1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
|
<?php
namespace MediaWiki\RenameUser;
use JobQueueGroup;
use JobSpecification;
use ManualLogEntry;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Session\SessionManager;
use MediaWiki\Specials\SpecialLog;
use MediaWiki\Title\TitleFactory;
use MediaWiki\User\User;
use MediaWiki\User\UserFactory;
use Psr\Log\LoggerInterface;
use Wikimedia\Rdbms\IConnectionProvider;
use Wikimedia\Rdbms\IDBAccessObject;
use Wikimedia\Rdbms\SelectQueryBuilder;
/**
* Class which performs the actual renaming of users
*/
class RenameuserSQL {
/**
* The old username of the user being renamed
*
* @var string
*/
public $old;
/**
* The new username of the user being renamed
*
* @var string
*/
public $new;
/**
* The user ID of the user being renamed
*
* @var int
*/
public $uid;
/**
* The [ tables => fields ] to be updated
*
* @var array
*/
public $tables;
/**
* [ tables => fields ] to be updated in a deferred job
*
* @var array[]
*/
public $tablesJob;
/**
* Flag that can be set to false, in case another process has already started
* the updates and the old username may have already been renamed in the user table.
*
* @var bool
*/
public $checkIfUserExists;
/**
* User object of the user performing the rename, for logging purposes
*
* @var User
*/
private $renamer;
/**
* Reason for the rename to be used in the log entry
*
* @var string
*/
private $reason = '';
/**
* A prefix to use in all debug log messages
*
* @var string
*/
private $debugPrefix = '';
// B/C constants for tablesJob field
public const NAME_COL = 0;
public const UID_COL = 1;
public const TIME_COL = 2;
/** @var HookRunner */
private $hookRunner;
/** @var IConnectionProvider */
private $dbProvider;
/** @var UserFactory */
private $userFactory;
/** @var JobQueueGroup */
private $jobQueueGroup;
/** @var TitleFactory */
private $titleFactory;
/** @var LoggerInterface */
private $logger;
/** @var int */
private $updateRowsPerJob;
/**
* Constructor
*
* @param string $old The old username
* @param string $new The new username
* @param int $uid
* @param User $renamer
* @param array $options Optional extra options.
* 'reason' - string, reason for the rename
* 'debugPrefix' - string, prefixed to debug messages
* 'checkIfUserExists' - bool, whether to update the user table
*/
public function __construct( $old, $new, $uid, User $renamer, $options = [] ) {
$services = MediaWikiServices::getInstance();
$this->hookRunner = new HookRunner( $services->getHookContainer() );
$this->dbProvider = $services->getConnectionProvider();
$this->userFactory = $services->getUserFactory();
$this->jobQueueGroup = $services->getJobQueueGroup();
$this->titleFactory = $services->getTitleFactory();
$this->logger = LoggerFactory::getInstance( 'Renameuser' );
$config = $services->getMainConfig();
$this->updateRowsPerJob = $config->get( MainConfigNames::UpdateRowsPerJob );
$this->old = $old;
$this->new = $new;
$this->uid = $uid;
$this->renamer = $renamer;
$this->checkIfUserExists = true;
if ( isset( $options['checkIfUserExists'] ) ) {
$this->checkIfUserExists = $options['checkIfUserExists'];
}
if ( isset( $options['debugPrefix'] ) ) {
$this->debugPrefix = $options['debugPrefix'];
}
if ( isset( $options['reason'] ) ) {
$this->reason = $options['reason'];
}
$this->tables = []; // Immediate updates
$this->tablesJob = []; // Slow updates
$this->hookRunner->onRenameUserSQL( $this );
}
protected function debug( $msg ) {
if ( $this->debugPrefix ) {
$msg = "{$this->debugPrefix}: $msg";
}
$this->logger->debug( $msg );
}
/**
* Do the rename operation
* @return bool
*/
public function rename() {
$dbw = $this->dbProvider->getPrimaryDatabase();
$atomicId = $dbw->startAtomic( __METHOD__, $dbw::ATOMIC_CANCELABLE );
$this->hookRunner->onRenameUserPreRename( $this->uid, $this->old, $this->new );
// Make sure the user exists if needed
if ( $this->checkIfUserExists && !$this->lockUserAndGetId( $this->old ) ) {
$this->debug( "User {$this->old} does not exist, bailing out" );
$dbw->cancelAtomic( __METHOD__, $atomicId );
return false;
}
// Grab the user's edit count before any updates are made; used later in a log entry
$contribs = $this->userFactory->newFromId( $this->uid )->getEditCount();
// Rename and touch the user before re-attributing edits to avoid users still being
// logged in and making new edits (under the old name) while being renamed.
$this->debug( "Starting rename of {$this->old} to {$this->new}" );
$dbw->newUpdateQueryBuilder()
->update( 'user' )
->set( [ 'user_name' => $this->new, 'user_touched' => $dbw->timestamp() ] )
->where( [ 'user_name' => $this->old, 'user_id' => $this->uid ] )
->caller( __METHOD__ )->execute();
$dbw->newUpdateQueryBuilder()
->update( 'actor' )
->set( [ 'actor_name' => $this->new ] )
->where( [ 'actor_name' => $this->old, 'actor_user' => $this->uid ] )
->caller( __METHOD__ )->execute();
// Reset token to break login with central auth systems.
// Again, avoids user being logged in with old name.
$user = $this->userFactory->newFromId( $this->uid );
$user->load( IDBAccessObject::READ_LATEST );
SessionManager::singleton()->invalidateSessionsForUser( $user );
// Purge user cache
$user->invalidateCache();
// Update the block_target table rows if this user has a block in there.
$dbw->newUpdateQueryBuilder()
->update( 'block_target' )
->set( [ 'bt_user_text' => $this->new ] )
->where( [ 'bt_user' => $this->uid, 'bt_user_text' => $this->old ] )
->caller( __METHOD__ )->execute();
// Update this users block/rights log. Ideally, the logs would be historical,
// but it is really annoying when users have "clean" block logs by virtue of
// being renamed, which makes admin tasks more of a pain...
$oldTitle = $this->titleFactory->makeTitle( NS_USER, $this->old );
$newTitle = $this->titleFactory->makeTitle( NS_USER, $this->new );
$this->debug( "Updating logging table for {$this->old} to {$this->new}" );
// Exclude user renames per T200731
$logTypesOnUser = array_diff( SpecialLog::getLogTypesOnUser(), [ 'renameuser' ] );
$dbw->newUpdateQueryBuilder()
->update( 'logging' )
->set( [ 'log_title' => $newTitle->getDBkey() ] )
->where( [
'log_type' => $logTypesOnUser,
'log_namespace' => NS_USER,
'log_title' => $oldTitle->getDBkey()
] )
->caller( __METHOD__ )->execute();
$this->debug( "Updating recentchanges table for rename from {$this->old} to {$this->new}" );
$dbw->newUpdateQueryBuilder()
->update( 'recentchanges' )
->set( [ 'rc_title' => $newTitle->getDBkey() ] )
->where( [
'rc_type' => RC_LOG,
'rc_log_type' => $logTypesOnUser,
'rc_namespace' => NS_USER,
'rc_title' => $oldTitle->getDBkey()
] )
->caller( __METHOD__ )->execute();
// Do immediate re-attribution table updates...
foreach ( $this->tables as $table => $fieldSet ) {
[ $nameCol, $userCol ] = $fieldSet;
$dbw->newUpdateQueryBuilder()
->update( $table )
->set( [ $nameCol => $this->new ] )
->where( [ $nameCol => $this->old, $userCol => $this->uid ] )
->caller( __METHOD__ )->execute();
}
/** @var RenameUserJob[] $jobs */
$jobs = []; // jobs for all tables
// Construct jobqueue updates...
// FIXME: if a bureaucrat renames a user in error, he/she
// must be careful to wait until the rename finishes before
// renaming back. This is due to the fact the job "queue"
// is not really FIFO, so we might end up with a bunch of edits
// randomly mixed between the two new names. Some sort of rename
// lock might be in order...
foreach ( $this->tablesJob as $table => $params ) {
$userTextC = $params[self::NAME_COL]; // some *_user_text column
$userIDC = $params[self::UID_COL]; // some *_user column
$timestampC = $params[self::TIME_COL]; // some *_timestamp column
$res = $dbw->newSelectQueryBuilder()
->select( [ $timestampC ] )
->from( $table )
->where( [ $userTextC => $this->old, $userIDC => $this->uid ] )
->orderBy( $timestampC, SelectQueryBuilder::SORT_ASC )
->caller( __METHOD__ )->fetchResultSet();
$jobParams = [];
$jobParams['table'] = $table;
$jobParams['column'] = $userTextC;
$jobParams['uidColumn'] = $userIDC;
$jobParams['timestampColumn'] = $timestampC;
$jobParams['oldname'] = $this->old;
$jobParams['newname'] = $this->new;
$jobParams['userID'] = $this->uid;
// Timestamp column data for index optimizations
$jobParams['minTimestamp'] = '0';
$jobParams['maxTimestamp'] = '0';
$jobParams['count'] = 0;
// Unique column for replica lag avoidance
if ( isset( $params['uniqueKey'] ) ) {
$jobParams['uniqueKey'] = $params['uniqueKey'];
}
// Insert jobs into queue!
foreach ( $res as $row ) {
// Since the ORDER BY is ASC, set the min timestamp with first row
if ( $jobParams['count'] === 0 ) {
$jobParams['minTimestamp'] = $row->$timestampC;
}
// Keep updating the last timestamp, so it should be correct
// when the last item is added.
$jobParams['maxTimestamp'] = $row->$timestampC;
// Update row counter
$jobParams['count']++;
// Once a job has $wgUpdateRowsPerJob rows, add it to the queue
if ( $jobParams['count'] >= $this->updateRowsPerJob ) {
$jobs[] = new JobSpecification( 'renameUser', $jobParams, [], $oldTitle );
$jobParams['minTimestamp'] = '0';
$jobParams['maxTimestamp'] = '0';
$jobParams['count'] = 0;
}
}
// If there are any job rows left, add it to the queue as one job
if ( $jobParams['count'] > 0 ) {
$jobs[] = new JobSpecification( 'renameUser', $jobParams, [], $oldTitle );
}
}
// Log it!
$logEntry = new ManualLogEntry( 'renameuser', 'renameuser' );
$logEntry->setPerformer( $this->renamer );
$logEntry->setTarget( $oldTitle );
$logEntry->setComment( $this->reason );
$logEntry->setParameters( [
'4::olduser' => $this->old,
'5::newuser' => $this->new,
'6::edits' => $contribs
] );
$logid = $logEntry->insert();
// Insert any jobs as needed. If this fails, then an exception will be thrown and the
// DB transaction will be rolled back. If it succeeds but the DB commit fails, then the
// jobs will see that the transaction was not committed and will cancel themselves.
$count = count( $jobs );
if ( $count > 0 ) {
$this->jobQueueGroup->push( $jobs );
$this->debug( "Queued $count jobs for rename from {$this->old} to {$this->new}" );
}
// Commit the transaction
$dbw->endAtomic( __METHOD__ );
$fname = __METHOD__;
$dbw->onTransactionCommitOrIdle(
function () use ( $dbw, $logEntry, $logid, $fname ) {
$dbw->startAtomic( $fname );
// Clear caches and inform authentication plugins
$user = $this->userFactory->newFromId( $this->uid );
$user->load( IDBAccessObject::READ_LATEST );
// Trigger the UserSaveSettings hook
$user->saveSettings();
$this->hookRunner->onRenameUserComplete( $this->uid, $this->old, $this->new );
// Publish to RC
$logEntry->publish( $logid );
$dbw->endAtomic( $fname );
},
$fname
);
$this->debug( "Finished rename from {$this->old} to {$this->new}" );
return true;
}
/**
* @param string $name Current wiki local username
* @return int Returns 0 if no row was found
*/
private function lockUserAndGetId( $name ) {
return (int)$this->dbProvider->getPrimaryDatabase()->newSelectQueryBuilder()
->select( 'user_id' )
->forUpdate()
->from( 'user' )
->where( [ 'user_name' => $name ] )
->caller( __METHOD__ )->fetchField();
}
}
|