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\MediaWikiServices
;
26 * Query module to get information about the currently logged-in user
30 class ApiQueryUserInfo
extends ApiQueryBase
{
32 const WL_UNREAD_LIMIT
= 1000;
37 public function __construct( ApiQuery
$query, $moduleName ) {
38 parent
::__construct( $query, $moduleName, 'ui' );
41 public function execute() {
42 $this->params
= $this->extractRequestParams();
43 $result = $this->getResult();
45 if ( !is_null( $this->params
['prop'] ) ) {
46 $this->prop
= array_flip( $this->params
['prop'] );
49 $r = $this->getCurrentUserInfo();
50 $result->addValue( 'query', $this->getModuleName(), $r );
54 * Get basic info about a given block
56 * @return array Array containing several keys:
57 * - blockid - ID of the block
58 * - blockedby - username of the blocker
59 * - blockedbyid - user ID of the blocker
60 * - blockreason - reason provided for the block
61 * - blockedtimestamp - timestamp for when the block was placed/modified
62 * - blockexpiry - expiry time of the block
63 * - systemblocktype - system block type, if any
65 public static function getBlockInfo( Block
$block ) {
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 $vals['blockpartial'] = !$block->isSitewide();
74 if ( $block->getSystemBlockType() !== null ) {
75 $vals['systemblocktype'] = $block->getSystemBlockType();
81 * Get central user info
82 * @param Config $config
84 * @param string|null $attachedWiki
85 * @return array Central user info
86 * - centralids: Array mapping non-local Central ID provider names to IDs
87 * - attachedlocal: Array mapping Central ID provider names to booleans
88 * indicating whether the local user is attached.
89 * - attachedwiki: Array mapping Central ID provider names to booleans
90 * indicating whether the user is attached to $attachedWiki.
92 public static function getCentralUserInfo( Config
$config, User
$user, $attachedWiki = null ) {
93 $providerIds = array_keys( $config->get( 'CentralIdLookupProviders' ) );
97 'attachedlocal' => [],
99 ApiResult
::setArrayType( $ret['centralids'], 'assoc' );
100 ApiResult
::setArrayType( $ret['attachedlocal'], 'assoc' );
101 if ( $attachedWiki ) {
102 $ret['attachedwiki'] = [];
103 ApiResult
::setArrayType( $ret['attachedwiki'], 'assoc' );
106 $name = $user->getName();
107 foreach ( $providerIds as $providerId ) {
108 $provider = CentralIdLookup
::factory( $providerId );
109 $ret['centralids'][$providerId] = $provider->centralIdFromName( $name );
110 $ret['attachedlocal'][$providerId] = $provider->isAttached( $user );
111 if ( $attachedWiki ) {
112 $ret['attachedwiki'][$providerId] = $provider->isAttached( $user, $attachedWiki );
119 protected function getCurrentUserInfo() {
120 $user = $this->getUser();
122 $vals['id'] = (int)$user->getId();
123 $vals['name'] = $user->getName();
125 if ( $user->isAnon() ) {
126 $vals['anon'] = true;
129 if ( isset( $this->prop
['blockinfo'] ) && $user->isBlocked() ) {
130 $vals = array_merge( $vals, self
::getBlockInfo( $user->getBlock() ) );
133 if ( isset( $this->prop
['hasmsg'] ) ) {
134 $vals['messages'] = $user->getNewtalk();
137 if ( isset( $this->prop
['groups'] ) ) {
138 $vals['groups'] = $user->getEffectiveGroups();
139 ApiResult
::setArrayType( $vals['groups'], 'array' ); // even if empty
140 ApiResult
::setIndexedTagName( $vals['groups'], 'g' ); // even if empty
143 if ( isset( $this->prop
['groupmemberships'] ) ) {
144 $ugms = $user->getGroupMemberships();
145 $vals['groupmemberships'] = [];
146 foreach ( $ugms as $group => $ugm ) {
147 $vals['groupmemberships'][] = [
149 'expiry' => ApiResult
::formatExpiry( $ugm->getExpiry() ),
152 ApiResult
::setArrayType( $vals['groupmemberships'], 'array' ); // even if empty
153 ApiResult
::setIndexedTagName( $vals['groupmemberships'], 'groupmembership' ); // even if empty
156 if ( isset( $this->prop
['implicitgroups'] ) ) {
157 $vals['implicitgroups'] = $user->getAutomaticGroups();
158 ApiResult
::setArrayType( $vals['implicitgroups'], 'array' ); // even if empty
159 ApiResult
::setIndexedTagName( $vals['implicitgroups'], 'g' ); // even if empty
162 if ( isset( $this->prop
['rights'] ) ) {
163 // User::getRights() may return duplicate values, strip them
164 $vals['rights'] = array_values( array_unique( $user->getRights() ) );
165 ApiResult
::setArrayType( $vals['rights'], 'array' ); // even if empty
166 ApiResult
::setIndexedTagName( $vals['rights'], 'r' ); // even if empty
169 if ( isset( $this->prop
['changeablegroups'] ) ) {
170 $vals['changeablegroups'] = $user->changeableGroups();
171 ApiResult
::setIndexedTagName( $vals['changeablegroups']['add'], 'g' );
172 ApiResult
::setIndexedTagName( $vals['changeablegroups']['remove'], 'g' );
173 ApiResult
::setIndexedTagName( $vals['changeablegroups']['add-self'], 'g' );
174 ApiResult
::setIndexedTagName( $vals['changeablegroups']['remove-self'], 'g' );
177 if ( isset( $this->prop
['options'] ) ) {
178 $vals['options'] = $user->getOptions();
179 $vals['options'][ApiResult
::META_BC_BOOLS
] = array_keys( $vals['options'] );
182 if ( isset( $this->prop
['preferencestoken'] ) &&
183 !$this->lacksSameOriginSecurity() &&
184 $user->isAllowed( 'editmyoptions' )
186 $vals['preferencestoken'] = $user->getEditToken( '', $this->getMain()->getRequest() );
189 if ( isset( $this->prop
['editcount'] ) ) {
190 // use intval to prevent null if a non-logged-in user calls
191 // api.php?format=jsonfm&action=query&meta=userinfo&uiprop=editcount
192 $vals['editcount'] = (int)$user->getEditCount();
195 if ( isset( $this->prop
['ratelimits'] ) ) {
196 $vals['ratelimits'] = $this->getRateLimits();
199 if ( isset( $this->prop
['realname'] ) &&
200 !in_array( 'realname', $this->getConfig()->get( 'HiddenPrefs' ) )
202 $vals['realname'] = $user->getRealName();
205 if ( $user->isAllowed( 'viewmyprivateinfo' ) ) {
206 if ( isset( $this->prop
['email'] ) ) {
207 $vals['email'] = $user->getEmail();
208 $auth = $user->getEmailAuthenticationTimestamp();
209 if ( !is_null( $auth ) ) {
210 $vals['emailauthenticated'] = wfTimestamp( TS_ISO_8601
, $auth );
215 if ( isset( $this->prop
['registrationdate'] ) ) {
216 $regDate = $user->getRegistration();
217 if ( $regDate !== false ) {
218 $vals['registrationdate'] = wfTimestamp( TS_ISO_8601
, $regDate );
222 if ( isset( $this->prop
['acceptlang'] ) ) {
223 $langs = $this->getRequest()->getAcceptLang();
225 foreach ( $langs as $lang => $val ) {
226 $r = [ 'q' => $val ];
227 ApiResult
::setContentValue( $r, 'code', $lang );
230 ApiResult
::setIndexedTagName( $acceptLang, 'lang' );
231 $vals['acceptlang'] = $acceptLang;
234 if ( isset( $this->prop
['unreadcount'] ) ) {
235 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
236 $unreadNotifications = $store->countUnreadNotifications(
238 self
::WL_UNREAD_LIMIT
241 if ( $unreadNotifications === true ) {
242 $vals['unreadcount'] = self
::WL_UNREAD_LIMIT
. '+';
244 $vals['unreadcount'] = $unreadNotifications;
248 if ( isset( $this->prop
['centralids'] ) ) {
249 $vals +
= self
::getCentralUserInfo(
250 $this->getConfig(), $this->getUser(), $this->params
['attachedwiki']
257 protected function getRateLimits() {
259 ApiResult
::META_TYPE
=> 'assoc',
262 $user = $this->getUser();
263 if ( !$user->isPingLimitable() ) {
264 return $retval; // No limits
267 // Find out which categories we belong to
269 if ( $user->isAnon() ) {
270 $categories[] = 'anon';
272 $categories[] = 'user';
274 if ( $user->isNewbie() ) {
275 $categories[] = 'ip';
276 $categories[] = 'subnet';
277 if ( !$user->isAnon() ) {
278 $categories[] = 'newbie';
281 $categories = array_merge( $categories, $user->getGroups() );
283 // Now get the actual limits
284 foreach ( $this->getConfig()->get( 'RateLimits' ) as $action => $limits ) {
285 foreach ( $categories as $cat ) {
286 if ( isset( $limits[$cat] ) && !is_null( $limits[$cat] ) ) {
287 $retval[$action][$cat]['hits'] = (int)$limits[$cat][0];
288 $retval[$action][$cat]['seconds'] = (int)$limits[$cat][1];
296 public function getAllowedParams() {
299 ApiBase
::PARAM_ISMULTI
=> true,
300 ApiBase
::PARAM_TYPE
=> [
319 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [
321 'apihelp-query+userinfo-paramvalue-prop-unreadcount',
322 self
::WL_UNREAD_LIMIT
- 1,
323 self
::WL_UNREAD_LIMIT
. '+',
326 ApiBase
::PARAM_DEPRECATED_VALUES
=> [
327 'preferencestoken' => [
328 'apiwarn-deprecation-withreplacement',
329 $this->getModulePrefix() . "prop=preferencestoken",
330 'action=query&meta=tokens',
334 'attachedwiki' => null,
338 protected function getExamplesMessages() {
340 'action=query&meta=userinfo'
341 => 'apihelp-query+userinfo-example-simple',
342 'action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg'
343 => 'apihelp-query+userinfo-example-data',
347 public function getHelpUrls() {
348 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Userinfo';