Add new message keys to go with r105954
[lhc/web/wiklou.git] / maintenance / storage / recompressTracked.php
index 1bb15b7..c8aac64 100644 (file)
@@ -1,15 +1,40 @@
 <?php
+/**
+ * Moves blobs indexed by trackBlobs.php to a specified list of destination
+ * clusters, and recompresses them in the process.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Maintenance ExternalStorage
+ */
 
 $optionsWithArgs = RecompressTracked::getOptionsWithArgs();
-require( dirname( __FILE__ ) .'/../commandLine.inc' );
+require( dirname( __FILE__ ) . '/../commandLine.inc' );
 
 if ( count( $args ) < 1 ) {
        echo "Usage: php recompressTracked.php [options] <cluster> [... <cluster>...]
 Moves blobs indexed by trackBlobs.php to a specified list of destination clusters, and recompresses them in the process. Restartable.
 
-Options: 
-    --procs <procs>     Set the number of child processes (default 8)
-    --copy-only         Copy only, do not update the text table. Restart without this option to complete.
+Options:
+       --procs <procs>         Set the number of child processes (default 1)
+       --copy-only             Copy only, do not update the text table. Restart without this option to complete.
+       --debug-log <file>      Log debugging data to the specified file
+       --info-log <file>       Log progress messages to the specified file
+       --critical-log <file>   Log error messages to the specified file
 ";
        exit( 1 );
 }
@@ -20,21 +45,28 @@ $job->execute();
 class RecompressTracked {
        var $destClusters;
        var $batchSize = 1000;
+       var $orphanBatchSize = 1000;
        var $reportingInterval = 10;
-       var $numProcs = 8;
+       var $numProcs = 1;
        var $useDiff, $pageBlobClass, $orphanBlobClass;
        var $slavePipes, $slaveProcs, $prevSlaveId;
        var $copyOnly = false;
        var $isChild = false;
        var $slaveId = false;
+       var $noCount = false;
+       var $debugLog, $infoLog, $criticalLog;
        var $store;
 
-       static $optionsWithArgs = array( 'procs', 'slave-id' );
+       static $optionsWithArgs = array( 'procs', 'slave-id', 'debug-log', 'info-log', 'critical-log' );
        static $cmdLineOptionMap = array(
+               'no-count' => 'noCount',
                'procs' => 'numProcs',
                'copy-only' => 'copyOnly',
                'child' => 'isChild',
                'slave-id' => 'slaveId',
+               'debug-log' => 'debugLog',
+               'info-log' => 'infoLog',
+               'critical-log' => 'criticalLog',
        );
 
        static function getOptionsWithArgs() {
@@ -68,12 +100,39 @@ class RecompressTracked {
 
        function debug( $msg ) {
                wfDebug( "$msg\n" );
+               if ( $this->debugLog ) {
+                       $this->logToFile( $msg, $this->debugLog );
+               }
+
+       }
+
+       function info( $msg ) {
+               echo "$msg\n";
+               if ( $this->infoLog ) {
+                       $this->logToFile( $msg, $this->infoLog );
+               }
+       }
+
+       function critical( $msg ) {
+               echo "$msg\n";
+               if ( $this->criticalLog ) {
+                       $this->logToFile( $msg, $this->criticalLog );
+               }
+       }
+
+       function logToFile( $msg, $file ) {
+               $header = '[' . date( 'd\TH:i:s' ) . '] ' . wfHostname() . ' ' . posix_getpid();
+               if ( $this->slaveId !== false ) {
+                       $header .= "({$this->slaveId})";
+               }
+               $header .= ' ' . wfWikiID();
+               wfErrorLog( sprintf( "%-50s %s\n", $header, $msg ), $file );
        }
 
        /**
         * Wait until the selected slave has caught up to the master.
-        * This allows us to use the slave for things that were committed in a 
-        * previous part of this batch process. 
+        * This allows us to use the slave for things that were committed in a
+        * previous part of this batch process.
         */
        function syncDBs() {
                $dbw = wfGetDB( DB_MASTER );
@@ -110,16 +169,17 @@ class RecompressTracked {
 
        /**
         * Make sure the tracking table exists and isn't empty
+        * @return bool
         */
        function checkTrackingTable() {
                $dbr = wfGetDB( DB_SLAVE );
                if ( !$dbr->tableExists( 'blob_tracking' ) ) {
-                       echo "Error: blob_tracking table does not exist\n";
+                       $this->critical( "Error: blob_tracking table does not exist" );
                        return false;
                }
                $row = $dbr->selectRow( 'blob_tracking', '*', false, __METHOD__ );
                if ( !$row ) {
-                       echo "Warning: blob_tracking table contains no rows, skipping this wiki.\n";
+                       $this->info( "Warning: blob_tracking table contains no rows, skipping this wiki." );
                        return false;
                }
                return true;
@@ -134,29 +194,31 @@ class RecompressTracked {
        function startSlaveProcs() {
                $cmd = 'php ' . wfEscapeShellArg( __FILE__ );
                foreach ( self::$cmdLineOptionMap as $cmdOption => $classOption ) {
-                       if ( in_array( $cmdOption, self::$optionsWithArgs ) ) {
+                       if ( $cmdOption == 'slave-id' ) {
+                               continue;
+                       } elseif ( in_array( $cmdOption, self::$optionsWithArgs ) && isset( $this->$classOption ) ) {
                                $cmd .= " --$cmdOption " . wfEscapeShellArg( $this->$classOption );
                        } elseif ( $this->$classOption ) {
                                $cmd .= " --$cmdOption";
                        }
                }
-               $cmd .= ' --child' . 
+               $cmd .= ' --child' .
                        ' --wiki ' . wfEscapeShellArg( wfWikiID() ) .
                        ' ' . call_user_func_array( 'wfEscapeShellArg', $this->destClusters );
 
                $this->slavePipes = $this->slaveProcs = array();
                for ( $i = 0; $i < $this->numProcs; $i++ ) {
                        $pipes = false;
-                       $spec = array( 
+                       $spec = array(
                                array( 'pipe', 'r' ),
-                               array( 'file', '/dev/stdout', 'w' ),
-                               array( 'file', '/dev/stderr', 'w' )
+                               array( 'file', 'php://stdout', 'w' ),
+                               array( 'file', 'php://stderr', 'w' )
                        );
                        wfSuppressWarnings();
                        $proc = proc_open( "$cmd --slave-id $i", $spec, $pipes );
                        wfRestoreWarnings();
                        if ( !$proc ) {
-                               echo "Error opening slave process\n";
+                               $this->critical( "Error opening slave process: $cmd" );
                                exit( 1 );
                        }
                        $this->slaveProcs[$i] = $proc;
@@ -169,12 +231,17 @@ class RecompressTracked {
         * Gracefully terminate the child processes
         */
        function killSlaveProcs() {
+               $this->info( "Waiting for slave processes to finish..." );
                for ( $i = 0; $i < $this->numProcs; $i++ ) {
                        $this->dispatchToSlave( $i, 'quit' );
                }
                for ( $i = 0; $i < $this->numProcs; $i++ ) {
-                       proc_close( $this->slaveProcs[$i] );
+                       $status = proc_close( $this->slaveProcs[$i] );
+                       if ( $status ) {
+                               $this->critical( "Warning: child #$i exited with status $status" );
+                       }
                }
+               $this->info( "Done." );
        }
 
        /**
@@ -184,9 +251,9 @@ class RecompressTracked {
        function dispatch( /*...*/ ) {
                $args = func_get_args();
                $pipes = $this->slavePipes;
-               $numPipes = stream_select( $x=array(), $pipes, $y=array(), 3600 );
+               $numPipes = stream_select( $x = array(), $pipes, $y = array(), 3600 );
                if ( !$numPipes ) {
-                       echo "Error waiting to write to slaves. Aborting\n";
+                       $this->critical( "Error waiting to write to slaves. Aborting" );
                        exit( 1 );
                }
                for ( $i = 0; $i < $this->numProcs; $i++ ) {
@@ -197,7 +264,7 @@ class RecompressTracked {
                                return;
                        }
                }
-               echo "Unreachable\n";
+               $this->critical( "Unreachable" );
                exit( 1 );
        }
 
@@ -215,22 +282,33 @@ class RecompressTracked {
         */
        function doAllPages() {
                $dbr = wfGetDB( DB_SLAVE );
+               $i = 0;
                $startId = 0;
-               $endId = $dbr->selectField( 'blob_tracking', 'MAX(bt_page)', 
-                       # A condition is required so that this query uses the index
-                       array( 'bt_moved' => 0 ),
-                       __METHOD__ );
-               echo "Moving pages...\n";
+               if ( $this->noCount ) {
+                       $numPages = '[unknown]';
+               } else {
+                       $numPages = $dbr->selectField( 'blob_tracking',
+                               'COUNT(DISTINCT bt_page)',
+                               # A condition is required so that this query uses the index
+                               array( 'bt_moved' => 0 ),
+                               __METHOD__
+                       );
+               }
+               if ( $this->copyOnly ) {
+                       $this->info( "Copying pages..." );
+               } else {
+                       $this->info( "Moving pages..." );
+               }
                while ( true ) {
-                       $res = $dbr->select( 'blob_tracking', 
+                       $res = $dbr->select( 'blob_tracking',
                                array( 'bt_page' ),
-                               array( 
+                               array(
                                        'bt_moved' => 0,
                                        'bt_page > ' . $dbr->addQuotes( $startId )
                                ),
                                __METHOD__,
-                               array( 
-                                       'DISTINCT', 
+                               array(
+                                       'DISTINCT',
                                        'ORDER BY' => 'bt_page',
                                        'LIMIT' => $this->batchSize,
                                )
@@ -240,22 +318,28 @@ class RecompressTracked {
                        }
                        foreach ( $res as $row ) {
                                $this->dispatch( 'doPage', $row->bt_page );
+                               $i++;
                        }
                        $startId = $row->bt_page;
-                       $this->report( $startId, $endId );
+                       $this->report( 'pages', $i, $numPages );
+               }
+               $this->report( 'pages', $i, $numPages );
+               if ( $this->copyOnly ) {
+                       $this->info( "All page copies queued." );
+               } else {
+                       $this->info( "All page moves queued." );
                }
-               echo "Done moving pages.\n";
        }
 
        /**
         * Display a progress report
         */
-       function report( $start, $end ) {
+       function report( $label, $current, $end ) {
                $this->numBatches++;
-               if ( $this->numBatches >= $this->reportingInterval ) {
+               if ( $current == $end || $this->numBatches >= $this->reportingInterval ) {
                        $this->numBatches = 0;
-                       echo "$start / $end\n";
-                       wfWaitForSlaves( 5 );
+                       $this->info( "$label: $current / $end" );
+                       $this->waitForSlaves();
                }
        }
 
@@ -265,13 +349,23 @@ class RecompressTracked {
        function doAllOrphans() {
                $dbr = wfGetDB( DB_SLAVE );
                $startId = 0;
-               $endId = $dbr->selectField( 'blob_tracking', 'MAX(bt_text_id)', 
-                       array( 'bt_moved' => 0, 'bt_page' => 0 ),
-                       __METHOD__ );
-               if ( !$endId ) {
-                       return;
+               $i = 0;
+               if ( $this->noCount ) {
+                       $numOrphans = '[unknown]';
+               } else {
+                       $numOrphans = $dbr->selectField( 'blob_tracking',
+                               'COUNT(DISTINCT bt_text_id)',
+                               array( 'bt_moved' => 0, 'bt_page' => 0 ),
+                               __METHOD__ );
+                       if ( !$numOrphans ) {
+                               return;
+                       }
+               }
+               if ( $this->copyOnly ) {
+                       $this->info( "Copying orphans..." );
+               } else {
+                       $this->info( "Moving orphans..." );
                }
-               echo "Moving orphans...\n";
 
                while ( true ) {
                        $res = $dbr->select( 'blob_tracking',
@@ -291,15 +385,31 @@ class RecompressTracked {
                        if ( !$res->numRows() ) {
                                break;
                        }
-                       $args = array( 'doOrphanList' );
+                       $ids = array();
                        foreach ( $res as $row ) {
-                               $args[] = $row->bt_text_id;
+                               $ids[] = $row->bt_text_id;
+                               $i++;
+                       }
+                       // Need to send enough orphan IDs to the child at a time to fill a blob,
+                       // so orphanBatchSize needs to be at least ~100.
+                       // batchSize can be smaller or larger.
+                       while ( count( $ids ) > $this->orphanBatchSize ) {
+                               $args = array_slice( $ids, 0, $this->orphanBatchSize );
+                               $ids = array_slice( $ids, $this->orphanBatchSize );
+                               array_unshift( $args, 'doOrphanList' );
+                               call_user_func_array( array( $this, 'dispatch' ), $args );
                        }
-                       call_user_func_array( array( $this, 'dispatch' ), $args );
+                       if ( count( $ids ) ) {
+                               $args = $ids;
+                               array_unshift( $args, 'doOrphanList' );
+                               call_user_func_array( array( $this, 'dispatch' ), $args );
+                       }
+
                        $startId = $row->bt_text_id;
-                       $this->report( $startId, $endId );
+                       $this->report( 'orphans', $i, $numOrphans );
                }
-               echo "Done moving orphans.\n";
+               $this->report( 'orphans', $i, $numOrphans );
+               $this->info( "All orphans queued." );
        }
 
        /**
@@ -327,6 +437,7 @@ class RecompressTracked {
                        case 'quit':
                                return;
                        }
+                       $this->waitForSlaves();
                }
        }
 
@@ -345,14 +456,15 @@ class RecompressTracked {
                // Finish any incomplete transactions
                if ( !$this->copyOnly ) {
                        $this->finishIncompleteMoves( array( 'bt_page' => $pageId ) );
+                       $this->syncDBs();
                }
 
                $startId = 0;
                $trx = new CgzCopyTransaction( $this, $this->pageBlobClass );
 
                while ( true ) {
-                       $res = $dbr->select( 
-                               array( 'blob_tracking', 'text' ), 
+                       $res = $dbr->select(
+                               array( 'blob_tracking', 'text' ),
                                '*',
                                array(
                                        'bt_page' => $pageId,
@@ -362,7 +474,7 @@ class RecompressTracked {
                                        'bt_text_id=old_id',
                                ),
                                __METHOD__,
-                               array( 
+                               array(
                                        'ORDER BY' => 'bt_text_id',
                                        'LIMIT' => $this->batchSize
                                )
@@ -381,7 +493,7 @@ class RecompressTracked {
                                // Load the text
                                $text = Revision::getRevisionText( $row );
                                if ( $text === false ) {
-                                       echo "Error loading {$row->bt_rev_id}/{$row->bt_text_id}\n";
+                                       $this->critical( "Error loading {$row->bt_rev_id}/{$row->bt_text_id}" );
                                        continue;
                                }
 
@@ -390,6 +502,7 @@ class RecompressTracked {
                                        $this->debug( "$titleText: committing blob with " . $trx->getSize() . " items" );
                                        $trx->commit();
                                        $trx = new CgzCopyTransaction( $this, $this->pageBlobClass );
+                                       $this->waitForSlaves();
                                }
                        }
                        $startId = $row->bt_text_id;
@@ -406,16 +519,20 @@ class RecompressTracked {
         *
         * This is done in a single transaction to provide restartable behaviour
         * without data loss.
-        * 
+        *
         * The transaction is kept short to reduce locking.
         */
        function moveTextRow( $textId, $url ) {
+               if ( $this->copyOnly ) {
+                       $this->critical( "Internal error: can't call moveTextRow() in --copy-only mode" );
+                       exit( 1 );
+               }
                $dbw = wfGetDB( DB_MASTER );
                $dbw->begin();
                $dbw->update( 'text',
                        array( // set
                                'old_text' => $url,
-                               'old_flags' => 'external,utf8',
+                               'old_flags' => 'external,utf-8',
                        ),
                        array( // where
                                'old_id' => $textId
@@ -442,16 +559,16 @@ class RecompressTracked {
                $dbr = wfGetDB( DB_SLAVE );
 
                $startId = 0;
-               $conds = array_merge( $conds, array( 
+               $conds = array_merge( $conds, array(
                        'bt_moved' => 0,
                        'bt_new_url IS NOT NULL'
-               ));
+               ) );
                while ( true ) {
                        $res = $dbr->select( 'blob_tracking',
                                '*',
                                array_merge( $conds, array( 'bt_text_id > ' . $dbr->addQuotes( $startId ) ) ),
                                __METHOD__,
-                               array( 
+                               array(
                                        'ORDER BY' => 'bt_text_id',
                                        'LIMIT' => $this->batchSize,
                                )
@@ -459,9 +576,12 @@ class RecompressTracked {
                        if ( !$res->numRows() ) {
                                break;
                        }
-                       $this->debug( 'Incomplete: ' . $row->numRows() . ' rows' );
+                       $this->debug( 'Incomplete: ' . $res->numRows() . ' rows' );
                        foreach ( $res as $row ) {
                                $this->moveTextRow( $row->bt_text_id, $row->bt_new_url );
+                               if ( $row->bt_text_id % 10 == 0 ) {
+                                       $this->waitForSlaves();
+                               }
                        }
                        $startId = $row->bt_text_id;
                }
@@ -469,6 +589,7 @@ class RecompressTracked {
 
        /**
         * Returns the name of the next target cluster
+        * @return string
         */
        function getTargetCluster() {
                $cluster = next( $this->destClusters );
@@ -480,6 +601,8 @@ class RecompressTracked {
 
        /**
         * Gets a DB master connection for the given external cluster name
+        * @param $cluster string
+        * @return DatabaseBase
         */
        function getExtDB( $cluster ) {
                $lb = wfGetLBFactory()->getExternalLB( $cluster );
@@ -491,27 +614,56 @@ class RecompressTracked {
         */
        function doOrphanList( $textIds ) {
                // Finish incomplete moves
-               $this->finishIncompleteMoves( array( 'bt_text_id' => $textIds ) );
-               
+               if ( !$this->copyOnly ) {
+                       $this->finishIncompleteMoves( array( 'bt_text_id' => $textIds ) );
+                       $this->syncDBs();
+               }
+
                $trx = new CgzCopyTransaction( $this, $this->orphanBlobClass );
-               foreach ( $textIds as $textId ) {
-                       $row = wfGetDB( DB_SLAVE )->selectRow( 'text', array( 'old_text', 'old_flags' ), 
-                               array( 'old_id' => $textId ), __METHOD__ );
+
+               $res = wfGetDB( DB_SLAVE )->select(
+                       array( 'text', 'blob_tracking' ),
+                       array( 'old_id', 'old_text', 'old_flags' ),
+                       array(
+                               'old_id' => $textIds,
+                               'bt_text_id=old_id',
+                               'bt_moved' => 0,
+                       ),
+                       __METHOD__,
+                       array( 'DISTINCT' )
+               );
+
+               foreach ( $res as $row ) {
                        $text = Revision::getRevisionText( $row );
                        if ( $text === false ) {
-                               echo "Error: cannot load revision text for $textId\n";
+                               $this->critical( "Error: cannot load revision text for old_id={$row->old_id}" );
                                continue;
                        }
-                       
-                       if ( !$trx->addItem( $text, $textId ) ) {
+
+                       if ( !$trx->addItem( $text, $row->old_id ) ) {
                                $this->debug( "[orphan]: committing blob with " . $trx->getSize() . " rows" );
                                $trx->commit();
                                $trx = new CgzCopyTransaction( $this, $this->orphanBlobClass );
+                               $this->waitForSlaves();
                        }
                }
                $this->debug( "[orphan]: committing blob with " . $trx->getSize() . " rows" );
                $trx->commit();
        }
+
+       /**
+        * Wait for slaves (quietly)
+        */
+       function waitForSlaves() {
+               $lb = wfGetLB();
+               while ( true ) {
+                       list( $host, $maxLag ) = $lb->getMaxLag();
+                       if ( $maxLag < 2 ) {
+                               break;
+                       }
+                       sleep( 5 );
+               }
+       }
 }
 
 /**
@@ -536,6 +688,9 @@ class CgzCopyTransaction {
        /**
         * Add text.
         * Returns false if it's ready to commit.
+        * @param $text string
+        * @param $textId
+        * @return bool
         */
        function addItem( $text, $textId ) {
                if ( !$this->cgz ) {
@@ -578,14 +733,14 @@ class CgzCopyTransaction {
 
                // Check to see if the target text_ids have been moved already.
                //
-               // We originally read from the slave, so this can happen when a single 
-               // text_id is shared between multiple pages. It's rare, but possible 
+               // We originally read from the slave, so this can happen when a single
+               // text_id is shared between multiple pages. It's rare, but possible
                // if a delete/move/undelete cycle splits up a null edit.
                //
                // We do a locking read to prevent closer-run race conditions.
                $dbw = wfGetDB( DB_MASTER );
                $dbw->begin();
-               $res = $dbw->select( 'blob_tracking', 
+               $res = $dbw->select( 'blob_tracking',
                        array( 'bt_text_id', 'bt_moved' ),
                        array( 'bt_text_id' => array_keys( $this->referrers ) ),
                        __METHOD__, array( 'FOR UPDATE' ) );
@@ -605,8 +760,8 @@ class CgzCopyTransaction {
                                // All have been moved already
                                if ( $originalCount > 1 ) {
                                        // This is suspcious, make noise
-                                       echo "Warning: concurrent operation detected, are there two conflicting " .
-                                               "processes running, doing the same job?\n";
+                                       $this->critical( "Warning: concurrent operation detected, are there two conflicting " .
+                                               "processes running, doing the same job?" );
                                }
                                return;
                        }