|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* |
|
4
|
|
|
* |
|
5
|
|
|
* Created on December 12, 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 categories, even the ones that don't have |
|
29
|
|
|
* category pages. |
|
30
|
|
|
* |
|
31
|
|
|
* @ingroup API |
|
32
|
|
|
*/ |
|
33
|
|
|
class ApiQueryAllCategories extends ApiQueryGeneratorBase { |
|
34
|
|
|
|
|
35
|
|
|
public function __construct( ApiQuery $query, $moduleName ) { |
|
36
|
|
|
parent::__construct( $query, $moduleName, 'ac' ); |
|
37
|
|
|
} |
|
38
|
|
|
|
|
39
|
|
|
public function execute() { |
|
40
|
|
|
$this->run(); |
|
41
|
|
|
} |
|
42
|
|
|
|
|
43
|
|
|
public function getCacheMode( $params ) { |
|
44
|
|
|
return 'public'; |
|
45
|
|
|
} |
|
46
|
|
|
|
|
47
|
|
|
public function executeGenerator( $resultPageSet ) { |
|
48
|
|
|
$this->run( $resultPageSet ); |
|
49
|
|
|
} |
|
50
|
|
|
|
|
51
|
|
|
/** |
|
52
|
|
|
* @param ApiPageSet $resultPageSet |
|
53
|
|
|
*/ |
|
54
|
|
|
private function run( $resultPageSet = null ) { |
|
55
|
|
|
$db = $this->getDB(); |
|
56
|
|
|
$params = $this->extractRequestParams(); |
|
57
|
|
|
|
|
58
|
|
|
$this->addTables( 'category' ); |
|
59
|
|
|
$this->addFields( 'cat_title' ); |
|
60
|
|
|
|
|
61
|
|
View Code Duplication |
if ( !is_null( $params['continue'] ) ) { |
|
62
|
|
|
$cont = explode( '|', $params['continue'] ); |
|
63
|
|
|
$this->dieContinueUsageIf( count( $cont ) != 1 ); |
|
64
|
|
|
$op = $params['dir'] == 'descending' ? '<' : '>'; |
|
65
|
|
|
$cont_from = $db->addQuotes( $cont[0] ); |
|
66
|
|
|
$this->addWhere( "cat_title $op= $cont_from" ); |
|
67
|
|
|
} |
|
68
|
|
|
|
|
69
|
|
|
$dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' ); |
|
70
|
|
|
$from = ( $params['from'] === null |
|
71
|
|
|
? null |
|
72
|
|
|
: $this->titlePartToKey( $params['from'], NS_CATEGORY ) ); |
|
73
|
|
|
$to = ( $params['to'] === null |
|
74
|
|
|
? null |
|
75
|
|
|
: $this->titlePartToKey( $params['to'], NS_CATEGORY ) ); |
|
76
|
|
|
$this->addWhereRange( 'cat_title', $dir, $from, $to ); |
|
77
|
|
|
|
|
78
|
|
|
$min = $params['min']; |
|
79
|
|
|
$max = $params['max']; |
|
80
|
|
|
if ( $dir == 'newer' ) { |
|
81
|
|
|
$this->addWhereRange( 'cat_pages', 'newer', $min, $max ); |
|
82
|
|
|
} else { |
|
83
|
|
|
$this->addWhereRange( 'cat_pages', 'older', $max, $min ); |
|
84
|
|
|
} |
|
85
|
|
|
|
|
86
|
|
View Code Duplication |
if ( isset( $params['prefix'] ) ) { |
|
87
|
|
|
$this->addWhere( 'cat_title' . $db->buildLike( |
|
88
|
|
|
$this->titlePartToKey( $params['prefix'], NS_CATEGORY ), |
|
89
|
|
|
$db->anyString() ) ); |
|
90
|
|
|
} |
|
91
|
|
|
|
|
92
|
|
|
$this->addOption( 'LIMIT', $params['limit'] + 1 ); |
|
93
|
|
|
$sort = ( $params['dir'] == 'descending' ? ' DESC' : '' ); |
|
94
|
|
|
$this->addOption( 'ORDER BY', 'cat_title' . $sort ); |
|
95
|
|
|
|
|
96
|
|
|
$prop = array_flip( $params['prop'] ); |
|
97
|
|
|
$this->addFieldsIf( [ 'cat_pages', 'cat_subcats', 'cat_files' ], isset( $prop['size'] ) ); |
|
98
|
|
|
if ( isset( $prop['hidden'] ) ) { |
|
99
|
|
|
$this->addTables( [ 'page', 'page_props' ] ); |
|
100
|
|
|
$this->addJoinConds( [ |
|
101
|
|
|
'page' => [ 'LEFT JOIN', [ |
|
102
|
|
|
'page_namespace' => NS_CATEGORY, |
|
103
|
|
|
'page_title=cat_title' ] ], |
|
104
|
|
|
'page_props' => [ 'LEFT JOIN', [ |
|
105
|
|
|
'pp_page=page_id', |
|
106
|
|
|
'pp_propname' => 'hiddencat' ] ], |
|
107
|
|
|
] ); |
|
108
|
|
|
$this->addFields( [ 'cat_hidden' => 'pp_propname' ] ); |
|
109
|
|
|
} |
|
110
|
|
|
|
|
111
|
|
|
$res = $this->select( __METHOD__ ); |
|
112
|
|
|
|
|
113
|
|
|
$pages = []; |
|
114
|
|
|
|
|
115
|
|
|
$result = $this->getResult(); |
|
116
|
|
|
$count = 0; |
|
117
|
|
|
foreach ( $res as $row ) { |
|
118
|
|
|
if ( ++$count > $params['limit'] ) { |
|
119
|
|
|
// We've reached the one extra which shows that there are |
|
120
|
|
|
// additional cats to be had. Stop here... |
|
121
|
|
|
$this->setContinueEnumParameter( 'continue', $row->cat_title ); |
|
122
|
|
|
break; |
|
123
|
|
|
} |
|
124
|
|
|
|
|
125
|
|
|
// Normalize titles |
|
126
|
|
|
$titleObj = Title::makeTitle( NS_CATEGORY, $row->cat_title ); |
|
127
|
|
|
if ( !is_null( $resultPageSet ) ) { |
|
128
|
|
|
$pages[] = $titleObj; |
|
129
|
|
|
} else { |
|
130
|
|
|
$item = []; |
|
131
|
|
|
ApiResult::setContentValue( $item, 'category', $titleObj->getText() ); |
|
132
|
|
|
if ( isset( $prop['size'] ) ) { |
|
133
|
|
|
$item['size'] = intval( $row->cat_pages ); |
|
134
|
|
|
$item['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files; |
|
135
|
|
|
$item['files'] = intval( $row->cat_files ); |
|
136
|
|
|
$item['subcats'] = intval( $row->cat_subcats ); |
|
137
|
|
|
} |
|
138
|
|
|
if ( isset( $prop['hidden'] ) ) { |
|
139
|
|
|
$item['hidden'] = (bool)$row->cat_hidden; |
|
140
|
|
|
} |
|
141
|
|
|
$fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $item ); |
|
142
|
|
|
if ( !$fit ) { |
|
143
|
|
|
$this->setContinueEnumParameter( 'continue', $row->cat_title ); |
|
144
|
|
|
break; |
|
145
|
|
|
} |
|
146
|
|
|
} |
|
147
|
|
|
} |
|
148
|
|
|
|
|
149
|
|
|
if ( is_null( $resultPageSet ) ) { |
|
150
|
|
|
$result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'c' ); |
|
151
|
|
|
} else { |
|
152
|
|
|
$resultPageSet->populateFromTitles( $pages ); |
|
153
|
|
|
} |
|
154
|
|
|
} |
|
155
|
|
|
|
|
156
|
|
|
public function getAllowedParams() { |
|
157
|
|
|
return [ |
|
158
|
|
|
'from' => null, |
|
159
|
|
|
'continue' => [ |
|
160
|
|
|
ApiBase::PARAM_HELP_MSG => 'api-help-param-continue', |
|
161
|
|
|
], |
|
162
|
|
|
'to' => null, |
|
163
|
|
|
'prefix' => null, |
|
164
|
|
|
'dir' => [ |
|
165
|
|
|
ApiBase::PARAM_DFLT => 'ascending', |
|
166
|
|
|
ApiBase::PARAM_TYPE => [ |
|
167
|
|
|
'ascending', |
|
168
|
|
|
'descending' |
|
169
|
|
|
], |
|
170
|
|
|
], |
|
171
|
|
|
'min' => [ |
|
172
|
|
|
ApiBase::PARAM_TYPE => 'integer' |
|
173
|
|
|
], |
|
174
|
|
|
'max' => [ |
|
175
|
|
|
ApiBase::PARAM_TYPE => 'integer' |
|
176
|
|
|
], |
|
177
|
|
|
'limit' => [ |
|
178
|
|
|
ApiBase::PARAM_DFLT => 10, |
|
179
|
|
|
ApiBase::PARAM_TYPE => 'limit', |
|
180
|
|
|
ApiBase::PARAM_MIN => 1, |
|
181
|
|
|
ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1, |
|
182
|
|
|
ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2 |
|
183
|
|
|
], |
|
184
|
|
|
'prop' => [ |
|
185
|
|
|
ApiBase::PARAM_TYPE => [ 'size', 'hidden' ], |
|
186
|
|
|
ApiBase::PARAM_DFLT => '', |
|
187
|
|
|
ApiBase::PARAM_ISMULTI => true, |
|
188
|
|
|
ApiBase::PARAM_HELP_MSG_PER_VALUE => [], |
|
189
|
|
|
], |
|
190
|
|
|
]; |
|
191
|
|
|
} |
|
192
|
|
|
|
|
193
|
|
|
protected function getExamplesMessages() { |
|
194
|
|
|
return [ |
|
195
|
|
|
'action=query&list=allcategories&acprop=size' |
|
196
|
|
|
=> 'apihelp-query+allcategories-example-size', |
|
197
|
|
|
'action=query&generator=allcategories&gacprefix=List&prop=info' |
|
198
|
|
|
=> 'apihelp-query+allcategories-example-generator', |
|
199
|
|
|
]; |
|
200
|
|
|
} |
|
201
|
|
|
|
|
202
|
|
|
public function getHelpUrls() { |
|
203
|
|
|
return 'https://www.mediawiki.org/wiki/API:Allcategories'; |
|
204
|
|
|
} |
|
205
|
|
|
} |
|
206
|
|
|
|
wikimedia /
mediawiki
