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                         $p = $this->getModulePrefix();
 187                         $this->addDeprecation(
 188                                 [
 189                                         'apiwarn-deprecation-withreplacement',
 190                                         "{$p}prop=preferencestoken",
 191                                         'action=query&meta=tokens',
 192                                 ],
 193                                 "meta=userinfo&{$p}prop=preferencestoken"
 194                         );
 195                 }
 196                 if ( isset( $this->prop['preferencestoken'] ) &&
 197                         !$this->lacksSameOriginSecurity() &&
 198                         $user->isAllowed( 'editmyoptions' )
 199                 ) {
 200                         $vals['preferencestoken'] = $user->getEditToken( '', $this->getMain()->getRequest() );
 201                 }
 202
 203                 if ( isset( $this->prop['editcount'] ) ) {
 204                         // use intval to prevent null if a non-logged-in user calls
 205                         // api.php?format=jsonfm&action=query&meta=userinfo&uiprop=editcount
 206                         $vals['editcount'] = intval( $user->getEditCount() );
 207                 }
 208
 209                 if ( isset( $this->prop['ratelimits'] ) ) {
 210                         $vals['ratelimits'] = $this->getRateLimits();
 211                 }
 212
 213                 if ( isset( $this->prop['realname'] ) &&
 214                         !in_array( 'realname', $this->getConfig()->get( 'HiddenPrefs' ) )
 215                 ) {
 216                         $vals['realname'] = $user->getRealName();
 217                 }
 218
 219                 if ( $user->isAllowed( 'viewmyprivateinfo' ) ) {
 220                         if ( isset( $this->prop['email'] ) ) {
 221                                 $vals['email'] = $user->getEmail();
 222                                 $auth = $user->getEmailAuthenticationTimestamp();
 223                                 if ( !is_null( $auth ) ) {
 224                                         $vals['emailauthenticated'] = wfTimestamp( TS_ISO_8601, $auth );
 225                                 }
 226                         }
 227                 }
 228
 229                 if ( isset( $this->prop['registrationdate'] ) ) {
 230                         $regDate = $user->getRegistration();
 231                         if ( $regDate !== false ) {
 232                                 $vals['registrationdate'] = wfTimestamp( TS_ISO_8601, $regDate );
 233                         }
 234                 }
 235
 236                 if ( isset( $this->prop['acceptlang'] ) ) {
 237                         $langs = $this->getRequest()->getAcceptLang();
 238                         $acceptLang = [];
 239                         foreach ( $langs as $lang => $val ) {
 240                                 $r = [ 'q' => $val ];
 241                                 ApiResult::setContentValue( $r, 'code', $lang );
 242                                 $acceptLang[] = $r;
 243                         }
 244                         ApiResult::setIndexedTagName( $acceptLang, 'lang' );
 245                         $vals['acceptlang'] = $acceptLang;
 246                 }
 247
 248                 if ( isset( $this->prop['unreadcount'] ) ) {
 249                         $store = MediaWikiServices::getInstance()->getWatchedItemStore();
 250                         $unreadNotifications = $store->countUnreadNotifications(
 251                                 $user,
 252                                 self::WL_UNREAD_LIMIT
 253                         );
 254
 255                         if ( $unreadNotifications === true ) {
 256                                 $vals['unreadcount'] = self::WL_UNREAD_LIMIT . '+';
 257                         } else {
 258                                 $vals['unreadcount'] = $unreadNotifications;
 259                         }
 260                 }
 261
 262                 if ( isset( $this->prop['centralids'] ) ) {
 263                         $vals += self::getCentralUserInfo(
 264                                 $this->getConfig(), $this->getUser(), $this->params['attachedwiki']
 265                         );
 266                 }
 267
 268                 return $vals;
 269         }
 270
 271         protected function getRateLimits() {
 272                 $retval = [
 273                         ApiResult::META_TYPE => 'assoc',
 274                 ];
 275
 276                 $user = $this->getUser();
 277                 if ( !$user->isPingLimitable() ) {
 278                         return $retval; // No limits
 279                 }
 280
 281                 // Find out which categories we belong to
 282                 $categories = [];
 283                 if ( $user->isAnon() ) {
 284                         $categories[] = 'anon';
 285                 } else {
 286                         $categories[] = 'user';
 287                 }
 288                 if ( $user->isNewbie() ) {
 289                         $categories[] = 'ip';
 290                         $categories[] = 'subnet';
 291                         if ( !$user->isAnon() ) {
 292                                 $categories[] = 'newbie';
 293                         }
 294                 }
 295                 $categories = array_merge( $categories, $user->getGroups() );
 296
 297                 // Now get the actual limits
 298                 foreach ( $this->getConfig()->get( 'RateLimits' ) as $action => $limits ) {
 299                         foreach ( $categories as $cat ) {
 300                                 if ( isset( $limits[$cat] ) && !is_null( $limits[$cat] ) ) {
 301                                         $retval[$action][$cat]['hits'] = intval( $limits[$cat][0] );
 302                                         $retval[$action][$cat]['seconds'] = intval( $limits[$cat][1] );
 303                                 }
 304                         }
 305                 }
 306
 307                 return $retval;
 308         }
 309
 310         public function getAllowedParams() {
 311                 return [
 312                         'prop' => [
 313                                 ApiBase::PARAM_ISMULTI => true,
 314                                 ApiBase::PARAM_TYPE => [
 315                                         'blockinfo',
 316                                         'hasmsg',
 317                                         'groups',
 318                                         'groupmemberships',
 319                                         'implicitgroups',
 320                                         'rights',
 321                                         'changeablegroups',
 322                                         'options',
 323                                         'preferencestoken',
 324                                         'editcount',
 325                                         'ratelimits',
 326                                         'email',
 327                                         'realname',
 328                                         'acceptlang',
 329                                         'registrationdate',
 330                                         'unreadcount',
 331                                         'centralids',
 332                                 ],
 333                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [
 334                                         'unreadcount' => [
 335                                                 'apihelp-query+userinfo-paramvalue-prop-unreadcount',
 336                                                 self::WL_UNREAD_LIMIT - 1,
 337                                                 self::WL_UNREAD_LIMIT . '+',
 338                                         ],
 339                                 ],
 340                         ],
 341                         'attachedwiki' => null,
 342                 ];
 343         }
 344
 345         protected function getExamplesMessages() {
 346                 return [
 347                         'action=query&meta=userinfo'
 348                                 => 'apihelp-query+userinfo-example-simple',
 349                         'action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg'
 350                                 => 'apihelp-query+userinfo-example-data',
 351                 ];
 352         }
 353
 354         public function getHelpUrls() {
 355                 return 'https://www.mediawiki.org/wiki/API:Userinfo';
 356         }
 357 }