lib/WikiDB.php

   1 <?php //-*-php-*-
   2 rcs_id('$Id: WikiDB.php,v 1.128 2005-04-01 16:11:42 rurban Exp $');
   3
   4 require_once('lib/PageType.php');
   5
   6 /**
   7  * The classes in the file define the interface to the
   8  * page database.
   9  *
  10  * @package WikiDB
  11  * @author Geoffrey T. Dairiki <dairiki@dairiki.org>
  12  *         Reini Urban
  13  */
  14
  15 /**
  16  * Force the creation of a new revision.
  17  * @see WikiDB_Page::createRevision()
  18  */
  19 if (!defined('WIKIDB_FORCE_CREATE'))
  20     define('WIKIDB_FORCE_CREATE', -1);
  21
  22 /**
  23  * Abstract base class for the database used by PhpWiki.
  24  *
  25  * A <tt>WikiDB</tt> is a container for <tt>WikiDB_Page</tt>s which in
  26  * turn contain <tt>WikiDB_PageRevision</tt>s.
  27  *
  28  * Conceptually a <tt>WikiDB</tt> contains all possible
  29  * <tt>WikiDB_Page</tt>s, whether they have been initialized or not.
  30  * Since all possible pages are already contained in a WikiDB, a call
  31  * to WikiDB::getPage() will never fail (barring bugs and
  32  * e.g. filesystem or SQL database problems.)
  33  *
  34  * Also each <tt>WikiDB_Page</tt> always contains at least one
  35  * <tt>WikiDB_PageRevision</tt>: the default content (e.g. "Describe
  36  * [PageName] here.").  This default content has a version number of
  37  * zero.
  38  *
  39  * <tt>WikiDB_PageRevision</tt>s have read-only semantics. One can
  40  * only create new revisions or delete old ones --- one can not modify
  41  * an existing revision.
  42  */
  43 class WikiDB {
  44     /**
  45      * Open a WikiDB database.
  46      *
  47      * This is a static member function. This function inspects its
  48      * arguments to determine the proper subclass of WikiDB to
  49      * instantiate, and then it instantiates it.
  50      *
  51      * @access public
  52      *
  53      * @param hash $dbparams Database configuration parameters.
  54      * Some pertinent paramters are:
  55      * <dl>
  56      * <dt> dbtype
  57      * <dd> The back-end type.  Current supported types are:
  58      *   <dl>
  59      *   <dt> SQL
  60      *     <dd> Generic SQL backend based on the PEAR/DB database abstraction
  61      *       library. (More stable and conservative)
  62      *   <dt> ADODB
  63      *     <dd> Another generic SQL backend. (More current features are tested here. Much faster)
  64      *   <dt> dba
  65      *     <dd> Dba based backend. The default and by far the fastest.
  66      *   <dt> cvs
  67      *     <dd>
  68      *   <dt> file
  69      *     <dd> flat files
  70      *   </dl>
  71      *
  72      * <dt> dsn
  73      * <dd> (Used by the SQL and ADODB backends.)
  74      *      The DSN specifying which database to connect to.
  75      *
  76      * <dt> prefix
  77      * <dd> Prefix to be prepended to database tables (and file names).
  78      *
  79      * <dt> directory
  80      * <dd> (Used by the dba backend.)
  81      *      Which directory db files reside in.
  82      *
  83      * <dt> timeout
  84      * <dd> Used only by the dba backend so far.
  85      *      And: When optimizing mysql it closes timed out mysql processes.
  86      *      otherwise only used for dba: Timeout in seconds for opening (and
  87      *      obtaining lock) on the dbm file.
  88      *
  89      * <dt> dba_handler
  90      * <dd> (Used by the dba backend.)
  91      *
  92      *      Which dba handler to use. Good choices are probably either
  93      *      'gdbm' or 'db2'.
  94      * </dl>
  95      *
  96      * @return WikiDB A WikiDB object.
  97      **/
  98     function open ($dbparams) {
  99         $dbtype = $dbparams{'dbtype'};
 100         include_once("lib/WikiDB/$dbtype.php");
 101
 102         $class = 'WikiDB_' . $dbtype;
 103         return new $class ($dbparams);
 104     }
 105
 106
 107     /**
 108      * Constructor.
 109      *
 110      * @access private
 111      * @see open()
 112      */
 113     function WikiDB (&$backend, $dbparams) {
 114         $this->_backend = &$backend;
 115         // don't do the following with the auth_dsn!
 116         if (isset($dbparams['auth_dsn'])) return;
 117
 118         $this->_cache = new WikiDB_cache($backend);
 119         if (!empty($GLOBALS['request'])) $GLOBALS['request']->_dbi = $this;
 120
 121         // If the database doesn't yet have a timestamp, initialize it now.
 122         if ($this->get('_timestamp') === false)
 123             $this->touch();
 124
 125         //FIXME: devel checking.
 126         //$this->_backend->check();
 127     }
 128
 129     /**
 130      * Close database connection.
 131      *
 132      * The database may no longer be used after it is closed.
 133      *
 134      * Closing a WikiDB invalidates all <tt>WikiDB_Page</tt>s,
 135      * <tt>WikiDB_PageRevision</tt>s and <tt>WikiDB_PageIterator</tt>s
 136      * which have been obtained from it.
 137      *
 138      * @access public
 139      */
 140     function close () {
 141         $this->_backend->close();
 142         $this->_cache->close();
 143     }
 144
 145     /**
 146      * Get a WikiDB_Page from a WikiDB.
 147      *
 148      * A {@link WikiDB} consists of the (infinite) set of all possible pages,
 149      * therefore this method never fails.
 150      *
 151      * @access public
 152      * @param string $pagename Which page to get.
 153      * @return WikiDB_Page The requested WikiDB_Page.
 154      */
 155     function getPage($pagename) {
 156         static $error_displayed = false;
 157         $pagename = (string) $pagename;
 158         if (DEBUG) {
 159             if ($pagename === '') {
 160                 if ($error_displayed) return false;
 161                 $error_displayed = true;
 162                 if (function_exists("xdebug_get_function_stack"))
 163                     var_dump(xdebug_get_function_stack());
 164                 trigger_error("empty pagename", E_USER_WARNING);
 165                 return false;
 166             }
 167         } else {
 168             assert($pagename != '');
 169         }
 170         return new WikiDB_Page($this, $pagename);
 171     }
 172
 173     /**
 174      * Determine whether page exists (in non-default form).
 175      *
 176      * <pre>
 177      *   $is_page = $dbi->isWikiPage($pagename);
 178      * </pre>
 179      * is equivalent to
 180      * <pre>
 181      *   $page = $dbi->getPage($pagename);
 182      *   $current = $page->getCurrentRevision();
 183      *   $is_page = ! $current->hasDefaultContents();
 184      * </pre>
 185      * however isWikiPage may be implemented in a more efficient
 186      * manner in certain back-ends.
 187      *
 188      * @access public
 189      *
 190      * @param string $pagename string Which page to check.
 191      *
 192      * @return boolean True if the page actually exists with
 193      * non-default contents in the WikiDataBase.
 194      */
 195     function isWikiPage ($pagename) {
 196         $page = $this->getPage($pagename);
 197         return $page->exists();
 198     }
 199
 200     /**
 201      * Delete page from the WikiDB.
 202      *
 203      * Deletes the page from the WikiDB with the possibility to revert and diff.
 204      * //Also resets all page meta-data to the default values.
 205      *
 206      * Note: purgePage() effectively destroys all revisions of the page from the WikiDB.
 207      *
 208      * @access public
 209      *
 210      * @param string $pagename Name of page to delete.
 211      */
 212     function deletePage($pagename) {
 213         // don't create empty revisions of already purged pages.
 214         if ($this->_backend->get_latest_version($pagename))
 215             $result = $this->_cache->delete_page($pagename);
 216         else
 217             $result = -1;
 218
 219         /* Generate notification emails? */
 220         if (! $this->isWikiPage($pagename) and !isa($GLOBALS['request'],'MockRequest')) {
 221             $notify = $this->get('notify');
 222             if (!empty($notify) and is_array($notify)) {
 223                 //TODO: deferr it (quite a massive load if you remove some pages).
 224                 //TODO: notification class which catches all changes,
 225                 //  and decides at the end of the request what to mail. (type, page, who, what, users, emails)
 226                 // could be used for PageModeration and RSS2 Cloud xml-rpc also.
 227                 $page = new WikiDB_Page($this, $pagename);
 228                 list($emails, $userids) = $page->getPageChangeEmails($notify);
 229                 if (!empty($emails)) {
 230                     $editedby = sprintf(_("Removed by: %s"), $GLOBALS['request']->_user->getId()); // Todo: host_id
 231                     $emails = join(',', $emails);
 232                     $subject = sprintf(_("Page removed %s"), urlencode($pagename));
 233                     if (mail($emails,"[".WIKI_NAME."] ".$subject,
 234                              $subject."\n".
 235                              $editedby."\n\n".
 236                              "Deleted $pagename"))
 237                         trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
 238                                               $pagename, join(',',$userids)), E_USER_NOTICE);
 239                     else
 240                         trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
 241                                               $pagename, join(',',$userids)), E_USER_WARNING);
 242                 }
 243             }
 244         }
 245
 246         //How to create a RecentChanges entry with explaining summary? Dynamically
 247         /*
 248         $page = $this->getPage($pagename);
 249         $current = $page->getCurrentRevision();
 250         $meta = $current->_data;
 251         $version = $current->getVersion();
 252         $meta['summary'] = _("removed");
 253         $page->save($current->getPackedContent(), $version + 1, $meta);
 254         */
 255         return $result;
 256     }
 257
 258     /**
 259      * Completely remove the page from the WikiDB, without undo possibility.
 260      */
 261     function purgePage($pagename) {
 262         $result = $this->_cache->purge_page($pagename);
 263         $this->deletePage($pagename); // just for the notification
 264         return $result;
 265     }
 266
 267     /**
 268      * Retrieve all pages.
 269      *
 270      * Gets the set of all pages with non-default contents.
 271      *
 272      * @access public
 273      *
 274      * @param boolean $include_defaulted Normally pages whose most
 275      * recent revision has empty content are considered to be
 276      * non-existant. Unless $include_defaulted is set to true, those
 277      * pages will not be returned.
 278      *
 279      * @return WikiDB_PageIterator A WikiDB_PageIterator which contains all pages
 280      *     in the WikiDB which have non-default contents.
 281      */
 282     function getAllPages($include_empty=false, $sortby=false, $limit=false,
 283                          $exclude=false)
 284     {
 285         // HACK: memory_limit=8M will fail on too large pagesets. old php on unix only!
 286         if (USECACHE) {
 287             $mem = ini_get("memory_limit");
 288             if ($mem and !$limit and !isWindows() and !check_php_version(4,3)) {
 289                 $limit = 450;
 290                 $GLOBALS['request']->setArg('limit', $limit);
 291                 $GLOBALS['request']->setArg('paging', 'auto');
 292             }
 293         }
 294         $result = $this->_backend->get_all_pages($include_empty, $sortby, $limit,
 295                                                  $exclude);
 296         return new WikiDB_PageIterator($this, $result,
 297                                        array('include_empty' => $include_empty,
 298                                              'exclude' => $exclude,
 299                                              'limit' => $limit));
 300     }
 301
 302     /**
 303      * $include_empty = true: include also empty pages
 304      * exclude: comma-seperated list pagenames: TBD: array of pagenames
 305      */
 306     function numPages($include_empty=false, $exclude='') {
 307         if (method_exists($this->_backend, 'numPages'))
 308             // FIXME: currently are all args ignored.
 309             $count = $this->_backend->numPages($include_empty, $exclude);
 310         else {
 311             // FIXME: exclude ignored.
 312             $iter = $this->getAllPages($include_empty, false, false, $exclude);
 313             $count = $iter->count();
 314             $iter->free();
 315         }
 316         return (int)$count;
 317     }
 318
 319     /**
 320      * Title search.
 321      *
 322      * Search for pages containing (or not containing) certain words
 323      * in their names.
 324      *
 325      * Pages are returned in alphabetical order whenever it is
 326      * practical to do so.
 327      *
 328      * FIXME: clarify $search syntax. provide glob=>TextSearchQuery converters
 329      *
 330      * @access public
 331      * @param TextSearchQuery $search A TextSearchQuery object
 332      * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
 333      * @see TextSearchQuery
 334      */
 335     function titleSearch($search) {
 336         $result = $this->_backend->text_search($search, false);
 337         return new WikiDB_PageIterator($this, $result);
 338     }
 339
 340     /**
 341      * Full text search.
 342      *
 343      * Search for pages containing (or not containing) certain words
 344      * in their entire text (this includes the page content and the
 345      * page name).
 346      *
 347      * Pages are returned in alphabetical order whenever it is
 348      * practical to do so.
 349      *
 350      * @access public
 351      *
 352      * @param TextSearchQuery $search A TextSearchQuery object.
 353      * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
 354      * @see TextSearchQuery
 355      */
 356     function fullSearch($search) {
 357         $result = $this->_backend->text_search($search, true);
 358         return new WikiDB_PageIterator($this, $result);
 359     }
 360
 361     /**
 362      * Find the pages with the greatest hit counts.
 363      *
 364      * Pages are returned in reverse order by hit count.
 365      *
 366      * @access public
 367      *
 368      * @param integer $limit The maximum number of pages to return.
 369      * Set $limit to zero to return all pages.  If $limit < 0, pages will
 370      * be sorted in decreasing order of popularity.
 371      *
 372      * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching
 373      * pages.
 374      */
 375     function mostPopular($limit = 20, $sortby = '-hits') {
 376         $result = $this->_backend->most_popular($limit, $sortby);
 377         return new WikiDB_PageIterator($this, $result);
 378     }
 379
 380     /**
 381      * Find recent page revisions.
 382      *
 383      * Revisions are returned in reverse order by creation time.
 384      *
 385      * @access public
 386      *
 387      * @param hash $params This hash is used to specify various optional
 388      *   parameters:
 389      * <dl>
 390      * <dt> limit
 391      *    <dd> (integer) At most this many revisions will be returned.
 392      * <dt> since
 393      *    <dd> (integer) Only revisions since this time (unix-timestamp) will be returned.
 394      * <dt> include_minor_revisions
 395      *    <dd> (boolean) Also include minor revisions.  (Default is not to.)
 396      * <dt> exclude_major_revisions
 397      *    <dd> (boolean) Don't include non-minor revisions.
 398      *         (Exclude_major_revisions implies include_minor_revisions.)
 399      * <dt> include_all_revisions
 400      *    <dd> (boolean) Return all matching revisions for each page.
 401      *         Normally only the most recent matching revision is returned
 402      *         for each page.
 403      * </dl>
 404      *
 405      * @return WikiDB_PageRevisionIterator A WikiDB_PageRevisionIterator containing the
 406      * matching revisions.
 407      */
 408     function mostRecent($params = false) {
 409         $result = $this->_backend->most_recent($params);
 410         return new WikiDB_PageRevisionIterator($this, $result);
 411     }
 412
 413     /**
 414      * @access public
 415      *
 416      * @return Iterator A generic iterator containing rows of (duplicate) pagename, wantedfrom.
 417      */
 418     function wantedPages($exclude_from='', $exclude='', $sortby=false, $limit=false) {
 419         return $this->_backend->wanted_pages($exclude_from, $exclude, $sortby, $limit);
 420         //return new WikiDB_PageIterator($this, $result);
 421     }
 422
 423
 424     /**
 425      * Call the appropriate backend method.
 426      *
 427      * @access public
 428      * @param string $from Page to rename
 429      * @param string $to   New name
 430      * @param boolean $updateWikiLinks If the text in all pages should be replaced.
 431      * @return boolean     true or false
 432      */
 433     function renamePage($from, $to, $updateWikiLinks = false) {
 434         assert(is_string($from) && $from != '');
 435         assert(is_string($to) && $to != '');
 436         $result = false;
 437         if (method_exists($this->_backend, 'rename_page')) {
 438             $oldpage = $this->getPage($from);
 439             $newpage = $this->getPage($to);
 440             //update all WikiLinks in existing pages
 441             //non-atomic! i.e. if rename fails the links are not undone
 442             if ($updateWikiLinks) {
 443                 require_once('lib/plugin/WikiAdminSearchReplace.php');
 444                 $links = $oldpage->getBackLinks();
 445                 while ($linked_page = $links->next()) {
 446                     WikiPlugin_WikiAdminSearchReplace::replaceHelper($this,
 447                                                                      $linked_page->getName(),
 448                                                                      $from, $to);
 449                 }
 450                 $links = $newpage->getBackLinks();
 451                 while ($linked_page = $links->next()) {
 452                     WikiPlugin_WikiAdminSearchReplace::replaceHelper($this,
 453                                                                      $linked_page->getName(),
 454                                                                      $from, $to);
 455                 }
 456             }
 457             if ($oldpage->exists() and ! $newpage->exists()) {
 458                 if ($result = $this->_backend->rename_page($from, $to)) {
 459                     //create a RecentChanges entry with explaining summary
 460                     $page = $this->getPage($to);
 461                     $current = $page->getCurrentRevision();
 462                     $meta = $current->_data;
 463                     $version = $current->getVersion();
 464                     $meta['summary'] = sprintf(_("renamed from %s"), $from);
 465                     $page->save($current->getPackedContent(), $version + 1, $meta);
 466                 }
 467             } elseif (!$oldpage->getCurrentRevision(false) and !$newpage->exists()) {
 468                 // if a version 0 exists try it also.
 469                 $result = $this->_backend->rename_page($from, $to);
 470             }
 471         } else {
 472             trigger_error(_("WikiDB::renamePage() not yet implemented for this backend"),
 473                           E_USER_WARNING);
 474         }
 475         /* Generate notification emails? */
 476         if ($result and !isa($GLOBALS['request'], 'MockRequest')) {
 477             $notify = $this->get('notify');
 478             if (!empty($notify) and is_array($notify)) {
 479                 list($emails, $userids) = $oldpage->getPageChangeEmails($notify);
 480                 if (!empty($emails)) {
 481                     $oldpage->sendPageRenameNotification($to, $meta, $emails, $userids);
 482                 }
 483             }
 484         }
 485         return $result;
 486     }
 487
 488     /** Get timestamp when database was last modified.
 489      *
 490      * @return string A string consisting of two integers,
 491      * separated by a space.  The first is the time in
 492      * unix timestamp format, the second is a modification
 493      * count for the database.
 494      *
 495      * The idea is that you can cast the return value to an
 496      * int to get a timestamp, or you can use the string value
 497      * as a good hash for the entire database.
 498      */
 499     function getTimestamp() {
 500         $ts = $this->get('_timestamp');
 501         return sprintf("%d %d", $ts[0], $ts[1]);
 502     }
 503
 504     /**
 505      * Update the database timestamp.
 506      *
 507      */
 508     function touch() {
 509         $ts = $this->get('_timestamp');
 510         $this->set('_timestamp', array(time(), $ts[1] + 1));
 511     }
 512
 513
 514     /**
 515      * Access WikiDB global meta-data.
 516      *
 517      * NOTE: this is currently implemented in a hackish and
 518      * not very efficient manner.
 519      *
 520      * @access public
 521      *
 522      * @param string $key Which meta data to get.
 523      * Some reserved meta-data keys are:
 524      * <dl>
 525      * <dt>'_timestamp' <dd> Data used by getTimestamp().
 526      * </dl>
 527      *
 528      * @return scalar The requested value, or false if the requested data
 529      * is not set.
 530      */
 531     function get($key) {
 532         if (!$key || $key[0] == '%')
 533             return false;
 534         /*
 535          * Hack Alert: We can use any page (existing or not) to store
 536          * this data (as long as we always use the same one.)
 537          */
 538         $gd = $this->getPage('global_data');
 539         $data = $gd->get('__global');
 540
 541         if ($data && isset($data[$key]))
 542             return $data[$key];
 543         else
 544             return false;
 545     }
 546
 547     /**
 548      * Set global meta-data.
 549      *
 550      * NOTE: this is currently implemented in a hackish and
 551      * not very efficient manner.
 552      *
 553      * @see get
 554      * @access public
 555      *
 556      * @param string $key  Meta-data key to set.
 557      * @param string $newval  New value.
 558      */
 559     function set($key, $newval) {
 560         if (!$key || $key[0] == '%')
 561             return;
 562
 563         $gd = $this->getPage('global_data');
 564         $data = $gd->get('__global');
 565         if ($data === false)
 566             $data = array();
 567
 568         if (empty($newval))
 569             unset($data[$key]);
 570         else
 571             $data[$key] = $newval;
 572
 573         $gd->set('__global', $data);
 574     }
 575
 576     /* TODO: these are really backend methods */
 577
 578     // SQL result: for simple select or create/update queries
 579     // returns the database specific resource type
 580     function genericSqlQuery($sql, $args=false) {
 581         if (function_exists('debug_backtrace')) { // >= 4.3.0
 582             echo "<pre>", printSimpleTrace(debug_backtrace()), "</pre>\n";
 583         }
 584         trigger_error("no SQL database", E_USER_ERROR);
 585         return false;
 586     }
 587
 588     // SQL iter: for simple select or create/update queries
 589     // returns the generic iterator object (count,next)
 590     function genericSqlIter($sql, $field_list = NULL) {
 591         if (function_exists('debug_backtrace')) { // >= 4.3.0
 592             echo "<pre>", printSimpleTrace(debug_backtrace()), "</pre>\n";
 593         }
 594         trigger_error("no SQL database", E_USER_ERROR);
 595         return false;
 596     }
 597
 598     // see backend upstream methods
 599     // ADODB adds surrounding quotes, SQL not yet!
 600     function quote ($s) {
 601         return $s;
 602     }
 603
 604     function isOpen () {
 605         global $request;
 606         if (!$request->_dbi) return false;
 607         else return false; /* so far only needed for sql so false it.
 608                             later we have to check dba also */
 609     }
 610
 611     function getParam($param) {
 612         global $DBParams;
 613         if (isset($DBParams[$param])) return $DBParams[$param];
 614         elseif ($param == 'prefix') return '';
 615         else return false;
 616     }
 617
 618     function getAuthParam($param) {
 619         global $DBAuthParams;
 620         if (isset($DBAuthParams[$param])) return $DBAuthParams[$param];
 621         elseif ($param == 'USER_AUTH_ORDER') return $GLOBALS['USER_AUTH_ORDER'];
 622         elseif ($param == 'USER_AUTH_POLICY') return $GLOBALS['USER_AUTH_POLICY'];
 623         else return false;
 624     }
 625 };
 626
 627
 628 /**
 629  * An abstract base class which representing a wiki-page within a
 630  * WikiDB.
 631  *
 632  * A WikiDB_Page contains a number (at least one) of
 633  * WikiDB_PageRevisions.
 634  */
 635 class WikiDB_Page
 636 {
 637     function WikiDB_Page(&$wikidb, $pagename) {
 638         $this->_wikidb = &$wikidb;
 639         $this->_pagename = $pagename;
 640         if (DEBUG) {
 641             if (!(is_string($pagename) and $pagename != '')) {
 642                 if (function_exists("xdebug_get_function_stack")) {
 643                     echo "xdebug_get_function_stack(): "; var_dump(xdebug_get_function_stack());
 644                 } elseif (function_exists("debug_backtrace")) { // >= 4.3.0
 645                     printSimpleTrace(debug_backtrace());
 646                 }
 647                 trigger_error("empty pagename", E_USER_WARNING);
 648                 return false;
 649             }
 650         } else
 651             assert(is_string($pagename) and $pagename != '');
 652     }
 653
 654     /**
 655      * Get the name of the wiki page.
 656      *
 657      * @access public
 658      *
 659      * @return string The page name.
 660      */
 661     function getName() {
 662         return $this->_pagename;
 663     }
 664
 665     // To reduce the memory footprint for larger sets of pagelists,
 666     // we don't cache the content (only true or false) and
 667     // we purge the pagedata (_cached_html) also
 668     function exists() {
 669         if (isset($this->_wikidb->_cache->_id_cache[$this->_pagename])) return true;
 670         $current = $this->getCurrentRevision(false);
 671         if (!$current) return false;
 672         return ! $current->hasDefaultContents();
 673     }
 674
 675     /**
 676      * Delete an old revision of a WikiDB_Page.
 677      *
 678      * Deletes the specified revision of the page.
 679      * It is a fatal error to attempt to delete the current revision.
 680      *
 681      * @access public
 682      *
 683      * @param integer $version Which revision to delete.  (You can also
 684      *  use a WikiDB_PageRevision object here.)
 685      */
 686     function deleteRevision($version) {
 687         $backend = &$this->_wikidb->_backend;
 688         $cache = &$this->_wikidb->_cache;
 689         $pagename = &$this->_pagename;
 690
 691         $version = $this->_coerce_to_version($version);
 692         if ($version == 0)
 693             return;
 694
 695         $backend->lock(array('page','version'));
 696         $latestversion = $cache->get_latest_version($pagename);
 697         if ($latestversion && $version == $latestversion) {
 698             $backend->unlock(array('page','version'));
 699             trigger_error(sprintf("Attempt to delete most recent revision of '%s'",
 700                                   $pagename), E_USER_ERROR);
 701             return;
 702         }
 703
 704         $cache->delete_versiondata($pagename, $version);
 705         $backend->unlock(array('page','version'));
 706     }
 707
 708     /*
 709      * Delete a revision, or possibly merge it with a previous
 710      * revision.
 711      *
 712      * The idea is this:
 713      * Suppose an author make a (major) edit to a page.  Shortly
 714      * after that the same author makes a minor edit (e.g. to fix
 715      * spelling mistakes he just made.)
 716      *
 717      * Now some time later, where cleaning out old saved revisions,
 718      * and would like to delete his minor revision (since there's
 719      * really no point in keeping minor revisions around for a long
 720      * time.)
 721      *
 722      * Note that the text after the minor revision probably represents
 723      * what the author intended to write better than the text after
 724      * the preceding major edit.
 725      *
 726      * So what we really want to do is merge the minor edit with the
 727      * preceding edit.
 728      *
 729      * We will only do this when:
 730      * <ul>
 731      * <li>The revision being deleted is a minor one, and
 732      * <li>It has the same author as the immediately preceding revision.
 733      * </ul>
 734      */
 735     function mergeRevision($version) {
 736         $backend = &$this->_wikidb->_backend;
 737         $cache = &$this->_wikidb->_cache;
 738         $pagename = &$this->_pagename;
 739
 740         $version = $this->_coerce_to_version($version);
 741         if ($version == 0)
 742             return;
 743
 744         $backend->lock(array('version'));
 745         $latestversion = $cache->get_latest_version($pagename);
 746         if ($latestversion && $version == $latestversion) {
 747             $backend->unlock(array('version'));
 748             trigger_error(sprintf("Attempt to merge most recent revision of '%s'",
 749                                   $pagename), E_USER_ERROR);
 750             return;
 751         }
 752
 753         $versiondata = $cache->get_versiondata($pagename, $version, true);
 754         if (!$versiondata) {
 755             // Not there? ... we're done!
 756             $backend->unlock(array('version'));
 757             return;
 758         }
 759
 760         if ($versiondata['is_minor_edit']) {
 761             $previous = $backend->get_previous_version($pagename, $version);
 762             if ($previous) {
 763                 $prevdata = $cache->get_versiondata($pagename, $previous);
 764                 if ($prevdata['author_id'] == $versiondata['author_id']) {
 765                     // This is a minor revision, previous version is
 766                     // by the same author. We will merge the
 767                     // revisions.
 768                     $cache->update_versiondata($pagename, $previous,
 769                                                array('%content' => $versiondata['%content'],
 770                                                      '_supplanted' => $versiondata['_supplanted']));
 771                 }
 772             }
 773         }
 774
 775         $cache->delete_versiondata($pagename, $version);
 776         $backend->unlock(array('version'));
 777     }
 778
 779
 780     /**
 781      * Create a new revision of a {@link WikiDB_Page}.
 782      *
 783      * @access public
 784      *
 785      * @param int $version Version number for new revision.
 786      * To ensure proper serialization of edits, $version must be
 787      * exactly one higher than the current latest version.
 788      * (You can defeat this check by setting $version to
 789      * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
 790      *
 791      * @param string $content Contents of new revision.
 792      *
 793      * @param hash $metadata Metadata for new revision.
 794      * All values in the hash should be scalars (strings or integers).
 795      *
 796      * @param array $links List of pagenames which this page links to.
 797      *
 798      * @return WikiDB_PageRevision  Returns the new WikiDB_PageRevision object. If
 799      * $version was incorrect, returns false
 800      */
 801     function createRevision($version, &$content, $metadata, $links) {
 802         $backend = &$this->_wikidb->_backend;
 803         $cache = &$this->_wikidb->_cache;
 804         $pagename = &$this->_pagename;
 805         $cache->invalidate_cache($pagename);
 806
 807         $backend->lock(array('version','page','recent','link','nonempty'));
 808
 809         $latestversion = $backend->get_latest_version($pagename);
 810         $newversion = ($latestversion ? $latestversion : 0) + 1;
 811         assert($newversion >= 1);
 812
 813         if ($version != WIKIDB_FORCE_CREATE and $version != $newversion) {
 814             $backend->unlock(array('version','page','recent','link','nonempty'));
 815             return false;
 816         }
 817
 818         $data = $metadata;
 819
 820         foreach ($data as $key => $val) {
 821             if (empty($val) || $key[0] == '_' || $key[0] == '%')
 822                 unset($data[$key]);
 823         }
 824
 825         assert(!empty($data['author']));
 826         if (empty($data['author_id']))
 827             @$data['author_id'] = $data['author'];
 828
 829         if (empty($data['mtime']))
 830             $data['mtime'] = time();
 831
 832         if ($latestversion and $version != WIKIDB_FORCE_CREATE) {
 833             // Ensure mtimes are monotonic.
 834             $pdata = $cache->get_versiondata($pagename, $latestversion);
 835             if ($data['mtime'] < $pdata['mtime']) {
 836                 trigger_error(sprintf(_("%s: Date of new revision is %s"),
 837                                       $pagename,"'non-monotonic'"),
 838                               E_USER_NOTICE);
 839                 $data['orig_mtime'] = $data['mtime'];
 840                 $data['mtime'] = $pdata['mtime'];
 841             }
 842
 843             // FIXME: use (possibly user specified) 'mtime' time or
 844             // time()?
 845             $cache->update_versiondata($pagename, $latestversion,
 846                                        array('_supplanted' => $data['mtime']));
 847         }
 848
 849         $data['%content'] = &$content;
 850
 851         $cache->set_versiondata($pagename, $newversion, $data);
 852
 853         //$cache->update_pagedata($pagename, array(':latestversion' => $newversion,
 854         //':deleted' => empty($content)));
 855
 856         $backend->set_links($pagename, $links);
 857
 858         $backend->unlock(array('version','page','recent','link','nonempty'));
 859
 860         return new WikiDB_PageRevision($this->_wikidb, $pagename, $newversion,
 861                                        $data);
 862     }
 863
 864     /** A higher-level interface to createRevision.
 865      *
 866      * This takes care of computing the links, and storing
 867      * a cached version of the transformed wiki-text.
 868      *
 869      * @param string $wikitext  The page content.
 870      *
 871      * @param int $version Version number for new revision.
 872      * To ensure proper serialization of edits, $version must be
 873      * exactly one higher than the current latest version.
 874      * (You can defeat this check by setting $version to
 875      * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
 876      *
 877      * @param hash $meta  Meta-data for new revision.
 878      */
 879     function save($wikitext, $version, $meta) {
 880         $formatted = new TransformedText($this, $wikitext, $meta);
 881         $type = $formatted->getType();
 882         $meta['pagetype'] = $type->getName();
 883         $links = $formatted->getWikiPageLinks();
 884
 885         $backend = &$this->_wikidb->_backend;
 886         $newrevision = $this->createRevision($version, $wikitext, $meta, $links);
 887         if ($newrevision and !WIKIDB_NOCACHE_MARKUP)
 888             $this->set('_cached_html', $formatted->pack());
 889
 890         // FIXME: probably should have some global state information
 891         // in the backend to control when to optimize.
 892         //
 893         // We're doing this here rather than in createRevision because
 894         // postgres can't optimize while locked.
 895         if ((DEBUG & _DEBUG_SQL) or (time() % 5 == 0)) {
 896             if ($backend->optimize())
 897                 trigger_error(_("Optimizing database"), E_USER_NOTICE);
 898         }
 899
 900         /* Generate notification emails? */
 901         if (isa($newrevision, 'WikiDB_PageRevision')) {
 902             // Save didn't fail because of concurrent updates.
 903             $notify = $this->_wikidb->get('notify');
 904             if (!empty($notify) and is_array($notify) and !isa($GLOBALS['request'],'MockRequest')) {
 905                 list($emails, $userids) = $this->getPageChangeEmails($notify);
 906                 if (!empty($emails)) {
 907                     $this->sendPageChangeNotification($wikitext, $version, $meta, $emails, $userids);
 908                 }
 909             }
 910             $newrevision->_transformedContent = $formatted;
 911         }
 912
 913         return $newrevision;
 914     }
 915
 916     function getPageChangeEmails($notify) {
 917         $emails = array(); $userids = array();
 918         foreach ($notify as $page => $users) {
 919             if (glob_match($page, $this->_pagename)) {
 920                 foreach ($users as $userid => $user) {
 921                     if (!$user) { // handle the case for ModeratePage: no prefs, just userid's.
 922                         global $request;
 923                         $u = $request->getUser();
 924                         if ($u->UserName() == $userid) {
 925                             $prefs = $u->getPreferences();
 926                         } else {
 927                             // not current user
 928                             if (ENABLE_USER_NEW) {
 929                                 $u = WikiUser($userid);
 930                                 $u->getPreferences();
 931                                 $prefs = &$u->_prefs;
 932                             } else {
 933                                 $u = new WikiUser($GLOBALS['request'], $userid);
 934                                 $prefs = $u->getPreferences();
 935                             }
 936                         }
 937                         $emails[] = $prefs->get('email');
 938                         $userids[] = $userid;
 939                     } else {
 940                       if (!empty($user['verified']) and !empty($user['email'])) {
 941                         $emails[]  = $user['email'];
 942                         $userids[] = $userid;
 943                       } elseif (!empty($user['email'])) {
 944                         global $request;
 945                         // do a dynamic emailVerified check update
 946                         $u = $request->getUser();
 947                         if ($u->UserName() == $userid) {
 948                             if ($request->_prefs->get('emailVerified')) {
 949                                 $emails[] = $user['email'];
 950                                 $userids[] = $userid;
 951                                 $notify[$page][$userid]['verified'] = 1;
 952                                 $request->_dbi->set('notify', $notify);
 953                             }
 954                         } else {
 955                             // not current user
 956                             if (ENABLE_USER_NEW) {
 957                                 $u = WikiUser($userid);
 958                                 $u->getPreferences();
 959                                 $prefs = &$u->_prefs;
 960                             } else {
 961                                 $u = new WikiUser($GLOBALS['request'], $userid);
 962                                 $prefs = $u->getPreferences();
 963                             }
 964                             if ($prefs->get('emailVerified')) {
 965                                 $emails[] = $user['email'];
 966                                 $userids[] = $userid;
 967                                 $notify[$page][$userid]['verified'] = 1;
 968                                 $request->_dbi->set('notify', $notify);
 969                             }
 970                         }
 971                         // ignore verification
 972                         /*
 973                         if (DEBUG) {
 974                             if (!in_array($user['email'],$emails))
 975                                 $emails[] = $user['email'];
 976                         }
 977                         */
 978                     }
 979                   }
 980                 }
 981             }
 982         }
 983         $emails = array_unique($emails);
 984         $userids = array_unique($userids);
 985         return array($emails, $userids);
 986     }
 987
 988     /**
 989      * Send udiff for a changed page to multiple users.
 990      * See rename and remove methods also
 991      */
 992     function sendPageChangeNotification(&$wikitext, $version, $meta, $emails, $userids) {
 993         global $request;
 994         if (@is_array($request->_deferredPageChangeNotification)) {
 995             // collapse multiple changes (loaddir) into one email
 996             $request->_deferredPageChangeNotification[] = array($this->_pagename, $emails, $userids);
 997             return;
 998         }
 999         $backend = &$this->_wikidb->_backend;
1000         //$backend = &$request->_dbi->_backend;
1001         $subject = _("Page change").' '.urlencode($this->_pagename);
1002         $previous = $backend->get_previous_version($this->_pagename, $version);
1003         if (!isset($meta['mtime'])) $meta['mtime'] = time();
1004         if ($previous) {
1005             $difflink = WikiURL($this->_pagename, array('action'=>'diff'), true);
1006             $cache = &$this->_wikidb->_cache;
1007             //$cache = &$request->_dbi->_cache;
1008             $this_content = explode("\n", $wikitext);
1009             $prevdata = $cache->get_versiondata($this->_pagename, $previous, true);
1010             if (empty($prevdata['%content']))
1011                 $prevdata = $backend->get_versiondata($this->_pagename, $previous, true);
1012             $other_content = explode("\n", $prevdata['%content']);
1013
1014             include_once("lib/difflib.php");
1015             $diff2 = new Diff($other_content, $this_content);
1016             //$context_lines = max(4, count($other_content) + 1,
1017             //                     count($this_content) + 1);
1018             $fmt = new UnifiedDiffFormatter(/*$context_lines*/);
1019             $content  = $this->_pagename . " " . $previous . " " .
1020                 Iso8601DateTime($prevdata['mtime']) . "\n";
1021             $content .= $this->_pagename . " " . $version . " " .
1022                 Iso8601DateTime($meta['mtime']) . "\n";
1023             $content .= $fmt->format($diff2);
1024
1025         } else {
1026             $difflink = WikiURL($this->_pagename,array(),true);
1027             $content = $this->_pagename . " " . $version . " " .
1028                 Iso8601DateTime($meta['mtime']) . "\n";
1029             $content .= _("New page");
1030         }
1031         $editedby = sprintf(_("Edited by: %s"), $meta['author']);
1032         $emails = join(',',$emails);
1033         if (mail($emails,"[".WIKI_NAME."] ".$subject,
1034                  $subject."\n".
1035                  $editedby."\n".
1036                  $difflink."\n\n".
1037                  $content))
1038             trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
1039                                   $this->_pagename, join(',',$userids)), E_USER_NOTICE);
1040         else
1041             trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
1042                                   $this->_pagename, join(',',$userids)), E_USER_WARNING);
1043     }
1044
1045     /** support mass rename / remove (not yet tested)
1046      */
1047     function sendPageRenameNotification($to, &$meta, $emails, $userids) {
1048         global $request;
1049         if (@is_array($request->_deferredPageRenameNotification)) {
1050             $request->_deferredPageRenameNotification[] = array($this->_pagename,
1051                                                                 $to, $meta, $emails, $userids);
1052         } else {
1053             $from = $this->_pagename;
1054             $editedby = sprintf(_("Edited by: %s"), $meta['author']) . ' ' . $meta['author_id'];
1055             $emails = join(',',$emails);
1056             $subject = sprintf(_("Page rename %s to %s"), urlencode($from), urlencode($to));
1057             $link = WikiURL($to, true);
1058             if (mail($emails,"[".WIKI_NAME."] ".$subject,
1059                      $subject."\n".
1060                      $editedby."\n".
1061                      $link."\n\n".
1062                      "Renamed $from to $to"))
1063                 trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
1064                                       $from, join(',',$userids)), E_USER_NOTICE);
1065             else
1066                 trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
1067                                       $from, join(',',$userids)), E_USER_WARNING);
1068         }
1069     }
1070
1071     /**
1072      * Get the most recent revision of a page.
1073      *
1074      * @access public
1075      *
1076      * @return WikiDB_PageRevision The current WikiDB_PageRevision object.
1077      */
1078     function getCurrentRevision($need_content = true) {
1079         $backend = &$this->_wikidb->_backend;
1080         $cache = &$this->_wikidb->_cache;
1081         $pagename = &$this->_pagename;
1082
1083         // Prevent deadlock in case of memory exhausted errors
1084         // Pure selection doesn't really need locking here.
1085         //   sf.net bug#927395
1086         // I know it would be better to lock, but with lots of pages this deadlock is more
1087         // severe than occasionally get not the latest revision.
1088         // In spirit to wikiwiki: read fast, edit slower.
1089         //$backend->lock();
1090         $version = $cache->get_latest_version($pagename);
1091         // getRevision gets the content also!
1092         $revision = $this->getRevision($version, $need_content);
1093         //$backend->unlock();
1094         assert($revision);
1095         return $revision;
1096     }
1097
1098     /**
1099      * Get a specific revision of a WikiDB_Page.
1100      *
1101      * @access public
1102      *
1103      * @param integer $version  Which revision to get.
1104      *
1105      * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or
1106      * false if the requested revision does not exist in the {@link WikiDB}.
1107      * Note that version zero of any page always exists.
1108      */
1109     function getRevision($version, $need_content=true) {
1110         $cache = &$this->_wikidb->_cache;
1111         $pagename = &$this->_pagename;
1112
1113         if (! $version or $version == -1) // 0 or false
1114             return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
1115
1116         assert($version > 0);
1117         $vdata = $cache->get_versiondata($pagename, $version, $need_content);
1118         if (!$vdata) {
1119             return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
1120         }
1121         return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1122                                        $vdata);
1123     }
1124
1125     /**
1126      * Get previous page revision.
1127      *
1128      * This method find the most recent revision before a specified
1129      * version.
1130      *
1131      * @access public
1132      *
1133      * @param integer $version  Find most recent revision before this version.
1134      *  You can also use a WikiDB_PageRevision object to specify the $version.
1135      *
1136      * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or false if the
1137      * requested revision does not exist in the {@link WikiDB}.  Note that
1138      * unless $version is greater than zero, a revision (perhaps version zero,
1139      * the default revision) will always be found.
1140      */
1141     function getRevisionBefore($version, $need_content=true) {
1142         $backend = &$this->_wikidb->_backend;
1143         $pagename = &$this->_pagename;
1144
1145         $version = $this->_coerce_to_version($version);
1146
1147         if ($version == 0)
1148             return false;
1149         //$backend->lock();
1150         $previous = $backend->get_previous_version($pagename, $version);
1151         $revision = $this->getRevision($previous, $need_content);
1152         //$backend->unlock();
1153         assert($revision);
1154         return $revision;
1155     }
1156
1157     /**
1158      * Get all revisions of the WikiDB_Page.
1159      *
1160      * This does not include the version zero (default) revision in the
1161      * returned revision set.
1162      *
1163      * @return WikiDB_PageRevisionIterator A
1164      *   WikiDB_PageRevisionIterator containing all revisions of this
1165      *   WikiDB_Page in reverse order by version number.
1166      */
1167     function getAllRevisions() {
1168         $backend = &$this->_wikidb->_backend;
1169         $revs = $backend->get_all_revisions($this->_pagename);
1170         return new WikiDB_PageRevisionIterator($this->_wikidb, $revs);
1171     }
1172
1173     /**
1174      * Find pages which link to or are linked from a page.
1175      *
1176      * @access public
1177      *
1178      * @param boolean $reversed Which links to find: true for backlinks (default).
1179      *
1180      * @return WikiDB_PageIterator A WikiDB_PageIterator containing
1181      * all matching pages.
1182      */
1183     function getLinks($reversed = true, $include_empty=false, $sortby=false,
1184                       $limit=false, $exclude=false) {
1185         $backend = &$this->_wikidb->_backend;
1186         $result =  $backend->get_links($this->_pagename, $reversed,
1187                                        $include_empty, $sortby, $limit, $exclude);
1188         return new WikiDB_PageIterator($this->_wikidb, $result,
1189                                        array('include_empty' => $include_empty,
1190                                              'sortby' => $sortby,
1191                                              'limit' => $limit,
1192                                              'exclude' => $exclude));
1193     }
1194
1195     /**
1196      * All Links from other pages to this page.
1197      */
1198     function getBackLinks($include_empty=false, $sortby=false, $limit=false, $exclude=false) {
1199         return $this->getLinks(true, $include_empty, $sortby, $limit, $exclude);
1200     }
1201     /**
1202      * Forward Links: All Links from this page to other pages.
1203      */
1204     function getPageLinks($include_empty=false, $sortby=false, $limit=false, $exclude=false) {
1205         return $this->getLinks(false, $include_empty, $sortby, $limit, $exclude);
1206     }
1207
1208     /**
1209      * possibly faster link existance check. not yet accelerated.
1210      */
1211     function existLink($link, $reversed=false) {
1212         $backend = &$this->_wikidb->_backend;
1213         if (method_exists($backend,'exists_link'))
1214             return $backend->exists_link($this->_pagename, $link, $reversed);
1215         //$cache = &$this->_wikidb->_cache;
1216         // TODO: check cache if it is possible
1217         $iter = $this->getLinks($reversed, false);
1218         while ($page = $iter->next()) {
1219             if ($page->getName() == $link)
1220                 return $page;
1221         }
1222         $iter->free();
1223         return false;
1224     }
1225
1226     /**
1227      * Access WikiDB_Page meta-data.
1228      *
1229      * @access public
1230      *
1231      * @param string $key Which meta data to get.
1232      * Some reserved meta-data keys are:
1233      * <dl>
1234      * <dt>'locked'<dd> Is page locked?
1235      * <dt>'hits'  <dd> Page hit counter.
1236      * <dt>'pref'  <dd> Users preferences, stored in homepages.
1237      * <dt>'owner' <dd> Default: first author_id. We might add a group with a dot here:
1238      *                  E.g. "owner.users"
1239      * <dt>'perm'  <dd> Permission flag to authorize read/write/execution of
1240      *                  page-headers and content.
1241      * <dt>'score' <dd> Page score (not yet implement, do we need?)
1242      * </dl>
1243      *
1244      * @return scalar The requested value, or false if the requested data
1245      * is not set.
1246      */
1247     function get($key) {
1248         $cache = &$this->_wikidb->_cache;
1249         $backend = &$this->_wikidb->_backend;
1250         if (!$key || $key[0] == '%')
1251             return false;
1252         // several new SQL backends optimize this.
1253         if ($key == '_cached_html' and method_exists($backend, 'get_cached_html')) {
1254             return $backend->get_cached_html($this->_pagename);
1255         }
1256         $data = $cache->get_pagedata($this->_pagename);
1257         return isset($data[$key]) ? $data[$key] : false;
1258     }
1259
1260     /**
1261      * Get all the page meta-data as a hash.
1262      *
1263      * @return hash The page meta-data.
1264      */
1265     function getMetaData() {
1266         $cache = &$this->_wikidb->_cache;
1267         $data = $cache->get_pagedata($this->_pagename);
1268         $meta = array();
1269         foreach ($data as $key => $val) {
1270             if (/*!empty($val) &&*/ $key[0] != '%')
1271                 $meta[$key] = $val;
1272         }
1273         return $meta;
1274     }
1275
1276     /**
1277      * Set page meta-data.
1278      *
1279      * @see get
1280      * @access public
1281      *
1282      * @param string $key  Meta-data key to set.
1283      * @param string $newval  New value.
1284      */
1285     function set($key, $newval) {
1286         $cache = &$this->_wikidb->_cache;
1287         $backend = &$this->_wikidb->_backend;
1288         $pagename = &$this->_pagename;
1289
1290         assert($key && $key[0] != '%');
1291
1292         // several new SQL backends optimize this.
1293         if ($key == '_cached_html' and method_exists($backend, 'set_cached_html')) {
1294             return $backend->set_cached_html($pagename, $newval);
1295         }
1296
1297         $data = $cache->get_pagedata($pagename);
1298
1299         if (!empty($newval)) {
1300             if (!empty($data[$key]) && $data[$key] == $newval)
1301                 return;         // values identical, skip update.
1302         }
1303         else {
1304             if (empty($data[$key]))
1305                 return;         // values identical, skip update.
1306         }
1307
1308         $cache->update_pagedata($pagename, array($key => $newval));
1309     }
1310
1311     /**
1312      * Increase page hit count.
1313      *
1314      * FIXME: IS this needed?  Probably not.
1315      *
1316      * This is a convenience function.
1317      * <pre> $page->increaseHitCount(); </pre>
1318      * is functionally identical to
1319      * <pre> $page->set('hits',$page->get('hits')+1); </pre>
1320      * but less expensive (ignores the pagadata string)
1321      *
1322      * Note that this method may be implemented in more efficient ways
1323      * in certain backends.
1324      *
1325      * @access public
1326      */
1327     function increaseHitCount() {
1328         if (method_exists($this->_wikidb->_backend, 'increaseHitCount'))
1329             $this->_wikidb->_backend->increaseHitCount($this->_pagename);
1330         else {
1331             @$newhits = $this->get('hits') + 1;
1332             $this->set('hits', $newhits);
1333         }
1334     }
1335
1336     /**
1337      * Return a string representation of the WikiDB_Page
1338      *
1339      * This is really only for debugging.
1340      *
1341      * @access public
1342      *
1343      * @return string Printable representation of the WikiDB_Page.
1344      */
1345     function asString () {
1346         ob_start();
1347         printf("[%s:%s\n", get_class($this), $this->getName());
1348         print_r($this->getMetaData());
1349         echo "]\n";
1350         $strval = ob_get_contents();
1351         ob_end_clean();
1352         return $strval;
1353     }
1354
1355
1356     /**
1357      * @access private
1358      * @param integer_or_object $version_or_pagerevision
1359      * Takes either the version number (and int) or a WikiDB_PageRevision
1360      * object.
1361      * @return integer The version number.
1362      */
1363     function _coerce_to_version($version_or_pagerevision) {
1364         if (method_exists($version_or_pagerevision, "getContent"))
1365             $version = $version_or_pagerevision->getVersion();
1366         else
1367             $version = (int) $version_or_pagerevision;
1368
1369         assert($version >= 0);
1370         return $version;
1371     }
1372
1373     function isUserPage ($include_empty = true) {
1374         if (!$include_empty and !$this->exists()) return false;
1375         return $this->get('pref') ? true : false;
1376     }
1377
1378     // May be empty. Either the stored owner (/Chown), or the first authorized author
1379     function getOwner() {
1380         if ($owner = $this->get('owner'))
1381             return ($owner == "The PhpWiki programming team") ? ADMIN_USER : $owner;
1382         // check all revisions forwards for the first author_id
1383         $backend = &$this->_wikidb->_backend;
1384         $pagename = &$this->_pagename;
1385         $latestversion = $backend->get_latest_version($pagename);
1386         for ($v=1; $v <= $latestversion; $v++) {
1387             $rev = $this->getRevision($v,false);
1388             if ($rev and $owner = $rev->get('author_id')) {
1389                 return ($owner == "The PhpWiki programming team") ? ADMIN_USER : $owner;
1390             }
1391         }
1392         return '';
1393     }
1394
1395     // The authenticated author of the first revision or empty if not authenticated then.
1396     function getCreator() {
1397         if ($current = $this->getRevision(1,false)) return $current->get('author_id');
1398         else return '';
1399     }
1400
1401     // The authenticated author of the current revision.
1402     function getAuthor() {
1403         if ($current = $this->getCurrentRevision(false)) return $current->get('author_id');
1404         else return '';
1405     }
1406
1407 };
1408
1409 /**
1410  * This class represents a specific revision of a WikiDB_Page within
1411  * a WikiDB.
1412  *
1413  * A WikiDB_PageRevision has read-only semantics. You may only create
1414  * new revisions (and delete old ones) --- you cannot modify existing
1415  * revisions.
1416  */
1417 class WikiDB_PageRevision
1418 {
1419     //var $_transformedContent = false; // set by WikiDB_Page::save()
1420
1421     function WikiDB_PageRevision(&$wikidb, $pagename, $version, $versiondata = false) {
1422         $this->_wikidb = &$wikidb;
1423         $this->_pagename = $pagename;
1424         $this->_version = $version;
1425         $this->_data = $versiondata ? $versiondata : array();
1426         $this->_transformedContent = false; // set by WikiDB_Page::save()
1427     }
1428
1429     /**
1430      * Get the WikiDB_Page which this revision belongs to.
1431      *
1432      * @access public
1433      *
1434      * @return WikiDB_Page The WikiDB_Page which this revision belongs to.
1435      */
1436     function getPage() {
1437         return new WikiDB_Page($this->_wikidb, $this->_pagename);
1438     }
1439
1440     /**
1441      * Get the version number of this revision.
1442      *
1443      * @access public
1444      *
1445      * @return integer The version number of this revision.
1446      */
1447     function getVersion() {
1448         return $this->_version;
1449     }
1450
1451     /**
1452      * Determine whether this revision has defaulted content.
1453      *
1454      * The default revision (version 0) of each page, as well as any
1455      * pages which are created with empty content have their content
1456      * defaulted to something like:
1457      * <pre>
1458      *   Describe [ThisPage] here.
1459      * </pre>
1460      *
1461      * @access public
1462      *
1463      * @return boolean Returns true if the page has default content.
1464      */
1465     function hasDefaultContents() {
1466         $data = &$this->_data;
1467         return empty($data['%content']); // FIXME: what if it's the number 0? <>'' or === false
1468     }
1469
1470     /**
1471      * Get the content as an array of lines.
1472      *
1473      * @access public
1474      *
1475      * @return array An array of lines.
1476      * The lines should contain no trailing white space.
1477      */
1478     function getContent() {
1479         return explode("\n", $this->getPackedContent());
1480     }
1481
1482    /**
1483      * Get the pagename of the revision.
1484      *
1485      * @access public
1486      *
1487      * @return string pagename.
1488      */
1489     function getPageName() {
1490         return $this->_pagename;
1491     }
1492     function getName() {
1493         return $this->_pagename;
1494     }
1495
1496     /**
1497      * Determine whether revision is the latest.
1498      *
1499      * @access public
1500      *
1501      * @return boolean True iff the revision is the latest (most recent) one.
1502      */
1503     function isCurrent() {
1504         if (!isset($this->_iscurrent)) {
1505             $page = $this->getPage();
1506             $current = $page->getCurrentRevision(false);
1507             $this->_iscurrent = $this->getVersion() == $current->getVersion();
1508         }
1509         return $this->_iscurrent;
1510     }
1511
1512     /**
1513      * Get the transformed content of a page.
1514      *
1515      * @param string $pagetype  Override the page-type of the revision.
1516      *
1517      * @return object An XmlContent-like object containing the page transformed
1518      * contents.
1519      */
1520     function getTransformedContent($pagetype_override=false) {
1521         $backend = &$this->_wikidb->_backend;
1522
1523         if ($pagetype_override) {
1524             // Figure out the normal page-type for this page.
1525             $type = PageType::GetPageType($this->get('pagetype'));
1526             if ($type->getName() == $pagetype_override)
1527                 $pagetype_override = false; // Not really an override...
1528         }
1529
1530         if ($pagetype_override) {
1531             // Overriden page type, don't cache (or check cache).
1532             return new TransformedText($this->getPage(),
1533                                        $this->getPackedContent(),
1534                                        $this->getMetaData(),
1535                                        $pagetype_override);
1536         }
1537
1538         $possibly_cache_results = true;
1539
1540         if (!USECACHE or WIKIDB_NOCACHE_MARKUP) {
1541             if (WIKIDB_NOCACHE_MARKUP == 'purge') {
1542                 // flush cache for this page.
1543                 $page = $this->getPage();
1544                 $page->set('_cached_html', '');
1545             }
1546             $possibly_cache_results = false;
1547         }
1548         elseif (!$this->_transformedContent) {
1549             //$backend->lock();
1550             if ($this->isCurrent()) {
1551                 $page = $this->getPage();
1552                 $this->_transformedContent = TransformedText::unpack($page->get('_cached_html'));
1553             }
1554             else {
1555                 $possibly_cache_results = false;
1556             }
1557             //$backend->unlock();
1558         }
1559
1560         if (!$this->_transformedContent) {
1561             $this->_transformedContent
1562                 = new TransformedText($this->getPage(),
1563                                       $this->getPackedContent(),
1564                                       $this->getMetaData());
1565
1566             if ($possibly_cache_results) {
1567                 // If we're still the current version, cache the transfomed page.
1568                 //$backend->lock();
1569                 if ($this->isCurrent()) {
1570                     $page->set('_cached_html', $this->_transformedContent->pack());
1571                 }
1572                 //$backend->unlock();
1573             }
1574         }
1575
1576         return $this->_transformedContent;
1577     }
1578
1579     /**
1580      * Get the content as a string.
1581      *
1582      * @access public
1583      *
1584      * @return string The page content.
1585      * Lines are separated by new-lines.
1586      */
1587     function getPackedContent() {
1588         $data = &$this->_data;
1589
1590
1591         if (empty($data['%content'])) {
1592             include_once('lib/InlineParser.php');
1593
1594             // A feature similar to taglines at http://www.wlug.org.nz/
1595             // Lib from http://www.aasted.org/quote/
1596             if (defined('FORTUNE_DIR')
1597                 and is_dir(FORTUNE_DIR)
1598                 and in_array($GLOBALS['request']->getArg('action'),
1599                              array('create','edit')))
1600             {
1601                 include_once("lib/fortune.php");
1602                 $fortune = new Fortune();
1603                 $quote = str_replace("\n<br>","\n", $fortune->quoteFromDir(FORTUNE_DIR));
1604                 return sprintf("<verbatim>\n%s</verbatim>\n\n"._("Describe %s here."),
1605                                $quote, "[" . WikiEscape($this->_pagename) . "]");
1606             }
1607             // Replace empty content with default value.
1608             return sprintf(_("Describe %s here."),
1609                            "[" . WikiEscape($this->_pagename) . "]");
1610         }
1611
1612         // There is (non-default) content.
1613         assert($this->_version > 0);
1614
1615         if (!is_string($data['%content'])) {
1616             // Content was not provided to us at init time.
1617             // (This is allowed because for some backends, fetching
1618             // the content may be expensive, and often is not wanted
1619             // by the user.)
1620             //
1621             // In any case, now we need to get it.
1622             $data['%content'] = $this->_get_content();
1623             assert(is_string($data['%content']));
1624         }
1625
1626         return $data['%content'];
1627     }
1628
1629     function _get_content() {
1630         $cache = &$this->_wikidb->_cache;
1631         $pagename = $this->_pagename;
1632         $version = $this->_version;
1633
1634         assert($version > 0);
1635
1636         $newdata = $cache->get_versiondata($pagename, $version, true);
1637         if ($newdata) {
1638             assert(is_string($newdata['%content']));
1639             return $newdata['%content'];
1640         }
1641         else {
1642             // else revision has been deleted... What to do?
1643             return __sprintf("Oops! Revision %s of %s seems to have been deleted!",
1644                              $version, $pagename);
1645         }
1646     }
1647
1648     /**
1649      * Get meta-data for this revision.
1650      *
1651      *
1652      * @access public
1653      *
1654      * @param string $key Which meta-data to access.
1655      *
1656      * Some reserved revision meta-data keys are:
1657      * <dl>
1658      * <dt> 'mtime' <dd> Time this revision was created (seconds since midnight Jan 1, 1970.)
1659      *        The 'mtime' meta-value is normally set automatically by the database
1660      *        backend, but it may be specified explicitly when creating a new revision.
1661      * <dt> orig_mtime
1662      *  <dd> To ensure consistency of RecentChanges, the mtimes of the versions
1663      *       of a page must be monotonically increasing.  If an attempt is
1664      *       made to create a new revision with an mtime less than that of
1665      *       the preceeding revision, the new revisions timestamp is force
1666      *       to be equal to that of the preceeding revision.  In that case,
1667      *       the originally requested mtime is preserved in 'orig_mtime'.
1668      * <dt> '_supplanted' <dd> Time this revision ceased to be the most recent.
1669      *        This meta-value is <em>always</em> automatically maintained by the database
1670      *        backend.  (It is set from the 'mtime' meta-value of the superceding
1671      *        revision.)  '_supplanted' has a value of 'false' for the current revision.
1672      *
1673      * FIXME: this could be refactored:
1674      * <dt> author
1675      *  <dd> Author of the page (as he should be reported in, e.g. RecentChanges.)
1676      * <dt> author_id
1677      *  <dd> Authenticated author of a page.  This is used to identify
1678      *       the distinctness of authors when cleaning old revisions from
1679      *       the database.
1680      * <dt> 'is_minor_edit' <dd> Set if change was marked as a minor revision by the author.
1681      * <dt> 'summary' <dd> Short change summary entered by page author.
1682      * </dl>
1683      *
1684      * Meta-data keys must be valid C identifers (they have to start with a letter
1685      * or underscore, and can contain only alphanumerics and underscores.)
1686      *
1687      * @return string The requested value, or false if the requested value
1688      * is not defined.
1689      */
1690     function get($key) {
1691         if (!$key || $key[0] == '%')
1692             return false;
1693         $data = &$this->_data;
1694         return isset($data[$key]) ? $data[$key] : false;
1695     }
1696
1697     /**
1698      * Get all the revision page meta-data as a hash.
1699      *
1700      * @return hash The revision meta-data.
1701      */
1702     function getMetaData() {
1703         $meta = array();
1704         foreach ($this->_data as $key => $val) {
1705             if (!empty($val) && $key[0] != '%')
1706                 $meta[$key] = $val;
1707         }
1708         return $meta;
1709     }
1710
1711
1712     /**
1713      * Return a string representation of the revision.
1714      *
1715      * This is really only for debugging.
1716      *
1717      * @access public
1718      *
1719      * @return string Printable representation of the WikiDB_Page.
1720      */
1721     function asString () {
1722         ob_start();
1723         printf("[%s:%d\n", get_class($this), $this->get('version'));
1724         print_r($this->_data);
1725         echo $this->getPackedContent() . "\n]\n";
1726         $strval = ob_get_contents();
1727         ob_end_clean();
1728         return $strval;
1729     }
1730 };
1731
1732
1733 /**
1734  * Class representing a sequence of WikiDB_Pages.
1735  * TODO: Enhance to php5 iterators
1736  */
1737 class WikiDB_PageIterator
1738 {
1739     function WikiDB_PageIterator(&$wikidb, &$iter, $options=false) {
1740         $this->_iter = $iter; // a WikiDB_backend_iterator
1741         $this->_wikidb = &$wikidb;
1742         $this->_options = $options;
1743     }
1744
1745     function count () {
1746         return $this->_iter->count();
1747     }
1748
1749     /**
1750      * Get next WikiDB_Page in sequence.
1751      *
1752      * @access public
1753      *
1754      * @return WikiDB_Page The next WikiDB_Page in the sequence.
1755      */
1756     function next () {
1757         if ( ! ($next = $this->_iter->next()) )
1758             return false;
1759
1760         $pagename = &$next['pagename'];
1761         if (!$pagename) {
1762             trigger_error('empty pagename in WikiDB_PageIterator::next()', E_USER_WARNING);
1763             var_dump($next);
1764             return false;
1765         }
1766         // there's always hits, but we cache only if more
1767         // (well not with file, cvs and dba)
1768         if (isset($next['pagedata']) and count($next['pagedata']) > 1) {
1769             $this->_wikidb->_cache->cache_data($next);
1770         // cache existing page id's since we iterate over all links in GleanDescription
1771         // and need them later for LinkExistingWord
1772         } elseif ($this->_options and array_key_exists('include_empty', $this->_options)
1773                   and !$this->_options['include_empty'] and isset($next['id'])) {
1774             $this->_wikidb->_cache->_id_cache[$next['pagename']] = $next['id'];
1775         }
1776         return new WikiDB_Page($this->_wikidb, $pagename);
1777     }
1778
1779     /**
1780      * Release resources held by this iterator.
1781      *
1782      * The iterator may not be used after free() is called.
1783      *
1784      * There is no need to call free(), if next() has returned false.
1785      * (I.e. if you iterate through all the pages in the sequence,
1786      * you do not need to call free() --- you only need to call it
1787      * if you stop before the end of the iterator is reached.)
1788      *
1789      * @access public
1790      */
1791     function free() {
1792         $this->_iter->free();
1793     }
1794
1795     function asArray() {
1796         $result = array();
1797         while ($page = $this->next())
1798             $result[] = $page;
1799         //$this->reset();
1800         return $result;
1801     }
1802
1803
1804 };
1805
1806 /**
1807  * A class which represents a sequence of WikiDB_PageRevisions.
1808  * TODO: Enhance to php5 iterators
1809  */
1810 class WikiDB_PageRevisionIterator
1811 {
1812     function WikiDB_PageRevisionIterator(&$wikidb, &$revisions, $options=false) {
1813         $this->_revisions = $revisions;
1814         $this->_wikidb = &$wikidb;
1815         $this->_options = $options;
1816     }
1817
1818     function count () {
1819         return $this->_revisions->count();
1820     }
1821
1822     /**
1823      * Get next WikiDB_PageRevision in sequence.
1824      *
1825      * @access public
1826      *
1827      * @return WikiDB_PageRevision
1828      * The next WikiDB_PageRevision in the sequence.
1829      */
1830     function next () {
1831         if ( ! ($next = $this->_revisions->next()) )
1832             return false;
1833
1834         //$this->_wikidb->_cache->cache_data($next);
1835
1836         $pagename = $next['pagename'];
1837         $version = $next['version'];
1838         $versiondata = $next['versiondata'];
1839         if (DEBUG) {
1840             if (!(is_string($pagename) and $pagename != '')) {
1841                 trigger_error("empty pagename",E_USER_WARNING);
1842                 return false;
1843             }
1844         } else assert(is_string($pagename) and $pagename != '');
1845         if (DEBUG) {
1846             if (!is_array($versiondata)) {
1847                 trigger_error("empty versiondata",E_USER_WARNING);
1848                 return false;
1849             }
1850         } else assert(is_array($versiondata));
1851         if (DEBUG) {
1852             if (!($version > 0)) {
1853                 trigger_error("invalid version",E_USER_WARNING);
1854                 return false;
1855             }
1856         } else assert($version > 0);
1857
1858         return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1859                                        $versiondata);
1860     }
1861
1862     /**
1863      * Release resources held by this iterator.
1864      *
1865      * The iterator may not be used after free() is called.
1866      *
1867      * There is no need to call free(), if next() has returned false.
1868      * (I.e. if you iterate through all the revisions in the sequence,
1869      * you do not need to call free() --- you only need to call it
1870      * if you stop before the end of the iterator is reached.)
1871      *
1872      * @access public
1873      */
1874     function free() {
1875         $this->_revisions->free();
1876     }
1877
1878     function asArray() {
1879         $result = array();
1880         while ($rev = $this->next())
1881             $result[] = $rev;
1882         $this->free();
1883         return $result;
1884     }
1885 };
1886
1887 /** pseudo iterator
1888  */
1889 class WikiDB_Array_PageIterator
1890 {
1891     function WikiDB_Array_PageIterator(&$pagenames) {
1892         global $request;
1893         $this->_dbi = $request->getDbh();
1894         $this->_pages = $pagenames;
1895         reset($this->_pages);
1896     }
1897     function next() {
1898         $c =& current($this->_pages);
1899         next($this->_pages);
1900         return $c !== false ? $this->_dbi->getPage($c) : false;
1901     }
1902     function count() {
1903         return count($this->_pages);
1904     }
1905     function free() {}
1906     function asArray() {
1907         reset($this->_pages);
1908         return $this->_pages;
1909     }
1910 }
1911
1912 class WikiDB_Array_generic_iter
1913 {
1914     function WikiDB_Array_generic_iter($result) {
1915         // $result may be either an array or a query result
1916         if (is_array($result)) {
1917             $this->_array = $result;
1918         } elseif (is_object($result)) {
1919             $this->_array = $result->asArray();
1920         } else {
1921             $this->_array = array();
1922         }
1923         if (!empty($this->_array))
1924             reset($this->_array);
1925     }
1926     function next() {
1927         $c =& current($this->_array);
1928         next($this->_array);
1929         return $c !== false ? $c : false;
1930     }
1931     function count() {
1932         return count($this->_array);
1933     }
1934     function free() {}
1935     function asArray() {
1936         if (!empty($this->_array))
1937             reset($this->_array);
1938         return $this->_array;
1939     }
1940 }
1941
1942 /**
1943  * Data cache used by WikiDB.
1944  *
1945  * FIXME: Maybe rename this to caching_backend (or some such).
1946  *
1947  * @access private
1948  */
1949 class WikiDB_cache
1950 {
1951     // FIXME: beautify versiondata cache.  Cache only limited data?
1952
1953     function WikiDB_cache (&$backend) {
1954         $this->_backend = &$backend;
1955
1956         $this->_pagedata_cache = array();
1957         $this->_versiondata_cache = array();
1958         array_push ($this->_versiondata_cache, array());
1959         $this->_glv_cache = array();
1960         $this->_id_cache = array(); // formerly ->_dbi->_iwpcache (nonempty pages => id)
1961     }
1962
1963     function close() {
1964         $this->_pagedata_cache = array();
1965         $this->_versiondata_cache = array();
1966         $this->_glv_cache = array();
1967         $this->_id_cache = array();
1968     }
1969
1970     function get_pagedata($pagename) {
1971         assert(is_string($pagename) && $pagename != '');
1972         if (USECACHE) {
1973             $cache = &$this->_pagedata_cache;
1974             if (!isset($cache[$pagename]) || !is_array($cache[$pagename])) {
1975                 $cache[$pagename] = $this->_backend->get_pagedata($pagename);
1976                 if (empty($cache[$pagename]))
1977                     $cache[$pagename] = array();
1978             }
1979             return $cache[$pagename];
1980         } else {
1981             return $this->_backend->get_pagedata($pagename);
1982         }
1983     }
1984
1985     function update_pagedata($pagename, $newdata) {
1986         assert(is_string($pagename) && $pagename != '');
1987
1988         $this->_backend->update_pagedata($pagename, $newdata);
1989
1990         if (USECACHE) {
1991             if (!empty($this->_pagedata_cache[$pagename])
1992                 and is_array($this->_pagedata_cache[$pagename]))
1993             {
1994                 $cachedata = &$this->_pagedata_cache[$pagename];
1995                 foreach($newdata as $key => $val)
1996                     $cachedata[$key] = $val;
1997             } else
1998                 $this->_pagedata_cache[$pagename] = $newdata;
1999         }
2000     }
2001
2002     function invalidate_cache($pagename) {
2003         unset ($this->_pagedata_cache[$pagename]);
2004         unset ($this->_versiondata_cache[$pagename]);
2005         unset ($this->_glv_cache[$pagename]);
2006         unset ($this->_id_cache[$pagename]);
2007         //unset ($this->_backend->_page_data);
2008     }
2009
2010     function delete_page($pagename) {
2011         $result = $this->_backend->delete_page($pagename);
2012         $this->invalidate_cache($pagename);
2013         return $result;
2014     }
2015
2016     function purge_page($pagename) {
2017         $result = $this->_backend->purge_page($pagename);
2018         $this->invalidate_cache($pagename);
2019         return $result;
2020     }
2021
2022     // FIXME: ugly and wrong. may overwrite full cache with partial cache
2023     function cache_data($data) {
2024         ;
2025         //if (isset($data['pagedata']))
2026         //    $this->_pagedata_cache[$data['pagename']] = $data['pagedata'];
2027     }
2028
2029     function get_versiondata($pagename, $version, $need_content = false) {
2030         //  FIXME: Seriously ugly hackage
2031         $readdata = false;
2032         if (USECACHE) {   //temporary - for debugging
2033             assert(is_string($pagename) && $pagename != '');
2034             // There is a bug here somewhere which results in an assertion failure at line 105
2035             // of ArchiveCleaner.php  It goes away if we use the next line.
2036             //$need_content = true;
2037             $nc = $need_content ? '1':'0';
2038             $cache = &$this->_versiondata_cache;
2039             if (!isset($cache[$pagename][$version][$nc])
2040                 || !(is_array ($cache[$pagename]))
2041                 || !(is_array ($cache[$pagename][$version])))
2042             {
2043                 $cache[$pagename][$version][$nc] =
2044                     $this->_backend->get_versiondata($pagename, $version, $need_content);
2045                 $readdata = true;
2046                 // If we have retrieved all data, we may as well set the cache for
2047                 // $need_content = false
2048                 if ($need_content){
2049                     $cache[$pagename][$version]['0'] =& $cache[$pagename][$version]['1'];
2050                 }
2051             }
2052             $vdata = $cache[$pagename][$version][$nc];
2053         } else {
2054             $vdata = $this->_backend->get_versiondata($pagename, $version, $need_content);
2055             $readdata = true;
2056         }
2057         if ($readdata && $vdata && !empty($vdata['%pagedata'])) {
2058             $this->_pagedata_cache[$pagename] =& $vdata['%pagedata'];
2059         }
2060         return $vdata;
2061     }
2062
2063     function set_versiondata($pagename, $version, $data) {
2064         //unset($this->_versiondata_cache[$pagename][$version]);
2065
2066         $new = $this->_backend->set_versiondata($pagename, $version, $data);
2067         // Update the cache
2068         $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2069         $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2070         // Is this necessary?
2071         unset($this->_glv_cache[$pagename]);
2072     }
2073
2074     function update_versiondata($pagename, $version, $data) {
2075         $new = $this->_backend->update_versiondata($pagename, $version, $data);
2076         // Update the cache
2077         $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2078         // FIXME: hack
2079         $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2080         // Is this necessary?
2081         unset($this->_glv_cache[$pagename]);
2082     }
2083
2084     function delete_versiondata($pagename, $version) {
2085         $new = $this->_backend->delete_versiondata($pagename, $version);
2086         if (isset($this->_versiondata_cache[$pagename][$version]['1']))
2087             unset ($this->_versiondata_cache[$pagename][$version]['1']);
2088         if (isset($this->_versiondata_cache[$pagename][$version]['0']))
2089             unset ($this->_versiondata_cache[$pagename][$version]['0']);
2090         if (isset($this->_glv_cache[$pagename]))
2091             unset ($this->_glv_cache[$pagename]);
2092     }
2093
2094     function get_latest_version($pagename)  {
2095         if (USECACHE) {
2096             assert (is_string($pagename) && $pagename != '');
2097             $cache = &$this->_glv_cache;
2098             if (!isset($cache[$pagename])) {
2099                 $cache[$pagename] = $this->_backend->get_latest_version($pagename);
2100                 if (empty($cache[$pagename]))
2101                     $cache[$pagename] = 0;
2102             }
2103             return $cache[$pagename];
2104         } else {
2105             return $this->_backend->get_latest_version($pagename);
2106         }
2107     }
2108 };
2109
2110 function _sql_debuglog($msg, $newline=true, $shutdown=false) {
2111     static $fp = false;
2112     static $i = 0;
2113     if (!$fp) {
2114         $stamp = strftime("%y%m%d-%H%M%S");
2115         $fp = fopen("/tmp/sql-$stamp.log", "a");
2116         register_shutdown_function("_sql_debuglog_shutdown_function");
2117     } elseif ($shutdown) {
2118         fclose($fp);
2119         return;
2120     }
2121     if ($newline) fputs($fp, "[$i++] $msg");
2122     else fwrite($fp, $msg);
2123 }
2124
2125 function _sql_debuglog_shutdown_function() {
2126     _sql_debuglog('',false,true);
2127 }
2128
2129 // $Log: not supported by cvs2svn $
2130 // Revision 1.127  2005/02/18 20:43:40  uckelman
2131 // WikiDB::genericWarnings() is no longer used.
2132 //
2133 // Revision 1.126  2005/02/04 17:58:06  rurban
2134 // minor versioncache improvement. part 2/3 of Charles Corrigan cache patch. not sure about the 0/1 issue
2135 //
2136 // Revision 1.125  2005/02/03 05:08:39  rurban
2137 // ref fix by Charles Corrigan
2138 //
2139 // Revision 1.124  2005/01/29 20:43:32  rurban
2140 // protect against empty request: on some occasion this happens
2141 //
2142 // Revision 1.123  2005/01/25 06:58:21  rurban
2143 // reformatting
2144 //
2145 // Revision 1.122  2005/01/20 10:18:17  rurban
2146 // reformatting
2147 //
2148 // Revision 1.121  2005/01/04 20:25:01  rurban
2149 // remove old [%pagedata][_cached_html] code
2150 //
2151 // Revision 1.120  2004/12/23 14:12:31  rurban
2152 // dont email on unittest
2153 //
2154 // Revision 1.119  2004/12/20 16:05:00  rurban
2155 // gettext msg unification
2156 //
2157 // Revision 1.118  2004/12/13 13:22:57  rurban
2158 // new BlogArchives plugin for the new blog theme. enable default box method
2159 // for all plugins. Minor search improvement.
2160 //
2161 // Revision 1.117  2004/12/13 08:15:09  rurban
2162 // false is wrong. null might be better but lets play safe.
2163 //
2164 // Revision 1.116  2004/12/10 22:15:00  rurban
2165 // fix $page->get('_cached_html)
2166 // refactor upgrade db helper _convert_cached_html() to be able to call them from WikiAdminUtils also.
2167 // support 2nd genericSqlQuery param (bind huge arg)
2168 //
2169 // Revision 1.115  2004/12/10 02:45:27  rurban
2170 // SQL optimization:
2171 //   put _cached_html from pagedata into a new seperate blob, not huge serialized string.
2172 //   it is only rarelely needed: for current page only, if-not-modified
2173 //   but was extracted for every simple page iteration.
2174 //
2175 // Revision 1.114  2004/12/09 22:24:44  rurban
2176 // optimize on _DEBUG_SQL only. but now again on every 50th request, not just save.
2177 //
2178 // Revision 1.113  2004/12/06 19:49:55  rurban
2179 // enable action=remove which is undoable and seeable in RecentChanges: ADODB ony for now.
2180 // renamed delete_page to purge_page.
2181 // enable action=edit&version=-1 to force creation of a new version.
2182 // added BABYCART_PATH config
2183 // fixed magiqc in adodb.inc.php
2184 // and some more docs
2185 //
2186 // Revision 1.112  2004/11/30 17:45:53  rurban
2187 // exists_links backend implementation
2188 //
2189 // Revision 1.111  2004/11/28 20:39:43  rurban
2190 // deactivate pagecache overwrite: it is wrong
2191 //
2192 // Revision 1.110  2004/11/26 18:39:01  rurban
2193 // new regex search parser and SQL backends (90% complete, glob and pcre backends missing)
2194 //
2195 // Revision 1.109  2004/11/25 17:20:50  rurban
2196 // and again a couple of more native db args: backlinks
2197 //
2198 // Revision 1.108  2004/11/23 13:35:31  rurban
2199 // add case_exact search
2200 //
2201 // Revision 1.107  2004/11/21 11:59:16  rurban
2202 // remove final \n to be ob_cache independent
2203 //
2204 // Revision 1.106  2004/11/20 17:35:56  rurban
2205 // improved WantedPages SQL backends
2206 // PageList::sortby new 3rd arg valid_fields (override db fields)
2207 // WantedPages sql pager inexact for performance reasons:
2208 //   assume 3 wantedfrom per page, to be correct, no getTotal()
2209 // support exclude argument for get_all_pages, new _sql_set()
2210 //
2211 // Revision 1.105  2004/11/20 09:16:27  rurban
2212 // Fix bad-style Cut&Paste programming errors, detected by Charles Corrigan.
2213 //
2214 // Revision 1.104  2004/11/19 19:22:03  rurban
2215 // ModeratePage part1: change status
2216 //
2217 // Revision 1.103  2004/11/16 17:29:04  rurban
2218 // fix remove notification error
2219 // fix creation + update id_cache update
2220 //
2221 // Revision 1.102  2004/11/11 18:31:26  rurban
2222 // add simple backtrace on such general failures to get at least an idea where
2223 //
2224 // Revision 1.101  2004/11/10 19:32:22  rurban
2225 // * optimize increaseHitCount, esp. for mysql.
2226 // * prepend dirs to the include_path (phpwiki_dir for faster searches)
2227 // * Pear_DB version logic (awful but needed)
2228 // * fix broken ADODB quote
2229 // * _extract_page_data simplification
2230 //
2231 // Revision 1.100  2004/11/10 15:29:20  rurban
2232 // * requires newer Pear_DB (as the internal one): quote() uses now escapeSimple for strings
2233 // * ACCESS_LOG_SQL: fix cause request not yet initialized
2234 // * WikiDB: moved SQL specific methods upwards
2235 // * new Pear_DB quoting: same as ADODB and as newer Pear_DB.
2236 //   fixes all around: WikiGroup, WikiUserNew SQL methods, SQL logging
2237 //
2238 // Revision 1.99  2004/11/09 17:11:05  rurban
2239 // * revert to the wikidb ref passing. there's no memory abuse there.
2240 // * use new wikidb->_cache->_id_cache[] instead of wikidb->_iwpcache, to effectively
2241 //   store page ids with getPageLinks (GleanDescription) of all existing pages, which
2242 //   are also needed at the rendering for linkExistingWikiWord().
2243 //   pass options to pageiterator.
2244 //   use this cache also for _get_pageid()
2245 //   This saves about 8 SELECT count per page (num all pagelinks).
2246 // * fix passing of all page fields to the pageiterator.
2247 // * fix overlarge session data which got broken with the latest ACCESS_LOG_SQL changes
2248 //
2249 // Revision 1.98  2004/11/07 18:34:29  rurban
2250 // more logging fixes
2251 //
2252 // Revision 1.97  2004/11/07 16:02:51  rurban
2253 // new sql access log (for spam prevention), and restructured access log class
2254 // dbh->quote (generic)
2255 // pear_db: mysql specific parts seperated (using replace)
2256 //
2257 // Revision 1.96  2004/11/05 22:32:15  rurban
2258 // encode the subject to be 7-bit safe
2259 //
2260 // Revision 1.95  2004/11/05 20:53:35  rurban
2261 // login cleanup: better debug msg on failing login,
2262 // checked password less immediate login (bogo or anon),
2263 // checked olduser pref session error,
2264 // better PersonalPage without password warning on minimal password length=0
2265 //   (which is default now)
2266 //
2267 // Revision 1.94  2004/11/01 10:43:56  rurban
2268 // seperate PassUser methods into seperate dir (memory usage)
2269 // fix WikiUser (old) overlarge data session
2270 // remove wikidb arg from various page class methods, use global ->_dbi instead
2271 // ...
2272 //
2273 // Revision 1.93  2004/10/14 17:17:57  rurban
2274 // remove dbi WikiDB_Page param: use global request object instead. (memory)
2275 // allow most_popular sortby arguments
2276 //
2277 // Revision 1.92  2004/10/05 17:00:04  rurban
2278 // support paging for simple lists
2279 // fix RatingDb sql backend.
2280 // remove pages from AllPages (this is ListPages then)
2281 //
2282 // Revision 1.91  2004/10/04 23:41:19  rurban
2283 // delete notify: fix, @unset syntax error
2284 //
2285 // Revision 1.90  2004/09/28 12:50:22  rurban
2286 // https://sourceforge.net/forum/forum.php?thread_id=1150924&forum_id=18929
2287 //
2288 // Revision 1.89  2004/09/26 10:54:42  rurban
2289 // silence deferred check
2290 //
2291 // Revision 1.88  2004/09/25 18:16:40  rurban
2292 // unset more unneeded _cached_html. (Guess this should fix sf.net now)
2293 //
2294 // Revision 1.87  2004/09/25 16:25:40  rurban
2295 // notify on rename and remove (to be improved)
2296 //
2297 // Revision 1.86  2004/09/23 18:52:06  rurban
2298 // only fortune at create
2299 //
2300 // Revision 1.85  2004/09/16 08:00:51  rurban
2301 // just some comments
2302 //
2303 // Revision 1.84  2004/09/14 10:34:30  rurban
2304 // fix TransformedText call to use refs
2305 //
2306 // Revision 1.83  2004/09/08 13:38:00  rurban
2307 // improve loadfile stability by using markup=2 as default for undefined markup-style.
2308 // use more refs for huge objects.
2309 // fix debug=static issue in WikiPluginCached
2310 //
2311 // Revision 1.82  2004/09/06 12:08:49  rurban
2312 // memory_limit on unix workaround
2313 // VisualWiki: default autosize image
2314 //
2315 // Revision 1.81  2004/09/06 08:28:00  rurban
2316 // rename genericQuery to genericSqlQuery
2317 //
2318 // Revision 1.80  2004/07/09 13:05:34  rurban
2319 // just aesthetics
2320 //
2321 // Revision 1.79  2004/07/09 10:06:49  rurban
2322 // Use backend specific sortby and sortable_columns method, to be able to
2323 // select between native (Db backend) and custom (PageList) sorting.
2324 // Fixed PageList::AddPageList (missed the first)
2325 // Added the author/creator.. name to AllPagesBy...
2326 //   display no pages if none matched.
2327 // Improved dba and file sortby().
2328 // Use &$request reference
2329 //
2330 // Revision 1.78  2004/07/08 21:32:35  rurban
2331 // Prevent from more warnings, minor db and sort optimizations
2332 //
2333 // Revision 1.77  2004/07/08 19:04:42  rurban
2334 // more unittest fixes (file backend, metadata RatingsDb)
2335 //
2336 // Revision 1.76  2004/07/08 17:31:43  rurban
2337 // improve numPages for file (fixing AllPagesTest)
2338 //
2339 // Revision 1.75  2004/07/05 13:56:22  rurban
2340 // sqlite autoincrement fix
2341 //
2342 // Revision 1.74  2004/07/03 16:51:05  rurban
2343 // optional DBADMIN_USER:DBADMIN_PASSWD for action=upgrade (if no ALTER permission)
2344 // added atomic mysql REPLACE for PearDB as in ADODB
2345 // fixed _lock_tables typo links => link
2346 // fixes unserialize ADODB bug in line 180
2347 //
2348 // Revision 1.73  2004/06/29 08:52:22  rurban
2349 // Use ...version() $need_content argument in WikiDB also:
2350 // To reduce the memory footprint for larger sets of pagelists,
2351 // we don't cache the content (only true or false) and
2352 // we purge the pagedata (_cached_html) also.
2353 // _cached_html is only cached for the current pagename.
2354 // => Vastly improved page existance check, ACL check, ...
2355 //
2356 // Now only PagedList info=content or size needs the whole content, esp. if sortable.
2357 //
2358 // Revision 1.72  2004/06/25 14:15:08  rurban
2359 // reduce memory footprint by caching only requested pagedate content (improving most page iterators)
2360 //
2361 // Revision 1.71  2004/06/21 16:22:30  rurban
2362 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
2363 // fixed dumping buttons locally (images/buttons/),
2364 // support pages arg for dumphtml,
2365 // optional directory arg for dumpserial + dumphtml,
2366 // fix a AllPages warning,
2367 // show dump warnings/errors on DEBUG,
2368 // don't warn just ignore on wikilens pagelist columns, if not loaded.
2369 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
2370 //
2371 // Revision 1.70  2004/06/18 14:39:31  rurban
2372 // actually check USECACHE
2373 //
2374 // Revision 1.69  2004/06/13 15:33:20  rurban
2375 // new support for arguments owner, author, creator in most relevant
2376 // PageList plugins. in WikiAdmin* via preSelectS()
2377 //
2378 // Revision 1.68  2004/06/08 21:03:20  rurban
2379 // updated RssParser for XmlParser quirks (store parser object params in globals)
2380 //
2381 // Revision 1.67  2004/06/07 19:12:49  rurban
2382 // fixed rename version=0, bug #966284
2383 //
2384 // Revision 1.66  2004/06/07 18:57:27  rurban
2385 // fix rename: Change pagename in all linked pages
2386 //
2387 // Revision 1.65  2004/06/04 20:32:53  rurban
2388 // Several locale related improvements suggested by Pierrick Meignen
2389 // LDAP fix by John Cole
2390 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
2391 //
2392 // Revision 1.64  2004/06/04 16:50:00  rurban
2393 // add random quotes to empty pages
2394 //
2395 // Revision 1.63  2004/06/04 11:58:38  rurban
2396 // added USE_TAGLINES
2397 //
2398 // Revision 1.62  2004/06/03 22:24:41  rurban
2399 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
2400 //
2401 // Revision 1.61  2004/06/02 17:13:48  rurban
2402 // fix getRevisionBefore assertion
2403 //
2404 // Revision 1.60  2004/05/28 10:09:58  rurban
2405 // fix bug #962117, incorrect init of auth_dsn
2406 //
2407 // Revision 1.59  2004/05/27 17:49:05  rurban
2408 // renamed DB_Session to DbSession (in CVS also)
2409 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
2410 // remove leading slash in error message
2411 // added force_unlock parameter to File_Passwd (no return on stale locks)
2412 // fixed adodb session AffectedRows
2413 // added FileFinder helpers to unify local filenames and DATA_PATH names
2414 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
2415 //
2416 // Revision 1.58  2004/05/18 13:59:14  rurban
2417 // rename simpleQuery to genericQuery
2418 //
2419 // Revision 1.57  2004/05/16 22:07:35  rurban
2420 // check more config-default and predefined constants
2421 // various PagePerm fixes:
2422 //   fix default PagePerms, esp. edit and view for Bogo and Password users
2423 //   implemented Creator and Owner
2424 //   BOGOUSERS renamed to BOGOUSER
2425 // fixed syntax errors in signin.tmpl
2426 //
2427 // Revision 1.56  2004/05/15 22:54:49  rurban
2428 // fixed important WikiDB bug with DEBUG > 0: wrong assertion
2429 // improved SetAcl (works) and PagePerms, some WikiGroup helpers.
2430 //
2431 // Revision 1.55  2004/05/12 19:27:47  rurban
2432 // revert wrong inline optimization.
2433 //
2434 // Revision 1.54  2004/05/12 10:49:55  rurban
2435 // require_once fix for those libs which are loaded before FileFinder and
2436 //   its automatic include_path fix, and where require_once doesn't grok
2437 //   dirname(__FILE__) != './lib'
2438 // upgrade fix with PearDB
2439 // navbar.tmpl: remove spaces for IE &nbsp; button alignment
2440 //
2441 // Revision 1.53  2004/05/08 14:06:12  rurban
2442 // new support for inlined image attributes: [image.jpg size=50x30 align=right]
2443 // minor stability and portability fixes
2444 //
2445 // Revision 1.52  2004/05/06 19:26:16  rurban
2446 // improve stability, trying to find the InlineParser endless loop on sf.net
2447 //
2448 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
2449 //
2450 // Revision 1.51  2004/05/06 17:30:37  rurban
2451 // CategoryGroup: oops, dos2unix eol
2452 // improved phpwiki_version:
2453 //   pre -= .0001 (1.3.10pre: 1030.099)
2454 //   -p1 += .001 (1.3.9-p1: 1030.091)
2455 // improved InstallTable for mysql and generic SQL versions and all newer tables so far.
2456 // abstracted more ADODB/PearDB methods for action=upgrade stuff:
2457 //   backend->backendType(), backend->database(),
2458 //   backend->listOfFields(),
2459 //   backend->listOfTables(),
2460 //
2461 // Revision 1.50  2004/05/04 22:34:25  rurban
2462 // more pdf support
2463 //
2464 // Revision 1.49  2004/05/03 11:16:40  rurban
2465 // fixed sendPageChangeNotification
2466 // subject rewording
2467 //
2468 // Revision 1.48  2004/04/29 23:03:54  rurban
2469 // fixed sf.net bug #940996
2470 //
2471 // Revision 1.47  2004/04/29 19:39:44  rurban
2472 // special support for formatted plugins (one-liners)
2473 //   like <small><plugin BlaBla ></small>
2474 // iter->asArray() helper for PopularNearby
2475 // db_session for older php's (no &func() allowed)
2476 //
2477 // Revision 1.46  2004/04/26 20:44:34  rurban
2478 // locking table specific for better databases
2479 //
2480 // Revision 1.45  2004/04/20 00:06:03  rurban
2481 // themable paging support
2482 //
2483 // Revision 1.44  2004/04/19 18:27:45  rurban
2484 // Prevent from some PHP5 warnings (ref args, no :: object init)
2485 //   php5 runs now through, just one wrong XmlElement object init missing
2486 // Removed unneccesary UpgradeUser lines
2487 // Changed WikiLink to omit version if current (RecentChanges)
2488 //
2489 // Revision 1.43  2004/04/18 01:34:20  rurban
2490 // protect most_popular from sortby=mtime
2491 //
2492 // Revision 1.42  2004/04/18 01:11:51  rurban
2493 // more numeric pagename fixes.
2494 // fixed action=upload with merge conflict warnings.
2495 // charset changed from constant to global (dynamic utf-8 switching)
2496 //
2497
2498 // Local Variables:
2499 // mode: php
2500 // tab-width: 8
2501 // c-basic-offset: 4
2502 // c-hanging-comment-ender-p: nil
2503 // indent-tabs-mode: nil
2504 // End:
2505 ?>