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