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
= $.grep( trackHandlers
, 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 * - store-eval: could not evaluate module code cached in localStorage
758 * - store-localstorage-init: localStorage or JSON parse error in mw.loader.store.init
759 * - store-localstorage-json: JSON conversion error in mw.loader.store.set
760 * - store-localstorage-update: localStorage or JSON conversion error in mw.loader.store.update
764 * Fired via mw.track on resource loading error conditions.
766 * @event resourceloader_assert
767 * @param {string} source Source of the error. Possible values:
769 * - bug-T59567: failed to cache script due to an Opera function -> string conversion
770 * bug; see <https://phabricator.wikimedia.org/T59567> for details
774 * Mapping of registered modules.
776 * See #implement and #execute for exact details on support for script, style and messages.
782 * // From mw.loader.register()
783 * 'version': '########' (hash)
784 * 'dependencies': ['required.foo', 'bar.also', ...], (or) function () {}
785 * 'group': 'somegroup', (or) null
786 * 'source': 'local', (or) 'anotherwiki'
787 * 'skip': 'return !!window.Example', (or) null
788 * 'module': export Object
790 * // Set from execute() or mw.loader.state()
791 * 'state': 'registered', 'loaded', 'loading', 'ready', 'error', or 'missing'
793 * // Optionally added at run-time by mw.loader.implement()
795 * 'script': closure, array of urls, or string
796 * 'style': { ... } (see #execute)
797 * 'messages': { 'key': 'value', ... }
804 * The module is known to the system but not yet required.
805 * Meta data is registered via mw.loader#register. Calls to that method are
806 * generated server-side by the startup module.
808 * The module was required through mw.loader (either directly or as dependency of
809 * another module). The client will fetch module contents from the server.
810 * The contents are then stashed in the registry via mw.loader#implement.
812 * The module has been loaded from the server and stashed via mw.loader#implement.
813 * If the module has no more dependencies in-flight, the module will be executed
814 * immediately. Otherwise execution is deferred, controlled via #handlePending.
816 * The module is being executed.
818 * The module has been successfully executed.
820 * The module (or one of its dependencies) produced an error during execution.
822 * The module was registered client-side and requested, but the server denied knowledge
823 * of the module's existence.
829 // Mapping of sources, keyed by source-id, values are strings.
834 // 'sourceId': 'http://example.org/w/load.php'
839 // For queueModuleScript()
840 handlingPendingRequests
= false,
841 pendingRequests
= [],
843 // List of modules to be loaded
847 * List of callback jobs waiting for modules to be ready.
849 * Jobs are created by #enqueue() and run by #handlePending().
851 * Typically when a job is created for a module, the job's dependencies contain
852 * both the required module and all its recursive dependencies.
857 * 'dependencies': [ module names ],
858 * 'ready': Function callback
859 * 'error': Function callback
862 * @property {Object[]} jobs
870 // For addEmbeddedCSS()
872 cssBufferTimer
= null,
873 cssCallbacks
= $.Callbacks(),
874 isIE9
= document
.documentMode
=== 9,
875 rAF
= window
.requestAnimationFrame
|| setTimeout
;
877 function getMarker() {
880 marker
= document
.querySelector( 'meta[name="ResourceLoaderDynamicStyles"]' );
882 mw
.log( 'Create <meta name="ResourceLoaderDynamicStyles"> dynamically' );
883 marker
= $( '<meta>' ).attr( 'name', 'ResourceLoaderDynamicStyles' ).appendTo( 'head' )[ 0 ];
890 * Create a new style element and add it to the DOM.
893 * @param {string} text CSS text
894 * @param {Node} [nextNode] The element where the style tag
895 * should be inserted before
896 * @return {HTMLElement} Reference to the created style element
898 function newStyleTag( text
, nextNode
) {
899 var s
= document
.createElement( 'style' );
901 s
.appendChild( document
.createTextNode( text
) );
902 if ( nextNode
&& nextNode
.parentNode
) {
903 nextNode
.parentNode
.insertBefore( s
, nextNode
);
905 document
.getElementsByTagName( 'head' )[ 0 ].appendChild( s
);
912 * Add a bit of CSS text to the current browser page.
914 * The CSS will be appended to an existing ResourceLoader-created `<style>` tag
915 * or create a new one based on whether the given `cssText` is safe for extension.
918 * @param {string} [cssText=cssBuffer] If called without cssText,
919 * the internal buffer will be inserted instead.
920 * @param {Function} [callback]
922 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 // By default, always create a new <style>. Appending text to a <style> tag is
968 // is a performance anti-pattern as it requires CSS to be reparsed (T47810).
971 // Try to re-use existing <style> tags due to the IE stylesheet limit (T33676).
973 $style
= $( getMarker() ).prev();
974 // Verify that the element before the marker actually is a <style> tag created
975 // by mw.loader (not some other style tag, or e.g. a <meta> tag).
976 if ( $style
.data( 'ResourceLoaderDynamicStyleTag' ) ) {
977 styleEl
= $style
[ 0 ];
978 styleEl
.appendChild( document
.createTextNode( cssText
) );
982 // Else: No existing tag to reuse. Continue below and create the first one.
985 $style
= $( newStyleTag( cssText
, getMarker() ) );
988 $style
.data( 'ResourceLoaderDynamicStyleTag', true );
996 * @param {Array} modules List of module names
997 * @return {string} Hash of concatenated version hashes.
999 function getCombinedVersion( modules
) {
1000 var hashes
= modules
.map( function ( module
) {
1001 return registry
[ module
].version
;
1003 return fnv132( hashes
.join( '' ) );
1007 * Determine whether all dependencies are in state 'ready', which means we may
1008 * execute the module or job now.
1011 * @param {Array} modules Names of modules to be checked
1012 * @return {boolean} True if all modules are in state 'ready', false otherwise
1014 function allReady( modules
) {
1016 for ( i
= 0; i
< modules
.length
; i
++ ) {
1017 if ( mw
.loader
.getState( modules
[ i
] ) !== 'ready' ) {
1025 * Determine whether all dependencies are in state 'ready', which means we may
1026 * execute the module or job now.
1029 * @param {Array} modules Names of modules to be checked
1030 * @return {boolean} True if no modules are in state 'error' or 'missing', false otherwise
1032 function anyFailed( modules
) {
1034 for ( i
= 0; i
< modules
.length
; i
++ ) {
1035 state
= mw
.loader
.getState( modules
[ i
] );
1036 if ( state
=== 'error' || state
=== 'missing' ) {
1044 * A module has entered state 'ready', 'error', or 'missing'. Automatically update
1045 * pending jobs and modules that depend upon this module. If the given module failed,
1046 * propagate the 'error' state up the dependency tree. Otherwise, go ahead and execute
1047 * all jobs/modules now having their dependencies satisfied.
1049 * Jobs that depend on a failed module, will have their error callback ran (if any).
1052 * @param {string} module Name of module that entered one of the states 'ready', 'error', or 'missing'.
1054 function handlePending( module
) {
1055 var j
, job
, hasErrors
, m
, stateChange
;
1057 if ( registry
[ module
].state
=== 'error' || registry
[ module
].state
=== 'missing' ) {
1058 // If the current module failed, mark all dependent modules also as failed.
1059 // Iterate until steady-state to propagate the error state upwards in the
1062 stateChange
= false;
1063 for ( m
in registry
) {
1064 if ( registry
[ m
].state
!== 'error' && registry
[ m
].state
!== 'missing' ) {
1065 if ( anyFailed( registry
[ m
].dependencies
) ) {
1066 registry
[ m
].state
= 'error';
1071 } while ( stateChange
);
1074 // Execute all jobs whose dependencies are either all satisfied or contain at least one failed module.
1075 for ( j
= 0; j
< jobs
.length
; j
++ ) {
1076 hasErrors
= anyFailed( jobs
[ j
].dependencies
);
1077 if ( hasErrors
|| allReady( jobs
[ j
].dependencies
) ) {
1078 // All dependencies satisfied, or some have errors
1080 jobs
.splice( j
, 1 );
1084 if ( typeof job
.error
=== 'function' ) {
1085 job
.error( new Error( 'Module ' + module
+ ' has failed dependencies' ), [ module
] );
1088 if ( typeof job
.ready
=== 'function' ) {
1093 // A user-defined callback raised an exception.
1094 // Swallow it to protect our state machine!
1095 mw
.track( 'resourceloader.exception', { exception
: e
, module
: module
, source
: 'load-callback' } );
1100 if ( registry
[ module
].state
=== 'ready' ) {
1101 // The current module became 'ready'. Set it in the module store, and recursively execute all
1102 // dependent modules that are loaded and now have all dependencies satisfied.
1103 mw
.loader
.store
.set( module
, registry
[ module
] );
1104 for ( m
in registry
) {
1105 if ( registry
[ m
].state
=== 'loaded' && allReady( registry
[ m
].dependencies
) ) {
1113 * Resolve dependencies and detect circular references.
1116 * @param {string} module Name of the top-level module whose dependencies shall be
1117 * resolved and sorted.
1118 * @param {Array} resolved Returns a topological sort of the given module and its
1119 * dependencies, such that later modules depend on earlier modules. The array
1120 * contains the module names. If the array contains already some module names,
1121 * this function appends its result to the pre-existing array.
1122 * @param {StringSet} [unresolved] Used to track the current dependency
1123 * chain, and to report loops in the dependency graph.
1124 * @throws {Error} If any unregistered module or a dependency loop is encountered
1126 function sortDependencies( module
, resolved
, unresolved
) {
1129 if ( !hasOwn
.call( registry
, module
) ) {
1130 throw new Error( 'Unknown dependency: ' + module
);
1133 if ( registry
[ module
].skip
!== null ) {
1134 // eslint-disable-next-line no-new-func
1135 skip
= new Function( registry
[ module
].skip
);
1136 registry
[ module
].skip
= null;
1138 registry
[ module
].skipped
= true;
1139 registry
[ module
].dependencies
= [];
1140 registry
[ module
].state
= 'ready';
1141 handlePending( module
);
1146 // Resolves dynamic loader function and replaces it with its own results
1147 if ( typeof registry
[ module
].dependencies
=== 'function' ) {
1148 registry
[ module
].dependencies
= registry
[ module
].dependencies();
1149 // Ensures the module's dependencies are always in an array
1150 if ( typeof registry
[ module
].dependencies
!== 'object' ) {
1151 registry
[ module
].dependencies
= [ registry
[ module
].dependencies
];
1154 if ( $.inArray( module
, resolved
) !== -1 ) {
1155 // Module already resolved; nothing to do
1158 // Create unresolved if not passed in
1159 if ( !unresolved
) {
1160 unresolved
= new StringSet();
1162 // Tracks down dependencies
1163 deps
= registry
[ module
].dependencies
;
1164 for ( i
= 0; i
< deps
.length
; i
++ ) {
1165 if ( $.inArray( deps
[ i
], resolved
) === -1 ) {
1166 if ( unresolved
.has( deps
[ i
] ) ) {
1167 throw new Error( mw
.format(
1168 'Circular reference detected: $1 -> $2',
1174 unresolved
.add( module
);
1175 sortDependencies( deps
[ i
], resolved
, unresolved
);
1178 resolved
.push( module
);
1182 * Get names of module that a module depends on, in their proper dependency order.
1185 * @param {string[]} modules Array of string module names
1186 * @return {Array} List of dependencies, including 'module'.
1187 * @throws {Error} If an unregistered module or a dependency loop is encountered
1189 function resolve( modules
) {
1190 var i
, resolved
= [];
1191 for ( i
= 0; i
< modules
.length
; i
++ ) {
1192 sortDependencies( modules
[ i
], resolved
);
1198 * Load and execute a script.
1201 * @param {string} src URL to script, will be used as the src attribute in the script tag
1202 * @return {jQuery.Promise}
1204 function addScript( src
) {
1208 // Force jQuery behaviour to be for crossDomain. Otherwise jQuery would use
1209 // XHR for a same domain request instead of <script>, which changes the request
1210 // headers (potentially missing a cache hit), and reduces caching in general
1211 // since browsers cache XHR much less (if at all). And XHR means we retrieve
1212 // text, so we'd need to $.globalEval, which then messes up line numbers.
1219 * Queue the loading and execution of a script for a particular module.
1222 * @param {string} src URL of the script
1223 * @param {string} [moduleName] Name of currently executing module
1224 * @return {jQuery.Promise}
1226 function queueModuleScript( src
, moduleName
) {
1227 var r
= $.Deferred();
1229 pendingRequests
.push( function () {
1230 if ( moduleName
&& hasOwn
.call( registry
, moduleName
) ) {
1231 // Emulate runScript() part of execute()
1232 window
.require
= mw
.loader
.require
;
1233 window
.module
= registry
[ moduleName
].module
;
1235 addScript( src
).always( function () {
1236 // 'module.exports' should not persist after the file is executed to
1237 // avoid leakage to unrelated code. 'require' should be kept, however,
1238 // as asynchronous access to 'require' is allowed and expected. (T144879)
1239 delete window
.module
;
1242 // Start the next one (if any)
1243 if ( pendingRequests
[ 0 ] ) {
1244 pendingRequests
.shift()();
1246 handlingPendingRequests
= false;
1250 if ( !handlingPendingRequests
&& pendingRequests
[ 0 ] ) {
1251 handlingPendingRequests
= true;
1252 pendingRequests
.shift()();
1258 * Utility function for execute()
1261 * @param {string} [media] Media attribute
1262 * @param {string} url URL
1264 function addLink( media
, url
) {
1265 var el
= document
.createElement( 'link' );
1267 el
.rel
= 'stylesheet';
1268 if ( media
&& media
!== 'all' ) {
1271 // If you end up here from an IE exception "SCRIPT: Invalid property value.",
1272 // see #addEmbeddedCSS, T33676, and T49277 for details.
1275 $( getMarker() ).before( el
);
1279 * Executes a loaded module, making it ready to use
1282 * @param {string} module Module name to execute
1284 function execute( module
) {
1285 var key
, value
, media
, i
, urls
, cssHandle
, checkCssHandles
, runScript
,
1286 cssHandlesRegistered
= false;
1288 if ( !hasOwn
.call( registry
, module
) ) {
1289 throw new Error( 'Module has not been registered yet: ' + module
);
1291 if ( registry
[ module
].state
!== 'loaded' ) {
1292 throw new Error( 'Module in state "' + registry
[ module
].state
+ '" may not be executed: ' + module
);
1295 registry
[ module
].state
= 'executing';
1297 runScript = function () {
1298 var script
, markModuleReady
, nestedAddScript
, legacyWait
, implicitDependencies
,
1299 // Expand to include dependencies since we have to exclude both legacy modules
1300 // and their dependencies from the legacyWait (to prevent a circular dependency).
1301 legacyModules
= resolve( mw
.config
.get( 'wgResourceLoaderLegacyModules', [] ) );
1303 script
= registry
[ module
].script
;
1304 markModuleReady = function () {
1305 registry
[ module
].state
= 'ready';
1306 handlePending( module
);
1308 nestedAddScript = function ( arr
, callback
, i
) {
1309 // Recursively call queueModuleScript() in its own callback
1310 // for each element of arr.
1311 if ( i
>= arr
.length
) {
1312 // We're at the end of the array
1317 queueModuleScript( arr
[ i
], module
).always( function () {
1318 nestedAddScript( arr
, callback
, i
+ 1 );
1322 implicitDependencies
= ( $.inArray( module
, legacyModules
) !== -1 ) ?
1326 if ( module
=== 'user' ) {
1327 // Implicit dependency on the site module. Not real dependency because
1328 // it should run after 'site' regardless of whether it succeeds or fails.
1329 implicitDependencies
.push( 'site' );
1332 legacyWait
= implicitDependencies
.length
?
1333 mw
.loader
.using( implicitDependencies
) :
1334 $.Deferred().resolve();
1336 legacyWait
.always( function () {
1338 if ( Array
.isArray( script
) ) {
1339 nestedAddScript( script
, markModuleReady
, 0 );
1340 } else if ( typeof script
=== 'function' ) {
1341 // Pass jQuery twice so that the signature of the closure which wraps
1342 // the script can bind both '$' and 'jQuery'.
1343 script( $, $, mw
.loader
.require
, registry
[ module
].module
);
1346 } else if ( typeof script
=== 'string' ) {
1347 // Site and user modules are legacy scripts that run in the global scope.
1348 // This is transported as a string instead of a function to avoid needing
1349 // to use string manipulation to undo the function wrapper.
1350 $.globalEval( script
);
1354 // Module without script
1358 // Use mw.track instead of mw.log because these errors are common in production mode
1359 // (e.g. undefined variable), and mw.log is only enabled in debug mode.
1360 registry
[ module
].state
= 'error';
1361 mw
.track( 'resourceloader.exception', { exception
: e
, module
: module
, source
: 'module-execute' } );
1362 handlePending( module
);
1367 // Add localizations to message system
1368 if ( registry
[ module
].messages
) {
1369 mw
.messages
.set( registry
[ module
].messages
);
1372 // Initialise templates
1373 if ( registry
[ module
].templates
) {
1374 mw
.templates
.set( module
, registry
[ module
].templates
);
1377 // Make sure we don't run the scripts until all stylesheet insertions have completed.
1380 checkCssHandles = function () {
1381 // cssHandlesRegistered ensures we don't take off too soon, e.g. when
1382 // one of the cssHandles is fired while we're still creating more handles.
1383 if ( cssHandlesRegistered
&& pending
=== 0 && runScript
) {
1385 runScript
= undefined; // Revoke
1388 cssHandle = function () {
1389 var check
= checkCssHandles
;
1391 return function () {
1395 check
= undefined; // Revoke
1401 // Process styles (see also mw.loader.implement)
1402 // * back-compat: { <media>: css }
1403 // * back-compat: { <media>: [url, ..] }
1404 // * { "css": [css, ..] }
1405 // * { "url": { <media>: [url, ..] } }
1406 if ( registry
[ module
].style
) {
1407 for ( key
in registry
[ module
].style
) {
1408 value
= registry
[ module
].style
[ key
];
1411 if ( key
!== 'url' && key
!== 'css' ) {
1412 // Backwards compatibility, key is a media-type
1413 if ( typeof value
=== 'string' ) {
1414 // back-compat: { <media>: css }
1415 // Ignore 'media' because it isn't supported (nor was it used).
1416 // Strings are pre-wrapped in "@media". The media-type was just ""
1417 // (because it had to be set to something).
1418 // This is one of the reasons why this format is no longer used.
1419 addEmbeddedCSS( value
, cssHandle() );
1421 // back-compat: { <media>: [url, ..] }
1427 // Array of css strings in key 'css',
1428 // or back-compat array of urls from media-type
1429 if ( Array
.isArray( value
) ) {
1430 for ( i
= 0; i
< value
.length
; i
++ ) {
1431 if ( key
=== 'bc-url' ) {
1432 // back-compat: { <media>: [url, ..] }
1433 addLink( media
, value
[ i
] );
1434 } else if ( key
=== 'css' ) {
1435 // { "css": [css, ..] }
1436 addEmbeddedCSS( value
[ i
], cssHandle() );
1439 // Not an array, but a regular object
1440 // Array of urls inside media-type key
1441 } else if ( typeof value
=== 'object' ) {
1442 // { "url": { <media>: [url, ..] } }
1443 for ( media
in value
) {
1444 urls
= value
[ media
];
1445 for ( i
= 0; i
< urls
.length
; i
++ ) {
1446 addLink( media
, urls
[ i
] );
1454 cssHandlesRegistered
= true;
1459 * Add one or more modules to the module load queue.
1464 * @param {string|string[]} dependencies Module name or array of string module names
1465 * @param {Function} [ready] Callback to execute when all dependencies are ready
1466 * @param {Function} [error] Callback to execute when any dependency fails
1468 function enqueue( dependencies
, ready
, error
) {
1469 // Allow calling by single module name
1470 if ( typeof dependencies
=== 'string' ) {
1471 dependencies
= [ dependencies
];
1474 // Add ready and error callbacks if they were given
1475 if ( ready
!== undefined || error
!== undefined ) {
1477 // Narrow down the list to modules that are worth waiting for
1478 dependencies
: $.grep( dependencies
, function ( module
) {
1479 var state
= mw
.loader
.getState( module
);
1480 return state
=== 'registered' || state
=== 'loaded' || state
=== 'loading' || state
=== 'executing';
1487 $.each( dependencies
, function ( idx
, module
) {
1488 var state
= mw
.loader
.getState( module
);
1489 // Only queue modules that are still in the initial 'registered' state
1490 // (not ones already loading, ready or error).
1491 if ( state
=== 'registered' && $.inArray( module
, queue
) === -1 ) {
1492 // Private modules must be embedded in the page. Don't bother queuing
1493 // these as the server will deny them anyway (T101806).
1494 if ( registry
[ module
].group
=== 'private' ) {
1495 registry
[ module
].state
= 'error';
1496 handlePending( module
);
1499 queue
.push( module
);
1506 function sortQuery( o
) {
1512 if ( hasOwn
.call( o
, key
) ) {
1517 for ( key
= 0; key
< a
.length
; key
++ ) {
1518 sorted
[ a
[ key
] ] = o
[ a
[ key
] ];
1524 * Converts a module map of the form { foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }
1525 * to a query string of the form foo.bar,baz|bar.baz,quux
1528 * @param {Object} moduleMap Module map
1529 * @return {string} Module query string
1531 function buildModulesString( moduleMap
) {
1535 for ( prefix
in moduleMap
) {
1536 p
= prefix
=== '' ? '' : prefix
+ '.';
1537 arr
.push( p
+ moduleMap
[ prefix
].join( ',' ) );
1539 return arr
.join( '|' );
1543 * Make a network request to load modules from the server.
1546 * @param {Object} moduleMap Module map, see #buildModulesString
1547 * @param {Object} currReqBase Object with other parameters (other than 'modules') to use in the request
1548 * @param {string} sourceLoadScript URL of load.php
1550 function doRequest( moduleMap
, currReqBase
, sourceLoadScript
) {
1551 var query
= $.extend(
1552 { modules
: buildModulesString( moduleMap
) },
1555 query
= sortQuery( query
);
1556 addScript( sourceLoadScript
+ '?' + $.param( query
) );
1560 * Resolve indexed dependencies.
1562 * ResourceLoader uses an optimization to save space which replaces module names in
1563 * dependency lists with the index of that module within the array of module
1564 * registration data if it exists. The benefit is a significant reduction in the data
1565 * size of the startup module. This function changes those dependency lists back to
1566 * arrays of strings.
1569 * @param {Array} modules Modules array
1571 function resolveIndexedDependencies( modules
) {
1573 function resolveIndex( dep
) {
1574 return typeof dep
=== 'number' ? modules
[ dep
][ 0 ] : dep
;
1576 for ( i
= 0; i
< modules
.length
; i
++ ) {
1577 deps
= modules
[ i
][ 2 ];
1579 for ( j
= 0; j
< deps
.length
; j
++ ) {
1580 deps
[ j
] = resolveIndex( deps
[ j
] );
1587 * Create network requests for a batch of modules.
1589 * This is an internal method for #work(). This must not be called directly
1590 * unless the modules are already registered, and no request is in progress,
1591 * and the module state has already been set to `loading`.
1594 * @param {string[]} batch
1596 function batchRequest( batch
) {
1597 var reqBase
, splits
, maxQueryLength
, b
, bSource
, bGroup
, bSourceGroup
,
1598 source
, group
, i
, modules
, sourceLoadScript
,
1599 currReqBase
, currReqBaseLength
, moduleMap
, l
,
1600 lastDotIndex
, prefix
, suffix
, bytesAdded
;
1602 if ( !batch
.length
) {
1606 // Always order modules alphabetically to help reduce cache
1607 // misses for otherwise identical content.
1610 // Build a list of query parameters common to all requests
1612 skin
: mw
.config
.get( 'skin' ),
1613 lang
: mw
.config
.get( 'wgUserLanguage' ),
1614 debug
: mw
.config
.get( 'debug' )
1616 maxQueryLength
= mw
.config
.get( 'wgResourceLoaderMaxQueryLength', 2000 );
1618 // Split module list by source and by group.
1620 for ( b
= 0; b
< batch
.length
; b
++ ) {
1621 bSource
= registry
[ batch
[ b
] ].source
;
1622 bGroup
= registry
[ batch
[ b
] ].group
;
1623 if ( !hasOwn
.call( splits
, bSource
) ) {
1624 splits
[ bSource
] = {};
1626 if ( !hasOwn
.call( splits
[ bSource
], bGroup
) ) {
1627 splits
[ bSource
][ bGroup
] = [];
1629 bSourceGroup
= splits
[ bSource
][ bGroup
];
1630 bSourceGroup
.push( batch
[ b
] );
1633 for ( source
in splits
) {
1635 sourceLoadScript
= sources
[ source
];
1637 for ( group
in splits
[ source
] ) {
1639 // Cache access to currently selected list of
1640 // modules for this group from this source.
1641 modules
= splits
[ source
][ group
];
1643 currReqBase
= $.extend( {
1644 version
: getCombinedVersion( modules
)
1646 // For user modules append a user name to the query string.
1647 if ( group
=== 'user' && mw
.config
.get( 'wgUserName' ) !== null ) {
1648 currReqBase
.user
= mw
.config
.get( 'wgUserName' );
1650 currReqBaseLength
= $.param( currReqBase
).length
;
1651 // We may need to split up the request to honor the query string length limit,
1652 // so build it piece by piece.
1653 l
= currReqBaseLength
+ 9; // '&modules='.length == 9
1655 moduleMap
= {}; // { prefix: [ suffixes ] }
1657 for ( i
= 0; i
< modules
.length
; i
++ ) {
1658 // Determine how many bytes this module would add to the query string
1659 lastDotIndex
= modules
[ i
].lastIndexOf( '.' );
1661 // If lastDotIndex is -1, substr() returns an empty string
1662 prefix
= modules
[ i
].substr( 0, lastDotIndex
);
1663 suffix
= modules
[ i
].slice( lastDotIndex
+ 1 );
1665 bytesAdded
= hasOwn
.call( moduleMap
, prefix
) ?
1666 suffix
.length
+ 3 : // '%2C'.length == 3
1667 modules
[ i
].length
+ 3; // '%7C'.length == 3
1669 // If the url would become too long, create a new one,
1670 // but don't create empty requests
1671 if ( maxQueryLength
> 0 && !$.isEmptyObject( moduleMap
) && l
+ bytesAdded
> maxQueryLength
) {
1672 // This url would become too long, create a new one, and start the old one
1673 doRequest( moduleMap
, currReqBase
, sourceLoadScript
);
1675 l
= currReqBaseLength
+ 9;
1676 mw
.track( 'resourceloader.splitRequest', { maxQueryLength
: maxQueryLength
} );
1678 if ( !hasOwn
.call( moduleMap
, prefix
) ) {
1679 moduleMap
[ prefix
] = [];
1681 moduleMap
[ prefix
].push( suffix
);
1684 // If there's anything left in moduleMap, request that too
1685 if ( !$.isEmptyObject( moduleMap
) ) {
1686 doRequest( moduleMap
, currReqBase
, sourceLoadScript
);
1694 * @param {string[]} implementations Array containing pieces of JavaScript code in the
1695 * form of calls to mw.loader#implement().
1696 * @param {Function} cb Callback in case of failure
1697 * @param {Error} cb.err
1699 function asyncEval( implementations
, cb
) {
1700 if ( !implementations
.length
) {
1703 mw
.requestIdleCallback( function () {
1705 $.globalEval( implementations
.join( ';' ) );
1713 * Make a versioned key for a specific module.
1716 * @param {string} module Module name
1717 * @return {string|null} Module key in format '`[name]@[version]`',
1718 * or null if the module does not exist
1720 function getModuleKey( module
) {
1721 return hasOwn
.call( registry
, module
) ?
1722 ( module
+ '@' + registry
[ module
].version
) : null;
1727 * @param {string} key Module name or '`[name]@[version]`'
1730 function splitModuleKey( key
) {
1731 var index
= key
.indexOf( '@' );
1732 if ( index
=== -1 ) {
1733 return { name
: key
};
1736 name
: key
.slice( 0, index
),
1737 version
: key
.slice( index
+ 1 )
1741 /* Public Members */
1744 * The module registry is exposed as an aid for debugging and inspecting page
1745 * state; it is not a public interface for modifying the registry.
1751 moduleRegistry
: registry
,
1754 * @inheritdoc #newStyleTag
1757 addStyleTag
: newStyleTag
,
1760 * Start loading of all queued module dependencies.
1765 var q
, batch
, implementations
, sourceModules
;
1769 // Appends a list of modules from the queue to the batch
1770 for ( q
= 0; q
< queue
.length
; q
++ ) {
1771 // Only load modules which are registered
1772 if ( hasOwn
.call( registry
, queue
[ q
] ) && registry
[ queue
[ q
] ].state
=== 'registered' ) {
1773 // Prevent duplicate entries
1774 if ( $.inArray( queue
[ q
], batch
) === -1 ) {
1775 batch
.push( queue
[ q
] );
1776 // Mark registered modules as loading
1777 registry
[ queue
[ q
] ].state
= 'loading';
1782 // Now that the queue has been processed into a batch, clear the queue.
1783 // This MUST happen before we initiate any eval or network request. Otherwise,
1784 // it is possible for a cached script to instantly trigger the same work queue
1785 // again; all before we've cleared it causing each request to include modules
1786 // which are already loaded.
1789 if ( !batch
.length
) {
1793 mw
.loader
.store
.init();
1794 if ( mw
.loader
.store
.enabled
) {
1795 implementations
= [];
1797 batch
= $.grep( batch
, function ( module
) {
1798 var implementation
= mw
.loader
.store
.get( module
);
1799 if ( implementation
) {
1800 implementations
.push( implementation
);
1801 sourceModules
.push( module
);
1806 asyncEval( implementations
, function ( err
) {
1808 // Not good, the cached mw.loader.implement calls failed! This should
1809 // never happen, barring ResourceLoader bugs, browser bugs and PEBKACs.
1810 // Depending on how corrupt the string is, it is likely that some
1811 // modules' implement() succeeded while the ones after the error will
1812 // never run and leave their modules in the 'loading' state forever.
1813 mw
.loader
.store
.stats
.failed
++;
1815 // Since this is an error not caused by an individual module but by
1816 // something that infected the implement call itself, don't take any
1817 // risks and clear everything in this cache.
1818 mw
.loader
.store
.clear();
1820 mw
.track( 'resourceloader.exception', { exception
: err
, source
: 'store-eval' } );
1821 // Re-add the failed ones that are still pending back to the batch
1822 failed
= $.grep( sourceModules
, function ( module
) {
1823 return registry
[ module
].state
=== 'loading';
1825 batchRequest( failed
);
1829 batchRequest( batch
);
1833 * Register a source.
1835 * The #work() method will use this information to split up requests by source.
1837 * mw.loader.addSource( 'mediawikiwiki', '//www.mediawiki.org/w/load.php' );
1839 * @param {string|Object} id Source ID, or object mapping ids to load urls
1840 * @param {string} loadUrl Url to a load.php end point
1841 * @throws {Error} If source id is already registered
1843 addSource: function ( id
, loadUrl
) {
1845 // Allow multiple additions
1846 if ( typeof id
=== 'object' ) {
1847 for ( source
in id
) {
1848 mw
.loader
.addSource( source
, id
[ source
] );
1853 if ( hasOwn
.call( sources
, id
) ) {
1854 throw new Error( 'source already registered: ' + id
);
1857 sources
[ id
] = loadUrl
;
1861 * Register a module, letting the system know about it and its properties.
1863 * The startup modules contain calls to this method.
1865 * When using multiple module registration by passing an array, dependencies that
1866 * are specified as references to modules within the array will be resolved before
1867 * the modules are registered.
1869 * @param {string|Array} module Module name or array of arrays, each containing
1870 * a list of arguments compatible with this method
1871 * @param {string|number} version Module version hash (falls backs to empty string)
1872 * Can also be a number (timestamp) for compatibility with MediaWiki 1.25 and earlier.
1873 * @param {string|Array|Function} dependencies One string or array of strings of module
1874 * names on which this module depends, or a function that returns that array.
1875 * @param {string} [group=null] Group which the module is in
1876 * @param {string} [source='local'] Name of the source
1877 * @param {string} [skip=null] Script body of the skip function
1879 register: function ( module
, version
, dependencies
, group
, source
, skip
) {
1881 // Allow multiple registration
1882 if ( typeof module
=== 'object' ) {
1883 resolveIndexedDependencies( module
);
1884 for ( i
= 0; i
< module
.length
; i
++ ) {
1885 // module is an array of module names
1886 if ( typeof module
[ i
] === 'string' ) {
1887 mw
.loader
.register( module
[ i
] );
1888 // module is an array of arrays
1889 } else if ( typeof module
[ i
] === 'object' ) {
1890 mw
.loader
.register
.apply( mw
.loader
, module
[ i
] );
1895 if ( hasOwn
.call( registry
, module
) ) {
1896 throw new Error( 'module already registered: ' + module
);
1898 if ( typeof dependencies
=== 'string' ) {
1899 // A single module name
1900 deps
= [ dependencies
];
1901 } else if ( typeof dependencies
=== 'object' || typeof dependencies
=== 'function' ) {
1902 // Array of module names or a function that returns an array
1903 deps
= dependencies
;
1905 // List the module as registered
1906 registry
[ module
] = {
1907 // Exposed to execute() for mw.loader.implement() closures.
1908 // Import happens via require().
1912 version
: version
!== undefined ? String( version
) : '',
1913 dependencies
: deps
|| [],
1914 group
: typeof group
=== 'string' ? group
: null,
1915 source
: typeof source
=== 'string' ? source
: 'local',
1916 state
: 'registered',
1917 skip
: typeof skip
=== 'string' ? skip
: null
1922 * Implement a module given the components that make up the module.
1924 * When #load() or #using() requests one or more modules, the server
1925 * response contain calls to this function.
1927 * @param {string} module Name of module and current module version. Formatted
1928 * as '`[name]@[version]`". This version should match the requested version
1929 * (from #batchRequest and #registry). This avoids race conditions (T117587).
1930 * For back-compat with MediaWiki 1.27 and earlier, the version may be omitted.
1931 * @param {Function|Array|string} [script] Function with module code, list of URLs
1932 * to load via `<script src>`, or string of module code for `$.globalEval()`.
1933 * @param {Object} [style] Should follow one of the following patterns:
1935 * { "css": [css, ..] }
1936 * { "url": { <media>: [url, ..] } }
1938 * And for backwards compatibility (needs to be supported forever due to caching):
1941 * { <media>: [url, ..] }
1943 * The reason css strings are not concatenated anymore is T33676. We now check
1944 * whether it's safe to extend the stylesheet.
1947 * @param {Object} [messages] List of key/value pairs to be added to mw#messages.
1948 * @param {Object} [templates] List of key/value pairs to be added to mw#templates.
1950 implement: function ( module
, script
, style
, messages
, templates
) {
1951 var split
= splitModuleKey( module
),
1953 version
= split
.version
;
1954 // Automatically register module
1955 if ( !hasOwn
.call( registry
, name
) ) {
1956 mw
.loader
.register( name
);
1958 // Check for duplicate implementation
1959 if ( hasOwn
.call( registry
, name
) && registry
[ name
].script
!== undefined ) {
1960 throw new Error( 'module already implemented: ' + name
);
1963 // Without this reset, if there is a version mismatch between the
1964 // requested and received module version, then mw.loader.store would
1965 // cache the response under the requested key. Thus poisoning the cache
1966 // indefinitely with a stale value. (T117587)
1967 registry
[ name
].version
= version
;
1969 // Attach components
1970 registry
[ name
].script
= script
|| null;
1971 registry
[ name
].style
= style
|| null;
1972 registry
[ name
].messages
= messages
|| null;
1973 registry
[ name
].templates
= templates
|| null;
1974 // The module may already have been marked as erroneous
1975 if ( $.inArray( registry
[ name
].state
, [ 'error', 'missing' ] ) === -1 ) {
1976 registry
[ name
].state
= 'loaded';
1977 if ( allReady( registry
[ name
].dependencies
) ) {
1984 * Execute a function as soon as one or more required modules are ready.
1986 * Example of inline dependency on OOjs:
1988 * mw.loader.using( 'oojs', function () {
1989 * OO.compare( [ 1 ], [ 1 ] );
1992 * Since MediaWiki 1.23 this also returns a promise.
1994 * Since MediaWiki 1.28 the promise is resolved with a `require` function.
1996 * @param {string|Array} dependencies Module name or array of modules names the
1997 * callback depends on to be ready before executing
1998 * @param {Function} [ready] Callback to execute when all dependencies are ready
1999 * @param {Function} [error] Callback to execute if one or more dependencies failed
2000 * @return {jQuery.Promise} With a `require` function
2002 using: function ( dependencies
, ready
, error
) {
2003 var deferred
= $.Deferred();
2005 // Allow calling with a single dependency as a string
2006 if ( typeof dependencies
=== 'string' ) {
2007 dependencies
= [ dependencies
];
2011 deferred
.done( ready
);
2014 deferred
.fail( error
);
2018 // Resolve entire dependency map
2019 dependencies
= resolve( dependencies
);
2021 return deferred
.reject( e
).promise();
2023 if ( allReady( dependencies
) ) {
2024 // Run ready immediately
2025 deferred
.resolve( mw
.loader
.require
);
2026 } else if ( anyFailed( dependencies
) ) {
2027 // Execute error immediately if any dependencies have errors
2029 new Error( 'One or more dependencies failed to load' ),
2033 // Not all dependencies are ready, add to the load queue
2034 enqueue( dependencies
, function () {
2035 deferred
.resolve( mw
.loader
.require
);
2036 }, deferred
.reject
);
2039 return deferred
.promise();
2043 * Load an external script or one or more modules.
2045 * @param {string|Array} modules Either the name of a module, array of modules,
2046 * or a URL of an external script or style
2047 * @param {string} [type='text/javascript'] MIME type to use if calling with a URL of an
2048 * external script or style; acceptable values are "text/css" and
2049 * "text/javascript"; if no type is provided, text/javascript is assumed.
2051 load: function ( modules
, type
) {
2054 // Allow calling with a url or single dependency as a string
2055 if ( typeof modules
=== 'string' ) {
2056 // "https://example.org/x.js", "http://example.org/x.js", "//example.org/x.js", "/x.js"
2057 if ( /^(https?:)?\/?\//.test( modules
) ) {
2058 if ( type
=== 'text/css' ) {
2060 // Use properties instead of attributes as IE throws security
2061 // warnings when inserting a <link> tag with a protocol-relative
2062 // URL set though attributes - when on HTTPS. See T43331.
2063 l
= document
.createElement( 'link' );
2064 l
.rel
= 'stylesheet';
2066 $( 'head' ).append( l
);
2069 if ( type
=== 'text/javascript' || type
=== undefined ) {
2070 addScript( modules
);
2074 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type
);
2076 // Called with single module
2077 modules
= [ modules
];
2080 // Filter out undefined modules, otherwise resolve() will throw
2081 // an exception for trying to load an undefined module.
2082 // Undefined modules are acceptable here in load(), because load() takes
2083 // an array of unrelated modules, whereas the modules passed to
2084 // using() are related and must all be loaded.
2085 filtered
= $.grep( modules
, function ( module
) {
2086 var state
= mw
.loader
.getState( module
);
2087 return state
!== null && state
!== 'error' && state
!== 'missing';
2090 if ( filtered
.length
=== 0 ) {
2093 // Resolve entire dependency map
2094 filtered
= resolve( filtered
);
2095 // If all modules are ready, or if any modules have errors, nothing to be done.
2096 if ( allReady( filtered
) || anyFailed( filtered
) ) {
2099 // Some modules are not yet ready, add to module load queue.
2100 enqueue( filtered
, undefined, undefined );
2104 * Change the state of one or more modules.
2106 * @param {string|Object} module Module name or object of module name/state pairs
2107 * @param {string} state State name
2109 state: function ( module
, state
) {
2112 if ( typeof module
=== 'object' ) {
2113 for ( m
in module
) {
2114 mw
.loader
.state( m
, module
[ m
] );
2118 if ( !hasOwn
.call( registry
, module
) ) {
2119 mw
.loader
.register( module
);
2121 registry
[ module
].state
= state
;
2122 if ( $.inArray( state
, [ 'ready', 'error', 'missing' ] ) !== -1 ) {
2123 // Make sure pending modules depending on this one get executed if their
2124 // dependencies are now fulfilled!
2125 handlePending( module
);
2130 * Get the version of a module.
2132 * @param {string} module Name of module
2133 * @return {string|null} The version, or null if the module (or its version) is not
2136 getVersion: function ( module
) {
2137 if ( !hasOwn
.call( registry
, module
) || registry
[ module
].version
=== undefined ) {
2140 return registry
[ module
].version
;
2144 * Get the state of a module.
2146 * @param {string} module Name of module
2147 * @return {string|null} The state, or null if the module (or its state) is not
2150 getState: function ( module
) {
2151 if ( !hasOwn
.call( registry
, module
) || registry
[ module
].state
=== undefined ) {
2154 return registry
[ module
].state
;
2158 * Get the names of all registered modules.
2162 getModuleNames: function () {
2163 return Object
.keys( registry
);
2167 * Get the exported value of a module.
2169 * Modules may provide this via their local `module.exports`.
2173 * @param {string} moduleName Module name
2174 * @return {Mixed} Exported value
2176 require: function ( moduleName
) {
2177 var state
= mw
.loader
.getState( moduleName
);
2179 // Only ready modules can be required
2180 if ( state
!== 'ready' ) {
2181 // Module may've forgotten to declare a dependency
2182 throw new Error( 'Module "' + moduleName
+ '" is not loaded.' );
2185 return registry
[ moduleName
].module
.exports
;
2189 * @inheritdoc mw.inspect#runReports
2192 inspect: function () {
2193 var args
= slice
.call( arguments
);
2194 mw
.loader
.using( 'mediawiki.inspect', function () {
2195 mw
.inspect
.runReports
.apply( mw
.inspect
, args
);
2200 * On browsers that implement the localStorage API, the module store serves as a
2201 * smart complement to the browser cache. Unlike the browser cache, the module store
2202 * can slice a concatenated response from ResourceLoader into its constituent
2203 * modules and cache each of them separately, using each module's versioning scheme
2204 * to determine when the cache should be invalidated.
2207 * @class mw.loader.store
2210 // Whether the store is in use on this page.
2213 // Modules whose string representation exceeds 100 kB are
2214 // ineligible for storage. See bug T66721.
2215 MODULE_SIZE_MAX
: 100 * 1000,
2217 // The contents of the store, mapping '[name]@[version]' keys
2218 // to module implementations.
2222 stats
: { hits
: 0, misses
: 0, expired
: 0, failed
: 0 },
2225 * Construct a JSON-serializable object representing the content of the store.
2227 * @return {Object} Module store contents.
2229 toJSON: function () {
2230 return { items
: mw
.loader
.store
.items
, vary
: mw
.loader
.store
.getVary() };
2234 * Get the localStorage key for the entire module store. The key references
2235 * $wgDBname to prevent clashes between wikis which share a common host.
2237 * @return {string} localStorage item key
2239 getStoreKey: function () {
2240 return 'MediaWikiModuleStore:' + mw
.config
.get( 'wgDBname' );
2244 * Get a key on which to vary the module cache.
2246 * @return {string} String of concatenated vary conditions.
2248 getVary: function () {
2250 mw
.config
.get( 'skin' ),
2251 mw
.config
.get( 'wgResourceLoaderStorageVersion' ),
2252 mw
.config
.get( 'wgUserLanguage' )
2257 * Initialize the store.
2259 * Retrieves store from localStorage and (if successfully retrieved) decoding
2260 * the stored JSON value to a plain object.
2262 * The try / catch block is used for JSON & localStorage feature detection.
2263 * See the in-line documentation for Modernizr's localStorage feature detection
2264 * code for a full account of why we need a try / catch:
2265 * <https://github.com/Modernizr/Modernizr/blob/v2.7.1/modernizr.js#L771-L796>.
2270 if ( mw
.loader
.store
.enabled
!== null ) {
2276 // Disabled because localStorage quotas are tight and (in Firefox's case)
2277 // shared by multiple origins.
2278 // See T66721, and <https://bugzilla.mozilla.org/show_bug.cgi?id=1064466>.
2279 /Firefox|Opera/.test( navigator
.userAgent
) ||
2281 // Disabled by configuration.
2282 !mw
.config
.get( 'wgResourceLoaderStorageEnabled' )
2284 // Clear any previous store to free up space. (T66721)
2285 mw
.loader
.store
.clear();
2286 mw
.loader
.store
.enabled
= false;
2289 if ( mw
.config
.get( 'debug' ) ) {
2290 // Disable module store in debug mode
2291 mw
.loader
.store
.enabled
= false;
2296 raw
= localStorage
.getItem( mw
.loader
.store
.getStoreKey() );
2297 // If we get here, localStorage is available; mark enabled
2298 mw
.loader
.store
.enabled
= true;
2299 data
= JSON
.parse( raw
);
2300 if ( data
&& typeof data
.items
=== 'object' && data
.vary
=== mw
.loader
.store
.getVary() ) {
2301 mw
.loader
.store
.items
= data
.items
;
2305 mw
.track( 'resourceloader.exception', { exception
: e
, source
: 'store-localstorage-init' } );
2308 if ( raw
=== undefined ) {
2309 // localStorage failed; disable store
2310 mw
.loader
.store
.enabled
= false;
2312 mw
.loader
.store
.update();
2317 * Retrieve a module from the store and update cache hit stats.
2319 * @param {string} module Module name
2320 * @return {string|boolean} Module implementation or false if unavailable
2322 get: function ( module
) {
2325 if ( !mw
.loader
.store
.enabled
) {
2329 key
= getModuleKey( module
);
2330 if ( key
in mw
.loader
.store
.items
) {
2331 mw
.loader
.store
.stats
.hits
++;
2332 return mw
.loader
.store
.items
[ key
];
2334 mw
.loader
.store
.stats
.misses
++;
2339 * Stringify a module and queue it for storage.
2341 * @param {string} module Module name
2342 * @param {Object} descriptor The module's descriptor as set in the registry
2343 * @return {boolean} Module was set
2345 set: function ( module
, descriptor
) {
2348 if ( !mw
.loader
.store
.enabled
) {
2352 key
= getModuleKey( module
);
2355 // Already stored a copy of this exact version
2356 key
in mw
.loader
.store
.items
||
2357 // Module failed to load
2358 descriptor
.state
!== 'ready' ||
2359 // Unversioned, private, or site-/user-specific
2360 ( !descriptor
.version
|| $.inArray( descriptor
.group
, [ 'private', 'user' ] ) !== -1 ) ||
2361 // Partial descriptor
2362 // (e.g. skipped module, or style module with state=ready)
2363 $.inArray( undefined, [ descriptor
.script
, descriptor
.style
,
2364 descriptor
.messages
, descriptor
.templates
] ) !== -1
2372 JSON
.stringify( key
),
2373 typeof descriptor
.script
=== 'function' ?
2374 String( descriptor
.script
) :
2375 JSON
.stringify( descriptor
.script
),
2376 JSON
.stringify( descriptor
.style
),
2377 JSON
.stringify( descriptor
.messages
),
2378 JSON
.stringify( descriptor
.templates
)
2380 // Attempted workaround for a possible Opera bug (bug T59567).
2381 // This regex should never match under sane conditions.
2382 if ( /^\s*\(/.test( args
[ 1 ] ) ) {
2383 args
[ 1 ] = 'function' + args
[ 1 ];
2384 mw
.track( 'resourceloader.assert', { source
: 'bug-T59567' } );
2387 mw
.track( 'resourceloader.exception', { exception
: e
, source
: 'store-localstorage-json' } );
2391 src
= 'mw.loader.implement(' + args
.join( ',' ) + ');';
2392 if ( src
.length
> mw
.loader
.store
.MODULE_SIZE_MAX
) {
2395 mw
.loader
.store
.items
[ key
] = src
;
2396 mw
.loader
.store
.update();
2401 * Iterate through the module store, removing any item that does not correspond
2402 * (in name and version) to an item in the module registry.
2404 * @return {boolean} Store was pruned
2406 prune: function () {
2409 if ( !mw
.loader
.store
.enabled
) {
2413 for ( key
in mw
.loader
.store
.items
) {
2414 module
= key
.slice( 0, key
.indexOf( '@' ) );
2415 if ( getModuleKey( module
) !== key
) {
2416 mw
.loader
.store
.stats
.expired
++;
2417 delete mw
.loader
.store
.items
[ key
];
2418 } else if ( mw
.loader
.store
.items
[ key
].length
> mw
.loader
.store
.MODULE_SIZE_MAX
) {
2419 // This value predates the enforcement of a size limit on cached modules.
2420 delete mw
.loader
.store
.items
[ key
];
2427 * Clear the entire module store right now.
2429 clear: function () {
2430 mw
.loader
.store
.items
= {};
2432 localStorage
.removeItem( mw
.loader
.store
.getStoreKey() );
2433 } catch ( ignored
) {}
2437 * Sync in-memory store back to localStorage.
2439 * This function debounces updates. When called with a flush already pending,
2440 * the call is coalesced into the pending update. The call to
2441 * localStorage.setItem will be naturally deferred until the page is quiescent.
2443 * Because localStorage is shared by all pages from the same origin, if multiple
2444 * pages are loaded with different module sets, the possibility exists that
2445 * modules saved by one page will be clobbered by another. But the impact would
2446 * be minor and the problem would be corrected by subsequent page views.
2450 update
: ( function () {
2451 var hasPendingWrite
= false;
2453 function flushWrites() {
2455 if ( !hasPendingWrite
|| !mw
.loader
.store
.enabled
) {
2459 mw
.loader
.store
.prune();
2460 key
= mw
.loader
.store
.getStoreKey();
2462 // Replacing the content of the module store might fail if the new
2463 // contents would exceed the browser's localStorage size limit. To
2464 // avoid clogging the browser with stale data, always remove the old
2465 // value before attempting to set the new one.
2466 localStorage
.removeItem( key
);
2467 data
= JSON
.stringify( mw
.loader
.store
);
2468 localStorage
.setItem( key
, data
);
2470 mw
.track( 'resourceloader.exception', { exception
: e
, source
: 'store-localstorage-update' } );
2473 hasPendingWrite
= false;
2476 return function () {
2477 if ( !hasPendingWrite
) {
2478 hasPendingWrite
= true;
2479 mw
.requestIdleCallback( flushWrites
);
2488 * HTML construction helper functions
2495 * output = Html.element( 'div', {}, new Html.Raw(
2496 * Html.element( 'img', { src: '<' } )
2498 * mw.log( output ); // <div><img src="<"/></div>
2503 html
: ( function () {
2504 function escapeCallback( s
) {
2521 * Escape a string for HTML.
2523 * Converts special characters to HTML entities.
2525 * mw.html.escape( '< > \' & "' );
2526 * // Returns < > ' & "
2528 * @param {string} s The string to escape
2529 * @return {string} HTML
2531 escape: function ( s
) {
2532 return s
.replace( /['"<>&]/g, escapeCallback
);
2536 * Create an HTML element string, with safe escaping.
2538 * @param {string} name The tag name.
2539 * @param {Object} [attrs] An object with members mapping element names to values
2540 * @param {string|mw.html.Raw|mw.html.Cdata|null} [contents=null] The contents of the element.
2542 * - string: Text to be escaped.
2543 * - null: The element is treated as void with short closing form, e.g. `<br/>`.
2544 * - this.Raw: The raw value is directly included.
2545 * - this.Cdata: The raw value is directly included. An exception is
2546 * thrown if it contains any illegal ETAGO delimiter.
2547 * See <https://www.w3.org/TR/html401/appendix/notes.html#h-B.3.2>.
2548 * @return {string} HTML
2550 element: function ( name
, attrs
, contents
) {
2551 var v
, attrName
, s
= '<' + name
;
2554 for ( attrName
in attrs
) {
2555 v
= attrs
[ attrName
];
2556 // Convert name=true, to name=name
2560 } else if ( v
=== false ) {
2563 s
+= ' ' + attrName
+ '="' + this.escape( String( v
) ) + '"';
2566 if ( contents
=== undefined || contents
=== null ) {
2573 switch ( typeof contents
) {
2576 s
+= this.escape( contents
);
2580 // Convert to string
2581 s
+= String( contents
);
2584 if ( contents
instanceof this.Raw
) {
2585 // Raw HTML inclusion
2586 s
+= contents
.value
;
2587 } else if ( contents
instanceof this.Cdata
) {
2589 if ( /<\/[a-zA-z]/.test( contents
.value
) ) {
2590 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
2592 s
+= contents
.value
;
2594 throw new Error( 'mw.html.element: Invalid type of contents' );
2597 s
+= '</' + name
+ '>';
2602 * Wrapper object for raw HTML passed to mw.html.element().
2604 * @class mw.html.Raw
2606 * @param {string} value
2608 Raw: function ( value
) {
2613 * Wrapper object for CDATA element contents passed to mw.html.element()
2615 * @class mw.html.Cdata
2617 * @param {string} value
2619 Cdata: function ( value
) {
2625 // Skeleton user object, extended by the 'mediawiki.user' module.
2632 * @property {mw.Map}
2636 * @property {mw.Map}
2641 // OOUI widgets specific to MediaWiki
2645 * Registry and firing of events.
2647 * MediaWiki has various interface components that are extended, enhanced
2648 * or manipulated in some other way by extensions, gadgets and even
2651 * This framework helps streamlining the timing of when these other
2652 * code paths fire their plugins (instead of using document-ready,
2653 * which can and should be limited to firing only once).
2655 * Features like navigating to other wiki pages, previewing an edit
2656 * and editing itself – without a refresh – can then retrigger these
2657 * hooks accordingly to ensure everything still works as expected.
2661 * mw.hook( 'wikipage.content' ).add( fn ).remove( fn );
2662 * mw.hook( 'wikipage.content' ).fire( $content );
2664 * Handlers can be added and fired for arbitrary event names at any time. The same
2665 * event can be fired multiple times. The last run of an event is memorized
2666 * (similar to `$(document).ready` and `$.Deferred().done`).
2667 * This means if an event is fired, and a handler added afterwards, the added
2668 * function will be fired right away with the last given event data.
2670 * Like Deferreds and Promises, the mw.hook object is both detachable and chainable.
2671 * Thus allowing flexible use and optimal maintainability and authority control.
2672 * You can pass around the `add` and/or `fire` method to another piece of code
2673 * without it having to know the event name (or `mw.hook` for that matter).
2675 * var h = mw.hook( 'bar.ready' );
2676 * new mw.Foo( .. ).fetch( { callback: h.fire } );
2678 * Note: Events are documented with an underscore instead of a dot in the event
2679 * name due to jsduck not supporting dots in that position.
2683 hook
: ( function () {
2687 * Create an instance of mw.hook.
2691 * @param {string} name Name of hook.
2694 return function ( name
) {
2695 var list
= hasOwn
.call( lists
, name
) ?
2697 lists
[ name
] = $.Callbacks( 'memory' );
2701 * Register a hook handler
2703 * @param {...Function} handler Function to bind.
2709 * Unregister a hook handler
2711 * @param {...Function} handler Function to unbind.
2714 remove
: list
.remove
,
2716 // eslint-disable-next-line valid-jsdoc
2720 * @param {...Mixed} data
2724 return list
.fireWith
.call( this, null, slice
.call( arguments
) );
2731 // Alias $j to jQuery for backwards compatibility
2732 // @deprecated since 1.23 Use $ or jQuery instead
2733 mw
.log
.deprecate( window
, '$j', $, 'Use $ or jQuery instead.' );
2736 * Log a message to window.console, if possible.
2738 * Useful to force logging of some errors that are otherwise hard to detect (i.e., this logs
2739 * also in production mode). Gets console references in each invocation instead of caching the
2740 * reference, so that debugging tools loaded later are supported (e.g. Firebug Lite in IE).
2743 * @param {string} topic Stream name passed by mw.track
2744 * @param {Object} data Data passed by mw.track
2745 * @param {Error} [data.exception]
2746 * @param {string} data.source Error source
2747 * @param {string} [data.module] Name of module which caused the error
2749 function logError( topic
, data
) {
2750 /* eslint-disable no-console */
2753 source
= data
.source
,
2754 module
= data
.module
,
2755 console
= window
.console
;
2757 if ( console
&& console
.log
) {
2758 msg
= ( e
? 'Exception' : 'Error' ) + ' in ' + source
;
2760 msg
+= ' in module ' + module
;
2762 msg
+= ( e
? ':' : '.' );
2765 // If we have an exception object, log it to the error channel to trigger
2766 // proper stacktraces in browsers that support it. No fallback as we have
2767 // no browsers that don't support error(), but do support log().
2768 if ( e
&& console
.error
) {
2769 console
.error( String( e
), e
);
2772 /* eslint-enable no-console */
2775 // Subscribe to error streams
2776 mw
.trackSubscribe( 'resourceloader.exception', logError
);
2777 mw
.trackSubscribe( 'resourceloader.assert', logError
);
2780 * Fired when all modules associated with the page have finished loading.
2782 * @event resourceloader_loadEnd
2786 var loading
= $.grep( mw
.loader
.getModuleNames(), function ( module
) {
2787 return mw
.loader
.getState( module
) === 'loading';
2789 // We only need a callback, not any actual module. First try a single using()
2790 // for all loading modules. If one fails, fall back to tracking each module
2791 // separately via $.when(), this is expensive.
2792 loading
= mw
.loader
.using( loading
).then( null, function () {
2793 var all
= loading
.map( function ( module
) {
2794 return mw
.loader
.using( module
).then( null, function () {
2795 return $.Deferred().resolve();
2798 return $.when
.apply( $, all
);
2800 loading
.then( function () {
2801 /* global mwPerformance */
2802 mwPerformance
.mark( 'mwLoadEnd' );
2803 mw
.hook( 'resourceloader.loadEnd' ).fire();
2807 // Attach to window and globally alias
2808 window
.mw
= window
.mediaWiki
= mw
;