lib/WikiDB.php

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