lib/WikiDB.php

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