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
98 lines
3 KiB
PHP
98 lines
3 KiB
PHP
<?php
|
|
/**
|
|
* Protect or unprotect a page.
|
|
*
|
|
* 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
|
|
*/
|
|
|
|
use MediaWiki\Title\Title;
|
|
use MediaWiki\User\User;
|
|
|
|
// @codeCoverageIgnoreStart
|
|
require_once __DIR__ . '/Maintenance.php';
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
/**
|
|
* Maintenance script that protects or unprotects a page.
|
|
*
|
|
* @ingroup Maintenance
|
|
*/
|
|
class Protect extends Maintenance {
|
|
public function __construct() {
|
|
parent::__construct();
|
|
$this->addDescription( 'Protect or unprotect a page from the command line.' );
|
|
$this->addOption( 'unprotect', 'Removes protection' );
|
|
$this->addOption( 'semiprotect', 'Adds semi-protection' );
|
|
$this->addOption( 'cascade', 'Add cascading protection' );
|
|
$this->addOption( 'user', 'Username to protect with', false, true, 'u' );
|
|
$this->addOption( 'reason', 'Reason for un/protection', false, true, 'r' );
|
|
$this->addArg( 'title', 'Title to protect', true );
|
|
}
|
|
|
|
public function execute() {
|
|
$userName = $this->getOption( 'user', false );
|
|
$reason = $this->getOption( 'reason', '' );
|
|
|
|
$cascade = $this->hasOption( 'cascade' );
|
|
|
|
$protection = "sysop";
|
|
if ( $this->hasOption( 'semiprotect' ) ) {
|
|
$protection = "autoconfirmed";
|
|
} elseif ( $this->hasOption( 'unprotect' ) ) {
|
|
$protection = "";
|
|
}
|
|
|
|
if ( $userName === false ) {
|
|
$user = User::newSystemUser( User::MAINTENANCE_SCRIPT_USER, [ 'steal' => true ] );
|
|
} else {
|
|
$user = User::newFromName( $userName );
|
|
}
|
|
if ( !$user ) {
|
|
$this->fatalError( "Invalid username" );
|
|
}
|
|
|
|
$t = Title::newFromText( $this->getArg( 0 ) );
|
|
if ( !$t ) {
|
|
$this->fatalError( "Invalid title" );
|
|
}
|
|
|
|
$services = $this->getServiceContainer();
|
|
$restrictions = [];
|
|
foreach ( $services->getRestrictionStore()->listApplicableRestrictionTypes( $t ) as $type ) {
|
|
$restrictions[$type] = $protection;
|
|
}
|
|
|
|
# un/protect the article
|
|
$this->output( "Updating protection status..." );
|
|
|
|
$page = $services->getWikiPageFactory()->newFromTitle( $t );
|
|
$status = $page->doUpdateRestrictions( $restrictions, [], $cascade, $reason, $user );
|
|
|
|
if ( $status->isOK() ) {
|
|
$this->output( "done\n" );
|
|
} else {
|
|
$this->output( "failed\n" );
|
|
}
|
|
}
|
|
}
|
|
|
|
// @codeCoverageIgnoreStart
|
|
$maintClass = Protect::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|
|
// @codeCoverageIgnoreEnd
|