Group related functions

[lhc/web/wiklou.git] / maintenance / storage / recompressTracked.php

diff --git a/maintenance/storage/recompressTracked.php b/maintenance/storage/recompressTracked.php
index 575a148..c8aac64 100644 (file)
--- a/maintenance/storage/recompressTracked.php
+++ b/maintenance/storage/recompressTracked.php
@@ -1,4 +1,26 @@
 <?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' );
@@ -7,8 +29,8 @@ 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 1)
+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
@@ -109,8 +131,8 @@ class RecompressTracked {
 
        /**
         * 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 );
@@ -147,6 +169,7 @@ class RecompressTracked {
 
        /**
         * Make sure the tracking table exists and isn't empty
+        * @return bool
         */
        function checkTrackingTable() {
                $dbr = wfGetDB( DB_SLAVE );
@@ -496,7 +519,7 @@ 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 ) {
@@ -566,6 +589,7 @@ class RecompressTracked {
 
        /**
         * Returns the name of the next target cluster
+        * @return string
         */
        function getTargetCluster() {
                $cluster = next( $this->destClusters );
@@ -577,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 );
@@ -592,7 +618,7 @@ class RecompressTracked {
                        $this->finishIncompleteMoves( array( 'bt_text_id' => $textIds ) );
                        $this->syncDBs();
                }
-               
+
                $trx = new CgzCopyTransaction( $this, $this->orphanBlobClass );
 
                $res = wfGetDB( DB_SLAVE )->select(
@@ -610,10 +636,10 @@ class RecompressTracked {
                foreach ( $res as $row ) {
                        $text = Revision::getRevisionText( $row );
                        if ( $text === false ) {
-                               $this->critical( "Error: cannot load revision text for old_id=$textId" );
+                               $this->critical( "Error: cannot load revision text for old_id={$row->old_id}" );
                                continue;
                        }
-                       
+
                        if ( !$trx->addItem( $text, $row->old_id ) ) {
                                $this->debug( "[orphan]: committing blob with " . $trx->getSize() . " rows" );
                                $trx->commit();
@@ -625,7 +651,7 @@ class RecompressTracked {
                $trx->commit();
        }
 
-       /** 
+       /**
         * Wait for slaves (quietly)
         */
        function waitForSlaves() {
@@ -662,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 ) {
@@ -704,8 +733,8 @@ 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.