lib/WikiDB.php

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