MediaWiki  master
ExternalUserNames.php
Go to the documentation of this file.
1 <?php
24 
30 
34  private $usernamePrefix = 'imported';
35 
39  private $assignKnownUsers = false;
40 
44  private $triedCreations = [];
45 
51  $this->usernamePrefix = rtrim( (string)$usernamePrefix, ':>' );
52  $this->assignKnownUsers = (bool)$assignKnownUsers;
53  }
54 
62  public static function getUserLinkTitle( $userName ) {
63  $pos = strpos( $userName, '>' );
64  if ( $pos !== false ) {
65  $iw = explode( ':', substr( $userName, 0, $pos ) );
66  $firstIw = array_shift( $iw );
67  $services = MediaWikiServices::getInstance();
68  $interwikiLookup = $services->getInterwikiLookup();
69  if ( $interwikiLookup->isValidInterwiki( $firstIw ) ) {
70  $title = $services->getNamespaceInfo()->getCanonicalName( NS_USER ) .
71  ':' . substr( $userName, $pos + 1 );
72  if ( $iw ) {
73  $title = implode( ':', $iw ) . ':' . $title;
74  }
75  return Title::makeTitle( NS_MAIN, $title, '', $firstIw );
76  }
77  return null;
78  } else {
79  return SpecialPage::getTitleFor( 'Contributions', $userName );
80  }
81  }
82 
97  public function applyPrefix( $name ) {
98  if ( !User::isUsableName( $name ) ) {
99  return $name;
100  }
101 
102  if ( $this->assignKnownUsers ) {
103  if ( User::idFromName( $name ) ) {
104  return $name;
105  }
106 
107  // See if any extension wants to create it.
108  if ( !isset( $this->triedCreations[$name] ) ) {
109  $this->triedCreations[$name] = true;
110  if ( !Hooks::run( 'ImportHandleUnknownUser', [ $name ] ) &&
111  User::idFromName( $name, User::READ_LATEST )
112  ) {
113  return $name;
114  }
115  }
116  }
117 
118  return $this->addPrefix( $name );
119  }
120 
127  public function addPrefix( $name ) {
128  return substr( $this->usernamePrefix . '>' . $name, 0, 255 );
129  }
130 
137  public static function isExternal( $username ) {
138  return strpos( $username, '>' ) !== false;
139  }
140 
147  public static function getLocal( $username ) {
148  if ( !self::isExternal( $username ) ) {
149  return $username;
150  }
151 
152  return substr( $username, strpos( $username, '>' ) + 1 );
153  }
154 
155 }
const NS_MAIN
Definition: Defines.php:60
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
addPrefix( $name)
Add an interwiki prefix to the username regardless of circumstances.
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:23
static idFromName( $name, $flags=self::READ_NORMAL)
Get database id given a user name.
Definition: User.php:864
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition: hooks.txt:2204
__construct( $usernamePrefix, $assignKnownUsers)
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
static isUsableName( $name)
Usernames which fail to pass this function will be blocked from user login and new account registrati...
Definition: User.php:1001
static getUserLinkTitle( $userName)
Get a target Title to link a username.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:83
applyPrefix( $name)
Add an interwiki prefix to the username, if appropriate.
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:590
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:35
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:767
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
Class to parse and build external user names.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
static getLocal( $username)
Get local part of the user name.
static isExternal( $username)
Tells whether the username is external or not.