(bug 37963) Fixed loading process for user options.
[lhc/web/wiklou.git] / maintenance / cleanupCaps.php
index ad3d5ab..ec2aa95 100644 (file)
 <?php
-/*
- * Script to clean up broken page links when somebody turns on $wgCapitalLinks.
+/**
+ * Clean up broken page links when somebody turns on $wgCapitalLinks.
  *
  * Usage: php cleanupCaps.php [--dry-run]
  * Options:
  *   --dry-run  don't actually try moving them
- * 
- * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
+ *
+ * Copyright © 2005 Brion Vibber <brion@pobox.com>
  * http://www.mediawiki.org/
- * 
+ *
  * 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 
+ * 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.,
- * 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
  *
+ * @file
  * @author Brion Vibber <brion at pobox.com>
- * @package MediaWiki
- * @subpackage maintenance
+ * @ingroup Maintenance
  */
 
-$options = array( 'dry-run' );
-
-require_once( 'commandLine.inc' );
-require_once( 'FiveUpgrade.inc' );
+require_once( __DIR__ . '/cleanupTable.inc' );
 
-class CapsCleanup extends FiveUpgrade {
-       function CapsCleanup( $dryrun = false, $namespace=0 ) {
-               parent::FiveUpgrade();
-               
-               $this->maxLag = 10; # if slaves are lagged more than 10 secs, wait
-               $this->dryrun = $dryrun;
-               $this->namespace = intval( $namespace );
-       }
-       
-       function cleanup() {
-               global $wgCapitalLinks;
-               if( $wgCapitalLinks ) {
-                       echo "\$wgCapitalLinks is on -- no need for caps links cleanup.\n";
-                       return false;
-               }
-               
-               $this->runTable( 'page', 'WHERE page_namespace=' . $this->namespace,
-                       array( &$this, 'processPage' ) );
-       }
-       
-       function init( $count, $table ) {
-               $this->processed = 0;
-               $this->updated = 0;
-               $this->count = $count;
-               $this->startTime = wfTime();
-               $this->table = $table;
-       }
-       
-       function progress( $updated ) {
-               $this->updated += $updated;
-               $this->processed++;
-               if( $this->processed % 100 != 0 ) {
-                       return;
-               }
-               $portion = $this->processed / $this->count;
-               $updateRate = $this->updated / $this->processed;
-               
-               $now = wfTime();
-               $delta = $now - $this->startTime;
-               $estimatedTotalTime = $delta / $portion;
-               $eta = $this->startTime + $estimatedTotalTime;
-               
-               printf( "%s: %6.2f%% done on %s; ETA %s [%d/%d] %.2f/sec <%.2f%% updated>\n",
-                       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();
+/**
+ * Maintenance script to clean up broken page links when somebody turns on $wgCapitalLinks.
+ *
+ * @ingroup Maintenance
+ */
+class CapsCleanup extends TableCleanup {
+       public function __construct() {
+               parent::__construct();
+               $this->mDescription = "Script to cleanup capitalization";
+               $this->addOption( 'namespace', 'Namespace number to run caps cleanup on', false, true );
        }
-       
-       function runTable( $table, $where, $callback ) {
-               $fname = 'CapsCleanup::buildTable';
-               
-               $count = $this->dbw->selectField( $table, 'count(*)', '', $fname );
-               $this->init( $count, 'page' );
-               $this->log( "Processing $table..." );
-               
-               $tableName = $this->dbr->tableName( $table );
-               $sql = "SELECT * FROM $tableName $where";
-               $result = $this->dbr->query( $sql, $fname );
-               
-               while( $row = $this->dbr->fetchObject( $result ) ) {
-                       $updated = call_user_func( $callback, $row );
+
+       public function execute() {
+               global $wgCapitalLinks, $wgUser;
+
+               if ( $wgCapitalLinks ) {
+                       $this->error( "\$wgCapitalLinks is on -- no need for caps links cleanup.", true );
                }
-               $this->log( "Finished $table... $this->updated of $this->processed rows updated" );
-               $this->dbr->freeResult( $result );
+
+               $wgUser = User::newFromName( 'Conversion script' );
+
+               $this->namespace = intval( $this->getOption( 'namespace', 0 ) );
+               $this->dryrun = $this->hasOption( 'dry-run' );
+
+               $this->runTable( array(
+                       'table' => 'page',
+                       'conds' => array( 'page_namespace' => $this->namespace ),
+                       'index' => 'page_id',
+                       'callback' => 'processRow' ) );
        }
-       
-       function processPage( $row ) {
+
+       protected function processRow( $row ) {
                global $wgContLang;
-               
+
                $current = Title::makeTitle( $row->page_namespace, $row->page_title );
                $display = $current->getPrefixedText();
                $upper = $row->page_title;
                $lower = $wgContLang->lcfirst( $row->page_title );
-               if( $upper == $lower ) {
-                       $this->log( "\"$display\" already lowercase." );
+               if ( $upper == $lower ) {
+                       $this->output( "\"$display\" already lowercase.\n" );
                        return $this->progress( 0 );
                }
-               
+
                $target = Title::makeTitle( $row->page_namespace, $lower );
                $targetDisplay = $target->getPrefixedText();
-               if( $target->exists() ) {
-                       $this->log( "\"$display\" skipped; \"$targetDisplay\" already exists" );
+               if ( $target->exists() ) {
+                       $this->output( "\"$display\" skipped; \"$targetDisplay\" already exists\n" );
                        return $this->progress( 0 );
                }
-               
-               if( $this->dryrun ) {
-                       $this->log( "\"$display\" -> \"$targetDisplay\": DRY RUN, NOT MOVED" );
+
+               if ( $this->dryrun ) {
+                       $this->output( "\"$display\" -> \"$targetDisplay\": DRY RUN, NOT MOVED\n" );
                        $ok = true;
                } else {
                        $ok = $current->moveTo( $target, false, 'Converting page titles to lowercase' );
-                       $this->log( "\"$display\" -> \"$targetDisplay\": $ok" );
+                       $this->output( "\"$display\" -> \"$targetDisplay\": $ok\n" );
                }
-               if( $ok === true ) {
+               if ( $ok === true ) {
                        $this->progress( 1 );
-                       
-                       if( $row->page_namespace == $this->namespace ) {
+                       if ( $row->page_namespace == $this->namespace ) {
                                $talk = $target->getTalkPage();
-                               $xrow = $row;
                                $row->page_namespace = $talk->getNamespace();
-                               if( $talk->exists() ) {
-                                       return $this->processPage( $row );
+                               if ( $talk->exists() ) {
+                                       return $this->processRow( $row );
                                }
                        }
-               } else {
-                       $this->progress( 0 );
                }
+               return $this->progress( 0 );
        }
-
 }
 
-$wgUser->setName( 'Conversion script' );
-$ns = isset( $options['namespace'] ) ? $options['namespace'] : 0;
-$caps = new CapsCleanup( isset( $options['dry-run'] ), $ns );
-$caps->cleanup();
-
-?>
+$maintClass = "CapsCleanup";
+require_once( RUN_MAINTENANCE_IF_MAIN );