lib/WikiDB.php

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