2 rcs_id('$Id: WikiDB.php,v 1.47 2004-04-29 19:39:44 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 $this->_cache = new WikiDB_cache($backend);
114 // If the database doesn't yet have a timestamp, initialize it now.
115 if ($this->get('_timestamp') === false)
118 //FIXME: devel checking.
119 //$this->_backend->check();
123 * Get any user-level warnings about this WikiDB.
125 * Some back-ends, e.g. by default create there data files in the
126 * global /tmp directory. We would like to warn the user when this
127 * happens (since /tmp files tend to get wiped periodically.)
128 * Warnings such as these may be communicated from specific
129 * back-ends through this method.
133 * @return string A warning message (or <tt>false</tt> if there is
136 function genericWarnings() {
141 * Close database connection.
143 * The database may no longer be used after it is closed.
145 * Closing a WikiDB invalidates all <tt>WikiDB_Page</tt>s,
146 * <tt>WikiDB_PageRevision</tt>s and <tt>WikiDB_PageIterator</tt>s
147 * which have been obtained from it.
152 $this->_backend->close();
153 $this->_cache->close();
157 * Get a WikiDB_Page from a WikiDB.
159 * A {@link WikiDB} consists of the (infinite) set of all possible pages,
160 * therefore this method never fails.
163 * @param string $pagename Which page to get.
164 * @return WikiDB_Page The requested WikiDB_Page.
166 function getPage($pagename) {
167 assert(is_string($pagename) and $pagename != '');
168 return new WikiDB_Page($this, $pagename);
172 * Determine whether page exists (in non-default form).
175 * $is_page = $dbi->isWikiPage($pagename);
179 * $page = $dbi->getPage($pagename);
180 * $current = $page->getCurrentRevision();
181 * $is_page = ! $current->hasDefaultContents();
183 * however isWikiPage may be implemented in a more efficient
184 * manner in certain back-ends.
188 * @param string $pagename string Which page to check.
190 * @return boolean True if the page actually exists with
191 * non-default contents in the WikiDataBase.
193 function isWikiPage ($pagename) {
194 $page = $this->getPage($pagename);
195 $current = $page->getCurrentRevision();
196 return ! $current->hasDefaultContents();
200 * Delete page from the WikiDB.
202 * Deletes all revisions of the page from the WikiDB. Also resets
203 * all page meta-data to the default values.
207 * @param string $pagename Name of page to delete.
209 function deletePage($pagename) {
210 $this->_cache->delete_page($pagename);
212 //How to create a RecentChanges entry with explaining summary?
214 $page = $this->getPage($pagename);
215 $current = $page->getCurrentRevision();
216 $meta = $current->_data;
217 $version = $current->getVersion();
218 $meta['summary'] = _("removed");
219 $page->save($current->getPackedContent(), $version + 1, $meta);
224 * Retrieve all pages.
226 * Gets the set of all pages with non-default contents.
228 * FIXME: do we need this? I think so. The simple searches
233 * @param boolean $include_defaulted Normally pages whose most
234 * recent revision has empty content are considered to be
235 * non-existant. Unless $include_defaulted is set to true, those
236 * pages will not be returned.
238 * @return WikiDB_PageIterator A WikiDB_PageIterator which contains all pages
239 * in the WikiDB which have non-default contents.
241 function getAllPages($include_defaulted=false, $sortby=false, $limit=false) {
242 $result = $this->_backend->get_all_pages($include_defaulted,$sortby,$limit);
243 return new WikiDB_PageIterator($this, $result);
247 //function nPages() {
249 // Yes, for paging. Renamed.
250 function numPages($filter=false, $exclude='') {
251 if (method_exists($this->_backend,'numPages'))
252 $count = $this->_backend->numPages($filter,$exclude);
254 $iter = $this->getAllPages();
255 $count = $iter->count();
263 * Search for pages containing (or not containing) certain words
266 * Pages are returned in alphabetical order whenever it is
267 * practical to do so.
269 * FIXME: should titleSearch and fullSearch be combined? I think so.
272 * @param TextSearchQuery $search A TextSearchQuery object
273 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
274 * @see TextSearchQuery
276 function titleSearch($search) {
277 $result = $this->_backend->text_search($search);
278 return new WikiDB_PageIterator($this, $result);
284 * Search for pages containing (or not containing) certain words
285 * in their entire text (this includes the page content and the
288 * Pages are returned in alphabetical order whenever it is
289 * practical to do so.
293 * @param TextSearchQuery $search A TextSearchQuery object.
294 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
295 * @see TextSearchQuery
297 function fullSearch($search) {
298 $result = $this->_backend->text_search($search, 'full_text');
299 return new WikiDB_PageIterator($this, $result);
303 * Find the pages with the greatest hit counts.
305 * Pages are returned in reverse order by hit count.
309 * @param integer $limit The maximum number of pages to return.
310 * Set $limit to zero to return all pages. If $limit < 0, pages will
311 * be sorted in decreasing order of popularity.
313 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching
316 function mostPopular($limit = 20, $sortby = '') {
317 // we don't support sortby=mtime here
318 if (strstr($sortby,'mtime'))
320 $result = $this->_backend->most_popular($limit, $sortby);
321 return new WikiDB_PageIterator($this, $result);
325 * Find recent page revisions.
327 * Revisions are returned in reverse order by creation time.
331 * @param hash $params This hash is used to specify various optional
335 * <dd> (integer) At most this many revisions will be returned.
337 * <dd> (integer) Only revisions since this time (unix-timestamp) will be returned.
338 * <dt> include_minor_revisions
339 * <dd> (boolean) Also include minor revisions. (Default is not to.)
340 * <dt> exclude_major_revisions
341 * <dd> (boolean) Don't include non-minor revisions.
342 * (Exclude_major_revisions implies include_minor_revisions.)
343 * <dt> include_all_revisions
344 * <dd> (boolean) Return all matching revisions for each page.
345 * Normally only the most recent matching revision is returned
349 * @return WikiDB_PageRevisionIterator A WikiDB_PageRevisionIterator containing the
350 * matching revisions.
352 function mostRecent($params = false) {
353 $result = $this->_backend->most_recent($params);
354 return new WikiDB_PageRevisionIterator($this, $result);
358 * Call the appropriate backend method.
361 * @param string $from Page to rename
362 * @param string $to New name
363 * @param boolean $updateWikiLinks If the text in all pages should be replaced.
364 * @return boolean true or false
366 function renamePage($from, $to, $updateWikiLinks = false) {
367 assert(is_string($from) && $from != '');
368 assert(is_string($to) && $to != '');
370 if (method_exists($this->_backend,'rename_page')) {
371 $oldpage = $this->getPage($from);
372 $newpage = $this->getPage($to);
373 if ($oldpage->exists() and ! $newpage->exists()) {
374 if ($result = $this->_backend->rename_page($from, $to)) {
375 //update all WikiLinks in existing pages
376 if ($updateWikiLinks) {
377 //trigger_error(_("WikiDB::renamePage(..,..,updateWikiLinks) not yet implemented"),E_USER_WARNING);
378 require_once('lib/plugin/WikiAdminSearchReplace.php');
379 $links = $oldpage->getLinks();
380 while ($linked_page = $links->next()) {
381 WikiPlugin_WikiAdminSearchReplace::replaceHelper($this,$linked_page->getName(),$from,$to);
384 //create a RecentChanges entry with explaining summary
385 $page = $this->getPage($to);
386 $current = $page->getCurrentRevision();
387 $meta = $current->_data;
388 $version = $current->getVersion();
389 $meta['summary'] = sprintf(_("renamed from %s"),$from);
390 $page->save($current->getPackedContent(), $version + 1, $meta);
394 trigger_error(_("WikiDB::renamePage() not yet implemented for this backend"),E_USER_WARNING);
399 /** Get timestamp when database was last modified.
401 * @return string A string consisting of two integers,
402 * separated by a space. The first is the time in
403 * unix timestamp format, the second is a modification
404 * count for the database.
406 * The idea is that you can cast the return value to an
407 * int to get a timestamp, or you can use the string value
408 * as a good hash for the entire database.
410 function getTimestamp() {
411 $ts = $this->get('_timestamp');
412 return sprintf("%d %d", $ts[0], $ts[1]);
416 * Update the database timestamp.
420 $ts = $this->get('_timestamp');
421 $this->set('_timestamp', array(time(), $ts[1] + 1));
426 * Access WikiDB global meta-data.
428 * NOTE: this is currently implemented in a hackish and
429 * not very efficient manner.
433 * @param string $key Which meta data to get.
434 * Some reserved meta-data keys are:
436 * <dt>'_timestamp' <dd> Data used by getTimestamp().
439 * @return scalar The requested value, or false if the requested data
443 if (!$key || $key[0] == '%')
446 * Hack Alert: We can use any page (existing or not) to store
447 * this data (as long as we always use the same one.)
449 $gd = $this->getPage('global_data');
450 $data = $gd->get('__global');
452 if ($data && isset($data[$key]))
459 * Set global meta-data.
461 * NOTE: this is currently implemented in a hackish and
462 * not very efficient manner.
467 * @param string $key Meta-data key to set.
468 * @param string $newval New value.
470 function set($key, $newval) {
471 if (!$key || $key[0] == '%')
474 $gd = $this->getPage('global_data');
476 $data = $gd->get('__global');
483 $data[$key] = $newval;
485 $gd->set('__global', $data);
491 * An abstract base class which representing a wiki-page within a
494 * A WikiDB_Page contains a number (at least one) of
495 * WikiDB_PageRevisions.
499 function WikiDB_Page(&$wikidb, $pagename) {
500 $this->_wikidb = &$wikidb;
501 $this->_pagename = $pagename;
502 assert(is_string($pagename) and $pagename != '');
506 * Get the name of the wiki page.
510 * @return string The page name.
513 return $this->_pagename;
517 $current = $this->getCurrentRevision();
518 return ! $current->hasDefaultContents();
522 * Delete an old revision of a WikiDB_Page.
524 * Deletes the specified revision of the page.
525 * It is a fatal error to attempt to delete the current revision.
529 * @param integer $version Which revision to delete. (You can also
530 * use a WikiDB_PageRevision object here.)
532 function deleteRevision($version) {
533 $backend = &$this->_wikidb->_backend;
534 $cache = &$this->_wikidb->_cache;
535 $pagename = &$this->_pagename;
537 $version = $this->_coerce_to_version($version);
541 $backend->lock(array('page','version'));
542 $latestversion = $cache->get_latest_version($pagename);
543 if ($latestversion && $version == $latestversion) {
544 $backend->unlock(array('page','version'));
545 trigger_error(sprintf("Attempt to delete most recent revision of '%s'",
546 $pagename), E_USER_ERROR);
550 $cache->delete_versiondata($pagename, $version);
551 $backend->unlock(array('page','version'));
555 * Delete a revision, or possibly merge it with a previous
559 * Suppose an author make a (major) edit to a page. Shortly
560 * after that the same author makes a minor edit (e.g. to fix
561 * spelling mistakes he just made.)
563 * Now some time later, where cleaning out old saved revisions,
564 * and would like to delete his minor revision (since there's
565 * really no point in keeping minor revisions around for a long
568 * Note that the text after the minor revision probably represents
569 * what the author intended to write better than the text after
570 * the preceding major edit.
572 * So what we really want to do is merge the minor edit with the
575 * We will only do this when:
577 * <li>The revision being deleted is a minor one, and
578 * <li>It has the same author as the immediately preceding revision.
581 function mergeRevision($version) {
582 $backend = &$this->_wikidb->_backend;
583 $cache = &$this->_wikidb->_cache;
584 $pagename = &$this->_pagename;
586 $version = $this->_coerce_to_version($version);
590 $backend->lock(array('version'));
591 $latestversion = $backend->get_latest_version($pagename);
592 if ($latestversion && $version == $latestversion) {
593 $backend->unlock(array('version'));
594 trigger_error(sprintf("Attempt to merge most recent revision of '%s'",
595 $pagename), E_USER_ERROR);
599 $versiondata = $cache->get_versiondata($pagename, $version, true);
601 // Not there? ... we're done!
602 $backend->unlock(array('version'));
606 if ($versiondata['is_minor_edit']) {
607 $previous = $backend->get_previous_version($pagename, $version);
609 $prevdata = $cache->get_versiondata($pagename, $previous);
610 if ($prevdata['author_id'] == $versiondata['author_id']) {
611 // This is a minor revision, previous version is
612 // by the same author. We will merge the
614 $cache->update_versiondata($pagename, $previous,
615 array('%content' => $versiondata['%content'],
616 '_supplanted' => $versiondata['_supplanted']));
621 $cache->delete_versiondata($pagename, $version);
622 $backend->unlock(array('version'));
627 * Create a new revision of a {@link WikiDB_Page}.
631 * @param int $version Version number for new revision.
632 * To ensure proper serialization of edits, $version must be
633 * exactly one higher than the current latest version.
634 * (You can defeat this check by setting $version to
635 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
637 * @param string $content Contents of new revision.
639 * @param hash $metadata Metadata for new revision.
640 * All values in the hash should be scalars (strings or integers).
642 * @param array $links List of pagenames which this page links to.
644 * @return WikiDB_PageRevision Returns the new WikiDB_PageRevision object. If
645 * $version was incorrect, returns false
647 function createRevision($version, &$content, $metadata, $links) {
648 $backend = &$this->_wikidb->_backend;
649 $cache = &$this->_wikidb->_cache;
650 $pagename = &$this->_pagename;
652 $backend->lock(array('version','page','recent','links','nonempty'));
654 $latestversion = $backend->get_latest_version($pagename);
655 $newversion = $latestversion + 1;
656 assert($newversion >= 1);
658 if ($version != WIKIDB_FORCE_CREATE && $version != $newversion) {
659 $backend->unlock(array('version','page','recent','links'));
665 foreach ($data as $key => $val) {
666 if (empty($val) || $key[0] == '_' || $key[0] == '%')
670 assert(!empty($data['author']));
671 if (empty($data['author_id']))
672 @$data['author_id'] = $data['author'];
674 if (empty($data['mtime']))
675 $data['mtime'] = time();
677 if ($latestversion) {
678 // Ensure mtimes are monotonic.
679 $pdata = $cache->get_versiondata($pagename, $latestversion);
680 if ($data['mtime'] < $pdata['mtime']) {
681 trigger_error(sprintf(_("%s: Date of new revision is %s"),
682 $pagename,"'non-monotonic'"),
684 $data['orig_mtime'] = $data['mtime'];
685 $data['mtime'] = $pdata['mtime'];
688 // FIXME: use (possibly user specified) 'mtime' time or
690 $cache->update_versiondata($pagename, $latestversion,
691 array('_supplanted' => $data['mtime']));
694 $data['%content'] = &$content;
696 $cache->set_versiondata($pagename, $newversion, $data);
698 //$cache->update_pagedata($pagename, array(':latestversion' => $newversion,
699 //':deleted' => empty($content)));
701 $backend->set_links($pagename, $links);
703 $backend->unlock(array('version','page','recent','links','nonempty'));
705 return new WikiDB_PageRevision($this->_wikidb, $pagename, $newversion,
709 /** A higher-level interface to createRevision.
711 * This takes care of computing the links, and storing
712 * a cached version of the transformed wiki-text.
714 * @param string $wikitext The page content.
716 * @param int $version Version number for new revision.
717 * To ensure proper serialization of edits, $version must be
718 * exactly one higher than the current latest version.
719 * (You can defeat this check by setting $version to
720 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
722 * @param hash $meta Meta-data for new revision.
724 function save($wikitext, $version, $meta) {
725 $formatted = new TransformedText($this, $wikitext, $meta);
726 $type = $formatted->getType();
727 $meta['pagetype'] = $type->getName();
728 $links = $formatted->getWikiPageLinks();
730 $backend = &$this->_wikidb->_backend;
731 $newrevision = $this->createRevision($version, $wikitext, $meta, $links);
733 if (!defined('WIKIDB_NOCACHE_MARKUP') or !WIKIDB_NOCACHE_MARKUP)
734 $this->set('_cached_html', $formatted->pack());
736 // FIXME: probably should have some global state information
737 // in the backend to control when to optimize.
739 // We're doing this here rather than in createRevision because
740 // postgres can't optimize while locked.
741 if (time() % 50 == 0) {
742 if ($backend->optimize())
743 trigger_error(sprintf(_("Optimizing %s"),'backend'), E_USER_NOTICE);
746 /* Generate notification emails? */
747 if (isa($newrevision, 'wikidb_pagerevision')) {
748 // Save didn't fail because of concurrent updates.
749 $notify = $this->_wikidb->get('notify');
750 if (!empty($notify) and is_array($notify)) {
751 list($emails,$userids) = $this->getPageChangeEmails($notify);
753 $this->sendPageChangeNotification($emails,$userids);
757 $newrevision->_transformedContent = $formatted;
761 function getPageChangeEmails($notify) {
762 $emails = array(); $userids = array();
763 foreach ($notify as $page => $users) {
764 if (glob_match($page,$this->_pagename)) {
765 foreach ($users as $userid => $user) {
766 if (!empty($user['verified']) and !empty($user['email'])) {
767 $emails[] = $user['email'];
768 $userids[] = $userid;
769 } elseif (!empty($user['email'])) {
771 // do a dynamic emailVerified check update
772 $u = $request->getUser();
773 if ($u->UserName() == $userid) {
774 if ($request->_prefs->get('emailVerified')) {
775 $emails[] = $user['email'];
776 $userids[] = $userid;
777 $notify[$page][$userid]['verified'] = 1;
778 $request->_dbi->set('notify',$notify);
781 $u = WikiUser($userid);
782 if ($u->_prefs->get('emailVerified')) {
783 $emails[] = $user['email'];
784 $userids[] = $userid;
785 $notify[$page][$userid]['verified'] = 1;
786 $request->_dbi->set('notify',$notify);
789 // ignore verification
792 if (!in_array($user['email'],$emails))
793 $emails[] = $user['email'];
800 $emails = array_unique($emails);
801 $userids = array_unique($userids);
802 return array($emails,$userids);
805 function sendPageChangeNotification($emails, $userids) {
806 $subject = sprintf(_("PageChange Notification %s"),$this->_pagename);
807 $previous = $backend->get_previous_version($this->_pagename, $version);
809 $difflink = WikiURL($this->_pagename,array('action'=>'diff'),true);
810 $cache = &$this->_wikidb->_cache;
811 $this_content = explode("\n", $wikitext);
812 $prevdata = $cache->get_versiondata($this->_pagename, $previous, true);
813 if (empty($prevdata['%content']))
814 $prevdata = $backend->get_versiondata($this->_pagename, $previous, true);
815 $other_content = explode("\n", $prevdata['%content']);
817 include_once("lib/diff.php");
818 $diff2 = new Diff($other_content, $this_content);
819 $context_lines = max(4, count($other_content) + 1,
820 count($this_content) + 1);
821 $fmt = new UnifiedDiffFormatter($context_lines);
822 $content = $this->_pagename . " " . $previous . " " . Iso8601DateTime($prevdata['mtime']) . "\n";
823 $content .= $this->_pagename . " " . $version . " " . Iso8601DateTime($meta['mtime']) . "\n";
824 $content .= $fmt->format($diff2);
827 $difflink = WikiURL($this->_pagename,array(),true);
828 if (!isset($meta['mtime'])) $meta['mtime'] = time();
829 $content = $this->_pagename . " " . $version . " " . Iso8601DateTime($meta['mtime']) . "\n";
830 $content .= _("New Page");
832 $editedby = sprintf(_("Edited by: %s"), $meta['author']);
833 $emails = join(',',$emails);
834 if (mail($emails,"[".WIKI_NAME."] ".$subject,
839 trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
840 $this->_pagename, join(',',$userids)), E_USER_NOTICE);
842 trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
843 $this->_pagename, join(',',$userids)), E_USER_WARNING);
847 * Get the most recent revision of a page.
851 * @return WikiDB_PageRevision The current WikiDB_PageRevision object.
853 function getCurrentRevision() {
854 $backend = &$this->_wikidb->_backend;
855 $cache = &$this->_wikidb->_cache;
856 $pagename = &$this->_pagename;
858 // Prevent deadlock in case of memory exhausted errors
859 // Pure selection doesn't really need locking here.
861 // I know it would be better, but with lots of pages this deadlock is more
862 // severe than occasionally get not the latest revision.
864 $version = $cache->get_latest_version($pagename);
865 $revision = $this->getRevision($version);
866 //$backend->unlock();
872 * Get a specific revision of a WikiDB_Page.
876 * @param integer $version Which revision to get.
878 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or
879 * false if the requested revision does not exist in the {@link WikiDB}.
880 * Note that version zero of any page always exists.
882 function getRevision($version) {
883 $cache = &$this->_wikidb->_cache;
884 $pagename = &$this->_pagename;
887 return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
889 assert($version > 0);
890 $vdata = $cache->get_versiondata($pagename, $version);
893 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
898 * Get previous page revision.
900 * This method find the most recent revision before a specified
905 * @param integer $version Find most recent revision before this version.
906 * You can also use a WikiDB_PageRevision object to specify the $version.
908 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or false if the
909 * requested revision does not exist in the {@link WikiDB}. Note that
910 * unless $version is greater than zero, a revision (perhaps version zero,
911 * the default revision) will always be found.
913 function getRevisionBefore($version) {
914 $backend = &$this->_wikidb->_backend;
915 $pagename = &$this->_pagename;
917 $version = $this->_coerce_to_version($version);
922 $previous = $backend->get_previous_version($pagename, $version);
923 $revision = $this->getRevision($previous);
924 //$backend->unlock();
930 * Get all revisions of the WikiDB_Page.
932 * This does not include the version zero (default) revision in the
933 * returned revision set.
935 * @return WikiDB_PageRevisionIterator A
936 * WikiDB_PageRevisionIterator containing all revisions of this
937 * WikiDB_Page in reverse order by version number.
939 function getAllRevisions() {
940 $backend = &$this->_wikidb->_backend;
941 $revs = $backend->get_all_revisions($this->_pagename);
942 return new WikiDB_PageRevisionIterator($this->_wikidb, $revs);
946 * Find pages which link to or are linked from a page.
950 * @param boolean $reversed Which links to find: true for backlinks (default).
952 * @return WikiDB_PageIterator A WikiDB_PageIterator containing
953 * all matching pages.
955 function getLinks($reversed = true) {
956 $backend = &$this->_wikidb->_backend;
957 $result = $backend->get_links($this->_pagename, $reversed);
958 return new WikiDB_PageIterator($this->_wikidb, $result);
962 * Access WikiDB_Page meta-data.
966 * @param string $key Which meta data to get.
967 * Some reserved meta-data keys are:
969 * <dt>'locked'<dd> Is page locked?
970 * <dt>'hits' <dd> Page hit counter.
971 * <dt>'pref' <dd> Users preferences, stored in homepages.
972 * <dt>'owner' <dd> Default: first author_id. We might add a group with a dot here:
974 * <dt>'perm' <dd> Permission flag to authorize read/write/execution of
975 * page-headers and content.
976 * <dt>'score' <dd> Page score (not yet implement, do we need?)
979 * @return scalar The requested value, or false if the requested data
983 $cache = &$this->_wikidb->_cache;
984 if (!$key || $key[0] == '%')
986 $data = $cache->get_pagedata($this->_pagename);
987 return isset($data[$key]) ? $data[$key] : false;
991 * Get all the page meta-data as a hash.
993 * @return hash The page meta-data.
995 function getMetaData() {
996 $cache = &$this->_wikidb->_cache;
997 $data = $cache->get_pagedata($this->_pagename);
999 foreach ($data as $key => $val) {
1000 if (/*!empty($val) &&*/ $key[0] != '%')
1007 * Set page meta-data.
1012 * @param string $key Meta-data key to set.
1013 * @param string $newval New value.
1015 function set($key, $newval) {
1016 $cache = &$this->_wikidb->_cache;
1017 $pagename = &$this->_pagename;
1019 assert($key && $key[0] != '%');
1021 $data = $cache->get_pagedata($pagename);
1023 if (!empty($newval)) {
1024 if (!empty($data[$key]) && $data[$key] == $newval)
1025 return; // values identical, skip update.
1028 if (empty($data[$key]))
1029 return; // values identical, skip update.
1032 $cache->update_pagedata($pagename, array($key => $newval));
1036 * Increase page hit count.
1038 * FIXME: IS this needed? Probably not.
1040 * This is a convenience function.
1041 * <pre> $page->increaseHitCount(); </pre>
1042 * is functionally identical to
1043 * <pre> $page->set('hits',$page->get('hits')+1); </pre>
1045 * Note that this method may be implemented in more efficient ways
1046 * in certain backends.
1050 function increaseHitCount() {
1051 @$newhits = $this->get('hits') + 1;
1052 $this->set('hits', $newhits);
1056 * Return a string representation of the WikiDB_Page
1058 * This is really only for debugging.
1062 * @return string Printable representation of the WikiDB_Page.
1064 function asString () {
1066 printf("[%s:%s\n", get_class($this), $this->getName());
1067 print_r($this->getMetaData());
1069 $strval = ob_get_contents();
1077 * @param integer_or_object $version_or_pagerevision
1078 * Takes either the version number (and int) or a WikiDB_PageRevision
1080 * @return integer The version number.
1082 function _coerce_to_version($version_or_pagerevision) {
1083 if (method_exists($version_or_pagerevision, "getContent"))
1084 $version = $version_or_pagerevision->getVersion();
1086 $version = (int) $version_or_pagerevision;
1088 assert($version >= 0);
1092 function isUserPage ($include_empty = true) {
1093 if ($include_empty) {
1094 $current = $this->getCurrentRevision();
1095 if ($current->hasDefaultContents()) {
1099 return $this->get('pref') ? true : false;
1105 * This class represents a specific revision of a WikiDB_Page within
1108 * A WikiDB_PageRevision has read-only semantics. You may only create
1109 * new revisions (and delete old ones) --- you cannot modify existing
1112 class WikiDB_PageRevision
1114 var $_transformedContent = false; // set by WikiDB_Page::save()
1116 function WikiDB_PageRevision(&$wikidb, $pagename, $version,
1117 $versiondata = false)
1119 $this->_wikidb = &$wikidb;
1120 $this->_pagename = $pagename;
1121 $this->_version = $version;
1122 $this->_data = $versiondata ? $versiondata : array();
1126 * Get the WikiDB_Page which this revision belongs to.
1130 * @return WikiDB_Page The WikiDB_Page which this revision belongs to.
1132 function getPage() {
1133 return new WikiDB_Page($this->_wikidb, $this->_pagename);
1137 * Get the version number of this revision.
1141 * @return integer The version number of this revision.
1143 function getVersion() {
1144 return $this->_version;
1148 * Determine whether this revision has defaulted content.
1150 * The default revision (version 0) of each page, as well as any
1151 * pages which are created with empty content have their content
1152 * defaulted to something like:
1154 * Describe [ThisPage] here.
1159 * @return boolean Returns true if the page has default content.
1161 function hasDefaultContents() {
1162 $data = &$this->_data;
1163 return empty($data['%content']);
1167 * Get the content as an array of lines.
1171 * @return array An array of lines.
1172 * The lines should contain no trailing white space.
1174 function getContent() {
1175 return explode("\n", $this->getPackedContent());
1179 * Get the pagename of the revision.
1183 * @return string pagename.
1185 function getPageName() {
1186 return $this->_pagename;
1190 * Determine whether revision is the latest.
1194 * @return boolean True iff the revision is the latest (most recent) one.
1196 function isCurrent() {
1197 if (!isset($this->_iscurrent)) {
1198 $page = $this->getPage();
1199 $current = $page->getCurrentRevision();
1200 $this->_iscurrent = $this->getVersion() == $current->getVersion();
1202 return $this->_iscurrent;
1206 * Get the transformed content of a page.
1208 * @param string $pagetype Override the page-type of the revision.
1210 * @return object An XmlContent-like object containing the page transformed
1213 function getTransformedContent($pagetype_override=false) {
1214 $backend = &$this->_wikidb->_backend;
1216 if ($pagetype_override) {
1217 // Figure out the normal page-type for this page.
1218 $type = PageType::GetPageType($this->get('pagetype'));
1219 if ($type->getName() == $pagetype_override)
1220 $pagetype_override = false; // Not really an override...
1223 if ($pagetype_override) {
1224 // Overriden page type, don't cache (or check cache).
1225 return new TransformedText($this->getPage(),
1226 $this->getPackedContent(),
1227 $this->getMetaData(),
1228 $pagetype_override);
1231 $possibly_cache_results = true;
1233 if (defined('WIKIDB_NOCACHE_MARKUP') and WIKIDB_NOCACHE_MARKUP) {
1234 if (WIKIDB_NOCACHE_MARKUP == 'purge') {
1235 // flush cache for this page.
1236 $page = $this->getPage();
1237 $page->set('_cached_html', false);
1239 $possibly_cache_results = false;
1241 elseif (!$this->_transformedContent) {
1243 if ($this->isCurrent()) {
1244 $page = $this->getPage();
1245 $this->_transformedContent = TransformedText::unpack($page->get('_cached_html'));
1248 $possibly_cache_results = false;
1250 //$backend->unlock();
1253 if (!$this->_transformedContent) {
1254 $this->_transformedContent
1255 = new TransformedText($this->getPage(),
1256 $this->getPackedContent(),
1257 $this->getMetaData());
1259 if ($possibly_cache_results) {
1260 // If we're still the current version, cache the transfomed page.
1262 if ($this->isCurrent()) {
1263 $page->set('_cached_html', $this->_transformedContent->pack());
1265 //$backend->unlock();
1269 return $this->_transformedContent;
1273 * Get the content as a string.
1277 * @return string The page content.
1278 * Lines are separated by new-lines.
1280 function getPackedContent() {
1281 $data = &$this->_data;
1284 if (empty($data['%content'])) {
1285 include_once('lib/InlineParser.php');
1286 // Replace empty content with default value.
1287 return sprintf(_("Describe %s here."),
1288 "[" . WikiEscape($this->_pagename) . "]");
1291 // There is (non-default) content.
1292 assert($this->_version > 0);
1294 if (!is_string($data['%content'])) {
1295 // Content was not provided to us at init time.
1296 // (This is allowed because for some backends, fetching
1297 // the content may be expensive, and often is not wanted
1300 // In any case, now we need to get it.
1301 $data['%content'] = $this->_get_content();
1302 assert(is_string($data['%content']));
1305 return $data['%content'];
1308 function _get_content() {
1309 $cache = &$this->_wikidb->_cache;
1310 $pagename = $this->_pagename;
1311 $version = $this->_version;
1313 assert($version > 0);
1315 $newdata = $cache->get_versiondata($pagename, $version, true);
1317 assert(is_string($newdata['%content']));
1318 return $newdata['%content'];
1321 // else revision has been deleted... What to do?
1322 return __sprintf("Oops! Revision %s of %s seems to have been deleted!",
1323 $version, $pagename);
1328 * Get meta-data for this revision.
1333 * @param string $key Which meta-data to access.
1335 * Some reserved revision meta-data keys are:
1337 * <dt> 'mtime' <dd> Time this revision was created (seconds since midnight Jan 1, 1970.)
1338 * The 'mtime' meta-value is normally set automatically by the database
1339 * backend, but it may be specified explicitly when creating a new revision.
1341 * <dd> To ensure consistency of RecentChanges, the mtimes of the versions
1342 * of a page must be monotonically increasing. If an attempt is
1343 * made to create a new revision with an mtime less than that of
1344 * the preceeding revision, the new revisions timestamp is force
1345 * to be equal to that of the preceeding revision. In that case,
1346 * the originally requested mtime is preserved in 'orig_mtime'.
1347 * <dt> '_supplanted' <dd> Time this revision ceased to be the most recent.
1348 * This meta-value is <em>always</em> automatically maintained by the database
1349 * backend. (It is set from the 'mtime' meta-value of the superceding
1350 * revision.) '_supplanted' has a value of 'false' for the current revision.
1352 * FIXME: this could be refactored:
1354 * <dd> Author of the page (as he should be reported in, e.g. RecentChanges.)
1356 * <dd> Authenticated author of a page. This is used to identify
1357 * the distinctness of authors when cleaning old revisions from
1359 * <dt> 'is_minor_edit' <dd> Set if change was marked as a minor revision by the author.
1360 * <dt> 'summary' <dd> Short change summary entered by page author.
1363 * Meta-data keys must be valid C identifers (they have to start with a letter
1364 * or underscore, and can contain only alphanumerics and underscores.)
1366 * @return string The requested value, or false if the requested value
1369 function get($key) {
1370 if (!$key || $key[0] == '%')
1372 $data = &$this->_data;
1373 return isset($data[$key]) ? $data[$key] : false;
1377 * Get all the revision page meta-data as a hash.
1379 * @return hash The revision meta-data.
1381 function getMetaData() {
1383 foreach ($this->_data as $key => $val) {
1384 if (!empty($val) && $key[0] != '%')
1392 * Return a string representation of the revision.
1394 * This is really only for debugging.
1398 * @return string Printable representation of the WikiDB_Page.
1400 function asString () {
1402 printf("[%s:%d\n", get_class($this), $this->get('version'));
1403 print_r($this->_data);
1404 echo $this->getPackedContent() . "\n]\n";
1405 $strval = ob_get_contents();
1413 * A class which represents a sequence of WikiDB_Pages.
1415 class WikiDB_PageIterator
1417 function WikiDB_PageIterator(&$wikidb, &$pages) {
1418 $this->_pages = $pages;
1419 $this->_wikidb = &$wikidb;
1423 return $this->_pages->count();
1427 * Get next WikiDB_Page in sequence.
1431 * @return WikiDB_Page The next WikiDB_Page in the sequence.
1434 if ( ! ($next = $this->_pages->next()) )
1437 $pagename = &$next['pagename'];
1438 if (isset($next['pagedata']))
1439 $this->_wikidb->_cache->cache_data($next);
1441 return new WikiDB_Page($this->_wikidb, $pagename);
1445 * Release resources held by this iterator.
1447 * The iterator may not be used after free() is called.
1449 * There is no need to call free(), if next() has returned false.
1450 * (I.e. if you iterate through all the pages in the sequence,
1451 * you do not need to call free() --- you only need to call it
1452 * if you stop before the end of the iterator is reached.)
1457 $this->_pages->free();
1461 function asArray() {
1463 while ($page = $this->next())
1469 // Not yet used and problematic. Order should be set in the query, not afterwards.
1470 // See PageList::sortby
1471 function setSortby ($arg = false) {
1473 $arg = @$_GET['sortby'];
1475 $sortby = substr($arg,1);
1476 $order = substr($arg,0,1)=='+' ? 'ASC' : 'DESC';
1479 if (is_array($arg)) { // array('mtime' => 'desc')
1486 // available column types to sort by:
1487 // todo: we must provide access methods for the generic dumb/iterator
1488 $this->_types = explode(',','pagename,mtime,hits,version,author,locked,minor,markup');
1489 if (in_array($sortby,$this->_types))
1490 $this->_options['sortby'] = $sortby;
1492 trigger_error(sprintf("Argument %s '%s' ignored",'sortby',$sortby), E_USER_WARNING);
1493 if (in_array(strtoupper($order),'ASC','DESC'))
1494 $this->_options['order'] = strtoupper($order);
1496 trigger_error(sprintf("Argument %s '%s' ignored",'order',$order), E_USER_WARNING);
1502 * A class which represents a sequence of WikiDB_PageRevisions.
1504 class WikiDB_PageRevisionIterator
1506 function WikiDB_PageRevisionIterator(&$wikidb, &$revisions) {
1507 $this->_revisions = $revisions;
1508 $this->_wikidb = &$wikidb;
1512 return $this->_revisions->count();
1516 * Get next WikiDB_PageRevision in sequence.
1520 * @return WikiDB_PageRevision
1521 * The next WikiDB_PageRevision in the sequence.
1524 if ( ! ($next = $this->_revisions->next()) )
1527 $this->_wikidb->_cache->cache_data($next);
1529 $pagename = $next['pagename'];
1530 $version = $next['version'];
1531 $versiondata = $next['versiondata'];
1532 assert(is_string($pagename) and $pagename != '');
1533 assert(is_array($versiondata));
1534 assert($version > 0);
1536 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1541 * Release resources held by this iterator.
1543 * The iterator may not be used after free() is called.
1545 * There is no need to call free(), if next() has returned false.
1546 * (I.e. if you iterate through all the revisions in the sequence,
1547 * you do not need to call free() --- you only need to call it
1548 * if you stop before the end of the iterator is reached.)
1553 $this->_revisions->free();
1559 * Data cache used by WikiDB.
1561 * FIXME: Maybe rename this to caching_backend (or some such).
1567 // FIXME: beautify versiondata cache. Cache only limited data?
1569 function WikiDB_cache (&$backend) {
1570 $this->_backend = &$backend;
1572 $this->_pagedata_cache = array();
1573 $this->_versiondata_cache = array();
1574 array_push ($this->_versiondata_cache, array());
1575 $this->_glv_cache = array();
1579 $this->_pagedata_cache = false;
1580 $this->_versiondata_cache = false;
1581 $this->_glv_cache = false;
1584 function get_pagedata($pagename) {
1585 assert(is_string($pagename) && $pagename != '');
1586 $cache = &$this->_pagedata_cache;
1588 if (!isset($cache[$pagename]) || !is_array($cache[$pagename])) {
1589 $cache[$pagename] = $this->_backend->get_pagedata($pagename);
1590 if (empty($cache[$pagename]))
1591 $cache[$pagename] = array();
1594 return $cache[$pagename];
1597 function update_pagedata($pagename, $newdata) {
1598 assert(is_string($pagename) && $pagename != '');
1600 $this->_backend->update_pagedata($pagename, $newdata);
1602 if (is_array($this->_pagedata_cache[$pagename])) {
1603 $cachedata = &$this->_pagedata_cache[$pagename];
1604 foreach($newdata as $key => $val)
1605 $cachedata[$key] = $val;
1609 function invalidate_cache($pagename) {
1610 unset ($this->_pagedata_cache[$pagename]);
1611 unset ($this->_versiondata_cache[$pagename]);
1612 unset ($this->_glv_cache[$pagename]);
1615 function delete_page($pagename) {
1616 $this->_backend->delete_page($pagename);
1617 unset ($this->_pagedata_cache[$pagename]);
1618 unset ($this->_glv_cache[$pagename]);
1622 function cache_data($data) {
1623 if (isset($data['pagedata']))
1624 $this->_pagedata_cache[$data['pagename']] = $data['pagedata'];
1627 function get_versiondata($pagename, $version, $need_content = false) {
1628 // FIXME: Seriously ugly hackage
1629 if (defined ('USECACHE')){ //temporary - for debugging
1630 assert(is_string($pagename) && $pagename != '');
1631 // there is a bug here somewhere which results in an assertion failure at line 105
1632 // of ArchiveCleaner.php It goes away if we use the next line.
1633 $need_content = true;
1634 $nc = $need_content ? '1':'0';
1635 $cache = &$this->_versiondata_cache;
1636 if (!isset($cache[$pagename][$version][$nc])||
1637 !(is_array ($cache[$pagename])) || !(is_array ($cache[$pagename][$version]))) {
1638 $cache[$pagename][$version][$nc] =
1639 $this->_backend->get_versiondata($pagename,$version, $need_content);
1640 // If we have retrieved all data, we may as well set the cache for $need_content = false
1642 $cache[$pagename][$version]['0'] = $cache[$pagename][$version]['1'];
1645 $vdata = $cache[$pagename][$version][$nc];
1647 $vdata = $this->_backend->get_versiondata($pagename, $version, $need_content);
1650 if ($vdata && !empty($vdata['%pagedata']))
1651 $this->_pagedata_cache[$pagename] = $vdata['%pagedata'];
1655 function set_versiondata($pagename, $version, $data) {
1656 $new = $this->_backend->set_versiondata($pagename, $version, $data);
1658 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
1660 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
1661 // Is this necessary?
1662 unset($this->_glv_cache[$pagename]);
1665 function update_versiondata($pagename, $version, $data) {
1666 $new = $this->_backend->update_versiondata($pagename, $version, $data);
1668 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
1670 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
1671 // Is this necessary?
1672 unset($this->_glv_cache[$pagename]);
1675 function delete_versiondata($pagename, $version) {
1676 $new = $this->_backend->delete_versiondata($pagename, $version);
1677 unset ($this->_versiondata_cache[$pagename][$version]['1']);
1678 unset ($this->_versiondata_cache[$pagename][$version]['0']);
1679 unset ($this->_glv_cache[$pagename]);
1682 function get_latest_version($pagename) {
1683 if (defined('USECACHE')){
1684 assert (is_string($pagename) && $pagename != '');
1685 $cache = &$this->_glv_cache;
1686 if (!isset($cache[$pagename])) {
1687 $cache[$pagename] = $this->_backend->get_latest_version($pagename);
1688 if (empty($cache[$pagename]))
1689 $cache[$pagename] = 0;
1691 return $cache[$pagename];
1693 return $this->_backend->get_latest_version($pagename);
1699 // $Log: not supported by cvs2svn $
1700 // Revision 1.46 2004/04/26 20:44:34 rurban
1701 // locking table specific for better databases
1703 // Revision 1.45 2004/04/20 00:06:03 rurban
1704 // themable paging support
1706 // Revision 1.44 2004/04/19 18:27:45 rurban
1707 // Prevent from some PHP5 warnings (ref args, no :: object init)
1708 // php5 runs now through, just one wrong XmlElement object init missing
1709 // Removed unneccesary UpgradeUser lines
1710 // Changed WikiLink to omit version if current (RecentChanges)
1712 // Revision 1.43 2004/04/18 01:34:20 rurban
1713 // protect most_popular from sortby=mtime
1715 // Revision 1.42 2004/04/18 01:11:51 rurban
1716 // more numeric pagename fixes.
1717 // fixed action=upload with merge conflict warnings.
1718 // charset changed from constant to global (dynamic utf-8 switching)
1724 // c-basic-offset: 4
1725 // c-hanging-comment-ender-p: nil
1726 // indent-tabs-mode: nil