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-US/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
) {
93 if ( arguments
.length
> 1 ) {
94 if ( typeof selection
!== 'string' ) {
97 setGlobalMapValue( this, selection
, value
);
100 if ( typeof selection
=== 'object' ) {
101 for ( s
in selection
) {
102 setGlobalMapValue( this, s
, selection
[ s
] );
112 * Alias property to the global object.
116 * @param {mw.Map} map
117 * @param {string} key
118 * @param {Mixed} value
120 function setGlobalMapValue( map
, key
, value
) {
121 map
.values
[ key
] = value
;
126 // Deprecation notice for mw.config globals (T58550, T72470)
127 map
=== mw
.config
&& 'Use mw.config instead.'
135 * Get the value of one or more keys.
137 * If called with no arguments, all values are returned.
139 * @param {string|Array} [selection] Key or array of keys to retrieve values for.
140 * @param {Mixed} [fallback=null] Value for keys that don't exist.
141 * @return {Mixed|Object|null} If selection was a string, returns the value,
142 * If selection was an array, returns an object of key/values.
143 * If no selection is passed, a new object with all key/values is returned.
145 get: function ( selection
, fallback
) {
147 fallback
= arguments
.length
> 1 ? fallback
: null;
149 if ( Array
.isArray( selection
) ) {
151 for ( i
= 0; i
< selection
.length
; i
++ ) {
152 if ( typeof selection
[ i
] === 'string' ) {
153 results
[ selection
[ i
] ] = hasOwn
.call( this.values
, selection
[ i
] ) ?
154 this.values
[ selection
[ i
] ] :
161 if ( typeof selection
=== 'string' ) {
162 return hasOwn
.call( this.values
, selection
) ?
163 this.values
[ selection
] :
167 if ( selection
=== undefined ) {
169 for ( i
in this.values
) {
170 results
[ i
] = this.values
[ i
];
175 // Invalid selection key
180 * Set one or more key/value pairs.
182 * @param {string|Object} selection Key to set value for, or object mapping keys to values
183 * @param {Mixed} [value] Value to set (optional, only in use when key is a string)
184 * @return {boolean} True on success, false on failure
186 set: function ( selection
, value
) {
188 // Use `arguments.length` because `undefined` is also a valid value.
189 if ( arguments
.length
> 1 ) {
190 if ( typeof selection
!== 'string' ) {
193 this.values
[ selection
] = value
;
196 if ( typeof selection
=== 'object' ) {
197 for ( s
in selection
) {
198 this.values
[ s
] = selection
[ s
];
206 * Check if one or more keys exist.
208 * @param {Mixed} selection Key or array of keys to check
209 * @return {boolean} True if the key(s) exist
211 exists: function ( selection
) {
213 if ( Array
.isArray( selection
) ) {
214 for ( i
= 0; i
< selection
.length
; i
++ ) {
215 if ( typeof selection
[ i
] !== 'string' || !hasOwn
.call( this.values
, selection
[ i
] ) ) {
221 return typeof selection
=== 'string' && hasOwn
.call( this.values
, selection
);
226 * Object constructor for messages.
228 * Similar to the Message class in MediaWiki PHP.
230 * Format defaults to 'text'.
236 * 'hello': 'Hello world',
237 * 'hello-user': 'Hello, $1!',
238 * 'welcome-user': 'Welcome back to $2, $1! Last visit by $1: $3'
241 * obj = new mw.Message( mw.messages, 'hello' );
242 * mw.log( obj.text() );
245 * obj = new mw.Message( mw.messages, 'hello-user', [ 'John Doe' ] );
246 * mw.log( obj.text() );
247 * // Hello, John Doe!
249 * obj = new mw.Message( mw.messages, 'welcome-user', [ 'John Doe', 'Wikipedia', '2 hours ago' ] );
250 * mw.log( obj.text() );
251 * // Welcome back to Wikipedia, John Doe! Last visit by John Doe: 2 hours ago
253 * // Using mw.message shortcut
254 * obj = mw.message( 'hello-user', 'John Doe' );
255 * mw.log( obj.text() );
256 * // Hello, John Doe!
258 * // Using mw.msg shortcut
259 * str = mw.msg( 'hello-user', 'John Doe' );
261 * // Hello, John Doe!
263 * // Different formats
264 * obj = new mw.Message( mw.messages, 'hello-user', [ 'John "Wiki" <3 Doe' ] );
266 * obj.format = 'text';
267 * str = obj.toString();
272 * // Hello, John "Wiki" <3 Doe!
274 * mw.log( obj.escaped() );
275 * // Hello, John "Wiki" <3 Doe!
280 * @param {mw.Map} map Message store
281 * @param {string} key
282 * @param {Array} [parameters]
284 function Message( map
, key
, parameters
) {
285 this.format
= 'text';
288 this.parameters
= parameters
=== undefined ? [] : slice
.call( parameters
);
292 Message
.prototype = {
294 * Get parsed contents of the message.
296 * The default parser does simple $N replacements and nothing else.
297 * This may be overridden to provide a more complex message parser.
298 * The primary override is in the mediawiki.jqueryMsg module.
300 * This function will not be called for nonexistent messages.
302 * @return {string} Parsed message
304 parser: function () {
305 return mw
.format
.apply( null, [ this.map
.get( this.key
) ].concat( this.parameters
) );
308 // eslint-disable-next-line valid-jsdoc
310 * Add (does not replace) parameters for `$N` placeholder values.
312 * @param {Array} parameters
315 params: function ( parameters
) {
317 for ( i
= 0; i
< parameters
.length
; i
++ ) {
318 this.parameters
.push( parameters
[ i
] );
324 * Convert message object to its string form based on current format.
326 * @return {string} Message as a string in the current form, or `<key>` if key
329 toString: function () {
332 if ( !this.exists() ) {
333 // Use ⧼key⧽ as text if key does not exist
334 // Err on the side of safety, ensure that the output
335 // is always html safe in the event the message key is
336 // missing, since in that case its highly likely the
337 // message key is user-controlled.
338 // '⧼' is used instead of '<' to side-step any
339 // double-escaping issues.
340 // (Keep synchronised with Message::toString() in PHP.)
341 return '⧼' + mw
.html
.escape( this.key
) + '⧽';
344 if ( this.format
=== 'plain' || this.format
=== 'text' || this.format
=== 'parse' ) {
345 text
= this.parser();
348 if ( this.format
=== 'escaped' ) {
349 text
= this.parser();
350 text
= mw
.html
.escape( text
);
357 * Change format to 'parse' and convert message to string
359 * If jqueryMsg is loaded, this parses the message text from wikitext
360 * (where supported) to HTML
362 * Otherwise, it is equivalent to plain.
364 * @return {string} String form of parsed message
367 this.format
= 'parse';
368 return this.toString();
372 * Change format to 'plain' and convert message to string
374 * This substitutes parameters, but otherwise does not change the
377 * @return {string} String form of plain message
380 this.format
= 'plain';
381 return this.toString();
385 * Change format to 'text' and convert message to string
387 * If jqueryMsg is loaded, {{-transformation is done where supported
388 * (such as {{plural:}}, {{gender:}}, {{int:}}).
390 * Otherwise, it is equivalent to plain
392 * @return {string} String form of text message
395 this.format
= 'text';
396 return this.toString();
400 * Change the format to 'escaped' and convert message to string
402 * This is equivalent to using the 'text' format (see #text), then
403 * HTML-escaping the output.
405 * @return {string} String form of html escaped message
407 escaped: function () {
408 this.format
= 'escaped';
409 return this.toString();
413 * Check if a message exists
418 exists: function () {
419 return this.map
.exists( this.key
);
425 /* eslint-disable no-console */
426 log
= ( function () {
428 * Write a verbose message to the browser's console in debug mode.
430 * This method is mainly intended for verbose logging. It is a no-op in production mode.
431 * In ResourceLoader debug mode, it will use the browser's console if available, with
432 * fallback to creating a console interface in the DOM and logging messages there.
434 * See {@link mw.log} for other logging methods.
437 * @param {...string} msg Messages to output to console.
439 var log = function () {},
440 console
= window
.console
;
442 // Note: Keep list of methods in sync with restoration in mediawiki.log.js
443 // when adding or removing mw.log methods below!
446 * Collection of methods to help log messages to the console.
453 * Write a message to the browser console's warning channel.
455 * This method is a no-op in browsers that don't implement the Console API.
457 * @param {...string} msg Messages to output to console
459 log
.warn
= console
&& console
.warn
&& Function
.prototype.bind
?
460 Function
.prototype.bind
.call( console
.warn
, console
) :
464 * Write a message to the browser console's error channel.
466 * Most browsers also print a stacktrace when calling this method if the
467 * argument is an Error object.
469 * This method is a no-op in browsers that don't implement the Console API.
472 * @param {Error|...string} msg Messages to output to console
474 log
.error
= console
&& console
.error
&& Function
.prototype.bind
?
475 Function
.prototype.bind
.call( console
.error
, console
) :
479 * Create a property on a host object that, when accessed, will produce
480 * a deprecation warning in the console.
482 * @param {Object} obj Host object of deprecated property
483 * @param {string} key Name of property to create in `obj`
484 * @param {Mixed} val The value this property should return when accessed
485 * @param {string} [msg] Optional text to include in the deprecation message
486 * @param {string} [logName=key] Optional custom name for the feature.
487 * This is used instead of `key` in the message and `mw.deprecate` tracking.
489 log
.deprecate
= !Object
.defineProperty
? function ( obj
, key
, val
) {
491 } : function ( obj
, key
, val
, msg
, logName
) {
492 var logged
= new StringSet();
493 logName
= logName
|| key
;
494 msg
= 'Use of "' + logName
+ '" is deprecated.' + ( msg
? ( ' ' + msg
) : '' );
495 function uniqueTrace() {
496 var trace
= new Error().stack
;
497 if ( logged
.has( trace
) ) {
503 // Support: Safari 5.0
504 // Throws "not supported on DOM Objects" for Node or Element objects (incl. document)
505 // Safari 4.0 doesn't have this method, and it was fixed in Safari 5.1.
507 Object
.defineProperty( obj
, key
, {
511 if ( uniqueTrace() ) {
512 mw
.track( 'mw.deprecate', logName
);
517 set: function ( newVal
) {
518 if ( uniqueTrace() ) {
519 mw
.track( 'mw.deprecate', logName
);
532 /* eslint-enable no-console */
538 redefineFallbacksForTest: function () {
539 if ( !window
.QUnit
) {
540 throw new Error( 'Reset not allowed outside unit tests' );
546 * Get the current time, measured in milliseconds since January 1, 1970 (UTC).
548 * On browsers that implement the Navigation Timing API, this function will produce floating-point
549 * values with microsecond precision that are guaranteed to be monotonic. On all other browsers,
550 * it will fall back to using `Date`.
552 * @return {number} Current time
555 // mwNow is defined in startup.js
558 * Format a string. Replace $1, $2 ... $N with positional arguments.
560 * Used by Message#parser().
563 * @param {string} formatString Format string
564 * @param {...Mixed} parameters Values for $N replacements
565 * @return {string} Formatted string
567 format: function ( formatString
) {
568 var parameters
= slice
.call( arguments
, 1 );
569 return formatString
.replace( /\$(\d+)/g, function ( str
, match
) {
570 var index
= parseInt( match
, 10 ) - 1;
571 return parameters
[ index
] !== undefined ? parameters
[ index
] : '$' + match
;
576 * Track an analytic event.
578 * This method provides a generic means for MediaWiki JavaScript code to capture state
579 * information for analysis. Each logged event specifies a string topic name that describes
580 * the kind of event that it is. Topic names consist of dot-separated path components,
581 * arranged from most general to most specific. Each path component should have a clear and
582 * well-defined purpose.
584 * Data handlers are registered via `mw.trackSubscribe`, and receive the full set of
585 * events that match their subcription, including those that fired before the handler was
588 * @param {string} topic Topic name
589 * @param {Object} [data] Data describing the event, encoded as an object
591 track: function ( topic
, data
) {
592 trackQueue
.push( { topic
: topic
, timeStamp
: mw
.now(), data
: data
} );
593 trackCallbacks
.fire( trackQueue
);
597 * Register a handler for subset of analytic events, specified by topic.
599 * Handlers will be called once for each tracked event, including any events that fired before the
600 * handler was registered; 'this' is set to a plain object with a 'timeStamp' property indicating
601 * the exact time at which the event fired, a string 'topic' property naming the event, and a
602 * 'data' property which is an object of event-specific data. The event topic and event data are
603 * also passed to the callback as the first and second arguments, respectively.
605 * @param {string} topic Handle events whose name starts with this string prefix
606 * @param {Function} callback Handler to call for each matching tracked event
607 * @param {string} callback.topic
608 * @param {Object} [callback.data]
610 trackSubscribe: function ( topic
, callback
) {
612 function handler( trackQueue
) {
614 for ( ; seen
< trackQueue
.length
; seen
++ ) {
615 event
= trackQueue
[ seen
];
616 if ( event
.topic
.indexOf( topic
) === 0 ) {
617 callback
.call( event
, event
.topic
, event
.data
);
622 trackHandlers
.push( [ handler
, callback
] );
624 trackCallbacks
.add( handler
);
628 * Stop handling events for a particular handler
630 * @param {Function} callback
632 trackUnsubscribe: function ( callback
) {
633 trackHandlers
= trackHandlers
.filter( function ( fns
) {
634 if ( fns
[ 1 ] === callback
) {
635 trackCallbacks
.remove( fns
[ 0 ] );
636 // Ensure the tuple is removed to avoid holding on to closures
643 // Expose Map constructor
646 // Expose Message constructor
650 * Map of configuration values.
652 * Check out [the complete list of configuration values](https://www.mediawiki.org/wiki/Manual:Interface/JavaScript#mw.config)
655 * If `$wgLegacyJavaScriptGlobals` is true, this Map will add its values to the
656 * global `window` object.
658 * @property {mw.Map} config
660 // Dummy placeholder later assigned in ResourceLoaderStartUpModule
664 * Empty object for third-party libraries, for cases where you don't
665 * want to add a new global, or the global is bad and needs containment
673 * Access container for deprecated functionality that can be moved from
674 * from their legacy location and attached to this object (e.g. a global
675 * function that is deprecated and as stop-gap can be exposed through here).
677 * This was reserved for future use but never ended up being used.
679 * @deprecated since 1.22 Let deprecated identifiers keep their original name
680 * and use mw.log#deprecate to create an access container for tracking.
686 * Store for messages.
693 * Store for templates associated with a module.
697 templates
: new Map(),
700 * Get a message object.
702 * Shortcut for `new mw.Message( mw.messages, key, parameters )`.
705 * @param {string} key Key of message to get
706 * @param {...Mixed} parameters Values for $N replacements
707 * @return {mw.Message}
709 message: function ( key
) {
710 var parameters
= slice
.call( arguments
, 1 );
711 return new Message( mw
.messages
, key
, parameters
);
715 * Get a message string using the (default) 'text' format.
717 * Shortcut for `mw.message( key, parameters... ).text()`.
720 * @param {string} key Key of message to get
721 * @param {...Mixed} parameters Values for $N replacements
725 return mw
.message
.apply( mw
.message
, arguments
).toString();
732 * Client for ResourceLoader server end point.
734 * This client is in charge of maintaining the module registry and state
735 * machine, initiating network (batch) requests for loading modules, as
736 * well as dependency resolution and execution of source code.
738 * For more information, refer to
739 * <https://www.mediawiki.org/wiki/ResourceLoader/Features>
744 loader
: ( function () {
747 * Fired via mw.track on various resource loading errors.
749 * @event resourceloader_exception
750 * @param {Error|Mixed} e The error that was thrown. Almost always an Error
751 * object, but in theory module code could manually throw something else, and that
752 * might also end up here.
753 * @param {string} [module] Name of the module which caused the error. Omitted if the
754 * error is not module-related or the module cannot be easily identified due to
756 * @param {string} source Source of the error. Possible values:
758 * - style: stylesheet error (only affects old IE where a special style loading method
760 * - load-callback: exception thrown by user callback
761 * - module-execute: exception thrown by module code
762 * - resolve: failed to sort dependencies for a module in mw.loader.load
763 * - store-eval: could not evaluate module code cached in localStorage
764 * - store-localstorage-init: localStorage or JSON parse error in mw.loader.store.init
765 * - store-localstorage-json: JSON conversion error in mw.loader.store.set
766 * - store-localstorage-update: localStorage or JSON conversion error in mw.loader.store.update
770 * Fired via mw.track on resource loading error conditions.
772 * @event resourceloader_assert
773 * @param {string} source Source of the error. Possible values:
775 * - bug-T59567: failed to cache script due to an Opera function -> string conversion
776 * bug; see <https://phabricator.wikimedia.org/T59567> for details
780 * Mapping of registered modules.
782 * See #implement and #execute for exact details on support for script, style and messages.
788 * // From mw.loader.register()
789 * 'version': '########' (hash)
790 * 'dependencies': ['required.foo', 'bar.also', ...]
791 * 'group': 'somegroup', (or) null
792 * 'source': 'local', (or) 'anotherwiki'
793 * 'skip': 'return !!window.Example', (or) null
794 * 'module': export Object
796 * // Set from execute() or mw.loader.state()
797 * 'state': 'registered', 'loaded', 'loading', 'ready', 'error', or 'missing'
799 * // Optionally added at run-time by mw.loader.implement()
801 * 'script': closure, array of urls, or string
802 * 'style': { ... } (see #execute)
803 * 'messages': { 'key': 'value', ... }
810 * The module is known to the system but not yet required.
811 * Meta data is registered via mw.loader#register. Calls to that method are
812 * generated server-side by the startup module.
814 * The module was required through mw.loader (either directly or as dependency of
815 * another module). The client will fetch module contents from the server.
816 * The contents are then stashed in the registry via mw.loader#implement.
818 * The module has been loaded from the server and stashed via mw.loader#implement.
819 * If the module has no more dependencies in-flight, the module will be executed
820 * immediately. Otherwise execution is deferred, controlled via #handlePending.
822 * The module is being executed.
824 * The module has been successfully executed.
826 * The module (or one of its dependencies) produced an error during execution.
828 * The module was registered client-side and requested, but the server denied knowledge
829 * of the module's existence.
835 // Mapping of sources, keyed by source-id, values are strings.
840 // 'sourceId': 'http://example.org/w/load.php'
845 // For queueModuleScript()
846 handlingPendingRequests
= false,
847 pendingRequests
= [],
849 // List of modules to be loaded
853 * List of callback jobs waiting for modules to be ready.
855 * Jobs are created by #enqueue() and run by #handlePending().
857 * Typically when a job is created for a module, the job's dependencies contain
858 * both the required module and all its recursive dependencies.
863 * 'dependencies': [ module names ],
864 * 'ready': Function callback
865 * 'error': Function callback
868 * @property {Object[]} jobs
874 * For #addEmbeddedCSS() and #addLink()
877 * @property {HTMLElement|null} marker
879 marker
= document
.querySelector( 'meta[name="ResourceLoaderDynamicStyles"]' ),
881 // For addEmbeddedCSS()
883 cssBufferTimer
= null,
885 rAF
= window
.requestAnimationFrame
|| setTimeout
;
888 * Create a new style element and add it to the DOM.
891 * @param {string} text CSS text
892 * @param {Node|null} [nextNode] The element where the style tag
893 * should be inserted before
894 * @return {HTMLElement} Reference to the created style element
896 function newStyleTag( text
, nextNode
) {
897 var el
= document
.createElement( 'style' );
898 el
.appendChild( document
.createTextNode( text
) );
899 if ( nextNode
&& nextNode
.parentNode
) {
900 nextNode
.parentNode
.insertBefore( el
, nextNode
);
902 document
.head
.appendChild( el
);
908 * Add a bit of CSS text to the current browser page.
910 * The CSS will be appended to an existing ResourceLoader-created `<style>` tag
911 * or create a new one based on whether the given `cssText` is safe for extension.
914 * @param {string} [cssText=cssBuffer] If called without cssText,
915 * the internal buffer will be inserted instead.
916 * @param {Function} [callback]
918 function addEmbeddedCSS( cssText
, callback
) {
919 function fireCallbacks() {
921 oldCallbacks
= cssCallbacks
;
922 // Reset cssCallbacks variable so it's not polluted by any calls to
923 // addEmbeddedCSS() from one of the callbacks (T105973)
925 for ( i
= 0; i
< oldCallbacks
.length
; i
++ ) {
931 cssCallbacks
.push( callback
);
934 // Yield once before creating the <style> tag. This lets multiple stylesheets
935 // accumulate into one buffer, allowing us to reduce how often new stylesheets
936 // are inserted in the browser. Appending a stylesheet and waiting for the
937 // browser to repaint is fairly expensive. (T47810)
939 // Don't extend the buffer if the item needs its own stylesheet.
940 // Keywords like `@import` are only valid at the start of a stylesheet (T37562).
941 if ( !cssBuffer
|| cssText
.slice( 0, '@import'.length
) !== '@import' ) {
942 // Linebreak for somewhat distinguishable sections
943 cssBuffer
+= '\n' + cssText
;
944 if ( !cssBufferTimer
) {
945 cssBufferTimer
= rAF( function () {
946 // Wrap in anonymous function that takes no arguments
947 // Support: Firefox < 13
948 // Firefox 12 has non-standard behaviour of passing a number
949 // as first argument to a setTimeout callback.
950 // http://benalman.com/news/2009/07/the-mysterious-firefox-settime/
957 // This is a scheduled flush for the buffer
959 cssBufferTimer
= null;
964 newStyleTag( cssText
, marker
);
971 * @param {Array} modules List of module names
972 * @return {string} Hash of concatenated version hashes.
974 function getCombinedVersion( modules
) {
975 var hashes
= modules
.map( function ( module
) {
976 return registry
[ module
].version
;
978 return fnv132( hashes
.join( '' ) );
982 * Determine whether all dependencies are in state 'ready', which means we may
983 * execute the module or job now.
986 * @param {Array} modules Names of modules to be checked
987 * @return {boolean} True if all modules are in state 'ready', false otherwise
989 function allReady( modules
) {
991 for ( i
= 0; i
< modules
.length
; i
++ ) {
992 if ( mw
.loader
.getState( modules
[ i
] ) !== 'ready' ) {
1000 * Determine whether all dependencies are in state 'ready', which means we may
1001 * execute the module or job now.
1004 * @param {Array} modules Names of modules to be checked
1005 * @return {boolean} True if no modules are in state 'error' or 'missing', false otherwise
1007 function anyFailed( modules
) {
1009 for ( i
= 0; i
< modules
.length
; i
++ ) {
1010 state
= mw
.loader
.getState( modules
[ i
] );
1011 if ( state
=== 'error' || state
=== 'missing' ) {
1019 * A module has entered state 'ready', 'error', or 'missing'. Automatically update
1020 * pending jobs and modules that depend upon this module. If the given module failed,
1021 * propagate the 'error' state up the dependency tree. Otherwise, go ahead and execute
1022 * all jobs/modules now having their dependencies satisfied.
1024 * Jobs that depend on a failed module, will have their error callback ran (if any).
1027 * @param {string} module Name of module that entered one of the states 'ready', 'error', or 'missing'.
1029 function handlePending( module
) {
1030 var j
, job
, hasErrors
, m
, stateChange
;
1032 if ( registry
[ module
].state
=== 'error' || registry
[ module
].state
=== 'missing' ) {
1033 // If the current module failed, mark all dependent modules also as failed.
1034 // Iterate until steady-state to propagate the error state upwards in the
1037 stateChange
= false;
1038 for ( m
in registry
) {
1039 if ( registry
[ m
].state
!== 'error' && registry
[ m
].state
!== 'missing' ) {
1040 if ( anyFailed( registry
[ m
].dependencies
) ) {
1041 registry
[ m
].state
= 'error';
1046 } while ( stateChange
);
1049 // Execute all jobs whose dependencies are either all satisfied or contain at least one failed module.
1050 for ( j
= 0; j
< jobs
.length
; j
++ ) {
1051 hasErrors
= anyFailed( jobs
[ j
].dependencies
);
1052 if ( hasErrors
|| allReady( jobs
[ j
].dependencies
) ) {
1053 // All dependencies satisfied, or some have errors
1055 jobs
.splice( j
, 1 );
1059 if ( typeof job
.error
=== 'function' ) {
1060 job
.error( new Error( 'Module ' + module
+ ' has failed dependencies' ), [ module
] );
1063 if ( typeof job
.ready
=== 'function' ) {
1068 // A user-defined callback raised an exception.
1069 // Swallow it to protect our state machine!
1070 mw
.track( 'resourceloader.exception', { exception
: e
, module
: module
, source
: 'load-callback' } );
1075 if ( registry
[ module
].state
=== 'ready' ) {
1076 // The current module became 'ready'. Set it in the module store, and recursively execute all
1077 // dependent modules that are loaded and now have all dependencies satisfied.
1078 mw
.loader
.store
.set( module
, registry
[ module
] );
1079 for ( m
in registry
) {
1080 if ( registry
[ m
].state
=== 'loaded' && allReady( registry
[ m
].dependencies
) ) {
1088 * Resolve dependencies and detect circular references.
1091 * @param {string} module Name of the top-level module whose dependencies shall be
1092 * resolved and sorted.
1093 * @param {Array} resolved Returns a topological sort of the given module and its
1094 * dependencies, such that later modules depend on earlier modules. The array
1095 * contains the module names. If the array contains already some module names,
1096 * this function appends its result to the pre-existing array.
1097 * @param {StringSet} [unresolved] Used to track the current dependency
1098 * chain, and to report loops in the dependency graph.
1099 * @throws {Error} If any unregistered module or a dependency loop is encountered
1101 function sortDependencies( module
, resolved
, unresolved
) {
1104 if ( !hasOwn
.call( registry
, module
) ) {
1105 throw new Error( 'Unknown dependency: ' + module
);
1108 if ( registry
[ module
].skip
!== null ) {
1109 // eslint-disable-next-line no-new-func
1110 skip
= new Function( registry
[ module
].skip
);
1111 registry
[ module
].skip
= null;
1113 registry
[ module
].skipped
= true;
1114 registry
[ module
].dependencies
= [];
1115 registry
[ module
].state
= 'ready';
1116 handlePending( module
);
1121 if ( resolved
.indexOf( module
) !== -1 ) {
1122 // Module already resolved; nothing to do
1125 // Create unresolved if not passed in
1126 if ( !unresolved
) {
1127 unresolved
= new StringSet();
1129 // Tracks down dependencies
1130 deps
= registry
[ module
].dependencies
;
1131 for ( i
= 0; i
< deps
.length
; i
++ ) {
1132 if ( resolved
.indexOf( deps
[ i
] ) === -1 ) {
1133 if ( unresolved
.has( deps
[ i
] ) ) {
1134 throw new Error( mw
.format(
1135 'Circular reference detected: $1 -> $2',
1141 unresolved
.add( module
);
1142 sortDependencies( deps
[ i
], resolved
, unresolved
);
1145 resolved
.push( module
);
1149 * Get names of module that a module depends on, in their proper dependency order.
1152 * @param {string[]} modules Array of string module names
1153 * @return {Array} List of dependencies, including 'module'.
1154 * @throws {Error} If an unregistered module or a dependency loop is encountered
1156 function resolve( modules
) {
1157 var i
, resolved
= [];
1158 for ( i
= 0; i
< modules
.length
; i
++ ) {
1159 sortDependencies( modules
[ i
], resolved
);
1165 * Like #resolve(), except it will silently ignore modules that
1166 * are missing or have missing dependencies.
1169 * @param {string[]} modules Array of string module names
1170 * @return {Array} List of dependencies.
1172 function resolveStubbornly( modules
) {
1173 var i
, saved
, resolved
= [];
1174 for ( i
= 0; i
< modules
.length
; i
++ ) {
1175 saved
= resolved
.slice();
1177 sortDependencies( modules
[ i
], resolved
);
1179 // This module is unknown or has unknown dependencies.
1180 // Undo any incomplete resolutions made and keep going.
1182 mw
.track( 'resourceloader.exception', {
1192 * Load and execute a script.
1195 * @param {string} src URL to script, will be used as the src attribute in the script tag
1196 * @param {Function} [callback] Callback to run after request resolution
1198 function addScript( src
, callback
) {
1199 var script
= document
.createElement( 'script' );
1201 script
.onload
= script
.onerror = function () {
1202 if ( script
.parentNode
) {
1203 script
.parentNode
.removeChild( script
);
1211 document
.head
.appendChild( script
);
1215 * Queue the loading and execution of a script for a particular module.
1218 * @param {string} src URL of the script
1219 * @param {string} moduleName Name of currently executing module
1220 * @param {Function} callback Callback to run after addScript() resolution
1222 function queueModuleScript( src
, moduleName
, callback
) {
1223 pendingRequests
.push( function () {
1224 if ( hasOwn
.call( registry
, moduleName
) ) {
1225 // Emulate runScript() part of execute()
1226 window
.require
= mw
.loader
.require
;
1227 window
.module
= registry
[ moduleName
].module
;
1229 addScript( src
, function () {
1230 // 'module.exports' should not persist after the file is executed to
1231 // avoid leakage to unrelated code. 'require' should be kept, however,
1232 // as asynchronous access to 'require' is allowed and expected. (T144879)
1233 delete window
.module
;
1235 // Start the next one (if any)
1236 if ( pendingRequests
[ 0 ] ) {
1237 pendingRequests
.shift()();
1239 handlingPendingRequests
= false;
1243 if ( !handlingPendingRequests
&& pendingRequests
[ 0 ] ) {
1244 handlingPendingRequests
= true;
1245 pendingRequests
.shift()();
1250 * Utility function for execute()
1253 * @param {string} [media] Media attribute
1254 * @param {string} url URL
1256 function addLink( media
, url
) {
1257 var el
= document
.createElement( 'link' );
1259 el
.rel
= 'stylesheet';
1260 if ( media
&& media
!== 'all' ) {
1263 // If you end up here from an IE exception "SCRIPT: Invalid property value.",
1264 // see #addEmbeddedCSS, T33676, T43331, and T49277 for details.
1267 if ( marker
&& marker
.parentNode
) {
1268 marker
.parentNode
.insertBefore( el
, marker
);
1270 document
.head
.appendChild( el
);
1276 * @param {string} code JavaScript code
1278 function domEval( code
) {
1279 var script
= document
.createElement( 'script' );
1281 document
.head
.appendChild( script
);
1282 script
.parentNode
.removeChild( script
);
1286 * Executes a loaded module, making it ready to use
1289 * @param {string} module Module name to execute
1291 function execute( module
) {
1292 var key
, value
, media
, i
, urls
, cssHandle
, checkCssHandles
, runScript
,
1293 cssHandlesRegistered
= false;
1295 if ( !hasOwn
.call( registry
, module
) ) {
1296 throw new Error( 'Module has not been registered yet: ' + module
);
1298 if ( registry
[ module
].state
!== 'loaded' ) {
1299 throw new Error( 'Module in state "' + registry
[ module
].state
+ '" may not be executed: ' + module
);
1302 registry
[ module
].state
= 'executing';
1304 runScript = function () {
1305 var script
, markModuleReady
, nestedAddScript
;
1307 script
= registry
[ module
].script
;
1308 markModuleReady = function () {
1309 registry
[ module
].state
= 'ready';
1310 handlePending( module
);
1312 nestedAddScript = function ( arr
, callback
, i
) {
1313 // Recursively call queueModuleScript() in its own callback
1314 // for each element of arr.
1315 if ( i
>= arr
.length
) {
1316 // We're at the end of the array
1321 queueModuleScript( arr
[ i
], module
, function () {
1322 nestedAddScript( arr
, callback
, i
+ 1 );
1327 if ( Array
.isArray( script
) ) {
1328 nestedAddScript( script
, markModuleReady
, 0 );
1329 } else if ( typeof script
=== 'function' ) {
1330 // Pass jQuery twice so that the signature of the closure which wraps
1331 // the script can bind both '$' and 'jQuery'.
1332 script( $, $, mw
.loader
.require
, registry
[ module
].module
);
1335 } else if ( typeof script
=== 'string' ) {
1336 // Site and user modules are legacy scripts that run in the global scope.
1337 // This is transported as a string instead of a function to avoid needing
1338 // to use string manipulation to undo the function wrapper.
1343 // Module without script
1347 // Use mw.track instead of mw.log because these errors are common in production mode
1348 // (e.g. undefined variable), and mw.log is only enabled in debug mode.
1349 registry
[ module
].state
= 'error';
1350 mw
.track( 'resourceloader.exception', { exception
: e
, module
: module
, source
: 'module-execute' } );
1351 handlePending( module
);
1355 // Add localizations to message system
1356 if ( registry
[ module
].messages
) {
1357 mw
.messages
.set( registry
[ module
].messages
);
1360 // Initialise templates
1361 if ( registry
[ module
].templates
) {
1362 mw
.templates
.set( module
, registry
[ module
].templates
);
1365 // Make sure we don't run the scripts until all stylesheet insertions have completed.
1368 checkCssHandles = function () {
1369 // cssHandlesRegistered ensures we don't take off too soon, e.g. when
1370 // one of the cssHandles is fired while we're still creating more handles.
1371 if ( cssHandlesRegistered
&& pending
=== 0 && runScript
) {
1372 if ( module
=== 'user' ) {
1373 // Implicit dependency on the site module. Not real dependency because
1374 // it should run after 'site' regardless of whether it succeeds or fails.
1375 mw
.loader
.using( [ 'site' ] ).always( runScript
);
1379 runScript
= undefined; // Revoke
1382 cssHandle = function () {
1383 var check
= checkCssHandles
;
1385 return function () {
1389 check
= undefined; // Revoke
1395 // Process styles (see also mw.loader.implement)
1396 // * back-compat: { <media>: css }
1397 // * back-compat: { <media>: [url, ..] }
1398 // * { "css": [css, ..] }
1399 // * { "url": { <media>: [url, ..] } }
1400 if ( registry
[ module
].style
) {
1401 for ( key
in registry
[ module
].style
) {
1402 value
= registry
[ module
].style
[ key
];
1405 if ( key
!== 'url' && key
!== 'css' ) {
1406 // Backwards compatibility, key is a media-type
1407 if ( typeof value
=== 'string' ) {
1408 // back-compat: { <media>: css }
1409 // Ignore 'media' because it isn't supported (nor was it used).
1410 // Strings are pre-wrapped in "@media". The media-type was just ""
1411 // (because it had to be set to something).
1412 // This is one of the reasons why this format is no longer used.
1413 addEmbeddedCSS( value
, cssHandle() );
1415 // back-compat: { <media>: [url, ..] }
1421 // Array of css strings in key 'css',
1422 // or back-compat array of urls from media-type
1423 if ( Array
.isArray( value
) ) {
1424 for ( i
= 0; i
< value
.length
; i
++ ) {
1425 if ( key
=== 'bc-url' ) {
1426 // back-compat: { <media>: [url, ..] }
1427 addLink( media
, value
[ i
] );
1428 } else if ( key
=== 'css' ) {
1429 // { "css": [css, ..] }
1430 addEmbeddedCSS( value
[ i
], cssHandle() );
1433 // Not an array, but a regular object
1434 // Array of urls inside media-type key
1435 } else if ( typeof value
=== 'object' ) {
1436 // { "url": { <media>: [url, ..] } }
1437 for ( media
in value
) {
1438 urls
= value
[ media
];
1439 for ( i
= 0; i
< urls
.length
; i
++ ) {
1440 addLink( media
, urls
[ i
] );
1448 cssHandlesRegistered
= true;
1453 * Add one or more modules to the module load queue.
1458 * @param {string|string[]} dependencies Module name or array of string module names
1459 * @param {Function} [ready] Callback to execute when all dependencies are ready
1460 * @param {Function} [error] Callback to execute when any dependency fails
1462 function enqueue( dependencies
, ready
, error
) {
1463 // Allow calling by single module name
1464 if ( typeof dependencies
=== 'string' ) {
1465 dependencies
= [ dependencies
];
1468 // Add ready and error callbacks if they were given
1469 if ( ready
!== undefined || error
!== undefined ) {
1471 // Narrow down the list to modules that are worth waiting for
1472 dependencies
: dependencies
.filter( function ( module
) {
1473 var state
= mw
.loader
.getState( module
);
1474 return state
=== 'registered' || state
=== 'loaded' || state
=== 'loading' || state
=== 'executing';
1481 dependencies
.forEach( function ( module
) {
1482 var state
= mw
.loader
.getState( module
);
1483 // Only queue modules that are still in the initial 'registered' state
1484 // (not ones already loading, ready or error).
1485 if ( state
=== 'registered' && queue
.indexOf( module
) === -1 ) {
1486 // Private modules must be embedded in the page. Don't bother queuing
1487 // these as the server will deny them anyway (T101806).
1488 if ( registry
[ module
].group
=== 'private' ) {
1489 registry
[ module
].state
= 'error';
1490 handlePending( module
);
1493 queue
.push( module
);
1500 function sortQuery( o
) {
1509 for ( key
= 0; key
< a
.length
; key
++ ) {
1510 sorted
[ a
[ key
] ] = o
[ a
[ key
] ];
1516 * Converts a module map of the form `{ foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }`
1517 * to a query string of the form `foo.bar,baz|bar.baz,quux`.
1519 * See `ResourceLoader::makePackedModulesString()` in PHP, of which this is a port.
1520 * On the server, unpacking is done by `ResourceLoaderContext::expandModuleNames()`.
1522 * Note: This is only half of the logic, the other half has to be in #batchRequest(),
1523 * because its implementation needs to keep track of potential string size in order
1524 * to decide when to split the requests due to url size.
1527 * @param {Object} moduleMap Module map
1529 * @return {string} return.str Module query string
1530 * @return {Array} return.list List of module names in matching order
1532 function buildModulesString( moduleMap
) {
1537 function restore( suffix
) {
1541 for ( prefix
in moduleMap
) {
1542 p
= prefix
=== '' ? '' : prefix
+ '.';
1543 str
.push( p
+ moduleMap
[ prefix
].join( ',' ) );
1544 list
.push
.apply( list
, moduleMap
[ prefix
].map( restore
) );
1547 str
: str
.join( '|' ),
1553 * Resolve indexed dependencies.
1555 * ResourceLoader uses an optimization to save space which replaces module names in
1556 * dependency lists with the index of that module within the array of module
1557 * registration data if it exists. The benefit is a significant reduction in the data
1558 * size of the startup module. This function changes those dependency lists back to
1559 * arrays of strings.
1562 * @param {Array} modules Modules array
1564 function resolveIndexedDependencies( modules
) {
1566 function resolveIndex( dep
) {
1567 return typeof dep
=== 'number' ? modules
[ dep
][ 0 ] : dep
;
1569 for ( i
= 0; i
< modules
.length
; i
++ ) {
1570 deps
= modules
[ i
][ 2 ];
1572 for ( j
= 0; j
< deps
.length
; j
++ ) {
1573 deps
[ j
] = resolveIndex( deps
[ j
] );
1580 * Create network requests for a batch of modules.
1582 * This is an internal method for #work(). This must not be called directly
1583 * unless the modules are already registered, and no request is in progress,
1584 * and the module state has already been set to `loading`.
1587 * @param {string[]} batch
1589 function batchRequest( batch
) {
1590 var reqBase
, splits
, maxQueryLength
, b
, bSource
, bGroup
, bSourceGroup
,
1591 source
, group
, i
, modules
, sourceLoadScript
,
1592 currReqBase
, currReqBaseLength
, moduleMap
, currReqModules
, l
,
1593 lastDotIndex
, prefix
, suffix
, bytesAdded
;
1596 * Start the currently drafted request to the server.
1600 function doRequest() {
1601 // Optimisation: Inherit (Object.create), not copy ($.extend)
1602 var query
= Object
.create( currReqBase
),
1603 packed
= buildModulesString( moduleMap
);
1604 query
.modules
= packed
.str
;
1605 // The packing logic can change the effective order, even if the input was
1606 // sorted. As such, the call to getCombinedVersion() must use this
1607 // effective order, instead of currReqModules, as otherwise the combined
1608 // version will not match the hash expected by the server based on
1609 // combining versions from the module query string in-order. (T188076)
1610 query
.version
= getCombinedVersion( packed
.list
);
1611 query
= sortQuery( query
);
1612 addScript( sourceLoadScript
+ '?' + $.param( query
) );
1615 if ( !batch
.length
) {
1619 // Always order modules alphabetically to help reduce cache
1620 // misses for otherwise identical content.
1623 // Query parameters common to all requests
1625 skin
: mw
.config
.get( 'skin' ),
1626 lang
: mw
.config
.get( 'wgUserLanguage' ),
1627 debug
: mw
.config
.get( 'debug' )
1629 maxQueryLength
= mw
.config
.get( 'wgResourceLoaderMaxQueryLength', 2000 );
1631 // Split module list by source and by group.
1633 for ( b
= 0; b
< batch
.length
; b
++ ) {
1634 bSource
= registry
[ batch
[ b
] ].source
;
1635 bGroup
= registry
[ batch
[ b
] ].group
;
1636 if ( !hasOwn
.call( splits
, bSource
) ) {
1637 splits
[ bSource
] = {};
1639 if ( !hasOwn
.call( splits
[ bSource
], bGroup
) ) {
1640 splits
[ bSource
][ bGroup
] = [];
1642 bSourceGroup
= splits
[ bSource
][ bGroup
];
1643 bSourceGroup
.push( batch
[ b
] );
1646 for ( source
in splits
) {
1648 sourceLoadScript
= sources
[ source
];
1650 for ( group
in splits
[ source
] ) {
1652 // Cache access to currently selected list of
1653 // modules for this group from this source.
1654 modules
= splits
[ source
][ group
];
1656 // Query parameters common to requests for this module group
1657 // Optimisation: Inherit (Object.create), not copy ($.extend)
1658 currReqBase
= Object
.create( reqBase
);
1659 // User modules require a user name in the query string.
1660 if ( group
=== 'user' && mw
.config
.get( 'wgUserName' ) !== null ) {
1661 currReqBase
.user
= mw
.config
.get( 'wgUserName' );
1664 // In addition to currReqBase, doRequest() will also add 'modules' and 'version'.
1665 // > '&modules='.length === 9
1666 // > '&version=1234567'.length === 16
1668 currReqBaseLength
= $.param( currReqBase
).length
+ 25;
1670 // We may need to split up the request to honor the query string length limit,
1671 // so build it piece by piece.
1672 l
= currReqBaseLength
;
1673 moduleMap
= {}; // { prefix: [ suffixes ] }
1674 currReqModules
= [];
1676 for ( i
= 0; i
< modules
.length
; i
++ ) {
1677 // Determine how many bytes this module would add to the query string
1678 lastDotIndex
= modules
[ i
].lastIndexOf( '.' );
1679 // If lastDotIndex is -1, substr() returns an empty string
1680 prefix
= modules
[ i
].substr( 0, lastDotIndex
);
1681 suffix
= modules
[ i
].slice( lastDotIndex
+ 1 );
1682 bytesAdded
= hasOwn
.call( moduleMap
, prefix
) ?
1683 suffix
.length
+ 3 : // '%2C'.length == 3
1684 modules
[ i
].length
+ 3; // '%7C'.length == 3
1686 // If the url would become too long, create a new one, but don't create empty requests
1687 if ( maxQueryLength
> 0 && currReqModules
.length
&& l
+ bytesAdded
> maxQueryLength
) {
1688 // Dispatch what we've got...
1690 // .. and start again.
1691 l
= currReqBaseLength
;
1693 currReqModules
= [];
1695 mw
.track( 'resourceloader.splitRequest', { maxQueryLength
: maxQueryLength
} );
1697 if ( !hasOwn
.call( moduleMap
, prefix
) ) {
1698 moduleMap
[ prefix
] = [];
1701 moduleMap
[ prefix
].push( suffix
);
1702 currReqModules
.push( modules
[ i
] );
1704 // If there's anything left in moduleMap, request that too
1705 if ( currReqModules
.length
) {
1714 * @param {string[]} implementations Array containing pieces of JavaScript code in the
1715 * form of calls to mw.loader#implement().
1716 * @param {Function} cb Callback in case of failure
1717 * @param {Error} cb.err
1719 function asyncEval( implementations
, cb
) {
1720 if ( !implementations
.length
) {
1723 mw
.requestIdleCallback( function () {
1725 domEval( implementations
.join( ';' ) );
1733 * Make a versioned key for a specific module.
1736 * @param {string} module Module name
1737 * @return {string|null} Module key in format '`[name]@[version]`',
1738 * or null if the module does not exist
1740 function getModuleKey( module
) {
1741 return hasOwn
.call( registry
, module
) ?
1742 ( module
+ '@' + registry
[ module
].version
) : null;
1747 * @param {string} key Module name or '`[name]@[version]`'
1750 function splitModuleKey( key
) {
1751 var index
= key
.indexOf( '@' );
1752 if ( index
=== -1 ) {
1759 name
: key
.slice( 0, index
),
1760 version
: key
.slice( index
+ 1 )
1764 /* Public Members */
1767 * The module registry is exposed as an aid for debugging and inspecting page
1768 * state; it is not a public interface for modifying the registry.
1774 moduleRegistry
: registry
,
1777 * @inheritdoc #newStyleTag
1780 addStyleTag
: newStyleTag
,
1783 * Start loading of all queued module dependencies.
1788 var q
, batch
, implementations
, sourceModules
;
1792 // Appends a list of modules from the queue to the batch
1793 for ( q
= 0; q
< queue
.length
; q
++ ) {
1794 // Only load modules which are registered
1795 if ( hasOwn
.call( registry
, queue
[ q
] ) && registry
[ queue
[ q
] ].state
=== 'registered' ) {
1796 // Prevent duplicate entries
1797 if ( batch
.indexOf( queue
[ q
] ) === -1 ) {
1798 batch
.push( queue
[ q
] );
1799 // Mark registered modules as loading
1800 registry
[ queue
[ q
] ].state
= 'loading';
1805 // Now that the queue has been processed into a batch, clear the queue.
1806 // This MUST happen before we initiate any eval or network request. Otherwise,
1807 // it is possible for a cached script to instantly trigger the same work queue
1808 // again; all before we've cleared it causing each request to include modules
1809 // which are already loaded.
1812 if ( !batch
.length
) {
1816 mw
.loader
.store
.init();
1817 if ( mw
.loader
.store
.enabled
) {
1818 implementations
= [];
1820 batch
= batch
.filter( function ( module
) {
1821 var implementation
= mw
.loader
.store
.get( module
);
1822 if ( implementation
) {
1823 implementations
.push( implementation
);
1824 sourceModules
.push( module
);
1829 asyncEval( implementations
, function ( err
) {
1831 // Not good, the cached mw.loader.implement calls failed! This should
1832 // never happen, barring ResourceLoader bugs, browser bugs and PEBKACs.
1833 // Depending on how corrupt the string is, it is likely that some
1834 // modules' implement() succeeded while the ones after the error will
1835 // never run and leave their modules in the 'loading' state forever.
1836 mw
.loader
.store
.stats
.failed
++;
1838 // Since this is an error not caused by an individual module but by
1839 // something that infected the implement call itself, don't take any
1840 // risks and clear everything in this cache.
1841 mw
.loader
.store
.clear();
1843 mw
.track( 'resourceloader.exception', { exception
: err
, source
: 'store-eval' } );
1844 // Re-add the failed ones that are still pending back to the batch
1845 failed
= sourceModules
.filter( function ( module
) {
1846 return registry
[ module
].state
=== 'loading';
1848 batchRequest( failed
);
1852 batchRequest( batch
);
1856 * Register a source.
1858 * The #work() method will use this information to split up requests by source.
1860 * mw.loader.addSource( 'mediawikiwiki', '//www.mediawiki.org/w/load.php' );
1862 * @param {string|Object} id Source ID, or object mapping ids to load urls
1863 * @param {string} loadUrl Url to a load.php end point
1864 * @throws {Error} If source id is already registered
1866 addSource: function ( id
, loadUrl
) {
1868 // Allow multiple additions
1869 if ( typeof id
=== 'object' ) {
1870 for ( source
in id
) {
1871 mw
.loader
.addSource( source
, id
[ source
] );
1876 if ( hasOwn
.call( sources
, id
) ) {
1877 throw new Error( 'source already registered: ' + id
);
1880 sources
[ id
] = loadUrl
;
1884 * Register a module, letting the system know about it and its properties.
1886 * The startup modules contain calls to this method.
1888 * When using multiple module registration by passing an array, dependencies that
1889 * are specified as references to modules within the array will be resolved before
1890 * the modules are registered.
1892 * @param {string|Array} module Module name or array of arrays, each containing
1893 * a list of arguments compatible with this method
1894 * @param {string|number} version Module version hash (falls backs to empty string)
1895 * Can also be a number (timestamp) for compatibility with MediaWiki 1.25 and earlier.
1896 * @param {string|Array} dependencies One string or array of strings of module
1897 * names on which this module depends.
1898 * @param {string} [group=null] Group which the module is in
1899 * @param {string} [source='local'] Name of the source
1900 * @param {string} [skip=null] Script body of the skip function
1902 register: function ( module
, version
, dependencies
, group
, source
, skip
) {
1904 // Allow multiple registration
1905 if ( typeof module
=== 'object' ) {
1906 resolveIndexedDependencies( module
);
1907 for ( i
= 0; i
< module
.length
; i
++ ) {
1908 // module is an array of module names
1909 if ( typeof module
[ i
] === 'string' ) {
1910 mw
.loader
.register( module
[ i
] );
1911 // module is an array of arrays
1912 } else if ( typeof module
[ i
] === 'object' ) {
1913 mw
.loader
.register
.apply( mw
.loader
, module
[ i
] );
1918 if ( hasOwn
.call( registry
, module
) ) {
1919 throw new Error( 'module already registered: ' + module
);
1921 if ( typeof dependencies
=== 'string' ) {
1922 // A single module name
1923 deps
= [ dependencies
];
1924 } else if ( typeof dependencies
=== 'object' ) {
1925 // Array of module names
1926 deps
= dependencies
;
1928 // List the module as registered
1929 registry
[ module
] = {
1930 // Exposed to execute() for mw.loader.implement() closures.
1931 // Import happens via require().
1935 version
: version
!== undefined ? String( version
) : '',
1936 dependencies
: deps
|| [],
1937 group
: typeof group
=== 'string' ? group
: null,
1938 source
: typeof source
=== 'string' ? source
: 'local',
1939 state
: 'registered',
1940 skip
: typeof skip
=== 'string' ? skip
: null
1945 * Implement a module given the components that make up the module.
1947 * When #load() or #using() requests one or more modules, the server
1948 * response contain calls to this function.
1950 * @param {string} module Name of module and current module version. Formatted
1951 * as '`[name]@[version]`". This version should match the requested version
1952 * (from #batchRequest and #registry). This avoids race conditions (T117587).
1953 * For back-compat with MediaWiki 1.27 and earlier, the version may be omitted.
1954 * @param {Function|Array|string} [script] Function with module code, list of URLs
1955 * to load via `<script src>`, or string of module code for `$.globalEval()`.
1956 * @param {Object} [style] Should follow one of the following patterns:
1958 * { "css": [css, ..] }
1959 * { "url": { <media>: [url, ..] } }
1961 * And for backwards compatibility (needs to be supported forever due to caching):
1964 * { <media>: [url, ..] }
1966 * The reason css strings are not concatenated anymore is T33676. We now check
1967 * whether it's safe to extend the stylesheet.
1970 * @param {Object} [messages] List of key/value pairs to be added to mw#messages.
1971 * @param {Object} [templates] List of key/value pairs to be added to mw#templates.
1973 implement: function ( module
, script
, style
, messages
, templates
) {
1974 var split
= splitModuleKey( module
),
1976 version
= split
.version
;
1977 // Automatically register module
1978 if ( !hasOwn
.call( registry
, name
) ) {
1979 mw
.loader
.register( name
);
1981 // Check for duplicate implementation
1982 if ( hasOwn
.call( registry
, name
) && registry
[ name
].script
!== undefined ) {
1983 throw new Error( 'module already implemented: ' + name
);
1986 // Without this reset, if there is a version mismatch between the
1987 // requested and received module version, then mw.loader.store would
1988 // cache the response under the requested key. Thus poisoning the cache
1989 // indefinitely with a stale value. (T117587)
1990 registry
[ name
].version
= version
;
1992 // Attach components
1993 registry
[ name
].script
= script
|| null;
1994 registry
[ name
].style
= style
|| null;
1995 registry
[ name
].messages
= messages
|| null;
1996 registry
[ name
].templates
= templates
|| null;
1997 // The module may already have been marked as erroneous
1998 if ( registry
[ name
].state
!== 'error' && registry
[ name
].state
!== 'missing' ) {
1999 registry
[ name
].state
= 'loaded';
2000 if ( allReady( registry
[ name
].dependencies
) ) {
2007 * Execute a function as soon as one or more required modules are ready.
2009 * Example of inline dependency on OOjs:
2011 * mw.loader.using( 'oojs', function () {
2012 * OO.compare( [ 1 ], [ 1 ] );
2015 * Example of inline dependency obtained via `require()`:
2017 * mw.loader.using( [ 'mediawiki.util' ], function ( require ) {
2018 * var util = require( 'mediawiki.util' );
2021 * Since MediaWiki 1.23 this also returns a promise.
2023 * Since MediaWiki 1.28 the promise is resolved with a `require` function.
2025 * @param {string|Array} dependencies Module name or array of modules names the
2026 * callback depends on to be ready before executing
2027 * @param {Function} [ready] Callback to execute when all dependencies are ready
2028 * @param {Function} [error] Callback to execute if one or more dependencies failed
2029 * @return {jQuery.Promise} With a `require` function
2031 using: function ( dependencies
, ready
, error
) {
2032 var deferred
= $.Deferred();
2034 // Allow calling with a single dependency as a string
2035 if ( typeof dependencies
=== 'string' ) {
2036 dependencies
= [ dependencies
];
2040 deferred
.done( ready
);
2043 deferred
.fail( error
);
2047 // Resolve entire dependency map
2048 dependencies
= resolve( dependencies
);
2050 return deferred
.reject( e
).promise();
2052 if ( allReady( dependencies
) ) {
2053 // Run ready immediately
2054 deferred
.resolve( mw
.loader
.require
);
2055 } else if ( anyFailed( dependencies
) ) {
2056 // Execute error immediately if any dependencies have errors
2058 new Error( 'One or more dependencies failed to load' ),
2062 // Not all dependencies are ready, add to the load queue
2063 enqueue( dependencies
, function () {
2064 deferred
.resolve( mw
.loader
.require
);
2065 }, deferred
.reject
);
2068 return deferred
.promise();
2072 * Load an external script or one or more modules.
2074 * This method takes a list of unrelated modules. Use cases:
2076 * - A web page will be composed of many different widgets. These widgets independently
2077 * queue their ResourceLoader modules (`OutputPage::addModules()`). If any of them
2078 * have problems, or are no longer known (e.g. cached HTML), the other modules
2079 * should still be loaded.
2080 * - This method is used for preloading, which must not throw. Later code that
2081 * calls #using() will handle the error.
2083 * @param {string|Array} modules Either the name of a module, array of modules,
2084 * or a URL of an external script or style
2085 * @param {string} [type='text/javascript'] MIME type to use if calling with a URL of an
2086 * external script or style; acceptable values are "text/css" and
2087 * "text/javascript"; if no type is provided, text/javascript is assumed.
2089 load: function ( modules
, type
) {
2092 // Allow calling with a url or single dependency as a string
2093 if ( typeof modules
=== 'string' ) {
2094 // "https://example.org/x.js", "http://example.org/x.js", "//example.org/x.js", "/x.js"
2095 if ( /^(https?:)?\/?\//.test( modules
) ) {
2096 if ( type
=== 'text/css' ) {
2097 l
= document
.createElement( 'link' );
2098 l
.rel
= 'stylesheet';
2100 document
.head
.appendChild( l
);
2103 if ( type
=== 'text/javascript' || type
=== undefined ) {
2104 addScript( modules
);
2108 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type
);
2110 // Called with single module
2111 modules
= [ modules
];
2114 // Filter out top-level modules that are unknown or failed to load before.
2115 filtered
= modules
.filter( function ( module
) {
2116 var state
= mw
.loader
.getState( module
);
2117 return state
!== 'error' && state
!== 'missing';
2119 // Resolve remaining list using the known dependency tree.
2120 // This also filters out modules with unknown dependencies. (T36853)
2121 filtered
= resolveStubbornly( filtered
);
2122 // If all modules are ready, or if any modules have errors, nothing to be done.
2123 if ( allReady( filtered
) || anyFailed( filtered
) ) {
2126 if ( filtered
.length
=== 0 ) {
2129 // Some modules are not yet ready, add to module load queue.
2130 enqueue( filtered
, undefined, undefined );
2134 * Change the state of one or more modules.
2136 * @param {string|Object} module Module name or object of module name/state pairs
2137 * @param {string} state State name
2139 state: function ( module
, state
) {
2142 if ( typeof module
=== 'object' ) {
2143 for ( m
in module
) {
2144 mw
.loader
.state( m
, module
[ m
] );
2148 if ( !hasOwn
.call( registry
, module
) ) {
2149 mw
.loader
.register( module
);
2151 registry
[ module
].state
= state
;
2152 if ( state
=== 'ready' || state
=== 'error' || state
=== 'missing' ) {
2153 // Make sure pending modules depending on this one get executed if their
2154 // dependencies are now fulfilled!
2155 handlePending( module
);
2160 * Get the version of a module.
2162 * @param {string} module Name of module
2163 * @return {string|null} The version, or null if the module (or its version) is not
2166 getVersion: function ( module
) {
2167 return hasOwn
.call( registry
, module
) ? registry
[ module
].version
: null;
2171 * Get the state of a module.
2173 * @param {string} module Name of module
2174 * @return {string|null} The state, or null if the module (or its state) is not
2177 getState: function ( module
) {
2178 return hasOwn
.call( registry
, module
) ? registry
[ module
].state
: null;
2182 * Get the names of all registered modules.
2186 getModuleNames: function () {
2187 return Object
.keys( registry
);
2191 * Get the exported value of a module.
2193 * This static method is publicly exposed for debugging purposes
2194 * only and must not be used in production code. In production code,
2195 * please use the dynamically provided `require()` function instead.
2197 * In case of lazy-loaded modules via mw.loader#using(), the returned
2198 * Promise provides the function, see #using() for examples.
2202 * @param {string} moduleName Module name
2203 * @return {Mixed} Exported value
2205 require: function ( moduleName
) {
2206 var state
= mw
.loader
.getState( moduleName
);
2208 // Only ready modules can be required
2209 if ( state
!== 'ready' ) {
2210 // Module may've forgotten to declare a dependency
2211 throw new Error( 'Module "' + moduleName
+ '" is not loaded.' );
2214 return registry
[ moduleName
].module
.exports
;
2218 * @inheritdoc mw.inspect#runReports
2221 inspect: function () {
2222 var args
= slice
.call( arguments
);
2223 mw
.loader
.using( 'mediawiki.inspect', function () {
2224 mw
.inspect
.runReports
.apply( mw
.inspect
, args
);
2229 * On browsers that implement the localStorage API, the module store serves as a
2230 * smart complement to the browser cache. Unlike the browser cache, the module store
2231 * can slice a concatenated response from ResourceLoader into its constituent
2232 * modules and cache each of them separately, using each module's versioning scheme
2233 * to determine when the cache should be invalidated.
2236 * @class mw.loader.store
2239 // Whether the store is in use on this page.
2242 // Modules whose string representation exceeds 100 kB are
2243 // ineligible for storage. See bug T66721.
2244 MODULE_SIZE_MAX
: 100 * 1000,
2246 // The contents of the store, mapping '[name]@[version]' keys
2247 // to module implementations.
2251 stats
: { hits
: 0, misses
: 0, expired
: 0, failed
: 0 },
2254 * Construct a JSON-serializable object representing the content of the store.
2256 * @return {Object} Module store contents.
2258 toJSON: function () {
2259 return { items
: mw
.loader
.store
.items
, vary
: mw
.loader
.store
.getVary() };
2263 * Get the localStorage key for the entire module store. The key references
2264 * $wgDBname to prevent clashes between wikis which share a common host.
2266 * @return {string} localStorage item key
2268 getStoreKey: function () {
2269 return 'MediaWikiModuleStore:' + mw
.config
.get( 'wgDBname' );
2273 * Get a key on which to vary the module cache.
2275 * @return {string} String of concatenated vary conditions.
2277 getVary: function () {
2279 mw
.config
.get( 'skin' ),
2280 mw
.config
.get( 'wgResourceLoaderStorageVersion' ),
2281 mw
.config
.get( 'wgUserLanguage' )
2286 * Initialize the store.
2288 * Retrieves store from localStorage and (if successfully retrieved) decoding
2289 * the stored JSON value to a plain object.
2291 * The try / catch block is used for JSON & localStorage feature detection.
2292 * See the in-line documentation for Modernizr's localStorage feature detection
2293 * code for a full account of why we need a try / catch:
2294 * <https://github.com/Modernizr/Modernizr/blob/v2.7.1/modernizr.js#L771-L796>.
2299 if ( mw
.loader
.store
.enabled
!== null ) {
2305 // Disabled because localStorage quotas are tight and (in Firefox's case)
2306 // shared by multiple origins.
2307 // See T66721, and <https://bugzilla.mozilla.org/show_bug.cgi?id=1064466>.
2308 /Firefox|Opera/.test( navigator
.userAgent
) ||
2310 // Disabled by configuration.
2311 !mw
.config
.get( 'wgResourceLoaderStorageEnabled' )
2313 // Clear any previous store to free up space. (T66721)
2314 mw
.loader
.store
.clear();
2315 mw
.loader
.store
.enabled
= false;
2318 if ( mw
.config
.get( 'debug' ) ) {
2319 // Disable module store in debug mode
2320 mw
.loader
.store
.enabled
= false;
2325 raw
= localStorage
.getItem( mw
.loader
.store
.getStoreKey() );
2326 // If we get here, localStorage is available; mark enabled
2327 mw
.loader
.store
.enabled
= true;
2328 data
= JSON
.parse( raw
);
2329 if ( data
&& typeof data
.items
=== 'object' && data
.vary
=== mw
.loader
.store
.getVary() ) {
2330 mw
.loader
.store
.items
= data
.items
;
2334 mw
.track( 'resourceloader.exception', { exception
: e
, source
: 'store-localstorage-init' } );
2337 if ( raw
=== undefined ) {
2338 // localStorage failed; disable store
2339 mw
.loader
.store
.enabled
= false;
2341 mw
.loader
.store
.update();
2346 * Retrieve a module from the store and update cache hit stats.
2348 * @param {string} module Module name
2349 * @return {string|boolean} Module implementation or false if unavailable
2351 get: function ( module
) {
2354 if ( !mw
.loader
.store
.enabled
) {
2358 key
= getModuleKey( module
);
2359 if ( key
in mw
.loader
.store
.items
) {
2360 mw
.loader
.store
.stats
.hits
++;
2361 return mw
.loader
.store
.items
[ key
];
2363 mw
.loader
.store
.stats
.misses
++;
2368 * Stringify a module and queue it for storage.
2370 * @param {string} module Module name
2371 * @param {Object} descriptor The module's descriptor as set in the registry
2372 * @return {boolean} Module was set
2374 set: function ( module
, descriptor
) {
2377 if ( !mw
.loader
.store
.enabled
) {
2381 key
= getModuleKey( module
);
2384 // Already stored a copy of this exact version
2385 key
in mw
.loader
.store
.items
||
2386 // Module failed to load
2387 descriptor
.state
!== 'ready' ||
2388 // Unversioned, private, or site-/user-specific
2389 !descriptor
.version
||
2390 descriptor
.group
=== 'private' ||
2391 descriptor
.group
=== 'user' ||
2392 // Partial descriptor
2393 // (e.g. skipped module, or style module with state=ready)
2394 [ descriptor
.script
, descriptor
.style
, descriptor
.messages
,
2395 descriptor
.templates
].indexOf( undefined ) !== -1
2403 JSON
.stringify( key
),
2404 typeof descriptor
.script
=== 'function' ?
2405 String( descriptor
.script
) :
2406 JSON
.stringify( descriptor
.script
),
2407 JSON
.stringify( descriptor
.style
),
2408 JSON
.stringify( descriptor
.messages
),
2409 JSON
.stringify( descriptor
.templates
)
2411 // Attempted workaround for a possible Opera bug (bug T59567).
2412 // This regex should never match under sane conditions.
2413 if ( /^\s*\(/.test( args
[ 1 ] ) ) {
2414 args
[ 1 ] = 'function' + args
[ 1 ];
2415 mw
.track( 'resourceloader.assert', { source
: 'bug-T59567' } );
2418 mw
.track( 'resourceloader.exception', { exception
: e
, source
: 'store-localstorage-json' } );
2422 src
= 'mw.loader.implement(' + args
.join( ',' ) + ');';
2423 if ( src
.length
> mw
.loader
.store
.MODULE_SIZE_MAX
) {
2426 mw
.loader
.store
.items
[ key
] = src
;
2427 mw
.loader
.store
.update();
2432 * Iterate through the module store, removing any item that does not correspond
2433 * (in name and version) to an item in the module registry.
2435 * @return {boolean} Store was pruned
2437 prune: function () {
2440 if ( !mw
.loader
.store
.enabled
) {
2444 for ( key
in mw
.loader
.store
.items
) {
2445 module
= key
.slice( 0, key
.indexOf( '@' ) );
2446 if ( getModuleKey( module
) !== key
) {
2447 mw
.loader
.store
.stats
.expired
++;
2448 delete mw
.loader
.store
.items
[ key
];
2449 } else if ( mw
.loader
.store
.items
[ key
].length
> mw
.loader
.store
.MODULE_SIZE_MAX
) {
2450 // This value predates the enforcement of a size limit on cached modules.
2451 delete mw
.loader
.store
.items
[ key
];
2458 * Clear the entire module store right now.
2460 clear: function () {
2461 mw
.loader
.store
.items
= {};
2463 localStorage
.removeItem( mw
.loader
.store
.getStoreKey() );
2464 } catch ( ignored
) {}
2468 * Sync in-memory store back to localStorage.
2470 * This function debounces updates. When called with a flush already pending,
2471 * the call is coalesced into the pending update. The call to
2472 * localStorage.setItem will be naturally deferred until the page is quiescent.
2474 * Because localStorage is shared by all pages from the same origin, if multiple
2475 * pages are loaded with different module sets, the possibility exists that
2476 * modules saved by one page will be clobbered by another. But the impact would
2477 * be minor and the problem would be corrected by subsequent page views.
2481 update
: ( function () {
2482 var hasPendingWrite
= false;
2484 function flushWrites() {
2486 if ( !hasPendingWrite
|| !mw
.loader
.store
.enabled
) {
2490 mw
.loader
.store
.prune();
2491 key
= mw
.loader
.store
.getStoreKey();
2493 // Replacing the content of the module store might fail if the new
2494 // contents would exceed the browser's localStorage size limit. To
2495 // avoid clogging the browser with stale data, always remove the old
2496 // value before attempting to set the new one.
2497 localStorage
.removeItem( key
);
2498 data
= JSON
.stringify( mw
.loader
.store
);
2499 localStorage
.setItem( key
, data
);
2501 mw
.track( 'resourceloader.exception', { exception
: e
, source
: 'store-localstorage-update' } );
2504 hasPendingWrite
= false;
2507 return function () {
2508 if ( !hasPendingWrite
) {
2509 hasPendingWrite
= true;
2510 mw
.requestIdleCallback( flushWrites
);
2519 * HTML construction helper functions
2526 * output = Html.element( 'div', {}, new Html.Raw(
2527 * Html.element( 'img', { src: '<' } )
2529 * mw.log( output ); // <div><img src="<"/></div>
2534 html
: ( function () {
2535 function escapeCallback( s
) {
2552 * Escape a string for HTML.
2554 * Converts special characters to HTML entities.
2556 * mw.html.escape( '< > \' & "' );
2557 * // Returns < > ' & "
2559 * @param {string} s The string to escape
2560 * @return {string} HTML
2562 escape: function ( s
) {
2563 return s
.replace( /['"<>&]/g, escapeCallback
);
2567 * Create an HTML element string, with safe escaping.
2569 * @param {string} name The tag name.
2570 * @param {Object} [attrs] An object with members mapping element names to values
2571 * @param {string|mw.html.Raw|mw.html.Cdata|null} [contents=null] The contents of the element.
2573 * - string: Text to be escaped.
2574 * - null: The element is treated as void with short closing form, e.g. `<br/>`.
2575 * - this.Raw: The raw value is directly included.
2576 * - this.Cdata: The raw value is directly included. An exception is
2577 * thrown if it contains any illegal ETAGO delimiter.
2578 * See <https://www.w3.org/TR/html401/appendix/notes.html#h-B.3.2>.
2579 * @return {string} HTML
2581 element: function ( name
, attrs
, contents
) {
2582 var v
, attrName
, s
= '<' + name
;
2585 for ( attrName
in attrs
) {
2586 v
= attrs
[ attrName
];
2587 // Convert name=true, to name=name
2591 } else if ( v
=== false ) {
2594 s
+= ' ' + attrName
+ '="' + this.escape( String( v
) ) + '"';
2597 if ( contents
=== undefined || contents
=== null ) {
2604 switch ( typeof contents
) {
2607 s
+= this.escape( contents
);
2611 // Convert to string
2612 s
+= String( contents
);
2615 if ( contents
instanceof this.Raw
) {
2616 // Raw HTML inclusion
2617 s
+= contents
.value
;
2618 } else if ( contents
instanceof this.Cdata
) {
2620 if ( /<\/[a-zA-z]/.test( contents
.value
) ) {
2621 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
2623 s
+= contents
.value
;
2625 throw new Error( 'mw.html.element: Invalid type of contents' );
2628 s
+= '</' + name
+ '>';
2633 * Wrapper object for raw HTML passed to mw.html.element().
2635 * @class mw.html.Raw
2637 * @param {string} value
2639 Raw: function ( value
) {
2644 * Wrapper object for CDATA element contents passed to mw.html.element()
2646 * @class mw.html.Cdata
2648 * @param {string} value
2650 Cdata: function ( value
) {
2656 // Skeleton user object, extended by the 'mediawiki.user' module.
2663 * @property {mw.Map}
2667 * @property {mw.Map}
2672 // OOUI widgets specific to MediaWiki
2676 * Registry and firing of events.
2678 * MediaWiki has various interface components that are extended, enhanced
2679 * or manipulated in some other way by extensions, gadgets and even
2682 * This framework helps streamlining the timing of when these other
2683 * code paths fire their plugins (instead of using document-ready,
2684 * which can and should be limited to firing only once).
2686 * Features like navigating to other wiki pages, previewing an edit
2687 * and editing itself – without a refresh – can then retrigger these
2688 * hooks accordingly to ensure everything still works as expected.
2692 * mw.hook( 'wikipage.content' ).add( fn ).remove( fn );
2693 * mw.hook( 'wikipage.content' ).fire( $content );
2695 * Handlers can be added and fired for arbitrary event names at any time. The same
2696 * event can be fired multiple times. The last run of an event is memorized
2697 * (similar to `$(document).ready` and `$.Deferred().done`).
2698 * This means if an event is fired, and a handler added afterwards, the added
2699 * function will be fired right away with the last given event data.
2701 * Like Deferreds and Promises, the mw.hook object is both detachable and chainable.
2702 * Thus allowing flexible use and optimal maintainability and authority control.
2703 * You can pass around the `add` and/or `fire` method to another piece of code
2704 * without it having to know the event name (or `mw.hook` for that matter).
2706 * var h = mw.hook( 'bar.ready' );
2707 * new mw.Foo( .. ).fetch( { callback: h.fire } );
2709 * Note: Events are documented with an underscore instead of a dot in the event
2710 * name due to jsduck not supporting dots in that position.
2714 hook
: ( function () {
2718 * Create an instance of mw.hook.
2722 * @param {string} name Name of hook.
2725 return function ( name
) {
2726 var list
= hasOwn
.call( lists
, name
) ?
2728 lists
[ name
] = $.Callbacks( 'memory' );
2732 * Register a hook handler
2734 * @param {...Function} handler Function to bind.
2740 * Unregister a hook handler
2742 * @param {...Function} handler Function to unbind.
2745 remove
: list
.remove
,
2747 // eslint-disable-next-line valid-jsdoc
2751 * @param {...Mixed} data
2755 return list
.fireWith
.call( this, null, slice
.call( arguments
) );
2762 // Alias $j to jQuery for backwards compatibility
2763 // @deprecated since 1.23 Use $ or jQuery instead
2764 mw
.log
.deprecate( window
, '$j', $, 'Use $ or jQuery instead.' );
2767 * Log a message to window.console, if possible.
2769 * Useful to force logging of some errors that are otherwise hard to detect (i.e., this logs
2770 * also in production mode). Gets console references in each invocation instead of caching the
2771 * reference, so that debugging tools loaded later are supported (e.g. Firebug Lite in IE).
2774 * @param {string} topic Stream name passed by mw.track
2775 * @param {Object} data Data passed by mw.track
2776 * @param {Error} [data.exception]
2777 * @param {string} data.source Error source
2778 * @param {string} [data.module] Name of module which caused the error
2780 function logError( topic
, data
) {
2781 /* eslint-disable no-console */
2784 source
= data
.source
,
2785 module
= data
.module
,
2786 console
= window
.console
;
2788 if ( console
&& console
.log
) {
2789 msg
= ( e
? 'Exception' : 'Error' ) + ' in ' + source
;
2791 msg
+= ' in module ' + module
;
2793 msg
+= ( e
? ':' : '.' );
2796 // If we have an exception object, log it to the warning channel to trigger
2797 // proper stacktraces in browsers that support it.
2798 if ( e
&& console
.warn
) {
2802 /* eslint-enable no-console */
2805 // Subscribe to error streams
2806 mw
.trackSubscribe( 'resourceloader.exception', logError
);
2807 mw
.trackSubscribe( 'resourceloader.assert', logError
);
2810 * Fired when all modules associated with the page have finished loading.
2812 * @event resourceloader_loadEnd
2816 var loading
, modules
;
2818 modules
= mw
.loader
.getModuleNames().filter( function ( module
) {
2819 return mw
.loader
.getState( module
) === 'loading';
2821 // We only need a callback, not any actual module. First try a single using()
2822 // for all loading modules. If one fails, fall back to tracking each module
2823 // separately via $.when(), this is expensive.
2824 loading
= mw
.loader
.using( modules
).catch( function () {
2825 var all
= modules
.map( function ( module
) {
2826 return mw
.loader
.using( module
).catch( function () {
2827 return $.Deferred().resolve();
2830 return $.when
.apply( $, all
);
2832 loading
.then( function () {
2833 if ( window
.performance
&& performance
.mark
) {
2834 performance
.mark( 'mwLoadEnd' );
2836 mw
.hook( 'resourceloader.loadEnd' ).fire();
2840 // Attach to window and globally alias
2841 window
.mw
= window
.mediaWiki
= mw
;