includes/api/ApiQueryBlocks.php

   1 <?php
   2 /**
   3  * Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  */
  22
  23 use Wikimedia\Rdbms\IResultWrapper;
  24 use MediaWiki\Block\BlockRestriction;
  25
  26 /**
  27  * Query module to enumerate all user blocks
  28  *
  29  * @ingroup API
  30  */
  31 class ApiQueryBlocks extends ApiQueryBase {
  32
  33         public function __construct( ApiQuery $query, $moduleName ) {
  34                 parent::__construct( $query, $moduleName, 'bk' );
  35         }
  36
  37         public function execute() {
  38                 $db = $this->getDB();
  39                 $commentStore = CommentStore::getStore();
  40                 $params = $this->extractRequestParams();
  41                 $this->requireMaxOneParameter( $params, 'users', 'ip' );
  42
  43                 $prop = array_flip( $params['prop'] );
  44                 $fld_id = isset( $prop['id'] );
  45                 $fld_user = isset( $prop['user'] );
  46                 $fld_userid = isset( $prop['userid'] );
  47                 $fld_by = isset( $prop['by'] );
  48                 $fld_byid = isset( $prop['byid'] );
  49                 $fld_timestamp = isset( $prop['timestamp'] );
  50                 $fld_expiry = isset( $prop['expiry'] );
  51                 $fld_reason = isset( $prop['reason'] );
  52                 $fld_range = isset( $prop['range'] );
  53                 $fld_flags = isset( $prop['flags'] );
  54                 $fld_restrictions = isset( $prop['restrictions'] );
  55
  56                 $result = $this->getResult();
  57
  58                 $this->addTables( 'ipblocks' );
  59                 $this->addFields( [ 'ipb_auto', 'ipb_id', 'ipb_timestamp' ] );
  60
  61                 $this->addFieldsIf( [ 'ipb_address', 'ipb_user' ], $fld_user || $fld_userid );
  62                 if ( $fld_by || $fld_byid ) {
  63                         $actorQuery = ActorMigration::newMigration()->getJoin( 'ipb_by' );
  64                         $this->addTables( $actorQuery['tables'] );
  65                         $this->addFields( $actorQuery['fields'] );
  66                         $this->addJoinConds( $actorQuery['joins'] );
  67                 }
  68                 $this->addFieldsIf( 'ipb_expiry', $fld_expiry );
  69                 $this->addFieldsIf( [ 'ipb_range_start', 'ipb_range_end' ], $fld_range );
  70                 $this->addFieldsIf( [ 'ipb_anon_only', 'ipb_create_account', 'ipb_enable_autoblock',
  71                         'ipb_block_email', 'ipb_deleted', 'ipb_allow_usertalk', 'ipb_sitewide' ],
  72                         $fld_flags );
  73                 $this->addFieldsIf( 'ipb_sitewide', $fld_restrictions );
  74
  75                 if ( $fld_reason ) {
  76                         $commentQuery = $commentStore->getJoin( 'ipb_reason' );
  77                         $this->addTables( $commentQuery['tables'] );
  78                         $this->addFields( $commentQuery['fields'] );
  79                         $this->addJoinConds( $commentQuery['joins'] );
  80                 }
  81
  82                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
  83                 $this->addTimestampWhereRange(
  84                         'ipb_timestamp',
  85                         $params['dir'],
  86                         $params['start'],
  87                         $params['end']
  88                 );
  89                 // Include in ORDER BY for uniqueness
  90                 $this->addWhereRange( 'ipb_id', $params['dir'], null, null );
  91
  92                 if ( !is_null( $params['continue'] ) ) {
  93                         $cont = explode( '|', $params['continue'] );
  94                         $this->dieContinueUsageIf( count( $cont ) != 2 );
  95                         $op = ( $params['dir'] == 'newer' ? '>' : '<' );
  96                         $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
  97                         $continueId = (int)$cont[1];
  98                         $this->dieContinueUsageIf( $continueId != $cont[1] );
  99                         $this->addWhere( "ipb_timestamp $op $continueTimestamp OR " .
 100                                 "(ipb_timestamp = $continueTimestamp AND " .
 101                                 "ipb_id $op= $continueId)"
 102                         );
 103                 }
 104
 105                 if ( isset( $params['ids'] ) ) {
 106                         $this->addWhereIDsFld( 'ipblocks', 'ipb_id', $params['ids'] );
 107                 }
 108                 if ( isset( $params['users'] ) ) {
 109                         $usernames = [];
 110                         foreach ( (array)$params['users'] as $u ) {
 111                                 $usernames[] = $this->prepareUsername( $u );
 112                         }
 113                         $this->addWhereFld( 'ipb_address', $usernames );
 114                         $this->addWhereFld( 'ipb_auto', 0 );
 115                 }
 116                 if ( isset( $params['ip'] ) ) {
 117                         $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
 118                         if ( IP::isIPv4( $params['ip'] ) ) {
 119                                 $type = 'IPv4';
 120                                 $cidrLimit = $blockCIDRLimit['IPv4'];
 121                                 $prefixLen = 0;
 122                         } elseif ( IP::isIPv6( $params['ip'] ) ) {
 123                                 $type = 'IPv6';
 124                                 $cidrLimit = $blockCIDRLimit['IPv6'];
 125                                 $prefixLen = 3; // IP::toHex output is prefixed with "v6-"
 126                         } else {
 127                                 $this->dieWithError( 'apierror-badip', 'param_ip' );
 128                         }
 129
 130                         # Check range validity, if it's a CIDR
 131                         list( $ip, $range ) = IP::parseCIDR( $params['ip'] );
 132                         if ( $ip !== false && $range !== false && $range < $cidrLimit ) {
 133                                 $this->dieWithError( [ 'apierror-cidrtoobroad', $type, $cidrLimit ] );
 134                         }
 135
 136                         # Let IP::parseRange handle calculating $upper, instead of duplicating the logic here.
 137                         list( $lower, $upper ) = IP::parseRange( $params['ip'] );
 138
 139                         # Extract the common prefix to any rangeblock affecting this IP/CIDR
 140                         $prefix = substr( $lower, 0, $prefixLen + floor( $cidrLimit / 4 ) );
 141
 142                         # Fairly hard to make a malicious SQL statement out of hex characters,
 143                         # but it is good practice to add quotes
 144                         $lower = $db->addQuotes( $lower );
 145                         $upper = $db->addQuotes( $upper );
 146
 147                         $this->addWhere( [
 148                                 'ipb_range_start' . $db->buildLike( $prefix, $db->anyString() ),
 149                                 'ipb_range_start <= ' . $lower,
 150                                 'ipb_range_end >= ' . $upper,
 151                                 'ipb_auto' => 0
 152                         ] );
 153                 }
 154
 155                 if ( !is_null( $params['show'] ) ) {
 156                         $show = array_flip( $params['show'] );
 157
 158                         /* Check for conflicting parameters. */
 159                         if ( ( isset( $show['account'] ) && isset( $show['!account'] ) )
 160                                 || ( isset( $show['ip'] ) && isset( $show['!ip'] ) )
 161                                 || ( isset( $show['range'] ) && isset( $show['!range'] ) )
 162                                 || ( isset( $show['temp'] ) && isset( $show['!temp'] ) )
 163                         ) {
 164                                 $this->dieWithError( 'apierror-show' );
 165                         }
 166
 167                         $this->addWhereIf( 'ipb_user = 0', isset( $show['!account'] ) );
 168                         $this->addWhereIf( 'ipb_user != 0', isset( $show['account'] ) );
 169                         $this->addWhereIf( 'ipb_user != 0 OR ipb_range_end > ipb_range_start', isset( $show['!ip'] ) );
 170                         $this->addWhereIf( 'ipb_user = 0 AND ipb_range_end = ipb_range_start', isset( $show['ip'] ) );
 171                         $this->addWhereIf( 'ipb_expiry = ' .
 172                                 $db->addQuotes( $db->getInfinity() ), isset( $show['!temp'] ) );
 173                         $this->addWhereIf( 'ipb_expiry != ' .
 174                                 $db->addQuotes( $db->getInfinity() ), isset( $show['temp'] ) );
 175                         $this->addWhereIf( 'ipb_range_end = ipb_range_start', isset( $show['!range'] ) );
 176                         $this->addWhereIf( 'ipb_range_end > ipb_range_start', isset( $show['range'] ) );
 177                 }
 178
 179                 if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
 180                         $this->addWhereFld( 'ipb_deleted', 0 );
 181                 }
 182
 183                 # Filter out expired rows
 184                 $this->addWhere( 'ipb_expiry > ' . $db->addQuotes( $db->timestamp() ) );
 185
 186                 $res = $this->select( __METHOD__ );
 187
 188                 $restrictions = [];
 189                 if ( $fld_restrictions ) {
 190                         $restrictions = self::getRestrictionData( $res, $params['limit'] );
 191                 }
 192
 193                 $count = 0;
 194                 foreach ( $res as $row ) {
 195                         if ( ++$count > $params['limit'] ) {
 196                                 // We've had enough
 197                                 $this->setContinueEnumParameter( 'continue', "$row->ipb_timestamp|$row->ipb_id" );
 198                                 break;
 199                         }
 200                         $block = [
 201                                 ApiResult::META_TYPE => 'assoc',
 202                         ];
 203                         if ( $fld_id ) {
 204                                 $block['id'] = (int)$row->ipb_id;
 205                         }
 206                         if ( $fld_user && !$row->ipb_auto ) {
 207                                 $block['user'] = $row->ipb_address;
 208                         }
 209                         if ( $fld_userid && !$row->ipb_auto ) {
 210                                 $block['userid'] = (int)$row->ipb_user;
 211                         }
 212                         if ( $fld_by ) {
 213                                 $block['by'] = $row->ipb_by_text;
 214                         }
 215                         if ( $fld_byid ) {
 216                                 $block['byid'] = (int)$row->ipb_by;
 217                         }
 218                         if ( $fld_timestamp ) {
 219                                 $block['timestamp'] = wfTimestamp( TS_ISO_8601, $row->ipb_timestamp );
 220                         }
 221                         if ( $fld_expiry ) {
 222                                 $block['expiry'] = ApiResult::formatExpiry( $row->ipb_expiry );
 223                         }
 224                         if ( $fld_reason ) {
 225                                 $block['reason'] = $commentStore->getComment( 'ipb_reason', $row )->text;
 226                         }
 227                         if ( $fld_range && !$row->ipb_auto ) {
 228                                 $block['rangestart'] = IP::formatHex( $row->ipb_range_start );
 229                                 $block['rangeend'] = IP::formatHex( $row->ipb_range_end );
 230                         }
 231                         if ( $fld_flags ) {
 232                                 // For clarity, these flags use the same names as their action=block counterparts
 233                                 $block['automatic'] = (bool)$row->ipb_auto;
 234                                 $block['anononly'] = (bool)$row->ipb_anon_only;
 235                                 $block['nocreate'] = (bool)$row->ipb_create_account;
 236                                 $block['autoblock'] = (bool)$row->ipb_enable_autoblock;
 237                                 $block['noemail'] = (bool)$row->ipb_block_email;
 238                                 $block['hidden'] = (bool)$row->ipb_deleted;
 239                                 $block['allowusertalk'] = (bool)$row->ipb_allow_usertalk;
 240                                 $block['partial'] = !(bool)$row->ipb_sitewide;
 241                         }
 242
 243                         if ( $fld_restrictions ) {
 244                                 $block['restrictions'] = [];
 245                                 if ( !$row->ipb_sitewide && isset( $restrictions[$row->ipb_id] ) ) {
 246                                         $block['restrictions'] = $restrictions[$row->ipb_id];
 247                                 }
 248                         }
 249
 250                         $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $block );
 251                         if ( !$fit ) {
 252                                 $this->setContinueEnumParameter( 'continue', "$row->ipb_timestamp|$row->ipb_id" );
 253                                 break;
 254                         }
 255                 }
 256                 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'block' );
 257         }
 258
 259         protected function prepareUsername( $user ) {
 260                 if ( !$user ) {
 261                         $encParamName = $this->encodeParamName( 'users' );
 262                         $this->dieWithError( [ 'apierror-baduser', $encParamName, wfEscapeWikiText( $user ) ],
 263                                 "baduser_{$encParamName}"
 264                         );
 265                 }
 266                 $name = User::isIP( $user )
 267                         ? $user
 268                         : User::getCanonicalName( $user, 'valid' );
 269                 if ( $name === false ) {
 270                         $encParamName = $this->encodeParamName( 'users' );
 271                         $this->dieWithError( [ 'apierror-baduser', $encParamName, wfEscapeWikiText( $user ) ],
 272                                 "baduser_{$encParamName}"
 273                         );
 274                 }
 275                 return $name;
 276         }
 277
 278         /**
 279          * Retrieves the restrictions based on the query result.
 280          *
 281          * @param IResultWrapper $result
 282          * @param int $limit
 283          *
 284          * @return array
 285          */
 286         private static function getRestrictionData( IResultWrapper $result, $limit ) {
 287                 $partialIds = [];
 288                 $count = 0;
 289                 foreach ( $result as $row ) {
 290                         if ( ++$count <= $limit && !$row->ipb_sitewide ) {
 291                                 $partialIds[] = (int)$row->ipb_id;
 292                         }
 293                 }
 294
 295                 $restrictions = BlockRestriction::loadByBlockId( $partialIds );
 296
 297                 $data = [];
 298                 $keys = [
 299                         'page' => 'pages',
 300                         'ns' => 'namespaces',
 301                 ];
 302                 foreach ( $restrictions as $restriction ) {
 303                         $key = $keys[$restriction->getType()];
 304                         $id = $restriction->getBlockId();
 305                         switch ( $restriction->getType() ) {
 306                                 case 'page':
 307                                         $value = [ 'id' => $restriction->getValue() ];
 308                                         if ( $restriction->getTitle() ) {
 309                                                 self::addTitleInfo( $value, $restriction->getTitle() );
 310                                         }
 311                                         break;
 312                                 default:
 313                                         $value = $restriction->getValue();
 314                         }
 315
 316                         if ( !isset( $data[$id][$key] ) ) {
 317                                 $data[$id][$key] = [];
 318                                 ApiResult::setIndexedTagName( $data[$id][$key], $restriction->getType() );
 319                         }
 320                         $data[$id][$key][] = $value;
 321                 }
 322
 323                 return $data;
 324         }
 325
 326         public function getAllowedParams() {
 327                 $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
 328
 329                 return [
 330                         'start' => [
 331                                 ApiBase::PARAM_TYPE => 'timestamp'
 332                         ],
 333                         'end' => [
 334                                 ApiBase::PARAM_TYPE => 'timestamp',
 335                         ],
 336                         'dir' => [
 337                                 ApiBase::PARAM_TYPE => [
 338                                         'newer',
 339                                         'older'
 340                                 ],
 341                                 ApiBase::PARAM_DFLT => 'older',
 342                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
 343                         ],
 344                         'ids' => [
 345                                 ApiBase::PARAM_TYPE => 'integer',
 346                                 ApiBase::PARAM_ISMULTI => true
 347                         ],
 348                         'users' => [
 349                                 ApiBase::PARAM_TYPE => 'user',
 350                                 ApiBase::PARAM_ISMULTI => true
 351                         ],
 352                         'ip' => [
 353                                 ApiBase::PARAM_HELP_MSG => [
 354                                         'apihelp-query+blocks-param-ip',
 355                                         $blockCIDRLimit['IPv4'],
 356                                         $blockCIDRLimit['IPv6'],
 357                                 ],
 358                         ],
 359                         'limit' => [
 360                                 ApiBase::PARAM_DFLT => 10,
 361                                 ApiBase::PARAM_TYPE => 'limit',
 362                                 ApiBase::PARAM_MIN => 1,
 363                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 364                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 365                         ],
 366                         'prop' => [
 367                                 ApiBase::PARAM_DFLT => 'id|user|by|timestamp|expiry|reason|flags',
 368                                 ApiBase::PARAM_TYPE => [
 369                                         'id',
 370                                         'user',
 371                                         'userid',
 372                                         'by',
 373                                         'byid',
 374                                         'timestamp',
 375                                         'expiry',
 376                                         'reason',
 377                                         'range',
 378                                         'flags',
 379                                         'restrictions',
 380                                 ],
 381                                 ApiBase::PARAM_ISMULTI => true,
 382                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
 383                         ],
 384                         'show' => [
 385                                 ApiBase::PARAM_TYPE => [
 386                                         'account',
 387                                         '!account',
 388                                         'temp',
 389                                         '!temp',
 390                                         'ip',
 391                                         '!ip',
 392                                         'range',
 393                                         '!range',
 394                                 ],
 395                                 ApiBase::PARAM_ISMULTI => true
 396                         ],
 397                         'continue' => [
 398                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 399                         ],
 400                 ];
 401         }
 402
 403         protected function getExamplesMessages() {
 404                 return [
 405                         'action=query&list=blocks'
 406                                 => 'apihelp-query+blocks-example-simple',
 407                         'action=query&list=blocks&bkusers=Alice|Bob'
 408                                 => 'apihelp-query+blocks-example-users',
 409                 ];
 410         }
 411
 412         public function getHelpUrls() {
 413                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Blocks';
 414         }
 415 }