lib/WikiDB.php

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