2 rcs_id('$Id: PearDB.php,v 1.11 2001-12-03 03:18:34 joe_edelman Exp $');
4 //require_once('DB.php');
5 require_once('lib/WikiDB/backend.php');
6 require_once('lib/FileFinder.php');
7 require_once('lib/ErrorManager.php');
9 class WikiDB_backend_PearDB
10 extends WikiDB_backend
12 function WikiDB_backend_PearDB ($dbparams) {
13 // Find and include PEAR's DB.php.
14 $pearFinder = new PearFileFinder;
15 $pearFinder->includeOnce('DB.php');
17 // Install filter to handle bogus error notices from buggy DB.php's.
19 $ErrorManager->pushErrorHandler(new WikiMethodCb($this, '_pear_notice_filter'));
21 // Open connection to database
22 $dsn = $dbparams['dsn'];
23 $this->_dbh = DB::connect($dsn, true); //FIXME: true -> persistent connection
25 if (DB::isError($dbh)) {
26 trigger_error("Can't connect to database: "
27 . $this->_pear_error_message($dbh),
30 $dbh->setErrorHandling(PEAR_ERROR_CALLBACK,
31 array($this, '_pear_error_callback'));
32 $dbh->setFetchMode(DB_FETCHMODE_ASSOC);
34 $prefix = isset($dbparams['prefix']) ? $dbparams['prefix'] : '';
37 = array('page_tbl' => $prefix . 'page',
38 'version_tbl' => $prefix . 'version',
39 'link_tbl' => $prefix . 'link',
40 'recent_tbl' => $prefix . 'recent',
41 'nonempty_tbl' => $prefix . 'nonempty');
44 = array('maxmajor' => "MAX(CASE WHEN minor_edit=0 THEN version END)",
45 'maxminor' => "MAX(CASE WHEN minor_edit<>0 THEN version END)",
46 'maxversion' => "MAX(version)");
48 $this->_lock_count = 0;
52 * Close database connection.
57 if ($this->_lock_count) {
58 trigger_error("WARNING: database still locked"
59 . " (lock_count = $this->_lock_count)\n<br>",
62 $this->_dbh->setErrorHandling(PEAR_ERROR_PRINT); // prevent recursive loops.
63 $this->unlock('force');
65 $this->_dbh->disconnect();
73 function is_wiki_page($pagename) {
75 extract($this->_table_names);
76 return $dbh->getOne(sprintf("SELECT $page_tbl.id"
77 . " FROM $nonempty_tbl, $page_tbl"
78 . " WHERE $nonempty_tbl.id=$page_tbl.id"
79 . " AND pagename='%s'",
80 $dbh->quoteString($pagename)));
83 function get_all_pagenames() {
85 extract($this->_table_names);
86 return $dbh->getCol("SELECT pagename"
87 . " FROM $nonempty_tbl, $page_tbl"
88 . " WHERE $nonempty_tbl.id=$page_tbl.id");
92 * Read page information from database.
94 function get_pagedata($pagename) {
96 $page_tbl = $this->_table_names['page_tbl'];
98 //trigger_error("GET_PAGEDATA $pagename", E_USER_NOTICE);
100 $result = $dbh->getRow(sprintf("SELECT * FROM $page_tbl WHERE pagename='%s'",
101 $dbh->quoteString($pagename)),
105 return $this->_extract_page_data($result);
108 function _extract_page_data(&$query_result) {
109 extract($query_result);
110 $data = empty($pagedata) ? array() : unserialize($pagedata);
111 $data['hits'] = $hits;
115 function update_pagedata($pagename, $newdata) {
117 $page_tbl = $this->_table_names['page_tbl'];
119 // Hits is the only thing we can update in a fast manner.
120 if (count($newdata) == 1 && isset($newdata['hits'])) {
121 // Note that this will fail silently if the page does not
122 // have a record in the page table. Since it's just the
123 // hit count, who cares?
124 $dbh->query(sprintf("UPDATE $page_tbl SET hits=%d WHERE pagename='%s'",
125 $newdata['hits'], $dbh->quoteString($pagename)));
130 $data = $this->get_pagedata($pagename);
133 $this->_get_pageid($pagename, true); // Creates page record
136 @$hits = (int)$data['hits'];
137 unset($data['hits']);
139 foreach ($newdata as $key => $val) {
142 else if (empty($val))
148 $dbh->query(sprintf("UPDATE $page_tbl"
149 . " SET hits=%d, pagedata='%s'"
150 . " WHERE pagename='%s'",
152 $dbh->quoteString(serialize($data)),
153 $dbh->quoteString($pagename)));
158 function _get_pageid($pagename, $create_if_missing = false) {
161 $page_tbl = $this->_table_names['page_tbl'];
163 $query = sprintf("SELECT id FROM $page_tbl WHERE pagename='%s'",
164 $dbh->quoteString($pagename));
166 if (!$create_if_missing)
167 return $dbh->getOne($query);
170 $id = $dbh->getOne($query);
172 $max_id = $dbh->getOne("SELECT MAX(id) FROM $page_tbl");
174 $dbh->query(sprintf("INSERT INTO $page_tbl"
175 . " (id,pagename,hits)"
176 . " VALUES (%d,'%s',0)",
177 $id, $dbh->quoteString($pagename)));
183 function get_latest_version($pagename) {
185 extract($this->_table_names);
187 (int)$dbh->getOne(sprintf("SELECT latestversion"
188 . " FROM $page_tbl, $recent_tbl"
189 . " WHERE $page_tbl.id=$recent_tbl.id"
190 . " AND pagename='%s'",
191 $dbh->quoteString($pagename)));
194 function get_previous_version($pagename, $version) {
196 extract($this->_table_names);
199 (int)$dbh->getOne(sprintf("SELECT version"
200 . " FROM $version_tbl, $page_tbl"
201 . " WHERE $version_tbl.id=$page_tbl.id"
202 . " AND pagename='%s'"
203 . " AND version < %d"
204 . " ORDER BY version DESC"
206 $dbh->quoteString($pagename),
213 * @param $version int Which version to get.
215 * @return hash The version data, or false if specified version does not
218 function get_versiondata($pagename, $version, $want_content = false) {
220 extract($this->_table_names);
222 assert(!empty($pagename));
223 assert($version > 0);
225 //trigger_error("GET_REVISION $pagename $version $want_content", E_USER_NOTICE);
226 // FIXME: optimization: sometimes don't get page data?
232 $fields = ("$page_tbl.*,"
233 . "mtime,minor_edit,versiondata,"
234 . "content<>'' AS have_content");
237 $result = $dbh->getRow(sprintf("SELECT $fields"
238 . " FROM $page_tbl, $version_tbl"
239 . " WHERE $page_tbl.id=$version_tbl.id"
240 . " AND pagename='%s'"
242 $dbh->quoteString($pagename), $version),
245 return $this->_extract_version_data($result);
248 function _extract_version_data(&$query_result) {
252 extract($query_result);
253 $data = empty($versiondata) ? array() : unserialize($versiondata);
255 $data['mtime'] = $mtime;
256 $data['is_minor_edit'] = !empty($minor_edit);
259 $data['%content'] = $content;
260 elseif ($have_content)
261 $data['%content'] = true;
263 $data['%content'] = '';
265 // FIXME: this is ugly.
266 if (isset($pagename)) {
267 // Query also includes page data.
268 // We might as well send that back too...
269 $data['%pagedata'] = $this->_extract_page_data($query_result);
277 * Create a new revision of a page.
279 function set_versiondata($pagename, $version, $data) {
281 $version_tbl = $this->_table_names['version_tbl'];
283 $minor_edit = (int) !empty($data['is_minor_edit']);
284 unset($data['is_minor_edit']);
286 $mtime = (int)$data['mtime'];
287 unset($data['mtime']);
288 assert(!empty($mtime));
290 @$content = (string) $data['%content'];
291 unset($data['%content']);
293 unset($data['%pagedata']);
296 $id = $this->_get_pageid($pagename, true);
298 // FIXME: optimize: mysql can do this with one REPLACE INTO (I think).
299 $dbh->query(sprintf("DELETE FROM $version_tbl"
300 . " WHERE id=%d AND version=%d",
303 $dbh->query(sprintf("INSERT INTO $version_tbl"
304 . " (id,version,mtime,minor_edit,content,versiondata)"
305 . " VALUES(%d,%d,%d,%d,'%s','%s')",
306 $id, $version, $mtime, $minor_edit,
307 $dbh->quoteString($content),
308 $dbh->quoteString(serialize($data))));
310 $this->_update_recent_table($id);
311 $this->_update_nonempty_table($id);
317 * Delete an old revision of a page.
319 function delete_versiondata($pagename, $version) {
321 extract($this->_table_names);
324 if ( ($id = $this->_get_pageid($pagename)) ) {
325 $dbh->query("DELETE FROM $version_tbl"
326 . " WHERE id=$id AND version=$version");
327 $this->_update_recent_table($id);
328 // This shouldn't be needed (as long as the latestversion
329 // never gets deleted.) But, let's be safe.
330 $this->_update_nonempty_table($id);
336 * Delete page from the database.
338 function delete_page($pagename) {
340 extract($this->_table_names);
343 if ( ($id = $this->_get_pageid($pagename, 'id')) ) {
344 $dbh->query("DELETE FROM $version_tbl WHERE id=$id");
345 $dbh->query("DELETE FROM $recent_tbl WHERE id=$id");
346 $dbh->query("DELETE FROM $nonempty_tbl WHERE id=$id");
347 $dbh->query("DELETE FROM $link_tbl WHERE linkfrom=$id");
348 $nlinks = $dbh->getOne("SELECT COUNT(*) FROM $link_tbl WHERE linkto=$id");
350 // We're still in the link table (dangling link) so we can't delete this
352 $dbh->query("UPDATE $page_tbl SET hits=0, pagedata='' WHERE id=$id");
355 $dbh->query("DELETE FROM $page_tbl WHERE id=$id");
357 $this->_update_recent_table();
358 $this->_update_nonempty_table();
364 // The only thing we might be interested in updating which we can
365 // do fast in the flags (minor_edit). I think the default
366 // update_versiondata will work fine...
367 //function update_versiondata($pagename, $version, $data) {
370 function set_links($pagename, $links) {
371 // Update link table.
372 // FIXME: optimize: mysql can do this all in one big INSERT.
375 extract($this->_table_names);
378 $pageid = $this->_get_pageid($pagename, true);
380 $dbh->query("DELETE FROM $link_tbl WHERE linkfrom=$pageid");
383 foreach($links as $link) {
384 if (isset($linkseen[$link]))
386 $linkseen[$link] = true;
387 $linkid = $this->_get_pageid($link, true);
388 $dbh->query("INSERT INTO $link_tbl (linkfrom, linkto)"
389 . " VALUES ($pageid, $linkid)");
396 * Find pages which link to or are linked from a page.
398 function get_links($pagename, $reversed = true) {
400 extract($this->_table_names);
403 list($have,$want) = array('linkee', 'linker');
405 list($have,$want) = array('linker', 'linkee');
407 $qpagename = $dbh->quoteString($pagename);
409 $result = $dbh->query("SELECT $want.*"
410 . " FROM $link_tbl, $page_tbl AS linker, $page_tbl AS linkee"
411 . " WHERE linkfrom=linker.id AND linkto=linkee.id"
412 . " AND $have.pagename='$qpagename'"
413 //. " GROUP BY $want.id"
414 . " ORDER BY $want.pagename",
417 return new WikiDB_backend_PearDB_iter($this, $result);
420 function get_all_pages($include_deleted) {
422 extract($this->_table_names);
424 if ($include_deleted) {
425 $result = $dbh->query("SELECT * FROM $page_tbl ORDER BY pagename");
428 $result = $dbh->query("SELECT $page_tbl.*"
429 . " FROM $nonempty_tbl, $page_tbl"
430 . " WHERE $nonempty_tbl.id=$page_tbl.id"
431 . " ORDER BY pagename");
434 return new WikiDB_backend_PearDB_iter($this, $result);
440 function text_search($search = '', $fullsearch = false) {
442 extract($this->_table_names);
444 $table = "$nonempty_tbl, $page_tbl";
445 $join_clause = "$nonempty_tbl.id=$page_tbl.id";
446 $fields = "$page_tbl.*";
447 $callback = new WikiMethodCb($this, '_sql_match_clause');
450 $table .= ", $recent_tbl";
451 $join_clause .= " AND $page_tbl.id=$recent_tbl.id";
453 $table .= ", $version_tbl";
454 $join_clause .= " AND $page_tbl.id=$version_tbl.id AND latestversion=version";
456 $fields .= ",$version_tbl.*";
457 $callback = new WikiMethodCb($this, '_fullsearch_sql_match_clause');
460 $search_clause = $search->makeSqlClause($callback);
462 $result = $dbh->query("SELECT $fields FROM $table"
463 . " WHERE $join_clause"
464 . " AND ($search_clause)"
465 . " ORDER BY pagename");
467 return new WikiDB_backend_PearDB_iter($this, $result);
470 function _sql_match_clause($word) {
471 $word = preg_replace('/(?=[%_\\\\])/', "\\", $word);
472 $word = $this->_dbh->quoteString($word);
473 return "LOWER(pagename) LIKE '%$word%'";
476 function _fullsearch_sql_match_clause($word) {
477 $word = preg_replace('/(?=[%_\\\\])/', "\\", $word);
478 $word = $this->_dbh->quoteString($word);
479 return "LOWER(pagename) LIKE '%$word%' OR content LIKE '%$word%'";
483 * Find highest hit counts.
485 function most_popular($limit) {
487 extract($this->_table_names);
489 $limitclause = $limit ? " LIMIT $limit" : '';
490 $result = $dbh->query("SELECT $page_tbl.*"
491 . " FROM $nonempty_tbl, $page_tbl"
492 . " WHERE $nonempty_tbl.id=$page_tbl.id"
493 . " ORDER BY hits DESC"
496 return new WikiDB_backend_PearDB_iter($this, $result);
500 * Find recent changes.
502 function most_recent($params) {
505 $include_minor_revisions = false;
506 $exclude_major_revisions = false;
507 $include_all_revisions = false;
511 extract($this->_table_names);
515 $pick[] = "mtime >= $since";
517 if ($include_all_revisions) {
518 // Include all revisions of each page.
519 $table = "$page_tbl, $version_tbl";
520 $join_clause = "$page_tbl.id=$version_tbl.id";
522 if ($exclude_major_revisions) {
523 // Include only minor revisions
524 $pick[] = "minor_edit <> 0";
526 elseif (!$include_minor_revisions) {
527 // Include only major revisions
528 $pick[] = "minor_edit = 0";
532 $table = "$page_tbl, $recent_tbl";
533 $join_clause = "$page_tbl.id=$recent_tbl.id";
534 $table .= ", $version_tbl";
535 $join_clause .= " AND $version_tbl.id=$page_tbl.id";
537 if ($exclude_major_revisions) {
538 // Include only most recent minor revision
539 $pick[] = 'version=latestminor';
541 elseif (!$include_minor_revisions) {
542 // Include only most recent major revision
543 $pick[] = 'version=latestmajor';
546 // Include only the latest revision (whether major or minor).
547 $pick[] ='version=latestversion';
551 $limitclause = $limit ? " LIMIT $limit" : '';
552 $where_clause = $join_clause;
554 $where_clause .= " AND " . join(" AND ", $pick);
556 // FIXME: use SQL_BUFFER_RESULT for mysql?
557 $result = $dbh->query("SELECT $page_tbl.*,$version_tbl.*"
559 . " WHERE $where_clause"
560 . " ORDER BY mtime DESC"
563 return new WikiDB_backend_PearDB_iter($this, $result);
566 function _update_recent_table($pageid = false) {
568 extract($this->_table_names);
569 extract($this->_expressions);
571 $pageid = (int)$pageid;
575 $dbh->query("DELETE FROM $recent_tbl"
576 . ( $pageid ? " WHERE id=$pageid" : ""));
578 $dbh->query( "INSERT INTO $recent_tbl"
579 . " (id, latestversion, latestmajor, latestminor)"
580 . " SELECT id, $maxversion, $maxmajor, $maxminor"
581 . " FROM $version_tbl"
582 . ( $pageid ? " WHERE id=$pageid" : "")
587 function _update_nonempty_table($pageid = false) {
589 extract($this->_table_names);
591 $pageid = (int)$pageid;
595 $dbh->query("DELETE FROM $nonempty_tbl"
596 . ( $pageid ? " WHERE id=$pageid" : ""));
598 $dbh->query("INSERT INTO $nonempty_tbl (id)"
599 . " SELECT $recent_tbl.id"
600 . " FROM $recent_tbl, $version_tbl"
601 . " WHERE $recent_tbl.id=$version_tbl.id"
602 . " AND version=latestversion"
604 . ( $pageid ? " AND $recent_tbl.id=$pageid" : ""));
611 * Grab a write lock on the tables in the SQL database.
613 * Calls can be nested. The tables won't be unlocked until
614 * _unlock_database() is called as many times as _lock_database().
618 function lock($write_lock = true) {
619 if ($this->_lock_count++ == 0)
620 $this->_lock_tables($write_lock);
624 * Actually lock the required tables.
626 function _lock_tables($write_lock) {
627 trigger_error("virtual", E_USER_ERROR);
631 * Release a write lock on the tables in the SQL database.
635 * @param $force boolean Unlock even if not every call to lock() has been matched
636 * by a call to unlock().
638 * @see _lock_database
640 function unlock($force = false) {
641 if ($this->_lock_count == 0)
643 if (--$this->_lock_count <= 0 || $force) {
644 $this->_unlock_tables();
645 $this->_lock_count = 0;
650 * Actually unlock the required tables.
652 function _unlock_tables($write_lock) {
653 trigger_error("virtual", E_USER_ERROR);
657 * Callback for PEAR (DB) errors.
661 * @param A PEAR_error object.
663 function _pear_error_callback($error) {
664 if ($this->_is_false_error($error))
667 $this->_dbh->setErrorHandling(PEAR_ERROR_PRINT); // prevent recursive loops.
669 trigger_error($this->_pear_error_message($error), E_USER_ERROR);
673 * Detect false errors messages from PEAR DB.
675 * The version of PEAR DB which ships with PHP 4.0.6 has a bug in that
676 * it doesn't recognize "LOCK" and "UNLOCK" as SQL commands which don't
677 * return any data. (So when a "LOCK" command doesn't return any data,
678 * DB reports it as an error, when in fact, it's not.)
681 * @return bool True iff error is not really an error.
683 function _is_false_error($error) {
684 $code = $error->getCode();
685 $query = $this->_dbh->last_query;
686 return ($code == DB_ERROR
687 && ! DB::isManip($query)
688 && preg_match('/^\s*"?(LOCK|UNLOCK)\s/', $query));
691 function _pear_error_message($error) {
692 $class = get_class($this);
693 $message = "$class: fatal database error\n"
694 . "\t" . $error->getMessage() . "\n"
695 . "\t(" . $error->getDebugInfo() . ")\n";
701 * Filter PHP errors notices from PEAR DB code.
703 * The PEAR DB code which ships with PHP 4.0.6 produces spurious
704 * errors and notices. This is an error callback (for use with
705 * ErrorManager which will filter out those spurious messages.)
706 * @see _is_false_error, ErrorManager
709 function _pear_notice_filter($err) {
710 return ( $err->isNotice()
711 && preg_match('|DB[/\\\\]common.php$|', $err->errfile)
712 && $err->errline == 126
713 && preg_match('/Undefined offset: +0\b/', $err->errstr) );
717 class WikiDB_backend_PearDB_iter
718 extends WikiDB_backend_iterator
720 function WikiDB_backend_PearDB_iter(&$backend, &$query_result) {
721 if (DB::isError($query_result)) {
722 // This shouldn't happen, I thought.
723 $backend->_pear_error_callback($query_result);
726 $this->_backend = &$backend;
727 $this->_result = $query_result;
731 $backend = &$this->_backend;
735 $record = $this->_result->fetchRow(DB_FETCHMODE_ASSOC);
741 $pagedata = $backend->_extract_page_data($record);
742 $rec = array('pagename' => $record['pagename'],
743 'pagedata' => $pagedata);
745 if (!empty($record['version'])) {
746 $rec['versiondata'] = $backend->_extract_version_data($record);
747 $rec['version'] = $record['version'];
754 if ($this->_result) {
755 $this->_result->free();
756 $this->_result = false;
761 // (c-file-style: "gnu")
766 // c-hanging-comment-ender-p: nil
767 // indent-tabs-mode: nil