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