3 * Copyright © 2007 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\Block\AbstractBlock
;
24 use MediaWiki\MediaWikiServices
;
27 * Query module to get information about the currently logged-in user
31 class ApiQueryUserInfo
extends ApiQueryBase
{
33 use ApiBlockInfoTrait
;
35 const WL_UNREAD_LIMIT
= 1000;
40 public function __construct( ApiQuery
$query, $moduleName ) {
41 parent
::__construct( $query, $moduleName, 'ui' );
44 public function execute() {
45 $this->params
= $this->extractRequestParams();
46 $result = $this->getResult();
48 if ( !is_null( $this->params
['prop'] ) ) {
49 $this->prop
= array_flip( $this->params
['prop'] );
52 $r = $this->getCurrentUserInfo();
53 $result->addValue( 'query', $this->getModuleName(), $r );
57 * Get basic info about a given block
59 * @deprecated since 1.34 Use ApiBlockInfoTrait::getBlockDetails() instead.
60 * @param AbstractBlock $block
61 * @return array See ApiBlockInfoTrait::getBlockDetails
63 public static function getBlockInfo( AbstractBlock
$block ) {
64 wfDeprecated( __METHOD__
, '1.34' );
66 // Hack to access a private method from a trait:
68 use ApiBlockInfoTrait
{
69 getBlockDetails
as public;
73 return $dummy->getBlockDetails( $block );
77 * Get central user info
78 * @param Config $config
80 * @param string|null $attachedWiki
81 * @return array Central user info
82 * - centralids: Array mapping non-local Central ID provider names to IDs
83 * - attachedlocal: Array mapping Central ID provider names to booleans
84 * indicating whether the local user is attached.
85 * - attachedwiki: Array mapping Central ID provider names to booleans
86 * indicating whether the user is attached to $attachedWiki.
88 public static function getCentralUserInfo( Config
$config, User
$user, $attachedWiki = null ) {
89 $providerIds = array_keys( $config->get( 'CentralIdLookupProviders' ) );
93 'attachedlocal' => [],
95 ApiResult
::setArrayType( $ret['centralids'], 'assoc' );
96 ApiResult
::setArrayType( $ret['attachedlocal'], 'assoc' );
97 if ( $attachedWiki ) {
98 $ret['attachedwiki'] = [];
99 ApiResult
::setArrayType( $ret['attachedwiki'], 'assoc' );
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 );
115 protected function getCurrentUserInfo() {
116 $user = $this->getUser();
118 $vals['id'] = (int)$user->getId();
119 $vals['name'] = $user->getName();
121 if ( $user->isAnon() ) {
122 $vals['anon'] = true;
125 if ( isset( $this->prop
['blockinfo'] ) ) {
126 $block = $user->getBlock();
128 $vals = array_merge( $vals, $this->getBlockDetails( $block ) );
132 if ( isset( $this->prop
['hasmsg'] ) ) {
133 $vals['messages'] = $user->getNewtalk();
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
142 if ( isset( $this->prop
['groupmemberships'] ) ) {
143 $ugms = $user->getGroupMemberships();
144 $vals['groupmemberships'] = [];
145 foreach ( $ugms as $group => $ugm ) {
146 $vals['groupmemberships'][] = [
148 'expiry' => ApiResult
::formatExpiry( $ugm->getExpiry() ),
151 ApiResult
::setArrayType( $vals['groupmemberships'], 'array' ); // even if empty
152 ApiResult
::setIndexedTagName( $vals['groupmemberships'], 'groupmembership' ); // even if empty
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
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
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' );
176 if ( isset( $this->prop
['options'] ) ) {
177 $vals['options'] = $user->getOptions();
178 $vals['options'][ApiResult
::META_BC_BOOLS
] = array_keys( $vals['options'] );
181 if ( isset( $this->prop
['preferencestoken'] ) &&
182 !$this->lacksSameOriginSecurity() &&
183 $user->isAllowed( 'editmyoptions' )
185 $vals['preferencestoken'] = $user->getEditToken( '', $this->getMain()->getRequest() );
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();
194 if ( isset( $this->prop
['ratelimits'] ) ) {
195 $vals['ratelimits'] = $this->getRateLimits();
198 if ( isset( $this->prop
['realname'] ) &&
199 !in_array( 'realname', $this->getConfig()->get( 'HiddenPrefs' ) )
201 $vals['realname'] = $user->getRealName();
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 );
212 if ( isset( $this->prop
['registrationdate'] ) ) {
213 $regDate = $user->getRegistration();
214 if ( $regDate !== false ) {
215 $vals['registrationdate'] = wfTimestamp( TS_ISO_8601
, $regDate );
219 if ( isset( $this->prop
['acceptlang'] ) ) {
220 $langs = $this->getRequest()->getAcceptLang();
222 foreach ( $langs as $lang => $val ) {
223 $r = [ 'q' => $val ];
224 ApiResult
::setContentValue( $r, 'code', $lang );
227 ApiResult
::setIndexedTagName( $acceptLang, 'lang' );
228 $vals['acceptlang'] = $acceptLang;
231 if ( isset( $this->prop
['unreadcount'] ) ) {
232 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
233 $unreadNotifications = $store->countUnreadNotifications(
235 self
::WL_UNREAD_LIMIT
238 if ( $unreadNotifications === true ) {
239 $vals['unreadcount'] = self
::WL_UNREAD_LIMIT
. '+';
241 $vals['unreadcount'] = $unreadNotifications;
245 if ( isset( $this->prop
['centralids'] ) ) {
246 $vals +
= self
::getCentralUserInfo(
247 $this->getConfig(), $this->getUser(), $this->params
['attachedwiki']
251 if ( isset( $this->prop
['latestcontrib'] ) ) {
252 $ts = $this->getLatestContributionTime();
253 if ( $ts !== null ) {
254 $vals['latestcontrib'] = $ts;
261 protected function getRateLimits() {
263 ApiResult
::META_TYPE
=> 'assoc',
266 $user = $this->getUser();
267 if ( !$user->isPingLimitable() ) {
268 return $retval; // No limits
271 // Find out which categories we belong to
273 if ( $user->isAnon() ) {
274 $categories[] = 'anon';
276 $categories[] = 'user';
278 if ( $user->isNewbie() ) {
279 $categories[] = 'ip';
280 $categories[] = 'subnet';
281 if ( !$user->isAnon() ) {
282 $categories[] = 'newbie';
285 $categories = array_merge( $categories, $user->getGroups() );
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];
301 * @return string|null ISO 8601 timestamp of current user's last contribution or null if none
303 protected function getLatestContributionTime() {
304 global $wgActorTableSchemaMigrationStage;
306 $user = $this->getUser();
307 $dbr = $this->getDB();
309 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) {
310 if ( $user->getActorId() === null ) {
313 $res = $dbr->selectField( 'revision_actor_temp',
314 'MAX(revactor_timestamp)',
315 [ 'revactor_actor' => $user->getActorId() ],
319 if ( $user->isLoggedIn() ) {
320 $conds = [ 'rev_user' => $user->getId() ];
322 $conds = [ 'rev_user_text' => $user->getName() ];
324 $res = $dbr->selectField( 'revision',
325 'MAX(rev_timestamp)',
331 return $res ?
wfTimestamp( TS_ISO_8601
, $res ) : null;
334 public function getAllowedParams() {
337 ApiBase
::PARAM_ISMULTI
=> true,
338 ApiBase
::PARAM_TYPE
=> [
358 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [
360 'apihelp-query+userinfo-paramvalue-prop-unreadcount',
361 self
::WL_UNREAD_LIMIT
- 1,
362 self
::WL_UNREAD_LIMIT
. '+',
365 ApiBase
::PARAM_DEPRECATED_VALUES
=> [
366 'preferencestoken' => [
367 'apiwarn-deprecation-withreplacement',
368 $this->getModulePrefix() . "prop=preferencestoken",
369 'action=query&meta=tokens',
373 'attachedwiki' => null,
377 protected function getExamplesMessages() {
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',
386 public function getHelpUrls() {
387 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Userinfo';