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();
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->getRequest()->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
370 $this->executeAction();
371 } catch ( Exception
$e ) {
372 // Allow extra cleanup and logging
373 wfRunHooks( 'ApiMain::onException', array( $this, $e ) );
376 if ( !( $e instanceof UsageException
) ) {
377 wfDebugLog( 'exception', $e->getLogMessage() );
380 // Handle any kind of exception by outputing properly formatted error message.
381 // If this fails, an unhandled exception should be thrown so that global error
382 // handler will process and log it.
384 $errCode = $this->substituteResultWithError( $e );
386 // Error results should not be cached
387 $this->setCacheMode( 'private' );
389 $response = $this->getRequest()->response();
390 $headerStr = 'MediaWiki-API-Error: ' . $errCode;
391 if ( $e->getCode() === 0 ) {
392 $response->header( $headerStr );
394 $response->header( $headerStr, true, $e->getCode() );
397 // Reset and print just the error message
400 // If the error occurred during printing, do a printer->profileOut()
401 $this->mPrinter
->safeProfileOut();
402 $this->printResult( true );
405 // Send cache headers after any code which might generate an error, to
406 // avoid sending public cache headers for errors.
407 $this->sendCacheHeaders();
409 if ( $this->mPrinter
->getIsHtml() && !$this->mPrinter
->isDisabled() ) {
417 * Check the &origin= query parameter against the Origin: HTTP header and respond appropriately.
419 * If no origin parameter is present, nothing happens.
420 * If an origin parameter is present but doesn't match the Origin header, a 403 status code
421 * is set and false is returned.
422 * If the parameter and the header do match, the header is checked against $wgCrossSiteAJAXdomains
423 * and $wgCrossSiteAJAXdomainExceptions, and if the origin qualifies, the appropriate CORS
426 * @return bool False if the caller should abort (403 case), true otherwise (all other cases)
428 protected function handleCORS() {
429 global $wgCrossSiteAJAXdomains, $wgCrossSiteAJAXdomainExceptions;
431 $originParam = $this->getParameter( 'origin' ); // defaults to null
432 if ( $originParam === null ) {
433 // No origin parameter, nothing to do
437 $request = $this->getRequest();
438 $response = $request->response();
439 // Origin: header is a space-separated list of origins, check all of them
440 $originHeader = $request->getHeader( 'Origin' );
441 if ( $originHeader === false ) {
444 $origins = explode( ' ', $originHeader );
446 if ( !in_array( $originParam, $origins ) ) {
447 // origin parameter set but incorrect
448 // Send a 403 response
449 $message = HttpStatus
::getMessage( 403 );
450 $response->header( "HTTP/1.1 403 $message", true, 403 );
451 $response->header( 'Cache-Control: no-cache' );
452 echo "'origin' parameter does not match Origin header\n";
455 if ( self
::matchOrigin( $originParam, $wgCrossSiteAJAXdomains, $wgCrossSiteAJAXdomainExceptions ) ) {
456 $response->header( "Access-Control-Allow-Origin: $originParam" );
457 $response->header( 'Access-Control-Allow-Credentials: true' );
458 $this->getOutput()->addVaryHeader( 'Origin' );
464 * Attempt to match an Origin header against a set of rules and a set of exceptions
465 * @param $value string Origin header
466 * @param $rules array Set of wildcard rules
467 * @param $exceptions array Set of wildcard rules
468 * @return bool True if $value matches a rule in $rules and doesn't match any rules in $exceptions, false otherwise
470 protected static function matchOrigin( $value, $rules, $exceptions ) {
471 foreach ( $rules as $rule ) {
472 if ( preg_match( self
::wildcardToRegex( $rule ), $value ) ) {
473 // Rule matches, check exceptions
474 foreach ( $exceptions as $exc ) {
475 if ( preg_match( self
::wildcardToRegex( $exc ), $value ) ) {
486 * Helper function to convert wildcard string into a regex
490 * @param $wildcard string String with wildcards
491 * @return string Regular expression
493 protected static function wildcardToRegex( $wildcard ) {
494 $wildcard = preg_quote( $wildcard, '/' );
495 $wildcard = str_replace(
500 return "/https?:\/\/$wildcard/";
503 protected function sendCacheHeaders() {
504 global $wgUseXVO, $wgVaryOnXFP;
505 $response = $this->getRequest()->response();
506 $out = $this->getOutput();
508 if ( $wgVaryOnXFP ) {
509 $out->addVaryHeader( 'X-Forwarded-Proto' );
512 if ( $this->mCacheMode
== 'private' ) {
513 $response->header( 'Cache-Control: private' );
517 if ( $this->mCacheMode
== 'anon-public-user-private' ) {
518 $out->addVaryHeader( 'Cookie' );
519 $response->header( $out->getVaryHeader() );
521 $response->header( $out->getXVO() );
522 if ( $out->haveCacheVaryCookies() ) {
523 // Logged in, mark this request private
524 $response->header( 'Cache-Control: private' );
527 // Logged out, send normal public headers below
528 } elseif ( session_id() != '' ) {
529 // Logged in or otherwise has session (e.g. anonymous users who have edited)
530 // Mark request private
531 $response->header( 'Cache-Control: private' );
533 } // else no XVO and anonymous, send public headers below
536 // Send public headers
537 $response->header( $out->getVaryHeader() );
539 $response->header( $out->getXVO() );
542 // If nobody called setCacheMaxAge(), use the (s)maxage parameters
543 if ( !isset( $this->mCacheControl
['s-maxage'] ) ) {
544 $this->mCacheControl
['s-maxage'] = $this->getParameter( 'smaxage' );
546 if ( !isset( $this->mCacheControl
['max-age'] ) ) {
547 $this->mCacheControl
['max-age'] = $this->getParameter( 'maxage' );
550 if ( !$this->mCacheControl
['s-maxage'] && !$this->mCacheControl
['max-age'] ) {
551 // Public cache not requested
552 // Sending a Vary header in this case is harmless, and protects us
553 // against conditional calls of setCacheMaxAge().
554 $response->header( 'Cache-Control: private' );
558 $this->mCacheControl
['public'] = true;
560 // Send an Expires header
561 $maxAge = min( $this->mCacheControl
['s-maxage'], $this->mCacheControl
['max-age'] );
562 $expiryUnixTime = ( $maxAge == 0 ?
1 : time() +
$maxAge );
563 $response->header( 'Expires: ' . wfTimestamp( TS_RFC2822
, $expiryUnixTime ) );
565 // Construct the Cache-Control header
568 foreach ( $this->mCacheControl
as $name => $value ) {
569 if ( is_bool( $value ) ) {
571 $ccHeader .= $separator . $name;
575 $ccHeader .= $separator . "$name=$value";
580 $response->header( "Cache-Control: $ccHeader" );
584 * Replace the result data with the information about an exception.
585 * Returns the error code
586 * @param $e Exception
589 protected function substituteResultWithError( $e ) {
590 global $wgShowHostnames;
592 $result = $this->getResult();
593 // Printer may not be initialized if the extractRequestParams() fails for the main module
594 if ( !isset ( $this->mPrinter
) ) {
595 // The printer has not been created yet. Try to manually get formatter value.
596 $value = $this->getRequest()->getVal( 'format', self
::API_DEFAULT_FORMAT
);
597 if ( !in_array( $value, $this->mFormatNames
) ) {
598 $value = self
::API_DEFAULT_FORMAT
;
601 $this->mPrinter
= $this->createPrinterByName( $value );
602 if ( $this->mPrinter
->getNeedsRawData() ) {
603 $result->setRawMode();
607 if ( $e instanceof UsageException
) {
608 // User entered incorrect parameters - print usage screen
609 $errMessage = $e->getMessageArray();
611 // Only print the help message when this is for the developer, not runtime
612 if ( $this->mPrinter
->getWantsHelp() ||
$this->mAction
== 'help' ) {
613 ApiResult
::setContent( $errMessage, $this->makeHelpMsg() );
617 global $wgShowSQLErrors, $wgShowExceptionDetails;
618 // Something is seriously wrong
619 if ( ( $e instanceof DBQueryError
) && !$wgShowSQLErrors ) {
620 $info = 'Database query error';
622 $info = "Exception Caught: {$e->getMessage()}";
626 'code' => 'internal_api_error_' . get_class( $e ),
629 ApiResult
::setContent( $errMessage, $wgShowExceptionDetails ?
"\n\n{$e->getTraceAsString()}\n\n" : '' );
633 $result->disableSizeCheck();
635 $requestid = $this->getParameter( 'requestid' );
636 if ( !is_null( $requestid ) ) {
637 $result->addValue( null, 'requestid', $requestid );
640 if ( $wgShowHostnames ) {
641 // servedby is especially useful when debugging errors
642 $result->addValue( null, 'servedby', wfHostName() );
645 $result->addValue( null, 'error', $errMessage );
647 return $errMessage['code'];
651 * Set up for the execution.
654 protected function setupExecuteAction() {
655 global $wgShowHostnames;
657 // First add the id to the top element
658 $result = $this->getResult();
659 $requestid = $this->getParameter( 'requestid' );
660 if ( !is_null( $requestid ) ) {
661 $result->addValue( null, 'requestid', $requestid );
664 if ( $wgShowHostnames ) {
665 $servedby = $this->getParameter( 'servedby' );
667 $result->addValue( null, 'servedby', wfHostName() );
671 $params = $this->extractRequestParams();
673 $this->mShowVersions
= $params['version'];
674 $this->mAction
= $params['action'];
676 if ( !is_string( $this->mAction
) ) {
677 $this->dieUsage( 'The API requires a valid action parameter', 'unknown_action' );
684 * Set up the module for response
685 * @return ApiBase The module that will handle this action
687 protected function setupModule() {
688 // Instantiate the module requested by the user
689 $module = new $this->mModules
[$this->mAction
] ( $this, $this->mAction
);
690 $this->mModule
= $module;
692 $moduleParams = $module->extractRequestParams();
694 // Die if token required, but not provided (unless there is a gettoken parameter)
695 if ( isset( $moduleParams['gettoken'] ) ) {
696 $gettoken = $moduleParams['gettoken'];
701 $salt = $module->getTokenSalt();
702 if ( $salt !== false && !$gettoken ) {
703 if ( !isset( $moduleParams['token'] ) ) {
704 $this->dieUsageMsg( array( 'missingparam', 'token' ) );
706 if ( !$this->getUser()->matchEditToken( $moduleParams['token'], $salt, $this->getContext()->getRequest() ) ) {
707 $this->dieUsageMsg( 'sessionfailure' );
715 * Check the max lag if necessary
716 * @param $module ApiBase object: Api module being used
717 * @param $params Array an array containing the request parameters.
718 * @return boolean True on success, false should exit immediately
720 protected function checkMaxLag( $module, $params ) {
721 if ( $module->shouldCheckMaxlag() && isset( $params['maxlag'] ) ) {
723 global $wgShowHostnames;
724 $maxLag = $params['maxlag'];
725 list( $host, $lag ) = wfGetLB()->getMaxLag();
726 if ( $lag > $maxLag ) {
727 $response = $this->getRequest()->response();
729 $response->header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
730 $response->header( 'X-Database-Lag: ' . intval( $lag ) );
732 if ( $wgShowHostnames ) {
733 $this->dieUsage( "Waiting for $host: $lag seconds lagged", 'maxlag' );
735 $this->dieUsage( "Waiting for a database server: $lag seconds lagged", 'maxlag' );
744 * Check for sufficient permissions to execute
745 * @param $module ApiBase An Api module
747 protected function checkExecutePermissions( $module ) {
748 $user = $this->getUser();
749 if ( $module->isReadMode() && !in_array( 'read', User
::getGroupPermissions( array( '*' ) ), true ) &&
750 !$user->isAllowed( 'read' ) )
752 $this->dieUsageMsg( 'readrequired' );
754 if ( $module->isWriteMode() ) {
755 if ( !$this->mEnableWrite
) {
756 $this->dieUsageMsg( 'writedisabled' );
758 if ( !$user->isAllowed( 'writeapi' ) ) {
759 $this->dieUsageMsg( 'writerequired' );
761 if ( wfReadOnly() ) {
762 $this->dieReadOnly();
766 // Allow extensions to stop execution for arbitrary reasons.
768 if( !wfRunHooks( 'ApiCheckCanExecute', array( $module, $user, &$message ) ) ) {
769 $this->dieUsageMsg( $message );
774 * Check POST for external response and setup result printer
775 * @param $module ApiBase An Api module
776 * @param $params Array an array with the request parameters
778 protected function setupExternalResponse( $module, $params ) {
779 // Ignore mustBePosted() for internal calls
780 if ( $module->mustBePosted() && !$this->getRequest()->wasPosted() ) {
781 $this->dieUsageMsg( array( 'mustbeposted', $this->mAction
) );
784 // See if custom printer is used
785 $this->mPrinter
= $module->getCustomPrinter();
786 if ( is_null( $this->mPrinter
) ) {
787 // Create an appropriate printer
788 $this->mPrinter
= $this->createPrinterByName( $params['format'] );
791 if ( $this->mPrinter
->getNeedsRawData() ) {
792 $this->getResult()->setRawMode();
797 * Execute the actual module, without any error handling
799 protected function executeAction() {
800 $params = $this->setupExecuteAction();
801 $module = $this->setupModule();
803 $this->checkExecutePermissions( $module );
805 if ( !$this->checkMaxLag( $module, $params ) ) {
809 if ( !$this->mInternalMode
) {
810 $this->setupExternalResponse( $module, $params );
814 $module->profileIn();
816 wfRunHooks( 'APIAfterExecute', array( &$module ) );
817 $module->profileOut();
819 if ( !$this->mInternalMode
) {
820 //append Debug information
821 MWDebug
::appendDebugInfoToApiResult( $this->getContext(), $this->getResult() );
824 $this->printResult( false );
829 * Print results using the current printer
831 * @param $isError bool
833 protected function printResult( $isError ) {
834 $this->getResult()->cleanUpUTF8();
835 $printer = $this->mPrinter
;
836 $printer->profileIn();
839 * If the help message is requested in the default (xmlfm) format,
840 * tell the printer not to escape ampersands so that our links do
843 $printer->setUnescapeAmps( ( $this->mAction
== 'help' ||
$isError )
844 && $printer->getFormat() == 'XML' && $printer->getIsHtml() );
846 $printer->initPrinter( $isError );
849 $printer->closePrinter();
850 $printer->profileOut();
856 public function isReadMode() {
861 * See ApiBase for description.
865 public function getAllowedParams() {
868 ApiBase
::PARAM_DFLT
=> ApiMain
::API_DEFAULT_FORMAT
,
869 ApiBase
::PARAM_TYPE
=> $this->mFormatNames
872 ApiBase
::PARAM_DFLT
=> 'help',
873 ApiBase
::PARAM_TYPE
=> $this->mModuleNames
877 ApiBase
::PARAM_TYPE
=> 'integer'
880 ApiBase
::PARAM_TYPE
=> 'integer',
881 ApiBase
::PARAM_DFLT
=> 0
884 ApiBase
::PARAM_TYPE
=> 'integer',
885 ApiBase
::PARAM_DFLT
=> 0
894 * See ApiBase for description.
898 public function getParamDescription() {
900 'format' => 'The format of the output',
901 'action' => 'What action you would like to perform. See below for module help',
902 'version' => 'When showing help, include version for each module',
904 'Maximum lag can be used when MediaWiki is installed on a database replicated cluster.',
905 'To save actions causing any more site replication lag, this parameter can make the client',
906 'wait until the replication lag is less than the specified value.',
907 'In case of a replag error, a HTTP 503 error is returned, with the message like',
908 '"Waiting for $host: $lag seconds lagged\n".',
909 'See https://www.mediawiki.org/wiki/Manual:Maxlag_parameter for more information',
911 'smaxage' => 'Set the s-maxage header to this many seconds. Errors are never cached',
912 'maxage' => 'Set the max-age header to this many seconds. Errors are never cached',
913 'requestid' => 'Request ID to distinguish requests. This will just be output back to you',
914 'servedby' => 'Include the hostname that served the request in the results. Unconditionally shown on error',
916 'When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain.',
917 '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 .',
918 'If this parameter does not match the Origin: header, a 403 response will be returned.',
919 'If this parameter matches the Origin: header and the origin is whitelisted, an Access-Control-Allow-Origin header will be set.',
925 * See ApiBase for description.
929 public function getDescription() {
933 '**********************************************************************************************************',
935 '** This is an auto-generated MediaWiki API documentation page **',
937 '** Documentation and Examples: **',
938 '** https://www.mediawiki.org/wiki/API **',
940 '**********************************************************************************************************',
942 'Status: All features shown on this page should be working, but the API',
943 ' is still in active development, and may change at any time.',
944 ' Make sure to monitor our mailing list for any updates',
946 'Erroneous requests: When erroneous requests are sent to the API, a HTTP header will be sent',
947 ' with the key "MediaWiki-API-Error" and then both the value of the',
948 ' header and the error code sent back will be set to the same value',
950 ' In the case of an invalid action being passed, these will have a value',
951 ' of "unknown_action"',
953 ' For more information see https://www.mediawiki.org/wiki/API:Errors_and_warnings',
955 'Documentation: https://www.mediawiki.org/wiki/API:Main_page',
956 'FAQ https://www.mediawiki.org/wiki/API:FAQ',
957 'Mailing list: https://lists.wikimedia.org/mailman/listinfo/mediawiki-api',
958 'Api Announcements: https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce',
959 'Bugs & Requests: https://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts',
971 public function getPossibleErrors() {
972 return array_merge( parent
::getPossibleErrors(), array(
973 array( 'readonlytext' ),
974 array( 'code' => 'unknown_format', 'info' => 'Unrecognized format: format' ),
975 array( 'code' => 'unknown_action', 'info' => 'The API requires a valid action parameter' ),
976 array( 'code' => 'maxlag', 'info' => 'Waiting for host: x seconds lagged' ),
977 array( 'code' => 'maxlag', 'info' => 'Waiting for a database server: x seconds lagged' ),
982 * Returns an array of strings with credits for the API
985 protected function getCredits() {
988 ' Roan Kattouw "<Firstname>.<Lastname>@gmail.com" (lead developer Sep 2007-present)',
989 ' Victor Vasiliev - vasilvv at gee mail dot com',
990 ' Bryan Tong Minh - bryan . tongminh @ gmail . com',
991 ' Sam Reed - sam @ reedyboy . net',
992 ' Yuri Astrakhan "<Firstname><Lastname>@gmail.com" (creator, lead developer Sep 2006-Sep 2007)',
994 'Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org',
995 'or file a bug report at https://bugzilla.wikimedia.org/'
1000 * Sets whether the pretty-printer should format *bold* and $italics$
1004 public function setHelp( $help = true ) {
1005 $this->mPrinter
->setHelp( $help );
1009 * Override the parent to generate help messages for all available modules.
1013 public function makeHelpMsg() {
1014 global $wgMemc, $wgAPICacheHelpTimeout;
1016 // Get help text from cache if present
1017 $key = wfMemcKey( 'apihelp', $this->getModuleName(),
1018 SpecialVersion
::getVersion( 'nodb' ) .
1019 $this->getShowVersions() );
1020 if ( $wgAPICacheHelpTimeout > 0 ) {
1021 $cached = $wgMemc->get( $key );
1026 $retval = $this->reallyMakeHelpMsg();
1027 if ( $wgAPICacheHelpTimeout > 0 ) {
1028 $wgMemc->set( $key, $retval, $wgAPICacheHelpTimeout );
1034 * @return mixed|string
1036 public function reallyMakeHelpMsg() {
1039 // Use parent to make default message for the main module
1040 $msg = parent
::makeHelpMsg();
1042 $astriks = str_repeat( '*** ', 14 );
1043 $msg .= "\n\n$astriks Modules $astriks\n\n";
1044 foreach ( array_keys( $this->mModules
) as $moduleName ) {
1045 $module = new $this->mModules
[$moduleName] ( $this, $moduleName );
1046 $msg .= self
::makeHelpMsgHeader( $module, 'action' );
1047 $msg2 = $module->makeHelpMsg();
1048 if ( $msg2 !== false ) {
1054 $msg .= "\n$astriks Permissions $astriks\n\n";
1055 foreach ( self
::$mRights as $right => $rightMsg ) {
1056 $groups = User
::getGroupsWithPermission( $right );
1057 $msg .= "* " . $right . " *\n " . wfMsgReplaceArgs( $rightMsg[ 'msg' ], $rightMsg[ 'params' ] ) .
1058 "\nGranted to:\n " . str_replace( '*', 'all', implode( ', ', $groups ) ) . "\n\n";
1062 $msg .= "\n$astriks Formats $astriks\n\n";
1063 foreach ( array_keys( $this->mFormats
) as $formatName ) {
1064 $module = $this->createPrinterByName( $formatName );
1065 $msg .= self
::makeHelpMsgHeader( $module, 'format' );
1066 $msg2 = $module->makeHelpMsg();
1067 if ( $msg2 !== false ) {
1073 $msg .= "\n*** Credits: ***\n " . implode( "\n ", $this->getCredits() ) . "\n";
1079 * @param $module ApiBase
1080 * @param $paramName String What type of request is this? e.g. action, query, list, prop, meta, format
1083 public static function makeHelpMsgHeader( $module, $paramName ) {
1084 $modulePrefix = $module->getModulePrefix();
1085 if ( strval( $modulePrefix ) !== '' ) {
1086 $modulePrefix = "($modulePrefix) ";
1089 return "* $paramName={$module->getModuleName()} $modulePrefix*";
1092 private $mCanApiHighLimits = null;
1095 * Check whether the current user is allowed to use high limits
1098 public function canApiHighLimits() {
1099 if ( !isset( $this->mCanApiHighLimits
) ) {
1100 $this->mCanApiHighLimits
= $this->getUser()->isAllowed( 'apihighlimits' );
1103 return $this->mCanApiHighLimits
;
1107 * Check whether the user wants us to show version information in the API help
1110 public function getShowVersions() {
1111 return $this->mShowVersions
;
1115 * Returns the version information of this file, plus it includes
1116 * the versions for all files that are not callable proper API modules
1120 public function getVersion() {
1122 $vers[] = 'MediaWiki: ' . SpecialVersion
::getVersion() . "\n https://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/";
1123 $vers[] = __CLASS__
. ': $Id$';
1124 $vers[] = ApiBase
::getBaseVersion();
1125 $vers[] = ApiFormatBase
::getBaseVersion();
1126 $vers[] = ApiQueryBase
::getBaseVersion();
1131 * Add or overwrite a module in this ApiMain instance. Intended for use by extending
1132 * classes who wish to add their own modules to their lexicon or override the
1133 * behavior of inherent ones.
1135 * @param $mdlName String The identifier for this module.
1136 * @param $mdlClass String The class where this module is implemented.
1138 protected function addModule( $mdlName, $mdlClass ) {
1139 $this->mModules
[$mdlName] = $mdlClass;
1143 * Add or overwrite an output format for this ApiMain. Intended for use by extending
1144 * classes who wish to add to or modify current formatters.
1146 * @param $fmtName string The identifier for this format.
1147 * @param $fmtClass ApiFormatBase The class implementing this format.
1149 protected function addFormat( $fmtName, $fmtClass ) {
1150 $this->mFormats
[$fmtName] = $fmtClass;
1154 * Get the array mapping module names to class names
1157 function getModules() {
1158 return $this->mModules
;
1162 * Returns the list of supported formats in form ( 'format' => 'ClassName' )
1167 public function getFormats() {
1168 return $this->mFormats
;
1173 * This exception will be thrown when dieUsage is called to stop module execution.
1174 * The exception handling code will print a help screen explaining how this API may be used.
1178 class UsageException
extends MWException
{
1185 private $mExtraData;
1188 * @param $message string
1189 * @param $codestr string
1191 * @param $extradata array|null
1193 public function __construct( $message, $codestr, $code = 0, $extradata = null ) {
1194 parent
::__construct( $message, $code );
1195 $this->mCodestr
= $codestr;
1196 $this->mExtraData
= $extradata;
1202 public function getCodeString() {
1203 return $this->mCodestr
;
1209 public function getMessageArray() {
1211 'code' => $this->mCodestr
,
1212 'info' => $this->getMessage()
1214 if ( is_array( $this->mExtraData
) ) {
1215 $result = array_merge( $result, $this->mExtraData
);
1223 public function __toString() {
1224 return "{$this->getCodeString()}: {$this->getMessage()}";