RenameUser.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\RenameUser;
 
use LogicException;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\Context\RequestContext;
use MediaWiki\JobQueue\JobQueueGroupFactory;
use MediaWiki\JobQueue\JobSpecification;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MainConfigNames;
use MediaWiki\Page\MovePageFactory;
use MediaWiki\Permissions\PermissionManager;
use MediaWiki\Status\Status;
use MediaWiki\Title\Title;
use MediaWiki\Title\TitleFactory;
use MediaWiki\User\CentralId\CentralIdLookupFactory;
use MediaWiki\User\User;
use MediaWiki\User\UserFactory;
use MediaWiki\User\UserNameUtils;
use MediaWiki\WikiMap\WikiMap;
use Psr\Log\LoggerInterface;
 
class RenameUser {
 
    private $performer;
    private $target;
    private $oldName;
    private $newName;
    private $reason;
 
    private $forceGlobalDetach = false;
    private $movePages = true;
    private $suppressRedirect = false;
    private $derived = false;
 
    private readonly LoggerInterface $logger;
 
    public const CONSTRUCTOR_OPTIONS = [
        MainConfigNames::LocalDatabases,
    ];
 
    public function __construct(
        private readonly ServiceOptions $options,
        private readonly CentralIdLookupFactory $centralIdLookupFactory,
        private readonly JobQueueGroupFactory $jobQueueGroupFactory,
        private readonly MovePageFactory $movePageFactory,
        private readonly UserFactory $userFactory,
        private readonly UserNameUtils $userNameUtils,
        private readonly PermissionManager $permissionManager,
        private readonly TitleFactory $titleFactory,
        User $performer,
        User $target,
        string $oldName,
        string $newName,
        string $reason,
        array $renameOptions
    ) {
        $options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
        $this->logger = LoggerFactory::getInstance( 'RenameUser' );
 
        foreach ( [
            'forceGlobalDetach',
            'movePages',
            'suppressRedirect',
            'derived',
        ] as $possibleOption ) {
            if ( isset( $renameOptions[ $possibleOption ] ) ) {
                $this->$possibleOption = $renameOptions[ $possibleOption ];
            }
        }
 
        $this->performer = $performer;
        $this->target = $target;
        $this->oldName = $oldName;
        $this->newName = $newName;
        $this->reason = $reason;
    }
 
    private function check(): Status {
        // Check if the user has a proper name
        // The wiki triggering a global rename across a wiki family using virtual domains
        // may not have the same user database as this wiki
        $expectedName = $this->oldName;
        if ( $this->derived && $this->userFactory->isUserTableShared() ) {
            $expectedName = $this->newName;
        }
        if ( $this->target->getName() !== $expectedName ) {
            return Status::newFatal( 'renameuser-error-unexpected-name' );
        }
 
        // Check user names valid
        $newRigor = $this->derived ? UserFactory::RIGOR_NONE : UserFactory::RIGOR_CREATABLE;
        $oldUser = $this->userFactory->newFromName( $this->oldName, UserFactory::RIGOR_NONE );
        $newUser = $this->userFactory->newFromName( $this->newName, $newRigor );
        if ( !$oldUser ) {
            return Status::newFatal( 'renameusererrorinvalid', $this->oldName );
        }
        if ( !$newUser ) {
            return Status::newFatal( 'renameusererrorinvalid', $this->newName );
        }
        $currentUser = $this->derived ? $newUser : $oldUser;
        if ( !$currentUser->isRegistered() ) {
            return Status::newFatal( 'renameusererrordoesnotexist', $currentUser->getName() );
        }
        if ( !$this->derived && $newUser->isRegistered() ) {
            return Status::newFatal( 'renameusererrorexists', $this->newName );
        }
 
        // Do not act on temp users
        if ( $this->userNameUtils->isTemp( $this->oldName ) ) {
            return Status::newFatal( 'renameuser-error-temp-user', $this->oldName );
        }
        if (
            $this->userNameUtils->isTemp( $this->newName ) ||
            $this->userNameUtils->isTempReserved( $this->newName )
        ) {
            return Status::newFatal( 'renameuser-error-temp-user-reserved', $this->newName );
        }
 
        // Check global detaching
        $centralIdLookup = $this->centralIdLookupFactory->getNonLocalLookup();
        $userCentralAttached = $centralIdLookup && $centralIdLookup->isAttached( $this->target );
        if ( !$this->forceGlobalDetach && $userCentralAttached ) {
            return Status::newFatal( 'renameuser-error-global-detaching' );
        }
 
        return Status::newGood();
    }
 
    public function renameLocal(): Status {
        $status = $this->check();
        if ( !$status->isOK() ) {
            return $status;
        }
 
        $user = $this->target;
        $performer = $this->performer;
        $oldName = $this->oldName;
        $newName = $this->newName;
 
        $options = [
            'reason' => $this->reason,
            'derived' => $this->derived,
        ];
 
        // Do the heavy lifting ...
        $rename = new RenameuserSQL(
            $oldName,
            $newName,
            $user->getId(),
            $performer,
            $options
        );
        $status->merge( $rename->renameUser() );
        if ( !$status->isOK() ) {
            return $status;
        }
 
        // If the user is renaming themself, make sure that code below uses a proper name
        if ( $performer->getId() === $user->getId() ) {
            $performer->setName( $newName );
            $this->performer->setName( $newName );
        }
 
        // Move any user pages
        $status->merge( $this->moveUserPages() );
 
        return $status;
    }
 
    public function moveUserPages(): Status {
        if ( $this->movePages && $this->permissionManager->userHasRight( $this->performer, 'move' ) ) {
            $suppressRedirect = $this->suppressRedirect
                && $this->permissionManager->userHasRight( $this->performer, 'suppressredirect' );
            $oldTitle = $this->titleFactory->makeTitle( NS_USER, $this->oldName );
            $newTitle = $this->titleFactory->makeTitle( NS_USER, $this->newName );
 
            $status = $this->movePagesAndSubPages( $this->performer, $oldTitle, $newTitle, $suppressRedirect );
            if ( !$status->isOK() ) {
                return $status;
            }
 
            $oldTalkTitle = $oldTitle->getTalkPageIfDefined();
            $newTalkTitle = $newTitle->getTalkPageIfDefined();
            if ( $oldTalkTitle && $newTalkTitle ) {
                $status = $this->movePagesAndSubPages(
                    $this->performer,
                    $oldTalkTitle,
                    $newTalkTitle,
                    $suppressRedirect
                );
                if ( !$status->isOK() ) {
                    return $status;
                }
            }
        }
        return Status::newGood();
    }
 
    private function movePagesAndSubPages(
        User $performer, Title $oldTitle, Title $newTitle, bool $suppressRedirect
    ): Status {
        $status = Status::newGood();
 
        $movePage = $this->movePageFactory->newMovePage(
            $oldTitle,
            $newTitle,
        );
        $movePage->setMaximumMovedPages( -1 );
        $logMessage = RequestContext::getMain()->msg(
            'renameuser-move-log',
            $oldTitle->getText(),
            $newTitle->getText()
        )->inContentLanguage()->text();
 
        if ( $oldTitle->exists() ) {
            $status->merge( $movePage->moveIfAllowed( $performer, $logMessage, !$suppressRedirect ) );
            if ( !$status->isGood() ) {
                return $status;
            }
        }
 
        $batchStatus = $movePage->moveSubpagesIfAllowed( $performer, $logMessage, !$suppressRedirect );
        foreach ( $batchStatus->getValue() as $titleText => $moveStatus ) {
            $status->merge( $moveStatus );
        }
        return $status;
    }
 
    public function renameGlobal(): Status {
        if ( $this->derived ) {
            throw new LogicException( "Can't rename globally with a command created with newDerivedRenameUser()" );
        }
        $status = $this->renameLocal();
        if ( !$status->isGood() ) {
            return $status;
        }
 
        // Create jobs for other wikis if needed
        if ( $this->userFactory->isUserTableShared() ) {
            foreach ( $this->options->get( MainConfigNames::LocalDatabases ) as $database ) {
                if ( $database == WikiMap::getCurrentWikiDbDomain()->getId() ) {
                    continue;
                }
                $status->merge( $this->enqueueRemoteRename( $database ) );
            }
        }
 
        return $status;
    }
 
    private function enqueueRemoteRename( string $database ): Status {
        $jobParams = [
            'oldname' => $this->oldName,
            'newname' => $this->newName,
            'uid' => $this->target->getId(),
            'performer' => $this->performer->getId(),
            'reason' => $this->reason,
            'movePages' => $this->movePages,
            'suppressRedirect' => $this->suppressRedirect,
        ];
        $oldTitle = $this->titleFactory->makeTitle( NS_USER, $this->oldName );
        $this->logger->info( "Enqueuing a rename job for domain {$database}" );
        $job = new JobSpecification( 'renameUserDerived', $jobParams, [], $oldTitle );
        $this->jobQueueGroupFactory->makeJobQueueGroup( $database )->push( $job );
        return Status::newGood();
    }
 
    public function renameUnsafe(): Status {
        if ( !$this->derived && $this->userFactory->isUserTableShared() ) {
            return $this->renameGlobal();
        } else {
            return $this->renameLocal();
        }
    }
 
    public function rename(): Status {
        // renameuser is always required
        if ( !$this->permissionManager->userHasRight( $this->performer, 'renameuser' ) ) {
            return Status::newFatal( 'renameuser-error-local-rights' );
        }
 
        // for global renames, renameuser-global is also required
        $centralIdLookup = $this->centralIdLookupFactory->getNonLocalLookup();
        $userCentralAttached = $centralIdLookup && $centralIdLookup->isAttached( $this->target );
        if ( ( $this->userFactory->isUserTableShared() || $userCentralAttached )
            && !$this->permissionManager->userHasRight( $this->performer, 'renameuser-global' ) ) {
            return Status::newFatal( 'renameuser-error-global-rights' );
        }
 
        return $this->renameUnsafe();
    }
}