1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
<?php
/**
* Re-assign users from an old group to a new one
*
* 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
/**
* Maintenance script that re-assigns users from an old group to a new one.
*
* @ingroup Maintenance
*/
class MigrateUserGroup extends Maintenance {
public function __construct() {
parent::__construct();
$this->addDescription( 'Re-assign users from an old group to a new one' );
$this->addArg( 'oldgroup', 'Old user group key', true );
$this->addArg( 'newgroup', 'New user group key', true );
$this->setBatchSize( 200 );
}
public function execute() {
$count = 0;
$oldGroup = $this->getArg( 0 );
$newGroup = $this->getArg( 1 );
$dbw = $this->getPrimaryDB();
$batchSize = $this->getBatchSize();
$userGroupManager = $this->getServiceContainer()->getUserGroupManager();
$start = $dbw->newSelectQueryBuilder()
->select( 'MIN(ug_user)' )
->from( 'user_groups' )
->where( [ 'ug_group' => $oldGroup ] )
->caller( __FUNCTION__ )->fetchField();
$end = $dbw->newSelectQueryBuilder()
->select( 'MAX(ug_user)' )
->from( 'user_groups' )
->where( [ 'ug_group' => $oldGroup ] )
->caller( __FUNCTION__ )->fetchField();
if ( $start === null ) {
$this->fatalError( "Nothing to do - no users in the '$oldGroup' group" );
}
# Do remaining chunk
$end += $batchSize - 1;
$blockStart = $start;
$blockEnd = $start + $batchSize - 1;
// Migrate users over in batches...
while ( $blockEnd <= $end ) {
$affected = 0;
$this->output( "Doing users $blockStart to $blockEnd\n" );
$this->beginTransaction( $dbw, __METHOD__ );
// Find the users already in the new group, so that we can exclude them from the UPDATE query
// and instead delete the rows.
$usersAlreadyInNewGroup = $dbw->newSelectQueryBuilder()
->select( 'ug_user' )
->from( 'user_groups' )
->where( [
'ug_group' => $newGroup,
$dbw->expr( 'ug_user', '>=', (int)$blockStart ),
$dbw->expr( 'ug_user', '<=', (int)$blockEnd ),
] )
->caller( __METHOD__ )
->fetchFieldValues();
// Update the user group for the users which do not already have the new group.
$updateQueryBuilder = $dbw->newUpdateQueryBuilder()
->update( 'user_groups' )
->set( [ 'ug_group' => $newGroup ] )
->where( [
'ug_group' => $oldGroup,
$dbw->expr( 'ug_user', '>=', (int)$blockStart ),
$dbw->expr( 'ug_user', '<=', (int)$blockEnd ),
] )
->caller( __METHOD__ );
if ( count( $usersAlreadyInNewGroup ) ) {
$updateQueryBuilder->where( $dbw->expr( 'ug_user', '!=', $usersAlreadyInNewGroup ) );
}
$updateQueryBuilder->execute();
$affected += $dbw->affectedRows();
// Delete rows that the UPDATE operation above had to ignore.
// This happens when a user is in both the old and new group, and as such the UPDATE would have failed.
if ( count( $usersAlreadyInNewGroup ) ) {
$dbw->newDeleteQueryBuilder()
->deleteFrom( 'user_groups' )
->where( [
'ug_group' => $oldGroup,
$dbw->expr( 'ug_user', '=', $usersAlreadyInNewGroup ),
] )
->caller( __METHOD__ )->execute();
$affected += $dbw->affectedRows();
}
$this->commitTransaction( $dbw, __METHOD__ );
// Clear cache for the affected users (T42340)
if ( $affected > 0 ) {
// XXX: This also invalidates cache of unaffected users that
// were in the new group and not in the group.
$res = $dbw->newSelectQueryBuilder()
->select( 'ug_user' )
->from( 'user_groups' )
->where( [
'ug_group' => $newGroup,
$dbw->expr( 'ug_user', '>=', (int)$blockStart ),
$dbw->expr( 'ug_user', '<=', (int)$blockEnd ),
] )
->caller( __METHOD__ )->fetchResultSet();
if ( $res !== false ) {
foreach ( $res as $row ) {
$user = User::newFromId( $row->ug_user );
$user->invalidateCache();
$userGroupManager->clearCache( $user );
}
}
}
$count += $affected;
$blockStart += $batchSize;
$blockEnd += $batchSize;
}
$this->output( "Done! $count users in group '$oldGroup' are now in '$newGroup' instead.\n" );
}
}
// @codeCoverageIgnoreStart
$maintClass = MigrateUserGroup::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd
|
