1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
<?php
/*
* Created on June 14, 2007
*
* API for MediaWiki 1.8+
*
* Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* http://www.gnu.org/copyleft/gpl.html
*/
if (!defined('MEDIAWIKI')) {
// Eclipse helper - will be ignored in production
require_once ("ApiQueryBase.php");
}
/**
* A query module to enumerate pages that belong to a category.
*
* @addtogroup API
*/
class ApiQueryCategoryMembers extends ApiQueryGeneratorBase {
public function __construct($query, $moduleName) {
parent :: __construct($query, $moduleName, 'cm');
}
public function execute() {
$this->run();
}
public function executeGenerator($resultPageSet) {
$this->run($resultPageSet);
}
private function run($resultPageSet = null) {
$params = $this->extractRequestParams();
$category = $params['category'];
if (is_null($category))
$this->dieUsage("Category parameter is required", 'param_category');
$categoryTitle = Title::makeTitleSafe( NS_CATEGORY, $category );
if ( is_null( $categoryTitle ) )
$this->dieUsage("Category name $category is not valid", 'param_category');
$prop = array_flip($params['prop']);
$fld_ids = isset($prop['ids']);
$fld_title = isset($prop['title']);
$fld_sortkey = isset($prop['sortkey']);
$fld_timestamp = isset($prop['timestamp']);
if (is_null($resultPageSet)) {
$this->addFields(array('cl_from', 'cl_sortkey', 'page_namespace', 'page_title'));
$this->addFieldsIf('page_id', $fld_ids);
} else {
$this->addFields($resultPageSet->getPageTableFields()); // will include page_ id, ns, title
$this->addFields(array('cl_from', 'cl_sortkey'));
}
$this->addFieldsIf('cl_timestamp', $fld_timestamp);
$this->addTables(array('page','categorylinks')); // must be in this order for 'USE INDEX'
// Not needed after bug 10280 is applied to servers
if($params['sort'] == 'timestamp')
{
$this->addOption('USE INDEX', 'cl_timestamp');
$this->addOption('ORDER BY', 'cl_to, cl_timestamp');
}
else
{
$this->addOption('USE INDEX', 'cl_sortkey');
$this->addOption('ORDER BY', 'cl_to, cl_sortkey, cl_from');
}
$this->addWhere('cl_from=page_id');
$this->setContinuation($params['continue']);
$this->addWhereFld('cl_to', $categoryTitle->getDBkey());
$this->addWhereFld('page_namespace', $params['namespace']);
$limit = $params['limit'];
$this->addOption('LIMIT', $limit +1);
$db = $this->getDB();
$data = array ();
$count = 0;
$lastSortKey = null;
$res = $this->select(__METHOD__);
while ($row = $db->fetchObject($res)) {
if (++ $count > $limit) {
// We've reached the one extra which shows that there are additional pages to be had. Stop here...
// TODO: Security issue - if the user has no right to view next title, it will still be shown
$this->setContinueEnumParameter('continue', $this->getContinueStr($row, $lastSortKey));
break;
}
$lastSortKey = $row->cl_sortkey; // detect duplicate sortkeys
if (is_null($resultPageSet)) {
$vals = array();
if ($fld_ids)
$vals['pageid'] = intval($row->page_id);
if ($fld_title) {
$title = Title :: makeTitle($row->page_namespace, $row->page_title);
$vals['ns'] = intval($title->getNamespace());
$vals['title'] = $title->getPrefixedText();
}
if ($fld_sortkey)
$vals['sortkey'] = $row->cl_sortkey;
if ($fld_timestamp)
$vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->cl_timestamp);
$data[] = $vals;
} else {
$resultPageSet->processDbRow($row);
}
}
$db->freeResult($res);
if (is_null($resultPageSet)) {
$this->getResult()->setIndexedTagName($data, 'cm');
$this->getResult()->addValue('query', $this->getModuleName(), $data);
}
}
private function getContinueStr($row, $lastSortKey) {
$ret = $row->cl_sortkey . '|';
if ($row->cl_sortkey == $lastSortKey) // duplicate sort key, add cl_from
$ret .= $row->cl_from;
return $ret;
}
/**
* Add DB WHERE clause to continue previous query based on 'continue' parameter
*/
private function setContinuation($continue) {
if (is_null($continue))
return; // This is not a continuation request
$continueList = explode('|', $continue);
$hasError = count($continueList) != 2;
$from = 0;
if (!$hasError && strlen($continueList[1]) > 0) {
$from = intval($continueList[1]);
$hasError = ($from == 0);
}
if ($hasError)
$this->dieUsage("Invalid continue param. You should pass the original value returned by the previous query", "badcontinue");
$encSortKey = $this->getDB()->addQuotes($continueList[0]);
$encFrom = $this->getDB()->addQuotes($from);
if ($from != 0) {
// Duplicate sort key continue
$this->addWhere( "cl_sortkey>$encSortKey OR (cl_sortkey=$encSortKey AND cl_from>=$encFrom)" );
} else {
$this->addWhere( "cl_sortkey>=$encSortKey" );
}
}
protected function getAllowedParams() {
return array (
'category' => null,
'prop' => array (
ApiBase :: PARAM_DFLT => 'ids|title',
ApiBase :: PARAM_ISMULTI => true,
ApiBase :: PARAM_TYPE => array (
'ids',
'title',
'sortkey',
'timestamp',
)
),
'namespace' => array (
ApiBase :: PARAM_ISMULTI => true,
ApiBase :: PARAM_TYPE => 'namespace',
),
'continue' => null,
'limit' => array (
ApiBase :: PARAM_TYPE => 'limit',
ApiBase :: PARAM_DFLT => 10,
ApiBase :: PARAM_MIN => 1,
ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
),
'sort' => array(
ApiBase :: PARAM_DFLT => 'sortkey',
ApiBase :: PARAM_TYPE => array(
'sortkey',
'timestamp'
)
)
);
}
protected function getParamDescription() {
return array (
'category' => 'Which category to enumerate (required)',
'prop' => 'What pieces of information to include',
'namespace' => 'Only include pages in these namespaces',
'sort' => 'Property to sort by',
'continue' => 'For large categories, give the value retured from previous query',
'limit' => 'The maximum number of pages to return.',
);
}
protected function getDescription() {
return 'List all pages in a given category';
}
protected function getExamples() {
return array (
"Get first 10 pages in the categories [[Physics]]:",
" api.php?action=query&list=categorymembers&cmcategory=Physics",
"Get page info about first 10 pages in the categories [[Physics]]:",
" api.php?action=query&generator=categorymembers&gcmcategory=Physics&prop=info",
);
}
public function getVersion() {
return __CLASS__ . ': $Id: ApiQueryCategoryMembers.php 25474 2007-09-04 14:30:31Z catrope $';
}
}
|
