MediaWiki  master
ApiQueryUserInfo.php
Go to the documentation of this file.
1 <?php
24 
31 
32  const WL_UNREAD_LIMIT = 1000;
33 
34  private $params = [];
35  private $prop = [];
36 
37  public function __construct( ApiQuery $query, $moduleName ) {
38  parent::__construct( $query, $moduleName, 'ui' );
39  }
40 
41  public function execute() {
42  $this->params = $this->extractRequestParams();
43  $result = $this->getResult();
44 
45  if ( !is_null( $this->params['prop'] ) ) {
46  $this->prop = array_flip( $this->params['prop'] );
47  }
48 
49  $r = $this->getCurrentUserInfo();
50  $result->addValue( 'query', $this->getModuleName(), $r );
51  }
52 
65  public static function getBlockInfo( Block $block ) {
66  $vals = [];
67  $vals['blockid'] = $block->getId();
68  $vals['blockedby'] = $block->getByName();
69  $vals['blockedbyid'] = $block->getBy();
70  $vals['blockreason'] = $block->mReason;
71  $vals['blockedtimestamp'] = wfTimestamp( TS_ISO_8601, $block->mTimestamp );
72  $vals['blockexpiry'] = ApiResult::formatExpiry( $block->getExpiry(), 'infinite' );
73  if ( $block->getSystemBlockType() !== null ) {
74  $vals['systemblocktype'] = $block->getSystemBlockType();
75  }
76  return $vals;
77  }
78 
91  public static function getCentralUserInfo( Config $config, User $user, $attachedWiki = null ) {
92  $providerIds = array_keys( $config->get( 'CentralIdLookupProviders' ) );
93 
94  $ret = [
95  'centralids' => [],
96  'attachedlocal' => [],
97  ];
98  ApiResult::setArrayType( $ret['centralids'], 'assoc' );
99  ApiResult::setArrayType( $ret['attachedlocal'], 'assoc' );
100  if ( $attachedWiki ) {
101  $ret['attachedwiki'] = [];
102  ApiResult::setArrayType( $ret['attachedwiki'], 'assoc' );
103  }
104 
105  $name = $user->getName();
106  foreach ( $providerIds as $providerId ) {
107  $provider = CentralIdLookup::factory( $providerId );
108  $ret['centralids'][$providerId] = $provider->centralIdFromName( $name );
109  $ret['attachedlocal'][$providerId] = $provider->isAttached( $user );
110  if ( $attachedWiki ) {
111  $ret['attachedwiki'][$providerId] = $provider->isAttached( $user, $attachedWiki );
112  }
113  }
114 
115  return $ret;
116  }
117 
118  protected function getCurrentUserInfo() {
119  $user = $this->getUser();
120  $vals = [];
121  $vals['id'] = intval( $user->getId() );
122  $vals['name'] = $user->getName();
123 
124  if ( $user->isAnon() ) {
125  $vals['anon'] = true;
126  }
127 
128  if ( isset( $this->prop['blockinfo'] ) && $user->isBlocked() ) {
129  $vals = array_merge( $vals, self::getBlockInfo( $user->getBlock() ) );
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'] = intval( $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' ) ) {
205  if ( isset( $this->prop['email'] ) ) {
206  $vals['email'] = $user->getEmail();
207  $auth = $user->getEmailAuthenticationTimestamp();
208  if ( !is_null( $auth ) ) {
209  $vals['emailauthenticated'] = wfTimestamp( TS_ISO_8601, $auth );
210  }
211  }
212  }
213 
214  if ( isset( $this->prop['registrationdate'] ) ) {
215  $regDate = $user->getRegistration();
216  if ( $regDate !== false ) {
217  $vals['registrationdate'] = wfTimestamp( TS_ISO_8601, $regDate );
218  }
219  }
220 
221  if ( isset( $this->prop['acceptlang'] ) ) {
222  $langs = $this->getRequest()->getAcceptLang();
223  $acceptLang = [];
224  foreach ( $langs as $lang => $val ) {
225  $r = [ 'q' => $val ];
226  ApiResult::setContentValue( $r, 'code', $lang );
227  $acceptLang[] = $r;
228  }
229  ApiResult::setIndexedTagName( $acceptLang, 'lang' );
230  $vals['acceptlang'] = $acceptLang;
231  }
232 
233  if ( isset( $this->prop['unreadcount'] ) ) {
234  $store = MediaWikiServices::getInstance()->getWatchedItemStore();
235  $unreadNotifications = $store->countUnreadNotifications(
236  $user,
237  self::WL_UNREAD_LIMIT
238  );
239 
240  if ( $unreadNotifications === true ) {
241  $vals['unreadcount'] = self::WL_UNREAD_LIMIT . '+';
242  } else {
243  $vals['unreadcount'] = $unreadNotifications;
244  }
245  }
246 
247  if ( isset( $this->prop['centralids'] ) ) {
248  $vals += self::getCentralUserInfo(
249  $this->getConfig(), $this->getUser(), $this->params['attachedwiki']
250  );
251  }
252 
253  return $vals;
254  }
255 
256  protected function getRateLimits() {
257  $retval = [
258  ApiResult::META_TYPE => 'assoc',
259  ];
260 
261  $user = $this->getUser();
262  if ( !$user->isPingLimitable() ) {
263  return $retval; // No limits
264  }
265 
266  // Find out which categories we belong to
267  $categories = [];
268  if ( $user->isAnon() ) {
269  $categories[] = 'anon';
270  } else {
271  $categories[] = 'user';
272  }
273  if ( $user->isNewbie() ) {
274  $categories[] = 'ip';
275  $categories[] = 'subnet';
276  if ( !$user->isAnon() ) {
277  $categories[] = 'newbie';
278  }
279  }
280  $categories = array_merge( $categories, $user->getGroups() );
281 
282  // Now get the actual limits
283  foreach ( $this->getConfig()->get( 'RateLimits' ) as $action => $limits ) {
284  foreach ( $categories as $cat ) {
285  if ( isset( $limits[$cat] ) && !is_null( $limits[$cat] ) ) {
286  $retval[$action][$cat]['hits'] = intval( $limits[$cat][0] );
287  $retval[$action][$cat]['seconds'] = intval( $limits[$cat][1] );
288  }
289  }
290  }
291 
292  return $retval;
293  }
294 
295  public function getAllowedParams() {
296  return [
297  'prop' => [
298  ApiBase::PARAM_ISMULTI => true,
300  'blockinfo',
301  'hasmsg',
302  'groups',
303  'groupmemberships',
304  'implicitgroups',
305  'rights',
306  'changeablegroups',
307  'options',
308  'editcount',
309  'ratelimits',
310  'email',
311  'realname',
312  'acceptlang',
313  'registrationdate',
314  'unreadcount',
315  'centralids',
316  'preferencestoken',
317  ],
319  'unreadcount' => [
320  'apihelp-query+userinfo-paramvalue-prop-unreadcount',
321  self::WL_UNREAD_LIMIT - 1,
322  self::WL_UNREAD_LIMIT . '+',
323  ],
324  ],
326  'preferencestoken' => [
327  'apiwarn-deprecation-withreplacement',
328  $this->getModulePrefix() . "prop=preferencestoken",
329  'action=query&meta=tokens',
330  ]
331  ],
332  ],
333  'attachedwiki' => null,
334  ];
335  }
336 
337  protected function getExamplesMessages() {
338  return [
339  'action=query&meta=userinfo'
340  => 'apihelp-query+userinfo-example-simple',
341  'action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg'
342  => 'apihelp-query+userinfo-example-data',
343  ];
344  }
345 
346  public function getHelpUrls() {
347  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Userinfo';
348  }
349 }
getBy()
Get the user id of the blocking sysop.
Definition: Block.php:990
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:87
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:1628
getResult()
Get the result object.
Definition: ApiBase.php:659
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:2037
getSystemBlockType()
Get the system block type, if any.
Definition: Block.php:1022
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getMain()
Get the main module.
Definition: ApiBase.php:555
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:587
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:770
const META_TYPE
Key for the &#39;type&#39; metadata item.
Definition: ApiResult.php:110
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:157
getId()
Get the block ID.
Definition: Block.php:1013
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:2463
static getBlockInfo(Block $block)
Get basic info about a given block.
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 '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. 'LanguageGetMagic':DEPRECATED since 1.16! 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: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:2035
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:47
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.
getExpiry()
Definition: Block.php:1483
__construct(ApiQuery $query, $moduleName)
Interface for configuration instances.
Definition: Config.php:28
Query module to get information about the currently logged-in user.
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:539
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.
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:547
const PARAM_DEPRECATED_VALUES
(array) When PARAM_TYPE is an array, this indicates which of the values are deprecated.
Definition: ApiBase.php:202
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:51
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:302
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
Definition: ApiResult.php:728
Definition: Block.php:27
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 incomplete not yet checked for validity & $retval
Definition: hooks.txt:244
getByName()
Get the username of the blocking sysop.
Definition: Block.php:1002
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:244