includes/api/ApiBase.php

   1 <?php
   2
   3
   4 /*
   5  * Created on Sep 5, 2006
   6  *
   7  * API for MediaWiki 1.8+
   8  *
   9  * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
  10  *
  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.
  15  *
  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.
  20  *
  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
  25  */
  26
  27 abstract class ApiBase {
  28
  29         // These constants allow modules to specify exactly how to treat incomming parameters.
  30
  31         const PARAM_DFLT = 0;
  32         const PARAM_ISMULTI = 1;
  33         const PARAM_TYPE = 2;
  34         const PARAM_MAX1 = 3;
  35         const PARAM_MAX2 = 4;
  36         const PARAM_MIN = 5;
  37
  38         private $mMainModule;
  39
  40         /**
  41         * Constructor
  42         */
  43         public function __construct($mainModule) {
  44                 $this->mMainModule = $mainModule;
  45         }
  46
  47         /**
  48          * Executes this module
  49          */
  50         abstract function execute();
  51
  52         /**
  53          * Get main module
  54          */
  55         public function getMain() {
  56                 return $this->mMainModule;
  57         }
  58
  59         /**
  60          * If this module's $this is the same as $this->mMainModule, its the root, otherwise no
  61          */
  62         public function isMain() {
  63                 return $this === $this->mMainModule;
  64         }
  65
  66         /**
  67          * Get result object
  68          */
  69         public function getResult() {
  70                 // Main module has getResult() method overriden
  71                 // Safety - avoid infinite loop:
  72                 if ($this->isMain())
  73                         ApiBase :: dieDebug(__METHOD__, 'base method was called on main module. ');
  74                 return $this->getMain()->getResult();
  75         }
  76
  77         /**
  78          * Get the result data array
  79          */
  80         public function & getResultData() {
  81                 return $this->getResult()->getData();
  82         }
  83
  84         /**
  85          * Generates help message for this module, or false if there is no description
  86          */
  87         public function makeHelpMsg() {
  88
  89                 static $lnPrfx = "\n  ";
  90
  91                 $msg = $this->getDescription();
  92
  93                 if ($msg !== false) {
  94
  95                         if (!is_array($msg))
  96                                 $msg = array (
  97                                         $msg
  98                                 );
  99                         $msg = $lnPrfx . implode($lnPrfx, $msg) . "\n";
 100
 101                         // Parameters
 102                         $paramsMsg = $this->makeHelpMsgParameters();
 103                         if ($paramsMsg !== false) {
 104                                 $msg .= "Parameters:\n$paramsMsg";
 105                         }
 106
 107                         // Examples
 108                         $examples = $this->getExamples();
 109                         if ($examples !== false) {
 110                                 if (!is_array($examples))
 111                                         $examples = array (
 112                                                 $examples
 113                                         );
 114                                 $msg .= 'Example' . (count($examples) > 1 ? 's' : '') . ":\n  ";
 115                                 $msg .= implode($lnPrfx, $examples) . "\n";
 116                         }
 117                 }
 118
 119                 return $msg;
 120         }
 121
 122         public function makeHelpMsgParameters() {
 123                 $params = $this->getAllowedParams();
 124                 if ($params !== false) {
 125
 126                         $paramsDescription = $this->getParamDescription();
 127                         $msg = '';
 128                         foreach (array_keys($params) as $paramName) {
 129                                 $desc = isset ($paramsDescription[$paramName]) ? $paramsDescription[$paramName] : '';
 130                                 if (is_array($desc))
 131                                         $desc = implode("\n" . str_repeat(' ', 19), $desc);
 132                                 $msg .= sprintf("  %-14s - %s\n", $paramName, $desc);
 133                         }
 134                         return $msg;
 135
 136                 } else
 137                         return false;
 138         }
 139
 140         /**
 141          * Returns the description string for this module
 142          */
 143         protected function getDescription() {
 144                 return false;
 145         }
 146
 147         /**
 148          * Returns usage examples for this module. Return null if no examples are available.
 149          */
 150         protected function getExamples() {
 151                 return false;
 152         }
 153
 154         /**
 155          * Returns an array of allowed parameters (keys) => default value for that parameter
 156          */
 157         protected function getAllowedParams() {
 158                 return false;
 159         }
 160
 161         /**
 162          * Returns the description string for the given parameter.
 163          */
 164         protected function getParamDescription() {
 165                 return false;
 166         }
 167
 168         /**
 169         * Using getAllowedParams(), makes an array of the values provided by the user,
 170         * with key being the name of the variable, and value - validated value from user or default.
 171         * This method can be used to generate local variables using extract().
 172         */
 173         public function extractRequestParams() {
 174                 $params = $this->getAllowedParams();
 175                 $results = array ();
 176
 177                 foreach ($params as $paramName => $paramSettings)
 178                         $results[$paramName] = $this->getParameter($paramName, $paramSettings);
 179
 180                 return $results;
 181         }
 182
 183         public function getParameter($paramName, $paramSettings) {
 184                 global $wgRequest;
 185
 186                 if (!is_array($paramSettings)) {
 187                         $default = $paramSettings;
 188                         $multi = false;
 189                         $type = gettype($paramSettings);
 190                 } else {
 191                         $default = isset ($paramSettings[self :: PARAM_DFLT]) ? $paramSettings[self :: PARAM_DFLT] : null;
 192                         $multi = isset ($paramSettings[self :: PARAM_ISMULTI]) ? $paramSettings[self :: PARAM_ISMULTI] : false;
 193                         $type = isset ($paramSettings[self :: PARAM_TYPE]) ? $paramSettings[self :: PARAM_TYPE] : null;
 194
 195                         // When type is not given, and no choices, the type is the same as $default
 196                         if (!isset ($type)) {
 197                                 if (isset ($default))
 198                                         $type = gettype($default);
 199                                 else
 200                                         $type = 'NULL'; // allow everything
 201                         }
 202                 }
 203
 204                 if ($type == 'boolean') {
 205                         if (isset ($default) && $default !== false) {
 206                                 // Having a default value of anything other than 'false' is pointless
 207                                 ApiBase :: dieDebug(__METHOD__, "Boolean param $paramName's default is set to '$default'");
 208                         }
 209
 210                         $value = $wgRequest->getCheck($paramName);
 211                 } else
 212                         $value = $wgRequest->getVal($paramName, $default);
 213
 214                 if (isset ($value) && ($multi || is_array($type)))
 215                         $value = $this->parseMultiValue($paramName, $value, $multi, is_array($type) ? $type : null);
 216
 217                 // More validation only when choices were not given
 218                 // choices were validated in parseMultiValue()
 219                 if (!is_array($type) && isset ($value)) {
 220
 221                         switch ($type) {
 222                                 case 'NULL' : // nothing to do
 223                                         break;
 224                                 case 'string' : // nothing to do
 225                                         break;
 226                                 case 'integer' : // Force everything using intval()
 227                                         $value = is_array($value) ? array_map('intval', $value) : intval($value);
 228                                         break;
 229                                 case 'limit' :
 230                                         if (!isset ($paramSettings[self :: PARAM_MAX1]) || !isset ($paramSettings[self :: PARAM_MAX2]))
 231                                                 ApiBase :: dieDebug(__METHOD__, "MAX1 or MAX2 are not defined for the limit $paramName");
 232                                         if ($multi)
 233                                                 ApiBase :: dieDebug(__METHOD__, "Multi-values not supported for $paramName");
 234                                         $min = isset ($paramSettings[self :: PARAM_MIN]) ? $paramSettings[self :: PARAM_MIN] : 0;
 235                                         $value = intval($value);
 236                                         $this->validateLimit($paramName, $value, $min, $paramSettings[self :: PARAM_MAX1], $paramSettings[self :: PARAM_MAX2]);
 237                                         break;
 238                                 case 'boolean' :
 239                                         if ($multi)
 240                                                 ApiBase :: dieDebug(__METHOD__, "Multi-values not supported for $paramName");
 241                                         break;
 242                                 case 'timestamp' :
 243                                         if ($multi)
 244                                                 ApiBase :: dieDebug(__METHOD__, "Multi-values not supported for $paramName");
 245                                         if (!preg_match('/^[0-9]{14}$/', $value))
 246                                                 $this->dieUsage("Invalid value '$value' for timestamp parameter $paramName", "badtimestamp_{$valueName}");
 247                                         break;
 248                                 default :
 249                                         ApiBase :: dieDebug(__METHOD__, "Param $paramName's type is unknown - $type");
 250
 251                         }
 252                 }
 253
 254                 return $value;
 255         }
 256
 257         /**
 258         * Return an array of values that were given in a 'a|b|c' notation,
 259         * after it optionally validates them against the list allowed values.
 260         *
 261         * @param valueName - The name of the parameter (for error reporting)
 262         * @param value - The value being parsed
 263         * @param allowMultiple - Can $value contain more than one value separated by '|'?
 264         * @param allowedValues - An array of values to check against. If null, all values are accepted.
 265         * @return (allowMultiple ? an_array_of_values : a_single_value)
 266         */
 267         protected function parseMultiValue($valueName, $value, $allowMultiple, $allowedValues) {
 268                 $valuesList = explode('|', $value);
 269                 if (!$allowMultiple && count($valuesList) != 1) {
 270                         $possibleValues = is_array($allowedValues) ? "of '" . implode("', '", $allowedValues) . "'" : '';
 271                         $this->dieUsage("Only one $possibleValues is allowed for parameter '$valueName'", "multival_$valueName");
 272                 }
 273                 if (is_array($allowedValues)) {
 274                         $unknownValues = array_diff($valuesList, $allowedValues);
 275                         if ($unknownValues) {
 276                                 $this->dieUsage('Unrecognised value' . (count($unknownValues) > 1 ? "s '" : " '") . implode("', '", $unknownValues) . "' for parameter '$valueName'", "unknown_$valueName");
 277                         }
 278                 }
 279
 280                 return $allowMultiple ? $valuesList : $valuesList[0];
 281         }
 282
 283         /**
 284         * Validate the value against the minimum and user/bot maximum limits. Prints usage info on failure.
 285         */
 286         function validateLimit($varname, $value, $min, $max, $botMax) {
 287                 global $wgUser;
 288
 289                 if ($value < $min) {
 290                         $this->dieUsage("$varname may not be less than $min (set to $value)", $varname);
 291                 }
 292
 293                 if ($this->getMain()->isBot()) {
 294                         if ($value > $botMax) {
 295                                 $this->dieUsage("$varname may not be over $botMax (set to $value) for bots", $varname);
 296                         }
 297                 }
 298                 elseif ($value > $max) {
 299                         $this->dieUsage("$varname may not be over $max (set to $value) for users", $varname);
 300                 }
 301         }
 302
 303         /**
 304          * Call main module's error handler
 305          */
 306         public function dieUsage($description, $errorCode, $httpRespCode = 0) {
 307                 $this->getMain()->mainDieUsage($description, $errorCode, $httpRespCode);
 308         }
 309
 310         /**
 311          * Internal code errors should be reported with this method
 312          */
 313         protected static function dieDebug($method, $message) {
 314                 wfDebugDieBacktrace("Internal error in $method: $message");
 315         }
 316
 317         /**
 318          * Profiling: total module execution time
 319          */
 320         private $mTimeIn = 0, $mModuleTime = 0;
 321
 322         /**
 323          * Start module profiling
 324          */
 325         public function profileIn() {
 326                 if ($this->mTimeIn !== 0)
 327                         ApiBase :: dieDebug(__METHOD__, 'called twice without calling profileOut()');
 328                 $this->mTimeIn = microtime(true);
 329         }
 330
 331         /**
 332          * End module profiling
 333          */
 334         public function profileOut() {
 335                 if ($this->mTimeIn === 0)
 336                         ApiBase :: dieDebug(__METHOD__, 'called without calling profileIn() first');
 337                 if ($this->mDBTimeIn !== 0)
 338                         ApiBase :: dieDebug(__METHOD__, 'must be called after database profiling is done with profileDBOut()');
 339
 340                 $this->mModuleTime += microtime(true) - $this->mTimeIn;
 341                 $this->mTimeIn = 0;
 342         }
 343
 344         /**
 345          * Total time the module was executed
 346          */
 347         public function getProfileTime() {
 348                 if ($this->mTimeIn !== 0)
 349                         ApiBase :: dieDebug(__METHOD__, 'called without calling profileOut() first');
 350                 return $this->mModuleTime;
 351         }
 352
 353         /**
 354          * Profiling: database execution time
 355          */
 356         private $mDBTimeIn = 0, $mDBTime = 0;
 357
 358         /**
 359          * Start module profiling
 360          */
 361         public function profileDBIn() {
 362                 if ($this->mTimeIn === 0)
 363                         ApiBase :: dieDebug(__METHOD__, 'must be called while profiling the entire module with profileIn()');
 364                 if ($this->mDBTimeIn !== 0)
 365                         ApiBase :: dieDebug(__METHOD__, 'called twice without calling profileDBOut()');
 366                 $this->mDBTimeIn = microtime(true);
 367         }
 368
 369         /**
 370          * End database profiling
 371          */
 372         public function profileDBOut() {
 373                 if ($this->mTimeIn === 0)
 374                         ApiBase :: dieDebug(__METHOD__, 'must be called while profiling the entire module with profileIn()');
 375                 if ($this->mDBTimeIn === 0)
 376                         ApiBase :: dieDebug(__METHOD__, 'called without calling profileDBIn() first');
 377
 378                 $time = microtime(true) - $this->mDBTimeIn;
 379                 $this->mDBTimeIn = 0;
 380
 381                 $this->mDBTime += $time;
 382                 $this->getMain()->mDBTime += $time;
 383         }
 384
 385         /**
 386          * Total time the module used the database
 387          */
 388         public function getProfileDBTime() {
 389                 if ($this->mDBTimeIn !== 0)
 390                         ApiBase :: dieDebug(__METHOD__, 'called without calling profileDBOut() first');
 391                 return $this->mDBTime;
 392         }
 393 }
 394 ?>