wikimedia /
mediawiki
| Conditions | 46 |
| Paths | > 20000 |
| Total Lines | 235 |
| Code Lines | 148 |
| Lines | 41 |
| Ratio | 17.45 % |
| Changes | 0 | ||
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | <?php |
||
| 81 | private function run( $resultPageSet = null ) { |
||
| 82 | $repo = $this->mRepo; |
||
| 83 | if ( !$repo instanceof LocalRepo ) { |
||
| 84 | $this->dieUsage( |
||
| 85 | 'Local file repository does not support querying all images', |
||
| 86 | 'unsupportedrepo' |
||
| 87 | ); |
||
| 88 | } |
||
| 89 | |||
| 90 | $prefix = $this->getModulePrefix(); |
||
| 91 | |||
| 92 | $db = $this->getDB(); |
||
| 93 | |||
| 94 | $params = $this->extractRequestParams(); |
||
| 95 | |||
| 96 | // Table and return fields |
||
| 97 | $this->addTables( 'image' ); |
||
| 98 | |||
| 99 | $prop = array_flip( $params['prop'] ); |
||
| 100 | $this->addFields( LocalFile::selectFields() ); |
||
| 101 | |||
| 102 | $ascendingOrder = true; |
||
| 103 | if ( $params['dir'] == 'descending' || $params['dir'] == 'older' ) { |
||
| 104 | $ascendingOrder = false; |
||
| 105 | } |
||
| 106 | |||
| 107 | if ( $params['sort'] == 'name' ) { |
||
| 108 | // Check mutually exclusive params |
||
| 109 | $disallowed = [ 'start', 'end', 'user' ]; |
||
| 110 | foreach ( $disallowed as $pname ) { |
||
| 111 | if ( isset( $params[$pname] ) ) { |
||
| 112 | $this->dieUsage( |
||
| 113 | "Parameter '{$prefix}{$pname}' can only be used with {$prefix}sort=timestamp", |
||
| 114 | 'badparams' |
||
| 115 | ); |
||
| 116 | } |
||
| 117 | } |
||
| 118 | if ( $params['filterbots'] != 'all' ) { |
||
| 119 | $this->dieUsage( |
||
| 120 | "Parameter '{$prefix}filterbots' can only be used with {$prefix}sort=timestamp", |
||
| 121 | 'badparams' |
||
| 122 | ); |
||
| 123 | } |
||
| 124 | |||
| 125 | // Pagination |
||
| 126 | View Code Duplication | if ( !is_null( $params['continue'] ) ) { |
|
| 127 | $cont = explode( '|', $params['continue'] ); |
||
| 128 | $this->dieContinueUsageIf( count( $cont ) != 1 ); |
||
| 129 | $op = ( $ascendingOrder ? '>' : '<' ); |
||
| 130 | $continueFrom = $db->addQuotes( $cont[0] ); |
||
| 131 | $this->addWhere( "img_name $op= $continueFrom" ); |
||
| 132 | } |
||
| 133 | |||
| 134 | // Image filters |
||
| 135 | $from = ( $params['from'] === null ? null : $this->titlePartToKey( $params['from'], NS_FILE ) ); |
||
| 136 | $to = ( $params['to'] === null ? null : $this->titlePartToKey( $params['to'], NS_FILE ) ); |
||
| 137 | $this->addWhereRange( 'img_name', ( $ascendingOrder ? 'newer' : 'older' ), $from, $to ); |
||
| 138 | |||
| 139 | View Code Duplication | if ( isset( $params['prefix'] ) ) { |
|
| 140 | $this->addWhere( 'img_name' . $db->buildLike( |
||
| 141 | $this->titlePartToKey( $params['prefix'], NS_FILE ), |
||
| 142 | $db->anyString() ) ); |
||
| 143 | } |
||
| 144 | } else { |
||
| 145 | // Check mutually exclusive params |
||
| 146 | $disallowed = [ 'from', 'to', 'prefix' ]; |
||
| 147 | foreach ( $disallowed as $pname ) { |
||
| 148 | if ( isset( $params[$pname] ) ) { |
||
| 149 | $this->dieUsage( |
||
| 150 | "Parameter '{$prefix}{$pname}' can only be used with {$prefix}sort=name", |
||
| 151 | 'badparams' |
||
| 152 | ); |
||
| 153 | } |
||
| 154 | } |
||
| 155 | if ( !is_null( $params['user'] ) && $params['filterbots'] != 'all' ) { |
||
| 156 | // Since filterbots checks if each user has the bot right, it |
||
| 157 | // doesn't make sense to use it with user |
||
| 158 | $this->dieUsage( |
||
| 159 | "Parameters '{$prefix}user' and '{$prefix}filterbots' cannot be used together", |
||
| 160 | 'badparams' |
||
| 161 | ); |
||
| 162 | } |
||
| 163 | |||
| 164 | // Pagination |
||
| 165 | $this->addTimestampWhereRange( |
||
| 166 | 'img_timestamp', |
||
| 167 | $ascendingOrder ? 'newer' : 'older', |
||
| 168 | $params['start'], |
||
| 169 | $params['end'] |
||
| 170 | ); |
||
| 171 | // Include in ORDER BY for uniqueness |
||
| 172 | $this->addWhereRange( 'img_name', $ascendingOrder ? 'newer' : 'older', null, null ); |
||
| 173 | |||
| 174 | if ( !is_null( $params['continue'] ) ) { |
||
| 175 | $cont = explode( '|', $params['continue'] ); |
||
| 176 | $this->dieContinueUsageIf( count( $cont ) != 2 ); |
||
| 177 | $op = ( $ascendingOrder ? '>' : '<' ); |
||
| 178 | $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) ); |
||
| 179 | $continueName = $db->addQuotes( $cont[1] ); |
||
| 180 | $this->addWhere( "img_timestamp $op $continueTimestamp OR " . |
||
| 181 | "(img_timestamp = $continueTimestamp AND " . |
||
| 182 | "img_name $op= $continueName)" |
||
| 183 | ); |
||
| 184 | } |
||
| 185 | |||
| 186 | // Image filters |
||
| 187 | if ( !is_null( $params['user'] ) ) { |
||
| 188 | $this->addWhereFld( 'img_user_text', $params['user'] ); |
||
| 189 | } |
||
| 190 | if ( $params['filterbots'] != 'all' ) { |
||
| 191 | $this->addTables( 'user_groups' ); |
||
| 192 | $this->addJoinConds( [ 'user_groups' => [ |
||
| 193 | 'LEFT JOIN', |
||
| 194 | [ |
||
| 195 | 'ug_group' => User::getGroupsWithPermission( 'bot' ), |
||
| 196 | 'ug_user = img_user' |
||
| 197 | ] |
||
| 198 | ] ] ); |
||
| 199 | $groupCond = ( $params['filterbots'] == 'nobots' ? 'NULL' : 'NOT NULL' ); |
||
| 200 | $this->addWhere( "ug_group IS $groupCond" ); |
||
| 201 | } |
||
| 202 | } |
||
| 203 | |||
| 204 | // Filters not depending on sort |
||
| 205 | if ( isset( $params['minsize'] ) ) { |
||
| 206 | $this->addWhere( 'img_size>=' . intval( $params['minsize'] ) ); |
||
| 207 | } |
||
| 208 | |||
| 209 | if ( isset( $params['maxsize'] ) ) { |
||
| 210 | $this->addWhere( 'img_size<=' . intval( $params['maxsize'] ) ); |
||
| 211 | } |
||
| 212 | |||
| 213 | $sha1 = false; |
||
| 214 | if ( isset( $params['sha1'] ) ) { |
||
| 215 | $sha1 = strtolower( $params['sha1'] ); |
||
| 216 | if ( !$this->validateSha1Hash( $sha1 ) ) { |
||
| 217 | $this->dieUsage( 'The SHA1 hash provided is not valid', 'invalidsha1hash' ); |
||
| 218 | } |
||
| 219 | $sha1 = Wikimedia\base_convert( $sha1, 16, 36, 31 ); |
||
| 220 | View Code Duplication | } elseif ( isset( $params['sha1base36'] ) ) { |
|
| 221 | $sha1 = strtolower( $params['sha1base36'] ); |
||
| 222 | if ( !$this->validateSha1Base36Hash( $sha1 ) ) { |
||
| 223 | $this->dieUsage( 'The SHA1Base36 hash provided is not valid', 'invalidsha1base36hash' ); |
||
| 224 | } |
||
| 225 | } |
||
| 226 | if ( $sha1 ) { |
||
|
|
|||
| 227 | $this->addWhereFld( 'img_sha1', $sha1 ); |
||
| 228 | } |
||
| 229 | |||
| 230 | if ( !is_null( $params['mime'] ) ) { |
||
| 231 | if ( $this->getConfig()->get( 'MiserMode' ) ) { |
||
| 232 | $this->dieUsage( 'MIME search disabled in Miser Mode', 'mimesearchdisabled' ); |
||
| 233 | } |
||
| 234 | |||
| 235 | $mimeConds = []; |
||
| 236 | foreach ( $params['mime'] as $mime ) { |
||
| 237 | list( $major, $minor ) = File::splitMime( $mime ); |
||
| 238 | $mimeConds[] = $db->makeList( |
||
| 239 | [ |
||
| 240 | 'img_major_mime' => $major, |
||
| 241 | 'img_minor_mime' => $minor, |
||
| 242 | ], |
||
| 243 | LIST_AND |
||
| 244 | ); |
||
| 245 | } |
||
| 246 | // safeguard against internal_api_error_DBQueryError |
||
| 247 | if ( count( $mimeConds ) > 0 ) { |
||
| 248 | $this->addWhere( $db->makeList( $mimeConds, LIST_OR ) ); |
||
| 249 | } else { |
||
| 250 | // no MIME types, no files |
||
| 251 | $this->getResult()->addValue( 'query', $this->getModuleName(), [] ); |
||
| 252 | return; |
||
| 253 | } |
||
| 254 | } |
||
| 255 | |||
| 256 | $limit = $params['limit']; |
||
| 257 | $this->addOption( 'LIMIT', $limit + 1 ); |
||
| 258 | $sortFlag = ''; |
||
| 259 | if ( !$ascendingOrder ) { |
||
| 260 | $sortFlag = ' DESC'; |
||
| 261 | } |
||
| 262 | if ( $params['sort'] == 'timestamp' ) { |
||
| 263 | $this->addOption( 'ORDER BY', 'img_timestamp' . $sortFlag ); |
||
| 264 | if ( !is_null( $params['user'] ) ) { |
||
| 265 | $this->addOption( 'USE INDEX', [ 'image' => 'img_usertext_timestamp' ] ); |
||
| 266 | } else { |
||
| 267 | $this->addOption( 'USE INDEX', [ 'image' => 'img_timestamp' ] ); |
||
| 268 | } |
||
| 269 | } else { |
||
| 270 | $this->addOption( 'ORDER BY', 'img_name' . $sortFlag ); |
||
| 271 | } |
||
| 272 | |||
| 273 | $res = $this->select( __METHOD__ ); |
||
| 274 | |||
| 275 | $titles = []; |
||
| 276 | $count = 0; |
||
| 277 | $result = $this->getResult(); |
||
| 278 | foreach ( $res as $row ) { |
||
| 279 | View Code Duplication | if ( ++$count > $limit ) { |
|
| 280 | // We've reached the one extra which shows that there are |
||
| 281 | // additional pages to be had. Stop here... |
||
| 282 | if ( $params['sort'] == 'name' ) { |
||
| 283 | $this->setContinueEnumParameter( 'continue', $row->img_name ); |
||
| 284 | } else { |
||
| 285 | $this->setContinueEnumParameter( 'continue', "$row->img_timestamp|$row->img_name" ); |
||
| 286 | } |
||
| 287 | break; |
||
| 288 | } |
||
| 289 | |||
| 290 | if ( is_null( $resultPageSet ) ) { |
||
| 291 | $file = $repo->newFileFromRow( $row ); |
||
| 292 | $info = array_merge( [ 'name' => $row->img_name ], |
||
| 293 | ApiQueryImageInfo::getInfo( $file, $prop, $result ) ); |
||
| 294 | self::addTitleInfo( $info, $file->getTitle() ); |
||
| 295 | |||
| 296 | $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $info ); |
||
| 297 | View Code Duplication | if ( !$fit ) { |
|
| 298 | if ( $params['sort'] == 'name' ) { |
||
| 299 | $this->setContinueEnumParameter( 'continue', $row->img_name ); |
||
| 300 | } else { |
||
| 301 | $this->setContinueEnumParameter( 'continue', "$row->img_timestamp|$row->img_name" ); |
||
| 302 | } |
||
| 303 | break; |
||
| 304 | } |
||
| 305 | } else { |
||
| 306 | $titles[] = Title::makeTitle( NS_FILE, $row->img_name ); |
||
| 307 | } |
||
| 308 | } |
||
| 309 | |||
| 310 | View Code Duplication | if ( is_null( $resultPageSet ) ) { |
|
| 311 | $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'img' ); |
||
| 312 | } else { |
||
| 313 | $resultPageSet->populateFromTitles( $titles ); |
||
| 314 | } |
||
| 315 | } |
||
| 316 | |||
| 416 |
Loading history...
In PHP, under loose comparison (like
==, or!=, orswitchconditions), values of different types might be equal.For
stringvalues, the empty string''is a special case, in particular the following results might be unexpected: