2 * Base library for MediaWiki.
4 * Exposed globally as `mediaWiki` with `mw` as shortcut.
7 * @alternateClassName mediaWiki
10 /*jshint latedef:false */
16 hasOwn
= Object
.prototype.hasOwnProperty
,
17 slice
= Array
.prototype.slice
,
18 trackCallbacks
= $.Callbacks( 'memory' ),
23 * Create an object that can be read from or written to from methods that allow
24 * interaction both with single and multiple properties at once.
28 * var collection, query, results;
30 * // Create your address book
31 * collection = new mw.Map();
33 * // This data could be coming from an external source (eg. API/AJAX)
35 * 'John Doe': 'john@example.org',
36 * 'Jane Doe': 'jane@example.org',
37 * 'George van Halen': 'gvanhalen@example.org'
40 * wanted = ['John Doe', 'Jane Doe', 'Daniel Jackson'];
42 * // You can detect missing keys first
43 * if ( !collection.exists( wanted ) ) {
44 * // One or more are missing (in this case: "Daniel Jackson")
45 * mw.log( 'One or more names were not found in your address book' );
48 * // Or just let it give you what it can. Optionally fill in from a default.
49 * results = collection.get( wanted, 'nobody@example.com' );
50 * mw.log( results['Jane Doe'] ); // "jane@example.org"
51 * mw.log( results['Daniel Jackson'] ); // "nobody@example.com"
56 * @param {Object|boolean} [values] The value-baring object to be mapped. Defaults to an
58 * For backwards-compatibility with mw.config, this can also be `true` in which case values
59 * are copied to the Window object as global variables (T72470). Values are copied in
60 * one direction only. Changes to globals are not reflected in the map.
62 function Map( values
) {
63 if ( values
=== true ) {
66 // Override #set to also set the global variable
67 this.set = function ( selection
, value
) {
70 if ( $.isPlainObject( selection
) ) {
71 for ( s
in selection
) {
72 setGlobalMapValue( this, s
, selection
[ s
] );
76 if ( typeof selection
=== 'string' && arguments
.length
) {
77 setGlobalMapValue( this, selection
, value
);
86 this.values
= values
|| {};
90 * Alias property to the global object.
96 * @param {Mixed} value
98 function setGlobalMapValue( map
, key
, value
) {
99 map
.values
[ key
] = value
;
104 // Deprecation notice for mw.config globals (T58550, T72470)
105 map
=== mw
.config
&& 'Use mw.config instead.'
111 * Get the value of one or more keys.
113 * If called with no arguments, all values are returned.
115 * @param {string|Array} [selection] Key or array of keys to retrieve values for.
116 * @param {Mixed} [fallback=null] Value for keys that don't exist.
117 * @return {Mixed|Object| null} If selection was a string, returns the value,
118 * If selection was an array, returns an object of key/values.
119 * If no selection is passed, the 'values' container is returned. (Beware that,
120 * as is the default in JavaScript, the object is returned by reference.)
122 get: function ( selection
, fallback
) {
124 // If we only do this in the `return` block, it'll fail for the
125 // call to get() from the mutli-selection block.
126 fallback
= arguments
.length
> 1 ? fallback
: null;
128 if ( $.isArray( selection
) ) {
129 selection
= slice
.call( selection
);
131 for ( i
= 0; i
< selection
.length
; i
++ ) {
132 results
[ selection
[ i
] ] = this.get( selection
[ i
], fallback
);
137 if ( typeof selection
=== 'string' ) {
138 if ( !hasOwn
.call( this.values
, selection
) ) {
141 return this.values
[ selection
];
144 if ( selection
=== undefined ) {
148 // Invalid selection key
153 * Set one or more key/value pairs.
155 * @param {string|Object} selection Key to set value for, or object mapping keys to values
156 * @param {Mixed} [value] Value to set (optional, only in use when key is a string)
157 * @return {boolean} True on success, false on failure
159 set: function ( selection
, value
) {
162 if ( $.isPlainObject( selection
) ) {
163 for ( s
in selection
) {
164 this.values
[ s
] = selection
[ s
];
168 if ( typeof selection
=== 'string' && arguments
.length
> 1 ) {
169 this.values
[ selection
] = value
;
176 * Check if one or more keys exist.
178 * @param {Mixed} selection Key or array of keys to check
179 * @return {boolean} True if the key(s) exist
181 exists: function ( selection
) {
184 if ( $.isArray( selection
) ) {
185 for ( s
= 0; s
< selection
.length
; s
++ ) {
186 if ( typeof selection
[ s
] !== 'string' || !hasOwn
.call( this.values
, selection
[ s
] ) ) {
192 return typeof selection
=== 'string' && hasOwn
.call( this.values
, selection
);
197 * Object constructor for messages.
199 * Similar to the Message class in MediaWiki PHP.
201 * Format defaults to 'text'.
207 * 'hello': 'Hello world',
208 * 'hello-user': 'Hello, $1!',
209 * 'welcome-user': 'Welcome back to $2, $1! Last visit by $1: $3'
212 * obj = new mw.Message( mw.messages, 'hello' );
213 * mw.log( obj.text() );
216 * obj = new mw.Message( mw.messages, 'hello-user', [ 'John Doe' ] );
217 * mw.log( obj.text() );
218 * // Hello, John Doe!
220 * obj = new mw.Message( mw.messages, 'welcome-user', [ 'John Doe', 'Wikipedia', '2 hours ago' ] );
221 * mw.log( obj.text() );
222 * // Welcome back to Wikipedia, John Doe! Last visit by John Doe: 2 hours ago
224 * // Using mw.message shortcut
225 * obj = mw.message( 'hello-user', 'John Doe' );
226 * mw.log( obj.text() );
227 * // Hello, John Doe!
229 * // Using mw.msg shortcut
230 * str = mw.msg( 'hello-user', 'John Doe' );
232 * // Hello, John Doe!
234 * // Different formats
235 * obj = new mw.Message( mw.messages, 'hello-user', [ 'John "Wiki" <3 Doe' ] );
237 * obj.format = 'text';
238 * str = obj.toString();
243 * // Hello, John "Wiki" <3 Doe!
245 * mw.log( obj.escaped() );
246 * // Hello, John "Wiki" <3 Doe!
251 * @param {mw.Map} map Message store
252 * @param {string} key
253 * @param {Array} [parameters]
255 function Message( map
, key
, parameters
) {
256 this.format
= 'text';
259 this.parameters
= parameters
=== undefined ? [] : slice
.call( parameters
);
263 Message
.prototype = {
265 * Get parsed contents of the message.
267 * The default parser does simple $N replacements and nothing else.
268 * This may be overridden to provide a more complex message parser.
269 * The primary override is in the mediawiki.jqueryMsg module.
271 * This function will not be called for nonexistent messages.
273 * @return {string} Parsed message
275 parser: function () {
276 return mw
.format
.apply( null, [ this.map
.get( this.key
) ].concat( this.parameters
) );
280 * Add (does not replace) parameters for `N$` placeholder values.
282 * @param {Array} parameters
285 params: function ( parameters
) {
287 for ( i
= 0; i
< parameters
.length
; i
+= 1 ) {
288 this.parameters
.push( parameters
[ i
] );
294 * Convert message object to its string form based on current format.
296 * @return {string} Message as a string in the current form, or `<key>` if key
299 toString: function () {
302 if ( !this.exists() ) {
303 // Use <key> as text if key does not exist
304 if ( this.format
=== 'escaped' || this.format
=== 'parse' ) {
305 // format 'escaped' and 'parse' need to have the brackets and key html escaped
306 return mw
.html
.escape( '<' + this.key
+ '>' );
308 return '<' + this.key
+ '>';
311 if ( this.format
=== 'plain' || this.format
=== 'text' || this.format
=== 'parse' ) {
312 text
= this.parser();
315 if ( this.format
=== 'escaped' ) {
316 text
= this.parser();
317 text
= mw
.html
.escape( text
);
324 * Change format to 'parse' and convert message to string
326 * If jqueryMsg is loaded, this parses the message text from wikitext
327 * (where supported) to HTML
329 * Otherwise, it is equivalent to plain.
331 * @return {string} String form of parsed message
334 this.format
= 'parse';
335 return this.toString();
339 * Change format to 'plain' and convert message to string
341 * This substitutes parameters, but otherwise does not change the
344 * @return {string} String form of plain message
347 this.format
= 'plain';
348 return this.toString();
352 * Change format to 'text' and convert message to string
354 * If jqueryMsg is loaded, {{-transformation is done where supported
355 * (such as {{plural:}}, {{gender:}}, {{int:}}).
357 * Otherwise, it is equivalent to plain
359 * @return {string} String form of text message
362 this.format
= 'text';
363 return this.toString();
367 * Change the format to 'escaped' and convert message to string
369 * This is equivalent to using the 'text' format (see #text), then
370 * HTML-escaping the output.
372 * @return {string} String form of html escaped message
374 escaped: function () {
375 this.format
= 'escaped';
376 return this.toString();
380 * Check if a message exists
385 exists: function () {
386 return this.map
.exists( this.key
);
396 * Get the current time, measured in milliseconds since January 1, 1970 (UTC).
398 * On browsers that implement the Navigation Timing API, this function will produce floating-point
399 * values with microsecond precision that are guaranteed to be monotonic. On all other browsers,
400 * it will fall back to using `Date`.
402 * @return {number} Current time
405 var perf
= window
.performance
,
406 navStart
= perf
&& perf
.timing
&& perf
.timing
.navigationStart
;
407 return navStart
&& typeof perf
.now
=== 'function' ?
408 function () { return navStart
+ perf
.now(); } :
409 function () { return +new Date(); };
413 * Format a string. Replace $1, $2 ... $N with positional arguments.
415 * Used by Message#parser().
418 * @param {string} fmt Format string
419 * @param {Mixed...} parameters Values for $N replacements
420 * @return {string} Formatted string
422 format: function ( formatString
) {
423 var parameters
= slice
.call( arguments
, 1 );
424 return formatString
.replace( /\$(\d+)/g, function ( str
, match
) {
425 var index
= parseInt( match
, 10 ) - 1;
426 return parameters
[ index
] !== undefined ? parameters
[ index
] : '$' + match
;
431 * Track an analytic event.
433 * This method provides a generic means for MediaWiki JavaScript code to capture state
434 * information for analysis. Each logged event specifies a string topic name that describes
435 * the kind of event that it is. Topic names consist of dot-separated path components,
436 * arranged from most general to most specific. Each path component should have a clear and
437 * well-defined purpose.
439 * Data handlers are registered via `mw.trackSubscribe`, and receive the full set of
440 * events that match their subcription, including those that fired before the handler was
443 * @param {string} topic Topic name
444 * @param {Object} [data] Data describing the event, encoded as an object
446 track: function ( topic
, data
) {
447 trackQueue
.push( { topic
: topic
, timeStamp
: mw
.now(), data
: data
} );
448 trackCallbacks
.fire( trackQueue
);
452 * Register a handler for subset of analytic events, specified by topic.
454 * Handlers will be called once for each tracked event, including any events that fired before the
455 * handler was registered; 'this' is set to a plain object with a 'timeStamp' property indicating
456 * the exact time at which the event fired, a string 'topic' property naming the event, and a
457 * 'data' property which is an object of event-specific data. The event topic and event data are
458 * also passed to the callback as the first and second arguments, respectively.
460 * @param {string} topic Handle events whose name starts with this string prefix
461 * @param {Function} callback Handler to call for each matching tracked event
462 * @param {string} callback.topic
463 * @param {Object} [callback.data]
465 trackSubscribe: function ( topic
, callback
) {
467 function handler( trackQueue
) {
469 for ( ; seen
< trackQueue
.length
; seen
++ ) {
470 event
= trackQueue
[ seen
];
471 if ( event
.topic
.indexOf( topic
) === 0 ) {
472 callback
.call( event
, event
.topic
, event
.data
);
477 trackHandlers
.push( [ handler
, callback
] );
479 trackCallbacks
.add( handler
);
483 * Stop handling events for a particular handler
485 * @param {Function} callback
487 trackUnsubscribe: function ( callback
) {
488 trackHandlers
= $.grep( trackHandlers
, function ( fns
) {
489 if ( fns
[ 1 ] === callback
) {
490 trackCallbacks
.remove( fns
[ 0 ] );
491 // Ensure the tuple is removed to avoid holding on to closures
498 // Expose Map constructor
501 // Expose Message constructor
505 * Map of configuration values.
507 * Check out [the complete list of configuration values](https://www.mediawiki.org/wiki/Manual:Interface/JavaScript#mw.config)
510 * If `$wgLegacyJavaScriptGlobals` is true, this Map will add its values to the
511 * global `window` object.
513 * @property {mw.Map} config
515 // Dummy placeholder later assigned in ResourceLoaderStartUpModule
519 * Empty object for third-party libraries, for cases where you don't
520 * want to add a new global, or the global is bad and needs containment
528 * Access container for deprecated functionality that can be moved from
529 * from their legacy location and attached to this object (e.g. a global
530 * function that is deprecated and as stop-gap can be exposed through here).
532 * This was reserved for future use but never ended up being used.
534 * @deprecated since 1.22 Let deprecated identifiers keep their original name
535 * and use mw.log#deprecate to create an access container for tracking.
541 * Store for messages.
548 * Store for templates associated with a module.
552 templates
: new Map(),
555 * Get a message object.
557 * Shorcut for `new mw.Message( mw.messages, key, parameters )`.
560 * @param {string} key Key of message to get
561 * @param {Mixed...} parameters Values for $N replacements
562 * @return {mw.Message}
564 message: function ( key
) {
565 var parameters
= slice
.call( arguments
, 1 );
566 return new Message( mw
.messages
, key
, parameters
);
570 * Get a message string using the (default) 'text' format.
572 * Shortcut for `mw.message( key, parameters... ).text()`.
575 * @param {string} key Key of message to get
576 * @param {Mixed...} parameters Values for $N replacements
580 return mw
.message
.apply( mw
.message
, arguments
).toString();
584 * Dummy placeholder for {@link mw.log}
589 // Also update the restoration of methods in mediawiki.log.js
590 // when adding or removing methods here.
591 var log = function () {};
599 * Write a message the console's warning channel.
600 * Actions not supported by the browser console are silently ignored.
602 * @param {string...} msg Messages to output to console
604 log
.warn = function () {
605 var console
= window
.console
;
606 if ( console
&& console
.warn
&& console
.warn
.apply
) {
607 console
.warn
.apply( console
, arguments
);
612 * Write a message the console's error channel.
614 * Most browsers provide a stacktrace by default if the argument
615 * is a caught Error object.
618 * @param {Error|string...} msg Messages to output to console
620 log
.error = function () {
621 var console
= window
.console
;
622 if ( console
&& console
.error
&& console
.error
.apply
) {
623 console
.error
.apply( console
, arguments
);
628 * Create a property in a host object that, when accessed, will produce
629 * a deprecation warning in the console with backtrace.
631 * @param {Object} obj Host object of deprecated property
632 * @param {string} key Name of property to create in `obj`
633 * @param {Mixed} val The value this property should return when accessed
634 * @param {string} [msg] Optional text to include in the deprecation message
636 log
.deprecate
= !Object
.defineProperty
? function ( obj
, key
, val
) {
638 } : function ( obj
, key
, val
, msg
) {
639 msg
= 'Use of "' + key
+ '" is deprecated.' + ( msg
? ( ' ' + msg
) : '' );
641 // Can throw on Object.defineProperty.
643 Object
.defineProperty( obj
, key
, {
647 mw
.track( 'mw.deprecate', key
);
651 set: function ( newVal
) {
652 mw
.track( 'mw.deprecate', key
);
658 // Fallback to creating a copy of the value to the object.
667 * Client for ResourceLoader server end point.
669 * This client is in charge of maintaining the module registry and state
670 * machine, initiating network (batch) requests for loading modules, as
671 * well as dependency resolution and execution of source code.
673 * For more information, refer to
674 * <https://www.mediawiki.org/wiki/ResourceLoader/Features>
679 loader
: ( function () {
682 * Fired via mw.track on various resource loading errors.
684 * @event resourceloader_exception
685 * @param {Error|Mixed} e The error that was thrown. Almost always an Error
686 * object, but in theory module code could manually throw something else, and that
687 * might also end up here.
688 * @param {string} [module] Name of the module which caused the error. Omitted if the
689 * error is not module-related or the module cannot be easily identified due to
691 * @param {string} source Source of the error. Possible values:
693 * - style: stylesheet error (only affects old IE where a special style loading method
695 * - load-callback: exception thrown by user callback
696 * - module-execute: exception thrown by module code
697 * - store-eval: could not evaluate module code cached in localStorage
698 * - store-localstorage-init: localStorage or JSON parse error in mw.loader.store.init
699 * - store-localstorage-json: JSON conversion error in mw.loader.store.set
700 * - store-localstorage-update: localStorage or JSON conversion error in mw.loader.store.update
704 * Fired via mw.track on resource loading error conditions.
706 * @event resourceloader_assert
707 * @param {string} source Source of the error. Possible values:
709 * - bug-T59567: failed to cache script due to an Opera function -> string conversion
710 * bug; see <https://phabricator.wikimedia.org/T59567> for details
714 * Mapping of registered modules.
716 * See #implement and #execute for exact details on support for script, style and messages.
722 * // From mw.loader.register()
723 * 'version': '########' (hash)
724 * 'dependencies': ['required.foo', 'bar.also', ...], (or) function () {}
725 * 'group': 'somegroup', (or) null
726 * 'source': 'local', (or) 'anotherwiki'
727 * 'skip': 'return !!window.Example', (or) null
729 * // Set from execute() or mw.loader.state()
730 * 'state': 'registered', 'loaded', 'loading', 'ready', 'error', or 'missing'
732 * // Optionally added at run-time by mw.loader.implement()
734 * 'script': closure, array of urls, or string
735 * 'style': { ... } (see #execute)
736 * 'messages': { 'key': 'value', ... }
743 * The module is known to the system but not yet requested.
744 * Meta data is registered via mw.loader#register. Calls to that method are
745 * generated server-side by the startup module.
747 * The module is requested through mw.loader (either directly or as dependency of
748 * another module). The client will be fetching module contents from the server.
749 * The contents are then stashed in the registry via mw.loader#implement.
751 * The module has been requested from the server and stashed via mw.loader#implement.
752 * If the module has no more dependencies in-fight, the module will be executed
753 * right away. Otherwise execution is deferred, controlled via #handlePending.
755 * The module is being executed.
757 * The module has been successfully executed.
759 * The module (or one of its dependencies) produced an error during execution.
761 * The module was registered client-side and requested, but the server denied knowledge
762 * of the module's existence.
768 // Mapping of sources, keyed by source-id, values are strings.
773 // 'sourceId': 'http://example.org/w/load.php'
778 // List of modules which will be loaded as when ready
781 // List of modules to be loaded
785 * List of callback jobs waiting for modules to be ready.
787 * Jobs are created by #request() and run by #handlePending().
789 * Typically when a job is created for a module, the job's dependencies contain
790 * both the module being requested and all its recursive dependencies.
795 * 'dependencies': [ module names ],
796 * 'ready': Function callback
797 * 'error': Function callback
800 * @property {Object[]} jobs
805 // Selector cache for the marker element. Use getMarker() to get/use the marker!
808 // Buffer for #addEmbeddedCSS
811 // Callbacks for #addEmbeddedCSS
812 cssCallbacks
= $.Callbacks();
814 function getMarker() {
817 $marker
= $( 'meta[name="ResourceLoaderDynamicStyles"]' );
818 if ( !$marker
.length
) {
819 mw
.log( 'No <meta name="ResourceLoaderDynamicStyles"> found, inserting dynamically' );
820 $marker
= $( '<meta>' ).attr( 'name', 'ResourceLoaderDynamicStyles' ).appendTo( 'head' );
827 * Create a new style element and add it to the DOM.
830 * @param {string} text CSS text
831 * @param {HTMLElement|jQuery} [nextnode=document.head] The element where the style tag
832 * should be inserted before
833 * @return {HTMLElement} Reference to the created style element
835 function newStyleTag( text
, nextnode
) {
836 var s
= document
.createElement( 'style' );
838 // Must attach to document before setting cssText (bug 33305)
840 $( nextnode
).before( s
);
842 document
.getElementsByTagName( 'head' )[ 0 ].appendChild( s
);
844 if ( s
.styleSheet
) {
846 // Old IE ignores appended text nodes, access stylesheet directly.
847 s
.styleSheet
.cssText
= text
;
849 // Standard behaviour
850 s
.appendChild( document
.createTextNode( text
) );
856 * Add a bit of CSS text to the current browser page.
858 * The CSS will be appended to an existing ResourceLoader-created `<style>` tag
859 * or create a new one based on whether the given `cssText` is safe for extension.
861 * @param {string} [cssText=cssBuffer] If called without cssText,
862 * the internal buffer will be inserted instead.
863 * @param {Function} [callback]
865 function addEmbeddedCSS( cssText
, callback
) {
868 function fireCallbacks() {
869 var oldCallbacks
= cssCallbacks
;
870 // Reset cssCallbacks variable so it's not polluted by any calls to
871 // addEmbeddedCSS() from one of the callbacks (T105973)
872 cssCallbacks
= $.Callbacks();
873 oldCallbacks
.fire().empty();
877 cssCallbacks
.add( callback
);
880 // Yield once before inserting the <style> tag. There are likely
881 // more calls coming up which we can combine this way.
882 // Appending a stylesheet and waiting for the browser to repaint
883 // is fairly expensive, this reduces that (bug 45810)
885 // Be careful not to extend the buffer with css that needs a new stylesheet.
886 // cssText containing `@import` rules needs to go at the start of a buffer,
887 // since those only work when placed at the start of a stylesheet; bug 35562.
888 if ( !cssBuffer
|| cssText
.slice( 0, '@import'.length
) !== '@import' ) {
889 // Linebreak for somewhat distinguishable sections
890 // (the rl-cachekey comment separating each)
891 cssBuffer
+= '\n' + cssText
;
892 // TODO: Use requestAnimationFrame in the future which will
893 // perform even better by not injecting styles while the browser
895 setTimeout( function () {
896 // Can't pass addEmbeddedCSS to setTimeout directly because Firefox
897 // (below version 13) has the non-standard behaviour of passing a
898 // numerical "lateness" value as first argument to this callback
899 // http://benalman.com/news/2009/07/the-mysterious-firefox-settime/
905 // This is a delayed call and we got a buffer still
906 } else if ( cssBuffer
) {
911 // This is a delayed call, but buffer was already cleared by
912 // another delayed call.
916 // By default, always create a new <style>. Appending text to a <style>
917 // tag is bad as it means the contents have to be re-parsed (bug 45810).
919 // Except, of course, in IE 9 and below. In there we default to re-using and
920 // appending to a <style> tag due to the IE stylesheet limit (bug 31676).
921 if ( 'documentMode' in document
&& document
.documentMode
<= 9 ) {
923 $style
= getMarker().prev();
924 // Verify that the element before the marker actually is a
925 // <style> tag and one that came from ResourceLoader
926 // (not some other style tag or even a `<meta>` or `<script>`).
927 if ( $style
.data( 'ResourceLoaderDynamicStyleTag' ) === true ) {
928 // There's already a dynamic <style> tag present and
929 // we are able to append more to it.
930 styleEl
= $style
.get( 0 );
932 if ( styleEl
.styleSheet
) {
934 styleEl
.styleSheet
.cssText
+= cssText
;
936 mw
.track( 'resourceloader.exception', { exception
: e
, source
: 'stylesheet' } );
939 styleEl
.appendChild( document
.createTextNode( cssText
) );
946 $( newStyleTag( cssText
, getMarker() ) ).data( 'ResourceLoaderDynamicStyleTag', true );
953 * @param {Array} modules List of module names
954 * @return {string} Hash of concatenated version hashes.
956 function getCombinedVersion( modules
) {
957 var hashes
= $.map( modules
, function ( module
) {
958 return registry
[ module
].version
;
960 // Trim for consistency with server-side ResourceLoader::makeHash. It also helps
961 // save precious space in the limited query string. Otherwise modules are more
962 // likely to require multiple HTTP requests.
963 return sha1( hashes
.join( '' ) ).slice( 0, 12 );
967 * Determine whether all dependencies are in state 'ready', which means we may
968 * execute the module or job now.
971 * @param {Array} module Names of modules to be checked
972 * @return {boolean} True if all modules are in state 'ready', false otherwise
974 function allReady( modules
) {
976 for ( i
= 0; i
< modules
.length
; i
++ ) {
977 if ( mw
.loader
.getState( modules
[ i
] ) !== 'ready' ) {
985 * Determine whether all dependencies are in state 'ready', which means we may
986 * execute the module or job now.
989 * @param {Array} modules Names of modules to be checked
990 * @return {boolean} True if no modules are in state 'error' or 'missing', false otherwise
992 function anyFailed( modules
) {
994 for ( i
= 0; i
< modules
.length
; i
++ ) {
995 state
= mw
.loader
.getState( modules
[ i
] );
996 if ( state
=== 'error' || state
=== 'missing' ) {
1004 * A module has entered state 'ready', 'error', or 'missing'. Automatically update
1005 * pending jobs and modules that depend upon this module. If the given module failed,
1006 * propagate the 'error' state up the dependency tree. Otherwise, go ahead an execute
1007 * all jobs/modules now having their dependencies satisfied.
1009 * Jobs that depend on a failed module, will have their error callback ran (if any).
1012 * @param {string} module Name of module that entered one of the states 'ready', 'error', or 'missing'.
1014 function handlePending( module
) {
1015 var j
, job
, hasErrors
, m
, stateChange
;
1017 if ( registry
[ module
].state
=== 'error' || registry
[ module
].state
=== 'missing' ) {
1018 // If the current module failed, mark all dependent modules also as failed.
1019 // Iterate until steady-state to propagate the error state upwards in the
1022 stateChange
= false;
1023 for ( m
in registry
) {
1024 if ( registry
[ m
].state
!== 'error' && registry
[ m
].state
!== 'missing' ) {
1025 if ( anyFailed( registry
[ m
].dependencies
) ) {
1026 registry
[ m
].state
= 'error';
1031 } while ( stateChange
);
1034 // Execute all jobs whose dependencies are either all satisfied or contain at least one failed module.
1035 for ( j
= 0; j
< jobs
.length
; j
+= 1 ) {
1036 hasErrors
= anyFailed( jobs
[ j
].dependencies
);
1037 if ( hasErrors
|| allReady( jobs
[ j
].dependencies
) ) {
1038 // All dependencies satisfied, or some have errors
1040 jobs
.splice( j
, 1 );
1044 if ( $.isFunction( job
.error
) ) {
1045 job
.error( new Error( 'Module ' + module
+ ' has failed dependencies' ), [ module
] );
1048 if ( $.isFunction( job
.ready
) ) {
1053 // A user-defined callback raised an exception.
1054 // Swallow it to protect our state machine!
1055 mw
.track( 'resourceloader.exception', { exception
: e
, module
: module
, source
: 'load-callback' } );
1060 if ( registry
[ module
].state
=== 'ready' ) {
1061 // The current module became 'ready'. Set it in the module store, and recursively execute all
1062 // dependent modules that are loaded and now have all dependencies satisfied.
1063 mw
.loader
.store
.set( module
, registry
[ module
] );
1064 for ( m
in registry
) {
1065 if ( registry
[ m
].state
=== 'loaded' && allReady( registry
[ m
].dependencies
) ) {
1073 * Resolve dependencies and detect circular references.
1076 * @param {string} module Name of the top-level module whose dependencies shall be
1077 * resolved and sorted.
1078 * @param {Array} resolved Returns a topological sort of the given module and its
1079 * dependencies, such that later modules depend on earlier modules. The array
1080 * contains the module names. If the array contains already some module names,
1081 * this function appends its result to the pre-existing array.
1082 * @param {Object} [unresolved] Hash used to track the current dependency
1083 * chain; used to report loops in the dependency graph.
1084 * @throws {Error} If any unregistered module or a dependency loop is encountered
1086 function sortDependencies( module
, resolved
, unresolved
) {
1087 var n
, deps
, len
, skip
;
1089 if ( !hasOwn
.call( registry
, module
) ) {
1090 throw new Error( 'Unknown dependency: ' + module
);
1093 if ( registry
[ module
].skip
!== null ) {
1094 /*jshint evil:true */
1095 skip
= new Function( registry
[ module
].skip
);
1096 registry
[ module
].skip
= null;
1098 registry
[ module
].skipped
= true;
1099 registry
[ module
].dependencies
= [];
1100 registry
[ module
].state
= 'ready';
1101 handlePending( module
);
1106 // Resolves dynamic loader function and replaces it with its own results
1107 if ( $.isFunction( registry
[ module
].dependencies
) ) {
1108 registry
[ module
].dependencies
= registry
[ module
].dependencies();
1109 // Ensures the module's dependencies are always in an array
1110 if ( typeof registry
[ module
].dependencies
!== 'object' ) {
1111 registry
[ module
].dependencies
= [ registry
[ module
].dependencies
];
1114 if ( $.inArray( module
, resolved
) !== -1 ) {
1115 // Module already resolved; nothing to do
1118 // Create unresolved if not passed in
1119 if ( !unresolved
) {
1122 // Tracks down dependencies
1123 deps
= registry
[ module
].dependencies
;
1125 for ( n
= 0; n
< len
; n
+= 1 ) {
1126 if ( $.inArray( deps
[ n
], resolved
) === -1 ) {
1127 if ( unresolved
[ deps
[ n
] ] ) {
1129 'Circular reference detected: ' + module
+
1134 // Add to unresolved
1135 unresolved
[ module
] = true;
1136 sortDependencies( deps
[ n
], resolved
, unresolved
);
1137 delete unresolved
[ module
];
1140 resolved
[ resolved
.length
] = module
;
1144 * Get a list of module names that a module depends on in their proper dependency
1148 * @param {string[]} module Array of string module names
1149 * @return {Array} List of dependencies, including 'module'.
1151 function resolve( modules
) {
1153 $.each( modules
, function ( idx
, module
) {
1154 sortDependencies( module
, resolved
);
1160 * Load and execute a script with callback.
1163 * @param {string} src URL to script, will be used as the src attribute in the script tag
1164 * @return {jQuery.Promise}
1166 function addScript( src
) {
1170 // Force jQuery behaviour to be for crossDomain. Otherwise jQuery would use
1171 // XHR for a same domain request instead of <script>, which changes the request
1172 // headers (potentially missing a cache hit), and reduces caching in general
1173 // since browsers cache XHR much less (if at all). And XHR means we retreive
1174 // text, so we'd need to $.globalEval, which then messes up line numbers.
1181 * Utility function for execute()
1185 function addLink( media
, url
) {
1186 var el
= document
.createElement( 'link' );
1188 // Insert in document *before* setting href
1189 getMarker().before( el
);
1190 el
.rel
= 'stylesheet';
1191 if ( media
&& media
!== 'all' ) {
1194 // If you end up here from an IE exception "SCRIPT: Invalid property value.",
1195 // see #addEmbeddedCSS, bug 31676, and bug 47277 for details.
1200 * Executes a loaded module, making it ready to use
1203 * @param {string} module Module name to execute
1205 function execute( module
) {
1206 var key
, value
, media
, i
, urls
, cssHandle
, checkCssHandles
, runScript
,
1207 cssHandlesRegistered
= false;
1209 if ( !hasOwn
.call( registry
, module
) ) {
1210 throw new Error( 'Module has not been registered yet: ' + module
);
1212 if ( registry
[ module
].state
!== 'loaded' ) {
1213 throw new Error( 'Module in state "' + registry
[ module
].state
+ '" may not be executed: ' + module
);
1216 registry
[ module
].state
= 'executing';
1218 runScript = function () {
1219 var script
, markModuleReady
, nestedAddScript
, legacyWait
,
1220 // Expand to include dependencies since we have to exclude both legacy modules
1221 // and their dependencies from the legacyWait (to prevent a circular dependency).
1222 legacyModules
= resolve( mw
.config
.get( 'wgResourceLoaderLegacyModules', [] ) );
1224 script
= registry
[ module
].script
;
1225 markModuleReady = function () {
1226 registry
[ module
].state
= 'ready';
1227 handlePending( module
);
1229 nestedAddScript = function ( arr
, callback
, i
) {
1230 // Recursively call addScript() in its own callback
1231 // for each element of arr.
1232 if ( i
>= arr
.length
) {
1233 // We're at the end of the array
1238 addScript( arr
[ i
] ).always( function () {
1239 nestedAddScript( arr
, callback
, i
+ 1 );
1243 legacyWait
= ( $.inArray( module
, legacyModules
) !== -1 )
1244 ? $.Deferred().resolve()
1245 : mw
.loader
.using( legacyModules
);
1247 legacyWait
.always( function () {
1248 if ( $.isArray( script
) ) {
1249 nestedAddScript( script
, markModuleReady
, 0 );
1250 } else if ( $.isFunction( script
) ) {
1251 // Pass jQuery twice so that the signature of the closure which wraps
1252 // the script can bind both '$' and 'jQuery'.
1255 } else if ( typeof script
=== 'string' ) {
1256 // Site and user modules are a legacy scripts that run in the global scope.
1257 // This is transported as a string instead of a function to avoid needing
1258 // to use string manipulation to undo the function wrapper.
1259 if ( module
=== 'user' ) {
1260 // Implicit dependency on the site module. Not real dependency because
1261 // it should run after 'site' regardless of whether it succeeds or fails.
1262 mw
.loader
.using( 'site' ).always( function () {
1263 $.globalEval( script
);
1267 $.globalEval( script
);
1271 // Module without script
1276 // This needs to NOT use mw.log because these errors are common in production mode
1277 // and not in debug mode, such as when a symbol that should be global isn't exported
1278 registry
[ module
].state
= 'error';
1279 mw
.track( 'resourceloader.exception', { exception
: e
, module
: module
, source
: 'module-execute' } );
1280 handlePending( module
);
1284 // Add localizations to message system
1285 if ( registry
[ module
].messages
) {
1286 mw
.messages
.set( registry
[ module
].messages
);
1289 // Initialise templates
1290 if ( registry
[ module
].templates
) {
1291 mw
.templates
.set( module
, registry
[ module
].templates
);
1294 // Make sure we don't run the scripts until all stylesheet insertions have completed.
1297 checkCssHandles = function () {
1298 // cssHandlesRegistered ensures we don't take off too soon, e.g. when
1299 // one of the cssHandles is fired while we're still creating more handles.
1300 if ( cssHandlesRegistered
&& pending
=== 0 && runScript
) {
1302 runScript
= undefined; // Revoke
1305 cssHandle = function () {
1306 var check
= checkCssHandles
;
1308 return function () {
1312 check
= undefined; // Revoke
1318 // Process styles (see also mw.loader.implement)
1319 // * back-compat: { <media>: css }
1320 // * back-compat: { <media>: [url, ..] }
1321 // * { "css": [css, ..] }
1322 // * { "url": { <media>: [url, ..] } }
1323 if ( registry
[ module
].style
) {
1324 for ( key
in registry
[ module
].style
) {
1325 value
= registry
[ module
].style
[ key
];
1328 if ( key
!== 'url' && key
!== 'css' ) {
1329 // Backwards compatibility, key is a media-type
1330 if ( typeof value
=== 'string' ) {
1331 // back-compat: { <media>: css }
1332 // Ignore 'media' because it isn't supported (nor was it used).
1333 // Strings are pre-wrapped in "@media". The media-type was just ""
1334 // (because it had to be set to something).
1335 // This is one of the reasons why this format is no longer used.
1336 addEmbeddedCSS( value
, cssHandle() );
1338 // back-compat: { <media>: [url, ..] }
1344 // Array of css strings in key 'css',
1345 // or back-compat array of urls from media-type
1346 if ( $.isArray( value
) ) {
1347 for ( i
= 0; i
< value
.length
; i
+= 1 ) {
1348 if ( key
=== 'bc-url' ) {
1349 // back-compat: { <media>: [url, ..] }
1350 addLink( media
, value
[ i
] );
1351 } else if ( key
=== 'css' ) {
1352 // { "css": [css, ..] }
1353 addEmbeddedCSS( value
[ i
], cssHandle() );
1356 // Not an array, but a regular object
1357 // Array of urls inside media-type key
1358 } else if ( typeof value
=== 'object' ) {
1359 // { "url": { <media>: [url, ..] } }
1360 for ( media
in value
) {
1361 urls
= value
[ media
];
1362 for ( i
= 0; i
< urls
.length
; i
+= 1 ) {
1363 addLink( media
, urls
[ i
] );
1371 cssHandlesRegistered
= true;
1376 * Adds a dependencies to the queue with optional callbacks to be run
1377 * when the dependencies are ready or fail
1380 * @param {string|string[]} dependencies Module name or array of string module names
1381 * @param {Function} [ready] Callback to execute when all dependencies are ready
1382 * @param {Function} [error] Callback to execute when any dependency fails
1384 function request( dependencies
, ready
, error
) {
1385 // Allow calling by single module name
1386 if ( typeof dependencies
=== 'string' ) {
1387 dependencies
= [ dependencies
];
1390 // Add ready and error callbacks if they were given
1391 if ( ready
!== undefined || error
!== undefined ) {
1393 dependencies
: $.grep( dependencies
, function ( module
) {
1394 var state
= mw
.loader
.getState( module
);
1395 return state
=== 'registered' || state
=== 'loaded' || state
=== 'loading';
1402 $.each( dependencies
, function ( idx
, module
) {
1403 var state
= mw
.loader
.getState( module
);
1404 // Only queue modules that are still in the initial 'registered' state
1405 // (not ones already loading, ready or error).
1406 if ( state
=== 'registered' && $.inArray( module
, queue
) === -1 ) {
1407 // Private modules must be embedded in the page. Don't bother queuing
1408 // these as the server will deny them anyway (T101806).
1409 if ( registry
[ module
].group
=== 'private' ) {
1410 registry
[ module
].state
= 'error';
1411 handlePending( module
);
1414 queue
.push( module
);
1421 function sortQuery( o
) {
1427 if ( hasOwn
.call( o
, key
) ) {
1432 for ( key
= 0; key
< a
.length
; key
+= 1 ) {
1433 sorted
[ a
[ key
] ] = o
[ a
[ key
] ];
1439 * Converts a module map of the form { foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }
1440 * to a query string of the form foo.bar,baz|bar.baz,quux
1444 function buildModulesString( moduleMap
) {
1448 for ( prefix
in moduleMap
) {
1449 p
= prefix
=== '' ? '' : prefix
+ '.';
1450 arr
.push( p
+ moduleMap
[ prefix
].join( ',' ) );
1452 return arr
.join( '|' );
1456 * Load modules from load.php
1459 * @param {Object} moduleMap Module map, see #buildModulesString
1460 * @param {Object} currReqBase Object with other parameters (other than 'modules') to use in the request
1461 * @param {string} sourceLoadScript URL of load.php
1463 function doRequest( moduleMap
, currReqBase
, sourceLoadScript
) {
1464 var request
= $.extend(
1465 { modules
: buildModulesString( moduleMap
) },
1468 request
= sortQuery( request
);
1469 addScript( sourceLoadScript
+ '?' + $.param( request
) );
1473 * Resolve indexed dependencies.
1475 * ResourceLoader uses an optimization to save space which replaces module names in
1476 * dependency lists with the index of that module within the array of module
1477 * registration data if it exists. The benefit is a significant reduction in the data
1478 * size of the startup module. This function changes those dependency lists back to
1479 * arrays of strings.
1481 * @param {Array} modules Modules array
1483 function resolveIndexedDependencies( modules
) {
1484 $.each( modules
, function ( idx
, module
) {
1485 if ( module
[ 2 ] ) {
1486 module
[ 2 ] = $.map( module
[ 2 ], function ( dep
) {
1487 return typeof dep
=== 'number' ? modules
[ dep
][ 0 ] : dep
;
1493 /* Public Members */
1496 * The module registry is exposed as an aid for debugging and inspecting page
1497 * state; it is not a public interface for modifying the registry.
1503 moduleRegistry
: registry
,
1506 * @inheritdoc #newStyleTag
1509 addStyleTag
: newStyleTag
,
1512 * Batch-request queued dependencies from the server.
1515 var reqBase
, splits
, maxQueryLength
, q
, b
, bSource
, bGroup
, bSourceGroup
,
1516 source
, concatSource
, origBatch
, group
, i
, modules
, sourceLoadScript
,
1517 currReqBase
, currReqBaseLength
, moduleMap
, l
,
1518 lastDotIndex
, prefix
, suffix
, bytesAdded
;
1520 // Build a list of request parameters common to all requests.
1522 skin
: mw
.config
.get( 'skin' ),
1523 lang
: mw
.config
.get( 'wgUserLanguage' ),
1524 debug
: mw
.config
.get( 'debug' )
1526 // Split module batch by source and by group.
1528 maxQueryLength
= mw
.config
.get( 'wgResourceLoaderMaxQueryLength', 2000 );
1530 // Appends a list of modules from the queue to the batch
1531 for ( q
= 0; q
< queue
.length
; q
+= 1 ) {
1532 // Only request modules which are registered
1533 if ( hasOwn
.call( registry
, queue
[ q
] ) && registry
[ queue
[ q
] ].state
=== 'registered' ) {
1534 // Prevent duplicate entries
1535 if ( $.inArray( queue
[ q
], batch
) === -1 ) {
1536 batch
[ batch
.length
] = queue
[ q
];
1537 // Mark registered modules as loading
1538 registry
[ queue
[ q
] ].state
= 'loading';
1543 mw
.loader
.store
.init();
1544 if ( mw
.loader
.store
.enabled
) {
1547 batch
= $.grep( batch
, function ( module
) {
1548 var source
= mw
.loader
.store
.get( module
);
1550 concatSource
.push( source
);
1556 $.globalEval( concatSource
.join( ';' ) );
1558 // Not good, the cached mw.loader.implement calls failed! This should
1559 // never happen, barring ResourceLoader bugs, browser bugs and PEBKACs.
1560 // Depending on how corrupt the string is, it is likely that some
1561 // modules' implement() succeeded while the ones after the error will
1562 // never run and leave their modules in the 'loading' state forever.
1564 // Since this is an error not caused by an individual module but by
1565 // something that infected the implement call itself, don't take any
1566 // risks and clear everything in this cache.
1567 mw
.loader
.store
.clear();
1568 // Re-add the ones still pending back to the batch and let the server
1569 // repopulate these modules to the cache.
1570 // This means that at most one module will be useless (the one that had
1571 // the error) instead of all of them.
1572 mw
.track( 'resourceloader.exception', { exception
: err
, source
: 'store-eval' } );
1573 origBatch
= $.grep( origBatch
, function ( module
) {
1574 return registry
[ module
].state
=== 'loading';
1576 batch
= batch
.concat( origBatch
);
1580 // Early exit if there's nothing to load...
1581 if ( !batch
.length
) {
1585 // The queue has been processed into the batch, clear up the queue.
1588 // Always order modules alphabetically to help reduce cache
1589 // misses for otherwise identical content.
1592 // Split batch by source and by group.
1593 for ( b
= 0; b
< batch
.length
; b
+= 1 ) {
1594 bSource
= registry
[ batch
[ b
] ].source
;
1595 bGroup
= registry
[ batch
[ b
] ].group
;
1596 if ( !hasOwn
.call( splits
, bSource
) ) {
1597 splits
[ bSource
] = {};
1599 if ( !hasOwn
.call( splits
[ bSource
], bGroup
) ) {
1600 splits
[ bSource
][ bGroup
] = [];
1602 bSourceGroup
= splits
[ bSource
][ bGroup
];
1603 bSourceGroup
[ bSourceGroup
.length
] = batch
[ b
];
1606 // Clear the batch - this MUST happen before we append any
1607 // script elements to the body or it's possible that a script
1608 // will be locally cached, instantly load, and work the batch
1609 // again, all before we've cleared it causing each request to
1610 // include modules which are already loaded.
1613 for ( source
in splits
) {
1615 sourceLoadScript
= sources
[ source
];
1617 for ( group
in splits
[ source
] ) {
1619 // Cache access to currently selected list of
1620 // modules for this group from this source.
1621 modules
= splits
[ source
][ group
];
1623 currReqBase
= $.extend( {
1624 version
: getCombinedVersion( modules
)
1626 // For user modules append a user name to the request.
1627 if ( group
=== 'user' && mw
.config
.get( 'wgUserName' ) !== null ) {
1628 currReqBase
.user
= mw
.config
.get( 'wgUserName' );
1630 currReqBaseLength
= $.param( currReqBase
).length
;
1631 // We may need to split up the request to honor the query string length limit,
1632 // so build it piece by piece.
1633 l
= currReqBaseLength
+ 9; // '&modules='.length == 9
1635 moduleMap
= {}; // { prefix: [ suffixes ] }
1637 for ( i
= 0; i
< modules
.length
; i
+= 1 ) {
1638 // Determine how many bytes this module would add to the query string
1639 lastDotIndex
= modules
[ i
].lastIndexOf( '.' );
1641 // If lastDotIndex is -1, substr() returns an empty string
1642 prefix
= modules
[ i
].substr( 0, lastDotIndex
);
1643 suffix
= modules
[ i
].slice( lastDotIndex
+ 1 );
1645 bytesAdded
= hasOwn
.call( moduleMap
, prefix
)
1646 ? suffix
.length
+ 3 // '%2C'.length == 3
1647 : modules
[ i
].length
+ 3; // '%7C'.length == 3
1649 // If the request would become too long, create a new one,
1650 // but don't create empty requests
1651 if ( maxQueryLength
> 0 && !$.isEmptyObject( moduleMap
) && l
+ bytesAdded
> maxQueryLength
) {
1652 // This request would become too long, create a new one
1653 // and fire off the old one
1654 doRequest( moduleMap
, currReqBase
, sourceLoadScript
);
1656 l
= currReqBaseLength
+ 9;
1657 mw
.track( 'resourceloader.splitRequest', { maxQueryLength
: maxQueryLength
} );
1659 if ( !hasOwn
.call( moduleMap
, prefix
) ) {
1660 moduleMap
[ prefix
] = [];
1662 moduleMap
[ prefix
].push( suffix
);
1665 // If there's anything left in moduleMap, request that too
1666 if ( !$.isEmptyObject( moduleMap
) ) {
1667 doRequest( moduleMap
, currReqBase
, sourceLoadScript
);
1674 * Register a source.
1676 * The #work method will use this information to split up requests by source.
1678 * mw.loader.addSource( 'mediawikiwiki', '//www.mediawiki.org/w/load.php' );
1680 * @param {string} id Short string representing a source wiki, used internally for
1681 * registered modules to indicate where they should be loaded from (usually lowercase a-z).
1682 * @param {Object|string} loadUrl load.php url, may be an object for backwards-compatibility
1685 addSource: function ( id
, loadUrl
) {
1687 // Allow multiple additions
1688 if ( typeof id
=== 'object' ) {
1689 for ( source
in id
) {
1690 mw
.loader
.addSource( source
, id
[ source
] );
1695 if ( hasOwn
.call( sources
, id
) ) {
1696 throw new Error( 'source already registered: ' + id
);
1699 if ( typeof loadUrl
=== 'object' ) {
1700 loadUrl
= loadUrl
.loadScript
;
1703 sources
[ id
] = loadUrl
;
1709 * Register a module, letting the system know about it and its properties.
1711 * The startup modules contain calls to this method.
1713 * When using multiple module registration by passing an array, dependencies that
1714 * are specified as references to modules within the array will be resolved before
1715 * the modules are registered.
1717 * @param {string|Array} module Module name or array of arrays, each containing
1718 * a list of arguments compatible with this method
1719 * @param {string|number} version Module version hash (falls backs to empty string)
1720 * Can also be a number (timestamp) for compatibility with MediaWiki 1.25 and earlier.
1721 * @param {string|Array|Function} dependencies One string or array of strings of module
1722 * names on which this module depends, or a function that returns that array.
1723 * @param {string} [group=null] Group which the module is in
1724 * @param {string} [source='local'] Name of the source
1725 * @param {string} [skip=null] Script body of the skip function
1727 register: function ( module
, version
, dependencies
, group
, source
, skip
) {
1729 // Allow multiple registration
1730 if ( typeof module
=== 'object' ) {
1731 resolveIndexedDependencies( module
);
1732 for ( i
= 0, len
= module
.length
; i
< len
; i
++ ) {
1733 // module is an array of module names
1734 if ( typeof module
[ i
] === 'string' ) {
1735 mw
.loader
.register( module
[ i
] );
1736 // module is an array of arrays
1737 } else if ( typeof module
[ i
] === 'object' ) {
1738 mw
.loader
.register
.apply( mw
.loader
, module
[ i
] );
1744 if ( typeof module
!== 'string' ) {
1745 throw new Error( 'module must be a string, not a ' + typeof module
);
1747 if ( hasOwn
.call( registry
, module
) ) {
1748 throw new Error( 'module already registered: ' + module
);
1750 // List the module as registered
1751 registry
[ module
] = {
1752 version
: version
!== undefined ? String( version
) : '',
1754 group
: typeof group
=== 'string' ? group
: null,
1755 source
: typeof source
=== 'string' ? source
: 'local',
1756 state
: 'registered',
1757 skip
: typeof skip
=== 'string' ? skip
: null
1759 if ( typeof dependencies
=== 'string' ) {
1760 // Allow dependencies to be given as a single module name
1761 registry
[ module
].dependencies
= [ dependencies
];
1762 } else if ( typeof dependencies
=== 'object' || $.isFunction( dependencies
) ) {
1763 // Allow dependencies to be given as an array of module names
1764 // or a function which returns an array
1765 registry
[ module
].dependencies
= dependencies
;
1770 * Implement a module given the components that make up the module.
1772 * When #load or #using requests one or more modules, the server
1773 * response contain calls to this function.
1775 * All arguments are required.
1777 * @param {string} module Name of module
1778 * @param {Function|Array} script Function with module code or Array of URLs to
1779 * be used as the src attribute of a new `<script>` tag.
1780 * @param {Object} [style] Should follow one of the following patterns:
1782 * { "css": [css, ..] }
1783 * { "url": { <media>: [url, ..] } }
1785 * And for backwards compatibility (needs to be supported forever due to caching):
1788 * { <media>: [url, ..] }
1790 * The reason css strings are not concatenated anymore is bug 31676. We now check
1791 * whether it's safe to extend the stylesheet.
1793 * @param {Object} [messages] List of key/value pairs to be added to mw#messages.
1794 * @param {Object} [templates] List of key/value pairs to be added to mw#templates.
1796 implement: function ( module
, script
, style
, messages
, templates
) {
1798 if ( typeof module
!== 'string' ) {
1799 throw new Error( 'module must be of type string, not ' + typeof module
);
1801 if ( script
&& !$.isFunction( script
) && !$.isArray( script
) && typeof script
!== 'string' ) {
1802 throw new Error( 'script must be of type function, array, or script; not ' + typeof script
);
1804 if ( style
&& !$.isPlainObject( style
) ) {
1805 throw new Error( 'style must be of type object, not ' + typeof style
);
1807 if ( messages
&& !$.isPlainObject( messages
) ) {
1808 throw new Error( 'messages must be of type object, not a ' + typeof messages
);
1810 if ( templates
&& !$.isPlainObject( templates
) ) {
1811 throw new Error( 'templates must be of type object, not a ' + typeof templates
);
1813 // Automatically register module
1814 if ( !hasOwn
.call( registry
, module
) ) {
1815 mw
.loader
.register( module
);
1817 // Check for duplicate implementation
1818 if ( hasOwn
.call( registry
, module
) && registry
[ module
].script
!== undefined ) {
1819 throw new Error( 'module already implemented: ' + module
);
1821 // Attach components
1822 registry
[ module
].script
= script
|| null;
1823 registry
[ module
].style
= style
|| null;
1824 registry
[ module
].messages
= messages
|| null;
1825 registry
[ module
].templates
= templates
|| null;
1826 // The module may already have been marked as erroneous
1827 if ( $.inArray( registry
[ module
].state
, [ 'error', 'missing' ] ) === -1 ) {
1828 registry
[ module
].state
= 'loaded';
1829 if ( allReady( registry
[ module
].dependencies
) ) {
1836 * Execute a function as soon as one or more required modules are ready.
1838 * Example of inline dependency on OOjs:
1840 * mw.loader.using( 'oojs', function () {
1841 * OO.compare( [ 1 ], [ 1 ] );
1844 * @param {string|Array} dependencies Module name or array of modules names the callback
1845 * dependends on to be ready before executing
1846 * @param {Function} [ready] Callback to execute when all dependencies are ready
1847 * @param {Function} [error] Callback to execute if one or more dependencies failed
1848 * @return {jQuery.Promise}
1849 * @since 1.23 this returns a promise
1851 using: function ( dependencies
, ready
, error
) {
1852 var deferred
= $.Deferred();
1854 // Allow calling with a single dependency as a string
1855 if ( typeof dependencies
=== 'string' ) {
1856 dependencies
= [ dependencies
];
1857 } else if ( !$.isArray( dependencies
) ) {
1859 throw new Error( 'Dependencies must be a string or an array' );
1863 deferred
.done( ready
);
1866 deferred
.fail( error
);
1869 // Resolve entire dependency map
1870 dependencies
= resolve( dependencies
);
1871 if ( allReady( dependencies
) ) {
1872 // Run ready immediately
1874 } else if ( anyFailed( dependencies
) ) {
1875 // Execute error immediately if any dependencies have errors
1877 new Error( 'One or more dependencies failed to load' ),
1881 // Not all dependencies are ready: queue up a request
1882 request( dependencies
, deferred
.resolve
, deferred
.reject
);
1885 return deferred
.promise();
1889 * Load an external script or one or more modules.
1891 * @param {string|Array} modules Either the name of a module, array of modules,
1892 * or a URL of an external script or style
1893 * @param {string} [type='text/javascript'] MIME type to use if calling with a URL of an
1894 * external script or style; acceptable values are "text/css" and
1895 * "text/javascript"; if no type is provided, text/javascript is assumed.
1897 load: function ( modules
, type
) {
1901 if ( typeof modules
!== 'object' && typeof modules
!== 'string' ) {
1902 throw new Error( 'modules must be a string or an array, not a ' + typeof modules
);
1904 // Allow calling with an external url or single dependency as a string
1905 if ( typeof modules
=== 'string' ) {
1906 if ( /^(https?:)?\/\//.test( modules
) ) {
1907 if ( type
=== 'text/css' ) {
1909 // Use properties instead of attributes as IE throws security
1910 // warnings when inserting a <link> tag with a protocol-relative
1911 // URL set though attributes - when on HTTPS. See bug 41331.
1912 l
= document
.createElement( 'link' );
1913 l
.rel
= 'stylesheet';
1915 $( 'head' ).append( l
);
1918 if ( type
=== 'text/javascript' || type
=== undefined ) {
1919 addScript( modules
);
1923 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type
);
1925 // Called with single module
1926 modules
= [ modules
];
1929 // Filter out undefined modules, otherwise resolve() will throw
1930 // an exception for trying to load an undefined module.
1931 // Undefined modules are acceptable here in load(), because load() takes
1932 // an array of unrelated modules, whereas the modules passed to
1933 // using() are related and must all be loaded.
1934 filtered
= $.grep( modules
, function ( module
) {
1935 var state
= mw
.loader
.getState( module
);
1936 return state
!== null && state
!== 'error' && state
!== 'missing';
1939 if ( filtered
.length
=== 0 ) {
1942 // Resolve entire dependency map
1943 filtered
= resolve( filtered
);
1944 // If all modules are ready, or if any modules have errors, nothing to be done.
1945 if ( allReady( filtered
) || anyFailed( filtered
) ) {
1948 // Since some modules are not yet ready, queue up a request.
1949 request( filtered
, undefined, undefined );
1953 * Change the state of one or more modules.
1955 * @param {string|Object} module Module name or object of module name/state pairs
1956 * @param {string} state State name
1958 state: function ( module
, state
) {
1961 if ( typeof module
=== 'object' ) {
1962 for ( m
in module
) {
1963 mw
.loader
.state( m
, module
[ m
] );
1967 if ( !hasOwn
.call( registry
, module
) ) {
1968 mw
.loader
.register( module
);
1970 if ( $.inArray( state
, [ 'ready', 'error', 'missing' ] ) !== -1
1971 && registry
[ module
].state
!== state
) {
1972 // Make sure pending modules depending on this one get executed if their
1973 // dependencies are now fulfilled!
1974 registry
[ module
].state
= state
;
1975 handlePending( module
);
1977 registry
[ module
].state
= state
;
1982 * Get the version of a module.
1984 * @param {string} module Name of module
1985 * @return {string|null} The version, or null if the module (or its version) is not
1988 getVersion: function ( module
) {
1989 if ( !hasOwn
.call( registry
, module
) || registry
[ module
].version
=== undefined ) {
1992 return registry
[ module
].version
;
1996 * Get the state of a module.
1998 * @param {string} module Name of module
1999 * @return {string|null} The state, or null if the module (or its state) is not
2002 getState: function ( module
) {
2003 if ( !hasOwn
.call( registry
, module
) || registry
[ module
].state
=== undefined ) {
2006 return registry
[ module
].state
;
2010 * Get the names of all registered modules.
2014 getModuleNames: function () {
2015 return $.map( registry
, function ( i
, key
) {
2021 * @inheritdoc mw.inspect#runReports
2024 inspect: function () {
2025 var args
= slice
.call( arguments
);
2026 mw
.loader
.using( 'mediawiki.inspect', function () {
2027 mw
.inspect
.runReports
.apply( mw
.inspect
, args
);
2032 * On browsers that implement the localStorage API, the module store serves as a
2033 * smart complement to the browser cache. Unlike the browser cache, the module store
2034 * can slice a concatenated response from ResourceLoader into its constituent
2035 * modules and cache each of them separately, using each module's versioning scheme
2036 * to determine when the cache should be invalidated.
2039 * @class mw.loader.store
2042 // Whether the store is in use on this page.
2045 // Modules whose string representation exceeds 100 kB are ineligible
2046 // for storage due to bug T66721.
2047 MODULE_SIZE_MAX
: 100000,
2049 // The contents of the store, mapping '[module name]@[version]' keys
2050 // to module implementations.
2054 stats
: { hits
: 0, misses
: 0, expired
: 0 },
2057 * Construct a JSON-serializable object representing the content of the store.
2059 * @return {Object} Module store contents.
2061 toJSON: function () {
2062 return { items
: mw
.loader
.store
.items
, vary
: mw
.loader
.store
.getVary() };
2066 * Get the localStorage key for the entire module store. The key references
2067 * $wgDBname to prevent clashes between wikis which share a common host.
2069 * @return {string} localStorage item key
2071 getStoreKey: function () {
2072 return 'MediaWikiModuleStore:' + mw
.config
.get( 'wgDBname' );
2076 * Get a key on which to vary the module cache.
2078 * @return {string} String of concatenated vary conditions.
2080 getVary: function () {
2082 mw
.config
.get( 'skin' ),
2083 mw
.config
.get( 'wgResourceLoaderStorageVersion' ),
2084 mw
.config
.get( 'wgUserLanguage' )
2089 * Get a key for a specific module. The key format is '[name]@[version]'.
2091 * @param {string} module Module name
2092 * @return {string|null} Module key or null if module does not exist
2094 getModuleKey: function ( module
) {
2095 return hasOwn
.call( registry
, module
) ?
2096 ( module
+ '@' + registry
[ module
].version
) : null;
2100 * Initialize the store.
2102 * Retrieves store from localStorage and (if successfully retrieved) decoding
2103 * the stored JSON value to a plain object.
2105 * The try / catch block is used for JSON & localStorage feature detection.
2106 * See the in-line documentation for Modernizr's localStorage feature detection
2107 * code for a full account of why we need a try / catch:
2108 * <https://github.com/Modernizr/Modernizr/blob/v2.7.1/modernizr.js#L771-L796>.
2113 if ( mw
.loader
.store
.enabled
!== null ) {
2118 if ( !mw
.config
.get( 'wgResourceLoaderStorageEnabled' ) ) {
2119 // Disabled by configuration.
2120 // Clear any previous store to free up space. (T66721)
2121 mw
.loader
.store
.clear();
2122 mw
.loader
.store
.enabled
= false;
2125 if ( mw
.config
.get( 'debug' ) ) {
2126 // Disable module store in debug mode
2127 mw
.loader
.store
.enabled
= false;
2132 raw
= localStorage
.getItem( mw
.loader
.store
.getStoreKey() );
2133 // If we get here, localStorage is available; mark enabled
2134 mw
.loader
.store
.enabled
= true;
2135 data
= JSON
.parse( raw
);
2136 if ( data
&& typeof data
.items
=== 'object' && data
.vary
=== mw
.loader
.store
.getVary() ) {
2137 mw
.loader
.store
.items
= data
.items
;
2141 mw
.track( 'resourceloader.exception', { exception
: e
, source
: 'store-localstorage-init' } );
2144 if ( raw
=== undefined ) {
2145 // localStorage failed; disable store
2146 mw
.loader
.store
.enabled
= false;
2148 mw
.loader
.store
.update();
2153 * Retrieve a module from the store and update cache hit stats.
2155 * @param {string} module Module name
2156 * @return {string|boolean} Module implementation or false if unavailable
2158 get: function ( module
) {
2161 if ( !mw
.loader
.store
.enabled
) {
2165 key
= mw
.loader
.store
.getModuleKey( module
);
2166 if ( key
in mw
.loader
.store
.items
) {
2167 mw
.loader
.store
.stats
.hits
++;
2168 return mw
.loader
.store
.items
[ key
];
2170 mw
.loader
.store
.stats
.misses
++;
2175 * Stringify a module and queue it for storage.
2177 * @param {string} module Module name
2178 * @param {Object} descriptor The module's descriptor as set in the registry
2180 set: function ( module
, descriptor
) {
2183 if ( !mw
.loader
.store
.enabled
) {
2187 key
= mw
.loader
.store
.getModuleKey( module
);
2190 // Already stored a copy of this exact version
2191 key
in mw
.loader
.store
.items
||
2192 // Module failed to load
2193 descriptor
.state
!== 'ready' ||
2194 // Unversioned, private, or site-/user-specific
2195 ( !descriptor
.version
|| $.inArray( descriptor
.group
, [ 'private', 'user' ] ) !== -1 ) ||
2196 // Partial descriptor
2197 $.inArray( undefined, [ descriptor
.script
, descriptor
.style
,
2198 descriptor
.messages
, descriptor
.templates
] ) !== -1
2206 JSON
.stringify( module
),
2207 typeof descriptor
.script
=== 'function' ?
2208 String( descriptor
.script
) :
2209 JSON
.stringify( descriptor
.script
),
2210 JSON
.stringify( descriptor
.style
),
2211 JSON
.stringify( descriptor
.messages
),
2212 JSON
.stringify( descriptor
.templates
)
2214 // Attempted workaround for a possible Opera bug (bug T59567).
2215 // This regex should never match under sane conditions.
2216 if ( /^\s*\(/.test( args
[ 1 ] ) ) {
2217 args
[ 1 ] = 'function' + args
[ 1 ];
2218 mw
.track( 'resourceloader.assert', { source
: 'bug-T59567' } );
2221 mw
.track( 'resourceloader.exception', { exception
: e
, source
: 'store-localstorage-json' } );
2225 src
= 'mw.loader.implement(' + args
.join( ',' ) + ');';
2226 if ( src
.length
> mw
.loader
.store
.MODULE_SIZE_MAX
) {
2229 mw
.loader
.store
.items
[ key
] = src
;
2230 mw
.loader
.store
.update();
2234 * Iterate through the module store, removing any item that does not correspond
2235 * (in name and version) to an item in the module registry.
2237 prune: function () {
2240 if ( !mw
.loader
.store
.enabled
) {
2244 for ( key
in mw
.loader
.store
.items
) {
2245 module
= key
.slice( 0, key
.indexOf( '@' ) );
2246 if ( mw
.loader
.store
.getModuleKey( module
) !== key
) {
2247 mw
.loader
.store
.stats
.expired
++;
2248 delete mw
.loader
.store
.items
[ key
];
2249 } else if ( mw
.loader
.store
.items
[ key
].length
> mw
.loader
.store
.MODULE_SIZE_MAX
) {
2250 // This value predates the enforcement of a size limit on cached modules.
2251 delete mw
.loader
.store
.items
[ key
];
2257 * Clear the entire module store right now.
2259 clear: function () {
2260 mw
.loader
.store
.items
= {};
2261 localStorage
.removeItem( mw
.loader
.store
.getStoreKey() );
2265 * Sync modules to localStorage.
2267 * This function debounces localStorage updates. When called multiple times in
2268 * quick succession, the calls are coalesced into a single update operation.
2269 * This allows us to call #update without having to consider the module load
2270 * queue; the call to localStorage.setItem will be naturally deferred until the
2271 * page is quiescent.
2273 * Because localStorage is shared by all pages with the same origin, if multiple
2274 * pages are loaded with different module sets, the possibility exists that
2275 * modules saved by one page will be clobbered by another. But the impact would
2276 * be minor and the problem would be corrected by subsequent page views.
2280 update
: ( function () {
2285 key
= mw
.loader
.store
.getStoreKey();
2287 if ( !mw
.loader
.store
.enabled
) {
2290 mw
.loader
.store
.prune();
2292 // Replacing the content of the module store might fail if the new
2293 // contents would exceed the browser's localStorage size limit. To
2294 // avoid clogging the browser with stale data, always remove the old
2295 // value before attempting to set the new one.
2296 localStorage
.removeItem( key
);
2297 data
= JSON
.stringify( mw
.loader
.store
);
2298 localStorage
.setItem( key
, data
);
2300 mw
.track( 'resourceloader.exception', { exception
: e
, source
: 'store-localstorage-update' } );
2304 return function () {
2305 clearTimeout( timer
);
2306 timer
= setTimeout( flush
, 2000 );
2314 * HTML construction helper functions
2321 * output = Html.element( 'div', {}, new Html.Raw(
2322 * Html.element( 'img', { src: '<' } )
2324 * mw.log( output ); // <div><img src="<"/></div>
2329 html
: ( function () {
2330 function escapeCallback( s
) {
2347 * Escape a string for HTML.
2349 * Converts special characters to HTML entities.
2351 * mw.html.escape( '< > \' & "' );
2352 * // Returns < > ' & "
2354 * @param {string} s The string to escape
2355 * @return {string} HTML
2357 escape: function ( s
) {
2358 return s
.replace( /['"<>&]/g, escapeCallback
);
2362 * Create an HTML element string, with safe escaping.
2364 * @param {string} name The tag name.
2365 * @param {Object} attrs An object with members mapping element names to values
2366 * @param {Mixed} contents The contents of the element. May be either:
2368 * - string: The string is escaped.
2369 * - null or undefined: The short closing form is used, e.g. `<br/>`.
2370 * - this.Raw: The value attribute is included without escaping.
2371 * - this.Cdata: The value attribute is included, and an exception is
2372 * thrown if it contains an illegal ETAGO delimiter.
2373 * See <http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.3.2>.
2374 * @return {string} HTML
2376 element: function ( name
, attrs
, contents
) {
2377 var v
, attrName
, s
= '<' + name
;
2379 for ( attrName
in attrs
) {
2380 v
= attrs
[ attrName
];
2381 // Convert name=true, to name=name
2385 } else if ( v
=== false ) {
2388 s
+= ' ' + attrName
+ '="' + this.escape( String( v
) ) + '"';
2390 if ( contents
=== undefined || contents
=== null ) {
2397 switch ( typeof contents
) {
2400 s
+= this.escape( contents
);
2404 // Convert to string
2405 s
+= String( contents
);
2408 if ( contents
instanceof this.Raw
) {
2409 // Raw HTML inclusion
2410 s
+= contents
.value
;
2411 } else if ( contents
instanceof this.Cdata
) {
2413 if ( /<\/[a-zA-z]/.test( contents
.value
) ) {
2414 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
2416 s
+= contents
.value
;
2418 throw new Error( 'mw.html.element: Invalid type of contents' );
2421 s
+= '</' + name
+ '>';
2426 * Wrapper object for raw HTML passed to mw.html.element().
2428 * @class mw.html.Raw
2430 Raw: function ( value
) {
2435 * Wrapper object for CDATA element contents passed to mw.html.element()
2437 * @class mw.html.Cdata
2439 Cdata: function ( value
) {
2445 // Skeleton user object. mediawiki.user.js extends this
2452 * Registry and firing of events.
2454 * MediaWiki has various interface components that are extended, enhanced
2455 * or manipulated in some other way by extensions, gadgets and even
2458 * This framework helps streamlining the timing of when these other
2459 * code paths fire their plugins (instead of using document-ready,
2460 * which can and should be limited to firing only once).
2462 * Features like navigating to other wiki pages, previewing an edit
2463 * and editing itself – without a refresh – can then retrigger these
2464 * hooks accordingly to ensure everything still works as expected.
2468 * mw.hook( 'wikipage.content' ).add( fn ).remove( fn );
2469 * mw.hook( 'wikipage.content' ).fire( $content );
2471 * Handlers can be added and fired for arbitrary event names at any time. The same
2472 * event can be fired multiple times. The last run of an event is memorized
2473 * (similar to `$(document).ready` and `$.Deferred().done`).
2474 * This means if an event is fired, and a handler added afterwards, the added
2475 * function will be fired right away with the last given event data.
2477 * Like Deferreds and Promises, the mw.hook object is both detachable and chainable.
2478 * Thus allowing flexible use and optimal maintainability and authority control.
2479 * You can pass around the `add` and/or `fire` method to another piece of code
2480 * without it having to know the event name (or `mw.hook` for that matter).
2482 * var h = mw.hook( 'bar.ready' );
2483 * new mw.Foo( .. ).fetch( { callback: h.fire } );
2485 * Note: Events are documented with an underscore instead of a dot in the event
2486 * name due to jsduck not supporting dots in that position.
2490 hook
: ( function () {
2494 * Create an instance of mw.hook.
2498 * @param {string} name Name of hook.
2501 return function ( name
) {
2502 var list
= hasOwn
.call( lists
, name
) ?
2504 lists
[ name
] = $.Callbacks( 'memory' );
2508 * Register a hook handler
2510 * @param {Function...} handler Function to bind.
2516 * Unregister a hook handler
2518 * @param {Function...} handler Function to unbind.
2521 remove
: list
.remove
,
2526 * @param {Mixed...} data
2530 return list
.fireWith
.call( this, null, slice
.call( arguments
) );
2537 // Alias $j to jQuery for backwards compatibility
2538 // @deprecated since 1.23 Use $ or jQuery instead
2539 mw
.log
.deprecate( window
, '$j', $, 'Use $ or jQuery instead.' );
2542 * Log a message to window.console, if possible.
2544 * Useful to force logging of some errors that are otherwise hard to detect (i.e., this logs
2545 * also in production mode). Gets console references in each invocation instead of caching the
2546 * reference, so that debugging tools loaded later are supported (e.g. Firebug Lite in IE).
2550 * @param {string} topic Stream name passed by mw.track
2551 * @param {Object} data Data passed by mw.track
2552 * @param {Error} [data.exception]
2553 * @param {string} data.source Error source
2554 * @param {string} [data.module] Name of module which caused the error
2556 function log( topic
, data
) {
2559 source
= data
.source
,
2560 module
= data
.module
,
2561 console
= window
.console
;
2563 if ( console
&& console
.log
) {
2564 msg
= ( e
? 'Exception' : 'Error' ) + ' in ' + source
;
2566 msg
+= ' in module ' + module
;
2568 msg
+= ( e
? ':' : '.' );
2571 // If we have an exception object, log it to the error channel to trigger a
2572 // proper stacktraces in browsers that support it. No fallback as we have no browsers
2573 // that don't support error(), but do support log().
2574 if ( e
&& console
.error
) {
2575 console
.error( String( e
), e
);
2580 // Subscribe to error streams
2581 mw
.trackSubscribe( 'resourceloader.exception', log
);
2582 mw
.trackSubscribe( 'resourceloader.assert', log
);
2585 * Fired when all modules associated with the page have finished loading.
2587 * @event resourceloader_loadEnd
2591 var loading
= $.grep( mw
.loader
.getModuleNames(), function ( module
) {
2592 return mw
.loader
.getState( module
) === 'loading';
2594 // In order to use jQuery.when (which stops early if one of the promises got rejected)
2595 // cast any loading failures into successes. We only need a callback, not the module.
2596 loading
= $.map( loading
, function ( module
) {
2597 return mw
.loader
.using( module
).then( null, function () {
2598 return $.Deferred().resolve();
2601 $.when
.apply( $, loading
).then( function () {
2602 performance
.mark( 'mwLoadEnd' );
2603 mw
.hook( 'resourceloader.loadEnd' ).fire();
2607 // Attach to window and globally alias
2608 window
.mw
= window
.mediaWiki
= mw
;