MediaWiki  1.28.0
ApiQueryUserInfo.php
Go to the documentation of this file.
1 <?php
28 
35 
36  const WL_UNREAD_LIMIT = 1000;
37 
38  private $params = [];
39  private $prop = [];
40 
41  public function __construct( ApiQuery $query, $moduleName ) {
42  parent::__construct( $query, $moduleName, 'ui' );
43  }
44 
45  public function execute() {
46  $this->params = $this->extractRequestParams();
47  $result = $this->getResult();
48 
49  if ( !is_null( $this->params['prop'] ) ) {
50  $this->prop = array_flip( $this->params['prop'] );
51  }
52 
53  $r = $this->getCurrentUserInfo();
54  $result->addValue( 'query', $this->getModuleName(), $r );
55  }
56 
68  public static function getBlockInfo( Block $block ) {
70  $vals = [];
71  $vals['blockid'] = $block->getId();
72  $vals['blockedby'] = $block->getByName();
73  $vals['blockedbyid'] = $block->getBy();
74  $vals['blockreason'] = $block->mReason;
75  $vals['blockedtimestamp'] = wfTimestamp( TS_ISO_8601, $block->mTimestamp );
76  $vals['blockexpiry'] = $wgContLang->formatExpiry(
77  $block->getExpiry(), TS_ISO_8601, 'infinite'
78  );
79  return $vals;
80  }
81 
94  public static function getCentralUserInfo( Config $config, User $user, $attachedWiki = null ) {
95  $providerIds = array_keys( $config->get( 'CentralIdLookupProviders' ) );
96 
97  $ret = [
98  'centralids' => [],
99  'attachedlocal' => [],
100  ];
101  ApiResult::setArrayType( $ret['centralids'], 'assoc' );
102  ApiResult::setArrayType( $ret['attachedlocal'], 'assoc' );
103  if ( $attachedWiki ) {
104  $ret['attachedwiki'] = [];
105  ApiResult::setArrayType( $ret['attachedwiki'], 'assoc' );
106  }
107 
108  $name = $user->getName();
109  foreach ( $providerIds as $providerId ) {
110  $provider = CentralIdLookup::factory( $providerId );
111  $ret['centralids'][$providerId] = $provider->centralIdFromName( $name );
112  $ret['attachedlocal'][$providerId] = $provider->isAttached( $user );
113  if ( $attachedWiki ) {
114  $ret['attachedwiki'][$providerId] = $provider->isAttached( $user, $attachedWiki );
115  }
116  }
117 
118  return $ret;
119  }
120 
121  protected function getCurrentUserInfo() {
122  $user = $this->getUser();
123  $vals = [];
124  $vals['id'] = intval( $user->getId() );
125  $vals['name'] = $user->getName();
126 
127  if ( $user->isAnon() ) {
128  $vals['anon'] = true;
129  }
130 
131  if ( isset( $this->prop['blockinfo'] ) && $user->isBlocked() ) {
132  $vals = array_merge( $vals, self::getBlockInfo( $user->getBlock() ) );
133  }
134 
135  if ( isset( $this->prop['hasmsg'] ) ) {
136  $vals['messages'] = $user->getNewtalk();
137  }
138 
139  if ( isset( $this->prop['groups'] ) ) {
140  $vals['groups'] = $user->getEffectiveGroups();
141  ApiResult::setArrayType( $vals['groups'], 'array' ); // even if empty
142  ApiResult::setIndexedTagName( $vals['groups'], 'g' ); // even if empty
143  }
144 
145  if ( isset( $this->prop['implicitgroups'] ) ) {
146  $vals['implicitgroups'] = $user->getAutomaticGroups();
147  ApiResult::setArrayType( $vals['implicitgroups'], 'array' ); // even if empty
148  ApiResult::setIndexedTagName( $vals['implicitgroups'], 'g' ); // even if empty
149  }
150 
151  if ( isset( $this->prop['rights'] ) ) {
152  // User::getRights() may return duplicate values, strip them
153  $vals['rights'] = array_values( array_unique( $user->getRights() ) );
154  ApiResult::setArrayType( $vals['rights'], 'array' ); // even if empty
155  ApiResult::setIndexedTagName( $vals['rights'], 'r' ); // even if empty
156  }
157 
158  if ( isset( $this->prop['changeablegroups'] ) ) {
159  $vals['changeablegroups'] = $user->changeableGroups();
160  ApiResult::setIndexedTagName( $vals['changeablegroups']['add'], 'g' );
161  ApiResult::setIndexedTagName( $vals['changeablegroups']['remove'], 'g' );
162  ApiResult::setIndexedTagName( $vals['changeablegroups']['add-self'], 'g' );
163  ApiResult::setIndexedTagName( $vals['changeablegroups']['remove-self'], 'g' );
164  }
165 
166  if ( isset( $this->prop['options'] ) ) {
167  $vals['options'] = $user->getOptions();
168  $vals['options'][ApiResult::META_BC_BOOLS] = array_keys( $vals['options'] );
169  }
170 
171  if ( isset( $this->prop['preferencestoken'] ) ) {
172  $p = $this->getModulePrefix();
173  $this->setWarning(
174  "{$p}prop=preferencestoken has been deprecated. Please use action=query&meta=tokens instead."
175  );
176  }
177  if ( isset( $this->prop['preferencestoken'] ) &&
178  !$this->lacksSameOriginSecurity() &&
179  $user->isAllowed( 'editmyoptions' )
180  ) {
181  $vals['preferencestoken'] = $user->getEditToken( '', $this->getMain()->getRequest() );
182  }
183 
184  if ( isset( $this->prop['editcount'] ) ) {
185  // use intval to prevent null if a non-logged-in user calls
186  // api.php?format=jsonfm&action=query&meta=userinfo&uiprop=editcount
187  $vals['editcount'] = intval( $user->getEditCount() );
188  }
189 
190  if ( isset( $this->prop['ratelimits'] ) ) {
191  $vals['ratelimits'] = $this->getRateLimits();
192  }
193 
194  if ( isset( $this->prop['realname'] ) &&
195  !in_array( 'realname', $this->getConfig()->get( 'HiddenPrefs' ) )
196  ) {
197  $vals['realname'] = $user->getRealName();
198  }
199 
200  if ( $user->isAllowed( 'viewmyprivateinfo' ) ) {
201  if ( isset( $this->prop['email'] ) ) {
202  $vals['email'] = $user->getEmail();
203  $auth = $user->getEmailAuthenticationTimestamp();
204  if ( !is_null( $auth ) ) {
205  $vals['emailauthenticated'] = wfTimestamp( TS_ISO_8601, $auth );
206  }
207  }
208  }
209 
210  if ( isset( $this->prop['registrationdate'] ) ) {
211  $regDate = $user->getRegistration();
212  if ( $regDate !== false ) {
213  $vals['registrationdate'] = wfTimestamp( TS_ISO_8601, $regDate );
214  }
215  }
216 
217  if ( isset( $this->prop['acceptlang'] ) ) {
218  $langs = $this->getRequest()->getAcceptLang();
219  $acceptLang = [];
220  foreach ( $langs as $lang => $val ) {
221  $r = [ 'q' => $val ];
222  ApiResult::setContentValue( $r, 'code', $lang );
223  $acceptLang[] = $r;
224  }
225  ApiResult::setIndexedTagName( $acceptLang, 'lang' );
226  $vals['acceptlang'] = $acceptLang;
227  }
228 
229  if ( isset( $this->prop['unreadcount'] ) ) {
230  $store = MediaWikiServices::getInstance()->getWatchedItemStore();
231  $unreadNotifications = $store->countUnreadNotifications(
232  $user,
233  self::WL_UNREAD_LIMIT
234  );
235 
236  if ( $unreadNotifications === true ) {
237  $vals['unreadcount'] = self::WL_UNREAD_LIMIT . '+';
238  } else {
239  $vals['unreadcount'] = $unreadNotifications;
240  }
241  }
242 
243  if ( isset( $this->prop['centralids'] ) ) {
244  $vals += self::getCentralUserInfo(
245  $this->getConfig(), $this->getUser(), $this->params['attachedwiki']
246  );
247  }
248 
249  return $vals;
250  }
251 
252  protected function getRateLimits() {
253  $retval = [
254  ApiResult::META_TYPE => 'assoc',
255  ];
256 
257  $user = $this->getUser();
258  if ( !$user->isPingLimitable() ) {
259  return $retval; // No limits
260  }
261 
262  // Find out which categories we belong to
263  $categories = [];
264  if ( $user->isAnon() ) {
265  $categories[] = 'anon';
266  } else {
267  $categories[] = 'user';
268  }
269  if ( $user->isNewbie() ) {
270  $categories[] = 'ip';
271  $categories[] = 'subnet';
272  if ( !$user->isAnon() ) {
273  $categories[] = 'newbie';
274  }
275  }
276  $categories = array_merge( $categories, $user->getGroups() );
277 
278  // Now get the actual limits
279  foreach ( $this->getConfig()->get( 'RateLimits' ) as $action => $limits ) {
280  foreach ( $categories as $cat ) {
281  if ( isset( $limits[$cat] ) && !is_null( $limits[$cat] ) ) {
282  $retval[$action][$cat]['hits'] = intval( $limits[$cat][0] );
283  $retval[$action][$cat]['seconds'] = intval( $limits[$cat][1] );
284  }
285  }
286  }
287 
288  return $retval;
289  }
290 
291  public function getAllowedParams() {
292  return [
293  'prop' => [
294  ApiBase::PARAM_ISMULTI => true,
296  'blockinfo',
297  'hasmsg',
298  'groups',
299  'implicitgroups',
300  'rights',
301  'changeablegroups',
302  'options',
303  'preferencestoken',
304  'editcount',
305  'ratelimits',
306  'email',
307  'realname',
308  'acceptlang',
309  'registrationdate',
310  'unreadcount',
311  'centralids',
312  ],
314  'unreadcount' => [
315  'apihelp-query+userinfo-paramvalue-prop-unreadcount',
316  self::WL_UNREAD_LIMIT - 1,
317  self::WL_UNREAD_LIMIT . '+',
318  ],
319  ],
320  ],
321  'attachedwiki' => null,
322  ];
323  }
324 
325  protected function getExamplesMessages() {
326  return [
327  'action=query&meta=userinfo'
328  => 'apihelp-query+userinfo-example-simple',
329  'action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg'
330  => 'apihelp-query+userinfo-example-data',
331  ];
332  }
333 
334  public function getHelpUrls() {
335  return 'https://www.mediawiki.org/wiki/API:Userinfo';
336  }
337 }
getBy()
Get the user id of the blocking sysop.
Definition: Block.php:910
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
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
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:1936
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getMain()
Get the main module.
Definition: ApiBase.php:473
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:505
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:678
const META_TYPE
Key for the 'type' metadata item.
Definition: ApiResult.php:108
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:933
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
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:480
const TS_ISO_8601
ISO 8601 format with no timezone: 1986-02-09T20:00:00Z.
Definition: defines.php:28
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:618
getName()
Get the user name, or the IP of an anonymous user.
Definition: User.php:2108
get($name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
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 '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.
getRequest()
Get the WebRequest object.
getExpiry()
Definition: Block.php:1392
__construct(ApiQuery $query, $moduleName)
Query module to get information about the currently logged-in user.
getConfig()
Get the Config object.
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:457
static factory($providerId=null)
Fetch a CentralIdLookup.
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
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:465
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:53
const META_BC_BOOLS
Key for the 'BC bools' metadata item.
Definition: ApiResult.php:134
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
Definition: ApiResult.php:730
Definition: Block.php:25
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:242
getUser()
Get the User object.
getByName()
Get the username of the blocking sysop.
Definition: Block.php:922
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300