5 * Created on December 12, 2007
7 * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@gmail.com
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.
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.
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
28 * Query module to enumerate all categories, even the ones that don't have
33 class ApiQueryAllCategories
extends ApiQueryGeneratorBase
{
35 public function __construct( $query, $moduleName ) {
36 parent
::__construct( $query, $moduleName, 'ac' );
39 public function execute() {
43 public function getCacheMode( $params ) {
47 public function executeGenerator( $resultPageSet ) {
48 $this->run( $resultPageSet );
52 * @param $resultPageSet ApiPageSet
54 private function run( $resultPageSet = null ) {
56 $params = $this->extractRequestParams();
58 $this->addTables( 'category' );
59 $this->addFields( 'cat_title' );
60 $this->addWhere( 'cat_pages > 0' );
62 $dir = ( $params['dir'] == 'descending' ?
'older' : 'newer' );
63 $from = ( is_null( $params['from'] ) ?
null : $this->titlePartToKey( $params['from'] ) );
64 $to = ( is_null( $params['to'] ) ?
null : $this->titlePartToKey( $params['to'] ) );
65 $this->addWhereRange( 'cat_title', $dir, $from, $to );
67 $min = $params['min'];
68 $max = $params['max'];
69 if ( $dir == 'newer' ) {
70 $this->addWhereRange( 'cat_pages', 'newer', $min, $max );
72 $this->addWhereRange( 'cat_pages', 'older', $max, $min);
76 if ( isset( $params['prefix'] ) ) {
77 $this->addWhere( 'cat_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );
80 $this->addOption( 'LIMIT', $params['limit'] +
1 );
81 $sort = ( $params['dir'] == 'descending' ?
' DESC' : '' );
82 $this->addOption( 'ORDER BY', 'cat_title' . $sort );
84 $prop = array_flip( $params['prop'] );
85 $this->addFieldsIf( array( 'cat_pages', 'cat_subcats', 'cat_files' ), isset( $prop['size'] ) );
86 if ( isset( $prop['hidden'] ) ) {
87 $this->addTables( array( 'page', 'page_props' ) );
88 $this->addJoinConds( array(
89 'page' => array( 'LEFT JOIN', array(
90 'page_namespace' => NS_CATEGORY
,
91 'page_title=cat_title' ) ),
92 'page_props' => array( 'LEFT JOIN', array(
94 'pp_propname' => 'hiddencat' ) ),
96 $this->addFields( 'pp_propname AS cat_hidden' );
99 $res = $this->select( __METHOD__
);
103 $result = $this->getResult();
105 foreach ( $res as $row ) {
106 if ( ++
$count > $params['limit'] ) {
107 // We've reached the one extra which shows that there are additional cats to be had. Stop here...
108 // TODO: Security issue - if the user has no right to view next title, it will still be shown
109 $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->cat_title
) );
114 $titleObj = Title
::makeTitle( NS_CATEGORY
, $row->cat_title
);
115 if ( !is_null( $resultPageSet ) ) {
116 $pages[] = $titleObj;
119 $result->setContent( $item, $titleObj->getText() );
120 if ( isset( $prop['size'] ) ) {
121 $item['size'] = intval( $row->cat_pages
);
122 $item['pages'] = $row->cat_pages
- $row->cat_subcats
- $row->cat_files
;
123 $item['files'] = intval( $row->cat_files
);
124 $item['subcats'] = intval( $row->cat_subcats
);
126 if ( isset( $prop['hidden'] ) && $row->cat_hidden
) {
127 $item['hidden'] = '';
129 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $item );
131 $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->cat_title
) );
137 if ( is_null( $resultPageSet ) ) {
138 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'c' );
140 $resultPageSet->populateFromTitles( $pages );
144 public function getAllowedParams() {
150 ApiBase
::PARAM_DFLT
=> 'ascending',
151 ApiBase
::PARAM_TYPE
=> array(
157 ApiBase
::PARAM_DFLT
=> null,
158 ApiBase
::PARAM_TYPE
=> 'integer'
161 ApiBase
::PARAM_DFLT
=> null,
162 ApiBase
::PARAM_TYPE
=> 'integer'
165 ApiBase
::PARAM_DFLT
=> 10,
166 ApiBase
::PARAM_TYPE
=> 'limit',
167 ApiBase
::PARAM_MIN
=> 1,
168 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
169 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
172 ApiBase
::PARAM_TYPE
=> array( 'size', 'hidden' ),
173 ApiBase
::PARAM_DFLT
=> '',
174 ApiBase
::PARAM_ISMULTI
=> true
179 public function getParamDescription() {
181 'from' => 'The category to start enumerating from',
182 'to' => 'The category to stop enumerating at',
183 'prefix' => 'Search for all category titles that begin with this value',
184 'dir' => 'Direction to sort in',
185 'min' => 'Minimum number of category members',
186 'max' => 'Maximum number of category members',
187 'limit' => 'How many categories to return',
189 'Which properties to get',
190 ' size - Adds number of pages in the category',
191 ' hidden - Tags categories that are hidden with __HIDDENCAT__',
196 public function getResultProperties() {
203 'pages' => 'integer',
204 'files' => 'integer',
205 'subcats' => 'integer'
208 'hidden' => 'boolean'
213 public function getDescription() {
214 return 'Enumerate all categories';
217 public function getExamples() {
219 'api.php?action=query&list=allcategories&acprop=size',
220 'api.php?action=query&generator=allcategories&gacprefix=List&prop=info',
224 public function getHelpUrls() {
225 return 'https://www.mediawiki.org/wiki/API:Allcategories';
228 public function getVersion() {
229 return __CLASS__
. ': $Id$';