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