lib/WikiDB/backend/cvs.php

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