lib/WikiDB.php

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