maintenance/moveBatch.php

   1 <?php
   2 /**
   3  * Move a batch of pages.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Maintenance
  22  * @author Tim Starling
  23  *
  24  * USAGE: php moveBatch.php [-u <user>] [-r <reason>] [-i <interval>] [listfile]
  25  *
  26  * [listfile] - file with two titles per line, separated with pipe characters;
  27  * the first title is the source, the second is the destination.
  28  * Standard input is used if listfile is not given.
  29  * <user> - username to perform moves as
  30  * <reason> - reason to be given for moves
  31  * <interval> - number of seconds to sleep after each move
  32  *
  33  * This will print out error codes from Title::moveTo() if something goes wrong,
  34  * e.g. immobile_namespace for namespaces which can't be moved
  35  */
  36
  37 require_once( __DIR__ . '/Maintenance.php' );
  38
  39 /**
  40  * Maintenance script to move a batch of pages.
  41  *
  42  * @ingroup Maintenance
  43  */
  44 class MoveBatch extends Maintenance {
  45         public function __construct() {
  46                 parent::__construct();
  47                 $this->mDescription = "Moves a batch of pages";
  48                 $this->addOption( 'u', "User to perform move", false, true );
  49                 $this->addOption( 'r', "Reason to move page", false, true );
  50                 $this->addOption( 'i', "Interval to sleep between moves" );
  51                 $this->addArg( 'listfile', 'List of pages to move, newline delimited', false );
  52         }
  53
  54         public function execute() {
  55                 global $wgUser;
  56
  57                 # Change to current working directory
  58                 $oldCwd = getcwd();
  59                 chdir( $oldCwd );
  60
  61                 # Options processing
  62                 $user = $this->getOption( 'u', 'Move page script' );
  63                 $reason = $this->getOption( 'r', '' );
  64                 $interval = $this->getOption( 'i', 0 );
  65                 if ( $this->hasArg() ) {
  66                         $file = fopen( $this->getArg(), 'r' );
  67                 } else {
  68                         $file = $this->getStdin();
  69                 }
  70
  71                 # Setup
  72                 if ( !$file ) {
  73                         $this->error( "Unable to read file, exiting", true );
  74                 }
  75                 $wgUser = User::newFromName( $user );
  76                 if ( !$wgUser ) {
  77                         $this->error( "Invalid username", true );
  78                 }
  79
  80                 # Setup complete, now start
  81                 $dbw = wfGetDB( DB_MASTER );
  82                 for ( $linenum = 1; !feof( $file ); $linenum++ ) {
  83                         $line = fgets( $file );
  84                         if ( $line === false ) {
  85                                 break;
  86                         }
  87                         $parts = array_map( 'trim', explode( '|', $line ) );
  88                         if ( count( $parts ) != 2 ) {
  89                                 $this->error( "Error on line $linenum, no pipe character" );
  90                                 continue;
  91                         }
  92                         $source = Title::newFromText( $parts[0] );
  93                         $dest = Title::newFromText( $parts[1] );
  94                         if ( is_null( $source ) || is_null( $dest ) ) {
  95                                 $this->error( "Invalid title on line $linenum" );
  96                                 continue;
  97                         }
  98
  99
 100                         $this->output( $source->getPrefixedText() . ' --> ' . $dest->getPrefixedText() );
 101                         $dbw->begin( __METHOD__ );
 102                         $err = $source->moveTo( $dest, false, $reason );
 103                         if ( $err !== true ) {
 104                                 $msg = array_shift( $err[0] );
 105                                 $this->output( "\nFAILED: " . wfMessage( $msg, $err[0] )->text() );
 106                         }
 107                         $dbw->commit( __METHOD__ );
 108                         $this->output( "\n" );
 109
 110                         if ( $interval ) {
 111                                 sleep( $interval );
 112                         }
 113                         wfWaitForSlaves();
 114                 }
 115         }
 116 }
 117
 118 $maintClass = "MoveBatch";
 119 require_once( RUN_MAINTENANCE_IF_MAIN );