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;
38 const LIMIT_BIG1
= 500; // Fast query, user's limit
39 const LIMIT_BIG2
= 5000; // Fast query, bot's limit
40 const LIMIT_SML1
= 50; // Slow query, user's limit
41 const LIMIT_SML2
= 500; // Slow query, bot's limit
43 private $mMainModule, $mModuleName, $mParamPrefix;
48 public function __construct($mainModule, $moduleName, $paramPrefix = '') {
49 $this->mMainModule
= $mainModule;
50 $this->mModuleName
= $moduleName;
51 $this->mParamPrefix
= $paramPrefix;
55 * Executes this module
57 public abstract function execute();
60 * Get the name of the module being executed by this instance
62 public function getModuleName() {
63 return $this->mModuleName
;
67 * Get the name of the module as shown in the profiler log
69 public function getModuleProfileName($db = false) {
71 return 'API:' . $this->mModuleName
. '-DB';
73 return 'API:' . $this->mModuleName
;
79 public function getMain() {
80 return $this->mMainModule
;
84 * If this module's $this is the same as $this->mMainModule, its the root, otherwise no
86 public function isMain() {
87 return $this === $this->mMainModule
;
93 public function getResult() {
94 // Main module has getResult() method overriden
95 // Safety - avoid infinite loop:
97 ApiBase
:: dieDebug(__METHOD__
, 'base method was called on main module. ');
98 return $this->getMain()->getResult();
102 * Get the result data array
104 public function & getResultData() {
105 return $this->getResult()->getData();
109 * If the module may only be used with a certain format module,
110 * it should override this method to return an instance of that formatter.
111 * A value of null means the default format will be used.
113 public function getCustomPrinter() {
118 * Generates help message for this module, or false if there is no description
120 public function makeHelpMsg() {
122 static $lnPrfx = "\n ";
124 $msg = $this->getDescription();
126 if ($msg !== false) {
132 $msg = $lnPrfx . implode($lnPrfx, $msg) . "\n";
135 $paramsMsg = $this->makeHelpMsgParameters();
136 if ($paramsMsg !== false) {
137 $msg .= "Parameters:\n$paramsMsg";
141 $examples = $this->getExamples();
142 if ($examples !== false) {
143 if (!is_array($examples))
147 $msg .= 'Example' . (count($examples) > 1 ?
's' : '') . ":\n ";
148 $msg .= implode($lnPrfx, $examples) . "\n";
151 if ($this->getMain()->getShowVersions()) {
152 $versions = $this->getVersion();
153 if (is_array($versions))
154 $versions = implode("\n ", $versions);
155 $msg .= "Version:\n $versions\n";
162 public function makeHelpMsgParameters() {
163 $params = $this->getAllowedParams();
164 if ($params !== false) {
166 $paramsDescription = $this->getParamDescription();
168 $paramPrefix = "\n" . str_repeat(' ', 19);
169 foreach ($params as $paramName => $paramSettings) {
170 $desc = isset ($paramsDescription[$paramName]) ?
$paramsDescription[$paramName] : '';
172 $desc = implode($paramPrefix, $desc);
173 if (isset ($paramSettings[self
:: PARAM_TYPE
])) {
174 $type = $paramSettings[self
:: PARAM_TYPE
];
175 if (is_array($type)) {
176 $desc .= $paramPrefix . 'Allowed values: ' . implode(', ', $type);
180 $default = is_array($paramSettings) ?
(isset ($paramSettings[self
:: PARAM_DFLT
]) ?
$paramSettings[self
:: PARAM_DFLT
] : null) : $paramSettings;
181 if (!is_null($default) && $default !== false)
182 $desc .= $paramPrefix . "Default: $default";
184 $msg .= sprintf(" %-14s - %s\n", $this->encodeParamName($paramName), $desc);
193 * Returns the description string for this module
195 protected function getDescription() {
200 * Returns usage examples for this module. Return null if no examples are available.
202 protected function getExamples() {
207 * Returns an array of allowed parameters (keys) => default value for that parameter
209 protected function getAllowedParams() {
214 * Returns the description string for the given parameter.
216 protected function getParamDescription() {
221 * This method mangles parameter name based on the prefix supplied to the constructor.
222 * Override this method to change parameter name during runtime
224 public function encodeParamName($paramName) {
225 return $this->mParamPrefix
. $paramName;
229 * Using getAllowedParams(), makes an array of the values provided by the user,
230 * with key being the name of the variable, and value - validated value from user or default.
231 * This method can be used to generate local variables using extract().
233 public function extractRequestParams() {
234 $params = $this->getAllowedParams();
237 foreach ($params as $paramName => $paramSettings)
238 $results[$paramName] = $this->getParameterFromSettings($paramName, $paramSettings);
244 * Get a value for the given parameter
246 protected function getParameter($paramName) {
247 $params = $this->getAllowedParams();
248 $paramSettings = $params[$paramName];
249 return $this->getParameterFromSettings($paramName, $paramSettings);
253 * Using the settings determine the value for the given parameter
254 * @param $paramName String: parameter name
255 * @param $paramSettings Mixed: default value or an array of settings using PARAM_* constants.
257 protected function getParameterFromSettings($paramName, $paramSettings) {
259 // Some classes may decide to change parameter names
260 $paramName = $this->encodeParamName($paramName);
262 if (!is_array($paramSettings)) {
263 $default = $paramSettings;
265 $type = gettype($paramSettings);
267 $default = isset ($paramSettings[self
:: PARAM_DFLT
]) ?
$paramSettings[self
:: PARAM_DFLT
] : null;
268 $multi = isset ($paramSettings[self
:: PARAM_ISMULTI
]) ?
$paramSettings[self
:: PARAM_ISMULTI
] : false;
269 $type = isset ($paramSettings[self
:: PARAM_TYPE
]) ?
$paramSettings[self
:: PARAM_TYPE
] : null;
271 // When type is not given, and no choices, the type is the same as $default
272 if (!isset ($type)) {
273 if (isset ($default))
274 $type = gettype($default);
276 $type = 'NULL'; // allow everything
280 if ($type == 'boolean') {
281 if (isset ($default) && $default !== false) {
282 // Having a default value of anything other than 'false' is pointless
283 ApiBase
:: dieDebug(__METHOD__
, "Boolean param $paramName's default is set to '$default'");
286 $value = $this->getMain()->getRequest()->getCheck($paramName);
288 $value = $this->getMain()->getRequest()->getVal($paramName, $default);
291 if (isset ($value) && ($multi ||
is_array($type)))
292 $value = $this->parseMultiValue($paramName, $value, $multi, is_array($type) ?
$type : null);
294 // More validation only when choices were not given
295 // choices were validated in parseMultiValue()
296 if (!is_array($type) && isset ($value)) {
299 case 'NULL' : // nothing to do
301 case 'string' : // nothing to do
303 case 'integer' : // Force everything using intval()
304 $value = is_array($value) ?
array_map('intval', $value) : intval($value);
307 if (!isset ($paramSettings[self
:: PARAM_MAX1
]) ||
!isset ($paramSettings[self
:: PARAM_MAX2
]))
308 ApiBase
:: dieDebug(__METHOD__
, "MAX1 or MAX2 are not defined for the limit $paramName");
310 ApiBase
:: dieDebug(__METHOD__
, "Multi-values not supported for $paramName");
311 $min = isset ($paramSettings[self
:: PARAM_MIN
]) ?
$paramSettings[self
:: PARAM_MIN
] : 0;
312 $value = intval($value);
313 $this->validateLimit($paramName, $value, $min, $paramSettings[self
:: PARAM_MAX1
], $paramSettings[self
:: PARAM_MAX2
]);
317 ApiBase
:: dieDebug(__METHOD__
, "Multi-values not supported for $paramName");
321 ApiBase
:: dieDebug(__METHOD__
, "Multi-values not supported for $paramName");
322 if (!preg_match('/^[0-9]{14}$/', $value)) {
323 $valueName = ""; // TODO: initialization
324 $this->dieUsage("Invalid value '$value' for timestamp parameter $paramName", "badtimestamp_{$valueName}");
328 ApiBase
:: dieDebug(__METHOD__
, "Param $paramName's type is unknown - $type");
333 // There should never be any duplicate values in a list
334 if (is_array($value))
335 $value = array_unique($value);
341 * Return an array of values that were given in a 'a|b|c' notation,
342 * after it optionally validates them against the list allowed values.
344 * @param valueName - The name of the parameter (for error reporting)
345 * @param value - The value being parsed
346 * @param allowMultiple - Can $value contain more than one value separated by '|'?
347 * @param allowedValues - An array of values to check against. If null, all values are accepted.
348 * @return (allowMultiple ? an_array_of_values : a_single_value)
350 protected function parseMultiValue($valueName, $value, $allowMultiple, $allowedValues) {
351 $valuesList = explode('|', $value);
352 if (!$allowMultiple && count($valuesList) != 1) {
353 $possibleValues = is_array($allowedValues) ?
"of '" . implode("', '", $allowedValues) . "'" : '';
354 $this->dieUsage("Only one $possibleValues is allowed for parameter '$valueName'", "multival_$valueName");
356 if (is_array($allowedValues)) {
357 $unknownValues = array_diff($valuesList, $allowedValues);
358 if ($unknownValues) {
359 $this->dieUsage('Unrecognised value' . (count($unknownValues) > 1 ?
"s" : "") . " for parameter '$valueName'", "unknown_$valueName");
363 return $allowMultiple ?
$valuesList : $valuesList[0];
367 * Validate the value against the minimum and user/bot maximum limits. Prints usage info on failure.
369 function validateLimit($varname, $value, $min, $max, $botMax) {
371 $this->dieUsage("$varname may not be less than $min (set to $value)", $varname);
374 if ($this->getMain()->isBot()) {
375 if ($value > $botMax) {
376 $this->dieUsage("$varname may not be over $botMax (set to $value) for bots", $varname);
379 elseif ($value > $max) {
380 $this->dieUsage("$varname may not be over $max (set to $value) for users", $varname);
385 * Call main module's error handler
387 public function dieUsage($description, $errorCode, $httpRespCode = 0) {
388 throw new UsageException($description, $this->encodeParamName($errorCode), $httpRespCode);
392 * Internal code errors should be reported with this method
394 protected static function dieDebug($method, $message) {
395 wfDebugDieBacktrace("Internal error in $method: $message");
399 * Profiling: total module execution time
401 private $mTimeIn = 0, $mModuleTime = 0;
404 * Start module profiling
406 public function profileIn() {
407 if ($this->mTimeIn
!== 0)
408 ApiBase
:: dieDebug(__METHOD__
, 'called twice without calling profileOut()');
409 $this->mTimeIn
= microtime(true);
410 wfProfileIn($this->getModuleProfileName());
414 * End module profiling
416 public function profileOut() {
417 if ($this->mTimeIn
=== 0)
418 ApiBase
:: dieDebug(__METHOD__
, 'called without calling profileIn() first');
419 if ($this->mDBTimeIn
!== 0)
420 ApiBase
:: dieDebug(__METHOD__
, 'must be called after database profiling is done with profileDBOut()');
422 $this->mModuleTime +
= microtime(true) - $this->mTimeIn
;
424 wfProfileOut($this->getModuleProfileName());
428 * When modules crash, sometimes it is needed to do a profileOut() regardless
429 * of the profiling state the module was in. This method does such cleanup.
431 public function safeProfileOut() {
432 if ($this->mTimeIn
!== 0) {
433 if ($this->mDBTimeIn
!== 0)
434 $this->profileDBOut();
440 * Total time the module was executed
442 public function getProfileTime() {
443 if ($this->mTimeIn
!== 0)
444 ApiBase
:: dieDebug(__METHOD__
, 'called without calling profileOut() first');
445 return $this->mModuleTime
;
449 * Profiling: database execution time
451 private $mDBTimeIn = 0, $mDBTime = 0;
454 * Start module profiling
456 public function profileDBIn() {
457 if ($this->mTimeIn
=== 0)
458 ApiBase
:: dieDebug(__METHOD__
, 'must be called while profiling the entire module with profileIn()');
459 if ($this->mDBTimeIn
!== 0)
460 ApiBase
:: dieDebug(__METHOD__
, 'called twice without calling profileDBOut()');
461 $this->mDBTimeIn
= microtime(true);
462 wfProfileIn($this->getModuleProfileName(true));
466 * End database profiling
468 public function profileDBOut() {
469 if ($this->mTimeIn
=== 0)
470 ApiBase
:: dieDebug(__METHOD__
, 'must be called while profiling the entire module with profileIn()');
471 if ($this->mDBTimeIn
=== 0)
472 ApiBase
:: dieDebug(__METHOD__
, 'called without calling profileDBIn() first');
474 $time = microtime(true) - $this->mDBTimeIn
;
475 $this->mDBTimeIn
= 0;
477 $this->mDBTime +
= $time;
478 $this->getMain()->mDBTime +
= $time;
479 wfProfileOut($this->getModuleProfileName(true));
483 * Total time the module used the database
485 public function getProfileDBTime() {
486 if ($this->mDBTimeIn
!== 0)
487 ApiBase
:: dieDebug(__METHOD__
, 'called without calling profileDBOut() first');
488 return $this->mDBTime
;
491 public abstract function getVersion();
493 public static function getBaseVersion() {
494 return __CLASS__
. ': $Id$';