Page MenuHomeWickedGov Phorge
Files F1428273

SpecialGlobalRenameUser.php
No OneTemporary
Actions

Size
9 KB
Referenced Files
None
Subscribers
None

SpecialGlobalRenameUser.php
View Options

<?php
namespace MediaWiki\Extension\CentralAuth\Special;
use MediaWiki\Extension\CentralAuth\CentralAuthUIService;
use MediaWiki\Extension\CentralAuth\GlobalRename\GlobalRenameDenylist;
use MediaWiki\Extension\CentralAuth\GlobalRename\GlobalRenameFactory;
use MediaWiki\Extension\CentralAuth\GlobalRename\GlobalRenameUserValidator;
use MediaWiki\Extension\CentralAuth\User\CentralAuthAntiSpoofManager;
use MediaWiki\Extension\CentralAuth\User\CentralAuthUser;
use MediaWiki\Extension\CentralAuth\Widget\HTMLGlobalUserTextField;
use MediaWiki\Extension\TitleBlacklist\TitleBlacklist;
use MediaWiki\Extension\TitleBlacklist\TitleBlacklistEntry;
use MediaWiki\Message\Message;
use MediaWiki\Registration\ExtensionRegistry;
use MediaWiki\SpecialPage\FormSpecialPage;
use MediaWiki\Status\Status;
use MediaWiki\Title\Title;
use MediaWiki\User\User;
use MediaWiki\User\UserNameUtils;
use MediaWiki\User\UserRigorOptions;
class SpecialGlobalRenameUser extends FormSpecialPage {
/**
* @var string
*/
private $newUsername;
/**
* @var string
*/
private $oldUsername;
/**
* @var bool
*/
private $overrideAntiSpoof = false;
/**
* @var bool
*/
private $allowHighEditcount = false;
/**
* @var bool
*/
private $overrideTitleBlacklist = false;
private UserNameUtils $userNameUtils;
private CentralAuthAntiSpoofManager $caAntiSpoofManager;
private CentralAuthUIService $uiService;
private GlobalRenameDenylist $globalRenameDenylist;
private GlobalRenameFactory $globalRenameFactory;
private GlobalRenameUserValidator $globalRenameUserValidator;
/**
* Require confirmation if olduser has more than this many global edits
*/
private const EDITCOUNT_THRESHOLD = 100000;
public function __construct(
UserNameUtils $userNameUtils,
CentralAuthAntiSpoofManager $caAntiSpoofManager,
CentralAuthUIService $uiService,
GlobalRenameDenylist $globalRenameDenylist,
GlobalRenameFactory $globalRenameFactory,
GlobalRenameUserValidator $globalRenameUserValidator
) {
parent::__construct( 'GlobalRenameUser', 'centralauth-rename' );
$this->userNameUtils = $userNameUtils;
$this->caAntiSpoofManager = $caAntiSpoofManager;
$this->uiService = $uiService;
$this->globalRenameDenylist = $globalRenameDenylist;
$this->globalRenameFactory = $globalRenameFactory;
$this->globalRenameUserValidator = $globalRenameUserValidator;
}
public function doesWrites() {
return true;
}
/**
* @param string|null $par Subpage string if one was specified
*/
public function execute( $par ) {
parent::execute( $par );
$this->getOutput()->addModules( 'ext.centralauth.globalrenameuser' );
$this->getOutput()->addModuleStyles( 'ext.centralauth.misc.styles' );
}
/**
* @return array[]
*/
public function getFormFields() {
$fields = [
'oldname' => [
'class' => HTMLGlobalUserTextField::class,
'id' => 'mw-globalrenameuser-oldname',
'name' => 'oldname',
'label-message' => 'centralauth-rename-form-oldname',
'type' => 'text',
'required' => true,
],
'newname' => [
'id' => 'mw-globalrenameuser-newname',
'name' => 'newname',
'label-message' => 'centralauth-rename-form-newname',
'type' => 'text',
'required' => true
],
'reason' => [
'id' => 'mw-globalrenameuser-reason',
'name' => 'reason',
'label-message' => 'centralauth-rename-form-reason',
'type' => 'text',
],
'movepages' => [
'id' => 'mw-globalrenameuser-movepages',
'name' => 'movepages',
'label-message' => 'centralauth-rename-form-movepages',
'type' => 'check',
'default' => 1,
],
'suppressredirects' => [
'id' => 'mw-globalrenameuser-suppressredirects',
'name' => 'suppressredirects',
'label-message' => 'centralauth-rename-form-suppressredirects',
'type' => 'check',
],
'overrideantispoof' => [
'id' => 'mw-globalrenameuser-overrideantispoof',
'name' => 'overrideantispoof',
'label-message' => 'centralauth-rename-form-overrideantispoof',
'type' => 'check'
],
'overridetitleblacklist' => [
'id' => 'mw-globalrenameuser-overridetitleblacklist',
'name' => 'overridetitleblacklist',
'label-message' => 'centralauth-rename-form-overridetitleblacklist',
'type' => 'check'
],
'allowhigheditcount' => [
'name' => 'allowhigheditcount',
'type' => 'hidden',
'default' => '',
]
];
// Ask for confirmation if the user has more than 100k edits globally
$oldName = trim( $this->getRequest()->getText( 'oldname' ) );
if ( $oldName !== '' ) {
$oldUser = User::newFromName( $oldName );
if ( $oldUser ) {
$caUser = CentralAuthUser::getInstance( $oldUser );
if ( $caUser->getGlobalEditCount() > self::EDITCOUNT_THRESHOLD ) {
$fields['allowhigheditcount'] = [
'id' => 'mw-globalrenameuser-allowhigheditcount',
'label-message' => [ 'centralauth-rename-form-allowhigheditcount',
Message::numParam( self::EDITCOUNT_THRESHOLD ) ],
'type' => 'check'
];
}
}
}
return $fields;
}
/** @inheritDoc */
protected function getDisplayFormat() {
return 'ooui';
}
/** @inheritDoc */
protected function getSubpageField() {
return 'oldname';
}
/**
* Perform validation on the user submitted data
* and check that we can perform the rename
* @param array $data
*
* @return Status
*/
public function validate( array $data ) {
$oldUser = User::newFromName( $data['oldname'] );
if ( !$oldUser ) {
return Status::newFatal( 'centralauth-rename-doesnotexist' );
}
if ( $oldUser->getName() === $this->getUser()->getName() ) {
return Status::newFatal( 'centralauth-rename-cannotself' );
}
if ( $oldUser->isTemp() ) {
return Status::newFatal( 'centralauth-rename-badusername' );
}
$newUser = User::newFromName(
$data['newname'],
// match GlobalRenameFactory
UserRigorOptions::RIGOR_CREATABLE
);
if ( !$newUser ) {
return Status::newFatal( 'centralauth-rename-badusername' );
}
if ( $newUser->isTemp() ) {
return Status::newFatal( 'centralauth-rename-badusername' );
}
if ( !$this->overrideAntiSpoof ) {
$spoofUser = $this->caAntiSpoofManager->getSpoofUser( $newUser->getName() );
$conflicts = $this->uiService->processAntiSpoofConflicts(
$this->getContext(),
$oldUser->getName(),
$spoofUser->getConflicts()
);
$renamedUser = $this->caAntiSpoofManager->getOldRenamedUserName( $newUser->getName() );
if ( $renamedUser !== null ) {
$conflicts[] = $renamedUser;
}
if ( $conflicts ) {
return Status::newFatal(
$this->msg( 'centralauth-rename-antispoofconflicts2' )
->params( $this->getLanguage()->listToText( $conflicts ) )
->numParams( count( $conflicts ) )
);
}
}
// Let the performer know that olduser's editcount is more than the
// sysadmin-intervention-threshold and do the rename only if we've received
// confirmation that they want to do it.
$caOldUser = CentralAuthUser::getInstance( $oldUser );
if ( !$this->allowHighEditcount &&
$caOldUser->getGlobalEditCount() > self::EDITCOUNT_THRESHOLD
) {
return Status::newFatal(
$this->msg( 'centralauth-rename-globaleditcount-threshold' )
->numParams( self::EDITCOUNT_THRESHOLD )
);
}
// Ask for confirmation if the new username matches the title blacklist.
if (
!$this->overrideTitleBlacklist
&& ExtensionRegistry::getInstance()->isLoaded( 'TitleBlacklist' )
) {
$titleBlacklist = TitleBlacklist::singleton()->isBlacklisted(
Title::makeTitleSafe( NS_USER, $newUser->getName() ),
'new-account'
);
if ( $titleBlacklist instanceof TitleBlacklistEntry ) {
return Status::newFatal(
$this->msg( 'centralauth-rename-titleblacklist-match' )
->params( wfEscapeWikiText( $titleBlacklist->getRegex() ) )
);
}
}
// Validate rename deny list
if ( !$this->globalRenameDenylist->checkUser( $oldUser ) ) {
return Status::newFatal( 'centralauth-rename-listed-on-denylist' );
}
return $this->globalRenameUserValidator->validate( $oldUser, $newUser );
}
/**
* @param array $data
* @return Status
*/
public function onSubmit( array $data ) {
if ( $data['overrideantispoof'] ) {
$this->overrideAntiSpoof = true;
}
if ( $data['overridetitleblacklist'] ) {
$this->overrideTitleBlacklist = true;
}
if ( $data['allowhigheditcount'] ) {
$this->allowHighEditcount = true;
}
$valid = $this->validate( $data );
if ( !$valid->isOK() ) {
return $valid;
}
// Turn old username into canonical form as CentralAuthUser:;getInstanceByName
// does not do that by default. See T343958, T343963.
$this->oldUsername = $this->userNameUtils->getCanonical(
$data['oldname'],
UserRigorOptions::RIGOR_VALID
);
// This isn't strictly necessary as of writing, but let's do that just in case too.
// The username should already been validated in validate().
$this->newUsername = $this->userNameUtils->getCanonical(
$data['newname'],
UserRigorOptions::RIGOR_CREATABLE
);
return $this->globalRenameFactory
->newGlobalRenameUser(
$this->getUser(),
CentralAuthUser::getInstanceByName( $this->oldUsername ),
$this->newUsername
)
->withSession( $this->getContext()->exportSession() )
->rename( $data );
}
public function onSuccess() {
$msg = $this->msg( 'centralauth-rename-queued' )
->params( $this->oldUsername, $this->newUsername )
->parse();
$this->getOutput()->addHTML( $msg );
}
/** @inheritDoc */
protected function getGroupName() {
return 'users';
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 15:57 (13 h, 36 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
fd/7d/fc57d2b50678a0bb5fdf6a88c6ff
Default Alt Text
SpecialGlobalRenameUser.php (9 KB)

Event Timeline