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
67 lines
2 KiB
PHP
67 lines
2 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Removes all users from a given user group.
|
|
*
|
|
* 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\User\User;
|
|
|
|
// @codeCoverageIgnoreStart
|
|
require_once __DIR__ . '/Maintenance.php';
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
class EmptyUserGroup extends Maintenance {
|
|
public function __construct() {
|
|
parent::__construct();
|
|
$this->addDescription( 'Remove all users from a given user group' );
|
|
$this->addArg( 'group', 'Group to be removed', true );
|
|
$this->setBatchSize( 100 );
|
|
}
|
|
|
|
public function execute() {
|
|
$group = $this->getArg( 0 );
|
|
$userGroupManager = $this->getServiceContainer()->getUserGroupManager();
|
|
|
|
$totalCount = 0;
|
|
$this->output( "Removing users from $group...\n" );
|
|
while ( true ) {
|
|
$users = User::findUsersByGroup( $group, $this->getBatchSize() );
|
|
if ( iterator_count( $users ) === 0 ) {
|
|
break;
|
|
}
|
|
|
|
foreach ( $users as $user ) {
|
|
$totalCount += (int)$userGroupManager->removeUserFromGroup( $user, $group );
|
|
}
|
|
$this->waitForReplication();
|
|
}
|
|
if ( $totalCount ) {
|
|
$this->output( " ...done! Removed $totalCount users in total.\n" );
|
|
} else {
|
|
$this->output( " ...nothing to do, group was empty.\n" );
|
|
}
|
|
}
|
|
}
|
|
|
|
// @codeCoverageIgnoreStart
|
|
$maintClass = EmptyUserGroup::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|
|
// @codeCoverageIgnoreEnd
|