lib/WikiDB.php

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