ca10ab7cc76fd33fb689df315c8733f97666d75a
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->localFileRefs
= array_unique( $this->localFileRefs
);
420 $this->saveFileDependencies( $context->getSkin(), $this->localFileRefs
);
426 * @param ResourceLoaderContext $context
429 public function getStyleURLsForDebug( ResourceLoaderContext
$context ) {
430 if ( $this->hasGeneratedStyles
) {
431 // Do the default behaviour of returning a url back to load.php
432 // but with only=styles.
433 return parent
::getStyleURLsForDebug( $context );
435 // Our module consists entirely of real css files,
436 // in debug mode we can load those directly.
438 foreach ( $this->getStyleFiles( $context ) as $mediaType => $list ) {
439 $urls[$mediaType] = array();
440 foreach ( $list as $file ) {
441 $urls[$mediaType][] = $this->getRemotePath( $file );
448 * Gets list of message keys used by this module.
450 * @return array List of message keys
452 public function getMessages() {
453 return $this->messages
;
457 * Gets the name of the group this module should be loaded in.
459 * @return string Group name
461 public function getGroup() {
468 public function getPosition() {
469 return $this->position
;
473 * Gets list of names of modules this module depends on.
474 * @param ResourceLoaderContext context
475 * @return array List of module names
477 public function getDependencies( ResourceLoaderContext
$context = null ) {
478 return $this->dependencies
;
482 * Get the skip function.
483 * @return null|string
484 * @throws MWException
486 public function getSkipFunction() {
487 if ( !$this->skipFunction
) {
491 $localPath = $this->getLocalPath( $this->skipFunction
);
492 if ( !file_exists( $localPath ) ) {
493 throw new MWException( __METHOD__
. ": skip function file not found: \"$localPath\"" );
495 $contents = file_get_contents( $localPath );
496 if ( $this->getConfig()->get( 'ResourceLoaderValidateStaticJS' ) ) {
497 $contents = $this->validateScriptFile( $localPath, $contents );
505 public function isRaw() {
510 * Disable module content versioning.
512 * This class uses getDefinitionSummary() instead, to avoid filesystem overhead
513 * involved with building the full module content inside a startup request.
517 public function enableModuleContentVersion() {
522 * Helper method to gather file hashes for getDefinitionSummary.
524 * This function is context-sensitive, only computing hashes of files relevant to the
525 * given language, skin, etc.
527 * @see ResourceLoaderModule::getFileDependencies
528 * @param ResourceLoaderContext $context
531 protected function getFileHashes( ResourceLoaderContext
$context ) {
534 // Flatten style files into $files
535 $styles = self
::collateFilePathListByOption( $this->styles
, 'media', 'all' );
536 foreach ( $styles as $styleFiles ) {
537 $files = array_merge( $files, $styleFiles );
540 $skinFiles = self
::collateFilePathListByOption(
541 self
::tryForKey( $this->skinStyles
, $context->getSkin(), 'default' ),
545 foreach ( $skinFiles as $styleFiles ) {
546 $files = array_merge( $files, $styleFiles );
549 // Final merge, this should result in a master list of dependent files
550 $files = array_merge(
554 $context->getDebug() ?
$this->debugScripts
: array(),
555 $this->getLanguageScripts( $context->getLanguage() ),
556 self
::tryForKey( $this->skinScripts
, $context->getSkin(), 'default' ),
559 if ( $this->skipFunction
) {
560 $files[] = $this->skipFunction
;
562 $files = array_map( array( $this, 'getLocalPath' ), $files );
563 // File deps need to be treated separately because they're already prefixed
564 $files = array_merge( $files, $this->getFileDependencies( $context->getSkin() ) );
565 // Filter out any duplicates from getFileDependencies() and others.
566 // Most commonly introduced by compileLessFile(), which always includes the
567 // entry point Less file we already know about.
568 $files = array_values( array_unique( $files ) );
570 // Don't include keys or file paths here, only the hashes. Including that would needlessly
571 // cause global cache invalidation when files move or if e.g. the MediaWiki path changes.
572 // Any significant ordering is already detected by the definition summary.
573 return array_map( array( __CLASS__
, 'safeFileHash' ), $files );
577 * Get the definition summary for this module.
579 * @param ResourceLoaderContext $context
582 public function getDefinitionSummary( ResourceLoaderContext
$context ) {
583 $summary = parent
::getDefinitionSummary( $context );
587 // The following properties are omitted because they don't affect the module reponse:
588 // - localBasePath (Per T104950; Changes when absolute directory name changes. If
589 // this affects 'scripts' and other file paths, getFileHashes accounts for that.)
590 // - remoteBasePath (Per T104950)
591 // - dependencies (provided via startup module)
593 // - group (provided via startup module)
594 // - position (only used by OutputPage)
608 $options[$member] = $this->{$member};
612 'options' => $options,
613 'fileHashes' => $this->getFileHashes( $context ),
614 'msgBlobMtime' => $this->getMsgBlobMtime( $context->getLanguage() ),
620 * @param string|ResourceLoaderFilePath $path
623 protected function getLocalPath( $path ) {
624 if ( $path instanceof ResourceLoaderFilePath
) {
625 return $path->getLocalPath();
628 return "{$this->localBasePath}/$path";
632 * @param string|ResourceLoaderFilePath $path
635 protected function getRemotePath( $path ) {
636 if ( $path instanceof ResourceLoaderFilePath
) {
637 return $path->getRemotePath();
640 return "{$this->remoteBasePath}/$path";
644 * Infer the stylesheet language from a stylesheet file path.
647 * @param string $path
648 * @return string The stylesheet language name
650 public function getStyleSheetLang( $path ) {
651 return preg_match( '/\.less$/i', $path ) ?
'less' : 'css';
655 * Collates file paths by option (where provided).
657 * @param array $list List of file paths in any combination of index/path
658 * or path/options pairs
659 * @param string $option Option name
660 * @param mixed $default Default value if the option isn't set
661 * @return array List of file paths, collated by $option
663 protected static function collateFilePathListByOption( array $list, $option, $default ) {
664 $collatedFiles = array();
665 foreach ( (array)$list as $key => $value ) {
666 if ( is_int( $key ) ) {
667 // File name as the value
668 if ( !isset( $collatedFiles[$default] ) ) {
669 $collatedFiles[$default] = array();
671 $collatedFiles[$default][] = $value;
672 } elseif ( is_array( $value ) ) {
673 // File name as the key, options array as the value
674 $optionValue = isset( $value[$option] ) ?
$value[$option] : $default;
675 if ( !isset( $collatedFiles[$optionValue] ) ) {
676 $collatedFiles[$optionValue] = array();
678 $collatedFiles[$optionValue][] = $key;
681 return $collatedFiles;
685 * Get a list of element that match a key, optionally using a fallback key.
687 * @param array $list List of lists to select from
688 * @param string $key Key to look for in $map
689 * @param string $fallback Key to look for in $list if $key doesn't exist
690 * @return array List of elements from $map which matched $key or $fallback,
691 * or an empty list in case of no match
693 protected static function tryForKey( array $list, $key, $fallback = null ) {
694 if ( isset( $list[$key] ) && is_array( $list[$key] ) ) {
696 } elseif ( is_string( $fallback )
697 && isset( $list[$fallback] )
698 && is_array( $list[$fallback] )
700 return $list[$fallback];
706 * Get a list of file paths for all scripts in this module, in order of proper execution.
708 * @param ResourceLoaderContext $context
709 * @return array List of file paths
711 protected function getScriptFiles( ResourceLoaderContext
$context ) {
712 $files = array_merge(
714 $this->getLanguageScripts( $context->getLanguage() ),
715 self
::tryForKey( $this->skinScripts
, $context->getSkin(), 'default' )
717 if ( $context->getDebug() ) {
718 $files = array_merge( $files, $this->debugScripts
);
721 return array_unique( $files, SORT_REGULAR
);
725 * Get the set of language scripts for the given language,
726 * possibly using a fallback language.
728 * @param string $lang
731 private function getLanguageScripts( $lang ) {
732 $scripts = self
::tryForKey( $this->languageScripts
, $lang );
736 $fallbacks = Language
::getFallbacksFor( $lang );
737 foreach ( $fallbacks as $lang ) {
738 $scripts = self
::tryForKey( $this->languageScripts
, $lang );
748 * Get a list of file paths for all styles in this module, in order of proper inclusion.
750 * @param ResourceLoaderContext $context
751 * @return array List of file paths
753 public function getStyleFiles( ResourceLoaderContext
$context ) {
754 return array_merge_recursive(
755 self
::collateFilePathListByOption( $this->styles
, 'media', 'all' ),
756 self
::collateFilePathListByOption(
757 self
::tryForKey( $this->skinStyles
, $context->getSkin(), 'default' ),
765 * Gets a list of file paths for all skin styles in the module used by
768 * @param string $skinName The name of the skin
769 * @return array A list of file paths collated by media type
771 protected function getSkinStyleFiles( $skinName ) {
772 return self
::collateFilePathListByOption(
773 self
::tryForKey( $this->skinStyles
, $skinName ),
780 * Gets a list of file paths for all skin style files in the module,
781 * for all available skins.
783 * @return array A list of file paths collated by media type
785 protected function getAllSkinStyleFiles() {
786 $styleFiles = array();
787 $internalSkinNames = array_keys( Skin
::getSkinNames() );
788 $internalSkinNames[] = 'default';
790 foreach ( $internalSkinNames as $internalSkinName ) {
791 $styleFiles = array_merge_recursive(
793 $this->getSkinStyleFiles( $internalSkinName )
801 * Returns all style files and all skin style files used by this module.
805 public function getAllStyleFiles() {
806 $collatedStyleFiles = array_merge_recursive(
807 self
::collateFilePathListByOption( $this->styles
, 'media', 'all' ),
808 $this->getAllSkinStyleFiles()
813 foreach ( $collatedStyleFiles as $media => $styleFiles ) {
814 foreach ( $styleFiles as $styleFile ) {
815 $result[] = $this->getLocalPath( $styleFile );
823 * Gets the contents of a list of JavaScript files.
825 * @param array $scripts List of file paths to scripts to read, remap and concetenate
826 * @throws MWException
827 * @return string Concatenated and remapped JavaScript data from $scripts
829 protected function readScriptFiles( array $scripts ) {
830 if ( empty( $scripts ) ) {
834 foreach ( array_unique( $scripts, SORT_REGULAR
) as $fileName ) {
835 $localPath = $this->getLocalPath( $fileName );
836 if ( !file_exists( $localPath ) ) {
837 throw new MWException( __METHOD__
. ": script file not found: \"$localPath\"" );
839 $contents = file_get_contents( $localPath );
840 if ( $this->getConfig()->get( 'ResourceLoaderValidateStaticJS' ) ) {
841 // Static files don't really need to be checked as often; unlike
842 // on-wiki module they shouldn't change unexpectedly without
843 // admin interference.
844 $contents = $this->validateScriptFile( $fileName, $contents );
846 $js .= $contents . "\n";
852 * Gets the contents of a list of CSS files.
854 * @param array $styles List of media type/list of file paths pairs, to read, remap and
857 * @param ResourceLoaderContext $context (optional)
859 * @throws MWException
860 * @return array List of concatenated and remapped CSS data from $styles,
861 * keyed by media type
863 public function readStyleFiles( array $styles, $flip, $context = null ) {
864 if ( empty( $styles ) ) {
867 foreach ( $styles as $media => $files ) {
868 $uniqueFiles = array_unique( $files, SORT_REGULAR
);
869 $styleFiles = array();
870 foreach ( $uniqueFiles as $file ) {
871 $styleFiles[] = $this->readStyleFile( $file, $flip, $context );
873 $styles[$media] = implode( "\n", $styleFiles );
879 * Reads a style file.
881 * This method can be used as a callback for array_map()
883 * @param string $path File path of style file to read
885 * @param ResourceLoaderContext $context (optional)
887 * @return string CSS data in script file
888 * @throws MWException If the file doesn't exist
890 protected function readStyleFile( $path, $flip, $context = null ) {
891 $localPath = $this->getLocalPath( $path );
892 $remotePath = $this->getRemotePath( $path );
893 if ( !file_exists( $localPath ) ) {
894 $msg = __METHOD__
. ": style file not found: \"$localPath\"";
895 wfDebugLog( 'resourceloader', $msg );
896 throw new MWException( $msg );
899 if ( $this->getStyleSheetLang( $localPath ) === 'less' ) {
900 $compiler = $this->getLessCompiler( $context );
901 $style = $this->compileLessFile( $localPath, $compiler );
902 $this->hasGeneratedStyles
= true;
904 $style = file_get_contents( $localPath );
908 $style = CSSJanus
::transform( $style, true, false );
910 $localDir = dirname( $localPath );
911 $remoteDir = dirname( $remotePath );
912 // Get and register local file references
913 $localFileRefs = CSSMin
::getAllLocalFileReferences( $style, $localDir );
914 foreach ( $localFileRefs as $file ) {
915 if ( file_exists( $file ) ) {
916 $this->localFileRefs
[] = $file;
918 $this->missingLocalFileRefs
[] = $file;
921 return CSSMin
::remap(
922 $style, $localDir, $remoteDir, true
927 * Get whether CSS for this module should be flipped
928 * @param ResourceLoaderContext $context
931 public function getFlip( $context ) {
932 return $context->getDirection() === 'rtl';
936 * Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile']
938 * @return array Array of strings
940 public function getTargets() {
941 return $this->targets
;
945 * Compile a LESS file into CSS.
947 * Keeps track of all used files and adds them to localFileRefs.
950 * @throws Exception If less.php encounters a parse error
951 * @param string $fileName File path of LESS source
952 * @param Less_Parser $parser Compiler to use, if not default
953 * @return string CSS source
955 protected function compileLessFile( $fileName, $compiler = null ) {
959 $cache = ObjectCache
::newAccelerator( CACHE_ANYTHING
);
962 // Construct a cache key from the LESS file name and a hash digest
963 // of the LESS variables used for compilation.
964 $varsHash = hash( 'md4', serialize( ResourceLoader
::getLessVars( $this->getConfig() ) ) );
965 $cacheKey = wfGlobalCacheKey( 'LESS', $fileName, $varsHash );
966 $cachedCompile = $cache->get( $cacheKey );
968 // If we got a cached value, we have to validate it by getting a
969 // checksum of all the files that were loaded by the parser and
970 // ensuring it matches the cached entry's.
971 if ( isset( $cachedCompile['hash'] ) ) {
972 $contentHash = FileContentsHasher
::getFileContentsHash( $cachedCompile['files'] );
973 if ( $contentHash === $cachedCompile['hash'] ) {
974 $this->localFileRefs +
= $cachedCompile['files'];
975 return $cachedCompile['css'];
980 $compiler = $this->getLessCompiler();
983 $css = $compiler->parseFile( $fileName )->getCss();
984 $files = $compiler->AllParsedFiles();
985 $this->localFileRefs
= array_merge( $this->localFileRefs
, $files );
987 $cache->set( $cacheKey, array(
990 'hash' => FileContentsHasher
::getFileContentsHash( $files ),
991 ), 60 * 60 * 24 ); // 86400 seconds, or 24 hours.
997 * Get a LESS compiler instance for this module in given context.
999 * Just calls ResourceLoader::getLessCompiler() by default to get a global compiler.
1001 * @param ResourceLoaderContext $context
1002 * @throws MWException
1004 * @return Less_Parser
1006 protected function getLessCompiler( ResourceLoaderContext
$context = null ) {
1007 return ResourceLoader
::getLessCompiler( $this->getConfig() );
1011 * Takes named templates by the module and returns an array mapping.
1012 * @return array of templates mapping template alias to content
1013 * @throws MWException
1015 public function getTemplates() {
1016 $templates = array();
1018 foreach ( $this->templates
as $alias => $templatePath ) {
1019 // Alias is optional
1020 if ( is_int( $alias ) ) {
1021 $alias = $templatePath;
1023 $localPath = $this->getLocalPath( $templatePath );
1024 if ( file_exists( $localPath ) ) {
1025 $content = file_get_contents( $localPath );
1026 $templates[$alias] = $content;
1028 $msg = __METHOD__
. ": template file not found: \"$localPath\"";
1029 wfDebugLog( 'resourceloader', $msg );
1030 throw new MWException( $msg );