lib/WikiDB/backend.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: backend.php,v 1.6 2004-03-01 13:48:45 rurban Exp $');
   3
   4 /*
   5   Pagedata
   6
   7    maintained by WikiPage
   8     //:latestversion
   9     //:deleted (*)     (Set if latest content is empty.)
  10     //:pagename (*)
  11
  12     hits
  13     is_locked
  14
  15   Versiondata
  16
  17     %content (?should this be here?)
  18     _supplanted : Time version ceased to be the current version
  19
  20     mtime (*)   : Time of version edit.
  21     orig_mtime
  22     is_minor_edit (*)
  23     author      : nominal author
  24     author_id   : authenticated author
  25     summary
  26
  27     //version
  28     //created (*)
  29     //%superceded
  30
  31     //:serial
  32
  33      (types are scalars: strings, ints, bools)
  34 */
  35
  36 /**
  37  * A WikiDB_backend handles the storage and retrieval of data for a WikiDB.
  38  *
  39  * A WikiDB_backend handles the storage and retrieval of data for a WikiDB.
  40  * It does not have to be this way, of course, but the standard WikiDB uses
  41  * a WikiDB_backend.  (Other WikiDB's could be written which use some other
  42  * method to access their underlying data store.)
  43  *
  44  * The interface outlined here seems to work well with both RDBM based
  45  * and flat DBM/hash based methods of data storage.
  46  *
  47  * Though it contains some default implementation of certain methods,
  48  * this is an abstract base class.  It is expected that most effificient
  49  * backends will override nearly all the methods in this class.
  50  *
  51  * @access protected
  52  * @see WikiDB
  53  */
  54 class WikiDB_backend
  55 {
  56     /**
  57      * Get page meta-data from database.
  58      *
  59      * @param $pagename string Page name.
  60      * @return hash
  61      * Returns a hash containing the page meta-data.
  62      * Returns an empty array if there is no meta-data for the requested page.
  63      * Keys which might be present in the hash are:
  64      * <dl>
  65      *  <dt> locked  <dd> If the page is locked.
  66      *  <dt> hits    <dd> The page hit count.
  67      *  <dt> created <dd> Unix time of page creation. (FIXME: Deprecated: I
  68      *                    don't think we need this...)
  69      * </dl>
  70      */
  71     function get_pagedata($pagename) {
  72         trigger_error("virtual", E_USER_ERROR);
  73     }
  74
  75     /**
  76      * Update the page meta-data.
  77      *
  78      * Set page meta-data.
  79      *
  80      * Only meta-data whose keys are preset in $newdata is affected.
  81      *
  82      * For example:
  83      * <pre>
  84      *   $backend->update_pagedata($pagename, array('locked' => 1));
  85      * </pre>
  86      * will set the value of 'locked' to 1 for the specified page, but it
  87      * will not affect the value of 'hits' (or whatever other meta-data
  88      * may have been stored for the page.)
  89      *
  90      * To delete a particular piece of meta-data, set it's value to false.
  91      * <pre>
  92      *   $backend->update_pagedata($pagename, array('locked' => false));
  93      * </pre>
  94      *
  95      * @param $pagename string Page name.
  96      * @param $newdata hash New meta-data.
  97      */
  98     function update_pagedata($pagename, $newdata) {
  99         trigger_error("virtual", E_USER_ERROR);
 100     }
 101
 102
 103     /**
 104      * Get the current version number for a page.
 105      *
 106      * @param $pagename string Page name.
 107      * @return int The latest version number for the page.  Returns zero if
 108      *  no versions of a page exist.
 109      */
 110     function get_latest_version($pagename) {
 111         trigger_error("virtual", E_USER_ERROR);
 112     }
 113
 114     /**
 115      * Get preceding version number.
 116      *
 117      * @param $pagename string Page name.
 118      * @param $version int Find version before this one.
 119      * @return int The version number of the version in the database which
 120      *  immediately preceeds $version.
 121      */
 122     function get_previous_version($pagename, $version) {
 123         trigger_error("virtual", E_USER_ERROR);
 124     }
 125
 126     /**
 127      * Get revision meta-data and content.
 128      *
 129      * @param $pagename string Page name.
 130      * @param $version integer Which version to get.
 131      * @param $want_content boolean
 132      *  Indicates the caller really wants the page content.  If this
 133      *  flag is not set, the backend is free to skip fetching of the
 134      *  page content (as that may be expensive).  If the backend omits
 135      *  the content, the backend might still want to set the value of
 136      *  '%content' to the empty string if it knows there's no content.
 137      *
 138      * @return hash The version data, or false if specified version does not
 139      *    exist.
 140      *
 141      * Some keys which might be present in the $versiondata hash are:
 142      * <dl>
 143      * <dt> %content
 144      *  <dd> This is a pseudo-meta-data element (since it's actually
 145      *       the page data, get it?) containing the page content.
 146      *       If the content was not fetched, this key may not be present.
 147      * </dl>
 148      * For description of other version meta-data see WikiDB_PageRevision::get().
 149      * @see WikiDB_PageRevision::get
 150      */
 151     function get_versiondata($pagename, $version, $want_content = false) {
 152         trigger_error("virtual", E_USER_ERROR);
 153     }
 154
 155     /**
 156      * Delete page from the database.
 157      *
 158      * Delete page (and all it's revisions) from the database.
 159      *
 160      * This should remove all links (from the named page) from
 161      * the link database.
 162      *
 163      * @param $pagename string Page name.
 164      */
 165     function delete_page($pagename) {
 166         trigger_error("virtual", E_USER_ERROR);
 167     }
 168
 169     /**
 170      * Delete an old revision of a page.
 171      *
 172      * Note that one is never allowed to delete the most recent version,
 173      * but that this requirement is enforced by WikiDB not by the backend.
 174      *
 175      * In fact, to be safe, backends should probably allow the deletion of
 176      * the most recent version.
 177      *
 178      * @param $pagename string Page name.
 179      * @param $version integer Version to delete.
 180      */
 181     function delete_versiondata($pagename, $version) {
 182         trigger_error("virtual", E_USER_ERROR);
 183     }
 184
 185     /**
 186      * Create a new page revision.
 187      *
 188      * If the given ($pagename,$version) is already in the database,
 189      * this method completely overwrites any stored data for that version.
 190      *
 191      * @param $pagename string Page name.
 192      * @param $version int New revisions content.
 193      * @param $data hash New revision metadata.
 194      *
 195      * @see get_versiondata
 196      */
 197     function set_versiondata($pagename, $version, $data) {
 198         trigger_error("virtual", E_USER_ERROR);
 199     }
 200
 201     /**
 202      * Update page version meta-data.
 203      *
 204      * If the given ($pagename,$version) is already in the database,
 205      * this method only changes those meta-data values whose keys are
 206      * explicity listed in $newdata.
 207      *
 208      * @param $pagename string Page name.
 209      * @param $version int New revisions content.
 210      * @param $newdata hash New revision metadata.
 211      * @see set_versiondata, get_versiondata
 212      */
 213     function update_versiondata($pagename, $version, $newdata) {
 214         $data = $this->get_versiondata($pagename, $version, true);
 215         if (!$data) {
 216             assert($data);
 217             return;
 218         }
 219         foreach ($newdata as $key => $val) {
 220             if (empty($val))
 221                 unset($data[$key]);
 222             else
 223                 $data[$key] = $val;
 224         }
 225         $this->set_versiondata($pagename, $version, $data);
 226     }
 227
 228     /**
 229      * Set links for page.
 230      *
 231      * @param $pagename string Page name.
 232      *
 233      * @param $links array List of page(names) which page links to.
 234      */
 235     function set_links($pagename, $links) {
 236         trigger_error("virtual", E_USER_ERROR);
 237     }
 238
 239     /**
 240      * Find pages which link to or are linked from a page.
 241      *
 242      * @param $pagename string Page name.
 243      * @param $reversed boolean True to get backlinks.
 244      *
 245      * FIXME: array or iterator?
 246      * @return object A WikiDB_backend_iterator.
 247      */
 248     function get_links($pagename, $reversed) {
 249         //FIXME: implement simple (but slow) link finder.
 250         die("FIXME");
 251     }
 252
 253     /**
 254      * Get all revisions of a page.
 255      *
 256      * @param $pagename string The page name.
 257      * @return object A WikiDB_backend_iterator.
 258      */
 259     function get_all_revisions($pagename) {
 260         include_once('lib/WikiDB/backend/dumb/AllRevisionsIter.php');
 261         return new WikiDB_backend_dumb_AllRevisionsIter($this, $pagename);
 262     }
 263
 264     /**
 265      * Get all pages in the database.
 266      *
 267      * Pages should be returned in alphabetical order if that is
 268      * feasable.
 269      *
 270      * @access protected
 271      *
 272      * @param $include_defaulted boolean
 273      * If set, even pages with no content will be returned
 274      * --- but still only if they have at least one revision (not
 275      * counting the default revision 0) entered in the database.
 276      *
 277      * Normally pages whose current revision has empty content
 278      * are not returned as these pages are considered to be
 279      * non-existing.
 280      *
 281      * @return object A WikiDB_backend_iterator.
 282      */
 283     function get_all_pages($include_defaulted, $orderby) {
 284         trigger_error("virtual", E_USER_ERROR);
 285     }
 286
 287     /**
 288      * Title or full text search.
 289      *
 290      * Pages should be returned in alphabetical order if that is
 291      * feasable.
 292      *
 293      * @access protected
 294      *
 295      * @param $search object A TextSearchQuery object describing what pages
 296      * are to be searched for.
 297      *
 298      * @param $fullsearch boolean If true, a full text search is performed,
 299      *  otherwise a title search is performed.
 300      *
 301      * @return object A WikiDB_backend_iterator.
 302      *
 303      * @see WikiDB::titleSearch
 304      */
 305     function text_search($search = '', $fullsearch = false) {
 306         // This is method implements a simple linear search
 307         // through all the pages in the database.
 308         //
 309         // It is expected that most backends will overload
 310         // method with something more efficient.
 311         include_once('lib/WikiDB/backend/dumb/TextSearchIter.php');
 312         $pages = $this->get_all_pages(false);
 313         return new WikiDB_backend_dumb_TextSearchIter($this, $pages, $search, $fullsearch);
 314     }
 315
 316     /**
 317      * Find pages with highest hit counts.
 318      *
 319      * Find the pages with the highest hit counts.  The pages should
 320      * be returned in reverse order by hit count.
 321      *
 322      * @access protected
 323      * @param $limit integer  No more than this many pages
 324      * @return object A WikiDB_backend_iterator.
 325      */
 326     function most_popular($limit,$sortby = '') {
 327         // This is method fetches all pages, then
 328         // sorts them by hit count.
 329         // (Not very efficient.)
 330         //
 331         // It is expected that most backends will overload
 332         // method with something more efficient.
 333         include_once('lib/WikiDB/backend/dumb/MostPopularIter.php');
 334         $pages = $this->get_all_pages(false,'hits DESC');
 335
 336         return new WikiDB_backend_dumb_MostPopularIter($this, $pages, $limit);
 337     }
 338
 339     /**
 340      * Find recent changes.
 341      *
 342      * @access protected
 343      * @param $params hash See WikiDB::mostRecent for a description
 344      *  of parameters which can be included in this hash.
 345      * @return object A WikiDB_backend_iterator.
 346      * @see WikiDB::mostRecent
 347      */
 348     function most_recent($params) {
 349         // This method is very inefficient and searches through
 350         // all pages for the most recent changes.
 351         //
 352         // It is expected that most backends will overload
 353         // method with something more efficient.
 354         include_once('lib/WikiDB/backend/dumb/MostRecentIter.php');
 355         $pages = $this->get_all_pages(true,'mtime DESC');
 356         return new WikiDB_backend_dumb_MostRecentIter($this, $pages, $params);
 357     }
 358
 359     /**
 360      * Lock backend database.
 361      *
 362      * Calls may be nested.
 363      *
 364      * @param $write_lock boolean Unless this is set to false, a write lock
 365      *     is acquired, otherwise a read lock.  If the backend doesn't support
 366      *     read locking, then it should make a write lock no matter which type
 367      *     of lock was requested.
 368      *
 369      *     All backends <em>should</em> support write locking.
 370      */
 371     function lock($write_lock = true) {
 372     }
 373
 374     /**
 375      * Unlock backend database.
 376      *
 377      * @param $force boolean Normally, the database is not unlocked until
 378      *  unlock() is called as many times as lock() has been.  If $force is
 379      *  set to true, the the database is unconditionally unlocked.
 380      */
 381     function unlock($force = false) {
 382     }
 383
 384
 385     /**
 386      * Close database.
 387      */
 388     function close () {
 389     }
 390
 391     /**
 392      * Synchronize with filesystem.
 393      *
 394      * This should flush all unwritten data to the filesystem.
 395      */
 396     function sync() {
 397     }
 398
 399     /**
 400      * Optimize the database.
 401      */
 402     function optimize() {
 403     }
 404
 405     /**
 406      * Check database integrity.
 407      *
 408      * This should check the validity of the internal structure of the database.
 409      * Errors should be reported via:
 410      * <pre>
 411      *   trigger_error("Message goes here.", E_USER_WARNING);
 412      * </pre>
 413      *
 414      * @return boolean True iff database is in a consistent state.
 415      */
 416     function check() {
 417     }
 418
 419     /**
 420      * Put the database into a consistent state.
 421      *
 422      * This should put the database into a consistent state.
 423      * (I.e. rebuild indexes, etc...)
 424      *
 425      * @return boolean True iff successful.
 426      */
 427     function rebuild() {
 428     }
 429
 430     function _parse_searchwords($search) {
 431         $search = strtolower(trim($search));
 432         if (!$search)
 433             return array(array(),array());
 434
 435         $words = preg_split('/\s+/', $search);
 436         $exclude = array();
 437         foreach ($words as $key => $word) {
 438             if ($word[0] == '-' && $word != '-') {
 439                 $word = substr($word, 1);
 440                 $exclude[] = preg_quote($word);
 441                 unset($words[$key]);
 442             }
 443         }
 444         return array($words, $exclude);
 445     }
 446
 447 };
 448
 449 /**
 450  * Iterator returned by backend methods which (possibly) return
 451  * multiple records.
 452  *
 453  * FIXME: this should be two seperate classes: page_iter and version_iter.
 454  */
 455 class WikiDB_backend_iterator
 456 {
 457     /**
 458      * Get the next record in the interator set.
 459      *
 460      * This returns a hash.  The has may contain the following keys:
 461      * <dl>
 462      * <dt> pagename <dt> (string) the page name
 463      * <dt> version  <dt> (int) the version number
 464      * <dt> pagedata <dt> (hash) page meta-data (as returned from backend::get_pagedata().)
 465      * <dt> versiondata <dt> (hash) page meta-data (as returned from backend::get_versiondata().)
 466      *
 467      * If this is a page iterator, it must contain the 'pagename' entry --- the others
 468      * are optional.
 469      *
 470      * If this is a version iterator, the 'pagename', 'version', <strong>and</strong> 'versiondata'
 471      * entries are mandatory.  ('pagedata' is optional.)
 472      */
 473     function next() {
 474         trigger_error("virtual", E_USER_ERROR);
 475     }
 476
 477     /**
 478      * Release resources held by this iterator.
 479      */
 480     function free() {
 481     }
 482 };
 483
 484 // For emacs users
 485 // Local Variables:
 486 // mode: php
 487 // tab-width: 8
 488 // c-basic-offset: 4
 489 // c-hanging-comment-ender-p: nil
 490 // indent-tabs-mode: nil
 491 // End:
 492
 493 ?>