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 'edit' => 'ApiEditPage',
78 * List of available formats: format name => format class
80 private static $Formats = array (
81 'json' => 'ApiFormatJson',
82 'jsonfm' => 'ApiFormatJson',
83 'php' => 'ApiFormatPhp',
84 'phpfm' => 'ApiFormatPhp',
85 'wddx' => 'ApiFormatWddx',
86 'wddxfm' => 'ApiFormatWddx',
87 'xml' => 'ApiFormatXml',
88 'xmlfm' => 'ApiFormatXml',
89 'yaml' => 'ApiFormatYaml',
90 'yamlfm' => 'ApiFormatYaml',
91 'rawfm' => 'ApiFormatJson',
92 'txt' => 'ApiFormatTxt',
93 'txtfm' => 'ApiFormatTxt',
94 'dbg' => 'ApiFormatDbg',
95 'dbgfm' => 'ApiFormatDbg'
98 private $mPrinter, $mModules, $mModuleNames, $mFormats, $mFormatNames, $mCommit;
99 private $mResult, $mAction, $mShowVersions, $mEnableWrite, $mRequest, $mInternalMode, $mSquidMaxage;
102 * Constructs an instance of ApiMain that utilizes the module and format specified by $request.
104 * @param $request object - if this is an instance of FauxRequest, errors are thrown and no printing occurs
105 * @param $enableWrite bool should be set to true if the api may modify data
107 public function __construct($request, $enableWrite = false) {
109 $this->mInternalMode
= ($request instanceof FauxRequest
);
111 // Special handling for the main module: $parent === $this
112 parent
:: __construct($this, $this->mInternalMode ?
'main_int' : 'main');
114 if (!$this->mInternalMode
) {
116 // Impose module restrictions.
117 // If the current user cannot read,
118 // Remove all modules other than login
121 if( $request->getVal( 'callback' ) !== null ) {
122 // JSON callback allows cross-site reads.
123 // For safety, strip user credentials.
124 wfDebug( "API: stripping user credentials for JSON callback\n" );
125 $wgUser = new User();
128 if (!$wgUser->isAllowed('read')) {
129 self
::$Modules = array(
130 'login' => self
::$Modules['login'],
131 'logout' => self
::$Modules['logout'],
132 'help' => self
::$Modules['help'],
137 global $wgAPIModules, $wgEnableWriteAPI; // extension modules
138 $this->mModules
= $wgAPIModules + self
:: $Modules;
139 if($wgEnableWriteAPI)
140 $this->mModules +
= self
::$WriteModules;
142 $this->mModuleNames
= array_keys($this->mModules
); // todo: optimize
143 $this->mFormats
= self
:: $Formats;
144 $this->mFormatNames
= array_keys($this->mFormats
); // todo: optimize
146 $this->mResult
= new ApiResult($this);
147 $this->mShowVersions
= false;
148 $this->mEnableWrite
= $enableWrite;
150 $this->mRequest
= & $request;
152 $this->mSquidMaxage
= 0;
153 $this->mCommit
= false;
157 * Return true if the API was started by other PHP code using FauxRequest
159 public function isInternalMode() {
160 return $this->mInternalMode
;
164 * Return the request object that contains client's request
166 public function getRequest() {
167 return $this->mRequest
;
171 * Get the ApiResult object asscosiated with current request
173 public function getResult() {
174 return $this->mResult
;
178 * This method will simply cause an error if the write mode was disabled for this api.
180 public function requestWriteMode() {
181 if (!$this->mEnableWrite
)
182 $this->dieUsage('Editing of this site is disabled. Make sure the $wgEnableWriteAPI=true; ' .
183 'statement is included in the site\'s LocalSettings.php file', 'noapiwrite');
187 * Set how long the response should be cached.
189 public function setCacheMaxAge($maxage) {
190 $this->mSquidMaxage
= $maxage;
194 * Create an instance of an output formatter by its name
196 public function createPrinterByName($format) {
197 return new $this->mFormats
[$format] ($this, $format);
201 * Schedule a database commit
203 public function scheduleCommit() {
204 $this->mCommit
= true;
208 * Execute api request. Any errors will be handled if the API was called by the remote client.
210 public function execute() {
212 if ($this->mInternalMode
)
213 $this->executeAction();
215 $this->executeActionWithErrorHandling();
218 $dbw = wfGetDb(DB_MASTER
);
219 $dbw->immediateCommit();
225 * Execute an action, and in case of an error, erase whatever partial results
226 * have been accumulated, and replace it with an error message and a help screen.
228 protected function executeActionWithErrorHandling() {
230 // In case an error occurs during data output,
231 // clear the output buffer and print just the error information
235 $this->executeAction();
236 } catch (Exception
$e) {
238 // Handle any kind of exception by outputing properly formatted error message.
239 // If this fails, an unhandled exception should be thrown so that global error
240 // handler will process and log it.
243 $errCode = $this->substituteResultWithError($e);
245 // Error results should not be cached
246 $this->setCacheMaxAge(0);
248 $headerStr = 'MediaWiki-API-Error: ' . $errCode;
249 if ($e->getCode() === 0)
250 header($headerStr, true);
252 header($headerStr, true, $e->getCode());
254 // Reset and print just the error message
257 // If the error occured during printing, do a printer->profileOut()
258 $this->mPrinter
->safeProfileOut();
259 $this->printResult(true);
262 // Set the cache expiration at the last moment, as any errors may change the expiration.
263 // if $this->mSquidMaxage == 0, the expiry time is set to the first second of unix epoch
264 $expires = $this->mSquidMaxage
== 0 ?
1 : time() +
$this->mSquidMaxage
;
265 header('Expires: ' . wfTimestamp(TS_RFC2822
, $expires));
266 header('Cache-Control: s-maxage=' . $this->mSquidMaxage
. ', must-revalidate, max-age=0');
268 if($this->mPrinter
->getIsHtml())
275 * Replace the result data with the information about an exception.
276 * Returns the error code
278 protected function substituteResultWithError($e) {
280 // Printer may not be initialized if the extractRequestParams() fails for the main module
281 if (!isset ($this->mPrinter
)) {
282 // The printer has not been created yet. Try to manually get formatter value.
283 $value = $this->getRequest()->getVal('format', self
::API_DEFAULT_FORMAT
);
284 if (!in_array($value, $this->mFormatNames
))
285 $value = self
::API_DEFAULT_FORMAT
;
287 $this->mPrinter
= $this->createPrinterByName($value);
288 if ($this->mPrinter
->getNeedsRawData())
289 $this->getResult()->setRawMode();
292 if ($e instanceof UsageException
) {
294 // User entered incorrect parameters - print usage screen
296 $errMessage = array (
297 'code' => $e->getCodeString(),
298 'info' => $e->getMessage());
300 // Only print the help message when this is for the developer, not runtime
301 if ($this->mPrinter
->getIsHtml() ||
$this->mAction
== 'help')
302 ApiResult
:: setContent($errMessage, $this->makeHelpMsg());
306 // Something is seriously wrong
308 $errMessage = array (
309 'code' => 'internal_api_error_'. get_class($e),
310 'info' => "Exception Caught: {$e->getMessage()}"
312 ApiResult
:: setContent($errMessage, "\n\n{$e->getTraceAsString()}\n\n");
315 $this->getResult()->reset();
316 $this->getResult()->addValue(null, 'error', $errMessage);
318 return $errMessage['code'];
322 * Execute the actual module, without any error handling
324 protected function executeAction() {
326 $params = $this->extractRequestParams();
328 $this->mShowVersions
= $params['version'];
329 $this->mAction
= $params['action'];
331 // Instantiate the module requested by the user
332 $module = new $this->mModules
[$this->mAction
] ($this, $this->mAction
);
334 if( $module->shouldCheckMaxlag() && isset( $params['maxlag'] ) ) {
336 global $wgShowHostnames;
337 $maxLag = $params['maxlag'];
338 list( $host, $lag ) = wfGetLB()->getMaxLag();
339 if ( $lag > $maxLag ) {
340 if( $wgShowHostnames ) {
341 ApiBase
:: dieUsage( "Waiting for $host: $lag seconds lagged", 'maxlag' );
343 ApiBase
:: dieUsage( "Waiting for a database server: $lag seconds lagged", 'maxlag' );
349 if (!$this->mInternalMode
) {
350 // Ignore mustBePosted() for internal calls
351 if($module->mustBePosted() && !$this->mRequest
->wasPosted())
352 $this->dieUsage("The {$this->mAction} module requires a POST request", 'mustbeposted');
354 // See if custom printer is used
355 $this->mPrinter
= $module->getCustomPrinter();
356 if (is_null($this->mPrinter
)) {
357 // Create an appropriate printer
358 $this->mPrinter
= $this->createPrinterByName($params['format']);
361 if ($this->mPrinter
->getNeedsRawData())
362 $this->getResult()->setRawMode();
366 $module->profileIn();
368 $module->profileOut();
370 if (!$this->mInternalMode
) {
372 $this->printResult(false);
377 * Print results using the current printer
379 protected function printResult($isError) {
380 $printer = $this->mPrinter
;
381 $printer->profileIn();
383 /* If the help message is requested in the default (xmlfm) format,
384 * tell the printer not to escape ampersands so that our links do
386 $printer->setUnescapeAmps ( ( $this->mAction
== 'help' ||
$isError )
387 && $this->getParameter('format') == ApiMain
::API_DEFAULT_FORMAT
);
389 $printer->initPrinter($isError);
392 $printer->closePrinter();
393 $printer->profileOut();
397 * See ApiBase for description.
399 public function getAllowedParams() {
402 ApiBase
:: PARAM_DFLT
=> ApiMain
:: API_DEFAULT_FORMAT
,
403 ApiBase
:: PARAM_TYPE
=> $this->mFormatNames
406 ApiBase
:: PARAM_DFLT
=> 'help',
407 ApiBase
:: PARAM_TYPE
=> $this->mModuleNames
411 ApiBase
:: PARAM_TYPE
=> 'integer'
417 * See ApiBase for description.
419 public function getParamDescription() {
421 'format' => 'The format of the output',
422 'action' => 'What action you would like to perform',
423 'version' => 'When showing help, include version for each module',
424 'maxlag' => 'Maximum lag'
429 * See ApiBase for description.
431 public function getDescription() {
435 '******************************************************************',
437 '** This is an auto-generated MediaWiki API documentation page **',
439 '** Documentation and Examples: **',
440 '** http://www.mediawiki.org/wiki/API **',
442 '******************************************************************',
444 'Status: All features shown on this page should be working, but the API',
445 ' is still in active development, and may change at any time.',
446 ' Make sure to monitor our mailing list for any updates.',
448 'Documentation: http://www.mediawiki.org/wiki/API',
449 'Mailing list: http://lists.wikimedia.org/mailman/listinfo/mediawiki-api',
450 'Bugs & Requests: http://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts',
460 * Returns an array of strings with credits for the API
462 protected function getCredits() {
465 ' Roan Kattouw <Firstname>.<Lastname>@home.nl (lead developer Sep 2007-present)',
466 ' Victor Vasiliev - vasilvv at gee mail dot com',
467 ' Yuri Astrakhan <Firstname><Lastname>@gmail.com (creator, lead developer Sep 2006-Sep 2007)',
469 'Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org',
470 'or file a bug report at http://bugzilla.wikimedia.org/'
475 * Override the parent to generate help messages for all available modules.
477 public function makeHelpMsg() {
479 $this->mPrinter
->setHelp();
481 // Use parent to make default message for the main module
482 $msg = parent
:: makeHelpMsg();
484 $astriks = str_repeat('*** ', 10);
485 $msg .= "\n\n$astriks Modules $astriks\n\n";
486 foreach( $this->mModules
as $moduleName => $unused ) {
487 $module = new $this->mModules
[$moduleName] ($this, $moduleName);
488 $msg .= self
::makeHelpMsgHeader($module, 'action');
489 $msg2 = $module->makeHelpMsg();
495 $msg .= "\n$astriks Formats $astriks\n\n";
496 foreach( $this->mFormats
as $formatName => $unused ) {
497 $module = $this->createPrinterByName($formatName);
498 $msg .= self
::makeHelpMsgHeader($module, 'format');
499 $msg2 = $module->makeHelpMsg();
505 $msg .= "\n*** Credits: ***\n " . implode("\n ", $this->getCredits()) . "\n";
511 public static function makeHelpMsgHeader($module, $paramName) {
512 $modulePrefix = $module->getModulePrefix();
513 if (!empty($modulePrefix))
514 $modulePrefix = "($modulePrefix) ";
516 return "* $paramName={$module->getModuleName()} $modulePrefix*";
519 private $mIsBot = null;
520 private $mIsSysop = null;
521 private $mCanApiHighLimits = null;
524 * Returns true if the currently logged in user is a bot, false otherwise
525 * OBSOLETE, use canApiHighLimits() instead
527 public function isBot() {
528 if (!isset ($this->mIsBot
)) {
530 $this->mIsBot
= $wgUser->isAllowed('bot');
532 return $this->mIsBot
;
536 * Similar to isBot(), this method returns true if the logged in user is
537 * a sysop, and false if not.
538 * OBSOLETE, use canApiHighLimits() instead
540 public function isSysop() {
541 if (!isset ($this->mIsSysop
)) {
543 $this->mIsSysop
= in_array( 'sysop', $wgUser->getGroups());
546 return $this->mIsSysop
;
550 * Check whether the current user is allowed to use high limits
553 public function canApiHighLimits() {
554 if (!isset($this->mCanApiHighLimits
)) {
556 $this->mCanApiHighLimits
= $wgUser->isAllowed('apihighlimits');
559 return $this->mCanApiHighLimits
;
563 * Check whether the user wants us to show version information in the API help
566 public function getShowVersions() {
567 return $this->mShowVersions
;
571 * Returns the version information of this file, plus it includes
572 * the versions for all files that are not callable proper API modules
574 public function getVersion() {
576 $vers[] = 'MediaWiki ' . SpecialVersion
::getVersion();
577 $vers[] = __CLASS__
. ': $Id$';
578 $vers[] = ApiBase
:: getBaseVersion();
579 $vers[] = ApiFormatBase
:: getBaseVersion();
580 $vers[] = ApiQueryBase
:: getBaseVersion();
581 $vers[] = ApiFormatFeedWrapper
:: getVersion(); // not accessible with format=xxx
586 * Add or overwrite a module in this ApiMain instance. Intended for use by extending
587 * classes who wish to add their own modules to their lexicon or override the
588 * behavior of inherent ones.
591 * @param $mdlName String The identifier for this module.
592 * @param $mdlClass String The class where this module is implemented.
594 protected function addModule( $mdlName, $mdlClass ) {
595 $this->mModules
[$mdlName] = $mdlClass;
599 * Add or overwrite an output format for this ApiMain. Intended for use by extending
600 * classes who wish to add to or modify current formatters.
603 * @param $fmtName The identifier for this format.
604 * @param $fmtClass The class implementing this format.
606 protected function addFormat( $fmtName, $fmtClass ) {
607 $this->mFormats
[$fmtName] = $fmtClass;
611 * Get the array mapping module names to class names
613 function getModules() {
614 return $this->mModules
;
619 * This exception will be thrown when dieUsage is called to stop module execution.
620 * The exception handling code will print a help screen explaining how this API may be used.
624 class UsageException
extends Exception
{
628 public function __construct($message, $codestr, $code = 0) {
629 parent
:: __construct($message, $code);
630 $this->mCodestr
= $codestr;
632 public function getCodeString() {
633 return $this->mCodestr
;
635 public function __toString() {
636 return "{$this->getCodeString()}: {$this->getMessage()}";