lib/WikiDB.php

   1 <?php //-*-php-*-
   2 rcs_id('$Id: WikiDB.php,v 1.12 2002-08-23 18:29:29 rurban Exp $');
   3
   4 //FIXME: arg on get*Revision to hint that content is wanted.
   5
   6 define('WIKIDB_FORCE_CREATE', -1);
   7
   8 // FIXME:  used for debugging only.  Comment out if cache does not work
   9 define('USECACHE', 1);
  10
  11 /**
  12  * Abstract base class for the database used by PhpWiki.
  13  *
  14  * A <tt>WikiDB</tt> is a container for <tt>WikiDB_Page</tt>s which in
  15  * turn contain <tt>WikiDB_PageRevision</tt>s.
  16  *
  17  * Conceptually a <tt>WikiDB</tt> contains all possible
  18  * <tt>WikiDB_Page</tt>s, whether they have been initialized or not.
  19  * Since all possible pages are already contained in a WikiDB, a call
  20  * to WikiDB::getPage() will never fail (barring bugs and
  21  * e.g. filesystem or SQL database problems.)
  22  *
  23  * Also each <tt>WikiDB_Page</tt> always contains at least one
  24  * <tt>WikiDB_PageRevision</tt>: the default content (e.g. "Describe
  25  * [PageName] here.").  This default content has a version number of
  26  * zero.
  27  *
  28  * <tt>WikiDB_PageRevision</tt>s have read-only semantics. One can
  29  * only create new revisions or delete old ones --- one can not modify
  30  * an existing revision.
  31  */
  32 class WikiDB {
  33     /**
  34      * Open a WikiDB database.
  35      *
  36      * This is a static member function. This function inspects its
  37      * arguments to determine the proper subclass of WikiDB to
  38      * instantiate, and then it instantiates it.
  39      *
  40      * @access public
  41      *
  42      * @param $dbparams hash Database configuration parameters.
  43      * Some pertinent paramters are:
  44      * <dl>
  45      * <dt> dbtype
  46      * <dd> The back-end type.  Current supported types are:
  47      *   <dl>
  48      *   <dt> SQL
  49      *   <dd> Generic SQL backend based on the PEAR/DB database abstraction
  50      *       library.
  51      *   <dt> dba
  52      *   <dd> Dba based backend.
  53      *   </dl>
  54      *
  55      * <dt> dsn
  56      * <dd> (Used by the SQL backend.)
  57      *      The DSN specifying which database to connect to.
  58      *
  59      * <dt> prefix
  60      * <dd> Prefix to be prepended to database table (and file names).
  61      *
  62      * <dt> directory
  63      * <dd> (Used by the dba backend.)
  64      *      Which directory db files reside in.
  65      *
  66      * <dt> timeout
  67      * <dd> (Used by the dba backend.)
  68      *      Timeout in seconds for opening (and obtaining lock) on the
  69      *      db files.
  70      *
  71      * <dt> dba_handler
  72      * <dd> (Used by the dba backend.)
  73      *
  74      *      Which dba handler to use. Good choices are probably either
  75      *      'gdbm' or 'db2'.
  76      * </dl>
  77      *
  78      * @return object A WikiDB object.
  79      **/
  80     function open ($dbparams) {
  81         $dbtype = $dbparams{'dbtype'};
  82         include_once("lib/WikiDB/$dbtype.php");
  83
  84         $class = 'WikiDB_' . $dbtype;
  85         return new $class ($dbparams);
  86     }
  87
  88
  89     /**
  90      * Constructor
  91      * @access protected
  92      */
  93     function WikiDB ($backend, $dbparams) {
  94         $this->_backend = &$backend;
  95         $this->_cache = new WikiDB_cache($backend);
  96
  97         //FIXME: devel checking.
  98         //$this->_backend->check();
  99     }
 100
 101     /**
 102      * Get any user-level warnings about this WikiDB.
 103      *
 104      * Some back-ends, e.g. by default create there data files in the
 105      * global /tmp directory. We would like to warn the user when this
 106      * happens (since /tmp files tend to get wiped periodically.)
 107      * Warnings such as these may be communicated from specific
 108      * back-ends through this method.
 109      *
 110      * @access public
 111      *
 112      * @return string A warning message (or <tt>false</tt> if there is
 113      * none.)
 114      */
 115     function genericWarnings() {
 116         return false;
 117     }
 118
 119     /**
 120      * Close database connection.
 121      *
 122      * The database may no longer be used after it is closed.
 123      *
 124      * Closing a WikiDB invalidates all <tt>WikiDB_Page</tt>s,
 125      * <tt>WikiDB_PageRevision</tt>s and <tt>WikiDB_PageIterator</tt>s
 126      * which have been obtained from it.
 127      *
 128      * @access public
 129      */
 130     function close () {
 131         $this->_backend->close();
 132         $this->_cache->close();
 133     }
 134
 135     /**
 136      * Get a WikiDB_Page from a WikiDB.
 137      *
 138      * A WikiDB consists of the (infinite) set of all possible pages,
 139      * therefore this method never fails.
 140      *
 141      * @access public
 142      * @param $pagename string Which page to get.
 143      * @return object The requested WikiDB_Page.
 144      */
 145     function getPage($pagename) {
 146         assert(is_string($pagename) && $pagename);
 147         return new WikiDB_Page($this, $pagename);
 148     }
 149
 150
 151     // Do we need this?
 152     //function nPages() {
 153     //}
 154
 155
 156     /**
 157      * Determine whether page exists (in non-default form).
 158      *
 159      * <pre>
 160      *   $is_page = $dbi->isWikiPage($pagename);
 161      * </pre>
 162      * is equivalent to
 163      * <pre>
 164      *   $page = $dbi->getPage($pagename);
 165      *   $current = $page->getCurrentRevision();
 166      *   $is_page = ! $current->hasDefaultContents();
 167      * </pre>
 168      * however isWikiPage may be implemented in a more efficient
 169      * manner in certain back-ends.
 170      *
 171      * @access public
 172      *
 173      * @param $pagename string Which page to check.
 174      *
 175      * @return boolean True if the page actually exists with
 176      * non-default contents in the WikiDataBase.
 177      */
 178     function isWikiPage ($pagename) {
 179         $page = $this->getPage($pagename);
 180         $current = $page->getCurrentRevision();
 181         return ! $current->hasDefaultContents();
 182     }
 183
 184     /**
 185      * Delete page from the WikiDB.
 186      *
 187      * Deletes all revisions of the page from the WikiDB. Also resets
 188      * all page meta-data to the default values.
 189      *
 190      * @access public
 191      *
 192      * @param $pagename string Name of page to delete.
 193      */
 194     function deletePage($pagename) {
 195         $this->_cache->delete_page($pagename);
 196         $this->_backend->set_links($pagename, false);
 197     }
 198
 199     /**
 200      * Retrieve all pages.
 201      *
 202      * Gets the set of all pages with non-default contents.
 203      *
 204      * FIXME: do we need this?  I think so.  The simple searches
 205      *        need this stuff.
 206      *
 207      * @access public
 208      *
 209      * @param $include_defaulted boolean Normally pages whose most
 210      * recent revision has empty content are considered to be
 211      * non-existant. Unless $include_defaulted is set to true, those
 212      * pages will not be returned.
 213      *
 214      * @return object A WikiDB_PageIterator which contains all pages
 215      *     in the WikiDB which have non-default contents.
 216      */
 217     function getAllPages($include_defaulted = false) {
 218         $result = $this->_backend->get_all_pages($include_defaulted);
 219         return new WikiDB_PageIterator($this, $result);
 220     }
 221
 222     /**
 223      * Title search.
 224      *
 225      * Search for pages containing (or not containing) certain words
 226      * in their names.
 227      *
 228      * Pages are returned in alphabetical order whenever it is
 229      * practical to do so.
 230      *
 231      * FIXME: should titleSearch and fullSearch be combined?  I think so.
 232      *
 233      * @access public
 234      * @param $search object A TextSearchQuery
 235      * @return object A WikiDB_PageIterator containing the matching pages.
 236      * @see TextSearchQuery
 237      */
 238     function titleSearch($search) {
 239         $result = $this->_backend->text_search($search);
 240         return new WikiDB_PageIterator($this, $result);
 241     }
 242
 243     /**
 244      * Full text search.
 245      *
 246      * Search for pages containing (or not containing) certain words
 247      * in their entire text (this includes the page content and the
 248      * page name).
 249      *
 250      * Pages are returned in alphabetical order whenever it is
 251      * practical to do so.
 252      *
 253      * @access public
 254      *
 255      * @param $search object A TextSearchQuery object.
 256      * @return object A WikiDB_PageIterator containing the matching pages.
 257      * @see TextSearchQuery
 258      */
 259     function fullSearch($search) {
 260         $result = $this->_backend->text_search($search, 'full_text');
 261         return new WikiDB_PageIterator($this, $result);
 262     }
 263
 264     /**
 265      * Find the pages with the greatest hit counts.
 266      *
 267      * Pages are returned in reverse order by hit count.
 268      *
 269      * @access public
 270      *
 271      * @param $limit signed integer The maximum number of pages to return.
 272      * Set $limit to zero to return all pages.  If $limit < 0, pages will
 273          * be sorted in decreasing order of popularity.
 274      *
 275      * @return object A WikiDB_PageIterator containing the matching
 276      * pages.
 277      */
 278     function mostPopular($limit = 20) {
 279         $result = $this->_backend->most_popular($limit);
 280         return new WikiDB_PageIterator($this, $result);
 281     }
 282
 283     /**
 284      * Find recent page revisions.
 285      *
 286      * Revisions are returned in reverse order by creation time.
 287      *
 288      * @access public
 289      *
 290      * @param $params hash This hash is used to specify various optional
 291      *   parameters:
 292      * <dl>
 293      * <dt> limit
 294      *    <dd> (integer) At most this many revisions will be returned.
 295      * <dt> since
 296      *    <dd> (integer) Only revisions since this time (unix-timestamp) will be returned.
 297      * <dt> include_minor_revisions
 298      *    <dd> (boolean) Also include minor revisions.  (Default is not to.)
 299      * <dt> exclude_major_revisions
 300      *    <dd> (boolean) Don't include non-minor revisions.
 301      *         (Exclude_major_revisions implies include_minor_revisions.)
 302      * <dt> include_all_revisions
 303      *    <dd> (boolean) Return all matching revisions for each page.
 304      *         Normally only the most recent matching revision is returned
 305      *         for each page.
 306      * </dl>
 307      *
 308      * @return object A WikiDB_PageRevisionIterator containing the
 309      * matching revisions.
 310      */
 311     function mostRecent($params = false) {
 312         $result = $this->_backend->most_recent($params);
 313         return new WikiDB_PageRevisionIterator($this, $result);
 314     }
 315
 316 };
 317
 318
 319 /**
 320  * An abstract base class which representing a wiki-page within a
 321  * WikiDB.
 322  *
 323  * A WikiDB_Page contains a number (at least one) of
 324  * WikiDB_PageRevisions.
 325  */
 326 class WikiDB_Page
 327 {
 328     function WikiDB_Page(&$wikidb, $pagename) {
 329         $this->_wikidb = &$wikidb;
 330         $this->_pagename = $pagename;
 331         assert(!empty($this->_pagename));
 332     }
 333
 334     /**
 335      * Get the name of the wiki page.
 336      *
 337      * @access public
 338      *
 339      * @return string The page name.
 340      */
 341     function getName() {
 342         return $this->_pagename;
 343     }
 344
 345
 346     /**
 347      * Delete an old revision of a WikiDB_Page.
 348      *
 349      * Deletes the specified revision of the page.
 350      * It is a fatal error to attempt to delete the current revision.
 351      *
 352      * @access public
 353      *
 354      * @param $version integer Which revision to delete.  (You can also
 355      *  use a WikiDB_PageRevision object here.)
 356      */
 357     function deleteRevision($version) {
 358         $backend = &$this->_wikidb->_backend;
 359         $cache = &$this->_wikidb->_cache;
 360         $pagename = &$this->_pagename;
 361
 362         $version = $this->_coerce_to_version($version);
 363         if ($version == 0)
 364             return;
 365
 366         $backend->lock();
 367         $latestversion = $cache->get_latest_version($pagename);
 368         if ($latestversion && $version == $latestversion) {
 369             $backend->unlock();
 370             trigger_error(sprintf("Attempt to delete most recent revision of '%s'",
 371                                   $pagename), E_USER_ERROR);
 372             return;
 373         }
 374
 375         $cache->delete_versiondata($pagename, $version);
 376
 377         $backend->unlock();
 378     }
 379
 380     /*
 381      * Delete a revision, or possibly merge it with a previous
 382      * revision.
 383      *
 384      * The idea is this:
 385      * Suppose an author make a (major) edit to a page.  Shortly
 386      * after that the same author makes a minor edit (e.g. to fix
 387      * spelling mistakes he just made.)
 388      *
 389      * Now some time later, where cleaning out old saved revisions,
 390      * and would like to delete his minor revision (since there's
 391      * really no point in keeping minor revisions around for a long
 392      * time.)
 393      *
 394      * Note that the text after the minor revision probably represents
 395      * what the author intended to write better than the text after
 396      * the preceding major edit.
 397      *
 398      * So what we really want to do is merge the minor edit with the
 399      * preceding edit.
 400      *
 401      * We will only do this when:
 402      * <ul>
 403      * <li>The revision being deleted is a minor one, and
 404      * <li>It has the same author as the immediately preceding revision.
 405      * </ul>
 406      */
 407     function mergeRevision($version) {
 408         $backend = &$this->_wikidb->_backend;
 409         $cache = &$this->_wikidb->_cache;
 410         $pagename = &$this->_pagename;
 411
 412         $version = $this->_coerce_to_version($version);
 413         if ($version == 0)
 414             return;
 415
 416         $backend->lock();
 417         $latestversion = $backend->get_latest_version($pagename);
 418         if ($latestversion && $version == $latestversion) {
 419             $backend->unlock();
 420             trigger_error(sprintf("Attempt to merge most recent revision of '%s'",
 421                                   $pagename), E_USER_ERROR);
 422             return;
 423         }
 424
 425         $versiondata = $cache->get_versiondata($pagename, $version, true);
 426         if (!$versiondata) {
 427             // Not there? ... we're done!
 428             $backend->unlock();
 429             return;
 430         }
 431
 432         if ($versiondata['is_minor_edit']) {
 433             $previous = $backend->get_previous_version($pagename, $version);
 434             if ($previous) {
 435                 $prevdata = $cache->get_versiondata($pagename, $previous);
 436                 if ($prevdata['author_id'] == $versiondata['author_id']) {
 437                     // This is a minor revision, previous version is
 438                     // by the same author. We will merge the
 439                     // revisions.
 440                     $cache->update_versiondata($pagename, $previous,
 441                                                array('%content' => $versiondata['%content'],
 442                                                      '_supplanted' => $versiondata['_supplanted']));
 443                 }
 444             }
 445         }
 446
 447         $cache->delete_versiondata($pagename, $version);
 448         $backend->unlock();
 449     }
 450
 451
 452     /**
 453      * Create a new revision of a WikiDB_Page.
 454      *
 455      * @access public
 456      *
 457      * @param $content string Contents of new revision.
 458      *
 459      * @param $metadata hash Metadata for new revision.
 460      * All values in the hash should be scalars (strings or integers).
 461      *
 462      *
 463      * @param $version int Version number for new revision.
 464      * To ensure proper serialization of edits, $version must be
 465      * exactly one higher than the current latest version.
 466      * (You can defeat this check by setting $version to
 467      * WIKIDB_FORCE_CREATE --- not usually recommended.)
 468      *
 469      * @param $links array List of pagenames which this page links to.
 470      *
 471      * @return object Returns the new WikiDB_PageRevision object. If
 472      * $version was incorrect, returns false
 473      */
 474     function createRevision($version, &$content, $metadata, $links) {
 475         $backend = &$this->_wikidb->_backend;
 476         $cache = &$this->_wikidb->_cache;
 477         $pagename = &$this->_pagename;
 478
 479         $backend->lock();
 480
 481         $latestversion = $backend->get_latest_version($pagename);
 482         $newversion = $latestversion + 1;
 483         assert($newversion >= 1);
 484
 485         if ($version != WIKIDB_FORCE_CREATE && $version != $newversion) {
 486             $backend->unlock();
 487             return false;
 488         }
 489
 490         $data = $metadata;
 491
 492         foreach ($data as $key => $val) {
 493             if (empty($val) || $key[0] == '_' || $key[0] == '%')
 494                 unset($data[$key]);
 495         }
 496
 497         assert(!empty($data['author_id']));
 498         if (empty($data['author_id']))
 499             @$data['author_id'] = $data['author'];
 500
 501         if (empty($data['mtime']))
 502             $data['mtime'] = time();
 503
 504         if ($latestversion) {
 505             // Ensure mtimes are monotonic.
 506             $pdata = $cache->get_versiondata($pagename, $latestversion);
 507             if ($data['mtime'] < $pdata['mtime']) {
 508                 trigger_error(sprintf(_("%s: Date of new revision is %s"),
 509                                       $pagename,"'non-monotonic'"),
 510                               E_USER_NOTICE);
 511                 $data['orig_mtime'] = $data['mtime'];
 512                 $data['mtime'] = $pdata['mtime'];
 513             }
 514
 515             // FIXME: use (possibly user specified) 'mtime' time or
 516             // time()?
 517             $cache->update_versiondata($pagename, $latestversion,
 518                                        array('_supplanted' => $data['mtime']));
 519         }
 520
 521         $data['%content'] = &$content;
 522
 523         $cache->set_versiondata($pagename, $newversion, $data);
 524
 525         //$cache->update_pagedata($pagename, array(':latestversion' => $newversion,
 526         //':deleted' => empty($content)));
 527
 528         $backend->set_links($pagename, $links);
 529
 530         $backend->unlock();
 531
 532         // FIXME: probably should have some global state information
 533         // in the backend to control when to optimize.
 534         if (time() % 50 == 0) {
 535             trigger_error(sprintf(_("Optimizing %s"),'backend'), E_USER_NOTICE);
 536             $backend->optimize();
 537         }
 538
 539         return new WikiDB_PageRevision($this->_wikidb, $pagename, $newversion,
 540                                        $data);
 541     }
 542
 543     /**
 544      * Get the most recent revision of a page.
 545      *
 546      * @access public
 547      *
 548      * @return object The current WikiDB_PageRevision object.
 549      */
 550     function getCurrentRevision() {
 551         $backend = &$this->_wikidb->_backend;
 552         $cache = &$this->_wikidb->_cache;
 553         $pagename = &$this->_pagename;
 554
 555         $backend->lock();
 556         $version = $cache->get_latest_version($pagename);
 557         $revision = $this->getRevision($version);
 558         $backend->unlock();
 559         assert($revision);
 560         return $revision;
 561     }
 562
 563     /**
 564      * Get a specific revision of a WikiDB_Page.
 565      *
 566      * @access public
 567      *
 568      * @param $version integer Which revision to get.
 569      *
 570      * @return object The requested WikiDB_PageRevision object, or
 571      * false if the requested revision does not exist in the WikiDB.
 572      * Note that version zero of any page always exists.
 573      */
 574     function getRevision($version) {
 575         $cache = &$this->_wikidb->_cache;
 576         $pagename = &$this->_pagename;
 577
 578         if ($version == 0)
 579             return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
 580
 581         assert($version > 0);
 582         $vdata = $cache->get_versiondata($pagename, $version);
 583         if (!$vdata)
 584             return false;
 585         return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
 586                                        $vdata);
 587     }
 588
 589     /**
 590      * Get previous page revision.
 591      *
 592      * This method find the most recent revision before a specified
 593      * version.
 594      *
 595      * @access public
 596      *
 597      * @param $version integer Find most recent revision before this version.
 598      *  You can also use a WikiDB_PageRevision object to specify the $version.
 599      *
 600      * @return object The requested WikiDB_PageRevision object, or false if the
 601      * requested revision does not exist in the WikiDB.  Note that
 602      * unless $version is greater than zero, a revision (perhaps version zero,
 603      * the default revision) will always be found.
 604      */
 605     function getRevisionBefore($version) {
 606         $backend = &$this->_wikidb->_backend;
 607         $pagename = &$this->_pagename;
 608
 609         $version = $this->_coerce_to_version($version);
 610
 611         if ($version == 0)
 612             return false;
 613         $backend->lock();
 614         $previous = $backend->get_previous_version($pagename, $version);
 615         $revision = $this->getRevision($previous);
 616         $backend->unlock();
 617         assert($revision);
 618         return $revision;
 619     }
 620
 621     /**
 622      * Get all revisions of the WikiDB_Page.
 623      *
 624      * This does not include the version zero (default) revision in the
 625      * returned revision set.
 626      *
 627      * @return object a WikiDB_PageRevisionIterator containing all
 628      * revisions of this WikiDB_Page in reverse order by version
 629      * number.
 630      */
 631     function getAllRevisions() {
 632         $backend = &$this->_wikidb->_backend;
 633         $revs = $backend->get_all_revisions($this->_pagename);
 634         return new WikiDB_PageRevisionIterator($this->_wikidb, $revs);
 635     }
 636
 637     /**
 638      * Find pages which link to or are linked from a page.
 639      *
 640      * @access public
 641      *
 642      * @param $reversed enum Which links to find: true for backlinks (default).
 643      *
 644      * @return object A WikiDB_PageIterator containing all matching pages.
 645      */
 646     function getLinks($reversed = true) {
 647         $backend = &$this->_wikidb->_backend;
 648         $result =  $backend->get_links($this->_pagename, $reversed);
 649         return new WikiDB_PageIterator($this->_wikidb, $result);
 650     }
 651
 652     /**
 653      * Access WikiDB_Page meta-data.
 654      *
 655      * @access public
 656      *
 657      * @param $key string Which meta data to get.
 658      * Some reserved meta-data keys are:
 659      * <dl>
 660      * <dt>'locked'<dd> Is page locked?
 661      * <dt>'hits'  <dd> Page hit counter.
 662      * <dt>'user'  <dd> User Homepage
 663      * <dt>'group' <dd> Group list
 664      * <dt>'score' <dd> Page score (not yet implement, do we need?)
 665      * </dl>
 666      *
 667      * @return scalar The requested value, or false if the requested data
 668      * is not set.
 669      */
 670     function get($key) {
 671         $cache = &$this->_wikidb->_cache;
 672         if (!$key || $key[0] == '%')
 673             return false;
 674         $data = $cache->get_pagedata($this->_pagename);
 675         return isset($data[$key]) ? $data[$key] : false;
 676     }
 677
 678     /**
 679      * Get all the page meta-data as a hash.
 680      *
 681      * @return hash The page meta-data.
 682      */
 683     function getMetaData() {
 684         $cache = &$this->_wikidb->_cache;
 685         $data = $cache->get_pagedata($this->_pagename);
 686         $meta = array();
 687         foreach ($data as $key => $val) {
 688             if (!empty($val) && $key[0] != '%')
 689                 $meta[$key] = $val;
 690         }
 691         return $meta;
 692     }
 693
 694     /**
 695      * Set page meta-data.
 696      *
 697      * @see get
 698      * @access public
 699      *
 700      * @param $key string Meta-data key to set.
 701      * @param $newval string New value.
 702      */
 703     function set($key, $newval) {
 704         $cache = &$this->_wikidb->_cache;
 705         $pagename = &$this->_pagename;
 706
 707         assert($key && $key[0] != '%');
 708
 709         $data = $cache->get_pagedata($pagename);
 710
 711         if (!empty($newval)) {
 712             if (!empty($data[$key]) && $data[$key] == $newval)
 713                 return;         // values identical, skip update.
 714         }
 715         else {
 716             if (empty($data[$key]))
 717                 return;         // values identical, skip update.
 718         }
 719
 720         $cache->update_pagedata($pagename, array($key => $newval));
 721     }
 722
 723     /**
 724      * Increase page hit count.
 725      *
 726      * FIXME: IS this needed?  Probably not.
 727      *
 728      * This is a convenience function.
 729      * <pre> $page->increaseHitCount(); </pre>
 730      * is functionally identical to
 731      * <pre> $page->set('hits',$page->get('hits')+1); </pre>
 732      *
 733      * Note that this method may be implemented in more efficient ways
 734      * in certain backends.
 735      *
 736      * @access public
 737      */
 738     function increaseHitCount() {
 739         @$newhits = $this->get('hits') + 1;
 740         $this->set('hits', $newhits);
 741     }
 742
 743     /**
 744      * Return a string representation of the WikiDB_Page
 745      *
 746      * This is really only for debugging.
 747      *
 748      * @access public
 749      *
 750      * @return string Printable representation of the WikiDB_Page.
 751      */
 752     function asString () {
 753         ob_start();
 754         printf("[%s:%s\n", get_class($this), $this->getName());
 755         print_r($this->getMetaData());
 756         echo "]\n";
 757         $strval = ob_get_contents();
 758         ob_end_clean();
 759         return $strval;
 760     }
 761
 762
 763     /**
 764      * @access private
 765      * @param $version_or_pagerevision int or object
 766      * Takes either the version number (and int) or a WikiDB_PageRevision
 767      * object.
 768      * @return int The version number.
 769      */
 770     function _coerce_to_version($version_or_pagerevision) {
 771         if (method_exists($version_or_pagerevision, "getContent"))
 772             $version = $version_or_pagerevision->getVersion();
 773         else
 774             $version = (int) $version_or_pagerevision;
 775
 776         assert($version >= 0);
 777         return $version;
 778     }
 779
 780     function isUserPage ($include_empty = true) {
 781         return $this->get('pref') ? true : false;
 782         if ($include_empty)
 783             return true;
 784         $current = $this->getCurrentRevision();
 785         return ! $current->hasDefaultContents();
 786     }
 787
 788 };
 789
 790 /**
 791  * This class represents a specific revision of a WikiDB_Page within
 792  * a WikiDB.
 793  *
 794  * A WikiDB_PageRevision has read-only semantics. You may only create
 795  * new revisions (and delete old ones) --- you cannot modify existing
 796  * revisions.
 797  */
 798 class WikiDB_PageRevision
 799 {
 800     function WikiDB_PageRevision(&$wikidb, $pagename, $version,
 801                                  $versiondata = false)
 802         {
 803             $this->_wikidb = &$wikidb;
 804             $this->_pagename = $pagename;
 805             $this->_version = $version;
 806             $this->_data = $versiondata ? $versiondata : array();
 807         }
 808
 809     /**
 810      * Get the WikiDB_Page which this revision belongs to.
 811      *
 812      * @access public
 813      *
 814      * @return object The WikiDB_Page which this revision belongs to.
 815      */
 816     function getPage() {
 817         return new WikiDB_Page($this->_wikidb, $this->_pagename);
 818     }
 819
 820     /**
 821      * Get the version number of this revision.
 822      *
 823      * @access public
 824      *
 825      * @return int The version number of this revision.
 826      */
 827     function getVersion() {
 828         return $this->_version;
 829     }
 830
 831     /**
 832      * Determine whether this revision has defaulted content.
 833      *
 834      * The default revision (version 0) of each page, as well as any
 835      * pages which are created with empty content have their content
 836      * defaulted to something like:
 837      * <pre>
 838      *   Describe [ThisPage] here.
 839      * </pre>
 840      *
 841      * @access public
 842      *
 843      * @return boolean Returns true if the page has default content.
 844      */
 845     function hasDefaultContents() {
 846         $data = &$this->_data;
 847         return empty($data['%content']);
 848     }
 849
 850     /**
 851      * Get the content as an array of lines.
 852      *
 853      * @access public
 854      *
 855      * @return array An array of lines.
 856      * The lines should contain no trailing white space.
 857      */
 858     function getContent() {
 859         return explode("\n", $this->getPackedContent());
 860     }
 861
 862     /**
 863      * Determine whether revision is the latest.
 864      *
 865      * @access public
 866      *
 867      * @return bool True iff the revision is the latest (most recent) one.
 868      */
 869     function isCurrent() {
 870         if (!isset($this->_iscurrent)) {
 871             $page = $this->getPage();
 872             $current = $page->getCurrentRevision();
 873             $this->_iscurrent = $this->getVersion() == $current->getVersion();
 874         }
 875         return $this->_iscurrent;
 876     }
 877
 878     /**
 879      * Get the content as a string.
 880      *
 881      * @access public
 882      *
 883      * @return string The page content.
 884      * Lines are separated by new-lines.
 885      */
 886     function getPackedContent() {
 887         $data = &$this->_data;
 888
 889
 890         if (empty($data['%content'])) {
 891             // Replace empty content with default value.
 892             return sprintf(_("Describe %s here."),
 893                            "[". $this->_pagename ."]");
 894         }
 895
 896         // There is (non-default) content.
 897         assert($this->_version > 0);
 898
 899         if (!is_string($data['%content'])) {
 900             // Content was not provided to us at init time.
 901             // (This is allowed because for some backends, fetching
 902             // the content may be expensive, and often is not wanted
 903             // by the user.)
 904             //
 905             // In any case, now we need to get it.
 906             $data['%content'] = $this->_get_content();
 907             assert(is_string($data['%content']));
 908         }
 909
 910         return $data['%content'];
 911     }
 912
 913     function _get_content() {
 914         $cache = &$this->_wikidb->_cache;
 915         $pagename = $this->_pagename;
 916         $version = $this->_version;
 917
 918         assert($version > 0);
 919
 920         $newdata = $cache->get_versiondata($pagename, $version, true);
 921         if ($newdata) {
 922             assert(is_string($newdata['%content']));
 923             return $newdata['%content'];
 924         }
 925         else {
 926             // else revision has been deleted... What to do?
 927             return __sprintf("Acck! Revision %s of %s seems to have been deleted!",
 928                              $version, $pagename);
 929         }
 930     }
 931
 932     /**
 933      * Get meta-data for this revision.
 934      *
 935      *
 936      * @access public
 937      *
 938      * @param $key string Which meta-data to access.
 939      *
 940      * Some reserved revision meta-data keys are:
 941      * <dl>
 942      * <dt> 'mtime' <dd> Time this revision was created (seconds since midnight Jan 1, 1970.)
 943      *        The 'mtime' meta-value is normally set automatically by the database
 944      *        backend, but it may be specified explicitly when creating a new revision.
 945      * <dt> orig_mtime
 946      *  <dd> To ensure consistency of RecentChanges, the mtimes of the versions
 947      *       of a page must be monotonically increasing.  If an attempt is
 948      *       made to create a new revision with an mtime less than that of
 949      *       the preceeding revision, the new revisions timestamp is force
 950      *       to be equal to that of the preceeding revision.  In that case,
 951      *       the originally requested mtime is preserved in 'orig_mtime'.
 952      * <dt> '_supplanted' <dd> Time this revision ceased to be the most recent.
 953      *        This meta-value is <em>always</em> automatically maintained by the database
 954      *        backend.  (It is set from the 'mtime' meta-value of the superceding
 955      *        revision.)  '_supplanted' has a value of 'false' for the current revision.
 956      *
 957      * FIXME: this could be refactored:
 958      * <dt> author
 959      *  <dd> Author of the page (as he should be reported in, e.g. RecentChanges.)
 960      * <dt> author_id
 961      *  <dd> Authenticated author of a page.  This is used to identify
 962      *       the distinctness of authors when cleaning old revisions from
 963      *       the database.
 964      * <dt> 'is_minor_edit' <dd> Set if change was marked as a minor revision by the author.
 965      * <dt> 'summary' <dd> Short change summary entered by page author.
 966      * </dl>
 967      *
 968      * Meta-data keys must be valid C identifers (they have to start with a letter
 969      * or underscore, and can contain only alphanumerics and underscores.)
 970      *
 971      * @return string The requested value, or false if the requested value
 972      * is not defined.
 973      */
 974     function get($key) {
 975         if (!$key || $key[0] == '%')
 976             return false;
 977         $data = &$this->_data;
 978         return isset($data[$key]) ? $data[$key] : false;
 979     }
 980
 981     /**
 982      * Get all the revision page meta-data as a hash.
 983      *
 984      * @return hash The revision meta-data.
 985      */
 986     function getMetaData() {
 987         $meta = array();
 988         foreach ($this->_data as $key => $val) {
 989             if (!empty($val) && $key[0] != '%')
 990                 $meta[$key] = $val;
 991         }
 992         return $meta;
 993     }
 994
 995
 996     /**
 997      * Return a string representation of the revision.
 998      *
 999      * This is really only for debugging.
1000      *
1001      * @access public
1002      *
1003      * @return string Printable representation of the WikiDB_Page.
1004      */
1005     function asString () {
1006         ob_start();
1007         printf("[%s:%d\n", get_class($this), $this->get('version'));
1008         print_r($this->_data);
1009         echo $this->getPackedContent() . "\n]\n";
1010         $strval = ob_get_contents();
1011         ob_end_clean();
1012         return $strval;
1013     }
1014 };
1015
1016
1017 /**
1018  * A class which represents a sequence of WikiDB_Pages.
1019  */
1020 class WikiDB_PageIterator
1021 {
1022     function WikiDB_PageIterator(&$wikidb, &$pages) {
1023         $this->_pages = $pages;
1024         $this->_wikidb = &$wikidb;
1025     }
1026
1027     /**
1028      * Get next WikiDB_Page in sequence.
1029      *
1030      * @access public
1031      *
1032      * @return object The next WikiDB_Page in the sequence.
1033      */
1034     function next () {
1035         if ( ! ($next = $this->_pages->next()) )
1036             return false;
1037
1038         $pagename = &$next['pagename'];
1039         if (isset($next['pagedata']))
1040             $this->_wikidb->_cache->cache_data($next);
1041
1042         return new WikiDB_Page($this->_wikidb, $pagename);
1043     }
1044
1045     /**
1046      * Release resources held by this iterator.
1047      *
1048      * The iterator may not be used after free() is called.
1049      *
1050      * There is no need to call free(), if next() has returned false.
1051      * (I.e. if you iterate through all the pages in the sequence,
1052      * you do not need to call free() --- you only need to call it
1053      * if you stop before the end of the iterator is reached.)
1054      *
1055      * @access public
1056      */
1057     function free() {
1058         $this->_pages->free();
1059     }
1060 };
1061
1062 /**
1063  * A class which represents a sequence of WikiDB_PageRevisions.
1064  */
1065 class WikiDB_PageRevisionIterator
1066 {
1067     function WikiDB_PageRevisionIterator(&$wikidb, &$revisions) {
1068         $this->_revisions = $revisions;
1069         $this->_wikidb = &$wikidb;
1070     }
1071
1072     /**
1073      * Get next WikiDB_PageRevision in sequence.
1074      *
1075      * @access public
1076      *
1077      * @return object The next WikiDB_PageRevision in the sequence.
1078      */
1079     function next () {
1080         if ( ! ($next = $this->_revisions->next()) )
1081             return false;
1082
1083         $this->_wikidb->_cache->cache_data($next);
1084
1085         $pagename = $next['pagename'];
1086         $version = $next['version'];
1087         $versiondata = $next['versiondata'];
1088         assert(!empty($pagename));
1089         assert(is_array($versiondata));
1090         assert($version > 0);
1091
1092         return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1093                                        $versiondata);
1094     }
1095
1096     /**
1097      * Release resources held by this iterator.
1098      *
1099      * The iterator may not be used after free() is called.
1100      *
1101      * There is no need to call free(), if next() has returned false.
1102      * (I.e. if you iterate through all the revisions in the sequence,
1103      * you do not need to call free() --- you only need to call it
1104      * if you stop before the end of the iterator is reached.)
1105      *
1106      * @access public
1107      */
1108     function free() {
1109         $this->_revisions->free();
1110     }
1111 };
1112
1113
1114 /**
1115  * Data cache used by WikiDB.
1116  *
1117  * FIXME: Maybe rename this to caching_backend (or some such).
1118  *
1119  * @access protected
1120  */
1121 class WikiDB_cache
1122 {
1123     // FIXME: beautify versiondata cache.  Cache only limited data?
1124
1125     function WikiDB_cache (&$backend) {
1126         $this->_backend = &$backend;
1127
1128         $this->_pagedata_cache = array();
1129                 $this->_versiondata_cache = array();
1130                 array_push ($this->_versiondata_cache, array());
1131                 $this->_glv_cache = array();
1132     }
1133
1134     function close() {
1135         $this->_pagedata_cache = false;
1136                 $this->_versiondata_cache = false;
1137                 $this->_glv_cache = false;
1138     }
1139
1140     function get_pagedata($pagename) {
1141         assert(is_string($pagename) && $pagename);
1142         $cache = &$this->_pagedata_cache;
1143
1144         if (!isset($cache[$pagename]) || !is_array($cache[$pagename])) {
1145             $cache[$pagename] = $this->_backend->get_pagedata($pagename);
1146             if (empty($cache[$pagename]))
1147                 $cache[$pagename] = array();
1148         }
1149
1150         return $cache[$pagename];
1151     }
1152
1153     function update_pagedata($pagename, $newdata) {
1154         assert(is_string($pagename) && $pagename);
1155
1156         $this->_backend->update_pagedata($pagename, $newdata);
1157
1158         if (is_array($this->_pagedata_cache[$pagename])) {
1159             $cachedata = &$this->_pagedata_cache[$pagename];
1160             foreach($newdata as $key => $val)
1161                 $cachedata[$key] = $val;
1162         }
1163     }
1164
1165     function invalidate_cache($pagename) {
1166         unset ($this->_pagedata_cache[$pagename]);
1167                 unset ($this->_versiondata_cache[$pagename]);
1168                 unset ($this->_glv_cache[$pagename]);
1169     }
1170
1171     function delete_page($pagename) {
1172         $this->_backend->delete_page($pagename);
1173         unset ($this->_pagedata_cache[$pagename]);
1174                 unset ($this->_glv_cache[$pagename]);
1175     }
1176
1177     // FIXME: ugly
1178     function cache_data($data) {
1179         if (isset($data['pagedata']))
1180             $this->_pagedata_cache[$data['pagename']] = $data['pagedata'];
1181     }
1182
1183     function get_versiondata($pagename, $version, $need_content = false) {
1184                 //  FIXME: Seriously ugly hackage
1185         if (defined ('USECACHE')){   //temporary - for debugging
1186         assert(is_string($pagename) && $pagename);
1187                 // there is a bug here somewhere which results in an assertion failure at line 105
1188                 // of ArchiveCleaner.php  It goes away if we use the next line.
1189                 $need_content = true;
1190                 $nc = $need_content ? '1':'0';
1191         $cache = &$this->_versiondata_cache;
1192         if (!isset($cache[$pagename][$version][$nc])||
1193                                 !(is_array ($cache[$pagename])) || !(is_array ($cache[$pagename][$version]))) {
1194             $cache[$pagename][$version][$nc] =
1195                                 $this->_backend->get_versiondata($pagename,$version, $need_content);
1196                         // If we have retrieved all data, we may as well set the cache for $need_content = false
1197                         if($need_content){
1198                                 $cache[$pagename][$version]['0'] = $cache[$pagename][$version]['1'];
1199                         }
1200                 }
1201         $vdata = $cache[$pagename][$version][$nc];
1202         }
1203         else
1204         {
1205     $vdata = $this->_backend->get_versiondata($pagename, $version, $need_content);
1206         }
1207         // FIXME: ugly
1208         if ($vdata && !empty($vdata['%pagedata']))
1209             $this->_pagedata_cache[$pagename] = $vdata['%pagedata'];
1210         return $vdata;
1211     }
1212
1213     function set_versiondata($pagename, $version, $data) {
1214         $new = $this->_backend->
1215              set_versiondata($pagename, $version, $data);
1216                 // Update the cache
1217                 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
1218                 // FIXME: hack
1219                 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
1220                 // Is this necessary?
1221                 unset($this->_glv_cache[$pagename]);
1222
1223     }
1224
1225     function update_versiondata($pagename, $version, $data) {
1226         $new = $this->_backend->
1227              update_versiondata($pagename, $version, $data);
1228                 // Update the cache
1229                 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
1230                 // FIXME: hack
1231                 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
1232                 // Is this necessary?
1233                 unset($this->_glv_cache[$pagename]);
1234
1235     }
1236
1237     function delete_versiondata($pagename, $version) {
1238         $new = $this->_backend->
1239              delete_versiondata($pagename, $version);
1240                 unset ($this->_versiondata_cache[$pagename][$version]['1']);
1241                 unset ($this->_versiondata_cache[$pagename][$version]['0']);
1242                 unset ($this->_glv_cache[$pagename]);
1243     }
1244
1245         function get_latest_version($pagename)  {
1246         if(defined('USECACHE')){
1247                 assert (is_string($pagename) && $pagename);
1248         $cache = &$this->_glv_cache;
1249         if (!isset($cache[$pagename])) {
1250             $cache[$pagename] = $this->_backend->get_latest_version($pagename);
1251             if (empty($cache[$pagename]))
1252                 $cache[$pagename] = 0;
1253         }
1254         return $cache[$pagename];}
1255         else {
1256                 return $this->_backend->get_latest_version($pagename);
1257                 }
1258         }
1259
1260 };
1261
1262 /**
1263  * FIXME! Class for externally authenticated users.
1264  *
1265  * We might have read-only access to the password and/or group membership,
1266  * or we might even be able to update the entries.
1267  *
1268  *   Group: list of userid's in a special WikiDB_Page
1269  *   WikiDB_Page:  owner.group permission_flag in page metadata
1270  *
1271  * FIXME: This was written before we stored prefs as %pagedata, so
1272  */
1273 class WikiDB_User
1274 extends WikiUser
1275 {
1276     var $_authdb;
1277
1278     function WikiDB_User($userid, $authlevel = false) {
1279         $this->_authdb = new WikiAuthDB($GLOBALS['DBAuthParams']);
1280         $this->_authmethod = 'AuthDB';
1281         WikiUser::WikiUser($userid, $authlevel);
1282     }
1283
1284     function getPreferences() {
1285         // external prefs override internal ones?
1286         if (! $this->_authdb->getPrefs() )
1287             if ($pref = WikiUser::getPreferences())
1288                 return $prefs;
1289         return false;
1290     }
1291
1292     function setPreferences($prefs) {
1293         if (! $this->_authdb->setPrefs($prefs) )
1294             return WikiUser::setPreferences();
1295     }
1296
1297     function exists() {
1298         return $this->_authdb->exists($this->_userid);
1299     }
1300
1301     // create user and default user homepage
1302     function createUser ($pref) {
1303         if ($this->exists()) return;
1304         if (! $this->_authdb->createUser($pref)) {
1305             // external auth doesn't allow this.
1306             // do our policies allow local users instead?
1307             return WikiUser::createUser($pref);
1308         }
1309     }
1310
1311     function checkPassword($passwd) {
1312         return $this->_authdb->pwcheck($passwd);
1313     }
1314
1315     function changePassword($passwd) {
1316         if (! $this->mayChangePassword() ) {
1317             trigger_error(sprintf("Attempt to change an external password for '%s'",
1318                                   $this->_userid), E_USER_ERROR);
1319             return;
1320         }
1321         return $this->_authdb->changePass($passwd);
1322     }
1323
1324     function mayChangePassword() {
1325         return $this->_authdb->auth_update;
1326     }
1327 }
1328
1329 class WikiAuthDB
1330 extends WikiDB
1331 {
1332     var $auth_dsn = false, $auth_check = false;
1333     var $auth_crypt_method = 'crypt', $auth_update = false;
1334     var $group_members = false, $user_groups = false;
1335     var $pref_update = false, $pref_select = false;
1336
1337     function WikiAuthDB($DBAuthParams) {
1338         foreach ($DBAuthParams as $key => $value) {
1339             $this->$key = $value;
1340         }
1341     }
1342
1343     function getPrefs($prefs) {
1344         if ($this->pref_select) {
1345             trigger_error(sprintf("WikiAuthDB->getPrefs() not yet written for '%s'",
1346                                   $this->_userid), E_USER_WARNING);
1347         } else {
1348             trigger_error(sprintf("WikiAuthDB->getPrefs() not defined for '%s'",
1349                                   $this->_userid), E_USER_ERROR);
1350         }
1351         return false;
1352     }
1353     function setPrefs($prefs) {
1354         if ($this->pref_write) {
1355             trigger_error(sprintf("WikiAuthDB->setPrefs() not allowed for '%s'",
1356                                   $this->_userid), E_USER_ERROR);
1357         } else {
1358             trigger_error(sprintf("WikiAuthDB->setPrefs() not yet written for '%s'",
1359                                   $this->_userid), E_USER_WARNING);
1360         }
1361         return false;
1362     }
1363     function createUser ($pref) {
1364         trigger_error(sprintf("WikiAuthDB->createUser() not yet written for '%s'",
1365                               $this->_userid), E_USER_WARNING);
1366         return false;
1367     }
1368     function exists() {
1369         trigger_error(sprintf("WikiAuthDB->exists() not yet written for '%s'",
1370                               $this->_userid), E_USER_WARNING);
1371         return false;
1372     }
1373     function pwcheck($pass) {
1374         trigger_error(sprintf("WikiAuthDB->pwcheck() not yet written for '%s'",
1375                               $this->_userid), E_USER_WARNING);
1376         return false;
1377     }
1378 }
1379
1380 // Local Variables:
1381 // mode: php
1382 // tab-width: 8
1383 // c-basic-offset: 4
1384 // c-hanging-comment-ender-p: nil
1385 // indent-tabs-mode: nil
1386 // End:
1387 ?>