includes/api/ApiBase.php

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