lib/WikiDB/backend/PearDB.php

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