ExternalUserNames.php

Go to the documentation of this file.

<?php
namespace MediaWiki\User;
 
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\MediaWikiServices;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Title\Title;
use Wikimedia\Rdbms\IDBAccessObject;
 
class ExternalUserNames {
 
    private readonly string $usernamePrefix;
 
    private $triedCreations = [];
 
    public function __construct(
        string $usernamePrefix,
        private readonly bool $assignKnownUsers,
    ) {
        $this->usernamePrefix = rtrim( $usernamePrefix, ':>' );
    }
 
    public static function getUserLinkTitle( $userName ) {
        $pos = strpos( $userName, '>' );
        $services = MediaWikiServices::getInstance();
        if ( $pos !== false ) {
            $iw = explode( ':', substr( $userName, 0, $pos ) );
            $firstIw = array_shift( $iw );
            $interwikiLookup = $services->getInterwikiLookup();
            if ( $interwikiLookup->isValidInterwiki( $firstIw ) ) {
                $title = $services->getNamespaceInfo()->getCanonicalName( NS_USER ) .
                    ':' . substr( $userName, $pos + 1 );
                if ( $iw ) {
                    $title = implode( ':', $iw ) . ':' . $title;
                }
                return Title::makeTitle( NS_MAIN, $title, '', $firstIw );
            }
            return null;
        } else {
            // Protect against invalid user names from old corrupt database rows, T232451
            if (
                $services->getUserNameUtils()->isIP( $userName )
                || $services->getUserNameUtils()->isValidIPRange( $userName )
                || $services->getUserNameUtils()->isValid( $userName )
            ) {
                return SpecialPage::getTitleFor( 'Contributions', $userName );
            } else {
                // Bad user name, no link
                return null;
            }
        }
    }
 
    public function applyPrefix( $name ) {
        $services = MediaWikiServices::getInstance();
        $userNameUtils = $services->getUserNameUtils();
        if ( $userNameUtils->getCanonical( $name, UserRigorOptions::RIGOR_USABLE ) === false ) {
            return $name;
        }
 
        if ( $this->assignKnownUsers ) {
            $userIdentityLookup = $services->getUserIdentityLookup();
            $userIdentity = $userIdentityLookup->getUserIdentityByName( $name );
            if ( $userIdentity && $userIdentity->isRegistered() ) {
                return $name;
            }
 
            // See if any extension wants to create it.
            if ( !isset( $this->triedCreations[$name] ) ) {
                $this->triedCreations[$name] = true;
                if ( !( new HookRunner( $services->getHookContainer() ) )->onImportHandleUnknownUser( $name ) ) {
                    $userIdentity = $userIdentityLookup->getUserIdentityByName( $name, IDBAccessObject::READ_LATEST );
                    if ( $userIdentity && $userIdentity->isRegistered() ) {
                        return $name;
                    }
                }
            }
        }
 
        return $this->addPrefix( $name );
    }
 
    public function addPrefix( $name ) {
        return substr( $this->usernamePrefix . '>' . $name, 0, 255 );
    }
 
    public static function isExternal( $username ) {
        return str_contains( $username, '>' );
    }
 
    public static function getLocal( $username ) {
        if ( !self::isExternal( $username ) ) {
            return $username;
        }
 
        return substr( $username, strpos( $username, '>' ) + 1 );
    }
 
    public static function getPrefix( $username ) {
        if ( !self::isExternal( $username ) ) {
            return false;
        }
 
        return substr( $username, 0, strpos( $username, '>' ) );
    }
 
}
 
class_alias( ExternalUserNames::class, 'ExternalUserNames' );