Merge "Follow-up I0b781c11 (2a55449): use User::getAutomaticGroups()."
[lhc/web/wiklou.git] / maintenance / cleanupTitles.php
index 7d30060..ad2577a 100644 (file)
 <?php
-/*
- * Script to clean up broken, unparseable titles.
+/**
+ * Clean up broken, unparseable titles.
  *
- * Usage: php cleanupTitles.php [--dry-run]
+ * Usage: php cleanupTitles.php [--fix]
  * Options:
- *   --dry-run  don't actually try moving them
- * 
- * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
+ *   --fix  Actually clean up titles; otherwise just checks for them
+ *
+ * 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( __DIR__ . '/cleanupTable.inc' );
 
-require_once( 'commandLine.inc' );
-require_once( 'FiveUpgrade.inc' );
-
-class TitleCleanup extends FiveUpgrade {
-       function TitleCleanup( $dryrun = false ) {
-               parent::FiveUpgrade();
-               
-               $this->maxLag = 10; # if slaves are lagged more than 10 secs, wait
-               $this->dryrun = $dryrun;
-       }
-       
-       function cleanup() {
-               $this->runTable( 'page', 'WHERE page_namespace=0',
-                       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;
-               
-               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 );
-               flush();
-       }
-       
-       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 );
-               }
-               $this->log( "Finished $table... $this->updated of $this->processed rows updated" );
-               $this->dbr->freeResult( $result );
+/**
+ * Maintenance script to clean up broken, unparseable titles.
+ *
+ * @ingroup Maintenance
+ */
+class TitleCleanup extends TableCleanup {
+       public function __construct() {
+               parent::__construct();
+               $this->mDescription = "Script to clean up broken, unparseable titles";
        }
-       
-       function processPage( $row ) {
+
+       protected function processRow( $row ) {
                global $wgContLang;
-               
-               $current = Title::makeTitle( $row->page_namespace, $row->page_title );
-               $display = $current->getPrefixedText();
-               
-               $verified = UtfNormal::cleanUp( $display );
+               $display = Title::makeName( $row->page_namespace, $row->page_title );
+               $verified = $wgContLang->normalize( $display );
                $title = Title::newFromText( $verified );
-               
-               if( is_null( $title ) ) {
-                       $this->log( "page $row->page_id ($display) is illegal." );
+
+               if ( !is_null( $title )
+                       && $title->canExist()
+                       && $title->getNamespace() == $row->page_namespace
+                       && $title->getDBkey() === $row->page_title )
+               {
+                       return $this->progress( 0 );  // all is fine
+               }
+
+               if ( $row->page_namespace == NS_FILE && $this->fileExists( $row->page_title ) ) {
+                       $this->output( "file $row->page_title needs cleanup, please run cleanupImages.php.\n" );
+                       return $this->progress( 0 );
+               } elseif ( is_null( $title ) ) {
+                       $this->output( "page $row->page_id ($display) is illegal.\n" );
                        $this->moveIllegalPage( $row );
                        return $this->progress( 1 );
-               }
-               
-               if( !$title->equals( $current ) ) {
-                       $this->log( "page $row->page_id ($display) doesn't match self." );
+               } else {
+                       $this->output( "page $row->page_id ($display) doesn't match self.\n" );
                        $this->moveInconsistentPage( $row, $title );
                        return $this->progress( 1 );
                }
-               
-               $this->progress( 0 );
        }
-       
-       function moveIllegalPage( $row ) {
+
+       protected function fileExists( $name ) {
+               // XXX: Doesn't actually check for file existence, just presence of image record.
+               // This is reasonable, since cleanupImages.php only iterates over the image table.
+               $dbr = wfGetDB( DB_SLAVE );
+               $row = $dbr->selectRow( 'image', array( 'img_name' ), array( 'img_name' => $name ), __METHOD__ );
+               return $row !== false;
+       }
+
+       protected function moveIllegalPage( $row ) {
                $legal = 'A-Za-z0-9_/\\\\-';
                $legalized = preg_replace_callback( "!([^$legal])!",
                        array( &$this, 'hexChar' ),
                        $row->page_title );
-               if( $legalized == '.' ) $legalized = '(dot)';
-               if( $legalized == '_' ) $legalized = '(space)';
+               if ( $legalized == '.' ) $legalized = '(dot)';
+               if ( $legalized == '_' ) $legalized = '(space)';
                $legalized = 'Broken/' . $legalized;
-               
+
                $title = Title::newFromText( $legalized );
-               if( is_null( $title ) ) {
+               if ( is_null( $title ) ) {
                        $clean = 'Broken/id:' . $row->page_id;
-                       $this->log( "Couldn't legalize; form '$legalized' still invalid; using '$clean'" );
+                       $this->output( "Couldn't legalize; form '$legalized' still invalid; using '$clean'\n" );
                        $title = Title::newFromText( $clean );
-               } elseif( $title->exists() ) {
+               } elseif ( $title->exists() ) {
                        $clean = 'Broken/id:' . $row->page_id;
-                       $this->log( "Legalized for '$legalized' exists; using '$clean'" );
+                       $this->output( "Legalized for '$legalized' exists; using '$clean'\n" );
                        $title = Title::newFromText( $clean );
                }
-               
-               $dest = $title->getDbKey();
-               if( $this->dryrun ) {
-                       $this->log( "DRY RUN: would rename $row->page_id ($row->page_namespace,'$row->page_title') to ($row->page_namespace,'$dest')" );
+
+               $dest = $title->getDBkey();
+               if ( $this->dryrun ) {
+                       $this->output( "DRY RUN: would rename $row->page_id ($row->page_namespace,'$row->page_title') to ($row->page_namespace,'$dest')\n" );
                } else {
-                       $this->log( "renaming $row->page_id ($row->page_namespace,'$row->page_title') to ($row->page_namespace,'$dest')" );
-                       $dbw =& wfGetDB( DB_MASTER );
+                       $this->output( "renaming $row->page_id ($row->page_namespace,'$row->page_title') to ($row->page_namespace,'$dest')\n" );
+                       $dbw = wfGetDB( DB_MASTER );
                        $dbw->update( 'page',
                                array( 'page_title' => $dest ),
                                array( 'page_id' => $row->page_id ),
-                               'cleanupTitles::moveInconsistentPage' );
+                               __METHOD__ );
                }
        }
-       
-       function moveInconsistentPage( $row, $title ) {
-               if( $title->exists() ) {
-                       $prior = $title->getDbKey();
+
+       protected function moveInconsistentPage( $row, $title ) {
+               if ( $title->exists() || $title->getInterwiki() || !$title->canExist() ) {
+                       if ( $title->getInterwiki() || !$title->canExist() ) {
+                               $prior = $title->getPrefixedDbKey();
+                       } else {
+                               $prior = $title->getDBkey();
+                       }
+
+                       # Old cleanupTitles could move articles there. See bug 23147.
+                       $ns = $row->page_namespace;
+                       if ( $ns < 0 ) $ns = 0;
+
                        $clean = 'Broken/' . $prior;
-                       $verified = Title::makeTitleSafe( $row->page_namespace, $clean );
-                       if( $verified->exists() ) {
+                       $verified = Title::makeTitleSafe( $ns, $clean );
+                       if ( $verified->exists() ) {
                                $blah = "Broken/id:" . $row->page_id;
-                               $this->log( "Couldn't legalize; form '$clean' exists; using '$blah'" );
-                               $verified = Title::makeTitleSafe( $row->page_namespace, $blah );
+                               $this->output( "Couldn't legalize; form '$clean' exists; using '$blah'\n" );
+                               $verified = Title::makeTitleSafe( $ns, $blah );
                        }
                        $title = $verified;
                }
-               if( is_null( $title ) ) {
-                       die( "Something awry; empty title.\n" );
+               if ( is_null( $title ) ) {
+                       $this->error( "Something awry; empty title.", true );
                }
-               $dest = $title->getDbKey();
-               if( $this->dryrun ) {
-                       $this->log( "DRY RUN: would rename $row->page_id ($row->page_namespace,'$row->page_title') to ($row->page_namespace,'$dest')" );
+               $ns = $title->getNamespace();
+               $dest = $title->getDBkey();
+
+               if ( $this->dryrun ) {
+                       $this->output( "DRY RUN: would rename $row->page_id ($row->page_namespace,'$row->page_title') to ($ns,'$dest')\n" );
                } else {
-                       $this->log( "renaming $row->page_id ($row->page_namespace,'$row->page_title') to ($row->page_namespace,'$dest')" );
-                       $dbw =& wfGetDB( DB_MASTER );
+                       $this->output( "renaming $row->page_id ($row->page_namespace,'$row->page_title') to ($ns,'$dest')\n" );
+                       $dbw = wfGetDB( DB_MASTER );
                        $dbw->update( 'page',
-                               array( 'page_title' => $dest ),
+                               array(
+                                       'page_namespace' => $ns,
+                                       'page_title' => $dest
+                               ),
                                array( 'page_id' => $row->page_id ),
-                               'cleanupTitles::moveInconsistentPage' );
+                               __METHOD__ );
+                       LinkCache::singleton()->clear();
                }
        }
-       
-       function hexChar( $matches ) {
-               return sprintf( "\\x%02x", ord( $matches[1] ) );
-       }
 }
 
-$wgUser->setName( 'Conversion script' );
-$caps = new TitleCleanup( isset( $options['dry-run'] ) );
-$caps->cleanup();
-
-?>
+$maintClass = "TitleCleanup";
+require_once( RUN_MAINTENANCE_IF_MAIN );