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