3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
19 * @author Trevor Parscal
20 * @author Roan Kattouw
24 * ResourceLoader module based on local JavaScript/CSS files.
26 class ResourceLoaderFileModule
extends ResourceLoaderModule
{
28 /* Protected Members */
30 /** String: Local base path, see __construct() */
31 protected $localBasePath = '';
32 /** String: Remote base path, see __construct() */
33 protected $remoteBasePath = '';
35 * Array: List of paths to JavaScript files to always include
36 * @example array( [file-path], [file-path], ... )
38 protected $scripts = array();
40 * Array: List of JavaScript files to include when using a specific language
41 * @example array( [language-code] => array( [file-path], [file-path], ... ), ... )
43 protected $languageScripts = array();
45 * Array: List of JavaScript files to include when using a specific skin
46 * @example array( [skin-name] => array( [file-path], [file-path], ... ), ... )
48 protected $skinScripts = array();
50 * Array: List of paths to JavaScript files to include in debug mode
51 * @example array( [skin-name] => array( [file-path], [file-path], ... ), ... )
53 protected $debugScripts = array();
55 * Array: List of paths to JavaScript files to include in the startup module
56 * @example array( [file-path], [file-path], ... )
58 protected $loaderScripts = array();
60 * Array: List of paths to CSS files to always include
61 * @example array( [file-path], [file-path], ... )
63 protected $styles = array();
65 * Array: List of paths to CSS files to include when using specific skins
66 * @example array( [file-path], [file-path], ... )
68 protected $skinStyles = array();
70 * Array: List of modules this module depends on
71 * @example array( [file-path], [file-path], ... )
73 protected $dependencies = array();
75 * Array: List of message keys used by this module
76 * @example array( [message-key], [message-key], ... )
78 protected $messages = array();
79 /** String: Name of group to load this module in */
81 /** Boolean: Link to raw files in debug mode */
82 protected $debugRaw = true;
84 * Array: Cache for mtime
85 * @example array( [hash] => [mtime], [hash] => [mtime], ... )
87 protected $modifiedTime = array();
89 * Array: Place where readStyleFile() tracks file dependencies
90 * @example array( [file-path], [file-path], ... )
92 protected $localFileRefs = array();
97 * Constructs a new module from an options array.
99 * @param $options Array: List of options; if not given or empty, an empty module will be
101 * @param $localBasePath String: Base path to prepend to all local paths in $options. Defaults
103 * @param $remoteBasePath String: Base path to prepend to all remote paths in $options. Defaults
108 * // Base path to prepend to all local paths in $options. Defaults to $IP
109 * 'localBasePath' => [base path],
110 * // Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath
111 * 'remoteBasePath' => [base path],
112 * // Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath
113 * 'remoteExtPath' => [base path],
114 * // Scripts to always include
115 * 'scripts' => [file path string or array of file path strings],
116 * // Scripts to include in specific language contexts
117 * 'languageScripts' => array(
118 * [language code] => [file path string or array of file path strings],
120 * // Scripts to include in specific skin contexts
121 * 'skinScripts' => array(
122 * [skin name] => [file path string or array of file path strings],
124 * // Scripts to include in debug contexts
125 * 'debugScripts' => [file path string or array of file path strings],
126 * // Scripts to include in the startup module
127 * 'loaderScripts' => [file path string or array of file path strings],
128 * // Modules which must be loaded before this module
129 * 'dependencies' => [modile name string or array of module name strings],
130 * // Styles to always load
131 * 'styles' => [file path string or array of file path strings],
132 * // Styles to include in specific skin contexts
133 * 'skinStyles' => array(
134 * [skin name] => [file path string or array of file path strings],
136 * // Messages to always load
137 * 'messages' => [array of message key strings],
138 * // Group which this module should be loaded together with
139 * 'group' => [group name string],
142 public function __construct( $options = array(), $localBasePath = null,
143 $remoteBasePath = null )
145 global $IP, $wgScriptPath;
146 $this->localBasePath
= $localBasePath === null ?
$IP : $localBasePath;
147 $this->remoteBasePath
= $remoteBasePath === null ?
$wgScriptPath : $remoteBasePath;
149 if ( isset( $options['remoteExtPath'] ) ) {
150 global $wgExtensionAssetsPath;
151 $this->remoteBasePath
= $wgExtensionAssetsPath . '/' . $options['remoteExtPath'];
154 foreach ( $options as $member => $option ) {
156 // Lists of file paths
159 case 'loaderScripts':
161 $this->{$member} = (array) $option;
163 // Collated lists of file paths
164 case 'languageScripts':
167 if ( !is_array( $option ) ) {
168 throw new MWException(
169 "Invalid collated file path list error. " .
170 "'$option' given, array expected."
173 foreach ( $option as $key => $value ) {
174 if ( !is_string( $key ) ) {
175 throw new MWException(
176 "Invalid collated file path list key error. " .
177 "'$key' given, string expected."
180 $this->{$member}[$key] = (array) $value;
186 $this->{$member} = (array) $option;
190 case 'localBasePath':
191 case 'remoteBasePath':
192 $this->{$member} = (string) $option;
196 $this->{$member} = (bool) $option;
203 * Gets all scripts for a given context concatenated together.
205 * @param $context ResourceLoaderContext: Context in which to generate script
206 * @return String: JavaScript code for $context
208 public function getScript( ResourceLoaderContext
$context ) {
211 $files = array_merge(
213 self
::tryForKey( $this->languageScripts
, $context->getLanguage() ),
214 self
::tryForKey( $this->skinScripts
, $context->getSkin(), 'default' )
216 if ( $context->getDebug() ) {
217 $files = array_merge( $files, $this->debugScripts
);
218 if ( $this->debugRaw
) {
220 foreach ( $files as $file ) {
221 $path = $wgServer . $this->getRemotePath( $file );
222 $script .= "\n\t" . Xml
::encodeJsCall( 'mediaWiki.loader.load', array( $path ) );
227 return $this->readScriptFiles( $files );
231 * Gets loader script.
233 * @return String: JavaScript code to be added to startup module
235 public function getLoaderScript() {
236 if ( count( $this->loaderScripts
) == 0 ) {
239 return $this->readScriptFiles( $this->loaderScripts
);
243 * Gets all styles for a given context concatenated together.
245 * @param $context ResourceLoaderContext: Context in which to generate styles
246 * @return String: CSS code for $context
248 public function getStyles( ResourceLoaderContext
$context ) {
249 // Merge general styles and skin specific styles, retaining media type collation
250 $styles = $this->readStyleFiles( $this->styles
);
251 $skinStyles = $this->readStyleFiles(
252 self
::tryForKey( $this->skinStyles
, $context->getSkin(), 'default' ) );
254 foreach ( $skinStyles as $media => $style ) {
255 if ( isset( $styles[$media] ) ) {
256 $styles[$media] .= $style;
258 $styles[$media] = $style;
261 // Collect referenced files
262 $this->localFileRefs
= array_unique( $this->localFileRefs
);
263 // If the list has been modified since last time we cached it, update the cache
264 if ( $this->localFileRefs
!== $this->getFileDependencies( $context->getSkin() ) ) {
265 $dbw = wfGetDB( DB_MASTER
);
266 $dbw->replace( 'module_deps',
267 array( array( 'md_module', 'md_skin' ) ), array(
268 'md_module' => $this->getName(),
269 'md_skin' => $context->getSkin(),
270 'md_deps' => FormatJson
::encode( $this->localFileRefs
),
278 * Gets list of message keys used by this module.
280 * @return Array: List of message keys
282 public function getMessages() {
283 return $this->messages
;
287 * Gets the name of the group this module should be loaded in.
289 * @return String: Group name
291 public function getGroup() {
296 * Gets list of names of modules this module depends on.
298 * @return Array: List of module names
300 public function getDependencies() {
301 return $this->dependencies
;
305 * Get the last modified timestamp of this module.
307 * Last modified timestamps are calculated from the highest last modified
308 * timestamp of this module's constituent files as well as the files it
309 * depends on. This function is context-sensitive, only performing
310 * calculations on files relevant to the given language, skin and debug
313 * @param $context ResourceLoaderContext: Context in which to calculate
315 * @return Integer: UNIX timestamp
316 * @see ResourceLoaderModule::getFileDependencies
318 public function getModifiedTime( ResourceLoaderContext
$context ) {
319 if ( isset( $this->modifiedTime
[$context->getHash()] ) ) {
320 return $this->modifiedTime
[$context->getHash()];
322 wfProfileIn( __METHOD__
);
326 // Flatten style files into $files
327 $styles = self
::collateFilePathListByOption( $this->styles
, 'media', 'all' );
328 foreach ( $styles as $styleFiles ) {
329 $files = array_merge( $files, $styleFiles );
331 $skinFiles = self
::tryForKey(
332 self
::collateFilePathListByOption( $this->skinStyles
, 'media', 'all' ),
336 foreach ( $skinFiles as $styleFiles ) {
337 $files = array_merge( $files, $styleFiles );
340 // Final merge, this should result in a master list of dependent files
341 $files = array_merge(
344 $context->getDebug() ?
$this->debugScripts
: array(),
345 self
::tryForKey( $this->languageScripts
, $context->getLanguage() ),
346 self
::tryForKey( $this->skinScripts
, $context->getSkin(), 'default' ),
349 $files = array_map( array( $this, 'getLocalPath' ), $files );
350 // File deps need to be treated separately because they're already prefixed
351 $files = array_merge( $files, $this->getFileDependencies( $context->getSkin() ) );
353 // If a module is nothing but a list of dependencies, we need to avoid
354 // giving max() an empty array
355 if ( count( $files ) === 0 ) {
356 return $this->modifiedTime
[$context->getHash()] = 1;
359 wfProfileIn( __METHOD__
.'-filemtime' );
360 $filesMtime = max( array_map( 'filemtime', $files ) );
361 wfProfileOut( __METHOD__
.'-filemtime' );
362 $this->modifiedTime
[$context->getHash()] = max(
364 $this->getMsgBlobMtime( $context->getLanguage() ) );
365 wfProfileOut( __METHOD__
);
366 return $this->modifiedTime
[$context->getHash()];
369 /* Protected Members */
371 protected function getLocalPath( $path ) {
372 return "{$this->localBasePath}/$path";
375 protected function getRemotePath( $path ) {
376 return "{$this->remoteBasePath}/$path";
380 * Collates file paths by option (where provided).
382 * @param $list Array: List of file paths in any combination of index/path
383 * or path/options pairs
384 * @param $option String: option name
385 * @param $default Mixed: default value if the option isn't set
386 * @return Array: List of file paths, collated by $option
388 protected static function collateFilePathListByOption( array $list, $option, $default ) {
389 $collatedFiles = array();
390 foreach ( (array) $list as $key => $value ) {
391 if ( is_int( $key ) ) {
392 // File name as the value
393 if ( !isset( $collatedFiles[$default] ) ) {
394 $collatedFiles[$default] = array();
396 $collatedFiles[$default][] = $value;
397 } else if ( is_array( $value ) ) {
398 // File name as the key, options array as the value
399 $optionValue = isset( $value[$option] ) ?
$value[$option] : $default;
400 if ( !isset( $collatedFiles[$optionValue] ) ) {
401 $collatedFiles[$optionValue] = array();
403 $collatedFiles[$optionValue][] = $key;
406 return $collatedFiles;
410 * Gets a list of element that match a key, optionally using a fallback key.
412 * @param $list Array: List of lists to select from
413 * @param $key String: Key to look for in $map
414 * @param $fallback String: Key to look for in $list if $key doesn't exist
415 * @return Array: List of elements from $map which matched $key or $fallback,
416 * or an empty list in case of no match
418 protected static function tryForKey( array $list, $key, $fallback = null ) {
419 if ( isset( $list[$key] ) && is_array( $list[$key] ) ) {
421 } else if ( is_string( $fallback )
422 && isset( $list[$fallback] )
423 && is_array( $list[$fallback] ) )
425 return $list[$fallback];
431 * Gets the contents of a list of JavaScript files.
433 * @param $scripts Array: List of file paths to scripts to read, remap and concetenate
434 * @return String: Concatenated and remapped JavaScript data from $scripts
436 protected function readScriptFiles( array $scripts ) {
437 if ( empty( $scripts ) ) {
441 foreach ( array_unique( $scripts ) as $fileName ) {
442 $localPath = $this->getLocalPath( $fileName );
443 $contents = file_get_contents( $localPath );
444 if ( $contents === false ) {
445 throw new MWException( __METHOD__
.": script file not found: \"$localPath\"" );
447 $js .= $contents . "\n";
453 * Gets the contents of a list of CSS files.
455 * @param $styles Array: List of file paths to styles to read, remap and concetenate
456 * @return Array: List of concatenated and remapped CSS data from $styles,
457 * keyed by media type
459 protected function readStyleFiles( array $styles ) {
460 if ( empty( $styles ) ) {
463 $styles = self
::collateFilePathListByOption( $styles, 'media', 'all' );
464 foreach ( $styles as $media => $files ) {
465 $styles[$media] = implode(
466 "\n", array_map( array( $this, 'readStyleFile' ), array_unique( $files ) )
473 * Reads a style file.
475 * This method can be used as a callback for array_map()
477 * @param $path String: File path of script file to read
478 * @return String: CSS data in script file
480 protected function readStyleFile( $path ) {
481 $localPath = $this->getLocalPath( $path );
482 $style = file_get_contents( $localPath );
483 if ( $style === false ) {
484 throw new MWException( __METHOD__
.": style file not found: \"$localPath\"" );
486 $dir = $this->getLocalPath( dirname( $path ) );
487 $remoteDir = $this->getRemotePath( dirname( $path ) );
488 // Get and register local file references
489 $this->localFileRefs
= array_merge(
490 $this->localFileRefs
,
491 CSSMin
::getLocalFileReferences( $style, $dir ) );
492 return CSSMin
::remap(
493 $style, $dir, $remoteDir, true