lib/WikiDB.php

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