lib/WikiDB.php

   1 <?php //-*-php-*-
   2 rcs_id('$Id: WikiDB.php,v 1.101 2004-11-10 19:32:22 rurban Exp $');
   3
   4 require_once('lib/PageType.php');
   5
   6 /**
   7  * The classes in the file define the interface to the
   8  * page database.
   9  *
  10  * @package WikiDB
  11  * @author Geoffrey T. Dairiki <dairiki@dairiki.org>
  12  *         Reini Urban
  13  */
  14
  15 /**
  16  * Force the creation of a new revision.
  17  * @see WikiDB_Page::createRevision()
  18  */
  19 if (!defined('WIKIDB_FORCE_CREATE'))
  20     define('WIKIDB_FORCE_CREATE', -1);
  21
  22 /**
  23  * Abstract base class for the database used by PhpWiki.
  24  *
  25  * A <tt>WikiDB</tt> is a container for <tt>WikiDB_Page</tt>s which in
  26  * turn contain <tt>WikiDB_PageRevision</tt>s.
  27  *
  28  * Conceptually a <tt>WikiDB</tt> contains all possible
  29  * <tt>WikiDB_Page</tt>s, whether they have been initialized or not.
  30  * Since all possible pages are already contained in a WikiDB, a call
  31  * to WikiDB::getPage() will never fail (barring bugs and
  32  * e.g. filesystem or SQL database problems.)
  33  *
  34  * Also each <tt>WikiDB_Page</tt> always contains at least one
  35  * <tt>WikiDB_PageRevision</tt>: the default content (e.g. "Describe
  36  * [PageName] here.").  This default content has a version number of
  37  * zero.
  38  *
  39  * <tt>WikiDB_PageRevision</tt>s have read-only semantics. One can
  40  * only create new revisions or delete old ones --- one can not modify
  41  * an existing revision.
  42  */
  43 class WikiDB {
  44     /**
  45      * Open a WikiDB database.
  46      *
  47      * This is a static member function. This function inspects its
  48      * arguments to determine the proper subclass of WikiDB to
  49      * instantiate, and then it instantiates it.
  50      *
  51      * @access public
  52      *
  53      * @param hash $dbparams Database configuration parameters.
  54      * Some pertinent paramters are:
  55      * <dl>
  56      * <dt> dbtype
  57      * <dd> The back-end type.  Current supported types are:
  58      *   <dl>
  59      *   <dt> SQL
  60      *     <dd> Generic SQL backend based on the PEAR/DB database abstraction
  61      *       library. (More stable and conservative)
  62      *   <dt> ADODB
  63      *     <dd> Another generic SQL backend. (More current features are tested here. Much faster)
  64      *   <dt> dba
  65      *     <dd> Dba based backend. The default and by far the fastest.
  66      *   <dt> cvs
  67      *     <dd>
  68      *   <dt> file
  69      *     <dd> flat files
  70      *   </dl>
  71      *
  72      * <dt> dsn
  73      * <dd> (Used by the SQL and ADODB backends.)
  74      *      The DSN specifying which database to connect to.
  75      *
  76      * <dt> prefix
  77      * <dd> Prefix to be prepended to database tables (and file names).
  78      *
  79      * <dt> directory
  80      * <dd> (Used by the dba backend.)
  81      *      Which directory db files reside in.
  82      *
  83      * <dt> timeout
  84      * <dd> Used only by the dba backend so far.
  85      *      And: When optimizing mysql it closes timed out mysql processes.
  86      *      otherwise only used for dba: Timeout in seconds for opening (and
  87      *      obtaining lock) on the dbm file.
  88      *
  89      * <dt> dba_handler
  90      * <dd> (Used by the dba backend.)
  91      *
  92      *      Which dba handler to use. Good choices are probably either
  93      *      'gdbm' or 'db2'.
  94      * </dl>
  95      *
  96      * @return WikiDB A WikiDB object.
  97      **/
  98     function open ($dbparams) {
  99         $dbtype = $dbparams{'dbtype'};
 100         include_once("lib/WikiDB/$dbtype.php");
 101
 102         $class = 'WikiDB_' . $dbtype;
 103         return new $class ($dbparams);
 104     }
 105
 106
 107     /**
 108      * Constructor.
 109      *
 110      * @access private
 111      * @see open()
 112      */
 113     function WikiDB (&$backend, $dbparams) {
 114         $this->_backend = &$backend;
 115         // don't do the following with the auth_dsn!
 116         if (isset($dbparams['auth_dsn'])) return;
 117
 118         $this->_cache = new WikiDB_cache($backend);
 119         $GLOBALS['request']->_dbi = $this;
 120
 121         // If the database doesn't yet have a timestamp, initialize it now.
 122         if ($this->get('_timestamp') === false)
 123             $this->touch();
 124
 125         //FIXME: devel checking.
 126         //$this->_backend->check();
 127     }
 128
 129     /**
 130      * Get any user-level warnings about this WikiDB.
 131      *
 132      * Some back-ends, e.g. by default create there data files in the
 133      * global /tmp directory. We would like to warn the user when this
 134      * happens (since /tmp files tend to get wiped periodically.)
 135      * Warnings such as these may be communicated from specific
 136      * back-ends through this method.
 137      *
 138      * @access public
 139      *
 140      * @return string A warning message (or <tt>false</tt> if there is
 141      * none.)
 142      */
 143     function genericWarnings() {
 144         return false;
 145     }
 146
 147     /**
 148      * Close database connection.
 149      *
 150      * The database may no longer be used after it is closed.
 151      *
 152      * Closing a WikiDB invalidates all <tt>WikiDB_Page</tt>s,
 153      * <tt>WikiDB_PageRevision</tt>s and <tt>WikiDB_PageIterator</tt>s
 154      * which have been obtained from it.
 155      *
 156      * @access public
 157      */
 158     function close () {
 159         $this->_backend->close();
 160         $this->_cache->close();
 161     }
 162
 163     /**
 164      * Get a WikiDB_Page from a WikiDB.
 165      *
 166      * A {@link WikiDB} consists of the (infinite) set of all possible pages,
 167      * therefore this method never fails.
 168      *
 169      * @access public
 170      * @param string $pagename Which page to get.
 171      * @return WikiDB_Page The requested WikiDB_Page.
 172      */
 173     function getPage($pagename) {
 174         static $error_displayed = false;
 175         $pagename = (string) $pagename;
 176         if (DEBUG) {
 177             if ($pagename === '') {
 178                 if ($error_displayed) return false;
 179                 $error_displayed = true;
 180                 if (function_exists("xdebug_get_function_stack"))
 181                     var_dump(xdebug_get_function_stack());
 182                 trigger_error("empty pagename", E_USER_WARNING);
 183                 return false;
 184             }
 185         } else {
 186             assert($pagename != '');
 187         }
 188         return new WikiDB_Page($this, $pagename);
 189     }
 190
 191     /**
 192      * Determine whether page exists (in non-default form).
 193      *
 194      * <pre>
 195      *   $is_page = $dbi->isWikiPage($pagename);
 196      * </pre>
 197      * is equivalent to
 198      * <pre>
 199      *   $page = $dbi->getPage($pagename);
 200      *   $current = $page->getCurrentRevision();
 201      *   $is_page = ! $current->hasDefaultContents();
 202      * </pre>
 203      * however isWikiPage may be implemented in a more efficient
 204      * manner in certain back-ends.
 205      *
 206      * @access public
 207      *
 208      * @param string $pagename string Which page to check.
 209      *
 210      * @return boolean True if the page actually exists with
 211      * non-default contents in the WikiDataBase.
 212      */
 213     function isWikiPage ($pagename) {
 214         $page = $this->getPage($pagename);
 215         return $page->exists();
 216     }
 217
 218     /**
 219      * Delete page from the WikiDB.
 220      *
 221      * Deletes all revisions of the page from the WikiDB. Also resets
 222      * all page meta-data to the default values.
 223      *
 224      * @access public
 225      *
 226      * @param string $pagename Name of page to delete.
 227      */
 228     function deletePage($pagename) {
 229         $this->_cache->delete_page($pagename);
 230
 231         /* Generate notification emails? */
 232         if (! $this->isWikiPage($pagename) ) {
 233             $notify = $this->get('notify');
 234             if (!empty($notify) and is_array($notify)) {
 235                 //TODO: deferr it (quite a massive load if you remove some pages).
 236                 //TODO: notification class which catches all changes,
 237                 //  and decides at the end of the request what to mail. (type, page, who, what, users, emails)
 238                 // could be used for PageModeration also.
 239                 $page = new WikiDB_Page($pagename);
 240                 list($emails, $userids) = $page->getPageChangeEmails($notify);
 241                 if (!empty($emails)) {
 242                     $editedby = sprintf(_("Edited by: %s"), $GLOBALS['request']->_user->getId()); // Todo: host_id
 243                     $emails = join(',', $emails);
 244                     $subject = sprintf(_("Page deleted %s"), urlencode($pagename));
 245                     if (mail($emails,"[".WIKI_NAME."] ".$subject,
 246                              $subject."\n".
 247                              $editedby."\n\n".
 248                              "Deleted $pagename"))
 249                         trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
 250                                               $pagename, join(',',$userids)), E_USER_NOTICE);
 251                     else
 252                         trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
 253                                               $pagename, join(',',$userids)), E_USER_WARNING);
 254                 }
 255             }
 256         }
 257
 258         //How to create a RecentChanges entry with explaining summary? Dynamically
 259         /*
 260         $page = $this->getPage($pagename);
 261         $current = $page->getCurrentRevision();
 262         $meta = $current->_data;
 263         $version = $current->getVersion();
 264         $meta['summary'] = _("removed");
 265         $page->save($current->getPackedContent(), $version + 1, $meta);
 266         */
 267     }
 268
 269     /**
 270      * Retrieve all pages.
 271      *
 272      * Gets the set of all pages with non-default contents.
 273      *
 274      * @access public
 275      *
 276      * @param boolean $include_defaulted Normally pages whose most
 277      * recent revision has empty content are considered to be
 278      * non-existant. Unless $include_defaulted is set to true, those
 279      * pages will not be returned.
 280      *
 281      * @return WikiDB_PageIterator A WikiDB_PageIterator which contains all pages
 282      *     in the WikiDB which have non-default contents.
 283      */
 284     function getAllPages($include_empty=false, $sortby=false, $limit=false) {
 285         // HACK: memory_limit=8M will fail on too large pagesets. old php on unix only!
 286         $mem = ini_get("memory_limit");
 287         if ($mem and !$limit and !isWindows() and !check_php_version(4,3)) {
 288             $limit = 450;
 289             $GLOBALS['request']->setArg('limit',$limit);
 290             $GLOBALS['request']->setArg('paging','auto');
 291         }
 292         $result = $this->_backend->get_all_pages($include_empty, $sortby, $limit);
 293         return new WikiDB_PageIterator($this, $result, array('include_empty' => $include_empty,
 294                                                              'limit' => $limit));
 295     }
 296
 297     /**
 298      * filter = true: include also empty pages
 299      * exclude: comma-seperated list pagenames
 300      */
 301     function numPages($filter=false, $exclude='') {
 302         if (method_exists($this->_backend, 'numPages'))
 303             // FIXME: currently are all args ignored.
 304             $count = $this->_backend->numPages($filter, $exclude);
 305         else {
 306             // FIXME: exclude ignored.
 307             $iter = $this->getAllPages($filter);
 308             $count = $iter->count();
 309             $iter->free();
 310         }
 311         return (int)$count;
 312     }
 313
 314     /**
 315      * Title search.
 316      *
 317      * Search for pages containing (or not containing) certain words
 318      * in their names.
 319      *
 320      * Pages are returned in alphabetical order whenever it is
 321      * practical to do so.
 322      *
 323      * FIXME: should titleSearch and fullSearch be combined?  I think so.
 324      *
 325      * @access public
 326      * @param TextSearchQuery $search A TextSearchQuery object
 327      * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
 328      * @see TextSearchQuery
 329      */
 330     function titleSearch($search) {
 331         $result = $this->_backend->text_search($search);
 332         return new WikiDB_PageIterator($this, $result);
 333     }
 334
 335     /**
 336      * Full text search.
 337      *
 338      * Search for pages containing (or not containing) certain words
 339      * in their entire text (this includes the page content and the
 340      * page name).
 341      *
 342      * Pages are returned in alphabetical order whenever it is
 343      * practical to do so.
 344      *
 345      * @access public
 346      *
 347      * @param TextSearchQuery $search A TextSearchQuery object.
 348      * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
 349      * @see TextSearchQuery
 350      */
 351     function fullSearch($search) {
 352         $result = $this->_backend->text_search($search, 'full_text');
 353         return new WikiDB_PageIterator($this, $result);
 354     }
 355
 356     /**
 357      * Find the pages with the greatest hit counts.
 358      *
 359      * Pages are returned in reverse order by hit count.
 360      *
 361      * @access public
 362      *
 363      * @param integer $limit The maximum number of pages to return.
 364      * Set $limit to zero to return all pages.  If $limit < 0, pages will
 365      * be sorted in decreasing order of popularity.
 366      *
 367      * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching
 368      * pages.
 369      */
 370     function mostPopular($limit = 20, $sortby = '-hits') {
 371         $result = $this->_backend->most_popular($limit, $sortby);
 372         return new WikiDB_PageIterator($this, $result);
 373     }
 374
 375     /**
 376      * Find recent page revisions.
 377      *
 378      * Revisions are returned in reverse order by creation time.
 379      *
 380      * @access public
 381      *
 382      * @param hash $params This hash is used to specify various optional
 383      *   parameters:
 384      * <dl>
 385      * <dt> limit
 386      *    <dd> (integer) At most this many revisions will be returned.
 387      * <dt> since
 388      *    <dd> (integer) Only revisions since this time (unix-timestamp) will be returned.
 389      * <dt> include_minor_revisions
 390      *    <dd> (boolean) Also include minor revisions.  (Default is not to.)
 391      * <dt> exclude_major_revisions
 392      *    <dd> (boolean) Don't include non-minor revisions.
 393      *         (Exclude_major_revisions implies include_minor_revisions.)
 394      * <dt> include_all_revisions
 395      *    <dd> (boolean) Return all matching revisions for each page.
 396      *         Normally only the most recent matching revision is returned
 397      *         for each page.
 398      * </dl>
 399      *
 400      * @return WikiDB_PageRevisionIterator A WikiDB_PageRevisionIterator containing the
 401      * matching revisions.
 402      */
 403     function mostRecent($params = false) {
 404         $result = $this->_backend->most_recent($params);
 405         return new WikiDB_PageRevisionIterator($this, $result);
 406     }
 407
 408     /**
 409      * Call the appropriate backend method.
 410      *
 411      * @access public
 412      * @param string $from Page to rename
 413      * @param string $to   New name
 414      * @param boolean $updateWikiLinks If the text in all pages should be replaced.
 415      * @return boolean     true or false
 416      */
 417     function renamePage($from, $to, $updateWikiLinks = false) {
 418         assert(is_string($from) && $from != '');
 419         assert(is_string($to) && $to != '');
 420         $result = false;
 421         if (method_exists($this->_backend, 'rename_page')) {
 422             $oldpage = $this->getPage($from);
 423             $newpage = $this->getPage($to);
 424             //update all WikiLinks in existing pages
 425             //non-atomic! i.e. if rename fails the links are not undone
 426             if ($updateWikiLinks) {
 427                 require_once('lib/plugin/WikiAdminSearchReplace.php');
 428                 $links = $oldpage->getBackLinks();
 429                 while ($linked_page = $links->next()) {
 430                     WikiPlugin_WikiAdminSearchReplace::replaceHelper($this,$linked_page->getName(),$from,$to);
 431                 }
 432                 $links = $newpage->getBackLinks();
 433                 while ($linked_page = $links->next()) {
 434                     WikiPlugin_WikiAdminSearchReplace::replaceHelper($this,$linked_page->getName(),$from,$to);
 435                 }
 436             }
 437             if ($oldpage->exists() and ! $newpage->exists()) {
 438                 if ($result = $this->_backend->rename_page($from, $to)) {
 439                     //create a RecentChanges entry with explaining summary
 440                     $page = $this->getPage($to);
 441                     $current = $page->getCurrentRevision();
 442                     $meta = $current->_data;
 443                     $version = $current->getVersion();
 444                     $meta['summary'] = sprintf(_("renamed from %s"), $from);
 445                     $page->save($current->getPackedContent(), $version + 1, $meta);
 446                 }
 447             } elseif (!$oldpage->getCurrentRevision(false) and !$newpage->exists()) {
 448                 // if a version 0 exists try it also.
 449                 $result = $this->_backend->rename_page($from, $to);
 450             }
 451         } else {
 452             trigger_error(_("WikiDB::renamePage() not yet implemented for this backend"),
 453                           E_USER_WARNING);
 454         }
 455         /* Generate notification emails? */
 456         if ($result) {
 457             $notify = $this->get('notify');
 458             if (!empty($notify) and is_array($notify)) {
 459                 list($emails, $userids) = $oldpage->getPageChangeEmails($notify);
 460                 if (!empty($emails)) {
 461                     $oldpage->sendPageRenameNotification($to, &$meta, $emails, $userids);
 462                 }
 463             }
 464         }
 465         return $result;
 466     }
 467
 468     /** Get timestamp when database was last modified.
 469      *
 470      * @return string A string consisting of two integers,
 471      * separated by a space.  The first is the time in
 472      * unix timestamp format, the second is a modification
 473      * count for the database.
 474      *
 475      * The idea is that you can cast the return value to an
 476      * int to get a timestamp, or you can use the string value
 477      * as a good hash for the entire database.
 478      */
 479     function getTimestamp() {
 480         $ts = $this->get('_timestamp');
 481         return sprintf("%d %d", $ts[0], $ts[1]);
 482     }
 483
 484     /**
 485      * Update the database timestamp.
 486      *
 487      */
 488     function touch() {
 489         $ts = $this->get('_timestamp');
 490         $this->set('_timestamp', array(time(), $ts[1] + 1));
 491     }
 492
 493
 494     /**
 495      * Access WikiDB global meta-data.
 496      *
 497      * NOTE: this is currently implemented in a hackish and
 498      * not very efficient manner.
 499      *
 500      * @access public
 501      *
 502      * @param string $key Which meta data to get.
 503      * Some reserved meta-data keys are:
 504      * <dl>
 505      * <dt>'_timestamp' <dd> Data used by getTimestamp().
 506      * </dl>
 507      *
 508      * @return scalar The requested value, or false if the requested data
 509      * is not set.
 510      */
 511     function get($key) {
 512         if (!$key || $key[0] == '%')
 513             return false;
 514         /*
 515          * Hack Alert: We can use any page (existing or not) to store
 516          * this data (as long as we always use the same one.)
 517          */
 518         $gd = $this->getPage('global_data');
 519         $data = $gd->get('__global');
 520
 521         if ($data && isset($data[$key]))
 522             return $data[$key];
 523         else
 524             return false;
 525     }
 526
 527     /**
 528      * Set global meta-data.
 529      *
 530      * NOTE: this is currently implemented in a hackish and
 531      * not very efficient manner.
 532      *
 533      * @see get
 534      * @access public
 535      *
 536      * @param string $key  Meta-data key to set.
 537      * @param string $newval  New value.
 538      */
 539     function set($key, $newval) {
 540         if (!$key || $key[0] == '%')
 541             return;
 542
 543         $gd = $this->getPage('global_data');
 544         $data = $gd->get('__global');
 545         if ($data === false)
 546             $data = array();
 547
 548         if (empty($newval))
 549             unset($data[$key]);
 550         else
 551             $data[$key] = $newval;
 552
 553         $gd->set('__global', $data);
 554     }
 555
 556     // SQL result: for simple select or create/update queries
 557     // returns the database specific resource type
 558     function genericSqlQuery($sql) {
 559         trigger_error("no SQL database", E_USER_ERROR);
 560         return false;
 561     }
 562
 563     // SQL iter: for simple select or create/update queries
 564     // returns the generic iterator object (count,next)
 565     function genericSqlIter($sql, $field_list = NULL) {
 566         trigger_error("no SQL database", E_USER_ERROR);
 567         return false;
 568     }
 569
 570     // see upstream methods:
 571     // ADODB adds surrounding quotes, SQL not yet!
 572     function quote ($s) {
 573         return $s;
 574     }
 575
 576     function isOpen () {
 577         global $request;
 578         if (!$request->_dbi) return false;
 579         else return true;
 580     }
 581
 582     function getParam($param) {
 583         global $DBParams;
 584         if (isset($DBParams[$param])) return $DBParams[$param];
 585         elseif ($param == 'prefix') return '';
 586         else return false;
 587     }
 588
 589     function getAuthParam($param) {
 590         global $DBAuthParams;
 591         if (isset($DBAuthParams[$param])) return $DBAuthParams[$param];
 592         elseif ($param == 'USER_AUTH_ORDER') return $GLOBALS['USER_AUTH_ORDER'];
 593         elseif ($param == 'USER_AUTH_POLICY') return $GLOBALS['USER_AUTH_POLICY'];
 594         else return false;
 595     }
 596 };
 597
 598
 599 /**
 600  * An abstract base class which representing a wiki-page within a
 601  * WikiDB.
 602  *
 603  * A WikiDB_Page contains a number (at least one) of
 604  * WikiDB_PageRevisions.
 605  */
 606 class WikiDB_Page
 607 {
 608     function WikiDB_Page(&$wikidb, $pagename) {
 609         $this->_wikidb = &$wikidb;
 610         $this->_pagename = $pagename;
 611         if (DEBUG) {
 612             if (!(is_string($pagename) and $pagename != '')) {
 613                 if (function_exists("xdebug_get_function_stack")) {
 614                     echo "xdebug_get_function_stack(): "; var_dump(xdebug_get_function_stack());
 615
 616                 }
 617                 trigger_error("empty pagename", E_USER_WARNING);
 618                 return false;
 619             }
 620         } else
 621             assert(is_string($pagename) and $pagename != '');
 622     }
 623
 624     /**
 625      * Get the name of the wiki page.
 626      *
 627      * @access public
 628      *
 629      * @return string The page name.
 630      */
 631     function getName() {
 632         return $this->_pagename;
 633     }
 634
 635     // To reduce the memory footprint for larger sets of pagelists,
 636     // we don't cache the content (only true or false) and
 637     // we purge the pagedata (_cached_html) also
 638     function exists() {
 639         if (isset($this->_wikidb->_cache->_id_cache[$this->_pagename])) return true;
 640         $current = $this->getCurrentRevision(false);
 641         return ! $current->hasDefaultContents();
 642     }
 643
 644     /**
 645      * Delete an old revision of a WikiDB_Page.
 646      *
 647      * Deletes the specified revision of the page.
 648      * It is a fatal error to attempt to delete the current revision.
 649      *
 650      * @access public
 651      *
 652      * @param integer $version Which revision to delete.  (You can also
 653      *  use a WikiDB_PageRevision object here.)
 654      */
 655     function deleteRevision($version) {
 656         $backend = &$this->_wikidb->_backend;
 657         $cache = &$this->_wikidb->_cache;
 658         $pagename = &$this->_pagename;
 659
 660         $version = $this->_coerce_to_version($version);
 661         if ($version == 0)
 662             return;
 663
 664         $backend->lock(array('page','version'));
 665         $latestversion = $cache->get_latest_version($pagename);
 666         if ($latestversion && $version == $latestversion) {
 667             $backend->unlock(array('page','version'));
 668             trigger_error(sprintf("Attempt to delete most recent revision of '%s'",
 669                                   $pagename), E_USER_ERROR);
 670             return;
 671         }
 672
 673         $cache->delete_versiondata($pagename, $version);
 674         $backend->unlock(array('page','version'));
 675     }
 676
 677     /*
 678      * Delete a revision, or possibly merge it with a previous
 679      * revision.
 680      *
 681      * The idea is this:
 682      * Suppose an author make a (major) edit to a page.  Shortly
 683      * after that the same author makes a minor edit (e.g. to fix
 684      * spelling mistakes he just made.)
 685      *
 686      * Now some time later, where cleaning out old saved revisions,
 687      * and would like to delete his minor revision (since there's
 688      * really no point in keeping minor revisions around for a long
 689      * time.)
 690      *
 691      * Note that the text after the minor revision probably represents
 692      * what the author intended to write better than the text after
 693      * the preceding major edit.
 694      *
 695      * So what we really want to do is merge the minor edit with the
 696      * preceding edit.
 697      *
 698      * We will only do this when:
 699      * <ul>
 700      * <li>The revision being deleted is a minor one, and
 701      * <li>It has the same author as the immediately preceding revision.
 702      * </ul>
 703      */
 704     function mergeRevision($version) {
 705         $backend = &$this->_wikidb->_backend;
 706         $cache = &$this->_wikidb->_cache;
 707         $pagename = &$this->_pagename;
 708
 709         $version = $this->_coerce_to_version($version);
 710         if ($version == 0)
 711             return;
 712
 713         $backend->lock(array('version'));
 714         $latestversion = $cache->get_latest_version($pagename);
 715         if ($latestversion && $version == $latestversion) {
 716             $backend->unlock(array('version'));
 717             trigger_error(sprintf("Attempt to merge most recent revision of '%s'",
 718                                   $pagename), E_USER_ERROR);
 719             return;
 720         }
 721
 722         $versiondata = $cache->get_versiondata($pagename, $version, true);
 723         if (!$versiondata) {
 724             // Not there? ... we're done!
 725             $backend->unlock(array('version'));
 726             return;
 727         }
 728
 729         if ($versiondata['is_minor_edit']) {
 730             $previous = $backend->get_previous_version($pagename, $version);
 731             if ($previous) {
 732                 $prevdata = $cache->get_versiondata($pagename, $previous);
 733                 if ($prevdata['author_id'] == $versiondata['author_id']) {
 734                     // This is a minor revision, previous version is
 735                     // by the same author. We will merge the
 736                     // revisions.
 737                     $cache->update_versiondata($pagename, $previous,
 738                                                array('%content' => $versiondata['%content'],
 739                                                      '_supplanted' => $versiondata['_supplanted']));
 740                 }
 741             }
 742         }
 743
 744         $cache->delete_versiondata($pagename, $version);
 745         $backend->unlock(array('version'));
 746     }
 747
 748
 749     /**
 750      * Create a new revision of a {@link WikiDB_Page}.
 751      *
 752      * @access public
 753      *
 754      * @param int $version Version number for new revision.
 755      * To ensure proper serialization of edits, $version must be
 756      * exactly one higher than the current latest version.
 757      * (You can defeat this check by setting $version to
 758      * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
 759      *
 760      * @param string $content Contents of new revision.
 761      *
 762      * @param hash $metadata Metadata for new revision.
 763      * All values in the hash should be scalars (strings or integers).
 764      *
 765      * @param array $links List of pagenames which this page links to.
 766      *
 767      * @return WikiDB_PageRevision  Returns the new WikiDB_PageRevision object. If
 768      * $version was incorrect, returns false
 769      */
 770     function createRevision($version, &$content, $metadata, $links) {
 771         $backend = &$this->_wikidb->_backend;
 772         $cache = &$this->_wikidb->_cache;
 773         $pagename = &$this->_pagename;
 774
 775         $backend->lock(array('version','page','recent','link','nonempty'));
 776
 777         $latestversion = $backend->get_latest_version($pagename);
 778         $newversion = $latestversion + 1;
 779         assert($newversion >= 1);
 780
 781         if ($version != WIKIDB_FORCE_CREATE && $version != $newversion) {
 782             $backend->unlock(array('version','page','recent','link','nonempty'));
 783             return false;
 784         }
 785
 786         $data = $metadata;
 787
 788         foreach ($data as $key => $val) {
 789             if (empty($val) || $key[0] == '_' || $key[0] == '%')
 790                 unset($data[$key]);
 791         }
 792
 793         assert(!empty($data['author']));
 794         if (empty($data['author_id']))
 795             @$data['author_id'] = $data['author'];
 796
 797         if (empty($data['mtime']))
 798             $data['mtime'] = time();
 799
 800         if ($latestversion) {
 801             // Ensure mtimes are monotonic.
 802             $pdata = $cache->get_versiondata($pagename, $latestversion);
 803             if ($data['mtime'] < $pdata['mtime']) {
 804                 trigger_error(sprintf(_("%s: Date of new revision is %s"),
 805                                       $pagename,"'non-monotonic'"),
 806                               E_USER_NOTICE);
 807                 $data['orig_mtime'] = $data['mtime'];
 808                 $data['mtime'] = $pdata['mtime'];
 809             }
 810
 811             // FIXME: use (possibly user specified) 'mtime' time or
 812             // time()?
 813             $cache->update_versiondata($pagename, $latestversion,
 814                                        array('_supplanted' => $data['mtime']));
 815         }
 816
 817         $data['%content'] = &$content;
 818
 819         $cache->set_versiondata($pagename, $newversion, $data);
 820
 821         //$cache->update_pagedata($pagename, array(':latestversion' => $newversion,
 822         //':deleted' => empty($content)));
 823
 824         $backend->set_links($pagename, $links);
 825
 826         $backend->unlock(array('version','page','recent','link','nonempty'));
 827
 828         return new WikiDB_PageRevision($this->_wikidb, $pagename, $newversion,
 829                                        $data);
 830     }
 831
 832     /** A higher-level interface to createRevision.
 833      *
 834      * This takes care of computing the links, and storing
 835      * a cached version of the transformed wiki-text.
 836      *
 837      * @param string $wikitext  The page content.
 838      *
 839      * @param int $version Version number for new revision.
 840      * To ensure proper serialization of edits, $version must be
 841      * exactly one higher than the current latest version.
 842      * (You can defeat this check by setting $version to
 843      * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
 844      *
 845      * @param hash $meta  Meta-data for new revision.
 846      */
 847     function save($wikitext, $version, $meta) {
 848         $formatted = new TransformedText($this, $wikitext, $meta);
 849         $type = $formatted->getType();
 850         $meta['pagetype'] = $type->getName();
 851         $links = $formatted->getWikiPageLinks();
 852
 853         $backend = &$this->_wikidb->_backend;
 854         $newrevision = $this->createRevision($version, $wikitext, $meta, $links);
 855         if ($newrevision and !WIKIDB_NOCACHE_MARKUP)
 856             $this->set('_cached_html', $formatted->pack());
 857
 858         // FIXME: probably should have some global state information
 859         // in the backend to control when to optimize.
 860         //
 861         // We're doing this here rather than in createRevision because
 862         // postgres can't optimize while locked.
 863         if (DEBUG or (time() % 50 == 0)) {
 864             if ($backend->optimize())
 865                 trigger_error(_("Optimizing database"), E_USER_NOTICE);
 866         }
 867
 868         /* Generate notification emails? */
 869         if (isa($newrevision, 'WikiDB_PageRevision')) {
 870             // Save didn't fail because of concurrent updates.
 871             $notify = $this->_wikidb->get('notify');
 872             if (!empty($notify) and is_array($notify)) {
 873                 list($emails, $userids) = $this->getPageChangeEmails($notify);
 874                 if (!empty($emails)) {
 875                     $this->sendPageChangeNotification($wikitext, $version, $meta, $emails, $userids);
 876                 }
 877             }
 878         }
 879
 880         $newrevision->_transformedContent = $formatted;
 881         return $newrevision;
 882     }
 883
 884     function getPageChangeEmails($notify) {
 885         $emails = array(); $userids = array();
 886         foreach ($notify as $page => $users) {
 887             if (glob_match($page, $this->_pagename)) {
 888                 foreach ($users as $userid => $user) {
 889                     if (!empty($user['verified']) and !empty($user['email'])) {
 890                         $emails[]  = $user['email'];
 891                         $userids[] = $userid;
 892                     } elseif (!empty($user['email'])) {
 893                         global $request;
 894                         // do a dynamic emailVerified check update
 895                         $u = $request->getUser();
 896                         if ($u->UserName() == $userid) {
 897                             if ($request->_prefs->get('emailVerified')) {
 898                                 $emails[] = $user['email'];
 899                                 $userids[] = $userid;
 900                                 $notify[$page][$userid]['verified'] = 1;
 901                                 $request->_dbi->set('notify', $notify);
 902                             }
 903                         } else {
 904                             // not current user
 905                             if (ENABLE_USER_NEW) {
 906                                 $u = WikiUser($userid);
 907                                 $u->getPreferences();
 908                                 $prefs = &$u->_prefs;
 909                             } else {
 910                                 $u = new WikiUser($GLOBALS['request'], $userid);
 911                                 $prefs = $u->getPreferences();
 912                             }
 913                             if ($prefs->get('emailVerified')) {
 914                                 $emails[] = $user['email'];
 915                                 $userids[] = $userid;
 916                                 $notify[$page][$userid]['verified'] = 1;
 917                                 $request->_dbi->set('notify', $notify);
 918                             }
 919                         }
 920                         // ignore verification
 921                         /*
 922                         if (DEBUG) {
 923                             if (!in_array($user['email'],$emails))
 924                                 $emails[] = $user['email'];
 925                         }
 926                         */
 927                     }
 928                 }
 929             }
 930         }
 931         $emails = array_unique($emails);
 932         $userids = array_unique($userids);
 933         return array($emails,$userids);
 934     }
 935
 936     /**
 937      * Send udiff for a changed page to multiple users.
 938      * See rename and remove methods also
 939      */
 940     function sendPageChangeNotification(&$wikitext, $version, $meta, $emails, $userids) {
 941         global $request;
 942         if (@is_array($request->_deferredPageChangeNotification)) {
 943             // collapse multiple changes (loaddir) into one email
 944             $request->_deferredPageChangeNotification[] = array($this->_pagename, $emails, $userids);
 945             return;
 946         }
 947         $backend = &$this->_wikidb->_backend;
 948         //$backend = &$request->_dbi->_backend;
 949         $subject = _("Page change").' '.urlencode($this->_pagename);
 950         $previous = $backend->get_previous_version($this->_pagename, $version);
 951         if (!isset($meta['mtime'])) $meta['mtime'] = time();
 952         if ($previous) {
 953             $difflink = WikiURL($this->_pagename, array('action'=>'diff'), true);
 954             $cache = &$this->_wikidb->_cache;
 955             //$cache = &$request->_dbi->_cache;
 956             $this_content = explode("\n", $wikitext);
 957             $prevdata = $cache->get_versiondata($this->_pagename, $previous, true);
 958             if (empty($prevdata['%content']))
 959                 $prevdata = $backend->get_versiondata($this->_pagename, $previous, true);
 960             $other_content = explode("\n", $prevdata['%content']);
 961
 962             include_once("lib/difflib.php");
 963             $diff2 = new Diff($other_content, $this_content);
 964             //$context_lines = max(4, count($other_content) + 1,
 965             //                     count($this_content) + 1);
 966             $fmt = new UnifiedDiffFormatter(/*$context_lines*/);
 967             $content  = $this->_pagename . " " . $previous . " " . Iso8601DateTime($prevdata['mtime']) . "\n";
 968             $content .= $this->_pagename . " " . $version . " " .  Iso8601DateTime($meta['mtime']) . "\n";
 969             $content .= $fmt->format($diff2);
 970
 971         } else {
 972             $difflink = WikiURL($this->_pagename,array(),true);
 973             $content = $this->_pagename . " " . $version . " " .  Iso8601DateTime($meta['mtime']) . "\n";
 974             $content .= _("New Page");
 975         }
 976         $editedby = sprintf(_("Edited by: %s"), $meta['author']);
 977         $emails = join(',',$emails);
 978         if (mail($emails,"[".WIKI_NAME."] ".$subject,
 979                  $subject."\n".
 980                  $editedby."\n".
 981                  $difflink."\n\n".
 982                  $content))
 983             trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
 984                                   $this->_pagename, join(',',$userids)), E_USER_NOTICE);
 985         else
 986             trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
 987                                   $this->_pagename, join(',',$userids)), E_USER_WARNING);
 988     }
 989
 990     /** support mass rename / remove (not yet tested)
 991      */
 992     function sendPageRenameNotification($to, &$meta, $emails, $userids) {
 993         global $request;
 994         if (@is_array($request->_deferredPageRenameNotification)) {
 995             $request->_deferredPageRenameNotification[] = array($this->_pagename, $to, $meta, $emails, $userids);
 996         } else {
 997             $from = $this->_pagename;
 998             $editedby = sprintf(_("Edited by: %s"), $meta['author']) . ' ' . $meta['author_id'];
 999             $emails = join(',',$emails);
1000             $subject = sprintf(_("Page rename %s to %s"), urlencode($from), urlencode($to));
1001             $link = WikiURL($to, true);
1002             if (mail($emails,"[".WIKI_NAME."] ".$subject,
1003                      $subject."\n".
1004                      $editedby."\n".
1005                      $link."\n\n".
1006                      "Renamed $from to $to"))
1007                 trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
1008                                       $from, join(',',$userids)), E_USER_NOTICE);
1009             else
1010                 trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
1011                                       $from, join(',',$userids)), E_USER_WARNING);
1012         }
1013     }
1014
1015     /**
1016      * Get the most recent revision of a page.
1017      *
1018      * @access public
1019      *
1020      * @return WikiDB_PageRevision The current WikiDB_PageRevision object.
1021      */
1022     function getCurrentRevision($need_content = true) {
1023         $backend = &$this->_wikidb->_backend;
1024         $cache = &$this->_wikidb->_cache;
1025         $pagename = &$this->_pagename;
1026
1027         // Prevent deadlock in case of memory exhausted errors
1028         // Pure selection doesn't really need locking here.
1029         //   sf.net bug#927395
1030         // I know it would be better, but with lots of pages this deadlock is more
1031         // severe than occasionally get not the latest revision.
1032         //$backend->lock();
1033         $version = $cache->get_latest_version($pagename);
1034         // getRevision gets the content also!
1035         $revision = $this->getRevision($version, $need_content);
1036         //$backend->unlock();
1037         assert($revision);
1038         return $revision;
1039     }
1040
1041     /**
1042      * Get a specific revision of a WikiDB_Page.
1043      *
1044      * @access public
1045      *
1046      * @param integer $version  Which revision to get.
1047      *
1048      * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or
1049      * false if the requested revision does not exist in the {@link WikiDB}.
1050      * Note that version zero of any page always exists.
1051      */
1052     function getRevision($version, $need_content=true) {
1053         $cache = &$this->_wikidb->_cache;
1054         $pagename = &$this->_pagename;
1055
1056         if (! $version ) // 0 or false
1057             return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
1058
1059         assert($version > 0);
1060         $vdata = $cache->get_versiondata($pagename, $version, $need_content);
1061         if (!$vdata) {
1062             return false;
1063         }
1064         return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1065                                        $vdata);
1066     }
1067
1068     /**
1069      * Get previous page revision.
1070      *
1071      * This method find the most recent revision before a specified
1072      * version.
1073      *
1074      * @access public
1075      *
1076      * @param integer $version  Find most recent revision before this version.
1077      *  You can also use a WikiDB_PageRevision object to specify the $version.
1078      *
1079      * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or false if the
1080      * requested revision does not exist in the {@link WikiDB}.  Note that
1081      * unless $version is greater than zero, a revision (perhaps version zero,
1082      * the default revision) will always be found.
1083      */
1084     function getRevisionBefore($version, $need_content=true) {
1085         $backend = &$this->_wikidb->_backend;
1086         $pagename = &$this->_pagename;
1087
1088         $version = $this->_coerce_to_version($version);
1089
1090         if ($version == 0)
1091             return false;
1092         //$backend->lock();
1093         $previous = $backend->get_previous_version($pagename, $version);
1094         $revision = $this->getRevision($previous, $need_content);
1095         //$backend->unlock();
1096         assert($revision);
1097         return $revision;
1098     }
1099
1100     /**
1101      * Get all revisions of the WikiDB_Page.
1102      *
1103      * This does not include the version zero (default) revision in the
1104      * returned revision set.
1105      *
1106      * @return WikiDB_PageRevisionIterator A
1107      *   WikiDB_PageRevisionIterator containing all revisions of this
1108      *   WikiDB_Page in reverse order by version number.
1109      */
1110     function getAllRevisions() {
1111         $backend = &$this->_wikidb->_backend;
1112         $revs = $backend->get_all_revisions($this->_pagename);
1113         return new WikiDB_PageRevisionIterator($this->_wikidb, $revs);
1114     }
1115
1116     /**
1117      * Find pages which link to or are linked from a page.
1118      *
1119      * @access public
1120      *
1121      * @param boolean $reversed Which links to find: true for backlinks (default).
1122      *
1123      * @return WikiDB_PageIterator A WikiDB_PageIterator containing
1124      * all matching pages.
1125      */
1126     function getLinks($reversed = true, $include_empty=false) {
1127         $backend = &$this->_wikidb->_backend;
1128         $result =  $backend->get_links($this->_pagename, $reversed, $include_empty=false);
1129         //if (empty($this->_iwpcache) and !$include_empty)
1130         //    $this->_iwpcache = $result->asArray();
1131         return new WikiDB_PageIterator($this->_wikidb, $result, array('include_empty' => $include_empty));
1132     }
1133
1134     /**
1135      * All Links from other pages to this page.
1136      */
1137     function getBackLinks($include_empty=false) {
1138         return $this->getLinks(true, $include_empty=false);
1139     }
1140     /**
1141      * Forward Links: All Links from this page to other pages.
1142      */
1143     function getPageLinks($include_empty=false) {
1144         return $this->getLinks(false, $include_empty=false);
1145     }
1146
1147     /**
1148      * Access WikiDB_Page meta-data.
1149      *
1150      * @access public
1151      *
1152      * @param string $key Which meta data to get.
1153      * Some reserved meta-data keys are:
1154      * <dl>
1155      * <dt>'locked'<dd> Is page locked?
1156      * <dt>'hits'  <dd> Page hit counter.
1157      * <dt>'pref'  <dd> Users preferences, stored in homepages.
1158      * <dt>'owner' <dd> Default: first author_id. We might add a group with a dot here:
1159      *                  E.g. "owner.users"
1160      * <dt>'perm'  <dd> Permission flag to authorize read/write/execution of
1161      *                  page-headers and content.
1162      * <dt>'score' <dd> Page score (not yet implement, do we need?)
1163      * </dl>
1164      *
1165      * @return scalar The requested value, or false if the requested data
1166      * is not set.
1167      */
1168     function get($key) {
1169         $cache = &$this->_wikidb->_cache;
1170         if (!$key || $key[0] == '%')
1171             return false;
1172         $data = $cache->get_pagedata($this->_pagename);
1173         return isset($data[$key]) ? $data[$key] : false;
1174     }
1175
1176     /**
1177      * Get all the page meta-data as a hash.
1178      *
1179      * @return hash The page meta-data.
1180      */
1181     function getMetaData() {
1182         $cache = &$this->_wikidb->_cache;
1183         $data = $cache->get_pagedata($this->_pagename);
1184         $meta = array();
1185         foreach ($data as $key => $val) {
1186             if (/*!empty($val) &&*/ $key[0] != '%')
1187                 $meta[$key] = $val;
1188         }
1189         return $meta;
1190     }
1191
1192     /**
1193      * Set page meta-data.
1194      *
1195      * @see get
1196      * @access public
1197      *
1198      * @param string $key  Meta-data key to set.
1199      * @param string $newval  New value.
1200      */
1201     function set($key, $newval) {
1202         $cache = &$this->_wikidb->_cache;
1203         $pagename = &$this->_pagename;
1204
1205         assert($key && $key[0] != '%');
1206
1207         $data = $cache->get_pagedata($pagename);
1208
1209         if (!empty($newval)) {
1210             if (!empty($data[$key]) && $data[$key] == $newval)
1211                 return;         // values identical, skip update.
1212         }
1213         else {
1214             if (empty($data[$key]))
1215                 return;         // values identical, skip update.
1216         }
1217
1218         $cache->update_pagedata($pagename, array($key => $newval));
1219     }
1220
1221     /**
1222      * Increase page hit count.
1223      *
1224      * FIXME: IS this needed?  Probably not.
1225      *
1226      * This is a convenience function.
1227      * <pre> $page->increaseHitCount(); </pre>
1228      * is functionally identical to
1229      * <pre> $page->set('hits',$page->get('hits')+1); </pre>
1230      * but less expensive (ignores the pagadata string)
1231      *
1232      * Note that this method may be implemented in more efficient ways
1233      * in certain backends.
1234      *
1235      * @access public
1236      */
1237     function increaseHitCount() {
1238         if (method_exists($this->_wikidb->_backend, 'increaseHitCount'))
1239             $this->_wikidb->_backend->increaseHitCount($this->_pagename);
1240         else {
1241             @$newhits = $this->get('hits') + 1;
1242             $this->set('hits', $newhits);
1243         }
1244     }
1245
1246     /**
1247      * Return a string representation of the WikiDB_Page
1248      *
1249      * This is really only for debugging.
1250      *
1251      * @access public
1252      *
1253      * @return string Printable representation of the WikiDB_Page.
1254      */
1255     function asString () {
1256         ob_start();
1257         printf("[%s:%s\n", get_class($this), $this->getName());
1258         print_r($this->getMetaData());
1259         echo "]\n";
1260         $strval = ob_get_contents();
1261         ob_end_clean();
1262         return $strval;
1263     }
1264
1265
1266     /**
1267      * @access private
1268      * @param integer_or_object $version_or_pagerevision
1269      * Takes either the version number (and int) or a WikiDB_PageRevision
1270      * object.
1271      * @return integer The version number.
1272      */
1273     function _coerce_to_version($version_or_pagerevision) {
1274         if (method_exists($version_or_pagerevision, "getContent"))
1275             $version = $version_or_pagerevision->getVersion();
1276         else
1277             $version = (int) $version_or_pagerevision;
1278
1279         assert($version >= 0);
1280         return $version;
1281     }
1282
1283     function isUserPage ($include_empty = true) {
1284         if (!$include_empty and !$this->exists()) return false;
1285         return $this->get('pref') ? true : false;
1286     }
1287
1288     // May be empty. Either the stored owner (/Chown), or the first authorized author
1289     function getOwner() {
1290         if ($owner = $this->get('owner'))
1291             return ($owner == "The PhpWiki programming team") ? ADMIN_USER : $owner;
1292         // check all revisions forwards for the first author_id
1293         $backend = &$this->_wikidb->_backend;
1294         $pagename = &$this->_pagename;
1295         $latestversion = $backend->get_latest_version($pagename);
1296         for ($v=1; $v <= $latestversion; $v++) {
1297             $rev = $this->getRevision($v,false);
1298             if ($rev and $owner = $rev->get('author_id')) {
1299                 return ($owner == "The PhpWiki programming team") ? ADMIN_USER : $owner;
1300             }
1301         }
1302         return '';
1303     }
1304
1305     // The authenticated author of the first revision or empty if not authenticated then.
1306     function getCreator() {
1307         if ($current = $this->getRevision(1,false)) return $current->get('author_id');
1308         else return '';
1309     }
1310
1311     // The authenticated author of the current revision.
1312     function getAuthor() {
1313         if ($current = $this->getCurrentRevision(false)) return $current->get('author_id');
1314         else return '';
1315     }
1316
1317 };
1318
1319 /**
1320  * This class represents a specific revision of a WikiDB_Page within
1321  * a WikiDB.
1322  *
1323  * A WikiDB_PageRevision has read-only semantics. You may only create
1324  * new revisions (and delete old ones) --- you cannot modify existing
1325  * revisions.
1326  */
1327 class WikiDB_PageRevision
1328 {
1329     //var $_transformedContent = false; // set by WikiDB_Page::save()
1330
1331     function WikiDB_PageRevision(&$wikidb, $pagename, $version, $versiondata = false) {
1332         $this->_wikidb = &$wikidb;
1333         $this->_pagename = $pagename;
1334         $this->_version = $version;
1335         $this->_data = $versiondata ? $versiondata : array();
1336         $this->_transformedContent = false; // set by WikiDB_Page::save()
1337     }
1338
1339     /**
1340      * Get the WikiDB_Page which this revision belongs to.
1341      *
1342      * @access public
1343      *
1344      * @return WikiDB_Page The WikiDB_Page which this revision belongs to.
1345      */
1346     function getPage() {
1347         return new WikiDB_Page($this->_wikidb, $this->_pagename);
1348     }
1349
1350     /**
1351      * Get the version number of this revision.
1352      *
1353      * @access public
1354      *
1355      * @return integer The version number of this revision.
1356      */
1357     function getVersion() {
1358         return $this->_version;
1359     }
1360
1361     /**
1362      * Determine whether this revision has defaulted content.
1363      *
1364      * The default revision (version 0) of each page, as well as any
1365      * pages which are created with empty content have their content
1366      * defaulted to something like:
1367      * <pre>
1368      *   Describe [ThisPage] here.
1369      * </pre>
1370      *
1371      * @access public
1372      *
1373      * @return boolean Returns true if the page has default content.
1374      */
1375     function hasDefaultContents() {
1376         $data = &$this->_data;
1377         return empty($data['%content']); // FIXME: what if it's the number 0? <>'' or === false
1378     }
1379
1380     /**
1381      * Get the content as an array of lines.
1382      *
1383      * @access public
1384      *
1385      * @return array An array of lines.
1386      * The lines should contain no trailing white space.
1387      */
1388     function getContent() {
1389         return explode("\n", $this->getPackedContent());
1390     }
1391
1392         /**
1393      * Get the pagename of the revision.
1394      *
1395      * @access public
1396      *
1397      * @return string pagename.
1398      */
1399     function getPageName() {
1400         return $this->_pagename;
1401     }
1402
1403     /**
1404      * Determine whether revision is the latest.
1405      *
1406      * @access public
1407      *
1408      * @return boolean True iff the revision is the latest (most recent) one.
1409      */
1410     function isCurrent() {
1411         if (!isset($this->_iscurrent)) {
1412             $page = $this->getPage();
1413             $current = $page->getCurrentRevision(false);
1414             $this->_iscurrent = $this->getVersion() == $current->getVersion();
1415         }
1416         return $this->_iscurrent;
1417     }
1418
1419     /**
1420      * Get the transformed content of a page.
1421      *
1422      * @param string $pagetype  Override the page-type of the revision.
1423      *
1424      * @return object An XmlContent-like object containing the page transformed
1425      * contents.
1426      */
1427     function getTransformedContent($pagetype_override=false) {
1428         $backend = &$this->_wikidb->_backend;
1429
1430         if ($pagetype_override) {
1431             // Figure out the normal page-type for this page.
1432             $type = PageType::GetPageType($this->get('pagetype'));
1433             if ($type->getName() == $pagetype_override)
1434                 $pagetype_override = false; // Not really an override...
1435         }
1436
1437         if ($pagetype_override) {
1438             // Overriden page type, don't cache (or check cache).
1439             return new TransformedText($this->getPage(),
1440                                        $this->getPackedContent(),
1441                                        $this->getMetaData(),
1442                                        $pagetype_override);
1443         }
1444
1445         $possibly_cache_results = true;
1446
1447         if (!USECACHE or WIKIDB_NOCACHE_MARKUP) {
1448             if (WIKIDB_NOCACHE_MARKUP == 'purge') {
1449                 // flush cache for this page.
1450                 $page = $this->getPage();
1451                 $page->set('_cached_html', false);
1452             }
1453             $possibly_cache_results = false;
1454         }
1455         elseif (!$this->_transformedContent) {
1456             //$backend->lock();
1457             if ($this->isCurrent()) {
1458                 $page = $this->getPage();
1459                 $this->_transformedContent = TransformedText::unpack($page->get('_cached_html'));
1460             }
1461             else {
1462                 $possibly_cache_results = false;
1463             }
1464             //$backend->unlock();
1465         }
1466
1467         if (!$this->_transformedContent) {
1468             $this->_transformedContent
1469                 = new TransformedText($this->getPage(),
1470                                       $this->getPackedContent(),
1471                                       $this->getMetaData());
1472
1473             if ($possibly_cache_results) {
1474                 // If we're still the current version, cache the transfomed page.
1475                 //$backend->lock();
1476                 if ($this->isCurrent()) {
1477                     $page->set('_cached_html', $this->_transformedContent->pack());
1478                 }
1479                 //$backend->unlock();
1480             }
1481         }
1482
1483         return $this->_transformedContent;
1484     }
1485
1486     /**
1487      * Get the content as a string.
1488      *
1489      * @access public
1490      *
1491      * @return string The page content.
1492      * Lines are separated by new-lines.
1493      */
1494     function getPackedContent() {
1495         $data = &$this->_data;
1496
1497
1498         if (empty($data['%content'])) {
1499             include_once('lib/InlineParser.php');
1500
1501             // A feature similar to taglines at http://www.wlug.org.nz/
1502             // Lib from http://www.aasted.org/quote/
1503             if (defined('FORTUNE_DIR')
1504                 and is_dir(FORTUNE_DIR)
1505                 and in_array($GLOBALS['request']->getArg('action'),
1506                              array('create','edit')))
1507             {
1508                 include_once("lib/fortune.php");
1509                 $fortune = new Fortune();
1510                 $quote = str_replace("\n<br>","\n", $fortune->quoteFromDir(FORTUNE_DIR));
1511                 return sprintf("<verbatim>\n%s</verbatim>\n\n"._("Describe %s here."),
1512                                $quote, "[" . WikiEscape($this->_pagename) . "]");
1513             }
1514             // Replace empty content with default value.
1515             return sprintf(_("Describe %s here."),
1516                            "[" . WikiEscape($this->_pagename) . "]");
1517         }
1518
1519         // There is (non-default) content.
1520         assert($this->_version > 0);
1521
1522         if (!is_string($data['%content'])) {
1523             // Content was not provided to us at init time.
1524             // (This is allowed because for some backends, fetching
1525             // the content may be expensive, and often is not wanted
1526             // by the user.)
1527             //
1528             // In any case, now we need to get it.
1529             $data['%content'] = $this->_get_content();
1530             assert(is_string($data['%content']));
1531         }
1532
1533         return $data['%content'];
1534     }
1535
1536     function _get_content() {
1537         $cache = &$this->_wikidb->_cache;
1538         $pagename = $this->_pagename;
1539         $version = $this->_version;
1540
1541         assert($version > 0);
1542
1543         $newdata = $cache->get_versiondata($pagename, $version, true);
1544         if ($newdata) {
1545             assert(is_string($newdata['%content']));
1546             return $newdata['%content'];
1547         }
1548         else {
1549             // else revision has been deleted... What to do?
1550             return __sprintf("Oops! Revision %s of %s seems to have been deleted!",
1551                              $version, $pagename);
1552         }
1553     }
1554
1555     /**
1556      * Get meta-data for this revision.
1557      *
1558      *
1559      * @access public
1560      *
1561      * @param string $key Which meta-data to access.
1562      *
1563      * Some reserved revision meta-data keys are:
1564      * <dl>
1565      * <dt> 'mtime' <dd> Time this revision was created (seconds since midnight Jan 1, 1970.)
1566      *        The 'mtime' meta-value is normally set automatically by the database
1567      *        backend, but it may be specified explicitly when creating a new revision.
1568      * <dt> orig_mtime
1569      *  <dd> To ensure consistency of RecentChanges, the mtimes of the versions
1570      *       of a page must be monotonically increasing.  If an attempt is
1571      *       made to create a new revision with an mtime less than that of
1572      *       the preceeding revision, the new revisions timestamp is force
1573      *       to be equal to that of the preceeding revision.  In that case,
1574      *       the originally requested mtime is preserved in 'orig_mtime'.
1575      * <dt> '_supplanted' <dd> Time this revision ceased to be the most recent.
1576      *        This meta-value is <em>always</em> automatically maintained by the database
1577      *        backend.  (It is set from the 'mtime' meta-value of the superceding
1578      *        revision.)  '_supplanted' has a value of 'false' for the current revision.
1579      *
1580      * FIXME: this could be refactored:
1581      * <dt> author
1582      *  <dd> Author of the page (as he should be reported in, e.g. RecentChanges.)
1583      * <dt> author_id
1584      *  <dd> Authenticated author of a page.  This is used to identify
1585      *       the distinctness of authors when cleaning old revisions from
1586      *       the database.
1587      * <dt> 'is_minor_edit' <dd> Set if change was marked as a minor revision by the author.
1588      * <dt> 'summary' <dd> Short change summary entered by page author.
1589      * </dl>
1590      *
1591      * Meta-data keys must be valid C identifers (they have to start with a letter
1592      * or underscore, and can contain only alphanumerics and underscores.)
1593      *
1594      * @return string The requested value, or false if the requested value
1595      * is not defined.
1596      */
1597     function get($key) {
1598         if (!$key || $key[0] == '%')
1599             return false;
1600         $data = &$this->_data;
1601         return isset($data[$key]) ? $data[$key] : false;
1602     }
1603
1604     /**
1605      * Get all the revision page meta-data as a hash.
1606      *
1607      * @return hash The revision meta-data.
1608      */
1609     function getMetaData() {
1610         $meta = array();
1611         foreach ($this->_data as $key => $val) {
1612             if (!empty($val) && $key[0] != '%')
1613                 $meta[$key] = $val;
1614         }
1615         return $meta;
1616     }
1617
1618
1619     /**
1620      * Return a string representation of the revision.
1621      *
1622      * This is really only for debugging.
1623      *
1624      * @access public
1625      *
1626      * @return string Printable representation of the WikiDB_Page.
1627      */
1628     function asString () {
1629         ob_start();
1630         printf("[%s:%d\n", get_class($this), $this->get('version'));
1631         print_r($this->_data);
1632         echo $this->getPackedContent() . "\n]\n";
1633         $strval = ob_get_contents();
1634         ob_end_clean();
1635         return $strval;
1636     }
1637 };
1638
1639
1640 /**
1641  * Class representing a sequence of WikiDB_Pages.
1642  * TODO: Enhance to php5 iterators
1643  */
1644 class WikiDB_PageIterator
1645 {
1646     function WikiDB_PageIterator(&$wikidb, &$iter, $options=false) {
1647         $this->_iter = $iter; // a WikiDB_backend_iterator
1648         $this->_wikidb = &$wikidb;
1649         $this->_options = $options;
1650     }
1651
1652     function count () {
1653         return $this->_iter->count();
1654     }
1655
1656     /**
1657      * Get next WikiDB_Page in sequence.
1658      *
1659      * @access public
1660      *
1661      * @return WikiDB_Page The next WikiDB_Page in the sequence.
1662      */
1663     function next () {
1664         if ( ! ($next = $this->_iter->next()) )
1665             return false;
1666
1667         $pagename = &$next['pagename'];
1668         if (!$pagename) {
1669             trigger_error('empty pagename in WikiDB_PageIterator::next()', E_USER_WARNING);
1670             var_dump($next);
1671             return false;
1672         }
1673         // there's always hits, but we cache only if more
1674         // (well not with file, cvs and dba)
1675         if (isset($next['pagedata']) and count($next['pagedata']) > 1) {
1676             $this->_wikidb->_cache->cache_data($next);
1677         // cache existing page id's since we iterate over all links in GleanDescription
1678         // and need them later for LinkExistingWord
1679         } elseif ($this->_options and array_key_exists('include_empty', $this->_options)
1680                   and !$this->_options['include_empty'] and isset($next['id'])) {
1681             $this->_wikidb->_cache->_id_cache[$next['pagename']] = $next['id'];
1682         }
1683         return new WikiDB_Page($this->_wikidb, $pagename);
1684     }
1685
1686     /**
1687      * Release resources held by this iterator.
1688      *
1689      * The iterator may not be used after free() is called.
1690      *
1691      * There is no need to call free(), if next() has returned false.
1692      * (I.e. if you iterate through all the pages in the sequence,
1693      * you do not need to call free() --- you only need to call it
1694      * if you stop before the end of the iterator is reached.)
1695      *
1696      * @access public
1697      */
1698     function free() {
1699         $this->_iter->free();
1700     }
1701
1702     function asArray() {
1703         $result = array();
1704         while ($page = $this->next())
1705             $result[] = $page;
1706         //$this->reset();
1707         return $result;
1708     }
1709
1710
1711 };
1712
1713 /**
1714  * A class which represents a sequence of WikiDB_PageRevisions.
1715  * TODO: Enhance to php5 iterators
1716  */
1717 class WikiDB_PageRevisionIterator
1718 {
1719     function WikiDB_PageRevisionIterator(&$wikidb, &$revisions, $options=false) {
1720         $this->_revisions = $revisions;
1721         $this->_wikidb = &$wikidb;
1722         $this->_options = $options;
1723     }
1724
1725     function count () {
1726         return $this->_revisions->count();
1727     }
1728
1729     /**
1730      * Get next WikiDB_PageRevision in sequence.
1731      *
1732      * @access public
1733      *
1734      * @return WikiDB_PageRevision
1735      * The next WikiDB_PageRevision in the sequence.
1736      */
1737     function next () {
1738         if ( ! ($next = $this->_revisions->next()) )
1739             return false;
1740
1741         $this->_wikidb->_cache->cache_data($next);
1742
1743         $pagename = $next['pagename'];
1744         $version = $next['version'];
1745         $versiondata = $next['versiondata'];
1746         if (DEBUG) {
1747             if (!(is_string($pagename) and $pagename != '')) {
1748                 trigger_error("empty pagename",E_USER_WARNING);
1749                 return false;
1750             }
1751         } else assert(is_string($pagename) and $pagename != '');
1752         if (DEBUG) {
1753             if (!is_array($versiondata)) {
1754                 trigger_error("empty versiondata",E_USER_WARNING);
1755                 return false;
1756             }
1757         } else assert(is_array($versiondata));
1758         if (DEBUG) {
1759             if (!($version > 0)) {
1760                 trigger_error("invalid version",E_USER_WARNING);
1761                 return false;
1762             }
1763         } else assert($version > 0);
1764
1765         return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1766                                        $versiondata);
1767     }
1768
1769     /**
1770      * Release resources held by this iterator.
1771      *
1772      * The iterator may not be used after free() is called.
1773      *
1774      * There is no need to call free(), if next() has returned false.
1775      * (I.e. if you iterate through all the revisions in the sequence,
1776      * you do not need to call free() --- you only need to call it
1777      * if you stop before the end of the iterator is reached.)
1778      *
1779      * @access public
1780      */
1781     function free() {
1782         $this->_revisions->free();
1783     }
1784
1785     function asArray() {
1786         $result = array();
1787         while ($rev = $this->next())
1788             $result[] = $rev;
1789         $this->free();
1790         return $result;
1791     }
1792 };
1793
1794 /** pseudo iterator
1795  */
1796 class WikiDB_Array_PageIterator
1797 {
1798     function WikiDB_Array_PageIterator(&$pagenames) {
1799         global $request;
1800         $this->_dbi = $request->getDbh();
1801         $this->_pages = $pagenames;
1802         reset($this->_pages);
1803     }
1804     function next() {
1805         $c =& current($this->_pages);
1806         next($this->_pages);
1807         return $c !== false ? $this->_dbi->getPage($c) : false;
1808     }
1809     function count() {
1810         return count($this->_pages);
1811     }
1812     function free() {}
1813     function asArray() {
1814         reset($this->_pages);
1815         return $this->_pages;
1816     }
1817 }
1818
1819 class WikiDB_Array_generic_iter
1820 {
1821     function WikiDB_Array_generic_iter($result) {
1822         // $result may be either an array or a query result
1823         if (is_array($result)) {
1824             $this->_array = $result;
1825         } elseif (is_object($result)) {
1826             $this->_array = $result->asArray();
1827         } else {
1828             $this->_array = array();
1829         }
1830         if (!empty($this->_array))
1831             reset($this->_array);
1832     }
1833     function next() {
1834         $c =& current($this->_array);
1835         next($this->_array);
1836         return $c !== false ? $c : false;
1837     }
1838     function count() {
1839         return count($this->_array);
1840     }
1841     function free() {}
1842     function asArray() {
1843         if (!empty($this->_array))
1844             reset($this->_array);
1845         return $this->_array;
1846     }
1847 }
1848
1849 /**
1850  * Data cache used by WikiDB.
1851  *
1852  * FIXME: Maybe rename this to caching_backend (or some such).
1853  *
1854  * @access private
1855  */
1856 class WikiDB_cache
1857 {
1858     // FIXME: beautify versiondata cache.  Cache only limited data?
1859
1860     function WikiDB_cache (&$backend) {
1861         $this->_backend = &$backend;
1862
1863         $this->_pagedata_cache = array();
1864         $this->_versiondata_cache = array();
1865         array_push ($this->_versiondata_cache, array());
1866         $this->_glv_cache = array();
1867         $this->_id_cache = array(); // formerly ->_dbi->_iwpcache (nonempty pages => id)
1868     }
1869
1870     function close() {
1871         $this->_pagedata_cache = array();
1872         $this->_versiondata_cache = array();
1873         $this->_glv_cache = array();
1874         $this->_id_cache = array();
1875     }
1876
1877     function get_pagedata($pagename) {
1878         assert(is_string($pagename) && $pagename != '');
1879         if (USECACHE) {
1880             $cache = &$this->_pagedata_cache;
1881             if (!isset($cache[$pagename]) || !is_array($cache[$pagename])) {
1882                 $cache[$pagename] = $this->_backend->get_pagedata($pagename);
1883                 // Never keep a ['%pagedata']['_cached_html'] in cache, other than the current page.
1884                 if (isset($cache[$pagename]['_cached_html'])
1885                     and $pagename != $GLOBALS['request']->getArg('pagename')) {
1886                     unset($cache[$pagename]['_cached_html']);
1887                 }
1888                 if (empty($cache[$pagename]))
1889                     $cache[$pagename] = array();
1890             }
1891             return $cache[$pagename];
1892         } else {
1893             return $this->_backend->get_pagedata($pagename);
1894         }
1895     }
1896
1897     function update_pagedata($pagename, $newdata) {
1898         assert(is_string($pagename) && $pagename != '');
1899
1900         $this->_backend->update_pagedata($pagename, $newdata);
1901
1902         if (USECACHE and is_array($this->_pagedata_cache[$pagename])) {
1903             $cachedata = &$this->_pagedata_cache[$pagename];
1904             foreach($newdata as $key => $val)
1905                 $cachedata[$key] = $val;
1906         }
1907     }
1908
1909     function invalidate_cache($pagename) {
1910         unset ($this->_pagedata_cache[$pagename]);
1911         unset ($this->_versiondata_cache[$pagename]);
1912         unset ($this->_glv_cache[$pagename]);
1913         unset ($this->_id_cache[$pagename]);
1914         //unset ($this->_backend->_page_data);
1915     }
1916
1917     function delete_page($pagename) {
1918         $this->_backend->delete_page($pagename);
1919         $this->invalidate_cache($pagename);
1920     }
1921
1922     // FIXME: ugly
1923     function cache_data($data) {
1924         if (isset($data['pagedata']))
1925             $this->_pagedata_cache[$data['pagename']] = $data['pagedata'];
1926     }
1927
1928     function get_versiondata($pagename, $version, $need_content = false) {
1929         //  FIXME: Seriously ugly hackage
1930         if (USECACHE) {   //temporary - for debugging
1931             assert(is_string($pagename) && $pagename != '');
1932             // there is a bug here somewhere which results in an assertion failure at line 105
1933             // of ArchiveCleaner.php  It goes away if we use the next line.
1934             //$need_content = true;
1935             $nc = $need_content ? '1':'0';
1936             $cache = &$this->_versiondata_cache;
1937             if (!isset($cache[$pagename][$version][$nc])||
1938                 !(is_array ($cache[$pagename])) || !(is_array ($cache[$pagename][$version]))) {
1939                 $cache[$pagename][$version][$nc] =
1940                     $this->_backend->get_versiondata($pagename, $version, $need_content);
1941                 // If we have retrieved all data, we may as well set the cache for $need_content = false
1942                 if ($need_content){
1943                     $cache[$pagename][$version]['0'] =& $cache[$pagename][$version]['1'];
1944                 }
1945             }
1946             $vdata = $cache[$pagename][$version][$nc];
1947         } else {
1948             $vdata = $this->_backend->get_versiondata($pagename, $version, $need_content);
1949         }
1950         // FIXME: ugly.
1951         // Rationale: never keep ['%pagedata']['_cached_html'] in cache.
1952         if ($vdata && !empty($vdata['%pagedata'])) {
1953             $this->_pagedata_cache[$pagename] =& $vdata['%pagedata'];
1954             // only store _cached_html for the requested page
1955             if (USECACHE
1956                 and isset($vdata['%pagedata']['_cached_html'])
1957                 and $pagename != $GLOBALS['request']->getArg('pagename'))
1958             {
1959                 unset($this->_pagedata_cache[$pagename]['_cached_html']);
1960                 unset($cache[$pagename][$version][$nc]['%pagedata']['_cached_html']);
1961                 if ($need_content)
1962                     unset($cache[$pagename][$version][0]['%pagedata']['_cached_html']);
1963             }
1964         }
1965         return $vdata;
1966     }
1967
1968     function set_versiondata($pagename, $version, $data) {
1969         $new = $this->_backend->set_versiondata($pagename, $version, $data);
1970         // Update the cache
1971         $this->_versiondata_cache[$pagename][$version]['1'] = $data;
1972         $this->_versiondata_cache[$pagename][$version]['0'] = $data;
1973         // Is this necessary?
1974         unset($this->_glv_cache[$pagename]);
1975     }
1976
1977     function update_versiondata($pagename, $version, $data) {
1978         $new = $this->_backend->update_versiondata($pagename, $version, $data);
1979         // Update the cache
1980         // FIXME: never keep ['%pagedata']['_cached_html'] in cache.
1981         $this->_versiondata_cache[$pagename][$version]['1'] = $data;
1982         // FIXME: hack
1983         $this->_versiondata_cache[$pagename][$version]['0'] = $data;
1984         // Is this necessary?
1985         unset($this->_glv_cache[$pagename]);
1986     }
1987
1988     function delete_versiondata($pagename, $version) {
1989         $new = $this->_backend->delete_versiondata($pagename, $version);
1990         if (isset($this->_versiondata_cache[$pagename][$version]['1']))
1991             unset ($this->_versiondata_cache[$pagename][$version]['1']);
1992         if (isset($this->_versiondata_cache[$pagename][$version]['0']))
1993             unset ($this->_versiondata_cache[$pagename][$version]['0']);
1994         if (isset($this->_glv_cache[$pagename]))
1995             unset ($this->_glv_cache[$pagename]);
1996     }
1997
1998     function get_latest_version($pagename)  {
1999         if (USECACHE) {
2000             assert (is_string($pagename) && $pagename != '');
2001             $cache = &$this->_glv_cache;
2002             if (!isset($cache[$pagename])) {
2003                 $cache[$pagename] = $this->_backend->get_latest_version($pagename);
2004                 if (empty($cache[$pagename]))
2005                     $cache[$pagename] = 0;
2006             }
2007             return $cache[$pagename];
2008         } else {
2009             return $this->_backend->get_latest_version($pagename);
2010         }
2011     }
2012 };
2013
2014 function _sql_debuglog($msg, $newline=true, $shutdown=false) {
2015     static $fp = false;
2016     static $i = 0;
2017     if (!$fp) {
2018         $stamp = strftime("%y%m%d-%H%M%S");
2019         $fp = fopen("/tmp/sql-$stamp.log", "a");
2020         register_shutdown_function("_sql_debuglog_shutdown_function");
2021     } elseif ($shutdown) {
2022         fclose($fp);
2023         return;
2024     }
2025     if ($newline) fputs($fp, "[$i++] $msg");
2026     else fwrite($fp, $msg);
2027 }
2028 function _sql_debuglog_shutdown_function() {
2029     _sql_debuglog('',false,true);
2030 }
2031
2032 // $Log: not supported by cvs2svn $
2033 // Revision 1.100  2004/11/10 15:29:20  rurban
2034 // * requires newer Pear_DB (as the internal one): quote() uses now escapeSimple for strings
2035 // * ACCESS_LOG_SQL: fix cause request not yet initialized
2036 // * WikiDB: moved SQL specific methods upwards
2037 // * new Pear_DB quoting: same as ADODB and as newer Pear_DB.
2038 //   fixes all around: WikiGroup, WikiUserNew SQL methods, SQL logging
2039 //
2040 // Revision 1.99  2004/11/09 17:11:05  rurban
2041 // * revert to the wikidb ref passing. there's no memory abuse there.
2042 // * use new wikidb->_cache->_id_cache[] instead of wikidb->_iwpcache, to effectively
2043 //   store page ids with getPageLinks (GleanDescription) of all existing pages, which
2044 //   are also needed at the rendering for linkExistingWikiWord().
2045 //   pass options to pageiterator.
2046 //   use this cache also for _get_pageid()
2047 //   This saves about 8 SELECT count per page (num all pagelinks).
2048 // * fix passing of all page fields to the pageiterator.
2049 // * fix overlarge session data which got broken with the latest ACCESS_LOG_SQL changes
2050 //
2051 // Revision 1.98  2004/11/07 18:34:29  rurban
2052 // more logging fixes
2053 //
2054 // Revision 1.97  2004/11/07 16:02:51  rurban
2055 // new sql access log (for spam prevention), and restructured access log class
2056 // dbh->quote (generic)
2057 // pear_db: mysql specific parts seperated (using replace)
2058 //
2059 // Revision 1.96  2004/11/05 22:32:15  rurban
2060 // encode the subject to be 7-bit safe
2061 //
2062 // Revision 1.95  2004/11/05 20:53:35  rurban
2063 // login cleanup: better debug msg on failing login,
2064 // checked password less immediate login (bogo or anon),
2065 // checked olduser pref session error,
2066 // better PersonalPage without password warning on minimal password length=0
2067 //   (which is default now)
2068 //
2069 // Revision 1.94  2004/11/01 10:43:56  rurban
2070 // seperate PassUser methods into seperate dir (memory usage)
2071 // fix WikiUser (old) overlarge data session
2072 // remove wikidb arg from various page class methods, use global ->_dbi instead
2073 // ...
2074 //
2075 // Revision 1.93  2004/10/14 17:17:57  rurban
2076 // remove dbi WikiDB_Page param: use global request object instead. (memory)
2077 // allow most_popular sortby arguments
2078 //
2079 // Revision 1.92  2004/10/05 17:00:04  rurban
2080 // support paging for simple lists
2081 // fix RatingDb sql backend.
2082 // remove pages from AllPages (this is ListPages then)
2083 //
2084 // Revision 1.91  2004/10/04 23:41:19  rurban
2085 // delete notify: fix, @unset syntax error
2086 //
2087 // Revision 1.90  2004/09/28 12:50:22  rurban
2088 // https://sourceforge.net/forum/forum.php?thread_id=1150924&forum_id=18929
2089 //
2090 // Revision 1.89  2004/09/26 10:54:42  rurban
2091 // silence deferred check
2092 //
2093 // Revision 1.88  2004/09/25 18:16:40  rurban
2094 // unset more unneeded _cached_html. (Guess this should fix sf.net now)
2095 //
2096 // Revision 1.87  2004/09/25 16:25:40  rurban
2097 // notify on rename and remove (to be improved)
2098 //
2099 // Revision 1.86  2004/09/23 18:52:06  rurban
2100 // only fortune at create
2101 //
2102 // Revision 1.85  2004/09/16 08:00:51  rurban
2103 // just some comments
2104 //
2105 // Revision 1.84  2004/09/14 10:34:30  rurban
2106 // fix TransformedText call to use refs
2107 //
2108 // Revision 1.83  2004/09/08 13:38:00  rurban
2109 // improve loadfile stability by using markup=2 as default for undefined markup-style.
2110 // use more refs for huge objects.
2111 // fix debug=static issue in WikiPluginCached
2112 //
2113 // Revision 1.82  2004/09/06 12:08:49  rurban
2114 // memory_limit on unix workaround
2115 // VisualWiki: default autosize image
2116 //
2117 // Revision 1.81  2004/09/06 08:28:00  rurban
2118 // rename genericQuery to genericSqlQuery
2119 //
2120 // Revision 1.80  2004/07/09 13:05:34  rurban
2121 // just aesthetics
2122 //
2123 // Revision 1.79  2004/07/09 10:06:49  rurban
2124 // Use backend specific sortby and sortable_columns method, to be able to
2125 // select between native (Db backend) and custom (PageList) sorting.
2126 // Fixed PageList::AddPageList (missed the first)
2127 // Added the author/creator.. name to AllPagesBy...
2128 //   display no pages if none matched.
2129 // Improved dba and file sortby().
2130 // Use &$request reference
2131 //
2132 // Revision 1.78  2004/07/08 21:32:35  rurban
2133 // Prevent from more warnings, minor db and sort optimizations
2134 //
2135 // Revision 1.77  2004/07/08 19:04:42  rurban
2136 // more unittest fixes (file backend, metadata RatingsDb)
2137 //
2138 // Revision 1.76  2004/07/08 17:31:43  rurban
2139 // improve numPages for file (fixing AllPagesTest)
2140 //
2141 // Revision 1.75  2004/07/05 13:56:22  rurban
2142 // sqlite autoincrement fix
2143 //
2144 // Revision 1.74  2004/07/03 16:51:05  rurban
2145 // optional DBADMIN_USER:DBADMIN_PASSWD for action=upgrade (if no ALTER permission)
2146 // added atomic mysql REPLACE for PearDB as in ADODB
2147 // fixed _lock_tables typo links => link
2148 // fixes unserialize ADODB bug in line 180
2149 //
2150 // Revision 1.73  2004/06/29 08:52:22  rurban
2151 // Use ...version() $need_content argument in WikiDB also:
2152 // To reduce the memory footprint for larger sets of pagelists,
2153 // we don't cache the content (only true or false) and
2154 // we purge the pagedata (_cached_html) also.
2155 // _cached_html is only cached for the current pagename.
2156 // => Vastly improved page existance check, ACL check, ...
2157 //
2158 // Now only PagedList info=content or size needs the whole content, esp. if sortable.
2159 //
2160 // Revision 1.72  2004/06/25 14:15:08  rurban
2161 // reduce memory footprint by caching only requested pagedate content (improving most page iterators)
2162 //
2163 // Revision 1.71  2004/06/21 16:22:30  rurban
2164 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
2165 // fixed dumping buttons locally (images/buttons/),
2166 // support pages arg for dumphtml,
2167 // optional directory arg for dumpserial + dumphtml,
2168 // fix a AllPages warning,
2169 // show dump warnings/errors on DEBUG,
2170 // don't warn just ignore on wikilens pagelist columns, if not loaded.
2171 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
2172 //
2173 // Revision 1.70  2004/06/18 14:39:31  rurban
2174 // actually check USECACHE
2175 //
2176 // Revision 1.69  2004/06/13 15:33:20  rurban
2177 // new support for arguments owner, author, creator in most relevant
2178 // PageList plugins. in WikiAdmin* via preSelectS()
2179 //
2180 // Revision 1.68  2004/06/08 21:03:20  rurban
2181 // updated RssParser for XmlParser quirks (store parser object params in globals)
2182 //
2183 // Revision 1.67  2004/06/07 19:12:49  rurban
2184 // fixed rename version=0, bug #966284
2185 //
2186 // Revision 1.66  2004/06/07 18:57:27  rurban
2187 // fix rename: Change pagename in all linked pages
2188 //
2189 // Revision 1.65  2004/06/04 20:32:53  rurban
2190 // Several locale related improvements suggested by Pierrick Meignen
2191 // LDAP fix by John Cole
2192 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
2193 //
2194 // Revision 1.64  2004/06/04 16:50:00  rurban
2195 // add random quotes to empty pages
2196 //
2197 // Revision 1.63  2004/06/04 11:58:38  rurban
2198 // added USE_TAGLINES
2199 //
2200 // Revision 1.62  2004/06/03 22:24:41  rurban
2201 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
2202 //
2203 // Revision 1.61  2004/06/02 17:13:48  rurban
2204 // fix getRevisionBefore assertion
2205 //
2206 // Revision 1.60  2004/05/28 10:09:58  rurban
2207 // fix bug #962117, incorrect init of auth_dsn
2208 //
2209 // Revision 1.59  2004/05/27 17:49:05  rurban
2210 // renamed DB_Session to DbSession (in CVS also)
2211 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
2212 // remove leading slash in error message
2213 // added force_unlock parameter to File_Passwd (no return on stale locks)
2214 // fixed adodb session AffectedRows
2215 // added FileFinder helpers to unify local filenames and DATA_PATH names
2216 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
2217 //
2218 // Revision 1.58  2004/05/18 13:59:14  rurban
2219 // rename simpleQuery to genericQuery
2220 //
2221 // Revision 1.57  2004/05/16 22:07:35  rurban
2222 // check more config-default and predefined constants
2223 // various PagePerm fixes:
2224 //   fix default PagePerms, esp. edit and view for Bogo and Password users
2225 //   implemented Creator and Owner
2226 //   BOGOUSERS renamed to BOGOUSER
2227 // fixed syntax errors in signin.tmpl
2228 //
2229 // Revision 1.56  2004/05/15 22:54:49  rurban
2230 // fixed important WikiDB bug with DEBUG > 0: wrong assertion
2231 // improved SetAcl (works) and PagePerms, some WikiGroup helpers.
2232 //
2233 // Revision 1.55  2004/05/12 19:27:47  rurban
2234 // revert wrong inline optimization.
2235 //
2236 // Revision 1.54  2004/05/12 10:49:55  rurban
2237 // require_once fix for those libs which are loaded before FileFinder and
2238 //   its automatic include_path fix, and where require_once doesn't grok
2239 //   dirname(__FILE__) != './lib'
2240 // upgrade fix with PearDB
2241 // navbar.tmpl: remove spaces for IE &nbsp; button alignment
2242 //
2243 // Revision 1.53  2004/05/08 14:06:12  rurban
2244 // new support for inlined image attributes: [image.jpg size=50x30 align=right]
2245 // minor stability and portability fixes
2246 //
2247 // Revision 1.52  2004/05/06 19:26:16  rurban
2248 // improve stability, trying to find the InlineParser endless loop on sf.net
2249 //
2250 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
2251 //
2252 // Revision 1.51  2004/05/06 17:30:37  rurban
2253 // CategoryGroup: oops, dos2unix eol
2254 // improved phpwiki_version:
2255 //   pre -= .0001 (1.3.10pre: 1030.099)
2256 //   -p1 += .001 (1.3.9-p1: 1030.091)
2257 // improved InstallTable for mysql and generic SQL versions and all newer tables so far.
2258 // abstracted more ADODB/PearDB methods for action=upgrade stuff:
2259 //   backend->backendType(), backend->database(),
2260 //   backend->listOfFields(),
2261 //   backend->listOfTables(),
2262 //
2263 // Revision 1.50  2004/05/04 22:34:25  rurban
2264 // more pdf support
2265 //
2266 // Revision 1.49  2004/05/03 11:16:40  rurban
2267 // fixed sendPageChangeNotification
2268 // subject rewording
2269 //
2270 // Revision 1.48  2004/04/29 23:03:54  rurban
2271 // fixed sf.net bug #940996
2272 //
2273 // Revision 1.47  2004/04/29 19:39:44  rurban
2274 // special support for formatted plugins (one-liners)
2275 //   like <small><plugin BlaBla ></small>
2276 // iter->asArray() helper for PopularNearby
2277 // db_session for older php's (no &func() allowed)
2278 //
2279 // Revision 1.46  2004/04/26 20:44:34  rurban
2280 // locking table specific for better databases
2281 //
2282 // Revision 1.45  2004/04/20 00:06:03  rurban
2283 // themable paging support
2284 //
2285 // Revision 1.44  2004/04/19 18:27:45  rurban
2286 // Prevent from some PHP5 warnings (ref args, no :: object init)
2287 //   php5 runs now through, just one wrong XmlElement object init missing
2288 // Removed unneccesary UpgradeUser lines
2289 // Changed WikiLink to omit version if current (RecentChanges)
2290 //
2291 // Revision 1.43  2004/04/18 01:34:20  rurban
2292 // protect most_popular from sortby=mtime
2293 //
2294 // Revision 1.42  2004/04/18 01:11:51  rurban
2295 // more numeric pagename fixes.
2296 // fixed action=upload with merge conflict warnings.
2297 // charset changed from constant to global (dynamic utf-8 switching)
2298 //
2299
2300 // Local Variables:
2301 // mode: php
2302 // tab-width: 8
2303 // c-basic-offset: 4
2304 // c-hanging-comment-ender-p: nil
2305 // indent-tabs-mode: nil
2306 // End:
2307 ?>