ExternalUserNames.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;

class ExternalUserNames {

    private $usernamePrefix = 'imported';

    private $assignKnownUsers = false;

    private $triedCreations = [];

    public function __construct( $usernamePrefix, $assignKnownUsers ) {
        $this->usernamePrefix = rtrim( (string)$usernamePrefix, ':>' );
        $this->assignKnownUsers = (bool)$assignKnownUsers;
    }

    public static function getUserLinkTitle( $userName ) {
        $pos = strpos( $userName, '>' );
        if ( $pos !== false ) {
            $iw = explode( ':', substr( $userName, 0, $pos ) );
            $firstIw = array_shift( $iw );
            $services = MediaWikiServices::getInstance();
            $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 {
            return SpecialPage::getTitleFor( 'Contributions', $userName );
        }
    }

    public function applyPrefix( $name ) {
        if ( !User::isUsableName( $name ) ) {
            return $name;
        }

        if ( $this->assignKnownUsers ) {
            if ( User::idFromName( $name ) ) {
                return $name;
            }

            // See if any extension wants to create it.
            if ( !isset( $this->triedCreations[$name] ) ) {
                $this->triedCreations[$name] = true;
                if ( !Hooks::run( 'ImportHandleUnknownUser', [ $name ] ) &&
                    User::idFromName( $name, User::READ_LATEST )
                ) {
                    return $name;
                }
            }
        }

        return $this->addPrefix( $name );
    }

    public function addPrefix( $name ) {
        return substr( $this->usernamePrefix . '>' . $name, 0, 255 );
    }

    public static function isExternal( $username ) {
        return strpos( $username, '>' ) !== false;
    }

    public static function getLocal( $username ) {
        if ( !self::isExternal( $username ) ) {
            return $username;
        }

        return substr( $username, strpos( $username, '>' ) + 1 );
    }

}