Localisation updates from https://translatewiki.net.

[mediawiki.git] / includes / context / RequestContext.php

<?php
/**
 * 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
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @since 1.18
 *
 * @author Alexandre Emsenhuber
 * @author Daniel Friesen
 * @file
 */

namespace MediaWiki\Context;

use BadMethodCallException;
use InvalidArgumentException;
use LogicException;
use MediaWiki\Config\Config;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\Language\Language;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Message\Message;
use MediaWiki\Output\OutputPage;
use MediaWiki\Permissions\Authority;
use MediaWiki\Request\FauxRequest;
use MediaWiki\Request\WebRequest;
use MediaWiki\Session\CsrfTokenSet;
use MediaWiki\Session\PHPSessionHandler;
use MediaWiki\Session\SessionManager;
use MediaWiki\StubObject\StubGlobalUser;
use MediaWiki\Title\Title;
use MediaWiki\User\User;
use MediaWiki\User\UserRigorOptions;
use RuntimeException;
use Skin;
use Timing;
use Wikimedia\Assert\Assert;
use Wikimedia\AtEase\AtEase;
use Wikimedia\Bcp47Code\Bcp47Code;
use Wikimedia\IPUtils;
use Wikimedia\Message\MessageParam;
use Wikimedia\Message\MessageSpecifier;
use Wikimedia\NonSerializable\NonSerializableTrait;
use Wikimedia\ScopedCallback;
use WikiPage;

/**
 * Group all the pieces relevant to the context of a request into one instance
 * @newable
 * @note marked as newable in 1.35 for lack of a better alternative,
 *       but should use a factory in the future and should be narrowed
 *       down to not expose heavy weight objects.
 */
class RequestContext implements IContextSource, MutableContext {
        use NonSerializableTrait;

        /**
         * @var WebRequest
         */
        private $request;

        /**
         * @var Title
         */
        private $title;

        /**
         * @var WikiPage|null
         */
        private $wikipage;

        /**
         * @var null|string
         */
        private $action;

        /**
         * @var OutputPage
         */
        private $output;

        /**
         * @var User|null
         */
        private $user;

        /**
         * @var Authority
         */
        private $authority;

        /**
         * @var Language|null
         */
        private $lang;

        /**
         * @var Skin|null
         */
        private $skin;

        /**
         * @var Timing
         */
        private $timing;

        /**
         * @var Config
         */
        private $config;

        /**
         * @var RequestContext|null
         */
        private static $instance = null;

        /**
         * Boolean flag to guard against recursion in getLanguage
         * @var bool
         */
        private $languageRecursion = false;

        /** @var Skin|string|null */
        private $skinFromHook;

        /** @var bool */
        private $skinHookCalled = false;

        /** @var string|null */
        private $skinName;

        /**
         * @param Config $config
         */
        public function setConfig( Config $config ) {
                $this->config = $config;
        }

        /**
         * @return Config
         */
        public function getConfig() {
                // @todo In the future, we could move this to WebStart.php so
                // the Config object is ready for when initialization happens
                $this->config ??= MediaWikiServices::getInstance()->getMainConfig();

                return $this->config;
        }

        /**
         * @param WebRequest $request
         */
        public function setRequest( WebRequest $request ) {
                $this->request = $request;
        }

        /**
         * @return WebRequest
         */
        public function getRequest() {
                if ( $this->request === null ) {
                        // create the WebRequest object on the fly
                        if ( MW_ENTRY_POINT === 'cli' ) {
                                // Don't use real WebRequest in CLI mode, it throws errors when trying to access
                                // things that don't exist, e.g. "Unable to determine IP".
                                $this->request = new FauxRequest( [] );
                        } else {
                                $this->request = new WebRequest();
                        }
                }

                return $this->request;
        }

        /**
         * @return Timing
         */
        public function getTiming() {
                $this->timing ??= new Timing( [
                        'logger' => LoggerFactory::getInstance( 'Timing' )
                ] );
                return $this->timing;
        }

        /**
         * @param Title|null $title
         */
        public function setTitle( ?Title $title = null ) {
                $this->title = $title;
                // Clear cache of derived getters
                $this->wikipage = null;
                $this->clearActionName();
        }

        /**
         * @return Title|null
         */
        public function getTitle() {
                if ( $this->title === null ) {
                        // phpcs:ignore MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgTitle
                        global $wgTitle; # fallback to $wg till we can improve this
                        $this->title = $wgTitle;
                        $logger = LoggerFactory::getInstance( 'GlobalTitleFail' );
                        $logger->info(
                                __METHOD__ . ' called with no title set.',
                                [ 'exception' => new RuntimeException ]
                        );
                }

                return $this->title;
        }

        /**
         * Check, if a Title object is set
         *
         * @since 1.25
         * @return bool
         */
        public function hasTitle() {
                return $this->title !== null;
        }

        /**
         * Check whether a WikiPage object can be get with getWikiPage().
         * Callers should expect that an exception is thrown from getWikiPage()
         * if this method returns false.
         *
         * @since 1.19
         * @return bool
         */
        public function canUseWikiPage() {
                if ( $this->wikipage ) {
                        // If there's a WikiPage object set, we can for sure get it
                        return true;
                }
                // Only pages with legitimate titles can have WikiPages.
                // That usually means pages in non-virtual namespaces.
                $title = $this->getTitle();
                return $title && $title->canExist();
        }

        /**
         * @since 1.19
         * @param WikiPage $wikiPage
         */
        public function setWikiPage( WikiPage $wikiPage ) {
                $pageTitle = $wikiPage->getTitle();
                if ( !$this->hasTitle() || !$pageTitle->equals( $this->getTitle() ) ) {
                        $this->setTitle( $pageTitle );
                }
                // Defer this to the end since setTitle sets it to null.
                $this->wikipage = $wikiPage;
                // Clear cache of derived getter
                $this->clearActionName();
        }

        /**
         * Get the WikiPage object.
         * May throw an exception if there's no Title object set or the Title object
         * belongs to a special namespace that doesn't have WikiPage, so use first
         * canUseWikiPage() to check whether this method can be called safely.
         *
         * @since 1.19
         * @return WikiPage
         */
        public function getWikiPage() {
                if ( $this->wikipage === null ) {
                        $title = $this->getTitle();
                        if ( $title === null ) {
                                throw new BadMethodCallException( __METHOD__ . ' called without Title object set' );
                        }
                        $this->wikipage = MediaWikiServices::getInstance()->getWikiPageFactory()->newFromTitle( $title );
                }

                return $this->wikipage;
        }

        /**
         * @since 1.38
         * @param string $action
         */
        public function setActionName( string $action ): void {
                $this->action = $action;
        }

        /**
         * Get the action name for the current web request.
         *
         * This generally returns "view" if the current request or process is
         * not for a skinned index.php web request (e.g. load.php, thumb.php,
         * job runner, CLI, API).
         *
         * @warning This must not be called before or during the Setup.php phase,
         * and may cause an error or warning if called too early.
         *
         * @since 1.38
         * @return string Action
         */
        public function getActionName(): string {
                // Optimisation: This is cached to avoid repeated running of the
                // expensive operations to compute this. The computation involves creation
                // of Article, WikiPage, and ContentHandler objects (and the various
                // database queries these classes require to be instantiated), as well
                // as potentially slow extension hooks in these classes.
                //
                // This value is frequently needed in OutputPage and in various
                // Skin-related methods and classes.
                $this->action ??= MediaWikiServices::getInstance()
                        ->getActionFactory()
                        ->getActionName( $this );

                return $this->action;
        }

        private function clearActionName(): void {
                if ( $this->action !== null ) {
                        // If we're clearing after something else has actually already computed the action,
                        // emit a warning.
                        //
                        // Doing so is unstable, given the first caller got something that turns out to be
                        // incomplete or incorrect. Even if we end up re-creating an instance of the same
                        // class, we may now be acting on a different title/skin/user etc.
                        //
                        // Re-computing the action is expensive and can be a performance problem (T302623).
                        trigger_error( 'Unexpected clearActionName after getActionName already called' );
                        $this->action = null;
                }
        }

        /**
         * @param OutputPage $output
         */
        public function setOutput( OutputPage $output ) {
                $this->output = $output;
        }

        /**
         * @return OutputPage
         */
        public function getOutput() {
                $this->output ??= new OutputPage( $this );

                return $this->output;
        }

        /**
         * @param User $user
         */
        public function setUser( User $user ) {
                $this->user = $user;
                // Keep authority consistent
                $this->authority = $user;
                // Invalidate cached user interface language and skin
                $this->lang = null;
                $this->skin = null;
                $this->skinName = null;
        }

        /**
         * @return User
         */
        public function getUser() {
                if ( $this->user === null ) {
                        if ( $this->authority !== null ) {
                                // Keep user consistent by using a possible set authority
                                $this->user = MediaWikiServices::getInstance()
                                        ->getUserFactory()
                                        ->newFromAuthority( $this->authority );
                        } else {
                                $this->user = User::newFromSession( $this->getRequest() );
                        }
                }

                return $this->user;
        }

        public function hasUser(): bool {
                if ( !defined( 'MW_PHPUNIT_TEST' ) && !defined( 'MW_PARSER_TEST' ) ) {
                        throw new LogicException( __METHOD__ . '() should be called only from tests!' );
                }
                return $this->user !== null;
        }

        /**
         * @param Authority $authority
         */
        public function setAuthority( Authority $authority ) {
                $this->authority = $authority;
                // If needed, a User object is constructed from this authority
                $this->user = null;
                // Invalidate cached user interface language and skin
                $this->lang = null;
                $this->skin = null;
                $this->skinName = null;
        }

        /**
         * @since 1.36
         * @return Authority
         */
        public function getAuthority(): Authority {
                return $this->authority ?: $this->getUser();
        }

        /**
         * Accepts a language code and ensures it's sensible. Outputs a cleaned up language
         * code and replaces with $wgLanguageCode if not sensible.
         * @param ?string $code Language code
         * @return string
         */
        public static function sanitizeLangCode( $code ) {
                global $wgLanguageCode;

                if ( !$code ) {
                        return $wgLanguageCode;
                }

                // BCP 47 - letter case MUST NOT carry meaning
                $code = strtolower( $code );

                # Validate $code
                if ( !MediaWikiServices::getInstance()->getLanguageNameUtils()
                                ->isValidCode( $code )
                        || $code === 'qqq'
                ) {
                        $code = $wgLanguageCode;
                }

                return $code;
        }

        /**
         * @param Language|string $language Language instance or language code
         * @since 1.19
         */
        public function setLanguage( $language ) {
                Assert::parameterType( [ Language::class, 'string' ], $language, '$language' );
                if ( $language instanceof Language ) {
                        $this->lang = $language;
                } else {
                        $language = self::sanitizeLangCode( $language );
                        $obj = MediaWikiServices::getInstance()->getLanguageFactory()->getLanguage( $language );
                        $this->lang = $obj;
                }
                OutputPage::resetOOUI();
        }

        /**
         * Get the Language object.
         * Initialization of user or request objects can depend on this.
         * @return Language
         * @throws LogicException
         * @since 1.19
         */
        public function getLanguage() {
                if ( $this->languageRecursion === true ) {
                        throw new LogicException( 'Recursion detected' );
                }

                if ( $this->lang === null ) {
                        $this->languageRecursion = true;

                        try {
                                $request = $this->getRequest();
                                $user = $this->getUser();
                                $services = MediaWikiServices::getInstance();

                                // Optimisation: Avoid slow getVal(), this isn't user-generated content.
                                $code = $request->getRawVal( 'uselang' ) ?? 'user';
                                if ( $code === 'user' ) {
                                        $userOptionsLookup = $services->getUserOptionsLookup();
                                        $code = $userOptionsLookup->getOption( $user, 'language' );
                                }

                                // There are certain characters we don't allow in language code strings,
                                // but by and large almost any valid UTF-8 string will makes it past
                                // this check and the LanguageNameUtils::isValidCode method it uses.
                                // This is to support on-wiki interface message overrides for
                                // non-existent language codes. Also known as "Uselang hacks".
                                // See <https://www.mediawiki.org/wiki/Manual:Uselang_hack>
                                // For something like "en-whatever" or "de-whatever" it will end up
                                // with a mostly "en" or "de" interface, but with an extra layer of
                                // possible MessageCache overrides from `MediaWiki:*/<code>` titles.
                                // While non-ASCII works here, it is required that they are in
                                // NFC form given this will not convert to normalised form.
                                $code = self::sanitizeLangCode( $code );

                                ( new HookRunner( $services->getHookContainer() ) )->onUserGetLanguageObject( $user, $code, $this );

                                if ( $code === $this->getConfig()->get( MainConfigNames::LanguageCode ) ) {
                                        $this->lang = $services->getContentLanguage();
                                } else {
                                        $obj = $services->getLanguageFactory()
                                                ->getLanguage( $code );
                                        $this->lang = $obj;
                                }
                        } finally {
                                $this->languageRecursion = false;
                        }
                }

                return $this->lang;
        }

        /**
         * @since 1.42
         * @return Bcp47Code
         */
        public function getLanguageCode() {
                return $this->getLanguage();
        }

        /**
         * @param Skin $skin
         */
        public function setSkin( Skin $skin ) {
                $this->skin = clone $skin;
                $this->skin->setContext( $this );
                $this->skinName = $skin->getSkinName();
                OutputPage::resetOOUI();
        }

        /**
         * Get the name of the skin
         *
         * @since 1.41
         * @return string
         */
        public function getSkinName() {
                if ( $this->skinName === null ) {
                        $this->skinName = $this->fetchSkinName();
                }
                return $this->skinName;
        }

        /**
         * Get the name of the skin, without caching
         *
         * @return string
         */
        private function fetchSkinName() {
                $skinFromHook = $this->getSkinFromHook();
                if ( $skinFromHook instanceof Skin ) {
                        // The hook provided a skin object
                        return $skinFromHook->getSkinName();
                } elseif ( is_string( $skinFromHook ) ) {
                        // The hook provided a skin name
                        $skinName = $skinFromHook;
                } elseif ( !in_array( 'skin', $this->getConfig()->get( MainConfigNames::HiddenPrefs ) ) ) {
                        // The normal case
                        $userOptionsLookup = MediaWikiServices::getInstance()->getUserOptionsLookup();
                        $userSkin = $userOptionsLookup->getOption( $this->getUser(), 'skin' );
                        // Optimisation: Avoid slow getVal(), this isn't user-generated content.
                        $skinName = $this->getRequest()->getRawVal( 'useskin' ) ?? $userSkin;
                } else {
                        // User preference disabled
                        $skinName = $this->getConfig()->get( MainConfigNames::DefaultSkin );
                }
                return Skin::normalizeKey( $skinName );
        }

        /**
         * Get the skin set by the RequestContextCreateSkin hook, if there is any.
         *
         * @return Skin|string|null
         */
        private function getSkinFromHook() {
                if ( !$this->skinHookCalled ) {
                        $this->skinHookCalled = true;
                        ( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) )
                                ->onRequestContextCreateSkin( $this, $this->skinFromHook );
                }
                return $this->skinFromHook;
        }

        /**
         * @return Skin
         */
        public function getSkin() {
                if ( $this->skin === null ) {
                        $skinFromHook = $this->getSkinFromHook();
                        if ( $skinFromHook instanceof Skin ) {
                                $this->skin = $skinFromHook;
                        } else {
                                $skinName = is_string( $skinFromHook )
                                        ? Skin::normalizeKey( $skinFromHook )
                                        : $this->getSkinName();
                                $factory = MediaWikiServices::getInstance()->getSkinFactory();
                                $this->skin = $factory->makeSkin( $skinName );
                        }
                        $this->skin->setContext( $this );
                }
                return $this->skin;
        }

        /**
         * Get a Message object with context set
         * Parameters are the same as wfMessage()
         *
         * @param string|string[]|MessageSpecifier $key Message key, or array of keys,
         *   or a MessageSpecifier.
         * @phpcs:ignore Generic.Files.LineLength
         * @param MessageParam|MessageSpecifier|string|int|float|list<MessageParam|MessageSpecifier|string|int|float> ...$params
         *   See Message::params()
         * @return Message
         */
        public function msg( $key, ...$params ) {
                return wfMessage( $key, ...$params )->setContext( $this );
        }

        /**
         * Get the RequestContext object associated with the main request
         *
         * @return RequestContext
         */
        public static function getMain(): RequestContext {
                self::$instance ??= new self;

                return self::$instance;
        }

        /**
         * Get the RequestContext object associated with the main request
         * and gives a warning to the log, to find places, where a context maybe is missing.
         *
         * @param string $func @phan-mandatory-param
         * @return RequestContext
         * @since 1.24
         */
        public static function getMainAndWarn( $func = __METHOD__ ) {
                wfDebug( $func . ' called without context. ' .
                        "Using RequestContext::getMain()" );

                return self::getMain();
        }

        /**
         * Resets singleton returned by getMain(). Should be called only from unit tests.
         */
        public static function resetMain() {
                if ( !defined( 'MW_PHPUNIT_TEST' ) && !defined( 'MW_PARSER_TEST' ) ) {
                        throw new LogicException( __METHOD__ . '() should be called only from unit tests!' );
                }
                self::$instance = null;
        }

        /**
         * Export the resolved user IP, HTTP headers, user ID, and session ID.
         * The result will be reasonably sized to allow for serialization.
         *
         * @return array
         * @since 1.21
         */
        public function exportSession() {
                $session = SessionManager::getGlobalSession();
                return [
                        'ip' => $this->getRequest()->getIP(),
                        'headers' => $this->getRequest()->getAllHeaders(),
                        'sessionId' => $session->isPersistent() ? $session->getId() : '',
                        'userId' => $this->getUser()->getId()
                ];
        }

        public function getCsrfTokenSet(): CsrfTokenSet {
                return new CsrfTokenSet( $this->getRequest() );
        }

        /**
         * Import a client IP address, HTTP headers, user ID, and session ID
         *
         * This sets the current session, $wgUser, and $wgRequest from $params.
         * Once the return value falls out of scope, the old context is restored.
         * This method should only be called in contexts where there is no session
         * ID or end user receiving the response (CLI or HTTP job runners). This
         * is partly enforced, and is done so to avoid leaking cookies if certain
         * error conditions arise.
         *
         * This is useful when background scripts inherit context when acting on
         * behalf of a user. In general the 'sessionId' parameter should be set
         * to an empty string unless session importing is *truly* needed. This
         * feature is somewhat deprecated.
         *
         * @param array $params Result of RequestContext::exportSession()
         * @return ScopedCallback
         * @since 1.21
         */
        public static function importScopedSession( array $params ) {
                if ( strlen( $params['sessionId'] ) &&
                        SessionManager::getGlobalSession()->isPersistent()
                ) {
                        // Check to avoid sending random cookies for the wrong users.
                        // This method should only called by CLI scripts or by HTTP job runners.
                        throw new BadMethodCallException( "Sessions can only be imported when none is active." );
                } elseif ( !IPUtils::isValid( $params['ip'] ) ) {
                        throw new InvalidArgumentException( "Invalid client IP address '{$params['ip']}'." );
                }

                $userFactory = MediaWikiServices::getInstance()->getUserFactory();

                if ( $params['userId'] ) { // logged-in user
                        $user = $userFactory->newFromId( (int)$params['userId'] );
                        $user->load();
                        if ( !$user->isRegistered() ) {
                                throw new InvalidArgumentException( "No user with ID '{$params['userId']}'." );
                        }
                } else { // anon user
                        $user = $userFactory->newFromName( $params['ip'], UserRigorOptions::RIGOR_NONE );
                }

                $importSessionFunc = static function ( User $user, array $params ) {
                        global $wgRequest;

                        $context = RequestContext::getMain();

                        // Commit and close any current session
                        if ( PHPSessionHandler::isEnabled() ) {
                                session_write_close(); // persist
                                session_id( '' ); // detach
                                $_SESSION = []; // clear in-memory array
                        }

                        // Get new session, if applicable
                        $session = null;
                        if ( strlen( $params['sessionId'] ) ) { // don't make a new random ID
                                $manager = SessionManager::singleton();
                                $session = $manager->getSessionById( $params['sessionId'], true )
                                        ?: $manager->getEmptySession();
                        }

                        // Remove any user IP or agent information, and attach the request
                        // with the new session.
                        $context->setRequest( new FauxRequest( [], false, $session ) );
                        $wgRequest = $context->getRequest(); // b/c

                        // Now that all private information is detached from the user, it should
                        // be safe to load the new user. If errors occur or an exception is thrown
                        // and caught (leaving the main context in a mixed state), there is no risk
                        // of the User object being attached to the wrong IP, headers, or session.
                        $context->setUser( $user );
                        StubGlobalUser::setUser( $context->getUser() ); // b/c
                        if ( $session && PHPSessionHandler::isEnabled() ) {
                                session_id( $session->getId() );
                                AtEase::quietCall( 'session_start' );
                        }
                        $request = new FauxRequest( [], false, $session );
                        $request->setIP( $params['ip'] );
                        foreach ( $params['headers'] as $name => $value ) {
                                $request->setHeader( $name, $value );
                        }
                        // Set the current context to use the new WebRequest
                        $context->setRequest( $request );
                        $wgRequest = $context->getRequest(); // b/c
                };

                // Stash the old session and load in the new one
                $oUser = self::getMain()->getUser();
                $oParams = self::getMain()->exportSession();
                $oRequest = self::getMain()->getRequest();
                // @phan-suppress-next-line PhanTypeMismatchArgumentNullable exceptions triggered above prevent the null case
                $importSessionFunc( $user, $params );

                // Set callback to save and close the new session and reload the old one
                return new ScopedCallback(
                        static function () use ( $importSessionFunc, $oUser, $oParams, $oRequest ) {
                                global $wgRequest;
                                $importSessionFunc( $oUser, $oParams );
                                // Restore the exact previous Request object (instead of leaving MediaWiki\Request\FauxRequest)
                                RequestContext::getMain()->setRequest( $oRequest );
                                $wgRequest = RequestContext::getMain()->getRequest(); // b/c
                        }
                );
        }

        /**
         * Create a new extraneous context. The context is filled with information
         * external to the current session.
         * - Title is specified by argument
         * - Request is a MediaWiki\Request\FauxRequest, or a MediaWiki\Request\FauxRequest can be specified by argument
         * - User is an anonymous user, for separation IPv4 localhost is used
         * - Language will be based on the anonymous user and request, may be content
         *   language or a uselang param in the fauxrequest data may change the lang
         * - Skin will be based on the anonymous user, should be the wiki's default skin
         *
         * @param Title $title Title to use for the extraneous request
         * @param WebRequest|array $request A WebRequest or data to use for a MediaWiki\Request\FauxRequest
         * @return RequestContext
         */
        public static function newExtraneousContext( Title $title, $request = [] ) {
                $context = new self;
                $context->setTitle( $title );
                if ( $request instanceof WebRequest ) {
                        $context->setRequest( $request );
                } else {
                        $context->setRequest( new FauxRequest( $request ) );
                }
                $context->user = MediaWikiServices::getInstance()->getUserFactory()->newFromName(
                        '127.0.0.1',
                        UserRigorOptions::RIGOR_NONE
                );

                return $context;
        }

        /** @return never */
        public function __clone() {
                throw new LogicException(
                        __CLASS__ . ' should not be cloned, use DerivativeContext instead.'
                );
        }

}

/** @deprecated class alias since 1.42 */
class_alias( RequestContext::class, 'RequestContext' );