2 rcs_id('$Id: WikiDB.php,v 1.39 2004-03-30 02:14:03 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) && $pagename);
168 return new WikiDB_Page($this, $pagename);
173 //function nPages() {
178 * Determine whether page exists (in non-default form).
181 * $is_page = $dbi->isWikiPage($pagename);
185 * $page = $dbi->getPage($pagename);
186 * $current = $page->getCurrentRevision();
187 * $is_page = ! $current->hasDefaultContents();
189 * however isWikiPage may be implemented in a more efficient
190 * manner in certain back-ends.
194 * @param string $pagename string Which page to check.
196 * @return boolean True if the page actually exists with
197 * non-default contents in the WikiDataBase.
199 function isWikiPage ($pagename) {
200 $page = $this->getPage($pagename);
201 $current = $page->getCurrentRevision();
202 return ! $current->hasDefaultContents();
206 * Delete page from the WikiDB.
208 * Deletes all revisions of the page from the WikiDB. Also resets
209 * all page meta-data to the default values.
213 * @param string $pagename Name of page to delete.
215 function deletePage($pagename) {
216 $this->_cache->delete_page($pagename);
218 //How to create a RecentChanges entry with explaining summary?
220 $page = $this->getPage($pagename);
221 $current = $page->getCurrentRevision();
222 $meta = $current->_data;
223 $version = $current->getVersion();
224 $meta['summary'] = sprintf(_("renamed from %s"),$from);
225 $page->save($current->getPackedContent(), $version + 1, $meta);
230 * Retrieve all pages.
232 * Gets the set of all pages with non-default contents.
234 * FIXME: do we need this? I think so. The simple searches
239 * @param boolean $include_defaulted Normally pages whose most
240 * recent revision has empty content are considered to be
241 * non-existant. Unless $include_defaulted is set to true, those
242 * pages will not be returned.
244 * @return WikiDB_PageIterator A WikiDB_PageIterator which contains all pages
245 * in the WikiDB which have non-default contents.
247 function getAllPages($include_defaulted=false, $sortby=false, $limit=false) {
248 $result = $this->_backend->get_all_pages($include_defaulted,$sortby,$limit);
249 return new WikiDB_PageIterator($this, $result);
255 * Search for pages containing (or not containing) certain words
258 * Pages are returned in alphabetical order whenever it is
259 * practical to do so.
261 * FIXME: should titleSearch and fullSearch be combined? I think so.
264 * @param TextSearchQuery $search A TextSearchQuery object
265 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
266 * @see TextSearchQuery
268 function titleSearch($search) {
269 $result = $this->_backend->text_search($search);
270 return new WikiDB_PageIterator($this, $result);
276 * Search for pages containing (or not containing) certain words
277 * in their entire text (this includes the page content and the
280 * Pages are returned in alphabetical order whenever it is
281 * practical to do so.
285 * @param TextSearchQuery $search A TextSearchQuery object.
286 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
287 * @see TextSearchQuery
289 function fullSearch($search) {
290 $result = $this->_backend->text_search($search, 'full_text');
291 return new WikiDB_PageIterator($this, $result);
295 * Find the pages with the greatest hit counts.
297 * Pages are returned in reverse order by hit count.
301 * @param integer $limit The maximum number of pages to return.
302 * Set $limit to zero to return all pages. If $limit < 0, pages will
303 * be sorted in decreasing order of popularity.
305 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching
308 function mostPopular($limit = 20, $sortby = '') {
309 $result = $this->_backend->most_popular($limit, $sortby);
310 return new WikiDB_PageIterator($this, $result);
314 * Find recent page revisions.
316 * Revisions are returned in reverse order by creation time.
320 * @param hash $params This hash is used to specify various optional
324 * <dd> (integer) At most this many revisions will be returned.
326 * <dd> (integer) Only revisions since this time (unix-timestamp) will be returned.
327 * <dt> include_minor_revisions
328 * <dd> (boolean) Also include minor revisions. (Default is not to.)
329 * <dt> exclude_major_revisions
330 * <dd> (boolean) Don't include non-minor revisions.
331 * (Exclude_major_revisions implies include_minor_revisions.)
332 * <dt> include_all_revisions
333 * <dd> (boolean) Return all matching revisions for each page.
334 * Normally only the most recent matching revision is returned
338 * @return WikiDB_PageRevisionIterator A WikiDB_PageRevisionIterator containing the
339 * matching revisions.
341 function mostRecent($params = false) {
342 $result = $this->_backend->most_recent($params);
343 return new WikiDB_PageRevisionIterator($this, $result);
347 * Blog search. (experimental)
349 * Search for blog entries related to a certain page.
351 * FIXME: with pagetype support and perhaps a RegexpSearchQuery
352 * we can make sure we are returning *ONLY* blog pages to the
353 * main routine. Currently, we just use titleSearch which requires
354 * some further checking in lib/plugin/WikiBlog.php (BAD).
358 * @param string $order 'normal' (chronological) or 'reverse'
359 * @param string $page Find blog entries related to this page.
360 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the relevant pages.
362 // Deleting until such time as this is properly implemented...
363 // (As long as it's just a title search, just use titleSearch.)
364 //function blogSearch($page, $order) {
365 // //FIXME: implement ordering
367 // require_once('lib/TextSearchQuery.php');
368 // $query = new TextSearchQuery ($page . SUBPAGE_SEPARATOR);
370 // return $this->titleSearch($query);
374 * Call the appropriate backend method.
377 * @param string $from Page to rename
378 * @param string $to New name
379 * @param boolean $updateWikiLinks If the text in all pages should be replaced.
380 * @return boolean true or false
382 function renamePage($from, $to, $updateWikiLinks = false) {
383 assert(is_string($from) && $from);
384 assert(is_string($to) && $to);
386 if (method_exists($this->_backend,'rename_page')) {
387 $oldpage = $this->getPage($from);
388 $newpage = $this->getPage($to);
389 if ($oldpage->exists() and ! $newpage->exists()) {
390 if ($result = $this->_backend->rename_page($from, $to)) {
391 //update all WikiLinks in existing pages
392 if ($updateWikiLinks) {
393 //trigger_error(_("WikiDB::renamePage(..,..,updateWikiLinks) not yet implemented"),E_USER_WARNING);
394 require_once('lib/plugin/WikiAdminSearchReplace.php');
395 $links = $oldpage->getLinks();
396 while ($linked_page = $links->next()) {
397 WikiPlugin_WikiAdminSearchReplace::replaceHelper($this,$linked_page->getName(),$from,$to);
400 //create a RecentChanges entry with explaining summary
401 $page = $this->getPage($to);
402 $current = $page->getCurrentRevision();
403 $meta = $current->_data;
404 $version = $current->getVersion();
405 $meta['summary'] = sprintf(_("renamed from %s"),$from);
406 $page->save($current->getPackedContent(), $version + 1, $meta);
410 trigger_error(_("WikiDB::renamePage() not yet implemented for this backend"),E_USER_WARNING);
415 /** Get timestamp when database was last modified.
417 * @return string A string consisting of two integers,
418 * separated by a space. The first is the time in
419 * unix timestamp format, the second is a modification
420 * count for the database.
422 * The idea is that you can cast the return value to an
423 * int to get a timestamp, or you can use the string value
424 * as a good hash for the entire database.
426 function getTimestamp() {
427 $ts = $this->get('_timestamp');
428 return sprintf("%d %d", $ts[0], $ts[1]);
432 * Update the database timestamp.
436 $ts = $this->get('_timestamp');
437 $this->set('_timestamp', array(time(), $ts[1] + 1));
442 * Access WikiDB global meta-data.
444 * NOTE: this is currently implemented in a hackish and
445 * not very efficient manner.
449 * @param string $key Which meta data to get.
450 * Some reserved meta-data keys are:
452 * <dt>'_timestamp' <dd> Data used by getTimestamp().
455 * @return scalar The requested value, or false if the requested data
459 if (!$key || $key[0] == '%')
462 * Hack Alert: We can use any page (existing or not) to store
463 * this data (as long as we always use the same one.)
465 $gd = $this->getPage('global_data');
466 $data = $gd->get('__global');
468 if ($data && isset($data[$key]))
475 * Set global meta-data.
477 * NOTE: this is currently implemented in a hackish and
478 * not very efficient manner.
483 * @param string $key Meta-data key to set.
484 * @param string $newval New value.
486 function set($key, $newval) {
487 if (!$key || $key[0] == '%')
490 $gd = $this->getPage('global_data');
492 $data = $gd->get('__global');
499 $data[$key] = $newval;
501 $gd->set('__global', $data);
507 * An abstract base class which representing a wiki-page within a
510 * A WikiDB_Page contains a number (at least one) of
511 * WikiDB_PageRevisions.
515 function WikiDB_Page(&$wikidb, $pagename) {
516 $this->_wikidb = &$wikidb;
517 $this->_pagename = $pagename;
518 assert(!empty($this->_pagename));
522 * Get the name of the wiki page.
526 * @return string The page name.
529 return $this->_pagename;
533 $current = $this->getCurrentRevision();
534 return ! $current->hasDefaultContents();
538 * Delete an old revision of a WikiDB_Page.
540 * Deletes the specified revision of the page.
541 * It is a fatal error to attempt to delete the current revision.
545 * @param integer $version Which revision to delete. (You can also
546 * use a WikiDB_PageRevision object here.)
548 function deleteRevision($version) {
549 $backend = &$this->_wikidb->_backend;
550 $cache = &$this->_wikidb->_cache;
551 $pagename = &$this->_pagename;
553 $version = $this->_coerce_to_version($version);
558 $latestversion = $cache->get_latest_version($pagename);
559 if ($latestversion && $version == $latestversion) {
561 trigger_error(sprintf("Attempt to delete most recent revision of '%s'",
562 $pagename), E_USER_ERROR);
566 $cache->delete_versiondata($pagename, $version);
572 * Delete a revision, or possibly merge it with a previous
576 * Suppose an author make a (major) edit to a page. Shortly
577 * after that the same author makes a minor edit (e.g. to fix
578 * spelling mistakes he just made.)
580 * Now some time later, where cleaning out old saved revisions,
581 * and would like to delete his minor revision (since there's
582 * really no point in keeping minor revisions around for a long
585 * Note that the text after the minor revision probably represents
586 * what the author intended to write better than the text after
587 * the preceding major edit.
589 * So what we really want to do is merge the minor edit with the
592 * We will only do this when:
594 * <li>The revision being deleted is a minor one, and
595 * <li>It has the same author as the immediately preceding revision.
598 function mergeRevision($version) {
599 $backend = &$this->_wikidb->_backend;
600 $cache = &$this->_wikidb->_cache;
601 $pagename = &$this->_pagename;
603 $version = $this->_coerce_to_version($version);
608 $latestversion = $backend->get_latest_version($pagename);
609 if ($latestversion && $version == $latestversion) {
611 trigger_error(sprintf("Attempt to merge most recent revision of '%s'",
612 $pagename), E_USER_ERROR);
616 $versiondata = $cache->get_versiondata($pagename, $version, true);
618 // Not there? ... we're done!
623 if ($versiondata['is_minor_edit']) {
624 $previous = $backend->get_previous_version($pagename, $version);
626 $prevdata = $cache->get_versiondata($pagename, $previous);
627 if ($prevdata['author_id'] == $versiondata['author_id']) {
628 // This is a minor revision, previous version is
629 // by the same author. We will merge the
631 $cache->update_versiondata($pagename, $previous,
632 array('%content' => $versiondata['%content'],
633 '_supplanted' => $versiondata['_supplanted']));
638 $cache->delete_versiondata($pagename, $version);
644 * Create a new revision of a {@link WikiDB_Page}.
648 * @param int $version Version number for new revision.
649 * To ensure proper serialization of edits, $version must be
650 * exactly one higher than the current latest version.
651 * (You can defeat this check by setting $version to
652 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
654 * @param string $content Contents of new revision.
656 * @param hash $metadata Metadata for new revision.
657 * All values in the hash should be scalars (strings or integers).
659 * @param array $links List of pagenames which this page links to.
661 * @return WikiDB_PageRevision Returns the new WikiDB_PageRevision object. If
662 * $version was incorrect, returns false
664 function createRevision($version, &$content, $metadata, $links) {
665 $backend = &$this->_wikidb->_backend;
666 $cache = &$this->_wikidb->_cache;
667 $pagename = &$this->_pagename;
671 $latestversion = $backend->get_latest_version($pagename);
672 $newversion = $latestversion + 1;
673 assert($newversion >= 1);
675 if ($version != WIKIDB_FORCE_CREATE && $version != $newversion) {
682 foreach ($data as $key => $val) {
683 if (empty($val) || $key[0] == '_' || $key[0] == '%')
687 assert(!empty($data['author']));
688 if (empty($data['author_id']))
689 @$data['author_id'] = $data['author'];
691 if (empty($data['mtime']))
692 $data['mtime'] = time();
694 if ($latestversion) {
695 // Ensure mtimes are monotonic.
696 $pdata = $cache->get_versiondata($pagename, $latestversion);
697 if ($data['mtime'] < $pdata['mtime']) {
698 trigger_error(sprintf(_("%s: Date of new revision is %s"),
699 $pagename,"'non-monotonic'"),
701 $data['orig_mtime'] = $data['mtime'];
702 $data['mtime'] = $pdata['mtime'];
705 // FIXME: use (possibly user specified) 'mtime' time or
707 $cache->update_versiondata($pagename, $latestversion,
708 array('_supplanted' => $data['mtime']));
711 $data['%content'] = &$content;
713 $cache->set_versiondata($pagename, $newversion, $data);
715 //$cache->update_pagedata($pagename, array(':latestversion' => $newversion,
716 //':deleted' => empty($content)));
718 $backend->set_links($pagename, $links);
722 return new WikiDB_PageRevision($this->_wikidb, $pagename, $newversion,
726 /** A higher-level interface to createRevision.
728 * This takes care of computing the links, and storing
729 * a cached version of the transformed wiki-text.
731 * @param string $wikitext The page content.
733 * @param int $version Version number for new revision.
734 * To ensure proper serialization of edits, $version must be
735 * exactly one higher than the current latest version.
736 * (You can defeat this check by setting $version to
737 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
739 * @param hash $meta Meta-data for new revision.
741 function save($wikitext, $version, $meta) {
742 $formatted = new TransformedText($this, $wikitext, $meta);
743 $type = $formatted->getType();
744 $meta['pagetype'] = $type->getName();
745 $links = $formatted->getWikiPageLinks();
747 $backend = &$this->_wikidb->_backend;
749 $newrevision = $this->createRevision($version, $wikitext, $meta, $links);
751 if (!defined('WIKIDB_NOCACHE_MARKUP') or !WIKIDB_NOCACHE_MARKUP)
752 $this->set('_cached_html', $formatted->pack());
755 // FIXME: probably should have some global state information
756 // in the backend to control when to optimize.
758 // We're doing this here rather than in createRevision because
759 // postgres can't optimize while locked.
760 if (time() % 50 == 0) {
761 if ($backend->optimize())
762 trigger_error(sprintf(_("Optimizing %s"),'backend'), E_USER_NOTICE);
765 /* Generate notification emails */
766 if (isa($newrevision, 'wikidb_pagerevision')) {
767 // Save didn't fail because of concurrent updates.
768 $notify = $this->get('notify');
769 if (!empty($notify) and is_array($notify)) {
770 foreach ($notify as $page => $users) {
771 if (ereg($page,$this->_pagename)) {
773 foreach ($users as $userid => $user) {
774 if (!empty($user['verified']) and !empty($user['email']))
775 $emails[] = $user['email'];
776 elseif (DEBUG and !empty($user['email'])) {
778 //do a dynamic emailVerified check update
779 $u = $request->getUser();
780 if ($u->UserName() == $userid) {
781 if ($request->_prefs->get('emailVerified')) {
782 $emails[] = $user['email'];
783 $notify[$page][$userid]['verified'] = 1;
784 $request->_dbi->set('notify',$notify);
787 $u = WikiUser($userid);
788 if ($u->_prefs->get('emailVerified')) {
789 $emails[] = $user['email'];
790 $notify[$page][$userid]['verified'] = 1;
791 $request->_dbi->set('notify',$notify);
794 // do no verification
795 if (DEBUG and !in_array($user['email'],$emails))
796 $emails[] = $user['email'];
799 if (!empty($emails)) {
800 $subject = sprintf(_("PageChange Notification %s"),$page);
801 $diff = WikiUrl($this->_pagename, array('action'=>'diff',true));
802 $emails = join(',',$emails);
803 if (mail($emails,"[".WIKI_NAME."] ".$subject,$subject."\n".$diff))
804 trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
805 $this->_pagename, $emails), E_USER_NOTICE);
807 trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
808 $this->_pagename, $emails), E_USER_WARNING);
815 $newrevision->_transformedContent = $formatted;
820 * Get the most recent revision of a page.
824 * @return WikiDB_PageRevision The current WikiDB_PageRevision object.
826 function getCurrentRevision() {
827 $backend = &$this->_wikidb->_backend;
828 $cache = &$this->_wikidb->_cache;
829 $pagename = &$this->_pagename;
832 $version = $cache->get_latest_version($pagename);
833 $revision = $this->getRevision($version);
840 * Get a specific revision of a WikiDB_Page.
844 * @param integer $version Which revision to get.
846 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or
847 * false if the requested revision does not exist in the {@link WikiDB}.
848 * Note that version zero of any page always exists.
850 function getRevision($version) {
851 $cache = &$this->_wikidb->_cache;
852 $pagename = &$this->_pagename;
855 return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
857 assert($version > 0);
858 $vdata = $cache->get_versiondata($pagename, $version);
861 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
866 * Get previous page revision.
868 * This method find the most recent revision before a specified
873 * @param integer $version Find most recent revision before this version.
874 * You can also use a WikiDB_PageRevision object to specify the $version.
876 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or false if the
877 * requested revision does not exist in the {@link WikiDB}. Note that
878 * unless $version is greater than zero, a revision (perhaps version zero,
879 * the default revision) will always be found.
881 function getRevisionBefore($version) {
882 $backend = &$this->_wikidb->_backend;
883 $pagename = &$this->_pagename;
885 $version = $this->_coerce_to_version($version);
890 $previous = $backend->get_previous_version($pagename, $version);
891 $revision = $this->getRevision($previous);
898 * Get all revisions of the WikiDB_Page.
900 * This does not include the version zero (default) revision in the
901 * returned revision set.
903 * @return WikiDB_PageRevisionIterator A
904 * WikiDB_PageRevisionIterator containing all revisions of this
905 * WikiDB_Page in reverse order by version number.
907 function getAllRevisions() {
908 $backend = &$this->_wikidb->_backend;
909 $revs = $backend->get_all_revisions($this->_pagename);
910 return new WikiDB_PageRevisionIterator($this->_wikidb, $revs);
914 * Find pages which link to or are linked from a page.
918 * @param boolean $reversed Which links to find: true for backlinks (default).
920 * @return WikiDB_PageIterator A WikiDB_PageIterator containing
921 * all matching pages.
923 function getLinks($reversed = true) {
924 $backend = &$this->_wikidb->_backend;
925 $result = $backend->get_links($this->_pagename, $reversed);
926 return new WikiDB_PageIterator($this->_wikidb, $result);
930 * Access WikiDB_Page meta-data.
934 * @param string $key Which meta data to get.
935 * Some reserved meta-data keys are:
937 * <dt>'locked'<dd> Is page locked?
938 * <dt>'hits' <dd> Page hit counter.
939 * <dt>'pref' <dd> Users preferences, stored in homepages.
940 * <dt>'owner' <dd> Default: first author_id. We might add a group with a dot here:
942 * <dt>'perm' <dd> Permission flag to authorize read/write/execution of
943 * page-headers and content.
944 * <dt>'score' <dd> Page score (not yet implement, do we need?)
947 * @return scalar The requested value, or false if the requested data
951 $cache = &$this->_wikidb->_cache;
952 if (!$key || $key[0] == '%')
954 $data = $cache->get_pagedata($this->_pagename);
955 return isset($data[$key]) ? $data[$key] : false;
959 * Get all the page meta-data as a hash.
961 * @return hash The page meta-data.
963 function getMetaData() {
964 $cache = &$this->_wikidb->_cache;
965 $data = $cache->get_pagedata($this->_pagename);
967 foreach ($data as $key => $val) {
968 if (/*!empty($val) &&*/ $key[0] != '%')
975 * Set page meta-data.
980 * @param string $key Meta-data key to set.
981 * @param string $newval New value.
983 function set($key, $newval) {
984 $cache = &$this->_wikidb->_cache;
985 $pagename = &$this->_pagename;
987 assert($key && $key[0] != '%');
989 $data = $cache->get_pagedata($pagename);
991 if (!empty($newval)) {
992 if (!empty($data[$key]) && $data[$key] == $newval)
993 return; // values identical, skip update.
996 if (empty($data[$key]))
997 return; // values identical, skip update.
1000 $cache->update_pagedata($pagename, array($key => $newval));
1004 * Increase page hit count.
1006 * FIXME: IS this needed? Probably not.
1008 * This is a convenience function.
1009 * <pre> $page->increaseHitCount(); </pre>
1010 * is functionally identical to
1011 * <pre> $page->set('hits',$page->get('hits')+1); </pre>
1013 * Note that this method may be implemented in more efficient ways
1014 * in certain backends.
1018 function increaseHitCount() {
1019 @$newhits = $this->get('hits') + 1;
1020 $this->set('hits', $newhits);
1024 * Return a string representation of the WikiDB_Page
1026 * This is really only for debugging.
1030 * @return string Printable representation of the WikiDB_Page.
1032 function asString () {
1034 printf("[%s:%s\n", get_class($this), $this->getName());
1035 print_r($this->getMetaData());
1037 $strval = ob_get_contents();
1045 * @param integer_or_object $version_or_pagerevision
1046 * Takes either the version number (and int) or a WikiDB_PageRevision
1048 * @return integer The version number.
1050 function _coerce_to_version($version_or_pagerevision) {
1051 if (method_exists($version_or_pagerevision, "getContent"))
1052 $version = $version_or_pagerevision->getVersion();
1054 $version = (int) $version_or_pagerevision;
1056 assert($version >= 0);
1060 function isUserPage ($include_empty = true) {
1061 if ($include_empty) {
1062 $current = $this->getCurrentRevision();
1063 if ($current->hasDefaultContents()) {
1067 return $this->get('pref') ? true : false;
1073 * This class represents a specific revision of a WikiDB_Page within
1076 * A WikiDB_PageRevision has read-only semantics. You may only create
1077 * new revisions (and delete old ones) --- you cannot modify existing
1080 class WikiDB_PageRevision
1082 var $_transformedContent = false; // set by WikiDB_Page::save()
1084 function WikiDB_PageRevision(&$wikidb, $pagename, $version,
1085 $versiondata = false)
1087 $this->_wikidb = &$wikidb;
1088 $this->_pagename = $pagename;
1089 $this->_version = $version;
1090 $this->_data = $versiondata ? $versiondata : array();
1094 * Get the WikiDB_Page which this revision belongs to.
1098 * @return WikiDB_Page The WikiDB_Page which this revision belongs to.
1100 function getPage() {
1101 return new WikiDB_Page($this->_wikidb, $this->_pagename);
1105 * Get the version number of this revision.
1109 * @return integer The version number of this revision.
1111 function getVersion() {
1112 return $this->_version;
1116 * Determine whether this revision has defaulted content.
1118 * The default revision (version 0) of each page, as well as any
1119 * pages which are created with empty content have their content
1120 * defaulted to something like:
1122 * Describe [ThisPage] here.
1127 * @return boolean Returns true if the page has default content.
1129 function hasDefaultContents() {
1130 $data = &$this->_data;
1131 return empty($data['%content']);
1135 * Get the content as an array of lines.
1139 * @return array An array of lines.
1140 * The lines should contain no trailing white space.
1142 function getContent() {
1143 return explode("\n", $this->getPackedContent());
1147 * Get the pagename of the revision.
1151 * @return string pagename.
1153 function getPageName() {
1154 return $this->_pagename;
1158 * Determine whether revision is the latest.
1162 * @return boolean True iff the revision is the latest (most recent) one.
1164 function isCurrent() {
1165 if (!isset($this->_iscurrent)) {
1166 $page = $this->getPage();
1167 $current = $page->getCurrentRevision();
1168 $this->_iscurrent = $this->getVersion() == $current->getVersion();
1170 return $this->_iscurrent;
1174 * Get the transformed content of a page.
1176 * @param string $pagetype Override the page-type of the revision.
1178 * @return object An XmlContent-like object containing the page transformed
1181 function getTransformedContent($pagetype_override=false) {
1182 $backend = &$this->_wikidb->_backend;
1184 if ($pagetype_override) {
1185 // Figure out the normal page-type for this page.
1186 $type = PageType::GetPageType($this->get('pagetype'));
1187 if ($type->getName() == $pagetype_override)
1188 $pagetype_override = false; // Not really an override...
1191 if ($pagetype_override) {
1192 // Overriden page type, don't cache (or check cache).
1193 return new TransformedText($this->getPage(),
1194 $this->getPackedContent(),
1195 $this->getMetaData(),
1196 $pagetype_override);
1199 $possibly_cache_results = true;
1201 if (defined('WIKIDB_NOCACHE_MARKUP') and WIKIDB_NOCACHE_MARKUP) {
1202 if (WIKIDB_NOCACHE_MARKUP == 'purge') {
1203 // flush cache for this page.
1204 $page = $this->getPage();
1205 $page->set('_cached_html', false);
1207 $possibly_cache_results = false;
1209 elseif (!$this->_transformedContent) {
1211 if ($this->isCurrent()) {
1212 $page = $this->getPage();
1213 $this->_transformedContent = TransformedText::unpack($page->get('_cached_html'));
1216 $possibly_cache_results = false;
1221 if (!$this->_transformedContent) {
1222 $this->_transformedContent
1223 = new TransformedText($this->getPage(),
1224 $this->getPackedContent(),
1225 $this->getMetaData());
1227 if ($possibly_cache_results) {
1228 // If we're still the current version, cache the transfomed page.
1230 if ($this->isCurrent()) {
1231 $page->set('_cached_html', $this->_transformedContent->pack());
1237 return $this->_transformedContent;
1241 * Get the content as a string.
1245 * @return string The page content.
1246 * Lines are separated by new-lines.
1248 function getPackedContent() {
1249 $data = &$this->_data;
1252 if (empty($data['%content'])) {
1253 include_once('lib/InlineParser.php');
1254 // Replace empty content with default value.
1255 return sprintf(_("Describe %s here."),
1256 "[" . WikiEscape($this->_pagename) . "]");
1259 // There is (non-default) content.
1260 assert($this->_version > 0);
1262 if (!is_string($data['%content'])) {
1263 // Content was not provided to us at init time.
1264 // (This is allowed because for some backends, fetching
1265 // the content may be expensive, and often is not wanted
1268 // In any case, now we need to get it.
1269 $data['%content'] = $this->_get_content();
1270 assert(is_string($data['%content']));
1273 return $data['%content'];
1276 function _get_content() {
1277 $cache = &$this->_wikidb->_cache;
1278 $pagename = $this->_pagename;
1279 $version = $this->_version;
1281 assert($version > 0);
1283 $newdata = $cache->get_versiondata($pagename, $version, true);
1285 assert(is_string($newdata['%content']));
1286 return $newdata['%content'];
1289 // else revision has been deleted... What to do?
1290 return __sprintf("Oops! Revision %s of %s seems to have been deleted!",
1291 $version, $pagename);
1296 * Get meta-data for this revision.
1301 * @param string $key Which meta-data to access.
1303 * Some reserved revision meta-data keys are:
1305 * <dt> 'mtime' <dd> Time this revision was created (seconds since midnight Jan 1, 1970.)
1306 * The 'mtime' meta-value is normally set automatically by the database
1307 * backend, but it may be specified explicitly when creating a new revision.
1309 * <dd> To ensure consistency of RecentChanges, the mtimes of the versions
1310 * of a page must be monotonically increasing. If an attempt is
1311 * made to create a new revision with an mtime less than that of
1312 * the preceeding revision, the new revisions timestamp is force
1313 * to be equal to that of the preceeding revision. In that case,
1314 * the originally requested mtime is preserved in 'orig_mtime'.
1315 * <dt> '_supplanted' <dd> Time this revision ceased to be the most recent.
1316 * This meta-value is <em>always</em> automatically maintained by the database
1317 * backend. (It is set from the 'mtime' meta-value of the superceding
1318 * revision.) '_supplanted' has a value of 'false' for the current revision.
1320 * FIXME: this could be refactored:
1322 * <dd> Author of the page (as he should be reported in, e.g. RecentChanges.)
1324 * <dd> Authenticated author of a page. This is used to identify
1325 * the distinctness of authors when cleaning old revisions from
1327 * <dt> 'is_minor_edit' <dd> Set if change was marked as a minor revision by the author.
1328 * <dt> 'summary' <dd> Short change summary entered by page author.
1331 * Meta-data keys must be valid C identifers (they have to start with a letter
1332 * or underscore, and can contain only alphanumerics and underscores.)
1334 * @return string The requested value, or false if the requested value
1337 function get($key) {
1338 if (!$key || $key[0] == '%')
1340 $data = &$this->_data;
1341 return isset($data[$key]) ? $data[$key] : false;
1345 * Get all the revision page meta-data as a hash.
1347 * @return hash The revision meta-data.
1349 function getMetaData() {
1351 foreach ($this->_data as $key => $val) {
1352 if (!empty($val) && $key[0] != '%')
1360 * Return a string representation of the revision.
1362 * This is really only for debugging.
1366 * @return string Printable representation of the WikiDB_Page.
1368 function asString () {
1370 printf("[%s:%d\n", get_class($this), $this->get('version'));
1371 print_r($this->_data);
1372 echo $this->getPackedContent() . "\n]\n";
1373 $strval = ob_get_contents();
1381 * A class which represents a sequence of WikiDB_Pages.
1383 class WikiDB_PageIterator
1385 function WikiDB_PageIterator(&$wikidb, &$pages) {
1386 $this->_pages = $pages;
1387 $this->_wikidb = &$wikidb;
1391 return $this->_pages->count();
1395 * Get next WikiDB_Page in sequence.
1399 * @return WikiDB_Page The next WikiDB_Page in the sequence.
1402 if ( ! ($next = $this->_pages->next()) )
1405 $pagename = &$next['pagename'];
1406 if (isset($next['pagedata']))
1407 $this->_wikidb->_cache->cache_data($next);
1409 return new WikiDB_Page($this->_wikidb, $pagename);
1413 * Release resources held by this iterator.
1415 * The iterator may not be used after free() is called.
1417 * There is no need to call free(), if next() has returned false.
1418 * (I.e. if you iterate through all the pages in the sequence,
1419 * you do not need to call free() --- you only need to call it
1420 * if you stop before the end of the iterator is reached.)
1425 $this->_pages->free();
1428 // Not yet used and problematic. Order should be set in the query, not afterwards.
1429 // See PageList::sortby
1430 function setSortby ($arg = false) {
1432 $arg = @$_GET['sortby'];
1434 $sortby = substr($arg,1);
1435 $order = substr($arg,0,1)=='+' ? 'ASC' : 'DESC';
1438 if (is_array($arg)) { // array('mtime' => 'desc')
1445 // available column types to sort by:
1446 // todo: we must provide access methods for the generic dumb/iterator
1447 $this->_types = explode(',','pagename,mtime,hits,version,author,locked,minor,markup');
1448 if (in_array($sortby,$this->_types))
1449 $this->_options['sortby'] = $sortby;
1451 trigger_error(sprintf("Argument %s '%s' ignored",'sortby',$sortby), E_USER_WARNING);
1452 if (in_array(strtoupper($order),'ASC','DESC'))
1453 $this->_options['order'] = strtoupper($order);
1455 trigger_error(sprintf("Argument %s '%s' ignored",'order',$order), E_USER_WARNING);
1461 * A class which represents a sequence of WikiDB_PageRevisions.
1463 class WikiDB_PageRevisionIterator
1465 function WikiDB_PageRevisionIterator(&$wikidb, &$revisions) {
1466 $this->_revisions = $revisions;
1467 $this->_wikidb = &$wikidb;
1471 return $this->_revisions->count();
1475 * Get next WikiDB_PageRevision in sequence.
1479 * @return WikiDB_PageRevision
1480 * The next WikiDB_PageRevision in the sequence.
1483 if ( ! ($next = $this->_revisions->next()) )
1486 $this->_wikidb->_cache->cache_data($next);
1488 $pagename = $next['pagename'];
1489 $version = $next['version'];
1490 $versiondata = $next['versiondata'];
1491 assert(!empty($pagename));
1492 assert(is_array($versiondata));
1493 assert($version > 0);
1495 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1500 * Release resources held by this iterator.
1502 * The iterator may not be used after free() is called.
1504 * There is no need to call free(), if next() has returned false.
1505 * (I.e. if you iterate through all the revisions in the sequence,
1506 * you do not need to call free() --- you only need to call it
1507 * if you stop before the end of the iterator is reached.)
1512 $this->_revisions->free();
1518 * Data cache used by WikiDB.
1520 * FIXME: Maybe rename this to caching_backend (or some such).
1526 // FIXME: beautify versiondata cache. Cache only limited data?
1528 function WikiDB_cache (&$backend) {
1529 $this->_backend = &$backend;
1531 $this->_pagedata_cache = array();
1532 $this->_versiondata_cache = array();
1533 array_push ($this->_versiondata_cache, array());
1534 $this->_glv_cache = array();
1538 $this->_pagedata_cache = false;
1539 $this->_versiondata_cache = false;
1540 $this->_glv_cache = false;
1543 function get_pagedata($pagename) {
1544 assert(is_string($pagename) && $pagename);
1545 $cache = &$this->_pagedata_cache;
1547 if (!isset($cache[$pagename]) || !is_array($cache[$pagename])) {
1548 $cache[$pagename] = $this->_backend->get_pagedata($pagename);
1549 if (empty($cache[$pagename]))
1550 $cache[$pagename] = array();
1553 return $cache[$pagename];
1556 function update_pagedata($pagename, $newdata) {
1557 assert(is_string($pagename) && $pagename);
1559 $this->_backend->update_pagedata($pagename, $newdata);
1561 if (is_array($this->_pagedata_cache[$pagename])) {
1562 $cachedata = &$this->_pagedata_cache[$pagename];
1563 foreach($newdata as $key => $val)
1564 $cachedata[$key] = $val;
1568 function invalidate_cache($pagename) {
1569 unset ($this->_pagedata_cache[$pagename]);
1570 unset ($this->_versiondata_cache[$pagename]);
1571 unset ($this->_glv_cache[$pagename]);
1574 function delete_page($pagename) {
1575 $this->_backend->delete_page($pagename);
1576 unset ($this->_pagedata_cache[$pagename]);
1577 unset ($this->_glv_cache[$pagename]);
1581 function cache_data($data) {
1582 if (isset($data['pagedata']))
1583 $this->_pagedata_cache[$data['pagename']] = $data['pagedata'];
1586 function get_versiondata($pagename, $version, $need_content = false) {
1587 // FIXME: Seriously ugly hackage
1588 if (defined ('USECACHE')){ //temporary - for debugging
1589 assert(is_string($pagename) && $pagename);
1590 // there is a bug here somewhere which results in an assertion failure at line 105
1591 // of ArchiveCleaner.php It goes away if we use the next line.
1592 $need_content = true;
1593 $nc = $need_content ? '1':'0';
1594 $cache = &$this->_versiondata_cache;
1595 if (!isset($cache[$pagename][$version][$nc])||
1596 !(is_array ($cache[$pagename])) || !(is_array ($cache[$pagename][$version]))) {
1597 $cache[$pagename][$version][$nc] =
1598 $this->_backend->get_versiondata($pagename,$version, $need_content);
1599 // If we have retrieved all data, we may as well set the cache for $need_content = false
1601 $cache[$pagename][$version]['0'] = $cache[$pagename][$version]['1'];
1604 $vdata = $cache[$pagename][$version][$nc];
1606 $vdata = $this->_backend->get_versiondata($pagename, $version, $need_content);
1609 if ($vdata && !empty($vdata['%pagedata']))
1610 $this->_pagedata_cache[$pagename] = $vdata['%pagedata'];
1614 function set_versiondata($pagename, $version, $data) {
1615 $new = $this->_backend->set_versiondata($pagename, $version, $data);
1617 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
1619 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
1620 // Is this necessary?
1621 unset($this->_glv_cache[$pagename]);
1624 function update_versiondata($pagename, $version, $data) {
1625 $new = $this->_backend->update_versiondata($pagename, $version, $data);
1627 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
1629 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
1630 // Is this necessary?
1631 unset($this->_glv_cache[$pagename]);
1634 function delete_versiondata($pagename, $version) {
1635 $new = $this->_backend->delete_versiondata($pagename, $version);
1636 unset ($this->_versiondata_cache[$pagename][$version]['1']);
1637 unset ($this->_versiondata_cache[$pagename][$version]['0']);
1638 unset ($this->_glv_cache[$pagename]);
1641 function get_latest_version($pagename) {
1642 if (defined('USECACHE')){
1643 assert (is_string($pagename) && $pagename);
1644 $cache = &$this->_glv_cache;
1645 if (!isset($cache[$pagename])) {
1646 $cache[$pagename] = $this->_backend->get_latest_version($pagename);
1647 if (empty($cache[$pagename]))
1648 $cache[$pagename] = 0;
1650 return $cache[$pagename];
1652 return $this->_backend->get_latest_version($pagename);
1661 // c-basic-offset: 4
1662 // c-hanging-comment-ender-p: nil
1663 // indent-tabs-mode: nil