includes/api/ApiMain.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Sep 4, 2006
   6  *
   7  * Copyright © 2006 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  * @defgroup API API
  26  */
  27
  28 /**
  29  * This is the main API class, used for both external and internal processing.
  30  * When executed, it will create the requested formatter object,
  31  * instantiate and execute an object associated with the needed action,
  32  * and use formatter to print results.
  33  * In case of an exception, an error message will be printed using the same formatter.
  34  *
  35  * To use API from another application, run it using FauxRequest object, in which
  36  * case any internal exceptions will not be handled but passed up to the caller.
  37  * After successful execution, use getResult() for the resulting data.
  38  *
  39  * @ingroup API
  40  */
  41 class ApiMain extends ApiBase {
  42         /**
  43          * When no format parameter is given, this format will be used
  44          */
  45         const API_DEFAULT_FORMAT = 'jsonfm';
  46
  47         /**
  48          * List of available modules: action name => module class
  49          */
  50         private static $Modules = array(
  51                 'login' => 'ApiLogin',
  52                 'logout' => 'ApiLogout',
  53                 'createaccount' => 'ApiCreateAccount',
  54                 'query' => 'ApiQuery',
  55                 'expandtemplates' => 'ApiExpandTemplates',
  56                 'parse' => 'ApiParse',
  57                 'stashedit' => 'ApiStashEdit',
  58                 'opensearch' => 'ApiOpenSearch',
  59                 'feedcontributions' => 'ApiFeedContributions',
  60                 'feedrecentchanges' => 'ApiFeedRecentChanges',
  61                 'feedwatchlist' => 'ApiFeedWatchlist',
  62                 'help' => 'ApiHelp',
  63                 'paraminfo' => 'ApiParamInfo',
  64                 'rsd' => 'ApiRsd',
  65                 'compare' => 'ApiComparePages',
  66                 'tokens' => 'ApiTokens',
  67
  68                 // Write modules
  69                 'purge' => 'ApiPurge',
  70                 'setnotificationtimestamp' => 'ApiSetNotificationTimestamp',
  71                 'rollback' => 'ApiRollback',
  72                 'delete' => 'ApiDelete',
  73                 'undelete' => 'ApiUndelete',
  74                 'protect' => 'ApiProtect',
  75                 'block' => 'ApiBlock',
  76                 'unblock' => 'ApiUnblock',
  77                 'move' => 'ApiMove',
  78                 'edit' => 'ApiEditPage',
  79                 'upload' => 'ApiUpload',
  80                 'filerevert' => 'ApiFileRevert',
  81                 'emailuser' => 'ApiEmailUser',
  82                 'watch' => 'ApiWatch',
  83                 'patrol' => 'ApiPatrol',
  84                 'import' => 'ApiImport',
  85                 'clearhasmsg' => 'ApiClearHasMsg',
  86                 'userrights' => 'ApiUserrights',
  87                 'options' => 'ApiOptions',
  88                 'imagerotate' => 'ApiImageRotate',
  89                 'revisiondelete' => 'ApiRevisionDelete',
  90         );
  91
  92         /**
  93          * List of available formats: format name => format class
  94          */
  95         private static $Formats = array(
  96                 'json' => 'ApiFormatJson',
  97                 'jsonfm' => 'ApiFormatJson',
  98                 'php' => 'ApiFormatPhp',
  99                 'phpfm' => 'ApiFormatPhp',
 100                 'wddx' => 'ApiFormatWddx',
 101                 'wddxfm' => 'ApiFormatWddx',
 102                 'xml' => 'ApiFormatXml',
 103                 'xmlfm' => 'ApiFormatXml',
 104                 'yaml' => 'ApiFormatYaml',
 105                 'yamlfm' => 'ApiFormatYaml',
 106                 'rawfm' => 'ApiFormatJson',
 107                 'txt' => 'ApiFormatTxt',
 108                 'txtfm' => 'ApiFormatTxt',
 109                 'dbg' => 'ApiFormatDbg',
 110                 'dbgfm' => 'ApiFormatDbg',
 111                 'dump' => 'ApiFormatDump',
 112                 'dumpfm' => 'ApiFormatDump',
 113                 'none' => 'ApiFormatNone',
 114         );
 115
 116         // @codingStandardsIgnoreStart String contenation on "msg" not allowed to break long line
 117         /**
 118          * List of user roles that are specifically relevant to the API.
 119          * array( 'right' => array ( 'msg'    => 'Some message with a $1',
 120          *                           'params' => array ( $someVarToSubst ) ),
 121          *                          );
 122          */
 123         private static $mRights = array(
 124                 'writeapi' => array(
 125                         'msg' => 'right-writeapi',
 126                         'params' => array()
 127                 ),
 128                 'apihighlimits' => array(
 129                         'msg' => 'api-help-right-apihighlimits',
 130                         'params' => array( ApiBase::LIMIT_SML2, ApiBase::LIMIT_BIG2 )
 131                 )
 132         );
 133         // @codingStandardsIgnoreEnd
 134
 135         /**
 136          * @var ApiFormatBase
 137          */
 138         private $mPrinter;
 139
 140         private $mModuleMgr, $mResult;
 141         private $mAction;
 142         private $mEnableWrite;
 143         private $mInternalMode, $mSquidMaxage, $mModule;
 144
 145         private $mCacheMode = 'private';
 146         private $mCacheControl = array();
 147         private $mParamsUsed = array();
 148
 149         /**
 150          * Constructs an instance of ApiMain that utilizes the module and format specified by $request.
 151          *
 152          * @param IContextSource|WebRequest $context If this is an instance of
 153          *    FauxRequest, errors are thrown and no printing occurs
 154          * @param bool $enableWrite Should be set to true if the api may modify data
 155          */
 156         public function __construct( $context = null, $enableWrite = false ) {
 157                 if ( $context === null ) {
 158                         $context = RequestContext::getMain();
 159                 } elseif ( $context instanceof WebRequest ) {
 160                         // BC for pre-1.19
 161                         $request = $context;
 162                         $context = RequestContext::getMain();
 163                 }
 164                 // We set a derivative context so we can change stuff later
 165                 $this->setContext( new DerivativeContext( $context ) );
 166
 167                 if ( isset( $request ) ) {
 168                         $this->getContext()->setRequest( $request );
 169                 }
 170
 171                 $this->mInternalMode = ( $this->getRequest() instanceof FauxRequest );
 172
 173                 // Special handling for the main module: $parent === $this
 174                 parent::__construct( $this, $this->mInternalMode ? 'main_int' : 'main' );
 175
 176                 if ( !$this->mInternalMode ) {
 177                         // Impose module restrictions.
 178                         // If the current user cannot read,
 179                         // Remove all modules other than login
 180                         global $wgUser;
 181
 182                         if ( $this->getVal( 'callback' ) !== null ) {
 183                                 // JSON callback allows cross-site reads.
 184                                 // For safety, strip user credentials.
 185                                 wfDebug( "API: stripping user credentials for JSON callback\n" );
 186                                 $wgUser = new User();
 187                                 $this->getContext()->setUser( $wgUser );
 188                         }
 189                 }
 190
 191                 $uselang = $this->getParameter( 'uselang' );
 192                 if ( $uselang === 'user' ) {
 193                         $uselang = $this->getUser()->getOption( 'language' );
 194                         $uselang = RequestContext::sanitizeLangCode( $uselang );
 195                         Hooks::run( 'UserGetLanguageObject', array( $this->getUser(), &$uselang, $this ) );
 196                 } elseif ( $uselang === 'content' ) {
 197                         global $wgContLang;
 198                         $uselang = $wgContLang->getCode();
 199                 }
 200                 $code = RequestContext::sanitizeLangCode( $uselang );
 201                 $this->getContext()->setLanguage( $code );
 202                 if ( !$this->mInternalMode ) {
 203                         global $wgLang;
 204                         $wgLang = $this->getContext()->getLanguage();
 205                         RequestContext::getMain()->setLanguage( $wgLang );
 206                 }
 207
 208                 $config = $this->getConfig();
 209                 $this->mModuleMgr = new ApiModuleManager( $this );
 210                 $this->mModuleMgr->addModules( self::$Modules, 'action' );
 211                 $this->mModuleMgr->addModules( $config->get( 'APIModules' ), 'action' );
 212                 $this->mModuleMgr->addModules( self::$Formats, 'format' );
 213                 $this->mModuleMgr->addModules( $config->get( 'APIFormatModules' ), 'format' );
 214
 215                 $this->mResult = new ApiResult( $this );
 216                 $this->mEnableWrite = $enableWrite;
 217
 218                 $this->mSquidMaxage = -1; // flag for executeActionWithErrorHandling()
 219                 $this->mCommit = false;
 220         }
 221
 222         /**
 223          * Return true if the API was started by other PHP code using FauxRequest
 224          * @return bool
 225          */
 226         public function isInternalMode() {
 227                 return $this->mInternalMode;
 228         }
 229
 230         /**
 231          * Get the ApiResult object associated with current request
 232          *
 233          * @return ApiResult
 234          */
 235         public function getResult() {
 236                 return $this->mResult;
 237         }
 238
 239         /**
 240          * Get the API module object. Only works after executeAction()
 241          *
 242          * @return ApiBase
 243          */
 244         public function getModule() {
 245                 return $this->mModule;
 246         }
 247
 248         /**
 249          * Get the result formatter object. Only works after setupExecuteAction()
 250          *
 251          * @return ApiFormatBase
 252          */
 253         public function getPrinter() {
 254                 return $this->mPrinter;
 255         }
 256
 257         /**
 258          * Set how long the response should be cached.
 259          *
 260          * @param int $maxage
 261          */
 262         public function setCacheMaxAge( $maxage ) {
 263                 $this->setCacheControl( array(
 264                         'max-age' => $maxage,
 265                         's-maxage' => $maxage
 266                 ) );
 267         }
 268
 269         /**
 270          * Set the type of caching headers which will be sent.
 271          *
 272          * @param string $mode One of:
 273          *    - 'public':     Cache this object in public caches, if the maxage or smaxage
 274          *         parameter is set, or if setCacheMaxAge() was called. If a maximum age is
 275          *         not provided by any of these means, the object will be private.
 276          *    - 'private':    Cache this object only in private client-side caches.
 277          *    - 'anon-public-user-private': Make this object cacheable for logged-out
 278          *         users, but private for logged-in users. IMPORTANT: If this is set, it must be
 279          *         set consistently for a given URL, it cannot be set differently depending on
 280          *         things like the contents of the database, or whether the user is logged in.
 281          *
 282          *  If the wiki does not allow anonymous users to read it, the mode set here
 283          *  will be ignored, and private caching headers will always be sent. In other words,
 284          *  the "public" mode is equivalent to saying that the data sent is as public as a page
 285          *  view.
 286          *
 287          *  For user-dependent data, the private mode should generally be used. The
 288          *  anon-public-user-private mode should only be used where there is a particularly
 289          *  good performance reason for caching the anonymous response, but where the
 290          *  response to logged-in users may differ, or may contain private data.
 291          *
 292          *  If this function is never called, then the default will be the private mode.
 293          */
 294         public function setCacheMode( $mode ) {
 295                 if ( !in_array( $mode, array( 'private', 'public', 'anon-public-user-private' ) ) ) {
 296                         wfDebug( __METHOD__ . ": unrecognised cache mode \"$mode\"\n" );
 297
 298                         // Ignore for forwards-compatibility
 299                         return;
 300                 }
 301
 302                 if ( !User::isEveryoneAllowed( 'read' ) ) {
 303                         // Private wiki, only private headers
 304                         if ( $mode !== 'private' ) {
 305                                 wfDebug( __METHOD__ . ": ignoring request for $mode cache mode, private wiki\n" );
 306
 307                                 return;
 308                         }
 309                 }
 310
 311                 if ( $mode === 'public' && $this->getParameter( 'uselang' ) === 'user' ) {
 312                         // User language is used for i18n, so we don't want to publicly
 313                         // cache. Anons are ok, because if they have non-default language
 314                         // then there's an appropriate Vary header set by whatever set
 315                         // their non-default language.
 316                         wfDebug( __METHOD__ . ": downgrading cache mode 'public' to " .
 317                                 "'anon-public-user-private' due to uselang=user\n" );
 318                         $mode = 'anon-public-user-private';
 319                 }
 320
 321                 wfDebug( __METHOD__ . ": setting cache mode $mode\n" );
 322                 $this->mCacheMode = $mode;
 323         }
 324
 325         /**
 326          * Set directives (key/value pairs) for the Cache-Control header.
 327          * Boolean values will be formatted as such, by including or omitting
 328          * without an equals sign.
 329          *
 330          * Cache control values set here will only be used if the cache mode is not
 331          * private, see setCacheMode().
 332          *
 333          * @param array $directives
 334          */
 335         public function setCacheControl( $directives ) {
 336                 $this->mCacheControl = $directives + $this->mCacheControl;
 337         }
 338
 339         /**
 340          * Create an instance of an output formatter by its name
 341          *
 342          * @param string $format
 343          *
 344          * @return ApiFormatBase
 345          */
 346         public function createPrinterByName( $format ) {
 347                 $printer = $this->mModuleMgr->getModule( $format, 'format' );
 348                 if ( $printer === null ) {
 349                         $this->dieUsage( "Unrecognized format: {$format}", 'unknown_format' );
 350                 }
 351
 352                 return $printer;
 353         }
 354
 355         /**
 356          * Execute api request. Any errors will be handled if the API was called by the remote client.
 357          */
 358         public function execute() {
 359                 $this->profileIn();
 360                 if ( $this->mInternalMode ) {
 361                         $this->executeAction();
 362                 } else {
 363                         $this->executeActionWithErrorHandling();
 364                 }
 365
 366                 $this->profileOut();
 367         }
 368
 369         /**
 370          * Execute an action, and in case of an error, erase whatever partial results
 371          * have been accumulated, and replace it with an error message and a help screen.
 372          */
 373         protected function executeActionWithErrorHandling() {
 374                 // Verify the CORS header before executing the action
 375                 if ( !$this->handleCORS() ) {
 376                         // handleCORS() has sent a 403, abort
 377                         return;
 378                 }
 379
 380                 // Exit here if the request method was OPTIONS
 381                 // (assume there will be a followup GET or POST)
 382                 if ( $this->getRequest()->getMethod() === 'OPTIONS' ) {
 383                         return;
 384                 }
 385
 386                 // In case an error occurs during data output,
 387                 // clear the output buffer and print just the error information
 388                 ob_start();
 389
 390                 $t = microtime( true );
 391                 try {
 392                         $this->executeAction();
 393                 } catch ( Exception $e ) {
 394                         $this->handleException( $e );
 395                 }
 396
 397                 // Log the request whether or not there was an error
 398                 $this->logRequest( microtime( true ) - $t );
 399
 400                 // Send cache headers after any code which might generate an error, to
 401                 // avoid sending public cache headers for errors.
 402                 $this->sendCacheHeaders();
 403
 404                 ob_end_flush();
 405         }
 406
 407         /**
 408          * Handle an exception as an API response
 409          *
 410          * @since 1.23
 411          * @param Exception $e
 412          */
 413         protected function handleException( Exception $e ) {
 414                 // Bug 63145: Rollback any open database transactions
 415                 if ( !( $e instanceof UsageException ) ) {
 416                         // UsageExceptions are intentional, so don't rollback if that's the case
 417                         MWExceptionHandler::rollbackMasterChangesAndLog( $e );
 418                 }
 419
 420                 // Allow extra cleanup and logging
 421                 Hooks::run( 'ApiMain::onException', array( $this, $e ) );
 422
 423                 // Log it
 424                 if ( !( $e instanceof UsageException ) ) {
 425                         MWExceptionHandler::logException( $e );
 426                 }
 427
 428                 // Handle any kind of exception by outputting properly formatted error message.
 429                 // If this fails, an unhandled exception should be thrown so that global error
 430                 // handler will process and log it.
 431
 432                 $errCode = $this->substituteResultWithError( $e );
 433
 434                 // Error results should not be cached
 435                 $this->setCacheMode( 'private' );
 436
 437                 $response = $this->getRequest()->response();
 438                 $headerStr = 'MediaWiki-API-Error: ' . $errCode;
 439                 if ( $e->getCode() === 0 ) {
 440                         $response->header( $headerStr );
 441                 } else {
 442                         $response->header( $headerStr, true, $e->getCode() );
 443                 }
 444
 445                 // Reset and print just the error message
 446                 ob_clean();
 447
 448                 // If the error occurred during printing, do a printer->profileOut()
 449                 $this->mPrinter->safeProfileOut();
 450                 $this->printResult( true );
 451         }
 452
 453         /**
 454          * Handle an exception from the ApiBeforeMain hook.
 455          *
 456          * This tries to print the exception as an API response, to be more
 457          * friendly to clients. If it fails, it will rethrow the exception.
 458          *
 459          * @since 1.23
 460          * @param Exception $e
 461          */
 462         public static function handleApiBeforeMainException( Exception $e ) {
 463                 ob_start();
 464
 465                 try {
 466                         $main = new self( RequestContext::getMain(), false );
 467                         $main->handleException( $e );
 468                 } catch ( Exception $e2 ) {
 469                         // Nope, even that didn't work. Punt.
 470                         throw $e;
 471                 }
 472
 473                 // Log the request and reset cache headers
 474                 $main->logRequest( 0 );
 475                 $main->sendCacheHeaders();
 476
 477                 ob_end_flush();
 478         }
 479
 480         /**
 481          * Check the &origin= query parameter against the Origin: HTTP header and respond appropriately.
 482          *
 483          * If no origin parameter is present, nothing happens.
 484          * If an origin parameter is present but doesn't match the Origin header, a 403 status code
 485          * is set and false is returned.
 486          * If the parameter and the header do match, the header is checked against $wgCrossSiteAJAXdomains
 487          * and $wgCrossSiteAJAXdomainExceptions, and if the origin qualifies, the appropriate CORS
 488          * headers are set.
 489          *
 490          * @return bool False if the caller should abort (403 case), true otherwise (all other cases)
 491          */
 492         protected function handleCORS() {
 493                 $originParam = $this->getParameter( 'origin' ); // defaults to null
 494                 if ( $originParam === null ) {
 495                         // No origin parameter, nothing to do
 496                         return true;
 497                 }
 498
 499                 $request = $this->getRequest();
 500                 $response = $request->response();
 501                 // Origin: header is a space-separated list of origins, check all of them
 502                 $originHeader = $request->getHeader( 'Origin' );
 503                 if ( $originHeader === false ) {
 504                         $origins = array();
 505                 } else {
 506                         $origins = explode( ' ', $originHeader );
 507                 }
 508
 509                 if ( !in_array( $originParam, $origins ) ) {
 510                         // origin parameter set but incorrect
 511                         // Send a 403 response
 512                         $message = HttpStatus::getMessage( 403 );
 513                         $response->header( "HTTP/1.1 403 $message", true, 403 );
 514                         $response->header( 'Cache-Control: no-cache' );
 515                         echo "'origin' parameter does not match Origin header\n";
 516
 517                         return false;
 518                 }
 519
 520                 $config = $this->getConfig();
 521                 $matchOrigin = self::matchOrigin(
 522                         $originParam,
 523                         $config->get( 'CrossSiteAJAXdomains' ),
 524                         $config->get( 'CrossSiteAJAXdomainExceptions' )
 525                 );
 526
 527                 if ( $matchOrigin ) {
 528                         $response->header( "Access-Control-Allow-Origin: $originParam" );
 529                         $response->header( 'Access-Control-Allow-Credentials: true' );
 530                         $response->header( 'Access-Control-Allow-Headers: Api-User-Agent' );
 531                         $this->getOutput()->addVaryHeader( 'Origin' );
 532                 }
 533
 534                 return true;
 535         }
 536
 537         /**
 538          * Attempt to match an Origin header against a set of rules and a set of exceptions
 539          * @param string $value Origin header
 540          * @param array $rules Set of wildcard rules
 541          * @param array $exceptions Set of wildcard rules
 542          * @return bool True if $value matches a rule in $rules and doesn't match
 543          *    any rules in $exceptions, false otherwise
 544          */
 545         protected static function matchOrigin( $value, $rules, $exceptions ) {
 546                 foreach ( $rules as $rule ) {
 547                         if ( preg_match( self::wildcardToRegex( $rule ), $value ) ) {
 548                                 // Rule matches, check exceptions
 549                                 foreach ( $exceptions as $exc ) {
 550                                         if ( preg_match( self::wildcardToRegex( $exc ), $value ) ) {
 551                                                 return false;
 552                                         }
 553                                 }
 554
 555                                 return true;
 556                         }
 557                 }
 558
 559                 return false;
 560         }
 561
 562         /**
 563          * Helper function to convert wildcard string into a regex
 564          * '*' => '.*?'
 565          * '?' => '.'
 566          *
 567          * @param string $wildcard String with wildcards
 568          * @return string Regular expression
 569          */
 570         protected static function wildcardToRegex( $wildcard ) {
 571                 $wildcard = preg_quote( $wildcard, '/' );
 572                 $wildcard = str_replace(
 573                         array( '\*', '\?' ),
 574                         array( '.*?', '.' ),
 575                         $wildcard
 576                 );
 577
 578                 return "/https?:\/\/$wildcard/";
 579         }
 580
 581         protected function sendCacheHeaders() {
 582                 $response = $this->getRequest()->response();
 583                 $out = $this->getOutput();
 584
 585                 $config = $this->getConfig();
 586
 587                 if ( $config->get( 'VaryOnXFP' ) ) {
 588                         $out->addVaryHeader( 'X-Forwarded-Proto' );
 589                 }
 590
 591                 if ( $this->mCacheMode == 'private' ) {
 592                         $response->header( 'Cache-Control: private' );
 593                         return;
 594                 }
 595
 596                 $useXVO = $config->get( 'UseXVO' );
 597                 if ( $this->mCacheMode == 'anon-public-user-private' ) {
 598                         $out->addVaryHeader( 'Cookie' );
 599                         $response->header( $out->getVaryHeader() );
 600                         if ( $useXVO ) {
 601                                 $response->header( $out->getXVO() );
 602                                 if ( $out->haveCacheVaryCookies() ) {
 603                                         // Logged in, mark this request private
 604                                         $response->header( 'Cache-Control: private' );
 605                                         return;
 606                                 }
 607                                 // Logged out, send normal public headers below
 608                         } elseif ( session_id() != '' ) {
 609                                 // Logged in or otherwise has session (e.g. anonymous users who have edited)
 610                                 // Mark request private
 611                                 $response->header( 'Cache-Control: private' );
 612
 613                                 return;
 614                         } // else no XVO and anonymous, send public headers below
 615                 }
 616
 617                 // Send public headers
 618                 $response->header( $out->getVaryHeader() );
 619                 if ( $useXVO ) {
 620                         $response->header( $out->getXVO() );
 621                 }
 622
 623                 // If nobody called setCacheMaxAge(), use the (s)maxage parameters
 624                 if ( !isset( $this->mCacheControl['s-maxage'] ) ) {
 625                         $this->mCacheControl['s-maxage'] = $this->getParameter( 'smaxage' );
 626                 }
 627                 if ( !isset( $this->mCacheControl['max-age'] ) ) {
 628                         $this->mCacheControl['max-age'] = $this->getParameter( 'maxage' );
 629                 }
 630
 631                 if ( !$this->mCacheControl['s-maxage'] && !$this->mCacheControl['max-age'] ) {
 632                         // Public cache not requested
 633                         // Sending a Vary header in this case is harmless, and protects us
 634                         // against conditional calls of setCacheMaxAge().
 635                         $response->header( 'Cache-Control: private' );
 636
 637                         return;
 638                 }
 639
 640                 $this->mCacheControl['public'] = true;
 641
 642                 // Send an Expires header
 643                 $maxAge = min( $this->mCacheControl['s-maxage'], $this->mCacheControl['max-age'] );
 644                 $expiryUnixTime = ( $maxAge == 0 ? 1 : time() + $maxAge );
 645                 $response->header( 'Expires: ' . wfTimestamp( TS_RFC2822, $expiryUnixTime ) );
 646
 647                 // Construct the Cache-Control header
 648                 $ccHeader = '';
 649                 $separator = '';
 650                 foreach ( $this->mCacheControl as $name => $value ) {
 651                         if ( is_bool( $value ) ) {
 652                                 if ( $value ) {
 653                                         $ccHeader .= $separator . $name;
 654                                         $separator = ', ';
 655                                 }
 656                         } else {
 657                                 $ccHeader .= $separator . "$name=$value";
 658                                 $separator = ', ';
 659                         }
 660                 }
 661
 662                 $response->header( "Cache-Control: $ccHeader" );
 663         }
 664
 665         /**
 666          * Replace the result data with the information about an exception.
 667          * Returns the error code
 668          * @param Exception $e
 669          * @return string
 670          */
 671         protected function substituteResultWithError( $e ) {
 672                 $result = $this->getResult();
 673
 674                 // Printer may not be initialized if the extractRequestParams() fails for the main module
 675                 if ( !isset( $this->mPrinter ) ) {
 676                         // The printer has not been created yet. Try to manually get formatter value.
 677                         $value = $this->getRequest()->getVal( 'format', self::API_DEFAULT_FORMAT );
 678                         if ( !$this->mModuleMgr->isDefined( $value, 'format' ) ) {
 679                                 $value = self::API_DEFAULT_FORMAT;
 680                         }
 681
 682                         $this->mPrinter = $this->createPrinterByName( $value );
 683                 }
 684
 685                 // Printer may not be able to handle errors. This is particularly
 686                 // likely if the module returns something for getCustomPrinter().
 687                 if ( !$this->mPrinter->canPrintErrors() ) {
 688                         $this->mPrinter->safeProfileOut();
 689                         $this->mPrinter = $this->createPrinterByName( self::API_DEFAULT_FORMAT );
 690                 }
 691
 692                 // Update raw mode flag for the selected printer.
 693                 $result->setRawMode( $this->mPrinter->getNeedsRawData() );
 694
 695                 $config = $this->getConfig();
 696
 697                 if ( $e instanceof UsageException ) {
 698                         // User entered incorrect parameters - generate error response
 699                         $errMessage = $e->getMessageArray();
 700                         $link = wfExpandUrl( wfScript( 'api' ) );
 701                         ApiResult::setContent( $errMessage, "See $link for API usage" );
 702                 } else {
 703                         // Something is seriously wrong
 704                         if ( ( $e instanceof DBQueryError ) && !$config->get( 'ShowSQLErrors' ) ) {
 705                                 $info = 'Database query error';
 706                         } else {
 707                                 $info = "Exception Caught: {$e->getMessage()}";
 708                         }
 709
 710                         $errMessage = array(
 711                                 'code' => 'internal_api_error_' . get_class( $e ),
 712                                 'info' => $info,
 713                         );
 714                         ApiResult::setContent(
 715                                 $errMessage,
 716                                 $config->get( 'ShowExceptionDetails' ) ? "\n\n{$e->getTraceAsString()}\n\n" : ''
 717                         );
 718                 }
 719
 720                 // Remember all the warnings to re-add them later
 721                 $oldResult = $result->getData();
 722                 $warnings = isset( $oldResult['warnings'] ) ? $oldResult['warnings'] : null;
 723
 724                 $result->reset();
 725                 // Re-add the id
 726                 $requestid = $this->getParameter( 'requestid' );
 727                 if ( !is_null( $requestid ) ) {
 728                         $result->addValue( null, 'requestid', $requestid, ApiResult::NO_SIZE_CHECK );
 729                 }
 730                 if ( $config->get( 'ShowHostnames' ) ) {
 731                         // servedby is especially useful when debugging errors
 732                         $result->addValue( null, 'servedby', wfHostName(), ApiResult::NO_SIZE_CHECK );
 733                 }
 734                 if ( $warnings !== null ) {
 735                         $result->addValue( null, 'warnings', $warnings, ApiResult::NO_SIZE_CHECK );
 736                 }
 737
 738                 $result->addValue( null, 'error', $errMessage, ApiResult::NO_SIZE_CHECK );
 739
 740                 return $errMessage['code'];
 741         }
 742
 743         /**
 744          * Set up for the execution.
 745          * @return array
 746          */
 747         protected function setupExecuteAction() {
 748                 // First add the id to the top element
 749                 $result = $this->getResult();
 750                 $requestid = $this->getParameter( 'requestid' );
 751                 if ( !is_null( $requestid ) ) {
 752                         $result->addValue( null, 'requestid', $requestid );
 753                 }
 754
 755                 if ( $this->getConfig()->get( 'ShowHostnames' ) ) {
 756                         $servedby = $this->getParameter( 'servedby' );
 757                         if ( $servedby ) {
 758                                 $result->addValue( null, 'servedby', wfHostName() );
 759                         }
 760                 }
 761
 762                 if ( $this->getParameter( 'curtimestamp' ) ) {
 763                         $result->addValue( null, 'curtimestamp', wfTimestamp( TS_ISO_8601, time() ),
 764                                 ApiResult::NO_SIZE_CHECK );
 765                 }
 766
 767                 $params = $this->extractRequestParams();
 768
 769                 $this->mAction = $params['action'];
 770
 771                 if ( !is_string( $this->mAction ) ) {
 772                         $this->dieUsage( 'The API requires a valid action parameter', 'unknown_action' );
 773                 }
 774
 775                 return $params;
 776         }
 777
 778         /**
 779          * Set up the module for response
 780          * @return ApiBase The module that will handle this action
 781          */
 782         protected function setupModule() {
 783                 // Instantiate the module requested by the user
 784                 $module = $this->mModuleMgr->getModule( $this->mAction, 'action' );
 785                 if ( $module === null ) {
 786                         $this->dieUsage( 'The API requires a valid action parameter', 'unknown_action' );
 787                 }
 788                 $moduleParams = $module->extractRequestParams();
 789
 790                 // Check token, if necessary
 791                 if ( $module->needsToken() === true ) {
 792                         throw new MWException(
 793                                 "Module '{$module->getModuleName()}' must be updated for the new token handling. " .
 794                                 "See documentation for ApiBase::needsToken for details."
 795                         );
 796                 }
 797                 if ( $module->needsToken() ) {
 798                         if ( !$module->mustBePosted() ) {
 799                                 throw new MWException(
 800                                         "Module '{$module->getModuleName()}' must require POST to use tokens."
 801                                 );
 802                         }
 803
 804                         if ( !isset( $moduleParams['token'] ) ) {
 805                                 $this->dieUsageMsg( array( 'missingparam', 'token' ) );
 806                         }
 807
 808                         if ( !$this->getConfig()->get( 'DebugAPI' ) &&
 809                                 array_key_exists(
 810                                         $module->encodeParamName( 'token' ),
 811                                         $this->getRequest()->getQueryValues()
 812                                 )
 813                         ) {
 814                                 $this->dieUsage(
 815                                         "The '{$module->encodeParamName( 'token' )}' parameter was found in the query string, but must be in the POST body",
 816                                         'mustposttoken'
 817                                 );
 818                         }
 819
 820                         if ( !$module->validateToken( $moduleParams['token'], $moduleParams ) ) {
 821                                 $this->dieUsageMsg( 'sessionfailure' );
 822                         }
 823                 }
 824
 825                 return $module;
 826         }
 827
 828         /**
 829          * Check the max lag if necessary
 830          * @param ApiBase $module Api module being used
 831          * @param array $params Array an array containing the request parameters.
 832          * @return bool True on success, false should exit immediately
 833          */
 834         protected function checkMaxLag( $module, $params ) {
 835                 if ( $module->shouldCheckMaxlag() && isset( $params['maxlag'] ) ) {
 836                         // Check for maxlag
 837                         $maxLag = $params['maxlag'];
 838                         list( $host, $lag ) = wfGetLB()->getMaxLag();
 839                         if ( $lag > $maxLag ) {
 840                                 $response = $this->getRequest()->response();
 841
 842                                 $response->header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
 843                                 $response->header( 'X-Database-Lag: ' . intval( $lag ) );
 844
 845                                 if ( $this->getConfig()->get( 'ShowHostnames' ) ) {
 846                                         $this->dieUsage( "Waiting for $host: $lag seconds lagged", 'maxlag' );
 847                                 }
 848
 849                                 $this->dieUsage( "Waiting for a database server: $lag seconds lagged", 'maxlag' );
 850                         }
 851                 }
 852
 853                 return true;
 854         }
 855
 856         /**
 857          * Check for sufficient permissions to execute
 858          * @param ApiBase $module An Api module
 859          */
 860         protected function checkExecutePermissions( $module ) {
 861                 $user = $this->getUser();
 862                 if ( $module->isReadMode() && !User::isEveryoneAllowed( 'read' ) &&
 863                         !$user->isAllowed( 'read' )
 864                 ) {
 865                         $this->dieUsageMsg( 'readrequired' );
 866                 }
 867                 if ( $module->isWriteMode() ) {
 868                         if ( !$this->mEnableWrite ) {
 869                                 $this->dieUsageMsg( 'writedisabled' );
 870                         }
 871                         if ( !$user->isAllowed( 'writeapi' ) ) {
 872                                 $this->dieUsageMsg( 'writerequired' );
 873                         }
 874                         if ( wfReadOnly() ) {
 875                                 $this->dieReadOnly();
 876                         }
 877                 }
 878
 879                 // Allow extensions to stop execution for arbitrary reasons.
 880                 $message = false;
 881                 if ( !Hooks::run( 'ApiCheckCanExecute', array( $module, $user, &$message ) ) ) {
 882                         $this->dieUsageMsg( $message );
 883                 }
 884         }
 885
 886         /**
 887          * Check asserts of the user's rights
 888          * @param array $params
 889          */
 890         protected function checkAsserts( $params ) {
 891                 if ( isset( $params['assert'] ) ) {
 892                         $user = $this->getUser();
 893                         switch ( $params['assert'] ) {
 894                                 case 'user':
 895                                         if ( $user->isAnon() ) {
 896                                                 $this->dieUsage( 'Assertion that the user is logged in failed', 'assertuserfailed' );
 897                                         }
 898                                         break;
 899                                 case 'bot':
 900                                         if ( !$user->isAllowed( 'bot' ) ) {
 901                                                 $this->dieUsage( 'Assertion that the user has the bot right failed', 'assertbotfailed' );
 902                                         }
 903                                         break;
 904                         }
 905                 }
 906         }
 907
 908         /**
 909          * Check POST for external response and setup result printer
 910          * @param ApiBase $module An Api module
 911          * @param array $params An array with the request parameters
 912          */
 913         protected function setupExternalResponse( $module, $params ) {
 914                 if ( !$this->getRequest()->wasPosted() && $module->mustBePosted() ) {
 915                         // Module requires POST. GET request might still be allowed
 916                         // if $wgDebugApi is true, otherwise fail.
 917                         $this->dieUsageMsgOrDebug( array( 'mustbeposted', $this->mAction ) );
 918                 }
 919
 920                 // See if custom printer is used
 921                 $this->mPrinter = $module->getCustomPrinter();
 922                 if ( is_null( $this->mPrinter ) ) {
 923                         // Create an appropriate printer
 924                         $this->mPrinter = $this->createPrinterByName( $params['format'] );
 925                 }
 926
 927                 if ( $this->mPrinter->getNeedsRawData() ) {
 928                         $this->getResult()->setRawMode();
 929                 }
 930         }
 931
 932         /**
 933          * Execute the actual module, without any error handling
 934          */
 935         protected function executeAction() {
 936                 $params = $this->setupExecuteAction();
 937                 $module = $this->setupModule();
 938                 $this->mModule = $module;
 939
 940                 $this->checkExecutePermissions( $module );
 941
 942                 if ( !$this->checkMaxLag( $module, $params ) ) {
 943                         return;
 944                 }
 945
 946                 if ( !$this->mInternalMode ) {
 947                         $this->setupExternalResponse( $module, $params );
 948                 }
 949
 950                 $this->checkAsserts( $params );
 951
 952                 // Execute
 953                 $module->profileIn();
 954                 $module->execute();
 955                 Hooks::run( 'APIAfterExecute', array( &$module ) );
 956                 $module->profileOut();
 957
 958                 $this->reportUnusedParams();
 959
 960                 if ( !$this->mInternalMode ) {
 961                         //append Debug information
 962                         MWDebug::appendDebugInfoToApiResult( $this->getContext(), $this->getResult() );
 963
 964                         // Print result data
 965                         $this->printResult( false );
 966                 }
 967         }
 968
 969         /**
 970          * Log the preceding request
 971          * @param int $time Time in seconds
 972          */
 973         protected function logRequest( $time ) {
 974                 $request = $this->getRequest();
 975                 $milliseconds = $time === null ? '?' : round( $time * 1000 );
 976                 $s = 'API' .
 977                         ' ' . $request->getMethod() .
 978                         ' ' . wfUrlencode( str_replace( ' ', '_', $this->getUser()->getName() ) ) .
 979                         ' ' . $request->getIP() .
 980                         ' T=' . $milliseconds . 'ms';
 981                 foreach ( $this->getParamsUsed() as $name ) {
 982                         $value = $request->getVal( $name );
 983                         if ( $value === null ) {
 984                                 continue;
 985                         }
 986                         $s .= ' ' . $name . '=';
 987                         if ( strlen( $value ) > 256 ) {
 988                                 $encValue = $this->encodeRequestLogValue( substr( $value, 0, 256 ) );
 989                                 $s .= $encValue . '[...]';
 990                         } else {
 991                                 $s .= $this->encodeRequestLogValue( $value );
 992                         }
 993                 }
 994                 $s .= "\n";
 995                 wfDebugLog( 'api', $s, 'private' );
 996         }
 997
 998         /**
 999          * Encode a value in a format suitable for a space-separated log line.
1000          * @param string $s
1001          * @return string
1002          */
1003         protected function encodeRequestLogValue( $s ) {
1004                 static $table;
1005                 if ( !$table ) {
1006                         $chars = ';@$!*(),/:';
1007                         $numChars = strlen( $chars );
1008                         for ( $i = 0; $i < $numChars; $i++ ) {
1009                                 $table[rawurlencode( $chars[$i] )] = $chars[$i];
1010                         }
1011                 }
1012
1013                 return strtr( rawurlencode( $s ), $table );
1014         }
1015
1016         /**
1017          * Get the request parameters used in the course of the preceding execute() request
1018          * @return array
1019          */
1020         protected function getParamsUsed() {
1021                 return array_keys( $this->mParamsUsed );
1022         }
1023
1024         /**
1025          * Get a request value, and register the fact that it was used, for logging.
1026          * @param string $name
1027          * @param mixed $default
1028          * @return mixed
1029          */
1030         public function getVal( $name, $default = null ) {
1031                 $this->mParamsUsed[$name] = true;
1032
1033                 $ret = $this->getRequest()->getVal( $name );
1034                 if ( $ret === null ) {
1035                         if ( $this->getRequest()->getArray( $name ) !== null ) {
1036                                 // See bug 10262 for why we don't just join( '|', ... ) the
1037                                 // array.
1038                                 $this->setWarning(
1039                                         "Parameter '$name' uses unsupported PHP array syntax"
1040                                 );
1041                         }
1042                         $ret = $default;
1043                 }
1044                 return $ret;
1045         }
1046
1047         /**
1048          * Get a boolean request value, and register the fact that the parameter
1049          * was used, for logging.
1050          * @param string $name
1051          * @return bool
1052          */
1053         public function getCheck( $name ) {
1054                 return $this->getVal( $name, null ) !== null;
1055         }
1056
1057         /**
1058          * Get a request upload, and register the fact that it was used, for logging.
1059          *
1060          * @since 1.21
1061          * @param string $name Parameter name
1062          * @return WebRequestUpload
1063          */
1064         public function getUpload( $name ) {
1065                 $this->mParamsUsed[$name] = true;
1066
1067                 return $this->getRequest()->getUpload( $name );
1068         }
1069
1070         /**
1071          * Report unused parameters, so the client gets a hint in case it gave us parameters we don't know,
1072          * for example in case of spelling mistakes or a missing 'g' prefix for generators.
1073          */
1074         protected function reportUnusedParams() {
1075                 $paramsUsed = $this->getParamsUsed();
1076                 $allParams = $this->getRequest()->getValueNames();
1077
1078                 if ( !$this->mInternalMode ) {
1079                         // Printer has not yet executed; don't warn that its parameters are unused
1080                         $printerParams = array_map(
1081                                 array( $this->mPrinter, 'encodeParamName' ),
1082                                 array_keys( $this->mPrinter->getFinalParams() ?: array() )
1083                         );
1084                         $unusedParams = array_diff( $allParams, $paramsUsed, $printerParams );
1085                 } else {
1086                         $unusedParams = array_diff( $allParams, $paramsUsed );
1087                 }
1088
1089                 if ( count( $unusedParams ) ) {
1090                         $s = count( $unusedParams ) > 1 ? 's' : '';
1091                         $this->setWarning( "Unrecognized parameter$s: '" . implode( $unusedParams, "', '" ) . "'" );
1092                 }
1093         }
1094
1095         /**
1096          * Print results using the current printer
1097          *
1098          * @param bool $isError
1099          */
1100         protected function printResult( $isError ) {
1101                 if ( $this->getConfig()->get( 'DebugAPI' ) !== false ) {
1102                         $this->setWarning( 'SECURITY WARNING: $wgDebugAPI is enabled' );
1103                 }
1104
1105                 $this->getResult()->cleanUpUTF8();
1106                 $printer = $this->mPrinter;
1107                 $printer->profileIn();
1108
1109                 $printer->initPrinter( false );
1110
1111                 $printer->execute();
1112                 $printer->closePrinter();
1113                 $printer->profileOut();
1114         }
1115
1116         /**
1117          * @return bool
1118          */
1119         public function isReadMode() {
1120                 return false;
1121         }
1122
1123         /**
1124          * See ApiBase for description.
1125          *
1126          * @return array
1127          */
1128         public function getAllowedParams() {
1129                 return array(
1130                         'action' => array(
1131                                 ApiBase::PARAM_DFLT => 'help',
1132                                 ApiBase::PARAM_TYPE => 'submodule',
1133                         ),
1134                         'format' => array(
1135                                 ApiBase::PARAM_DFLT => ApiMain::API_DEFAULT_FORMAT,
1136                                 ApiBase::PARAM_TYPE => 'submodule',
1137                         ),
1138                         'maxlag' => array(
1139                                 ApiBase::PARAM_TYPE => 'integer'
1140                         ),
1141                         'smaxage' => array(
1142                                 ApiBase::PARAM_TYPE => 'integer',
1143                                 ApiBase::PARAM_DFLT => 0
1144                         ),
1145                         'maxage' => array(
1146                                 ApiBase::PARAM_TYPE => 'integer',
1147                                 ApiBase::PARAM_DFLT => 0
1148                         ),
1149                         'assert' => array(
1150                                 ApiBase::PARAM_TYPE => array( 'user', 'bot' )
1151                         ),
1152                         'requestid' => null,
1153                         'servedby' => false,
1154                         'curtimestamp' => false,
1155                         'origin' => null,
1156                         'uselang' => array(
1157                                 ApiBase::PARAM_DFLT => 'user',
1158                         ),
1159                 );
1160         }
1161
1162         /** @see ApiBase::getExamplesMessages() */
1163         protected function getExamplesMessages() {
1164                 return array(
1165                         'action=help'
1166                                 => 'apihelp-help-example-main',
1167                         'action=help&recursivesubmodules=1'
1168                                 => 'apihelp-help-example-recursive',
1169                 );
1170         }
1171
1172         public function modifyHelp( array &$help, array $options ) {
1173                 // Wish PHP had an "array_insert_before". Instead, we have to manually
1174                 // reindex the array to get 'permissions' in the right place.
1175                 $oldHelp = $help;
1176                 $help = array();
1177                 foreach ( $oldHelp as $k => $v ) {
1178                         if ( $k === 'submodules' ) {
1179                                 $help['permissions'] = '';
1180                         }
1181                         $help[$k] = $v;
1182                 }
1183                 $help['credits'] = '';
1184
1185                 // Fill 'permissions'
1186                 $help['permissions'] .= Html::openElement( 'div',
1187                         array( 'class' => 'apihelp-block apihelp-permissions' ) );
1188                 $m = $this->msg( 'api-help-permissions' );
1189                 if ( !$m->isDisabled() ) {
1190                         $help['permissions'] .= Html::rawElement( 'div', array( 'class' => 'apihelp-block-head' ),
1191                                 $m->numParams( count( self::$mRights ) )->parse()
1192                         );
1193                 }
1194                 $help['permissions'] .= Html::openElement( 'dl' );
1195                 foreach ( self::$mRights as $right => $rightMsg ) {
1196                         $help['permissions'] .= Html::element( 'dt', null, $right );
1197
1198                         $rightMsg = $this->msg( $rightMsg['msg'], $rightMsg['params'] )->parse();
1199                         $help['permissions'] .= Html::rawElement( 'dd', null, $rightMsg );
1200
1201                         $groups = array_map( function ( $group ) {
1202                                 return $group == '*' ? 'all' : $group;
1203                         }, User::getGroupsWithPermission( $right ) );
1204
1205                         $help['permissions'] .= Html::rawElement( 'dd', null,
1206                                 $this->msg( 'api-help-permissions-granted-to' )
1207                                         ->numParams( count( $groups ) )
1208                                         ->params( $this->getLanguage()->commaList( $groups ) )
1209                                         ->parse()
1210                         );
1211                 }
1212                 $help['permissions'] .= Html::closeElement( 'dl' );
1213                 $help['permissions'] .= Html::closeElement( 'div' );
1214
1215                 // Fill 'credits', if applicable
1216                 if ( empty( $options['nolead'] ) ) {
1217                         $help['credits'] .= Html::element( 'h' . min( 6, $options['headerlevel'] + 1 ),
1218                                 array( 'id' => '+credits', 'class' => 'apihelp-header' ),
1219                                 $this->msg( 'api-credits-header' )->parse()
1220                         );
1221                         $help['credits'] .= $this->msg( 'api-credits' )->useDatabase( false )->parseAsBlock();
1222                 }
1223         }
1224
1225         private $mCanApiHighLimits = null;
1226
1227         /**
1228          * Check whether the current user is allowed to use high limits
1229          * @return bool
1230          */
1231         public function canApiHighLimits() {
1232                 if ( !isset( $this->mCanApiHighLimits ) ) {
1233                         $this->mCanApiHighLimits = $this->getUser()->isAllowed( 'apihighlimits' );
1234                 }
1235
1236                 return $this->mCanApiHighLimits;
1237         }
1238
1239         /**
1240          * Overrides to return this instance's module manager.
1241          * @return ApiModuleManager
1242          */
1243         public function getModuleManager() {
1244                 return $this->mModuleMgr;
1245         }
1246
1247         /**
1248          * Fetches the user agent used for this request
1249          *
1250          * The value will be the combination of the 'Api-User-Agent' header (if
1251          * any) and the standard User-Agent header (if any).
1252          *
1253          * @return string
1254          */
1255         public function getUserAgent() {
1256                 return trim(
1257                         $this->getRequest()->getHeader( 'Api-user-agent' ) . ' ' .
1258                         $this->getRequest()->getHeader( 'User-agent' )
1259                 );
1260         }
1261
1262         /************************************************************************//**
1263          * @name   Deprecated
1264          * @{
1265          */
1266
1267         /**
1268          * Sets whether the pretty-printer should format *bold* and $italics$
1269          *
1270          * @deprecated since 1.25
1271          * @param bool $help
1272          */
1273         public function setHelp( $help = true ) {
1274                 wfDeprecated( __METHOD__, '1.25' );
1275                 $this->mPrinter->setHelp( $help );
1276         }
1277
1278         /**
1279          * Override the parent to generate help messages for all available modules.
1280          *
1281          * @deprecated since 1.25
1282          * @return string
1283          */
1284         public function makeHelpMsg() {
1285                 wfDeprecated( __METHOD__, '1.25' );
1286                 global $wgMemc;
1287                 $this->setHelp();
1288                 // Get help text from cache if present
1289                 $key = wfMemcKey( 'apihelp', $this->getModuleName(),
1290                         str_replace( ' ', '_', SpecialVersion::getVersion( 'nodb' ) ) );
1291
1292                 $cacheHelpTimeout = $this->getConfig()->get( 'APICacheHelpTimeout' );
1293                 if ( $cacheHelpTimeout > 0 ) {
1294                         $cached = $wgMemc->get( $key );
1295                         if ( $cached ) {
1296                                 return $cached;
1297                         }
1298                 }
1299                 $retval = $this->reallyMakeHelpMsg();
1300                 if ( $cacheHelpTimeout > 0 ) {
1301                         $wgMemc->set( $key, $retval, $cacheHelpTimeout );
1302                 }
1303
1304                 return $retval;
1305         }
1306
1307         /**
1308          * @deprecated since 1.25
1309          * @return mixed|string
1310          */
1311         public function reallyMakeHelpMsg() {
1312                 wfDeprecated( __METHOD__, '1.25' );
1313                 $this->setHelp();
1314
1315                 // Use parent to make default message for the main module
1316                 $msg = parent::makeHelpMsg();
1317
1318                 $astriks = str_repeat( '*** ', 14 );
1319                 $msg .= "\n\n$astriks Modules  $astriks\n\n";
1320
1321                 foreach ( $this->mModuleMgr->getNames( 'action' ) as $name ) {
1322                         $module = $this->mModuleMgr->getModule( $name );
1323                         $msg .= self::makeHelpMsgHeader( $module, 'action' );
1324
1325                         $msg2 = $module->makeHelpMsg();
1326                         if ( $msg2 !== false ) {
1327                                 $msg .= $msg2;
1328                         }
1329                         $msg .= "\n";
1330                 }
1331
1332                 $msg .= "\n$astriks Permissions $astriks\n\n";
1333                 foreach ( self::$mRights as $right => $rightMsg ) {
1334                         $rightsMsg = $this->msg( $rightMsg['msg'], $rightMsg['params'] )
1335                                 ->useDatabase( false )
1336                                 ->inLanguage( 'en' )
1337                                 ->text();
1338                         $groups = User::getGroupsWithPermission( $right );
1339                         $msg .= "* " . $right . " *\n  $rightsMsg" .
1340                                 "\nGranted to:\n  " . str_replace( '*', 'all', implode( ', ', $groups ) ) . "\n\n";
1341                 }
1342
1343                 $msg .= "\n$astriks Formats  $astriks\n\n";
1344                 foreach ( $this->mModuleMgr->getNames( 'format' ) as $name ) {
1345                         $module = $this->mModuleMgr->getModule( $name );
1346                         $msg .= self::makeHelpMsgHeader( $module, 'format' );
1347                         $msg2 = $module->makeHelpMsg();
1348                         if ( $msg2 !== false ) {
1349                                 $msg .= $msg2;
1350                         }
1351                         $msg .= "\n";
1352                 }
1353
1354                 $credits = $this->msg( 'api-credits' )->useDatabase( 'false' )->inLanguage( 'en' )->text();
1355                 $credits = str_replace( "\n", "\n   ", $credits );
1356                 $msg .= "\n*** Credits: ***\n   $credits\n";
1357
1358                 return $msg;
1359         }
1360
1361         /**
1362          * @deprecated since 1.25
1363          * @param ApiBase $module
1364          * @param string $paramName What type of request is this? e.g. action,
1365          *    query, list, prop, meta, format
1366          * @return string
1367          */
1368         public static function makeHelpMsgHeader( $module, $paramName ) {
1369                 wfDeprecated( __METHOD__, '1.25' );
1370                 $modulePrefix = $module->getModulePrefix();
1371                 if ( strval( $modulePrefix ) !== '' ) {
1372                         $modulePrefix = "($modulePrefix) ";
1373                 }
1374
1375                 return "* $paramName={$module->getModuleName()} $modulePrefix*";
1376         }
1377
1378         /**
1379          * Check whether the user wants us to show version information in the API help
1380          * @return bool
1381          * @deprecated since 1.21, always returns false
1382          */
1383         public function getShowVersions() {
1384                 wfDeprecated( __METHOD__, '1.21' );
1385
1386                 return false;
1387         }
1388
1389         /**
1390          * Add or overwrite a module in this ApiMain instance. Intended for use by extending
1391          * classes who wish to add their own modules to their lexicon or override the
1392          * behavior of inherent ones.
1393          *
1394          * @deprecated since 1.21, Use getModuleManager()->addModule() instead.
1395          * @param string $name The identifier for this module.
1396          * @param ApiBase $class The class where this module is implemented.
1397          */
1398         protected function addModule( $name, $class ) {
1399                 $this->getModuleManager()->addModule( $name, 'action', $class );
1400         }
1401
1402         /**
1403          * Add or overwrite an output format for this ApiMain. Intended for use by extending
1404          * classes who wish to add to or modify current formatters.
1405          *
1406          * @deprecated since 1.21, Use getModuleManager()->addModule() instead.
1407          * @param string $name The identifier for this format.
1408          * @param ApiFormatBase $class The class implementing this format.
1409          */
1410         protected function addFormat( $name, $class ) {
1411                 $this->getModuleManager()->addModule( $name, 'format', $class );
1412         }
1413
1414         /**
1415          * Get the array mapping module names to class names
1416          * @deprecated since 1.21, Use getModuleManager()'s methods instead.
1417          * @return array
1418          */
1419         function getModules() {
1420                 return $this->getModuleManager()->getNamesWithClasses( 'action' );
1421         }
1422
1423         /**
1424          * Returns the list of supported formats in form ( 'format' => 'ClassName' )
1425          *
1426          * @since 1.18
1427          * @deprecated since 1.21, Use getModuleManager()'s methods instead.
1428          * @return array
1429          */
1430         public function getFormats() {
1431                 return $this->getModuleManager()->getNamesWithClasses( 'format' );
1432         }
1433
1434         /**@}*/
1435
1436 }
1437
1438 /**
1439  * This exception will be thrown when dieUsage is called to stop module execution.
1440  *
1441  * @ingroup API
1442  */
1443 class UsageException extends MWException {
1444
1445         private $mCodestr;
1446
1447         /**
1448          * @var null|array
1449          */
1450         private $mExtraData;
1451
1452         /**
1453          * @param string $message
1454          * @param string $codestr
1455          * @param int $code
1456          * @param array|null $extradata
1457          */
1458         public function __construct( $message, $codestr, $code = 0, $extradata = null ) {
1459                 parent::__construct( $message, $code );
1460                 $this->mCodestr = $codestr;
1461                 $this->mExtraData = $extradata;
1462         }
1463
1464         /**
1465          * @return string
1466          */
1467         public function getCodeString() {
1468                 return $this->mCodestr;
1469         }
1470
1471         /**
1472          * @return array
1473          */
1474         public function getMessageArray() {
1475                 $result = array(
1476                         'code' => $this->mCodestr,
1477                         'info' => $this->getMessage()
1478                 );
1479                 if ( is_array( $this->mExtraData ) ) {
1480                         $result = array_merge( $result, $this->mExtraData );
1481                 }
1482
1483                 return $result;
1484         }
1485
1486         /**
1487          * @return string
1488          */
1489         public function __toString() {
1490                 return "{$this->getCodeString()}: {$this->getMessage()}";
1491         }
1492 }
1493
1494 /**
1495  * For really cool vim folding this needs to be at the end:
1496  * vim: foldmarker=@{,@} foldmethod=marker
1497  */