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