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