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' );
61 $dir = ( $params['dir'] == 'descending' ?
'older' : 'newer' );
62 $from = ( is_null( $params['from'] ) ?
null : $this->titlePartToKey( $params['from'] ) );
63 $to = ( is_null( $params['to'] ) ?
null : $this->titlePartToKey( $params['to'] ) );
64 $this->addWhereRange( 'cat_title', $dir, $from, $to );
66 $min = $params['min'];
67 $max = $params['max'];
68 $this->addWhereRange( 'cat_pages', $dir, $min, $max );
70 if ( isset( $params['prefix'] ) ) {
71 $this->addWhere( 'cat_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );
74 $this->addOption( 'LIMIT', $params['limit'] +
1 );
75 $this->addOption( 'ORDER BY', 'cat_title' . ( $params['dir'] == 'descending' ?
' DESC' : '' ) );
77 $prop = array_flip( $params['prop'] );
78 $this->addFieldsIf( array( 'cat_pages', 'cat_subcats', 'cat_files' ), isset( $prop['size'] ) );
79 if ( isset( $prop['hidden'] ) ) {
80 $this->addTables( array( 'page', 'page_props' ) );
81 $this->addJoinConds( array(
82 'page' => array( 'LEFT JOIN', array(
83 'page_namespace' => NS_CATEGORY
,
84 'page_title=cat_title' ) ),
85 'page_props' => array( 'LEFT JOIN', array(
87 'pp_propname' => 'hiddencat' ) ),
89 $this->addFields( 'pp_propname AS cat_hidden' );
92 $res = $this->select( __METHOD__
);
96 $result = $this->getResult();
98 foreach ( $res as $row ) {
99 if ( ++
$count > $params['limit'] ) {
100 // We've reached the one extra which shows that there are additional cats to be had. Stop here...
101 // TODO: Security issue - if the user has no right to view next title, it will still be shown
102 $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->cat_title
) );
107 $titleObj = Title
::makeTitle( NS_CATEGORY
, $row->cat_title
);
108 if ( !is_null( $resultPageSet ) ) {
109 $pages[] = $titleObj->getPrefixedText();
112 $result->setContent( $item, $titleObj->getText() );
113 if ( isset( $prop['size'] ) ) {
114 $item['size'] = intval( $row->cat_pages
);
115 $item['pages'] = $row->cat_pages
- $row->cat_subcats
- $row->cat_files
;
116 $item['files'] = intval( $row->cat_files
);
117 $item['subcats'] = intval( $row->cat_subcats
);
119 if ( isset( $prop['hidden'] ) && $row->cat_hidden
) {
120 $item['hidden'] = '';
122 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $item );
124 $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->cat_title
) );
130 if ( is_null( $resultPageSet ) ) {
131 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'c' );
133 $resultPageSet->populateFromTitles( $pages );
137 public function getAllowedParams() {
143 ApiBase
::PARAM_DFLT
=> 'ascending',
144 ApiBase
::PARAM_TYPE
=> array(
150 ApiBase
::PARAM_DFLT
=> null,
151 ApiBase
::PARAM_TYPE
=> 'integer'
154 ApiBase
::PARAM_DFLT
=> null,
155 ApiBase
::PARAM_TYPE
=> 'integer'
158 ApiBase
::PARAM_DFLT
=> 10,
159 ApiBase
::PARAM_TYPE
=> 'limit',
160 ApiBase
::PARAM_MIN
=> 1,
161 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
162 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
165 ApiBase
::PARAM_TYPE
=> array( 'size', 'hidden' ),
166 ApiBase
::PARAM_DFLT
=> '',
167 ApiBase
::PARAM_ISMULTI
=> true
172 public function getParamDescription() {
174 'from' => 'The category to start enumerating from',
175 'to' => 'The category to stop enumerating at',
176 'prefix' => 'Search for all category titles that begin with this value',
177 'dir' => 'Direction to sort in',
178 'min' => 'Minimum number of category members',
179 'max' => 'Maximum number of category members',
180 'limit' => 'How many categories to return',
182 'Which properties to get',
183 ' size - Adds number of pages in the category',
184 ' hidden - Tags categories that are hidden with __HIDDENCAT__',
189 public function getDescription() {
190 return 'Enumerate all categories';
193 public function getExamples() {
195 'api.php?action=query&list=allcategories&acprop=size',
196 'api.php?action=query&generator=allcategories&gacprefix=List&prop=info',
200 public function getHelpUrls() {
201 return 'https://www.mediawiki.org/wiki/API:Allcategories';
204 public function getVersion() {
205 return __CLASS__
. ': $Id$';