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
|
<?php
/**
*
*
* Created on Dec 22, 2010
*
* Copyright © 2010 Roan Kattouw "<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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
/**
* Query module to get the results of a QueryPage-based special page
*
* @ingroup API
*/
class ApiQueryQueryPage extends ApiQueryGeneratorBase {
private $qpMap;
/**
* Some query pages are useless because they're available elsewhere in the API
*/
private $uselessQueryPages = array(
'MIMEsearch', // aiprop=mime
'LinkSearch', // list=exturlusage
'FileDuplicateSearch', // prop=duplicatefiles
);
public function __construct( $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'qp' );
// We need to do this to make sure $wgQueryPages is set up
// This SUCKS
global $IP;
require_once( "$IP/includes/QueryPage.php" );
// Build mapping from special page names to QueryPage classes
global $wgQueryPages;
$this->qpMap = array();
foreach ( $wgQueryPages as $page ) {
if( !in_array( $page[1], $this->uselessQueryPages ) ) {
$this->qpMap[$page[1]] = $page[0];
}
}
}
public function execute() {
$this->run();
}
public function executeGenerator( $resultPageSet ) {
$this->run( $resultPageSet );
}
/**
* @param $resultPageSet ApiPageSet
*/
public function run( $resultPageSet = null ) {
global $wgQueryCacheLimit;
$params = $this->extractRequestParams();
$result = $this->getResult();
/** @var $qp QueryPage */
$qp = new $this->qpMap[$params['page']]();
if ( !$qp->userCanExecute( $this->getUser() ) ) {
$this->dieUsageMsg( 'specialpage-cantexecute' );
}
$r = array( 'name' => $params['page'] );
if ( $qp->isCached() ) {
if ( !$qp->isCacheable() ) {
$r['disabled'] = '';
} else {
$r['cached'] = '';
$ts = $qp->getCachedTimestamp();
if ( $ts ) {
$r['cachedtimestamp'] = wfTimestamp( TS_ISO_8601, $ts );
}
$r['maxresults'] = $wgQueryCacheLimit;
}
}
$result->addValue( array( 'query' ), $this->getModuleName(), $r );
if ( $qp->isCached() && !$qp->isCacheable() ) {
// Disabled query page, don't run the query
return;
}
$res = $qp->doQuery( $params['offset'], $params['limit'] + 1 );
$count = 0;
$titles = array();
foreach ( $res as $row ) {
if ( ++$count > $params['limit'] ) {
// We've had enough
$this->setContinueEnumParameter( 'offset', $params['offset'] + $params['limit'] );
break;
}
$title = Title::makeTitle( $row->namespace, $row->title );
if ( is_null( $resultPageSet ) ) {
$data = array( 'value' => $row->value );
if ( $qp->usesTimestamps() ) {
$data['timestamp'] = wfTimestamp( TS_ISO_8601, $row->value );
}
self::addTitleInfo( $data, $title );
foreach ( $row as $field => $value ) {
if ( !in_array( $field, array( 'namespace', 'title', 'value', 'qc_type' ) ) ) {
$data['databaseResult'][$field] = $value;
}
}
$fit = $result->addValue( array( 'query', $this->getModuleName(), 'results' ), null, $data );
if ( !$fit ) {
$this->setContinueEnumParameter( 'offset', $params['offset'] + $count - 1 );
break;
}
} else {
$titles[] = $title;
}
}
if ( is_null( $resultPageSet ) ) {
$result->setIndexedTagName_internal( array( 'query', $this->getModuleName(), 'results' ), 'page' );
} else {
$resultPageSet->populateFromTitles( $titles );
}
}
public function getCacheMode( $params ) {
/** @var $qp QueryPage */
$qp = new $this->qpMap[$params['page']]();
if ( $qp->getRestriction() != '' ) {
return 'private';
}
return 'public';
}
public function getAllowedParams() {
return array(
'page' => array(
ApiBase::PARAM_TYPE => array_keys( $this->qpMap ),
ApiBase::PARAM_REQUIRED => true
),
'offset' => 0,
'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
),
);
}
public function getParamDescription() {
return array(
'page' => 'The name of the special page. Note, this is case sensitive',
'offset' => 'When more results are available, use this to continue',
'limit' => 'Number of results to return',
);
}
public function getResultProperties() {
return array(
ApiBase::PROP_ROOT => array(
'name' => array(
ApiBase::PROP_TYPE => 'string',
ApiBase::PROP_NULLABLE => false
),
'disabled' => array(
ApiBase::PROP_TYPE => 'boolean',
ApiBase::PROP_NULLABLE => false
),
'cached' => array(
ApiBase::PROP_TYPE => 'boolean',
ApiBase::PROP_NULLABLE => false
),
'cachedtimestamp' => array(
ApiBase::PROP_TYPE => 'timestamp',
ApiBase::PROP_NULLABLE => true
)
),
'' => array(
'value' => 'string',
'timestamp' => array(
ApiBase::PROP_TYPE => 'timestamp',
ApiBase::PROP_NULLABLE => true
),
'ns' => 'namespace',
'title' => 'string'
)
);
}
public function getDescription() {
return 'Get a list provided by a QueryPage-based special page';
}
public function getPossibleErrors() {
return array_merge( parent::getPossibleErrors(), array(
array( 'specialpage-cantexecute' )
) );
}
public function getExamples() {
return array(
'api.php?action=query&list=querypage&qppage=Ancientpages'
);
}
}
|
