lib/WikiDB/backend/ADODB.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: ADODB.php,v 1.68 2004-12-22 18:33:25 rurban Exp $');
   3
   4 /*
   5  Copyright 2002,2004 $ThePhpWikiProgrammingTeam
   6
   7  This file is part of PhpWiki.
   8
   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.
  13
  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.
  18
  19  You should have received a copy of the GNU General Public License
  20  along with PhpWiki; if not, write to the Free Software
  21  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22
  23 */
  24
  25 /**
  26  * Based on PearDB.php.
  27  * @author: Lawrence Akka, Reini Urban
  28  *
  29  * Now (phpwiki-1.3.10) with adodb-4.22, by Reini Urban:
  30  * 1) Extended to use all available database backends, not only mysql.
  31  * 2) It uses the ultra-fast binary adodb extension if loaded.
  32  * 3) We use FETCH_NUM instead of FETCH_ASSOC (faster and more generic)
  33  * 4) To support generic iterators which return ASSOC fields, and to support queries with
  34  *    variable columns, some trickery was needed to use recordset specific fetchMode.
  35  *    The first Execute uses the global fetchMode (ASSOC), then it's resetted back to NUM
  36  *    and the recordset fetchmode is set to ASSOC.
  37  * 5) Transaction support, and locking as fallback.
  38  * 6) 2004-12-10 added extra page.cached_html
  39  *
  40  * phpwiki-1.3.11, by Philippe Vanhaesendonck
  41  * - pass column list to iterators so we can FETCH_NUM in all cases
  42  *
  43  * ADODB basic differences to PearDB: It pre-fetches the first row into fields,
  44  * is dirtier in style, layout and more low-level ("worse is better").
  45  * It has less needed basic features (modifyQuery, locks, ...), but some more
  46  * unneeded features included: paging, monitoring and sessions, and much more drivers.
  47  * No locking (which PearDB supports in some backends), and sequences are very
  48  * bad compared to PearDB.
  49
  50  * Old Comments, by Lawrence Akka:
  51  * 1)  ADODB's GetRow() is slightly different from that in PEAR.  It does not
  52  *     accept a fetchmode parameter
  53  *     That doesn't matter too much here, since we only ever use FETCHMODE_ASSOC
  54  * 2)  No need for ''s around strings in sprintf arguments - qstr puts them
  55  *     there automatically
  56  * 3)  ADODB has a version of GetOne, but it is difficult to use it when
  57  *     FETCH_ASSOC is in effect.
  58  *     Instead, use $rs = Execute($query); $value = $rs->fields["$colname"]
  59  * 4)  No error handling yet - could use ADOConnection->raiseErrorFn
  60  * 5)  It used to be faster then PEAR/DB at the beginning of 2002.
  61  *     Now at August 2002 PEAR/DB with our own page cache added,
  62  *     performance is comparable.
  63  */
  64
  65 require_once('lib/WikiDB/backend.php');
  66 // Error handling - calls trigger_error.  NB - does not close the connection.  Does it need to?
  67 include_once('lib/WikiDB/adodb/adodb-errorhandler.inc.php');
  68 // include the main adodb file
  69 require_once('lib/WikiDB/adodb/adodb.inc.php');
  70
  71 class WikiDB_backend_ADODB
  72 extends WikiDB_backend
  73 {
  74
  75     function WikiDB_backend_ADODB ($dbparams) {
  76         $parsed = parseDSN($dbparams['dsn']);
  77         $this->_dbparams = $dbparams;
  78         $this->_dbh = &ADONewConnection($parsed['phptype']);
  79         if (DEBUG & _DEBUG_SQL) {
  80             $this->_dbh->debug = true;
  81             $GLOBALS['ADODB_OUTP'] = '_sql_debuglog';
  82         }
  83         $this->_dsn = $parsed;
  84         if (!empty($parsed['persistent']))
  85             $conn = $this->_dbh->PConnect($parsed['hostspec'],$parsed['username'],
  86                                           $parsed['password'], $parsed['database']);
  87         else
  88             $conn = $this->_dbh->Connect($parsed['hostspec'],$parsed['username'],
  89                                          $parsed['password'], $parsed['database']);
  90
  91         // Since 1.3.10 we use the faster ADODB_FETCH_NUM,
  92         // with some ASSOC based recordsets.
  93         $GLOBALS['ADODB_FETCH_MODE'] = ADODB_FETCH_NUM;
  94         $this->_dbh->SetFetchMode(ADODB_FETCH_NUM);
  95         $GLOBALS['ADODB_COUNTRECS'] = false;
  96
  97         $prefix = isset($dbparams['prefix']) ? $dbparams['prefix'] : '';
  98         $this->_table_names
  99             = array('page_tbl'     => $prefix . 'page',
 100                     'version_tbl'  => $prefix . 'version',
 101                     'link_tbl'     => $prefix . 'link',
 102                     'recent_tbl'   => $prefix . 'recent',
 103                     'nonempty_tbl' => $prefix . 'nonempty');
 104         $page_tbl = $this->_table_names['page_tbl'];
 105         $version_tbl = $this->_table_names['version_tbl'];
 106         $this->page_tbl_fields = "$page_tbl.id AS id, $page_tbl.pagename AS pagename, "
 107             . "$page_tbl.hits hits";
 108         $this->page_tbl_field_list = array('id', 'pagename', 'hits');
 109         $this->version_tbl_fields = "$version_tbl.version AS version, "
 110             . "$version_tbl.mtime AS mtime, "
 111             . "$version_tbl.minor_edit AS minor_edit, $version_tbl.content AS content, "
 112             . "$version_tbl.versiondata AS versiondata";
 113         $this->version_tbl_field_list = array('version', 'mtime', 'minor_edit', 'content',
 114             'versiondata');
 115
 116         $this->_expressions
 117             = array('maxmajor'     => "MAX(CASE WHEN minor_edit=0 THEN version END)",
 118                     'maxminor'     => "MAX(CASE WHEN minor_edit<>0 THEN version END)",
 119                     'maxversion'   => "MAX(version)",
 120                     'notempty'     => "<>''",
 121                     'iscontent'    => "$version_tbl.content<>''");
 122         $this->_lock_count = 0;
 123     }
 124
 125     /**
 126      * Close database connection.
 127      */
 128     function close () {
 129         if (!$this->_dbh)
 130             return;
 131         if ($this->_lock_count) {
 132             trigger_error("WARNING: database still locked " .
 133                           '(lock_count = $this->_lock_count)' . "\n<br />",
 134                           E_USER_WARNING);
 135         }
 136 //      $this->_dbh->setErrorHandling(PEAR_ERROR_PRINT);        // prevent recursive loops.
 137         $this->unlock(false,'force');
 138
 139         $this->_dbh->close();
 140         $this->_dbh = false;
 141     }
 142
 143     /*
 144      * Fast test for wikipage.
 145      */
 146     function is_wiki_page($pagename) {
 147         $dbh = &$this->_dbh;
 148         extract($this->_table_names);
 149         $row = $dbh->GetRow(sprintf("SELECT $page_tbl.id AS id"
 150                                     . " FROM $nonempty_tbl, $page_tbl"
 151                                     . " WHERE $nonempty_tbl.id=$page_tbl.id"
 152                                     . "   AND pagename=%s",
 153                                     $dbh->qstr($pagename)));
 154         return $row ? $row[0] : false;
 155     }
 156
 157     function get_all_pagenames() {
 158         $dbh = &$this->_dbh;
 159         extract($this->_table_names);
 160         $result = $dbh->Execute("SELECT pagename"
 161                                 . " FROM $nonempty_tbl, $page_tbl"
 162                                 . " WHERE $nonempty_tbl.id=$page_tbl.id");
 163         return $result->GetArray();
 164     }
 165
 166     function numPages($filter=false, $exclude='') {
 167         $dbh = &$this->_dbh;
 168         extract($this->_table_names);
 169         $result = $dbh->getRow("SELECT count(*)"
 170                             . " FROM $nonempty_tbl, $page_tbl"
 171                             . " WHERE $nonempty_tbl.id=$page_tbl.id");
 172         return $result[0];
 173     }
 174
 175     function increaseHitCount($pagename) {
 176         $dbh = &$this->_dbh;
 177         // Hits is the only thing we can update in a fast manner.
 178         // Note that this will fail silently if the page does not
 179         // have a record in the page table.  Since it's just the
 180         // hit count, who cares?
 181         $dbh->Execute(sprintf("UPDATE %s SET hits=hits+1 WHERE pagename=%s LIMIT 1",
 182                               $this->_table_names['page_tbl'],
 183                               $dbh->qstr($pagename)));
 184         return;
 185     }
 186
 187     /**
 188      * Read page information from database.
 189      */
 190     function get_pagedata($pagename) {
 191         $dbh = &$this->_dbh;
 192         $row = $dbh->GetRow(sprintf("SELECT id,pagename,hits,pagedata FROM %s WHERE pagename=%s",
 193                                     $this->_table_names['page_tbl'],
 194                                     $dbh->qstr($pagename)));
 195         return $row ? $this->_extract_page_data($row[3], $row[2]) : false;
 196     }
 197
 198     function  _extract_page_data($data, $hits) {
 199         if (empty($data)) return array();
 200         else return array_merge(array('hits' => $hits), $this->_unserialize($data));
 201     }
 202
 203     function update_pagedata($pagename, $newdata) {
 204         $dbh = &$this->_dbh;
 205         $page_tbl = $this->_table_names['page_tbl'];
 206
 207         // Hits is the only thing we can update in a fast manner.
 208         if (count($newdata) == 1 && isset($newdata['hits'])) {
 209             // Note that this will fail silently if the page does not
 210             // have a record in the page table.  Since it's just the
 211             // hit count, who cares?
 212             $dbh->Execute(sprintf("UPDATE $page_tbl SET hits=%d WHERE pagename=%s",
 213                                   $newdata['hits'], $dbh->qstr($pagename)));
 214             return;
 215         }
 216         $where = sprintf("pagename=%s", $dbh->qstr($pagename));
 217         $dbh->BeginTrans( );
 218         $dbh->RowLock($page_tbl,$where);
 219
 220         $data = $this->get_pagedata($pagename);
 221         if (!$data) {
 222             $data = array();
 223             $this->_get_pageid($pagename, true); // Creates page record
 224         }
 225
 226         $hits = (empty($data['hits'])) ? 0 : (int)$data['hits'];
 227         unset($data['hits']);
 228
 229         foreach ($newdata as $key => $val) {
 230             if ($key == 'hits')
 231                 $hits = (int)$val;
 232             else if (empty($val))
 233                 unset($data[$key]);
 234             else
 235                 $data[$key] = $val;
 236         }
 237         if ($dbh->Execute("UPDATE $page_tbl"
 238                           . " SET hits=?, pagedata=?"
 239                           . " WHERE pagename=?",
 240                           array($hits, $this->_serialize($data),$pagename))) {
 241             $dbh->CommitTrans( );
 242             return true;
 243         } else {
 244             $dbh->RollbackTrans( );
 245             return false;
 246         }
 247     }
 248
 249     function get_cached_html($pagename) {
 250         $dbh = &$this->_dbh;
 251         $page_tbl = $this->_table_names['page_tbl'];
 252         $row = $dbh->GetRow(sprintf("SELECT cached_html FROM $page_tbl WHERE pagename=%s",
 253                                     $dbh->qstr($pagename)));
 254         return $row ? $row[0] : false;
 255     }
 256
 257     function set_cached_html($pagename, $data) {
 258         $dbh = &$this->_dbh;
 259         $page_tbl = $this->_table_names['page_tbl'];
 260         $rs = $dbh->Execute("UPDATE $page_tbl"
 261                             . " SET cached_html=?"
 262                             . " WHERE pagename=?",
 263                             array($data, $pagename));
 264     }
 265
 266     function _get_pageid($pagename, $create_if_missing = false) {
 267
 268         // check id_cache
 269         global $request;
 270         $cache =& $request->_dbi->_cache->_id_cache;
 271         if (isset($cache[$pagename])) {
 272             if ($cache[$pagename] or !$create_if_missing) {
 273                 return $cache[$pagename];
 274             }
 275         }
 276
 277         $dbh = &$this->_dbh;
 278         $page_tbl = $this->_table_names['page_tbl'];
 279         $query = sprintf("SELECT id FROM $page_tbl WHERE pagename=%s",
 280                          $dbh->qstr($pagename));
 281         if (! $create_if_missing ) {
 282             $row = $dbh->GetRow($query);
 283             return $row ? $row[0] : false;
 284         }
 285         $row = $dbh->GetRow($query);
 286         if (! $row ) {
 287             //mysql, mysqli or mysqlt
 288             if (substr($dbh->databaseType,0,5) == 'mysql') {
 289                 // have auto-incrementing, atomic version
 290                 $rs = $dbh->Execute(sprintf("INSERT INTO $page_tbl"
 291                                             . " (id,pagename)"
 292                                             . " VALUES(NULL,%s)",
 293                                             $dbh->qstr($pagename)));
 294                 $id = $dbh->_insertid();
 295             } else {
 296                 //$id = $dbh->GenID($page_tbl . 'seq');
 297                 // Better generic version than with adodob::genID
 298                 //TODO: Does the DBM has subselects? Then we can do it with select max(id)+1
 299                 $this->lock(array('page'));
 300                 $dbh->BeginTrans( );
 301                 $dbh->CommitLock($page_tbl);
 302                 $row = $dbh->GetRow("SELECT MAX(id) FROM $page_tbl");
 303                 $id = $row[0] + 1;
 304                 $rs = $dbh->Execute(sprintf("INSERT INTO $page_tbl"
 305                                             . " (id,pagename,hits)"
 306                                             . " VALUES (%d,%s,0)",
 307                                             $id, $dbh->qstr($pagename)));
 308                 if ($rs) $dbh->CommitTrans( );
 309                 else $dbh->RollbackTrans( );
 310                 $this->unlock(array('page'));
 311             }
 312         } else {
 313             $id = $row[0];
 314         }
 315         assert($id);
 316         return $id;
 317     }
 318
 319     function get_latest_version($pagename) {
 320         $dbh = &$this->_dbh;
 321         extract($this->_table_names);
 322         $row = $dbh->GetRow(sprintf("SELECT latestversion"
 323                                     . " FROM $page_tbl, $recent_tbl"
 324                                     . " WHERE $page_tbl.id=$recent_tbl.id"
 325                                     . "  AND pagename=%s",
 326                                     $dbh->qstr($pagename)));
 327         return $row ? (int)$row[0] : false;
 328     }
 329
 330     function get_previous_version($pagename, $version) {
 331         $dbh = &$this->_dbh;
 332         extract($this->_table_names);
 333         // Use SELECTLIMIT for maximum portability
 334         $rs = $dbh->SelectLimit(sprintf("SELECT version"
 335                                         . " FROM $version_tbl, $page_tbl"
 336                                         . " WHERE $version_tbl.id=$page_tbl.id"
 337                                         . "  AND pagename=%s"
 338                                         . "  AND version < %d"
 339                                         . " ORDER BY version DESC"
 340                                         ,$dbh->qstr($pagename),
 341                                         $version),
 342                                 1);
 343         return $rs->fields ? (int)$rs->fields[0] : false;
 344     }
 345
 346     /**
 347      * Get version data.
 348      *
 349      * @param $version int Which version to get.
 350      *
 351      * @return hash The version data, or false if specified version does not
 352      *              exist.
 353      */
 354     function get_versiondata($pagename, $version, $want_content = false) {
 355         $dbh = &$this->_dbh;
 356         extract($this->_table_names);
 357         extract($this->_expressions);
 358
 359         assert(is_string($pagename) and $pagename != '');
 360         assert($version > 0);
 361
 362         // FIXME: optimization: sometimes don't get page data?
 363         if ($want_content) {
 364             $fields = $this->page_tbl_fields . ", $page_tbl.pagedata AS pagedata"
 365                 . ', ' . $this->version_tbl_fields;
 366         } else {
 367             $fields = $this->page_tbl_fields . ", '' AS pagedata"
 368                 . ", $version_tbl.version AS version, $version_tbl.mtime AS mtime, "
 369                 . "$version_tbl.minor_edit AS minor_edit, $iscontent AS have_content, "
 370                 . "$version_tbl.versiondata as versiondata";
 371         }
 372         $row = $dbh->GetRow(sprintf("SELECT $fields"
 373                                     . " FROM $page_tbl, $version_tbl"
 374                                     . " WHERE $page_tbl.id=$version_tbl.id"
 375                                     . "  AND pagename=%s"
 376                                     . "  AND version=%d",
 377                                     $dbh->qstr($pagename), $version));
 378         return $row ? $this->_extract_version_data_num($row, $want_content) : false;
 379     }
 380
 381     function _extract_version_data_num($row, $want_content) {
 382         if (!$row)
 383             return false;
 384
 385         //$id       &= $row[0];
 386         //$pagename &= $row[1];
 387         $data = empty($row[8]) ? array() : $this->_unserialize($row[8]);
 388         $data['mtime']         = $row[5];
 389         $data['is_minor_edit'] = !empty($row[6]);
 390         if ($want_content) {
 391             $data['%content'] = $row[7];
 392         } else {
 393             $data['%content'] = !empty($row[7]);
 394         }
 395         if (!empty($row[3])) {
 396             $data['%pagedata'] = $this->_extract_page_data($row[3], $row[2]);
 397         }
 398         return $data;
 399     }
 400
 401     function _extract_version_data_assoc($row) {
 402         if (!$row)
 403             return false;
 404
 405         extract($row);
 406         $data = empty($versiondata) ? array() : $this->_unserialize($versiondata);
 407         $data['mtime'] = $mtime;
 408         $data['is_minor_edit'] = !empty($minor_edit);
 409         if (isset($content))
 410             $data['%content'] = $content;
 411         elseif ($have_content)
 412             $data['%content'] = true;
 413         else
 414             $data['%content'] = '';
 415         if (!empty($pagedata)) {
 416             $data['%pagedata'] = $this->_extract_page_data($pagedata, $hits);
 417         }
 418         return $data;
 419     }
 420
 421     /**
 422      * Create a new revision of a page.
 423      */
 424     function set_versiondata($pagename, $version, $data) {
 425         $dbh = &$this->_dbh;
 426         $version_tbl = $this->_table_names['version_tbl'];
 427
 428         $minor_edit = (int) !empty($data['is_minor_edit']);
 429         unset($data['is_minor_edit']);
 430
 431         $mtime = (int)$data['mtime'];
 432         unset($data['mtime']);
 433         assert(!empty($mtime));
 434
 435         @$content = (string) $data['%content'];
 436         unset($data['%content']);
 437         unset($data['%pagedata']);
 438
 439         $this->lock(array('page','recent','version','nonempty'));
 440         $dbh->BeginTrans( );
 441         $dbh->CommitLock($version_tbl);
 442         $id = $this->_get_pageid($pagename, true);
 443         $backend_type = $this->backendType();
 444         // optimize: mysql can do this with one REPLACE INTO.
 445         if (substr($backend_type,0,5) == 'mysql') {
 446             $rs = $dbh->Execute(sprintf("REPLACE INTO $version_tbl"
 447                                   . " (id,version,mtime,minor_edit,content,versiondata)"
 448                                   . " VALUES(%d,%d,%d,%d,%s,%s)",
 449                                   $id, $version, $mtime, $minor_edit,
 450                                   $dbh->qstr($content),
 451                                   $dbh->qstr($this->_serialize($data))));
 452         } else {
 453             $dbh->Execute(sprintf("DELETE FROM $version_tbl"
 454                                   . " WHERE id=%d AND version=%d",
 455                                   $id, $version));
 456             $rs = $dbh->Execute("INSERT INTO $version_tbl"
 457                                 . " (id,version,mtime,minor_edit,content,versiondata)"
 458                                 . " VALUES(?,?,?,?,?,?)",
 459                                   array($id, $version, $mtime, $minor_edit,
 460                                   $content, $this->_serialize($data)));
 461         }
 462         $this->_update_recent_table($id);
 463         $this->_update_nonempty_table($id);
 464         if ($rs) $dbh->CommitTrans( );
 465         else $dbh->RollbackTrans( );
 466         $this->unlock(array('page','recent','version','nonempty'));
 467     }
 468
 469     /**
 470      * Delete an old revision of a page.
 471      */
 472     function delete_versiondata($pagename, $version) {
 473         $dbh = &$this->_dbh;
 474         extract($this->_table_names);
 475
 476         $this->lock(array('version'));
 477         if ( ($id = $this->_get_pageid($pagename)) ) {
 478             $dbh->Execute("DELETE FROM $version_tbl"
 479                         . " WHERE id=$id AND version=$version");
 480             $this->_update_recent_table($id);
 481             // This shouldn't be needed (as long as the latestversion
 482             // never gets deleted.)  But, let's be safe.
 483             $this->_update_nonempty_table($id);
 484         }
 485         $this->unlock(array('version'));
 486     }
 487
 488     /**
 489      * Delete page from the database with backup possibility.
 490      * i.e save_page('') and DELETE nonempty id
 491      *
 492      * deletePage increments latestversion in recent to a non-existent version,
 493      * and removes the nonempty row,
 494      * so that get_latest_version returns id+1 and get_previous_version returns prev id
 495      * and page->exists returns false.
 496      */
 497     function delete_page($pagename) {
 498         $dbh = &$this->_dbh;
 499         extract($this->_table_names);
 500
 501         $dbh->BeginTrans();
 502         $dbh->CommitLock($recent_tbl);
 503         if (($id = $this->_get_pageid($pagename, false)) === false) {
 504             $dbh->RollbackTrans( );
 505             return false;
 506         }
 507         $mtime = time();
 508         $user =& $GLOBALS['request']->_user;
 509         $meta = array('author' => $user->getId(),
 510                       'author_id' => $user->getAuthenticatedId(),
 511                       'mtime' => $mtime);
 512         $this->lock(array('version','recent','nonempty','page','link'));
 513         $version = $this->get_latest_version($pagename);
 514         if ($dbh->Execute("UPDATE $recent_tbl SET latestversion=latestversion+1,latestmajor=latestversion+1,latestminor=NULL WHERE id=$id")
 515             and $dbh->Execute("INSERT INTO $version_tbl"
 516                                 . " (id,version,mtime,minor_edit,content,versiondata)"
 517                                 . " VALUES(?,?,?,?,?,?)",
 518                                   array($id, $version+1, $mtime, 0,
 519                                         '', $this->_serialize($meta)))
 520             and $dbh->Execute("DELETE FROM $nonempty_tbl WHERE id=$id")
 521             and $this->set_links($pagename, false)
 522             // need to keep perms and LOCKED, otherwise you can reset the perm
 523             // by action=remove and re-create it with default perms
 524             //and $dbh->Execute("UPDATE $page_tbl SET pagedata='' WHERE id=$id") // keep hits but delete meta-data
 525            )
 526         {
 527             $this->unlock(array('version','recent','nonempty','page','link'));
 528             $dbh->CommitTrans( );
 529             return true;
 530         } else {
 531             $this->unlock(array('version','recent','nonempty','page','link'));
 532             $dbh->RollbackTrans( );
 533             return false;
 534         }
 535     }
 536
 537     function purge_page($pagename) {
 538         $dbh = &$this->_dbh;
 539         extract($this->_table_names);
 540
 541         $this->lock(array('version','recent','nonempty','page','link'));
 542         if ( ($id = $this->_get_pageid($pagename, false)) ) {
 543             $dbh->Execute("DELETE FROM $version_tbl  WHERE id=$id");
 544             $dbh->Execute("DELETE FROM $recent_tbl   WHERE id=$id");
 545             $dbh->Execute("DELETE FROM $nonempty_tbl WHERE id=$id");
 546             $this->set_links($pagename, false);
 547             $row = $dbh->GetRow("SELECT COUNT(*) FROM $link_tbl WHERE linkto=$id");
 548             if ($row and $row[0]) {
 549                 // We're still in the link table (dangling link) so we can't delete this
 550                 // altogether.
 551                 $dbh->Execute("UPDATE $page_tbl SET hits=0, pagedata='' WHERE id=$id");
 552                 $result = 0;
 553             }
 554             else {
 555                 $dbh->Execute("DELETE FROM $page_tbl WHERE id=$id");
 556                 $result = 1;
 557             }
 558         } else {
 559             $result = -1; // already purged or not existing
 560         }
 561         $this->unlock(array('version','recent','nonempty','page','link'));
 562         return $result;
 563     }
 564
 565
 566     // The only thing we might be interested in updating which we can
 567     // do fast in the flags (minor_edit).   I think the default
 568     // update_versiondata will work fine...
 569     //function update_versiondata($pagename, $version, $data) {
 570     //}
 571
 572     function set_links($pagename, $links) {
 573         // Update link table.
 574         // FIXME: optimize: mysql can do this all in one big INSERT/REPLACE.
 575
 576         $dbh = &$this->_dbh;
 577         extract($this->_table_names);
 578
 579         $this->lock(array('link'));
 580         $pageid = $this->_get_pageid($pagename, true);
 581
 582         if ($links) {
 583             $dbh->Execute("DELETE FROM $link_tbl WHERE linkfrom=$pageid");
 584             foreach ($links as $link) {
 585                 if (isset($linkseen[$link]))
 586                     continue;
 587                 $linkseen[$link] = true;
 588                 $linkid = $this->_get_pageid($link, true);
 589                 assert($linkid);
 590                 $dbh->Execute("INSERT INTO $link_tbl (linkfrom, linkto)"
 591                             . " VALUES ($pageid, $linkid)");
 592             }
 593         } elseif (DEBUG) {
 594             // purge page table: delete all non-referenced pages
 595             // for all previously linked pages...
 596             foreach ($dbh->getRow("SELECT $link_tbl.linkto as id FROM $link_tbl WHERE linkfrom=$pageid") as $id) {
 597                 // ...check if the page is empty and has no version
 598                 if ($dbh->getRow("SELECT $page_tbl.id FROM $page_tbl LEFT JOIN $nonempty_tbl USING (id) "
 599                                   ." LEFT JOIN $version_tbl USING (id)"
 600                                   ." WHERE ISNULL($nonempty_tbl.id) AND ISNULL($version_tbl.id) AND $page_tbl.id=$id")) {
 601                     $dbh->Execute("DELETE FROM $page_tbl WHERE id=$id");   // this purges the link
 602                     $dbh->Execute("DELETE FROM $recent_tbl WHERE id=$id"); // may fail
 603                 }
 604             }
 605             $dbh->Execute("DELETE FROM $link_tbl WHERE linkfrom=$pageid");
 606         }
 607         $this->unlock(array('link'));
 608         return true;
 609     }
 610
 611     /**
 612      * Find pages which link to or are linked from a page.
 613      *
 614      * Optimization: save request->_dbi->_iwpcache[] to avoid further iswikipage checks
 615      * (linkExistingWikiWord or linkUnknownWikiWord)
 616      * This is called on every page header GleanDescription, so we can store all the existing links.
 617      */
 618     function get_links($pagename, $reversed=true, $include_empty=false,
 619                        $sortby=false, $limit=false, $exclude='') {
 620         $dbh = &$this->_dbh;
 621         extract($this->_table_names);
 622
 623         if ($reversed)
 624             list($have,$want) = array('linkee', 'linker');
 625         else
 626             list($have,$want) = array('linker', 'linkee');
 627         $orderby = $this->sortby($sortby, 'db', array('pagename'));
 628         if ($orderby) $orderby = ' ORDER BY $want.' . $orderby;
 629         if ($exclude) // array of pagenames
 630             $exclude = " AND $want.pagename NOT IN ".$this->_sql_set($exclude);
 631         else
 632             $exclude='';
 633
 634         $qpagename = $dbh->qstr($pagename);
 635         // removed ref to FETCH_MODE in next line
 636         $result = $dbh->Execute("SELECT $want.id AS id, $want.pagename AS pagename,"
 637                                 . " $want.hits AS hits"
 638                                 . " FROM $link_tbl, $page_tbl linker, $page_tbl linkee"
 639                                 . (!$include_empty ? ", $nonempty_tbl" : '')
 640                                 . " WHERE linkfrom=linker.id AND linkto=linkee.id"
 641                                 . " AND $have.pagename=$qpagename"
 642                                 . (!$include_empty ? " AND $nonempty_tbl.id=$want.id" : "")
 643                                 //. " GROUP BY $want.id"
 644                                 . $exclude
 645                                 . $orderby);
 646         return new WikiDB_backend_ADODB_iter($this, $result, $this->page_tbl_field_list);
 647     }
 648
 649     /**
 650      * Find if a page links to another page
 651      */
 652     function exists_link($pagename, $link, $reversed=false) {
 653         $dbh = &$this->_dbh;
 654         extract($this->_table_names);
 655
 656         if ($reversed)
 657             list($have, $want) = array('linkee', 'linker');
 658         else
 659             list($have, $want) = array('linker', 'linkee');
 660         $qpagename = $dbh->qstr($pagename);
 661         $qlink = $dbh->qstr($link);
 662         $row = $dbh->GetRow("SELECT IF($want.pagename,1,0)"
 663                                 . " FROM $link_tbl, $page_tbl linker, $page_tbl linkee, $nonempty_tbl"
 664                                 . " WHERE linkfrom=linker.id AND linkto=linkee.id"
 665                                 . " AND $have.pagename=$qpagename"
 666                                 . " AND $want.pagename=$qlink"
 667                                 . "LIMIT 1");
 668         return $row[0];
 669     }
 670
 671     function get_all_pages($include_empty=false, $sortby=false, $limit=false, $exclude='') {
 672         $dbh = &$this->_dbh;
 673         extract($this->_table_names);
 674         $orderby = $this->sortby($sortby, 'db');
 675         if ($orderby) $orderby = ' ORDER BY ' . $orderby;
 676         if ($exclude) // array of pagenames
 677             $exclude = " AND $page_tbl.pagename NOT IN ".$this->_sql_set($exclude);
 678         else
 679             $exclude='';
 680
 681         //$dbh->SetFetchMode(ADODB_FETCH_ASSOC);
 682         if (strstr($orderby, 'mtime ')) { // was ' mtime'
 683             if ($include_empty) {
 684                 $sql = "SELECT "
 685                     . $this->page_tbl_fields
 686                     ." FROM $page_tbl, $recent_tbl, $version_tbl"
 687                     . " WHERE $page_tbl.id=$recent_tbl.id"
 688                     . " AND $page_tbl.id=$version_tbl.id AND latestversion=version"
 689                     . $exclude
 690                     . $orderby;
 691             }
 692             else {
 693                 $sql = "SELECT "
 694                     . $this->page_tbl_fields
 695                     . " FROM $nonempty_tbl, $page_tbl, $recent_tbl, $version_tbl"
 696                     . " WHERE $nonempty_tbl.id=$page_tbl.id"
 697                     . " AND $page_tbl.id=$recent_tbl.id"
 698                     . " AND $page_tbl.id=$version_tbl.id AND latestversion=version"
 699                     . $exclude
 700                     . $orderby;
 701             }
 702         } else {
 703             if ($include_empty) {
 704                 $sql = "SELECT "
 705                     . $this->page_tbl_fields
 706                     . " FROM $page_tbl"
 707                     . ($exclude ? " WHERE $exclude" : '')
 708                     . $orderby;
 709             } else {
 710                 $sql = "SELECT "
 711                     . $this->page_tbl_fields
 712                     . " FROM $nonempty_tbl, $page_tbl"
 713                     . " WHERE $nonempty_tbl.id=$page_tbl.id"
 714                     . $exclude
 715                     . $orderby;
 716             }
 717         }
 718         if ($limit) {
 719             // extract from,count from limit
 720             list($offset,$count) = $this->limit($limit);
 721             $result = $dbh->SelectLimit($sql, $count, $offset);
 722         } else {
 723             $result = $dbh->Execute($sql);
 724         }
 725         //$dbh->SetFetchMode(ADODB_FETCH_NUM);
 726         return new WikiDB_backend_ADODB_iter($this, $result, $this->page_tbl_field_list);
 727     }
 728
 729     /**
 730      * Title search.
 731      */
 732     function text_search($search, $fullsearch=false) {
 733         $dbh = &$this->_dbh;
 734         extract($this->_table_names);
 735
 736         $table = "$nonempty_tbl, $page_tbl";
 737         $join_clause = "$nonempty_tbl.id=$page_tbl.id";
 738         $fields = $this->page_tbl_fields;
 739         $field_list = $this->page_tbl_field_list;
 740         $searchobj = new WikiDB_backend_ADODB_search($search, $dbh);
 741
 742         if ($fullsearch) {
 743             $table .= ", $recent_tbl";
 744             $join_clause .= " AND $page_tbl.id=$recent_tbl.id";
 745
 746             $table .= ", $version_tbl";
 747             $join_clause .= " AND $page_tbl.id=$version_tbl.id AND latestversion=version";
 748
 749             $fields .= ",$page_tbl.pagedata as pagedata," . $this->version_tbl_fields;
 750             $field_list = array_merge($field_list, array('pagedata'), $this->version_tbl_field_list);
 751             $callback = new WikiMethodCb($searchobj, "_fulltext_match_clause");
 752         } else {
 753             $callback = new WikiMethodCb($searchobj, "_pagename_match_clause");
 754         }
 755
 756         $search_clause = $search->makeSqlClauseObj($callback);
 757         $result = $dbh->Execute("SELECT $fields FROM $table"
 758                                 . " WHERE $join_clause"
 759                                 . " AND ($search_clause)"
 760                                 . " ORDER BY pagename");
 761         return new WikiDB_backend_ADODB_iter($this, $result, $field_list);
 762     }
 763     /*
 764     function _sql_match_clause($word) {
 765         //not sure if we need this.  ADODB may do it for us
 766         $word = preg_replace('/(?=[%_\\\\])/', "\\", $word);
 767
 768         // (we need it for at least % and _ --- they're the wildcard characters
 769         //  for the LIKE operator, and we need to quote them if we're searching
 770         //  for literal '%'s or '_'s.  --- I'm not sure about \, but it seems to
 771         //  work as is.
 772         $word = $this->_dbh->qstr("%".strtolower($word)."%");
 773         $page_tbl = $this->_table_names['page_tbl'];
 774         return "LOWER($page_tbl.pagename) LIKE $word";
 775     }
 776     function _fullsearch_sql_match_clause($word) {
 777         $word = preg_replace('/(?=[%_\\\\])/', "\\", $word);  //not sure if we need this
 778         // (see above)
 779         $word = $this->_dbh->qstr("%".strtolower($word)."%");
 780         $page_tbl = $this->_table_names['page_tbl'];
 781         return "LOWER($page_tbl.pagename) LIKE $word OR content LIKE $word";
 782     }
 783     */
 784
 785     /*
 786      * TODO: efficiently handle wildcards exclusion: exclude=Php* => 'Php%',
 787      *       not sets. See above, but the above methods find too much.
 788      * This is only for already resolved wildcards:
 789      * " WHERE $page_tbl.pagename NOT IN ".$this->_sql_set(array('page1','page2'));
 790      */
 791     function _sql_set(&$pagenames) {
 792         $s = '(';
 793         foreach ($pagenames as $p) {
 794             $s .= ($this->_dbh->qstr($p).",");
 795         }
 796         return substr($s,0,-1).")";
 797     }
 798
 799     /**
 800      * Find highest or lowest hit counts.
 801      */
 802     function most_popular($limit=0, $sortby='-hits') {
 803         $dbh = &$this->_dbh;
 804         extract($this->_table_names);
 805         $order = "DESC";
 806         if ($limit < 0){
 807             $order = "ASC";
 808             $limit = -$limit;
 809             $where = "";
 810         } else {
 811             $where = " AND hits > 0";
 812         }
 813         if ($sortby != '-hits') {
 814             if ($order = $this->sortby($sortby, 'db'))  $orderby = " ORDER BY " . $order;
 815             else $orderby = "";
 816         } else
 817             $orderby = " ORDER BY hits $order";
 818         $limit = $limit ? $limit : -1;
 819
 820         $result = $dbh->SelectLimit("SELECT "
 821                                     . $this->page_tbl_fields
 822                                     . " FROM $nonempty_tbl, $page_tbl"
 823                                     . " WHERE $nonempty_tbl.id=$page_tbl.id"
 824                                     . $where
 825                                     . $orderby, $limit);
 826         return new WikiDB_backend_ADODB_iter($this, $result, $this->page_tbl_field_list);
 827     }
 828
 829     /**
 830      * Find recent changes.
 831      */
 832     function most_recent($params) {
 833         $limit = 0;
 834         $since = 0;
 835         $include_minor_revisions = false;
 836         $exclude_major_revisions = false;
 837         $include_all_revisions = false;
 838         extract($params);
 839
 840         $dbh = &$this->_dbh;
 841         extract($this->_table_names);
 842
 843         $pick = array();
 844         if ($since)
 845             $pick[] = "mtime >= $since";
 846
 847         if ($include_all_revisions) {
 848             // Include all revisions of each page.
 849             $table = "$page_tbl, $version_tbl";
 850             $join_clause = "$page_tbl.id=$version_tbl.id";
 851
 852             if ($exclude_major_revisions) {
 853                 // Include only minor revisions
 854                 $pick[] = "minor_edit <> 0";
 855             }
 856             elseif (!$include_minor_revisions) {
 857                 // Include only major revisions
 858                 $pick[] = "minor_edit = 0";
 859             }
 860         }
 861         else {
 862             $table = "$page_tbl, $recent_tbl";
 863             $join_clause = "$page_tbl.id=$recent_tbl.id";
 864             $table .= ", $version_tbl";
 865             $join_clause .= " AND $version_tbl.id=$page_tbl.id";
 866
 867             if ($exclude_major_revisions) {
 868                 // Include only most recent minor revision
 869                 $pick[] = 'version=latestminor';
 870             }
 871             elseif (!$include_minor_revisions) {
 872                 // Include only most recent major revision
 873                 $pick[] = 'version=latestmajor';
 874             }
 875             else {
 876                 // Include only the latest revision (whether major or minor).
 877                 $pick[] ='version=latestversion';
 878             }
 879         }
 880         $order = "DESC";
 881         if($limit < 0){
 882             $order = "ASC";
 883             $limit = -$limit;
 884         }
 885         $limit = $limit ? $limit : -1;
 886         $where_clause = $join_clause;
 887         if ($pick)
 888             $where_clause .= " AND " . join(" AND ", $pick);
 889
 890         // FIXME: use SQL_BUFFER_RESULT for mysql?
 891         // Use SELECTLIMIT for portability
 892         $result = $dbh->SelectLimit("SELECT "
 893                                     . $this->page_tbl_fields . ", " . $this->version_tbl_fields
 894                                     . " FROM $table"
 895                                     . " WHERE $where_clause"
 896                                     . " ORDER BY mtime $order",
 897                                     $limit);
 898         //$result->fields['version'] = $result->fields[6];
 899         return new WikiDB_backend_ADODB_iter($this, $result,
 900             array_merge($this->page_tbl_field_list, $this->version_tbl_field_list));
 901     }
 902
 903     /**
 904      * Find referenced empty pages.
 905      */
 906     function wanted_pages($exclude_from='', $exclude='', $sortby=false, $limit=false) {
 907         $dbh = &$this->_dbh;
 908         extract($this->_table_names);
 909         if ($orderby = $this->sortby($sortby, 'db', array('pagename','wantedfrom')))
 910             $orderby = 'ORDER BY ' . $orderby;
 911
 912         if ($exclude_from) // array of pagenames
 913             $exclude_from = " AND linked.pagename NOT IN ".$this->_sql_set($exclude_from);
 914         if ($exclude) // array of pagenames
 915             $exclude = " AND $page_tbl.pagename NOT IN ".$this->_sql_set($exclude);
 916
 917         $limit = $limit ? $limit : -1;
 918         /*
 919          all empty pages, independent of linkstatus:
 920            select pagename as empty from page left join nonempty using(id) where isnull(nonempty.id);
 921          only all empty pages, which have a linkto:
 922            select page.pagename, linked.pagename as wantedfrom from link, page as linked
 923              left join page on(link.linkto=page.id) left join nonempty on(link.linkto=nonempty.id)
 924              where isnull(nonempty.id) and linked.id=link.linkfrom;
 925         */
 926         $sql = "SELECT $page_tbl.pagename,linked.pagename as wantedfrom"
 927             . " FROM $link_tbl,$page_tbl as linked "
 928             . " LEFT JOIN $page_tbl ON($link_tbl.linkto=$page_tbl.id)"
 929             . " LEFT JOIN $nonempty_tbl ON($link_tbl.linkto=$nonempty_tbl.id)"
 930             . " WHERE ISNULL($nonempty_tbl.id) AND linked.id=$link_tbl.linkfrom"
 931             . $exclude_from
 932             . $exclude
 933             . $orderby;
 934         $result = $dbh->SelectLimit($sql, $limit);
 935         return new WikiDB_backend_ADODB_iter($this, $result, array('pagename','wantedfrom'));
 936     }
 937
 938     /**
 939      * Rename page in the database.
 940      */
 941     function rename_page($pagename, $to) {
 942         $dbh = &$this->_dbh;
 943         extract($this->_table_names);
 944
 945         $this->lock(array('page'));
 946         if ( ($id = $this->_get_pageid($pagename, false)) ) {
 947             if ($new = $this->_get_pageid($to, false)) {
 948                 //cludge alert!
 949                 //this page does not exist (already verified before), but exists in the page table.
 950                 //so we delete this page.
 951                 $dbh->query(sprintf("DELETE FROM $page_tbl WHERE id=$id",
 952                                     $dbh->qstr($to)));
 953             }
 954             $dbh->query(sprintf("UPDATE $page_tbl SET pagename=%s WHERE id=$id",
 955                                 $dbh->qstr($to)));
 956         }
 957         $this->unlock(array('page'));
 958         return $id;
 959     }
 960
 961     function _update_recent_table($pageid = false) {
 962         $dbh = &$this->_dbh;
 963         extract($this->_table_names);
 964         extract($this->_expressions);
 965
 966         $pageid = (int)$pageid;
 967
 968         // optimize: mysql can do this with one REPLACE INTO.
 969         $backend_type = $this->backendType();
 970         if (substr($backend_type,0,5) == 'mysql') {
 971             $dbh->Execute("REPLACE INTO $recent_tbl"
 972                           . " (id, latestversion, latestmajor, latestminor)"
 973                           . " SELECT id, $maxversion, $maxmajor, $maxminor"
 974                           . " FROM $version_tbl"
 975                           . ( $pageid ? " WHERE id=$pageid" : "")
 976                           . " GROUP BY id" );
 977         } else {
 978             $this->lock(array('recent'));
 979             $dbh->Execute("DELETE FROM $recent_tbl"
 980                       . ( $pageid ? " WHERE id=$pageid" : ""));
 981             $dbh->Execute( "INSERT INTO $recent_tbl"
 982                            . " (id, latestversion, latestmajor, latestminor)"
 983                            . " SELECT id, $maxversion, $maxmajor, $maxminor"
 984                            . " FROM $version_tbl"
 985                            . ( $pageid ? " WHERE id=$pageid" : "")
 986                            . " GROUP BY id" );
 987             $this->unlock(array('recent'));
 988         }
 989     }
 990
 991     function _update_nonempty_table($pageid = false) {
 992         $dbh = &$this->_dbh;
 993         extract($this->_table_names);
 994         extract($this->_expressions);
 995
 996         $pageid = (int)$pageid;
 997
 998         extract($this->_expressions);
 999         $this->lock(array('nonempty'));
1000         $dbh->Execute("DELETE FROM $nonempty_tbl"
1001                       . ( $pageid ? " WHERE id=$pageid" : ""));
1002         $dbh->Execute("INSERT INTO $nonempty_tbl (id)"
1003                       . " SELECT $recent_tbl.id"
1004                       . " FROM $recent_tbl, $version_tbl"
1005                       . " WHERE $recent_tbl.id=$version_tbl.id"
1006                       . "       AND version=latestversion"
1007                       // We have some specifics here (Oracle)
1008                       //. "  AND content<>''"
1009                       . "  AND content $notempty"
1010                       . ( $pageid ? " AND $recent_tbl.id=$pageid" : ""));
1011         $this->unlock(array('nonempty'));
1012     }
1013
1014     /**
1015      * Grab a write lock on the tables in the SQL database.
1016      *
1017      * Calls can be nested.  The tables won't be unlocked until
1018      * _unlock_database() is called as many times as _lock_database().
1019      *
1020      * @access protected
1021      */
1022     function lock($tables, $write_lock = true) {
1023             $this->_dbh->StartTrans();
1024         if ($this->_lock_count++ == 0) {
1025             $this->_current_lock = $tables;
1026             $this->_lock_tables($tables, $write_lock);
1027         }
1028     }
1029
1030     /**
1031      * Overridden by non-transaction safe backends.
1032      */
1033     function _lock_tables($tables, $write_lock) {
1034         return $this->_current_lock;
1035     }
1036
1037     /**
1038      * Release a write lock on the tables in the SQL database.
1039      *
1040      * @access protected
1041      *
1042      * @param $force boolean Unlock even if not every call to lock() has been matched
1043      * by a call to unlock().
1044      *
1045      * @see _lock_database
1046      */
1047     function unlock($tables = false, $force = false) {
1048         if ($this->_lock_count == 0) {
1049             $this->_dbh->CompleteTrans(! $force);
1050             $this->_current_lock = false;
1051             return;
1052         }
1053         if (--$this->_lock_count <= 0 || $force) {
1054             $this->_unlock_tables($tables);
1055             $this->_current_lock = false;
1056             $this->_lock_count = 0;
1057         }
1058             $this->_dbh->CompleteTrans(! $force);
1059     }
1060
1061     /**
1062      * overridden by non-transaction safe backends
1063      */
1064     function _unlock_tables($tables, $write_lock) {
1065         return;
1066     }
1067
1068     /**
1069      * Serialize data
1070      */
1071     function _serialize($data) {
1072         if (empty($data))
1073             return '';
1074         assert(is_array($data));
1075         return serialize($data);
1076     }
1077
1078     /**
1079      * Unserialize data
1080      */
1081     function _unserialize($data) {
1082         return empty($data) ? array() : unserialize($data);
1083     }
1084
1085     /* some variables and functions for DB backend abstraction (action=upgrade) */
1086     function database () {
1087         return $this->_dbh->database;
1088     }
1089     function backendType() {
1090         return $this->_dbh->databaseType;
1091     }
1092     function connection() {
1093         return $this->_dbh->_connectionID;
1094     }
1095
1096     function listOfTables() {
1097         return $this->_dbh->MetaTables();
1098     }
1099     function listOfFields($database,$table) {
1100         $field_list = array();
1101         foreach ($this->_dbh->MetaColumns($table,false) as $field) {
1102             $field_list[] = $field->name;
1103         }
1104         return $field_list;
1105     }
1106
1107 };
1108
1109 class WikiDB_backend_ADODB_generic_iter
1110 extends WikiDB_backend_iterator
1111 {
1112     function WikiDB_backend_ADODB_generic_iter($backend, $query_result, $field_list = NULL) {
1113         $this->_backend = &$backend;
1114         $this->_result = $query_result;
1115
1116         if (is_null($field_list)) {
1117             // No field list passed, retrieve from DB
1118             // WikiLens is using the iterator behind the scene
1119             $field_list = array();
1120             $fields = $query_result->FieldCount();
1121             for ($i = 0; $i < $fields ; $i++) {
1122                 $field_info = $query_result->FetchField($i);
1123                 array_push($field_list, $field_info->name);
1124             }
1125         }
1126
1127         $this->_fields = $field_list;
1128     }
1129
1130     function count() {
1131         if (!$this->_result) {
1132             return false;
1133         }
1134         $count = $this->_result->numRows();
1135         //$this->_result->Close();
1136         return $count;
1137     }
1138
1139     function next() {
1140         $result = &$this->_result;
1141         $backend = &$this->_backend;
1142         if (!$result || $result->EOF) {
1143             $this->free();
1144             return false;
1145         }
1146
1147         // Convert array to hash
1148         $i = 0;
1149         $rec_num = $result->fields;
1150         foreach ($this->_fields as $field) {
1151             $rec_assoc[$field] = $rec_num[$i++];
1152         }
1153         // check if the cache can be populated here?
1154
1155         $result->MoveNext();
1156         return $rec_assoc;
1157     }
1158
1159     function free () {
1160         if ($this->_result) {
1161             /* call mysql_free_result($this->_queryID) */
1162             $this->_result->Close();
1163             $this->_result = false;
1164         }
1165     }
1166 }
1167
1168 class WikiDB_backend_ADODB_iter
1169 extends WikiDB_backend_ADODB_generic_iter
1170 {
1171     function next() {
1172         $result = &$this->_result;
1173         $backend = &$this->_backend;
1174         if (!$result || $result->EOF) {
1175             $this->free();
1176             return false;
1177         }
1178
1179         // Convert array to hash
1180         $i = 0;
1181         $rec_num = $result->fields;
1182         foreach ($this->_fields as $field) {
1183             $rec_assoc[$field] = $rec_num[$i++];
1184         }
1185
1186         $result->MoveNext();
1187         if (isset($rec_assoc['pagedata']))
1188             $rec_assoc['pagedata'] = $backend->_extract_page_data($rec_assoc['pagedata'], $rec_assoc['hits']);
1189         if (!empty($rec_assoc['version'])) {
1190             $rec_assoc['versiondata'] = $backend->_extract_version_data_assoc($rec_assoc);
1191         }
1192         return $rec_assoc;
1193     }
1194 }
1195
1196 class WikiDB_backend_ADODB_search
1197 extends WikiDB_backend_search
1198 {
1199     function WikiDB_backend_ADODB_search(&$search, &$dbh) {
1200         $this->_dbh =& $dbh;
1201         $this->_case_exact = $search->_case_exact;
1202     }
1203     function _pagename_match_clause($node) {
1204         $word = $node->sql();
1205         return $this->_case_exact
1206             ? "pagename LIKE '$word'"
1207             : "LOWER(pagename) LIKE '$word'";
1208     }
1209     function _fulltext_match_clause($node) {
1210         $word = $node->sql();
1211         return $this->_case_exact
1212             ? "pagename LIKE '$word' OR content LIKE '$word'"
1213             : "LOWER(pagename) LIKE '$word' OR content LIKE '$word'";
1214     }
1215 }
1216
1217 // Following function taken from Pear::DB (prev. from adodb-pear.inc.php).
1218 // Eventually, change index.php to provide the relevant information
1219 // directly?
1220     /**
1221      * Parse a data source name.
1222      *
1223      * Additional keys can be added by appending a URI query string to the
1224      * end of the DSN.
1225      *
1226      * The format of the supplied DSN is in its fullest form:
1227      * <code>
1228      *  phptype(dbsyntax)://username:password@protocol+hostspec/database?option=8&another=true
1229      * </code>
1230      *
1231      * Most variations are allowed:
1232      * <code>
1233      *  phptype://username:password@protocol+hostspec:110//usr/db_file.db?mode=0644
1234      *  phptype://username:password@hostspec/database_name
1235      *  phptype://username:password@hostspec
1236      *  phptype://username@hostspec
1237      *  phptype://hostspec/database
1238      *  phptype://hostspec
1239      *  phptype(dbsyntax)
1240      *  phptype
1241      * </code>
1242      *
1243      * @param string $dsn Data Source Name to be parsed
1244      *
1245      * @return array an associative array with the following keys:
1246      *  + phptype:  Database backend used in PHP (mysql, odbc etc.)
1247      *  + dbsyntax: Database used with regards to SQL syntax etc.
1248      *  + protocol: Communication protocol to use (tcp, unix etc.)
1249      *  + hostspec: Host specification (hostname[:port])
1250      *  + database: Database to use on the DBMS server
1251      *  + username: User name for login
1252      *  + password: Password for login
1253      *
1254      * @author Tomas V.V.Cox <cox@idecnet.com>
1255      */
1256     function parseDSN($dsn)
1257     {
1258         $parsed = array(
1259             'phptype'  => false,
1260             'dbsyntax' => false,
1261             'username' => false,
1262             'password' => false,
1263             'protocol' => false,
1264             'hostspec' => false,
1265             'port'     => false,
1266             'socket'   => false,
1267             'database' => false,
1268         );
1269
1270         if (is_array($dsn)) {
1271             $dsn = array_merge($parsed, $dsn);
1272             if (!$dsn['dbsyntax']) {
1273                 $dsn['dbsyntax'] = $dsn['phptype'];
1274             }
1275             return $dsn;
1276         }
1277
1278         // Find phptype and dbsyntax
1279         if (($pos = strpos($dsn, '://')) !== false) {
1280             $str = substr($dsn, 0, $pos);
1281             $dsn = substr($dsn, $pos + 3);
1282         } else {
1283             $str = $dsn;
1284             $dsn = null;
1285         }
1286
1287         // Get phptype and dbsyntax
1288         // $str => phptype(dbsyntax)
1289         if (preg_match('|^(.+?)\((.*?)\)$|', $str, $arr)) {
1290             $parsed['phptype']  = $arr[1];
1291             $parsed['dbsyntax'] = !$arr[2] ? $arr[1] : $arr[2];
1292         } else {
1293             $parsed['phptype']  = $str;
1294             $parsed['dbsyntax'] = $str;
1295         }
1296
1297         if (!count($dsn)) {
1298             return $parsed;
1299         }
1300
1301         // Get (if found): username and password
1302         // $dsn => username:password@protocol+hostspec/database
1303         if (($at = strrpos($dsn,'@')) !== false) {
1304             $str = substr($dsn, 0, $at);
1305             $dsn = substr($dsn, $at + 1);
1306             if (($pos = strpos($str, ':')) !== false) {
1307                 $parsed['username'] = rawurldecode(substr($str, 0, $pos));
1308                 $parsed['password'] = rawurldecode(substr($str, $pos + 1));
1309             } else {
1310                 $parsed['username'] = rawurldecode($str);
1311             }
1312         }
1313
1314         // Find protocol and hostspec
1315
1316         // $dsn => proto(proto_opts)/database
1317         if (preg_match('|^([^(]+)\((.*?)\)/?(.*?)$|', $dsn, $match)) {
1318             $proto       = $match[1];
1319             $proto_opts  = $match[2] ? $match[2] : false;
1320             $dsn         = $match[3];
1321
1322         // $dsn => protocol+hostspec/database (old format)
1323         } else {
1324             if (strpos($dsn, '+') !== false) {
1325                 list($proto, $dsn) = explode('+', $dsn, 2);
1326             }
1327             if (strpos($dsn, '/') !== false) {
1328                 list($proto_opts, $dsn) = explode('/', $dsn, 2);
1329             } else {
1330                 $proto_opts = $dsn;
1331                 $dsn = null;
1332             }
1333         }
1334
1335         // process the different protocol options
1336         $parsed['protocol'] = (!empty($proto)) ? $proto : 'tcp';
1337         $proto_opts = rawurldecode($proto_opts);
1338         if ($parsed['protocol'] == 'tcp') {
1339             if (strpos($proto_opts, ':') !== false) {
1340                 list($parsed['hostspec'], $parsed['port']) = explode(':', $proto_opts);
1341             } else {
1342                 $parsed['hostspec'] = $proto_opts;
1343             }
1344         } elseif ($parsed['protocol'] == 'unix') {
1345             $parsed['socket'] = $proto_opts;
1346         }
1347
1348         // Get dabase if any
1349         // $dsn => database
1350         if ($dsn) {
1351             // /database
1352             if (($pos = strpos($dsn, '?')) === false) {
1353                 $parsed['database'] = $dsn;
1354             // /database?param1=value1&param2=value2
1355             } else {
1356                 $parsed['database'] = substr($dsn, 0, $pos);
1357                 $dsn = substr($dsn, $pos + 1);
1358                 if (strpos($dsn, '&') !== false) {
1359                     $opts = explode('&', $dsn);
1360                 } else { // database?param1=value1
1361                     $opts = array($dsn);
1362                 }
1363                 foreach ($opts as $opt) {
1364                     list($key, $value) = explode('=', $opt);
1365                     if (!isset($parsed[$key])) {
1366                         // don't allow params overwrite
1367                         $parsed[$key] = rawurldecode($value);
1368                     }
1369                 }
1370             }
1371         }
1372
1373         return $parsed;
1374     }
1375
1376 // $Log: not supported by cvs2svn $
1377 // Revision 1.67  2004/12/22 15:47:41  rurban
1378 // fix wrong _update_nonempty_table on empty content (i.e. the new deletePage)
1379 //
1380 // Revision 1.66  2004/12/13 14:39:16  rurban
1381 // avoid warning
1382 //
1383 // Revision 1.65  2004/12/10 22:15:00  rurban
1384 // fix $page->get('_cached_html)
1385 // refactor upgrade db helper _convert_cached_html() to be able to call them from WikiAdminUtils also.
1386 // support 2nd genericSqlQuery param (bind huge arg)
1387 //
1388 // Revision 1.64  2004/12/10 02:45:27  rurban
1389 // SQL optimization:
1390 //   put _cached_html from pagedata into a new seperate blob, not huge serialized string.
1391 //   it is only rarelely needed: for current page only, if-not-modified
1392 //   but was extracted for every simple page iteration.
1393 //
1394 // Revision 1.63  2004/12/08 12:55:51  rurban
1395 // support new non-destructive delete_page via generic backend method
1396 //
1397 // Revision 1.62  2004/12/06 19:50:04  rurban
1398 // enable action=remove which is undoable and seeable in RecentChanges: ADODB ony for now.
1399 // renamed delete_page to purge_page.
1400 // enable action=edit&version=-1 to force creation of a new version.
1401 // added BABYCART_PATH config
1402 // fixed magiqc in adodb.inc.php
1403 // and some more docs
1404 //
1405 // Revision 1.61  2004/11/30 17:45:53  rurban
1406 // exists_links backend implementation
1407 //
1408 // Revision 1.60  2004/11/28 20:42:18  rurban
1409 // Optimize PearDB _extract_version_data and _extract_page_data.
1410 //
1411 // Revision 1.59  2004/11/27 14:39:05  rurban
1412 // simpified regex search architecture:
1413 //   no db specific node methods anymore,
1414 //   new sql() method for each node
1415 //   parallel to regexp() (which returns pcre)
1416 //   regex types bitmasked (op's not yet)
1417 // new regex=sql
1418 // clarified WikiDB::quote() backend methods:
1419 //   ->quote() adds surrounsing quotes
1420 //   ->qstr() (new method) assumes strings and adds no quotes! (in contrast to ADODB)
1421 //   pear and adodb have now unified quote methods for all generic queries.
1422 //
1423 // Revision 1.58  2004/11/26 18:39:02  rurban
1424 // new regex search parser and SQL backends (90% complete, glob and pcre backends missing)
1425 //
1426 // Revision 1.57  2004/11/25 17:20:51  rurban
1427 // and again a couple of more native db args: backlinks
1428 //
1429 // Revision 1.56  2004/11/23 13:35:48  rurban
1430 // add case_exact search
1431 //
1432 // Revision 1.55  2004/11/21 11:59:26  rurban
1433 // remove final \n to be ob_cache independent
1434 //
1435 // Revision 1.54  2004/11/20 17:49:39  rurban
1436 // add fast exclude support to SQL get_all_pages
1437 //
1438 // Revision 1.53  2004/11/20 17:35:58  rurban
1439 // improved WantedPages SQL backends
1440 // PageList::sortby new 3rd arg valid_fields (override db fields)
1441 // WantedPages sql pager inexact for performance reasons:
1442 //   assume 3 wantedfrom per page, to be correct, no getTotal()
1443 // support exclude argument for get_all_pages, new _sql_set()
1444 //
1445 // Revision 1.52  2004/11/17 20:07:17  rurban
1446 // just whitespace
1447 //
1448 // Revision 1.51  2004/11/15 15:57:37  rurban
1449 // silent cache warning
1450 //
1451 // Revision 1.50  2004/11/10 19:32:23  rurban
1452 // * optimize increaseHitCount, esp. for mysql.
1453 // * prepend dirs to the include_path (phpwiki_dir for faster searches)
1454 // * Pear_DB version logic (awful but needed)
1455 // * fix broken ADODB quote
1456 // * _extract_page_data simplification
1457 //
1458 // Revision 1.49  2004/11/10 15:29:21  rurban
1459 // * requires newer Pear_DB (as the internal one): quote() uses now escapeSimple for strings
1460 // * ACCESS_LOG_SQL: fix cause request not yet initialized
1461 // * WikiDB: moved SQL specific methods upwards
1462 // * new Pear_DB quoting: same as ADODB and as newer Pear_DB.
1463 //   fixes all around: WikiGroup, WikiUserNew SQL methods, SQL logging
1464 //
1465 // Revision 1.48  2004/11/09 17:11:16  rurban
1466 // * revert to the wikidb ref passing. there's no memory abuse there.
1467 // * use new wikidb->_cache->_id_cache[] instead of wikidb->_iwpcache, to effectively
1468 //   store page ids with getPageLinks (GleanDescription) of all existing pages, which
1469 //   are also needed at the rendering for linkExistingWikiWord().
1470 //   pass options to pageiterator.
1471 //   use this cache also for _get_pageid()
1472 //   This saves about 8 SELECT count per page (num all pagelinks).
1473 // * fix passing of all page fields to the pageiterator.
1474 // * fix overlarge session data which got broken with the latest ACCESS_LOG_SQL changes
1475 //
1476 // Revision 1.47  2004/11/06 17:11:42  rurban
1477 // The optimized version doesn't query for pagedata anymore.
1478 //
1479 // Revision 1.46  2004/11/01 10:43:58  rurban
1480 // seperate PassUser methods into seperate dir (memory usage)
1481 // fix WikiUser (old) overlarge data session
1482 // remove wikidb arg from various page class methods, use global ->_dbi instead
1483 // ...
1484 //
1485 // Revision 1.45  2004/10/14 17:19:17  rurban
1486 // allow most_popular sortby arguments
1487 //
1488 // Revision 1.44  2004/09/06 08:33:09  rurban
1489 // force explicit mysql auto-incrementing, atomic version
1490 //
1491 // Revision 1.43  2004/07/10 08:50:24  rurban
1492 // applied patch by Philippe Vanhaesendonck:
1493 //   pass column list to iterators so we can FETCH_NUM in all cases.
1494 //   bind UPDATE pramas for huge pagedata.
1495 //   portable oracle backend
1496 //
1497 // Revision 1.42  2004/07/09 10:06:50  rurban
1498 // Use backend specific sortby and sortable_columns method, to be able to
1499 // select between native (Db backend) and custom (PageList) sorting.
1500 // Fixed PageList::AddPageList (missed the first)
1501 // Added the author/creator.. name to AllPagesBy...
1502 //   display no pages if none matched.
1503 // Improved dba and file sortby().
1504 // Use &$request reference
1505 //
1506 // Revision 1.41  2004/07/08 21:32:35  rurban
1507 // Prevent from more warnings, minor db and sort optimizations
1508 //
1509 // Revision 1.40  2004/07/08 16:56:16  rurban
1510 // use the backendType abstraction
1511 //
1512 // Revision 1.39  2004/07/05 13:56:22  rurban
1513 // sqlite autoincrement fix
1514 //
1515 // Revision 1.38  2004/07/05 12:57:54  rurban
1516 // add mysql timeout
1517 //
1518 // Revision 1.37  2004/07/04 10:24:43  rurban
1519 // forgot the expressions
1520 //
1521 // Revision 1.36  2004/07/03 16:51:06  rurban
1522 // optional DBADMIN_USER:DBADMIN_PASSWD for action=upgrade (if no ALTER permission)
1523 // added atomic mysql REPLACE for PearDB as in ADODB
1524 // fixed _lock_tables typo links => link
1525 // fixes unserialize ADODB bug in line 180
1526 //
1527 // Revision 1.35  2004/06/28 14:45:12  rurban
1528 // fix adodb_sqlite to have the same dsn syntax as pear, use pconnect if requested
1529 //
1530 // Revision 1.34  2004/06/28 14:17:38  rurban
1531 // updated DSN parser from Pear. esp. for sqlite
1532 //
1533 // Revision 1.33  2004/06/27 10:26:02  rurban
1534 // oci8 patch by Philippe Vanhaesendonck + some ADODB notes+fixes
1535 //
1536 // Revision 1.32  2004/06/25 14:15:08  rurban
1537 // reduce memory footprint by caching only requested pagedate content (improving most page iterators)
1538 //
1539 // Revision 1.31  2004/06/16 10:38:59  rurban
1540 // Disallow refernces in calls if the declaration is a reference
1541 // ("allow_call_time_pass_reference clean").
1542 //   PhpWiki is now allow_call_time_pass_reference = Off clean,
1543 //   but several external libraries may not.
1544 //   In detail these libs look to be affected (not tested):
1545 //   * Pear_DB odbc
1546 //   * adodb oracle
1547 //
1548 // Revision 1.30  2004/06/07 19:31:31  rurban
1549 // fixed ADOOB upgrade: listOfFields()
1550 //
1551 // Revision 1.29  2004/05/12 10:49:55  rurban
1552 // require_once fix for those libs which are loaded before FileFinder and
1553 //   its automatic include_path fix, and where require_once doesn't grok
1554 //   dirname(__FILE__) != './lib'
1555 // upgrade fix with PearDB
1556 // navbar.tmpl: remove spaces for IE &nbsp; button alignment
1557 //
1558 // Revision 1.28  2004/05/06 19:26:16  rurban
1559 // improve stability, trying to find the InlineParser endless loop on sf.net
1560 //
1561 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
1562 //
1563 // Revision 1.27  2004/05/06 17:30:38  rurban
1564 // CategoryGroup: oops, dos2unix eol
1565 // improved phpwiki_version:
1566 //   pre -= .0001 (1.3.10pre: 1030.099)
1567 //   -p1 += .001 (1.3.9-p1: 1030.091)
1568 // improved InstallTable for mysql and generic SQL versions and all newer tables so far.
1569 // abstracted more ADODB/PearDB methods for action=upgrade stuff:
1570 //   backend->backendType(), backend->database(),
1571 //   backend->listOfFields(),
1572 //   backend->listOfTables(),
1573 //
1574 // Revision 1.26  2004/04/26 20:44:35  rurban
1575 // locking table specific for better databases
1576 //
1577 // Revision 1.25  2004/04/20 00:06:04  rurban
1578 // themable paging support
1579 //
1580 // Revision 1.24  2004/04/18 01:34:20  rurban
1581 // protect most_popular from sortby=mtime
1582 //
1583 // Revision 1.23  2004/04/16 14:19:39  rurban
1584 // updated ADODB notes
1585 //
1586
1587 // (c-file-style: "gnu")
1588 // Local Variables:
1589 // mode: php
1590 // tab-width: 8
1591 // c-basic-offset: 4
1592 // c-hanging-comment-ender-p: nil
1593 // indent-tabs-mode: nil
1594 // End:
1595 ?>