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 Place where readStyleFile() tracks file dependencies
150 * array( [file-path], [file-path], ... )
153 protected $localFileRefs = array();
156 * @var array Place where readStyleFile() tracks file dependencies for non-existent files.
157 * Used in tests to detect missing dependencies.
159 protected $missingLocalFileRefs = array();
164 * Constructs a new module from an options array.
166 * @param array $options List of options; if not given or empty, an empty module will be
168 * @param string $localBasePath Base path to prepend to all local paths in $options. Defaults
170 * @param string $remoteBasePath Base path to prepend to all remote paths in $options. Defaults
171 * to $wgResourceBasePath
173 * Below is a description for the $options array:
174 * @throws InvalidArgumentException
175 * @par Construction options:
178 * // Base path to prepend to all local paths in $options. Defaults to $IP
179 * 'localBasePath' => [base path],
180 * // Base path to prepend to all remote paths in $options. Defaults to $wgResourceBasePath
181 * 'remoteBasePath' => [base path],
182 * // Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath
183 * 'remoteExtPath' => [base path],
184 * // Equivalent of remoteBasePath, but relative to $wgStylePath
185 * 'remoteSkinPath' => [base path],
186 * // Scripts to always include
187 * 'scripts' => [file path string or array of file path strings],
188 * // Scripts to include in specific language contexts
189 * 'languageScripts' => array(
190 * [language code] => [file path string or array of file path strings],
192 * // Scripts to include in specific skin contexts
193 * 'skinScripts' => array(
194 * [skin name] => [file path string or array of file path strings],
196 * // Scripts to include in debug contexts
197 * 'debugScripts' => [file path string or array of file path strings],
198 * // Scripts to include in the startup module
199 * 'loaderScripts' => [file path string or array of file path strings],
200 * // Modules which must be loaded before this module
201 * 'dependencies' => [module name string or array of module name strings],
202 * 'templates' => array(
203 * [template alias with file.ext] => [file path to a template file],
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 // Flag to decide whether to automagically add the mediawiki.template module
230 $hasTemplates = false;
231 // localBasePath and remoteBasePath both have unbelievably long fallback chains
232 // and need to be handled separately.
233 list( $this->localBasePath
, $this->remoteBasePath
) =
234 self
::extractBasePaths( $options, $localBasePath, $remoteBasePath );
236 // Extract, validate and normalise remaining options
237 foreach ( $options as $member => $option ) {
239 // Lists of file paths
242 case 'loaderScripts':
244 $this->{$member} = (array)$option;
247 $hasTemplates = true;
248 $this->{$member} = (array)$option;
250 // Collated lists of file paths
251 case 'languageScripts':
254 if ( !is_array( $option ) ) {
255 throw new InvalidArgumentException(
256 "Invalid collated file path list error. " .
257 "'$option' given, array expected."
260 foreach ( $option as $key => $value ) {
261 if ( !is_string( $key ) ) {
262 throw new InvalidArgumentException(
263 "Invalid collated file path list key error. " .
264 "'$key' given, string expected."
267 $this->{$member}[$key] = (array)$value;
275 $option = array_values( array_unique( (array)$option ) );
278 $this->{$member} = $option;
282 $this->isPositionDefined
= true;
285 $this->{$member} = (string)$option;
290 $this->{$member} = (bool)$option;
294 if ( $hasTemplates ) {
295 $this->dependencies
[] = 'mediawiki.template';
296 // Ensure relevant template compiler module gets loaded
297 foreach ( $this->templates
as $alias => $templatePath ) {
298 if ( is_int( $alias ) ) {
299 $alias = $templatePath;
301 $suffix = explode( '.', $alias );
302 $suffix = end( $suffix );
303 $compilerModule = 'mediawiki.template.' . $suffix;
304 if ( $suffix !== 'html' && !in_array( $compilerModule, $this->dependencies
) ) {
305 $this->dependencies
[] = $compilerModule;
312 * Extract a pair of local and remote base paths from module definition information.
313 * Implementation note: the amount of global state used in this function is staggering.
315 * @param array $options Module definition
316 * @param string $localBasePath Path to use if not provided in module definition. Defaults
318 * @param string $remoteBasePath Path to use if not provided in module definition. Defaults
319 * to $wgResourceBasePath
320 * @return array Array( localBasePath, remoteBasePath )
322 public static function extractBasePaths(
324 $localBasePath = null,
325 $remoteBasePath = null
327 global $IP, $wgResourceBasePath;
329 // The different ways these checks are done, and their ordering, look very silly,
330 // but were preserved for backwards-compatibility just in case. Tread lightly.
332 if ( $localBasePath === null ) {
333 $localBasePath = $IP;
335 if ( $remoteBasePath === null ) {
336 $remoteBasePath = $wgResourceBasePath;
339 if ( isset( $options['remoteExtPath'] ) ) {
340 global $wgExtensionAssetsPath;
341 $remoteBasePath = $wgExtensionAssetsPath . '/' . $options['remoteExtPath'];
344 if ( isset( $options['remoteSkinPath'] ) ) {
346 $remoteBasePath = $wgStylePath . '/' . $options['remoteSkinPath'];
349 if ( array_key_exists( 'localBasePath', $options ) ) {
350 $localBasePath = (string)$options['localBasePath'];
353 if ( array_key_exists( 'remoteBasePath', $options ) ) {
354 $remoteBasePath = (string)$options['remoteBasePath'];
357 // Make sure the remote base path is a complete valid URL,
358 // but possibly protocol-relative to avoid cache pollution
359 $remoteBasePath = wfExpandUrl( $remoteBasePath, PROTO_RELATIVE
);
361 return array( $localBasePath, $remoteBasePath );
365 * Gets all scripts for a given context concatenated together.
367 * @param ResourceLoaderContext $context Context in which to generate script
368 * @return string JavaScript code for $context
370 public function getScript( ResourceLoaderContext
$context ) {
371 $files = $this->getScriptFiles( $context );
372 return $this->readScriptFiles( $files );
376 * @param ResourceLoaderContext $context
379 public function getScriptURLsForDebug( ResourceLoaderContext
$context ) {
381 foreach ( $this->getScriptFiles( $context ) as $file ) {
382 $urls[] = $this->getRemotePath( $file );
390 public function supportsURLLoading() {
391 return $this->debugRaw
;
397 * @return string|bool JavaScript code to be added to startup module
399 public function getLoaderScript() {
400 if ( count( $this->loaderScripts
) === 0 ) {
403 return $this->readScriptFiles( $this->loaderScripts
);
407 * Get all styles for a given context.
409 * @param ResourceLoaderContext $context
410 * @return array CSS code for $context as an associative array mapping media type to CSS text.
412 public function getStyles( ResourceLoaderContext
$context ) {
413 $styles = $this->readStyleFiles(
414 $this->getStyleFiles( $context ),
415 $this->getFlip( $context ),
418 // Collect referenced files
419 $this->saveFileDependencies( $context, $this->localFileRefs
);
425 * @param ResourceLoaderContext $context
428 public function getStyleURLsForDebug( ResourceLoaderContext
$context ) {
429 if ( $this->hasGeneratedStyles
) {
430 // Do the default behaviour of returning a url back to load.php
431 // but with only=styles.
432 return parent
::getStyleURLsForDebug( $context );
434 // Our module consists entirely of real css files,
435 // in debug mode we can load those directly.
437 foreach ( $this->getStyleFiles( $context ) as $mediaType => $list ) {
438 $urls[$mediaType] = array();
439 foreach ( $list as $file ) {
440 $urls[$mediaType][] = $this->getRemotePath( $file );
447 * Gets list of message keys used by this module.
449 * @return array List of message keys
451 public function getMessages() {
452 return $this->messages
;
456 * Gets the name of the group this module should be loaded in.
458 * @return string Group name
460 public function getGroup() {
467 public function getPosition() {
468 return $this->position
;
472 * Gets list of names of modules this module depends on.
473 * @param ResourceLoaderContext context
474 * @return array List of module names
476 public function getDependencies( ResourceLoaderContext
$context = null ) {
477 return $this->dependencies
;
481 * Get the skip function.
482 * @return null|string
483 * @throws MWException
485 public function getSkipFunction() {
486 if ( !$this->skipFunction
) {
490 $localPath = $this->getLocalPath( $this->skipFunction
);
491 if ( !file_exists( $localPath ) ) {
492 throw new MWException( __METHOD__
. ": skip function file not found: \"$localPath\"" );
494 $contents = file_get_contents( $localPath );
495 if ( $this->getConfig()->get( 'ResourceLoaderValidateStaticJS' ) ) {
496 $contents = $this->validateScriptFile( $localPath, $contents );
504 public function isRaw() {
509 * Disable module content versioning.
511 * This class uses getDefinitionSummary() instead, to avoid filesystem overhead
512 * involved with building the full module content inside a startup request.
516 public function enableModuleContentVersion() {
521 * Helper method to gather file hashes for getDefinitionSummary.
523 * This function is context-sensitive, only computing hashes of files relevant to the
524 * given language, skin, etc.
526 * @see ResourceLoaderModule::getFileDependencies
527 * @param ResourceLoaderContext $context
530 protected function getFileHashes( ResourceLoaderContext
$context ) {
533 // Flatten style files into $files
534 $styles = self
::collateFilePathListByOption( $this->styles
, 'media', 'all' );
535 foreach ( $styles as $styleFiles ) {
536 $files = array_merge( $files, $styleFiles );
539 $skinFiles = self
::collateFilePathListByOption(
540 self
::tryForKey( $this->skinStyles
, $context->getSkin(), 'default' ),
544 foreach ( $skinFiles as $styleFiles ) {
545 $files = array_merge( $files, $styleFiles );
548 // Final merge, this should result in a master list of dependent files
549 $files = array_merge(
553 $context->getDebug() ?
$this->debugScripts
: array(),
554 $this->getLanguageScripts( $context->getLanguage() ),
555 self
::tryForKey( $this->skinScripts
, $context->getSkin(), 'default' ),
558 if ( $this->skipFunction
) {
559 $files[] = $this->skipFunction
;
561 $files = array_map( array( $this, 'getLocalPath' ), $files );
562 // File deps need to be treated separately because they're already prefixed
563 $files = array_merge( $files, $this->getFileDependencies( $context ) );
564 // Filter out any duplicates from getFileDependencies() and others.
565 // Most commonly introduced by compileLessFile(), which always includes the
566 // entry point Less file we already know about.
567 $files = array_values( array_unique( $files ) );
569 // Don't include keys or file paths here, only the hashes. Including that would needlessly
570 // cause global cache invalidation when files move or if e.g. the MediaWiki path changes.
571 // Any significant ordering is already detected by the definition summary.
572 return array_map( array( __CLASS__
, 'safeFileHash' ), $files );
576 * Get the definition summary for this module.
578 * @param ResourceLoaderContext $context
581 public function getDefinitionSummary( ResourceLoaderContext
$context ) {
582 $summary = parent
::getDefinitionSummary( $context );
586 // The following properties are omitted because they don't affect the module reponse:
587 // - localBasePath (Per T104950; Changes when absolute directory name changes. If
588 // this affects 'scripts' and other file paths, getFileHashes accounts for that.)
589 // - remoteBasePath (Per T104950)
590 // - dependencies (provided via startup module)
592 // - group (provided via startup module)
593 // - position (only used by OutputPage)
607 $options[$member] = $this->{$member};
611 'options' => $options,
612 'fileHashes' => $this->getFileHashes( $context ),
613 'msgBlobMtime' => $this->getMsgBlobMtime( $context->getLanguage() ),
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
858 * @throws MWException
859 * @return array List of concatenated and remapped CSS data from $styles,
860 * keyed by media type
862 * @since 1.27 Calling this method without a ResourceLoaderContext instance
865 public function readStyleFiles( array $styles, $flip, $context = null ) {
866 if ( $context === null ) {
867 wfDeprecated( __METHOD__
. ' without a ResourceLoader context', '1.27' );
868 $context = ResourceLoaderContext
::newDummyContext();
871 if ( empty( $styles ) ) {
874 foreach ( $styles as $media => $files ) {
875 $uniqueFiles = array_unique( $files, SORT_REGULAR
);
876 $styleFiles = array();
877 foreach ( $uniqueFiles as $file ) {
878 $styleFiles[] = $this->readStyleFile( $file, $flip, $context );
880 $styles[$media] = implode( "\n", $styleFiles );
886 * Reads a style file.
888 * This method can be used as a callback for array_map()
890 * @param string $path File path of style file to read
892 * @param ResourceLoaderContext $context
894 * @return string CSS data in script file
895 * @throws MWException If the file doesn't exist
897 protected function readStyleFile( $path, $flip, $context ) {
898 $localPath = $this->getLocalPath( $path );
899 $remotePath = $this->getRemotePath( $path );
900 if ( !file_exists( $localPath ) ) {
901 $msg = __METHOD__
. ": style file not found: \"$localPath\"";
902 wfDebugLog( 'resourceloader', $msg );
903 throw new MWException( $msg );
906 if ( $this->getStyleSheetLang( $localPath ) === 'less' ) {
907 $style = $this->compileLessFile( $localPath, $context );
908 $this->hasGeneratedStyles
= true;
910 $style = file_get_contents( $localPath );
914 $style = CSSJanus
::transform( $style, true, false );
916 $localDir = dirname( $localPath );
917 $remoteDir = dirname( $remotePath );
918 // Get and register local file references
919 $localFileRefs = CSSMin
::getAllLocalFileReferences( $style, $localDir );
920 foreach ( $localFileRefs as $file ) {
921 if ( file_exists( $file ) ) {
922 $this->localFileRefs
[] = $file;
924 $this->missingLocalFileRefs
[] = $file;
927 return MemoizedCallable
::call( 'CSSMin::remap',
928 array( $style, $localDir, $remoteDir, true ) );
932 * Get whether CSS for this module should be flipped
933 * @param ResourceLoaderContext $context
936 public function getFlip( $context ) {
937 return $context->getDirection() === 'rtl';
941 * Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile']
943 * @return array Array of strings
945 public function getTargets() {
946 return $this->targets
;
950 * Compile a LESS file into CSS.
952 * Keeps track of all used files and adds them to localFileRefs.
955 * @since 1.27 Added $context paramter.
956 * @throws Exception If less.php encounters a parse error
957 * @param string $fileName File path of LESS source
958 * @param ResourceLoaderContext $context Context in which to generate script
959 * @return string CSS source
961 protected function compileLessFile( $fileName, ResourceLoaderContext
$context ) {
965 $cache = ObjectCache
::newAccelerator( CACHE_ANYTHING
);
968 // Construct a cache key from the LESS file name and a hash digest
969 // of the LESS variables used for compilation.
970 $vars = $this->getLessVars( $context );
972 $varsHash = hash( 'md4', serialize( $vars ) );
973 $cacheKey = $cache->makeGlobalKey( 'LESS', $fileName, $varsHash );
974 $cachedCompile = $cache->get( $cacheKey );
976 // If we got a cached value, we have to validate it by getting a
977 // checksum of all the files that were loaded by the parser and
978 // ensuring it matches the cached entry's.
979 if ( isset( $cachedCompile['hash'] ) ) {
980 $contentHash = FileContentsHasher
::getFileContentsHash( $cachedCompile['files'] );
981 if ( $contentHash === $cachedCompile['hash'] ) {
982 $this->localFileRefs
= array_merge( $this->localFileRefs
, $cachedCompile['files'] );
983 return $cachedCompile['css'];
987 $compiler = ResourceLoader
::getLessCompiler( $this->getConfig(), $vars );
988 $css = $compiler->parseFile( $fileName )->getCss();
989 $files = $compiler->AllParsedFiles();
990 $this->localFileRefs
= array_merge( $this->localFileRefs
, $files );
992 $cache->set( $cacheKey, array(
995 'hash' => FileContentsHasher
::getFileContentsHash( $files ),
996 ), 60 * 60 * 24 ); // 86400 seconds, or 24 hours.
1002 * Takes named templates by the module and returns an array mapping.
1003 * @return array of templates mapping template alias to content
1004 * @throws MWException
1006 public function getTemplates() {
1007 $templates = array();
1009 foreach ( $this->templates
as $alias => $templatePath ) {
1010 // Alias is optional
1011 if ( is_int( $alias ) ) {
1012 $alias = $templatePath;
1014 $localPath = $this->getLocalPath( $templatePath );
1015 if ( file_exists( $localPath ) ) {
1016 $content = file_get_contents( $localPath );
1017 $templates[$alias] = $content;
1019 $msg = __METHOD__
. ": template file not found: \"$localPath\"";
1020 wfDebugLog( 'resourceloader', $msg );
1021 throw new MWException( $msg );