Merge "registration: Only allow one extension to set a specific config setting"
[lhc/web/wiklou.git] / resources / src / mediawiki / mediawiki.js
1 /**
2 * Base library for MediaWiki.
3 *
4 * Exposed globally as `mediaWiki` with `mw` as shortcut.
5 *
6 * @class mw
7 * @alternateClassName mediaWiki
8 * @singleton
9 */
10
11 /* global mwNow */
12 /* eslint-disable no-use-before-define */
13
14 ( function ( $ ) {
15 'use strict';
16
17 var mw, StringSet, log,
18 hasOwn = Object.prototype.hasOwnProperty,
19 slice = Array.prototype.slice,
20 trackCallbacks = $.Callbacks( 'memory' ),
21 trackHandlers = [],
22 trackQueue = [];
23
24 /**
25 * FNV132 hash function
26 *
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>
31 *
32 * @private
33 * @param {string} str String to hash
34 * @return {string} hash as an seven-character base 36 string
35 */
36 function fnv132( str ) {
37 /* eslint-disable no-bitwise */
38 var hash = 0x811C9DC5,
39 i;
40
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 );
44 }
45
46 hash = ( hash >>> 0 ).toString( 36 );
47 while ( hash.length < 7 ) {
48 hash = '0' + hash;
49 }
50
51 return hash;
52 /* eslint-enable no-bitwise */
53 }
54
55 function defineFallbacks() {
56 // <https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Set>
57 StringSet = window.Set || ( function () {
58 /**
59 * @private
60 * @class
61 */
62 function StringSet() {
63 this.set = {};
64 }
65 StringSet.prototype.add = function ( value ) {
66 this.set[ value ] = true;
67 };
68 StringSet.prototype.has = function ( value ) {
69 return hasOwn.call( this.set, value );
70 };
71 return StringSet;
72 }() );
73 }
74
75 /**
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.
78 *
79 * @private
80 * @class mw.Map
81 *
82 * @constructor
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.
86 */
87 function Map( global ) {
88 this.values = {};
89 if ( global === true ) {
90 // Override #set to also set the global variable
91 this.set = function ( selection, value ) {
92 var s;
93
94 if ( $.isPlainObject( selection ) ) {
95 for ( s in selection ) {
96 setGlobalMapValue( this, s, selection[ s ] );
97 }
98 return true;
99 }
100 if ( typeof selection === 'string' && arguments.length ) {
101 setGlobalMapValue( this, selection, value );
102 return true;
103 }
104 return false;
105 };
106 }
107 }
108
109 /**
110 * Alias property to the global object.
111 *
112 * @private
113 * @static
114 * @param {mw.Map} map
115 * @param {string} key
116 * @param {Mixed} value
117 */
118 function setGlobalMapValue( map, key, value ) {
119 map.values[ key ] = value;
120 log.deprecate(
121 window,
122 key,
123 value,
124 // Deprecation notice for mw.config globals (T58550, T72470)
125 map === mw.config && 'Use mw.config instead.'
126 );
127 }
128
129 Map.prototype = {
130 constructor: Map,
131
132 /**
133 * Get the value of one or more keys.
134 *
135 * If called with no arguments, all values are returned.
136 *
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.
142 */
143 get: function ( selection, fallback ) {
144 var results, i;
145 fallback = arguments.length > 1 ? fallback : null;
146
147 if ( Array.isArray( selection ) ) {
148 results = {};
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 ] ] :
153 fallback;
154 }
155 }
156 return results;
157 }
158
159 if ( typeof selection === 'string' ) {
160 return hasOwn.call( this.values, selection ) ?
161 this.values[ selection ] :
162 fallback;
163 }
164
165 if ( selection === undefined ) {
166 results = {};
167 for ( i in this.values ) {
168 results[ i ] = this.values[ i ];
169 }
170 return results;
171 }
172
173 // Invalid selection key
174 return fallback;
175 },
176
177 /**
178 * Set one or more key/value pairs.
179 *
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
183 */
184 set: function ( selection, value ) {
185 var s;
186
187 if ( $.isPlainObject( selection ) ) {
188 for ( s in selection ) {
189 this.values[ s ] = selection[ s ];
190 }
191 return true;
192 }
193 if ( typeof selection === 'string' && arguments.length > 1 ) {
194 this.values[ selection ] = value;
195 return true;
196 }
197 return false;
198 },
199
200 /**
201 * Check if one or more keys exist.
202 *
203 * @param {Mixed} selection Key or array of keys to check
204 * @return {boolean} True if the key(s) exist
205 */
206 exists: function ( selection ) {
207 var i;
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 ] ) ) {
211 return false;
212 }
213 }
214 return true;
215 }
216 return typeof selection === 'string' && hasOwn.call( this.values, selection );
217 }
218 };
219
220 /**
221 * Object constructor for messages.
222 *
223 * Similar to the Message class in MediaWiki PHP.
224 *
225 * Format defaults to 'text'.
226 *
227 * @example
228 *
229 * var obj, str;
230 * mw.messages.set( {
231 * 'hello': 'Hello world',
232 * 'hello-user': 'Hello, $1!',
233 * 'welcome-user': 'Welcome back to $2, $1! Last visit by $1: $3'
234 * } );
235 *
236 * obj = new mw.Message( mw.messages, 'hello' );
237 * mw.log( obj.text() );
238 * // Hello world
239 *
240 * obj = new mw.Message( mw.messages, 'hello-user', [ 'John Doe' ] );
241 * mw.log( obj.text() );
242 * // Hello, John Doe!
243 *
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
247 *
248 * // Using mw.message shortcut
249 * obj = mw.message( 'hello-user', 'John Doe' );
250 * mw.log( obj.text() );
251 * // Hello, John Doe!
252 *
253 * // Using mw.msg shortcut
254 * str = mw.msg( 'hello-user', 'John Doe' );
255 * mw.log( str );
256 * // Hello, John Doe!
257 *
258 * // Different formats
259 * obj = new mw.Message( mw.messages, 'hello-user', [ 'John "Wiki" <3 Doe' ] );
260 *
261 * obj.format = 'text';
262 * str = obj.toString();
263 * // Same as:
264 * str = obj.text();
265 *
266 * mw.log( str );
267 * // Hello, John "Wiki" <3 Doe!
268 *
269 * mw.log( obj.escaped() );
270 * // Hello, John &quot;Wiki&quot; &lt;3 Doe!
271 *
272 * @class mw.Message
273 *
274 * @constructor
275 * @param {mw.Map} map Message store
276 * @param {string} key
277 * @param {Array} [parameters]
278 */
279 function Message( map, key, parameters ) {
280 this.format = 'text';
281 this.map = map;
282 this.key = key;
283 this.parameters = parameters === undefined ? [] : slice.call( parameters );
284 return this;
285 }
286
287 Message.prototype = {
288 /**
289 * Get parsed contents of the message.
290 *
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.
294 *
295 * This function will not be called for nonexistent messages.
296 *
297 * @return {string} Parsed message
298 */
299 parser: function () {
300 return mw.format.apply( null, [ this.map.get( this.key ) ].concat( this.parameters ) );
301 },
302
303 // eslint-disable-next-line valid-jsdoc
304 /**
305 * Add (does not replace) parameters for `$N` placeholder values.
306 *
307 * @param {Array} parameters
308 * @chainable
309 */
310 params: function ( parameters ) {
311 var i;
312 for ( i = 0; i < parameters.length; i++ ) {
313 this.parameters.push( parameters[ i ] );
314 }
315 return this;
316 },
317
318 /**
319 * Convert message object to its string form based on current format.
320 *
321 * @return {string} Message as a string in the current form, or `<key>` if key
322 * does not exist.
323 */
324 toString: function () {
325 var text;
326
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 ) + '⧽';
337 }
338
339 if ( this.format === 'plain' || this.format === 'text' || this.format === 'parse' ) {
340 text = this.parser();
341 }
342
343 if ( this.format === 'escaped' ) {
344 text = this.parser();
345 text = mw.html.escape( text );
346 }
347
348 return text;
349 },
350
351 /**
352 * Change format to 'parse' and convert message to string
353 *
354 * If jqueryMsg is loaded, this parses the message text from wikitext
355 * (where supported) to HTML
356 *
357 * Otherwise, it is equivalent to plain.
358 *
359 * @return {string} String form of parsed message
360 */
361 parse: function () {
362 this.format = 'parse';
363 return this.toString();
364 },
365
366 /**
367 * Change format to 'plain' and convert message to string
368 *
369 * This substitutes parameters, but otherwise does not change the
370 * message text.
371 *
372 * @return {string} String form of plain message
373 */
374 plain: function () {
375 this.format = 'plain';
376 return this.toString();
377 },
378
379 /**
380 * Change format to 'text' and convert message to string
381 *
382 * If jqueryMsg is loaded, {{-transformation is done where supported
383 * (such as {{plural:}}, {{gender:}}, {{int:}}).
384 *
385 * Otherwise, it is equivalent to plain
386 *
387 * @return {string} String form of text message
388 */
389 text: function () {
390 this.format = 'text';
391 return this.toString();
392 },
393
394 /**
395 * Change the format to 'escaped' and convert message to string
396 *
397 * This is equivalent to using the 'text' format (see #text), then
398 * HTML-escaping the output.
399 *
400 * @return {string} String form of html escaped message
401 */
402 escaped: function () {
403 this.format = 'escaped';
404 return this.toString();
405 },
406
407 /**
408 * Check if a message exists
409 *
410 * @see mw.Map#exists
411 * @return {boolean}
412 */
413 exists: function () {
414 return this.map.exists( this.key );
415 }
416 };
417
418 defineFallbacks();
419
420 /* eslint-disable no-console */
421 log = ( function () {
422 /**
423 * Write a verbose message to the browser's console in debug mode.
424 *
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.
428 *
429 * See {@link mw.log} for other logging methods.
430 *
431 * @member mw
432 * @param {...string} msg Messages to output to console.
433 */
434 var log = function () {},
435 console = window.console;
436
437 // Note: Keep list of methods in sync with restoration in mediawiki.log.js
438 // when adding or removing mw.log methods below!
439
440 /**
441 * Collection of methods to help log messages to the console.
442 *
443 * @class mw.log
444 * @singleton
445 */
446
447 /**
448 * Write a message to the browser console's warning channel.
449 *
450 * This method is a no-op in browsers that don't implement the Console API.
451 *
452 * @param {...string} msg Messages to output to console
453 */
454 log.warn = console && console.warn && Function.prototype.bind ?
455 Function.prototype.bind.call( console.warn, console ) :
456 $.noop;
457
458 /**
459 * Write a message to the browser console's error channel.
460 *
461 * Most browsers also print a stacktrace when calling this method if the
462 * argument is an Error object.
463 *
464 * This method is a no-op in browsers that don't implement the Console API.
465 *
466 * @since 1.26
467 * @param {Error|...string} msg Messages to output to console
468 */
469 log.error = console && console.error && Function.prototype.bind ?
470 Function.prototype.bind.call( console.error, console ) :
471 $.noop;
472
473 /**
474 * Create a property on a host object that, when accessed, will produce
475 * a deprecation warning in the console.
476 *
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.
483 */
484 log.deprecate = !Object.defineProperty ? function ( obj, key, val ) {
485 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 ) ) {
493 return false;
494 }
495 logged.add( trace );
496 return true;
497 }
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.
501 try {
502 Object.defineProperty( obj, key, {
503 configurable: true,
504 enumerable: true,
505 get: function () {
506 if ( uniqueTrace() ) {
507 mw.track( 'mw.deprecate', logName );
508 mw.log.warn( msg );
509 }
510 return val;
511 },
512 set: function ( newVal ) {
513 if ( uniqueTrace() ) {
514 mw.track( 'mw.deprecate', logName );
515 mw.log.warn( msg );
516 }
517 val = newVal;
518 }
519 } );
520 } catch ( err ) {
521 obj[ key ] = val;
522 }
523 };
524
525 return log;
526 }() );
527 /* eslint-enable no-console */
528
529 /**
530 * @class mw
531 */
532 mw = {
533 redefineFallbacksForTest: function () {
534 if ( !window.QUnit ) {
535 throw new Error( 'Reset not allowed outside unit tests' );
536 }
537 defineFallbacks();
538 },
539
540 /**
541 * Get the current time, measured in milliseconds since January 1, 1970 (UTC).
542 *
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`.
546 *
547 * @return {number} Current time
548 */
549 now: mwNow,
550 // mwNow is defined in startup.js
551
552 /**
553 * Format a string. Replace $1, $2 ... $N with positional arguments.
554 *
555 * Used by Message#parser().
556 *
557 * @since 1.25
558 * @param {string} formatString Format string
559 * @param {...Mixed} parameters Values for $N replacements
560 * @return {string} Formatted string
561 */
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;
567 } );
568 },
569
570 /**
571 * Track an analytic event.
572 *
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.
578 *
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
581 * bound.
582 *
583 * @param {string} topic Topic name
584 * @param {Object} [data] Data describing the event, encoded as an object
585 */
586 track: function ( topic, data ) {
587 trackQueue.push( { topic: topic, timeStamp: mw.now(), data: data } );
588 trackCallbacks.fire( trackQueue );
589 },
590
591 /**
592 * Register a handler for subset of analytic events, specified by topic.
593 *
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.
599 *
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]
604 */
605 trackSubscribe: function ( topic, callback ) {
606 var seen = 0;
607 function handler( trackQueue ) {
608 var event;
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 );
613 }
614 }
615 }
616
617 trackHandlers.push( [ handler, callback ] );
618
619 trackCallbacks.add( handler );
620 },
621
622 /**
623 * Stop handling events for a particular handler
624 *
625 * @param {Function} callback
626 */
627 trackUnsubscribe: function ( callback ) {
628 trackHandlers = trackHandlers.filter( function ( fns ) {
629 if ( fns[ 1 ] === callback ) {
630 trackCallbacks.remove( fns[ 0 ] );
631 // Ensure the tuple is removed to avoid holding on to closures
632 return false;
633 }
634 return true;
635 } );
636 },
637
638 // Expose Map constructor
639 Map: Map,
640
641 // Expose Message constructor
642 Message: Message,
643
644 /**
645 * Map of configuration values.
646 *
647 * Check out [the complete list of configuration values](https://www.mediawiki.org/wiki/Manual:Interface/JavaScript#mw.config)
648 * on mediawiki.org.
649 *
650 * If `$wgLegacyJavaScriptGlobals` is true, this Map will add its values to the
651 * global `window` object.
652 *
653 * @property {mw.Map} config
654 */
655 // Dummy placeholder later assigned in ResourceLoaderStartUpModule
656 config: null,
657
658 /**
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
661 * or wrapping.
662 *
663 * @property
664 */
665 libs: {},
666
667 /**
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).
671 *
672 * This was reserved for future use but never ended up being used.
673 *
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.
676 * @property
677 */
678 legacy: {},
679
680 /**
681 * Store for messages.
682 *
683 * @property {mw.Map}
684 */
685 messages: new Map(),
686
687 /**
688 * Store for templates associated with a module.
689 *
690 * @property {mw.Map}
691 */
692 templates: new Map(),
693
694 /**
695 * Get a message object.
696 *
697 * Shortcut for `new mw.Message( mw.messages, key, parameters )`.
698 *
699 * @see mw.Message
700 * @param {string} key Key of message to get
701 * @param {...Mixed} parameters Values for $N replacements
702 * @return {mw.Message}
703 */
704 message: function ( key ) {
705 var parameters = slice.call( arguments, 1 );
706 return new Message( mw.messages, key, parameters );
707 },
708
709 /**
710 * Get a message string using the (default) 'text' format.
711 *
712 * Shortcut for `mw.message( key, parameters... ).text()`.
713 *
714 * @see mw.Message
715 * @param {string} key Key of message to get
716 * @param {...Mixed} parameters Values for $N replacements
717 * @return {string}
718 */
719 msg: function () {
720 return mw.message.apply( mw.message, arguments ).toString();
721 },
722
723 // Expose mw.log
724 log: log,
725
726 /**
727 * Client for ResourceLoader server end point.
728 *
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.
732 *
733 * For more information, refer to
734 * <https://www.mediawiki.org/wiki/ResourceLoader/Features>
735 *
736 * @class mw.loader
737 * @singleton
738 */
739 loader: ( function () {
740
741 /**
742 * Fired via mw.track on various resource loading errors.
743 *
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
750 * batched handling.
751 * @param {string} source Source of the error. Possible values:
752 *
753 * - style: stylesheet error (only affects old IE where a special style loading method
754 * is used)
755 * - load-callback: exception thrown by user callback
756 * - module-execute: exception thrown by module code
757 * - resolve: failed to sort dependencies for a module in mw.loader.load
758 * - store-eval: could not evaluate module code cached in localStorage
759 * - store-localstorage-init: localStorage or JSON parse error in mw.loader.store.init
760 * - store-localstorage-json: JSON conversion error in mw.loader.store.set
761 * - store-localstorage-update: localStorage or JSON conversion error in mw.loader.store.update
762 */
763
764 /**
765 * Fired via mw.track on resource loading error conditions.
766 *
767 * @event resourceloader_assert
768 * @param {string} source Source of the error. Possible values:
769 *
770 * - bug-T59567: failed to cache script due to an Opera function -> string conversion
771 * bug; see <https://phabricator.wikimedia.org/T59567> for details
772 */
773
774 /**
775 * Mapping of registered modules.
776 *
777 * See #implement and #execute for exact details on support for script, style and messages.
778 *
779 * Format:
780 *
781 * {
782 * 'moduleName': {
783 * // From mw.loader.register()
784 * 'version': '########' (hash)
785 * 'dependencies': ['required.foo', 'bar.also', ...], (or) function () {}
786 * 'group': 'somegroup', (or) null
787 * 'source': 'local', (or) 'anotherwiki'
788 * 'skip': 'return !!window.Example', (or) null
789 * 'module': export Object
790 *
791 * // Set from execute() or mw.loader.state()
792 * 'state': 'registered', 'loaded', 'loading', 'ready', 'error', or 'missing'
793 *
794 * // Optionally added at run-time by mw.loader.implement()
795 * 'skipped': true
796 * 'script': closure, array of urls, or string
797 * 'style': { ... } (see #execute)
798 * 'messages': { 'key': 'value', ... }
799 * }
800 * }
801 *
802 * State machine:
803 *
804 * - `registered`:
805 * The module is known to the system but not yet required.
806 * Meta data is registered via mw.loader#register. Calls to that method are
807 * generated server-side by the startup module.
808 * - `loading`:
809 * The module was required through mw.loader (either directly or as dependency of
810 * another module). The client will fetch module contents from the server.
811 * The contents are then stashed in the registry via mw.loader#implement.
812 * - `loaded`:
813 * The module has been loaded from the server and stashed via mw.loader#implement.
814 * If the module has no more dependencies in-flight, the module will be executed
815 * immediately. Otherwise execution is deferred, controlled via #handlePending.
816 * - `executing`:
817 * The module is being executed.
818 * - `ready`:
819 * The module has been successfully executed.
820 * - `error`:
821 * The module (or one of its dependencies) produced an error during execution.
822 * - `missing`:
823 * The module was registered client-side and requested, but the server denied knowledge
824 * of the module's existence.
825 *
826 * @property
827 * @private
828 */
829 var registry = {},
830 // Mapping of sources, keyed by source-id, values are strings.
831 //
832 // Format:
833 //
834 // {
835 // 'sourceId': 'http://example.org/w/load.php'
836 // }
837 //
838 sources = {},
839
840 // For queueModuleScript()
841 handlingPendingRequests = false,
842 pendingRequests = [],
843
844 // List of modules to be loaded
845 queue = [],
846
847 /**
848 * List of callback jobs waiting for modules to be ready.
849 *
850 * Jobs are created by #enqueue() and run by #handlePending().
851 *
852 * Typically when a job is created for a module, the job's dependencies contain
853 * both the required module and all its recursive dependencies.
854 *
855 * Format:
856 *
857 * {
858 * 'dependencies': [ module names ],
859 * 'ready': Function callback
860 * 'error': Function callback
861 * }
862 *
863 * @property {Object[]} jobs
864 * @private
865 */
866 jobs = [],
867
868 // For getMarker()
869 marker = null,
870
871 // For addEmbeddedCSS()
872 cssBuffer = '',
873 cssBufferTimer = null,
874 cssCallbacks = $.Callbacks(),
875 rAF = window.requestAnimationFrame || setTimeout;
876
877 function getMarker() {
878 if ( !marker ) {
879 // Cache
880 marker = document.querySelector( 'meta[name="ResourceLoaderDynamicStyles"]' );
881 if ( !marker ) {
882 mw.log( 'Create <meta name="ResourceLoaderDynamicStyles"> dynamically' );
883 marker = $( '<meta>' ).attr( 'name', 'ResourceLoaderDynamicStyles' ).appendTo( 'head' )[ 0 ];
884 }
885 }
886 return marker;
887 }
888
889 /**
890 * Create a new style element and add it to the DOM.
891 *
892 * @private
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
897 */
898 function newStyleTag( text, nextNode ) {
899 var s = document.createElement( 'style' );
900
901 s.appendChild( document.createTextNode( text ) );
902 if ( nextNode && nextNode.parentNode ) {
903 nextNode.parentNode.insertBefore( s, nextNode );
904 } else {
905 document.getElementsByTagName( 'head' )[ 0 ].appendChild( s );
906 }
907
908 return s;
909 }
910
911 /**
912 * Add a bit of CSS text to the current browser page.
913 *
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.
916 *
917 * @private
918 * @param {string} [cssText=cssBuffer] If called without cssText,
919 * the internal buffer will be inserted instead.
920 * @param {Function} [callback]
921 */
922 function addEmbeddedCSS( cssText, callback ) {
923 function fireCallbacks() {
924 var oldCallbacks = cssCallbacks;
925 // Reset cssCallbacks variable so it's not polluted by any calls to
926 // addEmbeddedCSS() from one of the callbacks (T105973)
927 cssCallbacks = $.Callbacks();
928 oldCallbacks.fire().empty();
929 }
930
931 if ( callback ) {
932 cssCallbacks.add( callback );
933 }
934
935 // Yield once before creating the <style> tag. This lets multiple stylesheets
936 // accumulate into one buffer, allowing us to reduce how often new stylesheets
937 // are inserted in the browser. Appending a stylesheet and waiting for the
938 // browser to repaint is fairly expensive. (T47810)
939 if ( cssText ) {
940 // Don't extend the buffer if the item needs its own stylesheet.
941 // Keywords like `@import` are only valid at the start of a stylesheet (T37562).
942 if ( !cssBuffer || cssText.slice( 0, '@import'.length ) !== '@import' ) {
943 // Linebreak for somewhat distinguishable sections
944 cssBuffer += '\n' + cssText;
945 if ( !cssBufferTimer ) {
946 cssBufferTimer = rAF( function () {
947 // Wrap in anonymous function that takes no arguments
948 // Support: Firefox < 13
949 // Firefox 12 has non-standard behaviour of passing a number
950 // as first argument to a setTimeout callback.
951 // http://benalman.com/news/2009/07/the-mysterious-firefox-settime/
952 addEmbeddedCSS();
953 } );
954 }
955 return;
956 }
957
958 // This is a scheduled flush for the buffer
959 } else {
960 cssBufferTimer = null;
961 cssText = cssBuffer;
962 cssBuffer = '';
963 }
964
965 $( newStyleTag( cssText, getMarker() ) );
966
967 fireCallbacks();
968 }
969
970 /**
971 * @private
972 * @param {Array} modules List of module names
973 * @return {string} Hash of concatenated version hashes.
974 */
975 function getCombinedVersion( modules ) {
976 var hashes = modules.map( function ( module ) {
977 return registry[ module ].version;
978 } );
979 return fnv132( hashes.join( '' ) );
980 }
981
982 /**
983 * Determine whether all dependencies are in state 'ready', which means we may
984 * execute the module or job now.
985 *
986 * @private
987 * @param {Array} modules Names of modules to be checked
988 * @return {boolean} True if all modules are in state 'ready', false otherwise
989 */
990 function allReady( modules ) {
991 var i;
992 for ( i = 0; i < modules.length; i++ ) {
993 if ( mw.loader.getState( modules[ i ] ) !== 'ready' ) {
994 return false;
995 }
996 }
997 return true;
998 }
999
1000 /**
1001 * Determine whether all dependencies are in state 'ready', which means we may
1002 * execute the module or job now.
1003 *
1004 * @private
1005 * @param {Array} modules Names of modules to be checked
1006 * @return {boolean} True if no modules are in state 'error' or 'missing', false otherwise
1007 */
1008 function anyFailed( modules ) {
1009 var i, state;
1010 for ( i = 0; i < modules.length; i++ ) {
1011 state = mw.loader.getState( modules[ i ] );
1012 if ( state === 'error' || state === 'missing' ) {
1013 return true;
1014 }
1015 }
1016 return false;
1017 }
1018
1019 /**
1020 * A module has entered state 'ready', 'error', or 'missing'. Automatically update
1021 * pending jobs and modules that depend upon this module. If the given module failed,
1022 * propagate the 'error' state up the dependency tree. Otherwise, go ahead and execute
1023 * all jobs/modules now having their dependencies satisfied.
1024 *
1025 * Jobs that depend on a failed module, will have their error callback ran (if any).
1026 *
1027 * @private
1028 * @param {string} module Name of module that entered one of the states 'ready', 'error', or 'missing'.
1029 */
1030 function handlePending( module ) {
1031 var j, job, hasErrors, m, stateChange;
1032
1033 if ( registry[ module ].state === 'error' || registry[ module ].state === 'missing' ) {
1034 // If the current module failed, mark all dependent modules also as failed.
1035 // Iterate until steady-state to propagate the error state upwards in the
1036 // dependency tree.
1037 do {
1038 stateChange = false;
1039 for ( m in registry ) {
1040 if ( registry[ m ].state !== 'error' && registry[ m ].state !== 'missing' ) {
1041 if ( anyFailed( registry[ m ].dependencies ) ) {
1042 registry[ m ].state = 'error';
1043 stateChange = true;
1044 }
1045 }
1046 }
1047 } while ( stateChange );
1048 }
1049
1050 // Execute all jobs whose dependencies are either all satisfied or contain at least one failed module.
1051 for ( j = 0; j < jobs.length; j++ ) {
1052 hasErrors = anyFailed( jobs[ j ].dependencies );
1053 if ( hasErrors || allReady( jobs[ j ].dependencies ) ) {
1054 // All dependencies satisfied, or some have errors
1055 job = jobs[ j ];
1056 jobs.splice( j, 1 );
1057 j -= 1;
1058 try {
1059 if ( hasErrors ) {
1060 if ( typeof job.error === 'function' ) {
1061 job.error( new Error( 'Module ' + module + ' has failed dependencies' ), [ module ] );
1062 }
1063 } else {
1064 if ( typeof job.ready === 'function' ) {
1065 job.ready();
1066 }
1067 }
1068 } catch ( e ) {
1069 // A user-defined callback raised an exception.
1070 // Swallow it to protect our state machine!
1071 mw.track( 'resourceloader.exception', { exception: e, module: module, source: 'load-callback' } );
1072 }
1073 }
1074 }
1075
1076 if ( registry[ module ].state === 'ready' ) {
1077 // The current module became 'ready'. Set it in the module store, and recursively execute all
1078 // dependent modules that are loaded and now have all dependencies satisfied.
1079 mw.loader.store.set( module, registry[ module ] );
1080 for ( m in registry ) {
1081 if ( registry[ m ].state === 'loaded' && allReady( registry[ m ].dependencies ) ) {
1082 execute( m );
1083 }
1084 }
1085 }
1086 }
1087
1088 /**
1089 * Resolve dependencies and detect circular references.
1090 *
1091 * @private
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
1101 */
1102 function sortDependencies( module, resolved, unresolved ) {
1103 var i, deps, skip;
1104
1105 if ( !hasOwn.call( registry, module ) ) {
1106 throw new Error( 'Unknown dependency: ' + module );
1107 }
1108
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;
1113 if ( skip() ) {
1114 registry[ module ].skipped = true;
1115 registry[ module ].dependencies = [];
1116 registry[ module ].state = 'ready';
1117 handlePending( module );
1118 return;
1119 }
1120 }
1121
1122 // Resolves dynamic loader function and replaces it with its own results
1123 if ( typeof registry[ module ].dependencies === 'function' ) {
1124 registry[ module ].dependencies = registry[ module ].dependencies();
1125 // Ensures the module's dependencies are always in an array
1126 if ( typeof registry[ module ].dependencies !== 'object' ) {
1127 registry[ module ].dependencies = [ registry[ module ].dependencies ];
1128 }
1129 }
1130 if ( resolved.indexOf( module ) !== -1 ) {
1131 // Module already resolved; nothing to do
1132 return;
1133 }
1134 // Create unresolved if not passed in
1135 if ( !unresolved ) {
1136 unresolved = new StringSet();
1137 }
1138 // Tracks down dependencies
1139 deps = registry[ module ].dependencies;
1140 for ( i = 0; i < deps.length; i++ ) {
1141 if ( resolved.indexOf( deps[ i ] ) === -1 ) {
1142 if ( unresolved.has( deps[ i ] ) ) {
1143 throw new Error( mw.format(
1144 'Circular reference detected: $1 -> $2',
1145 module,
1146 deps[ i ]
1147 ) );
1148 }
1149
1150 unresolved.add( module );
1151 sortDependencies( deps[ i ], resolved, unresolved );
1152 }
1153 }
1154 resolved.push( module );
1155 }
1156
1157 /**
1158 * Get names of module that a module depends on, in their proper dependency order.
1159 *
1160 * @private
1161 * @param {string[]} modules Array of string module names
1162 * @return {Array} List of dependencies, including 'module'.
1163 * @throws {Error} If an unregistered module or a dependency loop is encountered
1164 */
1165 function resolve( modules ) {
1166 var i, resolved = [];
1167 for ( i = 0; i < modules.length; i++ ) {
1168 sortDependencies( modules[ i ], resolved );
1169 }
1170 return resolved;
1171 }
1172
1173 /**
1174 * Like #resolve(), except it will silently ignore modules that
1175 * are missing or have missing dependencies.
1176 *
1177 * @private
1178 * @param {string[]} modules Array of string module names
1179 * @return {Array} List of dependencies.
1180 */
1181 function resolveStubbornly( modules ) {
1182 var i, saved, resolved = [];
1183 for ( i = 0; i < modules.length; i++ ) {
1184 saved = resolved.slice();
1185 try {
1186 sortDependencies( modules[ i ], resolved );
1187 } catch ( err ) {
1188 // This module is unknown or has unknown dependencies.
1189 // Undo any incomplete resolutions made and keep going.
1190 resolved = saved;
1191 mw.track( 'resourceloader.exception', {
1192 exception: err,
1193 source: 'resolve'
1194 } );
1195 }
1196 }
1197 return resolved;
1198 }
1199
1200 /**
1201 * Load and execute a script.
1202 *
1203 * @private
1204 * @param {string} src URL to script, will be used as the src attribute in the script tag
1205 * @return {jQuery.Promise}
1206 */
1207 function addScript( src ) {
1208 return $.ajax( {
1209 url: src,
1210 dataType: 'script',
1211 // Force jQuery behaviour to be for crossDomain. Otherwise jQuery would use
1212 // XHR for a same domain request instead of <script>, which changes the request
1213 // headers (potentially missing a cache hit), and reduces caching in general
1214 // since browsers cache XHR much less (if at all). And XHR means we retrieve
1215 // text, so we'd need to $.globalEval, which then messes up line numbers.
1216 crossDomain: true,
1217 cache: true
1218 } );
1219 }
1220
1221 /**
1222 * Queue the loading and execution of a script for a particular module.
1223 *
1224 * @private
1225 * @param {string} src URL of the script
1226 * @param {string} [moduleName] Name of currently executing module
1227 * @return {jQuery.Promise}
1228 */
1229 function queueModuleScript( src, moduleName ) {
1230 var r = $.Deferred();
1231
1232 pendingRequests.push( function () {
1233 if ( moduleName && hasOwn.call( registry, moduleName ) ) {
1234 // Emulate runScript() part of execute()
1235 window.require = mw.loader.require;
1236 window.module = registry[ moduleName ].module;
1237 }
1238 addScript( src ).always( function () {
1239 // 'module.exports' should not persist after the file is executed to
1240 // avoid leakage to unrelated code. 'require' should be kept, however,
1241 // as asynchronous access to 'require' is allowed and expected. (T144879)
1242 delete window.module;
1243 r.resolve();
1244
1245 // Start the next one (if any)
1246 if ( pendingRequests[ 0 ] ) {
1247 pendingRequests.shift()();
1248 } else {
1249 handlingPendingRequests = false;
1250 }
1251 } );
1252 } );
1253 if ( !handlingPendingRequests && pendingRequests[ 0 ] ) {
1254 handlingPendingRequests = true;
1255 pendingRequests.shift()();
1256 }
1257 return r.promise();
1258 }
1259
1260 /**
1261 * Utility function for execute()
1262 *
1263 * @ignore
1264 * @param {string} [media] Media attribute
1265 * @param {string} url URL
1266 */
1267 function addLink( media, url ) {
1268 var el = document.createElement( 'link' );
1269
1270 el.rel = 'stylesheet';
1271 if ( media && media !== 'all' ) {
1272 el.media = media;
1273 }
1274 // If you end up here from an IE exception "SCRIPT: Invalid property value.",
1275 // see #addEmbeddedCSS, T33676, T43331, and T49277 for details.
1276 el.href = url;
1277
1278 $( getMarker() ).before( el );
1279 }
1280
1281 /**
1282 * Executes a loaded module, making it ready to use
1283 *
1284 * @private
1285 * @param {string} module Module name to execute
1286 */
1287 function execute( module ) {
1288 var key, value, media, i, urls, cssHandle, checkCssHandles, runScript,
1289 cssHandlesRegistered = false;
1290
1291 if ( !hasOwn.call( registry, module ) ) {
1292 throw new Error( 'Module has not been registered yet: ' + module );
1293 }
1294 if ( registry[ module ].state !== 'loaded' ) {
1295 throw new Error( 'Module in state "' + registry[ module ].state + '" may not be executed: ' + module );
1296 }
1297
1298 registry[ module ].state = 'executing';
1299
1300 runScript = function () {
1301 var script, markModuleReady, nestedAddScript;
1302
1303 script = registry[ module ].script;
1304 markModuleReady = function () {
1305 registry[ module ].state = 'ready';
1306 handlePending( module );
1307 };
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
1313 callback();
1314 return;
1315 }
1316
1317 queueModuleScript( arr[ i ], module ).always( function () {
1318 nestedAddScript( arr, callback, i + 1 );
1319 } );
1320 };
1321
1322 try {
1323 if ( Array.isArray( script ) ) {
1324 nestedAddScript( script, markModuleReady, 0 );
1325 } else if ( typeof script === 'function' ) {
1326 // Pass jQuery twice so that the signature of the closure which wraps
1327 // the script can bind both '$' and 'jQuery'.
1328 script( $, $, mw.loader.require, registry[ module ].module );
1329 markModuleReady();
1330
1331 } else if ( typeof script === 'string' ) {
1332 // Site and user modules are legacy scripts that run in the global scope.
1333 // This is transported as a string instead of a function to avoid needing
1334 // to use string manipulation to undo the function wrapper.
1335 $.globalEval( script );
1336 markModuleReady();
1337
1338 } else {
1339 // Module without script
1340 markModuleReady();
1341 }
1342 } catch ( e ) {
1343 // Use mw.track instead of mw.log because these errors are common in production mode
1344 // (e.g. undefined variable), and mw.log is only enabled in debug mode.
1345 registry[ module ].state = 'error';
1346 mw.track( 'resourceloader.exception', { exception: e, module: module, source: 'module-execute' } );
1347 handlePending( module );
1348 }
1349 };
1350
1351 // Add localizations to message system
1352 if ( registry[ module ].messages ) {
1353 mw.messages.set( registry[ module ].messages );
1354 }
1355
1356 // Initialise templates
1357 if ( registry[ module ].templates ) {
1358 mw.templates.set( module, registry[ module ].templates );
1359 }
1360
1361 // Make sure we don't run the scripts until all stylesheet insertions have completed.
1362 ( function () {
1363 var pending = 0;
1364 checkCssHandles = function () {
1365 // cssHandlesRegistered ensures we don't take off too soon, e.g. when
1366 // one of the cssHandles is fired while we're still creating more handles.
1367 if ( cssHandlesRegistered && pending === 0 && runScript ) {
1368 if ( module === 'user' ) {
1369 // Implicit dependency on the site module. Not real dependency because
1370 // it should run after 'site' regardless of whether it succeeds or fails.
1371 mw.loader.using( [ 'site' ] ).always( runScript );
1372 } else {
1373 runScript();
1374 }
1375 runScript = undefined; // Revoke
1376 }
1377 };
1378 cssHandle = function () {
1379 var check = checkCssHandles;
1380 pending++;
1381 return function () {
1382 if ( check ) {
1383 pending--;
1384 check();
1385 check = undefined; // Revoke
1386 }
1387 };
1388 };
1389 }() );
1390
1391 // Process styles (see also mw.loader.implement)
1392 // * back-compat: { <media>: css }
1393 // * back-compat: { <media>: [url, ..] }
1394 // * { "css": [css, ..] }
1395 // * { "url": { <media>: [url, ..] } }
1396 if ( registry[ module ].style ) {
1397 for ( key in registry[ module ].style ) {
1398 value = registry[ module ].style[ key ];
1399 media = undefined;
1400
1401 if ( key !== 'url' && key !== 'css' ) {
1402 // Backwards compatibility, key is a media-type
1403 if ( typeof value === 'string' ) {
1404 // back-compat: { <media>: css }
1405 // Ignore 'media' because it isn't supported (nor was it used).
1406 // Strings are pre-wrapped in "@media". The media-type was just ""
1407 // (because it had to be set to something).
1408 // This is one of the reasons why this format is no longer used.
1409 addEmbeddedCSS( value, cssHandle() );
1410 } else {
1411 // back-compat: { <media>: [url, ..] }
1412 media = key;
1413 key = 'bc-url';
1414 }
1415 }
1416
1417 // Array of css strings in key 'css',
1418 // or back-compat array of urls from media-type
1419 if ( Array.isArray( value ) ) {
1420 for ( i = 0; i < value.length; i++ ) {
1421 if ( key === 'bc-url' ) {
1422 // back-compat: { <media>: [url, ..] }
1423 addLink( media, value[ i ] );
1424 } else if ( key === 'css' ) {
1425 // { "css": [css, ..] }
1426 addEmbeddedCSS( value[ i ], cssHandle() );
1427 }
1428 }
1429 // Not an array, but a regular object
1430 // Array of urls inside media-type key
1431 } else if ( typeof value === 'object' ) {
1432 // { "url": { <media>: [url, ..] } }
1433 for ( media in value ) {
1434 urls = value[ media ];
1435 for ( i = 0; i < urls.length; i++ ) {
1436 addLink( media, urls[ i ] );
1437 }
1438 }
1439 }
1440 }
1441 }
1442
1443 // Kick off.
1444 cssHandlesRegistered = true;
1445 checkCssHandles();
1446 }
1447
1448 /**
1449 * Add one or more modules to the module load queue.
1450 *
1451 * See also #work().
1452 *
1453 * @private
1454 * @param {string|string[]} dependencies Module name or array of string module names
1455 * @param {Function} [ready] Callback to execute when all dependencies are ready
1456 * @param {Function} [error] Callback to execute when any dependency fails
1457 */
1458 function enqueue( dependencies, ready, error ) {
1459 // Allow calling by single module name
1460 if ( typeof dependencies === 'string' ) {
1461 dependencies = [ dependencies ];
1462 }
1463
1464 // Add ready and error callbacks if they were given
1465 if ( ready !== undefined || error !== undefined ) {
1466 jobs.push( {
1467 // Narrow down the list to modules that are worth waiting for
1468 dependencies: dependencies.filter( function ( module ) {
1469 var state = mw.loader.getState( module );
1470 return state === 'registered' || state === 'loaded' || state === 'loading' || state === 'executing';
1471 } ),
1472 ready: ready,
1473 error: error
1474 } );
1475 }
1476
1477 dependencies.forEach( function ( module ) {
1478 var state = mw.loader.getState( module );
1479 // Only queue modules that are still in the initial 'registered' state
1480 // (not ones already loading, ready or error).
1481 if ( state === 'registered' && queue.indexOf( module ) === -1 ) {
1482 // Private modules must be embedded in the page. Don't bother queuing
1483 // these as the server will deny them anyway (T101806).
1484 if ( registry[ module ].group === 'private' ) {
1485 registry[ module ].state = 'error';
1486 handlePending( module );
1487 return;
1488 }
1489 queue.push( module );
1490 }
1491 } );
1492
1493 mw.loader.work();
1494 }
1495
1496 function sortQuery( o ) {
1497 var key,
1498 sorted = {},
1499 a = [];
1500
1501 for ( key in o ) {
1502 a.push( key );
1503 }
1504 a.sort();
1505 for ( key = 0; key < a.length; key++ ) {
1506 sorted[ a[ key ] ] = o[ a[ key ] ];
1507 }
1508 return sorted;
1509 }
1510
1511 /**
1512 * Converts a module map of the form { foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }
1513 * to a query string of the form foo.bar,baz|bar.baz,quux
1514 *
1515 * @private
1516 * @param {Object} moduleMap Module map
1517 * @return {string} Module query string
1518 */
1519 function buildModulesString( moduleMap ) {
1520 var p, prefix,
1521 arr = [];
1522
1523 for ( prefix in moduleMap ) {
1524 p = prefix === '' ? '' : prefix + '.';
1525 arr.push( p + moduleMap[ prefix ].join( ',' ) );
1526 }
1527 return arr.join( '|' );
1528 }
1529
1530 /**
1531 * Make a network request to load modules from the server.
1532 *
1533 * @private
1534 * @param {Object} moduleMap Module map, see #buildModulesString
1535 * @param {Object} currReqBase Object with other parameters (other than 'modules') to use in the request
1536 * @param {string} sourceLoadScript URL of load.php
1537 */
1538 function doRequest( moduleMap, currReqBase, sourceLoadScript ) {
1539 // Optimisation: Inherit (Object.create), not copy ($.extend)
1540 var query = Object.create( currReqBase );
1541 query.modules = buildModulesString( moduleMap );
1542 query = sortQuery( query );
1543 addScript( sourceLoadScript + '?' + $.param( query ) );
1544 }
1545
1546 /**
1547 * Resolve indexed dependencies.
1548 *
1549 * ResourceLoader uses an optimization to save space which replaces module names in
1550 * dependency lists with the index of that module within the array of module
1551 * registration data if it exists. The benefit is a significant reduction in the data
1552 * size of the startup module. This function changes those dependency lists back to
1553 * arrays of strings.
1554 *
1555 * @private
1556 * @param {Array} modules Modules array
1557 */
1558 function resolveIndexedDependencies( modules ) {
1559 var i, j, deps;
1560 function resolveIndex( dep ) {
1561 return typeof dep === 'number' ? modules[ dep ][ 0 ] : dep;
1562 }
1563 for ( i = 0; i < modules.length; i++ ) {
1564 deps = modules[ i ][ 2 ];
1565 if ( deps ) {
1566 for ( j = 0; j < deps.length; j++ ) {
1567 deps[ j ] = resolveIndex( deps[ j ] );
1568 }
1569 }
1570 }
1571 }
1572
1573 /**
1574 * Create network requests for a batch of modules.
1575 *
1576 * This is an internal method for #work(). This must not be called directly
1577 * unless the modules are already registered, and no request is in progress,
1578 * and the module state has already been set to `loading`.
1579 *
1580 * @private
1581 * @param {string[]} batch
1582 */
1583 function batchRequest( batch ) {
1584 var reqBase, splits, maxQueryLength, b, bSource, bGroup, bSourceGroup,
1585 source, group, i, modules, sourceLoadScript,
1586 currReqBase, currReqBaseLength, moduleMap, l,
1587 lastDotIndex, prefix, suffix, bytesAdded;
1588
1589 if ( !batch.length ) {
1590 return;
1591 }
1592
1593 // Always order modules alphabetically to help reduce cache
1594 // misses for otherwise identical content.
1595 batch.sort();
1596
1597 // Build a list of query parameters common to all requests
1598 reqBase = {
1599 skin: mw.config.get( 'skin' ),
1600 lang: mw.config.get( 'wgUserLanguage' ),
1601 debug: mw.config.get( 'debug' )
1602 };
1603 maxQueryLength = mw.config.get( 'wgResourceLoaderMaxQueryLength', 2000 );
1604
1605 // Split module list by source and by group.
1606 splits = {};
1607 for ( b = 0; b < batch.length; b++ ) {
1608 bSource = registry[ batch[ b ] ].source;
1609 bGroup = registry[ batch[ b ] ].group;
1610 if ( !hasOwn.call( splits, bSource ) ) {
1611 splits[ bSource ] = {};
1612 }
1613 if ( !hasOwn.call( splits[ bSource ], bGroup ) ) {
1614 splits[ bSource ][ bGroup ] = [];
1615 }
1616 bSourceGroup = splits[ bSource ][ bGroup ];
1617 bSourceGroup.push( batch[ b ] );
1618 }
1619
1620 for ( source in splits ) {
1621
1622 sourceLoadScript = sources[ source ];
1623
1624 for ( group in splits[ source ] ) {
1625
1626 // Cache access to currently selected list of
1627 // modules for this group from this source.
1628 modules = splits[ source ][ group ];
1629
1630 // Optimisation: Inherit (Object.create), not copy ($.extend)
1631 currReqBase = Object.create( reqBase );
1632 currReqBase.version = getCombinedVersion( modules );
1633
1634 // For user modules append a user name to the query string.
1635 if ( group === 'user' && mw.config.get( 'wgUserName' ) !== null ) {
1636 currReqBase.user = mw.config.get( 'wgUserName' );
1637 }
1638 currReqBaseLength = $.param( currReqBase ).length;
1639 // We may need to split up the request to honor the query string length limit,
1640 // so build it piece by piece.
1641 l = currReqBaseLength + 9; // '&modules='.length == 9
1642
1643 moduleMap = {}; // { prefix: [ suffixes ] }
1644
1645 for ( i = 0; i < modules.length; i++ ) {
1646 // Determine how many bytes this module would add to the query string
1647 lastDotIndex = modules[ i ].lastIndexOf( '.' );
1648
1649 // If lastDotIndex is -1, substr() returns an empty string
1650 prefix = modules[ i ].substr( 0, lastDotIndex );
1651 suffix = modules[ i ].slice( lastDotIndex + 1 );
1652
1653 bytesAdded = hasOwn.call( moduleMap, prefix ) ?
1654 suffix.length + 3 : // '%2C'.length == 3
1655 modules[ i ].length + 3; // '%7C'.length == 3
1656
1657 // If the url would become too long, create a new one,
1658 // but don't create empty requests
1659 if ( maxQueryLength > 0 && !$.isEmptyObject( moduleMap ) && l + bytesAdded > maxQueryLength ) {
1660 // This url would become too long, create a new one, and start the old one
1661 doRequest( moduleMap, currReqBase, sourceLoadScript );
1662 moduleMap = {};
1663 l = currReqBaseLength + 9;
1664 mw.track( 'resourceloader.splitRequest', { maxQueryLength: maxQueryLength } );
1665 }
1666 if ( !hasOwn.call( moduleMap, prefix ) ) {
1667 moduleMap[ prefix ] = [];
1668 }
1669 moduleMap[ prefix ].push( suffix );
1670 l += bytesAdded;
1671 }
1672 // If there's anything left in moduleMap, request that too
1673 if ( !$.isEmptyObject( moduleMap ) ) {
1674 doRequest( moduleMap, currReqBase, sourceLoadScript );
1675 }
1676 }
1677 }
1678 }
1679
1680 /**
1681 * @private
1682 * @param {string[]} implementations Array containing pieces of JavaScript code in the
1683 * form of calls to mw.loader#implement().
1684 * @param {Function} cb Callback in case of failure
1685 * @param {Error} cb.err
1686 */
1687 function asyncEval( implementations, cb ) {
1688 if ( !implementations.length ) {
1689 return;
1690 }
1691 mw.requestIdleCallback( function () {
1692 try {
1693 $.globalEval( implementations.join( ';' ) );
1694 } catch ( err ) {
1695 cb( err );
1696 }
1697 } );
1698 }
1699
1700 /**
1701 * Make a versioned key for a specific module.
1702 *
1703 * @private
1704 * @param {string} module Module name
1705 * @return {string|null} Module key in format '`[name]@[version]`',
1706 * or null if the module does not exist
1707 */
1708 function getModuleKey( module ) {
1709 return hasOwn.call( registry, module ) ?
1710 ( module + '@' + registry[ module ].version ) : null;
1711 }
1712
1713 /**
1714 * @private
1715 * @param {string} key Module name or '`[name]@[version]`'
1716 * @return {Object}
1717 */
1718 function splitModuleKey( key ) {
1719 var index = key.indexOf( '@' );
1720 if ( index === -1 ) {
1721 return {
1722 name: key,
1723 version: ''
1724 };
1725 }
1726 return {
1727 name: key.slice( 0, index ),
1728 version: key.slice( index + 1 )
1729 };
1730 }
1731
1732 /* Public Members */
1733 return {
1734 /**
1735 * The module registry is exposed as an aid for debugging and inspecting page
1736 * state; it is not a public interface for modifying the registry.
1737 *
1738 * @see #registry
1739 * @property
1740 * @private
1741 */
1742 moduleRegistry: registry,
1743
1744 /**
1745 * @inheritdoc #newStyleTag
1746 * @method
1747 */
1748 addStyleTag: newStyleTag,
1749
1750 /**
1751 * Start loading of all queued module dependencies.
1752 *
1753 * @protected
1754 */
1755 work: function () {
1756 var q, batch, implementations, sourceModules;
1757
1758 batch = [];
1759
1760 // Appends a list of modules from the queue to the batch
1761 for ( q = 0; q < queue.length; q++ ) {
1762 // Only load modules which are registered
1763 if ( hasOwn.call( registry, queue[ q ] ) && registry[ queue[ q ] ].state === 'registered' ) {
1764 // Prevent duplicate entries
1765 if ( batch.indexOf( queue[ q ] ) === -1 ) {
1766 batch.push( queue[ q ] );
1767 // Mark registered modules as loading
1768 registry[ queue[ q ] ].state = 'loading';
1769 }
1770 }
1771 }
1772
1773 // Now that the queue has been processed into a batch, clear the queue.
1774 // This MUST happen before we initiate any eval or network request. Otherwise,
1775 // it is possible for a cached script to instantly trigger the same work queue
1776 // again; all before we've cleared it causing each request to include modules
1777 // which are already loaded.
1778 queue = [];
1779
1780 if ( !batch.length ) {
1781 return;
1782 }
1783
1784 mw.loader.store.init();
1785 if ( mw.loader.store.enabled ) {
1786 implementations = [];
1787 sourceModules = [];
1788 batch = batch.filter( function ( module ) {
1789 var implementation = mw.loader.store.get( module );
1790 if ( implementation ) {
1791 implementations.push( implementation );
1792 sourceModules.push( module );
1793 return false;
1794 }
1795 return true;
1796 } );
1797 asyncEval( implementations, function ( err ) {
1798 var failed;
1799 // Not good, the cached mw.loader.implement calls failed! This should
1800 // never happen, barring ResourceLoader bugs, browser bugs and PEBKACs.
1801 // Depending on how corrupt the string is, it is likely that some
1802 // modules' implement() succeeded while the ones after the error will
1803 // never run and leave their modules in the 'loading' state forever.
1804 mw.loader.store.stats.failed++;
1805
1806 // Since this is an error not caused by an individual module but by
1807 // something that infected the implement call itself, don't take any
1808 // risks and clear everything in this cache.
1809 mw.loader.store.clear();
1810
1811 mw.track( 'resourceloader.exception', { exception: err, source: 'store-eval' } );
1812 // Re-add the failed ones that are still pending back to the batch
1813 failed = sourceModules.filter( function ( module ) {
1814 return registry[ module ].state === 'loading';
1815 } );
1816 batchRequest( failed );
1817 } );
1818 }
1819
1820 batchRequest( batch );
1821 },
1822
1823 /**
1824 * Register a source.
1825 *
1826 * The #work() method will use this information to split up requests by source.
1827 *
1828 * mw.loader.addSource( 'mediawikiwiki', '//www.mediawiki.org/w/load.php' );
1829 *
1830 * @param {string|Object} id Source ID, or object mapping ids to load urls
1831 * @param {string} loadUrl Url to a load.php end point
1832 * @throws {Error} If source id is already registered
1833 */
1834 addSource: function ( id, loadUrl ) {
1835 var source;
1836 // Allow multiple additions
1837 if ( typeof id === 'object' ) {
1838 for ( source in id ) {
1839 mw.loader.addSource( source, id[ source ] );
1840 }
1841 return;
1842 }
1843
1844 if ( hasOwn.call( sources, id ) ) {
1845 throw new Error( 'source already registered: ' + id );
1846 }
1847
1848 sources[ id ] = loadUrl;
1849 },
1850
1851 /**
1852 * Register a module, letting the system know about it and its properties.
1853 *
1854 * The startup modules contain calls to this method.
1855 *
1856 * When using multiple module registration by passing an array, dependencies that
1857 * are specified as references to modules within the array will be resolved before
1858 * the modules are registered.
1859 *
1860 * @param {string|Array} module Module name or array of arrays, each containing
1861 * a list of arguments compatible with this method
1862 * @param {string|number} version Module version hash (falls backs to empty string)
1863 * Can also be a number (timestamp) for compatibility with MediaWiki 1.25 and earlier.
1864 * @param {string|Array|Function} dependencies One string or array of strings of module
1865 * names on which this module depends, or a function that returns that array.
1866 * @param {string} [group=null] Group which the module is in
1867 * @param {string} [source='local'] Name of the source
1868 * @param {string} [skip=null] Script body of the skip function
1869 */
1870 register: function ( module, version, dependencies, group, source, skip ) {
1871 var i, deps;
1872 // Allow multiple registration
1873 if ( typeof module === 'object' ) {
1874 resolveIndexedDependencies( module );
1875 for ( i = 0; i < module.length; i++ ) {
1876 // module is an array of module names
1877 if ( typeof module[ i ] === 'string' ) {
1878 mw.loader.register( module[ i ] );
1879 // module is an array of arrays
1880 } else if ( typeof module[ i ] === 'object' ) {
1881 mw.loader.register.apply( mw.loader, module[ i ] );
1882 }
1883 }
1884 return;
1885 }
1886 if ( hasOwn.call( registry, module ) ) {
1887 throw new Error( 'module already registered: ' + module );
1888 }
1889 if ( typeof dependencies === 'string' ) {
1890 // A single module name
1891 deps = [ dependencies ];
1892 } else if ( typeof dependencies === 'object' || typeof dependencies === 'function' ) {
1893 // Array of module names or a function that returns an array
1894 deps = dependencies;
1895 }
1896 // List the module as registered
1897 registry[ module ] = {
1898 // Exposed to execute() for mw.loader.implement() closures.
1899 // Import happens via require().
1900 module: {
1901 exports: {}
1902 },
1903 version: version !== undefined ? String( version ) : '',
1904 dependencies: deps || [],
1905 group: typeof group === 'string' ? group : null,
1906 source: typeof source === 'string' ? source : 'local',
1907 state: 'registered',
1908 skip: typeof skip === 'string' ? skip : null
1909 };
1910 },
1911
1912 /**
1913 * Implement a module given the components that make up the module.
1914 *
1915 * When #load() or #using() requests one or more modules, the server
1916 * response contain calls to this function.
1917 *
1918 * @param {string} module Name of module and current module version. Formatted
1919 * as '`[name]@[version]`". This version should match the requested version
1920 * (from #batchRequest and #registry). This avoids race conditions (T117587).
1921 * For back-compat with MediaWiki 1.27 and earlier, the version may be omitted.
1922 * @param {Function|Array|string} [script] Function with module code, list of URLs
1923 * to load via `<script src>`, or string of module code for `$.globalEval()`.
1924 * @param {Object} [style] Should follow one of the following patterns:
1925 *
1926 * { "css": [css, ..] }
1927 * { "url": { <media>: [url, ..] } }
1928 *
1929 * And for backwards compatibility (needs to be supported forever due to caching):
1930 *
1931 * { <media>: css }
1932 * { <media>: [url, ..] }
1933 *
1934 * The reason css strings are not concatenated anymore is T33676. We now check
1935 * whether it's safe to extend the stylesheet.
1936 *
1937 * @protected
1938 * @param {Object} [messages] List of key/value pairs to be added to mw#messages.
1939 * @param {Object} [templates] List of key/value pairs to be added to mw#templates.
1940 */
1941 implement: function ( module, script, style, messages, templates ) {
1942 var split = splitModuleKey( module ),
1943 name = split.name,
1944 version = split.version;
1945 // Automatically register module
1946 if ( !hasOwn.call( registry, name ) ) {
1947 mw.loader.register( name );
1948 }
1949 // Check for duplicate implementation
1950 if ( hasOwn.call( registry, name ) && registry[ name ].script !== undefined ) {
1951 throw new Error( 'module already implemented: ' + name );
1952 }
1953 if ( version ) {
1954 // Without this reset, if there is a version mismatch between the
1955 // requested and received module version, then mw.loader.store would
1956 // cache the response under the requested key. Thus poisoning the cache
1957 // indefinitely with a stale value. (T117587)
1958 registry[ name ].version = version;
1959 }
1960 // Attach components
1961 registry[ name ].script = script || null;
1962 registry[ name ].style = style || null;
1963 registry[ name ].messages = messages || null;
1964 registry[ name ].templates = templates || null;
1965 // The module may already have been marked as erroneous
1966 if ( registry[ name ].state !== 'error' && registry[ name ].state !== 'missing' ) {
1967 registry[ name ].state = 'loaded';
1968 if ( allReady( registry[ name ].dependencies ) ) {
1969 execute( name );
1970 }
1971 }
1972 },
1973
1974 /**
1975 * Execute a function as soon as one or more required modules are ready.
1976 *
1977 * Example of inline dependency on OOjs:
1978 *
1979 * mw.loader.using( 'oojs', function () {
1980 * OO.compare( [ 1 ], [ 1 ] );
1981 * } );
1982 *
1983 * Since MediaWiki 1.23 this also returns a promise.
1984 *
1985 * Since MediaWiki 1.28 the promise is resolved with a `require` function.
1986 *
1987 * @param {string|Array} dependencies Module name or array of modules names the
1988 * callback depends on to be ready before executing
1989 * @param {Function} [ready] Callback to execute when all dependencies are ready
1990 * @param {Function} [error] Callback to execute if one or more dependencies failed
1991 * @return {jQuery.Promise} With a `require` function
1992 */
1993 using: function ( dependencies, ready, error ) {
1994 var deferred = $.Deferred();
1995
1996 // Allow calling with a single dependency as a string
1997 if ( typeof dependencies === 'string' ) {
1998 dependencies = [ dependencies ];
1999 }
2000
2001 if ( ready ) {
2002 deferred.done( ready );
2003 }
2004 if ( error ) {
2005 deferred.fail( error );
2006 }
2007
2008 try {
2009 // Resolve entire dependency map
2010 dependencies = resolve( dependencies );
2011 } catch ( e ) {
2012 return deferred.reject( e ).promise();
2013 }
2014 if ( allReady( dependencies ) ) {
2015 // Run ready immediately
2016 deferred.resolve( mw.loader.require );
2017 } else if ( anyFailed( dependencies ) ) {
2018 // Execute error immediately if any dependencies have errors
2019 deferred.reject(
2020 new Error( 'One or more dependencies failed to load' ),
2021 dependencies
2022 );
2023 } else {
2024 // Not all dependencies are ready, add to the load queue
2025 enqueue( dependencies, function () {
2026 deferred.resolve( mw.loader.require );
2027 }, deferred.reject );
2028 }
2029
2030 return deferred.promise();
2031 },
2032
2033 /**
2034 * Load an external script or one or more modules.
2035 *
2036 * This method takes a list of unrelated modules. Use cases:
2037 *
2038 * - A web page will be composed of many different widgets. These widgets independently
2039 * queue their ResourceLoader modules (`OutputPage::addModules()`). If any of them
2040 * have problems, or are no longer known (e.g. cached HTML), the other modules
2041 * should still be loaded.
2042 * - This method is used for preloading, which must not throw. Later code that
2043 * calls #using() will handle the error.
2044 *
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.
2050 */
2051 load: function ( modules, type ) {
2052 var filtered, l;
2053
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' ) {
2059 l = document.createElement( 'link' );
2060 l.rel = 'stylesheet';
2061 l.href = modules;
2062 $( 'head' ).append( l );
2063 return;
2064 }
2065 if ( type === 'text/javascript' || type === undefined ) {
2066 addScript( modules );
2067 return;
2068 }
2069 // Unknown type
2070 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type );
2071 }
2072 // Called with single module
2073 modules = [ modules ];
2074 }
2075
2076 // Filter out top-level modules that are unknown or failed to load before.
2077 filtered = modules.filter( function ( module ) {
2078 var state = mw.loader.getState( module );
2079 return state !== 'error' && state !== 'missing';
2080 } );
2081 // Resolve remaining list using the known dependency tree.
2082 // This also filters out modules with unknown dependencies. (T36853)
2083 filtered = resolveStubbornly( filtered );
2084 // If all modules are ready, or if any modules have errors, nothing to be done.
2085 if ( allReady( filtered ) || anyFailed( filtered ) ) {
2086 return;
2087 }
2088 if ( filtered.length === 0 ) {
2089 return;
2090 }
2091 // Some modules are not yet ready, add to module load queue.
2092 enqueue( filtered, undefined, undefined );
2093 },
2094
2095 /**
2096 * Change the state of one or more modules.
2097 *
2098 * @param {string|Object} module Module name or object of module name/state pairs
2099 * @param {string} state State name
2100 */
2101 state: function ( module, state ) {
2102 var m;
2103
2104 if ( typeof module === 'object' ) {
2105 for ( m in module ) {
2106 mw.loader.state( m, module[ m ] );
2107 }
2108 return;
2109 }
2110 if ( !hasOwn.call( registry, module ) ) {
2111 mw.loader.register( module );
2112 }
2113 registry[ module ].state = state;
2114 if ( state === 'ready' || state === 'error' || state === 'missing' ) {
2115 // Make sure pending modules depending on this one get executed if their
2116 // dependencies are now fulfilled!
2117 handlePending( module );
2118 }
2119 },
2120
2121 /**
2122 * Get the version of a module.
2123 *
2124 * @param {string} module Name of module
2125 * @return {string|null} The version, or null if the module (or its version) is not
2126 * in the registry.
2127 */
2128 getVersion: function ( module ) {
2129 return hasOwn.call( registry, module ) ? registry[ module ].version : null;
2130 },
2131
2132 /**
2133 * Get the state of a module.
2134 *
2135 * @param {string} module Name of module
2136 * @return {string|null} The state, or null if the module (or its state) is not
2137 * in the registry.
2138 */
2139 getState: function ( module ) {
2140 return hasOwn.call( registry, module ) ? registry[ module ].state : null;
2141 },
2142
2143 /**
2144 * Get the names of all registered modules.
2145 *
2146 * @return {Array}
2147 */
2148 getModuleNames: function () {
2149 return Object.keys( registry );
2150 },
2151
2152 /**
2153 * Get the exported value of a module.
2154 *
2155 * Modules may provide this via their local `module.exports`.
2156 *
2157 * @protected
2158 * @since 1.27
2159 * @param {string} moduleName Module name
2160 * @return {Mixed} Exported value
2161 */
2162 require: function ( moduleName ) {
2163 var state = mw.loader.getState( moduleName );
2164
2165 // Only ready modules can be required
2166 if ( state !== 'ready' ) {
2167 // Module may've forgotten to declare a dependency
2168 throw new Error( 'Module "' + moduleName + '" is not loaded.' );
2169 }
2170
2171 return registry[ moduleName ].module.exports;
2172 },
2173
2174 /**
2175 * @inheritdoc mw.inspect#runReports
2176 * @method
2177 */
2178 inspect: function () {
2179 var args = slice.call( arguments );
2180 mw.loader.using( 'mediawiki.inspect', function () {
2181 mw.inspect.runReports.apply( mw.inspect, args );
2182 } );
2183 },
2184
2185 /**
2186 * On browsers that implement the localStorage API, the module store serves as a
2187 * smart complement to the browser cache. Unlike the browser cache, the module store
2188 * can slice a concatenated response from ResourceLoader into its constituent
2189 * modules and cache each of them separately, using each module's versioning scheme
2190 * to determine when the cache should be invalidated.
2191 *
2192 * @singleton
2193 * @class mw.loader.store
2194 */
2195 store: {
2196 // Whether the store is in use on this page.
2197 enabled: null,
2198
2199 // Modules whose string representation exceeds 100 kB are
2200 // ineligible for storage. See bug T66721.
2201 MODULE_SIZE_MAX: 100 * 1000,
2202
2203 // The contents of the store, mapping '[name]@[version]' keys
2204 // to module implementations.
2205 items: {},
2206
2207 // Cache hit stats
2208 stats: { hits: 0, misses: 0, expired: 0, failed: 0 },
2209
2210 /**
2211 * Construct a JSON-serializable object representing the content of the store.
2212 *
2213 * @return {Object} Module store contents.
2214 */
2215 toJSON: function () {
2216 return { items: mw.loader.store.items, vary: mw.loader.store.getVary() };
2217 },
2218
2219 /**
2220 * Get the localStorage key for the entire module store. The key references
2221 * $wgDBname to prevent clashes between wikis which share a common host.
2222 *
2223 * @return {string} localStorage item key
2224 */
2225 getStoreKey: function () {
2226 return 'MediaWikiModuleStore:' + mw.config.get( 'wgDBname' );
2227 },
2228
2229 /**
2230 * Get a key on which to vary the module cache.
2231 *
2232 * @return {string} String of concatenated vary conditions.
2233 */
2234 getVary: function () {
2235 return [
2236 mw.config.get( 'skin' ),
2237 mw.config.get( 'wgResourceLoaderStorageVersion' ),
2238 mw.config.get( 'wgUserLanguage' )
2239 ].join( ':' );
2240 },
2241
2242 /**
2243 * Initialize the store.
2244 *
2245 * Retrieves store from localStorage and (if successfully retrieved) decoding
2246 * the stored JSON value to a plain object.
2247 *
2248 * The try / catch block is used for JSON & localStorage feature detection.
2249 * See the in-line documentation for Modernizr's localStorage feature detection
2250 * code for a full account of why we need a try / catch:
2251 * <https://github.com/Modernizr/Modernizr/blob/v2.7.1/modernizr.js#L771-L796>.
2252 */
2253 init: function () {
2254 var raw, data;
2255
2256 if ( mw.loader.store.enabled !== null ) {
2257 // Init already ran
2258 return;
2259 }
2260
2261 if (
2262 // Disabled because localStorage quotas are tight and (in Firefox's case)
2263 // shared by multiple origins.
2264 // See T66721, and <https://bugzilla.mozilla.org/show_bug.cgi?id=1064466>.
2265 /Firefox|Opera/.test( navigator.userAgent ) ||
2266
2267 // Disabled by configuration.
2268 !mw.config.get( 'wgResourceLoaderStorageEnabled' )
2269 ) {
2270 // Clear any previous store to free up space. (T66721)
2271 mw.loader.store.clear();
2272 mw.loader.store.enabled = false;
2273 return;
2274 }
2275 if ( mw.config.get( 'debug' ) ) {
2276 // Disable module store in debug mode
2277 mw.loader.store.enabled = false;
2278 return;
2279 }
2280
2281 try {
2282 raw = localStorage.getItem( mw.loader.store.getStoreKey() );
2283 // If we get here, localStorage is available; mark enabled
2284 mw.loader.store.enabled = true;
2285 data = JSON.parse( raw );
2286 if ( data && typeof data.items === 'object' && data.vary === mw.loader.store.getVary() ) {
2287 mw.loader.store.items = data.items;
2288 return;
2289 }
2290 } catch ( e ) {
2291 mw.track( 'resourceloader.exception', { exception: e, source: 'store-localstorage-init' } );
2292 }
2293
2294 if ( raw === undefined ) {
2295 // localStorage failed; disable store
2296 mw.loader.store.enabled = false;
2297 } else {
2298 mw.loader.store.update();
2299 }
2300 },
2301
2302 /**
2303 * Retrieve a module from the store and update cache hit stats.
2304 *
2305 * @param {string} module Module name
2306 * @return {string|boolean} Module implementation or false if unavailable
2307 */
2308 get: function ( module ) {
2309 var key;
2310
2311 if ( !mw.loader.store.enabled ) {
2312 return false;
2313 }
2314
2315 key = getModuleKey( module );
2316 if ( key in mw.loader.store.items ) {
2317 mw.loader.store.stats.hits++;
2318 return mw.loader.store.items[ key ];
2319 }
2320 mw.loader.store.stats.misses++;
2321 return false;
2322 },
2323
2324 /**
2325 * Stringify a module and queue it for storage.
2326 *
2327 * @param {string} module Module name
2328 * @param {Object} descriptor The module's descriptor as set in the registry
2329 * @return {boolean} Module was set
2330 */
2331 set: function ( module, descriptor ) {
2332 var args, key, src;
2333
2334 if ( !mw.loader.store.enabled ) {
2335 return false;
2336 }
2337
2338 key = getModuleKey( module );
2339
2340 if (
2341 // Already stored a copy of this exact version
2342 key in mw.loader.store.items ||
2343 // Module failed to load
2344 descriptor.state !== 'ready' ||
2345 // Unversioned, private, or site-/user-specific
2346 !descriptor.version ||
2347 descriptor.group === 'private' ||
2348 descriptor.group === 'user' ||
2349 // Partial descriptor
2350 // (e.g. skipped module, or style module with state=ready)
2351 [ descriptor.script, descriptor.style, descriptor.messages,
2352 descriptor.templates ].indexOf( undefined ) !== -1
2353 ) {
2354 // Decline to store
2355 return false;
2356 }
2357
2358 try {
2359 args = [
2360 JSON.stringify( key ),
2361 typeof descriptor.script === 'function' ?
2362 String( descriptor.script ) :
2363 JSON.stringify( descriptor.script ),
2364 JSON.stringify( descriptor.style ),
2365 JSON.stringify( descriptor.messages ),
2366 JSON.stringify( descriptor.templates )
2367 ];
2368 // Attempted workaround for a possible Opera bug (bug T59567).
2369 // This regex should never match under sane conditions.
2370 if ( /^\s*\(/.test( args[ 1 ] ) ) {
2371 args[ 1 ] = 'function' + args[ 1 ];
2372 mw.track( 'resourceloader.assert', { source: 'bug-T59567' } );
2373 }
2374 } catch ( e ) {
2375 mw.track( 'resourceloader.exception', { exception: e, source: 'store-localstorage-json' } );
2376 return false;
2377 }
2378
2379 src = 'mw.loader.implement(' + args.join( ',' ) + ');';
2380 if ( src.length > mw.loader.store.MODULE_SIZE_MAX ) {
2381 return false;
2382 }
2383 mw.loader.store.items[ key ] = src;
2384 mw.loader.store.update();
2385 return true;
2386 },
2387
2388 /**
2389 * Iterate through the module store, removing any item that does not correspond
2390 * (in name and version) to an item in the module registry.
2391 *
2392 * @return {boolean} Store was pruned
2393 */
2394 prune: function () {
2395 var key, module;
2396
2397 if ( !mw.loader.store.enabled ) {
2398 return false;
2399 }
2400
2401 for ( key in mw.loader.store.items ) {
2402 module = key.slice( 0, key.indexOf( '@' ) );
2403 if ( getModuleKey( module ) !== key ) {
2404 mw.loader.store.stats.expired++;
2405 delete mw.loader.store.items[ key ];
2406 } else if ( mw.loader.store.items[ key ].length > mw.loader.store.MODULE_SIZE_MAX ) {
2407 // This value predates the enforcement of a size limit on cached modules.
2408 delete mw.loader.store.items[ key ];
2409 }
2410 }
2411 return true;
2412 },
2413
2414 /**
2415 * Clear the entire module store right now.
2416 */
2417 clear: function () {
2418 mw.loader.store.items = {};
2419 try {
2420 localStorage.removeItem( mw.loader.store.getStoreKey() );
2421 } catch ( ignored ) {}
2422 },
2423
2424 /**
2425 * Sync in-memory store back to localStorage.
2426 *
2427 * This function debounces updates. When called with a flush already pending,
2428 * the call is coalesced into the pending update. The call to
2429 * localStorage.setItem will be naturally deferred until the page is quiescent.
2430 *
2431 * Because localStorage is shared by all pages from the same origin, if multiple
2432 * pages are loaded with different module sets, the possibility exists that
2433 * modules saved by one page will be clobbered by another. But the impact would
2434 * be minor and the problem would be corrected by subsequent page views.
2435 *
2436 * @method
2437 */
2438 update: ( function () {
2439 var hasPendingWrite = false;
2440
2441 function flushWrites() {
2442 var data, key;
2443 if ( !hasPendingWrite || !mw.loader.store.enabled ) {
2444 return;
2445 }
2446
2447 mw.loader.store.prune();
2448 key = mw.loader.store.getStoreKey();
2449 try {
2450 // Replacing the content of the module store might fail if the new
2451 // contents would exceed the browser's localStorage size limit. To
2452 // avoid clogging the browser with stale data, always remove the old
2453 // value before attempting to set the new one.
2454 localStorage.removeItem( key );
2455 data = JSON.stringify( mw.loader.store );
2456 localStorage.setItem( key, data );
2457 } catch ( e ) {
2458 mw.track( 'resourceloader.exception', { exception: e, source: 'store-localstorage-update' } );
2459 }
2460
2461 hasPendingWrite = false;
2462 }
2463
2464 return function () {
2465 if ( !hasPendingWrite ) {
2466 hasPendingWrite = true;
2467 mw.requestIdleCallback( flushWrites );
2468 }
2469 };
2470 }() )
2471 }
2472 };
2473 }() ),
2474
2475 /**
2476 * HTML construction helper functions
2477 *
2478 * @example
2479 *
2480 * var Html, output;
2481 *
2482 * Html = mw.html;
2483 * output = Html.element( 'div', {}, new Html.Raw(
2484 * Html.element( 'img', { src: '<' } )
2485 * ) );
2486 * mw.log( output ); // <div><img src="&lt;"/></div>
2487 *
2488 * @class mw.html
2489 * @singleton
2490 */
2491 html: ( function () {
2492 function escapeCallback( s ) {
2493 switch ( s ) {
2494 case '\'':
2495 return '&#039;';
2496 case '"':
2497 return '&quot;';
2498 case '<':
2499 return '&lt;';
2500 case '>':
2501 return '&gt;';
2502 case '&':
2503 return '&amp;';
2504 }
2505 }
2506
2507 return {
2508 /**
2509 * Escape a string for HTML.
2510 *
2511 * Converts special characters to HTML entities.
2512 *
2513 * mw.html.escape( '< > \' & "' );
2514 * // Returns &lt; &gt; &#039; &amp; &quot;
2515 *
2516 * @param {string} s The string to escape
2517 * @return {string} HTML
2518 */
2519 escape: function ( s ) {
2520 return s.replace( /['"<>&]/g, escapeCallback );
2521 },
2522
2523 /**
2524 * Create an HTML element string, with safe escaping.
2525 *
2526 * @param {string} name The tag name.
2527 * @param {Object} [attrs] An object with members mapping element names to values
2528 * @param {string|mw.html.Raw|mw.html.Cdata|null} [contents=null] The contents of the element.
2529 *
2530 * - string: Text to be escaped.
2531 * - null: The element is treated as void with short closing form, e.g. `<br/>`.
2532 * - this.Raw: The raw value is directly included.
2533 * - this.Cdata: The raw value is directly included. An exception is
2534 * thrown if it contains any illegal ETAGO delimiter.
2535 * See <https://www.w3.org/TR/html401/appendix/notes.html#h-B.3.2>.
2536 * @return {string} HTML
2537 */
2538 element: function ( name, attrs, contents ) {
2539 var v, attrName, s = '<' + name;
2540
2541 if ( attrs ) {
2542 for ( attrName in attrs ) {
2543 v = attrs[ attrName ];
2544 // Convert name=true, to name=name
2545 if ( v === true ) {
2546 v = attrName;
2547 // Skip name=false
2548 } else if ( v === false ) {
2549 continue;
2550 }
2551 s += ' ' + attrName + '="' + this.escape( String( v ) ) + '"';
2552 }
2553 }
2554 if ( contents === undefined || contents === null ) {
2555 // Self close tag
2556 s += '/>';
2557 return s;
2558 }
2559 // Regular open tag
2560 s += '>';
2561 switch ( typeof contents ) {
2562 case 'string':
2563 // Escaped
2564 s += this.escape( contents );
2565 break;
2566 case 'number':
2567 case 'boolean':
2568 // Convert to string
2569 s += String( contents );
2570 break;
2571 default:
2572 if ( contents instanceof this.Raw ) {
2573 // Raw HTML inclusion
2574 s += contents.value;
2575 } else if ( contents instanceof this.Cdata ) {
2576 // CDATA
2577 if ( /<\/[a-zA-z]/.test( contents.value ) ) {
2578 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
2579 }
2580 s += contents.value;
2581 } else {
2582 throw new Error( 'mw.html.element: Invalid type of contents' );
2583 }
2584 }
2585 s += '</' + name + '>';
2586 return s;
2587 },
2588
2589 /**
2590 * Wrapper object for raw HTML passed to mw.html.element().
2591 *
2592 * @class mw.html.Raw
2593 * @constructor
2594 * @param {string} value
2595 */
2596 Raw: function ( value ) {
2597 this.value = value;
2598 },
2599
2600 /**
2601 * Wrapper object for CDATA element contents passed to mw.html.element()
2602 *
2603 * @class mw.html.Cdata
2604 * @constructor
2605 * @param {string} value
2606 */
2607 Cdata: function ( value ) {
2608 this.value = value;
2609 }
2610 };
2611 }() ),
2612
2613 // Skeleton user object, extended by the 'mediawiki.user' module.
2614 /**
2615 * @class mw.user
2616 * @singleton
2617 */
2618 user: {
2619 /**
2620 * @property {mw.Map}
2621 */
2622 options: new Map(),
2623 /**
2624 * @property {mw.Map}
2625 */
2626 tokens: new Map()
2627 },
2628
2629 // OOUI widgets specific to MediaWiki
2630 widgets: {},
2631
2632 /**
2633 * Registry and firing of events.
2634 *
2635 * MediaWiki has various interface components that are extended, enhanced
2636 * or manipulated in some other way by extensions, gadgets and even
2637 * in core itself.
2638 *
2639 * This framework helps streamlining the timing of when these other
2640 * code paths fire their plugins (instead of using document-ready,
2641 * which can and should be limited to firing only once).
2642 *
2643 * Features like navigating to other wiki pages, previewing an edit
2644 * and editing itself – without a refresh – can then retrigger these
2645 * hooks accordingly to ensure everything still works as expected.
2646 *
2647 * Example usage:
2648 *
2649 * mw.hook( 'wikipage.content' ).add( fn ).remove( fn );
2650 * mw.hook( 'wikipage.content' ).fire( $content );
2651 *
2652 * Handlers can be added and fired for arbitrary event names at any time. The same
2653 * event can be fired multiple times. The last run of an event is memorized
2654 * (similar to `$(document).ready` and `$.Deferred().done`).
2655 * This means if an event is fired, and a handler added afterwards, the added
2656 * function will be fired right away with the last given event data.
2657 *
2658 * Like Deferreds and Promises, the mw.hook object is both detachable and chainable.
2659 * Thus allowing flexible use and optimal maintainability and authority control.
2660 * You can pass around the `add` and/or `fire` method to another piece of code
2661 * without it having to know the event name (or `mw.hook` for that matter).
2662 *
2663 * var h = mw.hook( 'bar.ready' );
2664 * new mw.Foo( .. ).fetch( { callback: h.fire } );
2665 *
2666 * Note: Events are documented with an underscore instead of a dot in the event
2667 * name due to jsduck not supporting dots in that position.
2668 *
2669 * @class mw.hook
2670 */
2671 hook: ( function () {
2672 var lists = {};
2673
2674 /**
2675 * Create an instance of mw.hook.
2676 *
2677 * @method hook
2678 * @member mw
2679 * @param {string} name Name of hook.
2680 * @return {mw.hook}
2681 */
2682 return function ( name ) {
2683 var list = hasOwn.call( lists, name ) ?
2684 lists[ name ] :
2685 lists[ name ] = $.Callbacks( 'memory' );
2686
2687 return {
2688 /**
2689 * Register a hook handler
2690 *
2691 * @param {...Function} handler Function to bind.
2692 * @chainable
2693 */
2694 add: list.add,
2695
2696 /**
2697 * Unregister a hook handler
2698 *
2699 * @param {...Function} handler Function to unbind.
2700 * @chainable
2701 */
2702 remove: list.remove,
2703
2704 // eslint-disable-next-line valid-jsdoc
2705 /**
2706 * Run a hook.
2707 *
2708 * @param {...Mixed} data
2709 * @chainable
2710 */
2711 fire: function () {
2712 return list.fireWith.call( this, null, slice.call( arguments ) );
2713 }
2714 };
2715 };
2716 }() )
2717 };
2718
2719 // Alias $j to jQuery for backwards compatibility
2720 // @deprecated since 1.23 Use $ or jQuery instead
2721 mw.log.deprecate( window, '$j', $, 'Use $ or jQuery instead.' );
2722
2723 /**
2724 * Log a message to window.console, if possible.
2725 *
2726 * Useful to force logging of some errors that are otherwise hard to detect (i.e., this logs
2727 * also in production mode). Gets console references in each invocation instead of caching the
2728 * reference, so that debugging tools loaded later are supported (e.g. Firebug Lite in IE).
2729 *
2730 * @private
2731 * @param {string} topic Stream name passed by mw.track
2732 * @param {Object} data Data passed by mw.track
2733 * @param {Error} [data.exception]
2734 * @param {string} data.source Error source
2735 * @param {string} [data.module] Name of module which caused the error
2736 */
2737 function logError( topic, data ) {
2738 /* eslint-disable no-console */
2739 var msg,
2740 e = data.exception,
2741 source = data.source,
2742 module = data.module,
2743 console = window.console;
2744
2745 if ( console && console.log ) {
2746 msg = ( e ? 'Exception' : 'Error' ) + ' in ' + source;
2747 if ( module ) {
2748 msg += ' in module ' + module;
2749 }
2750 msg += ( e ? ':' : '.' );
2751 console.log( msg );
2752
2753 // If we have an exception object, log it to the warning channel to trigger
2754 // proper stacktraces in browsers that support it.
2755 if ( e && console.warn ) {
2756 console.warn( String( e ), e );
2757 }
2758 }
2759 /* eslint-enable no-console */
2760 }
2761
2762 // Subscribe to error streams
2763 mw.trackSubscribe( 'resourceloader.exception', logError );
2764 mw.trackSubscribe( 'resourceloader.assert', logError );
2765
2766 /**
2767 * Fired when all modules associated with the page have finished loading.
2768 *
2769 * @event resourceloader_loadEnd
2770 * @member mw.hook
2771 */
2772 $( function () {
2773 var loading, modules;
2774
2775 modules = mw.loader.getModuleNames().filter( function ( module ) {
2776 return mw.loader.getState( module ) === 'loading';
2777 } );
2778 // We only need a callback, not any actual module. First try a single using()
2779 // for all loading modules. If one fails, fall back to tracking each module
2780 // separately via $.when(), this is expensive.
2781 loading = mw.loader.using( modules ).then( null, function () {
2782 var all = modules.map( function ( module ) {
2783 return mw.loader.using( module ).then( null, function () {
2784 return $.Deferred().resolve();
2785 } );
2786 } );
2787 return $.when.apply( $, all );
2788 } );
2789 loading.then( function () {
2790 /* global mwPerformance */
2791 mwPerformance.mark( 'mwLoadEnd' );
2792 mw.hook( 'resourceloader.loadEnd' ).fire();
2793 } );
2794 } );
2795
2796 // Attach to window and globally alias
2797 window.mw = window.mediaWiki = mw;
2798 }( jQuery ) );