ResourceLoaderClientHtml.php

Go to the documentation of this file.

<?php
use WrappedString\WrappedStringList;

class ResourceLoaderClientHtml {

    private $context;

    private $resourceLoader;

    private $target;

    private $config = [];

    private $modules = [];

    private $moduleStyles = [];

    private $moduleScripts = [];

    private $exemptStates = [];

    private $data;

    public function __construct( ResourceLoaderContext $context, $target = null ) {
        $this->context = $context;
        $this->resourceLoader = $context->getResourceLoader();
        $this->target = $target;
    }

    public function setConfig( array $vars ) {
        foreach ( $vars as $key => $value ) {
            $this->config[$key] = $value;
        }
    }

    public function setModules( array $modules ) {
        $this->modules = $modules;
    }

    public function setModuleStyles( array $modules ) {
        $this->moduleStyles = $modules;
    }

    public function setModuleScripts( array $modules ) {
        $this->moduleScripts = $modules;
    }

    public function setExemptStates( array $states ) {
        $this->exemptStates = $states;
    }

    private function getData() {
        if ( $this->data ) {
            // @codeCoverageIgnoreStart
            return $this->data;
            // @codeCoverageIgnoreEnd
        }

        $rl = $this->resourceLoader;
        $data = [
            'states' => [
                // moduleName => state
            ],
            'general' => [
                // position => [ moduleName ]
                'top' => [],
                'bottom' => [],
            ],
            'styles' => [
                // moduleName
            ],
            'scripts' => [
                // position => [ moduleName ]
                'top' => [],
                'bottom' => [],
            ],
            // Embedding for private modules
            'embed' => [
                'styles' => [],
                'general' => [
                    'top' => [],
                    'bottom' => [],
                ],
            ],

        ];

        foreach ( $this->modules as $name ) {
            $module = $rl->getModule( $name );
            if ( !$module ) {
                continue;
            }

            $group = $module->getGroup();
            $position = $module->getPosition();

            if ( $group === 'private' ) {
                // Embed via mw.loader.implement per T36907.
                $data['embed']['general'][$position][] = $name;
                // Avoid duplicate request from mw.loader
                $data['states'][$name] = 'loading';
            } else {
                // Load via mw.loader.load()
                $data['general'][$position][] = $name;
            }
        }

        foreach ( $this->moduleStyles as $name ) {
            $module = $rl->getModule( $name );
            if ( !$module ) {
                continue;
            }

            if ( $module->getType() !== ResourceLoaderModule::LOAD_STYLES ) {
                $logger = $rl->getLogger();
                $logger->debug( 'Unexpected general module "{module}" in styles queue.', [
                    'module' => $name,
                ] );
            } else {
                // Stylesheet doesn't trigger mw.loader callback.
                // Set "ready" state to allow dependencies and avoid duplicate requests. (T87871)
                $data['states'][$name] = 'ready';
            }

            $group = $module->getGroup();
            $context = $this->getContext( $group, ResourceLoaderModule::TYPE_STYLES );
            if ( $module->isKnownEmpty( $context ) ) {
                // Avoid needless request for empty module
                $data['states'][$name] = 'ready';
            } else {
                if ( $group === 'private' ) {
                    // Embed via style element
                    $data['embed']['styles'][] = $name;
                    // Avoid duplicate request from mw.loader
                    $data['states'][$name] = 'ready';
                } else {
                    // Load from load.php?only=styles via <link rel=stylesheet>
                    $data['styles'][] = $name;
                }
            }
        }

        foreach ( $this->moduleScripts as $name ) {
            $module = $rl->getModule( $name );
            if ( !$module ) {
                continue;
            }

            $group = $module->getGroup();
            $position = $module->getPosition();
            $context = $this->getContext( $group, ResourceLoaderModule::TYPE_SCRIPTS );
            if ( $module->isKnownEmpty( $context ) ) {
                // Avoid needless request for empty module
                $data['states'][$name] = 'ready';
            } else {
                // Load from load.php?only=scripts via <script src></script>
                $data['scripts'][$position][] = $name;

                // Avoid duplicate request from mw.loader
                $data['states'][$name] = 'loading';
            }
        }

        return $data;
    }

    public function getDocumentAttributes() {
        return [ 'class' => 'client-nojs' ];
    }

    public function getHeadHtml() {
        $data = $this->getData();
        $chunks = [];

        // Change "client-nojs" class to client-js. This allows easy toggling of UI components.
        // This happens synchronously on every page view to avoid flashes of wrong content.
        // See also #getDocumentAttributes() and /resources/src/startup.js.
        $chunks[] = Html::inlineScript(
            'document.documentElement.className = document.documentElement.className'
            . '.replace( /(^|\s)client-nojs(\s|$)/, "$1client-js$2" );'
        );

        // Inline RLQ: Set page variables
        if ( $this->config ) {
            $chunks[] = ResourceLoader::makeInlineScript(
                ResourceLoader::makeConfigSetScript( $this->config )
            );
        }

        // Inline RLQ: Initial module states
        $states = array_merge( $this->exemptStates, $data['states'] );
        if ( $states ) {
            $chunks[] = ResourceLoader::makeInlineScript(
                ResourceLoader::makeLoaderStateScript( $states )
            );
        }

        // Inline RLQ: Embedded modules
        if ( $data['embed']['general']['top'] ) {
            $chunks[] = $this->getLoad(
                $data['embed']['general']['top'],
                ResourceLoaderModule::TYPE_COMBINED
            );
        }

        // Inline RLQ: Load general modules
        if ( $data['general']['top'] ) {
            $chunks[] = ResourceLoader::makeInlineScript(
                Xml::encodeJsCall( 'mw.loader.load', [ $data['general']['top'] ] )
            );
        }

        // Inline RLQ: Load only=scripts
        if ( $data['scripts']['top'] ) {
            $chunks[] = $this->getLoad(
                $data['scripts']['top'],
                ResourceLoaderModule::TYPE_SCRIPTS
            );
        }

        // External stylesheets
        if ( $data['styles'] ) {
            $chunks[] = $this->getLoad(
                $data['styles'],
                ResourceLoaderModule::TYPE_STYLES
            );
        }

        // Inline stylesheets (embedded only=styles)
        if ( $data['embed']['styles'] ) {
            $chunks[] = $this->getLoad(
                $data['embed']['styles'],
                ResourceLoaderModule::TYPE_STYLES
            );
        }

        // Async scripts. Once the startup is loaded, inline RLQ scripts will run.
        // Pass-through a custom target from OutputPage (T143066).
        $startupQuery = $this->target ? [ 'target' => $this->target ] : [];
        $chunks[] = $this->getLoad(
            'startup',
            ResourceLoaderModule::TYPE_SCRIPTS,
            $startupQuery
        );

        return WrappedStringList::join( "\n", $chunks );
    }

    public function getBodyHtml() {
        $data = $this->getData();
        $chunks = [];

        // Inline RLQ: Embedded modules
        if ( $data['embed']['general']['bottom'] ) {
            $chunks[] = $this->getLoad(
                $data['embed']['general']['bottom'],
                ResourceLoaderModule::TYPE_COMBINED
            );
        }

        // Inline RLQ: Load only=scripts
        if ( $data['scripts']['bottom'] ) {
            $chunks[] = $this->getLoad(
                $data['scripts']['bottom'],
                ResourceLoaderModule::TYPE_SCRIPTS
            );
        }

        // Inline RLQ: Load general modules
        if ( $data['general']['bottom'] ) {
            $chunks[] = ResourceLoader::makeInlineScript(
                Xml::encodeJsCall( 'mw.loader.load', [ $data['general']['bottom'] ] )
            );
        }

        return WrappedStringList::join( "\n", $chunks );
    }

    private function getContext( $group, $type ) {
        return self::makeContext( $this->context, $group, $type );
    }

    private function getLoad( $modules, $only, array $extraQuery = [] ) {
        return self::makeLoad( $this->context, (array)$modules, $only, $extraQuery );
    }

    private static function makeContext( ResourceLoaderContext $mainContext, $group, $type,
        array $extraQuery = []
    ) {
        // Create new ResourceLoaderContext so that $extraQuery may trigger isRaw().
        $req = new FauxRequest( array_merge( $mainContext->getRequest()->getValues(), $extraQuery ) );
        // Set 'only' if not combined
        $req->setVal( 'only', $type === ResourceLoaderModule::TYPE_COMBINED ? null : $type );
        // Remove user parameter in most cases
        if ( $group !== 'user' && $group !== 'private' ) {
            $req->setVal( 'user', null );
        }
        $context = new ResourceLoaderContext( $mainContext->getResourceLoader(), $req );
        // Allow caller to setVersion() and setModules()
        return new DerivativeResourceLoaderContext( $context );
    }

    public static function makeLoad( ResourceLoaderContext $mainContext, array $modules, $only,
        array $extraQuery = []
    ) {
        $rl = $mainContext->getResourceLoader();
        $chunks = [];

        if ( $mainContext->getDebug() && count( $modules ) > 1 ) {
            $chunks = [];
            // Recursively call us for every item
            foreach ( $modules as $name ) {
                $chunks[] = self::makeLoad( $mainContext, [ $name ], $only, $extraQuery );
            }
            return new WrappedStringList( "\n", $chunks );
        }

        // Sort module names so requests are more uniform
        sort( $modules );
        // Create keyed-by-source and then keyed-by-group list of module objects from modules list
        $sortedModules = [];
        foreach ( $modules as $name ) {
            $module = $rl->getModule( $name );
            if ( !$module ) {
                $rl->getLogger()->warning( 'Unknown module "{module}"', [ 'module' => $name ] );
                continue;
            }
            $sortedModules[$module->getSource()][$module->getGroup()][$name] = $module;
        }

        foreach ( $sortedModules as $source => $groups ) {
            foreach ( $groups as $group => $grpModules ) {
                $context = self::makeContext( $mainContext, $group, $only, $extraQuery );
                $context->setModules( array_keys( $grpModules ) );

                if ( $group === 'private' ) {
                    // Decide whether to use style or script element
                    if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
                        $chunks[] = Html::inlineStyle(
                            $rl->makeModuleResponse( $context, $grpModules )
                        );
                    } else {
                        $chunks[] = ResourceLoader::makeInlineScript(
                            $rl->makeModuleResponse( $context, $grpModules )
                        );
                    }
                    continue;
                }

                // See if we have one or more raw modules
                $isRaw = false;
                foreach ( $grpModules as $key => $module ) {
                    $isRaw |= $module->isRaw();
                }

                // Special handling for the user group; because users might change their stuff
                // on-wiki like user pages, or user preferences; we need to find the highest
                // timestamp of these user-changeable modules so we can ensure cache misses on change
                // This should NOT be done for the site group (bug 27564) because anons get that too
                // and we shouldn't be putting timestamps in CDN-cached HTML
                if ( $group === 'user' ) {
                    // Must setModules() before makeVersionQuery()
                    $context->setVersion( $rl->makeVersionQuery( $context ) );
                }

                $url = $rl->createLoaderURL( $source, $context, $extraQuery );

                // Decide whether to use 'style' or 'script' element
                if ( $only === ResourceLoaderModule::TYPE_STYLES ) {
                    $chunk = Html::linkedStyle( $url );
                } else {
                    if ( $context->getRaw() || $isRaw ) {
                        $chunk = Html::element( 'script', [
                            // In SpecialJavaScriptTest, QUnit must load synchronous
                            'async' => !isset( $extraQuery['sync'] ),
                            'src' => $url
                        ] );
                    } else {
                        $chunk = ResourceLoader::makeInlineScript(
                            Xml::encodeJsCall( 'mw.loader.load', [ $url ] )
                        );
                    }
                }

                if ( $group == 'noscript' ) {
                    $chunks[] = Html::rawElement( 'noscript', [], $chunk );
                } else {
                    $chunks[] = $chunk;
                }
            }
        }

        return new WrappedStringList( "\n", $chunks );
    }
}