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 'query' => 'ApiQuery',
57 'opensearch' => 'ApiOpenSearch',
58 'feedwatchlist' => 'ApiFeedWatchlist',
63 * List of available formats: format name => format class
65 private static $Formats = array (
66 'json' => 'ApiFormatJson',
67 'jsonfm' => 'ApiFormatJson',
68 'php' => 'ApiFormatPhp',
69 'phpfm' => 'ApiFormatPhp',
70 'wddx' => 'ApiFormatWddx',
71 'wddxfm' => 'ApiFormatWddx',
72 'xml' => 'ApiFormatXml',
73 'xmlfm' => 'ApiFormatXml',
74 'yaml' => 'ApiFormatYaml',
75 'yamlfm' => 'ApiFormatYaml',
76 'rawfm' => 'ApiFormatJson'
79 private $mPrinter, $mModules, $mModuleNames, $mFormats, $mFormatNames;
80 private $mResult, $mAction, $mShowVersions, $mEnableWrite, $mRequest, $mInternalMode, $mSquidMaxage;
83 * Constructs an instance of ApiMain that utilizes the module and format specified by $request.
85 * @param $request object - if this is an instance of FauxRequest, errors are thrown and no printing occurs
86 * @param $enableWrite bool should be set to true if the api may modify data
88 public function __construct($request, $enableWrite = false) {
90 $this->mInternalMode = ($request instanceof FauxRequest);
92 // Special handling for the main module: $parent === $this
93 parent :: __construct($this, $this->mInternalMode ? 'main_int' : 'main');
95 if (!$this->mInternalMode) {
97 // Impose module restrictions.
98 // If the current user cannot read,
99 // Remove all modules other than login
101 if (!$wgUser->isAllowed('read')) {
102 self::$Modules = array(
103 'login' => self::$Modules['login'],
104 'help' => self::$Modules['help']
109 global $wgAPIModules; // extension modules
110 $this->mModules = $wgAPIModules + self :: $Modules;
112 $this->mModuleNames = array_keys($this->mModules); // todo: optimize
113 $this->mFormats = self :: $Formats;
114 $this->mFormatNames = array_keys($this->mFormats); // todo: optimize
116 $this->mResult = new ApiResult($this);
117 $this->mShowVersions = false;
118 $this->mEnableWrite = $enableWrite;
120 $this->mRequest = & $request;
122 $this->mSquidMaxage = 0;
126 * Return true if the API was started by other PHP code using FauxRequest
128 public function isInternalMode() {
129 return $this->mInternalMode;
133 * Return the request object that contains client's request
135 public function getRequest() {
136 return $this->mRequest;
140 * Get the ApiResult object asscosiated with current request
142 public function getResult() {
143 return $this->mResult;
147 * This method will simply cause an error if the write mode was disabled for this api.
149 public function requestWriteMode() {
150 if (!$this->mEnableWrite)
151 $this->dieUsage('Editing of this site is disabled. Make sure the $wgEnableWriteAPI=true; ' .
152 'statement is included in the site\'s LocalSettings.php file', 'readonly');
156 * Set how long the response should be cached.
158 public function setCacheMaxAge($maxage) {
159 $this->mSquidMaxage = $maxage;
163 * Create an instance of an output formatter by its name
165 public function createPrinterByName($format) {
166 return new $this->mFormats[$format] ($this, $format);
170 * Execute api request. Any errors will be handled if the API was called by the remote client.
172 public function execute() {
174 if ($this->mInternalMode)
175 $this->executeAction();
177 $this->executeActionWithErrorHandling();
182 * Execute an action, and in case of an error, erase whatever partial results
183 * have been accumulated, and replace it with an error message and a help screen.
185 protected function executeActionWithErrorHandling() {
187 // In case an error occurs during data output,
188 // clear the output buffer and print just the error information
192 $this->executeAction();
193 } catch (Exception $e) {
195 // Handle any kind of exception by outputing properly formatted error message.
196 // If this fails, an unhandled exception should be thrown so that global error
197 // handler will process and log it.
200 $errCode = $this->substituteResultWithError($e);
202 // Error results should not be cached
203 $this->setCacheMaxAge(0);
205 $headerStr = 'MediaWiki-API-Error: ' . $errCode;
206 if ($e->getCode() === 0)
207 header($headerStr, true);
209 header($headerStr, true, $e->getCode());
211 // Reset and print just the error message
214 // If the error occured during printing, do a printer->profileOut()
215 $this->mPrinter->safeProfileOut();
216 $this->printResult(true);
219 // Set the cache expiration at the last moment, as any errors may change the expiration.
220 // if $this->mSquidMaxage == 0, the expiry time is set to the first second of unix epoch
221 $expires = $this->mSquidMaxage == 0 ? 1 : time() + $this->mSquidMaxage;
222 header('Expires: ' . wfTimestamp(TS_RFC2822, $expires));
223 header('Cache-Control: s-maxage=' . $this->mSquidMaxage . ', must-revalidate, max-age=0');
225 if($this->mPrinter->getIsHtml())
232 * Replace the result data with the information about an exception.
233 * Returns the error code
235 protected function substituteResultWithError($e) {
237 // Printer may not be initialized if the extractRequestParams() fails for the main module
238 if (!isset ($this->mPrinter)) {
239 // The printer has not been created yet. Try to manually get formatter value.
240 $value = $this->getRequest()->getVal('format', self::API_DEFAULT_FORMAT);
241 if (!in_array($value, $this->mFormatNames))
242 $value = self::API_DEFAULT_FORMAT;
244 $this->mPrinter = $this->createPrinterByName($value);
245 if ($this->mPrinter->getNeedsRawData())
246 $this->getResult()->setRawMode();
249 if ($e instanceof UsageException) {
251 // User entered incorrect parameters - print usage screen
253 $errMessage = array (
254 'code' => $e->getCodeString(),
255 'info' => $e->getMessage());
257 // Only print the help message when this is for the developer, not runtime
258 if ($this->mPrinter->getIsHtml() || $this->mAction == 'help')
259 ApiResult :: setContent($errMessage, $this->makeHelpMsg());
263 // Something is seriously wrong
265 $errMessage = array (
266 'code' => 'internal_api_error',
267 'info' => "Exception Caught: {$e->getMessage()}"
269 ApiResult :: setContent($errMessage, "\n\n{$e->getTraceAsString()}\n\n");
272 $this->getResult()->reset();
273 $this->getResult()->addValue(null, 'error', $errMessage);
275 return $errMessage['code'];
279 * Execute the actual module, without any error handling
281 protected function executeAction() {
283 $params = $this->extractRequestParams();
285 $this->mShowVersions = $params['version'];
286 $this->mAction = $params['action'];
288 // Instantiate the module requested by the user
289 $module = new $this->mModules[$this->mAction] ($this, $this->mAction);
291 if (!$this->mInternalMode) {
293 // See if custom printer is used
294 $this->mPrinter = $module->getCustomPrinter();
295 if (is_null($this->mPrinter)) {
296 // Create an appropriate printer
297 $this->mPrinter = $this->createPrinterByName($params['format']);
300 if ($this->mPrinter->getNeedsRawData())
301 $this->getResult()->setRawMode();
305 $module->profileIn();
307 $module->profileOut();
309 if (!$this->mInternalMode) {
311 $this->printResult(false);
316 * Print results using the current printer
318 protected function printResult($isError) {
319 $printer = $this->mPrinter;
320 $printer->profileIn();
321 $printer->initPrinter($isError);
323 $printer->closePrinter();
324 $printer->profileOut();
328 * See ApiBase for description.
330 protected function getAllowedParams() {
333 ApiBase :: PARAM_DFLT => ApiMain :: API_DEFAULT_FORMAT,
334 ApiBase :: PARAM_TYPE => $this->mFormatNames
337 ApiBase :: PARAM_DFLT => 'help',
338 ApiBase :: PARAM_TYPE => $this->mModuleNames
345 * See ApiBase for description.
347 protected function getParamDescription() {
349 'format' => 'The format of the output',
350 'action' => 'What action you would like to perform',
351 'version' => 'When showing help, include version for each module'
356 * See ApiBase for description.
358 protected function getDescription() {
362 '******************************************************************',
364 '** This is an auto-generated MediaWiki API documentation page **',
366 '** Documentation and Examples: **',
367 '** http://www.mediawiki.org/wiki/API **',
369 '******************************************************************',
371 'Status: All features shown on this page should be working, but the API',
372 ' is still in active development, and may change at any time.',
373 ' Make sure to monitor our mailing list for any updates.',
375 'Documentation: http://www.mediawiki.org/wiki/API',
376 'Mailing list: http://lists.wikimedia.org/mailman/listinfo/mediawiki-api',
377 'Bugs & Requests: http://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts',
387 * Returns an array of strings with credits for the API
389 protected function getCredits() {
391 'This API is being implemented by Yuri Astrakhan [[User:Yurik]] / <Firstname><Lastname>@gmail.com',
392 'Please leave your comments and suggestions at http://www.mediawiki.org/wiki/API'
397 * Override the parent to generate help messages for all available modules.
399 public function makeHelpMsg() {
401 // Use parent to make default message for the main module
402 $msg = parent :: makeHelpMsg();
404 $astriks = str_repeat('*** ', 10);
405 $msg .= "\n\n$astriks Modules $astriks\n\n";
406 foreach( $this->mModules as $moduleName => $unused ) {
407 $module = new $this->mModules[$moduleName] ($this, $moduleName);
408 $msg .= self::makeHelpMsgHeader($module, 'action');
409 $msg2 = $module->makeHelpMsg();
415 $msg .= "\n$astriks Formats $astriks\n\n";
416 foreach( $this->mFormats as $formatName => $unused ) {
417 $module = $this->createPrinterByName($formatName);
418 $msg .= self::makeHelpMsgHeader($module, 'format');
419 $msg2 = $module->makeHelpMsg();
425 $msg .= "\n*** Credits: ***\n " . implode("\n ", $this->getCredits()) . "\n";
431 public static function makeHelpMsgHeader($module, $paramName) {
432 $modulePrefix = $module->getModulePrefix();
433 if (!empty($modulePrefix))
434 $modulePrefix = "($modulePrefix) ";
436 return "* $paramName={$module->getModuleName()} $modulePrefix*";
439 private $mIsBot = null;
441 private $mIsSysop = null;
444 * Returns true if the currently logged in user is a bot, false otherwise
446 public function isBot() {
447 if (!isset ($this->mIsBot)) {
449 $this->mIsBot = $wgUser->isAllowed('bot');
451 return $this->mIsBot;
455 * Similar to isBot(), this method returns true if the logged in user is
456 * a sysop, and false if not.
458 public function isSysop() {
459 if (!isset ($this->mIsSysop)) {
461 $this->mIsSysop = in_array( 'sysop', $wgUser->getGroups());
464 return $this->mIsSysop;
467 public function getShowVersions() {
468 return $this->mShowVersions;
472 * Returns the version information of this file, plus it includes
473 * the versions for all files that are not callable proper API modules
475 public function getVersion() {
477 $vers[] = 'MediaWiki ' . SpecialVersion::getVersion();
478 $vers[] = __CLASS__ . ': $Id: ApiMain.php 25364 2007-08-31 15:23:48Z tstarling $';
479 $vers[] = ApiBase :: getBaseVersion();
480 $vers[] = ApiFormatBase :: getBaseVersion();
481 $vers[] = ApiQueryBase :: getBaseVersion();
482 $vers[] = ApiFormatFeedWrapper :: getVersion(); // not accessible with format=xxx
487 * Add or overwrite a module in this ApiMain instance. Intended for use by extending
488 * classes who wish to add their own modules to their lexicon or override the
489 * behavior of inherent ones.
492 * @param $mdlName String The identifier for this module.
493 * @param $mdlClass String The class where this module is implemented.
495 protected function addModule( $mdlName, $mdlClass ) {
496 $this->mModules[$mdlName] = $mdlClass;
500 * Add or overwrite an output format for this ApiMain. Intended for use by extending
501 * classes who wish to add to or modify current formatters.
504 * @param $fmtName The identifier for this format.
505 * @param $fmtClass The class implementing this format.
507 protected function addFormat( $fmtName, $fmtClass ) {
508 $this->mFormats[$fmtName] = $fmtClass;
513 * This exception will be thrown when dieUsage is called to stop module execution.
514 * The exception handling code will print a help screen explaining how this API may be used.
518 class UsageException extends Exception {
522 public function __construct($message, $codestr, $code = 0) {
523 parent :: __construct($message, $code);
524 $this->mCodestr = $codestr;
526 public function getCodeString() {
527 return $this->mCodestr;
529 public function __toString() {
530 return "{$this->getCodeString()}: {$this->getMessage()}";