MultiFormatUserIdentityLookup.php

Go to the documentation of this file.

<?php
namespace MediaWiki\User;
 
use MediaWiki\Config\ServiceOptions;
use MediaWiki\MainConfigNames;
use MediaWiki\Permissions\Authority;
use MediaWiki\Status\Status;
use MediaWiki\WikiMap\WikiMap;
use Wikimedia\IPUtils;
 
class MultiFormatUserIdentityLookup {
 
    public const CONSTRUCTOR_OPTIONS = [
        MainConfigNames::LocalDatabases,
        MainConfigNames::UserrightsInterwikiDelimiter
    ];
 
    public function __construct(
        private readonly ActorStoreFactory $actorStoreFactory,
        private readonly UserFactory $userFactory,
        private readonly ServiceOptions $options,
    ) {
        $this->options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
    }
 
    public function getUserIdentity( string $designator, ?Authority $viewer = null ): Status {
        [ $name, $wikiId ] = $this->parseUserDesignator( $designator );
 
        // Check if the wikiId is valid
        if ( $wikiId !== UserIdentity::LOCAL ) {
            $localDatabases = $this->options->get( MainConfigNames::LocalDatabases );
            if ( !in_array( $wikiId, $localDatabases ) ) {
                return Status::newFatal( 'userrights-nodatabase', $wikiId );
            }
        }
 
        if ( $name === '' ) {
            return Status::newFatal( 'nouserspecified' );
        }
 
        if ( IPUtils::isValid( $name ) ) {
            return Status::newGood( UserIdentityValue::newAnonymous( $name, $wikiId ) );
        }
 
        $userIdentityLookup = $this->actorStoreFactory->getUserIdentityLookup( $wikiId );
        if ( $name[0] == '#' ) {
            $id = intval( substr( $name, 1 ) );
            $user = $userIdentityLookup->getUserIdentityByUserId( $id );
        } else {
            $user = $userIdentityLookup->getUserIdentityByName( $name );
        }
 
        if ( !$user ) {
            return Status::newFatal( 'nosuchusershort', $designator );
        }
 
        // If an authority is specified, check if the viewer is allowed to see the user
        // If they can't, pretend the user doesn't exist
        if (
            $viewer !== null &&
            $user->getWikiId() === UserIdentity::LOCAL &&
            $this->userFactory->newFromUserIdentity( $user )->isHidden() &&
            !$viewer->isAllowed( 'hideuser' )
        ) {
            return Status::newFatal( 'nosuchusershort', $designator );
        }
 
        return Status::newGood( $user );
    }
 
    private function parseUserDesignator( string $designator ): array {
        $interwikiSeparator = $this->options->get( MainConfigNames::UserrightsInterwikiDelimiter );
        $designatorParts = explode( $interwikiSeparator, $designator );
 
        $name = trim( $designator );
        $wikiId = UserIdentity::LOCAL;
        if ( count( $designatorParts ) >= 2 ) {
            $name = trim( $designatorParts[0] );
            $wikiId = trim( $designatorParts[1] );
 
            if ( WikiMap::isCurrentWikiId( $wikiId ) ) {
                $wikiId = UserIdentity::LOCAL;
            }
        }
        return [ $name, $wikiId ];
    }
}