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