wikimedia /
mediawiki
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like ApiQueryBlocks often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use ApiQueryBlocks, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 32 | class ApiQueryBlocks extends ApiQueryBase { |
||
| 33 | |||
| 34 | public function __construct( ApiQuery $query, $moduleName ) { |
||
| 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", |
||
| 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 ) ); |
||
| 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 ) { |
||
| 250 | |||
| 251 | public function getAllowedParams() { |
||
| 326 | |||
| 327 | protected function getExamplesMessages() { |
||
| 335 | |||
| 336 | public function getHelpUrls() { |
||
| 339 | } |
||
| 340 |
Loading history...
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:
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:
Define a default value for the variable:
Add a value for the missing path: