lib/WikiDB.php

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