lib/WikiDB/backend/cvs.php

   1 <?php
   2
   3 /**
   4  * Backend for handling CVS repository.
   5  *
   6  * ASSUMES: that the shell commands 'cvs', 'grep', 'rm', are all located
   7  * ASSUMES: in the path of the server calling this script.
   8  *
   9  * Author: Gerrit Riessen, gerrit.riessen@open-source-consultants.de
  10  */
  11
  12 require_once 'lib/WikiDB/backend.php';
  13 require_once 'lib/ErrorManager.php';
  14
  15 /**
  16  * Constants used by the CVS backend
  17  **/
  18 // these are the parameters defined in db_params
  19 define('CVS_DOC_DIR', 'doc_dir');
  20 define('CVS_REPOSITORY', 'repository');
  21 define('CVS_CHECK_FOR_REPOSITORY', 'check_for_repository');
  22 define('CVS_DEBUG_FILE', 'debug_file');
  23 define('CVS_PAGE_SOURCE', 'pgsrc');
  24 define('CVS_MODULE_NAME', 'module_name');
  25
  26 // these are the things that are defined in the page hash
  27 // CMD == Cvs Meta Data
  28 define('CMD_LAST_MODIFIED', 'lastmodified');
  29 define('CMD_CONTENT', '%content');
  30 define('CMD_CREATED', 'created');
  31 define('CMD_VERSION', 'version');
  32 define('CMD_AUTHOR', 'author');
  33 define('CMD_LINK_ATT', '_links_');
  34
  35 // file names used to store specific information
  36 define('CVS_MP_FILE', '.most_popular');
  37 define('CVS_MR_FILE', '.most_recent');
  38
  39 class WikiDB_backend_cvs
  40     extends WikiDB_backend
  41 {
  42     public $_docDir;
  43     public $_repository;
  44     public $_module_name;
  45     public $_debug_file;
  46
  47     /**
  48      * In the following parameters should be defined in dbparam:
  49      *   . wiki ==> directory where the pages should be stored
  50      *              this is not the CVS repository location
  51      *   . repository ==> local directory where the repository should be
  52      *                    created. This can also be a :pserver: but then
  53      *                    set check_for_repository to false and checkout
  54      *                    the documents beforehand. (This is basically CVSROOT)
  55      *   . check_for_repository ==> boolean flag to indicate whether the
  56      *                              repository should be created, this only
  57      *                              applies to local directories, for pserver
  58      *                              set this to false and check out the
  59      *                              document base beforehand
  60      *   . debug_file ==> file name where debug information should be sent.
  61      *                    If file doesn't exist then it's created, if this
  62      *                    is empty, then debugging is turned off.
  63      *   . pgsrc ==> directory name where the default wiki pages are stored.
  64      *               This is only required if the backend is to create a
  65      *               new CVS repository.
  66      *
  67      * The class also adds a parameter 'module_name' to indicate the name
  68      * of the cvs module that is being used to version the documents. The
  69      * module_name is assumed to be the base name of directory given in
  70      * wiki, e.g. if wiki == '/some/path/to/documents' then module_name
  71      * becomes 'documents' and this module will be created in the CVS
  72      * repository or assumed to exist. If on the other hand the parameter
  73      * already exists, then it is not overwritten.
  74      */
  75     function WikiDB_backend_cvs($dbparam)
  76     {
  77         // setup all the instance values.
  78         $this->_docDir = $dbparam{CVS_DOC_DIR};
  79         $this->_repository = $dbparam{CVS_REPOSITORY};
  80         if (!$dbparam{CVS_MODULE_NAME}) {
  81             $this->_module_name = basename($this->_docDir);
  82             $dbparam{CVS_MODULE_NAME} = $this->_module_name;
  83         } else {
  84             $this->_module_name = $dbparam{CVS_MODULE_NAME};
  85         }
  86         $this->_debug_file = $dbparam{CVS_DEBUG_FILE};
  87
  88         if ($dbparam{CVS_CHECK_FOR_REPOSITORY}
  89             && !(is_dir($this->_repository)
  90                 && is_dir($this->_repository . "/CVSROOT")
  91                 && is_dir($this->_repository . "/" . $this->_module_name))
  92         ) {
  93
  94             $this->_cvsDebug(sprintf("Creating new repository [%s]", $this->_repository));
  95
  96             // doesn't exist, need to create it and the replace the wiki
  97             // document directory.
  98             $this->_mkdir($this->_repository, 0775);
  99
 100             // assume that the repository is a local directory, prefix :local:
 101             if (!ereg("^:local:", $this->_repository)) {
 102                 $this->_repository = ":local:" . $this->_repository;
 103             }
 104
 105             $cmdLine = sprintf("cvs -d \"%s\" init", $this->_repository);
 106             $this->_execCommand($cmdLine, $cmdOutput, true);
 107
 108             $this->_mkdir($this->_docDir, 0775);
 109             $cmdLine = sprintf("cd %s; cvs -d \"%s\" import -m no_message "
 110                     . "%s V R", $this->_docDir, $this->_repository,
 111                 $this->_module_name);
 112             $this->_execCommand($cmdLine, $cmdOutput, true);
 113
 114             // remove the wiki directory and check it out from the
 115             // CVS repository
 116             $cmdLine = sprintf("rm -fr %s; cd %s; cvs -d \"%s\" co %s",
 117                 $this->_docDir, dirname($this->_docDir),
 118                 $this->_repository, $this->_module_name);
 119             $this->_execCommand($cmdLine, $cmdOutput, true);
 120
 121             // add the default pages using the update_pagedata
 122             $metaData = array();
 123             $metaData[$AUTHOR] = "PhpWiki -- CVS Backend";
 124
 125             if (is_dir($dbparam[CVS_PAGE_SOURCE])) {
 126                 $d = opendir($dbparam[CVS_PAGE_SOURCE]);
 127                 while ($entry = readdir($d)) {
 128                     $filename = $dbparam[CVS_PAGE_SOURCE] . "/" . $entry;
 129                     $this->_cvsDebug(sprintf("Found [%s] in [%s]", $entry, $dbparam[CVS_PAGE_SOURCE]));
 130
 131                     if (is_file($filename)) {
 132                         $metaData[CMD_CONTENT] = join('', file($filename));
 133                         $this->update_pagedata($entry, $metaData);
 134                     }
 135                 }
 136                 closedir($d);
 137             }
 138
 139             // ensure that the results of the is_dir are cleared
 140             clearstatcache();
 141         }
 142     }
 143
 144     /**
 145      * Return: metadata about page
 146      */
 147     function get_pagedata($pagename)
 148     {
 149         // the metadata information about a page is stored in the
 150         // CVS directory of the document root in serialized form. The
 151         // file always has the name, i.e. '_$pagename'.
 152         $metaFile = $this->_docDir . "/CVS/_" . $pagename;
 153
 154         if (file_exists($metaFile)) {
 155
 156             $megaHash =
 157                 unserialize(join('', $this->_readFileWithPath($metaFile)));
 158
 159             $filename = $this->_docDir . "/" . $pagename;
 160             if (file_exists($filename)) {
 161                 $megaHash[CMD_CONTENT] = $this->_readFileWithPath($filename);
 162             } else {
 163                 $megaHash[CMD_CONTENT] = "";
 164             }
 165
 166             $this->_updateMostRecent($pagename);
 167             $this->_updateMostPopular($pagename);
 168
 169             return $megaHash;
 170         } else {
 171             return false;
 172         }
 173     }
 174
 175     /**
 176      * This will create a new page if page being requested does not
 177      * exist.
 178      */
 179     function update_pagedata($pagename, $newdata = array())
 180     {
 181         // check argument
 182         if (!is_array($newdata)) {
 183             trigger_error("update_pagedata: Argument 'newdata' was not array",
 184                 E_USER_WARNING);
 185         }
 186
 187         // retrieve the meta data
 188         $metaData = $this->get_pagedata($pagename);
 189
 190         if (!$metaData) {
 191             $this->_cvsDebug("update_pagedata: no meta data found");
 192             // this means that the page does not exist, we need to create
 193             // it.
 194             $metaData = array();
 195
 196             $metaData[CMD_CREATED] = time();
 197             $metaData[CMD_VERSION] = "1";
 198
 199             if (!isset($newdata[CMD_CONTENT])) {
 200                 $metaData[CMD_CONTENT] = "";
 201             } else {
 202                 $metaData[CMD_CONTENT] = $newdata[CMD_CONTENT];
 203             }
 204
 205             // create an empty page ...
 206             $this->_writePage($pagename, $metaData[CMD_CONTENT]);
 207             $this->_addPage($pagename);
 208
 209             // make sure that the page is written and committed a second time
 210             unset($newdata[CMD_CONTENT]);
 211             unset($metaData[CMD_CONTENT]);
 212         }
 213
 214         // change any meta data information
 215         foreach ($newdata as $key => $value) {
 216             if ($value == false || empty($value)) {
 217                 unset($metaData[$key]);
 218             } else {
 219                 $metaData[$key] = $value;
 220             }
 221         }
 222
 223         // update the page data, if required. Use newdata because it could
 224         // be empty and thus unset($metaData[CMD_CONTENT]).
 225         if (isset($newdata[CMD_CONTENT])) {
 226             $this->_writePage($pagename, $newdata[CMD_CONTENT]);
 227         }
 228
 229         // remove any content from the meta data before storing it
 230         unset($metaData[CMD_CONTENT]);
 231         $metaData[CMD_LAST_MODIFIED] = time();
 232
 233         $metaData[CMD_VERSION] = $this->_commitPage($pagename, $metaData);
 234         $this->_writeMetaInfo($pagename, $metaData);
 235     }
 236
 237     function get_latest_version($pagename)
 238     {
 239         $metaData = $this->get_pagedata($pagename);
 240         if ($metaData) {
 241             // the version number is everything after the '1.'
 242             return $metaData[CMD_VERSION];
 243         } else {
 244             $this->_cvsDebug(sprintf("get_latest_versioned FAILED for [%s]", $pagename));
 245             return 0;
 246         }
 247     }
 248
 249     function get_previous_version($pagename, $version)
 250     {
 251         // cvs increments the version numbers, so this is real easy ;-)
 252         return ($version > 0 ? $version - 1 : 0);
 253     }
 254
 255     /**
 256      * the version parameter is assumed to be everything after the '1.'
 257      * in the CVS versioning system.
 258      */
 259     function get_versiondata($pagename, $version, $want_content = false)
 260     {
 261         $this->_cvsDebug("get_versiondata: [$pagename] [$version] [$want_content]");
 262
 263         $filedata = "";
 264         if ($want_content) {
 265             // retrieve the version from the repository
 266             $cmdLine = sprintf("cvs -d \"%s\" co -p -r 1.%d %s/%s 2>&1",
 267                 $this->_repository, $version,
 268                 $this->_module_name, $pagename);
 269             $this->_execCommand($cmdLine, $filedata, true);
 270
 271             // TODO: DEBUG: 5 is a magic number here, depending on the
 272             // TODO: DEBUG: version of cvs used here, 5 might have to
 273             // TODO: DEBUG: change. Basically find a more reliable way of
 274             // TODO: DEBUG: doing this.
 275             // the first 5 lines contain various bits of
 276             // administrative information that can be ignored.
 277             for ($i = 0; $i < 5; $i++) {
 278                 array_shift($filedata);
 279             }
 280         }
 281
 282         /**
 283          * Now obtain the rest of the pagehash information, this is contained
 284          * in the log message for the revision in serialized form.
 285          */
 286         $cmdLine = sprintf("cd %s; cvs log -r1.%d %s", $this->_docDir,
 287             $version, $pagename);
 288         $this->_execCommand($cmdLine, $logdata, true);
 289
 290         // shift log data until we get to the 'revision X.X' line
 291         // FIXME: ensure that we don't enter an endless loop here
 292         while (!ereg("^revision 1.([0-9]+)$", $logdata[0], $revInfo)) {
 293             array_shift($logdata);
 294         }
 295
 296         // serialized hash information now stored in position 2
 297         $rVal = unserialize(_unescape($logdata[2]));
 298
 299         // version information is incorrect
 300         $rVal[CMD_VERSION] = $revInfo[1];
 301         $rVal[CMD_CONTENT] = $filedata;
 302
 303         foreach ($rVal as $key => $value) {
 304             $this->_cvsDebug("$key == [$value]");
 305         }
 306
 307         return $rVal;
 308     }
 309
 310     /**
 311      * See ADODB for a better delete_page(), which can be undone and is seen in RecentChanges.
 312      * See backend.php
 313      */
 314     //function delete_page($pagename) { $this->purge_page($pagename); }
 315
 316     /**
 317      * This returns false if page was not deleted or could not be deleted
 318      * else return true.
 319      */
 320     function purge_page($pagename)
 321     {
 322         $this->_cvsDebug("delete_page [$pagename]");
 323         $filename = $this->_docDir . "/" . $pagename;
 324         $metaFile = $this->_docDir . "/CVS/_" . $pagename;
 325
 326         // obtain a write block before deleting the file
 327         if ($this->_deleteFile($filename) == false) {
 328             return false;
 329         }
 330
 331         $this->_deleteFile($metaFile);
 332
 333         $this->_removePage($pagename);
 334
 335         return true;
 336     }
 337
 338     /**
 339      * For now delete and create a new one.
 340      *
 341      * This returns false if page was not renamed,
 342      * else return true.
 343      */
 344     function rename_page($pagename, $to)
 345     {
 346         $this->_cvsDebug("rename_page [$pagename,$to]");
 347         $data = get_pagedata($pagename);
 348         if (isset($data['pagename']))
 349             $data['pagename'] = $to;
 350         //$version = $this->get_latest_version($pagename);
 351         //$vdata = get_versiondata($pagename, $version, 1);
 352         //$data[CMD_CONTENT] = $vdata[CMD_CONTENT];
 353         $this->delete_page($pagename);
 354         $this->update_pagedata($to, $data);
 355         return true;
 356     }
 357
 358     function delete_versiondata($pagename, $version)
 359     {
 360         // TODO: Not Implemented.
 361         // TODO: This is, for CVS, difficult because it implies removing a
 362         // TODO: revision somewhere in the middle of a revision tree, and
 363         // TODO: this is basically not possible!
 364         trigger_error("delete_versiondata: Not Implemented", E_USER_WARNING);
 365     }
 366
 367     function set_versiondata($pagename, $version, $data)
 368     {
 369         // TODO: Not Implemented.
 370         // TODO: requires changing the log(commit) message for a particular
 371         // TODO: version and this can't be done??? (You can edit the repository
 372         // TODO: file directly but i don't know of a way of doing it via
 373         // TODO: the cvs tools).
 374         trigger_error("set_versiondata: Not Implemented", E_USER_WARNING);
 375     }
 376
 377     function update_versiondata($pagename, $version, $newdata)
 378     {
 379         // TODO: same problem as set_versiondata
 380         trigger_error("set_versiondata: Not Implemented", E_USER_WARNING);
 381     }
 382
 383     function set_links($pagename, $links)
 384     {
 385         // TODO: needs to be tested ....
 386         $megaHash = get_pagedata($pagename);
 387         $megaHash[CMD_LINK_ATT] = $links;
 388         $this->_writeMetaInfo($pagename, $megaHash);
 389     }
 390
 391     function get_links($pagename, $reversed = true, $include_empty = false,
 392                        $sortby = '', $limit = '', $exclude = '')
 393     {
 394         // TODO: ignores the $reversed argument and returns
 395         // TODO: the value of _links_ attribute of the meta information
 396         // TODO: to implement a reversed version, i guess, we going to
 397         // TODO: need to do a grep on all files for the pagename in
 398         // TODO: in question and return all those page names that contained
 399         // TODO: the required pagename!
 400         $megaHash = get_pagedata($pagename);
 401         return $megaHash[CMD_LINK_ATT];
 402     }
 403
 404     /* function get_all_revisions($pagename) {
 405         // TODO: should replace this with something more efficient
 406         include_once 'lib/WikiDB/backend/dumb/AllRevisionsIter.php';
 407         return new WikiDB_backend_dumb_AllRevisionsIter($this, $pagename);
 408     } */
 409
 410     function get_all_pages($include_empty = false, $sortby = '', $limit = '')
 411     {
 412         // FIXME: this ignores the parameters.
 413         return new Cvs_Backend_Array_Iterator(
 414             $this->_getAllFileNamesInDir($this->_docDir));
 415     }
 416
 417     function text_search($search, $fullsearch = false, $orderby = false, $limit = '', $exclude = '')
 418     {
 419         if ($fullsearch) {
 420             $iter = new Cvs_Backend_Full_Search_Iterator(
 421                 $this->_getAllFileNamesInDir($this->_docDir),
 422                 $search,
 423                 $this->_docDir);
 424             $iter->stoplisted =& $search->stoplisted;
 425             return $iter;
 426         } else {
 427             return new Cvs_Backend_Title_Search_Iterator(
 428                 $this->_getAllFileNamesInDir($this->_docDir),
 429                 $search);
 430         }
 431     }
 432
 433     function most_popular($limit, $sortby = '')
 434     {
 435         // TODO: needs to be tested ...
 436         $mp = $this->_getMostPopular();
 437         if ($limit < 0) {
 438             asort($mp, SORT_NUMERIC);
 439             $limit = -$limit;
 440         } else {
 441             arsort($mp, SORT_NUMERIC);
 442         }
 443         $returnVal = array();
 444
 445         while ((list($key, $val) = each($a)) && $limit > 0) {
 446             $returnVal[] = $key;
 447             $limit--;
 448         }
 449         return $returnVal;
 450     }
 451
 452     /**
 453      * This only accepts the 'since' and 'limit' attributes, everything
 454      * else is ignored.
 455      */
 456     function most_recent($params)
 457     {
 458         // TODO: needs to be tested ...
 459         // most recent are those pages with the highest time value ...
 460         $mr = $this->_getMostRecent();
 461         $rev = false;
 462         $returnVal = array();
 463         if (isset($params['limit'])) {
 464             $limit = $params['limit'];
 465             $rev = $limit < 0;
 466         }
 467         if ($rev) {
 468             arsort($mr, SORT_NUMERIC);
 469         } else {
 470             asort($mr, SORT_NUMERIC);
 471         }
 472         if (isset($limit)) {
 473             while ((list($key, $val) = each($a)) && $limit > 0) {
 474                 $returnVal[] = $key;
 475                 $limit--;
 476             }
 477         } elseif (isset($params['since'])) {
 478             while ((list($key, $val) = each($a))) {
 479
 480                 if ($val > $params['since']) {
 481                     $returnVal[] = $key;
 482                 }
 483             }
 484         }
 485
 486         return new Cvs_Backend_Array_Iterator($returnVal);
 487     }
 488
 489     function lock($write_lock = true)
 490     {
 491         // TODO: to be implemented
 492         trigger_error("lock: Not Implemented", E_USER_WARNING);
 493     }
 494
 495     function unlock($force = false)
 496     {
 497         // TODO: to be implemented
 498         trigger_error("unlock: Not Implemented", E_USER_WARNING);
 499     }
 500
 501     function close()
 502     {
 503     }
 504
 505     function sync()
 506     {
 507     }
 508
 509     function optimize()
 510     {
 511     }
 512
 513     /**
 514      * What we do here is take a listing of the documents directory and
 515      * check that each page has metadata file. If not, then a metadata
 516      * file is created for the page.
 517      *
 518      * This can happen if rebuild() was called and someone has added
 519      * files to the CVS repository not via PhpWiki. These files are
 520      * added to the document directory but without any metadata files.
 521      */
 522     function check()
 523     {
 524         // TODO:
 525         // TODO: test this .... i.e. add test to unit test file.
 526         // TODO:
 527         $page_names = $this->_getAllFileNamesInDir($this->_docDir);
 528         $meta_names = $this->_getAllFileNamesInDir($this->_docDir . "/CVS");
 529
 530         array_walk($meta_names, '_strip_leading_underscore');
 531         reset($meta_names);
 532         $no_meta_files = array_diff($page_names, $meta_names);
 533
 534         array_walk($no_meta_files, '_create_meta_file', $this);
 535
 536         return true;
 537     }
 538
 539     /**
 540      * Do an update of the CVS repository
 541      */
 542     function rebuild()
 543     {
 544         // TODO:
 545         // TODO: test this .... i.e. add test to unit test file.
 546         // TODO:
 547         $cmdLine = sprintf("cd %s; cvs update -d 2>&1", $this->_docDir);
 548         $this->_execCommand($cmdLine, $cmdOutput, true);
 549         return true;
 550     }
 551
 552     //
 553     // ..-.-..-.-..-.-.. .--..-......-.--. --.-....----.....
 554     // The rest are all internal methods, not to be used
 555     // directly.
 556     // ..-.-..-.-..-.-.. .--..-......-.--. --.-....----.....
 557     //
 558     function _create_meta_file($page_name, $key, &$backend)
 559     {
 560         // this is used as part of an array walk and therefore takes
 561         // the backend argument
 562         $backend->_cvsDebug(sprintf("Creating meta file for [%s]", $page_name));
 563         $backend->update_pagedata($page_name, array());
 564     }
 565
 566     function _strip_leading_underscore(&$item)
 567     {
 568         $item = ereg_replace("^_", "", $item);
 569     }
 570
 571     /**
 572      * update the most popular information by incrementing the count
 573      * for the following page. If the page was not defined, it is entered
 574      * with a value of 1.
 575      */
 576     function _updateMostPopular($pagename)
 577     {
 578         $mp = $this->_getMostPopular();
 579         if (isset($mp[$pagename])) {
 580             $mp[$pagename]++;
 581         } else {
 582             $mp[$pagename] = 1;
 583         }
 584         $this->_writeFileWithPath($this->_docDir . "/CVS/" . CVS_MP_FILE,
 585             serialize($mp));
 586     }
 587
 588     /**
 589      * Returns an array containing the most popular information. This
 590      * creates the most popular file if it does not exist.
 591      */
 592     function _getMostPopular()
 593     {
 594         $mostPopular = $this->_docDir . "/CVS/" . CVS_MP_FILE;
 595         if (!file_exists($mostPopular)) {
 596             $this->_writeFileWithPath($mostPopular, serialize(array()));
 597         }
 598         return unserialize(join('', $this->_readFileWithPath($mostPopular)));
 599     }
 600
 601     function _getMostRecent()
 602     {
 603         $mostRecent = $this->_docDir . "/CVS/" . CVS_MR_FILE;
 604         if (!file_exists($mostRecent)) {
 605             $this->_writeFileWithPath($mostRecent, serialize(array()));
 606         }
 607         return unserialize(join('', $this->_readFileWithPath($mostRecent)));
 608     }
 609
 610     function _updateMostRecent($pagename)
 611     {
 612         $mr = $this->_getMostRecent();
 613         $mr[$pagename] = time();
 614         $this->_writeFileWithPath($this->_docDir . "/CVS/" . CVS_MR_FILE,
 615             serialize($mr));
 616     }
 617
 618     function _writeMetaInfo($pagename, $hashInfo)
 619     {
 620         $this->_writeFileWithPath($this->_docDir . "/CVS/_" . $pagename,
 621             serialize($hashInfo));
 622     }
 623
 624     function _writePage($pagename, $content)
 625     {
 626         $this->_writeFileWithPath($this->_docDir . "/" . $pagename, $content);
 627     }
 628
 629     function _removePage($pagename)
 630     {
 631         $cmdLine = sprintf("cd %s; cvs remove %s 2>&1; cvs commit -m '%s' "
 632                 . "%s 2>&1", $this->_docDir, $pagename,
 633             "remove page", $pagename);
 634
 635         $this->_execCommand($cmdLine, $cmdRemoveOutput, true);
 636     }
 637
 638     /**
 639      * this returns the new version number of the file.
 640      */
 641     function _commitPage($pagename, &$meta_data)
 642     {
 643         $cmdLine = sprintf("cd %s; cvs commit -m \"%s\" %s 2>&1",
 644             $this->_docDir,
 645             escapeshellcmd(serialize($meta_data)),
 646             $pagename);
 647         $this->_execCommand($cmdLine, $cmdOutput, true);
 648
 649         $cmdOutput = implode("\n", $cmdOutput);
 650         $revInfo = array();
 651         ereg("\nnew revision: 1[.]([0-9]+); previous revision: ", $cmdOutput,
 652             $revInfo);
 653
 654         $this->_cvsDebug("CP: revInfo 0: $revInfo[0]");
 655         $this->_cvsDebug("CP: $cmdOutput");
 656         if (isset($revInfo[1])) {
 657             $this->_cvsDebug("CP: got revision information");
 658             return $revInfo[1];
 659         } else {
 660             ereg("\ninitial revision: 1[.]([0-9]+)", $cmdOutput, $revInfo);
 661             if (isset($revInfo[1])) {
 662                 $this->_cvsDebug("CP: is initial release");
 663                 return 1;
 664             }
 665             $this->_cvsDebug("CP: returning old version");
 666             return $meta_data[CMD_VERSION];
 667         }
 668     }
 669
 670     function _addPage($pagename)
 671     {
 672         // TODO: need to add a check for the mimetype so that binary
 673         // TODO: files are added as binary files
 674         $cmdLine = sprintf("cd %s; cvs add %s 2>&1", $this->_docDir,
 675             $pagename);
 676         $this->_execCommand($cmdLine, $cmdAddOutput, true);
 677     }
 678
 679     /**
 680      * Returns an array containing all the names of files contained
 681      * in a particular directory. The list is sorted according the
 682      * string representation of the filenames.
 683      */
 684     function _getAllFileNamesInDir($dirName)
 685     {
 686         $namelist = array();
 687         $d = opendir($dirName);
 688         while ($entry = readdir($d)) {
 689             $namelist[] = $entry;
 690         }
 691         closedir($d);
 692         sort($namelist, SORT_STRING);
 693         return $namelist;
 694     }
 695
 696     /**
 697      * Recursively create all directories.
 698      */
 699     function _mkdir($path, $mode)
 700     {
 701         $directoryName = dirname($path);
 702         if ($directoryName != "/" && $directoryName != "\\"
 703             && !is_dir($directoryName) && $directoryName != ""
 704         ) {
 705             $rVal = $this->_mkdir($directoryName, $mode);
 706         } else {
 707             $rVal = true;
 708         }
 709
 710         return ($rVal && @mkdir($path, $mode));
 711     }
 712
 713     /**
 714      * Recursively create all directories and then the file.
 715      */
 716     function _createFile($path, $mode)
 717     {
 718         $this->_mkdir(dirname($path), $mode);
 719         touch($path);
 720         chmod($path, $mode);
 721     }
 722
 723     /**
 724      * The lord giveth, and the lord taketh.
 725      */
 726     function _deleteFile($filename)
 727     {
 728         if ($fd = fopen($filename, 'a')) {
 729
 730             $locked = flock($fd, 2); // Exclusive blocking lock
 731
 732             if (!$locked) {
 733                 $this->_cvsError("Unable to delete file, lock was not obtained.",
 734                     __LINE__, $filename, EM_NOTICE_ERRORS);
 735             }
 736
 737             if (($rVal = unlink($filename)) != 0) {
 738                 $this->_cvsDebug("[$filename] --> Unlink returned [$rVal]");
 739             }
 740
 741             return $rVal;
 742         } else {
 743             $this->_cvsError("deleteFile: Unable to open file",
 744                 __LINE__, $filename, EM_NOTICE_ERRORS);
 745             return false;
 746         }
 747     }
 748
 749     /**
 750      * Called when something happened that causes the CVS backend to
 751      * fail.
 752      */
 753     function _cvsError($msg = "no message",
 754                        $errline = 0,
 755                        $errfile = "lib/WikiDB/backend/cvs.php",
 756                        $errno = EM_FATAL_ERRORS)
 757     {
 758         $err = new PhpError($errno, "[CVS(be)]: " . $msg, $errfile, $errline);
 759         // send error to the debug routine
 760         $this->_cvsDebug($err->asXML());
 761         // send the error to the error manager
 762         $GLOBALS['ErrorManager']->handleError($err);
 763     }
 764
 765     /**
 766      * Debug function specifically for the CVS database functions.
 767      * Can be deactived by setting the WikiDB['debug_file'] to ""
 768      */
 769     function _cvsDebug($msg)
 770     {
 771         if ($this->_debug_file == "") {
 772             return;
 773         }
 774
 775         if (!file_exists($this->_debug_file)) {
 776             $this->_createFile($this->_debug_file, 0755);
 777         }
 778
 779         if ($fdlock = @fopen($this->_debug_file, 'a')) {
 780             $locked = flock($fdlock, 2);
 781             if (!$locked) {
 782                 fclose($fdlock);
 783                 return;
 784             }
 785
 786             $fdappend = @fopen($this->_debug_file, 'a');
 787             fwrite($fdappend, ($msg . "\n"));
 788             fclose($fdappend);
 789             fclose($fdlock);
 790         } else {
 791             // TODO: this should be replaced ...
 792             printf("unable to locate/open [%s], turning debug off\n", $filename);
 793             $this->_debug_file = "";
 794         }
 795     }
 796
 797     /**
 798      * Execute a command and potentially exit if the flag exitOnNonZero is
 799      * set to true and the return value was nonZero
 800      */
 801     function _execCommand($cmdLine, &$cmdOutput, $exitOnNonZero)
 802     {
 803         $this->_cvsDebug(sprintf("Preparing to execute [%s]", $cmdLine));
 804         exec($cmdLine, $cmdOutput, $cmdReturnVal);
 805         if ($exitOnNonZero && ($cmdReturnVal != 0)) {
 806             $this->_cvsDebug(sprintf("Command failed [%s], Output: ", $cmdLine) . "[" .
 807                 join("\n", $cmdOutput) . "]");
 808             $this->_cvsError(sprintf("Command failed [%s], Return value: %s", $cmdLine, $cmdReturnVal),
 809                 __LINE__);
 810         }
 811         $this->_cvsDebug("Done execution [" . join("\n", $cmdOutput) . "]");
 812
 813         return $cmdReturnVal;
 814     }
 815
 816     /**
 817      * Read locks a file, reads it, and returns it contents
 818      */
 819     function _readFileWithPath($filename)
 820     {
 821         if ($fd = @fopen($filename, "r")) {
 822             $locked = flock($fd, 1); // read lock
 823             if (!$locked) {
 824                 fclose($fd);
 825                 $this->_cvsError("Unable to obtain read lock.", __LINE__);
 826             }
 827
 828             $content = file($filename);
 829             fclose($fd);
 830             return $content;
 831         } else {
 832             $this->_cvsError(sprintf("Unable to open file '%s' for reading", $filename),
 833                 __LINE__);
 834             return false;
 835         }
 836     }
 837
 838     /**
 839      * Either replace the contents of an existing file or create a
 840      * new file in the particular store using the page name as the
 841      * file name.
 842      *
 843      * Nothing is returned, might be useful to return something ;-)
 844      */
 845     function _writeFileWithPath($filename, $contents)
 846     {
 847         // TODO: $contents should probably be a reference parameter ...
 848         if ($fd = fopen($filename, 'a')) {
 849             $locked = flock($fd, 2); // Exclusive blocking lock
 850             if (!$locked) {
 851                 $this->_cvsError("Timeout while obtaining lock.", __LINE__);
 852             }
 853
 854             // Second filehandle -- we use this to write the contents
 855             $fdsafe = fopen($filename, 'w');
 856             fwrite($fdsafe, $contents);
 857             fclose($fdsafe);
 858             fclose($fd);
 859         } else {
 860             $this->_cvsError(sprintf("Could not open file '%s' for writing", $filename),
 861                 __LINE__);
 862         }
 863     }
 864
 865     /**
 866      * Copy the contents of the source directory to the destination directory.
 867      */
 868     function _copyFilesFromDirectory($src, $dest)
 869     {
 870         $this->_cvsDebug(sprintf("Copying from [%s] to [%s]", $src, $dest));
 871
 872         if (is_dir($src) && is_dir($dest)) {
 873             $this->_cvsDebug("Copying ");
 874             $d = opendir($src);
 875             while ($entry = readdir($d)) {
 876                 if (is_file($src . "/" . $entry)
 877                     && copy($src . "/" . $entry, $dest . "/" . $entry)
 878                 ) {
 879                     $this->_cvsDebug(sprintf("Copied to [%s]", "$dest/$entry"));
 880                 } else {
 881                     $this->_cvsDebug(sprintf("Failed to copy [%s]", "$src/$entry"));
 882                 }
 883             }
 884             closedir($d);
 885             return true;
 886         } else {
 887             $this->_cvsDebug("Not copying");
 888             return false;
 889         }
 890     }
 891
 892     /**
 893      * Unescape a string value. Normally this comes from doing an
 894      * escapeshellcmd. This converts the following:
 895      *    \{ --> {
 896      *    \} --> }
 897      *    \; --> ;
 898      *    \" --> "
 899      */
 900     function _unescape($val)
 901     {
 902         $val = str_replace("\\{", "{", $val);
 903         $val = str_replace("\\}", "}", $val);
 904         $val = str_replace("\\;", ";", $val);
 905         $val = str_replace("\\\"", "\"", $val);
 906
 907         return $val;
 908     }
 909
 910     /**
 911      * Function for removing the newlines from the ends of the
 912      * file data returned from file(..). This is used in retrievePage
 913      */
 914     function _strip_newlines(&$item, $key)
 915     {
 916         $item = ereg_replace("\n$", "", $item);
 917     }
 918
 919 } /* End of WikiDB_backend_cvs class */
 920
 921 /**
 922  * Generic iterator for stepping through an array of values.
 923  */
 924 class Cvs_Backend_Array_Iterator
 925     extends WikiDB_backend_iterator
 926 {
 927     public $_array;
 928
 929     function Cvs_Backend_Iterator($arrayValue = Array())
 930     {
 931         $this->_array = $arrayValue;
 932     }
 933
 934     function next()
 935     {
 936         while (($rVal = array_pop($this->_array)) != NULL) {
 937             return $rVal;
 938         }
 939         return false;
 940     }
 941
 942     function count()
 943     {
 944         return count($this->_array);
 945     }
 946
 947     function free()
 948     {
 949         unset($this->_array);
 950     }
 951 }
 952
 953 class Cvs_Backend_Full_Search_Iterator
 954     extends Cvs_Backend_Array_Iterator
 955 {
 956     public $_searchString = '';
 957     public $_docDir = "";
 958
 959     function Cvs_Backend_Title_Search_Iterator($arrayValue = Array(),
 960                                                $searchString = "",
 961                                                $documentDir = ".")
 962     {
 963         $this->Cvs_Backend_Array_Iterator($arrayValue);
 964         $_searchString = $searchString;
 965         $_docDir = $documentDir;
 966     }
 967
 968     function next()
 969     {
 970         do {
 971             $pageName = Cvs_Backend_Array_Iterator::next();
 972         } while (!$this->_searchFile($_searchString,
 973             $_docDir . "/" . $pageName));
 974
 975         return $pageName;
 976     }
 977
 978     /**
 979      * Does nothing more than a grep and search the entire contents
 980      * of the given file. Returns TRUE of the searchstring was found,
 981      * false if the search string wasn't find or the file was a directory
 982      * or could not be read.
 983      */
 984     function _searchFile($searchString, $fileName)
 985     {
 986         // TODO: using grep here, it might make more sense to use
 987         // TODO: some sort of inbuilt/language specific method for
 988         // TODO: searching files.
 989         $cmdLine = sprintf("grep -E -i '%s' %s > /dev/null 2>&1",
 990             $searchString, $fileName);
 991
 992         return (WikiDB_backend_cvs::_execCommand($cmdLine, $cmdOutput,
 993             false) == 0);
 994     }
 995 }
 996
 997 /**
 998  * Iterator used for doing a title search.
 999  */
1000 class Cvs_Backend_Title_Search_Iterator
1001     extends Cvs_Backend_Array_Iterator
1002 {
1003     public $_searchString = '';
1004
1005     function Cvs_Backend_Title_Search_Iterator($arrayValue = Array(),
1006                                                $searchString = "")
1007     {
1008         $this->Cvs_Backend_Array_Iterator($arrayValue);
1009         $_searchString = $searchString;
1010     }
1011
1012     function next()
1013     {
1014         do {
1015             $pageName = Cvs_Backend_Array_Iterator::next();
1016         } while (!eregi($this->_searchString, $pageName));
1017
1018         return $pageName;
1019     }
1020 }
1021
1022 // Local Variables:
1023 // mode: php
1024 // tab-width: 8
1025 // c-basic-offset: 4
1026 // c-hanging-comment-ender-p: nil
1027 // indent-tabs-mode: nil
1028 // End: