4 require_once('lib/PageType.php');
7 * The classes in the file define the interface to the
11 * @author Geoffrey T. Dairiki <dairiki@dairiki.org>
12 * Minor enhancements by Reini Urban
16 * Force the creation of a new revision.
17 * @see WikiDB_Page::createRevision()
19 if (!defined('WIKIDB_FORCE_CREATE'))
20 define('WIKIDB_FORCE_CREATE', -1);
23 * Abstract base class for the database used by PhpWiki.
25 * A <tt>WikiDB</tt> is a container for <tt>WikiDB_Page</tt>s which in
26 * turn contain <tt>WikiDB_PageRevision</tt>s.
28 * Conceptually a <tt>WikiDB</tt> contains all possible
29 * <tt>WikiDB_Page</tt>s, whether they have been initialized or not.
30 * Since all possible pages are already contained in a WikiDB, a call
31 * to WikiDB::getPage() will never fail (barring bugs and
32 * e.g. filesystem or SQL database problems.)
34 * Also each <tt>WikiDB_Page</tt> always contains at least one
35 * <tt>WikiDB_PageRevision</tt>: the default content (e.g. "Describe
36 * [PageName] here."). This default content has a version number of
39 * <tt>WikiDB_PageRevision</tt>s have read-only semantics. One can
40 * only create new revisions or delete old ones --- one can not modify
41 * an existing revision.
45 * Open a WikiDB database.
47 * This is a static member function. This function inspects its
48 * arguments to determine the proper subclass of WikiDB to
49 * instantiate, and then it instantiates it.
53 * @param hash $dbparams Database configuration parameters.
54 * Some pertinent parameters are:
57 * <dd> The back-end type. Current supported types are:
60 * <dd> Generic SQL backend based on the PEAR/DB database abstraction
61 * library. (More stable and conservative)
63 * <dd> Another generic SQL backend. (More current features are tested here. Much faster)
65 * <dd> Dba based backend. The default and by far the fastest.
73 * <dd> (Used by the SQL and ADODB backends.)
74 * The DSN specifying which database to connect to.
77 * <dd> Prefix to be prepended to database tables (and file names).
80 * <dd> (Used by the dba backend.)
81 * Which directory db files reside in.
84 * <dd> Used only by the dba backend so far.
85 * And: When optimizing mysql it closes timed out mysql processes.
86 * otherwise only used for dba: Timeout in seconds for opening (and
87 * obtaining lock) on the dbm file.
90 * <dd> (Used by the dba backend.)
92 * Which dba handler to use. Good choices are probably either
96 * @return WikiDB A WikiDB object.
98 function open ($dbparams) {
99 $dbtype = $dbparams{'dbtype'};
100 include_once("lib/WikiDB/$dbtype.php");
102 $class = 'WikiDB_' . $dbtype;
103 return new $class ($dbparams);
113 function WikiDB (&$backend, $dbparams) {
114 $this->_backend =& $backend;
115 // don't do the following with the auth_dsn!
116 if (isset($dbparams['auth_dsn'])) return;
118 $this->_cache = new WikiDB_cache($backend);
119 if (!empty($GLOBALS['request'])) $GLOBALS['request']->_dbi = $this;
121 // If the database doesn't yet have a timestamp, initialize it now.
122 if ($this->get('_timestamp') === false)
126 if ((int)DEBUG & _DEBUG_SQL) {
127 $this->_backend->check();
132 * Close database connection.
134 * The database may no longer be used after it is closed.
136 * Closing a WikiDB invalidates all <tt>WikiDB_Page</tt>s,
137 * <tt>WikiDB_PageRevision</tt>s and <tt>WikiDB_PageIterator</tt>s
138 * which have been obtained from it.
143 $this->_backend->close();
144 $this->_cache->close();
148 * Get a WikiDB_Page from a WikiDB.
150 * A {@link WikiDB} consists of the (infinite) set of all possible pages,
151 * therefore this method never fails.
154 * @param string $pagename Which page to get.
155 * @return WikiDB_Page The requested WikiDB_Page.
157 function getPage($pagename) {
158 static $error_displayed = false;
159 $pagename = (string) $pagename;
161 if ($pagename === '') {
162 if ($error_displayed) return false;
163 $error_displayed = true;
164 if (function_exists("xdebug_get_function_stack"))
165 var_dump(xdebug_get_function_stack());
166 trigger_error("empty pagename", E_USER_WARNING);
170 assert($pagename != '');
172 return new WikiDB_Page($this, $pagename);
176 * Determine whether page exists (in non-default form).
179 * $is_page = $dbi->isWikiPage($pagename);
183 * $page = $dbi->getPage($pagename);
184 * $current = $page->getCurrentRevision();
185 * $is_page = ! $current->hasDefaultContents();
187 * however isWikiPage may be implemented in a more efficient
188 * manner in certain back-ends.
191 * @param string $pagename string Which page to check.
192 * @return boolean True if the page actually exists with
193 * non-default contents in the WikiDataBase.
195 function isWikiPage ($pagename) {
196 $page = $this->getPage($pagename);
197 return ($page and $page->exists());
201 * Delete page from the WikiDB.
203 * Deletes the page from the WikiDB with the possibility to revert and diff.
204 * //Also resets all page meta-data to the default values.
206 * Note: purgePage() effectively destroys all revisions of the page from the WikiDB.
209 * @param string $pagename Name of page to delete.
212 function deletePage($pagename) {
213 // don't create empty revisions of already purged pages.
214 if ($this->_backend->get_latest_version($pagename))
215 $result = $this->_cache->delete_page($pagename);
219 /* Generate notification emails */
220 if (ENABLE_MAILNOTIFY) {
221 include_once("lib/MailNotify.php");
222 $MailNotify = new MailNotify($pagename);
223 $MailNotify->onDeletePage ($this, $pagename);
226 //How to create a RecentChanges entry with explaining summary? Dynamically
228 $page = $this->getPage($pagename);
229 $current = $page->getCurrentRevision();
230 $meta = $current->_data;
231 $version = $current->getVersion();
232 $meta['summary'] = _("removed");
233 $page->save($current->getPackedContent(), $version + 1, $meta);
239 * Completely remove the page from the WikiDB, without undo possibility.
241 * @param string $pagename Name of page to delete.
244 function purgePage($pagename) {
245 $result = $this->_cache->purge_page($pagename);
246 $this->deletePage($pagename); // just for the notification
251 * Retrieve all pages.
253 * Gets the set of all pages with non-default contents.
257 * @param boolean $include_empty Optional. Normally pages whose most
258 * recent revision has empty content are considered to be
259 * non-existant. Unless $include_defaulted is set to true, those
260 * pages will not be returned.
261 * @param string or false $sortby Optional. "+-column,+-column2".
262 * If false the result is faster in natural order.
263 * @param string or false $limit Optional. Encoded as "$offset,$count".
264 * $offset defaults to 0.
265 * @param string $exclude: Optional comma-seperated list of pagenames.
267 * @return WikiDB_PageIterator A WikiDB_PageIterator which contains all pages
268 * in the WikiDB which have non-default contents.
270 function getAllPages($include_empty=false, $sortby='', $limit='', $exclude='')
272 // HACK: memory_limit=8M will fail on too large pagesets. old php on unix only!
274 $mem = ini_get("memory_limit");
275 if ($mem and !$limit and !isWindows() and !check_php_version(4,3)) {
277 $GLOBALS['request']->setArg('limit', $limit);
278 $GLOBALS['request']->setArg('paging', 'auto');
281 $result = $this->_backend->get_all_pages($include_empty, $sortby, $limit,
283 return new WikiDB_PageIterator($this, $result,
284 array('include_empty' => $include_empty,
285 'exclude' => $exclude,
292 * @param boolean $include_empty If true include also empty pages
293 * @param string $exclude: comma-seperated list of pagenames.
294 * TBD: array of pagenames
298 function numPages($include_empty=false, $exclude='') {
299 if (method_exists($this->_backend, 'numPages'))
300 // FIXME: currently are all args ignored.
301 $count = $this->_backend->numPages($include_empty, $exclude);
303 // FIXME: exclude ignored.
304 $iter = $this->getAllPages($include_empty, false, false, $exclude);
305 $count = $iter->count();
314 * Search for pages containing (or not containing) certain words
317 * Pages are returned in alphabetical order whenever it is
318 * practical to do so.
319 * TODO: Sort by ranking. Only postgresql with tsearch2 can do ranking so far.
322 * @param TextSearchQuery $search A TextSearchQuery object
323 * @param string or false $sortby Optional. "+-column,+-column2".
324 * If false the result is faster in natural order.
325 * @param string or false $limit Optional. Encoded as "$offset,$count".
326 * $offset defaults to 0.
327 * @param string $exclude: Optional comma-seperated list of pagenames.
328 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
329 * @see TextSearchQuery
331 function titleSearch($search, $sortby='pagename', $limit='', $exclude='') {
332 $result = $this->_backend->text_search($search, false, $sortby, $limit, $exclude);
333 $options = array('exclude' => $exclude,
335 //if (isset($result->_count)) $options['count'] = $result->_count;
336 return new WikiDB_PageIterator($this, $result, $options);
342 * Search for pages containing (or not containing) certain words
343 * in their entire text (this includes the page content and the
346 * Pages are returned in alphabetical order whenever it is
347 * practical to do so.
348 * TODO: Sort by ranking. Only postgresql with tsearch2 can do ranking so far.
352 * @param TextSearchQuery $search A TextSearchQuery object.
353 * @param string or false $sortby Optional. "+-column,+-column2".
354 * If false the result is faster in natural order.
355 * @param string or false $limit Optional. Encoded as "$offset,$count".
356 * $offset defaults to 0.
357 * @param string $exclude: Optional comma-seperated list of pagenames.
358 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
359 * @see TextSearchQuery
361 function fullSearch($search, $sortby='pagename', $limit='', $exclude='') {
362 $result = $this->_backend->text_search($search, true, $sortby, $limit, $exclude);
363 return new WikiDB_PageIterator($this, $result,
364 array('exclude' => $exclude,
366 'stoplisted' => $result->stoplisted
371 * Find the pages with the greatest hit counts.
373 * Pages are returned in reverse order by hit count.
377 * @param integer $limit The maximum number of pages to return.
378 * Set $limit to zero to return all pages. If $limit < 0, pages will
379 * be sorted in decreasing order of popularity.
380 * @param string or false $sortby Optional. "+-column,+-column2".
381 * If false the result is faster in natural order.
383 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching
386 function mostPopular($limit = 20, $sortby = '-hits') {
387 $result = $this->_backend->most_popular($limit, $sortby);
388 return new WikiDB_PageIterator($this, $result);
392 * Find recent page revisions.
394 * Revisions are returned in reverse order by creation time.
398 * @param hash $params This hash is used to specify various optional
402 * <dd> (integer) At most this many revisions will be returned.
404 * <dd> (integer) Only revisions since this time (unix-timestamp)
406 * <dt> include_minor_revisions
407 * <dd> (boolean) Also include minor revisions. (Default is not to.)
408 * <dt> exclude_major_revisions
409 * <dd> (boolean) Don't include non-minor revisions.
410 * (Exclude_major_revisions implies include_minor_revisions.)
411 * <dt> include_all_revisions
412 * <dd> (boolean) Return all matching revisions for each page.
413 * Normally only the most recent matching revision is returned
417 * @return WikiDB_PageRevisionIterator A WikiDB_PageRevisionIterator
418 * containing the matching revisions.
420 function mostRecent($params = false) {
421 $result = $this->_backend->most_recent($params);
422 return new WikiDB_PageRevisionIterator($this, $result);
428 * @param string or false $sortby Optional. "+-column,+-column2".
429 * If false the result is faster in natural order.
430 * @param string or false $limit Optional. Encoded as "$offset,$count".
431 * $offset defaults to 0.
432 * @return Iterator A generic iterator containing rows of
433 * (duplicate) pagename, wantedfrom.
435 function wantedPages($exclude_from='', $exclude='', $sortby='', $limit='') {
436 return $this->_backend->wanted_pages($exclude_from, $exclude, $sortby, $limit);
437 //return new WikiDB_PageIterator($this, $result);
441 * Generic interface to the link table. Esp. useful to search for rdf triples as in
442 * SemanticSearch and ListRelations.
446 * @param $pages object A TextSearchQuery object.
447 * @param $search object A TextSearchQuery object.
448 * @param string $linktype One of "linkto", "linkfrom", "relation", "attribute".
449 * linktype parameter:
452 * <dd> search for simple out-links
454 * <dd> in-links, i.e BackLinks
456 * <dd> the first part in a <>::<> link
458 * <dd> the first part in a <>:=<> link
460 * @param $relation object An optional TextSearchQuery to match the
461 * relation name. Ignored on simple in-out links.
463 * @return Iterator A generic iterator containing links to pages or values.
464 * hash of "pagename", "linkname", "linkvalue.
466 function linkSearch($pages, $search, $linktype, $relation=false) {
467 return $this->_backend->link_search($pages, $search, $linktype, $relation);
471 * Return a simple list of all defined relations (and attributes), mainly
472 * for the SemanticSearch autocompletion.
476 * @return array of strings
478 function listRelations($also_attributes=false, $only_attributes=false, $sorted=true) {
479 if (method_exists($this->_backend, "list_relations"))
480 return $this->_backend->list_relations($also_attributes, $only_attributes, $sorted);
481 // dumb, slow fallback. no iter, so simply define it here.
482 $relations = array();
483 $iter = $this->getAllPages();
484 while ($page = $iter->next()) {
485 $reliter = $page->getRelations();
487 while ($rel = $reliter->next()) {
488 // if there's no pagename it's an attribute
489 $names[] = $rel->getName();
491 $relations = array_merge($relations, $names);
503 * Call the appropriate backend method.
506 * @param string $from Page to rename
507 * @param string $to New name
508 * @param boolean $updateWikiLinks If the text in all pages should be replaced.
509 * @return boolean true or false
511 function renamePage($from, $to, $updateWikiLinks = false) {
512 assert(is_string($from) && $from != '');
513 assert(is_string($to) && $to != '');
515 if (method_exists($this->_backend, 'rename_page')) {
516 $oldpage = $this->getPage($from);
517 $newpage = $this->getPage($to);
518 //update all WikiLinks in existing pages
519 //non-atomic! i.e. if rename fails the links are not undone
520 if ($updateWikiLinks) {
521 $lookbehind = "/(?<=[\W:])\Q";
522 $lookahead = "\E(?=[\W:])/";
523 if (!check_php_version(4,3,3)) {
524 $lookbehind = "/(?<=[\W:])";
525 $lookahead = "(?=[\W:])/";
526 $from = preg_quote($from, "/");
527 $to = preg_quote($to, "/");
529 require_once('lib/plugin/WikiAdminSearchReplace.php');
530 $links = $oldpage->getBackLinks();
531 while ($linked_page = $links->next()) {
532 WikiPlugin_WikiAdminSearchReplace::replaceHelper
534 $linked_page->getName(),
535 $lookbehind.$from.$lookahead, $to,
538 // FIXME: Disabled to avoid recursive modification when renaming
539 // a page like 'PageFoo to 'PageFooTwo'
541 $links = $newpage->getBackLinks();
542 while ($linked_page = $links->next()) {
543 WikiPlugin_WikiAdminSearchReplace::replaceHelper
545 $linked_page->getName(),
546 $lookbehind.$from.$lookahead, $to,
551 if ($oldpage->exists() and ! $newpage->exists()) {
552 if ($result = $this->_backend->rename_page($from, $to)) {
553 // create a RecentChanges entry with explaining summary
554 $page = $this->getPage($to);
555 $current = $page->getCurrentRevision();
556 $meta = $current->_data;
557 $version = $current->getVersion();
558 $meta['summary'] = sprintf(_("renamed from %s"), $from);
559 unset($meta['mtime']); // force new date
560 $page->save($current->getPackedContent(), $version + 1, $meta);
562 } elseif (!$oldpage->getCurrentRevision(false) and !$newpage->exists()) {
563 // if a version 0 exists try it also.
564 $result = $this->_backend->rename_page($from, $to);
567 trigger_error(_("WikiDB::renamePage() not yet implemented for this backend"),
570 /* Generate notification emails? */
571 if ($result and ENABLE_MAILNOTIFY and !isa($GLOBALS['request'], 'MockRequest')) {
572 $notify = $this->get('notify');
573 if (!empty($notify) and is_array($notify)) {
574 include_once("lib/MailNotify.php");
575 $MailNotify = new MailNotify($from);
576 $MailNotify->onRenamePage ($this, $from, $to);
582 /** Get timestamp when database was last modified.
584 * @return string A string consisting of two integers,
585 * separated by a space. The first is the time in
586 * unix timestamp format, the second is a modification
587 * count for the database.
589 * The idea is that you can cast the return value to an
590 * int to get a timestamp, or you can use the string value
591 * as a good hash for the entire database.
593 function getTimestamp() {
594 $ts = $this->get('_timestamp');
595 return sprintf("%d %d", $ts[0], $ts[1]);
599 * Update the database timestamp.
603 $ts = $this->get('_timestamp');
604 $this->set('_timestamp', array(time(), $ts[1] + 1));
608 * Roughly similar to the float in phpwiki_version(). Set by action=upgrade.
610 function get_db_version() {
611 return (float) $this->get('_db_version');
613 function set_db_version($ver) {
614 return $this->set('_db_version', (float)$ver);
618 * Access WikiDB global meta-data.
620 * NOTE: this is currently implemented in a hackish and
621 * not very efficient manner.
625 * @param string $key Which meta data to get.
626 * Some reserved meta-data keys are:
628 * <dt>'_timestamp' <dd> Data used by getTimestamp().
631 * @return scalar The requested value, or false if the requested data
635 if (!$key || $key[0] == '%')
638 * Hack Alert: We can use any page (existing or not) to store
639 * this data (as long as we always use the same one.)
641 $gd = $this->getPage('global_data');
642 $data = $gd->get('__global');
644 if ($data && isset($data[$key]))
651 * Set global meta-data.
653 * NOTE: this is currently implemented in a hackish and
654 * not very efficient manner.
659 * @param string $key Meta-data key to set.
660 * @param string $newval New value.
662 function set($key, $newval) {
663 if (!$key || $key[0] == '%')
666 $gd = $this->getPage('global_data');
667 $data = $gd->get('__global');
674 $data[$key] = $newval;
676 $gd->set('__global', $data);
679 /* TODO: these are really backend methods */
681 // SQL result: for simple select or create/update queries
682 // returns the database specific resource type
683 function genericSqlQuery($sql, $args=false) {
684 if (function_exists('debug_backtrace')) { // >= 4.3.0
685 echo "<pre>", printSimpleTrace(debug_backtrace()), "</pre>\n";
687 trigger_error("no SQL database", E_USER_ERROR);
691 // SQL iter: for simple select or create/update queries
692 // returns the generic iterator object (count,next)
693 function genericSqlIter($sql, $field_list = NULL) {
694 if (function_exists('debug_backtrace')) { // >= 4.3.0
695 echo "<pre>", printSimpleTrace(debug_backtrace()), "</pre>\n";
697 trigger_error("no SQL database", E_USER_ERROR);
701 // see backend upstream methods
702 // ADODB adds surrounding quotes, SQL not yet!
703 function quote ($s) {
709 if (!$request->_dbi) return false;
710 else return false; /* so far only needed for sql so false it.
711 later we have to check dba also */
714 function getParam($param) {
716 if (isset($DBParams[$param])) return $DBParams[$param];
717 elseif ($param == 'prefix') return '';
721 function getAuthParam($param) {
722 global $DBAuthParams;
723 if (isset($DBAuthParams[$param])) return $DBAuthParams[$param];
724 elseif ($param == 'USER_AUTH_ORDER') return $GLOBALS['USER_AUTH_ORDER'];
725 elseif ($param == 'USER_AUTH_POLICY') return $GLOBALS['USER_AUTH_POLICY'];
732 * A base class which representing a wiki-page within a
735 * A WikiDB_Page contains a number (at least one) of
736 * WikiDB_PageRevisions.
740 function WikiDB_Page(&$wikidb, $pagename) {
741 $this->_wikidb = &$wikidb;
742 $this->_pagename = $pagename;
744 if (!(is_string($pagename) and $pagename != '')) {
745 if (function_exists("xdebug_get_function_stack")) {
746 echo "xdebug_get_function_stack(): "; var_dump(xdebug_get_function_stack());
747 } elseif (function_exists("debug_backtrace")) { // >= 4.3.0
748 printSimpleTrace(debug_backtrace());
750 trigger_error("empty pagename", E_USER_WARNING);
754 assert(is_string($pagename) and $pagename != '');
759 * Get the name of the wiki page.
763 * @return string The page name.
766 return $this->_pagename;
769 // To reduce the memory footprint for larger sets of pagelists,
770 // we don't cache the content (only true or false) and
771 // we purge the pagedata (_cached_html) also
773 if (isset($this->_wikidb->_cache->_id_cache[$this->_pagename])) return true;
774 $current = $this->getCurrentRevision(false);
775 if (!$current) return false;
776 return ! $current->hasDefaultContents();
780 * Delete an old revision of a WikiDB_Page.
782 * Deletes the specified revision of the page.
783 * It is a fatal error to attempt to delete the current revision.
787 * @param integer $version Which revision to delete. (You can also
788 * use a WikiDB_PageRevision object here.)
790 function deleteRevision($version) {
791 $backend = &$this->_wikidb->_backend;
792 $cache = &$this->_wikidb->_cache;
793 $pagename = &$this->_pagename;
795 $version = $this->_coerce_to_version($version);
799 $backend->lock(array('page','version'));
800 $latestversion = $cache->get_latest_version($pagename);
801 if ($latestversion && ($version == $latestversion)) {
802 $backend->unlock(array('page','version'));
803 trigger_error(sprintf("Attempt to delete most recent revision of '%s'",
804 $pagename), E_USER_ERROR);
808 $cache->delete_versiondata($pagename, $version);
809 $backend->unlock(array('page','version'));
813 * Delete a revision, or possibly merge it with a previous
817 * Suppose an author make a (major) edit to a page. Shortly
818 * after that the same author makes a minor edit (e.g. to fix
819 * spelling mistakes he just made.)
821 * Now some time later, where cleaning out old saved revisions,
822 * and would like to delete his minor revision (since there's
823 * really no point in keeping minor revisions around for a long
826 * Note that the text after the minor revision probably represents
827 * what the author intended to write better than the text after
828 * the preceding major edit.
830 * So what we really want to do is merge the minor edit with the
833 * We will only do this when:
835 * <li>The revision being deleted is a minor one, and
836 * <li>It has the same author as the immediately preceding revision.
839 function mergeRevision($version) {
840 $backend = &$this->_wikidb->_backend;
841 $cache = &$this->_wikidb->_cache;
842 $pagename = &$this->_pagename;
844 $version = $this->_coerce_to_version($version);
848 $backend->lock(array('version'));
849 $latestversion = $cache->get_latest_version($pagename);
850 if ($latestversion && $version == $latestversion) {
851 $backend->unlock(array('version'));
852 trigger_error(sprintf("Attempt to merge most recent revision of '%s'",
853 $pagename), E_USER_ERROR);
857 $versiondata = $cache->get_versiondata($pagename, $version, true);
859 // Not there? ... we're done!
860 $backend->unlock(array('version'));
864 if ($versiondata['is_minor_edit']) {
865 $previous = $backend->get_previous_version($pagename, $version);
867 $prevdata = $cache->get_versiondata($pagename, $previous);
868 if ($prevdata['author_id'] == $versiondata['author_id']) {
869 // This is a minor revision, previous version is
870 // by the same author. We will merge the
872 $cache->update_versiondata($pagename, $previous,
873 array('%content' => $versiondata['%content'],
874 '_supplanted' => $versiondata['_supplanted']));
879 $cache->delete_versiondata($pagename, $version);
880 $backend->unlock(array('version'));
885 * Create a new revision of a {@link WikiDB_Page}.
889 * @param int $version Version number for new revision.
890 * To ensure proper serialization of edits, $version must be
891 * exactly one higher than the current latest version.
892 * (You can defeat this check by setting $version to
893 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
895 * @param string $content Contents of new revision.
897 * @param hash $metadata Metadata for new revision.
898 * All values in the hash should be scalars (strings or integers).
900 * @param hash $links List of linkto=>pagename, relation=>pagename which this page links to.
902 * @return WikiDB_PageRevision Returns the new WikiDB_PageRevision object. If
903 * $version was incorrect, returns false
905 function createRevision($version, &$content, $metadata, $links) {
906 $backend = &$this->_wikidb->_backend;
907 $cache = &$this->_wikidb->_cache;
908 $pagename = &$this->_pagename;
909 $cache->invalidate_cache($pagename);
911 $backend->lock(array('version','page','recent','link','nonempty'));
913 $latestversion = $backend->get_latest_version($pagename);
914 $newversion = ($latestversion ? $latestversion : 0) + 1;
915 assert($newversion >= 1);
917 if ($version != WIKIDB_FORCE_CREATE and $version != $newversion) {
918 $backend->unlock(array('version','page','recent','link','nonempty'));
924 foreach ($data as $key => $val) {
925 if (empty($val) || $key[0] == '_' || $key[0] == '%')
929 assert(!empty($data['author']));
930 if (empty($data['author_id']))
931 @$data['author_id'] = $data['author'];
933 if (empty($data['mtime']))
934 $data['mtime'] = time();
936 if ($latestversion and $version != WIKIDB_FORCE_CREATE) {
937 // Ensure mtimes are monotonic.
938 $pdata = $cache->get_versiondata($pagename, $latestversion);
939 if ($data['mtime'] < $pdata['mtime']) {
940 trigger_error(sprintf(_("%s: Date of new revision is %s"),
941 $pagename,"'non-monotonic'"),
943 $data['orig_mtime'] = $data['mtime'];
944 $data['mtime'] = $pdata['mtime'];
947 // FIXME: use (possibly user specified) 'mtime' time or
949 $cache->update_versiondata($pagename, $latestversion,
950 array('_supplanted' => $data['mtime']));
953 $data['%content'] = &$content;
955 $cache->set_versiondata($pagename, $newversion, $data);
957 //$cache->update_pagedata($pagename, array(':latestversion' => $newversion,
958 //':deleted' => empty($content)));
960 $backend->set_links($pagename, $links);
962 $backend->unlock(array('version','page','recent','link','nonempty'));
964 return new WikiDB_PageRevision($this->_wikidb, $pagename, $newversion,
968 /** A higher-level interface to createRevision.
970 * This takes care of computing the links, and storing
971 * a cached version of the transformed wiki-text.
973 * @param string $wikitext The page content.
975 * @param int $version Version number for new revision.
976 * To ensure proper serialization of edits, $version must be
977 * exactly one higher than the current latest version.
978 * (You can defeat this check by setting $version to
979 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
981 * @param hash $meta Meta-data for new revision.
983 function save($wikitext, $version, $meta, $formatted = null) {
984 if (is_null($formatted))
985 $formatted = new TransformedText($this, $wikitext, $meta);
986 $type = $formatted->getType();
987 $meta['pagetype'] = $type->getName();
988 $links = $formatted->getWikiPageLinks(); // linkto => relation
989 $attributes = array();
990 foreach ($links as $link) {
991 if ($link['linkto'] === "" and $link['relation']) {
992 $attributes[$link['relation']] = $this->getAttribute($link['relation']);
995 $meta['attribute'] = $attributes;
997 $backend = &$this->_wikidb->_backend;
998 $newrevision = $this->createRevision($version, $wikitext, $meta, $links);
999 if ($newrevision and !WIKIDB_NOCACHE_MARKUP)
1000 $this->set('_cached_html', $formatted->pack());
1002 // FIXME: probably should have some global state information
1003 // in the backend to control when to optimize.
1005 // We're doing this here rather than in createRevision because
1006 // postgresql can't optimize while locked.
1007 if (((int)DEBUG & _DEBUG_SQL)
1008 or (DATABASE_OPTIMISE_FREQUENCY > 0 and
1009 (time() % DATABASE_OPTIMISE_FREQUENCY == 0))) {
1010 if ($backend->optimize()) {
1012 trigger_error(_("Optimizing database"), E_USER_NOTICE);
1016 /* Generate notification emails? */
1017 if (ENABLE_MAILNOTIFY and isa($newrevision, 'WikiDB_PageRevision')) {
1018 // Save didn't fail because of concurrent updates.
1019 $notify = $this->_wikidb->get('notify');
1021 and is_array($notify)
1022 and !isa($GLOBALS['request'],'MockRequest'))
1024 include_once("lib/MailNotify.php");
1025 $MailNotify = new MailNotify($newrevision->getName());
1026 $MailNotify->onChangePage ($this->_wikidb, $wikitext, $version, $meta);
1028 $newrevision->_transformedContent = $formatted;
1030 // more pagechange callbacks: (in a hackish manner for now)
1031 if (ENABLE_RECENTCHANGESBOX and empty($meta['is_minor_edit'])) {
1032 require_once("lib/WikiPlugin.php");
1033 $w = new WikiPluginLoader;
1034 $p = $w->getPlugin("RecentChangesCached", false);
1035 $p->box_update(false, $GLOBALS['request'], $this->_pagename);
1037 return $newrevision;
1041 * Get the most recent revision of a page.
1045 * @return WikiDB_PageRevision The current WikiDB_PageRevision object.
1047 function getCurrentRevision ($need_content=true) {
1048 $backend = &$this->_wikidb->_backend;
1049 $cache = &$this->_wikidb->_cache;
1050 $pagename = &$this->_pagename;
1052 // Prevent deadlock in case of memory exhausted errors
1053 // Pure selection doesn't really need locking here.
1054 // sf.net bug#927395
1055 // I know it would be better to lock, but with lots of pages this deadlock is more
1056 // severe than occasionally get not the latest revision.
1057 // In spirit to wikiwiki: read fast, edit slower.
1059 $version = $cache->get_latest_version($pagename);
1060 // getRevision gets the content also!
1061 $revision = $this->getRevision($version, $need_content);
1062 //$backend->unlock();
1068 * Get a specific revision of a WikiDB_Page.
1072 * @param integer $version Which revision to get.
1074 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or
1075 * false if the requested revision does not exist in the {@link WikiDB}.
1076 * Note that version zero of any page always exists.
1078 function getRevision ($version, $need_content=true) {
1079 $cache = &$this->_wikidb->_cache;
1080 $pagename = &$this->_pagename;
1082 if (! $version or $version == -1) // 0 or false
1083 return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
1085 assert($version > 0);
1086 $vdata = $cache->get_versiondata($pagename, $version, $need_content);
1088 return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
1090 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1095 * Get previous page revision.
1097 * This method find the most recent revision before a specified
1102 * @param integer $version Find most recent revision before this version.
1103 * You can also use a WikiDB_PageRevision object to specify the $version.
1105 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or false if the
1106 * requested revision does not exist in the {@link WikiDB}. Note that
1107 * unless $version is greater than zero, a revision (perhaps version zero,
1108 * the default revision) will always be found.
1110 function getRevisionBefore ($version=false, $need_content=true) {
1111 $backend = &$this->_wikidb->_backend;
1112 $pagename = &$this->_pagename;
1113 if ($version === false)
1114 $version = $this->_wikidb->_cache->get_latest_version($pagename);
1116 $version = $this->_coerce_to_version($version);
1121 $previous = $backend->get_previous_version($pagename, $version);
1122 $revision = $this->getRevision($previous, $need_content);
1123 //$backend->unlock();
1129 * Get all revisions of the WikiDB_Page.
1131 * This does not include the version zero (default) revision in the
1132 * returned revision set.
1134 * @return WikiDB_PageRevisionIterator A
1135 * WikiDB_PageRevisionIterator containing all revisions of this
1136 * WikiDB_Page in reverse order by version number.
1138 function getAllRevisions() {
1139 $backend = &$this->_wikidb->_backend;
1140 $revs = $backend->get_all_revisions($this->_pagename);
1141 return new WikiDB_PageRevisionIterator($this->_wikidb, $revs);
1145 * Find pages which link to or are linked from a page.
1146 * relations: $backend->get_links is responsible to add the relation to the pagehash
1147 * as 'linkrelation' key as pagename. See WikiDB_PageIterator::next
1148 * if (isset($next['linkrelation']))
1152 * @param boolean $reversed Which links to find: true for backlinks (default).
1154 * @return WikiDB_PageIterator A WikiDB_PageIterator containing
1155 * all matching pages.
1157 function getLinks ($reversed=true, $include_empty=false, $sortby='',
1158 $limit='', $exclude='', $want_relations=false)
1160 $backend = &$this->_wikidb->_backend;
1161 $result = $backend->get_links($this->_pagename, $reversed,
1162 $include_empty, $sortby, $limit, $exclude,
1164 return new WikiDB_PageIterator($this->_wikidb, $result,
1165 array('include_empty' => $include_empty,
1166 'sortby' => $sortby,
1168 'exclude' => $exclude,
1169 'want_relations'=> $want_relations));
1173 * All Links from other pages to this page.
1175 function getBackLinks($include_empty=false, $sortby='', $limit='', $exclude='',
1176 $want_relations=false)
1178 return $this->getLinks(true, $include_empty, $sortby, $limit, $exclude);
1181 * Forward Links: All Links from this page to other pages.
1183 function getPageLinks($include_empty=false, $sortby='', $limit='', $exclude='',
1184 $want_relations=false)
1186 return $this->getLinks(false, $include_empty, $sortby, $limit, $exclude);
1189 * Relations: All links from this page to other pages with relation <> 0.
1190 * is_a:=page or population:=number
1192 function getRelations($sortby='', $limit='', $exclude='') {
1193 $backend = &$this->_wikidb->_backend;
1194 $result = $backend->get_links($this->_pagename, false, true,
1195 $sortby, $limit, $exclude,
1197 // we do not care for the linked page versiondata, just the pagename and linkrelation
1198 return new WikiDB_PageIterator($this->_wikidb, $result,
1199 array('include_empty' => true,
1200 'sortby' => $sortby,
1202 'exclude' => $exclude,
1203 'want_relations'=> true));
1207 * possibly faster link existance check. not yet accelerated.
1209 function existLink($link, $reversed=false) {
1210 $backend = &$this->_wikidb->_backend;
1211 if (method_exists($backend,'exists_link'))
1212 return $backend->exists_link($this->_pagename, $link, $reversed);
1213 //$cache = &$this->_wikidb->_cache;
1214 // TODO: check cache if it is possible
1215 $iter = $this->getLinks($reversed, false);
1216 while ($page = $iter->next()) {
1217 if ($page->getName() == $link)
1224 /* Semantic relations are links with the relation pointing to another page,
1225 the so-called "RDF Triple".
1226 [San Diego] is%20a::city
1227 => "At the page San Diego there is a relation link of 'is a' to the page 'city'."
1230 /* Semantic attributes for a page.
1231 [San Diego] population:=1,305,736
1232 Attributes are links with the relation pointing to another page.
1236 * Access WikiDB_Page non version-specific meta-data.
1240 * @param string $key Which meta data to get.
1241 * Some reserved meta-data keys are:
1243 * <dt>'date' <dd> Created as unixtime
1244 * <dt>'locked'<dd> Is page locked? 'yes' or 'no'
1245 * <dt>'hits' <dd> Page hit counter.
1246 * <dt>'_cached_html' <dd> Transformed CachedMarkup object, serialized + optionally gzipped.
1247 * In SQL stored now in an extra column.
1249 * <dt>'pref' <dd> Users preferences, stored only in homepages.
1250 * <dt>'owner' <dd> Default: first author_id. We might add a group with a dot here:
1251 * E.g. "owner.users"
1252 * <dt>'perm' <dd> Permission flag to authorize read/write/execution of
1253 * page-headers and content.
1254 + <dt>'moderation'<dd> ModeratedPage data. Handled by plugin/ModeratedPage
1255 * <dt>'rating' <dd> Page rating. Handled by plugin/RateIt
1258 * @return scalar The requested value, or false if the requested data
1261 function get($key) {
1262 $cache = &$this->_wikidb->_cache;
1263 $backend = &$this->_wikidb->_backend;
1264 if (!$key || $key[0] == '%')
1266 // several new SQL backends optimize this.
1267 if (!WIKIDB_NOCACHE_MARKUP
1268 and $key == '_cached_html'
1269 and method_exists($backend, 'get_cached_html'))
1271 return $backend->get_cached_html($this->_pagename);
1273 $data = $cache->get_pagedata($this->_pagename);
1274 return isset($data[$key]) ? $data[$key] : false;
1278 * Get all the page meta-data as a hash.
1280 * @return hash The page meta-data.
1282 function getMetaData() {
1283 $cache = &$this->_wikidb->_cache;
1284 $data = $cache->get_pagedata($this->_pagename);
1286 foreach ($data as $key => $val) {
1287 if (/*!empty($val) &&*/ $key[0] != '%')
1294 * Set page meta-data.
1299 * @param string $key Meta-data key to set.
1300 * @param string $newval New value.
1302 function set($key, $newval) {
1303 $cache = &$this->_wikidb->_cache;
1304 $backend = &$this->_wikidb->_backend;
1305 $pagename = &$this->_pagename;
1307 assert($key && $key[0] != '%');
1309 // several new SQL backends optimize this.
1310 if (!WIKIDB_NOCACHE_MARKUP
1311 and $key == '_cached_html'
1312 and method_exists($backend, 'set_cached_html'))
1314 return $backend->set_cached_html($pagename, $newval);
1317 $data = $cache->get_pagedata($pagename);
1319 if (!empty($newval)) {
1320 if (!empty($data[$key]) && $data[$key] == $newval)
1321 return; // values identical, skip update.
1324 if (empty($data[$key]))
1325 return; // values identical, skip update.
1328 $cache->update_pagedata($pagename, array($key => $newval));
1332 * Increase page hit count.
1334 * FIXME: IS this needed? Probably not.
1336 * This is a convenience function.
1337 * <pre> $page->increaseHitCount(); </pre>
1338 * is functionally identical to
1339 * <pre> $page->set('hits',$page->get('hits')+1); </pre>
1340 * but less expensive (ignores the pagadata string)
1342 * Note that this method may be implemented in more efficient ways
1343 * in certain backends.
1347 function increaseHitCount() {
1348 if (method_exists($this->_wikidb->_backend, 'increaseHitCount'))
1349 $this->_wikidb->_backend->increaseHitCount($this->_pagename);
1351 @$newhits = $this->get('hits') + 1;
1352 $this->set('hits', $newhits);
1357 * Return a string representation of the WikiDB_Page
1359 * This is really only for debugging.
1363 * @return string Printable representation of the WikiDB_Page.
1365 function asString () {
1367 printf("[%s:%s\n", get_class($this), $this->getName());
1368 print_r($this->getMetaData());
1370 $strval = ob_get_contents();
1378 * @param integer_or_object $version_or_pagerevision
1379 * Takes either the version number (and int) or a WikiDB_PageRevision
1381 * @return integer The version number.
1383 function _coerce_to_version($version_or_pagerevision) {
1384 if (method_exists($version_or_pagerevision, "getContent"))
1385 $version = $version_or_pagerevision->getVersion();
1387 $version = (int) $version_or_pagerevision;
1389 assert($version >= 0);
1393 function isUserPage ($include_empty = true) {
1394 if (!$include_empty and !$this->exists()) return false;
1395 return $this->get('pref') ? true : false;
1398 // May be empty. Either the stored owner (/Chown), or the first authorized author
1399 function getOwner() {
1400 if ($owner = $this->get('owner'))
1401 return ($owner == _("The PhpWiki programming team")) ? ADMIN_USER : $owner;
1402 // check all revisions forwards for the first author_id
1403 $backend = &$this->_wikidb->_backend;
1404 $pagename = &$this->_pagename;
1405 $latestversion = $backend->get_latest_version($pagename);
1406 for ($v=1; $v <= $latestversion; $v++) {
1407 $rev = $this->getRevision($v,false);
1408 if ($rev and $owner = $rev->get('author_id')) {
1409 return ($owner == _("The PhpWiki programming team")) ? ADMIN_USER : $owner;
1415 // The authenticated author of the first revision or empty if not authenticated then.
1416 function getCreator() {
1417 if ($current = $this->getRevision(1,false)) return $current->get('author_id');
1421 // The authenticated author of the current revision.
1422 function getAuthor() {
1423 if ($current = $this->getCurrentRevision(false)) return $current->get('author_id');
1427 /* Semantic Web value, not stored in the links.
1428 * todo: unify with some unit knowledge
1430 function setAttribute($relation, $value) {
1431 $attr = $this->get('attributes');
1433 $attr = array($relation => $value);
1435 $attr[$relation] = $value;
1436 $this->set('attributes', $attr);
1439 function getAttribute($relation) {
1440 $meta = $this->get('attributes');
1444 return $meta[$relation];
1450 * This class represents a specific revision of a WikiDB_Page within
1453 * A WikiDB_PageRevision has read-only semantics. You may only create
1454 * new revisions (and delete old ones) --- you cannot modify existing
1457 class WikiDB_PageRevision
1459 //var $_transformedContent = false; // set by WikiDB_Page::save()
1461 function WikiDB_PageRevision(&$wikidb, $pagename, $version, $versiondata = false) {
1462 $this->_wikidb = &$wikidb;
1463 $this->_pagename = $pagename;
1464 $this->_version = $version;
1465 $this->_data = $versiondata ? $versiondata : array();
1466 $this->_transformedContent = false; // set by WikiDB_Page::save()
1470 * Get the WikiDB_Page which this revision belongs to.
1474 * @return WikiDB_Page The WikiDB_Page which this revision belongs to.
1476 function getPage() {
1477 return new WikiDB_Page($this->_wikidb, $this->_pagename);
1481 * Get the version number of this revision.
1485 * @return integer The version number of this revision.
1487 function getVersion() {
1488 return $this->_version;
1492 * Determine whether this revision has defaulted content.
1494 * The default revision (version 0) of each page, as well as any
1495 * pages which are created with empty content have their content
1496 * defaulted to something like:
1498 * Describe [ThisPage] here.
1503 * @return boolean Returns true if the page has default content.
1505 function hasDefaultContents() {
1506 $data = &$this->_data;
1507 return empty($data['%content']); // FIXME: what if it's the number 0? <>'' or === false
1511 * Get the content as an array of lines.
1515 * @return array An array of lines.
1516 * The lines should contain no trailing white space.
1518 function getContent() {
1519 return explode("\n", $this->getPackedContent());
1523 * Get the pagename of the revision.
1527 * @return string pagename.
1529 function getPageName() {
1530 return $this->_pagename;
1532 function getName() {
1533 return $this->_pagename;
1537 * Determine whether revision is the latest.
1541 * @return boolean True iff the revision is the latest (most recent) one.
1543 function isCurrent() {
1544 if (!isset($this->_iscurrent)) {
1545 $page = $this->getPage();
1546 $current = $page->getCurrentRevision(false);
1547 $this->_iscurrent = $this->getVersion() == $current->getVersion();
1549 return $this->_iscurrent;
1553 * Get the transformed content of a page.
1555 * @param string $pagetype Override the page-type of the revision.
1557 * @return object An XmlContent-like object containing the page transformed
1560 function getTransformedContent($pagetype_override=false) {
1561 $backend = &$this->_wikidb->_backend;
1563 if ($pagetype_override) {
1564 // Figure out the normal page-type for this page.
1565 $type = PageType::GetPageType($this->get('pagetype'));
1566 if ($type->getName() == $pagetype_override)
1567 $pagetype_override = false; // Not really an override...
1570 if ($pagetype_override) {
1571 // Overriden page type, don't cache (or check cache).
1572 return new TransformedText($this->getPage(),
1573 $this->getPackedContent(),
1574 $this->getMetaData(),
1575 $pagetype_override);
1578 $possibly_cache_results = true;
1580 if (!USECACHE or WIKIDB_NOCACHE_MARKUP) {
1581 if (WIKIDB_NOCACHE_MARKUP == 'purge') {
1582 // flush cache for this page.
1583 $page = $this->getPage();
1584 $page->set('_cached_html', ''); // ignored with !USECACHE
1586 $possibly_cache_results = false;
1588 elseif (USECACHE and !$this->_transformedContent) {
1590 if ($this->isCurrent()) {
1591 $page = $this->getPage();
1592 $this->_transformedContent = TransformedText::unpack($page->get('_cached_html'));
1595 $possibly_cache_results = false;
1597 //$backend->unlock();
1600 if (!$this->_transformedContent) {
1601 $this->_transformedContent
1602 = new TransformedText($this->getPage(),
1603 $this->getPackedContent(),
1604 $this->getMetaData());
1606 if ($possibly_cache_results and !WIKIDB_NOCACHE_MARKUP) {
1607 // If we're still the current version, cache the transfomed page.
1609 if ($this->isCurrent()) {
1610 $page->set('_cached_html', $this->_transformedContent->pack());
1612 //$backend->unlock();
1616 return $this->_transformedContent;
1620 * Get the content as a string.
1624 * @return string The page content.
1625 * Lines are separated by new-lines.
1627 function getPackedContent() {
1628 $data = &$this->_data;
1630 if (empty($data['%content'])
1631 || (!$this->_wikidb->isWikiPage($this->_pagename)
1632 && $this->isCurrent())) {
1633 include_once('lib/InlineParser.php');
1635 // A feature similar to taglines at http://www.wlug.org.nz/
1636 // Lib from http://www.aasted.org/quote/
1637 if (defined('FORTUNE_DIR')
1638 and is_dir(FORTUNE_DIR)
1639 and in_array($GLOBALS['request']->getArg('action'),
1640 array('create','edit')))
1642 include_once("lib/fortune.php");
1643 $fortune = new Fortune();
1644 $quote = $fortune->quoteFromDir(FORTUNE_DIR);
1646 $quote = "<verbatim>\n"
1647 . str_replace("\n<br>","\n", $quote)
1648 . "</verbatim>\n\n";
1652 . sprintf(_("Describe %s here."),
1653 "[" . WikiEscape($this->_pagename) . "]");
1655 // Replace empty content with default value.
1656 return sprintf(_("Describe %s here."),
1657 "[" . WikiEscape($this->_pagename) . "]");
1660 // There is (non-default) content.
1661 assert($this->_version > 0);
1663 if (!is_string($data['%content'])) {
1664 // Content was not provided to us at init time.
1665 // (This is allowed because for some backends, fetching
1666 // the content may be expensive, and often is not wanted
1669 // In any case, now we need to get it.
1670 $data['%content'] = $this->_get_content();
1671 assert(is_string($data['%content']));
1674 return $data['%content'];
1677 function _get_content() {
1678 $cache = &$this->_wikidb->_cache;
1679 $pagename = $this->_pagename;
1680 $version = $this->_version;
1682 assert($version > 0);
1684 $newdata = $cache->get_versiondata($pagename, $version, true);
1686 assert(is_string($newdata['%content']));
1687 return $newdata['%content'];
1690 // else revision has been deleted... What to do?
1691 return __sprintf("Oops! Revision %s of %s seems to have been deleted!",
1692 $version, $pagename);
1697 * Get meta-data for this revision.
1702 * @param string $key Which meta-data to access.
1704 * Some reserved revision meta-data keys are:
1706 * <dt> 'mtime' <dd> Time this revision was created (seconds since midnight Jan 1, 1970.)
1707 * The 'mtime' meta-value is normally set automatically by the database
1708 * backend, but it may be specified explicitly when creating a new revision.
1710 * <dd> To ensure consistency of RecentChanges, the mtimes of the versions
1711 * of a page must be monotonically increasing. If an attempt is
1712 * made to create a new revision with an mtime less than that of
1713 * the preceeding revision, the new revisions timestamp is force
1714 * to be equal to that of the preceeding revision. In that case,
1715 * the originally requested mtime is preserved in 'orig_mtime'.
1716 * <dt> '_supplanted' <dd> Time this revision ceased to be the most recent.
1717 * This meta-value is <em>always</em> automatically maintained by the database
1718 * backend. (It is set from the 'mtime' meta-value of the superceding
1719 * revision.) '_supplanted' has a value of 'false' for the current revision.
1721 * FIXME: this could be refactored:
1723 * <dd> Author of the page (as he should be reported in, e.g. RecentChanges.)
1725 * <dd> Authenticated author of a page. This is used to identify
1726 * the distinctness of authors when cleaning old revisions from
1728 * <dt> 'is_minor_edit' <dd> Set if change was marked as a minor revision by the author.
1729 * <dt> 'summary' <dd> Short change summary entered by page author.
1732 * Meta-data keys must be valid C identifers (they have to start with a letter
1733 * or underscore, and can contain only alphanumerics and underscores.)
1735 * @return string The requested value, or false if the requested value
1738 function get($key) {
1739 if (!$key || $key[0] == '%')
1741 $data = &$this->_data;
1742 return isset($data[$key]) ? $data[$key] : false;
1746 * Get all the revision page meta-data as a hash.
1748 * @return hash The revision meta-data.
1750 function getMetaData() {
1752 foreach ($this->_data as $key => $val) {
1753 if (!empty($val) && $key[0] != '%')
1761 * Return a string representation of the revision.
1763 * This is really only for debugging.
1767 * @return string Printable representation of the WikiDB_Page.
1769 function asString () {
1771 printf("[%s:%d\n", get_class($this), $this->get('version'));
1772 print_r($this->_data);
1773 echo $this->getPackedContent() . "\n]\n";
1774 $strval = ob_get_contents();
1782 * Class representing a sequence of WikiDB_Pages.
1783 * TODO: Enhance to php5 iterators
1785 * apply filters for options like 'sortby', 'limit', 'exclude'
1786 * for simple queries like titleSearch, where the backend is not ready yet.
1788 class WikiDB_PageIterator
1790 function WikiDB_PageIterator(&$wikidb, &$iter, $options=false) {
1791 $this->_iter = $iter; // a WikiDB_backend_iterator
1792 $this->_wikidb = &$wikidb;
1793 $this->_options = $options;
1797 return $this->_iter->count();
1801 * Get next WikiDB_Page in sequence.
1805 * @return WikiDB_Page The next WikiDB_Page in the sequence.
1808 if ( ! ($next = $this->_iter->next()) )
1811 $pagename = &$next['pagename'];
1812 if (!is_string($pagename)) { // Bug #1327912 fixed by Joachim Lous
1813 /*if (is_array($pagename) && isset($pagename['linkto'])) {
1814 $pagename = $pagename['linkto'];
1816 $pagename = strval($pagename);*/
1817 trigger_error("WikiDB_PageIterator->next pagename", E_USER_WARNING);
1820 if (isset($next['linkrelation'])
1821 or isset($next['pagedata']['linkrelation'])) return false;
1822 trigger_error('empty pagename in WikiDB_PageIterator::next()', E_USER_WARNING);
1826 // There's always hits, but we cache only if more
1827 // (well not with file, cvs and dba)
1828 if (isset($next['pagedata']) and count($next['pagedata']) > 1) {
1829 $this->_wikidb->_cache->cache_data($next);
1830 // cache existing page id's since we iterate over all links in GleanDescription
1831 // and need them later for LinkExistingWord
1832 } elseif ($this->_options and array_key_exists('include_empty', $this->_options)
1833 and !$this->_options['include_empty'] and isset($next['id'])) {
1834 $this->_wikidb->_cache->_id_cache[$next['pagename']] = $next['id'];
1836 $page = new WikiDB_Page($this->_wikidb, $pagename);
1837 if (isset($next['linkrelation']))
1838 $page->set('linkrelation', $next['linkrelation']);
1839 if (isset($next['score']))
1840 $page->score = $next['score'];
1845 * Release resources held by this iterator.
1847 * The iterator may not be used after free() is called.
1849 * There is no need to call free(), if next() has returned false.
1850 * (I.e. if you iterate through all the pages in the sequence,
1851 * you do not need to call free() --- you only need to call it
1852 * if you stop before the end of the iterator is reached.)
1857 $this->_iter->free();
1860 $this->_iter->reset();
1862 function asArray() {
1864 while ($page = $this->next())
1871 * Apply filters for options like 'sortby', 'limit', 'exclude'
1872 * for simple queries like titleSearch, where the backend is not ready yet.
1873 * Since iteration is usually destructive for SQL results,
1874 * we have to generate a copy.
1876 function applyFilters($options = false) {
1877 if (!$options) $options = $this->_options;
1878 if (isset($options['sortby'])) {
1880 /* this is destructive */
1881 while ($page = $this->next())
1882 $result[] = $page->getName();
1883 $this->_doSort($array, $options['sortby']);
1885 /* the rest is not destructive.
1886 * reconstruct a new iterator
1888 $pagenames = array(); $i = 0;
1889 if (isset($options['limit']))
1890 $limit = $options['limit'];
1893 if (isset($options['exclude']))
1894 $exclude = $options['exclude'];
1895 if (is_string($exclude) and !is_array($exclude))
1896 $exclude = PageList::explodePageList($exclude, false, false, $limit);
1897 foreach($array as $pagename) {
1898 if ($limit and $i++ > $limit)
1899 return new WikiDB_Array_PageIterator($pagenames);
1900 if (!empty($exclude) and !in_array($pagename, $exclude))
1901 $pagenames[] = $pagename;
1902 elseif (empty($exclude))
1903 $pagenames[] = $pagename;
1905 return new WikiDB_Array_PageIterator($pagenames);
1909 function _doSort(&$array, $sortby) {
1910 $sortby = PageList::sortby($sortby, 'init');
1911 if ($sortby == '+pagename')
1912 sort($array, SORT_STRING);
1913 elseif ($sortby == '-pagename')
1914 rsort($array, SORT_STRING);
1921 * A class which represents a sequence of WikiDB_PageRevisions.
1922 * TODO: Enhance to php5 iterators
1924 class WikiDB_PageRevisionIterator
1926 function WikiDB_PageRevisionIterator(&$wikidb, &$revisions, $options=false) {
1927 $this->_revisions = $revisions;
1928 $this->_wikidb = &$wikidb;
1929 $this->_options = $options;
1933 return $this->_revisions->count();
1937 * Get next WikiDB_PageRevision in sequence.
1941 * @return WikiDB_PageRevision
1942 * The next WikiDB_PageRevision in the sequence.
1945 if ( ! ($next = $this->_revisions->next()) )
1948 //$this->_wikidb->_cache->cache_data($next);
1950 $pagename = $next['pagename'];
1951 $version = $next['version'];
1952 $versiondata = $next['versiondata'];
1954 if (!(is_string($pagename) and $pagename != '')) {
1955 trigger_error("empty pagename",E_USER_WARNING);
1958 } else assert(is_string($pagename) and $pagename != '');
1960 if (!is_array($versiondata)) {
1961 trigger_error("empty versiondata",E_USER_WARNING);
1964 } else assert(is_array($versiondata));
1966 if (!($version > 0)) {
1967 trigger_error("invalid version",E_USER_WARNING);
1970 } else assert($version > 0);
1972 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1977 * Release resources held by this iterator.
1979 * The iterator may not be used after free() is called.
1981 * There is no need to call free(), if next() has returned false.
1982 * (I.e. if you iterate through all the revisions in the sequence,
1983 * you do not need to call free() --- you only need to call it
1984 * if you stop before the end of the iterator is reached.)
1989 $this->_revisions->free();
1992 function asArray() {
1994 while ($rev = $this->next())
2003 class WikiDB_Array_PageIterator
2005 function WikiDB_Array_PageIterator($pagenames) {
2007 $this->_dbi = $request->getDbh();
2008 $this->_pages = $pagenames;
2009 reset($this->_pages);
2012 $c = current($this->_pages);
2013 next($this->_pages);
2014 return $c !== false ? $this->_dbi->getPage($c) : false;
2017 return count($this->_pages);
2020 reset($this->_pages);
2023 function asArray() {
2024 reset($this->_pages);
2025 return $this->_pages;
2029 class WikiDB_Array_generic_iter
2031 function WikiDB_Array_generic_iter($result) {
2032 // $result may be either an array or a query result
2033 if (is_array($result)) {
2034 $this->_array = $result;
2035 } elseif (is_object($result)) {
2036 $this->_array = $result->asArray();
2038 $this->_array = array();
2040 if (!empty($this->_array))
2041 reset($this->_array);
2044 $c = current($this->_array);
2045 next($this->_array);
2046 return $c !== false ? $c : false;
2049 return count($this->_array);
2052 reset($this->_array);
2055 function asArray() {
2056 if (!empty($this->_array))
2057 reset($this->_array);
2058 return $this->_array;
2063 * Data cache used by WikiDB.
2065 * FIXME: Maybe rename this to caching_backend (or some such).
2071 // FIXME: beautify versiondata cache. Cache only limited data?
2073 function WikiDB_cache (&$backend) {
2074 $this->_backend = &$backend;
2076 $this->_pagedata_cache = array();
2077 $this->_versiondata_cache = array();
2078 array_push ($this->_versiondata_cache, array());
2079 $this->_glv_cache = array();
2080 $this->_id_cache = array(); // formerly ->_dbi->_iwpcache (nonempty pages => id)
2084 $this->_pagedata_cache = array();
2085 $this->_versiondata_cache = array();
2086 $this->_glv_cache = array();
2087 $this->_id_cache = array();
2090 function get_pagedata($pagename) {
2091 assert(is_string($pagename) && $pagename != '');
2093 $cache = &$this->_pagedata_cache;
2094 if (!isset($cache[$pagename]) || !is_array($cache[$pagename])) {
2095 $cache[$pagename] = $this->_backend->get_pagedata($pagename);
2096 if (empty($cache[$pagename]))
2097 $cache[$pagename] = array();
2099 return $cache[$pagename];
2101 return $this->_backend->get_pagedata($pagename);
2105 function update_pagedata($pagename, $newdata) {
2106 assert(is_string($pagename) && $pagename != '');
2108 $this->_backend->update_pagedata($pagename, $newdata);
2111 if (!empty($this->_pagedata_cache[$pagename])
2112 and is_array($this->_pagedata_cache[$pagename]))
2114 $cachedata = &$this->_pagedata_cache[$pagename];
2115 foreach($newdata as $key => $val)
2116 $cachedata[$key] = $val;
2118 $this->_pagedata_cache[$pagename] = $newdata;
2122 function invalidate_cache($pagename) {
2123 unset ($this->_pagedata_cache[$pagename]);
2124 unset ($this->_versiondata_cache[$pagename]);
2125 unset ($this->_glv_cache[$pagename]);
2126 unset ($this->_id_cache[$pagename]);
2127 //unset ($this->_backend->_page_data);
2130 function delete_page($pagename) {
2131 $result = $this->_backend->delete_page($pagename);
2132 $this->invalidate_cache($pagename);
2136 function purge_page($pagename) {
2137 $result = $this->_backend->purge_page($pagename);
2138 $this->invalidate_cache($pagename);
2142 // FIXME: ugly and wrong. may overwrite full cache with partial cache
2143 function cache_data($data) {
2145 //if (isset($data['pagedata']))
2146 // $this->_pagedata_cache[$data['pagename']] = $data['pagedata'];
2149 function get_versiondata($pagename, $version, $need_content = false) {
2150 // FIXME: Seriously ugly hackage
2152 if (USECACHE) { //temporary - for debugging
2153 assert(is_string($pagename) && $pagename != '');
2154 // There is a bug here somewhere which results in an assertion failure at line 105
2155 // of ArchiveCleaner.php It goes away if we use the next line.
2156 //$need_content = true;
2157 $nc = $need_content ? '1':'0';
2158 $cache = &$this->_versiondata_cache;
2159 if (!isset($cache[$pagename][$version][$nc])
2160 || !(is_array ($cache[$pagename]))
2161 || !(is_array ($cache[$pagename][$version])))
2163 $cache[$pagename][$version][$nc] =
2164 $this->_backend->get_versiondata($pagename, $version, $need_content);
2166 // If we have retrieved all data, we may as well set the cache for
2167 // $need_content = false
2169 $cache[$pagename][$version]['0'] =& $cache[$pagename][$version]['1'];
2172 $vdata = $cache[$pagename][$version][$nc];
2174 $vdata = $this->_backend->get_versiondata($pagename, $version, $need_content);
2177 if ($readdata && is_array($vdata) && !empty($vdata['%pagedata'])) {
2178 if (empty($this->_pagedata_cache))
2179 $this->_pagedata_cache = array();
2180 /* PHP Fatal error: Cannot create references to/from string offsets nor overloaded objects in /var/www/html/phpwiki/lib/WikiDB.php on line 2180, referer: wiki/TitleSearch?s=and&auto_redirect=1 */
2181 $this->_pagedata_cache[$pagename] = $vdata['%pagedata'];
2186 function set_versiondata($pagename, $version, $data) {
2187 //unset($this->_versiondata_cache[$pagename][$version]);
2189 $new = $this->_backend->set_versiondata($pagename, $version, $data);
2191 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2192 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2193 // Is this necessary?
2194 unset($this->_glv_cache[$pagename]);
2197 function update_versiondata($pagename, $version, $data) {
2198 $new = $this->_backend->update_versiondata($pagename, $version, $data);
2200 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2202 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2203 // Is this necessary?
2204 unset($this->_glv_cache[$pagename]);
2207 function delete_versiondata($pagename, $version) {
2208 $new = $this->_backend->delete_versiondata($pagename, $version);
2209 if (isset($this->_versiondata_cache[$pagename][$version]))
2210 unset ($this->_versiondata_cache[$pagename][$version]);
2211 // dirty latest version cache only if latest version gets deleted
2212 if (isset($this->_glv_cache[$pagename]) and $this->_glv_cache[$pagename] == $version)
2213 unset ($this->_glv_cache[$pagename]);
2216 function get_latest_version($pagename) {
2218 assert (is_string($pagename) && $pagename != '');
2219 $cache = &$this->_glv_cache;
2220 if (!isset($cache[$pagename])) {
2221 $cache[$pagename] = $this->_backend->get_latest_version($pagename);
2222 if (empty($cache[$pagename]))
2223 $cache[$pagename] = 0;
2225 return $cache[$pagename];
2227 return $this->_backend->get_latest_version($pagename);
2232 function _sql_debuglog($msg, $newline=true, $shutdown=false) {
2236 $stamp = strftime("%y%m%d-%H%M%S");
2237 $fp = fopen(TEMP_DIR."/sql-$stamp.log", "a");
2238 register_shutdown_function("_sql_debuglog_shutdown_function");
2239 } elseif ($shutdown) {
2243 if ($newline) fputs($fp, "[$i++] $msg");
2244 else fwrite($fp, $msg);
2247 function _sql_debuglog_shutdown_function() {
2248 _sql_debuglog('',false,true);
2254 // c-basic-offset: 4
2255 // c-hanging-comment-ender-p: nil
2256 // indent-tabs-mode: nil