2 rcs_id('$Id: PearDB.php,v 1.4 2001-09-20 18:25:15 dairiki 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(array($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');
43 $this->_lock_count = 0;
47 * Close database connection.
52 if ($this->_lock_count) {
53 trigger_error("WARNING: database still locked"
54 . " (lock_count = $this->_lock_count)\n<br>",
57 $this->_dbh->setErrorHandling(PEAR_ERROR_PRINT); // prevent recursive loops.
58 $this->unlock('force');
60 $this->_dbh->disconnect();
68 function is_wiki_page($pagename) {
70 extract($this->_table_names);
71 return $dbh->getOne(sprintf("SELECT $page_tbl.id"
72 . " FROM $nonempty_tbl INNER JOIN $page_tbl USING(id)"
73 . " WHERE pagename='%s'",
74 $dbh->quoteString($pagename)));
77 function get_all_pagenames() {
79 extract($this->_table_names);
80 return $dbh->getCol("SELECT pagename"
81 . " FROM $nonempty_tbl INNER JOIN $page_tbl USING(id)");
85 * Read page information from database.
87 function get_pagedata($pagename) {
89 $page_tbl = $this->_table_names['page_tbl'];
91 //trigger_error("GET_PAGEDATA $pagename", E_USER_NOTICE);
93 $result = $dbh->getRow(sprintf("SELECT * FROM $page_tbl WHERE pagename='%s'",
94 $dbh->quoteString($pagename)),
98 return $this->_extract_page_data($result);
101 function _extract_page_data(&$query_result) {
102 extract($query_result);
103 $data = empty($pagedata) ? array() : unserialize($pagedata);
104 $data['hits'] = $hits;
108 function update_pagedata($pagename, $newdata) {
110 $page_tbl = $this->_table_names['page_tbl'];
112 // Hits is the only thing we can update in a fast manner.
113 if (count($newdata) == 1 && isset($newdata['hits'])) {
114 // Note that this will fail silently if the page does not
115 // have a record in the page table. Since it's just the
116 // hit count, who cares?
117 $dbh->query(sprintf("UPDATE $page_tbl SET hits=%d WHERE pagename='%s'",
118 $newdata['hits'], $dbh->quoteString($pagename)));
123 $data = $this->get_pagedata($pagename);
126 $this->_get_pageid($pagename, true); // Creates page record
129 @$hits = (int)$data['hits'];
130 unset($data['hits']);
132 foreach ($newdata as $key => $val) {
135 else if (empty($val))
141 $dbh->query(sprintf("UPDATE $page_tbl"
142 . " SET hits=%d, pagedata='%s'"
143 . " WHERE pagename='%s'",
145 $dbh->quoteString(serialize($data)),
146 $dbh->quoteString($pagename)));
151 function _get_pageid($pagename, $create_if_missing = false) {
154 $page_tbl = $this->_table_names['page_tbl'];
156 $query = sprintf("SELECT id FROM $page_tbl WHERE pagename='%s'",
157 $dbh->quoteString($pagename));
159 if (!$create_if_missing)
160 return $dbh->getOne($query);
163 $id = $dbh->getOne($query);
165 $max_id = $dbh->getOne("SELECT MAX(id) FROM $page_tbl");
167 $dbh->query(sprintf("INSERT INTO $page_tbl"
168 . " (id,pagename,hits)"
169 . " VALUES (%d,'%s',0)",
170 $id, $dbh->quoteString($pagename)));
176 function get_latest_version($pagename) {
178 extract($this->_table_names);
180 (int)$dbh->getOne(sprintf("SELECT latestversion"
182 . " INNER JOIN $recent_tbl USING(id)"
183 . " WHERE pagename='%s'",
184 $dbh->quoteString($pagename)));
187 function get_previous_version($pagename, $version) {
189 extract($this->_table_names);
192 (int)$dbh->getOne(sprintf("SELECT version"
193 . " FROM $version_tbl"
194 . " INNER JOIN $page_tbl USING(id)"
195 . " WHERE pagename='%s'"
196 . " AND version < %d"
197 . " ORDER BY version DESC"
199 $dbh->quoteString($pagename),
206 * @param $version int Which version to get.
208 * @return hash The version data, or false if specified version does not
211 function get_versiondata($pagename, $version, $want_content = false) {
213 extract($this->_table_names);
215 assert(!empty($pagename));
216 assert($version > 0);
218 //trigger_error("GET_REVISION $pagename $version $want_content", E_USER_NOTICE);
219 // FIXME: optimization: sometimes don't get page data?
225 $fields = ("$page_tbl.*,"
226 . "mtime,minor_edit,versiondata,"
227 . "content<>'' AS have_content");
230 $result = $dbh->getRow(sprintf("SELECT $fields"
232 . " INNER JOIN $version_tbl USING(id)"
233 . " WHERE pagename='%s' AND version=%d",
234 $dbh->quoteString($pagename), $version),
237 return $this->_extract_version_data($result);
240 function _extract_version_data(&$query_result) {
244 extract($query_result);
245 $data = empty($versiondata) ? array() : unserialize($versiondata);
247 $data['mtime'] = $mtime;
248 $data['is_minor_edit'] = !empty($minor_edit);
251 $data['%content'] = $content;
252 elseif ($have_content)
253 $data['%content'] = true;
255 $data['%content'] = '';
257 // FIXME: this is ugly.
258 if (isset($pagename)) {
259 // Query also includes page data.
260 // We might as well send that back too...
261 $data['%pagedata'] = $this->_extract_page_data($query_result);
269 * Create a new revision of a page.
271 function set_versiondata($pagename, $version, $data) {
273 $version_tbl = $this->_table_names['version_tbl'];
275 $minor_edit = (int) !empty($data['is_minor_edit']);
276 unset($data['is_minor_edit']);
278 $mtime = (int)$data['mtime'];
279 unset($data['mtime']);
280 assert(!empty($mtime));
282 @$content = (string) $data['%content'];
283 unset($data['%content']);
285 unset($data['%pagedata']);
288 $id = $this->_get_pageid($pagename, true);
290 // FIXME: optimize: mysql can do this with one REPLACE INTO (I think).
291 $dbh->query(sprintf("DELETE FROM $version_tbl"
292 . " WHERE id=%d AND version=%d",
295 $dbh->query(sprintf("INSERT INTO $version_tbl"
296 . " (id,version,mtime,minor_edit,content,versiondata)"
297 . " VALUES(%d,%d,%d,%d,'%s','%s')",
298 $id, $version, $mtime, $minor_edit,
299 $dbh->quoteString($content),
300 $dbh->quoteString(serialize($data))));
302 $this->_update_recent_table($id);
303 $this->_update_nonempty_table($id);
309 * Delete an old revision of a page.
311 function delete_versiondata($pagename, $version) {
313 extract($this->_table_names);
316 if ( ($id = $this->_get_pageid($pagename)) ) {
317 $dbh->query("DELETE FROM $version_tbl"
318 . " WHERE id=$id AND version=$version");
319 $this->_update_recent_table($id);
320 // This shouldn't be needed (as long as the latestversion
321 // never gets deleted.) But, let's be safe.
322 $this->_update_nonempty_table($id);
328 * Delete page from the database.
330 function delete_page($pagename) {
332 extract($this->_table_names);
335 if ( ($id = $this->_get_pageid($pagename, 'id')) ) {
336 $dbh->query("DELETE FROM $version_tbl WHERE id=$id");
337 $dbh->query("DELETE FROM $recent_tbl WHERE id=$id");
338 $dbh->query("DELETE FROM $nonempty_tbl WHERE id=$id");
339 $dbh->query("DELETE FROM $link_tbl WHERE linkfrom=$id");
340 $nlinks = $dbh->getOne("SELECT COUNT(*) FROM $link_tbl WHERE linkto=$id");
342 // We're still in the link table (dangling link) so we can't delete this
344 $dbh->query("UPDATE $page_tbl SET hits=0, pagedata='' WHERE id=$id");
347 $dbh->query("DELETE FROM $page_tbl WHERE id=$id");
349 $this->_update_recent_table();
350 $this->_update_nonempty_table();
356 // The only thing we might be interested in updating which we can
357 // do fast in the flags (minor_edit). I think the default
358 // update_versiondata will work fine...
359 //function update_versiondata($pagename, $version, $data) {
362 function set_links($pagename, $links) {
363 // Update link table.
364 // FIXME: optimize: mysql can do this all in one big INSERT.
367 extract($this->_table_names);
370 $pageid = $this->_get_pageid($pagename, true);
372 $dbh->query("DELETE FROM $link_tbl WHERE linkfrom=$pageid");
374 foreach($links as $link) {
375 if (isset($linkseen[$link]))
377 $linkseen[$link] = true;
378 $linkid = $this->_get_pageid($link, true);
379 $dbh->query("INSERT INTO $link_tbl (linkfrom, linkto)"
380 . " VALUES ($pageid, $linkid)");
386 * Find pages which link to or are linked from a page.
388 function get_links($pagename, $reversed = true) {
390 extract($this->_table_names);
393 list($have,$want) = array('linkee', 'linker');
395 list($have,$want) = array('linker', 'linkee');
397 $qpagename = $dbh->quoteString($pagename);
399 $result = $dbh->query("SELECT $want.*"
401 . " INNER JOIN $page_tbl AS linker ON linkfrom=linker.id"
402 . " INNER JOIN $page_tbl AS linkee ON linkto=linkee.id"
403 . " WHERE $have.pagename='$qpagename'"
404 //. " GROUP BY $want.id"
405 . " ORDER BY $want.pagename",
408 return new WikiDB_backend_PearDB_iter($this, $result);
411 function get_all_pages($include_deleted) {
413 extract($this->_table_names);
415 if ($include_deleted) {
416 $result = $dbh->query("SELECT * FROM $page_tbl ORDER BY pagename");
419 $result = $dbh->query("SELECT $page_tbl.*"
420 . " FROM $nonempty_tbl INNER JOIN $page_tbl USING(id)"
421 . " ORDER BY pagename");
424 return new WikiDB_backend_PearDB_iter($this, $result);
430 function text_search($search = '', $fullsearch = false) {
432 extract($this->_table_names);
434 $table = "$nonempty_tbl INNER JOIN $page_tbl USING(id)";
435 $fields = "$page_tbl.*";
436 $callback = '_sql_match_clause';
439 $table .= (" INNER JOIN $recent_tbl ON $page_tbl.id=$recent_tbl.id"
440 . " INNER JOIN $version_tbl"
441 . " ON $page_tbl.id=$version_tbl.id"
442 . " AND latestversion=version" );
443 $fields .= ",$version_tbl.*";
444 $callback = '_fullsearch_sql_match_clause';
448 $search_clause = $search->makeSqlClause(array($this, $callback));
450 $result = $dbh->query("SELECT $fields FROM $table"
451 . " WHERE $search_clause"
452 . " ORDER BY pagename");
454 return new WikiDB_backend_PearDB_iter($this, $result);
457 function _sql_match_clause($word) {
458 $word = $this->_dbh->quoteString($word);
459 return "LOWER(pagename) LIKE '%$word%'";
462 function _fullsearch_sql_match_clause($word) {
463 $word = $this->_dbh->quoteString($word);
464 return "LOWER(pagename) LIKE '%$word%' OR content LIKE '%$word%'";
468 * Find highest hit counts.
470 function most_popular($limit) {
472 extract($this->_table_names);
474 $limitclause = $limit ? " LIMIT $limit" : '';
475 $result = $dbh->query("SELECT $page_tbl.*"
476 . " FROM $nonempty_tbl INNER JOIN $page_tbl USING(id)"
477 . " ORDER BY hits DESC"
480 return new WikiDB_backend_PearDB_iter($this, $result);
484 * Find recent changes.
486 function most_recent($params) {
489 $include_minor_revisions = false;
490 $exclude_major_revisions = false;
491 $include_all_revisions = false;
495 extract($this->_table_names);
499 $pick[] = "mtime >= $since";
501 if ($include_all_revisions) {
502 // Include all revisions of each page.
503 $table = "$page_tbl INNER JOIN $version_tbl USING(id)";
505 if ($exclude_major_revisions) {
506 // Include only minor revisions
507 $pick[] = "minor_edit <> 0";
509 elseif (!$include_minor_revisions) {
510 // Include only major revisions
511 $pick[] = "minor_edit = 0";
515 $table = ( "$page_tbl INNER JOIN $recent_tbl USING(id)"
516 . " INNER JOIN $version_tbl ON $version_tbl.id=$page_tbl.id");
518 if ($exclude_major_revisions) {
519 // Include only most recent minor revision
520 $pick[] = 'version=latestminor';
522 elseif (!$include_minor_revisions) {
523 // Include only most recent major revision
524 $pick[] = 'version=latestmajor';
527 // Include only the latest revision (whether major or minor).
528 $pick[] ='version=latestversion';
532 $limitclause = $limit ? " LIMIT $limit" : '';
533 $whereclause = $pick ? " WHERE " . join(" AND ", $pick) : '';
535 // FIXME: use SQL_BUFFER_RESULT for mysql?
536 $result = $dbh->query("SELECT $page_tbl.*,$version_tbl.*"
539 . " ORDER BY mtime DESC"
542 return new WikiDB_backend_PearDB_iter($this, $result);
545 function _update_recent_table($pageid = false) {
547 extract($this->_table_names);
549 $maxmajor = "MAX(CASE WHEN minor_edit=0 THEN version END)";
550 $maxminor = "MAX(CASE WHEN minor_edit<>0 THEN version END)";
551 $maxversion = "MAX(version)";
553 $pageid = (int)$pageid;
557 $dbh->query("DELETE FROM $recent_tbl"
558 . ( $pageid ? " WHERE id=$pageid" : ""));
560 $dbh->query( "INSERT INTO $recent_tbl"
561 . " (id, latestversion, latestmajor, latestminor)"
562 . " SELECT id, $maxversion, $maxmajor, $maxminor"
563 . " FROM $version_tbl"
564 . ( $pageid ? " WHERE id=$pageid" : "")
569 function _update_nonempty_table($pageid = false) {
571 extract($this->_table_names);
573 $pageid = (int)$pageid;
577 $dbh->query("DELETE FROM $nonempty_tbl"
578 . ( $pageid ? " WHERE id=$pageid" : ""));
580 $dbh->query("INSERT INTO $nonempty_tbl (id)"
581 . " SELECT $recent_tbl.id"
582 . " FROM $recent_tbl INNER JOIN $version_tbl"
583 . " ON $recent_tbl.id=$version_tbl.id"
584 . " AND version=latestversion"
585 . " WHERE content<>''"
586 . ( $pageid ? " AND $recent_tbl.id=$pageid" : ""));
593 * Grab a write lock on the tables in the SQL database.
595 * Calls can be nested. The tables won't be unlocked until
596 * _unlock_database() is called as many times as _lock_database().
600 function lock($write_lock = true) {
601 if ($this->_lock_count++ == 0)
602 $this->_lock_tables($write_lock);
606 * Actually lock the required tables.
608 function _lock_tables($write_lock) {
609 trigger_error("virtual", E_USER_ERROR);
613 * Release a write lock on the tables in the SQL database.
617 * @param $force boolean Unlock even if not every call to lock() has been matched
618 * by a call to unlock().
620 * @see _lock_database
622 function unlock($force = false) {
623 if ($this->_lock_count == 0)
625 if (--$this->_lock_count <= 0 || $force) {
626 $this->_unlock_tables();
627 $this->_lock_count = 0;
632 * Actually unlock the required tables.
634 function _unlock_tables($write_lock) {
635 trigger_error("virtual", E_USER_ERROR);
639 * Callback for PEAR (DB) errors.
643 * @param A PEAR_error object.
645 function _pear_error_callback($error) {
646 if ($this->_is_false_error($error))
649 $this->_dbh->setErrorHandling(PEAR_ERROR_PRINT); // prevent recursive loops.
651 trigger_error($this->_pear_error_message($error), E_USER_ERROR);
655 * Detect false errors messages from PEAR DB.
657 * The version of PEAR DB which ships with PHP 4.0.6 has a bug in that
658 * it doesn't recognize "LOCK" and "UNLOCK" as SQL commands which don't
659 * return any data. (So when a "LOCK" command doesn't return any data,
660 * DB reports it as an error, when in fact, it's not.)
663 * @return bool True iff error is not really an error.
665 function _is_false_error($error) {
666 $code = $error->getCode();
667 $query = $this->_dbh->last_query;
668 return ($code == DB_ERROR
669 && ! DB::isManip($query)
670 && preg_match('/^\s*"?(LOCK|UNLOCK)\s/', $query));
673 function _pear_error_message($error) {
674 $class = get_class($this);
675 $message = "$class: fatal database error\n"
676 . "\t" . $error->getMessage() . "\n"
677 . "\t(" . $error->getDebugInfo() . ")\n";
683 * Filter PHP errors notices from PEAR DB code.
685 * The PEAR DB code which ships with PHP 4.0.6 produces spurious
686 * errors and notices. This is an error callback (for use with
687 * ErrorManager which will filter out those spurious messages.)
688 * @see _is_false_error, ErrorManager
691 function _pear_notice_filter($err) {
692 return ( $err->isNotice()
693 && preg_match('|DB/common.php$|', $err->errfile)
694 && $err->errline == 126
695 && preg_match('/Undefined offset: +0\b/', $err->errstr) );
699 class WikiDB_backend_PearDB_iter
700 extends WikiDB_backend_iterator
702 function WikiDB_backend_PearDB_iter(&$backend, &$query_result) {
703 if (DB::isError($query_result)) {
704 // This shouldn't happen, I thought.
705 $backend->_pear_error_callback($query_result);
708 $this->_backend = &$backend;
709 $this->_result = $query_result;
713 $backend = &$this->_backend;
717 $record = $this->_result->fetchRow(DB_FETCHMODE_ASSOC);
723 $pagedata = $backend->_extract_page_data($record);
724 $rec = array('pagename' => $record['pagename'],
725 'pagedata' => $pagedata);
727 if (!empty($record['version'])) {
728 $rec['versiondata'] = $backend->_extract_version_data($record);
729 $rec['version'] = $record['version'];
736 if ($this->_result) {
737 $this->_result->free();
738 $this->_result = false;
743 // (c-file-style: "gnu")
748 // c-hanging-comment-ender-p: nil
749 // indent-tabs-mode: nil