MediaWiki  master
renameUsersMatchingPattern.php
Go to the documentation of this file.
1 <?php
2 
10 
11 require_once __DIR__ . '/Maintenance.php';
12 
15  private $userFactory;
16 
18  private $movePageFactory;
19 
21  private $titleFactory;
22 
24  private $performer;
25 
27  private $reason;
28 
30  private $dryRun;
31 
33  private $suppressRedirect;
34 
36  private $skipPageMoves;
37 
38  public function __construct() {
39  parent::__construct();
40 
41  $this->addDescription( 'Rename users with a name matching a pattern. ' .
42  'This can be used to migrate to a temporary user (IP masking) configuration.' );
43  $this->addOption( 'from', 'A username pattern where $1 is ' .
44  'the wildcard standing in for any number of characters. All users ' .
45  'matching this pattern will be renamed.', true, true );
46  $this->addOption( 'to', 'A username pattern where $1 is ' .
47  'the part of the username matched by $1 in --from. Users will be ' .
48  ' renamed to this pattern.', true, true );
49  $this->addOption( 'performer', 'Performer of the rename action', false, true );
50  $this->addOption( 'reason', 'Reason of the rename', false, true );
51  $this->addOption( 'suppress-redirect', 'Don\'t create redirects when moving pages' );
52  $this->addOption( 'skip-page-moves', 'Don\'t move associated user pages' );
53  $this->addOption( 'dry-run', 'Don\'t actually rename the ' .
54  'users, just report what it would do.' );
55  $this->setBatchSize( 1000 );
56  }
57 
58  private function initServices() {
59  $services = $this->getServiceContainer();
60  if ( $services->getCentralIdLookupFactory()->getNonLocalLookup() ) {
61  $this->fatalError( "This script cannot be run when CentralAuth is enabled." );
62  }
63  $this->userFactory = $services->getUserFactory();
64  $this->movePageFactory = $services->getMovePageFactory();
65  $this->titleFactory = $services->getTitleFactory();
66  }
67 
68  public function execute() {
69  $this->initServices();
70 
71  $fromPattern = new Pattern( 'from', $this->getOption( 'from' ) );
72  $toPattern = new Pattern( 'to', $this->getOption( 'to' ) );
73 
74  if ( $this->getOption( 'performer' ) === null ) {
75  $performer = User::newSystemUser( User::MAINTENANCE_SCRIPT_USER, [ 'steal' => true ] );
76  } else {
77  $performer = $this->userFactory->newFromName( $this->getOption( 'performer' ) );
78  }
79  if ( !$performer ) {
80  $this->error( "Unable to get performer account" );
81  return false;
82  }
83  $this->performer = $performer;
84 
85  $this->reason = $this->getOption( 'reason', '' );
86  $this->dryRun = $this->getOption( 'dry-run' );
87  $this->suppressRedirect = $this->getOption( 'suppress-redirect' );
88  $this->skipPageMoves = $this->getOption( 'skip-page-moves' );
89 
90  $dbr = $this->getDB( DB_REPLICA );
91  $batchConds = [];
92  $batchSize = $this->getBatchSize();
93  $numRenamed = 0;
94  do {
95  $res = $dbr->newSelectQueryBuilder()
96  ->select( [ 'user_name' ] )
97  ->from( 'user' )
98  ->where( array_merge(
99  [ 'user_name' . $fromPattern->buildLike( $dbr ) ],
100  $batchConds
101  ) )
102  ->orderBy( 'user_name' )
103  ->limit( $batchSize )
104  ->caller( __METHOD__ )
105  ->fetchResultSet();
106 
107  foreach ( $res as $row ) {
108  $oldName = $row->user_name;
109  $batchConds = [ 'user_name > ' . $dbr->addQuotes( $oldName ) ];
110  $variablePart = $fromPattern->extract( $oldName );
111  if ( $variablePart === null ) {
112  $this->output( "Username \"fromName\" matched the LIKE " .
113  "but does not seem to match the pattern" );
114  continue;
115  }
116  $newName = $toPattern->generate( $variablePart );
117 
118  // Canonicalize
119  $newTitle = $this->titleFactory->makeTitleSafe( NS_USER, $newName );
120  $newUser = $this->userFactory->newFromName( $newName );
121  if ( !$newTitle || !$newUser ) {
122  $this->output( "Cannot rename \"$oldName\" " .
123  "because \"$newName\" is not a valid title\n" );
124  continue;
125  }
126  $newName = $newTitle->getText();
127 
128  // Check destination existence
129  if ( $newUser->isRegistered() ) {
130  $this->output( "Cannot rename \"$oldName\" " .
131  "because \"$newName\" already exists\n" );
132  continue;
133  }
134 
135  $numRenamed += $this->renameUser( $oldName, $newName ) ? 1 : 0;
136  $this->waitForReplication();
137  }
138  } while ( $res->numRows() === $batchSize );
139  $this->output( "Renamed $numRenamed user(s)\n" );
140  return true;
141  }
142 
148  private function renameUser( $oldName, $newName ) {
149  $id = $this->userFactory->newFromName( $oldName )->getId();
150  if ( !$id ) {
151  $this->output( "Cannot rename non-existent user \"$oldName\"" );
152  }
153 
154  if ( $this->dryRun ) {
155  $this->output( "$oldName would be renamed to $newName\n" );
156  } else {
157  $renamer = new RenameuserSQL(
158  $oldName,
159  $newName,
160  $id,
161  $this->performer,
162  [
163  'reason' => $this->reason
164  ]
165  );
166 
167  if ( !$renamer->rename() ) {
168  $this->output( "Unable to rename $oldName" );
169  return false;
170  } else {
171  $this->output( "$oldName was successfully renamed to $newName.\n" );
172  }
173  }
174 
175  if ( $this->skipPageMoves ) {
176  return true;
177  }
178 
179  $this->movePageAndSubpages( NS_USER, 'User', $oldName, $newName );
180  $this->movePageAndSubpages( NS_USER_TALK, 'User talk', $oldName, $newName );
181  return true;
182  }
183 
184  private function movePageAndSubpages( $ns, $nsName, $oldName, $newName ) {
185  $oldTitle = $this->titleFactory->makeTitleSafe( $ns, $oldName );
186  if ( !$oldTitle ) {
187  $this->output( "[[$nsName:$oldName]] is an invalid title, can't move it.\n" );
188  return true;
189  }
190  $newTitle = $this->titleFactory->makeTitleSafe( $ns, $newName );
191  if ( !$newTitle ) {
192  $this->output( "[[$nsName:$newName]] is an invalid title, can't move to it.\n" );
193  return true;
194  }
195 
196  $movePage = $this->movePageFactory->newMovePage( $oldTitle, $newTitle );
197  $movePage->setMaximumMovedPages( -1 );
198 
199  $logMessage = wfMessage(
200  'renameuser-move-log', $oldName, $newName
201  )->inContentLanguage()->text();
202 
203  if ( $this->dryRun ) {
204  if ( $oldTitle->exists() ) {
205  $this->output( "Would move [[$nsName:$oldName]] to [[$nsName:$newName]].\n" );
206  }
207  } else {
208  if ( $oldTitle->exists() ) {
209  $status = $movePage->move(
210  $this->performer, $logMessage, !$this->suppressRedirect );
211  } else {
212  $status = Status::newGood();
213  }
214  $status->merge( $movePage->moveSubpages(
215  $this->performer, $logMessage, !$this->suppressRedirect ) );
216  if ( !$status->isGood() ) {
217  $this->output( "Failed to rename user page: " .
218  $status->getWikiText( false, false, 'en' ) .
219  "\n" );
220  }
221  }
222  return true;
223  }
224 }
225 
226 $maintClass = RenameUsersMatchingPattern::class;
227 require_once RUN_MAINTENANCE_IF_MAIN;
const NS_USER
Definition: Defines.php:66
const NS_USER_TALK
Definition: Defines.php:67
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: Maintenance.php:66
getDB( $db, $groups=[], $dbDomain=false)
Returns a database to be used by current maintenance script.
error( $err, $die=0)
Throw an error to the user.
output( $out, $channel=null)
Throw some output to the user.
waitForReplication()
Wait for replica DBs to catch up.
getServiceContainer()
Returns the main service container.
getBatchSize()
Returns batch size.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
setBatchSize( $s=0)
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Class which performs the actual renaming of users.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:58
Creates Title objects.
Helper for TempUserConfig representing string patterns with "$1" indicating variable substitution.
Definition: Pattern.php:13
Creates User objects.
Definition: UserFactory.php:41
internal since 1.36
Definition: User.php:98
static newFromName( $name, $validate='valid')
Definition: User.php:600
Service for page rename actions.
const DB_REPLICA
Definition: defines.php:26