X-Git-Url: http://git.cyclocoop.org/?a=blobdiff_plain;f=maintenance%2FcleanupTable.inc;h=898bdf497e5d82668cdcf7f4799033e92100a64b;hb=9cd080744ff168bf8d0630931849bb63a3d9bcdc;hp=265eca9768c30c13b516d0eb3ac41724b81d15e2;hpb=9dc71928c49fe1fd9d45205dac7e84592f488ce8;p=lhc%2Fweb%2Fwiklou.git

diff --git a/maintenance/cleanupTable.inc b/maintenance/cleanupTable.inc
index 265eca9768..898bdf497e 100644
--- a/maintenance/cleanupTable.inc
+++ b/maintenance/cleanupTable.inc
@@ -1,28 +1,64 @@
 <?php
+/**
+ * Generic class to cleanup a database table.
+ *
+ * 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
+ */
 
-require_once( 'FiveUpgrade.inc' );
+require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
-abstract class TableCleanup extends FiveUpgrade {
-	function __construct( $table, $dryrun = false ) {
-		parent::__construct();
+/**
+ * Generic class to cleanup a database table. Already subclasses Maintenance.
+ *
+ * @ingroup Maintenance
+ */
+class TableCleanup extends Maintenance {
+	protected $defaultParams = array(
+		'table' => 'page',
+		'conds' => array(),
+		'index' => 'page_id',
+		'callback' => 'processRow',
+	);
+
+	protected $dryrun = false;
+	protected $maxLag = 10; # if slaves are lagged more than 10 secs, wait
+	public $batchSize = 100;
+	public $reportInterval = 100;
 
-		$this->targetTable = $table;
-		$this->maxLag = 10; # if slaves are lagged more than 10 secs, wait
-		$this->dryrun = $dryrun;
+	public function __construct() {
+		parent::__construct();
+		$this->addOption( 'dry-run', 'Perform a dry run' );
 	}
 
-	function cleanup() {
-		if( $this->dryrun ) {
-			echo "Checking for bad titles...\n";
+	public function execute() {
+		global $wgUser;
+		$wgUser = User::newFromName( 'Conversion script' );
+		$this->dryrun = $this->hasOption( 'dry-run' );
+		if ( $this->dryrun ) {
+			$this->output( "Checking for bad titles...\n" );
 		} else {
-			echo "Checking and fixing bad titles...\n";
+			$this->output( "Checking and fixing bad titles...\n" );
 		}
-		$this->runTable( $this->targetTable,
-			'', //'WHERE page_namespace=0',
-			array( $this, 'processPage' ) );
+		$this->runTable( $this->defaultParams );
 	}
 
-	function init( $count, $table ) {
+	protected function init( $count, $table ) {
 		$this->processed = 0;
 		$this->updated = 0;
 		$this->count = $count;
@@ -30,10 +66,10 @@ abstract class TableCleanup extends FiveUpgrade {
 		$this->table = $table;
 	}
 
-	function progress( $updated ) {
+	protected function progress( $updated ) {
 		$this->updated += $updated;
 		$this->processed++;
-		if( $this->processed % 100 != 0 ) {
+		if ( $this->processed % $this->reportInterval != 0 ) {
 			return;
 		}
 		$portion = $this->processed / $this->count;
@@ -44,44 +80,90 @@ abstract class TableCleanup extends FiveUpgrade {
 		$estimatedTotalTime = $delta / $portion;
 		$eta = $this->startTime + $estimatedTotalTime;
 
-		global $wgDBname;
-		printf( "%s %s: %6.2f%% done on %s; ETA %s [%d/%d] %.2f/sec <%.2f%% updated>\n",
-			$wgDBname,
-			wfTimestamp( TS_DB, intval( $now ) ),
-			$portion * 100.0,
-			$this->table,
-			wfTimestamp( TS_DB, intval( $eta ) ),
-			$this->processed,
-			$this->count,
-			$this->processed / $delta,
-			$updateRate * 100.0 );
+		$this->output(
+			sprintf( "%s %s: %6.2f%% done on %s; ETA %s [%d/%d] %.2f/sec <%.2f%% updated>\n",
+				wfWikiID(),
+				wfTimestamp( TS_DB, intval( $now ) ),
+				$portion * 100.0,
+				$this->table,
+				wfTimestamp( TS_DB, intval( $eta ) ),
+				$this->processed,
+				$this->count,
+				$this->processed / $delta,
+				$updateRate * 100.0
+			)
+		);
 		flush();
 	}
 
-	function runTable( $table, $where, $callback ) {
-		$fname = 'CapsCleanup::buildTable';
+	public function runTable( $params ) {
+		$dbr = wfGetDB( DB_SLAVE );
 
-		$count = $this->dbw->selectField( $table, 'count(*)', '', $fname );
+		if ( array_diff( array_keys( $params ),
+			array( 'table', 'conds', 'index', 'callback' ) ) )
+		{
+			throw new MWException( __METHOD__ . ': Missing parameter ' . implode( ', ', $params ) );
+		}
+
+		$table = $params['table'];
+		// count(*) would melt the DB for huge tables, we can estimate here
+		$count = $dbr->estimateRowCount( $table, '*', '', __METHOD__ );
 		$this->init( $count, $table );
-		$this->log( "Processing $table..." );
+		$this->output( "Processing $table...\n" );
+
+
+		$index = (array)$params['index'];
+		$indexConds = array();
+		$options = array(
+			'ORDER BY' => implode( ',', $index ),
+			'LIMIT' => $this->batchSize
+		);
+		$callback = array( $this, $params['callback'] );
 
-		$tableName = $this->dbr->tableName( $table );
-		$sql = "SELECT * FROM $tableName $where";
-		$result = $this->dbr->query( $sql, $fname );
+		while ( true ) {
+			$conds = array_merge( $params['conds'], $indexConds );
+			$res = $dbr->select( $table, '*', $conds, __METHOD__, $options );
+			if ( !$res->numRows() ) {
+				// Done
+				break;
+			}
 
-		while( $row = $this->dbr->fetchObject( $result ) ) {
-			$updated = call_user_func( $callback, $row );
+			foreach ( $res as $row ) {
+				call_user_func( $callback, $row );
+			}
+
+			if ( $res->numRows() < $this->batchSize ) {
+				// Done
+				break;
+			}
+
+			// Update the conditions to select the next batch.
+			// Construct a condition string by starting with the least significant part
+			// of the index, and adding more significant parts progressively to the left
+			// of the string.
+			$nextCond = '';
+			foreach ( array_reverse( $index ) as $field ) {
+				$encValue = $dbr->addQuotes( $row->$field );
+				if ( $nextCond === '' ) {
+					$nextCond = "$field > $encValue";
+				} else {
+					$nextCond = "$field > $encValue OR ($field = $encValue AND ($nextCond))";
+				}
+			}
+			$indexConds = array( $nextCond );
 		}
-		$this->log( "Finished $table... $this->updated of $this->processed rows updated" );
-		$this->dbr->freeResult( $result );
+
+		$this->output( "Finished $table... $this->updated of $this->processed rows updated\n" );
 	}
 
-	function hexChar( $matches ) {
+	protected function hexChar( $matches ) {
 		return sprintf( "\\x%02x", ord( $matches[1] ) );
 	}
-	
-	abstract function processPage( $row );
-	
 }
 
-?>
\ No newline at end of file
+class TableCleanupTest extends TableCleanup {
+	function processRow( $row ) {
+		$this->progress( mt_rand( 0, 1 ) );
+	}
+}
+