MediaWiki  master
moveBatch.php
Go to the documentation of this file.
1 <?php
30 
31 require_once __DIR__ . '/Maintenance.php';
32 
38 class MoveBatch extends Maintenance {
39  public function __construct() {
40  parent::__construct();
41  $this->addDescription( '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->addOption( 'noredirects', "Suppress creation of redirects" );
46  $this->addArg( 'listfile', 'List of pages to move, newline delimited', false );
47  }
48 
49  public function execute() {
50  # Options processing
51  $username = $this->getOption( 'u', false );
52  $reason = $this->getOption( 'r', '' );
53  $interval = $this->getOption( 'i', 0 );
54  $noRedirects = $this->hasOption( 'noredirects' );
55  if ( $this->hasArg( 0 ) ) {
56  $file = fopen( $this->getArg( 0 ), 'r' );
57  } else {
58  $file = $this->getStdin();
59  }
60 
61  # Setup
62  if ( !$file ) {
63  $this->fatalError( "Unable to read file, exiting" );
64  }
65  if ( $username === false ) {
66  $user = User::newSystemUser( 'Move page script', [ 'steal' => true ] );
67  } else {
68  $user = User::newFromName( $username );
69  }
70  if ( !$user ) {
71  $this->fatalError( "Invalid username" );
72  }
73  StubGlobalUser::setUser( $user );
74 
75  # Setup complete, now start
76  $dbw = $this->getDB( DB_PRIMARY );
77  for ( $lineNum = 1; !feof( $file ); $lineNum++ ) {
78  $line = fgets( $file );
79  if ( $line === false ) {
80  break;
81  }
82  $parts = array_map( 'trim', explode( '|', $line ) );
83  if ( count( $parts ) !== 2 ) {
84  $this->error( "Error on line $lineNum, no pipe character" );
85  continue;
86  }
87  $source = Title::newFromText( $parts[0] );
88  $dest = Title::newFromText( $parts[1] );
89  if ( $source === null || $dest === null ) {
90  $this->error( "Invalid title on line $lineNum" );
91  continue;
92  }
93 
94  $this->output( $source->getPrefixedText() . ' --> ' . $dest->getPrefixedText() );
95  $this->beginTransaction( $dbw, __METHOD__ );
96  $mp = MediaWikiServices::getInstance()->getMovePageFactory()
97  ->newMovePage( $source, $dest );
98  $status = $mp->move( $user, $reason, !$noRedirects );
99  if ( !$status->isOK() ) {
100  $this->output( "\nFAILED: " . $status->getMessage( false, false, 'en' )->text() );
101  }
102  $this->commitTransaction( $dbw, __METHOD__ );
103  $this->output( "\n" );
104 
105  if ( $interval ) {
106  sleep( $interval );
107  }
108  }
109  }
110 }
111 
112 $maintClass = MoveBatch::class;
113 require_once RUN_MAINTENANCE_IF_MAIN;
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: Maintenance.php:66
getDB( $db, $groups=[], $dbDomain=false)
Returns a database to be used by current maintenance script.
error( $err, $die=0)
Throw an error to the user.
addArg( $arg, $description, $required=true)
Add some args that are needed.
beginTransaction(IDatabase $dbw, $fname)
Begin a transaction on a DB.
commitTransaction(IDatabase $dbw, $fname)
Commit the transaction on a DB handle and wait for replica DBs to catch up.
output( $out, $channel=null)
Throw some output to the user.
getStdin( $len=null)
Return input from stdin.
hasArg( $argId=0)
Does a given argument exist?
hasOption( $name)
Checks to see if a particular option was set.
getArg( $argId=0, $default=null)
Get an argument.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Service locator for MediaWiki core services.
Maintenance script to move a batch of pages.
Definition: moveBatch.php:38
execute()
Do the actual work.
Definition: moveBatch.php:49
__construct()
Default constructor.
Definition: moveBatch.php:39
static setUser( $user)
Reset the stub global user to a different "real" user object, while ensuring that any method calls on...
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:370
static newFromName( $name, $validate='valid')
Definition: User.php:597
static newSystemUser( $name, $options=[])
Static factory method for creation of a "system" user from username.
Definition: User.php:805
$line
Definition: mcc.php:119
$maintClass
Definition: moveBatch.php:112
$source
const DB_PRIMARY
Definition: defines.php:28
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Item class for a filearchive table row.
Definition: router.php:42