3 * Move a batch of pages.
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.
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.
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
21 * @ingroup Maintenance
22 * @author Tim Starling
24 * USAGE: php moveBatch.php [-u <user>] [-r <reason>] [-i <interval>] [-noredirects] [listfile]
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
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
38 use MediaWiki\MediaWikiServices
;
40 require_once __DIR__
. '/Maintenance.php';
43 * Maintenance script to move a batch of pages.
45 * @ingroup Maintenance
47 class MoveBatch
extends Maintenance
{
48 public function __construct() {
49 parent
::__construct();
50 $this->addDescription( 'Moves a batch of pages' );
51 $this->addOption( 'u', "User to perform move", false, true );
52 $this->addOption( 'r', "Reason to move page", false, true );
53 $this->addOption( 'i', "Interval to sleep between moves" );
54 $this->addOption( 'noredirects', "Suppress creation of redirects" );
55 $this->addArg( 'listfile', 'List of pages to move, newline delimited', false );
58 public function execute() {
61 # Change to current working directory
66 $user = $this->getOption( 'u', false );
67 $reason = $this->getOption( 'r', '' );
68 $interval = $this->getOption( 'i', 0 );
69 $noredirects = $this->hasOption( 'noredirects' );
70 if ( $this->hasArg( 0 ) ) {
71 $file = fopen( $this->getArg( 0 ), 'r' );
73 $file = $this->getStdin();
78 $this->fatalError( "Unable to read file, exiting" );
80 if ( $user === false ) {
81 $wgUser = User
::newSystemUser( 'Move page script', [ 'steal' => true ] );
83 $wgUser = User
::newFromName( $user );
86 $this->fatalError( "Invalid username" );
89 # Setup complete, now start
90 $dbw = $this->getDB( DB_MASTER
);
91 for ( $linenum = 1; !feof( $file ); $linenum++
) {
92 $line = fgets( $file );
93 if ( $line === false ) {
96 $parts = array_map( 'trim', explode( '|', $line ) );
97 if ( count( $parts ) != 2 ) {
98 $this->error( "Error on line $linenum, no pipe character" );
101 $source = Title
::newFromText( $parts[0] );
102 $dest = Title
::newFromText( $parts[1] );
103 if ( is_null( $source ) ||
is_null( $dest ) ) {
104 $this->error( "Invalid title on line $linenum" );
108 $this->output( $source->getPrefixedText() . ' --> ' . $dest->getPrefixedText() );
109 $this->beginTransaction( $dbw, __METHOD__
);
110 $mp = MediaWikiServices
::getInstance()->getMovePageFactory()
111 ->newMovePage( $source, $dest );
112 $status = $mp->move( $wgUser, $reason, !$noredirects );
113 if ( !$status->isOK() ) {
114 $this->output( "\nFAILED: " . $status->getWikiText( false, false, 'en' ) );
116 $this->commitTransaction( $dbw, __METHOD__
);
117 $this->output( "\n" );
126 $maintClass = MoveBatch
::class;
127 require_once RUN_MAINTENANCE_IF_MAIN
;