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');
32 * This is the main API class, used for both external and internal processing.
33 * When executed, it will create the requested formatter object,
34 * instantiate and execute an object associated with the needed action,
35 * and use formatter to print results.
36 * In case of an exception, an error message will be printed using the same formatter.
38 * To use API from another application, run it using FauxRequest object, in which
39 * case any internal exceptions will not be handled but passed up to the caller.
40 * After successful execution, use getResult() for the resulting data.
44 class ApiMain
extends ApiBase
{
47 * When no format parameter is given, this format will be used
49 const API_DEFAULT_FORMAT
= 'xmlfm';
52 * List of available modules: action name => module class
54 private static $Modules = array (
55 'login' => 'ApiLogin',
56 'logout' => 'ApiLogout',
57 'query' => 'ApiQuery',
58 'expandtemplates' => 'ApiExpandTemplates',
59 'parse' => 'ApiParse',
60 'opensearch' => 'ApiOpenSearch',
61 'feedwatchlist' => 'ApiFeedWatchlist',
63 'paraminfo' => 'ApiParamInfo',
66 private static $WriteModules = array (
67 'rollback' => 'ApiRollback',
68 'delete' => 'ApiDelete',
69 'undelete' => 'ApiUndelete',
70 'protect' => 'ApiProtect',
71 'block' => 'ApiBlock',
72 'unblock' => 'ApiUnblock',
74 #'changerights' => 'ApiChangeRights'
79 * List of available formats: format name => format class
81 private static $Formats = array (
82 'json' => 'ApiFormatJson',
83 'jsonfm' => 'ApiFormatJson',
84 'php' => 'ApiFormatPhp',
85 'phpfm' => 'ApiFormatPhp',
86 'wddx' => 'ApiFormatWddx',
87 'wddxfm' => 'ApiFormatWddx',
88 'xml' => 'ApiFormatXml',
89 'xmlfm' => 'ApiFormatXml',
90 'yaml' => 'ApiFormatYaml',
91 'yamlfm' => 'ApiFormatYaml',
92 'rawfm' => 'ApiFormatJson',
93 'txt' => 'ApiFormatTxt',
94 'txtfm' => 'ApiFormatTxt',
95 'dbg' => 'ApiFormatDbg',
96 'dbgfm' => 'ApiFormatDbg'
99 private $mPrinter, $mModules, $mModuleNames, $mFormats, $mFormatNames;
100 private $mResult, $mAction, $mShowVersions, $mEnableWrite, $mRequest, $mInternalMode, $mSquidMaxage;
103 * Constructs an instance of ApiMain that utilizes the module and format specified by $request.
105 * @param $request object - if this is an instance of FauxRequest, errors are thrown and no printing occurs
106 * @param $enableWrite bool should be set to true if the api may modify data
108 public function __construct($request, $enableWrite = false) {
110 $this->mInternalMode
= ($request instanceof FauxRequest
);
112 // Special handling for the main module: $parent === $this
113 parent
:: __construct($this, $this->mInternalMode ?
'main_int' : 'main');
115 if (!$this->mInternalMode
) {
117 // Impose module restrictions.
118 // If the current user cannot read,
119 // Remove all modules other than login
121 if (!$wgUser->isAllowed('read')) {
122 self
::$Modules = array(
123 'login' => self
::$Modules['login'],
124 'logout' => self
::$Modules['logout'],
125 'help' => self
::$Modules['help'],
130 global $wgAPIModules, $wgEnableWriteAPI; // extension modules
131 $this->mModules
= $wgAPIModules + self
:: $Modules;
132 if($wgEnableWriteAPI)
133 $this->mModules +
= self
::$WriteModules;
135 $this->mModuleNames
= array_keys($this->mModules
); // todo: optimize
136 $this->mFormats
= self
:: $Formats;
137 $this->mFormatNames
= array_keys($this->mFormats
); // todo: optimize
139 $this->mResult
= new ApiResult($this);
140 $this->mShowVersions
= false;
141 $this->mEnableWrite
= $enableWrite;
143 $this->mRequest
= & $request;
145 $this->mSquidMaxage
= 0;
149 * Return true if the API was started by other PHP code using FauxRequest
151 public function isInternalMode() {
152 return $this->mInternalMode
;
156 * Return the request object that contains client's request
158 public function getRequest() {
159 return $this->mRequest
;
163 * Get the ApiResult object asscosiated with current request
165 public function getResult() {
166 return $this->mResult
;
170 * This method will simply cause an error if the write mode was disabled for this api.
172 public function requestWriteMode() {
173 if (!$this->mEnableWrite
)
174 $this->dieUsage('Editing of this site is disabled. Make sure the $wgEnableWriteAPI=true; ' .
175 'statement is included in the site\'s LocalSettings.php file', 'noapiwrite');
179 * Set how long the response should be cached.
181 public function setCacheMaxAge($maxage) {
182 $this->mSquidMaxage
= $maxage;
186 * Create an instance of an output formatter by its name
188 public function createPrinterByName($format) {
189 return new $this->mFormats
[$format] ($this, $format);
193 * Execute api request. Any errors will be handled if the API was called by the remote client.
195 public function execute() {
197 if ($this->mInternalMode
)
198 $this->executeAction();
200 $this->executeActionWithErrorHandling();
205 * Execute an action, and in case of an error, erase whatever partial results
206 * have been accumulated, and replace it with an error message and a help screen.
208 protected function executeActionWithErrorHandling() {
210 // In case an error occurs during data output,
211 // clear the output buffer and print just the error information
215 $this->executeAction();
216 } catch (Exception
$e) {
218 // Handle any kind of exception by outputing properly formatted error message.
219 // If this fails, an unhandled exception should be thrown so that global error
220 // handler will process and log it.
223 $errCode = $this->substituteResultWithError($e);
225 // Error results should not be cached
226 $this->setCacheMaxAge(0);
228 $headerStr = 'MediaWiki-API-Error: ' . $errCode;
229 if ($e->getCode() === 0)
230 header($headerStr, true);
232 header($headerStr, true, $e->getCode());
234 // Reset and print just the error message
237 // If the error occured during printing, do a printer->profileOut()
238 $this->mPrinter
->safeProfileOut();
239 $this->printResult(true);
242 // Set the cache expiration at the last moment, as any errors may change the expiration.
243 // if $this->mSquidMaxage == 0, the expiry time is set to the first second of unix epoch
244 $expires = $this->mSquidMaxage
== 0 ?
1 : time() +
$this->mSquidMaxage
;
245 header('Expires: ' . wfTimestamp(TS_RFC2822
, $expires));
246 header('Cache-Control: s-maxage=' . $this->mSquidMaxage
. ', must-revalidate, max-age=0');
248 if($this->mPrinter
->getIsHtml())
255 * Replace the result data with the information about an exception.
256 * Returns the error code
258 protected function substituteResultWithError($e) {
260 // Printer may not be initialized if the extractRequestParams() fails for the main module
261 if (!isset ($this->mPrinter
)) {
262 // The printer has not been created yet. Try to manually get formatter value.
263 $value = $this->getRequest()->getVal('format', self
::API_DEFAULT_FORMAT
);
264 if (!in_array($value, $this->mFormatNames
))
265 $value = self
::API_DEFAULT_FORMAT
;
267 $this->mPrinter
= $this->createPrinterByName($value);
268 if ($this->mPrinter
->getNeedsRawData())
269 $this->getResult()->setRawMode();
272 if ($e instanceof UsageException
) {
274 // User entered incorrect parameters - print usage screen
276 $errMessage = array (
277 'code' => $e->getCodeString(),
278 'info' => $e->getMessage());
280 // Only print the help message when this is for the developer, not runtime
281 if ($this->mPrinter
->getIsHtml() ||
$this->mAction
== 'help')
282 ApiResult
:: setContent($errMessage, $this->makeHelpMsg());
286 // Something is seriously wrong
288 $errMessage = array (
289 'code' => 'internal_api_error_'. get_class($e),
290 'info' => "Exception Caught: {$e->getMessage()}"
292 ApiResult
:: setContent($errMessage, "\n\n{$e->getTraceAsString()}\n\n");
295 $this->getResult()->reset();
296 $this->getResult()->addValue(null, 'error', $errMessage);
298 return $errMessage['code'];
302 * Execute the actual module, without any error handling
304 protected function executeAction() {
306 $params = $this->extractRequestParams();
308 $this->mShowVersions
= $params['version'];
309 $this->mAction
= $params['action'];
311 // Instantiate the module requested by the user
312 $module = new $this->mModules
[$this->mAction
] ($this, $this->mAction
);
314 if( $module->shouldCheckMaxlag() && isset( $params['maxlag'] ) ) {
316 global $wgLoadBalancer, $wgShowHostnames;
317 $maxLag = $params['maxlag'];
318 list( $host, $lag ) = $wgLoadBalancer->getMaxLag();
319 if ( $lag > $maxLag ) {
320 if( $wgShowHostnames ) {
321 ApiBase
:: dieUsage( "Waiting for $host: $lag seconds lagged", 'maxlag' );
323 ApiBase
:: dieUsage( "Waiting for a database server: $lag seconds lagged", 'maxlag' );
329 if (!$this->mInternalMode
) {
330 // Ignore mustBePosted() for internal calls
331 if($module->mustBePosted() && !$this->mRequest
->wasPosted())
332 $this->dieUsage("The {$this->mAction} module requires a POST request", 'mustbeposted');
334 // See if custom printer is used
335 $this->mPrinter
= $module->getCustomPrinter();
336 if (is_null($this->mPrinter
)) {
337 // Create an appropriate printer
338 $this->mPrinter
= $this->createPrinterByName($params['format']);
341 if ($this->mPrinter
->getNeedsRawData())
342 $this->getResult()->setRawMode();
346 $module->profileIn();
348 $module->profileOut();
350 if (!$this->mInternalMode
) {
352 $this->printResult(false);
357 * Print results using the current printer
359 protected function printResult($isError) {
360 $printer = $this->mPrinter
;
361 $printer->profileIn();
363 /* If the help message is requested in the default (xmlfm) format,
364 * tell the printer not to escape ampersands so that our links do
366 $params = $this->extractRequestParams();
367 $printer->setUnescapeAmps ( ( $this->mAction
== 'help' ||
$isError )
368 && $params['format'] == ApiMain
::API_DEFAULT_FORMAT
);
370 $printer->initPrinter($isError);
373 $printer->closePrinter();
374 $printer->profileOut();
378 * See ApiBase for description.
380 public function getAllowedParams() {
383 ApiBase
:: PARAM_DFLT
=> ApiMain
:: API_DEFAULT_FORMAT
,
384 ApiBase
:: PARAM_TYPE
=> $this->mFormatNames
387 ApiBase
:: PARAM_DFLT
=> 'help',
388 ApiBase
:: PARAM_TYPE
=> $this->mModuleNames
392 ApiBase
:: PARAM_TYPE
=> 'integer'
398 * See ApiBase for description.
400 public function getParamDescription() {
402 'format' => 'The format of the output',
403 'action' => 'What action you would like to perform',
404 'version' => 'When showing help, include version for each module',
405 'maxlag' => 'Maximum lag'
410 * See ApiBase for description.
412 public function getDescription() {
416 '******************************************************************',
418 '** This is an auto-generated MediaWiki API documentation page **',
420 '** Documentation and Examples: **',
421 '** http://www.mediawiki.org/wiki/API **',
423 '******************************************************************',
425 'Status: All features shown on this page should be working, but the API',
426 ' is still in active development, and may change at any time.',
427 ' Make sure to monitor our mailing list for any updates.',
429 'Documentation: http://www.mediawiki.org/wiki/API',
430 'Mailing list: http://lists.wikimedia.org/mailman/listinfo/mediawiki-api',
431 'Bugs & Requests: http://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts',
441 * Returns an array of strings with credits for the API
443 protected function getCredits() {
445 'This API is being implemented by Roan Kattouw <Firstname>.<Lastname>@home.nl',
446 'Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org',
447 'or file a bug report at http://bugzilla.wikimedia.org/'
452 * Override the parent to generate help messages for all available modules.
454 public function makeHelpMsg() {
456 $this->mPrinter
->setHelp();
458 // Use parent to make default message for the main module
459 $msg = parent
:: makeHelpMsg();
461 $astriks = str_repeat('*** ', 10);
462 $msg .= "\n\n$astriks Modules $astriks\n\n";
463 foreach( $this->mModules
as $moduleName => $unused ) {
464 $module = new $this->mModules
[$moduleName] ($this, $moduleName);
465 $msg .= self
::makeHelpMsgHeader($module, 'action');
466 $msg2 = $module->makeHelpMsg();
472 $msg .= "\n$astriks Formats $astriks\n\n";
473 foreach( $this->mFormats
as $formatName => $unused ) {
474 $module = $this->createPrinterByName($formatName);
475 $msg .= self
::makeHelpMsgHeader($module, 'format');
476 $msg2 = $module->makeHelpMsg();
482 $msg .= "\n*** Credits: ***\n " . implode("\n ", $this->getCredits()) . "\n";
488 public static function makeHelpMsgHeader($module, $paramName) {
489 $modulePrefix = $module->getModulePrefix();
490 if (!empty($modulePrefix))
491 $modulePrefix = "($modulePrefix) ";
493 return "* $paramName={$module->getModuleName()} $modulePrefix*";
496 private $mIsBot = null;
497 private $mIsSysop = null;
498 private $mCanApiHighLimits = null;
501 * Returns true if the currently logged in user is a bot, false otherwise
502 * OBSOLETE, use canApiHighLimits() instead
504 public function isBot() {
505 if (!isset ($this->mIsBot
)) {
507 $this->mIsBot
= $wgUser->isAllowed('bot');
509 return $this->mIsBot
;
513 * Similar to isBot(), this method returns true if the logged in user is
514 * a sysop, and false if not.
515 * OBSOLETE, use canApiHighLimits() instead
517 public function isSysop() {
518 if (!isset ($this->mIsSysop
)) {
520 $this->mIsSysop
= in_array( 'sysop', $wgUser->getGroups());
523 return $this->mIsSysop
;
526 public function canApiHighLimits() {
527 if (!isset($this->mCanApiHighLimits
)) {
529 $this->mCanApiHighLimits
= $wgUser->isAllowed('apihighlimits');
532 return $this->mCanApiHighLimits
;
535 public function getShowVersions() {
536 return $this->mShowVersions
;
540 * Returns the version information of this file, plus it includes
541 * the versions for all files that are not callable proper API modules
543 public function getVersion() {
545 $vers[] = 'MediaWiki ' . SpecialVersion
::getVersion();
546 $vers[] = __CLASS__
. ': $Id$';
547 $vers[] = ApiBase
:: getBaseVersion();
548 $vers[] = ApiFormatBase
:: getBaseVersion();
549 $vers[] = ApiQueryBase
:: getBaseVersion();
550 $vers[] = ApiFormatFeedWrapper
:: getVersion(); // not accessible with format=xxx
555 * Add or overwrite a module in this ApiMain instance. Intended for use by extending
556 * classes who wish to add their own modules to their lexicon or override the
557 * behavior of inherent ones.
560 * @param $mdlName String The identifier for this module.
561 * @param $mdlClass String The class where this module is implemented.
563 protected function addModule( $mdlName, $mdlClass ) {
564 $this->mModules
[$mdlName] = $mdlClass;
568 * Add or overwrite an output format for this ApiMain. Intended for use by extending
569 * classes who wish to add to or modify current formatters.
572 * @param $fmtName The identifier for this format.
573 * @param $fmtClass The class implementing this format.
575 protected function addFormat( $fmtName, $fmtClass ) {
576 $this->mFormats
[$fmtName] = $fmtClass;
580 * Get the array mapping module names to class names
582 function getModules() {
583 return $this->mModules
;
588 * This exception will be thrown when dieUsage is called to stop module execution.
589 * The exception handling code will print a help screen explaining how this API may be used.
593 class UsageException
extends Exception
{
597 public function __construct($message, $codestr, $code = 0) {
598 parent
:: __construct($message, $code);
599 $this->mCodestr
= $codestr;
601 public function getCodeString() {
602 return $this->mCodestr
;
604 public function __toString() {
605 return "{$this->getCodeString()}: {$this->getMessage()}";