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