Add a maintenance script to remove all users from a User Group

Bug: T185989
Change-Id: Ie5cc95b350230bc730c1f1d9f06fc3e95c5f6bd0

diff --git a/autoload.php b/autoload.php
index d939089..33ee128 100644 (file)
--- a/autoload.php
+++ b/autoload.php
@@ -449,6 +449,7 @@ $wgAutoloadLocalClasses = [
        'EmailNotification' => __DIR__ . '/includes/mail/EmailNotification.php',
        'EmaillingJob' => __DIR__ . '/includes/jobqueue/jobs/EmaillingJob.php',
        'EmptyBagOStuff' => __DIR__ . '/includes/libs/objectcache/EmptyBagOStuff.php',
+       'EmptyUserGroup' => __DIR__ . '/maintenance/emptyUserGroup.php',
        'EnConverter' => __DIR__ . '/languages/classes/LanguageEn.php',
        'EncryptedPassword' => __DIR__ . '/includes/password/EncryptedPassword.php',
        'EnhancedChangesList' => __DIR__ . '/includes/changes/EnhancedChangesList.php',

diff --git a/maintenance/emptyUserGroup.php b/maintenance/emptyUserGroup.php
new file mode 100644 (file)
index 0000000..03a38fc
--- /dev/null
+++ b/maintenance/emptyUserGroup.php
@@ -0,0 +1,61 @@
+<?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
+ */
+
+require_once __DIR__ . '/Maintenance.php';
+
+use MediaWiki\MediaWikiServices;
+
+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 );
+       }
+
+       public function execute() {
+               $group = $this->getArg( 0 );
+
+               $lb = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
+
+               $users = User::findUsersByGroup( $group );
+
+               $count = iterator_count( $users );
+
+               $this->output( "Removing $count users from $group..." );
+
+               /**
+                * @var User $user
+                */
+               foreach ( $users as $user ) {
+                       $user->removeGroup( $group );
+
+                       $lb->waitForReplication();
+               }
+
+               $this->output( " Done!\n" );
+       }
+}
+
+$maintClass = EmptyUserGroup::class;
+require_once RUN_MAINTENANCE_IF_MAIN;