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
27 if ( !defined( 'MEDIAWIKI' ) ) {
28 // Eclipse helper - will be ignored in production
29 require_once( 'ApiQueryBase.php' );
33 * Query module to enumerate all categories, even the ones that don't have
38 class ApiQueryAllCategories
extends ApiQueryGeneratorBase
{
40 public function __construct( $query, $moduleName ) {
41 parent
::__construct( $query, $moduleName, 'ac' );
44 public function execute() {
48 public function getCacheMode( $params ) {
52 public function executeGenerator( $resultPageSet ) {
53 $this->run( $resultPageSet );
57 * @param $resultPageSet ApiPageSet
60 private function run( $resultPageSet = null ) {
62 $params = $this->extractRequestParams();
64 $this->addTables( 'category' );
65 $this->addFields( 'cat_title' );
67 $dir = ( $params['dir'] == 'descending' ?
'older' : 'newer' );
68 $from = ( is_null( $params['from'] ) ?
null : $this->titlePartToKey( $params['from'] ) );
69 $to = ( is_null( $params['to'] ) ?
null : $this->titlePartToKey( $params['to'] ) );
70 $this->addWhereRange( 'cat_title', $dir, $from, $to );
72 $min = $params['minpage'];
73 $max = $params['maxpage'];
74 $this->addWhereRange( 'cat_pages', $dir, $min, $max );
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 $this->addOption( 'ORDER BY', 'cat_title' . ( $params['dir'] == 'descending' ?
' DESC' : '' ) );
83 $prop = array_flip( $params['prop'] );
84 $this->addFieldsIf( array( 'cat_pages', 'cat_subcats', 'cat_files' ), isset( $prop['size'] ) );
85 if ( isset( $prop['hidden'] ) ) {
86 $this->addTables( array( 'page', 'page_props' ) );
87 $this->addJoinConds( array(
88 'page' => array( 'LEFT JOIN', array(
89 'page_namespace' => NS_CATEGORY
,
90 'page_title=cat_title' ) ),
91 'page_props' => array( 'LEFT JOIN', array(
93 'pp_propname' => 'hiddencat' ) ),
95 $this->addFields( 'pp_propname AS cat_hidden' );
98 $res = $this->select( __METHOD__
);
102 $result = $this->getResult();
104 foreach ( $res as $row ) {
105 if ( ++
$count > $params['limit'] ) {
106 // We've reached the one extra which shows that there are additional cats to be had. Stop here...
107 // TODO: Security issue - if the user has no right to view next title, it will still be shown
108 $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->cat_title
) );
113 $titleObj = Title
::makeTitle( NS_CATEGORY
, $row->cat_title
);
114 if ( !is_null( $resultPageSet ) ) {
115 $pages[] = $titleObj->getPrefixedText();
118 $result->setContent( $item, $titleObj->getText() );
119 if ( isset( $prop['size'] ) ) {
120 $item['size'] = intval( $row->cat_pages
);
121 $item['pages'] = $row->cat_pages
- $row->cat_subcats
- $row->cat_files
;
122 $item['files'] = intval( $row->cat_files
);
123 $item['subcats'] = intval( $row->cat_subcats
);
125 if ( isset( $prop['hidden'] ) && $row->cat_hidden
) {
126 $item['hidden'] = '';
128 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $item );
130 $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->cat_title
) );
136 if ( is_null( $resultPageSet ) ) {
137 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'c' );
139 $resultPageSet->populateFromTitles( $pages );
143 public function getAllowedParams() {
149 ApiBase
::PARAM_DFLT
=> 'ascending',
150 ApiBase
::PARAM_TYPE
=> array(
156 ApiBase
::PARAM_DFLT
=> null,
157 ApiBase
::PARAM_TYPE
=> 'integer'
160 ApiBase
::PARAM_DFLT
=> null,
161 ApiBase
::PARAM_TYPE
=> 'integer'
164 ApiBase
::PARAM_DFLT
=> 10,
165 ApiBase
::PARAM_TYPE
=> 'limit',
166 ApiBase
::PARAM_MIN
=> 1,
167 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
168 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
171 ApiBase
::PARAM_TYPE
=> array( 'size', 'hidden' ),
172 ApiBase
::PARAM_DFLT
=> '',
173 ApiBase
::PARAM_ISMULTI
=> true
178 public function getParamDescription() {
180 'from' => 'The category to start enumerating from',
181 'to' => 'The category to stop enumerating at',
182 'prefix' => 'Search for all category titles that begin with this value',
183 'dir' => 'Direction to sort in',
184 'minpage' => 'Minimum number of category page members',
185 'maxpage' => 'Maximum number of category page members',
186 'limit' => 'How many categories to return',
188 'Which properties to get',
189 ' size - Adds number of pages in the category',
190 ' hidden - Tags categories that are hidden with __HIDDENCAT__',
195 public function getDescription() {
196 return 'Enumerate all categories';
199 protected function getExamples() {
201 'api.php?action=query&list=allcategories&acprop=size',
202 'api.php?action=query&generator=allcategories&gacprefix=List&prop=info',
206 public function getVersion() {
207 return __CLASS__
. ': $Id$';