includes/api/ApiMain.php

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