X-Git-Url: https://git.cyclocoop.org/?a=blobdiff_plain;f=maintenance%2FdumpTextPass.php;h=41a7a687435292c1e6e3e76dbbb20d5906b294d5;hb=b41b2194669874092fc09a9c9002645a94a8df00;hp=3687694557c337326c3afe35509197e1edd5b8cd;hpb=50e2405a030a8055a56851b956f06a3ec0a0a461;p=lhc%2Fweb%2Fwiklou.git

diff --git a/maintenance/dumpTextPass.php b/maintenance/dumpTextPass.php
index 3687694557..41a7a68743 100644
--- a/maintenance/dumpTextPass.php
+++ b/maintenance/dumpTextPass.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Script that postprocesses XML dumps from dumpBackup.php to add page text
+ *
  * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
  * http://www.mediawiki.org/
  *
@@ -25,450 +27,13 @@
 $originalDir = getcwd();
 
 require_once( dirname( __FILE__ ) . '/commandLine.inc' );
-require_once( 'backup.inc' );
-
-/**
- * @ingroup Maintenance
- */
-class TextPassDumper extends BackupDumper {
-	var $prefetch = null;
-	var $input = "php://stdin";
-	var $history = WikiExporter::FULL;
-	var $fetchCount = 0;
-	var $prefetchCount = 0;
-
-	var $failures = 0;
-	var $maxFailures = 5;
-	var $failedTextRetrievals = 0;
-	var $maxConsecutiveFailedTextRetrievals = 200;
-	var $failureTimeout = 5; // Seconds to sleep after db failure
-
-	var $php = "php";
-	var $spawn = false;
-	var $spawnProc = false;
-	var $spawnWrite = false;
-	var $spawnRead = false;
-	var $spawnErr = false;
-
-	function dump() {
-		# This shouldn't happen if on console... ;)
-		header( 'Content-type: text/html; charset=UTF-8' );
-
-		# Notice messages will foul up your XML output even if they're
-		# relatively harmless.
-		if ( ini_get( 'display_errors' ) )
-			ini_set( 'display_errors', 'stderr' );
-
-		$this->initProgress( $this->history );
-
-		$this->db = $this->backupDb();
-
-		$this->egress = new ExportProgressFilter( $this->sink, $this );
-
-		$input = fopen( $this->input, "rt" );
-		$result = $this->readDump( $input );
-
-		if ( WikiError::isError( $result ) ) {
-			wfDie( $result->getMessage() );
-		}
-
-		if ( $this->spawnProc ) {
-			$this->closeSpawn();
-		}
-
-		$this->report( true );
-	}
-
-	function processOption( $opt, $val, $param ) {
-		global $IP;
-		$url = $this->processFileOpt( $val, $param );
-
-		switch( $opt ) {
-		case 'prefetch':
-			require_once "$IP/maintenance/backupPrefetch.inc";
-			$this->prefetch = new BaseDump( $url );
-			break;
-		case 'stub':
-			$this->input = $url;
-			break;
-		case 'current':
-			$this->history = WikiExporter::CURRENT;
-			break;
-		case 'full':
-			$this->history = WikiExporter::FULL;
-			break;
-		case 'spawn':
-			$this->spawn = true;
-			if ( $val ) {
-				$this->php = $val;
-			}
-			break;
-		}
-	}
-
-	function processFileOpt( $val, $param ) {
-		switch( $val ) {
-		case "file":
-			return $param;
-		case "gzip":
-			return "compress.zlib://$param";
-		case "bzip2":
-			return "compress.bzip2://$param";
-		case "7zip":
-			return "mediawiki.compress.7z://$param";
-		default:
-			return $val;
-		}
-	}
-
-	/**
-	 * Overridden to include prefetch ratio if enabled.
-	 */
-	function showReport() {
-		if ( !$this->prefetch ) {
-			return parent::showReport();
-		}
-
-		if ( $this->reporting ) {
-			$delta = wfTime() - $this->startTime;
-			$now = wfTimestamp( TS_DB );
-			if ( $delta ) {
-				$rate = $this->pageCount / $delta;
-				$revrate = $this->revCount / $delta;
-				$portion = $this->revCount / $this->maxCount;
-				$eta = $this->startTime + $delta / $portion;
-				$etats = wfTimestamp( TS_DB, intval( $eta ) );
-				$fetchrate = 100.0 * $this->prefetchCount / $this->fetchCount;
-			} else {
-				$rate = '-';
-				$revrate = '-';
-				$etats = '-';
-				$fetchrate = '-';
-			}
-			$this->progress( sprintf( "%s: %s %d pages (%0.3f/sec), %d revs (%0.3f/sec), %0.1f%% prefetched, ETA %s [max %d]",
-				$now, wfWikiID(), $this->pageCount, $rate, $this->revCount, $revrate, $fetchrate, $etats, $this->maxCount ) );
-		}
-	}
-
-	function readDump( $input ) {
-		$this->buffer = "";
-		$this->openElement = false;
-		$this->atStart = true;
-		$this->state = "";
-		$this->lastName = "";
-		$this->thisPage = 0;
-		$this->thisRev = 0;
-
-		$parser = xml_parser_create( "UTF-8" );
-		xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
-
-		xml_set_element_handler( $parser, array( &$this, 'startElement' ), array( &$this, 'endElement' ) );
-		xml_set_character_data_handler( $parser, array( &$this, 'characterData' ) );
-
-		$offset = 0; // for context extraction on error reporting
-		$bufferSize = 512 * 1024;
-		do {
-			$chunk = fread( $input, $bufferSize );
-			if ( !xml_parse( $parser, $chunk, feof( $input ) ) ) {
-				wfDebug( "TextDumpPass::readDump encountered XML parsing error\n" );
-				return new WikiXmlError( $parser, 'XML import parse failure', $chunk, $offset );
-			}
-			$offset += strlen( $chunk );
-		} while ( $chunk !== false && !feof( $input ) );
-		xml_parser_free( $parser );
-
-		return true;
-	}
-
-	function getText( $id ) {
-		$this->fetchCount++;
-		if ( isset( $this->prefetch ) ) {
-			$text = $this->prefetch->prefetch( $this->thisPage, $this->thisRev );
-			if ( $text === null ) {
-				// Entry missing from prefetch dump
-			} elseif ( $text === "" ) {
-				// Blank entries may indicate that the prior dump was broken.
-				// To be safe, reload it.
-			} else {
-				$dbr = wfGetDB( DB_SLAVE );
-				$revID = intval($this->thisRev);
-				$revLength = $dbr->selectField( 'revision', 'rev_len', array('rev_id' => $revID ) );
-				// if length of rev text in file doesn't match length in db, we reload
-				// this avoids carrying forward broken data from previous xml dumps
-				if( strlen($text) == $revLength ) {
-					$this->prefetchCount++;
-					return $text;
-				}
-			}
-		}
-		return $this->doGetText( $id );
-	}
-
-	private function doGetText( $id ) {
-
-		$id = intval( $id );
-		$this->failures = 0;
-		$ex = new MWException( "Graceful storage failure" );
-		while (true) {
-			if ( $this->spawn ) {
-				if ($this->failures) {
-					// we don't know why it failed, could be the child process
-					// borked, could be db entry busted, could be db server out to lunch,
-					// so cover all bases
-					$this->closeSpawn();
-					$this->openSpawn();
-				}
-				$text =	 $this->getTextSpawned( $id );
-			} else {
-				$text =	 $this->getTextDbSafe( $id );
-			}
-			if ( $text === false ) {
-				$this->failures++;
-				if ( $this->failures > $this->maxFailures) {
-					$this->progress( "Failed to retrieve revision text for text id ".
-									 "$id after $this->maxFailures tries, giving up" );
-					// were there so many bad retrievals in a row we want to bail?
-					// at some point we have to declare the dump irretrievably broken
-					$this->failedTextRetrievals++;
-					if ($this->failedTextRetrievals > $this->maxConsecutiveFailedTextRetrievals) {
-						throw $ex;
-					}
-					else {
-						// would be nice to return something better to the caller someday,
-						// log what we know about the failure and about the revision
-						return("");
-					}
-				} else {
-					$this->progress( "Error $this->failures " .
-								 "of allowed $this->maxFailures retrieving revision text for text id $id! " .
-								 "Pausing $this->failureTimeout seconds before retry..." );
-					sleep( $this->failureTimeout );
-				}
-			} else {
-				$this->failedTextRetrievals= 0;
-				return( $text );
-			}
-		}
-
-	}
-
-	/**
-	 * Fetch a text revision from the database, retrying in case of failure.
-	 * This may survive some transitory errors by reconnecting, but
-	 * may not survive a long-term server outage.
-	 */
-	private function getTextDbSafe( $id ) {
-		while ( true ) {
-			try {
-				$text = $this->getTextDb( $id );
-				$ex = new MWException( "Graceful storage failure" );
-			} catch ( DBQueryError $ex ) {
-				$text = false;
-			}
-			return $text;
-		}
-	}
-
-	/**
-	 * May throw a database error if, say, the server dies during query.
-	 */
-	private function getTextDb( $id ) {
-		global $wgContLang;
-		$row = $this->db->selectRow( 'text',
-			array( 'old_text', 'old_flags' ),
-			array( 'old_id' => $id ),
-			'TextPassDumper::getText' );
-		$text = Revision::getRevisionText( $row );
-		if ( $text === false ) {
-			return false;
-		}
-		$stripped = str_replace( "\r", "", $text );
-		$normalized = $wgContLang->normalize( $stripped );
-		return $normalized;
-	}
-
-	private function getTextSpawned( $id ) {
-		wfSuppressWarnings();
-		if ( !$this->spawnProc ) {
-			// First time?
-			$this->openSpawn();
-		}
-		$text = $this->getTextSpawnedOnce( $id );
-		wfRestoreWarnings();
-		return $text;
-	}
-
-	function openSpawn() {
-		global $IP, $wgDBname;
-
-		$cmd = implode( " ",
-			array_map( 'wfEscapeShellArg',
-				array(
-					$this->php,
-					"$IP/maintenance/fetchText.php",
-					$wgDBname ) ) );
-		$spec = array(
-			0 => array( "pipe", "r" ),
-			1 => array( "pipe", "w" ),
-			2 => array( "file", "/dev/null", "a" ) );
-		$pipes = array();
-
-		$this->progress( "Spawning database subprocess: $cmd" );
-		$this->spawnProc = proc_open( $cmd, $spec, $pipes );
-		if ( !$this->spawnProc ) {
-			// shit
-			$this->progress( "Subprocess spawn failed." );
-			return false;
-		}
-		list(
-			$this->spawnWrite, // -> stdin
-			$this->spawnRead,  // <- stdout
-		) = $pipes;
-
-		return true;
-	}
-
-	private function closeSpawn() {
-		wfSuppressWarnings();
-		if ( $this->spawnRead )
-			fclose( $this->spawnRead );
-		$this->spawnRead = false;
-		if ( $this->spawnWrite )
-			fclose( $this->spawnWrite );
-		$this->spawnWrite = false;
-		if ( $this->spawnErr )
-			fclose( $this->spawnErr );
-		$this->spawnErr = false;
-		if ( $this->spawnProc )
-			pclose( $this->spawnProc );
-		$this->spawnProc = false;
-		wfRestoreWarnings();
-	}
-
-	private function getTextSpawnedOnce( $id ) {
-		global $wgContLang;
-
-		$ok = fwrite( $this->spawnWrite, "$id\n" );
-		// $this->progress( ">> $id" );
-		if ( !$ok ) return false;
-
-		$ok = fflush( $this->spawnWrite );
-		// $this->progress( ">> [flush]" );
-		if ( !$ok ) return false;
-
-		// check that the text id they are sending is the one we asked for
-		// this avoids out of sync revision text errors we have encountered in the past
-		$newId = fgets( $this->spawnRead );
-		if ( $newId === false ) {
-			return false;
-		}
-		if ( $id != intval( $newId ) ) {
-			return false;
-		}
-
-		$len = fgets( $this->spawnRead );
-		// $this->progress( "<< " . trim( $len ) );
-		if ( $len === false ) return false;
-
-		$nbytes = intval( $len );
-		// actual error, not zero-length text
-		if ($nbytes < 0 ) return false;
-
-		$text = "";
-
-		// Subprocess may not send everything at once, we have to loop.
-		while ( $nbytes > strlen( $text ) ) {
-			$buffer = fread( $this->spawnRead, $nbytes - strlen( $text ) );
-			if ( $buffer === false ) break;
-			$text .= $buffer;
-		}
-
-		$gotbytes = strlen( $text );
-		if ( $gotbytes != $nbytes ) {
-			$this->progress( "Expected $nbytes bytes from database subprocess, got $gotbytes " );
-			return false;
-		}
-
-		// Do normalization in the dump thread...
-		$stripped = str_replace( "\r", "", $text );
-		$normalized = $wgContLang->normalize( $stripped );
-		return $normalized;
-	}
-
-	function startElement( $parser, $name, $attribs ) {
-		$this->clearOpenElement( null );
-		$this->lastName = $name;
-
-		if ( $name == 'revision' ) {
-			$this->state = $name;
-			$this->egress->writeOpenPage( null, $this->buffer );
-			$this->buffer = "";
-		} elseif ( $name == 'page' ) {
-			$this->state = $name;
-			if ( $this->atStart ) {
-				$this->egress->writeOpenStream( $this->buffer );
-				$this->buffer = "";
-				$this->atStart = false;
-			}
-		}
-
-		if ( $name == "text" && isset( $attribs['id'] ) ) {
-			$text = $this->getText( $attribs['id'] );
-			$this->openElement = array( $name, array( 'xml:space' => 'preserve' ) );
-			if ( strlen( $text ) > 0 ) {
-				$this->characterData( $parser, $text );
-			}
-		} else {
-			$this->openElement = array( $name, $attribs );
-		}
-	}
-
-	function endElement( $parser, $name ) {
-		if ( $this->openElement ) {
-			$this->clearOpenElement( "" );
-		} else {
-			$this->buffer .= "</$name>";
-		}
-
-		if ( $name == 'revision' ) {
-			$this->egress->writeRevision( null, $this->buffer );
-			$this->buffer = "";
-			$this->thisRev = "";
-		} elseif ( $name == 'page' ) {
-			$this->egress->writeClosePage( $this->buffer );
-			$this->buffer = "";
-			$this->thisPage = "";
-		} elseif ( $name == 'mediawiki' ) {
-			$this->egress->writeCloseStream( $this->buffer );
-			$this->buffer = "";
-		}
-	}
-
-	function characterData( $parser, $data ) {
-		$this->clearOpenElement( null );
-		if ( $this->lastName == "id" ) {
-			if ( $this->state == "revision" ) {
-				$this->thisRev .= $data;
-			} elseif ( $this->state == "page" ) {
-				$this->thisPage .= $data;
-			}
-		}
-		$this->buffer .= htmlspecialchars( $data );
-	}
-
-	function clearOpenElement( $style ) {
-		if ( $this->openElement ) {
-			$this->buffer .= Xml::element( $this->openElement[0], $this->openElement[1], $style );
-			$this->openElement = false;
-		}
-	}
-}
+require_once( dirname( __FILE__ ) . '/backupTextPass.inc' );
 
 
 $dumper = new TextPassDumper( $argv );
 
-if ( true ) {
-	$dumper->dump();
+if ( !isset( $options['help'] ) ) {
+	$dumper->dump( true );
 } else {
 	$dumper->progress( <<<ENDS
 This script postprocesses XML dumps from dumpBackup.php to add
@@ -482,13 +47,20 @@ Options:
   --stub=<type>:<file> To load a compressed stub dump instead of stdin
   --prefetch=<type>:<file> Use a prior dump file as a text source, to save
 			  pressure on the database.
-			  (Requires PHP 5.0+ and the XMLReader PECL extension)
+			  (Requires the XMLReader extension)
+  --maxtime=<minutes> Write out checkpoint file after this many minutes (writing
+	          out complete page, closing xml file properly, and opening new one
+	          with header).  This option requires the checkpointfile option.
+  --checkpointfile=<filenamepattern> Use this string for checkpoint filenames,
+		      substituting first pageid written for the first %s (required) and the
+              last pageid written for the second %s if it exists.
   --quiet	  Don't dump status reports to stderr.
   --report=n  Report position and speed after every n pages processed.
 			  (Default: 100)
   --server=h  Force reading from MySQL server h
   --current	  Base ETA on number of pages in database instead of all revisions
   --spawn	  Spawn a subprocess for loading text records
+  --help      Display this help message
 ENDS
 );
 }