4 * Created on June 14, 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 pages that belong to a category.
36 class ApiQueryCategoryMembers extends ApiQueryGeneratorBase {
38 public function __construct($query, $moduleName) {
39 parent :: __construct($query, $moduleName, 'cm');
42 public function execute() {
46 public function executeGenerator($resultPageSet) {
47 $this->run($resultPageSet);
50 private function run($resultPageSet = null) {
52 $params = $this->extractRequestParams();
54 $category = $params['category'];
55 if (is_null($category))
56 $this->dieUsage("Category parameter is required", 'param_category');
57 $categoryTitle = Title::makeTitleSafe( NS_CATEGORY, $category );
58 if ( is_null( $categoryTitle ) )
59 $this->dieUsage("Category name $category is not valid", 'param_category');
61 $prop = array_flip($params['prop']);
62 $fld_ids = isset($prop['ids']);
63 $fld_title = isset($prop['title']);
64 $fld_sortkey = isset($prop['sortkey']);
65 $fld_timestamp = isset($prop['timestamp']);
67 if (is_null($resultPageSet)) {
68 $this->addFields(array('cl_from', 'cl_sortkey', 'page_namespace', 'page_title'));
69 $this->addFieldsIf('page_id', $fld_ids);
71 $this->addFields($resultPageSet->getPageTableFields()); // will include page_ id, ns, title
72 $this->addFields(array('cl_from', 'cl_sortkey'));
75 $this->addFieldsIf('cl_timestamp', $fld_timestamp);
76 $this->addTables(array('page','categorylinks')); // must be in this order for 'USE INDEX'
77 // Not needed after bug 10280 is applied to servers
78 if($params['sort'] == 'timestamp')
80 $this->addOption('USE INDEX', 'cl_timestamp');
81 $this->addOption('ORDER BY', 'cl_to, cl_timestamp');
85 $this->addOption('USE INDEX', 'cl_sortkey');
86 $this->addOption('ORDER BY', 'cl_to, cl_sortkey, cl_from');
89 $this->addWhere('cl_from=page_id');
90 $this->setContinuation($params['continue']);
91 $this->addWhereFld('cl_to', $categoryTitle->getDBkey());
92 $this->addWhereFld('page_namespace', $params['namespace']);
94 $limit = $params['limit'];
95 $this->addOption('LIMIT', $limit +1);
102 $res = $this->select(__METHOD__);
103 while ($row = $db->fetchObject($res)) {
104 if (++ $count > $limit) {
105 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
106 // TODO: Security issue - if the user has no right to view next title, it will still be shown
107 $this->setContinueEnumParameter('continue', $this->getContinueStr($row, $lastSortKey));
111 $lastSortKey = $row->cl_sortkey; // detect duplicate sortkeys
113 if (is_null($resultPageSet)) {
116 $vals['pageid'] = intval($row->page_id);
118 $title = Title :: makeTitle($row->page_namespace, $row->page_title);
119 $vals['ns'] = intval($title->getNamespace());
120 $vals['title'] = $title->getPrefixedText();
123 $vals['sortkey'] = $row->cl_sortkey;
125 $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->cl_timestamp);
128 $resultPageSet->processDbRow($row);
131 $db->freeResult($res);
133 if (is_null($resultPageSet)) {
134 $this->getResult()->setIndexedTagName($data, 'cm');
135 $this->getResult()->addValue('query', $this->getModuleName(), $data);
139 private function getContinueStr($row, $lastSortKey) {
140 $ret = $row->cl_sortkey . '|';
141 if ($row->cl_sortkey == $lastSortKey) // duplicate sort key, add cl_from
142 $ret .= $row->cl_from;
147 * Add DB WHERE clause to continue previous query based on 'continue' parameter
149 private function setContinuation($continue) {
150 if (is_null($continue))
151 return; // This is not a continuation request
153 $continueList = explode('|', $continue);
154 $hasError = count($continueList) != 2;
156 if (!$hasError && strlen($continueList[1]) > 0) {
157 $from = intval($continueList[1]);
158 $hasError = ($from == 0);
162 $this->dieUsage("Invalid continue param. You should pass the original value returned by the previous query", "badcontinue");
164 $encSortKey = $this->getDB()->addQuotes($continueList[0]);
165 $encFrom = $this->getDB()->addQuotes($from);
168 // Duplicate sort key continue
169 $this->addWhere( "cl_sortkey>$encSortKey OR (cl_sortkey=$encSortKey AND cl_from>=$encFrom)" );
171 $this->addWhere( "cl_sortkey>=$encSortKey" );
175 protected function getAllowedParams() {
179 ApiBase :: PARAM_DFLT => 'ids|title',
180 ApiBase :: PARAM_ISMULTI => true,
181 ApiBase :: PARAM_TYPE => array (
188 'namespace' => array (
189 ApiBase :: PARAM_ISMULTI => true,
190 ApiBase :: PARAM_TYPE => 'namespace',
194 ApiBase :: PARAM_TYPE => 'limit',
195 ApiBase :: PARAM_DFLT => 10,
196 ApiBase :: PARAM_MIN => 1,
197 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
198 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
201 ApiBase :: PARAM_DFLT => 'sortkey',
202 ApiBase :: PARAM_TYPE => array(
210 protected function getParamDescription() {
212 'category' => 'Which category to enumerate (required)',
213 'prop' => 'What pieces of information to include',
214 'namespace' => 'Only include pages in these namespaces',
215 'sort' => 'Property to sort by',
216 'continue' => 'For large categories, give the value retured from previous query',
217 'limit' => 'The maximum number of pages to return.',
221 protected function getDescription() {
222 return 'List all pages in a given category';
225 protected function getExamples() {
227 "Get first 10 pages in the categories [[Physics]]:",
228 " api.php?action=query&list=categorymembers&cmcategory=Physics",
229 "Get page info about first 10 pages in the categories [[Physics]]:",
230 " api.php?action=query&generator=categorymembers&gcmcategory=Physics&prop=info",
234 public function getVersion() {
235 return __CLASS__ . ': $Id: ApiQueryCategoryMembers.php 25474 2007-09-04 14:30:31Z catrope $';