wiki.techinc.nl/maintenance/moveBatch.php
Thiemo Kreuz 06c1a5976c maintenance: Deprecate Maintenance::hasArg/getArg with no param
Benefit of keeping the parameter optional:
- In maintenance scripts that really only have one parameter, it's a
  little more convenient to be able to ask for *the* parameter via an
  empty getArg().

Disadvantages:
- It's unclear what getArg() means when there is no indication *which*
  argument the code asks for. This might as well return the last
  argument, or an array of all arguments.
- In scripts with two or more arguments, it's confusing to see
  getArg( 1 ) next to an empty getArg().
- The methods are more complex and a bit more complicated to use with
  the extra feature of this parameter being optional. Users need to
  look up what the default is to be able to use it safely.

Change-Id: I22a43bfdfc0f0c9ffdb468c13aba73b888d1f15e
2019-03-29 14:37:46 +01:00

124 lines
3.9 KiB
PHP

<?php
/**
* Move a batch of pages.
*
* 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
* @author Tim Starling
*
* USAGE: php moveBatch.php [-u <user>] [-r <reason>] [-i <interval>] [-noredirects] [listfile]
*
* [listfile] - file with two titles per line, separated with pipe characters;
* the first title is the source, the second is the destination.
* Standard input is used if listfile is not given.
* <user> - username to perform moves as
* <reason> - reason to be given for moves
* <interval> - number of seconds to sleep after each move
* <noredirects> - suppress creation of redirects
*
* This will print out error codes from Title::moveTo() if something goes wrong,
* e.g. immobile_namespace for namespaces which can't be moved
*/
require_once __DIR__ . '/Maintenance.php';
/**
* Maintenance script to move a batch of pages.
*
* @ingroup Maintenance
*/
class MoveBatch extends Maintenance {
public function __construct() {
parent::__construct();
$this->addDescription( 'Moves a batch of pages' );
$this->addOption( 'u', "User to perform move", false, true );
$this->addOption( 'r', "Reason to move page", false, true );
$this->addOption( 'i', "Interval to sleep between moves" );
$this->addOption( 'noredirects', "Suppress creation of redirects" );
$this->addArg( 'listfile', 'List of pages to move, newline delimited', false );
}
public function execute() {
global $wgUser;
# Change to current working directory
$oldCwd = getcwd();
chdir( $oldCwd );
# Options processing
$user = $this->getOption( 'u', false );
$reason = $this->getOption( 'r', '' );
$interval = $this->getOption( 'i', 0 );
$noredirects = $this->hasOption( 'noredirects' );
if ( $this->hasArg( 0 ) ) {
$file = fopen( $this->getArg( 0 ), 'r' );
} else {
$file = $this->getStdin();
}
# Setup
if ( !$file ) {
$this->fatalError( "Unable to read file, exiting" );
}
if ( $user === false ) {
$wgUser = User::newSystemUser( 'Move page script', [ 'steal' => true ] );
} else {
$wgUser = User::newFromName( $user );
}
if ( !$wgUser ) {
$this->fatalError( "Invalid username" );
}
# Setup complete, now start
$dbw = $this->getDB( DB_MASTER );
for ( $linenum = 1; !feof( $file ); $linenum++ ) {
$line = fgets( $file );
if ( $line === false ) {
break;
}
$parts = array_map( 'trim', explode( '|', $line ) );
if ( count( $parts ) != 2 ) {
$this->error( "Error on line $linenum, no pipe character" );
continue;
}
$source = Title::newFromText( $parts[0] );
$dest = Title::newFromText( $parts[1] );
if ( is_null( $source ) || is_null( $dest ) ) {
$this->error( "Invalid title on line $linenum" );
continue;
}
$this->output( $source->getPrefixedText() . ' --> ' . $dest->getPrefixedText() );
$this->beginTransaction( $dbw, __METHOD__ );
$mp = new MovePage( $source, $dest );
$status = $mp->move( $wgUser, $reason, !$noredirects );
if ( !$status->isOK() ) {
$this->output( "\nFAILED: " . $status->getWikiText( false, false, 'en' ) );
}
$this->commitTransaction( $dbw, __METHOD__ );
$this->output( "\n" );
if ( $interval ) {
sleep( $interval );
}
}
}
}
$maintClass = MoveBatch::class;
require_once RUN_MAINTENANCE_IF_MAIN;