ResourceLoaderFileModule.php

Go to the documentation of this file.

<?php
class ResourceLoaderFileModule extends ResourceLoaderModule {
    /* Protected Members */

    protected $localBasePath = '';

    protected $remoteBasePath = '';

    protected $templates = [];

    protected $scripts = [];

    protected $languageScripts = [];

    protected $skinScripts = [];

    protected $debugScripts = [];

    protected $styles = [];

    protected $skinStyles = [];

    protected $dependencies = [];

    protected $skipFunction = null;

    protected $messages = [];

    protected $group;

    protected $position = 'bottom';

    protected $debugRaw = true;

    protected $raw = false;

    protected $targets = [ 'desktop' ];

    protected $noflip = false;

    protected $hasGeneratedStyles = false;

    protected $localFileRefs = [];

    protected $missingLocalFileRefs = [];

    /* Methods */

    public function __construct(
        $options = [],
        $localBasePath = null,
        $remoteBasePath = null
    ) {
        // Flag to decide whether to automagically add the mediawiki.template module
        $hasTemplates = false;
        // localBasePath and remoteBasePath both have unbelievably long fallback chains
        // and need to be handled separately.
        list( $this->localBasePath, $this->remoteBasePath ) =
            self::extractBasePaths( $options, $localBasePath, $remoteBasePath );

        // Extract, validate and normalise remaining options
        foreach ( $options as $member => $option ) {
            switch ( $member ) {
                // Lists of file paths
                case 'scripts':
                case 'debugScripts':
                case 'styles':
                    $this->{$member} = (array)$option;
                    break;
                case 'templates':
                    $hasTemplates = true;
                    $this->{$member} = (array)$option;
                    break;
                // Collated lists of file paths
                case 'languageScripts':
                case 'skinScripts':
                case 'skinStyles':
                    if ( !is_array( $option ) ) {
                        throw new InvalidArgumentException(
                            "Invalid collated file path list error. " .
                            "'$option' given, array expected."
                        );
                    }
                    foreach ( $option as $key => $value ) {
                        if ( !is_string( $key ) ) {
                            throw new InvalidArgumentException(
                                "Invalid collated file path list key error. " .
                                "'$key' given, string expected."
                            );
                        }
                        $this->{$member}[$key] = (array)$value;
                    }
                    break;
                case 'deprecated':
                    $this->deprecated = $option;
                    break;
                // Lists of strings
                case 'dependencies':
                case 'messages':
                case 'targets':
                    // Normalise
                    $option = array_values( array_unique( (array)$option ) );
                    sort( $option );

                    $this->{$member} = $option;
                    break;
                // Single strings
                case 'position':
                case 'group':
                case 'skipFunction':
                    $this->{$member} = (string)$option;
                    break;
                // Single booleans
                case 'debugRaw':
                case 'raw':
                case 'noflip':
                    $this->{$member} = (bool)$option;
                    break;
            }
        }
        if ( $hasTemplates ) {
            $this->dependencies[] = 'mediawiki.template';
            // Ensure relevant template compiler module gets loaded
            foreach ( $this->templates as $alias => $templatePath ) {
                if ( is_int( $alias ) ) {
                    $alias = $templatePath;
                }
                $suffix = explode( '.', $alias );
                $suffix = end( $suffix );
                $compilerModule = 'mediawiki.template.' . $suffix;
                if ( $suffix !== 'html' && !in_array( $compilerModule, $this->dependencies ) ) {
                    $this->dependencies[] = $compilerModule;
                }
            }
        }
    }

    public static function extractBasePaths(
        $options = [],
        $localBasePath = null,
        $remoteBasePath = null
    ) {
        global $IP, $wgResourceBasePath;

        // The different ways these checks are done, and their ordering, look very silly,
        // but were preserved for backwards-compatibility just in case. Tread lightly.

        if ( $localBasePath === null ) {
            $localBasePath = $IP;
        }
        if ( $remoteBasePath === null ) {
            $remoteBasePath = $wgResourceBasePath;
        }

        if ( isset( $options['remoteExtPath'] ) ) {
            global $wgExtensionAssetsPath;
            $remoteBasePath = $wgExtensionAssetsPath . '/' . $options['remoteExtPath'];
        }

        if ( isset( $options['remoteSkinPath'] ) ) {
            global $wgStylePath;
            $remoteBasePath = $wgStylePath . '/' . $options['remoteSkinPath'];
        }

        if ( array_key_exists( 'localBasePath', $options ) ) {
            $localBasePath = (string)$options['localBasePath'];
        }

        if ( array_key_exists( 'remoteBasePath', $options ) ) {
            $remoteBasePath = (string)$options['remoteBasePath'];
        }

        return [ $localBasePath, $remoteBasePath ];
    }

    public function getScript( ResourceLoaderContext $context ) {
        $files = $this->getScriptFiles( $context );
        return $this->getDeprecationInformation() . $this->readScriptFiles( $files );
    }

    public function getScriptURLsForDebug( ResourceLoaderContext $context ) {
        $urls = [];
        foreach ( $this->getScriptFiles( $context ) as $file ) {
            $urls[] = OutputPage::transformResourcePath(
                $this->getConfig(),
                $this->getRemotePath( $file )
            );
        }
        return $urls;
    }

    public function supportsURLLoading() {
        return $this->debugRaw;
    }

    public function getStyles( ResourceLoaderContext $context ) {
        $styles = $this->readStyleFiles(
            $this->getStyleFiles( $context ),
            $this->getFlip( $context ),
            $context
        );
        // Collect referenced files
        $this->saveFileDependencies( $context, $this->localFileRefs );

        return $styles;
    }

    public function getStyleURLsForDebug( ResourceLoaderContext $context ) {
        if ( $this->hasGeneratedStyles ) {
            // Do the default behaviour of returning a url back to load.php
            // but with only=styles.
            return parent::getStyleURLsForDebug( $context );
        }
        // Our module consists entirely of real css files,
        // in debug mode we can load those directly.
        $urls = [];
        foreach ( $this->getStyleFiles( $context ) as $mediaType => $list ) {
            $urls[$mediaType] = [];
            foreach ( $list as $file ) {
                $urls[$mediaType][] = OutputPage::transformResourcePath(
                    $this->getConfig(),
                    $this->getRemotePath( $file )
                );
            }
        }
        return $urls;
    }

    public function getMessages() {
        return $this->messages;
    }

    public function getGroup() {
        return $this->group;
    }

    public function getPosition() {
        return $this->position;
    }

    public function getDependencies( ResourceLoaderContext $context = null ) {
        return $this->dependencies;
    }

    public function getSkipFunction() {
        if ( !$this->skipFunction ) {
            return null;
        }

        $localPath = $this->getLocalPath( $this->skipFunction );
        if ( !file_exists( $localPath ) ) {
            throw new MWException( __METHOD__ . ": skip function file not found: \"$localPath\"" );
        }
        $contents = $this->stripBom( file_get_contents( $localPath ) );
        if ( $this->getConfig()->get( 'ResourceLoaderValidateStaticJS' ) ) {
            $contents = $this->validateScriptFile( $localPath, $contents );
        }
        return $contents;
    }

    public function isRaw() {
        return $this->raw;
    }

    public function enableModuleContentVersion() {
        return false;
    }

    protected function getFileHashes( ResourceLoaderContext $context ) {
        $files = [];

        // Flatten style files into $files
        $styles = self::collateFilePathListByOption( $this->styles, 'media', 'all' );
        foreach ( $styles as $styleFiles ) {
            $files = array_merge( $files, $styleFiles );
        }

        $skinFiles = self::collateFilePathListByOption(
            self::tryForKey( $this->skinStyles, $context->getSkin(), 'default' ),
            'media',
            'all'
        );
        foreach ( $skinFiles as $styleFiles ) {
            $files = array_merge( $files, $styleFiles );
        }

        // Final merge, this should result in a master list of dependent files
        $files = array_merge(
            $files,
            $this->scripts,
            $this->templates,
            $context->getDebug() ? $this->debugScripts : [],
            $this->getLanguageScripts( $context->getLanguage() ),
            self::tryForKey( $this->skinScripts, $context->getSkin(), 'default' )
        );
        if ( $this->skipFunction ) {
            $files[] = $this->skipFunction;
        }
        $files = array_map( [ $this, 'getLocalPath' ], $files );
        // File deps need to be treated separately because they're already prefixed
        $files = array_merge( $files, $this->getFileDependencies( $context ) );
        // Filter out any duplicates from getFileDependencies() and others.
        // Most commonly introduced by compileLessFile(), which always includes the
        // entry point Less file we already know about.
        $files = array_values( array_unique( $files ) );

        // Don't include keys or file paths here, only the hashes. Including that would needlessly
        // cause global cache invalidation when files move or if e.g. the MediaWiki path changes.
        // Any significant ordering is already detected by the definition summary.
        return array_map( [ __CLASS__, 'safeFileHash' ], $files );
    }

    public function getDefinitionSummary( ResourceLoaderContext $context ) {
        $summary = parent::getDefinitionSummary( $context );

        $options = [];
        foreach ( [
            // The following properties are omitted because they don't affect the module reponse:
            // - localBasePath (Per T104950; Changes when absolute directory name changes. If
            //    this affects 'scripts' and other file paths, getFileHashes accounts for that.)
            // - remoteBasePath (Per T104950)
            // - dependencies (provided via startup module)
            // - targets
            // - group (provided via startup module)
            // - position (only used by OutputPage)
            'scripts',
            'debugScripts',
            'styles',
            'languageScripts',
            'skinScripts',
            'skinStyles',
            'messages',
            'templates',
            'skipFunction',
            'debugRaw',
            'raw',
        ] as $member ) {
            $options[$member] = $this->{$member};
        };

        $summary[] = [
            'options' => $options,
            'fileHashes' => $this->getFileHashes( $context ),
            'messageBlob' => $this->getMessageBlob( $context ),
        ];
        return $summary;
    }

    protected function getLocalPath( $path ) {
        if ( $path instanceof ResourceLoaderFilePath ) {
            return $path->getLocalPath();
        }

        return "{$this->localBasePath}/$path";
    }

    protected function getRemotePath( $path ) {
        if ( $path instanceof ResourceLoaderFilePath ) {
            return $path->getRemotePath();
        }

        return "{$this->remoteBasePath}/$path";
    }

    public function getStyleSheetLang( $path ) {
        return preg_match( '/\.less$/i', $path ) ? 'less' : 'css';
    }

    protected static function collateFilePathListByOption( array $list, $option, $default ) {
        $collatedFiles = [];
        foreach ( (array)$list as $key => $value ) {
            if ( is_int( $key ) ) {
                // File name as the value
                if ( !isset( $collatedFiles[$default] ) ) {
                    $collatedFiles[$default] = [];
                }
                $collatedFiles[$default][] = $value;
            } elseif ( is_array( $value ) ) {
                // File name as the key, options array as the value
                $optionValue = isset( $value[$option] ) ? $value[$option] : $default;
                if ( !isset( $collatedFiles[$optionValue] ) ) {
                    $collatedFiles[$optionValue] = [];
                }
                $collatedFiles[$optionValue][] = $key;
            }
        }
        return $collatedFiles;
    }

    protected static function tryForKey( array $list, $key, $fallback = null ) {
        if ( isset( $list[$key] ) && is_array( $list[$key] ) ) {
            return $list[$key];
        } elseif ( is_string( $fallback )
            && isset( $list[$fallback] )
            && is_array( $list[$fallback] )
        ) {
            return $list[$fallback];
        }
        return [];
    }

    protected function getScriptFiles( ResourceLoaderContext $context ) {
        $files = array_merge(
            $this->scripts,
            $this->getLanguageScripts( $context->getLanguage() ),
            self::tryForKey( $this->skinScripts, $context->getSkin(), 'default' )
        );
        if ( $context->getDebug() ) {
            $files = array_merge( $files, $this->debugScripts );
        }

        return array_unique( $files, SORT_REGULAR );
    }

    private function getLanguageScripts( $lang ) {
        $scripts = self::tryForKey( $this->languageScripts, $lang );
        if ( $scripts ) {
            return $scripts;
        }
        $fallbacks = Language::getFallbacksFor( $lang );
        foreach ( $fallbacks as $lang ) {
            $scripts = self::tryForKey( $this->languageScripts, $lang );
            if ( $scripts ) {
                return $scripts;
            }
        }

        return [];
    }

    public function getStyleFiles( ResourceLoaderContext $context ) {
        return array_merge_recursive(
            self::collateFilePathListByOption( $this->styles, 'media', 'all' ),
            self::collateFilePathListByOption(
                self::tryForKey( $this->skinStyles, $context->getSkin(), 'default' ),
                'media',
                'all'
            )
        );
    }

    protected function getSkinStyleFiles( $skinName ) {
        return self::collateFilePathListByOption(
            self::tryForKey( $this->skinStyles, $skinName ),
            'media',
            'all'
        );
    }

    protected function getAllSkinStyleFiles() {
        $styleFiles = [];
        $internalSkinNames = array_keys( Skin::getSkinNames() );
        $internalSkinNames[] = 'default';

        foreach ( $internalSkinNames as $internalSkinName ) {
            $styleFiles = array_merge_recursive(
                $styleFiles,
                $this->getSkinStyleFiles( $internalSkinName )
            );
        }

        return $styleFiles;
    }

    public function getAllStyleFiles() {
        $collatedStyleFiles = array_merge_recursive(
            self::collateFilePathListByOption( $this->styles, 'media', 'all' ),
            $this->getAllSkinStyleFiles()
        );

        $result = [];

        foreach ( $collatedStyleFiles as $media => $styleFiles ) {
            foreach ( $styleFiles as $styleFile ) {
                $result[] = $this->getLocalPath( $styleFile );
            }
        }

        return $result;
    }

    protected function readScriptFiles( array $scripts ) {
        if ( empty( $scripts ) ) {
            return '';
        }
        $js = '';
        foreach ( array_unique( $scripts, SORT_REGULAR ) as $fileName ) {
            $localPath = $this->getLocalPath( $fileName );
            if ( !file_exists( $localPath ) ) {
                throw new MWException( __METHOD__ . ": script file not found: \"$localPath\"" );
            }
            $contents = $this->stripBom( file_get_contents( $localPath ) );
            if ( $this->getConfig()->get( 'ResourceLoaderValidateStaticJS' ) ) {
                // Static files don't really need to be checked as often; unlike
                // on-wiki module they shouldn't change unexpectedly without
                // admin interference.
                $contents = $this->validateScriptFile( $fileName, $contents );
            }
            $js .= $contents . "\n";
        }
        return $js;
    }

    public function readStyleFiles( array $styles, $flip, $context = null ) {
        if ( $context === null ) {
            wfDeprecated( __METHOD__ . ' without a ResourceLoader context', '1.27' );
            $context = ResourceLoaderContext::newDummyContext();
        }

        if ( empty( $styles ) ) {
            return [];
        }
        foreach ( $styles as $media => $files ) {
            $uniqueFiles = array_unique( $files, SORT_REGULAR );
            $styleFiles = [];
            foreach ( $uniqueFiles as $file ) {
                $styleFiles[] = $this->readStyleFile( $file, $flip, $context );
            }
            $styles[$media] = implode( "\n", $styleFiles );
        }
        return $styles;
    }

    protected function readStyleFile( $path, $flip, $context ) {
        $localPath = $this->getLocalPath( $path );
        $remotePath = $this->getRemotePath( $path );
        if ( !file_exists( $localPath ) ) {
            $msg = __METHOD__ . ": style file not found: \"$localPath\"";
            wfDebugLog( 'resourceloader', $msg );
            throw new MWException( $msg );
        }

        if ( $this->getStyleSheetLang( $localPath ) === 'less' ) {
            $style = $this->compileLessFile( $localPath, $context );
            $this->hasGeneratedStyles = true;
        } else {
            $style = $this->stripBom( file_get_contents( $localPath ) );
        }

        if ( $flip ) {
            $style = CSSJanus::transform( $style, true, false );
        }
        $localDir = dirname( $localPath );
        $remoteDir = dirname( $remotePath );
        // Get and register local file references
        $localFileRefs = CSSMin::getLocalFileReferences( $style, $localDir );
        foreach ( $localFileRefs as $file ) {
            if ( file_exists( $file ) ) {
                $this->localFileRefs[] = $file;
            } else {
                $this->missingLocalFileRefs[] = $file;
            }
        }
        // Don't cache this call. remap() ensures data URIs embeds are up to date,
        // and urls contain correct content hashes in their query string. (T128668)
        return CSSMin::remap( $style, $localDir, $remoteDir, true );
    }

    public function getFlip( $context ) {
        return $context->getDirection() === 'rtl' && !$this->noflip;
    }

    public function getTargets() {
        return $this->targets;
    }

    public function getType() {
        $canBeStylesOnly = !(
            // All options except 'styles', 'skinStyles' and 'debugRaw'
            $this->scripts
            || $this->debugScripts
            || $this->templates
            || $this->languageScripts
            || $this->skinScripts
            || $this->dependencies
            || $this->messages
            || $this->skipFunction
            || $this->raw
        );
        return $canBeStylesOnly ? self::LOAD_STYLES : self::LOAD_GENERAL;
    }

    protected function compileLessFile( $fileName, ResourceLoaderContext $context ) {
        static $cache;

        if ( !$cache ) {
            $cache = ObjectCache::getLocalServerInstance( CACHE_ANYTHING );
        }

        // Construct a cache key from the LESS file name and a hash digest
        // of the LESS variables used for compilation.
        $vars = $this->getLessVars( $context );
        ksort( $vars );
        $varsHash = hash( 'md4', serialize( $vars ) );
        $cacheKey = $cache->makeGlobalKey( 'LESS', $fileName, $varsHash );
        $cachedCompile = $cache->get( $cacheKey );

        // If we got a cached value, we have to validate it by getting a
        // checksum of all the files that were loaded by the parser and
        // ensuring it matches the cached entry's.
        if ( isset( $cachedCompile['hash'] ) ) {
            $contentHash = FileContentsHasher::getFileContentsHash( $cachedCompile['files'] );
            if ( $contentHash === $cachedCompile['hash'] ) {
                $this->localFileRefs = array_merge( $this->localFileRefs, $cachedCompile['files'] );
                return $cachedCompile['css'];
            }
        }

        $compiler = $context->getResourceLoader()->getLessCompiler( $vars );
        $css = $compiler->parseFile( $fileName )->getCss();
        $files = $compiler->AllParsedFiles();
        $this->localFileRefs = array_merge( $this->localFileRefs, $files );

        $cache->set( $cacheKey, [
            'css'   => $css,
            'files' => $files,
            'hash'  => FileContentsHasher::getFileContentsHash( $files ),
        ], 60 * 60 * 24 );  // 86400 seconds, or 24 hours.

        return $css;
    }

    public function getTemplates() {
        $templates = [];

        foreach ( $this->templates as $alias => $templatePath ) {
            // Alias is optional
            if ( is_int( $alias ) ) {
                $alias = $templatePath;
            }
            $localPath = $this->getLocalPath( $templatePath );
            if ( file_exists( $localPath ) ) {
                $content = file_get_contents( $localPath );
                $templates[$alias] = $this->stripBom( $content );
            } else {
                $msg = __METHOD__ . ": template file not found: \"$localPath\"";
                wfDebugLog( 'resourceloader', $msg );
                throw new MWException( $msg );
            }
        }
        return $templates;
    }

    protected function stripBom( $input ) {
        if ( substr_compare( "\xef\xbb\xbf", $input, 0, 3 ) === 0 ) {
            return substr( $input, 3 );
        }
        return $input;
    }
}