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
|
<?php
namespace MediaWiki\RenameUser;
use InvalidArgumentException;
use Job;
use MediaWiki\Config\Config;
use MediaWiki\MainConfigNames;
use MediaWiki\Title\Title;
use Wikimedia\Rdbms\ILBFactory;
/**
* Custom job to perform updates on tables in busier environments
*
* Job parameters include:
* - table : DB table to update
* - column : The *_user_text column to update
* - oldname : The old user name
* - newname : The new user name
* - count : The expected number of rows to update in this batch
*
* Additionally, one of the following groups of parameters must be set:
* a) The timestamp based rename parameters:
* - timestampColumn : The *_timestamp column
* - minTimestamp : The minimum bound of the timestamp column range for this batch
* - maxTimestamp : The maximum bound of the timestamp column range for this batch
* - uniqueKey : A column that is unique (preferably the PRIMARY KEY) [optional]
* b) The unique key based rename parameters:
* - uniqueKey : A column that is unique (preferably the PRIMARY KEY)
* - keyId : A list of values for this column to determine rows to update for this batch
*
* To avoid some race conditions, the following parameters should be set:
* - userID : The ID of the user to update
* - uidColumn : The *_user_id column
*/
class RenameUserJob extends Job {
/** @var int */
private $updateRowsPerQuery;
/** @var ILBFactory */
private $lbFactory;
public function __construct(
Title $title,
$params,
Config $config,
ILBFactory $lbFactory
) {
parent::__construct( 'renameUser', $title, $params );
$this->updateRowsPerQuery = $config->get( MainConfigNames::UpdateRowsPerQuery );
$this->lbFactory = $lbFactory;
}
public function run() {
$dbw = $this->lbFactory->getPrimaryDatabase();
$ticket = $this->lbFactory->getEmptyTransactionTicket( __METHOD__ );
$table = $this->params['table'];
$column = $this->params['column'];
$oldname = $this->params['oldname'];
$newname = $this->params['newname'];
if ( isset( $this->params['userID'] ) ) {
$userID = $this->params['userID'];
$uidColumn = $this->params['uidColumn'];
} else {
$userID = null;
$uidColumn = null;
}
if ( isset( $this->params['timestampColumn'] ) ) {
$timestampColumn = $this->params['timestampColumn'];
$minTimestamp = $this->params['minTimestamp'];
$maxTimestamp = $this->params['maxTimestamp'];
} else {
$timestampColumn = null;
$minTimestamp = null;
$maxTimestamp = null;
}
$uniqueKey = $this->params['uniqueKey'] ?? null;
$keyId = $this->params['keyId'] ?? null;
# Conditions like "*_user_text = 'x'
$conds = [ $column => $oldname ];
# If user ID given, add that to condition to avoid rename collisions
if ( $userID !== null ) {
$conds[$uidColumn] = $userID;
}
# Bound by timestamp if given
if ( $timestampColumn !== null ) {
$conds[] = $dbw->expr( $timestampColumn, '>=', $minTimestamp );
$conds[] = $dbw->expr( $timestampColumn, '<=', $maxTimestamp );
# Bound by unique key if given (B/C)
} elseif ( $uniqueKey !== null && $keyId !== null ) {
$conds[$uniqueKey] = $keyId;
} else {
throw new InvalidArgumentException( 'Expected ID batch or time range' );
}
# Actually update the rows for this job...
if ( $uniqueKey !== null ) {
// Select the rows to update by PRIMARY KEY
$ids = $dbw->newSelectQueryBuilder()
->select( $uniqueKey )
->from( $table )
->where( $conds )
->caller( __METHOD__ )->fetchFieldValues();
# Update these rows by PRIMARY KEY to avoid replica lag
foreach ( array_chunk( $ids, $this->updateRowsPerQuery ) as $batch ) {
$this->lbFactory->commitAndWaitForReplication( __METHOD__, $ticket );
$dbw->newUpdateQueryBuilder()
->update( $table )
->set( [ $column => $newname ] )
->where( [ $column => $oldname, $uniqueKey => $batch ] )
->caller( __METHOD__ )->execute();
}
} else {
# Update the chunk of rows directly
$dbw->newUpdateQueryBuilder()
->update( $table )
->set( [ $column => $newname ] )
->where( $conds )
->caller( __METHOD__ )->execute();
}
return true;
}
}
/** @deprecated class alias since 1.43 */
class_alias( RenameUserJob::class, 'RenameUserJob' );
|
