2 * Base library for MediaWiki.
4 * Exposed globally as `mediaWiki` with `mw` as shortcut.
7 * @alternateClassName mediaWiki
16 var mw
, StringSet
, log
,
17 hasOwn
= Object
.prototype.hasOwnProperty
,
18 slice
= Array
.prototype.slice
,
19 trackCallbacks
= $.Callbacks( 'memory' ),
24 * FNV132 hash function
26 * This function implements the 32-bit version of FNV-1.
27 * It is equivalent to hash( 'fnv132', ... ) in PHP, except
28 * its output is base 36 rather than hex.
29 * See <https://en.wikipedia.org/wiki/FNV_hash_function>
32 * @param {string} str String to hash
33 * @return {string} hash as an seven-character base 36 string
35 function fnv132( str
) {
36 /* eslint-disable no-bitwise */
37 var hash
= 0x811C9DC5,
40 for ( i
= 0; i
< str
.length
; i
++ ) {
41 hash
+= ( hash
<< 1 ) + ( hash
<< 4 ) + ( hash
<< 7 ) + ( hash
<< 8 ) + ( hash
<< 24 );
42 hash
^= str
.charCodeAt( i
);
45 hash
= ( hash
>>> 0 ).toString( 36 );
46 while ( hash
.length
< 7 ) {
51 /* eslint-enable no-bitwise */
54 function defineFallbacks() {
55 // <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set>
56 StringSet
= window
.Set
|| ( function () {
61 function StringSet() {
64 StringSet
.prototype.add = function ( value
) {
65 this.set[ value
] = true;
67 StringSet
.prototype.has = function ( value
) {
68 return hasOwn
.call( this.set, value
);
75 * Alias property to the global object.
82 * @param {Mixed} value
84 function setGlobalMapValue( map
, key
, value
) {
85 map
.values
[ key
] = value
;
90 // Deprecation notice for mw.config globals (T58550, T72470)
91 map
=== mw
.config
&& 'Use mw.config instead.'
96 * Create an object that can be read from or written to via methods that allow
97 * interaction both with single and multiple properties at once.
103 * @param {boolean} [global=false] Whether to synchronise =values to the global
104 * window object (for backwards-compatibility with mw.config; T72470). Values are
105 * copied in one direction only. Changes to globals do not reflect in the map.
107 function Map( global
) {
109 if ( global
=== true ) {
110 // Override #set to also set the global variable
111 this.set = function ( selection
, value
) {
113 if ( arguments
.length
> 1 ) {
114 if ( typeof selection
!== 'string' ) {
117 setGlobalMapValue( this, selection
, value
);
120 if ( typeof selection
=== 'object' ) {
121 for ( s
in selection
) {
122 setGlobalMapValue( this, s
, selection
[ s
] );
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
) ) {
1081 // eslint-disable-next-line no-use-before-define
1089 * Resolve dependencies and detect circular references.
1092 * @param {string} module Name of the top-level module whose dependencies shall be
1093 * resolved and sorted.
1094 * @param {Array} resolved Returns a topological sort of the given module and its
1095 * dependencies, such that later modules depend on earlier modules. The array
1096 * contains the module names. If the array contains already some module names,
1097 * this function appends its result to the pre-existing array.
1098 * @param {StringSet} [unresolved] Used to track the current dependency
1099 * chain, and to report loops in the dependency graph.
1100 * @throws {Error} If any unregistered module or a dependency loop is encountered
1102 function sortDependencies( module
, resolved
, unresolved
) {
1105 if ( !hasOwn
.call( registry
, module
) ) {
1106 throw new Error( 'Unknown dependency: ' + module
);
1109 if ( registry
[ module
].skip
!== null ) {
1110 // eslint-disable-next-line no-new-func
1111 skip
= new Function( registry
[ module
].skip
);
1112 registry
[ module
].skip
= null;
1114 registry
[ module
].skipped
= true;
1115 registry
[ module
].dependencies
= [];
1116 registry
[ module
].state
= 'ready';
1117 handlePending( module
);
1122 if ( resolved
.indexOf( module
) !== -1 ) {
1123 // Module already resolved; nothing to do
1126 // Create unresolved if not passed in
1127 if ( !unresolved
) {
1128 unresolved
= new StringSet();
1130 // Tracks down dependencies
1131 deps
= registry
[ module
].dependencies
;
1132 for ( i
= 0; i
< deps
.length
; i
++ ) {
1133 if ( resolved
.indexOf( deps
[ i
] ) === -1 ) {
1134 if ( unresolved
.has( deps
[ i
] ) ) {
1135 throw new Error( mw
.format(
1136 'Circular reference detected: $1 -> $2',
1142 unresolved
.add( module
);
1143 sortDependencies( deps
[ i
], resolved
, unresolved
);
1146 resolved
.push( module
);
1150 * Get names of module that a module depends on, in their proper dependency order.
1153 * @param {string[]} modules Array of string module names
1154 * @return {Array} List of dependencies, including 'module'.
1155 * @throws {Error} If an unregistered module or a dependency loop is encountered
1157 function resolve( modules
) {
1158 var i
, resolved
= [];
1159 for ( i
= 0; i
< modules
.length
; i
++ ) {
1160 sortDependencies( modules
[ i
], resolved
);
1166 * Like #resolve(), except it will silently ignore modules that
1167 * are missing or have missing dependencies.
1170 * @param {string[]} modules Array of string module names
1171 * @return {Array} List of dependencies.
1173 function resolveStubbornly( modules
) {
1174 var i
, saved
, resolved
= [];
1175 for ( i
= 0; i
< modules
.length
; i
++ ) {
1176 saved
= resolved
.slice();
1178 sortDependencies( modules
[ i
], resolved
);
1180 // This module is unknown or has unknown dependencies.
1181 // Undo any incomplete resolutions made and keep going.
1183 mw
.track( 'resourceloader.exception', {
1193 * Load and execute a script.
1196 * @param {string} src URL to script, will be used as the src attribute in the script tag
1197 * @param {Function} [callback] Callback to run after request resolution
1199 function addScript( src
, callback
) {
1200 var script
= document
.createElement( 'script' );
1202 script
.onload
= script
.onerror = function () {
1203 if ( script
.parentNode
) {
1204 script
.parentNode
.removeChild( script
);
1212 document
.head
.appendChild( script
);
1216 * Queue the loading and execution of a script for a particular module.
1219 * @param {string} src URL of the script
1220 * @param {string} moduleName Name of currently executing module
1221 * @param {Function} callback Callback to run after addScript() resolution
1223 function queueModuleScript( src
, moduleName
, callback
) {
1224 pendingRequests
.push( function () {
1225 if ( hasOwn
.call( registry
, moduleName
) ) {
1226 // Emulate runScript() part of execute()
1227 window
.require
= mw
.loader
.require
;
1228 window
.module
= registry
[ moduleName
].module
;
1230 addScript( src
, function () {
1231 // 'module.exports' should not persist after the file is executed to
1232 // avoid leakage to unrelated code. 'require' should be kept, however,
1233 // as asynchronous access to 'require' is allowed and expected. (T144879)
1234 delete window
.module
;
1236 // Start the next one (if any)
1237 if ( pendingRequests
[ 0 ] ) {
1238 pendingRequests
.shift()();
1240 handlingPendingRequests
= false;
1244 if ( !handlingPendingRequests
&& pendingRequests
[ 0 ] ) {
1245 handlingPendingRequests
= true;
1246 pendingRequests
.shift()();
1251 * Utility function for execute()
1254 * @param {string} [media] Media attribute
1255 * @param {string} url URL
1257 function addLink( media
, url
) {
1258 var el
= document
.createElement( 'link' );
1260 el
.rel
= 'stylesheet';
1261 if ( media
&& media
!== 'all' ) {
1264 // If you end up here from an IE exception "SCRIPT: Invalid property value.",
1265 // see #addEmbeddedCSS, T33676, T43331, and T49277 for details.
1268 if ( marker
&& marker
.parentNode
) {
1269 marker
.parentNode
.insertBefore( el
, marker
);
1271 document
.head
.appendChild( el
);
1277 * @param {string} code JavaScript code
1279 function domEval( code
) {
1280 var script
= document
.createElement( 'script' );
1282 document
.head
.appendChild( script
);
1283 script
.parentNode
.removeChild( script
);
1287 * Executes a loaded module, making it ready to use
1290 * @param {string} module Module name to execute
1292 function execute( module
) {
1293 var key
, value
, media
, i
, urls
, cssHandle
, checkCssHandles
, runScript
,
1294 cssHandlesRegistered
= false;
1296 if ( !hasOwn
.call( registry
, module
) ) {
1297 throw new Error( 'Module has not been registered yet: ' + module
);
1299 if ( registry
[ module
].state
!== 'loaded' ) {
1300 throw new Error( 'Module in state "' + registry
[ module
].state
+ '" may not be executed: ' + module
);
1303 registry
[ module
].state
= 'executing';
1305 runScript = function () {
1306 var script
, markModuleReady
, nestedAddScript
;
1308 script
= registry
[ module
].script
;
1309 markModuleReady = function () {
1310 registry
[ module
].state
= 'ready';
1311 handlePending( module
);
1313 nestedAddScript = function ( arr
, callback
, i
) {
1314 // Recursively call queueModuleScript() in its own callback
1315 // for each element of arr.
1316 if ( i
>= arr
.length
) {
1317 // We're at the end of the array
1322 queueModuleScript( arr
[ i
], module
, function () {
1323 nestedAddScript( arr
, callback
, i
+ 1 );
1328 if ( Array
.isArray( script
) ) {
1329 nestedAddScript( script
, markModuleReady
, 0 );
1330 } else if ( typeof script
=== 'function' ) {
1331 // Pass jQuery twice so that the signature of the closure which wraps
1332 // the script can bind both '$' and 'jQuery'.
1333 script( $, $, mw
.loader
.require
, registry
[ module
].module
);
1336 } else if ( typeof script
=== 'string' ) {
1337 // Site and user modules are legacy scripts that run in the global scope.
1338 // This is transported as a string instead of a function to avoid needing
1339 // to use string manipulation to undo the function wrapper.
1344 // Module without script
1348 // Use mw.track instead of mw.log because these errors are common in production mode
1349 // (e.g. undefined variable), and mw.log is only enabled in debug mode.
1350 registry
[ module
].state
= 'error';
1351 mw
.track( 'resourceloader.exception', { exception
: e
, module
: module
, source
: 'module-execute' } );
1352 handlePending( module
);
1356 // Add localizations to message system
1357 if ( registry
[ module
].messages
) {
1358 mw
.messages
.set( registry
[ module
].messages
);
1361 // Initialise templates
1362 if ( registry
[ module
].templates
) {
1363 mw
.templates
.set( module
, registry
[ module
].templates
);
1366 // Make sure we don't run the scripts until all stylesheet insertions have completed.
1369 checkCssHandles = function () {
1370 // cssHandlesRegistered ensures we don't take off too soon, e.g. when
1371 // one of the cssHandles is fired while we're still creating more handles.
1372 if ( cssHandlesRegistered
&& pending
=== 0 && runScript
) {
1373 if ( module
=== 'user' ) {
1374 // Implicit dependency on the site module. Not real dependency because
1375 // it should run after 'site' regardless of whether it succeeds or fails.
1376 mw
.loader
.using( [ 'site' ] ).always( runScript
);
1380 runScript
= undefined; // Revoke
1383 cssHandle = function () {
1384 var check
= checkCssHandles
;
1386 return function () {
1390 check
= undefined; // Revoke
1396 // Process styles (see also mw.loader.implement)
1397 // * back-compat: { <media>: css }
1398 // * back-compat: { <media>: [url, ..] }
1399 // * { "css": [css, ..] }
1400 // * { "url": { <media>: [url, ..] } }
1401 if ( registry
[ module
].style
) {
1402 for ( key
in registry
[ module
].style
) {
1403 value
= registry
[ module
].style
[ key
];
1406 if ( key
!== 'url' && key
!== 'css' ) {
1407 // Backwards compatibility, key is a media-type
1408 if ( typeof value
=== 'string' ) {
1409 // back-compat: { <media>: css }
1410 // Ignore 'media' because it isn't supported (nor was it used).
1411 // Strings are pre-wrapped in "@media". The media-type was just ""
1412 // (because it had to be set to something).
1413 // This is one of the reasons why this format is no longer used.
1414 addEmbeddedCSS( value
, cssHandle() );
1416 // back-compat: { <media>: [url, ..] }
1422 // Array of css strings in key 'css',
1423 // or back-compat array of urls from media-type
1424 if ( Array
.isArray( value
) ) {
1425 for ( i
= 0; i
< value
.length
; i
++ ) {
1426 if ( key
=== 'bc-url' ) {
1427 // back-compat: { <media>: [url, ..] }
1428 addLink( media
, value
[ i
] );
1429 } else if ( key
=== 'css' ) {
1430 // { "css": [css, ..] }
1431 addEmbeddedCSS( value
[ i
], cssHandle() );
1434 // Not an array, but a regular object
1435 // Array of urls inside media-type key
1436 } else if ( typeof value
=== 'object' ) {
1437 // { "url": { <media>: [url, ..] } }
1438 for ( media
in value
) {
1439 urls
= value
[ media
];
1440 for ( i
= 0; i
< urls
.length
; i
++ ) {
1441 addLink( media
, urls
[ i
] );
1449 cssHandlesRegistered
= true;
1454 * Add one or more modules to the module load queue.
1459 * @param {string|string[]} dependencies Module name or array of string module names
1460 * @param {Function} [ready] Callback to execute when all dependencies are ready
1461 * @param {Function} [error] Callback to execute when any dependency fails
1463 function enqueue( dependencies
, ready
, error
) {
1464 // Allow calling by single module name
1465 if ( typeof dependencies
=== 'string' ) {
1466 dependencies
= [ dependencies
];
1469 // Add ready and error callbacks if they were given
1470 if ( ready
!== undefined || error
!== undefined ) {
1472 // Narrow down the list to modules that are worth waiting for
1473 dependencies
: dependencies
.filter( function ( module
) {
1474 var state
= mw
.loader
.getState( module
);
1475 return state
=== 'registered' || state
=== 'loaded' || state
=== 'loading' || state
=== 'executing';
1482 dependencies
.forEach( function ( module
) {
1483 var state
= mw
.loader
.getState( module
);
1484 // Only queue modules that are still in the initial 'registered' state
1485 // (not ones already loading, ready or error).
1486 if ( state
=== 'registered' && queue
.indexOf( module
) === -1 ) {
1487 // Private modules must be embedded in the page. Don't bother queuing
1488 // these as the server will deny them anyway (T101806).
1489 if ( registry
[ module
].group
=== 'private' ) {
1490 registry
[ module
].state
= 'error';
1491 handlePending( module
);
1494 queue
.push( module
);
1501 function sortQuery( o
) {
1510 for ( key
= 0; key
< a
.length
; key
++ ) {
1511 sorted
[ a
[ key
] ] = o
[ a
[ key
] ];
1517 * Converts a module map of the form `{ foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }`
1518 * to a query string of the form `foo.bar,baz|bar.baz,quux`.
1520 * See `ResourceLoader::makePackedModulesString()` in PHP, of which this is a port.
1521 * On the server, unpacking is done by `ResourceLoaderContext::expandModuleNames()`.
1523 * Note: This is only half of the logic, the other half has to be in #batchRequest(),
1524 * because its implementation needs to keep track of potential string size in order
1525 * to decide when to split the requests due to url size.
1528 * @param {Object} moduleMap Module map
1530 * @return {string} return.str Module query string
1531 * @return {Array} return.list List of module names in matching order
1533 function buildModulesString( moduleMap
) {
1538 function restore( suffix
) {
1542 for ( prefix
in moduleMap
) {
1543 p
= prefix
=== '' ? '' : prefix
+ '.';
1544 str
.push( p
+ moduleMap
[ prefix
].join( ',' ) );
1545 list
.push
.apply( list
, moduleMap
[ prefix
].map( restore
) );
1548 str
: str
.join( '|' ),
1554 * Resolve indexed dependencies.
1556 * ResourceLoader uses an optimization to save space which replaces module names in
1557 * dependency lists with the index of that module within the array of module
1558 * registration data if it exists. The benefit is a significant reduction in the data
1559 * size of the startup module. This function changes those dependency lists back to
1560 * arrays of strings.
1563 * @param {Array} modules Modules array
1565 function resolveIndexedDependencies( modules
) {
1567 function resolveIndex( dep
) {
1568 return typeof dep
=== 'number' ? modules
[ dep
][ 0 ] : dep
;
1570 for ( i
= 0; i
< modules
.length
; i
++ ) {
1571 deps
= modules
[ i
][ 2 ];
1573 for ( j
= 0; j
< deps
.length
; j
++ ) {
1574 deps
[ j
] = resolveIndex( deps
[ j
] );
1581 * Create network requests for a batch of modules.
1583 * This is an internal method for #work(). This must not be called directly
1584 * unless the modules are already registered, and no request is in progress,
1585 * and the module state has already been set to `loading`.
1588 * @param {string[]} batch
1590 function batchRequest( batch
) {
1591 var reqBase
, splits
, maxQueryLength
, b
, bSource
, bGroup
, bSourceGroup
,
1592 source
, group
, i
, modules
, sourceLoadScript
,
1593 currReqBase
, currReqBaseLength
, moduleMap
, currReqModules
, l
,
1594 lastDotIndex
, prefix
, suffix
, bytesAdded
;
1597 * Start the currently drafted request to the server.
1601 function doRequest() {
1602 // Optimisation: Inherit (Object.create), not copy ($.extend)
1603 var query
= Object
.create( currReqBase
),
1604 packed
= buildModulesString( moduleMap
);
1605 query
.modules
= packed
.str
;
1606 // The packing logic can change the effective order, even if the input was
1607 // sorted. As such, the call to getCombinedVersion() must use this
1608 // effective order, instead of currReqModules, as otherwise the combined
1609 // version will not match the hash expected by the server based on
1610 // combining versions from the module query string in-order. (T188076)
1611 query
.version
= getCombinedVersion( packed
.list
);
1612 query
= sortQuery( query
);
1613 addScript( sourceLoadScript
+ '?' + $.param( query
) );
1616 if ( !batch
.length
) {
1620 // Always order modules alphabetically to help reduce cache
1621 // misses for otherwise identical content.
1624 // Query parameters common to all requests
1626 skin
: mw
.config
.get( 'skin' ),
1627 lang
: mw
.config
.get( 'wgUserLanguage' ),
1628 debug
: mw
.config
.get( 'debug' )
1630 maxQueryLength
= mw
.config
.get( 'wgResourceLoaderMaxQueryLength', 2000 );
1632 // Split module list by source and by group.
1634 for ( b
= 0; b
< batch
.length
; b
++ ) {
1635 bSource
= registry
[ batch
[ b
] ].source
;
1636 bGroup
= registry
[ batch
[ b
] ].group
;
1637 if ( !hasOwn
.call( splits
, bSource
) ) {
1638 splits
[ bSource
] = {};
1640 if ( !hasOwn
.call( splits
[ bSource
], bGroup
) ) {
1641 splits
[ bSource
][ bGroup
] = [];
1643 bSourceGroup
= splits
[ bSource
][ bGroup
];
1644 bSourceGroup
.push( batch
[ b
] );
1647 for ( source
in splits
) {
1649 sourceLoadScript
= sources
[ source
];
1651 for ( group
in splits
[ source
] ) {
1653 // Cache access to currently selected list of
1654 // modules for this group from this source.
1655 modules
= splits
[ source
][ group
];
1657 // Query parameters common to requests for this module group
1658 // Optimisation: Inherit (Object.create), not copy ($.extend)
1659 currReqBase
= Object
.create( reqBase
);
1660 // User modules require a user name in the query string.
1661 if ( group
=== 'user' && mw
.config
.get( 'wgUserName' ) !== null ) {
1662 currReqBase
.user
= mw
.config
.get( 'wgUserName' );
1665 // In addition to currReqBase, doRequest() will also add 'modules' and 'version'.
1666 // > '&modules='.length === 9
1667 // > '&version=1234567'.length === 16
1669 currReqBaseLength
= $.param( currReqBase
).length
+ 25;
1671 // We may need to split up the request to honor the query string length limit,
1672 // so build it piece by piece.
1673 l
= currReqBaseLength
;
1674 moduleMap
= {}; // { prefix: [ suffixes ] }
1675 currReqModules
= [];
1677 for ( i
= 0; i
< modules
.length
; i
++ ) {
1678 // Determine how many bytes this module would add to the query string
1679 lastDotIndex
= modules
[ i
].lastIndexOf( '.' );
1680 // If lastDotIndex is -1, substr() returns an empty string
1681 prefix
= modules
[ i
].substr( 0, lastDotIndex
);
1682 suffix
= modules
[ i
].slice( lastDotIndex
+ 1 );
1683 bytesAdded
= hasOwn
.call( moduleMap
, prefix
) ?
1684 suffix
.length
+ 3 : // '%2C'.length == 3
1685 modules
[ i
].length
+ 3; // '%7C'.length == 3
1687 // If the url would become too long, create a new one, but don't create empty requests
1688 if ( maxQueryLength
> 0 && currReqModules
.length
&& l
+ bytesAdded
> maxQueryLength
) {
1689 // Dispatch what we've got...
1691 // .. and start again.
1692 l
= currReqBaseLength
;
1694 currReqModules
= [];
1696 mw
.track( 'resourceloader.splitRequest', { maxQueryLength
: maxQueryLength
} );
1698 if ( !hasOwn
.call( moduleMap
, prefix
) ) {
1699 moduleMap
[ prefix
] = [];
1702 moduleMap
[ prefix
].push( suffix
);
1703 currReqModules
.push( modules
[ i
] );
1705 // If there's anything left in moduleMap, request that too
1706 if ( currReqModules
.length
) {
1715 * @param {string[]} implementations Array containing pieces of JavaScript code in the
1716 * form of calls to mw.loader#implement().
1717 * @param {Function} cb Callback in case of failure
1718 * @param {Error} cb.err
1720 function asyncEval( implementations
, cb
) {
1721 if ( !implementations
.length
) {
1724 mw
.requestIdleCallback( function () {
1726 domEval( implementations
.join( ';' ) );
1734 * Make a versioned key for a specific module.
1737 * @param {string} module Module name
1738 * @return {string|null} Module key in format '`[name]@[version]`',
1739 * or null if the module does not exist
1741 function getModuleKey( module
) {
1742 return hasOwn
.call( registry
, module
) ?
1743 ( module
+ '@' + registry
[ module
].version
) : null;
1748 * @param {string} key Module name or '`[name]@[version]`'
1751 function splitModuleKey( key
) {
1752 var index
= key
.indexOf( '@' );
1753 if ( index
=== -1 ) {
1760 name
: key
.slice( 0, index
),
1761 version
: key
.slice( index
+ 1 )
1765 /* Public Members */
1768 * The module registry is exposed as an aid for debugging and inspecting page
1769 * state; it is not a public interface for modifying the registry.
1775 moduleRegistry
: registry
,
1778 * @inheritdoc #newStyleTag
1781 addStyleTag
: newStyleTag
,
1784 * Start loading of all queued module dependencies.
1789 var q
, batch
, implementations
, sourceModules
;
1793 // Appends a list of modules from the queue to the batch
1794 for ( q
= 0; q
< queue
.length
; q
++ ) {
1795 // Only load modules which are registered
1796 if ( hasOwn
.call( registry
, queue
[ q
] ) && registry
[ queue
[ q
] ].state
=== 'registered' ) {
1797 // Prevent duplicate entries
1798 if ( batch
.indexOf( queue
[ q
] ) === -1 ) {
1799 batch
.push( queue
[ q
] );
1800 // Mark registered modules as loading
1801 registry
[ queue
[ q
] ].state
= 'loading';
1806 // Now that the queue has been processed into a batch, clear the queue.
1807 // This MUST happen before we initiate any eval or network request. Otherwise,
1808 // it is possible for a cached script to instantly trigger the same work queue
1809 // again; all before we've cleared it causing each request to include modules
1810 // which are already loaded.
1813 if ( !batch
.length
) {
1817 mw
.loader
.store
.init();
1818 if ( mw
.loader
.store
.enabled
) {
1819 implementations
= [];
1821 batch
= batch
.filter( function ( module
) {
1822 var implementation
= mw
.loader
.store
.get( module
);
1823 if ( implementation
) {
1824 implementations
.push( implementation
);
1825 sourceModules
.push( module
);
1830 asyncEval( implementations
, function ( err
) {
1832 // Not good, the cached mw.loader.implement calls failed! This should
1833 // never happen, barring ResourceLoader bugs, browser bugs and PEBKACs.
1834 // Depending on how corrupt the string is, it is likely that some
1835 // modules' implement() succeeded while the ones after the error will
1836 // never run and leave their modules in the 'loading' state forever.
1837 mw
.loader
.store
.stats
.failed
++;
1839 // Since this is an error not caused by an individual module but by
1840 // something that infected the implement call itself, don't take any
1841 // risks and clear everything in this cache.
1842 mw
.loader
.store
.clear();
1844 mw
.track( 'resourceloader.exception', { exception
: err
, source
: 'store-eval' } );
1845 // Re-add the failed ones that are still pending back to the batch
1846 failed
= sourceModules
.filter( function ( module
) {
1847 return registry
[ module
].state
=== 'loading';
1849 batchRequest( failed
);
1853 batchRequest( batch
);
1857 * Register a source.
1859 * The #work() method will use this information to split up requests by source.
1861 * mw.loader.addSource( 'mediawikiwiki', '//www.mediawiki.org/w/load.php' );
1863 * @param {string|Object} id Source ID, or object mapping ids to load urls
1864 * @param {string} loadUrl Url to a load.php end point
1865 * @throws {Error} If source id is already registered
1867 addSource: function ( id
, loadUrl
) {
1869 // Allow multiple additions
1870 if ( typeof id
=== 'object' ) {
1871 for ( source
in id
) {
1872 mw
.loader
.addSource( source
, id
[ source
] );
1877 if ( hasOwn
.call( sources
, id
) ) {
1878 throw new Error( 'source already registered: ' + id
);
1881 sources
[ id
] = loadUrl
;
1885 * Register a module, letting the system know about it and its properties.
1887 * The startup modules contain calls to this method.
1889 * When using multiple module registration by passing an array, dependencies that
1890 * are specified as references to modules within the array will be resolved before
1891 * the modules are registered.
1893 * @param {string|Array} module Module name or array of arrays, each containing
1894 * a list of arguments compatible with this method
1895 * @param {string|number} version Module version hash (falls backs to empty string)
1896 * Can also be a number (timestamp) for compatibility with MediaWiki 1.25 and earlier.
1897 * @param {string|Array} dependencies One string or array of strings of module
1898 * names on which this module depends.
1899 * @param {string} [group=null] Group which the module is in
1900 * @param {string} [source='local'] Name of the source
1901 * @param {string} [skip=null] Script body of the skip function
1903 register: function ( module
, version
, dependencies
, group
, source
, skip
) {
1905 // Allow multiple registration
1906 if ( typeof module
=== 'object' ) {
1907 resolveIndexedDependencies( module
);
1908 for ( i
= 0; i
< module
.length
; i
++ ) {
1909 // module is an array of module names
1910 if ( typeof module
[ i
] === 'string' ) {
1911 mw
.loader
.register( module
[ i
] );
1912 // module is an array of arrays
1913 } else if ( typeof module
[ i
] === 'object' ) {
1914 mw
.loader
.register
.apply( mw
.loader
, module
[ i
] );
1919 if ( hasOwn
.call( registry
, module
) ) {
1920 throw new Error( 'module already registered: ' + module
);
1922 if ( typeof dependencies
=== 'string' ) {
1923 // A single module name
1924 deps
= [ dependencies
];
1925 } else if ( typeof dependencies
=== 'object' ) {
1926 // Array of module names
1927 deps
= dependencies
;
1929 // List the module as registered
1930 registry
[ module
] = {
1931 // Exposed to execute() for mw.loader.implement() closures.
1932 // Import happens via require().
1936 version
: version
!== undefined ? String( version
) : '',
1937 dependencies
: deps
|| [],
1938 group
: typeof group
=== 'string' ? group
: null,
1939 source
: typeof source
=== 'string' ? source
: 'local',
1940 state
: 'registered',
1941 skip
: typeof skip
=== 'string' ? skip
: null
1946 * Implement a module given the components that make up the module.
1948 * When #load() or #using() requests one or more modules, the server
1949 * response contain calls to this function.
1951 * @param {string} module Name of module and current module version. Formatted
1952 * as '`[name]@[version]`". This version should match the requested version
1953 * (from #batchRequest and #registry). This avoids race conditions (T117587).
1954 * For back-compat with MediaWiki 1.27 and earlier, the version may be omitted.
1955 * @param {Function|Array|string} [script] Function with module code, list of URLs
1956 * to load via `<script src>`, or string of module code for `$.globalEval()`.
1957 * @param {Object} [style] Should follow one of the following patterns:
1959 * { "css": [css, ..] }
1960 * { "url": { <media>: [url, ..] } }
1962 * And for backwards compatibility (needs to be supported forever due to caching):
1965 * { <media>: [url, ..] }
1967 * The reason css strings are not concatenated anymore is T33676. We now check
1968 * whether it's safe to extend the stylesheet.
1971 * @param {Object} [messages] List of key/value pairs to be added to mw#messages.
1972 * @param {Object} [templates] List of key/value pairs to be added to mw#templates.
1974 implement: function ( module
, script
, style
, messages
, templates
) {
1975 var split
= splitModuleKey( module
),
1977 version
= split
.version
;
1978 // Automatically register module
1979 if ( !hasOwn
.call( registry
, name
) ) {
1980 mw
.loader
.register( name
);
1982 // Check for duplicate implementation
1983 if ( hasOwn
.call( registry
, name
) && registry
[ name
].script
!== undefined ) {
1984 throw new Error( 'module already implemented: ' + name
);
1987 // Without this reset, if there is a version mismatch between the
1988 // requested and received module version, then mw.loader.store would
1989 // cache the response under the requested key. Thus poisoning the cache
1990 // indefinitely with a stale value. (T117587)
1991 registry
[ name
].version
= version
;
1993 // Attach components
1994 registry
[ name
].script
= script
|| null;
1995 registry
[ name
].style
= style
|| null;
1996 registry
[ name
].messages
= messages
|| null;
1997 registry
[ name
].templates
= templates
|| null;
1998 // The module may already have been marked as erroneous
1999 if ( registry
[ name
].state
!== 'error' && registry
[ name
].state
!== 'missing' ) {
2000 registry
[ name
].state
= 'loaded';
2001 if ( allReady( registry
[ name
].dependencies
) ) {
2008 * Execute a function as soon as one or more required modules are ready.
2010 * Example of inline dependency on OOjs:
2012 * mw.loader.using( 'oojs', function () {
2013 * OO.compare( [ 1 ], [ 1 ] );
2016 * Example of inline dependency obtained via `require()`:
2018 * mw.loader.using( [ 'mediawiki.util' ], function ( require ) {
2019 * var util = require( 'mediawiki.util' );
2022 * Since MediaWiki 1.23 this also returns a promise.
2024 * Since MediaWiki 1.28 the promise is resolved with a `require` function.
2026 * @param {string|Array} dependencies Module name or array of modules names the
2027 * callback depends on to be ready before executing
2028 * @param {Function} [ready] Callback to execute when all dependencies are ready
2029 * @param {Function} [error] Callback to execute if one or more dependencies failed
2030 * @return {jQuery.Promise} With a `require` function
2032 using: function ( dependencies
, ready
, error
) {
2033 var deferred
= $.Deferred();
2035 // Allow calling with a single dependency as a string
2036 if ( typeof dependencies
=== 'string' ) {
2037 dependencies
= [ dependencies
];
2041 deferred
.done( ready
);
2044 deferred
.fail( error
);
2048 // Resolve entire dependency map
2049 dependencies
= resolve( dependencies
);
2051 return deferred
.reject( e
).promise();
2053 if ( allReady( dependencies
) ) {
2054 // Run ready immediately
2055 deferred
.resolve( mw
.loader
.require
);
2056 } else if ( anyFailed( dependencies
) ) {
2057 // Execute error immediately if any dependencies have errors
2059 new Error( 'One or more dependencies failed to load' ),
2063 // Not all dependencies are ready, add to the load queue
2064 enqueue( dependencies
, function () {
2065 deferred
.resolve( mw
.loader
.require
);
2066 }, deferred
.reject
);
2069 return deferred
.promise();
2073 * Load an external script or one or more modules.
2075 * This method takes a list of unrelated modules. Use cases:
2077 * - A web page will be composed of many different widgets. These widgets independently
2078 * queue their ResourceLoader modules (`OutputPage::addModules()`). If any of them
2079 * have problems, or are no longer known (e.g. cached HTML), the other modules
2080 * should still be loaded.
2081 * - This method is used for preloading, which must not throw. Later code that
2082 * calls #using() will handle the error.
2084 * @param {string|Array} modules Either the name of a module, array of modules,
2085 * or a URL of an external script or style
2086 * @param {string} [type='text/javascript'] MIME type to use if calling with a URL of an
2087 * external script or style; acceptable values are "text/css" and
2088 * "text/javascript"; if no type is provided, text/javascript is assumed.
2090 load: function ( modules
, type
) {
2093 // Allow calling with a url or single dependency as a string
2094 if ( typeof modules
=== 'string' ) {
2095 // "https://example.org/x.js", "http://example.org/x.js", "//example.org/x.js", "/x.js"
2096 if ( /^(https?:)?\/?\//.test( modules
) ) {
2097 if ( type
=== 'text/css' ) {
2098 l
= document
.createElement( 'link' );
2099 l
.rel
= 'stylesheet';
2101 document
.head
.appendChild( l
);
2104 if ( type
=== 'text/javascript' || type
=== undefined ) {
2105 addScript( modules
);
2109 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type
);
2111 // Called with single module
2112 modules
= [ modules
];
2115 // Filter out top-level modules that are unknown or failed to load before.
2116 filtered
= modules
.filter( function ( module
) {
2117 var state
= mw
.loader
.getState( module
);
2118 return state
!== 'error' && state
!== 'missing';
2120 // Resolve remaining list using the known dependency tree.
2121 // This also filters out modules with unknown dependencies. (T36853)
2122 filtered
= resolveStubbornly( filtered
);
2123 // If all modules are ready, or if any modules have errors, nothing to be done.
2124 if ( allReady( filtered
) || anyFailed( filtered
) ) {
2127 if ( filtered
.length
=== 0 ) {
2130 // Some modules are not yet ready, add to module load queue.
2131 enqueue( filtered
, undefined, undefined );
2135 * Change the state of one or more modules.
2137 * @param {string|Object} module Module name or object of module name/state pairs
2138 * @param {string} state State name
2140 state: function ( module
, state
) {
2143 if ( typeof module
=== 'object' ) {
2144 for ( m
in module
) {
2145 mw
.loader
.state( m
, module
[ m
] );
2149 if ( !hasOwn
.call( registry
, module
) ) {
2150 mw
.loader
.register( module
);
2152 registry
[ module
].state
= state
;
2153 if ( state
=== 'ready' || state
=== 'error' || state
=== 'missing' ) {
2154 // Make sure pending modules depending on this one get executed if their
2155 // dependencies are now fulfilled!
2156 handlePending( module
);
2161 * Get the version of a module.
2163 * @param {string} module Name of module
2164 * @return {string|null} The version, or null if the module (or its version) is not
2167 getVersion: function ( module
) {
2168 return hasOwn
.call( registry
, module
) ? registry
[ module
].version
: null;
2172 * Get the state of a module.
2174 * @param {string} module Name of module
2175 * @return {string|null} The state, or null if the module (or its state) is not
2178 getState: function ( module
) {
2179 return hasOwn
.call( registry
, module
) ? registry
[ module
].state
: null;
2183 * Get the names of all registered modules.
2187 getModuleNames: function () {
2188 return Object
.keys( registry
);
2192 * Get the exported value of a module.
2194 * This static method is publicly exposed for debugging purposes
2195 * only and must not be used in production code. In production code,
2196 * please use the dynamically provided `require()` function instead.
2198 * In case of lazy-loaded modules via mw.loader#using(), the returned
2199 * Promise provides the function, see #using() for examples.
2203 * @param {string} moduleName Module name
2204 * @return {Mixed} Exported value
2206 require: function ( moduleName
) {
2207 var state
= mw
.loader
.getState( moduleName
);
2209 // Only ready modules can be required
2210 if ( state
!== 'ready' ) {
2211 // Module may've forgotten to declare a dependency
2212 throw new Error( 'Module "' + moduleName
+ '" is not loaded.' );
2215 return registry
[ moduleName
].module
.exports
;
2219 * @inheritdoc mw.inspect#runReports
2222 inspect: function () {
2223 var args
= slice
.call( arguments
);
2224 mw
.loader
.using( 'mediawiki.inspect', function () {
2225 mw
.inspect
.runReports
.apply( mw
.inspect
, args
);
2230 * On browsers that implement the localStorage API, the module store serves as a
2231 * smart complement to the browser cache. Unlike the browser cache, the module store
2232 * can slice a concatenated response from ResourceLoader into its constituent
2233 * modules and cache each of them separately, using each module's versioning scheme
2234 * to determine when the cache should be invalidated.
2237 * @class mw.loader.store
2240 // Whether the store is in use on this page.
2243 // Modules whose string representation exceeds 100 kB are
2244 // ineligible for storage. See bug T66721.
2245 MODULE_SIZE_MAX
: 100 * 1000,
2247 // The contents of the store, mapping '[name]@[version]' keys
2248 // to module implementations.
2252 stats
: { hits
: 0, misses
: 0, expired
: 0, failed
: 0 },
2255 * Construct a JSON-serializable object representing the content of the store.
2257 * @return {Object} Module store contents.
2259 toJSON: function () {
2260 return { items
: mw
.loader
.store
.items
, vary
: mw
.loader
.store
.getVary() };
2264 * Get the localStorage key for the entire module store. The key references
2265 * $wgDBname to prevent clashes between wikis which share a common host.
2267 * @return {string} localStorage item key
2269 getStoreKey: function () {
2270 return 'MediaWikiModuleStore:' + mw
.config
.get( 'wgDBname' );
2274 * Get a key on which to vary the module cache.
2276 * @return {string} String of concatenated vary conditions.
2278 getVary: function () {
2280 mw
.config
.get( 'skin' ),
2281 mw
.config
.get( 'wgResourceLoaderStorageVersion' ),
2282 mw
.config
.get( 'wgUserLanguage' )
2287 * Initialize the store.
2289 * Retrieves store from localStorage and (if successfully retrieved) decoding
2290 * the stored JSON value to a plain object.
2292 * The try / catch block is used for JSON & localStorage feature detection.
2293 * See the in-line documentation for Modernizr's localStorage feature detection
2294 * code for a full account of why we need a try / catch:
2295 * <https://github.com/Modernizr/Modernizr/blob/v2.7.1/modernizr.js#L771-L796>.
2300 if ( mw
.loader
.store
.enabled
!== null ) {
2306 // Disabled because localStorage quotas are tight and (in Firefox's case)
2307 // shared by multiple origins.
2308 // See T66721, and <https://bugzilla.mozilla.org/show_bug.cgi?id=1064466>.
2309 /Firefox|Opera/.test( navigator
.userAgent
) ||
2311 // Disabled by configuration.
2312 !mw
.config
.get( 'wgResourceLoaderStorageEnabled' )
2314 // Clear any previous store to free up space. (T66721)
2315 mw
.loader
.store
.clear();
2316 mw
.loader
.store
.enabled
= false;
2319 if ( mw
.config
.get( 'debug' ) ) {
2320 // Disable module store in debug mode
2321 mw
.loader
.store
.enabled
= false;
2326 raw
= localStorage
.getItem( mw
.loader
.store
.getStoreKey() );
2327 // If we get here, localStorage is available; mark enabled
2328 mw
.loader
.store
.enabled
= true;
2329 data
= JSON
.parse( raw
);
2330 if ( data
&& typeof data
.items
=== 'object' && data
.vary
=== mw
.loader
.store
.getVary() ) {
2331 mw
.loader
.store
.items
= data
.items
;
2335 mw
.track( 'resourceloader.exception', { exception
: e
, source
: 'store-localstorage-init' } );
2338 if ( raw
=== undefined ) {
2339 // localStorage failed; disable store
2340 mw
.loader
.store
.enabled
= false;
2342 mw
.loader
.store
.update();
2347 * Retrieve a module from the store and update cache hit stats.
2349 * @param {string} module Module name
2350 * @return {string|boolean} Module implementation or false if unavailable
2352 get: function ( module
) {
2355 if ( !mw
.loader
.store
.enabled
) {
2359 key
= getModuleKey( module
);
2360 if ( key
in mw
.loader
.store
.items
) {
2361 mw
.loader
.store
.stats
.hits
++;
2362 return mw
.loader
.store
.items
[ key
];
2364 mw
.loader
.store
.stats
.misses
++;
2369 * Stringify a module and queue it for storage.
2371 * @param {string} module Module name
2372 * @param {Object} descriptor The module's descriptor as set in the registry
2373 * @return {boolean} Module was set
2375 set: function ( module
, descriptor
) {
2378 if ( !mw
.loader
.store
.enabled
) {
2382 key
= getModuleKey( module
);
2385 // Already stored a copy of this exact version
2386 key
in mw
.loader
.store
.items
||
2387 // Module failed to load
2388 descriptor
.state
!== 'ready' ||
2389 // Unversioned, private, or site-/user-specific
2390 !descriptor
.version
||
2391 descriptor
.group
=== 'private' ||
2392 descriptor
.group
=== 'user' ||
2393 // Partial descriptor
2394 // (e.g. skipped module, or style module with state=ready)
2395 [ descriptor
.script
, descriptor
.style
, descriptor
.messages
,
2396 descriptor
.templates
].indexOf( undefined ) !== -1
2404 JSON
.stringify( key
),
2405 typeof descriptor
.script
=== 'function' ?
2406 String( descriptor
.script
) :
2407 JSON
.stringify( descriptor
.script
),
2408 JSON
.stringify( descriptor
.style
),
2409 JSON
.stringify( descriptor
.messages
),
2410 JSON
.stringify( descriptor
.templates
)
2412 // Attempted workaround for a possible Opera bug (bug T59567).
2413 // This regex should never match under sane conditions.
2414 if ( /^\s*\(/.test( args
[ 1 ] ) ) {
2415 args
[ 1 ] = 'function' + args
[ 1 ];
2416 mw
.track( 'resourceloader.assert', { source
: 'bug-T59567' } );
2419 mw
.track( 'resourceloader.exception', { exception
: e
, source
: 'store-localstorage-json' } );
2423 src
= 'mw.loader.implement(' + args
.join( ',' ) + ');';
2424 if ( src
.length
> mw
.loader
.store
.MODULE_SIZE_MAX
) {
2427 mw
.loader
.store
.items
[ key
] = src
;
2428 mw
.loader
.store
.update();
2433 * Iterate through the module store, removing any item that does not correspond
2434 * (in name and version) to an item in the module registry.
2436 * @return {boolean} Store was pruned
2438 prune: function () {
2441 if ( !mw
.loader
.store
.enabled
) {
2445 for ( key
in mw
.loader
.store
.items
) {
2446 module
= key
.slice( 0, key
.indexOf( '@' ) );
2447 if ( getModuleKey( module
) !== key
) {
2448 mw
.loader
.store
.stats
.expired
++;
2449 delete mw
.loader
.store
.items
[ key
];
2450 } else if ( mw
.loader
.store
.items
[ key
].length
> mw
.loader
.store
.MODULE_SIZE_MAX
) {
2451 // This value predates the enforcement of a size limit on cached modules.
2452 delete mw
.loader
.store
.items
[ key
];
2459 * Clear the entire module store right now.
2461 clear: function () {
2462 mw
.loader
.store
.items
= {};
2464 localStorage
.removeItem( mw
.loader
.store
.getStoreKey() );
2465 } catch ( ignored
) {}
2469 * Sync in-memory store back to localStorage.
2471 * This function debounces updates. When called with a flush already pending,
2472 * the call is coalesced into the pending update. The call to
2473 * localStorage.setItem will be naturally deferred until the page is quiescent.
2475 * Because localStorage is shared by all pages from the same origin, if multiple
2476 * pages are loaded with different module sets, the possibility exists that
2477 * modules saved by one page will be clobbered by another. But the impact would
2478 * be minor and the problem would be corrected by subsequent page views.
2482 update
: ( function () {
2483 var hasPendingWrite
= false;
2485 function flushWrites() {
2487 if ( !hasPendingWrite
|| !mw
.loader
.store
.enabled
) {
2491 mw
.loader
.store
.prune();
2492 key
= mw
.loader
.store
.getStoreKey();
2494 // Replacing the content of the module store might fail if the new
2495 // contents would exceed the browser's localStorage size limit. To
2496 // avoid clogging the browser with stale data, always remove the old
2497 // value before attempting to set the new one.
2498 localStorage
.removeItem( key
);
2499 data
= JSON
.stringify( mw
.loader
.store
);
2500 localStorage
.setItem( key
, data
);
2502 mw
.track( 'resourceloader.exception', { exception
: e
, source
: 'store-localstorage-update' } );
2505 hasPendingWrite
= false;
2508 return function () {
2509 if ( !hasPendingWrite
) {
2510 hasPendingWrite
= true;
2511 mw
.requestIdleCallback( flushWrites
);
2520 * HTML construction helper functions
2527 * output = Html.element( 'div', {}, new Html.Raw(
2528 * Html.element( 'img', { src: '<' } )
2530 * mw.log( output ); // <div><img src="<"/></div>
2535 html
: ( function () {
2536 function escapeCallback( s
) {
2553 * Escape a string for HTML.
2555 * Converts special characters to HTML entities.
2557 * mw.html.escape( '< > \' & "' );
2558 * // Returns < > ' & "
2560 * @param {string} s The string to escape
2561 * @return {string} HTML
2563 escape: function ( s
) {
2564 return s
.replace( /['"<>&]/g, escapeCallback
);
2568 * Create an HTML element string, with safe escaping.
2570 * @param {string} name The tag name.
2571 * @param {Object} [attrs] An object with members mapping element names to values
2572 * @param {string|mw.html.Raw|mw.html.Cdata|null} [contents=null] The contents of the element.
2574 * - string: Text to be escaped.
2575 * - null: The element is treated as void with short closing form, e.g. `<br/>`.
2576 * - this.Raw: The raw value is directly included.
2577 * - this.Cdata: The raw value is directly included. An exception is
2578 * thrown if it contains any illegal ETAGO delimiter.
2579 * See <https://www.w3.org/TR/html401/appendix/notes.html#h-B.3.2>.
2580 * @return {string} HTML
2582 element: function ( name
, attrs
, contents
) {
2583 var v
, attrName
, s
= '<' + name
;
2586 for ( attrName
in attrs
) {
2587 v
= attrs
[ attrName
];
2588 // Convert name=true, to name=name
2592 } else if ( v
=== false ) {
2595 s
+= ' ' + attrName
+ '="' + this.escape( String( v
) ) + '"';
2598 if ( contents
=== undefined || contents
=== null ) {
2605 switch ( typeof contents
) {
2608 s
+= this.escape( contents
);
2612 // Convert to string
2613 s
+= String( contents
);
2616 if ( contents
instanceof this.Raw
) {
2617 // Raw HTML inclusion
2618 s
+= contents
.value
;
2619 } else if ( contents
instanceof this.Cdata
) {
2621 if ( /<\/[a-zA-z]/.test( contents
.value
) ) {
2622 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
2624 s
+= contents
.value
;
2626 throw new Error( 'mw.html.element: Invalid type of contents' );
2629 s
+= '</' + name
+ '>';
2634 * Wrapper object for raw HTML passed to mw.html.element().
2636 * @class mw.html.Raw
2638 * @param {string} value
2640 Raw: function ( value
) {
2645 * Wrapper object for CDATA element contents passed to mw.html.element()
2647 * @class mw.html.Cdata
2649 * @param {string} value
2651 Cdata: function ( value
) {
2657 // Skeleton user object, extended by the 'mediawiki.user' module.
2664 * @property {mw.Map}
2668 * @property {mw.Map}
2673 // OOUI widgets specific to MediaWiki
2677 * Registry and firing of events.
2679 * MediaWiki has various interface components that are extended, enhanced
2680 * or manipulated in some other way by extensions, gadgets and even
2683 * This framework helps streamlining the timing of when these other
2684 * code paths fire their plugins (instead of using document-ready,
2685 * which can and should be limited to firing only once).
2687 * Features like navigating to other wiki pages, previewing an edit
2688 * and editing itself – without a refresh – can then retrigger these
2689 * hooks accordingly to ensure everything still works as expected.
2693 * mw.hook( 'wikipage.content' ).add( fn ).remove( fn );
2694 * mw.hook( 'wikipage.content' ).fire( $content );
2696 * Handlers can be added and fired for arbitrary event names at any time. The same
2697 * event can be fired multiple times. The last run of an event is memorized
2698 * (similar to `$(document).ready` and `$.Deferred().done`).
2699 * This means if an event is fired, and a handler added afterwards, the added
2700 * function will be fired right away with the last given event data.
2702 * Like Deferreds and Promises, the mw.hook object is both detachable and chainable.
2703 * Thus allowing flexible use and optimal maintainability and authority control.
2704 * You can pass around the `add` and/or `fire` method to another piece of code
2705 * without it having to know the event name (or `mw.hook` for that matter).
2707 * var h = mw.hook( 'bar.ready' );
2708 * new mw.Foo( .. ).fetch( { callback: h.fire } );
2710 * Note: Events are documented with an underscore instead of a dot in the event
2711 * name due to jsduck not supporting dots in that position.
2715 hook
: ( function () {
2719 * Create an instance of mw.hook.
2723 * @param {string} name Name of hook.
2726 return function ( name
) {
2727 var list
= hasOwn
.call( lists
, name
) ?
2729 lists
[ name
] = $.Callbacks( 'memory' );
2733 * Register a hook handler
2735 * @param {...Function} handler Function to bind.
2741 * Unregister a hook handler
2743 * @param {...Function} handler Function to unbind.
2746 remove
: list
.remove
,
2748 // eslint-disable-next-line valid-jsdoc
2752 * @param {...Mixed} data
2756 return list
.fireWith
.call( this, null, slice
.call( arguments
) );
2763 // Alias $j to jQuery for backwards compatibility
2764 // @deprecated since 1.23 Use $ or jQuery instead
2765 mw
.log
.deprecate( window
, '$j', $, 'Use $ or jQuery instead.' );
2768 * Log a message to window.console, if possible.
2770 * Useful to force logging of some errors that are otherwise hard to detect (i.e., this logs
2771 * also in production mode). Gets console references in each invocation instead of caching the
2772 * reference, so that debugging tools loaded later are supported (e.g. Firebug Lite in IE).
2775 * @param {string} topic Stream name passed by mw.track
2776 * @param {Object} data Data passed by mw.track
2777 * @param {Error} [data.exception]
2778 * @param {string} data.source Error source
2779 * @param {string} [data.module] Name of module which caused the error
2781 function logError( topic
, data
) {
2782 /* eslint-disable no-console */
2785 source
= data
.source
,
2786 module
= data
.module
,
2787 console
= window
.console
;
2789 if ( console
&& console
.log
) {
2790 msg
= ( e
? 'Exception' : 'Error' ) + ' in ' + source
;
2792 msg
+= ' in module ' + module
;
2794 msg
+= ( e
? ':' : '.' );
2797 // If we have an exception object, log it to the warning channel to trigger
2798 // proper stacktraces in browsers that support it.
2799 if ( e
&& console
.warn
) {
2803 /* eslint-enable no-console */
2806 // Subscribe to error streams
2807 mw
.trackSubscribe( 'resourceloader.exception', logError
);
2808 mw
.trackSubscribe( 'resourceloader.assert', logError
);
2810 // Attach to window and globally alias
2811 window
.mw
= window
.mediaWiki
= mw
;