ResourceLoaderFileModule.php

Go to the documentation of this file.

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

    protected $localBasePath = '';

    protected $remoteBasePath = '';

    protected $scripts = array();

    protected $languageScripts = array();

    protected $skinScripts = array();

    protected $debugScripts = array();

    protected $loaderScripts = array();

    protected $styles = array();

    protected $skinStyles = array();

    protected $dependencies = array();

    protected $skipFunction = null;

    protected $messages = array();

    protected $group;

    protected $position = 'bottom';

    protected $debugRaw = true;

    protected $raw = false;

    protected $targets = array( 'desktop' );

    protected $hasGeneratedStyles = false;

    protected $modifiedTime = array();

    protected $localFileRefs = array();

    /* Methods */

    public function __construct(
        $options = array(),
        $localBasePath = null,
        $remoteBasePath = null
    ) {
        // 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 'loaderScripts':
                case 'styles':
                    $this->{$member} = (array)$option;
                    break;
                // Collated lists of file paths
                case 'languageScripts':
                case 'skinScripts':
                case 'skinStyles':
                    if ( !is_array( $option ) ) {
                        throw new MWException(
                            "Invalid collated file path list error. " .
                            "'$option' given, array expected."
                        );
                    }
                    foreach ( $option as $key => $value ) {
                        if ( !is_string( $key ) ) {
                            throw new MWException(
                                "Invalid collated file path list key error. " .
                                "'$key' given, string expected."
                            );
                        }
                        $this->{$member}[$key] = (array)$value;
                    }
                    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 'group':
                case 'position':
                case 'skipFunction':
                    $this->{$member} = (string)$option;
                    break;
                // Single booleans
                case 'debugRaw':
                case 'raw':
                    $this->{$member} = (bool)$option;
                    break;
            }
        }
    }

    public static function extractBasePaths(
        $options = array(),
        $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.

        $localBasePath = $localBasePath === null ? $IP : $localBasePath;
        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'];
        }

        // Make sure the remote base path is a complete valid URL,
        // but possibly protocol-relative to avoid cache pollution
        $remoteBasePath = wfExpandUrl( $remoteBasePath, PROTO_RELATIVE );

        return array( $localBasePath, $remoteBasePath );
    }

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

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

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

    public function getLoaderScript() {
        if ( count( $this->loaderScripts ) === 0 ) {
            return false;
        }
        return $this->readScriptFiles( $this->loaderScripts );
    }

    public function getStyles( ResourceLoaderContext $context ) {
        $styles = $this->readStyleFiles(
            $this->getStyleFiles( $context ),
            $this->getFlip( $context ),
            $context
        );
        // Collect referenced files
        $this->localFileRefs = array_unique( $this->localFileRefs );
        // If the list has been modified since last time we cached it, update the cache
        try {
            if ( $this->localFileRefs !== $this->getFileDependencies( $context->getSkin() ) ) {
                $dbw = wfGetDB( DB_MASTER );
                $dbw->replace( 'module_deps',
                    array( array( 'md_module', 'md_skin' ) ), array(
                        'md_module' => $this->getName(),
                        'md_skin' => $context->getSkin(),
                        'md_deps' => FormatJson::encode( $this->localFileRefs ),
                    )
                );
            }
        } catch ( Exception $e ) {
            wfDebugLog( 'resourceloader', __METHOD__ . ": failed to update DB: $e" );
        }
        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 = array();
        foreach ( $this->getStyleFiles( $context ) as $mediaType => $list ) {
            $urls[$mediaType] = array();
            foreach ( $list as $file ) {
                $urls[$mediaType][] = $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() {
        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 = file_get_contents( $localPath );
        if ( $this->getConfig()->get( 'ResourceLoaderValidateStaticJS' ) ) {
            $contents = $this->validateScriptFile( $localPath, $contents );
        }
        return $contents;
    }

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

    public function getModifiedTime( ResourceLoaderContext $context ) {
        if ( isset( $this->modifiedTime[$context->getHash()] ) ) {
            return $this->modifiedTime[$context->getHash()];
        }
        wfProfileIn( __METHOD__ );

        $files = array();

        // 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,
            $context->getDebug() ? $this->debugScripts : array(),
            self::tryForKey( $this->languageScripts, $context->getLanguage() ),
            self::tryForKey( $this->skinScripts, $context->getSkin(), 'default' ),
            $this->loaderScripts
        );
        if ( $this->skipFunction ) {
            $files[] = $this->skipFunction;
        }
        $files = array_map( array( $this, 'getLocalPath' ), $files );
        // File deps need to be treated separately because they're already prefixed
        $files = array_merge( $files, $this->getFileDependencies( $context->getSkin() ) );

        // If a module is nothing but a list of dependencies, we need to avoid
        // giving max() an empty array
        if ( count( $files ) === 0 ) {
            $this->modifiedTime[$context->getHash()] = 1;
            wfProfileOut( __METHOD__ );
            return $this->modifiedTime[$context->getHash()];
        }

        wfProfileIn( __METHOD__ . '-filemtime' );
        $filesMtime = max( array_map( array( __CLASS__, 'safeFilemtime' ), $files ) );
        wfProfileOut( __METHOD__ . '-filemtime' );

        $this->modifiedTime[$context->getHash()] = max(
            $filesMtime,
            $this->getMsgBlobMtime( $context->getLanguage() ),
            $this->getDefinitionMtime( $context )
        );

        wfProfileOut( __METHOD__ );
        return $this->modifiedTime[$context->getHash()];
    }

    public function getDefinitionSummary( ResourceLoaderContext $context ) {
        $summary = array(
            'class' => get_class( $this ),
        );
        foreach ( array(
            'scripts',
            'debugScripts',
            'loaderScripts',
            'styles',
            'languageScripts',
            'skinScripts',
            'skinStyles',
            'dependencies',
            'messages',
            'targets',
            'group',
            'position',
            'skipFunction',
            'localBasePath',
            'remoteBasePath',
            'debugRaw',
            'raw',
        ) as $member ) {
            $summary[$member] = $this->{$member};
        };
        return $summary;
    }

    /* Protected Methods */

    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 = array();
        foreach ( (array)$list as $key => $value ) {
            if ( is_int( $key ) ) {
                // File name as the value
                if ( !isset( $collatedFiles[$default] ) ) {
                    $collatedFiles[$default] = array();
                }
                $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] = array();
                }
                $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 array();
    }

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

        return array_unique( $files, SORT_REGULAR );
    }

    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 = array();
        $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 = array();

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

    protected function readStyleFile( $path, $flip, $context = null ) {
        $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' ) {
            $compiler = $this->getLessCompiler( $context );
            $style = $this->compileLessFile( $localPath, $compiler );
            $this->hasGeneratedStyles = true;
        } else {
            $style = file_get_contents( $localPath );
        }

        if ( $flip ) {
            $style = CSSJanus::transform( $style, true, false );
        }
        $localDir = dirname( $localPath );
        $remoteDir = dirname( $remotePath );
        // Get and register local file references
        $this->localFileRefs = array_merge(
            $this->localFileRefs,
            CSSMin::getLocalFileReferences( $style, $localDir )
        );
        return CSSMin::remap(
            $style, $localDir, $remoteDir, true
        );
    }

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

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

    protected function compileLessFile( $fileName, $compiler = null ) {
        if ( !$compiler ) {
            $compiler = $this->getLessCompiler();
        }
        $result = $compiler->compileFile( $fileName );
        $this->localFileRefs += array_keys( $compiler->allParsedFiles() );
        return $result;
    }

    protected function getLessCompiler( ResourceLoaderContext $context = null ) {
        return ResourceLoader::getLessCompiler( $this->getConfig() );
    }
}