2 rcs_id('$Id: WikiDB.php,v 1.159 2008-03-22 21:51:11 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>
12 * Minor enhancements by Reini Urban
16 * Force the creation of a new revision.
17 * @see WikiDB_Page::createRevision()
19 if (!defined('WIKIDB_FORCE_CREATE'))
20 define('WIKIDB_FORCE_CREATE', -1);
23 * Abstract base class for the database used by PhpWiki.
25 * A <tt>WikiDB</tt> is a container for <tt>WikiDB_Page</tt>s which in
26 * turn contain <tt>WikiDB_PageRevision</tt>s.
28 * Conceptually a <tt>WikiDB</tt> contains all possible
29 * <tt>WikiDB_Page</tt>s, whether they have been initialized or not.
30 * Since all possible pages are already contained in a WikiDB, a call
31 * to WikiDB::getPage() will never fail (barring bugs and
32 * e.g. filesystem or SQL database problems.)
34 * Also each <tt>WikiDB_Page</tt> always contains at least one
35 * <tt>WikiDB_PageRevision</tt>: the default content (e.g. "Describe
36 * [PageName] here."). This default content has a version number of
39 * <tt>WikiDB_PageRevision</tt>s have read-only semantics. One can
40 * only create new revisions or delete old ones --- one can not modify
41 * an existing revision.
45 * Open a WikiDB database.
47 * This is a static member function. This function inspects its
48 * arguments to determine the proper subclass of WikiDB to
49 * instantiate, and then it instantiates it.
53 * @param hash $dbparams Database configuration parameters.
54 * Some pertinent parameters are:
57 * <dd> The back-end type. Current supported types are:
60 * <dd> Generic SQL backend based on the PEAR/DB database abstraction
61 * library. (More stable and conservative)
63 * <dd> Another generic SQL backend. (More current features are tested here. Much faster)
65 * <dd> Dba based backend. The default and by far the fastest.
73 * <dd> (Used by the SQL and ADODB backends.)
74 * The DSN specifying which database to connect to.
77 * <dd> Prefix to be prepended to database tables (and file names).
80 * <dd> (Used by the dba backend.)
81 * Which directory db files reside in.
84 * <dd> Used only by the dba backend so far.
85 * And: When optimizing mysql it closes timed out mysql processes.
86 * otherwise only used for dba: Timeout in seconds for opening (and
87 * obtaining lock) on the dbm file.
90 * <dd> (Used by the dba backend.)
92 * Which dba handler to use. Good choices are probably either
96 * @return WikiDB A WikiDB object.
98 function open ($dbparams) {
99 $dbtype = $dbparams{'dbtype'};
100 include_once("lib/WikiDB/$dbtype.php");
102 $class = 'WikiDB_' . $dbtype;
103 return new $class ($dbparams);
113 function WikiDB (&$backend, $dbparams) {
114 $this->_backend =& $backend;
115 // don't do the following with the auth_dsn!
116 if (isset($dbparams['auth_dsn'])) return;
118 $this->_cache = new WikiDB_cache($backend);
119 if (!empty($GLOBALS['request'])) $GLOBALS['request']->_dbi = $this;
121 // If the database doesn't yet have a timestamp, initialize it now.
122 if ($this->get('_timestamp') === false)
126 if ((int)DEBUG & _DEBUG_SQL) {
127 $this->_backend->check();
132 * Close database connection.
134 * The database may no longer be used after it is closed.
136 * Closing a WikiDB invalidates all <tt>WikiDB_Page</tt>s,
137 * <tt>WikiDB_PageRevision</tt>s and <tt>WikiDB_PageIterator</tt>s
138 * which have been obtained from it.
143 $this->_backend->close();
144 $this->_cache->close();
148 * Get a WikiDB_Page from a WikiDB.
150 * A {@link WikiDB} consists of the (infinite) set of all possible pages,
151 * therefore this method never fails.
154 * @param string $pagename Which page to get.
155 * @return WikiDB_Page The requested WikiDB_Page.
157 function getPage($pagename) {
158 static $error_displayed = false;
159 $pagename = (string) $pagename;
161 if ($pagename === '') {
162 if ($error_displayed) return false;
163 $error_displayed = true;
164 if (function_exists("xdebug_get_function_stack"))
165 var_dump(xdebug_get_function_stack());
166 trigger_error("empty pagename", E_USER_WARNING);
170 assert($pagename != '');
172 return new WikiDB_Page($this, $pagename);
176 * Determine whether page exists (in non-default form).
179 * $is_page = $dbi->isWikiPage($pagename);
183 * $page = $dbi->getPage($pagename);
184 * $current = $page->getCurrentRevision();
185 * $is_page = ! $current->hasDefaultContents();
187 * however isWikiPage may be implemented in a more efficient
188 * manner in certain back-ends.
191 * @param string $pagename string Which page to check.
192 * @return boolean True if the page actually exists with
193 * non-default contents in the WikiDataBase.
195 function isWikiPage ($pagename) {
196 $page = $this->getPage($pagename);
197 return ($page and $page->exists());
201 * Delete page from the WikiDB.
203 * Deletes the page from the WikiDB with the possibility to revert and diff.
204 * //Also resets all page meta-data to the default values.
206 * Note: purgePage() effectively destroys all revisions of the page from the WikiDB.
209 * @param string $pagename Name of page to delete.
212 function deletePage($pagename) {
213 // don't create empty revisions of already purged pages.
214 if ($this->_backend->get_latest_version($pagename))
215 $result = $this->_cache->delete_page($pagename);
219 /* Generate notification emails */
220 if (ENABLE_MAILNOTIFY) {
221 include_once("lib/MailNotify.php");
222 $MailNotify = new MailNotify($pagename);
223 $MailNotify->onDeletePage ($this, $pagename);
226 //How to create a RecentChanges entry with explaining summary? Dynamically
228 $page = $this->getPage($pagename);
229 $current = $page->getCurrentRevision();
230 $meta = $current->_data;
231 $version = $current->getVersion();
232 $meta['summary'] = _("removed");
233 $page->save($current->getPackedContent(), $version + 1, $meta);
239 * Completely remove the page from the WikiDB, without undo possibility.
241 * @param string $pagename Name of page to delete.
244 function purgePage($pagename) {
245 $result = $this->_cache->purge_page($pagename);
246 $this->deletePage($pagename); // just for the notification
251 * Retrieve all pages.
253 * Gets the set of all pages with non-default contents.
257 * @param boolean $include_empty Optional. Normally pages whose most
258 * recent revision has empty content are considered to be
259 * non-existant. Unless $include_defaulted is set to true, those
260 * pages will not be returned.
261 * @param string or false $sortby Optional. "+-column,+-column2".
262 * If false the result is faster in natural order.
263 * @param string or false $limit Optional. Encoded as "$offset,$count".
264 * $offset defaults to 0.
265 * @param string $exclude: Optional comma-seperated list of pagenames.
267 * @return WikiDB_PageIterator A WikiDB_PageIterator which contains all pages
268 * in the WikiDB which have non-default contents.
270 function getAllPages($include_empty=false, $sortby='', $limit='', $exclude='')
272 // HACK: memory_limit=8M will fail on too large pagesets. old php on unix only!
274 $mem = ini_get("memory_limit");
275 if ($mem and !$limit and !isWindows() and !check_php_version(4,3)) {
277 $GLOBALS['request']->setArg('limit', $limit);
278 $GLOBALS['request']->setArg('paging', 'auto');
281 $result = $this->_backend->get_all_pages($include_empty, $sortby, $limit,
283 return new WikiDB_PageIterator($this, $result,
284 array('include_empty' => $include_empty,
285 'exclude' => $exclude,
292 * @param boolean $include_empty If true include also empty pages
293 * @param string $exclude: comma-seperated list of pagenames.
294 * TBD: array of pagenames
298 function numPages($include_empty=false, $exclude='') {
299 if (method_exists($this->_backend, 'numPages'))
300 // FIXME: currently are all args ignored.
301 $count = $this->_backend->numPages($include_empty, $exclude);
303 // FIXME: exclude ignored.
304 $iter = $this->getAllPages($include_empty, false, false, $exclude);
305 $count = $iter->count();
314 * Search for pages containing (or not containing) certain words
317 * Pages are returned in alphabetical order whenever it is
318 * practical to do so.
319 * TODO: Sort by ranking. Only postgresql with tsearch2 can do ranking so far.
322 * @param TextSearchQuery $search A TextSearchQuery object
323 * @param string or false $sortby Optional. "+-column,+-column2".
324 * If false the result is faster in natural order.
325 * @param string or false $limit Optional. Encoded as "$offset,$count".
326 * $offset defaults to 0.
327 * @param string $exclude: Optional comma-seperated list of pagenames.
328 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
329 * @see TextSearchQuery
331 function titleSearch($search, $sortby='pagename', $limit='', $exclude='') {
332 $result = $this->_backend->text_search($search, false, $sortby, $limit, $exclude);
333 $options = array('exclude' => $exclude,
335 //if (isset($result->_count)) $options['count'] = $result->_count;
336 return new WikiDB_PageIterator($this, $result, $options);
342 * Search for pages containing (or not containing) certain words
343 * in their entire text (this includes the page content and the
346 * Pages are returned in alphabetical order whenever it is
347 * practical to do so.
348 * TODO: Sort by ranking. Only postgresql with tsearch2 can do ranking so far.
352 * @param TextSearchQuery $search A TextSearchQuery object.
353 * @param string or false $sortby Optional. "+-column,+-column2".
354 * If false the result is faster in natural order.
355 * @param string or false $limit Optional. Encoded as "$offset,$count".
356 * $offset defaults to 0.
357 * @param string $exclude: Optional comma-seperated list of pagenames.
358 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
359 * @see TextSearchQuery
361 function fullSearch($search, $sortby='pagename', $limit='', $exclude='') {
362 $result = $this->_backend->text_search($search, true, $sortby, $limit, $exclude);
363 return new WikiDB_PageIterator($this, $result,
364 array('exclude' => $exclude,
366 'stoplisted' => $result->stoplisted
371 * Find the pages with the greatest hit counts.
373 * Pages are returned in reverse order by hit count.
377 * @param integer $limit The maximum number of pages to return.
378 * Set $limit to zero to return all pages. If $limit < 0, pages will
379 * be sorted in decreasing order of popularity.
380 * @param string or false $sortby Optional. "+-column,+-column2".
381 * If false the result is faster in natural order.
383 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching
386 function mostPopular($limit = 20, $sortby = '-hits') {
387 $result = $this->_backend->most_popular($limit, $sortby);
388 return new WikiDB_PageIterator($this, $result);
392 * Find recent page revisions.
394 * Revisions are returned in reverse order by creation time.
398 * @param hash $params This hash is used to specify various optional
402 * <dd> (integer) At most this many revisions will be returned.
404 * <dd> (integer) Only revisions since this time (unix-timestamp)
406 * <dt> include_minor_revisions
407 * <dd> (boolean) Also include minor revisions. (Default is not to.)
408 * <dt> exclude_major_revisions
409 * <dd> (boolean) Don't include non-minor revisions.
410 * (Exclude_major_revisions implies include_minor_revisions.)
411 * <dt> include_all_revisions
412 * <dd> (boolean) Return all matching revisions for each page.
413 * Normally only the most recent matching revision is returned
417 * @return WikiDB_PageRevisionIterator A WikiDB_PageRevisionIterator
418 * containing the matching revisions.
420 function mostRecent($params = false) {
421 $result = $this->_backend->most_recent($params);
422 return new WikiDB_PageRevisionIterator($this, $result);
428 * @param string or false $sortby Optional. "+-column,+-column2".
429 * If false the result is faster in natural order.
430 * @param string or false $limit Optional. Encoded as "$offset,$count".
431 * $offset defaults to 0.
432 * @return Iterator A generic iterator containing rows of
433 * (duplicate) pagename, wantedfrom.
435 function wantedPages($exclude_from='', $exclude='', $sortby='', $limit='') {
436 return $this->_backend->wanted_pages($exclude_from, $exclude, $sortby, $limit);
437 //return new WikiDB_PageIterator($this, $result);
441 * Generic interface to the link table. Esp. useful to search for rdf triples as in
442 * SemanticSearch and ListRelations.
446 * @param $pages object A TextSearchQuery object.
447 * @param $search object A TextSearchQuery object.
448 * @param string $linktype One of "linkto", "linkfrom", "relation", "attribute".
449 * linktype parameter:
452 * <dd> search for simple out-links
454 * <dd> in-links, i.e BackLinks
456 * <dd> the first part in a <>::<> link
458 * <dd> the first part in a <>:=<> link
460 * @param $relation object An optional TextSearchQuery to match the
461 * relation name. Ignored on simple in-out links.
463 * @return Iterator A generic iterator containing links to pages or values.
464 * hash of "pagename", "linkname", "linkvalue.
466 function linkSearch($pages, $search, $linktype, $relation=false) {
467 return $this->_backend->link_search($pages, $search, $linktype, $relation);
471 * Return a simple list of all defined relations (and attributes), mainly
472 * for the SemanticSearch autocompletion.
476 * @return array of strings
478 function listRelations($also_attributes=false, $only_attributes=false, $sorted=true) {
479 if (method_exists($this->_backend, "list_relations"))
480 return $this->_backend->list_relations($also_attributes, $only_attributes, $sorted);
481 // dumb, slow fallback. no iter, so simply define it here.
482 $relations = array();
483 $iter = $this->getAllPages();
484 while ($page = $iter->next()) {
485 $reliter = $page->getRelations();
487 while ($rel = $reliter->next()) {
488 // if there's no pagename it's an attribute
489 $names[] = $rel->getName();
491 $relations = array_merge($relations, $names);
503 * Call the appropriate backend method.
506 * @param string $from Page to rename
507 * @param string $to New name
508 * @param boolean $updateWikiLinks If the text in all pages should be replaced.
509 * @return boolean true or false
511 function renamePage($from, $to, $updateWikiLinks = false) {
512 assert(is_string($from) && $from != '');
513 assert(is_string($to) && $to != '');
515 if (method_exists($this->_backend, 'rename_page')) {
516 $oldpage = $this->getPage($from);
517 $newpage = $this->getPage($to);
518 //update all WikiLinks in existing pages
519 //non-atomic! i.e. if rename fails the links are not undone
520 if ($updateWikiLinks) {
521 $lookbehind = "/(?<=[\W:])\Q";
522 $lookahead = "\E(?=[\W:])/";
523 if (!check_php_version(4,3,3)) {
524 $lookbehind = "/(?<=[\W:])";
525 $lookahead = "(?=[\W:])/";
526 $from = preg_quote($from, "/");
527 $to = preg_quote($to, "/");
529 require_once('lib/plugin/WikiAdminSearchReplace.php');
530 $links = $oldpage->getBackLinks();
531 while ($linked_page = $links->next()) {
532 WikiPlugin_WikiAdminSearchReplace::replaceHelper
534 $linked_page->getName(),
535 $lookbehind.$from.$lookahead, $to,
539 if ($oldpage->exists() and ! $newpage->exists()) {
540 if ($result = $this->_backend->rename_page($from, $to)) {
541 // create a RecentChanges entry with explaining summary
542 $page = $this->getPage($to);
543 $current = $page->getCurrentRevision();
544 $meta = $current->_data;
545 $version = $current->getVersion();
546 $meta['summary'] = sprintf(_("renamed from %s"), $from);
547 unset($meta['mtime']); // force new date
548 $page->save($current->getPackedContent(), $version + 1, $meta);
550 } elseif (!$oldpage->getCurrentRevision(false) and !$newpage->exists()) {
551 // if a version 0 exists try it also.
552 $result = $this->_backend->rename_page($from, $to);
555 trigger_error(_("WikiDB::renamePage() not yet implemented for this backend"),
558 /* Generate notification emails? */
559 if ($result and ENABLE_MAILNOTIFY and !isa($GLOBALS['request'], 'MockRequest')) {
560 $notify = $this->get('notify');
561 if (!empty($notify) and is_array($notify)) {
562 include_once("lib/MailNotify.php");
563 $MailNotify = new MailNotify($from);
564 $MailNotify->onRenamePage ($this, $from, $to);
570 /** Get timestamp when database was last modified.
572 * @return string A string consisting of two integers,
573 * separated by a space. The first is the time in
574 * unix timestamp format, the second is a modification
575 * count for the database.
577 * The idea is that you can cast the return value to an
578 * int to get a timestamp, or you can use the string value
579 * as a good hash for the entire database.
581 function getTimestamp() {
582 $ts = $this->get('_timestamp');
583 return sprintf("%d %d", $ts[0], $ts[1]);
587 * Update the database timestamp.
591 $ts = $this->get('_timestamp');
592 $this->set('_timestamp', array(time(), $ts[1] + 1));
596 * Roughly similar to the float in phpwiki_version(). Set by action=upgrade.
598 function get_db_version() {
599 return (float) $this->get('_db_version');
601 function set_db_version($ver) {
602 return $this->set('_db_version', (float)$ver);
606 * Access WikiDB global meta-data.
608 * NOTE: this is currently implemented in a hackish and
609 * not very efficient manner.
613 * @param string $key Which meta data to get.
614 * Some reserved meta-data keys are:
616 * <dt>'_timestamp' <dd> Data used by getTimestamp().
619 * @return scalar The requested value, or false if the requested data
623 if (!$key || $key[0] == '%')
626 * Hack Alert: We can use any page (existing or not) to store
627 * this data (as long as we always use the same one.)
629 $gd = $this->getPage('global_data');
630 $data = $gd->get('__global');
632 if ($data && isset($data[$key]))
639 * Set global meta-data.
641 * NOTE: this is currently implemented in a hackish and
642 * not very efficient manner.
647 * @param string $key Meta-data key to set.
648 * @param string $newval New value.
650 function set($key, $newval) {
651 if (!$key || $key[0] == '%')
654 $gd = $this->getPage('global_data');
655 $data = $gd->get('__global');
662 $data[$key] = $newval;
664 $gd->set('__global', $data);
667 /* TODO: these are really backend methods */
669 // SQL result: for simple select or create/update queries
670 // returns the database specific resource type
671 function genericSqlQuery($sql, $args=false) {
672 if (function_exists('debug_backtrace')) { // >= 4.3.0
673 echo "<pre>", printSimpleTrace(debug_backtrace()), "</pre>\n";
675 trigger_error("no SQL database", E_USER_ERROR);
679 // SQL iter: for simple select or create/update queries
680 // returns the generic iterator object (count,next)
681 function genericSqlIter($sql, $field_list = NULL) {
682 if (function_exists('debug_backtrace')) { // >= 4.3.0
683 echo "<pre>", printSimpleTrace(debug_backtrace()), "</pre>\n";
685 trigger_error("no SQL database", E_USER_ERROR);
689 // see backend upstream methods
690 // ADODB adds surrounding quotes, SQL not yet!
691 function quote ($s) {
697 if (!$request->_dbi) return false;
698 else return false; /* so far only needed for sql so false it.
699 later we have to check dba also */
702 function getParam($param) {
704 if (isset($DBParams[$param])) return $DBParams[$param];
705 elseif ($param == 'prefix') return '';
709 function getAuthParam($param) {
710 global $DBAuthParams;
711 if (isset($DBAuthParams[$param])) return $DBAuthParams[$param];
712 elseif ($param == 'USER_AUTH_ORDER') return $GLOBALS['USER_AUTH_ORDER'];
713 elseif ($param == 'USER_AUTH_POLICY') return $GLOBALS['USER_AUTH_POLICY'];
720 * An abstract base class which representing a wiki-page within a
723 * A WikiDB_Page contains a number (at least one) of
724 * WikiDB_PageRevisions.
728 function WikiDB_Page(&$wikidb, $pagename) {
729 $this->_wikidb = &$wikidb;
730 $this->_pagename = $pagename;
732 if (!(is_string($pagename) and $pagename != '')) {
733 if (function_exists("xdebug_get_function_stack")) {
734 echo "xdebug_get_function_stack(): "; var_dump(xdebug_get_function_stack());
735 } elseif (function_exists("debug_backtrace")) { // >= 4.3.0
736 printSimpleTrace(debug_backtrace());
738 trigger_error("empty pagename", E_USER_WARNING);
742 assert(is_string($pagename) and $pagename != '');
747 * Get the name of the wiki page.
751 * @return string The page name.
754 return $this->_pagename;
757 // To reduce the memory footprint for larger sets of pagelists,
758 // we don't cache the content (only true or false) and
759 // we purge the pagedata (_cached_html) also
761 if (isset($this->_wikidb->_cache->_id_cache[$this->_pagename])) return true;
762 $current = $this->getCurrentRevision(false);
763 if (!$current) return false;
764 return ! $current->hasDefaultContents();
768 * Delete an old revision of a WikiDB_Page.
770 * Deletes the specified revision of the page.
771 * It is a fatal error to attempt to delete the current revision.
775 * @param integer $version Which revision to delete. (You can also
776 * use a WikiDB_PageRevision object here.)
778 function deleteRevision($version) {
779 $backend = &$this->_wikidb->_backend;
780 $cache = &$this->_wikidb->_cache;
781 $pagename = &$this->_pagename;
783 $version = $this->_coerce_to_version($version);
787 $backend->lock(array('page','version'));
788 $latestversion = $cache->get_latest_version($pagename);
789 if ($latestversion && ($version == $latestversion)) {
790 $backend->unlock(array('page','version'));
791 trigger_error(sprintf("Attempt to delete most recent revision of '%s'",
792 $pagename), E_USER_ERROR);
796 $cache->delete_versiondata($pagename, $version);
797 $backend->unlock(array('page','version'));
801 * Delete a revision, or possibly merge it with a previous
805 * Suppose an author make a (major) edit to a page. Shortly
806 * after that the same author makes a minor edit (e.g. to fix
807 * spelling mistakes he just made.)
809 * Now some time later, where cleaning out old saved revisions,
810 * and would like to delete his minor revision (since there's
811 * really no point in keeping minor revisions around for a long
814 * Note that the text after the minor revision probably represents
815 * what the author intended to write better than the text after
816 * the preceding major edit.
818 * So what we really want to do is merge the minor edit with the
821 * We will only do this when:
823 * <li>The revision being deleted is a minor one, and
824 * <li>It has the same author as the immediately preceding revision.
827 function mergeRevision($version) {
828 $backend = &$this->_wikidb->_backend;
829 $cache = &$this->_wikidb->_cache;
830 $pagename = &$this->_pagename;
832 $version = $this->_coerce_to_version($version);
836 $backend->lock(array('version'));
837 $latestversion = $cache->get_latest_version($pagename);
838 if ($latestversion && $version == $latestversion) {
839 $backend->unlock(array('version'));
840 trigger_error(sprintf("Attempt to merge most recent revision of '%s'",
841 $pagename), E_USER_ERROR);
845 $versiondata = $cache->get_versiondata($pagename, $version, true);
847 // Not there? ... we're done!
848 $backend->unlock(array('version'));
852 if ($versiondata['is_minor_edit']) {
853 $previous = $backend->get_previous_version($pagename, $version);
855 $prevdata = $cache->get_versiondata($pagename, $previous);
856 if ($prevdata['author_id'] == $versiondata['author_id']) {
857 // This is a minor revision, previous version is
858 // by the same author. We will merge the
860 $cache->update_versiondata($pagename, $previous,
861 array('%content' => $versiondata['%content'],
862 '_supplanted' => $versiondata['_supplanted']));
867 $cache->delete_versiondata($pagename, $version);
868 $backend->unlock(array('version'));
873 * Create a new revision of a {@link WikiDB_Page}.
877 * @param int $version Version number for new revision.
878 * To ensure proper serialization of edits, $version must be
879 * exactly one higher than the current latest version.
880 * (You can defeat this check by setting $version to
881 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
883 * @param string $content Contents of new revision.
885 * @param hash $metadata Metadata for new revision.
886 * All values in the hash should be scalars (strings or integers).
888 * @param hash $links List of linkto=>pagename, relation=>pagename which this page links to.
890 * @return WikiDB_PageRevision Returns the new WikiDB_PageRevision object. If
891 * $version was incorrect, returns false
893 function createRevision($version, &$content, $metadata, $links) {
894 $backend = &$this->_wikidb->_backend;
895 $cache = &$this->_wikidb->_cache;
896 $pagename = &$this->_pagename;
897 $cache->invalidate_cache($pagename);
899 $backend->lock(array('version','page','recent','link','nonempty'));
901 $latestversion = $backend->get_latest_version($pagename);
902 $newversion = ($latestversion ? $latestversion : 0) + 1;
903 assert($newversion >= 1);
905 if ($version != WIKIDB_FORCE_CREATE and $version != $newversion) {
906 $backend->unlock(array('version','page','recent','link','nonempty'));
912 foreach ($data as $key => $val) {
913 if (empty($val) || $key[0] == '_' || $key[0] == '%')
917 assert(!empty($data['author']));
918 if (empty($data['author_id']))
919 @$data['author_id'] = $data['author'];
921 if (empty($data['mtime']))
922 $data['mtime'] = time();
924 if ($latestversion and $version != WIKIDB_FORCE_CREATE) {
925 // Ensure mtimes are monotonic.
926 $pdata = $cache->get_versiondata($pagename, $latestversion);
927 if ($data['mtime'] < $pdata['mtime']) {
928 trigger_error(sprintf(_("%s: Date of new revision is %s"),
929 $pagename,"'non-monotonic'"),
931 $data['orig_mtime'] = $data['mtime'];
932 $data['mtime'] = $pdata['mtime'];
935 // FIXME: use (possibly user specified) 'mtime' time or
937 $cache->update_versiondata($pagename, $latestversion,
938 array('_supplanted' => $data['mtime']));
941 $data['%content'] = &$content;
943 $cache->set_versiondata($pagename, $newversion, $data);
945 //$cache->update_pagedata($pagename, array(':latestversion' => $newversion,
946 //':deleted' => empty($content)));
948 $backend->set_links($pagename, $links);
950 $backend->unlock(array('version','page','recent','link','nonempty'));
952 return new WikiDB_PageRevision($this->_wikidb, $pagename, $newversion,
956 /** A higher-level interface to createRevision.
958 * This takes care of computing the links, and storing
959 * a cached version of the transformed wiki-text.
961 * @param string $wikitext The page content.
963 * @param int $version Version number for new revision.
964 * To ensure proper serialization of edits, $version must be
965 * exactly one higher than the current latest version.
966 * (You can defeat this check by setting $version to
967 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
969 * @param hash $meta Meta-data for new revision.
971 function save($wikitext, $version, $meta, $formatted = null) {
972 if (is_null($formatted))
973 $formatted = new TransformedText($this, $wikitext, $meta);
974 $type = $formatted->getType();
975 $meta['pagetype'] = $type->getName();
976 $links = $formatted->getWikiPageLinks(); // linkto => relation
977 $attributes = array();
978 foreach ($links as $link) {
979 if ($link['linkto'] === "" and $link['relation']) {
980 $attributes[$link['relation']] = $this->getAttribute($link['relation']);
983 $meta['attribute'] = $attributes;
985 $backend = &$this->_wikidb->_backend;
986 $newrevision = $this->createRevision($version, $wikitext, $meta, $links);
987 if ($newrevision and !WIKIDB_NOCACHE_MARKUP)
988 $this->set('_cached_html', $formatted->pack());
990 // FIXME: probably should have some global state information
991 // in the backend to control when to optimize.
993 // We're doing this here rather than in createRevision because
994 // postgresql can't optimize while locked.
995 if (((int)DEBUG & _DEBUG_SQL)
996 or (DATABASE_OPTIMISE_FREQUENCY > 0 and
997 (time() % DATABASE_OPTIMISE_FREQUENCY == 0))) {
998 if ($backend->optimize()) {
1000 trigger_error(_("Optimizing database"), E_USER_NOTICE);
1004 /* Generate notification emails? */
1005 if (ENABLE_MAILNOTIFY and isa($newrevision, 'WikiDB_PageRevision')) {
1006 // Save didn't fail because of concurrent updates.
1007 $notify = $this->_wikidb->get('notify');
1009 and is_array($notify)
1010 and !isa($GLOBALS['request'],'MockRequest'))
1012 include_once("lib/MailNotify.php");
1013 $MailNotify = new MailNotify($newrevision->getName());
1014 $MailNotify->onChangePage ($this->_wikidb, $wikitext, $version, $meta);
1016 $newrevision->_transformedContent = $formatted;
1019 return $newrevision;
1023 * Get the most recent revision of a page.
1027 * @return WikiDB_PageRevision The current WikiDB_PageRevision object.
1029 function getCurrentRevision ($need_content=true) {
1030 $backend = &$this->_wikidb->_backend;
1031 $cache = &$this->_wikidb->_cache;
1032 $pagename = &$this->_pagename;
1034 // Prevent deadlock in case of memory exhausted errors
1035 // Pure selection doesn't really need locking here.
1036 // sf.net bug#927395
1037 // I know it would be better to lock, but with lots of pages this deadlock is more
1038 // severe than occasionally get not the latest revision.
1039 // In spirit to wikiwiki: read fast, edit slower.
1041 $version = $cache->get_latest_version($pagename);
1042 // getRevision gets the content also!
1043 $revision = $this->getRevision($version, $need_content);
1044 //$backend->unlock();
1050 * Get a specific revision of a WikiDB_Page.
1054 * @param integer $version Which revision to get.
1056 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or
1057 * false if the requested revision does not exist in the {@link WikiDB}.
1058 * Note that version zero of any page always exists.
1060 function getRevision ($version, $need_content=true) {
1061 $cache = &$this->_wikidb->_cache;
1062 $pagename = &$this->_pagename;
1064 if (! $version or $version == -1) // 0 or false
1065 return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
1067 assert($version > 0);
1068 $vdata = $cache->get_versiondata($pagename, $version, $need_content);
1070 return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
1072 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1077 * Get previous page revision.
1079 * This method find the most recent revision before a specified
1084 * @param integer $version Find most recent revision before this version.
1085 * You can also use a WikiDB_PageRevision object to specify the $version.
1087 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or false if the
1088 * requested revision does not exist in the {@link WikiDB}. Note that
1089 * unless $version is greater than zero, a revision (perhaps version zero,
1090 * the default revision) will always be found.
1092 function getRevisionBefore ($version=false, $need_content=true) {
1093 $backend = &$this->_wikidb->_backend;
1094 $pagename = &$this->_pagename;
1095 if ($version === false)
1096 $version = $this->_wikidb->_cache->get_latest_version($pagename);
1098 $version = $this->_coerce_to_version($version);
1103 $previous = $backend->get_previous_version($pagename, $version);
1104 $revision = $this->getRevision($previous, $need_content);
1105 //$backend->unlock();
1111 * Get all revisions of the WikiDB_Page.
1113 * This does not include the version zero (default) revision in the
1114 * returned revision set.
1116 * @return WikiDB_PageRevisionIterator A
1117 * WikiDB_PageRevisionIterator containing all revisions of this
1118 * WikiDB_Page in reverse order by version number.
1120 function getAllRevisions() {
1121 $backend = &$this->_wikidb->_backend;
1122 $revs = $backend->get_all_revisions($this->_pagename);
1123 return new WikiDB_PageRevisionIterator($this->_wikidb, $revs);
1127 * Find pages which link to or are linked from a page.
1128 * relations: $backend->get_links is responsible to add the relation to the pagehash
1129 * as 'linkrelation' key as pagename. See WikiDB_PageIterator::next
1130 * if (isset($next['linkrelation']))
1134 * @param boolean $reversed Which links to find: true for backlinks (default).
1136 * @return WikiDB_PageIterator A WikiDB_PageIterator containing
1137 * all matching pages.
1139 function getLinks ($reversed=true, $include_empty=false, $sortby='',
1140 $limit='', $exclude='', $want_relations=false)
1142 $backend = &$this->_wikidb->_backend;
1143 $result = $backend->get_links($this->_pagename, $reversed,
1144 $include_empty, $sortby, $limit, $exclude,
1146 return new WikiDB_PageIterator($this->_wikidb, $result,
1147 array('include_empty' => $include_empty,
1148 'sortby' => $sortby,
1150 'exclude' => $exclude,
1151 'want_relations'=> $want_relations));
1155 * All Links from other pages to this page.
1157 function getBackLinks($include_empty=false, $sortby='', $limit='', $exclude='',
1158 $want_relations=false)
1160 return $this->getLinks(true, $include_empty, $sortby, $limit, $exclude);
1163 * Forward Links: All Links from this page to other pages.
1165 function getPageLinks($include_empty=false, $sortby='', $limit='', $exclude='',
1166 $want_relations=false)
1168 return $this->getLinks(false, $include_empty, $sortby, $limit, $exclude);
1171 * Relations: All links from this page to other pages with relation <> 0.
1172 * is_a:=page or population:=number
1174 function getRelations($sortby='', $limit='', $exclude='') {
1175 $backend = &$this->_wikidb->_backend;
1176 $result = $backend->get_links($this->_pagename, false, true,
1177 $sortby, $limit, $exclude,
1179 // we do not care for the linked page versiondata, just the pagename and linkrelation
1180 return new WikiDB_PageIterator($this->_wikidb, $result,
1181 array('include_empty' => true,
1182 'sortby' => $sortby,
1184 'exclude' => $exclude,
1185 'want_relations'=> true));
1189 * possibly faster link existance check. not yet accelerated.
1191 function existLink($link, $reversed=false) {
1192 $backend = &$this->_wikidb->_backend;
1193 if (method_exists($backend,'exists_link'))
1194 return $backend->exists_link($this->_pagename, $link, $reversed);
1195 //$cache = &$this->_wikidb->_cache;
1196 // TODO: check cache if it is possible
1197 $iter = $this->getLinks($reversed, false);
1198 while ($page = $iter->next()) {
1199 if ($page->getName() == $link)
1206 /* Semantic relations are links with the relation pointing to another page,
1207 the so-called "RDF Triple".
1208 [San Diego] is%20a::city
1209 => "At the page San Diego there is a relation link of 'is a' to the page 'city'."
1212 /* Semantic attributes for a page.
1213 [San Diego] population:=1,305,736
1214 Attributes are links with the relation pointing to another page.
1218 * Access WikiDB_Page non version-specific meta-data.
1222 * @param string $key Which meta data to get.
1223 * Some reserved meta-data keys are:
1225 * <dt>'date' <dd> Created as unixtime
1226 * <dt>'locked'<dd> Is page locked? 'yes' or 'no'
1227 * <dt>'hits' <dd> Page hit counter.
1228 * <dt>'_cached_html' <dd> Transformed CachedMarkup object, serialized + optionally gzipped.
1229 * In SQL stored now in an extra column.
1231 * <dt>'pref' <dd> Users preferences, stored only in homepages.
1232 * <dt>'owner' <dd> Default: first author_id. We might add a group with a dot here:
1233 * E.g. "owner.users"
1234 * <dt>'perm' <dd> Permission flag to authorize read/write/execution of
1235 * page-headers and content.
1236 + <dt>'moderation'<dd> ModeratedPage data
1237 * <dt>'score' <dd> Page score (not yet implement, do we need?)
1240 * @return scalar The requested value, or false if the requested data
1243 function get($key) {
1244 $cache = &$this->_wikidb->_cache;
1245 $backend = &$this->_wikidb->_backend;
1246 if (!$key || $key[0] == '%')
1248 // several new SQL backends optimize this.
1249 if (!WIKIDB_NOCACHE_MARKUP
1250 and $key == '_cached_html'
1251 and method_exists($backend, 'get_cached_html'))
1253 return $backend->get_cached_html($this->_pagename);
1255 $data = $cache->get_pagedata($this->_pagename);
1256 return isset($data[$key]) ? $data[$key] : false;
1260 * Get all the page meta-data as a hash.
1262 * @return hash The page meta-data.
1264 function getMetaData() {
1265 $cache = &$this->_wikidb->_cache;
1266 $data = $cache->get_pagedata($this->_pagename);
1268 foreach ($data as $key => $val) {
1269 if (/*!empty($val) &&*/ $key[0] != '%')
1276 * Set page meta-data.
1281 * @param string $key Meta-data key to set.
1282 * @param string $newval New value.
1284 function set($key, $newval) {
1285 $cache = &$this->_wikidb->_cache;
1286 $backend = &$this->_wikidb->_backend;
1287 $pagename = &$this->_pagename;
1289 assert($key && $key[0] != '%');
1291 // several new SQL backends optimize this.
1292 if (!WIKIDB_NOCACHE_MARKUP
1293 and $key == '_cached_html'
1294 and method_exists($backend, 'set_cached_html'))
1296 return $backend->set_cached_html($pagename, $newval);
1299 $data = $cache->get_pagedata($pagename);
1301 if (!empty($newval)) {
1302 if (!empty($data[$key]) && $data[$key] == $newval)
1303 return; // values identical, skip update.
1306 if (empty($data[$key]))
1307 return; // values identical, skip update.
1310 $cache->update_pagedata($pagename, array($key => $newval));
1314 * Increase page hit count.
1316 * FIXME: IS this needed? Probably not.
1318 * This is a convenience function.
1319 * <pre> $page->increaseHitCount(); </pre>
1320 * is functionally identical to
1321 * <pre> $page->set('hits',$page->get('hits')+1); </pre>
1322 * but less expensive (ignores the pagadata string)
1324 * Note that this method may be implemented in more efficient ways
1325 * in certain backends.
1329 function increaseHitCount() {
1330 if (method_exists($this->_wikidb->_backend, 'increaseHitCount'))
1331 $this->_wikidb->_backend->increaseHitCount($this->_pagename);
1333 @$newhits = $this->get('hits') + 1;
1334 $this->set('hits', $newhits);
1339 * Return a string representation of the WikiDB_Page
1341 * This is really only for debugging.
1345 * @return string Printable representation of the WikiDB_Page.
1347 function asString () {
1349 printf("[%s:%s\n", get_class($this), $this->getName());
1350 print_r($this->getMetaData());
1352 $strval = ob_get_contents();
1360 * @param integer_or_object $version_or_pagerevision
1361 * Takes either the version number (and int) or a WikiDB_PageRevision
1363 * @return integer The version number.
1365 function _coerce_to_version($version_or_pagerevision) {
1366 if (method_exists($version_or_pagerevision, "getContent"))
1367 $version = $version_or_pagerevision->getVersion();
1369 $version = (int) $version_or_pagerevision;
1371 assert($version >= 0);
1375 function isUserPage ($include_empty = true) {
1376 if (!$include_empty and !$this->exists()) return false;
1377 return $this->get('pref') ? true : false;
1380 // May be empty. Either the stored owner (/Chown), or the first authorized author
1381 function getOwner() {
1382 if ($owner = $this->get('owner'))
1383 return ($owner == _("The PhpWiki programming team")) ? ADMIN_USER : $owner;
1384 // check all revisions forwards for the first author_id
1385 $backend = &$this->_wikidb->_backend;
1386 $pagename = &$this->_pagename;
1387 $latestversion = $backend->get_latest_version($pagename);
1388 for ($v=1; $v <= $latestversion; $v++) {
1389 $rev = $this->getRevision($v,false);
1390 if ($rev and $owner = $rev->get('author_id')) {
1391 return ($owner == _("The PhpWiki programming team")) ? ADMIN_USER : $owner;
1397 // The authenticated author of the first revision or empty if not authenticated then.
1398 function getCreator() {
1399 if ($current = $this->getRevision(1,false)) return $current->get('author_id');
1403 // The authenticated author of the current revision.
1404 function getAuthor() {
1405 if ($current = $this->getCurrentRevision(false)) return $current->get('author_id');
1409 /* Semantic Web value, not stored in the links.
1410 * todo: unify with some unit knowledge
1412 function setAttribute($relation, $value) {
1413 $attr = $this->get('attributes');
1415 $attr = array($relation => $value);
1417 $attr[$relation] = $value;
1418 $this->set('attributes', $attr);
1421 function getAttribute($relation) {
1422 $meta = $this->get('attributes');
1426 return $meta[$relation];
1432 * This class represents a specific revision of a WikiDB_Page within
1435 * A WikiDB_PageRevision has read-only semantics. You may only create
1436 * new revisions (and delete old ones) --- you cannot modify existing
1439 class WikiDB_PageRevision
1441 //var $_transformedContent = false; // set by WikiDB_Page::save()
1443 function WikiDB_PageRevision(&$wikidb, $pagename, $version, $versiondata = false) {
1444 $this->_wikidb = &$wikidb;
1445 $this->_pagename = $pagename;
1446 $this->_version = $version;
1447 $this->_data = $versiondata ? $versiondata : array();
1448 $this->_transformedContent = false; // set by WikiDB_Page::save()
1452 * Get the WikiDB_Page which this revision belongs to.
1456 * @return WikiDB_Page The WikiDB_Page which this revision belongs to.
1458 function getPage() {
1459 return new WikiDB_Page($this->_wikidb, $this->_pagename);
1463 * Get the version number of this revision.
1467 * @return integer The version number of this revision.
1469 function getVersion() {
1470 return $this->_version;
1474 * Determine whether this revision has defaulted content.
1476 * The default revision (version 0) of each page, as well as any
1477 * pages which are created with empty content have their content
1478 * defaulted to something like:
1480 * Describe [ThisPage] here.
1485 * @return boolean Returns true if the page has default content.
1487 function hasDefaultContents() {
1488 $data = &$this->_data;
1489 return empty($data['%content']); // FIXME: what if it's the number 0? <>'' or === false
1493 * Get the content as an array of lines.
1497 * @return array An array of lines.
1498 * The lines should contain no trailing white space.
1500 function getContent() {
1501 return explode("\n", $this->getPackedContent());
1505 * Get the pagename of the revision.
1509 * @return string pagename.
1511 function getPageName() {
1512 return $this->_pagename;
1514 function getName() {
1515 return $this->_pagename;
1519 * Determine whether revision is the latest.
1523 * @return boolean True iff the revision is the latest (most recent) one.
1525 function isCurrent() {
1526 if (!isset($this->_iscurrent)) {
1527 $page = $this->getPage();
1528 $current = $page->getCurrentRevision(false);
1529 $this->_iscurrent = $this->getVersion() == $current->getVersion();
1531 return $this->_iscurrent;
1535 * Get the transformed content of a page.
1537 * @param string $pagetype Override the page-type of the revision.
1539 * @return object An XmlContent-like object containing the page transformed
1542 function getTransformedContent($pagetype_override=false) {
1543 $backend = &$this->_wikidb->_backend;
1545 if ($pagetype_override) {
1546 // Figure out the normal page-type for this page.
1547 $type = PageType::GetPageType($this->get('pagetype'));
1548 if ($type->getName() == $pagetype_override)
1549 $pagetype_override = false; // Not really an override...
1552 if ($pagetype_override) {
1553 // Overriden page type, don't cache (or check cache).
1554 return new TransformedText($this->getPage(),
1555 $this->getPackedContent(),
1556 $this->getMetaData(),
1557 $pagetype_override);
1560 $possibly_cache_results = true;
1562 if (!USECACHE or WIKIDB_NOCACHE_MARKUP) {
1563 if (WIKIDB_NOCACHE_MARKUP == 'purge') {
1564 // flush cache for this page.
1565 $page = $this->getPage();
1566 $page->set('_cached_html', ''); // ignored with !USECACHE
1568 $possibly_cache_results = false;
1570 elseif (USECACHE and !$this->_transformedContent) {
1572 if ($this->isCurrent()) {
1573 $page = $this->getPage();
1574 $this->_transformedContent = TransformedText::unpack($page->get('_cached_html'));
1577 $possibly_cache_results = false;
1579 //$backend->unlock();
1582 if (!$this->_transformedContent) {
1583 $this->_transformedContent
1584 = new TransformedText($this->getPage(),
1585 $this->getPackedContent(),
1586 $this->getMetaData());
1588 if ($possibly_cache_results and !WIKIDB_NOCACHE_MARKUP) {
1589 // If we're still the current version, cache the transfomed page.
1591 if ($this->isCurrent()) {
1592 $page->set('_cached_html', $this->_transformedContent->pack());
1594 //$backend->unlock();
1598 return $this->_transformedContent;
1602 * Get the content as a string.
1606 * @return string The page content.
1607 * Lines are separated by new-lines.
1609 function getPackedContent() {
1610 $data = &$this->_data;
1612 if (empty($data['%content'])
1613 || (!$this->_wikidb->isWikiPage($this->_pagename)
1614 && $this->isCurrent())) {
1615 include_once('lib/InlineParser.php');
1617 // A feature similar to taglines at http://www.wlug.org.nz/
1618 // Lib from http://www.aasted.org/quote/
1619 if (defined('FORTUNE_DIR')
1620 and is_dir(FORTUNE_DIR)
1621 and in_array($GLOBALS['request']->getArg('action'),
1622 array('create','edit')))
1624 include_once("lib/fortune.php");
1625 $fortune = new Fortune();
1626 $quote = $fortune->quoteFromDir(FORTUNE_DIR);
1628 $quote = "<verbatim>\n"
1629 . str_replace("\n<br>","\n", $quote)
1630 . "</verbatim>\n\n";
1634 . sprintf(_("Describe %s here."),
1635 "[" . WikiEscape($this->_pagename) . "]");
1637 // Replace empty content with default value.
1638 return sprintf(_("Describe %s here."),
1639 "[" . WikiEscape($this->_pagename) . "]");
1642 // There is (non-default) content.
1643 assert($this->_version > 0);
1645 if (!is_string($data['%content'])) {
1646 // Content was not provided to us at init time.
1647 // (This is allowed because for some backends, fetching
1648 // the content may be expensive, and often is not wanted
1651 // In any case, now we need to get it.
1652 $data['%content'] = $this->_get_content();
1653 assert(is_string($data['%content']));
1656 return $data['%content'];
1659 function _get_content() {
1660 $cache = &$this->_wikidb->_cache;
1661 $pagename = $this->_pagename;
1662 $version = $this->_version;
1664 assert($version > 0);
1666 $newdata = $cache->get_versiondata($pagename, $version, true);
1668 assert(is_string($newdata['%content']));
1669 return $newdata['%content'];
1672 // else revision has been deleted... What to do?
1673 return __sprintf("Oops! Revision %s of %s seems to have been deleted!",
1674 $version, $pagename);
1679 * Get meta-data for this revision.
1684 * @param string $key Which meta-data to access.
1686 * Some reserved revision meta-data keys are:
1688 * <dt> 'mtime' <dd> Time this revision was created (seconds since midnight Jan 1, 1970.)
1689 * The 'mtime' meta-value is normally set automatically by the database
1690 * backend, but it may be specified explicitly when creating a new revision.
1692 * <dd> To ensure consistency of RecentChanges, the mtimes of the versions
1693 * of a page must be monotonically increasing. If an attempt is
1694 * made to create a new revision with an mtime less than that of
1695 * the preceeding revision, the new revisions timestamp is force
1696 * to be equal to that of the preceeding revision. In that case,
1697 * the originally requested mtime is preserved in 'orig_mtime'.
1698 * <dt> '_supplanted' <dd> Time this revision ceased to be the most recent.
1699 * This meta-value is <em>always</em> automatically maintained by the database
1700 * backend. (It is set from the 'mtime' meta-value of the superceding
1701 * revision.) '_supplanted' has a value of 'false' for the current revision.
1703 * FIXME: this could be refactored:
1705 * <dd> Author of the page (as he should be reported in, e.g. RecentChanges.)
1707 * <dd> Authenticated author of a page. This is used to identify
1708 * the distinctness of authors when cleaning old revisions from
1710 * <dt> 'is_minor_edit' <dd> Set if change was marked as a minor revision by the author.
1711 * <dt> 'summary' <dd> Short change summary entered by page author.
1714 * Meta-data keys must be valid C identifers (they have to start with a letter
1715 * or underscore, and can contain only alphanumerics and underscores.)
1717 * @return string The requested value, or false if the requested value
1720 function get($key) {
1721 if (!$key || $key[0] == '%')
1723 $data = &$this->_data;
1724 return isset($data[$key]) ? $data[$key] : false;
1728 * Get all the revision page meta-data as a hash.
1730 * @return hash The revision meta-data.
1732 function getMetaData() {
1734 foreach ($this->_data as $key => $val) {
1735 if (!empty($val) && $key[0] != '%')
1743 * Return a string representation of the revision.
1745 * This is really only for debugging.
1749 * @return string Printable representation of the WikiDB_Page.
1751 function asString () {
1753 printf("[%s:%d\n", get_class($this), $this->get('version'));
1754 print_r($this->_data);
1755 echo $this->getPackedContent() . "\n]\n";
1756 $strval = ob_get_contents();
1764 * Class representing a sequence of WikiDB_Pages.
1765 * TODO: Enhance to php5 iterators
1767 * apply filters for options like 'sortby', 'limit', 'exclude'
1768 * for simple queries like titleSearch, where the backend is not ready yet.
1770 class WikiDB_PageIterator
1772 function WikiDB_PageIterator(&$wikidb, &$iter, $options=false) {
1773 $this->_iter = $iter; // a WikiDB_backend_iterator
1774 $this->_wikidb = &$wikidb;
1775 $this->_options = $options;
1779 return $this->_iter->count();
1783 * Get next WikiDB_Page in sequence.
1787 * @return WikiDB_Page The next WikiDB_Page in the sequence.
1790 if ( ! ($next = $this->_iter->next()) )
1793 $pagename = &$next['pagename'];
1794 if (!is_string($pagename)) { // Bug #1327912 fixed by Joachim Lous
1795 /*if (is_array($pagename) && isset($pagename['linkto'])) {
1796 $pagename = $pagename['linkto'];
1798 $pagename = strval($pagename);*/
1799 trigger_error("WikiDB_PageIterator->next pagename", E_USER_WARNING);
1802 if (isset($next['linkrelation'])
1803 or isset($next['pagedata']['linkrelation'])) return false;
1804 trigger_error('empty pagename in WikiDB_PageIterator::next()', E_USER_WARNING);
1808 // There's always hits, but we cache only if more
1809 // (well not with file, cvs and dba)
1810 if (isset($next['pagedata']) and count($next['pagedata']) > 1) {
1811 $this->_wikidb->_cache->cache_data($next);
1812 // cache existing page id's since we iterate over all links in GleanDescription
1813 // and need them later for LinkExistingWord
1814 } elseif ($this->_options and array_key_exists('include_empty', $this->_options)
1815 and !$this->_options['include_empty'] and isset($next['id'])) {
1816 $this->_wikidb->_cache->_id_cache[$next['pagename']] = $next['id'];
1818 $page = new WikiDB_Page($this->_wikidb, $pagename);
1819 if (isset($next['linkrelation']))
1820 $page->set('linkrelation', $next['linkrelation']);
1821 if (isset($next['score']))
1822 $page->score = $next['score'];
1827 * Release resources held by this iterator.
1829 * The iterator may not be used after free() is called.
1831 * There is no need to call free(), if next() has returned false.
1832 * (I.e. if you iterate through all the pages in the sequence,
1833 * you do not need to call free() --- you only need to call it
1834 * if you stop before the end of the iterator is reached.)
1839 $this->_iter->free();
1842 $this->_iter->reset();
1844 function asArray() {
1846 while ($page = $this->next())
1853 * Apply filters for options like 'sortby', 'limit', 'exclude'
1854 * for simple queries like titleSearch, where the backend is not ready yet.
1855 * Since iteration is usually destructive for SQL results,
1856 * we have to generate a copy.
1858 function applyFilters($options = false) {
1859 if (!$options) $options = $this->_options;
1860 if (isset($options['sortby'])) {
1862 /* this is destructive */
1863 while ($page = $this->next())
1864 $result[] = $page->getName();
1865 $this->_doSort($array, $options['sortby']);
1867 /* the rest is not destructive.
1868 * reconstruct a new iterator
1870 $pagenames = array(); $i = 0;
1871 if (isset($options['limit']))
1872 $limit = $options['limit'];
1875 if (isset($options['exclude']))
1876 $exclude = $options['exclude'];
1877 if (is_string($exclude) and !is_array($exclude))
1878 $exclude = PageList::explodePageList($exclude, false, false, $limit);
1879 foreach($array as $pagename) {
1880 if ($limit and $i++ > $limit)
1881 return new WikiDB_Array_PageIterator($pagenames);
1882 if (!empty($exclude) and !in_array($pagename, $exclude))
1883 $pagenames[] = $pagename;
1884 elseif (empty($exclude))
1885 $pagenames[] = $pagename;
1887 return new WikiDB_Array_PageIterator($pagenames);
1891 function _doSort(&$array, $sortby) {
1892 $sortby = PageList::sortby($sortby, 'init');
1893 if ($sortby == '+pagename')
1894 sort($array, SORT_STRING);
1895 elseif ($sortby == '-pagename')
1896 rsort($array, SORT_STRING);
1903 * A class which represents a sequence of WikiDB_PageRevisions.
1904 * TODO: Enhance to php5 iterators
1906 class WikiDB_PageRevisionIterator
1908 function WikiDB_PageRevisionIterator(&$wikidb, &$revisions, $options=false) {
1909 $this->_revisions = $revisions;
1910 $this->_wikidb = &$wikidb;
1911 $this->_options = $options;
1915 return $this->_revisions->count();
1919 * Get next WikiDB_PageRevision in sequence.
1923 * @return WikiDB_PageRevision
1924 * The next WikiDB_PageRevision in the sequence.
1927 if ( ! ($next = $this->_revisions->next()) )
1930 //$this->_wikidb->_cache->cache_data($next);
1932 $pagename = $next['pagename'];
1933 $version = $next['version'];
1934 $versiondata = $next['versiondata'];
1936 if (!(is_string($pagename) and $pagename != '')) {
1937 trigger_error("empty pagename",E_USER_WARNING);
1940 } else assert(is_string($pagename) and $pagename != '');
1942 if (!is_array($versiondata)) {
1943 trigger_error("empty versiondata",E_USER_WARNING);
1946 } else assert(is_array($versiondata));
1948 if (!($version > 0)) {
1949 trigger_error("invalid version",E_USER_WARNING);
1952 } else assert($version > 0);
1954 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1959 * Release resources held by this iterator.
1961 * The iterator may not be used after free() is called.
1963 * There is no need to call free(), if next() has returned false.
1964 * (I.e. if you iterate through all the revisions in the sequence,
1965 * you do not need to call free() --- you only need to call it
1966 * if you stop before the end of the iterator is reached.)
1971 $this->_revisions->free();
1974 function asArray() {
1976 while ($rev = $this->next())
1985 class WikiDB_Array_PageIterator
1987 function WikiDB_Array_PageIterator($pagenames) {
1989 $this->_dbi = $request->getDbh();
1990 $this->_pages = $pagenames;
1991 reset($this->_pages);
1994 $c = current($this->_pages);
1995 next($this->_pages);
1996 return $c !== false ? $this->_dbi->getPage($c) : false;
1999 return count($this->_pages);
2002 reset($this->_pages);
2005 function asArray() {
2006 reset($this->_pages);
2007 return $this->_pages;
2011 class WikiDB_Array_generic_iter
2013 function WikiDB_Array_generic_iter($result) {
2014 // $result may be either an array or a query result
2015 if (is_array($result)) {
2016 $this->_array = $result;
2017 } elseif (is_object($result)) {
2018 $this->_array = $result->asArray();
2020 $this->_array = array();
2022 if (!empty($this->_array))
2023 reset($this->_array);
2026 $c = current($this->_array);
2027 next($this->_array);
2028 return $c !== false ? $c : false;
2031 return count($this->_array);
2034 reset($this->_array);
2037 function asArray() {
2038 if (!empty($this->_array))
2039 reset($this->_array);
2040 return $this->_array;
2045 * Data cache used by WikiDB.
2047 * FIXME: Maybe rename this to caching_backend (or some such).
2053 // FIXME: beautify versiondata cache. Cache only limited data?
2055 function WikiDB_cache (&$backend) {
2056 $this->_backend = &$backend;
2058 $this->_pagedata_cache = array();
2059 $this->_versiondata_cache = array();
2060 array_push ($this->_versiondata_cache, array());
2061 $this->_glv_cache = array();
2062 $this->_id_cache = array(); // formerly ->_dbi->_iwpcache (nonempty pages => id)
2066 $this->_pagedata_cache = array();
2067 $this->_versiondata_cache = array();
2068 $this->_glv_cache = array();
2069 $this->_id_cache = array();
2072 function get_pagedata($pagename) {
2073 assert(is_string($pagename) && $pagename != '');
2075 $cache = &$this->_pagedata_cache;
2076 if (!isset($cache[$pagename]) || !is_array($cache[$pagename])) {
2077 $cache[$pagename] = $this->_backend->get_pagedata($pagename);
2078 if (empty($cache[$pagename]))
2079 $cache[$pagename] = array();
2081 return $cache[$pagename];
2083 return $this->_backend->get_pagedata($pagename);
2087 function update_pagedata($pagename, $newdata) {
2088 assert(is_string($pagename) && $pagename != '');
2090 $this->_backend->update_pagedata($pagename, $newdata);
2093 if (!empty($this->_pagedata_cache[$pagename])
2094 and is_array($this->_pagedata_cache[$pagename]))
2096 $cachedata = &$this->_pagedata_cache[$pagename];
2097 foreach($newdata as $key => $val)
2098 $cachedata[$key] = $val;
2100 $this->_pagedata_cache[$pagename] = $newdata;
2104 function invalidate_cache($pagename) {
2105 unset ($this->_pagedata_cache[$pagename]);
2106 unset ($this->_versiondata_cache[$pagename]);
2107 unset ($this->_glv_cache[$pagename]);
2108 unset ($this->_id_cache[$pagename]);
2109 //unset ($this->_backend->_page_data);
2112 function delete_page($pagename) {
2113 $result = $this->_backend->delete_page($pagename);
2114 $this->invalidate_cache($pagename);
2118 function purge_page($pagename) {
2119 $result = $this->_backend->purge_page($pagename);
2120 $this->invalidate_cache($pagename);
2124 // FIXME: ugly and wrong. may overwrite full cache with partial cache
2125 function cache_data($data) {
2127 //if (isset($data['pagedata']))
2128 // $this->_pagedata_cache[$data['pagename']] = $data['pagedata'];
2131 function get_versiondata($pagename, $version, $need_content = false) {
2132 // FIXME: Seriously ugly hackage
2134 if (USECACHE) { //temporary - for debugging
2135 assert(is_string($pagename) && $pagename != '');
2136 // There is a bug here somewhere which results in an assertion failure at line 105
2137 // of ArchiveCleaner.php It goes away if we use the next line.
2138 //$need_content = true;
2139 $nc = $need_content ? '1':'0';
2140 $cache = &$this->_versiondata_cache;
2141 if (!isset($cache[$pagename][$version][$nc])
2142 || !(is_array ($cache[$pagename]))
2143 || !(is_array ($cache[$pagename][$version])))
2145 $cache[$pagename][$version][$nc] =
2146 $this->_backend->get_versiondata($pagename, $version, $need_content);
2148 // If we have retrieved all data, we may as well set the cache for
2149 // $need_content = false
2151 $cache[$pagename][$version]['0'] =& $cache[$pagename][$version]['1'];
2154 $vdata = $cache[$pagename][$version][$nc];
2156 $vdata = $this->_backend->get_versiondata($pagename, $version, $need_content);
2159 if ($readdata && $vdata && !empty($vdata['%pagedata'])) {
2160 $this->_pagedata_cache[$pagename] =& $vdata['%pagedata'];
2165 function set_versiondata($pagename, $version, $data) {
2166 //unset($this->_versiondata_cache[$pagename][$version]);
2168 $new = $this->_backend->set_versiondata($pagename, $version, $data);
2170 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2171 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2172 // Is this necessary?
2173 unset($this->_glv_cache[$pagename]);
2176 function update_versiondata($pagename, $version, $data) {
2177 $new = $this->_backend->update_versiondata($pagename, $version, $data);
2179 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2181 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2182 // Is this necessary?
2183 unset($this->_glv_cache[$pagename]);
2186 function delete_versiondata($pagename, $version) {
2187 $new = $this->_backend->delete_versiondata($pagename, $version);
2188 if (isset($this->_versiondata_cache[$pagename][$version]))
2189 unset ($this->_versiondata_cache[$pagename][$version]);
2190 // dirty latest version cache only if latest version gets deleted
2191 if (isset($this->_glv_cache[$pagename]) and $this->_glv_cache[$pagename] == $version)
2192 unset ($this->_glv_cache[$pagename]);
2195 function get_latest_version($pagename) {
2197 assert (is_string($pagename) && $pagename != '');
2198 $cache = &$this->_glv_cache;
2199 if (!isset($cache[$pagename])) {
2200 $cache[$pagename] = $this->_backend->get_latest_version($pagename);
2201 if (empty($cache[$pagename]))
2202 $cache[$pagename] = 0;
2204 return $cache[$pagename];
2206 return $this->_backend->get_latest_version($pagename);
2211 function _sql_debuglog($msg, $newline=true, $shutdown=false) {
2215 $stamp = strftime("%y%m%d-%H%M%S");
2216 $fp = fopen(TEMP_DIR."/sql-$stamp.log", "a");
2217 register_shutdown_function("_sql_debuglog_shutdown_function");
2218 } elseif ($shutdown) {
2222 if ($newline) fputs($fp, "[$i++] $msg");
2223 else fwrite($fp, $msg);
2226 function _sql_debuglog_shutdown_function() {
2227 _sql_debuglog('',false,true);
2230 // $Log: not supported by cvs2svn $
2231 // Revision 1.158 2008/01/30 19:29:52 vargenau
2232 // Disabled to avoid recursive modification when renaming a page like 'PageFoo to 'PageFooTwo'
2234 // Revision 1.157 2007/09/15 12:35:50 rurban
2235 // basic array reset support - unclear if needed, iteration is usually one-time only
2237 // Revision 1.156 2007/09/12 19:38:05 rurban
2238 // fix wrong ref ¤t
2240 // Revision 1.155 2007/07/15 17:39:33 rurban
2241 // stabilize rename updateWikiLinks to check only words
2243 // Revision 1.154 2007/07/14 12:03:58 rurban
2246 // Revision 1.153 2007/06/07 16:54:29 rurban
2247 // enable $MailNotify->onChangePage. support other formatters (MediaWiki, Creole, ...)
2249 // Revision 1.152 2007/05/28 20:13:46 rurban
2250 // Overwrite all attributes at once at page->save to delete dangling meta
2252 // Revision 1.151 2007/05/01 16:20:12 rurban
2253 // MailNotify->onChangePage only on DEBUG (still broken)
2255 // Revision 1.150 2007/03/18 17:35:27 rurban
2258 // Revision 1.149 2007/02/17 14:16:37 rurban
2259 // isWikiPage no error on empty pagenames. MailNotify->onChangePage fix by ??
2261 // Revision 1.148 2007/01/27 21:53:03 rurban
2262 // Use TEMP_DIR for debug sql.log
2264 // Revision 1.147 2007/01/04 16:41:41 rurban
2265 // Some pageiterators also set ['pagedata']['linkrelation'], hmm
2267 // Revision 1.146 2007/01/02 13:20:00 rurban
2268 // rewrote listRelations. added linkSearch. force new date in renamePage. fix fortune error handling. added page->setAttributes. use translated initial owner. Clarify API: sortby,limit and exclude are strings. Enhance documentation.
2270 // Revision 1.145 2006/12/22 17:59:55 rurban
2271 // Move mailer functions into seperate MailNotify.php
2273 // Revision 1.144 2006/10/12 06:36:09 rurban
2274 // Guard against unwanted DEBUG="DEBUG" logic. In detail (WikiDB),
2275 // and generally by forcing all int constants to be defined as int.
2277 // Revision 1.143 2006/09/06 05:46:40 rurban
2278 // do db backend check on _DEBUG_SQL
2280 // Revision 1.142 2006/06/10 11:55:58 rurban
2281 // print optimize only when DEBUG
2283 // Revision 1.141 2006/04/17 17:28:21 rurban
2284 // honor getWikiPageLinks change linkto=>relation
2286 // Revision 1.140 2006/03/19 14:23:51 rurban
2287 // sf.net patch #1377011 by Matt Brown: add DATABASE_OPTIMISE_FREQUENCY
2289 // Revision 1.139 2006/01/12 16:38:07 rurban
2290 // add page method listRelations()
2291 // fix bug #1327912 numeric pagenames can break plugins (Joachim Lous)
2293 // Revision 1.138 2005/11/14 22:27:07 rurban
2294 // add linkrelation support
2295 // getPageLinks returns now an array of hashes
2296 // pass stoplist through iterator
2298 // Revision 1.137 2005/10/12 06:16:18 rurban
2299 // better From header
2301 // Revision 1.136 2005/10/03 16:14:57 rurban
2302 // improve description
2304 // Revision 1.135 2005/09/11 14:19:44 rurban
2305 // enable LIMIT support for fulltext search
2307 // Revision 1.134 2005/09/10 21:28:10 rurban
2308 // applyFilters hack to use filters after methods, which do not support them (titleSearch)
2310 // Revision 1.133 2005/08/27 09:39:10 rurban
2311 // dumphtml when not at admin page: dump the current or given page
2313 // Revision 1.132 2005/08/07 10:10:07 rurban
2314 // clean whole version cache
2316 // Revision 1.131 2005/04/23 11:30:12 rurban
2317 // allow emtpy WikiDB::getRevisionBefore(), for simplier templates (revert)
2319 // Revision 1.130 2005/04/06 06:19:30 rurban
2320 // Revert the previous wrong bugfix #1175761: USECACHE was mixed with WIKIDB_NOCACHE_MARKUP.
2321 // Fix WIKIDB_NOCACHE_MARKUP in main (always set it) and clarify it in WikiDB
2323 // Revision 1.129 2005/04/06 05:50:29 rurban
2324 // honor !USECACHE for _cached_html, fixes #1175761
2326 // Revision 1.128 2005/04/01 16:11:42 rurban
2329 // Revision 1.127 2005/02/18 20:43:40 uckelman
2330 // WikiDB::genericWarnings() is no longer used.
2332 // Revision 1.126 2005/02/04 17:58:06 rurban
2333 // minor versioncache improvement. part 2/3 of Charles Corrigan cache patch. not sure about the 0/1 issue
2335 // Revision 1.125 2005/02/03 05:08:39 rurban
2336 // ref fix by Charles Corrigan
2338 // Revision 1.124 2005/01/29 20:43:32 rurban
2339 // protect against empty request: on some occasion this happens
2341 // Revision 1.123 2005/01/25 06:58:21 rurban
2344 // Revision 1.122 2005/01/20 10:18:17 rurban
2347 // Revision 1.121 2005/01/04 20:25:01 rurban
2348 // remove old [%pagedata][_cached_html] code
2350 // Revision 1.120 2004/12/23 14:12:31 rurban
2351 // dont email on unittest
2353 // Revision 1.119 2004/12/20 16:05:00 rurban
2354 // gettext msg unification
2356 // Revision 1.118 2004/12/13 13:22:57 rurban
2357 // new BlogArchives plugin for the new blog theme. enable default box method
2358 // for all plugins. Minor search improvement.
2360 // Revision 1.117 2004/12/13 08:15:09 rurban
2361 // false is wrong. null might be better but lets play safe.
2363 // Revision 1.116 2004/12/10 22:15:00 rurban
2364 // fix $page->get('_cached_html)
2365 // refactor upgrade db helper _convert_cached_html() to be able to call them from WikiAdminUtils also.
2366 // support 2nd genericSqlQuery param (bind huge arg)
2368 // Revision 1.115 2004/12/10 02:45:27 rurban
2369 // SQL optimization:
2370 // put _cached_html from pagedata into a new seperate blob, not huge serialized string.
2371 // it is only rarelely needed: for current page only, if-not-modified
2372 // but was extracted for every simple page iteration.
2374 // Revision 1.114 2004/12/09 22:24:44 rurban
2375 // optimize on _DEBUG_SQL only. but now again on every 50th request, not just save.
2377 // Revision 1.113 2004/12/06 19:49:55 rurban
2378 // enable action=remove which is undoable and seeable in RecentChanges: ADODB ony for now.
2379 // renamed delete_page to purge_page.
2380 // enable action=edit&version=-1 to force creation of a new version.
2381 // added BABYCART_PATH config
2382 // fixed magiqc in adodb.inc.php
2383 // and some more docs
2385 // Revision 1.112 2004/11/30 17:45:53 rurban
2386 // exists_links backend implementation
2388 // Revision 1.111 2004/11/28 20:39:43 rurban
2389 // deactivate pagecache overwrite: it is wrong
2391 // Revision 1.110 2004/11/26 18:39:01 rurban
2392 // new regex search parser and SQL backends (90% complete, glob and pcre backends missing)
2394 // Revision 1.109 2004/11/25 17:20:50 rurban
2395 // and again a couple of more native db args: backlinks
2397 // Revision 1.108 2004/11/23 13:35:31 rurban
2398 // add case_exact search
2400 // Revision 1.107 2004/11/21 11:59:16 rurban
2401 // remove final \n to be ob_cache independent
2403 // Revision 1.106 2004/11/20 17:35:56 rurban
2404 // improved WantedPages SQL backends
2405 // PageList::sortby new 3rd arg valid_fields (override db fields)
2406 // WantedPages sql pager inexact for performance reasons:
2407 // assume 3 wantedfrom per page, to be correct, no getTotal()
2408 // support exclude argument for get_all_pages, new _sql_set()
2410 // Revision 1.105 2004/11/20 09:16:27 rurban
2411 // Fix bad-style Cut&Paste programming errors, detected by Charles Corrigan.
2413 // Revision 1.104 2004/11/19 19:22:03 rurban
2414 // ModeratePage part1: change status
2416 // Revision 1.103 2004/11/16 17:29:04 rurban
2417 // fix remove notification error
2418 // fix creation + update id_cache update
2420 // Revision 1.102 2004/11/11 18:31:26 rurban
2421 // add simple backtrace on such general failures to get at least an idea where
2423 // Revision 1.101 2004/11/10 19:32:22 rurban
2424 // * optimize increaseHitCount, esp. for mysql.
2425 // * prepend dirs to the include_path (phpwiki_dir for faster searches)
2426 // * Pear_DB version logic (awful but needed)
2427 // * fix broken ADODB quote
2428 // * _extract_page_data simplification
2430 // Revision 1.100 2004/11/10 15:29:20 rurban
2431 // * requires newer Pear_DB (as the internal one): quote() uses now escapeSimple for strings
2432 // * ACCESS_LOG_SQL: fix cause request not yet initialized
2433 // * WikiDB: moved SQL specific methods upwards
2434 // * new Pear_DB quoting: same as ADODB and as newer Pear_DB.
2435 // fixes all around: WikiGroup, WikiUserNew SQL methods, SQL logging
2437 // Revision 1.99 2004/11/09 17:11:05 rurban
2438 // * revert to the wikidb ref passing. there's no memory abuse there.
2439 // * use new wikidb->_cache->_id_cache[] instead of wikidb->_iwpcache, to effectively
2440 // store page ids with getPageLinks (GleanDescription) of all existing pages, which
2441 // are also needed at the rendering for linkExistingWikiWord().
2442 // pass options to pageiterator.
2443 // use this cache also for _get_pageid()
2444 // This saves about 8 SELECT count per page (num all pagelinks).
2445 // * fix passing of all page fields to the pageiterator.
2446 // * fix overlarge session data which got broken with the latest ACCESS_LOG_SQL changes
2448 // Revision 1.98 2004/11/07 18:34:29 rurban
2449 // more logging fixes
2451 // Revision 1.97 2004/11/07 16:02:51 rurban
2452 // new sql access log (for spam prevention), and restructured access log class
2453 // dbh->quote (generic)
2454 // pear_db: mysql specific parts seperated (using replace)
2456 // Revision 1.96 2004/11/05 22:32:15 rurban
2457 // encode the subject to be 7-bit safe
2459 // Revision 1.95 2004/11/05 20:53:35 rurban
2460 // login cleanup: better debug msg on failing login,
2461 // checked password less immediate login (bogo or anon),
2462 // checked olduser pref session error,
2463 // better PersonalPage without password warning on minimal password length=0
2464 // (which is default now)
2466 // Revision 1.94 2004/11/01 10:43:56 rurban
2467 // seperate PassUser methods into seperate dir (memory usage)
2468 // fix WikiUser (old) overlarge data session
2469 // remove wikidb arg from various page class methods, use global ->_dbi instead
2472 // Revision 1.93 2004/10/14 17:17:57 rurban
2473 // remove dbi WikiDB_Page param: use global request object instead. (memory)
2474 // allow most_popular sortby arguments
2476 // Revision 1.92 2004/10/05 17:00:04 rurban
2477 // support paging for simple lists
2478 // fix RatingDb sql backend.
2479 // remove pages from AllPages (this is ListPages then)
2481 // Revision 1.91 2004/10/04 23:41:19 rurban
2482 // delete notify: fix, @unset syntax error
2484 // Revision 1.90 2004/09/28 12:50:22 rurban
2485 // https://sourceforge.net/forum/forum.php?thread_id=1150924&forum_id=18929
2487 // Revision 1.89 2004/09/26 10:54:42 rurban
2488 // silence deferred check
2490 // Revision 1.88 2004/09/25 18:16:40 rurban
2491 // unset more unneeded _cached_html. (Guess this should fix sf.net now)
2493 // Revision 1.87 2004/09/25 16:25:40 rurban
2494 // notify on rename and remove (to be improved)
2496 // Revision 1.86 2004/09/23 18:52:06 rurban
2497 // only fortune at create
2499 // Revision 1.85 2004/09/16 08:00:51 rurban
2500 // just some comments
2502 // Revision 1.84 2004/09/14 10:34:30 rurban
2503 // fix TransformedText call to use refs
2505 // Revision 1.83 2004/09/08 13:38:00 rurban
2506 // improve loadfile stability by using markup=2 as default for undefined markup-style.
2507 // use more refs for huge objects.
2508 // fix debug=static issue in WikiPluginCached
2510 // Revision 1.82 2004/09/06 12:08:49 rurban
2511 // memory_limit on unix workaround
2512 // VisualWiki: default autosize image
2514 // Revision 1.81 2004/09/06 08:28:00 rurban
2515 // rename genericQuery to genericSqlQuery
2517 // Revision 1.80 2004/07/09 13:05:34 rurban
2520 // Revision 1.79 2004/07/09 10:06:49 rurban
2521 // Use backend specific sortby and sortable_columns method, to be able to
2522 // select between native (Db backend) and custom (PageList) sorting.
2523 // Fixed PageList::AddPageList (missed the first)
2524 // Added the author/creator.. name to AllPagesBy...
2525 // display no pages if none matched.
2526 // Improved dba and file sortby().
2527 // Use &$request reference
2529 // Revision 1.78 2004/07/08 21:32:35 rurban
2530 // Prevent from more warnings, minor db and sort optimizations
2532 // Revision 1.77 2004/07/08 19:04:42 rurban
2533 // more unittest fixes (file backend, metadata RatingsDb)
2535 // Revision 1.76 2004/07/08 17:31:43 rurban
2536 // improve numPages for file (fixing AllPagesTest)
2538 // Revision 1.75 2004/07/05 13:56:22 rurban
2539 // sqlite autoincrement fix
2541 // Revision 1.74 2004/07/03 16:51:05 rurban
2542 // optional DBADMIN_USER:DBADMIN_PASSWD for action=upgrade (if no ALTER permission)
2543 // added atomic mysql REPLACE for PearDB as in ADODB
2544 // fixed _lock_tables typo links => link
2545 // fixes unserialize ADODB bug in line 180
2547 // Revision 1.73 2004/06/29 08:52:22 rurban
2548 // Use ...version() $need_content argument in WikiDB also:
2549 // To reduce the memory footprint for larger sets of pagelists,
2550 // we don't cache the content (only true or false) and
2551 // we purge the pagedata (_cached_html) also.
2552 // _cached_html is only cached for the current pagename.
2553 // => Vastly improved page existance check, ACL check, ...
2555 // Now only PagedList info=content or size needs the whole content, esp. if sortable.
2557 // Revision 1.72 2004/06/25 14:15:08 rurban
2558 // reduce memory footprint by caching only requested pagedate content (improving most page iterators)
2560 // Revision 1.71 2004/06/21 16:22:30 rurban
2561 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
2562 // fixed dumping buttons locally (images/buttons/),
2563 // support pages arg for dumphtml,
2564 // optional directory arg for dumpserial + dumphtml,
2565 // fix a AllPages warning,
2566 // show dump warnings/errors on DEBUG,
2567 // don't warn just ignore on wikilens pagelist columns, if not loaded.
2568 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
2570 // Revision 1.70 2004/06/18 14:39:31 rurban
2571 // actually check USECACHE
2573 // Revision 1.69 2004/06/13 15:33:20 rurban
2574 // new support for arguments owner, author, creator in most relevant
2575 // PageList plugins. in WikiAdmin* via preSelectS()
2577 // Revision 1.68 2004/06/08 21:03:20 rurban
2578 // updated RssParser for XmlParser quirks (store parser object params in globals)
2580 // Revision 1.67 2004/06/07 19:12:49 rurban
2581 // fixed rename version=0, bug #966284
2583 // Revision 1.66 2004/06/07 18:57:27 rurban
2584 // fix rename: Change pagename in all linked pages
2586 // Revision 1.65 2004/06/04 20:32:53 rurban
2587 // Several locale related improvements suggested by Pierrick Meignen
2588 // LDAP fix by John Cole
2589 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
2591 // Revision 1.64 2004/06/04 16:50:00 rurban
2592 // add random quotes to empty pages
2594 // Revision 1.63 2004/06/04 11:58:38 rurban
2595 // added USE_TAGLINES
2597 // Revision 1.62 2004/06/03 22:24:41 rurban
2598 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
2600 // Revision 1.61 2004/06/02 17:13:48 rurban
2601 // fix getRevisionBefore assertion
2603 // Revision 1.60 2004/05/28 10:09:58 rurban
2604 // fix bug #962117, incorrect init of auth_dsn
2606 // Revision 1.59 2004/05/27 17:49:05 rurban
2607 // renamed DB_Session to DbSession (in CVS also)
2608 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
2609 // remove leading slash in error message
2610 // added force_unlock parameter to File_Passwd (no return on stale locks)
2611 // fixed adodb session AffectedRows
2612 // added FileFinder helpers to unify local filenames and DATA_PATH names
2613 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
2615 // Revision 1.58 2004/05/18 13:59:14 rurban
2616 // rename simpleQuery to genericQuery
2618 // Revision 1.57 2004/05/16 22:07:35 rurban
2619 // check more config-default and predefined constants
2620 // various PagePerm fixes:
2621 // fix default PagePerms, esp. edit and view for Bogo and Password users
2622 // implemented Creator and Owner
2623 // BOGOUSERS renamed to BOGOUSER
2624 // fixed syntax errors in signin.tmpl
2626 // Revision 1.56 2004/05/15 22:54:49 rurban
2627 // fixed important WikiDB bug with DEBUG > 0: wrong assertion
2628 // improved SetAcl (works) and PagePerms, some WikiGroup helpers.
2630 // Revision 1.55 2004/05/12 19:27:47 rurban
2631 // revert wrong inline optimization.
2633 // Revision 1.54 2004/05/12 10:49:55 rurban
2634 // require_once fix for those libs which are loaded before FileFinder and
2635 // its automatic include_path fix, and where require_once doesn't grok
2636 // dirname(__FILE__) != './lib'
2637 // upgrade fix with PearDB
2638 // navbar.tmpl: remove spaces for IE button alignment
2640 // Revision 1.53 2004/05/08 14:06:12 rurban
2641 // new support for inlined image attributes: [image.jpg size=50x30 align=right]
2642 // minor stability and portability fixes
2644 // Revision 1.52 2004/05/06 19:26:16 rurban
2645 // improve stability, trying to find the InlineParser endless loop on sf.net
2647 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
2649 // Revision 1.51 2004/05/06 17:30:37 rurban
2650 // CategoryGroup: oops, dos2unix eol
2651 // improved phpwiki_version:
2652 // pre -= .0001 (1.3.10pre: 1030.099)
2653 // -p1 += .001 (1.3.9-p1: 1030.091)
2654 // improved InstallTable for mysql and generic SQL versions and all newer tables so far.
2655 // abstracted more ADODB/PearDB methods for action=upgrade stuff:
2656 // backend->backendType(), backend->database(),
2657 // backend->listOfFields(),
2658 // backend->listOfTables(),
2660 // Revision 1.50 2004/05/04 22:34:25 rurban
2663 // Revision 1.49 2004/05/03 11:16:40 rurban
2664 // fixed sendPageChangeNotification
2665 // subject rewording
2667 // Revision 1.48 2004/04/29 23:03:54 rurban
2668 // fixed sf.net bug #940996
2670 // Revision 1.47 2004/04/29 19:39:44 rurban
2671 // special support for formatted plugins (one-liners)
2672 // like <small><plugin BlaBla ></small>
2673 // iter->asArray() helper for PopularNearby
2674 // db_session for older php's (no &func() allowed)
2676 // Revision 1.46 2004/04/26 20:44:34 rurban
2677 // locking table specific for better databases
2679 // Revision 1.45 2004/04/20 00:06:03 rurban
2680 // themable paging support
2682 // Revision 1.44 2004/04/19 18:27:45 rurban
2683 // Prevent from some PHP5 warnings (ref args, no :: object init)
2684 // php5 runs now through, just one wrong XmlElement object init missing
2685 // Removed unneccesary UpgradeUser lines
2686 // Changed WikiLink to omit version if current (RecentChanges)
2688 // Revision 1.43 2004/04/18 01:34:20 rurban
2689 // protect most_popular from sortby=mtime
2691 // Revision 1.42 2004/04/18 01:11:51 rurban
2692 // more numeric pagename fixes.
2693 // fixed action=upload with merge conflict warnings.
2694 // charset changed from constant to global (dynamic utf-8 switching)
2700 // c-basic-offset: 4
2701 // c-hanging-comment-ender-p: nil
2702 // indent-tabs-mode: nil