4 * Created on Sep 4, 2006
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ('ApiBase.php');
36 * This is the main API class, used for both external and internal processing.
37 * When executed, it will create the requested formatter object,
38 * instantiate and execute an object associated with the needed action,
39 * and use formatter to print results.
40 * In case of an exception, an error message will be printed using the same formatter.
42 * To use API from another application, run it using FauxRequest object, in which
43 * case any internal exceptions will not be handled but passed up to the caller.
44 * After successful execution, use getResult() for the resulting data.
48 class ApiMain
extends ApiBase
{
51 * When no format parameter is given, this format will be used
53 const API_DEFAULT_FORMAT
= 'xmlfm';
56 * List of available modules: action name => module class
58 private static $Modules = array (
59 'login' => 'ApiLogin',
60 'logout' => 'ApiLogout',
61 'query' => 'ApiQuery',
62 'expandtemplates' => 'ApiExpandTemplates',
63 'parse' => 'ApiParse',
64 'opensearch' => 'ApiOpenSearch',
65 'feedwatchlist' => 'ApiFeedWatchlist',
67 'paraminfo' => 'ApiParamInfo',
70 'purge' => 'ApiPurge',
71 'rollback' => 'ApiRollback',
72 'delete' => 'ApiDelete',
73 'undelete' => 'ApiUndelete',
74 'protect' => 'ApiProtect',
75 'block' => 'ApiBlock',
76 'unblock' => 'ApiUnblock',
78 'edit' => 'ApiEditPage',
79 'upload' => 'ApiUpload',
80 'emailuser' => 'ApiEmailUser',
81 'watch' => 'ApiWatch',
82 'patrol' => 'ApiPatrol',
83 'import' => 'ApiImport',
84 'userrights' => 'ApiUserrights',
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'
109 * List of user roles that are specifically relevant to the API.
110 * array( 'right' => array ( 'msg' => 'Some message with a $1',
111 * 'params' => array ( $someVarToSubst ) ),
114 private static $mRights = array('writeapi' => array(
115 'msg' => 'Use of the write API',
118 'apihighlimits' => array(
119 '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.',
120 'params' => array (ApiMain
::LIMIT_SML2
, ApiMain
::LIMIT_BIG2
)
125 private $mPrinter, $mModules, $mModuleNames, $mFormats, $mFormatNames;
126 private $mResult, $mAction, $mShowVersions, $mEnableWrite, $mRequest;
127 private $mInternalMode, $mSquidMaxage, $mModule;
130 * Constructs an instance of ApiMain that utilizes the module and format specified by $request.
132 * @param $request object - if this is an instance of FauxRequest, errors are thrown and no printing occurs
133 * @param $enableWrite bool should be set to true if the api may modify data
135 public function __construct($request, $enableWrite = false) {
137 $this->mInternalMode
= ($request instanceof FauxRequest
);
139 // Special handling for the main module: $parent === $this
140 parent
:: __construct($this, $this->mInternalMode ?
'main_int' : 'main');
142 if (!$this->mInternalMode
) {
144 // Impose module restrictions.
145 // If the current user cannot read,
146 // Remove all modules other than login
149 if( $request->getVal( 'callback' ) !== null ) {
150 // JSON callback allows cross-site reads.
151 // For safety, strip user credentials.
152 wfDebug( "API: stripping user credentials for JSON callback\n" );
153 $wgUser = new User();
157 global $wgAPIModules; // extension modules
158 $this->mModules
= $wgAPIModules + self
:: $Modules;
160 $this->mModuleNames
= array_keys($this->mModules
);
161 $this->mFormats
= self
:: $Formats;
162 $this->mFormatNames
= array_keys($this->mFormats
);
164 $this->mResult
= new ApiResult($this);
165 $this->mShowVersions
= false;
166 $this->mEnableWrite
= $enableWrite;
168 $this->mRequest
= & $request;
170 $this->mSquidMaxage
= -1; // flag for executeActionWithErrorHandling()
171 $this->mCommit
= false;
175 * Return true if the API was started by other PHP code using FauxRequest
177 public function isInternalMode() {
178 return $this->mInternalMode
;
182 * Return the request object that contains client's request
184 public function getRequest() {
185 return $this->mRequest
;
189 * Get the ApiResult object asscosiated with current request
191 public function getResult() {
192 return $this->mResult
;
196 * Get the API module object. Only works after executeAction()
198 public function getModule() {
199 return $this->mModule
;
203 * Only kept for backwards compatibility
204 * @deprecated Use isWriteMode() instead
206 public function requestWriteMode() {}
209 * Set how long the response should be cached.
211 public function setCacheMaxAge($maxage) {
212 $this->mSquidMaxage
= $maxage;
216 * Create an instance of an output formatter by its name
218 public function createPrinterByName($format) {
219 if( !isset( $this->mFormats
[$format] ) )
220 $this->dieUsage( "Unrecognized format: {$format}", 'unknown_format' );
221 return new $this->mFormats
[$format] ($this, $format);
225 * Execute api request. Any errors will be handled if the API was called by the remote client.
227 public function execute() {
229 if ($this->mInternalMode
)
230 $this->executeAction();
232 $this->executeActionWithErrorHandling();
238 * Execute an action, and in case of an error, erase whatever partial results
239 * have been accumulated, and replace it with an error message and a help screen.
241 protected function executeActionWithErrorHandling() {
243 // In case an error occurs during data output,
244 // clear the output buffer and print just the error information
248 $this->executeAction();
249 } catch (Exception
$e) {
251 if ( $e instanceof MWException
) {
252 wfDebugLog( 'exception', $e->getLogMessage() );
256 // Handle any kind of exception by outputing properly formatted error message.
257 // If this fails, an unhandled exception should be thrown so that global error
258 // handler will process and log it.
261 $errCode = $this->substituteResultWithError($e);
263 // Error results should not be cached
264 $this->setCacheMaxAge(0);
266 $headerStr = 'MediaWiki-API-Error: ' . $errCode;
267 if ($e->getCode() === 0)
270 header($headerStr, true, $e->getCode());
272 // Reset and print just the error message
275 // If the error occured during printing, do a printer->profileOut()
276 $this->mPrinter
->safeProfileOut();
277 $this->printResult(true);
280 if($this->mSquidMaxage
== -1)
282 # Nobody called setCacheMaxAge(), use the (s)maxage parameters
283 $smaxage = $this->getParameter('smaxage');
284 $maxage = $this->getParameter('maxage');
287 $smaxage = $maxage = $this->mSquidMaxage
;
289 // Set the cache expiration at the last moment, as any errors may change the expiration.
290 // if $this->mSquidMaxage == 0, the expiry time is set to the first second of unix epoch
291 $exp = min($smaxage, $maxage);
292 $expires = ($exp == 0 ?
1 : time() +
$exp);
293 header('Expires: ' . wfTimestamp(TS_RFC2822
, $expires));
294 header('Cache-Control: s-maxage=' . $smaxage . ', must-revalidate, max-age=' . $maxage);
296 if($this->mPrinter
->getIsHtml())
303 * Replace the result data with the information about an exception.
304 * Returns the error code
306 protected function substituteResultWithError($e) {
308 // Printer may not be initialized if the extractRequestParams() fails for the main module
309 if (!isset ($this->mPrinter
)) {
310 // The printer has not been created yet. Try to manually get formatter value.
311 $value = $this->getRequest()->getVal('format', self
::API_DEFAULT_FORMAT
);
312 if (!in_array($value, $this->mFormatNames
))
313 $value = self
::API_DEFAULT_FORMAT
;
315 $this->mPrinter
= $this->createPrinterByName($value);
316 if ($this->mPrinter
->getNeedsRawData())
317 $this->getResult()->setRawMode();
320 if ($e instanceof UsageException
) {
322 // User entered incorrect parameters - print usage screen
324 $errMessage = $e->getMessageArray();
326 // Only print the help message when this is for the developer, not runtime
327 if ($this->mPrinter
->getWantsHelp() ||
$this->mAction
== 'help')
328 ApiResult
:: setContent($errMessage, $this->makeHelpMsg());
331 global $wgShowSQLErrors, $wgShowExceptionDetails;
333 // Something is seriously wrong
335 if ( ( $e instanceof DBQueryError
) && !$wgShowSQLErrors ) {
336 $info = "Database query error";
338 $info = "Exception Caught: {$e->getMessage()}";
341 $errMessage = array (
342 'code' => 'internal_api_error_'. get_class($e),
345 ApiResult
:: setContent($errMessage, $wgShowExceptionDetails ?
"\n\n{$e->getTraceAsString()}\n\n" : "" );
348 $this->getResult()->reset();
349 $this->getResult()->disableSizeCheck();
351 $requestid = $this->getParameter('requestid');
352 if(!is_null($requestid))
353 $this->getResult()->addValue(null, 'requestid', $requestid);
354 $this->getResult()->addValue(null, 'error', $errMessage);
356 return $errMessage['code'];
360 * Execute the actual module, without any error handling
362 protected function executeAction() {
363 // First add the id to the top element
364 $requestid = $this->getParameter('requestid');
365 if(!is_null($requestid))
366 $this->getResult()->addValue(null, 'requestid', $requestid);
368 $params = $this->extractRequestParams();
370 $this->mShowVersions
= $params['version'];
371 $this->mAction
= $params['action'];
373 if( !is_string( $this->mAction
) ) {
374 $this->dieUsage( "The API requires a valid action parameter", 'unknown_action' );
377 // Instantiate the module requested by the user
378 $module = new $this->mModules
[$this->mAction
] ($this, $this->mAction
);
379 $this->mModule
= $module;
381 if( $module->shouldCheckMaxlag() && isset( $params['maxlag'] ) ) {
383 global $wgShowHostnames;
384 $maxLag = $params['maxlag'];
385 list( $host, $lag ) = wfGetLB()->getMaxLag();
386 if ( $lag > $maxLag ) {
387 header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
388 header( 'X-Database-Lag: ' . intval( $lag ) );
389 if( $wgShowHostnames ) {
390 $this->dieUsage( "Waiting for $host: $lag seconds lagged", 'maxlag' );
392 $this->dieUsage( "Waiting for a database server: $lag seconds lagged", 'maxlag' );
399 if ($module->isReadMode() && !$wgUser->isAllowed('read'))
400 $this->dieUsageMsg(array('readrequired'));
401 if ($module->isWriteMode()) {
402 if (!$this->mEnableWrite
)
403 $this->dieUsageMsg(array('writedisabled'));
404 if (!$wgUser->isAllowed('writeapi'))
405 $this->dieUsageMsg(array('writerequired'));
407 $this->dieReadOnly();
410 if (!$this->mInternalMode
) {
411 // Ignore mustBePosted() for internal calls
412 if($module->mustBePosted() && !$this->mRequest
->wasPosted())
413 $this->dieUsage("The {$this->mAction} module requires a POST request", 'mustbeposted');
415 // See if custom printer is used
416 $this->mPrinter
= $module->getCustomPrinter();
417 if (is_null($this->mPrinter
)) {
418 // Create an appropriate printer
419 $this->mPrinter
= $this->createPrinterByName($params['format']);
422 if ($this->mPrinter
->getNeedsRawData())
423 $this->getResult()->setRawMode();
427 $module->profileIn();
429 wfRunHooks('APIAfterExecute', array(&$module));
430 $module->profileOut();
432 if (!$this->mInternalMode
) {
434 $this->printResult(false);
439 * Print results using the current printer
441 protected function printResult($isError) {
442 $this->getResult()->cleanUpUTF8();
443 $printer = $this->mPrinter
;
444 $printer->profileIn();
446 /* If the help message is requested in the default (xmlfm) format,
447 * tell the printer not to escape ampersands so that our links do
449 $printer->setUnescapeAmps ( ( $this->mAction
== 'help' ||
$isError )
450 && $printer->getFormat() == 'XML' && $printer->getIsHtml() );
452 $printer->initPrinter($isError);
455 $printer->closePrinter();
456 $printer->profileOut();
459 public function isReadMode() {
464 * See ApiBase for description.
466 public function getAllowedParams() {
469 ApiBase
:: PARAM_DFLT
=> ApiMain
:: API_DEFAULT_FORMAT
,
470 ApiBase
:: PARAM_TYPE
=> $this->mFormatNames
473 ApiBase
:: PARAM_DFLT
=> 'help',
474 ApiBase
:: PARAM_TYPE
=> $this->mModuleNames
478 ApiBase
:: PARAM_TYPE
=> 'integer'
481 ApiBase
:: PARAM_TYPE
=> 'integer',
482 ApiBase
:: PARAM_DFLT
=> 0
485 ApiBase
:: PARAM_TYPE
=> 'integer',
486 ApiBase
:: PARAM_DFLT
=> 0
493 * See ApiBase for description.
495 public function getParamDescription() {
497 'format' => 'The format of the output',
498 'action' => 'What action you would like to perform',
499 'version' => 'When showing help, include version for each module',
500 'maxlag' => 'Maximum lag',
501 'smaxage' => 'Set the s-maxage header to this many seconds. Errors are never cached',
502 'maxage' => 'Set the max-age header to this many seconds. Errors are never cached',
503 'requestid' => 'Request ID to distinguish requests. This will just be output back to you',
508 * See ApiBase for description.
510 public function getDescription() {
514 '******************************************************************',
516 '** This is an auto-generated MediaWiki API documentation page **',
518 '** Documentation and Examples: **',
519 '** http://www.mediawiki.org/wiki/API **',
521 '******************************************************************',
523 'Status: All features shown on this page should be working, but the API',
524 ' is still in active development, and may change at any time.',
525 ' Make sure to monitor our mailing list for any updates.',
527 'Documentation: http://www.mediawiki.org/wiki/API',
528 'Mailing list: http://lists.wikimedia.org/mailman/listinfo/mediawiki-api',
529 'Bugs & Requests: http://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts',
539 * Returns an array of strings with credits for the API
541 protected function getCredits() {
544 ' Roan Kattouw <Firstname>.<Lastname>@home.nl (lead developer Sep 2007-present)',
545 ' Victor Vasiliev - vasilvv at gee mail dot com',
546 ' Bryan Tong Minh - bryan . tongminh @ gmail . com',
547 ' Yuri Astrakhan <Firstname><Lastname>@gmail.com (creator, lead developer Sep 2006-Sep 2007)',
549 'Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org',
550 'or file a bug report at http://bugzilla.wikimedia.org/'
555 * Override the parent to generate help messages for all available modules.
557 public function makeHelpMsg() {
559 $this->mPrinter
->setHelp();
560 // Get help text from cache if present
561 $key = wfMemcKey( 'apihelp', $this->getModuleName() );
562 $cached = $wgMemc->get( $key );
565 $retval = $this->reallyMakeHelpMsg();
566 $wgMemc->set( $key, $retval, 60*60 );
570 public function reallyMakeHelpMsg() {
572 $this->mPrinter
->setHelp();
574 // Use parent to make default message for the main module
575 $msg = parent
:: makeHelpMsg();
577 $astriks = str_repeat('*** ', 10);
578 $msg .= "\n\n$astriks Modules $astriks\n\n";
579 foreach( $this->mModules
as $moduleName => $unused ) {
580 $module = new $this->mModules
[$moduleName] ($this, $moduleName);
581 $msg .= self
::makeHelpMsgHeader($module, 'action');
582 $msg2 = $module->makeHelpMsg();
588 $msg .= "\n$astriks Permissions $astriks\n\n";
589 foreach ( self
:: $mRights as $right => $rightMsg ) {
590 $groups = User
::getGroupsWithPermission( $right );
591 $msg .= "* " . $right . " *\n " . wfMsgReplaceArgs( $rightMsg[ 'msg' ], $rightMsg[ 'params' ] ) .
592 "\nGranted to:\n " . str_replace( "*", "all", implode( ", ", $groups ) ) . "\n";
596 $msg .= "\n$astriks Formats $astriks\n\n";
597 foreach( $this->mFormats
as $formatName => $unused ) {
598 $module = $this->createPrinterByName($formatName);
599 $msg .= self
::makeHelpMsgHeader($module, 'format');
600 $msg2 = $module->makeHelpMsg();
606 $msg .= "\n*** Credits: ***\n " . implode("\n ", $this->getCredits()) . "\n";
612 public static function makeHelpMsgHeader($module, $paramName) {
613 $modulePrefix = $module->getModulePrefix();
614 if (strval($modulePrefix) !== '')
615 $modulePrefix = "($modulePrefix) ";
617 return "* $paramName={$module->getModuleName()} $modulePrefix*";
620 private $mIsBot = null;
621 private $mIsSysop = null;
622 private $mCanApiHighLimits = null;
625 * Returns true if the currently logged in user is a bot, false otherwise
626 * OBSOLETE, use canApiHighLimits() instead
628 public function isBot() {
629 if (!isset ($this->mIsBot
)) {
631 $this->mIsBot
= $wgUser->isAllowed('bot');
633 return $this->mIsBot
;
637 * Similar to isBot(), this method returns true if the logged in user is
638 * a sysop, and false if not.
639 * OBSOLETE, use canApiHighLimits() instead
641 public function isSysop() {
642 if (!isset ($this->mIsSysop
)) {
644 $this->mIsSysop
= in_array( 'sysop', $wgUser->getGroups());
647 return $this->mIsSysop
;
651 * Check whether the current user is allowed to use high limits
654 public function canApiHighLimits() {
655 if (!isset($this->mCanApiHighLimits
)) {
657 $this->mCanApiHighLimits
= $wgUser->isAllowed('apihighlimits');
660 return $this->mCanApiHighLimits
;
664 * Check whether the user wants us to show version information in the API help
667 public function getShowVersions() {
668 return $this->mShowVersions
;
672 * Returns the version information of this file, plus it includes
673 * the versions for all files that are not callable proper API modules
675 public function getVersion() {
677 $vers[] = 'MediaWiki: ' . SpecialVersion
::getVersion() . "\n http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/";
678 $vers[] = __CLASS__
. ': $Id$';
679 $vers[] = ApiBase
:: getBaseVersion();
680 $vers[] = ApiFormatBase
:: getBaseVersion();
681 $vers[] = ApiQueryBase
:: getBaseVersion();
686 * Add or overwrite a module in this ApiMain instance. Intended for use by extending
687 * classes who wish to add their own modules to their lexicon or override the
688 * behavior of inherent ones.
691 * @param $mdlName String The identifier for this module.
692 * @param $mdlClass String The class where this module is implemented.
694 protected function addModule( $mdlName, $mdlClass ) {
695 $this->mModules
[$mdlName] = $mdlClass;
699 * Add or overwrite an output format for this ApiMain. Intended for use by extending
700 * classes who wish to add to or modify current formatters.
703 * @param $fmtName The identifier for this format.
704 * @param $fmtClass The class implementing this format.
706 protected function addFormat( $fmtName, $fmtClass ) {
707 $this->mFormats
[$fmtName] = $fmtClass;
711 * Get the array mapping module names to class names
713 function getModules() {
714 return $this->mModules
;
719 * This exception will be thrown when dieUsage is called to stop module execution.
720 * The exception handling code will print a help screen explaining how this API may be used.
724 class UsageException
extends Exception
{
729 public function __construct($message, $codestr, $code = 0, $extradata = null) {
730 parent
:: __construct($message, $code);
731 $this->mCodestr
= $codestr;
732 $this->mExtraData
= $extradata;
734 public function getCodeString() {
735 return $this->mCodestr
;
737 public function getMessageArray() {
739 'code' => $this->mCodestr
,
740 'info' => $this->getMessage()
742 if ( is_array( $this->mExtraData
) )
743 $result = array_merge( $result, $this->mExtraData
);
746 public function __toString() {
747 return "{$this->getCodeString()}: {$this->getMessage()}";