5 * Created on Sep 10, 2007
7 * Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
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.
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.
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
28 * Query module to enumerate all user blocks
32 class ApiQueryBlocks extends ApiQueryBase {
34 public function __construct( ApiQuery $query, $moduleName ) {
35 parent::__construct( $query, $moduleName, 'bk' );
38 public function execute() {
40 $commentStore = new CommentStore( 'ipb_reason' );
41 $params = $this->extractRequestParams();
42 $this->requireMaxOneParameter( $params, 'users', 'ip' );
44 $prop = array_flip( $params['prop'] );
45 $fld_id = isset( $prop['id'] );
46 $fld_user = isset( $prop['user'] );
47 $fld_userid = isset( $prop['userid'] );
48 $fld_by = isset( $prop['by'] );
49 $fld_byid = isset( $prop['byid'] );
50 $fld_timestamp = isset( $prop['timestamp'] );
51 $fld_expiry = isset( $prop['expiry'] );
52 $fld_reason = isset( $prop['reason'] );
53 $fld_range = isset( $prop['range'] );
54 $fld_flags = isset( $prop['flags'] );
56 $result = $this->getResult();
58 $this->addTables( 'ipblocks' );
59 $this->addFields( [ 'ipb_auto', 'ipb_id', 'ipb_timestamp' ] );
61 $this->addFieldsIf( [ 'ipb_address', 'ipb_user' ], $fld_user || $fld_userid );
62 $this->addFieldsIf( 'ipb_by_text', $fld_by );
63 $this->addFieldsIf( 'ipb_by', $fld_byid );
64 $this->addFieldsIf( 'ipb_expiry', $fld_expiry );
65 $this->addFieldsIf( [ 'ipb_range_start', 'ipb_range_end' ], $fld_range );
66 $this->addFieldsIf( [ 'ipb_anon_only', 'ipb_create_account', 'ipb_enable_autoblock',
67 'ipb_block_email', 'ipb_deleted', 'ipb_allow_usertalk' ],
71 $commentQuery = $commentStore->getJoin();
72 $this->addTables( $commentQuery['tables'] );
73 $this->addFields( $commentQuery['fields'] );
74 $this->addJoinConds( $commentQuery['joins'] );
77 $this->addOption( 'LIMIT', $params['limit'] + 1 );
78 $this->addTimestampWhereRange(
84 // Include in ORDER BY for uniqueness
85 $this->addWhereRange( 'ipb_id', $params['dir'], null, null );
87 if ( !is_null( $params['continue'] ) ) {
88 $cont = explode( '|', $params['continue'] );
89 $this->dieContinueUsageIf( count( $cont ) != 2 );
90 $op = ( $params['dir'] == 'newer' ? '>' : '<' );
91 $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
92 $continueId = (int)$cont[1];
93 $this->dieContinueUsageIf( $continueId != $cont[1] );
94 $this->addWhere( "ipb_timestamp $op $continueTimestamp OR " .
95 "(ipb_timestamp = $continueTimestamp AND " .
96 "ipb_id $op= $continueId)"
100 if ( isset( $params['ids'] ) ) {
101 $this->addWhereFld( 'ipb_id', $params['ids'] );
103 if ( isset( $params['users'] ) ) {
105 foreach ( (array)$params['users'] as $u ) {
106 $usernames[] = $this->prepareUsername( $u );
108 $this->addWhereFld( 'ipb_address', $usernames );
109 $this->addWhereFld( 'ipb_auto', 0 );
111 if ( isset( $params['ip'] ) ) {
112 $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
113 if ( IP::isIPv4( $params['ip'] ) ) {
115 $cidrLimit = $blockCIDRLimit['IPv4'];
117 } elseif ( IP::isIPv6( $params['ip'] ) ) {
119 $cidrLimit = $blockCIDRLimit['IPv6'];
120 $prefixLen = 3; // IP::toHex output is prefixed with "v6-"
122 $this->dieWithError( 'apierror-badip', 'param_ip' );
125 # Check range validity, if it's a CIDR
126 list( $ip, $range ) = IP::parseCIDR( $params['ip'] );
127 if ( $ip !== false && $range !== false && $range < $cidrLimit ) {
128 $this->dieWithError( [ 'apierror-cidrtoobroad', $type, $cidrLimit ] );
131 # Let IP::parseRange handle calculating $upper, instead of duplicating the logic here.
132 list( $lower, $upper ) = IP::parseRange( $params['ip'] );
134 # Extract the common prefix to any rangeblock affecting this IP/CIDR
135 $prefix = substr( $lower, 0, $prefixLen + floor( $cidrLimit / 4 ) );
137 # Fairly hard to make a malicious SQL statement out of hex characters,
138 # but it is good practice to add quotes
139 $lower = $db->addQuotes( $lower );
140 $upper = $db->addQuotes( $upper );
143 'ipb_range_start' . $db->buildLike( $prefix, $db->anyString() ),
144 'ipb_range_start <= ' . $lower,
145 'ipb_range_end >= ' . $upper,
150 if ( !is_null( $params['show'] ) ) {
151 $show = array_flip( $params['show'] );
153 /* Check for conflicting parameters. */
154 if ( ( isset( $show['account'] ) && isset( $show['!account'] ) )
155 || ( isset( $show['ip'] ) && isset( $show['!ip'] ) )
156 || ( isset( $show['range'] ) && isset( $show['!range'] ) )
157 || ( isset( $show['temp'] ) && isset( $show['!temp'] ) )
159 $this->dieWithError( 'apierror-show' );
162 $this->addWhereIf( 'ipb_user = 0', isset( $show['!account'] ) );
163 $this->addWhereIf( 'ipb_user != 0', isset( $show['account'] ) );
164 $this->addWhereIf( 'ipb_user != 0 OR ipb_range_end > ipb_range_start', isset( $show['!ip'] ) );
165 $this->addWhereIf( 'ipb_user = 0 AND ipb_range_end = ipb_range_start', isset( $show['ip'] ) );
166 $this->addWhereIf( 'ipb_expiry = ' .
167 $db->addQuotes( $db->getInfinity() ), isset( $show['!temp'] ) );
168 $this->addWhereIf( 'ipb_expiry != ' .
169 $db->addQuotes( $db->getInfinity() ), isset( $show['temp'] ) );
170 $this->addWhereIf( 'ipb_range_end = ipb_range_start', isset( $show['!range'] ) );
171 $this->addWhereIf( 'ipb_range_end > ipb_range_start', isset( $show['range'] ) );
174 if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
175 $this->addWhereFld( 'ipb_deleted', 0 );
178 # Filter out expired rows
179 $this->addWhere( 'ipb_expiry > ' . $db->addQuotes( $db->timestamp() ) );
181 $res = $this->select( __METHOD__ );
184 foreach ( $res as $row ) {
185 if ( ++$count > $params['limit'] ) {
187 $this->setContinueEnumParameter( 'continue', "$row->ipb_timestamp|$row->ipb_id" );
191 ApiResult::META_TYPE => 'assoc',
194 $block['id'] = (int)$row->ipb_id;
196 if ( $fld_user && !$row->ipb_auto ) {
197 $block['user'] = $row->ipb_address;
199 if ( $fld_userid && !$row->ipb_auto ) {
200 $block['userid'] = (int)$row->ipb_user;
203 $block['by'] = $row->ipb_by_text;
206 $block['byid'] = (int)$row->ipb_by;
208 if ( $fld_timestamp ) {
209 $block['timestamp'] = wfTimestamp( TS_ISO_8601, $row->ipb_timestamp );
212 $block['expiry'] = ApiResult::formatExpiry( $row->ipb_expiry );
215 $block['reason'] = $commentStore->getComment( $row )->text;
217 if ( $fld_range && !$row->ipb_auto ) {
218 $block['rangestart'] = IP::formatHex( $row->ipb_range_start );
219 $block['rangeend'] = IP::formatHex( $row->ipb_range_end );
222 // For clarity, these flags use the same names as their action=block counterparts
223 $block['automatic'] = (bool)$row->ipb_auto;
224 $block['anononly'] = (bool)$row->ipb_anon_only;
225 $block['nocreate'] = (bool)$row->ipb_create_account;
226 $block['autoblock'] = (bool)$row->ipb_enable_autoblock;
227 $block['noemail'] = (bool)$row->ipb_block_email;
228 $block['hidden'] = (bool)$row->ipb_deleted;
229 $block['allowusertalk'] = (bool)$row->ipb_allow_usertalk;
231 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $block );
233 $this->setContinueEnumParameter( 'continue', "$row->ipb_timestamp|$row->ipb_id" );
237 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'block' );
240 protected function prepareUsername( $user ) {
242 $encParamName = $this->encodeParamName( 'users' );
243 $this->dieWithError( [ 'apierror-baduser', $encParamName, wfEscapeWikiText( $user ) ],
244 "baduser_{$encParamName}"
247 $name = User::isIP( $user )
249 : User::getCanonicalName( $user, 'valid' );
250 if ( $name === false ) {
251 $encParamName = $this->encodeParamName( 'users' );
252 $this->dieWithError( [ 'apierror-baduser', $encParamName, wfEscapeWikiText( $user ) ],
253 "baduser_{$encParamName}"
259 public function getAllowedParams() {
260 $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
264 ApiBase::PARAM_TYPE => 'timestamp'
267 ApiBase::PARAM_TYPE => 'timestamp',
270 ApiBase::PARAM_TYPE => [
274 ApiBase::PARAM_DFLT => 'older',
275 ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
278 ApiBase::PARAM_TYPE => 'integer',
279 ApiBase::PARAM_ISMULTI => true
282 ApiBase::PARAM_TYPE => 'user',
283 ApiBase::PARAM_ISMULTI => true
286 ApiBase::PARAM_HELP_MSG => [
287 'apihelp-query+blocks-param-ip',
288 $blockCIDRLimit['IPv4'],
289 $blockCIDRLimit['IPv6'],
293 ApiBase::PARAM_DFLT => 10,
294 ApiBase::PARAM_TYPE => 'limit',
295 ApiBase::PARAM_MIN => 1,
296 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
297 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
300 ApiBase::PARAM_DFLT => 'id|user|by|timestamp|expiry|reason|flags',
301 ApiBase::PARAM_TYPE => [
313 ApiBase::PARAM_ISMULTI => true,
314 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
317 ApiBase::PARAM_TYPE => [
327 ApiBase::PARAM_ISMULTI => true
330 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
335 protected function getExamplesMessages() {
337 'action=query&list=blocks'
338 => 'apihelp-query+blocks-example-simple',
339 'action=query&list=blocks&bkusers=Alice|Bob'
340 => 'apihelp-query+blocks-example-users',
344 public function getHelpUrls() {
345 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Blocks';