* Rename new message 'filetype-separator' (r28530) to the more generic message name...
[lhc/web/wiklou.git] / maintenance / dumpTextPass.php
index 5a3e11a..703fa1e 100644 (file)
  *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
- * @package MediaWiki
- * @subpackage SpecialPage
+ * @addtogroup SpecialPage
  */
 
 $originalDir = getcwd();
 
-$optionsWithArgs = array( 'server', 'pagelist', 'start', 'end' );
-
 require_once( 'commandLine.inc' );
-require_once( 'SpecialExport.php' );
-require_once( 'maintenance/backup.inc' );
+require_once( 'backup.inc' );
+
+/**
+ * Stream wrapper around 7za filter program.
+ * Required since we can't pass an open file resource to XMLReader->open()
+ * which is used for the text prefetch.
+ */
+class SevenZipStream {
+       var $stream;
+       
+       private function stripPath( $path ) {
+               $prefix = 'mediawiki.compress.7z://';
+               return substr( $path, strlen( $prefix ) );
+       }
+       
+       function stream_open( $path, $mode, $options, &$opened_path ) {
+               if( $mode{0} == 'r' ) {
+                       $options = 'e -bd -so';
+               } elseif( $mode{0} == 'w' ) {
+                       $options = 'a -bd -si';
+               } else {
+                       return false;
+               }
+               $arg = wfEscapeShellArg( $this->stripPath( $path ) );
+               $command = "7za $options $arg";
+               if( !wfIsWindows() ) {
+                       // Suppress the stupid messages on stderr
+                       $command .= ' 2>/dev/null';
+               }
+               $this->stream = popen( $command, $mode );
+               return ($this->stream !== false);
+       }
+       
+       function url_stat( $path, $flags ) {
+               return stat( $this->stripPath( $path ) );
+       }
+       
+       // This is all so lame; there should be a default class we can extend
+       
+       function stream_close() {
+               return fclose( $this->stream );
+       }
+       
+       function stream_flush() {
+               return fflush( $this->stream );
+       }
+       
+       function stream_read( $count ) {
+               return fread( $this->stream, $count );
+       }
+       
+       function stream_write( $data ) {
+               return fwrite( $this->stream, $data );
+       }
+       
+       function stream_tell() {
+               return ftell( $this->stream );
+       }
+       
+       function stream_eof() {
+               return feof( $this->stream );
+       }
+       
+       function stream_seek( $offset, $whence ) {
+               return fseek( $this->stream, $offset, $whence );
+       }
+}
+stream_wrapper_register( 'mediawiki.compress.7z', 'SevenZipStream' );
+
 
 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 = 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... ;)
@@ -39,43 +118,96 @@ class TextPassDumper extends BackupDumper {
 
                # Notice messages will foul up your XML output even if they're
                # relatively harmless.
-//             ini_set( 'display_errors', false );
+               if( ini_get( 'display_errors' ) )
+                       ini_set( 'display_errors', 'stderr' );
 
-               $this->startTime = wfTime();
+               $this->initProgress( $this->history );
 
-               $this->db =& $this->backupDb();
-               $this->maxCount = $this->db->selectField( 'page', 'MAX(page_id)', '', 'BackupDumper::dump' );
-               $this->startTime = wfTime();
+               $this->db = $this->backupDb();
 
                $this->egress = new ExportProgressFilter( $this->sink, $this );
 
-               $input = fopen( "php://stdin", "rt" );
+               $input = fopen( $this->input, "rt" );
                $result = $this->readDump( $input );
 
                if( WikiError::isError( $result ) ) {
-                       $this->progress( $result->getMessage() );
+                       wfDie( $result->getMessage() );
+               }
+               
+               if( $this->spawnProc ) {
+                       $this->closeSpawn();
                }
 
                $this->report( true );
        }
 
        function processOption( $opt, $val, $param ) {
-               if( $opt == 'prefetch' ) {
+               $url = $this->processFileOpt( $val, $param );
+               
+               switch( $opt ) {
+               case 'prefetch':
                        require_once 'maintenance/backupPrefetch.inc';
-                       switch( $val ) {
-                       case "file":
-                               $filename = $param;
-                               break;
-                       case "gzip":
-                               $filename = "compress.gzip://$param";
-                               break;
-                       case "bzip2":
-                               $filename = "compress.bzip2://$param";
-                               break;
-                       default:
-                               $filename = $val;
+                       $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->prefetch = new BaseDump( $filename );
+                       $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 ) );
                }
        }
 
@@ -105,20 +237,182 @@ class TextPassDumper extends BackupDumper {
                        $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( !is_null( $text ) )
+                       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 {
+                               $this->prefetchCount++;
                                return $text;
+                       }
+               }
+               return $this->doGetText( $id );
+       }
+       
+       private function doGetText( $id ) {
+               if( $this->spawn ) {
+                       return $this->getTextSpawned( $id );
+               } else {
+                       return $this->getTextDbSafe( $id );
                }
+       }
+       
+       /**
+        * 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;
+                       }
+                       if( $text === false ) {
+                               $this->failures++;
+                               if( $this->failures > $this->maxFailures ) {
+                                       throw $ex;
+                               } else {
+                                       $this->progress( "Database failure $this->failures " .
+                                               "of allowed $this->maxFailures for revision $id! " .
+                                               "Pausing $this->failureTimeout seconds..." );
+                                       sleep( $this->failureTimeout );
+                               }
+                       } else {
+                               return $text;
+                       }
+               }
+       }
+       
+       /**
+        * May throw a database error if, say, the server dies during query.
+        */
+       private function getTextDb( $id ) {
                $id = intval( $id );
                $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 = UtfNormal::cleanUp( $stripped );
+               return $normalized;
+       }
+       
+       private function getTextSpawned( $id ) {
+               wfSuppressWarnings();
+               if( !$this->spawnProc ) {
+                       // First time?
+                       $this->openSpawn();
+               }
+               while( true ) {
+                       
+                       $text = $this->getTextSpawnedOnce( $id );
+                       if( !is_string( $text ) ) {
+                               $this->progress("Database subprocess failed. Respawning...");
+                               
+                               $this->closeSpawn();
+                               sleep( $this->failureTimeout );
+                               $this->openSpawn();
+                               
+                               continue;
+                       }
+                       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 ) {
+               $ok = fwrite( $this->spawnWrite, "$id\n" );
+               //$this->progress( ">> $id" );
+               if( !$ok ) return false;
+               
+               $ok = fflush( $this->spawnWrite );
+               //$this->progress( ">> [flush]" );
+               if( !$ok ) return false;
+               
+               $len = fgets( $this->spawnRead );
+               //$this->progress( "<< " . trim( $len ) );
+               if( $len === false ) return false;
+               
+               $nbytes = intval( $len );
+               $text = "";
+               
+               // Subprocess may not send everything at once, we have to loop.
+               while( $nbytes > strlen( $text ) ) {
+                       $buffer = fread( $this->spawnRead, $nbytes - strlen( $text ) );
+                       if( $text === 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 = UtfNormal::cleanUp( $stripped );
                return $normalized;
@@ -195,9 +489,6 @@ class TextPassDumper extends BackupDumper {
 
 
 $dumper = new TextPassDumper( $argv );
-if( isset( $options['server'] ) ) {
-       $dumper->server = $options['server'];
-}
 
 if( true ) {
        $dumper->dump();
@@ -211,14 +502,18 @@ XML output is sent to stdout; progress reports are sent to stderr.
 
 Usage: php dumpTextPass.php [<options>]
 Options:
-  --prefetch <file>  Use a prior dump file as a text source where possible.
+  --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)
   --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
 END
 );
 }
 
-?>
+