lib/WikiDB.php

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