MediaWiki  REL1_31
ExternalUserNames.php
Go to the documentation of this file.
1 <?php
24 
30  private $usernamePrefix = 'imported';
31  private $assignKnownUsers = false;
32  private $triedCreations = [];
33 
39  $this->usernamePrefix = rtrim( (string)$usernamePrefix, ':>' );
40  $this->assignKnownUsers = (bool)$assignKnownUsers;
41  }
42 
50  public static function getUserLinkTitle( $userName ) {
51  $pos = strpos( $userName, '>' );
52  if ( $pos !== false ) {
53  $iw = explode( ':', substr( $userName, 0, $pos ) );
54  $firstIw = array_shift( $iw );
55  $interwikiLookup = MediaWikiServices::getInstance()->getInterwikiLookup();
56  if ( $interwikiLookup->isValidInterwiki( $firstIw ) ) {
57  $title = MWNamespace::getCanonicalName( NS_USER ) . ':' . substr( $userName, $pos + 1 );
58  if ( $iw ) {
59  $title = implode( ':', $iw ) . ':' . $title;
60  }
61  return Title::makeTitle( NS_MAIN, $title, '', $firstIw );
62  }
63  return null;
64  } else {
65  return SpecialPage::getTitleFor( 'Contributions', $userName );
66  }
67  }
68 
75  public function applyPrefix( $name ) {
76  if ( !User::isUsableName( $name ) ) {
77  return $name;
78  }
79 
80  if ( $this->assignKnownUsers ) {
81  if ( User::idFromName( $name ) ) {
82  return $name;
83  }
84 
85  // See if any extension wants to create it.
86  if ( !isset( $this->triedCreations[$name] ) ) {
87  $this->triedCreations[$name] = true;
88  if ( !Hooks::run( 'ImportHandleUnknownUser', [ $name ] ) &&
89  User::idFromName( $name, User::READ_LATEST )
90  ) {
91  return $name;
92  }
93  }
94  }
95 
96  return $this->addPrefix( $name );
97  }
98 
105  public function addPrefix( $name ) {
106  return substr( $this->usernamePrefix . '>' . $name, 0, 255 );
107  }
108 
115  public static function isExternal( $username ) {
116  return strpos( $username, '>' ) !== false;
117  }
118 
125  public static function getLocal( $username ) {
126  if ( !self::isExternal( $username ) ) {
127  return $username;
128  }
129 
130  return substr( $username, strpos( $username, '>' ) + 1 );
131  }
132 
133 }
ExternalUserNames\$usernamePrefix
$usernamePrefix
Definition: ExternalUserNames.php:30
ExternalUserNames\getLocal
static getLocal( $username)
Get local part of the user name.
Definition: ExternalUserNames.php:125
ExternalUserNames\$assignKnownUsers
$assignKnownUsers
Definition: ExternalUserNames.php:31
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
ExternalUserNames
Class to parse and build external user names.
Definition: ExternalUserNames.php:29
ExternalUserNames\addPrefix
addPrefix( $name)
Add an interwiki prefix to the username regardless of circumstances.
Definition: ExternalUserNames.php:105
SpecialPage\getTitleFor
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
Definition: SpecialPage.php:82
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
NS_MAIN
const NS_MAIN
Definition: Defines.php:74
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:534
ExternalUserNames\__construct
__construct( $usernamePrefix, $assignKnownUsers)
Definition: ExternalUserNames.php:38
ExternalUserNames\$triedCreations
$triedCreations
Definition: ExternalUserNames.php:32
ExternalUserNames\getUserLinkTitle
static getUserLinkTitle( $userName)
Get a target Title to link a username.
Definition: ExternalUserNames.php:50
ExternalUserNames\applyPrefix
applyPrefix( $name)
Add an interwiki prefix to the username, if appropriate.
Definition: ExternalUserNames.php:75
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
User\idFromName
static idFromName( $name, $flags=self::READ_NORMAL)
Get database id given a user name.
Definition: User.php:883
NS_USER
const NS_USER
Definition: Defines.php:76
$username
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:785
MediaWikiServices
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:25
User\isUsableName
static isUsableName( $name)
Usernames which fail to pass this function will be blocked from user login and new account registrati...
Definition: User.php:1018
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
ExternalUserNames\isExternal
static isExternal( $username)
Tells whether the username is external or not.
Definition: ExternalUserNames.php:115
MWNamespace\getCanonicalName
static getCanonicalName( $index)
Returns the canonical (English) name for a given index.
Definition: MWNamespace.php:255