lib/WikiDB.php

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