2 rcs_id('$Id: WikiDB.php,v 1.100 2004-11-10 15:29:20 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($pagename);
240 list($emails, $userids) = $page->getPageChangeEmails($notify);
241 if (!empty($emails)) {
242 $editedby = sprintf(_("Edited 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 trigger_error("no SQL database", E_USER_ERROR);
563 // SQL iter: for simple select or create/update queries
564 // returns the generic iterator object (count,next)
565 function genericSqlIter($sql, $field_list = NULL) {
566 trigger_error("no SQL database", E_USER_ERROR);
570 // see upstream methods:
571 // ADODB adds surrounding quotes, SQL not yet!
572 function quote ($s) {
578 if (!$request->_dbi) return false;
582 function getParam($param) {
584 if (isset($DBParams[$param])) return $DBParams[$param];
585 elseif ($param == 'prefix') return '';
589 function getAuthParam($param) {
590 global $DBAuthParams;
591 if (isset($DBAuthParams[$param])) return $DBAuthParams[$param];
592 elseif ($param == 'USER_AUTH_ORDER') return $GLOBALS['USER_AUTH_ORDER'];
593 elseif ($param == 'USER_AUTH_POLICY') return $GLOBALS['USER_AUTH_POLICY'];
600 * An abstract base class which representing a wiki-page within a
603 * A WikiDB_Page contains a number (at least one) of
604 * WikiDB_PageRevisions.
608 function WikiDB_Page(&$wikidb, $pagename) {
609 $this->_wikidb = &$wikidb;
610 $this->_pagename = $pagename;
612 if (!(is_string($pagename) and $pagename != '')) {
613 if (function_exists("xdebug_get_function_stack")) {
614 echo "xdebug_get_function_stack(): "; var_dump(xdebug_get_function_stack());
617 trigger_error("empty pagename", E_USER_WARNING);
621 assert(is_string($pagename) and $pagename != '');
625 * Get the name of the wiki page.
629 * @return string The page name.
632 return $this->_pagename;
635 // To reduce the memory footprint for larger sets of pagelists,
636 // we don't cache the content (only true or false) and
637 // we purge the pagedata (_cached_html) also
639 if (isset($this->_wikidb->_cache->_id_cache[$this->_pagename])) return true;
640 $current = $this->getCurrentRevision(false);
641 return ! $current->hasDefaultContents();
645 * Delete an old revision of a WikiDB_Page.
647 * Deletes the specified revision of the page.
648 * It is a fatal error to attempt to delete the current revision.
652 * @param integer $version Which revision to delete. (You can also
653 * use a WikiDB_PageRevision object here.)
655 function deleteRevision($version) {
656 $backend = &$this->_wikidb->_backend;
657 $cache = &$this->_wikidb->_cache;
658 $pagename = &$this->_pagename;
660 $version = $this->_coerce_to_version($version);
664 $backend->lock(array('page','version'));
665 $latestversion = $cache->get_latest_version($pagename);
666 if ($latestversion && $version == $latestversion) {
667 $backend->unlock(array('page','version'));
668 trigger_error(sprintf("Attempt to delete most recent revision of '%s'",
669 $pagename), E_USER_ERROR);
673 $cache->delete_versiondata($pagename, $version);
674 $backend->unlock(array('page','version'));
678 * Delete a revision, or possibly merge it with a previous
682 * Suppose an author make a (major) edit to a page. Shortly
683 * after that the same author makes a minor edit (e.g. to fix
684 * spelling mistakes he just made.)
686 * Now some time later, where cleaning out old saved revisions,
687 * and would like to delete his minor revision (since there's
688 * really no point in keeping minor revisions around for a long
691 * Note that the text after the minor revision probably represents
692 * what the author intended to write better than the text after
693 * the preceding major edit.
695 * So what we really want to do is merge the minor edit with the
698 * We will only do this when:
700 * <li>The revision being deleted is a minor one, and
701 * <li>It has the same author as the immediately preceding revision.
704 function mergeRevision($version) {
705 $backend = &$this->_wikidb->_backend;
706 $cache = &$this->_wikidb->_cache;
707 $pagename = &$this->_pagename;
709 $version = $this->_coerce_to_version($version);
713 $backend->lock(array('version'));
714 $latestversion = $cache->get_latest_version($pagename);
715 if ($latestversion && $version == $latestversion) {
716 $backend->unlock(array('version'));
717 trigger_error(sprintf("Attempt to merge most recent revision of '%s'",
718 $pagename), E_USER_ERROR);
722 $versiondata = $cache->get_versiondata($pagename, $version, true);
724 // Not there? ... we're done!
725 $backend->unlock(array('version'));
729 if ($versiondata['is_minor_edit']) {
730 $previous = $backend->get_previous_version($pagename, $version);
732 $prevdata = $cache->get_versiondata($pagename, $previous);
733 if ($prevdata['author_id'] == $versiondata['author_id']) {
734 // This is a minor revision, previous version is
735 // by the same author. We will merge the
737 $cache->update_versiondata($pagename, $previous,
738 array('%content' => $versiondata['%content'],
739 '_supplanted' => $versiondata['_supplanted']));
744 $cache->delete_versiondata($pagename, $version);
745 $backend->unlock(array('version'));
750 * Create a new revision of a {@link WikiDB_Page}.
754 * @param int $version Version number for new revision.
755 * To ensure proper serialization of edits, $version must be
756 * exactly one higher than the current latest version.
757 * (You can defeat this check by setting $version to
758 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
760 * @param string $content Contents of new revision.
762 * @param hash $metadata Metadata for new revision.
763 * All values in the hash should be scalars (strings or integers).
765 * @param array $links List of pagenames which this page links to.
767 * @return WikiDB_PageRevision Returns the new WikiDB_PageRevision object. If
768 * $version was incorrect, returns false
770 function createRevision($version, &$content, $metadata, $links) {
771 $backend = &$this->_wikidb->_backend;
772 $cache = &$this->_wikidb->_cache;
773 $pagename = &$this->_pagename;
775 $backend->lock(array('version','page','recent','link','nonempty'));
777 $latestversion = $backend->get_latest_version($pagename);
778 $newversion = $latestversion + 1;
779 assert($newversion >= 1);
781 if ($version != WIKIDB_FORCE_CREATE && $version != $newversion) {
782 $backend->unlock(array('version','page','recent','link','nonempty'));
788 foreach ($data as $key => $val) {
789 if (empty($val) || $key[0] == '_' || $key[0] == '%')
793 assert(!empty($data['author']));
794 if (empty($data['author_id']))
795 @$data['author_id'] = $data['author'];
797 if (empty($data['mtime']))
798 $data['mtime'] = time();
800 if ($latestversion) {
801 // Ensure mtimes are monotonic.
802 $pdata = $cache->get_versiondata($pagename, $latestversion);
803 if ($data['mtime'] < $pdata['mtime']) {
804 trigger_error(sprintf(_("%s: Date of new revision is %s"),
805 $pagename,"'non-monotonic'"),
807 $data['orig_mtime'] = $data['mtime'];
808 $data['mtime'] = $pdata['mtime'];
811 // FIXME: use (possibly user specified) 'mtime' time or
813 $cache->update_versiondata($pagename, $latestversion,
814 array('_supplanted' => $data['mtime']));
817 $data['%content'] = &$content;
819 $cache->set_versiondata($pagename, $newversion, $data);
821 //$cache->update_pagedata($pagename, array(':latestversion' => $newversion,
822 //':deleted' => empty($content)));
824 $backend->set_links($pagename, $links);
826 $backend->unlock(array('version','page','recent','link','nonempty'));
828 return new WikiDB_PageRevision($this->_wikidb, $pagename, $newversion,
832 /** A higher-level interface to createRevision.
834 * This takes care of computing the links, and storing
835 * a cached version of the transformed wiki-text.
837 * @param string $wikitext The page content.
839 * @param int $version Version number for new revision.
840 * To ensure proper serialization of edits, $version must be
841 * exactly one higher than the current latest version.
842 * (You can defeat this check by setting $version to
843 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
845 * @param hash $meta Meta-data for new revision.
847 function save($wikitext, $version, $meta) {
848 $formatted = new TransformedText($this, $wikitext, $meta);
849 $type = $formatted->getType();
850 $meta['pagetype'] = $type->getName();
851 $links = $formatted->getWikiPageLinks();
853 $backend = &$this->_wikidb->_backend;
854 $newrevision = $this->createRevision($version, $wikitext, $meta, $links);
855 if ($newrevision and !WIKIDB_NOCACHE_MARKUP)
856 $this->set('_cached_html', $formatted->pack());
858 // FIXME: probably should have some global state information
859 // in the backend to control when to optimize.
861 // We're doing this here rather than in createRevision because
862 // postgres can't optimize while locked.
863 if (DEBUG or (time() % 50 == 0)) {
864 if ($backend->optimize())
865 trigger_error(_("Optimizing database"), E_USER_NOTICE);
868 /* Generate notification emails? */
869 if (isa($newrevision, 'WikiDB_PageRevision')) {
870 // Save didn't fail because of concurrent updates.
871 $notify = $this->_wikidb->get('notify');
872 if (!empty($notify) and is_array($notify)) {
873 list($emails, $userids) = $this->getPageChangeEmails($notify);
874 if (!empty($emails)) {
875 $this->sendPageChangeNotification($wikitext, $version, $meta, $emails, $userids);
880 $newrevision->_transformedContent = $formatted;
884 function getPageChangeEmails($notify) {
885 $emails = array(); $userids = array();
886 foreach ($notify as $page => $users) {
887 if (glob_match($page, $this->_pagename)) {
888 foreach ($users as $userid => $user) {
889 if (!empty($user['verified']) and !empty($user['email'])) {
890 $emails[] = $user['email'];
891 $userids[] = $userid;
892 } elseif (!empty($user['email'])) {
894 // do a dynamic emailVerified check update
895 $u = $request->getUser();
896 if ($u->UserName() == $userid) {
897 if ($request->_prefs->get('emailVerified')) {
898 $emails[] = $user['email'];
899 $userids[] = $userid;
900 $notify[$page][$userid]['verified'] = 1;
901 $request->_dbi->set('notify', $notify);
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();
913 if ($prefs->get('emailVerified')) {
914 $emails[] = $user['email'];
915 $userids[] = $userid;
916 $notify[$page][$userid]['verified'] = 1;
917 $request->_dbi->set('notify', $notify);
920 // ignore verification
923 if (!in_array($user['email'],$emails))
924 $emails[] = $user['email'];
931 $emails = array_unique($emails);
932 $userids = array_unique($userids);
933 return array($emails,$userids);
937 * Send udiff for a changed page to multiple users.
938 * See rename and remove methods also
940 function sendPageChangeNotification(&$wikitext, $version, $meta, $emails, $userids) {
942 if (@is_array($request->_deferredPageChangeNotification)) {
943 // collapse multiple changes (loaddir) into one email
944 $request->_deferredPageChangeNotification[] = array($this->_pagename, $emails, $userids);
947 $backend = &$this->_wikidb->_backend;
948 //$backend = &$request->_dbi->_backend;
949 $subject = _("Page change").' '.urlencode($this->_pagename);
950 $previous = $backend->get_previous_version($this->_pagename, $version);
951 if (!isset($meta['mtime'])) $meta['mtime'] = time();
953 $difflink = WikiURL($this->_pagename, array('action'=>'diff'), true);
954 $cache = &$this->_wikidb->_cache;
955 //$cache = &$request->_dbi->_cache;
956 $this_content = explode("\n", $wikitext);
957 $prevdata = $cache->get_versiondata($this->_pagename, $previous, true);
958 if (empty($prevdata['%content']))
959 $prevdata = $backend->get_versiondata($this->_pagename, $previous, true);
960 $other_content = explode("\n", $prevdata['%content']);
962 include_once("lib/difflib.php");
963 $diff2 = new Diff($other_content, $this_content);
964 //$context_lines = max(4, count($other_content) + 1,
965 // count($this_content) + 1);
966 $fmt = new UnifiedDiffFormatter(/*$context_lines*/);
967 $content = $this->_pagename . " " . $previous . " " . Iso8601DateTime($prevdata['mtime']) . "\n";
968 $content .= $this->_pagename . " " . $version . " " . Iso8601DateTime($meta['mtime']) . "\n";
969 $content .= $fmt->format($diff2);
972 $difflink = WikiURL($this->_pagename,array(),true);
973 $content = $this->_pagename . " " . $version . " " . Iso8601DateTime($meta['mtime']) . "\n";
974 $content .= _("New Page");
976 $editedby = sprintf(_("Edited by: %s"), $meta['author']);
977 $emails = join(',',$emails);
978 if (mail($emails,"[".WIKI_NAME."] ".$subject,
983 trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
984 $this->_pagename, join(',',$userids)), E_USER_NOTICE);
986 trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
987 $this->_pagename, join(',',$userids)), E_USER_WARNING);
990 /** support mass rename / remove (not yet tested)
992 function sendPageRenameNotification($to, &$meta, $emails, $userids) {
994 if (@is_array($request->_deferredPageRenameNotification)) {
995 $request->_deferredPageRenameNotification[] = array($this->_pagename, $to, $meta, $emails, $userids);
997 $from = $this->_pagename;
998 $editedby = sprintf(_("Edited by: %s"), $meta['author']) . ' ' . $meta['author_id'];
999 $emails = join(',',$emails);
1000 $subject = sprintf(_("Page rename %s to %s"), urlencode($from), urlencode($to));
1001 $link = WikiURL($to, true);
1002 if (mail($emails,"[".WIKI_NAME."] ".$subject,
1006 "Renamed $from to $to"))
1007 trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
1008 $from, join(',',$userids)), E_USER_NOTICE);
1010 trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
1011 $from, join(',',$userids)), E_USER_WARNING);
1016 * Get the most recent revision of a page.
1020 * @return WikiDB_PageRevision The current WikiDB_PageRevision object.
1022 function getCurrentRevision($need_content = true) {
1023 $backend = &$this->_wikidb->_backend;
1024 $cache = &$this->_wikidb->_cache;
1025 $pagename = &$this->_pagename;
1027 // Prevent deadlock in case of memory exhausted errors
1028 // Pure selection doesn't really need locking here.
1029 // sf.net bug#927395
1030 // I know it would be better, but with lots of pages this deadlock is more
1031 // severe than occasionally get not the latest revision.
1033 $version = $cache->get_latest_version($pagename);
1034 // getRevision gets the content also!
1035 $revision = $this->getRevision($version, $need_content);
1036 //$backend->unlock();
1042 * Get a specific revision of a WikiDB_Page.
1046 * @param integer $version Which revision to get.
1048 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or
1049 * false if the requested revision does not exist in the {@link WikiDB}.
1050 * Note that version zero of any page always exists.
1052 function getRevision($version, $need_content=true) {
1053 $cache = &$this->_wikidb->_cache;
1054 $pagename = &$this->_pagename;
1056 if (! $version ) // 0 or false
1057 return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
1059 assert($version > 0);
1060 $vdata = $cache->get_versiondata($pagename, $version, $need_content);
1064 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1069 * Get previous page revision.
1071 * This method find the most recent revision before a specified
1076 * @param integer $version Find most recent revision before this version.
1077 * You can also use a WikiDB_PageRevision object to specify the $version.
1079 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or false if the
1080 * requested revision does not exist in the {@link WikiDB}. Note that
1081 * unless $version is greater than zero, a revision (perhaps version zero,
1082 * the default revision) will always be found.
1084 function getRevisionBefore($version, $need_content=true) {
1085 $backend = &$this->_wikidb->_backend;
1086 $pagename = &$this->_pagename;
1088 $version = $this->_coerce_to_version($version);
1093 $previous = $backend->get_previous_version($pagename, $version);
1094 $revision = $this->getRevision($previous, $need_content);
1095 //$backend->unlock();
1101 * Get all revisions of the WikiDB_Page.
1103 * This does not include the version zero (default) revision in the
1104 * returned revision set.
1106 * @return WikiDB_PageRevisionIterator A
1107 * WikiDB_PageRevisionIterator containing all revisions of this
1108 * WikiDB_Page in reverse order by version number.
1110 function getAllRevisions() {
1111 $backend = &$this->_wikidb->_backend;
1112 $revs = $backend->get_all_revisions($this->_pagename);
1113 return new WikiDB_PageRevisionIterator($this->_wikidb, $revs);
1117 * Find pages which link to or are linked from a page.
1121 * @param boolean $reversed Which links to find: true for backlinks (default).
1123 * @return WikiDB_PageIterator A WikiDB_PageIterator containing
1124 * all matching pages.
1126 function getLinks($reversed = true, $include_empty=false) {
1127 $backend = &$this->_wikidb->_backend;
1128 $result = $backend->get_links($this->_pagename, $reversed, $include_empty=false);
1129 //if (empty($this->_iwpcache) and !$include_empty)
1130 // $this->_iwpcache = $result->asArray();
1131 return new WikiDB_PageIterator($this->_wikidb, $result, array('include_empty' => $include_empty));
1135 * All Links from other pages to this page.
1137 function getBackLinks($include_empty=false) {
1138 return $this->getLinks(true, $include_empty=false);
1141 * Forward Links: All Links from this page to other pages.
1143 function getPageLinks($include_empty=false) {
1144 return $this->getLinks(false, $include_empty=false);
1148 * Access WikiDB_Page meta-data.
1152 * @param string $key Which meta data to get.
1153 * Some reserved meta-data keys are:
1155 * <dt>'locked'<dd> Is page locked?
1156 * <dt>'hits' <dd> Page hit counter.
1157 * <dt>'pref' <dd> Users preferences, stored in homepages.
1158 * <dt>'owner' <dd> Default: first author_id. We might add a group with a dot here:
1159 * E.g. "owner.users"
1160 * <dt>'perm' <dd> Permission flag to authorize read/write/execution of
1161 * page-headers and content.
1162 * <dt>'score' <dd> Page score (not yet implement, do we need?)
1165 * @return scalar The requested value, or false if the requested data
1168 function get($key) {
1169 $cache = &$this->_wikidb->_cache;
1170 if (!$key || $key[0] == '%')
1172 $data = $cache->get_pagedata($this->_pagename);
1173 return isset($data[$key]) ? $data[$key] : false;
1177 * Get all the page meta-data as a hash.
1179 * @return hash The page meta-data.
1181 function getMetaData() {
1182 $cache = &$this->_wikidb->_cache;
1183 $data = $cache->get_pagedata($this->_pagename);
1185 foreach ($data as $key => $val) {
1186 if (/*!empty($val) &&*/ $key[0] != '%')
1193 * Set page meta-data.
1198 * @param string $key Meta-data key to set.
1199 * @param string $newval New value.
1201 function set($key, $newval) {
1202 $cache = &$this->_wikidb->_cache;
1203 $pagename = &$this->_pagename;
1205 assert($key && $key[0] != '%');
1207 $data = $cache->get_pagedata($pagename);
1209 if (!empty($newval)) {
1210 if (!empty($data[$key]) && $data[$key] == $newval)
1211 return; // values identical, skip update.
1214 if (empty($data[$key]))
1215 return; // values identical, skip update.
1218 $cache->update_pagedata($pagename, array($key => $newval));
1222 * Increase page hit count.
1224 * FIXME: IS this needed? Probably not.
1226 * This is a convenience function.
1227 * <pre> $page->increaseHitCount(); </pre>
1228 * is functionally identical to
1229 * <pre> $page->set('hits',$page->get('hits')+1); </pre>
1231 * Note that this method may be implemented in more efficient ways
1232 * in certain backends.
1236 function increaseHitCount() {
1237 if (method_exists($this->_wikidb->_backend, 'increaseHitCount'))
1238 $this->_backend->increaseHitCount();
1240 @$newhits = $this->get('hits') + 1;
1241 $this->set('hits', $newhits);
1246 * Return a string representation of the WikiDB_Page
1248 * This is really only for debugging.
1252 * @return string Printable representation of the WikiDB_Page.
1254 function asString () {
1256 printf("[%s:%s\n", get_class($this), $this->getName());
1257 print_r($this->getMetaData());
1259 $strval = ob_get_contents();
1267 * @param integer_or_object $version_or_pagerevision
1268 * Takes either the version number (and int) or a WikiDB_PageRevision
1270 * @return integer The version number.
1272 function _coerce_to_version($version_or_pagerevision) {
1273 if (method_exists($version_or_pagerevision, "getContent"))
1274 $version = $version_or_pagerevision->getVersion();
1276 $version = (int) $version_or_pagerevision;
1278 assert($version >= 0);
1282 function isUserPage ($include_empty = true) {
1283 if (!$include_empty and !$this->exists()) return false;
1284 return $this->get('pref') ? true : false;
1287 // May be empty. Either the stored owner (/Chown), or the first authorized author
1288 function getOwner() {
1289 if ($owner = $this->get('owner'))
1290 return ($owner == "The PhpWiki programming team") ? ADMIN_USER : $owner;
1291 // check all revisions forwards for the first author_id
1292 $backend = &$this->_wikidb->_backend;
1293 $pagename = &$this->_pagename;
1294 $latestversion = $backend->get_latest_version($pagename);
1295 for ($v=1; $v <= $latestversion; $v++) {
1296 $rev = $this->getRevision($v,false);
1297 if ($rev and $owner = $rev->get('author_id')) {
1298 return ($owner == "The PhpWiki programming team") ? ADMIN_USER : $owner;
1304 // The authenticated author of the first revision or empty if not authenticated then.
1305 function getCreator() {
1306 if ($current = $this->getRevision(1,false)) return $current->get('author_id');
1310 // The authenticated author of the current revision.
1311 function getAuthor() {
1312 if ($current = $this->getCurrentRevision(false)) return $current->get('author_id');
1319 * This class represents a specific revision of a WikiDB_Page within
1322 * A WikiDB_PageRevision has read-only semantics. You may only create
1323 * new revisions (and delete old ones) --- you cannot modify existing
1326 class WikiDB_PageRevision
1328 //var $_transformedContent = false; // set by WikiDB_Page::save()
1330 function WikiDB_PageRevision(&$wikidb, $pagename, $version, $versiondata = false) {
1331 $this->_wikidb = &$wikidb;
1332 $this->_pagename = $pagename;
1333 $this->_version = $version;
1334 $this->_data = $versiondata ? $versiondata : array();
1335 $this->_transformedContent = false; // set by WikiDB_Page::save()
1339 * Get the WikiDB_Page which this revision belongs to.
1343 * @return WikiDB_Page The WikiDB_Page which this revision belongs to.
1345 function getPage() {
1346 return new WikiDB_Page($this->_wikidb, $this->_pagename);
1350 * Get the version number of this revision.
1354 * @return integer The version number of this revision.
1356 function getVersion() {
1357 return $this->_version;
1361 * Determine whether this revision has defaulted content.
1363 * The default revision (version 0) of each page, as well as any
1364 * pages which are created with empty content have their content
1365 * defaulted to something like:
1367 * Describe [ThisPage] here.
1372 * @return boolean Returns true if the page has default content.
1374 function hasDefaultContents() {
1375 $data = &$this->_data;
1376 return empty($data['%content']); // FIXME: what if it's the number 0? <>'' or === false
1380 * Get the content as an array of lines.
1384 * @return array An array of lines.
1385 * The lines should contain no trailing white space.
1387 function getContent() {
1388 return explode("\n", $this->getPackedContent());
1392 * Get the pagename of the revision.
1396 * @return string pagename.
1398 function getPageName() {
1399 return $this->_pagename;
1403 * Determine whether revision is the latest.
1407 * @return boolean True iff the revision is the latest (most recent) one.
1409 function isCurrent() {
1410 if (!isset($this->_iscurrent)) {
1411 $page = $this->getPage();
1412 $current = $page->getCurrentRevision(false);
1413 $this->_iscurrent = $this->getVersion() == $current->getVersion();
1415 return $this->_iscurrent;
1419 * Get the transformed content of a page.
1421 * @param string $pagetype Override the page-type of the revision.
1423 * @return object An XmlContent-like object containing the page transformed
1426 function getTransformedContent($pagetype_override=false) {
1427 $backend = &$this->_wikidb->_backend;
1429 if ($pagetype_override) {
1430 // Figure out the normal page-type for this page.
1431 $type = PageType::GetPageType($this->get('pagetype'));
1432 if ($type->getName() == $pagetype_override)
1433 $pagetype_override = false; // Not really an override...
1436 if ($pagetype_override) {
1437 // Overriden page type, don't cache (or check cache).
1438 return new TransformedText($this->getPage(),
1439 $this->getPackedContent(),
1440 $this->getMetaData(),
1441 $pagetype_override);
1444 $possibly_cache_results = true;
1446 if (!USECACHE or WIKIDB_NOCACHE_MARKUP) {
1447 if (WIKIDB_NOCACHE_MARKUP == 'purge') {
1448 // flush cache for this page.
1449 $page = $this->getPage();
1450 $page->set('_cached_html', false);
1452 $possibly_cache_results = false;
1454 elseif (!$this->_transformedContent) {
1456 if ($this->isCurrent()) {
1457 $page = $this->getPage();
1458 $this->_transformedContent = TransformedText::unpack($page->get('_cached_html'));
1461 $possibly_cache_results = false;
1463 //$backend->unlock();
1466 if (!$this->_transformedContent) {
1467 $this->_transformedContent
1468 = new TransformedText($this->getPage(),
1469 $this->getPackedContent(),
1470 $this->getMetaData());
1472 if ($possibly_cache_results) {
1473 // If we're still the current version, cache the transfomed page.
1475 if ($this->isCurrent()) {
1476 $page->set('_cached_html', $this->_transformedContent->pack());
1478 //$backend->unlock();
1482 return $this->_transformedContent;
1486 * Get the content as a string.
1490 * @return string The page content.
1491 * Lines are separated by new-lines.
1493 function getPackedContent() {
1494 $data = &$this->_data;
1497 if (empty($data['%content'])) {
1498 include_once('lib/InlineParser.php');
1500 // A feature similar to taglines at http://www.wlug.org.nz/
1501 // Lib from http://www.aasted.org/quote/
1502 if (defined('FORTUNE_DIR')
1503 and is_dir(FORTUNE_DIR)
1504 and in_array($GLOBALS['request']->getArg('action'),
1505 array('create','edit')))
1507 include_once("lib/fortune.php");
1508 $fortune = new Fortune();
1509 $quote = str_replace("\n<br>","\n", $fortune->quoteFromDir(FORTUNE_DIR));
1510 return sprintf("<verbatim>\n%s</verbatim>\n\n"._("Describe %s here."),
1511 $quote, "[" . WikiEscape($this->_pagename) . "]");
1513 // Replace empty content with default value.
1514 return sprintf(_("Describe %s here."),
1515 "[" . WikiEscape($this->_pagename) . "]");
1518 // There is (non-default) content.
1519 assert($this->_version > 0);
1521 if (!is_string($data['%content'])) {
1522 // Content was not provided to us at init time.
1523 // (This is allowed because for some backends, fetching
1524 // the content may be expensive, and often is not wanted
1527 // In any case, now we need to get it.
1528 $data['%content'] = $this->_get_content();
1529 assert(is_string($data['%content']));
1532 return $data['%content'];
1535 function _get_content() {
1536 $cache = &$this->_wikidb->_cache;
1537 $pagename = $this->_pagename;
1538 $version = $this->_version;
1540 assert($version > 0);
1542 $newdata = $cache->get_versiondata($pagename, $version, true);
1544 assert(is_string($newdata['%content']));
1545 return $newdata['%content'];
1548 // else revision has been deleted... What to do?
1549 return __sprintf("Oops! Revision %s of %s seems to have been deleted!",
1550 $version, $pagename);
1555 * Get meta-data for this revision.
1560 * @param string $key Which meta-data to access.
1562 * Some reserved revision meta-data keys are:
1564 * <dt> 'mtime' <dd> Time this revision was created (seconds since midnight Jan 1, 1970.)
1565 * The 'mtime' meta-value is normally set automatically by the database
1566 * backend, but it may be specified explicitly when creating a new revision.
1568 * <dd> To ensure consistency of RecentChanges, the mtimes of the versions
1569 * of a page must be monotonically increasing. If an attempt is
1570 * made to create a new revision with an mtime less than that of
1571 * the preceeding revision, the new revisions timestamp is force
1572 * to be equal to that of the preceeding revision. In that case,
1573 * the originally requested mtime is preserved in 'orig_mtime'.
1574 * <dt> '_supplanted' <dd> Time this revision ceased to be the most recent.
1575 * This meta-value is <em>always</em> automatically maintained by the database
1576 * backend. (It is set from the 'mtime' meta-value of the superceding
1577 * revision.) '_supplanted' has a value of 'false' for the current revision.
1579 * FIXME: this could be refactored:
1581 * <dd> Author of the page (as he should be reported in, e.g. RecentChanges.)
1583 * <dd> Authenticated author of a page. This is used to identify
1584 * the distinctness of authors when cleaning old revisions from
1586 * <dt> 'is_minor_edit' <dd> Set if change was marked as a minor revision by the author.
1587 * <dt> 'summary' <dd> Short change summary entered by page author.
1590 * Meta-data keys must be valid C identifers (they have to start with a letter
1591 * or underscore, and can contain only alphanumerics and underscores.)
1593 * @return string The requested value, or false if the requested value
1596 function get($key) {
1597 if (!$key || $key[0] == '%')
1599 $data = &$this->_data;
1600 return isset($data[$key]) ? $data[$key] : false;
1604 * Get all the revision page meta-data as a hash.
1606 * @return hash The revision meta-data.
1608 function getMetaData() {
1610 foreach ($this->_data as $key => $val) {
1611 if (!empty($val) && $key[0] != '%')
1619 * Return a string representation of the revision.
1621 * This is really only for debugging.
1625 * @return string Printable representation of the WikiDB_Page.
1627 function asString () {
1629 printf("[%s:%d\n", get_class($this), $this->get('version'));
1630 print_r($this->_data);
1631 echo $this->getPackedContent() . "\n]\n";
1632 $strval = ob_get_contents();
1640 * Class representing a sequence of WikiDB_Pages.
1641 * TODO: Enhance to php5 iterators
1643 class WikiDB_PageIterator
1645 function WikiDB_PageIterator(&$wikidb, &$iter, $options=false) {
1646 $this->_iter = $iter; // a WikiDB_backend_iterator
1647 $this->_wikidb = &$wikidb;
1648 $this->_options = $options;
1652 return $this->_iter->count();
1656 * Get next WikiDB_Page in sequence.
1660 * @return WikiDB_Page The next WikiDB_Page in the sequence.
1663 if ( ! ($next = $this->_iter->next()) )
1666 $pagename = &$next['pagename'];
1668 trigger_error('empty pagename in WikiDB_PageIterator::next()', E_USER_WARNING);
1672 // there's always hits, but we cache only if more
1673 // (well not with file, cvs and dba)
1674 if (isset($next['pagedata']) and count($next['pagedata']) > 1) {
1675 $this->_wikidb->_cache->cache_data($next);
1676 // cache existing page id's since we iterate over all links in GleanDescription
1677 // and need them later for LinkExistingWord
1678 } elseif ($this->_options and array_key_exists('include_empty', $this->_options)
1679 and !$this->_options['include_empty'] and isset($next['id'])) {
1680 $this->_wikidb->_cache->_id_cache[$next['pagename']] = $next['id'];
1682 return new WikiDB_Page($this->_wikidb, $pagename);
1686 * Release resources held by this iterator.
1688 * The iterator may not be used after free() is called.
1690 * There is no need to call free(), if next() has returned false.
1691 * (I.e. if you iterate through all the pages in the sequence,
1692 * you do not need to call free() --- you only need to call it
1693 * if you stop before the end of the iterator is reached.)
1698 $this->_iter->free();
1701 function asArray() {
1703 while ($page = $this->next())
1713 * A class which represents a sequence of WikiDB_PageRevisions.
1714 * TODO: Enhance to php5 iterators
1716 class WikiDB_PageRevisionIterator
1718 function WikiDB_PageRevisionIterator(&$wikidb, &$revisions, $options=false) {
1719 $this->_revisions = $revisions;
1720 $this->_wikidb = &$wikidb;
1721 $this->_options = $options;
1725 return $this->_revisions->count();
1729 * Get next WikiDB_PageRevision in sequence.
1733 * @return WikiDB_PageRevision
1734 * The next WikiDB_PageRevision in the sequence.
1737 if ( ! ($next = $this->_revisions->next()) )
1740 $this->_wikidb->_cache->cache_data($next);
1742 $pagename = $next['pagename'];
1743 $version = $next['version'];
1744 $versiondata = $next['versiondata'];
1746 if (!(is_string($pagename) and $pagename != '')) {
1747 trigger_error("empty pagename",E_USER_WARNING);
1750 } else assert(is_string($pagename) and $pagename != '');
1752 if (!is_array($versiondata)) {
1753 trigger_error("empty versiondata",E_USER_WARNING);
1756 } else assert(is_array($versiondata));
1758 if (!($version > 0)) {
1759 trigger_error("invalid version",E_USER_WARNING);
1762 } else assert($version > 0);
1764 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1769 * Release resources held by this iterator.
1771 * The iterator may not be used after free() is called.
1773 * There is no need to call free(), if next() has returned false.
1774 * (I.e. if you iterate through all the revisions in the sequence,
1775 * you do not need to call free() --- you only need to call it
1776 * if you stop before the end of the iterator is reached.)
1781 $this->_revisions->free();
1784 function asArray() {
1786 while ($rev = $this->next())
1795 class WikiDB_Array_PageIterator
1797 function WikiDB_Array_PageIterator(&$pagenames) {
1799 $this->_dbi = $request->getDbh();
1800 $this->_pages = $pagenames;
1801 reset($this->_pages);
1804 $c =& current($this->_pages);
1805 next($this->_pages);
1806 return $c !== false ? $this->_dbi->getPage($c) : false;
1809 return count($this->_pages);
1812 function asArray() {
1813 reset($this->_pages);
1814 return $this->_pages;
1818 class WikiDB_Array_generic_iter
1820 function WikiDB_Array_generic_iter($result) {
1821 // $result may be either an array or a query result
1822 if (is_array($result)) {
1823 $this->_array = $result;
1824 } elseif (is_object($result)) {
1825 $this->_array = $result->asArray();
1827 $this->_array = array();
1829 if (!empty($this->_array))
1830 reset($this->_array);
1833 $c =& current($this->_array);
1834 next($this->_array);
1835 return $c !== false ? $c : false;
1838 return count($this->_array);
1841 function asArray() {
1842 if (!empty($this->_array))
1843 reset($this->_array);
1844 return $this->_array;
1849 * Data cache used by WikiDB.
1851 * FIXME: Maybe rename this to caching_backend (or some such).
1857 // FIXME: beautify versiondata cache. Cache only limited data?
1859 function WikiDB_cache (&$backend) {
1860 $this->_backend = &$backend;
1862 $this->_pagedata_cache = array();
1863 $this->_versiondata_cache = array();
1864 array_push ($this->_versiondata_cache, array());
1865 $this->_glv_cache = array();
1866 $this->_id_cache = array(); // formerly ->_dbi->_iwpcache (nonempty pages => id)
1870 $this->_pagedata_cache = array();
1871 $this->_versiondata_cache = array();
1872 $this->_glv_cache = array();
1873 $this->_id_cache = array();
1876 function get_pagedata($pagename) {
1877 assert(is_string($pagename) && $pagename != '');
1879 $cache = &$this->_pagedata_cache;
1880 if (!isset($cache[$pagename]) || !is_array($cache[$pagename])) {
1881 $cache[$pagename] = $this->_backend->get_pagedata($pagename);
1882 // Never keep a ['%pagedata']['_cached_html'] in cache, other than the current page.
1883 if (isset($cache[$pagename]['_cached_html'])
1884 and $pagename != $GLOBALS['request']->getArg('pagename')) {
1885 unset($cache[$pagename]['_cached_html']);
1887 if (empty($cache[$pagename]))
1888 $cache[$pagename] = array();
1890 return $cache[$pagename];
1892 return $this->_backend->get_pagedata($pagename);
1896 function update_pagedata($pagename, $newdata) {
1897 assert(is_string($pagename) && $pagename != '');
1899 $this->_backend->update_pagedata($pagename, $newdata);
1901 if (USECACHE and is_array($this->_pagedata_cache[$pagename])) {
1902 $cachedata = &$this->_pagedata_cache[$pagename];
1903 foreach($newdata as $key => $val)
1904 $cachedata[$key] = $val;
1908 function invalidate_cache($pagename) {
1909 unset ($this->_pagedata_cache[$pagename]);
1910 unset ($this->_versiondata_cache[$pagename]);
1911 unset ($this->_glv_cache[$pagename]);
1912 unset ($this->_id_cache[$pagename]);
1913 //unset ($this->_backend->_page_data);
1916 function delete_page($pagename) {
1917 $this->_backend->delete_page($pagename);
1918 $this->invalidate_cache($pagename);
1922 function cache_data($data) {
1923 if (isset($data['pagedata']))
1924 $this->_pagedata_cache[$data['pagename']] = $data['pagedata'];
1927 function get_versiondata($pagename, $version, $need_content = false) {
1928 // FIXME: Seriously ugly hackage
1929 if (USECACHE) { //temporary - for debugging
1930 assert(is_string($pagename) && $pagename != '');
1931 // there is a bug here somewhere which results in an assertion failure at line 105
1932 // of ArchiveCleaner.php It goes away if we use the next line.
1933 //$need_content = true;
1934 $nc = $need_content ? '1':'0';
1935 $cache = &$this->_versiondata_cache;
1936 if (!isset($cache[$pagename][$version][$nc])||
1937 !(is_array ($cache[$pagename])) || !(is_array ($cache[$pagename][$version]))) {
1938 $cache[$pagename][$version][$nc] =
1939 $this->_backend->get_versiondata($pagename, $version, $need_content);
1940 // If we have retrieved all data, we may as well set the cache for $need_content = false
1942 $cache[$pagename][$version]['0'] =& $cache[$pagename][$version]['1'];
1945 $vdata = $cache[$pagename][$version][$nc];
1947 $vdata = $this->_backend->get_versiondata($pagename, $version, $need_content);
1950 // Rationale: never keep ['%pagedata']['_cached_html'] in cache.
1951 if ($vdata && !empty($vdata['%pagedata'])) {
1952 $this->_pagedata_cache[$pagename] =& $vdata['%pagedata'];
1953 // only store _cached_html for the requested page
1955 and isset($vdata['%pagedata']['_cached_html'])
1956 and $pagename != $GLOBALS['request']->getArg('pagename'))
1958 unset($this->_pagedata_cache[$pagename]['_cached_html']);
1959 unset($cache[$pagename][$version][$nc]['%pagedata']['_cached_html']);
1961 unset($cache[$pagename][$version][0]['%pagedata']['_cached_html']);
1967 function set_versiondata($pagename, $version, $data) {
1968 $new = $this->_backend->set_versiondata($pagename, $version, $data);
1970 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
1971 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
1972 // Is this necessary?
1973 unset($this->_glv_cache[$pagename]);
1976 function update_versiondata($pagename, $version, $data) {
1977 $new = $this->_backend->update_versiondata($pagename, $version, $data);
1979 // FIXME: never keep ['%pagedata']['_cached_html'] in cache.
1980 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
1982 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
1983 // Is this necessary?
1984 unset($this->_glv_cache[$pagename]);
1987 function delete_versiondata($pagename, $version) {
1988 $new = $this->_backend->delete_versiondata($pagename, $version);
1989 if (isset($this->_versiondata_cache[$pagename][$version]['1']))
1990 unset ($this->_versiondata_cache[$pagename][$version]['1']);
1991 if (isset($this->_versiondata_cache[$pagename][$version]['0']))
1992 unset ($this->_versiondata_cache[$pagename][$version]['0']);
1993 if (isset($this->_glv_cache[$pagename]))
1994 unset ($this->_glv_cache[$pagename]);
1997 function get_latest_version($pagename) {
1999 assert (is_string($pagename) && $pagename != '');
2000 $cache = &$this->_glv_cache;
2001 if (!isset($cache[$pagename])) {
2002 $cache[$pagename] = $this->_backend->get_latest_version($pagename);
2003 if (empty($cache[$pagename]))
2004 $cache[$pagename] = 0;
2006 return $cache[$pagename];
2008 return $this->_backend->get_latest_version($pagename);
2013 function _sql_debuglog($msg, $newline=true, $shutdown=false) {
2017 $stamp = strftime("%y%m%d-%H%M%S");
2018 $fp = fopen("/tmp/sql-$stamp.log", "a");
2019 register_shutdown_function("_sql_debuglog_shutdown_function");
2020 } elseif ($shutdown) {
2024 if ($newline) fputs($fp, "[$i++] $msg");
2025 else fwrite($fp, $msg);
2027 function _sql_debuglog_shutdown_function() {
2028 _sql_debuglog('',false,true);
2031 // $Log: not supported by cvs2svn $
2032 // Revision 1.99 2004/11/09 17:11:05 rurban
2033 // * revert to the wikidb ref passing. there's no memory abuse there.
2034 // * use new wikidb->_cache->_id_cache[] instead of wikidb->_iwpcache, to effectively
2035 // store page ids with getPageLinks (GleanDescription) of all existing pages, which
2036 // are also needed at the rendering for linkExistingWikiWord().
2037 // pass options to pageiterator.
2038 // use this cache also for _get_pageid()
2039 // This saves about 8 SELECT count per page (num all pagelinks).
2040 // * fix passing of all page fields to the pageiterator.
2041 // * fix overlarge session data which got broken with the latest ACCESS_LOG_SQL changes
2043 // Revision 1.98 2004/11/07 18:34:29 rurban
2044 // more logging fixes
2046 // Revision 1.97 2004/11/07 16:02:51 rurban
2047 // new sql access log (for spam prevention), and restructured access log class
2048 // dbh->quote (generic)
2049 // pear_db: mysql specific parts seperated (using replace)
2051 // Revision 1.96 2004/11/05 22:32:15 rurban
2052 // encode the subject to be 7-bit safe
2054 // Revision 1.95 2004/11/05 20:53:35 rurban
2055 // login cleanup: better debug msg on failing login,
2056 // checked password less immediate login (bogo or anon),
2057 // checked olduser pref session error,
2058 // better PersonalPage without password warning on minimal password length=0
2059 // (which is default now)
2061 // Revision 1.94 2004/11/01 10:43:56 rurban
2062 // seperate PassUser methods into seperate dir (memory usage)
2063 // fix WikiUser (old) overlarge data session
2064 // remove wikidb arg from various page class methods, use global ->_dbi instead
2067 // Revision 1.93 2004/10/14 17:17:57 rurban
2068 // remove dbi WikiDB_Page param: use global request object instead. (memory)
2069 // allow most_popular sortby arguments
2071 // Revision 1.92 2004/10/05 17:00:04 rurban
2072 // support paging for simple lists
2073 // fix RatingDb sql backend.
2074 // remove pages from AllPages (this is ListPages then)
2076 // Revision 1.91 2004/10/04 23:41:19 rurban
2077 // delete notify: fix, @unset syntax error
2079 // Revision 1.90 2004/09/28 12:50:22 rurban
2080 // https://sourceforge.net/forum/forum.php?thread_id=1150924&forum_id=18929
2082 // Revision 1.89 2004/09/26 10:54:42 rurban
2083 // silence deferred check
2085 // Revision 1.88 2004/09/25 18:16:40 rurban
2086 // unset more unneeded _cached_html. (Guess this should fix sf.net now)
2088 // Revision 1.87 2004/09/25 16:25:40 rurban
2089 // notify on rename and remove (to be improved)
2091 // Revision 1.86 2004/09/23 18:52:06 rurban
2092 // only fortune at create
2094 // Revision 1.85 2004/09/16 08:00:51 rurban
2095 // just some comments
2097 // Revision 1.84 2004/09/14 10:34:30 rurban
2098 // fix TransformedText call to use refs
2100 // Revision 1.83 2004/09/08 13:38:00 rurban
2101 // improve loadfile stability by using markup=2 as default for undefined markup-style.
2102 // use more refs for huge objects.
2103 // fix debug=static issue in WikiPluginCached
2105 // Revision 1.82 2004/09/06 12:08:49 rurban
2106 // memory_limit on unix workaround
2107 // VisualWiki: default autosize image
2109 // Revision 1.81 2004/09/06 08:28:00 rurban
2110 // rename genericQuery to genericSqlQuery
2112 // Revision 1.80 2004/07/09 13:05:34 rurban
2115 // Revision 1.79 2004/07/09 10:06:49 rurban
2116 // Use backend specific sortby and sortable_columns method, to be able to
2117 // select between native (Db backend) and custom (PageList) sorting.
2118 // Fixed PageList::AddPageList (missed the first)
2119 // Added the author/creator.. name to AllPagesBy...
2120 // display no pages if none matched.
2121 // Improved dba and file sortby().
2122 // Use &$request reference
2124 // Revision 1.78 2004/07/08 21:32:35 rurban
2125 // Prevent from more warnings, minor db and sort optimizations
2127 // Revision 1.77 2004/07/08 19:04:42 rurban
2128 // more unittest fixes (file backend, metadata RatingsDb)
2130 // Revision 1.76 2004/07/08 17:31:43 rurban
2131 // improve numPages for file (fixing AllPagesTest)
2133 // Revision 1.75 2004/07/05 13:56:22 rurban
2134 // sqlite autoincrement fix
2136 // Revision 1.74 2004/07/03 16:51:05 rurban
2137 // optional DBADMIN_USER:DBADMIN_PASSWD for action=upgrade (if no ALTER permission)
2138 // added atomic mysql REPLACE for PearDB as in ADODB
2139 // fixed _lock_tables typo links => link
2140 // fixes unserialize ADODB bug in line 180
2142 // Revision 1.73 2004/06/29 08:52:22 rurban
2143 // Use ...version() $need_content argument in WikiDB also:
2144 // To reduce the memory footprint for larger sets of pagelists,
2145 // we don't cache the content (only true or false) and
2146 // we purge the pagedata (_cached_html) also.
2147 // _cached_html is only cached for the current pagename.
2148 // => Vastly improved page existance check, ACL check, ...
2150 // Now only PagedList info=content or size needs the whole content, esp. if sortable.
2152 // Revision 1.72 2004/06/25 14:15:08 rurban
2153 // reduce memory footprint by caching only requested pagedate content (improving most page iterators)
2155 // Revision 1.71 2004/06/21 16:22:30 rurban
2156 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
2157 // fixed dumping buttons locally (images/buttons/),
2158 // support pages arg for dumphtml,
2159 // optional directory arg for dumpserial + dumphtml,
2160 // fix a AllPages warning,
2161 // show dump warnings/errors on DEBUG,
2162 // don't warn just ignore on wikilens pagelist columns, if not loaded.
2163 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
2165 // Revision 1.70 2004/06/18 14:39:31 rurban
2166 // actually check USECACHE
2168 // Revision 1.69 2004/06/13 15:33:20 rurban
2169 // new support for arguments owner, author, creator in most relevant
2170 // PageList plugins. in WikiAdmin* via preSelectS()
2172 // Revision 1.68 2004/06/08 21:03:20 rurban
2173 // updated RssParser for XmlParser quirks (store parser object params in globals)
2175 // Revision 1.67 2004/06/07 19:12:49 rurban
2176 // fixed rename version=0, bug #966284
2178 // Revision 1.66 2004/06/07 18:57:27 rurban
2179 // fix rename: Change pagename in all linked pages
2181 // Revision 1.65 2004/06/04 20:32:53 rurban
2182 // Several locale related improvements suggested by Pierrick Meignen
2183 // LDAP fix by John Cole
2184 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
2186 // Revision 1.64 2004/06/04 16:50:00 rurban
2187 // add random quotes to empty pages
2189 // Revision 1.63 2004/06/04 11:58:38 rurban
2190 // added USE_TAGLINES
2192 // Revision 1.62 2004/06/03 22:24:41 rurban
2193 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
2195 // Revision 1.61 2004/06/02 17:13:48 rurban
2196 // fix getRevisionBefore assertion
2198 // Revision 1.60 2004/05/28 10:09:58 rurban
2199 // fix bug #962117, incorrect init of auth_dsn
2201 // Revision 1.59 2004/05/27 17:49:05 rurban
2202 // renamed DB_Session to DbSession (in CVS also)
2203 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
2204 // remove leading slash in error message
2205 // added force_unlock parameter to File_Passwd (no return on stale locks)
2206 // fixed adodb session AffectedRows
2207 // added FileFinder helpers to unify local filenames and DATA_PATH names
2208 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
2210 // Revision 1.58 2004/05/18 13:59:14 rurban
2211 // rename simpleQuery to genericQuery
2213 // Revision 1.57 2004/05/16 22:07:35 rurban
2214 // check more config-default and predefined constants
2215 // various PagePerm fixes:
2216 // fix default PagePerms, esp. edit and view for Bogo and Password users
2217 // implemented Creator and Owner
2218 // BOGOUSERS renamed to BOGOUSER
2219 // fixed syntax errors in signin.tmpl
2221 // Revision 1.56 2004/05/15 22:54:49 rurban
2222 // fixed important WikiDB bug with DEBUG > 0: wrong assertion
2223 // improved SetAcl (works) and PagePerms, some WikiGroup helpers.
2225 // Revision 1.55 2004/05/12 19:27:47 rurban
2226 // revert wrong inline optimization.
2228 // Revision 1.54 2004/05/12 10:49:55 rurban
2229 // require_once fix for those libs which are loaded before FileFinder and
2230 // its automatic include_path fix, and where require_once doesn't grok
2231 // dirname(__FILE__) != './lib'
2232 // upgrade fix with PearDB
2233 // navbar.tmpl: remove spaces for IE button alignment
2235 // Revision 1.53 2004/05/08 14:06:12 rurban
2236 // new support for inlined image attributes: [image.jpg size=50x30 align=right]
2237 // minor stability and portability fixes
2239 // Revision 1.52 2004/05/06 19:26:16 rurban
2240 // improve stability, trying to find the InlineParser endless loop on sf.net
2242 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
2244 // Revision 1.51 2004/05/06 17:30:37 rurban
2245 // CategoryGroup: oops, dos2unix eol
2246 // improved phpwiki_version:
2247 // pre -= .0001 (1.3.10pre: 1030.099)
2248 // -p1 += .001 (1.3.9-p1: 1030.091)
2249 // improved InstallTable for mysql and generic SQL versions and all newer tables so far.
2250 // abstracted more ADODB/PearDB methods for action=upgrade stuff:
2251 // backend->backendType(), backend->database(),
2252 // backend->listOfFields(),
2253 // backend->listOfTables(),
2255 // Revision 1.50 2004/05/04 22:34:25 rurban
2258 // Revision 1.49 2004/05/03 11:16:40 rurban
2259 // fixed sendPageChangeNotification
2260 // subject rewording
2262 // Revision 1.48 2004/04/29 23:03:54 rurban
2263 // fixed sf.net bug #940996
2265 // Revision 1.47 2004/04/29 19:39:44 rurban
2266 // special support for formatted plugins (one-liners)
2267 // like <small><plugin BlaBla ></small>
2268 // iter->asArray() helper for PopularNearby
2269 // db_session for older php's (no &func() allowed)
2271 // Revision 1.46 2004/04/26 20:44:34 rurban
2272 // locking table specific for better databases
2274 // Revision 1.45 2004/04/20 00:06:03 rurban
2275 // themable paging support
2277 // Revision 1.44 2004/04/19 18:27:45 rurban
2278 // Prevent from some PHP5 warnings (ref args, no :: object init)
2279 // php5 runs now through, just one wrong XmlElement object init missing
2280 // Removed unneccesary UpgradeUser lines
2281 // Changed WikiLink to omit version if current (RecentChanges)
2283 // Revision 1.43 2004/04/18 01:34:20 rurban
2284 // protect most_popular from sortby=mtime
2286 // Revision 1.42 2004/04/18 01:11:51 rurban
2287 // more numeric pagename fixes.
2288 // fixed action=upload with merge conflict warnings.
2289 // charset changed from constant to global (dynamic utf-8 switching)
2295 // c-basic-offset: 4
2296 // c-hanging-comment-ender-p: nil
2297 // indent-tabs-mode: nil