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
|
<?php
/*
* Created on May 13, 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 categories the set of pages belong to.
*
* @ingroup API
*/
class ApiQueryCategories extends ApiQueryGeneratorBase {
public function __construct($query, $moduleName) {
parent :: __construct($query, $moduleName, 'cl');
}
public function execute() {
$this->run();
}
public function executeGenerator($resultPageSet) {
$this->run($resultPageSet);
}
private function run($resultPageSet = null) {
if ($this->getPageSet()->getGoodTitleCount() == 0)
return; // nothing to do
$params = $this->extractRequestParams();
$prop = $params['prop'];
$show = array_flip((array)$params['show']);
$this->addFields(array (
'cl_from',
'cl_to'
));
$fld_sortkey = $fld_timestamp = false;
if (!is_null($prop)) {
foreach($prop as $p) {
switch ($p) {
case 'sortkey':
$this->addFields('cl_sortkey');
$fld_sortkey = true;
break;
case 'timestamp':
$this->addFields('cl_timestamp');
$fld_timestamp = true;
break;
default :
ApiBase :: dieDebug(__METHOD__, "Unknown prop=$p");
}
}
}
$this->addTables('categorylinks');
$this->addWhereFld('cl_from', array_keys($this->getPageSet()->getGoodTitles()));
if(!is_null($params['continue'])) {
$cont = explode('|', $params['continue']);
if(count($cont) != 2)
$this->dieUsage("Invalid continue param. You should pass the " .
"original value returned by the previous query", "_badcontinue");
$clfrom = intval($cont[0]);
$clto = $this->getDB()->strencode($this->titleToKey($cont[1]));
$this->addWhere("cl_from > $clfrom OR ".
"(cl_from = $clfrom AND ".
"cl_to >= '$clto')");
}
if(isset($show['hidden']) && isset($show['!hidden']))
$this->dieUsage("Incorrect parameter - mutually exclusive values may not be supplied", 'show');
if(isset($show['hidden']) || isset($show['!hidden']))
{
$this->addOption('STRAIGHT_JOIN');
$this->addTables(array('page', 'page_props'));
$this->addJoinConds(array(
'page' => array('LEFT JOIN', array(
'page_namespace' => NS_CATEGORY,
'page_title = cl_to')),
'page_props' => array('LEFT JOIN', array(
'pp_page=page_id',
'pp_propname' => 'hiddencat'))
));
if(isset($show['hidden']))
$this->addWhere(array('pp_propname IS NOT NULL'));
else
$this->addWhere(array('pp_propname IS NULL'));
}
# Don't order by cl_from if it's constant in the WHERE clause
if(count($this->getPageSet()->getGoodTitles()) == 1)
$this->addOption('ORDER BY', 'cl_to');
else
$this->addOption('ORDER BY', "cl_from, cl_to");
$db = $this->getDB();
$res = $this->select(__METHOD__);
if (is_null($resultPageSet)) {
$data = array();
$lastId = 0; // database has no ID 0
$count = 0;
while ($row = $db->fetchObject($res)) {
if (++$count > $params['limit']) {
// We've reached the one extra which shows that
// there are additional pages to be had. Stop here...
$this->setContinueEnumParameter('continue', $row->cl_from .
'|' . $this->keyToTitle($row->cl_to));
break;
}
if ($lastId != $row->cl_from) {
if($lastId != 0) {
$this->addPageSubItems($lastId, $data);
$data = array();
}
$lastId = $row->cl_from;
}
$title = Title :: makeTitle(NS_CATEGORY, $row->cl_to);
$vals = array();
ApiQueryBase :: addTitleInfo($vals, $title);
if ($fld_sortkey)
$vals['sortkey'] = $row->cl_sortkey;
if ($fld_timestamp)
$vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->cl_timestamp);
$data[] = $vals;
}
if($lastId != 0) {
$this->addPageSubItems($lastId, $data);
}
} else {
$titles = array();
while ($row = $db->fetchObject($res)) {
if (++$count > $params['limit']) {
// We've reached the one extra which shows that
// there are additional pages to be had. Stop here...
$this->setContinueEnumParameter('continue', $row->cl_from .
'|' . $this->keyToTitle($row->cl_to));
break;
}
$titles[] = Title :: makeTitle(NS_CATEGORY, $row->cl_to);
}
$resultPageSet->populateFromTitles($titles);
}
$db->freeResult($res);
}
public function getAllowedParams() {
return array (
'prop' => array (
ApiBase :: PARAM_ISMULTI => true,
ApiBase :: PARAM_TYPE => array (
'sortkey',
'timestamp',
)
),
'show' => array(
ApiBase :: PARAM_ISMULTI => true,
ApiBase :: PARAM_TYPE => array(
'hidden',
'!hidden',
)
),
'limit' => array(
ApiBase :: PARAM_DFLT => 10,
ApiBase :: PARAM_TYPE => 'limit',
ApiBase :: PARAM_MIN => 1,
ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
),
'continue' => null,
);
}
public function getParamDescription() {
return array (
'prop' => 'Which additional properties to get for each category.',
'limit' => 'How many categories to return',
'show' => 'Which kind of categories to show',
'continue' => 'When more results are available, use this to continue',
);
}
public function getDescription() {
return 'List all categories the page(s) belong to';
}
protected function getExamples() {
return array (
"Get a list of categories [[Albert Einstein]] belongs to:",
" api.php?action=query&prop=categories&titles=Albert%20Einstein",
"Get information about all categories used in the [[Albert Einstein]]:",
" api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info"
);
}
public function getVersion() {
return __CLASS__ . ': $Id: ApiQueryCategories.php 44585 2008-12-14 17:39:50Z catrope $';
}
}
|
