MediaWiki  master
ApiQueryUserInfo.php
Go to the documentation of this file.
1 <?php
25 
32 
34 
35  const WL_UNREAD_LIMIT = 1000;
36 
37  private $params = [];
38  private $prop = [];
39 
40  public function __construct( ApiQuery $query, $moduleName ) {
41  parent::__construct( $query, $moduleName, 'ui' );
42  }
43 
44  public function execute() {
45  $this->params = $this->extractRequestParams();
46  $result = $this->getResult();
47 
48  if ( !is_null( $this->params['prop'] ) ) {
49  $this->prop = array_flip( $this->params['prop'] );
50  }
51 
52  $r = $this->getCurrentUserInfo();
53  $result->addValue( 'query', $this->getModuleName(), $r );
54  }
55 
63  public static function getBlockInfo( AbstractBlock $block ) {
64  wfDeprecated( __METHOD__, '1.34' );
65 
66  // Hack to access a private method from a trait:
67  $dummy = new class {
68  use ApiBlockInfoTrait {
69  getBlockDetails as public;
70  }
71  };
72 
73  return $dummy->getBlockDetails( $block );
74  }
75 
88  public static function getCentralUserInfo( Config $config, User $user, $attachedWiki = null ) {
89  $providerIds = array_keys( $config->get( 'CentralIdLookupProviders' ) );
90 
91  $ret = [
92  'centralids' => [],
93  'attachedlocal' => [],
94  ];
95  ApiResult::setArrayType( $ret['centralids'], 'assoc' );
96  ApiResult::setArrayType( $ret['attachedlocal'], 'assoc' );
97  if ( $attachedWiki ) {
98  $ret['attachedwiki'] = [];
99  ApiResult::setArrayType( $ret['attachedwiki'], 'assoc' );
100  }
101 
102  $name = $user->getName();
103  foreach ( $providerIds as $providerId ) {
104  $provider = CentralIdLookup::factory( $providerId );
105  $ret['centralids'][$providerId] = $provider->centralIdFromName( $name );
106  $ret['attachedlocal'][$providerId] = $provider->isAttached( $user );
107  if ( $attachedWiki ) {
108  $ret['attachedwiki'][$providerId] = $provider->isAttached( $user, $attachedWiki );
109  }
110  }
111 
112  return $ret;
113  }
114 
115  protected function getCurrentUserInfo() {
116  $user = $this->getUser();
117  $vals = [];
118  $vals['id'] = (int)$user->getId();
119  $vals['name'] = $user->getName();
120 
121  if ( $user->isAnon() ) {
122  $vals['anon'] = true;
123  }
124 
125  if ( isset( $this->prop['blockinfo'] ) ) {
126  $block = $user->getBlock();
127  if ( $block ) {
128  $vals = array_merge( $vals, $this->getBlockDetails( $block ) );
129  }
130  }
131 
132  if ( isset( $this->prop['hasmsg'] ) ) {
133  $vals['messages'] = $user->getNewtalk();
134  }
135 
136  if ( isset( $this->prop['groups'] ) ) {
137  $vals['groups'] = $user->getEffectiveGroups();
138  ApiResult::setArrayType( $vals['groups'], 'array' ); // even if empty
139  ApiResult::setIndexedTagName( $vals['groups'], 'g' ); // even if empty
140  }
141 
142  if ( isset( $this->prop['groupmemberships'] ) ) {
143  $ugms = $user->getGroupMemberships();
144  $vals['groupmemberships'] = [];
145  foreach ( $ugms as $group => $ugm ) {
146  $vals['groupmemberships'][] = [
147  'group' => $group,
148  'expiry' => ApiResult::formatExpiry( $ugm->getExpiry() ),
149  ];
150  }
151  ApiResult::setArrayType( $vals['groupmemberships'], 'array' ); // even if empty
152  ApiResult::setIndexedTagName( $vals['groupmemberships'], 'groupmembership' ); // even if empty
153  }
154 
155  if ( isset( $this->prop['implicitgroups'] ) ) {
156  $vals['implicitgroups'] = $user->getAutomaticGroups();
157  ApiResult::setArrayType( $vals['implicitgroups'], 'array' ); // even if empty
158  ApiResult::setIndexedTagName( $vals['implicitgroups'], 'g' ); // even if empty
159  }
160 
161  if ( isset( $this->prop['rights'] ) ) {
162  // User::getRights() may return duplicate values, strip them
163  $vals['rights'] = array_values( array_unique( $user->getRights() ) );
164  ApiResult::setArrayType( $vals['rights'], 'array' ); // even if empty
165  ApiResult::setIndexedTagName( $vals['rights'], 'r' ); // even if empty
166  }
167 
168  if ( isset( $this->prop['changeablegroups'] ) ) {
169  $vals['changeablegroups'] = $user->changeableGroups();
170  ApiResult::setIndexedTagName( $vals['changeablegroups']['add'], 'g' );
171  ApiResult::setIndexedTagName( $vals['changeablegroups']['remove'], 'g' );
172  ApiResult::setIndexedTagName( $vals['changeablegroups']['add-self'], 'g' );
173  ApiResult::setIndexedTagName( $vals['changeablegroups']['remove-self'], 'g' );
174  }
175 
176  if ( isset( $this->prop['options'] ) ) {
177  $vals['options'] = $user->getOptions();
178  $vals['options'][ApiResult::META_BC_BOOLS] = array_keys( $vals['options'] );
179  }
180 
181  if ( isset( $this->prop['preferencestoken'] ) &&
182  !$this->lacksSameOriginSecurity() &&
183  $user->isAllowed( 'editmyoptions' )
184  ) {
185  $vals['preferencestoken'] = $user->getEditToken( '', $this->getMain()->getRequest() );
186  }
187 
188  if ( isset( $this->prop['editcount'] ) ) {
189  // use intval to prevent null if a non-logged-in user calls
190  // api.php?format=jsonfm&action=query&meta=userinfo&uiprop=editcount
191  $vals['editcount'] = (int)$user->getEditCount();
192  }
193 
194  if ( isset( $this->prop['ratelimits'] ) ) {
195  $vals['ratelimits'] = $this->getRateLimits();
196  }
197 
198  if ( isset( $this->prop['realname'] ) &&
199  !in_array( 'realname', $this->getConfig()->get( 'HiddenPrefs' ) )
200  ) {
201  $vals['realname'] = $user->getRealName();
202  }
203 
204  if ( $user->isAllowed( 'viewmyprivateinfo' ) && isset( $this->prop['email'] ) ) {
205  $vals['email'] = $user->getEmail();
206  $auth = $user->getEmailAuthenticationTimestamp();
207  if ( $auth !== null ) {
208  $vals['emailauthenticated'] = wfTimestamp( TS_ISO_8601, $auth );
209  }
210  }
211 
212  if ( isset( $this->prop['registrationdate'] ) ) {
213  $regDate = $user->getRegistration();
214  if ( $regDate !== false ) {
215  $vals['registrationdate'] = wfTimestamp( TS_ISO_8601, $regDate );
216  }
217  }
218 
219  if ( isset( $this->prop['acceptlang'] ) ) {
220  $langs = $this->getRequest()->getAcceptLang();
221  $acceptLang = [];
222  foreach ( $langs as $lang => $val ) {
223  $r = [ 'q' => $val ];
224  ApiResult::setContentValue( $r, 'code', $lang );
225  $acceptLang[] = $r;
226  }
227  ApiResult::setIndexedTagName( $acceptLang, 'lang' );
228  $vals['acceptlang'] = $acceptLang;
229  }
230 
231  if ( isset( $this->prop['unreadcount'] ) ) {
232  $store = MediaWikiServices::getInstance()->getWatchedItemStore();
233  $unreadNotifications = $store->countUnreadNotifications(
234  $user,
235  self::WL_UNREAD_LIMIT
236  );
237 
238  if ( $unreadNotifications === true ) {
239  $vals['unreadcount'] = self::WL_UNREAD_LIMIT . '+';
240  } else {
241  $vals['unreadcount'] = $unreadNotifications;
242  }
243  }
244 
245  if ( isset( $this->prop['centralids'] ) ) {
246  $vals += self::getCentralUserInfo(
247  $this->getConfig(), $this->getUser(), $this->params['attachedwiki']
248  );
249  }
250 
251  if ( isset( $this->prop['latestcontrib'] ) ) {
252  $ts = $this->getLatestContributionTime();
253  if ( $ts !== null ) {
254  $vals['latestcontrib'] = $ts;
255  }
256  }
257 
258  return $vals;
259  }
260 
261  protected function getRateLimits() {
262  $retval = [
263  ApiResult::META_TYPE => 'assoc',
264  ];
265 
266  $user = $this->getUser();
267  if ( !$user->isPingLimitable() ) {
268  return $retval; // No limits
269  }
270 
271  // Find out which categories we belong to
272  $categories = [];
273  if ( $user->isAnon() ) {
274  $categories[] = 'anon';
275  } else {
276  $categories[] = 'user';
277  }
278  if ( $user->isNewbie() ) {
279  $categories[] = 'ip';
280  $categories[] = 'subnet';
281  if ( !$user->isAnon() ) {
282  $categories[] = 'newbie';
283  }
284  }
285  $categories = array_merge( $categories, $user->getGroups() );
286 
287  // Now get the actual limits
288  foreach ( $this->getConfig()->get( 'RateLimits' ) as $action => $limits ) {
289  foreach ( $categories as $cat ) {
290  if ( isset( $limits[$cat] ) && !is_null( $limits[$cat] ) ) {
291  $retval[$action][$cat]['hits'] = (int)$limits[$cat][0];
292  $retval[$action][$cat]['seconds'] = (int)$limits[$cat][1];
293  }
294  }
295  }
296 
297  return $retval;
298  }
299 
303  protected function getLatestContributionTime() {
305 
306  $user = $this->getUser();
307  $dbr = $this->getDB();
308 
309  if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW ) {
310  if ( $user->getActorId() === null ) {
311  return null;
312  }
313  $res = $dbr->selectField( 'revision_actor_temp',
314  'MAX(revactor_timestamp)',
315  [ 'revactor_actor' => $user->getActorId() ],
316  __METHOD__
317  );
318  } else {
319  if ( $user->isLoggedIn() ) {
320  $conds = [ 'rev_user' => $user->getId() ];
321  } else {
322  $conds = [ 'rev_user_text' => $user->getName() ];
323  }
324  $res = $dbr->selectField( 'revision',
325  'MAX(rev_timestamp)',
326  $conds,
327  __METHOD__
328  );
329  }
330 
331  return $res ? wfTimestamp( TS_ISO_8601, $res ) : null;
332  }
333 
334  public function getAllowedParams() {
335  return [
336  'prop' => [
337  ApiBase::PARAM_ISMULTI => true,
339  'blockinfo',
340  'hasmsg',
341  'groups',
342  'groupmemberships',
343  'implicitgroups',
344  'rights',
345  'changeablegroups',
346  'options',
347  'editcount',
348  'ratelimits',
349  'email',
350  'realname',
351  'acceptlang',
352  'registrationdate',
353  'unreadcount',
354  'centralids',
355  'preferencestoken',
356  'latestcontrib',
357  ],
359  'unreadcount' => [
360  'apihelp-query+userinfo-paramvalue-prop-unreadcount',
361  self::WL_UNREAD_LIMIT - 1,
362  self::WL_UNREAD_LIMIT . '+',
363  ],
364  ],
366  'preferencestoken' => [
367  'apiwarn-deprecation-withreplacement',
368  $this->getModulePrefix() . "prop=preferencestoken",
369  'action=query&meta=tokens',
370  ]
371  ],
372  ],
373  'attachedwiki' => null,
374  ];
375  }
376 
377  protected function getExamplesMessages() {
378  return [
379  'action=query&meta=userinfo'
380  => 'apihelp-query+userinfo-example-simple',
381  'action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg'
382  => 'apihelp-query+userinfo-example-data',
383  ];
384  }
385 
386  public function getHelpUrls() {
387  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Userinfo';
388  }
389 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
getDB()
Get the Query database connection (read-only)
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used $groups Array of ChangesListFilterGroup objects(added in 1.34) 'FileDeleteComplete' 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:1529
getResult()
Get the result object.
Definition: ApiBase.php:640
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 & $ret
Definition: hooks.txt:1972
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getMain()
Get the main module.
Definition: ApiBase.php:536
int $wgActorTableSchemaMigrationStage
Actor table schema migration stage.
if(!isset( $args[0])) $lang
This is a base class for all Query modules.
lacksSameOriginSecurity()
Returns true if the current request breaks the same-origin policy.
Definition: ApiBase.php:568
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
const META_TYPE
Key for the &#39;type&#39; metadata item.
Definition: ApiResult.php:110
const SCHEMA_COMPAT_READ_NEW
Definition: Defines.php:267
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
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:164
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
Definition: ApiResult.php:478
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
get( $name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
getName()
Get the user name, or the IP of an anonymous user.
Definition: User.php:2251
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\*-\*)") will be honored when streaming the file. '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 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name '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. '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 '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:Array with elements of the form "language:title" in the order that they will be output. & $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 since 1.28! 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:1970
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:51
static formatExpiry( $expiry, $infinity='infinity')
Format an expiry timestamp for API output.
Definition: ApiResult.php:1205
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
__construct(ApiQuery $query, $moduleName)
Interface for configuration instances.
Definition: Config.php:28
Query module to get information about the currently logged-in user.
$res
Definition: database.txt:21
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
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:520
This is the main query class.
Definition: ApiQuery.php:36
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
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 factory( $providerId=null)
Fetch a CentralIdLookup.
static getBlockInfo(AbstractBlock $block)
Get basic info about a given block.
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:528
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
const PARAM_DEPRECATED_VALUES
(array) When PARAM_TYPE is an array, this indicates which of the values are deprecated.
Definition: ApiBase.php:209
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
const META_BC_BOOLS
Key for the &#39;BC bools&#39; metadata item.
Definition: ApiResult.php:136
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
Definition: ApiResult.php:728
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454