lib/WikiDB.php

   1 <?php //-*-php-*-
   2 rcs_id('$Id: WikiDB.php,v 1.60 2004-05-28 10:09:58 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             if ($oldpage->exists() and ! $newpage->exists()) {
 389                 if ($result = $this->_backend->rename_page($from, $to)) {
 390                     //update all WikiLinks in existing pages
 391                     if ($updateWikiLinks) {
 392                         //trigger_error(_("WikiDB::renamePage(..,..,updateWikiLinks) not yet implemented"),E_USER_WARNING);
 393                         require_once('lib/plugin/WikiAdminSearchReplace.php');
 394                         $links = $oldpage->getLinks();
 395                         while ($linked_page = $links->next()) {
 396                             WikiPlugin_WikiAdminSearchReplace::replaceHelper($this,$linked_page->getName(),$from,$to);
 397                         }
 398                         $links = $newpage->getLinks();
 399                         while ($linked_page = $links->next()) {
 400                             WikiPlugin_WikiAdminSearchReplace::replaceHelper($this,$linked_page->getName(),$from,$to);
 401                         }
 402                     }
 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             }
 412         } else {
 413             trigger_error(_("WikiDB::renamePage() not yet implemented for this backend"),E_USER_WARNING);
 414         }
 415         return $result;
 416     }
 417
 418     /** Get timestamp when database was last modified.
 419      *
 420      * @return string A string consisting of two integers,
 421      * separated by a space.  The first is the time in
 422      * unix timestamp format, the second is a modification
 423      * count for the database.
 424      *
 425      * The idea is that you can cast the return value to an
 426      * int to get a timestamp, or you can use the string value
 427      * as a good hash for the entire database.
 428      */
 429     function getTimestamp() {
 430         $ts = $this->get('_timestamp');
 431         return sprintf("%d %d", $ts[0], $ts[1]);
 432     }
 433
 434     /**
 435      * Update the database timestamp.
 436      *
 437      */
 438     function touch() {
 439         $ts = $this->get('_timestamp');
 440         $this->set('_timestamp', array(time(), $ts[1] + 1));
 441     }
 442
 443
 444     /**
 445      * Access WikiDB global meta-data.
 446      *
 447      * NOTE: this is currently implemented in a hackish and
 448      * not very efficient manner.
 449      *
 450      * @access public
 451      *
 452      * @param string $key Which meta data to get.
 453      * Some reserved meta-data keys are:
 454      * <dl>
 455      * <dt>'_timestamp' <dd> Data used by getTimestamp().
 456      * </dl>
 457      *
 458      * @return scalar The requested value, or false if the requested data
 459      * is not set.
 460      */
 461     function get($key) {
 462         if (!$key || $key[0] == '%')
 463             return false;
 464         /*
 465          * Hack Alert: We can use any page (existing or not) to store
 466          * this data (as long as we always use the same one.)
 467          */
 468         $gd = $this->getPage('global_data');
 469         $data = $gd->get('__global');
 470
 471         if ($data && isset($data[$key]))
 472             return $data[$key];
 473         else
 474             return false;
 475     }
 476
 477     /**
 478      * Set global meta-data.
 479      *
 480      * NOTE: this is currently implemented in a hackish and
 481      * not very efficient manner.
 482      *
 483      * @see get
 484      * @access public
 485      *
 486      * @param string $key  Meta-data key to set.
 487      * @param string $newval  New value.
 488      */
 489     function set($key, $newval) {
 490         if (!$key || $key[0] == '%')
 491             return;
 492
 493         $gd = $this->getPage('global_data');
 494
 495         $data = $gd->get('__global');
 496         if ($data === false)
 497             $data = array();
 498
 499         if (empty($newval))
 500             unset($data[$key]);
 501         else
 502             $data[$key] = $newval;
 503
 504         $gd->set('__global', $data);
 505     }
 506
 507     // simple select or create/update queries
 508     function genericQuery($sql) {
 509         global $DBParams;
 510         if ($DBParams['dbtype'] == 'SQL') {
 511             $result = $this->_backend->_dbh->query($sql);
 512             if (DB::isError($result)) {
 513                 $msg = $result->getMessage();
 514                 trigger_error("SQL Error: ".DB::errorMessage($result), E_USER_WARNING);
 515                 return false;
 516             } else {
 517                 return $result;
 518             }
 519         } elseif ($DBParams['dbtype'] == 'ADODB') {
 520             if (!($result = $this->_backend->_dbh->Execute($sql))) {
 521                 trigger_error("SQL Error: ".$this->_backend->_dbh->ErrorMsg(), E_USER_WARNING);
 522                 return false;
 523             } else {
 524                 return $result;
 525             }
 526         }
 527         return false;
 528     }
 529
 530     function getParam($param) {
 531         global $DBParams;
 532         if (isset($DBParams[$param])) return $DBParams[$param];
 533         elseif ($param == 'prefix') return '';
 534         else return false;
 535     }
 536
 537     function getAuthParam($param) {
 538         global $DBAuthParams;
 539         if (isset($DBAuthParams[$param])) return $DBAuthParams[$param];
 540         elseif ($param == 'USER_AUTH_ORDER') return $GLOBALS['USER_AUTH_ORDER'];
 541         elseif ($param == 'USER_AUTH_POLICY') return $GLOBALS['USER_AUTH_POLICY'];
 542         else return false;
 543     }
 544 };
 545
 546
 547 /**
 548  * An abstract base class which representing a wiki-page within a
 549  * WikiDB.
 550  *
 551  * A WikiDB_Page contains a number (at least one) of
 552  * WikiDB_PageRevisions.
 553  */
 554 class WikiDB_Page
 555 {
 556     function WikiDB_Page(&$wikidb, $pagename) {
 557         $this->_wikidb = &$wikidb;
 558         $this->_pagename = $pagename;
 559         if (DEBUG) {
 560             if (!(is_string($pagename) and $pagename != '')) {
 561                 if (function_exists("xdebug_get_function_stack")) {
 562                     echo "xdebug_get_function_stack(): "; var_dump(xdebug_get_function_stack());
 563
 564                 }
 565                 trigger_error("empty pagename",E_USER_WARNING);
 566                 return false;
 567             }
 568         } else assert(is_string($pagename) and $pagename != '');
 569     }
 570
 571     /**
 572      * Get the name of the wiki page.
 573      *
 574      * @access public
 575      *
 576      * @return string The page name.
 577      */
 578     function getName() {
 579         return $this->_pagename;
 580     }
 581
 582     function exists() {
 583         $current = $this->getCurrentRevision();
 584         return ! $current->hasDefaultContents();
 585     }
 586
 587     /**
 588      * Delete an old revision of a WikiDB_Page.
 589      *
 590      * Deletes the specified revision of the page.
 591      * It is a fatal error to attempt to delete the current revision.
 592      *
 593      * @access public
 594      *
 595      * @param integer $version Which revision to delete.  (You can also
 596      *  use a WikiDB_PageRevision object here.)
 597      */
 598     function deleteRevision($version) {
 599         $backend = &$this->_wikidb->_backend;
 600         $cache = &$this->_wikidb->_cache;
 601         $pagename = &$this->_pagename;
 602
 603         $version = $this->_coerce_to_version($version);
 604         if ($version == 0)
 605             return;
 606
 607         $backend->lock(array('page','version'));
 608         $latestversion = $cache->get_latest_version($pagename);
 609         if ($latestversion && $version == $latestversion) {
 610             $backend->unlock(array('page','version'));
 611             trigger_error(sprintf("Attempt to delete most recent revision of '%s'",
 612                                   $pagename), E_USER_ERROR);
 613             return;
 614         }
 615
 616         $cache->delete_versiondata($pagename, $version);
 617         $backend->unlock(array('page','version'));
 618     }
 619
 620     /*
 621      * Delete a revision, or possibly merge it with a previous
 622      * revision.
 623      *
 624      * The idea is this:
 625      * Suppose an author make a (major) edit to a page.  Shortly
 626      * after that the same author makes a minor edit (e.g. to fix
 627      * spelling mistakes he just made.)
 628      *
 629      * Now some time later, where cleaning out old saved revisions,
 630      * and would like to delete his minor revision (since there's
 631      * really no point in keeping minor revisions around for a long
 632      * time.)
 633      *
 634      * Note that the text after the minor revision probably represents
 635      * what the author intended to write better than the text after
 636      * the preceding major edit.
 637      *
 638      * So what we really want to do is merge the minor edit with the
 639      * preceding edit.
 640      *
 641      * We will only do this when:
 642      * <ul>
 643      * <li>The revision being deleted is a minor one, and
 644      * <li>It has the same author as the immediately preceding revision.
 645      * </ul>
 646      */
 647     function mergeRevision($version) {
 648         $backend = &$this->_wikidb->_backend;
 649         $cache = &$this->_wikidb->_cache;
 650         $pagename = &$this->_pagename;
 651
 652         $version = $this->_coerce_to_version($version);
 653         if ($version == 0)
 654             return;
 655
 656         $backend->lock(array('version'));
 657         $latestversion = $backend->get_latest_version($pagename);
 658         if ($latestversion && $version == $latestversion) {
 659             $backend->unlock(array('version'));
 660             trigger_error(sprintf("Attempt to merge most recent revision of '%s'",
 661                                   $pagename), E_USER_ERROR);
 662             return;
 663         }
 664
 665         $versiondata = $cache->get_versiondata($pagename, $version, true);
 666         if (!$versiondata) {
 667             // Not there? ... we're done!
 668             $backend->unlock(array('version'));
 669             return;
 670         }
 671
 672         if ($versiondata['is_minor_edit']) {
 673             $previous = $backend->get_previous_version($pagename, $version);
 674             if ($previous) {
 675                 $prevdata = $cache->get_versiondata($pagename, $previous);
 676                 if ($prevdata['author_id'] == $versiondata['author_id']) {
 677                     // This is a minor revision, previous version is
 678                     // by the same author. We will merge the
 679                     // revisions.
 680                     $cache->update_versiondata($pagename, $previous,
 681                                                array('%content' => $versiondata['%content'],
 682                                                      '_supplanted' => $versiondata['_supplanted']));
 683                 }
 684             }
 685         }
 686
 687         $cache->delete_versiondata($pagename, $version);
 688         $backend->unlock(array('version'));
 689     }
 690
 691
 692     /**
 693      * Create a new revision of a {@link WikiDB_Page}.
 694      *
 695      * @access public
 696      *
 697      * @param int $version Version number for new revision.
 698      * To ensure proper serialization of edits, $version must be
 699      * exactly one higher than the current latest version.
 700      * (You can defeat this check by setting $version to
 701      * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
 702      *
 703      * @param string $content Contents of new revision.
 704      *
 705      * @param hash $metadata Metadata for new revision.
 706      * All values in the hash should be scalars (strings or integers).
 707      *
 708      * @param array $links List of pagenames which this page links to.
 709      *
 710      * @return WikiDB_PageRevision  Returns the new WikiDB_PageRevision object. If
 711      * $version was incorrect, returns false
 712      */
 713     function createRevision($version, &$content, $metadata, $links) {
 714         $backend = &$this->_wikidb->_backend;
 715         $cache = &$this->_wikidb->_cache;
 716         $pagename = &$this->_pagename;
 717
 718         $backend->lock(array('version','page','recent','links','nonempty'));
 719
 720         $latestversion = $backend->get_latest_version($pagename);
 721         $newversion = $latestversion + 1;
 722         assert($newversion >= 1);
 723
 724         if ($version != WIKIDB_FORCE_CREATE && $version != $newversion) {
 725             $backend->unlock(array('version','page','recent','links'));
 726             return false;
 727         }
 728
 729         $data = $metadata;
 730
 731         foreach ($data as $key => $val) {
 732             if (empty($val) || $key[0] == '_' || $key[0] == '%')
 733                 unset($data[$key]);
 734         }
 735
 736         assert(!empty($data['author']));
 737         if (empty($data['author_id']))
 738             @$data['author_id'] = $data['author'];
 739
 740         if (empty($data['mtime']))
 741             $data['mtime'] = time();
 742
 743         if ($latestversion) {
 744             // Ensure mtimes are monotonic.
 745             $pdata = $cache->get_versiondata($pagename, $latestversion);
 746             if ($data['mtime'] < $pdata['mtime']) {
 747                 trigger_error(sprintf(_("%s: Date of new revision is %s"),
 748                                       $pagename,"'non-monotonic'"),
 749                               E_USER_NOTICE);
 750                 $data['orig_mtime'] = $data['mtime'];
 751                 $data['mtime'] = $pdata['mtime'];
 752             }
 753
 754             // FIXME: use (possibly user specified) 'mtime' time or
 755             // time()?
 756             $cache->update_versiondata($pagename, $latestversion,
 757                                        array('_supplanted' => $data['mtime']));
 758         }
 759
 760         $data['%content'] = &$content;
 761
 762         $cache->set_versiondata($pagename, $newversion, $data);
 763
 764         //$cache->update_pagedata($pagename, array(':latestversion' => $newversion,
 765         //':deleted' => empty($content)));
 766
 767         $backend->set_links($pagename, $links);
 768
 769         $backend->unlock(array('version','page','recent','links','nonempty'));
 770
 771         return new WikiDB_PageRevision($this->_wikidb, $pagename, $newversion,
 772                                        $data);
 773     }
 774
 775     /** A higher-level interface to createRevision.
 776      *
 777      * This takes care of computing the links, and storing
 778      * a cached version of the transformed wiki-text.
 779      *
 780      * @param string $wikitext  The page content.
 781      *
 782      * @param int $version Version number for new revision.
 783      * To ensure proper serialization of edits, $version must be
 784      * exactly one higher than the current latest version.
 785      * (You can defeat this check by setting $version to
 786      * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
 787      *
 788      * @param hash $meta  Meta-data for new revision.
 789      */
 790     function save($wikitext, $version, $meta) {
 791         $formatted = new TransformedText($this, $wikitext, $meta);
 792         $type = $formatted->getType();
 793         $meta['pagetype'] = $type->getName();
 794         $links = $formatted->getWikiPageLinks();
 795
 796         $backend = &$this->_wikidb->_backend;
 797         $newrevision = $this->createRevision($version, $wikitext, $meta, $links);
 798         if ($newrevision)
 799             if (!defined('WIKIDB_NOCACHE_MARKUP') or !WIKIDB_NOCACHE_MARKUP)
 800                 $this->set('_cached_html', $formatted->pack());
 801
 802         // FIXME: probably should have some global state information
 803         // in the backend to control when to optimize.
 804         //
 805         // We're doing this here rather than in createRevision because
 806         // postgres can't optimize while locked.
 807         if (time() % 50 == 0) {
 808             if ($backend->optimize())
 809                 trigger_error(sprintf(_("Optimizing %s"),'backend'), E_USER_NOTICE);
 810         }
 811
 812         /* Generate notification emails? */
 813         if (isa($newrevision, 'wikidb_pagerevision')) {
 814             // Save didn't fail because of concurrent updates.
 815             $notify = $this->_wikidb->get('notify');
 816             if (!empty($notify) and is_array($notify)) {
 817                 list($emails,$userids) = $this->getPageChangeEmails($notify);
 818                 if (!empty($emails))
 819                     $this->sendPageChangeNotification($wikitext, $version, $meta, $emails, $userids);
 820             }
 821         }
 822
 823         $newrevision->_transformedContent = $formatted;
 824         return $newrevision;
 825     }
 826
 827     function getPageChangeEmails($notify) {
 828         $emails = array(); $userids = array();
 829         foreach ($notify as $page => $users) {
 830             if (glob_match($page,$this->_pagename)) {
 831                 foreach ($users as $userid => $user) {
 832                     if (!empty($user['verified']) and !empty($user['email'])) {
 833                         $emails[]  = $user['email'];
 834                         $userids[] = $userid;
 835                     } elseif (!empty($user['email'])) {
 836                         global $request;
 837                         // do a dynamic emailVerified check update
 838                         $u = $request->getUser();
 839                         if ($u->UserName() == $userid) {
 840                             if ($request->_prefs->get('emailVerified')) {
 841                                 $emails[] = $user['email'];
 842                                 $userids[] = $userid;
 843                                 $notify[$page][$userid]['verified'] = 1;
 844                                 $request->_dbi->set('notify',$notify);
 845                             }
 846                         } else {
 847                             $u = WikiUser($userid);
 848                             if ($u->_prefs->get('emailVerified')) {
 849                                 $emails[] = $user['email'];
 850                                 $userids[] = $userid;
 851                                 $notify[$page][$userid]['verified'] = 1;
 852                                 $request->_dbi->set('notify',$notify);
 853                             }
 854                         }
 855                         // ignore verification
 856                         /*
 857                         if (DEBUG) {
 858                             if (!in_array($user['email'],$emails))
 859                                 $emails[] = $user['email'];
 860                         }
 861                         */
 862                     }
 863                 }
 864             }
 865         }
 866         $emails = array_unique($emails);
 867         $userids = array_unique($userids);
 868         return array($emails,$userids);
 869     }
 870
 871     function sendPageChangeNotification(&$wikitext, $version, $meta, $emails, $userids) {
 872         $backend = &$this->_wikidb->_backend;
 873         $subject = _("Page change").' '.$this->_pagename;
 874         $previous = $backend->get_previous_version($this->_pagename, $version);
 875         if (!isset($meta['mtime'])) $meta['mtime'] = time();
 876         if ($previous) {
 877             $difflink = WikiURL($this->_pagename,array('action'=>'diff'),true);
 878             $cache = &$this->_wikidb->_cache;
 879             $this_content = explode("\n", $wikitext);
 880             $prevdata = $cache->get_versiondata($this->_pagename, $previous, true);
 881             if (empty($prevdata['%content']))
 882                 $prevdata = $backend->get_versiondata($this->_pagename, $previous, true);
 883             $other_content = explode("\n", $prevdata['%content']);
 884
 885             include_once("lib/diff.php");
 886             $diff2 = new Diff($other_content, $this_content);
 887             $context_lines = max(4, count($other_content) + 1,
 888                                  count($this_content) + 1);
 889             $fmt = new UnifiedDiffFormatter($context_lines);
 890             $content  = $this->_pagename . " " . $previous . " " . Iso8601DateTime($prevdata['mtime']) . "\n";
 891             $content .= $this->_pagename . " " . $version . " " .  Iso8601DateTime($meta['mtime']) . "\n";
 892             $content .= $fmt->format($diff2);
 893
 894         } else {
 895             $difflink = WikiURL($this->_pagename,array(),true);
 896             $content = $this->_pagename . " " . $version . " " .  Iso8601DateTime($meta['mtime']) . "\n";
 897             $content .= _("New Page");
 898         }
 899         $editedby = sprintf(_("Edited by: %s"), $meta['author']);
 900         $emails = join(',',$emails);
 901         if (mail($emails,"[".WIKI_NAME."] ".$subject,
 902                  $subject."\n".
 903                  $editedby."\n".
 904                  $difflink."\n\n".
 905                  $content))
 906             trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
 907                                   $this->_pagename, join(',',$userids)), E_USER_NOTICE);
 908         else
 909             trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
 910                                   $this->_pagename, join(',',$userids)), E_USER_WARNING);
 911     }
 912
 913     /**
 914      * Get the most recent revision of a page.
 915      *
 916      * @access public
 917      *
 918      * @return WikiDB_PageRevision The current WikiDB_PageRevision object.
 919      */
 920     function getCurrentRevision() {
 921         $backend = &$this->_wikidb->_backend;
 922         $cache = &$this->_wikidb->_cache;
 923         $pagename = &$this->_pagename;
 924
 925         // Prevent deadlock in case of memory exhausted errors
 926         // Pure selection doesn't really need locking here.
 927         //   sf.net bug#927395
 928         // I know it would be better, but with lots of pages this deadlock is more
 929         // severe than occasionally get not the latest revision.
 930         //$backend->lock();
 931         $version = $cache->get_latest_version($pagename);
 932         $revision = $this->getRevision($version);
 933         //$backend->unlock();
 934         assert($revision);
 935         return $revision;
 936     }
 937
 938     /**
 939      * Get a specific revision of a WikiDB_Page.
 940      *
 941      * @access public
 942      *
 943      * @param integer $version  Which revision to get.
 944      *
 945      * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or
 946      * false if the requested revision does not exist in the {@link WikiDB}.
 947      * Note that version zero of any page always exists.
 948      */
 949     function getRevision($version) {
 950         $cache = &$this->_wikidb->_cache;
 951         $pagename = &$this->_pagename;
 952
 953         if ($version == 0)
 954             return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
 955
 956         assert($version > 0);
 957         $vdata = $cache->get_versiondata($pagename, $version);
 958         if (!$vdata)
 959             return false;
 960         return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
 961                                        $vdata);
 962     }
 963
 964     /**
 965      * Get previous page revision.
 966      *
 967      * This method find the most recent revision before a specified
 968      * version.
 969      *
 970      * @access public
 971      *
 972      * @param integer $version  Find most recent revision before this version.
 973      *  You can also use a WikiDB_PageRevision object to specify the $version.
 974      *
 975      * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or false if the
 976      * requested revision does not exist in the {@link WikiDB}.  Note that
 977      * unless $version is greater than zero, a revision (perhaps version zero,
 978      * the default revision) will always be found.
 979      */
 980     function getRevisionBefore($version) {
 981         $backend = &$this->_wikidb->_backend;
 982         $pagename = &$this->_pagename;
 983
 984         $version = $this->_coerce_to_version($version);
 985
 986         if ($version == 0)
 987             return false;
 988         //$backend->lock();
 989         $previous = $backend->get_previous_version($pagename, $version);
 990         $revision = $this->getRevision($previous);
 991         //$backend->unlock();
 992         assert($revision);
 993         return $revision;
 994     }
 995
 996     /**
 997      * Get all revisions of the WikiDB_Page.
 998      *
 999      * This does not include the version zero (default) revision in the
1000      * returned revision set.
1001      *
1002      * @return WikiDB_PageRevisionIterator A
1003      * WikiDB_PageRevisionIterator containing all revisions of this
1004      * WikiDB_Page in reverse order by version number.
1005      */
1006     function getAllRevisions() {
1007         $backend = &$this->_wikidb->_backend;
1008         $revs = $backend->get_all_revisions($this->_pagename);
1009         return new WikiDB_PageRevisionIterator($this->_wikidb, $revs);
1010     }
1011
1012     /**
1013      * Find pages which link to or are linked from a page.
1014      *
1015      * @access public
1016      *
1017      * @param boolean $reversed Which links to find: true for backlinks (default).
1018      *
1019      * @return WikiDB_PageIterator A WikiDB_PageIterator containing
1020      * all matching pages.
1021      */
1022     function getLinks($reversed = true) {
1023         $backend = &$this->_wikidb->_backend;
1024         $result =  $backend->get_links($this->_pagename, $reversed);
1025         return new WikiDB_PageIterator($this->_wikidb, $result);
1026     }
1027
1028     function getBackLinks() {
1029         return $this->getLinks(true);
1030     }
1031     function getPageLinks() {
1032         return $this->getLinks(false);
1033     }
1034
1035     /**
1036      * Access WikiDB_Page meta-data.
1037      *
1038      * @access public
1039      *
1040      * @param string $key Which meta data to get.
1041      * Some reserved meta-data keys are:
1042      * <dl>
1043      * <dt>'locked'<dd> Is page locked?
1044      * <dt>'hits'  <dd> Page hit counter.
1045      * <dt>'pref'  <dd> Users preferences, stored in homepages.
1046      * <dt>'owner' <dd> Default: first author_id. We might add a group with a dot here:
1047      *                  E.g. "owner.users"
1048      * <dt>'perm'  <dd> Permission flag to authorize read/write/execution of
1049      *                  page-headers and content.
1050      * <dt>'score' <dd> Page score (not yet implement, do we need?)
1051      * </dl>
1052      *
1053      * @return scalar The requested value, or false if the requested data
1054      * is not set.
1055      */
1056     function get($key) {
1057         $cache = &$this->_wikidb->_cache;
1058         if (!$key || $key[0] == '%')
1059             return false;
1060         $data = $cache->get_pagedata($this->_pagename);
1061         return isset($data[$key]) ? $data[$key] : false;
1062     }
1063
1064     /**
1065      * Get all the page meta-data as a hash.
1066      *
1067      * @return hash The page meta-data.
1068      */
1069     function getMetaData() {
1070         $cache = &$this->_wikidb->_cache;
1071         $data = $cache->get_pagedata($this->_pagename);
1072         $meta = array();
1073         foreach ($data as $key => $val) {
1074             if (/*!empty($val) &&*/ $key[0] != '%')
1075                 $meta[$key] = $val;
1076         }
1077         return $meta;
1078     }
1079
1080     /**
1081      * Set page meta-data.
1082      *
1083      * @see get
1084      * @access public
1085      *
1086      * @param string $key  Meta-data key to set.
1087      * @param string $newval  New value.
1088      */
1089     function set($key, $newval) {
1090         $cache = &$this->_wikidb->_cache;
1091         $pagename = &$this->_pagename;
1092
1093         assert($key && $key[0] != '%');
1094
1095         $data = $cache->get_pagedata($pagename);
1096
1097         if (!empty($newval)) {
1098             if (!empty($data[$key]) && $data[$key] == $newval)
1099                 return;         // values identical, skip update.
1100         }
1101         else {
1102             if (empty($data[$key]))
1103                 return;         // values identical, skip update.
1104         }
1105
1106         $cache->update_pagedata($pagename, array($key => $newval));
1107     }
1108
1109     /**
1110      * Increase page hit count.
1111      *
1112      * FIXME: IS this needed?  Probably not.
1113      *
1114      * This is a convenience function.
1115      * <pre> $page->increaseHitCount(); </pre>
1116      * is functionally identical to
1117      * <pre> $page->set('hits',$page->get('hits')+1); </pre>
1118      *
1119      * Note that this method may be implemented in more efficient ways
1120      * in certain backends.
1121      *
1122      * @access public
1123      */
1124     function increaseHitCount() {
1125         @$newhits = $this->get('hits') + 1;
1126         $this->set('hits', $newhits);
1127     }
1128
1129     /**
1130      * Return a string representation of the WikiDB_Page
1131      *
1132      * This is really only for debugging.
1133      *
1134      * @access public
1135      *
1136      * @return string Printable representation of the WikiDB_Page.
1137      */
1138     function asString () {
1139         ob_start();
1140         printf("[%s:%s\n", get_class($this), $this->getName());
1141         print_r($this->getMetaData());
1142         echo "]\n";
1143         $strval = ob_get_contents();
1144         ob_end_clean();
1145         return $strval;
1146     }
1147
1148
1149     /**
1150      * @access private
1151      * @param integer_or_object $version_or_pagerevision
1152      * Takes either the version number (and int) or a WikiDB_PageRevision
1153      * object.
1154      * @return integer The version number.
1155      */
1156     function _coerce_to_version($version_or_pagerevision) {
1157         if (method_exists($version_or_pagerevision, "getContent"))
1158             $version = $version_or_pagerevision->getVersion();
1159         else
1160             $version = (int) $version_or_pagerevision;
1161
1162         assert($version >= 0);
1163         return $version;
1164     }
1165
1166     function isUserPage ($include_empty = true) {
1167         if ($include_empty) {
1168             $current = $this->getCurrentRevision();
1169             if ($current->hasDefaultContents()) {
1170                 return false;
1171             }
1172         }
1173         return $this->get('pref') ? true : false;
1174     }
1175
1176     // May be empty. Either the stored owner (/Chown), or the first authorized author
1177     function getOwner() {
1178         if ($owner = $this->get('owner'))
1179             return ($owner == "The PhpWiki programming team") ? ADMIN_USER : $owner;
1180         // check all revisions forwards for the first author_id
1181         $backend = &$this->_wikidb->_backend;
1182         $pagename = &$this->_pagename;
1183         $latestversion = $backend->get_latest_version($pagename);
1184         for ($v=1; $v <= $latestversion; $v++) {
1185             $rev = $this->getRevision($v);
1186             if ($rev and $owner = $rev->get('author_id')) {
1187                 return ($owner == "The PhpWiki programming team") ? ADMIN_USER : $owner;
1188             }
1189         }
1190         return '';
1191     }
1192
1193     // The authenticated author of the first revision or empty if not authenticated then.
1194     function getCreator() {
1195         if ($current = $this->getRevision(1)) return $current->get('author_id');
1196         else return '';
1197     }
1198
1199 };
1200
1201 /**
1202  * This class represents a specific revision of a WikiDB_Page within
1203  * a WikiDB.
1204  *
1205  * A WikiDB_PageRevision has read-only semantics. You may only create
1206  * new revisions (and delete old ones) --- you cannot modify existing
1207  * revisions.
1208  */
1209 class WikiDB_PageRevision
1210 {
1211     var $_transformedContent = false; // set by WikiDB_Page::save()
1212
1213     function WikiDB_PageRevision(&$wikidb, $pagename, $version,
1214                                  $versiondata = false)
1215         {
1216             $this->_wikidb = &$wikidb;
1217             $this->_pagename = $pagename;
1218             $this->_version = $version;
1219             $this->_data = $versiondata ? $versiondata : array();
1220         }
1221
1222     /**
1223      * Get the WikiDB_Page which this revision belongs to.
1224      *
1225      * @access public
1226      *
1227      * @return WikiDB_Page The WikiDB_Page which this revision belongs to.
1228      */
1229     function getPage() {
1230         return new WikiDB_Page($this->_wikidb, $this->_pagename);
1231     }
1232
1233     /**
1234      * Get the version number of this revision.
1235      *
1236      * @access public
1237      *
1238      * @return integer The version number of this revision.
1239      */
1240     function getVersion() {
1241         return $this->_version;
1242     }
1243
1244     /**
1245      * Determine whether this revision has defaulted content.
1246      *
1247      * The default revision (version 0) of each page, as well as any
1248      * pages which are created with empty content have their content
1249      * defaulted to something like:
1250      * <pre>
1251      *   Describe [ThisPage] here.
1252      * </pre>
1253      *
1254      * @access public
1255      *
1256      * @return boolean Returns true if the page has default content.
1257      */
1258     function hasDefaultContents() {
1259         $data = &$this->_data;
1260         return empty($data['%content']);
1261     }
1262
1263     /**
1264      * Get the content as an array of lines.
1265      *
1266      * @access public
1267      *
1268      * @return array An array of lines.
1269      * The lines should contain no trailing white space.
1270      */
1271     function getContent() {
1272         return explode("\n", $this->getPackedContent());
1273     }
1274
1275         /**
1276      * Get the pagename of the revision.
1277      *
1278      * @access public
1279      *
1280      * @return string pagename.
1281      */
1282     function getPageName() {
1283         return $this->_pagename;
1284     }
1285
1286     /**
1287      * Determine whether revision is the latest.
1288      *
1289      * @access public
1290      *
1291      * @return boolean True iff the revision is the latest (most recent) one.
1292      */
1293     function isCurrent() {
1294         if (!isset($this->_iscurrent)) {
1295             $page = $this->getPage();
1296             $current = $page->getCurrentRevision();
1297             $this->_iscurrent = $this->getVersion() == $current->getVersion();
1298         }
1299         return $this->_iscurrent;
1300     }
1301
1302     /**
1303      * Get the transformed content of a page.
1304      *
1305      * @param string $pagetype  Override the page-type of the revision.
1306      *
1307      * @return object An XmlContent-like object containing the page transformed
1308      * contents.
1309      */
1310     function getTransformedContent($pagetype_override=false) {
1311         $backend = &$this->_wikidb->_backend;
1312
1313         if ($pagetype_override) {
1314             // Figure out the normal page-type for this page.
1315             $type = PageType::GetPageType($this->get('pagetype'));
1316             if ($type->getName() == $pagetype_override)
1317                 $pagetype_override = false; // Not really an override...
1318         }
1319
1320         if ($pagetype_override) {
1321             // Overriden page type, don't cache (or check cache).
1322             return new TransformedText($this->getPage(),
1323                                        $this->getPackedContent(),
1324                                        $this->getMetaData(),
1325                                        $pagetype_override);
1326         }
1327
1328         $possibly_cache_results = true;
1329
1330         if (defined('WIKIDB_NOCACHE_MARKUP') and WIKIDB_NOCACHE_MARKUP) {
1331             if (WIKIDB_NOCACHE_MARKUP == 'purge') {
1332                 // flush cache for this page.
1333                 $page = $this->getPage();
1334                 $page->set('_cached_html', false);
1335             }
1336             $possibly_cache_results = false;
1337         }
1338         elseif (!$this->_transformedContent) {
1339             //$backend->lock();
1340             if ($this->isCurrent()) {
1341                 $page = $this->getPage();
1342                 $this->_transformedContent = TransformedText::unpack($page->get('_cached_html'));
1343             }
1344             else {
1345                 $possibly_cache_results = false;
1346             }
1347             //$backend->unlock();
1348         }
1349
1350         if (!$this->_transformedContent) {
1351             $this->_transformedContent
1352                 = new TransformedText($this->getPage(),
1353                                       $this->getPackedContent(),
1354                                       $this->getMetaData());
1355
1356             if ($possibly_cache_results) {
1357                 // If we're still the current version, cache the transfomed page.
1358                 //$backend->lock();
1359                 if ($this->isCurrent()) {
1360                     $page->set('_cached_html', $this->_transformedContent->pack());
1361                 }
1362                 //$backend->unlock();
1363             }
1364         }
1365
1366         return $this->_transformedContent;
1367     }
1368
1369     /**
1370      * Get the content as a string.
1371      *
1372      * @access public
1373      *
1374      * @return string The page content.
1375      * Lines are separated by new-lines.
1376      */
1377     function getPackedContent() {
1378         $data = &$this->_data;
1379
1380
1381         if (empty($data['%content'])) {
1382             include_once('lib/InlineParser.php');
1383             // Replace empty content with default value.
1384             return sprintf(_("Describe %s here."),
1385                            "[" . WikiEscape($this->_pagename) . "]");
1386         }
1387
1388         // There is (non-default) content.
1389         assert($this->_version > 0);
1390
1391         if (!is_string($data['%content'])) {
1392             // Content was not provided to us at init time.
1393             // (This is allowed because for some backends, fetching
1394             // the content may be expensive, and often is not wanted
1395             // by the user.)
1396             //
1397             // In any case, now we need to get it.
1398             $data['%content'] = $this->_get_content();
1399             assert(is_string($data['%content']));
1400         }
1401
1402         return $data['%content'];
1403     }
1404
1405     function _get_content() {
1406         $cache = &$this->_wikidb->_cache;
1407         $pagename = $this->_pagename;
1408         $version = $this->_version;
1409
1410         assert($version > 0);
1411
1412         $newdata = $cache->get_versiondata($pagename, $version, true);
1413         if ($newdata) {
1414             assert(is_string($newdata['%content']));
1415             return $newdata['%content'];
1416         }
1417         else {
1418             // else revision has been deleted... What to do?
1419             return __sprintf("Oops! Revision %s of %s seems to have been deleted!",
1420                              $version, $pagename);
1421         }
1422     }
1423
1424     /**
1425      * Get meta-data for this revision.
1426      *
1427      *
1428      * @access public
1429      *
1430      * @param string $key Which meta-data to access.
1431      *
1432      * Some reserved revision meta-data keys are:
1433      * <dl>
1434      * <dt> 'mtime' <dd> Time this revision was created (seconds since midnight Jan 1, 1970.)
1435      *        The 'mtime' meta-value is normally set automatically by the database
1436      *        backend, but it may be specified explicitly when creating a new revision.
1437      * <dt> orig_mtime
1438      *  <dd> To ensure consistency of RecentChanges, the mtimes of the versions
1439      *       of a page must be monotonically increasing.  If an attempt is
1440      *       made to create a new revision with an mtime less than that of
1441      *       the preceeding revision, the new revisions timestamp is force
1442      *       to be equal to that of the preceeding revision.  In that case,
1443      *       the originally requested mtime is preserved in 'orig_mtime'.
1444      * <dt> '_supplanted' <dd> Time this revision ceased to be the most recent.
1445      *        This meta-value is <em>always</em> automatically maintained by the database
1446      *        backend.  (It is set from the 'mtime' meta-value of the superceding
1447      *        revision.)  '_supplanted' has a value of 'false' for the current revision.
1448      *
1449      * FIXME: this could be refactored:
1450      * <dt> author
1451      *  <dd> Author of the page (as he should be reported in, e.g. RecentChanges.)
1452      * <dt> author_id
1453      *  <dd> Authenticated author of a page.  This is used to identify
1454      *       the distinctness of authors when cleaning old revisions from
1455      *       the database.
1456      * <dt> 'is_minor_edit' <dd> Set if change was marked as a minor revision by the author.
1457      * <dt> 'summary' <dd> Short change summary entered by page author.
1458      * </dl>
1459      *
1460      * Meta-data keys must be valid C identifers (they have to start with a letter
1461      * or underscore, and can contain only alphanumerics and underscores.)
1462      *
1463      * @return string The requested value, or false if the requested value
1464      * is not defined.
1465      */
1466     function get($key) {
1467         if (!$key || $key[0] == '%')
1468             return false;
1469         $data = &$this->_data;
1470         return isset($data[$key]) ? $data[$key] : false;
1471     }
1472
1473     /**
1474      * Get all the revision page meta-data as a hash.
1475      *
1476      * @return hash The revision meta-data.
1477      */
1478     function getMetaData() {
1479         $meta = array();
1480         foreach ($this->_data as $key => $val) {
1481             if (!empty($val) && $key[0] != '%')
1482                 $meta[$key] = $val;
1483         }
1484         return $meta;
1485     }
1486
1487
1488     /**
1489      * Return a string representation of the revision.
1490      *
1491      * This is really only for debugging.
1492      *
1493      * @access public
1494      *
1495      * @return string Printable representation of the WikiDB_Page.
1496      */
1497     function asString () {
1498         ob_start();
1499         printf("[%s:%d\n", get_class($this), $this->get('version'));
1500         print_r($this->_data);
1501         echo $this->getPackedContent() . "\n]\n";
1502         $strval = ob_get_contents();
1503         ob_end_clean();
1504         return $strval;
1505     }
1506 };
1507
1508
1509 /**
1510  * Class representing a sequence of WikiDB_Pages.
1511  * TODO: Enhance to php5 iterators
1512  */
1513 class WikiDB_PageIterator
1514 {
1515     function WikiDB_PageIterator(&$wikidb, &$pages) {
1516         $this->_pages = $pages;
1517         $this->_wikidb = &$wikidb;
1518     }
1519
1520     function count () {
1521         return $this->_pages->count();
1522     }
1523
1524     /**
1525      * Get next WikiDB_Page in sequence.
1526      *
1527      * @access public
1528      *
1529      * @return WikiDB_Page The next WikiDB_Page in the sequence.
1530      */
1531     function next () {
1532         if ( ! ($next = $this->_pages->next()) )
1533             return false;
1534
1535         $pagename = &$next['pagename'];
1536         if (!$pagename) {
1537             trigger_error('empty pagename in WikiDB_PageIterator::next()', E_USER_WARNING);
1538             var_dump($next);
1539             return false;
1540         }
1541         if (isset($next['pagedata']))
1542             $this->_wikidb->_cache->cache_data($next);
1543
1544         return new WikiDB_Page($this->_wikidb, $pagename);
1545     }
1546
1547     /**
1548      * Release resources held by this iterator.
1549      *
1550      * The iterator may not be used after free() is called.
1551      *
1552      * There is no need to call free(), if next() has returned false.
1553      * (I.e. if you iterate through all the pages in the sequence,
1554      * you do not need to call free() --- you only need to call it
1555      * if you stop before the end of the iterator is reached.)
1556      *
1557      * @access public
1558      */
1559     function free() {
1560         $this->_pages->free();
1561     }
1562
1563     function asArray() {
1564         $result = array();
1565         while ($page = $this->next())
1566             $result[] = $page;
1567         $this->free();
1568         return $result;
1569     }
1570
1571     // Not yet used and problematic. Order should be set in the query, not afterwards.
1572     // See PageList::sortby
1573     function setSortby ($arg = false) {
1574         if (!$arg) {
1575             $arg = @$_GET['sortby'];
1576             if ($arg) {
1577                 $sortby = substr($arg,1);
1578                 $order  = substr($arg,0,1)=='+' ? 'ASC' : 'DESC';
1579             }
1580         }
1581         if (is_array($arg)) { // array('mtime' => 'desc')
1582             $sortby = $arg[0];
1583             $order = $arg[1];
1584         } else {
1585             $sortby = $arg;
1586             $order  = 'ASC';
1587         }
1588         // available column types to sort by:
1589         // todo: we must provide access methods for the generic dumb/iterator
1590         $this->_types = explode(',','pagename,mtime,hits,version,author,locked,minor,markup');
1591         if (in_array($sortby,$this->_types))
1592             $this->_options['sortby'] = $sortby;
1593         else
1594             trigger_error(sprintf("Argument %s '%s' ignored",'sortby',$sortby), E_USER_WARNING);
1595         if (in_array(strtoupper($order),'ASC','DESC'))
1596             $this->_options['order'] = strtoupper($order);
1597         else
1598             trigger_error(sprintf("Argument %s '%s' ignored",'order',$order), E_USER_WARNING);
1599     }
1600
1601 };
1602
1603 /**
1604  * A class which represents a sequence of WikiDB_PageRevisions.
1605  * TODO: Enhance to php5 iterators
1606  */
1607 class WikiDB_PageRevisionIterator
1608 {
1609     function WikiDB_PageRevisionIterator(&$wikidb, &$revisions) {
1610         $this->_revisions = $revisions;
1611         $this->_wikidb = &$wikidb;
1612     }
1613
1614     function count () {
1615         return $this->_revisions->count();
1616     }
1617
1618     /**
1619      * Get next WikiDB_PageRevision in sequence.
1620      *
1621      * @access public
1622      *
1623      * @return WikiDB_PageRevision
1624      * The next WikiDB_PageRevision in the sequence.
1625      */
1626     function next () {
1627         if ( ! ($next = $this->_revisions->next()) )
1628             return false;
1629
1630         $this->_wikidb->_cache->cache_data($next);
1631
1632         $pagename = $next['pagename'];
1633         $version = $next['version'];
1634         $versiondata = $next['versiondata'];
1635         if (DEBUG) {
1636             if (!(is_string($pagename) and $pagename != '')) {
1637                 trigger_error("empty pagename",E_USER_WARNING);
1638                 return false;
1639             }
1640         } else assert(is_string($pagename) and $pagename != '');
1641         if (DEBUG) {
1642             if (!is_array($versiondata)) {
1643                 trigger_error("empty versiondata",E_USER_WARNING);
1644                 return false;
1645             }
1646         } else assert(is_array($versiondata));
1647         if (DEBUG) {
1648             if (!($version > 0)) {
1649                 trigger_error("invalid version",E_USER_WARNING);
1650                 return false;
1651             }
1652         } else assert($version > 0);
1653
1654         return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1655                                        $versiondata);
1656     }
1657
1658     /**
1659      * Release resources held by this iterator.
1660      *
1661      * The iterator may not be used after free() is called.
1662      *
1663      * There is no need to call free(), if next() has returned false.
1664      * (I.e. if you iterate through all the revisions in the sequence,
1665      * you do not need to call free() --- you only need to call it
1666      * if you stop before the end of the iterator is reached.)
1667      *
1668      * @access public
1669      */
1670     function free() {
1671         $this->_revisions->free();
1672     }
1673
1674     function asArray() {
1675         $result = array();
1676         while ($rev = $this->next())
1677             $result[] = $rev;
1678         $this->free();
1679         return $result;
1680     }
1681 };
1682
1683
1684 /**
1685  * Data cache used by WikiDB.
1686  *
1687  * FIXME: Maybe rename this to caching_backend (or some such).
1688  *
1689  * @access private
1690  */
1691 class WikiDB_cache
1692 {
1693     // FIXME: beautify versiondata cache.  Cache only limited data?
1694
1695     function WikiDB_cache (&$backend) {
1696         $this->_backend = &$backend;
1697
1698         $this->_pagedata_cache = array();
1699         $this->_versiondata_cache = array();
1700         array_push ($this->_versiondata_cache, array());
1701         $this->_glv_cache = array();
1702     }
1703
1704     function close() {
1705         $this->_pagedata_cache = false;
1706         $this->_versiondata_cache = false;
1707         $this->_glv_cache = false;
1708     }
1709
1710     function get_pagedata($pagename) {
1711         assert(is_string($pagename) && $pagename != '');
1712         $cache = &$this->_pagedata_cache;
1713
1714         if (!isset($cache[$pagename]) || !is_array($cache[$pagename])) {
1715             $cache[$pagename] = $this->_backend->get_pagedata($pagename);
1716             if (empty($cache[$pagename]))
1717                 $cache[$pagename] = array();
1718         }
1719
1720         return $cache[$pagename];
1721     }
1722
1723     function update_pagedata($pagename, $newdata) {
1724         assert(is_string($pagename) && $pagename != '');
1725
1726         $this->_backend->update_pagedata($pagename, $newdata);
1727
1728         if (is_array($this->_pagedata_cache[$pagename])) {
1729             $cachedata = &$this->_pagedata_cache[$pagename];
1730             foreach($newdata as $key => $val)
1731                 $cachedata[$key] = $val;
1732         }
1733     }
1734
1735     function invalidate_cache($pagename) {
1736         unset ($this->_pagedata_cache[$pagename]);
1737         unset ($this->_versiondata_cache[$pagename]);
1738         unset ($this->_glv_cache[$pagename]);
1739     }
1740
1741     function delete_page($pagename) {
1742         $this->_backend->delete_page($pagename);
1743         unset ($this->_pagedata_cache[$pagename]);
1744         unset ($this->_glv_cache[$pagename]);
1745     }
1746
1747     // FIXME: ugly
1748     function cache_data($data) {
1749         if (isset($data['pagedata']))
1750             $this->_pagedata_cache[$data['pagename']] = $data['pagedata'];
1751     }
1752
1753     function get_versiondata($pagename, $version, $need_content = false) {
1754         //  FIXME: Seriously ugly hackage
1755         if (defined('USECACHE') and USECACHE) {   //temporary - for debugging
1756             assert(is_string($pagename) && $pagename != '');
1757             // there is a bug here somewhere which results in an assertion failure at line 105
1758             // of ArchiveCleaner.php  It goes away if we use the next line.
1759             $need_content = true;
1760             $nc = $need_content ? '1':'0';
1761             $cache = &$this->_versiondata_cache;
1762             if (!isset($cache[$pagename][$version][$nc])||
1763                 !(is_array ($cache[$pagename])) || !(is_array ($cache[$pagename][$version]))) {
1764                 $cache[$pagename][$version][$nc] =
1765                     $this->_backend->get_versiondata($pagename,$version, $need_content);
1766                 // If we have retrieved all data, we may as well set the cache for $need_content = false
1767                 if ($need_content){
1768                     $cache[$pagename][$version]['0'] = $cache[$pagename][$version]['1'];
1769                 }
1770             }
1771             $vdata = $cache[$pagename][$version][$nc];
1772         } else {
1773             $vdata = $this->_backend->get_versiondata($pagename, $version, $need_content);
1774         }
1775         // FIXME: ugly
1776         if ($vdata && !empty($vdata['%pagedata']))
1777             $this->_pagedata_cache[$pagename] = $vdata['%pagedata'];
1778         return $vdata;
1779     }
1780
1781     function set_versiondata($pagename, $version, $data) {
1782         $new = $this->_backend->set_versiondata($pagename, $version, $data);
1783         // Update the cache
1784         $this->_versiondata_cache[$pagename][$version]['1'] = $data;
1785         // FIXME: hack
1786         $this->_versiondata_cache[$pagename][$version]['0'] = $data;
1787         // Is this necessary?
1788         unset($this->_glv_cache[$pagename]);
1789     }
1790
1791     function update_versiondata($pagename, $version, $data) {
1792         $new = $this->_backend->update_versiondata($pagename, $version, $data);
1793         // Update the cache
1794         $this->_versiondata_cache[$pagename][$version]['1'] = $data;
1795         // FIXME: hack
1796         $this->_versiondata_cache[$pagename][$version]['0'] = $data;
1797         // Is this necessary?
1798         unset($this->_glv_cache[$pagename]);
1799     }
1800
1801     function delete_versiondata($pagename, $version) {
1802         $new = $this->_backend->delete_versiondata($pagename, $version);
1803         unset ($this->_versiondata_cache[$pagename][$version]['1']);
1804         unset ($this->_versiondata_cache[$pagename][$version]['0']);
1805         unset ($this->_glv_cache[$pagename]);
1806     }
1807
1808     function get_latest_version($pagename)  {
1809         if (defined('USECACHE')){
1810             assert (is_string($pagename) && $pagename != '');
1811             $cache = &$this->_glv_cache;
1812             if (!isset($cache[$pagename])) {
1813                 $cache[$pagename] = $this->_backend->get_latest_version($pagename);
1814                 if (empty($cache[$pagename]))
1815                     $cache[$pagename] = 0;
1816             }
1817             return $cache[$pagename];
1818         } else {
1819             return $this->_backend->get_latest_version($pagename);
1820         }
1821     }
1822
1823 };
1824
1825 // $Log: not supported by cvs2svn $
1826 // Revision 1.59  2004/05/27 17:49:05  rurban
1827 // renamed DB_Session to DbSession (in CVS also)
1828 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
1829 // remove leading slash in error message
1830 // added force_unlock parameter to File_Passwd (no return on stale locks)
1831 // fixed adodb session AffectedRows
1832 // added FileFinder helpers to unify local filenames and DATA_PATH names
1833 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
1834 //
1835 // Revision 1.58  2004/05/18 13:59:14  rurban
1836 // rename simpleQuery to genericQuery
1837 //
1838 // Revision 1.57  2004/05/16 22:07:35  rurban
1839 // check more config-default and predefined constants
1840 // various PagePerm fixes:
1841 //   fix default PagePerms, esp. edit and view for Bogo and Password users
1842 //   implemented Creator and Owner
1843 //   BOGOUSERS renamed to BOGOUSER
1844 // fixed syntax errors in signin.tmpl
1845 //
1846 // Revision 1.56  2004/05/15 22:54:49  rurban
1847 // fixed important WikiDB bug with DEBUG > 0: wrong assertion
1848 // improved SetAcl (works) and PagePerms, some WikiGroup helpers.
1849 //
1850 // Revision 1.55  2004/05/12 19:27:47  rurban
1851 // revert wrong inline optimization.
1852 //
1853 // Revision 1.54  2004/05/12 10:49:55  rurban
1854 // require_once fix for those libs which are loaded before FileFinder and
1855 //   its automatic include_path fix, and where require_once doesn't grok
1856 //   dirname(__FILE__) != './lib'
1857 // upgrade fix with PearDB
1858 // navbar.tmpl: remove spaces for IE &nbsp; button alignment
1859 //
1860 // Revision 1.53  2004/05/08 14:06:12  rurban
1861 // new support for inlined image attributes: [image.jpg size=50x30 align=right]
1862 // minor stability and portability fixes
1863 //
1864 // Revision 1.52  2004/05/06 19:26:16  rurban
1865 // improve stability, trying to find the InlineParser endless loop on sf.net
1866 //
1867 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
1868 //
1869 // Revision 1.51  2004/05/06 17:30:37  rurban
1870 // CategoryGroup: oops, dos2unix eol
1871 // improved phpwiki_version:
1872 //   pre -= .0001 (1.3.10pre: 1030.099)
1873 //   -p1 += .001 (1.3.9-p1: 1030.091)
1874 // improved InstallTable for mysql and generic SQL versions and all newer tables so far.
1875 // abstracted more ADODB/PearDB methods for action=upgrade stuff:
1876 //   backend->backendType(), backend->database(),
1877 //   backend->listOfFields(),
1878 //   backend->listOfTables(),
1879 //
1880 // Revision 1.50  2004/05/04 22:34:25  rurban
1881 // more pdf support
1882 //
1883 // Revision 1.49  2004/05/03 11:16:40  rurban
1884 // fixed sendPageChangeNotification
1885 // subject rewording
1886 //
1887 // Revision 1.48  2004/04/29 23:03:54  rurban
1888 // fixed sf.net bug #940996
1889 //
1890 // Revision 1.47  2004/04/29 19:39:44  rurban
1891 // special support for formatted plugins (one-liners)
1892 //   like <small><plugin BlaBla ></small>
1893 // iter->asArray() helper for PopularNearby
1894 // db_session for older php's (no &func() allowed)
1895 //
1896 // Revision 1.46  2004/04/26 20:44:34  rurban
1897 // locking table specific for better databases
1898 //
1899 // Revision 1.45  2004/04/20 00:06:03  rurban
1900 // themable paging support
1901 //
1902 // Revision 1.44  2004/04/19 18:27:45  rurban
1903 // Prevent from some PHP5 warnings (ref args, no :: object init)
1904 //   php5 runs now through, just one wrong XmlElement object init missing
1905 // Removed unneccesary UpgradeUser lines
1906 // Changed WikiLink to omit version if current (RecentChanges)
1907 //
1908 // Revision 1.43  2004/04/18 01:34:20  rurban
1909 // protect most_popular from sortby=mtime
1910 //
1911 // Revision 1.42  2004/04/18 01:11:51  rurban
1912 // more numeric pagename fixes.
1913 // fixed action=upload with merge conflict warnings.
1914 // charset changed from constant to global (dynamic utf-8 switching)
1915 //
1916
1917 // Local Variables:
1918 // mode: php
1919 // tab-width: 8
1920 // c-basic-offset: 4
1921 // c-hanging-comment-ender-p: nil
1922 // indent-tabs-mode: nil
1923 // End:
1924 ?>