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['continue'])) {
85 $cont = explode('|', $params['continue']);
87 $this->dieUsage("Invalid continue param. You should pass the " .
88 "original value returned by the previous query", "_badcontinue");
89 $clfrom = intval($cont[0]);
90 $clto = $this->getDB()->strencode($this->titleToKey($cont[1]));
91 $this->addWhere("cl_from > $clfrom OR ".
92 "(cl_from = $clfrom AND ".
95 if(isset($show['hidden']) && isset($show['!hidden']))
96 $this->dieUsage("Incorrect parameter - mutually exclusive values may not be supplied", 'show');
97 if(isset($show['hidden']) || isset($show['!hidden']))
99 $this->addOption('STRAIGHT_JOIN');
100 $this->addTables(array('page', 'page_props'));
101 $this->addJoinConds(array(
102 'page' => array('LEFT JOIN', array(
103 'page_namespace' => NS_CATEGORY,
104 'page_title = cl_to')),
105 'page_props' => array('LEFT JOIN', array(
107 'pp_propname' => 'hiddencat'))
109 if(isset($show['hidden']))
110 $this->addWhere(array('pp_propname IS NOT NULL'));
112 $this->addWhere(array('pp_propname IS NULL'));
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 $lastId = 0; // database has no ID 0
129 while ($row = $db->fetchObject($res)) {
130 if (++$count > $params['limit']) {
131 // We've reached the one extra which shows that
132 // there are additional pages to be had. Stop here...
133 $this->setContinueEnumParameter('continue', $row->cl_from .
134 '|' . $this->keyToTitle($row->cl_to));
137 if ($lastId != $row->cl_from) {
139 $this->addPageSubItems($lastId, $data);
142 $lastId = $row->cl_from;
145 $title = Title :: makeTitle(NS_CATEGORY, $row->cl_to);
148 ApiQueryBase :: addTitleInfo($vals, $title);
150 $vals['sortkey'] = $row->cl_sortkey;
152 $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->cl_timestamp);
158 $this->addPageSubItems($lastId, $data);
164 while ($row = $db->fetchObject($res)) {
165 if (++$count > $params['limit']) {
166 // We've reached the one extra which shows that
167 // there are additional pages to be had. Stop here...
168 $this->setContinueEnumParameter('continue', $row->cl_from .
169 '|' . $this->keyToTitle($row->cl_to));
173 $titles[] = Title :: makeTitle(NS_CATEGORY, $row->cl_to);
175 $resultPageSet->populateFromTitles($titles);
178 $db->freeResult($res);
181 public function getAllowedParams() {
184 ApiBase :: PARAM_ISMULTI => true,
185 ApiBase :: PARAM_TYPE => array (
191 ApiBase :: PARAM_ISMULTI => true,
192 ApiBase :: PARAM_TYPE => array(
198 ApiBase :: PARAM_DFLT => 10,
199 ApiBase :: PARAM_TYPE => 'limit',
200 ApiBase :: PARAM_MIN => 1,
201 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
202 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
208 public function getParamDescription() {
210 'prop' => 'Which additional properties to get for each category.',
211 'limit' => 'How many categories to return',
212 'show' => 'Which kind of categories to show',
213 'continue' => 'When more results are available, use this to continue',
217 public function getDescription() {
218 return 'List all categories the page(s) belong to';
221 protected function getExamples() {
223 "Get a list of categories [[Albert Einstein]] belongs to:",
224 " api.php?action=query&prop=categories&titles=Albert%20Einstein",
225 "Get information about all categories used in the [[Albert Einstein]]:",
226 " api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info"
230 public function getVersion() {
231 return __CLASS__ . ': $Id: ApiQueryCategories.php 44585 2008-12-14 17:39:50Z catrope $';