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 = $params['prop'];
57 $show = array_flip((array)$params['show']);
59 $this->addFields(array (
64 $fld_sortkey = $fld_timestamp = false;
65 if (!is_null($prop)) {
66 foreach($prop as $p) {
69 $this->addFields('cl_sortkey');
73 $this->addFields('cl_timestamp');
74 $fld_timestamp = true;
77 ApiBase
:: dieDebug(__METHOD__
, "Unknown prop=$p");
82 $this->addTables('categorylinks');
83 $this->addWhereFld('cl_from', array_keys($this->getPageSet()->getGoodTitles()));
84 if(!is_null($params['categories']))
87 foreach($params['categories'] as $cat)
89 $title = Title
::newFromText($cat);
90 if(!$title ||
$title->getNamespace() != NS_CATEGORY
)
91 $this->setWarning("``$cat'' is not a category");
93 $cats[] = $title->getDBkey();
95 $this->addWhereFld('cl_to', $cats);
97 if(!is_null($params['continue'])) {
98 $cont = explode('|', $params['continue']);
100 $this->dieUsage("Invalid continue param. You should pass the " .
101 "original value returned by the previous query", "_badcontinue");
102 $clfrom = intval($cont[0]);
103 $clto = $this->getDB()->strencode($this->titleToKey($cont[1]));
104 $this->addWhere("cl_from > $clfrom OR ".
105 "(cl_from = $clfrom AND ".
106 "cl_to >= '$clto')");
108 if(isset($show['hidden']) && isset($show['!hidden']))
109 $this->dieUsage("Incorrect parameter - mutually exclusive values may not be supplied", 'show');
110 if(isset($show['hidden']) ||
isset($show['!hidden']))
112 $this->addOption('STRAIGHT_JOIN');
113 $this->addTables(array('page', 'page_props'));
114 $this->addJoinConds(array(
115 'page' => array('LEFT JOIN', array(
116 'page_namespace' => NS_CATEGORY
,
117 'page_title = cl_to')),
118 'page_props' => array('LEFT JOIN', array(
120 'pp_propname' => 'hiddencat'))
122 if(isset($show['hidden']))
123 $this->addWhere(array('pp_propname IS NOT NULL'));
125 $this->addWhere(array('pp_propname IS NULL'));
128 $this->addOption('USE INDEX', array('categorylinks' => 'cl_from'));
129 # Don't order by cl_from if it's constant in the WHERE clause
130 if(count($this->getPageSet()->getGoodTitles()) == 1)
131 $this->addOption('ORDER BY', 'cl_to');
133 $this->addOption('ORDER BY', "cl_from, cl_to");
135 $db = $this->getDB();
136 $res = $this->select(__METHOD__
);
138 if (is_null($resultPageSet)) {
141 while ($row = $db->fetchObject($res)) {
142 if (++
$count > $params['limit']) {
143 // We've reached the one extra which shows that
144 // there are additional pages to be had. Stop here...
145 $this->setContinueEnumParameter('continue', $row->cl_from
.
146 '|' . $this->keyToTitle($row->cl_to
));
150 $title = Title
:: makeTitle(NS_CATEGORY
, $row->cl_to
);
152 ApiQueryBase
:: addTitleInfo($vals, $title);
154 $vals['sortkey'] = $row->cl_sortkey
;
156 $vals['timestamp'] = wfTimestamp(TS_ISO_8601
, $row->cl_timestamp
);
158 $fit = $this->addPageSubItem($row->cl_from
, $vals);
161 $this->setContinueEnumParameter('continue', $row->cl_from
.
162 '|' . $this->keyToTitle($row->cl_to
));
169 while ($row = $db->fetchObject($res)) {
170 if (++
$count > $params['limit']) {
171 // We've reached the one extra which shows that
172 // there are additional pages to be had. Stop here...
173 $this->setContinueEnumParameter('continue', $row->cl_from
.
174 '|' . $this->keyToTitle($row->cl_to
));
178 $titles[] = Title
:: makeTitle(NS_CATEGORY
, $row->cl_to
);
180 $resultPageSet->populateFromTitles($titles);
183 $db->freeResult($res);
186 public function getAllowedParams() {
189 ApiBase
:: PARAM_ISMULTI
=> true,
190 ApiBase
:: PARAM_TYPE
=> array (
196 ApiBase
:: PARAM_ISMULTI
=> true,
197 ApiBase
:: PARAM_TYPE
=> array(
203 ApiBase
:: PARAM_DFLT
=> 10,
204 ApiBase
:: PARAM_TYPE
=> 'limit',
205 ApiBase
:: PARAM_MIN
=> 1,
206 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
207 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
210 'categories' => array(
211 ApiBase
:: PARAM_ISMULTI
=> true,
216 public function getParamDescription() {
218 'prop' => 'Which additional properties to get for each category.',
219 'limit' => 'How many categories to return',
220 'show' => 'Which kind of categories to show',
221 'continue' => 'When more results are available, use this to continue',
222 'categories' => 'Only list these categories. Useful for checking whether a certain page is in a certain category',
226 public function getDescription() {
227 return 'List all categories the page(s) belong to';
230 protected function getExamples() {
232 "Get a list of categories [[Albert Einstein]] belongs to:",
233 " api.php?action=query&prop=categories&titles=Albert%20Einstein",
234 "Get information about all categories used in the [[Albert Einstein]]:",
235 " api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info"
239 public function getVersion() {
240 return __CLASS__
. ': $Id$';