MediaWiki  1.30.0
LocalIdLookup.php
Go to the documentation of this file.
1 <?php
34 
35  public function isAttached( User $user, $wikiId = null ) {
37 
38  // If the user has no ID, it can't be attached
39  if ( !$user->getId() ) {
40  return false;
41  }
42 
43  // Easy case, we're checking locally
44  if ( $wikiId === null || $wikiId === wfWikiID() ) {
45  return true;
46  }
47 
48  // Assume that shared user tables are set up as described above, if
49  // they're being used at all.
50  return $wgSharedDB !== null &&
51  in_array( 'user', $wgSharedTables, true ) &&
52  in_array( $wikiId, $wgLocalDatabases, true );
53  }
54 
55  public function lookupCentralIds(
56  array $idToName, $audience = self::AUDIENCE_PUBLIC, $flags = self::READ_NORMAL
57  ) {
58  if ( !$idToName ) {
59  return [];
60  }
61 
62  $audience = $this->checkAudience( $audience );
64  $db = wfGetDB( $index );
65 
66  $tables = [ 'user' ];
67  $fields = [ 'user_id', 'user_name' ];
68  $where = [
69  'user_id' => array_map( 'intval', array_keys( $idToName ) ),
70  ];
71  $join = [];
72  if ( $audience && !$audience->isAllowed( 'hideuser' ) ) {
73  $tables[] = 'ipblocks';
74  $join['ipblocks'] = [ 'LEFT JOIN', 'ipb_user=user_id' ];
75  $fields[] = 'ipb_deleted';
76  }
77 
78  $res = $db->select( $tables, $fields, $where, __METHOD__, $options, $join );
79  foreach ( $res as $row ) {
80  $idToName[$row->user_id] = empty( $row->ipb_deleted ) ? $row->user_name : '';
81  }
82 
83  return $idToName;
84  }
85 
86  public function lookupUserNames(
87  array $nameToId, $audience = self::AUDIENCE_PUBLIC, $flags = self::READ_NORMAL
88  ) {
89  if ( !$nameToId ) {
90  return [];
91  }
92 
93  $audience = $this->checkAudience( $audience );
95  $db = wfGetDB( $index );
96 
97  $tables = [ 'user' ];
98  $fields = [ 'user_id', 'user_name' ];
99  $where = [
100  'user_name' => array_map( 'strval', array_keys( $nameToId ) ),
101  ];
102  $join = [];
103  if ( $audience && !$audience->isAllowed( 'hideuser' ) ) {
104  $tables[] = 'ipblocks';
105  $join['ipblocks'] = [ 'LEFT JOIN', 'ipb_user=user_id' ];
106  $where[] = 'ipb_deleted = 0 OR ipb_deleted IS NULL';
107  }
108 
109  $res = $db->select( $tables, $fields, $where, __METHOD__, $options, $join );
110  foreach ( $res as $row ) {
111  $nameToId[$row->user_name] = (int)$row->user_id;
112  }
113 
114  return $nameToId;
115  }
116 }
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:244
$tables
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist & $tables
Definition: hooks.txt:988
$wgSharedTables
$wgSharedTables
Definition: DefaultSettings.php:1909
$wgSharedDB
$wgSharedDB
Shared database for multiple wikis.
Definition: DefaultSettings.php:1899
LocalIdLookup\lookupUserNames
lookupUserNames(array $nameToId, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
Given (local) user names, return the central IDs.
Definition: LocalIdLookup.php:86
$res
$res
Definition: database.txt:21
DBAccessObjectUtils\getDBOptions
static getDBOptions( $bitfield)
Get an appropriate DB index, options, and fallback DB index for a query.
Definition: DBAccessObjectUtils.php:52
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:35
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2856
LocalIdLookup\isAttached
isAttached(User $user, $wikiId=null)
Check that a User is attached on the specified wiki.
Definition: LocalIdLookup.php:35
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
$wgLocalDatabases
$wgLocalDatabases
Other wikis on this site, can be administered from a single developer account.
Definition: DefaultSettings.php:2069
LocalIdLookup\lookupCentralIds
lookupCentralIds(array $idToName, $audience=self::AUDIENCE_PUBLIC, $flags=self::READ_NORMAL)
Given central user IDs, return the (local) user names.
Definition: LocalIdLookup.php:55
wfWikiID
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
Definition: GlobalFunctions.php:2807
LocalIdLookup
A CentralIdLookup provider that just uses local IDs.
Definition: LocalIdLookup.php:33
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1965
CentralIdLookup
The CentralIdLookup service allows for connecting local users with cluster-wide IDs.
Definition: CentralIdLookup.php:29
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
CentralIdLookup\checkAudience
checkAudience( $audience)
Check that the "audience" parameter is valid.
Definition: CentralIdLookup.php:87
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:51
$flags
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2801
array
the array() calling protocol came about after MediaWiki 1.4rc1.