includes/api/ApiBase.php

   1 <?php
   2 /**
   3  * API for MediaWiki 1.8+
   4  *
   5  * Created on Sep 5, 2006
   6  *
   7  * Copyright © 2006, 2010 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 /**
  28  * This abstract class implements many basic API functions, and is the base of
  29  * all API classes.
  30  * The class functions are divided into several areas of functionality:
  31  *
  32  * Module parameters: Derived classes can define getAllowedParams() to specify
  33  *      which parameters to expect,h ow to parse and validate them.
  34  *
  35  * Profiling: various methods to allow keeping tabs on various tasks and their
  36  *      time costs
  37  *
  38  * Self-documentation: code to allow the API to document its own state
  39  *
  40  * @ingroup API
  41  */
  42 abstract class ApiBase {
  43
  44         // These constants allow modules to specify exactly how to treat incoming parameters.
  45
  46         const PARAM_DFLT = 0; // Default value of the parameter
  47         const PARAM_ISMULTI = 1; // Boolean, do we accept more than one item for this parameter (e.g.: titles)?
  48         const PARAM_TYPE = 2; // Can be either a string type (e.g.: 'integer') or an array of allowed values
  49         const PARAM_MAX = 3; // Max value allowed for a parameter. Only applies if TYPE='integer'
  50         const PARAM_MAX2 = 4; // Max value allowed for a parameter for bots and sysops. Only applies if TYPE='integer'
  51         const PARAM_MIN = 5; // Lowest value allowed for a parameter. Only applies if TYPE='integer'
  52         const PARAM_ALLOW_DUPLICATES = 6; // Boolean, do we allow the same value to be set more than once when ISMULTI=true
  53         const PARAM_DEPRECATED = 7; // Boolean, is the parameter deprecated (will show a warning)
  54         const PARAM_REQUIRED = 8; // Boolean, is the parameter required?
  55         const PARAM_RANGE_ENFORCE = 9; // Boolean, if MIN/MAX are set, enforce (die) these? Only applies if TYPE='integer' Use with extreme caution
  56
  57         const LIMIT_BIG1 = 500; // Fast query, std user limit
  58         const LIMIT_BIG2 = 5000; // Fast query, bot/sysop limit
  59         const LIMIT_SML1 = 50; // Slow query, std user limit
  60         const LIMIT_SML2 = 500; // Slow query, bot/sysop limit
  61
  62         private $mMainModule, $mModuleName, $mModulePrefix;
  63         private $mParamCache = array();
  64
  65         /**
  66          * Constructor
  67          * @param $mainModule ApiMain object
  68          * @param $moduleName string Name of this module
  69          * @param $modulePrefix string Prefix to use for parameter names
  70          */
  71         public function __construct( $mainModule, $moduleName, $modulePrefix = '' ) {
  72                 $this->mMainModule = $mainModule;
  73                 $this->mModuleName = $moduleName;
  74                 $this->mModulePrefix = $modulePrefix;
  75         }
  76
  77         /*****************************************************************************
  78          * ABSTRACT METHODS                                                          *
  79          *****************************************************************************/
  80
  81         /**
  82          * Evaluates the parameters, performs the requested query, and sets up
  83          * the result. Concrete implementations of ApiBase must override this
  84          * method to provide whatever functionality their module offers.
  85          * Implementations must not produce any output on their own and are not
  86          * expected to handle any errors.
  87          *
  88          * The execute() method will be invoked directly by ApiMain immediately
  89          * before the result of the module is output. Aside from the
  90          * constructor, implementations should assume that no other methods
  91          * will be called externally on the module before the result is
  92          * processed.
  93          *
  94          * The result data should be stored in the ApiResult object available
  95          * through getResult().
  96          */
  97         public abstract function execute();
  98
  99         /**
 100          * Returns a string that identifies the version of the extending class.
 101          * Typically includes the class name, the svn revision, timestamp, and
 102          * last author. Usually done with SVN's Id keyword
 103          * @return string
 104          */
 105         public abstract function getVersion();
 106
 107         /**
 108          * Get the name of the module being executed by this instance
 109          * @return string
 110          */
 111         public function getModuleName() {
 112                 return $this->mModuleName;
 113         }
 114
 115         /**
 116          * Get parameter prefix (usually two letters or an empty string).
 117          * @return string
 118          */
 119         public function getModulePrefix() {
 120                 return $this->mModulePrefix;
 121         }
 122
 123         /**
 124          * Get the name of the module as shown in the profiler log
 125          * @return string
 126          */
 127         public function getModuleProfileName( $db = false ) {
 128                 if ( $db ) {
 129                         return 'API:' . $this->mModuleName . '-DB';
 130                 } else {
 131                         return 'API:' . $this->mModuleName;
 132                 }
 133         }
 134
 135         /**
 136          * Get the main module
 137          * @return ApiMain object
 138          */
 139         public function getMain() {
 140                 return $this->mMainModule;
 141         }
 142
 143         /**
 144          * Returns true if this module is the main module ($this === $this->mMainModule),
 145          * false otherwise.
 146          * @return bool
 147          */
 148         public function isMain() {
 149                 return $this === $this->mMainModule;
 150         }
 151
 152         /**
 153          * Get the result object
 154          * @return ApiResult
 155          */
 156         public function getResult() {
 157                 // Main module has getResult() method overriden
 158                 // Safety - avoid infinite loop:
 159                 if ( $this->isMain() ) {
 160                         ApiBase::dieDebug( __METHOD__, 'base method was called on main module. ' );
 161                 }
 162                 return $this->getMain()->getResult();
 163         }
 164
 165         /**
 166          * Get the result data array (read-only)
 167          * @return array
 168          */
 169         public function getResultData() {
 170                 return $this->getResult()->getData();
 171         }
 172
 173         /**
 174          * Set warning section for this module. Users should monitor this
 175          * section to notice any changes in API. Multiple calls to this
 176          * function will result in the warning messages being separated by
 177          * newlines
 178          * @param $warning string Warning message
 179          */
 180         public function setWarning( $warning ) {
 181                 $data = $this->getResult()->getData();
 182                 if ( isset( $data['warnings'][$this->getModuleName()] ) ) {
 183                         // Don't add duplicate warnings
 184                         $warn_regex = preg_quote( $warning, '/' );
 185                         if ( preg_match( "/{$warn_regex}(\\n|$)/", $data['warnings'][$this->getModuleName()]['*'] ) ) {
 186                                 return;
 187                         }
 188                         $oldwarning = $data['warnings'][$this->getModuleName()]['*'];
 189                         // If there is a warning already, append it to the existing one
 190                         $warning = "$oldwarning\n$warning";
 191                         $this->getResult()->unsetValue( 'warnings', $this->getModuleName() );
 192                 }
 193                 $msg = array();
 194                 ApiResult::setContent( $msg, $warning );
 195                 $this->getResult()->disableSizeCheck();
 196                 $this->getResult()->addValue( 'warnings', $this->getModuleName(), $msg );
 197                 $this->getResult()->enableSizeCheck();
 198         }
 199
 200         /**
 201          * If the module may only be used with a certain format module,
 202          * it should override this method to return an instance of that formatter.
 203          * A value of null means the default format will be used.
 204          * @return mixed instance of a derived class of ApiFormatBase, or null
 205          */
 206         public function getCustomPrinter() {
 207                 return null;
 208         }
 209
 210         /**
 211          * Generates help message for this module, or false if there is no description
 212          * @return mixed string or false
 213          */
 214         public function makeHelpMsg() {
 215                 static $lnPrfx = "\n  ";
 216
 217                 $msg = $this->getDescription();
 218
 219                 if ( $msg !== false ) {
 220
 221                         if ( !is_array( $msg ) ) {
 222                                 $msg = array(
 223                                         $msg
 224                                 );
 225                         }
 226                         $msg = $lnPrfx . implode( $lnPrfx, $msg ) . "\n";
 227
 228                         if ( $this->isReadMode() ) {
 229                                 $msg .= "\nThis module requires read rights";
 230                         }
 231                         if ( $this->isWriteMode() ) {
 232                                 $msg .= "\nThis module requires write rights";
 233                         }
 234                         if ( $this->mustBePosted() ) {
 235                                 $msg .= "\nThis module only accepts POST requests";
 236                         }
 237                         if ( $this->isReadMode() || $this->isWriteMode() ||
 238                                         $this->mustBePosted() )
 239                         {
 240                                 $msg .= "\n";
 241                         }
 242
 243                         // Parameters
 244                         $paramsMsg = $this->makeHelpMsgParameters();
 245                         if ( $paramsMsg !== false ) {
 246                                 $msg .= "Parameters:\n$paramsMsg";
 247                         }
 248
 249                         // Examples
 250                         $examples = $this->getExamples();
 251                         if ( $examples !== false ) {
 252                                 if ( !is_array( $examples ) ) {
 253                                         $examples = array(
 254                                                 $examples
 255                                         );
 256                                 }
 257
 258                                 if ( count( $examples ) > 0 ) {
 259                                         $msg .= 'Example' . ( count( $examples ) > 1 ? 's' : '' ) . ":\n  ";
 260                                         $msg .= implode( $lnPrfx, $examples ) . "\n";
 261                                 }
 262                         }
 263
 264                         if ( $this->getMain()->getShowVersions() ) {
 265                                 $versions = $this->getVersion();
 266                                 $pattern = '/(\$.*) ([0-9a-z_]+\.php) (.*\$)/i';
 267                                 $callback = array( $this, 'makeHelpMsg_callback' );
 268
 269                                 if ( is_array( $versions ) ) {
 270                                         foreach ( $versions as &$v ) {
 271                                                 $v = preg_replace_callback( $pattern, $callback, $v );
 272                                         }
 273                                         $versions = implode( "\n  ", $versions );
 274                                 } else {
 275                                         $versions = preg_replace_callback( $pattern, $callback, $versions );
 276                                 }
 277
 278                                 $msg .= "Version:\n  $versions\n";
 279                         }
 280                 }
 281
 282                 return $msg;
 283         }
 284
 285         /**
 286          * Generates the parameter descriptions for this module, to be displayed in the
 287          * module's help.
 288          * @return string
 289          */
 290         public function makeHelpMsgParameters() {
 291                 $params = $this->getFinalParams();
 292                 if ( $params ) {
 293
 294                         $paramsDescription = $this->getFinalParamDescription();
 295                         $msg = '';
 296                         $paramPrefix = "\n" . str_repeat( ' ', 19 );
 297                         foreach ( $params as $paramName => $paramSettings ) {
 298                                 $desc = isset( $paramsDescription[$paramName] ) ? $paramsDescription[$paramName] : '';
 299                                 if ( is_array( $desc ) ) {
 300                                         $desc = implode( $paramPrefix, $desc );
 301                                 }
 302
 303                                 if ( !is_array( $paramSettings ) ) {
 304                                         $paramSettings = array(
 305                                                 self::PARAM_DFLT => $paramSettings,
 306                                         );
 307                                 }
 308
 309                                 $deprecated = isset( $paramSettings[self::PARAM_DEPRECATED] ) ?
 310                                         $paramSettings[self::PARAM_DEPRECATED] : false;
 311                                 if ( $deprecated ) {
 312                                         $desc = "DEPRECATED! $desc";
 313                                 }
 314
 315                                 $required = isset( $paramSettings[self::PARAM_REQUIRED] ) ?
 316                                         $paramSettings[self::PARAM_REQUIRED] : false;
 317                                 if ( $required ) {
 318                                         $desc .= $paramPrefix . "This parameter is required";
 319                                 }
 320
 321                                 $type = isset( $paramSettings[self::PARAM_TYPE] ) ? $paramSettings[self::PARAM_TYPE] : null;
 322                                 if ( isset( $type ) ) {
 323                                         if ( isset( $paramSettings[self::PARAM_ISMULTI] ) ) {
 324                                                 $prompt = 'Values (separate with \'|\'): ';
 325                                         } else {
 326                                                 $prompt = 'One value: ';
 327                                         }
 328
 329                                         if ( is_array( $type ) ) {
 330                                                 $choices = array();
 331                                                 $nothingPrompt = false;
 332                                                 foreach ( $type as $t ) {
 333                                                         if ( $t === '' ) {
 334                                                                 $nothingPrompt = 'Can be empty, or ';
 335                                                         } else {
 336                                                                 $choices[] =  $t;
 337                                                         }
 338                                                 }
 339                                                 $desc .= $paramPrefix . $nothingPrompt . $prompt . implode( ', ', $choices );
 340                                         } else {
 341                                                 switch ( $type ) {
 342                                                         case 'namespace':
 343                                                                 // Special handling because namespaces are type-limited, yet they are not given
 344                                                                 $desc .= $paramPrefix . $prompt . implode( ', ', MWNamespace::getValidNamespaces() );
 345                                                                 break;
 346                                                         case 'limit':
 347                                                                 $desc .= $paramPrefix . "No more than {$paramSettings[self :: PARAM_MAX]}";
 348                                                                 if ( isset( $paramSettings[self::PARAM_MAX2] ) ) {
 349                                                                         $desc .= " ({$paramSettings[self::PARAM_MAX2]} for bots)";
 350                                                                 }
 351                                                                 $desc .= ' allowed';
 352                                                                 break;
 353                                                         case 'integer':
 354                                                                 $hasMin = isset( $paramSettings[self::PARAM_MIN] );
 355                                                                 $hasMax = isset( $paramSettings[self::PARAM_MAX] );
 356                                                                 if ( $hasMin || $hasMax ) {
 357                                                                         if ( !$hasMax ) {
 358                                                                                 $intRangeStr = "The value must be no less than {$paramSettings[self::PARAM_MIN]}";
 359                                                                         } elseif ( !$hasMin ) {
 360                                                                                 $intRangeStr = "The value must be no more than {$paramSettings[self::PARAM_MAX]}";
 361                                                                         } else {
 362                                                                                 $intRangeStr = "The value must be between {$paramSettings[self::PARAM_MIN]} and {$paramSettings[self::PARAM_MAX]}";
 363                                                                         }
 364
 365                                                                         $desc .= $paramPrefix . $intRangeStr;
 366                                                                 }
 367                                                                 break;
 368                                                 }
 369
 370                                                 if ( isset( $paramSettings[self::PARAM_ISMULTI] ) ) {
 371                                                         $isArray = is_array( $paramSettings[self::PARAM_TYPE] );
 372
 373                                                         if ( !$isArray
 374                                                                         || $isArray && count( $paramSettings[self::PARAM_TYPE] ) > self::LIMIT_SML1) {
 375                                                                 $desc .= $paramPrefix . "Maximum number of values " .
 376                                                                         self::LIMIT_SML1 . " (" . self::LIMIT_SML2 . " for bots)";
 377                                                         }
 378                                                 }
 379                                         }
 380                                 }
 381
 382                                 $default = is_array( $paramSettings )
 383                                                 ? ( isset( $paramSettings[self::PARAM_DFLT] ) ? $paramSettings[self::PARAM_DFLT] : null )
 384                                                 : $paramSettings;
 385                                 if ( !is_null( $default ) && $default !== false ) {
 386                                         $desc .= $paramPrefix . "Default: $default";
 387                                 }
 388
 389                                 $msg .= sprintf( "  %-14s - %s\n", $this->encodeParamName( $paramName ), $desc );
 390                         }
 391                         return $msg;
 392
 393                 } else {
 394                         return false;
 395                 }
 396         }
 397
 398         /**
 399          * Callback for preg_replace_callback() call in makeHelpMsg().
 400          * Replaces a source file name with a link to ViewVC
 401          */
 402         public function makeHelpMsg_callback( $matches ) {
 403                 global $wgAutoloadClasses, $wgAutoloadLocalClasses;
 404                 if ( isset( $wgAutoloadLocalClasses[get_class( $this )] ) ) {
 405                         $file = $wgAutoloadLocalClasses[get_class( $this )];
 406                 } elseif ( isset( $wgAutoloadClasses[get_class( $this )] ) ) {
 407                         $file = $wgAutoloadClasses[get_class( $this )];
 408                 }
 409
 410                 // Do some guesswork here
 411                 $path = strstr( $file, 'includes/api/' );
 412                 if ( $path === false ) {
 413                         $path = strstr( $file, 'extensions/' );
 414                 } else {
 415                         $path = 'phase3/' . $path;
 416                 }
 417
 418                 // Get the filename from $matches[2] instead of $file
 419                 // If they're not the same file, they're assumed to be in the
 420                 // same directory
 421                 // This is necessary to make stuff like ApiMain::getVersion()
 422                 // returning the version string for ApiBase work
 423                 if ( $path ) {
 424                         return "{$matches[0]}\n   http://svn.wikimedia.org/" .
 425                                 "viewvc/mediawiki/trunk/" . dirname( $path ) .
 426                                 "/{$matches[2]}";
 427                 }
 428                 return $matches[0];
 429         }
 430
 431         /**
 432          * Returns the description string for this module
 433          * @return mixed string or array of strings
 434          */
 435         protected function getDescription() {
 436                 return false;
 437         }
 438
 439         /**
 440          * Returns usage examples for this module. Return null if no examples are available.
 441          * @return mixed string or array of strings
 442          */
 443         protected function getExamples() {
 444                 return false;
 445         }
 446
 447         /**
 448          * Returns an array of allowed parameters (parameter name) => (default
 449          * value) or (parameter name) => (array with PARAM_* constants as keys)
 450          * Don't call this function directly: use getFinalParams() to allow
 451          * hooks to modify parameters as needed.
 452          * @return array
 453          */
 454         protected function getAllowedParams() {
 455                 return false;
 456         }
 457
 458         /**
 459          * Returns an array of parameter descriptions.
 460          * Don't call this functon directly: use getFinalParamDescription() to
 461          * allow hooks to modify descriptions as needed.
 462          * @return array
 463          */
 464         protected function getParamDescription() {
 465                 return false;
 466         }
 467
 468         /**
 469          * Get final list of parameters, after hooks have had a chance to
 470          * tweak it as needed.
 471          * @return array
 472          */
 473         public function getFinalParams() {
 474                 $params = $this->getAllowedParams();
 475                 wfRunHooks( 'APIGetAllowedParams', array( &$this, &$params ) );
 476                 return $params;
 477         }
 478
 479         /**
 480          * Get final description, after hooks have had a chance to tweak it as
 481          * needed.
 482          * @return array
 483          */
 484         public function getFinalParamDescription() {
 485                 $desc = $this->getParamDescription();
 486                 wfRunHooks( 'APIGetParamDescription', array( &$this, &$desc ) );
 487                 return $desc;
 488         }
 489
 490         /**
 491          * This method mangles parameter name based on the prefix supplied to the constructor.
 492          * Override this method to change parameter name during runtime
 493          * @param $paramName string Parameter name
 494          * @return string Prefixed parameter name
 495          */
 496         public function encodeParamName( $paramName ) {
 497                 return $this->mModulePrefix . $paramName;
 498         }
 499
 500         /**
 501          * Using getAllowedParams(), this function makes an array of the values
 502          * provided by the user, with key being the name of the variable, and
 503          * value - validated value from user or default. limits will not be
 504          * parsed if $parseLimit is set to false; use this when the max
 505          * limit is not definitive yet, e.g. when getting revisions.
 506          * @param $parseLimit Boolean: true by default
 507          * @return array
 508          */
 509         public function extractRequestParams( $parseLimit = true ) {
 510                 // Cache parameters, for performance and to avoid bug 24564.
 511                 if ( !isset( $this->mParamCache[$parseLimit] ) ) {
 512                         $params = $this->getFinalParams();
 513                         $results = array();
 514
 515                         if ( $params ) { // getFinalParams() can return false
 516                                 foreach ( $params as $paramName => $paramSettings ) {
 517                                         $results[$paramName] = $this->getParameterFromSettings(
 518                                                 $paramName, $paramSettings, $parseLimit );
 519                                 }
 520                         }
 521                         $this->mParamCache[$parseLimit] = $results;
 522                 }
 523                 return $this->mParamCache[$parseLimit];
 524         }
 525
 526         /**
 527          * Get a value for the given parameter
 528          * @param $paramName string Parameter name
 529          * @param $parseLimit bool see extractRequestParams()
 530          * @return mixed Parameter value
 531          */
 532         protected function getParameter( $paramName, $parseLimit = true ) {
 533                 $params = $this->getFinalParams();
 534                 $paramSettings = $params[$paramName];
 535                 return $this->getParameterFromSettings( $paramName, $paramSettings, $parseLimit );
 536         }
 537
 538         /**
 539          * Die if none or more than one of a certain set of parameters is set and not false.
 540          * @param $params array of parameter names
 541          */
 542         public function requireOnlyOneParameter( $params ) {
 543                 $required = func_get_args();
 544                 array_shift( $required );
 545
 546                 $intersection = array_intersect( array_keys( array_filter( $params,
 547                                 array( $this, "parameterNotEmpty" ) ) ), $required );
 548
 549                 if ( count( $intersection ) > 1 ) {
 550                         $this->dieUsage( 'The parameters ' . implode( ', ', $intersection ) . ' can not be used together', 'invalidparammix' );
 551                 } elseif ( count( $intersection ) == 0 ) {
 552                         $this->dieUsage( 'One of the parameters ' . implode( ', ', $required ) . ' is required', 'missingparam' );
 553                 }
 554         }
 555
 556         /**
 557          * Callback function used in requireOnlyOneParameter to check whether reequired parameters are set
 558          *
 559          * @param  $x object Parameter to check is not null/false
 560          * @return bool
 561          */
 562         private function parameterNotEmpty( $x ) {
 563                 return !is_null( $x ) && $x !== false;
 564         }
 565
 566         /**
 567          * @deprecated use MWNamespace::getValidNamespaces()
 568          */
 569         public static function getValidNamespaces() {
 570                 return MWNamespace::getValidNamespaces();
 571         }
 572
 573         /**
 574          * Return true if we're to watch the page, false if not, null if no change.
 575          * @param $watchlist String Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
 576          * @param $titleObj Title the page under consideration
 577          * @param $userOption String The user option to consider when $watchlist=preferences.
 578          *      If not set will magically default to either watchdefault or watchcreations
 579          * @returns mixed
 580          */
 581         protected function getWatchlistValue ( $watchlist, $titleObj, $userOption = null ) {
 582                 global $wgUser;
 583                 switch ( $watchlist ) {
 584                         case 'watch':
 585                                 return true;
 586
 587                         case 'unwatch':
 588                                 return false;
 589
 590                         case 'preferences':
 591                                 # If the user is already watching, don't bother checking
 592                                 if ( $titleObj->userIsWatching() ) {
 593                                         return null;
 594                                 }
 595                                 # If no user option was passed, use watchdefault or watchcreation
 596                                 if ( is_null( $userOption ) ) {
 597                                         $userOption = $titleObj->exists()
 598                                                 ? 'watchdefault' : 'watchcreations';
 599                                 }
 600                                 # If the corresponding user option is true, watch, else no change
 601                                 return $wgUser->getOption( $userOption ) ? true : null;
 602
 603                         case 'nochange':
 604                                 return null;
 605
 606                         default:
 607                                 return null;
 608                 }
 609         }
 610
 611         /**
 612          * Set a watch (or unwatch) based the based on a watchlist parameter.
 613          * @param $watch String Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
 614          * @param $titleObj Title the article's title to change
 615          * @param $userOption String The user option to consider when $watch=preferences
 616          */
 617         protected function setWatch ( $watch, $titleObj, $userOption = null ) {
 618                 $value = $this->getWatchlistValue( $watch, $titleObj, $userOption );
 619                 if ( $value === null ) {
 620                         return;
 621                 }
 622
 623                 $articleObj = new Article( $titleObj );
 624                 if ( $value ) {
 625                         $articleObj->doWatch();
 626                 } else {
 627                         $articleObj->doUnwatch();
 628                 }
 629         }
 630
 631         /**
 632          * Using the settings determine the value for the given parameter
 633          *
 634          * @param $paramName String: parameter name
 635          * @param $paramSettings Mixed: default value or an array of settings
 636          *  using PARAM_* constants.
 637          * @param $parseLimit Boolean: parse limit?
 638          * @return mixed Parameter value
 639          */
 640         protected function getParameterFromSettings( $paramName, $paramSettings, $parseLimit ) {
 641                 // Some classes may decide to change parameter names
 642                 $encParamName = $this->encodeParamName( $paramName );
 643
 644                 if ( !is_array( $paramSettings ) ) {
 645                         $default = $paramSettings;
 646                         $multi = false;
 647                         $type = gettype( $paramSettings );
 648                         $dupes = false;
 649                         $deprecated = false;
 650                         $required = false;
 651                 } else {
 652                         $default = isset( $paramSettings[self::PARAM_DFLT] ) ? $paramSettings[self::PARAM_DFLT] : null;
 653                         $multi = isset( $paramSettings[self::PARAM_ISMULTI] ) ? $paramSettings[self::PARAM_ISMULTI] : false;
 654                         $type = isset( $paramSettings[self::PARAM_TYPE] ) ? $paramSettings[self::PARAM_TYPE] : null;
 655                         $dupes = isset( $paramSettings[self::PARAM_ALLOW_DUPLICATES] ) ? $paramSettings[self::PARAM_ALLOW_DUPLICATES] : false;
 656                         $deprecated = isset( $paramSettings[self::PARAM_DEPRECATED] ) ? $paramSettings[self::PARAM_DEPRECATED] : false;
 657                         $required = isset( $paramSettings[self::PARAM_REQUIRED] ) ? $paramSettings[self::PARAM_REQUIRED] : false;
 658
 659                         // When type is not given, and no choices, the type is the same as $default
 660                         if ( !isset( $type ) ) {
 661                                 if ( isset( $default ) ) {
 662                                         $type = gettype( $default );
 663                                 } else {
 664                                         $type = 'NULL'; // allow everything
 665                                 }
 666                         }
 667                 }
 668
 669                 if ( $type == 'boolean' ) {
 670                         if ( isset( $default ) && $default !== false ) {
 671                                 // Having a default value of anything other than 'false' is pointless
 672                                 ApiBase::dieDebug( __METHOD__, "Boolean param $encParamName's default is set to '$default'" );
 673                         }
 674
 675                         $value = $this->getMain()->getRequest()->getCheck( $encParamName );
 676                 } else {
 677                         $value = $this->getMain()->getRequest()->getVal( $encParamName, $default );
 678
 679                         if ( isset( $value ) && $type == 'namespace' ) {
 680                                 $type = MWNamespace::getValidNamespaces();
 681                         }
 682                 }
 683
 684                 if ( isset( $value ) && ( $multi || is_array( $type ) ) ) {
 685                         $value = $this->parseMultiValue( $encParamName, $value, $multi, is_array( $type ) ? $type : null );
 686                 }
 687
 688                 // More validation only when choices were not given
 689                 // choices were validated in parseMultiValue()
 690                 if ( isset( $value ) ) {
 691                         if ( !is_array( $type ) ) {
 692                                 switch ( $type ) {
 693                                         case 'NULL': // nothing to do
 694                                                 break;
 695                                         case 'string':
 696                                                 if ( $required && $value === '' ) {
 697                                                         $this->dieUsageMsg( array( 'missingparam', $paramName ) );
 698                                                 }
 699
 700                                                 break;
 701                                         case 'integer': // Force everything using intval() and optionally validate limits
 702                                                 $min = isset ( $paramSettings[self::PARAM_MIN] ) ? $paramSettings[self::PARAM_MIN] : null;
 703                                                 $max = isset ( $paramSettings[self::PARAM_MAX] ) ? $paramSettings[self::PARAM_MAX] : null;
 704                                                 $enforceLimits = isset ( $paramSettings[self::PARAM_RANGE_ENFORCE] )
 705                                                                 ? $paramSettings[self::PARAM_RANGE_ENFORCE] : false;
 706
 707                                                 if ( !is_null( $min ) || !is_null( $max ) ) {
 708                                                     if ( is_array( $value ) ) {
 709                                                             $value = array_map( 'intval', $value );
 710                                                             foreach ( $value as &$v ) {
 711                                                                         $this->validateLimit( $paramName, $v, $min, $max, null, $enforceLimits );
 712                                                                 }
 713                                                     } else {
 714                                                             $value = intval( $value );
 715                                                             $this->validateLimit( $paramName, $value, $min, $max, null, $enforceLimits );
 716                                                     }
 717                                                 }
 718                                                 break;
 719                                         case 'limit':
 720                                                 if ( !$parseLimit ) {
 721                                                         // Don't do any validation whatsoever
 722                                                         break;
 723                                                 }
 724                                                 if ( !isset( $paramSettings[self::PARAM_MAX] ) || !isset( $paramSettings[self::PARAM_MAX2] ) ) {
 725                                                         ApiBase::dieDebug( __METHOD__, "MAX1 or MAX2 are not defined for the limit $encParamName" );
 726                                                 }
 727                                                 if ( $multi ) {
 728                                                         ApiBase::dieDebug( __METHOD__, "Multi-values not supported for $encParamName" );
 729                                                 }
 730                                                 $min = isset( $paramSettings[self::PARAM_MIN] ) ? $paramSettings[self::PARAM_MIN] : 0;
 731                                                 if ( $value == 'max' ) {
 732                                                         $value = $this->getMain()->canApiHighLimits() ? $paramSettings[self::PARAM_MAX2] : $paramSettings[self::PARAM_MAX];
 733                                                         $this->getResult()->setParsedLimit( $this->getModuleName(), $value );
 734                                                 } else {
 735                                                         $value = intval( $value );
 736                                                         $this->validateLimit( $paramName, $value, $min, $paramSettings[self::PARAM_MAX], $paramSettings[self::PARAM_MAX2] );
 737                                                 }
 738                                                 break;
 739                                         case 'boolean':
 740                                                 if ( $multi ) {
 741                                                         ApiBase::dieDebug( __METHOD__, "Multi-values not supported for $encParamName" );
 742                                                 }
 743                                                 break;
 744                                         case 'timestamp':
 745                                                 if ( $multi ) {
 746                                                         ApiBase::dieDebug( __METHOD__, "Multi-values not supported for $encParamName" );
 747                                                 }
 748                                                 $value = wfTimestamp( TS_UNIX, $value );
 749                                                 if ( $value === 0 ) {
 750                                                         $this->dieUsage( "Invalid value '$value' for timestamp parameter $encParamName", "badtimestamp_{$encParamName}" );
 751                                                 }
 752                                                 $value = wfTimestamp( TS_MW, $value );
 753                                                 break;
 754                                         case 'user':
 755                                                 if ( !is_array( $value ) ) {
 756                                                         $value = array( $value );
 757                                                 }
 758
 759                                                 foreach ( $value as $key => $val ) {
 760                                                         $title = Title::makeTitleSafe( NS_USER, $val );
 761                                                         if ( is_null( $title ) ) {
 762                                                                 $this->dieUsage( "Invalid value for user parameter $encParamName", "baduser_{$encParamName}" );
 763                                                         }
 764                                                         $value[$key] = $title->getText();
 765                                                 }
 766
 767                                                 if ( !$multi ) {
 768                                                         $value = $value[0];
 769                                                 }
 770                                                 break;
 771                                         default:
 772                                                 ApiBase::dieDebug( __METHOD__, "Param $encParamName's type is unknown - $type" );
 773                                 }
 774                         }
 775
 776                         // Throw out duplicates if requested
 777                         if ( is_array( $value ) && !$dupes ) {
 778                                 $value = array_unique( $value );
 779                         }
 780
 781                         // Set a warning if a deprecated parameter has been passed
 782                         if ( $deprecated && $value !== false ) {
 783                                 $this->setWarning( "The $encParamName parameter has been deprecated." );
 784                         }
 785                 } else if ( $required ) {
 786                         $this->dieUsageMsg( array( 'missingparam', $paramName ) );
 787                 }
 788
 789                 return $value;
 790         }
 791
 792         /**
 793          * Return an array of values that were given in a 'a|b|c' notation,
 794          * after it optionally validates them against the list allowed values.
 795          *
 796          * @param $valueName string The name of the parameter (for error
 797          *  reporting)
 798          * @param $value mixed The value being parsed
 799          * @param $allowMultiple bool Can $value contain more than one value
 800          *  separated by '|'?
 801          * @param $allowedValues mixed An array of values to check against. If
 802          *  null, all values are accepted.
 803          * @return mixed (allowMultiple ? an_array_of_values : a_single_value)
 804          */
 805         protected function parseMultiValue( $valueName, $value, $allowMultiple, $allowedValues ) {
 806                 if ( trim( $value ) === '' && $allowMultiple ) {
 807                         return array();
 808                 }
 809
 810                 // This is a bit awkward, but we want to avoid calling canApiHighLimits() because it unstubs $wgUser
 811                 $valuesList = explode( '|', $value, self::LIMIT_SML2 + 1 );
 812                 $sizeLimit = count( $valuesList ) > self::LIMIT_SML1 && $this->mMainModule->canApiHighLimits() ?
 813                         self::LIMIT_SML2 : self::LIMIT_SML1;
 814
 815                 if ( self::truncateArray( $valuesList, $sizeLimit ) ) {
 816                         $this->setWarning( "Too many values supplied for parameter '$valueName': the limit is $sizeLimit" );
 817                 }
 818
 819                 if ( !$allowMultiple && count( $valuesList ) != 1 ) {
 820                         $possibleValues = is_array( $allowedValues ) ? "of '" . implode( "', '", $allowedValues ) . "'" : '';
 821                         $this->dieUsage( "Only one $possibleValues is allowed for parameter '$valueName'", "multival_$valueName" );
 822                 }
 823
 824                 if ( is_array( $allowedValues ) ) {
 825                         // Check for unknown values
 826                         $unknown = array_diff( $valuesList, $allowedValues );
 827                         if ( count( $unknown ) ) {
 828                                 if ( $allowMultiple ) {
 829                                         $s = count( $unknown ) > 1 ? 's' : '';
 830                                         $vals = implode( ", ", $unknown );
 831                                         $this->setWarning( "Unrecognized value$s for parameter '$valueName': $vals" );
 832                                 } else {
 833                                         $this->dieUsage( "Unrecognized value for parameter '$valueName': {$valuesList[0]}", "unknown_$valueName" );
 834                                 }
 835                         }
 836                         // Now throw them out
 837                         $valuesList = array_intersect( $valuesList, $allowedValues );
 838                 }
 839
 840                 return $allowMultiple ? $valuesList : $valuesList[0];
 841         }
 842
 843         /**
 844          * Validate the value against the minimum and user/bot maximum limits.
 845          * Prints usage info on failure.
 846          * @param $paramName string Parameter name
 847          * @param $value int Parameter value
 848          * @param $min int Minimum value
 849          * @param $max int Maximum value for users
 850          * @param $botMax int Maximum value for sysops/bots
 851          * @param $enforceLimits Boolean Whether to enforce (die) if value is outside limits
 852          */
 853         function validateLimit( $paramName, &$value, $min, $max, $botMax = null, $enforceLimits = false ) {
 854                 if ( !is_null( $min ) && $value < $min ) {
 855
 856                         $msg = $this->encodeParamName( $paramName ) . " may not be less than $min (set to $value)";
 857                         $this->warnOrDie( $msg, $enforceLimits );
 858                         $value = $min;
 859                 }
 860
 861                 // Minimum is always validated, whereas maximum is checked only if not running in internal call mode
 862                 if ( $this->getMain()->isInternalMode() ) {
 863                         return;
 864                 }
 865
 866                 // Optimization: do not check user's bot status unless really needed -- skips db query
 867                 // assumes $botMax >= $max
 868                 if ( !is_null( $max ) && $value > $max ) {
 869                         if ( !is_null( $botMax ) && $this->getMain()->canApiHighLimits() ) {
 870                                 if ( $value > $botMax ) {
 871                                         $msg = $this->encodeParamName( $paramName ) . " may not be over $botMax (set to $value) for bots or sysops";
 872                                         $this->warnOrDie( $msg, $enforceLimits );
 873                                         $value = $botMax;
 874                                 }
 875                         } else {
 876                                 $msg = $this->encodeParamName( $paramName ) . " may not be over $max (set to $value) for users";
 877                                 $this->warnOrDie( $msg, $enforceLimits );
 878                                 $value = $max;
 879                         }
 880                 }
 881         }
 882
 883         /**
 884          * Adds a warning to the output, else dies
 885          *
 886          * @param  $msg String Message to show as a warning, or error message if dying
 887          * @param  $enforceLimits Boolean Whether this is an enforce (die)
 888          */
 889         private function warnOrDie( $msg, $enforceLimits = false ) {
 890                 if ( $enforceLimits ) {
 891                         $this->dieUsage( $msg, 'integeroutofrange' );
 892                 } else {
 893                         $this->setWarning( $msg );
 894                 }
 895         }
 896
 897         /**
 898          * Truncate an array to a certain length.
 899          * @param $arr array Array to truncate
 900          * @param $limit int Maximum length
 901          * @return bool True if the array was truncated, false otherwise
 902          */
 903         public static function truncateArray( &$arr, $limit ) {
 904                 $modified = false;
 905                 while ( count( $arr ) > $limit ) {
 906                         array_pop( $arr );
 907                         $modified = true;
 908                 }
 909                 return $modified;
 910         }
 911
 912         /**
 913          * Throw a UsageException, which will (if uncaught) call the main module's
 914          * error handler and die with an error message.
 915          *
 916          * @param $description string One-line human-readable description of the
 917          *   error condition, e.g., "The API requires a valid action parameter"
 918          * @param $errorCode string Brief, arbitrary, stable string to allow easy
 919          *   automated identification of the error, e.g., 'unknown_action'
 920          * @param $httpRespCode int HTTP response code
 921          * @param $extradata array Data to add to the <error> element; array in ApiResult format
 922          */
 923         public function dieUsage( $description, $errorCode, $httpRespCode = 0, $extradata = null ) {
 924                 wfProfileClose();
 925                 throw new UsageException( $description, $this->encodeParamName( $errorCode ), $httpRespCode, $extradata );
 926         }
 927
 928         /**
 929          * Array that maps message keys to error messages. $1 and friends are replaced.
 930          */
 931         public static $messageMap = array(
 932                 // This one MUST be present, or dieUsageMsg() will recurse infinitely
 933                 'unknownerror' => array( 'code' => 'unknownerror', 'info' => "Unknown error: ``\$1''" ),
 934                 'unknownerror-nocode' => array( 'code' => 'unknownerror', 'info' => 'Unknown error' ),
 935
 936                 // Messages from Title::getUserPermissionsErrors()
 937                 'ns-specialprotected' => array( 'code' => 'unsupportednamespace', 'info' => "Pages in the Special namespace can't be edited" ),
 938                 'protectedinterface' => array( 'code' => 'protectednamespace-interface', 'info' => "You're not allowed to edit interface messages" ),
 939                 'namespaceprotected' => array( 'code' => 'protectednamespace', 'info' => "You're not allowed to edit pages in the ``\$1'' namespace" ),
 940                 'customcssjsprotected' => array( 'code' => 'customcssjsprotected', 'info' => "You're not allowed to edit custom CSS and JavaScript pages" ),
 941                 'cascadeprotected' => array( 'code' => 'cascadeprotected', 'info' => "The page you're trying to edit is protected because it's included in a cascade-protected page" ),
 942                 'protectedpagetext' => array( 'code' => 'protectedpage', 'info' => "The ``\$1'' right is required to edit this page" ),
 943                 'protect-cantedit' => array( 'code' => 'cantedit', 'info' => "You can't protect this page because you can't edit it" ),
 944                 'badaccess-group0' => array( 'code' => 'permissiondenied', 'info' => "Permission denied" ), // Generic permission denied message
 945                 'badaccess-groups' => array( 'code' => 'permissiondenied', 'info' => "Permission denied" ),
 946                 'titleprotected' => array( 'code' => 'protectedtitle', 'info' => "This title has been protected from creation" ),
 947                 'nocreate-loggedin' => array( 'code' => 'cantcreate', 'info' => "You don't have permission to create new pages" ),
 948                 'nocreatetext' => array( 'code' => 'cantcreate-anon', 'info' => "Anonymous users can't create new pages" ),
 949                 'movenologintext' => array( 'code' => 'cantmove-anon', 'info' => "Anonymous users can't move pages" ),
 950                 'movenotallowed' => array( 'code' => 'cantmove', 'info' => "You don't have permission to move pages" ),
 951                 'confirmedittext' => array( 'code' => 'confirmemail', 'info' => "You must confirm your e-mail address before you can edit" ),
 952                 'blockedtext' => array( 'code' => 'blocked', 'info' => "You have been blocked from editing" ),
 953                 'autoblockedtext' => array( 'code' => 'autoblocked', 'info' => "Your IP address has been blocked automatically, because it was used by a blocked user" ),
 954
 955                 // Miscellaneous interface messages
 956                 'actionthrottledtext' => array( 'code' => 'ratelimited', 'info' => "You've exceeded your rate limit. Please wait some time and try again" ),
 957                 'alreadyrolled' => array( 'code' => 'alreadyrolled', 'info' => "The page you tried to rollback was already rolled back" ),
 958                 'cantrollback' => array( 'code' => 'onlyauthor', 'info' => "The page you tried to rollback only has one author" ),
 959                 'readonlytext' => array( 'code' => 'readonly', 'info' => "The wiki is currently in read-only mode" ),
 960                 'sessionfailure' => array( 'code' => 'badtoken', 'info' => "Invalid token" ),
 961                 'cannotdelete' => array( 'code' => 'cantdelete', 'info' => "Couldn't delete ``\$1''. Maybe it was deleted already by someone else" ),
 962                 'notanarticle' => array( 'code' => 'missingtitle', 'info' => "The page you requested doesn't exist" ),
 963                 'selfmove' => array( 'code' => 'selfmove', 'info' => "Can't move a page to itself" ),
 964                 'immobile_namespace' => array( 'code' => 'immobilenamespace', 'info' => "You tried to move pages from or to a namespace that is protected from moving" ),
 965                 'articleexists' => array( 'code' => 'articleexists', 'info' => "The destination article already exists and is not a redirect to the source article" ),
 966                 'protectedpage' => array( 'code' => 'protectedpage', 'info' => "You don't have permission to perform this move" ),
 967                 'hookaborted' => array( 'code' => 'hookaborted', 'info' => "The modification you tried to make was aborted by an extension hook" ),
 968                 'cantmove-titleprotected' => array( 'code' => 'protectedtitle', 'info' => "The destination article has been protected from creation" ),
 969                 'imagenocrossnamespace' => array( 'code' => 'nonfilenamespace', 'info' => "Can't move a file to a non-file namespace" ),
 970                 'imagetypemismatch' => array( 'code' => 'filetypemismatch', 'info' => "The new file extension doesn't match its type" ),
 971                 // 'badarticleerror' => shouldn't happen
 972                 // 'badtitletext' => shouldn't happen
 973                 'ip_range_invalid' => array( 'code' => 'invalidrange', 'info' => "Invalid IP range" ),
 974                 'range_block_disabled' => array( 'code' => 'rangedisabled', 'info' => "Blocking IP ranges has been disabled" ),
 975                 'nosuchusershort' => array( 'code' => 'nosuchuser', 'info' => "The user you specified doesn't exist" ),
 976                 'badipaddress' => array( 'code' => 'invalidip', 'info' => "Invalid IP address specified" ),
 977                 'ipb_expiry_invalid' => array( 'code' => 'invalidexpiry', 'info' => "Invalid expiry time" ),
 978                 'ipb_already_blocked' => array( 'code' => 'alreadyblocked', 'info' => "The user you tried to block was already blocked" ),
 979                 'ipb_blocked_as_range' => array( 'code' => 'blockedasrange', 'info' => "IP address ``\$1'' was blocked as part of range ``\$2''. You can't unblock the IP invidually, but you can unblock the range as a whole." ),
 980                 'ipb_cant_unblock' => array( 'code' => 'cantunblock', 'info' => "The block you specified was not found. It may have been unblocked already" ),
 981                 'mailnologin' => array( 'code' => 'cantsend', 'info' => "You are not logged in, you do not have a confirmed e-mail address, or you are not allowed to send e-mail to other users, so you cannot send e-mail" ),
 982                 'ipbblocked' => array( 'code' => 'ipbblocked', 'info' => 'You cannot block or unblock users while you are yourself blocked' ),
 983                 'ipbnounblockself' => array( 'code' => 'ipbnounblockself', 'info' => 'You are not allowed to unblock yourself' ),
 984                 'usermaildisabled' => array( 'code' => 'usermaildisabled', 'info' => "User email has been disabled" ),
 985                 'blockedemailuser' => array( 'code' => 'blockedfrommail', 'info' => "You have been blocked from sending e-mail" ),
 986                 'notarget' => array( 'code' => 'notarget', 'info' => "You have not specified a valid target for this action" ),
 987                 'noemail' => array( 'code' => 'noemail', 'info' => "The user has not specified a valid e-mail address, or has chosen not to receive e-mail from other users" ),
 988                 'rcpatroldisabled' => array( 'code' => 'patroldisabled', 'info' => "Patrolling is disabled on this wiki" ),
 989                 'markedaspatrollederror-noautopatrol' => array( 'code' => 'noautopatrol', 'info' => "You don't have permission to patrol your own changes" ),
 990                 'delete-toobig' => array( 'code' => 'bigdelete', 'info' => "You can't delete this page because it has more than \$1 revisions" ),
 991                 'movenotallowedfile' => array( 'code' => 'cantmovefile', 'info' => "You don't have permission to move files" ),
 992                 'userrights-no-interwiki' => array( 'code' => 'nointerwikiuserrights', 'info' => "You don't have permission to change user rights on other wikis" ),
 993                 'userrights-nodatabase' => array( 'code' => 'nosuchdatabase', 'info' => "Database ``\$1'' does not exist or is not local" ),
 994                 'nouserspecified' => array( 'code' => 'invaliduser', 'info' => "Invalid username ``\$1''" ),
 995                 'noname' => array( 'code' => 'invaliduser', 'info' => "Invalid username ``\$1''" ),
 996                 'summaryrequired' => array( 'code' => 'summaryrequired', 'info' => 'Summary required' ),
 997
 998                 // API-specific messages
 999                 'readrequired' => array( 'code' => 'readapidenied', 'info' => "You need read permission to use this module" ),
1000                 'writedisabled' => array( 'code' => 'noapiwrite', 'info' => "Editing of this wiki through the API is disabled. Make sure the \$wgEnableWriteAPI=true; statement is included in the wiki's LocalSettings.php file" ),
1001                 'writerequired' => array( 'code' => 'writeapidenied', 'info' => "You're not allowed to edit this wiki through the API" ),
1002                 'missingparam' => array( 'code' => 'no$1', 'info' => "The \$1 parameter must be set" ),
1003                 'invalidtitle' => array( 'code' => 'invalidtitle', 'info' => "Bad title ``\$1''" ),
1004                 'nosuchpageid' => array( 'code' => 'nosuchpageid', 'info' => "There is no page with ID \$1" ),
1005                 'nosuchrevid' => array( 'code' => 'nosuchrevid', 'info' => "There is no revision with ID \$1" ),
1006                 'nosuchuser' => array( 'code' => 'nosuchuser', 'info' => "User ``\$1'' doesn't exist" ),
1007                 'invaliduser' => array( 'code' => 'invaliduser', 'info' => "Invalid username ``\$1''" ),
1008                 'invalidexpiry' => array( 'code' => 'invalidexpiry', 'info' => "Invalid expiry time ``\$1''" ),
1009                 'pastexpiry' => array( 'code' => 'pastexpiry', 'info' => "Expiry time ``\$1'' is in the past" ),
1010                 'create-titleexists' => array( 'code' => 'create-titleexists', 'info' => "Existing titles can't be protected with 'create'" ),
1011                 'missingtitle-createonly' => array( 'code' => 'missingtitle-createonly', 'info' => "Missing titles can only be protected with 'create'" ),
1012                 'cantblock' => array( 'code' => 'cantblock', 'info' => "You don't have permission to block users" ),
1013                 'canthide' => array( 'code' => 'canthide', 'info' => "You don't have permission to hide user names from the block log" ),
1014                 'cantblock-email' => array( 'code' => 'cantblock-email', 'info' => "You don't have permission to block users from sending e-mail through the wiki" ),
1015                 'unblock-notarget' => array( 'code' => 'notarget', 'info' => "Either the id or the user parameter must be set" ),
1016                 'unblock-idanduser' => array( 'code' => 'idanduser', 'info' => "The id and user parameters can't be used together" ),
1017                 'cantunblock' => array( 'code' => 'permissiondenied', 'info' => "You don't have permission to unblock users" ),
1018                 'cannotundelete' => array( 'code' => 'cantundelete', 'info' => "Couldn't undelete: the requested revisions may not exist, or may have been undeleted already" ),
1019                 'permdenied-undelete' => array( 'code' => 'permissiondenied', 'info' => "You don't have permission to restore deleted revisions" ),
1020                 'createonly-exists' => array( 'code' => 'articleexists', 'info' => "The article you tried to create has been created already" ),
1021                 'nocreate-missing' => array( 'code' => 'missingtitle', 'info' => "The article you tried to edit doesn't exist" ),
1022                 'nosuchrcid' => array( 'code' => 'nosuchrcid', 'info' => "There is no change with rcid ``\$1''" ),
1023                 'protect-invalidaction' => array( 'code' => 'protect-invalidaction', 'info' => "Invalid protection type ``\$1''" ),
1024                 'protect-invalidlevel' => array( 'code' => 'protect-invalidlevel', 'info' => "Invalid protection level ``\$1''" ),
1025                 'toofewexpiries' => array( 'code' => 'toofewexpiries', 'info' => "\$1 expiry timestamps were provided where \$2 were needed" ),
1026                 'cantimport' => array( 'code' => 'cantimport', 'info' => "You don't have permission to import pages" ),
1027                 'cantimport-upload' => array( 'code' => 'cantimport-upload', 'info' => "You don't have permission to import uploaded pages" ),
1028                 'nouploadmodule' => array( 'code' => 'nomodule', 'info' => 'No upload module set' ),
1029                 'importnofile' => array( 'code' => 'nofile', 'info' => "You didn't upload a file" ),
1030                 'importuploaderrorsize' => array( 'code' => 'filetoobig', 'info' => 'The file you uploaded is bigger than the maximum upload size' ),
1031                 'importuploaderrorpartial' => array( 'code' => 'partialupload', 'info' => 'The file was only partially uploaded' ),
1032                 'importuploaderrortemp' => array( 'code' => 'notempdir', 'info' => 'The temporary upload directory is missing' ),
1033                 'importcantopen' => array( 'code' => 'cantopenfile', 'info' => "Couldn't open the uploaded file" ),
1034                 'import-noarticle' => array( 'code' => 'badinterwiki', 'info' => 'Invalid interwiki title specified' ),
1035                 'importbadinterwiki' => array( 'code' => 'badinterwiki', 'info' => 'Invalid interwiki title specified' ),
1036                 'import-unknownerror' => array( 'code' => 'import-unknownerror', 'info' => "Unknown error on import: ``\$1''" ),
1037                 'cantoverwrite-sharedfile' => array( 'code' => 'cantoverwrite-sharedfile', 'info' => 'The target file exists on a shared repository and you do not have permission to override it' ),
1038                 'sharedfile-exists' => array( 'code' => 'fileexists-sharedrepo-perm', 'info' => 'The target file exists on a shared repository. Use the ignorewarnings parameter to override it.' ),
1039                 'mustbeposted' => array( 'code' => 'mustbeposted', 'info' => "The \$1 module requires a POST request" ),
1040                 'show' => array( 'code' => 'show', 'info' => 'Incorrect parameter - mutually exclusive values may not be supplied' ),
1041
1042                 // ApiEditPage messages
1043                 'noimageredirect-anon' => array( 'code' => 'noimageredirect-anon', 'info' => "Anonymous users can't create image redirects" ),
1044                 'noimageredirect-logged' => array( 'code' => 'noimageredirect', 'info' => "You don't have permission to create image redirects" ),
1045                 'spamdetected' => array( 'code' => 'spamdetected', 'info' => "Your edit was refused because it contained a spam fragment: ``\$1''" ),
1046                 'filtered' => array( 'code' => 'filtered', 'info' => "The filter callback function refused your edit" ),
1047                 'contenttoobig' => array( 'code' => 'contenttoobig', 'info' => "The content you supplied exceeds the article size limit of \$1 kilobytes" ),
1048                 'noedit-anon' => array( 'code' => 'noedit-anon', 'info' => "Anonymous users can't edit pages" ),
1049                 'noedit' => array( 'code' => 'noedit', 'info' => "You don't have permission to edit pages" ),
1050                 'wasdeleted' => array( 'code' => 'pagedeleted', 'info' => "The page has been deleted since you fetched its timestamp" ),
1051                 'blankpage' => array( 'code' => 'emptypage', 'info' => "Creating new, empty pages is not allowed" ),
1052                 'editconflict' => array( 'code' => 'editconflict', 'info' => "Edit conflict detected" ),
1053                 'hashcheckfailed' => array( 'code' => 'badmd5', 'info' => "The supplied MD5 hash was incorrect" ),
1054                 'missingtext' => array( 'code' => 'notext', 'info' => "One of the text, appendtext, prependtext and undo parameters must be set" ),
1055                 'emptynewsection' => array( 'code' => 'emptynewsection', 'info' => 'Creating empty new sections is not possible.' ),
1056                 'revwrongpage' => array( 'code' => 'revwrongpage', 'info' => "r\$1 is not a revision of ``\$2''" ),
1057                 'undo-failure' => array( 'code' => 'undofailure', 'info' => 'Undo failed due to conflicting intermediate edits' ),
1058
1059                 // uploadMsgs
1060                 'invalid-session-key' => array( 'code' => 'invalid-session-key', 'info' => 'Not a valid session key' ),
1061                 'nouploadmodule' => array( 'code' => 'nouploadmodule', 'info' => 'No upload module set' ),
1062                 'uploaddisabled' => array( 'code' => 'uploaddisabled', 'info' => 'Uploads are not enabled.  Make sure $wgEnableUploads is set to true in LocalSettings.php and the PHP ini setting file_uploads is true' ),
1063                 'copyuploaddisabled' => array( 'code' => 'copyuploaddisabled', 'info' => 'Uploads by URL is not enabled.  Make sure $wgAllowCopyUploads is set to true in LocalSettings.php.' ),
1064         );
1065
1066         /**
1067          * Helper function for readonly errors
1068          */
1069         public function dieReadOnly() {
1070                 $parsed = $this->parseMsg( array( 'readonlytext' ) );
1071                 $this->dieUsage( $parsed['info'], $parsed['code'], /* http error */ 0,
1072                         array( 'readonlyreason' => wfReadOnlyReason() ) );
1073         }
1074
1075         /**
1076          * Output the error message related to a certain array
1077          * @param $error array Element of a getUserPermissionsErrors()-style array
1078          */
1079         public function dieUsageMsg( $error ) {
1080                 $parsed = $this->parseMsg( $error );
1081                 $this->dieUsage( $parsed['info'], $parsed['code'] );
1082         }
1083
1084         /**
1085          * Return the error message related to a certain array
1086          * @param $error array Element of a getUserPermissionsErrors()-style array
1087          * @return array('code' => code, 'info' => info)
1088          */
1089         public function parseMsg( $error ) {
1090                 $key = array_shift( $error );
1091                 if ( isset( self::$messageMap[$key] ) ) {
1092                         return array( 'code' =>
1093                                 wfMsgReplaceArgs( self::$messageMap[$key]['code'], $error ),
1094                                         'info' =>
1095                                 wfMsgReplaceArgs( self::$messageMap[$key]['info'], $error )
1096                         );
1097                 }
1098                 // If the key isn't present, throw an "unknown error"
1099                 return $this->parseMsg( array( 'unknownerror', $key ) );
1100         }
1101
1102         /**
1103          * Internal code errors should be reported with this method
1104          * @param $method string Method or function name
1105          * @param $message string Error message
1106          */
1107         protected static function dieDebug( $method, $message ) {
1108                 wfDebugDieBacktrace( "Internal error in $method: $message" );
1109         }
1110
1111         /**
1112          * Indicates if this module needs maxlag to be checked
1113          * @return bool
1114          */
1115         public function shouldCheckMaxlag() {
1116                 return true;
1117         }
1118
1119         /**
1120          * Indicates whether this module requires read rights
1121          * @return bool
1122          */
1123         public function isReadMode() {
1124                 return true;
1125         }
1126         /**
1127          * Indicates whether this module requires write mode
1128          * @return bool
1129          */
1130         public function isWriteMode() {
1131                 return false;
1132         }
1133
1134         /**
1135          * Indicates whether this module must be called with a POST request
1136          * @return bool
1137          */
1138         public function mustBePosted() {
1139                 return false;
1140         }
1141
1142         /**
1143          * Returns whether this module requires a Token to execute
1144          * @returns bool
1145          */
1146         public function needsToken() {
1147                 return false;
1148         }
1149
1150         /**
1151          * Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the module doesn't need a token
1152          * @returns bool
1153          */
1154         public function getTokenSalt() {
1155                 return false;
1156         }
1157
1158         /**
1159         * Gets the user for whom to get the watchlist
1160         *
1161         * @returns User
1162         */
1163         public function getWatchlistUser( $params ) {
1164                 global $wgUser;
1165                 if ( !is_null( $params['owner'] ) && !is_null( $params['token'] ) ) {
1166                         $user = User::newFromName( $params['owner'], false );
1167                         if ( !$user->getId() ) {
1168                                 $this->dieUsage( 'Specified user does not exist', 'bad_wlowner' );
1169                         }
1170                         $token = $user->getOption( 'watchlisttoken' );
1171                         if ( $token == '' || $token != $params['token'] ) {
1172                                 $this->dieUsage( 'Incorrect watchlist token provided -- please set a correct token in Special:Preferences', 'bad_wltoken' );
1173                         }
1174                 } else {
1175                         if ( !$wgUser->isLoggedIn() ) {
1176                                 $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
1177                         }
1178                         $user = $wgUser;
1179                 }
1180                 return $user;
1181         }
1182
1183         /**
1184          * Returns a list of all possible errors returned by the module
1185          * @return array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
1186          */
1187         public function getPossibleErrors() {
1188                 $ret = array();
1189
1190                 $params = $this->getFinalParams();
1191                 if ( $params ) {
1192                         foreach ( $params as $paramName => $paramSettings ) {
1193                                 if ( isset( $paramSettings[ApiBase::PARAM_REQUIRED] ) ) {
1194                                         $ret[] = array( 'missingparam', $paramName );
1195                                 }
1196                         }
1197                 }
1198
1199                 if ( $this->mustBePosted() ) {
1200                         $ret[] = array( 'mustbeposted', $this->getModuleName() );
1201                 }
1202
1203                 if ( $this->isReadMode() ) {
1204                         $ret[] = array( 'readrequired' );
1205                 }
1206
1207                 if ( $this->isWriteMode() ) {
1208                         $ret[] = array( 'writerequired' );
1209                         $ret[] = array( 'writedisabled' );
1210                 }
1211
1212                 if ( $this->needsToken() ) {
1213                         $ret[] = array( 'missingparam', 'token' );
1214                         $ret[] = array( 'sessionfailure' );
1215                 }
1216
1217                 return $ret;
1218         }
1219
1220         /**
1221          * Parses a list of errors into a standardised format
1222          * @param $errors array List of errors. Items can be in the for array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
1223          * @return array Parsed list of errors with items in the form array( 'code' => ..., 'info' => ... )
1224          */
1225         public function parseErrors( $errors ) {
1226                 $ret = array();
1227
1228                 foreach ( $errors as $row ) {
1229                         if ( isset( $row['code'] ) && isset( $row['info'] ) ) {
1230                                 $ret[] = $row;
1231                         } else {
1232                                 $ret[] = $this->parseMsg( $row );
1233                         }
1234                 }
1235                 return $ret;
1236         }
1237
1238         /**
1239          * Profiling: total module execution time
1240          */
1241         private $mTimeIn = 0, $mModuleTime = 0;
1242
1243         /**
1244          * Start module profiling
1245          */
1246         public function profileIn() {
1247                 if ( $this->mTimeIn !== 0 ) {
1248                         ApiBase::dieDebug( __METHOD__, 'called twice without calling profileOut()' );
1249                 }
1250                 $this->mTimeIn = microtime( true );
1251                 wfProfileIn( $this->getModuleProfileName() );
1252         }
1253
1254         /**
1255          * End module profiling
1256          */
1257         public function profileOut() {
1258                 if ( $this->mTimeIn === 0 ) {
1259                         ApiBase::dieDebug( __METHOD__, 'called without calling profileIn() first' );
1260                 }
1261                 if ( $this->mDBTimeIn !== 0 ) {
1262                         ApiBase::dieDebug( __METHOD__, 'must be called after database profiling is done with profileDBOut()' );
1263                 }
1264
1265                 $this->mModuleTime += microtime( true ) - $this->mTimeIn;
1266                 $this->mTimeIn = 0;
1267                 wfProfileOut( $this->getModuleProfileName() );
1268         }
1269
1270         /**
1271          * When modules crash, sometimes it is needed to do a profileOut() regardless
1272          * of the profiling state the module was in. This method does such cleanup.
1273          */
1274         public function safeProfileOut() {
1275                 if ( $this->mTimeIn !== 0 ) {
1276                         if ( $this->mDBTimeIn !== 0 ) {
1277                                 $this->profileDBOut();
1278                         }
1279                         $this->profileOut();
1280                 }
1281         }
1282
1283         /**
1284          * Total time the module was executed
1285          * @return float
1286          */
1287         public function getProfileTime() {
1288                 if ( $this->mTimeIn !== 0 ) {
1289                         ApiBase::dieDebug( __METHOD__, 'called without calling profileOut() first' );
1290                 }
1291                 return $this->mModuleTime;
1292         }
1293
1294         /**
1295          * Profiling: database execution time
1296          */
1297         private $mDBTimeIn = 0, $mDBTime = 0;
1298
1299         /**
1300          * Start module profiling
1301          */
1302         public function profileDBIn() {
1303                 if ( $this->mTimeIn === 0 ) {
1304                         ApiBase::dieDebug( __METHOD__, 'must be called while profiling the entire module with profileIn()' );
1305                 }
1306                 if ( $this->mDBTimeIn !== 0 ) {
1307                         ApiBase::dieDebug( __METHOD__, 'called twice without calling profileDBOut()' );
1308                 }
1309                 $this->mDBTimeIn = microtime( true );
1310                 wfProfileIn( $this->getModuleProfileName( true ) );
1311         }
1312
1313         /**
1314          * End database profiling
1315          */
1316         public function profileDBOut() {
1317                 if ( $this->mTimeIn === 0 ) {
1318                         ApiBase::dieDebug( __METHOD__, 'must be called while profiling the entire module with profileIn()' );
1319                 }
1320                 if ( $this->mDBTimeIn === 0 ) {
1321                         ApiBase::dieDebug( __METHOD__, 'called without calling profileDBIn() first' );
1322                 }
1323
1324                 $time = microtime( true ) - $this->mDBTimeIn;
1325                 $this->mDBTimeIn = 0;
1326
1327                 $this->mDBTime += $time;
1328                 $this->getMain()->mDBTime += $time;
1329                 wfProfileOut( $this->getModuleProfileName( true ) );
1330         }
1331
1332         /**
1333          * Total time the module used the database
1334          * @return float
1335          */
1336         public function getProfileDBTime() {
1337                 if ( $this->mDBTimeIn !== 0 ) {
1338                         ApiBase::dieDebug( __METHOD__, 'called without calling profileDBOut() first' );
1339                 }
1340                 return $this->mDBTime;
1341         }
1342
1343         /**
1344          * Debugging function that prints a value and an optional backtrace
1345          * @param $value mixed Value to print
1346          * @param $name string Description of the printed value
1347          * @param $backtrace bool If true, print a backtrace
1348          */
1349         public static function debugPrint( $value, $name = 'unknown', $backtrace = false ) {
1350                 print "\n\n<pre><b>Debugging value '$name':</b>\n\n";
1351                 var_export( $value );
1352                 if ( $backtrace ) {
1353                         print "\n" . wfBacktrace();
1354                 }
1355                 print "\n</pre>\n";
1356         }
1357
1358         /**
1359          * Returns a string that identifies the version of this class.
1360          * @return string
1361          */
1362         public static function getBaseVersion() {
1363                 return __CLASS__ . ': $Id$';
1364         }
1365 }