lib/WikiDB.php

   1 <?php //-*-php-*-
   2 rcs_id('$Id: WikiDB.php,v 1.132 2005-08-07 10:10:07 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=false, $need_content=true) {
1142         $backend = &$this->_wikidb->_backend;
1143         $pagename = &$this->_pagename;
1144         if ($version === false)
1145             $version = $this->_wikidb->_cache->get_latest_version($pagename);
1146         else
1147             $version = $this->_coerce_to_version($version);
1148
1149         if ($version == 0)
1150             return false;
1151         //$backend->lock();
1152         $previous = $backend->get_previous_version($pagename, $version);
1153         $revision = $this->getRevision($previous, $need_content);
1154         //$backend->unlock();
1155         assert($revision);
1156         return $revision;
1157     }
1158
1159     /**
1160      * Get all revisions of the WikiDB_Page.
1161      *
1162      * This does not include the version zero (default) revision in the
1163      * returned revision set.
1164      *
1165      * @return WikiDB_PageRevisionIterator A
1166      *   WikiDB_PageRevisionIterator containing all revisions of this
1167      *   WikiDB_Page in reverse order by version number.
1168      */
1169     function getAllRevisions() {
1170         $backend = &$this->_wikidb->_backend;
1171         $revs = $backend->get_all_revisions($this->_pagename);
1172         return new WikiDB_PageRevisionIterator($this->_wikidb, $revs);
1173     }
1174
1175     /**
1176      * Find pages which link to or are linked from a page.
1177      *
1178      * @access public
1179      *
1180      * @param boolean $reversed Which links to find: true for backlinks (default).
1181      *
1182      * @return WikiDB_PageIterator A WikiDB_PageIterator containing
1183      * all matching pages.
1184      */
1185     function getLinks($reversed = true, $include_empty=false, $sortby=false,
1186                       $limit=false, $exclude=false) {
1187         $backend = &$this->_wikidb->_backend;
1188         $result =  $backend->get_links($this->_pagename, $reversed,
1189                                        $include_empty, $sortby, $limit, $exclude);
1190         return new WikiDB_PageIterator($this->_wikidb, $result,
1191                                        array('include_empty' => $include_empty,
1192                                              'sortby' => $sortby,
1193                                              'limit' => $limit,
1194                                              'exclude' => $exclude));
1195     }
1196
1197     /**
1198      * All Links from other pages to this page.
1199      */
1200     function getBackLinks($include_empty=false, $sortby=false, $limit=false, $exclude=false) {
1201         return $this->getLinks(true, $include_empty, $sortby, $limit, $exclude);
1202     }
1203     /**
1204      * Forward Links: All Links from this page to other pages.
1205      */
1206     function getPageLinks($include_empty=false, $sortby=false, $limit=false, $exclude=false) {
1207         return $this->getLinks(false, $include_empty, $sortby, $limit, $exclude);
1208     }
1209
1210     /**
1211      * possibly faster link existance check. not yet accelerated.
1212      */
1213     function existLink($link, $reversed=false) {
1214         $backend = &$this->_wikidb->_backend;
1215         if (method_exists($backend,'exists_link'))
1216             return $backend->exists_link($this->_pagename, $link, $reversed);
1217         //$cache = &$this->_wikidb->_cache;
1218         // TODO: check cache if it is possible
1219         $iter = $this->getLinks($reversed, false);
1220         while ($page = $iter->next()) {
1221             if ($page->getName() == $link)
1222                 return $page;
1223         }
1224         $iter->free();
1225         return false;
1226     }
1227
1228     /**
1229      * Access WikiDB_Page meta-data.
1230      *
1231      * @access public
1232      *
1233      * @param string $key Which meta data to get.
1234      * Some reserved meta-data keys are:
1235      * <dl>
1236      * <dt>'locked'<dd> Is page locked?
1237      * <dt>'hits'  <dd> Page hit counter.
1238      * <dt>'pref'  <dd> Users preferences, stored in homepages.
1239      * <dt>'owner' <dd> Default: first author_id. We might add a group with a dot here:
1240      *                  E.g. "owner.users"
1241      * <dt>'perm'  <dd> Permission flag to authorize read/write/execution of
1242      *                  page-headers and content.
1243      * <dt>'score' <dd> Page score (not yet implement, do we need?)
1244      * <dt>'_cached_html' <dd> Transformed CachedMarkup object, serialized + optionally gzipped.
1245      *                         In SQL stored in an extra column.
1246      * </dl>
1247      *
1248      * @return scalar The requested value, or false if the requested data
1249      * is not set.
1250      */
1251     function get($key) {
1252         $cache = &$this->_wikidb->_cache;
1253         $backend = &$this->_wikidb->_backend;
1254         if (!$key || $key[0] == '%')
1255             return false;
1256         // several new SQL backends optimize this.
1257         if (!WIKIDB_NOCACHE_MARKUP
1258             and $key == '_cached_html'
1259             and method_exists($backend, 'get_cached_html'))
1260         {
1261             return $backend->get_cached_html($this->_pagename);
1262         }
1263         $data = $cache->get_pagedata($this->_pagename);
1264         return isset($data[$key]) ? $data[$key] : false;
1265     }
1266
1267     /**
1268      * Get all the page meta-data as a hash.
1269      *
1270      * @return hash The page meta-data.
1271      */
1272     function getMetaData() {
1273         $cache = &$this->_wikidb->_cache;
1274         $data = $cache->get_pagedata($this->_pagename);
1275         $meta = array();
1276         foreach ($data as $key => $val) {
1277             if (/*!empty($val) &&*/ $key[0] != '%')
1278                 $meta[$key] = $val;
1279         }
1280         return $meta;
1281     }
1282
1283     /**
1284      * Set page meta-data.
1285      *
1286      * @see get
1287      * @access public
1288      *
1289      * @param string $key  Meta-data key to set.
1290      * @param string $newval  New value.
1291      */
1292     function set($key, $newval) {
1293         $cache = &$this->_wikidb->_cache;
1294         $backend = &$this->_wikidb->_backend;
1295         $pagename = &$this->_pagename;
1296
1297         assert($key && $key[0] != '%');
1298
1299         // several new SQL backends optimize this.
1300         if (!WIKIDB_NOCACHE_MARKUP
1301             and $key == '_cached_html'
1302             and method_exists($backend, 'set_cached_html'))
1303         {
1304             return $backend->set_cached_html($pagename, $newval);
1305         }
1306
1307         $data = $cache->get_pagedata($pagename);
1308
1309         if (!empty($newval)) {
1310             if (!empty($data[$key]) && $data[$key] == $newval)
1311                 return;         // values identical, skip update.
1312         }
1313         else {
1314             if (empty($data[$key]))
1315                 return;         // values identical, skip update.
1316         }
1317
1318         $cache->update_pagedata($pagename, array($key => $newval));
1319     }
1320
1321     /**
1322      * Increase page hit count.
1323      *
1324      * FIXME: IS this needed?  Probably not.
1325      *
1326      * This is a convenience function.
1327      * <pre> $page->increaseHitCount(); </pre>
1328      * is functionally identical to
1329      * <pre> $page->set('hits',$page->get('hits')+1); </pre>
1330      * but less expensive (ignores the pagadata string)
1331      *
1332      * Note that this method may be implemented in more efficient ways
1333      * in certain backends.
1334      *
1335      * @access public
1336      */
1337     function increaseHitCount() {
1338         if (method_exists($this->_wikidb->_backend, 'increaseHitCount'))
1339             $this->_wikidb->_backend->increaseHitCount($this->_pagename);
1340         else {
1341             @$newhits = $this->get('hits') + 1;
1342             $this->set('hits', $newhits);
1343         }
1344     }
1345
1346     /**
1347      * Return a string representation of the WikiDB_Page
1348      *
1349      * This is really only for debugging.
1350      *
1351      * @access public
1352      *
1353      * @return string Printable representation of the WikiDB_Page.
1354      */
1355     function asString () {
1356         ob_start();
1357         printf("[%s:%s\n", get_class($this), $this->getName());
1358         print_r($this->getMetaData());
1359         echo "]\n";
1360         $strval = ob_get_contents();
1361         ob_end_clean();
1362         return $strval;
1363     }
1364
1365
1366     /**
1367      * @access private
1368      * @param integer_or_object $version_or_pagerevision
1369      * Takes either the version number (and int) or a WikiDB_PageRevision
1370      * object.
1371      * @return integer The version number.
1372      */
1373     function _coerce_to_version($version_or_pagerevision) {
1374         if (method_exists($version_or_pagerevision, "getContent"))
1375             $version = $version_or_pagerevision->getVersion();
1376         else
1377             $version = (int) $version_or_pagerevision;
1378
1379         assert($version >= 0);
1380         return $version;
1381     }
1382
1383     function isUserPage ($include_empty = true) {
1384         if (!$include_empty and !$this->exists()) return false;
1385         return $this->get('pref') ? true : false;
1386     }
1387
1388     // May be empty. Either the stored owner (/Chown), or the first authorized author
1389     function getOwner() {
1390         if ($owner = $this->get('owner'))
1391             return ($owner == "The PhpWiki programming team") ? ADMIN_USER : $owner;
1392         // check all revisions forwards for the first author_id
1393         $backend = &$this->_wikidb->_backend;
1394         $pagename = &$this->_pagename;
1395         $latestversion = $backend->get_latest_version($pagename);
1396         for ($v=1; $v <= $latestversion; $v++) {
1397             $rev = $this->getRevision($v,false);
1398             if ($rev and $owner = $rev->get('author_id')) {
1399                 return ($owner == "The PhpWiki programming team") ? ADMIN_USER : $owner;
1400             }
1401         }
1402         return '';
1403     }
1404
1405     // The authenticated author of the first revision or empty if not authenticated then.
1406     function getCreator() {
1407         if ($current = $this->getRevision(1,false)) return $current->get('author_id');
1408         else return '';
1409     }
1410
1411     // The authenticated author of the current revision.
1412     function getAuthor() {
1413         if ($current = $this->getCurrentRevision(false)) return $current->get('author_id');
1414         else return '';
1415     }
1416
1417 };
1418
1419 /**
1420  * This class represents a specific revision of a WikiDB_Page within
1421  * a WikiDB.
1422  *
1423  * A WikiDB_PageRevision has read-only semantics. You may only create
1424  * new revisions (and delete old ones) --- you cannot modify existing
1425  * revisions.
1426  */
1427 class WikiDB_PageRevision
1428 {
1429     //var $_transformedContent = false; // set by WikiDB_Page::save()
1430
1431     function WikiDB_PageRevision(&$wikidb, $pagename, $version, $versiondata = false) {
1432         $this->_wikidb = &$wikidb;
1433         $this->_pagename = $pagename;
1434         $this->_version = $version;
1435         $this->_data = $versiondata ? $versiondata : array();
1436         $this->_transformedContent = false; // set by WikiDB_Page::save()
1437     }
1438
1439     /**
1440      * Get the WikiDB_Page which this revision belongs to.
1441      *
1442      * @access public
1443      *
1444      * @return WikiDB_Page The WikiDB_Page which this revision belongs to.
1445      */
1446     function getPage() {
1447         return new WikiDB_Page($this->_wikidb, $this->_pagename);
1448     }
1449
1450     /**
1451      * Get the version number of this revision.
1452      *
1453      * @access public
1454      *
1455      * @return integer The version number of this revision.
1456      */
1457     function getVersion() {
1458         return $this->_version;
1459     }
1460
1461     /**
1462      * Determine whether this revision has defaulted content.
1463      *
1464      * The default revision (version 0) of each page, as well as any
1465      * pages which are created with empty content have their content
1466      * defaulted to something like:
1467      * <pre>
1468      *   Describe [ThisPage] here.
1469      * </pre>
1470      *
1471      * @access public
1472      *
1473      * @return boolean Returns true if the page has default content.
1474      */
1475     function hasDefaultContents() {
1476         $data = &$this->_data;
1477         return empty($data['%content']); // FIXME: what if it's the number 0? <>'' or === false
1478     }
1479
1480     /**
1481      * Get the content as an array of lines.
1482      *
1483      * @access public
1484      *
1485      * @return array An array of lines.
1486      * The lines should contain no trailing white space.
1487      */
1488     function getContent() {
1489         return explode("\n", $this->getPackedContent());
1490     }
1491
1492    /**
1493      * Get the pagename of the revision.
1494      *
1495      * @access public
1496      *
1497      * @return string pagename.
1498      */
1499     function getPageName() {
1500         return $this->_pagename;
1501     }
1502     function getName() {
1503         return $this->_pagename;
1504     }
1505
1506     /**
1507      * Determine whether revision is the latest.
1508      *
1509      * @access public
1510      *
1511      * @return boolean True iff the revision is the latest (most recent) one.
1512      */
1513     function isCurrent() {
1514         if (!isset($this->_iscurrent)) {
1515             $page = $this->getPage();
1516             $current = $page->getCurrentRevision(false);
1517             $this->_iscurrent = $this->getVersion() == $current->getVersion();
1518         }
1519         return $this->_iscurrent;
1520     }
1521
1522     /**
1523      * Get the transformed content of a page.
1524      *
1525      * @param string $pagetype  Override the page-type of the revision.
1526      *
1527      * @return object An XmlContent-like object containing the page transformed
1528      * contents.
1529      */
1530     function getTransformedContent($pagetype_override=false) {
1531         $backend = &$this->_wikidb->_backend;
1532
1533         if ($pagetype_override) {
1534             // Figure out the normal page-type for this page.
1535             $type = PageType::GetPageType($this->get('pagetype'));
1536             if ($type->getName() == $pagetype_override)
1537                 $pagetype_override = false; // Not really an override...
1538         }
1539
1540         if ($pagetype_override) {
1541             // Overriden page type, don't cache (or check cache).
1542             return new TransformedText($this->getPage(),
1543                                        $this->getPackedContent(),
1544                                        $this->getMetaData(),
1545                                        $pagetype_override);
1546         }
1547
1548         $possibly_cache_results = true;
1549
1550         if (!USECACHE or WIKIDB_NOCACHE_MARKUP) {
1551             if (WIKIDB_NOCACHE_MARKUP == 'purge') {
1552                 // flush cache for this page.
1553                 $page = $this->getPage();
1554                 $page->set('_cached_html', ''); // ignored with !USECACHE
1555             }
1556             $possibly_cache_results = false;
1557         }
1558         elseif (USECACHE and !$this->_transformedContent) {
1559             //$backend->lock();
1560             if ($this->isCurrent()) {
1561                 $page = $this->getPage();
1562                 $this->_transformedContent = TransformedText::unpack($page->get('_cached_html'));
1563             }
1564             else {
1565                 $possibly_cache_results = false;
1566             }
1567             //$backend->unlock();
1568         }
1569
1570         if (!$this->_transformedContent) {
1571             $this->_transformedContent
1572                 = new TransformedText($this->getPage(),
1573                                       $this->getPackedContent(),
1574                                       $this->getMetaData());
1575
1576             if ($possibly_cache_results and !WIKIDB_NOCACHE_MARKUP) {
1577                 // If we're still the current version, cache the transfomed page.
1578                 //$backend->lock();
1579                 if ($this->isCurrent()) {
1580                     $page->set('_cached_html', $this->_transformedContent->pack());
1581                 }
1582                 //$backend->unlock();
1583             }
1584         }
1585
1586         return $this->_transformedContent;
1587     }
1588
1589     /**
1590      * Get the content as a string.
1591      *
1592      * @access public
1593      *
1594      * @return string The page content.
1595      * Lines are separated by new-lines.
1596      */
1597     function getPackedContent() {
1598         $data = &$this->_data;
1599
1600
1601         if (empty($data['%content'])) {
1602             include_once('lib/InlineParser.php');
1603
1604             // A feature similar to taglines at http://www.wlug.org.nz/
1605             // Lib from http://www.aasted.org/quote/
1606             if (defined('FORTUNE_DIR')
1607                 and is_dir(FORTUNE_DIR)
1608                 and in_array($GLOBALS['request']->getArg('action'),
1609                              array('create','edit')))
1610             {
1611                 include_once("lib/fortune.php");
1612                 $fortune = new Fortune();
1613                 $quote = str_replace("\n<br>","\n", $fortune->quoteFromDir(FORTUNE_DIR));
1614                 return sprintf("<verbatim>\n%s</verbatim>\n\n"._("Describe %s here."),
1615                                $quote, "[" . WikiEscape($this->_pagename) . "]");
1616             }
1617             // Replace empty content with default value.
1618             return sprintf(_("Describe %s here."),
1619                            "[" . WikiEscape($this->_pagename) . "]");
1620         }
1621
1622         // There is (non-default) content.
1623         assert($this->_version > 0);
1624
1625         if (!is_string($data['%content'])) {
1626             // Content was not provided to us at init time.
1627             // (This is allowed because for some backends, fetching
1628             // the content may be expensive, and often is not wanted
1629             // by the user.)
1630             //
1631             // In any case, now we need to get it.
1632             $data['%content'] = $this->_get_content();
1633             assert(is_string($data['%content']));
1634         }
1635
1636         return $data['%content'];
1637     }
1638
1639     function _get_content() {
1640         $cache = &$this->_wikidb->_cache;
1641         $pagename = $this->_pagename;
1642         $version = $this->_version;
1643
1644         assert($version > 0);
1645
1646         $newdata = $cache->get_versiondata($pagename, $version, true);
1647         if ($newdata) {
1648             assert(is_string($newdata['%content']));
1649             return $newdata['%content'];
1650         }
1651         else {
1652             // else revision has been deleted... What to do?
1653             return __sprintf("Oops! Revision %s of %s seems to have been deleted!",
1654                              $version, $pagename);
1655         }
1656     }
1657
1658     /**
1659      * Get meta-data for this revision.
1660      *
1661      *
1662      * @access public
1663      *
1664      * @param string $key Which meta-data to access.
1665      *
1666      * Some reserved revision meta-data keys are:
1667      * <dl>
1668      * <dt> 'mtime' <dd> Time this revision was created (seconds since midnight Jan 1, 1970.)
1669      *        The 'mtime' meta-value is normally set automatically by the database
1670      *        backend, but it may be specified explicitly when creating a new revision.
1671      * <dt> orig_mtime
1672      *  <dd> To ensure consistency of RecentChanges, the mtimes of the versions
1673      *       of a page must be monotonically increasing.  If an attempt is
1674      *       made to create a new revision with an mtime less than that of
1675      *       the preceeding revision, the new revisions timestamp is force
1676      *       to be equal to that of the preceeding revision.  In that case,
1677      *       the originally requested mtime is preserved in 'orig_mtime'.
1678      * <dt> '_supplanted' <dd> Time this revision ceased to be the most recent.
1679      *        This meta-value is <em>always</em> automatically maintained by the database
1680      *        backend.  (It is set from the 'mtime' meta-value of the superceding
1681      *        revision.)  '_supplanted' has a value of 'false' for the current revision.
1682      *
1683      * FIXME: this could be refactored:
1684      * <dt> author
1685      *  <dd> Author of the page (as he should be reported in, e.g. RecentChanges.)
1686      * <dt> author_id
1687      *  <dd> Authenticated author of a page.  This is used to identify
1688      *       the distinctness of authors when cleaning old revisions from
1689      *       the database.
1690      * <dt> 'is_minor_edit' <dd> Set if change was marked as a minor revision by the author.
1691      * <dt> 'summary' <dd> Short change summary entered by page author.
1692      * </dl>
1693      *
1694      * Meta-data keys must be valid C identifers (they have to start with a letter
1695      * or underscore, and can contain only alphanumerics and underscores.)
1696      *
1697      * @return string The requested value, or false if the requested value
1698      * is not defined.
1699      */
1700     function get($key) {
1701         if (!$key || $key[0] == '%')
1702             return false;
1703         $data = &$this->_data;
1704         return isset($data[$key]) ? $data[$key] : false;
1705     }
1706
1707     /**
1708      * Get all the revision page meta-data as a hash.
1709      *
1710      * @return hash The revision meta-data.
1711      */
1712     function getMetaData() {
1713         $meta = array();
1714         foreach ($this->_data as $key => $val) {
1715             if (!empty($val) && $key[0] != '%')
1716                 $meta[$key] = $val;
1717         }
1718         return $meta;
1719     }
1720
1721
1722     /**
1723      * Return a string representation of the revision.
1724      *
1725      * This is really only for debugging.
1726      *
1727      * @access public
1728      *
1729      * @return string Printable representation of the WikiDB_Page.
1730      */
1731     function asString () {
1732         ob_start();
1733         printf("[%s:%d\n", get_class($this), $this->get('version'));
1734         print_r($this->_data);
1735         echo $this->getPackedContent() . "\n]\n";
1736         $strval = ob_get_contents();
1737         ob_end_clean();
1738         return $strval;
1739     }
1740 };
1741
1742
1743 /**
1744  * Class representing a sequence of WikiDB_Pages.
1745  * TODO: Enhance to php5 iterators
1746  */
1747 class WikiDB_PageIterator
1748 {
1749     function WikiDB_PageIterator(&$wikidb, &$iter, $options=false) {
1750         $this->_iter = $iter; // a WikiDB_backend_iterator
1751         $this->_wikidb = &$wikidb;
1752         $this->_options = $options;
1753     }
1754
1755     function count () {
1756         return $this->_iter->count();
1757     }
1758
1759     /**
1760      * Get next WikiDB_Page in sequence.
1761      *
1762      * @access public
1763      *
1764      * @return WikiDB_Page The next WikiDB_Page in the sequence.
1765      */
1766     function next () {
1767         if ( ! ($next = $this->_iter->next()) )
1768             return false;
1769
1770         $pagename = &$next['pagename'];
1771         if (!$pagename) {
1772             trigger_error('empty pagename in WikiDB_PageIterator::next()', E_USER_WARNING);
1773             var_dump($next);
1774             return false;
1775         }
1776         // there's always hits, but we cache only if more
1777         // (well not with file, cvs and dba)
1778         if (isset($next['pagedata']) and count($next['pagedata']) > 1) {
1779             $this->_wikidb->_cache->cache_data($next);
1780         // cache existing page id's since we iterate over all links in GleanDescription
1781         // and need them later for LinkExistingWord
1782         } elseif ($this->_options and array_key_exists('include_empty', $this->_options)
1783                   and !$this->_options['include_empty'] and isset($next['id'])) {
1784             $this->_wikidb->_cache->_id_cache[$next['pagename']] = $next['id'];
1785         }
1786         return new WikiDB_Page($this->_wikidb, $pagename);
1787     }
1788
1789     /**
1790      * Release resources held by this iterator.
1791      *
1792      * The iterator may not be used after free() is called.
1793      *
1794      * There is no need to call free(), if next() has returned false.
1795      * (I.e. if you iterate through all the pages in the sequence,
1796      * you do not need to call free() --- you only need to call it
1797      * if you stop before the end of the iterator is reached.)
1798      *
1799      * @access public
1800      */
1801     function free() {
1802         $this->_iter->free();
1803     }
1804
1805     function asArray() {
1806         $result = array();
1807         while ($page = $this->next())
1808             $result[] = $page;
1809         //$this->reset();
1810         return $result;
1811     }
1812
1813
1814 };
1815
1816 /**
1817  * A class which represents a sequence of WikiDB_PageRevisions.
1818  * TODO: Enhance to php5 iterators
1819  */
1820 class WikiDB_PageRevisionIterator
1821 {
1822     function WikiDB_PageRevisionIterator(&$wikidb, &$revisions, $options=false) {
1823         $this->_revisions = $revisions;
1824         $this->_wikidb = &$wikidb;
1825         $this->_options = $options;
1826     }
1827
1828     function count () {
1829         return $this->_revisions->count();
1830     }
1831
1832     /**
1833      * Get next WikiDB_PageRevision in sequence.
1834      *
1835      * @access public
1836      *
1837      * @return WikiDB_PageRevision
1838      * The next WikiDB_PageRevision in the sequence.
1839      */
1840     function next () {
1841         if ( ! ($next = $this->_revisions->next()) )
1842             return false;
1843
1844         //$this->_wikidb->_cache->cache_data($next);
1845
1846         $pagename = $next['pagename'];
1847         $version = $next['version'];
1848         $versiondata = $next['versiondata'];
1849         if (DEBUG) {
1850             if (!(is_string($pagename) and $pagename != '')) {
1851                 trigger_error("empty pagename",E_USER_WARNING);
1852                 return false;
1853             }
1854         } else assert(is_string($pagename) and $pagename != '');
1855         if (DEBUG) {
1856             if (!is_array($versiondata)) {
1857                 trigger_error("empty versiondata",E_USER_WARNING);
1858                 return false;
1859             }
1860         } else assert(is_array($versiondata));
1861         if (DEBUG) {
1862             if (!($version > 0)) {
1863                 trigger_error("invalid version",E_USER_WARNING);
1864                 return false;
1865             }
1866         } else assert($version > 0);
1867
1868         return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1869                                        $versiondata);
1870     }
1871
1872     /**
1873      * Release resources held by this iterator.
1874      *
1875      * The iterator may not be used after free() is called.
1876      *
1877      * There is no need to call free(), if next() has returned false.
1878      * (I.e. if you iterate through all the revisions in the sequence,
1879      * you do not need to call free() --- you only need to call it
1880      * if you stop before the end of the iterator is reached.)
1881      *
1882      * @access public
1883      */
1884     function free() {
1885         $this->_revisions->free();
1886     }
1887
1888     function asArray() {
1889         $result = array();
1890         while ($rev = $this->next())
1891             $result[] = $rev;
1892         $this->free();
1893         return $result;
1894     }
1895 };
1896
1897 /** pseudo iterator
1898  */
1899 class WikiDB_Array_PageIterator
1900 {
1901     function WikiDB_Array_PageIterator(&$pagenames) {
1902         global $request;
1903         $this->_dbi = $request->getDbh();
1904         $this->_pages = $pagenames;
1905         reset($this->_pages);
1906     }
1907     function next() {
1908         $c =& current($this->_pages);
1909         next($this->_pages);
1910         return $c !== false ? $this->_dbi->getPage($c) : false;
1911     }
1912     function count() {
1913         return count($this->_pages);
1914     }
1915     function free() {}
1916     function asArray() {
1917         reset($this->_pages);
1918         return $this->_pages;
1919     }
1920 }
1921
1922 class WikiDB_Array_generic_iter
1923 {
1924     function WikiDB_Array_generic_iter($result) {
1925         // $result may be either an array or a query result
1926         if (is_array($result)) {
1927             $this->_array = $result;
1928         } elseif (is_object($result)) {
1929             $this->_array = $result->asArray();
1930         } else {
1931             $this->_array = array();
1932         }
1933         if (!empty($this->_array))
1934             reset($this->_array);
1935     }
1936     function next() {
1937         $c =& current($this->_array);
1938         next($this->_array);
1939         return $c !== false ? $c : false;
1940     }
1941     function count() {
1942         return count($this->_array);
1943     }
1944     function free() {}
1945     function asArray() {
1946         if (!empty($this->_array))
1947             reset($this->_array);
1948         return $this->_array;
1949     }
1950 }
1951
1952 /**
1953  * Data cache used by WikiDB.
1954  *
1955  * FIXME: Maybe rename this to caching_backend (or some such).
1956  *
1957  * @access private
1958  */
1959 class WikiDB_cache
1960 {
1961     // FIXME: beautify versiondata cache.  Cache only limited data?
1962
1963     function WikiDB_cache (&$backend) {
1964         $this->_backend = &$backend;
1965
1966         $this->_pagedata_cache = array();
1967         $this->_versiondata_cache = array();
1968         array_push ($this->_versiondata_cache, array());
1969         $this->_glv_cache = array();
1970         $this->_id_cache = array(); // formerly ->_dbi->_iwpcache (nonempty pages => id)
1971     }
1972
1973     function close() {
1974         $this->_pagedata_cache = array();
1975         $this->_versiondata_cache = array();
1976         $this->_glv_cache = array();
1977         $this->_id_cache = array();
1978     }
1979
1980     function get_pagedata($pagename) {
1981         assert(is_string($pagename) && $pagename != '');
1982         if (USECACHE) {
1983             $cache = &$this->_pagedata_cache;
1984             if (!isset($cache[$pagename]) || !is_array($cache[$pagename])) {
1985                 $cache[$pagename] = $this->_backend->get_pagedata($pagename);
1986                 if (empty($cache[$pagename]))
1987                     $cache[$pagename] = array();
1988             }
1989             return $cache[$pagename];
1990         } else {
1991             return $this->_backend->get_pagedata($pagename);
1992         }
1993     }
1994
1995     function update_pagedata($pagename, $newdata) {
1996         assert(is_string($pagename) && $pagename != '');
1997
1998         $this->_backend->update_pagedata($pagename, $newdata);
1999
2000         if (USECACHE) {
2001             if (!empty($this->_pagedata_cache[$pagename])
2002                 and is_array($this->_pagedata_cache[$pagename]))
2003             {
2004                 $cachedata = &$this->_pagedata_cache[$pagename];
2005                 foreach($newdata as $key => $val)
2006                     $cachedata[$key] = $val;
2007             } else
2008                 $this->_pagedata_cache[$pagename] = $newdata;
2009         }
2010     }
2011
2012     function invalidate_cache($pagename) {
2013         unset ($this->_pagedata_cache[$pagename]);
2014         unset ($this->_versiondata_cache[$pagename]);
2015         unset ($this->_glv_cache[$pagename]);
2016         unset ($this->_id_cache[$pagename]);
2017         //unset ($this->_backend->_page_data);
2018     }
2019
2020     function delete_page($pagename) {
2021         $result = $this->_backend->delete_page($pagename);
2022         $this->invalidate_cache($pagename);
2023         return $result;
2024     }
2025
2026     function purge_page($pagename) {
2027         $result = $this->_backend->purge_page($pagename);
2028         $this->invalidate_cache($pagename);
2029         return $result;
2030     }
2031
2032     // FIXME: ugly and wrong. may overwrite full cache with partial cache
2033     function cache_data($data) {
2034         ;
2035         //if (isset($data['pagedata']))
2036         //    $this->_pagedata_cache[$data['pagename']] = $data['pagedata'];
2037     }
2038
2039     function get_versiondata($pagename, $version, $need_content = false) {
2040         //  FIXME: Seriously ugly hackage
2041         $readdata = false;
2042         if (USECACHE) {   //temporary - for debugging
2043             assert(is_string($pagename) && $pagename != '');
2044             // There is a bug here somewhere which results in an assertion failure at line 105
2045             // of ArchiveCleaner.php  It goes away if we use the next line.
2046             //$need_content = true;
2047             $nc = $need_content ? '1':'0';
2048             $cache = &$this->_versiondata_cache;
2049             if (!isset($cache[$pagename][$version][$nc])
2050                 || !(is_array ($cache[$pagename]))
2051                 || !(is_array ($cache[$pagename][$version])))
2052             {
2053                 $cache[$pagename][$version][$nc] =
2054                     $this->_backend->get_versiondata($pagename, $version, $need_content);
2055                 $readdata = true;
2056                 // If we have retrieved all data, we may as well set the cache for
2057                 // $need_content = false
2058                 if ($need_content){
2059                     $cache[$pagename][$version]['0'] =& $cache[$pagename][$version]['1'];
2060                 }
2061             }
2062             $vdata = $cache[$pagename][$version][$nc];
2063         } else {
2064             $vdata = $this->_backend->get_versiondata($pagename, $version, $need_content);
2065             $readdata = true;
2066         }
2067         if ($readdata && $vdata && !empty($vdata['%pagedata'])) {
2068             $this->_pagedata_cache[$pagename] =& $vdata['%pagedata'];
2069         }
2070         return $vdata;
2071     }
2072
2073     function set_versiondata($pagename, $version, $data) {
2074         //unset($this->_versiondata_cache[$pagename][$version]);
2075
2076         $new = $this->_backend->set_versiondata($pagename, $version, $data);
2077         // Update the cache
2078         $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2079         $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2080         // Is this necessary?
2081         unset($this->_glv_cache[$pagename]);
2082     }
2083
2084     function update_versiondata($pagename, $version, $data) {
2085         $new = $this->_backend->update_versiondata($pagename, $version, $data);
2086         // Update the cache
2087         $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2088         // FIXME: hack
2089         $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2090         // Is this necessary?
2091         unset($this->_glv_cache[$pagename]);
2092     }
2093
2094     function delete_versiondata($pagename, $version) {
2095         $new = $this->_backend->delete_versiondata($pagename, $version);
2096         if (isset($this->_versiondata_cache[$pagename][$version]))
2097             unset ($this->_versiondata_cache[$pagename][$version]);
2098         // dirty latest version cache only if latest version gets deleted
2099         if (isset($this->_glv_cache[$pagename]) and $this->_glv_cache[$pagename] == $version)
2100             unset ($this->_glv_cache[$pagename]);
2101     }
2102
2103     function get_latest_version($pagename)  {
2104         if (USECACHE) {
2105             assert (is_string($pagename) && $pagename != '');
2106             $cache = &$this->_glv_cache;
2107             if (!isset($cache[$pagename])) {
2108                 $cache[$pagename] = $this->_backend->get_latest_version($pagename);
2109                 if (empty($cache[$pagename]))
2110                     $cache[$pagename] = 0;
2111             }
2112             return $cache[$pagename];
2113         } else {
2114             return $this->_backend->get_latest_version($pagename);
2115         }
2116     }
2117 };
2118
2119 function _sql_debuglog($msg, $newline=true, $shutdown=false) {
2120     static $fp = false;
2121     static $i = 0;
2122     if (!$fp) {
2123         $stamp = strftime("%y%m%d-%H%M%S");
2124         $fp = fopen("/tmp/sql-$stamp.log", "a");
2125         register_shutdown_function("_sql_debuglog_shutdown_function");
2126     } elseif ($shutdown) {
2127         fclose($fp);
2128         return;
2129     }
2130     if ($newline) fputs($fp, "[$i++] $msg");
2131     else fwrite($fp, $msg);
2132 }
2133
2134 function _sql_debuglog_shutdown_function() {
2135     _sql_debuglog('',false,true);
2136 }
2137
2138 // $Log: not supported by cvs2svn $
2139 // Revision 1.131  2005/04/23 11:30:12  rurban
2140 // allow emtpy WikiDB::getRevisionBefore(), for simplier templates (revert)
2141 //
2142 // Revision 1.130  2005/04/06 06:19:30  rurban
2143 // Revert the previous wrong bugfix #1175761: USECACHE was mixed with WIKIDB_NOCACHE_MARKUP.
2144 // Fix WIKIDB_NOCACHE_MARKUP in main (always set it) and clarify it in WikiDB
2145 //
2146 // Revision 1.129  2005/04/06 05:50:29  rurban
2147 // honor !USECACHE for _cached_html, fixes #1175761
2148 //
2149 // Revision 1.128  2005/04/01 16:11:42  rurban
2150 // just whitespace
2151 //
2152 // Revision 1.127  2005/02/18 20:43:40  uckelman
2153 // WikiDB::genericWarnings() is no longer used.
2154 //
2155 // Revision 1.126  2005/02/04 17:58:06  rurban
2156 // minor versioncache improvement. part 2/3 of Charles Corrigan cache patch. not sure about the 0/1 issue
2157 //
2158 // Revision 1.125  2005/02/03 05:08:39  rurban
2159 // ref fix by Charles Corrigan
2160 //
2161 // Revision 1.124  2005/01/29 20:43:32  rurban
2162 // protect against empty request: on some occasion this happens
2163 //
2164 // Revision 1.123  2005/01/25 06:58:21  rurban
2165 // reformatting
2166 //
2167 // Revision 1.122  2005/01/20 10:18:17  rurban
2168 // reformatting
2169 //
2170 // Revision 1.121  2005/01/04 20:25:01  rurban
2171 // remove old [%pagedata][_cached_html] code
2172 //
2173 // Revision 1.120  2004/12/23 14:12:31  rurban
2174 // dont email on unittest
2175 //
2176 // Revision 1.119  2004/12/20 16:05:00  rurban
2177 // gettext msg unification
2178 //
2179 // Revision 1.118  2004/12/13 13:22:57  rurban
2180 // new BlogArchives plugin for the new blog theme. enable default box method
2181 // for all plugins. Minor search improvement.
2182 //
2183 // Revision 1.117  2004/12/13 08:15:09  rurban
2184 // false is wrong. null might be better but lets play safe.
2185 //
2186 // Revision 1.116  2004/12/10 22:15:00  rurban
2187 // fix $page->get('_cached_html)
2188 // refactor upgrade db helper _convert_cached_html() to be able to call them from WikiAdminUtils also.
2189 // support 2nd genericSqlQuery param (bind huge arg)
2190 //
2191 // Revision 1.115  2004/12/10 02:45:27  rurban
2192 // SQL optimization:
2193 //   put _cached_html from pagedata into a new seperate blob, not huge serialized string.
2194 //   it is only rarelely needed: for current page only, if-not-modified
2195 //   but was extracted for every simple page iteration.
2196 //
2197 // Revision 1.114  2004/12/09 22:24:44  rurban
2198 // optimize on _DEBUG_SQL only. but now again on every 50th request, not just save.
2199 //
2200 // Revision 1.113  2004/12/06 19:49:55  rurban
2201 // enable action=remove which is undoable and seeable in RecentChanges: ADODB ony for now.
2202 // renamed delete_page to purge_page.
2203 // enable action=edit&version=-1 to force creation of a new version.
2204 // added BABYCART_PATH config
2205 // fixed magiqc in adodb.inc.php
2206 // and some more docs
2207 //
2208 // Revision 1.112  2004/11/30 17:45:53  rurban
2209 // exists_links backend implementation
2210 //
2211 // Revision 1.111  2004/11/28 20:39:43  rurban
2212 // deactivate pagecache overwrite: it is wrong
2213 //
2214 // Revision 1.110  2004/11/26 18:39:01  rurban
2215 // new regex search parser and SQL backends (90% complete, glob and pcre backends missing)
2216 //
2217 // Revision 1.109  2004/11/25 17:20:50  rurban
2218 // and again a couple of more native db args: backlinks
2219 //
2220 // Revision 1.108  2004/11/23 13:35:31  rurban
2221 // add case_exact search
2222 //
2223 // Revision 1.107  2004/11/21 11:59:16  rurban
2224 // remove final \n to be ob_cache independent
2225 //
2226 // Revision 1.106  2004/11/20 17:35:56  rurban
2227 // improved WantedPages SQL backends
2228 // PageList::sortby new 3rd arg valid_fields (override db fields)
2229 // WantedPages sql pager inexact for performance reasons:
2230 //   assume 3 wantedfrom per page, to be correct, no getTotal()
2231 // support exclude argument for get_all_pages, new _sql_set()
2232 //
2233 // Revision 1.105  2004/11/20 09:16:27  rurban
2234 // Fix bad-style Cut&Paste programming errors, detected by Charles Corrigan.
2235 //
2236 // Revision 1.104  2004/11/19 19:22:03  rurban
2237 // ModeratePage part1: change status
2238 //
2239 // Revision 1.103  2004/11/16 17:29:04  rurban
2240 // fix remove notification error
2241 // fix creation + update id_cache update
2242 //
2243 // Revision 1.102  2004/11/11 18:31:26  rurban
2244 // add simple backtrace on such general failures to get at least an idea where
2245 //
2246 // Revision 1.101  2004/11/10 19:32:22  rurban
2247 // * optimize increaseHitCount, esp. for mysql.
2248 // * prepend dirs to the include_path (phpwiki_dir for faster searches)
2249 // * Pear_DB version logic (awful but needed)
2250 // * fix broken ADODB quote
2251 // * _extract_page_data simplification
2252 //
2253 // Revision 1.100  2004/11/10 15:29:20  rurban
2254 // * requires newer Pear_DB (as the internal one): quote() uses now escapeSimple for strings
2255 // * ACCESS_LOG_SQL: fix cause request not yet initialized
2256 // * WikiDB: moved SQL specific methods upwards
2257 // * new Pear_DB quoting: same as ADODB and as newer Pear_DB.
2258 //   fixes all around: WikiGroup, WikiUserNew SQL methods, SQL logging
2259 //
2260 // Revision 1.99  2004/11/09 17:11:05  rurban
2261 // * revert to the wikidb ref passing. there's no memory abuse there.
2262 // * use new wikidb->_cache->_id_cache[] instead of wikidb->_iwpcache, to effectively
2263 //   store page ids with getPageLinks (GleanDescription) of all existing pages, which
2264 //   are also needed at the rendering for linkExistingWikiWord().
2265 //   pass options to pageiterator.
2266 //   use this cache also for _get_pageid()
2267 //   This saves about 8 SELECT count per page (num all pagelinks).
2268 // * fix passing of all page fields to the pageiterator.
2269 // * fix overlarge session data which got broken with the latest ACCESS_LOG_SQL changes
2270 //
2271 // Revision 1.98  2004/11/07 18:34:29  rurban
2272 // more logging fixes
2273 //
2274 // Revision 1.97  2004/11/07 16:02:51  rurban
2275 // new sql access log (for spam prevention), and restructured access log class
2276 // dbh->quote (generic)
2277 // pear_db: mysql specific parts seperated (using replace)
2278 //
2279 // Revision 1.96  2004/11/05 22:32:15  rurban
2280 // encode the subject to be 7-bit safe
2281 //
2282 // Revision 1.95  2004/11/05 20:53:35  rurban
2283 // login cleanup: better debug msg on failing login,
2284 // checked password less immediate login (bogo or anon),
2285 // checked olduser pref session error,
2286 // better PersonalPage without password warning on minimal password length=0
2287 //   (which is default now)
2288 //
2289 // Revision 1.94  2004/11/01 10:43:56  rurban
2290 // seperate PassUser methods into seperate dir (memory usage)
2291 // fix WikiUser (old) overlarge data session
2292 // remove wikidb arg from various page class methods, use global ->_dbi instead
2293 // ...
2294 //
2295 // Revision 1.93  2004/10/14 17:17:57  rurban
2296 // remove dbi WikiDB_Page param: use global request object instead. (memory)
2297 // allow most_popular sortby arguments
2298 //
2299 // Revision 1.92  2004/10/05 17:00:04  rurban
2300 // support paging for simple lists
2301 // fix RatingDb sql backend.
2302 // remove pages from AllPages (this is ListPages then)
2303 //
2304 // Revision 1.91  2004/10/04 23:41:19  rurban
2305 // delete notify: fix, @unset syntax error
2306 //
2307 // Revision 1.90  2004/09/28 12:50:22  rurban
2308 // https://sourceforge.net/forum/forum.php?thread_id=1150924&forum_id=18929
2309 //
2310 // Revision 1.89  2004/09/26 10:54:42  rurban
2311 // silence deferred check
2312 //
2313 // Revision 1.88  2004/09/25 18:16:40  rurban
2314 // unset more unneeded _cached_html. (Guess this should fix sf.net now)
2315 //
2316 // Revision 1.87  2004/09/25 16:25:40  rurban
2317 // notify on rename and remove (to be improved)
2318 //
2319 // Revision 1.86  2004/09/23 18:52:06  rurban
2320 // only fortune at create
2321 //
2322 // Revision 1.85  2004/09/16 08:00:51  rurban
2323 // just some comments
2324 //
2325 // Revision 1.84  2004/09/14 10:34:30  rurban
2326 // fix TransformedText call to use refs
2327 //
2328 // Revision 1.83  2004/09/08 13:38:00  rurban
2329 // improve loadfile stability by using markup=2 as default for undefined markup-style.
2330 // use more refs for huge objects.
2331 // fix debug=static issue in WikiPluginCached
2332 //
2333 // Revision 1.82  2004/09/06 12:08:49  rurban
2334 // memory_limit on unix workaround
2335 // VisualWiki: default autosize image
2336 //
2337 // Revision 1.81  2004/09/06 08:28:00  rurban
2338 // rename genericQuery to genericSqlQuery
2339 //
2340 // Revision 1.80  2004/07/09 13:05:34  rurban
2341 // just aesthetics
2342 //
2343 // Revision 1.79  2004/07/09 10:06:49  rurban
2344 // Use backend specific sortby and sortable_columns method, to be able to
2345 // select between native (Db backend) and custom (PageList) sorting.
2346 // Fixed PageList::AddPageList (missed the first)
2347 // Added the author/creator.. name to AllPagesBy...
2348 //   display no pages if none matched.
2349 // Improved dba and file sortby().
2350 // Use &$request reference
2351 //
2352 // Revision 1.78  2004/07/08 21:32:35  rurban
2353 // Prevent from more warnings, minor db and sort optimizations
2354 //
2355 // Revision 1.77  2004/07/08 19:04:42  rurban
2356 // more unittest fixes (file backend, metadata RatingsDb)
2357 //
2358 // Revision 1.76  2004/07/08 17:31:43  rurban
2359 // improve numPages for file (fixing AllPagesTest)
2360 //
2361 // Revision 1.75  2004/07/05 13:56:22  rurban
2362 // sqlite autoincrement fix
2363 //
2364 // Revision 1.74  2004/07/03 16:51:05  rurban
2365 // optional DBADMIN_USER:DBADMIN_PASSWD for action=upgrade (if no ALTER permission)
2366 // added atomic mysql REPLACE for PearDB as in ADODB
2367 // fixed _lock_tables typo links => link
2368 // fixes unserialize ADODB bug in line 180
2369 //
2370 // Revision 1.73  2004/06/29 08:52:22  rurban
2371 // Use ...version() $need_content argument in WikiDB also:
2372 // To reduce the memory footprint for larger sets of pagelists,
2373 // we don't cache the content (only true or false) and
2374 // we purge the pagedata (_cached_html) also.
2375 // _cached_html is only cached for the current pagename.
2376 // => Vastly improved page existance check, ACL check, ...
2377 //
2378 // Now only PagedList info=content or size needs the whole content, esp. if sortable.
2379 //
2380 // Revision 1.72  2004/06/25 14:15:08  rurban
2381 // reduce memory footprint by caching only requested pagedate content (improving most page iterators)
2382 //
2383 // Revision 1.71  2004/06/21 16:22:30  rurban
2384 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
2385 // fixed dumping buttons locally (images/buttons/),
2386 // support pages arg for dumphtml,
2387 // optional directory arg for dumpserial + dumphtml,
2388 // fix a AllPages warning,
2389 // show dump warnings/errors on DEBUG,
2390 // don't warn just ignore on wikilens pagelist columns, if not loaded.
2391 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
2392 //
2393 // Revision 1.70  2004/06/18 14:39:31  rurban
2394 // actually check USECACHE
2395 //
2396 // Revision 1.69  2004/06/13 15:33:20  rurban
2397 // new support for arguments owner, author, creator in most relevant
2398 // PageList plugins. in WikiAdmin* via preSelectS()
2399 //
2400 // Revision 1.68  2004/06/08 21:03:20  rurban
2401 // updated RssParser for XmlParser quirks (store parser object params in globals)
2402 //
2403 // Revision 1.67  2004/06/07 19:12:49  rurban
2404 // fixed rename version=0, bug #966284
2405 //
2406 // Revision 1.66  2004/06/07 18:57:27  rurban
2407 // fix rename: Change pagename in all linked pages
2408 //
2409 // Revision 1.65  2004/06/04 20:32:53  rurban
2410 // Several locale related improvements suggested by Pierrick Meignen
2411 // LDAP fix by John Cole
2412 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
2413 //
2414 // Revision 1.64  2004/06/04 16:50:00  rurban
2415 // add random quotes to empty pages
2416 //
2417 // Revision 1.63  2004/06/04 11:58:38  rurban
2418 // added USE_TAGLINES
2419 //
2420 // Revision 1.62  2004/06/03 22:24:41  rurban
2421 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
2422 //
2423 // Revision 1.61  2004/06/02 17:13:48  rurban
2424 // fix getRevisionBefore assertion
2425 //
2426 // Revision 1.60  2004/05/28 10:09:58  rurban
2427 // fix bug #962117, incorrect init of auth_dsn
2428 //
2429 // Revision 1.59  2004/05/27 17:49:05  rurban
2430 // renamed DB_Session to DbSession (in CVS also)
2431 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
2432 // remove leading slash in error message
2433 // added force_unlock parameter to File_Passwd (no return on stale locks)
2434 // fixed adodb session AffectedRows
2435 // added FileFinder helpers to unify local filenames and DATA_PATH names
2436 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
2437 //
2438 // Revision 1.58  2004/05/18 13:59:14  rurban
2439 // rename simpleQuery to genericQuery
2440 //
2441 // Revision 1.57  2004/05/16 22:07:35  rurban
2442 // check more config-default and predefined constants
2443 // various PagePerm fixes:
2444 //   fix default PagePerms, esp. edit and view for Bogo and Password users
2445 //   implemented Creator and Owner
2446 //   BOGOUSERS renamed to BOGOUSER
2447 // fixed syntax errors in signin.tmpl
2448 //
2449 // Revision 1.56  2004/05/15 22:54:49  rurban
2450 // fixed important WikiDB bug with DEBUG > 0: wrong assertion
2451 // improved SetAcl (works) and PagePerms, some WikiGroup helpers.
2452 //
2453 // Revision 1.55  2004/05/12 19:27:47  rurban
2454 // revert wrong inline optimization.
2455 //
2456 // Revision 1.54  2004/05/12 10:49:55  rurban
2457 // require_once fix for those libs which are loaded before FileFinder and
2458 //   its automatic include_path fix, and where require_once doesn't grok
2459 //   dirname(__FILE__) != './lib'
2460 // upgrade fix with PearDB
2461 // navbar.tmpl: remove spaces for IE &nbsp; button alignment
2462 //
2463 // Revision 1.53  2004/05/08 14:06:12  rurban
2464 // new support for inlined image attributes: [image.jpg size=50x30 align=right]
2465 // minor stability and portability fixes
2466 //
2467 // Revision 1.52  2004/05/06 19:26:16  rurban
2468 // improve stability, trying to find the InlineParser endless loop on sf.net
2469 //
2470 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
2471 //
2472 // Revision 1.51  2004/05/06 17:30:37  rurban
2473 // CategoryGroup: oops, dos2unix eol
2474 // improved phpwiki_version:
2475 //   pre -= .0001 (1.3.10pre: 1030.099)
2476 //   -p1 += .001 (1.3.9-p1: 1030.091)
2477 // improved InstallTable for mysql and generic SQL versions and all newer tables so far.
2478 // abstracted more ADODB/PearDB methods for action=upgrade stuff:
2479 //   backend->backendType(), backend->database(),
2480 //   backend->listOfFields(),
2481 //   backend->listOfTables(),
2482 //
2483 // Revision 1.50  2004/05/04 22:34:25  rurban
2484 // more pdf support
2485 //
2486 // Revision 1.49  2004/05/03 11:16:40  rurban
2487 // fixed sendPageChangeNotification
2488 // subject rewording
2489 //
2490 // Revision 1.48  2004/04/29 23:03:54  rurban
2491 // fixed sf.net bug #940996
2492 //
2493 // Revision 1.47  2004/04/29 19:39:44  rurban
2494 // special support for formatted plugins (one-liners)
2495 //   like <small><plugin BlaBla ></small>
2496 // iter->asArray() helper for PopularNearby
2497 // db_session for older php's (no &func() allowed)
2498 //
2499 // Revision 1.46  2004/04/26 20:44:34  rurban
2500 // locking table specific for better databases
2501 //
2502 // Revision 1.45  2004/04/20 00:06:03  rurban
2503 // themable paging support
2504 //
2505 // Revision 1.44  2004/04/19 18:27:45  rurban
2506 // Prevent from some PHP5 warnings (ref args, no :: object init)
2507 //   php5 runs now through, just one wrong XmlElement object init missing
2508 // Removed unneccesary UpgradeUser lines
2509 // Changed WikiLink to omit version if current (RecentChanges)
2510 //
2511 // Revision 1.43  2004/04/18 01:34:20  rurban
2512 // protect most_popular from sortby=mtime
2513 //
2514 // Revision 1.42  2004/04/18 01:11:51  rurban
2515 // more numeric pagename fixes.
2516 // fixed action=upload with merge conflict warnings.
2517 // charset changed from constant to global (dynamic utf-8 switching)
2518 //
2519
2520 // Local Variables:
2521 // mode: php
2522 // tab-width: 8
2523 // c-basic-offset: 4
2524 // c-hanging-comment-ender-p: nil
2525 // indent-tabs-mode: nil
2526 // End:
2527 ?>