lib/WikiDB.php

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