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
{
39 public function __construct( ApiQuery
$query, $moduleName ) {
40 parent
::__construct( $query, $moduleName, 'bk' );
43 public function execute() {
47 $params = $this->extractRequestParams();
48 $this->requireMaxOneParameter( $params, 'users', 'ip' );
50 $prop = array_flip( $params['prop'] );
51 $fld_id = isset( $prop['id'] );
52 $fld_user = isset( $prop['user'] );
53 $fld_userid = isset( $prop['userid'] );
54 $fld_by = isset( $prop['by'] );
55 $fld_byid = isset( $prop['byid'] );
56 $fld_timestamp = isset( $prop['timestamp'] );
57 $fld_expiry = isset( $prop['expiry'] );
58 $fld_reason = isset( $prop['reason'] );
59 $fld_range = isset( $prop['range'] );
60 $fld_flags = isset( $prop['flags'] );
62 $result = $this->getResult();
64 $this->addTables( 'ipblocks' );
65 $this->addFields( array( 'ipb_auto', 'ipb_id' ) );
67 $this->addFieldsIf( array( 'ipb_address', 'ipb_user' ), $fld_user ||
$fld_userid );
68 $this->addFieldsIf( 'ipb_by_text', $fld_by );
69 $this->addFieldsIf( 'ipb_by', $fld_byid );
70 $this->addFieldsIf( 'ipb_timestamp', $fld_timestamp );
71 $this->addFieldsIf( 'ipb_expiry', $fld_expiry );
72 $this->addFieldsIf( 'ipb_reason', $fld_reason );
73 $this->addFieldsIf( array( 'ipb_range_start', 'ipb_range_end' ), $fld_range );
74 $this->addFieldsIf( array( 'ipb_anon_only', 'ipb_create_account', 'ipb_enable_autoblock',
75 'ipb_block_email', 'ipb_deleted', 'ipb_allow_usertalk' ),
78 $this->addOption( 'LIMIT', $params['limit'] +
1 );
79 $this->addTimestampWhereRange(
85 // Include in ORDER BY for uniqueness
86 $this->addWhereRange( 'ipb_id', $params['dir'], null, null );
88 if ( !is_null( $params['continue'] ) ) {
89 $cont = explode( '|', $params['continue'] );
90 $this->dieContinueUsageIf( count( $cont ) != 2 );
91 $op = ( $params['dir'] == 'newer' ?
'>' : '<' );
92 $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
93 $continueId = (int)$cont[1];
94 $this->dieContinueUsageIf( $continueId != $cont[1] );
95 $this->addWhere( "ipb_timestamp $op $continueTimestamp OR " .
96 "(ipb_timestamp = $continueTimestamp AND " .
97 "ipb_id $op= $continueId)"
101 if ( isset( $params['ids'] ) ) {
102 $this->addWhereFld( 'ipb_id', $params['ids'] );
104 if ( isset( $params['users'] ) ) {
105 foreach ( (array)$params['users'] as $u ) {
106 $this->prepareUsername( $u );
108 $this->addWhereFld( 'ipb_address', $this->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->dieUsage( 'IP parameter is not valid', '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 ) {
129 "$type CIDR ranges broader than /$cidrLimit are not accepted",
134 # Let IP::parseRange handle calculating $upper, instead of duplicating the logic here.
135 list( $lower, $upper ) = IP
::parseRange( $params['ip'] );
137 # Extract the common prefix to any rangeblock affecting this IP/CIDR
138 $prefix = substr( $lower, 0, $prefixLen +
floor( $cidrLimit / 4 ) );
140 # Fairly hard to make a malicious SQL statement out of hex characters,
141 # but it is good practice to add quotes
142 $lower = $db->addQuotes( $lower );
143 $upper = $db->addQuotes( $upper );
145 $this->addWhere( array(
146 'ipb_range_start' . $db->buildLike( $prefix, $db->anyString() ),
147 'ipb_range_start <= ' . $lower,
148 'ipb_range_end >= ' . $upper,
153 if ( !is_null( $params['show'] ) ) {
154 $show = array_flip( $params['show'] );
156 /* Check for conflicting parameters. */
157 if ( ( isset( $show['account'] ) && isset( $show['!account'] ) )
158 ||
( isset( $show['ip'] ) && isset( $show['!ip'] ) )
159 ||
( isset( $show['range'] ) && isset( $show['!range'] ) )
160 ||
( isset( $show['temp'] ) && isset( $show['!temp'] ) )
162 $this->dieUsageMsg( 'show' );
165 $this->addWhereIf( 'ipb_user = 0', isset( $show['!account'] ) );
166 $this->addWhereIf( 'ipb_user != 0', isset( $show['account'] ) );
167 $this->addWhereIf( 'ipb_user != 0 OR ipb_range_end > ipb_range_start', isset( $show['!ip'] ) );
168 $this->addWhereIf( 'ipb_user = 0 AND ipb_range_end = ipb_range_start', isset( $show['ip'] ) );
169 $this->addWhereIf( 'ipb_expiry = ' .
170 $db->addQuotes( $db->getInfinity() ), isset( $show['!temp'] ) );
171 $this->addWhereIf( 'ipb_expiry != ' .
172 $db->addQuotes( $db->getInfinity() ), isset( $show['temp'] ) );
173 $this->addWhereIf( 'ipb_range_end = ipb_range_start', isset( $show['!range'] ) );
174 $this->addWhereIf( 'ipb_range_end > ipb_range_start', isset( $show['range'] ) );
177 if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
178 $this->addWhereFld( 'ipb_deleted', 0 );
181 // Purge expired entries on one in every 10 queries
182 if ( !mt_rand( 0, 10 ) ) {
183 Block
::purgeExpired();
186 $res = $this->select( __METHOD__
);
189 foreach ( $res as $row ) {
190 if ( ++
$count > $params['limit'] ) {
192 $this->setContinueEnumParameter( 'continue', "$row->ipb_timestamp|$row->ipb_id" );
197 $block['id'] = $row->ipb_id
;
199 if ( $fld_user && !$row->ipb_auto
) {
200 $block['user'] = $row->ipb_address
;
202 if ( $fld_userid && !$row->ipb_auto
) {
203 $block['userid'] = $row->ipb_user
;
206 $block['by'] = $row->ipb_by_text
;
209 $block['byid'] = $row->ipb_by
;
211 if ( $fld_timestamp ) {
212 $block['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->ipb_timestamp
);
215 $block['expiry'] = $wgContLang->formatExpiry( $row->ipb_expiry
, TS_ISO_8601
);
218 $block['reason'] = $row->ipb_reason
;
220 if ( $fld_range && !$row->ipb_auto
) {
221 $block['rangestart'] = IP
::formatHex( $row->ipb_range_start
);
222 $block['rangeend'] = IP
::formatHex( $row->ipb_range_end
);
225 // For clarity, these flags use the same names as their action=block counterparts
226 if ( $row->ipb_auto
) {
227 $block['automatic'] = '';
229 if ( $row->ipb_anon_only
) {
230 $block['anononly'] = '';
232 if ( $row->ipb_create_account
) {
233 $block['nocreate'] = '';
235 if ( $row->ipb_enable_autoblock
) {
236 $block['autoblock'] = '';
238 if ( $row->ipb_block_email
) {
239 $block['noemail'] = '';
241 if ( $row->ipb_deleted
) {
242 $block['hidden'] = '';
244 if ( $row->ipb_allow_usertalk
) {
245 $block['allowusertalk'] = '';
248 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $block );
250 $this->setContinueEnumParameter( 'continue', "$row->ipb_timestamp|$row->ipb_id" );
254 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'block' );
257 protected function prepareUsername( $user ) {
259 $this->dieUsage( 'User parameter may not be empty', 'param_user' );
261 $name = User
::isIP( $user )
263 : User
::getCanonicalName( $user, 'valid' );
264 if ( $name === false ) {
265 $this->dieUsage( "User name {$user} is not valid", 'param_user' );
267 $this->usernames
[] = $name;
270 public function getAllowedParams() {
271 $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
275 ApiBase
::PARAM_TYPE
=> 'timestamp'
278 ApiBase
::PARAM_TYPE
=> 'timestamp',
281 ApiBase
::PARAM_TYPE
=> array(
285 ApiBase
::PARAM_DFLT
=> 'older',
286 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-direction',
289 ApiBase
::PARAM_TYPE
=> 'integer',
290 ApiBase
::PARAM_ISMULTI
=> true
293 ApiBase
::PARAM_ISMULTI
=> true
296 ApiBase
::PARAM_HELP_MSG
=> array(
297 'apihelp-query+blocks-param-ip',
298 $blockCIDRLimit['IPv4'],
299 $blockCIDRLimit['IPv6'],
303 ApiBase
::PARAM_DFLT
=> 10,
304 ApiBase
::PARAM_TYPE
=> 'limit',
305 ApiBase
::PARAM_MIN
=> 1,
306 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
307 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
310 ApiBase
::PARAM_DFLT
=> 'id|user|by|timestamp|expiry|reason|flags',
311 ApiBase
::PARAM_TYPE
=> array(
323 ApiBase
::PARAM_ISMULTI
=> true
326 ApiBase
::PARAM_TYPE
=> array(
336 ApiBase
::PARAM_ISMULTI
=> true
339 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
344 public function getExamplesMessages() {
346 'action=query&list=blocks'
347 => 'apihelp-query+blocks-example-simple',
348 'action=query&list=blocks&bkusers=Alice|Bob'
349 => 'apihelp-query+blocks-example-users',
353 public function getHelpUrls() {
354 return 'https://www.mediawiki.org/wiki/API:Blocks';