File: renameUser.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (177 lines) | stat: -rw-r--r-- 5,589 bytes parent folder | download | duplicates (2)
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
<?php
/**
 * 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 Martin Urbanec <martin.urbanec@wikimedia.cz>
 */

// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd

use MediaWiki\Page\MovePageFactory;
use MediaWiki\RenameUser\RenameuserSQL;
use MediaWiki\Title\Title;
use MediaWiki\User\CentralId\CentralIdLookup;
use MediaWiki\User\User;
use MediaWiki\User\UserFactory;

class RenameUser extends Maintenance {
	/** @var UserFactory */
	private $userFactory;

	/** @var CentralIdLookup|null */
	private $centralLookup;

	/** @var MovePageFactory */
	private $movePageFactory;

	public function __construct() {
		parent::__construct();

		$this->addDescription( 'Rename a user' );
		$this->addArg( 'old-name', 'Current username of the to-be-renamed user' );
		$this->addArg( 'new-name', 'New username of the to-be-renamed user' );
		$this->addOption( 'performer', 'Performer of the rename action', false, true );
		$this->addOption( 'reason', 'Reason of the rename', false, true );
		$this->addOption( 'force-global-detach',
			'Rename the local user even if it is attached to a global account' );
		$this->addOption( 'suppress-redirect', 'Don\'t create redirects when moving pages' );
		$this->addOption( 'skip-page-moves', 'Don\'t move associated user pages' );
	}

	private function initServices() {
		$services = $this->getServiceContainer();
		$this->userFactory = $services->getUserFactory();
		$this->centralLookup = $services->getCentralIdLookupFactory()->getNonLocalLookup();
		$this->movePageFactory = $services->getMovePageFactory();
	}

	public function execute() {
		$this->initServices();

		$oldName = $this->getArg( 'old-name' );
		$newName = $this->getArg( 'new-name' );

		$oldUser = $this->userFactory->newFromName( $oldName );
		if ( !$oldUser ) {
			$this->fatalError( 'The specified old username is invalid' );
		}

		if ( !$oldUser->isRegistered() ) {
			$this->fatalError( 'The user does not exist' );
		}

		if ( !$this->getOption( 'force-global-detach' )
			&& $this->centralLookup
			&& $this->centralLookup->isAttached( $oldUser )
		) {
			$this->fatalError( 'The user is globally attached. Use CentralAuth to rename this account.' );
		}

		$newUser = $this->userFactory->newFromName( $newName, UserFactory::RIGOR_CREATABLE );
		if ( !$newUser ) {
			$this->fatalError( 'The specified new username is invalid' );
		} elseif ( $newUser->isRegistered() ) {
			$this->fatalError( 'New username must be free' );
		}

		if ( $this->getOption( 'performer' ) === null ) {
			$performer = User::newSystemUser( User::MAINTENANCE_SCRIPT_USER, [ 'steal' => true ] );
		} else {
			$performer = $this->userFactory->newFromName( $this->getOption( 'performer' ) );
		}

		if ( !( $performer instanceof User ) || !$performer->isRegistered() ) {
			$this->fatalError( 'Performer does not exist.' );
		}

		$renamer = new RenameuserSQL(
			$oldUser->getName(),
			$newUser->getName(),
			$oldUser->getId(),
			$performer,
			[
				'reason' => $this->getOption( 'reason' )
			]
		);

		if ( !$renamer->rename() ) {
			$this->fatalError( 'Renaming failed.' );
		} else {
			$this->output( "{$oldUser->getName()} was successfully renamed to {$newUser->getName()}.\n" );
		}

		$numRenames = 0;
		if ( !$this->getOption( 'skip-page-moves' ) ) {
			$numRenames += $this->movePageAndSubpages(
				$performer,
				$oldUser->getUserPage(),
				$newUser->getUserPage(),
				'user'
			);
			$numRenames += $this->movePageAndSubpages(
				$performer,
				$oldUser->getTalkPage(),
				$newUser->getTalkPage(),
				'user talk',
			);
		}
		if ( $numRenames > 0 ) {
			$this->output( "$numRenames user page(s) renamed\n" );
		}
	}

	private function movePageAndSubpages( User $performer, Title $oldTitle, Title $newTitle, $kind ) {
		$movePage = $this->movePageFactory->newMovePage(
			$oldTitle,
			$newTitle,
		);
		$movePage->setMaximumMovedPages( -1 );
		$logMessage = wfMessage(
			'renameuser-move-log', $oldTitle->getText(), $newTitle->getText()
		)->inContentLanguage()->text();
		$createRedirect = !$this->getOption( 'suppress-redirect' );

		$numRenames = 0;
		if ( $oldTitle->exists() ) {
			$status = $movePage->move( $performer, $logMessage, $createRedirect );
			if ( $status->isGood() ) {
				$numRenames++;
			} else {
				$this->output( "Failed to rename $kind page\n" );
				$this->error( $status );
			}
		}

		$batchStatus = $movePage->moveSubpages( $performer, $logMessage, $createRedirect );
		foreach ( $batchStatus->getValue() as $titleText => $status ) {
			if ( $status->isGood() ) {
				$numRenames++;
			} else {
				$this->output( "Failed to rename $kind subpage \"$titleText\"\n" );
				$this->error( $status );
			}
		}
		return $numRenames;
	}
}

// @codeCoverageIgnoreStart
$maintClass = RenameUser::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd