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>] [-noredirects] [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  * <noredirects> - suppress creation of redirects
  33  *
  34  * This will print out error codes from Title::moveTo() if something goes wrong,
  35  * e.g. immobile_namespace for namespaces which can't be moved
  36  */
  37
  38 require_once __DIR__ . '/Maintenance.php';
  39
  40 /**
  41  * Maintenance script to move a batch of pages.
  42  *
  43  * @ingroup Maintenance
  44  */
  45 class MoveBatch extends Maintenance {
  46         public function __construct() {
  47                 parent::__construct();
  48                 $this->addDescription( 'Moves a batch of pages' );
  49                 $this->addOption( 'u', "User to perform move", false, true );
  50                 $this->addOption( 'r', "Reason to move page", false, true );
  51                 $this->addOption( 'i', "Interval to sleep between moves" );
  52                 $this->addOption( 'noredirects', "Suppress creation of redirects" );
  53                 $this->addArg( 'listfile', 'List of pages to move, newline delimited', false );
  54         }
  55
  56         public function execute() {
  57                 global $wgUser;
  58
  59                 # Change to current working directory
  60                 $oldCwd = getcwd();
  61                 chdir( $oldCwd );
  62
  63                 # Options processing
  64                 $user = $this->getOption( 'u', false );
  65                 $reason = $this->getOption( 'r', '' );
  66                 $interval = $this->getOption( 'i', 0 );
  67                 $noredirects = $this->hasOption( 'noredirects' );
  68                 if ( $this->hasArg() ) {
  69                         $file = fopen( $this->getArg(), 'r' );
  70                 } else {
  71                         $file = $this->getStdin();
  72                 }
  73
  74                 # Setup
  75                 if ( !$file ) {
  76                         $this->fatalError( "Unable to read file, exiting" );
  77                 }
  78                 if ( $user === false ) {
  79                         $wgUser = User::newSystemUser( 'Move page script', [ 'steal' => true ] );
  80                 } else {
  81                         $wgUser = User::newFromName( $user );
  82                 }
  83                 if ( !$wgUser ) {
  84                         $this->fatalError( "Invalid username" );
  85                 }
  86
  87                 # Setup complete, now start
  88                 $dbw = $this->getDB( DB_MASTER );
  89                 // phpcs:ignore Generic.CodeAnalysis.ForLoopWithTestFunctionCall
  90                 for ( $linenum = 1; !feof( $file ); $linenum++ ) {
  91                         $line = fgets( $file );
  92                         if ( $line === false ) {
  93                                 break;
  94                         }
  95                         $parts = array_map( 'trim', explode( '|', $line ) );
  96                         if ( count( $parts ) != 2 ) {
  97                                 $this->error( "Error on line $linenum, no pipe character" );
  98                                 continue;
  99                         }
 100                         $source = Title::newFromText( $parts[0] );
 101                         $dest = Title::newFromText( $parts[1] );
 102                         if ( is_null( $source ) || is_null( $dest ) ) {
 103                                 $this->error( "Invalid title on line $linenum" );
 104                                 continue;
 105                         }
 106
 107                         $this->output( $source->getPrefixedText() . ' --> ' . $dest->getPrefixedText() );
 108                         $this->beginTransaction( $dbw, __METHOD__ );
 109                         $mp = new MovePage( $source, $dest );
 110                         $status = $mp->move( $wgUser, $reason, !$noredirects );
 111                         if ( !$status->isOK() ) {
 112                                 $this->output( "\nFAILED: " . $status->getWikiText( false, false, 'en' ) );
 113                         }
 114                         $this->commitTransaction( $dbw, __METHOD__ );
 115                         $this->output( "\n" );
 116
 117                         if ( $interval ) {
 118                                 sleep( $interval );
 119                         }
 120                         wfWaitForSlaves();
 121                 }
 122         }
 123 }
 124
 125 $maintClass = "MoveBatch";
 126 require_once RUN_MAINTENANCE_IF_MAIN;