MediaWiki REL1_28
Go to the documentation of this file.
24require_once __DIR__ . '/Maintenance.php';
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 }
40 public function execute() {
41 $count = 0;
42 $oldGroup = $this->getArg( 0 );
43 $newGroup = $this->getArg( 1 );
44 $dbw = $this->getDB( DB_MASTER );
45 $start = $dbw->selectField( 'user_groups', 'MIN(ug_user)',
46 [ 'ug_group' => $oldGroup ], __FUNCTION__ );
47 $end = $dbw->selectField( 'user_groups', 'MAX(ug_user)',
48 [ '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" );
61 $this->beginTransaction( $dbw, __METHOD__ );
62 $dbw->update( 'user_groups',
63 [ 'ug_group' => $newGroup ],
64 [ 'ug_group' => $oldGroup,
65 "ug_user BETWEEN $blockStart AND $blockEnd" ],
66 __METHOD__,
67 [ '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 [ 'ug_group' => $oldGroup,
76 "ug_user BETWEEN $blockStart AND $blockEnd" ],
77 __METHOD__
78 );
79 $affected += $dbw->affectedRows();
80 $this->commitTransaction( $dbw, __METHOD__ );
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 [ '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 }
99 $count += $affected;
100 $blockStart += $this->mBatchSize;
101 $blockEnd += $this->mBatchSize;
103 }
104 $this->output( "Done! $count users in group '$oldGroup' are now in '$newGroup' instead.\n" );
105 }
108$maintClass = "MigrateUserGroup";
109require_once RUN_MAINTENANCE_IF_MAIN;
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
error( $err, $die=0)
Throw an error to the user.
addArg( $arg, $description, $required=true)
Add some args that are needed.
int $mBatchSize
Batch size.
beginTransaction(IDatabase $dbw, $fname)
Begin a transcation on a DB.
commitTransaction(IDatabase $dbw, $fname)
Commit the transcation on a DB handle and wait for replica DBs to catch up.
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
getArg( $argId=0, $default=null)
Get an argument.
addDescription( $text)
Set the description text.
setBatchSize( $s=0)
Set the batch size.
Maintenance script that re-assigns users from an old group to a new one.
Do the actual work.
Default constructor.
Definition database.txt:21
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
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
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 local account $user
Definition hooks.txt:249
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
Definition defines.php:23