4 * Created on December 12, 2007
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ('ApiQueryBase.php');
32 * Query module to enumerate all categories, even the ones that don't have
37 class ApiQueryAllCategories extends ApiQueryGeneratorBase {
39 public function __construct($query, $moduleName) {
40 parent :: __construct($query, $moduleName, 'ac');
43 public function execute() {
47 public function executeGenerator($resultPageSet) {
48 $this->run($resultPageSet);
51 private function run($resultPageSet = null) {
54 $params = $this->extractRequestParams();
56 $this->addTables('category');
57 $this->addFields('cat_title');
59 $dir = ($params['dir'] == 'descending' ? 'older' : 'newer');
60 $from = (is_null($params['from']) ? null : $this->titlePartToKey($params['from']));
61 $this->addWhereRange('cat_title', $dir, $from, null);
62 if (isset ($params['prefix']))
63 $this->addWhere("cat_title LIKE '" . $db->escapeLike($this->titlePartToKey($params['prefix'])) . "%'");
65 $this->addOption('LIMIT', $params['limit']+1);
66 $this->addOption('ORDER BY', 'cat_title' . ($params['dir'] == 'descending' ? ' DESC' : ''));
68 $prop = array_flip($params['prop']);
69 $this->addFieldsIf( array( 'cat_pages', 'cat_subcats', 'cat_files' ), isset($prop['size']) );
70 if(isset($prop['hidden']))
72 $this->addTables(array('page', 'page_props'));
73 $this->addJoinConds(array(
74 'page' => array('LEFT JOIN', array(
75 'page_namespace' => NS_CATEGORY,
76 'page_title=cat_title')),
77 'page_props' => array('LEFT JOIN', array(
79 'pp_propname' => 'hiddencat')),
81 $this->addFields('pp_propname AS cat_hidden');
84 $res = $this->select(__METHOD__);
87 $categories = array();
88 $result = $this->getResult();
90 while ($row = $db->fetchObject($res)) {
91 if (++ $count > $params['limit']) {
92 // We've reached the one extra which shows that there are additional cats to be had. Stop here...
93 // TODO: Security issue - if the user has no right to view next title, it will still be shown
94 $this->setContinueEnumParameter('from', $this->keyToTitle($row->cat_title));
99 $titleObj = Title::makeTitle(NS_CATEGORY, $row->cat_title);
100 if(!is_null($resultPageSet))
101 $pages[] = $titleObj->getPrefixedText();
104 $result->setContent( $item, $titleObj->getText() );
105 if( isset( $prop['size'] ) ) {
106 $item['size'] = $row->cat_pages;
107 $item['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files;
108 $item['files'] = $row->cat_files;
109 $item['subcats'] = $row->cat_subcats;
111 if( isset( $prop['hidden'] ) && $row->cat_hidden )
112 $item['hidden'] = '';
113 $categories[] = $item;
116 $db->freeResult($res);
118 if (is_null($resultPageSet)) {
119 $result->setIndexedTagName($categories, 'c');
120 $result->addValue('query', $this->getModuleName(), $categories);
122 $resultPageSet->populateFromTitles($pages);
126 public function getAllowedParams() {
131 ApiBase :: PARAM_DFLT => 'ascending',
132 ApiBase :: PARAM_TYPE => array(
138 ApiBase :: PARAM_DFLT => 10,
139 ApiBase :: PARAM_TYPE => 'limit',
140 ApiBase :: PARAM_MIN => 1,
141 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
142 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
145 ApiBase :: PARAM_TYPE => array( 'size', 'hidden' ),
146 ApiBase :: PARAM_DFLT => '',
147 ApiBase :: PARAM_ISMULTI => true
152 public function getParamDescription() {
154 'from' => 'The category to start enumerating from.',
155 'prefix' => 'Search for all category titles that begin with this value.',
156 'dir' => 'Direction to sort in.',
157 'limit' => 'How many categories to return.',
158 'prop' => 'Which properties to get',
162 public function getDescription() {
163 return 'Enumerate all categories';
166 protected function getExamples() {
168 'api.php?action=query&list=allcategories&acprop=size',
169 'api.php?action=query&generator=allcategories&gacprefix=List&prop=info',
173 public function getVersion() {
174 return __CLASS__ . ': $Id: ApiQueryAllCategories.php 44590 2008-12-14 20:24:23Z catrope $';