3 * Re-assign users from an old group to a new one
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup Maintenance
24 require_once __DIR__
. '/Maintenance.php';
27 * Maintenance script that re-assigns users from an old group to a new one.
29 * @ingroup Maintenance
31 class MigrateUserGroup
extends Maintenance
{
32 public function __construct() {
33 parent
::__construct();
34 $this->addDescription( 'Re-assign users from an old group to a new one' );
35 $this->addArg( 'oldgroup', 'Old user group key', true );
36 $this->addArg( 'newgroup', 'New user group key', true );
37 $this->setBatchSize( 200 );
40 public function execute() {
42 $oldGroup = $this->getArg( 0 );
43 $newGroup = $this->getArg( 1 );
44 $dbw = $this->getDB( DB_MASTER
);
45 $batchSize = $this->getBatchSize();
46 $start = $dbw->selectField( 'user_groups', 'MIN(ug_user)',
47 [ 'ug_group' => $oldGroup ], __FUNCTION__
);
48 $end = $dbw->selectField( 'user_groups', 'MAX(ug_user)',
49 [ 'ug_group' => $oldGroup ], __FUNCTION__
);
50 if ( $start === null ) {
51 $this->fatalError( "Nothing to do - no users in the '$oldGroup' group" );
54 $end +
= $batchSize - 1;
56 $blockEnd = $start +
$batchSize - 1;
57 // Migrate users over in batches...
58 while ( $blockEnd <= $end ) {
60 $this->output( "Doing users $blockStart to $blockEnd\n" );
62 $this->beginTransaction( $dbw, __METHOD__
);
63 $dbw->update( 'user_groups',
64 [ 'ug_group' => $newGroup ],
65 [ 'ug_group' => $oldGroup,
66 "ug_user BETWEEN " . (int)$blockStart . " AND " . (int)$blockEnd ],
70 $affected +
= $dbw->affectedRows();
71 // Delete rows that the UPDATE operation above had to ignore.
72 // This happens when a user is in both the old and new group.
73 // Updating the row for the old group membership failed since
74 // user/group is UNIQUE.
75 $dbw->delete( 'user_groups',
76 [ 'ug_group' => $oldGroup,
77 "ug_user BETWEEN " . (int)$blockStart . " AND " . (int)$blockEnd ],
80 $affected +
= $dbw->affectedRows();
81 $this->commitTransaction( $dbw, __METHOD__
);
83 // Clear cache for the affected users (T42340)
84 if ( $affected > 0 ) {
85 // XXX: This also invalidates cache of unaffected users that
86 // were in the new group and not in the group.
87 $res = $dbw->select( 'user_groups', 'ug_user',
88 [ 'ug_group' => $newGroup,
89 "ug_user BETWEEN " . (int)$blockStart . " AND " . (int)$blockEnd ],
92 if ( $res !== false ) {
93 foreach ( $res as $row ) {
94 $user = User
::newFromId( $row->ug_user
);
95 $user->invalidateCache();
101 $blockStart +
= $batchSize;
102 $blockEnd +
= $batchSize;
104 $this->output( "Done! $count users in group '$oldGroup' are now in '$newGroup' instead.\n" );
108 $maintClass = MigrateUserGroup
::class;
109 require_once RUN_MAINTENANCE_IF_MAIN
;