maintenance/migrateUserGroup.php

   1 <?php
   2 /**
   3  * Re-assign users from an old group to a new one
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup Maintenance
  22  */
  23
  24 require_once( __DIR__ . '/Maintenance.php' );
  25
  26 /**
  27  * Maintenance script that re-assigns users from an old group to a new one.
  28  *
  29  * @ingroup Maintenance
  30  */
  31 class MigrateUserGroup extends Maintenance {
  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                         $this->output( "Doing users $blockStart to $blockEnd\n" );
  59                         $dbw->begin( __METHOD__ );
  60                         $dbw->update( 'user_groups',
  61                                 array( 'ug_group' => $newGroup ),
  62                                 array( 'ug_group' => $oldGroup,
  63                                         "ug_user BETWEEN $blockStart AND $blockEnd" )
  64                         );
  65                         $count += $dbw->affectedRows();
  66                         $dbw->commit( __METHOD__ );
  67                         $blockStart += $this->mBatchSize;
  68                         $blockEnd += $this->mBatchSize;
  69                         wfWaitForSlaves();
  70                 }
  71                 $this->output( "Done! $count user(s) in group '$oldGroup' are now in '$newGroup' instead.\n" );
  72         }
  73 }
  74
  75 $maintClass = "MigrateUserGroup";
  76 require_once( RUN_MAINTENANCE_IF_MAIN );