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',
111 * List of user roles that are specifically relevant to the API.
112 * array( 'right' => array ( 'msg' => 'Some message with a $1',
113 * 'params' => array ( $someVarToSubst ) ),
116 private static $mRights = array(
118 'msg' => 'Use of the write API',
121 'apihighlimits' => array(
122 '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.',
123 'params' => array( ApiBase
::LIMIT_SML2
, ApiBase
::LIMIT_BIG2
)
132 private $mModules, $mModuleNames, $mFormats, $mFormatNames;
133 private $mResult, $mAction, $mShowVersions, $mEnableWrite;
134 private $mInternalMode, $mSquidMaxage, $mModule;
136 private $mCacheMode = 'private';
137 private $mCacheControl = array();
138 private $mParamsUsed = array();
141 * Constructs an instance of ApiMain that utilizes the module and format specified by $request.
143 * @param $context IContextSource|WebRequest - if this is an instance of FauxRequest, errors are thrown and no printing occurs
144 * @param $enableWrite bool should be set to true if the api may modify data
146 public function __construct( $context = null, $enableWrite = false ) {
147 if ( $context === null ) {
148 $context = RequestContext
::getMain();
149 } elseif ( $context instanceof WebRequest
) {
152 $context = RequestContext
::getMain();
154 // We set a derivative context so we can change stuff later
155 $this->setContext( new DerivativeContext( $context ) );
157 if ( isset( $request ) ) {
158 $this->getContext()->setRequest( $request );
161 $this->mInternalMode
= ( $this->getRequest() instanceof FauxRequest
);
163 // Special handling for the main module: $parent === $this
164 parent
::__construct( $this, $this->mInternalMode ?
'main_int' : 'main' );
166 if ( !$this->mInternalMode
) {
167 // Impose module restrictions.
168 // If the current user cannot read,
169 // Remove all modules other than login
172 if ( $this->getVal( 'callback' ) !== null ) {
173 // JSON callback allows cross-site reads.
174 // For safety, strip user credentials.
175 wfDebug( "API: stripping user credentials for JSON callback\n" );
176 $wgUser = new User();
177 $this->getContext()->setUser( $wgUser );
181 global $wgAPIModules; // extension modules
182 $this->mModules
= $wgAPIModules + self
::$Modules;
184 $this->mModuleNames
= array_keys( $this->mModules
);
185 $this->mFormats
= self
::$Formats;
186 $this->mFormatNames
= array_keys( $this->mFormats
);
188 $this->mResult
= new ApiResult( $this );
189 $this->mShowVersions
= false;
190 $this->mEnableWrite
= $enableWrite;
192 $this->mSquidMaxage
= - 1; // flag for executeActionWithErrorHandling()
193 $this->mCommit
= false;
197 * Return true if the API was started by other PHP code using FauxRequest
200 public function isInternalMode() {
201 return $this->mInternalMode
;
205 * Get the ApiResult object associated with current request
209 public function getResult() {
210 return $this->mResult
;
214 * Get the API module object. Only works after executeAction()
218 public function getModule() {
219 return $this->mModule
;
223 * Get the result formatter object. Only works after setupExecuteAction()
225 * @return ApiFormatBase
227 public function getPrinter() {
228 return $this->mPrinter
;
232 * Set how long the response should be cached.
236 public function setCacheMaxAge( $maxage ) {
237 $this->setCacheControl( array(
238 'max-age' => $maxage,
239 's-maxage' => $maxage
244 * Set the type of caching headers which will be sent.
246 * @param $mode String One of:
247 * - 'public': Cache this object in public caches, if the maxage or smaxage
248 * parameter is set, or if setCacheMaxAge() was called. If a maximum age is
249 * not provided by any of these means, the object will be private.
250 * - 'private': Cache this object only in private client-side caches.
251 * - 'anon-public-user-private': Make this object cacheable for logged-out
252 * users, but private for logged-in users. IMPORTANT: If this is set, it must be
253 * set consistently for a given URL, it cannot be set differently depending on
254 * things like the contents of the database, or whether the user is logged in.
256 * If the wiki does not allow anonymous users to read it, the mode set here
257 * will be ignored, and private caching headers will always be sent. In other words,
258 * the "public" mode is equivalent to saying that the data sent is as public as a page
261 * For user-dependent data, the private mode should generally be used. The
262 * anon-public-user-private mode should only be used where there is a particularly
263 * good performance reason for caching the anonymous response, but where the
264 * response to logged-in users may differ, or may contain private data.
266 * If this function is never called, then the default will be the private mode.
268 public function setCacheMode( $mode ) {
269 if ( !in_array( $mode, array( 'private', 'public', 'anon-public-user-private' ) ) ) {
270 wfDebug( __METHOD__
. ": unrecognised cache mode \"$mode\"\n" );
271 // Ignore for forwards-compatibility
275 if ( !in_array( 'read', User
::getGroupPermissions( array( '*' ) ), true ) ) {
276 // Private wiki, only private headers
277 if ( $mode !== 'private' ) {
278 wfDebug( __METHOD__
. ": ignoring request for $mode cache mode, private wiki\n" );
283 wfDebug( __METHOD__
. ": setting cache mode $mode\n" );
284 $this->mCacheMode
= $mode;
288 * @deprecated since 1.17 Private caching is now the default, so there is usually no
289 * need to call this function. If there is a need, you can use
290 * $this->setCacheMode('private')
292 public function setCachePrivate() {
293 wfDeprecated( __METHOD__
, '1.17' );
294 $this->setCacheMode( 'private' );
298 * Set directives (key/value pairs) for the Cache-Control header.
299 * Boolean values will be formatted as such, by including or omitting
300 * without an equals sign.
302 * Cache control values set here will only be used if the cache mode is not
303 * private, see setCacheMode().
305 * @param $directives array
307 public function setCacheControl( $directives ) {
308 $this->mCacheControl
= $directives +
$this->mCacheControl
;
312 * Make sure Vary: Cookie and friends are set. Use this when the output of a request
313 * may be cached for anons but may not be cached for logged-in users.
315 * WARNING: This function must be called CONSISTENTLY for a given URL. This means that a
316 * given URL must either always or never call this function; if it sometimes does and
317 * sometimes doesn't, stuff will break.
319 * @deprecated since 1.17 Use setCacheMode( 'anon-public-user-private' )
321 public function setVaryCookie() {
322 wfDeprecated( __METHOD__
, '1.17' );
323 $this->setCacheMode( 'anon-public-user-private' );
327 * Create an instance of an output formatter by its name
329 * @param $format string
331 * @return ApiFormatBase
333 public function createPrinterByName( $format ) {
334 if ( !isset( $this->mFormats
[$format] ) ) {
335 $this->dieUsage( "Unrecognized format: {$format}", 'unknown_format' );
337 return new $this->mFormats
[$format] ( $this, $format );
341 * Execute api request. Any errors will be handled if the API was called by the remote client.
343 public function execute() {
345 if ( $this->mInternalMode
) {
346 $this->executeAction();
348 $this->executeActionWithErrorHandling();
355 * Execute an action, and in case of an error, erase whatever partial results
356 * have been accumulated, and replace it with an error message and a help screen.
358 protected function executeActionWithErrorHandling() {
359 // Verify the CORS header before executing the action
360 if ( !$this->handleCORS() ) {
361 // handleCORS() has sent a 403, abort
365 // In case an error occurs during data output,
366 // clear the output buffer and print just the error information
369 $t = microtime( true );
371 $this->executeAction();
372 } catch ( Exception
$e ) {
373 // Allow extra cleanup and logging
374 wfRunHooks( 'ApiMain::onException', array( $this, $e ) );
377 if ( !( $e instanceof UsageException
) ) {
378 wfDebugLog( 'exception', $e->getLogMessage() );
381 // Handle any kind of exception by outputing properly formatted error message.
382 // If this fails, an unhandled exception should be thrown so that global error
383 // handler will process and log it.
385 $errCode = $this->substituteResultWithError( $e );
387 // Error results should not be cached
388 $this->setCacheMode( 'private' );
390 $response = $this->getRequest()->response();
391 $headerStr = 'MediaWiki-API-Error: ' . $errCode;
392 if ( $e->getCode() === 0 ) {
393 $response->header( $headerStr );
395 $response->header( $headerStr, true, $e->getCode() );
398 // Reset and print just the error message
401 // If the error occurred during printing, do a printer->profileOut()
402 $this->mPrinter
->safeProfileOut();
403 $this->printResult( true );
406 // Log the request whether or not there was an error
407 $this->logRequest( microtime( true ) - $t);
409 // Send cache headers after any code which might generate an error, to
410 // avoid sending public cache headers for errors.
411 $this->sendCacheHeaders();
413 if ( $this->mPrinter
->getIsHtml() && !$this->mPrinter
->isDisabled() ) {
421 * Check the &origin= query parameter against the Origin: HTTP header and respond appropriately.
423 * If no origin parameter is present, nothing happens.
424 * If an origin parameter is present but doesn't match the Origin header, a 403 status code
425 * is set and false is returned.
426 * If the parameter and the header do match, the header is checked against $wgCrossSiteAJAXdomains
427 * and $wgCrossSiteAJAXdomainExceptions, and if the origin qualifies, the appropriate CORS
430 * @return bool False if the caller should abort (403 case), true otherwise (all other cases)
432 protected function handleCORS() {
433 global $wgCrossSiteAJAXdomains, $wgCrossSiteAJAXdomainExceptions;
435 $originParam = $this->getParameter( 'origin' ); // defaults to null
436 if ( $originParam === null ) {
437 // No origin parameter, nothing to do
441 $request = $this->getRequest();
442 $response = $request->response();
443 // Origin: header is a space-separated list of origins, check all of them
444 $originHeader = $request->getHeader( 'Origin' );
445 if ( $originHeader === false ) {
448 $origins = explode( ' ', $originHeader );
450 if ( !in_array( $originParam, $origins ) ) {
451 // origin parameter set but incorrect
452 // Send a 403 response
453 $message = HttpStatus
::getMessage( 403 );
454 $response->header( "HTTP/1.1 403 $message", true, 403 );
455 $response->header( 'Cache-Control: no-cache' );
456 echo "'origin' parameter does not match Origin header\n";
459 if ( self
::matchOrigin( $originParam, $wgCrossSiteAJAXdomains, $wgCrossSiteAJAXdomainExceptions ) ) {
460 $response->header( "Access-Control-Allow-Origin: $originParam" );
461 $response->header( 'Access-Control-Allow-Credentials: true' );
462 $this->getOutput()->addVaryHeader( 'Origin' );
468 * Attempt to match an Origin header against a set of rules and a set of exceptions
469 * @param $value string Origin header
470 * @param $rules array Set of wildcard rules
471 * @param $exceptions array Set of wildcard rules
472 * @return bool True if $value matches a rule in $rules and doesn't match any rules in $exceptions, false otherwise
474 protected static function matchOrigin( $value, $rules, $exceptions ) {
475 foreach ( $rules as $rule ) {
476 if ( preg_match( self
::wildcardToRegex( $rule ), $value ) ) {
477 // Rule matches, check exceptions
478 foreach ( $exceptions as $exc ) {
479 if ( preg_match( self
::wildcardToRegex( $exc ), $value ) ) {
490 * Helper function to convert wildcard string into a regex
494 * @param $wildcard string String with wildcards
495 * @return string Regular expression
497 protected static function wildcardToRegex( $wildcard ) {
498 $wildcard = preg_quote( $wildcard, '/' );
499 $wildcard = str_replace(
504 return "/https?:\/\/$wildcard/";
507 protected function sendCacheHeaders() {
508 global $wgUseXVO, $wgVaryOnXFP;
509 $response = $this->getRequest()->response();
510 $out = $this->getOutput();
512 if ( $wgVaryOnXFP ) {
513 $out->addVaryHeader( 'X-Forwarded-Proto' );
516 if ( $this->mCacheMode
== 'private' ) {
517 $response->header( 'Cache-Control: private' );
521 if ( $this->mCacheMode
== 'anon-public-user-private' ) {
522 $out->addVaryHeader( 'Cookie' );
523 $response->header( $out->getVaryHeader() );
525 $response->header( $out->getXVO() );
526 if ( $out->haveCacheVaryCookies() ) {
527 // Logged in, mark this request private
528 $response->header( 'Cache-Control: private' );
531 // Logged out, send normal public headers below
532 } elseif ( session_id() != '' ) {
533 // Logged in or otherwise has session (e.g. anonymous users who have edited)
534 // Mark request private
535 $response->header( 'Cache-Control: private' );
537 } // else no XVO and anonymous, send public headers below
540 // Send public headers
541 $response->header( $out->getVaryHeader() );
543 $response->header( $out->getXVO() );
546 // If nobody called setCacheMaxAge(), use the (s)maxage parameters
547 if ( !isset( $this->mCacheControl
['s-maxage'] ) ) {
548 $this->mCacheControl
['s-maxage'] = $this->getParameter( 'smaxage' );
550 if ( !isset( $this->mCacheControl
['max-age'] ) ) {
551 $this->mCacheControl
['max-age'] = $this->getParameter( 'maxage' );
554 if ( !$this->mCacheControl
['s-maxage'] && !$this->mCacheControl
['max-age'] ) {
555 // Public cache not requested
556 // Sending a Vary header in this case is harmless, and protects us
557 // against conditional calls of setCacheMaxAge().
558 $response->header( 'Cache-Control: private' );
562 $this->mCacheControl
['public'] = true;
564 // Send an Expires header
565 $maxAge = min( $this->mCacheControl
['s-maxage'], $this->mCacheControl
['max-age'] );
566 $expiryUnixTime = ( $maxAge == 0 ?
1 : time() +
$maxAge );
567 $response->header( 'Expires: ' . wfTimestamp( TS_RFC2822
, $expiryUnixTime ) );
569 // Construct the Cache-Control header
572 foreach ( $this->mCacheControl
as $name => $value ) {
573 if ( is_bool( $value ) ) {
575 $ccHeader .= $separator . $name;
579 $ccHeader .= $separator . "$name=$value";
584 $response->header( "Cache-Control: $ccHeader" );
588 * Replace the result data with the information about an exception.
589 * Returns the error code
590 * @param $e Exception
593 protected function substituteResultWithError( $e ) {
594 global $wgShowHostnames;
596 $result = $this->getResult();
597 // Printer may not be initialized if the extractRequestParams() fails for the main module
598 if ( !isset ( $this->mPrinter
) ) {
599 // The printer has not been created yet. Try to manually get formatter value.
600 $value = $this->getRequest()->getVal( 'format', self
::API_DEFAULT_FORMAT
);
601 if ( !in_array( $value, $this->mFormatNames
) ) {
602 $value = self
::API_DEFAULT_FORMAT
;
605 $this->mPrinter
= $this->createPrinterByName( $value );
606 if ( $this->mPrinter
->getNeedsRawData() ) {
607 $result->setRawMode();
611 if ( $e instanceof UsageException
) {
612 // User entered incorrect parameters - print usage screen
613 $errMessage = $e->getMessageArray();
615 // Only print the help message when this is for the developer, not runtime
616 if ( $this->mPrinter
->getWantsHelp() ||
$this->mAction
== 'help' ) {
617 ApiResult
::setContent( $errMessage, $this->makeHelpMsg() );
621 global $wgShowSQLErrors, $wgShowExceptionDetails;
622 // Something is seriously wrong
623 if ( ( $e instanceof DBQueryError
) && !$wgShowSQLErrors ) {
624 $info = 'Database query error';
626 $info = "Exception Caught: {$e->getMessage()}";
630 'code' => 'internal_api_error_' . get_class( $e ),
633 ApiResult
::setContent( $errMessage, $wgShowExceptionDetails ?
"\n\n{$e->getTraceAsString()}\n\n" : '' );
637 $result->disableSizeCheck();
639 $requestid = $this->getParameter( 'requestid' );
640 if ( !is_null( $requestid ) ) {
641 $result->addValue( null, 'requestid', $requestid );
644 if ( $wgShowHostnames ) {
645 // servedby is especially useful when debugging errors
646 $result->addValue( null, 'servedby', wfHostName() );
649 $result->addValue( null, 'error', $errMessage );
651 return $errMessage['code'];
655 * Set up for the execution.
658 protected function setupExecuteAction() {
659 global $wgShowHostnames;
661 // First add the id to the top element
662 $result = $this->getResult();
663 $requestid = $this->getParameter( 'requestid' );
664 if ( !is_null( $requestid ) ) {
665 $result->addValue( null, 'requestid', $requestid );
668 if ( $wgShowHostnames ) {
669 $servedby = $this->getParameter( 'servedby' );
671 $result->addValue( null, 'servedby', wfHostName() );
675 $params = $this->extractRequestParams();
677 $this->mShowVersions
= $params['version'];
678 $this->mAction
= $params['action'];
680 if ( !is_string( $this->mAction
) ) {
681 $this->dieUsage( 'The API requires a valid action parameter', 'unknown_action' );
688 * Set up the module for response
689 * @return ApiBase The module that will handle this action
691 protected function setupModule() {
692 // Instantiate the module requested by the user
693 $module = new $this->mModules
[$this->mAction
] ( $this, $this->mAction
);
694 $this->mModule
= $module;
696 $moduleParams = $module->extractRequestParams();
698 // Die if token required, but not provided (unless there is a gettoken parameter)
699 if ( isset( $moduleParams['gettoken'] ) ) {
700 $gettoken = $moduleParams['gettoken'];
705 $salt = $module->getTokenSalt();
706 if ( $salt !== false && !$gettoken ) {
707 if ( !isset( $moduleParams['token'] ) ) {
708 $this->dieUsageMsg( array( 'missingparam', 'token' ) );
710 if ( !$this->getUser()->matchEditToken( $moduleParams['token'], $salt, $this->getContext()->getRequest() ) ) {
711 $this->dieUsageMsg( 'sessionfailure' );
719 * Check the max lag if necessary
720 * @param $module ApiBase object: Api module being used
721 * @param $params Array an array containing the request parameters.
722 * @return boolean True on success, false should exit immediately
724 protected function checkMaxLag( $module, $params ) {
725 if ( $module->shouldCheckMaxlag() && isset( $params['maxlag'] ) ) {
727 global $wgShowHostnames;
728 $maxLag = $params['maxlag'];
729 list( $host, $lag ) = wfGetLB()->getMaxLag();
730 if ( $lag > $maxLag ) {
731 $response = $this->getRequest()->response();
733 $response->header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
734 $response->header( 'X-Database-Lag: ' . intval( $lag ) );
736 if ( $wgShowHostnames ) {
737 $this->dieUsage( "Waiting for $host: $lag seconds lagged", 'maxlag' );
739 $this->dieUsage( "Waiting for a database server: $lag seconds lagged", 'maxlag' );
748 * Check for sufficient permissions to execute
749 * @param $module ApiBase An Api module
751 protected function checkExecutePermissions( $module ) {
752 $user = $this->getUser();
753 if ( $module->isReadMode() && !in_array( 'read', User
::getGroupPermissions( array( '*' ) ), true ) &&
754 !$user->isAllowed( 'read' ) )
756 $this->dieUsageMsg( 'readrequired' );
758 if ( $module->isWriteMode() ) {
759 if ( !$this->mEnableWrite
) {
760 $this->dieUsageMsg( 'writedisabled' );
762 if ( !$user->isAllowed( 'writeapi' ) ) {
763 $this->dieUsageMsg( 'writerequired' );
765 if ( wfReadOnly() ) {
766 $this->dieReadOnly();
770 // Allow extensions to stop execution for arbitrary reasons.
772 if( !wfRunHooks( 'ApiCheckCanExecute', array( $module, $user, &$message ) ) ) {
773 $this->dieUsageMsg( $message );
778 * Check POST for external response and setup result printer
779 * @param $module ApiBase An Api module
780 * @param $params Array an array with the request parameters
782 protected function setupExternalResponse( $module, $params ) {
783 // Ignore mustBePosted() for internal calls
784 if ( $module->mustBePosted() && !$this->getRequest()->wasPosted() ) {
785 $this->dieUsageMsg( array( 'mustbeposted', $this->mAction
) );
788 // See if custom printer is used
789 $this->mPrinter
= $module->getCustomPrinter();
790 if ( is_null( $this->mPrinter
) ) {
791 // Create an appropriate printer
792 $this->mPrinter
= $this->createPrinterByName( $params['format'] );
795 if ( $this->mPrinter
->getNeedsRawData() ) {
796 $this->getResult()->setRawMode();
801 * Execute the actual module, without any error handling
803 protected function executeAction() {
804 $params = $this->setupExecuteAction();
805 $module = $this->setupModule();
807 $this->checkExecutePermissions( $module );
809 if ( !$this->checkMaxLag( $module, $params ) ) {
813 if ( !$this->mInternalMode
) {
814 $this->setupExternalResponse( $module, $params );
818 $module->profileIn();
820 wfRunHooks( 'APIAfterExecute', array( &$module ) );
821 $module->profileOut();
823 if ( !$this->mInternalMode
) {
824 // Report unused params
825 $this->reportUnusedParams();
827 //append Debug information
828 MWDebug
::appendDebugInfoToApiResult( $this->getContext(), $this->getResult() );
831 $this->printResult( false );
836 * Log the preceding request
837 * @param $time Time in seconds
839 protected function logRequest( $time ) {
840 $request = $this->getRequest();
841 $milliseconds = $time === null ?
'?' : round( $time * 1000 );
843 ' ' . $request->getMethod() .
844 ' ' . wfUrlencode( str_replace( ' ', '_', $this->getUser()->getName() ) ) .
845 ' ' . $request->getIP() .
846 ' T=' . $milliseconds .'ms';
847 foreach ( $this->getParamsUsed() as $name ) {
848 $value = $request->getVal( $name );
849 if ( $value === null ) {
852 $s .= ' ' . $name . '=';
853 if ( strlen( $value ) > 256 ) {
854 $encValue = $this->encodeRequestLogValue( substr( $value, 0, 256 ) );
855 $s .= $encValue . '[...]';
857 $s .= $this->encodeRequestLogValue( $value );
861 wfDebugLog( 'api', $s, false );
865 * Encode a value in a format suitable for a space-separated log line.
867 protected function encodeRequestLogValue( $s ) {
870 $chars = ';@$!*(),/:';
871 for ( $i = 0; $i < strlen( $chars ); $i++
) {
872 $table[ rawurlencode( $chars[$i] ) ] = $chars[$i];
875 return strtr( rawurlencode( $s ), $table );
879 * Get the request parameters used in the course of the preceding execute() request
881 protected function getParamsUsed() {
882 return array_keys( $this->mParamsUsed
);
886 * Get a request value, and register the fact that it was used, for logging.
888 public function getVal( $name, $default = null ) {
889 $this->mParamsUsed
[$name] = true;
890 return $this->getRequest()->getVal( $name, $default );
894 * Get a boolean request value, and register the fact that the parameter
895 * was used, for logging.
897 public function getCheck( $name ) {
898 $this->mParamsUsed
[$name] = true;
899 return $this->getRequest()->getCheck( $name );
903 * Report unused parameters, so the client gets a hint in case it gave us parameters we don't know,
904 * for example in case of spelling mistakes or a missing 'g' prefix for generators.
906 protected function reportUnusedParams() {
907 $paramsUsed = $this->getParamsUsed();
908 $allParams = $this->getRequest()->getValueNames();
910 $unusedParams = array_diff( $allParams, $paramsUsed );
911 if( count( $unusedParams ) ) {
912 $s = count( $unusedParams ) > 1 ?
's' : '';
913 $this->setWarning( "Unrecognized parameter$s: '" . implode( $unusedParams, "', '" ) . "'" );
918 * Print results using the current printer
920 * @param $isError bool
922 protected function printResult( $isError ) {
923 $this->getResult()->cleanUpUTF8();
924 $printer = $this->mPrinter
;
925 $printer->profileIn();
928 * If the help message is requested in the default (xmlfm) format,
929 * tell the printer not to escape ampersands so that our links do
932 $printer->setUnescapeAmps( ( $this->mAction
== 'help' ||
$isError )
933 && $printer->getFormat() == 'XML' && $printer->getIsHtml() );
935 $printer->initPrinter( $isError );
938 $printer->closePrinter();
939 $printer->profileOut();
945 public function isReadMode() {
950 * See ApiBase for description.
954 public function getAllowedParams() {
957 ApiBase
::PARAM_DFLT
=> ApiMain
::API_DEFAULT_FORMAT
,
958 ApiBase
::PARAM_TYPE
=> $this->mFormatNames
961 ApiBase
::PARAM_DFLT
=> 'help',
962 ApiBase
::PARAM_TYPE
=> $this->mModuleNames
966 ApiBase
::PARAM_TYPE
=> 'integer'
969 ApiBase
::PARAM_TYPE
=> 'integer',
970 ApiBase
::PARAM_DFLT
=> 0
973 ApiBase
::PARAM_TYPE
=> 'integer',
974 ApiBase
::PARAM_DFLT
=> 0
983 * See ApiBase for description.
987 public function getParamDescription() {
989 'format' => 'The format of the output',
990 'action' => 'What action you would like to perform. See below for module help',
991 'version' => 'When showing help, include version for each module',
993 'Maximum lag can be used when MediaWiki is installed on a database replicated cluster.',
994 'To save actions causing any more site replication lag, this parameter can make the client',
995 'wait until the replication lag is less than the specified value.',
996 'In case of a replag error, a HTTP 503 error is returned, with the message like',
997 '"Waiting for $host: $lag seconds lagged\n".',
998 'See https://www.mediawiki.org/wiki/Manual:Maxlag_parameter for more information',
1000 'smaxage' => 'Set the s-maxage header to this many seconds. Errors are never cached',
1001 'maxage' => 'Set the max-age header to this many seconds. Errors are never cached',
1002 'requestid' => 'Request ID to distinguish requests. This will just be output back to you',
1003 'servedby' => 'Include the hostname that served the request in the results. Unconditionally shown on error',
1005 'When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain.',
1006 '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 .',
1007 'If this parameter does not match the Origin: header, a 403 response will be returned.',
1008 'If this parameter matches the Origin: header and the origin is whitelisted, an Access-Control-Allow-Origin header will be set.',
1014 * See ApiBase for description.
1018 public function getDescription() {
1022 '**********************************************************************************************************',
1024 '** This is an auto-generated MediaWiki API documentation page **',
1026 '** Documentation and Examples: **',
1027 '** https://www.mediawiki.org/wiki/API **',
1029 '**********************************************************************************************************',
1031 'Status: All features shown on this page should be working, but the API',
1032 ' is still in active development, and may change at any time.',
1033 ' Make sure to monitor our mailing list for any updates',
1035 'Erroneous requests: When erroneous requests are sent to the API, a HTTP header will be sent',
1036 ' with the key "MediaWiki-API-Error" and then both the value of the',
1037 ' header and the error code sent back will be set to the same value',
1039 ' In the case of an invalid action being passed, these will have a value',
1040 ' of "unknown_action"',
1042 ' For more information see https://www.mediawiki.org/wiki/API:Errors_and_warnings',
1044 'Documentation: https://www.mediawiki.org/wiki/API:Main_page',
1045 'FAQ https://www.mediawiki.org/wiki/API:FAQ',
1046 'Mailing list: https://lists.wikimedia.org/mailman/listinfo/mediawiki-api',
1047 'Api Announcements: https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce',
1048 'Bugs & Requests: https://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts',
1060 public function getPossibleErrors() {
1061 return array_merge( parent
::getPossibleErrors(), array(
1062 array( 'readonlytext' ),
1063 array( 'code' => 'unknown_format', 'info' => 'Unrecognized format: format' ),
1064 array( 'code' => 'unknown_action', 'info' => 'The API requires a valid action parameter' ),
1065 array( 'code' => 'maxlag', 'info' => 'Waiting for host: x seconds lagged' ),
1066 array( 'code' => 'maxlag', 'info' => 'Waiting for a database server: x seconds lagged' ),
1071 * Returns an array of strings with credits for the API
1074 protected function getCredits() {
1077 ' Roan Kattouw "<Firstname>.<Lastname>@gmail.com" (lead developer Sep 2007-present)',
1078 ' Victor Vasiliev - vasilvv at gee mail dot com',
1079 ' Bryan Tong Minh - bryan . tongminh @ gmail . com',
1080 ' Sam Reed - sam @ reedyboy . net',
1081 ' Yuri Astrakhan "<Firstname><Lastname>@gmail.com" (creator, lead developer Sep 2006-Sep 2007)',
1083 'Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org',
1084 'or file a bug report at https://bugzilla.wikimedia.org/'
1089 * Sets whether the pretty-printer should format *bold* and $italics$
1093 public function setHelp( $help = true ) {
1094 $this->mPrinter
->setHelp( $help );
1098 * Override the parent to generate help messages for all available modules.
1102 public function makeHelpMsg() {
1103 global $wgMemc, $wgAPICacheHelpTimeout;
1105 // Get help text from cache if present
1106 $key = wfMemcKey( 'apihelp', $this->getModuleName(),
1107 SpecialVersion
::getVersion( 'nodb' ) .
1108 $this->getShowVersions() );
1109 if ( $wgAPICacheHelpTimeout > 0 ) {
1110 $cached = $wgMemc->get( $key );
1115 $retval = $this->reallyMakeHelpMsg();
1116 if ( $wgAPICacheHelpTimeout > 0 ) {
1117 $wgMemc->set( $key, $retval, $wgAPICacheHelpTimeout );
1123 * @return mixed|string
1125 public function reallyMakeHelpMsg() {
1128 // Use parent to make default message for the main module
1129 $msg = parent
::makeHelpMsg();
1131 $astriks = str_repeat( '*** ', 14 );
1132 $msg .= "\n\n$astriks Modules $astriks\n\n";
1133 foreach ( array_keys( $this->mModules
) as $moduleName ) {
1134 $module = new $this->mModules
[$moduleName] ( $this, $moduleName );
1135 $msg .= self
::makeHelpMsgHeader( $module, 'action' );
1136 $msg2 = $module->makeHelpMsg();
1137 if ( $msg2 !== false ) {
1143 $msg .= "\n$astriks Permissions $astriks\n\n";
1144 foreach ( self
::$mRights as $right => $rightMsg ) {
1145 $groups = User
::getGroupsWithPermission( $right );
1146 $msg .= "* " . $right . " *\n " . wfMsgReplaceArgs( $rightMsg[ 'msg' ], $rightMsg[ 'params' ] ) .
1147 "\nGranted to:\n " . str_replace( '*', 'all', implode( ', ', $groups ) ) . "\n\n";
1151 $msg .= "\n$astriks Formats $astriks\n\n";
1152 foreach ( array_keys( $this->mFormats
) as $formatName ) {
1153 $module = $this->createPrinterByName( $formatName );
1154 $msg .= self
::makeHelpMsgHeader( $module, 'format' );
1155 $msg2 = $module->makeHelpMsg();
1156 if ( $msg2 !== false ) {
1162 $msg .= "\n*** Credits: ***\n " . implode( "\n ", $this->getCredits() ) . "\n";
1168 * @param $module ApiBase
1169 * @param $paramName String What type of request is this? e.g. action, query, list, prop, meta, format
1172 public static function makeHelpMsgHeader( $module, $paramName ) {
1173 $modulePrefix = $module->getModulePrefix();
1174 if ( strval( $modulePrefix ) !== '' ) {
1175 $modulePrefix = "($modulePrefix) ";
1178 return "* $paramName={$module->getModuleName()} $modulePrefix*";
1181 private $mCanApiHighLimits = null;
1184 * Check whether the current user is allowed to use high limits
1187 public function canApiHighLimits() {
1188 if ( !isset( $this->mCanApiHighLimits
) ) {
1189 $this->mCanApiHighLimits
= $this->getUser()->isAllowed( 'apihighlimits' );
1192 return $this->mCanApiHighLimits
;
1196 * Check whether the user wants us to show version information in the API help
1199 public function getShowVersions() {
1200 return $this->mShowVersions
;
1204 * Returns the version information of this file, plus it includes
1205 * the versions for all files that are not callable proper API modules
1209 public function getVersion() {
1211 $vers[] = 'MediaWiki: ' . SpecialVersion
::getVersion() . "\n https://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/";
1212 $vers[] = __CLASS__
. ': $Id$';
1213 $vers[] = ApiBase
::getBaseVersion();
1214 $vers[] = ApiFormatBase
::getBaseVersion();
1215 $vers[] = ApiQueryBase
::getBaseVersion();
1220 * Add or overwrite a module in this ApiMain instance. Intended for use by extending
1221 * classes who wish to add their own modules to their lexicon or override the
1222 * behavior of inherent ones.
1224 * @param $mdlName String The identifier for this module.
1225 * @param $mdlClass String The class where this module is implemented.
1227 protected function addModule( $mdlName, $mdlClass ) {
1228 $this->mModules
[$mdlName] = $mdlClass;
1232 * Add or overwrite an output format for this ApiMain. Intended for use by extending
1233 * classes who wish to add to or modify current formatters.
1235 * @param $fmtName string The identifier for this format.
1236 * @param $fmtClass ApiFormatBase The class implementing this format.
1238 protected function addFormat( $fmtName, $fmtClass ) {
1239 $this->mFormats
[$fmtName] = $fmtClass;
1243 * Get the array mapping module names to class names
1246 function getModules() {
1247 return $this->mModules
;
1251 * Returns the list of supported formats in form ( 'format' => 'ClassName' )
1256 public function getFormats() {
1257 return $this->mFormats
;
1262 * This exception will be thrown when dieUsage is called to stop module execution.
1263 * The exception handling code will print a help screen explaining how this API may be used.
1267 class UsageException
extends MWException
{
1274 private $mExtraData;
1277 * @param $message string
1278 * @param $codestr string
1280 * @param $extradata array|null
1282 public function __construct( $message, $codestr, $code = 0, $extradata = null ) {
1283 parent
::__construct( $message, $code );
1284 $this->mCodestr
= $codestr;
1285 $this->mExtraData
= $extradata;
1291 public function getCodeString() {
1292 return $this->mCodestr
;
1298 public function getMessageArray() {
1300 'code' => $this->mCodestr
,
1301 'info' => $this->getMessage()
1303 if ( is_array( $this->mExtraData
) ) {
1304 $result = array_merge( $result, $this->mExtraData
);
1312 public function __toString() {
1313 return "{$this->getCodeString()}: {$this->getMessage()}";