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