ResourceLoaderContext.php

Go to the documentation of this file.

<?php
use MediaWiki\Logger\LoggerFactory;

class ResourceLoaderContext {
    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();

        // Future developers: Avoid use of getVal() in this class, which performs
        // expensive UTF normalisation by default. Use getRawVal() instead.
        // Values here are either one of a finite number of internal IDs,
        // or previously-stored user input (e.g. titles, user names) that were passed
        // to this endpoint by ResourceLoader itself from the canonical value.
        // Values do not come directly from user input and need not match.

        // List of modules
        $modules = $request->getRawVal( 'modules' );
        $this->modules = $modules ? self::expandModuleNames( $modules ) : [];

        // Various parameters
        $this->user = $request->getRawVal( 'user' );
        $this->debug = $request->getFuzzyBool(
            'debug',
            $resourceLoader->getConfig()->get( 'ResourceLoaderDebug' )
        );
        $this->only = $request->getRawVal( 'only', null );
        $this->version = $request->getRawVal( 'version', null );
        $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 no skin is specified, or we don't recognize the skin, use the default skin
        if ( !$this->skin || !isset( $skinnames[$this->skin] ) ) {
            $this->skin = $resourceLoader->getConfig()->get( 'DefaultSkin' );
        }
    }

    public static function expandModuleNames( $modules ) {
        $retval = [];
        $exploded = explode( '|', $modules );
        foreach ( $exploded as $group ) {
            if ( strpos( $group, ',' ) === false ) {
                // This is not a set of modules in foo.bar,baz notation
                // but a single module
                $retval[] = $group;
            } else {
                // This is a set of modules in foo.bar,baz notation
                $pos = strrpos( $group, '.' );
                if ( $pos === false ) {
                    // Prefixless modules, i.e. without dots
                    $retval = array_merge( $retval, explode( ',', $group ) );
                } else {
                    // We have a prefix and a bunch of suffixes
                    $prefix = substr( $group, 0, $pos ); // 'foo'
                    $suffixes = explode( ',', substr( $group, $pos + 1 ) ); // [ 'bar', 'baz' ]
                    foreach ( $suffixes as $suffix ) {
                        $retval[] = "$prefix.$suffix";
                    }
                }
            }
        }
        return $retval;
    }

    public static function newDummyContext() {
        return new self( new ResourceLoader(
            ConfigFactory::getDefaultInstance()->makeConfig( 'main' ),
            LoggerFactory::getInstance( 'resourceloader' )
        ), new FauxRequest( [] ) );
    }

    public function getResourceLoader() {
        return $this->resourceLoader;
    }

    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 ) ) {
                wfDebug( "Invalid user language code\n" );
                $lang = $this->getResourceLoader()->getConfig()->get( 'LanguageCode' );
            }
            $this->language = $lang;
        }
        return $this->language;
    }

    public function getDirection() {
        if ( $this->direction === null ) {
            $this->direction = $this->getRequest()->getRawVal( 'dir' );
            if ( !$this->direction ) {
                // Determine directionality based on user language (bug 6100)
                $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() {
        return call_user_func_array( 'wfMessage', func_get_args() )
            ->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 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;
    }
}