lib/WikiDB.php

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