2 rcs_id('$Id: WikiDB.php,v 1.156 2007-09-12 19:38:05 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 include_once("lib/MailNotify.php");
221 $MailNotify = new MailNotify($pagename);
222 $MailNotify->onDeletePage ($this, $pagename);
224 //How to create a RecentChanges entry with explaining summary? Dynamically
226 $page = $this->getPage($pagename);
227 $current = $page->getCurrentRevision();
228 $meta = $current->_data;
229 $version = $current->getVersion();
230 $meta['summary'] = _("removed");
231 $page->save($current->getPackedContent(), $version + 1, $meta);
237 * Completely remove the page from the WikiDB, without undo possibility.
239 * @param string $pagename Name of page to delete.
242 function purgePage($pagename) {
243 $result = $this->_cache->purge_page($pagename);
244 $this->deletePage($pagename); // just for the notification
249 * Retrieve all pages.
251 * Gets the set of all pages with non-default contents.
255 * @param boolean $include_empty Optional. Normally pages whose most
256 * recent revision has empty content are considered to be
257 * non-existant. Unless $include_defaulted is set to true, those
258 * pages will not be returned.
259 * @param string or false $sortby Optional. "+-column,+-column2".
260 * If false the result is faster in natural order.
261 * @param string or false $limit Optional. Encoded as "$offset,$count".
262 * $offset defaults to 0.
263 * @param string $exclude: Optional comma-seperated list of pagenames.
265 * @return WikiDB_PageIterator A WikiDB_PageIterator which contains all pages
266 * in the WikiDB which have non-default contents.
268 function getAllPages($include_empty=false, $sortby='', $limit='', $exclude='')
270 // HACK: memory_limit=8M will fail on too large pagesets. old php on unix only!
272 $mem = ini_get("memory_limit");
273 if ($mem and !$limit and !isWindows() and !check_php_version(4,3)) {
275 $GLOBALS['request']->setArg('limit', $limit);
276 $GLOBALS['request']->setArg('paging', 'auto');
279 $result = $this->_backend->get_all_pages($include_empty, $sortby, $limit,
281 return new WikiDB_PageIterator($this, $result,
282 array('include_empty' => $include_empty,
283 'exclude' => $exclude,
290 * @param boolean $include_empty If true include also empty pages
291 * @param string $exclude: comma-seperated list of pagenames.
292 * TBD: array of pagenames
296 function numPages($include_empty=false, $exclude='') {
297 if (method_exists($this->_backend, 'numPages'))
298 // FIXME: currently are all args ignored.
299 $count = $this->_backend->numPages($include_empty, $exclude);
301 // FIXME: exclude ignored.
302 $iter = $this->getAllPages($include_empty, false, false, $exclude);
303 $count = $iter->count();
312 * Search for pages containing (or not containing) certain words
315 * Pages are returned in alphabetical order whenever it is
316 * practical to do so.
317 * TODO: Sort by ranking. Only postgresql with tsearch2 can do ranking so far.
320 * @param TextSearchQuery $search A TextSearchQuery object
321 * @param string or false $sortby Optional. "+-column,+-column2".
322 * If false the result is faster in natural order.
323 * @param string or false $limit Optional. Encoded as "$offset,$count".
324 * $offset defaults to 0.
325 * @param string $exclude: Optional comma-seperated list of pagenames.
326 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
327 * @see TextSearchQuery
329 function titleSearch($search, $sortby='pagename', $limit='', $exclude='') {
330 $result = $this->_backend->text_search($search, false, $sortby, $limit, $exclude);
331 $options = array('exclude' => $exclude,
333 //if (isset($result->_count)) $options['count'] = $result->_count;
334 return new WikiDB_PageIterator($this, $result, $options);
340 * Search for pages containing (or not containing) certain words
341 * in their entire text (this includes the page content and the
344 * Pages are returned in alphabetical order whenever it is
345 * practical to do so.
346 * TODO: Sort by ranking. Only postgresql with tsearch2 can do ranking so far.
350 * @param TextSearchQuery $search A TextSearchQuery object.
351 * @param string or false $sortby Optional. "+-column,+-column2".
352 * If false the result is faster in natural order.
353 * @param string or false $limit Optional. Encoded as "$offset,$count".
354 * $offset defaults to 0.
355 * @param string $exclude: Optional comma-seperated list of pagenames.
356 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching pages.
357 * @see TextSearchQuery
359 function fullSearch($search, $sortby='pagename', $limit='', $exclude='') {
360 $result = $this->_backend->text_search($search, true, $sortby, $limit, $exclude);
361 return new WikiDB_PageIterator($this, $result,
362 array('exclude' => $exclude,
364 'stoplisted' => $result->stoplisted
369 * Find the pages with the greatest hit counts.
371 * Pages are returned in reverse order by hit count.
375 * @param integer $limit The maximum number of pages to return.
376 * Set $limit to zero to return all pages. If $limit < 0, pages will
377 * be sorted in decreasing order of popularity.
378 * @param string or false $sortby Optional. "+-column,+-column2".
379 * If false the result is faster in natural order.
381 * @return WikiDB_PageIterator A WikiDB_PageIterator containing the matching
384 function mostPopular($limit = 20, $sortby = '-hits') {
385 $result = $this->_backend->most_popular($limit, $sortby);
386 return new WikiDB_PageIterator($this, $result);
390 * Find recent page revisions.
392 * Revisions are returned in reverse order by creation time.
396 * @param hash $params This hash is used to specify various optional
400 * <dd> (integer) At most this many revisions will be returned.
402 * <dd> (integer) Only revisions since this time (unix-timestamp)
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
416 * containing the matching revisions.
418 function mostRecent($params = false) {
419 $result = $this->_backend->most_recent($params);
420 return new WikiDB_PageRevisionIterator($this, $result);
426 * @param string or false $sortby Optional. "+-column,+-column2".
427 * If false the result is faster in natural order.
428 * @param string or false $limit Optional. Encoded as "$offset,$count".
429 * $offset defaults to 0.
430 * @return Iterator A generic iterator containing rows of
431 * (duplicate) pagename, wantedfrom.
433 function wantedPages($exclude_from='', $exclude='', $sortby='', $limit='') {
434 return $this->_backend->wanted_pages($exclude_from, $exclude, $sortby, $limit);
435 //return new WikiDB_PageIterator($this, $result);
439 * Generic interface to the link table. Esp. useful to search for rdf triples as in
440 * SemanticSearch and ListRelations.
444 * @param $pages object A TextSearchQuery object.
445 * @param $search object A TextSearchQuery object.
446 * @param string $linktype One of "linkto", "linkfrom", "relation", "attribute".
447 * linktype parameter:
450 * <dd> search for simple out-links
452 * <dd> in-links, i.e BackLinks
454 * <dd> the first part in a <>::<> link
456 * <dd> the first part in a <>:=<> link
458 * @param $relation object An optional TextSearchQuery to match the
459 * relation name. Ignored on simple in-out links.
461 * @return Iterator A generic iterator containing links to pages or values.
462 * hash of "pagename", "linkname", "linkvalue.
464 function linkSearch($pages, $search, $linktype, $relation=false) {
465 return $this->_backend->link_search($pages, $search, $linktype, $relation);
469 * Return a simple list of all defined relations (and attributes), mainly
470 * for the SemanticSearch autocompletion.
474 * @return array of strings
476 function listRelations($also_attributes=false, $only_attributes=false, $sorted=true) {
477 if (method_exists($this->_backend, "list_relations"))
478 return $this->_backend->list_relations($also_attributes, $only_attributes, $sorted);
479 // dumb, slow fallback. no iter, so simply define it here.
480 $relations = array();
481 $iter = $this->getAllPages();
482 while ($page = $iter->next()) {
483 $reliter = $page->getRelations();
485 while ($rel = $reliter->next()) {
486 // if there's no pagename it's an attribute
487 $names[] = $rel->getName();
489 $relations = array_merge($relations, $names);
501 * Call the appropriate backend method.
504 * @param string $from Page to rename
505 * @param string $to New name
506 * @param boolean $updateWikiLinks If the text in all pages should be replaced.
507 * @return boolean true or false
509 function renamePage($from, $to, $updateWikiLinks = false) {
510 assert(is_string($from) && $from != '');
511 assert(is_string($to) && $to != '');
513 if (method_exists($this->_backend, 'rename_page')) {
514 $oldpage = $this->getPage($from);
515 $newpage = $this->getPage($to);
516 //update all WikiLinks in existing pages
517 //non-atomic! i.e. if rename fails the links are not undone
518 if ($updateWikiLinks) {
519 $lookbehind = "/(?<=[\W:])\Q";
520 $lookahead = "\E(?=[\W:])/";
521 if (!check_php_version(4,3,3)) {
522 $lookbehind = "/(?<=[\W:])";
523 $lookahead = "(?=[\W:])/";
524 $from = preg_quote($from, "/");
525 $to = preg_quote($to, "/");
527 require_once('lib/plugin/WikiAdminSearchReplace.php');
528 $links = $oldpage->getBackLinks();
529 while ($linked_page = $links->next()) {
530 WikiPlugin_WikiAdminSearchReplace::replaceHelper
532 $linked_page->getName(),
533 $lookbehind.$from.$lookahead, $to,
536 $links = $newpage->getBackLinks();
537 while ($linked_page = $links->next()) {
538 WikiPlugin_WikiAdminSearchReplace::replaceHelper
540 $linked_page->getName(),
541 $lookbehind.$from.$lookahead, $to,
545 if ($oldpage->exists() and ! $newpage->exists()) {
546 if ($result = $this->_backend->rename_page($from, $to)) {
547 // create a RecentChanges entry with explaining summary
548 $page = $this->getPage($to);
549 $current = $page->getCurrentRevision();
550 $meta = $current->_data;
551 $version = $current->getVersion();
552 $meta['summary'] = sprintf(_("renamed from %s"), $from);
553 unset($meta['mtime']); // force new date
554 $page->save($current->getPackedContent(), $version + 1, $meta);
556 } elseif (!$oldpage->getCurrentRevision(false) and !$newpage->exists()) {
557 // if a version 0 exists try it also.
558 $result = $this->_backend->rename_page($from, $to);
561 trigger_error(_("WikiDB::renamePage() not yet implemented for this backend"),
564 /* Generate notification emails? */
565 if ($result and !isa($GLOBALS['request'], 'MockRequest')) {
566 $notify = $this->get('notify');
567 if (!empty($notify) and is_array($notify)) {
568 include_once("lib/MailNotify.php");
569 $MailNotify = new MailNotify($from);
570 $MailNotify->onRenamePage ($this, $from, $to);
576 /** Get timestamp when database was last modified.
578 * @return string A string consisting of two integers,
579 * separated by a space. The first is the time in
580 * unix timestamp format, the second is a modification
581 * count for the database.
583 * The idea is that you can cast the return value to an
584 * int to get a timestamp, or you can use the string value
585 * as a good hash for the entire database.
587 function getTimestamp() {
588 $ts = $this->get('_timestamp');
589 return sprintf("%d %d", $ts[0], $ts[1]);
593 * Update the database timestamp.
597 $ts = $this->get('_timestamp');
598 $this->set('_timestamp', array(time(), $ts[1] + 1));
602 * Roughly similar to the float in phpwiki_version(). Set by action=upgrade.
604 function get_db_version() {
605 return (float) $this->get('_db_version');
607 function set_db_version($ver) {
608 return $this->set('_db_version', (float)$ver);
612 * Access WikiDB global meta-data.
614 * NOTE: this is currently implemented in a hackish and
615 * not very efficient manner.
619 * @param string $key Which meta data to get.
620 * Some reserved meta-data keys are:
622 * <dt>'_timestamp' <dd> Data used by getTimestamp().
625 * @return scalar The requested value, or false if the requested data
629 if (!$key || $key[0] == '%')
632 * Hack Alert: We can use any page (existing or not) to store
633 * this data (as long as we always use the same one.)
635 $gd = $this->getPage('global_data');
636 $data = $gd->get('__global');
638 if ($data && isset($data[$key]))
645 * Set global meta-data.
647 * NOTE: this is currently implemented in a hackish and
648 * not very efficient manner.
653 * @param string $key Meta-data key to set.
654 * @param string $newval New value.
656 function set($key, $newval) {
657 if (!$key || $key[0] == '%')
660 $gd = $this->getPage('global_data');
661 $data = $gd->get('__global');
668 $data[$key] = $newval;
670 $gd->set('__global', $data);
673 /* TODO: these are really backend methods */
675 // SQL result: for simple select or create/update queries
676 // returns the database specific resource type
677 function genericSqlQuery($sql, $args=false) {
678 if (function_exists('debug_backtrace')) { // >= 4.3.0
679 echo "<pre>", printSimpleTrace(debug_backtrace()), "</pre>\n";
681 trigger_error("no SQL database", E_USER_ERROR);
685 // SQL iter: for simple select or create/update queries
686 // returns the generic iterator object (count,next)
687 function genericSqlIter($sql, $field_list = NULL) {
688 if (function_exists('debug_backtrace')) { // >= 4.3.0
689 echo "<pre>", printSimpleTrace(debug_backtrace()), "</pre>\n";
691 trigger_error("no SQL database", E_USER_ERROR);
695 // see backend upstream methods
696 // ADODB adds surrounding quotes, SQL not yet!
697 function quote ($s) {
703 if (!$request->_dbi) return false;
704 else return false; /* so far only needed for sql so false it.
705 later we have to check dba also */
708 function getParam($param) {
710 if (isset($DBParams[$param])) return $DBParams[$param];
711 elseif ($param == 'prefix') return '';
715 function getAuthParam($param) {
716 global $DBAuthParams;
717 if (isset($DBAuthParams[$param])) return $DBAuthParams[$param];
718 elseif ($param == 'USER_AUTH_ORDER') return $GLOBALS['USER_AUTH_ORDER'];
719 elseif ($param == 'USER_AUTH_POLICY') return $GLOBALS['USER_AUTH_POLICY'];
726 * An abstract base class which representing a wiki-page within a
729 * A WikiDB_Page contains a number (at least one) of
730 * WikiDB_PageRevisions.
734 function WikiDB_Page(&$wikidb, $pagename) {
735 $this->_wikidb = &$wikidb;
736 $this->_pagename = $pagename;
738 if (!(is_string($pagename) and $pagename != '')) {
739 if (function_exists("xdebug_get_function_stack")) {
740 echo "xdebug_get_function_stack(): "; var_dump(xdebug_get_function_stack());
741 } elseif (function_exists("debug_backtrace")) { // >= 4.3.0
742 printSimpleTrace(debug_backtrace());
744 trigger_error("empty pagename", E_USER_WARNING);
748 assert(is_string($pagename) and $pagename != '');
753 * Get the name of the wiki page.
757 * @return string The page name.
760 return $this->_pagename;
763 // To reduce the memory footprint for larger sets of pagelists,
764 // we don't cache the content (only true or false) and
765 // we purge the pagedata (_cached_html) also
767 if (isset($this->_wikidb->_cache->_id_cache[$this->_pagename])) return true;
768 $current = $this->getCurrentRevision(false);
769 if (!$current) return false;
770 return ! $current->hasDefaultContents();
774 * Delete an old revision of a WikiDB_Page.
776 * Deletes the specified revision of the page.
777 * It is a fatal error to attempt to delete the current revision.
781 * @param integer $version Which revision to delete. (You can also
782 * use a WikiDB_PageRevision object here.)
784 function deleteRevision($version) {
785 $backend = &$this->_wikidb->_backend;
786 $cache = &$this->_wikidb->_cache;
787 $pagename = &$this->_pagename;
789 $version = $this->_coerce_to_version($version);
793 $backend->lock(array('page','version'));
794 $latestversion = $cache->get_latest_version($pagename);
795 if ($latestversion && ($version == $latestversion)) {
796 $backend->unlock(array('page','version'));
797 trigger_error(sprintf("Attempt to delete most recent revision of '%s'",
798 $pagename), E_USER_ERROR);
802 $cache->delete_versiondata($pagename, $version);
803 $backend->unlock(array('page','version'));
807 * Delete a revision, or possibly merge it with a previous
811 * Suppose an author make a (major) edit to a page. Shortly
812 * after that the same author makes a minor edit (e.g. to fix
813 * spelling mistakes he just made.)
815 * Now some time later, where cleaning out old saved revisions,
816 * and would like to delete his minor revision (since there's
817 * really no point in keeping minor revisions around for a long
820 * Note that the text after the minor revision probably represents
821 * what the author intended to write better than the text after
822 * the preceding major edit.
824 * So what we really want to do is merge the minor edit with the
827 * We will only do this when:
829 * <li>The revision being deleted is a minor one, and
830 * <li>It has the same author as the immediately preceding revision.
833 function mergeRevision($version) {
834 $backend = &$this->_wikidb->_backend;
835 $cache = &$this->_wikidb->_cache;
836 $pagename = &$this->_pagename;
838 $version = $this->_coerce_to_version($version);
842 $backend->lock(array('version'));
843 $latestversion = $cache->get_latest_version($pagename);
844 if ($latestversion && $version == $latestversion) {
845 $backend->unlock(array('version'));
846 trigger_error(sprintf("Attempt to merge most recent revision of '%s'",
847 $pagename), E_USER_ERROR);
851 $versiondata = $cache->get_versiondata($pagename, $version, true);
853 // Not there? ... we're done!
854 $backend->unlock(array('version'));
858 if ($versiondata['is_minor_edit']) {
859 $previous = $backend->get_previous_version($pagename, $version);
861 $prevdata = $cache->get_versiondata($pagename, $previous);
862 if ($prevdata['author_id'] == $versiondata['author_id']) {
863 // This is a minor revision, previous version is
864 // by the same author. We will merge the
866 $cache->update_versiondata($pagename, $previous,
867 array('%content' => $versiondata['%content'],
868 '_supplanted' => $versiondata['_supplanted']));
873 $cache->delete_versiondata($pagename, $version);
874 $backend->unlock(array('version'));
879 * Create a new revision of a {@link WikiDB_Page}.
883 * @param int $version Version number for new revision.
884 * To ensure proper serialization of edits, $version must be
885 * exactly one higher than the current latest version.
886 * (You can defeat this check by setting $version to
887 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
889 * @param string $content Contents of new revision.
891 * @param hash $metadata Metadata for new revision.
892 * All values in the hash should be scalars (strings or integers).
894 * @param hash $links List of linkto=>pagename, relation=>pagename which this page links to.
896 * @return WikiDB_PageRevision Returns the new WikiDB_PageRevision object. If
897 * $version was incorrect, returns false
899 function createRevision($version, &$content, $metadata, $links) {
900 $backend = &$this->_wikidb->_backend;
901 $cache = &$this->_wikidb->_cache;
902 $pagename = &$this->_pagename;
903 $cache->invalidate_cache($pagename);
905 $backend->lock(array('version','page','recent','link','nonempty'));
907 $latestversion = $backend->get_latest_version($pagename);
908 $newversion = ($latestversion ? $latestversion : 0) + 1;
909 assert($newversion >= 1);
911 if ($version != WIKIDB_FORCE_CREATE and $version != $newversion) {
912 $backend->unlock(array('version','page','recent','link','nonempty'));
918 foreach ($data as $key => $val) {
919 if (empty($val) || $key[0] == '_' || $key[0] == '%')
923 assert(!empty($data['author']));
924 if (empty($data['author_id']))
925 @$data['author_id'] = $data['author'];
927 if (empty($data['mtime']))
928 $data['mtime'] = time();
930 if ($latestversion and $version != WIKIDB_FORCE_CREATE) {
931 // Ensure mtimes are monotonic.
932 $pdata = $cache->get_versiondata($pagename, $latestversion);
933 if ($data['mtime'] < $pdata['mtime']) {
934 trigger_error(sprintf(_("%s: Date of new revision is %s"),
935 $pagename,"'non-monotonic'"),
937 $data['orig_mtime'] = $data['mtime'];
938 $data['mtime'] = $pdata['mtime'];
941 // FIXME: use (possibly user specified) 'mtime' time or
943 $cache->update_versiondata($pagename, $latestversion,
944 array('_supplanted' => $data['mtime']));
947 $data['%content'] = &$content;
949 $cache->set_versiondata($pagename, $newversion, $data);
951 //$cache->update_pagedata($pagename, array(':latestversion' => $newversion,
952 //':deleted' => empty($content)));
954 $backend->set_links($pagename, $links);
956 $backend->unlock(array('version','page','recent','link','nonempty'));
958 return new WikiDB_PageRevision($this->_wikidb, $pagename, $newversion,
962 /** A higher-level interface to createRevision.
964 * This takes care of computing the links, and storing
965 * a cached version of the transformed wiki-text.
967 * @param string $wikitext The page content.
969 * @param int $version Version number for new revision.
970 * To ensure proper serialization of edits, $version must be
971 * exactly one higher than the current latest version.
972 * (You can defeat this check by setting $version to
973 * {@link WIKIDB_FORCE_CREATE} --- not usually recommended.)
975 * @param hash $meta Meta-data for new revision.
977 function save($wikitext, $version, $meta, $formatted = null) {
978 if (is_null($formatted))
979 $formatted = new TransformedText($this, $wikitext, $meta);
980 $type = $formatted->getType();
981 $meta['pagetype'] = $type->getName();
982 $links = $formatted->getWikiPageLinks(); // linkto => relation
983 $attributes = array();
984 foreach ($links as $link) {
985 if ($link['linkto'] === "" and $link['relation']) {
986 $attributes[$link['relation']] = $this->getAttribute($link['relation']);
989 $meta['attribute'] = $attributes;
991 $backend = &$this->_wikidb->_backend;
992 $newrevision = $this->createRevision($version, $wikitext, $meta, $links);
993 if ($newrevision and !WIKIDB_NOCACHE_MARKUP)
994 $this->set('_cached_html', $formatted->pack());
996 // FIXME: probably should have some global state information
997 // in the backend to control when to optimize.
999 // We're doing this here rather than in createRevision because
1000 // postgresql can't optimize while locked.
1001 if (((int)DEBUG & _DEBUG_SQL)
1002 or (DATABASE_OPTIMISE_FREQUENCY > 0 and
1003 (time() % DATABASE_OPTIMISE_FREQUENCY == 0))) {
1004 if ($backend->optimize()) {
1006 trigger_error(_("Optimizing database"), E_USER_NOTICE);
1010 /* Generate notification emails? */
1011 if (isa($newrevision, 'WikiDB_PageRevision')) {
1012 // Save didn't fail because of concurrent updates.
1013 $notify = $this->_wikidb->get('notify');
1015 and is_array($notify)
1016 and !isa($GLOBALS['request'],'MockRequest'))
1018 include_once("lib/MailNotify.php");
1019 $MailNotify = new MailNotify($newrevision->getName());
1020 $MailNotify->onChangePage ($this->_wikidb, $wikitext, $version, $meta);
1022 $newrevision->_transformedContent = $formatted;
1025 return $newrevision;
1029 * Get the most recent revision of a page.
1033 * @return WikiDB_PageRevision The current WikiDB_PageRevision object.
1035 function getCurrentRevision ($need_content=true) {
1036 $backend = &$this->_wikidb->_backend;
1037 $cache = &$this->_wikidb->_cache;
1038 $pagename = &$this->_pagename;
1040 // Prevent deadlock in case of memory exhausted errors
1041 // Pure selection doesn't really need locking here.
1042 // sf.net bug#927395
1043 // I know it would be better to lock, but with lots of pages this deadlock is more
1044 // severe than occasionally get not the latest revision.
1045 // In spirit to wikiwiki: read fast, edit slower.
1047 $version = $cache->get_latest_version($pagename);
1048 // getRevision gets the content also!
1049 $revision = $this->getRevision($version, $need_content);
1050 //$backend->unlock();
1056 * Get a specific revision of a WikiDB_Page.
1060 * @param integer $version Which revision to get.
1062 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or
1063 * false if the requested revision does not exist in the {@link WikiDB}.
1064 * Note that version zero of any page always exists.
1066 function getRevision ($version, $need_content=true) {
1067 $cache = &$this->_wikidb->_cache;
1068 $pagename = &$this->_pagename;
1070 if (! $version or $version == -1) // 0 or false
1071 return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
1073 assert($version > 0);
1074 $vdata = $cache->get_versiondata($pagename, $version, $need_content);
1076 return new WikiDB_PageRevision($this->_wikidb, $pagename, 0);
1078 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1083 * Get previous page revision.
1085 * This method find the most recent revision before a specified
1090 * @param integer $version Find most recent revision before this version.
1091 * You can also use a WikiDB_PageRevision object to specify the $version.
1093 * @return WikiDB_PageRevision The requested WikiDB_PageRevision object, or false if the
1094 * requested revision does not exist in the {@link WikiDB}. Note that
1095 * unless $version is greater than zero, a revision (perhaps version zero,
1096 * the default revision) will always be found.
1098 function getRevisionBefore ($version=false, $need_content=true) {
1099 $backend = &$this->_wikidb->_backend;
1100 $pagename = &$this->_pagename;
1101 if ($version === false)
1102 $version = $this->_wikidb->_cache->get_latest_version($pagename);
1104 $version = $this->_coerce_to_version($version);
1109 $previous = $backend->get_previous_version($pagename, $version);
1110 $revision = $this->getRevision($previous, $need_content);
1111 //$backend->unlock();
1117 * Get all revisions of the WikiDB_Page.
1119 * This does not include the version zero (default) revision in the
1120 * returned revision set.
1122 * @return WikiDB_PageRevisionIterator A
1123 * WikiDB_PageRevisionIterator containing all revisions of this
1124 * WikiDB_Page in reverse order by version number.
1126 function getAllRevisions() {
1127 $backend = &$this->_wikidb->_backend;
1128 $revs = $backend->get_all_revisions($this->_pagename);
1129 return new WikiDB_PageRevisionIterator($this->_wikidb, $revs);
1133 * Find pages which link to or are linked from a page.
1134 * relations: $backend->get_links is responsible to add the relation to the pagehash
1135 * as 'linkrelation' key as pagename. See WikiDB_PageIterator::next
1136 * if (isset($next['linkrelation']))
1140 * @param boolean $reversed Which links to find: true for backlinks (default).
1142 * @return WikiDB_PageIterator A WikiDB_PageIterator containing
1143 * all matching pages.
1145 function getLinks ($reversed=true, $include_empty=false, $sortby='',
1146 $limit='', $exclude='', $want_relations=false)
1148 $backend = &$this->_wikidb->_backend;
1149 $result = $backend->get_links($this->_pagename, $reversed,
1150 $include_empty, $sortby, $limit, $exclude,
1152 return new WikiDB_PageIterator($this->_wikidb, $result,
1153 array('include_empty' => $include_empty,
1154 'sortby' => $sortby,
1156 'exclude' => $exclude,
1157 'want_relations'=> $want_relations));
1161 * All Links from other pages to this page.
1163 function getBackLinks($include_empty=false, $sortby='', $limit='', $exclude='',
1164 $want_relations=false)
1166 return $this->getLinks(true, $include_empty, $sortby, $limit, $exclude);
1169 * Forward Links: All Links from this page to other pages.
1171 function getPageLinks($include_empty=false, $sortby='', $limit='', $exclude='',
1172 $want_relations=false)
1174 return $this->getLinks(false, $include_empty, $sortby, $limit, $exclude);
1177 * Relations: All links from this page to other pages with relation <> 0.
1178 * is_a:=page or population:=number
1180 function getRelations($sortby='', $limit='', $exclude='') {
1181 $backend = &$this->_wikidb->_backend;
1182 $result = $backend->get_links($this->_pagename, false, true,
1183 $sortby, $limit, $exclude,
1185 // we do not care for the linked page versiondata, just the pagename and linkrelation
1186 return new WikiDB_PageIterator($this->_wikidb, $result,
1187 array('include_empty' => true,
1188 'sortby' => $sortby,
1190 'exclude' => $exclude,
1191 'want_relations'=> true));
1195 * possibly faster link existance check. not yet accelerated.
1197 function existLink($link, $reversed=false) {
1198 $backend = &$this->_wikidb->_backend;
1199 if (method_exists($backend,'exists_link'))
1200 return $backend->exists_link($this->_pagename, $link, $reversed);
1201 //$cache = &$this->_wikidb->_cache;
1202 // TODO: check cache if it is possible
1203 $iter = $this->getLinks($reversed, false);
1204 while ($page = $iter->next()) {
1205 if ($page->getName() == $link)
1212 /* Semantic relations are links with the relation pointing to another page,
1213 the so-called "RDF Triple".
1214 [San Diego] is%20a::city
1215 => "At the page San Diego there is a relation link of 'is a' to the page 'city'."
1218 /* Semantic attributes for a page.
1219 [San Diego] population:=1,305,736
1220 Attributes are links with the relation pointing to another page.
1224 * Access WikiDB_Page non version-specific meta-data.
1228 * @param string $key Which meta data to get.
1229 * Some reserved meta-data keys are:
1231 * <dt>'date' <dd> Created as unixtime
1232 * <dt>'locked'<dd> Is page locked? 'yes' or 'no'
1233 * <dt>'hits' <dd> Page hit counter.
1234 * <dt>'_cached_html' <dd> Transformed CachedMarkup object, serialized + optionally gzipped.
1235 * In SQL stored now in an extra column.
1237 * <dt>'pref' <dd> Users preferences, stored only in homepages.
1238 * <dt>'owner' <dd> Default: first author_id. We might add a group with a dot here:
1239 * E.g. "owner.users"
1240 * <dt>'perm' <dd> Permission flag to authorize read/write/execution of
1241 * page-headers and content.
1242 + <dt>'moderation'<dd> ModeratedPage data
1243 * <dt>'score' <dd> Page score (not yet implement, do we need?)
1246 * @return scalar The requested value, or false if the requested data
1249 function get($key) {
1250 $cache = &$this->_wikidb->_cache;
1251 $backend = &$this->_wikidb->_backend;
1252 if (!$key || $key[0] == '%')
1254 // several new SQL backends optimize this.
1255 if (!WIKIDB_NOCACHE_MARKUP
1256 and $key == '_cached_html'
1257 and method_exists($backend, 'get_cached_html'))
1259 return $backend->get_cached_html($this->_pagename);
1261 $data = $cache->get_pagedata($this->_pagename);
1262 return isset($data[$key]) ? $data[$key] : false;
1266 * Get all the page meta-data as a hash.
1268 * @return hash The page meta-data.
1270 function getMetaData() {
1271 $cache = &$this->_wikidb->_cache;
1272 $data = $cache->get_pagedata($this->_pagename);
1274 foreach ($data as $key => $val) {
1275 if (/*!empty($val) &&*/ $key[0] != '%')
1282 * Set page meta-data.
1287 * @param string $key Meta-data key to set.
1288 * @param string $newval New value.
1290 function set($key, $newval) {
1291 $cache = &$this->_wikidb->_cache;
1292 $backend = &$this->_wikidb->_backend;
1293 $pagename = &$this->_pagename;
1295 assert($key && $key[0] != '%');
1297 // several new SQL backends optimize this.
1298 if (!WIKIDB_NOCACHE_MARKUP
1299 and $key == '_cached_html'
1300 and method_exists($backend, 'set_cached_html'))
1302 return $backend->set_cached_html($pagename, $newval);
1305 $data = $cache->get_pagedata($pagename);
1307 if (!empty($newval)) {
1308 if (!empty($data[$key]) && $data[$key] == $newval)
1309 return; // values identical, skip update.
1312 if (empty($data[$key]))
1313 return; // values identical, skip update.
1316 $cache->update_pagedata($pagename, array($key => $newval));
1320 * Increase page hit count.
1322 * FIXME: IS this needed? Probably not.
1324 * This is a convenience function.
1325 * <pre> $page->increaseHitCount(); </pre>
1326 * is functionally identical to
1327 * <pre> $page->set('hits',$page->get('hits')+1); </pre>
1328 * but less expensive (ignores the pagadata string)
1330 * Note that this method may be implemented in more efficient ways
1331 * in certain backends.
1335 function increaseHitCount() {
1336 if (method_exists($this->_wikidb->_backend, 'increaseHitCount'))
1337 $this->_wikidb->_backend->increaseHitCount($this->_pagename);
1339 @$newhits = $this->get('hits') + 1;
1340 $this->set('hits', $newhits);
1345 * Return a string representation of the WikiDB_Page
1347 * This is really only for debugging.
1351 * @return string Printable representation of the WikiDB_Page.
1353 function asString () {
1355 printf("[%s:%s\n", get_class($this), $this->getName());
1356 print_r($this->getMetaData());
1358 $strval = ob_get_contents();
1366 * @param integer_or_object $version_or_pagerevision
1367 * Takes either the version number (and int) or a WikiDB_PageRevision
1369 * @return integer The version number.
1371 function _coerce_to_version($version_or_pagerevision) {
1372 if (method_exists($version_or_pagerevision, "getContent"))
1373 $version = $version_or_pagerevision->getVersion();
1375 $version = (int) $version_or_pagerevision;
1377 assert($version >= 0);
1381 function isUserPage ($include_empty = true) {
1382 if (!$include_empty and !$this->exists()) return false;
1383 return $this->get('pref') ? true : false;
1386 // May be empty. Either the stored owner (/Chown), or the first authorized author
1387 function getOwner() {
1388 if ($owner = $this->get('owner'))
1389 return ($owner == _("The PhpWiki programming team")) ? ADMIN_USER : $owner;
1390 // check all revisions forwards for the first author_id
1391 $backend = &$this->_wikidb->_backend;
1392 $pagename = &$this->_pagename;
1393 $latestversion = $backend->get_latest_version($pagename);
1394 for ($v=1; $v <= $latestversion; $v++) {
1395 $rev = $this->getRevision($v,false);
1396 if ($rev and $owner = $rev->get('author_id')) {
1397 return ($owner == _("The PhpWiki programming team")) ? ADMIN_USER : $owner;
1403 // The authenticated author of the first revision or empty if not authenticated then.
1404 function getCreator() {
1405 if ($current = $this->getRevision(1,false)) return $current->get('author_id');
1409 // The authenticated author of the current revision.
1410 function getAuthor() {
1411 if ($current = $this->getCurrentRevision(false)) return $current->get('author_id');
1415 /* Semantic Web value, not stored in the links.
1416 * todo: unify with some unit knowledge
1418 function setAttribute($relation, $value) {
1419 $attr = $this->get('attributes');
1421 $attr = array($relation => $value);
1423 $attr[$relation] = $value;
1424 $this->set('attributes', $attr);
1427 function getAttribute($relation) {
1428 $meta = $this->get('attributes');
1432 return $meta[$relation];
1438 * This class represents a specific revision of a WikiDB_Page within
1441 * A WikiDB_PageRevision has read-only semantics. You may only create
1442 * new revisions (and delete old ones) --- you cannot modify existing
1445 class WikiDB_PageRevision
1447 //var $_transformedContent = false; // set by WikiDB_Page::save()
1449 function WikiDB_PageRevision(&$wikidb, $pagename, $version, $versiondata = false) {
1450 $this->_wikidb = &$wikidb;
1451 $this->_pagename = $pagename;
1452 $this->_version = $version;
1453 $this->_data = $versiondata ? $versiondata : array();
1454 $this->_transformedContent = false; // set by WikiDB_Page::save()
1458 * Get the WikiDB_Page which this revision belongs to.
1462 * @return WikiDB_Page The WikiDB_Page which this revision belongs to.
1464 function getPage() {
1465 return new WikiDB_Page($this->_wikidb, $this->_pagename);
1469 * Get the version number of this revision.
1473 * @return integer The version number of this revision.
1475 function getVersion() {
1476 return $this->_version;
1480 * Determine whether this revision has defaulted content.
1482 * The default revision (version 0) of each page, as well as any
1483 * pages which are created with empty content have their content
1484 * defaulted to something like:
1486 * Describe [ThisPage] here.
1491 * @return boolean Returns true if the page has default content.
1493 function hasDefaultContents() {
1494 $data = &$this->_data;
1495 return empty($data['%content']); // FIXME: what if it's the number 0? <>'' or === false
1499 * Get the content as an array of lines.
1503 * @return array An array of lines.
1504 * The lines should contain no trailing white space.
1506 function getContent() {
1507 return explode("\n", $this->getPackedContent());
1511 * Get the pagename of the revision.
1515 * @return string pagename.
1517 function getPageName() {
1518 return $this->_pagename;
1520 function getName() {
1521 return $this->_pagename;
1525 * Determine whether revision is the latest.
1529 * @return boolean True iff the revision is the latest (most recent) one.
1531 function isCurrent() {
1532 if (!isset($this->_iscurrent)) {
1533 $page = $this->getPage();
1534 $current = $page->getCurrentRevision(false);
1535 $this->_iscurrent = $this->getVersion() == $current->getVersion();
1537 return $this->_iscurrent;
1541 * Get the transformed content of a page.
1543 * @param string $pagetype Override the page-type of the revision.
1545 * @return object An XmlContent-like object containing the page transformed
1548 function getTransformedContent($pagetype_override=false) {
1549 $backend = &$this->_wikidb->_backend;
1551 if ($pagetype_override) {
1552 // Figure out the normal page-type for this page.
1553 $type = PageType::GetPageType($this->get('pagetype'));
1554 if ($type->getName() == $pagetype_override)
1555 $pagetype_override = false; // Not really an override...
1558 if ($pagetype_override) {
1559 // Overriden page type, don't cache (or check cache).
1560 return new TransformedText($this->getPage(),
1561 $this->getPackedContent(),
1562 $this->getMetaData(),
1563 $pagetype_override);
1566 $possibly_cache_results = true;
1568 if (!USECACHE or WIKIDB_NOCACHE_MARKUP) {
1569 if (WIKIDB_NOCACHE_MARKUP == 'purge') {
1570 // flush cache for this page.
1571 $page = $this->getPage();
1572 $page->set('_cached_html', ''); // ignored with !USECACHE
1574 $possibly_cache_results = false;
1576 elseif (USECACHE and !$this->_transformedContent) {
1578 if ($this->isCurrent()) {
1579 $page = $this->getPage();
1580 $this->_transformedContent = TransformedText::unpack($page->get('_cached_html'));
1583 $possibly_cache_results = false;
1585 //$backend->unlock();
1588 if (!$this->_transformedContent) {
1589 $this->_transformedContent
1590 = new TransformedText($this->getPage(),
1591 $this->getPackedContent(),
1592 $this->getMetaData());
1594 if ($possibly_cache_results and !WIKIDB_NOCACHE_MARKUP) {
1595 // If we're still the current version, cache the transfomed page.
1597 if ($this->isCurrent()) {
1598 $page->set('_cached_html', $this->_transformedContent->pack());
1600 //$backend->unlock();
1604 return $this->_transformedContent;
1608 * Get the content as a string.
1612 * @return string The page content.
1613 * Lines are separated by new-lines.
1615 function getPackedContent() {
1616 $data = &$this->_data;
1618 if (empty($data['%content'])
1619 || (!$this->_wikidb->isWikiPage($this->_pagename)
1620 && $this->isCurrent())) {
1621 include_once('lib/InlineParser.php');
1623 // A feature similar to taglines at http://www.wlug.org.nz/
1624 // Lib from http://www.aasted.org/quote/
1625 if (defined('FORTUNE_DIR')
1626 and is_dir(FORTUNE_DIR)
1627 and in_array($GLOBALS['request']->getArg('action'),
1628 array('create','edit')))
1630 include_once("lib/fortune.php");
1631 $fortune = new Fortune();
1632 $quote = $fortune->quoteFromDir(FORTUNE_DIR);
1634 $quote = "<verbatim>\n"
1635 . str_replace("\n<br>","\n", $quote)
1636 . "</verbatim>\n\n";
1640 . sprintf(_("Describe %s here."),
1641 "[" . WikiEscape($this->_pagename) . "]");
1643 // Replace empty content with default value.
1644 return sprintf(_("Describe %s here."),
1645 "[" . WikiEscape($this->_pagename) . "]");
1648 // There is (non-default) content.
1649 assert($this->_version > 0);
1651 if (!is_string($data['%content'])) {
1652 // Content was not provided to us at init time.
1653 // (This is allowed because for some backends, fetching
1654 // the content may be expensive, and often is not wanted
1657 // In any case, now we need to get it.
1658 $data['%content'] = $this->_get_content();
1659 assert(is_string($data['%content']));
1662 return $data['%content'];
1665 function _get_content() {
1666 $cache = &$this->_wikidb->_cache;
1667 $pagename = $this->_pagename;
1668 $version = $this->_version;
1670 assert($version > 0);
1672 $newdata = $cache->get_versiondata($pagename, $version, true);
1674 assert(is_string($newdata['%content']));
1675 return $newdata['%content'];
1678 // else revision has been deleted... What to do?
1679 return __sprintf("Oops! Revision %s of %s seems to have been deleted!",
1680 $version, $pagename);
1685 * Get meta-data for this revision.
1690 * @param string $key Which meta-data to access.
1692 * Some reserved revision meta-data keys are:
1694 * <dt> 'mtime' <dd> Time this revision was created (seconds since midnight Jan 1, 1970.)
1695 * The 'mtime' meta-value is normally set automatically by the database
1696 * backend, but it may be specified explicitly when creating a new revision.
1698 * <dd> To ensure consistency of RecentChanges, the mtimes of the versions
1699 * of a page must be monotonically increasing. If an attempt is
1700 * made to create a new revision with an mtime less than that of
1701 * the preceeding revision, the new revisions timestamp is force
1702 * to be equal to that of the preceeding revision. In that case,
1703 * the originally requested mtime is preserved in 'orig_mtime'.
1704 * <dt> '_supplanted' <dd> Time this revision ceased to be the most recent.
1705 * This meta-value is <em>always</em> automatically maintained by the database
1706 * backend. (It is set from the 'mtime' meta-value of the superceding
1707 * revision.) '_supplanted' has a value of 'false' for the current revision.
1709 * FIXME: this could be refactored:
1711 * <dd> Author of the page (as he should be reported in, e.g. RecentChanges.)
1713 * <dd> Authenticated author of a page. This is used to identify
1714 * the distinctness of authors when cleaning old revisions from
1716 * <dt> 'is_minor_edit' <dd> Set if change was marked as a minor revision by the author.
1717 * <dt> 'summary' <dd> Short change summary entered by page author.
1720 * Meta-data keys must be valid C identifers (they have to start with a letter
1721 * or underscore, and can contain only alphanumerics and underscores.)
1723 * @return string The requested value, or false if the requested value
1726 function get($key) {
1727 if (!$key || $key[0] == '%')
1729 $data = &$this->_data;
1730 return isset($data[$key]) ? $data[$key] : false;
1734 * Get all the revision page meta-data as a hash.
1736 * @return hash The revision meta-data.
1738 function getMetaData() {
1740 foreach ($this->_data as $key => $val) {
1741 if (!empty($val) && $key[0] != '%')
1749 * Return a string representation of the revision.
1751 * This is really only for debugging.
1755 * @return string Printable representation of the WikiDB_Page.
1757 function asString () {
1759 printf("[%s:%d\n", get_class($this), $this->get('version'));
1760 print_r($this->_data);
1761 echo $this->getPackedContent() . "\n]\n";
1762 $strval = ob_get_contents();
1770 * Class representing a sequence of WikiDB_Pages.
1771 * TODO: Enhance to php5 iterators
1773 * apply filters for options like 'sortby', 'limit', 'exclude'
1774 * for simple queries like titleSearch, where the backend is not ready yet.
1776 class WikiDB_PageIterator
1778 function WikiDB_PageIterator(&$wikidb, &$iter, $options=false) {
1779 $this->_iter = $iter; // a WikiDB_backend_iterator
1780 $this->_wikidb = &$wikidb;
1781 $this->_options = $options;
1785 return $this->_iter->count();
1789 * Get next WikiDB_Page in sequence.
1793 * @return WikiDB_Page The next WikiDB_Page in the sequence.
1796 if ( ! ($next = $this->_iter->next()) )
1799 $pagename = &$next['pagename'];
1800 if (!is_string($pagename)) { // Bug #1327912 fixed by Joachim Lous
1801 /*if (is_array($pagename) && isset($pagename['linkto'])) {
1802 $pagename = $pagename['linkto'];
1804 $pagename = strval($pagename);*/
1805 trigger_error("WikiDB_PageIterator->next pagename", E_USER_WARNING);
1808 if (isset($next['linkrelation'])
1809 or isset($next['pagedata']['linkrelation'])) return false;
1810 trigger_error('empty pagename in WikiDB_PageIterator::next()', E_USER_WARNING);
1814 // There's always hits, but we cache only if more
1815 // (well not with file, cvs and dba)
1816 if (isset($next['pagedata']) and count($next['pagedata']) > 1) {
1817 $this->_wikidb->_cache->cache_data($next);
1818 // cache existing page id's since we iterate over all links in GleanDescription
1819 // and need them later for LinkExistingWord
1820 } elseif ($this->_options and array_key_exists('include_empty', $this->_options)
1821 and !$this->_options['include_empty'] and isset($next['id'])) {
1822 $this->_wikidb->_cache->_id_cache[$next['pagename']] = $next['id'];
1824 $page = new WikiDB_Page($this->_wikidb, $pagename);
1825 if (isset($next['linkrelation']))
1826 $page->set('linkrelation', $next['linkrelation']);
1827 if (isset($next['score']))
1828 $page->score = $next['score'];
1833 * Release resources held by this iterator.
1835 * The iterator may not be used after free() is called.
1837 * There is no need to call free(), if next() has returned false.
1838 * (I.e. if you iterate through all the pages in the sequence,
1839 * you do not need to call free() --- you only need to call it
1840 * if you stop before the end of the iterator is reached.)
1845 $this->_iter->free();
1848 function asArray() {
1850 while ($page = $this->next())
1857 * Apply filters for options like 'sortby', 'limit', 'exclude'
1858 * for simple queries like titleSearch, where the backend is not ready yet.
1859 * Since iteration is usually destructive for SQL results,
1860 * we have to generate a copy.
1862 function applyFilters($options = false) {
1863 if (!$options) $options = $this->_options;
1864 if (isset($options['sortby'])) {
1866 /* this is destructive */
1867 while ($page = $this->next())
1868 $result[] = $page->getName();
1869 $this->_doSort($array, $options['sortby']);
1871 /* the rest is not destructive.
1872 * reconstruct a new iterator
1874 $pagenames = array(); $i = 0;
1875 if (isset($options['limit']))
1876 $limit = $options['limit'];
1879 if (isset($options['exclude']))
1880 $exclude = $options['exclude'];
1881 if (is_string($exclude) and !is_array($exclude))
1882 $exclude = PageList::explodePageList($exclude, false, false, $limit);
1883 foreach($array as $pagename) {
1884 if ($limit and $i++ > $limit)
1885 return new WikiDB_Array_PageIterator($pagenames);
1886 if (!empty($exclude) and !in_array($pagename, $exclude))
1887 $pagenames[] = $pagename;
1888 elseif (empty($exclude))
1889 $pagenames[] = $pagename;
1891 return new WikiDB_Array_PageIterator($pagenames);
1895 function _doSort(&$array, $sortby) {
1896 $sortby = PageList::sortby($sortby, 'init');
1897 if ($sortby == '+pagename')
1898 sort($array, SORT_STRING);
1899 elseif ($sortby == '-pagename')
1900 rsort($array, SORT_STRING);
1907 * A class which represents a sequence of WikiDB_PageRevisions.
1908 * TODO: Enhance to php5 iterators
1910 class WikiDB_PageRevisionIterator
1912 function WikiDB_PageRevisionIterator(&$wikidb, &$revisions, $options=false) {
1913 $this->_revisions = $revisions;
1914 $this->_wikidb = &$wikidb;
1915 $this->_options = $options;
1919 return $this->_revisions->count();
1923 * Get next WikiDB_PageRevision in sequence.
1927 * @return WikiDB_PageRevision
1928 * The next WikiDB_PageRevision in the sequence.
1931 if ( ! ($next = $this->_revisions->next()) )
1934 //$this->_wikidb->_cache->cache_data($next);
1936 $pagename = $next['pagename'];
1937 $version = $next['version'];
1938 $versiondata = $next['versiondata'];
1940 if (!(is_string($pagename) and $pagename != '')) {
1941 trigger_error("empty pagename",E_USER_WARNING);
1944 } else assert(is_string($pagename) and $pagename != '');
1946 if (!is_array($versiondata)) {
1947 trigger_error("empty versiondata",E_USER_WARNING);
1950 } else assert(is_array($versiondata));
1952 if (!($version > 0)) {
1953 trigger_error("invalid version",E_USER_WARNING);
1956 } else assert($version > 0);
1958 return new WikiDB_PageRevision($this->_wikidb, $pagename, $version,
1963 * Release resources held by this iterator.
1965 * The iterator may not be used after free() is called.
1967 * There is no need to call free(), if next() has returned false.
1968 * (I.e. if you iterate through all the revisions in the sequence,
1969 * you do not need to call free() --- you only need to call it
1970 * if you stop before the end of the iterator is reached.)
1975 $this->_revisions->free();
1978 function asArray() {
1980 while ($rev = $this->next())
1989 class WikiDB_Array_PageIterator
1991 function WikiDB_Array_PageIterator($pagenames) {
1993 $this->_dbi = $request->getDbh();
1994 $this->_pages = $pagenames;
1995 reset($this->_pages);
1998 $c = current($this->_pages);
1999 next($this->_pages);
2000 return $c !== false ? $this->_dbi->getPage($c) : false;
2003 return count($this->_pages);
2006 function asArray() {
2007 reset($this->_pages);
2008 return $this->_pages;
2012 class WikiDB_Array_generic_iter
2014 function WikiDB_Array_generic_iter($result) {
2015 // $result may be either an array or a query result
2016 if (is_array($result)) {
2017 $this->_array = $result;
2018 } elseif (is_object($result)) {
2019 $this->_array = $result->asArray();
2021 $this->_array = array();
2023 if (!empty($this->_array))
2024 reset($this->_array);
2027 $c = current($this->_array);
2028 next($this->_array);
2029 return $c !== false ? $c : false;
2032 return count($this->_array);
2035 function asArray() {
2036 if (!empty($this->_array))
2037 reset($this->_array);
2038 return $this->_array;
2043 * Data cache used by WikiDB.
2045 * FIXME: Maybe rename this to caching_backend (or some such).
2051 // FIXME: beautify versiondata cache. Cache only limited data?
2053 function WikiDB_cache (&$backend) {
2054 $this->_backend = &$backend;
2056 $this->_pagedata_cache = array();
2057 $this->_versiondata_cache = array();
2058 array_push ($this->_versiondata_cache, array());
2059 $this->_glv_cache = array();
2060 $this->_id_cache = array(); // formerly ->_dbi->_iwpcache (nonempty pages => id)
2064 $this->_pagedata_cache = array();
2065 $this->_versiondata_cache = array();
2066 $this->_glv_cache = array();
2067 $this->_id_cache = array();
2070 function get_pagedata($pagename) {
2071 assert(is_string($pagename) && $pagename != '');
2073 $cache = &$this->_pagedata_cache;
2074 if (!isset($cache[$pagename]) || !is_array($cache[$pagename])) {
2075 $cache[$pagename] = $this->_backend->get_pagedata($pagename);
2076 if (empty($cache[$pagename]))
2077 $cache[$pagename] = array();
2079 return $cache[$pagename];
2081 return $this->_backend->get_pagedata($pagename);
2085 function update_pagedata($pagename, $newdata) {
2086 assert(is_string($pagename) && $pagename != '');
2088 $this->_backend->update_pagedata($pagename, $newdata);
2091 if (!empty($this->_pagedata_cache[$pagename])
2092 and is_array($this->_pagedata_cache[$pagename]))
2094 $cachedata = &$this->_pagedata_cache[$pagename];
2095 foreach($newdata as $key => $val)
2096 $cachedata[$key] = $val;
2098 $this->_pagedata_cache[$pagename] = $newdata;
2102 function invalidate_cache($pagename) {
2103 unset ($this->_pagedata_cache[$pagename]);
2104 unset ($this->_versiondata_cache[$pagename]);
2105 unset ($this->_glv_cache[$pagename]);
2106 unset ($this->_id_cache[$pagename]);
2107 //unset ($this->_backend->_page_data);
2110 function delete_page($pagename) {
2111 $result = $this->_backend->delete_page($pagename);
2112 $this->invalidate_cache($pagename);
2116 function purge_page($pagename) {
2117 $result = $this->_backend->purge_page($pagename);
2118 $this->invalidate_cache($pagename);
2122 // FIXME: ugly and wrong. may overwrite full cache with partial cache
2123 function cache_data($data) {
2125 //if (isset($data['pagedata']))
2126 // $this->_pagedata_cache[$data['pagename']] = $data['pagedata'];
2129 function get_versiondata($pagename, $version, $need_content = false) {
2130 // FIXME: Seriously ugly hackage
2132 if (USECACHE) { //temporary - for debugging
2133 assert(is_string($pagename) && $pagename != '');
2134 // There is a bug here somewhere which results in an assertion failure at line 105
2135 // of ArchiveCleaner.php It goes away if we use the next line.
2136 //$need_content = true;
2137 $nc = $need_content ? '1':'0';
2138 $cache = &$this->_versiondata_cache;
2139 if (!isset($cache[$pagename][$version][$nc])
2140 || !(is_array ($cache[$pagename]))
2141 || !(is_array ($cache[$pagename][$version])))
2143 $cache[$pagename][$version][$nc] =
2144 $this->_backend->get_versiondata($pagename, $version, $need_content);
2146 // If we have retrieved all data, we may as well set the cache for
2147 // $need_content = false
2149 $cache[$pagename][$version]['0'] =& $cache[$pagename][$version]['1'];
2152 $vdata = $cache[$pagename][$version][$nc];
2154 $vdata = $this->_backend->get_versiondata($pagename, $version, $need_content);
2157 if ($readdata && $vdata && !empty($vdata['%pagedata'])) {
2158 $this->_pagedata_cache[$pagename] =& $vdata['%pagedata'];
2163 function set_versiondata($pagename, $version, $data) {
2164 //unset($this->_versiondata_cache[$pagename][$version]);
2166 $new = $this->_backend->set_versiondata($pagename, $version, $data);
2168 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2169 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2170 // Is this necessary?
2171 unset($this->_glv_cache[$pagename]);
2174 function update_versiondata($pagename, $version, $data) {
2175 $new = $this->_backend->update_versiondata($pagename, $version, $data);
2177 $this->_versiondata_cache[$pagename][$version]['1'] = $data;
2179 $this->_versiondata_cache[$pagename][$version]['0'] = $data;
2180 // Is this necessary?
2181 unset($this->_glv_cache[$pagename]);
2184 function delete_versiondata($pagename, $version) {
2185 $new = $this->_backend->delete_versiondata($pagename, $version);
2186 if (isset($this->_versiondata_cache[$pagename][$version]))
2187 unset ($this->_versiondata_cache[$pagename][$version]);
2188 // dirty latest version cache only if latest version gets deleted
2189 if (isset($this->_glv_cache[$pagename]) and $this->_glv_cache[$pagename] == $version)
2190 unset ($this->_glv_cache[$pagename]);
2193 function get_latest_version($pagename) {
2195 assert (is_string($pagename) && $pagename != '');
2196 $cache = &$this->_glv_cache;
2197 if (!isset($cache[$pagename])) {
2198 $cache[$pagename] = $this->_backend->get_latest_version($pagename);
2199 if (empty($cache[$pagename]))
2200 $cache[$pagename] = 0;
2202 return $cache[$pagename];
2204 return $this->_backend->get_latest_version($pagename);
2209 function _sql_debuglog($msg, $newline=true, $shutdown=false) {
2213 $stamp = strftime("%y%m%d-%H%M%S");
2214 $fp = fopen(TEMP_DIR."/sql-$stamp.log", "a");
2215 register_shutdown_function("_sql_debuglog_shutdown_function");
2216 } elseif ($shutdown) {
2220 if ($newline) fputs($fp, "[$i++] $msg");
2221 else fwrite($fp, $msg);
2224 function _sql_debuglog_shutdown_function() {
2225 _sql_debuglog('',false,true);
2228 // $Log: not supported by cvs2svn $
2229 // Revision 1.155 2007/07/15 17:39:33 rurban
2230 // stabilize rename updateWikiLinks to check only words
2232 // Revision 1.154 2007/07/14 12:03:58 rurban
2235 // Revision 1.153 2007/06/07 16:54:29 rurban
2236 // enable $MailNotify->onChangePage. support other formatters (MediaWiki, Creole, ...)
2238 // Revision 1.152 2007/05/28 20:13:46 rurban
2239 // Overwrite all attributes at once at page->save to delete dangling meta
2241 // Revision 1.151 2007/05/01 16:20:12 rurban
2242 // MailNotify->onChangePage only on DEBUG (still broken)
2244 // Revision 1.150 2007/03/18 17:35:27 rurban
2247 // Revision 1.149 2007/02/17 14:16:37 rurban
2248 // isWikiPage no error on empty pagenames. MailNotify->onChangePage fix by ??
2250 // Revision 1.148 2007/01/27 21:53:03 rurban
2251 // Use TEMP_DIR for debug sql.log
2253 // Revision 1.147 2007/01/04 16:41:41 rurban
2254 // Some pageiterators also set ['pagedata']['linkrelation'], hmm
2256 // Revision 1.146 2007/01/02 13:20:00 rurban
2257 // 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.
2259 // Revision 1.145 2006/12/22 17:59:55 rurban
2260 // Move mailer functions into seperate MailNotify.php
2262 // Revision 1.144 2006/10/12 06:36:09 rurban
2263 // Guard against unwanted DEBUG="DEBUG" logic. In detail (WikiDB),
2264 // and generally by forcing all int constants to be defined as int.
2266 // Revision 1.143 2006/09/06 05:46:40 rurban
2267 // do db backend check on _DEBUG_SQL
2269 // Revision 1.142 2006/06/10 11:55:58 rurban
2270 // print optimize only when DEBUG
2272 // Revision 1.141 2006/04/17 17:28:21 rurban
2273 // honor getWikiPageLinks change linkto=>relation
2275 // Revision 1.140 2006/03/19 14:23:51 rurban
2276 // sf.net patch #1377011 by Matt Brown: add DATABASE_OPTIMISE_FREQUENCY
2278 // Revision 1.139 2006/01/12 16:38:07 rurban
2279 // add page method listRelations()
2280 // fix bug #1327912 numeric pagenames can break plugins (Joachim Lous)
2282 // Revision 1.138 2005/11/14 22:27:07 rurban
2283 // add linkrelation support
2284 // getPageLinks returns now an array of hashes
2285 // pass stoplist through iterator
2287 // Revision 1.137 2005/10/12 06:16:18 rurban
2288 // better From header
2290 // Revision 1.136 2005/10/03 16:14:57 rurban
2291 // improve description
2293 // Revision 1.135 2005/09/11 14:19:44 rurban
2294 // enable LIMIT support for fulltext search
2296 // Revision 1.134 2005/09/10 21:28:10 rurban
2297 // applyFilters hack to use filters after methods, which do not support them (titleSearch)
2299 // Revision 1.133 2005/08/27 09:39:10 rurban
2300 // dumphtml when not at admin page: dump the current or given page
2302 // Revision 1.132 2005/08/07 10:10:07 rurban
2303 // clean whole version cache
2305 // Revision 1.131 2005/04/23 11:30:12 rurban
2306 // allow emtpy WikiDB::getRevisionBefore(), for simplier templates (revert)
2308 // Revision 1.130 2005/04/06 06:19:30 rurban
2309 // Revert the previous wrong bugfix #1175761: USECACHE was mixed with WIKIDB_NOCACHE_MARKUP.
2310 // Fix WIKIDB_NOCACHE_MARKUP in main (always set it) and clarify it in WikiDB
2312 // Revision 1.129 2005/04/06 05:50:29 rurban
2313 // honor !USECACHE for _cached_html, fixes #1175761
2315 // Revision 1.128 2005/04/01 16:11:42 rurban
2318 // Revision 1.127 2005/02/18 20:43:40 uckelman
2319 // WikiDB::genericWarnings() is no longer used.
2321 // Revision 1.126 2005/02/04 17:58:06 rurban
2322 // minor versioncache improvement. part 2/3 of Charles Corrigan cache patch. not sure about the 0/1 issue
2324 // Revision 1.125 2005/02/03 05:08:39 rurban
2325 // ref fix by Charles Corrigan
2327 // Revision 1.124 2005/01/29 20:43:32 rurban
2328 // protect against empty request: on some occasion this happens
2330 // Revision 1.123 2005/01/25 06:58:21 rurban
2333 // Revision 1.122 2005/01/20 10:18:17 rurban
2336 // Revision 1.121 2005/01/04 20:25:01 rurban
2337 // remove old [%pagedata][_cached_html] code
2339 // Revision 1.120 2004/12/23 14:12:31 rurban
2340 // dont email on unittest
2342 // Revision 1.119 2004/12/20 16:05:00 rurban
2343 // gettext msg unification
2345 // Revision 1.118 2004/12/13 13:22:57 rurban
2346 // new BlogArchives plugin for the new blog theme. enable default box method
2347 // for all plugins. Minor search improvement.
2349 // Revision 1.117 2004/12/13 08:15:09 rurban
2350 // false is wrong. null might be better but lets play safe.
2352 // Revision 1.116 2004/12/10 22:15:00 rurban
2353 // fix $page->get('_cached_html)
2354 // refactor upgrade db helper _convert_cached_html() to be able to call them from WikiAdminUtils also.
2355 // support 2nd genericSqlQuery param (bind huge arg)
2357 // Revision 1.115 2004/12/10 02:45:27 rurban
2358 // SQL optimization:
2359 // put _cached_html from pagedata into a new seperate blob, not huge serialized string.
2360 // it is only rarelely needed: for current page only, if-not-modified
2361 // but was extracted for every simple page iteration.
2363 // Revision 1.114 2004/12/09 22:24:44 rurban
2364 // optimize on _DEBUG_SQL only. but now again on every 50th request, not just save.
2366 // Revision 1.113 2004/12/06 19:49:55 rurban
2367 // enable action=remove which is undoable and seeable in RecentChanges: ADODB ony for now.
2368 // renamed delete_page to purge_page.
2369 // enable action=edit&version=-1 to force creation of a new version.
2370 // added BABYCART_PATH config
2371 // fixed magiqc in adodb.inc.php
2372 // and some more docs
2374 // Revision 1.112 2004/11/30 17:45:53 rurban
2375 // exists_links backend implementation
2377 // Revision 1.111 2004/11/28 20:39:43 rurban
2378 // deactivate pagecache overwrite: it is wrong
2380 // Revision 1.110 2004/11/26 18:39:01 rurban
2381 // new regex search parser and SQL backends (90% complete, glob and pcre backends missing)
2383 // Revision 1.109 2004/11/25 17:20:50 rurban
2384 // and again a couple of more native db args: backlinks
2386 // Revision 1.108 2004/11/23 13:35:31 rurban
2387 // add case_exact search
2389 // Revision 1.107 2004/11/21 11:59:16 rurban
2390 // remove final \n to be ob_cache independent
2392 // Revision 1.106 2004/11/20 17:35:56 rurban
2393 // improved WantedPages SQL backends
2394 // PageList::sortby new 3rd arg valid_fields (override db fields)
2395 // WantedPages sql pager inexact for performance reasons:
2396 // assume 3 wantedfrom per page, to be correct, no getTotal()
2397 // support exclude argument for get_all_pages, new _sql_set()
2399 // Revision 1.105 2004/11/20 09:16:27 rurban
2400 // Fix bad-style Cut&Paste programming errors, detected by Charles Corrigan.
2402 // Revision 1.104 2004/11/19 19:22:03 rurban
2403 // ModeratePage part1: change status
2405 // Revision 1.103 2004/11/16 17:29:04 rurban
2406 // fix remove notification error
2407 // fix creation + update id_cache update
2409 // Revision 1.102 2004/11/11 18:31:26 rurban
2410 // add simple backtrace on such general failures to get at least an idea where
2412 // Revision 1.101 2004/11/10 19:32:22 rurban
2413 // * optimize increaseHitCount, esp. for mysql.
2414 // * prepend dirs to the include_path (phpwiki_dir for faster searches)
2415 // * Pear_DB version logic (awful but needed)
2416 // * fix broken ADODB quote
2417 // * _extract_page_data simplification
2419 // Revision 1.100 2004/11/10 15:29:20 rurban
2420 // * requires newer Pear_DB (as the internal one): quote() uses now escapeSimple for strings
2421 // * ACCESS_LOG_SQL: fix cause request not yet initialized
2422 // * WikiDB: moved SQL specific methods upwards
2423 // * new Pear_DB quoting: same as ADODB and as newer Pear_DB.
2424 // fixes all around: WikiGroup, WikiUserNew SQL methods, SQL logging
2426 // Revision 1.99 2004/11/09 17:11:05 rurban
2427 // * revert to the wikidb ref passing. there's no memory abuse there.
2428 // * use new wikidb->_cache->_id_cache[] instead of wikidb->_iwpcache, to effectively
2429 // store page ids with getPageLinks (GleanDescription) of all existing pages, which
2430 // are also needed at the rendering for linkExistingWikiWord().
2431 // pass options to pageiterator.
2432 // use this cache also for _get_pageid()
2433 // This saves about 8 SELECT count per page (num all pagelinks).
2434 // * fix passing of all page fields to the pageiterator.
2435 // * fix overlarge session data which got broken with the latest ACCESS_LOG_SQL changes
2437 // Revision 1.98 2004/11/07 18:34:29 rurban
2438 // more logging fixes
2440 // Revision 1.97 2004/11/07 16:02:51 rurban
2441 // new sql access log (for spam prevention), and restructured access log class
2442 // dbh->quote (generic)
2443 // pear_db: mysql specific parts seperated (using replace)
2445 // Revision 1.96 2004/11/05 22:32:15 rurban
2446 // encode the subject to be 7-bit safe
2448 // Revision 1.95 2004/11/05 20:53:35 rurban
2449 // login cleanup: better debug msg on failing login,
2450 // checked password less immediate login (bogo or anon),
2451 // checked olduser pref session error,
2452 // better PersonalPage without password warning on minimal password length=0
2453 // (which is default now)
2455 // Revision 1.94 2004/11/01 10:43:56 rurban
2456 // seperate PassUser methods into seperate dir (memory usage)
2457 // fix WikiUser (old) overlarge data session
2458 // remove wikidb arg from various page class methods, use global ->_dbi instead
2461 // Revision 1.93 2004/10/14 17:17:57 rurban
2462 // remove dbi WikiDB_Page param: use global request object instead. (memory)
2463 // allow most_popular sortby arguments
2465 // Revision 1.92 2004/10/05 17:00:04 rurban
2466 // support paging for simple lists
2467 // fix RatingDb sql backend.
2468 // remove pages from AllPages (this is ListPages then)
2470 // Revision 1.91 2004/10/04 23:41:19 rurban
2471 // delete notify: fix, @unset syntax error
2473 // Revision 1.90 2004/09/28 12:50:22 rurban
2474 // https://sourceforge.net/forum/forum.php?thread_id=1150924&forum_id=18929
2476 // Revision 1.89 2004/09/26 10:54:42 rurban
2477 // silence deferred check
2479 // Revision 1.88 2004/09/25 18:16:40 rurban
2480 // unset more unneeded _cached_html. (Guess this should fix sf.net now)
2482 // Revision 1.87 2004/09/25 16:25:40 rurban
2483 // notify on rename and remove (to be improved)
2485 // Revision 1.86 2004/09/23 18:52:06 rurban
2486 // only fortune at create
2488 // Revision 1.85 2004/09/16 08:00:51 rurban
2489 // just some comments
2491 // Revision 1.84 2004/09/14 10:34:30 rurban
2492 // fix TransformedText call to use refs
2494 // Revision 1.83 2004/09/08 13:38:00 rurban
2495 // improve loadfile stability by using markup=2 as default for undefined markup-style.
2496 // use more refs for huge objects.
2497 // fix debug=static issue in WikiPluginCached
2499 // Revision 1.82 2004/09/06 12:08:49 rurban
2500 // memory_limit on unix workaround
2501 // VisualWiki: default autosize image
2503 // Revision 1.81 2004/09/06 08:28:00 rurban
2504 // rename genericQuery to genericSqlQuery
2506 // Revision 1.80 2004/07/09 13:05:34 rurban
2509 // Revision 1.79 2004/07/09 10:06:49 rurban
2510 // Use backend specific sortby and sortable_columns method, to be able to
2511 // select between native (Db backend) and custom (PageList) sorting.
2512 // Fixed PageList::AddPageList (missed the first)
2513 // Added the author/creator.. name to AllPagesBy...
2514 // display no pages if none matched.
2515 // Improved dba and file sortby().
2516 // Use &$request reference
2518 // Revision 1.78 2004/07/08 21:32:35 rurban
2519 // Prevent from more warnings, minor db and sort optimizations
2521 // Revision 1.77 2004/07/08 19:04:42 rurban
2522 // more unittest fixes (file backend, metadata RatingsDb)
2524 // Revision 1.76 2004/07/08 17:31:43 rurban
2525 // improve numPages for file (fixing AllPagesTest)
2527 // Revision 1.75 2004/07/05 13:56:22 rurban
2528 // sqlite autoincrement fix
2530 // Revision 1.74 2004/07/03 16:51:05 rurban
2531 // optional DBADMIN_USER:DBADMIN_PASSWD for action=upgrade (if no ALTER permission)
2532 // added atomic mysql REPLACE for PearDB as in ADODB
2533 // fixed _lock_tables typo links => link
2534 // fixes unserialize ADODB bug in line 180
2536 // Revision 1.73 2004/06/29 08:52:22 rurban
2537 // Use ...version() $need_content argument in WikiDB also:
2538 // To reduce the memory footprint for larger sets of pagelists,
2539 // we don't cache the content (only true or false) and
2540 // we purge the pagedata (_cached_html) also.
2541 // _cached_html is only cached for the current pagename.
2542 // => Vastly improved page existance check, ACL check, ...
2544 // Now only PagedList info=content or size needs the whole content, esp. if sortable.
2546 // Revision 1.72 2004/06/25 14:15:08 rurban
2547 // reduce memory footprint by caching only requested pagedate content (improving most page iterators)
2549 // Revision 1.71 2004/06/21 16:22:30 rurban
2550 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
2551 // fixed dumping buttons locally (images/buttons/),
2552 // support pages arg for dumphtml,
2553 // optional directory arg for dumpserial + dumphtml,
2554 // fix a AllPages warning,
2555 // show dump warnings/errors on DEBUG,
2556 // don't warn just ignore on wikilens pagelist columns, if not loaded.
2557 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
2559 // Revision 1.70 2004/06/18 14:39:31 rurban
2560 // actually check USECACHE
2562 // Revision 1.69 2004/06/13 15:33:20 rurban
2563 // new support for arguments owner, author, creator in most relevant
2564 // PageList plugins. in WikiAdmin* via preSelectS()
2566 // Revision 1.68 2004/06/08 21:03:20 rurban
2567 // updated RssParser for XmlParser quirks (store parser object params in globals)
2569 // Revision 1.67 2004/06/07 19:12:49 rurban
2570 // fixed rename version=0, bug #966284
2572 // Revision 1.66 2004/06/07 18:57:27 rurban
2573 // fix rename: Change pagename in all linked pages
2575 // Revision 1.65 2004/06/04 20:32:53 rurban
2576 // Several locale related improvements suggested by Pierrick Meignen
2577 // LDAP fix by John Cole
2578 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
2580 // Revision 1.64 2004/06/04 16:50:00 rurban
2581 // add random quotes to empty pages
2583 // Revision 1.63 2004/06/04 11:58:38 rurban
2584 // added USE_TAGLINES
2586 // Revision 1.62 2004/06/03 22:24:41 rurban
2587 // reenable admin check on !ENABLE_PAGEPERM, honor s=Wildcard arg, fix warning after Remove
2589 // Revision 1.61 2004/06/02 17:13:48 rurban
2590 // fix getRevisionBefore assertion
2592 // Revision 1.60 2004/05/28 10:09:58 rurban
2593 // fix bug #962117, incorrect init of auth_dsn
2595 // Revision 1.59 2004/05/27 17:49:05 rurban
2596 // renamed DB_Session to DbSession (in CVS also)
2597 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
2598 // remove leading slash in error message
2599 // added force_unlock parameter to File_Passwd (no return on stale locks)
2600 // fixed adodb session AffectedRows
2601 // added FileFinder helpers to unify local filenames and DATA_PATH names
2602 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
2604 // Revision 1.58 2004/05/18 13:59:14 rurban
2605 // rename simpleQuery to genericQuery
2607 // Revision 1.57 2004/05/16 22:07:35 rurban
2608 // check more config-default and predefined constants
2609 // various PagePerm fixes:
2610 // fix default PagePerms, esp. edit and view for Bogo and Password users
2611 // implemented Creator and Owner
2612 // BOGOUSERS renamed to BOGOUSER
2613 // fixed syntax errors in signin.tmpl
2615 // Revision 1.56 2004/05/15 22:54:49 rurban
2616 // fixed important WikiDB bug with DEBUG > 0: wrong assertion
2617 // improved SetAcl (works) and PagePerms, some WikiGroup helpers.
2619 // Revision 1.55 2004/05/12 19:27:47 rurban
2620 // revert wrong inline optimization.
2622 // Revision 1.54 2004/05/12 10:49:55 rurban
2623 // require_once fix for those libs which are loaded before FileFinder and
2624 // its automatic include_path fix, and where require_once doesn't grok
2625 // dirname(__FILE__) != './lib'
2626 // upgrade fix with PearDB
2627 // navbar.tmpl: remove spaces for IE button alignment
2629 // Revision 1.53 2004/05/08 14:06:12 rurban
2630 // new support for inlined image attributes: [image.jpg size=50x30 align=right]
2631 // minor stability and portability fixes
2633 // Revision 1.52 2004/05/06 19:26:16 rurban
2634 // improve stability, trying to find the InlineParser endless loop on sf.net
2636 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
2638 // Revision 1.51 2004/05/06 17:30:37 rurban
2639 // CategoryGroup: oops, dos2unix eol
2640 // improved phpwiki_version:
2641 // pre -= .0001 (1.3.10pre: 1030.099)
2642 // -p1 += .001 (1.3.9-p1: 1030.091)
2643 // improved InstallTable for mysql and generic SQL versions and all newer tables so far.
2644 // abstracted more ADODB/PearDB methods for action=upgrade stuff:
2645 // backend->backendType(), backend->database(),
2646 // backend->listOfFields(),
2647 // backend->listOfTables(),
2649 // Revision 1.50 2004/05/04 22:34:25 rurban
2652 // Revision 1.49 2004/05/03 11:16:40 rurban
2653 // fixed sendPageChangeNotification
2654 // subject rewording
2656 // Revision 1.48 2004/04/29 23:03:54 rurban
2657 // fixed sf.net bug #940996
2659 // Revision 1.47 2004/04/29 19:39:44 rurban
2660 // special support for formatted plugins (one-liners)
2661 // like <small><plugin BlaBla ></small>
2662 // iter->asArray() helper for PopularNearby
2663 // db_session for older php's (no &func() allowed)
2665 // Revision 1.46 2004/04/26 20:44:34 rurban
2666 // locking table specific for better databases
2668 // Revision 1.45 2004/04/20 00:06:03 rurban
2669 // themable paging support
2671 // Revision 1.44 2004/04/19 18:27:45 rurban
2672 // Prevent from some PHP5 warnings (ref args, no :: object init)
2673 // php5 runs now through, just one wrong XmlElement object init missing
2674 // Removed unneccesary UpgradeUser lines
2675 // Changed WikiLink to omit version if current (RecentChanges)
2677 // Revision 1.43 2004/04/18 01:34:20 rurban
2678 // protect most_popular from sortby=mtime
2680 // Revision 1.42 2004/04/18 01:11:51 rurban
2681 // more numeric pagename fixes.
2682 // fixed action=upload with merge conflict warnings.
2683 // charset changed from constant to global (dynamic utf-8 switching)
2689 // c-basic-offset: 4
2690 // c-hanging-comment-ender-p: nil
2691 // indent-tabs-mode: nil