Use OO.ui.MultilineTextInputWidget
[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 = $.grep( trackHandlers, function ( fns ) {
629 if ( fns[ 1 ] === callback ) {
630 trackCallbacks.remove( fns[ 0 ] );
631 // Ensure the tuple is removed to avoid holding on to closures
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 ( $.inArray( module, resolved ) !== -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 ( $.inArray( deps[ i ], resolved ) === -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, implicitDependencies, implicitWait;
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 implicitDependencies = [];
1323
1324 if ( module === 'user' ) {
1325 // Implicit dependency on the site module. Not real dependency because
1326 // it should run after 'site' regardless of whether it succeeds or fails.
1327 implicitDependencies.push( 'site' );
1328 }
1329
1330 implicitWait = implicitDependencies.length ?
1331 mw.loader.using( implicitDependencies ) :
1332 $.Deferred().resolve();
1333
1334 implicitWait.always( function () {
1335 try {
1336 if ( Array.isArray( script ) ) {
1337 nestedAddScript( script, markModuleReady, 0 );
1338 } else if ( typeof script === 'function' ) {
1339 // Pass jQuery twice so that the signature of the closure which wraps
1340 // the script can bind both '$' and 'jQuery'.
1341 script( $, $, mw.loader.require, registry[ module ].module );
1342 markModuleReady();
1343
1344 } else if ( typeof script === 'string' ) {
1345 // Site and user modules are legacy scripts that run in the global scope.
1346 // This is transported as a string instead of a function to avoid needing
1347 // to use string manipulation to undo the function wrapper.
1348 $.globalEval( script );
1349 markModuleReady();
1350
1351 } else {
1352 // Module without script
1353 markModuleReady();
1354 }
1355 } catch ( e ) {
1356 // Use mw.track instead of mw.log because these errors are common in production mode
1357 // (e.g. undefined variable), and mw.log is only enabled in debug mode.
1358 registry[ module ].state = 'error';
1359 mw.track( 'resourceloader.exception', { exception: e, module: module, source: 'module-execute' } );
1360 handlePending( module );
1361 }
1362 } );
1363 };
1364
1365 // Add localizations to message system
1366 if ( registry[ module ].messages ) {
1367 mw.messages.set( registry[ module ].messages );
1368 }
1369
1370 // Initialise templates
1371 if ( registry[ module ].templates ) {
1372 mw.templates.set( module, registry[ module ].templates );
1373 }
1374
1375 // Make sure we don't run the scripts until all stylesheet insertions have completed.
1376 ( function () {
1377 var pending = 0;
1378 checkCssHandles = function () {
1379 // cssHandlesRegistered ensures we don't take off too soon, e.g. when
1380 // one of the cssHandles is fired while we're still creating more handles.
1381 if ( cssHandlesRegistered && pending === 0 && runScript ) {
1382 runScript();
1383 runScript = undefined; // Revoke
1384 }
1385 };
1386 cssHandle = function () {
1387 var check = checkCssHandles;
1388 pending++;
1389 return function () {
1390 if ( check ) {
1391 pending--;
1392 check();
1393 check = undefined; // Revoke
1394 }
1395 };
1396 };
1397 }() );
1398
1399 // Process styles (see also mw.loader.implement)
1400 // * back-compat: { <media>: css }
1401 // * back-compat: { <media>: [url, ..] }
1402 // * { "css": [css, ..] }
1403 // * { "url": { <media>: [url, ..] } }
1404 if ( registry[ module ].style ) {
1405 for ( key in registry[ module ].style ) {
1406 value = registry[ module ].style[ key ];
1407 media = undefined;
1408
1409 if ( key !== 'url' && key !== 'css' ) {
1410 // Backwards compatibility, key is a media-type
1411 if ( typeof value === 'string' ) {
1412 // back-compat: { <media>: css }
1413 // Ignore 'media' because it isn't supported (nor was it used).
1414 // Strings are pre-wrapped in "@media". The media-type was just ""
1415 // (because it had to be set to something).
1416 // This is one of the reasons why this format is no longer used.
1417 addEmbeddedCSS( value, cssHandle() );
1418 } else {
1419 // back-compat: { <media>: [url, ..] }
1420 media = key;
1421 key = 'bc-url';
1422 }
1423 }
1424
1425 // Array of css strings in key 'css',
1426 // or back-compat array of urls from media-type
1427 if ( Array.isArray( value ) ) {
1428 for ( i = 0; i < value.length; i++ ) {
1429 if ( key === 'bc-url' ) {
1430 // back-compat: { <media>: [url, ..] }
1431 addLink( media, value[ i ] );
1432 } else if ( key === 'css' ) {
1433 // { "css": [css, ..] }
1434 addEmbeddedCSS( value[ i ], cssHandle() );
1435 }
1436 }
1437 // Not an array, but a regular object
1438 // Array of urls inside media-type key
1439 } else if ( typeof value === 'object' ) {
1440 // { "url": { <media>: [url, ..] } }
1441 for ( media in value ) {
1442 urls = value[ media ];
1443 for ( i = 0; i < urls.length; i++ ) {
1444 addLink( media, urls[ i ] );
1445 }
1446 }
1447 }
1448 }
1449 }
1450
1451 // Kick off.
1452 cssHandlesRegistered = true;
1453 checkCssHandles();
1454 }
1455
1456 /**
1457 * Add one or more modules to the module load queue.
1458 *
1459 * See also #work().
1460 *
1461 * @private
1462 * @param {string|string[]} dependencies Module name or array of string module names
1463 * @param {Function} [ready] Callback to execute when all dependencies are ready
1464 * @param {Function} [error] Callback to execute when any dependency fails
1465 */
1466 function enqueue( dependencies, ready, error ) {
1467 // Allow calling by single module name
1468 if ( typeof dependencies === 'string' ) {
1469 dependencies = [ dependencies ];
1470 }
1471
1472 // Add ready and error callbacks if they were given
1473 if ( ready !== undefined || error !== undefined ) {
1474 jobs.push( {
1475 // Narrow down the list to modules that are worth waiting for
1476 dependencies: $.grep( dependencies, function ( module ) {
1477 var state = mw.loader.getState( module );
1478 return state === 'registered' || state === 'loaded' || state === 'loading' || state === 'executing';
1479 } ),
1480 ready: ready,
1481 error: error
1482 } );
1483 }
1484
1485 $.each( dependencies, function ( idx, module ) {
1486 var state = mw.loader.getState( module );
1487 // Only queue modules that are still in the initial 'registered' state
1488 // (not ones already loading, ready or error).
1489 if ( state === 'registered' && $.inArray( module, queue ) === -1 ) {
1490 // Private modules must be embedded in the page. Don't bother queuing
1491 // these as the server will deny them anyway (T101806).
1492 if ( registry[ module ].group === 'private' ) {
1493 registry[ module ].state = 'error';
1494 handlePending( module );
1495 return;
1496 }
1497 queue.push( module );
1498 }
1499 } );
1500
1501 mw.loader.work();
1502 }
1503
1504 function sortQuery( o ) {
1505 var key,
1506 sorted = {},
1507 a = [];
1508
1509 for ( key in o ) {
1510 if ( hasOwn.call( o, key ) ) {
1511 a.push( key );
1512 }
1513 }
1514 a.sort();
1515 for ( key = 0; key < a.length; key++ ) {
1516 sorted[ a[ key ] ] = o[ a[ key ] ];
1517 }
1518 return sorted;
1519 }
1520
1521 /**
1522 * Converts a module map of the form { foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }
1523 * to a query string of the form foo.bar,baz|bar.baz,quux
1524 *
1525 * @private
1526 * @param {Object} moduleMap Module map
1527 * @return {string} Module query string
1528 */
1529 function buildModulesString( moduleMap ) {
1530 var p, prefix,
1531 arr = [];
1532
1533 for ( prefix in moduleMap ) {
1534 p = prefix === '' ? '' : prefix + '.';
1535 arr.push( p + moduleMap[ prefix ].join( ',' ) );
1536 }
1537 return arr.join( '|' );
1538 }
1539
1540 /**
1541 * Make a network request to load modules from the server.
1542 *
1543 * @private
1544 * @param {Object} moduleMap Module map, see #buildModulesString
1545 * @param {Object} currReqBase Object with other parameters (other than 'modules') to use in the request
1546 * @param {string} sourceLoadScript URL of load.php
1547 */
1548 function doRequest( moduleMap, currReqBase, sourceLoadScript ) {
1549 var query = $.extend(
1550 { modules: buildModulesString( moduleMap ) },
1551 currReqBase
1552 );
1553 query = sortQuery( query );
1554 addScript( sourceLoadScript + '?' + $.param( query ) );
1555 }
1556
1557 /**
1558 * Resolve indexed dependencies.
1559 *
1560 * ResourceLoader uses an optimization to save space which replaces module names in
1561 * dependency lists with the index of that module within the array of module
1562 * registration data if it exists. The benefit is a significant reduction in the data
1563 * size of the startup module. This function changes those dependency lists back to
1564 * arrays of strings.
1565 *
1566 * @private
1567 * @param {Array} modules Modules array
1568 */
1569 function resolveIndexedDependencies( modules ) {
1570 var i, j, deps;
1571 function resolveIndex( dep ) {
1572 return typeof dep === 'number' ? modules[ dep ][ 0 ] : dep;
1573 }
1574 for ( i = 0; i < modules.length; i++ ) {
1575 deps = modules[ i ][ 2 ];
1576 if ( deps ) {
1577 for ( j = 0; j < deps.length; j++ ) {
1578 deps[ j ] = resolveIndex( deps[ j ] );
1579 }
1580 }
1581 }
1582 }
1583
1584 /**
1585 * Create network requests for a batch of modules.
1586 *
1587 * This is an internal method for #work(). This must not be called directly
1588 * unless the modules are already registered, and no request is in progress,
1589 * and the module state has already been set to `loading`.
1590 *
1591 * @private
1592 * @param {string[]} batch
1593 */
1594 function batchRequest( batch ) {
1595 var reqBase, splits, maxQueryLength, b, bSource, bGroup, bSourceGroup,
1596 source, group, i, modules, sourceLoadScript,
1597 currReqBase, currReqBaseLength, moduleMap, l,
1598 lastDotIndex, prefix, suffix, bytesAdded;
1599
1600 if ( !batch.length ) {
1601 return;
1602 }
1603
1604 // Always order modules alphabetically to help reduce cache
1605 // misses for otherwise identical content.
1606 batch.sort();
1607
1608 // Build a list of query parameters common to all requests
1609 reqBase = {
1610 skin: mw.config.get( 'skin' ),
1611 lang: mw.config.get( 'wgUserLanguage' ),
1612 debug: mw.config.get( 'debug' )
1613 };
1614 maxQueryLength = mw.config.get( 'wgResourceLoaderMaxQueryLength', 2000 );
1615
1616 // Split module list by source and by group.
1617 splits = {};
1618 for ( b = 0; b < batch.length; b++ ) {
1619 bSource = registry[ batch[ b ] ].source;
1620 bGroup = registry[ batch[ b ] ].group;
1621 if ( !hasOwn.call( splits, bSource ) ) {
1622 splits[ bSource ] = {};
1623 }
1624 if ( !hasOwn.call( splits[ bSource ], bGroup ) ) {
1625 splits[ bSource ][ bGroup ] = [];
1626 }
1627 bSourceGroup = splits[ bSource ][ bGroup ];
1628 bSourceGroup.push( batch[ b ] );
1629 }
1630
1631 for ( source in splits ) {
1632
1633 sourceLoadScript = sources[ source ];
1634
1635 for ( group in splits[ source ] ) {
1636
1637 // Cache access to currently selected list of
1638 // modules for this group from this source.
1639 modules = splits[ source ][ group ];
1640
1641 currReqBase = $.extend( {
1642 version: getCombinedVersion( modules )
1643 }, reqBase );
1644 // For user modules append a user name to the query string.
1645 if ( group === 'user' && mw.config.get( 'wgUserName' ) !== null ) {
1646 currReqBase.user = mw.config.get( 'wgUserName' );
1647 }
1648 currReqBaseLength = $.param( currReqBase ).length;
1649 // We may need to split up the request to honor the query string length limit,
1650 // so build it piece by piece.
1651 l = currReqBaseLength + 9; // '&modules='.length == 9
1652
1653 moduleMap = {}; // { prefix: [ suffixes ] }
1654
1655 for ( i = 0; i < modules.length; i++ ) {
1656 // Determine how many bytes this module would add to the query string
1657 lastDotIndex = modules[ i ].lastIndexOf( '.' );
1658
1659 // If lastDotIndex is -1, substr() returns an empty string
1660 prefix = modules[ i ].substr( 0, lastDotIndex );
1661 suffix = modules[ i ].slice( lastDotIndex + 1 );
1662
1663 bytesAdded = hasOwn.call( moduleMap, prefix ) ?
1664 suffix.length + 3 : // '%2C'.length == 3
1665 modules[ i ].length + 3; // '%7C'.length == 3
1666
1667 // If the url would become too long, create a new one,
1668 // but don't create empty requests
1669 if ( maxQueryLength > 0 && !$.isEmptyObject( moduleMap ) && l + bytesAdded > maxQueryLength ) {
1670 // This url would become too long, create a new one, and start the old one
1671 doRequest( moduleMap, currReqBase, sourceLoadScript );
1672 moduleMap = {};
1673 l = currReqBaseLength + 9;
1674 mw.track( 'resourceloader.splitRequest', { maxQueryLength: maxQueryLength } );
1675 }
1676 if ( !hasOwn.call( moduleMap, prefix ) ) {
1677 moduleMap[ prefix ] = [];
1678 }
1679 moduleMap[ prefix ].push( suffix );
1680 l += bytesAdded;
1681 }
1682 // If there's anything left in moduleMap, request that too
1683 if ( !$.isEmptyObject( moduleMap ) ) {
1684 doRequest( moduleMap, currReqBase, sourceLoadScript );
1685 }
1686 }
1687 }
1688 }
1689
1690 /**
1691 * @private
1692 * @param {string[]} implementations Array containing pieces of JavaScript code in the
1693 * form of calls to mw.loader#implement().
1694 * @param {Function} cb Callback in case of failure
1695 * @param {Error} cb.err
1696 */
1697 function asyncEval( implementations, cb ) {
1698 if ( !implementations.length ) {
1699 return;
1700 }
1701 mw.requestIdleCallback( function () {
1702 try {
1703 $.globalEval( implementations.join( ';' ) );
1704 } catch ( err ) {
1705 cb( err );
1706 }
1707 } );
1708 }
1709
1710 /**
1711 * Make a versioned key for a specific module.
1712 *
1713 * @private
1714 * @param {string} module Module name
1715 * @return {string|null} Module key in format '`[name]@[version]`',
1716 * or null if the module does not exist
1717 */
1718 function getModuleKey( module ) {
1719 return hasOwn.call( registry, module ) ?
1720 ( module + '@' + registry[ module ].version ) : null;
1721 }
1722
1723 /**
1724 * @private
1725 * @param {string} key Module name or '`[name]@[version]`'
1726 * @return {Object}
1727 */
1728 function splitModuleKey( key ) {
1729 var index = key.indexOf( '@' );
1730 if ( index === -1 ) {
1731 return { name: key };
1732 }
1733 return {
1734 name: key.slice( 0, index ),
1735 version: key.slice( index + 1 )
1736 };
1737 }
1738
1739 /* Public Members */
1740 return {
1741 /**
1742 * The module registry is exposed as an aid for debugging and inspecting page
1743 * state; it is not a public interface for modifying the registry.
1744 *
1745 * @see #registry
1746 * @property
1747 * @private
1748 */
1749 moduleRegistry: registry,
1750
1751 /**
1752 * @inheritdoc #newStyleTag
1753 * @method
1754 */
1755 addStyleTag: newStyleTag,
1756
1757 /**
1758 * Start loading of all queued module dependencies.
1759 *
1760 * @protected
1761 */
1762 work: function () {
1763 var q, batch, implementations, sourceModules;
1764
1765 batch = [];
1766
1767 // Appends a list of modules from the queue to the batch
1768 for ( q = 0; q < queue.length; q++ ) {
1769 // Only load modules which are registered
1770 if ( hasOwn.call( registry, queue[ q ] ) && registry[ queue[ q ] ].state === 'registered' ) {
1771 // Prevent duplicate entries
1772 if ( $.inArray( queue[ q ], batch ) === -1 ) {
1773 batch.push( queue[ q ] );
1774 // Mark registered modules as loading
1775 registry[ queue[ q ] ].state = 'loading';
1776 }
1777 }
1778 }
1779
1780 // Now that the queue has been processed into a batch, clear the queue.
1781 // This MUST happen before we initiate any eval or network request. Otherwise,
1782 // it is possible for a cached script to instantly trigger the same work queue
1783 // again; all before we've cleared it causing each request to include modules
1784 // which are already loaded.
1785 queue = [];
1786
1787 if ( !batch.length ) {
1788 return;
1789 }
1790
1791 mw.loader.store.init();
1792 if ( mw.loader.store.enabled ) {
1793 implementations = [];
1794 sourceModules = [];
1795 batch = $.grep( batch, function ( module ) {
1796 var implementation = mw.loader.store.get( module );
1797 if ( implementation ) {
1798 implementations.push( implementation );
1799 sourceModules.push( module );
1800 return false;
1801 }
1802 return true;
1803 } );
1804 asyncEval( implementations, function ( err ) {
1805 var failed;
1806 // Not good, the cached mw.loader.implement calls failed! This should
1807 // never happen, barring ResourceLoader bugs, browser bugs and PEBKACs.
1808 // Depending on how corrupt the string is, it is likely that some
1809 // modules' implement() succeeded while the ones after the error will
1810 // never run and leave their modules in the 'loading' state forever.
1811 mw.loader.store.stats.failed++;
1812
1813 // Since this is an error not caused by an individual module but by
1814 // something that infected the implement call itself, don't take any
1815 // risks and clear everything in this cache.
1816 mw.loader.store.clear();
1817
1818 mw.track( 'resourceloader.exception', { exception: err, source: 'store-eval' } );
1819 // Re-add the failed ones that are still pending back to the batch
1820 failed = $.grep( sourceModules, function ( module ) {
1821 return registry[ module ].state === 'loading';
1822 } );
1823 batchRequest( failed );
1824 } );
1825 }
1826
1827 batchRequest( batch );
1828 },
1829
1830 /**
1831 * Register a source.
1832 *
1833 * The #work() method will use this information to split up requests by source.
1834 *
1835 * mw.loader.addSource( 'mediawikiwiki', '//www.mediawiki.org/w/load.php' );
1836 *
1837 * @param {string|Object} id Source ID, or object mapping ids to load urls
1838 * @param {string} loadUrl Url to a load.php end point
1839 * @throws {Error} If source id is already registered
1840 */
1841 addSource: function ( id, loadUrl ) {
1842 var source;
1843 // Allow multiple additions
1844 if ( typeof id === 'object' ) {
1845 for ( source in id ) {
1846 mw.loader.addSource( source, id[ source ] );
1847 }
1848 return;
1849 }
1850
1851 if ( hasOwn.call( sources, id ) ) {
1852 throw new Error( 'source already registered: ' + id );
1853 }
1854
1855 sources[ id ] = loadUrl;
1856 },
1857
1858 /**
1859 * Register a module, letting the system know about it and its properties.
1860 *
1861 * The startup modules contain calls to this method.
1862 *
1863 * When using multiple module registration by passing an array, dependencies that
1864 * are specified as references to modules within the array will be resolved before
1865 * the modules are registered.
1866 *
1867 * @param {string|Array} module Module name or array of arrays, each containing
1868 * a list of arguments compatible with this method
1869 * @param {string|number} version Module version hash (falls backs to empty string)
1870 * Can also be a number (timestamp) for compatibility with MediaWiki 1.25 and earlier.
1871 * @param {string|Array|Function} dependencies One string or array of strings of module
1872 * names on which this module depends, or a function that returns that array.
1873 * @param {string} [group=null] Group which the module is in
1874 * @param {string} [source='local'] Name of the source
1875 * @param {string} [skip=null] Script body of the skip function
1876 */
1877 register: function ( module, version, dependencies, group, source, skip ) {
1878 var i, deps;
1879 // Allow multiple registration
1880 if ( typeof module === 'object' ) {
1881 resolveIndexedDependencies( module );
1882 for ( i = 0; i < module.length; i++ ) {
1883 // module is an array of module names
1884 if ( typeof module[ i ] === 'string' ) {
1885 mw.loader.register( module[ i ] );
1886 // module is an array of arrays
1887 } else if ( typeof module[ i ] === 'object' ) {
1888 mw.loader.register.apply( mw.loader, module[ i ] );
1889 }
1890 }
1891 return;
1892 }
1893 if ( hasOwn.call( registry, module ) ) {
1894 throw new Error( 'module already registered: ' + module );
1895 }
1896 if ( typeof dependencies === 'string' ) {
1897 // A single module name
1898 deps = [ dependencies ];
1899 } else if ( typeof dependencies === 'object' || typeof dependencies === 'function' ) {
1900 // Array of module names or a function that returns an array
1901 deps = dependencies;
1902 }
1903 // List the module as registered
1904 registry[ module ] = {
1905 // Exposed to execute() for mw.loader.implement() closures.
1906 // Import happens via require().
1907 module: {
1908 exports: {}
1909 },
1910 version: version !== undefined ? String( version ) : '',
1911 dependencies: deps || [],
1912 group: typeof group === 'string' ? group : null,
1913 source: typeof source === 'string' ? source : 'local',
1914 state: 'registered',
1915 skip: typeof skip === 'string' ? skip : null
1916 };
1917 },
1918
1919 /**
1920 * Implement a module given the components that make up the module.
1921 *
1922 * When #load() or #using() requests one or more modules, the server
1923 * response contain calls to this function.
1924 *
1925 * @param {string} module Name of module and current module version. Formatted
1926 * as '`[name]@[version]`". This version should match the requested version
1927 * (from #batchRequest and #registry). This avoids race conditions (T117587).
1928 * For back-compat with MediaWiki 1.27 and earlier, the version may be omitted.
1929 * @param {Function|Array|string} [script] Function with module code, list of URLs
1930 * to load via `<script src>`, or string of module code for `$.globalEval()`.
1931 * @param {Object} [style] Should follow one of the following patterns:
1932 *
1933 * { "css": [css, ..] }
1934 * { "url": { <media>: [url, ..] } }
1935 *
1936 * And for backwards compatibility (needs to be supported forever due to caching):
1937 *
1938 * { <media>: css }
1939 * { <media>: [url, ..] }
1940 *
1941 * The reason css strings are not concatenated anymore is T33676. We now check
1942 * whether it's safe to extend the stylesheet.
1943 *
1944 * @protected
1945 * @param {Object} [messages] List of key/value pairs to be added to mw#messages.
1946 * @param {Object} [templates] List of key/value pairs to be added to mw#templates.
1947 */
1948 implement: function ( module, script, style, messages, templates ) {
1949 var split = splitModuleKey( module ),
1950 name = split.name,
1951 version = split.version;
1952 // Automatically register module
1953 if ( !hasOwn.call( registry, name ) ) {
1954 mw.loader.register( name );
1955 }
1956 // Check for duplicate implementation
1957 if ( hasOwn.call( registry, name ) && registry[ name ].script !== undefined ) {
1958 throw new Error( 'module already implemented: ' + name );
1959 }
1960 if ( version ) {
1961 // Without this reset, if there is a version mismatch between the
1962 // requested and received module version, then mw.loader.store would
1963 // cache the response under the requested key. Thus poisoning the cache
1964 // indefinitely with a stale value. (T117587)
1965 registry[ name ].version = version;
1966 }
1967 // Attach components
1968 registry[ name ].script = script || null;
1969 registry[ name ].style = style || null;
1970 registry[ name ].messages = messages || null;
1971 registry[ name ].templates = templates || null;
1972 // The module may already have been marked as erroneous
1973 if ( $.inArray( registry[ name ].state, [ 'error', 'missing' ] ) === -1 ) {
1974 registry[ name ].state = 'loaded';
1975 if ( allReady( registry[ name ].dependencies ) ) {
1976 execute( name );
1977 }
1978 }
1979 },
1980
1981 /**
1982 * Execute a function as soon as one or more required modules are ready.
1983 *
1984 * Example of inline dependency on OOjs:
1985 *
1986 * mw.loader.using( 'oojs', function () {
1987 * OO.compare( [ 1 ], [ 1 ] );
1988 * } );
1989 *
1990 * Since MediaWiki 1.23 this also returns a promise.
1991 *
1992 * Since MediaWiki 1.28 the promise is resolved with a `require` function.
1993 *
1994 * @param {string|Array} dependencies Module name or array of modules names the
1995 * callback depends on to be ready before executing
1996 * @param {Function} [ready] Callback to execute when all dependencies are ready
1997 * @param {Function} [error] Callback to execute if one or more dependencies failed
1998 * @return {jQuery.Promise} With a `require` function
1999 */
2000 using: function ( dependencies, ready, error ) {
2001 var deferred = $.Deferred();
2002
2003 // Allow calling with a single dependency as a string
2004 if ( typeof dependencies === 'string' ) {
2005 dependencies = [ dependencies ];
2006 }
2007
2008 if ( ready ) {
2009 deferred.done( ready );
2010 }
2011 if ( error ) {
2012 deferred.fail( error );
2013 }
2014
2015 try {
2016 // Resolve entire dependency map
2017 dependencies = resolve( dependencies );
2018 } catch ( e ) {
2019 return deferred.reject( e ).promise();
2020 }
2021 if ( allReady( dependencies ) ) {
2022 // Run ready immediately
2023 deferred.resolve( mw.loader.require );
2024 } else if ( anyFailed( dependencies ) ) {
2025 // Execute error immediately if any dependencies have errors
2026 deferred.reject(
2027 new Error( 'One or more dependencies failed to load' ),
2028 dependencies
2029 );
2030 } else {
2031 // Not all dependencies are ready, add to the load queue
2032 enqueue( dependencies, function () {
2033 deferred.resolve( mw.loader.require );
2034 }, deferred.reject );
2035 }
2036
2037 return deferred.promise();
2038 },
2039
2040 /**
2041 * Load an external script or one or more modules.
2042 *
2043 * This method takes a list of unrelated modules. Use cases:
2044 *
2045 * - A web page will be composed of many different widgets. These widgets independently
2046 * queue their ResourceLoader modules (`OutputPage::addModules()`). If any of them
2047 * have problems, or are no longer known (e.g. cached HTML), the other modules
2048 * should still be loaded.
2049 * - This method is used for preloading, which must not throw. Later code that
2050 * calls #using() will handle the error.
2051 *
2052 * @param {string|Array} modules Either the name of a module, array of modules,
2053 * or a URL of an external script or style
2054 * @param {string} [type='text/javascript'] MIME type to use if calling with a URL of an
2055 * external script or style; acceptable values are "text/css" and
2056 * "text/javascript"; if no type is provided, text/javascript is assumed.
2057 */
2058 load: function ( modules, type ) {
2059 var filtered, l;
2060
2061 // Allow calling with a url or single dependency as a string
2062 if ( typeof modules === 'string' ) {
2063 // "https://example.org/x.js", "http://example.org/x.js", "//example.org/x.js", "/x.js"
2064 if ( /^(https?:)?\/?\//.test( modules ) ) {
2065 if ( type === 'text/css' ) {
2066 l = document.createElement( 'link' );
2067 l.rel = 'stylesheet';
2068 l.href = modules;
2069 $( 'head' ).append( l );
2070 return;
2071 }
2072 if ( type === 'text/javascript' || type === undefined ) {
2073 addScript( modules );
2074 return;
2075 }
2076 // Unknown type
2077 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type );
2078 }
2079 // Called with single module
2080 modules = [ modules ];
2081 }
2082
2083 // Filter out top-level modules that are unknown or failed to load before.
2084 filtered = $.grep( modules, function ( module ) {
2085 var state = mw.loader.getState( module );
2086 return state !== null && state !== 'error' && state !== 'missing';
2087 } );
2088 // Resolve remaining list using the known dependency tree.
2089 // This also filters out modules with unknown dependencies. (T36853)
2090 filtered = resolveStubbornly( filtered );
2091 // If all modules are ready, or if any modules have errors, nothing to be done.
2092 if ( allReady( filtered ) || anyFailed( filtered ) ) {
2093 return;
2094 }
2095 if ( filtered.length === 0 ) {
2096 return;
2097 }
2098 // Some modules are not yet ready, add to module load queue.
2099 enqueue( filtered, undefined, undefined );
2100 },
2101
2102 /**
2103 * Change the state of one or more modules.
2104 *
2105 * @param {string|Object} module Module name or object of module name/state pairs
2106 * @param {string} state State name
2107 */
2108 state: function ( module, state ) {
2109 var m;
2110
2111 if ( typeof module === 'object' ) {
2112 for ( m in module ) {
2113 mw.loader.state( m, module[ m ] );
2114 }
2115 return;
2116 }
2117 if ( !hasOwn.call( registry, module ) ) {
2118 mw.loader.register( module );
2119 }
2120 registry[ module ].state = state;
2121 if ( $.inArray( state, [ 'ready', 'error', 'missing' ] ) !== -1 ) {
2122 // Make sure pending modules depending on this one get executed if their
2123 // dependencies are now fulfilled!
2124 handlePending( module );
2125 }
2126 },
2127
2128 /**
2129 * Get the version of a module.
2130 *
2131 * @param {string} module Name of module
2132 * @return {string|null} The version, or null if the module (or its version) is not
2133 * in the registry.
2134 */
2135 getVersion: function ( module ) {
2136 if ( !hasOwn.call( registry, module ) || registry[ module ].version === undefined ) {
2137 return null;
2138 }
2139 return registry[ module ].version;
2140 },
2141
2142 /**
2143 * Get the state of a module.
2144 *
2145 * @param {string} module Name of module
2146 * @return {string|null} The state, or null if the module (or its state) is not
2147 * in the registry.
2148 */
2149 getState: function ( module ) {
2150 if ( !hasOwn.call( registry, module ) || registry[ module ].state === undefined ) {
2151 return null;
2152 }
2153 return registry[ module ].state;
2154 },
2155
2156 /**
2157 * Get the names of all registered modules.
2158 *
2159 * @return {Array}
2160 */
2161 getModuleNames: function () {
2162 return Object.keys( registry );
2163 },
2164
2165 /**
2166 * Get the exported value of a module.
2167 *
2168 * Modules may provide this via their local `module.exports`.
2169 *
2170 * @protected
2171 * @since 1.27
2172 * @param {string} moduleName Module name
2173 * @return {Mixed} Exported value
2174 */
2175 require: function ( moduleName ) {
2176 var state = mw.loader.getState( moduleName );
2177
2178 // Only ready modules can be required
2179 if ( state !== 'ready' ) {
2180 // Module may've forgotten to declare a dependency
2181 throw new Error( 'Module "' + moduleName + '" is not loaded.' );
2182 }
2183
2184 return registry[ moduleName ].module.exports;
2185 },
2186
2187 /**
2188 * @inheritdoc mw.inspect#runReports
2189 * @method
2190 */
2191 inspect: function () {
2192 var args = slice.call( arguments );
2193 mw.loader.using( 'mediawiki.inspect', function () {
2194 mw.inspect.runReports.apply( mw.inspect, args );
2195 } );
2196 },
2197
2198 /**
2199 * On browsers that implement the localStorage API, the module store serves as a
2200 * smart complement to the browser cache. Unlike the browser cache, the module store
2201 * can slice a concatenated response from ResourceLoader into its constituent
2202 * modules and cache each of them separately, using each module's versioning scheme
2203 * to determine when the cache should be invalidated.
2204 *
2205 * @singleton
2206 * @class mw.loader.store
2207 */
2208 store: {
2209 // Whether the store is in use on this page.
2210 enabled: null,
2211
2212 // Modules whose string representation exceeds 100 kB are
2213 // ineligible for storage. See bug T66721.
2214 MODULE_SIZE_MAX: 100 * 1000,
2215
2216 // The contents of the store, mapping '[name]@[version]' keys
2217 // to module implementations.
2218 items: {},
2219
2220 // Cache hit stats
2221 stats: { hits: 0, misses: 0, expired: 0, failed: 0 },
2222
2223 /**
2224 * Construct a JSON-serializable object representing the content of the store.
2225 *
2226 * @return {Object} Module store contents.
2227 */
2228 toJSON: function () {
2229 return { items: mw.loader.store.items, vary: mw.loader.store.getVary() };
2230 },
2231
2232 /**
2233 * Get the localStorage key for the entire module store. The key references
2234 * $wgDBname to prevent clashes between wikis which share a common host.
2235 *
2236 * @return {string} localStorage item key
2237 */
2238 getStoreKey: function () {
2239 return 'MediaWikiModuleStore:' + mw.config.get( 'wgDBname' );
2240 },
2241
2242 /**
2243 * Get a key on which to vary the module cache.
2244 *
2245 * @return {string} String of concatenated vary conditions.
2246 */
2247 getVary: function () {
2248 return [
2249 mw.config.get( 'skin' ),
2250 mw.config.get( 'wgResourceLoaderStorageVersion' ),
2251 mw.config.get( 'wgUserLanguage' )
2252 ].join( ':' );
2253 },
2254
2255 /**
2256 * Initialize the store.
2257 *
2258 * Retrieves store from localStorage and (if successfully retrieved) decoding
2259 * the stored JSON value to a plain object.
2260 *
2261 * The try / catch block is used for JSON & localStorage feature detection.
2262 * See the in-line documentation for Modernizr's localStorage feature detection
2263 * code for a full account of why we need a try / catch:
2264 * <https://github.com/Modernizr/Modernizr/blob/v2.7.1/modernizr.js#L771-L796>.
2265 */
2266 init: function () {
2267 var raw, data;
2268
2269 if ( mw.loader.store.enabled !== null ) {
2270 // Init already ran
2271 return;
2272 }
2273
2274 if (
2275 // Disabled because localStorage quotas are tight and (in Firefox's case)
2276 // shared by multiple origins.
2277 // See T66721, and <https://bugzilla.mozilla.org/show_bug.cgi?id=1064466>.
2278 /Firefox|Opera/.test( navigator.userAgent ) ||
2279
2280 // Disabled by configuration.
2281 !mw.config.get( 'wgResourceLoaderStorageEnabled' )
2282 ) {
2283 // Clear any previous store to free up space. (T66721)
2284 mw.loader.store.clear();
2285 mw.loader.store.enabled = false;
2286 return;
2287 }
2288 if ( mw.config.get( 'debug' ) ) {
2289 // Disable module store in debug mode
2290 mw.loader.store.enabled = false;
2291 return;
2292 }
2293
2294 try {
2295 raw = localStorage.getItem( mw.loader.store.getStoreKey() );
2296 // If we get here, localStorage is available; mark enabled
2297 mw.loader.store.enabled = true;
2298 data = JSON.parse( raw );
2299 if ( data && typeof data.items === 'object' && data.vary === mw.loader.store.getVary() ) {
2300 mw.loader.store.items = data.items;
2301 return;
2302 }
2303 } catch ( e ) {
2304 mw.track( 'resourceloader.exception', { exception: e, source: 'store-localstorage-init' } );
2305 }
2306
2307 if ( raw === undefined ) {
2308 // localStorage failed; disable store
2309 mw.loader.store.enabled = false;
2310 } else {
2311 mw.loader.store.update();
2312 }
2313 },
2314
2315 /**
2316 * Retrieve a module from the store and update cache hit stats.
2317 *
2318 * @param {string} module Module name
2319 * @return {string|boolean} Module implementation or false if unavailable
2320 */
2321 get: function ( module ) {
2322 var key;
2323
2324 if ( !mw.loader.store.enabled ) {
2325 return false;
2326 }
2327
2328 key = getModuleKey( module );
2329 if ( key in mw.loader.store.items ) {
2330 mw.loader.store.stats.hits++;
2331 return mw.loader.store.items[ key ];
2332 }
2333 mw.loader.store.stats.misses++;
2334 return false;
2335 },
2336
2337 /**
2338 * Stringify a module and queue it for storage.
2339 *
2340 * @param {string} module Module name
2341 * @param {Object} descriptor The module's descriptor as set in the registry
2342 * @return {boolean} Module was set
2343 */
2344 set: function ( module, descriptor ) {
2345 var args, key, src;
2346
2347 if ( !mw.loader.store.enabled ) {
2348 return false;
2349 }
2350
2351 key = getModuleKey( module );
2352
2353 if (
2354 // Already stored a copy of this exact version
2355 key in mw.loader.store.items ||
2356 // Module failed to load
2357 descriptor.state !== 'ready' ||
2358 // Unversioned, private, or site-/user-specific
2359 ( !descriptor.version || $.inArray( descriptor.group, [ 'private', 'user' ] ) !== -1 ) ||
2360 // Partial descriptor
2361 // (e.g. skipped module, or style module with state=ready)
2362 $.inArray( undefined, [ descriptor.script, descriptor.style,
2363 descriptor.messages, descriptor.templates ] ) !== -1
2364 ) {
2365 // Decline to store
2366 return false;
2367 }
2368
2369 try {
2370 args = [
2371 JSON.stringify( key ),
2372 typeof descriptor.script === 'function' ?
2373 String( descriptor.script ) :
2374 JSON.stringify( descriptor.script ),
2375 JSON.stringify( descriptor.style ),
2376 JSON.stringify( descriptor.messages ),
2377 JSON.stringify( descriptor.templates )
2378 ];
2379 // Attempted workaround for a possible Opera bug (bug T59567).
2380 // This regex should never match under sane conditions.
2381 if ( /^\s*\(/.test( args[ 1 ] ) ) {
2382 args[ 1 ] = 'function' + args[ 1 ];
2383 mw.track( 'resourceloader.assert', { source: 'bug-T59567' } );
2384 }
2385 } catch ( e ) {
2386 mw.track( 'resourceloader.exception', { exception: e, source: 'store-localstorage-json' } );
2387 return false;
2388 }
2389
2390 src = 'mw.loader.implement(' + args.join( ',' ) + ');';
2391 if ( src.length > mw.loader.store.MODULE_SIZE_MAX ) {
2392 return false;
2393 }
2394 mw.loader.store.items[ key ] = src;
2395 mw.loader.store.update();
2396 return true;
2397 },
2398
2399 /**
2400 * Iterate through the module store, removing any item that does not correspond
2401 * (in name and version) to an item in the module registry.
2402 *
2403 * @return {boolean} Store was pruned
2404 */
2405 prune: function () {
2406 var key, module;
2407
2408 if ( !mw.loader.store.enabled ) {
2409 return false;
2410 }
2411
2412 for ( key in mw.loader.store.items ) {
2413 module = key.slice( 0, key.indexOf( '@' ) );
2414 if ( getModuleKey( module ) !== key ) {
2415 mw.loader.store.stats.expired++;
2416 delete mw.loader.store.items[ key ];
2417 } else if ( mw.loader.store.items[ key ].length > mw.loader.store.MODULE_SIZE_MAX ) {
2418 // This value predates the enforcement of a size limit on cached modules.
2419 delete mw.loader.store.items[ key ];
2420 }
2421 }
2422 return true;
2423 },
2424
2425 /**
2426 * Clear the entire module store right now.
2427 */
2428 clear: function () {
2429 mw.loader.store.items = {};
2430 try {
2431 localStorage.removeItem( mw.loader.store.getStoreKey() );
2432 } catch ( ignored ) {}
2433 },
2434
2435 /**
2436 * Sync in-memory store back to localStorage.
2437 *
2438 * This function debounces updates. When called with a flush already pending,
2439 * the call is coalesced into the pending update. The call to
2440 * localStorage.setItem will be naturally deferred until the page is quiescent.
2441 *
2442 * Because localStorage is shared by all pages from the same origin, if multiple
2443 * pages are loaded with different module sets, the possibility exists that
2444 * modules saved by one page will be clobbered by another. But the impact would
2445 * be minor and the problem would be corrected by subsequent page views.
2446 *
2447 * @method
2448 */
2449 update: ( function () {
2450 var hasPendingWrite = false;
2451
2452 function flushWrites() {
2453 var data, key;
2454 if ( !hasPendingWrite || !mw.loader.store.enabled ) {
2455 return;
2456 }
2457
2458 mw.loader.store.prune();
2459 key = mw.loader.store.getStoreKey();
2460 try {
2461 // Replacing the content of the module store might fail if the new
2462 // contents would exceed the browser's localStorage size limit. To
2463 // avoid clogging the browser with stale data, always remove the old
2464 // value before attempting to set the new one.
2465 localStorage.removeItem( key );
2466 data = JSON.stringify( mw.loader.store );
2467 localStorage.setItem( key, data );
2468 } catch ( e ) {
2469 mw.track( 'resourceloader.exception', { exception: e, source: 'store-localstorage-update' } );
2470 }
2471
2472 hasPendingWrite = false;
2473 }
2474
2475 return function () {
2476 if ( !hasPendingWrite ) {
2477 hasPendingWrite = true;
2478 mw.requestIdleCallback( flushWrites );
2479 }
2480 };
2481 }() )
2482 }
2483 };
2484 }() ),
2485
2486 /**
2487 * HTML construction helper functions
2488 *
2489 * @example
2490 *
2491 * var Html, output;
2492 *
2493 * Html = mw.html;
2494 * output = Html.element( 'div', {}, new Html.Raw(
2495 * Html.element( 'img', { src: '<' } )
2496 * ) );
2497 * mw.log( output ); // <div><img src="&lt;"/></div>
2498 *
2499 * @class mw.html
2500 * @singleton
2501 */
2502 html: ( function () {
2503 function escapeCallback( s ) {
2504 switch ( s ) {
2505 case '\'':
2506 return '&#039;';
2507 case '"':
2508 return '&quot;';
2509 case '<':
2510 return '&lt;';
2511 case '>':
2512 return '&gt;';
2513 case '&':
2514 return '&amp;';
2515 }
2516 }
2517
2518 return {
2519 /**
2520 * Escape a string for HTML.
2521 *
2522 * Converts special characters to HTML entities.
2523 *
2524 * mw.html.escape( '< > \' & "' );
2525 * // Returns &lt; &gt; &#039; &amp; &quot;
2526 *
2527 * @param {string} s The string to escape
2528 * @return {string} HTML
2529 */
2530 escape: function ( s ) {
2531 return s.replace( /['"<>&]/g, escapeCallback );
2532 },
2533
2534 /**
2535 * Create an HTML element string, with safe escaping.
2536 *
2537 * @param {string} name The tag name.
2538 * @param {Object} [attrs] An object with members mapping element names to values
2539 * @param {string|mw.html.Raw|mw.html.Cdata|null} [contents=null] The contents of the element.
2540 *
2541 * - string: Text to be escaped.
2542 * - null: The element is treated as void with short closing form, e.g. `<br/>`.
2543 * - this.Raw: The raw value is directly included.
2544 * - this.Cdata: The raw value is directly included. An exception is
2545 * thrown if it contains any illegal ETAGO delimiter.
2546 * See <https://www.w3.org/TR/html401/appendix/notes.html#h-B.3.2>.
2547 * @return {string} HTML
2548 */
2549 element: function ( name, attrs, contents ) {
2550 var v, attrName, s = '<' + name;
2551
2552 if ( attrs ) {
2553 for ( attrName in attrs ) {
2554 v = attrs[ attrName ];
2555 // Convert name=true, to name=name
2556 if ( v === true ) {
2557 v = attrName;
2558 // Skip name=false
2559 } else if ( v === false ) {
2560 continue;
2561 }
2562 s += ' ' + attrName + '="' + this.escape( String( v ) ) + '"';
2563 }
2564 }
2565 if ( contents === undefined || contents === null ) {
2566 // Self close tag
2567 s += '/>';
2568 return s;
2569 }
2570 // Regular open tag
2571 s += '>';
2572 switch ( typeof contents ) {
2573 case 'string':
2574 // Escaped
2575 s += this.escape( contents );
2576 break;
2577 case 'number':
2578 case 'boolean':
2579 // Convert to string
2580 s += String( contents );
2581 break;
2582 default:
2583 if ( contents instanceof this.Raw ) {
2584 // Raw HTML inclusion
2585 s += contents.value;
2586 } else if ( contents instanceof this.Cdata ) {
2587 // CDATA
2588 if ( /<\/[a-zA-z]/.test( contents.value ) ) {
2589 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
2590 }
2591 s += contents.value;
2592 } else {
2593 throw new Error( 'mw.html.element: Invalid type of contents' );
2594 }
2595 }
2596 s += '</' + name + '>';
2597 return s;
2598 },
2599
2600 /**
2601 * Wrapper object for raw HTML passed to mw.html.element().
2602 *
2603 * @class mw.html.Raw
2604 * @constructor
2605 * @param {string} value
2606 */
2607 Raw: function ( value ) {
2608 this.value = value;
2609 },
2610
2611 /**
2612 * Wrapper object for CDATA element contents passed to mw.html.element()
2613 *
2614 * @class mw.html.Cdata
2615 * @constructor
2616 * @param {string} value
2617 */
2618 Cdata: function ( value ) {
2619 this.value = value;
2620 }
2621 };
2622 }() ),
2623
2624 // Skeleton user object, extended by the 'mediawiki.user' module.
2625 /**
2626 * @class mw.user
2627 * @singleton
2628 */
2629 user: {
2630 /**
2631 * @property {mw.Map}
2632 */
2633 options: new Map(),
2634 /**
2635 * @property {mw.Map}
2636 */
2637 tokens: new Map()
2638 },
2639
2640 // OOUI widgets specific to MediaWiki
2641 widgets: {},
2642
2643 /**
2644 * Registry and firing of events.
2645 *
2646 * MediaWiki has various interface components that are extended, enhanced
2647 * or manipulated in some other way by extensions, gadgets and even
2648 * in core itself.
2649 *
2650 * This framework helps streamlining the timing of when these other
2651 * code paths fire their plugins (instead of using document-ready,
2652 * which can and should be limited to firing only once).
2653 *
2654 * Features like navigating to other wiki pages, previewing an edit
2655 * and editing itself – without a refresh – can then retrigger these
2656 * hooks accordingly to ensure everything still works as expected.
2657 *
2658 * Example usage:
2659 *
2660 * mw.hook( 'wikipage.content' ).add( fn ).remove( fn );
2661 * mw.hook( 'wikipage.content' ).fire( $content );
2662 *
2663 * Handlers can be added and fired for arbitrary event names at any time. The same
2664 * event can be fired multiple times. The last run of an event is memorized
2665 * (similar to `$(document).ready` and `$.Deferred().done`).
2666 * This means if an event is fired, and a handler added afterwards, the added
2667 * function will be fired right away with the last given event data.
2668 *
2669 * Like Deferreds and Promises, the mw.hook object is both detachable and chainable.
2670 * Thus allowing flexible use and optimal maintainability and authority control.
2671 * You can pass around the `add` and/or `fire` method to another piece of code
2672 * without it having to know the event name (or `mw.hook` for that matter).
2673 *
2674 * var h = mw.hook( 'bar.ready' );
2675 * new mw.Foo( .. ).fetch( { callback: h.fire } );
2676 *
2677 * Note: Events are documented with an underscore instead of a dot in the event
2678 * name due to jsduck not supporting dots in that position.
2679 *
2680 * @class mw.hook
2681 */
2682 hook: ( function () {
2683 var lists = {};
2684
2685 /**
2686 * Create an instance of mw.hook.
2687 *
2688 * @method hook
2689 * @member mw
2690 * @param {string} name Name of hook.
2691 * @return {mw.hook}
2692 */
2693 return function ( name ) {
2694 var list = hasOwn.call( lists, name ) ?
2695 lists[ name ] :
2696 lists[ name ] = $.Callbacks( 'memory' );
2697
2698 return {
2699 /**
2700 * Register a hook handler
2701 *
2702 * @param {...Function} handler Function to bind.
2703 * @chainable
2704 */
2705 add: list.add,
2706
2707 /**
2708 * Unregister a hook handler
2709 *
2710 * @param {...Function} handler Function to unbind.
2711 * @chainable
2712 */
2713 remove: list.remove,
2714
2715 // eslint-disable-next-line valid-jsdoc
2716 /**
2717 * Run a hook.
2718 *
2719 * @param {...Mixed} data
2720 * @chainable
2721 */
2722 fire: function () {
2723 return list.fireWith.call( this, null, slice.call( arguments ) );
2724 }
2725 };
2726 };
2727 }() )
2728 };
2729
2730 // Alias $j to jQuery for backwards compatibility
2731 // @deprecated since 1.23 Use $ or jQuery instead
2732 mw.log.deprecate( window, '$j', $, 'Use $ or jQuery instead.' );
2733
2734 /**
2735 * Log a message to window.console, if possible.
2736 *
2737 * Useful to force logging of some errors that are otherwise hard to detect (i.e., this logs
2738 * also in production mode). Gets console references in each invocation instead of caching the
2739 * reference, so that debugging tools loaded later are supported (e.g. Firebug Lite in IE).
2740 *
2741 * @private
2742 * @param {string} topic Stream name passed by mw.track
2743 * @param {Object} data Data passed by mw.track
2744 * @param {Error} [data.exception]
2745 * @param {string} data.source Error source
2746 * @param {string} [data.module] Name of module which caused the error
2747 */
2748 function logError( topic, data ) {
2749 /* eslint-disable no-console */
2750 var msg,
2751 e = data.exception,
2752 source = data.source,
2753 module = data.module,
2754 console = window.console;
2755
2756 if ( console && console.log ) {
2757 msg = ( e ? 'Exception' : 'Error' ) + ' in ' + source;
2758 if ( module ) {
2759 msg += ' in module ' + module;
2760 }
2761 msg += ( e ? ':' : '.' );
2762 console.log( msg );
2763
2764 // If we have an exception object, log it to the error channel to trigger
2765 // proper stacktraces in browsers that support it. No fallback as we have
2766 // no browsers that don't support error(), but do support log().
2767 if ( e && console.error ) {
2768 console.error( String( e ), e );
2769 }
2770 }
2771 /* eslint-enable no-console */
2772 }
2773
2774 // Subscribe to error streams
2775 mw.trackSubscribe( 'resourceloader.exception', logError );
2776 mw.trackSubscribe( 'resourceloader.assert', logError );
2777
2778 /**
2779 * Fired when all modules associated with the page have finished loading.
2780 *
2781 * @event resourceloader_loadEnd
2782 * @member mw.hook
2783 */
2784 $( function () {
2785 var loading, modules;
2786
2787 modules = $.grep( mw.loader.getModuleNames(), function ( module ) {
2788 return mw.loader.getState( module ) === 'loading';
2789 } );
2790 // We only need a callback, not any actual module. First try a single using()
2791 // for all loading modules. If one fails, fall back to tracking each module
2792 // separately via $.when(), this is expensive.
2793 loading = mw.loader.using( modules ).then( null, function () {
2794 var all = modules.map( function ( module ) {
2795 return mw.loader.using( module ).then( null, function () {
2796 return $.Deferred().resolve();
2797 } );
2798 } );
2799 return $.when.apply( $, all );
2800 } );
2801 loading.then( function () {
2802 /* global mwPerformance */
2803 mwPerformance.mark( 'mwLoadEnd' );
2804 mw.hook( 'resourceloader.loadEnd' ).fire();
2805 } );
2806 } );
2807
2808 // Attach to window and globally alias
2809 window.mw = window.mediaWiki = mw;
2810 }( jQuery ) );