lib/WikiDB/backend/PearDB.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: PearDB.php,v 1.49 2004-05-03 21:35:30 rurban Exp $');
   3
   4 require_once('lib/WikiDB/backend.php');
   5 //require_once('lib/FileFinder.php');
   6 require_once('lib/ErrorManager.php');
   7 require_once('DB.php'); // Always favor use our local pear copy
   8
   9 class WikiDB_backend_PearDB
  10 extends WikiDB_backend
  11 {
  12     var $_dbh;
  13
  14     function WikiDB_backend_PearDB ($dbparams) {
  15         // Find and include PEAR's DB.php.
  16         //$pearFinder = new PearFileFinder;
  17         //$pearFinder->includeOnce('DB.php');
  18
  19         // Install filter to handle bogus error notices from buggy DB.php's.
  20         global $ErrorManager;
  21         $ErrorManager->pushErrorHandler(new WikiMethodCb($this, '_pear_notice_filter'));
  22
  23         // Open connection to database
  24         $this->_dsn = $dbparams['dsn'];
  25         $dboptions = array('persistent' => true,
  26                            'debug' => 2);
  27         if (preg_match('/^pgsql/',$this->_dsn))
  28             $dboptions['persistent'] = false;
  29         $this->_dbh = DB::connect($this->_dsn, $dboptions);
  30         $dbh = &$this->_dbh;
  31         if (DB::isError($dbh)) {
  32             trigger_error(sprintf("Can't connect to database: %s",
  33                                   $this->_pear_error_message($dbh)),
  34                           E_USER_ERROR);
  35         }
  36         $dbh->setErrorHandling(PEAR_ERROR_CALLBACK,
  37                                array(&$this, '_pear_error_callback'));
  38         $dbh->setFetchMode(DB_FETCHMODE_ASSOC);
  39
  40         $prefix = isset($dbparams['prefix']) ? $dbparams['prefix'] : '';
  41
  42         $this->_table_names
  43             = array('page_tbl'     => $prefix . 'page',
  44                     'version_tbl'  => $prefix . 'version',
  45                     'link_tbl'     => $prefix . 'link',
  46                     'recent_tbl'   => $prefix . 'recent',
  47                     'nonempty_tbl' => $prefix . 'nonempty');
  48         $page_tbl = $this->_table_names['page_tbl'];
  49         $version_tbl = $this->_table_names['version_tbl'];
  50         $this->page_tbl_fields = "$page_tbl.id as id, $page_tbl.pagename as pagename, $page_tbl.hits as hits, $page_tbl.pagedata as pagedata";
  51         $this->version_tbl_fields = "$version_tbl.version as version, $version_tbl.mtime as mtime, ".
  52             "$version_tbl.minor_edit as minor_edit, $version_tbl.content as content, $version_tbl.versiondata as versiondata";
  53
  54         $this->_expressions
  55             = array('maxmajor'     => "MAX(CASE WHEN minor_edit=0 THEN version END)",
  56                     'maxminor'     => "MAX(CASE WHEN minor_edit<>0 THEN version END)",
  57                     'maxversion'   => "MAX(version)");
  58
  59         $this->_lock_count = 0;
  60     }
  61
  62     /**
  63      * Close database connection.
  64      */
  65     function close () {
  66         if (!$this->_dbh)
  67             return;
  68         if ($this->_lock_count) {
  69             trigger_error( "WARNING: database still locked " . '(lock_count = $this->_lock_count)' . "\n<br />",
  70                           E_USER_WARNING);
  71         }
  72         $this->_dbh->setErrorHandling(PEAR_ERROR_PRINT);        // prevent recursive loops.
  73         $this->unlock('force');
  74
  75         $this->_dbh->disconnect();
  76     }
  77
  78
  79     /*
  80      * Test fast wikipage.
  81      */
  82     function is_wiki_page($pagename) {
  83         $dbh = &$this->_dbh;
  84         extract($this->_table_names);
  85         return $dbh->getOne(sprintf("SELECT $page_tbl.id as id"
  86                                     . " FROM $nonempty_tbl, $page_tbl"
  87                                     . " WHERE $nonempty_tbl.id=$page_tbl.id"
  88                                     . "   AND pagename='%s'",
  89                                     $dbh->quoteString($pagename)));
  90     }
  91
  92     function get_all_pagenames() {
  93         $dbh = &$this->_dbh;
  94         extract($this->_table_names);
  95         return $dbh->getCol("SELECT pagename"
  96                             . " FROM $nonempty_tbl, $page_tbl"
  97                             . " WHERE $nonempty_tbl.id=$page_tbl.id");
  98     }
  99
 100     function numPages($filter=false, $exclude='') {
 101         $dbh = &$this->_dbh;
 102         extract($this->_table_names);
 103         return $dbh->getOne("SELECT count(*)"
 104                             . " FROM $nonempty_tbl, $page_tbl"
 105                             . " WHERE $nonempty_tbl.id=$page_tbl.id");
 106     }
 107
 108     /**
 109      * Read page information from database.
 110      */
 111     function get_pagedata($pagename) {
 112         $dbh = &$this->_dbh;
 113         $page_tbl = $this->_table_names['page_tbl'];
 114
 115         //trigger_error("GET_PAGEDATA $pagename", E_USER_NOTICE);
 116
 117         $result = $dbh->getRow(sprintf("SELECT %s FROM $page_tbl WHERE pagename='%s'",
 118                                                                    $this->page_tbl_fields,
 119                                        $dbh->quoteString($pagename)),
 120                                DB_FETCHMODE_ASSOC);
 121         if (!$result)
 122             return false;
 123         return $this->_extract_page_data($result);
 124     }
 125
 126     function  _extract_page_data(&$query_result) {
 127         extract($query_result);
 128         $data = $this->_unserialize($pagedata);
 129         $data['hits'] = $hits;
 130         return $data;
 131     }
 132
 133     function update_pagedata($pagename, $newdata) {
 134         $dbh = &$this->_dbh;
 135         $page_tbl = $this->_table_names['page_tbl'];
 136
 137         // Hits is the only thing we can update in a fast manner.
 138         if (count($newdata) == 1 && isset($newdata['hits'])) {
 139             // Note that this will fail silently if the page does not
 140             // have a record in the page table.  Since it's just the
 141             // hit count, who cares?
 142             $dbh->query(sprintf("UPDATE $page_tbl SET hits=%d WHERE pagename='%s'",
 143                                 $newdata['hits'], $dbh->quoteString($pagename)));
 144             return;
 145         }
 146
 147         $this->lock();
 148         $data = $this->get_pagedata($pagename);
 149         if (!$data) {
 150             $data = array();
 151             $this->_get_pageid($pagename, true); // Creates page record
 152         }
 153
 154         @$hits = (int)$data['hits'];
 155         unset($data['hits']);
 156
 157         foreach ($newdata as $key => $val) {
 158             if ($key == 'hits')
 159                 $hits = (int)$val;
 160             else if (empty($val))
 161                 unset($data[$key]);
 162             else
 163                 $data[$key] = $val;
 164         }
 165
 166         $dbh->query(sprintf("UPDATE $page_tbl"
 167                             . " SET hits=%d, pagedata='%s'"
 168                             . " WHERE pagename='%s'",
 169                             $hits,
 170                             $dbh->quoteString($this->_serialize($data)),
 171                             $dbh->quoteString($pagename)));
 172
 173         $this->unlock();
 174     }
 175
 176     function _get_pageid($pagename, $create_if_missing = false) {
 177
 178         $dbh = &$this->_dbh;
 179         $page_tbl = $this->_table_names['page_tbl'];
 180
 181         $query = sprintf("SELECT id FROM $page_tbl WHERE pagename='%s'",
 182                          $dbh->quoteString($pagename));
 183
 184         if (!$create_if_missing)
 185             return $dbh->getOne($query);
 186
 187         $this->lock();
 188         $id = $dbh->getOne($query);
 189         if (empty($id)) {
 190             $max_id = $dbh->getOne("SELECT MAX(id) FROM $page_tbl");
 191             $id = $max_id + 1;
 192             $dbh->query(sprintf("INSERT INTO $page_tbl"
 193                                 . " (id,pagename,hits)"
 194                                 . " VALUES (%d,'%s',0)",
 195                                 $id, $dbh->quoteString($pagename)));
 196         }
 197         $this->unlock();
 198         return $id;
 199     }
 200
 201     function get_latest_version($pagename) {
 202         $dbh = &$this->_dbh;
 203         extract($this->_table_names);
 204         return
 205             (int)$dbh->getOne(sprintf("SELECT latestversion"
 206                                       . " FROM $page_tbl, $recent_tbl"
 207                                       . " WHERE $page_tbl.id=$recent_tbl.id"
 208                                       . "  AND pagename='%s'",
 209                                       $dbh->quoteString($pagename)));
 210     }
 211
 212     function get_previous_version($pagename, $version) {
 213         $dbh = &$this->_dbh;
 214         extract($this->_table_names);
 215
 216         return
 217             (int)$dbh->getOne(sprintf("SELECT version"
 218                                       . " FROM $version_tbl, $page_tbl"
 219                                       . " WHERE $version_tbl.id=$page_tbl.id"
 220                                       . "  AND pagename='%s'"
 221                                       . "  AND version < %d"
 222                                       . " ORDER BY version DESC"
 223                                       . " LIMIT 1",
 224                                       $dbh->quoteString($pagename),
 225                                       $version));
 226     }
 227
 228     /**
 229      * Get version data.
 230      *
 231      * @param $version int Which version to get.
 232      *
 233      * @return hash The version data, or false if specified version does not
 234      *              exist.
 235      */
 236     function get_versiondata($pagename, $version, $want_content = false) {
 237         $dbh = &$this->_dbh;
 238         extract($this->_table_names);
 239
 240         assert(is_string($pagename) and $pagename != "");
 241         assert($version > 0);
 242
 243         //trigger_error("GET_REVISION $pagename $version $want_content", E_USER_NOTICE);
 244         // FIXME: optimization: sometimes don't get page data?
 245
 246         if ($want_content) {
 247             $fields = $this->page_tbl_fields . "," . $this->version_tbl_fields;
 248         }
 249         else {
 250             $fields = $this->page_tbl_fields . ","
 251                        . "mtime, minor_edit, versiondata,"
 252                        . "content<>'' AS have_content";
 253         }
 254
 255         $result = $dbh->getRow(sprintf("SELECT $fields"
 256                                        . " FROM $page_tbl, $version_tbl"
 257                                        . " WHERE $page_tbl.id=$version_tbl.id"
 258                                        . "  AND pagename='%s'"
 259                                        . "  AND version=%d",
 260                                        $dbh->quoteString($pagename), $version),
 261                                DB_FETCHMODE_ASSOC);
 262
 263         return $this->_extract_version_data($result);
 264     }
 265
 266     function _extract_version_data(&$query_result) {
 267         if (!$query_result)
 268             return false;
 269
 270         extract($query_result);
 271         $data = $this->_unserialize($versiondata);
 272
 273         $data['mtime'] = $mtime;
 274         $data['is_minor_edit'] = !empty($minor_edit);
 275
 276         if (isset($content))
 277             $data['%content'] = $content;
 278         elseif ($have_content)
 279             $data['%content'] = true;
 280         else
 281             $data['%content'] = '';
 282
 283         // FIXME: this is ugly.
 284         if (isset($pagename)) {
 285             // Query also includes page data.
 286             // We might as well send that back too...
 287             $data['%pagedata'] = $this->_extract_page_data($query_result);
 288         }
 289
 290         return $data;
 291     }
 292
 293
 294     /**
 295      * Create a new revision of a page.
 296      */
 297     function set_versiondata($pagename, $version, $data) {
 298         $dbh = &$this->_dbh;
 299         $version_tbl = $this->_table_names['version_tbl'];
 300
 301         $minor_edit = (int) !empty($data['is_minor_edit']);
 302         unset($data['is_minor_edit']);
 303
 304         $mtime = (int)$data['mtime'];
 305         unset($data['mtime']);
 306         assert(!empty($mtime));
 307
 308         @$content = (string) $data['%content'];
 309         unset($data['%content']);
 310
 311         unset($data['%pagedata']);
 312
 313         $this->lock();
 314         $id = $this->_get_pageid($pagename, true);
 315
 316         // FIXME: optimize: mysql can do this with one REPLACE INTO (I think).
 317         $dbh->query(sprintf("DELETE FROM $version_tbl"
 318                             . " WHERE id=%d AND version=%d",
 319                             $id, $version));
 320
 321         $dbh->query(sprintf("INSERT INTO $version_tbl"
 322                             . " (id,version,mtime,minor_edit,content,versiondata)"
 323                             . " VALUES(%d,%d,%d,%d,'%s','%s')",
 324                             $id, $version, $mtime, $minor_edit,
 325                             $dbh->quoteString($content),
 326                             $dbh->quoteString($this->_serialize($data))));
 327
 328         $this->_update_recent_table($id);
 329         $this->_update_nonempty_table($id);
 330
 331         $this->unlock();
 332     }
 333
 334     /**
 335      * Delete an old revision of a page.
 336      */
 337     function delete_versiondata($pagename, $version) {
 338         $dbh = &$this->_dbh;
 339         extract($this->_table_names);
 340
 341         $this->lock();
 342         if ( ($id = $this->_get_pageid($pagename)) ) {
 343             $dbh->query("DELETE FROM $version_tbl"
 344                         . " WHERE id=$id AND version=$version");
 345             $this->_update_recent_table($id);
 346             // This shouldn't be needed (as long as the latestversion
 347             // never gets deleted.)  But, let's be safe.
 348             $this->_update_nonempty_table($id);
 349         }
 350         $this->unlock();
 351     }
 352
 353     /**
 354      * Delete page completely from the database.
 355      * I'm not sure if this is what we want. Maybe just delete the revisions
 356      */
 357     function delete_page($pagename) {
 358         $dbh = &$this->_dbh;
 359         extract($this->_table_names);
 360
 361         $this->lock();
 362         if ( ($id = $this->_get_pageid($pagename, false)) ) {
 363             $dbh->query("DELETE FROM $version_tbl  WHERE id=$id");
 364             $dbh->query("DELETE FROM $recent_tbl   WHERE id=$id");
 365             $dbh->query("DELETE FROM $nonempty_tbl WHERE id=$id");
 366             $dbh->query("DELETE FROM $link_tbl     WHERE linkfrom=$id");
 367             $nlinks = $dbh->getOne("SELECT COUNT(*) FROM $link_tbl WHERE linkto=$id");
 368             if ($nlinks) {
 369                 // We're still in the link table (dangling link) so we can't delete this
 370                 // altogether.
 371                 $dbh->query("UPDATE $page_tbl SET hits=0, pagedata='' WHERE id=$id");
 372             }
 373             else {
 374                 $dbh->query("DELETE FROM $page_tbl WHERE id=$id");
 375             }
 376             $this->_update_recent_table();
 377             $this->_update_nonempty_table();
 378         }
 379         $this->unlock();
 380     }
 381
 382
 383     // The only thing we might be interested in updating which we can
 384     // do fast in the flags (minor_edit).   I think the default
 385     // update_versiondata will work fine...
 386     //function update_versiondata($pagename, $version, $data) {
 387     //}
 388
 389     function set_links($pagename, $links) {
 390         // Update link table.
 391         // FIXME: optimize: mysql can do this all in one big INSERT.
 392
 393         $dbh = &$this->_dbh;
 394         extract($this->_table_names);
 395
 396         $this->lock();
 397         $pageid = $this->_get_pageid($pagename, true);
 398
 399         $dbh->query("DELETE FROM $link_tbl WHERE linkfrom=$pageid");
 400
 401         if ($links) {
 402             foreach($links as $link) {
 403                 if (isset($linkseen[$link]))
 404                     continue;
 405                 $linkseen[$link] = true;
 406                 $linkid = $this->_get_pageid($link, true);
 407                 $dbh->query("INSERT INTO $link_tbl (linkfrom, linkto)"
 408                             . " VALUES ($pageid, $linkid)");
 409             }
 410         }
 411         $this->unlock();
 412     }
 413
 414     /**
 415      * Find pages which link to or are linked from a page.
 416      */
 417     function get_links($pagename, $reversed = true) {
 418         $dbh = &$this->_dbh;
 419         extract($this->_table_names);
 420
 421         if ($reversed)
 422             list($have,$want) = array('linkee', 'linker');
 423         else
 424             list($have,$want) = array('linker', 'linkee');
 425
 426
 427         $qpagename = $dbh->quoteString($pagename);
 428
 429         $result = $dbh->query("SELECT $want.id as id, $want.pagename as pagename, $want.hits as hits, $want.pagedata as pagedata"
 430                               . " FROM $link_tbl, $page_tbl AS linker, $page_tbl AS linkee"
 431                               . " WHERE linkfrom=linker.id AND linkto=linkee.id"
 432                               . "  AND $have.pagename='$qpagename'"
 433                               //. " GROUP BY $want.id"
 434                               . " ORDER BY $want.pagename");
 435
 436         return new WikiDB_backend_PearDB_iter($this, $result);
 437     }
 438
 439     function get_all_pages($include_deleted=false,$sortby=false,$limit=false) {
 440         $dbh = &$this->_dbh;
 441         extract($this->_table_names);
 442         if ($limit)  $limit = "LIMIT $limit";
 443         else         $limit = '';
 444         if ($sortby) $orderby = 'ORDER BY ' . PageList::sortby($sortby,'db');
 445         else         $orderby = '';
 446         if (strstr($orderby,' mtime')) {
 447             if ($include_deleted) {
 448                 $result = $dbh->query("SELECT "
 449                                                           . $this->page_tbl_fields
 450                                                           . " FROM $page_tbl, $recent_tbl, $version_tbl"
 451                                       . " WHERE $page_tbl.id=$recent_tbl.id"
 452                                       . " AND $page_tbl.id=$version_tbl.id AND latestversion=version"
 453                                       . " $orderby $limit");
 454             }
 455             else {
 456                 $result = $dbh->query("SELECT "
 457                                       . $this->page_tbl_fields
 458                                       . " FROM $nonempty_tbl, $page_tbl, $recent_tbl, $version_tbl"
 459                                       . " WHERE $nonempty_tbl.id=$page_tbl.id"
 460                                       . " AND $page_tbl.id=$recent_tbl.id"
 461                                       . " AND $page_tbl.id=$version_tbl.id AND latestversion=version"
 462                                       . " $orderby $limit");
 463             }
 464         } else {
 465             if ($include_deleted) {
 466                 $result = $dbh->query("SELECT * FROM $page_tbl $orderby $limit");
 467             }
 468             else {
 469                 $result = $dbh->query("SELECT "
 470                                       . $this->page_tbl_fields
 471                                       . " FROM $nonempty_tbl, $page_tbl"
 472                                       . " WHERE $nonempty_tbl.id=$page_tbl.id"
 473                                       . " $orderby $limit");
 474             }
 475         }
 476         return new WikiDB_backend_PearDB_iter($this, $result);
 477     }
 478
 479     /**
 480      * Title search.
 481      */
 482     function text_search($search = '', $fullsearch = false) {
 483         $dbh = &$this->_dbh;
 484         extract($this->_table_names);
 485
 486         $table = "$nonempty_tbl, $page_tbl";
 487         $join_clause = "$nonempty_tbl.id=$page_tbl.id";
 488         $fields = $this->page_tbl_fields;
 489         $callback = new WikiMethodCb($this, '_sql_match_clause');
 490
 491         if ($fullsearch) {
 492             $table .= ", $recent_tbl";
 493             $join_clause .= " AND $page_tbl.id=$recent_tbl.id";
 494
 495             $table .= ", $version_tbl";
 496             $join_clause .= " AND $page_tbl.id=$version_tbl.id AND latestversion=version";
 497
 498             $fields .= ", " . $this->version_tbl_fields;
 499             $callback = new WikiMethodCb($this, '_fullsearch_sql_match_clause');
 500         }
 501
 502         $search_clause = $search->makeSqlClause($callback);
 503
 504         $result = $dbh->query("SELECT $fields FROM $table"
 505                               . " WHERE $join_clause"
 506                               . "  AND ($search_clause)"
 507                               . " ORDER BY pagename");
 508
 509         return new WikiDB_backend_PearDB_iter($this, $result);
 510     }
 511
 512     //Todo: check if the better Mysql MATCH operator is supported,
 513     // (ranked search) and also google like expressions.
 514     function _sql_match_clause($word) {
 515         $word = preg_replace('/(?=[%_\\\\])/', "\\", $word);
 516         $word = $this->_dbh->quoteString($word);
 517         //$page_tbl = $this->_table_names['page_tbl'];
 518         //Note: Mysql 4.1.0 has a bug which fails with binary fields.
 519         //      e.g. if word is lowercased.
 520         // http://bugs.mysql.com/bug.php?id=1491
 521         return "LOWER(pagename) LIKE '%$word%'";
 522     }
 523
 524     function _fullsearch_sql_match_clause($word) {
 525         $word = preg_replace('/(?=[%_\\\\])/', "\\", $word);
 526         $word = $this->_dbh->quoteString($word);
 527         //$page_tbl = $this->_table_names['page_tbl'];
 528         //Mysql 4.1.1 has a bug which fails here if word is lowercased.
 529         return "LOWER(pagename) LIKE '%$word%' OR content LIKE '%$word%'";
 530     }
 531
 532     /**
 533      * Find highest or lowest hit counts.
 534      */
 535     function most_popular($limit=false,$sortby = '') {
 536         $dbh = &$this->_dbh;
 537         extract($this->_table_names);
 538         $order = "DESC";
 539         if ($limit < 0){
 540             $order = "ASC";
 541             $limit = -$limit;
 542             $where = "";
 543         } else {
 544             $where = " AND hits > 0";
 545         }
 546         if ($limit)  $limit = " LIMIT $limit";
 547         else         $limit = '';
 548         if ($sortby) $orderby = ' ORDER BY ' . PageList::sortby($sortby,'db');
 549         else         $orderby = " ORDER BY hits $order";
 550         //$limitclause = $limit ? " LIMIT $limit" : '';
 551         $result = $dbh->query("SELECT "
 552                               . $this->page_tbl_fields
 553                               . " FROM $nonempty_tbl, $page_tbl"
 554                               . " WHERE $nonempty_tbl.id=$page_tbl.id"
 555                               . $where
 556                               . $orderby
 557                               . $limit);
 558
 559         return new WikiDB_backend_PearDB_iter($this, $result);
 560     }
 561
 562     /**
 563      * Find recent changes.
 564      */
 565     function most_recent($params) {
 566         $limit = 0;
 567         $since = 0;
 568         $include_minor_revisions = false;
 569         $exclude_major_revisions = false;
 570         $include_all_revisions = false;
 571         extract($params);
 572
 573         $dbh = &$this->_dbh;
 574         extract($this->_table_names);
 575
 576         $pick = array();
 577         if ($since)
 578             $pick[] = "mtime >= $since";
 579
 580
 581         if ($include_all_revisions) {
 582             // Include all revisions of each page.
 583             $table = "$page_tbl, $version_tbl";
 584             $join_clause = "$page_tbl.id=$version_tbl.id";
 585
 586             if ($exclude_major_revisions) {
 587                 // Include only minor revisions
 588                 $pick[] = "minor_edit <> 0";
 589             }
 590             elseif (!$include_minor_revisions) {
 591                 // Include only major revisions
 592                 $pick[] = "minor_edit = 0";
 593             }
 594         }
 595         else {
 596             $table = "$page_tbl, $recent_tbl";
 597             $join_clause = "$page_tbl.id=$recent_tbl.id";
 598             $table .= ", $version_tbl";
 599             $join_clause .= " AND $version_tbl.id=$page_tbl.id";
 600
 601             if ($exclude_major_revisions) {
 602                 // Include only most recent minor revision
 603                 $pick[] = 'version=latestminor';
 604             }
 605             elseif (!$include_minor_revisions) {
 606                 // Include only most recent major revision
 607                 $pick[] = 'version=latestmajor';
 608             }
 609             else {
 610                 // Include only the latest revision (whether major or minor).
 611                 $pick[] ='version=latestversion';
 612             }
 613         }
 614         $order = "DESC";
 615         if($limit < 0){
 616             $order = "ASC";
 617             $limit = -$limit;
 618         }
 619         $limitclause = $limit ? " LIMIT $limit" : '';
 620         $where_clause = $join_clause;
 621         if ($pick)
 622             $where_clause .= " AND " . join(" AND ", $pick);
 623
 624         // FIXME: use SQL_BUFFER_RESULT for mysql?
 625         $result = $dbh->query("SELECT "
 626                               . $this->page_tbl_fields . ", " . $this->version_tbl_fields
 627                               . " FROM $table"
 628                               . " WHERE $where_clause"
 629                               . " ORDER BY mtime $order"
 630                               . $limitclause);
 631
 632         return new WikiDB_backend_PearDB_iter($this, $result);
 633     }
 634
 635     /**
 636      * Rename page in the database.
 637      */
 638     function rename_page($pagename, $to) {
 639         $dbh = &$this->_dbh;
 640         extract($this->_table_names);
 641
 642         $this->lock();
 643         if ( ($id = $this->_get_pageid($pagename, false)) ) {
 644             if ($new = $this->_get_pageid($to, false)) {
 645                 //cludge alert!
 646                 //this page does not exist (already verified before), but exists in the page table.
 647                 //so we delete this page.
 648                 $dbh->query(sprintf("DELETE FROM $page_tbl WHERE id=$id",
 649                                     $dbh->quoteString($to)));
 650             }
 651             $dbh->query(sprintf("UPDATE $page_tbl SET pagename='%s' WHERE id=$id",
 652                                 $dbh->quoteString($to)));
 653         }
 654         $this->unlock();
 655         return $id;
 656     }
 657
 658     function _update_recent_table($pageid = false) {
 659         $dbh = &$this->_dbh;
 660         extract($this->_table_names);
 661         extract($this->_expressions);
 662
 663         $pageid = (int)$pageid;
 664
 665         $this->lock();
 666
 667         $dbh->query("DELETE FROM $recent_tbl"
 668                     . ( $pageid ? " WHERE id=$pageid" : ""));
 669
 670         $dbh->query( "INSERT INTO $recent_tbl"
 671                      . " (id, latestversion, latestmajor, latestminor)"
 672                      . " SELECT id, $maxversion, $maxmajor, $maxminor"
 673                      . " FROM $version_tbl"
 674                      . ( $pageid ? " WHERE id=$pageid" : "")
 675                      . " GROUP BY id" );
 676         $this->unlock();
 677     }
 678
 679     function _update_nonempty_table($pageid = false) {
 680         $dbh = &$this->_dbh;
 681         extract($this->_table_names);
 682
 683         $pageid = (int)$pageid;
 684
 685         $this->lock();
 686
 687         $dbh->query("DELETE FROM $nonempty_tbl"
 688                     . ( $pageid ? " WHERE id=$pageid" : ""));
 689
 690         $dbh->query("INSERT INTO $nonempty_tbl (id)"
 691                     . " SELECT $recent_tbl.id"
 692                     . " FROM $recent_tbl, $version_tbl"
 693                     . " WHERE $recent_tbl.id=$version_tbl.id"
 694                     . "       AND version=latestversion"
 695                     . "  AND content<>''"
 696                     . ( $pageid ? " AND $recent_tbl.id=$pageid" : ""));
 697
 698         $this->unlock();
 699     }
 700
 701
 702     /**
 703      * Grab a write lock on the tables in the SQL database.
 704      *
 705      * Calls can be nested.  The tables won't be unlocked until
 706      * _unlock_database() is called as many times as _lock_database().
 707      *
 708      * @access protected
 709      */
 710     function lock($tables = false, $write_lock = true) {
 711         if ($this->_lock_count++ == 0)
 712             $this->_lock_tables($write_lock);
 713     }
 714
 715     /**
 716      * Actually lock the required tables.
 717      */
 718     function _lock_tables($write_lock) {
 719         trigger_error("virtual", E_USER_ERROR);
 720     }
 721
 722     /**
 723      * Release a write lock on the tables in the SQL database.
 724      *
 725      * @access protected
 726      *
 727      * @param $force boolean Unlock even if not every call to lock() has been matched
 728      * by a call to unlock().
 729      *
 730      * @see _lock_database
 731      */
 732     function unlock($tables = false, $force = false) {
 733         if ($this->_lock_count == 0)
 734             return;
 735         if (--$this->_lock_count <= 0 || $force) {
 736             $this->_unlock_tables();
 737             $this->_lock_count = 0;
 738         }
 739     }
 740
 741     /**
 742      * Actually unlock the required tables.
 743      */
 744     function _unlock_tables($write_lock) {
 745         trigger_error("virtual", E_USER_ERROR);
 746     }
 747
 748
 749     /**
 750      * Serialize data
 751      */
 752     function _serialize($data) {
 753         if (empty($data))
 754             return '';
 755         assert(is_array($data));
 756         return serialize($data);
 757     }
 758
 759     /**
 760      * Unserialize data
 761      */
 762     function _unserialize($data) {
 763         return empty($data) ? array() : unserialize($data);
 764     }
 765
 766     /**
 767      * Callback for PEAR (DB) errors.
 768      *
 769      * @access protected
 770      *
 771      * @param A PEAR_error object.
 772      */
 773     function _pear_error_callback($error) {
 774         if ($this->_is_false_error($error))
 775             return;
 776
 777         $this->_dbh->setErrorHandling(PEAR_ERROR_PRINT);        // prevent recursive loops.
 778         $this->close();
 779         trigger_error($this->_pear_error_message($error), E_USER_ERROR);
 780     }
 781
 782     /**
 783      * Detect false errors messages from PEAR DB.
 784      *
 785      * The version of PEAR DB which ships with PHP 4.0.6 has a bug in that
 786      * it doesn't recognize "LOCK" and "UNLOCK" as SQL commands which don't
 787      * return any data.  (So when a "LOCK" command doesn't return any data,
 788      * DB reports it as an error, when in fact, it's not.)
 789      *
 790      * @access private
 791      * @return bool True iff error is not really an error.
 792      */
 793     function _is_false_error($error) {
 794         if ($error->getCode() != DB_ERROR)
 795             return false;
 796
 797         $query = $this->_dbh->last_query;
 798
 799         if (! preg_match('/^\s*"?(INSERT|UPDATE|DELETE|REPLACE|CREATE'
 800                          . '|DROP|ALTER|GRANT|REVOKE|LOCK|UNLOCK)\s/', $query)) {
 801             // Last query was not of the sort which doesn't return any data.
 802             //" <--kludge for brain-dead syntax coloring
 803             return false;
 804         }
 805
 806         if (! in_array('ismanip', get_class_methods('DB'))) {
 807             // Pear shipped with PHP 4.0.4pl1 (and before, presumably)
 808             // does not have the DB::isManip method.
 809             return true;
 810         }
 811
 812         if (DB::isManip($query)) {
 813             // If Pear thinks it's an isManip then it wouldn't have thrown
 814             // the error we're testing for....
 815             return false;
 816         }
 817
 818         return true;
 819     }
 820
 821     function _pear_error_message($error) {
 822         $class = get_class($this);
 823         $message = "$class: fatal database error\n"
 824              . "\t" . $error->getMessage() . "\n"
 825              . "\t(" . $error->getDebugInfo() . ")\n";
 826
 827         // Prevent password from being exposed during a connection error
 828         $safe_dsn = preg_replace('| ( :// .*? ) : .* (?=@) |xs',
 829                                  '\\1:XXXXXXXX', $this->_dsn);
 830         return str_replace($this->_dsn, $safe_dsn, $message);
 831     }
 832
 833     /**
 834      * Filter PHP errors notices from PEAR DB code.
 835      *
 836      * The PEAR DB code which ships with PHP 4.0.6 produces spurious
 837      * errors and notices.  This is an error callback (for use with
 838      * ErrorManager which will filter out those spurious messages.)
 839      * @see _is_false_error, ErrorManager
 840      * @access private
 841      */
 842     function _pear_notice_filter($err) {
 843         return ( $err->isNotice()
 844                  && preg_match('|DB[/\\\\]common.php$|', $err->errfile)
 845                  && $err->errline == 126
 846                  && preg_match('/Undefined offset: +0\b/', $err->errstr) );
 847     }
 848 };
 849
 850 /**
 851  * This class is a generic iterator.
 852  *
 853  * WikiDB_backend_PearDB_iter only iterates over things that have
 854  * 'pagename', 'pagedata', etc. etc.
 855  *
 856  * Probably WikiDB_backend_PearDB_iter and this class should be merged
 857  * (most of the code is cut-and-paste :-( ), but I am trying to make
 858  * changes that could be merged easily.
 859  *
 860  * @author: Dan Frankowski
 861  */
 862 class WikiDB_backend_PearDB_generic_iter
 863 extends WikiDB_backend_iterator
 864 {
 865     function WikiDB_backend_PearDB_generic_iter(&$backend, &$query_result) {
 866         if (DB::isError($query_result)) {
 867             // This shouldn't happen, I thought.
 868             $backend->_pear_error_callback($query_result);
 869         }
 870
 871         $this->_backend = &$backend;
 872         $this->_result = $query_result;
 873     }
 874
 875     function count() {
 876         if (!$this->_result)
 877             return false;
 878         return $this->_result->numRows();
 879     }
 880
 881     function next() {
 882         $backend = &$this->_backend;
 883         if (!$this->_result)
 884             return false;
 885
 886         $record = $this->_result->fetchRow(DB_FETCHMODE_ASSOC);
 887         if (!$record) {
 888             $this->free();
 889             return false;
 890         }
 891
 892         return $record;
 893     }
 894
 895     function free () {
 896         if ($this->_result) {
 897             $this->_result->free();
 898             $this->_result = false;
 899         }
 900     }
 901 }
 902
 903 class WikiDB_backend_PearDB_iter
 904 extends WikiDB_backend_PearDB_generic_iter
 905 {
 906
 907     function next() {
 908         $backend = &$this->_backend;
 909         if (!$this->_result)
 910             return false;
 911
 912         $record = $this->_result->fetchRow(DB_FETCHMODE_ASSOC);
 913         if (!$record) {
 914             $this->free();
 915             return false;
 916         }
 917
 918         $pagedata = $backend->_extract_page_data($record);
 919         $rec = array('pagename' => $record['pagename'],
 920                      'pagedata' => $pagedata);
 921
 922         if (!empty($record['version'])) {
 923             $rec['versiondata'] = $backend->_extract_version_data($record);
 924             $rec['version'] = $record['version'];
 925         }
 926
 927         return $rec;
 928     }
 929 }
 930 // $Log: not supported by cvs2svn $
 931 // Revision 1.48  2004/04/26 20:44:35  rurban
 932 // locking table specific for better databases
 933 //
 934 // Revision 1.47  2004/04/20 00:06:04  rurban
 935 // themable paging support
 936 //
 937 // Revision 1.46  2004/04/19 21:51:41  rurban
 938 // php5 compatibility: it works!
 939 //
 940 // Revision 1.45  2004/04/16 14:19:39  rurban
 941 // updated ADODB notes
 942 //
 943
 944 // (c-file-style: "gnu")
 945 // Local Variables:
 946 // mode: php
 947 // tab-width: 8
 948 // c-basic-offset: 4
 949 // c-hanging-comment-ender-p: nil
 950 // indent-tabs-mode: nil
 951 // End:
 952 ?>