wiki.techinc.nl/includes/resourceloader/ResourceLoaderFileModule.php

<?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 */

	/** @var {string} Local base path, see __construct() */
	protected $localBasePath = '';
	/** @var {string} Remote base path, see __construct() */
	protected $remoteBasePath = '';
	/**
	 * @var {array} List of paths to JavaScript files to always include
	 * @format array( [file-path], [file-path], ... )
	 */
	protected $scripts = array();
	/**
	 * @var {array} List of JavaScript files to include when using a specific language
	 * @format array( [language-code] => array( [file-path], [file-path], ... ), ... )
	 */
	protected $languageScripts = array();
	/**
	 * @var {array} List of JavaScript files to include when using a specific skin
	 * @format array( [skin-name] => array( [file-path], [file-path], ... ), ... )
	 */
	protected $skinScripts = array();
	/**
	 * @var {array} List of paths to JavaScript files to include in debug mode
	 * @format array( [skin-name] => array( [file-path], [file-path], ... ), ... )
	 */
	protected $debugScripts = array();
	/**
	 * @var {array} List of paths to JavaScript files to include in the startup module
	 * @format array( [file-path], [file-path], ... )
	 */
	protected $loaderScripts = array();
	/**
	 * @var {array} List of paths to CSS files to always include
	 * @format array( [file-path], [file-path], ... )
	 */
	protected $styles = array();
	/**
	 * @var {array} List of paths to CSS files to include when using specific skins
	 * @format array( [file-path], [file-path], ... )
	 */
	protected $skinStyles = array();
	/**
	 * @var {array} List of modules this module depends on
	 * @format array( [file-path], [file-path], ... )
	 */
	protected $dependencies = array();
	/**
	 * @var {array} List of message keys used by this module
	 * @format array( [message-key], [message-key], ... )
	 */
	protected $messages = array();
	/** @var {string} Name of group to load this module in */
	protected $group;
	/** @var {boolean} Link to raw files in debug mode */
	protected $debugRaw = true;
	/**
	 * @var {array}  Cache for mtime
	 * @format array( [hash] => [mtime], [hash] => [mtime], ... )
	 */
	protected $modifiedTime = array();
	/**
	 * @var {array} Place where readStyleFile() tracks file dependencies
	 * @format array( [file-path], [file-path], ... )
	 */
	protected $localFileRefs = array();

	/* Methods */

	/**
	 * Constructs a new module from an options array.
	 * 
	 * @param {array} $options Options array. If not given or empty, an empty module will be constructed
	 * @param {string} $localBasePath base path to prepend to all local paths in $options. Defaults to $IP
	 * @param {string} $remoteBasePath base path to prepend to all remote paths in $options. Defaults to $wgScriptPath
	 * 
	 * @format $options
	 * 	array(
	 * 		// 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],
	 * 	)
	 */
	public function __construct( $options = array(), $localBasePath = null, $remoteBasePath = null ) {
		global $IP, $wgScriptPath;
		$this->localBasePath = $localBasePath === null ? $IP : $localBasePath;
		$this->remoteBasePath = $remoteBasePath === null ? $wgScriptPath : $remoteBasePath;
		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':
					$this->{$member} = (string) $option;
					break;
				// Single booleans
				case 'debugRaw':
					$this->{$member} = (bool) $option;
					break;
			}
		}
	}

	/**
	 * Gets all scripts for a given context concatenated together.
	 * 
	 * @param {ResourceLoaderContext} $context Context in which to generate script
	 * @return {string} JavaScript code for $context
	 */
	public function getScript( ResourceLoaderContext $context ) {
		global $wgServer;
		
		$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 );
			if ( $this->debugRaw ) {
				$script = '';
				foreach ( $files as $file ) {
					$path = $wgServer . $this->getRemotePath( $file );
					$script .= "\n\t" . Xml::encodeJsCall( 'mediaWiki.loader.load', array( $path ) );
				}
				return $script;
			}
		}
		return $this->readScriptFiles( $files );
	}

	/**
	 * 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 {ResourceLoaderContext} $context Context in which to generate styles
	 * @return {string} CSS code for $context
	 */
	public function getStyles( ResourceLoaderContext $context ) {
		// Merge general styles and skin specific styles, retaining media type collation
		$styles = $this->readStyleFiles( $this->styles );
		$skinStyles = $this->readStyleFiles( self::tryForKey( $this->skinStyles, $context->getSkin(), 'default' ) );
		
		foreach ( $skinStyles as $media => $style ) {
			if ( isset( $styles[$media] ) ) {
				$styles[$media] .= $style;
			} else {
				$styles[$media] = $style;
			}
		}
		// 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() ) ) {
			$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;
	}

	/**
	 * 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;
	}

	/**
	 * 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 {ResourceLoaderContext} $context 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 ) {
			return $this->modifiedTime[$context->getHash()] = 1;
		}
		
		wfProfileIn( __METHOD__.'-filemtime' );
		$filesMtime = max( array_map( 'filemtime', $files ) );
		wfProfileOut( __METHOD__.'-filemtime' );
		$this->modifiedTime[$context->getHash()] = max( $filesMtime, $this->getMsgBlobMtime( $context->getLanguage() ) );
		wfProfileOut( __METHOD__ );
		return $this->modifiedTime[$context->getHash()];
	}

	/* Protected Members */

	protected function getLocalPath( $path ) {
		return "{$this->localBasePath}/$path";
	}
	
	protected function getRemotePath( $path ) {
		return "{$this->remoteBasePath}/$path";
	}

	/**
	 * Collates file paths by option (where provided).
	 * 
	 * @param {array} $list List of file paths in any combination of index/path or path/options pairs
	 * @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;
			} else if ( 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 {array} $list List of lists to select from
	 * @param {string} $key Key to look for in $map
	 * @param {string} $fallback 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];
		} else if ( is_string( $fallback ) && isset( $list[$fallback] ) && is_array( $list[$fallback] ) ) {
			return $list[$fallback];
		}
		return array();
	}

	/**
	 * Gets the contents of a list of JavaScript files.
	 * 
	 * @param {array} $scripts 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 ) {
		if ( empty( $scripts ) ) {
			return '';
		}
		return implode( "\n", array_map( 'file_get_contents', array_map( array( $this, 'getLocalPath' ), array_unique( $scripts ) ) ) );
	}

	/**
	 * Gets the contents of a list of CSS files.
	 * 
	 * @param {array} $styles List of file paths to styles to read, remap and concetenate
	 * @return {array} List of concatenated and remapped CSS data from $styles, keyed by media type
	 */
	protected function readStyleFiles( array $styles ) {
		if ( empty( $styles ) ) {
			return array();
		}
		$styles = self::collateFilePathListByOption( $styles, 'media', 'all' );
		foreach ( $styles as $media => $files ) {
			$styles[$media] = implode(
				"\n", array_map( array( $this, 'readStyleFile' ), array_unique( $files ) )
			);
		}
		return $styles;
	}

	/**
	 * Reads a style file.
	 * 
	 * This method can be used as a callback for array_map()
	 * 
	 * @param {string} $path File path of script file to read
	 * @return {string} CSS data in script file
	 */
	protected function readStyleFile( $path ) {	
		$style = file_get_contents( $this->getLocalPath( $path ) );
		$dir = $this->getLocalPath( dirname( $path ) );
		$remoteDir = $this->getRemotePath( dirname( $path ) );
		// Get and register local file references
		$this->localFileRefs = array_merge( $this->localFileRefs, CSSMin::getLocalFileReferences( $style, $dir ) );
		return CSSMin::remap(
			$style, $dir, $remoteDir, true
		);
	}
}