maintenance/dumpTextPass.php

   1 <?php
   2 /**
   3  * Script that postprocesses XML dumps from dumpBackup.php to add page text
   4  *
   5  * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
   6  * http://www.mediawiki.org/
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  *
  23  * @file
  24  * @ingroup Maintenance
  25  */
  26
  27 $originalDir = getcwd();
  28
  29 require_once( dirname( __FILE__ ) . '/commandLine.inc' );
  30 require_once( 'backup.inc' );
  31
  32 /**
  33  * @ingroup Maintenance
  34  */
  35 class TextPassDumper extends BackupDumper {
  36         var $prefetch = null;
  37         var $input = "php://stdin";
  38         var $history = WikiExporter::FULL;
  39         var $fetchCount = 0;
  40         var $prefetchCount = 0;
  41         var $prefetchCountLast = 0;
  42         var $fetchCountLast = 0;
  43
  44         var $failures = 0;
  45         var $maxFailures = 5;
  46         var $failedTextRetrievals = 0;
  47         var $maxConsecutiveFailedTextRetrievals = 200;
  48         var $failureTimeout = 5; // Seconds to sleep after db failure
  49
  50         var $php = "php";
  51         var $spawn = false;
  52         var $spawnProc = false;
  53         var $spawnWrite = false;
  54         var $spawnRead = false;
  55         var $spawnErr = false;
  56
  57         var $xmlwriterobj = false;
  58
  59         // when we spend more than maxTimeAllowed seconds on this run, we continue
  60         // processing until we write out the next complete page, then save output file(s),
  61         // rename it/them and open new one(s)
  62         var $maxTimeAllowed = 0;  // 0 = no limit
  63         var $timeExceeded = false;
  64         var $firstPageWritten = false;
  65         var $lastPageWritten = false;
  66         var $checkpointJustWritten = false;
  67         var $checkpointFiles = array();
  68
  69         function initProgress( $history ) {
  70                 parent::initProgress();
  71                 $this->timeOfCheckpoint = $this->startTime;
  72         }
  73
  74         function dump( $history, $text = WikiExporter::TEXT ) {
  75                 // This shouldn't happen if on console... ;)
  76                 header( 'Content-type: text/html; charset=UTF-8' );
  77
  78                 // Notice messages will foul up your XML output even if they're
  79                 // relatively harmless.
  80                 if ( ini_get( 'display_errors' ) )
  81                         ini_set( 'display_errors', 'stderr' );
  82
  83                 $this->initProgress( $this->history );
  84
  85                 $this->db = $this->backupDb();
  86
  87                 $this->egress = new ExportProgressFilter( $this->sink, $this );
  88
  89                 // it would be nice to do it in the constructor, oh well. need egress set
  90                 $this->finalOptionCheck();
  91
  92                 // we only want this so we know how to close a stream :-P
  93                 $this->xmlwriterobj = new XmlDumpWriter();
  94
  95                 $input = fopen( $this->input, "rt" );
  96                 $result = $this->readDump( $input );
  97
  98                 if ( WikiError::isError( $result ) ) {
  99                         throw new MWException( $result->getMessage() );
 100                 }
 101
 102                 if ( $this->spawnProc ) {
 103                         $this->closeSpawn();
 104                 }
 105
 106                 $this->report( true );
 107         }
 108
 109         function processOption( $opt, $val, $param ) {
 110                 global $IP;
 111                 $url = $this->processFileOpt( $val, $param );
 112
 113                 switch( $opt ) {
 114                 case 'prefetch':
 115                         require_once "$IP/maintenance/backupPrefetch.inc";
 116                         $this->prefetch = new BaseDump( $url );
 117                         break;
 118                 case 'stub':
 119                         $this->input = $url;
 120                         break;
 121                 case 'maxtime':
 122                         $this->maxTimeAllowed = intval($val)*60;
 123                         break;
 124                 case 'checkpointfile':
 125                         $this->checkpointFiles[] = $val;
 126                         break;
 127                 case 'current':
 128                         $this->history = WikiExporter::CURRENT;
 129                         break;
 130                 case 'full':
 131                         $this->history = WikiExporter::FULL;
 132                         break;
 133                 case 'spawn':
 134                         $this->spawn = true;
 135                         if ( $val ) {
 136                                 $this->php = $val;
 137                         }
 138                         break;
 139                 }
 140         }
 141
 142         function processFileOpt( $val, $param ) {
 143                 $fileURIs = explode(';',$param);
 144                 foreach ( $fileURIs as $URI ) {
 145                         switch( $val ) {
 146                                 case "file":
 147                                         $newURI = $URI;
 148                                         break;
 149                                 case "gzip":
 150                                         $newURI = "compress.zlib://$URI";
 151                                         break;
 152                                 case "bzip2":
 153                                         $newURI = "compress.bzip2://$URI";
 154                                         break;
 155                                 case "7zip":
 156                                         $newURI = "mediawiki.compress.7z://$URI";
 157                                         break;
 158                                 default:
 159                                         $newURI = $URI;
 160                         }
 161                         $newFileURIs[] = $newURI;
 162                 }
 163                 $val = implode( ';', $newFileURIs );
 164                 return $val;
 165         }
 166
 167         /**
 168          * Overridden to include prefetch ratio if enabled.
 169          */
 170         function showReport() {
 171                 if ( !$this->prefetch ) {
 172                         return parent::showReport();
 173                 }
 174
 175                 if ( $this->reporting ) {
 176                         $now = wfTimestamp( TS_DB );
 177                         $nowts = wfTime();
 178                         $deltaAll = wfTime() - $this->startTime;
 179                         $deltaPart = wfTime() - $this->lastTime;
 180                         $this->pageCountPart = $this->pageCount - $this->pageCountLast;
 181                         $this->revCountPart = $this->revCount - $this->revCountLast;
 182
 183                         if ( $deltaAll ) {
 184                                 $portion = $this->revCount / $this->maxCount;
 185                                 $eta = $this->startTime + $deltaAll / $portion;
 186                                 $etats = wfTimestamp( TS_DB, intval( $eta ) );
 187                                 if ( $this->fetchCount ) {
 188                                         $fetchRate = 100.0 * $this->prefetchCount / $this->fetchCount;
 189                                 }
 190                                 else {
 191                                         $fetchRate = '-';
 192                                 }
 193                                 $pageRate = $this->pageCount / $deltaAll;
 194                                 $revRate = $this->revCount / $deltaAll;
 195                         } else {
 196                                 $pageRate = '-';
 197                                 $revRate = '-';
 198                                 $etats = '-';
 199                                 $fetchRate = '-';
 200                         }
 201                         if ( $deltaPart ) {
 202                                 if ( $this->fetchCountLast ) {
 203                                         $fetchRatePart = 100.0 * $this->prefetchCountLast / $this->fetchCountLast;
 204                                 }
 205                                 else {
 206                                         $fetchRatePart = '-';
 207                                 }
 208                                 $pageRatePart = $this->pageCountPart / $deltaPart;
 209                                 $revRatePart = $this->revCountPart / $deltaPart;
 210
 211                         } else {
 212                                 $fetchRatePart = '-';
 213                                 $pageRatePart = '-';
 214                                 $revRatePart = '-';
 215                         }
 216                         $this->progress( sprintf( "%s: %s (ID %d) %d pages (%0.1f|%0.1f/sec all|curr), %d revs (%0.1f|%0.1f/sec all|curr), %0.1f%%|%0.1f%% prefetched (all|curr), ETA %s [max %d]",
 217                                         $now, wfWikiID(), $this->ID, $this->pageCount, $pageRate, $pageRatePart, $this->revCount, $revRate, $revRatePart, $fetchRate, $fetchRatePart, $etats, $this->maxCount ) );
 218                         $this->lastTime = $nowts;
 219                         $this->revCountLast = $this->revCount;
 220                         $this->prefetchCountLast = $this->prefetchCount;
 221                         $this->fetchCountLast = $this->fetchCount;
 222                 }
 223         }
 224
 225         function setTimeExceeded() {
 226                 $this->timeExceeded = True;
 227         }
 228
 229         function checkIfTimeExceeded() {
 230                 if ( $this->maxTimeAllowed &&  ( $this->lastTime - $this->timeOfCheckpoint  > $this->maxTimeAllowed ) ) {
 231                         return True;
 232                 }
 233                 return False;
 234         }
 235
 236         function finalOptionCheck() {
 237                 if ( ( $this->checkpointFiles && ! $this->maxTimeAllowed ) ||
 238                         ( $this->maxTimeAllowed && !$this->checkpointFiles ) ) {
 239                         throw new MWException("Options checkpointfile and maxtime must be specified together.\n");
 240                 }
 241                 foreach ($this->checkpointFiles as $checkpointFile) {
 242                         $count = substr_count ( $checkpointFile,"%s" );
 243                         if ( $count != 2 ) {
 244                                 throw new MWException("Option checkpointfile must contain two '%s' for substitution of first and last pageids, count is $count instead, file is $checkpointFile.\n");
 245                         }
 246                 }
 247
 248                 if ( $this->checkpointFiles ) {
 249                         $filenameList = (array)$this->egress->getFilenames();
 250                         if ( count( $filenameList ) != count( $this->checkpointFiles ) ) {
 251                                 throw new MWException("One checkpointfile must be specified for each output option, if maxtime is used.\n");
 252                         }
 253                 }
 254         }
 255
 256         function readDump( $input ) {
 257                 $this->buffer = "";
 258                 $this->openElement = false;
 259                 $this->atStart = true;
 260                 $this->state = "";
 261                 $this->lastName = "";
 262                 $this->thisPage = 0;
 263                 $this->thisRev = 0;
 264
 265                 $parser = xml_parser_create( "UTF-8" );
 266                 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
 267
 268                 xml_set_element_handler( $parser, array( &$this, 'startElement' ), array( &$this, 'endElement' ) );
 269                 xml_set_character_data_handler( $parser, array( &$this, 'characterData' ) );
 270
 271                 $offset = 0; // for context extraction on error reporting
 272                 $bufferSize = 512 * 1024;
 273                 do {
 274                         if ($this->checkIfTimeExceeded()) {
 275                                 $this->setTimeExceeded();
 276                         }
 277                         $chunk = fread( $input, $bufferSize );
 278                         if ( !xml_parse( $parser, $chunk, feof( $input ) ) ) {
 279                                 wfDebug( "TextDumpPass::readDump encountered XML parsing error\n" );
 280                                 return new WikiXmlError( $parser, 'XML import parse failure', $chunk, $offset );
 281                         }
 282                         $offset += strlen( $chunk );
 283                 } while ( $chunk !== false && !feof( $input ) );
 284                 if ($this->maxTimeAllowed) {
 285                         $filenameList = (array)$this->egress->getFilenames();
 286                         // we wrote some stuff after last checkpoint that needs renamed
 287                         if (file_exists($filenameList[0])) {
 288                                 $newFilenames = array();
 289                                 # we might have just written the header and footer and had no
 290                                 # pages or revisions written... perhaps they were all deleted
 291                                 # there's no pageID 0 so we use that. the caller is responsible
 292                                 # for deciding what to do with a file containing only the
 293                                 # siteinfo information and the mw tags.
 294                                 if (! $this->firstPageWritten) {
 295                                         $firstPageID = str_pad(0,9,"0",STR_PAD_LEFT);
 296                                         $lastPageID = str_pad(0,9,"0",STR_PAD_LEFT);
 297                                 }
 298                                 else {
 299                                         $firstPageID = str_pad($this->firstPageWritten,9,"0",STR_PAD_LEFT);
 300                                         $lastPageID = str_pad($this->lastPageWritten,9,"0",STR_PAD_LEFT);
 301                                 }
 302                                 for ( $i = 0; $i < count( $filenameList ); $i++ ) {
 303                                         $checkpointNameFilledIn = sprintf( $this->checkpointFiles[$i], $firstPageID, $lastPageID );
 304                                         $fileinfo = pathinfo($filenameList[$i]);
 305                                         $newFilenames[] = $fileinfo['dirname'] . '/' . $checkpointNameFilledIn;
 306                                 }
 307                                 $this->egress->closeAndRename( $newFilenames );
 308                         }
 309                 }
 310                 xml_parser_free( $parser );
 311
 312                 return true;
 313         }
 314
 315         function getText( $id ) {
 316                 $this->fetchCount++;
 317                 if ( isset( $this->prefetch ) ) {
 318                         $text = $this->prefetch->prefetch( $this->thisPage, $this->thisRev );
 319                         if ( $text !== null ) { // Entry missing from prefetch dump
 320                                 $dbr = wfGetDB( DB_SLAVE );
 321                                 $revID = intval( $this->thisRev );
 322                                 $revLength = $dbr->selectField( 'revision', 'rev_len', array( 'rev_id' => $revID ) );
 323                                 // if length of rev text in file doesn't match length in db, we reload
 324                                 // this avoids carrying forward broken data from previous xml dumps
 325                                 if( strlen( $text ) == $revLength ) {
 326                                         $this->prefetchCount++;
 327                                         return $text;
 328                                 }
 329                         }
 330                 }
 331                 return $this->doGetText( $id );
 332         }
 333
 334         private function doGetText( $id ) {
 335
 336                 $id = intval( $id );
 337                 $this->failures = 0;
 338                 $ex = new MWException( "Graceful storage failure" );
 339                 while (true) {
 340                         if ( $this->spawn ) {
 341                                 if ($this->failures) {
 342                                         // we don't know why it failed, could be the child process
 343                                         // borked, could be db entry busted, could be db server out to lunch,
 344                                         // so cover all bases
 345                                         $this->closeSpawn();
 346                                         $this->openSpawn();
 347                                 }
 348                                 $text =  $this->getTextSpawned( $id );
 349                         } else {
 350                                 $text =  $this->getTextDbSafe( $id );
 351                         }
 352                         if ( $text === false ) {
 353                                 $this->failures++;
 354                                 if ( $this->failures > $this->maxFailures) {
 355                                         $this->progress( "Failed to retrieve revision text for text id ".
 356                                                                          "$id after $this->maxFailures tries, giving up" );
 357                                         // were there so many bad retrievals in a row we want to bail?
 358                                         // at some point we have to declare the dump irretrievably broken
 359                                         $this->failedTextRetrievals++;
 360                                         if ($this->failedTextRetrievals > $this->maxConsecutiveFailedTextRetrievals) {
 361                                                 throw $ex;
 362                                         }
 363                                         else {
 364                                                 // would be nice to return something better to the caller someday,
 365                                                 // log what we know about the failure and about the revision
 366                                                 return("");
 367                                         }
 368                                 } else {
 369                                         $this->progress( "Error $this->failures " .
 370                                                                  "of allowed $this->maxFailures retrieving revision text for text id $id! " .
 371                                                                  "Pausing $this->failureTimeout seconds before retry..." );
 372                                         sleep( $this->failureTimeout );
 373                                 }
 374                         } else {
 375                                 $this->failedTextRetrievals= 0;
 376                                 return( $text );
 377                         }
 378                 }
 379
 380         }
 381
 382         /**
 383          * Fetch a text revision from the database, retrying in case of failure.
 384          * This may survive some transitory errors by reconnecting, but
 385          * may not survive a long-term server outage.
 386          */
 387         private function getTextDbSafe( $id ) {
 388                 while ( true ) {
 389                         try {
 390                                 $text = $this->getTextDb( $id );
 391                         } catch ( DBQueryError $ex ) {
 392                                 $text = false;
 393                         }
 394                         return $text;
 395                 }
 396         }
 397
 398         /**
 399          * May throw a database error if, say, the server dies during query.
 400          */
 401         private function getTextDb( $id ) {
 402                 global $wgContLang;
 403                 $row = $this->db->selectRow( 'text',
 404                         array( 'old_text', 'old_flags' ),
 405                         array( 'old_id' => $id ),
 406                         __METHOD__ );
 407                 $text = Revision::getRevisionText( $row );
 408                 if ( $text === false ) {
 409                         return false;
 410                 }
 411                 $stripped = str_replace( "\r", "", $text );
 412                 $normalized = $wgContLang->normalize( $stripped );
 413                 return $normalized;
 414         }
 415
 416         private function getTextSpawned( $id ) {
 417                 wfSuppressWarnings();
 418                 if ( !$this->spawnProc ) {
 419                         // First time?
 420                         $this->openSpawn();
 421                 }
 422                 $text = $this->getTextSpawnedOnce( $id );
 423                 wfRestoreWarnings();
 424                 return $text;
 425         }
 426
 427         function openSpawn() {
 428                 global $IP;
 429
 430                 $cmd = implode( " ",
 431                         array_map( 'wfEscapeShellArg',
 432                                 array(
 433                                         $this->php,
 434                                         "$IP/maintenance/fetchText.php",
 435                                         '--wiki', wfWikiID() ) ) );
 436                 $spec = array(
 437                         0 => array( "pipe", "r" ),
 438                         1 => array( "pipe", "w" ),
 439                         2 => array( "file", "/dev/null", "a" ) );
 440                 $pipes = array();
 441
 442                 $this->progress( "Spawning database subprocess: $cmd" );
 443                 $this->spawnProc = proc_open( $cmd, $spec, $pipes );
 444                 if ( !$this->spawnProc ) {
 445                         // shit
 446                         $this->progress( "Subprocess spawn failed." );
 447                         return false;
 448                 }
 449                 list(
 450                         $this->spawnWrite, // -> stdin
 451                         $this->spawnRead,  // <- stdout
 452                 ) = $pipes;
 453
 454                 return true;
 455         }
 456
 457         private function closeSpawn() {
 458                 wfSuppressWarnings();
 459                 if ( $this->spawnRead )
 460                         fclose( $this->spawnRead );
 461                 $this->spawnRead = false;
 462                 if ( $this->spawnWrite )
 463                         fclose( $this->spawnWrite );
 464                 $this->spawnWrite = false;
 465                 if ( $this->spawnErr )
 466                         fclose( $this->spawnErr );
 467                 $this->spawnErr = false;
 468                 if ( $this->spawnProc )
 469                         pclose( $this->spawnProc );
 470                 $this->spawnProc = false;
 471                 wfRestoreWarnings();
 472         }
 473
 474         private function getTextSpawnedOnce( $id ) {
 475                 global $wgContLang;
 476
 477                 $ok = fwrite( $this->spawnWrite, "$id\n" );
 478                 // $this->progress( ">> $id" );
 479                 if ( !$ok ) return false;
 480
 481                 $ok = fflush( $this->spawnWrite );
 482                 // $this->progress( ">> [flush]" );
 483                 if ( !$ok ) return false;
 484
 485                 // check that the text id they are sending is the one we asked for
 486                 // this avoids out of sync revision text errors we have encountered in the past
 487                 $newId = fgets( $this->spawnRead );
 488                 if ( $newId === false ) {
 489                         return false;
 490                 }
 491                 if ( $id != intval( $newId ) ) {
 492                         return false;
 493                 }
 494
 495                 $len = fgets( $this->spawnRead );
 496                 // $this->progress( "<< " . trim( $len ) );
 497                 if ( $len === false ) return false;
 498
 499                 $nbytes = intval( $len );
 500                 // actual error, not zero-length text
 501                 if ($nbytes < 0 ) return false;
 502
 503                 $text = "";
 504
 505                 // Subprocess may not send everything at once, we have to loop.
 506                 while ( $nbytes > strlen( $text ) ) {
 507                         $buffer = fread( $this->spawnRead, $nbytes - strlen( $text ) );
 508                         if ( $buffer === false ) break;
 509                         $text .= $buffer;
 510                 }
 511
 512                 $gotbytes = strlen( $text );
 513                 if ( $gotbytes != $nbytes ) {
 514                         $this->progress( "Expected $nbytes bytes from database subprocess, got $gotbytes " );
 515                         return false;
 516                 }
 517
 518                 // Do normalization in the dump thread...
 519                 $stripped = str_replace( "\r", "", $text );
 520                 $normalized = $wgContLang->normalize( $stripped );
 521                 return $normalized;
 522         }
 523
 524         function startElement( $parser, $name, $attribs ) {
 525                 $this->checkpointJustWritten = false;
 526
 527                 $this->clearOpenElement( null );
 528                 $this->lastName = $name;
 529
 530                 if ( $name == 'revision' ) {
 531                         $this->state = $name;
 532                         $this->egress->writeOpenPage( null, $this->buffer );
 533                         $this->buffer = "";
 534                 } elseif ( $name == 'page' ) {
 535                         $this->state = $name;
 536                         if ( $this->atStart ) {
 537                                 $this->egress->writeOpenStream( $this->buffer );
 538                                 $this->buffer = "";
 539                                 $this->atStart = false;
 540                         }
 541                 }
 542
 543                 if ( $name == "text" && isset( $attribs['id'] ) ) {
 544                         $text = $this->getText( $attribs['id'] );
 545                         $this->openElement = array( $name, array( 'xml:space' => 'preserve' ) );
 546                         if ( strlen( $text ) > 0 ) {
 547                                 $this->characterData( $parser, $text );
 548                         }
 549                 } else {
 550                         $this->openElement = array( $name, $attribs );
 551                 }
 552         }
 553
 554         function endElement( $parser, $name ) {
 555                 $this->checkpointJustWritten = false;
 556
 557                 if ( $this->openElement ) {
 558                         $this->clearOpenElement( "" );
 559                 } else {
 560                         $this->buffer .= "</$name>";
 561                 }
 562
 563                 if ( $name == 'revision' ) {
 564                         $this->egress->writeRevision( null, $this->buffer );
 565                         $this->buffer = "";
 566                         $this->thisRev = "";
 567                 } elseif ( $name == 'page' ) {
 568                         if (! $this->firstPageWritten) {
 569                                 $this->firstPageWritten = trim($this->thisPage);
 570                         }
 571                         $this->lastPageWritten = trim($this->thisPage);
 572                         if ($this->timeExceeded) {
 573                                 $this->egress->writeClosePage( $this->buffer );
 574                                 // nasty hack, we can't just write the chardata after the
 575                                 // page tag, it will include leading blanks from the next line
 576                                 $this->egress->sink->write("\n");
 577
 578                                 $this->buffer = $this->xmlwriterobj->closeStream();
 579                                 $this->egress->writeCloseStream( $this->buffer );
 580
 581                                 $this->buffer = "";
 582                                 $this->thisPage = "";
 583                                 // this could be more than one file if we had more than one output arg
 584                                 $checkpointFilenames = array();
 585                                 $filenameList = (array)$this->egress->getFilenames();
 586                                 $newFilenames = array();
 587                                 $firstPageID = str_pad($this->firstPageWritten,9,"0",STR_PAD_LEFT);
 588                                 $lastPageID = str_pad($this->lastPageWritten,9,"0",STR_PAD_LEFT);
 589                                 for ( $i = 0; $i < count( $filenameList ); $i++ ) {
 590                                         $checkpointNameFilledIn = sprintf( $this->checkpointFiles[$i], $firstPageID, $lastPageID );
 591                                         $fileinfo = pathinfo($filenameList[$i]);
 592                                         $newFilenames[] = $fileinfo['dirname'] . '/' . $checkpointNameFilledIn;
 593                                 }
 594                                 $this->egress->closeRenameAndReopen( $newFilenames );
 595                                 $this->buffer = $this->xmlwriterobj->openStream();
 596                                 $this->timeExceeded = false;
 597                                 $this->timeOfCheckpoint = $this->lastTime;
 598                                 $this->firstPageWritten = false;
 599                                 $this->checkpointJustWritten = true;
 600                         }
 601                         else {
 602                                 $this->egress->writeClosePage( $this->buffer );
 603                                 $this->buffer = "";
 604                                 $this->thisPage = "";
 605                         }
 606
 607                 } elseif ( $name == 'mediawiki' ) {
 608                         $this->egress->writeCloseStream( $this->buffer );
 609                         $this->buffer = "";
 610                 }
 611         }
 612
 613         function characterData( $parser, $data ) {
 614                 $this->clearOpenElement( null );
 615                 if ( $this->lastName == "id" ) {
 616                         if ( $this->state == "revision" ) {
 617                                 $this->thisRev .= $data;
 618                         } elseif ( $this->state == "page" ) {
 619                                 $this->thisPage .= $data;
 620                         }
 621                 }
 622                 // have to skip the newline left over from closepagetag line of
 623                 // end of checkpoint files. nasty hack!!
 624                 if ($this->checkpointJustWritten) {
 625                         if ($data[0] == "\n") {
 626                                 $data = substr($data,1);
 627                         }
 628                         $this->checkpointJustWritten = false;
 629                 }
 630                 $this->buffer .= htmlspecialchars( $data );
 631         }
 632
 633         function clearOpenElement( $style ) {
 634                 if ( $this->openElement ) {
 635                         $this->buffer .= Xml::element( $this->openElement[0], $this->openElement[1], $style );
 636                         $this->openElement = false;
 637                 }
 638         }
 639 }
 640
 641
 642 $dumper = new TextPassDumper( $argv );
 643
 644 if ( !isset( $options['help'] ) ) {
 645         $dumper->dump( true );
 646 } else {
 647         $dumper->progress( <<<ENDS
 648 This script postprocesses XML dumps from dumpBackup.php to add
 649 page text which was stubbed out (using --stub).
 650
 651 XML input is accepted on stdin.
 652 XML output is sent to stdout; progress reports are sent to stderr.
 653
 654 Usage: php dumpTextPass.php [<options>]
 655 Options:
 656   --stub=<type>:<file> To load a compressed stub dump instead of stdin
 657   --prefetch=<type>:<file> Use a prior dump file as a text source, to save
 658                           pressure on the database.
 659                           (Requires the XMLReader extension)
 660   --maxtime=<minutes> Write out checkpoint file after this many minutes (writing
 661                   out complete page, closing xml file properly, and opening new one
 662                   with header).  This option requires the checkpointfile option.
 663   --checkpointfile=<filenamepattern> Use this string for checkpoint filenames,
 664                       substituting first pageid written for the first %s (required) and the
 665               last pageid written for the second %s if it exists.
 666   --quiet         Don't dump status reports to stderr.
 667   --report=n  Report position and speed after every n pages processed.
 668                           (Default: 100)
 669   --server=h  Force reading from MySQL server h
 670   --current       Base ETA on number of pages in database instead of all revisions
 671   --spawn         Spawn a subprocess for loading text records
 672   --help      Display this help message
 673 ENDS
 674 );
 675 }
 676
 677