ApiMain.php

Go to the documentation of this file.

<?php
use MediaWiki\Api\Validator\ApiParamValidator;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;
use MediaWiki\ParamValidator\TypeDef\UserDef;
use MediaWiki\Session\SessionManager;
use Wikimedia\Timestamp\TimestampException;
 
class ApiMain extends ApiBase {
    private const API_DEFAULT_FORMAT = 'jsonfm';
 
    private const API_DEFAULT_USELANG = 'user';
 
    private static $Modules = [
        'login' => ApiLogin::class,
        'clientlogin' => ApiClientLogin::class,
        'logout' => ApiLogout::class,
        'createaccount' => ApiAMCreateAccount::class,
        'linkaccount' => ApiLinkAccount::class,
        'unlinkaccount' => ApiRemoveAuthenticationData::class,
        'changeauthenticationdata' => ApiChangeAuthenticationData::class,
        'removeauthenticationdata' => ApiRemoveAuthenticationData::class,
        'resetpassword' => ApiResetPassword::class,
        'query' => ApiQuery::class,
        'expandtemplates' => ApiExpandTemplates::class,
        'parse' => ApiParse::class,
        'stashedit' => ApiStashEdit::class,
        'opensearch' => ApiOpenSearch::class,
        'feedcontributions' => ApiFeedContributions::class,
        'feedrecentchanges' => ApiFeedRecentChanges::class,
        'feedwatchlist' => ApiFeedWatchlist::class,
        'help' => ApiHelp::class,
        'paraminfo' => ApiParamInfo::class,
        'rsd' => ApiRsd::class,
        'compare' => ApiComparePages::class,
        'tokens' => ApiTokens::class,
        'checktoken' => ApiCheckToken::class,
        'cspreport' => ApiCSPReport::class,
        'validatepassword' => ApiValidatePassword::class,
 
        // Write modules
        'purge' => ApiPurge::class,
        'setnotificationtimestamp' => ApiSetNotificationTimestamp::class,
        'rollback' => ApiRollback::class,
        'delete' => ApiDelete::class,
        'undelete' => ApiUndelete::class,
        'protect' => ApiProtect::class,
        'block' => ApiBlock::class,
        'unblock' => ApiUnblock::class,
        'move' => ApiMove::class,
        'edit' => ApiEditPage::class,
        'upload' => ApiUpload::class,
        'filerevert' => ApiFileRevert::class,
        'emailuser' => ApiEmailUser::class,
        'watch' => ApiWatch::class,
        'patrol' => ApiPatrol::class,
        'import' => ApiImport::class,
        'clearhasmsg' => ApiClearHasMsg::class,
        'userrights' => ApiUserrights::class,
        'options' => ApiOptions::class,
        'imagerotate' => ApiImageRotate::class,
        'revisiondelete' => ApiRevisionDelete::class,
        'managetags' => ApiManageTags::class,
        'tag' => ApiTag::class,
        'mergehistory' => ApiMergeHistory::class,
        'setpagelanguage' => ApiSetPageLanguage::class,
        'changecontentmodel' => ApiChangeContentModel::class,
    ];
 
    private static $Formats = [
        'json' => ApiFormatJson::class,
        'jsonfm' => ApiFormatJson::class,
        'php' => ApiFormatPhp::class,
        'phpfm' => ApiFormatPhp::class,
        'xml' => ApiFormatXml::class,
        'xmlfm' => ApiFormatXml::class,
        'rawfm' => ApiFormatJson::class,
        'none' => ApiFormatNone::class,
    ];
 
    private static $mRights = [
        'writeapi' => [
            'msg' => 'right-writeapi',
            'params' => []
        ],
        'apihighlimits' => [
            'msg' => 'api-help-right-apihighlimits',
            'params' => [ ApiBase::LIMIT_SML2, ApiBase::LIMIT_BIG2 ]
        ]
    ];
 
    private $mPrinter;
 
    private $mModuleMgr, $mResult, $mErrorFormatter = null, $mParamValidator;
    private $mContinuationManager;
    private $mAction;
    private $mEnableWrite;
    private $mInternalMode, $mCdnMaxAge;
    private $mModule;
 
    private $mCacheMode = 'private';
    private $mCacheControl = [];
    private $mParamsUsed = [];
    private $mParamsSensitive = [];
 
    private $lacksSameOriginSecurity = null;
 
    public function __construct( $context = null, $enableWrite = false ) {
        if ( $context === null ) {
            $context = RequestContext::getMain();
        } elseif ( $context instanceof WebRequest ) {
            // BC for pre-1.19
            $request = $context;
            $context = RequestContext::getMain();
        }
        // We set a derivative context so we can change stuff later
        $derivativeContext = new DerivativeContext( $context );
        $this->setContext( $derivativeContext );
 
        if ( isset( $request ) ) {
            $derivativeContext->setRequest( $request );
        } else {
            $request = $this->getRequest();
        }
 
        $this->mInternalMode = ( $request instanceof FauxRequest );
 
        // Special handling for the main module: $parent === $this
        parent::__construct( $this, $this->mInternalMode ? 'main_int' : 'main' );
 
        $config = $this->getConfig();
 
        if ( !$this->mInternalMode ) {
            // If we're in a mode that breaks the same-origin policy, strip
            // user credentials for security.
            if ( $this->lacksSameOriginSecurity() ) {
                global $wgUser;
                wfDebug( "API: stripping user credentials when the same-origin policy is not applied" );
                $user = new User();
                $wgUser = $user;
                $derivativeContext->setUser( $user );
                $request->response()->header( 'MediaWiki-Login-Suppressed: true' );
            }
        }
 
        $this->mParamValidator = new ApiParamValidator(
            $this, MediaWikiServices::getInstance()->getObjectFactory()
        );
 
        $this->mResult = new ApiResult( $this->getConfig()->get( 'APIMaxResultSize' ) );
 
        // Setup uselang. This doesn't use $this->getParameter()
        // because we're not ready to handle errors yet.
        // Optimisation: Avoid slow getVal(), this isn't user-generated content.
        $uselang = $request->getRawVal( 'uselang', self::API_DEFAULT_USELANG );
        if ( $uselang === 'user' ) {
            // Assume the parent context is going to return the user language
            // for uselang=user (see T85635).
        } else {
            if ( $uselang === 'content' ) {
                $uselang = MediaWikiServices::getInstance()->getContentLanguage()->getCode();
            }
            $code = RequestContext::sanitizeLangCode( $uselang );
            $derivativeContext->setLanguage( $code );
            if ( !$this->mInternalMode ) {
                global $wgLang;
                $wgLang = $derivativeContext->getLanguage();
                RequestContext::getMain()->setLanguage( $wgLang );
            }
        }
 
        // Set up the error formatter. This doesn't use $this->getParameter()
        // because we're not ready to handle errors yet.
        // Optimisation: Avoid slow getVal(), this isn't user-generated content.
        $errorFormat = $request->getRawVal( 'errorformat', 'bc' );
        $errorLangCode = $request->getRawVal( 'errorlang', 'uselang' );
        $errorsUseDB = $request->getCheck( 'errorsuselocal' );
        if ( in_array( $errorFormat, [ 'plaintext', 'wikitext', 'html', 'raw', 'none' ], true ) ) {
            if ( $errorLangCode === 'uselang' ) {
                $errorLang = $this->getLanguage();
            } elseif ( $errorLangCode === 'content' ) {
                $errorLang = MediaWikiServices::getInstance()->getContentLanguage();
            } else {
                $errorLangCode = RequestContext::sanitizeLangCode( $errorLangCode );
                $errorLang = MediaWikiServices::getInstance()->getLanguageFactory()
                    ->getLanguage( $errorLangCode );
            }
            $this->mErrorFormatter = new ApiErrorFormatter(
                $this->mResult, $errorLang, $errorFormat, $errorsUseDB
            );
        } else {
            $this->mErrorFormatter = new ApiErrorFormatter_BackCompat( $this->mResult );
        }
        $this->mResult->setErrorFormatter( $this->getErrorFormatter() );
 
        $this->mModuleMgr = new ApiModuleManager(
            $this,
            MediaWikiServices::getInstance()->getObjectFactory()
        );
        $this->mModuleMgr->addModules( self::$Modules, 'action' );
        $this->mModuleMgr->addModules( $config->get( 'APIModules' ), 'action' );
        $this->mModuleMgr->addModules( self::$Formats, 'format' );
        $this->mModuleMgr->addModules( $config->get( 'APIFormatModules' ), 'format' );
 
        $this->getHookRunner()->onApiMain__moduleManager( $this->mModuleMgr );
 
        $this->mContinuationManager = null;
        $this->mEnableWrite = $enableWrite;
 
        $this->mCdnMaxAge = -1; // flag for executeActionWithErrorHandling()
    }
 
    public function isInternalMode() {
        return $this->mInternalMode;
    }
 
    public function getResult() {
        return $this->mResult;
    }
 
    public function lacksSameOriginSecurity() {
        if ( $this->lacksSameOriginSecurity !== null ) {
            return $this->lacksSameOriginSecurity;
        }
 
        $request = $this->getRequest();
 
        // JSONP mode
        if ( $request->getCheck( 'callback' ) ) {
            $this->lacksSameOriginSecurity = true;
            return true;
        }
 
        // Anonymous CORS
        if ( $request->getVal( 'origin' ) === '*' ) {
            $this->lacksSameOriginSecurity = true;
            return true;
        }
 
        // Header to be used from XMLHTTPRequest when the request might
        // otherwise be used for XSS.
        if ( $request->getHeader( 'Treat-as-Untrusted' ) !== false ) {
            $this->lacksSameOriginSecurity = true;
            return true;
        }
 
        // Allow extensions to override.
        $this->lacksSameOriginSecurity = !$this->getHookRunner()
            ->onRequestHasSameOriginSecurity( $request );
        return $this->lacksSameOriginSecurity;
    }
 
    public function getErrorFormatter() {
        return $this->mErrorFormatter;
    }
 
    public function getContinuationManager() {
        return $this->mContinuationManager;
    }
 
    public function setContinuationManager( ApiContinuationManager $manager = null ) {
        if ( $manager !== null && $this->mContinuationManager !== null ) {
            throw new UnexpectedValueException(
                __METHOD__ . ': tried to set manager from ' . $manager->getSource() .
                ' when a manager is already set from ' . $this->mContinuationManager->getSource()
            );
        }
        $this->mContinuationManager = $manager;
    }
 
    public function getParamValidator() : ApiParamValidator {
        return $this->mParamValidator;
    }
 
    public function getModule() {
        return $this->mModule;
    }
 
    public function getPrinter() {
        return $this->mPrinter;
    }
 
    public function setCacheMaxAge( $maxage ) {
        $this->setCacheControl( [
            'max-age' => $maxage,
            's-maxage' => $maxage
        ] );
    }
 
    public function setCacheMode( $mode ) {
        if ( !in_array( $mode, [ 'private', 'public', 'anon-public-user-private' ] ) ) {
            wfDebug( __METHOD__ . ": unrecognised cache mode \"$mode\"" );
 
            // Ignore for forwards-compatibility
            return;
        }
 
        if ( !$this->getPermissionManager()->isEveryoneAllowed( 'read' ) ) {
            // Private wiki, only private headers
            if ( $mode !== 'private' ) {
                wfDebug( __METHOD__ . ": ignoring request for $mode cache mode, private wiki" );
 
                return;
            }
        }
 
        if ( $mode === 'public' && $this->getParameter( 'uselang' ) === 'user' ) {
            // User language is used for i18n, so we don't want to publicly
            // cache. Anons are ok, because if they have non-default language
            // then there's an appropriate Vary header set by whatever set
            // their non-default language.
            wfDebug( __METHOD__ . ": downgrading cache mode 'public' to " .
                "'anon-public-user-private' due to uselang=user" );
            $mode = 'anon-public-user-private';
        }
 
        wfDebug( __METHOD__ . ": setting cache mode $mode" );
        $this->mCacheMode = $mode;
    }
 
    public function setCacheControl( $directives ) {
        $this->mCacheControl = $directives + $this->mCacheControl;
    }
 
    public function createPrinterByName( $format ) {
        $printer = $this->mModuleMgr->getModule( $format, 'format', /* $ignoreCache */ true );
        if ( $printer === null ) {
            $this->dieWithError(
                [ 'apierror-unknownformat', wfEscapeWikiText( $format ) ], 'unknown_format'
            );
        }
 
        return $printer;
    }
 
    public function execute() {
        if ( $this->mInternalMode ) {
            $this->executeAction();
        } else {
            $this->executeActionWithErrorHandling();
        }
    }
 
    protected function executeActionWithErrorHandling() {
        // Verify the CORS header before executing the action
        if ( !$this->handleCORS() ) {
            // handleCORS() has sent a 403, abort
            return;
        }
 
        // Exit here if the request method was OPTIONS
        // (assume there will be a followup GET or POST)
        if ( $this->getRequest()->getMethod() === 'OPTIONS' ) {
            return;
        }
 
        // In case an error occurs during data output,
        // clear the output buffer and print just the error information
        $obLevel = ob_get_level();
        ob_start();
 
        $t = microtime( true );
        $isError = false;
        try {
            $this->executeAction();
            $runTime = microtime( true ) - $t;
            $this->logRequest( $runTime );
            MediaWikiServices::getInstance()->getStatsdDataFactory()->timing(
                'api.' . $this->mModule->getModuleName() . '.executeTiming', 1000 * $runTime
            );
        } catch ( Throwable $e ) {
            $this->handleException( $e );
            $this->logRequest( microtime( true ) - $t, $e );
            $isError = true;
        }
 
        // Disable the client cache on the output so that BlockManager::trackBlockWithCookie is executed
        // as part of MediaWiki::preOutputCommit().
        if (
            $this->mCacheMode === 'private'
            || (
                $this->mCacheMode === 'anon-public-user-private'
                && SessionManager::getGlobalSession()->isPersistent()
            )
        ) {
            $this->getContext()->getOutput()->enableClientCache( false );
            $this->getContext()->getOutput()->considerCacheSettingsFinal();
        }
 
        // Commit DBs and send any related cookies and headers
        MediaWiki::preOutputCommit( $this->getContext() );
 
        // Send cache headers after any code which might generate an error, to
        // avoid sending public cache headers for errors.
        $this->sendCacheHeaders( $isError );
 
        // Executing the action might have already messed with the output
        // buffers.
        while ( ob_get_level() > $obLevel ) {
            ob_end_flush();
        }
    }
 
    protected function handleException( Throwable $e ) {
        // T65145: Rollback any open database transactions
        if ( !$e instanceof ApiUsageException ) {
            // ApiUsageExceptions are intentional, so don't rollback if that's the case
            MWExceptionHandler::rollbackMasterChangesAndLog(
                $e,
                MWExceptionHandler::CAUGHT_BY_ENTRYPOINT
            );
        }
 
        // Allow extra cleanup and logging
        $this->getHookRunner()->onApiMain__onException( $this, $e );
 
        // Handle any kind of exception by outputting properly formatted error message.
        // If this fails, an unhandled exception should be thrown so that global error
        // handler will process and log it.
 
        $errCodes = $this->substituteResultWithError( $e );
 
        // Error results should not be cached
        $this->setCacheMode( 'private' );
 
        $response = $this->getRequest()->response();
        $headerStr = 'MediaWiki-API-Error: ' . implode( ', ', $errCodes );
        $response->header( $headerStr );
 
        // Reset and print just the error message
        ob_clean();
 
        // Printer may not be initialized if the extractRequestParams() fails for the main module
        $this->createErrorPrinter();
 
        // Get desired HTTP code from an ApiUsageException. Don't use codes from other
        // exception types, as they are unlikely to be intended as an HTTP code.
        $httpCode = $e instanceof ApiUsageException ? $e->getCode() : 0;
 
        $failed = false;
        try {
            $this->printResult( $httpCode );
        } catch ( ApiUsageException $ex ) {
            // The error printer itself is failing. Try suppressing its request
            // parameters and redo.
            $failed = true;
            $this->addWarning( 'apiwarn-errorprinterfailed' );
            foreach ( $ex->getStatusValue()->getErrors() as $error ) {
                try {
                    $this->mPrinter->addWarning( $error );
                } catch ( Throwable $ex2 ) {
                    // WTF?
                    $this->addWarning( $error );
                }
            }
        }
        if ( $failed ) {
            $this->mPrinter = null;
            $this->createErrorPrinter();
            $this->mPrinter->forceDefaultParams();
            if ( $httpCode ) {
                $response->statusHeader( 200 ); // Reset in case the fallback doesn't want a non-200
            }
            $this->printResult( $httpCode );
        }
    }
 
    public static function handleApiBeforeMainException( Throwable $e ) {
        ob_start();
 
        try {
            $main = new self( RequestContext::getMain(), false );
            $main->handleException( $e );
            $main->logRequest( 0, $e );
        } catch ( Throwable $e2 ) {
            // Nope, even that didn't work. Punt.
            throw $e;
        }
 
        // Reset cache headers
        $main->sendCacheHeaders( true );
 
        ob_end_flush();
    }
 
    protected function handleCORS() {
        $originParam = $this->getParameter( 'origin' ); // defaults to null
        if ( $originParam === null ) {
            // No origin parameter, nothing to do
            return true;
        }
 
        $request = $this->getRequest();
        $response = $request->response();
 
        $allowTiming = false;
        $varyOrigin = true;
 
        if ( $originParam === '*' ) {
            // Request for anonymous CORS
            // Technically we should check for the presence of an Origin header
            // and not process it as CORS if it's not set, but that would
            // require us to vary on Origin for all 'origin=*' requests which
            // we don't want to do.
            $matchedOrigin = true;
            $allowOrigin = '*';
            $allowCredentials = 'false';
            $varyOrigin = false; // No need to vary
        } else {
            // Non-anonymous CORS, check we allow the domain
 
            // Origin: header is a space-separated list of origins, check all of them
            $originHeader = $request->getHeader( 'Origin' );
            if ( $originHeader === false ) {
                $origins = [];
            } else {
                $originHeader = trim( $originHeader );
                $origins = preg_split( '/\s+/', $originHeader );
            }
 
            if ( !in_array( $originParam, $origins ) ) {
                // origin parameter set but incorrect
                // Send a 403 response
                $response->statusHeader( 403 );
                $response->header( 'Cache-Control: no-cache' );
                echo "'origin' parameter does not match Origin header\n";
 
                return false;
            }
 
            $config = $this->getConfig();
            $matchedOrigin = count( $origins ) === 1 && self::matchOrigin(
                $originParam,
                $config->get( 'CrossSiteAJAXdomains' ),
                $config->get( 'CrossSiteAJAXdomainExceptions' )
            );
 
            $allowOrigin = $originHeader;
            $allowCredentials = 'true';
            $allowTiming = $originHeader;
        }
 
        if ( $matchedOrigin ) {
            $requestedMethod = $request->getHeader( 'Access-Control-Request-Method' );
            $preflight = $request->getMethod() === 'OPTIONS' && $requestedMethod !== false;
            if ( $preflight ) {
                // This is a CORS preflight request
                if ( $requestedMethod !== 'POST' && $requestedMethod !== 'GET' ) {
                    // If method is not a case-sensitive match, do not set any additional headers and terminate.
                    $response->header( 'MediaWiki-CORS-Rejection: Unsupported method requested in preflight' );
                    return true;
                }
                // We allow the actual request to send the following headers
                $requestedHeaders = $request->getHeader( 'Access-Control-Request-Headers' );
                $allowedHeaders = $this->getConfig()->get( 'AllowedCorsHeaders' );
                if ( $requestedHeaders !== false ) {
                    if ( !self::matchRequestedHeaders( $requestedHeaders, $allowedHeaders ) ) {
                        $response->header( 'MediaWiki-CORS-Rejection: Unsupported header requested in preflight' );
                        return true;
                    }
                    $response->header( 'Access-Control-Allow-Headers: ' . $requestedHeaders );
                }
 
                // We only allow the actual request to be GET or POST
                $response->header( 'Access-Control-Allow-Methods: POST, GET' );
            } elseif ( $request->getMethod() !== 'POST' && $request->getMethod() !== 'GET' ) {
                // Unsupported non-preflight method, don't handle it as CORS
                $response->header(
                    'MediaWiki-CORS-Rejection: Unsupported method for simple request or actual request'
                );
                return true;
            }
 
            $response->header( "Access-Control-Allow-Origin: $allowOrigin" );
            $response->header( "Access-Control-Allow-Credentials: $allowCredentials" );
            // https://www.w3.org/TR/resource-timing/#timing-allow-origin
            if ( $allowTiming !== false ) {
                $response->header( "Timing-Allow-Origin: $allowTiming" );
            }
 
            if ( !$preflight ) {
                $response->header(
                    'Access-Control-Expose-Headers: MediaWiki-API-Error, Retry-After, X-Database-Lag, '
                    . 'MediaWiki-Login-Suppressed'
                );
            }
        } else {
            $response->header( 'MediaWiki-CORS-Rejection: Origin mismatch' );
        }
 
        if ( $varyOrigin ) {
            $this->getOutput()->addVaryHeader( 'Origin' );
        }
 
        return true;
    }
 
    protected static function matchOrigin( $value, $rules, $exceptions ) {
        foreach ( $rules as $rule ) {
            if ( preg_match( self::wildcardToRegex( $rule ), $value ) ) {
                // Rule matches, check exceptions
                foreach ( $exceptions as $exc ) {
                    if ( preg_match( self::wildcardToRegex( $exc ), $value ) ) {
                        return false;
                    }
                }
 
                return true;
            }
        }
 
        return false;
    }
 
    protected static function matchRequestedHeaders( $requestedHeaders, $allowedHeaders ) {
        if ( trim( $requestedHeaders ) === '' ) {
            return true;
        }
        $requestedHeaders = explode( ',', $requestedHeaders );
        $allowedHeaders = array_change_key_case( array_flip( $allowedHeaders ), CASE_LOWER );
        foreach ( $requestedHeaders as $rHeader ) {
            $rHeader = strtolower( trim( $rHeader ) );
            if ( !isset( $allowedHeaders[$rHeader] ) ) {
                LoggerFactory::getInstance( 'api-warning' )->warning(
                    'CORS preflight failed on requested header: {header}', [
                        'header' => $rHeader
                    ]
                );
                return false;
            }
        }
        return true;
    }
 
    protected static function wildcardToRegex( $wildcard ) {
        $wildcard = preg_quote( $wildcard, '/' );
        $wildcard = str_replace(
            [ '\*', '\?' ],
            [ '.*?', '.' ],
            $wildcard
        );
 
        return "/^https?:\/\/$wildcard$/";
    }
 
    protected function sendCacheHeaders( $isError ) {
        $response = $this->getRequest()->response();
        $out = $this->getOutput();
 
        $out->addVaryHeader( 'Treat-as-Untrusted' );
 
        $config = $this->getConfig();
 
        if ( $config->get( 'VaryOnXFP' ) ) {
            $out->addVaryHeader( 'X-Forwarded-Proto' );
        }
 
        if ( !$isError && $this->mModule &&
            ( $this->getRequest()->getMethod() === 'GET' || $this->getRequest()->getMethod() === 'HEAD' )
        ) {
            $etag = $this->mModule->getConditionalRequestData( 'etag' );
            if ( $etag !== null ) {
                $response->header( "ETag: $etag" );
            }
            $lastMod = $this->mModule->getConditionalRequestData( 'last-modified' );
            if ( $lastMod !== null ) {
                $response->header( 'Last-Modified: ' . wfTimestamp( TS_RFC2822, $lastMod ) );
            }
        }
 
        // The logic should be:
        // $this->mCacheControl['max-age'] is set?
        //    Use it, the module knows better than our guess.
        // !$this->mModule || $this->mModule->isWriteMode(), and mCacheMode is private?
        //    Use 0 because we can guess caching is probably the wrong thing to do.
        // Use $this->getParameter( 'maxage' ), which already defaults to 0.
        $maxage = 0;
        if ( isset( $this->mCacheControl['max-age'] ) ) {
            $maxage = $this->mCacheControl['max-age'];
        } elseif ( ( $this->mModule && !$this->mModule->isWriteMode() ) ||
            $this->mCacheMode !== 'private'
        ) {
            $maxage = $this->getParameter( 'maxage' );
        }
        $privateCache = 'private, must-revalidate, max-age=' . $maxage;
 
        if ( $this->mCacheMode == 'private' ) {
            $response->header( "Cache-Control: $privateCache" );
            return;
        }
 
        if ( $this->mCacheMode == 'anon-public-user-private' ) {
            $out->addVaryHeader( 'Cookie' );
            $response->header( $out->getVaryHeader() );
            if ( SessionManager::getGlobalSession()->isPersistent() ) {
                // Logged in or otherwise has session (e.g. anonymous users who have edited)
                // Mark request private
                $response->header( "Cache-Control: $privateCache" );
 
                return;
            } // else anonymous, send public headers below
        }
 
        // Send public headers
        $response->header( $out->getVaryHeader() );
 
        // If nobody called setCacheMaxAge(), use the (s)maxage parameters
        if ( !isset( $this->mCacheControl['s-maxage'] ) ) {
            $this->mCacheControl['s-maxage'] = $this->getParameter( 'smaxage' );
        }
        if ( !isset( $this->mCacheControl['max-age'] ) ) {
            $this->mCacheControl['max-age'] = $this->getParameter( 'maxage' );
        }
 
        if ( !$this->mCacheControl['s-maxage'] && !$this->mCacheControl['max-age'] ) {
            // Public cache not requested
            // Sending a Vary header in this case is harmless, and protects us
            // against conditional calls of setCacheMaxAge().
            $response->header( "Cache-Control: $privateCache" );
 
            return;
        }
 
        $this->mCacheControl['public'] = true;
 
        // Send an Expires header
        $maxAge = min( $this->mCacheControl['s-maxage'], $this->mCacheControl['max-age'] );
        $expiryUnixTime = ( $maxAge == 0 ? 1 : time() + $maxAge );
        $response->header( 'Expires: ' . wfTimestamp( TS_RFC2822, $expiryUnixTime ) );
 
        // Construct the Cache-Control header
        $ccHeader = '';
        $separator = '';
        foreach ( $this->mCacheControl as $name => $value ) {
            if ( is_bool( $value ) ) {
                if ( $value ) {
                    $ccHeader .= $separator . $name;
                    $separator = ', ';
                }
            } else {
                $ccHeader .= $separator . "$name=$value";
                $separator = ', ';
            }
        }
 
        $response->header( "Cache-Control: $ccHeader" );
    }
 
    private function createErrorPrinter() {
        if ( !isset( $this->mPrinter ) ) {
            $value = $this->getRequest()->getVal( 'format', self::API_DEFAULT_FORMAT );
            if ( !$this->mModuleMgr->isDefined( $value, 'format' ) ) {
                $value = self::API_DEFAULT_FORMAT;
            }
            $this->mPrinter = $this->createPrinterByName( $value );
        }
 
        // Printer may not be able to handle errors. This is particularly
        // likely if the module returns something for getCustomPrinter().
        if ( !$this->mPrinter->canPrintErrors() ) {
            $this->mPrinter = $this->createPrinterByName( self::API_DEFAULT_FORMAT );
        }
    }
 
    protected function errorMessagesFromException( Throwable $e, $type = 'error' ) {
        $messages = [];
        if ( $e instanceof ApiUsageException ) {
            foreach ( $e->getStatusValue()->getErrorsByType( $type ) as $error ) {
                $messages[] = ApiMessage::create( $error );
            }
        } elseif ( $type !== 'error' ) {
            // None of the rest have any messages for non-error types
        } else {
            // Something is seriously wrong
            $config = $this->getConfig();
            // TODO: Avoid embedding arbitrary class names in the error code.
            $class = preg_replace( '#^Wikimedia\\\Rdbms\\\#', '', get_class( $e ) );
            $code = 'internal_api_error_' . $class;
            $data = [ 'errorclass' => get_class( $e ) ];
            if ( $config->get( 'ShowExceptionDetails' ) ) {
                if ( $e instanceof ILocalizedException ) {
                    $msg = $e->getMessageObject();
                } elseif ( $e instanceof MessageSpecifier ) {
                    $msg = Message::newFromSpecifier( $e );
                } else {
                    $msg = wfEscapeWikiText( $e->getMessage() );
                }
                $params = [ 'apierror-exceptioncaught', WebRequest::getRequestId(), $msg ];
            } else {
                $params = [ 'apierror-exceptioncaughttype', WebRequest::getRequestId(), get_class( $e ) ];
            }
 
            $messages[] = ApiMessage::create( $params, $code, $data );
        }
        return $messages;
    }
 
    protected function substituteResultWithError( Throwable $e ) {
        $result = $this->getResult();
        $formatter = $this->getErrorFormatter();
        $config = $this->getConfig();
        $errorCodes = [];
 
        // Remember existing warnings and errors across the reset
        $errors = $result->getResultData( [ 'errors' ] );
        $warnings = $result->getResultData( [ 'warnings' ] );
        $result->reset();
        if ( $warnings !== null ) {
            $result->addValue( null, 'warnings', $warnings, ApiResult::NO_SIZE_CHECK );
        }
        if ( $errors !== null ) {
            $result->addValue( null, 'errors', $errors, ApiResult::NO_SIZE_CHECK );
 
            // Collect the copied error codes for the return value
            foreach ( $errors as $error ) {
                if ( isset( $error['code'] ) ) {
                    $errorCodes[$error['code']] = true;
                }
            }
        }
 
        // Add errors from the exception
        $modulePath = $e instanceof ApiUsageException ? $e->getModulePath() : null;
        foreach ( $this->errorMessagesFromException( $e, 'error' ) as $msg ) {
            if ( ApiErrorFormatter::isValidApiCode( $msg->getApiCode() ) ) {
                $errorCodes[$msg->getApiCode()] = true;
            } else {
                LoggerFactory::getInstance( 'api-warning' )->error( 'Invalid API error code "{code}"', [
                    'code' => $msg->getApiCode(),
                    'exception' => $e,
                ] );
                $errorCodes['<invalid-code>'] = true;
            }
            $formatter->addError( $modulePath, $msg );
        }
        foreach ( $this->errorMessagesFromException( $e, 'warning' ) as $msg ) {
            $formatter->addWarning( $modulePath, $msg );
        }
 
        // Add additional data. Path depends on whether we're in BC mode or not.
        // Data depends on the type of exception.
        if ( $formatter instanceof ApiErrorFormatter_BackCompat ) {
            $path = [ 'error' ];
        } else {
            $path = null;
        }
        if ( $e instanceof ApiUsageException ) {
            $link = wfExpandUrl( wfScript( 'api' ) );
            $result->addContentValue(
                $path,
                'docref',
                trim(
                    $this->msg( 'api-usage-docref', $link )->inLanguage( $formatter->getLanguage() )->text()
                    . ' '
                    . $this->msg( 'api-usage-mailinglist-ref' )->inLanguage( $formatter->getLanguage() )->text()
                )
            );
        } elseif ( $config->get( 'ShowExceptionDetails' ) ) {
            $result->addContentValue(
                $path,
                'trace',
                $this->msg( 'api-exception-trace',
                    get_class( $e ),
                    $e->getFile(),
                    $e->getLine(),
                    MWExceptionHandler::getRedactedTraceAsString( $e )
                )->inLanguage( $formatter->getLanguage() )->text()
            );
        }
 
        // Add the id and such
        $this->addRequestedFields( [ 'servedby' ] );
 
        return array_keys( $errorCodes );
    }
 
    protected function addRequestedFields( $force = [] ) {
        $result = $this->getResult();
 
        $requestid = $this->getParameter( 'requestid' );
        if ( $requestid !== null ) {
            $result->addValue( null, 'requestid', $requestid, ApiResult::NO_SIZE_CHECK );
        }
 
        if ( $this->getConfig()->get( 'ShowHostnames' ) && (
            in_array( 'servedby', $force, true ) || $this->getParameter( 'servedby' )
        ) ) {
            $result->addValue( null, 'servedby', wfHostname(), ApiResult::NO_SIZE_CHECK );
        }
 
        if ( $this->getParameter( 'curtimestamp' ) ) {
            $result->addValue( null, 'curtimestamp', wfTimestamp( TS_ISO_8601 ), ApiResult::NO_SIZE_CHECK );
        }
 
        if ( $this->getParameter( 'responselanginfo' ) ) {
            $result->addValue( null, 'uselang', $this->getLanguage()->getCode(),
                ApiResult::NO_SIZE_CHECK );
            $result->addValue( null, 'errorlang', $this->getErrorFormatter()->getLanguage()->getCode(),
                ApiResult::NO_SIZE_CHECK );
        }
    }
 
    protected function setupExecuteAction() {
        $this->addRequestedFields();
 
        $params = $this->extractRequestParams();
        $this->mAction = $params['action'];
 
        return $params;
    }
 
    protected function setupModule() {
        // Instantiate the module requested by the user
        $module = $this->mModuleMgr->getModule( $this->mAction, 'action' );
        if ( $module === null ) {
            // Probably can't happen
            // @codeCoverageIgnoreStart
            $this->dieWithError(
                [ 'apierror-unknownaction', wfEscapeWikiText( $this->mAction ) ], 'unknown_action'
            );
            // @codeCoverageIgnoreEnd
        }
        $moduleParams = $module->extractRequestParams();
 
        // Check token, if necessary
        if ( $module->needsToken() === true ) {
            throw new MWException(
                "Module '{$module->getModuleName()}' must be updated for the new token handling. " .
                'See documentation for ApiBase::needsToken for details.'
            );
        }
        if ( $module->needsToken() ) {
            if ( !$module->mustBePosted() ) {
                throw new MWException(
                    "Module '{$module->getModuleName()}' must require POST to use tokens."
                );
            }
 
            if ( !isset( $moduleParams['token'] ) ) {
                // Probably can't happen
                // @codeCoverageIgnoreStart
                $module->dieWithError( [ 'apierror-missingparam', 'token' ] );
                // @codeCoverageIgnoreEnd
            }
 
            $module->requirePostedParameters( [ 'token' ] );
 
            if ( !$module->validateToken( $moduleParams['token'], $moduleParams ) ) {
                $module->dieWithError( 'apierror-badtoken' );
            }
        }
 
        return $module;
    }
 
    private function getMaxLag() {
        $dbLag = MediaWikiServices::getInstance()->getDBLoadBalancer()->getMaxLag();
        $lagInfo = [
            'host' => $dbLag[0],
            'lag' => $dbLag[1],
            'type' => 'db'
        ];
 
        $jobQueueLagFactor = $this->getConfig()->get( 'JobQueueIncludeInMaxLagFactor' );
        if ( $jobQueueLagFactor ) {
            // Turn total number of jobs into seconds by using the configured value
            $totalJobs = array_sum( JobQueueGroup::singleton()->getQueueSizes() );
            $jobQueueLag = $totalJobs / (float)$jobQueueLagFactor;
            if ( $jobQueueLag > $lagInfo['lag'] ) {
                $lagInfo = [
                    'host' => wfHostname(), // XXX: Is there a better value that could be used?
                    'lag' => $jobQueueLag,
                    'type' => 'jobqueue',
                    'jobs' => $totalJobs,
                ];
            }
        }
 
        $this->getHookRunner()->onApiMaxLagInfo( $lagInfo );
 
        return $lagInfo;
    }
 
    protected function checkMaxLag( $module, $params ) {
        if ( $module->shouldCheckMaxlag() && isset( $params['maxlag'] ) ) {
            $maxLag = $params['maxlag'];
            $lagInfo = $this->getMaxLag();
            if ( $lagInfo['lag'] > $maxLag ) {
                $response = $this->getRequest()->response();
 
                $response->header( 'Retry-After: ' . max( (int)$maxLag, 5 ) );
                $response->header( 'X-Database-Lag: ' . (int)$lagInfo['lag'] );
 
                if ( $this->getConfig()->get( 'ShowHostnames' ) ) {
                    $this->dieWithError(
                        [ 'apierror-maxlag', $lagInfo['lag'], $lagInfo['host'] ],
                        'maxlag',
                        $lagInfo
                    );
                }
 
                $this->dieWithError( [ 'apierror-maxlag-generic', $lagInfo['lag'] ], 'maxlag', $lagInfo );
            }
        }
 
        return true;
    }
 
    protected function checkConditionalRequestHeaders( $module ) {
        if ( $this->mInternalMode ) {
            // No headers to check in internal mode
            return true;
        }
 
        if ( $this->getRequest()->getMethod() !== 'GET' && $this->getRequest()->getMethod() !== 'HEAD' ) {
            // Don't check POSTs
            return true;
        }
 
        $return304 = false;
 
        $ifNoneMatch = array_diff(
            $this->getRequest()->getHeader( 'If-None-Match', WebRequest::GETHEADER_LIST ) ?: [],
            [ '' ]
        );
        if ( $ifNoneMatch ) {
            // @phan-suppress-next-line PhanImpossibleTypeComparison
            if ( $ifNoneMatch === [ '*' ] ) {
                // API responses always "exist"
                $etag = '*';
            } else {
                $etag = $module->getConditionalRequestData( 'etag' );
            }
        }
        if ( $ifNoneMatch && $etag !== null ) {
            $test = substr( $etag, 0, 2 ) === 'W/' ? substr( $etag, 2 ) : $etag;
            $match = array_map( function ( $s ) {
                return substr( $s, 0, 2 ) === 'W/' ? substr( $s, 2 ) : $s;
            }, $ifNoneMatch );
            $return304 = in_array( $test, $match, true );
        } else {
            $value = trim( $this->getRequest()->getHeader( 'If-Modified-Since' ) );
 
            // Some old browsers sends sizes after the date, like this:
            //  Wed, 20 Aug 2003 06:51:19 GMT; length=5202
            // Ignore that.
            $i = strpos( $value, ';' );
            if ( $i !== false ) {
                $value = trim( substr( $value, 0, $i ) );
            }
 
            if ( $value !== '' ) {
                try {
                    $ts = new MWTimestamp( $value );
                    if (
                        // RFC 7231 IMF-fixdate
                        $ts->getTimestamp( TS_RFC2822 ) === $value ||
                        // RFC 850
                        $ts->format( 'l, d-M-y H:i:s' ) . ' GMT' === $value ||
                        // asctime (with and without space-padded day)
                        $ts->format( 'D M j H:i:s Y' ) === $value ||
                        $ts->format( 'D M  j H:i:s Y' ) === $value
                    ) {
                        $config = $this->getConfig();
                        $lastMod = $module->getConditionalRequestData( 'last-modified' );
                        if ( $lastMod !== null ) {
                            // Mix in some MediaWiki modification times
                            $modifiedTimes = [
                                'page' => $lastMod,
                                'user' => $this->getUser()->getTouched(),
                                'epoch' => $config->get( 'CacheEpoch' ),
                            ];
 
                            if ( $config->get( 'UseCdn' ) ) {
                                // T46570: the core page itself may not change, but resources might
                                $modifiedTimes['sepoch'] = wfTimestamp(
                                    TS_MW, time() - $config->get( 'CdnMaxAge' )
                                );
                            }
                            $this->getHookRunner()->onOutputPageCheckLastModified( $modifiedTimes, $this->getOutput() );
                            $lastMod = max( $modifiedTimes );
                            $return304 = wfTimestamp( TS_MW, $lastMod ) <= $ts->getTimestamp( TS_MW );
                        }
                    }
                } catch ( TimestampException $e ) {
                    // Invalid timestamp, ignore it
                }
            }
        }
 
        if ( $return304 ) {
            $this->getRequest()->response()->statusHeader( 304 );
 
            // Avoid outputting the compressed representation of a zero-length body
            Wikimedia\suppressWarnings();
            ini_set( 'zlib.output_compression', 0 );
            Wikimedia\restoreWarnings();
            wfClearOutputBuffers();
 
            return false;
        }
 
        return true;
    }
 
    protected function checkExecutePermissions( $module ) {
        $user = $this->getUser();
        if ( $module->isReadMode() && !$this->getPermissionManager()->isEveryoneAllowed( 'read' ) &&
            !$this->getPermissionManager()->userHasRight( $user, 'read' )
        ) {
            $this->dieWithError( 'apierror-readapidenied' );
        }
 
        if ( $module->isWriteMode() ) {
            if ( !$this->mEnableWrite ) {
                $this->dieWithError( 'apierror-noapiwrite' );
            } elseif ( !$this->getPermissionManager()->userHasRight( $user, 'writeapi' ) ) {
                $this->dieWithError( 'apierror-writeapidenied' );
            } elseif ( $this->getRequest()->getHeader( 'Promise-Non-Write-API-Action' ) ) {
                $this->dieWithError( 'apierror-promised-nonwrite-api' );
            }
 
            $this->checkReadOnly( $module );
        }
 
        // Allow extensions to stop execution for arbitrary reasons.
        $message = 'hookaborted';
        if ( !$this->getHookRunner()->onApiCheckCanExecute( $module, $user, $message ) ) {
            $this->dieWithError( $message );
        }
    }
 
    protected function checkReadOnly( $module ) {
        if ( wfReadOnly() ) {
            $this->dieReadOnly();
        }
 
        if ( $module->isWriteMode()
            && $this->getUser()->isBot()
            && MediaWikiServices::getInstance()->getDBLoadBalancer()->getServerCount() > 1
        ) {
            $this->checkBotReadOnly();
        }
    }
 
    private function checkBotReadOnly() {
        // Figure out how many servers have passed the lag threshold
        $numLagged = 0;
        $lagLimit = $this->getConfig()->get( 'APIMaxLagThreshold' );
        $laggedServers = [];
        $loadBalancer = MediaWikiServices::getInstance()->getDBLoadBalancer();
        foreach ( $loadBalancer->getLagTimes() as $serverIndex => $lag ) {
            if ( $lag > $lagLimit ) {
                ++$numLagged;
                $laggedServers[] = $loadBalancer->getServerName( $serverIndex ) . " ({$lag}s)";
            }
        }
 
        // If a majority of replica DBs are too lagged then disallow writes
        $replicaCount = $loadBalancer->getServerCount() - 1;
        if ( $numLagged >= ceil( $replicaCount / 2 ) ) {
            $laggedServers = implode( ', ', $laggedServers );
            wfDebugLog(
                'api-readonly', // Deprecate this channel in favor of api-warning?
                "Api request failed as read only because the following DBs are lagged: $laggedServers"
            );
            LoggerFactory::getInstance( 'api-warning' )->warning(
                "Api request failed as read only because the following DBs are lagged: {laggeddbs}", [
                    'laggeddbs' => $laggedServers,
                ]
            );
 
            $this->dieWithError(
                'readonly_lag',
                'readonly',
                [ 'readonlyreason' => "Waiting for $numLagged lagged database(s)" ]
            );
        }
    }
 
    protected function checkAsserts( $params ) {
        if ( isset( $params['assert'] ) ) {
            $user = $this->getUser();
            switch ( $params['assert'] ) {
                case 'anon':
                    if ( !$user->isAnon() ) {
                        $this->dieWithError( 'apierror-assertanonfailed' );
                    }
                    break;
                case 'user':
                    if ( $user->isAnon() ) {
                        $this->dieWithError( 'apierror-assertuserfailed' );
                    }
                    break;
                case 'bot':
                    if ( !$this->getPermissionManager()->userHasRight( $user, 'bot' ) ) {
                        $this->dieWithError( 'apierror-assertbotfailed' );
                    }
                    break;
            }
        }
        if ( isset( $params['assertuser'] ) ) {
            $assertUser = User::newFromName( $params['assertuser'], false );
            if ( !$assertUser || !$this->getUser()->equals( $assertUser ) ) {
                $this->dieWithError(
                    [ 'apierror-assertnameduserfailed', wfEscapeWikiText( $params['assertuser'] ) ]
                );
            }
        }
    }
 
    protected function setupExternalResponse( $module, $params ) {
        $validMethods = [ 'GET', 'HEAD', 'POST', 'OPTIONS' ];
        $request = $this->getRequest();
 
        if ( !in_array( $request->getMethod(), $validMethods ) ) {
            $this->dieWithError( 'apierror-invalidmethod', null, null, 405 );
        }
 
        if ( !$request->wasPosted() && $module->mustBePosted() ) {
            // Module requires POST. GET request might still be allowed
            // if $wgDebugApi is true, otherwise fail.
            $this->dieWithErrorOrDebug( [ 'apierror-mustbeposted', $this->mAction ] );
        }
 
        if ( $request->wasPosted() && !$request->getHeader( 'Content-Type' ) ) {
            $this->addDeprecation(
                'apiwarn-deprecation-post-without-content-type', 'post-without-content-type'
            );
        }
 
        // See if custom printer is used
        $this->mPrinter = $module->getCustomPrinter();
        if ( $this->mPrinter === null ) {
            // Create an appropriate printer
            $this->mPrinter = $this->createPrinterByName( $params['format'] );
        }
 
        if ( $request->getProtocol() === 'http' &&
            (
                $this->getConfig()->get( 'ForceHTTPS' ) ||
                $request->getSession()->shouldForceHTTPS() ||
                ( $this->getUser()->isLoggedIn() &&
                    $this->getUser()->requiresHTTPS() )
            )
        ) {
            $this->addDeprecation( 'apiwarn-deprecation-httpsexpected', 'https-expected' );
        }
    }
 
    protected function executeAction() {
        $params = $this->setupExecuteAction();
 
        // Check asserts early so e.g. errors in parsing a module's parameters due to being
        // logged out don't override the client's intended "am I logged in?" check.
        $this->checkAsserts( $params );
 
        $module = $this->setupModule();
        $this->mModule = $module;
 
        if ( !$this->mInternalMode ) {
            $this->setRequestExpectations( $module );
        }
 
        $this->checkExecutePermissions( $module );
 
        if ( !$this->checkMaxLag( $module, $params ) ) {
            return;
        }
 
        if ( !$this->checkConditionalRequestHeaders( $module ) ) {
            return;
        }
 
        if ( !$this->mInternalMode ) {
            $this->setupExternalResponse( $module, $params );
        }
 
        $module->execute();
        $this->getHookRunner()->onAPIAfterExecute( $module );
 
        $this->reportUnusedParams();
 
        if ( !$this->mInternalMode ) {
            MWDebug::appendDebugInfoToApiResult( $this->getContext(), $this->getResult() );
 
            $this->printResult();
        }
    }
 
    protected function setRequestExpectations( ApiBase $module ) {
        $limits = $this->getConfig()->get( 'TrxProfilerLimits' );
        $trxProfiler = Profiler::instance()->getTransactionProfiler();
        $trxProfiler->setLogger( LoggerFactory::getInstance( 'DBPerformance' ) );
        if ( $this->getRequest()->hasSafeMethod() ) {
            $trxProfiler->setExpectations( $limits['GET'], __METHOD__ );
        } elseif ( $this->getRequest()->wasPosted() && !$module->isWriteMode() ) {
            $trxProfiler->setExpectations( $limits['POST-nonwrite'], __METHOD__ );
            $this->getRequest()->markAsSafeRequest();
        } else {
            $trxProfiler->setExpectations( $limits['POST'], __METHOD__ );
        }
    }
 
    protected function logRequest( $time, Throwable $e = null ) {
        $request = $this->getRequest();
 
        $logCtx = [
            // https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/event-schemas/+/master/jsonschema/mediawiki/api/request
            '$schema' => '/mediawiki/api/request/0.0.1',
            'meta' => [
                'request_id' => WebRequest::getRequestId(),
                'id' => MediaWikiServices::getInstance()
                    ->getGlobalIdGenerator()->newUUIDv4(),
                'dt' => wfTimestamp( TS_ISO_8601 ),
                'domain' => $this->getConfig()->get( 'ServerName' ),
                // If using the EventBus extension (as intended) with this log channel,
                // this stream name will map to a Kafka topic.
                'stream' => 'mediawiki.api-request'
            ],
            'http' => [
                'method' => $request->getMethod(),
                'client_ip' => $request->getIP()
            ],
            'database' => WikiMap::getCurrentWikiDbDomain()->getId(),
            'backend_time_ms' => (int)round( $time * 1000 ),
        ];
 
        // If set, these headers will be logged in http.request_headers.
        $httpRequestHeadersToLog = [ 'accept-language', 'referer', 'user-agent' ];
        foreach ( $httpRequestHeadersToLog as $header ) {
            if ( $request->getHeader( $header ) ) {
                // Set the header in http.request_headers
                $logCtx['http']['request_headers'][$header] = $request->getHeader( $header );
            }
        }
 
        if ( $e ) {
            $logCtx['api_error_codes'] = [];
            foreach ( $this->errorMessagesFromException( $e ) as $msg ) {
                $logCtx['api_error_codes'][] = $msg->getApiCode();
            }
        }
 
        // Construct space separated message for 'api' log channel
        $msg = "API {$request->getMethod()} " .
            wfUrlencode( str_replace( ' ', '_', $this->getUser()->getName() ) ) .
            " {$logCtx['http']['client_ip']} " .
            "T={$logCtx['backend_time_ms']}ms";
 
        $sensitive = array_flip( $this->getSensitiveParams() );
        foreach ( $this->getParamsUsed() as $name ) {
            $value = $request->getVal( $name );
            if ( $value === null ) {
                continue;
            }
 
            if ( isset( $sensitive[$name] ) ) {
                $value = '[redacted]';
                $encValue = '[redacted]';
            } elseif ( strlen( $value ) > 256 ) {
                $value = substr( $value, 0, 256 );
                $encValue = $this->encodeRequestLogValue( $value ) . '[...]';
            } else {
                $encValue = $this->encodeRequestLogValue( $value );
            }
 
            $logCtx['params'][$name] = $value;
            $msg .= " {$name}={$encValue}";
        }
 
        // Log an unstructured message to the api channel.
        wfDebugLog( 'api', $msg, 'private' );
 
        // The api-request channel a structured data log channel.
        wfDebugLog( 'api-request', '', 'private', $logCtx );
    }
 
    protected function encodeRequestLogValue( $s ) {
        static $table = [];
        if ( !$table ) {
            $chars = ';@$!*(),/:';
            $numChars = strlen( $chars );
            for ( $i = 0; $i < $numChars; $i++ ) {
                $table[rawurlencode( $chars[$i] )] = $chars[$i];
            }
        }
 
        return strtr( rawurlencode( $s ), $table );
    }
 
    protected function getParamsUsed() {
        return array_keys( $this->mParamsUsed );
    }
 
    public function markParamsUsed( $params ) {
        $this->mParamsUsed += array_fill_keys( (array)$params, true );
    }
 
    protected function getSensitiveParams() {
        return array_keys( $this->mParamsSensitive );
    }
 
    public function markParamsSensitive( $params ) {
        $this->mParamsSensitive += array_fill_keys( (array)$params, true );
    }
 
    public function getVal( $name, $default = null ) {
        $this->mParamsUsed[$name] = true;
 
        $ret = $this->getRequest()->getVal( $name );
        if ( $ret === null ) {
            if ( $this->getRequest()->getArray( $name ) !== null ) {
                // See T12262 for why we don't just implode( '|', ... ) the
                // array.
                $this->addWarning( [ 'apiwarn-unsupportedarray', $name ] );
            }
            $ret = $default;
        }
        return $ret;
    }
 
    public function getCheck( $name ) {
        $this->mParamsUsed[$name] = true;
        return $this->getRequest()->getCheck( $name );
    }
 
    public function getUpload( $name ) {
        $this->mParamsUsed[$name] = true;
 
        return $this->getRequest()->getUpload( $name );
    }
 
    protected function reportUnusedParams() {
        $paramsUsed = $this->getParamsUsed();
        $allParams = $this->getRequest()->getValueNames();
 
        if ( !$this->mInternalMode ) {
            // Printer has not yet executed; don't warn that its parameters are unused
            $printerParams = $this->mPrinter->encodeParamName(
                array_keys( $this->mPrinter->getFinalParams() ?: [] )
            );
            $unusedParams = array_diff( $allParams, $paramsUsed, $printerParams );
        } else {
            $unusedParams = array_diff( $allParams, $paramsUsed );
        }
 
        if ( count( $unusedParams ) ) {
            $this->addWarning( [
                'apierror-unrecognizedparams',
                Message::listParam( array_map( 'wfEscapeWikiText', $unusedParams ), 'comma' ),
                count( $unusedParams )
            ] );
        }
    }
 
    protected function printResult( $httpCode = 0 ) {
        if ( $this->getConfig()->get( 'DebugAPI' ) !== false ) {
            $this->addWarning( 'apiwarn-wgdebugapi' );
        }
 
        $printer = $this->mPrinter;
        $printer->initPrinter( false );
        if ( $httpCode ) {
            $printer->setHttpStatus( $httpCode );
        }
        $printer->execute();
        $printer->closePrinter();
    }
 
    public function isReadMode() {
        return false;
    }
 
    public function getAllowedParams() {
        return [
            'action' => [
                ApiBase::PARAM_DFLT => 'help',
                ApiBase::PARAM_TYPE => 'submodule',
            ],
            'format' => [
                ApiBase::PARAM_DFLT => self::API_DEFAULT_FORMAT,
                ApiBase::PARAM_TYPE => 'submodule',
            ],
            'maxlag' => [
                ApiBase::PARAM_TYPE => 'integer'
            ],
            'smaxage' => [
                ApiBase::PARAM_TYPE => 'integer',
                ApiBase::PARAM_DFLT => 0
            ],
            'maxage' => [
                ApiBase::PARAM_TYPE => 'integer',
                ApiBase::PARAM_DFLT => 0
            ],
            'assert' => [
                ApiBase::PARAM_TYPE => [ 'anon', 'user', 'bot' ]
            ],
            'assertuser' => [
                ApiBase::PARAM_TYPE => 'user',
                UserDef::PARAM_ALLOWED_USER_TYPES => [ 'name' ],
            ],
            'requestid' => null,
            'servedby' => false,
            'curtimestamp' => false,
            'responselanginfo' => false,
            'origin' => null,
            'uselang' => [
                ApiBase::PARAM_DFLT => self::API_DEFAULT_USELANG,
            ],
            'errorformat' => [
                ApiBase::PARAM_TYPE => [ 'plaintext', 'wikitext', 'html', 'raw', 'none', 'bc' ],
                ApiBase::PARAM_DFLT => 'bc',
            ],
            'errorlang' => [
                ApiBase::PARAM_DFLT => 'uselang',
            ],
            'errorsuselocal' => [
                ApiBase::PARAM_DFLT => false,
            ],
        ];
    }
 
    protected function getExamplesMessages() {
        return [
            'action=help'
                => 'apihelp-help-example-main',
            'action=help&recursivesubmodules=1'
                => 'apihelp-help-example-recursive',
        ];
    }
 
    public function modifyHelp( array &$help, array $options, array &$tocData ) {
        // Wish PHP had an "array_insert_before". Instead, we have to manually
        // reindex the array to get 'permissions' in the right place.
        $oldHelp = $help;
        $help = [];
        foreach ( $oldHelp as $k => $v ) {
            if ( $k === 'submodules' ) {
                $help['permissions'] = '';
            }
            $help[$k] = $v;
        }
        $help['datatypes'] = '';
        $help['templatedparams'] = '';
        $help['credits'] = '';
 
        // Fill 'permissions'
        $help['permissions'] .= Html::openElement( 'div',
            [ 'class' => 'apihelp-block apihelp-permissions' ] );
        $m = $this->msg( 'api-help-permissions' );
        if ( !$m->isDisabled() ) {
            $help['permissions'] .= Html::rawElement( 'div', [ 'class' => 'apihelp-block-head' ],
                $m->numParams( count( self::$mRights ) )->parse()
            );
        }
        $help['permissions'] .= Html::openElement( 'dl' );
        foreach ( self::$mRights as $right => $rightMsg ) {
            $help['permissions'] .= Html::element( 'dt', null, $right );
 
            $rightMsg = $this->msg( $rightMsg['msg'], $rightMsg['params'] )->parse();
            $help['permissions'] .= Html::rawElement( 'dd', null, $rightMsg );
 
            $groups = array_map( function ( $group ) {
                return $group == '*' ? 'all' : $group;
            }, $this->getPermissionManager()->getGroupsWithPermission( $right ) );
 
            $help['permissions'] .= Html::rawElement( 'dd', null,
                $this->msg( 'api-help-permissions-granted-to' )
                    ->numParams( count( $groups ) )
                    ->params( Message::listParam( $groups ) )
                    ->parse()
            );
        }
        $help['permissions'] .= Html::closeElement( 'dl' );
        $help['permissions'] .= Html::closeElement( 'div' );
 
        // Fill 'datatypes', 'templatedparams', and 'credits', if applicable
        if ( empty( $options['nolead'] ) ) {
            $level = $options['headerlevel'];
            $tocnumber = &$options['tocnumber'];
 
            $header = $this->msg( 'api-help-datatypes-header' )->parse();
 
            $id = Sanitizer::escapeIdForAttribute( 'main/datatypes', Sanitizer::ID_PRIMARY );
            $idFallback = Sanitizer::escapeIdForAttribute( 'main/datatypes', Sanitizer::ID_FALLBACK );
            $headline = Linker::makeHeadline( min( 6, $level ),
                ' class="apihelp-header">',
                $id,
                $header,
                '',
                $idFallback
            );
            // Ensure we have a sane anchor
            if ( $id !== 'main/datatypes' && $idFallback !== 'main/datatypes' ) {
                $headline = '<div id="main/datatypes"></div>' . $headline;
            }
            $help['datatypes'] .= $headline;
            $help['datatypes'] .= $this->msg( 'api-help-datatypes-top' )->parseAsBlock();
            $help['datatypes'] .= '<dl>';
            foreach ( $this->getParamValidator()->knownTypes() as $type ) {
                $m = $this->msg( "api-help-datatype-$type" );
                if ( !$m->isDisabled() ) {
                    $id = "main/datatype/$type";
                    $help['datatypes'] .= '<dt id="' . htmlspecialchars( $id ) . '">';
                    $encId = Sanitizer::escapeIdForAttribute( $id, Sanitizer::ID_PRIMARY );
                    if ( $encId !== $id ) {
                        $help['datatypes'] .= '<span id="' . htmlspecialchars( $encId ) . '"></span>';
                    }
                    $encId2 = Sanitizer::escapeIdForAttribute( $id, Sanitizer::ID_FALLBACK );
                    if ( $encId2 !== $id && $encId2 !== $encId ) {
                        $help['datatypes'] .= '<span id="' . htmlspecialchars( $encId2 ) . '"></span>';
                    }
                    $help['datatypes'] .= htmlspecialchars( $type ) . '</dt><dd>' . $m->parseAsBlock() . "</dd>";
                }
            }
            $help['datatypes'] .= '</dl>';
            if ( !isset( $tocData['main/datatypes'] ) ) {
                $tocnumber[$level]++;
                $tocData['main/datatypes'] = [
                    'toclevel' => count( $tocnumber ),
                    'level' => $level,
                    'anchor' => 'main/datatypes',
                    'line' => $header,
                    'number' => implode( '.', $tocnumber ),
                    'index' => false,
                ];
            }
 
            $header = $this->msg( 'api-help-templatedparams-header' )->parse();
 
            $id = Sanitizer::escapeIdForAttribute( 'main/templatedparams', Sanitizer::ID_PRIMARY );
            $idFallback = Sanitizer::escapeIdForAttribute( 'main/templatedparams', Sanitizer::ID_FALLBACK );
            $headline = Linker::makeHeadline( min( 6, $level ),
                ' class="apihelp-header">',
                $id,
                $header,
                '',
                $idFallback
            );
            // Ensure we have a sane anchor
            if ( $id !== 'main/templatedparams' && $idFallback !== 'main/templatedparams' ) {
                $headline = '<div id="main/templatedparams"></div>' . $headline;
            }
            $help['templatedparams'] .= $headline;
            $help['templatedparams'] .= $this->msg( 'api-help-templatedparams' )->parseAsBlock();
            if ( !isset( $tocData['main/templatedparams'] ) ) {
                $tocnumber[$level]++;
                $tocData['main/templatedparams'] = [
                    'toclevel' => count( $tocnumber ),
                    'level' => $level,
                    'anchor' => 'main/templatedparams',
                    'line' => $header,
                    'number' => implode( '.', $tocnumber ),
                    'index' => false,
                ];
            }
 
            $header = $this->msg( 'api-credits-header' )->parse();
            $id = Sanitizer::escapeIdForAttribute( 'main/credits', Sanitizer::ID_PRIMARY );
            $idFallback = Sanitizer::escapeIdForAttribute( 'main/credits', Sanitizer::ID_FALLBACK );
            $headline = Linker::makeHeadline( min( 6, $level ),
                ' class="apihelp-header">',
                $id,
                $header,
                '',
                $idFallback
            );
            // Ensure we have a sane anchor
            if ( $id !== 'main/credits' && $idFallback !== 'main/credits' ) {
                $headline = '<div id="main/credits"></div>' . $headline;
            }
            $help['credits'] .= $headline;
            $help['credits'] .= $this->msg( 'api-credits' )->useDatabase( false )->parseAsBlock();
            if ( !isset( $tocData['main/credits'] ) ) {
                $tocnumber[$level]++;
                $tocData['main/credits'] = [
                    'toclevel' => count( $tocnumber ),
                    'level' => $level,
                    'anchor' => 'main/credits',
                    'line' => $header,
                    'number' => implode( '.', $tocnumber ),
                    'index' => false,
                ];
            }
        }
    }
 
    private $mCanApiHighLimits = null;
 
    public function canApiHighLimits() {
        if ( !isset( $this->mCanApiHighLimits ) ) {
            $this->mCanApiHighLimits = $this->getPermissionManager()
                ->userHasRight( $this->getUser(), 'apihighlimits' );
        }
 
        return $this->mCanApiHighLimits;
    }
 
    public function getModuleManager() {
        return $this->mModuleMgr;
    }
 
    public function getUserAgent() {
        return trim(
            $this->getRequest()->getHeader( 'Api-user-agent' ) . ' ' .
            $this->getRequest()->getHeader( 'User-agent' )
        );
    }
}