5 * Created on July 30, 2007
7 * Copyright © 2007 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
27 use MediaWiki\MediaWikiServices
;
30 * Query module to get information about the currently logged-in user
34 class ApiQueryUserInfo
extends ApiQueryBase
{
36 const WL_UNREAD_LIMIT
= 1000;
41 public function __construct( ApiQuery
$query, $moduleName ) {
42 parent
::__construct( $query, $moduleName, 'ui' );
45 public function execute() {
46 $this->params
= $this->extractRequestParams();
47 $result = $this->getResult();
49 if ( !is_null( $this->params
['prop'] ) ) {
50 $this->prop
= array_flip( $this->params
['prop'] );
53 $r = $this->getCurrentUserInfo();
54 $result->addValue( 'query', $this->getModuleName(), $r );
58 * Get basic info about a given block
60 * @return array Array containing several keys:
61 * - blockid - ID of the block
62 * - blockedby - username of the blocker
63 * - blockedbyid - user ID of the blocker
64 * - blockreason - reason provided for the block
65 * - blockedtimestamp - timestamp for when the block was placed/modified
66 * - blockexpiry - expiry time of the block
67 * - systemblocktype - system block type, if any
69 public static function getBlockInfo( Block
$block ) {
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'] = ApiResult
::formatExpiry( $block->getExpiry(), 'infinite' );
77 if ( $block->getSystemBlockType() !== null ) {
78 $vals['systemblocktype'] = $block->getSystemBlockType();
84 * Get central user info
85 * @param Config $config
87 * @param string|null $attachedWiki
88 * @return array Central user info
89 * - centralids: Array mapping non-local Central ID provider names to IDs
90 * - attachedlocal: Array mapping Central ID provider names to booleans
91 * indicating whether the local user is attached.
92 * - attachedwiki: Array mapping Central ID provider names to booleans
93 * indicating whether the user is attached to $attachedWiki.
95 public static function getCentralUserInfo( Config
$config, User
$user, $attachedWiki = null ) {
96 $providerIds = array_keys( $config->get( 'CentralIdLookupProviders' ) );
100 'attachedlocal' => [],
102 ApiResult
::setArrayType( $ret['centralids'], 'assoc' );
103 ApiResult
::setArrayType( $ret['attachedlocal'], 'assoc' );
104 if ( $attachedWiki ) {
105 $ret['attachedwiki'] = [];
106 ApiResult
::setArrayType( $ret['attachedwiki'], 'assoc' );
109 $name = $user->getName();
110 foreach ( $providerIds as $providerId ) {
111 $provider = CentralIdLookup
::factory( $providerId );
112 $ret['centralids'][$providerId] = $provider->centralIdFromName( $name );
113 $ret['attachedlocal'][$providerId] = $provider->isAttached( $user );
114 if ( $attachedWiki ) {
115 $ret['attachedwiki'][$providerId] = $provider->isAttached( $user, $attachedWiki );
122 protected function getCurrentUserInfo() {
123 $user = $this->getUser();
125 $vals['id'] = intval( $user->getId() );
126 $vals['name'] = $user->getName();
128 if ( $user->isAnon() ) {
129 $vals['anon'] = true;
132 if ( isset( $this->prop
['blockinfo'] ) && $user->isBlocked() ) {
133 $vals = array_merge( $vals, self
::getBlockInfo( $user->getBlock() ) );
136 if ( isset( $this->prop
['hasmsg'] ) ) {
137 $vals['messages'] = $user->getNewtalk();
140 if ( isset( $this->prop
['groups'] ) ) {
141 $vals['groups'] = $user->getEffectiveGroups();
142 ApiResult
::setArrayType( $vals['groups'], 'array' ); // even if empty
143 ApiResult
::setIndexedTagName( $vals['groups'], 'g' ); // even if empty
146 if ( isset( $this->prop
['groupmemberships'] ) ) {
147 $ugms = $user->getGroupMemberships();
148 $vals['groupmemberships'] = [];
149 foreach ( $ugms as $group => $ugm ) {
150 $vals['groupmemberships'][] = [
152 'expiry' => ApiResult
::formatExpiry( $ugm->getExpiry() ),
155 ApiResult
::setArrayType( $vals['groupmemberships'], 'array' ); // even if empty
156 ApiResult
::setIndexedTagName( $vals['groupmemberships'], 'groupmembership' ); // even if empty
159 if ( isset( $this->prop
['implicitgroups'] ) ) {
160 $vals['implicitgroups'] = $user->getAutomaticGroups();
161 ApiResult
::setArrayType( $vals['implicitgroups'], 'array' ); // even if empty
162 ApiResult
::setIndexedTagName( $vals['implicitgroups'], 'g' ); // even if empty
165 if ( isset( $this->prop
['rights'] ) ) {
166 // User::getRights() may return duplicate values, strip them
167 $vals['rights'] = array_values( array_unique( $user->getRights() ) );
168 ApiResult
::setArrayType( $vals['rights'], 'array' ); // even if empty
169 ApiResult
::setIndexedTagName( $vals['rights'], 'r' ); // even if empty
172 if ( isset( $this->prop
['changeablegroups'] ) ) {
173 $vals['changeablegroups'] = $user->changeableGroups();
174 ApiResult
::setIndexedTagName( $vals['changeablegroups']['add'], 'g' );
175 ApiResult
::setIndexedTagName( $vals['changeablegroups']['remove'], 'g' );
176 ApiResult
::setIndexedTagName( $vals['changeablegroups']['add-self'], 'g' );
177 ApiResult
::setIndexedTagName( $vals['changeablegroups']['remove-self'], 'g' );
180 if ( isset( $this->prop
['options'] ) ) {
181 $vals['options'] = $user->getOptions();
182 $vals['options'][ApiResult
::META_BC_BOOLS
] = array_keys( $vals['options'] );
185 if ( isset( $this->prop
['preferencestoken'] ) &&
186 !$this->lacksSameOriginSecurity() &&
187 $user->isAllowed( 'editmyoptions' )
189 $vals['preferencestoken'] = $user->getEditToken( '', $this->getMain()->getRequest() );
192 if ( isset( $this->prop
['editcount'] ) ) {
193 // use intval to prevent null if a non-logged-in user calls
194 // api.php?format=jsonfm&action=query&meta=userinfo&uiprop=editcount
195 $vals['editcount'] = intval( $user->getEditCount() );
198 if ( isset( $this->prop
['ratelimits'] ) ) {
199 $vals['ratelimits'] = $this->getRateLimits();
202 if ( isset( $this->prop
['realname'] ) &&
203 !in_array( 'realname', $this->getConfig()->get( 'HiddenPrefs' ) )
205 $vals['realname'] = $user->getRealName();
208 if ( $user->isAllowed( 'viewmyprivateinfo' ) ) {
209 if ( isset( $this->prop
['email'] ) ) {
210 $vals['email'] = $user->getEmail();
211 $auth = $user->getEmailAuthenticationTimestamp();
212 if ( !is_null( $auth ) ) {
213 $vals['emailauthenticated'] = wfTimestamp( TS_ISO_8601
, $auth );
218 if ( isset( $this->prop
['registrationdate'] ) ) {
219 $regDate = $user->getRegistration();
220 if ( $regDate !== false ) {
221 $vals['registrationdate'] = wfTimestamp( TS_ISO_8601
, $regDate );
225 if ( isset( $this->prop
['acceptlang'] ) ) {
226 $langs = $this->getRequest()->getAcceptLang();
228 foreach ( $langs as $lang => $val ) {
229 $r = [ 'q' => $val ];
230 ApiResult
::setContentValue( $r, 'code', $lang );
233 ApiResult
::setIndexedTagName( $acceptLang, 'lang' );
234 $vals['acceptlang'] = $acceptLang;
237 if ( isset( $this->prop
['unreadcount'] ) ) {
238 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
239 $unreadNotifications = $store->countUnreadNotifications(
241 self
::WL_UNREAD_LIMIT
244 if ( $unreadNotifications === true ) {
245 $vals['unreadcount'] = self
::WL_UNREAD_LIMIT
. '+';
247 $vals['unreadcount'] = $unreadNotifications;
251 if ( isset( $this->prop
['centralids'] ) ) {
252 $vals +
= self
::getCentralUserInfo(
253 $this->getConfig(), $this->getUser(), $this->params
['attachedwiki']
260 protected function getRateLimits() {
262 ApiResult
::META_TYPE
=> 'assoc',
265 $user = $this->getUser();
266 if ( !$user->isPingLimitable() ) {
267 return $retval; // No limits
270 // Find out which categories we belong to
272 if ( $user->isAnon() ) {
273 $categories[] = 'anon';
275 $categories[] = 'user';
277 if ( $user->isNewbie() ) {
278 $categories[] = 'ip';
279 $categories[] = 'subnet';
280 if ( !$user->isAnon() ) {
281 $categories[] = 'newbie';
284 $categories = array_merge( $categories, $user->getGroups() );
286 // Now get the actual limits
287 foreach ( $this->getConfig()->get( 'RateLimits' ) as $action => $limits ) {
288 foreach ( $categories as $cat ) {
289 if ( isset( $limits[$cat] ) && !is_null( $limits[$cat] ) ) {
290 $retval[$action][$cat]['hits'] = intval( $limits[$cat][0] );
291 $retval[$action][$cat]['seconds'] = intval( $limits[$cat][1] );
299 public function getAllowedParams() {
302 ApiBase
::PARAM_ISMULTI
=> true,
303 ApiBase
::PARAM_TYPE
=> [
322 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [
324 'apihelp-query+userinfo-paramvalue-prop-unreadcount',
325 self
::WL_UNREAD_LIMIT
- 1,
326 self
::WL_UNREAD_LIMIT
. '+',
329 ApiBase
::PARAM_DEPRECATED_VALUES
=> [
330 'preferencestoken' => [
331 'apiwarn-deprecation-withreplacement',
332 $this->getModulePrefix() . "prop=preferencestoken",
333 'action=query&meta=tokens',
337 'attachedwiki' => null,
341 protected function getExamplesMessages() {
343 'action=query&meta=userinfo'
344 => 'apihelp-query+userinfo-example-simple',
345 'action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg'
346 => 'apihelp-query+userinfo-example-data',
350 public function getHelpUrls() {
351 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Userinfo';