From 8f416baead93a48e5799e44b8bd2e2c4859f4e04 Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Fri, 14 Sep 2007 13:18:58 +0200 Subject: auf Version 1.11 aktualisiert; Login-Bug behoben --- includes/api/ApiMain.php | 268 ++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 217 insertions(+), 51 deletions(-) (limited to 'includes/api/ApiMain.php') diff --git a/includes/api/ApiMain.php b/includes/api/ApiMain.php index 9a6b0f83..31870449 100644 --- a/includes/api/ApiMain.php +++ b/includes/api/ApiMain.php @@ -5,7 +5,7 @@ * * API for MediaWiki 1.8+ * - * Copyright (C) 2006 Yuri Astrakhan + * Copyright (C) 2006 Yuri Astrakhan @gmail.com * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -29,7 +29,16 @@ if (!defined('MEDIAWIKI')) { } /** - * This is the main API class, used for both external and internal processing. + * This is the main API class, used for both external and internal processing. + * When executed, it will create the requested formatter object, + * instantiate and execute an object associated with the needed action, + * and use formatter to print results. + * In case of an exception, an error message will be printed using the same formatter. + * + * To use API from another application, run it using FauxRequest object, in which + * case any internal exceptions will not be handled but passed up to the caller. + * After successful execution, use getResult() for the resulting data. + * * @addtogroup API */ class ApiMain extends ApiBase { @@ -43,11 +52,11 @@ class ApiMain extends ApiBase { * List of available modules: action name => module class */ private static $Modules = array ( - 'help' => 'ApiHelp', 'login' => 'ApiLogin', + 'query' => 'ApiQuery', 'opensearch' => 'ApiOpenSearch', 'feedwatchlist' => 'ApiFeedWatchlist', - 'query' => 'ApiQuery' + 'help' => 'ApiHelp', ); /** @@ -68,10 +77,11 @@ class ApiMain extends ApiBase { ); private $mPrinter, $mModules, $mModuleNames, $mFormats, $mFormatNames; - private $mResult, $mShowVersions, $mEnableWrite, $mRequest, $mInternalMode, $mSquidMaxage; + private $mResult, $mAction, $mShowVersions, $mEnableWrite, $mRequest, $mInternalMode, $mSquidMaxage; /** - * Constructor + * Constructs an instance of ApiMain that utilizes the module and format specified by $request. + * * @param $request object - if this is an instance of FauxRequest, errors are thrown and no printing occurs * @param $enableWrite bool should be set to true if the api may modify data */ @@ -82,7 +92,23 @@ class ApiMain extends ApiBase { // Special handling for the main module: $parent === $this parent :: __construct($this, $this->mInternalMode ? 'main_int' : 'main'); - $this->mModules = self :: $Modules; + if (!$this->mInternalMode) { + + // Impose module restrictions. + // If the current user cannot read, + // Remove all modules other than login + global $wgUser; + if (!$wgUser->isAllowed('read')) { + self::$Modules = array( + 'login' => self::$Modules['login'], + 'help' => self::$Modules['help'] + ); + } + } + + global $wgAPIModules; // extension modules + $this->mModules = $wgAPIModules + self :: $Modules; + $this->mModuleNames = array_keys($this->mModules); // todo: optimize $this->mFormats = self :: $Formats; $this->mFormatNames = array_keys($this->mFormats); // todo: optimize @@ -96,28 +122,53 @@ class ApiMain extends ApiBase { $this->mSquidMaxage = 0; } - public function & getRequest() { + /** + * Return true if the API was started by other PHP code using FauxRequest + */ + public function isInternalMode() { + return $this->mInternalMode; + } + + /** + * Return the request object that contains client's request + */ + public function getRequest() { return $this->mRequest; } + /** + * Get the ApiResult object asscosiated with current request + */ public function getResult() { return $this->mResult; } + /** + * This method will simply cause an error if the write mode was disabled for this api. + */ public function requestWriteMode() { if (!$this->mEnableWrite) $this->dieUsage('Editing of this site is disabled. Make sure the $wgEnableWriteAPI=true; ' . 'statement is included in the site\'s LocalSettings.php file', 'readonly'); } + /** + * Set how long the response should be cached. + */ public function setCacheMaxAge($maxage) { $this->mSquidMaxage = $maxage; } + /** + * Create an instance of an output formatter by its name + */ public function createPrinterByName($format) { return new $this->mFormats[$format] ($this, $format); } + /** + * Execute api request. Any errors will be handled if the API was called by the remote client. + */ public function execute() { $this->profileIn(); if ($this->mInternalMode) @@ -127,10 +178,14 @@ class ApiMain extends ApiBase { $this->profileOut(); } + /** + * Execute an action, and in case of an error, erase whatever partial results + * have been accumulated, and replace it with an error message and a help screen. + */ protected function executeActionWithErrorHandling() { // In case an error occurs during data output, - // this clear the output buffer and print just the error information + // clear the output buffer and print just the error information ob_start(); try { @@ -142,12 +197,51 @@ class ApiMain extends ApiBase { // handler will process and log it. // + $errCode = $this->substituteResultWithError($e); + // Error results should not be cached $this->setCacheMaxAge(0); + $headerStr = 'MediaWiki-API-Error: ' . $errCode; + if ($e->getCode() === 0) + header($headerStr, true); + else + header($headerStr, true, $e->getCode()); + + // Reset and print just the error message + ob_clean(); + + // If the error occured during printing, do a printer->profileOut() + $this->mPrinter->safeProfileOut(); + $this->printResult(true); + } + + // Set the cache expiration at the last moment, as any errors may change the expiration. + // if $this->mSquidMaxage == 0, the expiry time is set to the first second of unix epoch + $expires = $this->mSquidMaxage == 0 ? 1 : time() + $this->mSquidMaxage; + header('Expires: ' . wfTimestamp(TS_RFC2822, $expires)); + header('Cache-Control: s-maxage=' . $this->mSquidMaxage . ', must-revalidate, max-age=0'); + + if($this->mPrinter->getIsHtml()) + echo wfReportTime(); + + ob_end_flush(); + } + + /** + * Replace the result data with the information about an exception. + * Returns the error code + */ + protected function substituteResultWithError($e) { + // Printer may not be initialized if the extractRequestParams() fails for the main module if (!isset ($this->mPrinter)) { - $this->mPrinter = $this->createPrinterByName(self :: API_DEFAULT_FORMAT); + // The printer has not been created yet. Try to manually get formatter value. + $value = $this->getRequest()->getVal('format', self::API_DEFAULT_FORMAT); + if (!in_array($value, $this->mFormatNames)) + $value = self::API_DEFAULT_FORMAT; + + $this->mPrinter = $this->createPrinterByName($value); if ($this->mPrinter->getNeedsRawData()) $this->getResult()->setRawMode(); } @@ -157,8 +251,12 @@ class ApiMain extends ApiBase { // User entered incorrect parameters - print usage screen // $errMessage = array ( - 'code' => $e->getCodeString(), 'info' => $e->getMessage()); - ApiResult :: setContent($errMessage, $this->makeHelpMsg()); + 'code' => $e->getCodeString(), + 'info' => $e->getMessage()); + + // Only print the help message when this is for the developer, not runtime + if ($this->mPrinter->getIsHtml() || $this->mAction == 'help') + ApiResult :: setContent($errMessage, $this->makeHelpMsg()); } else { // @@ -171,41 +269,24 @@ class ApiMain extends ApiBase { ApiResult :: setContent($errMessage, "\n\n{$e->getTraceAsString()}\n\n"); } - $headerStr = 'MediaWiki-API-Error: ' . $errMessage['code']; - if ($e->getCode() === 0) - header($headerStr, true); - else - header($headerStr, true, $e->getCode()); - - // Reset and print just the error message - ob_clean(); $this->getResult()->reset(); $this->getResult()->addValue(null, 'error', $errMessage); - // If the error occured during printing, do a printer->profileOut() - $this->mPrinter->safeProfileOut(); - $this->printResult(true); - } - - // Set the cache expiration at the last moment, as any errors may change the expiration. - // if $this->mSquidMaxage == 0, the expiry time is set to the first second of unix epoch - $expires = $this->mSquidMaxage == 0 ? 1 : time() + $this->mSquidMaxage; - header('Expires: ' . wfTimestamp(TS_RFC2822, $expires)); - header('Cache-Control: s-maxage=' . $this->mSquidMaxage . ', must-revalidate, max-age=0'); - - ob_end_flush(); + return $errMessage['code']; } /** * Execute the actual module, without any error handling */ protected function executeAction() { - $action = $format = $version = null; - extract($this->extractRequestParams()); - $this->mShowVersions = $version; + + $params = $this->extractRequestParams(); + + $this->mShowVersions = $params['version']; + $this->mAction = $params['action']; // Instantiate the module requested by the user - $module = new $this->mModules[$action] ($this, $action); + $module = new $this->mModules[$this->mAction] ($this, $this->mAction); if (!$this->mInternalMode) { @@ -213,7 +294,7 @@ class ApiMain extends ApiBase { $this->mPrinter = $module->getCustomPrinter(); if (is_null($this->mPrinter)) { // Create an appropriate printer - $this->mPrinter = $this->createPrinterByName($format); + $this->mPrinter = $this->createPrinterByName($params['format']); } if ($this->mPrinter->getNeedsRawData()) @@ -232,7 +313,7 @@ class ApiMain extends ApiBase { } /** - * Internal printer + * Print results using the current printer */ protected function printResult($isError) { $printer = $this->mPrinter; @@ -243,6 +324,9 @@ class ApiMain extends ApiBase { $printer->profileOut(); } + /** + * See ApiBase for description. + */ protected function getAllowedParams() { return array ( 'format' => array ( @@ -257,6 +341,9 @@ class ApiMain extends ApiBase { ); } + /** + * See ApiBase for description. + */ protected function getParamDescription() { return array ( 'format' => 'The format of the output', @@ -265,24 +352,44 @@ class ApiMain extends ApiBase { ); } + /** + * See ApiBase for description. + */ protected function getDescription() { return array ( '', - 'This API allows programs to access various functions of MediaWiki software.', - 'For more details see API Home Page @ http://meta.wikimedia.org/wiki/API', '', - 'Status: ALPHA -- all features shown on this page should be working,', - ' but the API is still in active development, and may change at any time.', - ' Make sure you monitor changes to this page, wikitech-l mailing list,', - ' or the source code in the includes/api directory for any changes.', - '' + '******************************************************************', + '** **', + '** This is an auto-generated MediaWiki API documentation page **', + '** **', + '** Documentation and Examples: **', + '** http://www.mediawiki.org/wiki/API **', + '** **', + '******************************************************************', + '', + 'Status: All features shown on this page should be working, but the API', + ' is still in active development, and may change at any time.', + ' Make sure to monitor our mailing list for any updates.', + '', + 'Documentation: http://www.mediawiki.org/wiki/API', + 'Mailing list: http://lists.wikimedia.org/mailman/listinfo/mediawiki-api', + 'Bugs & Requests: http://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts', + '', + '', + '', + '', + '', ); } + /** + * Returns an array of strings with credits for the API + */ protected function getCredits() { return array( - 'This API is being implemented by Yuri Astrakhan [[User:Yurik]] / FirstnameLastname@gmail.com', - 'Please leave your comments and suggestions at http://meta.wikimedia.org/wiki/API' + 'This API is being implemented by Yuri Astrakhan [[User:Yurik]] / @gmail.com', + 'Please leave your comments and suggestions at http://www.mediawiki.org/wiki/API' ); } @@ -297,8 +404,8 @@ class ApiMain extends ApiBase { $astriks = str_repeat('*** ', 10); $msg .= "\n\n$astriks Modules $astriks\n\n"; foreach( $this->mModules as $moduleName => $unused ) { - $msg .= "* action=$moduleName *"; $module = new $this->mModules[$moduleName] ($this, $moduleName); + $msg .= self::makeHelpMsgHeader($module, 'action'); $msg2 = $module->makeHelpMsg(); if ($msg2 !== false) $msg .= $msg2; @@ -307,8 +414,8 @@ class ApiMain extends ApiBase { $msg .= "\n$astriks Formats $astriks\n\n"; foreach( $this->mFormats as $formatName => $unused ) { - $msg .= "* format=$formatName *"; $module = $this->createPrinterByName($formatName); + $msg .= self::makeHelpMsgHeader($module, 'format'); $msg2 = $module->makeHelpMsg(); if ($msg2 !== false) $msg .= $msg2; @@ -321,7 +428,21 @@ class ApiMain extends ApiBase { return $msg; } + public static function makeHelpMsgHeader($module, $paramName) { + $modulePrefix = $module->getModulePrefix(); + if (!empty($modulePrefix)) + $modulePrefix = "($modulePrefix) "; + + return "* $paramName={$module->getModuleName()} $modulePrefix*"; + } + private $mIsBot = null; + + private $mIsSysop = null; + + /** + * Returns true if the currently logged in user is a bot, false otherwise + */ public function isBot() { if (!isset ($this->mIsBot)) { global $wgUser; @@ -329,24 +450,69 @@ class ApiMain extends ApiBase { } return $this->mIsBot; } + + /** + * Similar to isBot(), this method returns true if the logged in user is + * a sysop, and false if not. + */ + public function isSysop() { + if (!isset ($this->mIsSysop)) { + global $wgUser; + $this->mIsSysop = in_array( 'sysop', $wgUser->getGroups()); + } + + return $this->mIsSysop; + } public function getShowVersions() { return $this->mShowVersions; } + /** + * Returns the version information of this file, plus it includes + * the versions for all files that are not callable proper API modules + */ public function getVersion() { $vers = array (); - $vers[] = __CLASS__ . ': $Id: ApiMain.php 21402 2007-04-20 08:55:14Z nickj $'; + $vers[] = 'MediaWiki ' . SpecialVersion::getVersion(); + $vers[] = __CLASS__ . ': $Id: ApiMain.php 25364 2007-08-31 15:23:48Z tstarling $'; $vers[] = ApiBase :: getBaseVersion(); $vers[] = ApiFormatBase :: getBaseVersion(); $vers[] = ApiQueryBase :: getBaseVersion(); $vers[] = ApiFormatFeedWrapper :: getVersion(); // not accessible with format=xxx return $vers; } + + /** + * Add or overwrite a module in this ApiMain instance. Intended for use by extending + * classes who wish to add their own modules to their lexicon or override the + * behavior of inherent ones. + * + * @access protected + * @param $mdlName String The identifier for this module. + * @param $mdlClass String The class where this module is implemented. + */ + protected function addModule( $mdlName, $mdlClass ) { + $this->mModules[$mdlName] = $mdlClass; + } + + /** + * Add or overwrite an output format for this ApiMain. Intended for use by extending + * classes who wish to add to or modify current formatters. + * + * @access protected + * @param $fmtName The identifier for this format. + * @param $fmtClass The class implementing this format. + */ + protected function addFormat( $fmtName, $fmtClass ) { + $this->mFormats[$fmtName] = $fmtClass; + } } /** * This exception will be thrown when dieUsage is called to stop module execution. + * The exception handling code will print a help screen explaining how this API may be used. + * * @addtogroup API */ class UsageException extends Exception { @@ -364,4 +530,4 @@ class UsageException extends Exception { return "{$this->getCodeString()}: {$this->getMessage()}"; } } -?> + -- cgit v1.2.3-54-g00ecf