Redo addArgs() as addArg() so we can actually do useful things with arguments like...
[lhc/web/wiklou.git] / maintenance / moveBatch.php
1 <?php
2 /**
3 * Maintenance script to 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 * @ingroup Maintenance
21 * @author Tim Starling
22 *
23 * USAGE: php moveBatch.php [-u <user>] [-r <reason>] [-i <interval>] [listfile]
24 *
25 * [listfile] - file with two titles per line, separated with pipe characters;
26 * the first title is the source, the second is the destination.
27 * Standard input is used if listfile is not given.
28 * <user> - username to perform moves as
29 * <reason> - reason to be given for moves
30 * <interval> - number of seconds to sleep after each move
31 *
32 * This will print out error codes from Title::moveTo() if something goes wrong,
33 * e.g. immobile_namespace for namespaces which can't be moved
34 */
35
36 require_once( dirname(__FILE__) . '/Maintenance.php' );
37
38 class MoveBatch extends Maintenance {
39 public function __construct() {
40 parent::__construct();
41 $this->mDescription = "Moves a batch of pages";
42 $this->addOption( 'u', "User to perform move", false, true );
43 $this->addOption( 'r', "Reason to move page", false, true );
44 $this->addOption( 'i', "Interval to sleep between moves" );
45 $this->addArg( 'listfile', 'List of pages to move, newline delimited', false );
46 }
47
48 public function execute() {
49 global $wgUser;
50
51 # Change to current working directory
52 $oldCwd = getcwd();
53 chdir( $oldCwd );
54
55 # Options processing
56 $user = $this->getOption( 'u', 'Move page script' );
57 $reason = $this->getOption( 'r', '' );
58 $interval = $this->getOption( 'i', 0 );
59 if( $this->hasArg() ) {
60 $file = fopen( $this->getArg(), 'r' );
61 } else {
62 $file = $this->getStdin();
63 }
64
65 # Setup
66 if( !$file ) {
67 $this->error( "Unable to read file, exiting", true );
68 }
69 $wgUser = User::newFromName( $user );
70
71 # Setup complete, now start
72 $dbw = wfGetDB( DB_MASTER );
73 for ( $linenum = 1; !feof( $file ); $linenum++ ) {
74 $line = fgets( $file );
75 if ( $line === false ) {
76 break;
77 }
78 $parts = array_map( 'trim', explode( '|', $line ) );
79 if ( count( $parts ) != 2 ) {
80 $this->error( "Error on line $linenum, no pipe character" );
81 continue;
82 }
83 $source = Title::newFromText( $parts[0] );
84 $dest = Title::newFromText( $parts[1] );
85 if ( is_null( $source ) || is_null( $dest ) ) {
86 $this->error( "Invalid title on line $linenum" );
87 continue;
88 }
89
90
91 $this->output( $source->getPrefixedText() . ' --> ' . $dest->getPrefixedText() );
92 $dbw->begin();
93 $err = $source->moveTo( $dest, false, $reason );
94 if( $err !== true ) {
95 $this->output( "\nFAILED: $err" );
96 }
97 $dbw->immediateCommit();
98 $this->output( "\n" );
99
100 if ( $interval ) {
101 sleep( $interval );
102 }
103 wfWaitForSlaves( 5 );
104 }
105 }
106 }
107
108 $maintClass = "MoveBatch";
109 require_once( DO_MAINTENANCE );