2 rcs_id('$Id: WikiDB.php,v 1.104 2004-11-19 19:22:03 rurban Exp $');
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>
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 paramters 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 $GLOBALS['request']->_dbi = $this;
121 // If the database doesn't yet have a timestamp, initialize it now.
122 if ($this->get('_timestamp') === false)
125 //FIXME: devel checking.
126 //$this->_backend->check();
130 * Get any user-level warnings about this WikiDB.
132 * Some back-ends, e.g. by default create there data files in the
133 * global /tmp directory. We would like to warn the user when this
134 * happens (since /tmp files tend to get wiped periodically.)
135 * Warnings such as these may be communicated from specific
136 * back-ends through this method.
140 * @return string A warning message (or <tt>false</tt> if there is
143 function genericWarnings() {
148 * Close database connection.
150 * The database may no longer be used after it is closed.
152 * Closing a WikiDB invalidates all <tt>WikiDB_Page</tt>s,
153 * <tt>WikiDB_PageRevision</tt>s and <tt>WikiDB_PageIterator</tt>s
154 * which have been obtained from it.
159 $this->_backend->close();
160 $this->_cache->close();
164 * Get a WikiDB_Page from a WikiDB.
166 * A {@link WikiDB} consists of the (infinite) set of all possible pages,
167 * therefore this method never fails.
170 * @param string $pagename Which page to get.
171 * @return WikiDB_Page The requested WikiDB_Page.
173 function getPage($pagename) {
174 static $error_displayed = false;
175 $pagename = (string) $pagename;
177 if ($pagename === '') {
178 if ($error_displayed) return false;
179 $error_displayed = true;
180 if (function_exists("xdebug_get_function_stack"))
181 var_dump(xdebug_get_function_stack());
182 trigger_error("empty pagename", E_USER_WARNING);
186 assert($pagename != '');
188 return new WikiDB_Page($this, $pagename);
192 * Determine whether page exists (in non-default form).
195 * $is_page = $dbi->isWikiPage($pagename);
199 * $page = $dbi->getPage($pagename);
200 * $current = $page->getCurrentRevision();
201 * $is_page = ! $current->hasDefaultContents();
203 * however isWikiPage may be implemented in a more efficient
204 * manner in certain back-ends.
208 * @param string $pagename string Which page to check.
210 * @return boolean True if the page actually exists with
211 * non-default contents in the WikiDataBase.
213 function isWikiPage ($pagename) {
214 $page = $this->getPage($pagename);
215 return $page->exists();
219 * Delete page from the WikiDB.
221 * Deletes all revisions of the page from the WikiDB. Also resets
222 * all page meta-data to the default values.
226 * @param string $pagename Name of page to delete.
228 function deletePage($pagename) {
229 $this->_cache->delete_page($pagename);
231 /* Generate notification emails? */
232 if (! $this->isWikiPage($pagename) ) {
233 $notify = $this->get('notify');
234 if (!empty($notify) and is_array($notify)) {
235 //TODO: deferr it (quite a massive load if you remove some pages).
236 //TODO: notification class which catches all changes,
237 // and decides at the end of the request what to mail. (type, page, who, what, users, emails)
238 // could be used for PageModeration also.
239 $page = new WikiDB_Page($this, $pagename);
240 list($emails, $userids) = $page->getPageChangeEmails($notify);
241 if (!empty($emails)) {
242 $editedby = sprintf(_("Removed by: %s"), $GLOBALS['request']->_user->getId()); // Todo: host_id
243 $emails = join(',', $emails);
244 $subject = sprintf(_("Page deleted %s"), urlencode($pagename));
245 if (mail($emails,"[".WIKI_NAME."] ".$subject,
248 "Deleted $pagename"))
249 trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
250 $pagename, join(',',$userids)), E_USER_NOTICE);
252 trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
253 $pagename, join(',',$userids)), E_USER_WARNING);
258 //How to create a RecentChanges entry with explaining summary? Dynamically
260 $page = $this->getPage($pagename);
261 $current = $page->getCurrentRevision();
262 $meta = $current->_data;
263 $version = $current->getVersion();
264 $meta['summary'] = _("removed");
265 $page->save($current->getPackedContent(), $version + 1, $meta);
270 * Retrieve all pages.
272 * Gets the set of all pages with non-default contents.
276 * @param boolean $include_defaulted Normally pages whose most
277 * recent revision has empty content are considered to be
278 * non-existant. Unless $include_defaulted is set to true, those
279 * pages will not be returned.
281 * @return WikiDB_PageIterator A WikiDB_PageIterator which contains all pages
282 * in the WikiDB which have non-default contents.
284 function getAllPages($include_empty=false, $sortby=false, $limit=false) {
285 // HACK: memory_limit=8M will fail on too large pagesets. old php on unix only!
286 $mem = ini_get("memory_limit");
287 if ($mem and !$limit and !isWindows() and !check_php_version(4,3)) {
289 $GLOBALS['request']->setArg('limit',$limit);
290 $GLOBALS['request']->setArg('paging','auto');
292 $result = $this->_backend->get_all_pages($include_empty, $sortby, $limit);
293 return new WikiDB_PageIterator($this, $result, array('include_empty' => $include_empty,
298 * filter = true: include also empty pages
299 * exclude: comma-seperated list pagenames
301 function numPages($filter=false, $exclude='') {
302 if (method_exists($this->_backend, 'numPages'))
303 // FIXME: currently are all args ignored.
304 $count = $this->_backend->numPages($filter, $exclude);
306 // FIXME: exclude ignored.
307 $iter = $this->getAllPages($filter);
308 $count = $iter->count();
317 * Search for pages containing (or not containing) certain words
320 * Pages are returned in alphabetical order whenever it is
321 * practical to do so.
323 * FIXME: should titleSearch and fullSearch be combined? I think so.
326 * @param TextSearchQuery $search A TextSearchQuery object
327 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
328 * @see TextSearchQuery
330 function titleSearch($search) {
331 $result = $this->_backend->text_search($search);
332 return new WikiDB_PageIterator($this, $result);
338 * Search for pages containing (or not containing) certain words
339 * in their entire text (this includes the page content and the
342 * Pages are returned in alphabetical order whenever it is
343 * practical to do so.
347 * @param TextSearchQuery $search A TextSearchQuery object.
348 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
349 * @see TextSearchQuery
351 function fullSearch($search) {
352 $result = $this->_backend->text_search($search, 'full_text');
353 return new WikiDB_PageIterator($this, $result);
357 * Find the pages with the greatest hit counts.
359 * Pages are returned in reverse order by hit count.
363 * @param integer $limit The maximum number of pages to return.
364 * Set $limit to zero to return all pages. If $limit < 0, pages will
365 * be sorted in decreasing order of popularity.
367 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching
370 function mostPopular($limit = 20, $sortby = '-hits') {
371 $result = $this->_backend->most_popular($limit, $sortby);
372 return new WikiDB_PageIterator($this, $result);
376 * Find recent page revisions.
378 * Revisions are returned in reverse order by creation time.
382 * @param hash $params This hash is used to specify various optional
386 * <dd> (integer) At most this many revisions will be returned.
388 * <dd> (integer) Only revisions since this time (unix-timestamp) will be returned.
389 * <dt> include_minor_revisions
390 * <dd> (boolean) Also include minor revisions. (Default is not to.)
391 * <dt> exclude_major_revisions
392 * <dd> (boolean) Don't include non-minor revisions.
393 * (Exclude_major_revisions implies include_minor_revisions.)
394 * <dt> include_all_revisions
395 * <dd> (boolean) Return all matching revisions for each page.
396 * Normally only the most recent matching revision is returned
400 * @return WikiDB_PageRevisionIterator A WikiDB_PageRevisionIterator containing the
401 * matching revisions.
403 function mostRecent($params = false) {
404 $result = $this->_backend->most_recent($params);
405 return new WikiDB_PageRevisionIterator($this, $result);
409 * Call the appropriate backend method.
412 * @param string $from Page to rename
413 * @param string $to New name
414 * @param boolean $updateWikiLinks If the text in all pages should be replaced.
415 * @return boolean true or false
417 function renamePage($from, $to, $updateWikiLinks = false) {
418 assert(is_string($from) && $from != '');
419 assert(is_string($to) && $to != '');
421 if (method_exists($this->_backend, 'rename_page')) {
422 $oldpage = $this->getPage($from);
423 $newpage = $this->getPage($to);
424 //update all WikiLinks in existing pages
425 //non-atomic! i.e. if rename fails the links are not undone
426 if ($updateWikiLinks) {
427 require_once('lib/plugin/WikiAdminSearchReplace.php');
428 $links = $oldpage->getBackLinks();
429 while ($linked_page = $links->next()) {
430 WikiPlugin_WikiAdminSearchReplace::replaceHelper($this,$linked_page->getName(),$from,$to);
432 $links = $newpage->getBackLinks();
433 while ($linked_page = $links->next()) {
434 WikiPlugin_WikiAdminSearchReplace::replaceHelper($this,$linked_page->getName(),$from,$to);
437 if ($oldpage->exists() and ! $newpage->exists()) {
438 if ($result = $this->_backend->rename_page($from, $to)) {
439 //create a RecentChanges entry with explaining summary
440 $page = $this->getPage($to);
441 $current = $page->getCurrentRevision();
442 $meta = $current->_data;
443 $version = $current->getVersion();
444 $meta['summary'] = sprintf(_("renamed from %s"), $from);
445 $page->save($current->getPackedContent(), $version + 1, $meta);
447 } elseif (!$oldpage->getCurrentRevision(false) and !$newpage->exists()) {
448 // if a version 0 exists try it also.
449 $result = $this->_backend->rename_page($from, $to);
452 trigger_error(_("WikiDB::renamePage() not yet implemented for this backend"),
455 /* Generate notification emails? */
457 $notify = $this->get('notify');
458 if (!empty($notify) and is_array($notify)) {
459 list($emails, $userids) = $oldpage->getPageChangeEmails($notify);
460 if (!empty($emails)) {
461 $oldpage->sendPageRenameNotification($to, &$meta, $emails, $userids);
468 /** Get timestamp when database was last modified.
470 * @return string A string consisting of two integers,
471 * separated by a space. The first is the time in
472 * unix timestamp format, the second is a modification
473 * count for the database.
475 * The idea is that you can cast the return value to an
476 * int to get a timestamp, or you can use the string value
477 * as a good hash for the entire database.
479 function getTimestamp() {
480 $ts = $this->get('_timestamp');
481 return sprintf("%d %d", $ts[0], $ts[1]);
485 * Update the database timestamp.
489 $ts = $this->get('_timestamp');
490 $this->set('_timestamp', array(time(), $ts[1] + 1));
495 * Access WikiDB global meta-data.
497 * NOTE: this is currently implemented in a hackish and
498 * not very efficient manner.
502 * @param string $key Which meta data to get.
503 * Some reserved meta-data keys are:
505 * <dt>'_timestamp' <dd> Data used by getTimestamp().
508 * @return scalar The requested value, or false if the requested data
512 if (!$key || $key[0] == '%')
515 * Hack Alert: We can use any page (existing or not) to store
516 * this data (as long as we always use the same one.)
518 $gd = $this->getPage('global_data');
519 $data = $gd->get('__global');
521 if ($data && isset($data[$key]))
528 * Set global meta-data.
530 * NOTE: this is currently implemented in a hackish and
531 * not very efficient manner.
536 * @param string $key Meta-data key to set.
537 * @param string $newval New value.
539 function set($key, $newval) {
540 if (!$key || $key[0] == '%')
543 $gd = $this->getPage('global_data');
544 $data = $gd->get('__global');
551 $data[$key] = $newval;
553 $gd->set('__global', $data);
556 // SQL result: for simple select or create/update queries
557 // returns the database specific resource type
558 function genericSqlQuery($sql) {
559 if (function_exists('debug_backtrace')) { // >= 4.3.0
560 echo "<pre>", printSimpleTrace(debug_backtrace()), "</pre>\n";
562 trigger_error("no SQL database", E_USER_ERROR);
566 // SQL iter: for simple select or create/update queries
567 // returns the generic iterator object (count,next)
568 function genericSqlIter($sql, $field_list = NULL) {
569 if (function_exists('debug_backtrace')) { // >= 4.3.0
570 echo "<pre>", printSimpleTrace(debug_backtrace()), "</pre>\n";
572 trigger_error("no SQL database", E_USER_ERROR);
576 // see upstream methods:
577 // ADODB adds surrounding quotes, SQL not yet!
578 function quote ($s) {
584 if (!$request->_dbi) return false;
585 else return false; /* so far only needed for sql so false it.
586 later we have to check dba also */
589 function getParam($param) {
591 if (isset($DBParams[$param])) return $DBParams[$param];
592 elseif ($param == 'prefix') return '';
596 function getAuthParam($param) {
597 global $DBAuthParams;
598 if (isset($DBAuthParams[$param])) return $DBAuthParams[$param];
599 elseif ($param == 'USER_AUTH_ORDER') return $GLOBALS['USER_AUTH_ORDER'];
600 elseif ($param == 'USER_AUTH_POLICY') return $GLOBALS['USER_AUTH_POLICY'];
607 * An abstract base class which representing a wiki-page within a
610 * A WikiDB_Page contains a number (at least one) of
611 * WikiDB_PageRevisions.
615 function WikiDB_Page(&$wikidb, $pagename) {
616 $this->_wikidb = &$wikidb;
617 $this->_pagename = $pagename;
619 if (!(is_string($pagename) and $pagename != '')) {
620 if (function_exists("xdebug_get_function_stack")) {
621 echo "xdebug_get_function_stack(): "; var_dump(xdebug_get_function_stack());
622 } elseif (function_exists("debug_backtrace")) { // >= 4.3.0
623 printSimpleTrace(debug_backtrace());
625 trigger_error("empty pagename", E_USER_WARNING);
629 assert(is_string($pagename) and $pagename != '');
633 * Get the name of the wiki page.
637 * @return string The page name.
640 return $this->_pagename;
643 // To reduce the memory footprint for larger sets of pagelists,
644 // we don't cache the content (only true or false) and
645 // we purge the pagedata (_cached_html) also
647 if (isset($this->_wikidb->_cache->_id_cache[$this->_pagename])) return true;
648 $current = $this->getCurrentRevision(false);
649 return ! $current->hasDefaultContents();
653 * Delete an old revision of a WikiDB_Page.
655 * Deletes the specified revision of the page.
656 * It is a fatal error to attempt to delete the current revision.
660 * @param integer $version Which revision to delete. (You can also
661 * use a WikiDB_PageRevision object here.)
663 function deleteRevision($version) {
664 $backend = &$this->_wikidb->_backend;
665 $cache = &$this->_wikidb->_cache;
666 $pagename = &$this->_pagename;
668 $version = $this->_coerce_to_version($version);
672 $backend->lock(array('page','version'));
673 $latestversion = $cache->get_latest_version($pagename);
674 if ($latestversion && $version == $latestversion) {
675 $backend->unlock(array('page','version'));
676 trigger_error(sprintf("Attempt to delete most recent revision of '%s'",
677 $pagename), E_USER_ERROR);
681 $cache->delete_versiondata($pagename, $version);
682 $backend->unlock(array('page','version'));
686 * Delete a revision, or possibly merge it with a previous
690 * Suppose an author make a (major) edit to a page. Shortly
691 * after that the same author makes a minor edit (e.g. to fix
692 * spelling mistakes he just made.)
694 * Now some time later, where cleaning out old saved revisions,
695 * and would like to delete his minor revision (since there's
696 * really no point in keeping minor revisions around for a long
699 * Note that the text after the minor revision probably represents
700 * what the author intended to write better than the text after
701 * the preceding major edit.
703 * So what we really want to do is merge the minor edit with the
706 * We will only do this when:
708 * <li>The revision being deleted is a minor one, and
709 * <li>It has the same author as the immediately preceding revision.
712 function mergeRevision($version) {
713 $backend = &$this->_wikidb->_backend;
714 $cache = &$this->_wikidb->_cache;
715 $pagename = &$this->_pagename;
717 $version = $this->_coerce_to_version($version);
721 $backend->lock(array('version'));
722 $latestversion = $cache->get_latest_version($pagename);
723 if ($latestversion && $version == $latestversion) {
724 $backend->unlock(array('version'));
725 trigger_error(sprintf("Attempt to merge most recent revision of '%s'",
726 $pagename), E_USER_ERROR);
730 $versiondata = $cache->get_versiondata($pagename, $version, true);
732 // Not there? ... we're done!
733 $backend->unlock(array('version'));
737 if ($versiondata['is_minor_edit']) {
738 $previous = $backend->get_previous_version($pagename, $version);
740 $prevdata = $cache->get_versiondata($pagename, $previous);
741 if ($prevdata['author_id'] == $versiondata['author_id']) {
742 // This is a minor revision, previous version is
743 // by the same author. We will merge the
745 $cache->update_versiondata($pagename, $previous,
746 array('%content' => $versiondata['%content'],
747 '_supplanted' => $versiondata['_supplanted']));
752 $cache->delete_versiondata($pagename, $version);
753 $backend->unlock(array('version'));
758 * Create a new revision of a {@link WikiDB_Page}.
762 * @param int $version Version number for new revision.
763 * To ensure proper serialization of edits, $version must be
764 * exactly one higher than the current latest version.
765 * (You can defeat this check by setting $version to
766 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
768 * @param string $content Contents of new revision.
770 * @param hash $metadata Metadata for new revision.
771 * All values in the hash should be scalars (strings or integers).
773 * @param array $links List of pagenames which this page links to.
775 * @return WikiDB_PageRevision Returns the new WikiDB_PageRevision object. If
776 * $version was incorrect, returns false
778 function createRevision($version, &$content, $metadata, $links) {
779 $backend = &$this->_wikidb->_backend;
780 $cache = &$this->_wikidb->_cache;
781 $pagename = &$this->_pagename;
782 $cache->invalidate_cache($pagename);
784 $backend->lock(array('version','page','recent','link','nonempty'));
786 $latestversion = $backend->get_latest_version($pagename);
787 $newversion = ($latestversion ? $latestversion : 0) + 1;
788 assert($newversion >= 1);
790 if ($version != WIKIDB_FORCE_CREATE and $version != $newversion) {
791 $backend->unlock(array('version','page','recent','link','nonempty'));
797 foreach ($data as $key => $val) {
798 if (empty($val) || $key[0] == '_' || $key[0] == '%')
802 assert(!empty($data['author']));
803 if (empty($data['author_id']))
804 @$data['author_id'] = $data['author'];
806 if (empty($data['mtime']))
807 $data['mtime'] = time();
809 if ($latestversion) {
810 // Ensure mtimes are monotonic.
811 $pdata = $cache->get_versiondata($pagename, $latestversion);
812 if ($data['mtime'] < $pdata['mtime']) {
813 trigger_error(sprintf(_("%s: Date of new revision is %s"),
814 $pagename,"'non-monotonic'"),
816 $data['orig_mtime'] = $data['mtime'];
817 $data['mtime'] = $pdata['mtime'];
820 // FIXME: use (possibly user specified) 'mtime' time or
822 $cache->update_versiondata($pagename, $latestversion,
823 array('_supplanted' => $data['mtime']));
826 $data['%content'] = &$content;
828 $cache->set_versiondata($pagename, $newversion, $data);
830 //$cache->update_pagedata($pagename, array(':latestversion' => $newversion,
831 //':deleted' => empty($content)));
833 $backend->set_links($pagename, $links);
835 $backend->unlock(array('version','page','recent','link','nonempty'));
837 return new WikiDB_PageRevision($this->_wikidb, $pagename, $newversion,
841 /** A higher-level interface to createRevision.
843 * This takes care of computing the links, and storing
844 * a cached version of the transformed wiki-text.
846 * @param string $wikitext The page content.
848 * @param int $version Version number for new revision.
849 * To ensure proper serialization of edits, $version must be
850 * exactly one higher than the current latest version.
851 * (You can defeat this check by setting $version to
852 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
854 * @param hash $meta Meta-data for new revision.
856 function save($wikitext, $version, $meta) {
857 $formatted = new TransformedText($this, $wikitext, $meta);
858 $type = $formatted->getType();
859 $meta['pagetype'] = $type->getName();
860 $links = $formatted->getWikiPageLinks();
862 $backend = &$this->_wikidb->_backend;
863 $newrevision = $this->createRevision($version, $wikitext, $meta, $links);
864 if ($newrevision and !WIKIDB_NOCACHE_MARKUP)
865 $this->set('_cached_html', $formatted->pack());
867 // FIXME: probably should have some global state information
868 // in the backend to control when to optimize.
870 // We're doing this here rather than in createRevision because
871 // postgres can't optimize while locked.
872 if (DEBUG or (time() % 50 == 0)) {
873 if ($backend->optimize())
874 trigger_error(_("Optimizing database"), E_USER_NOTICE);
877 /* Generate notification emails? */
878 if (isa($newrevision, 'WikiDB_PageRevision')) {
879 // Save didn't fail because of concurrent updates.
880 $notify = $this->_wikidb->get('notify');
881 if (!empty($notify) and is_array($notify)) {
882 list($emails, $userids) = $this->getPageChangeEmails($notify);
883 if (!empty($emails)) {
884 $this->sendPageChangeNotification($wikitext, $version, $meta, $emails, $userids);
889 $newrevision->_transformedContent = $formatted;
893 function getPageChangeEmails($notify) {
894 $emails = array(); $userids = array();
895 foreach ($notify as $page => $users) {
896 if (glob_match($page, $this->_pagename)) {
897 foreach ($users as $userid => $user) {
898 if (!$user) { // handle the case for ModeratePage: no prefs, just userid's.
900 $u = $request->getUser();
901 if ($u->UserName() == $userid) {
902 $prefs = $u->getPreferences();
905 if (ENABLE_USER_NEW) {
906 $u = WikiUser($userid);
907 $u->getPreferences();
908 $prefs = &$u->_prefs;
910 $u = new WikiUser($GLOBALS['request'], $userid);
911 $prefs = $u->getPreferences();
914 $emails[] = $prefs->get('email');
915 $userids[] = $userid;
917 if (!empty($user['verified']) and !empty($user['email'])) {
918 $emails[] = $user['email'];
919 $userids[] = $userid;
920 } elseif (!empty($user['email'])) {
922 // do a dynamic emailVerified check update
923 $u = $request->getUser();
924 if ($u->UserName() == $userid) {
925 if ($request->_prefs->get('emailVerified')) {
926 $emails[] = $user['email'];
927 $userids[] = $userid;
928 $notify[$page][$userid]['verified'] = 1;
929 $request->_dbi->set('notify', $notify);
933 if (ENABLE_USER_NEW) {
934 $u = WikiUser($userid);
935 $u->getPreferences();
936 $prefs = &$u->_prefs;
938 $u = new WikiUser($GLOBALS['request'], $userid);
939 $prefs = $u->getPreferences();
941 if ($prefs->get('emailVerified')) {
942 $emails[] = $user['email'];
943 $userids[] = $userid;
944 $notify[$page][$userid]['verified'] = 1;
945 $request->_dbi->set('notify', $notify);
948 // ignore verification
951 if (!in_array($user['email'],$emails))
952 $emails[] = $user['email'];
960 $emails = array_unique($emails);
961 $userids = array_unique($userids);
962 return array($emails, $userids);
966 * Send udiff for a changed page to multiple users.
967 * See rename and remove methods also
969 function sendPageChangeNotification(&$wikitext, $version, $meta, $emails, $userids) {
971 if (@is_array($request->_deferredPageChangeNotification)) {
972 // collapse multiple changes (loaddir) into one email
973 $request->_deferredPageChangeNotification[] = array($this->_pagename, $emails, $userids);
976 $backend = &$this->_wikidb->_backend;
977 //$backend = &$request->_dbi->_backend;
978 $subject = _("Page change").' '.urlencode($this->_pagename);
979 $previous = $backend->get_previous_version($this->_pagename, $version);
980 if (!isset($meta['mtime'])) $meta['mtime'] = time();
982 $difflink = WikiURL($this->_pagename, array('action'=>'diff'), true);
983 $cache = &$this->_wikidb->_cache;
984 //$cache = &$request->_dbi->_cache;
985 $this_content = explode("\n", $wikitext);
986 $prevdata = $cache->get_versiondata($this->_pagename, $previous, true);
987 if (empty($prevdata['%content']))
988 $prevdata = $backend->get_versiondata($this->_pagename, $previous, true);
989 $other_content = explode("\n", $prevdata['%content']);
991 include_once("lib/difflib.php");
992 $diff2 = new Diff($other_content, $this_content);
993 //$context_lines = max(4, count($other_content) + 1,
994 // count($this_content) + 1);
995 $fmt = new UnifiedDiffFormatter(/*$context_lines*/);
996 $content = $this->_pagename . " " . $previous . " " . Iso8601DateTime($prevdata['mtime']) . "\n";
997 $content .= $this->_pagename . " " . $version . " " . Iso8601DateTime($meta['mtime']) . "\n";
998 $content .= $fmt->format($diff2);
1001 $difflink = WikiURL($this->_pagename,array(),true);
1002 $content = $this->_pagename . " " . $version . " " . Iso8601DateTime($meta['mtime']) . "\n";
1003 $content .= _("New Page");
1005 $editedby = sprintf(_("Edited by: %s"), $meta['author']);
1006 $emails = join(',',$emails);
1007 if (mail($emails,"[".WIKI_NAME."] ".$subject,
1012 trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
1013 $this->_pagename, join(',',$userids)), E_USER_NOTICE);
1015 trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
1016 $this->_pagename, join(',',$userids)), E_USER_WARNING);
1019 /** support mass rename / remove (not yet tested)
1021 function sendPageRenameNotification($to, &$meta, $emails, $userids) {
1023 if (@is_array($request->_deferredPageRenameNotification)) {
1024 $request->_deferredPageRenameNotification[] = array($this->_pagename, $to, $meta, $emails, $userids);
1026 $from = $this->_pagename;
1027 $editedby = sprintf(_("Edited by: %s"), $meta['author']) . ' ' . $meta['author_id'];
1028 $emails = join(',',$emails);
1029 $subject = sprintf(_("Page rename %s to %s"), urlencode($from), urlencode($to));
1030 $link = WikiURL($to, true);
1031 if (mail($emails,"[".WIKI_NAME."] ".$subject,
1035 "Renamed $from to $to"))
1036 trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
1037 $from, join(',',$userids)), E_USER_NOTICE);
1039 trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
1040 $from, join(',',$userids)), E_USER_WARNING);
1045 * Get the most recent revision of a page.
1049 * @return WikiDB_PageRevision The current WikiDB_PageRevision object.
1051 function getCurrentRevision($need_content = true) {
1052 $backend = &$this->_wikidb->_backend;
1053 $cache = &$this->_wikidb->_cache;
1054 $pagename = &$this->_pagename;
1056 // Prevent deadlock in case of memory exhausted errors
1057 // Pure selection doesn't really need locking here.
1058 // sf.net bug#927395
1059 // I know it would be better to lock, but with lots of pages this deadlock is more
1060 // severe than occasionally get not the latest revision.
1061 // In spirit to wikiwiki: read fast, edit slower.
1063 $version = $cache->get_latest_version($pagename);
1064 // getRevision gets the content also!
1065 $revision = $this->getRevision($version, $need_content);
1066 //$backend->unlock();
1072 * Get a specific revision of a WikiDB_Page.
1076 * @param integer $version Which revision to get.
1078 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or
1079 * false if the requested revision does not exist in the {@link WikiDB}.
1080 * Note that version zero of any page always exists.
1082 function getRevision($version, $need_content=true) {
1083 $cache = &$this->_wikidb->_cache;
1084 $pagename = &$this->_pagename;
1086 if (! $version ) // 0 or false
1087 return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
1089 assert($version > 0);
1090 $vdata = $cache->get_versiondata($pagename, $version, $need_content);
1094 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1099 * Get previous page revision.
1101 * This method find the most recent revision before a specified
1106 * @param integer $version Find most recent revision before this version.
1107 * You can also use a WikiDB_PageRevision object to specify the $version.
1109 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or false if the
1110 * requested revision does not exist in the {@link WikiDB}. Note that
1111 * unless $version is greater than zero, a revision (perhaps version zero,
1112 * the default revision) will always be found.
1114 function getRevisionBefore($version, $need_content=true) {
1115 $backend = &$this->_wikidb->_backend;
1116 $pagename = &$this->_pagename;
1118 $version = $this->_coerce_to_version($version);
1123 $previous = $backend->get_previous_version($pagename, $version);
1124 $revision = $this->getRevision($previous, $need_content);
1125 //$backend->unlock();
1131 * Get all revisions of the WikiDB_Page.
1133 * This does not include the version zero (default) revision in the
1134 * returned revision set.
1136 * @return WikiDB_PageRevisionIterator A
1137 * WikiDB_PageRevisionIterator containing all revisions of this
1138 * WikiDB_Page in reverse order by version number.
1140 function getAllRevisions() {
1141 $backend = &$this->_wikidb->_backend;
1142 $revs = $backend->get_all_revisions($this->_pagename);
1143 return new WikiDB_PageRevisionIterator($this->_wikidb, $revs);
1147 * Find pages which link to or are linked from a page.
1151 * @param boolean $reversed Which links to find: true for backlinks (default).
1153 * @return WikiDB_PageIterator A WikiDB_PageIterator containing
1154 * all matching pages.
1156 function getLinks($reversed = true, $include_empty=false) {
1157 $backend = &$this->_wikidb->_backend;
1158 $result = $backend->get_links($this->_pagename, $reversed, $include_empty=false);
1159 return new WikiDB_PageIterator($this->_wikidb, $result, array('include_empty' => $include_empty));
1163 * All Links from other pages to this page.
1165 function getBackLinks($include_empty=false) {
1166 return $this->getLinks(true, $include_empty=false);
1169 * Forward Links: All Links from this page to other pages.
1171 function getPageLinks($include_empty=false) {
1172 return $this->getLinks(false, $include_empty=false);
1176 * possibly faster link existance check. not yet accelerated.
1178 function existLink($link, $reversed = false) {
1179 $cache = &$this->_wikidb->_cache;
1180 // TODO: check cache if it is possible
1181 $iter = $this->getLinks($reversed, false);
1182 while ($page = $iter->next()) {
1183 if ($page->getName() == $link)
1191 * Access WikiDB_Page meta-data.
1195 * @param string $key Which meta data to get.
1196 * Some reserved meta-data keys are:
1198 * <dt>'locked'<dd> Is page locked?
1199 * <dt>'hits' <dd> Page hit counter.
1200 * <dt>'pref' <dd> Users preferences, stored in homepages.
1201 * <dt>'owner' <dd> Default: first author_id. We might add a group with a dot here:
1202 * E.g. "owner.users"
1203 * <dt>'perm' <dd> Permission flag to authorize read/write/execution of
1204 * page-headers and content.
1205 * <dt>'score' <dd> Page score (not yet implement, do we need?)
1208 * @return scalar The requested value, or false if the requested data
1211 function get($key) {
1212 $cache = &$this->_wikidb->_cache;
1213 if (!$key || $key[0] == '%')
1215 $data = $cache->get_pagedata($this->_pagename);
1216 return isset($data[$key]) ? $data[$key] : false;
1220 * Get all the page meta-data as a hash.
1222 * @return hash The page meta-data.
1224 function getMetaData() {
1225 $cache = &$this->_wikidb->_cache;
1226 $data = $cache->get_pagedata($this->_pagename);
1228 foreach ($data as $key => $val) {
1229 if (/*!empty($val) &&*/ $key[0] != '%')
1236 * Set page meta-data.
1241 * @param string $key Meta-data key to set.
1242 * @param string $newval New value.
1244 function set($key, $newval) {
1245 $cache = &$this->_wikidb->_cache;
1246 $pagename = &$this->_pagename;
1248 assert($key && $key[0] != '%');
1250 $data = $cache->get_pagedata($pagename);
1252 if (!empty($newval)) {
1253 if (!empty($data[$key]) && $data[$key] == $newval)
1254 return; // values identical, skip update.
1257 if (empty($data[$key]))
1258 return; // values identical, skip update.
1261 $cache->update_pagedata($pagename, array($key => $newval));
1265 * Increase page hit count.
1267 * FIXME: IS this needed? Probably not.
1269 * This is a convenience function.
1270 * <pre> $page->increaseHitCount(); </pre>
1271 * is functionally identical to
1272 * <pre> $page->set('hits',$page->get('hits')+1); </pre>
1273 * but less expensive (ignores the pagadata string)
1275 * Note that this method may be implemented in more efficient ways
1276 * in certain backends.
1280 function increaseHitCount() {
1281 if (method_exists($this->_wikidb->_backend, 'increaseHitCount'))
1282 $this->_wikidb->_backend->increaseHitCount($this->_pagename);
1284 @$newhits = $this->get('hits') + 1;
1285 $this->set('hits', $newhits);
1290 * Return a string representation of the WikiDB_Page
1292 * This is really only for debugging.
1296 * @return string Printable representation of the WikiDB_Page.
1298 function asString () {
1300 printf("[%s:%s\n", get_class($this), $this->getName());
1301 print_r($this->getMetaData());
1303 $strval = ob_get_contents();
1311 * @param integer_or_object $version_or_pagerevision
1312 * Takes either the version number (and int) or a WikiDB_PageRevision
1314 * @return integer The version number.
1316 function _coerce_to_version($version_or_pagerevision) {
1317 if (method_exists($version_or_pagerevision, "getContent"))
1318 $version = $version_or_pagerevision->getVersion();
1320 $version = (int) $version_or_pagerevision;
1322 assert($version >= 0);
1326 function isUserPage ($include_empty = true) {
1327 if (!$include_empty and !$this->exists()) return false;
1328 return $this->get('pref') ? true : false;
1331 // May be empty. Either the stored owner (/Chown), or the first authorized author
1332 function getOwner() {
1333 if ($owner = $this->get('owner'))
1334 return ($owner == "The PhpWiki programming team") ? ADMIN_USER : $owner;
1335 // check all revisions forwards for the first author_id
1336 $backend = &$this->_wikidb->_backend;
1337 $pagename = &$this->_pagename;
1338 $latestversion = $backend->get_latest_version($pagename);
1339 for ($v=1; $v <= $latestversion; $v++) {
1340 $rev = $this->getRevision($v,false);
1341 if ($rev and $owner = $rev->get('author_id')) {
1342 return ($owner == "The PhpWiki programming team") ? ADMIN_USER : $owner;
1348 // The authenticated author of the first revision or empty if not authenticated then.
1349 function getCreator() {
1350 if ($current = $this->getRevision(1,false)) return $current->get('author_id');
1354 // The authenticated author of the current revision.
1355 function getAuthor() {
1356 if ($current = $this->getCurrentRevision(false)) return $current->get('author_id');
1363 * This class represents a specific revision of a WikiDB_Page within
1366 * A WikiDB_PageRevision has read-only semantics. You may only create
1367 * new revisions (and delete old ones) --- you cannot modify existing
1370 class WikiDB_PageRevision
1372 //var $_transformedContent = false; // set by WikiDB_Page::save()
1374 function WikiDB_PageRevision(&$wikidb, $pagename, $version, $versiondata = false) {
1375 $this->_wikidb = &$wikidb;
1376 $this->_pagename = $pagename;
1377 $this->_version = $version;
1378 $this->_data = $versiondata ? $versiondata : array();
1379 $this->_transformedContent = false; // set by WikiDB_Page::save()
1383 * Get the WikiDB_Page which this revision belongs to.
1387 * @return WikiDB_Page The WikiDB_Page which this revision belongs to.
1389 function getPage() {
1390 return new WikiDB_Page($this->_wikidb, $this->_pagename);
1394 * Get the version number of this revision.
1398 * @return integer The version number of this revision.
1400 function getVersion() {
1401 return $this->_version;
1405 * Determine whether this revision has defaulted content.
1407 * The default revision (version 0) of each page, as well as any
1408 * pages which are created with empty content have their content
1409 * defaulted to something like:
1411 * Describe [ThisPage] here.
1416 * @return boolean Returns true if the page has default content.
1418 function hasDefaultContents() {
1419 $data = &$this->_data;
1420 return empty($data['%content']); // FIXME: what if it's the number 0? <>'' or === false
1424 * Get the content as an array of lines.
1428 * @return array An array of lines.
1429 * The lines should contain no trailing white space.
1431 function getContent() {
1432 return explode("\n", $this->getPackedContent());
1436 * Get the pagename of the revision.
1440 * @return string pagename.
1442 function getPageName() {
1443 return $this->_pagename;
1447 * Determine whether revision is the latest.
1451 * @return boolean True iff the revision is the latest (most recent) one.
1453 function isCurrent() {
1454 if (!isset($this->_iscurrent)) {
1455 $page = $this->getPage();
1456 $current = $page->getCurrentRevision(false);
1457 $this->_iscurrent = $this->getVersion() == $current->getVersion();
1459 return $this->_iscurrent;
1463 * Get the transformed content of a page.
1465 * @param string $pagetype Override the page-type of the revision.
1467 * @return object An XmlContent-like object containing the page transformed
1470 function getTransformedContent($pagetype_override=false) {
1471 $backend = &$this->_wikidb->_backend;
1473 if ($pagetype_override) {
1474 // Figure out the normal page-type for this page.
1475 $type = PageType::GetPageType($this->get('pagetype'));
1476 if ($type->getName() == $pagetype_override)
1477 $pagetype_override = false; // Not really an override...
1480 if ($pagetype_override) {
1481 // Overriden page type, don't cache (or check cache).
1482 return new TransformedText($this->getPage(),
1483 $this->getPackedContent(),
1484 $this->getMetaData(),
1485 $pagetype_override);
1488 $possibly_cache_results = true;
1490 if (!USECACHE or WIKIDB_NOCACHE_MARKUP) {
1491 if (WIKIDB_NOCACHE_MARKUP == 'purge') {
1492 // flush cache for this page.
1493 $page = $this->getPage();
1494 $page->set('_cached_html', false);
1496 $possibly_cache_results = false;
1498 elseif (!$this->_transformedContent) {
1500 if ($this->isCurrent()) {
1501 $page = $this->getPage();
1502 $this->_transformedContent = TransformedText::unpack($page->get('_cached_html'));
1505 $possibly_cache_results = false;
1507 //$backend->unlock();
1510 if (!$this->_transformedContent) {
1511 $this->_transformedContent
1512 = new TransformedText($this->getPage(),
1513 $this->getPackedContent(),
1514 $this->getMetaData());
1516 if ($possibly_cache_results) {
1517 // If we're still the current version, cache the transfomed page.
1519 if ($this->isCurrent()) {
1520 $page->set('_cached_html', $this->_transformedContent->pack());
1522 //$backend->unlock();
1526 return $this->_transformedContent;
1530 * Get the content as a string.
1534 * @return string The page content.
1535 * Lines are separated by new-lines.
1537 function getPackedContent() {
1538 $data = &$this->_data;
1541 if (empty($data['%content'])) {
1542 include_once('lib/InlineParser.php');
1544 // A feature similar to taglines at http://www.wlug.org.nz/
1545 // Lib from http://www.aasted.org/quote/
1546 if (defined('FORTUNE_DIR')
1547 and is_dir(FORTUNE_DIR)
1548 and in_array($GLOBALS['request']->getArg('action'),
1549 array('create','edit')))
1551 include_once("lib/fortune.php");
1552 $fortune = new Fortune();
1553 $quote = str_replace("\n<br>","\n", $fortune->quoteFromDir(FORTUNE_DIR));
1554 return sprintf("<verbatim>\n%s</verbatim>\n\n"._("Describe %s here."),
1555 $quote, "[" . WikiEscape($this->_pagename) . "]");
1557 // Replace empty content with default value.
1558 return sprintf(_("Describe %s here."),
1559 "[" . WikiEscape($this->_pagename) . "]");
1562 // There is (non-default) content.
1563 assert($this->_version > 0);
1565 if (!is_string($data['%content'])) {
1566 // Content was not provided to us at init time.
1567 // (This is allowed because for some backends, fetching
1568 // the content may be expensive, and often is not wanted
1571 // In any case, now we need to get it.
1572 $data['%content'] = $this->_get_content();
1573 assert(is_string($data['%content']));
1576 return $data['%content'];
1579 function _get_content() {
1580 $cache = &$this->_wikidb->_cache;
1581 $pagename = $this->_pagename;
1582 $version = $this->_version;
1584 assert($version > 0);
1586 $newdata = $cache->get_versiondata($pagename, $version, true);
1588 assert(is_string($newdata['%content']));
1589 return $newdata['%content'];
1592 // else revision has been deleted... What to do?
1593 return __sprintf("Oops! Revision %s of %s seems to have been deleted!",
1594 $version, $pagename);
1599 * Get meta-data for this revision.
1604 * @param string $key Which meta-data to access.
1606 * Some reserved revision meta-data keys are:
1608 * <dt> 'mtime' <dd> Time this revision was created (seconds since midnight Jan 1, 1970.)
1609 * The 'mtime' meta-value is normally set automatically by the database
1610 * backend, but it may be specified explicitly when creating a new revision.
1612 * <dd> To ensure consistency of RecentChanges, the mtimes of the versions
1613 * of a page must be monotonically increasing. If an attempt is
1614 * made to create a new revision with an mtime less than that of
1615 * the preceeding revision, the new revisions timestamp is force
1616 * to be equal to that of the preceeding revision. In that case,
1617 * the originally requested mtime is preserved in 'orig_mtime'.
1618 * <dt> '_supplanted' <dd> Time this revision ceased to be the most recent.
1619 * This meta-value is <em>always</em> automatically maintained by the database
1620 * backend. (It is set from the 'mtime' meta-value of the superceding
1621 * revision.) '_supplanted' has a value of 'false' for the current revision.
1623 * FIXME: this could be refactored:
1625 * <dd> Author of the page (as he should be reported in, e.g. RecentChanges.)
1627 * <dd> Authenticated author of a page. This is used to identify
1628 * the distinctness of authors when cleaning old revisions from
1630 * <dt> 'is_minor_edit' <dd> Set if change was marked as a minor revision by the author.
1631 * <dt> 'summary' <dd> Short change summary entered by page author.
1634 * Meta-data keys must be valid C identifers (they have to start with a letter
1635 * or underscore, and can contain only alphanumerics and underscores.)
1637 * @return string The requested value, or false if the requested value
1640 function get($key) {
1641 if (!$key || $key[0] == '%')
1643 $data = &$this->_data;
1644 return isset($data[$key]) ? $data[$key] : false;
1648 * Get all the revision page meta-data as a hash.
1650 * @return hash The revision meta-data.
1652 function getMetaData() {
1654 foreach ($this->_data as $key => $val) {
1655 if (!empty($val) && $key[0] != '%')
1663 * Return a string representation of the revision.
1665 * This is really only for debugging.
1669 * @return string Printable representation of the WikiDB_Page.
1671 function asString () {
1673 printf("[%s:%d\n", get_class($this), $this->get('version'));
1674 print_r($this->_data);
1675 echo $this->getPackedContent() . "\n]\n";
1676 $strval = ob_get_contents();
1684 * Class representing a sequence of WikiDB_Pages.
1685 * TODO: Enhance to php5 iterators
1687 class WikiDB_PageIterator
1689 function WikiDB_PageIterator(&$wikidb, &$iter, $options=false) {
1690 $this->_iter = $iter; // a WikiDB_backend_iterator
1691 $this->_wikidb = &$wikidb;
1692 $this->_options = $options;
1696 return $this->_iter->count();
1700 * Get next WikiDB_Page in sequence.
1704 * @return WikiDB_Page The next WikiDB_Page in the sequence.
1707 if ( ! ($next = $this->_iter->next()) )
1710 $pagename = &$next['pagename'];
1712 trigger_error('empty pagename in WikiDB_PageIterator::next()', E_USER_WARNING);
1716 // there's always hits, but we cache only if more
1717 // (well not with file, cvs and dba)
1718 if (isset($next['pagedata']) and count($next['pagedata']) > 1) {
1719 $this->_wikidb->_cache->cache_data($next);
1720 // cache existing page id's since we iterate over all links in GleanDescription
1721 // and need them later for LinkExistingWord
1722 } elseif ($this->_options and array_key_exists('include_empty', $this->_options)
1723 and !$this->_options['include_empty'] and isset($next['id'])) {
1724 $this->_wikidb->_cache->_id_cache[$next['pagename']] = $next['id'];
1726 return new WikiDB_Page($this->_wikidb, $pagename);
1730 * Release resources held by this iterator.
1732 * The iterator may not be used after free() is called.
1734 * There is no need to call free(), if next() has returned false.
1735 * (I.e. if you iterate through all the pages in the sequence,
1736 * you do not need to call free() --- you only need to call it
1737 * if you stop before the end of the iterator is reached.)
1742 $this->_iter->free();
1745 function asArray() {
1747 while ($page = $this->next())
1757 * A class which represents a sequence of WikiDB_PageRevisions.
1758 * TODO: Enhance to php5 iterators
1760 class WikiDB_PageRevisionIterator
1762 function WikiDB_PageRevisionIterator(&$wikidb, &$revisions, $options=false) {
1763 $this->_revisions = $revisions;
1764 $this->_wikidb = &$wikidb;
1765 $this->_options = $options;
1769 return $this->_revisions->count();
1773 * Get next WikiDB_PageRevision in sequence.
1777 * @return WikiDB_PageRevision
1778 * The next WikiDB_PageRevision in the sequence.
1781 if ( ! ($next = $this->_revisions->next()) )
1784 $this->_wikidb->_cache->cache_data($next);
1786 $pagename = $next['pagename'];
1787 $version = $next['version'];
1788 $versiondata = $next['versiondata'];
1790 if (!(is_string($pagename) and $pagename != '')) {
1791 trigger_error("empty pagename",E_USER_WARNING);
1794 } else assert(is_string($pagename) and $pagename != '');
1796 if (!is_array($versiondata)) {
1797 trigger_error("empty versiondata",E_USER_WARNING);
1800 } else assert(is_array($versiondata));
1802 if (!($version > 0)) {
1803 trigger_error("invalid version",E_USER_WARNING);
1806 } else assert($version > 0);
1808 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1813 * Release resources held by this iterator.
1815 * The iterator may not be used after free() is called.
1817 * There is no need to call free(), if next() has returned false.
1818 * (I.e. if you iterate through all the revisions in the sequence,
1819 * you do not need to call free() --- you only need to call it
1820 * if you stop before the end of the iterator is reached.)
1825 $this->_revisions->free();
1828 function asArray() {
1830 while ($rev = $this->next())
1839 class WikiDB_Array_PageIterator
1841 function WikiDB_Array_PageIterator(&$pagenames) {
1843 $this->_dbi = $request->getDbh();
1844 $this->_pages = $pagenames;
1845 reset($this->_pages);
1848 $c =& current($this->_pages);
1849 next($this->_pages);
1850 return $c !== false ? $this->_dbi->getPage($c) : false;
1853 return count($this->_pages);
1856 function asArray() {
1857 reset($this->_pages);
1858 return $this->_pages;
1862 class WikiDB_Array_generic_iter
1864 function WikiDB_Array_generic_iter($result) {
1865 // $result may be either an array or a query result
1866 if (is_array($result)) {
1867 $this->_array = $result;
1868 } elseif (is_object($result)) {
1869 $this->_array = $result->asArray();
1871 $this->_array = array();
1873 if (!empty($this->_array))
1874 reset($this->_array);
1877 $c =& current($this->_array);
1878 next($this->_array);
1879 return $c !== false ? $c : false;
1882 return count($this->_array);
1885 function asArray() {
1886 if (!empty($this->_array))
1887 reset($this->_array);
1888 return $this->_array;
1893 * Data cache used by WikiDB.
1895 * FIXME: Maybe rename this to caching_backend (or some such).
1901 // FIXME: beautify versiondata cache. Cache only limited data?
1903 function WikiDB_cache (&$backend) {
1904 $this->_backend = &$backend;
1906 $this->_pagedata_cache = array();
1907 $this->_versiondata_cache = array();
1908 array_push ($this->_versiondata_cache, array());
1909 $this->_glv_cache = array();
1910 $this->_id_cache = array(); // formerly ->_dbi->_iwpcache (nonempty pages => id)
1914 $this->_pagedata_cache = array();
1915 $this->_versiondata_cache = array();
1916 $this->_glv_cache = array();
1917 $this->_id_cache = array();
1920 function get_pagedata($pagename) {
1921 assert(is_string($pagename) && $pagename != '');
1923 $cache = &$this->_pagedata_cache;
1924 if (!isset($cache[$pagename]) || !is_array($cache[$pagename])) {
1925 $cache[$pagename] = $this->_backend->get_pagedata($pagename);
1926 // Never keep a ['%pagedata']['_cached_html'] in cache, other than the current page.
1927 if (isset($cache[$pagename]['_cached_html'])
1928 and $pagename != $GLOBALS['request']->getArg('pagename')) {
1929 unset($cache[$pagename]['_cached_html']);
1931 if (empty($cache[$pagename]))
1932 $cache[$pagename] = array();
1934 return $cache[$pagename];
1936 return $this->_backend->get_pagedata($pagename);
1940 function update_pagedata($pagename, $newdata) {
1941 assert(is_string($pagename) && $pagename != '');
1942 unset ($this->_pagedata_cache[$pagename]);
1944 $this->_backend->update_pagedata($pagename, $newdata);
1946 if (USECACHE and !empty($this->_pagedata_cache[$pagename]) and is_array($this->_pagedata_cache[$pagename])) {
1947 $cachedata = &$this->_pagedata_cache[$pagename];
1948 foreach($newdata as $key => $val)
1949 $cachedata[$key] = $val;
1953 function invalidate_cache($pagename) {
1954 unset ($this->_pagedata_cache[$pagename]);
1955 unset ($this->_versiondata_cache[$pagename]);
1956 unset ($this->_glv_cache[$pagename]);
1957 unset ($this->_id_cache[$pagename]);
1958 //unset ($this->_backend->_page_data);
1961 function delete_page($pagename) {
1962 $this->_backend->delete_page($pagename);
1963 $this->invalidate_cache($pagename);
1967 function cache_data($data) {
1968 if (isset($data['pagedata']))
1969 $this->_pagedata_cache[$data['pagename']] = $data['pagedata'];
1972 function get_versiondata($pagename, $version, $need_content = false) {
1973 // FIXME: Seriously ugly hackage
1974 if (USECACHE) { //temporary - for debugging
1975 assert(is_string($pagename) && $pagename != '');
1976 // there is a bug here somewhere which results in an assertion failure at line 105
1977 // of ArchiveCleaner.php It goes away if we use the next line.
1978 //$need_content = true;
1979 $nc = $need_content ? '1':'0';
1980 $cache = &$this->_versiondata_cache;
1981 if (!isset($cache[$pagename][$version][$nc])||
1982 !(is_array ($cache[$pagename])) || !(is_array ($cache[$pagename][$version]))) {
1983 $cache[$pagename][$version][$nc] =
1984 $this->_backend->get_versiondata($pagename, $version, $need_content);
1985 // If we have retrieved all data, we may as well set the cache for $need_content = false
1987 $cache[$pagename][$version]['0'] =& $cache[$pagename][$version]['1'];
1990 $vdata = $cache[$pagename][$version][$nc];
1992 $vdata = $this->_backend->get_versiondata($pagename, $version, $need_content);
1995 // Rationale: never keep ['%pagedata']['_cached_html'] in cache.
1996 if ($vdata && !empty($vdata['%pagedata'])) {
1997 $this->_pagedata_cache[$pagename] =& $vdata['%pagedata'];
1998 // only store _cached_html for the requested page
2000 and isset($vdata['%pagedata']['_cached_html'])
2001 and $pagename != $GLOBALS['request']->getArg('pagename'))
2003 unset($this->_pagedata_cache[$pagename]['_cached_html']);
2004 unset($cache[$pagename][$version][$nc]['%pagedata']['_cached_html']);
2006 unset($cache[$pagename][$version][0]['%pagedata']['_cached_html']);
2012 function set_versiondata($pagename, $version, $data) {
2013 //unset($this->_versiondata_cache[$pagename][$version]);
2015 $new = $this->_backend->set_versiondata($pagename, $version, $data);
2017 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2018 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2019 // Is this necessary?
2020 unset($this->_glv_cache[$pagename]);
2023 function update_versiondata($pagename, $version, $data) {
2024 $new = $this->_backend->update_versiondata($pagename, $version, $data);
2026 // FIXME: never keep ['%pagedata']['_cached_html'] in cache.
2027 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2029 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2030 // Is this necessary?
2031 unset($this->_glv_cache[$pagename]);
2034 function delete_versiondata($pagename, $version) {
2035 $new = $this->_backend->delete_versiondata($pagename, $version);
2036 if (isset($this->_versiondata_cache[$pagename][$version]['1']))
2037 unset ($this->_versiondata_cache[$pagename][$version]['1']);
2038 if (isset($this->_versiondata_cache[$pagename][$version]['0']))
2039 unset ($this->_versiondata_cache[$pagename][$version]['0']);
2040 if (isset($this->_glv_cache[$pagename]))
2041 unset ($this->_glv_cache[$pagename]);
2044 function get_latest_version($pagename) {
2046 assert (is_string($pagename) && $pagename != '');
2047 $cache = &$this->_glv_cache;
2048 if (!isset($cache[$pagename])) {
2049 $cache[$pagename] = $this->_backend->get_latest_version($pagename);
2050 if (empty($cache[$pagename]))
2051 $cache[$pagename] = 0;
2053 return $cache[$pagename];
2055 return $this->_backend->get_latest_version($pagename);
2060 function _sql_debuglog($msg, $newline=true, $shutdown=false) {
2064 $stamp = strftime("%y%m%d-%H%M%S");
2065 $fp = fopen("/tmp/sql-$stamp.log", "a");
2066 register_shutdown_function("_sql_debuglog_shutdown_function");
2067 } elseif ($shutdown) {
2071 if ($newline) fputs($fp, "[$i++] $msg");
2072 else fwrite($fp, $msg);
2074 function _sql_debuglog_shutdown_function() {
2075 _sql_debuglog('',false,true);
2078 // $Log: not supported by cvs2svn $
2079 // Revision 1.103 2004/11/16 17:29:04 rurban
2080 // fix remove notification error
2081 // fix creation + update id_cache update
2083 // Revision 1.102 2004/11/11 18:31:26 rurban
2084 // add simple backtrace on such general failures to get at least an idea where
2086 // Revision 1.101 2004/11/10 19:32:22 rurban
2087 // * optimize increaseHitCount, esp. for mysql.
2088 // * prepend dirs to the include_path (phpwiki_dir for faster searches)
2089 // * Pear_DB version logic (awful but needed)
2090 // * fix broken ADODB quote
2091 // * _extract_page_data simplification
2093 // Revision 1.100 2004/11/10 15:29:20 rurban
2094 // * requires newer Pear_DB (as the internal one): quote() uses now escapeSimple for strings
2095 // * ACCESS_LOG_SQL: fix cause request not yet initialized
2096 // * WikiDB: moved SQL specific methods upwards
2097 // * new Pear_DB quoting: same as ADODB and as newer Pear_DB.
2098 // fixes all around: WikiGroup, WikiUserNew SQL methods, SQL logging
2100 // Revision 1.99 2004/11/09 17:11:05 rurban
2101 // * revert to the wikidb ref passing. there's no memory abuse there.
2102 // * use new wikidb->_cache->_id_cache[] instead of wikidb->_iwpcache, to effectively
2103 // store page ids with getPageLinks (GleanDescription) of all existing pages, which
2104 // are also needed at the rendering for linkExistingWikiWord().
2105 // pass options to pageiterator.
2106 // use this cache also for _get_pageid()
2107 // This saves about 8 SELECT count per page (num all pagelinks).
2108 // * fix passing of all page fields to the pageiterator.
2109 // * fix overlarge session data which got broken with the latest ACCESS_LOG_SQL changes
2111 // Revision 1.98 2004/11/07 18:34:29 rurban
2112 // more logging fixes
2114 // Revision 1.97 2004/11/07 16:02:51 rurban
2115 // new sql access log (for spam prevention), and restructured access log class
2116 // dbh->quote (generic)
2117 // pear_db: mysql specific parts seperated (using replace)
2119 // Revision 1.96 2004/11/05 22:32:15 rurban
2120 // encode the subject to be 7-bit safe
2122 // Revision 1.95 2004/11/05 20:53:35 rurban
2123 // login cleanup: better debug msg on failing login,
2124 // checked password less immediate login (bogo or anon),
2125 // checked olduser pref session error,
2126 // better PersonalPage without password warning on minimal password length=0
2127 // (which is default now)
2129 // Revision 1.94 2004/11/01 10:43:56 rurban
2130 // seperate PassUser methods into seperate dir (memory usage)
2131 // fix WikiUser (old) overlarge data session
2132 // remove wikidb arg from various page class methods, use global ->_dbi instead
2135 // Revision 1.93 2004/10/14 17:17:57 rurban
2136 // remove dbi WikiDB_Page param: use global request object instead. (memory)
2137 // allow most_popular sortby arguments
2139 // Revision 1.92 2004/10/05 17:00:04 rurban
2140 // support paging for simple lists
2141 // fix RatingDb sql backend.
2142 // remove pages from AllPages (this is ListPages then)
2144 // Revision 1.91 2004/10/04 23:41:19 rurban
2145 // delete notify: fix, @unset syntax error
2147 // Revision 1.90 2004/09/28 12:50:22 rurban
2148 // https://sourceforge.net/forum/forum.php?thread_id=1150924&forum_id=18929
2150 // Revision 1.89 2004/09/26 10:54:42 rurban
2151 // silence deferred check
2153 // Revision 1.88 2004/09/25 18:16:40 rurban
2154 // unset more unneeded _cached_html. (Guess this should fix sf.net now)
2156 // Revision 1.87 2004/09/25 16:25:40 rurban
2157 // notify on rename and remove (to be improved)
2159 // Revision 1.86 2004/09/23 18:52:06 rurban
2160 // only fortune at create
2162 // Revision 1.85 2004/09/16 08:00:51 rurban
2163 // just some comments
2165 // Revision 1.84 2004/09/14 10:34:30 rurban
2166 // fix TransformedText call to use refs
2168 // Revision 1.83 2004/09/08 13:38:00 rurban
2169 // improve loadfile stability by using markup=2 as default for undefined markup-style.
2170 // use more refs for huge objects.
2171 // fix debug=static issue in WikiPluginCached
2173 // Revision 1.82 2004/09/06 12:08:49 rurban
2174 // memory_limit on unix workaround
2175 // VisualWiki: default autosize image
2177 // Revision 1.81 2004/09/06 08:28:00 rurban
2178 // rename genericQuery to genericSqlQuery
2180 // Revision 1.80 2004/07/09 13:05:34 rurban
2183 // Revision 1.79 2004/07/09 10:06:49 rurban
2184 // Use backend specific sortby and sortable_columns method, to be able to
2185 // select between native (Db backend) and custom (PageList) sorting.
2186 // Fixed PageList::AddPageList (missed the first)
2187 // Added the author/creator.. name to AllPagesBy...
2188 // display no pages if none matched.
2189 // Improved dba and file sortby().
2190 // Use &$request reference
2192 // Revision 1.78 2004/07/08 21:32:35 rurban
2193 // Prevent from more warnings, minor db and sort optimizations
2195 // Revision 1.77 2004/07/08 19:04:42 rurban
2196 // more unittest fixes (file backend, metadata RatingsDb)
2198 // Revision 1.76 2004/07/08 17:31:43 rurban
2199 // improve numPages for file (fixing AllPagesTest)
2201 // Revision 1.75 2004/07/05 13:56:22 rurban
2202 // sqlite autoincrement fix
2204 // Revision 1.74 2004/07/03 16:51:05 rurban
2205 // optional DBADMIN_USER:DBADMIN_PASSWD for action=upgrade (if no ALTER permission)
2206 // added atomic mysql REPLACE for PearDB as in ADODB
2207 // fixed _lock_tables typo links => link
2208 // fixes unserialize ADODB bug in line 180
2210 // Revision 1.73 2004/06/29 08:52:22 rurban
2211 // Use ...version() $need_content argument in WikiDB also:
2212 // To reduce the memory footprint for larger sets of pagelists,
2213 // we don't cache the content (only true or false) and
2214 // we purge the pagedata (_cached_html) also.
2215 // _cached_html is only cached for the current pagename.
2216 // => Vastly improved page existance check, ACL check, ...
2218 // Now only PagedList info=content or size needs the whole content, esp. if sortable.
2220 // Revision 1.72 2004/06/25 14:15:08 rurban
2221 // reduce memory footprint by caching only requested pagedate content (improving most page iterators)
2223 // Revision 1.71 2004/06/21 16:22:30 rurban
2224 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
2225 // fixed dumping buttons locally (images/buttons/),
2226 // support pages arg for dumphtml,
2227 // optional directory arg for dumpserial + dumphtml,
2228 // fix a AllPages warning,
2229 // show dump warnings/errors on DEBUG,
2230 // don't warn just ignore on wikilens pagelist columns, if not loaded.
2231 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
2233 // Revision 1.70 2004/06/18 14:39:31 rurban
2234 // actually check USECACHE
2236 // Revision 1.69 2004/06/13 15:33:20 rurban
2237 // new support for arguments owner, author, creator in most relevant
2238 // PageList plugins. in WikiAdmin* via preSelectS()
2240 // Revision 1.68 2004/06/08 21:03:20 rurban
2241 // updated RssParser for XmlParser quirks (store parser object params in globals)
2243 // Revision 1.67 2004/06/07 19:12:49 rurban
2244 // fixed rename version=0, bug #966284
2246 // Revision 1.66 2004/06/07 18:57:27 rurban
2247 // fix rename: Change pagename in all linked pages
2249 // Revision 1.65 2004/06/04 20:32:53 rurban
2250 // Several locale related improvements suggested by Pierrick Meignen
2251 // LDAP fix by John Cole
2252 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
2254 // Revision 1.64 2004/06/04 16:50:00 rurban
2255 // add random quotes to empty pages
2257 // Revision 1.63 2004/06/04 11:58:38 rurban
2258 // added USE_TAGLINES
2260 // Revision 1.62 2004/06/03 22:24:41 rurban
2261 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
2263 // Revision 1.61 2004/06/02 17:13:48 rurban
2264 // fix getRevisionBefore assertion
2266 // Revision 1.60 2004/05/28 10:09:58 rurban
2267 // fix bug #962117, incorrect init of auth_dsn
2269 // Revision 1.59 2004/05/27 17:49:05 rurban
2270 // renamed DB_Session to DbSession (in CVS also)
2271 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
2272 // remove leading slash in error message
2273 // added force_unlock parameter to File_Passwd (no return on stale locks)
2274 // fixed adodb session AffectedRows
2275 // added FileFinder helpers to unify local filenames and DATA_PATH names
2276 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
2278 // Revision 1.58 2004/05/18 13:59:14 rurban
2279 // rename simpleQuery to genericQuery
2281 // Revision 1.57 2004/05/16 22:07:35 rurban
2282 // check more config-default and predefined constants
2283 // various PagePerm fixes:
2284 // fix default PagePerms, esp. edit and view for Bogo and Password users
2285 // implemented Creator and Owner
2286 // BOGOUSERS renamed to BOGOUSER
2287 // fixed syntax errors in signin.tmpl
2289 // Revision 1.56 2004/05/15 22:54:49 rurban
2290 // fixed important WikiDB bug with DEBUG > 0: wrong assertion
2291 // improved SetAcl (works) and PagePerms, some WikiGroup helpers.
2293 // Revision 1.55 2004/05/12 19:27:47 rurban
2294 // revert wrong inline optimization.
2296 // Revision 1.54 2004/05/12 10:49:55 rurban
2297 // require_once fix for those libs which are loaded before FileFinder and
2298 // its automatic include_path fix, and where require_once doesn't grok
2299 // dirname(__FILE__) != './lib'
2300 // upgrade fix with PearDB
2301 // navbar.tmpl: remove spaces for IE button alignment
2303 // Revision 1.53 2004/05/08 14:06:12 rurban
2304 // new support for inlined image attributes: [image.jpg size=50x30 align=right]
2305 // minor stability and portability fixes
2307 // Revision 1.52 2004/05/06 19:26:16 rurban
2308 // improve stability, trying to find the InlineParser endless loop on sf.net
2310 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
2312 // Revision 1.51 2004/05/06 17:30:37 rurban
2313 // CategoryGroup: oops, dos2unix eol
2314 // improved phpwiki_version:
2315 // pre -= .0001 (1.3.10pre: 1030.099)
2316 // -p1 += .001 (1.3.9-p1: 1030.091)
2317 // improved InstallTable for mysql and generic SQL versions and all newer tables so far.
2318 // abstracted more ADODB/PearDB methods for action=upgrade stuff:
2319 // backend->backendType(), backend->database(),
2320 // backend->listOfFields(),
2321 // backend->listOfTables(),
2323 // Revision 1.50 2004/05/04 22:34:25 rurban
2326 // Revision 1.49 2004/05/03 11:16:40 rurban
2327 // fixed sendPageChangeNotification
2328 // subject rewording
2330 // Revision 1.48 2004/04/29 23:03:54 rurban
2331 // fixed sf.net bug #940996
2333 // Revision 1.47 2004/04/29 19:39:44 rurban
2334 // special support for formatted plugins (one-liners)
2335 // like <small><plugin BlaBla ></small>
2336 // iter->asArray() helper for PopularNearby
2337 // db_session for older php's (no &func() allowed)
2339 // Revision 1.46 2004/04/26 20:44:34 rurban
2340 // locking table specific for better databases
2342 // Revision 1.45 2004/04/20 00:06:03 rurban
2343 // themable paging support
2345 // Revision 1.44 2004/04/19 18:27:45 rurban
2346 // Prevent from some PHP5 warnings (ref args, no :: object init)
2347 // php5 runs now through, just one wrong XmlElement object init missing
2348 // Removed unneccesary UpgradeUser lines
2349 // Changed WikiLink to omit version if current (RecentChanges)
2351 // Revision 1.43 2004/04/18 01:34:20 rurban
2352 // protect most_popular from sortby=mtime
2354 // Revision 1.42 2004/04/18 01:11:51 rurban
2355 // more numeric pagename fixes.
2356 // fixed action=upload with merge conflict warnings.
2357 // charset changed from constant to global (dynamic utf-8 switching)
2363 // c-basic-offset: 4
2364 // c-hanging-comment-ender-p: nil
2365 // indent-tabs-mode: nil