3 * Resource loader module based on local JavaScript/CSS files.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @author Trevor Parscal
22 * @author Roan Kattouw
26 * ResourceLoader module based on local JavaScript/CSS files.
28 class ResourceLoaderFileModule
extends ResourceLoaderModule
{
29 /* Protected Members */
31 /** @var string Local base path, see __construct() */
32 protected $localBasePath = '';
34 /** @var string Remote base path, see __construct() */
35 protected $remoteBasePath = '';
37 /** @var array Saves a list of the templates named by the modules. */
38 protected $templates = array();
41 * @var array List of paths to JavaScript files to always include
44 * array( [file-path], [file-path], ... )
47 protected $scripts = array();
50 * @var array List of JavaScript files to include when using a specific language
53 * array( [language-code] => array( [file-path], [file-path], ... ), ... )
56 protected $languageScripts = array();
59 * @var array List of JavaScript files to include when using a specific skin
62 * array( [skin-name] => array( [file-path], [file-path], ... ), ... )
65 protected $skinScripts = array();
68 * @var array List of paths to JavaScript files to include in debug mode
71 * array( [skin-name] => array( [file-path], [file-path], ... ), ... )
74 protected $debugScripts = array();
77 * @var array List of paths to JavaScript files to include in the startup module
80 * array( [file-path], [file-path], ... )
83 protected $loaderScripts = array();
86 * @var array List of paths to CSS files to always include
89 * array( [file-path], [file-path], ... )
92 protected $styles = array();
95 * @var array List of paths to CSS files to include when using specific skins
98 * array( [file-path], [file-path], ... )
101 protected $skinStyles = array();
104 * @var array List of modules this module depends on
107 * array( [file-path], [file-path], ... )
110 protected $dependencies = array();
113 * @var string File name containing the body of the skip function
115 protected $skipFunction = null;
118 * @var array List of message keys used by this module
121 * array( [message-key], [message-key], ... )
124 protected $messages = array();
126 /** @var string Name of group to load this module in */
129 /** @var string Position on the page to load this module at */
130 protected $position = 'bottom';
132 /** @var bool Link to raw files in debug mode */
133 protected $debugRaw = true;
135 /** @var bool Whether mw.loader.state() call should be omitted */
136 protected $raw = false;
138 protected $targets = array( 'desktop' );
141 * @var bool Whether getStyleURLsForDebug should return raw file paths,
142 * or return load.php urls
144 protected $hasGeneratedStyles = false;
147 * @var array Cache for mtime
150 * array( [hash] => [mtime], [hash] => [mtime], ... )
153 protected $modifiedTime = array();
156 * @var array Place where readStyleFile() tracks file dependencies
159 * array( [file-path], [file-path], ... )
162 protected $localFileRefs = array();
167 * Constructs a new module from an options array.
169 * @param array $options List of options; if not given or empty, an empty module will be
171 * @param string $localBasePath Base path to prepend to all local paths in $options. Defaults
173 * @param string $remoteBasePath Base path to prepend to all remote paths in $options. Defaults
174 * to $wgResourceBasePath
176 * Below is a description for the $options array:
177 * @throws MWException
178 * @par Construction options:
181 * // Base path to prepend to all local paths in $options. Defaults to $IP
182 * 'localBasePath' => [base path],
183 * // Base path to prepend to all remote paths in $options. Defaults to $wgResourceBasePath
184 * 'remoteBasePath' => [base path],
185 * // Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath
186 * 'remoteExtPath' => [base path],
187 * // Equivalent of remoteBasePath, but relative to $wgStylePath
188 * 'remoteSkinPath' => [base path],
189 * // Scripts to always include
190 * 'scripts' => [file path string or array of file path strings],
191 * // Scripts to include in specific language contexts
192 * 'languageScripts' => array(
193 * [language code] => [file path string or array of file path strings],
195 * // Scripts to include in specific skin contexts
196 * 'skinScripts' => array(
197 * [skin name] => [file path string or array of file path strings],
199 * // Scripts to include in debug contexts
200 * 'debugScripts' => [file path string or array of file path strings],
201 * // Scripts to include in the startup module
202 * 'loaderScripts' => [file path string or array of file path strings],
203 * // Modules which must be loaded before this module
204 * 'dependencies' => [module name string or array of module name strings],
205 * // Styles to always load
206 * 'styles' => [file path string or array of file path strings],
207 * // Styles to include in specific skin contexts
208 * 'skinStyles' => array(
209 * [skin name] => [file path string or array of file path strings],
211 * // Messages to always load
212 * 'messages' => [array of message key strings],
213 * // Group which this module should be loaded together with
214 * 'group' => [group name string],
215 * // Position on the page to load this module at
216 * 'position' => ['bottom' (default) or 'top']
217 * // Function that, if it returns true, makes the loader skip this module.
218 * // The file must contain valid JavaScript for execution in a private function.
219 * // The file must not contain the "function () {" and "}" wrapper though.
220 * 'skipFunction' => [file path]
224 public function __construct(
226 $localBasePath = null,
227 $remoteBasePath = null
229 // localBasePath and remoteBasePath both have unbelievably long fallback chains
230 // and need to be handled separately.
231 list( $this->localBasePath
, $this->remoteBasePath
) =
232 self
::extractBasePaths( $options, $localBasePath, $remoteBasePath );
234 // Extract, validate and normalise remaining options
235 foreach ( $options as $member => $option ) {
237 // Lists of file paths
240 case 'loaderScripts':
242 $this->{$member} = (array)$option;
244 // Collated lists of file paths
245 case 'languageScripts':
248 if ( !is_array( $option ) ) {
249 throw new MWException(
250 "Invalid collated file path list error. " .
251 "'$option' given, array expected."
254 foreach ( $option as $key => $value ) {
255 if ( !is_string( $key ) ) {
256 throw new MWException(
257 "Invalid collated file path list key error. " .
258 "'$key' given, string expected."
261 $this->{$member}[$key] = (array)$value;
269 $option = array_values( array_unique( (array)$option ) );
272 $this->{$member} = $option;
276 $this->{$member} = (array) $option;
282 $this->{$member} = (string)$option;
287 $this->{$member} = (bool)$option;
294 * Extract a pair of local and remote base paths from module definition information.
295 * Implementation note: the amount of global state used in this function is staggering.
297 * @param array $options Module definition
298 * @param string $localBasePath Path to use if not provided in module definition. Defaults
300 * @param string $remoteBasePath Path to use if not provided in module definition. Defaults
301 * to $wgResourceBasePath
302 * @return array Array( localBasePath, remoteBasePath )
304 public static function extractBasePaths(
306 $localBasePath = null,
307 $remoteBasePath = null
309 global $IP, $wgResourceBasePath;
311 // The different ways these checks are done, and their ordering, look very silly,
312 // but were preserved for backwards-compatibility just in case. Tread lightly.
314 if ( $localBasePath === null ) {
315 $localBasePath = $IP;
317 if ( $remoteBasePath === null ) {
318 $remoteBasePath = $wgResourceBasePath;
321 if ( isset( $options['remoteExtPath'] ) ) {
322 global $wgExtensionAssetsPath;
323 $remoteBasePath = $wgExtensionAssetsPath . '/' . $options['remoteExtPath'];
326 if ( isset( $options['remoteSkinPath'] ) ) {
328 $remoteBasePath = $wgStylePath . '/' . $options['remoteSkinPath'];
331 if ( array_key_exists( 'localBasePath', $options ) ) {
332 $localBasePath = (string)$options['localBasePath'];
335 if ( array_key_exists( 'remoteBasePath', $options ) ) {
336 $remoteBasePath = (string)$options['remoteBasePath'];
339 // Make sure the remote base path is a complete valid URL,
340 // but possibly protocol-relative to avoid cache pollution
341 $remoteBasePath = wfExpandUrl( $remoteBasePath, PROTO_RELATIVE
);
343 return array( $localBasePath, $remoteBasePath );
347 * Gets all scripts for a given context concatenated together.
349 * @param ResourceLoaderContext $context Context in which to generate script
350 * @return string JavaScript code for $context
352 public function getScript( ResourceLoaderContext
$context ) {
353 $files = $this->getScriptFiles( $context );
354 return $this->readScriptFiles( $files );
358 * @param ResourceLoaderContext $context
361 public function getScriptURLsForDebug( ResourceLoaderContext
$context ) {
363 foreach ( $this->getScriptFiles( $context ) as $file ) {
364 $urls[] = $this->getRemotePath( $file );
372 public function supportsURLLoading() {
373 return $this->debugRaw
;
379 * @return string|bool JavaScript code to be added to startup module
381 public function getLoaderScript() {
382 if ( count( $this->loaderScripts
) === 0 ) {
385 return $this->readScriptFiles( $this->loaderScripts
);
389 * Get all styles for a given context.
391 * @param ResourceLoaderContext $context
392 * @return array CSS code for $context as an associative array mapping media type to CSS text.
394 public function getStyles( ResourceLoaderContext
$context ) {
395 $styles = $this->readStyleFiles(
396 $this->getStyleFiles( $context ),
397 $this->getFlip( $context ),
400 // Collect referenced files
401 $this->localFileRefs
= array_unique( $this->localFileRefs
);
402 // If the list has been modified since last time we cached it, update the cache
404 if ( $this->localFileRefs
!== $this->getFileDependencies( $context->getSkin() ) ) {
405 $dbw = wfGetDB( DB_MASTER
);
406 $dbw->replace( 'module_deps',
407 array( array( 'md_module', 'md_skin' ) ), array(
408 'md_module' => $this->getName(),
409 'md_skin' => $context->getSkin(),
410 'md_deps' => FormatJson
::encode( $this->localFileRefs
),
414 } catch ( Exception
$e ) {
415 wfDebugLog( 'resourceloader', __METHOD__
. ": failed to update DB: $e" );
421 * @param ResourceLoaderContext $context
424 public function getStyleURLsForDebug( ResourceLoaderContext
$context ) {
425 if ( $this->hasGeneratedStyles
) {
426 // Do the default behaviour of returning a url back to load.php
427 // but with only=styles.
428 return parent
::getStyleURLsForDebug( $context );
430 // Our module consists entirely of real css files,
431 // in debug mode we can load those directly.
433 foreach ( $this->getStyleFiles( $context ) as $mediaType => $list ) {
434 $urls[$mediaType] = array();
435 foreach ( $list as $file ) {
436 $urls[$mediaType][] = $this->getRemotePath( $file );
443 * Gets list of message keys used by this module.
445 * @return array List of message keys
447 public function getMessages() {
448 return $this->messages
;
452 * Gets the name of the group this module should be loaded in.
454 * @return string Group name
456 public function getGroup() {
463 public function getPosition() {
464 return $this->position
;
468 * Gets list of names of modules this module depends on.
470 * @return array List of module names
472 public function getDependencies() {
473 return $this->dependencies
;
477 * Get the skip function.
479 * @return string|null
481 public function getSkipFunction() {
482 if ( !$this->skipFunction
) {
486 $localPath = $this->getLocalPath( $this->skipFunction
);
487 if ( !file_exists( $localPath ) ) {
488 throw new MWException( __METHOD__
. ": skip function file not found: \"$localPath\"" );
490 $contents = file_get_contents( $localPath );
491 if ( $this->getConfig()->get( 'ResourceLoaderValidateStaticJS' ) ) {
492 $contents = $this->validateScriptFile( $localPath, $contents );
500 public function isRaw() {
505 * Get the last modified timestamp of this module.
507 * Last modified timestamps are calculated from the highest last modified
508 * timestamp of this module's constituent files as well as the files it
509 * depends on. This function is context-sensitive, only performing
510 * calculations on files relevant to the given language, skin and debug
513 * @param ResourceLoaderContext $context Context in which to calculate
515 * @return int UNIX timestamp
516 * @see ResourceLoaderModule::getFileDependencies
518 public function getModifiedTime( ResourceLoaderContext
$context ) {
519 if ( isset( $this->modifiedTime
[$context->getHash()] ) ) {
520 return $this->modifiedTime
[$context->getHash()];
522 wfProfileIn( __METHOD__
);
526 // Flatten style files into $files
527 $styles = self
::collateFilePathListByOption( $this->styles
, 'media', 'all' );
528 foreach ( $styles as $styleFiles ) {
529 $files = array_merge( $files, $styleFiles );
532 $skinFiles = self
::collateFilePathListByOption(
533 self
::tryForKey( $this->skinStyles
, $context->getSkin(), 'default' ),
537 foreach ( $skinFiles as $styleFiles ) {
538 $files = array_merge( $files, $styleFiles );
541 // Final merge, this should result in a master list of dependent files
542 $files = array_merge(
545 $context->getDebug() ?
$this->debugScripts
: array(),
546 $this->getLanguageScripts( $context->getLanguage() ),
547 self
::tryForKey( $this->skinScripts
, $context->getSkin(), 'default' ),
550 if ( $this->skipFunction
) {
551 $files[] = $this->skipFunction
;
553 $files = array_map( array( $this, 'getLocalPath' ), $files );
555 $templateFiles = array_map( array( $this, 'getLocalPath' ), $this->templates
);
556 $files = array_merge( $files, $templateFiles );
557 // File deps need to be treated separately because they're already prefixed
558 $files = array_merge( $files, $this->getFileDependencies( $context->getSkin() ) );
560 // If a module is nothing but a list of dependencies, we need to avoid
561 // giving max() an empty array
562 if ( count( $files ) === 0 ) {
563 $this->modifiedTime
[$context->getHash()] = 1;
564 wfProfileOut( __METHOD__
);
565 return $this->modifiedTime
[$context->getHash()];
568 wfProfileIn( __METHOD__
. '-filemtime' );
569 $filesMtime = max( array_map( array( __CLASS__
, 'safeFilemtime' ), $files ) );
570 wfProfileOut( __METHOD__
. '-filemtime' );
572 $this->modifiedTime
[$context->getHash()] = max(
574 $this->getMsgBlobMtime( $context->getLanguage() ),
575 $this->getDefinitionMtime( $context )
578 wfProfileOut( __METHOD__
);
579 return $this->modifiedTime
[$context->getHash()];
583 * Get the definition summary for this module.
585 * @param ResourceLoaderContext $context
588 public function getDefinitionSummary( ResourceLoaderContext
$context ) {
590 'class' => get_class( $this ),
611 $summary[$member] = $this->{$member};
616 /* Protected Methods */
619 * @param string|ResourceLoaderFilePath $path
622 protected function getLocalPath( $path ) {
623 if ( $path instanceof ResourceLoaderFilePath
) {
624 return $path->getLocalPath();
627 return "{$this->localBasePath}/$path";
631 * @param string|ResourceLoaderFilePath $path
634 protected function getRemotePath( $path ) {
635 if ( $path instanceof ResourceLoaderFilePath
) {
636 return $path->getRemotePath();
639 return "{$this->remoteBasePath}/$path";
643 * Infer the stylesheet language from a stylesheet file path.
646 * @param string $path
647 * @return string The stylesheet language name
649 public function getStyleSheetLang( $path ) {
650 return preg_match( '/\.less$/i', $path ) ?
'less' : 'css';
654 * Collates file paths by option (where provided).
656 * @param array $list List of file paths in any combination of index/path
657 * or path/options pairs
658 * @param string $option Option name
659 * @param mixed $default Default value if the option isn't set
660 * @return array List of file paths, collated by $option
662 protected static function collateFilePathListByOption( array $list, $option, $default ) {
663 $collatedFiles = array();
664 foreach ( (array)$list as $key => $value ) {
665 if ( is_int( $key ) ) {
666 // File name as the value
667 if ( !isset( $collatedFiles[$default] ) ) {
668 $collatedFiles[$default] = array();
670 $collatedFiles[$default][] = $value;
671 } elseif ( is_array( $value ) ) {
672 // File name as the key, options array as the value
673 $optionValue = isset( $value[$option] ) ?
$value[$option] : $default;
674 if ( !isset( $collatedFiles[$optionValue] ) ) {
675 $collatedFiles[$optionValue] = array();
677 $collatedFiles[$optionValue][] = $key;
680 return $collatedFiles;
684 * Get a list of element that match a key, optionally using a fallback key.
686 * @param array $list List of lists to select from
687 * @param string $key Key to look for in $map
688 * @param string $fallback Key to look for in $list if $key doesn't exist
689 * @return array List of elements from $map which matched $key or $fallback,
690 * or an empty list in case of no match
692 protected static function tryForKey( array $list, $key, $fallback = null ) {
693 if ( isset( $list[$key] ) && is_array( $list[$key] ) ) {
695 } elseif ( is_string( $fallback )
696 && isset( $list[$fallback] )
697 && is_array( $list[$fallback] )
699 return $list[$fallback];
705 * Get a list of file paths for all scripts in this module, in order of proper execution.
707 * @param ResourceLoaderContext $context
708 * @return array List of file paths
710 protected function getScriptFiles( ResourceLoaderContext
$context ) {
711 $files = array_merge(
713 $this->getLanguageScripts( $context->getLanguage() ),
714 self
::tryForKey( $this->skinScripts
, $context->getSkin(), 'default' )
716 if ( $context->getDebug() ) {
717 $files = array_merge( $files, $this->debugScripts
);
720 return array_unique( $files, SORT_REGULAR
);
724 * Get the set of language scripts for the given language,
725 * possibly using a fallback language.
727 * @param string $lang
730 private function getLanguageScripts( $lang ) {
731 $scripts = self
::tryForKey( $this->languageScripts
, $lang );
735 $fallbacks = Language
::getFallbacksFor( $lang );
736 foreach ( $fallbacks as $lang ) {
737 $scripts = self
::tryForKey( $this->languageScripts
, $lang );
747 * Get a list of file paths for all styles in this module, in order of proper inclusion.
749 * @param ResourceLoaderContext $context
750 * @return array List of file paths
752 public function getStyleFiles( ResourceLoaderContext
$context ) {
753 return array_merge_recursive(
754 self
::collateFilePathListByOption( $this->styles
, 'media', 'all' ),
755 self
::collateFilePathListByOption(
756 self
::tryForKey( $this->skinStyles
, $context->getSkin(), 'default' ),
764 * Gets a list of file paths for all skin styles in the module used by
767 * @param string $skinName The name of the skin
768 * @return array A list of file paths collated by media type
770 protected function getSkinStyleFiles( $skinName ) {
771 return self
::collateFilePathListByOption(
772 self
::tryForKey( $this->skinStyles
, $skinName ),
779 * Gets a list of file paths for all skin style files in the module,
780 * for all available skins.
782 * @return array A list of file paths collated by media type
784 protected function getAllSkinStyleFiles() {
785 $styleFiles = array();
786 $internalSkinNames = array_keys( Skin
::getSkinNames() );
787 $internalSkinNames[] = 'default';
789 foreach ( $internalSkinNames as $internalSkinName ) {
790 $styleFiles = array_merge_recursive(
792 $this->getSkinStyleFiles( $internalSkinName )
800 * Returns all style files and all skin style files used by this module.
804 public function getAllStyleFiles() {
805 $collatedStyleFiles = array_merge_recursive(
806 self
::collateFilePathListByOption( $this->styles
, 'media', 'all' ),
807 $this->getAllSkinStyleFiles()
812 foreach ( $collatedStyleFiles as $media => $styleFiles ) {
813 foreach ( $styleFiles as $styleFile ) {
814 $result[] = $this->getLocalPath( $styleFile );
822 * Gets the contents of a list of JavaScript files.
824 * @param array $scripts List of file paths to scripts to read, remap and concetenate
825 * @throws MWException
826 * @return string Concatenated and remapped JavaScript data from $scripts
828 protected function readScriptFiles( array $scripts ) {
829 if ( empty( $scripts ) ) {
833 foreach ( array_unique( $scripts, SORT_REGULAR
) as $fileName ) {
834 $localPath = $this->getLocalPath( $fileName );
835 if ( !file_exists( $localPath ) ) {
836 throw new MWException( __METHOD__
. ": script file not found: \"$localPath\"" );
838 $contents = file_get_contents( $localPath );
839 if ( $this->getConfig()->get( 'ResourceLoaderValidateStaticJS' ) ) {
840 // Static files don't really need to be checked as often; unlike
841 // on-wiki module they shouldn't change unexpectedly without
842 // admin interference.
843 $contents = $this->validateScriptFile( $fileName, $contents );
845 $js .= $contents . "\n";
851 * Gets the contents of a list of CSS files.
853 * @param array $styles List of media type/list of file paths pairs, to read, remap and
856 * @param ResourceLoaderContext $context (optional)
858 * @throws MWException
859 * @return array List of concatenated and remapped CSS data from $styles,
860 * keyed by media type
862 public function readStyleFiles( array $styles, $flip, $context = null ) {
863 if ( empty( $styles ) ) {
866 foreach ( $styles as $media => $files ) {
867 $uniqueFiles = array_unique( $files, SORT_REGULAR
);
868 $styleFiles = array();
869 foreach ( $uniqueFiles as $file ) {
870 $styleFiles[] = $this->readStyleFile( $file, $flip, $context );
872 $styles[$media] = implode( "\n", $styleFiles );
878 * Reads a style file.
880 * This method can be used as a callback for array_map()
882 * @param string $path File path of style file to read
884 * @param ResourceLoaderContext $context (optional)
886 * @return string CSS data in script file
887 * @throws MWException If the file doesn't exist
889 protected function readStyleFile( $path, $flip, $context = null ) {
890 $localPath = $this->getLocalPath( $path );
891 $remotePath = $this->getRemotePath( $path );
892 if ( !file_exists( $localPath ) ) {
893 $msg = __METHOD__
. ": style file not found: \"$localPath\"";
894 wfDebugLog( 'resourceloader', $msg );
895 throw new MWException( $msg );
898 if ( $this->getStyleSheetLang( $localPath ) === 'less' ) {
899 $compiler = $this->getLessCompiler( $context );
900 $style = $this->compileLessFile( $localPath, $compiler );
901 $this->hasGeneratedStyles
= true;
903 $style = file_get_contents( $localPath );
907 $style = CSSJanus
::transform( $style, true, false );
909 $localDir = dirname( $localPath );
910 $remoteDir = dirname( $remotePath );
911 // Get and register local file references
912 $this->localFileRefs
= array_merge(
913 $this->localFileRefs
,
914 CSSMin
::getLocalFileReferences( $style, $localDir )
916 return CSSMin
::remap(
917 $style, $localDir, $remoteDir, true
922 * Get whether CSS for this module should be flipped
923 * @param ResourceLoaderContext $context
926 public function getFlip( $context ) {
927 return $context->getDirection() === 'rtl';
931 * Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile']
933 * @return array Array of strings
935 public function getTargets() {
936 return $this->targets
;
940 * Compile a LESS file into CSS.
942 * Keeps track of all used files and adds them to localFileRefs.
945 * @throws Exception If lessc encounters a parse error
946 * @param string $fileName File path of LESS source
947 * @param lessc $compiler Compiler to use, if not default
948 * @return string CSS source
950 protected function compileLessFile( $fileName, $compiler = null ) {
952 $compiler = $this->getLessCompiler();
954 $result = $compiler->compileFile( $fileName );
955 $this->localFileRefs +
= array_keys( $compiler->allParsedFiles() );
960 * Get a LESS compiler instance for this module in given context.
962 * Just calls ResourceLoader::getLessCompiler() by default to get a global compiler.
964 * @param ResourceLoaderContext $context
965 * @throws MWException
969 protected function getLessCompiler( ResourceLoaderContext
$context = null ) {
970 return ResourceLoader
::getLessCompiler( $this->getConfig() );
974 * Takes named templates by the module and adds them to the JavaScript output
976 * @return array of templates mapping template alias to content
978 function getTemplates() {
979 $templates = array();
981 foreach( $this->templates
as $alias => $templatePath ) {
983 if ( is_int( $alias ) ) {
984 $alias = $templatePath;
986 $localPath = $this->getLocalPath( $templatePath );
987 if ( file_exists( $localPath ) ) {
988 $content = file_get_contents( $localPath );
989 $templates[ $alias ] = $content;