From ca32f08966f1b51fcb19460f0996bb0c4048e6fe Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Sat, 3 Dec 2011 13:29:22 +0100 Subject: Update to MediaWiki 1.18.0 * also update ArchLinux skin to chagnes in MonoBook * Use only css to hide our menu bar when printing --- includes/api/ApiMain.php | 256 ++++++++++++++++++++++++++++++----------------- 1 file changed, 165 insertions(+), 91 deletions(-) (limited to 'includes/api/ApiMain.php') diff --git a/includes/api/ApiMain.php b/includes/api/ApiMain.php index d5238a51..d24e1df2 100644 --- a/includes/api/ApiMain.php +++ b/includes/api/ApiMain.php @@ -1,6 +1,6 @@ 'ApiExpandTemplates', 'parse' => 'ApiParse', 'opensearch' => 'ApiOpenSearch', + 'feedcontributions' => 'ApiFeedContributions', 'feedwatchlist' => 'ApiFeedWatchlist', 'help' => 'ApiHelp', 'paraminfo' => 'ApiParamInfo', 'rsd' => 'ApiRsd', + 'compare' => 'ApiComparePages', // Write modules 'purge' => 'ApiPurge', @@ -76,6 +78,7 @@ class ApiMain extends ApiBase { 'move' => 'ApiMove', 'edit' => 'ApiEditPage', 'upload' => 'ApiUpload', + 'filerevert' => 'ApiFileRevert', 'emailuser' => 'ApiEmailUser', 'watch' => 'ApiWatch', 'patrol' => 'ApiPatrol', @@ -123,7 +126,12 @@ class ApiMain extends ApiBase { ) ); - private $mPrinter, $mModules, $mModuleNames, $mFormats, $mFormatNames; + /** + * @var ApiFormatBase + */ + private $mPrinter; + + private $mModules, $mModuleNames, $mFormats, $mFormatNames; private $mResult, $mAction, $mShowVersions, $mEnableWrite, $mRequest; private $mInternalMode, $mSquidMaxage, $mModule; @@ -175,6 +183,7 @@ class ApiMain extends ApiBase { /** * Return true if the API was started by other PHP code using FauxRequest + * @return bool */ public function isInternalMode() { return $this->mInternalMode; @@ -199,6 +208,8 @@ class ApiMain extends ApiBase { /** * Get the API module object. Only works after executeAction() + * + * @return ApiBase */ public function getModule() { return $this->mModule; @@ -215,6 +226,8 @@ class ApiMain extends ApiBase { /** * Set how long the response should be cached. + * + * @param $maxage */ public function setCacheMaxAge( $maxage ) { $this->setCacheControl( array( @@ -268,7 +281,7 @@ class ApiMain extends ApiBase { } /** - * @deprecated Private caching is now the default, so there is usually no + * @deprecated since 1.17 Private caching is now the default, so there is usually no * need to call this function. If there is a need, you can use * $this->setCacheMode('private') */ @@ -283,6 +296,8 @@ class ApiMain extends ApiBase { * * Cache control values set here will only be used if the cache mode is not * private, see setCacheMode(). + * + * @param $directives array */ public function setCacheControl( $directives ) { $this->mCacheControl = $directives + $this->mCacheControl; @@ -296,7 +311,7 @@ class ApiMain extends ApiBase { * given URL must either always or never call this function; if it sometimes does and * sometimes doesn't, stuff will break. * - * @deprecated Use setCacheMode( 'anon-public-user-private' ) + * @deprecated since 1.17 Use setCacheMode( 'anon-public-user-private' ) */ public function setVaryCookie() { $this->setCacheMode( 'anon-public-user-private' ); @@ -304,6 +319,10 @@ class ApiMain extends ApiBase { /** * Create an instance of an output formatter by its name + * + * @param $format string + * + * @return ApiFormatBase */ public function createPrinterByName( $format ) { if ( !isset( $this->mFormats[$format] ) ) { @@ -343,22 +362,21 @@ class ApiMain extends ApiBase { wfDebugLog( 'exception', $e->getLogMessage() ); } - // // Handle any kind of exception by outputing properly formatted error message. // If this fails, an unhandled exception should be thrown so that global error // handler will process and log it. - // $errCode = $this->substituteResultWithError( $e ); // Error results should not be cached $this->setCacheMode( 'private' ); + $response = $this->getRequest()->response(); $headerStr = 'MediaWiki-API-Error: ' . $errCode; if ( $e->getCode() === 0 ) { - header( $headerStr ); + $response->header( $headerStr ); } else { - header( $headerStr, true, $e->getCode() ); + $response->header( $headerStr, true, $e->getCode() ); } // Reset and print just the error message @@ -381,29 +399,44 @@ class ApiMain extends ApiBase { } protected function sendCacheHeaders() { + global $wgUseXVO, $wgOut, $wgVaryOnXFP; + $response = $this->getRequest()->response(); + if ( $this->mCacheMode == 'private' ) { - header( 'Cache-Control: private' ); + $response->header( 'Cache-Control: private' ); return; } if ( $this->mCacheMode == 'anon-public-user-private' ) { - global $wgUseXVO, $wgOut; - header( 'Vary: Accept-Encoding, Cookie' ); + $xfp = $wgVaryOnXFP ? ', X-Forwarded-Proto' : ''; + $response->header( 'Vary: Accept-Encoding, Cookie' . $xfp ); if ( $wgUseXVO ) { - header( $wgOut->getXVO() ); + if ( $wgVaryOnXFP ) { + $wgOut->addVaryHeader( 'X-Forwarded-Proto' ); + } + $response->header( $wgOut->getXVO() ); if ( $wgOut->haveCacheVaryCookies() ) { // Logged in, mark this request private - header( 'Cache-Control: private' ); + $response->header( 'Cache-Control: private' ); return; } // Logged out, send normal public headers below } elseif ( session_id() != '' ) { // Logged in or otherwise has session (e.g. anonymous users who have edited) // Mark request private - header( 'Cache-Control: private' ); + $response->header( 'Cache-Control: private' ); return; } // else no XVO and anonymous, send public headers below } + + // Send public headers + if ( $wgVaryOnXFP ) { + $response->header( 'Vary: Accept-Encoding, X-Forwarded-Proto' ); + if ( $wgUseXVO ) { + // Bleeeeegh. Our header setting system sucks + $response->header( 'X-Vary-Options: Accept-Encoding;list-contains=gzip, X-Forwarded-Proto' ); + } + } // If nobody called setCacheMaxAge(), use the (s)maxage parameters if ( !isset( $this->mCacheControl['s-maxage'] ) ) { @@ -417,7 +450,7 @@ class ApiMain extends ApiBase { // Public cache not requested // Sending a Vary header in this case is harmless, and protects us // against conditional calls of setCacheMaxAge(). - header( 'Cache-Control: private' ); + $response->header( 'Cache-Control: private' ); return; } @@ -426,7 +459,7 @@ class ApiMain extends ApiBase { // Send an Expires header $maxAge = min( $this->mCacheControl['s-maxage'], $this->mCacheControl['max-age'] ); $expiryUnixTime = ( $maxAge == 0 ? 1 : time() + $maxAge ); - header( 'Expires: ' . wfTimestamp( TS_RFC2822, $expiryUnixTime ) ); + $response->header( 'Expires: ' . wfTimestamp( TS_RFC2822, $expiryUnixTime ) ); // Construct the Cache-Control header $ccHeader = ''; @@ -443,15 +476,17 @@ class ApiMain extends ApiBase { } } - header( "Cache-Control: $ccHeader" ); + $response->header( "Cache-Control: $ccHeader" ); } /** * Replace the result data with the information about an exception. * Returns the error code * @param $e Exception + * @return string */ protected function substituteResultWithError( $e ) { + $result = $this->getResult(); // Printer may not be initialized if the extractRequestParams() fails for the main module if ( !isset ( $this->mPrinter ) ) { // The printer has not been created yet. Try to manually get formatter value. @@ -462,14 +497,12 @@ class ApiMain extends ApiBase { $this->mPrinter = $this->createPrinterByName( $value ); if ( $this->mPrinter->getNeedsRawData() ) { - $this->getResult()->setRawMode(); + $result->setRawMode(); } } if ( $e instanceof UsageException ) { - // // User entered incorrect parameters - print usage screen - // $errMessage = $e->getMessageArray(); // Only print the help message when this is for the developer, not runtime @@ -479,9 +512,7 @@ class ApiMain extends ApiBase { } else { global $wgShowSQLErrors, $wgShowExceptionDetails; - // // Something is seriously wrong - // if ( ( $e instanceof DBQueryError ) && !$wgShowSQLErrors ) { $info = 'Database query error'; } else { @@ -495,32 +526,34 @@ class ApiMain extends ApiBase { ApiResult::setContent( $errMessage, $wgShowExceptionDetails ? "\n\n{$e->getTraceAsString()}\n\n" : '' ); } - $this->getResult()->reset(); - $this->getResult()->disableSizeCheck(); + $result->reset(); + $result->disableSizeCheck(); // Re-add the id $requestid = $this->getParameter( 'requestid' ); if ( !is_null( $requestid ) ) { - $this->getResult()->addValue( null, 'requestid', $requestid ); + $result->addValue( null, 'requestid', $requestid ); } // servedby is especially useful when debugging errors - $this->getResult()->addValue( null, 'servedby', wfHostName() ); - $this->getResult()->addValue( null, 'error', $errMessage ); + $result->addValue( null, 'servedby', wfHostName() ); + $result->addValue( null, 'error', $errMessage ); return $errMessage['code']; } /** * Set up for the execution. + * @return array */ protected function setupExecuteAction() { // First add the id to the top element + $result = $this->getResult(); $requestid = $this->getParameter( 'requestid' ); if ( !is_null( $requestid ) ) { - $this->getResult()->addValue( null, 'requestid', $requestid ); + $result->addValue( null, 'requestid', $requestid ); } $servedby = $this->getParameter( 'servedby' ); if ( $servedby ) { - $this->getResult()->addValue( null, 'servedby', wfHostName() ); + $result->addValue( null, 'servedby', wfHostName() ); } $params = $this->extractRequestParams(); @@ -553,8 +586,8 @@ class ApiMain extends ApiBase { $this->dieUsageMsg( array( 'missingparam', 'token' ) ); } else { global $wgUser; - if ( !$wgUser->matchEditToken( $moduleParams['token'], $salt ) ) { - $this->dieUsageMsg( array( 'sessionfailure' ) ); + if ( !$wgUser->matchEditToken( $moduleParams['token'], $salt, $this->getRequest() ) ) { + $this->dieUsageMsg( 'sessionfailure' ); } } } @@ -574,8 +607,11 @@ class ApiMain extends ApiBase { $maxLag = $params['maxlag']; list( $host, $lag ) = wfGetLB()->getMaxLag(); if ( $lag > $maxLag ) { - header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) ); - header( 'X-Database-Lag: ' . intval( $lag ) ); + $response = $this->getRequest()->response(); + + $response->header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) ); + $response->header( 'X-Database-Lag: ' . intval( $lag ) ); + if ( $wgShowHostnames ) { $this->dieUsage( "Waiting for $host: $lag seconds lagged", 'maxlag' ); } else { @@ -587,7 +623,6 @@ class ApiMain extends ApiBase { return true; } - /** * Check for sufficient permissions to execute * @param $module ApiBase An Api module @@ -597,14 +632,14 @@ class ApiMain extends ApiBase { if ( $module->isReadMode() && !in_array( 'read', User::getGroupPermissions( array( '*' ) ), true ) && !$wgUser->isAllowed( 'read' ) ) { - $this->dieUsageMsg( array( 'readrequired' ) ); + $this->dieUsageMsg( 'readrequired' ); } if ( $module->isWriteMode() ) { if ( !$this->mEnableWrite ) { - $this->dieUsageMsg( array( 'writedisabled' ) ); + $this->dieUsageMsg( 'writedisabled' ); } if ( !$wgUser->isAllowed( 'writeapi' ) ) { - $this->dieUsageMsg( array( 'writerequired' ) ); + $this->dieUsageMsg( 'writerequired' ); } if ( wfReadOnly() ) { $this->dieReadOnly(); @@ -666,6 +701,8 @@ class ApiMain extends ApiBase { /** * Print results using the current printer + * + * @param $isError bool */ protected function printResult( $isError ) { $this->getResult()->cleanUpUTF8(); @@ -687,12 +724,17 @@ class ApiMain extends ApiBase { $printer->profileOut(); } + /** + * @return bool + */ public function isReadMode() { return false; } /** * See ApiBase for description. + * + * @return array */ public function getAllowedParams() { return array( @@ -723,13 +765,22 @@ class ApiMain extends ApiBase { /** * See ApiBase for description. + * + * @return array */ public function getParamDescription() { return array( 'format' => 'The format of the output', 'action' => 'What action you would like to perform. See below for module help', 'version' => 'When showing help, include version for each module', - 'maxlag' => 'Maximum lag', + 'maxlag' => array( + 'Maximum lag can be used when MediaWiki is installed on a database replicated cluster.', + 'To save actions causing any more site replication lag, this parameter can make the client', + 'wait until the replication lag is less than the specified value.', + 'In case of a replag error, a HTTP 503 error is returned, with the message like', + '"Waiting for $host: $lag seconds lagged\n".', + 'See https://www.mediawiki.org/wiki/Manual:Maxlag_parameter for more information', + ), 'smaxage' => 'Set the s-maxage header to this many seconds. Errors are never cached', 'maxage' => 'Set the max-age header to this many seconds. Errors are never cached', 'requestid' => 'Request ID to distinguish requests. This will just be output back to you', @@ -739,28 +790,40 @@ class ApiMain extends ApiBase { /** * See ApiBase for description. + * + * @return array */ public function getDescription() { return array( '', '', - '******************************************************************************************', - '** **', - '** This is an auto-generated MediaWiki API documentation page **', - '** **', - '** Documentation and Examples: **', - '** http://www.mediawiki.org/wiki/API **', - '** **', - '******************************************************************************************', + '**********************************************************************************************************', + '** **', + '** This is an auto-generated MediaWiki API documentation page **', + '** **', + '** Documentation and Examples: **', + '** https://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.', + ' 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', - 'Api Announcements: http://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce', - 'Bugs & Requests: http://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts', + 'Erroneous requests: When erroneous requests are sent to the API, a HTTP header will be sent', + ' with the key "MediaWiki-API-Error" and then both the value of the', + ' header and the error code sent back will be set to the same value', + '', + ' In the case of an invalid action being passed, these will have a value', + ' of "unknown_action"', + '', + ' For more information see https://www.mediawiki.org/wiki/API:Errors_and_warnings', + '', + 'Documentation: https://www.mediawiki.org/wiki/API:Main_page', + 'FAQ https://www.mediawiki.org/wiki/API:FAQ', + 'Mailing list: https://lists.wikimedia.org/mailman/listinfo/mediawiki-api', + 'Api Announcements: https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce', + 'Bugs & Requests: https://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts', '', '', '', @@ -769,6 +832,9 @@ class ApiMain extends ApiBase { ); } + /** + * @return array + */ public function getPossibleErrors() { return array_merge( parent::getPossibleErrors(), array( array( 'readonlytext' ), @@ -781,22 +847,26 @@ class ApiMain extends ApiBase { /** * Returns an array of strings with credits for the API + * @return array */ protected function getCredits() { return array( 'API developers:', - ' Roan Kattouw .@home.nl (lead developer Sep 2007-present)', + ' Roan Kattouw .@gmail.com (lead developer Sep 2007-present)', ' Victor Vasiliev - vasilvv at gee mail dot com', ' Bryan Tong Minh - bryan . tongminh @ gmail . com', ' Sam Reed - sam @ reedyboy . net', ' Yuri Astrakhan @gmail.com (creator, lead developer Sep 2006-Sep 2007)', '', 'Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org', - 'or file a bug report at http://bugzilla.wikimedia.org/' + 'or file a bug report at https://bugzilla.wikimedia.org/' ); } + /** * Sets whether the pretty-printer should format *bold* and $italics$ + * + * @param $help bool */ public function setHelp( $help = true ) { $this->mPrinter->setHelp( $help ); @@ -804,34 +874,39 @@ class ApiMain extends ApiBase { /** * Override the parent to generate help messages for all available modules. + * + * @return string */ public function makeHelpMsg() { - global $wgMemc, $wgAPICacheHelp, $wgAPICacheHelpTimeout; + global $wgMemc, $wgAPICacheHelpTimeout; $this->setHelp(); // Get help text from cache if present $key = wfMemcKey( 'apihelp', $this->getModuleName(), SpecialVersion::getVersion( 'nodb' ) . - $this->getMain()->getShowVersions() ); - if ( $wgAPICacheHelp ) { + $this->getShowVersions() ); + if ( $wgAPICacheHelpTimeout > 0 ) { $cached = $wgMemc->get( $key ); if ( $cached ) { return $cached; } } $retval = $this->reallyMakeHelpMsg(); - if ( $wgAPICacheHelp ) { + if ( $wgAPICacheHelpTimeout > 0 ) { $wgMemc->set( $key, $retval, $wgAPICacheHelpTimeout ); } return $retval; } + /** + * @return mixed|string + */ public function reallyMakeHelpMsg() { $this->setHelp(); // Use parent to make default message for the main module $msg = parent::makeHelpMsg(); - $astriks = str_repeat( '*** ', 10 ); + $astriks = str_repeat( '*** ', 14 ); $msg .= "\n\n$astriks Modules $astriks\n\n"; foreach ( array_keys( $this->mModules ) as $moduleName ) { $module = new $this->mModules[$moduleName] ( $this, $moduleName ); @@ -867,6 +942,11 @@ class ApiMain extends ApiBase { return $msg; } + /** + * @param $module ApiBase + * @param $paramName String What type of request is this? e.g. action, query, list, prop, meta, format + * @return string + */ public static function makeHelpMsgHeader( $module, $paramName ) { $modulePrefix = $module->getModulePrefix(); if ( strval( $modulePrefix ) !== '' ) { @@ -876,36 +956,8 @@ class ApiMain extends ApiBase { return "* $paramName={$module->getModuleName()} $modulePrefix*"; } - private $mIsBot = null; - private $mIsSysop = null; private $mCanApiHighLimits = null; - /** - * Returns true if the currently logged in user is a bot, false otherwise - * OBSOLETE, use canApiHighLimits() instead - */ - public function isBot() { - if ( !isset( $this->mIsBot ) ) { - global $wgUser; - $this->mIsBot = $wgUser->isAllowed( 'bot' ); - } - return $this->mIsBot; - } - - /** - * Similar to isBot(), this method returns true if the logged in user is - * a sysop, and false if not. - * OBSOLETE, use canApiHighLimits() instead - */ - public function isSysop() { - if ( !isset( $this->mIsSysop ) ) { - global $wgUser; - $this->mIsSysop = in_array( 'sysop', $wgUser->getGroups() ); - } - - return $this->mIsSysop; - } - /** * Check whether the current user is allowed to use high limits * @return bool @@ -930,11 +982,13 @@ class ApiMain extends ApiBase { /** * Returns the version information of this file, plus it includes * the versions for all files that are not callable proper API modules + * + * @return array */ public function getVersion() { - $vers = array (); - $vers[] = 'MediaWiki: ' . SpecialVersion::getVersion() . "\n http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/"; - $vers[] = __CLASS__ . ': $Id: ApiMain.php 76196 2010-11-06 16:11:19Z reedy $'; + $vers = array(); + $vers[] = 'MediaWiki: ' . SpecialVersion::getVersion() . "\n https://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/"; + $vers[] = __CLASS__ . ': $Id: ApiMain.php 104449 2011-11-28 15:52:04Z reedy $'; $vers[] = ApiBase::getBaseVersion(); $vers[] = ApiFormatBase::getBaseVersion(); $vers[] = ApiQueryBase::getBaseVersion(); @@ -957,8 +1011,8 @@ class ApiMain extends ApiBase { * Add or overwrite an output format for this ApiMain. Intended for use by extending * classes who wish to add to or modify current formatters. * - * @param $fmtName The identifier for this format. - * @param $fmtClass The class implementing this format. + * @param $fmtName string The identifier for this format. + * @param $fmtClass ApiFormatBase The class implementing this format. */ protected function addFormat( $fmtName, $fmtClass ) { $this->mFormats[$fmtName] = $fmtClass; @@ -966,10 +1020,21 @@ class ApiMain extends ApiBase { /** * Get the array mapping module names to class names + * @return array */ function getModules() { return $this->mModules; } + + /** + * Returns the list of supported formats in form ( 'format' => 'ClassName' ) + * + * @since 1.18 + * @return array + */ + public function getFormats() { + return $this->mFormats; + } } /** @@ -989,10 +1054,16 @@ class UsageException extends Exception { $this->mExtraData = $extradata; } + /** + * @return string + */ public function getCodeString() { return $this->mCodestr; } + /** + * @return array + */ public function getMessageArray() { $result = array( 'code' => $this->mCodestr, @@ -1004,6 +1075,9 @@ class UsageException extends Exception { return $result; } + /** + * @return string + */ public function __toString() { return "{$this->getCodeString()}: {$this->getMessage()}"; } -- cgit v1.2.2