ApiQueryBlocks::__construct() - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

ApiQueryBlocks::__construct() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: ApiQueryBlocks

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	2
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
/**
 *
 *
 * Created on Sep 10, 2007
 *
 * Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 */

/**
 * Query module to enumerate all user blocks
 *
 * @ingroup API
 */
class ApiQueryBlocks extends ApiQueryBase {

	public function __construct( ApiQuery $query, $moduleName ) {
		parent::__construct( $query, $moduleName, 'bk' );
	}

	public function execute() {
		global $wgContLang;

		$db = $this->getDB();
		$params = $this->extractRequestParams();
		$this->requireMaxOneParameter( $params, 'users', 'ip' );

		$prop = array_flip( $params['prop'] );
		$fld_id = isset( $prop['id'] );
		$fld_user = isset( $prop['user'] );
		$fld_userid = isset( $prop['userid'] );
		$fld_by = isset( $prop['by'] );
		$fld_byid = isset( $prop['byid'] );
		$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();

		$this->addTables( 'ipblocks' );
		$this->addFields( [ 'ipb_auto', 'ipb_id', 'ipb_timestamp' ] );

		$this->addFieldsIf( [ 'ipb_address', 'ipb_user' ], $fld_user || $fld_userid );
		$this->addFieldsIf( 'ipb_by_text', $fld_by );
		$this->addFieldsIf( 'ipb_by', $fld_byid );
		$this->addFieldsIf( 'ipb_expiry', $fld_expiry );
		$this->addFieldsIf( 'ipb_reason', $fld_reason );
		$this->addFieldsIf( [ 'ipb_range_start', 'ipb_range_end' ], $fld_range );
		$this->addFieldsIf( [ 'ipb_anon_only', 'ipb_create_account', 'ipb_enable_autoblock',
			'ipb_block_email', 'ipb_deleted', 'ipb_allow_usertalk' ],
			$fld_flags );

		$this->addOption( 'LIMIT', $params['limit'] + 1 );
		$this->addTimestampWhereRange(
			'ipb_timestamp',
			$params['dir'],
			$params['start'],
			$params['end']
		);
		// Include in ORDER BY for uniqueness
		$this->addWhereRange( 'ipb_id', $params['dir'], null, null );

		if ( !is_null( $params['continue'] ) ) {
			$cont = explode( '|', $params['continue'] );
			$this->dieContinueUsageIf( count( $cont ) != 2 );
			$op = ( $params['dir'] == 'newer' ? '>' : '<' );
			$continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
			$continueId = (int)$cont[1];
			$this->dieContinueUsageIf( $continueId != $cont[1] );
			$this->addWhere( "ipb_timestamp $op $continueTimestamp OR " .
				"(ipb_timestamp = $continueTimestamp AND " .
				"ipb_id $op= $continueId)"
			);
		}

		if ( isset( $params['ids'] ) ) {
			$this->addWhereFld( 'ipb_id', $params['ids'] );
		}
		if ( isset( $params['users'] ) ) {
			$usernames = [];
			foreach ( (array)$params['users'] as $u ) {
				$usernames[] = $this->prepareUsername( $u );
			}
			$this->addWhereFld( 'ipb_address', $usernames );
			$this->addWhereFld( 'ipb_auto', 0 );
		}
		if ( isset( $params['ip'] ) ) {
			$blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
			if ( IP::isIPv4( $params['ip'] ) ) {
				$type = 'IPv4';
				$cidrLimit = $blockCIDRLimit['IPv4'];
				$prefixLen = 0;
			} elseif ( IP::isIPv6( $params['ip'] ) ) {
				$type = 'IPv6';
				$cidrLimit = $blockCIDRLimit['IPv6'];
				$prefixLen = 3; // IP::toHex output is prefixed with "v6-"
			} else {
				$this->dieUsage( 'IP parameter is not valid', 'param_ip' );
			}

			# Check range validity, if it's a CIDR
			list( $ip, $range ) = IP::parseCIDR( $params['ip'] );
			if ( $ip !== false && $range !== false && $range < $cidrLimit ) {
				$this->dieUsage(
					"$type CIDR ranges broader than /$cidrLimit are not accepted",
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
					'cidrtoobroad'
				);
			}

			# Let IP::parseRange handle calculating $upper, instead of duplicating the logic here.
			list( $lower, $upper ) = IP::parseRange( $params['ip'] );

			# Extract the common prefix to any rangeblock affecting this IP/CIDR
			$prefix = substr( $lower, 0, $prefixLen + floor( $cidrLimit / 4 ) );
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

			# Fairly hard to make a malicious SQL statement out of hex characters,
			# but it is good practice to add quotes
			$lower = $db->addQuotes( $lower );
			$upper = $db->addQuotes( $upper );

			$this->addWhere( [
				'ipb_range_start' . $db->buildLike( $prefix, $db->anyString() ),
				'ipb_range_start <= ' . $lower,
				'ipb_range_end >= ' . $upper,
				'ipb_auto' => 0
			] );
		}

		if ( !is_null( $params['show'] ) ) {
			$show = array_flip( $params['show'] );

			/* Check for conflicting parameters. */
			if ( ( isset( $show['account'] ) && isset( $show['!account'] ) )
				|| ( isset( $show['ip'] ) && isset( $show['!ip'] ) )
				|| ( isset( $show['range'] ) && isset( $show['!range'] ) )
				|| ( isset( $show['temp'] ) && isset( $show['!temp'] ) )
			) {
				$this->dieUsageMsg( 'show' );
			}

			$this->addWhereIf( 'ipb_user = 0', isset( $show['!account'] ) );
			$this->addWhereIf( 'ipb_user != 0', isset( $show['account'] ) );
			$this->addWhereIf( 'ipb_user != 0 OR ipb_range_end > ipb_range_start', isset( $show['!ip'] ) );
			$this->addWhereIf( 'ipb_user = 0 AND ipb_range_end = ipb_range_start', isset( $show['ip'] ) );
			$this->addWhereIf( 'ipb_expiry = ' .
				$db->addQuotes( $db->getInfinity() ), isset( $show['!temp'] ) );
			$this->addWhereIf( 'ipb_expiry != ' .
				$db->addQuotes( $db->getInfinity() ), isset( $show['temp'] ) );
			$this->addWhereIf( 'ipb_range_end = ipb_range_start', isset( $show['!range'] ) );
			$this->addWhereIf( 'ipb_range_end > ipb_range_start', isset( $show['range'] ) );
		}

		if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
			$this->addWhereFld( 'ipb_deleted', 0 );
		}

		# Filter out expired rows
		$this->addWhere( 'ipb_expiry > ' . $db->addQuotes( $db->timestamp() ) );

		$res = $this->select( __METHOD__ );

		$count = 0;
		foreach ( $res as $row ) {
			if ( ++$count > $params['limit'] ) {
				// We've had enough
				$this->setContinueEnumParameter( 'continue', "$row->ipb_timestamp|$row->ipb_id" );
				break;
			}
			$block = [
				ApiResult::META_TYPE => 'assoc',
			];
			if ( $fld_id ) {
				$block['id'] = (int)$row->ipb_id;
			}
			if ( $fld_user && !$row->ipb_auto ) {
				$block['user'] = $row->ipb_address;
			}
			if ( $fld_userid && !$row->ipb_auto ) {
				$block['userid'] = (int)$row->ipb_user;
			}
			if ( $fld_by ) {
				$block['by'] = $row->ipb_by_text;
			}
			if ( $fld_byid ) {
				$block['byid'] = (int)$row->ipb_by;
			}
			if ( $fld_timestamp ) {
				$block['timestamp'] = wfTimestamp( TS_ISO_8601, $row->ipb_timestamp );
			}
			if ( $fld_expiry ) {
				$block['expiry'] = $wgContLang->formatExpiry( $row->ipb_expiry, TS_ISO_8601 );
			}
			if ( $fld_reason ) {
				$block['reason'] = $row->ipb_reason;
			}
			if ( $fld_range && !$row->ipb_auto ) {
				$block['rangestart'] = IP::formatHex( $row->ipb_range_start );
				$block['rangeend'] = IP::formatHex( $row->ipb_range_end );
			}
			if ( $fld_flags ) {
				// For clarity, these flags use the same names as their action=block counterparts
				$block['automatic'] = (bool)$row->ipb_auto;
				$block['anononly'] = (bool)$row->ipb_anon_only;
				$block['nocreate'] = (bool)$row->ipb_create_account;
				$block['autoblock'] = (bool)$row->ipb_enable_autoblock;
				$block['noemail'] = (bool)$row->ipb_block_email;
				$block['hidden'] = (bool)$row->ipb_deleted;
				$block['allowusertalk'] = (bool)$row->ipb_allow_usertalk;
			}
			$fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $block );
			if ( !$fit ) {
				$this->setContinueEnumParameter( 'continue', "$row->ipb_timestamp|$row->ipb_id" );
				break;
			}
		}
		$result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'block' );
	}

	protected function prepareUsername( $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' );
		}
		return $name;
	}

	public function getAllowedParams() {
		$blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );

		return [
			'start' => [
				ApiBase::PARAM_TYPE => 'timestamp'
			],
			'end' => [
				ApiBase::PARAM_TYPE => 'timestamp',
			],
			'dir' => [
				ApiBase::PARAM_TYPE => [
					'newer',
					'older'
				],
				ApiBase::PARAM_DFLT => 'older',
				ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
			],
			'ids' => [
				ApiBase::PARAM_TYPE => 'integer',
				ApiBase::PARAM_ISMULTI => true
			],
			'users' => [
				ApiBase::PARAM_TYPE => 'user',
				ApiBase::PARAM_ISMULTI => true
			],
			'ip' => [
				ApiBase::PARAM_HELP_MSG => [
					'apihelp-query+blocks-param-ip',
					$blockCIDRLimit['IPv4'],
					$blockCIDRLimit['IPv6'],
				],
			],
			'limit' => [
				ApiBase::PARAM_DFLT => 10,
				ApiBase::PARAM_TYPE => 'limit',
				ApiBase::PARAM_MIN => 1,
				ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
				ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
			],
			'prop' => [
				ApiBase::PARAM_DFLT => 'id|user|by|timestamp|expiry|reason|flags',
				ApiBase::PARAM_TYPE => [
					'id',
					'user',
					'userid',
					'by',
					'byid',
					'timestamp',
					'expiry',
					'reason',
					'range',
					'flags'
				],
				ApiBase::PARAM_ISMULTI => true,
				ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
			],
			'show' => [
				ApiBase::PARAM_TYPE => [
					'account',
					'!account',
					'temp',
					'!temp',
					'ip',
					'!ip',
					'range',
					'!range',
				],
				ApiBase::PARAM_ISMULTI => true
			],
			'continue' => [
				ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
			],
		];
	}

	protected function getExamplesMessages() {
		return [
			'action=query&list=blocks'
				=> 'apihelp-query+blocks-example-simple',
			'action=query&list=blocks&bkusers=Alice|Bob'
				=> 'apihelp-query+blocks-example-users',
		];
	}

	public function getHelpUrls() {
		return 'https://www.mediawiki.org/wiki/API:Blocks';
	}
}


ApiQueryBlocks::__construct() A
last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

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

wikimedia / mediawiki

ApiQueryBlocks::__construct() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

ApiQueryBlocks::__construct() A
last analyzed 2016-11-13 17:42 UTC