ResourceLoaderContext.php

Go to the documentation of this file.

<?php
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;
 
class ResourceLoaderContext implements MessageLocalizer {
    const DEFAULT_LANG = 'qqx';
    const DEFAULT_SKIN = 'fallback';
 
    protected $resourceLoader;
    protected $request;
    protected $logger;
 
    // Module content vary
    protected $skin;
    protected $language;
    protected $debug;
    protected $user;
 
    // Request vary (in addition to cache vary)
    protected $modules;
    protected $only;
    protected $version;
    protected $raw;
    protected $image;
    protected $variant;
    protected $format;
 
    protected $direction;
    protected $hash;
    protected $userObj;
    protected $imageObj;
 
    public function __construct( ResourceLoader $resourceLoader, WebRequest $request ) {
        $this->resourceLoader = $resourceLoader;
        $this->request = $request;
        $this->logger = $resourceLoader->getLogger();
 
        // Optimisation: Use WebRequest::getRawVal() instead of getVal(). We don't
        // need the slow Language+UTF logic meant for user input here. (f303bb9360)
 
        // List of modules
        $modules = $request->getRawVal( 'modules' );
        $this->modules = $modules ? ResourceLoader::expandModuleNames( $modules ) : [];
 
        // Various parameters
        $this->user = $request->getRawVal( 'user' );
        $this->debug = $request->getRawVal( 'debug' ) === 'true';
        $this->only = $request->getRawVal( 'only' );
        $this->version = $request->getRawVal( 'version' );
        $this->raw = $request->getFuzzyBool( 'raw' );
 
        // Image requests
        $this->image = $request->getRawVal( 'image' );
        $this->variant = $request->getRawVal( 'variant' );
        $this->format = $request->getRawVal( 'format' );
 
        $this->skin = $request->getRawVal( 'skin' );
        $skinnames = Skin::getSkinNames();
        if ( !$this->skin || !isset( $skinnames[$this->skin] ) ) {
            // The 'skin' parameter is required. (Not yet enforced.)
            // For requests without a known skin specified,
            // use MediaWiki's 'fallback' skin for skin-specific decisions.
            $this->skin = self::DEFAULT_SKIN;
        }
    }
 
    public static function newDummyContext() {
        // This currently creates a non-empty instance of ResourceLoader (all modules registered),
        // but that's probably not needed. So once that moves into ServiceWiring, this'll
        // become more like the EmptyResourceLoader class we have in PHPUnit tests, which
        // is what this should've had originally. If this turns out to be untrue, change to:
        // `MediaWikiServices::getInstance()->getResourceLoader()` instead.
        return new self( new ResourceLoader(
            MediaWikiServices::getInstance()->getMainConfig(),
            LoggerFactory::getInstance( 'resourceloader' )
        ), new FauxRequest( [] ) );
    }
 
    public function getResourceLoader() {
        return $this->resourceLoader;
    }
 
    public function getConfig() {
        wfDeprecated( __METHOD__, '1.34' );
        return $this->getResourceLoader()->getConfig();
    }
 
    public function getRequest() {
        return $this->request;
    }
 
    public function getLogger() {
        return $this->logger;
    }
 
    public function getModules() {
        return $this->modules;
    }
 
    public function getLanguage() {
        if ( $this->language === null ) {
            // Must be a valid language code after this point (T64849)
            // Only support uselang values that follow built-in conventions (T102058)
            $lang = $this->getRequest()->getRawVal( 'lang', '' );
            // Stricter version of RequestContext::sanitizeLangCode()
            if ( !Language::isValidBuiltInCode( $lang ) ) {
                // The 'lang' parameter is required. (Not yet enforced.)
                // If omitted, localise with the dummy language code.
                $lang = self::DEFAULT_LANG;
            }
            $this->language = $lang;
        }
        return $this->language;
    }
 
    public function getDirection() {
        if ( $this->direction === null ) {
            $direction = $this->getRequest()->getRawVal( 'dir' );
            if ( $direction === 'ltr' || $direction === 'rtl' ) {
                $this->direction = $direction;
            } else {
                // Determine directionality based on user language (T8100)
                $this->direction = Language::factory( $this->getLanguage() )->getDir();
            }
        }
        return $this->direction;
    }
 
    public function getSkin() {
        return $this->skin;
    }
 
    public function getUser() {
        return $this->user;
    }
 
    public function msg( $key, ...$params ) {
        return wfMessage( $key, ...$params )
            ->inLanguage( $this->getLanguage() )
            // Use a dummy title because there is no real title
            // for this endpoint, and the cache won't vary on it
            // anyways.
            ->title( Title::newFromText( 'Dwimmerlaik' ) );
    }
 
    public function getUserObj() {
        if ( $this->userObj === null ) {
            $username = $this->getUser();
            if ( $username ) {
                // Use provided username if valid, fallback to anonymous user
                $this->userObj = User::newFromName( $username ) ?: new User;
            } else {
                // Anonymous user
                $this->userObj = new User;
            }
        }
 
        return $this->userObj;
    }
 
    public function getDebug() {
        return $this->debug;
    }
 
    public function getOnly() {
        return $this->only;
    }
 
    public function getVersion() {
        return $this->version;
    }
 
    public function getRaw() {
        return $this->raw;
    }
 
    public function getImage() {
        return $this->image;
    }
 
    public function getVariant() {
        return $this->variant;
    }
 
    public function getFormat() {
        return $this->format;
    }
 
    public function getImageObj() {
        if ( $this->imageObj === null ) {
            $this->imageObj = false;
 
            if ( !$this->image ) {
                return $this->imageObj;
            }
 
            $modules = $this->getModules();
            if ( count( $modules ) !== 1 ) {
                return $this->imageObj;
            }
 
            $module = $this->getResourceLoader()->getModule( $modules[0] );
            if ( !$module || !$module instanceof ResourceLoaderImageModule ) {
                return $this->imageObj;
            }
 
            $image = $module->getImage( $this->image, $this );
            if ( !$image ) {
                return $this->imageObj;
            }
 
            $this->imageObj = $image;
        }
 
        return $this->imageObj;
    }
 
    public function getContentOverrideCallback() {
        return null;
    }
 
    public function shouldIncludeScripts() {
        return $this->getOnly() === null || $this->getOnly() === 'scripts';
    }
 
    public function shouldIncludeStyles() {
        return $this->getOnly() === null || $this->getOnly() === 'styles';
    }
 
    public function shouldIncludeMessages() {
        return $this->getOnly() === null;
    }
 
    public function getHash() {
        if ( !isset( $this->hash ) ) {
            $this->hash = implode( '|', [
                // Module content vary
                $this->getLanguage(),
                $this->getSkin(),
                $this->getDebug(),
                $this->getUser(),
                // Request vary
                $this->getOnly(),
                $this->getVersion(),
                $this->getRaw(),
                $this->getImage(),
                $this->getVariant(),
                $this->getFormat(),
            ] );
        }
        return $this->hash;
    }
 
    public function getReqBase() {
        $reqBase = [];
        if ( $this->getLanguage() !== self::DEFAULT_LANG ) {
            $reqBase['lang'] = $this->getLanguage();
        }
        if ( $this->getSkin() !== self::DEFAULT_SKIN ) {
            $reqBase['skin'] = $this->getSkin();
        }
        if ( $this->getDebug() ) {
            $reqBase['debug'] = 'true';
        }
        return $reqBase;
    }
 
    public function encodeJson( $data ) {
        // Keep output as small as possible by disabling needless escape modes
        // that PHP uses by default.
        // However, while most module scripts are only served on HTTP responses
        // for JavaScript, some modules can also be embedded in the HTML as inline
        // scripts. This, and the fact that we sometimes need to export strings
        // containing user-generated content and labels that may genuinely contain
        // a sequences like "</script>", we need to encode either '/' or '<'.
        // By default PHP escapes '/'. Let's escape '<' instead which is less common
        // and allows URLs to mostly remain readable.
        $jsonFlags = JSON_UNESCAPED_SLASHES |
            JSON_UNESCAPED_UNICODE |
            JSON_HEX_TAG |
            JSON_HEX_AMP;
        if ( $this->getDebug() ) {
            $jsonFlags |= JSON_PRETTY_PRINT;
        }
        return json_encode( $data, $jsonFlags );
    }
}