2 rcs_id('$Id: PearDB.php,v 1.1 2001-09-18 19:16:23 dairiki Exp $');
4 require_once('DB.php');
5 require_once('lib/WikiDB/backend.php');
7 class WikiDB_backend_PearDB
10 function WikiDB_backend_PearDB ($dbparams) {
11 // Open connection to database
12 $dsn = $dbparams['dsn'];
13 $this->_dbh = DB::connect($dsn, true); //FIXME: true -> persistent connection
15 if (DB::isError($dbh)) {
16 trigger_error("Can't connect to database: "
17 . $this->_pear_error_message($dbh),
21 $dbh->setErrorHandling(PEAR_ERROR_CALLBACK,
22 array($this, '_pear_error_callback'));
23 $dbh->setFetchMode(DB_FETCHMODE_ASSOC);
25 $prefix = isset($dbparams['prefix']) ? $dbparams['prefix'] : '';
28 = array('page_tbl' => $prefix . 'page',
29 'version_tbl' => $prefix . 'version',
30 'link_tbl' => $prefix . 'link',
31 'recent_tbl' => $prefix . 'recent',
32 'nonempty_tbl' => $prefix . 'nonempty');
34 $this->_lock_count = 0;
38 * Close database connection.
43 if ($this->_lock_count) {
44 trigger_error("WARNING: database still locked"
45 . " (lock_count = $this->_lock_count)\n<br>",
48 $this->_dbh->setErrorHandling(PEAR_ERROR_PRINT); // prevent recursive loops.
49 $this->unlock('force');
51 $this->_dbh->disconnect();
59 function is_wiki_page($pagename) {
61 extract($this->_table_names);
62 return $dbh->getOne(sprintf("SELECT $page_tbl.id"
63 . " FROM $nonempty_tbl INNER JOIN $page_tbl USING(id)"
64 . " WHERE pagename='%s'",
65 $dbh->quoteString($pagename)));
68 function get_all_pagenames() {
70 extract($this->_table_names);
71 return $dbh->getCol("SELECT pagename"
72 . " FROM $nonempty_tbl INNER JOIN $page_tbl USING(id)");
76 * Read page information from database.
78 function get_pagedata($pagename) {
80 $page_tbl = $this->_table_names['page_tbl'];
82 //trigger_error("GET_PAGEDATA $pagename", E_USER_NOTICE);
84 $result = $dbh->getRow(sprintf("SELECT * FROM $page_tbl WHERE pagename='%s'",
85 $dbh->quoteString($pagename)),
89 return $this->_extract_page_data($result);
92 function _extract_page_data(&$query_result) {
93 extract($query_result);
94 $data = empty($pagedata) ? array() : unserialize($pagedata);
95 $data['hits'] = $hits;
99 function update_pagedata($pagename, $newdata) {
101 $page_tbl = $this->_table_names['page_tbl'];
103 // Hits is the only thing we can update in a fast manner.
104 if (count($newdata) == 1 && isset($newdata['hits'])) {
105 // Note that this will fail silently if the page does not
106 // have a record in the page table. Since it's just the
107 // hit count, who cares?
108 $dbh->query(sprintf("UPDATE $page_tbl SET hits=%d WHERE pagename='%s'",
109 $newdata['hits'], $dbh->quoteString($pagename)));
114 $data = $this->get_pagedata($pagename);
117 $this->_get_pageid($pagename, true); // Creates page record
120 @$hits = (int)$data['hits'];
121 unset($data['hits']);
123 foreach ($newdata as $key => $val) {
126 else if (empty($val))
132 $dbh->query(sprintf("UPDATE $page_tbl"
133 . " SET hits=%d, pagedata='%s'"
134 . " WHERE pagename='%s'",
136 $dbh->quoteString(serialize($data)),
137 $dbh->quoteString($pagename)));
142 function _get_pageid($pagename, $create_if_missing = false) {
145 $page_tbl = $this->_table_names['page_tbl'];
147 $query = sprintf("SELECT id FROM $page_tbl WHERE pagename='%s'",
148 $dbh->quoteString($pagename));
150 if (!$create_if_missing)
151 return $dbh->getOne($query);
154 $id = $dbh->getOne($query);
156 $max_id = $dbh->getOne("SELECT MAX(id) FROM $page_tbl");
158 $dbh->query(sprintf("INSERT INTO $page_tbl"
159 . " (id,pagename,hits)"
160 . " VALUES (%d,'%s',0)",
161 $id, $dbh->quoteString($pagename)));
167 function get_latest_version($pagename) {
169 extract($this->_table_names);
171 (int)$dbh->getOne(sprintf("SELECT latestversion"
173 . " INNER JOIN $recent_tbl USING(id)"
174 . " WHERE pagename='%s'",
175 $dbh->quoteString($pagename)));
178 function get_previous_version($pagename, $version) {
180 extract($this->_table_names);
183 (int)$dbh->getOne(sprintf("SELECT version"
184 . " FROM $version_tbl"
185 . " INNER JOIN $page_tbl USING(id)"
186 . " WHERE pagename='%s'"
187 . " AND version < %d"
188 . " ORDER BY version DESC"
190 $dbh->quoteString($pagename),
197 * @param $version int Which version to get.
199 * @return hash The version data, or false if specified version does not
202 function get_versiondata($pagename, $version, $want_content = false) {
204 extract($this->_table_names);
206 assert(!empty($pagename));
207 assert($version > 0);
209 //trigger_error("GET_REVISION $pagename $version $want_content", E_USER_NOTICE);
210 // FIXME: optimization: sometimes don't get page data?
216 $fields = ("$page_tbl.*,"
217 . "mtime,minor_edit,versiondata,"
218 . "content<>'' AS have_content");
221 $result = $dbh->getRow(sprintf("SELECT $fields"
223 . " INNER JOIN $version_tbl USING(id)"
224 . " WHERE pagename='%s' AND version=%d",
225 $dbh->quoteString($pagename), $version),
228 return $this->_extract_version_data($result);
231 function _extract_version_data(&$query_result) {
235 extract($query_result);
236 $data = empty($versiondata) ? array() : unserialize($versiondata);
238 $data['mtime'] = $mtime;
239 $data['is_minor_edit'] = !empty($minor_edit);
242 $data['%content'] = $content;
243 elseif ($have_content)
244 $data['%content'] = true;
246 $data['%content'] = '';
248 // FIXME: this is ugly.
249 if (isset($pagename)) {
250 // Query also includes page data.
251 // We might as well send that back too...
252 $data['%pagedata'] = $this->_extract_page_data($query_result);
260 * Create a new revision of a page.
262 function set_versiondata($pagename, $version, $data) {
264 $version_tbl = $this->_table_names['version_tbl'];
266 $minor_edit = (int) !empty($data['is_minor_edit']);
267 unset($data['is_minor_edit']);
269 $mtime = (int)$data['mtime'];
270 unset($data['mtime']);
271 assert(!empty($mtime));
273 @$content = (string) $data['%content'];
274 unset($data['%content']);
276 unset($data['%pagedata']);
279 $id = $this->_get_pageid($pagename, true);
281 // FIXME: optimize: mysql can do this with one REPLACE INTO (I think).
282 $dbh->query(sprintf("DELETE FROM $version_tbl"
283 . " WHERE id=%d AND version=%d",
286 $dbh->query(sprintf("INSERT INTO $version_tbl"
287 . " (id,version,mtime,minor_edit,content,versiondata)"
288 . " VALUES(%d,%d,%d,%d,'%s','%s')",
289 $id, $version, $mtime, $minor_edit,
290 $dbh->quoteString($content),
291 $dbh->quoteString(serialize($data))));
293 $this->_update_recent_table($id);
294 $this->_update_nonempty_table($id);
300 * Delete an old revision of a page.
302 function delete_versiondata($pagename, $version) {
304 extract($this->_table_names);
307 if ( ($id = $this->_get_pageid($pagename)) ) {
308 $dbh->query("DELETE FROM $version_tbl"
309 . " WHERE id=$id AND version=$version");
310 $this->_update_recent_table($id);
311 // This shouldn't be needed (as long as the latestversion
312 // never gets deleted.) But, let's be safe.
313 $this->_update_nonempty_table($id);
319 * Delete page from the database.
321 function delete_page($pagename) {
323 extract($this->_table_names);
326 if ( ($id = $this->_get_pageid($pagename, 'id')) ) {
327 $dbh->query("DELETE FROM $version_tbl WHERE id=$id");
328 $dbh->query("DELETE FROM $recent_tbl WHERE id=$id");
329 $dbh->query("DELETE FROM $nonempty_tbl WHERE id=$id");
330 $dbh->query("DELETE FROM $link_tbl WHERE linkfrom=$id");
331 $nlinks = $dbh->getOne("SELECT COUNT(*) FROM $link_tbl WHERE linkto=$id");
333 // We're still in the link table (dangling link) so we can't delete this
335 $dbh->query("UPDATE $page_tbl SET hits=0, pagedata='' WHERE id=$id");
338 $dbh->query("DELETE FROM $page_tbl WHERE id=$id");
340 $this->_update_recent_table();
341 $this->_update_nonempty_table();
347 // The only thing we might be interested in updating which we can
348 // do fast in the flags (minor_edit). I think the default
349 // update_versiondata will work fine...
350 //function update_versiondata($pagename, $version, $data) {
353 function set_links($pagename, $links) {
354 // Update link table.
355 // FIXME: optimize: mysql can do this all in one big INSERT.
358 extract($this->_table_names);
361 $pageid = $this->_get_pageid($pagename, true);
363 $dbh->query("DELETE FROM $link_tbl WHERE linkfrom=$pageid");
365 foreach($links as $link) {
366 if (isset($linkseen[$link]))
368 $linkseen[$link] = true;
369 $linkid = $this->_get_pageid($link, true);
370 $dbh->query("INSERT INTO $link_tbl (linkfrom, linkto)"
371 . " VALUES ($pageid, $linkid)");
377 * Find pages which link to or are linked from a page.
379 function get_links($pagename, $reversed = true) {
381 extract($this->_table_names);
384 list($have,$want) = array('linkee', 'linker');
386 list($have,$want) = array('linker', 'linkee');
388 $qpagename = $dbh->quoteString($pagename);
390 $result = $dbh->query("SELECT $want.*"
392 . " INNER JOIN $page_tbl AS linker ON linkfrom=linker.id"
393 . " INNER JOIN $page_tbl AS linkee ON linkto=linkee.id"
394 . " WHERE $have.pagename='$qpagename'"
395 //. " GROUP BY $want.id"
396 . " ORDER BY $want.pagename",
399 return new WikiDB_backend_PearDB_iter($this, $result);
402 function get_all_pages($include_deleted) {
404 extract($this->_table_names);
406 if ($include_deleted) {
407 $result = $dbh->query("SELECT * FROM $page_tbl ORDER BY pagename");
410 $result = $dbh->query("SELECT $page_tbl.*"
411 . " FROM $nonempty_tbl INNER JOIN $page_tbl USING(id)"
412 . " ORDER BY pagename");
415 return new WikiDB_backend_PearDB_iter($this, $result);
421 function text_search($search = '', $fullsearch = false) {
423 extract($this->_table_names);
425 $table = "$nonempty_tbl INNER JOIN $page_tbl USING(id)";
426 $fields = "$page_tbl.*";
427 $callback = '_sql_match_clause';
430 $table .= (" INNER JOIN $recent_tbl ON $page_tbl.id=$recent_tbl.id"
431 . " INNER JOIN $version_tbl"
432 . " ON $page_tbl.id=$version_tbl.id"
433 . " AND latestversion=version" );
434 $fields .= ",$version_tbl.*";
435 $callback = '_fullsearch_sql_match_clause';
439 $search_clause = $search->makeSqlClause(array($this, $callback));
441 $result = $dbh->query("SELECT $fields FROM $table"
442 . " WHERE $search_clause"
443 . " ORDER BY pagename");
445 return new WikiDB_backend_PearDB_iter($this, $result);
448 function _sql_match_clause($word) {
449 $word = $this->_dbh->quoteString($word);
450 return "LOWER(pagename) LIKE '%$word%'";
453 function _fullsearch_sql_match_clause($word) {
454 $word = $this->_dbh->quoteString($word);
455 return "LOWER(pagename) LIKE '%$word%' OR content LIKE '%$word%'";
459 * Find highest hit counts.
461 function most_popular($limit) {
463 extract($this->_table_names);
465 $limitclause = $limit ? " LIMIT $limit" : '';
466 $result = $dbh->query("SELECT $page_tbl.*"
467 . " FROM $nonempty_tbl INNER JOIN $page_tbl USING(id)"
468 . " ORDER BY hits DESC"
471 return new WikiDB_backend_PearDB_iter($this, $result);
475 * Find recent changes.
477 function most_recent($params) {
480 $include_minor_revisions = false;
481 $exclude_major_revisions = false;
482 $include_all_revisions = false;
486 extract($this->_table_names);
490 $pick[] = "mtime >= $since";
492 if ($include_all_revisions) {
493 // Include all revisions of each page.
494 $table = "$page_tbl INNER JOIN $version_tbl USING(id)";
496 if ($exclude_major_revisions) {
497 // Include only minor revisions
498 $pick[] = "minor_edit <> 0";
500 elseif (!$include_minor_revisions) {
501 // Include only major revisions
502 $pick[] = "minor_edit = 0";
506 $table = ( "$page_tbl INNER JOIN $recent_tbl USING(id)"
507 . " INNER JOIN $version_tbl ON $version_tbl.id=$page_tbl.id");
509 if ($exclude_major_revisions) {
510 // Include only most recent minor revision
511 $pick[] = 'version=latestminor';
513 elseif (!$include_minor_revisions) {
514 // Include only most recent major revision
515 $pick[] = 'version=latestmajor';
518 // Include only the latest revision (whether major or minor).
519 $pick[] ='version=latestversion';
523 $limitclause = $limit ? " LIMIT $limit" : '';
524 $whereclause = $pick ? " WHERE " . join(" AND ", $pick) : '';
526 // FIXME: use SQL_BUFFER_RESULT for mysql?
527 $result = $dbh->query("SELECT $page_tbl.*,$version_tbl.*"
530 . " ORDER BY mtime DESC"
533 return new WikiDB_backend_PearDB_iter($this, $result);
536 function _update_recent_table($pageid = false) {
538 extract($this->_table_names);
540 $maxmajor = "MAX(CASE WHEN minor_edit=0 THEN version END)";
541 $maxminor = "MAX(CASE WHEN minor_edit<>0 THEN version END)";
542 $maxversion = "MAX(version)";
544 $pageid = (int)$pageid;
548 $dbh->query("DELETE FROM $recent_tbl"
549 . ( $pageid ? " WHERE id=$pageid" : ""));
551 $dbh->query( "INSERT INTO $recent_tbl"
552 . " (id, latestversion, latestmajor, latestminor)"
553 . " SELECT id, $maxversion, $maxmajor, $maxminor"
554 . " FROM $version_tbl"
555 . ( $pageid ? " WHERE id=$pageid" : "")
560 function _update_nonempty_table($pageid = false) {
562 extract($this->_table_names);
564 $pageid = (int)$pageid;
568 $dbh->query("DELETE FROM $nonempty_tbl"
569 . ( $pageid ? " WHERE id=$pageid" : ""));
571 $dbh->query("INSERT INTO $nonempty_tbl (id)"
572 . " SELECT $recent_tbl.id"
573 . " FROM $recent_tbl INNER JOIN $version_tbl"
574 . " ON $recent_tbl.id=$version_tbl.id"
575 . " AND version=latestversion"
576 . " WHERE content<>''"
577 . ( $pageid ? " AND $recent_tbl.id=$pageid" : ""));
584 * Grab a write lock on the tables in the SQL database.
586 * Calls can be nested. The tables won't be unlocked until
587 * _unlock_database() is called as many times as _lock_database().
591 function lock($write_lock = true) {
592 if ($this->_lock_count++ == 0)
593 $this->_lock_tables($write_lock);
597 * Actually lock the required tables.
599 function _lock_tables($write_lock) {
600 trigger_error("virtual", E_USER_ERROR);
604 * Release a write lock on the tables in the SQL database.
608 * @param $force boolean Unlock even if not every call to lock() has been matched
609 * by a call to unlock().
611 * @see _lock_database
613 function unlock($force = false) {
614 if ($this->_lock_count == 0)
616 if (--$this->_lock_count <= 0 || $force) {
617 $this->_unlock_tables();
618 $this->_lock_count = 0;
623 * Actually unlock the required tables.
625 function _unlock_tables($write_lock) {
626 trigger_error("virtual", E_USER_ERROR);
630 * Callback for PEAR (DB) errors.
634 * @param A PEAR_error object.
636 function _pear_error_callback($error) {
637 $this->_dbh->setErrorHandling(PEAR_ERROR_PRINT); // prevent recursive loops.
639 //trigger_error($this->_pear_error_message($error), E_USER_WARNING);
640 ExitWiki($this->_pear_error_message($error));
643 function _pear_error_message($error) {
644 $class = get_class($this);
645 $message = "$class: fatal database error\n"
646 . "\t" . $error->getMessage() . "\n"
647 . "\t(" . $error->getDebugInfo() . ")\n";
653 class WikiDB_backend_PearDB_iter
654 extends WikiDB_backend_iterator
656 function WikiDB_backend_PearDB_iter(&$backend, &$query_result) {
657 if (DB::isError($query_result)) {
658 // This shouldn't happen, I thought.
659 $backend->_pear_error_callback($query_result);
662 $this->_backend = &$backend;
663 $this->_result = $query_result;
667 $backend = &$this->_backend;
671 $record = $this->_result->fetchRow(DB_FETCHMODE_ASSOC);
677 $pagedata = $backend->_extract_page_data($record);
678 $rec = array('pagename' => $record['pagename'],
679 'pagedata' => $pagedata);
681 if (!empty($record['version'])) {
682 $rec['versiondata'] = $backend->_extract_version_data($record);
683 $rec['version'] = $record['version'];
690 if ($this->_result) {
691 $this->_result->free();
692 $this->_result = false;
697 // (c-file-style: "gnu")
702 // c-hanging-comment-ender-p: nil
703 // indent-tabs-mode: nil