RELEASE-NOTES-1.31: More cleanup
[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-US/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 = [],
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( 'Created ResourceLoaderDynamicStyles marker dynamically' );
883 marker = document.createElement( 'meta' );
884 marker.name = 'ResourceLoaderDynamicStyles';
885 document.head.appendChild( marker );
886 }
887 }
888 return marker;
889 }
890
891 /**
892 * Create a new style element and add it to the DOM.
893 *
894 * @private
895 * @param {string} text CSS text
896 * @param {Node} [nextNode] The element where the style tag
897 * should be inserted before
898 * @return {HTMLElement} Reference to the created style element
899 */
900 function newStyleTag( text, nextNode ) {
901 var s = document.createElement( 'style' );
902
903 s.appendChild( document.createTextNode( text ) );
904 if ( nextNode && nextNode.parentNode ) {
905 nextNode.parentNode.insertBefore( s, nextNode );
906 } else {
907 document.head.appendChild( s );
908 }
909
910 return s;
911 }
912
913 /**
914 * Add a bit of CSS text to the current browser page.
915 *
916 * The CSS will be appended to an existing ResourceLoader-created `<style>` tag
917 * or create a new one based on whether the given `cssText` is safe for extension.
918 *
919 * @private
920 * @param {string} [cssText=cssBuffer] If called without cssText,
921 * the internal buffer will be inserted instead.
922 * @param {Function} [callback]
923 */
924 function addEmbeddedCSS( cssText, callback ) {
925 function fireCallbacks() {
926 var i,
927 oldCallbacks = cssCallbacks;
928 // Reset cssCallbacks variable so it's not polluted by any calls to
929 // addEmbeddedCSS() from one of the callbacks (T105973)
930 cssCallbacks = [];
931 for ( i = 0; i < oldCallbacks.length; i++ ) {
932 oldCallbacks[ i ]();
933 }
934 }
935
936 if ( callback ) {
937 cssCallbacks.push( callback );
938 }
939
940 // Yield once before creating the <style> tag. This lets multiple stylesheets
941 // accumulate into one buffer, allowing us to reduce how often new stylesheets
942 // are inserted in the browser. Appending a stylesheet and waiting for the
943 // browser to repaint is fairly expensive. (T47810)
944 if ( cssText ) {
945 // Don't extend the buffer if the item needs its own stylesheet.
946 // Keywords like `@import` are only valid at the start of a stylesheet (T37562).
947 if ( !cssBuffer || cssText.slice( 0, '@import'.length ) !== '@import' ) {
948 // Linebreak for somewhat distinguishable sections
949 cssBuffer += '\n' + cssText;
950 if ( !cssBufferTimer ) {
951 cssBufferTimer = rAF( function () {
952 // Wrap in anonymous function that takes no arguments
953 // Support: Firefox < 13
954 // Firefox 12 has non-standard behaviour of passing a number
955 // as first argument to a setTimeout callback.
956 // http://benalman.com/news/2009/07/the-mysterious-firefox-settime/
957 addEmbeddedCSS();
958 } );
959 }
960 return;
961 }
962
963 // This is a scheduled flush for the buffer
964 } else {
965 cssBufferTimer = null;
966 cssText = cssBuffer;
967 cssBuffer = '';
968 }
969
970 $( newStyleTag( cssText, getMarker() ) );
971
972 fireCallbacks();
973 }
974
975 /**
976 * @private
977 * @param {Array} modules List of module names
978 * @return {string} Hash of concatenated version hashes.
979 */
980 function getCombinedVersion( modules ) {
981 var hashes = modules.map( function ( module ) {
982 return registry[ module ].version;
983 } );
984 return fnv132( hashes.join( '' ) );
985 }
986
987 /**
988 * Determine whether all dependencies are in state 'ready', which means we may
989 * execute the module or job now.
990 *
991 * @private
992 * @param {Array} modules Names of modules to be checked
993 * @return {boolean} True if all modules are in state 'ready', false otherwise
994 */
995 function allReady( modules ) {
996 var i;
997 for ( i = 0; i < modules.length; i++ ) {
998 if ( mw.loader.getState( modules[ i ] ) !== 'ready' ) {
999 return false;
1000 }
1001 }
1002 return true;
1003 }
1004
1005 /**
1006 * Determine whether all dependencies are in state 'ready', which means we may
1007 * execute the module or job now.
1008 *
1009 * @private
1010 * @param {Array} modules Names of modules to be checked
1011 * @return {boolean} True if no modules are in state 'error' or 'missing', false otherwise
1012 */
1013 function anyFailed( modules ) {
1014 var i, state;
1015 for ( i = 0; i < modules.length; i++ ) {
1016 state = mw.loader.getState( modules[ i ] );
1017 if ( state === 'error' || state === 'missing' ) {
1018 return true;
1019 }
1020 }
1021 return false;
1022 }
1023
1024 /**
1025 * A module has entered state 'ready', 'error', or 'missing'. Automatically update
1026 * pending jobs and modules that depend upon this module. If the given module failed,
1027 * propagate the 'error' state up the dependency tree. Otherwise, go ahead and execute
1028 * all jobs/modules now having their dependencies satisfied.
1029 *
1030 * Jobs that depend on a failed module, will have their error callback ran (if any).
1031 *
1032 * @private
1033 * @param {string} module Name of module that entered one of the states 'ready', 'error', or 'missing'.
1034 */
1035 function handlePending( module ) {
1036 var j, job, hasErrors, m, stateChange;
1037
1038 if ( registry[ module ].state === 'error' || registry[ module ].state === 'missing' ) {
1039 // If the current module failed, mark all dependent modules also as failed.
1040 // Iterate until steady-state to propagate the error state upwards in the
1041 // dependency tree.
1042 do {
1043 stateChange = false;
1044 for ( m in registry ) {
1045 if ( registry[ m ].state !== 'error' && registry[ m ].state !== 'missing' ) {
1046 if ( anyFailed( registry[ m ].dependencies ) ) {
1047 registry[ m ].state = 'error';
1048 stateChange = true;
1049 }
1050 }
1051 }
1052 } while ( stateChange );
1053 }
1054
1055 // Execute all jobs whose dependencies are either all satisfied or contain at least one failed module.
1056 for ( j = 0; j < jobs.length; j++ ) {
1057 hasErrors = anyFailed( jobs[ j ].dependencies );
1058 if ( hasErrors || allReady( jobs[ j ].dependencies ) ) {
1059 // All dependencies satisfied, or some have errors
1060 job = jobs[ j ];
1061 jobs.splice( j, 1 );
1062 j -= 1;
1063 try {
1064 if ( hasErrors ) {
1065 if ( typeof job.error === 'function' ) {
1066 job.error( new Error( 'Module ' + module + ' has failed dependencies' ), [ module ] );
1067 }
1068 } else {
1069 if ( typeof job.ready === 'function' ) {
1070 job.ready();
1071 }
1072 }
1073 } catch ( e ) {
1074 // A user-defined callback raised an exception.
1075 // Swallow it to protect our state machine!
1076 mw.track( 'resourceloader.exception', { exception: e, module: module, source: 'load-callback' } );
1077 }
1078 }
1079 }
1080
1081 if ( registry[ module ].state === 'ready' ) {
1082 // The current module became 'ready'. Set it in the module store, and recursively execute all
1083 // dependent modules that are loaded and now have all dependencies satisfied.
1084 mw.loader.store.set( module, registry[ module ] );
1085 for ( m in registry ) {
1086 if ( registry[ m ].state === 'loaded' && allReady( registry[ m ].dependencies ) ) {
1087 execute( m );
1088 }
1089 }
1090 }
1091 }
1092
1093 /**
1094 * Resolve dependencies and detect circular references.
1095 *
1096 * @private
1097 * @param {string} module Name of the top-level module whose dependencies shall be
1098 * resolved and sorted.
1099 * @param {Array} resolved Returns a topological sort of the given module and its
1100 * dependencies, such that later modules depend on earlier modules. The array
1101 * contains the module names. If the array contains already some module names,
1102 * this function appends its result to the pre-existing array.
1103 * @param {StringSet} [unresolved] Used to track the current dependency
1104 * chain, and to report loops in the dependency graph.
1105 * @throws {Error} If any unregistered module or a dependency loop is encountered
1106 */
1107 function sortDependencies( module, resolved, unresolved ) {
1108 var i, deps, skip;
1109
1110 if ( !hasOwn.call( registry, module ) ) {
1111 throw new Error( 'Unknown dependency: ' + module );
1112 }
1113
1114 if ( registry[ module ].skip !== null ) {
1115 // eslint-disable-next-line no-new-func
1116 skip = new Function( registry[ module ].skip );
1117 registry[ module ].skip = null;
1118 if ( skip() ) {
1119 registry[ module ].skipped = true;
1120 registry[ module ].dependencies = [];
1121 registry[ module ].state = 'ready';
1122 handlePending( module );
1123 return;
1124 }
1125 }
1126
1127 // Resolves dynamic loader function and replaces it with its own results
1128 if ( typeof registry[ module ].dependencies === 'function' ) {
1129 registry[ module ].dependencies = registry[ module ].dependencies();
1130 // Ensures the module's dependencies are always in an array
1131 if ( typeof registry[ module ].dependencies !== 'object' ) {
1132 registry[ module ].dependencies = [ registry[ module ].dependencies ];
1133 }
1134 }
1135 if ( resolved.indexOf( module ) !== -1 ) {
1136 // Module already resolved; nothing to do
1137 return;
1138 }
1139 // Create unresolved if not passed in
1140 if ( !unresolved ) {
1141 unresolved = new StringSet();
1142 }
1143 // Tracks down dependencies
1144 deps = registry[ module ].dependencies;
1145 for ( i = 0; i < deps.length; i++ ) {
1146 if ( resolved.indexOf( deps[ i ] ) === -1 ) {
1147 if ( unresolved.has( deps[ i ] ) ) {
1148 throw new Error( mw.format(
1149 'Circular reference detected: $1 -> $2',
1150 module,
1151 deps[ i ]
1152 ) );
1153 }
1154
1155 unresolved.add( module );
1156 sortDependencies( deps[ i ], resolved, unresolved );
1157 }
1158 }
1159 resolved.push( module );
1160 }
1161
1162 /**
1163 * Get names of module that a module depends on, in their proper dependency order.
1164 *
1165 * @private
1166 * @param {string[]} modules Array of string module names
1167 * @return {Array} List of dependencies, including 'module'.
1168 * @throws {Error} If an unregistered module or a dependency loop is encountered
1169 */
1170 function resolve( modules ) {
1171 var i, resolved = [];
1172 for ( i = 0; i < modules.length; i++ ) {
1173 sortDependencies( modules[ i ], resolved );
1174 }
1175 return resolved;
1176 }
1177
1178 /**
1179 * Like #resolve(), except it will silently ignore modules that
1180 * are missing or have missing dependencies.
1181 *
1182 * @private
1183 * @param {string[]} modules Array of string module names
1184 * @return {Array} List of dependencies.
1185 */
1186 function resolveStubbornly( modules ) {
1187 var i, saved, resolved = [];
1188 for ( i = 0; i < modules.length; i++ ) {
1189 saved = resolved.slice();
1190 try {
1191 sortDependencies( modules[ i ], resolved );
1192 } catch ( err ) {
1193 // This module is unknown or has unknown dependencies.
1194 // Undo any incomplete resolutions made and keep going.
1195 resolved = saved;
1196 mw.track( 'resourceloader.exception', {
1197 exception: err,
1198 source: 'resolve'
1199 } );
1200 }
1201 }
1202 return resolved;
1203 }
1204
1205 /**
1206 * Load and execute a script.
1207 *
1208 * @private
1209 * @param {string} src URL to script, will be used as the src attribute in the script tag
1210 * @return {jQuery.Promise}
1211 */
1212 function addScript( src ) {
1213 return $.ajax( {
1214 url: src,
1215 dataType: 'script',
1216 // Force jQuery behaviour to be for crossDomain. Otherwise jQuery would use
1217 // XHR for a same domain request instead of <script>, which changes the request
1218 // headers (potentially missing a cache hit), and reduces caching in general
1219 // since browsers cache XHR much less (if at all). And XHR means we retrieve
1220 // text, so we'd need to $.globalEval, which then messes up line numbers.
1221 crossDomain: true,
1222 cache: true
1223 } );
1224 }
1225
1226 /**
1227 * Queue the loading and execution of a script for a particular module.
1228 *
1229 * @private
1230 * @param {string} src URL of the script
1231 * @param {string} [moduleName] Name of currently executing module
1232 * @return {jQuery.Promise}
1233 */
1234 function queueModuleScript( src, moduleName ) {
1235 var r = $.Deferred();
1236
1237 pendingRequests.push( function () {
1238 if ( moduleName && hasOwn.call( registry, moduleName ) ) {
1239 // Emulate runScript() part of execute()
1240 window.require = mw.loader.require;
1241 window.module = registry[ moduleName ].module;
1242 }
1243 addScript( src ).always( function () {
1244 // 'module.exports' should not persist after the file is executed to
1245 // avoid leakage to unrelated code. 'require' should be kept, however,
1246 // as asynchronous access to 'require' is allowed and expected. (T144879)
1247 delete window.module;
1248 r.resolve();
1249
1250 // Start the next one (if any)
1251 if ( pendingRequests[ 0 ] ) {
1252 pendingRequests.shift()();
1253 } else {
1254 handlingPendingRequests = false;
1255 }
1256 } );
1257 } );
1258 if ( !handlingPendingRequests && pendingRequests[ 0 ] ) {
1259 handlingPendingRequests = true;
1260 pendingRequests.shift()();
1261 }
1262 return r.promise();
1263 }
1264
1265 /**
1266 * Utility function for execute()
1267 *
1268 * @ignore
1269 * @param {string} [media] Media attribute
1270 * @param {string} url URL
1271 */
1272 function addLink( media, url ) {
1273 var el = document.createElement( 'link' );
1274
1275 el.rel = 'stylesheet';
1276 if ( media && media !== 'all' ) {
1277 el.media = media;
1278 }
1279 // If you end up here from an IE exception "SCRIPT: Invalid property value.",
1280 // see #addEmbeddedCSS, T33676, T43331, and T49277 for details.
1281 el.href = url;
1282
1283 $( getMarker() ).before( el );
1284 }
1285
1286 /**
1287 * Executes a loaded module, making it ready to use
1288 *
1289 * @private
1290 * @param {string} module Module name to execute
1291 */
1292 function execute( module ) {
1293 var key, value, media, i, urls, cssHandle, checkCssHandles, runScript,
1294 cssHandlesRegistered = false;
1295
1296 if ( !hasOwn.call( registry, module ) ) {
1297 throw new Error( 'Module has not been registered yet: ' + module );
1298 }
1299 if ( registry[ module ].state !== 'loaded' ) {
1300 throw new Error( 'Module in state "' + registry[ module ].state + '" may not be executed: ' + module );
1301 }
1302
1303 registry[ module ].state = 'executing';
1304
1305 runScript = function () {
1306 var script, markModuleReady, nestedAddScript;
1307
1308 script = registry[ module ].script;
1309 markModuleReady = function () {
1310 registry[ module ].state = 'ready';
1311 handlePending( module );
1312 };
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
1318 callback();
1319 return;
1320 }
1321
1322 queueModuleScript( arr[ i ], module ).always( function () {
1323 nestedAddScript( arr, callback, i + 1 );
1324 } );
1325 };
1326
1327 try {
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 );
1334 markModuleReady();
1335
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.
1340 $.globalEval( script );
1341 markModuleReady();
1342
1343 } else {
1344 // Module without script
1345 markModuleReady();
1346 }
1347 } catch ( e ) {
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 );
1353 }
1354 };
1355
1356 // Add localizations to message system
1357 if ( registry[ module ].messages ) {
1358 mw.messages.set( registry[ module ].messages );
1359 }
1360
1361 // Initialise templates
1362 if ( registry[ module ].templates ) {
1363 mw.templates.set( module, registry[ module ].templates );
1364 }
1365
1366 // Make sure we don't run the scripts until all stylesheet insertions have completed.
1367 ( function () {
1368 var pending = 0;
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 );
1377 } else {
1378 runScript();
1379 }
1380 runScript = undefined; // Revoke
1381 }
1382 };
1383 cssHandle = function () {
1384 var check = checkCssHandles;
1385 pending++;
1386 return function () {
1387 if ( check ) {
1388 pending--;
1389 check();
1390 check = undefined; // Revoke
1391 }
1392 };
1393 };
1394 }() );
1395
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 ];
1404 media = undefined;
1405
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() );
1415 } else {
1416 // back-compat: { <media>: [url, ..] }
1417 media = key;
1418 key = 'bc-url';
1419 }
1420 }
1421
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() );
1432 }
1433 }
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 ] );
1442 }
1443 }
1444 }
1445 }
1446 }
1447
1448 // Kick off.
1449 cssHandlesRegistered = true;
1450 checkCssHandles();
1451 }
1452
1453 /**
1454 * Add one or more modules to the module load queue.
1455 *
1456 * See also #work().
1457 *
1458 * @private
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
1462 */
1463 function enqueue( dependencies, ready, error ) {
1464 // Allow calling by single module name
1465 if ( typeof dependencies === 'string' ) {
1466 dependencies = [ dependencies ];
1467 }
1468
1469 // Add ready and error callbacks if they were given
1470 if ( ready !== undefined || error !== undefined ) {
1471 jobs.push( {
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';
1476 } ),
1477 ready: ready,
1478 error: error
1479 } );
1480 }
1481
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 );
1492 return;
1493 }
1494 queue.push( module );
1495 }
1496 } );
1497
1498 mw.loader.work();
1499 }
1500
1501 function sortQuery( o ) {
1502 var key,
1503 sorted = {},
1504 a = [];
1505
1506 for ( key in o ) {
1507 a.push( key );
1508 }
1509 a.sort();
1510 for ( key = 0; key < a.length; key++ ) {
1511 sorted[ a[ key ] ] = o[ a[ key ] ];
1512 }
1513 return sorted;
1514 }
1515
1516 /**
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`.
1519 *
1520 * See `ResourceLoader::makePackedModulesString()` in PHP, of which this is a port.
1521 * On the server, unpacking is done by `ResourceLoaderContext::expandModuleNames()`.
1522 *
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.
1526 *
1527 * @private
1528 * @param {Object} moduleMap Module map
1529 * @return {Object}
1530 * @return {string} return.str Module query string
1531 * @return {Array} return.list List of module names in matching order
1532 */
1533 function buildModulesString( moduleMap ) {
1534 var p, prefix,
1535 str = [],
1536 list = [];
1537
1538 function restore( suffix ) {
1539 return p + suffix;
1540 }
1541
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 ) );
1546 }
1547 return {
1548 str: str.join( '|' ),
1549 list: list
1550 };
1551 }
1552
1553 /**
1554 * Resolve indexed dependencies.
1555 *
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.
1561 *
1562 * @private
1563 * @param {Array} modules Modules array
1564 */
1565 function resolveIndexedDependencies( modules ) {
1566 var i, j, deps;
1567 function resolveIndex( dep ) {
1568 return typeof dep === 'number' ? modules[ dep ][ 0 ] : dep;
1569 }
1570 for ( i = 0; i < modules.length; i++ ) {
1571 deps = modules[ i ][ 2 ];
1572 if ( deps ) {
1573 for ( j = 0; j < deps.length; j++ ) {
1574 deps[ j ] = resolveIndex( deps[ j ] );
1575 }
1576 }
1577 }
1578 }
1579
1580 /**
1581 * Create network requests for a batch of modules.
1582 *
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`.
1586 *
1587 * @private
1588 * @param {string[]} batch
1589 */
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;
1595
1596 /**
1597 * Start the currently drafted request to the server.
1598 *
1599 * @ignore
1600 */
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 ) );
1614 }
1615
1616 if ( !batch.length ) {
1617 return;
1618 }
1619
1620 // Always order modules alphabetically to help reduce cache
1621 // misses for otherwise identical content.
1622 batch.sort();
1623
1624 // Query parameters common to all requests
1625 reqBase = {
1626 skin: mw.config.get( 'skin' ),
1627 lang: mw.config.get( 'wgUserLanguage' ),
1628 debug: mw.config.get( 'debug' )
1629 };
1630 maxQueryLength = mw.config.get( 'wgResourceLoaderMaxQueryLength', 2000 );
1631
1632 // Split module list by source and by group.
1633 splits = {};
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 ] = {};
1639 }
1640 if ( !hasOwn.call( splits[ bSource ], bGroup ) ) {
1641 splits[ bSource ][ bGroup ] = [];
1642 }
1643 bSourceGroup = splits[ bSource ][ bGroup ];
1644 bSourceGroup.push( batch[ b ] );
1645 }
1646
1647 for ( source in splits ) {
1648
1649 sourceLoadScript = sources[ source ];
1650
1651 for ( group in splits[ source ] ) {
1652
1653 // Cache access to currently selected list of
1654 // modules for this group from this source.
1655 modules = splits[ source ][ group ];
1656
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' );
1663 }
1664
1665 // In addition to currReqBase, doRequest() will also add 'modules' and 'version'.
1666 // > '&modules='.length === 9
1667 // > '&version=1234567'.length === 16
1668 // > 9 + 16 = 25
1669 currReqBaseLength = $.param( currReqBase ).length + 25;
1670
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 = [];
1676
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
1686
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...
1690 doRequest();
1691 // .. and start again.
1692 l = currReqBaseLength;
1693 moduleMap = {};
1694 currReqModules = [];
1695
1696 mw.track( 'resourceloader.splitRequest', { maxQueryLength: maxQueryLength } );
1697 }
1698 if ( !hasOwn.call( moduleMap, prefix ) ) {
1699 moduleMap[ prefix ] = [];
1700 }
1701 l += bytesAdded;
1702 moduleMap[ prefix ].push( suffix );
1703 currReqModules.push( modules[ i ] );
1704 }
1705 // If there's anything left in moduleMap, request that too
1706 if ( currReqModules.length ) {
1707 doRequest();
1708 }
1709 }
1710 }
1711 }
1712
1713 /**
1714 * @private
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
1719 */
1720 function asyncEval( implementations, cb ) {
1721 if ( !implementations.length ) {
1722 return;
1723 }
1724 mw.requestIdleCallback( function () {
1725 try {
1726 $.globalEval( implementations.join( ';' ) );
1727 } catch ( err ) {
1728 cb( err );
1729 }
1730 } );
1731 }
1732
1733 /**
1734 * Make a versioned key for a specific module.
1735 *
1736 * @private
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
1740 */
1741 function getModuleKey( module ) {
1742 return hasOwn.call( registry, module ) ?
1743 ( module + '@' + registry[ module ].version ) : null;
1744 }
1745
1746 /**
1747 * @private
1748 * @param {string} key Module name or '`[name]@[version]`'
1749 * @return {Object}
1750 */
1751 function splitModuleKey( key ) {
1752 var index = key.indexOf( '@' );
1753 if ( index === -1 ) {
1754 return {
1755 name: key,
1756 version: ''
1757 };
1758 }
1759 return {
1760 name: key.slice( 0, index ),
1761 version: key.slice( index + 1 )
1762 };
1763 }
1764
1765 /* Public Members */
1766 return {
1767 /**
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.
1770 *
1771 * @see #registry
1772 * @property
1773 * @private
1774 */
1775 moduleRegistry: registry,
1776
1777 /**
1778 * @inheritdoc #newStyleTag
1779 * @method
1780 */
1781 addStyleTag: newStyleTag,
1782
1783 /**
1784 * Start loading of all queued module dependencies.
1785 *
1786 * @protected
1787 */
1788 work: function () {
1789 var q, batch, implementations, sourceModules;
1790
1791 batch = [];
1792
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';
1802 }
1803 }
1804 }
1805
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.
1811 queue = [];
1812
1813 if ( !batch.length ) {
1814 return;
1815 }
1816
1817 mw.loader.store.init();
1818 if ( mw.loader.store.enabled ) {
1819 implementations = [];
1820 sourceModules = [];
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 );
1826 return false;
1827 }
1828 return true;
1829 } );
1830 asyncEval( implementations, function ( err ) {
1831 var failed;
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++;
1838
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();
1843
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';
1848 } );
1849 batchRequest( failed );
1850 } );
1851 }
1852
1853 batchRequest( batch );
1854 },
1855
1856 /**
1857 * Register a source.
1858 *
1859 * The #work() method will use this information to split up requests by source.
1860 *
1861 * mw.loader.addSource( 'mediawikiwiki', '//www.mediawiki.org/w/load.php' );
1862 *
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
1866 */
1867 addSource: function ( id, loadUrl ) {
1868 var source;
1869 // Allow multiple additions
1870 if ( typeof id === 'object' ) {
1871 for ( source in id ) {
1872 mw.loader.addSource( source, id[ source ] );
1873 }
1874 return;
1875 }
1876
1877 if ( hasOwn.call( sources, id ) ) {
1878 throw new Error( 'source already registered: ' + id );
1879 }
1880
1881 sources[ id ] = loadUrl;
1882 },
1883
1884 /**
1885 * Register a module, letting the system know about it and its properties.
1886 *
1887 * The startup modules contain calls to this method.
1888 *
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.
1892 *
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|Function} dependencies One string or array of strings of module
1898 * names on which this module depends, or a function that returns that array.
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
1902 */
1903 register: function ( module, version, dependencies, group, source, skip ) {
1904 var i, deps;
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 ] );
1915 }
1916 }
1917 return;
1918 }
1919 if ( hasOwn.call( registry, module ) ) {
1920 throw new Error( 'module already registered: ' + module );
1921 }
1922 if ( typeof dependencies === 'string' ) {
1923 // A single module name
1924 deps = [ dependencies ];
1925 } else if ( typeof dependencies === 'object' || typeof dependencies === 'function' ) {
1926 // Array of module names or a function that returns an array
1927 deps = dependencies;
1928 }
1929 // List the module as registered
1930 registry[ module ] = {
1931 // Exposed to execute() for mw.loader.implement() closures.
1932 // Import happens via require().
1933 module: {
1934 exports: {}
1935 },
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
1942 };
1943 },
1944
1945 /**
1946 * Implement a module given the components that make up the module.
1947 *
1948 * When #load() or #using() requests one or more modules, the server
1949 * response contain calls to this function.
1950 *
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:
1958 *
1959 * { "css": [css, ..] }
1960 * { "url": { <media>: [url, ..] } }
1961 *
1962 * And for backwards compatibility (needs to be supported forever due to caching):
1963 *
1964 * { <media>: css }
1965 * { <media>: [url, ..] }
1966 *
1967 * The reason css strings are not concatenated anymore is T33676. We now check
1968 * whether it's safe to extend the stylesheet.
1969 *
1970 * @protected
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.
1973 */
1974 implement: function ( module, script, style, messages, templates ) {
1975 var split = splitModuleKey( module ),
1976 name = split.name,
1977 version = split.version;
1978 // Automatically register module
1979 if ( !hasOwn.call( registry, name ) ) {
1980 mw.loader.register( name );
1981 }
1982 // Check for duplicate implementation
1983 if ( hasOwn.call( registry, name ) && registry[ name ].script !== undefined ) {
1984 throw new Error( 'module already implemented: ' + name );
1985 }
1986 if ( version ) {
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;
1992 }
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 ) ) {
2002 execute( name );
2003 }
2004 }
2005 },
2006
2007 /**
2008 * Execute a function as soon as one or more required modules are ready.
2009 *
2010 * Example of inline dependency on OOjs:
2011 *
2012 * mw.loader.using( 'oojs', function () {
2013 * OO.compare( [ 1 ], [ 1 ] );
2014 * } );
2015 *
2016 * Example of inline dependency obtained via `require()`:
2017 *
2018 * mw.loader.using( [ 'mediawiki.util' ], function ( require ) {
2019 * var util = require( 'mediawiki.util' );
2020 * } );
2021 *
2022 * Since MediaWiki 1.23 this also returns a promise.
2023 *
2024 * Since MediaWiki 1.28 the promise is resolved with a `require` function.
2025 *
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
2031 */
2032 using: function ( dependencies, ready, error ) {
2033 var deferred = $.Deferred();
2034
2035 // Allow calling with a single dependency as a string
2036 if ( typeof dependencies === 'string' ) {
2037 dependencies = [ dependencies ];
2038 }
2039
2040 if ( ready ) {
2041 deferred.done( ready );
2042 }
2043 if ( error ) {
2044 deferred.fail( error );
2045 }
2046
2047 try {
2048 // Resolve entire dependency map
2049 dependencies = resolve( dependencies );
2050 } catch ( e ) {
2051 return deferred.reject( e ).promise();
2052 }
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
2058 deferred.reject(
2059 new Error( 'One or more dependencies failed to load' ),
2060 dependencies
2061 );
2062 } else {
2063 // Not all dependencies are ready, add to the load queue
2064 enqueue( dependencies, function () {
2065 deferred.resolve( mw.loader.require );
2066 }, deferred.reject );
2067 }
2068
2069 return deferred.promise();
2070 },
2071
2072 /**
2073 * Load an external script or one or more modules.
2074 *
2075 * This method takes a list of unrelated modules. Use cases:
2076 *
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.
2083 *
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.
2089 */
2090 load: function ( modules, type ) {
2091 var filtered, l;
2092
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';
2100 l.href = modules;
2101 document.head.appendChild( l );
2102 return;
2103 }
2104 if ( type === 'text/javascript' || type === undefined ) {
2105 addScript( modules );
2106 return;
2107 }
2108 // Unknown type
2109 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type );
2110 }
2111 // Called with single module
2112 modules = [ modules ];
2113 }
2114
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';
2119 } );
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 ) ) {
2125 return;
2126 }
2127 if ( filtered.length === 0 ) {
2128 return;
2129 }
2130 // Some modules are not yet ready, add to module load queue.
2131 enqueue( filtered, undefined, undefined );
2132 },
2133
2134 /**
2135 * Change the state of one or more modules.
2136 *
2137 * @param {string|Object} module Module name or object of module name/state pairs
2138 * @param {string} state State name
2139 */
2140 state: function ( module, state ) {
2141 var m;
2142
2143 if ( typeof module === 'object' ) {
2144 for ( m in module ) {
2145 mw.loader.state( m, module[ m ] );
2146 }
2147 return;
2148 }
2149 if ( !hasOwn.call( registry, module ) ) {
2150 mw.loader.register( module );
2151 }
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 );
2157 }
2158 },
2159
2160 /**
2161 * Get the version of a module.
2162 *
2163 * @param {string} module Name of module
2164 * @return {string|null} The version, or null if the module (or its version) is not
2165 * in the registry.
2166 */
2167 getVersion: function ( module ) {
2168 return hasOwn.call( registry, module ) ? registry[ module ].version : null;
2169 },
2170
2171 /**
2172 * Get the state of a module.
2173 *
2174 * @param {string} module Name of module
2175 * @return {string|null} The state, or null if the module (or its state) is not
2176 * in the registry.
2177 */
2178 getState: function ( module ) {
2179 return hasOwn.call( registry, module ) ? registry[ module ].state : null;
2180 },
2181
2182 /**
2183 * Get the names of all registered modules.
2184 *
2185 * @return {Array}
2186 */
2187 getModuleNames: function () {
2188 return Object.keys( registry );
2189 },
2190
2191 /**
2192 * Get the exported value of a module.
2193 *
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.
2197 *
2198 * In case of lazy-loaded modules via mw.loader#using(), the returned
2199 * Promise provides the function, see #using() for examples.
2200 *
2201 * @private
2202 * @since 1.27
2203 * @param {string} moduleName Module name
2204 * @return {Mixed} Exported value
2205 */
2206 require: function ( moduleName ) {
2207 var state = mw.loader.getState( moduleName );
2208
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.' );
2213 }
2214
2215 return registry[ moduleName ].module.exports;
2216 },
2217
2218 /**
2219 * @inheritdoc mw.inspect#runReports
2220 * @method
2221 */
2222 inspect: function () {
2223 var args = slice.call( arguments );
2224 mw.loader.using( 'mediawiki.inspect', function () {
2225 mw.inspect.runReports.apply( mw.inspect, args );
2226 } );
2227 },
2228
2229 /**
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.
2235 *
2236 * @singleton
2237 * @class mw.loader.store
2238 */
2239 store: {
2240 // Whether the store is in use on this page.
2241 enabled: null,
2242
2243 // Modules whose string representation exceeds 100 kB are
2244 // ineligible for storage. See bug T66721.
2245 MODULE_SIZE_MAX: 100 * 1000,
2246
2247 // The contents of the store, mapping '[name]@[version]' keys
2248 // to module implementations.
2249 items: {},
2250
2251 // Cache hit stats
2252 stats: { hits: 0, misses: 0, expired: 0, failed: 0 },
2253
2254 /**
2255 * Construct a JSON-serializable object representing the content of the store.
2256 *
2257 * @return {Object} Module store contents.
2258 */
2259 toJSON: function () {
2260 return { items: mw.loader.store.items, vary: mw.loader.store.getVary() };
2261 },
2262
2263 /**
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.
2266 *
2267 * @return {string} localStorage item key
2268 */
2269 getStoreKey: function () {
2270 return 'MediaWikiModuleStore:' + mw.config.get( 'wgDBname' );
2271 },
2272
2273 /**
2274 * Get a key on which to vary the module cache.
2275 *
2276 * @return {string} String of concatenated vary conditions.
2277 */
2278 getVary: function () {
2279 return [
2280 mw.config.get( 'skin' ),
2281 mw.config.get( 'wgResourceLoaderStorageVersion' ),
2282 mw.config.get( 'wgUserLanguage' )
2283 ].join( ':' );
2284 },
2285
2286 /**
2287 * Initialize the store.
2288 *
2289 * Retrieves store from localStorage and (if successfully retrieved) decoding
2290 * the stored JSON value to a plain object.
2291 *
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>.
2296 */
2297 init: function () {
2298 var raw, data;
2299
2300 if ( mw.loader.store.enabled !== null ) {
2301 // Init already ran
2302 return;
2303 }
2304
2305 if (
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 ) ||
2310
2311 // Disabled by configuration.
2312 !mw.config.get( 'wgResourceLoaderStorageEnabled' )
2313 ) {
2314 // Clear any previous store to free up space. (T66721)
2315 mw.loader.store.clear();
2316 mw.loader.store.enabled = false;
2317 return;
2318 }
2319 if ( mw.config.get( 'debug' ) ) {
2320 // Disable module store in debug mode
2321 mw.loader.store.enabled = false;
2322 return;
2323 }
2324
2325 try {
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;
2332 return;
2333 }
2334 } catch ( e ) {
2335 mw.track( 'resourceloader.exception', { exception: e, source: 'store-localstorage-init' } );
2336 }
2337
2338 if ( raw === undefined ) {
2339 // localStorage failed; disable store
2340 mw.loader.store.enabled = false;
2341 } else {
2342 mw.loader.store.update();
2343 }
2344 },
2345
2346 /**
2347 * Retrieve a module from the store and update cache hit stats.
2348 *
2349 * @param {string} module Module name
2350 * @return {string|boolean} Module implementation or false if unavailable
2351 */
2352 get: function ( module ) {
2353 var key;
2354
2355 if ( !mw.loader.store.enabled ) {
2356 return false;
2357 }
2358
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 ];
2363 }
2364 mw.loader.store.stats.misses++;
2365 return false;
2366 },
2367
2368 /**
2369 * Stringify a module and queue it for storage.
2370 *
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
2374 */
2375 set: function ( module, descriptor ) {
2376 var args, key, src;
2377
2378 if ( !mw.loader.store.enabled ) {
2379 return false;
2380 }
2381
2382 key = getModuleKey( module );
2383
2384 if (
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
2397 ) {
2398 // Decline to store
2399 return false;
2400 }
2401
2402 try {
2403 args = [
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 )
2411 ];
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' } );
2417 }
2418 } catch ( e ) {
2419 mw.track( 'resourceloader.exception', { exception: e, source: 'store-localstorage-json' } );
2420 return false;
2421 }
2422
2423 src = 'mw.loader.implement(' + args.join( ',' ) + ');';
2424 if ( src.length > mw.loader.store.MODULE_SIZE_MAX ) {
2425 return false;
2426 }
2427 mw.loader.store.items[ key ] = src;
2428 mw.loader.store.update();
2429 return true;
2430 },
2431
2432 /**
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.
2435 *
2436 * @return {boolean} Store was pruned
2437 */
2438 prune: function () {
2439 var key, module;
2440
2441 if ( !mw.loader.store.enabled ) {
2442 return false;
2443 }
2444
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 ];
2453 }
2454 }
2455 return true;
2456 },
2457
2458 /**
2459 * Clear the entire module store right now.
2460 */
2461 clear: function () {
2462 mw.loader.store.items = {};
2463 try {
2464 localStorage.removeItem( mw.loader.store.getStoreKey() );
2465 } catch ( ignored ) {}
2466 },
2467
2468 /**
2469 * Sync in-memory store back to localStorage.
2470 *
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.
2474 *
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.
2479 *
2480 * @method
2481 */
2482 update: ( function () {
2483 var hasPendingWrite = false;
2484
2485 function flushWrites() {
2486 var data, key;
2487 if ( !hasPendingWrite || !mw.loader.store.enabled ) {
2488 return;
2489 }
2490
2491 mw.loader.store.prune();
2492 key = mw.loader.store.getStoreKey();
2493 try {
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 );
2501 } catch ( e ) {
2502 mw.track( 'resourceloader.exception', { exception: e, source: 'store-localstorage-update' } );
2503 }
2504
2505 hasPendingWrite = false;
2506 }
2507
2508 return function () {
2509 if ( !hasPendingWrite ) {
2510 hasPendingWrite = true;
2511 mw.requestIdleCallback( flushWrites );
2512 }
2513 };
2514 }() )
2515 }
2516 };
2517 }() ),
2518
2519 /**
2520 * HTML construction helper functions
2521 *
2522 * @example
2523 *
2524 * var Html, output;
2525 *
2526 * Html = mw.html;
2527 * output = Html.element( 'div', {}, new Html.Raw(
2528 * Html.element( 'img', { src: '<' } )
2529 * ) );
2530 * mw.log( output ); // <div><img src="&lt;"/></div>
2531 *
2532 * @class mw.html
2533 * @singleton
2534 */
2535 html: ( function () {
2536 function escapeCallback( s ) {
2537 switch ( s ) {
2538 case '\'':
2539 return '&#039;';
2540 case '"':
2541 return '&quot;';
2542 case '<':
2543 return '&lt;';
2544 case '>':
2545 return '&gt;';
2546 case '&':
2547 return '&amp;';
2548 }
2549 }
2550
2551 return {
2552 /**
2553 * Escape a string for HTML.
2554 *
2555 * Converts special characters to HTML entities.
2556 *
2557 * mw.html.escape( '< > \' & "' );
2558 * // Returns &lt; &gt; &#039; &amp; &quot;
2559 *
2560 * @param {string} s The string to escape
2561 * @return {string} HTML
2562 */
2563 escape: function ( s ) {
2564 return s.replace( /['"<>&]/g, escapeCallback );
2565 },
2566
2567 /**
2568 * Create an HTML element string, with safe escaping.
2569 *
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.
2573 *
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
2581 */
2582 element: function ( name, attrs, contents ) {
2583 var v, attrName, s = '<' + name;
2584
2585 if ( attrs ) {
2586 for ( attrName in attrs ) {
2587 v = attrs[ attrName ];
2588 // Convert name=true, to name=name
2589 if ( v === true ) {
2590 v = attrName;
2591 // Skip name=false
2592 } else if ( v === false ) {
2593 continue;
2594 }
2595 s += ' ' + attrName + '="' + this.escape( String( v ) ) + '"';
2596 }
2597 }
2598 if ( contents === undefined || contents === null ) {
2599 // Self close tag
2600 s += '/>';
2601 return s;
2602 }
2603 // Regular open tag
2604 s += '>';
2605 switch ( typeof contents ) {
2606 case 'string':
2607 // Escaped
2608 s += this.escape( contents );
2609 break;
2610 case 'number':
2611 case 'boolean':
2612 // Convert to string
2613 s += String( contents );
2614 break;
2615 default:
2616 if ( contents instanceof this.Raw ) {
2617 // Raw HTML inclusion
2618 s += contents.value;
2619 } else if ( contents instanceof this.Cdata ) {
2620 // CDATA
2621 if ( /<\/[a-zA-z]/.test( contents.value ) ) {
2622 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
2623 }
2624 s += contents.value;
2625 } else {
2626 throw new Error( 'mw.html.element: Invalid type of contents' );
2627 }
2628 }
2629 s += '</' + name + '>';
2630 return s;
2631 },
2632
2633 /**
2634 * Wrapper object for raw HTML passed to mw.html.element().
2635 *
2636 * @class mw.html.Raw
2637 * @constructor
2638 * @param {string} value
2639 */
2640 Raw: function ( value ) {
2641 this.value = value;
2642 },
2643
2644 /**
2645 * Wrapper object for CDATA element contents passed to mw.html.element()
2646 *
2647 * @class mw.html.Cdata
2648 * @constructor
2649 * @param {string} value
2650 */
2651 Cdata: function ( value ) {
2652 this.value = value;
2653 }
2654 };
2655 }() ),
2656
2657 // Skeleton user object, extended by the 'mediawiki.user' module.
2658 /**
2659 * @class mw.user
2660 * @singleton
2661 */
2662 user: {
2663 /**
2664 * @property {mw.Map}
2665 */
2666 options: new Map(),
2667 /**
2668 * @property {mw.Map}
2669 */
2670 tokens: new Map()
2671 },
2672
2673 // OOUI widgets specific to MediaWiki
2674 widgets: {},
2675
2676 /**
2677 * Registry and firing of events.
2678 *
2679 * MediaWiki has various interface components that are extended, enhanced
2680 * or manipulated in some other way by extensions, gadgets and even
2681 * in core itself.
2682 *
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).
2686 *
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.
2690 *
2691 * Example usage:
2692 *
2693 * mw.hook( 'wikipage.content' ).add( fn ).remove( fn );
2694 * mw.hook( 'wikipage.content' ).fire( $content );
2695 *
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.
2701 *
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).
2706 *
2707 * var h = mw.hook( 'bar.ready' );
2708 * new mw.Foo( .. ).fetch( { callback: h.fire } );
2709 *
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.
2712 *
2713 * @class mw.hook
2714 */
2715 hook: ( function () {
2716 var lists = {};
2717
2718 /**
2719 * Create an instance of mw.hook.
2720 *
2721 * @method hook
2722 * @member mw
2723 * @param {string} name Name of hook.
2724 * @return {mw.hook}
2725 */
2726 return function ( name ) {
2727 var list = hasOwn.call( lists, name ) ?
2728 lists[ name ] :
2729 lists[ name ] = $.Callbacks( 'memory' );
2730
2731 return {
2732 /**
2733 * Register a hook handler
2734 *
2735 * @param {...Function} handler Function to bind.
2736 * @chainable
2737 */
2738 add: list.add,
2739
2740 /**
2741 * Unregister a hook handler
2742 *
2743 * @param {...Function} handler Function to unbind.
2744 * @chainable
2745 */
2746 remove: list.remove,
2747
2748 // eslint-disable-next-line valid-jsdoc
2749 /**
2750 * Run a hook.
2751 *
2752 * @param {...Mixed} data
2753 * @chainable
2754 */
2755 fire: function () {
2756 return list.fireWith.call( this, null, slice.call( arguments ) );
2757 }
2758 };
2759 };
2760 }() )
2761 };
2762
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.' );
2766
2767 /**
2768 * Log a message to window.console, if possible.
2769 *
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).
2773 *
2774 * @private
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
2780 */
2781 function logError( topic, data ) {
2782 /* eslint-disable no-console */
2783 var msg,
2784 e = data.exception,
2785 source = data.source,
2786 module = data.module,
2787 console = window.console;
2788
2789 if ( console && console.log ) {
2790 msg = ( e ? 'Exception' : 'Error' ) + ' in ' + source;
2791 if ( module ) {
2792 msg += ' in module ' + module;
2793 }
2794 msg += ( e ? ':' : '.' );
2795 console.log( msg );
2796
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 ) {
2800 console.warn( e );
2801 }
2802 }
2803 /* eslint-enable no-console */
2804 }
2805
2806 // Subscribe to error streams
2807 mw.trackSubscribe( 'resourceloader.exception', logError );
2808 mw.trackSubscribe( 'resourceloader.assert', logError );
2809
2810 /**
2811 * Fired when all modules associated with the page have finished loading.
2812 *
2813 * @event resourceloader_loadEnd
2814 * @member mw.hook
2815 */
2816 $( function () {
2817 var loading, modules;
2818
2819 modules = mw.loader.getModuleNames().filter( function ( module ) {
2820 return mw.loader.getState( module ) === 'loading';
2821 } );
2822 // We only need a callback, not any actual module. First try a single using()
2823 // for all loading modules. If one fails, fall back to tracking each module
2824 // separately via $.when(), this is expensive.
2825 loading = mw.loader.using( modules ).catch( function () {
2826 var all = modules.map( function ( module ) {
2827 return mw.loader.using( module ).catch( function () {
2828 return $.Deferred().resolve();
2829 } );
2830 } );
2831 return $.when.apply( $, all );
2832 } );
2833 loading.then( function () {
2834 if ( window.performance && performance.mark ) {
2835 performance.mark( 'mwLoadEnd' );
2836 }
2837 mw.hook( 'resourceloader.loadEnd' ).fire();
2838 } );
2839 } );
2840
2841 // Attach to window and globally alias
2842 window.mw = window.mediaWiki = mw;
2843 }( jQuery ) );