MediaWiki  master
moveBatch.php
Go to the documentation of this file.
1 <?php
39 
40 require_once __DIR__ . '/Maintenance.php';
41 
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 );
56  }
57 
58  public function execute() {
59  global $wgUser;
60 
61  # Change to current working directory
62  $oldCwd = getcwd();
63  chdir( $oldCwd );
64 
65  # Options processing
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' );
72  } else {
73  $file = $this->getStdin();
74  }
75 
76  # Setup
77  if ( !$file ) {
78  $this->fatalError( "Unable to read file, exiting" );
79  }
80  if ( $user === false ) {
81  $wgUser = User::newSystemUser( 'Move page script', [ 'steal' => true ] );
82  } else {
83  $wgUser = User::newFromName( $user );
84  }
85  if ( !$wgUser ) {
86  $this->fatalError( "Invalid username" );
87  }
88 
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 ) {
94  break;
95  }
96  $parts = array_map( 'trim', explode( '|', $line ) );
97  if ( count( $parts ) != 2 ) {
98  $this->error( "Error on line $linenum, no pipe character" );
99  continue;
100  }
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" );
105  continue;
106  }
107 
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' ) );
115  }
116  $this->commitTransaction( $dbw, __METHOD__ );
117  $this->output( "\n" );
118 
119  if ( $interval ) {
120  sleep( $interval );
121  }
122  }
123  }
124 }
125 
126 $maintClass = MoveBatch::class;
127 require_once RUN_MAINTENANCE_IF_MAIN;
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Item class for a filearchive table row.
Definition: router.php:42
commitTransaction(IDatabase $dbw, $fname)
Commit the transcation on a DB handle and wait for replica DBs to catch up.
getArg( $argId=0, $default=null)
Get an argument.
const RUN_MAINTENANCE_IF_MAIN
Definition: Maintenance.php:39
error( $err, $die=0)
Throw an error to the user.
getOption( $name, $default=null)
Get an option, or return the default.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: Maintenance.php:82
$source
hasOption( $name)
Checks to see if a particular option exists.
const DB_MASTER
Definition: defines.php:26
hasArg( $argId=0)
Does a given argument exist?
$maintClass
Definition: moveBatch.php:126
addDescription( $text)
Set the description text.
addArg( $arg, $description, $required=true)
Add some args that are needed.
__construct()
Definition: moveBatch.php:48
output( $out, $channel=null)
Throw some output to the user.
Maintenance script to move a batch of pages.
Definition: moveBatch.php:47
$line
Definition: cdb.php:59
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getStdin( $len=null)
Return input from stdin.
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:515
getDB( $db, $groups=[], $dbDomain=false)
Returns a database to be used by current maintenance script.
static newSystemUser( $name, $options=[])
Static factory method for creation of a "system" user from username.
Definition: User.php:737
beginTransaction(IDatabase $dbw, $fname)
Begin a transcation on a DB.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:316