includes/api/ApiQueryUserInfo.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on July 30, 2007
   6  *
   7  * Copyright © 2007 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   8  *
   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.
  13  *
  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.
  18  *
  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
  23  *
  24  * @file
  25  */
  26
  27 use MediaWiki\MediaWikiServices;
  28
  29 /**
  30  * Query module to get information about the currently logged-in user
  31  *
  32  * @ingroup API
  33  */
  34 class ApiQueryUserInfo extends ApiQueryBase {
  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
  57         /**
  58          * Get basic info about a given block
  59          * @param Block $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
  68          */
  69         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'] = ApiResult::formatExpiry( $block->getExpiry(), 'infinite' );
  77                 if ( $block->getSystemBlockType() !== null ) {
  78                         $vals['systemblocktype'] = $block->getSystemBlockType();
  79                 }
  80                 return $vals;
  81         }
  82
  83         /**
  84          * Get central user info
  85          * @param Config $config
  86          * @param User $user
  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.
  94          */
  95         public static function getCentralUserInfo( Config $config, User $user, $attachedWiki = null ) {
  96                 $providerIds = array_keys( $config->get( 'CentralIdLookupProviders' ) );
  97
  98                 $ret = [
  99                         'centralids' => [],
 100                         'attachedlocal' => [],
 101                 ];
 102                 ApiResult::setArrayType( $ret['centralids'], 'assoc' );
 103                 ApiResult::setArrayType( $ret['attachedlocal'], 'assoc' );
 104                 if ( $attachedWiki ) {
 105                         $ret['attachedwiki'] = [];
 106                         ApiResult::setArrayType( $ret['attachedwiki'], 'assoc' );
 107                 }
 108
 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 );
 116                         }
 117                 }
 118
 119                 return $ret;
 120         }
 121
 122         protected function getCurrentUserInfo() {
 123                 $user = $this->getUser();
 124                 $vals = [];
 125                 $vals['id'] = intval( $user->getId() );
 126                 $vals['name'] = $user->getName();
 127
 128                 if ( $user->isAnon() ) {
 129                         $vals['anon'] = true;
 130                 }
 131
 132                 if ( isset( $this->prop['blockinfo'] ) && $user->isBlocked() ) {
 133                         $vals = array_merge( $vals, self::getBlockInfo( $user->getBlock() ) );
 134                 }
 135
 136                 if ( isset( $this->prop['hasmsg'] ) ) {
 137                         $vals['messages'] = $user->getNewtalk();
 138                 }
 139
 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
 144                 }
 145
 146                 if ( isset( $this->prop['groupmemberships'] ) ) {
 147                         $ugms = $user->getGroupMemberships();
 148                         $vals['groupmemberships'] = [];
 149                         foreach ( $ugms as $group => $ugm ) {
 150                                 $vals['groupmemberships'][] = [
 151                                         'group' => $group,
 152                                         'expiry' => ApiResult::formatExpiry( $ugm->getExpiry() ),
 153                                 ];
 154                         }
 155                         ApiResult::setArrayType( $vals['groupmemberships'], 'array' ); // even if empty
 156                         ApiResult::setIndexedTagName( $vals['groupmemberships'], 'groupmembership' ); // even if empty
 157                 }
 158
 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
 163                 }
 164
 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
 170                 }
 171
 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' );
 178                 }
 179
 180                 if ( isset( $this->prop['options'] ) ) {
 181                         $vals['options'] = $user->getOptions();
 182                         $vals['options'][ApiResult::META_BC_BOOLS] = array_keys( $vals['options'] );
 183                 }
 184
 185                 if ( isset( $this->prop['preferencestoken'] ) &&
 186                         !$this->lacksSameOriginSecurity() &&
 187                         $user->isAllowed( 'editmyoptions' )
 188                 ) {
 189                         $vals['preferencestoken'] = $user->getEditToken( '', $this->getMain()->getRequest() );
 190                 }
 191
 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() );
 196                 }
 197
 198                 if ( isset( $this->prop['ratelimits'] ) ) {
 199                         $vals['ratelimits'] = $this->getRateLimits();
 200                 }
 201
 202                 if ( isset( $this->prop['realname'] ) &&
 203                         !in_array( 'realname', $this->getConfig()->get( 'HiddenPrefs' ) )
 204                 ) {
 205                         $vals['realname'] = $user->getRealName();
 206                 }
 207
 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 );
 214                                 }
 215                         }
 216                 }
 217
 218                 if ( isset( $this->prop['registrationdate'] ) ) {
 219                         $regDate = $user->getRegistration();
 220                         if ( $regDate !== false ) {
 221                                 $vals['registrationdate'] = wfTimestamp( TS_ISO_8601, $regDate );
 222                         }
 223                 }
 224
 225                 if ( isset( $this->prop['acceptlang'] ) ) {
 226                         $langs = $this->getRequest()->getAcceptLang();
 227                         $acceptLang = [];
 228                         foreach ( $langs as $lang => $val ) {
 229                                 $r = [ 'q' => $val ];
 230                                 ApiResult::setContentValue( $r, 'code', $lang );
 231                                 $acceptLang[] = $r;
 232                         }
 233                         ApiResult::setIndexedTagName( $acceptLang, 'lang' );
 234                         $vals['acceptlang'] = $acceptLang;
 235                 }
 236
 237                 if ( isset( $this->prop['unreadcount'] ) ) {
 238                         $store = MediaWikiServices::getInstance()->getWatchedItemStore();
 239                         $unreadNotifications = $store->countUnreadNotifications(
 240                                 $user,
 241                                 self::WL_UNREAD_LIMIT
 242                         );
 243
 244                         if ( $unreadNotifications === true ) {
 245                                 $vals['unreadcount'] = self::WL_UNREAD_LIMIT . '+';
 246                         } else {
 247                                 $vals['unreadcount'] = $unreadNotifications;
 248                         }
 249                 }
 250
 251                 if ( isset( $this->prop['centralids'] ) ) {
 252                         $vals += self::getCentralUserInfo(
 253                                 $this->getConfig(), $this->getUser(), $this->params['attachedwiki']
 254                         );
 255                 }
 256
 257                 return $vals;
 258         }
 259
 260         protected function getRateLimits() {
 261                 $retval = [
 262                         ApiResult::META_TYPE => 'assoc',
 263                 ];
 264
 265                 $user = $this->getUser();
 266                 if ( !$user->isPingLimitable() ) {
 267                         return $retval; // No limits
 268                 }
 269
 270                 // Find out which categories we belong to
 271                 $categories = [];
 272                 if ( $user->isAnon() ) {
 273                         $categories[] = 'anon';
 274                 } else {
 275                         $categories[] = 'user';
 276                 }
 277                 if ( $user->isNewbie() ) {
 278                         $categories[] = 'ip';
 279                         $categories[] = 'subnet';
 280                         if ( !$user->isAnon() ) {
 281                                 $categories[] = 'newbie';
 282                         }
 283                 }
 284                 $categories = array_merge( $categories, $user->getGroups() );
 285
 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] );
 292                                 }
 293                         }
 294                 }
 295
 296                 return $retval;
 297         }
 298
 299         public function getAllowedParams() {
 300                 return [
 301                         'prop' => [
 302                                 ApiBase::PARAM_ISMULTI => true,
 303                                 ApiBase::PARAM_TYPE => [
 304                                         'blockinfo',
 305                                         'hasmsg',
 306                                         'groups',
 307                                         'groupmemberships',
 308                                         'implicitgroups',
 309                                         'rights',
 310                                         'changeablegroups',
 311                                         'options',
 312                                         'editcount',
 313                                         'ratelimits',
 314                                         'email',
 315                                         'realname',
 316                                         'acceptlang',
 317                                         'registrationdate',
 318                                         'unreadcount',
 319                                         'centralids',
 320                                         'preferencestoken',
 321                                 ],
 322                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [
 323                                         'unreadcount' => [
 324                                                 'apihelp-query+userinfo-paramvalue-prop-unreadcount',
 325                                                 self::WL_UNREAD_LIMIT - 1,
 326                                                 self::WL_UNREAD_LIMIT . '+',
 327                                         ],
 328                                 ],
 329                                 ApiBase::PARAM_DEPRECATED_VALUES => [
 330                                         'preferencestoken' => [
 331                                                 'apiwarn-deprecation-withreplacement',
 332                                                 $this->getModulePrefix() . "prop=preferencestoken",
 333                                                 'action=query&meta=tokens',
 334                                         ]
 335                                 ],
 336                         ],
 337                         'attachedwiki' => null,
 338                 ];
 339         }
 340
 341         protected function getExamplesMessages() {
 342                 return [
 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',
 347                 ];
 348         }
 349
 350         public function getHelpUrls() {
 351                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Userinfo';
 352         }
 353 }