2 * Base library for MediaWiki.
4 * Exposed globally as `mediaWiki` with `mw` as shortcut.
7 * @alternateClassName mediaWiki
12 /* eslint-disable no-use-before-define */
17 var mw
, StringSet
, log
,
18 hasOwn
= Object
.prototype.hasOwnProperty
,
19 slice
= Array
.prototype.slice
,
20 trackCallbacks
= $.Callbacks( 'memory' ),
25 * FNV132 hash function
27 * This function implements the 32-bit version of FNV-1.
28 * It is equivalent to hash( 'fnv132', ... ) in PHP, except
29 * its output is base 36 rather than hex.
30 * See <https://en.wikipedia.org/wiki/FNV_hash_function>
33 * @param {string} str String to hash
34 * @return {string} hash as an seven-character base 36 string
36 function fnv132( str
) {
37 /* eslint-disable no-bitwise */
38 var hash
= 0x811C9DC5,
41 for ( i
= 0; i
< str
.length
; i
++ ) {
42 hash
+= ( hash
<< 1 ) + ( hash
<< 4 ) + ( hash
<< 7 ) + ( hash
<< 8 ) + ( hash
<< 24 );
43 hash
^= str
.charCodeAt( i
);
46 hash
= ( hash
>>> 0 ).toString( 36 );
47 while ( hash
.length
< 7 ) {
52 /* eslint-enable no-bitwise */
55 function defineFallbacks() {
56 // <https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Set>
57 StringSet
= window
.Set
|| ( function () {
62 function StringSet() {
65 StringSet
.prototype.add = function ( value
) {
66 this.set[ value
] = true;
68 StringSet
.prototype.has = function ( value
) {
69 return hasOwn
.call( this.set, value
);
76 * Create an object that can be read from or written to via methods that allow
77 * interaction both with single and multiple properties at once.
83 * @param {boolean} [global=false] Whether to synchronise =values to the global
84 * window object (for backwards-compatibility with mw.config; T72470). Values are
85 * copied in one direction only. Changes to globals do not reflect in the map.
87 function Map( global
) {
89 if ( global
=== true ) {
90 // Override #set to also set the global variable
91 this.set = function ( selection
, value
) {
94 if ( $.isPlainObject( selection
) ) {
95 for ( s
in selection
) {
96 setGlobalMapValue( this, s
, selection
[ s
] );
100 if ( typeof selection
=== 'string' && arguments
.length
) {
101 setGlobalMapValue( this, selection
, value
);
110 * Alias property to the global object.
114 * @param {mw.Map} map
115 * @param {string} key
116 * @param {Mixed} value
118 function setGlobalMapValue( map
, key
, value
) {
119 map
.values
[ key
] = value
;
124 // Deprecation notice for mw.config globals (T58550, T72470)
125 map
=== mw
.config
&& 'Use mw.config instead.'
133 * Get the value of one or more keys.
135 * If called with no arguments, all values are returned.
137 * @param {string|Array} [selection] Key or array of keys to retrieve values for.
138 * @param {Mixed} [fallback=null] Value for keys that don't exist.
139 * @return {Mixed|Object|null} If selection was a string, returns the value,
140 * If selection was an array, returns an object of key/values.
141 * If no selection is passed, a new object with all key/values is returned.
143 get: function ( selection
, fallback
) {
145 fallback
= arguments
.length
> 1 ? fallback
: null;
147 if ( Array
.isArray( selection
) ) {
149 for ( i
= 0; i
< selection
.length
; i
++ ) {
150 if ( typeof selection
[ i
] === 'string' ) {
151 results
[ selection
[ i
] ] = hasOwn
.call( this.values
, selection
[ i
] ) ?
152 this.values
[ selection
[ i
] ] :
159 if ( typeof selection
=== 'string' ) {
160 return hasOwn
.call( this.values
, selection
) ?
161 this.values
[ selection
] :
165 if ( selection
=== undefined ) {
167 for ( i
in this.values
) {
168 results
[ i
] = this.values
[ i
];
173 // Invalid selection key
178 * Set one or more key/value pairs.
180 * @param {string|Object} selection Key to set value for, or object mapping keys to values
181 * @param {Mixed} [value] Value to set (optional, only in use when key is a string)
182 * @return {boolean} True on success, false on failure
184 set: function ( selection
, value
) {
187 if ( $.isPlainObject( selection
) ) {
188 for ( s
in selection
) {
189 this.values
[ s
] = selection
[ s
];
193 if ( typeof selection
=== 'string' && arguments
.length
> 1 ) {
194 this.values
[ selection
] = value
;
201 * Check if one or more keys exist.
203 * @param {Mixed} selection Key or array of keys to check
204 * @return {boolean} True if the key(s) exist
206 exists: function ( selection
) {
208 if ( Array
.isArray( selection
) ) {
209 for ( i
= 0; i
< selection
.length
; i
++ ) {
210 if ( typeof selection
[ i
] !== 'string' || !hasOwn
.call( this.values
, selection
[ i
] ) ) {
216 return typeof selection
=== 'string' && hasOwn
.call( this.values
, selection
);
221 * Object constructor for messages.
223 * Similar to the Message class in MediaWiki PHP.
225 * Format defaults to 'text'.
231 * 'hello': 'Hello world',
232 * 'hello-user': 'Hello, $1!',
233 * 'welcome-user': 'Welcome back to $2, $1! Last visit by $1: $3'
236 * obj = new mw.Message( mw.messages, 'hello' );
237 * mw.log( obj.text() );
240 * obj = new mw.Message( mw.messages, 'hello-user', [ 'John Doe' ] );
241 * mw.log( obj.text() );
242 * // Hello, John Doe!
244 * obj = new mw.Message( mw.messages, 'welcome-user', [ 'John Doe', 'Wikipedia', '2 hours ago' ] );
245 * mw.log( obj.text() );
246 * // Welcome back to Wikipedia, John Doe! Last visit by John Doe: 2 hours ago
248 * // Using mw.message shortcut
249 * obj = mw.message( 'hello-user', 'John Doe' );
250 * mw.log( obj.text() );
251 * // Hello, John Doe!
253 * // Using mw.msg shortcut
254 * str = mw.msg( 'hello-user', 'John Doe' );
256 * // Hello, John Doe!
258 * // Different formats
259 * obj = new mw.Message( mw.messages, 'hello-user', [ 'John "Wiki" <3 Doe' ] );
261 * obj.format = 'text';
262 * str = obj.toString();
267 * // Hello, John "Wiki" <3 Doe!
269 * mw.log( obj.escaped() );
270 * // Hello, John "Wiki" <3 Doe!
275 * @param {mw.Map} map Message store
276 * @param {string} key
277 * @param {Array} [parameters]
279 function Message( map
, key
, parameters
) {
280 this.format
= 'text';
283 this.parameters
= parameters
=== undefined ? [] : slice
.call( parameters
);
287 Message
.prototype = {
289 * Get parsed contents of the message.
291 * The default parser does simple $N replacements and nothing else.
292 * This may be overridden to provide a more complex message parser.
293 * The primary override is in the mediawiki.jqueryMsg module.
295 * This function will not be called for nonexistent messages.
297 * @return {string} Parsed message
299 parser: function () {
300 return mw
.format
.apply( null, [ this.map
.get( this.key
) ].concat( this.parameters
) );
303 // eslint-disable-next-line valid-jsdoc
305 * Add (does not replace) parameters for `$N` placeholder values.
307 * @param {Array} parameters
310 params: function ( parameters
) {
312 for ( i
= 0; i
< parameters
.length
; i
++ ) {
313 this.parameters
.push( parameters
[ i
] );
319 * Convert message object to its string form based on current format.
321 * @return {string} Message as a string in the current form, or `<key>` if key
324 toString: function () {
327 if ( !this.exists() ) {
328 // Use ⧼key⧽ as text if key does not exist
329 // Err on the side of safety, ensure that the output
330 // is always html safe in the event the message key is
331 // missing, since in that case its highly likely the
332 // message key is user-controlled.
333 // '⧼' is used instead of '<' to side-step any
334 // double-escaping issues.
335 // (Keep synchronised with Message::toString() in PHP.)
336 return '⧼' + mw
.html
.escape( this.key
) + '⧽';
339 if ( this.format
=== 'plain' || this.format
=== 'text' || this.format
=== 'parse' ) {
340 text
= this.parser();
343 if ( this.format
=== 'escaped' ) {
344 text
= this.parser();
345 text
= mw
.html
.escape( text
);
352 * Change format to 'parse' and convert message to string
354 * If jqueryMsg is loaded, this parses the message text from wikitext
355 * (where supported) to HTML
357 * Otherwise, it is equivalent to plain.
359 * @return {string} String form of parsed message
362 this.format
= 'parse';
363 return this.toString();
367 * Change format to 'plain' and convert message to string
369 * This substitutes parameters, but otherwise does not change the
372 * @return {string} String form of plain message
375 this.format
= 'plain';
376 return this.toString();
380 * Change format to 'text' and convert message to string
382 * If jqueryMsg is loaded, {{-transformation is done where supported
383 * (such as {{plural:}}, {{gender:}}, {{int:}}).
385 * Otherwise, it is equivalent to plain
387 * @return {string} String form of text message
390 this.format
= 'text';
391 return this.toString();
395 * Change the format to 'escaped' and convert message to string
397 * This is equivalent to using the 'text' format (see #text), then
398 * HTML-escaping the output.
400 * @return {string} String form of html escaped message
402 escaped: function () {
403 this.format
= 'escaped';
404 return this.toString();
408 * Check if a message exists
413 exists: function () {
414 return this.map
.exists( this.key
);
420 /* eslint-disable no-console */
421 log
= ( function () {
423 * Write a verbose message to the browser's console in debug mode.
425 * This method is mainly intended for verbose logging. It is a no-op in production mode.
426 * In ResourceLoader debug mode, it will use the browser's console if available, with
427 * fallback to creating a console interface in the DOM and logging messages there.
429 * See {@link mw.log} for other logging methods.
432 * @param {...string} msg Messages to output to console.
434 var log = function () {},
435 console
= window
.console
;
437 // Note: Keep list of methods in sync with restoration in mediawiki.log.js
438 // when adding or removing mw.log methods below!
441 * Collection of methods to help log messages to the console.
448 * Write a message to the browser console's warning channel.
450 * This method is a no-op in browsers that don't implement the Console API.
452 * @param {...string} msg Messages to output to console
454 log
.warn
= console
&& console
.warn
&& Function
.prototype.bind
?
455 Function
.prototype.bind
.call( console
.warn
, console
) :
459 * Write a message to the browser console's error channel.
461 * Most browsers also print a stacktrace when calling this method if the
462 * argument is an Error object.
464 * This method is a no-op in browsers that don't implement the Console API.
467 * @param {Error|...string} msg Messages to output to console
469 log
.error
= console
&& console
.error
&& Function
.prototype.bind
?
470 Function
.prototype.bind
.call( console
.error
, console
) :
474 * Create a property on a host object that, when accessed, will produce
475 * a deprecation warning in the console.
477 * @param {Object} obj Host object of deprecated property
478 * @param {string} key Name of property to create in `obj`
479 * @param {Mixed} val The value this property should return when accessed
480 * @param {string} [msg] Optional text to include in the deprecation message
481 * @param {string} [logName=key] Optional custom name for the feature.
482 * This is used instead of `key` in the message and `mw.deprecate` tracking.
484 log
.deprecate
= !Object
.defineProperty
? function ( obj
, key
, val
) {
486 } : function ( obj
, key
, val
, msg
, logName
) {
487 var logged
= new StringSet();
488 logName
= logName
|| key
;
489 msg
= 'Use of "' + logName
+ '" is deprecated.' + ( msg
? ( ' ' + msg
) : '' );
490 function uniqueTrace() {
491 var trace
= new Error().stack
;
492 if ( logged
.has( trace
) ) {
498 // Support: Safari 5.0
499 // Throws "not supported on DOM Objects" for Node or Element objects (incl. document)
500 // Safari 4.0 doesn't have this method, and it was fixed in Safari 5.1.
502 Object
.defineProperty( obj
, key
, {
506 if ( uniqueTrace() ) {
507 mw
.track( 'mw.deprecate', logName
);
512 set: function ( newVal
) {
513 if ( uniqueTrace() ) {
514 mw
.track( 'mw.deprecate', logName
);
527 /* eslint-enable no-console */
533 redefineFallbacksForTest: function () {
534 if ( !window
.QUnit
) {
535 throw new Error( 'Reset not allowed outside unit tests' );
541 * Get the current time, measured in milliseconds since January 1, 1970 (UTC).
543 * On browsers that implement the Navigation Timing API, this function will produce floating-point
544 * values with microsecond precision that are guaranteed to be monotonic. On all other browsers,
545 * it will fall back to using `Date`.
547 * @return {number} Current time
550 // mwNow is defined in startup.js
553 * Format a string. Replace $1, $2 ... $N with positional arguments.
555 * Used by Message#parser().
558 * @param {string} formatString Format string
559 * @param {...Mixed} parameters Values for $N replacements
560 * @return {string} Formatted string
562 format: function ( formatString
) {
563 var parameters
= slice
.call( arguments
, 1 );
564 return formatString
.replace( /\$(\d+)/g, function ( str
, match
) {
565 var index
= parseInt( match
, 10 ) - 1;
566 return parameters
[ index
] !== undefined ? parameters
[ index
] : '$' + match
;
571 * Track an analytic event.
573 * This method provides a generic means for MediaWiki JavaScript code to capture state
574 * information for analysis. Each logged event specifies a string topic name that describes
575 * the kind of event that it is. Topic names consist of dot-separated path components,
576 * arranged from most general to most specific. Each path component should have a clear and
577 * well-defined purpose.
579 * Data handlers are registered via `mw.trackSubscribe`, and receive the full set of
580 * events that match their subcription, including those that fired before the handler was
583 * @param {string} topic Topic name
584 * @param {Object} [data] Data describing the event, encoded as an object
586 track: function ( topic
, data
) {
587 trackQueue
.push( { topic
: topic
, timeStamp
: mw
.now(), data
: data
} );
588 trackCallbacks
.fire( trackQueue
);
592 * Register a handler for subset of analytic events, specified by topic.
594 * Handlers will be called once for each tracked event, including any events that fired before the
595 * handler was registered; 'this' is set to a plain object with a 'timeStamp' property indicating
596 * the exact time at which the event fired, a string 'topic' property naming the event, and a
597 * 'data' property which is an object of event-specific data. The event topic and event data are
598 * also passed to the callback as the first and second arguments, respectively.
600 * @param {string} topic Handle events whose name starts with this string prefix
601 * @param {Function} callback Handler to call for each matching tracked event
602 * @param {string} callback.topic
603 * @param {Object} [callback.data]
605 trackSubscribe: function ( topic
, callback
) {
607 function handler( trackQueue
) {
609 for ( ; seen
< trackQueue
.length
; seen
++ ) {
610 event
= trackQueue
[ seen
];
611 if ( event
.topic
.indexOf( topic
) === 0 ) {
612 callback
.call( event
, event
.topic
, event
.data
);
617 trackHandlers
.push( [ handler
, callback
] );
619 trackCallbacks
.add( handler
);
623 * Stop handling events for a particular handler
625 * @param {Function} callback
627 trackUnsubscribe: function ( callback
) {
628 trackHandlers
= trackHandlers
.filter( function ( fns
) {
629 if ( fns
[ 1 ] === callback
) {
630 trackCallbacks
.remove( fns
[ 0 ] );
631 // Ensure the tuple is removed to avoid holding on to closures
638 // Expose Map constructor
641 // Expose Message constructor
645 * Map of configuration values.
647 * Check out [the complete list of configuration values](https://www.mediawiki.org/wiki/Manual:Interface/JavaScript#mw.config)
650 * If `$wgLegacyJavaScriptGlobals` is true, this Map will add its values to the
651 * global `window` object.
653 * @property {mw.Map} config
655 // Dummy placeholder later assigned in ResourceLoaderStartUpModule
659 * Empty object for third-party libraries, for cases where you don't
660 * want to add a new global, or the global is bad and needs containment
668 * Access container for deprecated functionality that can be moved from
669 * from their legacy location and attached to this object (e.g. a global
670 * function that is deprecated and as stop-gap can be exposed through here).
672 * This was reserved for future use but never ended up being used.
674 * @deprecated since 1.22 Let deprecated identifiers keep their original name
675 * and use mw.log#deprecate to create an access container for tracking.
681 * Store for messages.
688 * Store for templates associated with a module.
692 templates
: new Map(),
695 * Get a message object.
697 * Shortcut for `new mw.Message( mw.messages, key, parameters )`.
700 * @param {string} key Key of message to get
701 * @param {...Mixed} parameters Values for $N replacements
702 * @return {mw.Message}
704 message: function ( key
) {
705 var parameters
= slice
.call( arguments
, 1 );
706 return new Message( mw
.messages
, key
, parameters
);
710 * Get a message string using the (default) 'text' format.
712 * Shortcut for `mw.message( key, parameters... ).text()`.
715 * @param {string} key Key of message to get
716 * @param {...Mixed} parameters Values for $N replacements
720 return mw
.message
.apply( mw
.message
, arguments
).toString();
727 * Client for ResourceLoader server end point.
729 * This client is in charge of maintaining the module registry and state
730 * machine, initiating network (batch) requests for loading modules, as
731 * well as dependency resolution and execution of source code.
733 * For more information, refer to
734 * <https://www.mediawiki.org/wiki/ResourceLoader/Features>
739 loader
: ( function () {
742 * Fired via mw.track on various resource loading errors.
744 * @event resourceloader_exception
745 * @param {Error|Mixed} e The error that was thrown. Almost always an Error
746 * object, but in theory module code could manually throw something else, and that
747 * might also end up here.
748 * @param {string} [module] Name of the module which caused the error. Omitted if the
749 * error is not module-related or the module cannot be easily identified due to
751 * @param {string} source Source of the error. Possible values:
753 * - style: stylesheet error (only affects old IE where a special style loading method
755 * - load-callback: exception thrown by user callback
756 * - module-execute: exception thrown by module code
757 * - resolve: failed to sort dependencies for a module in mw.loader.load
758 * - store-eval: could not evaluate module code cached in localStorage
759 * - store-localstorage-init: localStorage or JSON parse error in mw.loader.store.init
760 * - store-localstorage-json: JSON conversion error in mw.loader.store.set
761 * - store-localstorage-update: localStorage or JSON conversion error in mw.loader.store.update
765 * Fired via mw.track on resource loading error conditions.
767 * @event resourceloader_assert
768 * @param {string} source Source of the error. Possible values:
770 * - bug-T59567: failed to cache script due to an Opera function -> string conversion
771 * bug; see <https://phabricator.wikimedia.org/T59567> for details
775 * Mapping of registered modules.
777 * See #implement and #execute for exact details on support for script, style and messages.
783 * // From mw.loader.register()
784 * 'version': '########' (hash)
785 * 'dependencies': ['required.foo', 'bar.also', ...], (or) function () {}
786 * 'group': 'somegroup', (or) null
787 * 'source': 'local', (or) 'anotherwiki'
788 * 'skip': 'return !!window.Example', (or) null
789 * 'module': export Object
791 * // Set from execute() or mw.loader.state()
792 * 'state': 'registered', 'loaded', 'loading', 'ready', 'error', or 'missing'
794 * // Optionally added at run-time by mw.loader.implement()
796 * 'script': closure, array of urls, or string
797 * 'style': { ... } (see #execute)
798 * 'messages': { 'key': 'value', ... }
805 * The module is known to the system but not yet required.
806 * Meta data is registered via mw.loader#register. Calls to that method are
807 * generated server-side by the startup module.
809 * The module was required through mw.loader (either directly or as dependency of
810 * another module). The client will fetch module contents from the server.
811 * The contents are then stashed in the registry via mw.loader#implement.
813 * The module has been loaded from the server and stashed via mw.loader#implement.
814 * If the module has no more dependencies in-flight, the module will be executed
815 * immediately. Otherwise execution is deferred, controlled via #handlePending.
817 * The module is being executed.
819 * The module has been successfully executed.
821 * The module (or one of its dependencies) produced an error during execution.
823 * The module was registered client-side and requested, but the server denied knowledge
824 * of the module's existence.
830 // Mapping of sources, keyed by source-id, values are strings.
835 // 'sourceId': 'http://example.org/w/load.php'
840 // For queueModuleScript()
841 handlingPendingRequests
= false,
842 pendingRequests
= [],
844 // List of modules to be loaded
848 * List of callback jobs waiting for modules to be ready.
850 * Jobs are created by #enqueue() and run by #handlePending().
852 * Typically when a job is created for a module, the job's dependencies contain
853 * both the required module and all its recursive dependencies.
858 * 'dependencies': [ module names ],
859 * 'ready': Function callback
860 * 'error': Function callback
863 * @property {Object[]} jobs
871 // For addEmbeddedCSS()
873 cssBufferTimer
= null,
874 cssCallbacks
= $.Callbacks(),
875 rAF
= window
.requestAnimationFrame
|| setTimeout
;
877 function getMarker() {
880 marker
= document
.querySelector( 'meta[name="ResourceLoaderDynamicStyles"]' );
882 mw
.log( 'Created ResourceLoaderDynamicStyles marker dynamically' );
883 marker
= document
.createElement( 'meta' );
884 marker
.name
= 'ResourceLoaderDynamicStyles';
885 document
.head
.appendChild( marker
);
892 * Create a new style element and add it to the DOM.
895 * @param {string} text CSS text
896 * @param {Node} [nextNode] The element where the style tag
897 * should be inserted before
898 * @return {HTMLElement} Reference to the created style element
900 function newStyleTag( text
, nextNode
) {
901 var s
= document
.createElement( 'style' );
903 s
.appendChild( document
.createTextNode( text
) );
904 if ( nextNode
&& nextNode
.parentNode
) {
905 nextNode
.parentNode
.insertBefore( s
, nextNode
);
907 document
.head
.appendChild( s
);
914 * Add a bit of CSS text to the current browser page.
916 * The CSS will be appended to an existing ResourceLoader-created `<style>` tag
917 * or create a new one based on whether the given `cssText` is safe for extension.
920 * @param {string} [cssText=cssBuffer] If called without cssText,
921 * the internal buffer will be inserted instead.
922 * @param {Function} [callback]
924 function addEmbeddedCSS( cssText
, callback
) {
925 function fireCallbacks() {
926 var oldCallbacks
= cssCallbacks
;
927 // Reset cssCallbacks variable so it's not polluted by any calls to
928 // addEmbeddedCSS() from one of the callbacks (T105973)
929 cssCallbacks
= $.Callbacks();
930 oldCallbacks
.fire().empty();
934 cssCallbacks
.add( callback
);
937 // Yield once before creating the <style> tag. This lets multiple stylesheets
938 // accumulate into one buffer, allowing us to reduce how often new stylesheets
939 // are inserted in the browser. Appending a stylesheet and waiting for the
940 // browser to repaint is fairly expensive. (T47810)
942 // Don't extend the buffer if the item needs its own stylesheet.
943 // Keywords like `@import` are only valid at the start of a stylesheet (T37562).
944 if ( !cssBuffer
|| cssText
.slice( 0, '@import'.length
) !== '@import' ) {
945 // Linebreak for somewhat distinguishable sections
946 cssBuffer
+= '\n' + cssText
;
947 if ( !cssBufferTimer
) {
948 cssBufferTimer
= rAF( function () {
949 // Wrap in anonymous function that takes no arguments
950 // Support: Firefox < 13
951 // Firefox 12 has non-standard behaviour of passing a number
952 // as first argument to a setTimeout callback.
953 // http://benalman.com/news/2009/07/the-mysterious-firefox-settime/
960 // This is a scheduled flush for the buffer
962 cssBufferTimer
= null;
967 $( newStyleTag( cssText
, getMarker() ) );
974 * @param {Array} modules List of module names
975 * @return {string} Hash of concatenated version hashes.
977 function getCombinedVersion( modules
) {
978 var hashes
= modules
.map( function ( module
) {
979 return registry
[ module
].version
;
981 return fnv132( hashes
.join( '' ) );
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 all modules are in state 'ready', false otherwise
992 function allReady( modules
) {
994 for ( i
= 0; i
< modules
.length
; i
++ ) {
995 if ( mw
.loader
.getState( modules
[ i
] ) !== 'ready' ) {
1003 * Determine whether all dependencies are in state 'ready', which means we may
1004 * execute the module or job now.
1007 * @param {Array} modules Names of modules to be checked
1008 * @return {boolean} True if no modules are in state 'error' or 'missing', false otherwise
1010 function anyFailed( modules
) {
1012 for ( i
= 0; i
< modules
.length
; i
++ ) {
1013 state
= mw
.loader
.getState( modules
[ i
] );
1014 if ( state
=== 'error' || state
=== 'missing' ) {
1022 * A module has entered state 'ready', 'error', or 'missing'. Automatically update
1023 * pending jobs and modules that depend upon this module. If the given module failed,
1024 * propagate the 'error' state up the dependency tree. Otherwise, go ahead and execute
1025 * all jobs/modules now having their dependencies satisfied.
1027 * Jobs that depend on a failed module, will have their error callback ran (if any).
1030 * @param {string} module Name of module that entered one of the states 'ready', 'error', or 'missing'.
1032 function handlePending( module
) {
1033 var j
, job
, hasErrors
, m
, stateChange
;
1035 if ( registry
[ module
].state
=== 'error' || registry
[ module
].state
=== 'missing' ) {
1036 // If the current module failed, mark all dependent modules also as failed.
1037 // Iterate until steady-state to propagate the error state upwards in the
1040 stateChange
= false;
1041 for ( m
in registry
) {
1042 if ( registry
[ m
].state
!== 'error' && registry
[ m
].state
!== 'missing' ) {
1043 if ( anyFailed( registry
[ m
].dependencies
) ) {
1044 registry
[ m
].state
= 'error';
1049 } while ( stateChange
);
1052 // Execute all jobs whose dependencies are either all satisfied or contain at least one failed module.
1053 for ( j
= 0; j
< jobs
.length
; j
++ ) {
1054 hasErrors
= anyFailed( jobs
[ j
].dependencies
);
1055 if ( hasErrors
|| allReady( jobs
[ j
].dependencies
) ) {
1056 // All dependencies satisfied, or some have errors
1058 jobs
.splice( j
, 1 );
1062 if ( typeof job
.error
=== 'function' ) {
1063 job
.error( new Error( 'Module ' + module
+ ' has failed dependencies' ), [ module
] );
1066 if ( typeof job
.ready
=== 'function' ) {
1071 // A user-defined callback raised an exception.
1072 // Swallow it to protect our state machine!
1073 mw
.track( 'resourceloader.exception', { exception
: e
, module
: module
, source
: 'load-callback' } );
1078 if ( registry
[ module
].state
=== 'ready' ) {
1079 // The current module became 'ready'. Set it in the module store, and recursively execute all
1080 // dependent modules that are loaded and now have all dependencies satisfied.
1081 mw
.loader
.store
.set( module
, registry
[ module
] );
1082 for ( m
in registry
) {
1083 if ( registry
[ m
].state
=== 'loaded' && allReady( registry
[ m
].dependencies
) ) {
1091 * Resolve dependencies and detect circular references.
1094 * @param {string} module Name of the top-level module whose dependencies shall be
1095 * resolved and sorted.
1096 * @param {Array} resolved Returns a topological sort of the given module and its
1097 * dependencies, such that later modules depend on earlier modules. The array
1098 * contains the module names. If the array contains already some module names,
1099 * this function appends its result to the pre-existing array.
1100 * @param {StringSet} [unresolved] Used to track the current dependency
1101 * chain, and to report loops in the dependency graph.
1102 * @throws {Error} If any unregistered module or a dependency loop is encountered
1104 function sortDependencies( module
, resolved
, unresolved
) {
1107 if ( !hasOwn
.call( registry
, module
) ) {
1108 throw new Error( 'Unknown dependency: ' + module
);
1111 if ( registry
[ module
].skip
!== null ) {
1112 // eslint-disable-next-line no-new-func
1113 skip
= new Function( registry
[ module
].skip
);
1114 registry
[ module
].skip
= null;
1116 registry
[ module
].skipped
= true;
1117 registry
[ module
].dependencies
= [];
1118 registry
[ module
].state
= 'ready';
1119 handlePending( module
);
1124 // Resolves dynamic loader function and replaces it with its own results
1125 if ( typeof registry
[ module
].dependencies
=== 'function' ) {
1126 registry
[ module
].dependencies
= registry
[ module
].dependencies();
1127 // Ensures the module's dependencies are always in an array
1128 if ( typeof registry
[ module
].dependencies
!== 'object' ) {
1129 registry
[ module
].dependencies
= [ registry
[ module
].dependencies
];
1132 if ( resolved
.indexOf( module
) !== -1 ) {
1133 // Module already resolved; nothing to do
1136 // Create unresolved if not passed in
1137 if ( !unresolved
) {
1138 unresolved
= new StringSet();
1140 // Tracks down dependencies
1141 deps
= registry
[ module
].dependencies
;
1142 for ( i
= 0; i
< deps
.length
; i
++ ) {
1143 if ( resolved
.indexOf( deps
[ i
] ) === -1 ) {
1144 if ( unresolved
.has( deps
[ i
] ) ) {
1145 throw new Error( mw
.format(
1146 'Circular reference detected: $1 -> $2',
1152 unresolved
.add( module
);
1153 sortDependencies( deps
[ i
], resolved
, unresolved
);
1156 resolved
.push( module
);
1160 * Get names of module that a module depends on, in their proper dependency order.
1163 * @param {string[]} modules Array of string module names
1164 * @return {Array} List of dependencies, including 'module'.
1165 * @throws {Error} If an unregistered module or a dependency loop is encountered
1167 function resolve( modules
) {
1168 var i
, resolved
= [];
1169 for ( i
= 0; i
< modules
.length
; i
++ ) {
1170 sortDependencies( modules
[ i
], resolved
);
1176 * Like #resolve(), except it will silently ignore modules that
1177 * are missing or have missing dependencies.
1180 * @param {string[]} modules Array of string module names
1181 * @return {Array} List of dependencies.
1183 function resolveStubbornly( modules
) {
1184 var i
, saved
, resolved
= [];
1185 for ( i
= 0; i
< modules
.length
; i
++ ) {
1186 saved
= resolved
.slice();
1188 sortDependencies( modules
[ i
], resolved
);
1190 // This module is unknown or has unknown dependencies.
1191 // Undo any incomplete resolutions made and keep going.
1193 mw
.track( 'resourceloader.exception', {
1203 * Load and execute a script.
1206 * @param {string} src URL to script, will be used as the src attribute in the script tag
1207 * @return {jQuery.Promise}
1209 function addScript( src
) {
1213 // Force jQuery behaviour to be for crossDomain. Otherwise jQuery would use
1214 // XHR for a same domain request instead of <script>, which changes the request
1215 // headers (potentially missing a cache hit), and reduces caching in general
1216 // since browsers cache XHR much less (if at all). And XHR means we retrieve
1217 // text, so we'd need to $.globalEval, which then messes up line numbers.
1224 * Queue the loading and execution of a script for a particular module.
1227 * @param {string} src URL of the script
1228 * @param {string} [moduleName] Name of currently executing module
1229 * @return {jQuery.Promise}
1231 function queueModuleScript( src
, moduleName
) {
1232 var r
= $.Deferred();
1234 pendingRequests
.push( function () {
1235 if ( moduleName
&& hasOwn
.call( registry
, moduleName
) ) {
1236 // Emulate runScript() part of execute()
1237 window
.require
= mw
.loader
.require
;
1238 window
.module
= registry
[ moduleName
].module
;
1240 addScript( src
).always( function () {
1241 // 'module.exports' should not persist after the file is executed to
1242 // avoid leakage to unrelated code. 'require' should be kept, however,
1243 // as asynchronous access to 'require' is allowed and expected. (T144879)
1244 delete window
.module
;
1247 // Start the next one (if any)
1248 if ( pendingRequests
[ 0 ] ) {
1249 pendingRequests
.shift()();
1251 handlingPendingRequests
= false;
1255 if ( !handlingPendingRequests
&& pendingRequests
[ 0 ] ) {
1256 handlingPendingRequests
= true;
1257 pendingRequests
.shift()();
1263 * Utility function for execute()
1266 * @param {string} [media] Media attribute
1267 * @param {string} url URL
1269 function addLink( media
, url
) {
1270 var el
= document
.createElement( 'link' );
1272 el
.rel
= 'stylesheet';
1273 if ( media
&& media
!== 'all' ) {
1276 // If you end up here from an IE exception "SCRIPT: Invalid property value.",
1277 // see #addEmbeddedCSS, T33676, T43331, and T49277 for details.
1280 $( getMarker() ).before( el
);
1284 * Executes a loaded module, making it ready to use
1287 * @param {string} module Module name to execute
1289 function execute( module
) {
1290 var key
, value
, media
, i
, urls
, cssHandle
, checkCssHandles
, runScript
,
1291 cssHandlesRegistered
= false;
1293 if ( !hasOwn
.call( registry
, module
) ) {
1294 throw new Error( 'Module has not been registered yet: ' + module
);
1296 if ( registry
[ module
].state
!== 'loaded' ) {
1297 throw new Error( 'Module in state "' + registry
[ module
].state
+ '" may not be executed: ' + module
);
1300 registry
[ module
].state
= 'executing';
1302 runScript = function () {
1303 var script
, markModuleReady
, nestedAddScript
;
1305 script
= registry
[ module
].script
;
1306 markModuleReady = function () {
1307 registry
[ module
].state
= 'ready';
1308 handlePending( module
);
1310 nestedAddScript = function ( arr
, callback
, i
) {
1311 // Recursively call queueModuleScript() in its own callback
1312 // for each element of arr.
1313 if ( i
>= arr
.length
) {
1314 // We're at the end of the array
1319 queueModuleScript( arr
[ i
], module
).always( function () {
1320 nestedAddScript( arr
, callback
, i
+ 1 );
1325 if ( Array
.isArray( script
) ) {
1326 nestedAddScript( script
, markModuleReady
, 0 );
1327 } else if ( typeof script
=== 'function' ) {
1328 // Pass jQuery twice so that the signature of the closure which wraps
1329 // the script can bind both '$' and 'jQuery'.
1330 script( $, $, mw
.loader
.require
, registry
[ module
].module
);
1333 } else if ( typeof script
=== 'string' ) {
1334 // Site and user modules are legacy scripts that run in the global scope.
1335 // This is transported as a string instead of a function to avoid needing
1336 // to use string manipulation to undo the function wrapper.
1337 $.globalEval( script
);
1341 // Module without script
1345 // Use mw.track instead of mw.log because these errors are common in production mode
1346 // (e.g. undefined variable), and mw.log is only enabled in debug mode.
1347 registry
[ module
].state
= 'error';
1348 mw
.track( 'resourceloader.exception', { exception
: e
, module
: module
, source
: 'module-execute' } );
1349 handlePending( module
);
1353 // Add localizations to message system
1354 if ( registry
[ module
].messages
) {
1355 mw
.messages
.set( registry
[ module
].messages
);
1358 // Initialise templates
1359 if ( registry
[ module
].templates
) {
1360 mw
.templates
.set( module
, registry
[ module
].templates
);
1363 // Make sure we don't run the scripts until all stylesheet insertions have completed.
1366 checkCssHandles = function () {
1367 // cssHandlesRegistered ensures we don't take off too soon, e.g. when
1368 // one of the cssHandles is fired while we're still creating more handles.
1369 if ( cssHandlesRegistered
&& pending
=== 0 && runScript
) {
1370 if ( module
=== 'user' ) {
1371 // Implicit dependency on the site module. Not real dependency because
1372 // it should run after 'site' regardless of whether it succeeds or fails.
1373 mw
.loader
.using( [ 'site' ] ).always( runScript
);
1377 runScript
= undefined; // Revoke
1380 cssHandle = function () {
1381 var check
= checkCssHandles
;
1383 return function () {
1387 check
= undefined; // Revoke
1393 // Process styles (see also mw.loader.implement)
1394 // * back-compat: { <media>: css }
1395 // * back-compat: { <media>: [url, ..] }
1396 // * { "css": [css, ..] }
1397 // * { "url": { <media>: [url, ..] } }
1398 if ( registry
[ module
].style
) {
1399 for ( key
in registry
[ module
].style
) {
1400 value
= registry
[ module
].style
[ key
];
1403 if ( key
!== 'url' && key
!== 'css' ) {
1404 // Backwards compatibility, key is a media-type
1405 if ( typeof value
=== 'string' ) {
1406 // back-compat: { <media>: css }
1407 // Ignore 'media' because it isn't supported (nor was it used).
1408 // Strings are pre-wrapped in "@media". The media-type was just ""
1409 // (because it had to be set to something).
1410 // This is one of the reasons why this format is no longer used.
1411 addEmbeddedCSS( value
, cssHandle() );
1413 // back-compat: { <media>: [url, ..] }
1419 // Array of css strings in key 'css',
1420 // or back-compat array of urls from media-type
1421 if ( Array
.isArray( value
) ) {
1422 for ( i
= 0; i
< value
.length
; i
++ ) {
1423 if ( key
=== 'bc-url' ) {
1424 // back-compat: { <media>: [url, ..] }
1425 addLink( media
, value
[ i
] );
1426 } else if ( key
=== 'css' ) {
1427 // { "css": [css, ..] }
1428 addEmbeddedCSS( value
[ i
], cssHandle() );
1431 // Not an array, but a regular object
1432 // Array of urls inside media-type key
1433 } else if ( typeof value
=== 'object' ) {
1434 // { "url": { <media>: [url, ..] } }
1435 for ( media
in value
) {
1436 urls
= value
[ media
];
1437 for ( i
= 0; i
< urls
.length
; i
++ ) {
1438 addLink( media
, urls
[ i
] );
1446 cssHandlesRegistered
= true;
1451 * Add one or more modules to the module load queue.
1456 * @param {string|string[]} dependencies Module name or array of string module names
1457 * @param {Function} [ready] Callback to execute when all dependencies are ready
1458 * @param {Function} [error] Callback to execute when any dependency fails
1460 function enqueue( dependencies
, ready
, error
) {
1461 // Allow calling by single module name
1462 if ( typeof dependencies
=== 'string' ) {
1463 dependencies
= [ dependencies
];
1466 // Add ready and error callbacks if they were given
1467 if ( ready
!== undefined || error
!== undefined ) {
1469 // Narrow down the list to modules that are worth waiting for
1470 dependencies
: dependencies
.filter( function ( module
) {
1471 var state
= mw
.loader
.getState( module
);
1472 return state
=== 'registered' || state
=== 'loaded' || state
=== 'loading' || state
=== 'executing';
1479 dependencies
.forEach( function ( module
) {
1480 var state
= mw
.loader
.getState( module
);
1481 // Only queue modules that are still in the initial 'registered' state
1482 // (not ones already loading, ready or error).
1483 if ( state
=== 'registered' && queue
.indexOf( module
) === -1 ) {
1484 // Private modules must be embedded in the page. Don't bother queuing
1485 // these as the server will deny them anyway (T101806).
1486 if ( registry
[ module
].group
=== 'private' ) {
1487 registry
[ module
].state
= 'error';
1488 handlePending( module
);
1491 queue
.push( module
);
1498 function sortQuery( o
) {
1507 for ( key
= 0; key
< a
.length
; key
++ ) {
1508 sorted
[ a
[ key
] ] = o
[ a
[ key
] ];
1514 * Converts a module map of the form { foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }
1515 * to a query string of the form foo.bar,baz|bar.baz,quux
1518 * @param {Object} moduleMap Module map
1519 * @return {string} Module query string
1521 function buildModulesString( moduleMap
) {
1525 for ( prefix
in moduleMap
) {
1526 p
= prefix
=== '' ? '' : prefix
+ '.';
1527 arr
.push( p
+ moduleMap
[ prefix
].join( ',' ) );
1529 return arr
.join( '|' );
1533 * Make a network request to load modules from the server.
1536 * @param {Object} moduleMap Module map, see #buildModulesString
1537 * @param {Object} currReqBase Object with other parameters (other than 'modules') to use in the request
1538 * @param {string} sourceLoadScript URL of load.php
1540 function doRequest( moduleMap
, currReqBase
, sourceLoadScript
) {
1541 // Optimisation: Inherit (Object.create), not copy ($.extend)
1542 var query
= Object
.create( currReqBase
);
1543 query
.modules
= buildModulesString( moduleMap
);
1544 query
= sortQuery( query
);
1545 addScript( sourceLoadScript
+ '?' + $.param( query
) );
1549 * Resolve indexed dependencies.
1551 * ResourceLoader uses an optimization to save space which replaces module names in
1552 * dependency lists with the index of that module within the array of module
1553 * registration data if it exists. The benefit is a significant reduction in the data
1554 * size of the startup module. This function changes those dependency lists back to
1555 * arrays of strings.
1558 * @param {Array} modules Modules array
1560 function resolveIndexedDependencies( modules
) {
1562 function resolveIndex( dep
) {
1563 return typeof dep
=== 'number' ? modules
[ dep
][ 0 ] : dep
;
1565 for ( i
= 0; i
< modules
.length
; i
++ ) {
1566 deps
= modules
[ i
][ 2 ];
1568 for ( j
= 0; j
< deps
.length
; j
++ ) {
1569 deps
[ j
] = resolveIndex( deps
[ j
] );
1576 * Create network requests for a batch of modules.
1578 * This is an internal method for #work(). This must not be called directly
1579 * unless the modules are already registered, and no request is in progress,
1580 * and the module state has already been set to `loading`.
1583 * @param {string[]} batch
1585 function batchRequest( batch
) {
1586 var reqBase
, splits
, maxQueryLength
, b
, bSource
, bGroup
, bSourceGroup
,
1587 source
, group
, i
, modules
, sourceLoadScript
,
1588 currReqBase
, currReqBaseLength
, moduleMap
, l
,
1589 lastDotIndex
, prefix
, suffix
, bytesAdded
;
1591 if ( !batch
.length
) {
1595 // Always order modules alphabetically to help reduce cache
1596 // misses for otherwise identical content.
1599 // Build a list of query parameters common to all requests
1601 skin
: mw
.config
.get( 'skin' ),
1602 lang
: mw
.config
.get( 'wgUserLanguage' ),
1603 debug
: mw
.config
.get( 'debug' )
1605 maxQueryLength
= mw
.config
.get( 'wgResourceLoaderMaxQueryLength', 2000 );
1607 // Split module list by source and by group.
1609 for ( b
= 0; b
< batch
.length
; b
++ ) {
1610 bSource
= registry
[ batch
[ b
] ].source
;
1611 bGroup
= registry
[ batch
[ b
] ].group
;
1612 if ( !hasOwn
.call( splits
, bSource
) ) {
1613 splits
[ bSource
] = {};
1615 if ( !hasOwn
.call( splits
[ bSource
], bGroup
) ) {
1616 splits
[ bSource
][ bGroup
] = [];
1618 bSourceGroup
= splits
[ bSource
][ bGroup
];
1619 bSourceGroup
.push( batch
[ b
] );
1622 for ( source
in splits
) {
1624 sourceLoadScript
= sources
[ source
];
1626 for ( group
in splits
[ source
] ) {
1628 // Cache access to currently selected list of
1629 // modules for this group from this source.
1630 modules
= splits
[ source
][ group
];
1632 // Optimisation: Inherit (Object.create), not copy ($.extend)
1633 currReqBase
= Object
.create( reqBase
);
1634 currReqBase
.version
= getCombinedVersion( modules
);
1636 // For user modules append a user name to the query string.
1637 if ( group
=== 'user' && mw
.config
.get( 'wgUserName' ) !== null ) {
1638 currReqBase
.user
= mw
.config
.get( 'wgUserName' );
1640 currReqBaseLength
= $.param( currReqBase
).length
;
1641 // We may need to split up the request to honor the query string length limit,
1642 // so build it piece by piece.
1643 l
= currReqBaseLength
+ 9; // '&modules='.length == 9
1645 moduleMap
= {}; // { prefix: [ suffixes ] }
1647 for ( i
= 0; i
< modules
.length
; i
++ ) {
1648 // Determine how many bytes this module would add to the query string
1649 lastDotIndex
= modules
[ i
].lastIndexOf( '.' );
1651 // If lastDotIndex is -1, substr() returns an empty string
1652 prefix
= modules
[ i
].substr( 0, lastDotIndex
);
1653 suffix
= modules
[ i
].slice( lastDotIndex
+ 1 );
1655 bytesAdded
= hasOwn
.call( moduleMap
, prefix
) ?
1656 suffix
.length
+ 3 : // '%2C'.length == 3
1657 modules
[ i
].length
+ 3; // '%7C'.length == 3
1659 // If the url would become too long, create a new one,
1660 // but don't create empty requests
1661 if ( maxQueryLength
> 0 && !$.isEmptyObject( moduleMap
) && l
+ bytesAdded
> maxQueryLength
) {
1662 // This url would become too long, create a new one, and start the old one
1663 doRequest( moduleMap
, currReqBase
, sourceLoadScript
);
1665 l
= currReqBaseLength
+ 9;
1666 mw
.track( 'resourceloader.splitRequest', { maxQueryLength
: maxQueryLength
} );
1668 if ( !hasOwn
.call( moduleMap
, prefix
) ) {
1669 moduleMap
[ prefix
] = [];
1671 moduleMap
[ prefix
].push( suffix
);
1674 // If there's anything left in moduleMap, request that too
1675 if ( !$.isEmptyObject( moduleMap
) ) {
1676 doRequest( moduleMap
, currReqBase
, sourceLoadScript
);
1684 * @param {string[]} implementations Array containing pieces of JavaScript code in the
1685 * form of calls to mw.loader#implement().
1686 * @param {Function} cb Callback in case of failure
1687 * @param {Error} cb.err
1689 function asyncEval( implementations
, cb
) {
1690 if ( !implementations
.length
) {
1693 mw
.requestIdleCallback( function () {
1695 $.globalEval( implementations
.join( ';' ) );
1703 * Make a versioned key for a specific module.
1706 * @param {string} module Module name
1707 * @return {string|null} Module key in format '`[name]@[version]`',
1708 * or null if the module does not exist
1710 function getModuleKey( module
) {
1711 return hasOwn
.call( registry
, module
) ?
1712 ( module
+ '@' + registry
[ module
].version
) : null;
1717 * @param {string} key Module name or '`[name]@[version]`'
1720 function splitModuleKey( key
) {
1721 var index
= key
.indexOf( '@' );
1722 if ( index
=== -1 ) {
1729 name
: key
.slice( 0, index
),
1730 version
: key
.slice( index
+ 1 )
1734 /* Public Members */
1737 * The module registry is exposed as an aid for debugging and inspecting page
1738 * state; it is not a public interface for modifying the registry.
1744 moduleRegistry
: registry
,
1747 * @inheritdoc #newStyleTag
1750 addStyleTag
: newStyleTag
,
1753 * Start loading of all queued module dependencies.
1758 var q
, batch
, implementations
, sourceModules
;
1762 // Appends a list of modules from the queue to the batch
1763 for ( q
= 0; q
< queue
.length
; q
++ ) {
1764 // Only load modules which are registered
1765 if ( hasOwn
.call( registry
, queue
[ q
] ) && registry
[ queue
[ q
] ].state
=== 'registered' ) {
1766 // Prevent duplicate entries
1767 if ( batch
.indexOf( queue
[ q
] ) === -1 ) {
1768 batch
.push( queue
[ q
] );
1769 // Mark registered modules as loading
1770 registry
[ queue
[ q
] ].state
= 'loading';
1775 // Now that the queue has been processed into a batch, clear the queue.
1776 // This MUST happen before we initiate any eval or network request. Otherwise,
1777 // it is possible for a cached script to instantly trigger the same work queue
1778 // again; all before we've cleared it causing each request to include modules
1779 // which are already loaded.
1782 if ( !batch
.length
) {
1786 mw
.loader
.store
.init();
1787 if ( mw
.loader
.store
.enabled
) {
1788 implementations
= [];
1790 batch
= batch
.filter( function ( module
) {
1791 var implementation
= mw
.loader
.store
.get( module
);
1792 if ( implementation
) {
1793 implementations
.push( implementation
);
1794 sourceModules
.push( module
);
1799 asyncEval( implementations
, function ( err
) {
1801 // Not good, the cached mw.loader.implement calls failed! This should
1802 // never happen, barring ResourceLoader bugs, browser bugs and PEBKACs.
1803 // Depending on how corrupt the string is, it is likely that some
1804 // modules' implement() succeeded while the ones after the error will
1805 // never run and leave their modules in the 'loading' state forever.
1806 mw
.loader
.store
.stats
.failed
++;
1808 // Since this is an error not caused by an individual module but by
1809 // something that infected the implement call itself, don't take any
1810 // risks and clear everything in this cache.
1811 mw
.loader
.store
.clear();
1813 mw
.track( 'resourceloader.exception', { exception
: err
, source
: 'store-eval' } );
1814 // Re-add the failed ones that are still pending back to the batch
1815 failed
= sourceModules
.filter( function ( module
) {
1816 return registry
[ module
].state
=== 'loading';
1818 batchRequest( failed
);
1822 batchRequest( batch
);
1826 * Register a source.
1828 * The #work() method will use this information to split up requests by source.
1830 * mw.loader.addSource( 'mediawikiwiki', '//www.mediawiki.org/w/load.php' );
1832 * @param {string|Object} id Source ID, or object mapping ids to load urls
1833 * @param {string} loadUrl Url to a load.php end point
1834 * @throws {Error} If source id is already registered
1836 addSource: function ( id
, loadUrl
) {
1838 // Allow multiple additions
1839 if ( typeof id
=== 'object' ) {
1840 for ( source
in id
) {
1841 mw
.loader
.addSource( source
, id
[ source
] );
1846 if ( hasOwn
.call( sources
, id
) ) {
1847 throw new Error( 'source already registered: ' + id
);
1850 sources
[ id
] = loadUrl
;
1854 * Register a module, letting the system know about it and its properties.
1856 * The startup modules contain calls to this method.
1858 * When using multiple module registration by passing an array, dependencies that
1859 * are specified as references to modules within the array will be resolved before
1860 * the modules are registered.
1862 * @param {string|Array} module Module name or array of arrays, each containing
1863 * a list of arguments compatible with this method
1864 * @param {string|number} version Module version hash (falls backs to empty string)
1865 * Can also be a number (timestamp) for compatibility with MediaWiki 1.25 and earlier.
1866 * @param {string|Array|Function} dependencies One string or array of strings of module
1867 * names on which this module depends, or a function that returns that array.
1868 * @param {string} [group=null] Group which the module is in
1869 * @param {string} [source='local'] Name of the source
1870 * @param {string} [skip=null] Script body of the skip function
1872 register: function ( module
, version
, dependencies
, group
, source
, skip
) {
1874 // Allow multiple registration
1875 if ( typeof module
=== 'object' ) {
1876 resolveIndexedDependencies( module
);
1877 for ( i
= 0; i
< module
.length
; i
++ ) {
1878 // module is an array of module names
1879 if ( typeof module
[ i
] === 'string' ) {
1880 mw
.loader
.register( module
[ i
] );
1881 // module is an array of arrays
1882 } else if ( typeof module
[ i
] === 'object' ) {
1883 mw
.loader
.register
.apply( mw
.loader
, module
[ i
] );
1888 if ( hasOwn
.call( registry
, module
) ) {
1889 throw new Error( 'module already registered: ' + module
);
1891 if ( typeof dependencies
=== 'string' ) {
1892 // A single module name
1893 deps
= [ dependencies
];
1894 } else if ( typeof dependencies
=== 'object' || typeof dependencies
=== 'function' ) {
1895 // Array of module names or a function that returns an array
1896 deps
= dependencies
;
1898 // List the module as registered
1899 registry
[ module
] = {
1900 // Exposed to execute() for mw.loader.implement() closures.
1901 // Import happens via require().
1905 version
: version
!== undefined ? String( version
) : '',
1906 dependencies
: deps
|| [],
1907 group
: typeof group
=== 'string' ? group
: null,
1908 source
: typeof source
=== 'string' ? source
: 'local',
1909 state
: 'registered',
1910 skip
: typeof skip
=== 'string' ? skip
: null
1915 * Implement a module given the components that make up the module.
1917 * When #load() or #using() requests one or more modules, the server
1918 * response contain calls to this function.
1920 * @param {string} module Name of module and current module version. Formatted
1921 * as '`[name]@[version]`". This version should match the requested version
1922 * (from #batchRequest and #registry). This avoids race conditions (T117587).
1923 * For back-compat with MediaWiki 1.27 and earlier, the version may be omitted.
1924 * @param {Function|Array|string} [script] Function with module code, list of URLs
1925 * to load via `<script src>`, or string of module code for `$.globalEval()`.
1926 * @param {Object} [style] Should follow one of the following patterns:
1928 * { "css": [css, ..] }
1929 * { "url": { <media>: [url, ..] } }
1931 * And for backwards compatibility (needs to be supported forever due to caching):
1934 * { <media>: [url, ..] }
1936 * The reason css strings are not concatenated anymore is T33676. We now check
1937 * whether it's safe to extend the stylesheet.
1940 * @param {Object} [messages] List of key/value pairs to be added to mw#messages.
1941 * @param {Object} [templates] List of key/value pairs to be added to mw#templates.
1943 implement: function ( module
, script
, style
, messages
, templates
) {
1944 var split
= splitModuleKey( module
),
1946 version
= split
.version
;
1947 // Automatically register module
1948 if ( !hasOwn
.call( registry
, name
) ) {
1949 mw
.loader
.register( name
);
1951 // Check for duplicate implementation
1952 if ( hasOwn
.call( registry
, name
) && registry
[ name
].script
!== undefined ) {
1953 throw new Error( 'module already implemented: ' + name
);
1956 // Without this reset, if there is a version mismatch between the
1957 // requested and received module version, then mw.loader.store would
1958 // cache the response under the requested key. Thus poisoning the cache
1959 // indefinitely with a stale value. (T117587)
1960 registry
[ name
].version
= version
;
1962 // Attach components
1963 registry
[ name
].script
= script
|| null;
1964 registry
[ name
].style
= style
|| null;
1965 registry
[ name
].messages
= messages
|| null;
1966 registry
[ name
].templates
= templates
|| null;
1967 // The module may already have been marked as erroneous
1968 if ( registry
[ name
].state
!== 'error' && registry
[ name
].state
!== 'missing' ) {
1969 registry
[ name
].state
= 'loaded';
1970 if ( allReady( registry
[ name
].dependencies
) ) {
1977 * Execute a function as soon as one or more required modules are ready.
1979 * Example of inline dependency on OOjs:
1981 * mw.loader.using( 'oojs', function () {
1982 * OO.compare( [ 1 ], [ 1 ] );
1985 * Since MediaWiki 1.23 this also returns a promise.
1987 * Since MediaWiki 1.28 the promise is resolved with a `require` function.
1989 * @param {string|Array} dependencies Module name or array of modules names the
1990 * callback depends on to be ready before executing
1991 * @param {Function} [ready] Callback to execute when all dependencies are ready
1992 * @param {Function} [error] Callback to execute if one or more dependencies failed
1993 * @return {jQuery.Promise} With a `require` function
1995 using: function ( dependencies
, ready
, error
) {
1996 var deferred
= $.Deferred();
1998 // Allow calling with a single dependency as a string
1999 if ( typeof dependencies
=== 'string' ) {
2000 dependencies
= [ dependencies
];
2004 deferred
.done( ready
);
2007 deferred
.fail( error
);
2011 // Resolve entire dependency map
2012 dependencies
= resolve( dependencies
);
2014 return deferred
.reject( e
).promise();
2016 if ( allReady( dependencies
) ) {
2017 // Run ready immediately
2018 deferred
.resolve( mw
.loader
.require
);
2019 } else if ( anyFailed( dependencies
) ) {
2020 // Execute error immediately if any dependencies have errors
2022 new Error( 'One or more dependencies failed to load' ),
2026 // Not all dependencies are ready, add to the load queue
2027 enqueue( dependencies
, function () {
2028 deferred
.resolve( mw
.loader
.require
);
2029 }, deferred
.reject
);
2032 return deferred
.promise();
2036 * Load an external script or one or more modules.
2038 * This method takes a list of unrelated modules. Use cases:
2040 * - A web page will be composed of many different widgets. These widgets independently
2041 * queue their ResourceLoader modules (`OutputPage::addModules()`). If any of them
2042 * have problems, or are no longer known (e.g. cached HTML), the other modules
2043 * should still be loaded.
2044 * - This method is used for preloading, which must not throw. Later code that
2045 * calls #using() will handle the error.
2047 * @param {string|Array} modules Either the name of a module, array of modules,
2048 * or a URL of an external script or style
2049 * @param {string} [type='text/javascript'] MIME type to use if calling with a URL of an
2050 * external script or style; acceptable values are "text/css" and
2051 * "text/javascript"; if no type is provided, text/javascript is assumed.
2053 load: function ( modules
, type
) {
2056 // Allow calling with a url or single dependency as a string
2057 if ( typeof modules
=== 'string' ) {
2058 // "https://example.org/x.js", "http://example.org/x.js", "//example.org/x.js", "/x.js"
2059 if ( /^(https?:)?\/?\//.test( modules
) ) {
2060 if ( type
=== 'text/css' ) {
2061 l
= document
.createElement( 'link' );
2062 l
.rel
= 'stylesheet';
2064 document
.head
.appendChild( l
);
2067 if ( type
=== 'text/javascript' || type
=== undefined ) {
2068 addScript( modules
);
2072 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type
);
2074 // Called with single module
2075 modules
= [ modules
];
2078 // Filter out top-level modules that are unknown or failed to load before.
2079 filtered
= modules
.filter( function ( module
) {
2080 var state
= mw
.loader
.getState( module
);
2081 return state
!== 'error' && state
!== 'missing';
2083 // Resolve remaining list using the known dependency tree.
2084 // This also filters out modules with unknown dependencies. (T36853)
2085 filtered
= resolveStubbornly( filtered
);
2086 // If all modules are ready, or if any modules have errors, nothing to be done.
2087 if ( allReady( filtered
) || anyFailed( filtered
) ) {
2090 if ( filtered
.length
=== 0 ) {
2093 // Some modules are not yet ready, add to module load queue.
2094 enqueue( filtered
, undefined, undefined );
2098 * Change the state of one or more modules.
2100 * @param {string|Object} module Module name or object of module name/state pairs
2101 * @param {string} state State name
2103 state: function ( module
, state
) {
2106 if ( typeof module
=== 'object' ) {
2107 for ( m
in module
) {
2108 mw
.loader
.state( m
, module
[ m
] );
2112 if ( !hasOwn
.call( registry
, module
) ) {
2113 mw
.loader
.register( module
);
2115 registry
[ module
].state
= state
;
2116 if ( state
=== 'ready' || state
=== 'error' || state
=== 'missing' ) {
2117 // Make sure pending modules depending on this one get executed if their
2118 // dependencies are now fulfilled!
2119 handlePending( module
);
2124 * Get the version of a module.
2126 * @param {string} module Name of module
2127 * @return {string|null} The version, or null if the module (or its version) is not
2130 getVersion: function ( module
) {
2131 return hasOwn
.call( registry
, module
) ? registry
[ module
].version
: null;
2135 * Get the state of a module.
2137 * @param {string} module Name of module
2138 * @return {string|null} The state, or null if the module (or its state) is not
2141 getState: function ( module
) {
2142 return hasOwn
.call( registry
, module
) ? registry
[ module
].state
: null;
2146 * Get the names of all registered modules.
2150 getModuleNames: function () {
2151 return Object
.keys( registry
);
2155 * Get the exported value of a module.
2157 * Modules may provide this via their local `module.exports`.
2161 * @param {string} moduleName Module name
2162 * @return {Mixed} Exported value
2164 require: function ( moduleName
) {
2165 var state
= mw
.loader
.getState( moduleName
);
2167 // Only ready modules can be required
2168 if ( state
!== 'ready' ) {
2169 // Module may've forgotten to declare a dependency
2170 throw new Error( 'Module "' + moduleName
+ '" is not loaded.' );
2173 return registry
[ moduleName
].module
.exports
;
2177 * @inheritdoc mw.inspect#runReports
2180 inspect: function () {
2181 var args
= slice
.call( arguments
);
2182 mw
.loader
.using( 'mediawiki.inspect', function () {
2183 mw
.inspect
.runReports
.apply( mw
.inspect
, args
);
2188 * On browsers that implement the localStorage API, the module store serves as a
2189 * smart complement to the browser cache. Unlike the browser cache, the module store
2190 * can slice a concatenated response from ResourceLoader into its constituent
2191 * modules and cache each of them separately, using each module's versioning scheme
2192 * to determine when the cache should be invalidated.
2195 * @class mw.loader.store
2198 // Whether the store is in use on this page.
2201 // Modules whose string representation exceeds 100 kB are
2202 // ineligible for storage. See bug T66721.
2203 MODULE_SIZE_MAX
: 100 * 1000,
2205 // The contents of the store, mapping '[name]@[version]' keys
2206 // to module implementations.
2210 stats
: { hits
: 0, misses
: 0, expired
: 0, failed
: 0 },
2213 * Construct a JSON-serializable object representing the content of the store.
2215 * @return {Object} Module store contents.
2217 toJSON: function () {
2218 return { items
: mw
.loader
.store
.items
, vary
: mw
.loader
.store
.getVary() };
2222 * Get the localStorage key for the entire module store. The key references
2223 * $wgDBname to prevent clashes between wikis which share a common host.
2225 * @return {string} localStorage item key
2227 getStoreKey: function () {
2228 return 'MediaWikiModuleStore:' + mw
.config
.get( 'wgDBname' );
2232 * Get a key on which to vary the module cache.
2234 * @return {string} String of concatenated vary conditions.
2236 getVary: function () {
2238 mw
.config
.get( 'skin' ),
2239 mw
.config
.get( 'wgResourceLoaderStorageVersion' ),
2240 mw
.config
.get( 'wgUserLanguage' )
2245 * Initialize the store.
2247 * Retrieves store from localStorage and (if successfully retrieved) decoding
2248 * the stored JSON value to a plain object.
2250 * The try / catch block is used for JSON & localStorage feature detection.
2251 * See the in-line documentation for Modernizr's localStorage feature detection
2252 * code for a full account of why we need a try / catch:
2253 * <https://github.com/Modernizr/Modernizr/blob/v2.7.1/modernizr.js#L771-L796>.
2258 if ( mw
.loader
.store
.enabled
!== null ) {
2264 // Disabled because localStorage quotas are tight and (in Firefox's case)
2265 // shared by multiple origins.
2266 // See T66721, and <https://bugzilla.mozilla.org/show_bug.cgi?id=1064466>.
2267 /Firefox|Opera/.test( navigator
.userAgent
) ||
2269 // Disabled by configuration.
2270 !mw
.config
.get( 'wgResourceLoaderStorageEnabled' )
2272 // Clear any previous store to free up space. (T66721)
2273 mw
.loader
.store
.clear();
2274 mw
.loader
.store
.enabled
= false;
2277 if ( mw
.config
.get( 'debug' ) ) {
2278 // Disable module store in debug mode
2279 mw
.loader
.store
.enabled
= false;
2284 raw
= localStorage
.getItem( mw
.loader
.store
.getStoreKey() );
2285 // If we get here, localStorage is available; mark enabled
2286 mw
.loader
.store
.enabled
= true;
2287 data
= JSON
.parse( raw
);
2288 if ( data
&& typeof data
.items
=== 'object' && data
.vary
=== mw
.loader
.store
.getVary() ) {
2289 mw
.loader
.store
.items
= data
.items
;
2293 mw
.track( 'resourceloader.exception', { exception
: e
, source
: 'store-localstorage-init' } );
2296 if ( raw
=== undefined ) {
2297 // localStorage failed; disable store
2298 mw
.loader
.store
.enabled
= false;
2300 mw
.loader
.store
.update();
2305 * Retrieve a module from the store and update cache hit stats.
2307 * @param {string} module Module name
2308 * @return {string|boolean} Module implementation or false if unavailable
2310 get: function ( module
) {
2313 if ( !mw
.loader
.store
.enabled
) {
2317 key
= getModuleKey( module
);
2318 if ( key
in mw
.loader
.store
.items
) {
2319 mw
.loader
.store
.stats
.hits
++;
2320 return mw
.loader
.store
.items
[ key
];
2322 mw
.loader
.store
.stats
.misses
++;
2327 * Stringify a module and queue it for storage.
2329 * @param {string} module Module name
2330 * @param {Object} descriptor The module's descriptor as set in the registry
2331 * @return {boolean} Module was set
2333 set: function ( module
, descriptor
) {
2336 if ( !mw
.loader
.store
.enabled
) {
2340 key
= getModuleKey( module
);
2343 // Already stored a copy of this exact version
2344 key
in mw
.loader
.store
.items
||
2345 // Module failed to load
2346 descriptor
.state
!== 'ready' ||
2347 // Unversioned, private, or site-/user-specific
2348 !descriptor
.version
||
2349 descriptor
.group
=== 'private' ||
2350 descriptor
.group
=== 'user' ||
2351 // Partial descriptor
2352 // (e.g. skipped module, or style module with state=ready)
2353 [ descriptor
.script
, descriptor
.style
, descriptor
.messages
,
2354 descriptor
.templates
].indexOf( undefined ) !== -1
2362 JSON
.stringify( key
),
2363 typeof descriptor
.script
=== 'function' ?
2364 String( descriptor
.script
) :
2365 JSON
.stringify( descriptor
.script
),
2366 JSON
.stringify( descriptor
.style
),
2367 JSON
.stringify( descriptor
.messages
),
2368 JSON
.stringify( descriptor
.templates
)
2370 // Attempted workaround for a possible Opera bug (bug T59567).
2371 // This regex should never match under sane conditions.
2372 if ( /^\s*\(/.test( args
[ 1 ] ) ) {
2373 args
[ 1 ] = 'function' + args
[ 1 ];
2374 mw
.track( 'resourceloader.assert', { source
: 'bug-T59567' } );
2377 mw
.track( 'resourceloader.exception', { exception
: e
, source
: 'store-localstorage-json' } );
2381 src
= 'mw.loader.implement(' + args
.join( ',' ) + ');';
2382 if ( src
.length
> mw
.loader
.store
.MODULE_SIZE_MAX
) {
2385 mw
.loader
.store
.items
[ key
] = src
;
2386 mw
.loader
.store
.update();
2391 * Iterate through the module store, removing any item that does not correspond
2392 * (in name and version) to an item in the module registry.
2394 * @return {boolean} Store was pruned
2396 prune: function () {
2399 if ( !mw
.loader
.store
.enabled
) {
2403 for ( key
in mw
.loader
.store
.items
) {
2404 module
= key
.slice( 0, key
.indexOf( '@' ) );
2405 if ( getModuleKey( module
) !== key
) {
2406 mw
.loader
.store
.stats
.expired
++;
2407 delete mw
.loader
.store
.items
[ key
];
2408 } else if ( mw
.loader
.store
.items
[ key
].length
> mw
.loader
.store
.MODULE_SIZE_MAX
) {
2409 // This value predates the enforcement of a size limit on cached modules.
2410 delete mw
.loader
.store
.items
[ key
];
2417 * Clear the entire module store right now.
2419 clear: function () {
2420 mw
.loader
.store
.items
= {};
2422 localStorage
.removeItem( mw
.loader
.store
.getStoreKey() );
2423 } catch ( ignored
) {}
2427 * Sync in-memory store back to localStorage.
2429 * This function debounces updates. When called with a flush already pending,
2430 * the call is coalesced into the pending update. The call to
2431 * localStorage.setItem will be naturally deferred until the page is quiescent.
2433 * Because localStorage is shared by all pages from the same origin, if multiple
2434 * pages are loaded with different module sets, the possibility exists that
2435 * modules saved by one page will be clobbered by another. But the impact would
2436 * be minor and the problem would be corrected by subsequent page views.
2440 update
: ( function () {
2441 var hasPendingWrite
= false;
2443 function flushWrites() {
2445 if ( !hasPendingWrite
|| !mw
.loader
.store
.enabled
) {
2449 mw
.loader
.store
.prune();
2450 key
= mw
.loader
.store
.getStoreKey();
2452 // Replacing the content of the module store might fail if the new
2453 // contents would exceed the browser's localStorage size limit. To
2454 // avoid clogging the browser with stale data, always remove the old
2455 // value before attempting to set the new one.
2456 localStorage
.removeItem( key
);
2457 data
= JSON
.stringify( mw
.loader
.store
);
2458 localStorage
.setItem( key
, data
);
2460 mw
.track( 'resourceloader.exception', { exception
: e
, source
: 'store-localstorage-update' } );
2463 hasPendingWrite
= false;
2466 return function () {
2467 if ( !hasPendingWrite
) {
2468 hasPendingWrite
= true;
2469 mw
.requestIdleCallback( flushWrites
);
2478 * HTML construction helper functions
2485 * output = Html.element( 'div', {}, new Html.Raw(
2486 * Html.element( 'img', { src: '<' } )
2488 * mw.log( output ); // <div><img src="<"/></div>
2493 html
: ( function () {
2494 function escapeCallback( s
) {
2511 * Escape a string for HTML.
2513 * Converts special characters to HTML entities.
2515 * mw.html.escape( '< > \' & "' );
2516 * // Returns < > ' & "
2518 * @param {string} s The string to escape
2519 * @return {string} HTML
2521 escape: function ( s
) {
2522 return s
.replace( /['"<>&]/g, escapeCallback
);
2526 * Create an HTML element string, with safe escaping.
2528 * @param {string} name The tag name.
2529 * @param {Object} [attrs] An object with members mapping element names to values
2530 * @param {string|mw.html.Raw|mw.html.Cdata|null} [contents=null] The contents of the element.
2532 * - string: Text to be escaped.
2533 * - null: The element is treated as void with short closing form, e.g. `<br/>`.
2534 * - this.Raw: The raw value is directly included.
2535 * - this.Cdata: The raw value is directly included. An exception is
2536 * thrown if it contains any illegal ETAGO delimiter.
2537 * See <https://www.w3.org/TR/html401/appendix/notes.html#h-B.3.2>.
2538 * @return {string} HTML
2540 element: function ( name
, attrs
, contents
) {
2541 var v
, attrName
, s
= '<' + name
;
2544 for ( attrName
in attrs
) {
2545 v
= attrs
[ attrName
];
2546 // Convert name=true, to name=name
2550 } else if ( v
=== false ) {
2553 s
+= ' ' + attrName
+ '="' + this.escape( String( v
) ) + '"';
2556 if ( contents
=== undefined || contents
=== null ) {
2563 switch ( typeof contents
) {
2566 s
+= this.escape( contents
);
2570 // Convert to string
2571 s
+= String( contents
);
2574 if ( contents
instanceof this.Raw
) {
2575 // Raw HTML inclusion
2576 s
+= contents
.value
;
2577 } else if ( contents
instanceof this.Cdata
) {
2579 if ( /<\/[a-zA-z]/.test( contents
.value
) ) {
2580 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
2582 s
+= contents
.value
;
2584 throw new Error( 'mw.html.element: Invalid type of contents' );
2587 s
+= '</' + name
+ '>';
2592 * Wrapper object for raw HTML passed to mw.html.element().
2594 * @class mw.html.Raw
2596 * @param {string} value
2598 Raw: function ( value
) {
2603 * Wrapper object for CDATA element contents passed to mw.html.element()
2605 * @class mw.html.Cdata
2607 * @param {string} value
2609 Cdata: function ( value
) {
2615 // Skeleton user object, extended by the 'mediawiki.user' module.
2622 * @property {mw.Map}
2626 * @property {mw.Map}
2631 // OOUI widgets specific to MediaWiki
2635 * Registry and firing of events.
2637 * MediaWiki has various interface components that are extended, enhanced
2638 * or manipulated in some other way by extensions, gadgets and even
2641 * This framework helps streamlining the timing of when these other
2642 * code paths fire their plugins (instead of using document-ready,
2643 * which can and should be limited to firing only once).
2645 * Features like navigating to other wiki pages, previewing an edit
2646 * and editing itself – without a refresh – can then retrigger these
2647 * hooks accordingly to ensure everything still works as expected.
2651 * mw.hook( 'wikipage.content' ).add( fn ).remove( fn );
2652 * mw.hook( 'wikipage.content' ).fire( $content );
2654 * Handlers can be added and fired for arbitrary event names at any time. The same
2655 * event can be fired multiple times. The last run of an event is memorized
2656 * (similar to `$(document).ready` and `$.Deferred().done`).
2657 * This means if an event is fired, and a handler added afterwards, the added
2658 * function will be fired right away with the last given event data.
2660 * Like Deferreds and Promises, the mw.hook object is both detachable and chainable.
2661 * Thus allowing flexible use and optimal maintainability and authority control.
2662 * You can pass around the `add` and/or `fire` method to another piece of code
2663 * without it having to know the event name (or `mw.hook` for that matter).
2665 * var h = mw.hook( 'bar.ready' );
2666 * new mw.Foo( .. ).fetch( { callback: h.fire } );
2668 * Note: Events are documented with an underscore instead of a dot in the event
2669 * name due to jsduck not supporting dots in that position.
2673 hook
: ( function () {
2677 * Create an instance of mw.hook.
2681 * @param {string} name Name of hook.
2684 return function ( name
) {
2685 var list
= hasOwn
.call( lists
, name
) ?
2687 lists
[ name
] = $.Callbacks( 'memory' );
2691 * Register a hook handler
2693 * @param {...Function} handler Function to bind.
2699 * Unregister a hook handler
2701 * @param {...Function} handler Function to unbind.
2704 remove
: list
.remove
,
2706 // eslint-disable-next-line valid-jsdoc
2710 * @param {...Mixed} data
2714 return list
.fireWith
.call( this, null, slice
.call( arguments
) );
2721 // Alias $j to jQuery for backwards compatibility
2722 // @deprecated since 1.23 Use $ or jQuery instead
2723 mw
.log
.deprecate( window
, '$j', $, 'Use $ or jQuery instead.' );
2726 * Log a message to window.console, if possible.
2728 * Useful to force logging of some errors that are otherwise hard to detect (i.e., this logs
2729 * also in production mode). Gets console references in each invocation instead of caching the
2730 * reference, so that debugging tools loaded later are supported (e.g. Firebug Lite in IE).
2733 * @param {string} topic Stream name passed by mw.track
2734 * @param {Object} data Data passed by mw.track
2735 * @param {Error} [data.exception]
2736 * @param {string} data.source Error source
2737 * @param {string} [data.module] Name of module which caused the error
2739 function logError( topic
, data
) {
2740 /* eslint-disable no-console */
2743 source
= data
.source
,
2744 module
= data
.module
,
2745 console
= window
.console
;
2747 if ( console
&& console
.log
) {
2748 msg
= ( e
? 'Exception' : 'Error' ) + ' in ' + source
;
2750 msg
+= ' in module ' + module
;
2752 msg
+= ( e
? ':' : '.' );
2755 // If we have an exception object, log it to the warning channel to trigger
2756 // proper stacktraces in browsers that support it.
2757 if ( e
&& console
.warn
) {
2761 /* eslint-enable no-console */
2764 // Subscribe to error streams
2765 mw
.trackSubscribe( 'resourceloader.exception', logError
);
2766 mw
.trackSubscribe( 'resourceloader.assert', logError
);
2769 * Fired when all modules associated with the page have finished loading.
2771 * @event resourceloader_loadEnd
2775 var loading
, modules
;
2777 modules
= mw
.loader
.getModuleNames().filter( function ( module
) {
2778 return mw
.loader
.getState( module
) === 'loading';
2780 // We only need a callback, not any actual module. First try a single using()
2781 // for all loading modules. If one fails, fall back to tracking each module
2782 // separately via $.when(), this is expensive.
2783 loading
= mw
.loader
.using( modules
).then( null, function () {
2784 var all
= modules
.map( function ( module
) {
2785 return mw
.loader
.using( module
).then( null, function () {
2786 return $.Deferred().resolve();
2789 return $.when
.apply( $, all
);
2791 loading
.then( function () {
2792 /* global mwPerformance */
2793 mwPerformance
.mark( 'mwLoadEnd' );
2794 mw
.hook( 'resourceloader.loadEnd' ).fire();
2798 // Attach to window and globally alias
2799 window
.mw
= window
.mediaWiki
= mw
;