4 * Created on May 13, 2007
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
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 * A query module to enumerate categories the set of pages belong to.
36 class ApiQueryCategories
extends ApiQueryGeneratorBase
{
38 public function __construct($query, $moduleName) {
39 parent
:: __construct($query, $moduleName, 'cl');
42 public function execute() {
46 public function executeGenerator($resultPageSet) {
47 $this->run($resultPageSet);
50 private function run($resultPageSet = null) {
52 if ($this->getPageSet()->getGoodTitleCount() == 0)
53 return; // nothing to do
55 $params = $this->extractRequestParams();
56 $prop = array_flip((array)$params['prop']);
57 $show = array_flip((array)$params['show']);
59 $this->addFields(array (
64 $this->addFieldsIf('cl_sortkey', isset($prop['sortkey']));
65 $this->addFieldsIf('cl_timestamp', isset($prop['timestamp']));
67 $this->addTables('categorylinks');
68 $this->addWhereFld('cl_from', array_keys($this->getPageSet()->getGoodTitles()));
69 if(!is_null($params['categories']))
72 foreach($params['categories'] as $cat)
74 $title = Title
::newFromText($cat);
75 if(!$title ||
$title->getNamespace() != NS_CATEGORY
)
76 $this->setWarning("``$cat'' is not a category");
78 $cats[] = $title->getDBkey();
80 $this->addWhereFld('cl_to', $cats);
82 if(!is_null($params['continue'])) {
83 $cont = explode('|', $params['continue']);
85 $this->dieUsage("Invalid continue param. You should pass the " .
86 "original value returned by the previous query", "_badcontinue");
87 $clfrom = intval($cont[0]);
88 $clto = $this->getDB()->strencode($this->titleToKey($cont[1]));
89 $this->addWhere("cl_from > $clfrom OR ".
90 "(cl_from = $clfrom AND ".
93 if(isset($show['hidden']) && isset($show['!hidden']))
94 $this->dieUsage("Incorrect parameter - mutually exclusive values may not be supplied", 'show');
95 if(isset($show['hidden']) ||
isset($show['!hidden']) ||
isset($prop['hidden']))
97 $this->addOption('STRAIGHT_JOIN');
98 $this->addTables(array('page', 'page_props'));
99 $this->addFieldsIf('pp_propname', isset($prop['hidden']));
100 $this->addJoinConds(array(
101 'page' => array('LEFT JOIN', array(
102 'page_namespace' => NS_CATEGORY
,
103 'page_title = cl_to')),
104 'page_props' => array('LEFT JOIN', array(
106 'pp_propname' => 'hiddencat'))
108 if(isset($show['hidden']))
109 $this->addWhere(array('pp_propname IS NOT NULL'));
110 else if(isset($show['!hidden']))
111 $this->addWhere(array('pp_propname IS NULL'));
114 $this->addOption('USE INDEX', array('categorylinks' => 'cl_from'));
115 # Don't order by cl_from if it's constant in the WHERE clause
116 if(count($this->getPageSet()->getGoodTitles()) == 1)
117 $this->addOption('ORDER BY', 'cl_to');
119 $this->addOption('ORDER BY', "cl_from, cl_to");
121 $db = $this->getDB();
122 $res = $this->select(__METHOD__
);
124 if (is_null($resultPageSet)) {
127 while ($row = $db->fetchObject($res)) {
128 if (++
$count > $params['limit']) {
129 // We've reached the one extra which shows that
130 // there are additional pages to be had. Stop here...
131 $this->setContinueEnumParameter('continue', $row->cl_from
.
132 '|' . $this->keyToTitle($row->cl_to
));
136 $title = Title
:: makeTitle(NS_CATEGORY
, $row->cl_to
);
138 ApiQueryBase
:: addTitleInfo($vals, $title);
139 if (isset($prop['sortkey']))
140 $vals['sortkey'] = $row->cl_sortkey
;
141 if (isset($prop['timestamp']))
142 $vals['timestamp'] = wfTimestamp(TS_ISO_8601
, $row->cl_timestamp
);
143 if (isset($prop['hidden']) && !is_null($row->pp_propname
))
144 $vals['hidden'] = '';
146 $fit = $this->addPageSubItem($row->cl_from
, $vals);
149 $this->setContinueEnumParameter('continue', $row->cl_from
.
150 '|' . $this->keyToTitle($row->cl_to
));
157 while ($row = $db->fetchObject($res)) {
158 if (++
$count > $params['limit']) {
159 // We've reached the one extra which shows that
160 // there are additional pages to be had. Stop here...
161 $this->setContinueEnumParameter('continue', $row->cl_from
.
162 '|' . $this->keyToTitle($row->cl_to
));
166 $titles[] = Title
:: makeTitle(NS_CATEGORY
, $row->cl_to
);
168 $resultPageSet->populateFromTitles($titles);
171 $db->freeResult($res);
174 public function getAllowedParams() {
177 ApiBase
:: PARAM_ISMULTI
=> true,
178 ApiBase
:: PARAM_TYPE
=> array (
185 ApiBase
:: PARAM_ISMULTI
=> true,
186 ApiBase
:: PARAM_TYPE
=> array(
192 ApiBase
:: PARAM_DFLT
=> 10,
193 ApiBase
:: PARAM_TYPE
=> 'limit',
194 ApiBase
:: PARAM_MIN
=> 1,
195 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
196 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
199 'categories' => array(
200 ApiBase
:: PARAM_ISMULTI
=> true,
205 public function getParamDescription() {
207 'prop' => 'Which additional properties to get for each category.',
208 'limit' => 'How many categories to return',
209 'show' => 'Which kind of categories to show',
210 'continue' => 'When more results are available, use this to continue',
211 'categories' => 'Only list these categories. Useful for checking whether a certain page is in a certain category',
215 public function getDescription() {
216 return 'List all categories the page(s) belong to';
219 protected function getExamples() {
221 "Get a list of categories [[Albert Einstein]] belongs to:",
222 " api.php?action=query&prop=categories&titles=Albert%20Einstein",
223 "Get information about all categories used in the [[Albert Einstein]]:",
224 " api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info"
228 public function getVersion() {
229 return __CLASS__
. ': $Id$';