lib/WikiDB.php

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