MediaWiki  1.28.0
ApiQueryUsers.php
Go to the documentation of this file.
1 <?php
32 class ApiQueryUsers extends ApiQueryBase {
33 
35 
41  protected static $publicProps = [
42  // everything except 'blockinfo' which might show hidden records if the user
43  // making the request has the appropriate permissions
44  'groups',
45  'implicitgroups',
46  'rights',
47  'editcount',
48  'registration',
49  'emailable',
50  'gender',
51  'centralids',
52  'cancreate',
53  ];
54 
55  public function __construct( ApiQuery $query, $moduleName ) {
56  parent::__construct( $query, $moduleName, 'us' );
57  }
58 
66  protected function getTokenFunctions() {
67  // Don't call the hooks twice
68  if ( isset( $this->tokenFunctions ) ) {
69  return $this->tokenFunctions;
70  }
71 
72  // If we're in a mode that breaks the same-origin policy, no tokens can
73  // be obtained
74  if ( $this->lacksSameOriginSecurity() ) {
75  return [];
76  }
77 
78  $this->tokenFunctions = [
79  'userrights' => [ 'ApiQueryUsers', 'getUserrightsToken' ],
80  ];
81  Hooks::run( 'APIQueryUsersTokens', [ &$this->tokenFunctions ] );
82 
83  return $this->tokenFunctions;
84  }
85 
91  public static function getUserrightsToken( $user ) {
93 
94  // Since the permissions check for userrights is non-trivial,
95  // don't bother with it here
96  return $wgUser->getEditToken( $user->getName() );
97  }
98 
99  public function execute() {
100  $params = $this->extractRequestParams();
101 
102  if ( !is_null( $params['prop'] ) ) {
103  $this->prop = array_flip( $params['prop'] );
104  } else {
105  $this->prop = [];
106  }
107 
108  $users = (array)$params['users'];
109  $goodNames = $done = [];
110  $result = $this->getResult();
111  // Canonicalize user names
112  foreach ( $users as $u ) {
113  $n = User::getCanonicalName( $u );
114  if ( $n === false || $n === '' ) {
115  $vals = [ 'name' => $u, 'invalid' => true ];
116  $fit = $result->addValue( [ 'query', $this->getModuleName() ],
117  null, $vals );
118  if ( !$fit ) {
119  $this->setContinueEnumParameter( 'users',
120  implode( '|', array_diff( $users, $done ) ) );
121  $goodNames = [];
122  break;
123  }
124  $done[] = $u;
125  } else {
126  $goodNames[] = $n;
127  }
128  }
129 
130  $result = $this->getResult();
131 
132  if ( count( $goodNames ) ) {
133  $this->addTables( 'user' );
134  $this->addFields( User::selectFields() );
135  $this->addWhereFld( 'user_name', $goodNames );
136 
137  $this->showHiddenUsersAddBlockInfo( isset( $this->prop['blockinfo'] ) );
138 
139  $data = [];
140  $res = $this->select( __METHOD__ );
141  $this->resetQueryParams();
142 
143  // get user groups if needed
144  if ( isset( $this->prop['groups'] ) || isset( $this->prop['rights'] ) ) {
145  $userGroups = [];
146 
147  $this->addTables( 'user' );
148  $this->addWhereFld( 'user_name', $goodNames );
149  $this->addTables( 'user_groups' );
150  $this->addJoinConds( [ 'user_groups' => [ 'INNER JOIN', 'ug_user=user_id' ] ] );
151  $this->addFields( [ 'user_name', 'ug_group' ] );
152  $userGroupsRes = $this->select( __METHOD__ );
153 
154  foreach ( $userGroupsRes as $row ) {
155  $userGroups[$row->user_name][] = $row->ug_group;
156  }
157  }
158 
159  foreach ( $res as $row ) {
160  // create user object and pass along $userGroups if set
161  // that reduces the number of database queries needed in User dramatically
162  if ( !isset( $userGroups ) ) {
163  $user = User::newFromRow( $row );
164  } else {
165  if ( !isset( $userGroups[$row->user_name] ) || !is_array( $userGroups[$row->user_name] ) ) {
166  $userGroups[$row->user_name] = [];
167  }
168  $user = User::newFromRow( $row, [ 'user_groups' => $userGroups[$row->user_name] ] );
169  }
170  $name = $user->getName();
171 
172  $data[$name]['userid'] = $user->getId();
173  $data[$name]['name'] = $name;
174 
175  if ( isset( $this->prop['editcount'] ) ) {
176  $data[$name]['editcount'] = $user->getEditCount();
177  }
178 
179  if ( isset( $this->prop['registration'] ) ) {
180  $data[$name]['registration'] = wfTimestampOrNull( TS_ISO_8601, $user->getRegistration() );
181  }
182 
183  if ( isset( $this->prop['groups'] ) ) {
184  $data[$name]['groups'] = $user->getEffectiveGroups();
185  }
186 
187  if ( isset( $this->prop['implicitgroups'] ) ) {
188  $data[$name]['implicitgroups'] = $user->getAutomaticGroups();
189  }
190 
191  if ( isset( $this->prop['rights'] ) ) {
192  $data[$name]['rights'] = $user->getRights();
193  }
194  if ( $row->ipb_deleted ) {
195  $data[$name]['hidden'] = true;
196  }
197  if ( isset( $this->prop['blockinfo'] ) && !is_null( $row->ipb_by_text ) ) {
198  $data[$name]['blockid'] = (int)$row->ipb_id;
199  $data[$name]['blockedby'] = $row->ipb_by_text;
200  $data[$name]['blockedbyid'] = (int)$row->ipb_by;
201  $data[$name]['blockedtimestamp'] = wfTimestamp( TS_ISO_8601, $row->ipb_timestamp );
202  $data[$name]['blockreason'] = $row->ipb_reason;
203  $data[$name]['blockexpiry'] = $row->ipb_expiry;
204  }
205 
206  if ( isset( $this->prop['emailable'] ) ) {
207  $data[$name]['emailable'] = $user->canReceiveEmail();
208  }
209 
210  if ( isset( $this->prop['gender'] ) ) {
211  $gender = $user->getOption( 'gender' );
212  if ( strval( $gender ) === '' ) {
213  $gender = 'unknown';
214  }
215  $data[$name]['gender'] = $gender;
216  }
217 
218  if ( isset( $this->prop['centralids'] ) ) {
220  $this->getConfig(), $user, $params['attachedwiki']
221  );
222  }
223 
224  if ( !is_null( $params['token'] ) ) {
226  foreach ( $params['token'] as $t ) {
227  $val = call_user_func( $tokenFunctions[$t], $user );
228  if ( $val === false ) {
229  $this->setWarning( "Action '$t' is not allowed for the current user" );
230  } else {
231  $data[$name][$t . 'token'] = $val;
232  }
233  }
234  }
235  }
236  }
237 
238  $context = $this->getContext();
239  // Second pass: add result data to $retval
240  foreach ( $goodNames as $u ) {
241  if ( !isset( $data[$u] ) ) {
242  $data[$u] = [ 'name' => $u ];
243  $urPage = new UserrightsPage;
244  $urPage->setContext( $context );
245  $iwUser = $urPage->fetchUser( $u );
246 
247  if ( $iwUser instanceof UserRightsProxy ) {
248  $data[$u]['interwiki'] = true;
249 
250  if ( !is_null( $params['token'] ) ) {
252 
253  foreach ( $params['token'] as $t ) {
254  $val = call_user_func( $tokenFunctions[$t], $iwUser );
255  if ( $val === false ) {
256  $this->setWarning( "Action '$t' is not allowed for the current user" );
257  } else {
258  $data[$u][$t . 'token'] = $val;
259  }
260  }
261  }
262  } else {
263  $data[$u]['missing'] = true;
264  if ( isset( $this->prop['cancreate'] ) ) {
265  $status = MediaWiki\Auth\AuthManager::singleton()->canCreateAccount( $u );
266  $data[$u]['cancreate'] = $status->isGood();
267  if ( !$status->isGood() ) {
268  $data[$u]['cancreateerror'] = $this->getErrorFormatter()->arrayFromStatus( $status );
269  }
270  }
271  }
272  } else {
273  if ( isset( $this->prop['groups'] ) && isset( $data[$u]['groups'] ) ) {
274  ApiResult::setArrayType( $data[$u]['groups'], 'array' );
275  ApiResult::setIndexedTagName( $data[$u]['groups'], 'g' );
276  }
277  if ( isset( $this->prop['implicitgroups'] ) && isset( $data[$u]['implicitgroups'] ) ) {
278  ApiResult::setArrayType( $data[$u]['implicitgroups'], 'array' );
279  ApiResult::setIndexedTagName( $data[$u]['implicitgroups'], 'g' );
280  }
281  if ( isset( $this->prop['rights'] ) && isset( $data[$u]['rights'] ) ) {
282  ApiResult::setArrayType( $data[$u]['rights'], 'array' );
283  ApiResult::setIndexedTagName( $data[$u]['rights'], 'r' );
284  }
285  }
286 
287  $fit = $result->addValue( [ 'query', $this->getModuleName() ],
288  null, $data[$u] );
289  if ( !$fit ) {
290  $this->setContinueEnumParameter( 'users',
291  implode( '|', array_diff( $users, $done ) ) );
292  break;
293  }
294  $done[] = $u;
295  }
296  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'user' );
297  }
298 
299  public function getCacheMode( $params ) {
300  if ( isset( $params['token'] ) ) {
301  return 'private';
302  } elseif ( array_diff( (array)$params['prop'], static::$publicProps ) ) {
303  return 'anon-public-user-private';
304  } else {
305  return 'public';
306  }
307  }
308 
309  public function getAllowedParams() {
310  return [
311  'prop' => [
312  ApiBase::PARAM_ISMULTI => true,
314  'blockinfo',
315  'groups',
316  'implicitgroups',
317  'rights',
318  'editcount',
319  'registration',
320  'emailable',
321  'gender',
322  'centralids',
323  'cancreate',
324  // When adding a prop, consider whether it should be added
325  // to self::$publicProps
326  ],
328  ],
329  'attachedwiki' => null,
330  'users' => [
332  ],
333  'token' => [
335  ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() ),
337  ],
338  ];
339  }
340 
341  protected function getExamplesMessages() {
342  return [
343  'action=query&list=users&ususers=Example&usprop=groups|editcount|gender'
344  => 'apihelp-query+users-example-simple',
345  ];
346  }
347 
348  public function getHelpUrls() {
349  return 'https://www.mediawiki.org/wiki/API:Users';
350  }
351 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
getErrorFormatter()
Get the error formatter.
Definition: ApiBase.php:591
static newFromRow($row, $data=null)
Create a new user object from a user row.
Definition: User.php:612
the array() calling protocol came about after MediaWiki 1.4rc1.
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1555
getResult()
Get the result object.
Definition: ApiBase.php:577
addWhereFld($field, $value)
Equivalent to addWhere(array($field => $value))
Cut-down copy of User interface for local-interwiki-database user rights manipulation.
static getCanonicalName($name, $validate= 'valid')
Given unvalidated user input, return a canonical username, or false if the username is invalid...
Definition: User.php:1046
This is a base class for all Query modules.
lacksSameOriginSecurity()
Returns true if the current request breaks the same-origin policy.
Definition: ApiBase.php:505
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:678
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition: ApiBase.php:157
select($method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
__construct(ApiQuery $query, $moduleName)
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
const TS_ISO_8601
ISO 8601 format with no timezone: 1986-02-09T20:00:00Z.
Definition: defines.php:28
IContextSource $context
addJoinConds($join_conds)
Add a set of JOIN conditions to the internal array.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:618
static selectFields()
Return the list of user fields that should be selected to create a new user object.
Definition: User.php:5325
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message.Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item.Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page.Return false to stop further processing of the tag $reader:XMLReader object &$pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision.Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag.Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload.Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports.&$fullInterwikiPrefix:Interwiki prefix, may contain colons.&$pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable.Can be used to lazy-load the import sources list.&$importSources:The value of $wgImportSources.Modify as necessary.See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page.$context:IContextSource object &$pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect.&$title:Title object for the current page &$request:WebRequest &$ignoreRedirect:boolean to skip redirect check &$target:Title/string of redirect target &$article:Article object 'InternalParseBeforeLinks':during Parser's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InternalParseBeforeSanitize':during Parser's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings.Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not.Return true without providing an interwiki to continue interwiki search.$prefix:interwiki prefix we are looking for.&$iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user's email has been invalidated successfully.$user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification.Callee may modify $url and $query, URL will be constructed as $url.$query &$url:URL to index.php &$query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) &$article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() &$ip:IP being check &$result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from &$allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn't match your organization.$addr:The e-mail address entered by the user &$result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user &$result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we're looking for a messages file for &$file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces.Do not use this hook to add namespaces.Use CanonicalNamespaces for that.&$namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names.&$names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page's language links.This is called in various places to allow extensions to define the effective language links for a page.$title:The page's Title.&$links:Associative array mapping language codes to prefixed links of the form"language:title".&$linkFlags:Associative array mapping prefixed links to arrays of flags.Currently unused, but planned to provide support for marking individual language links in the UI, e.g.for featured articles. 'LanguageSelector':Hook to change the language selector available on a page.$out:The output page.$cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED!Use HtmlPageLinkRendererBegin instead.Used when generating internal and interwiki links in Linker::link(), before processing starts.Return false to skip default processing and return $ret.See documentation for Linker::link() for details on the expected meanings of parameters.$skin:the Skin object $target:the Title that the link is pointing to &$html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1934
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
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 noclasses just before the function returns a value If you return true
Definition: hooks.txt:1936
static singleton()
Get the global AuthManager.
$res
Definition: database.txt:21
getConfig()
Get the Config object.
getContext()
Get the base IContextSource object.
$params
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:457
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
This is the main query class.
Definition: ApiQuery.php:38
setWarning($warning)
Set warning section for this module.
Definition: ApiBase.php:1543
static getCentralUserInfo(Config $config, User $user, $attachedWiki=null)
Get central user info.
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
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 local account $user
Definition: hooks.txt:242
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
static getUserrightsToken($user)
static array $publicProps
Properties whose contents does not depend on who is looking at them.
addFields($value)
Add a set of fields to select to the internal array.
Query module to get information about a list of users.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:53
setContinueEnumParameter($paramName, $paramValue)
Set a query-continue value.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
Special page to allow managing user group membership.
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition: ApiBase.php:106
showHiddenUsersAddBlockInfo($showBlockInfo)
Filters hidden users (where the user doesn't have the right to view them) Also adds relevant block in...
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
Definition: ApiResult.php:730
wfTimestampOrNull($outputtype=TS_UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
getTokenFunctions()
Get an array mapping token names to their handler functions.
setContext($context)
Sets the context this SpecialPage is executed in.
addTables($tables, $alias=null)
Add a set of tables to the internal array.
resetQueryParams()
Blank the internal arrays with query parameters.
getCacheMode($params)
$wgUser
Definition: Setup.php:806
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300