Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 117 |
|
0.00% |
0 / 8 |
CRAP | |
0.00% |
0 / 1 |
| ApiQueryAllCategories | |
0.00% |
0 / 117 |
|
0.00% |
0 / 8 |
600 | |
0.00% |
0 / 1 |
| __construct | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| execute | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getCacheMode | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| executeGenerator | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| run | |
0.00% |
0 / 72 |
|
0.00% |
0 / 1 |
306 | |||
| getAllowedParams | |
0.00% |
0 / 34 |
|
0.00% |
0 / 1 |
2 | |||
| getExamplesMessages | |
0.00% |
0 / 6 |
|
0.00% |
0 / 1 |
2 | |||
| getHelpUrls | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| 1 | <?php |
| 2 | /** |
| 3 | * Copyright © 2007 Roan Kattouw <roan.kattouw@gmail.com> |
| 4 | * |
| 5 | * This program is free software; you can redistribute it and/or modify |
| 6 | * it under the terms of the GNU General Public License as published by |
| 7 | * the Free Software Foundation; either version 2 of the License, or |
| 8 | * (at your option) any later version. |
| 9 | * |
| 10 | * This program is distributed in the hope that it will be useful, |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | * GNU General Public License for more details. |
| 14 | * |
| 15 | * You should have received a copy of the GNU General Public License along |
| 16 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 17 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 18 | * http://www.gnu.org/copyleft/gpl.html |
| 19 | * |
| 20 | * @file |
| 21 | */ |
| 22 | |
| 23 | use MediaWiki\Title\Title; |
| 24 | use Wikimedia\ParamValidator\ParamValidator; |
| 25 | use Wikimedia\ParamValidator\TypeDef\IntegerDef; |
| 26 | use Wikimedia\Rdbms\IExpression; |
| 27 | use Wikimedia\Rdbms\LikeValue; |
| 28 | |
| 29 | /** |
| 30 | * Query module to enumerate all categories, even the ones that don't have |
| 31 | * category pages. |
| 32 | * |
| 33 | * @ingroup API |
| 34 | */ |
| 35 | class ApiQueryAllCategories extends ApiQueryGeneratorBase { |
| 36 | |
| 37 | /** |
| 38 | * @param ApiQuery $query |
| 39 | * @param string $moduleName |
| 40 | */ |
| 41 | public function __construct( ApiQuery $query, $moduleName ) { |
| 42 | parent::__construct( $query, $moduleName, 'ac' ); |
| 43 | } |
| 44 | |
| 45 | public function execute() { |
| 46 | $this->run(); |
| 47 | } |
| 48 | |
| 49 | public function getCacheMode( $params ) { |
| 50 | return 'public'; |
| 51 | } |
| 52 | |
| 53 | public function executeGenerator( $resultPageSet ) { |
| 54 | $this->run( $resultPageSet ); |
| 55 | } |
| 56 | |
| 57 | /** |
| 58 | * @param ApiPageSet|null $resultPageSet |
| 59 | */ |
| 60 | private function run( $resultPageSet = null ) { |
| 61 | $db = $this->getDB(); |
| 62 | $params = $this->extractRequestParams(); |
| 63 | |
| 64 | $this->addTables( 'category' ); |
| 65 | $this->addFields( 'cat_title' ); |
| 66 | |
| 67 | if ( $params['continue'] !== null ) { |
| 68 | $cont = $this->parseContinueParamOrDie( $params['continue'], [ 'string' ] ); |
| 69 | $op = $params['dir'] == 'descending' ? '<=' : '>='; |
| 70 | $this->addWhere( $db->expr( 'cat_title', $op, $cont[0] ) ); |
| 71 | } |
| 72 | |
| 73 | $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' ); |
| 74 | $from = ( $params['from'] === null |
| 75 | ? null |
| 76 | : $this->titlePartToKey( $params['from'], NS_CATEGORY ) ); |
| 77 | $to = ( $params['to'] === null |
| 78 | ? null |
| 79 | : $this->titlePartToKey( $params['to'], NS_CATEGORY ) ); |
| 80 | $this->addWhereRange( 'cat_title', $dir, $from, $to ); |
| 81 | |
| 82 | $min = $params['min']; |
| 83 | $max = $params['max']; |
| 84 | if ( $dir == 'newer' ) { |
| 85 | $this->addWhereRange( 'cat_pages', 'newer', $min, $max ); |
| 86 | } else { |
| 87 | $this->addWhereRange( 'cat_pages', 'older', $max, $min ); |
| 88 | } |
| 89 | |
| 90 | if ( isset( $params['prefix'] ) ) { |
| 91 | $this->addWhere( |
| 92 | $db->expr( |
| 93 | 'cat_title', |
| 94 | IExpression::LIKE, |
| 95 | new LikeValue( $this->titlePartToKey( $params['prefix'], NS_CATEGORY ), $db->anyString() ) |
| 96 | ) |
| 97 | ); |
| 98 | } |
| 99 | |
| 100 | $this->addOption( 'LIMIT', $params['limit'] + 1 ); |
| 101 | $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' ); |
| 102 | $this->addOption( 'ORDER BY', 'cat_title' . $sort ); |
| 103 | |
| 104 | $prop = array_fill_keys( $params['prop'], true ); |
| 105 | $this->addFieldsIf( [ 'cat_pages', 'cat_subcats', 'cat_files' ], isset( $prop['size'] ) ); |
| 106 | if ( isset( $prop['hidden'] ) ) { |
| 107 | $this->addTables( [ 'page', 'page_props' ] ); |
| 108 | $this->addJoinConds( [ |
| 109 | 'page' => [ 'LEFT JOIN', [ |
| 110 | 'page_namespace' => NS_CATEGORY, |
| 111 | 'page_title=cat_title' ] ], |
| 112 | 'page_props' => [ 'LEFT JOIN', [ |
| 113 | 'pp_page=page_id', |
| 114 | 'pp_propname' => 'hiddencat' ] ], |
| 115 | ] ); |
| 116 | $this->addFields( [ 'cat_hidden' => 'pp_propname' ] ); |
| 117 | } |
| 118 | |
| 119 | $res = $this->select( __METHOD__ ); |
| 120 | |
| 121 | $pages = []; |
| 122 | |
| 123 | $result = $this->getResult(); |
| 124 | $count = 0; |
| 125 | foreach ( $res as $row ) { |
| 126 | if ( ++$count > $params['limit'] ) { |
| 127 | // We've reached the one extra which shows that there are |
| 128 | // additional cats to be had. Stop here... |
| 129 | $this->setContinueEnumParameter( 'continue', $row->cat_title ); |
| 130 | break; |
| 131 | } |
| 132 | |
| 133 | // Normalize titles |
| 134 | $titleObj = Title::makeTitle( NS_CATEGORY, $row->cat_title ); |
| 135 | if ( $resultPageSet !== null ) { |
| 136 | $pages[] = $titleObj; |
| 137 | } else { |
| 138 | $item = []; |
| 139 | ApiResult::setContentValue( $item, 'category', $titleObj->getText() ); |
| 140 | if ( isset( $prop['size'] ) ) { |
| 141 | $item['size'] = (int)$row->cat_pages; |
| 142 | $item['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files; |
| 143 | $item['files'] = (int)$row->cat_files; |
| 144 | $item['subcats'] = (int)$row->cat_subcats; |
| 145 | } |
| 146 | if ( isset( $prop['hidden'] ) ) { |
| 147 | $item['hidden'] = (bool)$row->cat_hidden; |
| 148 | } |
| 149 | $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $item ); |
| 150 | if ( !$fit ) { |
| 151 | $this->setContinueEnumParameter( 'continue', $row->cat_title ); |
| 152 | break; |
| 153 | } |
| 154 | } |
| 155 | } |
| 156 | |
| 157 | if ( $resultPageSet === null ) { |
| 158 | $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'c' ); |
| 159 | } else { |
| 160 | $resultPageSet->populateFromTitles( $pages ); |
| 161 | } |
| 162 | } |
| 163 | |
| 164 | public function getAllowedParams() { |
| 165 | return [ |
| 166 | 'from' => null, |
| 167 | 'continue' => [ |
| 168 | ApiBase::PARAM_HELP_MSG => 'api-help-param-continue', |
| 169 | ], |
| 170 | 'to' => null, |
| 171 | 'prefix' => null, |
| 172 | 'dir' => [ |
| 173 | ParamValidator::PARAM_DEFAULT => 'ascending', |
| 174 | ParamValidator::PARAM_TYPE => [ |
| 175 | 'ascending', |
| 176 | 'descending' |
| 177 | ], |
| 178 | ], |
| 179 | 'min' => [ |
| 180 | ParamValidator::PARAM_TYPE => 'integer' |
| 181 | ], |
| 182 | 'max' => [ |
| 183 | ParamValidator::PARAM_TYPE => 'integer' |
| 184 | ], |
| 185 | 'limit' => [ |
| 186 | ParamValidator::PARAM_DEFAULT => 10, |
| 187 | ParamValidator::PARAM_TYPE => 'limit', |
| 188 | IntegerDef::PARAM_MIN => 1, |
| 189 | IntegerDef::PARAM_MAX => ApiBase::LIMIT_BIG1, |
| 190 | IntegerDef::PARAM_MAX2 => ApiBase::LIMIT_BIG2 |
| 191 | ], |
| 192 | 'prop' => [ |
| 193 | ParamValidator::PARAM_TYPE => [ 'size', 'hidden' ], |
| 194 | ParamValidator::PARAM_DEFAULT => '', |
| 195 | ParamValidator::PARAM_ISMULTI => true, |
| 196 | ApiBase::PARAM_HELP_MSG_PER_VALUE => [], |
| 197 | ], |
| 198 | ]; |
| 199 | } |
| 200 | |
| 201 | protected function getExamplesMessages() { |
| 202 | return [ |
| 203 | 'action=query&list=allcategories&acprop=size' |
| 204 | => 'apihelp-query+allcategories-example-size', |
| 205 | 'action=query&generator=allcategories&gacprefix=List&prop=info' |
| 206 | => 'apihelp-query+allcategories-example-generator', |
| 207 | ]; |
| 208 | } |
| 209 | |
| 210 | public function getHelpUrls() { |
| 211 | return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allcategories'; |
| 212 | } |
| 213 | } |