summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/Renameuser/renameUserCleanup.php
blob: 10041c5bf2ffa83998420569af03e84ccf8791ca (plain)
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
<?php
/**
 * Maintenance script to clean up after incomplete user renames
 * Sometimes user edits are left lying around under the old name,
 * check for that and assign them to the new username
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @ingroup Maintenance
 * @author Ariel Glenn <ariel@wikimedia.org>
 */

$IP = getenv( 'MW_INSTALL_PATH' );
if ( $IP === false ) {
	$IP = __DIR__ . '/../..';
}
require_once "$IP/maintenance/Maintenance.php";

class RenameUserCleanup extends Maintenance {
	public function __construct() {
		parent::__construct();
		$this->mDescription = 'Maintenance script to finish incomplete rename user, ' .
		 	'in particular to reassign edits that were missed';
		$this->addOption( 'olduser', 'Old user name', true, true );
		$this->addOption( 'newuser', 'New user name', true, true );
		$this->addOption( 'olduid', 'Old user id in revision records (DANGEROUS)', false, true );
		$this->mBatchSize = 1000;
	}

	public function execute() {
		$this->output( "Rename User Cleanup starting...\n\n" );
		$olduser = User::newFromName( $this->getOption( 'olduser' ) );
		$newuser = User::newFromName( $this->getOption( 'newuser' ) );
		$olduid = $this->getOption( 'olduid' );

		$this->checkUserExistence( $olduser, $newuser );
		$this->checkRenameLog( $olduser, $newuser );

		if ( $olduid ) {
			$this->doUpdates( $olduser, $newuser, $olduid );
		}
		$this->doUpdates( $olduser, $newuser, $newuser->getId() );
		$this->doUpdates( $olduser, $newuser, 0 );

		print "Done!\n";
		exit( 0 );
	}

	/**
	 * @param $olduser User
	 * @param $newuser User
	 */
	public function checkUserExistence( $olduser, $newuser ) {
		if ( !$newuser->getId() ) {
			$this->error( 'No such user: ' . $this->getOption( 'newuser' ), true );
			exit( 1 );
		}
		if ( $olduser->getId() ) {
			print 'WARNING!!: Old user still exists: ' . $this->getOption( 'olduser' ) . "\n";
			print "proceed anyways? We'll only re-attribute edits that have the new user uid (or 0)";
			print ' or the uid specified by the caller, and the old user name.  [N/y]   ';
			$stdin = fopen( 'php://stdin', 'rt' );
			$line = fgets( $stdin );
			fclose( $stdin );
			if ( $line[0] !== 'Y' && $line[0] !== 'y' ) {
				print "Exiting at user's request\n";
				exit( 0 );
			}
		}
	}

	/**
	 * @param $olduser User
	 * @param $newuser User
	 */
	public function checkRenameLog( $olduser, $newuser ) {
		$dbr = wfGetDB( DB_SLAVE );

		$oldTitle = Title::makeTitle( NS_USER, $olduser->getName() );

		$result = $dbr->select( 'logging', '*',
			[ 'log_type' => 'renameuser',
				'log_action' => 'renameuser',
				'log_namespace' => NS_USER,
				'log_title' => $oldTitle->getDBkey(),
				'log_params' => $newuser->getName()
			],
			__METHOD__
		);
		if ( !$result || !$result->numRows() ) {
			// try the old format
			$result = $dbr->select( 'logging', '*',
				[ 'log_type' => 'renameuser',
					'log_action' => 'renameuser',
					'log_namespace' => NS_USER,
					'log_title' => $olduser->getName(),
				],
				__METHOD__
			);
			if ( !$result || !$result->numRows() ) {
				print 'No log entry found for a rename of ' . $olduser->getName() .
					' to ' . $newuser->getName() . ', proceed anyways??? [N/y] ';
				$stdin = fopen( 'php://stdin', 'rt' );
				$line = fgets( $stdin );
				fclose( $stdin );
				if ( $line[0] !== 'Y' && $line[0] !== 'y' ) {
					print "Exiting at user's request\n";
					exit( 1 );
				}
			} else {
				foreach ( $result as $row ) {
					print 'Found possible log entry of the rename, please check: ' .
						$row->log_title . ' with comment ' . $row->log_comment .
						" on $row->log_timestamp\n";
				}
			}
		} else {
			foreach ( $result as $row ) {
				print 'Found log entry of the rename: ' . $olduser->getName() .
					' to ' . $newuser->getName() . " on $row->log_timestamp\n";
			}
		}
		if ( $result && $result->numRows() > 1 ) {
			print 'More than one rename entry found in the log, not sure ' .
				'what to do. Continue anyways? [N/y]  ';
			$stdin = fopen( 'php://stdin', 'rt' );
			$line = fgets( $stdin );
			fclose( $stdin );
			if ( $line[0] !== 'Y' && $line[0] !== 'y' ) {
				print "Exiting at user's request\n";
				exit( 1 );
			}
		}
	}

	/**
	 * @param $olduser User
	 * @param $newuser User
	 * @param $uid
	 */
	public function doUpdates( $olduser, $newuser, $uid ) {
		$this->updateTable( 'revision', 'rev_user_text', 'rev_user', 'rev_timestamp',
			$olduser, $newuser, $uid );
		$this->updateTable( 'archive', 'ar_user_text', 'ar_user', 'ar_timestamp',
			$olduser, $newuser, $uid );
		$this->updateTable( 'logging', 'log_user_text', 'log_user', 'log_timestamp',
			$olduser, $newuser, $uid );
		$this->updateTable( 'image', 'img_user_text', 'img_user', 'img_timestamp',
			$olduser, $newuser, $uid );
		$this->updateTable( 'oldimage', 'oi_user_text', 'oi_user', 'oi_timestamp',
			$olduser, $newuser, $uid );
		$this->updateTable( 'filearchive', 'fa_user_text', 'fa_user', 'fa_timestamp',
			$olduser, $newuser, $uid );
	}

	/**
	 * @param $table
	 * @param $usernamefield
	 * @param $useridfield
	 * @param $timestampfield
	 * @param $olduser User
	 * @param $newuser User
	 * @param $uid
	 * @return int
	 */
	public function updateTable( $table, $usernamefield, $useridfield,
		$timestampfield, $olduser, $newuser, $uid
	) {
		$dbw = wfGetDB( DB_MASTER );

		$contribs = $dbw->selectField( $table, 'count(*)',
			[ $usernamefield => $olduser->getName(), $useridfield => $uid ], __METHOD__ );

		if ( $contribs === 0 ) {
			print "No edits to be re-attributed from table $table for uid $uid\n";

			return ( 0 );
		}

		print "Found $contribs edits to be re-attributed from table $table for uid $uid\n";
		if ( $uid !== $newuser->getId() ) {
			print 'If you proceed, the uid field will be set to that ' .
				'of the new user name (i.e. ' . $newuser->getId() . ") in these rows.\n";
		}

		print 'Proceed? [N/y]  ';
		$stdin = fopen( 'php://stdin', 'rt' );
		$line = fgets( $stdin );
		fclose( $stdin );
		if ( $line[0] !== 'Y' && $line[0] !== 'y' ) {
			print "Skipping at user's request\n";

			return ( 0 );
		}

		$selectConds = [ $usernamefield => $olduser->getName(), $useridfield => $uid ];
		$updateFields = [ $usernamefield => $newuser->getName(), $useridfield => $newuser->getId() ];

		while ( $contribs > 0 ) {
			print 'Doing batch of up to approximately ' . $this->mBatchSize . "\n";
			print 'Do this batch? [N/y]  ';
			$stdin = fopen( 'php://stdin', 'rt' );
			$line = fgets( $stdin );
			fclose( $stdin );
			if ( $line[0] !== 'Y' && $line[0] !== 'y' ) {
				print "Skipping at user's request\n";

				return ( 0 );
			}
			$this->beginTransaction( $dbw, __METHOD__ );
			$result = $dbw->select( $table, $timestampfield, $selectConds, __METHOD__,
				[ 'ORDER BY' => $timestampfield . ' DESC', 'LIMIT' => $this->mBatchSize ] );
			if ( !$result ) {
				print "There were rows for updating but now they are gone. Skipping.\n";
				$this->rollbackTransaction( $dbw, __METHOD__ );

				return ( 0 );
			}
			$result->seek( $result->numRows() - 1 );
			$row = $result->fetchObject();
			$timestamp = $row->$timestampfield;
			$updateCondsWithTime = array_merge( $selectConds, [ "$timestampfield >= $timestamp" ] );
			$success = $dbw->update( $table, $updateFields, $updateCondsWithTime, __METHOD__ );
			if ( $success ) {
				$rowsDone = $dbw->affectedRows();
				$this->commitTransaction( $dbw, __METHOD__ );
			} else {
				print "Problem with the update, rolling back and exiting\n";
				$this->rollbackTransaction( $dbw, __METHOD__ );
				exit( 1 );
			}

			// $contribs = User::edits( $olduser->getId() );
			$contribs = $dbw->selectField( $table, 'count(*)', $selectConds, __METHOD__ );
			print "Updated $rowsDone edits; $contribs edits remaining to be re-attributed\n";
		}

		return ( 0 );
	}
}

$maintClass = 'RenameUserCleanup';
require_once RUN_MAINTENANCE_IF_MAIN;