2 rcs_id('$Id: PearDB.php,v 1.91 2005-09-11 14:55:05 rurban Exp $');
4 require_once('lib/WikiDB/backend.php');
5 //require_once('lib/FileFinder.php');
6 //require_once('lib/ErrorManager.php');
8 class WikiDB_backend_PearDB
13 function WikiDB_backend_PearDB ($dbparams) {
14 // Find and include PEAR's DB.php. maybe we should force our private version again...
15 // if DB would have exported its version number, it would be easier.
16 @require_once('DB/common.php'); // Either our local pear copy or the system one
18 $name = check_php_version(5) ? "escapeSimple" : strtolower("escapeSimple");
19 // TODO: apparently some Pear::Db version adds LIMIT 1,0 to getOne(),
20 // which is invalid for "select version()"
21 if (!in_array($name, get_class_methods("DB_common"))) {
22 $finder = new FileFinder;
23 $dir = dirname(__FILE__)."/../../pear";
24 $finder->_prepend_to_include_path($dir);
25 include_once("$dir/DB/common.php"); // use our version instead.
26 if (!in_array($name, get_class_methods("DB_common"))) {
27 $pearFinder = new PearFileFinder("lib/pear");
28 $pearFinder->includeOnce('DB.php');
30 include_once("$dir/DB.php");
33 include_once("DB.php");
36 // Install filter to handle bogus error notices from buggy DB.php's.
37 // TODO: check the Pear_DB version, but how?
40 $ErrorManager->pushErrorHandler(new WikiMethodCb($this, '_pear_notice_filter'));
41 $this->_pearerrhandler = true;
44 // Open connection to database
45 $this->_dsn = $dbparams['dsn'];
46 $this->_dbparams = $dbparams;
47 $this->_lock_count = 0;
49 // persistent is usually a DSN option: we override it with a config value.
50 // phptype://username:password@hostspec/database?persistent=false
51 $dboptions = array('persistent' => DATABASE_PERSISTENT,
53 //if (preg_match('/^pgsql/', $this->_dsn)) $dboptions['persistent'] = false;
54 $this->_dbh = DB::connect($this->_dsn, $dboptions);
56 if (DB::isError($dbh)) {
57 trigger_error(sprintf("Can't connect to database: %s",
58 $this->_pear_error_message($dbh)),
61 $dbh->setErrorHandling(PEAR_ERROR_CALLBACK,
62 array($this, '_pear_error_callback'));
63 $dbh->setFetchMode(DB_FETCHMODE_ASSOC);
65 $prefix = isset($dbparams['prefix']) ? $dbparams['prefix'] : '';
67 = array('page_tbl' => $prefix . 'page',
68 'version_tbl' => $prefix . 'version',
69 'link_tbl' => $prefix . 'link',
70 'recent_tbl' => $prefix . 'recent',
71 'nonempty_tbl' => $prefix . 'nonempty');
72 $page_tbl = $this->_table_names['page_tbl'];
73 $version_tbl = $this->_table_names['version_tbl'];
74 $this->page_tbl_fields = "$page_tbl.id AS id, $page_tbl.pagename AS pagename, $page_tbl.hits AS hits";
75 $this->version_tbl_fields = "$version_tbl.version AS version, $version_tbl.mtime AS mtime, ".
76 "$version_tbl.minor_edit AS minor_edit, $version_tbl.content AS content, $version_tbl.versiondata AS versiondata";
79 = array('maxmajor' => "MAX(CASE WHEN minor_edit=0 THEN version END)",
80 'maxminor' => "MAX(CASE WHEN minor_edit<>0 THEN version END)",
81 'maxversion' => "MAX(version)",
83 'iscontent' => "content<>''");
88 * Close database connection.
93 if ($this->_lock_count) {
94 trigger_error( "WARNING: database still locked " . '(lock_count = $this->_lock_count)' . "\n<br />",
97 $this->_dbh->setErrorHandling(PEAR_ERROR_PRINT); // prevent recursive loops.
98 $this->unlock('force');
100 $this->_dbh->disconnect();
102 if (!empty($this->_pearerrhandler)) {
103 $GLOBALS['ErrorManager']->popErrorHandler();
109 * Test fast wikipage.
111 function is_wiki_page($pagename) {
113 extract($this->_table_names);
114 return $dbh->getOne(sprintf("SELECT $page_tbl.id as id"
115 . " FROM $nonempty_tbl, $page_tbl"
116 . " WHERE $nonempty_tbl.id=$page_tbl.id"
117 . " AND pagename='%s'",
118 $dbh->escapeSimple($pagename)));
121 function get_all_pagenames() {
123 extract($this->_table_names);
124 return $dbh->getCol("SELECT pagename"
125 . " FROM $nonempty_tbl, $page_tbl"
126 . " WHERE $nonempty_tbl.id=$page_tbl.id");
129 function numPages($filter=false, $exclude='') {
131 extract($this->_table_names);
132 return $dbh->getOne("SELECT count(*)"
133 . " FROM $nonempty_tbl, $page_tbl"
134 . " WHERE $nonempty_tbl.id=$page_tbl.id");
137 function increaseHitCount($pagename) {
139 // Hits is the only thing we can update in a fast manner.
140 // Note that this will fail silently if the page does not
141 // have a record in the page table. Since it's just the
142 // hit count, who cares?
143 $dbh->query(sprintf("UPDATE %s SET hits=hits+1 WHERE pagename='%s'",
144 $this->_table_names['page_tbl'],
145 $dbh->escapeSimple($pagename)));
150 * Read page information from database.
152 function get_pagedata($pagename) {
154 //trigger_error("GET_PAGEDATA $pagename", E_USER_NOTICE);
155 $result = $dbh->getRow(sprintf("SELECT hits,pagedata FROM %s WHERE pagename='%s'",
156 $this->_table_names['page_tbl'],
157 $dbh->escapeSimple($pagename)),
159 return $result ? $this->_extract_page_data($result) : false;
162 function _extract_page_data($data) {
163 if (empty($data)) return array();
164 elseif (empty($data['pagedata'])) return $data;
166 $data = array_merge($data, $this->_unserialize($data['pagedata']));
167 unset($data['pagedata']);
172 function update_pagedata($pagename, $newdata) {
174 $page_tbl = $this->_table_names['page_tbl'];
176 // Hits is the only thing we can update in a fast manner.
177 if (count($newdata) == 1 && isset($newdata['hits'])) {
178 // Note that this will fail silently if the page does not
179 // have a record in the page table. Since it's just the
180 // hit count, who cares?
181 $dbh->query(sprintf("UPDATE $page_tbl SET hits=%d WHERE pagename='%s'",
182 $newdata['hits'], $dbh->escapeSimple($pagename)));
186 $this->lock(array($page_tbl), true);
187 $data = $this->get_pagedata($pagename);
190 $this->_get_pageid($pagename, true); // Creates page record
193 @$hits = (int)$data['hits'];
194 unset($data['hits']);
196 foreach ($newdata as $key => $val) {
199 else if (empty($val))
205 /* Portability issue -- not all DBMS supports huge strings
206 * so we need to 'bind' instead of building a simple SQL statment.
207 * Note that we do not need to escapeSimple when we bind
208 $dbh->query(sprintf("UPDATE $page_tbl"
209 . " SET hits=%d, pagedata='%s'"
210 . " WHERE pagename='%s'",
212 $dbh->escapeSimple($this->_serialize($data)),
213 $dbh->escapeSimple($pagename)));
215 $sth = $dbh->query("UPDATE $page_tbl"
216 . " SET hits=?, pagedata=?"
217 . " WHERE pagename=?",
218 array($hits, $this->_serialize($data), $pagename));
219 $this->unlock(array($page_tbl));
222 function get_cached_html($pagename) {
224 $page_tbl = $this->_table_names['page_tbl'];
225 return $dbh->GetOne(sprintf("SELECT cached_html FROM $page_tbl WHERE pagename='%s'",
226 $dbh->escapeSimple($pagename)));
229 function set_cached_html($pagename, $data) {
231 $page_tbl = $this->_table_names['page_tbl'];
232 $sth = $dbh->query("UPDATE $page_tbl"
233 . " SET cached_html=?"
234 . " WHERE pagename=?",
235 array($data, $pagename));
238 function _get_pageid($pagename, $create_if_missing = false) {
242 $cache =& $request->_dbi->_cache->_id_cache;
243 if (isset($cache[$pagename])) {
244 if ($cache[$pagename] or !$create_if_missing) {
245 return $cache[$pagename];
250 $page_tbl = $this->_table_names['page_tbl'];
252 $query = sprintf("SELECT id FROM $page_tbl WHERE pagename='%s'",
253 $dbh->escapeSimple($pagename));
255 if (!$create_if_missing)
256 return $dbh->getOne($query);
258 $id = $dbh->getOne($query);
260 $this->lock(array($page_tbl), true); // write lock
261 $max_id = $dbh->getOne("SELECT MAX(id) FROM $page_tbl");
263 $dbh->query(sprintf("INSERT INTO $page_tbl"
264 . " (id,pagename,hits)"
265 . " VALUES (%d,'%s',0)",
266 $id, $dbh->escapeSimple($pagename)));
267 $this->unlock(array($page_tbl));
272 function get_latest_version($pagename) {
274 extract($this->_table_names);
276 (int)$dbh->getOne(sprintf("SELECT latestversion"
277 . " FROM $page_tbl, $recent_tbl"
278 . " WHERE $page_tbl.id=$recent_tbl.id"
279 . " AND pagename='%s'",
280 $dbh->escapeSimple($pagename)));
283 function get_previous_version($pagename, $version) {
285 extract($this->_table_names);
288 (int)$dbh->getOne(sprintf("SELECT version"
289 . " FROM $version_tbl, $page_tbl"
290 . " WHERE $version_tbl.id=$page_tbl.id"
291 . " AND pagename='%s'"
292 . " AND version < %d"
293 . " ORDER BY version DESC",
294 /* Non portable and useless anyway with getOne
297 $dbh->escapeSimple($pagename),
304 * @param $version int Which version to get.
306 * @return hash The version data, or false if specified version does not
309 function get_versiondata($pagename, $version, $want_content = false) {
311 extract($this->_table_names);
312 extract($this->_expressions);
314 assert(is_string($pagename) and $pagename != "");
315 assert($version > 0);
317 //trigger_error("GET_REVISION $pagename $version $want_content", E_USER_NOTICE);
318 // FIXME: optimization: sometimes don't get page data?
320 $fields = $this->page_tbl_fields
321 . ",$page_tbl.pagedata as pagedata,"
322 . $this->version_tbl_fields;
325 $fields = $this->page_tbl_fields . ","
326 . "mtime, minor_edit, versiondata,"
327 . "$iscontent AS have_content";
330 $result = $dbh->getRow(sprintf("SELECT $fields"
331 . " FROM $page_tbl, $version_tbl"
332 . " WHERE $page_tbl.id=$version_tbl.id"
333 . " AND pagename='%s'"
335 $dbh->escapeSimple($pagename), $version),
338 return $this->_extract_version_data($result);
341 function _extract_version_data($query_result) {
345 $data = $this->_unserialize($query_result['versiondata']);
347 $data['mtime'] = $query_result['mtime'];
348 $data['is_minor_edit'] = !empty($query_result['minor_edit']);
350 if (isset($query_result['content']))
351 $data['%content'] = $query_result['content'];
352 elseif ($query_result['have_content'])
353 $data['%content'] = true;
355 $data['%content'] = '';
357 // FIXME: this is ugly.
358 if (isset($query_result['pagedata'])) {
359 // Query also includes page data.
360 // We might as well send that back too...
361 unset($query_result['versiondata']);
362 $data['%pagedata'] = $this->_extract_page_data($query_result);
370 * Create a new revision of a page.
372 function set_versiondata($pagename, $version, $data) {
374 $version_tbl = $this->_table_names['version_tbl'];
376 $minor_edit = (int) !empty($data['is_minor_edit']);
377 unset($data['is_minor_edit']);
379 $mtime = (int)$data['mtime'];
380 unset($data['mtime']);
381 assert(!empty($mtime));
383 @$content = (string) $data['%content'];
384 unset($data['%content']);
386 unset($data['%pagedata']);
389 $id = $this->_get_pageid($pagename, true);
391 // FIXME: optimize: mysql can do this with one REPLACE INTO (I think).
392 $dbh->query(sprintf("DELETE FROM $version_tbl"
393 . " WHERE id=%d AND version=%d",
396 /* mysql optimized version.
397 $dbh->query(sprintf("INSERT INTO $version_tbl"
398 . " (id,version,mtime,minor_edit,content,versiondata)"
399 . " VALUES(%d,%d,%d,%d,'%s','%s')",
400 $id, $version, $mtime, $minor_edit,
401 $dbh->quoteSmart($content),
402 $dbh->quoteSmart($this->_serialize($data))));
404 // generic slow PearDB bind eh quoting.
405 $dbh->query("INSERT INTO $version_tbl"
406 . " (id,version,mtime,minor_edit,content,versiondata)"
407 . " VALUES(?, ?, ?, ?, ?, ?)",
408 array($id, $version, $mtime, $minor_edit, $content,
409 $this->_serialize($data)));
411 $this->_update_recent_table($id);
412 $this->_update_nonempty_table($id);
418 * Delete an old revision of a page.
420 function delete_versiondata($pagename, $version) {
422 extract($this->_table_names);
425 if ( ($id = $this->_get_pageid($pagename)) ) {
426 $dbh->query("DELETE FROM $version_tbl"
427 . " WHERE id=$id AND version=$version");
428 $this->_update_recent_table($id);
429 // This shouldn't be needed (as long as the latestversion
430 // never gets deleted.) But, let's be safe.
431 $this->_update_nonempty_table($id);
437 * Delete page from the database with backup possibility.
438 * i.e save_page('') and DELETE nonempty id
439 * Can be undone and is seen in RecentChanges.
441 /* // see parent backend.php
442 function delete_page($pagename) {
444 $user =& $GLOBALS['request']->_user;
445 $vdata = array('author' => $user->getId(),
446 'author_id' => $user->getAuthenticatedId(),
450 $version = $this->get_latest_version($pagename);
451 $this->set_versiondata($pagename, $version+1, $vdata);
452 $this->set_links($pagename, false);
453 $pagedata = get_pagedata($pagename);
454 $this->update_pagedata($pagename, array('hits' => $pagedata['hits']));
460 * Delete page completely from the database.
461 * I'm not sure if this is what we want. Maybe just delete the revisions
463 function purge_page($pagename) {
465 extract($this->_table_names);
468 if ( ($id = $this->_get_pageid($pagename, false)) ) {
469 $dbh->query("DELETE FROM $version_tbl WHERE id=$id");
470 $dbh->query("DELETE FROM $recent_tbl WHERE id=$id");
471 $dbh->query("DELETE FROM $nonempty_tbl WHERE id=$id");
472 $dbh->query("DELETE FROM $link_tbl WHERE linkfrom=$id");
473 $nlinks = $dbh->getOne("SELECT COUNT(*) FROM $link_tbl WHERE linkto=$id");
475 // We're still in the link table (dangling link) so we can't delete this
477 $dbh->query("UPDATE $page_tbl SET hits=0, pagedata='' WHERE id=$id");
481 $dbh->query("DELETE FROM $page_tbl WHERE id=$id");
484 $this->_update_recent_table();
485 $this->_update_nonempty_table();
487 $result = -1; // already purged or not existing
493 // The only thing we might be interested in updating which we can
494 // do fast in the flags (minor_edit). I think the default
495 // update_versiondata will work fine...
496 //function update_versiondata($pagename, $version, $data) {
499 function set_links($pagename, $links) {
500 // Update link table.
501 // FIXME: optimize: mysql can do this all in one big INSERT.
504 extract($this->_table_names);
507 $pageid = $this->_get_pageid($pagename, true);
509 $dbh->query("DELETE FROM $link_tbl WHERE linkfrom=$pageid");
512 foreach($links as $link) {
513 if (isset($linkseen[$link]))
515 $linkseen[$link] = true;
516 $linkid = $this->_get_pageid($link, true);
517 $dbh->query("INSERT INTO $link_tbl (linkfrom, linkto)"
518 . " VALUES ($pageid, $linkid)");
525 * Find pages which link to or are linked from a page.
527 function get_links($pagename, $reversed=true, $include_empty=false,
528 $sortby=false, $limit=false, $exclude='') {
530 extract($this->_table_names);
533 list($have,$want) = array('linkee', 'linker');
535 list($have,$want) = array('linker', 'linkee');
536 $orderby = $this->sortby($sortby, 'db', array('pagename'));
537 if ($orderby) $orderby = ' ORDER BY $want.' . $orderby;
538 if ($exclude) // array of pagenames
539 $exclude = " AND $want.pagename NOT IN ".$this->_sql_set($exclude);
543 $qpagename = $dbh->escapeSimple($pagename);
544 $sql = "SELECT $want.id as id, $want.pagename as pagename, $want.hits as hits"
545 // Looks like 'AS' in column alias is a MySQL thing, Oracle does not like it
546 // and the PostgresSQL manual does not have it either
547 // Since it is optional in mySQL, just remove it...
548 . " FROM $link_tbl, $page_tbl linker, $page_tbl linkee"
549 . (!$include_empty ? ", $nonempty_tbl" : '')
550 . " WHERE linkfrom=linker.id AND linkto=linkee.id"
551 . " AND $have.pagename='$qpagename'"
552 . (!$include_empty ? " AND $nonempty_tbl.id=$want.id" : "")
553 //. " GROUP BY $want.id"
557 // extract from,count from limit
558 list($from,$count) = $this->limit($limit);
559 $result = $dbh->limitQuery($sql, $from, $count);
561 $result = $dbh->query($sql);
564 return new WikiDB_backend_PearDB_iter($this, $result);
568 * Find if a page links to another page
570 function exists_link($pagename, $link, $reversed=false) {
572 extract($this->_table_names);
575 list($have, $want) = array('linkee', 'linker');
577 list($have, $want) = array('linker', 'linkee');
578 $qpagename = $dbh->escapeSimple($pagename);
579 $qlink = $dbh->escapeSimple($link);
580 $row = $dbh->GetRow("SELECT IF($want.pagename,1,0) as result"
581 . " FROM $link_tbl, $page_tbl linker, $page_tbl linkee, $nonempty_tbl"
582 . " WHERE linkfrom=linker.id AND linkto=linkee.id"
583 . " AND $have.pagename='$qpagename'"
584 . " AND $want.pagename='$qlink'"
586 return $row['result'];
589 function get_all_pages($include_empty=false, $sortby=false, $limit=false, $exclude='') {
591 extract($this->_table_names);
592 $orderby = $this->sortby($sortby, 'db');
593 if ($orderby) $orderby = ' ORDER BY ' . $orderby;
594 if ($exclude) // array of pagenames
595 $exclude = " AND $page_tbl.pagename NOT IN ".$this->_sql_set($exclude);
599 if (strstr($orderby, 'mtime ')) { // multiple columns possible
600 if ($include_empty) {
602 . $this->page_tbl_fields
603 . " FROM $page_tbl, $recent_tbl, $version_tbl"
604 . " WHERE $page_tbl.id=$recent_tbl.id"
605 . " AND $page_tbl.id=$version_tbl.id AND latestversion=version"
611 . $this->page_tbl_fields
612 . " FROM $nonempty_tbl, $page_tbl, $recent_tbl, $version_tbl"
613 . " WHERE $nonempty_tbl.id=$page_tbl.id"
614 . " AND $page_tbl.id=$recent_tbl.id"
615 . " AND $page_tbl.id=$version_tbl.id AND latestversion=version"
620 if ($include_empty) {
622 . $this->page_tbl_fields
624 . ($exclude ? " WHERE $exclude" : '')
629 . $this->page_tbl_fields
630 . " FROM $nonempty_tbl, $page_tbl"
631 . " WHERE $nonempty_tbl.id=$page_tbl.id"
637 // extract from,count from limit
638 list($from,$count) = $this->limit($limit);
639 $result = $dbh->limitQuery($sql, $from, $count);
641 $result = $dbh->query($sql);
643 return new WikiDB_backend_PearDB_iter($this, $result);
649 function text_search($search, $fulltext=false, $sortby=false, $limit=false, $exclude=false) {
651 extract($this->_table_names);
652 $orderby = $this->sortby($sortby, 'db');
653 if ($orderby) $orderby = ' ORDER BY ' . $orderby;
655 $searchclass = get_class($this)."_search";
656 // no need to define it everywhere and then fallback. memory!
657 if (!class_exists($searchclass))
658 $searchclass = "WikiDB_backend_PearDB_search";
659 $searchobj = new $searchclass($search, $dbh);
661 $table = "$nonempty_tbl, $page_tbl";
662 $join_clause = "$nonempty_tbl.id=$page_tbl.id";
663 $fields = $this->page_tbl_fields;
666 $table .= ", $recent_tbl";
667 $join_clause .= " AND $page_tbl.id=$recent_tbl.id";
669 $table .= ", $version_tbl";
670 $join_clause .= " AND $page_tbl.id=$version_tbl.id AND latestversion=version";
672 $fields .= ", $page_tbl.pagedata as pagedata, " . $this->version_tbl_fields;
673 $callback = new WikiMethodCb($searchobj, "_fulltext_match_clause");
675 $callback = new WikiMethodCb($searchobj, "_pagename_match_clause");
677 $search_clause = $search->makeSqlClauseObj($callback);
679 $sql = "SELECT $fields FROM $table"
680 . " WHERE $join_clause"
681 . " AND ($search_clause)"
684 list($from, $count) = $this->limit($limit);
685 $result = $dbh->limitQuery($sql, $from, $count);
687 $result = $dbh->query($sql);
690 return new WikiDB_backend_PearDB_iter($this, $result);
693 //Todo: check if the better Mysql MATCH operator is supported,
694 // (ranked search) and also google like expressions.
695 function _sql_match_clause($word) {
696 $word = preg_replace('/(?=[%_\\\\])/', "\\", $word);
697 $word = $this->_dbh->escapeSimple($word);
698 //$page_tbl = $this->_table_names['page_tbl'];
699 //Note: Mysql 4.1.0 has a bug which fails with binary fields.
700 // e.g. if word is lowercased.
701 // http://bugs.mysql.com/bug.php?id=1491
702 return "LOWER(pagename) LIKE '%$word%'";
704 function _sql_casematch_clause($word) {
705 $word = preg_replace('/(?=[%_\\\\])/', "\\", $word);
706 $word = $this->_dbh->escapeSimple($word);
707 return "pagename LIKE '%$word%'";
709 function _fullsearch_sql_match_clause($word) {
710 $word = preg_replace('/(?=[%_\\\\])/', "\\", $word);
711 $word = $this->_dbh->escapeSimple($word);
712 //$page_tbl = $this->_table_names['page_tbl'];
713 //Mysql 4.1.1 has a bug which fails here if word is lowercased.
714 return "LOWER(pagename) LIKE '%$word%' OR content LIKE '%$word%'";
716 function _fullsearch_sql_casematch_clause($word) {
717 $word = preg_replace('/(?=[%_\\\\])/', "\\", $word);
718 $word = $this->_dbh->escapeSimple($word);
719 return "pagename LIKE '%$word%' OR content LIKE '%$word%'";
723 * Find highest or lowest hit counts.
725 function most_popular($limit=20, $sortby='-hits') {
727 extract($this->_table_names);
733 $order = "hits DESC";
734 $where = " AND hits > 0";
737 if ($sortby != '-hits') {
738 if ($order = $this->sortby($sortby, 'db'))
739 $orderby = " ORDER BY " . $order;
741 $orderby = " ORDER BY $order";
743 //$limitclause = $limit ? " LIMIT $limit" : '';
745 . $this->page_tbl_fields
746 . " FROM $nonempty_tbl, $page_tbl"
747 . " WHERE $nonempty_tbl.id=$page_tbl.id"
751 list($from, $count) = $this->limit($limit);
752 $result = $dbh->limitQuery($sql, $from, $count);
754 $result = $dbh->query($sql);
757 return new WikiDB_backend_PearDB_iter($this, $result);
761 * Find recent changes.
763 function most_recent($params) {
766 $include_minor_revisions = false;
767 $exclude_major_revisions = false;
768 $include_all_revisions = false;
772 extract($this->_table_names);
776 $pick[] = "mtime >= $since";
779 if ($include_all_revisions) {
780 // Include all revisions of each page.
781 $table = "$page_tbl, $version_tbl";
782 $join_clause = "$page_tbl.id=$version_tbl.id";
784 if ($exclude_major_revisions) {
785 // Include only minor revisions
786 $pick[] = "minor_edit <> 0";
788 elseif (!$include_minor_revisions) {
789 // Include only major revisions
790 $pick[] = "minor_edit = 0";
794 $table = "$page_tbl, $recent_tbl";
795 $join_clause = "$page_tbl.id=$recent_tbl.id";
796 $table .= ", $version_tbl";
797 $join_clause .= " AND $version_tbl.id=$page_tbl.id";
799 if ($exclude_major_revisions) {
800 // Include only most recent minor revision
801 $pick[] = 'version=latestminor';
803 elseif (!$include_minor_revisions) {
804 // Include only most recent major revision
805 $pick[] = 'version=latestmajor';
808 // Include only the latest revision (whether major or minor).
809 $pick[] ='version=latestversion';
817 // $limitclause = $limit ? " LIMIT $limit" : '';
818 $where_clause = $join_clause;
820 $where_clause .= " AND " . join(" AND ", $pick);
822 // FIXME: use SQL_BUFFER_RESULT for mysql?
824 . $this->page_tbl_fields . ", " . $this->version_tbl_fields
826 . " WHERE $where_clause"
827 . " ORDER BY mtime $order";
829 list($from, $count) = $this->limit($limit);
830 $result = $dbh->limitQuery($sql, $from, $count);
832 $result = $dbh->query($sql);
834 return new WikiDB_backend_PearDB_iter($this, $result);
838 * Find referenced empty pages.
840 function wanted_pages($exclude_from='', $exclude='', $sortby=false, $limit=false) {
842 extract($this->_table_names);
843 if ($orderby = $this->sortby($sortby, 'db', array('pagename','wantedfrom')))
844 $orderby = 'ORDER BY ' . $orderby;
846 if ($exclude_from) // array of pagenames
847 $exclude_from = " AND linked.pagename NOT IN ".$this->_sql_set($exclude_from);
848 if ($exclude) // array of pagenames
849 $exclude = " AND $page_tbl.pagename NOT IN ".$this->_sql_set($exclude);
851 $sql = "SELECT $page_tbl.pagename,linked.pagename as wantedfrom"
852 . " FROM $link_tbl,$page_tbl as linked "
853 . " LEFT JOIN $page_tbl ON($link_tbl.linkto=$page_tbl.id)"
854 . " LEFT JOIN $nonempty_tbl ON($link_tbl.linkto=$nonempty_tbl.id)"
855 . " WHERE ISNULL($nonempty_tbl.id) AND linked.id=$link_tbl.linkfrom"
860 list($from, $count) = $this->limit($limit);
861 $result = $dbh->limitQuery($sql, $from, $count * 3);
863 $result = $dbh->query($sql);
865 return new WikiDB_backend_PearDB_generic_iter($this, $result);
868 function _sql_set(&$pagenames) {
870 foreach ($pagenames as $p) {
871 $s .= ("'".$this->_dbh->escapeSimple($p)."',");
873 return substr($s,0,-1).")";
877 * Rename page in the database.
879 function rename_page($pagename, $to) {
881 extract($this->_table_names);
884 if (($id = $this->_get_pageid($pagename, false)) ) {
885 if ($new = $this->_get_pageid($to, false)) {
887 // This page does not exist (already verified before), but exists in the page table.
888 // So we delete this page.
889 $dbh->query("DELETE FROM $page_tbl WHERE id=$new");
890 $dbh->query("DELETE FROM $version_tbl WHERE id=$new");
891 $dbh->query("DELETE FROM $recent_tbl WHERE id=$new");
892 $dbh->query("DELETE FROM $nonempty_tbl WHERE id=$new");
893 // We have to fix all referring tables to the old id
894 $dbh->query("UPDATE $link_tbl SET linkfrom=$id WHERE linkfrom=$new");
895 $dbh->query("UPDATE $link_tbl SET linkto=$id WHERE linkto=$new");
897 $dbh->query(sprintf("UPDATE $page_tbl SET pagename='%s' WHERE id=$id",
898 $dbh->escapeSimple($to)));
904 function _update_recent_table($pageid = false) {
906 extract($this->_table_names);
907 extract($this->_expressions);
909 $pageid = (int)$pageid;
912 $dbh->query("DELETE FROM $recent_tbl"
913 . ( $pageid ? " WHERE id=$pageid" : ""));
914 $dbh->query( "INSERT INTO $recent_tbl"
915 . " (id, latestversion, latestmajor, latestminor)"
916 . " SELECT id, $maxversion, $maxmajor, $maxminor"
917 . " FROM $version_tbl"
918 . ( $pageid ? " WHERE id=$pageid" : "")
923 function _update_nonempty_table($pageid = false) {
925 extract($this->_table_names);
927 $pageid = (int)$pageid;
929 extract($this->_expressions);
931 $dbh->query("DELETE FROM $nonempty_tbl"
932 . ( $pageid ? " WHERE id=$pageid" : ""));
933 $dbh->query("INSERT INTO $nonempty_tbl (id)"
934 . " SELECT $recent_tbl.id"
935 . " FROM $recent_tbl, $version_tbl"
936 . " WHERE $recent_tbl.id=$version_tbl.id"
937 . " AND version=latestversion"
938 // We have some specifics here (Oracle)
939 //. " AND content<>''"
940 . " AND content $notempty"
941 . ( $pageid ? " AND $recent_tbl.id=$pageid" : ""));
948 * Grab a write lock on the tables in the SQL database.
950 * Calls can be nested. The tables won't be unlocked until
951 * _unlock_database() is called as many times as _lock_database().
955 function lock($tables = false, $write_lock = true) {
956 if ($this->_lock_count++ == 0)
957 $this->_lock_tables($write_lock);
961 * Actually lock the required tables.
963 function _lock_tables($write_lock) {
964 trigger_error("virtual", E_USER_ERROR);
968 * Release a write lock on the tables in the SQL database.
972 * @param $force boolean Unlock even if not every call to lock() has been matched
973 * by a call to unlock().
975 * @see _lock_database
977 function unlock($tables = false, $force = false) {
978 if ($this->_lock_count == 0)
980 if (--$this->_lock_count <= 0 || $force) {
981 $this->_unlock_tables();
982 $this->_lock_count = 0;
987 * Actually unlock the required tables.
989 function _unlock_tables($write_lock) {
990 trigger_error("virtual", E_USER_ERROR);
997 function _serialize($data) {
1000 assert(is_array($data));
1001 return serialize($data);
1007 function _unserialize($data) {
1008 return empty($data) ? array() : unserialize($data);
1012 * Callback for PEAR (DB) errors.
1016 * @param A PEAR_error object.
1018 function _pear_error_callback($error) {
1019 if ($this->_is_false_error($error))
1022 $this->_dbh->setErrorHandling(PEAR_ERROR_PRINT); // prevent recursive loops.
1024 trigger_error($this->_pear_error_message($error), E_USER_ERROR);
1028 * Detect false errors messages from PEAR DB.
1030 * The version of PEAR DB which ships with PHP 4.0.6 has a bug in that
1031 * it doesn't recognize "LOCK" and "UNLOCK" as SQL commands which don't
1032 * return any data. (So when a "LOCK" command doesn't return any data,
1033 * DB reports it as an error, when in fact, it's not.)
1036 * @return bool True iff error is not really an error.
1038 function _is_false_error($error) {
1039 if ($error->getCode() != DB_ERROR)
1042 $query = $this->_dbh->last_query;
1044 if (! preg_match('/^\s*"?(INSERT|UPDATE|DELETE|REPLACE|CREATE'
1045 . '|DROP|ALTER|GRANT|REVOKE|LOCK|UNLOCK)\s/', $query)) {
1046 // Last query was not of the sort which doesn't return any data.
1047 //" <--kludge for brain-dead syntax coloring
1051 if (! in_array('ismanip', get_class_methods('DB'))) {
1052 // Pear shipped with PHP 4.0.4pl1 (and before, presumably)
1053 // does not have the DB::isManip method.
1057 if (DB::isManip($query)) {
1058 // If Pear thinks it's an isManip then it wouldn't have thrown
1059 // the error we're testing for....
1066 function _pear_error_message($error) {
1067 $class = get_class($this);
1068 $message = "$class: fatal database error\n"
1069 . "\t" . $error->getMessage() . "\n"
1070 . "\t(" . $error->getDebugInfo() . ")\n";
1072 // Prevent password from being exposed during a connection error
1073 $safe_dsn = preg_replace('| ( :// .*? ) : .* (?=@) |xs',
1074 '\\1:XXXXXXXX', $this->_dsn);
1075 return str_replace($this->_dsn, $safe_dsn, $message);
1079 * Filter PHP errors notices from PEAR DB code.
1081 * The PEAR DB code which ships with PHP 4.0.6 produces spurious
1082 * errors and notices. This is an error callback (for use with
1083 * ErrorManager which will filter out those spurious messages.)
1084 * @see _is_false_error, ErrorManager
1087 function _pear_notice_filter($err) {
1088 return ( $err->isNotice()
1089 && preg_match('|DB[/\\\\]common.php$|', $err->errfile)
1090 && $err->errline == 126
1091 && preg_match('/Undefined offset: +0\b/', $err->errstr) );
1094 /* some variables and functions for DB backend abstraction (action=upgrade) */
1095 function database () {
1096 return $this->_dbh->dsn['database'];
1098 function backendType() {
1099 return $this->_dbh->phptype;
1101 function connection() {
1102 return $this->_dbh->connection;
1104 function getRow($query) {
1105 return $this->_dbh->getRow($query);
1108 function listOfTables() {
1109 return $this->_dbh->getListOf('tables');
1111 function listOfFields($database,$table) {
1112 if ($this->backendType() == 'mysql') {
1114 assert(!empty($database));
1115 assert(!empty($table));
1116 $result = mysql_list_fields($database, $table, $this->_dbh->connection) or
1117 trigger_error(__FILE__.':'.__LINE__.' '.mysql_error(), E_USER_WARNING);
1118 if (!$result) return array();
1119 $columns = mysql_num_fields($result);
1120 for ($i = 0; $i < $columns; $i++) {
1121 $fields[] = mysql_field_name($result, $i);
1123 mysql_free_result($result);
1126 // TODO: try ADODB version?
1127 trigger_error("Unsupported dbtype and backend. Either switch to ADODB or check it manually.");
1133 * This class is a generic iterator.
1135 * WikiDB_backend_PearDB_iter only iterates over things that have
1136 * 'pagename', 'pagedata', etc. etc.
1138 * Probably WikiDB_backend_PearDB_iter and this class should be merged
1139 * (most of the code is cut-and-paste :-( ), but I am trying to make
1140 * changes that could be merged easily.
1142 * @author: Dan Frankowski
1144 class WikiDB_backend_PearDB_generic_iter
1145 extends WikiDB_backend_iterator
1147 function WikiDB_backend_PearDB_generic_iter($backend, $query_result, $field_list = NULL) {
1148 if (DB::isError($query_result)) {
1149 // This shouldn't happen, I thought.
1150 $backend->_pear_error_callback($query_result);
1153 $this->_backend = &$backend;
1154 $this->_result = $query_result;
1158 if (!$this->_result)
1160 return $this->_result->numRows();
1164 $backend = &$this->_backend;
1165 if (!$this->_result)
1168 $record = $this->_result->fetchRow(DB_FETCHMODE_ASSOC);
1178 if ($this->_result) {
1179 $this->_result->free();
1180 $this->_result = false;
1185 class WikiDB_backend_PearDB_iter
1186 extends WikiDB_backend_PearDB_generic_iter
1190 $backend = &$this->_backend;
1191 if (!$this->_result)
1194 $record = $this->_result->fetchRow(DB_FETCHMODE_ASSOC);
1200 $pagedata = $backend->_extract_page_data($record);
1201 $rec = array('pagename' => $record['pagename'],
1202 'pagedata' => $pagedata);
1204 if (!empty($record['version'])) {
1205 $rec['versiondata'] = $backend->_extract_version_data($record);
1206 $rec['version'] = $record['version'];
1214 class WikiDB_backend_PearDB_search
1215 extends WikiDB_backend_search
1217 function WikiDB_backend_PearDB_search(&$search, &$dbh) {
1219 $this->_case_exact = $search->_case_exact;
1220 $this->_stoplist =& $search->_stoplist;
1222 function _pagename_match_clause($node) {
1223 $word = $node->sql();
1224 return ($this->_case_exact
1225 ? "pagename LIKE '$word'"
1226 : "LOWER(pagename) LIKE '$word'");
1228 function _fulltext_match_clause($node) {
1229 $word = $node->sql();
1230 // eliminate stoplist words
1231 if (preg_match("/^%".$this->_stoplist."%/i", $word)
1232 or preg_match("/^".$this->_stoplist."$/i", $word))
1233 return $this->_pagename_match_clause($node);
1235 return $this->_pagename_match_clause($node)
1236 // probably convert this MATCH AGAINST or SUBSTR/POSITION without wildcards
1237 . ($this->_case_exact ? " OR content LIKE '$word'"
1238 : " OR LOWER(content) LIKE '$word'");
1242 // $Log: not supported by cvs2svn $
1243 // Revision 1.90 2005/09/11 13:25:12 rurban
1244 // enhance LIMIT support
1246 // Revision 1.89 2005/09/10 21:30:16 rurban
1247 // enhance titleSearch
1249 // Revision 1.88 2005/08/06 13:20:05 rurban
1252 // Revision 1.87 2005/02/10 19:04:24 rurban
1253 // move getRow up one level to our backend class
1255 // Revision 1.86 2005/01/29 19:51:02 rurban
1256 // Bugs item #1077769 fixed by frugal.
1257 // Deleted the wrong page. Fix all other tables also.
1259 // Revision 1.85 2005/01/25 08:03:35 rurban
1260 // support DATABASE_PERSISTENT besides dsn database?persistent=false; move lock_count up (per Charles Corrigan)
1262 // Revision 1.84 2005/01/18 20:55:47 rurban
1263 // reformatting and two bug fixes: adding missing parens
1265 // Revision 1.83 2005/01/18 10:11:29 rurban
1266 // Oops. Again thanks to Charles Corrigan
1268 // Revision 1.82 2005/01/18 08:55:51 rurban
1271 // Revision 1.81 2005/01/17 08:53:09 rurban
1272 // pagedata fix by Charles Corrigan
1274 // Revision 1.80 2004/12/22 18:33:31 rurban
1275 // fix page _id_cache logic for _get_pageid create_if_missing
1277 // Revision 1.79 2004/12/10 02:45:27 rurban
1278 // SQL optimization:
1279 // put _cached_html from pagedata into a new seperate blob, not huge serialized string.
1280 // it is only rarelely needed: for current page only, if-not-modified
1281 // but was extracted for every simple page iteration.
1283 // Revision 1.78 2004/12/08 12:55:51 rurban
1284 // support new non-destructive delete_page via generic backend method
1286 // Revision 1.77 2004/12/06 19:50:04 rurban
1287 // enable action=remove which is undoable and seeable in RecentChanges: ADODB ony for now.
1288 // renamed delete_page to purge_page.
1289 // enable action=edit&version=-1 to force creation of a new version.
1290 // added BABYCART_PATH config
1291 // fixed magiqc in adodb.inc.php
1292 // and some more docs
1294 // Revision 1.76 2004/11/30 17:45:53 rurban
1295 // exists_links backend implementation
1297 // Revision 1.75 2004/11/28 20:42:33 rurban
1298 // Optimize PearDB _extract_version_data and _extract_page_data.
1300 // Revision 1.74 2004/11/27 14:39:05 rurban
1301 // simpified regex search architecture:
1302 // no db specific node methods anymore,
1303 // new sql() method for each node
1304 // parallel to regexp() (which returns pcre)
1305 // regex types bitmasked (op's not yet)
1307 // clarified WikiDB::quote() backend methods:
1308 // ->quote() adds surrounsing quotes
1309 // ->qstr() (new method) assumes strings and adds no quotes! (in contrast to ADODB)
1310 // pear and adodb have now unified quote methods for all generic queries.
1312 // Revision 1.73 2004/11/26 18:39:02 rurban
1313 // new regex search parser and SQL backends (90% complete, glob and pcre backends missing)
1315 // Revision 1.72 2004/11/25 17:20:51 rurban
1316 // and again a couple of more native db args: backlinks
1318 // Revision 1.71 2004/11/23 13:35:48 rurban
1319 // add case_exact search
1321 // Revision 1.70 2004/11/21 11:59:26 rurban
1322 // remove final \n to be ob_cache independent
1324 // Revision 1.69 2004/11/20 17:49:39 rurban
1325 // add fast exclude support to SQL get_all_pages
1327 // Revision 1.68 2004/11/20 17:35:58 rurban
1328 // improved WantedPages SQL backends
1329 // PageList::sortby new 3rd arg valid_fields (override db fields)
1330 // WantedPages sql pager inexact for performance reasons:
1331 // assume 3 wantedfrom per page, to be correct, no getTotal()
1332 // support exclude argument for get_all_pages, new _sql_set()
1334 // Revision 1.67 2004/11/10 19:32:24 rurban
1335 // * optimize increaseHitCount, esp. for mysql.
1336 // * prepend dirs to the include_path (phpwiki_dir for faster searches)
1337 // * Pear_DB version logic (awful but needed)
1338 // * fix broken ADODB quote
1339 // * _extract_page_data simplification
1341 // Revision 1.66 2004/11/10 15:29:21 rurban
1342 // * requires newer Pear_DB (as the internal one): quote() uses now escapeSimple for strings
1343 // * ACCESS_LOG_SQL: fix cause request not yet initialized
1344 // * WikiDB: moved SQL specific methods upwards
1345 // * new Pear_DB quoting: same as ADODB and as newer Pear_DB.
1346 // fixes all around: WikiGroup, WikiUserNew SQL methods, SQL logging
1348 // Revision 1.65 2004/11/09 17:11:17 rurban
1349 // * revert to the wikidb ref passing. there's no memory abuse there.
1350 // * use new wikidb->_cache->_id_cache[] instead of wikidb->_iwpcache, to effectively
1351 // store page ids with getPageLinks (GleanDescription) of all existing pages, which
1352 // are also needed at the rendering for linkExistingWikiWord().
1353 // pass options to pageiterator.
1354 // use this cache also for _get_pageid()
1355 // This saves about 8 SELECT count per page (num all pagelinks).
1356 // * fix passing of all page fields to the pageiterator.
1357 // * fix overlarge session data which got broken with the latest ACCESS_LOG_SQL changes
1359 // Revision 1.64 2004/11/07 16:02:52 rurban
1360 // new sql access log (for spam prevention), and restructured access log class
1361 // dbh->quote (generic)
1362 // pear_db: mysql specific parts seperated (using replace)
1364 // Revision 1.63 2004/11/01 10:43:58 rurban
1365 // seperate PassUser methods into seperate dir (memory usage)
1366 // fix WikiUser (old) overlarge data session
1367 // remove wikidb arg from various page class methods, use global ->_dbi instead
1370 // Revision 1.62 2004/10/14 19:19:34 rurban
1371 // loadsave: check if the dumped file will be accessible from outside.
1372 // and some other minor fixes. (cvsclient native not yet ready)
1374 // Revision 1.61 2004/10/14 17:19:17 rurban
1375 // allow most_popular sortby arguments
1377 // Revision 1.60 2004/07/09 10:06:50 rurban
1378 // Use backend specific sortby and sortable_columns method, to be able to
1379 // select between native (Db backend) and custom (PageList) sorting.
1380 // Fixed PageList::AddPageList (missed the first)
1381 // Added the author/creator.. name to AllPagesBy...
1382 // display no pages if none matched.
1383 // Improved dba and file sortby().
1384 // Use &$request reference
1386 // Revision 1.59 2004/07/08 21:32:36 rurban
1387 // Prevent from more warnings, minor db and sort optimizations
1389 // Revision 1.58 2004/07/08 16:56:16 rurban
1390 // use the backendType abstraction
1392 // Revision 1.57 2004/07/05 12:57:54 rurban
1393 // add mysql timeout
1395 // Revision 1.56 2004/07/04 10:24:43 rurban
1396 // forgot the expressions
1398 // Revision 1.55 2004/07/03 16:51:06 rurban
1399 // optional DBADMIN_USER:DBADMIN_PASSWD for action=upgrade (if no ALTER permission)
1400 // added atomic mysql REPLACE for PearDB as in ADODB
1401 // fixed _lock_tables typo links => link
1402 // fixes unserialize ADODB bug in line 180
1404 // Revision 1.54 2004/06/29 08:52:24 rurban
1405 // Use ...version() $need_content argument in WikiDB also:
1406 // To reduce the memory footprint for larger sets of pagelists,
1407 // we don't cache the content (only true or false) and
1408 // we purge the pagedata (_cached_html) also.
1409 // _cached_html is only cached for the current pagename.
1410 // => Vastly improved page existance check, ACL check, ...
1412 // Now only PagedList info=content or size needs the whole content, esp. if sortable.
1414 // Revision 1.53 2004/06/27 10:26:03 rurban
1415 // oci8 patch by Philippe Vanhaesendonck + some ADODB notes+fixes
1417 // Revision 1.52 2004/06/25 14:15:08 rurban
1418 // reduce memory footprint by caching only requested pagedate content (improving most page iterators)
1420 // Revision 1.51 2004/05/12 10:49:55 rurban
1421 // require_once fix for those libs which are loaded before FileFinder and
1422 // its automatic include_path fix, and where require_once doesn't grok
1423 // dirname(__FILE__) != './lib'
1424 // upgrade fix with PearDB
1425 // navbar.tmpl: remove spaces for IE button alignment
1427 // Revision 1.50 2004/05/06 17:30:39 rurban
1428 // CategoryGroup: oops, dos2unix eol
1429 // improved phpwiki_version:
1430 // pre -= .0001 (1.3.10pre: 1030.099)
1431 // -p1 += .001 (1.3.9-p1: 1030.091)
1432 // improved InstallTable for mysql and generic SQL versions and all newer tables so far.
1433 // abstracted more ADODB/PearDB methods for action=upgrade stuff:
1434 // backend->backendType(), backend->database(),
1435 // backend->listOfFields(),
1436 // backend->listOfTables(),
1438 // Revision 1.49 2004/05/03 21:35:30 rurban
1439 // don't use persistent connections with postgres
1441 // Revision 1.48 2004/04/26 20:44:35 rurban
1442 // locking table specific for better databases
1444 // Revision 1.47 2004/04/20 00:06:04 rurban
1445 // themable paging support
1447 // Revision 1.46 2004/04/19 21:51:41 rurban
1448 // php5 compatibility: it works!
1450 // Revision 1.45 2004/04/16 14:19:39 rurban
1451 // updated ADODB notes
1454 // (c-file-style: "gnu")
1458 // c-basic-offset: 4
1459 // c-hanging-comment-ender-p: nil
1460 // indent-tabs-mode: nil