4 * Copyright (C) 2001-2009 $ThePhpWikiProgrammingTeam
5 * Copyright (C) 2010 Alain Peyrat, Alcatel-Lucent
7 * This file is part of PhpWiki.
9 * PhpWiki is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * PhpWiki is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 * Standard Alcatel-Lucent disclaimer for contributing to open source
27 * "The Fusionforge backend ("Contribution") has not been tested and/or
28 * validated for release as or in products, combinations with products or
29 * other commercial use. Any use of the Contribution is entirely made at
30 * the user's own responsibility and the user can not rely on any features,
31 * functionalities or performances Alcatel-Lucent has attributed to the
34 * THE CONTRIBUTION BY ALCATEL-LUCENT IS PROVIDED AS IS, WITHOUT WARRANTY
35 * OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
36 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, COMPLIANCE,
37 * NON-INTERFERENCE AND/OR INTERWORKING WITH THE SOFTWARE TO WHICH THE
38 * CONTRIBUTION HAS BEEN MADE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL
39 * ALCATEL-LUCENT BE LIABLE FOR ANY DAMAGES OR OTHER LIABLITY, WHETHER IN
40 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
41 * CONTRIBUTION OR THE USE OR OTHER DEALINGS IN THE CONTRIBUTION, WHETHER
42 * TOGETHER WITH THE SOFTWARE TO WHICH THE CONTRIBUTION RELATES OR ON A STAND
46 require_once 'lib/ErrorManager.php';
47 require_once 'lib/WikiDB/backend/PearDB_pgsql.php';
49 class WikiDB_backend_PearDB_ffpgsql
50 extends WikiDB_backend_PearDB_pgsql
52 function __construct($dbparams)
54 $dbparams['dsn'] = str_replace('ffpgsql:', 'pgsql:', $dbparams['dsn']);
55 parent::__construct($dbparams);
58 $p = strlen($page_prefix) + 1;
59 $page_tbl = $this->_table_names['page_tbl'];
60 $this->page_tbl_fields = "$page_tbl.id AS id, substring($page_tbl.pagename from $p) AS pagename, $page_tbl.hits AS hits";
62 pg_set_client_encoding("iso-8859-1");
65 function get_all_pagenames()
68 extract($this->_table_names);
71 $p = strlen($pat) + 1;
72 return $dbh->getCol("SELECT substring(pagename from $p)"
73 . " FROM $nonempty_tbl, $page_tbl"
74 . " WHERE $nonempty_tbl.id=$page_tbl.id"
75 . " AND substring($page_tbl.pagename from 0 for $p) = '$pat'");
78 function numPages($filter = false, $exclude = '')
81 extract($this->_table_names);
84 $p = strlen($pat) + 1;
85 return $dbh->getOne("SELECT count(*)"
86 . " FROM $nonempty_tbl, $page_tbl"
87 . " WHERE $nonempty_tbl.id=$page_tbl.id"
88 . " AND substring($page_tbl.pagename from 0 for $p) = '$pat'");
91 function get_pagedata($pagename)
94 return parent::get_pagedata($page_prefix . $pagename);
97 function update_pagedata($pagename, $newdata)
100 $page_tbl = $this->_table_names['page_tbl'];
102 // Hits is the only thing we can update in a fast manner.
103 if (count($newdata) == 1 && isset($newdata['hits'])) {
104 // Note that this will fail silently if the page does not
105 // have a record in the page table. Since it's just the
106 // hit count, who cares?
108 $pagename = $page_prefix . $pagename;
109 $dbh->query(sprintf("UPDATE $page_tbl SET hits=%d WHERE pagename='%s'",
110 $newdata['hits'], $dbh->escapeSimple($pagename)));
114 $this->lock(array($page_tbl), true);
115 $data = $this->get_pagedata($pagename);
118 $this->_get_pageid($pagename, true); // Creates page record
121 if (isset($data['hits'])) {
122 $hits = (int)$data['hits'];
123 unset($data['hits']);
128 foreach ($newdata as $key => $val) {
131 else if (empty($val))
137 /* Portability issue -- not all DBMS supports huge strings
138 * so we need to 'bind' instead of building a simple SQL statment.
139 * Note that we do not need to escapeSimple when we bind
140 $dbh->query(sprintf("UPDATE $page_tbl"
141 . " SET hits=%d, pagedata='%s'"
142 . " WHERE pagename='%s'",
144 $dbh->escapeSimple($this->_serialize($data)),
145 $dbh->escapeSimple($pagename)));
148 $pagename = $page_prefix . $pagename;
149 $dbh->query("UPDATE $page_tbl"
150 . " SET hits=?, pagedata=?"
151 . " WHERE pagename=?",
152 array($hits, $this->_serialize($data), $pagename));
153 $this->unlock(array($page_tbl));
156 function get_latest_version($pagename)
159 return parent::get_latest_version($page_prefix . $pagename);
162 function get_previous_version($pagename, $version)
165 return parent::get_previous_version($page_prefix . $pagename, $version);
168 function get_versiondata($pagename, $version, $want_content = false)
171 extract($this->_table_names);
172 extract($this->_expressions);
174 // assert(is_string($pagename) and $pagename != "");
175 // assert($version > 0);
177 //trigger_error("GET_REVISION $pagename $version $want_content", E_USER_NOTICE);
178 // FIXME: optimization: sometimes don't get page data?
180 $fields = $this->page_tbl_fields
181 . ",$page_tbl.pagedata as pagedata,"
182 . $this->version_tbl_fields;
184 $fields = $this->page_tbl_fields . ","
185 . "mtime, minor_edit, versiondata,"
186 . "$iscontent AS have_content";
190 $pagename = $page_prefix . $pagename;
191 $result = $dbh->getRow(sprintf("SELECT $fields"
192 . " FROM $page_tbl, $version_tbl"
193 . " WHERE $page_tbl.id=$version_tbl.id"
194 . " AND pagename='%s'"
196 $dbh->escapeSimple($pagename), $version),
199 return $this->_extract_version_data($result);
202 function get_cached_html($pagename)
205 return parent::get_cached_html($page_prefix . $pagename);
208 function set_cached_html($pagename, $data)
211 parent::set_cached_html($page_prefix . $pagename, $data);
214 function _get_pageid($pagename, $create_if_missing = false)
219 $cache =& $request->_dbi->_cache->_id_cache;
220 if (isset($cache[$pagename])) {
221 if ($cache[$pagename] or !$create_if_missing) {
222 return $cache[$pagename];
226 // attributes play this game.
227 if ($pagename === '') return 0;
230 $page_tbl = $this->_table_names['page_tbl'];
232 $pagename = $page_prefix . $pagename;
234 $query = sprintf("SELECT id FROM $page_tbl WHERE pagename='%s'",
235 $dbh->escapeSimple($pagename));
237 if (!$create_if_missing)
238 return $dbh->getOne($query);
240 $id = $dbh->getOne($query);
242 $this->lock(array($page_tbl), true); // write lock
243 $max_id = $dbh->getOne("SELECT MAX(id) FROM $page_tbl");
245 // requires createSequence and on mysql lock the interim table ->getSequenceName
246 //$id = $dbh->nextId($page_tbl . "_id");
247 $dbh->query(sprintf("INSERT INTO $page_tbl"
248 . " (id,pagename,hits)"
249 . " VALUES (%d,'%s',0)",
250 $id, $dbh->escapeSimple($pagename)));
251 $this->unlock(array($page_tbl));
256 function purge_page($pagename)
259 extract($this->_table_names);
262 if (($id = $this->_get_pageid($pagename, false))) {
263 $dbh->query("DELETE FROM $nonempty_tbl WHERE id=$id");
264 $dbh->query("DELETE FROM $recent_tbl WHERE id=$id");
265 $dbh->query("DELETE FROM $version_tbl WHERE id=$id");
266 $dbh->query("DELETE FROM $link_tbl WHERE linkfrom=$id");
267 $nlinks = $dbh->getOne("SELECT COUNT(*) FROM $link_tbl WHERE linkto=$id");
269 // We're still in the link table (dangling link) so we can't delete this
271 $dbh->query("UPDATE $page_tbl SET hits=0, pagedata='' WHERE id=$id");
274 $dbh->query("DELETE FROM $page_tbl WHERE id=$id");
278 $result = -1; // already purged or not existing
284 function get_links($pagename, $reversed = true, $include_empty = false,
285 $sortby = '', $limit = '', $exclude = '',
286 $want_relations = false)
289 extract($this->_table_names);
292 list($have, $want) = array('linkee', 'linker');
294 list($have, $want) = array('linker', 'linkee');
295 $orderby = $this->sortby($sortby, 'db', array('pagename'));
296 if ($orderby) $orderby = " ORDER BY $want." . $orderby;
297 if ($exclude) // array of pagenames
298 $exclude = " AND $want.pagename NOT IN " . $this->_sql_set($exclude);
304 $p = strlen($pat) + 1;
306 $qpagename = $dbh->escapeSimple($pagename);
307 // MeV+APe 2007-11-14
308 // added "dummyname" so that database accepts "ORDER BY"
309 $sql = "SELECT DISTINCT $want.id AS id, substring($want.pagename from $p) AS pagename, $want.pagename AS dummyname,"
310 . ($want_relations ? " related.pagename as linkrelation" : " $want.hits AS hits")
312 . (!$include_empty ? "$nonempty_tbl, " : '')
313 . " $page_tbl linkee, $page_tbl linker, $link_tbl "
314 . ($want_relations ? " JOIN $page_tbl related ON ($link_tbl.relation=related.id)" : '')
315 . " WHERE linkfrom=linker.id AND linkto=linkee.id"
316 . " AND $have.pagename='$pat$qpagename'"
317 . " AND substring($want.pagename from 0 for $p) = '$pat'"
318 . (!$include_empty ? " AND $nonempty_tbl.id=$want.id" : "")
319 //. " GROUP BY $want.id"
323 // extract from,count from limit
324 list($from, $count) = $this->limit($limit);
325 $result = $dbh->limitQuery($sql, $from, $count);
327 $result = $dbh->query($sql);
330 return new WikiDB_backend_PearDB_iter($this, $result);
333 public function get_all_pages($include_empty = false,
334 $sortby = '', $limit = '', $exclude = '')
337 extract($this->_table_names);
341 $p = strlen($pat) + 1;
343 $orderby = $this->sortby($sortby, 'db');
344 if ($orderby) $orderby = ' ORDER BY ' . $orderby;
345 if ($exclude) // array of pagenames
346 $exclude = " AND $page_tbl.pagename NOT IN " . $this->_sql_set($exclude);
350 if (strstr($orderby, 'mtime ')) { // multiple columns possible
351 if ($include_empty) {
353 . $this->page_tbl_fields
354 . " FROM $page_tbl, $recent_tbl, $version_tbl"
355 . " WHERE $page_tbl.id=$recent_tbl.id"
356 . " AND $page_tbl.id=$version_tbl.id AND latestversion=version"
357 . " AND substring($page_tbl.pagename from 0 for $p) = '$pat'"
362 . $this->page_tbl_fields
363 . " FROM $nonempty_tbl, $page_tbl, $recent_tbl, $version_tbl"
364 . " WHERE $nonempty_tbl.id=$page_tbl.id"
365 . " AND $page_tbl.id=$recent_tbl.id"
366 . " AND $page_tbl.id=$version_tbl.id AND latestversion=version"
367 . " AND substring($page_tbl.pagename from 0 for $p) = '$pat'"
372 if ($include_empty) {
374 . $this->page_tbl_fields
376 . ($exclude ? " WHERE $exclude" : '')
377 . ($exclude ? " AND " : " WHERE ")
378 . " substring($page_tbl.pagename from 0 for $p) = '$pat'"
382 . $this->page_tbl_fields
383 . " FROM $nonempty_tbl, $page_tbl"
384 . " WHERE $nonempty_tbl.id=$page_tbl.id"
385 . " AND substring($page_tbl.pagename from 0 for $p) = '$pat'"
390 if ($limit && $orderby) {
391 // extract from,count from limit
392 list($from, $count) = $this->limit($limit);
393 $result = $dbh->limitQuery($sql, $from, $count);
394 $options = array('limit_by_db' => 1);
396 $result = $dbh->query($sql);
397 $options = array('limit_by_db' => 0);
399 return new WikiDB_backend_PearDB_iter($this, $result, $options);
402 public function most_popular($limit = 20, $sortby = '-hits')
405 extract($this->_table_names);
408 $p = strlen($pat) + 1;
414 $order = "hits DESC";
415 $where = " AND hits > 0";
418 if ($sortby != '-hits') {
419 if ($order = $this->sortby($sortby, 'db'))
420 $orderby = " ORDER BY " . $order;
422 $orderby = " ORDER BY $order";
424 //$limitclause = $limit ? " LIMIT $limit" : '';
426 . $this->page_tbl_fields
427 . " FROM $nonempty_tbl, $page_tbl"
428 . " WHERE $nonempty_tbl.id=$page_tbl.id"
429 . " AND substring($page_tbl.pagename from 0 for $p) = '$pat'"
433 list($from, $count) = $this->limit($limit);
434 $result = $dbh->limitQuery($sql, $from, $count);
436 $result = $dbh->query($sql);
439 return new WikiDB_backend_PearDB_iter($this, $result);
442 public function most_recent($params)
446 $include_minor_revisions = false;
447 $exclude_major_revisions = false;
448 $include_all_revisions = false;
452 extract($this->_table_names);
456 $pick[] = "mtime >= $since";
458 if ($include_all_revisions) {
459 // Include all revisions of each page.
460 $table = "$page_tbl, $version_tbl";
461 $join_clause = "$page_tbl.id=$version_tbl.id";
463 if ($exclude_major_revisions) {
464 // Include only minor revisions
465 $pick[] = "minor_edit <> 0";
466 } elseif (!$include_minor_revisions) {
467 // Include only major revisions
468 $pick[] = "minor_edit = 0";
471 $table = "$page_tbl, $recent_tbl";
472 $join_clause = "$page_tbl.id=$recent_tbl.id";
473 $table .= ", $version_tbl";
474 $join_clause .= " AND $version_tbl.id=$page_tbl.id";
476 if ($exclude_major_revisions) {
477 // Include only most recent minor revision
478 $pick[] = 'version=latestminor';
479 } elseif (!$include_minor_revisions) {
480 // Include only most recent major revision
481 $pick[] = 'version=latestmajor';
483 // Include only the latest revision (whether major or minor).
484 $pick[] = 'version=latestversion';
492 // $limitclause = $limit ? " LIMIT $limit" : '';
493 $where_clause = $join_clause;
495 $where_clause .= " AND " . join(" AND ", $pick);
499 $p = strlen($pat) + 1;
501 // FIXME: use SQL_BUFFER_RESULT for mysql?
503 . $this->page_tbl_fields . ", " . $this->version_tbl_fields
505 . " WHERE $where_clause"
506 . " AND substring($page_tbl.pagename from 0 for $p) = '$pat'"
507 . " ORDER BY mtime $order";
509 list($from, $count) = $this->limit($limit);
510 $result = $dbh->limitQuery($sql, $from, $count);
512 $result = $dbh->query($sql);
514 return new WikiDB_backend_PearDB_iter($this, $result);
517 function wanted_pages($exclude_from = '', $exclude = '', $sortby = '', $limit = '')
520 extract($this->_table_names);
523 $p = strlen($pat) + 1;
524 if ($orderby = $this->sortby($sortby, 'db', array('pagename', 'wantedfrom')))
525 $orderby = 'ORDER BY ' . $orderby;
527 if ($exclude_from) // array of pagenames
528 $exclude_from = " AND pp.pagename NOT IN " . $this->_sql_set($exclude_from);
529 if ($exclude) // array of pagenames
530 $exclude = " AND p.pagename NOT IN " . $this->_sql_set($exclude);
532 $p = strlen($page_prefix) + 1;
533 $sql = "SELECT substring(p.pagename from $p) AS wantedfrom, substring(pp.pagename from $p) AS pagename"
534 . " FROM $page_tbl p, $link_tbl linked"
535 . " LEFT JOIN $page_tbl pp ON linked.linkto = pp.id"
536 . " LEFT JOIN $nonempty_tbl ne ON linked.linkto = ne.id"
537 . " WHERE ne.id IS NULL"
538 . " AND p.id = linked.linkfrom"
539 . " AND substring(p.pagename from 0 for $p) = '$pat'"
540 . " AND substring(pp.pagename from 0 for $p) = '$pat'"
545 // oci8 error: WHERE NULL = NULL appended
546 list($from, $count) = $this->limit($limit);
547 $result = $dbh->limitQuery($sql, $from, $count * 3);
549 $result = $dbh->query($sql);
551 return new WikiDB_backend_PearDB_generic_iter($this, $result);
554 function rename_page($pagename, $to)
557 extract($this->_table_names);
560 if (($id = $this->_get_pageid($pagename, false))) {
561 if ($new = $this->_get_pageid($to, false)) {
563 // This page does not exist (already verified before), but exists in the page table.
564 // So we delete this page.
565 $dbh->query("DELETE FROM $nonempty_tbl WHERE id=$new");
566 $dbh->query("DELETE FROM $recent_tbl WHERE id=$new");
567 $dbh->query("DELETE FROM $version_tbl WHERE id=$new");
568 // We have to fix all referring tables to the old id
569 $dbh->query("UPDATE $link_tbl SET linkfrom=$id WHERE linkfrom=$new");
570 $dbh->query("UPDATE $link_tbl SET linkto=$id WHERE linkto=$new");
571 $dbh->query("DELETE FROM $page_tbl WHERE id=$new");
574 $dbh->query(sprintf("UPDATE $page_tbl SET pagename='%s' WHERE id=$id",
575 $dbh->escapeSimple($page_prefix . $to)));
581 function is_wiki_page($pagename)
584 return parent::is_wiki_page($page_prefix . $pagename);
587 function increaseHitCount($pagename)
590 parent::increaseHitCount($page_prefix . $pagename);
593 function _serialize($data)
595 return WikiDB_backend_PearDB::_serialize($data);
600 * NOTE: Disable vacuum, wikiuser is not the table owner
608 * Text search (title or full text)
610 public function text_search($search, $fulltext = false,
611 $sortby = '', $limit = '', $exclude = '')
614 extract($this->_table_names);
617 $len = strlen($pat) + 1;
618 $orderby = $this->sortby($sortby, 'db');
619 if ($sortby and $orderby) $orderby = ' ORDER BY ' . $orderby;
621 $searchclass = get_class($this) . "_search";
622 // no need to define it everywhere and then fallback. memory!
623 if (!class_exists($searchclass))
624 $searchclass = "WikiDB_backend_PearDB_search";
625 $searchobj = new $searchclass($search, $dbh);
627 $table = "$nonempty_tbl, $page_tbl";
628 $join_clause = "$nonempty_tbl.id=$page_tbl.id";
629 $fields = $this->page_tbl_fields;
632 $table .= ", $recent_tbl";
633 $join_clause .= " AND $page_tbl.id=$recent_tbl.id";
635 $table .= ", $version_tbl";
636 $join_clause .= " AND $page_tbl.id=$version_tbl.id AND latestversion=version";
638 $fields .= ", $page_tbl.pagedata as pagedata, " . $this->version_tbl_fields;
639 // TODO: title still ignored, need better rank and subselect
640 $callback = new WikiMethodCb($searchobj, "_fulltext_match_clause");
641 $search_string = $search->makeTsearch2SqlClauseObj($callback);
642 $search_string = str_replace('%', '', $search_string);
643 $search_clause = "substring(plugin_wiki_page.pagename from 0 for $len) = '$pat') AND (";
645 $search_clause .= "idxFTI @@ plainto_tsquery('english', '$search_string')";
647 $orderby = " ORDER BY ts_rank(idxFTI, plainto_tsquery('english', '$search_string')) DESC";
649 $callback = new WikiMethodCb($searchobj, "_pagename_match_clause");
650 $search_clause = "substring(plugin_wiki_page.pagename from 0 for $len) = '$pat') AND (";
651 $search_clause .= $search->makeSqlClauseObj($callback);
654 $sql = "SELECT $fields FROM $table"
655 . " WHERE $join_clause"
656 . " AND ($search_clause)"
659 list($from, $count) = $this->limit($limit);
660 $result = $dbh->limitQuery($sql, $from, $count);
662 $result = $dbh->query($sql);
665 $iter = new WikiDB_backend_PearDB_iter($this, $result);
666 $iter->stoplisted = @$searchobj->stoplisted;
670 function exists_link($pagename, $link, $reversed = false)
673 extract($this->_table_names);
676 list($have, $want) = array('linkee', 'linker');
678 list($have, $want) = array('linker', 'linkee');
679 $qpagename = $dbh->escapeSimple($pagename);
680 $qlink = $dbh->escapeSimple($link);
681 $row = $dbh->GetRow("SELECT $want.pagename as result"
682 . " FROM $link_tbl, $page_tbl linker, $page_tbl linkee, $nonempty_tbl"
683 . " WHERE linkfrom=linker.id AND linkto=linkee.id"
684 . " AND $have.pagename='$qpagename'"
685 . " AND $want.pagename='$qlink'"
687 return $row['result'] ? 1 : 0;
691 class WikiDB_backend_PearDB_ffpgsql_search
692 extends WikiDB_backend_PearDB_pgsql_search
694 function _pagename_match_clause($node)
696 $word = $node->sql();
697 // @alu: use _quote maybe instead of direct pg_escape_string
698 $word = pg_escape_string($word);
700 $len = strlen($page_prefix) + 1;
701 if ($node->op == 'REGEX') { // posix regex extensions
702 return ($this->_case_exact
703 ? "substring(pagename from $len) ~* '$word'"
704 : "substring(pagename from $len) ~ '$word'");
706 return ($this->_case_exact
707 ? "substring(pagename from $len) LIKE '$word'"
708 : "substring(pagename from $len) ILIKE '$word'");
713 * use tsearch2. See schemas/psql-tsearch2.sql and /usr/share/postgresql/contrib/tsearch2.sql
714 * TODO: don't parse the words into nodes. rather replace "[ +]" with & and "-" with "!" and " or " with "|"
715 * tsearch2 query language: @@ "word | word", "word & word", ! word
716 * ~* '.*something that does not exist.*'
719 phrase search for "history lesson":
721 SELECT id FROM tab WHERE ts_idx_col @@ to_tsquery('history&lesson')
722 AND text_col ~* '.*history\\s+lesson.*';
724 The full-text index will still be used, and the regex will be used to
725 prune the results afterwards.
727 function _fulltext_match_clause($node)
729 $word = strtolower($node->word);
730 // $word = str_replace(" ", "&", $word); // phrase fix
732 // @alu: use _quote maybe instead of direct pg_escape_string
733 $word = pg_escape_string($word);
743 // c-hanging-comment-ender-p: nil
744 // indent-tabs-mode: nil