lib/WikiDB.php

   1 <?php //-*-php-*-
   2 rcs_id('$Id: WikiDB.php,v 1.44 2004-04-19 18:27:45 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         $this->_cache = new WikiDB_cache($backend);
 113
 114         // If the database doesn't yet have a timestamp, initialize it now.
 115         if ($this->get('_timestamp') === false)
 116             $this->touch();
 117
 118         //FIXME: devel checking.
 119         //$this->_backend->check();
 120     }
 121
 122     /**
 123      * Get any user-level warnings about this WikiDB.
 124      *
 125      * Some back-ends, e.g. by default create there data files in the
 126      * global /tmp directory. We would like to warn the user when this
 127      * happens (since /tmp files tend to get wiped periodically.)
 128      * Warnings such as these may be communicated from specific
 129      * back-ends through this method.
 130      *
 131      * @access public
 132      *
 133      * @return string A warning message (or <tt>false</tt> if there is
 134      * none.)
 135      */
 136     function genericWarnings() {
 137         return false;
 138     }
 139
 140     /**
 141      * Close database connection.
 142      *
 143      * The database may no longer be used after it is closed.
 144      *
 145      * Closing a WikiDB invalidates all <tt>WikiDB_Page</tt>s,
 146      * <tt>WikiDB_PageRevision</tt>s and <tt>WikiDB_PageIterator</tt>s
 147      * which have been obtained from it.
 148      *
 149      * @access public
 150      */
 151     function close () {
 152         $this->_backend->close();
 153         $this->_cache->close();
 154     }
 155
 156     /**
 157      * Get a WikiDB_Page from a WikiDB.
 158      *
 159      * A {@link WikiDB} consists of the (infinite) set of all possible pages,
 160      * therefore this method never fails.
 161      *
 162      * @access public
 163      * @param string $pagename Which page to get.
 164      * @return WikiDB_Page The requested WikiDB_Page.
 165      */
 166     function getPage($pagename) {
 167         assert(is_string($pagename) and $pagename != '');
 168         return new WikiDB_Page($this, $pagename);
 169     }
 170
 171
 172     // Do we need this?
 173     //function nPages() {
 174     //}
 175
 176
 177     /**
 178      * Determine whether page exists (in non-default form).
 179      *
 180      * <pre>
 181      *   $is_page = $dbi->isWikiPage($pagename);
 182      * </pre>
 183      * is equivalent to
 184      * <pre>
 185      *   $page = $dbi->getPage($pagename);
 186      *   $current = $page->getCurrentRevision();
 187      *   $is_page = ! $current->hasDefaultContents();
 188      * </pre>
 189      * however isWikiPage may be implemented in a more efficient
 190      * manner in certain back-ends.
 191      *
 192      * @access public
 193      *
 194      * @param string $pagename string Which page to check.
 195      *
 196      * @return boolean True if the page actually exists with
 197      * non-default contents in the WikiDataBase.
 198      */
 199     function isWikiPage ($pagename) {
 200         $page = $this->getPage($pagename);
 201         $current = $page->getCurrentRevision();
 202         return ! $current->hasDefaultContents();
 203     }
 204
 205     /**
 206      * Delete page from the WikiDB.
 207      *
 208      * Deletes all revisions of the page from the WikiDB. Also resets
 209      * all page meta-data to the default values.
 210      *
 211      * @access public
 212      *
 213      * @param string $pagename Name of page to delete.
 214      */
 215     function deletePage($pagename) {
 216         $this->_cache->delete_page($pagename);
 217
 218         //How to create a RecentChanges entry with explaining summary?
 219         /*
 220         $page = $this->getPage($pagename);
 221         $current = $page->getCurrentRevision();
 222         $meta = $current->_data;
 223         $version = $current->getVersion();
 224         $meta['summary'] = sprintf(_("renamed from %s"),$from);
 225         $page->save($current->getPackedContent(), $version + 1, $meta);
 226         */
 227     }
 228
 229     /**
 230      * Retrieve all pages.
 231      *
 232      * Gets the set of all pages with non-default contents.
 233      *
 234      * FIXME: do we need this?  I think so.  The simple searches
 235      *        need this stuff.
 236      *
 237      * @access public
 238      *
 239      * @param boolean $include_defaulted Normally pages whose most
 240      * recent revision has empty content are considered to be
 241      * non-existant. Unless $include_defaulted is set to true, those
 242      * pages will not be returned.
 243      *
 244      * @return WikiDB_PageIterator A WikiDB_PageIterator which contains all pages
 245      *     in the WikiDB which have non-default contents.
 246      */
 247     function getAllPages($include_defaulted=false, $sortby=false, $limit=false) {
 248         $result = $this->_backend->get_all_pages($include_defaulted,$sortby,$limit);
 249         return new WikiDB_PageIterator($this, $result);
 250     }
 251
 252     /**
 253      * Title search.
 254      *
 255      * Search for pages containing (or not containing) certain words
 256      * in their names.
 257      *
 258      * Pages are returned in alphabetical order whenever it is
 259      * practical to do so.
 260      *
 261      * FIXME: should titleSearch and fullSearch be combined?  I think so.
 262      *
 263      * @access public
 264      * @param TextSearchQuery $search A TextSearchQuery object
 265      * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
 266      * @see TextSearchQuery
 267      */
 268     function titleSearch($search) {
 269         $result = $this->_backend->text_search($search);
 270         return new WikiDB_PageIterator($this, $result);
 271     }
 272
 273     /**
 274      * Full text search.
 275      *
 276      * Search for pages containing (or not containing) certain words
 277      * in their entire text (this includes the page content and the
 278      * page name).
 279      *
 280      * Pages are returned in alphabetical order whenever it is
 281      * practical to do so.
 282      *
 283      * @access public
 284      *
 285      * @param TextSearchQuery $search A TextSearchQuery object.
 286      * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
 287      * @see TextSearchQuery
 288      */
 289     function fullSearch($search) {
 290         $result = $this->_backend->text_search($search, 'full_text');
 291         return new WikiDB_PageIterator($this, $result);
 292     }
 293
 294     /**
 295      * Find the pages with the greatest hit counts.
 296      *
 297      * Pages are returned in reverse order by hit count.
 298      *
 299      * @access public
 300      *
 301      * @param integer $limit The maximum number of pages to return.
 302      * Set $limit to zero to return all pages.  If $limit < 0, pages will
 303      * be sorted in decreasing order of popularity.
 304      *
 305      * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching
 306      * pages.
 307      */
 308     function mostPopular($limit = 20, $sortby = '') {
 309         // we don't support sortby=mtime here
 310         if (strstr($sortby,'mtime'))
 311             $sortby = '';
 312         $result = $this->_backend->most_popular($limit, $sortby);
 313         return new WikiDB_PageIterator($this, $result);
 314     }
 315
 316     /**
 317      * Find recent page revisions.
 318      *
 319      * Revisions are returned in reverse order by creation time.
 320      *
 321      * @access public
 322      *
 323      * @param hash $params This hash is used to specify various optional
 324      *   parameters:
 325      * <dl>
 326      * <dt> limit
 327      *    <dd> (integer) At most this many revisions will be returned.
 328      * <dt> since
 329      *    <dd> (integer) Only revisions since this time (unix-timestamp) will be returned.
 330      * <dt> include_minor_revisions
 331      *    <dd> (boolean) Also include minor revisions.  (Default is not to.)
 332      * <dt> exclude_major_revisions
 333      *    <dd> (boolean) Don't include non-minor revisions.
 334      *         (Exclude_major_revisions implies include_minor_revisions.)
 335      * <dt> include_all_revisions
 336      *    <dd> (boolean) Return all matching revisions for each page.
 337      *         Normally only the most recent matching revision is returned
 338      *         for each page.
 339      * </dl>
 340      *
 341      * @return WikiDB_PageRevisionIterator A WikiDB_PageRevisionIterator containing the
 342      * matching revisions.
 343      */
 344     function mostRecent($params = false) {
 345         $result = $this->_backend->most_recent($params);
 346         return new WikiDB_PageRevisionIterator($this, $result);
 347     }
 348
 349    /**
 350      * Blog search. (experimental)
 351      *
 352      * Search for blog entries related to a certain page.
 353      *
 354      * FIXME: with pagetype support and perhaps a RegexpSearchQuery
 355      * we can make sure we are returning *ONLY* blog pages to the
 356      * main routine.  Currently, we just use titleSearch which requires
 357      * some further checking in lib/plugin/WikiBlog.php (BAD).
 358      *
 359      * @access public
 360      *
 361      * @param string $order  'normal' (chronological) or 'reverse'
 362      * @param string $page   Find blog entries related to this page.
 363      * @return WikiDB_PageIterator A WikiDB_PageIterator containing the relevant pages.
 364      */
 365     // Deleting until such time as this is properly implemented...
 366     // (As long as it's just a title search, just use titleSearch.)
 367     //function blogSearch($page, $order) {
 368     //  //FIXME: implement ordering
 369     //
 370     //  require_once('lib/TextSearchQuery.php');
 371     //  $query = new TextSearchQuery ($page . SUBPAGE_SEPARATOR);
 372     //
 373     //  return $this->titleSearch($query);
 374     //}
 375
 376     /**
 377      * Call the appropriate backend method.
 378      *
 379      * @access public
 380      * @param string $from Page to rename
 381      * @param string $to   New name
 382      * @param boolean $updateWikiLinks If the text in all pages should be replaced.
 383      * @return boolean     true or false
 384      */
 385     function renamePage($from, $to, $updateWikiLinks = false) {
 386         assert(is_string($from) && $from != '');
 387         assert(is_string($to) && $to != '');
 388         $result = false;
 389         if (method_exists($this->_backend,'rename_page')) {
 390             $oldpage = $this->getPage($from);
 391             $newpage = $this->getPage($to);
 392             if ($oldpage->exists() and ! $newpage->exists()) {
 393                 if ($result = $this->_backend->rename_page($from, $to)) {
 394                     //update all WikiLinks in existing pages
 395                     if ($updateWikiLinks) {
 396                         //trigger_error(_("WikiDB::renamePage(..,..,updateWikiLinks) not yet implemented"),E_USER_WARNING);
 397                         require_once('lib/plugin/WikiAdminSearchReplace.php');
 398                         $links = $oldpage->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
 508
 509 /**
 510  * An abstract base class which representing a wiki-page within a
 511  * WikiDB.
 512  *
 513  * A WikiDB_Page contains a number (at least one) of
 514  * WikiDB_PageRevisions.
 515  */
 516 class WikiDB_Page
 517 {
 518     function WikiDB_Page(&$wikidb, $pagename) {
 519         $this->_wikidb = &$wikidb;
 520         $this->_pagename = $pagename;
 521         assert(is_string($pagename) and $pagename != '');
 522     }
 523
 524     /**
 525      * Get the name of the wiki page.
 526      *
 527      * @access public
 528      *
 529      * @return string The page name.
 530      */
 531     function getName() {
 532         return $this->_pagename;
 533     }
 534
 535     function exists() {
 536         $current = $this->getCurrentRevision();
 537         return ! $current->hasDefaultContents();
 538     }
 539
 540     /**
 541      * Delete an old revision of a WikiDB_Page.
 542      *
 543      * Deletes the specified revision of the page.
 544      * It is a fatal error to attempt to delete the current revision.
 545      *
 546      * @access public
 547      *
 548      * @param integer $version Which revision to delete.  (You can also
 549      *  use a WikiDB_PageRevision object here.)
 550      */
 551     function deleteRevision($version) {
 552         $backend = &$this->_wikidb->_backend;
 553         $cache = &$this->_wikidb->_cache;
 554         $pagename = &$this->_pagename;
 555
 556         $version = $this->_coerce_to_version($version);
 557         if ($version == 0)
 558             return;
 559
 560         $backend->lock();
 561         $latestversion = $cache->get_latest_version($pagename);
 562         if ($latestversion && $version == $latestversion) {
 563             $backend->unlock();
 564             trigger_error(sprintf("Attempt to delete most recent revision of '%s'",
 565                                   $pagename), E_USER_ERROR);
 566             return;
 567         }
 568
 569         $cache->delete_versiondata($pagename, $version);
 570
 571         $backend->unlock();
 572     }
 573
 574     /*
 575      * Delete a revision, or possibly merge it with a previous
 576      * revision.
 577      *
 578      * The idea is this:
 579      * Suppose an author make a (major) edit to a page.  Shortly
 580      * after that the same author makes a minor edit (e.g. to fix
 581      * spelling mistakes he just made.)
 582      *
 583      * Now some time later, where cleaning out old saved revisions,
 584      * and would like to delete his minor revision (since there's
 585      * really no point in keeping minor revisions around for a long
 586      * time.)
 587      *
 588      * Note that the text after the minor revision probably represents
 589      * what the author intended to write better than the text after
 590      * the preceding major edit.
 591      *
 592      * So what we really want to do is merge the minor edit with the
 593      * preceding edit.
 594      *
 595      * We will only do this when:
 596      * <ul>
 597      * <li>The revision being deleted is a minor one, and
 598      * <li>It has the same author as the immediately preceding revision.
 599      * </ul>
 600      */
 601     function mergeRevision($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();
 611         $latestversion = $backend->get_latest_version($pagename);
 612         if ($latestversion && $version == $latestversion) {
 613             $backend->unlock();
 614             trigger_error(sprintf("Attempt to merge most recent revision of '%s'",
 615                                   $pagename), E_USER_ERROR);
 616             return;
 617         }
 618
 619         $versiondata = $cache->get_versiondata($pagename, $version, true);
 620         if (!$versiondata) {
 621             // Not there? ... we're done!
 622             $backend->unlock();
 623             return;
 624         }
 625
 626         if ($versiondata['is_minor_edit']) {
 627             $previous = $backend->get_previous_version($pagename, $version);
 628             if ($previous) {
 629                 $prevdata = $cache->get_versiondata($pagename, $previous);
 630                 if ($prevdata['author_id'] == $versiondata['author_id']) {
 631                     // This is a minor revision, previous version is
 632                     // by the same author. We will merge the
 633                     // revisions.
 634                     $cache->update_versiondata($pagename, $previous,
 635                                                array('%content' => $versiondata['%content'],
 636                                                      '_supplanted' => $versiondata['_supplanted']));
 637                 }
 638             }
 639         }
 640
 641         $cache->delete_versiondata($pagename, $version);
 642         $backend->unlock();
 643     }
 644
 645
 646     /**
 647      * Create a new revision of a {@link WikiDB_Page}.
 648      *
 649      * @access public
 650      *
 651      * @param int $version Version number for new revision.
 652      * To ensure proper serialization of edits, $version must be
 653      * exactly one higher than the current latest version.
 654      * (You can defeat this check by setting $version to
 655      * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
 656      *
 657      * @param string $content Contents of new revision.
 658      *
 659      * @param hash $metadata Metadata for new revision.
 660      * All values in the hash should be scalars (strings or integers).
 661      *
 662      * @param array $links List of pagenames which this page links to.
 663      *
 664      * @return WikiDB_PageRevision  Returns the new WikiDB_PageRevision object. If
 665      * $version was incorrect, returns false
 666      */
 667     function createRevision($version, &$content, $metadata, $links) {
 668         $backend = &$this->_wikidb->_backend;
 669         $cache = &$this->_wikidb->_cache;
 670         $pagename = &$this->_pagename;
 671
 672         $backend->lock();
 673
 674         $latestversion = $backend->get_latest_version($pagename);
 675         $newversion = $latestversion + 1;
 676         assert($newversion >= 1);
 677
 678         if ($version != WIKIDB_FORCE_CREATE && $version != $newversion) {
 679             $backend->unlock();
 680             return false;
 681         }
 682
 683         $data = $metadata;
 684
 685         foreach ($data as $key => $val) {
 686             if (empty($val) || $key[0] == '_' || $key[0] == '%')
 687                 unset($data[$key]);
 688         }
 689
 690         assert(!empty($data['author']));
 691         if (empty($data['author_id']))
 692             @$data['author_id'] = $data['author'];
 693
 694         if (empty($data['mtime']))
 695             $data['mtime'] = time();
 696
 697         if ($latestversion) {
 698             // Ensure mtimes are monotonic.
 699             $pdata = $cache->get_versiondata($pagename, $latestversion);
 700             if ($data['mtime'] < $pdata['mtime']) {
 701                 trigger_error(sprintf(_("%s: Date of new revision is %s"),
 702                                       $pagename,"'non-monotonic'"),
 703                               E_USER_NOTICE);
 704                 $data['orig_mtime'] = $data['mtime'];
 705                 $data['mtime'] = $pdata['mtime'];
 706             }
 707
 708             // FIXME: use (possibly user specified) 'mtime' time or
 709             // time()?
 710             $cache->update_versiondata($pagename, $latestversion,
 711                                        array('_supplanted' => $data['mtime']));
 712         }
 713
 714         $data['%content'] = &$content;
 715
 716         $cache->set_versiondata($pagename, $newversion, $data);
 717
 718         //$cache->update_pagedata($pagename, array(':latestversion' => $newversion,
 719         //':deleted' => empty($content)));
 720
 721         $backend->set_links($pagename, $links);
 722
 723         $backend->unlock();
 724
 725         return new WikiDB_PageRevision($this->_wikidb, $pagename, $newversion,
 726                                        $data);
 727     }
 728
 729     /** A higher-level interface to createRevision.
 730      *
 731      * This takes care of computing the links, and storing
 732      * a cached version of the transformed wiki-text.
 733      *
 734      * @param string $wikitext  The page content.
 735      *
 736      * @param int $version Version number for new revision.
 737      * To ensure proper serialization of edits, $version must be
 738      * exactly one higher than the current latest version.
 739      * (You can defeat this check by setting $version to
 740      * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
 741      *
 742      * @param hash $meta  Meta-data for new revision.
 743      */
 744     function save($wikitext, $version, $meta) {
 745         $formatted = new TransformedText($this, $wikitext, $meta);
 746         $type = $formatted->getType();
 747         $meta['pagetype'] = $type->getName();
 748         $links = $formatted->getWikiPageLinks();
 749
 750         $backend = &$this->_wikidb->_backend;
 751         $backend->lock();
 752         $newrevision = $this->createRevision($version, $wikitext, $meta, $links);
 753         if ($newrevision)
 754             if (!defined('WIKIDB_NOCACHE_MARKUP') or !WIKIDB_NOCACHE_MARKUP)
 755                 $this->set('_cached_html', $formatted->pack());
 756         $backend->unlock();
 757
 758         // FIXME: probably should have some global state information
 759         // in the backend to control when to optimize.
 760         //
 761         // We're doing this here rather than in createRevision because
 762         // postgres can't optimize while locked.
 763         if (time() % 50 == 0) {
 764             if ($backend->optimize())
 765                 trigger_error(sprintf(_("Optimizing %s"),'backend'), E_USER_NOTICE);
 766         }
 767
 768         /* Generate notification emails? */
 769         if (isa($newrevision, 'wikidb_pagerevision')) {
 770             // Save didn't fail because of concurrent updates.
 771             $notify = $this->_wikidb->get('notify');
 772             if (!empty($notify) and is_array($notify)) {
 773                 list($emails,$userids) = $this->getPageChangeEmails($notify);
 774                 if (!empty($emails))
 775                     $this->sendPageChangeNotification($emails,$userids);
 776             }
 777         }
 778
 779         $newrevision->_transformedContent = $formatted;
 780         return $newrevision;
 781     }
 782
 783     function getPageChangeEmails($notify) {
 784         $emails = array(); $userids = array();
 785         foreach ($notify as $page => $users) {
 786             if (glob_match($page,$this->_pagename)) {
 787                 foreach ($users as $userid => $user) {
 788                     if (!empty($user['verified']) and !empty($user['email'])) {
 789                         $emails[]  = $user['email'];
 790                         $userids[] = $userid;
 791                     } elseif (!empty($user['email'])) {
 792                         global $request;
 793                         // do a dynamic emailVerified check update
 794                         $u = $request->getUser();
 795                         if ($u->UserName() == $userid) {
 796                             if ($request->_prefs->get('emailVerified')) {
 797                                 $emails[] = $user['email'];
 798                                 $userids[] = $userid;
 799                                 $notify[$page][$userid]['verified'] = 1;
 800                                 $request->_dbi->set('notify',$notify);
 801                             }
 802                         } else {
 803                             $u = WikiUser($userid);
 804                             if ($u->_prefs->get('emailVerified')) {
 805                                 $emails[] = $user['email'];
 806                                 $userids[] = $userid;
 807                                 $notify[$page][$userid]['verified'] = 1;
 808                                 $request->_dbi->set('notify',$notify);
 809                             }
 810                         }
 811                         // ignore verification
 812                         /*
 813                         if (DEBUG) {
 814                             if (!in_array($user['email'],$emails))
 815                                 $emails[] = $user['email'];
 816                         }
 817                         */
 818                     }
 819                 }
 820             }
 821         }
 822         $emails = array_unique($emails);
 823         $userids = array_unique($userids);
 824         return array($emails,$userids);
 825     }
 826
 827     function sendPageChangeNotification($emails, $userids) {
 828         $subject = sprintf(_("PageChange Notification %s"),$this->_pagename);
 829         $previous = $backend->get_previous_version($this->_pagename, $version);
 830         if ($previous) {
 831             $difflink = WikiUrl($this->_pagename,array('action'=>'diff'),true);
 832             $cache = &$this->_wikidb->_cache;
 833             $this_content = explode("\n", $wikitext);
 834             $prevdata = $cache->get_versiondata($this->_pagename, $previous, true);
 835             if (empty($prevdata['%content']))
 836                 $prevdata = $backend->get_versiondata($this->_pagename, $previous, true);
 837             $other_content = explode("\n", $prevdata['%content']);
 838
 839             include_once("lib/diff.php");
 840             $diff2 = new Diff($other_content, $this_content);
 841             $context_lines = max(4, count($other_content) + 1,
 842                                  count($this_content) + 1);
 843             $fmt = new UnifiedDiffFormatter($context_lines);
 844             $content  = $this->_pagename . " " . $previous . " " . Iso8601DateTime($prevdata['mtime']) . "\n";
 845             $content .= $this->_pagename . " " . $version . " " .  Iso8601DateTime($meta['mtime']) . "\n";
 846             $content .= $fmt->format($diff2);
 847
 848         } else {
 849             $difflink = WikiUrl($this->_pagename,array(),true);
 850             if (!isset($meta['mtime'])) $meta['mtime'] = time();
 851             $content = $this->_pagename . " " . $version . " " .  Iso8601DateTime($meta['mtime']) . "\n";
 852             $content .= _("New Page");
 853         }
 854         $editedby = sprintf(_("Edited by: %s"), $meta['author']);
 855         $emails = join(',',$emails);
 856         if (mail($emails,"[".WIKI_NAME."] ".$subject,
 857                  $subject."\n".
 858                  $editedby."\n".
 859                  $difflink."\n\n".
 860                  $content))
 861             trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
 862                                   $this->_pagename, join(',',$userids)), E_USER_NOTICE);
 863         else
 864             trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
 865                                   $this->_pagename, join(',',$userids)), E_USER_WARNING);
 866     }
 867
 868     /**
 869      * Get the most recent revision of a page.
 870      *
 871      * @access public
 872      *
 873      * @return WikiDB_PageRevision The current WikiDB_PageRevision object.
 874      */
 875     function getCurrentRevision() {
 876         $backend = &$this->_wikidb->_backend;
 877         $cache = &$this->_wikidb->_cache;
 878         $pagename = &$this->_pagename;
 879
 880         // Prevent deadlock in case of memory exhausted errors
 881         // Pure selection doesn't really need locking here.
 882         //   sf.net bug#927395
 883         // I know it would be better, but with lots of pages this deadlock is more
 884         // severe than occasionally get not the latest revision.
 885         //$backend->lock();
 886         $version = $cache->get_latest_version($pagename);
 887         $revision = $this->getRevision($version);
 888         //$backend->unlock();
 889         assert($revision);
 890         return $revision;
 891     }
 892
 893     /**
 894      * Get a specific revision of a WikiDB_Page.
 895      *
 896      * @access public
 897      *
 898      * @param integer $version  Which revision to get.
 899      *
 900      * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or
 901      * false if the requested revision does not exist in the {@link WikiDB}.
 902      * Note that version zero of any page always exists.
 903      */
 904     function getRevision($version) {
 905         $cache = &$this->_wikidb->_cache;
 906         $pagename = &$this->_pagename;
 907
 908         if ($version == 0)
 909             return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
 910
 911         assert($version > 0);
 912         $vdata = $cache->get_versiondata($pagename, $version);
 913         if (!$vdata)
 914             return false;
 915         return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
 916                                        $vdata);
 917     }
 918
 919     /**
 920      * Get previous page revision.
 921      *
 922      * This method find the most recent revision before a specified
 923      * version.
 924      *
 925      * @access public
 926      *
 927      * @param integer $version  Find most recent revision before this version.
 928      *  You can also use a WikiDB_PageRevision object to specify the $version.
 929      *
 930      * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or false if the
 931      * requested revision does not exist in the {@link WikiDB}.  Note that
 932      * unless $version is greater than zero, a revision (perhaps version zero,
 933      * the default revision) will always be found.
 934      */
 935     function getRevisionBefore($version) {
 936         $backend = &$this->_wikidb->_backend;
 937         $pagename = &$this->_pagename;
 938
 939         $version = $this->_coerce_to_version($version);
 940
 941         if ($version == 0)
 942             return false;
 943         //$backend->lock();
 944         $previous = $backend->get_previous_version($pagename, $version);
 945         $revision = $this->getRevision($previous);
 946         //$backend->unlock();
 947         assert($revision);
 948         return $revision;
 949     }
 950
 951     /**
 952      * Get all revisions of the WikiDB_Page.
 953      *
 954      * This does not include the version zero (default) revision in the
 955      * returned revision set.
 956      *
 957      * @return WikiDB_PageRevisionIterator A
 958      * WikiDB_PageRevisionIterator containing all revisions of this
 959      * WikiDB_Page in reverse order by version number.
 960      */
 961     function getAllRevisions() {
 962         $backend = &$this->_wikidb->_backend;
 963         $revs = $backend->get_all_revisions($this->_pagename);
 964         return new WikiDB_PageRevisionIterator($this->_wikidb, $revs);
 965     }
 966
 967     /**
 968      * Find pages which link to or are linked from a page.
 969      *
 970      * @access public
 971      *
 972      * @param boolean $reversed Which links to find: true for backlinks (default).
 973      *
 974      * @return WikiDB_PageIterator A WikiDB_PageIterator containing
 975      * all matching pages.
 976      */
 977     function getLinks($reversed = true) {
 978         $backend = &$this->_wikidb->_backend;
 979         $result =  $backend->get_links($this->_pagename, $reversed);
 980         return new WikiDB_PageIterator($this->_wikidb, $result);
 981     }
 982
 983     /**
 984      * Access WikiDB_Page meta-data.
 985      *
 986      * @access public
 987      *
 988      * @param string $key Which meta data to get.
 989      * Some reserved meta-data keys are:
 990      * <dl>
 991      * <dt>'locked'<dd> Is page locked?
 992      * <dt>'hits'  <dd> Page hit counter.
 993      * <dt>'pref'  <dd> Users preferences, stored in homepages.
 994      * <dt>'owner' <dd> Default: first author_id. We might add a group with a dot here:
 995      *                  E.g. "owner.users"
 996      * <dt>'perm'  <dd> Permission flag to authorize read/write/execution of
 997      *                  page-headers and content.
 998      * <dt>'score' <dd> Page score (not yet implement, do we need?)
 999      * </dl>
1000      *
1001      * @return scalar The requested value, or false if the requested data
1002      * is not set.
1003      */
1004     function get($key) {
1005         $cache = &$this->_wikidb->_cache;
1006         if (!$key || $key[0] == '%')
1007             return false;
1008         $data = $cache->get_pagedata($this->_pagename);
1009         return isset($data[$key]) ? $data[$key] : false;
1010     }
1011
1012     /**
1013      * Get all the page meta-data as a hash.
1014      *
1015      * @return hash The page meta-data.
1016      */
1017     function getMetaData() {
1018         $cache = &$this->_wikidb->_cache;
1019         $data = $cache->get_pagedata($this->_pagename);
1020         $meta = array();
1021         foreach ($data as $key => $val) {
1022             if (/*!empty($val) &&*/ $key[0] != '%')
1023                 $meta[$key] = $val;
1024         }
1025         return $meta;
1026     }
1027
1028     /**
1029      * Set page meta-data.
1030      *
1031      * @see get
1032      * @access public
1033      *
1034      * @param string $key  Meta-data key to set.
1035      * @param string $newval  New value.
1036      */
1037     function set($key, $newval) {
1038         $cache = &$this->_wikidb->_cache;
1039         $pagename = &$this->_pagename;
1040
1041         assert($key && $key[0] != '%');
1042
1043         $data = $cache->get_pagedata($pagename);
1044
1045         if (!empty($newval)) {
1046             if (!empty($data[$key]) && $data[$key] == $newval)
1047                 return;         // values identical, skip update.
1048         }
1049         else {
1050             if (empty($data[$key]))
1051                 return;         // values identical, skip update.
1052         }
1053
1054         $cache->update_pagedata($pagename, array($key => $newval));
1055     }
1056
1057     /**
1058      * Increase page hit count.
1059      *
1060      * FIXME: IS this needed?  Probably not.
1061      *
1062      * This is a convenience function.
1063      * <pre> $page->increaseHitCount(); </pre>
1064      * is functionally identical to
1065      * <pre> $page->set('hits',$page->get('hits')+1); </pre>
1066      *
1067      * Note that this method may be implemented in more efficient ways
1068      * in certain backends.
1069      *
1070      * @access public
1071      */
1072     function increaseHitCount() {
1073         @$newhits = $this->get('hits') + 1;
1074         $this->set('hits', $newhits);
1075     }
1076
1077     /**
1078      * Return a string representation of the WikiDB_Page
1079      *
1080      * This is really only for debugging.
1081      *
1082      * @access public
1083      *
1084      * @return string Printable representation of the WikiDB_Page.
1085      */
1086     function asString () {
1087         ob_start();
1088         printf("[%s:%s\n", get_class($this), $this->getName());
1089         print_r($this->getMetaData());
1090         echo "]\n";
1091         $strval = ob_get_contents();
1092         ob_end_clean();
1093         return $strval;
1094     }
1095
1096
1097     /**
1098      * @access private
1099      * @param integer_or_object $version_or_pagerevision
1100      * Takes either the version number (and int) or a WikiDB_PageRevision
1101      * object.
1102      * @return integer The version number.
1103      */
1104     function _coerce_to_version($version_or_pagerevision) {
1105         if (method_exists($version_or_pagerevision, "getContent"))
1106             $version = $version_or_pagerevision->getVersion();
1107         else
1108             $version = (int) $version_or_pagerevision;
1109
1110         assert($version >= 0);
1111         return $version;
1112     }
1113
1114     function isUserPage ($include_empty = true) {
1115         if ($include_empty) {
1116             $current = $this->getCurrentRevision();
1117             if ($current->hasDefaultContents()) {
1118                 return false;
1119             }
1120         }
1121         return $this->get('pref') ? true : false;
1122     }
1123
1124 };
1125
1126 /**
1127  * This class represents a specific revision of a WikiDB_Page within
1128  * a WikiDB.
1129  *
1130  * A WikiDB_PageRevision has read-only semantics. You may only create
1131  * new revisions (and delete old ones) --- you cannot modify existing
1132  * revisions.
1133  */
1134 class WikiDB_PageRevision
1135 {
1136     var $_transformedContent = false; // set by WikiDB_Page::save()
1137
1138     function WikiDB_PageRevision(&$wikidb, $pagename, $version,
1139                                  $versiondata = false)
1140         {
1141             $this->_wikidb = &$wikidb;
1142             $this->_pagename = $pagename;
1143             $this->_version = $version;
1144             $this->_data = $versiondata ? $versiondata : array();
1145         }
1146
1147     /**
1148      * Get the WikiDB_Page which this revision belongs to.
1149      *
1150      * @access public
1151      *
1152      * @return WikiDB_Page The WikiDB_Page which this revision belongs to.
1153      */
1154     function getPage() {
1155         return new WikiDB_Page($this->_wikidb, $this->_pagename);
1156     }
1157
1158     /**
1159      * Get the version number of this revision.
1160      *
1161      * @access public
1162      *
1163      * @return integer The version number of this revision.
1164      */
1165     function getVersion() {
1166         return $this->_version;
1167     }
1168
1169     /**
1170      * Determine whether this revision has defaulted content.
1171      *
1172      * The default revision (version 0) of each page, as well as any
1173      * pages which are created with empty content have their content
1174      * defaulted to something like:
1175      * <pre>
1176      *   Describe [ThisPage] here.
1177      * </pre>
1178      *
1179      * @access public
1180      *
1181      * @return boolean Returns true if the page has default content.
1182      */
1183     function hasDefaultContents() {
1184         $data = &$this->_data;
1185         return empty($data['%content']);
1186     }
1187
1188     /**
1189      * Get the content as an array of lines.
1190      *
1191      * @access public
1192      *
1193      * @return array An array of lines.
1194      * The lines should contain no trailing white space.
1195      */
1196     function getContent() {
1197         return explode("\n", $this->getPackedContent());
1198     }
1199
1200         /**
1201      * Get the pagename of the revision.
1202      *
1203      * @access public
1204      *
1205      * @return string pagename.
1206      */
1207     function getPageName() {
1208         return $this->_pagename;
1209     }
1210
1211     /**
1212      * Determine whether revision is the latest.
1213      *
1214      * @access public
1215      *
1216      * @return boolean True iff the revision is the latest (most recent) one.
1217      */
1218     function isCurrent() {
1219         if (!isset($this->_iscurrent)) {
1220             $page = $this->getPage();
1221             $current = $page->getCurrentRevision();
1222             $this->_iscurrent = $this->getVersion() == $current->getVersion();
1223         }
1224         return $this->_iscurrent;
1225     }
1226
1227     /**
1228      * Get the transformed content of a page.
1229      *
1230      * @param string $pagetype  Override the page-type of the revision.
1231      *
1232      * @return object An XmlContent-like object containing the page transformed
1233      * contents.
1234      */
1235     function getTransformedContent($pagetype_override=false) {
1236         $backend = &$this->_wikidb->_backend;
1237
1238         if ($pagetype_override) {
1239             // Figure out the normal page-type for this page.
1240             $type = PageType::GetPageType($this->get('pagetype'));
1241             if ($type->getName() == $pagetype_override)
1242                 $pagetype_override = false; // Not really an override...
1243         }
1244
1245         if ($pagetype_override) {
1246             // Overriden page type, don't cache (or check cache).
1247             return new TransformedText($this->getPage(),
1248                                        $this->getPackedContent(),
1249                                        $this->getMetaData(),
1250                                        $pagetype_override);
1251         }
1252
1253         $possibly_cache_results = true;
1254
1255         if (defined('WIKIDB_NOCACHE_MARKUP') and WIKIDB_NOCACHE_MARKUP) {
1256             if (WIKIDB_NOCACHE_MARKUP == 'purge') {
1257                 // flush cache for this page.
1258                 $page = $this->getPage();
1259                 $page->set('_cached_html', false);
1260             }
1261             $possibly_cache_results = false;
1262         }
1263         elseif (!$this->_transformedContent) {
1264             //$backend->lock();
1265             if ($this->isCurrent()) {
1266                 $page = $this->getPage();
1267                 $this->_transformedContent = TransformedText::unpack($page->get('_cached_html'));
1268             }
1269             else {
1270                 $possibly_cache_results = false;
1271             }
1272             //$backend->unlock();
1273         }
1274
1275         if (!$this->_transformedContent) {
1276             $this->_transformedContent
1277                 = new TransformedText($this->getPage(),
1278                                       $this->getPackedContent(),
1279                                       $this->getMetaData());
1280
1281             if ($possibly_cache_results) {
1282                 // If we're still the current version, cache the transfomed page.
1283                 //$backend->lock();
1284                 if ($this->isCurrent()) {
1285                     $page->set('_cached_html', $this->_transformedContent->pack());
1286                 }
1287                 //$backend->unlock();
1288             }
1289         }
1290
1291         return $this->_transformedContent;
1292     }
1293
1294     /**
1295      * Get the content as a string.
1296      *
1297      * @access public
1298      *
1299      * @return string The page content.
1300      * Lines are separated by new-lines.
1301      */
1302     function getPackedContent() {
1303         $data = &$this->_data;
1304
1305
1306         if (empty($data['%content'])) {
1307             include_once('lib/InlineParser.php');
1308             // Replace empty content with default value.
1309             return sprintf(_("Describe %s here."),
1310                            "[" . WikiEscape($this->_pagename) . "]");
1311         }
1312
1313         // There is (non-default) content.
1314         assert($this->_version > 0);
1315
1316         if (!is_string($data['%content'])) {
1317             // Content was not provided to us at init time.
1318             // (This is allowed because for some backends, fetching
1319             // the content may be expensive, and often is not wanted
1320             // by the user.)
1321             //
1322             // In any case, now we need to get it.
1323             $data['%content'] = $this->_get_content();
1324             assert(is_string($data['%content']));
1325         }
1326
1327         return $data['%content'];
1328     }
1329
1330     function _get_content() {
1331         $cache = &$this->_wikidb->_cache;
1332         $pagename = $this->_pagename;
1333         $version = $this->_version;
1334
1335         assert($version > 0);
1336
1337         $newdata = $cache->get_versiondata($pagename, $version, true);
1338         if ($newdata) {
1339             assert(is_string($newdata['%content']));
1340             return $newdata['%content'];
1341         }
1342         else {
1343             // else revision has been deleted... What to do?
1344             return __sprintf("Oops! Revision %s of %s seems to have been deleted!",
1345                              $version, $pagename);
1346         }
1347     }
1348
1349     /**
1350      * Get meta-data for this revision.
1351      *
1352      *
1353      * @access public
1354      *
1355      * @param string $key Which meta-data to access.
1356      *
1357      * Some reserved revision meta-data keys are:
1358      * <dl>
1359      * <dt> 'mtime' <dd> Time this revision was created (seconds since midnight Jan 1, 1970.)
1360      *        The 'mtime' meta-value is normally set automatically by the database
1361      *        backend, but it may be specified explicitly when creating a new revision.
1362      * <dt> orig_mtime
1363      *  <dd> To ensure consistency of RecentChanges, the mtimes of the versions
1364      *       of a page must be monotonically increasing.  If an attempt is
1365      *       made to create a new revision with an mtime less than that of
1366      *       the preceeding revision, the new revisions timestamp is force
1367      *       to be equal to that of the preceeding revision.  In that case,
1368      *       the originally requested mtime is preserved in 'orig_mtime'.
1369      * <dt> '_supplanted' <dd> Time this revision ceased to be the most recent.
1370      *        This meta-value is <em>always</em> automatically maintained by the database
1371      *        backend.  (It is set from the 'mtime' meta-value of the superceding
1372      *        revision.)  '_supplanted' has a value of 'false' for the current revision.
1373      *
1374      * FIXME: this could be refactored:
1375      * <dt> author
1376      *  <dd> Author of the page (as he should be reported in, e.g. RecentChanges.)
1377      * <dt> author_id
1378      *  <dd> Authenticated author of a page.  This is used to identify
1379      *       the distinctness of authors when cleaning old revisions from
1380      *       the database.
1381      * <dt> 'is_minor_edit' <dd> Set if change was marked as a minor revision by the author.
1382      * <dt> 'summary' <dd> Short change summary entered by page author.
1383      * </dl>
1384      *
1385      * Meta-data keys must be valid C identifers (they have to start with a letter
1386      * or underscore, and can contain only alphanumerics and underscores.)
1387      *
1388      * @return string The requested value, or false if the requested value
1389      * is not defined.
1390      */
1391     function get($key) {
1392         if (!$key || $key[0] == '%')
1393             return false;
1394         $data = &$this->_data;
1395         return isset($data[$key]) ? $data[$key] : false;
1396     }
1397
1398     /**
1399      * Get all the revision page meta-data as a hash.
1400      *
1401      * @return hash The revision meta-data.
1402      */
1403     function getMetaData() {
1404         $meta = array();
1405         foreach ($this->_data as $key => $val) {
1406             if (!empty($val) && $key[0] != '%')
1407                 $meta[$key] = $val;
1408         }
1409         return $meta;
1410     }
1411
1412
1413     /**
1414      * Return a string representation of the revision.
1415      *
1416      * This is really only for debugging.
1417      *
1418      * @access public
1419      *
1420      * @return string Printable representation of the WikiDB_Page.
1421      */
1422     function asString () {
1423         ob_start();
1424         printf("[%s:%d\n", get_class($this), $this->get('version'));
1425         print_r($this->_data);
1426         echo $this->getPackedContent() . "\n]\n";
1427         $strval = ob_get_contents();
1428         ob_end_clean();
1429         return $strval;
1430     }
1431 };
1432
1433
1434 /**
1435  * A class which represents a sequence of WikiDB_Pages.
1436  */
1437 class WikiDB_PageIterator
1438 {
1439     function WikiDB_PageIterator(&$wikidb, &$pages) {
1440         $this->_pages = $pages;
1441         $this->_wikidb = &$wikidb;
1442     }
1443
1444     function count () {
1445         return $this->_pages->count();
1446     }
1447
1448     /**
1449      * Get next WikiDB_Page in sequence.
1450      *
1451      * @access public
1452      *
1453      * @return WikiDB_Page The next WikiDB_Page in the sequence.
1454      */
1455     function next () {
1456         if ( ! ($next = $this->_pages->next()) )
1457             return false;
1458
1459         $pagename = &$next['pagename'];
1460         if (isset($next['pagedata']))
1461             $this->_wikidb->_cache->cache_data($next);
1462
1463         return new WikiDB_Page($this->_wikidb, $pagename);
1464     }
1465
1466     /**
1467      * Release resources held by this iterator.
1468      *
1469      * The iterator may not be used after free() is called.
1470      *
1471      * There is no need to call free(), if next() has returned false.
1472      * (I.e. if you iterate through all the pages in the sequence,
1473      * you do not need to call free() --- you only need to call it
1474      * if you stop before the end of the iterator is reached.)
1475      *
1476      * @access public
1477      */
1478     function free() {
1479         $this->_pages->free();
1480     }
1481
1482     // Not yet used and problematic. Order should be set in the query, not afterwards.
1483     // See PageList::sortby
1484     function setSortby ($arg = false) {
1485         if (!$arg) {
1486             $arg = @$_GET['sortby'];
1487             if ($arg) {
1488                 $sortby = substr($arg,1);
1489                 $order  = substr($arg,0,1)=='+' ? 'ASC' : 'DESC';
1490             }
1491         }
1492         if (is_array($arg)) { // array('mtime' => 'desc')
1493             $sortby = $arg[0];
1494             $order = $arg[1];
1495         } else {
1496             $sortby = $arg;
1497             $order  = 'ASC';
1498         }
1499         // available column types to sort by:
1500         // todo: we must provide access methods for the generic dumb/iterator
1501         $this->_types = explode(',','pagename,mtime,hits,version,author,locked,minor,markup');
1502         if (in_array($sortby,$this->_types))
1503             $this->_options['sortby'] = $sortby;
1504         else
1505             trigger_error(sprintf("Argument %s '%s' ignored",'sortby',$sortby), E_USER_WARNING);
1506         if (in_array(strtoupper($order),'ASC','DESC'))
1507             $this->_options['order'] = strtoupper($order);
1508         else
1509             trigger_error(sprintf("Argument %s '%s' ignored",'order',$order), E_USER_WARNING);
1510     }
1511
1512 };
1513
1514 /**
1515  * A class which represents a sequence of WikiDB_PageRevisions.
1516  */
1517 class WikiDB_PageRevisionIterator
1518 {
1519     function WikiDB_PageRevisionIterator(&$wikidb, &$revisions) {
1520         $this->_revisions = $revisions;
1521         $this->_wikidb = &$wikidb;
1522     }
1523
1524     function count () {
1525         return $this->_revisions->count();
1526     }
1527
1528     /**
1529      * Get next WikiDB_PageRevision in sequence.
1530      *
1531      * @access public
1532      *
1533      * @return WikiDB_PageRevision
1534      * The next WikiDB_PageRevision in the sequence.
1535      */
1536     function next () {
1537         if ( ! ($next = $this->_revisions->next()) )
1538             return false;
1539
1540         $this->_wikidb->_cache->cache_data($next);
1541
1542         $pagename = $next['pagename'];
1543         $version = $next['version'];
1544         $versiondata = $next['versiondata'];
1545         assert(is_string($pagename) and $pagename != '');
1546         assert(is_array($versiondata));
1547         assert($version > 0);
1548
1549         return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1550                                        $versiondata);
1551     }
1552
1553     /**
1554      * Release resources held by this iterator.
1555      *
1556      * The iterator may not be used after free() is called.
1557      *
1558      * There is no need to call free(), if next() has returned false.
1559      * (I.e. if you iterate through all the revisions in the sequence,
1560      * you do not need to call free() --- you only need to call it
1561      * if you stop before the end of the iterator is reached.)
1562      *
1563      * @access public
1564      */
1565     function free() {
1566         $this->_revisions->free();
1567     }
1568 };
1569
1570
1571 /**
1572  * Data cache used by WikiDB.
1573  *
1574  * FIXME: Maybe rename this to caching_backend (or some such).
1575  *
1576  * @access private
1577  */
1578 class WikiDB_cache
1579 {
1580     // FIXME: beautify versiondata cache.  Cache only limited data?
1581
1582     function WikiDB_cache (&$backend) {
1583         $this->_backend = &$backend;
1584
1585         $this->_pagedata_cache = array();
1586         $this->_versiondata_cache = array();
1587         array_push ($this->_versiondata_cache, array());
1588         $this->_glv_cache = array();
1589     }
1590
1591     function close() {
1592         $this->_pagedata_cache = false;
1593         $this->_versiondata_cache = false;
1594         $this->_glv_cache = false;
1595     }
1596
1597     function get_pagedata($pagename) {
1598         assert(is_string($pagename) && $pagename != '');
1599         $cache = &$this->_pagedata_cache;
1600
1601         if (!isset($cache[$pagename]) || !is_array($cache[$pagename])) {
1602             $cache[$pagename] = $this->_backend->get_pagedata($pagename);
1603             if (empty($cache[$pagename]))
1604                 $cache[$pagename] = array();
1605         }
1606
1607         return $cache[$pagename];
1608     }
1609
1610     function update_pagedata($pagename, $newdata) {
1611         assert(is_string($pagename) && $pagename != '');
1612
1613         $this->_backend->update_pagedata($pagename, $newdata);
1614
1615         if (is_array($this->_pagedata_cache[$pagename])) {
1616             $cachedata = &$this->_pagedata_cache[$pagename];
1617             foreach($newdata as $key => $val)
1618                 $cachedata[$key] = $val;
1619         }
1620     }
1621
1622     function invalidate_cache($pagename) {
1623         unset ($this->_pagedata_cache[$pagename]);
1624         unset ($this->_versiondata_cache[$pagename]);
1625         unset ($this->_glv_cache[$pagename]);
1626     }
1627
1628     function delete_page($pagename) {
1629         $this->_backend->delete_page($pagename);
1630         unset ($this->_pagedata_cache[$pagename]);
1631         unset ($this->_glv_cache[$pagename]);
1632     }
1633
1634     // FIXME: ugly
1635     function cache_data($data) {
1636         if (isset($data['pagedata']))
1637             $this->_pagedata_cache[$data['pagename']] = $data['pagedata'];
1638     }
1639
1640     function get_versiondata($pagename, $version, $need_content = false) {
1641         //  FIXME: Seriously ugly hackage
1642         if (defined ('USECACHE')){   //temporary - for debugging
1643             assert(is_string($pagename) && $pagename != '');
1644             // there is a bug here somewhere which results in an assertion failure at line 105
1645             // of ArchiveCleaner.php  It goes away if we use the next line.
1646             $need_content = true;
1647             $nc = $need_content ? '1':'0';
1648             $cache = &$this->_versiondata_cache;
1649             if (!isset($cache[$pagename][$version][$nc])||
1650                 !(is_array ($cache[$pagename])) || !(is_array ($cache[$pagename][$version]))) {
1651                 $cache[$pagename][$version][$nc] =
1652                     $this->_backend->get_versiondata($pagename,$version, $need_content);
1653                 // If we have retrieved all data, we may as well set the cache for $need_content = false
1654                 if ($need_content){
1655                     $cache[$pagename][$version]['0'] = $cache[$pagename][$version]['1'];
1656                 }
1657             }
1658             $vdata = $cache[$pagename][$version][$nc];
1659         } else {
1660             $vdata = $this->_backend->get_versiondata($pagename, $version, $need_content);
1661         }
1662         // FIXME: ugly
1663         if ($vdata && !empty($vdata['%pagedata']))
1664             $this->_pagedata_cache[$pagename] = $vdata['%pagedata'];
1665         return $vdata;
1666     }
1667
1668     function set_versiondata($pagename, $version, $data) {
1669         $new = $this->_backend->set_versiondata($pagename, $version, $data);
1670         // Update the cache
1671         $this->_versiondata_cache[$pagename][$version]['1'] = $data;
1672         // FIXME: hack
1673         $this->_versiondata_cache[$pagename][$version]['0'] = $data;
1674         // Is this necessary?
1675         unset($this->_glv_cache[$pagename]);
1676     }
1677
1678     function update_versiondata($pagename, $version, $data) {
1679         $new = $this->_backend->update_versiondata($pagename, $version, $data);
1680         // Update the cache
1681         $this->_versiondata_cache[$pagename][$version]['1'] = $data;
1682         // FIXME: hack
1683         $this->_versiondata_cache[$pagename][$version]['0'] = $data;
1684         // Is this necessary?
1685         unset($this->_glv_cache[$pagename]);
1686     }
1687
1688     function delete_versiondata($pagename, $version) {
1689         $new = $this->_backend->delete_versiondata($pagename, $version);
1690         unset ($this->_versiondata_cache[$pagename][$version]['1']);
1691         unset ($this->_versiondata_cache[$pagename][$version]['0']);
1692         unset ($this->_glv_cache[$pagename]);
1693     }
1694
1695     function get_latest_version($pagename)  {
1696         if (defined('USECACHE')){
1697             assert (is_string($pagename) && $pagename != '');
1698             $cache = &$this->_glv_cache;
1699             if (!isset($cache[$pagename])) {
1700                 $cache[$pagename] = $this->_backend->get_latest_version($pagename);
1701                 if (empty($cache[$pagename]))
1702                     $cache[$pagename] = 0;
1703             }
1704             return $cache[$pagename];
1705         } else {
1706             return $this->_backend->get_latest_version($pagename);
1707         }
1708     }
1709
1710 };
1711
1712 // $Log: not supported by cvs2svn $
1713 // Revision 1.43  2004/04/18 01:34:20  rurban
1714 // protect most_popular from sortby=mtime
1715 //
1716 // Revision 1.42  2004/04/18 01:11:51  rurban
1717 // more numeric pagename fixes.
1718 // fixed action=upload with merge conflict warnings.
1719 // charset changed from constant to global (dynamic utf-8 switching)
1720 //
1721
1722 // Local Variables:
1723 // mode: php
1724 // tab-width: 8
1725 // c-basic-offset: 4
1726 // c-hanging-comment-ender-p: nil
1727 // indent-tabs-mode: nil
1728 // End:
1729 ?>