From 222b01f5169f1c7e69762e0e8904c24f78f71882 Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Wed, 28 Jul 2010 11:52:48 +0200 Subject: update to MediaWiki 1.16.0 --- includes/api/ApiQueryBlocks.php | 205 +++++++++++++++++++++------------------- 1 file changed, 110 insertions(+), 95 deletions(-) (limited to 'includes/api/ApiQueryBlocks.php') diff --git a/includes/api/ApiQueryBlocks.php b/includes/api/ApiQueryBlocks.php index 64790037..8b321044 100644 --- a/includes/api/ApiQueryBlocks.php +++ b/includes/api/ApiQueryBlocks.php @@ -23,9 +23,9 @@ * http://www.gnu.org/copyleft/gpl.html */ -if (!defined('MEDIAWIKI')) { +if ( !defined( 'MEDIAWIKI' ) ) { // Eclipse helper - will be ignored in production - require_once ('ApiQueryBase.php'); + require_once ( 'ApiQueryBase.php' ); } /** @@ -37,157 +37,163 @@ class ApiQueryBlocks extends ApiQueryBase { var $users; - public function __construct($query, $moduleName) { - parent :: __construct($query, $moduleName, 'bk'); + public function __construct( $query, $moduleName ) { + parent :: __construct( $query, $moduleName, 'bk' ); } public function execute() { global $wgUser; $params = $this->extractRequestParams(); - if(isset($params['users']) && isset($params['ip'])) - $this->dieUsage('bkusers and bkip cannot be used together', 'usersandip'); + if ( isset( $params['users'] ) && isset( $params['ip'] ) ) + $this->dieUsage( 'bkusers and bkip cannot be used together', 'usersandip' ); - $prop = array_flip($params['prop']); - $fld_id = isset($prop['id']); - $fld_user = isset($prop['user']); - $fld_by = isset($prop['by']); - $fld_timestamp = isset($prop['timestamp']); - $fld_expiry = isset($prop['expiry']); - $fld_reason = isset($prop['reason']); - $fld_range = isset($prop['range']); - $fld_flags = isset($prop['flags']); + $prop = array_flip( $params['prop'] ); + $fld_id = isset( $prop['id'] ); + $fld_user = isset( $prop['user'] ); + $fld_by = isset( $prop['by'] ); + $fld_timestamp = isset( $prop['timestamp'] ); + $fld_expiry = isset( $prop['expiry'] ); + $fld_reason = isset( $prop['reason'] ); + $fld_range = isset( $prop['range'] ); + $fld_flags = isset( $prop['flags'] ); $result = $this->getResult(); $pageSet = $this->getPageSet(); $titles = $pageSet->getTitles(); $data = array(); - $this->addTables('ipblocks'); - if($fld_id) - $this->addFields('ipb_id'); - if($fld_user) - $this->addFields(array('ipb_address', 'ipb_user', 'ipb_auto')); - if($fld_by) + $this->addTables( 'ipblocks' ); + $this->addFields( 'ipb_auto' ); + + if ( $fld_id ) + $this->addFields( 'ipb_id' ); + if ( $fld_user ) + $this->addFields( array( 'ipb_address', 'ipb_user' ) ); + if ( $fld_by ) { - $this->addTables('user'); - $this->addFields(array('ipb_by', 'user_name')); - $this->addWhere('user_id = ipb_by'); + $this->addTables( 'user' ); + $this->addFields( array( 'ipb_by', 'user_name' ) ); + $this->addWhere( 'user_id = ipb_by' ); } - if($fld_timestamp) - $this->addFields('ipb_timestamp'); - if($fld_expiry) - $this->addFields('ipb_expiry'); - if($fld_reason) - $this->addFields('ipb_reason'); - if($fld_range) - $this->addFields(array('ipb_range_start', 'ipb_range_end')); - if($fld_flags) - $this->addFields(array('ipb_auto', 'ipb_anon_only', 'ipb_create_account', 'ipb_enable_autoblock', 'ipb_block_email', 'ipb_deleted', 'ipb_allow_usertalk')); + if ( $fld_timestamp ) + $this->addFields( 'ipb_timestamp' ); + if ( $fld_expiry ) + $this->addFields( 'ipb_expiry' ); + if ( $fld_reason ) + $this->addFields( 'ipb_reason' ); + if ( $fld_range ) + $this->addFields( array( 'ipb_range_start', 'ipb_range_end' ) ); + if ( $fld_flags ) + $this->addFields( array( 'ipb_anon_only', 'ipb_create_account', 'ipb_enable_autoblock', 'ipb_block_email', 'ipb_deleted', 'ipb_allow_usertalk' ) ); - $this->addOption('LIMIT', $params['limit'] + 1); - $this->addWhereRange('ipb_timestamp', $params['dir'], $params['start'], $params['end']); - if(isset($params['ids'])) - $this->addWhereFld('ipb_id', $params['ids']); - if(isset($params['users'])) + $this->addOption( 'LIMIT', $params['limit'] + 1 ); + $this->addWhereRange( 'ipb_timestamp', $params['dir'], $params['start'], $params['end'] ); + if ( isset( $params['ids'] ) ) + $this->addWhereFld( 'ipb_id', $params['ids'] ); + if ( isset( $params['users'] ) ) { - foreach((array)$params['users'] as $u) - $this->prepareUsername($u); - $this->addWhereFld('ipb_address', $this->usernames); + foreach ( (array)$params['users'] as $u ) + $this->prepareUsername( $u ); + $this->addWhereFld( 'ipb_address', $this->usernames ); + $this->addWhereFld( 'ipb_auto', 0 ); } - if(isset($params['ip'])) + if ( isset( $params['ip'] ) ) { - list($ip, $range) = IP::parseCIDR($params['ip']); - if($ip && $range) + list( $ip, $range ) = IP::parseCIDR( $params['ip'] ); + if ( $ip && $range ) { - # We got a CIDR range - if($range < 16) - $this->dieUsage('CIDR ranges broader than /16 are not accepted', 'cidrtoobroad'); - $lower = wfBaseConvert($ip, 10, 16, 8, false); - $upper = wfBaseConvert($ip + pow(2, 32 - $range) - 1, 10, 16, 8, false); + // We got a CIDR range + if ( $range < 16 ) + $this->dieUsage( 'CIDR ranges broader than /16 are not accepted', 'cidrtoobroad' ); + $lower = wfBaseConvert( $ip, 10, 16, 8, false ); + $upper = wfBaseConvert( $ip + pow( 2, 32 - $range ) - 1, 10, 16, 8, false ); } else - $lower = $upper = IP::toHex($params['ip']); - $prefix = substr($lower, 0, 4); - $this->addWhere(array( - "ipb_range_start LIKE '$prefix%'", + $lower = $upper = IP::toHex( $params['ip'] ); + $prefix = substr( $lower, 0, 4 ); + + $db = $this->getDB(); + $this->addWhere( array( + 'ipb_range_start' . $db->buildLike( $prefix, $db->anyString() ), "ipb_range_start <= '$lower'", - "ipb_range_end >= '$upper'" - )); + "ipb_range_end >= '$upper'", + 'ipb_auto' => 0 + ) ); } - if(!$wgUser->isAllowed('hideuser')) - $this->addWhereFld('ipb_deleted', 0); + if ( !$wgUser->isAllowed( 'hideuser' ) ) + $this->addWhereFld( 'ipb_deleted', 0 ); // Purge expired entries on one in every 10 queries - if(!mt_rand(0, 10)) + if ( !mt_rand( 0, 10 ) ) Block::purgeExpired(); - $res = $this->select(__METHOD__); + $res = $this->select( __METHOD__ ); $count = 0; - while($row = $res->fetchObject()) + while ( $row = $res->fetchObject() ) { - if(++$count > $params['limit']) + if ( ++$count > $params['limit'] ) { // We've had enough - $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->ipb_timestamp)); + $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->ipb_timestamp ) ); break; } $block = array(); - if($fld_id) + if ( $fld_id ) $block['id'] = $row->ipb_id; - if($fld_user && !$row->ipb_auto) + if ( $fld_user && !$row->ipb_auto ) $block['user'] = $row->ipb_address; - if($fld_by) + if ( $fld_by ) $block['by'] = $row->user_name; - if($fld_timestamp) - $block['timestamp'] = wfTimestamp(TS_ISO_8601, $row->ipb_timestamp); - if($fld_expiry) - $block['expiry'] = Block::decodeExpiry($row->ipb_expiry, TS_ISO_8601); - if($fld_reason) + if ( $fld_timestamp ) + $block['timestamp'] = wfTimestamp( TS_ISO_8601, $row->ipb_timestamp ); + if ( $fld_expiry ) + $block['expiry'] = Block::decodeExpiry( $row->ipb_expiry, TS_ISO_8601 ); + if ( $fld_reason ) $block['reason'] = $row->ipb_reason; - if($fld_range) + if ( $fld_range && !$row->ipb_auto ) { - $block['rangestart'] = IP::hexToQuad($row->ipb_range_start); - $block['rangeend'] = IP::hexToQuad($row->ipb_range_end); + $block['rangestart'] = IP::hexToQuad( $row->ipb_range_start ); + $block['rangeend'] = IP::hexToQuad( $row->ipb_range_end ); } - if($fld_flags) + if ( $fld_flags ) { // For clarity, these flags use the same names as their action=block counterparts - if($row->ipb_auto) + if ( $row->ipb_auto ) $block['automatic'] = ''; - if($row->ipb_anon_only) + if ( $row->ipb_anon_only ) $block['anononly'] = ''; - if($row->ipb_create_account) + if ( $row->ipb_create_account ) $block['nocreate'] = ''; - if($row->ipb_enable_autoblock) + if ( $row->ipb_enable_autoblock ) $block['autoblock'] = ''; - if($row->ipb_block_email) + if ( $row->ipb_block_email ) $block['noemail'] = ''; - if($row->ipb_deleted) + if ( $row->ipb_deleted ) $block['hidden'] = ''; - if($row->ipb_allow_usertalk) + if ( $row->ipb_allow_usertalk ) $block['allowusertalk'] = ''; } - $fit = $result->addValue(array('query', $this->getModuleName()), null, $block); - if(!$fit) + $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $block ); + if ( !$fit ) { - $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->ipb_timestamp)); + $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->ipb_timestamp ) ); break; } } - $result->setIndexedTagName_internal(array('query', $this->getModuleName()), 'block'); + $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'block' ); } - protected function prepareUsername($user) + protected function prepareUsername( $user ) { - if(!$user) - $this->dieUsage('User parameter may not be empty', 'param_user'); - $name = User::isIP($user) + if ( !$user ) + $this->dieUsage( 'User parameter may not be empty', 'param_user' ); + $name = User::isIP( $user ) ? $user - : User::getCanonicalName($user, 'valid'); - if($name === false) - $this->dieUsage("User name {$user} is not valid", 'param_user'); + : User::getCanonicalName( $user, 'valid' ); + if ( $name === false ) + $this->dieUsage( "User name {$user} is not valid", 'param_user' ); $this->usernames[] = $name; } @@ -246,7 +252,7 @@ class ApiQueryBlocks extends ApiQueryBase { 'ids' => 'Pipe-separated list of block IDs to list (optional)', 'users' => 'Pipe-separated list of users to search for (optional)', 'ip' => array( 'Get all blocks applying to this IP or CIDR range, including range blocks.', - 'Cannot be used together with bkusers. CIDR ranges broader than /16 are not accepted.'), + 'Cannot be used together with bkusers. CIDR ranges broader than /16 are not accepted.' ), 'limit' => 'The maximum amount of blocks to list', 'prop' => 'Which properties to get', ); @@ -255,6 +261,15 @@ class ApiQueryBlocks extends ApiQueryBase { public function getDescription() { return 'List all blocked users and IP addresses.'; } + + public function getPossibleErrors() { + return array_merge( parent::getPossibleErrors(), array( + array( 'code' => 'usersandip', 'info' => 'bkusers and bkip cannot be used together' ), + array( 'code' => 'cidrtoobroad', 'info' => 'CIDR ranges broader than /16 are not accepted' ), + array( 'code' => 'param_user', 'info' => 'User parameter may not be empty' ), + array( 'code' => 'param_user', 'info' => 'User name user is not valid' ), + ) ); + } protected function getExamples() { return array ( 'api.php?action=query&list=blocks', @@ -263,6 +278,6 @@ class ApiQueryBlocks extends ApiQueryBase { } public function getVersion() { - return __CLASS__ . ': $Id: ApiQueryBlocks.php 69579 2010-07-20 02:49:55Z tstarling $'; + return __CLASS__ . ': $Id: ApiQueryBlocks.php 69578 2010-07-20 02:46:20Z tstarling $'; } } \ No newline at end of file -- cgit v1.2.3-54-g00ecf