2 rcs_id('$Id: WikiDB.php,v 1.71 2004-06-21 16:22:30 rurban Exp $');
4 //require_once('lib/stdlib.php');
5 require_once('lib/PageType.php');
7 //FIXME: arg on get*Revision to hint that content is wanted.
10 * The classes in the file define the interface to the
14 * @author Geoffrey T. Dairiki <dairiki@dairiki.org>
18 * Force the creation of a new revision.
19 * @see WikiDB_Page::createRevision()
21 define('WIKIDB_FORCE_CREATE', -1);
23 // FIXME: used for debugging only. Comment out if cache does not work
24 define('USECACHE', 1);
27 * Abstract base class for the database used by PhpWiki.
29 * A <tt>WikiDB</tt> is a container for <tt>WikiDB_Page</tt>s which in
30 * turn contain <tt>WikiDB_PageRevision</tt>s.
32 * Conceptually a <tt>WikiDB</tt> contains all possible
33 * <tt>WikiDB_Page</tt>s, whether they have been initialized or not.
34 * Since all possible pages are already contained in a WikiDB, a call
35 * to WikiDB::getPage() will never fail (barring bugs and
36 * e.g. filesystem or SQL database problems.)
38 * Also each <tt>WikiDB_Page</tt> always contains at least one
39 * <tt>WikiDB_PageRevision</tt>: the default content (e.g. "Describe
40 * [PageName] here."). This default content has a version number of
43 * <tt>WikiDB_PageRevision</tt>s have read-only semantics. One can
44 * only create new revisions or delete old ones --- one can not modify
45 * an existing revision.
49 * Open a WikiDB database.
51 * This is a static member function. This function inspects its
52 * arguments to determine the proper subclass of WikiDB to
53 * instantiate, and then it instantiates it.
57 * @param hash $dbparams Database configuration parameters.
58 * Some pertinent paramters are:
61 * <dd> The back-end type. Current supported types are:
64 * <dd> Generic SQL backend based on the PEAR/DB database abstraction
67 * <dd> Dba based backend.
71 * <dd> (Used by the SQL backend.)
72 * The DSN specifying which database to connect to.
75 * <dd> Prefix to be prepended to database table (and file names).
78 * <dd> (Used by the dba backend.)
79 * Which directory db files reside in.
82 * <dd> (Used by the dba backend.)
83 * Timeout in seconds for opening (and obtaining lock) on the
87 * <dd> (Used by the dba backend.)
89 * Which dba handler to use. Good choices are probably either
93 * @return WikiDB A WikiDB object.
95 function open ($dbparams) {
96 $dbtype = $dbparams{'dbtype'};
97 include_once("lib/WikiDB/$dbtype.php");
99 $class = 'WikiDB_' . $dbtype;
100 return new $class ($dbparams);
110 function WikiDB (&$backend, $dbparams) {
111 $this->_backend = &$backend;
112 // don't do the following with the auth_dsn!
113 if (isset($dbparams['auth_dsn'])) return;
115 $this->_cache = new WikiDB_cache($backend);
116 // If the database doesn't yet have a timestamp, initialize it now.
117 if ($this->get('_timestamp') === false)
120 //FIXME: devel checking.
121 //$this->_backend->check();
125 * Get any user-level warnings about this WikiDB.
127 * Some back-ends, e.g. by default create there data files in the
128 * global /tmp directory. We would like to warn the user when this
129 * happens (since /tmp files tend to get wiped periodically.)
130 * Warnings such as these may be communicated from specific
131 * back-ends through this method.
135 * @return string A warning message (or <tt>false</tt> if there is
138 function genericWarnings() {
143 * Close database connection.
145 * The database may no longer be used after it is closed.
147 * Closing a WikiDB invalidates all <tt>WikiDB_Page</tt>s,
148 * <tt>WikiDB_PageRevision</tt>s and <tt>WikiDB_PageIterator</tt>s
149 * which have been obtained from it.
154 $this->_backend->close();
155 $this->_cache->close();
159 * Get a WikiDB_Page from a WikiDB.
161 * A {@link WikiDB} consists of the (infinite) set of all possible pages,
162 * therefore this method never fails.
165 * @param string $pagename Which page to get.
166 * @return WikiDB_Page The requested WikiDB_Page.
168 function getPage($pagename) {
169 static $error_displayed = false;
170 $pagename = (string) $pagename;
172 if ($pagename === '') {
173 if ($error_displayed) return false;
174 $error_displayed = true;
175 if (function_exists("xdebug_get_function_stack"))
176 var_dump(xdebug_get_function_stack());
177 trigger_error("empty pagename",E_USER_WARNING);
181 assert($pagename != '');
183 return new WikiDB_Page($this, $pagename);
187 * Determine whether page exists (in non-default form).
190 * $is_page = $dbi->isWikiPage($pagename);
194 * $page = $dbi->getPage($pagename);
195 * $current = $page->getCurrentRevision();
196 * $is_page = ! $current->hasDefaultContents();
198 * however isWikiPage may be implemented in a more efficient
199 * manner in certain back-ends.
203 * @param string $pagename string Which page to check.
205 * @return boolean True if the page actually exists with
206 * non-default contents in the WikiDataBase.
208 function isWikiPage ($pagename) {
209 $page = $this->getPage($pagename);
210 $current = $page->getCurrentRevision();
211 return ! $current->hasDefaultContents();
215 * Delete page from the WikiDB.
217 * Deletes all revisions of the page from the WikiDB. Also resets
218 * all page meta-data to the default values.
222 * @param string $pagename Name of page to delete.
224 function deletePage($pagename) {
225 $this->_cache->delete_page($pagename);
227 //How to create a RecentChanges entry with explaining summary?
229 $page = $this->getPage($pagename);
230 $current = $page->getCurrentRevision();
231 $meta = $current->_data;
232 $version = $current->getVersion();
233 $meta['summary'] = _("removed");
234 $page->save($current->getPackedContent(), $version + 1, $meta);
239 * Retrieve all pages.
241 * Gets the set of all pages with non-default contents.
243 * FIXME: do we need this? I think so. The simple searches
248 * @param boolean $include_defaulted Normally pages whose most
249 * recent revision has empty content are considered to be
250 * non-existant. Unless $include_defaulted is set to true, those
251 * pages will not be returned.
253 * @return WikiDB_PageIterator A WikiDB_PageIterator which contains all pages
254 * in the WikiDB which have non-default contents.
256 function getAllPages($include_defaulted=false, $sortby=false, $limit=false) {
257 $result = $this->_backend->get_all_pages($include_defaulted,$sortby,$limit);
258 return new WikiDB_PageIterator($this, $result);
262 //function nPages() {
264 // Yes, for paging. Renamed.
265 function numPages($filter=false, $exclude='') {
266 if (method_exists($this->_backend,'numPages'))
267 $count = $this->_backend->numPages($filter,$exclude);
269 $iter = $this->getAllPages();
270 $count = $iter->count();
278 * Search for pages containing (or not containing) certain words
281 * Pages are returned in alphabetical order whenever it is
282 * practical to do so.
284 * FIXME: should titleSearch and fullSearch be combined? I think so.
287 * @param TextSearchQuery $search A TextSearchQuery object
288 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
289 * @see TextSearchQuery
291 function titleSearch($search) {
292 $result = $this->_backend->text_search($search);
293 return new WikiDB_PageIterator($this, $result);
299 * Search for pages containing (or not containing) certain words
300 * in their entire text (this includes the page content and the
303 * Pages are returned in alphabetical order whenever it is
304 * practical to do so.
308 * @param TextSearchQuery $search A TextSearchQuery object.
309 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
310 * @see TextSearchQuery
312 function fullSearch($search) {
313 $result = $this->_backend->text_search($search, 'full_text');
314 return new WikiDB_PageIterator($this, $result);
318 * Find the pages with the greatest hit counts.
320 * Pages are returned in reverse order by hit count.
324 * @param integer $limit The maximum number of pages to return.
325 * Set $limit to zero to return all pages. If $limit < 0, pages will
326 * be sorted in decreasing order of popularity.
328 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching
331 function mostPopular($limit = 20, $sortby = '') {
332 // we don't support sortby=mtime here
333 if (strstr($sortby,'mtime'))
335 $result = $this->_backend->most_popular($limit, $sortby);
336 return new WikiDB_PageIterator($this, $result);
340 * Find recent page revisions.
342 * Revisions are returned in reverse order by creation time.
346 * @param hash $params This hash is used to specify various optional
350 * <dd> (integer) At most this many revisions will be returned.
352 * <dd> (integer) Only revisions since this time (unix-timestamp) will be returned.
353 * <dt> include_minor_revisions
354 * <dd> (boolean) Also include minor revisions. (Default is not to.)
355 * <dt> exclude_major_revisions
356 * <dd> (boolean) Don't include non-minor revisions.
357 * (Exclude_major_revisions implies include_minor_revisions.)
358 * <dt> include_all_revisions
359 * <dd> (boolean) Return all matching revisions for each page.
360 * Normally only the most recent matching revision is returned
364 * @return WikiDB_PageRevisionIterator A WikiDB_PageRevisionIterator containing the
365 * matching revisions.
367 function mostRecent($params = false) {
368 $result = $this->_backend->most_recent($params);
369 return new WikiDB_PageRevisionIterator($this, $result);
373 * Call the appropriate backend method.
376 * @param string $from Page to rename
377 * @param string $to New name
378 * @param boolean $updateWikiLinks If the text in all pages should be replaced.
379 * @return boolean true or false
381 function renamePage($from, $to, $updateWikiLinks = false) {
382 assert(is_string($from) && $from != '');
383 assert(is_string($to) && $to != '');
385 if (method_exists($this->_backend,'rename_page')) {
386 $oldpage = $this->getPage($from);
387 $newpage = $this->getPage($to);
388 //update all WikiLinks in existing pages
389 //non-atomic! i.e. if rename fails the links are not undone
390 if ($updateWikiLinks) {
391 require_once('lib/plugin/WikiAdminSearchReplace.php');
392 $links = $oldpage->getBackLinks();
393 while ($linked_page = $links->next()) {
394 WikiPlugin_WikiAdminSearchReplace::replaceHelper($this,$linked_page->getName(),$from,$to);
396 $links = $newpage->getBackLinks();
397 while ($linked_page = $links->next()) {
398 WikiPlugin_WikiAdminSearchReplace::replaceHelper($this,$linked_page->getName(),$from,$to);
401 if ($oldpage->exists() and ! $newpage->exists()) {
402 if ($result = $this->_backend->rename_page($from, $to)) {
403 //create a RecentChanges entry with explaining summary
404 $page = $this->getPage($to);
405 $current = $page->getCurrentRevision();
406 $meta = $current->_data;
407 $version = $current->getVersion();
408 $meta['summary'] = sprintf(_("renamed from %s"),$from);
409 $page->save($current->getPackedContent(), $version + 1, $meta);
411 } elseif (!$oldpage->getCurrentRevision() and !$newpage->exists()) {
412 // if a version 0 exists try it also.
413 $result = $this->_backend->rename_page($from, $to);
416 trigger_error(_("WikiDB::renamePage() not yet implemented for this backend"),E_USER_WARNING);
421 /** Get timestamp when database was last modified.
423 * @return string A string consisting of two integers,
424 * separated by a space. The first is the time in
425 * unix timestamp format, the second is a modification
426 * count for the database.
428 * The idea is that you can cast the return value to an
429 * int to get a timestamp, or you can use the string value
430 * as a good hash for the entire database.
432 function getTimestamp() {
433 $ts = $this->get('_timestamp');
434 return sprintf("%d %d", $ts[0], $ts[1]);
438 * Update the database timestamp.
442 $ts = $this->get('_timestamp');
443 $this->set('_timestamp', array(time(), $ts[1] + 1));
448 * Access WikiDB global meta-data.
450 * NOTE: this is currently implemented in a hackish and
451 * not very efficient manner.
455 * @param string $key Which meta data to get.
456 * Some reserved meta-data keys are:
458 * <dt>'_timestamp' <dd> Data used by getTimestamp().
461 * @return scalar The requested value, or false if the requested data
465 if (!$key || $key[0] == '%')
468 * Hack Alert: We can use any page (existing or not) to store
469 * this data (as long as we always use the same one.)
471 $gd = $this->getPage('global_data');
472 $data = $gd->get('__global');
474 if ($data && isset($data[$key]))
481 * Set global meta-data.
483 * NOTE: this is currently implemented in a hackish and
484 * not very efficient manner.
489 * @param string $key Meta-data key to set.
490 * @param string $newval New value.
492 function set($key, $newval) {
493 if (!$key || $key[0] == '%')
496 $gd = $this->getPage('global_data');
498 $data = $gd->get('__global');
505 $data[$key] = $newval;
507 $gd->set('__global', $data);
510 // simple select or create/update queries
511 function genericQuery($sql) {
513 if ($DBParams['dbtype'] == 'SQL') {
514 $result = $this->_backend->_dbh->query($sql);
515 if (DB::isError($result)) {
516 $msg = $result->getMessage();
517 trigger_error("SQL Error: ".DB::errorMessage($result), E_USER_WARNING);
522 } elseif ($DBParams['dbtype'] == 'ADODB') {
523 if (!($result = $this->_backend->_dbh->Execute($sql))) {
524 trigger_error("SQL Error: ".$this->_backend->_dbh->ErrorMsg(), E_USER_WARNING);
533 function getParam($param) {
535 if (isset($DBParams[$param])) return $DBParams[$param];
536 elseif ($param == 'prefix') return '';
540 function getAuthParam($param) {
541 global $DBAuthParams;
542 if (isset($DBAuthParams[$param])) return $DBAuthParams[$param];
543 elseif ($param == 'USER_AUTH_ORDER') return $GLOBALS['USER_AUTH_ORDER'];
544 elseif ($param == 'USER_AUTH_POLICY') return $GLOBALS['USER_AUTH_POLICY'];
551 * An abstract base class which representing a wiki-page within a
554 * A WikiDB_Page contains a number (at least one) of
555 * WikiDB_PageRevisions.
559 function WikiDB_Page(&$wikidb, $pagename) {
560 $this->_wikidb = &$wikidb;
561 $this->_pagename = $pagename;
563 if (!(is_string($pagename) and $pagename != '')) {
564 if (function_exists("xdebug_get_function_stack")) {
565 echo "xdebug_get_function_stack(): "; var_dump(xdebug_get_function_stack());
568 trigger_error("empty pagename",E_USER_WARNING);
571 } else assert(is_string($pagename) and $pagename != '');
575 * Get the name of the wiki page.
579 * @return string The page name.
582 return $this->_pagename;
586 $current = $this->getCurrentRevision();
587 return ! $current->hasDefaultContents();
591 * Delete an old revision of a WikiDB_Page.
593 * Deletes the specified revision of the page.
594 * It is a fatal error to attempt to delete the current revision.
598 * @param integer $version Which revision to delete. (You can also
599 * use a WikiDB_PageRevision object here.)
601 function deleteRevision($version) {
602 $backend = &$this->_wikidb->_backend;
603 $cache = &$this->_wikidb->_cache;
604 $pagename = &$this->_pagename;
606 $version = $this->_coerce_to_version($version);
610 $backend->lock(array('page','version'));
611 $latestversion = $cache->get_latest_version($pagename);
612 if ($latestversion && $version == $latestversion) {
613 $backend->unlock(array('page','version'));
614 trigger_error(sprintf("Attempt to delete most recent revision of '%s'",
615 $pagename), E_USER_ERROR);
619 $cache->delete_versiondata($pagename, $version);
620 $backend->unlock(array('page','version'));
624 * Delete a revision, or possibly merge it with a previous
628 * Suppose an author make a (major) edit to a page. Shortly
629 * after that the same author makes a minor edit (e.g. to fix
630 * spelling mistakes he just made.)
632 * Now some time later, where cleaning out old saved revisions,
633 * and would like to delete his minor revision (since there's
634 * really no point in keeping minor revisions around for a long
637 * Note that the text after the minor revision probably represents
638 * what the author intended to write better than the text after
639 * the preceding major edit.
641 * So what we really want to do is merge the minor edit with the
644 * We will only do this when:
646 * <li>The revision being deleted is a minor one, and
647 * <li>It has the same author as the immediately preceding revision.
650 function mergeRevision($version) {
651 $backend = &$this->_wikidb->_backend;
652 $cache = &$this->_wikidb->_cache;
653 $pagename = &$this->_pagename;
655 $version = $this->_coerce_to_version($version);
659 $backend->lock(array('version'));
660 $latestversion = $backend->get_latest_version($pagename);
661 if ($latestversion && $version == $latestversion) {
662 $backend->unlock(array('version'));
663 trigger_error(sprintf("Attempt to merge most recent revision of '%s'",
664 $pagename), E_USER_ERROR);
668 $versiondata = $cache->get_versiondata($pagename, $version, true);
670 // Not there? ... we're done!
671 $backend->unlock(array('version'));
675 if ($versiondata['is_minor_edit']) {
676 $previous = $backend->get_previous_version($pagename, $version);
678 $prevdata = $cache->get_versiondata($pagename, $previous);
679 if ($prevdata['author_id'] == $versiondata['author_id']) {
680 // This is a minor revision, previous version is
681 // by the same author. We will merge the
683 $cache->update_versiondata($pagename, $previous,
684 array('%content' => $versiondata['%content'],
685 '_supplanted' => $versiondata['_supplanted']));
690 $cache->delete_versiondata($pagename, $version);
691 $backend->unlock(array('version'));
696 * Create a new revision of a {@link WikiDB_Page}.
700 * @param int $version Version number for new revision.
701 * To ensure proper serialization of edits, $version must be
702 * exactly one higher than the current latest version.
703 * (You can defeat this check by setting $version to
704 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
706 * @param string $content Contents of new revision.
708 * @param hash $metadata Metadata for new revision.
709 * All values in the hash should be scalars (strings or integers).
711 * @param array $links List of pagenames which this page links to.
713 * @return WikiDB_PageRevision Returns the new WikiDB_PageRevision object. If
714 * $version was incorrect, returns false
716 function createRevision($version, &$content, $metadata, $links) {
717 $backend = &$this->_wikidb->_backend;
718 $cache = &$this->_wikidb->_cache;
719 $pagename = &$this->_pagename;
721 $backend->lock(array('version','page','recent','links','nonempty'));
723 $latestversion = $backend->get_latest_version($pagename);
724 $newversion = $latestversion + 1;
725 assert($newversion >= 1);
727 if ($version != WIKIDB_FORCE_CREATE && $version != $newversion) {
728 $backend->unlock(array('version','page','recent','links','nonempty'));
734 foreach ($data as $key => $val) {
735 if (empty($val) || $key[0] == '_' || $key[0] == '%')
739 assert(!empty($data['author']));
740 if (empty($data['author_id']))
741 @$data['author_id'] = $data['author'];
743 if (empty($data['mtime']))
744 $data['mtime'] = time();
746 if ($latestversion) {
747 // Ensure mtimes are monotonic.
748 $pdata = $cache->get_versiondata($pagename, $latestversion);
749 if ($data['mtime'] < $pdata['mtime']) {
750 trigger_error(sprintf(_("%s: Date of new revision is %s"),
751 $pagename,"'non-monotonic'"),
753 $data['orig_mtime'] = $data['mtime'];
754 $data['mtime'] = $pdata['mtime'];
757 // FIXME: use (possibly user specified) 'mtime' time or
759 $cache->update_versiondata($pagename, $latestversion,
760 array('_supplanted' => $data['mtime']));
763 $data['%content'] = &$content;
765 $cache->set_versiondata($pagename, $newversion, $data);
767 //$cache->update_pagedata($pagename, array(':latestversion' => $newversion,
768 //':deleted' => empty($content)));
770 $backend->set_links($pagename, $links);
772 $backend->unlock(array('version','page','recent','links','nonempty'));
774 return new WikiDB_PageRevision($this->_wikidb, $pagename, $newversion,
778 /** A higher-level interface to createRevision.
780 * This takes care of computing the links, and storing
781 * a cached version of the transformed wiki-text.
783 * @param string $wikitext The page content.
785 * @param int $version Version number for new revision.
786 * To ensure proper serialization of edits, $version must be
787 * exactly one higher than the current latest version.
788 * (You can defeat this check by setting $version to
789 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
791 * @param hash $meta Meta-data for new revision.
793 function save($wikitext, $version, $meta) {
794 $formatted = new TransformedText($this, $wikitext, $meta);
795 $type = $formatted->getType();
796 $meta['pagetype'] = $type->getName();
797 $links = $formatted->getWikiPageLinks();
799 $backend = &$this->_wikidb->_backend;
800 $newrevision = $this->createRevision($version, $wikitext, $meta, $links);
802 if (!defined('WIKIDB_NOCACHE_MARKUP') or !WIKIDB_NOCACHE_MARKUP)
803 $this->set('_cached_html', $formatted->pack());
805 // FIXME: probably should have some global state information
806 // in the backend to control when to optimize.
808 // We're doing this here rather than in createRevision because
809 // postgres can't optimize while locked.
810 if (time() % 50 == 0) {
811 if ($backend->optimize())
812 trigger_error(sprintf(_("Optimizing %s"),'backend'), E_USER_NOTICE);
815 /* Generate notification emails? */
816 if (isa($newrevision, 'wikidb_pagerevision')) {
817 // Save didn't fail because of concurrent updates.
818 $notify = $this->_wikidb->get('notify');
819 if (!empty($notify) and is_array($notify)) {
820 list($emails, $userids) = $this->getPageChangeEmails($notify);
822 $this->sendPageChangeNotification($wikitext, $version, $meta, $emails, $userids);
826 $newrevision->_transformedContent = $formatted;
830 function getPageChangeEmails($notify) {
831 $emails = array(); $userids = array();
832 foreach ($notify as $page => $users) {
833 if (glob_match($page, $this->_pagename)) {
834 foreach ($users as $userid => $user) {
835 if (!empty($user['verified']) and !empty($user['email'])) {
836 $emails[] = $user['email'];
837 $userids[] = $userid;
838 } elseif (!empty($user['email'])) {
840 // do a dynamic emailVerified check update
841 $u = $request->getUser();
842 if ($u->UserName() == $userid) {
843 if ($request->_prefs->get('emailVerified')) {
844 $emails[] = $user['email'];
845 $userids[] = $userid;
846 $notify[$page][$userid]['verified'] = 1;
847 $request->_dbi->set('notify', $notify);
850 $u = WikiUser($userid);
851 $u->getPreferences();
852 if ($u->_prefs->get('emailVerified')) {
853 $emails[] = $user['email'];
854 $userids[] = $userid;
855 $notify[$page][$userid]['verified'] = 1;
856 $request->_dbi->set('notify', $notify);
859 // ignore verification
862 if (!in_array($user['email'],$emails))
863 $emails[] = $user['email'];
870 $emails = array_unique($emails);
871 $userids = array_unique($userids);
872 return array($emails,$userids);
875 function sendPageChangeNotification(&$wikitext, $version, $meta, $emails, $userids) {
876 $backend = &$this->_wikidb->_backend;
877 $subject = _("Page change").' '.$this->_pagename;
878 $previous = $backend->get_previous_version($this->_pagename, $version);
879 if (!isset($meta['mtime'])) $meta['mtime'] = time();
881 $difflink = WikiURL($this->_pagename,array('action'=>'diff'),true);
882 $cache = &$this->_wikidb->_cache;
883 $this_content = explode("\n", $wikitext);
884 $prevdata = $cache->get_versiondata($this->_pagename, $previous, true);
885 if (empty($prevdata['%content']))
886 $prevdata = $backend->get_versiondata($this->_pagename, $previous, true);
887 $other_content = explode("\n", $prevdata['%content']);
889 include_once("lib/diff.php");
890 $diff2 = new Diff($other_content, $this_content);
891 $context_lines = max(4, count($other_content) + 1,
892 count($this_content) + 1);
893 $fmt = new UnifiedDiffFormatter($context_lines);
894 $content = $this->_pagename . " " . $previous . " " . Iso8601DateTime($prevdata['mtime']) . "\n";
895 $content .= $this->_pagename . " " . $version . " " . Iso8601DateTime($meta['mtime']) . "\n";
896 $content .= $fmt->format($diff2);
899 $difflink = WikiURL($this->_pagename,array(),true);
900 $content = $this->_pagename . " " . $version . " " . Iso8601DateTime($meta['mtime']) . "\n";
901 $content .= _("New Page");
903 $editedby = sprintf(_("Edited by: %s"), $meta['author']);
904 $emails = join(',',$emails);
905 if (mail($emails,"[".WIKI_NAME."] ".$subject,
910 trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
911 $this->_pagename, join(',',$userids)), E_USER_NOTICE);
913 trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
914 $this->_pagename, join(',',$userids)), E_USER_WARNING);
918 * Get the most recent revision of a page.
922 * @return WikiDB_PageRevision The current WikiDB_PageRevision object.
924 function getCurrentRevision() {
925 $backend = &$this->_wikidb->_backend;
926 $cache = &$this->_wikidb->_cache;
927 $pagename = &$this->_pagename;
929 // Prevent deadlock in case of memory exhausted errors
930 // Pure selection doesn't really need locking here.
932 // I know it would be better, but with lots of pages this deadlock is more
933 // severe than occasionally get not the latest revision.
935 $version = $cache->get_latest_version($pagename);
936 $revision = $this->getRevision($version);
937 //$backend->unlock();
943 * Get a specific revision of a WikiDB_Page.
947 * @param integer $version Which revision to get.
949 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or
950 * false if the requested revision does not exist in the {@link WikiDB}.
951 * Note that version zero of any page always exists.
953 function getRevision($version) {
954 $cache = &$this->_wikidb->_cache;
955 $pagename = &$this->_pagename;
957 if (! $version ) // 0 or false
958 return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
960 assert($version > 0);
961 $vdata = $cache->get_versiondata($pagename, $version);
964 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
969 * Get previous page revision.
971 * This method find the most recent revision before a specified
976 * @param integer $version Find most recent revision before this version.
977 * You can also use a WikiDB_PageRevision object to specify the $version.
979 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or false if the
980 * requested revision does not exist in the {@link WikiDB}. Note that
981 * unless $version is greater than zero, a revision (perhaps version zero,
982 * the default revision) will always be found.
984 function getRevisionBefore($version) {
985 $backend = &$this->_wikidb->_backend;
986 $pagename = &$this->_pagename;
988 $version = $this->_coerce_to_version($version);
993 $previous = $backend->get_previous_version($pagename, $version);
994 $revision = $this->getRevision($previous);
995 //$backend->unlock();
1001 * Get all revisions of the WikiDB_Page.
1003 * This does not include the version zero (default) revision in the
1004 * returned revision set.
1006 * @return WikiDB_PageRevisionIterator A
1007 * WikiDB_PageRevisionIterator containing all revisions of this
1008 * WikiDB_Page in reverse order by version number.
1010 function getAllRevisions() {
1011 $backend = &$this->_wikidb->_backend;
1012 $revs = $backend->get_all_revisions($this->_pagename);
1013 return new WikiDB_PageRevisionIterator($this->_wikidb, $revs);
1017 * Find pages which link to or are linked from a page.
1021 * @param boolean $reversed Which links to find: true for backlinks (default).
1023 * @return WikiDB_PageIterator A WikiDB_PageIterator containing
1024 * all matching pages.
1026 function getLinks($reversed = true) {
1027 $backend = &$this->_wikidb->_backend;
1028 $result = $backend->get_links($this->_pagename, $reversed);
1029 return new WikiDB_PageIterator($this->_wikidb, $result);
1033 * All Links from other pages to this page.
1035 function getBackLinks() {
1036 return $this->getLinks(true);
1039 * Forward Links: All Links from this page to other pages.
1041 function getPageLinks() {
1042 return $this->getLinks(false);
1046 * Access WikiDB_Page meta-data.
1050 * @param string $key Which meta data to get.
1051 * Some reserved meta-data keys are:
1053 * <dt>'locked'<dd> Is page locked?
1054 * <dt>'hits' <dd> Page hit counter.
1055 * <dt>'pref' <dd> Users preferences, stored in homepages.
1056 * <dt>'owner' <dd> Default: first author_id. We might add a group with a dot here:
1057 * E.g. "owner.users"
1058 * <dt>'perm' <dd> Permission flag to authorize read/write/execution of
1059 * page-headers and content.
1060 * <dt>'score' <dd> Page score (not yet implement, do we need?)
1063 * @return scalar The requested value, or false if the requested data
1066 function get($key) {
1067 $cache = &$this->_wikidb->_cache;
1068 if (!$key || $key[0] == '%')
1070 $data = $cache->get_pagedata($this->_pagename);
1071 return isset($data[$key]) ? $data[$key] : false;
1075 * Get all the page meta-data as a hash.
1077 * @return hash The page meta-data.
1079 function getMetaData() {
1080 $cache = &$this->_wikidb->_cache;
1081 $data = $cache->get_pagedata($this->_pagename);
1083 foreach ($data as $key => $val) {
1084 if (/*!empty($val) &&*/ $key[0] != '%')
1091 * Set page meta-data.
1096 * @param string $key Meta-data key to set.
1097 * @param string $newval New value.
1099 function set($key, $newval) {
1100 $cache = &$this->_wikidb->_cache;
1101 $pagename = &$this->_pagename;
1103 assert($key && $key[0] != '%');
1105 $data = $cache->get_pagedata($pagename);
1107 if (!empty($newval)) {
1108 if (!empty($data[$key]) && $data[$key] == $newval)
1109 return; // values identical, skip update.
1112 if (empty($data[$key]))
1113 return; // values identical, skip update.
1116 $cache->update_pagedata($pagename, array($key => $newval));
1120 * Increase page hit count.
1122 * FIXME: IS this needed? Probably not.
1124 * This is a convenience function.
1125 * <pre> $page->increaseHitCount(); </pre>
1126 * is functionally identical to
1127 * <pre> $page->set('hits',$page->get('hits')+1); </pre>
1129 * Note that this method may be implemented in more efficient ways
1130 * in certain backends.
1134 function increaseHitCount() {
1135 @$newhits = $this->get('hits') + 1;
1136 $this->set('hits', $newhits);
1140 * Return a string representation of the WikiDB_Page
1142 * This is really only for debugging.
1146 * @return string Printable representation of the WikiDB_Page.
1148 function asString () {
1150 printf("[%s:%s\n", get_class($this), $this->getName());
1151 print_r($this->getMetaData());
1153 $strval = ob_get_contents();
1161 * @param integer_or_object $version_or_pagerevision
1162 * Takes either the version number (and int) or a WikiDB_PageRevision
1164 * @return integer The version number.
1166 function _coerce_to_version($version_or_pagerevision) {
1167 if (method_exists($version_or_pagerevision, "getContent"))
1168 $version = $version_or_pagerevision->getVersion();
1170 $version = (int) $version_or_pagerevision;
1172 assert($version >= 0);
1176 function isUserPage ($include_empty = true) {
1177 if ($include_empty) {
1178 $current = $this->getCurrentRevision();
1179 if ($current->hasDefaultContents()) {
1183 return $this->get('pref') ? true : false;
1186 // May be empty. Either the stored owner (/Chown), or the first authorized author
1187 function getOwner() {
1188 if ($owner = $this->get('owner'))
1189 return ($owner == "The PhpWiki programming team") ? ADMIN_USER : $owner;
1190 // check all revisions forwards for the first author_id
1191 $backend = &$this->_wikidb->_backend;
1192 $pagename = &$this->_pagename;
1193 $latestversion = $backend->get_latest_version($pagename);
1194 for ($v=1; $v <= $latestversion; $v++) {
1195 $rev = $this->getRevision($v);
1196 if ($rev and $owner = $rev->get('author_id')) {
1197 return ($owner == "The PhpWiki programming team") ? ADMIN_USER : $owner;
1203 // The authenticated author of the first revision or empty if not authenticated then.
1204 function getCreator() {
1205 if ($current = $this->getRevision(1)) return $current->get('author_id');
1209 // The authenticated author of the current revision.
1210 function getAuthor() {
1211 if ($current = $this->getCurrentRevision()) return $current->get('author_id');
1218 * This class represents a specific revision of a WikiDB_Page within
1221 * A WikiDB_PageRevision has read-only semantics. You may only create
1222 * new revisions (and delete old ones) --- you cannot modify existing
1225 class WikiDB_PageRevision
1227 var $_transformedContent = false; // set by WikiDB_Page::save()
1229 function WikiDB_PageRevision(&$wikidb, $pagename, $version,
1230 $versiondata = false)
1232 $this->_wikidb = &$wikidb;
1233 $this->_pagename = $pagename;
1234 $this->_version = $version;
1235 $this->_data = $versiondata ? $versiondata : array();
1239 * Get the WikiDB_Page which this revision belongs to.
1243 * @return WikiDB_Page The WikiDB_Page which this revision belongs to.
1245 function getPage() {
1246 return new WikiDB_Page($this->_wikidb, $this->_pagename);
1250 * Get the version number of this revision.
1254 * @return integer The version number of this revision.
1256 function getVersion() {
1257 return $this->_version;
1261 * Determine whether this revision has defaulted content.
1263 * The default revision (version 0) of each page, as well as any
1264 * pages which are created with empty content have their content
1265 * defaulted to something like:
1267 * Describe [ThisPage] here.
1272 * @return boolean Returns true if the page has default content.
1274 function hasDefaultContents() {
1275 $data = &$this->_data;
1276 return empty($data['%content']);
1280 * Get the content as an array of lines.
1284 * @return array An array of lines.
1285 * The lines should contain no trailing white space.
1287 function getContent() {
1288 return explode("\n", $this->getPackedContent());
1292 * Get the pagename of the revision.
1296 * @return string pagename.
1298 function getPageName() {
1299 return $this->_pagename;
1303 * Determine whether revision is the latest.
1307 * @return boolean True iff the revision is the latest (most recent) one.
1309 function isCurrent() {
1310 if (!isset($this->_iscurrent)) {
1311 $page = $this->getPage();
1312 $current = $page->getCurrentRevision();
1313 $this->_iscurrent = $this->getVersion() == $current->getVersion();
1315 return $this->_iscurrent;
1319 * Get the transformed content of a page.
1321 * @param string $pagetype Override the page-type of the revision.
1323 * @return object An XmlContent-like object containing the page transformed
1326 function getTransformedContent($pagetype_override=false) {
1327 $backend = &$this->_wikidb->_backend;
1329 if ($pagetype_override) {
1330 // Figure out the normal page-type for this page.
1331 $type = PageType::GetPageType($this->get('pagetype'));
1332 if ($type->getName() == $pagetype_override)
1333 $pagetype_override = false; // Not really an override...
1336 if ($pagetype_override) {
1337 // Overriden page type, don't cache (or check cache).
1338 return new TransformedText($this->getPage(),
1339 $this->getPackedContent(),
1340 $this->getMetaData(),
1341 $pagetype_override);
1344 $possibly_cache_results = true;
1346 if (defined('WIKIDB_NOCACHE_MARKUP') and WIKIDB_NOCACHE_MARKUP) {
1347 if (WIKIDB_NOCACHE_MARKUP == 'purge') {
1348 // flush cache for this page.
1349 $page = $this->getPage();
1350 $page->set('_cached_html', false);
1352 $possibly_cache_results = false;
1354 elseif (!$this->_transformedContent) {
1356 if ($this->isCurrent()) {
1357 $page = $this->getPage();
1358 $this->_transformedContent = TransformedText::unpack($page->get('_cached_html'));
1361 $possibly_cache_results = false;
1363 //$backend->unlock();
1366 if (!$this->_transformedContent) {
1367 $this->_transformedContent
1368 = new TransformedText($this->getPage(),
1369 $this->getPackedContent(),
1370 $this->getMetaData());
1372 if ($possibly_cache_results) {
1373 // If we're still the current version, cache the transfomed page.
1375 if ($this->isCurrent()) {
1376 $page->set('_cached_html', $this->_transformedContent->pack());
1378 //$backend->unlock();
1382 return $this->_transformedContent;
1386 * Get the content as a string.
1390 * @return string The page content.
1391 * Lines are separated by new-lines.
1393 function getPackedContent() {
1394 $data = &$this->_data;
1397 if (empty($data['%content'])) {
1398 include_once('lib/InlineParser.php');
1399 // A feature similar to taglines at http://www.wlug.org.nz/
1400 // Lib from http://www.aasted.org/quote/
1401 if (defined('FORTUNE_DIR') and is_dir(FORTUNE_DIR)) {
1402 include_once("lib/fortune.php");
1403 $fortune = new Fortune();
1404 $quote = str_replace("\n<br>","\n", $fortune->quoteFromDir(FORTUNE_DIR));
1405 return sprintf("<verbatim>\n%s</verbatim>\n\n"._("Describe %s here."),
1406 $quote, "[" . WikiEscape($this->_pagename) . "]");
1408 // Replace empty content with default value.
1409 return sprintf(_("Describe %s here."),
1410 "[" . WikiEscape($this->_pagename) . "]");
1413 // There is (non-default) content.
1414 assert($this->_version > 0);
1416 if (!is_string($data['%content'])) {
1417 // Content was not provided to us at init time.
1418 // (This is allowed because for some backends, fetching
1419 // the content may be expensive, and often is not wanted
1422 // In any case, now we need to get it.
1423 $data['%content'] = $this->_get_content();
1424 assert(is_string($data['%content']));
1427 return $data['%content'];
1430 function _get_content() {
1431 $cache = &$this->_wikidb->_cache;
1432 $pagename = $this->_pagename;
1433 $version = $this->_version;
1435 assert($version > 0);
1437 $newdata = $cache->get_versiondata($pagename, $version, true);
1439 assert(is_string($newdata['%content']));
1440 return $newdata['%content'];
1443 // else revision has been deleted... What to do?
1444 return __sprintf("Oops! Revision %s of %s seems to have been deleted!",
1445 $version, $pagename);
1450 * Get meta-data for this revision.
1455 * @param string $key Which meta-data to access.
1457 * Some reserved revision meta-data keys are:
1459 * <dt> 'mtime' <dd> Time this revision was created (seconds since midnight Jan 1, 1970.)
1460 * The 'mtime' meta-value is normally set automatically by the database
1461 * backend, but it may be specified explicitly when creating a new revision.
1463 * <dd> To ensure consistency of RecentChanges, the mtimes of the versions
1464 * of a page must be monotonically increasing. If an attempt is
1465 * made to create a new revision with an mtime less than that of
1466 * the preceeding revision, the new revisions timestamp is force
1467 * to be equal to that of the preceeding revision. In that case,
1468 * the originally requested mtime is preserved in 'orig_mtime'.
1469 * <dt> '_supplanted' <dd> Time this revision ceased to be the most recent.
1470 * This meta-value is <em>always</em> automatically maintained by the database
1471 * backend. (It is set from the 'mtime' meta-value of the superceding
1472 * revision.) '_supplanted' has a value of 'false' for the current revision.
1474 * FIXME: this could be refactored:
1476 * <dd> Author of the page (as he should be reported in, e.g. RecentChanges.)
1478 * <dd> Authenticated author of a page. This is used to identify
1479 * the distinctness of authors when cleaning old revisions from
1481 * <dt> 'is_minor_edit' <dd> Set if change was marked as a minor revision by the author.
1482 * <dt> 'summary' <dd> Short change summary entered by page author.
1485 * Meta-data keys must be valid C identifers (they have to start with a letter
1486 * or underscore, and can contain only alphanumerics and underscores.)
1488 * @return string The requested value, or false if the requested value
1491 function get($key) {
1492 if (!$key || $key[0] == '%')
1494 $data = &$this->_data;
1495 return isset($data[$key]) ? $data[$key] : false;
1499 * Get all the revision page meta-data as a hash.
1501 * @return hash The revision meta-data.
1503 function getMetaData() {
1505 foreach ($this->_data as $key => $val) {
1506 if (!empty($val) && $key[0] != '%')
1514 * Return a string representation of the revision.
1516 * This is really only for debugging.
1520 * @return string Printable representation of the WikiDB_Page.
1522 function asString () {
1524 printf("[%s:%d\n", get_class($this), $this->get('version'));
1525 print_r($this->_data);
1526 echo $this->getPackedContent() . "\n]\n";
1527 $strval = ob_get_contents();
1535 * Class representing a sequence of WikiDB_Pages.
1536 * TODO: Enhance to php5 iterators
1538 class WikiDB_PageIterator
1540 function WikiDB_PageIterator(&$wikidb, &$pages) {
1541 $this->_pages = $pages;
1542 $this->_wikidb = &$wikidb;
1546 return $this->_pages->count();
1550 * Get next WikiDB_Page in sequence.
1554 * @return WikiDB_Page The next WikiDB_Page in the sequence.
1557 if ( ! ($next = $this->_pages->next()) )
1560 $pagename = &$next['pagename'];
1562 trigger_error('empty pagename in WikiDB_PageIterator::next()', E_USER_WARNING);
1566 if (isset($next['pagedata']))
1567 $this->_wikidb->_cache->cache_data($next);
1569 return new WikiDB_Page($this->_wikidb, $pagename);
1573 * Release resources held by this iterator.
1575 * The iterator may not be used after free() is called.
1577 * There is no need to call free(), if next() has returned false.
1578 * (I.e. if you iterate through all the pages in the sequence,
1579 * you do not need to call free() --- you only need to call it
1580 * if you stop before the end of the iterator is reached.)
1585 $this->_pages->free();
1588 function asArray() {
1590 while ($page = $this->next())
1596 // Not yet used and problematic. Order should be set in the query, not afterwards.
1597 // See PageList::sortby
1598 function setSortby ($arg = false) {
1600 $arg = @$_GET['sortby'];
1602 $sortby = substr($arg,1);
1603 $order = substr($arg,0,1)=='+' ? 'ASC' : 'DESC';
1606 if (is_array($arg)) { // array('mtime' => 'desc')
1613 // available column types to sort by:
1614 // todo: we must provide access methods for the generic dumb/iterator
1615 $this->_types = explode(',','pagename,mtime,hits,version,author,locked,minor,markup');
1616 if (in_array($sortby,$this->_types))
1617 $this->_options['sortby'] = $sortby;
1619 trigger_error(sprintf("Argument %s '%s' ignored",'sortby',$sortby), E_USER_WARNING);
1620 if (in_array(strtoupper($order),'ASC','DESC'))
1621 $this->_options['order'] = strtoupper($order);
1623 trigger_error(sprintf("Argument %s '%s' ignored",'order',$order), E_USER_WARNING);
1629 * A class which represents a sequence of WikiDB_PageRevisions.
1630 * TODO: Enhance to php5 iterators
1632 class WikiDB_PageRevisionIterator
1634 function WikiDB_PageRevisionIterator(&$wikidb, &$revisions) {
1635 $this->_revisions = $revisions;
1636 $this->_wikidb = &$wikidb;
1640 return $this->_revisions->count();
1644 * Get next WikiDB_PageRevision in sequence.
1648 * @return WikiDB_PageRevision
1649 * The next WikiDB_PageRevision in the sequence.
1652 if ( ! ($next = $this->_revisions->next()) )
1655 $this->_wikidb->_cache->cache_data($next);
1657 $pagename = $next['pagename'];
1658 $version = $next['version'];
1659 $versiondata = $next['versiondata'];
1661 if (!(is_string($pagename) and $pagename != '')) {
1662 trigger_error("empty pagename",E_USER_WARNING);
1665 } else assert(is_string($pagename) and $pagename != '');
1667 if (!is_array($versiondata)) {
1668 trigger_error("empty versiondata",E_USER_WARNING);
1671 } else assert(is_array($versiondata));
1673 if (!($version > 0)) {
1674 trigger_error("invalid version",E_USER_WARNING);
1677 } else assert($version > 0);
1679 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1684 * Release resources held by this iterator.
1686 * The iterator may not be used after free() is called.
1688 * There is no need to call free(), if next() has returned false.
1689 * (I.e. if you iterate through all the revisions in the sequence,
1690 * you do not need to call free() --- you only need to call it
1691 * if you stop before the end of the iterator is reached.)
1696 $this->_revisions->free();
1699 function asArray() {
1701 while ($rev = $this->next())
1710 class WikiDB_Array_PageIterator
1712 function WikiDB_Array_PageIterator(&$pagenames) {
1714 $this->_dbi = $request->getDbh();
1715 $this->_pages = $pagenames;
1716 reset($this->_pages);
1719 $c =& current($this->_pages);
1720 next($this->_pages);
1721 return $c !== false ? $this->_dbi->getPage($c) : false;
1724 return count($this->_pages);
1727 function asArray() {
1728 reset($this->_pages);
1729 return $this->_pages;
1734 * Data cache used by WikiDB.
1736 * FIXME: Maybe rename this to caching_backend (or some such).
1742 // FIXME: beautify versiondata cache. Cache only limited data?
1744 function WikiDB_cache (&$backend) {
1745 $this->_backend = &$backend;
1747 $this->_pagedata_cache = array();
1748 $this->_versiondata_cache = array();
1749 array_push ($this->_versiondata_cache, array());
1750 $this->_glv_cache = array();
1754 $this->_pagedata_cache = false;
1755 $this->_versiondata_cache = false;
1756 $this->_glv_cache = false;
1759 function get_pagedata($pagename) {
1760 assert(is_string($pagename) && $pagename != '');
1761 $cache = &$this->_pagedata_cache;
1763 if (!isset($cache[$pagename]) || !is_array($cache[$pagename])) {
1764 $cache[$pagename] = $this->_backend->get_pagedata($pagename);
1765 if (empty($cache[$pagename]))
1766 $cache[$pagename] = array();
1769 return $cache[$pagename];
1772 function update_pagedata($pagename, $newdata) {
1773 assert(is_string($pagename) && $pagename != '');
1775 $this->_backend->update_pagedata($pagename, $newdata);
1777 if (is_array($this->_pagedata_cache[$pagename])) {
1778 $cachedata = &$this->_pagedata_cache[$pagename];
1779 foreach($newdata as $key => $val)
1780 $cachedata[$key] = $val;
1784 function invalidate_cache($pagename) {
1785 unset ($this->_pagedata_cache[$pagename]);
1786 unset ($this->_versiondata_cache[$pagename]);
1787 unset ($this->_glv_cache[$pagename]);
1790 function delete_page($pagename) {
1791 $this->_backend->delete_page($pagename);
1792 unset ($this->_pagedata_cache[$pagename]);
1793 unset ($this->_glv_cache[$pagename]);
1797 function cache_data($data) {
1798 if (isset($data['pagedata']))
1799 $this->_pagedata_cache[$data['pagename']] = $data['pagedata'];
1802 function get_versiondata($pagename, $version, $need_content = false) {
1803 // FIXME: Seriously ugly hackage
1804 if (defined('USECACHE') and USECACHE) { //temporary - for debugging
1805 assert(is_string($pagename) && $pagename != '');
1806 // there is a bug here somewhere which results in an assertion failure at line 105
1807 // of ArchiveCleaner.php It goes away if we use the next line.
1808 $need_content = true;
1809 $nc = $need_content ? '1':'0';
1810 $cache = &$this->_versiondata_cache;
1811 if (!isset($cache[$pagename][$version][$nc])||
1812 !(is_array ($cache[$pagename])) || !(is_array ($cache[$pagename][$version]))) {
1813 $cache[$pagename][$version][$nc] =
1814 $this->_backend->get_versiondata($pagename,$version, $need_content);
1815 // If we have retrieved all data, we may as well set the cache for $need_content = false
1817 $cache[$pagename][$version]['0'] = $cache[$pagename][$version]['1'];
1820 $vdata = $cache[$pagename][$version][$nc];
1822 $vdata = $this->_backend->get_versiondata($pagename, $version, $need_content);
1825 if ($vdata && !empty($vdata['%pagedata']))
1826 $this->_pagedata_cache[$pagename] = $vdata['%pagedata'];
1830 function set_versiondata($pagename, $version, $data) {
1831 $new = $this->_backend->set_versiondata($pagename, $version, $data);
1833 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
1835 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
1836 // Is this necessary?
1837 unset($this->_glv_cache[$pagename]);
1840 function update_versiondata($pagename, $version, $data) {
1841 $new = $this->_backend->update_versiondata($pagename, $version, $data);
1843 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
1845 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
1846 // Is this necessary?
1847 unset($this->_glv_cache[$pagename]);
1850 function delete_versiondata($pagename, $version) {
1851 $new = $this->_backend->delete_versiondata($pagename, $version);
1852 unset ($this->_versiondata_cache[$pagename][$version]['1']);
1853 unset ($this->_versiondata_cache[$pagename][$version]['0']);
1854 unset ($this->_glv_cache[$pagename]);
1857 function get_latest_version($pagename) {
1858 if (defined('USECACHE') and USECACHE) {
1859 assert (is_string($pagename) && $pagename != '');
1860 $cache = &$this->_glv_cache;
1861 if (!isset($cache[$pagename])) {
1862 $cache[$pagename] = $this->_backend->get_latest_version($pagename);
1863 if (empty($cache[$pagename]))
1864 $cache[$pagename] = 0;
1866 return $cache[$pagename];
1868 return $this->_backend->get_latest_version($pagename);
1874 // $Log: not supported by cvs2svn $
1875 // Revision 1.70 2004/06/18 14:39:31 rurban
1876 // actually check USECACHE
1878 // Revision 1.69 2004/06/13 15:33:20 rurban
1879 // new support for arguments owner, author, creator in most relevant
1880 // PageList plugins. in WikiAdmin* via preSelectS()
1882 // Revision 1.68 2004/06/08 21:03:20 rurban
1883 // updated RssParser for XmlParser quirks (store parser object params in globals)
1885 // Revision 1.67 2004/06/07 19:12:49 rurban
1886 // fixed rename version=0, bug #966284
1888 // Revision 1.66 2004/06/07 18:57:27 rurban
1889 // fix rename: Change pagename in all linked pages
1891 // Revision 1.65 2004/06/04 20:32:53 rurban
1892 // Several locale related improvements suggested by Pierrick Meignen
1893 // LDAP fix by John Cole
1894 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
1896 // Revision 1.64 2004/06/04 16:50:00 rurban
1897 // add random quotes to empty pages
1899 // Revision 1.63 2004/06/04 11:58:38 rurban
1900 // added USE_TAGLINES
1902 // Revision 1.62 2004/06/03 22:24:41 rurban
1903 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
1905 // Revision 1.61 2004/06/02 17:13:48 rurban
1906 // fix getRevisionBefore assertion
1908 // Revision 1.60 2004/05/28 10:09:58 rurban
1909 // fix bug #962117, incorrect init of auth_dsn
1911 // Revision 1.59 2004/05/27 17:49:05 rurban
1912 // renamed DB_Session to DbSession (in CVS also)
1913 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
1914 // remove leading slash in error message
1915 // added force_unlock parameter to File_Passwd (no return on stale locks)
1916 // fixed adodb session AffectedRows
1917 // added FileFinder helpers to unify local filenames and DATA_PATH names
1918 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
1920 // Revision 1.58 2004/05/18 13:59:14 rurban
1921 // rename simpleQuery to genericQuery
1923 // Revision 1.57 2004/05/16 22:07:35 rurban
1924 // check more config-default and predefined constants
1925 // various PagePerm fixes:
1926 // fix default PagePerms, esp. edit and view for Bogo and Password users
1927 // implemented Creator and Owner
1928 // BOGOUSERS renamed to BOGOUSER
1929 // fixed syntax errors in signin.tmpl
1931 // Revision 1.56 2004/05/15 22:54:49 rurban
1932 // fixed important WikiDB bug with DEBUG > 0: wrong assertion
1933 // improved SetAcl (works) and PagePerms, some WikiGroup helpers.
1935 // Revision 1.55 2004/05/12 19:27:47 rurban
1936 // revert wrong inline optimization.
1938 // Revision 1.54 2004/05/12 10:49:55 rurban
1939 // require_once fix for those libs which are loaded before FileFinder and
1940 // its automatic include_path fix, and where require_once doesn't grok
1941 // dirname(__FILE__) != './lib'
1942 // upgrade fix with PearDB
1943 // navbar.tmpl: remove spaces for IE button alignment
1945 // Revision 1.53 2004/05/08 14:06:12 rurban
1946 // new support for inlined image attributes: [image.jpg size=50x30 align=right]
1947 // minor stability and portability fixes
1949 // Revision 1.52 2004/05/06 19:26:16 rurban
1950 // improve stability, trying to find the InlineParser endless loop on sf.net
1952 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
1954 // Revision 1.51 2004/05/06 17:30:37 rurban
1955 // CategoryGroup: oops, dos2unix eol
1956 // improved phpwiki_version:
1957 // pre -= .0001 (1.3.10pre: 1030.099)
1958 // -p1 += .001 (1.3.9-p1: 1030.091)
1959 // improved InstallTable for mysql and generic SQL versions and all newer tables so far.
1960 // abstracted more ADODB/PearDB methods for action=upgrade stuff:
1961 // backend->backendType(), backend->database(),
1962 // backend->listOfFields(),
1963 // backend->listOfTables(),
1965 // Revision 1.50 2004/05/04 22:34:25 rurban
1968 // Revision 1.49 2004/05/03 11:16:40 rurban
1969 // fixed sendPageChangeNotification
1970 // subject rewording
1972 // Revision 1.48 2004/04/29 23:03:54 rurban
1973 // fixed sf.net bug #940996
1975 // Revision 1.47 2004/04/29 19:39:44 rurban
1976 // special support for formatted plugins (one-liners)
1977 // like <small><plugin BlaBla ></small>
1978 // iter->asArray() helper for PopularNearby
1979 // db_session for older php's (no &func() allowed)
1981 // Revision 1.46 2004/04/26 20:44:34 rurban
1982 // locking table specific for better databases
1984 // Revision 1.45 2004/04/20 00:06:03 rurban
1985 // themable paging support
1987 // Revision 1.44 2004/04/19 18:27:45 rurban
1988 // Prevent from some PHP5 warnings (ref args, no :: object init)
1989 // php5 runs now through, just one wrong XmlElement object init missing
1990 // Removed unneccesary UpgradeUser lines
1991 // Changed WikiLink to omit version if current (RecentChanges)
1993 // Revision 1.43 2004/04/18 01:34:20 rurban
1994 // protect most_popular from sortby=mtime
1996 // Revision 1.42 2004/04/18 01:11:51 rurban
1997 // more numeric pagename fixes.
1998 // fixed action=upload with merge conflict warnings.
1999 // charset changed from constant to global (dynamic utf-8 switching)
2005 // c-basic-offset: 4
2006 // c-hanging-comment-ender-p: nil
2007 // indent-tabs-mode: nil