5 * Created on Sep 5, 2006
7 * API for MediaWiki 1.8+
9 * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, write to the Free Software Foundation, Inc.,
23 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 * http://www.gnu.org/copyleft/gpl.html
27 abstract class ApiBase
{
29 // These constants allow modules to specify exactly how to treat incomming parameters.
32 const PARAM_ISMULTI
= 1;
43 public function __construct($mainModule) {
44 $this->mMainModule
= $mainModule;
48 * Executes this module
50 public abstract function execute();
55 public function getMain() {
56 return $this->mMainModule
;
60 * If this module's $this is the same as $this->mMainModule, its the root, otherwise no
62 public function isMain() {
63 return $this === $this->mMainModule
;
69 public function getResult() {
70 // Main module has getResult() method overriden
71 // Safety - avoid infinite loop:
73 ApiBase
:: dieDebug(__METHOD__
, 'base method was called on main module. ');
74 return $this->getMain()->getResult();
78 * Get the result data array
80 public function & getResultData() {
81 return $this->getResult()->getData();
85 * Generates help message for this module, or false if there is no description
87 public function makeHelpMsg() {
89 static $lnPrfx = "\n ";
91 $msg = $this->getDescription();
99 $msg = $lnPrfx . implode($lnPrfx, $msg) . "\n";
102 $paramsMsg = $this->makeHelpMsgParameters();
103 if ($paramsMsg !== false) {
104 $msg .= "Parameters:\n$paramsMsg";
108 $examples = $this->getExamples();
109 if ($examples !== false) {
110 if (!is_array($examples))
114 $msg .= 'Example' . (count($examples) > 1 ?
's' : '') . ":\n ";
115 $msg .= implode($lnPrfx, $examples) . "\n";
118 if ($this->getMain()->getShowVersions()) {
119 $versions = $this->getVersion();
120 if (is_array($versions))
121 $versions = implode("\n ", $versions);
122 $msg .= "Version:\n $versions\n";
129 public function makeHelpMsgParameters() {
130 $params = $this->getAllowedParams();
131 if ($params !== false) {
133 $paramsDescription = $this->getParamDescription();
135 foreach (array_keys($params) as $paramName) {
136 $desc = isset ($paramsDescription[$paramName]) ?
$paramsDescription[$paramName] : '';
138 $desc = implode("\n" . str_repeat(' ', 19), $desc);
139 $msg .= sprintf(" %-14s - %s\n", $paramName, $desc);
148 * Returns the description string for this module
150 protected function getDescription() {
155 * Returns usage examples for this module. Return null if no examples are available.
157 protected function getExamples() {
162 * Returns an array of allowed parameters (keys) => default value for that parameter
164 protected function getAllowedParams() {
169 * Returns the description string for the given parameter.
171 protected function getParamDescription() {
176 * Using getAllowedParams(), makes an array of the values provided by the user,
177 * with key being the name of the variable, and value - validated value from user or default.
178 * This method can be used to generate local variables using extract().
180 * @param $prefix String: prepend this prefix to all parameter names.
182 public function extractRequestParams($prefix = '') {
183 $params = $this->getAllowedParams();
186 foreach ($params as $paramName => $paramSettings)
187 $results[$paramName] = $this->getParameterFromSettings($prefix . $paramName, $paramSettings);
192 protected function getParameter($paramName, $prefix = '') {
193 $params = $this->getAllowedParams();
194 $paramSettings = $params[$paramName];
195 return $this->getParameterFromSettings($prefix . $paramName, $paramSettings);
198 protected function getParameterFromSettings($paramName, $paramSettings) {
201 if (!is_array($paramSettings)) {
202 $default = $paramSettings;
204 $type = gettype($paramSettings);
206 $default = isset ($paramSettings[self
:: PARAM_DFLT
]) ?
$paramSettings[self
:: PARAM_DFLT
] : null;
207 $multi = isset ($paramSettings[self
:: PARAM_ISMULTI
]) ?
$paramSettings[self
:: PARAM_ISMULTI
] : false;
208 $type = isset ($paramSettings[self
:: PARAM_TYPE
]) ?
$paramSettings[self
:: PARAM_TYPE
] : null;
210 // When type is not given, and no choices, the type is the same as $default
211 if (!isset ($type)) {
212 if (isset ($default))
213 $type = gettype($default);
215 $type = 'NULL'; // allow everything
219 if ($type == 'boolean') {
220 if (isset ($default) && $default !== false) {
221 // Having a default value of anything other than 'false' is pointless
222 ApiBase
:: dieDebug(__METHOD__
, "Boolean param $paramName's default is set to '$default'");
225 $value = $wgRequest->getCheck($paramName);
227 $value = $wgRequest->getVal($paramName, $default);
229 if (isset ($value) && ($multi ||
is_array($type)))
230 $value = $this->parseMultiValue($paramName, $value, $multi, is_array($type) ?
$type : null);
232 // More validation only when choices were not given
233 // choices were validated in parseMultiValue()
234 if (!is_array($type) && isset ($value)) {
237 case 'NULL' : // nothing to do
239 case 'string' : // nothing to do
241 case 'integer' : // Force everything using intval()
242 $value = is_array($value) ?
array_map('intval', $value) : intval($value);
245 if (!isset ($paramSettings[self
:: PARAM_MAX1
]) ||
!isset ($paramSettings[self
:: PARAM_MAX2
]))
246 ApiBase
:: dieDebug(__METHOD__
, "MAX1 or MAX2 are not defined for the limit $paramName");
248 ApiBase
:: dieDebug(__METHOD__
, "Multi-values not supported for $paramName");
249 $min = isset ($paramSettings[self
:: PARAM_MIN
]) ?
$paramSettings[self
:: PARAM_MIN
] : 0;
250 $value = intval($value);
251 $this->validateLimit($paramName, $value, $min, $paramSettings[self
:: PARAM_MAX1
], $paramSettings[self
:: PARAM_MAX2
]);
255 ApiBase
:: dieDebug(__METHOD__
, "Multi-values not supported for $paramName");
259 ApiBase
:: dieDebug(__METHOD__
, "Multi-values not supported for $paramName");
260 if (!preg_match('/^[0-9]{14}$/', $value))
261 $this->dieUsage("Invalid value '$value' for timestamp parameter $paramName", "badtimestamp_{$valueName}");
264 ApiBase
:: dieDebug(__METHOD__
, "Param $paramName's type is unknown - $type");
273 * Return an array of values that were given in a 'a|b|c' notation,
274 * after it optionally validates them against the list allowed values.
276 * @param valueName - The name of the parameter (for error reporting)
277 * @param value - The value being parsed
278 * @param allowMultiple - Can $value contain more than one value separated by '|'?
279 * @param allowedValues - An array of values to check against. If null, all values are accepted.
280 * @return (allowMultiple ? an_array_of_values : a_single_value)
282 protected function parseMultiValue($valueName, $value, $allowMultiple, $allowedValues) {
283 $valuesList = explode('|', $value);
284 if (!$allowMultiple && count($valuesList) != 1) {
285 $possibleValues = is_array($allowedValues) ?
"of '" . implode("', '", $allowedValues) . "'" : '';
286 $this->dieUsage("Only one $possibleValues is allowed for parameter '$valueName'", "multival_$valueName");
288 if (is_array($allowedValues)) {
289 $unknownValues = array_diff($valuesList, $allowedValues);
290 if ($unknownValues) {
291 $this->dieUsage('Unrecognised value' . (count($unknownValues) > 1 ?
"s '" : " '") . implode("', '", $unknownValues) . "' for parameter '$valueName'", "unknown_$valueName");
295 return $allowMultiple ?
$valuesList : $valuesList[0];
299 * Validate the value against the minimum and user/bot maximum limits. Prints usage info on failure.
301 function validateLimit($varname, $value, $min, $max, $botMax) {
305 $this->dieUsage("$varname may not be less than $min (set to $value)", $varname);
308 if ($this->getMain()->isBot()) {
309 if ($value > $botMax) {
310 $this->dieUsage("$varname may not be over $botMax (set to $value) for bots", $varname);
313 elseif ($value > $max) {
314 $this->dieUsage("$varname may not be over $max (set to $value) for users", $varname);
319 * Call main module's error handler
321 public function dieUsage($description, $errorCode, $httpRespCode = 0) {
322 $this->getMain()->mainDieUsage($description, $errorCode, $httpRespCode);
326 * Internal code errors should be reported with this method
328 protected static function dieDebug($method, $message) {
329 wfDebugDieBacktrace("Internal error in $method: $message");
333 * Profiling: total module execution time
335 private $mTimeIn = 0, $mModuleTime = 0;
338 * Start module profiling
340 public function profileIn() {
341 if ($this->mTimeIn
!== 0)
342 ApiBase
:: dieDebug(__METHOD__
, 'called twice without calling profileOut()');
343 $this->mTimeIn
= microtime(true);
347 * End module profiling
349 public function profileOut() {
350 if ($this->mTimeIn
=== 0)
351 ApiBase
:: dieDebug(__METHOD__
, 'called without calling profileIn() first');
352 if ($this->mDBTimeIn
!== 0)
353 ApiBase
:: dieDebug(__METHOD__
, 'must be called after database profiling is done with profileDBOut()');
355 $this->mModuleTime +
= microtime(true) - $this->mTimeIn
;
360 * Total time the module was executed
362 public function getProfileTime() {
363 if ($this->mTimeIn
!== 0)
364 ApiBase
:: dieDebug(__METHOD__
, 'called without calling profileOut() first');
365 return $this->mModuleTime
;
369 * Profiling: database execution time
371 private $mDBTimeIn = 0, $mDBTime = 0;
374 * Start module profiling
376 public function profileDBIn() {
377 if ($this->mTimeIn
=== 0)
378 ApiBase
:: dieDebug(__METHOD__
, 'must be called while profiling the entire module with profileIn()');
379 if ($this->mDBTimeIn
!== 0)
380 ApiBase
:: dieDebug(__METHOD__
, 'called twice without calling profileDBOut()');
381 $this->mDBTimeIn
= microtime(true);
385 * End database profiling
387 public function profileDBOut() {
388 if ($this->mTimeIn
=== 0)
389 ApiBase
:: dieDebug(__METHOD__
, 'must be called while profiling the entire module with profileIn()');
390 if ($this->mDBTimeIn
=== 0)
391 ApiBase
:: dieDebug(__METHOD__
, 'called without calling profileDBIn() first');
393 $time = microtime(true) - $this->mDBTimeIn
;
394 $this->mDBTimeIn
= 0;
396 $this->mDBTime +
= $time;
397 $this->getMain()->mDBTime +
= $time;
401 * Total time the module used the database
403 public function getProfileDBTime() {
404 if ($this->mDBTimeIn
!== 0)
405 ApiBase
:: dieDebug(__METHOD__
, 'called without calling profileDBOut() first');
406 return $this->mDBTime
;
409 public abstract function getVersion();
411 public static function getBaseVersion() {
412 return __CLASS__
. ': $Id$';