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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
|
<?php
/**
*
*
* Created on Dec 01, 2007
*
* Copyright © 2008 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
*/
/**
* @ingroup API
*/
class ApiParamInfo extends ApiBase {
/**
* @var ApiQuery
*/
protected $queryObj;
public function __construct( ApiMain $main, $action ) {
parent::__construct( $main, $action );
$this->queryObj = new ApiQuery( $this->getMain(), 'query' );
}
public function execute() {
// Get parameters
$params = $this->extractRequestParams();
$resultObj = $this->getResult();
$res = array();
$this->addModulesInfo( $params, 'modules', $res, $resultObj );
$this->addModulesInfo( $params, 'querymodules', $res, $resultObj );
if ( $params['mainmodule'] ) {
$res['mainmodule'] = $this->getClassInfo( $this->getMain() );
}
if ( $params['pagesetmodule'] ) {
$pageSet = new ApiPageSet( $this->queryObj );
$res['pagesetmodule'] = $this->getClassInfo( $pageSet );
}
$this->addModulesInfo( $params, 'formatmodules', $res, $resultObj );
$resultObj->addValue( null, $this->getModuleName(), $res );
}
/**
* If the type is requested in parameters, adds a section to res with module info.
* @param array $params User parameters array
* @param string $type Parameter name
* @param array $res Store results in this array
* @param ApiResult $resultObj Results object to set indexed tag.
*/
private function addModulesInfo( $params, $type, &$res, $resultObj ) {
if ( !is_array( $params[$type] ) ) {
return;
}
$isQuery = ( $type === 'querymodules' );
if ( $isQuery ) {
$mgr = $this->queryObj->getModuleManager();
} else {
$mgr = $this->getMain()->getModuleManager();
}
$res[$type] = array();
foreach ( $params[$type] as $mod ) {
if ( !$mgr->isDefined( $mod ) ) {
$res[$type][] = array( 'name' => $mod, 'missing' => '' );
continue;
}
$obj = $mgr->getModule( $mod );
$item = $this->getClassInfo( $obj );
$item['name'] = $mod;
if ( $isQuery ) {
$item['querytype'] = $mgr->getModuleGroup( $mod );
}
$res[$type][] = $item;
}
$resultObj->setIndexedTagName( $res[$type], 'module' );
}
/**
* @param ApiBase $obj
* @return ApiResult
*/
private function getClassInfo( $obj ) {
$result = $this->getResult();
$retval['classname'] = get_class( $obj );
$retval['description'] = implode( "\n", (array)$obj->getFinalDescription() );
$retval['examples'] = '';
// version is deprecated since 1.21, but needs to be returned for v1
$retval['version'] = '';
$retval['prefix'] = $obj->getModulePrefix();
if ( $obj->isReadMode() ) {
$retval['readrights'] = '';
}
if ( $obj->isWriteMode() ) {
$retval['writerights'] = '';
}
if ( $obj->mustBePosted() ) {
$retval['mustbeposted'] = '';
}
if ( $obj instanceof ApiQueryGeneratorBase ) {
$retval['generator'] = '';
}
$allowedParams = $obj->getFinalParams( ApiBase::GET_VALUES_FOR_HELP );
if ( !is_array( $allowedParams ) ) {
return $retval;
}
$retval['helpurls'] = (array)$obj->getHelpUrls();
if ( isset( $retval['helpurls'][0] ) && $retval['helpurls'][0] === false ) {
$retval['helpurls'] = array();
}
$result->setIndexedTagName( $retval['helpurls'], 'helpurl' );
$examples = $obj->getExamples();
$retval['allexamples'] = array();
if ( $examples !== false ) {
if ( is_string( $examples ) ) {
$examples = array( $examples );
}
foreach ( $examples as $k => $v ) {
if ( strlen( $retval['examples'] ) ) {
$retval['examples'] .= ' ';
}
$item = array();
if ( is_numeric( $k ) ) {
$retval['examples'] .= $v;
ApiResult::setContent( $item, $v );
} else {
if ( !is_array( $v ) ) {
$item['description'] = $v;
} else {
$item['description'] = implode( $v, "\n" );
}
$retval['examples'] .= $item['description'] . ' ' . $k;
ApiResult::setContent( $item, $k );
}
$retval['allexamples'][] = $item;
}
}
$result->setIndexedTagName( $retval['allexamples'], 'example' );
$retval['parameters'] = array();
$paramDesc = $obj->getFinalParamDescription();
foreach ( $allowedParams as $n => $p ) {
$a = array( 'name' => $n );
if ( isset( $paramDesc[$n] ) ) {
$a['description'] = implode( "\n", (array)$paramDesc[$n] );
}
//handle shorthand
if ( !is_array( $p ) ) {
$p = array(
ApiBase::PARAM_DFLT => $p,
);
}
//handle missing type
if ( !isset( $p[ApiBase::PARAM_TYPE] ) ) {
$dflt = isset( $p[ApiBase::PARAM_DFLT] ) ? $p[ApiBase::PARAM_DFLT] : null;
if ( is_bool( $dflt ) ) {
$p[ApiBase::PARAM_TYPE] = 'boolean';
} elseif ( is_string( $dflt ) || is_null( $dflt ) ) {
$p[ApiBase::PARAM_TYPE] = 'string';
} elseif ( is_int( $dflt ) ) {
$p[ApiBase::PARAM_TYPE] = 'integer';
}
}
if ( isset( $p[ApiBase::PARAM_DEPRECATED] ) && $p[ApiBase::PARAM_DEPRECATED] ) {
$a['deprecated'] = '';
}
if ( isset( $p[ApiBase::PARAM_REQUIRED] ) && $p[ApiBase::PARAM_REQUIRED] ) {
$a['required'] = '';
}
if ( $n === 'token' && $obj->needsToken() ) {
$a['tokentype'] = $obj->needsToken();
}
if ( isset( $p[ApiBase::PARAM_DFLT] ) ) {
$type = $p[ApiBase::PARAM_TYPE];
if ( $type === 'boolean' ) {
$a['default'] = ( $p[ApiBase::PARAM_DFLT] ? 'true' : 'false' );
} elseif ( $type === 'string' ) {
$a['default'] = strval( $p[ApiBase::PARAM_DFLT] );
} elseif ( $type === 'integer' ) {
$a['default'] = intval( $p[ApiBase::PARAM_DFLT] );
} else {
$a['default'] = $p[ApiBase::PARAM_DFLT];
}
}
if ( isset( $p[ApiBase::PARAM_ISMULTI] ) && $p[ApiBase::PARAM_ISMULTI] ) {
$a['multi'] = '';
$a['limit'] = $this->getMain()->canApiHighLimits() ?
ApiBase::LIMIT_SML2 :
ApiBase::LIMIT_SML1;
$a['lowlimit'] = ApiBase::LIMIT_SML1;
$a['highlimit'] = ApiBase::LIMIT_SML2;
}
if ( isset( $p[ApiBase::PARAM_ALLOW_DUPLICATES] ) && $p[ApiBase::PARAM_ALLOW_DUPLICATES] ) {
$a['allowsduplicates'] = '';
}
if ( isset( $p[ApiBase::PARAM_TYPE] ) ) {
if ( $p[ApiBase::PARAM_TYPE] === 'submodule' ) {
$a['type'] = $obj->getModuleManager()->getNames( $n );
sort( $a['type'] );
$a['submodules'] = '';
} else {
$a['type'] = $p[ApiBase::PARAM_TYPE];
}
if ( is_array( $a['type'] ) ) {
// To prevent sparse arrays from being serialized to JSON as objects
$a['type'] = array_values( $a['type'] );
$result->setIndexedTagName( $a['type'], 't' );
}
}
if ( isset( $p[ApiBase::PARAM_MAX] ) ) {
$a['max'] = $p[ApiBase::PARAM_MAX];
}
if ( isset( $p[ApiBase::PARAM_MAX2] ) ) {
$a['highmax'] = $p[ApiBase::PARAM_MAX2];
}
if ( isset( $p[ApiBase::PARAM_MIN] ) ) {
$a['min'] = $p[ApiBase::PARAM_MIN];
}
$retval['parameters'][] = $a;
}
$result->setIndexedTagName( $retval['parameters'], 'param' );
return $retval;
}
public function isReadMode() {
return false;
}
public function getAllowedParams() {
$modules = $this->getMain()->getModuleManager()->getNames( 'action' );
sort( $modules );
$querymodules = $this->queryObj->getModuleManager()->getNames();
sort( $querymodules );
$formatmodules = $this->getMain()->getModuleManager()->getNames( 'format' );
sort( $formatmodules );
return array(
'modules' => array(
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_TYPE => $modules,
),
'querymodules' => array(
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_TYPE => $querymodules,
),
'mainmodule' => false,
'pagesetmodule' => false,
'formatmodules' => array(
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_TYPE => $formatmodules,
)
);
}
public function getParamDescription() {
return array(
'modules' => 'List of module names (value of the action= parameter)',
'querymodules' => 'List of query module names (value of prop=, meta= or list= parameter)',
'mainmodule' => 'Get information about the main (top-level) module as well',
'pagesetmodule' => 'Get information about the pageset module ' .
'(providing titles= and friends) as well',
'formatmodules' => 'List of format module names (value of format= parameter)',
);
}
public function getDescription() {
return 'Obtain information about certain API parameters and errors.';
}
public function getExamples() {
return array(
'api.php?action=paraminfo&modules=parse&querymodules=allpages|siteinfo'
);
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/API:Parameter_information';
}
}
|
