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 boolean $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 or false $sortby Optional. "+-column,+-column2".
 281      *        If false the result is faster in natural order.
 282      * @param string or false $limit Optional. Encoded as "$offset,$count".
 283      *         $offset defaults to 0.
 284      * @param string $exclude: Optional comma-seperated 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-seperated 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 or false $sortby Optional. "+-column,+-column2".
 336      *        If false the result is faster in natural order.
 337      * @param string or false $limit Optional. Encoded as "$offset,$count".
 338      *         $offset defaults to 0.
 339      * @param  string              $exclude: Optional comma-seperated 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 or false $sortby Optional. "+-column,+-column2".
 367      *        If false the result is faster in natural order.
 368      * @param string or false $limit Optional. Encoded as "$offset,$count".
 369      *         $offset defaults to 0.
 370      * @param  string              $exclude: Optional comma-seperated 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 integer $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 or false $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 or false $sortby Optional. "+-column,+-column2".
 445      *        If false the result is faster in natural order.
 446      * @param string or false $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>", printSimpleTrace(debug_backtrace()), "</pre>\n";
 715         trigger_error("no SQL database", E_USER_ERROR);
 716         return false;
 717     }
 718
 719     // SQL iter: for simple select or create/update queries
 720     // returns the generic iterator object (count,next)
 721     function genericSqlIter($sql, $field_list = NULL)
 722     {
 723         echo "<pre>", printSimpleTrace(debug_backtrace()), "</pre>\n";
 724         trigger_error("no SQL database", E_USER_ERROR);
 725         return false;
 726     }
 727
 728     // see backend upstream methods
 729     // ADODB adds surrounding quotes, SQL not yet!
 730     function quote($s)
 731     {
 732         return $s;
 733     }
 734
 735     function isOpen()
 736     {
 737         global $request;
 738         if (!$request->_dbi) return false;
 739         else return false; /* so far only needed for sql so false it.
 740                             later we have to check dba also */
 741     }
 742
 743     function getParam($param)
 744     {
 745         global $DBParams;
 746         if (isset($DBParams[$param])) return $DBParams[$param];
 747         elseif ($param == 'prefix') return ''; else return false;
 748     }
 749
 750     function getAuthParam($param)
 751     {
 752         global $DBAuthParams;
 753         if (isset($DBAuthParams[$param])) return $DBAuthParams[$param];
 754         elseif ($param == 'USER_AUTH_ORDER') return $GLOBALS['USER_AUTH_ORDER']; elseif ($param == 'USER_AUTH_POLICY') return $GLOBALS['USER_AUTH_POLICY']; else return false;
 755     }
 756 }
 757
 758 /**
 759  * A base class which representing a wiki-page within a
 760  * WikiDB.
 761  *
 762  * A WikiDB_Page contains a number (at least one) of
 763  * WikiDB_PageRevisions.
 764  */
 765 class WikiDB_Page
 766 {
 767     function WikiDB_Page(&$wikidb, $pagename)
 768     {
 769         $this->_wikidb = &$wikidb;
 770         $this->_pagename = $pagename;
 771         if ((int)DEBUG) {
 772             if (!(is_string($pagename) and $pagename != '')) {
 773                 if (function_exists("xdebug_get_function_stack")) {
 774                     echo "xdebug_get_function_stack(): ";
 775                     var_dump(xdebug_get_function_stack());
 776                 } else {
 777                     printSimpleTrace(debug_backtrace());
 778                 }
 779                 trigger_error("empty pagename", E_USER_WARNING);
 780                 return false;
 781             }
 782         } else {
 783             assert(is_string($pagename) and $pagename != '');
 784         }
 785     }
 786
 787     /**
 788      * Get the name of the wiki page.
 789      *
 790      * @access public
 791      *
 792      * @return string The page name.
 793      */
 794     function getName()
 795     {
 796         return $this->_pagename;
 797     }
 798
 799     // To reduce the memory footprint for larger sets of pagelists,
 800     // we don't cache the content (only true or false) and
 801     // we purge the pagedata (_cached_html) also
 802     function exists()
 803     {
 804         if (isset($this->_wikidb->_cache->_id_cache[$this->_pagename])) return true;
 805         $current = $this->getCurrentRevision(false);
 806         if (!$current) return false;
 807         return !$current->hasDefaultContents();
 808     }
 809
 810     /**
 811      * Delete an old revision of a WikiDB_Page.
 812      *
 813      * Deletes the specified revision of the page.
 814      * It is a fatal error to attempt to delete the current revision.
 815      *
 816      * @access public
 817      *
 818      * @param integer $version Which revision to delete.  (You can also
 819      *  use a WikiDB_PageRevision object here.)
 820      */
 821     function deleteRevision($version)
 822     {
 823         if ($this->_wikidb->readonly) {
 824             trigger_error("readonly database", E_USER_WARNING);
 825             return;
 826         }
 827         $backend = &$this->_wikidb->_backend;
 828         $cache = &$this->_wikidb->_cache;
 829         $pagename = &$this->_pagename;
 830
 831         $version = $this->_coerce_to_version($version);
 832         if ($version == 0)
 833             return;
 834
 835         $backend->lock(array('page', 'version'));
 836         $latestversion = $cache->get_latest_version($pagename);
 837         if ($latestversion && ($version == $latestversion)) {
 838             $backend->unlock(array('page', 'version'));
 839             trigger_error(sprintf("Attempt to delete most recent revision of '%s'",
 840                 $pagename), E_USER_ERROR);
 841             return;
 842         }
 843
 844         $cache->delete_versiondata($pagename, $version);
 845         $backend->unlock(array('page', 'version'));
 846     }
 847
 848     /*
 849      * Delete a revision, or possibly merge it with a previous
 850      * revision.
 851      *
 852      * The idea is this:
 853      * Suppose an author make a (major) edit to a page.  Shortly
 854      * after that the same author makes a minor edit (e.g. to fix
 855      * spelling mistakes he just made.)
 856      *
 857      * Now some time later, where cleaning out old saved revisions,
 858      * and would like to delete his minor revision (since there's
 859      * really no point in keeping minor revisions around for a long
 860      * time.)
 861      *
 862      * Note that the text after the minor revision probably represents
 863      * what the author intended to write better than the text after
 864      * the preceding major edit.
 865      *
 866      * So what we really want to do is merge the minor edit with the
 867      * preceding edit.
 868      *
 869      * We will only do this when:
 870      * <ul>
 871      * <li>The revision being deleted is a minor one, and
 872      * <li>It has the same author as the immediately preceding revision.
 873      * </ul>
 874      */
 875     function mergeRevision($version)
 876     {
 877         if ($this->_wikidb->readonly) {
 878             trigger_error("readonly database", E_USER_WARNING);
 879             return;
 880         }
 881         $backend = &$this->_wikidb->_backend;
 882         $cache = &$this->_wikidb->_cache;
 883         $pagename = &$this->_pagename;
 884
 885         $version = $this->_coerce_to_version($version);
 886         if ($version == 0)
 887             return;
 888
 889         $backend->lock(array('version'));
 890         $latestversion = $cache->get_latest_version($pagename);
 891         if ($latestversion && $version == $latestversion) {
 892             $backend->unlock(array('version'));
 893             trigger_error(sprintf("Attempt to merge most recent revision of '%s'",
 894                 $pagename), E_USER_ERROR);
 895             return;
 896         }
 897
 898         $versiondata = $cache->get_versiondata($pagename, $version, true);
 899         if (!$versiondata) {
 900             // Not there? ... we're done!
 901             $backend->unlock(array('version'));
 902             return;
 903         }
 904
 905         if ($versiondata['is_minor_edit']) {
 906             $previous = $backend->get_previous_version($pagename, $version);
 907             if ($previous) {
 908                 $prevdata = $cache->get_versiondata($pagename, $previous);
 909                 if ($prevdata['author_id'] == $versiondata['author_id']) {
 910                     // This is a minor revision, previous version is
 911                     // by the same author. We will merge the
 912                     // revisions.
 913                     $cache->update_versiondata($pagename, $previous,
 914                         array('%content' => $versiondata['%content'],
 915                             '_supplanted' => $versiondata['_supplanted']));
 916                 }
 917             }
 918         }
 919
 920         $cache->delete_versiondata($pagename, $version);
 921         $backend->unlock(array('version'));
 922     }
 923
 924
 925     /**
 926      * Create a new revision of a {@link WikiDB_Page}.
 927      *
 928      * @access public
 929      *
 930      * @param int $version Version number for new revision.
 931      * To ensure proper serialization of edits, $version must be
 932      * exactly one higher than the current latest version.
 933      * (You can defeat this check by setting $version to
 934      * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
 935      *
 936      * @param string $content Contents of new revision.
 937      *
 938      * @param hash $metadata Metadata for new revision.
 939      * All values in the hash should be scalars (strings or integers).
 940      *
 941      * @param hash $links List of linkto=>pagename, relation=>pagename which this page links to.
 942      *
 943      * @return WikiDB_PageRevision Returns the new WikiDB_PageRevision object. If
 944      * $version was incorrect, returns false
 945      */
 946     function createRevision($version, &$content, $metadata, $links)
 947     {
 948         if ($this->_wikidb->readonly) {
 949             trigger_error("readonly database", E_USER_WARNING);
 950             return;
 951         }
 952         $backend = &$this->_wikidb->_backend;
 953         $cache = &$this->_wikidb->_cache;
 954         $pagename = &$this->_pagename;
 955         $cache->invalidate_cache($pagename);
 956
 957         $backend->lock(array('version', 'page', 'recent', 'link', 'nonempty'));
 958
 959         $latestversion = $backend->get_latest_version($pagename);
 960         $newversion = ($latestversion ? $latestversion : 0) + 1;
 961         assert($newversion >= 1);
 962
 963         if ($version != WIKIDB_FORCE_CREATE and $version != $newversion) {
 964             $backend->unlock(array('version', 'page', 'recent', 'link', 'nonempty'));
 965             return false;
 966         }
 967
 968         $data = $metadata;
 969
 970         foreach ($data as $key => $val) {
 971             if (empty($val) || $key[0] == '_' || $key[0] == '%')
 972                 unset($data[$key]);
 973         }
 974
 975         assert(!empty($data['author']));
 976         if (empty($data['author_id']))
 977             @$data['author_id'] = $data['author'];
 978
 979         if (empty($data['mtime']))
 980             $data['mtime'] = time();
 981
 982         if ($latestversion and $version != WIKIDB_FORCE_CREATE) {
 983             // Ensure mtimes are monotonic.
 984             $pdata = $cache->get_versiondata($pagename, $latestversion);
 985             if ($data['mtime'] < $pdata['mtime']) {
 986                 trigger_error(sprintf(_("%s: Date of new revision is %s"),
 987                         $pagename, "'non-monotonic'"),
 988                     E_USER_NOTICE);
 989                 $data['orig_mtime'] = $data['mtime'];
 990                 $data['mtime'] = $pdata['mtime'];
 991             }
 992
 993             // FIXME: use (possibly user specified) 'mtime' time or
 994             // time()?
 995             $cache->update_versiondata($pagename, $latestversion,
 996                 array('_supplanted' => $data['mtime']));
 997         }
 998
 999         $data['%content'] = &$content;
1000
1001         $cache->set_versiondata($pagename, $newversion, $data);
1002
1003         //$cache->update_pagedata($pagename, array(':latestversion' => $newversion,
1004         //':deleted' => empty($content)));
1005
1006         $backend->set_links($pagename, $links);
1007
1008         $backend->unlock(array('version', 'page', 'recent', 'link', 'nonempty'));
1009
1010         return new WikiDB_PageRevision($this->_wikidb, $pagename, $newversion,
1011             $data);
1012     }
1013
1014     /** A higher-level interface to createRevision.
1015      *
1016      * This takes care of computing the links, and storing
1017      * a cached version of the transformed wiki-text.
1018      *
1019      * @param string $wikitext The page content.
1020      *
1021      * @param int $version Version number for new revision.
1022      * To ensure proper serialization of edits, $version must be
1023      * exactly one higher than the current latest version.
1024      * (You can defeat this check by setting $version to
1025      * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
1026      *
1027      * @param hash $meta Meta-data for new revision.
1028      */
1029     function save($wikitext, $version, $meta, $formatted = null)
1030     {
1031         if ($this->_wikidb->readonly) {
1032             trigger_error("readonly database", E_USER_WARNING);
1033             return;
1034         }
1035         if (is_null($formatted))
1036             $formatted = new TransformedText($this, $wikitext, $meta);
1037         $type = $formatted->getType();
1038         $meta['pagetype'] = $type->getName();
1039         $links = $formatted->getWikiPageLinks(); // linkto => relation
1040         $attributes = array();
1041         foreach ($links as $link) {
1042             if ($link['linkto'] === "" and !empty($link['relation'])) {
1043                 $attributes[$link['relation']] = $this->getAttribute($link['relation']);
1044             }
1045         }
1046         $meta['attribute'] = $attributes;
1047
1048         $backend = &$this->_wikidb->_backend;
1049         $newrevision = $this->createRevision($version, $wikitext, $meta, $links);
1050         if ($newrevision and !WIKIDB_NOCACHE_MARKUP)
1051             $this->set('_cached_html', $formatted->pack());
1052
1053         // FIXME: probably should have some global state information
1054         // in the backend to control when to optimize.
1055         //
1056         // We're doing this here rather than in createRevision because
1057         // postgresql can't optimize while locked.
1058         if (((int)DEBUG & _DEBUG_SQL)
1059             or (DATABASE_OPTIMISE_FREQUENCY > 0 and
1060                 (time() % DATABASE_OPTIMISE_FREQUENCY == 0))
1061         ) {
1062             if ($backend->optimize()) {
1063                 if ((int)DEBUG)
1064                     trigger_error(_("Optimizing database"), E_USER_NOTICE);
1065             }
1066         }
1067
1068         /* Generate notification emails? */
1069         if (ENABLE_MAILNOTIFY and isa($newrevision, 'WikiDB_PageRevision')) {
1070             // Save didn't fail because of concurrent updates.
1071             $notify = $this->_wikidb->get('notify');
1072             if (!empty($notify)
1073                 and is_array($notify)
1074                     and !isa($GLOBALS['request'], 'MockRequest')
1075             ) {
1076                 include_once 'lib/MailNotify.php';
1077                 $MailNotify = new MailNotify($newrevision->getName());
1078                 $MailNotify->onChangePage($this->_wikidb, $wikitext, $version, $meta);
1079             }
1080             $newrevision->_transformedContent = $formatted;
1081         }
1082         // more pagechange callbacks: (in a hackish manner for now)
1083         if (ENABLE_RECENTCHANGESBOX
1084             and empty($meta['is_minor_edit'])
1085                 and !in_array($GLOBALS['request']->getArg('action'),
1086                     array('loadfile', 'upgrade'))
1087         ) {
1088             require_once 'lib/WikiPlugin.php';
1089             $w = new WikiPluginLoader;
1090             $p = $w->getPlugin("RecentChangesCached", false);
1091             $p->box_update(false, $GLOBALS['request'], $this->_pagename);
1092         }
1093         return $newrevision;
1094     }
1095
1096     /**
1097      * Get the most recent revision of a page.
1098      *
1099      * @access public
1100      *
1101      * @return WikiDB_PageRevision The current WikiDB_PageRevision object.
1102      */
1103     function getCurrentRevision($need_content = true)
1104     {
1105         $backend = &$this->_wikidb->_backend;
1106         $cache = &$this->_wikidb->_cache;
1107         $pagename = &$this->_pagename;
1108
1109         // Prevent deadlock in case of memory exhausted errors
1110         // Pure selection doesn't really need locking here.
1111         //   sf.net bug#927395
1112         // I know it would be better to lock, but with lots of pages this deadlock is more
1113         // severe than occasionally get not the latest revision.
1114         // In spirit to wikiwiki: read fast, edit slower.
1115         //$backend->lock();
1116         $version = $cache->get_latest_version($pagename);
1117         // getRevision gets the content also!
1118         $revision = $this->getRevision($version, $need_content);
1119         //$backend->unlock();
1120         assert($revision);
1121         return $revision;
1122     }
1123
1124     /**
1125      * Get a specific revision of a WikiDB_Page.
1126      *
1127      * @access public
1128      *
1129      * @param integer $version Which revision to get.
1130      *
1131      * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or
1132      * false if the requested revision does not exist in the {@link WikiDB}.
1133      * Note that version zero of any page always exists.
1134      */
1135     function getRevision($version, $need_content = true)
1136     {
1137         $cache = &$this->_wikidb->_cache;
1138         $pagename = &$this->_pagename;
1139
1140         if ((!$version) or ($version == 0) or ($version == -1)) { // 0 or false
1141             return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
1142         }
1143
1144         assert($version > 0);
1145         $vdata = $cache->get_versiondata($pagename, $version, $need_content);
1146         if (!$vdata) {
1147             return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
1148         }
1149         return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1150             $vdata);
1151     }
1152
1153     /**
1154      * Get previous page revision.
1155      *
1156      * This method find the most recent revision before a specified
1157      * version.
1158      *
1159      * @access public
1160      *
1161      * @param integer $version Find most recent revision before this version.
1162      *  You can also use a WikiDB_PageRevision object to specify the $version.
1163      *
1164      * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or false if the
1165      * requested revision does not exist in the {@link WikiDB}.  Note that
1166      * unless $version is greater than zero, a revision (perhaps version zero,
1167      * the default revision) will always be found.
1168      */
1169     function getRevisionBefore($version = false, $need_content = true)
1170     {
1171         $backend = &$this->_wikidb->_backend;
1172         $pagename = &$this->_pagename;
1173         if ($version === false)
1174             $version = $this->_wikidb->_cache->get_latest_version($pagename);
1175         else
1176             $version = $this->_coerce_to_version($version);
1177
1178         if ($version == 0)
1179             return false;
1180         //$backend->lock();
1181         $previous = $backend->get_previous_version($pagename, $version);
1182         $revision = $this->getRevision($previous, $need_content);
1183         //$backend->unlock();
1184         assert($revision);
1185         return $revision;
1186     }
1187
1188     /**
1189      * Get all revisions of the WikiDB_Page.
1190      *
1191      * This does not include the version zero (default) revision in the
1192      * returned revision set.
1193      *
1194      * @return WikiDB_PageRevisionIterator A
1195      *   WikiDB_PageRevisionIterator containing all revisions of this
1196      *   WikiDB_Page in reverse order by version number.
1197      */
1198     function getAllRevisions()
1199     {
1200         $backend = &$this->_wikidb->_backend;
1201         $revs = $backend->get_all_revisions($this->_pagename);
1202         return new WikiDB_PageRevisionIterator($this->_wikidb, $revs);
1203     }
1204
1205     /**
1206      * Find pages which link to or are linked from a page.
1207      * relations: $backend->get_links is responsible to add the relation to the pagehash
1208      * as 'linkrelation' key as pagename. See WikiDB_PageIterator::next
1209      *   if (isset($next['linkrelation']))
1210      *
1211      * @access public
1212      *
1213      * @param boolean $reversed Which links to find: true for backlinks (default).
1214      *
1215      * @return WikiDB_PageIterator A WikiDB_PageIterator containing
1216      * all matching pages.
1217      */
1218     function getLinks($reversed = true, $include_empty = false, $sortby = '',
1219                       $limit = '', $exclude = '', $want_relations = false)
1220     {
1221         $backend = &$this->_wikidb->_backend;
1222         $result = $backend->get_links($this->_pagename, $reversed,
1223             $include_empty, $sortby, $limit, $exclude,
1224             $want_relations);
1225         return new WikiDB_PageIterator($this->_wikidb, $result,
1226             array('include_empty' => $include_empty,
1227                 'sortby' => $sortby,
1228                 'limit' => $limit,
1229                 'exclude' => $exclude,
1230                 'want_relations' => $want_relations));
1231     }
1232
1233     /**
1234      * All Links from other pages to this page.
1235      */
1236     function getBackLinks($include_empty = false, $sortby = '', $limit = '', $exclude = '',
1237                           $want_relations = false)
1238     {
1239         return $this->getLinks(true, $include_empty, $sortby, $limit, $exclude);
1240     }
1241
1242     /**
1243      * Forward Links: All Links from this page to other pages.
1244      */
1245     function getPageLinks($include_empty = false, $sortby = '', $limit = '', $exclude = '',
1246                           $want_relations = false)
1247     {
1248         return $this->getLinks(false, $include_empty, $sortby, $limit, $exclude);
1249     }
1250
1251     /**
1252      * Relations: All links from this page to other pages with relation <> 0.
1253      * is_a:=page or population:=number
1254      */
1255     function getRelations($sortby = '', $limit = '', $exclude = '')
1256     {
1257         $backend = &$this->_wikidb->_backend;
1258         $result = $backend->get_links($this->_pagename, false, true,
1259             $sortby, $limit, $exclude,
1260             true);
1261         // we do not care for the linked page versiondata, just the pagename and linkrelation
1262         return new WikiDB_PageIterator($this->_wikidb, $result,
1263             array('include_empty' => true,
1264                 'sortby' => $sortby,
1265                 'limit' => $limit,
1266                 'exclude' => $exclude,
1267                 'want_relations' => true));
1268     }
1269
1270     /**
1271      * possibly faster link existance check. not yet accelerated.
1272      */
1273     function existLink($link, $reversed = false)
1274     {
1275         $backend = &$this->_wikidb->_backend;
1276         if (method_exists($backend, 'exists_link'))
1277             return $backend->exists_link($this->_pagename, $link, $reversed);
1278         //$cache = &$this->_wikidb->_cache;
1279         // TODO: check cache if it is possible
1280         $iter = $this->getLinks($reversed, false);
1281         while ($page = $iter->next()) {
1282             if ($page->getName() == $link)
1283                 return $page;
1284         }
1285         $iter->free();
1286         return false;
1287     }
1288
1289     /* Semantic relations are links with the relation pointing to another page,
1290        the so-called "RDF Triple".
1291        [San Diego] is%20a::city
1292        => "At the page San Diego there is a relation link of 'is a' to the page 'city'."
1293      */
1294
1295     /* Semantic attributes for a page.
1296        [San Diego] population:=1,305,736
1297        Attributes are links with the relation pointing to another page.
1298     */
1299
1300     /**
1301      * Access WikiDB_Page non version-specific meta-data.
1302      *
1303      * @access public
1304      *
1305      * @param string $key Which meta data to get.
1306      * Some reserved meta-data keys are:
1307      * <dl>
1308      * <dt>'date'  <dd> Created as unixtime
1309      * <dt>'locked'<dd> Is page locked? 'yes' or 'no'
1310      * <dt>'hits'  <dd> Page hit counter.
1311      * <dt>'_cached_html' <dd> Transformed CachedMarkup object, serialized + optionally gzipped.
1312      *                         In SQL stored now in an extra column.
1313      * Optional data:
1314      * <dt>'pref'  <dd> Users preferences, stored only in homepages.
1315      * <dt>'owner' <dd> Default: first author_id. We might add a group with a dot here:
1316      *                  E.g. "owner.users"
1317      * <dt>'perm'  <dd> Permission flag to authorize read/write/execution of
1318      *                  page-headers and content.
1319     + <dt>'moderation'<dd> ModeratedPage data. Handled by plugin/ModeratedPage
1320      * <dt>'rating' <dd> Page rating. Handled by plugin/RateIt
1321      * </dl>
1322      *
1323      * @return scalar The requested value, or false if the requested data
1324      * is not set.
1325      */
1326     function get($key)
1327     {
1328         $cache = &$this->_wikidb->_cache;
1329         $backend = &$this->_wikidb->_backend;
1330         if (!$key || $key[0] == '%')
1331             return false;
1332         // several new SQL backends optimize this.
1333         if (!WIKIDB_NOCACHE_MARKUP
1334             and $key == '_cached_html'
1335                 and method_exists($backend, 'get_cached_html')
1336         ) {
1337             return $backend->get_cached_html($this->_pagename);
1338         }
1339         $data = $cache->get_pagedata($this->_pagename);
1340         return isset($data[$key]) ? $data[$key] : false;
1341     }
1342
1343     /**
1344      * Get all the page meta-data as a hash.
1345      *
1346      * @return hash The page meta-data.
1347      */
1348     function getMetaData()
1349     {
1350         $cache = &$this->_wikidb->_cache;
1351         $data = $cache->get_pagedata($this->_pagename);
1352         $meta = array();
1353         foreach ($data as $key => $val) {
1354             if ( /*!empty($val) &&*/
1355                 $key[0] != '%'
1356             )
1357                 $meta[$key] = $val;
1358         }
1359         return $meta;
1360     }
1361
1362     /**
1363      * Set page meta-data.
1364      *
1365      * @see get
1366      * @access public
1367      *
1368      * @param string $key    Meta-data key to set.
1369      * @param string $newval New value.
1370      */
1371     function set($key, $newval)
1372     {
1373         $cache = &$this->_wikidb->_cache;
1374         $backend = &$this->_wikidb->_backend;
1375         $pagename = &$this->_pagename;
1376
1377         assert($key && $key[0] != '%');
1378
1379         // several new SQL backends optimize this.
1380         if (!WIKIDB_NOCACHE_MARKUP
1381             and $key == '_cached_html'
1382                 and method_exists($backend, 'set_cached_html')
1383         ) {
1384             if ($this->_wikidb->readonly) {
1385                 trigger_error("readonly database", E_USER_WARNING);
1386                 return;
1387             }
1388             return $backend->set_cached_html($pagename, $newval);
1389         }
1390
1391         $data = $cache->get_pagedata($pagename);
1392
1393         if (!empty($newval)) {
1394             if (!empty($data[$key]) && $data[$key] == $newval)
1395                 return; // values identical, skip update.
1396         } else {
1397             if (empty($data[$key]))
1398                 return; // values identical, skip update.
1399         }
1400
1401         if (isset($this->_wikidb->readonly) and ($this->_wikidb->readonly)) {
1402             trigger_error("readonly database", E_USER_WARNING);
1403             return;
1404         }
1405         $cache->update_pagedata($pagename, array($key => $newval));
1406     }
1407
1408     /**
1409      * Increase page hit count.
1410      *
1411      * FIXME: IS this needed?  Probably not.
1412      *
1413      * This is a convenience function.
1414      * <pre> $page->increaseHitCount(); </pre>
1415      * is functionally identical to
1416      * <pre> $page->set('hits',$page->get('hits')+1); </pre>
1417      * but less expensive (ignores the pagadata string)
1418      *
1419      * Note that this method may be implemented in more efficient ways
1420      * in certain backends.
1421      *
1422      * @access public
1423      */
1424     function increaseHitCount()
1425     {
1426         if ($this->_wikidb->readonly) {
1427             trigger_error("readonly database", E_USER_NOTICE);
1428             return;
1429         }
1430         if (method_exists($this->_wikidb->_backend, 'increaseHitCount'))
1431             $this->_wikidb->_backend->increaseHitCount($this->_pagename);
1432         else {
1433             @$newhits = $this->get('hits') + 1;
1434             $this->set('hits', $newhits);
1435         }
1436     }
1437
1438     /**
1439      * Return a string representation of the WikiDB_Page
1440      *
1441      * This is really only for debugging.
1442      *
1443      * @access public
1444      *
1445      * @return string Printable representation of the WikiDB_Page.
1446      */
1447     function asString()
1448     {
1449         ob_start();
1450         printf("[%s:%s\n", get_class($this), $this->getName());
1451         print_r($this->getMetaData());
1452         echo "]\n";
1453         $strval = ob_get_contents();
1454         ob_end_clean();
1455         return $strval;
1456     }
1457
1458
1459     /**
1460      * @access private
1461      * @param integer_or_object $version_or_pagerevision
1462      * Takes either the version number (and int) or a WikiDB_PageRevision
1463      * object.
1464      * @return integer The version number.
1465      */
1466     function _coerce_to_version($version_or_pagerevision)
1467     {
1468         if (method_exists($version_or_pagerevision, "getContent"))
1469             $version = $version_or_pagerevision->getVersion();
1470         else
1471             $version = (int)$version_or_pagerevision;
1472
1473         assert($version >= 0);
1474         return $version;
1475     }
1476
1477     function isUserPage($include_empty = true)
1478     {
1479         if (!$include_empty and !$this->exists()) return false;
1480         return $this->get('pref') ? true : false;
1481     }
1482
1483     // May be empty. Either the stored owner (/Chown), or the first authorized author
1484     function getOwner()
1485     {
1486         if ($owner = $this->get('owner'))
1487             return $owner;
1488         // check all revisions forwards for the first author_id
1489         $backend = &$this->_wikidb->_backend;
1490         $pagename = &$this->_pagename;
1491         $latestversion = $backend->get_latest_version($pagename);
1492         for ($v = 1; $v <= $latestversion; $v++) {
1493             $rev = $this->getRevision($v, false);
1494             if ($rev and $owner = $rev->get('author_id')) {
1495                 return $owner;
1496             }
1497         }
1498         return '';
1499     }
1500
1501     // The authenticated author of the first revision or empty if not authenticated then.
1502     function getCreator()
1503     {
1504         if ($current = $this->getRevision(1, false)) return $current->get('author_id');
1505         else return '';
1506     }
1507
1508     // The authenticated author of the current revision.
1509     function getAuthor()
1510     {
1511         if ($current = $this->getCurrentRevision(false)) return $current->get('author_id');
1512         else return '';
1513     }
1514
1515     /* Semantic Web value, not stored in the links.
1516      * todo: unify with some unit knowledge
1517      */
1518     function setAttribute($relation, $value)
1519     {
1520         $attr = $this->get('attributes');
1521         if (empty($attr))
1522             $attr = array($relation => $value);
1523         else
1524             $attr[$relation] = $value;
1525         $this->set('attributes', $attr);
1526     }
1527
1528     function getAttribute($relation)
1529     {
1530         $meta = $this->get('attributes');
1531         if (empty($meta))
1532             return '';
1533         else
1534             return $meta[$relation];
1535     }
1536
1537 }
1538
1539 /**
1540  * This class represents a specific revision of a WikiDB_Page within
1541  * a WikiDB.
1542  *
1543  * A WikiDB_PageRevision has read-only semantics. You may only create
1544  * new revisions (and delete old ones) --- you cannot modify existing
1545  * revisions.
1546  */
1547 class WikiDB_PageRevision
1548 {
1549     //var $_transformedContent = false; // set by WikiDB_Page::save()
1550
1551     function WikiDB_PageRevision(&$wikidb, $pagename, $version,
1552                                  $versiondata = false)
1553     {
1554         $this->_wikidb = &$wikidb;
1555         $this->_pagename = $pagename;
1556         $this->_version = $version;
1557         $this->_data = $versiondata ? $versiondata : array();
1558         $this->_transformedContent = false; // set by WikiDB_Page::save()
1559     }
1560
1561     /**
1562      * Get the WikiDB_Page which this revision belongs to.
1563      *
1564      * @access public
1565      *
1566      * @return WikiDB_Page The WikiDB_Page which this revision belongs to.
1567      */
1568     function getPage()
1569     {
1570         return new WikiDB_Page($this->_wikidb, $this->_pagename);
1571     }
1572
1573     /**
1574      * Get the version number of this revision.
1575      *
1576      * @access public
1577      *
1578      * @return integer The version number of this revision.
1579      */
1580     function getVersion()
1581     {
1582         return $this->_version;
1583     }
1584
1585     /**
1586      * Determine whether this revision has defaulted content.
1587      *
1588      * The default revision (version 0) of each page, as well as any
1589      * pages which are created with empty content have their content
1590      * defaulted to something like:
1591      * <pre>
1592      *   Describe [ThisPage] here.
1593      * </pre>
1594      *
1595      * @access public
1596      *
1597      * @return boolean Returns true if the page has default content.
1598      */
1599     function hasDefaultContents()
1600     {
1601         $data = &$this->_data;
1602         if (!isset($data['%content'])) return true;
1603         if ($data['%content'] === true) return false;
1604         return $data['%content'] === false or $data['%content'] === "";
1605     }
1606
1607     /**
1608      * Get the content as an array of lines.
1609      *
1610      * @access public
1611      *
1612      * @return array An array of lines.
1613      * The lines should contain no trailing white space.
1614      */
1615     function getContent()
1616     {
1617         return explode("\n", $this->getPackedContent());
1618     }
1619
1620     /**
1621      * Get the pagename of the revision.
1622      *
1623      * @access public
1624      *
1625      * @return string pagename.
1626      */
1627     function getPageName()
1628     {
1629         return $this->_pagename;
1630     }
1631
1632     function getName()
1633     {
1634         return $this->_pagename;
1635     }
1636
1637     /**
1638      * Determine whether revision is the latest.
1639      *
1640      * @access public
1641      *
1642      * @return boolean True iff the revision is the latest (most recent) one.
1643      */
1644     function isCurrent()
1645     {
1646         if (!isset($this->_iscurrent)) {
1647             $page = $this->getPage();
1648             $current = $page->getCurrentRevision(false);
1649             $this->_iscurrent = $this->getVersion() == $current->getVersion();
1650         }
1651         return $this->_iscurrent;
1652     }
1653
1654     /**
1655      * Get the transformed content of a page.
1656      *
1657      * @param string $pagetype Override the page-type of the revision.
1658      *
1659      * @return object An XmlContent-like object containing the page transformed
1660      * contents.
1661      */
1662     function getTransformedContent($pagetype_override = false)
1663     {
1664         $backend = &$this->_wikidb->_backend;
1665
1666         if ($pagetype_override) {
1667             // Figure out the normal page-type for this page.
1668             $type = PageType::GetPageType($this->get('pagetype'));
1669             if ($type->getName() == $pagetype_override)
1670                 $pagetype_override = false; // Not really an override...
1671         }
1672
1673         if ($pagetype_override) {
1674             // Overriden page type, don't cache (or check cache).
1675             return new TransformedText($this->getPage(),
1676                 $this->getPackedContent(),
1677                 $this->getMetaData(),
1678                 $pagetype_override);
1679         }
1680
1681         $possibly_cache_results = true;
1682
1683         if (!USECACHE or WIKIDB_NOCACHE_MARKUP) {
1684             if (WIKIDB_NOCACHE_MARKUP == 'purge') {
1685                 // flush cache for this page.
1686                 $page = $this->getPage();
1687                 $page->set('_cached_html', ''); // ignored with !USECACHE
1688             }
1689             $possibly_cache_results = false;
1690         } elseif (USECACHE and !$this->_transformedContent) {
1691             //$backend->lock();
1692             if ($this->isCurrent()) {
1693                 $page = $this->getPage();
1694                 $this->_transformedContent = TransformedText::unpack($page->get('_cached_html'));
1695             } else {
1696                 $possibly_cache_results = false;
1697             }
1698             //$backend->unlock();
1699         }
1700
1701         if (!$this->_transformedContent) {
1702             $this->_transformedContent
1703                 = new TransformedText($this->getPage(),
1704                 $this->getPackedContent(),
1705                 $this->getMetaData());
1706
1707             if ($possibly_cache_results and !WIKIDB_NOCACHE_MARKUP) {
1708                 // If we're still the current version, cache the transfomed page.
1709                 //$backend->lock();
1710                 if ($this->isCurrent()) {
1711                     $page->set('_cached_html', $this->_transformedContent->pack());
1712                 }
1713                 //$backend->unlock();
1714             }
1715         }
1716
1717         return $this->_transformedContent;
1718     }
1719
1720     /**
1721      * Get the content as a string.
1722      *
1723      * @access public
1724      *
1725      * @return string The page content.
1726      * Lines are separated by new-lines.
1727      */
1728     function getPackedContent()
1729     {
1730         $data = &$this->_data;
1731
1732         if (empty($data['%content'])
1733             || (!$this->_wikidb->isWikiPage($this->_pagename)
1734                 && $this->isCurrent())
1735         ) {
1736             include_once 'lib/InlineParser.php';
1737
1738             // A feature similar to taglines at http://www.wlug.org.nz/
1739             // Lib from http://www.aasted.org/quote/
1740             if (defined('FORTUNE_DIR')
1741                 and is_dir(FORTUNE_DIR)
1742                     and in_array($GLOBALS['request']->getArg('action'),
1743                         array('create', 'edit'))
1744             ) {
1745                 include_once 'lib/fortune.php';
1746                 $fortune = new Fortune();
1747                 $quote = $fortune->quoteFromDir(FORTUNE_DIR);
1748                 if ($quote != -1)
1749                     $quote = "<verbatim>\n"
1750                         . str_replace("\n<br>", "\n", $quote)
1751                         . "</verbatim>\n\n";
1752                 else
1753                     $quote = "";
1754                 return $quote
1755                     . sprintf(_("Describe %s here."),
1756                         "[" . WikiEscape($this->_pagename) . "]");
1757             }
1758             // Replace empty content with default value.
1759             return sprintf(_("Describe %s here."),
1760                 "[" . WikiEscape($this->_pagename) . "]");
1761         }
1762
1763         // There is (non-default) content.
1764         assert($this->_version > 0);
1765
1766         if (!is_string($data['%content'])) {
1767             // Content was not provided to us at init time.
1768             // (This is allowed because for some backends, fetching
1769             // the content may be expensive, and often is not wanted
1770             // by the user.)
1771             //
1772             // In any case, now we need to get it.
1773             $data['%content'] = $this->_get_content();
1774             assert(is_string($data['%content']));
1775         }
1776
1777         return $data['%content'];
1778     }
1779
1780     function _get_content()
1781     {
1782         $cache = &$this->_wikidb->_cache;
1783         $pagename = $this->_pagename;
1784         $version = $this->_version;
1785
1786         assert($version > 0);
1787
1788         $newdata = $cache->get_versiondata($pagename, $version, true);
1789         if ($newdata) {
1790             assert(is_string($newdata['%content']));
1791             return $newdata['%content'];
1792         } else {
1793             // else revision has been deleted... What to do?
1794             return __sprintf("Oops! Revision %s of %s seems to have been deleted!",
1795                 $version, $pagename);
1796         }
1797     }
1798
1799     /**
1800      * Get meta-data for this revision.
1801      *
1802      *
1803      * @access public
1804      *
1805      * @param string $key Which meta-data to access.
1806      *
1807      * Some reserved revision meta-data keys are:
1808      * <dl>
1809      * <dt> 'mtime' <dd> Time this revision was created (seconds since midnight Jan 1, 1970.)
1810      *        The 'mtime' meta-value is normally set automatically by the database
1811      *        backend, but it may be specified explicitly when creating a new revision.
1812      * <dt> orig_mtime
1813      *  <dd> To ensure consistency of RecentChanges, the mtimes of the versions
1814      *       of a page must be monotonically increasing.  If an attempt is
1815      *       made to create a new revision with an mtime less than that of
1816      *       the preceeding revision, the new revisions timestamp is force
1817      *       to be equal to that of the preceeding revision.  In that case,
1818      *       the originally requested mtime is preserved in 'orig_mtime'.
1819      * <dt> '_supplanted' <dd> Time this revision ceased to be the most recent.
1820      *        This meta-value is <em>always</em> automatically maintained by the database
1821      *        backend.  (It is set from the 'mtime' meta-value of the superceding
1822      *        revision.)  '_supplanted' has a value of 'false' for the current revision.
1823      *
1824      * FIXME: this could be refactored:
1825      * <dt> author
1826      *  <dd> Author of the page (as he should be reported in, e.g. RecentChanges.)
1827      * <dt> author_id
1828      *  <dd> Authenticated author of a page.  This is used to identify
1829      *       the distinctness of authors when cleaning old revisions from
1830      *       the database.
1831      * <dt> 'is_minor_edit' <dd> Set if change was marked as a minor revision by the author.
1832      * <dt> 'summary' <dd> Short change summary entered by page author.
1833      * </dl>
1834      *
1835      * Meta-data keys must be valid C identifers (they have to start with a letter
1836      * or underscore, and can contain only alphanumerics and underscores.)
1837      *
1838      * @return string The requested value, or false if the requested value
1839      * is not defined.
1840      */
1841     function get($key)
1842     {
1843         if (!$key || $key[0] == '%')
1844             return false;
1845         $data = &$this->_data;
1846         return isset($data[$key]) ? $data[$key] : false;
1847     }
1848
1849     /**
1850      * Get all the revision page meta-data as a hash.
1851      *
1852      * @return hash The revision meta-data.
1853      */
1854     function getMetaData()
1855     {
1856         $meta = array();
1857         foreach ($this->_data as $key => $val) {
1858             if (!empty($val) && $key[0] != '%')
1859                 $meta[$key] = $val;
1860         }
1861         return $meta;
1862     }
1863
1864
1865     /**
1866      * Return a string representation of the revision.
1867      *
1868      * This is really only for debugging.
1869      *
1870      * @access public
1871      *
1872      * @return string Printable representation of the WikiDB_Page.
1873      */
1874     function asString()
1875     {
1876         ob_start();
1877         printf("[%s:%d\n", get_class($this), $this->get('version'));
1878         print_r($this->_data);
1879         echo $this->getPackedContent() . "\n]\n";
1880         $strval = ob_get_contents();
1881         ob_end_clean();
1882         return $strval;
1883     }
1884 }
1885
1886 /**
1887  * Class representing a sequence of WikiDB_Pages.
1888  * TODO: Enhance to php5 iterators
1889  * TODO:
1890  *   apply filters for options like 'sortby', 'limit', 'exclude'
1891  *   for simple queries like titleSearch, where the backend is not ready yet.
1892  */
1893 class WikiDB_PageIterator
1894 {
1895     function WikiDB_PageIterator(&$wikidb, &$iter, $options = false)
1896     {
1897         $this->_iter = $iter; // a WikiDB_backend_iterator
1898         $this->_wikidb = &$wikidb;
1899         $this->_options = $options;
1900     }
1901
1902     function count()
1903     {
1904         return $this->_iter->count();
1905     }
1906
1907     function limit()
1908     {
1909         return empty($this->_options['limit']) ? 0 : $this->_options['limit'];
1910     }
1911
1912     /**
1913      * Get next WikiDB_Page in sequence.
1914      *
1915      * @access public
1916      *
1917      * @return WikiDB_Page The next WikiDB_Page in the sequence.
1918      */
1919     function next()
1920     {
1921         if (!($next = $this->_iter->next())) {
1922             return false;
1923         }
1924
1925         $pagename = &$next['pagename'];
1926         if (!is_string($pagename)) { // Bug #1327912 fixed by Joachim Lous
1927             trigger_error("WikiDB_PageIterator->next pagename", E_USER_WARNING);
1928         }
1929
1930         if (!$pagename) {
1931             if (isset($next['linkrelation'])
1932                 or isset($next['pagedata']['linkrelation'])
1933             ) {
1934                 return false;
1935             }
1936         }
1937
1938         // There's always hits, but we cache only if more
1939         // (well not with file, cvs and dba)
1940         if (isset($next['pagedata']) and count($next['pagedata']) > 1) {
1941             $this->_wikidb->_cache->cache_data($next);
1942             // cache existing page id's since we iterate over all links in GleanDescription
1943             // and need them later for LinkExistingWord
1944         } elseif ($this->_options and array_key_exists('include_empty', $this->_options)
1945             and !$this->_options['include_empty'] and isset($next['id'])
1946         ) {
1947             $this->_wikidb->_cache->_id_cache[$next['pagename']] = $next['id'];
1948         }
1949         $page = new WikiDB_Page($this->_wikidb, $pagename);
1950         if (isset($next['linkrelation']))
1951             $page->set('linkrelation', $next['linkrelation']);
1952         if (isset($next['score']))
1953             $page->score = $next['score'];
1954         return $page;
1955     }
1956
1957     /**
1958      * Release resources held by this iterator.
1959      *
1960      * The iterator may not be used after free() is called.
1961      *
1962      * There is no need to call free(), if next() has returned false.
1963      * (I.e. if you iterate through all the pages in the sequence,
1964      * you do not need to call free() --- you only need to call it
1965      * if you stop before the end of the iterator is reached.)
1966      *
1967      * @access public
1968      */
1969     function free()
1970     {
1971         $this->_iter->free();
1972     }
1973
1974     function reset()
1975     {
1976         $this->_iter->reset();
1977     }
1978
1979     function asArray()
1980     {
1981         $result = array();
1982         while ($page = $this->next())
1983             $result[] = $page;
1984         $this->reset();
1985         return $result;
1986     }
1987
1988     /**
1989      * Apply filters for options like 'sortby', 'limit', 'exclude'
1990      * for simple queries like titleSearch, where the backend is not ready yet.
1991      * Since iteration is usually destructive for SQL results,
1992      * we have to generate a copy.
1993      */
1994     function applyFilters($options = false)
1995     {
1996         if (!$options) $options = $this->_options;
1997         if (isset($options['sortby'])) {
1998             $array = array();
1999             /* this is destructive */
2000             while ($page = $this->next())
2001                 $result[] = $page->getName();
2002             $this->_doSort($array, $options['sortby']);
2003         }
2004         /* the rest is not destructive.
2005          * reconstruct a new iterator
2006          */
2007         $pagenames = array();
2008         $i = 0;
2009         if (isset($options['limit']))
2010             $limit = $options['limit'];
2011         else
2012             $limit = 0;
2013         if (isset($options['exclude']))
2014             $exclude = $options['exclude'];
2015         if (is_string($exclude) and !is_array($exclude))
2016             $exclude = PageList::explodePageList($exclude, false, false, $limit);
2017         foreach ($array as $pagename) {
2018             if ($limit and $i++ > $limit)
2019                 return new WikiDB_Array_PageIterator($pagenames);
2020             if (!empty($exclude) and !in_array($pagename, $exclude))
2021                 $pagenames[] = $pagename;
2022             elseif (empty($exclude))
2023                 $pagenames[] = $pagename;
2024         }
2025         return new WikiDB_Array_PageIterator($pagenames);
2026     }
2027
2028     /* pagename only */
2029     function _doSort(&$array, $sortby)
2030     {
2031         $sortby = PageList::sortby($sortby, 'init');
2032         if ($sortby == '+pagename')
2033             sort($array, SORT_STRING);
2034         elseif ($sortby == '-pagename')
2035             rsort($array, SORT_STRING);
2036         reset($array);
2037     }
2038
2039 }
2040
2041 /**
2042  * A class which represents a sequence of WikiDB_PageRevisions.
2043  * TODO: Enhance to php5 iterators
2044  */
2045 class WikiDB_PageRevisionIterator
2046 {
2047     function WikiDB_PageRevisionIterator(&$wikidb, &$revisions, $options = false)
2048     {
2049         $this->_revisions = $revisions;
2050         $this->_wikidb = &$wikidb;
2051         $this->_options = $options;
2052     }
2053
2054     function count()
2055     {
2056         return $this->_revisions->count();
2057     }
2058
2059     /**
2060      * Get next WikiDB_PageRevision in sequence.
2061      *
2062      * @access public
2063      *
2064      * @return WikiDB_PageRevision
2065      * The next WikiDB_PageRevision in the sequence.
2066      */
2067     function next()
2068     {
2069         if (!($next = $this->_revisions->next()))
2070             return false;
2071
2072         //$this->_wikidb->_cache->cache_data($next);
2073
2074         $pagename = $next['pagename'];
2075         $version = $next['version'];
2076         $versiondata = $next['versiondata'];
2077         if ((int)DEBUG) {
2078             if (!(is_string($pagename) and $pagename != '')) {
2079                 trigger_error("empty pagename", E_USER_WARNING);
2080                 return false;
2081             }
2082         } else assert(is_string($pagename) and $pagename != '');
2083         if ((int)DEBUG) {
2084             if (!is_array($versiondata)) {
2085                 trigger_error("empty versiondata", E_USER_WARNING);
2086                 return false;
2087             }
2088         } else assert(is_array($versiondata));
2089         if ((int)DEBUG) {
2090             if (!($version > 0)) {
2091                 trigger_error("invalid version", E_USER_WARNING);
2092                 return false;
2093             }
2094         } else assert($version > 0);
2095
2096         return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
2097             $versiondata);
2098     }
2099
2100     /**
2101      * Release resources held by this iterator.
2102      *
2103      * The iterator may not be used after free() is called.
2104      *
2105      * There is no need to call free(), if next() has returned false.
2106      * (I.e. if you iterate through all the revisions in the sequence,
2107      * you do not need to call free() --- you only need to call it
2108      * if you stop before the end of the iterator is reached.)
2109      *
2110      * @access public
2111      */
2112     function free()
2113     {
2114         $this->_revisions->free();
2115     }
2116
2117     function asArray()
2118     {
2119         $result = array();
2120         while ($rev = $this->next())
2121             $result[] = $rev;
2122         $this->free();
2123         return $result;
2124     }
2125 }
2126
2127 /** pseudo iterator
2128  */
2129 class WikiDB_Array_PageIterator
2130 {
2131     function WikiDB_Array_PageIterator($pagenames)
2132     {
2133         global $request;
2134         $this->_dbi = $request->getDbh();
2135         $this->_pages = $pagenames;
2136         reset($this->_pages);
2137     }
2138
2139     function next()
2140     {
2141         $c = current($this->_pages);
2142         next($this->_pages);
2143         return $c !== false ? $this->_dbi->getPage($c) : false;
2144     }
2145
2146     function count()
2147     {
2148         return count($this->_pages);
2149     }
2150
2151     function reset()
2152     {
2153         reset($this->_pages);
2154     }
2155
2156     function free()
2157     {
2158     }
2159
2160     function asArray()
2161     {
2162         reset($this->_pages);
2163         return $this->_pages;
2164     }
2165 }
2166
2167 class WikiDB_Array_generic_iter
2168 {
2169     function WikiDB_Array_generic_iter($result)
2170     {
2171         // $result may be either an array or a query result
2172         if (is_array($result)) {
2173             $this->_array = $result;
2174         } elseif (is_object($result)) {
2175             $this->_array = $result->asArray();
2176         } else {
2177             $this->_array = array();
2178         }
2179         if (!empty($this->_array))
2180             reset($this->_array);
2181     }
2182
2183     function next()
2184     {
2185         $c = current($this->_array);
2186         next($this->_array);
2187         return $c !== false ? $c : false;
2188     }
2189
2190     function count()
2191     {
2192         return count($this->_array);
2193     }
2194
2195     function reset()
2196     {
2197         reset($this->_array);
2198     }
2199
2200     function free()
2201     {
2202     }
2203
2204     function asArray()
2205     {
2206         if (!empty($this->_array))
2207             reset($this->_array);
2208         return $this->_array;
2209     }
2210 }
2211
2212 /**
2213  * Data cache used by WikiDB.
2214  *
2215  * FIXME: Maybe rename this to caching_backend (or some such).
2216  *
2217  * @access private
2218  */
2219 class WikiDB_cache
2220 {
2221     // FIXME: beautify versiondata cache.  Cache only limited data?
2222
2223     function WikiDB_cache(&$backend)
2224     {
2225         $this->_backend = &$backend;
2226
2227         $this->_pagedata_cache = array();
2228         $this->_versiondata_cache = array();
2229         array_push($this->_versiondata_cache, array());
2230         $this->_glv_cache = array();
2231         $this->_id_cache = array(); // formerly ->_dbi->_iwpcache (nonempty pages => id)
2232
2233         if (isset($GLOBALS['request']->_dbi))
2234             $this->readonly = $GLOBALS['request']->_dbi->readonly;
2235     }
2236
2237     function close()
2238     {
2239         $this->_pagedata_cache = array();
2240         $this->_versiondata_cache = array();
2241         $this->_glv_cache = array();
2242         $this->_id_cache = array();
2243     }
2244
2245     function get_pagedata($pagename)
2246     {
2247         assert(is_string($pagename) && $pagename != '');
2248         if (USECACHE) {
2249             $cache = &$this->_pagedata_cache;
2250             if (!isset($cache[$pagename]) || !is_array($cache[$pagename])) {
2251                 $cache[$pagename] = $this->_backend->get_pagedata($pagename);
2252                 if (empty($cache[$pagename]))
2253                     $cache[$pagename] = array();
2254             }
2255             return $cache[$pagename];
2256         } else {
2257             return $this->_backend->get_pagedata($pagename);
2258         }
2259     }
2260
2261     function update_pagedata($pagename, $newdata)
2262     {
2263         assert(is_string($pagename) && $pagename != '');
2264         if (!empty($this->readonly)) {
2265             trigger_error("readonly database", E_USER_WARNING);
2266             return;
2267         }
2268
2269         $this->_backend->update_pagedata($pagename, $newdata);
2270
2271         if (USECACHE) {
2272             if (!empty($this->_pagedata_cache[$pagename])
2273                 and is_array($this->_pagedata_cache[$pagename])
2274             ) {
2275                 $cachedata = &$this->_pagedata_cache[$pagename];
2276                 foreach ($newdata as $key => $val)
2277                     $cachedata[$key] = $val;
2278             } else
2279                 $this->_pagedata_cache[$pagename] = $newdata;
2280         }
2281     }
2282
2283     function invalidate_cache($pagename)
2284     {
2285         unset ($this->_pagedata_cache[$pagename]);
2286         unset ($this->_versiondata_cache[$pagename]);
2287         unset ($this->_glv_cache[$pagename]);
2288         unset ($this->_id_cache[$pagename]);
2289         //unset ($this->_backend->_page_data);
2290     }
2291
2292     function delete_page($pagename)
2293     {
2294         if (!empty($this->readonly)) {
2295             trigger_error("readonly database", E_USER_WARNING);
2296             return;
2297         }
2298         $result = $this->_backend->delete_page($pagename);
2299         $this->invalidate_cache($pagename);
2300         return $result;
2301     }
2302
2303     function purge_page($pagename)
2304     {
2305         if (!empty($this->readonly)) {
2306             trigger_error("readonly database", E_USER_WARNING);
2307             return;
2308         }
2309         $result = $this->_backend->purge_page($pagename);
2310         $this->invalidate_cache($pagename);
2311         return $result;
2312     }
2313
2314     // FIXME: ugly and wrong. may overwrite full cache with partial cache
2315     function cache_data($data)
2316     {
2317         ;
2318         //if (isset($data['pagedata']))
2319         //    $this->_pagedata_cache[$data['pagename']] = $data['pagedata'];
2320     }
2321
2322     function get_versiondata($pagename, $version, $need_content = false)
2323     {
2324         //  FIXME: Seriously ugly hackage
2325         $readdata = false;
2326         if (USECACHE) { //temporary - for debugging
2327             assert(is_string($pagename) && $pagename != '');
2328             // There is a bug here somewhere which results in an assertion failure at line 105
2329             // of ArchiveCleaner.php  It goes away if we use the next line.
2330             //$need_content = true;
2331             $nc = $need_content ? '1' : '0';
2332             $cache = &$this->_versiondata_cache;
2333             if (!isset($cache[$pagename][$version][$nc])
2334                 || !(is_array($cache[$pagename]))
2335                 || !(is_array($cache[$pagename][$version]))
2336             ) {
2337                 $cache[$pagename][$version][$nc] =
2338                     $this->_backend->get_versiondata($pagename, $version, $need_content);
2339                 $readdata = true;
2340                 // If we have retrieved all data, we may as well set the cache for
2341                 // $need_content = false
2342                 if ($need_content) {
2343                     $cache[$pagename][$version]['0'] =& $cache[$pagename][$version]['1'];
2344                 }
2345             }
2346             $vdata = $cache[$pagename][$version][$nc];
2347         } else {
2348             $vdata = $this->_backend->get_versiondata($pagename, $version, $need_content);
2349             $readdata = true;
2350         }
2351         if ($readdata && is_array($vdata) && !empty($vdata['%pagedata'])) {
2352             if (empty($this->_pagedata_cache))
2353                 $this->_pagedata_cache = array();
2354             /* 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 */
2355             $this->_pagedata_cache[$pagename] = $vdata['%pagedata'];
2356         }
2357         return $vdata;
2358     }
2359
2360     function set_versiondata($pagename, $version, $data)
2361     {
2362         //unset($this->_versiondata_cache[$pagename][$version]);
2363
2364         if (!empty($this->readonly)) {
2365             trigger_error("readonly database", E_USER_WARNING);
2366             return;
2367         }
2368         $new = $this->_backend->set_versiondata($pagename, $version, $data);
2369         // Update the cache
2370         $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2371         $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2372         // Is this necessary?
2373         unset($this->_glv_cache[$pagename]);
2374     }
2375
2376     function update_versiondata($pagename, $version, $data)
2377     {
2378         if (!empty($this->readonly)) {
2379             trigger_error("readonly database", E_USER_WARNING);
2380             return;
2381         }
2382         $new = $this->_backend->update_versiondata($pagename, $version, $data);
2383         // Update the cache
2384         $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2385         // FIXME: hack
2386         $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2387         // Is this necessary?
2388         unset($this->_glv_cache[$pagename]);
2389     }
2390
2391     function delete_versiondata($pagename, $version)
2392     {
2393         if (!empty($this->readonly)) {
2394             trigger_error("readonly database", E_USER_WARNING);
2395             return;
2396         }
2397         $new = $this->_backend->delete_versiondata($pagename, $version);
2398         if (isset($this->_versiondata_cache[$pagename][$version]))
2399             unset ($this->_versiondata_cache[$pagename][$version]);
2400         // dirty latest version cache only if latest version gets deleted
2401         if (isset($this->_glv_cache[$pagename]) and $this->_glv_cache[$pagename] == $version)
2402             unset ($this->_glv_cache[$pagename]);
2403     }
2404
2405     function get_latest_version($pagename)
2406     {
2407         if (USECACHE) {
2408             assert(is_string($pagename) && $pagename != '');
2409             $cache = &$this->_glv_cache;
2410             if (!isset($cache[$pagename])) {
2411                 $cache[$pagename] = $this->_backend->get_latest_version($pagename);
2412                 if (empty($cache[$pagename]))
2413                     $cache[$pagename] = 0;
2414             }
2415             return $cache[$pagename];
2416         } else {
2417             return $this->_backend->get_latest_version($pagename);
2418         }
2419     }
2420 }
2421
2422 function _sql_debuglog($msg, $newline = true, $shutdown = false)
2423 {
2424     static $fp = false;
2425     static $i = 0;
2426     if (!$fp) {
2427         $stamp = strftime("%y%m%d-%H%M%S");
2428         $fp = fopen(TEMP_DIR . "/sql-$stamp.log", "a");
2429         register_shutdown_function("_sql_debuglog_shutdown_function");
2430     } elseif ($shutdown) {
2431         fclose($fp);
2432         return;
2433     }
2434     if ($newline) fputs($fp, "[$i++] $msg");
2435     else fwrite($fp, $msg);
2436 }
2437
2438 function _sql_debuglog_shutdown_function()
2439 {
2440     _sql_debuglog('', false, true);
2441 }
2442
2443 // Local Variables:
2444 // mode: php
2445 // tab-width: 8
2446 // c-basic-offset: 4
2447 // c-hanging-comment-ender-p: nil
2448 // indent-tabs-mode: nil
2449 // End: