2 rcs_id('$Id: WikiDB.php,v 1.140 2006-03-19 14:23:51 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 if (!empty($GLOBALS['request'])) $GLOBALS['request']->_dbi = $this;
121 // If the database doesn't yet have a timestamp, initialize it now.
122 if ($this->get('_timestamp') === false)
125 //FIXME: devel checking.
126 //$this->_backend->check();
130 * Close database connection.
132 * The database may no longer be used after it is closed.
134 * Closing a WikiDB invalidates all <tt>WikiDB_Page</tt>s,
135 * <tt>WikiDB_PageRevision</tt>s and <tt>WikiDB_PageIterator</tt>s
136 * which have been obtained from it.
141 $this->_backend->close();
142 $this->_cache->close();
146 * Get a WikiDB_Page from a WikiDB.
148 * A {@link WikiDB} consists of the (infinite) set of all possible pages,
149 * therefore this method never fails.
152 * @param string $pagename Which page to get.
153 * @return WikiDB_Page The requested WikiDB_Page.
155 function getPage($pagename) {
156 static $error_displayed = false;
157 $pagename = (string) $pagename;
159 if ($pagename === '') {
160 if ($error_displayed) return false;
161 $error_displayed = true;
162 if (function_exists("xdebug_get_function_stack"))
163 var_dump(xdebug_get_function_stack());
164 trigger_error("empty pagename", E_USER_WARNING);
168 assert($pagename != '');
170 return new WikiDB_Page($this, $pagename);
174 * Determine whether page exists (in non-default form).
177 * $is_page = $dbi->isWikiPage($pagename);
181 * $page = $dbi->getPage($pagename);
182 * $current = $page->getCurrentRevision();
183 * $is_page = ! $current->hasDefaultContents();
185 * however isWikiPage may be implemented in a more efficient
186 * manner in certain back-ends.
190 * @param string $pagename string Which page to check.
192 * @return boolean True if the page actually exists with
193 * non-default contents in the WikiDataBase.
195 function isWikiPage ($pagename) {
196 $page = $this->getPage($pagename);
197 return $page->exists();
201 * Delete page from the WikiDB.
203 * Deletes the page from the WikiDB with the possibility to revert and diff.
204 * //Also resets all page meta-data to the default values.
206 * Note: purgePage() effectively destroys all revisions of the page from the WikiDB.
210 * @param string $pagename Name of page to delete.
212 function deletePage($pagename) {
213 // don't create empty revisions of already purged pages.
214 if ($this->_backend->get_latest_version($pagename))
215 $result = $this->_cache->delete_page($pagename);
219 /* Generate notification emails? */
220 if (! $this->isWikiPage($pagename) and !isa($GLOBALS['request'],'MockRequest')) {
221 $notify = $this->get('notify');
222 if (!empty($notify) and is_array($notify)) {
224 //TODO: deferr it (quite a massive load if you remove some pages).
225 //TODO: notification class which catches all changes,
226 // and decides at the end of the request what to mail.
227 // (type, page, who, what, users, emails)
228 // could be used for PageModeration and RSS2 Cloud xml-rpc also.
229 $page = new WikiDB_Page($this, $pagename);
230 list($emails, $userids) = $page->getPageChangeEmails($notify);
231 if (!empty($emails)) {
232 $from = $request->_user->getId() . '@' . $request->get('REMOTE_HOST');
233 $editedby = sprintf(_("Removed by: %s"), $from);
234 $emails = join(',', $emails);
235 $subject = sprintf(_("Page removed %s"), urlencode($pagename));
236 if (mail("<undisclosed-recipients>","[".WIKI_NAME."] ".$subject,
240 "From: $from\r\nBcc: $emails"))
241 trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
242 $pagename, join(',',$userids)), E_USER_NOTICE);
244 trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
245 $pagename, join(',',$userids)), E_USER_WARNING);
250 //How to create a RecentChanges entry with explaining summary? Dynamically
252 $page = $this->getPage($pagename);
253 $current = $page->getCurrentRevision();
254 $meta = $current->_data;
255 $version = $current->getVersion();
256 $meta['summary'] = _("removed");
257 $page->save($current->getPackedContent(), $version + 1, $meta);
263 * Completely remove the page from the WikiDB, without undo possibility.
265 function purgePage($pagename) {
266 $result = $this->_cache->purge_page($pagename);
267 $this->deletePage($pagename); // just for the notification
272 * Retrieve all pages.
274 * Gets the set of all pages with non-default contents.
278 * @param boolean $include_defaulted Normally pages whose most
279 * recent revision has empty content are considered to be
280 * non-existant. Unless $include_defaulted is set to true, those
281 * pages will not be returned.
283 * @return WikiDB_PageIterator A WikiDB_PageIterator which contains all pages
284 * in the WikiDB which have non-default contents.
286 function getAllPages($include_empty=false, $sortby=false, $limit=false,
289 // HACK: memory_limit=8M will fail on too large pagesets. old php on unix only!
291 $mem = ini_get("memory_limit");
292 if ($mem and !$limit and !isWindows() and !check_php_version(4,3)) {
294 $GLOBALS['request']->setArg('limit', $limit);
295 $GLOBALS['request']->setArg('paging', 'auto');
298 $result = $this->_backend->get_all_pages($include_empty, $sortby, $limit,
300 return new WikiDB_PageIterator($this, $result,
301 array('include_empty' => $include_empty,
302 'exclude' => $exclude,
307 * $include_empty = true: include also empty pages
308 * exclude: comma-seperated list pagenames: TBD: array of pagenames
310 function numPages($include_empty=false, $exclude='') {
311 if (method_exists($this->_backend, 'numPages'))
312 // FIXME: currently are all args ignored.
313 $count = $this->_backend->numPages($include_empty, $exclude);
315 // FIXME: exclude ignored.
316 $iter = $this->getAllPages($include_empty, false, false, $exclude);
317 $count = $iter->count();
326 * Search for pages containing (or not containing) certain words
329 * Pages are returned in alphabetical order whenever it is
330 * practical to do so.
332 * FIXME: clarify $search syntax. provide glob=>TextSearchQuery converters
335 * @param TextSearchQuery $search A TextSearchQuery object
336 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
337 * @see TextSearchQuery
339 function titleSearch($search, $sortby='pagename', $limit=false, $exclude=false) {
340 $result = $this->_backend->text_search($search, false, $sortby, $limit, $exclude);
341 return new WikiDB_PageIterator($this, $result,
342 array('exclude' => $exclude,
349 * Search for pages containing (or not containing) certain words
350 * in their entire text (this includes the page content and the
353 * Pages are returned in alphabetical order whenever it is
354 * practical to do so.
358 * @param TextSearchQuery $search A TextSearchQuery object.
359 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
360 * @see TextSearchQuery
362 function fullSearch($search, $sortby='pagename', $limit=false, $exclude=false) {
363 $result = $this->_backend->text_search($search, true, $sortby, $limit, $exclude);
364 return new WikiDB_PageIterator($this, $result,
365 array('exclude' => $exclude,
367 'stoplisted' => $result->stoplisted
372 * Find the pages with the greatest hit counts.
374 * Pages are returned in reverse order by hit count.
378 * @param integer $limit The maximum number of pages to return.
379 * Set $limit to zero to return all pages. If $limit < 0, pages will
380 * be sorted in decreasing order of popularity.
382 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching
385 function mostPopular($limit = 20, $sortby = '-hits') {
386 $result = $this->_backend->most_popular($limit, $sortby);
387 return new WikiDB_PageIterator($this, $result);
391 * Find recent page revisions.
393 * Revisions are returned in reverse order by creation time.
397 * @param hash $params This hash is used to specify various optional
401 * <dd> (integer) At most this many revisions will be returned.
403 * <dd> (integer) Only revisions since this time (unix-timestamp) will be returned.
404 * <dt> include_minor_revisions
405 * <dd> (boolean) Also include minor revisions. (Default is not to.)
406 * <dt> exclude_major_revisions
407 * <dd> (boolean) Don't include non-minor revisions.
408 * (Exclude_major_revisions implies include_minor_revisions.)
409 * <dt> include_all_revisions
410 * <dd> (boolean) Return all matching revisions for each page.
411 * Normally only the most recent matching revision is returned
415 * @return WikiDB_PageRevisionIterator A WikiDB_PageRevisionIterator containing the
416 * matching revisions.
418 function mostRecent($params = false) {
419 $result = $this->_backend->most_recent($params);
420 return new WikiDB_PageRevisionIterator($this, $result);
426 * @return Iterator A generic iterator containing rows of (duplicate) pagename, wantedfrom.
428 function wantedPages($exclude_from='', $exclude='', $sortby=false, $limit=false) {
429 return $this->_backend->wanted_pages($exclude_from, $exclude, $sortby, $limit);
430 //return new WikiDB_PageIterator($this, $result);
436 * @return array rows of pagenames.
438 function listRelations() {
439 if (method_exists($this->_backend, "list_relations"))
440 return $this->_backend->list_relations();
441 $iter = $this->getAllPages(false, false, false, $exclude);
442 while ($page = $iter->next()) {
443 $reliter = $page->getRelations();
445 while ($rel = $reliter->next()) {
446 $names[] = $rel->getName();
448 $relations = array_merge($relations, $names);
456 * Call the appropriate backend method.
459 * @param string $from Page to rename
460 * @param string $to New name
461 * @param boolean $updateWikiLinks If the text in all pages should be replaced.
462 * @return boolean true or false
464 function renamePage($from, $to, $updateWikiLinks = false) {
465 assert(is_string($from) && $from != '');
466 assert(is_string($to) && $to != '');
468 if (method_exists($this->_backend, 'rename_page')) {
469 $oldpage = $this->getPage($from);
470 $newpage = $this->getPage($to);
471 //update all WikiLinks in existing pages
472 //non-atomic! i.e. if rename fails the links are not undone
473 if ($updateWikiLinks) {
474 require_once('lib/plugin/WikiAdminSearchReplace.php');
475 $links = $oldpage->getBackLinks();
476 while ($linked_page = $links->next()) {
477 WikiPlugin_WikiAdminSearchReplace::replaceHelper($this,
478 $linked_page->getName(),
481 $links = $newpage->getBackLinks();
482 while ($linked_page = $links->next()) {
483 WikiPlugin_WikiAdminSearchReplace::replaceHelper($this,
484 $linked_page->getName(),
488 if ($oldpage->exists() and ! $newpage->exists()) {
489 if ($result = $this->_backend->rename_page($from, $to)) {
490 //create a RecentChanges entry with explaining summary
491 $page = $this->getPage($to);
492 $current = $page->getCurrentRevision();
493 $meta = $current->_data;
494 $version = $current->getVersion();
495 $meta['summary'] = sprintf(_("renamed from %s"), $from);
496 $page->save($current->getPackedContent(), $version + 1, $meta);
498 } elseif (!$oldpage->getCurrentRevision(false) and !$newpage->exists()) {
499 // if a version 0 exists try it also.
500 $result = $this->_backend->rename_page($from, $to);
503 trigger_error(_("WikiDB::renamePage() not yet implemented for this backend"),
506 /* Generate notification emails? */
507 if ($result and !isa($GLOBALS['request'], 'MockRequest')) {
508 $notify = $this->get('notify');
509 if (!empty($notify) and is_array($notify)) {
510 list($emails, $userids) = $oldpage->getPageChangeEmails($notify);
511 if (!empty($emails)) {
512 $oldpage->sendPageRenameNotification($to, $meta, $emails, $userids);
519 /** Get timestamp when database was last modified.
521 * @return string A string consisting of two integers,
522 * separated by a space. The first is the time in
523 * unix timestamp format, the second is a modification
524 * count for the database.
526 * The idea is that you can cast the return value to an
527 * int to get a timestamp, or you can use the string value
528 * as a good hash for the entire database.
530 function getTimestamp() {
531 $ts = $this->get('_timestamp');
532 return sprintf("%d %d", $ts[0], $ts[1]);
536 * Update the database timestamp.
540 $ts = $this->get('_timestamp');
541 $this->set('_timestamp', array(time(), $ts[1] + 1));
546 * Access WikiDB global meta-data.
548 * NOTE: this is currently implemented in a hackish and
549 * not very efficient manner.
553 * @param string $key Which meta data to get.
554 * Some reserved meta-data keys are:
556 * <dt>'_timestamp' <dd> Data used by getTimestamp().
559 * @return scalar The requested value, or false if the requested data
563 if (!$key || $key[0] == '%')
566 * Hack Alert: We can use any page (existing or not) to store
567 * this data (as long as we always use the same one.)
569 $gd = $this->getPage('global_data');
570 $data = $gd->get('__global');
572 if ($data && isset($data[$key]))
579 * Set global meta-data.
581 * NOTE: this is currently implemented in a hackish and
582 * not very efficient manner.
587 * @param string $key Meta-data key to set.
588 * @param string $newval New value.
590 function set($key, $newval) {
591 if (!$key || $key[0] == '%')
594 $gd = $this->getPage('global_data');
595 $data = $gd->get('__global');
602 $data[$key] = $newval;
604 $gd->set('__global', $data);
607 /* TODO: these are really backend methods */
609 // SQL result: for simple select or create/update queries
610 // returns the database specific resource type
611 function genericSqlQuery($sql, $args=false) {
612 if (function_exists('debug_backtrace')) { // >= 4.3.0
613 echo "<pre>", printSimpleTrace(debug_backtrace()), "</pre>\n";
615 trigger_error("no SQL database", E_USER_ERROR);
619 // SQL iter: for simple select or create/update queries
620 // returns the generic iterator object (count,next)
621 function genericSqlIter($sql, $field_list = NULL) {
622 if (function_exists('debug_backtrace')) { // >= 4.3.0
623 echo "<pre>", printSimpleTrace(debug_backtrace()), "</pre>\n";
625 trigger_error("no SQL database", E_USER_ERROR);
629 // see backend upstream methods
630 // ADODB adds surrounding quotes, SQL not yet!
631 function quote ($s) {
637 if (!$request->_dbi) return false;
638 else return false; /* so far only needed for sql so false it.
639 later we have to check dba also */
642 function getParam($param) {
644 if (isset($DBParams[$param])) return $DBParams[$param];
645 elseif ($param == 'prefix') return '';
649 function getAuthParam($param) {
650 global $DBAuthParams;
651 if (isset($DBAuthParams[$param])) return $DBAuthParams[$param];
652 elseif ($param == 'USER_AUTH_ORDER') return $GLOBALS['USER_AUTH_ORDER'];
653 elseif ($param == 'USER_AUTH_POLICY') return $GLOBALS['USER_AUTH_POLICY'];
660 * An abstract base class which representing a wiki-page within a
663 * A WikiDB_Page contains a number (at least one) of
664 * WikiDB_PageRevisions.
668 function WikiDB_Page(&$wikidb, $pagename) {
669 $this->_wikidb = &$wikidb;
670 $this->_pagename = $pagename;
672 if (!(is_string($pagename) and $pagename != '')) {
673 if (function_exists("xdebug_get_function_stack")) {
674 echo "xdebug_get_function_stack(): "; var_dump(xdebug_get_function_stack());
675 } elseif (function_exists("debug_backtrace")) { // >= 4.3.0
676 printSimpleTrace(debug_backtrace());
678 trigger_error("empty pagename", E_USER_WARNING);
682 assert(is_string($pagename) and $pagename != '');
687 * Get the name of the wiki page.
691 * @return string The page name.
694 return $this->_pagename;
697 // To reduce the memory footprint for larger sets of pagelists,
698 // we don't cache the content (only true or false) and
699 // we purge the pagedata (_cached_html) also
701 if (isset($this->_wikidb->_cache->_id_cache[$this->_pagename])) return true;
702 $current = $this->getCurrentRevision(false);
703 if (!$current) return false;
704 return ! $current->hasDefaultContents();
708 * Delete an old revision of a WikiDB_Page.
710 * Deletes the specified revision of the page.
711 * It is a fatal error to attempt to delete the current revision.
715 * @param integer $version Which revision to delete. (You can also
716 * use a WikiDB_PageRevision object here.)
718 function deleteRevision($version) {
719 $backend = &$this->_wikidb->_backend;
720 $cache = &$this->_wikidb->_cache;
721 $pagename = &$this->_pagename;
723 $version = $this->_coerce_to_version($version);
727 $backend->lock(array('page','version'));
728 $latestversion = $cache->get_latest_version($pagename);
729 if ($latestversion && ($version == $latestversion)) {
730 $backend->unlock(array('page','version'));
731 trigger_error(sprintf("Attempt to delete most recent revision of '%s'",
732 $pagename), E_USER_ERROR);
736 $cache->delete_versiondata($pagename, $version);
737 $backend->unlock(array('page','version'));
741 * Delete a revision, or possibly merge it with a previous
745 * Suppose an author make a (major) edit to a page. Shortly
746 * after that the same author makes a minor edit (e.g. to fix
747 * spelling mistakes he just made.)
749 * Now some time later, where cleaning out old saved revisions,
750 * and would like to delete his minor revision (since there's
751 * really no point in keeping minor revisions around for a long
754 * Note that the text after the minor revision probably represents
755 * what the author intended to write better than the text after
756 * the preceding major edit.
758 * So what we really want to do is merge the minor edit with the
761 * We will only do this when:
763 * <li>The revision being deleted is a minor one, and
764 * <li>It has the same author as the immediately preceding revision.
767 function mergeRevision($version) {
768 $backend = &$this->_wikidb->_backend;
769 $cache = &$this->_wikidb->_cache;
770 $pagename = &$this->_pagename;
772 $version = $this->_coerce_to_version($version);
776 $backend->lock(array('version'));
777 $latestversion = $cache->get_latest_version($pagename);
778 if ($latestversion && $version == $latestversion) {
779 $backend->unlock(array('version'));
780 trigger_error(sprintf("Attempt to merge most recent revision of '%s'",
781 $pagename), E_USER_ERROR);
785 $versiondata = $cache->get_versiondata($pagename, $version, true);
787 // Not there? ... we're done!
788 $backend->unlock(array('version'));
792 if ($versiondata['is_minor_edit']) {
793 $previous = $backend->get_previous_version($pagename, $version);
795 $prevdata = $cache->get_versiondata($pagename, $previous);
796 if ($prevdata['author_id'] == $versiondata['author_id']) {
797 // This is a minor revision, previous version is
798 // by the same author. We will merge the
800 $cache->update_versiondata($pagename, $previous,
801 array('%content' => $versiondata['%content'],
802 '_supplanted' => $versiondata['_supplanted']));
807 $cache->delete_versiondata($pagename, $version);
808 $backend->unlock(array('version'));
813 * Create a new revision of a {@link WikiDB_Page}.
817 * @param int $version Version number for new revision.
818 * To ensure proper serialization of edits, $version must be
819 * exactly one higher than the current latest version.
820 * (You can defeat this check by setting $version to
821 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
823 * @param string $content Contents of new revision.
825 * @param hash $metadata Metadata for new revision.
826 * All values in the hash should be scalars (strings or integers).
828 * @param hash $links List of linkto=>pagename, relation=>pagename which this page links to.
830 * @return WikiDB_PageRevision Returns the new WikiDB_PageRevision object. If
831 * $version was incorrect, returns false
833 function createRevision($version, &$content, $metadata, $links) {
834 $backend = &$this->_wikidb->_backend;
835 $cache = &$this->_wikidb->_cache;
836 $pagename = &$this->_pagename;
837 $cache->invalidate_cache($pagename);
839 $backend->lock(array('version','page','recent','link','nonempty'));
841 $latestversion = $backend->get_latest_version($pagename);
842 $newversion = ($latestversion ? $latestversion : 0) + 1;
843 assert($newversion >= 1);
845 if ($version != WIKIDB_FORCE_CREATE and $version != $newversion) {
846 $backend->unlock(array('version','page','recent','link','nonempty'));
852 foreach ($data as $key => $val) {
853 if (empty($val) || $key[0] == '_' || $key[0] == '%')
857 assert(!empty($data['author']));
858 if (empty($data['author_id']))
859 @$data['author_id'] = $data['author'];
861 if (empty($data['mtime']))
862 $data['mtime'] = time();
864 if ($latestversion and $version != WIKIDB_FORCE_CREATE) {
865 // Ensure mtimes are monotonic.
866 $pdata = $cache->get_versiondata($pagename, $latestversion);
867 if ($data['mtime'] < $pdata['mtime']) {
868 trigger_error(sprintf(_("%s: Date of new revision is %s"),
869 $pagename,"'non-monotonic'"),
871 $data['orig_mtime'] = $data['mtime'];
872 $data['mtime'] = $pdata['mtime'];
875 // FIXME: use (possibly user specified) 'mtime' time or
877 $cache->update_versiondata($pagename, $latestversion,
878 array('_supplanted' => $data['mtime']));
881 $data['%content'] = &$content;
883 $cache->set_versiondata($pagename, $newversion, $data);
885 //$cache->update_pagedata($pagename, array(':latestversion' => $newversion,
886 //':deleted' => empty($content)));
888 $backend->set_links($pagename, $links);
890 $backend->unlock(array('version','page','recent','link','nonempty'));
892 return new WikiDB_PageRevision($this->_wikidb, $pagename, $newversion,
896 /** A higher-level interface to createRevision.
898 * This takes care of computing the links, and storing
899 * a cached version of the transformed wiki-text.
901 * @param string $wikitext The page content.
903 * @param int $version Version number for new revision.
904 * To ensure proper serialization of edits, $version must be
905 * exactly one higher than the current latest version.
906 * (You can defeat this check by setting $version to
907 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
909 * @param hash $meta Meta-data for new revision.
911 function save($wikitext, $version, $meta) {
912 $formatted = new TransformedText($this, $wikitext, $meta);
913 $type = $formatted->getType();
914 $meta['pagetype'] = $type->getName();
915 $links = $formatted->getWikiPageLinks();
917 $backend = &$this->_wikidb->_backend;
918 $newrevision = $this->createRevision($version, $wikitext, $meta, $links);
919 if ($newrevision and !WIKIDB_NOCACHE_MARKUP)
920 $this->set('_cached_html', $formatted->pack());
922 // FIXME: probably should have some global state information
923 // in the backend to control when to optimize.
925 // We're doing this here rather than in createRevision because
926 // postgresql can't optimize while locked.
927 if ((DEBUG & _DEBUG_SQL)
928 or (DATABASE_OPTIMISE_FREQUENCY > 0 and
929 (time() % DATABASE_OPTIMISE_FREQUENCY == 0))) {
930 if ($backend->optimize())
931 trigger_error(_("Optimizing database"), E_USER_NOTICE);
934 /* Generate notification emails? */
935 if (isa($newrevision, 'WikiDB_PageRevision')) {
936 // Save didn't fail because of concurrent updates.
937 $notify = $this->_wikidb->get('notify');
938 if (!empty($notify) and is_array($notify) and !isa($GLOBALS['request'],'MockRequest')) {
939 list($emails, $userids) = $this->getPageChangeEmails($notify);
940 if (!empty($emails)) {
941 $this->sendPageChangeNotification($wikitext, $version, $meta, $emails, $userids);
944 $newrevision->_transformedContent = $formatted;
950 function getPageChangeEmails($notify) {
951 $emails = array(); $userids = array();
952 foreach ($notify as $page => $users) {
953 if (glob_match($page, $this->_pagename)) {
954 foreach ($users as $userid => $user) {
955 if (!$user) { // handle the case for ModeratePage: no prefs, just userid's.
957 $u = $request->getUser();
958 if ($u->UserName() == $userid) {
959 $prefs = $u->getPreferences();
962 if (ENABLE_USER_NEW) {
963 $u = WikiUser($userid);
964 $u->getPreferences();
965 $prefs = &$u->_prefs;
967 $u = new WikiUser($GLOBALS['request'], $userid);
968 $prefs = $u->getPreferences();
971 $emails[] = $prefs->get('email');
972 $userids[] = $userid;
974 if (!empty($user['verified']) and !empty($user['email'])) {
975 $emails[] = $user['email'];
976 $userids[] = $userid;
977 } elseif (!empty($user['email'])) {
979 // do a dynamic emailVerified check update
980 $u = $request->getUser();
981 if ($u->UserName() == $userid) {
982 if ($request->_prefs->get('emailVerified')) {
983 $emails[] = $user['email'];
984 $userids[] = $userid;
985 $notify[$page][$userid]['verified'] = 1;
986 $request->_dbi->set('notify', $notify);
990 if (ENABLE_USER_NEW) {
991 $u = WikiUser($userid);
992 $u->getPreferences();
993 $prefs = &$u->_prefs;
995 $u = new WikiUser($GLOBALS['request'], $userid);
996 $prefs = $u->getPreferences();
998 if ($prefs->get('emailVerified')) {
999 $emails[] = $user['email'];
1000 $userids[] = $userid;
1001 $notify[$page][$userid]['verified'] = 1;
1002 $request->_dbi->set('notify', $notify);
1005 // ignore verification
1008 if (!in_array($user['email'],$emails))
1009 $emails[] = $user['email'];
1017 $emails = array_unique($emails);
1018 $userids = array_unique($userids);
1019 return array($emails, $userids);
1023 * Send udiff for a changed page to multiple users.
1024 * See rename and remove methods also
1026 function sendPageChangeNotification(&$wikitext, $version, $meta, $emails, $userids) {
1028 if (@is_array($request->_deferredPageChangeNotification)) {
1029 // collapse multiple changes (loaddir) into one email
1030 $request->_deferredPageChangeNotification[]
1031 = array($this->_pagename, $emails, $userids);
1034 $backend = &$this->_wikidb->_backend;
1035 //$backend = &$request->_dbi->_backend;
1036 $subject = _("Page change").' '.urlencode($this->_pagename);
1037 $previous = $backend->get_previous_version($this->_pagename, $version);
1038 if (!isset($meta['mtime'])) $meta['mtime'] = time();
1040 $difflink = WikiURL($this->_pagename, array('action'=>'diff'), true);
1041 $cache = &$this->_wikidb->_cache;
1042 //$cache = &$request->_dbi->_cache;
1043 $this_content = explode("\n", $wikitext);
1044 $prevdata = $cache->get_versiondata($this->_pagename, $previous, true);
1045 if (empty($prevdata['%content']))
1046 $prevdata = $backend->get_versiondata($this->_pagename, $previous, true);
1047 $other_content = explode("\n", $prevdata['%content']);
1049 include_once("lib/difflib.php");
1050 $diff2 = new Diff($other_content, $this_content);
1051 //$context_lines = max(4, count($other_content) + 1,
1052 // count($this_content) + 1);
1053 $fmt = new UnifiedDiffFormatter(/*$context_lines*/);
1054 $content = $this->_pagename . " " . $previous . " " .
1055 Iso8601DateTime($prevdata['mtime']) . "\n";
1056 $content .= $this->_pagename . " " . $version . " " .
1057 Iso8601DateTime($meta['mtime']) . "\n";
1058 $content .= $fmt->format($diff2);
1061 $difflink = WikiURL($this->_pagename,array(),true);
1062 $content = $this->_pagename . " " . $version . " " .
1063 Iso8601DateTime($meta['mtime']) . "\n";
1064 $content .= _("New page");
1066 $from = $request->_user->getId() . '@' . $request->get('REMOTE_HOST');
1067 $editedby = sprintf(_("Edited by: %s"), $from);
1068 $emails = join(',',$emails);
1069 if (mail("<undisclosed-recipients>",
1070 "[".WIKI_NAME."] ".$subject,
1071 $subject."\n". $editedby."\n". $difflink."\n\n". $content,
1072 "From: $from\r\nBcc: $emails"))
1073 trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
1074 $this->_pagename, join(',',$userids)), E_USER_NOTICE);
1076 trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
1077 $this->_pagename, join(',',$userids)), E_USER_WARNING);
1080 /** support mass rename / remove (not yet tested)
1082 function sendPageRenameNotification($to, &$meta, $emails, $userids) {
1084 if (@is_array($request->_deferredPageRenameNotification)) {
1085 $request->_deferredPageRenameNotification[] = array($this->_pagename,
1086 $to, $meta, $emails, $userids);
1088 $oldname = $this->_pagename;
1089 $from = $request->_user->getId() . '@' . $request->get('REMOTE_HOST');
1090 $editedby = sprintf(_("Edited by: %s"), $from);
1091 $emails = join(',',$emails);
1092 $subject = sprintf(_("Page rename %s to %s"), urlencode($oldname), urlencode($to));
1093 $link = WikiURL($to, true);
1094 if (mail("<undisclosed-recipients>",
1095 "[".WIKI_NAME."] ".$subject,
1096 $subject."\n".$editedby."\n".$link."\n\n"."Renamed $from to $to",
1097 "From: $from\r\nBcc: $emails"))
1098 trigger_error(sprintf(_("PageChange Notification of %s sent to %s"),
1099 $oldname, join(',',$userids)), E_USER_NOTICE);
1101 trigger_error(sprintf(_("PageChange Notification Error: Couldn't send %s to %s"),
1102 $oldname, join(',',$userids)), E_USER_WARNING);
1107 * Get the most recent revision of a page.
1111 * @return WikiDB_PageRevision The current WikiDB_PageRevision object.
1113 function getCurrentRevision ($need_content = true) {
1114 $backend = &$this->_wikidb->_backend;
1115 $cache = &$this->_wikidb->_cache;
1116 $pagename = &$this->_pagename;
1118 // Prevent deadlock in case of memory exhausted errors
1119 // Pure selection doesn't really need locking here.
1120 // sf.net bug#927395
1121 // I know it would be better to lock, but with lots of pages this deadlock is more
1122 // severe than occasionally get not the latest revision.
1123 // In spirit to wikiwiki: read fast, edit slower.
1125 $version = $cache->get_latest_version($pagename);
1126 // getRevision gets the content also!
1127 $revision = $this->getRevision($version, $need_content);
1128 //$backend->unlock();
1134 * Get a specific revision of a WikiDB_Page.
1138 * @param integer $version Which revision to get.
1140 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or
1141 * false if the requested revision does not exist in the {@link WikiDB}.
1142 * Note that version zero of any page always exists.
1144 function getRevision ($version, $need_content=true) {
1145 $cache = &$this->_wikidb->_cache;
1146 $pagename = &$this->_pagename;
1148 if (! $version or $version == -1) // 0 or false
1149 return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
1151 assert($version > 0);
1152 $vdata = $cache->get_versiondata($pagename, $version, $need_content);
1154 return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
1156 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1161 * Get previous page revision.
1163 * This method find the most recent revision before a specified
1168 * @param integer $version Find most recent revision before this version.
1169 * You can also use a WikiDB_PageRevision object to specify the $version.
1171 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or false if the
1172 * requested revision does not exist in the {@link WikiDB}. Note that
1173 * unless $version is greater than zero, a revision (perhaps version zero,
1174 * the default revision) will always be found.
1176 function getRevisionBefore ($version=false, $need_content=true) {
1177 $backend = &$this->_wikidb->_backend;
1178 $pagename = &$this->_pagename;
1179 if ($version === false)
1180 $version = $this->_wikidb->_cache->get_latest_version($pagename);
1182 $version = $this->_coerce_to_version($version);
1187 $previous = $backend->get_previous_version($pagename, $version);
1188 $revision = $this->getRevision($previous, $need_content);
1189 //$backend->unlock();
1195 * Get all revisions of the WikiDB_Page.
1197 * This does not include the version zero (default) revision in the
1198 * returned revision set.
1200 * @return WikiDB_PageRevisionIterator A
1201 * WikiDB_PageRevisionIterator containing all revisions of this
1202 * WikiDB_Page in reverse order by version number.
1204 function getAllRevisions() {
1205 $backend = &$this->_wikidb->_backend;
1206 $revs = $backend->get_all_revisions($this->_pagename);
1207 return new WikiDB_PageRevisionIterator($this->_wikidb, $revs);
1211 * Find pages which link to or are linked from a page.
1215 * @param boolean $reversed Which links to find: true for backlinks (default).
1217 * @return WikiDB_PageIterator A WikiDB_PageIterator containing
1218 * all matching pages.
1220 function getLinks ($reversed = true, $include_empty=false, $sortby=false,
1221 $limit=false, $exclude=false) {
1222 $backend = &$this->_wikidb->_backend;
1223 $result = $backend->get_links($this->_pagename, $reversed,
1224 $include_empty, $sortby, $limit, $exclude);
1225 return new WikiDB_PageIterator($this->_wikidb, $result,
1226 array('include_empty' => $include_empty,
1227 'sortby' => $sortby,
1229 'exclude' => $exclude));
1233 * All Links from other pages to this page.
1235 function getBackLinks($include_empty=false, $sortby=false, $limit=false, $exclude=false) {
1236 return $this->getLinks(true, $include_empty, $sortby, $limit, $exclude);
1239 * Forward Links: All Links from this page to other pages.
1241 function getPageLinks($include_empty=false, $sortby=false, $limit=false, $exclude=false) {
1242 return $this->getLinks(false, $include_empty, $sortby, $limit, $exclude);
1245 * Relations: All links from this page to other pages with relation <> 0.
1248 function getRelations($sortby=false, $limit=false, $exclude=false) {
1249 $backend = &$this->_wikidb->_backend;
1250 $result = $backend->get_links($this->_pagename, false, true,
1251 $sortby, $limit, $exclude,
1253 // we do not care for the linked page versiondata, just the pagename and relationname
1254 return new WikiDB_PageIterator($this->_wikidb, $result,
1255 array('include_empty' => true,
1256 'sortby' => $sortby,
1258 'exclude' => $exclude));
1262 * possibly faster link existance check. not yet accelerated.
1264 function existLink($link, $reversed=false) {
1265 $backend = &$this->_wikidb->_backend;
1266 if (method_exists($backend,'exists_link'))
1267 return $backend->exists_link($this->_pagename, $link, $reversed);
1268 //$cache = &$this->_wikidb->_cache;
1269 // TODO: check cache if it is possible
1270 $iter = $this->getLinks($reversed, false);
1271 while ($page = $iter->next()) {
1272 if ($page->getName() == $link)
1279 /* Semantic relations are links with the relation pointing to another page,
1280 the so called "RDF Triple".
1281 [San Diego] is%20a::city
1282 => "At the page San Diego there is a relation link of 'is a' to the page 'city'."
1285 /* Semantic attributes for a page.
1286 [San Diego] population:=1,305,736
1287 Attributes are links with the relation pointing to another page.
1291 * Access WikiDB_Page non version-specific meta-data.
1295 * @param string $key Which meta data to get.
1296 * Some reserved meta-data keys are:
1298 * <dt>'date' <dd> Created as unixtime
1299 * <dt>'locked'<dd> Is page locked? 'yes' or 'no'
1300 * <dt>'hits' <dd> Page hit counter.
1301 * <dt>'_cached_html' <dd> Transformed CachedMarkup object, serialized + optionally gzipped.
1302 * In SQL stored now in an extra column.
1304 * <dt>'pref' <dd> Users preferences, stored only in homepages.
1305 * <dt>'owner' <dd> Default: first author_id. We might add a group with a dot here:
1306 * E.g. "owner.users"
1307 * <dt>'perm' <dd> Permission flag to authorize read/write/execution of
1308 * page-headers and content.
1309 + <dt>'moderation'<dd> ModeratedPage data
1310 * <dt>'score' <dd> Page score (not yet implement, do we need?)
1313 * @return scalar The requested value, or false if the requested data
1316 function get($key) {
1317 $cache = &$this->_wikidb->_cache;
1318 $backend = &$this->_wikidb->_backend;
1319 if (!$key || $key[0] == '%')
1321 // several new SQL backends optimize this.
1322 if (!WIKIDB_NOCACHE_MARKUP
1323 and $key == '_cached_html'
1324 and method_exists($backend, 'get_cached_html'))
1326 return $backend->get_cached_html($this->_pagename);
1328 $data = $cache->get_pagedata($this->_pagename);
1329 return isset($data[$key]) ? $data[$key] : false;
1333 * Get all the page meta-data as a hash.
1335 * @return hash The page meta-data.
1337 function getMetaData() {
1338 $cache = &$this->_wikidb->_cache;
1339 $data = $cache->get_pagedata($this->_pagename);
1341 foreach ($data as $key => $val) {
1342 if (/*!empty($val) &&*/ $key[0] != '%')
1349 * Set page meta-data.
1354 * @param string $key Meta-data key to set.
1355 * @param string $newval New value.
1357 function set($key, $newval) {
1358 $cache = &$this->_wikidb->_cache;
1359 $backend = &$this->_wikidb->_backend;
1360 $pagename = &$this->_pagename;
1362 assert($key && $key[0] != '%');
1364 // several new SQL backends optimize this.
1365 if (!WIKIDB_NOCACHE_MARKUP
1366 and $key == '_cached_html'
1367 and method_exists($backend, 'set_cached_html'))
1369 return $backend->set_cached_html($pagename, $newval);
1372 $data = $cache->get_pagedata($pagename);
1374 if (!empty($newval)) {
1375 if (!empty($data[$key]) && $data[$key] == $newval)
1376 return; // values identical, skip update.
1379 if (empty($data[$key]))
1380 return; // values identical, skip update.
1383 $cache->update_pagedata($pagename, array($key => $newval));
1387 * Increase page hit count.
1389 * FIXME: IS this needed? Probably not.
1391 * This is a convenience function.
1392 * <pre> $page->increaseHitCount(); </pre>
1393 * is functionally identical to
1394 * <pre> $page->set('hits',$page->get('hits')+1); </pre>
1395 * but less expensive (ignores the pagadata string)
1397 * Note that this method may be implemented in more efficient ways
1398 * in certain backends.
1402 function increaseHitCount() {
1403 if (method_exists($this->_wikidb->_backend, 'increaseHitCount'))
1404 $this->_wikidb->_backend->increaseHitCount($this->_pagename);
1406 @$newhits = $this->get('hits') + 1;
1407 $this->set('hits', $newhits);
1412 * Return a string representation of the WikiDB_Page
1414 * This is really only for debugging.
1418 * @return string Printable representation of the WikiDB_Page.
1420 function asString () {
1422 printf("[%s:%s\n", get_class($this), $this->getName());
1423 print_r($this->getMetaData());
1425 $strval = ob_get_contents();
1433 * @param integer_or_object $version_or_pagerevision
1434 * Takes either the version number (and int) or a WikiDB_PageRevision
1436 * @return integer The version number.
1438 function _coerce_to_version($version_or_pagerevision) {
1439 if (method_exists($version_or_pagerevision, "getContent"))
1440 $version = $version_or_pagerevision->getVersion();
1442 $version = (int) $version_or_pagerevision;
1444 assert($version >= 0);
1448 function isUserPage ($include_empty = true) {
1449 if (!$include_empty and !$this->exists()) return false;
1450 return $this->get('pref') ? true : false;
1453 // May be empty. Either the stored owner (/Chown), or the first authorized author
1454 function getOwner() {
1455 if ($owner = $this->get('owner'))
1456 return ($owner == "The PhpWiki programming team") ? ADMIN_USER : $owner;
1457 // check all revisions forwards for the first author_id
1458 $backend = &$this->_wikidb->_backend;
1459 $pagename = &$this->_pagename;
1460 $latestversion = $backend->get_latest_version($pagename);
1461 for ($v=1; $v <= $latestversion; $v++) {
1462 $rev = $this->getRevision($v,false);
1463 if ($rev and $owner = $rev->get('author_id')) {
1464 return ($owner == "The PhpWiki programming team") ? ADMIN_USER : $owner;
1470 // The authenticated author of the first revision or empty if not authenticated then.
1471 function getCreator() {
1472 if ($current = $this->getRevision(1,false)) return $current->get('author_id');
1476 // The authenticated author of the current revision.
1477 function getAuthor() {
1478 if ($current = $this->getCurrentRevision(false)) return $current->get('author_id');
1485 * This class represents a specific revision of a WikiDB_Page within
1488 * A WikiDB_PageRevision has read-only semantics. You may only create
1489 * new revisions (and delete old ones) --- you cannot modify existing
1492 class WikiDB_PageRevision
1494 //var $_transformedContent = false; // set by WikiDB_Page::save()
1496 function WikiDB_PageRevision(&$wikidb, $pagename, $version, $versiondata = false) {
1497 $this->_wikidb = &$wikidb;
1498 $this->_pagename = $pagename;
1499 $this->_version = $version;
1500 $this->_data = $versiondata ? $versiondata : array();
1501 $this->_transformedContent = false; // set by WikiDB_Page::save()
1505 * Get the WikiDB_Page which this revision belongs to.
1509 * @return WikiDB_Page The WikiDB_Page which this revision belongs to.
1511 function getPage() {
1512 return new WikiDB_Page($this->_wikidb, $this->_pagename);
1516 * Get the version number of this revision.
1520 * @return integer The version number of this revision.
1522 function getVersion() {
1523 return $this->_version;
1527 * Determine whether this revision has defaulted content.
1529 * The default revision (version 0) of each page, as well as any
1530 * pages which are created with empty content have their content
1531 * defaulted to something like:
1533 * Describe [ThisPage] here.
1538 * @return boolean Returns true if the page has default content.
1540 function hasDefaultContents() {
1541 $data = &$this->_data;
1542 return empty($data['%content']); // FIXME: what if it's the number 0? <>'' or === false
1546 * Get the content as an array of lines.
1550 * @return array An array of lines.
1551 * The lines should contain no trailing white space.
1553 function getContent() {
1554 return explode("\n", $this->getPackedContent());
1558 * Get the pagename of the revision.
1562 * @return string pagename.
1564 function getPageName() {
1565 return $this->_pagename;
1567 function getName() {
1568 return $this->_pagename;
1572 * Determine whether revision is the latest.
1576 * @return boolean True iff the revision is the latest (most recent) one.
1578 function isCurrent() {
1579 if (!isset($this->_iscurrent)) {
1580 $page = $this->getPage();
1581 $current = $page->getCurrentRevision(false);
1582 $this->_iscurrent = $this->getVersion() == $current->getVersion();
1584 return $this->_iscurrent;
1588 * Get the transformed content of a page.
1590 * @param string $pagetype Override the page-type of the revision.
1592 * @return object An XmlContent-like object containing the page transformed
1595 function getTransformedContent($pagetype_override=false) {
1596 $backend = &$this->_wikidb->_backend;
1598 if ($pagetype_override) {
1599 // Figure out the normal page-type for this page.
1600 $type = PageType::GetPageType($this->get('pagetype'));
1601 if ($type->getName() == $pagetype_override)
1602 $pagetype_override = false; // Not really an override...
1605 if ($pagetype_override) {
1606 // Overriden page type, don't cache (or check cache).
1607 return new TransformedText($this->getPage(),
1608 $this->getPackedContent(),
1609 $this->getMetaData(),
1610 $pagetype_override);
1613 $possibly_cache_results = true;
1615 if (!USECACHE or WIKIDB_NOCACHE_MARKUP) {
1616 if (WIKIDB_NOCACHE_MARKUP == 'purge') {
1617 // flush cache for this page.
1618 $page = $this->getPage();
1619 $page->set('_cached_html', ''); // ignored with !USECACHE
1621 $possibly_cache_results = false;
1623 elseif (USECACHE and !$this->_transformedContent) {
1625 if ($this->isCurrent()) {
1626 $page = $this->getPage();
1627 $this->_transformedContent = TransformedText::unpack($page->get('_cached_html'));
1630 $possibly_cache_results = false;
1632 //$backend->unlock();
1635 if (!$this->_transformedContent) {
1636 $this->_transformedContent
1637 = new TransformedText($this->getPage(),
1638 $this->getPackedContent(),
1639 $this->getMetaData());
1641 if ($possibly_cache_results and !WIKIDB_NOCACHE_MARKUP) {
1642 // If we're still the current version, cache the transfomed page.
1644 if ($this->isCurrent()) {
1645 $page->set('_cached_html', $this->_transformedContent->pack());
1647 //$backend->unlock();
1651 return $this->_transformedContent;
1655 * Get the content as a string.
1659 * @return string The page content.
1660 * Lines are separated by new-lines.
1662 function getPackedContent() {
1663 $data = &$this->_data;
1666 if (empty($data['%content'])) {
1667 include_once('lib/InlineParser.php');
1669 // A feature similar to taglines at http://www.wlug.org.nz/
1670 // Lib from http://www.aasted.org/quote/
1671 if (defined('FORTUNE_DIR')
1672 and is_dir(FORTUNE_DIR)
1673 and in_array($GLOBALS['request']->getArg('action'),
1674 array('create','edit')))
1676 include_once("lib/fortune.php");
1677 $fortune = new Fortune();
1678 $quote = str_replace("\n<br>","\n", $fortune->quoteFromDir(FORTUNE_DIR));
1679 return sprintf("<verbatim>\n%s</verbatim>\n\n"._("Describe %s here."),
1680 $quote, "[" . WikiEscape($this->_pagename) . "]");
1682 // Replace empty content with default value.
1683 return sprintf(_("Describe %s here."),
1684 "[" . WikiEscape($this->_pagename) . "]");
1687 // There is (non-default) content.
1688 assert($this->_version > 0);
1690 if (!is_string($data['%content'])) {
1691 // Content was not provided to us at init time.
1692 // (This is allowed because for some backends, fetching
1693 // the content may be expensive, and often is not wanted
1696 // In any case, now we need to get it.
1697 $data['%content'] = $this->_get_content();
1698 assert(is_string($data['%content']));
1701 return $data['%content'];
1704 function _get_content() {
1705 $cache = &$this->_wikidb->_cache;
1706 $pagename = $this->_pagename;
1707 $version = $this->_version;
1709 assert($version > 0);
1711 $newdata = $cache->get_versiondata($pagename, $version, true);
1713 assert(is_string($newdata['%content']));
1714 return $newdata['%content'];
1717 // else revision has been deleted... What to do?
1718 return __sprintf("Oops! Revision %s of %s seems to have been deleted!",
1719 $version, $pagename);
1724 * Get meta-data for this revision.
1729 * @param string $key Which meta-data to access.
1731 * Some reserved revision meta-data keys are:
1733 * <dt> 'mtime' <dd> Time this revision was created (seconds since midnight Jan 1, 1970.)
1734 * The 'mtime' meta-value is normally set automatically by the database
1735 * backend, but it may be specified explicitly when creating a new revision.
1737 * <dd> To ensure consistency of RecentChanges, the mtimes of the versions
1738 * of a page must be monotonically increasing. If an attempt is
1739 * made to create a new revision with an mtime less than that of
1740 * the preceeding revision, the new revisions timestamp is force
1741 * to be equal to that of the preceeding revision. In that case,
1742 * the originally requested mtime is preserved in 'orig_mtime'.
1743 * <dt> '_supplanted' <dd> Time this revision ceased to be the most recent.
1744 * This meta-value is <em>always</em> automatically maintained by the database
1745 * backend. (It is set from the 'mtime' meta-value of the superceding
1746 * revision.) '_supplanted' has a value of 'false' for the current revision.
1748 * FIXME: this could be refactored:
1750 * <dd> Author of the page (as he should be reported in, e.g. RecentChanges.)
1752 * <dd> Authenticated author of a page. This is used to identify
1753 * the distinctness of authors when cleaning old revisions from
1755 * <dt> 'is_minor_edit' <dd> Set if change was marked as a minor revision by the author.
1756 * <dt> 'summary' <dd> Short change summary entered by page author.
1759 * Meta-data keys must be valid C identifers (they have to start with a letter
1760 * or underscore, and can contain only alphanumerics and underscores.)
1762 * @return string The requested value, or false if the requested value
1765 function get($key) {
1766 if (!$key || $key[0] == '%')
1768 $data = &$this->_data;
1769 return isset($data[$key]) ? $data[$key] : false;
1773 * Get all the revision page meta-data as a hash.
1775 * @return hash The revision meta-data.
1777 function getMetaData() {
1779 foreach ($this->_data as $key => $val) {
1780 if (!empty($val) && $key[0] != '%')
1788 * Return a string representation of the revision.
1790 * This is really only for debugging.
1794 * @return string Printable representation of the WikiDB_Page.
1796 function asString () {
1798 printf("[%s:%d\n", get_class($this), $this->get('version'));
1799 print_r($this->_data);
1800 echo $this->getPackedContent() . "\n]\n";
1801 $strval = ob_get_contents();
1809 * Class representing a sequence of WikiDB_Pages.
1810 * TODO: Enhance to php5 iterators
1812 * apply filters for options like 'sortby', 'limit', 'exclude'
1813 * for simple queries like titleSearch, where the backend is not ready yet.
1815 class WikiDB_PageIterator
1817 function WikiDB_PageIterator(&$wikidb, &$iter, $options=false) {
1818 $this->_iter = $iter; // a WikiDB_backend_iterator
1819 $this->_wikidb = &$wikidb;
1820 $this->_options = $options;
1824 return $this->_iter->count();
1828 * Get next WikiDB_Page in sequence.
1832 * @return WikiDB_Page The next WikiDB_Page in the sequence.
1835 if ( ! ($next = $this->_iter->next()) )
1838 $pagename = &$next['pagename'];
1839 if (!is_string($pagename)) // Bug #1327912 fixed by Joachim Lous
1840 $pagename = strval($pagename);
1842 trigger_error('empty pagename in WikiDB_PageIterator::next()', E_USER_WARNING);
1846 // There's always hits, but we cache only if more
1847 // (well not with file, cvs and dba)
1848 if (isset($next['pagedata']) and count($next['pagedata']) > 1) {
1849 $this->_wikidb->_cache->cache_data($next);
1850 // cache existing page id's since we iterate over all links in GleanDescription
1851 // and need them later for LinkExistingWord
1852 } elseif ($this->_options and array_key_exists('include_empty', $this->_options)
1853 and !$this->_options['include_empty'] and isset($next['id'])) {
1854 $this->_wikidb->_cache->_id_cache[$next['pagename']] = $next['id'];
1856 $page = new WikiDB_Page($this->_wikidb, $pagename);
1857 if (isset($next['linkrelation']))
1858 $page->set('linkrelation', $next['linkrelation']);
1863 * Release resources held by this iterator.
1865 * The iterator may not be used after free() is called.
1867 * There is no need to call free(), if next() has returned false.
1868 * (I.e. if you iterate through all the pages in the sequence,
1869 * you do not need to call free() --- you only need to call it
1870 * if you stop before the end of the iterator is reached.)
1875 $this->_iter->free();
1878 function asArray() {
1880 while ($page = $this->next())
1887 * Apply filters for options like 'sortby', 'limit', 'exclude'
1888 * for simple queries like titleSearch, where the backend is not ready yet.
1889 * Since iteration is usually destructive for SQL results,
1890 * we have to generate a copy.
1892 function applyFilters($options = false) {
1893 if (!$options) $options = $this->_options;
1894 if (isset($options['sortby'])) {
1896 /* this is destructive */
1897 while ($page = $this->next())
1898 $result[] = $page->getName();
1899 $this->_doSort($array, $options['sortby']);
1901 /* the rest is not destructive.
1902 * reconstruct a new iterator
1904 $pagenames = array(); $i = 0;
1905 if (isset($options['limit']))
1906 $limit = $options['limit'];
1909 if (isset($options['exclude']))
1910 $exclude = $options['exclude'];
1911 if (is_string($exclude) and !is_array($exclude))
1912 $exclude = PageList::explodePageList($exclude, false, false, $limit);
1913 foreach($array as $pagename) {
1914 if ($limit and $i++ > $limit)
1915 return new WikiDB_Array_PageIterator($pagenames);
1916 if (!empty($exclude) and !in_array($pagename, $exclude))
1917 $pagenames[] = $pagename;
1918 elseif (empty($exclude))
1919 $pagenames[] = $pagename;
1921 return new WikiDB_Array_PageIterator($pagenames);
1925 function _doSort(&$array, $sortby) {
1926 $sortby = PageList::sortby($sortby, 'init');
1927 if ($sortby == '+pagename')
1928 sort($array, SORT_STRING);
1929 elseif ($sortby == '-pagename')
1930 rsort($array, SORT_STRING);
1937 * A class which represents a sequence of WikiDB_PageRevisions.
1938 * TODO: Enhance to php5 iterators
1940 class WikiDB_PageRevisionIterator
1942 function WikiDB_PageRevisionIterator(&$wikidb, &$revisions, $options=false) {
1943 $this->_revisions = $revisions;
1944 $this->_wikidb = &$wikidb;
1945 $this->_options = $options;
1949 return $this->_revisions->count();
1953 * Get next WikiDB_PageRevision in sequence.
1957 * @return WikiDB_PageRevision
1958 * The next WikiDB_PageRevision in the sequence.
1961 if ( ! ($next = $this->_revisions->next()) )
1964 //$this->_wikidb->_cache->cache_data($next);
1966 $pagename = $next['pagename'];
1967 $version = $next['version'];
1968 $versiondata = $next['versiondata'];
1970 if (!(is_string($pagename) and $pagename != '')) {
1971 trigger_error("empty pagename",E_USER_WARNING);
1974 } else assert(is_string($pagename) and $pagename != '');
1976 if (!is_array($versiondata)) {
1977 trigger_error("empty versiondata",E_USER_WARNING);
1980 } else assert(is_array($versiondata));
1982 if (!($version > 0)) {
1983 trigger_error("invalid version",E_USER_WARNING);
1986 } else assert($version > 0);
1988 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1993 * Release resources held by this iterator.
1995 * The iterator may not be used after free() is called.
1997 * There is no need to call free(), if next() has returned false.
1998 * (I.e. if you iterate through all the revisions in the sequence,
1999 * you do not need to call free() --- you only need to call it
2000 * if you stop before the end of the iterator is reached.)
2005 $this->_revisions->free();
2008 function asArray() {
2010 while ($rev = $this->next())
2019 class WikiDB_Array_PageIterator
2021 function WikiDB_Array_PageIterator($pagenames) {
2023 $this->_dbi = $request->getDbh();
2024 $this->_pages = $pagenames;
2025 reset($this->_pages);
2028 $c =& current($this->_pages);
2029 next($this->_pages);
2030 return $c !== false ? $this->_dbi->getPage($c) : false;
2033 return count($this->_pages);
2036 function asArray() {
2037 reset($this->_pages);
2038 return $this->_pages;
2042 class WikiDB_Array_generic_iter
2044 function WikiDB_Array_generic_iter($result) {
2045 // $result may be either an array or a query result
2046 if (is_array($result)) {
2047 $this->_array = $result;
2048 } elseif (is_object($result)) {
2049 $this->_array = $result->asArray();
2051 $this->_array = array();
2053 if (!empty($this->_array))
2054 reset($this->_array);
2057 $c =& current($this->_array);
2058 next($this->_array);
2059 return $c !== false ? $c : false;
2062 return count($this->_array);
2065 function asArray() {
2066 if (!empty($this->_array))
2067 reset($this->_array);
2068 return $this->_array;
2073 * Data cache used by WikiDB.
2075 * FIXME: Maybe rename this to caching_backend (or some such).
2081 // FIXME: beautify versiondata cache. Cache only limited data?
2083 function WikiDB_cache (&$backend) {
2084 $this->_backend = &$backend;
2086 $this->_pagedata_cache = array();
2087 $this->_versiondata_cache = array();
2088 array_push ($this->_versiondata_cache, array());
2089 $this->_glv_cache = array();
2090 $this->_id_cache = array(); // formerly ->_dbi->_iwpcache (nonempty pages => id)
2094 $this->_pagedata_cache = array();
2095 $this->_versiondata_cache = array();
2096 $this->_glv_cache = array();
2097 $this->_id_cache = array();
2100 function get_pagedata($pagename) {
2101 assert(is_string($pagename) && $pagename != '');
2103 $cache = &$this->_pagedata_cache;
2104 if (!isset($cache[$pagename]) || !is_array($cache[$pagename])) {
2105 $cache[$pagename] = $this->_backend->get_pagedata($pagename);
2106 if (empty($cache[$pagename]))
2107 $cache[$pagename] = array();
2109 return $cache[$pagename];
2111 return $this->_backend->get_pagedata($pagename);
2115 function update_pagedata($pagename, $newdata) {
2116 assert(is_string($pagename) && $pagename != '');
2118 $this->_backend->update_pagedata($pagename, $newdata);
2121 if (!empty($this->_pagedata_cache[$pagename])
2122 and is_array($this->_pagedata_cache[$pagename]))
2124 $cachedata = &$this->_pagedata_cache[$pagename];
2125 foreach($newdata as $key => $val)
2126 $cachedata[$key] = $val;
2128 $this->_pagedata_cache[$pagename] = $newdata;
2132 function invalidate_cache($pagename) {
2133 unset ($this->_pagedata_cache[$pagename]);
2134 unset ($this->_versiondata_cache[$pagename]);
2135 unset ($this->_glv_cache[$pagename]);
2136 unset ($this->_id_cache[$pagename]);
2137 //unset ($this->_backend->_page_data);
2140 function delete_page($pagename) {
2141 $result = $this->_backend->delete_page($pagename);
2142 $this->invalidate_cache($pagename);
2146 function purge_page($pagename) {
2147 $result = $this->_backend->purge_page($pagename);
2148 $this->invalidate_cache($pagename);
2152 // FIXME: ugly and wrong. may overwrite full cache with partial cache
2153 function cache_data($data) {
2155 //if (isset($data['pagedata']))
2156 // $this->_pagedata_cache[$data['pagename']] = $data['pagedata'];
2159 function get_versiondata($pagename, $version, $need_content = false) {
2160 // FIXME: Seriously ugly hackage
2162 if (USECACHE) { //temporary - for debugging
2163 assert(is_string($pagename) && $pagename != '');
2164 // There is a bug here somewhere which results in an assertion failure at line 105
2165 // of ArchiveCleaner.php It goes away if we use the next line.
2166 //$need_content = true;
2167 $nc = $need_content ? '1':'0';
2168 $cache = &$this->_versiondata_cache;
2169 if (!isset($cache[$pagename][$version][$nc])
2170 || !(is_array ($cache[$pagename]))
2171 || !(is_array ($cache[$pagename][$version])))
2173 $cache[$pagename][$version][$nc] =
2174 $this->_backend->get_versiondata($pagename, $version, $need_content);
2176 // If we have retrieved all data, we may as well set the cache for
2177 // $need_content = false
2179 $cache[$pagename][$version]['0'] =& $cache[$pagename][$version]['1'];
2182 $vdata = $cache[$pagename][$version][$nc];
2184 $vdata = $this->_backend->get_versiondata($pagename, $version, $need_content);
2187 if ($readdata && $vdata && !empty($vdata['%pagedata'])) {
2188 $this->_pagedata_cache[$pagename] =& $vdata['%pagedata'];
2193 function set_versiondata($pagename, $version, $data) {
2194 //unset($this->_versiondata_cache[$pagename][$version]);
2196 $new = $this->_backend->set_versiondata($pagename, $version, $data);
2198 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2199 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2200 // Is this necessary?
2201 unset($this->_glv_cache[$pagename]);
2204 function update_versiondata($pagename, $version, $data) {
2205 $new = $this->_backend->update_versiondata($pagename, $version, $data);
2207 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2209 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2210 // Is this necessary?
2211 unset($this->_glv_cache[$pagename]);
2214 function delete_versiondata($pagename, $version) {
2215 $new = $this->_backend->delete_versiondata($pagename, $version);
2216 if (isset($this->_versiondata_cache[$pagename][$version]))
2217 unset ($this->_versiondata_cache[$pagename][$version]);
2218 // dirty latest version cache only if latest version gets deleted
2219 if (isset($this->_glv_cache[$pagename]) and $this->_glv_cache[$pagename] == $version)
2220 unset ($this->_glv_cache[$pagename]);
2223 function get_latest_version($pagename) {
2225 assert (is_string($pagename) && $pagename != '');
2226 $cache = &$this->_glv_cache;
2227 if (!isset($cache[$pagename])) {
2228 $cache[$pagename] = $this->_backend->get_latest_version($pagename);
2229 if (empty($cache[$pagename]))
2230 $cache[$pagename] = 0;
2232 return $cache[$pagename];
2234 return $this->_backend->get_latest_version($pagename);
2239 function _sql_debuglog($msg, $newline=true, $shutdown=false) {
2243 $stamp = strftime("%y%m%d-%H%M%S");
2244 $fp = fopen("/tmp/sql-$stamp.log", "a");
2245 register_shutdown_function("_sql_debuglog_shutdown_function");
2246 } elseif ($shutdown) {
2250 if ($newline) fputs($fp, "[$i++] $msg");
2251 else fwrite($fp, $msg);
2254 function _sql_debuglog_shutdown_function() {
2255 _sql_debuglog('',false,true);
2258 // $Log: not supported by cvs2svn $
2259 // Revision 1.139 2006/01/12 16:38:07 rurban
2260 // add page method listRelations()
2261 // fix bug #1327912 numeric pagenames can break plugins (Joachim Lous)
2263 // Revision 1.138 2005/11/14 22:27:07 rurban
2264 // add linkrelation support
2265 // getPageLinks returns now an array of hashes
2266 // pass stoplist through iterator
2268 // Revision 1.137 2005/10/12 06:16:18 rurban
2269 // better From header
2271 // Revision 1.136 2005/10/03 16:14:57 rurban
2272 // improve description
2274 // Revision 1.135 2005/09/11 14:19:44 rurban
2275 // enable LIMIT support for fulltext search
2277 // Revision 1.134 2005/09/10 21:28:10 rurban
2278 // applyFilters hack to use filters after methods, which do not support them (titleSearch)
2280 // Revision 1.133 2005/08/27 09:39:10 rurban
2281 // dumphtml when not at admin page: dump the current or given page
2283 // Revision 1.132 2005/08/07 10:10:07 rurban
2284 // clean whole version cache
2286 // Revision 1.131 2005/04/23 11:30:12 rurban
2287 // allow emtpy WikiDB::getRevisionBefore(), for simplier templates (revert)
2289 // Revision 1.130 2005/04/06 06:19:30 rurban
2290 // Revert the previous wrong bugfix #1175761: USECACHE was mixed with WIKIDB_NOCACHE_MARKUP.
2291 // Fix WIKIDB_NOCACHE_MARKUP in main (always set it) and clarify it in WikiDB
2293 // Revision 1.129 2005/04/06 05:50:29 rurban
2294 // honor !USECACHE for _cached_html, fixes #1175761
2296 // Revision 1.128 2005/04/01 16:11:42 rurban
2299 // Revision 1.127 2005/02/18 20:43:40 uckelman
2300 // WikiDB::genericWarnings() is no longer used.
2302 // Revision 1.126 2005/02/04 17:58:06 rurban
2303 // minor versioncache improvement. part 2/3 of Charles Corrigan cache patch. not sure about the 0/1 issue
2305 // Revision 1.125 2005/02/03 05:08:39 rurban
2306 // ref fix by Charles Corrigan
2308 // Revision 1.124 2005/01/29 20:43:32 rurban
2309 // protect against empty request: on some occasion this happens
2311 // Revision 1.123 2005/01/25 06:58:21 rurban
2314 // Revision 1.122 2005/01/20 10:18:17 rurban
2317 // Revision 1.121 2005/01/04 20:25:01 rurban
2318 // remove old [%pagedata][_cached_html] code
2320 // Revision 1.120 2004/12/23 14:12:31 rurban
2321 // dont email on unittest
2323 // Revision 1.119 2004/12/20 16:05:00 rurban
2324 // gettext msg unification
2326 // Revision 1.118 2004/12/13 13:22:57 rurban
2327 // new BlogArchives plugin for the new blog theme. enable default box method
2328 // for all plugins. Minor search improvement.
2330 // Revision 1.117 2004/12/13 08:15:09 rurban
2331 // false is wrong. null might be better but lets play safe.
2333 // Revision 1.116 2004/12/10 22:15:00 rurban
2334 // fix $page->get('_cached_html)
2335 // refactor upgrade db helper _convert_cached_html() to be able to call them from WikiAdminUtils also.
2336 // support 2nd genericSqlQuery param (bind huge arg)
2338 // Revision 1.115 2004/12/10 02:45:27 rurban
2339 // SQL optimization:
2340 // put _cached_html from pagedata into a new seperate blob, not huge serialized string.
2341 // it is only rarelely needed: for current page only, if-not-modified
2342 // but was extracted for every simple page iteration.
2344 // Revision 1.114 2004/12/09 22:24:44 rurban
2345 // optimize on _DEBUG_SQL only. but now again on every 50th request, not just save.
2347 // Revision 1.113 2004/12/06 19:49:55 rurban
2348 // enable action=remove which is undoable and seeable in RecentChanges: ADODB ony for now.
2349 // renamed delete_page to purge_page.
2350 // enable action=edit&version=-1 to force creation of a new version.
2351 // added BABYCART_PATH config
2352 // fixed magiqc in adodb.inc.php
2353 // and some more docs
2355 // Revision 1.112 2004/11/30 17:45:53 rurban
2356 // exists_links backend implementation
2358 // Revision 1.111 2004/11/28 20:39:43 rurban
2359 // deactivate pagecache overwrite: it is wrong
2361 // Revision 1.110 2004/11/26 18:39:01 rurban
2362 // new regex search parser and SQL backends (90% complete, glob and pcre backends missing)
2364 // Revision 1.109 2004/11/25 17:20:50 rurban
2365 // and again a couple of more native db args: backlinks
2367 // Revision 1.108 2004/11/23 13:35:31 rurban
2368 // add case_exact search
2370 // Revision 1.107 2004/11/21 11:59:16 rurban
2371 // remove final \n to be ob_cache independent
2373 // Revision 1.106 2004/11/20 17:35:56 rurban
2374 // improved WantedPages SQL backends
2375 // PageList::sortby new 3rd arg valid_fields (override db fields)
2376 // WantedPages sql pager inexact for performance reasons:
2377 // assume 3 wantedfrom per page, to be correct, no getTotal()
2378 // support exclude argument for get_all_pages, new _sql_set()
2380 // Revision 1.105 2004/11/20 09:16:27 rurban
2381 // Fix bad-style Cut&Paste programming errors, detected by Charles Corrigan.
2383 // Revision 1.104 2004/11/19 19:22:03 rurban
2384 // ModeratePage part1: change status
2386 // Revision 1.103 2004/11/16 17:29:04 rurban
2387 // fix remove notification error
2388 // fix creation + update id_cache update
2390 // Revision 1.102 2004/11/11 18:31:26 rurban
2391 // add simple backtrace on such general failures to get at least an idea where
2393 // Revision 1.101 2004/11/10 19:32:22 rurban
2394 // * optimize increaseHitCount, esp. for mysql.
2395 // * prepend dirs to the include_path (phpwiki_dir for faster searches)
2396 // * Pear_DB version logic (awful but needed)
2397 // * fix broken ADODB quote
2398 // * _extract_page_data simplification
2400 // Revision 1.100 2004/11/10 15:29:20 rurban
2401 // * requires newer Pear_DB (as the internal one): quote() uses now escapeSimple for strings
2402 // * ACCESS_LOG_SQL: fix cause request not yet initialized
2403 // * WikiDB: moved SQL specific methods upwards
2404 // * new Pear_DB quoting: same as ADODB and as newer Pear_DB.
2405 // fixes all around: WikiGroup, WikiUserNew SQL methods, SQL logging
2407 // Revision 1.99 2004/11/09 17:11:05 rurban
2408 // * revert to the wikidb ref passing. there's no memory abuse there.
2409 // * use new wikidb->_cache->_id_cache[] instead of wikidb->_iwpcache, to effectively
2410 // store page ids with getPageLinks (GleanDescription) of all existing pages, which
2411 // are also needed at the rendering for linkExistingWikiWord().
2412 // pass options to pageiterator.
2413 // use this cache also for _get_pageid()
2414 // This saves about 8 SELECT count per page (num all pagelinks).
2415 // * fix passing of all page fields to the pageiterator.
2416 // * fix overlarge session data which got broken with the latest ACCESS_LOG_SQL changes
2418 // Revision 1.98 2004/11/07 18:34:29 rurban
2419 // more logging fixes
2421 // Revision 1.97 2004/11/07 16:02:51 rurban
2422 // new sql access log (for spam prevention), and restructured access log class
2423 // dbh->quote (generic)
2424 // pear_db: mysql specific parts seperated (using replace)
2426 // Revision 1.96 2004/11/05 22:32:15 rurban
2427 // encode the subject to be 7-bit safe
2429 // Revision 1.95 2004/11/05 20:53:35 rurban
2430 // login cleanup: better debug msg on failing login,
2431 // checked password less immediate login (bogo or anon),
2432 // checked olduser pref session error,
2433 // better PersonalPage without password warning on minimal password length=0
2434 // (which is default now)
2436 // Revision 1.94 2004/11/01 10:43:56 rurban
2437 // seperate PassUser methods into seperate dir (memory usage)
2438 // fix WikiUser (old) overlarge data session
2439 // remove wikidb arg from various page class methods, use global ->_dbi instead
2442 // Revision 1.93 2004/10/14 17:17:57 rurban
2443 // remove dbi WikiDB_Page param: use global request object instead. (memory)
2444 // allow most_popular sortby arguments
2446 // Revision 1.92 2004/10/05 17:00:04 rurban
2447 // support paging for simple lists
2448 // fix RatingDb sql backend.
2449 // remove pages from AllPages (this is ListPages then)
2451 // Revision 1.91 2004/10/04 23:41:19 rurban
2452 // delete notify: fix, @unset syntax error
2454 // Revision 1.90 2004/09/28 12:50:22 rurban
2455 // https://sourceforge.net/forum/forum.php?thread_id=1150924&forum_id=18929
2457 // Revision 1.89 2004/09/26 10:54:42 rurban
2458 // silence deferred check
2460 // Revision 1.88 2004/09/25 18:16:40 rurban
2461 // unset more unneeded _cached_html. (Guess this should fix sf.net now)
2463 // Revision 1.87 2004/09/25 16:25:40 rurban
2464 // notify on rename and remove (to be improved)
2466 // Revision 1.86 2004/09/23 18:52:06 rurban
2467 // only fortune at create
2469 // Revision 1.85 2004/09/16 08:00:51 rurban
2470 // just some comments
2472 // Revision 1.84 2004/09/14 10:34:30 rurban
2473 // fix TransformedText call to use refs
2475 // Revision 1.83 2004/09/08 13:38:00 rurban
2476 // improve loadfile stability by using markup=2 as default for undefined markup-style.
2477 // use more refs for huge objects.
2478 // fix debug=static issue in WikiPluginCached
2480 // Revision 1.82 2004/09/06 12:08:49 rurban
2481 // memory_limit on unix workaround
2482 // VisualWiki: default autosize image
2484 // Revision 1.81 2004/09/06 08:28:00 rurban
2485 // rename genericQuery to genericSqlQuery
2487 // Revision 1.80 2004/07/09 13:05:34 rurban
2490 // Revision 1.79 2004/07/09 10:06:49 rurban
2491 // Use backend specific sortby and sortable_columns method, to be able to
2492 // select between native (Db backend) and custom (PageList) sorting.
2493 // Fixed PageList::AddPageList (missed the first)
2494 // Added the author/creator.. name to AllPagesBy...
2495 // display no pages if none matched.
2496 // Improved dba and file sortby().
2497 // Use &$request reference
2499 // Revision 1.78 2004/07/08 21:32:35 rurban
2500 // Prevent from more warnings, minor db and sort optimizations
2502 // Revision 1.77 2004/07/08 19:04:42 rurban
2503 // more unittest fixes (file backend, metadata RatingsDb)
2505 // Revision 1.76 2004/07/08 17:31:43 rurban
2506 // improve numPages for file (fixing AllPagesTest)
2508 // Revision 1.75 2004/07/05 13:56:22 rurban
2509 // sqlite autoincrement fix
2511 // Revision 1.74 2004/07/03 16:51:05 rurban
2512 // optional DBADMIN_USER:DBADMIN_PASSWD for action=upgrade (if no ALTER permission)
2513 // added atomic mysql REPLACE for PearDB as in ADODB
2514 // fixed _lock_tables typo links => link
2515 // fixes unserialize ADODB bug in line 180
2517 // Revision 1.73 2004/06/29 08:52:22 rurban
2518 // Use ...version() $need_content argument in WikiDB also:
2519 // To reduce the memory footprint for larger sets of pagelists,
2520 // we don't cache the content (only true or false) and
2521 // we purge the pagedata (_cached_html) also.
2522 // _cached_html is only cached for the current pagename.
2523 // => Vastly improved page existance check, ACL check, ...
2525 // Now only PagedList info=content or size needs the whole content, esp. if sortable.
2527 // Revision 1.72 2004/06/25 14:15:08 rurban
2528 // reduce memory footprint by caching only requested pagedate content (improving most page iterators)
2530 // Revision 1.71 2004/06/21 16:22:30 rurban
2531 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
2532 // fixed dumping buttons locally (images/buttons/),
2533 // support pages arg for dumphtml,
2534 // optional directory arg for dumpserial + dumphtml,
2535 // fix a AllPages warning,
2536 // show dump warnings/errors on DEBUG,
2537 // don't warn just ignore on wikilens pagelist columns, if not loaded.
2538 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
2540 // Revision 1.70 2004/06/18 14:39:31 rurban
2541 // actually check USECACHE
2543 // Revision 1.69 2004/06/13 15:33:20 rurban
2544 // new support for arguments owner, author, creator in most relevant
2545 // PageList plugins. in WikiAdmin* via preSelectS()
2547 // Revision 1.68 2004/06/08 21:03:20 rurban
2548 // updated RssParser for XmlParser quirks (store parser object params in globals)
2550 // Revision 1.67 2004/06/07 19:12:49 rurban
2551 // fixed rename version=0, bug #966284
2553 // Revision 1.66 2004/06/07 18:57:27 rurban
2554 // fix rename: Change pagename in all linked pages
2556 // Revision 1.65 2004/06/04 20:32:53 rurban
2557 // Several locale related improvements suggested by Pierrick Meignen
2558 // LDAP fix by John Cole
2559 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
2561 // Revision 1.64 2004/06/04 16:50:00 rurban
2562 // add random quotes to empty pages
2564 // Revision 1.63 2004/06/04 11:58:38 rurban
2565 // added USE_TAGLINES
2567 // Revision 1.62 2004/06/03 22:24:41 rurban
2568 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
2570 // Revision 1.61 2004/06/02 17:13:48 rurban
2571 // fix getRevisionBefore assertion
2573 // Revision 1.60 2004/05/28 10:09:58 rurban
2574 // fix bug #962117, incorrect init of auth_dsn
2576 // Revision 1.59 2004/05/27 17:49:05 rurban
2577 // renamed DB_Session to DbSession (in CVS also)
2578 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
2579 // remove leading slash in error message
2580 // added force_unlock parameter to File_Passwd (no return on stale locks)
2581 // fixed adodb session AffectedRows
2582 // added FileFinder helpers to unify local filenames and DATA_PATH names
2583 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
2585 // Revision 1.58 2004/05/18 13:59:14 rurban
2586 // rename simpleQuery to genericQuery
2588 // Revision 1.57 2004/05/16 22:07:35 rurban
2589 // check more config-default and predefined constants
2590 // various PagePerm fixes:
2591 // fix default PagePerms, esp. edit and view for Bogo and Password users
2592 // implemented Creator and Owner
2593 // BOGOUSERS renamed to BOGOUSER
2594 // fixed syntax errors in signin.tmpl
2596 // Revision 1.56 2004/05/15 22:54:49 rurban
2597 // fixed important WikiDB bug with DEBUG > 0: wrong assertion
2598 // improved SetAcl (works) and PagePerms, some WikiGroup helpers.
2600 // Revision 1.55 2004/05/12 19:27:47 rurban
2601 // revert wrong inline optimization.
2603 // Revision 1.54 2004/05/12 10:49:55 rurban
2604 // require_once fix for those libs which are loaded before FileFinder and
2605 // its automatic include_path fix, and where require_once doesn't grok
2606 // dirname(__FILE__) != './lib'
2607 // upgrade fix with PearDB
2608 // navbar.tmpl: remove spaces for IE button alignment
2610 // Revision 1.53 2004/05/08 14:06:12 rurban
2611 // new support for inlined image attributes: [image.jpg size=50x30 align=right]
2612 // minor stability and portability fixes
2614 // Revision 1.52 2004/05/06 19:26:16 rurban
2615 // improve stability, trying to find the InlineParser endless loop on sf.net
2617 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
2619 // Revision 1.51 2004/05/06 17:30:37 rurban
2620 // CategoryGroup: oops, dos2unix eol
2621 // improved phpwiki_version:
2622 // pre -= .0001 (1.3.10pre: 1030.099)
2623 // -p1 += .001 (1.3.9-p1: 1030.091)
2624 // improved InstallTable for mysql and generic SQL versions and all newer tables so far.
2625 // abstracted more ADODB/PearDB methods for action=upgrade stuff:
2626 // backend->backendType(), backend->database(),
2627 // backend->listOfFields(),
2628 // backend->listOfTables(),
2630 // Revision 1.50 2004/05/04 22:34:25 rurban
2633 // Revision 1.49 2004/05/03 11:16:40 rurban
2634 // fixed sendPageChangeNotification
2635 // subject rewording
2637 // Revision 1.48 2004/04/29 23:03:54 rurban
2638 // fixed sf.net bug #940996
2640 // Revision 1.47 2004/04/29 19:39:44 rurban
2641 // special support for formatted plugins (one-liners)
2642 // like <small><plugin BlaBla ></small>
2643 // iter->asArray() helper for PopularNearby
2644 // db_session for older php's (no &func() allowed)
2646 // Revision 1.46 2004/04/26 20:44:34 rurban
2647 // locking table specific for better databases
2649 // Revision 1.45 2004/04/20 00:06:03 rurban
2650 // themable paging support
2652 // Revision 1.44 2004/04/19 18:27:45 rurban
2653 // Prevent from some PHP5 warnings (ref args, no :: object init)
2654 // php5 runs now through, just one wrong XmlElement object init missing
2655 // Removed unneccesary UpgradeUser lines
2656 // Changed WikiLink to omit version if current (RecentChanges)
2658 // Revision 1.43 2004/04/18 01:34:20 rurban
2659 // protect most_popular from sortby=mtime
2661 // Revision 1.42 2004/04/18 01:11:51 rurban
2662 // more numeric pagename fixes.
2663 // fixed action=upload with merge conflict warnings.
2664 // charset changed from constant to global (dynamic utf-8 switching)
2670 // c-basic-offset: 4
2671 // c-hanging-comment-ender-p: nil
2672 // indent-tabs-mode: nil