MediaWiki  1.23.0
migrateUserGroup.php
Go to the documentation of this file.
1 <?php
24 require_once __DIR__ . '/Maintenance.php';
25 
32  public function __construct() {
33  parent::__construct();
34  $this->mDescription = "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 );
38  }
39 
40  public function execute() {
41  $count = 0;
42  $oldGroup = $this->getArg( 0 );
43  $newGroup = $this->getArg( 1 );
44  $dbw = wfGetDB( DB_MASTER );
45  $start = $dbw->selectField( 'user_groups', 'MIN(ug_user)',
46  array( 'ug_group' => $oldGroup ), __FUNCTION__ );
47  $end = $dbw->selectField( 'user_groups', 'MAX(ug_user)',
48  array( 'ug_group' => $oldGroup ), __FUNCTION__ );
49  if ( $start === null ) {
50  $this->error( "Nothing to do - no users in the '$oldGroup' group", true );
51  }
52  # Do remaining chunk
53  $end += $this->mBatchSize - 1;
54  $blockStart = $start;
55  $blockEnd = $start + $this->mBatchSize - 1;
56  // Migrate users over in batches...
57  while ( $blockEnd <= $end ) {
58  $affected = 0;
59  $this->output( "Doing users $blockStart to $blockEnd\n" );
60 
61  $dbw->begin( __METHOD__ );
62  $dbw->update( 'user_groups',
63  array( 'ug_group' => $newGroup ),
64  array( 'ug_group' => $oldGroup,
65  "ug_user BETWEEN $blockStart AND $blockEnd" ),
66  __METHOD__,
67  array( 'IGNORE' )
68  );
69  $affected += $dbw->affectedRows();
70  // Delete rows that the UPDATE operation above had to ignore.
71  // This happens when a user is in both the old and new group.
72  // Updating the row for the old group membership failed since
73  // user/group is UNIQUE.
74  $dbw->delete( 'user_groups',
75  array( 'ug_group' => $oldGroup,
76  "ug_user BETWEEN $blockStart AND $blockEnd" ),
77  __METHOD__
78  );
79  $affected += $dbw->affectedRows();
80  $dbw->commit( __METHOD__ );
81 
82  // Clear cache for the affected users (bug 40340)
83  if ( $affected > 0 ) {
84  // XXX: This also invalidates cache of unaffected users that
85  // were in the new group and not in the group.
86  $res = $dbw->select( 'user_groups', 'ug_user',
87  array( 'ug_group' => $newGroup,
88  "ug_user BETWEEN $blockStart AND $blockEnd" ),
89  __METHOD__
90  );
91  if ( $res !== false ) {
92  foreach ( $res as $row ) {
93  $user = User::newFromId( $row->ug_user );
94  $user->invalidateCache();
95  }
96  }
97  }
98 
99  $count += $affected;
100  $blockStart += $this->mBatchSize;
101  $blockEnd += $this->mBatchSize;
102  wfWaitForSlaves();
103  }
104  $this->output( "Done! $count users in group '$oldGroup' are now in '$newGroup' instead.\n" );
105  }
106 }
107 
108 $maintClass = "MigrateUserGroup";
109 require_once RUN_MAINTENANCE_IF_MAIN;
Maintenance\$mBatchSize
int $mBatchSize
Batch size.
Definition: Maintenance.php:97
User\newFromId
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:411
DB_MASTER
const DB_MASTER
Definition: Defines.php:56
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
wfGetDB
& wfGetDB( $db, $groups=array(), $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:3650
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
MigrateUserGroup\execute
execute()
Do the actual work.
Definition: migrateUserGroup.php:40
$maintClass
$maintClass
Definition: migrateUserGroup.php:108
MigrateUserGroup
Maintenance script that re-assigns users from an old group to a new one.
Definition: migrateUserGroup.php:31
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
wfWaitForSlaves
wfWaitForSlaves( $maxLag=false, $wiki=false, $cluster=false)
Modern version of wfWaitForSlaves().
Definition: GlobalFunctions.php:3795
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:237
$count
$count
Definition: UtfNormalTest2.php:96
Maintenance\addArg
addArg( $arg, $description, $required=true)
Add some args that are needed.
Definition: Maintenance.php:207
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:333
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:314
Maintenance\getArg
getArg( $argId=0, $default=null)
Get an argument.
Definition: Maintenance.php:246
MigrateUserGroup\__construct
__construct()
Default constructor.
Definition: migrateUserGroup.php:32
$res
$res
Definition: database.txt:21
Maintenance\setBatchSize
setBatchSize( $s=0)
Set the batch size.
Definition: Maintenance.php:254