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']);
66 if (is_null($resultPageSet)) {
67 $this->addFields(array('cl_from', 'cl_sortkey', 'page_namespace', 'page_title'));
68 $this->addFieldsIf('page_id', $fld_ids);
70 $this->addFields($resultPageSet->getPageTableFields()); // will include page_ id, ns, title
71 $this->addFields(array('cl_from', 'cl_sortkey'));
74 $this->addTables(array('page','categorylinks')); // must be in this order for 'USE INDEX'
75 $this->addOption('USE INDEX', 'cl_sortkey'); // Not needed after bug 10280 is applied to servers
77 $this->addWhere('cl_from=page_id');
78 $this->setContinuation($params['continue']);
79 $this->addWhereFld('cl_to', $categoryTitle->getDBkey());
80 $this->addWhereFld('page_namespace', $params['namespace']);
81 $this->addOption('ORDER BY', "cl_to, cl_sortkey, cl_from");
83 $limit = $params['limit'];
84 $this->addOption('LIMIT', $limit +
1);
91 $res = $this->select(__METHOD__
);
92 while ($row = $db->fetchObject($res)) {
93 if (++
$count > $limit) {
94 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
95 $this->setContinueEnumParameter('continue', $this->getContinueStr($row, $lastSortKey));
99 $lastSortKey = $row->cl_sortkey
; // detect duplicate sortkeys
101 if (is_null($resultPageSet)) {
102 $title = Title
:: makeTitle($row->page_namespace
, $row->page_title
);
103 if ($title->userCanRead()) {
106 $vals['pageid'] = intval($row->page_id
);
108 $vals['ns'] = intval($title->getNamespace());
109 $vals['title'] = $title->getPrefixedText();
112 $vals['sortkey'] = $row->cl_sortkey
;
116 $resultPageSet->processDbRow($row);
119 $db->freeResult($res);
121 if (is_null($resultPageSet)) {
122 $this->getResult()->setIndexedTagName($data, 'cm');
123 $this->getResult()->addValue('query', $this->getModuleName(), $data);
127 private function getContinueStr($row, $lastSortKey) {
128 $ret = $row->cl_sortkey
. '|';
129 if ($row->cl_sortkey
== $lastSortKey) // duplicate sort key, add cl_from
130 $ret .= $row->cl_from
;
135 * Add DB WHERE clause to continue previous query based on 'continue' parameter
137 private function setContinuation($continue) {
138 if (is_null($continue))
139 return; // This is not a continuation request
141 $continueList = explode('|', $continue);
142 $hasError = count($continueList) != 2;
144 if (!$hasError && strlen($continueList[1]) > 0) {
145 $from = intval($continueList[1]);
146 $hasError = ($from == 0);
150 $this->dieUsage("Invalid continue param. You should pass the original value returned by the previous query", "badcontinue");
152 $sortKey = $this->getDB()->addQuotes($continueList[0]);
155 // Duplicate sort key continue
156 $this->addWhere( "cl_sortkey>$sortKey OR (cl_sortkey=$sortKey AND cl_from>=$from)" );
158 $this->addWhere( "cl_sortkey>=$sortKey" );
162 protected function getAllowedParams() {
166 ApiBase
:: PARAM_DFLT
=> 'ids|title',
167 ApiBase
:: PARAM_ISMULTI
=> true,
168 ApiBase
:: PARAM_TYPE
=> array (
174 'namespace' => array (
175 ApiBase
:: PARAM_ISMULTI
=> true,
176 ApiBase
:: PARAM_TYPE
=> 'namespace',
180 ApiBase
:: PARAM_TYPE
=> 'limit',
181 ApiBase
:: PARAM_DFLT
=> 10,
182 ApiBase
:: PARAM_MIN
=> 1,
183 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
184 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
189 protected function getParamDescription() {
191 'category' => 'Which category to enumerate (required)',
192 'prop' => 'What pieces of information to include',
193 'namespace' => 'Only include pages in these namespaces',
194 'continue' => 'For large categories, give the value retured from previous query',
195 'limit' => 'The maximum number of pages to return.',
199 protected function getDescription() {
200 return 'List all pages in a given category';
203 protected function getExamples() {
205 "Get first 10 pages in the categories [[Physics]]:",
206 " api.php?action=query&list=categorymembers&cmcategory=Physics",
207 "Get page info about first 10 pages in the categories [[Physics]]:",
208 " api.php?action=query&generator=categorymembers&gcmcategory=Physics&prop=info",
212 public function getVersion() {
213 return __CLASS__
. ': $Id$';