]> CyberLeo.Net >> Repos - SourceForge/phpwiki.git/blob - lib/WikiDB.php
Use TEMP_DIR for debug sql.log
[SourceForge/phpwiki.git] / lib / WikiDB.php
1 <?php //-*-php-*-
2 rcs_id('$Id: WikiDB.php,v 1.148 2007-01-27 21:53:03 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) 
992                 and is_array($notify) 
993                 and !isa($GLOBALS['request'],'MockRequest')) 
994             {
995                 include_once("lib/MailNotify.php");
996                 $MailNotify = new MailNotify($newrevision->getName());
997                 $MailNotify->onChangePage ($this, $wikitext, $version, $meta);
998             }
999             $newrevision->_transformedContent = $formatted;
1000         }
1001
1002         return $newrevision;
1003     }
1004
1005     /**
1006      * Get the most recent revision of a page.
1007      *
1008      * @access public
1009      *
1010      * @return WikiDB_PageRevision The current WikiDB_PageRevision object. 
1011      */
1012     function getCurrentRevision ($need_content=true) {
1013         $backend = &$this->_wikidb->_backend;
1014         $cache = &$this->_wikidb->_cache;
1015         $pagename = &$this->_pagename;
1016         
1017         // Prevent deadlock in case of memory exhausted errors
1018         // Pure selection doesn't really need locking here.
1019         //   sf.net bug#927395
1020         // I know it would be better to lock, but with lots of pages this deadlock is more 
1021         // severe than occasionally get not the latest revision.
1022         // In spirit to wikiwiki: read fast, edit slower.
1023         //$backend->lock();
1024         $version = $cache->get_latest_version($pagename);
1025         // getRevision gets the content also!
1026         $revision = $this->getRevision($version, $need_content);
1027         //$backend->unlock();
1028         assert($revision);
1029         return $revision;
1030     }
1031
1032     /**
1033      * Get a specific revision of a WikiDB_Page.
1034      *
1035      * @access public
1036      *
1037      * @param integer $version  Which revision to get.
1038      *
1039      * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or
1040      * false if the requested revision does not exist in the {@link WikiDB}.
1041      * Note that version zero of any page always exists.
1042      */
1043     function getRevision ($version, $need_content=true) {
1044         $cache = &$this->_wikidb->_cache;
1045         $pagename = &$this->_pagename;
1046         
1047         if (! $version or $version == -1) // 0 or false
1048             return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
1049
1050         assert($version > 0);
1051         $vdata = $cache->get_versiondata($pagename, $version, $need_content);
1052         if (!$vdata) {
1053             return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
1054         }
1055         return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1056                                        $vdata);
1057     }
1058
1059     /**
1060      * Get previous page revision.
1061      *
1062      * This method find the most recent revision before a specified
1063      * version.
1064      *
1065      * @access public
1066      *
1067      * @param integer $version  Find most recent revision before this version.
1068      *  You can also use a WikiDB_PageRevision object to specify the $version.
1069      *
1070      * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or false if the
1071      * requested revision does not exist in the {@link WikiDB}.  Note that
1072      * unless $version is greater than zero, a revision (perhaps version zero,
1073      * the default revision) will always be found.
1074      */
1075     function getRevisionBefore ($version=false, $need_content=true) {
1076         $backend = &$this->_wikidb->_backend;
1077         $pagename = &$this->_pagename;
1078         if ($version === false)
1079             $version = $this->_wikidb->_cache->get_latest_version($pagename);
1080         else
1081             $version = $this->_coerce_to_version($version);
1082
1083         if ($version == 0)
1084             return false;
1085         //$backend->lock();
1086         $previous = $backend->get_previous_version($pagename, $version);
1087         $revision = $this->getRevision($previous, $need_content);
1088         //$backend->unlock();
1089         assert($revision);
1090         return $revision;
1091     }
1092
1093     /**
1094      * Get all revisions of the WikiDB_Page.
1095      *
1096      * This does not include the version zero (default) revision in the
1097      * returned revision set.
1098      *
1099      * @return WikiDB_PageRevisionIterator A
1100      *   WikiDB_PageRevisionIterator containing all revisions of this
1101      *   WikiDB_Page in reverse order by version number.
1102      */
1103     function getAllRevisions() {
1104         $backend = &$this->_wikidb->_backend;
1105         $revs = $backend->get_all_revisions($this->_pagename);
1106         return new WikiDB_PageRevisionIterator($this->_wikidb, $revs);
1107     }
1108     
1109     /**
1110      * Find pages which link to or are linked from a page.
1111      * relations: $backend->get_links is responsible to add the relation to the pagehash 
1112      * as 'linkrelation' key as pagename. See WikiDB_PageIterator::next 
1113      *   if (isset($next['linkrelation']))
1114      *
1115      * @access public
1116      *
1117      * @param boolean $reversed Which links to find: true for backlinks (default).
1118      *
1119      * @return WikiDB_PageIterator A WikiDB_PageIterator containing
1120      * all matching pages.
1121      */
1122     function getLinks ($reversed=true, $include_empty=false, $sortby='', 
1123                        $limit='', $exclude='', $want_relations=false) 
1124     {
1125         $backend = &$this->_wikidb->_backend;
1126         $result =  $backend->get_links($this->_pagename, $reversed, 
1127                                        $include_empty, $sortby, $limit, $exclude,
1128                                        $want_relations);
1129         return new WikiDB_PageIterator($this->_wikidb, $result, 
1130                                        array('include_empty' => $include_empty,
1131                                              'sortby'        => $sortby, 
1132                                              'limit'         => $limit, 
1133                                              'exclude'       => $exclude,
1134                                              'want_relations'=> $want_relations));
1135     }
1136
1137     /**
1138      * All Links from other pages to this page.
1139      */
1140     function getBackLinks($include_empty=false, $sortby='', $limit='', $exclude='', 
1141                           $want_relations=false) 
1142     {
1143         return $this->getLinks(true, $include_empty, $sortby, $limit, $exclude);
1144     }
1145     /**
1146      * Forward Links: All Links from this page to other pages.
1147      */
1148     function getPageLinks($include_empty=false, $sortby='', $limit='', $exclude='', 
1149                           $want_relations=false) 
1150     {
1151         return $this->getLinks(false, $include_empty, $sortby, $limit, $exclude);
1152     }
1153     /**
1154      * Relations: All links from this page to other pages with relation <> 0. 
1155      * is_a:=page or population:=number
1156      */
1157     function getRelations($sortby='', $limit='', $exclude='') {
1158         $backend = &$this->_wikidb->_backend;
1159         $result =  $backend->get_links($this->_pagename, false, true,
1160                                        $sortby, $limit, $exclude, 
1161                                        true);
1162         // we do not care for the linked page versiondata, just the pagename and linkrelation
1163         return new WikiDB_PageIterator($this->_wikidb, $result, 
1164                                        array('include_empty' => true,
1165                                              'sortby'        => $sortby, 
1166                                              'limit'         => $limit, 
1167                                              'exclude'       => $exclude,
1168                                              'want_relations'=> true));
1169     }
1170     
1171     /**
1172      * possibly faster link existance check. not yet accelerated.
1173      */
1174     function existLink($link, $reversed=false) {
1175         $backend = &$this->_wikidb->_backend;
1176         if (method_exists($backend,'exists_link'))
1177             return $backend->exists_link($this->_pagename, $link, $reversed);
1178         //$cache = &$this->_wikidb->_cache;
1179         // TODO: check cache if it is possible
1180         $iter = $this->getLinks($reversed, false);
1181         while ($page = $iter->next()) {
1182             if ($page->getName() == $link)
1183                 return $page;
1184         }
1185         $iter->free();
1186         return false;
1187     }
1188
1189     /* Semantic relations are links with the relation pointing to another page,
1190        the so-called "RDF Triple".
1191        [San Diego] is%20a::city
1192        => "At the page San Diego there is a relation link of 'is a' to the page 'city'."
1193      */
1194
1195     /* Semantic attributes for a page. 
1196        [San Diego] population:=1,305,736
1197        Attributes are links with the relation pointing to another page.
1198     */
1199             
1200     /**
1201      * Access WikiDB_Page non version-specific meta-data.
1202      *
1203      * @access public
1204      *
1205      * @param string $key Which meta data to get.
1206      * Some reserved meta-data keys are:
1207      * <dl>
1208      * <dt>'date'  <dd> Created as unixtime
1209      * <dt>'locked'<dd> Is page locked? 'yes' or 'no'
1210      * <dt>'hits'  <dd> Page hit counter.
1211      * <dt>'_cached_html' <dd> Transformed CachedMarkup object, serialized + optionally gzipped.
1212      *                         In SQL stored now in an extra column.
1213      * Optional data:
1214      * <dt>'pref'  <dd> Users preferences, stored only in homepages.
1215      * <dt>'owner' <dd> Default: first author_id. We might add a group with a dot here:
1216      *                  E.g. "owner.users"
1217      * <dt>'perm'  <dd> Permission flag to authorize read/write/execution of 
1218      *                  page-headers and content.
1219      + <dt>'moderation'<dd> ModeratedPage data
1220      * <dt>'score' <dd> Page score (not yet implement, do we need?)
1221      * </dl>
1222      *
1223      * @return scalar The requested value, or false if the requested data
1224      * is not set.
1225      */
1226     function get($key) {
1227         $cache = &$this->_wikidb->_cache;
1228         $backend = &$this->_wikidb->_backend;
1229         if (!$key || $key[0] == '%')
1230             return false;
1231         // several new SQL backends optimize this.
1232         if (!WIKIDB_NOCACHE_MARKUP
1233             and $key == '_cached_html' 
1234             and method_exists($backend, 'get_cached_html')) 
1235         {
1236             return $backend->get_cached_html($this->_pagename);
1237         }
1238         $data = $cache->get_pagedata($this->_pagename);
1239         return isset($data[$key]) ? $data[$key] : false;
1240     }
1241
1242     /**
1243      * Get all the page meta-data as a hash.
1244      *
1245      * @return hash The page meta-data.
1246      */
1247     function getMetaData() {
1248         $cache = &$this->_wikidb->_cache;
1249         $data = $cache->get_pagedata($this->_pagename);
1250         $meta = array();
1251         foreach ($data as $key => $val) {
1252             if (/*!empty($val) &&*/ $key[0] != '%')
1253                 $meta[$key] = $val;
1254         }
1255         return $meta;
1256     }
1257
1258     /**
1259      * Set page meta-data.
1260      *
1261      * @see get
1262      * @access public
1263      *
1264      * @param string $key  Meta-data key to set.
1265      * @param string $newval  New value.
1266      */
1267     function set($key, $newval) {
1268         $cache = &$this->_wikidb->_cache;
1269         $backend = &$this->_wikidb->_backend;
1270         $pagename = &$this->_pagename;
1271         
1272         assert($key && $key[0] != '%');
1273
1274         // several new SQL backends optimize this.
1275         if (!WIKIDB_NOCACHE_MARKUP 
1276             and $key == '_cached_html' 
1277             and method_exists($backend, 'set_cached_html'))
1278         {
1279             return $backend->set_cached_html($pagename, $newval);
1280         }
1281
1282         $data = $cache->get_pagedata($pagename);
1283
1284         if (!empty($newval)) {
1285             if (!empty($data[$key]) && $data[$key] == $newval)
1286                 return;         // values identical, skip update.
1287         }
1288         else {
1289             if (empty($data[$key]))
1290                 return;         // values identical, skip update.
1291         }
1292
1293         $cache->update_pagedata($pagename, array($key => $newval));
1294     }
1295
1296     /**
1297      * Increase page hit count.
1298      *
1299      * FIXME: IS this needed?  Probably not.
1300      *
1301      * This is a convenience function.
1302      * <pre> $page->increaseHitCount(); </pre>
1303      * is functionally identical to
1304      * <pre> $page->set('hits',$page->get('hits')+1); </pre>
1305      * but less expensive (ignores the pagadata string)
1306      *
1307      * Note that this method may be implemented in more efficient ways
1308      * in certain backends.
1309      *
1310      * @access public
1311      */
1312     function increaseHitCount() {
1313         if (method_exists($this->_wikidb->_backend, 'increaseHitCount'))
1314             $this->_wikidb->_backend->increaseHitCount($this->_pagename);
1315         else {
1316             @$newhits = $this->get('hits') + 1;
1317             $this->set('hits', $newhits);
1318         }
1319     }
1320
1321     /**
1322      * Return a string representation of the WikiDB_Page
1323      *
1324      * This is really only for debugging.
1325      *
1326      * @access public
1327      *
1328      * @return string Printable representation of the WikiDB_Page.
1329      */
1330     function asString () {
1331         ob_start();
1332         printf("[%s:%s\n", get_class($this), $this->getName());
1333         print_r($this->getMetaData());
1334         echo "]\n";
1335         $strval = ob_get_contents();
1336         ob_end_clean();
1337         return $strval;
1338     }
1339
1340
1341     /**
1342      * @access private
1343      * @param integer_or_object $version_or_pagerevision
1344      * Takes either the version number (and int) or a WikiDB_PageRevision
1345      * object.
1346      * @return integer The version number.
1347      */
1348     function _coerce_to_version($version_or_pagerevision) {
1349         if (method_exists($version_or_pagerevision, "getContent"))
1350             $version = $version_or_pagerevision->getVersion();
1351         else
1352             $version = (int) $version_or_pagerevision;
1353
1354         assert($version >= 0);
1355         return $version;
1356     }
1357
1358     function isUserPage ($include_empty = true) {
1359         if (!$include_empty and !$this->exists()) return false;
1360         return $this->get('pref') ? true : false;
1361     }
1362
1363     // May be empty. Either the stored owner (/Chown), or the first authorized author
1364     function getOwner() {
1365         if ($owner = $this->get('owner'))
1366             return ($owner == _("The PhpWiki programming team")) ? ADMIN_USER : $owner;
1367         // check all revisions forwards for the first author_id
1368         $backend = &$this->_wikidb->_backend;
1369         $pagename = &$this->_pagename;
1370         $latestversion = $backend->get_latest_version($pagename);
1371         for ($v=1; $v <= $latestversion; $v++) {
1372             $rev = $this->getRevision($v,false);
1373             if ($rev and $owner = $rev->get('author_id')) {
1374                 return ($owner == _("The PhpWiki programming team")) ? ADMIN_USER : $owner;
1375             }
1376         }
1377         return '';
1378     }
1379
1380     // The authenticated author of the first revision or empty if not authenticated then.
1381     function getCreator() {
1382         if ($current = $this->getRevision(1,false)) return $current->get('author_id');
1383         else return '';
1384     }
1385
1386     // The authenticated author of the current revision.
1387     function getAuthor() {
1388         if ($current = $this->getCurrentRevision(false)) return $current->get('author_id');
1389         else return '';
1390     }
1391
1392     /* Semantic Web value, not stored in the links
1393      * todo: unify with some unit knowledge
1394      */
1395     function setAttribute($relation, $value) {
1396         $attr = $this->get('attributes');
1397         if (empty($attr))
1398             $attr = array($relation => $value);
1399         else
1400             $attr[$relation] = $value;
1401         $this->set('attributes', $attr);
1402     }
1403
1404 };
1405
1406 /**
1407  * This class represents a specific revision of a WikiDB_Page within
1408  * a WikiDB.
1409  *
1410  * A WikiDB_PageRevision has read-only semantics. You may only create
1411  * new revisions (and delete old ones) --- you cannot modify existing
1412  * revisions.
1413  */
1414 class WikiDB_PageRevision
1415 {
1416     //var $_transformedContent = false; // set by WikiDB_Page::save()
1417     
1418     function WikiDB_PageRevision(&$wikidb, $pagename, $version, $versiondata = false) {
1419         $this->_wikidb = &$wikidb;
1420         $this->_pagename = $pagename;
1421         $this->_version = $version;
1422         $this->_data = $versiondata ? $versiondata : array();
1423         $this->_transformedContent = false; // set by WikiDB_Page::save()
1424     }
1425     
1426     /**
1427      * Get the WikiDB_Page which this revision belongs to.
1428      *
1429      * @access public
1430      *
1431      * @return WikiDB_Page The WikiDB_Page which this revision belongs to.
1432      */
1433     function getPage() {
1434         return new WikiDB_Page($this->_wikidb, $this->_pagename);
1435     }
1436
1437     /**
1438      * Get the version number of this revision.
1439      *
1440      * @access public
1441      *
1442      * @return integer The version number of this revision.
1443      */
1444     function getVersion() {
1445         return $this->_version;
1446     }
1447     
1448     /**
1449      * Determine whether this revision has defaulted content.
1450      *
1451      * The default revision (version 0) of each page, as well as any
1452      * pages which are created with empty content have their content
1453      * defaulted to something like:
1454      * <pre>
1455      *   Describe [ThisPage] here.
1456      * </pre>
1457      *
1458      * @access public
1459      *
1460      * @return boolean Returns true if the page has default content.
1461      */
1462     function hasDefaultContents() {
1463         $data = &$this->_data;
1464         return empty($data['%content']); // FIXME: what if it's the number 0? <>'' or === false
1465     }
1466
1467     /**
1468      * Get the content as an array of lines.
1469      *
1470      * @access public
1471      *
1472      * @return array An array of lines.
1473      * The lines should contain no trailing white space.
1474      */
1475     function getContent() {
1476         return explode("\n", $this->getPackedContent());
1477     }
1478         
1479    /**
1480      * Get the pagename of the revision.
1481      *
1482      * @access public
1483      *
1484      * @return string pagename.
1485      */
1486     function getPageName() {
1487         return $this->_pagename;
1488     }
1489     function getName() {
1490         return $this->_pagename;
1491     }
1492
1493     /**
1494      * Determine whether revision is the latest.
1495      *
1496      * @access public
1497      *
1498      * @return boolean True iff the revision is the latest (most recent) one.
1499      */
1500     function isCurrent() {
1501         if (!isset($this->_iscurrent)) {
1502             $page = $this->getPage();
1503             $current = $page->getCurrentRevision(false);
1504             $this->_iscurrent = $this->getVersion() == $current->getVersion();
1505         }
1506         return $this->_iscurrent;
1507     }
1508
1509     /**
1510      * Get the transformed content of a page.
1511      *
1512      * @param string $pagetype  Override the page-type of the revision.
1513      *
1514      * @return object An XmlContent-like object containing the page transformed
1515      * contents.
1516      */
1517     function getTransformedContent($pagetype_override=false) {
1518         $backend = &$this->_wikidb->_backend;
1519         
1520         if ($pagetype_override) {
1521             // Figure out the normal page-type for this page.
1522             $type = PageType::GetPageType($this->get('pagetype'));
1523             if ($type->getName() == $pagetype_override)
1524                 $pagetype_override = false; // Not really an override...
1525         }
1526
1527         if ($pagetype_override) {
1528             // Overriden page type, don't cache (or check cache).
1529             return new TransformedText($this->getPage(),
1530                                        $this->getPackedContent(),
1531                                        $this->getMetaData(),
1532                                        $pagetype_override);
1533         }
1534
1535         $possibly_cache_results = true;
1536
1537         if (!USECACHE or WIKIDB_NOCACHE_MARKUP) {
1538             if (WIKIDB_NOCACHE_MARKUP == 'purge') {
1539                 // flush cache for this page.
1540                 $page = $this->getPage();
1541                 $page->set('_cached_html', ''); // ignored with !USECACHE 
1542             }
1543             $possibly_cache_results = false;
1544         }
1545         elseif (USECACHE and !$this->_transformedContent) {
1546             //$backend->lock();
1547             if ($this->isCurrent()) {
1548                 $page = $this->getPage();
1549                 $this->_transformedContent = TransformedText::unpack($page->get('_cached_html'));
1550             }
1551             else {
1552                 $possibly_cache_results = false;
1553             }
1554             //$backend->unlock();
1555         }
1556         
1557         if (!$this->_transformedContent) {
1558             $this->_transformedContent
1559                 = new TransformedText($this->getPage(),
1560                                       $this->getPackedContent(),
1561                                       $this->getMetaData());
1562             
1563             if ($possibly_cache_results and !WIKIDB_NOCACHE_MARKUP) {
1564                 // If we're still the current version, cache the transfomed page.
1565                 //$backend->lock();
1566                 if ($this->isCurrent()) {
1567                     $page->set('_cached_html', $this->_transformedContent->pack());
1568                 }
1569                 //$backend->unlock();
1570             }
1571         }
1572
1573         return $this->_transformedContent;
1574     }
1575
1576     /**
1577      * Get the content as a string.
1578      *
1579      * @access public
1580      *
1581      * @return string The page content.
1582      * Lines are separated by new-lines.
1583      */
1584     function getPackedContent() {
1585         $data = &$this->_data;
1586
1587         
1588         if (empty($data['%content'])) {
1589             include_once('lib/InlineParser.php');
1590
1591             // A feature similar to taglines at http://www.wlug.org.nz/
1592             // Lib from http://www.aasted.org/quote/
1593             if (defined('FORTUNE_DIR') 
1594                 and is_dir(FORTUNE_DIR) 
1595                 and in_array($GLOBALS['request']->getArg('action'), 
1596                              array('create','edit')))
1597             {
1598                 include_once("lib/fortune.php");
1599                 $fortune = new Fortune();
1600                 $quote = $fortune->quoteFromDir(FORTUNE_DIR);
1601                 if ($quote != -1)
1602                     $quote = "<verbatim>\n"
1603                         . str_replace("\n<br>","\n", $quote)
1604                         . "</verbatim>\n\n";
1605                 else 
1606                     $quote = "";
1607                 return $quote
1608                     . sprintf(_("Describe %s here."), 
1609                               "[" . WikiEscape($this->_pagename) . "]");
1610             }
1611             // Replace empty content with default value.
1612             return sprintf(_("Describe %s here."), 
1613                            "[" . WikiEscape($this->_pagename) . "]");
1614         }
1615
1616         // There is (non-default) content.
1617         assert($this->_version > 0);
1618         
1619         if (!is_string($data['%content'])) {
1620             // Content was not provided to us at init time.
1621             // (This is allowed because for some backends, fetching
1622             // the content may be expensive, and often is not wanted
1623             // by the user.)
1624             //
1625             // In any case, now we need to get it.
1626             $data['%content'] = $this->_get_content();
1627             assert(is_string($data['%content']));
1628         }
1629         
1630         return $data['%content'];
1631     }
1632
1633     function _get_content() {
1634         $cache = &$this->_wikidb->_cache;
1635         $pagename = $this->_pagename;
1636         $version = $this->_version;
1637
1638         assert($version > 0);
1639         
1640         $newdata = $cache->get_versiondata($pagename, $version, true);
1641         if ($newdata) {
1642             assert(is_string($newdata['%content']));
1643             return $newdata['%content'];
1644         }
1645         else {
1646             // else revision has been deleted... What to do?
1647             return __sprintf("Oops! Revision %s of %s seems to have been deleted!",
1648                              $version, $pagename);
1649         }
1650     }
1651
1652     /**
1653      * Get meta-data for this revision.
1654      *
1655      *
1656      * @access public
1657      *
1658      * @param string $key Which meta-data to access.
1659      *
1660      * Some reserved revision meta-data keys are:
1661      * <dl>
1662      * <dt> 'mtime' <dd> Time this revision was created (seconds since midnight Jan 1, 1970.)
1663      *        The 'mtime' meta-value is normally set automatically by the database
1664      *        backend, but it may be specified explicitly when creating a new revision.
1665      * <dt> orig_mtime
1666      *  <dd> To ensure consistency of RecentChanges, the mtimes of the versions
1667      *       of a page must be monotonically increasing.  If an attempt is
1668      *       made to create a new revision with an mtime less than that of
1669      *       the preceeding revision, the new revisions timestamp is force
1670      *       to be equal to that of the preceeding revision.  In that case,
1671      *       the originally requested mtime is preserved in 'orig_mtime'.
1672      * <dt> '_supplanted' <dd> Time this revision ceased to be the most recent.
1673      *        This meta-value is <em>always</em> automatically maintained by the database
1674      *        backend.  (It is set from the 'mtime' meta-value of the superceding
1675      *        revision.)  '_supplanted' has a value of 'false' for the current revision.
1676      *
1677      * FIXME: this could be refactored:
1678      * <dt> author
1679      *  <dd> Author of the page (as he should be reported in, e.g. RecentChanges.)
1680      * <dt> author_id
1681      *  <dd> Authenticated author of a page.  This is used to identify
1682      *       the distinctness of authors when cleaning old revisions from
1683      *       the database.
1684      * <dt> 'is_minor_edit' <dd> Set if change was marked as a minor revision by the author.
1685      * <dt> 'summary' <dd> Short change summary entered by page author.
1686      * </dl>
1687      *
1688      * Meta-data keys must be valid C identifers (they have to start with a letter
1689      * or underscore, and can contain only alphanumerics and underscores.)
1690      *
1691      * @return string The requested value, or false if the requested value
1692      * is not defined.
1693      */
1694     function get($key) {
1695         if (!$key || $key[0] == '%')
1696             return false;
1697         $data = &$this->_data;
1698         return isset($data[$key]) ? $data[$key] : false;
1699     }
1700
1701     /**
1702      * Get all the revision page meta-data as a hash.
1703      *
1704      * @return hash The revision meta-data.
1705      */
1706     function getMetaData() {
1707         $meta = array();
1708         foreach ($this->_data as $key => $val) {
1709             if (!empty($val) && $key[0] != '%')
1710                 $meta[$key] = $val;
1711         }
1712         return $meta;
1713     }
1714     
1715             
1716     /**
1717      * Return a string representation of the revision.
1718      *
1719      * This is really only for debugging.
1720      *
1721      * @access public
1722      *
1723      * @return string Printable representation of the WikiDB_Page.
1724      */
1725     function asString () {
1726         ob_start();
1727         printf("[%s:%d\n", get_class($this), $this->get('version'));
1728         print_r($this->_data);
1729         echo $this->getPackedContent() . "\n]\n";
1730         $strval = ob_get_contents();
1731         ob_end_clean();
1732         return $strval;
1733     }
1734 };
1735
1736
1737 /**
1738  * Class representing a sequence of WikiDB_Pages.
1739  * TODO: Enhance to php5 iterators
1740  * TODO: 
1741  *   apply filters for options like 'sortby', 'limit', 'exclude'
1742  *   for simple queries like titleSearch, where the backend is not ready yet.
1743  */
1744 class WikiDB_PageIterator
1745 {
1746     function WikiDB_PageIterator(&$wikidb, &$iter, $options=false) {
1747         $this->_iter = $iter; // a WikiDB_backend_iterator
1748         $this->_wikidb = &$wikidb;
1749         $this->_options = $options;
1750     }
1751     
1752     function count () {
1753         return $this->_iter->count();
1754     }
1755
1756     /**
1757      * Get next WikiDB_Page in sequence.
1758      *
1759      * @access public
1760      *
1761      * @return WikiDB_Page The next WikiDB_Page in the sequence.
1762      */
1763     function next () {
1764         if ( ! ($next = $this->_iter->next()) )
1765             return false;
1766
1767         $pagename = &$next['pagename'];
1768         if (!is_string($pagename)) { // Bug #1327912 fixed by Joachim Lous
1769             $pagename = strval($pagename);
1770         }
1771         if (!$pagename) {
1772             if (isset($next['linkrelation']) 
1773                 or isset($next['pagedata']['linkrelation'])) return false;      
1774             trigger_error('empty pagename in WikiDB_PageIterator::next()', E_USER_WARNING);
1775             var_dump($next);
1776             return false;
1777         }
1778         // There's always hits, but we cache only if more 
1779         // (well not with file, cvs and dba)
1780         if (isset($next['pagedata']) and count($next['pagedata']) > 1) {
1781             $this->_wikidb->_cache->cache_data($next);
1782         // cache existing page id's since we iterate over all links in GleanDescription 
1783         // and need them later for LinkExistingWord
1784         } elseif ($this->_options and array_key_exists('include_empty', $this->_options)
1785                   and !$this->_options['include_empty'] and isset($next['id'])) {
1786             $this->_wikidb->_cache->_id_cache[$next['pagename']] = $next['id'];
1787         }
1788         $page = new WikiDB_Page($this->_wikidb, $pagename);
1789         if (isset($next['linkrelation']))
1790             $page->set('linkrelation', $next['linkrelation']);
1791         return $page;
1792     }
1793
1794     /**
1795      * Release resources held by this iterator.
1796      *
1797      * The iterator may not be used after free() is called.
1798      *
1799      * There is no need to call free(), if next() has returned false.
1800      * (I.e. if you iterate through all the pages in the sequence,
1801      * you do not need to call free() --- you only need to call it
1802      * if you stop before the end of the iterator is reached.)
1803      *
1804      * @access public
1805      */
1806     function free() {
1807         $this->_iter->free();
1808     }
1809     
1810     function asArray() {
1811         $result = array();
1812         while ($page = $this->next())
1813             $result[] = $page;
1814         //$this->reset();
1815         return $result;
1816     }
1817     
1818     /**
1819      * Apply filters for options like 'sortby', 'limit', 'exclude'
1820      * for simple queries like titleSearch, where the backend is not ready yet.
1821      * Since iteration is usually destructive for SQL results,
1822      * we have to generate a copy.
1823      */
1824     function applyFilters($options = false) {
1825         if (!$options) $options = $this->_options;
1826         if (isset($options['sortby'])) {
1827             $array = array();
1828             /* this is destructive */
1829             while ($page = $this->next())
1830                 $result[] = $page->getName();
1831             $this->_doSort($array, $options['sortby']);
1832         }
1833         /* the rest is not destructive.
1834          * reconstruct a new iterator 
1835          */
1836         $pagenames = array(); $i = 0;
1837         if (isset($options['limit']))
1838             $limit = $options['limit'];
1839         else 
1840             $limit = 0;
1841         if (isset($options['exclude']))
1842             $exclude = $options['exclude'];
1843         if (is_string($exclude) and !is_array($exclude))
1844             $exclude = PageList::explodePageList($exclude, false, false, $limit);
1845         foreach($array as $pagename) {
1846             if ($limit and $i++ > $limit)
1847                 return new WikiDB_Array_PageIterator($pagenames);
1848             if (!empty($exclude) and !in_array($pagename, $exclude))
1849                 $pagenames[] = $pagename;
1850             elseif (empty($exclude))
1851                 $pagenames[] = $pagename;
1852         }
1853         return new WikiDB_Array_PageIterator($pagenames);
1854     }
1855
1856     /* pagename only */
1857     function _doSort(&$array, $sortby) {
1858         $sortby = PageList::sortby($sortby, 'init');
1859         if ($sortby == '+pagename')
1860             sort($array, SORT_STRING);
1861         elseif ($sortby == '-pagename')
1862             rsort($array, SORT_STRING);
1863         reset($array);
1864     }
1865
1866 };
1867
1868 /**
1869  * A class which represents a sequence of WikiDB_PageRevisions.
1870  * TODO: Enhance to php5 iterators
1871  */
1872 class WikiDB_PageRevisionIterator
1873 {
1874     function WikiDB_PageRevisionIterator(&$wikidb, &$revisions, $options=false) {
1875         $this->_revisions = $revisions;
1876         $this->_wikidb = &$wikidb;
1877         $this->_options = $options;
1878     }
1879     
1880     function count () {
1881         return $this->_revisions->count();
1882     }
1883
1884     /**
1885      * Get next WikiDB_PageRevision in sequence.
1886      *
1887      * @access public
1888      *
1889      * @return WikiDB_PageRevision
1890      * The next WikiDB_PageRevision in the sequence.
1891      */
1892     function next () {
1893         if ( ! ($next = $this->_revisions->next()) )
1894             return false;
1895
1896         //$this->_wikidb->_cache->cache_data($next);
1897
1898         $pagename = $next['pagename'];
1899         $version = $next['version'];
1900         $versiondata = $next['versiondata'];
1901         if ((int)DEBUG) {
1902             if (!(is_string($pagename) and $pagename != '')) {
1903                 trigger_error("empty pagename",E_USER_WARNING);
1904                 return false;
1905             }
1906         } else assert(is_string($pagename) and $pagename != '');
1907         if ((int)DEBUG) {
1908             if (!is_array($versiondata)) {
1909                 trigger_error("empty versiondata",E_USER_WARNING);
1910                 return false;
1911             }
1912         } else assert(is_array($versiondata));
1913         if ((int)DEBUG) {
1914             if (!($version > 0)) {
1915                 trigger_error("invalid version",E_USER_WARNING);
1916                 return false;
1917             }
1918         } else assert($version > 0);
1919
1920         return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1921                                        $versiondata);
1922     }
1923
1924     /**
1925      * Release resources held by this iterator.
1926      *
1927      * The iterator may not be used after free() is called.
1928      *
1929      * There is no need to call free(), if next() has returned false.
1930      * (I.e. if you iterate through all the revisions in the sequence,
1931      * you do not need to call free() --- you only need to call it
1932      * if you stop before the end of the iterator is reached.)
1933      *
1934      * @access public
1935      */
1936     function free() { 
1937         $this->_revisions->free();
1938     }
1939
1940     function asArray() {
1941         $result = array();
1942         while ($rev = $this->next())
1943             $result[] = $rev;
1944         $this->free();
1945         return $result;
1946     }
1947 };
1948
1949 /** pseudo iterator
1950  */
1951 class WikiDB_Array_PageIterator
1952 {
1953     function WikiDB_Array_PageIterator($pagenames) {
1954         global $request;
1955         $this->_dbi = $request->getDbh();
1956         $this->_pages = $pagenames;
1957         reset($this->_pages);
1958     }
1959     function next() {
1960         $c =& current($this->_pages);
1961         next($this->_pages);
1962         return $c !== false ? $this->_dbi->getPage($c) : false;
1963     }
1964     function count() {
1965         return count($this->_pages);
1966     }
1967     function free() {}
1968     function asArray() {
1969         reset($this->_pages);
1970         return $this->_pages;
1971     }
1972 }
1973
1974 class WikiDB_Array_generic_iter
1975 {
1976     function WikiDB_Array_generic_iter($result) {
1977         // $result may be either an array or a query result
1978         if (is_array($result)) {
1979             $this->_array = $result;
1980         } elseif (is_object($result)) {
1981             $this->_array = $result->asArray();
1982         } else {
1983             $this->_array = array();
1984         }
1985         if (!empty($this->_array))
1986             reset($this->_array);
1987     }
1988     function next() {
1989         $c =& current($this->_array);
1990         next($this->_array);
1991         return $c !== false ? $c : false;
1992     }
1993     function count() {
1994         return count($this->_array);
1995     }
1996     function free() {}
1997     function asArray() {
1998         if (!empty($this->_array))
1999             reset($this->_array);
2000         return $this->_array;
2001     }
2002 }
2003
2004 /**
2005  * Data cache used by WikiDB.
2006  *
2007  * FIXME: Maybe rename this to caching_backend (or some such).
2008  *
2009  * @access private
2010  */
2011 class WikiDB_cache 
2012 {
2013     // FIXME: beautify versiondata cache.  Cache only limited data?
2014
2015     function WikiDB_cache (&$backend) {
2016         $this->_backend = &$backend;
2017
2018         $this->_pagedata_cache = array();
2019         $this->_versiondata_cache = array();
2020         array_push ($this->_versiondata_cache, array());
2021         $this->_glv_cache = array();
2022         $this->_id_cache = array(); // formerly ->_dbi->_iwpcache (nonempty pages => id)
2023     }
2024     
2025     function close() {
2026         $this->_pagedata_cache = array();
2027         $this->_versiondata_cache = array();
2028         $this->_glv_cache = array();
2029         $this->_id_cache = array();
2030     }
2031
2032     function get_pagedata($pagename) {
2033         assert(is_string($pagename) && $pagename != '');
2034         if (USECACHE) {
2035             $cache = &$this->_pagedata_cache;
2036             if (!isset($cache[$pagename]) || !is_array($cache[$pagename])) {
2037                 $cache[$pagename] = $this->_backend->get_pagedata($pagename);
2038                 if (empty($cache[$pagename]))
2039                     $cache[$pagename] = array();
2040             }
2041             return $cache[$pagename];
2042         } else {
2043             return $this->_backend->get_pagedata($pagename);
2044         }
2045     }
2046     
2047     function update_pagedata($pagename, $newdata) {
2048         assert(is_string($pagename) && $pagename != '');
2049        
2050         $this->_backend->update_pagedata($pagename, $newdata);
2051
2052         if (USECACHE) {
2053             if (!empty($this->_pagedata_cache[$pagename]) 
2054                 and is_array($this->_pagedata_cache[$pagename])) 
2055             {
2056                 $cachedata = &$this->_pagedata_cache[$pagename];
2057                 foreach($newdata as $key => $val)
2058                     $cachedata[$key] = $val;
2059             } else 
2060                 $this->_pagedata_cache[$pagename] = $newdata;
2061         }
2062     }
2063
2064     function invalidate_cache($pagename) {
2065         unset ($this->_pagedata_cache[$pagename]);
2066         unset ($this->_versiondata_cache[$pagename]);
2067         unset ($this->_glv_cache[$pagename]);
2068         unset ($this->_id_cache[$pagename]);
2069         //unset ($this->_backend->_page_data);
2070     }
2071     
2072     function delete_page($pagename) {
2073         $result = $this->_backend->delete_page($pagename);
2074         $this->invalidate_cache($pagename);
2075         return $result;
2076     }
2077
2078     function purge_page($pagename) {
2079         $result = $this->_backend->purge_page($pagename);
2080         $this->invalidate_cache($pagename);
2081         return $result;
2082     }
2083
2084     // FIXME: ugly and wrong. may overwrite full cache with partial cache
2085     function cache_data($data) {
2086         ;
2087         //if (isset($data['pagedata']))
2088         //    $this->_pagedata_cache[$data['pagename']] = $data['pagedata'];
2089     }
2090     
2091     function get_versiondata($pagename, $version, $need_content = false) {
2092         //  FIXME: Seriously ugly hackage
2093         $readdata = false;
2094         if (USECACHE) {   //temporary - for debugging
2095             assert(is_string($pagename) && $pagename != '');
2096             // There is a bug here somewhere which results in an assertion failure at line 105
2097             // of ArchiveCleaner.php  It goes away if we use the next line.
2098             //$need_content = true;
2099             $nc = $need_content ? '1':'0';
2100             $cache = &$this->_versiondata_cache;
2101             if (!isset($cache[$pagename][$version][$nc]) 
2102                 || !(is_array ($cache[$pagename])) 
2103                 || !(is_array ($cache[$pagename][$version]))) 
2104             {
2105                 $cache[$pagename][$version][$nc] = 
2106                     $this->_backend->get_versiondata($pagename, $version, $need_content);
2107                 $readdata = true;
2108                 // If we have retrieved all data, we may as well set the cache for 
2109                 // $need_content = false
2110                 if ($need_content){
2111                     $cache[$pagename][$version]['0'] =& $cache[$pagename][$version]['1'];
2112                 }
2113             }
2114             $vdata = $cache[$pagename][$version][$nc];
2115         } else {
2116             $vdata = $this->_backend->get_versiondata($pagename, $version, $need_content);
2117             $readdata = true;
2118         }
2119         if ($readdata && $vdata && !empty($vdata['%pagedata'])) {
2120             $this->_pagedata_cache[$pagename] =& $vdata['%pagedata'];
2121         }
2122         return $vdata;
2123     }
2124
2125     function set_versiondata($pagename, $version, $data) {
2126         //unset($this->_versiondata_cache[$pagename][$version]);
2127         
2128         $new = $this->_backend->set_versiondata($pagename, $version, $data);
2129         // Update the cache
2130         $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2131         $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2132         // Is this necessary?
2133         unset($this->_glv_cache[$pagename]);
2134     }
2135
2136     function update_versiondata($pagename, $version, $data) {
2137         $new = $this->_backend->update_versiondata($pagename, $version, $data);
2138         // Update the cache
2139         $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2140         // FIXME: hack
2141         $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2142         // Is this necessary?
2143         unset($this->_glv_cache[$pagename]);
2144     }
2145
2146     function delete_versiondata($pagename, $version) {
2147         $new = $this->_backend->delete_versiondata($pagename, $version);
2148         if (isset($this->_versiondata_cache[$pagename][$version]))
2149             unset ($this->_versiondata_cache[$pagename][$version]);
2150         // dirty latest version cache only if latest version gets deleted
2151         if (isset($this->_glv_cache[$pagename]) and $this->_glv_cache[$pagename] == $version)
2152             unset ($this->_glv_cache[$pagename]);
2153     }
2154         
2155     function get_latest_version($pagename)  {
2156         if (USECACHE) {
2157             assert (is_string($pagename) && $pagename != '');
2158             $cache = &$this->_glv_cache;
2159             if (!isset($cache[$pagename])) {
2160                 $cache[$pagename] = $this->_backend->get_latest_version($pagename);
2161                 if (empty($cache[$pagename]))
2162                     $cache[$pagename] = 0;
2163             }
2164             return $cache[$pagename];
2165         } else {
2166             return $this->_backend->get_latest_version($pagename); 
2167         }
2168     }
2169 };
2170
2171 function _sql_debuglog($msg, $newline=true, $shutdown=false) {
2172     static $fp = false;
2173     static $i = 0;
2174     if (!$fp) {
2175         $stamp = strftime("%y%m%d-%H%M%S");
2176         $fp = fopen(TEMP_DIR."/sql-$stamp.log", "a");
2177         register_shutdown_function("_sql_debuglog_shutdown_function");
2178     } elseif ($shutdown) {
2179         fclose($fp);
2180         return;
2181     }
2182     if ($newline) fputs($fp, "[$i++] $msg");
2183     else fwrite($fp, $msg);
2184 }
2185
2186 function _sql_debuglog_shutdown_function() {
2187     _sql_debuglog('',false,true);
2188 }
2189
2190 // $Log: not supported by cvs2svn $
2191 // Revision 1.147  2007/01/04 16:41:41  rurban
2192 // Some pageiterators also set ['pagedata']['linkrelation'], hmm
2193 //
2194 // Revision 1.146  2007/01/02 13:20:00  rurban
2195 // 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.
2196 //
2197 // Revision 1.145  2006/12/22 17:59:55  rurban
2198 // Move mailer functions into seperate MailNotify.php
2199 //
2200 // Revision 1.144  2006/10/12 06:36:09  rurban
2201 // Guard against unwanted DEBUG="DEBUG" logic. In detail (WikiDB),
2202 // and generally by forcing all int constants to be defined as int.
2203 //
2204 // Revision 1.143  2006/09/06 05:46:40  rurban
2205 // do db backend check on _DEBUG_SQL
2206 //
2207 // Revision 1.142  2006/06/10 11:55:58  rurban
2208 // print optimize only when DEBUG
2209 //
2210 // Revision 1.141  2006/04/17 17:28:21  rurban
2211 // honor getWikiPageLinks change linkto=>relation
2212 //
2213 // Revision 1.140  2006/03/19 14:23:51  rurban
2214 // sf.net patch #1377011 by Matt Brown: add DATABASE_OPTIMISE_FREQUENCY
2215 //
2216 // Revision 1.139  2006/01/12 16:38:07  rurban
2217 // add page method listRelations()
2218 // fix bug #1327912 numeric pagenames can break plugins (Joachim Lous)
2219 //
2220 // Revision 1.138  2005/11/14 22:27:07  rurban
2221 // add linkrelation support
2222 //   getPageLinks returns now an array of hashes
2223 // pass stoplist through iterator
2224 //
2225 // Revision 1.137  2005/10/12 06:16:18  rurban
2226 // better From header
2227 //
2228 // Revision 1.136  2005/10/03 16:14:57  rurban
2229 // improve description
2230 //
2231 // Revision 1.135  2005/09/11 14:19:44  rurban
2232 // enable LIMIT support for fulltext search
2233 //
2234 // Revision 1.134  2005/09/10 21:28:10  rurban
2235 // applyFilters hack to use filters after methods, which do not support them (titleSearch)
2236 //
2237 // Revision 1.133  2005/08/27 09:39:10  rurban
2238 // dumphtml when not at admin page: dump the current or given page
2239 //
2240 // Revision 1.132  2005/08/07 10:10:07  rurban
2241 // clean whole version cache
2242 //
2243 // Revision 1.131  2005/04/23 11:30:12  rurban
2244 // allow emtpy WikiDB::getRevisionBefore(), for simplier templates (revert)
2245 //
2246 // Revision 1.130  2005/04/06 06:19:30  rurban
2247 // Revert the previous wrong bugfix #1175761: USECACHE was mixed with WIKIDB_NOCACHE_MARKUP.
2248 // Fix WIKIDB_NOCACHE_MARKUP in main (always set it) and clarify it in WikiDB
2249 //
2250 // Revision 1.129  2005/04/06 05:50:29  rurban
2251 // honor !USECACHE for _cached_html, fixes #1175761
2252 //
2253 // Revision 1.128  2005/04/01 16:11:42  rurban
2254 // just whitespace
2255 //
2256 // Revision 1.127  2005/02/18 20:43:40  uckelman
2257 // WikiDB::genericWarnings() is no longer used.
2258 //
2259 // Revision 1.126  2005/02/04 17:58:06  rurban
2260 // minor versioncache improvement. part 2/3 of Charles Corrigan cache patch. not sure about the 0/1 issue
2261 //
2262 // Revision 1.125  2005/02/03 05:08:39  rurban
2263 // ref fix by Charles Corrigan
2264 //
2265 // Revision 1.124  2005/01/29 20:43:32  rurban
2266 // protect against empty request: on some occasion this happens
2267 //
2268 // Revision 1.123  2005/01/25 06:58:21  rurban
2269 // reformatting
2270 //
2271 // Revision 1.122  2005/01/20 10:18:17  rurban
2272 // reformatting
2273 //
2274 // Revision 1.121  2005/01/04 20:25:01  rurban
2275 // remove old [%pagedata][_cached_html] code
2276 //
2277 // Revision 1.120  2004/12/23 14:12:31  rurban
2278 // dont email on unittest
2279 //
2280 // Revision 1.119  2004/12/20 16:05:00  rurban
2281 // gettext msg unification
2282 //
2283 // Revision 1.118  2004/12/13 13:22:57  rurban
2284 // new BlogArchives plugin for the new blog theme. enable default box method
2285 // for all plugins. Minor search improvement.
2286 //
2287 // Revision 1.117  2004/12/13 08:15:09  rurban
2288 // false is wrong. null might be better but lets play safe.
2289 //
2290 // Revision 1.116  2004/12/10 22:15:00  rurban
2291 // fix $page->get('_cached_html)
2292 // refactor upgrade db helper _convert_cached_html() to be able to call them from WikiAdminUtils also.
2293 // support 2nd genericSqlQuery param (bind huge arg)
2294 //
2295 // Revision 1.115  2004/12/10 02:45:27  rurban
2296 // SQL optimization:
2297 //   put _cached_html from pagedata into a new seperate blob, not huge serialized string.
2298 //   it is only rarelely needed: for current page only, if-not-modified
2299 //   but was extracted for every simple page iteration.
2300 //
2301 // Revision 1.114  2004/12/09 22:24:44  rurban
2302 // optimize on _DEBUG_SQL only. but now again on every 50th request, not just save.
2303 //
2304 // Revision 1.113  2004/12/06 19:49:55  rurban
2305 // enable action=remove which is undoable and seeable in RecentChanges: ADODB ony for now.
2306 // renamed delete_page to purge_page.
2307 // enable action=edit&version=-1 to force creation of a new version.
2308 // added BABYCART_PATH config
2309 // fixed magiqc in adodb.inc.php
2310 // and some more docs
2311 //
2312 // Revision 1.112  2004/11/30 17:45:53  rurban
2313 // exists_links backend implementation
2314 //
2315 // Revision 1.111  2004/11/28 20:39:43  rurban
2316 // deactivate pagecache overwrite: it is wrong
2317 //
2318 // Revision 1.110  2004/11/26 18:39:01  rurban
2319 // new regex search parser and SQL backends (90% complete, glob and pcre backends missing)
2320 //
2321 // Revision 1.109  2004/11/25 17:20:50  rurban
2322 // and again a couple of more native db args: backlinks
2323 //
2324 // Revision 1.108  2004/11/23 13:35:31  rurban
2325 // add case_exact search
2326 //
2327 // Revision 1.107  2004/11/21 11:59:16  rurban
2328 // remove final \n to be ob_cache independent
2329 //
2330 // Revision 1.106  2004/11/20 17:35:56  rurban
2331 // improved WantedPages SQL backends
2332 // PageList::sortby new 3rd arg valid_fields (override db fields)
2333 // WantedPages sql pager inexact for performance reasons:
2334 //   assume 3 wantedfrom per page, to be correct, no getTotal()
2335 // support exclude argument for get_all_pages, new _sql_set()
2336 //
2337 // Revision 1.105  2004/11/20 09:16:27  rurban
2338 // Fix bad-style Cut&Paste programming errors, detected by Charles Corrigan.
2339 //
2340 // Revision 1.104  2004/11/19 19:22:03  rurban
2341 // ModeratePage part1: change status
2342 //
2343 // Revision 1.103  2004/11/16 17:29:04  rurban
2344 // fix remove notification error
2345 // fix creation + update id_cache update
2346 //
2347 // Revision 1.102  2004/11/11 18:31:26  rurban
2348 // add simple backtrace on such general failures to get at least an idea where
2349 //
2350 // Revision 1.101  2004/11/10 19:32:22  rurban
2351 // * optimize increaseHitCount, esp. for mysql.
2352 // * prepend dirs to the include_path (phpwiki_dir for faster searches)
2353 // * Pear_DB version logic (awful but needed)
2354 // * fix broken ADODB quote
2355 // * _extract_page_data simplification
2356 //
2357 // Revision 1.100  2004/11/10 15:29:20  rurban
2358 // * requires newer Pear_DB (as the internal one): quote() uses now escapeSimple for strings
2359 // * ACCESS_LOG_SQL: fix cause request not yet initialized
2360 // * WikiDB: moved SQL specific methods upwards
2361 // * new Pear_DB quoting: same as ADODB and as newer Pear_DB.
2362 //   fixes all around: WikiGroup, WikiUserNew SQL methods, SQL logging
2363 //
2364 // Revision 1.99  2004/11/09 17:11:05  rurban
2365 // * revert to the wikidb ref passing. there's no memory abuse there.
2366 // * use new wikidb->_cache->_id_cache[] instead of wikidb->_iwpcache, to effectively
2367 //   store page ids with getPageLinks (GleanDescription) of all existing pages, which
2368 //   are also needed at the rendering for linkExistingWikiWord().
2369 //   pass options to pageiterator.
2370 //   use this cache also for _get_pageid()
2371 //   This saves about 8 SELECT count per page (num all pagelinks).
2372 // * fix passing of all page fields to the pageiterator.
2373 // * fix overlarge session data which got broken with the latest ACCESS_LOG_SQL changes
2374 //
2375 // Revision 1.98  2004/11/07 18:34:29  rurban
2376 // more logging fixes
2377 //
2378 // Revision 1.97  2004/11/07 16:02:51  rurban
2379 // new sql access log (for spam prevention), and restructured access log class
2380 // dbh->quote (generic)
2381 // pear_db: mysql specific parts seperated (using replace)
2382 //
2383 // Revision 1.96  2004/11/05 22:32:15  rurban
2384 // encode the subject to be 7-bit safe
2385 //
2386 // Revision 1.95  2004/11/05 20:53:35  rurban
2387 // login cleanup: better debug msg on failing login,
2388 // checked password less immediate login (bogo or anon),
2389 // checked olduser pref session error,
2390 // better PersonalPage without password warning on minimal password length=0
2391 //   (which is default now)
2392 //
2393 // Revision 1.94  2004/11/01 10:43:56  rurban
2394 // seperate PassUser methods into seperate dir (memory usage)
2395 // fix WikiUser (old) overlarge data session
2396 // remove wikidb arg from various page class methods, use global ->_dbi instead
2397 // ...
2398 //
2399 // Revision 1.93  2004/10/14 17:17:57  rurban
2400 // remove dbi WikiDB_Page param: use global request object instead. (memory)
2401 // allow most_popular sortby arguments
2402 //
2403 // Revision 1.92  2004/10/05 17:00:04  rurban
2404 // support paging for simple lists
2405 // fix RatingDb sql backend.
2406 // remove pages from AllPages (this is ListPages then)
2407 //
2408 // Revision 1.91  2004/10/04 23:41:19  rurban
2409 // delete notify: fix, @unset syntax error
2410 //
2411 // Revision 1.90  2004/09/28 12:50:22  rurban
2412 // https://sourceforge.net/forum/forum.php?thread_id=1150924&forum_id=18929
2413 //
2414 // Revision 1.89  2004/09/26 10:54:42  rurban
2415 // silence deferred check
2416 //
2417 // Revision 1.88  2004/09/25 18:16:40  rurban
2418 // unset more unneeded _cached_html. (Guess this should fix sf.net now)
2419 //
2420 // Revision 1.87  2004/09/25 16:25:40  rurban
2421 // notify on rename and remove (to be improved)
2422 //
2423 // Revision 1.86  2004/09/23 18:52:06  rurban
2424 // only fortune at create
2425 //
2426 // Revision 1.85  2004/09/16 08:00:51  rurban
2427 // just some comments
2428 //
2429 // Revision 1.84  2004/09/14 10:34:30  rurban
2430 // fix TransformedText call to use refs
2431 //
2432 // Revision 1.83  2004/09/08 13:38:00  rurban
2433 // improve loadfile stability by using markup=2 as default for undefined markup-style.
2434 // use more refs for huge objects.
2435 // fix debug=static issue in WikiPluginCached
2436 //
2437 // Revision 1.82  2004/09/06 12:08:49  rurban
2438 // memory_limit on unix workaround
2439 // VisualWiki: default autosize image
2440 //
2441 // Revision 1.81  2004/09/06 08:28:00  rurban
2442 // rename genericQuery to genericSqlQuery
2443 //
2444 // Revision 1.80  2004/07/09 13:05:34  rurban
2445 // just aesthetics
2446 //
2447 // Revision 1.79  2004/07/09 10:06:49  rurban
2448 // Use backend specific sortby and sortable_columns method, to be able to
2449 // select between native (Db backend) and custom (PageList) sorting.
2450 // Fixed PageList::AddPageList (missed the first)
2451 // Added the author/creator.. name to AllPagesBy...
2452 //   display no pages if none matched.
2453 // Improved dba and file sortby().
2454 // Use &$request reference
2455 //
2456 // Revision 1.78  2004/07/08 21:32:35  rurban
2457 // Prevent from more warnings, minor db and sort optimizations
2458 //
2459 // Revision 1.77  2004/07/08 19:04:42  rurban
2460 // more unittest fixes (file backend, metadata RatingsDb)
2461 //
2462 // Revision 1.76  2004/07/08 17:31:43  rurban
2463 // improve numPages for file (fixing AllPagesTest)
2464 //
2465 // Revision 1.75  2004/07/05 13:56:22  rurban
2466 // sqlite autoincrement fix
2467 //
2468 // Revision 1.74  2004/07/03 16:51:05  rurban
2469 // optional DBADMIN_USER:DBADMIN_PASSWD for action=upgrade (if no ALTER permission)
2470 // added atomic mysql REPLACE for PearDB as in ADODB
2471 // fixed _lock_tables typo links => link
2472 // fixes unserialize ADODB bug in line 180
2473 //
2474 // Revision 1.73  2004/06/29 08:52:22  rurban
2475 // Use ...version() $need_content argument in WikiDB also:
2476 // To reduce the memory footprint for larger sets of pagelists,
2477 // we don't cache the content (only true or false) and
2478 // we purge the pagedata (_cached_html) also.
2479 // _cached_html is only cached for the current pagename.
2480 // => Vastly improved page existance check, ACL check, ...
2481 //
2482 // Now only PagedList info=content or size needs the whole content, esp. if sortable.
2483 //
2484 // Revision 1.72  2004/06/25 14:15:08  rurban
2485 // reduce memory footprint by caching only requested pagedate content (improving most page iterators)
2486 //
2487 // Revision 1.71  2004/06/21 16:22:30  rurban
2488 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
2489 // fixed dumping buttons locally (images/buttons/),
2490 // support pages arg for dumphtml,
2491 // optional directory arg for dumpserial + dumphtml,
2492 // fix a AllPages warning,
2493 // show dump warnings/errors on DEBUG,
2494 // don't warn just ignore on wikilens pagelist columns, if not loaded.
2495 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
2496 //
2497 // Revision 1.70  2004/06/18 14:39:31  rurban
2498 // actually check USECACHE
2499 //
2500 // Revision 1.69  2004/06/13 15:33:20  rurban
2501 // new support for arguments owner, author, creator in most relevant
2502 // PageList plugins. in WikiAdmin* via preSelectS()
2503 //
2504 // Revision 1.68  2004/06/08 21:03:20  rurban
2505 // updated RssParser for XmlParser quirks (store parser object params in globals)
2506 //
2507 // Revision 1.67  2004/06/07 19:12:49  rurban
2508 // fixed rename version=0, bug #966284
2509 //
2510 // Revision 1.66  2004/06/07 18:57:27  rurban
2511 // fix rename: Change pagename in all linked pages
2512 //
2513 // Revision 1.65  2004/06/04 20:32:53  rurban
2514 // Several locale related improvements suggested by Pierrick Meignen
2515 // LDAP fix by John Cole
2516 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
2517 //
2518 // Revision 1.64  2004/06/04 16:50:00  rurban
2519 // add random quotes to empty pages
2520 //
2521 // Revision 1.63  2004/06/04 11:58:38  rurban
2522 // added USE_TAGLINES
2523 //
2524 // Revision 1.62  2004/06/03 22:24:41  rurban
2525 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
2526 //
2527 // Revision 1.61  2004/06/02 17:13:48  rurban
2528 // fix getRevisionBefore assertion
2529 //
2530 // Revision 1.60  2004/05/28 10:09:58  rurban
2531 // fix bug #962117, incorrect init of auth_dsn
2532 //
2533 // Revision 1.59  2004/05/27 17:49:05  rurban
2534 // renamed DB_Session to DbSession (in CVS also)
2535 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
2536 // remove leading slash in error message
2537 // added force_unlock parameter to File_Passwd (no return on stale locks)
2538 // fixed adodb session AffectedRows
2539 // added FileFinder helpers to unify local filenames and DATA_PATH names
2540 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
2541 //
2542 // Revision 1.58  2004/05/18 13:59:14  rurban
2543 // rename simpleQuery to genericQuery
2544 //
2545 // Revision 1.57  2004/05/16 22:07:35  rurban
2546 // check more config-default and predefined constants
2547 // various PagePerm fixes:
2548 //   fix default PagePerms, esp. edit and view for Bogo and Password users
2549 //   implemented Creator and Owner
2550 //   BOGOUSERS renamed to BOGOUSER
2551 // fixed syntax errors in signin.tmpl
2552 //
2553 // Revision 1.56  2004/05/15 22:54:49  rurban
2554 // fixed important WikiDB bug with DEBUG > 0: wrong assertion
2555 // improved SetAcl (works) and PagePerms, some WikiGroup helpers.
2556 //
2557 // Revision 1.55  2004/05/12 19:27:47  rurban
2558 // revert wrong inline optimization.
2559 //
2560 // Revision 1.54  2004/05/12 10:49:55  rurban
2561 // require_once fix for those libs which are loaded before FileFinder and
2562 //   its automatic include_path fix, and where require_once doesn't grok
2563 //   dirname(__FILE__) != './lib'
2564 // upgrade fix with PearDB
2565 // navbar.tmpl: remove spaces for IE &nbsp; button alignment
2566 //
2567 // Revision 1.53  2004/05/08 14:06:12  rurban
2568 // new support for inlined image attributes: [image.jpg size=50x30 align=right]
2569 // minor stability and portability fixes
2570 //
2571 // Revision 1.52  2004/05/06 19:26:16  rurban
2572 // improve stability, trying to find the InlineParser endless loop on sf.net
2573 //
2574 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
2575 //
2576 // Revision 1.51  2004/05/06 17:30:37  rurban
2577 // CategoryGroup: oops, dos2unix eol
2578 // improved phpwiki_version:
2579 //   pre -= .0001 (1.3.10pre: 1030.099)
2580 //   -p1 += .001 (1.3.9-p1: 1030.091)
2581 // improved InstallTable for mysql and generic SQL versions and all newer tables so far.
2582 // abstracted more ADODB/PearDB methods for action=upgrade stuff:
2583 //   backend->backendType(), backend->database(),
2584 //   backend->listOfFields(),
2585 //   backend->listOfTables(),
2586 //
2587 // Revision 1.50  2004/05/04 22:34:25  rurban
2588 // more pdf support
2589 //
2590 // Revision 1.49  2004/05/03 11:16:40  rurban
2591 // fixed sendPageChangeNotification
2592 // subject rewording
2593 //
2594 // Revision 1.48  2004/04/29 23:03:54  rurban
2595 // fixed sf.net bug #940996
2596 //
2597 // Revision 1.47  2004/04/29 19:39:44  rurban
2598 // special support for formatted plugins (one-liners)
2599 //   like <small><plugin BlaBla ></small>
2600 // iter->asArray() helper for PopularNearby
2601 // db_session for older php's (no &func() allowed)
2602 //
2603 // Revision 1.46  2004/04/26 20:44:34  rurban
2604 // locking table specific for better databases
2605 //
2606 // Revision 1.45  2004/04/20 00:06:03  rurban
2607 // themable paging support
2608 //
2609 // Revision 1.44  2004/04/19 18:27:45  rurban
2610 // Prevent from some PHP5 warnings (ref args, no :: object init)
2611 //   php5 runs now through, just one wrong XmlElement object init missing
2612 // Removed unneccesary UpgradeUser lines
2613 // Changed WikiLink to omit version if current (RecentChanges)
2614 //
2615 // Revision 1.43  2004/04/18 01:34:20  rurban
2616 // protect most_popular from sortby=mtime
2617 //
2618 // Revision 1.42  2004/04/18 01:11:51  rurban
2619 // more numeric pagename fixes.
2620 // fixed action=upload with merge conflict warnings.
2621 // charset changed from constant to global (dynamic utf-8 switching)
2622 //
2623
2624 // Local Variables:
2625 // mode: php
2626 // tab-width: 8
2627 // c-basic-offset: 4
2628 // c-hanging-comment-ender-p: nil
2629 // indent-tabs-mode: nil
2630 // End:   
2631 ?>