/includes/resourceloader/ResourceLoaderFileModule.php
PHP | 656 lines | 300 code | 36 blank | 320 comment | 30 complexity | 8920a8885799b7bfb12295518d2ff794 MD5 | raw file
Possible License(s): GPL-2.0, Apache-2.0, LGPL-3.0
- <?php
- /**
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * http://www.gnu.org/copyleft/gpl.html
- *
- * @file
- * @author Trevor Parscal
- * @author Roan Kattouw
- */
- /**
- * ResourceLoader module based on local JavaScript/CSS files.
- */
- class ResourceLoaderFileModule extends ResourceLoaderModule {
- /* Protected Members */
- /** String: Local base path, see __construct() */
- protected $localBasePath = '';
- /** String: Remote base path, see __construct() */
- protected $remoteBasePath = '';
- /**
- * Array: List of paths to JavaScript files to always include
- * @par Usage:
- * @code
- * array( [file-path], [file-path], ... )
- * @endcode
- */
- protected $scripts = array();
- /**
- * Array: List of JavaScript files to include when using a specific language
- * @par Usage:
- * @code
- * array( [language-code] => array( [file-path], [file-path], ... ), ... )
- * @endcode
- */
- protected $languageScripts = array();
- /**
- * Array: List of JavaScript files to include when using a specific skin
- * @par Usage:
- * @code
- * array( [skin-name] => array( [file-path], [file-path], ... ), ... )
- * @endcode
- */
- protected $skinScripts = array();
- /**
- * Array: List of paths to JavaScript files to include in debug mode
- * @par Usage:
- * @code
- * array( [skin-name] => array( [file-path], [file-path], ... ), ... )
- * @endcode
- */
- protected $debugScripts = array();
- /**
- * Array: List of paths to JavaScript files to include in the startup module
- * @par Usage:
- * @code
- * array( [file-path], [file-path], ... )
- * @endcode
- */
- protected $loaderScripts = array();
- /**
- * Array: List of paths to CSS files to always include
- * @par Usage:
- * @code
- * array( [file-path], [file-path], ... )
- * @endcode
- */
- protected $styles = array();
- /**
- * Array: List of paths to CSS files to include when using specific skins
- * @par Usage:
- * @code
- * array( [file-path], [file-path], ... )
- * @endcode
- */
- protected $skinStyles = array();
- /**
- * Array: List of modules this module depends on
- * @par Usage:
- * @code
- * array( [file-path], [file-path], ... )
- * @endcode
- */
- protected $dependencies = array();
- /**
- * Array: List of message keys used by this module
- * @par Usage:
- * @code
- * array( [message-key], [message-key], ... )
- * @endcode
- */
- protected $messages = array();
- /** String: Name of group to load this module in */
- protected $group;
- /** String: Position on the page to load this module at */
- protected $position = 'bottom';
- /** Boolean: Link to raw files in debug mode */
- protected $debugRaw = true;
- /**
- * Array: Cache for mtime
- * @par Usage:
- * @code
- * array( [hash] => [mtime], [hash] => [mtime], ... )
- * @endcode
- */
- protected $modifiedTime = array();
- /**
- * Array: Place where readStyleFile() tracks file dependencies
- * @par Usage:
- * @code
- * array( [file-path], [file-path], ... )
- * @endcode
- */
- protected $localFileRefs = array();
- /* Methods */
- /**
- * Constructs a new module from an options array.
- *
- * @param $options Array: List of options; if not given or empty, an empty module will be
- * constructed
- * @param $localBasePath String: Base path to prepend to all local paths in $options. Defaults
- * to $IP
- * @param $remoteBasePath String: Base path to prepend to all remote paths in $options. Defaults
- * to $wgScriptPath
- *
- * Below is a description for the $options array:
- * @par Construction options:
- * @code
- * array(
- * // Base path to prepend to all local paths in $options. Defaults to $IP
- * 'localBasePath' => [base path],
- * // Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath
- * 'remoteBasePath' => [base path],
- * // Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath
- * 'remoteExtPath' => [base path],
- * // Scripts to always include
- * 'scripts' => [file path string or array of file path strings],
- * // Scripts to include in specific language contexts
- * 'languageScripts' => array(
- * [language code] => [file path string or array of file path strings],
- * ),
- * // Scripts to include in specific skin contexts
- * 'skinScripts' => array(
- * [skin name] => [file path string or array of file path strings],
- * ),
- * // Scripts to include in debug contexts
- * 'debugScripts' => [file path string or array of file path strings],
- * // Scripts to include in the startup module
- * 'loaderScripts' => [file path string or array of file path strings],
- * // Modules which must be loaded before this module
- * 'dependencies' => [modile name string or array of module name strings],
- * // Styles to always load
- * 'styles' => [file path string or array of file path strings],
- * // Styles to include in specific skin contexts
- * 'skinStyles' => array(
- * [skin name] => [file path string or array of file path strings],
- * ),
- * // Messages to always load
- * 'messages' => [array of message key strings],
- * // Group which this module should be loaded together with
- * 'group' => [group name string],
- * // Position on the page to load this module at
- * 'position' => ['bottom' (default) or 'top']
- * )
- * @endcode
- */
- public function __construct( $options = array(), $localBasePath = null,
- $remoteBasePath = null )
- {
- global $IP, $wgScriptPath, $wgResourceBasePath;
- $this->localBasePath = $localBasePath === null ? $IP : $localBasePath;
- if ( $remoteBasePath !== null ) {
- $this->remoteBasePath = $remoteBasePath;
- } else {
- $this->remoteBasePath = $wgResourceBasePath === null ? $wgScriptPath : $wgResourceBasePath;
- }
- if ( isset( $options['remoteExtPath'] ) ) {
- global $wgExtensionAssetsPath;
- $this->remoteBasePath = $wgExtensionAssetsPath . '/' . $options['remoteExtPath'];
- }
- 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':
- $this->{$member} = (array) $option;
- break;
- // Single strings
- case 'group':
- case 'position':
- case 'localBasePath':
- case 'remoteBasePath':
- $this->{$member} = (string) $option;
- break;
- // Single booleans
- case 'debugRaw':
- $this->{$member} = (bool) $option;
- break;
- }
- }
- // Make sure the remote base path is a complete valid URL,
- // but possibly protocol-relative to avoid cache pollution
- $this->remoteBasePath = wfExpandUrl( $this->remoteBasePath, PROTO_RELATIVE );
- }
- /**
- * Gets all scripts for a given context concatenated together.
- *
- * @param $context ResourceLoaderContext: Context in which to generate script
- * @return String: JavaScript code for $context
- */
- public function getScript( ResourceLoaderContext $context ) {
- $files = $this->getScriptFiles( $context );
- return $this->readScriptFiles( $files );
- }
- /**
- * @param $context ResourceLoaderContext
- * @return array
- */
- public function getScriptURLsForDebug( ResourceLoaderContext $context ) {
- $urls = array();
- foreach ( $this->getScriptFiles( $context ) as $file ) {
- $urls[] = $this->getRemotePath( $file );
- }
- return $urls;
- }
- /**
- * @return bool
- */
- public function supportsURLLoading() {
- return $this->debugRaw;
- }
- /**
- * Gets loader script.
- *
- * @return String: JavaScript code to be added to startup module
- */
- public function getLoaderScript() {
- if ( count( $this->loaderScripts ) == 0 ) {
- return false;
- }
- return $this->readScriptFiles( $this->loaderScripts );
- }
- /**
- * Gets all styles for a given context concatenated together.
- *
- * @param $context ResourceLoaderContext: Context in which to generate styles
- * @return String: CSS code for $context
- */
- public function getStyles( ResourceLoaderContext $context ) {
- $styles = $this->readStyleFiles(
- $this->getStyleFiles( $context ),
- $this->getFlip( $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
- if ( $this->localFileRefs !== $this->getFileDependencies( $context->getSkin() ) && !wfReadOnly() ) {
- $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 ),
- )
- );
- }
- return $styles;
- }
- /**
- * @param $context ResourceLoaderContext
- * @return array
- */
- public function getStyleURLsForDebug( ResourceLoaderContext $context ) {
- $urls = array();
- foreach ( $this->getStyleFiles( $context ) as $mediaType => $list ) {
- $urls[$mediaType] = array();
- foreach ( $list as $file ) {
- $urls[$mediaType][] = $this->getRemotePath( $file );
- }
- }
- return $urls;
- }
- /**
- * Gets list of message keys used by this module.
- *
- * @return Array: List of message keys
- */
- public function getMessages() {
- return $this->messages;
- }
- /**
- * Gets the name of the group this module should be loaded in.
- *
- * @return String: Group name
- */
- public function getGroup() {
- return $this->group;
- }
- /**
- * @return string
- */
- public function getPosition() {
- return $this->position;
- }
- /**
- * Gets list of names of modules this module depends on.
- *
- * @return Array: List of module names
- */
- public function getDependencies() {
- return $this->dependencies;
- }
- /**
- * Get the last modified timestamp of this module.
- *
- * Last modified timestamps are calculated from the highest last modified
- * timestamp of this module's constituent files as well as the files it
- * depends on. This function is context-sensitive, only performing
- * calculations on files relevant to the given language, skin and debug
- * mode.
- *
- * @param $context ResourceLoaderContext: Context in which to calculate
- * the modified time
- * @return Integer: UNIX timestamp
- * @see ResourceLoaderModule::getFileDependencies
- */
- 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::tryForKey(
- self::collateFilePathListByOption( $this->skinStyles, 'media', 'all' ),
- $context->getSkin(),
- 'default'
- );
- 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
- );
- $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 ) {
- wfProfileOut( __METHOD__ );
- return $this->modifiedTime[$context->getHash()] = 1;
- }
- wfProfileIn( __METHOD__.'-filemtime' );
- $filesMtime = max( array_map( array( __CLASS__, 'safeFilemtime' ), $files ) );
- wfProfileOut( __METHOD__.'-filemtime' );
- $this->modifiedTime[$context->getHash()] = max(
- $filesMtime,
- $this->getMsgBlobMtime( $context->getLanguage() ) );
- wfProfileOut( __METHOD__ );
- return $this->modifiedTime[$context->getHash()];
- }
- /* Protected Methods */
- /**
- * @param $path string
- * @return string
- */
- protected function getLocalPath( $path ) {
- return "{$this->localBasePath}/$path";
- }
- /**
- * @param $path string
- * @return string
- */
- protected function getRemotePath( $path ) {
- return "{$this->remoteBasePath}/$path";
- }
- /**
- * Collates file paths by option (where provided).
- *
- * @param $list Array: List of file paths in any combination of index/path
- * or path/options pairs
- * @param $option String: option name
- * @param $default Mixed: default value if the option isn't set
- * @return Array: List of file paths, collated by $option
- */
- 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;
- }
- /**
- * Gets a list of element that match a key, optionally using a fallback key.
- *
- * @param $list Array: List of lists to select from
- * @param $key String: Key to look for in $map
- * @param $fallback String: Key to look for in $list if $key doesn't exist
- * @return Array: List of elements from $map which matched $key or $fallback,
- * or an empty list in case of no match
- */
- 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();
- }
- /**
- * Gets a list of file paths for all scripts in this module, in order of propper execution.
- *
- * @param $context ResourceLoaderContext: Context
- * @return Array: List of file paths
- */
- 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 $files;
- }
- /**
- * Gets a list of file paths for all styles in this module, in order of propper inclusion.
- *
- * @param $context ResourceLoaderContext: Context
- * @return Array: List of file paths
- */
- protected 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'
- )
- );
- }
- /**
- * Gets the contents of a list of JavaScript files.
- *
- * @param $scripts Array: List of file paths to scripts to read, remap and concetenate
- * @return String: Concatenated and remapped JavaScript data from $scripts
- */
- protected function readScriptFiles( array $scripts ) {
- global $wgResourceLoaderValidateStaticJS;
- if ( empty( $scripts ) ) {
- return '';
- }
- $js = '';
- foreach ( array_unique( $scripts ) 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 ( $wgResourceLoaderValidateStaticJS ) {
- // 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;
- }
- /**
- * Gets the contents of a list of CSS files.
- *
- * @param $styles Array: List of media type/list of file paths pairs, to read, remap and
- * concetenate
- *
- * @param $flip bool
- *
- * @return Array: List of concatenated and remapped CSS data from $styles,
- * keyed by media type
- */
- protected function readStyleFiles( array $styles, $flip ) {
- if ( empty( $styles ) ) {
- return array();
- }
- foreach ( $styles as $media => $files ) {
- $uniqueFiles = array_unique( $files );
- $styles[$media] = implode(
- "\n",
- array_map(
- array( $this, 'readStyleFile' ),
- $uniqueFiles,
- array_fill( 0, count( $uniqueFiles ), $flip )
- )
- );
- }
- return $styles;
- }
- /**
- * Reads a style file.
- *
- * This method can be used as a callback for array_map()
- *
- * @param $path String: File path of style file to read
- * @param $flip bool
- *
- * @return String: CSS data in script file
- * @throws MWException if the file doesn't exist
- */
- protected function readStyleFile( $path, $flip ) {
- $localPath = $this->getLocalPath( $path );
- if ( !file_exists( $localPath ) ) {
- throw new MWException( __METHOD__.": style file not found: \"$localPath\"" );
- }
- $style = file_get_contents( $localPath );
- if ( $flip ) {
- $style = CSSJanus::transform( $style, true, false );
- }
- $dirname = dirname( $path );
- if ( $dirname == '.' ) {
- // If $path doesn't have a directory component, don't prepend a dot
- $dirname = '';
- }
- $dir = $this->getLocalPath( $dirname );
- $remoteDir = $this->getRemotePath( $dirname );
- // Get and register local file references
- $this->localFileRefs = array_merge(
- $this->localFileRefs,
- CSSMin::getLocalFileReferences( $style, $dir ) );
- return CSSMin::remap(
- $style, $dir, $remoteDir, true
- );
- }
- /**
- * Safe version of filemtime(), which doesn't throw a PHP warning if the file doesn't exist
- * but returns 1 instead.
- * @param $filename string File name
- * @return int UNIX timestamp, or 1 if the file doesn't exist
- */
- protected static function safeFilemtime( $filename ) {
- if ( file_exists( $filename ) ) {
- return filemtime( $filename );
- } else {
- // We only ever map this function on an array if we're gonna call max() after,
- // so return our standard minimum timestamps here. This is 1, not 0, because
- // wfTimestamp(0) == NOW
- return 1;
- }
- }
- /**
- * Get whether CSS for this module should be flipped
- * @param $context ResourceLoaderContext
- * @return bool
- */
- public function getFlip( $context ) {
- return $context->getDirection() === 'rtl';
- }
- }