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                 'checktoken' => 'ApiCheckToken',
  68
  69                 // Write modules
  70                 'purge' => 'ApiPurge',
  71                 'setnotificationtimestamp' => 'ApiSetNotificationTimestamp',
  72                 'rollback' => 'ApiRollback',
  73                 'delete' => 'ApiDelete',
  74                 'undelete' => 'ApiUndelete',
  75                 'protect' => 'ApiProtect',
  76                 'block' => 'ApiBlock',
  77                 'unblock' => 'ApiUnblock',
  78                 'move' => 'ApiMove',
  79                 'edit' => 'ApiEditPage',
  80                 'upload' => 'ApiUpload',
  81                 'filerevert' => 'ApiFileRevert',
  82                 'emailuser' => 'ApiEmailUser',
  83                 'watch' => 'ApiWatch',
  84                 'patrol' => 'ApiPatrol',
  85                 'import' => 'ApiImport',
  86                 'clearhasmsg' => 'ApiClearHasMsg',
  87                 'userrights' => 'ApiUserrights',
  88                 'options' => 'ApiOptions',
  89                 'imagerotate' => 'ApiImageRotate',
  90                 'revisiondelete' => 'ApiRevisionDelete',
  91                 'managetags' => 'ApiManageTags',
  92                 'tag' => 'ApiTag',
  93         );
  94
  95         /**
  96          * List of available formats: format name => format class
  97          */
  98         private static $Formats = array(
  99                 'json' => 'ApiFormatJson',
 100                 'jsonfm' => 'ApiFormatJson',
 101                 'php' => 'ApiFormatPhp',
 102                 'phpfm' => 'ApiFormatPhp',
 103                 'xml' => 'ApiFormatXml',
 104                 'xmlfm' => 'ApiFormatXml',
 105                 'yaml' => 'ApiFormatYaml',
 106                 'yamlfm' => 'ApiFormatYaml',
 107                 'rawfm' => 'ApiFormatJson',
 108                 'txt' => 'ApiFormatTxt',
 109                 'txtfm' => 'ApiFormatTxt',
 110                 'dbg' => 'ApiFormatDbg',
 111                 'dbgfm' => 'ApiFormatDbg',
 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' => 'right-writeapi',
 125                         'params' => array()
 126                 ),
 127                 'apihighlimits' => array(
 128                         'msg' => 'api-help-right-apihighlimits',
 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, $mErrorFormatter, $mContinuationManager;
 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 IContextSource|WebRequest $context 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->lacksSameOriginSecurity() ) {
 182                                 // If we're in a mode that breaks the same-origin policy, strip
 183                                 // user credentials for security.
 184                                 wfDebug( "API: stripping user credentials when the same-origin policy is not applied\n" );
 185                                 $wgUser = new User();
 186                                 $this->getContext()->setUser( $wgUser );
 187                         }
 188                 }
 189
 190                 $uselang = $this->getParameter( 'uselang' );
 191                 if ( $uselang === 'user' ) {
 192                         // Assume the parent context is going to return the user language
 193                         // for uselang=user (see T85635).
 194                 } else {
 195                         if ( $uselang === 'content' ) {
 196                                 global $wgContLang;
 197                                 $uselang = $wgContLang->getCode();
 198                         }
 199                         $code = RequestContext::sanitizeLangCode( $uselang );
 200                         $this->getContext()->setLanguage( $code );
 201                         if ( !$this->mInternalMode ) {
 202                                 global $wgLang;
 203                                 $wgLang = $this->getContext()->getLanguage();
 204                                 RequestContext::getMain()->setLanguage( $wgLang );
 205                         }
 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                 Hooks::run( 'ApiMain::moduleManager', array( $this->mModuleMgr ) );
 216
 217                 $this->mResult = new ApiResult( $this->getConfig()->get( 'APIMaxResultSize' ) );
 218                 $this->mErrorFormatter = new ApiErrorFormatter_BackCompat( $this->mResult );
 219                 $this->mResult->setErrorFormatter( $this->mErrorFormatter );
 220                 $this->mResult->setMainForContinuation( $this );
 221                 $this->mContinuationManager = null;
 222                 $this->mEnableWrite = $enableWrite;
 223
 224                 $this->mSquidMaxage = -1; // flag for executeActionWithErrorHandling()
 225                 $this->mCommit = false;
 226         }
 227
 228         /**
 229          * Return true if the API was started by other PHP code using FauxRequest
 230          * @return bool
 231          */
 232         public function isInternalMode() {
 233                 return $this->mInternalMode;
 234         }
 235
 236         /**
 237          * Get the ApiResult object associated with current request
 238          *
 239          * @return ApiResult
 240          */
 241         public function getResult() {
 242                 return $this->mResult;
 243         }
 244
 245         /**
 246          * Get the ApiErrorFormatter object associated with current request
 247          * @return ApiErrorFormatter
 248          */
 249         public function getErrorFormatter() {
 250                 return $this->mErrorFormatter;
 251         }
 252
 253         /**
 254          * Get the continuation manager
 255          * @return ApiContinuationManager|null
 256          */
 257         public function getContinuationManager() {
 258                 return $this->mContinuationManager;
 259         }
 260
 261         /**
 262          * Set the continuation manager
 263          * @param ApiContinuationManager|null
 264          */
 265         public function setContinuationManager( $manager ) {
 266                 if ( $manager !== null ) {
 267                         if ( !$manager instanceof ApiContinuationManager ) {
 268                                 throw new InvalidArgumentException( __METHOD__ . ': Was passed ' .
 269                                         is_object( $manager ) ? get_class( $manager ) : gettype( $manager )
 270                                 );
 271                         }
 272                         if ( $this->mContinuationManager !== null ) {
 273                                 throw new UnexpectedValueException(
 274                                         __METHOD__ . ': tried to set manager from ' . $manager->getSource() .
 275                                         ' when a manager is already set from ' . $this->mContinuationManager->getSource()
 276                                 );
 277                         }
 278                 }
 279                 $this->mContinuationManager = $manager;
 280         }
 281
 282         /**
 283          * Get the API module object. Only works after executeAction()
 284          *
 285          * @return ApiBase
 286          */
 287         public function getModule() {
 288                 return $this->mModule;
 289         }
 290
 291         /**
 292          * Get the result formatter object. Only works after setupExecuteAction()
 293          *
 294          * @return ApiFormatBase
 295          */
 296         public function getPrinter() {
 297                 return $this->mPrinter;
 298         }
 299
 300         /**
 301          * Set how long the response should be cached.
 302          *
 303          * @param int $maxage
 304          */
 305         public function setCacheMaxAge( $maxage ) {
 306                 $this->setCacheControl( array(
 307                         'max-age' => $maxage,
 308                         's-maxage' => $maxage
 309                 ) );
 310         }
 311
 312         /**
 313          * Set the type of caching headers which will be sent.
 314          *
 315          * @param string $mode One of:
 316          *    - 'public':     Cache this object in public caches, if the maxage or smaxage
 317          *         parameter is set, or if setCacheMaxAge() was called. If a maximum age is
 318          *         not provided by any of these means, the object will be private.
 319          *    - 'private':    Cache this object only in private client-side caches.
 320          *    - 'anon-public-user-private': Make this object cacheable for logged-out
 321          *         users, but private for logged-in users. IMPORTANT: If this is set, it must be
 322          *         set consistently for a given URL, it cannot be set differently depending on
 323          *         things like the contents of the database, or whether the user is logged in.
 324          *
 325          *  If the wiki does not allow anonymous users to read it, the mode set here
 326          *  will be ignored, and private caching headers will always be sent. In other words,
 327          *  the "public" mode is equivalent to saying that the data sent is as public as a page
 328          *  view.
 329          *
 330          *  For user-dependent data, the private mode should generally be used. The
 331          *  anon-public-user-private mode should only be used where there is a particularly
 332          *  good performance reason for caching the anonymous response, but where the
 333          *  response to logged-in users may differ, or may contain private data.
 334          *
 335          *  If this function is never called, then the default will be the private mode.
 336          */
 337         public function setCacheMode( $mode ) {
 338                 if ( !in_array( $mode, array( 'private', 'public', 'anon-public-user-private' ) ) ) {
 339                         wfDebug( __METHOD__ . ": unrecognised cache mode \"$mode\"\n" );
 340
 341                         // Ignore for forwards-compatibility
 342                         return;
 343                 }
 344
 345                 if ( !User::isEveryoneAllowed( 'read' ) ) {
 346                         // Private wiki, only private headers
 347                         if ( $mode !== 'private' ) {
 348                                 wfDebug( __METHOD__ . ": ignoring request for $mode cache mode, private wiki\n" );
 349
 350                                 return;
 351                         }
 352                 }
 353
 354                 if ( $mode === 'public' && $this->getParameter( 'uselang' ) === 'user' ) {
 355                         // User language is used for i18n, so we don't want to publicly
 356                         // cache. Anons are ok, because if they have non-default language
 357                         // then there's an appropriate Vary header set by whatever set
 358                         // their non-default language.
 359                         wfDebug( __METHOD__ . ": downgrading cache mode 'public' to " .
 360                                 "'anon-public-user-private' due to uselang=user\n" );
 361                         $mode = 'anon-public-user-private';
 362                 }
 363
 364                 wfDebug( __METHOD__ . ": setting cache mode $mode\n" );
 365                 $this->mCacheMode = $mode;
 366         }
 367
 368         /**
 369          * Set directives (key/value pairs) for the Cache-Control header.
 370          * Boolean values will be formatted as such, by including or omitting
 371          * without an equals sign.
 372          *
 373          * Cache control values set here will only be used if the cache mode is not
 374          * private, see setCacheMode().
 375          *
 376          * @param array $directives
 377          */
 378         public function setCacheControl( $directives ) {
 379                 $this->mCacheControl = $directives + $this->mCacheControl;
 380         }
 381
 382         /**
 383          * Create an instance of an output formatter by its name
 384          *
 385          * @param string $format
 386          *
 387          * @return ApiFormatBase
 388          */
 389         public function createPrinterByName( $format ) {
 390                 $printer = $this->mModuleMgr->getModule( $format, 'format' );
 391                 if ( $printer === null ) {
 392                         $this->dieUsage( "Unrecognized format: {$format}", 'unknown_format' );
 393                 }
 394
 395                 return $printer;
 396         }
 397
 398         /**
 399          * Execute api request. Any errors will be handled if the API was called by the remote client.
 400          */
 401         public function execute() {
 402                 if ( $this->mInternalMode ) {
 403                         $this->executeAction();
 404                 } else {
 405                         $this->executeActionWithErrorHandling();
 406                 }
 407         }
 408
 409         /**
 410          * Execute an action, and in case of an error, erase whatever partial results
 411          * have been accumulated, and replace it with an error message and a help screen.
 412          */
 413         protected function executeActionWithErrorHandling() {
 414                 // Verify the CORS header before executing the action
 415                 if ( !$this->handleCORS() ) {
 416                         // handleCORS() has sent a 403, abort
 417                         return;
 418                 }
 419
 420                 // Exit here if the request method was OPTIONS
 421                 // (assume there will be a followup GET or POST)
 422                 if ( $this->getRequest()->getMethod() === 'OPTIONS' ) {
 423                         return;
 424                 }
 425
 426                 // In case an error occurs during data output,
 427                 // clear the output buffer and print just the error information
 428                 $obLevel = ob_get_level();
 429                 ob_start();
 430
 431                 $t = microtime( true );
 432                 try {
 433                         $this->executeAction();
 434                         $isError = false;
 435                 } catch ( Exception $e ) {
 436                         $this->handleException( $e );
 437                         $isError = true;
 438                 }
 439
 440                 // Log the request whether or not there was an error
 441                 $this->logRequest( microtime( true ) - $t );
 442
 443                 // Send cache headers after any code which might generate an error, to
 444                 // avoid sending public cache headers for errors.
 445                 $this->sendCacheHeaders( $isError );
 446
 447                 // Executing the action might have already messed with the output
 448                 // buffers.
 449                 while ( ob_get_level() > $obLevel ) {
 450                         ob_end_flush();
 451                 }
 452         }
 453
 454         /**
 455          * Handle an exception as an API response
 456          *
 457          * @since 1.23
 458          * @param Exception $e
 459          */
 460         protected function handleException( Exception $e ) {
 461                 // Bug 63145: Rollback any open database transactions
 462                 if ( !( $e instanceof UsageException ) ) {
 463                         // UsageExceptions are intentional, so don't rollback if that's the case
 464                         try {
 465                                 MWExceptionHandler::rollbackMasterChangesAndLog( $e );
 466                         } catch ( DBError $e2 ) {
 467                                 // Rollback threw an exception too. Log it, but don't interrupt
 468                                 // our regularly scheduled exception handling.
 469                                 MWExceptionHandler::logException( $e2 );
 470                         }
 471                 }
 472
 473                 // Allow extra cleanup and logging
 474                 Hooks::run( 'ApiMain::onException', array( $this, $e ) );
 475
 476                 // Log it
 477                 if ( !( $e instanceof UsageException ) ) {
 478                         MWExceptionHandler::logException( $e );
 479                 }
 480
 481                 // Handle any kind of exception by outputting properly formatted error message.
 482                 // If this fails, an unhandled exception should be thrown so that global error
 483                 // handler will process and log it.
 484
 485                 $errCode = $this->substituteResultWithError( $e );
 486
 487                 // Error results should not be cached
 488                 $this->setCacheMode( 'private' );
 489
 490                 $response = $this->getRequest()->response();
 491                 $headerStr = 'MediaWiki-API-Error: ' . $errCode;
 492                 if ( $e->getCode() === 0 ) {
 493                         $response->header( $headerStr );
 494                 } else {
 495                         $response->header( $headerStr, true, $e->getCode() );
 496                 }
 497
 498                 // Reset and print just the error message
 499                 ob_clean();
 500
 501                 // Printer may not be initialized if the extractRequestParams() fails for the main module
 502                 $this->createErrorPrinter();
 503
 504                 try {
 505                         $this->printResult( true );
 506                 } catch ( UsageException $ex ) {
 507                         // The error printer itself is failing. Try suppressing its request
 508                         // parameters and redo.
 509                         $this->setWarning(
 510                                 'Error printer failed (will retry without params): ' . $ex->getMessage()
 511                         );
 512                         $this->mPrinter = null;
 513                         $this->createErrorPrinter();
 514                         $this->mPrinter->forceDefaultParams();
 515                         $this->printResult( true );
 516                 }
 517         }
 518
 519         /**
 520          * Handle an exception from the ApiBeforeMain hook.
 521          *
 522          * This tries to print the exception as an API response, to be more
 523          * friendly to clients. If it fails, it will rethrow the exception.
 524          *
 525          * @since 1.23
 526          * @param Exception $e
 527          * @throws Exception
 528          */
 529         public static function handleApiBeforeMainException( Exception $e ) {
 530                 ob_start();
 531
 532                 try {
 533                         $main = new self( RequestContext::getMain(), false );
 534                         $main->handleException( $e );
 535                 } catch ( Exception $e2 ) {
 536                         // Nope, even that didn't work. Punt.
 537                         throw $e;
 538                 }
 539
 540                 // Log the request and reset cache headers
 541                 $main->logRequest( 0 );
 542                 $main->sendCacheHeaders( true );
 543
 544                 ob_end_flush();
 545         }
 546
 547         /**
 548          * Check the &origin= query parameter against the Origin: HTTP header and respond appropriately.
 549          *
 550          * If no origin parameter is present, nothing happens.
 551          * If an origin parameter is present but doesn't match the Origin header, a 403 status code
 552          * is set and false is returned.
 553          * If the parameter and the header do match, the header is checked against $wgCrossSiteAJAXdomains
 554          * and $wgCrossSiteAJAXdomainExceptions, and if the origin qualifies, the appropriate CORS
 555          * headers are set.
 556          * http://www.w3.org/TR/cors/#resource-requests
 557          * http://www.w3.org/TR/cors/#resource-preflight-requests
 558          *
 559          * @return bool False if the caller should abort (403 case), true otherwise (all other cases)
 560          */
 561         protected function handleCORS() {
 562                 $originParam = $this->getParameter( 'origin' ); // defaults to null
 563                 if ( $originParam === null ) {
 564                         // No origin parameter, nothing to do
 565                         return true;
 566                 }
 567
 568                 $request = $this->getRequest();
 569                 $response = $request->response();
 570
 571                 // Origin: header is a space-separated list of origins, check all of them
 572                 $originHeader = $request->getHeader( 'Origin' );
 573                 if ( $originHeader === false ) {
 574                         $origins = array();
 575                 } else {
 576                         $originHeader = trim( $originHeader );
 577                         $origins = preg_split( '/\s+/', $originHeader );
 578                 }
 579
 580                 if ( !in_array( $originParam, $origins ) ) {
 581                         // origin parameter set but incorrect
 582                         // Send a 403 response
 583                         $response->statusHeader( 403 );
 584                         $response->header( 'Cache-Control: no-cache' );
 585                         echo "'origin' parameter does not match Origin header\n";
 586
 587                         return false;
 588                 }
 589
 590                 $config = $this->getConfig();
 591                 $matchOrigin = count( $origins ) === 1 && self::matchOrigin(
 592                         $originParam,
 593                         $config->get( 'CrossSiteAJAXdomains' ),
 594                         $config->get( 'CrossSiteAJAXdomainExceptions' )
 595                 );
 596
 597                 if ( $matchOrigin ) {
 598                         $requestedMethod = $request->getHeader( 'Access-Control-Request-Method' );
 599                         $preflight = $request->getMethod() === 'OPTIONS' && $requestedMethod !== false;
 600                         if ( $preflight ) {
 601                                 // This is a CORS preflight request
 602                                 if ( $requestedMethod !== 'POST' && $requestedMethod !== 'GET' ) {
 603                                         // If method is not a case-sensitive match, do not set any additional headers and terminate.
 604                                         return true;
 605                                 }
 606                                 // We allow the actual request to send the following headers
 607                                 $requestedHeaders = $request->getHeader( 'Access-Control-Request-Headers' );
 608                                 if ( $requestedHeaders !== false ) {
 609                                         if ( !self::matchRequestedHeaders( $requestedHeaders ) ) {
 610                                                 return true;
 611                                         }
 612                                         $response->header( 'Access-Control-Allow-Headers: ' . $requestedHeaders );
 613                                 }
 614
 615                                 // We only allow the actual request to be GET or POST
 616                                 $response->header( 'Access-Control-Allow-Methods: POST, GET' );
 617                         }
 618
 619                         $response->header( "Access-Control-Allow-Origin: $originHeader" );
 620                         $response->header( 'Access-Control-Allow-Credentials: true' );
 621                         $response->header( "Timing-Allow-Origin: $originHeader" ); # http://www.w3.org/TR/resource-timing/#timing-allow-origin
 622
 623                         if ( !$preflight ) {
 624                                 $response->header( 'Access-Control-Expose-Headers: MediaWiki-API-Error, Retry-After, X-Database-Lag' );
 625                         }
 626                 }
 627
 628                 $this->getOutput()->addVaryHeader( 'Origin' );
 629                 return true;
 630         }
 631
 632         /**
 633          * Attempt to match an Origin header against a set of rules and a set of exceptions
 634          * @param string $value Origin header
 635          * @param array $rules Set of wildcard rules
 636          * @param array $exceptions Set of wildcard rules
 637          * @return bool True if $value matches a rule in $rules and doesn't match
 638          *    any rules in $exceptions, false otherwise
 639          */
 640         protected static function matchOrigin( $value, $rules, $exceptions ) {
 641                 foreach ( $rules as $rule ) {
 642                         if ( preg_match( self::wildcardToRegex( $rule ), $value ) ) {
 643                                 // Rule matches, check exceptions
 644                                 foreach ( $exceptions as $exc ) {
 645                                         if ( preg_match( self::wildcardToRegex( $exc ), $value ) ) {
 646                                                 return false;
 647                                         }
 648                                 }
 649
 650                                 return true;
 651                         }
 652                 }
 653
 654                 return false;
 655         }
 656
 657         /**
 658          * Attempt to validate the value of Access-Control-Request-Headers against a list
 659          * of headers that we allow the follow up request to send.
 660          *
 661          * @param string $requestedHeaders Comma seperated list of HTTP headers
 662          * @return bool True if all requested headers are in the list of allowed headers
 663          */
 664         protected static function matchRequestedHeaders( $requestedHeaders ) {
 665                 if ( trim( $requestedHeaders ) === '' ) {
 666                         return true;
 667                 }
 668                 $requestedHeaders = explode( ',', $requestedHeaders );
 669                 $allowedAuthorHeaders = array_flip( array(
 670                         /* simple headers (see spec) */
 671                         'accept',
 672                         'accept-language',
 673                         'content-language',
 674                         'content-type',
 675                         /* non-authorable headers in XHR, which are however requested by some UAs */
 676                         'accept-encoding',
 677                         'dnt',
 678                         'origin',
 679                         /* MediaWiki whitelist */
 680                         'api-user-agent',
 681                 ) );
 682                 foreach ( $requestedHeaders as $rHeader ) {
 683                         $rHeader = strtolower( trim( $rHeader ) );
 684                         if ( !isset( $allowedAuthorHeaders[$rHeader] ) ) {
 685                                 wfDebugLog( 'api', 'CORS preflight failed on requested header: ' . $rHeader );
 686                                 return false;
 687                         }
 688                 }
 689                 return true;
 690         }
 691
 692         /**
 693          * Helper function to convert wildcard string into a regex
 694          * '*' => '.*?'
 695          * '?' => '.'
 696          *
 697          * @param string $wildcard String with wildcards
 698          * @return string Regular expression
 699          */
 700         protected static function wildcardToRegex( $wildcard ) {
 701                 $wildcard = preg_quote( $wildcard, '/' );
 702                 $wildcard = str_replace(
 703                         array( '\*', '\?' ),
 704                         array( '.*?', '.' ),
 705                         $wildcard
 706                 );
 707
 708                 return "/^https?:\/\/$wildcard$/";
 709         }
 710
 711         /**
 712          * Send caching headers
 713          * @param boolean $isError Whether an error response is being output
 714          * @since 1.26 added $isError parameter
 715          */
 716         protected function sendCacheHeaders( $isError ) {
 717                 $response = $this->getRequest()->response();
 718                 $out = $this->getOutput();
 719
 720                 $config = $this->getConfig();
 721
 722                 if ( $config->get( 'VaryOnXFP' ) ) {
 723                         $out->addVaryHeader( 'X-Forwarded-Proto' );
 724                 }
 725
 726                 if ( !$isError && $this->mModule &&
 727                         ( $this->getRequest()->getMethod() === 'GET' || $this->getRequest()->getMethod() === 'HEAD' )
 728                 ) {
 729                         $etag = $this->mModule->getConditionalRequestData( 'etag' );
 730                         if ( $etag !== null ) {
 731                                 $response->header( "ETag: $etag" );
 732                         }
 733                         $lastMod = $this->mModule->getConditionalRequestData( 'last-modified' );
 734                         if ( $lastMod !== null ) {
 735                                 $response->header( 'Last-Modified: ' . wfTimestamp( TS_RFC2822, $lastMod ) );
 736                         }
 737                 }
 738
 739                 // The logic should be:
 740                 // $this->mCacheControl['max-age'] is set?
 741                 //    Use it, the module knows better than our guess.
 742                 // !$this->mModule || $this->mModule->isWriteMode(), and mCacheMode is private?
 743                 //    Use 0 because we can guess caching is probably the wrong thing to do.
 744                 // Use $this->getParameter( 'maxage' ), which already defaults to 0.
 745                 $maxage = 0;
 746                 if ( isset( $this->mCacheControl['max-age'] ) ) {
 747                         $maxage = $this->mCacheControl['max-age'];
 748                 } elseif ( ( $this->mModule && !$this->mModule->isWriteMode() ) ||
 749                         $this->mCacheMode !== 'private'
 750                 ) {
 751                         $maxage = $this->getParameter( 'maxage' );
 752                 }
 753                 $privateCache = 'private, must-revalidate, max-age=' . $maxage;
 754
 755                 if ( $this->mCacheMode == 'private' ) {
 756                         $response->header( "Cache-Control: $privateCache" );
 757                         return;
 758                 }
 759
 760                 $useXVO = $config->get( 'UseXVO' );
 761                 if ( $this->mCacheMode == 'anon-public-user-private' ) {
 762                         $out->addVaryHeader( 'Cookie' );
 763                         $response->header( $out->getVaryHeader() );
 764                         if ( $useXVO ) {
 765                                 $response->header( $out->getXVO() );
 766                                 if ( $out->haveCacheVaryCookies() ) {
 767                                         // Logged in, mark this request private
 768                                         $response->header( "Cache-Control: $privateCache" );
 769                                         return;
 770                                 }
 771                                 // Logged out, send normal public headers below
 772                         } elseif ( session_id() != '' ) {
 773                                 // Logged in or otherwise has session (e.g. anonymous users who have edited)
 774                                 // Mark request private
 775                                 $response->header( "Cache-Control: $privateCache" );
 776
 777                                 return;
 778                         } // else no XVO and anonymous, send public headers below
 779                 }
 780
 781                 // Send public headers
 782                 $response->header( $out->getVaryHeader() );
 783                 if ( $useXVO ) {
 784                         $response->header( $out->getXVO() );
 785                 }
 786
 787                 // If nobody called setCacheMaxAge(), use the (s)maxage parameters
 788                 if ( !isset( $this->mCacheControl['s-maxage'] ) ) {
 789                         $this->mCacheControl['s-maxage'] = $this->getParameter( 'smaxage' );
 790                 }
 791                 if ( !isset( $this->mCacheControl['max-age'] ) ) {
 792                         $this->mCacheControl['max-age'] = $this->getParameter( 'maxage' );
 793                 }
 794
 795                 if ( !$this->mCacheControl['s-maxage'] && !$this->mCacheControl['max-age'] ) {
 796                         // Public cache not requested
 797                         // Sending a Vary header in this case is harmless, and protects us
 798                         // against conditional calls of setCacheMaxAge().
 799                         $response->header( "Cache-Control: $privateCache" );
 800
 801                         return;
 802                 }
 803
 804                 $this->mCacheControl['public'] = true;
 805
 806                 // Send an Expires header
 807                 $maxAge = min( $this->mCacheControl['s-maxage'], $this->mCacheControl['max-age'] );
 808                 $expiryUnixTime = ( $maxAge == 0 ? 1 : time() + $maxAge );
 809                 $response->header( 'Expires: ' . wfTimestamp( TS_RFC2822, $expiryUnixTime ) );
 810
 811                 // Construct the Cache-Control header
 812                 $ccHeader = '';
 813                 $separator = '';
 814                 foreach ( $this->mCacheControl as $name => $value ) {
 815                         if ( is_bool( $value ) ) {
 816                                 if ( $value ) {
 817                                         $ccHeader .= $separator . $name;
 818                                         $separator = ', ';
 819                                 }
 820                         } else {
 821                                 $ccHeader .= $separator . "$name=$value";
 822                                 $separator = ', ';
 823                         }
 824                 }
 825
 826                 $response->header( "Cache-Control: $ccHeader" );
 827         }
 828
 829         /**
 830          * Create the printer for error output
 831          */
 832         private function createErrorPrinter() {
 833                 if ( !isset( $this->mPrinter ) ) {
 834                         $value = $this->getRequest()->getVal( 'format', self::API_DEFAULT_FORMAT );
 835                         if ( !$this->mModuleMgr->isDefined( $value, 'format' ) ) {
 836                                 $value = self::API_DEFAULT_FORMAT;
 837                         }
 838                         $this->mPrinter = $this->createPrinterByName( $value );
 839                 }
 840
 841                 // Printer may not be able to handle errors. This is particularly
 842                 // likely if the module returns something for getCustomPrinter().
 843                 if ( !$this->mPrinter->canPrintErrors() ) {
 844                         $this->mPrinter = $this->createPrinterByName( self::API_DEFAULT_FORMAT );
 845                 }
 846         }
 847
 848         /**
 849          * Replace the result data with the information about an exception.
 850          * Returns the error code
 851          * @param Exception $e
 852          * @return string
 853          */
 854         protected function substituteResultWithError( $e ) {
 855                 $result = $this->getResult();
 856                 $config = $this->getConfig();
 857
 858                 if ( $e instanceof UsageException ) {
 859                         // User entered incorrect parameters - generate error response
 860                         $errMessage = $e->getMessageArray();
 861                         $link = wfExpandUrl( wfScript( 'api' ) );
 862                         ApiResult::setContentValue( $errMessage, 'docref', "See $link for API usage" );
 863                 } else {
 864                         // Something is seriously wrong
 865                         if ( ( $e instanceof DBQueryError ) && !$config->get( 'ShowSQLErrors' ) ) {
 866                                 $info = 'Database query error';
 867                         } else {
 868                                 $info = "Exception Caught: {$e->getMessage()}";
 869                         }
 870
 871                         $errMessage = array(
 872                                 'code' => 'internal_api_error_' . get_class( $e ),
 873                                 'info' => '[' . MWExceptionHandler::getLogId( $e ) . '] ' . $info,
 874                         );
 875                         if ( $config->get( 'ShowExceptionDetails' ) ) {
 876                                 ApiResult::setContentValue(
 877                                         $errMessage,
 878                                         'trace',
 879                                         MWExceptionHandler::getRedactedTraceAsString( $e )
 880                                 );
 881                         }
 882                 }
 883
 884                 // Remember all the warnings to re-add them later
 885                 $warnings = $result->getResultData( array( 'warnings' ) );
 886
 887                 $result->reset();
 888                 // Re-add the id
 889                 $requestid = $this->getParameter( 'requestid' );
 890                 if ( !is_null( $requestid ) ) {
 891                         $result->addValue( null, 'requestid', $requestid, ApiResult::NO_SIZE_CHECK );
 892                 }
 893                 if ( $config->get( 'ShowHostnames' ) ) {
 894                         // servedby is especially useful when debugging errors
 895                         $result->addValue( null, 'servedby', wfHostName(), ApiResult::NO_SIZE_CHECK );
 896                 }
 897                 if ( $warnings !== null ) {
 898                         $result->addValue( null, 'warnings', $warnings, ApiResult::NO_SIZE_CHECK );
 899                 }
 900
 901                 $result->addValue( null, 'error', $errMessage, ApiResult::NO_SIZE_CHECK );
 902
 903                 return $errMessage['code'];
 904         }
 905
 906         /**
 907          * Set up for the execution.
 908          * @return array
 909          */
 910         protected function setupExecuteAction() {
 911                 // First add the id to the top element
 912                 $result = $this->getResult();
 913                 $requestid = $this->getParameter( 'requestid' );
 914                 if ( !is_null( $requestid ) ) {
 915                         $result->addValue( null, 'requestid', $requestid );
 916                 }
 917
 918                 if ( $this->getConfig()->get( 'ShowHostnames' ) ) {
 919                         $servedby = $this->getParameter( 'servedby' );
 920                         if ( $servedby ) {
 921                                 $result->addValue( null, 'servedby', wfHostName() );
 922                         }
 923                 }
 924
 925                 if ( $this->getParameter( 'curtimestamp' ) ) {
 926                         $result->addValue( null, 'curtimestamp', wfTimestamp( TS_ISO_8601, time() ),
 927                                 ApiResult::NO_SIZE_CHECK );
 928                 }
 929
 930                 $params = $this->extractRequestParams();
 931
 932                 $this->mAction = $params['action'];
 933
 934                 if ( !is_string( $this->mAction ) ) {
 935                         $this->dieUsage( 'The API requires a valid action parameter', 'unknown_action' );
 936                 }
 937
 938                 return $params;
 939         }
 940
 941         /**
 942          * Set up the module for response
 943          * @return ApiBase The module that will handle this action
 944          * @throws MWException
 945          * @throws UsageException
 946          */
 947         protected function setupModule() {
 948                 // Instantiate the module requested by the user
 949                 $module = $this->mModuleMgr->getModule( $this->mAction, 'action' );
 950                 if ( $module === null ) {
 951                         $this->dieUsage( 'The API requires a valid action parameter', 'unknown_action' );
 952                 }
 953                 $moduleParams = $module->extractRequestParams();
 954
 955                 // Check token, if necessary
 956                 if ( $module->needsToken() === true ) {
 957                         throw new MWException(
 958                                 "Module '{$module->getModuleName()}' must be updated for the new token handling. " .
 959                                 "See documentation for ApiBase::needsToken for details."
 960                         );
 961                 }
 962                 if ( $module->needsToken() ) {
 963                         if ( !$module->mustBePosted() ) {
 964                                 throw new MWException(
 965                                         "Module '{$module->getModuleName()}' must require POST to use tokens."
 966                                 );
 967                         }
 968
 969                         if ( !isset( $moduleParams['token'] ) ) {
 970                                 $this->dieUsageMsg( array( 'missingparam', 'token' ) );
 971                         }
 972
 973                         if ( !$this->getConfig()->get( 'DebugAPI' ) &&
 974                                 array_key_exists(
 975                                         $module->encodeParamName( 'token' ),
 976                                         $this->getRequest()->getQueryValues()
 977                                 )
 978                         ) {
 979                                 $this->dieUsage(
 980                                         "The '{$module->encodeParamName( 'token' )}' parameter was found in the query string, but must be in the POST body",
 981                                         'mustposttoken'
 982                                 );
 983                         }
 984
 985                         if ( !$module->validateToken( $moduleParams['token'], $moduleParams ) ) {
 986                                 $this->dieUsageMsg( 'sessionfailure' );
 987                         }
 988                 }
 989
 990                 return $module;
 991         }
 992
 993         /**
 994          * Check the max lag if necessary
 995          * @param ApiBase $module Api module being used
 996          * @param array $params Array an array containing the request parameters.
 997          * @return bool True on success, false should exit immediately
 998          */
 999         protected function checkMaxLag( $module, $params ) {
1000                 if ( $module->shouldCheckMaxlag() && isset( $params['maxlag'] ) ) {
1001                         // Check for maxlag
1002                         $maxLag = $params['maxlag'];
1003                         list( $host, $lag ) = wfGetLB()->getMaxLag();
1004                         if ( $lag > $maxLag ) {
1005                                 $response = $this->getRequest()->response();
1006
1007                                 $response->header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
1008                                 $response->header( 'X-Database-Lag: ' . intval( $lag ) );
1009
1010                                 if ( $this->getConfig()->get( 'ShowHostnames' ) ) {
1011                                         $this->dieUsage( "Waiting for $host: $lag seconds lagged", 'maxlag' );
1012                                 }
1013
1014                                 $this->dieUsage( "Waiting for a database server: $lag seconds lagged", 'maxlag' );
1015                         }
1016                 }
1017
1018                 return true;
1019         }
1020
1021         /**
1022          * Check selected RFC 7232 precondition headers
1023          *
1024          * RFC 7232 envisions a particular model where you send your request to "a
1025          * resource", and for write requests that you can read "the resource" by
1026          * changing the method to GET. When the API receives a GET request, it
1027          * works out even though "the resource" from RFC 7232's perspective might
1028          * be many resources from MediaWiki's perspective. But it totally fails for
1029          * a POST, since what HTTP sees as "the resource" is probably just
1030          * "/api.php" with all the interesting bits in the body.
1031          *
1032          * Therefore, we only support RFC 7232 precondition headers for GET (and
1033          * HEAD). That means we don't need to bother with If-Match and
1034          * If-Unmodified-Since since they only apply to modification requests.
1035          *
1036          * And since we don't support Range, If-Range is ignored too.
1037          *
1038          * @since 1.26
1039          * @param ApiBase $module Api module being used
1040          * @return bool True on success, false should exit immediately
1041          */
1042         protected function checkConditionalRequestHeaders( $module ) {
1043                 if ( $this->mInternalMode ) {
1044                         // No headers to check in internal mode
1045                         return true;
1046                 }
1047
1048                 if ( $this->getRequest()->getMethod() !== 'GET' && $this->getRequest()->getMethod() !== 'HEAD' ) {
1049                         // Don't check POSTs
1050                         return true;
1051                 }
1052
1053                 $return304 = false;
1054
1055                 $ifNoneMatch = array_diff(
1056                         $this->getRequest()->getHeader( 'If-None-Match', WebRequest::GETHEADER_LIST ) ?: array(),
1057                         array( '' )
1058                 );
1059                 if ( $ifNoneMatch ) {
1060                         if ( $ifNoneMatch === array( '*' ) ) {
1061                                 // API responses always "exist"
1062                                 $etag = '*';
1063                         } else {
1064                                 $etag = $module->getConditionalRequestData( 'etag' );
1065                         }
1066                 }
1067                 if ( $ifNoneMatch && $etag !== null ) {
1068                         $test = substr( $etag, 0, 2 ) === 'W/' ? substr( $etag, 2 ) : $etag;
1069                         $match = array_map( function ( $s ) {
1070                                 return substr( $s, 0, 2 ) === 'W/' ? substr( $s, 2 ) : $s;
1071                         }, $ifNoneMatch );
1072                         $return304 = in_array( $test, $match, true );
1073                 } else {
1074                         $value = trim( $this->getRequest()->getHeader( 'If-Modified-Since' ) );
1075
1076                         // Some old browsers sends sizes after the date, like this:
1077                         //  Wed, 20 Aug 2003 06:51:19 GMT; length=5202
1078                         // Ignore that.
1079                         $i = strpos( $value, ';' );
1080                         if ( $i !== false ) {
1081                                 $value = trim( substr( $value, 0, $i ) );
1082                         }
1083
1084                         if ( $value !== '' ) {
1085                                 try {
1086                                         $ts = new MWTimestamp( $value );
1087                                         if (
1088                                                 // RFC 7231 IMF-fixdate
1089                                                 $ts->getTimestamp( TS_RFC2822 ) === $value ||
1090                                                 // RFC 850
1091                                                 $ts->format( 'l, d-M-y H:i:s' ) . ' GMT' === $value ||
1092                                                 // asctime (with and without space-padded day)
1093                                                 $ts->format( 'D M j H:i:s Y' ) === $value ||
1094                                                 $ts->format( 'D M  j H:i:s Y' ) === $value
1095                                         ) {
1096                                                 $lastMod = $module->getConditionalRequestData( 'last-modified' );
1097                                                 if ( $lastMod !== null ) {
1098                                                         // Mix in some MediaWiki modification times
1099                                                         $modifiedTimes = array(
1100                                                                 'page' => $lastMod,
1101                                                                 'user' => $this->getUser()->getTouched(),
1102                                                                 'epoch' => $this->getConfig()->get( 'CacheEpoch' ),
1103                                                         );
1104                                                         if ( $this->getConfig()->get( 'UseSquid' ) ) {
1105                                                                 // T46570: the core page itself may not change, but resources might
1106                                                                 $modifiedTimes['sepoch'] = wfTimestamp(
1107                                                                         TS_MW, time() - $this->getConfig()->get( 'SquidMaxage' )
1108                                                                 );
1109                                                         }
1110                                                         Hooks::run( 'OutputPageCheckLastModified', array( &$modifiedTimes ) );
1111                                                         $lastMod = max( $modifiedTimes );
1112                                                         $return304 = wfTimestamp( TS_MW, $lastMod ) <= $ts->getTimestamp( TS_MW );
1113                                                 }
1114                                         }
1115                                 } catch ( TimestampException $e ) {
1116                                         // Invalid timestamp, ignore it
1117                                 }
1118                         }
1119                 }
1120
1121                 if ( $return304 ) {
1122                         $this->getRequest()->response()->statusHeader( 304 );
1123
1124                         // Avoid outputting the compressed representation of a zero-length body
1125                         MediaWiki\suppressWarnings();
1126                         ini_set( 'zlib.output_compression', 0 );
1127                         MediaWiki\restoreWarnings();
1128                         wfClearOutputBuffers();
1129
1130                         return false;
1131                 }
1132
1133                 return true;
1134         }
1135
1136         /**
1137          * Check for sufficient permissions to execute
1138          * @param ApiBase $module An Api module
1139          */
1140         protected function checkExecutePermissions( $module ) {
1141                 $user = $this->getUser();
1142                 if ( $module->isReadMode() && !User::isEveryoneAllowed( 'read' ) &&
1143                         !$user->isAllowed( 'read' )
1144                 ) {
1145                         $this->dieUsageMsg( 'readrequired' );
1146                 }
1147                 if ( $module->isWriteMode() ) {
1148                         if ( !$this->mEnableWrite ) {
1149                                 $this->dieUsageMsg( 'writedisabled' );
1150                         }
1151                         if ( !$user->isAllowed( 'writeapi' ) ) {
1152                                 $this->dieUsageMsg( 'writerequired' );
1153                         }
1154                         if ( wfReadOnly() ) {
1155                                 $this->dieReadOnly();
1156                         }
1157                 }
1158
1159                 // Allow extensions to stop execution for arbitrary reasons.
1160                 $message = false;
1161                 if ( !Hooks::run( 'ApiCheckCanExecute', array( $module, $user, &$message ) ) ) {
1162                         $this->dieUsageMsg( $message );
1163                 }
1164         }
1165
1166         /**
1167          * Check asserts of the user's rights
1168          * @param array $params
1169          */
1170         protected function checkAsserts( $params ) {
1171                 if ( isset( $params['assert'] ) ) {
1172                         $user = $this->getUser();
1173                         switch ( $params['assert'] ) {
1174                                 case 'user':
1175                                         if ( $user->isAnon() ) {
1176                                                 $this->dieUsage( 'Assertion that the user is logged in failed', 'assertuserfailed' );
1177                                         }
1178                                         break;
1179                                 case 'bot':
1180                                         if ( !$user->isAllowed( 'bot' ) ) {
1181                                                 $this->dieUsage( 'Assertion that the user has the bot right failed', 'assertbotfailed' );
1182                                         }
1183                                         break;
1184                         }
1185                 }
1186         }
1187
1188         /**
1189          * Check POST for external response and setup result printer
1190          * @param ApiBase $module An Api module
1191          * @param array $params An array with the request parameters
1192          */
1193         protected function setupExternalResponse( $module, $params ) {
1194                 if ( !$this->getRequest()->wasPosted() && $module->mustBePosted() ) {
1195                         // Module requires POST. GET request might still be allowed
1196                         // if $wgDebugApi is true, otherwise fail.
1197                         $this->dieUsageMsgOrDebug( array( 'mustbeposted', $this->mAction ) );
1198                 }
1199
1200                 // See if custom printer is used
1201                 $this->mPrinter = $module->getCustomPrinter();
1202                 if ( is_null( $this->mPrinter ) ) {
1203                         // Create an appropriate printer
1204                         $this->mPrinter = $this->createPrinterByName( $params['format'] );
1205                 }
1206         }
1207
1208         /**
1209          * Execute the actual module, without any error handling
1210          */
1211         protected function executeAction() {
1212                 $params = $this->setupExecuteAction();
1213                 $module = $this->setupModule();
1214                 $this->mModule = $module;
1215
1216                 $this->checkExecutePermissions( $module );
1217
1218                 if ( !$this->checkMaxLag( $module, $params ) ) {
1219                         return;
1220                 }
1221
1222                 if ( !$this->checkConditionalRequestHeaders( $module ) ) {
1223                         return;
1224                 }
1225
1226                 if ( !$this->mInternalMode ) {
1227                         $this->setupExternalResponse( $module, $params );
1228                 }
1229
1230                 $this->checkAsserts( $params );
1231
1232                 // Execute
1233                 $module->execute();
1234                 Hooks::run( 'APIAfterExecute', array( &$module ) );
1235
1236                 $this->reportUnusedParams();
1237
1238                 if ( !$this->mInternalMode ) {
1239                         //append Debug information
1240                         MWDebug::appendDebugInfoToApiResult( $this->getContext(), $this->getResult() );
1241
1242                         // Print result data
1243                         $this->printResult( false );
1244                 }
1245         }
1246
1247         /**
1248          * Log the preceding request
1249          * @param int $time Time in seconds
1250          */
1251         protected function logRequest( $time ) {
1252                 $request = $this->getRequest();
1253                 $milliseconds = $time === null ? '?' : round( $time * 1000 );
1254                 $s = 'API' .
1255                         ' ' . $request->getMethod() .
1256                         ' ' . wfUrlencode( str_replace( ' ', '_', $this->getUser()->getName() ) ) .
1257                         ' ' . $request->getIP() .
1258                         ' T=' . $milliseconds . 'ms';
1259                 foreach ( $this->getParamsUsed() as $name ) {
1260                         $value = $request->getVal( $name );
1261                         if ( $value === null ) {
1262                                 continue;
1263                         }
1264                         $s .= ' ' . $name . '=';
1265                         if ( strlen( $value ) > 256 ) {
1266                                 $encValue = $this->encodeRequestLogValue( substr( $value, 0, 256 ) );
1267                                 $s .= $encValue . '[...]';
1268                         } else {
1269                                 $s .= $this->encodeRequestLogValue( $value );
1270                         }
1271                 }
1272                 $s .= "\n";
1273                 wfDebugLog( 'api', $s, 'private' );
1274         }
1275
1276         /**
1277          * Encode a value in a format suitable for a space-separated log line.
1278          * @param string $s
1279          * @return string
1280          */
1281         protected function encodeRequestLogValue( $s ) {
1282                 static $table;
1283                 if ( !$table ) {
1284                         $chars = ';@$!*(),/:';
1285                         $numChars = strlen( $chars );
1286                         for ( $i = 0; $i < $numChars; $i++ ) {
1287                                 $table[rawurlencode( $chars[$i] )] = $chars[$i];
1288                         }
1289                 }
1290
1291                 return strtr( rawurlencode( $s ), $table );
1292         }
1293
1294         /**
1295          * Get the request parameters used in the course of the preceding execute() request
1296          * @return array
1297          */
1298         protected function getParamsUsed() {
1299                 return array_keys( $this->mParamsUsed );
1300         }
1301
1302         /**
1303          * Get a request value, and register the fact that it was used, for logging.
1304          * @param string $name
1305          * @param mixed $default
1306          * @return mixed
1307          */
1308         public function getVal( $name, $default = null ) {
1309                 $this->mParamsUsed[$name] = true;
1310
1311                 $ret = $this->getRequest()->getVal( $name );
1312                 if ( $ret === null ) {
1313                         if ( $this->getRequest()->getArray( $name ) !== null ) {
1314                                 // See bug 10262 for why we don't just join( '|', ... ) the
1315                                 // array.
1316                                 $this->setWarning(
1317                                         "Parameter '$name' uses unsupported PHP array syntax"
1318                                 );
1319                         }
1320                         $ret = $default;
1321                 }
1322                 return $ret;
1323         }
1324
1325         /**
1326          * Get a boolean request value, and register the fact that the parameter
1327          * was used, for logging.
1328          * @param string $name
1329          * @return bool
1330          */
1331         public function getCheck( $name ) {
1332                 return $this->getVal( $name, null ) !== null;
1333         }
1334
1335         /**
1336          * Get a request upload, and register the fact that it was used, for logging.
1337          *
1338          * @since 1.21
1339          * @param string $name Parameter name
1340          * @return WebRequestUpload
1341          */
1342         public function getUpload( $name ) {
1343                 $this->mParamsUsed[$name] = true;
1344
1345                 return $this->getRequest()->getUpload( $name );
1346         }
1347
1348         /**
1349          * Report unused parameters, so the client gets a hint in case it gave us parameters we don't know,
1350          * for example in case of spelling mistakes or a missing 'g' prefix for generators.
1351          */
1352         protected function reportUnusedParams() {
1353                 $paramsUsed = $this->getParamsUsed();
1354                 $allParams = $this->getRequest()->getValueNames();
1355
1356                 if ( !$this->mInternalMode ) {
1357                         // Printer has not yet executed; don't warn that its parameters are unused
1358                         $printerParams = array_map(
1359                                 array( $this->mPrinter, 'encodeParamName' ),
1360                                 array_keys( $this->mPrinter->getFinalParams() ?: array() )
1361                         );
1362                         $unusedParams = array_diff( $allParams, $paramsUsed, $printerParams );
1363                 } else {
1364                         $unusedParams = array_diff( $allParams, $paramsUsed );
1365                 }
1366
1367                 if ( count( $unusedParams ) ) {
1368                         $s = count( $unusedParams ) > 1 ? 's' : '';
1369                         $this->setWarning( "Unrecognized parameter$s: '" . implode( $unusedParams, "', '" ) . "'" );
1370                 }
1371         }
1372
1373         /**
1374          * Print results using the current printer
1375          *
1376          * @param bool $isError
1377          */
1378         protected function printResult( $isError ) {
1379                 if ( $this->getConfig()->get( 'DebugAPI' ) !== false ) {
1380                         $this->setWarning( 'SECURITY WARNING: $wgDebugAPI is enabled' );
1381                 }
1382
1383                 $printer = $this->mPrinter;
1384                 $printer->initPrinter( false );
1385                 $printer->execute();
1386                 $printer->closePrinter();
1387         }
1388
1389         /**
1390          * @return bool
1391          */
1392         public function isReadMode() {
1393                 return false;
1394         }
1395
1396         /**
1397          * See ApiBase for description.
1398          *
1399          * @return array
1400          */
1401         public function getAllowedParams() {
1402                 return array(
1403                         'action' => array(
1404                                 ApiBase::PARAM_DFLT => 'help',
1405                                 ApiBase::PARAM_TYPE => 'submodule',
1406                         ),
1407                         'format' => array(
1408                                 ApiBase::PARAM_DFLT => ApiMain::API_DEFAULT_FORMAT,
1409                                 ApiBase::PARAM_TYPE => 'submodule',
1410                         ),
1411                         'maxlag' => array(
1412                                 ApiBase::PARAM_TYPE => 'integer'
1413                         ),
1414                         'smaxage' => array(
1415                                 ApiBase::PARAM_TYPE => 'integer',
1416                                 ApiBase::PARAM_DFLT => 0
1417                         ),
1418                         'maxage' => array(
1419                                 ApiBase::PARAM_TYPE => 'integer',
1420                                 ApiBase::PARAM_DFLT => 0
1421                         ),
1422                         'assert' => array(
1423                                 ApiBase::PARAM_TYPE => array( 'user', 'bot' )
1424                         ),
1425                         'requestid' => null,
1426                         'servedby' => false,
1427                         'curtimestamp' => false,
1428                         'origin' => null,
1429                         'uselang' => array(
1430                                 ApiBase::PARAM_DFLT => 'user',
1431                         ),
1432                 );
1433         }
1434
1435         /** @see ApiBase::getExamplesMessages() */
1436         protected function getExamplesMessages() {
1437                 return array(
1438                         'action=help'
1439                                 => 'apihelp-help-example-main',
1440                         'action=help&recursivesubmodules=1'
1441                                 => 'apihelp-help-example-recursive',
1442                 );
1443         }
1444
1445         public function modifyHelp( array &$help, array $options, array &$tocData ) {
1446                 // Wish PHP had an "array_insert_before". Instead, we have to manually
1447                 // reindex the array to get 'permissions' in the right place.
1448                 $oldHelp = $help;
1449                 $help = array();
1450                 foreach ( $oldHelp as $k => $v ) {
1451                         if ( $k === 'submodules' ) {
1452                                 $help['permissions'] = '';
1453                         }
1454                         $help[$k] = $v;
1455                 }
1456                 $help['datatypes'] = '';
1457                 $help['credits'] = '';
1458
1459                 // Fill 'permissions'
1460                 $help['permissions'] .= Html::openElement( 'div',
1461                         array( 'class' => 'apihelp-block apihelp-permissions' ) );
1462                 $m = $this->msg( 'api-help-permissions' );
1463                 if ( !$m->isDisabled() ) {
1464                         $help['permissions'] .= Html::rawElement( 'div', array( 'class' => 'apihelp-block-head' ),
1465                                 $m->numParams( count( self::$mRights ) )->parse()
1466                         );
1467                 }
1468                 $help['permissions'] .= Html::openElement( 'dl' );
1469                 foreach ( self::$mRights as $right => $rightMsg ) {
1470                         $help['permissions'] .= Html::element( 'dt', null, $right );
1471
1472                         $rightMsg = $this->msg( $rightMsg['msg'], $rightMsg['params'] )->parse();
1473                         $help['permissions'] .= Html::rawElement( 'dd', null, $rightMsg );
1474
1475                         $groups = array_map( function ( $group ) {
1476                                 return $group == '*' ? 'all' : $group;
1477                         }, User::getGroupsWithPermission( $right ) );
1478
1479                         $help['permissions'] .= Html::rawElement( 'dd', null,
1480                                 $this->msg( 'api-help-permissions-granted-to' )
1481                                         ->numParams( count( $groups ) )
1482                                         ->params( $this->getLanguage()->commaList( $groups ) )
1483                                         ->parse()
1484                         );
1485                 }
1486                 $help['permissions'] .= Html::closeElement( 'dl' );
1487                 $help['permissions'] .= Html::closeElement( 'div' );
1488
1489                 // Fill 'datatypes' and 'credits', if applicable
1490                 if ( empty( $options['nolead'] ) ) {
1491                         $level = $options['headerlevel'];
1492                         $tocnumber = &$options['tocnumber'];
1493
1494                         $header = $this->msg( 'api-help-datatypes-header' )->parse();
1495                         $help['datatypes'] .= Html::rawelement( 'h' . min( 6, $level ),
1496                                 array( 'id' => 'main/datatypes', 'class' => 'apihelp-header' ),
1497                                 Html::element( 'span', array( 'id' => Sanitizer::escapeId( 'main/datatypes' ) ) ) .
1498                                 $header
1499                         );
1500                         $help['datatypes'] .= $this->msg( 'api-help-datatypes' )->parseAsBlock();
1501                         if ( !isset( $tocData['main/datatypes'] ) ) {
1502                                 $tocnumber[$level]++;
1503                                 $tocData['main/datatypes'] = array(
1504                                         'toclevel' => count( $tocnumber ),
1505                                         'level' => $level,
1506                                         'anchor' => 'main/datatypes',
1507                                         'line' => $header,
1508                                         'number' => join( '.', $tocnumber ),
1509                                         'index' => false,
1510                                 );
1511                         }
1512
1513                         $header = $this->msg( 'api-credits-header' )->parse();
1514                         $help['credits'] .= Html::rawelement( 'h' . min( 6, $level ),
1515                                 array( 'id' => 'main/credits', 'class' => 'apihelp-header' ),
1516                                 Html::element( 'span', array( 'id' => Sanitizer::escapeId( 'main/credits' ) ) ) .
1517                                 $header
1518                         );
1519                         $help['credits'] .= $this->msg( 'api-credits' )->useDatabase( false )->parseAsBlock();
1520                         if ( !isset( $tocData['main/credits'] ) ) {
1521                                 $tocnumber[$level]++;
1522                                 $tocData['main/credits'] = array(
1523                                         'toclevel' => count( $tocnumber ),
1524                                         'level' => $level,
1525                                         'anchor' => 'main/credits',
1526                                         'line' => $header,
1527                                         'number' => join( '.', $tocnumber ),
1528                                         'index' => false,
1529                                 );
1530                         }
1531                 }
1532         }
1533
1534         private $mCanApiHighLimits = null;
1535
1536         /**
1537          * Check whether the current user is allowed to use high limits
1538          * @return bool
1539          */
1540         public function canApiHighLimits() {
1541                 if ( !isset( $this->mCanApiHighLimits ) ) {
1542                         $this->mCanApiHighLimits = $this->getUser()->isAllowed( 'apihighlimits' );
1543                 }
1544
1545                 return $this->mCanApiHighLimits;
1546         }
1547
1548         /**
1549          * Overrides to return this instance's module manager.
1550          * @return ApiModuleManager
1551          */
1552         public function getModuleManager() {
1553                 return $this->mModuleMgr;
1554         }
1555
1556         /**
1557          * Fetches the user agent used for this request
1558          *
1559          * The value will be the combination of the 'Api-User-Agent' header (if
1560          * any) and the standard User-Agent header (if any).
1561          *
1562          * @return string
1563          */
1564         public function getUserAgent() {
1565                 return trim(
1566                         $this->getRequest()->getHeader( 'Api-user-agent' ) . ' ' .
1567                         $this->getRequest()->getHeader( 'User-agent' )
1568                 );
1569         }
1570
1571         /************************************************************************//**
1572          * @name   Deprecated
1573          * @{
1574          */
1575
1576         /**
1577          * Sets whether the pretty-printer should format *bold* and $italics$
1578          *
1579          * @deprecated since 1.25
1580          * @param bool $help
1581          */
1582         public function setHelp( $help = true ) {
1583                 wfDeprecated( __METHOD__, '1.25' );
1584                 $this->mPrinter->setHelp( $help );
1585         }
1586
1587         /**
1588          * Override the parent to generate help messages for all available modules.
1589          *
1590          * @deprecated since 1.25
1591          * @return string
1592          */
1593         public function makeHelpMsg() {
1594                 wfDeprecated( __METHOD__, '1.25' );
1595                 global $wgMemc;
1596                 $this->setHelp();
1597                 // Get help text from cache if present
1598                 $key = wfMemcKey( 'apihelp', $this->getModuleName(),
1599                         str_replace( ' ', '_', SpecialVersion::getVersion( 'nodb' ) ) );
1600
1601                 $cacheHelpTimeout = $this->getConfig()->get( 'APICacheHelpTimeout' );
1602                 if ( $cacheHelpTimeout > 0 ) {
1603                         $cached = $wgMemc->get( $key );
1604                         if ( $cached ) {
1605                                 return $cached;
1606                         }
1607                 }
1608                 $retval = $this->reallyMakeHelpMsg();
1609                 if ( $cacheHelpTimeout > 0 ) {
1610                         $wgMemc->set( $key, $retval, $cacheHelpTimeout );
1611                 }
1612
1613                 return $retval;
1614         }
1615
1616         /**
1617          * @deprecated since 1.25
1618          * @return mixed|string
1619          */
1620         public function reallyMakeHelpMsg() {
1621                 wfDeprecated( __METHOD__, '1.25' );
1622                 $this->setHelp();
1623
1624                 // Use parent to make default message for the main module
1625                 $msg = parent::makeHelpMsg();
1626
1627                 $astriks = str_repeat( '*** ', 14 );
1628                 $msg .= "\n\n$astriks Modules  $astriks\n\n";
1629
1630                 foreach ( $this->mModuleMgr->getNames( 'action' ) as $name ) {
1631                         $module = $this->mModuleMgr->getModule( $name );
1632                         $msg .= self::makeHelpMsgHeader( $module, 'action' );
1633
1634                         $msg2 = $module->makeHelpMsg();
1635                         if ( $msg2 !== false ) {
1636                                 $msg .= $msg2;
1637                         }
1638                         $msg .= "\n";
1639                 }
1640
1641                 $msg .= "\n$astriks Permissions $astriks\n\n";
1642                 foreach ( self::$mRights as $right => $rightMsg ) {
1643                         $rightsMsg = $this->msg( $rightMsg['msg'], $rightMsg['params'] )
1644                                 ->useDatabase( false )
1645                                 ->inLanguage( 'en' )
1646                                 ->text();
1647                         $groups = User::getGroupsWithPermission( $right );
1648                         $msg .= "* " . $right . " *\n  $rightsMsg" .
1649                                 "\nGranted to:\n  " . str_replace( '*', 'all', implode( ', ', $groups ) ) . "\n\n";
1650                 }
1651
1652                 $msg .= "\n$astriks Formats  $astriks\n\n";
1653                 foreach ( $this->mModuleMgr->getNames( 'format' ) as $name ) {
1654                         $module = $this->mModuleMgr->getModule( $name );
1655                         $msg .= self::makeHelpMsgHeader( $module, 'format' );
1656                         $msg2 = $module->makeHelpMsg();
1657                         if ( $msg2 !== false ) {
1658                                 $msg .= $msg2;
1659                         }
1660                         $msg .= "\n";
1661                 }
1662
1663                 $credits = $this->msg( 'api-credits' )->useDatabase( 'false' )->inLanguage( 'en' )->text();
1664                 $credits = str_replace( "\n", "\n   ", $credits );
1665                 $msg .= "\n*** Credits: ***\n   $credits\n";
1666
1667                 return $msg;
1668         }
1669
1670         /**
1671          * @deprecated since 1.25
1672          * @param ApiBase $module
1673          * @param string $paramName What type of request is this? e.g. action,
1674          *    query, list, prop, meta, format
1675          * @return string
1676          */
1677         public static function makeHelpMsgHeader( $module, $paramName ) {
1678                 wfDeprecated( __METHOD__, '1.25' );
1679                 $modulePrefix = $module->getModulePrefix();
1680                 if ( strval( $modulePrefix ) !== '' ) {
1681                         $modulePrefix = "($modulePrefix) ";
1682                 }
1683
1684                 return "* $paramName={$module->getModuleName()} $modulePrefix*";
1685         }
1686
1687         /**
1688          * Check whether the user wants us to show version information in the API help
1689          * @return bool
1690          * @deprecated since 1.21, always returns false
1691          */
1692         public function getShowVersions() {
1693                 wfDeprecated( __METHOD__, '1.21' );
1694
1695                 return false;
1696         }
1697
1698         /**
1699          * Add or overwrite a module in this ApiMain instance. Intended for use by extending
1700          * classes who wish to add their own modules to their lexicon or override the
1701          * behavior of inherent ones.
1702          *
1703          * @deprecated since 1.21, Use getModuleManager()->addModule() instead.
1704          * @param string $name The identifier for this module.
1705          * @param ApiBase $class The class where this module is implemented.
1706          */
1707         protected function addModule( $name, $class ) {
1708                 $this->getModuleManager()->addModule( $name, 'action', $class );
1709         }
1710
1711         /**
1712          * Add or overwrite an output format for this ApiMain. Intended for use by extending
1713          * classes who wish to add to or modify current formatters.
1714          *
1715          * @deprecated since 1.21, Use getModuleManager()->addModule() instead.
1716          * @param string $name The identifier for this format.
1717          * @param ApiFormatBase $class The class implementing this format.
1718          */
1719         protected function addFormat( $name, $class ) {
1720                 $this->getModuleManager()->addModule( $name, 'format', $class );
1721         }
1722
1723         /**
1724          * Get the array mapping module names to class names
1725          * @deprecated since 1.21, Use getModuleManager()'s methods instead.
1726          * @return array
1727          */
1728         function getModules() {
1729                 return $this->getModuleManager()->getNamesWithClasses( 'action' );
1730         }
1731
1732         /**
1733          * Returns the list of supported formats in form ( 'format' => 'ClassName' )
1734          *
1735          * @since 1.18
1736          * @deprecated since 1.21, Use getModuleManager()'s methods instead.
1737          * @return array
1738          */
1739         public function getFormats() {
1740                 return $this->getModuleManager()->getNamesWithClasses( 'format' );
1741         }
1742
1743         /**@}*/
1744
1745 }
1746
1747 /**
1748  * This exception will be thrown when dieUsage is called to stop module execution.
1749  *
1750  * @ingroup API
1751  */
1752 class UsageException extends MWException {
1753
1754         private $mCodestr;
1755
1756         /**
1757          * @var null|array
1758          */
1759         private $mExtraData;
1760
1761         /**
1762          * @param string $message
1763          * @param string $codestr
1764          * @param int $code
1765          * @param array|null $extradata
1766          */
1767         public function __construct( $message, $codestr, $code = 0, $extradata = null ) {
1768                 parent::__construct( $message, $code );
1769                 $this->mCodestr = $codestr;
1770                 $this->mExtraData = $extradata;
1771         }
1772
1773         /**
1774          * @return string
1775          */
1776         public function getCodeString() {
1777                 return $this->mCodestr;
1778         }
1779
1780         /**
1781          * @return array
1782          */
1783         public function getMessageArray() {
1784                 $result = array(
1785                         'code' => $this->mCodestr,
1786                         'info' => $this->getMessage()
1787                 );
1788                 if ( is_array( $this->mExtraData ) ) {
1789                         $result = array_merge( $result, $this->mExtraData );
1790                 }
1791
1792                 return $result;
1793         }
1794
1795         /**
1796          * @return string
1797          */
1798         public function __toString() {
1799                 return "{$this->getCodeString()}: {$this->getMessage()}";
1800         }
1801 }
1802
1803 /**
1804  * For really cool vim folding this needs to be at the end:
1805  * vim: foldmarker=@{,@} foldmethod=marker
1806  */