5 * Created on Sep 4, 2006
7 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
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.
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.
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
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.
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.
41 class ApiMain
extends ApiBase
{
44 * When no format parameter is given, this format will be used
46 const API_DEFAULT_FORMAT
= 'xmlfm';
49 * List of available modules: action name => module class
51 private static $Modules = array(
52 'login' => 'ApiLogin',
53 'logout' => 'ApiLogout',
54 'createaccount' => 'ApiCreateAccount',
55 'query' => 'ApiQuery',
56 'expandtemplates' => 'ApiExpandTemplates',
57 'parse' => 'ApiParse',
58 'opensearch' => 'ApiOpenSearch',
59 'feedcontributions' => 'ApiFeedContributions',
60 'feedwatchlist' => 'ApiFeedWatchlist',
62 'paraminfo' => 'ApiParamInfo',
64 'compare' => 'ApiComparePages',
65 'tokens' => 'ApiTokens',
68 'purge' => 'ApiPurge',
69 'setnotificationtimestamp' => 'ApiSetNotificationTimestamp',
70 'rollback' => 'ApiRollback',
71 'delete' => 'ApiDelete',
72 'undelete' => 'ApiUndelete',
73 'protect' => 'ApiProtect',
74 'block' => 'ApiBlock',
75 'unblock' => 'ApiUnblock',
77 'edit' => 'ApiEditPage',
78 'upload' => 'ApiUpload',
79 'filerevert' => 'ApiFileRevert',
80 'emailuser' => 'ApiEmailUser',
81 'watch' => 'ApiWatch',
82 'patrol' => 'ApiPatrol',
83 'import' => 'ApiImport',
84 'userrights' => 'ApiUserrights',
85 'options' => 'ApiOptions',
86 'imagerotate' => 'ApiImageRotate',
90 * List of available formats: format name => format class
92 private static $Formats = array(
93 'json' => 'ApiFormatJson',
94 'jsonfm' => 'ApiFormatJson',
95 'php' => 'ApiFormatPhp',
96 'phpfm' => 'ApiFormatPhp',
97 'wddx' => 'ApiFormatWddx',
98 'wddxfm' => 'ApiFormatWddx',
99 'xml' => 'ApiFormatXml',
100 'xmlfm' => 'ApiFormatXml',
101 'yaml' => 'ApiFormatYaml',
102 'yamlfm' => 'ApiFormatYaml',
103 'rawfm' => 'ApiFormatJson',
104 'txt' => 'ApiFormatTxt',
105 'txtfm' => 'ApiFormatTxt',
106 'dbg' => 'ApiFormatDbg',
107 'dbgfm' => 'ApiFormatDbg',
108 'dump' => 'ApiFormatDump',
109 'dumpfm' => 'ApiFormatDump',
110 'none' => 'ApiFormatNone',
113 // @codingStandardsIgnoreStart String contenation on "msg" not allowed to break long line
115 * List of user roles that are specifically relevant to the API.
116 * array( 'right' => array ( 'msg' => 'Some message with a $1',
117 * 'params' => array ( $someVarToSubst ) ),
120 private static $mRights = array(
122 'msg' => 'Use of the write API',
125 'apihighlimits' => array(
126 'msg' => 'Use higher limits in API queries (Slow queries: $1 results; Fast queries: $2 results). The limits for slow queries also apply to multivalue parameters.',
127 'params' => array( ApiBase
::LIMIT_SML2
, ApiBase
::LIMIT_BIG2
)
130 // @codingStandardsIgnoreEnd
137 private $mModuleMgr, $mResult;
139 private $mEnableWrite;
140 private $mInternalMode, $mSquidMaxage, $mModule;
142 private $mCacheMode = 'private';
143 private $mCacheControl = array();
144 private $mParamsUsed = array();
147 * Constructs an instance of ApiMain that utilizes the module and format specified by $request.
149 * @param $context IContextSource|WebRequest - if this is an instance of
150 * FauxRequest, errors are thrown and no printing occurs
151 * @param bool $enableWrite should be set to true if the api may modify data
153 public function __construct( $context = null, $enableWrite = false ) {
154 if ( $context === null ) {
155 $context = RequestContext
::getMain();
156 } elseif ( $context instanceof WebRequest
) {
159 $context = RequestContext
::getMain();
161 // We set a derivative context so we can change stuff later
162 $this->setContext( new DerivativeContext( $context ) );
164 if ( isset( $request ) ) {
165 $this->getContext()->setRequest( $request );
168 $this->mInternalMode
= ( $this->getRequest() instanceof FauxRequest
);
170 // Special handling for the main module: $parent === $this
171 parent
::__construct( $this, $this->mInternalMode ?
'main_int' : 'main' );
173 if ( !$this->mInternalMode
) {
174 // Impose module restrictions.
175 // If the current user cannot read,
176 // Remove all modules other than login
179 if ( $this->getVal( 'callback' ) !== null ) {
180 // JSON callback allows cross-site reads.
181 // For safety, strip user credentials.
182 wfDebug( "API: stripping user credentials for JSON callback\n" );
183 $wgUser = new User();
184 $this->getContext()->setUser( $wgUser );
188 global $wgAPIModules, $wgAPIFormatModules;
189 $this->mModuleMgr
= new ApiModuleManager( $this );
190 $this->mModuleMgr
->addModules( self
::$Modules, 'action' );
191 $this->mModuleMgr
->addModules( $wgAPIModules, 'action' );
192 $this->mModuleMgr
->addModules( self
::$Formats, 'format' );
193 $this->mModuleMgr
->addModules( $wgAPIFormatModules, 'format' );
195 $this->mResult
= new ApiResult( $this );
196 $this->mEnableWrite
= $enableWrite;
198 $this->mSquidMaxage
= -1; // flag for executeActionWithErrorHandling()
199 $this->mCommit
= false;
203 * Return true if the API was started by other PHP code using FauxRequest
206 public function isInternalMode() {
207 return $this->mInternalMode
;
211 * Get the ApiResult object associated with current request
215 public function getResult() {
216 return $this->mResult
;
220 * Get the API module object. Only works after executeAction()
224 public function getModule() {
225 return $this->mModule
;
229 * Get the result formatter object. Only works after setupExecuteAction()
231 * @return ApiFormatBase
233 public function getPrinter() {
234 return $this->mPrinter
;
238 * Set how long the response should be cached.
242 public function setCacheMaxAge( $maxage ) {
243 $this->setCacheControl( array(
244 'max-age' => $maxage,
245 's-maxage' => $maxage
250 * Set the type of caching headers which will be sent.
252 * @param string $mode One of:
253 * - 'public': Cache this object in public caches, if the maxage or smaxage
254 * parameter is set, or if setCacheMaxAge() was called. If a maximum age is
255 * not provided by any of these means, the object will be private.
256 * - 'private': Cache this object only in private client-side caches.
257 * - 'anon-public-user-private': Make this object cacheable for logged-out
258 * users, but private for logged-in users. IMPORTANT: If this is set, it must be
259 * set consistently for a given URL, it cannot be set differently depending on
260 * things like the contents of the database, or whether the user is logged in.
262 * If the wiki does not allow anonymous users to read it, the mode set here
263 * will be ignored, and private caching headers will always be sent. In other words,
264 * the "public" mode is equivalent to saying that the data sent is as public as a page
267 * For user-dependent data, the private mode should generally be used. The
268 * anon-public-user-private mode should only be used where there is a particularly
269 * good performance reason for caching the anonymous response, but where the
270 * response to logged-in users may differ, or may contain private data.
272 * If this function is never called, then the default will be the private mode.
274 public function setCacheMode( $mode ) {
275 if ( !in_array( $mode, array( 'private', 'public', 'anon-public-user-private' ) ) ) {
276 wfDebug( __METHOD__
. ": unrecognised cache mode \"$mode\"\n" );
278 // Ignore for forwards-compatibility
282 if ( !User
::isEveryoneAllowed( 'read' ) ) {
283 // Private wiki, only private headers
284 if ( $mode !== 'private' ) {
285 wfDebug( __METHOD__
. ": ignoring request for $mode cache mode, private wiki\n" );
291 wfDebug( __METHOD__
. ": setting cache mode $mode\n" );
292 $this->mCacheMode
= $mode;
296 * Set directives (key/value pairs) for the Cache-Control header.
297 * Boolean values will be formatted as such, by including or omitting
298 * without an equals sign.
300 * Cache control values set here will only be used if the cache mode is not
301 * private, see setCacheMode().
303 * @param $directives array
305 public function setCacheControl( $directives ) {
306 $this->mCacheControl
= $directives +
$this->mCacheControl
;
310 * Create an instance of an output formatter by its name
312 * @param $format string
314 * @return ApiFormatBase
316 public function createPrinterByName( $format ) {
317 $printer = $this->mModuleMgr
->getModule( $format, 'format' );
318 if ( $printer === null ) {
319 $this->dieUsage( "Unrecognized format: {$format}", 'unknown_format' );
326 * Execute api request. Any errors will be handled if the API was called by the remote client.
328 public function execute() {
330 if ( $this->mInternalMode
) {
331 $this->executeAction();
333 $this->executeActionWithErrorHandling();
340 * Execute an action, and in case of an error, erase whatever partial results
341 * have been accumulated, and replace it with an error message and a help screen.
343 protected function executeActionWithErrorHandling() {
344 // Verify the CORS header before executing the action
345 if ( !$this->handleCORS() ) {
346 // handleCORS() has sent a 403, abort
350 // Exit here if the request method was OPTIONS
351 // (assume there will be a followup GET or POST)
352 if ( $this->getRequest()->getMethod() === 'OPTIONS' ) {
356 // In case an error occurs during data output,
357 // clear the output buffer and print just the error information
360 $t = microtime( true );
362 $this->executeAction();
363 } catch ( Exception
$e ) {
364 // Allow extra cleanup and logging
365 wfRunHooks( 'ApiMain::onException', array( $this, $e ) );
368 if ( !( $e instanceof UsageException
) ) {
369 MWExceptionHandler
::logException( $e );
372 // Handle any kind of exception by outputting properly formatted error message.
373 // If this fails, an unhandled exception should be thrown so that global error
374 // handler will process and log it.
376 $errCode = $this->substituteResultWithError( $e );
378 // Error results should not be cached
379 $this->setCacheMode( 'private' );
381 $response = $this->getRequest()->response();
382 $headerStr = 'MediaWiki-API-Error: ' . $errCode;
383 if ( $e->getCode() === 0 ) {
384 $response->header( $headerStr );
386 $response->header( $headerStr, true, $e->getCode() );
389 // Reset and print just the error message
392 // If the error occurred during printing, do a printer->profileOut()
393 $this->mPrinter
->safeProfileOut();
394 $this->printResult( true );
397 // Log the request whether or not there was an error
398 $this->logRequest( microtime( true ) - $t );
400 // Send cache headers after any code which might generate an error, to
401 // avoid sending public cache headers for errors.
402 $this->sendCacheHeaders();
404 if ( $this->mPrinter
->getIsHtml() && !$this->mPrinter
->isDisabled() ) {
412 * Check the &origin= query parameter against the Origin: HTTP header and respond appropriately.
414 * If no origin parameter is present, nothing happens.
415 * If an origin parameter is present but doesn't match the Origin header, a 403 status code
416 * is set and false is returned.
417 * If the parameter and the header do match, the header is checked against $wgCrossSiteAJAXdomains
418 * and $wgCrossSiteAJAXdomainExceptions, and if the origin qualifies, the appropriate CORS
421 * @return bool False if the caller should abort (403 case), true otherwise (all other cases)
423 protected function handleCORS() {
424 global $wgCrossSiteAJAXdomains, $wgCrossSiteAJAXdomainExceptions;
426 $originParam = $this->getParameter( 'origin' ); // defaults to null
427 if ( $originParam === null ) {
428 // No origin parameter, nothing to do
432 $request = $this->getRequest();
433 $response = $request->response();
434 // Origin: header is a space-separated list of origins, check all of them
435 $originHeader = $request->getHeader( 'Origin' );
436 if ( $originHeader === false ) {
439 $origins = explode( ' ', $originHeader );
442 if ( !in_array( $originParam, $origins ) ) {
443 // origin parameter set but incorrect
444 // Send a 403 response
445 $message = HttpStatus
::getMessage( 403 );
446 $response->header( "HTTP/1.1 403 $message", true, 403 );
447 $response->header( 'Cache-Control: no-cache' );
448 echo "'origin' parameter does not match Origin header\n";
453 $matchOrigin = self
::matchOrigin(
455 $wgCrossSiteAJAXdomains,
456 $wgCrossSiteAJAXdomainExceptions
459 if ( $matchOrigin ) {
460 $response->header( "Access-Control-Allow-Origin: $originParam" );
461 $response->header( 'Access-Control-Allow-Credentials: true' );
462 $this->getOutput()->addVaryHeader( 'Origin' );
469 * Attempt to match an Origin header against a set of rules and a set of exceptions
470 * @param string $value Origin header
471 * @param array $rules Set of wildcard rules
472 * @param array $exceptions Set of wildcard rules
473 * @return bool True if $value matches a rule in $rules and doesn't match
474 * any rules in $exceptions, false otherwise
476 protected static function matchOrigin( $value, $rules, $exceptions ) {
477 foreach ( $rules as $rule ) {
478 if ( preg_match( self
::wildcardToRegex( $rule ), $value ) ) {
479 // Rule matches, check exceptions
480 foreach ( $exceptions as $exc ) {
481 if ( preg_match( self
::wildcardToRegex( $exc ), $value ) ) {
494 * Helper function to convert wildcard string into a regex
498 * @param string $wildcard String with wildcards
499 * @return string Regular expression
501 protected static function wildcardToRegex( $wildcard ) {
502 $wildcard = preg_quote( $wildcard, '/' );
503 $wildcard = str_replace(
509 return "/https?:\/\/$wildcard/";
512 protected function sendCacheHeaders() {
513 global $wgUseXVO, $wgVaryOnXFP;
514 $response = $this->getRequest()->response();
515 $out = $this->getOutput();
517 if ( $wgVaryOnXFP ) {
518 $out->addVaryHeader( 'X-Forwarded-Proto' );
521 if ( $this->mCacheMode
== 'private' ) {
522 $response->header( 'Cache-Control: private' );
527 if ( $this->mCacheMode
== 'anon-public-user-private' ) {
528 $out->addVaryHeader( 'Cookie' );
529 $response->header( $out->getVaryHeader() );
531 $response->header( $out->getXVO() );
532 if ( $out->haveCacheVaryCookies() ) {
533 // Logged in, mark this request private
534 $response->header( 'Cache-Control: private' );
538 // Logged out, send normal public headers below
539 } elseif ( session_id() != '' ) {
540 // Logged in or otherwise has session (e.g. anonymous users who have edited)
541 // Mark request private
542 $response->header( 'Cache-Control: private' );
545 } // else no XVO and anonymous, send public headers below
548 // Send public headers
549 $response->header( $out->getVaryHeader() );
551 $response->header( $out->getXVO() );
554 // If nobody called setCacheMaxAge(), use the (s)maxage parameters
555 if ( !isset( $this->mCacheControl
['s-maxage'] ) ) {
556 $this->mCacheControl
['s-maxage'] = $this->getParameter( 'smaxage' );
558 if ( !isset( $this->mCacheControl
['max-age'] ) ) {
559 $this->mCacheControl
['max-age'] = $this->getParameter( 'maxage' );
562 if ( !$this->mCacheControl
['s-maxage'] && !$this->mCacheControl
['max-age'] ) {
563 // Public cache not requested
564 // Sending a Vary header in this case is harmless, and protects us
565 // against conditional calls of setCacheMaxAge().
566 $response->header( 'Cache-Control: private' );
571 $this->mCacheControl
['public'] = true;
573 // Send an Expires header
574 $maxAge = min( $this->mCacheControl
['s-maxage'], $this->mCacheControl
['max-age'] );
575 $expiryUnixTime = ( $maxAge == 0 ?
1 : time() +
$maxAge );
576 $response->header( 'Expires: ' . wfTimestamp( TS_RFC2822
, $expiryUnixTime ) );
578 // Construct the Cache-Control header
581 foreach ( $this->mCacheControl
as $name => $value ) {
582 if ( is_bool( $value ) ) {
584 $ccHeader .= $separator . $name;
588 $ccHeader .= $separator . "$name=$value";
593 $response->header( "Cache-Control: $ccHeader" );
597 * Replace the result data with the information about an exception.
598 * Returns the error code
599 * @param $e Exception
602 protected function substituteResultWithError( $e ) {
603 global $wgShowHostnames;
605 $result = $this->getResult();
606 // Printer may not be initialized if the extractRequestParams() fails for the main module
607 if ( !isset( $this->mPrinter
) ) {
608 // The printer has not been created yet. Try to manually get formatter value.
609 $value = $this->getRequest()->getVal( 'format', self
::API_DEFAULT_FORMAT
);
610 if ( !$this->mModuleMgr
->isDefined( $value, 'format' ) ) {
611 $value = self
::API_DEFAULT_FORMAT
;
614 $this->mPrinter
= $this->createPrinterByName( $value );
615 if ( $this->mPrinter
->getNeedsRawData() ) {
616 $result->setRawMode();
620 if ( $e instanceof UsageException
) {
621 // User entered incorrect parameters - print usage screen
622 $errMessage = $e->getMessageArray();
624 // Only print the help message when this is for the developer, not runtime
625 if ( $this->mPrinter
->getWantsHelp() ||
$this->mAction
== 'help' ) {
626 ApiResult
::setContent( $errMessage, $this->makeHelpMsg() );
629 global $wgShowSQLErrors, $wgShowExceptionDetails;
630 // Something is seriously wrong
631 if ( ( $e instanceof DBQueryError
) && !$wgShowSQLErrors ) {
632 $info = 'Database query error';
634 $info = "Exception Caught: {$e->getMessage()}";
638 'code' => 'internal_api_error_' . get_class( $e ),
641 ApiResult
::setContent(
643 $wgShowExceptionDetails ?
"\n\n{$e->getTraceAsString()}\n\n" : ''
647 // Remember all the warnings to re-add them later
648 $oldResult = $result->getData();
649 $warnings = isset( $oldResult['warnings'] ) ?
$oldResult['warnings'] : null;
652 $result->disableSizeCheck();
654 $requestid = $this->getParameter( 'requestid' );
655 if ( !is_null( $requestid ) ) {
656 $result->addValue( null, 'requestid', $requestid );
658 if ( $wgShowHostnames ) {
659 // servedby is especially useful when debugging errors
660 $result->addValue( null, 'servedby', wfHostName() );
662 if ( $warnings !== null ) {
663 $result->addValue( null, 'warnings', $warnings );
666 $result->addValue( null, 'error', $errMessage );
668 return $errMessage['code'];
672 * Set up for the execution.
675 protected function setupExecuteAction() {
676 global $wgShowHostnames;
678 // First add the id to the top element
679 $result = $this->getResult();
680 $requestid = $this->getParameter( 'requestid' );
681 if ( !is_null( $requestid ) ) {
682 $result->addValue( null, 'requestid', $requestid );
685 if ( $wgShowHostnames ) {
686 $servedby = $this->getParameter( 'servedby' );
688 $result->addValue( null, 'servedby', wfHostName() );
692 $params = $this->extractRequestParams();
694 $this->mAction
= $params['action'];
696 if ( !is_string( $this->mAction
) ) {
697 $this->dieUsage( 'The API requires a valid action parameter', 'unknown_action' );
704 * Set up the module for response
705 * @return ApiBase The module that will handle this action
707 protected function setupModule() {
708 // Instantiate the module requested by the user
709 $module = $this->mModuleMgr
->getModule( $this->mAction
, 'action' );
710 if ( $module === null ) {
711 $this->dieUsage( 'The API requires a valid action parameter', 'unknown_action' );
713 $moduleParams = $module->extractRequestParams();
715 // Die if token required, but not provided
716 $salt = $module->getTokenSalt();
717 if ( $salt !== false ) {
718 if ( !isset( $moduleParams['token'] ) ) {
719 $this->dieUsageMsg( array( 'missingparam', 'token' ) );
722 if ( !$this->getUser()->matchEditToken(
723 $moduleParams['token'],
725 $this->getContext()->getRequest() )
727 $this->dieUsageMsg( 'sessionfailure' );
735 * Check the max lag if necessary
736 * @param $module ApiBase object: Api module being used
737 * @param array $params an array containing the request parameters.
738 * @return boolean True on success, false should exit immediately
740 protected function checkMaxLag( $module, $params ) {
741 if ( $module->shouldCheckMaxlag() && isset( $params['maxlag'] ) ) {
743 global $wgShowHostnames;
744 $maxLag = $params['maxlag'];
745 list( $host, $lag ) = wfGetLB()->getMaxLag();
746 if ( $lag > $maxLag ) {
747 $response = $this->getRequest()->response();
749 $response->header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
750 $response->header( 'X-Database-Lag: ' . intval( $lag ) );
752 if ( $wgShowHostnames ) {
753 $this->dieUsage( "Waiting for $host: $lag seconds lagged", 'maxlag' );
756 $this->dieUsage( "Waiting for a database server: $lag seconds lagged", 'maxlag' );
764 * Check for sufficient permissions to execute
765 * @param $module ApiBase An Api module
767 protected function checkExecutePermissions( $module ) {
768 $user = $this->getUser();
769 if ( $module->isReadMode() && !User
::isEveryoneAllowed( 'read' ) &&
770 !$user->isAllowed( 'read' )
772 $this->dieUsageMsg( 'readrequired' );
774 if ( $module->isWriteMode() ) {
775 if ( !$this->mEnableWrite
) {
776 $this->dieUsageMsg( 'writedisabled' );
778 if ( !$user->isAllowed( 'writeapi' ) ) {
779 $this->dieUsageMsg( 'writerequired' );
781 if ( wfReadOnly() ) {
782 $this->dieReadOnly();
786 // Allow extensions to stop execution for arbitrary reasons.
788 if ( !wfRunHooks( 'ApiCheckCanExecute', array( $module, $user, &$message ) ) ) {
789 $this->dieUsageMsg( $message );
794 * Check asserts of the user's rights
795 * @param $params array
797 protected function checkAsserts( $params ) {
798 if ( isset( $params['assert'] ) ) {
799 $user = $this->getUser();
800 switch ( $params['assert'] ) {
802 if ( $user->isAnon() ) {
803 $this->dieUsage( 'Assertion that the user is logged in failed', 'assertuserfailed' );
807 if ( !$user->isAllowed( 'bot' ) ) {
808 $this->dieUsage( 'Assertion that the user has the bot right failed', 'assertbotfailed' );
816 * Check POST for external response and setup result printer
817 * @param $module ApiBase An Api module
818 * @param array $params an array with the request parameters
820 protected function setupExternalResponse( $module, $params ) {
821 if ( !$this->getRequest()->wasPosted() && $module->mustBePosted() ) {
822 // Module requires POST. GET request might still be allowed
823 // if $wgDebugApi is true, otherwise fail.
824 $this->dieUsageMsgOrDebug( array( 'mustbeposted', $this->mAction
) );
827 // See if custom printer is used
828 $this->mPrinter
= $module->getCustomPrinter();
829 if ( is_null( $this->mPrinter
) ) {
830 // Create an appropriate printer
831 $this->mPrinter
= $this->createPrinterByName( $params['format'] );
834 if ( $this->mPrinter
->getNeedsRawData() ) {
835 $this->getResult()->setRawMode();
840 * Execute the actual module, without any error handling
842 protected function executeAction() {
843 $params = $this->setupExecuteAction();
844 $module = $this->setupModule();
845 $this->mModule
= $module;
847 $this->checkExecutePermissions( $module );
849 if ( !$this->checkMaxLag( $module, $params ) ) {
853 if ( !$this->mInternalMode
) {
854 $this->setupExternalResponse( $module, $params );
857 $this->checkAsserts( $params );
860 $module->profileIn();
862 wfRunHooks( 'APIAfterExecute', array( &$module ) );
863 $module->profileOut();
865 $this->reportUnusedParams();
867 if ( !$this->mInternalMode
) {
868 //append Debug information
869 MWDebug
::appendDebugInfoToApiResult( $this->getContext(), $this->getResult() );
872 $this->printResult( false );
877 * Log the preceding request
878 * @param int $time Time in seconds
880 protected function logRequest( $time ) {
881 $request = $this->getRequest();
882 $milliseconds = $time === null ?
'?' : round( $time * 1000 );
884 ' ' . $request->getMethod() .
885 ' ' . wfUrlencode( str_replace( ' ', '_', $this->getUser()->getName() ) ) .
886 ' ' . $request->getIP() .
887 ' T=' . $milliseconds . 'ms';
888 foreach ( $this->getParamsUsed() as $name ) {
889 $value = $request->getVal( $name );
890 if ( $value === null ) {
893 $s .= ' ' . $name . '=';
894 if ( strlen( $value ) > 256 ) {
895 $encValue = $this->encodeRequestLogValue( substr( $value, 0, 256 ) );
896 $s .= $encValue . '[...]';
898 $s .= $this->encodeRequestLogValue( $value );
902 wfDebugLog( 'api', $s, false );
906 * Encode a value in a format suitable for a space-separated log line.
908 protected function encodeRequestLogValue( $s ) {
911 $chars = ';@$!*(),/:';
912 $numChars = strlen( $chars );
913 for ( $i = 0; $i < $numChars; $i++
) {
914 $table[rawurlencode( $chars[$i] )] = $chars[$i];
918 return strtr( rawurlencode( $s ), $table );
922 * Get the request parameters used in the course of the preceding execute() request
924 protected function getParamsUsed() {
925 return array_keys( $this->mParamsUsed
);
929 * Get a request value, and register the fact that it was used, for logging.
931 public function getVal( $name, $default = null ) {
932 $this->mParamsUsed
[$name] = true;
934 return $this->getRequest()->getVal( $name, $default );
938 * Get a boolean request value, and register the fact that the parameter
939 * was used, for logging.
941 public function getCheck( $name ) {
942 $this->mParamsUsed
[$name] = true;
944 return $this->getRequest()->getCheck( $name );
948 * Get a request upload, and register the fact that it was used, for logging.
951 * @param string $name Parameter name
952 * @return WebRequestUpload
954 public function getUpload( $name ) {
955 $this->mParamsUsed
[$name] = true;
957 return $this->getRequest()->getUpload( $name );
961 * Report unused parameters, so the client gets a hint in case it gave us parameters we don't know,
962 * for example in case of spelling mistakes or a missing 'g' prefix for generators.
964 protected function reportUnusedParams() {
965 $paramsUsed = $this->getParamsUsed();
966 $allParams = $this->getRequest()->getValueNames();
968 if ( !$this->mInternalMode
) {
969 // Printer has not yet executed; don't warn that its parameters are unused
970 $printerParams = array_map(
971 array( $this->mPrinter
, 'encodeParamName' ),
972 array_keys( $this->mPrinter
->getFinalParams() ?
: array() )
974 $unusedParams = array_diff( $allParams, $paramsUsed, $printerParams );
976 $unusedParams = array_diff( $allParams, $paramsUsed );
979 if ( count( $unusedParams ) ) {
980 $s = count( $unusedParams ) > 1 ?
's' : '';
981 $this->setWarning( "Unrecognized parameter$s: '" . implode( $unusedParams, "', '" ) . "'" );
986 * Print results using the current printer
988 * @param $isError bool
990 protected function printResult( $isError ) {
992 if ( $wgDebugAPI !== false ) {
993 $this->setWarning( 'SECURITY WARNING: $wgDebugAPI is enabled' );
996 $this->getResult()->cleanUpUTF8();
997 $printer = $this->mPrinter
;
998 $printer->profileIn();
1001 * If the help message is requested in the default (xmlfm) format,
1002 * tell the printer not to escape ampersands so that our links do
1005 $isHelp = $isError ||
$this->mAction
== 'help';
1006 $printer->setUnescapeAmps( $isHelp && $printer->getFormat() == 'XML' && $printer->getIsHtml() );
1008 $printer->initPrinter( $isHelp );
1010 $printer->execute();
1011 $printer->closePrinter();
1012 $printer->profileOut();
1018 public function isReadMode() {
1023 * See ApiBase for description.
1027 public function getAllowedParams() {
1030 ApiBase
::PARAM_DFLT
=> ApiMain
::API_DEFAULT_FORMAT
,
1031 ApiBase
::PARAM_TYPE
=> $this->mModuleMgr
->getNames( 'format' )
1034 ApiBase
::PARAM_DFLT
=> 'help',
1035 ApiBase
::PARAM_TYPE
=> $this->mModuleMgr
->getNames( 'action' )
1038 ApiBase
::PARAM_TYPE
=> 'integer'
1041 ApiBase
::PARAM_TYPE
=> 'integer',
1042 ApiBase
::PARAM_DFLT
=> 0
1045 ApiBase
::PARAM_TYPE
=> 'integer',
1046 ApiBase
::PARAM_DFLT
=> 0
1049 ApiBase
::PARAM_TYPE
=> array( 'user', 'bot' )
1051 'requestid' => null,
1052 'servedby' => false,
1058 * See ApiBase for description.
1062 public function getParamDescription() {
1064 'format' => 'The format of the output',
1065 'action' => 'What action you would like to perform. See below for module help',
1067 'Maximum lag can be used when MediaWiki is installed on a database replicated cluster.',
1068 'To save actions causing any more site replication lag, this parameter can make the client',
1069 'wait until the replication lag is less than the specified value.',
1070 'In case of a replag error, error code "maxlag" is returned, with the message like',
1071 '"Waiting for $host: $lag seconds lagged\n".',
1072 'See https://www.mediawiki.org/wiki/Manual:Maxlag_parameter for more information',
1074 'smaxage' => 'Set the s-maxage header to this many seconds. Errors are never cached',
1075 'maxage' => 'Set the max-age header to this many seconds. Errors are never cached',
1076 'assert' => 'Verify the user is logged in if set to "user", or has the bot userright if "bot"',
1077 'requestid' => 'Request ID to distinguish requests. This will just be output back to you',
1078 'servedby' => 'Include the hostname that served the request in the ' .
1079 'results. Unconditionally shown on error',
1081 'When accessing the API using a cross-domain AJAX request (CORS), set this to the',
1082 'originating domain. This must be included in any pre-flight request, and',
1083 'therefore must be part of the request URI (not the POST body). This must match',
1084 'one of the origins in the Origin: header exactly, so it has to be set to ',
1085 'something like http://en.wikipedia.org or https://meta.wikimedia.org . If this',
1086 'parameter does not match the Origin: header, a 403 response will be returned. If',
1087 'this parameter matches the Origin: header and the origin is whitelisted, an',
1088 'Access-Control-Allow-Origin header will be set.',
1094 * See ApiBase for description.
1098 public function getDescription() {
1102 '**********************************************************************************************',
1104 '** This is an auto-generated MediaWiki API documentation page **',
1106 '** Documentation and Examples: **',
1107 '** https://www.mediawiki.org/wiki/API **',
1109 '**********************************************************************************************',
1111 'Status: All features shown on this page should be working, but the API',
1112 ' is still in active development, and may change at any time.',
1113 ' Make sure to monitor our mailing list for any updates',
1115 'Erroneous requests: When erroneous requests are sent to the API, a HTTP header will be sent',
1116 ' with the key "MediaWiki-API-Error" and then both the value of the',
1117 ' header and the error code sent back will be set to the same value',
1119 ' In the case of an invalid action being passed, these will have a value',
1120 ' of "unknown_action"',
1122 ' For more information see https://www.mediawiki.org' .
1123 '/wiki/API:Errors_and_warnings',
1125 'Documentation: https://www.mediawiki.org/wiki/API:Main_page',
1126 'FAQ https://www.mediawiki.org/wiki/API:FAQ',
1127 'Mailing list: https://lists.wikimedia.org/mailman/listinfo/mediawiki-api',
1128 'Api Announcements: https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce',
1129 'Bugs & Requests: https://bugzilla.wikimedia.org/buglist.cgi?component=API&' .
1130 'bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts',
1142 public function getPossibleErrors() {
1143 return array_merge( parent
::getPossibleErrors(), array(
1144 array( 'readonlytext' ),
1145 array( 'code' => 'unknown_format', 'info' => 'Unrecognized format: format' ),
1146 array( 'code' => 'unknown_action', 'info' => 'The API requires a valid action parameter' ),
1147 array( 'code' => 'maxlag', 'info' => 'Waiting for host: x seconds lagged' ),
1148 array( 'code' => 'maxlag', 'info' => 'Waiting for a database server: x seconds lagged' ),
1149 array( 'code' => 'assertuserfailed', 'info' => 'Assertion that the user is logged in failed' ),
1150 array( 'code' => 'assertbotfailed', 'info' => 'Assertion that the user has the bot right failed' ),
1155 * Returns an array of strings with credits for the API
1158 protected function getCredits() {
1161 ' Roan Kattouw - roan . kattouw @ gmail . com (lead developer Sep 2007-2009)',
1162 ' Victor Vasiliev - vasilvv @ gmail . com',
1163 ' Bryan Tong Minh - bryan . tongminh @ gmail . com',
1164 ' Sam Reed - sam @ reedyboy . net',
1165 ' Yuri Astrakhan - yuri . astrakhan @ gmail . com (creator, lead ' .
1166 'developer Sep 2006-Sep 2007, 2012-present)',
1168 'Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org',
1169 'or file a bug report at https://bugzilla.wikimedia.org/'
1174 * Sets whether the pretty-printer should format *bold* and $italics$
1178 public function setHelp( $help = true ) {
1179 $this->mPrinter
->setHelp( $help );
1183 * Override the parent to generate help messages for all available modules.
1187 public function makeHelpMsg() {
1188 global $wgMemc, $wgAPICacheHelpTimeout;
1190 // Get help text from cache if present
1191 $key = wfMemcKey( 'apihelp', $this->getModuleName(),
1192 str_replace( ' ', '_', SpecialVersion
::getVersion( 'nodb' ) ) );
1193 if ( $wgAPICacheHelpTimeout > 0 ) {
1194 $cached = $wgMemc->get( $key );
1199 $retval = $this->reallyMakeHelpMsg();
1200 if ( $wgAPICacheHelpTimeout > 0 ) {
1201 $wgMemc->set( $key, $retval, $wgAPICacheHelpTimeout );
1208 * @return mixed|string
1210 public function reallyMakeHelpMsg() {
1213 // Use parent to make default message for the main module
1214 $msg = parent
::makeHelpMsg();
1216 $astriks = str_repeat( '*** ', 14 );
1217 $msg .= "\n\n$astriks Modules $astriks\n\n";
1219 foreach ( $this->mModuleMgr
->getNames( 'action' ) as $name ) {
1220 $module = $this->mModuleMgr
->getModule( $name );
1221 $msg .= self
::makeHelpMsgHeader( $module, 'action' );
1223 $msg2 = $module->makeHelpMsg();
1224 if ( $msg2 !== false ) {
1230 $msg .= "\n$astriks Permissions $astriks\n\n";
1231 foreach ( self
::$mRights as $right => $rightMsg ) {
1232 $groups = User
::getGroupsWithPermission( $right );
1233 $msg .= "* " . $right . " *\n " . wfMsgReplaceArgs( $rightMsg['msg'], $rightMsg['params'] ) .
1234 "\nGranted to:\n " . str_replace( '*', 'all', implode( ', ', $groups ) ) . "\n\n";
1237 $msg .= "\n$astriks Formats $astriks\n\n";
1238 foreach ( $this->mModuleMgr
->getNames( 'format' ) as $name ) {
1239 $module = $this->mModuleMgr
->getModule( $name );
1240 $msg .= self
::makeHelpMsgHeader( $module, 'format' );
1241 $msg2 = $module->makeHelpMsg();
1242 if ( $msg2 !== false ) {
1248 $msg .= "\n*** Credits: ***\n " . implode( "\n ", $this->getCredits() ) . "\n";
1254 * @param $module ApiBase
1255 * @param string $paramName What type of request is this? e.g. action,
1256 * query, list, prop, meta, format
1259 public static function makeHelpMsgHeader( $module, $paramName ) {
1260 $modulePrefix = $module->getModulePrefix();
1261 if ( strval( $modulePrefix ) !== '' ) {
1262 $modulePrefix = "($modulePrefix) ";
1265 return "* $paramName={$module->getModuleName()} $modulePrefix*";
1268 private $mCanApiHighLimits = null;
1271 * Check whether the current user is allowed to use high limits
1274 public function canApiHighLimits() {
1275 if ( !isset( $this->mCanApiHighLimits
) ) {
1276 $this->mCanApiHighLimits
= $this->getUser()->isAllowed( 'apihighlimits' );
1279 return $this->mCanApiHighLimits
;
1283 * Check whether the user wants us to show version information in the API help
1285 * @deprecated since 1.21, always returns false
1287 public function getShowVersions() {
1288 wfDeprecated( __METHOD__
, '1.21' );
1294 * Overrides to return this instance's module manager.
1295 * @return ApiModuleManager
1297 public function getModuleManager() {
1298 return $this->mModuleMgr
;
1302 * Add or overwrite a module in this ApiMain instance. Intended for use by extending
1303 * classes who wish to add their own modules to their lexicon or override the
1304 * behavior of inherent ones.
1306 * @deprecated since 1.21, Use getModuleManager()->addModule() instead.
1307 * @param string $name The identifier for this module.
1308 * @param $class ApiBase The class where this module is implemented.
1310 protected function addModule( $name, $class ) {
1311 $this->getModuleManager()->addModule( $name, 'action', $class );
1315 * Add or overwrite an output format for this ApiMain. Intended for use by extending
1316 * classes who wish to add to or modify current formatters.
1318 * @deprecated since 1.21, Use getModuleManager()->addModule() instead.
1319 * @param string $name The identifier for this format.
1320 * @param $class ApiFormatBase The class implementing this format.
1322 protected function addFormat( $name, $class ) {
1323 $this->getModuleManager()->addModule( $name, 'format', $class );
1327 * Get the array mapping module names to class names
1328 * @deprecated since 1.21, Use getModuleManager()'s methods instead.
1331 function getModules() {
1332 return $this->getModuleManager()->getNamesWithClasses( 'action' );
1336 * Returns the list of supported formats in form ( 'format' => 'ClassName' )
1339 * @deprecated since 1.21, Use getModuleManager()'s methods instead.
1342 public function getFormats() {
1343 return $this->getModuleManager()->getNamesWithClasses( 'format' );
1348 * This exception will be thrown when dieUsage is called to stop module execution.
1349 * The exception handling code will print a help screen explaining how this API may be used.
1353 class UsageException
extends MWException
{
1360 private $mExtraData;
1363 * @param $message string
1364 * @param $codestr string
1366 * @param $extradata array|null
1368 public function __construct( $message, $codestr, $code = 0, $extradata = null ) {
1369 parent
::__construct( $message, $code );
1370 $this->mCodestr
= $codestr;
1371 $this->mExtraData
= $extradata;
1377 public function getCodeString() {
1378 return $this->mCodestr
;
1384 public function getMessageArray() {
1386 'code' => $this->mCodestr
,
1387 'info' => $this->getMessage()
1389 if ( is_array( $this->mExtraData
) ) {
1390 $result = array_merge( $result, $this->mExtraData
);
1399 public function __toString() {
1400 return "{$this->getCodeString()}: {$this->getMessage()}";