MediaWiki  REL1_31
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->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 );
38  }
39 
40  public function execute() {
41  $count = 0;
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" );
52  }
53  # Do remaining chunk
54  $end += $batchSize - 1;
55  $blockStart = $start;
56  $blockEnd = $start + $batchSize - 1;
57  // Migrate users over in batches...
58  while ( $blockEnd <= $end ) {
59  $affected = 0;
60  $this->output( "Doing users $blockStart to $blockEnd\n" );
61 
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 ],
67  __METHOD__,
68  [ 'IGNORE' ]
69  );
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 ],
78  __METHOD__
79  );
80  $affected += $dbw->affectedRows();
81  $this->commitTransaction( $dbw, __METHOD__ );
82 
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 ],
90  __METHOD__
91  );
92  if ( $res !== false ) {
93  foreach ( $res as $row ) {
94  $user = User::newFromId( $row->ug_user );
95  $user->invalidateCache();
96  }
97  }
98  }
99 
100  $count += $affected;
101  $blockStart += $batchSize;
102  $blockEnd += $batchSize;
103  }
104  $this->output( "Done! $count users in group '$oldGroup' are now in '$newGroup' instead.\n" );
105  }
106 }
107 
109 require_once RUN_MAINTENANCE_IF_MAIN;
$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:247
User\newFromId
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:614
Maintenance\fatalError
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition: Maintenance.php:439
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:291
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
$res
$res
Definition: database.txt:21
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
MigrateUserGroup\execute
execute()
Do the actual work.
Definition: migrateUserGroup.php:40
$maintClass
$maintClass
Definition: migrateUserGroup.php:108
Maintenance\beginTransaction
beginTransaction(IDatabase $dbw, $fname)
Begin a transcation on a DB.
Definition: Maintenance.php:1336
MigrateUserGroup
Maintenance script that re-assigns users from an old group to a new one.
Definition: migrateUserGroup.php:31
DB_MASTER
const DB_MASTER
Definition: defines.php:29
Maintenance\commitTransaction
commitTransaction(IDatabase $dbw, $fname)
Commit the transcation on a DB handle and wait for replica DBs to catch up.
Definition: Maintenance.php:1351
Maintenance\addArg
addArg( $arg, $description, $required=true)
Add some args that are needed.
Definition: Maintenance.php:271
Maintenance\getBatchSize
getBatchSize()
Returns batch size.
Definition: Maintenance.php:321
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:22
Maintenance\getDB
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
Definition: Maintenance.php:1309
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:388
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
Maintenance\getArg
getArg( $argId=0, $default=null)
Get an argument.
Definition: Maintenance.php:310
MigrateUserGroup\__construct
__construct()
Default constructor.
Definition: migrateUserGroup.php:32
Maintenance\setBatchSize
setBatchSize( $s=0)
Set the batch size.
Definition: Maintenance.php:329