4 * Created on Sep 10, 2007
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ('ApiQueryBase.php');
32 * Query module to enumerate all available pages.
36 class ApiQueryBlocks extends ApiQueryBase {
40 public function __construct($query, $moduleName) {
41 parent :: __construct($query, $moduleName, 'bk');
44 public function execute() {
47 $params = $this->extractRequestParams();
48 if(isset($params['users']) && isset($params['ip']))
49 $this->dieUsage('bkusers and bkip cannot be used together', 'usersandip');
51 $prop = array_flip($params['prop']);
52 $fld_id = isset($prop['id']);
53 $fld_user = isset($prop['user']);
54 $fld_by = isset($prop['by']);
55 $fld_timestamp = isset($prop['timestamp']);
56 $fld_expiry = isset($prop['expiry']);
57 $fld_reason = isset($prop['reason']);
58 $fld_range = isset($prop['range']);
59 $fld_flags = isset($prop['flags']);
61 $result = $this->getResult();
62 $pageSet = $this->getPageSet();
63 $titles = $pageSet->getTitles();
66 $this->addTables('ipblocks');
68 $this->addFields('ipb_id');
70 $this->addFields(array('ipb_address', 'ipb_user', 'ipb_auto'));
73 $this->addTables('user');
74 $this->addFields(array('ipb_by', 'user_name'));
75 $this->addWhere('user_id = ipb_by');
78 $this->addFields('ipb_timestamp');
80 $this->addFields('ipb_expiry');
82 $this->addFields('ipb_reason');
84 $this->addFields(array('ipb_range_start', 'ipb_range_end'));
86 $this->addFields(array('ipb_auto', 'ipb_anon_only', 'ipb_create_account', 'ipb_enable_autoblock', 'ipb_block_email', 'ipb_deleted', 'ipb_allow_usertalk'));
88 $this->addOption('LIMIT', $params['limit'] + 1);
89 $this->addWhereRange('ipb_timestamp', $params['dir'], $params['start'], $params['end']);
90 if(isset($params['ids']))
91 $this->addWhereFld('ipb_id', $params['ids']);
92 if(isset($params['users']))
94 foreach((array)$params['users'] as $u)
95 $this->prepareUsername($u);
96 $this->addWhereFld('ipb_address', $this->usernames);
98 if(isset($params['ip']))
100 list($ip, $range) = IP::parseCIDR($params['ip']);
103 # We got a CIDR range
105 $this->dieUsage('CIDR ranges broader than /16 are not accepted', 'cidrtoobroad');
106 $lower = wfBaseConvert($ip, 10, 16, 8, false);
107 $upper = wfBaseConvert($ip + pow(2, 32 - $range) - 1, 10, 16, 8, false);
110 $lower = $upper = IP::toHex($params['ip']);
111 $prefix = substr($lower, 0, 4);
112 $this->addWhere(array(
113 "ipb_range_start LIKE '$prefix%'",
114 "ipb_range_start <= '$lower'",
115 "ipb_range_end >= '$upper'"
118 if(!$wgUser->isAllowed('hideuser'))
119 $this->addWhereFld('ipb_deleted', 0);
121 // Purge expired entries on one in every 10 queries
123 Block::purgeExpired();
125 $res = $this->select(__METHOD__);
128 while($row = $res->fetchObject())
130 if(++$count > $params['limit'])
133 $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->ipb_timestamp));
138 $block['id'] = $row->ipb_id;
139 if($fld_user && !$row->ipb_auto)
140 $block['user'] = $row->ipb_address;
142 $block['by'] = $row->user_name;
144 $block['timestamp'] = wfTimestamp(TS_ISO_8601, $row->ipb_timestamp);
146 $block['expiry'] = Block::decodeExpiry($row->ipb_expiry, TS_ISO_8601);
148 $block['reason'] = $row->ipb_reason;
151 $block['rangestart'] = IP::hexToQuad($row->ipb_range_start);
152 $block['rangeend'] = IP::hexToQuad($row->ipb_range_end);
156 // For clarity, these flags use the same names as their action=block counterparts
158 $block['automatic'] = '';
159 if($row->ipb_anon_only)
160 $block['anononly'] = '';
161 if($row->ipb_create_account)
162 $block['nocreate'] = '';
163 if($row->ipb_enable_autoblock)
164 $block['autoblock'] = '';
165 if($row->ipb_block_email)
166 $block['noemail'] = '';
167 if($row->ipb_deleted)
168 $block['hidden'] = '';
169 if($row->ipb_allow_usertalk)
170 $block['allowusertalk'] = '';
172 $fit = $result->addValue(array('query', $this->getModuleName()), null, $block);
175 $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->ipb_timestamp));
179 $result->setIndexedTagName_internal(array('query', $this->getModuleName()), 'block');
182 protected function prepareUsername($user)
185 $this->dieUsage('User parameter may not be empty', 'param_user');
186 $name = User::isIP($user)
188 : User::getCanonicalName($user, 'valid');
190 $this->dieUsage("User name {$user} is not valid", 'param_user');
191 $this->usernames[] = $name;
194 public function getAllowedParams() {
197 ApiBase :: PARAM_TYPE => 'timestamp'
200 ApiBase :: PARAM_TYPE => 'timestamp',
203 ApiBase :: PARAM_TYPE => array(
207 ApiBase :: PARAM_DFLT => 'older'
210 ApiBase :: PARAM_TYPE => 'integer',
211 ApiBase :: PARAM_ISMULTI => true
214 ApiBase :: PARAM_ISMULTI => true
218 ApiBase :: PARAM_DFLT => 10,
219 ApiBase :: PARAM_TYPE => 'limit',
220 ApiBase :: PARAM_MIN => 1,
221 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
222 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
225 ApiBase :: PARAM_DFLT => 'id|user|by|timestamp|expiry|reason|flags',
226 ApiBase :: PARAM_TYPE => array(
236 ApiBase :: PARAM_ISMULTI => true
241 public function getParamDescription() {
243 'start' => 'The timestamp to start enumerating from',
244 'end' => 'The timestamp to stop enumerating at',
245 'dir' => 'The direction in which to enumerate',
246 'ids' => 'Pipe-separated list of block IDs to list (optional)',
247 'users' => 'Pipe-separated list of users to search for (optional)',
248 'ip' => array( 'Get all blocks applying to this IP or CIDR range, including range blocks.',
249 'Cannot be used together with bkusers. CIDR ranges broader than /16 are not accepted.'),
250 'limit' => 'The maximum amount of blocks to list',
251 'prop' => 'Which properties to get',
255 public function getDescription() {
256 return 'List all blocked users and IP addresses.';
259 protected function getExamples() {
260 return array ( 'api.php?action=query&list=blocks',
261 'api.php?action=query&list=blocks&bkusers=Alice|Bob'
265 public function getVersion() {
266 return __CLASS__ . ': $Id: ApiQueryBlocks.php 69579 2010-07-20 02:49:55Z tstarling $';