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 'query' => 'ApiQuery',
55 'expandtemplates' => 'ApiExpandTemplates',
56 'parse' => 'ApiParse',
57 'opensearch' => 'ApiOpenSearch',
58 'feedcontributions' => 'ApiFeedContributions',
59 'feedwatchlist' => 'ApiFeedWatchlist',
61 'paraminfo' => 'ApiParamInfo',
63 'compare' => 'ApiComparePages',
64 'tokens' => 'ApiTokens',
67 'purge' => 'ApiPurge',
68 'setnotificationtimestamp' => 'ApiSetNotificationTimestamp',
69 'rollback' => 'ApiRollback',
70 'delete' => 'ApiDelete',
71 'undelete' => 'ApiUndelete',
72 'protect' => 'ApiProtect',
73 'block' => 'ApiBlock',
74 'unblock' => 'ApiUnblock',
76 'edit' => 'ApiEditPage',
77 'upload' => 'ApiUpload',
78 'filerevert' => 'ApiFileRevert',
79 'emailuser' => 'ApiEmailUser',
80 'watch' => 'ApiWatch',
81 'patrol' => 'ApiPatrol',
82 'import' => 'ApiImport',
83 'userrights' => 'ApiUserrights',
84 'options' => 'ApiOptions',
88 * List of available formats: format name => format class
90 private static $Formats = array(
91 'json' => 'ApiFormatJson',
92 'jsonfm' => 'ApiFormatJson',
93 'php' => 'ApiFormatPhp',
94 'phpfm' => 'ApiFormatPhp',
95 'wddx' => 'ApiFormatWddx',
96 'wddxfm' => 'ApiFormatWddx',
97 'xml' => 'ApiFormatXml',
98 'xmlfm' => 'ApiFormatXml',
99 'yaml' => 'ApiFormatYaml',
100 'yamlfm' => 'ApiFormatYaml',
101 'rawfm' => 'ApiFormatJson',
102 'txt' => 'ApiFormatTxt',
103 'txtfm' => 'ApiFormatTxt',
104 'dbg' => 'ApiFormatDbg',
105 'dbgfm' => 'ApiFormatDbg',
106 'dump' => 'ApiFormatDump',
107 'dumpfm' => 'ApiFormatDump',
108 'none' => 'ApiFormatNone',
112 * List of user roles that are specifically relevant to the API.
113 * array( 'right' => array ( 'msg' => 'Some message with a $1',
114 * 'params' => array ( $someVarToSubst ) ),
117 private static $mRights = array(
119 'msg' => 'Use of the write API',
122 'apihighlimits' => array(
123 '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.',
124 'params' => array( ApiBase
::LIMIT_SML2
, ApiBase
::LIMIT_BIG2
)
133 private $mModules, $mModuleNames, $mFormats, $mFormatNames;
134 private $mResult, $mAction, $mShowVersions, $mEnableWrite;
135 private $mInternalMode, $mSquidMaxage, $mModule;
137 private $mCacheMode = 'private';
138 private $mCacheControl = array();
139 private $mParamsUsed = array();
142 * Constructs an instance of ApiMain that utilizes the module and format specified by $request.
144 * @param $context IContextSource|WebRequest - if this is an instance of FauxRequest, errors are thrown and no printing occurs
145 * @param $enableWrite bool should be set to true if the api may modify data
147 public function __construct( $context = null, $enableWrite = false ) {
148 if ( $context === null ) {
149 $context = RequestContext
::getMain();
150 } elseif ( $context instanceof WebRequest
) {
153 $context = RequestContext
::getMain();
155 // We set a derivative context so we can change stuff later
156 $this->setContext( new DerivativeContext( $context ) );
158 if ( isset( $request ) ) {
159 $this->getContext()->setRequest( $request );
162 $this->mInternalMode
= ( $this->getRequest() instanceof FauxRequest
);
164 // Special handling for the main module: $parent === $this
165 parent
::__construct( $this, $this->mInternalMode ?
'main_int' : 'main' );
167 if ( !$this->mInternalMode
) {
168 // Impose module restrictions.
169 // If the current user cannot read,
170 // Remove all modules other than login
173 if ( $this->getVal( 'callback' ) !== null ) {
174 // JSON callback allows cross-site reads.
175 // For safety, strip user credentials.
176 wfDebug( "API: stripping user credentials for JSON callback\n" );
177 $wgUser = new User();
178 $this->getContext()->setUser( $wgUser );
182 global $wgAPIModules; // extension modules
183 $this->mModules
= $wgAPIModules + self
::$Modules;
185 $this->mModuleNames
= array_keys( $this->mModules
);
186 $this->mFormats
= self
::$Formats;
187 $this->mFormatNames
= array_keys( $this->mFormats
);
189 $this->mResult
= new ApiResult( $this );
190 $this->mShowVersions
= false;
191 $this->mEnableWrite
= $enableWrite;
193 $this->mSquidMaxage
= - 1; // flag for executeActionWithErrorHandling()
194 $this->mCommit
= false;
198 * Return true if the API was started by other PHP code using FauxRequest
201 public function isInternalMode() {
202 return $this->mInternalMode
;
206 * Get the ApiResult object associated with current request
210 public function getResult() {
211 return $this->mResult
;
215 * Get the API module object. Only works after executeAction()
219 public function getModule() {
220 return $this->mModule
;
224 * Get the result formatter object. Only works after setupExecuteAction()
226 * @return ApiFormatBase
228 public function getPrinter() {
229 return $this->mPrinter
;
233 * Set how long the response should be cached.
237 public function setCacheMaxAge( $maxage ) {
238 $this->setCacheControl( array(
239 'max-age' => $maxage,
240 's-maxage' => $maxage
245 * Set the type of caching headers which will be sent.
247 * @param $mode String One of:
248 * - 'public': Cache this object in public caches, if the maxage or smaxage
249 * parameter is set, or if setCacheMaxAge() was called. If a maximum age is
250 * not provided by any of these means, the object will be private.
251 * - 'private': Cache this object only in private client-side caches.
252 * - 'anon-public-user-private': Make this object cacheable for logged-out
253 * users, but private for logged-in users. IMPORTANT: If this is set, it must be
254 * set consistently for a given URL, it cannot be set differently depending on
255 * things like the contents of the database, or whether the user is logged in.
257 * If the wiki does not allow anonymous users to read it, the mode set here
258 * will be ignored, and private caching headers will always be sent. In other words,
259 * the "public" mode is equivalent to saying that the data sent is as public as a page
262 * For user-dependent data, the private mode should generally be used. The
263 * anon-public-user-private mode should only be used where there is a particularly
264 * good performance reason for caching the anonymous response, but where the
265 * response to logged-in users may differ, or may contain private data.
267 * If this function is never called, then the default will be the private mode.
269 public function setCacheMode( $mode ) {
270 if ( !in_array( $mode, array( 'private', 'public', 'anon-public-user-private' ) ) ) {
271 wfDebug( __METHOD__
. ": unrecognised cache mode \"$mode\"\n" );
272 // Ignore for forwards-compatibility
276 if ( !in_array( 'read', User
::getGroupPermissions( array( '*' ) ), true ) ) {
277 // Private wiki, only private headers
278 if ( $mode !== 'private' ) {
279 wfDebug( __METHOD__
. ": ignoring request for $mode cache mode, private wiki\n" );
284 wfDebug( __METHOD__
. ": setting cache mode $mode\n" );
285 $this->mCacheMode
= $mode;
289 * @deprecated since 1.17 Private caching is now the default, so there is usually no
290 * need to call this function. If there is a need, you can use
291 * $this->setCacheMode('private')
293 public function setCachePrivate() {
294 wfDeprecated( __METHOD__
, '1.17' );
295 $this->setCacheMode( 'private' );
299 * Set directives (key/value pairs) for the Cache-Control header.
300 * Boolean values will be formatted as such, by including or omitting
301 * without an equals sign.
303 * Cache control values set here will only be used if the cache mode is not
304 * private, see setCacheMode().
306 * @param $directives array
308 public function setCacheControl( $directives ) {
309 $this->mCacheControl
= $directives +
$this->mCacheControl
;
313 * Make sure Vary: Cookie and friends are set. Use this when the output of a request
314 * may be cached for anons but may not be cached for logged-in users.
316 * WARNING: This function must be called CONSISTENTLY for a given URL. This means that a
317 * given URL must either always or never call this function; if it sometimes does and
318 * sometimes doesn't, stuff will break.
320 * @deprecated since 1.17 Use setCacheMode( 'anon-public-user-private' )
322 public function setVaryCookie() {
323 wfDeprecated( __METHOD__
, '1.17' );
324 $this->setCacheMode( 'anon-public-user-private' );
328 * Create an instance of an output formatter by its name
330 * @param $format string
332 * @return ApiFormatBase
334 public function createPrinterByName( $format ) {
335 if ( !isset( $this->mFormats
[$format] ) ) {
336 $this->dieUsage( "Unrecognized format: {$format}", 'unknown_format' );
338 return new $this->mFormats
[$format] ( $this, $format );
342 * Execute api request. Any errors will be handled if the API was called by the remote client.
344 public function execute() {
346 if ( $this->mInternalMode
) {
347 $this->executeAction();
349 $this->executeActionWithErrorHandling();
356 * Execute an action, and in case of an error, erase whatever partial results
357 * have been accumulated, and replace it with an error message and a help screen.
359 protected function executeActionWithErrorHandling() {
360 // Verify the CORS header before executing the action
361 if ( !$this->handleCORS() ) {
362 // handleCORS() has sent a 403, abort
366 // In case an error occurs during data output,
367 // clear the output buffer and print just the error information
370 $t = microtime( true );
372 $this->executeAction();
373 } catch ( Exception
$e ) {
374 // Allow extra cleanup and logging
375 wfRunHooks( 'ApiMain::onException', array( $this, $e ) );
378 if ( !( $e instanceof UsageException
) ) {
379 wfDebugLog( 'exception', $e->getLogMessage() );
382 // Handle any kind of exception by outputing properly formatted error message.
383 // If this fails, an unhandled exception should be thrown so that global error
384 // handler will process and log it.
386 $errCode = $this->substituteResultWithError( $e );
388 // Error results should not be cached
389 $this->setCacheMode( 'private' );
391 $response = $this->getRequest()->response();
392 $headerStr = 'MediaWiki-API-Error: ' . $errCode;
393 if ( $e->getCode() === 0 ) {
394 $response->header( $headerStr );
396 $response->header( $headerStr, true, $e->getCode() );
399 // Reset and print just the error message
402 // If the error occurred during printing, do a printer->profileOut()
403 $this->mPrinter
->safeProfileOut();
404 $this->printResult( true );
407 // Log the request whether or not there was an error
408 $this->logRequest( microtime( true ) - $t);
410 // Send cache headers after any code which might generate an error, to
411 // avoid sending public cache headers for errors.
412 $this->sendCacheHeaders();
414 if ( $this->mPrinter
->getIsHtml() && !$this->mPrinter
->isDisabled() ) {
422 * Check the &origin= query parameter against the Origin: HTTP header and respond appropriately.
424 * If no origin parameter is present, nothing happens.
425 * If an origin parameter is present but doesn't match the Origin header, a 403 status code
426 * is set and false is returned.
427 * If the parameter and the header do match, the header is checked against $wgCrossSiteAJAXdomains
428 * and $wgCrossSiteAJAXdomainExceptions, and if the origin qualifies, the appropriate CORS
431 * @return bool False if the caller should abort (403 case), true otherwise (all other cases)
433 protected function handleCORS() {
434 global $wgCrossSiteAJAXdomains, $wgCrossSiteAJAXdomainExceptions;
436 $originParam = $this->getParameter( 'origin' ); // defaults to null
437 if ( $originParam === null ) {
438 // No origin parameter, nothing to do
442 $request = $this->getRequest();
443 $response = $request->response();
444 // Origin: header is a space-separated list of origins, check all of them
445 $originHeader = $request->getHeader( 'Origin' );
446 if ( $originHeader === false ) {
449 $origins = explode( ' ', $originHeader );
451 if ( !in_array( $originParam, $origins ) ) {
452 // origin parameter set but incorrect
453 // Send a 403 response
454 $message = HttpStatus
::getMessage( 403 );
455 $response->header( "HTTP/1.1 403 $message", true, 403 );
456 $response->header( 'Cache-Control: no-cache' );
457 echo "'origin' parameter does not match Origin header\n";
460 if ( self
::matchOrigin( $originParam, $wgCrossSiteAJAXdomains, $wgCrossSiteAJAXdomainExceptions ) ) {
461 $response->header( "Access-Control-Allow-Origin: $originParam" );
462 $response->header( 'Access-Control-Allow-Credentials: true' );
463 $this->getOutput()->addVaryHeader( 'Origin' );
469 * Attempt to match an Origin header against a set of rules and a set of exceptions
470 * @param $value string Origin header
471 * @param $rules array Set of wildcard rules
472 * @param $exceptions array Set of wildcard rules
473 * @return bool True if $value matches a rule in $rules and doesn't match any rules in $exceptions, false otherwise
475 protected static function matchOrigin( $value, $rules, $exceptions ) {
476 foreach ( $rules as $rule ) {
477 if ( preg_match( self
::wildcardToRegex( $rule ), $value ) ) {
478 // Rule matches, check exceptions
479 foreach ( $exceptions as $exc ) {
480 if ( preg_match( self
::wildcardToRegex( $exc ), $value ) ) {
491 * Helper function to convert wildcard string into a regex
495 * @param $wildcard string String with wildcards
496 * @return string Regular expression
498 protected static function wildcardToRegex( $wildcard ) {
499 $wildcard = preg_quote( $wildcard, '/' );
500 $wildcard = str_replace(
505 return "/https?:\/\/$wildcard/";
508 protected function sendCacheHeaders() {
509 global $wgUseXVO, $wgVaryOnXFP;
510 $response = $this->getRequest()->response();
511 $out = $this->getOutput();
513 if ( $wgVaryOnXFP ) {
514 $out->addVaryHeader( 'X-Forwarded-Proto' );
517 if ( $this->mCacheMode
== 'private' ) {
518 $response->header( 'Cache-Control: private' );
522 if ( $this->mCacheMode
== 'anon-public-user-private' ) {
523 $out->addVaryHeader( 'Cookie' );
524 $response->header( $out->getVaryHeader() );
526 $response->header( $out->getXVO() );
527 if ( $out->haveCacheVaryCookies() ) {
528 // Logged in, mark this request private
529 $response->header( 'Cache-Control: private' );
532 // Logged out, send normal public headers below
533 } elseif ( session_id() != '' ) {
534 // Logged in or otherwise has session (e.g. anonymous users who have edited)
535 // Mark request private
536 $response->header( 'Cache-Control: private' );
538 } // else no XVO and anonymous, send public headers below
541 // Send public headers
542 $response->header( $out->getVaryHeader() );
544 $response->header( $out->getXVO() );
547 // If nobody called setCacheMaxAge(), use the (s)maxage parameters
548 if ( !isset( $this->mCacheControl
['s-maxage'] ) ) {
549 $this->mCacheControl
['s-maxage'] = $this->getParameter( 'smaxage' );
551 if ( !isset( $this->mCacheControl
['max-age'] ) ) {
552 $this->mCacheControl
['max-age'] = $this->getParameter( 'maxage' );
555 if ( !$this->mCacheControl
['s-maxage'] && !$this->mCacheControl
['max-age'] ) {
556 // Public cache not requested
557 // Sending a Vary header in this case is harmless, and protects us
558 // against conditional calls of setCacheMaxAge().
559 $response->header( 'Cache-Control: private' );
563 $this->mCacheControl
['public'] = true;
565 // Send an Expires header
566 $maxAge = min( $this->mCacheControl
['s-maxage'], $this->mCacheControl
['max-age'] );
567 $expiryUnixTime = ( $maxAge == 0 ?
1 : time() +
$maxAge );
568 $response->header( 'Expires: ' . wfTimestamp( TS_RFC2822
, $expiryUnixTime ) );
570 // Construct the Cache-Control header
573 foreach ( $this->mCacheControl
as $name => $value ) {
574 if ( is_bool( $value ) ) {
576 $ccHeader .= $separator . $name;
580 $ccHeader .= $separator . "$name=$value";
585 $response->header( "Cache-Control: $ccHeader" );
589 * Replace the result data with the information about an exception.
590 * Returns the error code
591 * @param $e Exception
594 protected function substituteResultWithError( $e ) {
595 global $wgShowHostnames;
597 $result = $this->getResult();
598 // Printer may not be initialized if the extractRequestParams() fails for the main module
599 if ( !isset ( $this->mPrinter
) ) {
600 // The printer has not been created yet. Try to manually get formatter value.
601 $value = $this->getRequest()->getVal( 'format', self
::API_DEFAULT_FORMAT
);
602 if ( !in_array( $value, $this->mFormatNames
) ) {
603 $value = self
::API_DEFAULT_FORMAT
;
606 $this->mPrinter
= $this->createPrinterByName( $value );
607 if ( $this->mPrinter
->getNeedsRawData() ) {
608 $result->setRawMode();
612 if ( $e instanceof UsageException
) {
613 // User entered incorrect parameters - print usage screen
614 $errMessage = $e->getMessageArray();
616 // Only print the help message when this is for the developer, not runtime
617 if ( $this->mPrinter
->getWantsHelp() ||
$this->mAction
== 'help' ) {
618 ApiResult
::setContent( $errMessage, $this->makeHelpMsg() );
622 global $wgShowSQLErrors, $wgShowExceptionDetails;
623 // Something is seriously wrong
624 if ( ( $e instanceof DBQueryError
) && !$wgShowSQLErrors ) {
625 $info = 'Database query error';
627 $info = "Exception Caught: {$e->getMessage()}";
631 'code' => 'internal_api_error_' . get_class( $e ),
634 ApiResult
::setContent( $errMessage, $wgShowExceptionDetails ?
"\n\n{$e->getTraceAsString()}\n\n" : '' );
638 $result->disableSizeCheck();
640 $requestid = $this->getParameter( 'requestid' );
641 if ( !is_null( $requestid ) ) {
642 $result->addValue( null, 'requestid', $requestid );
645 if ( $wgShowHostnames ) {
646 // servedby is especially useful when debugging errors
647 $result->addValue( null, 'servedby', wfHostName() );
650 $result->addValue( null, 'error', $errMessage );
652 return $errMessage['code'];
656 * Set up for the execution.
659 protected function setupExecuteAction() {
660 global $wgShowHostnames;
662 // First add the id to the top element
663 $result = $this->getResult();
664 $requestid = $this->getParameter( 'requestid' );
665 if ( !is_null( $requestid ) ) {
666 $result->addValue( null, 'requestid', $requestid );
669 if ( $wgShowHostnames ) {
670 $servedby = $this->getParameter( 'servedby' );
672 $result->addValue( null, 'servedby', wfHostName() );
676 $params = $this->extractRequestParams();
678 $this->mShowVersions
= $params['version'];
679 $this->mAction
= $params['action'];
681 if ( !is_string( $this->mAction
) ) {
682 $this->dieUsage( 'The API requires a valid action parameter', 'unknown_action' );
689 * Set up the module for response
690 * @return ApiBase The module that will handle this action
692 protected function setupModule() {
693 // Instantiate the module requested by the user
694 $module = new $this->mModules
[$this->mAction
] ( $this, $this->mAction
);
695 $this->mModule
= $module;
697 $moduleParams = $module->extractRequestParams();
699 // Die if token required, but not provided (unless there is a gettoken parameter)
700 if ( isset( $moduleParams['gettoken'] ) ) {
701 $gettoken = $moduleParams['gettoken'];
706 $salt = $module->getTokenSalt();
707 if ( $salt !== false && !$gettoken ) {
708 if ( !isset( $moduleParams['token'] ) ) {
709 $this->dieUsageMsg( array( 'missingparam', 'token' ) );
711 if ( !$this->getUser()->matchEditToken( $moduleParams['token'], $salt, $this->getContext()->getRequest() ) ) {
712 $this->dieUsageMsg( 'sessionfailure' );
720 * Check the max lag if necessary
721 * @param $module ApiBase object: Api module being used
722 * @param $params Array an array containing the request parameters.
723 * @return boolean True on success, false should exit immediately
725 protected function checkMaxLag( $module, $params ) {
726 if ( $module->shouldCheckMaxlag() && isset( $params['maxlag'] ) ) {
728 global $wgShowHostnames;
729 $maxLag = $params['maxlag'];
730 list( $host, $lag ) = wfGetLB()->getMaxLag();
731 if ( $lag > $maxLag ) {
732 $response = $this->getRequest()->response();
734 $response->header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
735 $response->header( 'X-Database-Lag: ' . intval( $lag ) );
737 if ( $wgShowHostnames ) {
738 $this->dieUsage( "Waiting for $host: $lag seconds lagged", 'maxlag' );
740 $this->dieUsage( "Waiting for a database server: $lag seconds lagged", 'maxlag' );
749 * Check for sufficient permissions to execute
750 * @param $module ApiBase An Api module
752 protected function checkExecutePermissions( $module ) {
753 $user = $this->getUser();
754 if ( $module->isReadMode() && !in_array( 'read', User
::getGroupPermissions( array( '*' ) ), true ) &&
755 !$user->isAllowed( 'read' ) )
757 $this->dieUsageMsg( 'readrequired' );
759 if ( $module->isWriteMode() ) {
760 if ( !$this->mEnableWrite
) {
761 $this->dieUsageMsg( 'writedisabled' );
763 if ( !$user->isAllowed( 'writeapi' ) ) {
764 $this->dieUsageMsg( 'writerequired' );
766 if ( wfReadOnly() ) {
767 $this->dieReadOnly();
771 // Allow extensions to stop execution for arbitrary reasons.
773 if( !wfRunHooks( 'ApiCheckCanExecute', array( $module, $user, &$message ) ) ) {
774 $this->dieUsageMsg( $message );
779 * Check POST for external response and setup result printer
780 * @param $module ApiBase An Api module
781 * @param $params Array an array with the request parameters
783 protected function setupExternalResponse( $module, $params ) {
784 // Ignore mustBePosted() for internal calls
785 if ( $module->mustBePosted() && !$this->getRequest()->wasPosted() ) {
786 $this->dieUsageMsg( array( 'mustbeposted', $this->mAction
) );
789 // See if custom printer is used
790 $this->mPrinter
= $module->getCustomPrinter();
791 if ( is_null( $this->mPrinter
) ) {
792 // Create an appropriate printer
793 $this->mPrinter
= $this->createPrinterByName( $params['format'] );
796 if ( $this->mPrinter
->getNeedsRawData() ) {
797 $this->getResult()->setRawMode();
802 * Execute the actual module, without any error handling
804 protected function executeAction() {
805 $params = $this->setupExecuteAction();
806 $module = $this->setupModule();
808 $this->checkExecutePermissions( $module );
810 if ( !$this->checkMaxLag( $module, $params ) ) {
814 if ( !$this->mInternalMode
) {
815 $this->setupExternalResponse( $module, $params );
819 $module->profileIn();
821 wfRunHooks( 'APIAfterExecute', array( &$module ) );
822 $module->profileOut();
824 if ( !$this->mInternalMode
) {
825 // Report unused params
826 $this->reportUnusedParams();
828 //append Debug information
829 MWDebug
::appendDebugInfoToApiResult( $this->getContext(), $this->getResult() );
832 $this->printResult( false );
837 * Log the preceding request
838 * @param $time Time in seconds
840 protected function logRequest( $time ) {
841 $request = $this->getRequest();
842 $milliseconds = $time === null ?
'?' : round( $time * 1000 );
844 ' ' . $request->getMethod() .
845 ' ' . wfUrlencode( str_replace( ' ', '_', $this->getUser()->getName() ) ) .
846 ' ' . $request->getIP() .
847 ' T=' . $milliseconds .'ms';
848 foreach ( $this->getParamsUsed() as $name ) {
849 $value = $request->getVal( $name );
850 if ( $value === null ) {
853 $s .= ' ' . $name . '=';
854 if ( strlen( $value ) > 256 ) {
855 $encValue = $this->encodeRequestLogValue( substr( $value, 0, 256 ) );
856 $s .= $encValue . '[...]';
858 $s .= $this->encodeRequestLogValue( $value );
862 wfDebugLog( 'api', $s, false );
866 * Encode a value in a format suitable for a space-separated log line.
868 protected function encodeRequestLogValue( $s ) {
871 $chars = ';@$!*(),/:';
872 for ( $i = 0; $i < strlen( $chars ); $i++
) {
873 $table[ rawurlencode( $chars[$i] ) ] = $chars[$i];
876 return strtr( rawurlencode( $s ), $table );
880 * Get the request parameters used in the course of the preceding execute() request
882 protected function getParamsUsed() {
883 return array_keys( $this->mParamsUsed
);
887 * Get a request value, and register the fact that it was used, for logging.
889 public function getVal( $name, $default = null ) {
890 $this->mParamsUsed
[$name] = true;
891 return $this->getRequest()->getVal( $name, $default );
895 * Get a boolean request value, and register the fact that the parameter
896 * was used, for logging.
898 public function getCheck( $name ) {
899 $this->mParamsUsed
[$name] = true;
900 return $this->getRequest()->getCheck( $name );
904 * Report unused parameters, so the client gets a hint in case it gave us parameters we don't know,
905 * for example in case of spelling mistakes or a missing 'g' prefix for generators.
907 protected function reportUnusedParams() {
908 $paramsUsed = $this->getParamsUsed();
909 $allParams = $this->getRequest()->getValueNames();
911 $unusedParams = array_diff( $allParams, $paramsUsed );
912 if( count( $unusedParams ) ) {
913 $s = count( $unusedParams ) > 1 ?
's' : '';
914 $this->setWarning( "Unrecognized parameter$s: '" . implode( $unusedParams, "', '" ) . "'" );
919 * Print results using the current printer
921 * @param $isError bool
923 protected function printResult( $isError ) {
924 $this->getResult()->cleanUpUTF8();
925 $printer = $this->mPrinter
;
926 $printer->profileIn();
929 * If the help message is requested in the default (xmlfm) format,
930 * tell the printer not to escape ampersands so that our links do
933 $printer->setUnescapeAmps( ( $this->mAction
== 'help' ||
$isError )
934 && $printer->getFormat() == 'XML' && $printer->getIsHtml() );
936 $printer->initPrinter( $isError );
939 $printer->closePrinter();
940 $printer->profileOut();
946 public function isReadMode() {
951 * See ApiBase for description.
955 public function getAllowedParams() {
958 ApiBase
::PARAM_DFLT
=> ApiMain
::API_DEFAULT_FORMAT
,
959 ApiBase
::PARAM_TYPE
=> $this->mFormatNames
962 ApiBase
::PARAM_DFLT
=> 'help',
963 ApiBase
::PARAM_TYPE
=> $this->mModuleNames
967 ApiBase
::PARAM_TYPE
=> 'integer'
970 ApiBase
::PARAM_TYPE
=> 'integer',
971 ApiBase
::PARAM_DFLT
=> 0
974 ApiBase
::PARAM_TYPE
=> 'integer',
975 ApiBase
::PARAM_DFLT
=> 0
984 * See ApiBase for description.
988 public function getParamDescription() {
990 'format' => 'The format of the output',
991 'action' => 'What action you would like to perform. See below for module help',
992 'version' => 'When showing help, include version for each module',
994 'Maximum lag can be used when MediaWiki is installed on a database replicated cluster.',
995 'To save actions causing any more site replication lag, this parameter can make the client',
996 'wait until the replication lag is less than the specified value.',
997 'In case of a replag error, a HTTP 503 error is returned, with the message like',
998 '"Waiting for $host: $lag seconds lagged\n".',
999 'See https://www.mediawiki.org/wiki/Manual:Maxlag_parameter for more information',
1001 'smaxage' => 'Set the s-maxage header to this many seconds. Errors are never cached',
1002 'maxage' => 'Set the max-age header to this many seconds. Errors are never cached',
1003 'requestid' => 'Request ID to distinguish requests. This will just be output back to you',
1004 'servedby' => 'Include the hostname that served the request in the results. Unconditionally shown on error',
1006 'When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain.',
1007 'This must match one of the origins in the Origin: header exactly, so it has to be set to something like http://en.wikipedia.org or https://meta.wikimedia.org .',
1008 'If this parameter does not match the Origin: header, a 403 response will be returned.',
1009 'If this parameter matches the Origin: header and the origin is whitelisted, an Access-Control-Allow-Origin header will be set.',
1015 * See ApiBase for description.
1019 public function getDescription() {
1023 '**********************************************************************************************************',
1025 '** This is an auto-generated MediaWiki API documentation page **',
1027 '** Documentation and Examples: **',
1028 '** https://www.mediawiki.org/wiki/API **',
1030 '**********************************************************************************************************',
1032 'Status: All features shown on this page should be working, but the API',
1033 ' is still in active development, and may change at any time.',
1034 ' Make sure to monitor our mailing list for any updates',
1036 'Erroneous requests: When erroneous requests are sent to the API, a HTTP header will be sent',
1037 ' with the key "MediaWiki-API-Error" and then both the value of the',
1038 ' header and the error code sent back will be set to the same value',
1040 ' In the case of an invalid action being passed, these will have a value',
1041 ' of "unknown_action"',
1043 ' For more information see https://www.mediawiki.org/wiki/API:Errors_and_warnings',
1045 'Documentation: https://www.mediawiki.org/wiki/API:Main_page',
1046 'FAQ https://www.mediawiki.org/wiki/API:FAQ',
1047 'Mailing list: https://lists.wikimedia.org/mailman/listinfo/mediawiki-api',
1048 'Api Announcements: https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce',
1049 'Bugs & Requests: https://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts',
1061 public function getPossibleErrors() {
1062 return array_merge( parent
::getPossibleErrors(), array(
1063 array( 'readonlytext' ),
1064 array( 'code' => 'unknown_format', 'info' => 'Unrecognized format: format' ),
1065 array( 'code' => 'unknown_action', 'info' => 'The API requires a valid action parameter' ),
1066 array( 'code' => 'maxlag', 'info' => 'Waiting for host: x seconds lagged' ),
1067 array( 'code' => 'maxlag', 'info' => 'Waiting for a database server: x seconds lagged' ),
1072 * Returns an array of strings with credits for the API
1075 protected function getCredits() {
1078 ' Roan Kattouw "<Firstname>.<Lastname>@gmail.com" (lead developer Sep 2007-present)',
1079 ' Victor Vasiliev - vasilvv at gee mail dot com',
1080 ' Bryan Tong Minh - bryan . tongminh @ gmail . com',
1081 ' Sam Reed - sam @ reedyboy . net',
1082 ' Yuri Astrakhan "<Firstname><Lastname>@gmail.com" (creator, lead developer Sep 2006-Sep 2007)',
1084 'Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org',
1085 'or file a bug report at https://bugzilla.wikimedia.org/'
1090 * Sets whether the pretty-printer should format *bold* and $italics$
1094 public function setHelp( $help = true ) {
1095 $this->mPrinter
->setHelp( $help );
1099 * Override the parent to generate help messages for all available modules.
1103 public function makeHelpMsg() {
1104 global $wgMemc, $wgAPICacheHelpTimeout;
1106 // Get help text from cache if present
1107 $key = wfMemcKey( 'apihelp', $this->getModuleName(),
1108 SpecialVersion
::getVersion( 'nodb' ) .
1109 $this->getShowVersions() );
1110 if ( $wgAPICacheHelpTimeout > 0 ) {
1111 $cached = $wgMemc->get( $key );
1116 $retval = $this->reallyMakeHelpMsg();
1117 if ( $wgAPICacheHelpTimeout > 0 ) {
1118 $wgMemc->set( $key, $retval, $wgAPICacheHelpTimeout );
1124 * @return mixed|string
1126 public function reallyMakeHelpMsg() {
1129 // Use parent to make default message for the main module
1130 $msg = parent
::makeHelpMsg();
1132 $astriks = str_repeat( '*** ', 14 );
1133 $msg .= "\n\n$astriks Modules $astriks\n\n";
1134 foreach ( array_keys( $this->mModules
) as $moduleName ) {
1135 $module = new $this->mModules
[$moduleName] ( $this, $moduleName );
1136 $msg .= self
::makeHelpMsgHeader( $module, 'action' );
1137 $msg2 = $module->makeHelpMsg();
1138 if ( $msg2 !== false ) {
1144 $msg .= "\n$astriks Permissions $astriks\n\n";
1145 foreach ( self
::$mRights as $right => $rightMsg ) {
1146 $groups = User
::getGroupsWithPermission( $right );
1147 $msg .= "* " . $right . " *\n " . wfMsgReplaceArgs( $rightMsg[ 'msg' ], $rightMsg[ 'params' ] ) .
1148 "\nGranted to:\n " . str_replace( '*', 'all', implode( ', ', $groups ) ) . "\n\n";
1152 $msg .= "\n$astriks Formats $astriks\n\n";
1153 foreach ( array_keys( $this->mFormats
) as $formatName ) {
1154 $module = $this->createPrinterByName( $formatName );
1155 $msg .= self
::makeHelpMsgHeader( $module, 'format' );
1156 $msg2 = $module->makeHelpMsg();
1157 if ( $msg2 !== false ) {
1163 $msg .= "\n*** Credits: ***\n " . implode( "\n ", $this->getCredits() ) . "\n";
1169 * @param $module ApiBase
1170 * @param $paramName String What type of request is this? e.g. action, query, list, prop, meta, format
1173 public static function makeHelpMsgHeader( $module, $paramName ) {
1174 $modulePrefix = $module->getModulePrefix();
1175 if ( strval( $modulePrefix ) !== '' ) {
1176 $modulePrefix = "($modulePrefix) ";
1179 return "* $paramName={$module->getModuleName()} $modulePrefix*";
1182 private $mCanApiHighLimits = null;
1185 * Check whether the current user is allowed to use high limits
1188 public function canApiHighLimits() {
1189 if ( !isset( $this->mCanApiHighLimits
) ) {
1190 $this->mCanApiHighLimits
= $this->getUser()->isAllowed( 'apihighlimits' );
1193 return $this->mCanApiHighLimits
;
1197 * Check whether the user wants us to show version information in the API help
1200 public function getShowVersions() {
1201 return $this->mShowVersions
;
1205 * Returns the version information of this file, plus it includes
1206 * the versions for all files that are not callable proper API modules
1210 public function getVersion() {
1212 $vers[] = 'MediaWiki: ' . SpecialVersion
::getVersion() . "\n https://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/";
1213 $vers[] = __CLASS__
. ': $Id$';
1214 $vers[] = ApiBase
::getBaseVersion();
1215 $vers[] = ApiFormatBase
::getBaseVersion();
1216 $vers[] = ApiQueryBase
::getBaseVersion();
1221 * Add or overwrite a module in this ApiMain instance. Intended for use by extending
1222 * classes who wish to add their own modules to their lexicon or override the
1223 * behavior of inherent ones.
1225 * @param $mdlName String The identifier for this module.
1226 * @param $mdlClass String The class where this module is implemented.
1228 protected function addModule( $mdlName, $mdlClass ) {
1229 $this->mModules
[$mdlName] = $mdlClass;
1233 * Add or overwrite an output format for this ApiMain. Intended for use by extending
1234 * classes who wish to add to or modify current formatters.
1236 * @param $fmtName string The identifier for this format.
1237 * @param $fmtClass ApiFormatBase The class implementing this format.
1239 protected function addFormat( $fmtName, $fmtClass ) {
1240 $this->mFormats
[$fmtName] = $fmtClass;
1244 * Get the array mapping module names to class names
1247 function getModules() {
1248 return $this->mModules
;
1252 * Returns the list of supported formats in form ( 'format' => 'ClassName' )
1257 public function getFormats() {
1258 return $this->mFormats
;
1263 * This exception will be thrown when dieUsage is called to stop module execution.
1264 * The exception handling code will print a help screen explaining how this API may be used.
1268 class UsageException
extends MWException
{
1275 private $mExtraData;
1278 * @param $message string
1279 * @param $codestr string
1281 * @param $extradata array|null
1283 public function __construct( $message, $codestr, $code = 0, $extradata = null ) {
1284 parent
::__construct( $message, $code );
1285 $this->mCodestr
= $codestr;
1286 $this->mExtraData
= $extradata;
1292 public function getCodeString() {
1293 return $this->mCodestr
;
1299 public function getMessageArray() {
1301 'code' => $this->mCodestr
,
1302 'info' => $this->getMessage()
1304 if ( is_array( $this->mExtraData
) ) {
1305 $result = array_merge( $result, $this->mExtraData
);
1313 public function __toString() {
1314 return "{$this->getCodeString()}: {$this->getMessage()}";