e7393b3cc7
Why: * Maintenance scripts in core have bolierplate code that is added before and after the class to allow directly running the maintenance script. * Running the maintenance script directly has been deprecated since 1.40, so this boilerplate code is only to support a now deprecated method of running maintenance scripts. * This code cannot also be marked as covered, due to PHPUnit not recognising code coverage for files. * Therefore, it is best to ignore this boilerplate code in code coverage reports as it cannot be marked as covered and also is for deprecated code. What: * Wrap the boilerplate code (requiring Maintenance.php and then later defining the maintenance script class and running if the maintenance script was called directly) with @codeCoverageIgnore comments. * Some files use a different boilerplate code, however, these should also be marked as ignored for coverage for the same reason that coverage is not properly reported for files. Bug: T371167 Change-Id: I32f5c6362dfb354149a48ce9c28da9a7fc494f7c
120 lines
3.6 KiB
PHP
120 lines
3.6 KiB
PHP
<?php
|
|
/**
|
|
* Move a batch of pages.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @ingroup Maintenance
|
|
* @author Tim Starling
|
|
*
|
|
*
|
|
* This will print out error codes from Title::moveTo() if something goes wrong,
|
|
* e.g. immobile_namespace for namespaces which can't be moved
|
|
*/
|
|
|
|
use MediaWiki\StubObject\StubGlobalUser;
|
|
use MediaWiki\Title\Title;
|
|
use MediaWiki\User\User;
|
|
|
|
// @codeCoverageIgnoreStart
|
|
require_once __DIR__ . '/Maintenance.php';
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
/**
|
|
* Maintenance script to move a batch of pages.
|
|
*
|
|
* @ingroup Maintenance
|
|
*/
|
|
class MoveBatch extends Maintenance {
|
|
public function __construct() {
|
|
parent::__construct();
|
|
$this->addDescription( 'Moves a batch of pages' );
|
|
$this->addOption( 'u', "User to perform move", false, true );
|
|
$this->addOption( 'r', "Reason to move page", false, true );
|
|
$this->addOption( 'i', "Interval to sleep between moves" );
|
|
$this->addOption( 'noredirects', "Suppress creation of redirects" );
|
|
$this->addArg( 'listfile', 'List of pages to move, newline delimited', false );
|
|
}
|
|
|
|
public function execute() {
|
|
# Options processing
|
|
$username = $this->getOption( 'u', false );
|
|
$reason = $this->getOption( 'r', '' );
|
|
$interval = $this->getOption( 'i', 0 );
|
|
$noRedirects = $this->hasOption( 'noredirects' );
|
|
if ( $this->hasArg( 0 ) ) {
|
|
$file = fopen( $this->getArg( 0 ), 'r' );
|
|
} else {
|
|
$file = $this->getStdin();
|
|
}
|
|
|
|
# Setup
|
|
if ( !$file ) {
|
|
$this->fatalError( "Unable to read file, exiting" );
|
|
}
|
|
if ( $username === false ) {
|
|
$user = User::newSystemUser( 'Move page script', [ 'steal' => true ] );
|
|
} else {
|
|
$user = User::newFromName( $username );
|
|
}
|
|
if ( !$user ) {
|
|
$this->fatalError( "Invalid username" );
|
|
}
|
|
StubGlobalUser::setUser( $user );
|
|
|
|
# Setup complete, now start
|
|
$dbw = $this->getPrimaryDB();
|
|
for ( $lineNum = 1; !feof( $file ); $lineNum++ ) {
|
|
$line = fgets( $file );
|
|
if ( $line === false ) {
|
|
break;
|
|
}
|
|
$parts = array_map( 'trim', explode( '|', $line ) );
|
|
if ( count( $parts ) !== 2 ) {
|
|
$this->error( "Error on line $lineNum, no pipe character" );
|
|
continue;
|
|
}
|
|
$source = Title::newFromText( $parts[0] );
|
|
$dest = Title::newFromText( $parts[1] );
|
|
if ( $source === null || $dest === null ) {
|
|
$this->error( "Invalid title on line $lineNum" );
|
|
continue;
|
|
}
|
|
|
|
$this->output( $source->getPrefixedText() . ' --> ' . $dest->getPrefixedText() );
|
|
$this->beginTransaction( $dbw, __METHOD__ );
|
|
$mp = $this->getServiceContainer()->getMovePageFactory()
|
|
->newMovePage( $source, $dest );
|
|
$status = $mp->move( $user, $reason, !$noRedirects );
|
|
if ( !$status->isOK() ) {
|
|
$this->output( " FAILED\n" );
|
|
$this->error( $status );
|
|
}
|
|
$this->commitTransaction( $dbw, __METHOD__ );
|
|
$this->output( "\n" );
|
|
|
|
if ( $interval ) {
|
|
sleep( $interval );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// @codeCoverageIgnoreStart
|
|
$maintClass = MoveBatch::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|
|
// @codeCoverageIgnoreEnd
|