49479521b8d836890acc8f33f73448e532b6088b
[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', ...]
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 /**
869 * For #addEmbeddedCSS() and #addLink()
870 *
871 * @private
872 * @property {HTMLElement|null} marker
873 */
874 marker = document.querySelector( 'meta[name="ResourceLoaderDynamicStyles"]' ),
875
876 // For addEmbeddedCSS()
877 cssBuffer = '',
878 cssBufferTimer = null,
879 cssCallbacks = [],
880 rAF = window.requestAnimationFrame || setTimeout;
881
882 /**
883 * Create a new style element and add it to the DOM.
884 *
885 * @private
886 * @param {string} text CSS text
887 * @param {Node|null} [nextNode] The element where the style tag
888 * should be inserted before
889 * @return {HTMLElement} Reference to the created style element
890 */
891 function newStyleTag( text, nextNode ) {
892 var el = document.createElement( 'style' );
893 el.appendChild( document.createTextNode( text ) );
894 if ( nextNode && nextNode.parentNode ) {
895 nextNode.parentNode.insertBefore( el, nextNode );
896 } else {
897 document.head.appendChild( el );
898 }
899 return el;
900 }
901
902 /**
903 * Add a bit of CSS text to the current browser page.
904 *
905 * The CSS will be appended to an existing ResourceLoader-created `<style>` tag
906 * or create a new one based on whether the given `cssText` is safe for extension.
907 *
908 * @private
909 * @param {string} [cssText=cssBuffer] If called without cssText,
910 * the internal buffer will be inserted instead.
911 * @param {Function} [callback]
912 */
913 function addEmbeddedCSS( cssText, callback ) {
914 function fireCallbacks() {
915 var i,
916 oldCallbacks = cssCallbacks;
917 // Reset cssCallbacks variable so it's not polluted by any calls to
918 // addEmbeddedCSS() from one of the callbacks (T105973)
919 cssCallbacks = [];
920 for ( i = 0; i < oldCallbacks.length; i++ ) {
921 oldCallbacks[ i ]();
922 }
923 }
924
925 if ( callback ) {
926 cssCallbacks.push( callback );
927 }
928
929 // Yield once before creating the <style> tag. This lets multiple stylesheets
930 // accumulate into one buffer, allowing us to reduce how often new stylesheets
931 // are inserted in the browser. Appending a stylesheet and waiting for the
932 // browser to repaint is fairly expensive. (T47810)
933 if ( cssText ) {
934 // Don't extend the buffer if the item needs its own stylesheet.
935 // Keywords like `@import` are only valid at the start of a stylesheet (T37562).
936 if ( !cssBuffer || cssText.slice( 0, '@import'.length ) !== '@import' ) {
937 // Linebreak for somewhat distinguishable sections
938 cssBuffer += '\n' + cssText;
939 if ( !cssBufferTimer ) {
940 cssBufferTimer = rAF( function () {
941 // Wrap in anonymous function that takes no arguments
942 // Support: Firefox < 13
943 // Firefox 12 has non-standard behaviour of passing a number
944 // as first argument to a setTimeout callback.
945 // http://benalman.com/news/2009/07/the-mysterious-firefox-settime/
946 addEmbeddedCSS();
947 } );
948 }
949 return;
950 }
951
952 // This is a scheduled flush for the buffer
953 } else {
954 cssBufferTimer = null;
955 cssText = cssBuffer;
956 cssBuffer = '';
957 }
958
959 newStyleTag( cssText, marker );
960
961 fireCallbacks();
962 }
963
964 /**
965 * @private
966 * @param {Array} modules List of module names
967 * @return {string} Hash of concatenated version hashes.
968 */
969 function getCombinedVersion( modules ) {
970 var hashes = modules.map( function ( module ) {
971 return registry[ module ].version;
972 } );
973 return fnv132( hashes.join( '' ) );
974 }
975
976 /**
977 * Determine whether all dependencies are in state 'ready', which means we may
978 * execute the module or job now.
979 *
980 * @private
981 * @param {Array} modules Names of modules to be checked
982 * @return {boolean} True if all modules are in state 'ready', false otherwise
983 */
984 function allReady( modules ) {
985 var i;
986 for ( i = 0; i < modules.length; i++ ) {
987 if ( mw.loader.getState( modules[ i ] ) !== 'ready' ) {
988 return false;
989 }
990 }
991 return true;
992 }
993
994 /**
995 * Determine whether all dependencies are in state 'ready', which means we may
996 * execute the module or job now.
997 *
998 * @private
999 * @param {Array} modules Names of modules to be checked
1000 * @return {boolean} True if no modules are in state 'error' or 'missing', false otherwise
1001 */
1002 function anyFailed( modules ) {
1003 var i, state;
1004 for ( i = 0; i < modules.length; i++ ) {
1005 state = mw.loader.getState( modules[ i ] );
1006 if ( state === 'error' || state === 'missing' ) {
1007 return true;
1008 }
1009 }
1010 return false;
1011 }
1012
1013 /**
1014 * A module has entered state 'ready', 'error', or 'missing'. Automatically update
1015 * pending jobs and modules that depend upon this module. If the given module failed,
1016 * propagate the 'error' state up the dependency tree. Otherwise, go ahead and execute
1017 * all jobs/modules now having their dependencies satisfied.
1018 *
1019 * Jobs that depend on a failed module, will have their error callback ran (if any).
1020 *
1021 * @private
1022 * @param {string} module Name of module that entered one of the states 'ready', 'error', or 'missing'.
1023 */
1024 function handlePending( module ) {
1025 var j, job, hasErrors, m, stateChange;
1026
1027 if ( registry[ module ].state === 'error' || registry[ module ].state === 'missing' ) {
1028 // If the current module failed, mark all dependent modules also as failed.
1029 // Iterate until steady-state to propagate the error state upwards in the
1030 // dependency tree.
1031 do {
1032 stateChange = false;
1033 for ( m in registry ) {
1034 if ( registry[ m ].state !== 'error' && registry[ m ].state !== 'missing' ) {
1035 if ( anyFailed( registry[ m ].dependencies ) ) {
1036 registry[ m ].state = 'error';
1037 stateChange = true;
1038 }
1039 }
1040 }
1041 } while ( stateChange );
1042 }
1043
1044 // Execute all jobs whose dependencies are either all satisfied or contain at least one failed module.
1045 for ( j = 0; j < jobs.length; j++ ) {
1046 hasErrors = anyFailed( jobs[ j ].dependencies );
1047 if ( hasErrors || allReady( jobs[ j ].dependencies ) ) {
1048 // All dependencies satisfied, or some have errors
1049 job = jobs[ j ];
1050 jobs.splice( j, 1 );
1051 j -= 1;
1052 try {
1053 if ( hasErrors ) {
1054 if ( typeof job.error === 'function' ) {
1055 job.error( new Error( 'Module ' + module + ' has failed dependencies' ), [ module ] );
1056 }
1057 } else {
1058 if ( typeof job.ready === 'function' ) {
1059 job.ready();
1060 }
1061 }
1062 } catch ( e ) {
1063 // A user-defined callback raised an exception.
1064 // Swallow it to protect our state machine!
1065 mw.track( 'resourceloader.exception', { exception: e, module: module, source: 'load-callback' } );
1066 }
1067 }
1068 }
1069
1070 if ( registry[ module ].state === 'ready' ) {
1071 // The current module became 'ready'. Set it in the module store, and recursively execute all
1072 // dependent modules that are loaded and now have all dependencies satisfied.
1073 mw.loader.store.set( module, registry[ module ] );
1074 for ( m in registry ) {
1075 if ( registry[ m ].state === 'loaded' && allReady( registry[ m ].dependencies ) ) {
1076 execute( m );
1077 }
1078 }
1079 }
1080 }
1081
1082 /**
1083 * Resolve dependencies and detect circular references.
1084 *
1085 * @private
1086 * @param {string} module Name of the top-level module whose dependencies shall be
1087 * resolved and sorted.
1088 * @param {Array} resolved Returns a topological sort of the given module and its
1089 * dependencies, such that later modules depend on earlier modules. The array
1090 * contains the module names. If the array contains already some module names,
1091 * this function appends its result to the pre-existing array.
1092 * @param {StringSet} [unresolved] Used to track the current dependency
1093 * chain, and to report loops in the dependency graph.
1094 * @throws {Error} If any unregistered module or a dependency loop is encountered
1095 */
1096 function sortDependencies( module, resolved, unresolved ) {
1097 var i, deps, skip;
1098
1099 if ( !hasOwn.call( registry, module ) ) {
1100 throw new Error( 'Unknown dependency: ' + module );
1101 }
1102
1103 if ( registry[ module ].skip !== null ) {
1104 // eslint-disable-next-line no-new-func
1105 skip = new Function( registry[ module ].skip );
1106 registry[ module ].skip = null;
1107 if ( skip() ) {
1108 registry[ module ].skipped = true;
1109 registry[ module ].dependencies = [];
1110 registry[ module ].state = 'ready';
1111 handlePending( module );
1112 return;
1113 }
1114 }
1115
1116 if ( resolved.indexOf( module ) !== -1 ) {
1117 // Module already resolved; nothing to do
1118 return;
1119 }
1120 // Create unresolved if not passed in
1121 if ( !unresolved ) {
1122 unresolved = new StringSet();
1123 }
1124 // Tracks down dependencies
1125 deps = registry[ module ].dependencies;
1126 for ( i = 0; i < deps.length; i++ ) {
1127 if ( resolved.indexOf( deps[ i ] ) === -1 ) {
1128 if ( unresolved.has( deps[ i ] ) ) {
1129 throw new Error( mw.format(
1130 'Circular reference detected: $1 -> $2',
1131 module,
1132 deps[ i ]
1133 ) );
1134 }
1135
1136 unresolved.add( module );
1137 sortDependencies( deps[ i ], resolved, unresolved );
1138 }
1139 }
1140 resolved.push( module );
1141 }
1142
1143 /**
1144 * Get names of module that a module depends on, in their proper dependency order.
1145 *
1146 * @private
1147 * @param {string[]} modules Array of string module names
1148 * @return {Array} List of dependencies, including 'module'.
1149 * @throws {Error} If an unregistered module or a dependency loop is encountered
1150 */
1151 function resolve( modules ) {
1152 var i, resolved = [];
1153 for ( i = 0; i < modules.length; i++ ) {
1154 sortDependencies( modules[ i ], resolved );
1155 }
1156 return resolved;
1157 }
1158
1159 /**
1160 * Like #resolve(), except it will silently ignore modules that
1161 * are missing or have missing dependencies.
1162 *
1163 * @private
1164 * @param {string[]} modules Array of string module names
1165 * @return {Array} List of dependencies.
1166 */
1167 function resolveStubbornly( modules ) {
1168 var i, saved, resolved = [];
1169 for ( i = 0; i < modules.length; i++ ) {
1170 saved = resolved.slice();
1171 try {
1172 sortDependencies( modules[ i ], resolved );
1173 } catch ( err ) {
1174 // This module is unknown or has unknown dependencies.
1175 // Undo any incomplete resolutions made and keep going.
1176 resolved = saved;
1177 mw.track( 'resourceloader.exception', {
1178 exception: err,
1179 source: 'resolve'
1180 } );
1181 }
1182 }
1183 return resolved;
1184 }
1185
1186 /**
1187 * Load and execute a script.
1188 *
1189 * @private
1190 * @param {string} src URL to script, will be used as the src attribute in the script tag
1191 * @return {jQuery.Promise}
1192 */
1193 function addScript( src ) {
1194 return $.ajax( {
1195 url: src,
1196 dataType: 'script',
1197 // Force jQuery behaviour to be for crossDomain. Otherwise jQuery would use
1198 // XHR for a same domain request instead of <script>, which changes the request
1199 // headers (potentially missing a cache hit), and reduces caching in general
1200 // since browsers cache XHR much less (if at all). And XHR means we retrieve
1201 // text, so we'd need to $.globalEval, which then messes up line numbers.
1202 crossDomain: true,
1203 cache: true
1204 } );
1205 }
1206
1207 /**
1208 * Queue the loading and execution of a script for a particular module.
1209 *
1210 * @private
1211 * @param {string} src URL of the script
1212 * @param {string} moduleName Name of currently executing module
1213 * @param {Function} callback Callback to run after addScript() resolution
1214 */
1215 function queueModuleScript( src, moduleName, callback ) {
1216 pendingRequests.push( function () {
1217 if ( moduleName && hasOwn.call( registry, moduleName ) ) {
1218 // Emulate runScript() part of execute()
1219 window.require = mw.loader.require;
1220 window.module = registry[ moduleName ].module;
1221 }
1222 addScript( src ).always( function () {
1223 // 'module.exports' should not persist after the file is executed to
1224 // avoid leakage to unrelated code. 'require' should be kept, however,
1225 // as asynchronous access to 'require' is allowed and expected. (T144879)
1226 delete window.module;
1227 callback();
1228 // Start the next one (if any)
1229 if ( pendingRequests[ 0 ] ) {
1230 pendingRequests.shift()();
1231 } else {
1232 handlingPendingRequests = false;
1233 }
1234 } );
1235 } );
1236 if ( !handlingPendingRequests && pendingRequests[ 0 ] ) {
1237 handlingPendingRequests = true;
1238 pendingRequests.shift()();
1239 }
1240 }
1241
1242 /**
1243 * Utility function for execute()
1244 *
1245 * @ignore
1246 * @param {string} [media] Media attribute
1247 * @param {string} url URL
1248 */
1249 function addLink( media, url ) {
1250 var el = document.createElement( 'link' );
1251
1252 el.rel = 'stylesheet';
1253 if ( media && media !== 'all' ) {
1254 el.media = media;
1255 }
1256 // If you end up here from an IE exception "SCRIPT: Invalid property value.",
1257 // see #addEmbeddedCSS, T33676, T43331, and T49277 for details.
1258 el.href = url;
1259
1260 if ( marker && marker.parentNode ) {
1261 marker.parentNode.insertBefore( el, marker );
1262 } else {
1263 document.head.appendChild( el );
1264 }
1265 }
1266
1267 /**
1268 * Executes a loaded module, making it ready to use
1269 *
1270 * @private
1271 * @param {string} module Module name to execute
1272 */
1273 function execute( module ) {
1274 var key, value, media, i, urls, cssHandle, checkCssHandles, runScript,
1275 cssHandlesRegistered = false;
1276
1277 if ( !hasOwn.call( registry, module ) ) {
1278 throw new Error( 'Module has not been registered yet: ' + module );
1279 }
1280 if ( registry[ module ].state !== 'loaded' ) {
1281 throw new Error( 'Module in state "' + registry[ module ].state + '" may not be executed: ' + module );
1282 }
1283
1284 registry[ module ].state = 'executing';
1285
1286 runScript = function () {
1287 var script, markModuleReady, nestedAddScript;
1288
1289 script = registry[ module ].script;
1290 markModuleReady = function () {
1291 registry[ module ].state = 'ready';
1292 handlePending( module );
1293 };
1294 nestedAddScript = function ( arr, callback, i ) {
1295 // Recursively call queueModuleScript() in its own callback
1296 // for each element of arr.
1297 if ( i >= arr.length ) {
1298 // We're at the end of the array
1299 callback();
1300 return;
1301 }
1302
1303 queueModuleScript( arr[ i ], module, function () {
1304 nestedAddScript( arr, callback, i + 1 );
1305 } );
1306 };
1307
1308 try {
1309 if ( Array.isArray( script ) ) {
1310 nestedAddScript( script, markModuleReady, 0 );
1311 } else if ( typeof script === 'function' ) {
1312 // Pass jQuery twice so that the signature of the closure which wraps
1313 // the script can bind both '$' and 'jQuery'.
1314 script( $, $, mw.loader.require, registry[ module ].module );
1315 markModuleReady();
1316
1317 } else if ( typeof script === 'string' ) {
1318 // Site and user modules are legacy scripts that run in the global scope.
1319 // This is transported as a string instead of a function to avoid needing
1320 // to use string manipulation to undo the function wrapper.
1321 $.globalEval( script );
1322 markModuleReady();
1323
1324 } else {
1325 // Module without script
1326 markModuleReady();
1327 }
1328 } catch ( e ) {
1329 // Use mw.track instead of mw.log because these errors are common in production mode
1330 // (e.g. undefined variable), and mw.log is only enabled in debug mode.
1331 registry[ module ].state = 'error';
1332 mw.track( 'resourceloader.exception', { exception: e, module: module, source: 'module-execute' } );
1333 handlePending( module );
1334 }
1335 };
1336
1337 // Add localizations to message system
1338 if ( registry[ module ].messages ) {
1339 mw.messages.set( registry[ module ].messages );
1340 }
1341
1342 // Initialise templates
1343 if ( registry[ module ].templates ) {
1344 mw.templates.set( module, registry[ module ].templates );
1345 }
1346
1347 // Make sure we don't run the scripts until all stylesheet insertions have completed.
1348 ( function () {
1349 var pending = 0;
1350 checkCssHandles = function () {
1351 // cssHandlesRegistered ensures we don't take off too soon, e.g. when
1352 // one of the cssHandles is fired while we're still creating more handles.
1353 if ( cssHandlesRegistered && pending === 0 && runScript ) {
1354 if ( module === 'user' ) {
1355 // Implicit dependency on the site module. Not real dependency because
1356 // it should run after 'site' regardless of whether it succeeds or fails.
1357 mw.loader.using( [ 'site' ] ).always( runScript );
1358 } else {
1359 runScript();
1360 }
1361 runScript = undefined; // Revoke
1362 }
1363 };
1364 cssHandle = function () {
1365 var check = checkCssHandles;
1366 pending++;
1367 return function () {
1368 if ( check ) {
1369 pending--;
1370 check();
1371 check = undefined; // Revoke
1372 }
1373 };
1374 };
1375 }() );
1376
1377 // Process styles (see also mw.loader.implement)
1378 // * back-compat: { <media>: css }
1379 // * back-compat: { <media>: [url, ..] }
1380 // * { "css": [css, ..] }
1381 // * { "url": { <media>: [url, ..] } }
1382 if ( registry[ module ].style ) {
1383 for ( key in registry[ module ].style ) {
1384 value = registry[ module ].style[ key ];
1385 media = undefined;
1386
1387 if ( key !== 'url' && key !== 'css' ) {
1388 // Backwards compatibility, key is a media-type
1389 if ( typeof value === 'string' ) {
1390 // back-compat: { <media>: css }
1391 // Ignore 'media' because it isn't supported (nor was it used).
1392 // Strings are pre-wrapped in "@media". The media-type was just ""
1393 // (because it had to be set to something).
1394 // This is one of the reasons why this format is no longer used.
1395 addEmbeddedCSS( value, cssHandle() );
1396 } else {
1397 // back-compat: { <media>: [url, ..] }
1398 media = key;
1399 key = 'bc-url';
1400 }
1401 }
1402
1403 // Array of css strings in key 'css',
1404 // or back-compat array of urls from media-type
1405 if ( Array.isArray( value ) ) {
1406 for ( i = 0; i < value.length; i++ ) {
1407 if ( key === 'bc-url' ) {
1408 // back-compat: { <media>: [url, ..] }
1409 addLink( media, value[ i ] );
1410 } else if ( key === 'css' ) {
1411 // { "css": [css, ..] }
1412 addEmbeddedCSS( value[ i ], cssHandle() );
1413 }
1414 }
1415 // Not an array, but a regular object
1416 // Array of urls inside media-type key
1417 } else if ( typeof value === 'object' ) {
1418 // { "url": { <media>: [url, ..] } }
1419 for ( media in value ) {
1420 urls = value[ media ];
1421 for ( i = 0; i < urls.length; i++ ) {
1422 addLink( media, urls[ i ] );
1423 }
1424 }
1425 }
1426 }
1427 }
1428
1429 // Kick off.
1430 cssHandlesRegistered = true;
1431 checkCssHandles();
1432 }
1433
1434 /**
1435 * Add one or more modules to the module load queue.
1436 *
1437 * See also #work().
1438 *
1439 * @private
1440 * @param {string|string[]} dependencies Module name or array of string module names
1441 * @param {Function} [ready] Callback to execute when all dependencies are ready
1442 * @param {Function} [error] Callback to execute when any dependency fails
1443 */
1444 function enqueue( dependencies, ready, error ) {
1445 // Allow calling by single module name
1446 if ( typeof dependencies === 'string' ) {
1447 dependencies = [ dependencies ];
1448 }
1449
1450 // Add ready and error callbacks if they were given
1451 if ( ready !== undefined || error !== undefined ) {
1452 jobs.push( {
1453 // Narrow down the list to modules that are worth waiting for
1454 dependencies: dependencies.filter( function ( module ) {
1455 var state = mw.loader.getState( module );
1456 return state === 'registered' || state === 'loaded' || state === 'loading' || state === 'executing';
1457 } ),
1458 ready: ready,
1459 error: error
1460 } );
1461 }
1462
1463 dependencies.forEach( function ( module ) {
1464 var state = mw.loader.getState( module );
1465 // Only queue modules that are still in the initial 'registered' state
1466 // (not ones already loading, ready or error).
1467 if ( state === 'registered' && queue.indexOf( module ) === -1 ) {
1468 // Private modules must be embedded in the page. Don't bother queuing
1469 // these as the server will deny them anyway (T101806).
1470 if ( registry[ module ].group === 'private' ) {
1471 registry[ module ].state = 'error';
1472 handlePending( module );
1473 return;
1474 }
1475 queue.push( module );
1476 }
1477 } );
1478
1479 mw.loader.work();
1480 }
1481
1482 function sortQuery( o ) {
1483 var key,
1484 sorted = {},
1485 a = [];
1486
1487 for ( key in o ) {
1488 a.push( key );
1489 }
1490 a.sort();
1491 for ( key = 0; key < a.length; key++ ) {
1492 sorted[ a[ key ] ] = o[ a[ key ] ];
1493 }
1494 return sorted;
1495 }
1496
1497 /**
1498 * Converts a module map of the form `{ foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }`
1499 * to a query string of the form `foo.bar,baz|bar.baz,quux`.
1500 *
1501 * See `ResourceLoader::makePackedModulesString()` in PHP, of which this is a port.
1502 * On the server, unpacking is done by `ResourceLoaderContext::expandModuleNames()`.
1503 *
1504 * Note: This is only half of the logic, the other half has to be in #batchRequest(),
1505 * because its implementation needs to keep track of potential string size in order
1506 * to decide when to split the requests due to url size.
1507 *
1508 * @private
1509 * @param {Object} moduleMap Module map
1510 * @return {Object}
1511 * @return {string} return.str Module query string
1512 * @return {Array} return.list List of module names in matching order
1513 */
1514 function buildModulesString( moduleMap ) {
1515 var p, prefix,
1516 str = [],
1517 list = [];
1518
1519 function restore( suffix ) {
1520 return p + suffix;
1521 }
1522
1523 for ( prefix in moduleMap ) {
1524 p = prefix === '' ? '' : prefix + '.';
1525 str.push( p + moduleMap[ prefix ].join( ',' ) );
1526 list.push.apply( list, moduleMap[ prefix ].map( restore ) );
1527 }
1528 return {
1529 str: str.join( '|' ),
1530 list: list
1531 };
1532 }
1533
1534 /**
1535 * Resolve indexed dependencies.
1536 *
1537 * ResourceLoader uses an optimization to save space which replaces module names in
1538 * dependency lists with the index of that module within the array of module
1539 * registration data if it exists. The benefit is a significant reduction in the data
1540 * size of the startup module. This function changes those dependency lists back to
1541 * arrays of strings.
1542 *
1543 * @private
1544 * @param {Array} modules Modules array
1545 */
1546 function resolveIndexedDependencies( modules ) {
1547 var i, j, deps;
1548 function resolveIndex( dep ) {
1549 return typeof dep === 'number' ? modules[ dep ][ 0 ] : dep;
1550 }
1551 for ( i = 0; i < modules.length; i++ ) {
1552 deps = modules[ i ][ 2 ];
1553 if ( deps ) {
1554 for ( j = 0; j < deps.length; j++ ) {
1555 deps[ j ] = resolveIndex( deps[ j ] );
1556 }
1557 }
1558 }
1559 }
1560
1561 /**
1562 * Create network requests for a batch of modules.
1563 *
1564 * This is an internal method for #work(). This must not be called directly
1565 * unless the modules are already registered, and no request is in progress,
1566 * and the module state has already been set to `loading`.
1567 *
1568 * @private
1569 * @param {string[]} batch
1570 */
1571 function batchRequest( batch ) {
1572 var reqBase, splits, maxQueryLength, b, bSource, bGroup, bSourceGroup,
1573 source, group, i, modules, sourceLoadScript,
1574 currReqBase, currReqBaseLength, moduleMap, currReqModules, l,
1575 lastDotIndex, prefix, suffix, bytesAdded;
1576
1577 /**
1578 * Start the currently drafted request to the server.
1579 *
1580 * @ignore
1581 */
1582 function doRequest() {
1583 // Optimisation: Inherit (Object.create), not copy ($.extend)
1584 var query = Object.create( currReqBase ),
1585 packed = buildModulesString( moduleMap );
1586 query.modules = packed.str;
1587 // The packing logic can change the effective order, even if the input was
1588 // sorted. As such, the call to getCombinedVersion() must use this
1589 // effective order, instead of currReqModules, as otherwise the combined
1590 // version will not match the hash expected by the server based on
1591 // combining versions from the module query string in-order. (T188076)
1592 query.version = getCombinedVersion( packed.list );
1593 query = sortQuery( query );
1594 addScript( sourceLoadScript + '?' + $.param( query ) );
1595 }
1596
1597 if ( !batch.length ) {
1598 return;
1599 }
1600
1601 // Always order modules alphabetically to help reduce cache
1602 // misses for otherwise identical content.
1603 batch.sort();
1604
1605 // Query parameters common to all requests
1606 reqBase = {
1607 skin: mw.config.get( 'skin' ),
1608 lang: mw.config.get( 'wgUserLanguage' ),
1609 debug: mw.config.get( 'debug' )
1610 };
1611 maxQueryLength = mw.config.get( 'wgResourceLoaderMaxQueryLength', 2000 );
1612
1613 // Split module list by source and by group.
1614 splits = {};
1615 for ( b = 0; b < batch.length; b++ ) {
1616 bSource = registry[ batch[ b ] ].source;
1617 bGroup = registry[ batch[ b ] ].group;
1618 if ( !hasOwn.call( splits, bSource ) ) {
1619 splits[ bSource ] = {};
1620 }
1621 if ( !hasOwn.call( splits[ bSource ], bGroup ) ) {
1622 splits[ bSource ][ bGroup ] = [];
1623 }
1624 bSourceGroup = splits[ bSource ][ bGroup ];
1625 bSourceGroup.push( batch[ b ] );
1626 }
1627
1628 for ( source in splits ) {
1629
1630 sourceLoadScript = sources[ source ];
1631
1632 for ( group in splits[ source ] ) {
1633
1634 // Cache access to currently selected list of
1635 // modules for this group from this source.
1636 modules = splits[ source ][ group ];
1637
1638 // Query parameters common to requests for this module group
1639 // Optimisation: Inherit (Object.create), not copy ($.extend)
1640 currReqBase = Object.create( reqBase );
1641 // User modules require a user name in the query string.
1642 if ( group === 'user' && mw.config.get( 'wgUserName' ) !== null ) {
1643 currReqBase.user = mw.config.get( 'wgUserName' );
1644 }
1645
1646 // In addition to currReqBase, doRequest() will also add 'modules' and 'version'.
1647 // > '&modules='.length === 9
1648 // > '&version=1234567'.length === 16
1649 // > 9 + 16 = 25
1650 currReqBaseLength = $.param( currReqBase ).length + 25;
1651
1652 // We may need to split up the request to honor the query string length limit,
1653 // so build it piece by piece.
1654 l = currReqBaseLength;
1655 moduleMap = {}; // { prefix: [ suffixes ] }
1656 currReqModules = [];
1657
1658 for ( i = 0; i < modules.length; i++ ) {
1659 // Determine how many bytes this module would add to the query string
1660 lastDotIndex = modules[ i ].lastIndexOf( '.' );
1661 // If lastDotIndex is -1, substr() returns an empty string
1662 prefix = modules[ i ].substr( 0, lastDotIndex );
1663 suffix = modules[ i ].slice( lastDotIndex + 1 );
1664 bytesAdded = hasOwn.call( moduleMap, prefix ) ?
1665 suffix.length + 3 : // '%2C'.length == 3
1666 modules[ i ].length + 3; // '%7C'.length == 3
1667
1668 // If the url would become too long, create a new one, but don't create empty requests
1669 if ( maxQueryLength > 0 && currReqModules.length && l + bytesAdded > maxQueryLength ) {
1670 // Dispatch what we've got...
1671 doRequest();
1672 // .. and start again.
1673 l = currReqBaseLength;
1674 moduleMap = {};
1675 currReqModules = [];
1676
1677 mw.track( 'resourceloader.splitRequest', { maxQueryLength: maxQueryLength } );
1678 }
1679 if ( !hasOwn.call( moduleMap, prefix ) ) {
1680 moduleMap[ prefix ] = [];
1681 }
1682 l += bytesAdded;
1683 moduleMap[ prefix ].push( suffix );
1684 currReqModules.push( modules[ i ] );
1685 }
1686 // If there's anything left in moduleMap, request that too
1687 if ( currReqModules.length ) {
1688 doRequest();
1689 }
1690 }
1691 }
1692 }
1693
1694 /**
1695 * @private
1696 * @param {string[]} implementations Array containing pieces of JavaScript code in the
1697 * form of calls to mw.loader#implement().
1698 * @param {Function} cb Callback in case of failure
1699 * @param {Error} cb.err
1700 */
1701 function asyncEval( implementations, cb ) {
1702 if ( !implementations.length ) {
1703 return;
1704 }
1705 mw.requestIdleCallback( function () {
1706 try {
1707 $.globalEval( implementations.join( ';' ) );
1708 } catch ( err ) {
1709 cb( err );
1710 }
1711 } );
1712 }
1713
1714 /**
1715 * Make a versioned key for a specific module.
1716 *
1717 * @private
1718 * @param {string} module Module name
1719 * @return {string|null} Module key in format '`[name]@[version]`',
1720 * or null if the module does not exist
1721 */
1722 function getModuleKey( module ) {
1723 return hasOwn.call( registry, module ) ?
1724 ( module + '@' + registry[ module ].version ) : null;
1725 }
1726
1727 /**
1728 * @private
1729 * @param {string} key Module name or '`[name]@[version]`'
1730 * @return {Object}
1731 */
1732 function splitModuleKey( key ) {
1733 var index = key.indexOf( '@' );
1734 if ( index === -1 ) {
1735 return {
1736 name: key,
1737 version: ''
1738 };
1739 }
1740 return {
1741 name: key.slice( 0, index ),
1742 version: key.slice( index + 1 )
1743 };
1744 }
1745
1746 /* Public Members */
1747 return {
1748 /**
1749 * The module registry is exposed as an aid for debugging and inspecting page
1750 * state; it is not a public interface for modifying the registry.
1751 *
1752 * @see #registry
1753 * @property
1754 * @private
1755 */
1756 moduleRegistry: registry,
1757
1758 /**
1759 * @inheritdoc #newStyleTag
1760 * @method
1761 */
1762 addStyleTag: newStyleTag,
1763
1764 /**
1765 * Start loading of all queued module dependencies.
1766 *
1767 * @protected
1768 */
1769 work: function () {
1770 var q, batch, implementations, sourceModules;
1771
1772 batch = [];
1773
1774 // Appends a list of modules from the queue to the batch
1775 for ( q = 0; q < queue.length; q++ ) {
1776 // Only load modules which are registered
1777 if ( hasOwn.call( registry, queue[ q ] ) && registry[ queue[ q ] ].state === 'registered' ) {
1778 // Prevent duplicate entries
1779 if ( batch.indexOf( queue[ q ] ) === -1 ) {
1780 batch.push( queue[ q ] );
1781 // Mark registered modules as loading
1782 registry[ queue[ q ] ].state = 'loading';
1783 }
1784 }
1785 }
1786
1787 // Now that the queue has been processed into a batch, clear the queue.
1788 // This MUST happen before we initiate any eval or network request. Otherwise,
1789 // it is possible for a cached script to instantly trigger the same work queue
1790 // again; all before we've cleared it causing each request to include modules
1791 // which are already loaded.
1792 queue = [];
1793
1794 if ( !batch.length ) {
1795 return;
1796 }
1797
1798 mw.loader.store.init();
1799 if ( mw.loader.store.enabled ) {
1800 implementations = [];
1801 sourceModules = [];
1802 batch = batch.filter( function ( module ) {
1803 var implementation = mw.loader.store.get( module );
1804 if ( implementation ) {
1805 implementations.push( implementation );
1806 sourceModules.push( module );
1807 return false;
1808 }
1809 return true;
1810 } );
1811 asyncEval( implementations, function ( err ) {
1812 var failed;
1813 // Not good, the cached mw.loader.implement calls failed! This should
1814 // never happen, barring ResourceLoader bugs, browser bugs and PEBKACs.
1815 // Depending on how corrupt the string is, it is likely that some
1816 // modules' implement() succeeded while the ones after the error will
1817 // never run and leave their modules in the 'loading' state forever.
1818 mw.loader.store.stats.failed++;
1819
1820 // Since this is an error not caused by an individual module but by
1821 // something that infected the implement call itself, don't take any
1822 // risks and clear everything in this cache.
1823 mw.loader.store.clear();
1824
1825 mw.track( 'resourceloader.exception', { exception: err, source: 'store-eval' } );
1826 // Re-add the failed ones that are still pending back to the batch
1827 failed = sourceModules.filter( function ( module ) {
1828 return registry[ module ].state === 'loading';
1829 } );
1830 batchRequest( failed );
1831 } );
1832 }
1833
1834 batchRequest( batch );
1835 },
1836
1837 /**
1838 * Register a source.
1839 *
1840 * The #work() method will use this information to split up requests by source.
1841 *
1842 * mw.loader.addSource( 'mediawikiwiki', '//www.mediawiki.org/w/load.php' );
1843 *
1844 * @param {string|Object} id Source ID, or object mapping ids to load urls
1845 * @param {string} loadUrl Url to a load.php end point
1846 * @throws {Error} If source id is already registered
1847 */
1848 addSource: function ( id, loadUrl ) {
1849 var source;
1850 // Allow multiple additions
1851 if ( typeof id === 'object' ) {
1852 for ( source in id ) {
1853 mw.loader.addSource( source, id[ source ] );
1854 }
1855 return;
1856 }
1857
1858 if ( hasOwn.call( sources, id ) ) {
1859 throw new Error( 'source already registered: ' + id );
1860 }
1861
1862 sources[ id ] = loadUrl;
1863 },
1864
1865 /**
1866 * Register a module, letting the system know about it and its properties.
1867 *
1868 * The startup modules contain calls to this method.
1869 *
1870 * When using multiple module registration by passing an array, dependencies that
1871 * are specified as references to modules within the array will be resolved before
1872 * the modules are registered.
1873 *
1874 * @param {string|Array} module Module name or array of arrays, each containing
1875 * a list of arguments compatible with this method
1876 * @param {string|number} version Module version hash (falls backs to empty string)
1877 * Can also be a number (timestamp) for compatibility with MediaWiki 1.25 and earlier.
1878 * @param {string|Array} dependencies One string or array of strings of module
1879 * names on which this module depends.
1880 * @param {string} [group=null] Group which the module is in
1881 * @param {string} [source='local'] Name of the source
1882 * @param {string} [skip=null] Script body of the skip function
1883 */
1884 register: function ( module, version, dependencies, group, source, skip ) {
1885 var i, deps;
1886 // Allow multiple registration
1887 if ( typeof module === 'object' ) {
1888 resolveIndexedDependencies( module );
1889 for ( i = 0; i < module.length; i++ ) {
1890 // module is an array of module names
1891 if ( typeof module[ i ] === 'string' ) {
1892 mw.loader.register( module[ i ] );
1893 // module is an array of arrays
1894 } else if ( typeof module[ i ] === 'object' ) {
1895 mw.loader.register.apply( mw.loader, module[ i ] );
1896 }
1897 }
1898 return;
1899 }
1900 if ( hasOwn.call( registry, module ) ) {
1901 throw new Error( 'module already registered: ' + module );
1902 }
1903 if ( typeof dependencies === 'string' ) {
1904 // A single module name
1905 deps = [ dependencies ];
1906 } else if ( typeof dependencies === 'object' ) {
1907 // Array of module names
1908 deps = dependencies;
1909 }
1910 // List the module as registered
1911 registry[ module ] = {
1912 // Exposed to execute() for mw.loader.implement() closures.
1913 // Import happens via require().
1914 module: {
1915 exports: {}
1916 },
1917 version: version !== undefined ? String( version ) : '',
1918 dependencies: deps || [],
1919 group: typeof group === 'string' ? group : null,
1920 source: typeof source === 'string' ? source : 'local',
1921 state: 'registered',
1922 skip: typeof skip === 'string' ? skip : null
1923 };
1924 },
1925
1926 /**
1927 * Implement a module given the components that make up the module.
1928 *
1929 * When #load() or #using() requests one or more modules, the server
1930 * response contain calls to this function.
1931 *
1932 * @param {string} module Name of module and current module version. Formatted
1933 * as '`[name]@[version]`". This version should match the requested version
1934 * (from #batchRequest and #registry). This avoids race conditions (T117587).
1935 * For back-compat with MediaWiki 1.27 and earlier, the version may be omitted.
1936 * @param {Function|Array|string} [script] Function with module code, list of URLs
1937 * to load via `<script src>`, or string of module code for `$.globalEval()`.
1938 * @param {Object} [style] Should follow one of the following patterns:
1939 *
1940 * { "css": [css, ..] }
1941 * { "url": { <media>: [url, ..] } }
1942 *
1943 * And for backwards compatibility (needs to be supported forever due to caching):
1944 *
1945 * { <media>: css }
1946 * { <media>: [url, ..] }
1947 *
1948 * The reason css strings are not concatenated anymore is T33676. We now check
1949 * whether it's safe to extend the stylesheet.
1950 *
1951 * @protected
1952 * @param {Object} [messages] List of key/value pairs to be added to mw#messages.
1953 * @param {Object} [templates] List of key/value pairs to be added to mw#templates.
1954 */
1955 implement: function ( module, script, style, messages, templates ) {
1956 var split = splitModuleKey( module ),
1957 name = split.name,
1958 version = split.version;
1959 // Automatically register module
1960 if ( !hasOwn.call( registry, name ) ) {
1961 mw.loader.register( name );
1962 }
1963 // Check for duplicate implementation
1964 if ( hasOwn.call( registry, name ) && registry[ name ].script !== undefined ) {
1965 throw new Error( 'module already implemented: ' + name );
1966 }
1967 if ( version ) {
1968 // Without this reset, if there is a version mismatch between the
1969 // requested and received module version, then mw.loader.store would
1970 // cache the response under the requested key. Thus poisoning the cache
1971 // indefinitely with a stale value. (T117587)
1972 registry[ name ].version = version;
1973 }
1974 // Attach components
1975 registry[ name ].script = script || null;
1976 registry[ name ].style = style || null;
1977 registry[ name ].messages = messages || null;
1978 registry[ name ].templates = templates || null;
1979 // The module may already have been marked as erroneous
1980 if ( registry[ name ].state !== 'error' && registry[ name ].state !== 'missing' ) {
1981 registry[ name ].state = 'loaded';
1982 if ( allReady( registry[ name ].dependencies ) ) {
1983 execute( name );
1984 }
1985 }
1986 },
1987
1988 /**
1989 * Execute a function as soon as one or more required modules are ready.
1990 *
1991 * Example of inline dependency on OOjs:
1992 *
1993 * mw.loader.using( 'oojs', function () {
1994 * OO.compare( [ 1 ], [ 1 ] );
1995 * } );
1996 *
1997 * Example of inline dependency obtained via `require()`:
1998 *
1999 * mw.loader.using( [ 'mediawiki.util' ], function ( require ) {
2000 * var util = require( 'mediawiki.util' );
2001 * } );
2002 *
2003 * Since MediaWiki 1.23 this also returns a promise.
2004 *
2005 * Since MediaWiki 1.28 the promise is resolved with a `require` function.
2006 *
2007 * @param {string|Array} dependencies Module name or array of modules names the
2008 * callback depends on to be ready before executing
2009 * @param {Function} [ready] Callback to execute when all dependencies are ready
2010 * @param {Function} [error] Callback to execute if one or more dependencies failed
2011 * @return {jQuery.Promise} With a `require` function
2012 */
2013 using: function ( dependencies, ready, error ) {
2014 var deferred = $.Deferred();
2015
2016 // Allow calling with a single dependency as a string
2017 if ( typeof dependencies === 'string' ) {
2018 dependencies = [ dependencies ];
2019 }
2020
2021 if ( ready ) {
2022 deferred.done( ready );
2023 }
2024 if ( error ) {
2025 deferred.fail( error );
2026 }
2027
2028 try {
2029 // Resolve entire dependency map
2030 dependencies = resolve( dependencies );
2031 } catch ( e ) {
2032 return deferred.reject( e ).promise();
2033 }
2034 if ( allReady( dependencies ) ) {
2035 // Run ready immediately
2036 deferred.resolve( mw.loader.require );
2037 } else if ( anyFailed( dependencies ) ) {
2038 // Execute error immediately if any dependencies have errors
2039 deferred.reject(
2040 new Error( 'One or more dependencies failed to load' ),
2041 dependencies
2042 );
2043 } else {
2044 // Not all dependencies are ready, add to the load queue
2045 enqueue( dependencies, function () {
2046 deferred.resolve( mw.loader.require );
2047 }, deferred.reject );
2048 }
2049
2050 return deferred.promise();
2051 },
2052
2053 /**
2054 * Load an external script or one or more modules.
2055 *
2056 * This method takes a list of unrelated modules. Use cases:
2057 *
2058 * - A web page will be composed of many different widgets. These widgets independently
2059 * queue their ResourceLoader modules (`OutputPage::addModules()`). If any of them
2060 * have problems, or are no longer known (e.g. cached HTML), the other modules
2061 * should still be loaded.
2062 * - This method is used for preloading, which must not throw. Later code that
2063 * calls #using() will handle the error.
2064 *
2065 * @param {string|Array} modules Either the name of a module, array of modules,
2066 * or a URL of an external script or style
2067 * @param {string} [type='text/javascript'] MIME type to use if calling with a URL of an
2068 * external script or style; acceptable values are "text/css" and
2069 * "text/javascript"; if no type is provided, text/javascript is assumed.
2070 */
2071 load: function ( modules, type ) {
2072 var filtered, l;
2073
2074 // Allow calling with a url or single dependency as a string
2075 if ( typeof modules === 'string' ) {
2076 // "https://example.org/x.js", "http://example.org/x.js", "//example.org/x.js", "/x.js"
2077 if ( /^(https?:)?\/?\//.test( modules ) ) {
2078 if ( type === 'text/css' ) {
2079 l = document.createElement( 'link' );
2080 l.rel = 'stylesheet';
2081 l.href = modules;
2082 document.head.appendChild( l );
2083 return;
2084 }
2085 if ( type === 'text/javascript' || type === undefined ) {
2086 addScript( modules );
2087 return;
2088 }
2089 // Unknown type
2090 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type );
2091 }
2092 // Called with single module
2093 modules = [ modules ];
2094 }
2095
2096 // Filter out top-level modules that are unknown or failed to load before.
2097 filtered = modules.filter( function ( module ) {
2098 var state = mw.loader.getState( module );
2099 return state !== 'error' && state !== 'missing';
2100 } );
2101 // Resolve remaining list using the known dependency tree.
2102 // This also filters out modules with unknown dependencies. (T36853)
2103 filtered = resolveStubbornly( filtered );
2104 // If all modules are ready, or if any modules have errors, nothing to be done.
2105 if ( allReady( filtered ) || anyFailed( filtered ) ) {
2106 return;
2107 }
2108 if ( filtered.length === 0 ) {
2109 return;
2110 }
2111 // Some modules are not yet ready, add to module load queue.
2112 enqueue( filtered, undefined, undefined );
2113 },
2114
2115 /**
2116 * Change the state of one or more modules.
2117 *
2118 * @param {string|Object} module Module name or object of module name/state pairs
2119 * @param {string} state State name
2120 */
2121 state: function ( module, state ) {
2122 var m;
2123
2124 if ( typeof module === 'object' ) {
2125 for ( m in module ) {
2126 mw.loader.state( m, module[ m ] );
2127 }
2128 return;
2129 }
2130 if ( !hasOwn.call( registry, module ) ) {
2131 mw.loader.register( module );
2132 }
2133 registry[ module ].state = state;
2134 if ( state === 'ready' || state === 'error' || state === 'missing' ) {
2135 // Make sure pending modules depending on this one get executed if their
2136 // dependencies are now fulfilled!
2137 handlePending( module );
2138 }
2139 },
2140
2141 /**
2142 * Get the version of a module.
2143 *
2144 * @param {string} module Name of module
2145 * @return {string|null} The version, or null if the module (or its version) is not
2146 * in the registry.
2147 */
2148 getVersion: function ( module ) {
2149 return hasOwn.call( registry, module ) ? registry[ module ].version : null;
2150 },
2151
2152 /**
2153 * Get the state of a module.
2154 *
2155 * @param {string} module Name of module
2156 * @return {string|null} The state, or null if the module (or its state) is not
2157 * in the registry.
2158 */
2159 getState: function ( module ) {
2160 return hasOwn.call( registry, module ) ? registry[ module ].state : null;
2161 },
2162
2163 /**
2164 * Get the names of all registered modules.
2165 *
2166 * @return {Array}
2167 */
2168 getModuleNames: function () {
2169 return Object.keys( registry );
2170 },
2171
2172 /**
2173 * Get the exported value of a module.
2174 *
2175 * This static method is publicly exposed for debugging purposes
2176 * only and must not be used in production code. In production code,
2177 * please use the dynamically provided `require()` function instead.
2178 *
2179 * In case of lazy-loaded modules via mw.loader#using(), the returned
2180 * Promise provides the function, see #using() for examples.
2181 *
2182 * @private
2183 * @since 1.27
2184 * @param {string} moduleName Module name
2185 * @return {Mixed} Exported value
2186 */
2187 require: function ( moduleName ) {
2188 var state = mw.loader.getState( moduleName );
2189
2190 // Only ready modules can be required
2191 if ( state !== 'ready' ) {
2192 // Module may've forgotten to declare a dependency
2193 throw new Error( 'Module "' + moduleName + '" is not loaded.' );
2194 }
2195
2196 return registry[ moduleName ].module.exports;
2197 },
2198
2199 /**
2200 * @inheritdoc mw.inspect#runReports
2201 * @method
2202 */
2203 inspect: function () {
2204 var args = slice.call( arguments );
2205 mw.loader.using( 'mediawiki.inspect', function () {
2206 mw.inspect.runReports.apply( mw.inspect, args );
2207 } );
2208 },
2209
2210 /**
2211 * On browsers that implement the localStorage API, the module store serves as a
2212 * smart complement to the browser cache. Unlike the browser cache, the module store
2213 * can slice a concatenated response from ResourceLoader into its constituent
2214 * modules and cache each of them separately, using each module's versioning scheme
2215 * to determine when the cache should be invalidated.
2216 *
2217 * @singleton
2218 * @class mw.loader.store
2219 */
2220 store: {
2221 // Whether the store is in use on this page.
2222 enabled: null,
2223
2224 // Modules whose string representation exceeds 100 kB are
2225 // ineligible for storage. See bug T66721.
2226 MODULE_SIZE_MAX: 100 * 1000,
2227
2228 // The contents of the store, mapping '[name]@[version]' keys
2229 // to module implementations.
2230 items: {},
2231
2232 // Cache hit stats
2233 stats: { hits: 0, misses: 0, expired: 0, failed: 0 },
2234
2235 /**
2236 * Construct a JSON-serializable object representing the content of the store.
2237 *
2238 * @return {Object} Module store contents.
2239 */
2240 toJSON: function () {
2241 return { items: mw.loader.store.items, vary: mw.loader.store.getVary() };
2242 },
2243
2244 /**
2245 * Get the localStorage key for the entire module store. The key references
2246 * $wgDBname to prevent clashes between wikis which share a common host.
2247 *
2248 * @return {string} localStorage item key
2249 */
2250 getStoreKey: function () {
2251 return 'MediaWikiModuleStore:' + mw.config.get( 'wgDBname' );
2252 },
2253
2254 /**
2255 * Get a key on which to vary the module cache.
2256 *
2257 * @return {string} String of concatenated vary conditions.
2258 */
2259 getVary: function () {
2260 return [
2261 mw.config.get( 'skin' ),
2262 mw.config.get( 'wgResourceLoaderStorageVersion' ),
2263 mw.config.get( 'wgUserLanguage' )
2264 ].join( ':' );
2265 },
2266
2267 /**
2268 * Initialize the store.
2269 *
2270 * Retrieves store from localStorage and (if successfully retrieved) decoding
2271 * the stored JSON value to a plain object.
2272 *
2273 * The try / catch block is used for JSON & localStorage feature detection.
2274 * See the in-line documentation for Modernizr's localStorage feature detection
2275 * code for a full account of why we need a try / catch:
2276 * <https://github.com/Modernizr/Modernizr/blob/v2.7.1/modernizr.js#L771-L796>.
2277 */
2278 init: function () {
2279 var raw, data;
2280
2281 if ( mw.loader.store.enabled !== null ) {
2282 // Init already ran
2283 return;
2284 }
2285
2286 if (
2287 // Disabled because localStorage quotas are tight and (in Firefox's case)
2288 // shared by multiple origins.
2289 // See T66721, and <https://bugzilla.mozilla.org/show_bug.cgi?id=1064466>.
2290 /Firefox|Opera/.test( navigator.userAgent ) ||
2291
2292 // Disabled by configuration.
2293 !mw.config.get( 'wgResourceLoaderStorageEnabled' )
2294 ) {
2295 // Clear any previous store to free up space. (T66721)
2296 mw.loader.store.clear();
2297 mw.loader.store.enabled = false;
2298 return;
2299 }
2300 if ( mw.config.get( 'debug' ) ) {
2301 // Disable module store in debug mode
2302 mw.loader.store.enabled = false;
2303 return;
2304 }
2305
2306 try {
2307 raw = localStorage.getItem( mw.loader.store.getStoreKey() );
2308 // If we get here, localStorage is available; mark enabled
2309 mw.loader.store.enabled = true;
2310 data = JSON.parse( raw );
2311 if ( data && typeof data.items === 'object' && data.vary === mw.loader.store.getVary() ) {
2312 mw.loader.store.items = data.items;
2313 return;
2314 }
2315 } catch ( e ) {
2316 mw.track( 'resourceloader.exception', { exception: e, source: 'store-localstorage-init' } );
2317 }
2318
2319 if ( raw === undefined ) {
2320 // localStorage failed; disable store
2321 mw.loader.store.enabled = false;
2322 } else {
2323 mw.loader.store.update();
2324 }
2325 },
2326
2327 /**
2328 * Retrieve a module from the store and update cache hit stats.
2329 *
2330 * @param {string} module Module name
2331 * @return {string|boolean} Module implementation or false if unavailable
2332 */
2333 get: function ( module ) {
2334 var key;
2335
2336 if ( !mw.loader.store.enabled ) {
2337 return false;
2338 }
2339
2340 key = getModuleKey( module );
2341 if ( key in mw.loader.store.items ) {
2342 mw.loader.store.stats.hits++;
2343 return mw.loader.store.items[ key ];
2344 }
2345 mw.loader.store.stats.misses++;
2346 return false;
2347 },
2348
2349 /**
2350 * Stringify a module and queue it for storage.
2351 *
2352 * @param {string} module Module name
2353 * @param {Object} descriptor The module's descriptor as set in the registry
2354 * @return {boolean} Module was set
2355 */
2356 set: function ( module, descriptor ) {
2357 var args, key, src;
2358
2359 if ( !mw.loader.store.enabled ) {
2360 return false;
2361 }
2362
2363 key = getModuleKey( module );
2364
2365 if (
2366 // Already stored a copy of this exact version
2367 key in mw.loader.store.items ||
2368 // Module failed to load
2369 descriptor.state !== 'ready' ||
2370 // Unversioned, private, or site-/user-specific
2371 !descriptor.version ||
2372 descriptor.group === 'private' ||
2373 descriptor.group === 'user' ||
2374 // Partial descriptor
2375 // (e.g. skipped module, or style module with state=ready)
2376 [ descriptor.script, descriptor.style, descriptor.messages,
2377 descriptor.templates ].indexOf( undefined ) !== -1
2378 ) {
2379 // Decline to store
2380 return false;
2381 }
2382
2383 try {
2384 args = [
2385 JSON.stringify( key ),
2386 typeof descriptor.script === 'function' ?
2387 String( descriptor.script ) :
2388 JSON.stringify( descriptor.script ),
2389 JSON.stringify( descriptor.style ),
2390 JSON.stringify( descriptor.messages ),
2391 JSON.stringify( descriptor.templates )
2392 ];
2393 // Attempted workaround for a possible Opera bug (bug T59567).
2394 // This regex should never match under sane conditions.
2395 if ( /^\s*\(/.test( args[ 1 ] ) ) {
2396 args[ 1 ] = 'function' + args[ 1 ];
2397 mw.track( 'resourceloader.assert', { source: 'bug-T59567' } );
2398 }
2399 } catch ( e ) {
2400 mw.track( 'resourceloader.exception', { exception: e, source: 'store-localstorage-json' } );
2401 return false;
2402 }
2403
2404 src = 'mw.loader.implement(' + args.join( ',' ) + ');';
2405 if ( src.length > mw.loader.store.MODULE_SIZE_MAX ) {
2406 return false;
2407 }
2408 mw.loader.store.items[ key ] = src;
2409 mw.loader.store.update();
2410 return true;
2411 },
2412
2413 /**
2414 * Iterate through the module store, removing any item that does not correspond
2415 * (in name and version) to an item in the module registry.
2416 *
2417 * @return {boolean} Store was pruned
2418 */
2419 prune: function () {
2420 var key, module;
2421
2422 if ( !mw.loader.store.enabled ) {
2423 return false;
2424 }
2425
2426 for ( key in mw.loader.store.items ) {
2427 module = key.slice( 0, key.indexOf( '@' ) );
2428 if ( getModuleKey( module ) !== key ) {
2429 mw.loader.store.stats.expired++;
2430 delete mw.loader.store.items[ key ];
2431 } else if ( mw.loader.store.items[ key ].length > mw.loader.store.MODULE_SIZE_MAX ) {
2432 // This value predates the enforcement of a size limit on cached modules.
2433 delete mw.loader.store.items[ key ];
2434 }
2435 }
2436 return true;
2437 },
2438
2439 /**
2440 * Clear the entire module store right now.
2441 */
2442 clear: function () {
2443 mw.loader.store.items = {};
2444 try {
2445 localStorage.removeItem( mw.loader.store.getStoreKey() );
2446 } catch ( ignored ) {}
2447 },
2448
2449 /**
2450 * Sync in-memory store back to localStorage.
2451 *
2452 * This function debounces updates. When called with a flush already pending,
2453 * the call is coalesced into the pending update. The call to
2454 * localStorage.setItem will be naturally deferred until the page is quiescent.
2455 *
2456 * Because localStorage is shared by all pages from the same origin, if multiple
2457 * pages are loaded with different module sets, the possibility exists that
2458 * modules saved by one page will be clobbered by another. But the impact would
2459 * be minor and the problem would be corrected by subsequent page views.
2460 *
2461 * @method
2462 */
2463 update: ( function () {
2464 var hasPendingWrite = false;
2465
2466 function flushWrites() {
2467 var data, key;
2468 if ( !hasPendingWrite || !mw.loader.store.enabled ) {
2469 return;
2470 }
2471
2472 mw.loader.store.prune();
2473 key = mw.loader.store.getStoreKey();
2474 try {
2475 // Replacing the content of the module store might fail if the new
2476 // contents would exceed the browser's localStorage size limit. To
2477 // avoid clogging the browser with stale data, always remove the old
2478 // value before attempting to set the new one.
2479 localStorage.removeItem( key );
2480 data = JSON.stringify( mw.loader.store );
2481 localStorage.setItem( key, data );
2482 } catch ( e ) {
2483 mw.track( 'resourceloader.exception', { exception: e, source: 'store-localstorage-update' } );
2484 }
2485
2486 hasPendingWrite = false;
2487 }
2488
2489 return function () {
2490 if ( !hasPendingWrite ) {
2491 hasPendingWrite = true;
2492 mw.requestIdleCallback( flushWrites );
2493 }
2494 };
2495 }() )
2496 }
2497 };
2498 }() ),
2499
2500 /**
2501 * HTML construction helper functions
2502 *
2503 * @example
2504 *
2505 * var Html, output;
2506 *
2507 * Html = mw.html;
2508 * output = Html.element( 'div', {}, new Html.Raw(
2509 * Html.element( 'img', { src: '<' } )
2510 * ) );
2511 * mw.log( output ); // <div><img src="&lt;"/></div>
2512 *
2513 * @class mw.html
2514 * @singleton
2515 */
2516 html: ( function () {
2517 function escapeCallback( s ) {
2518 switch ( s ) {
2519 case '\'':
2520 return '&#039;';
2521 case '"':
2522 return '&quot;';
2523 case '<':
2524 return '&lt;';
2525 case '>':
2526 return '&gt;';
2527 case '&':
2528 return '&amp;';
2529 }
2530 }
2531
2532 return {
2533 /**
2534 * Escape a string for HTML.
2535 *
2536 * Converts special characters to HTML entities.
2537 *
2538 * mw.html.escape( '< > \' & "' );
2539 * // Returns &lt; &gt; &#039; &amp; &quot;
2540 *
2541 * @param {string} s The string to escape
2542 * @return {string} HTML
2543 */
2544 escape: function ( s ) {
2545 return s.replace( /['"<>&]/g, escapeCallback );
2546 },
2547
2548 /**
2549 * Create an HTML element string, with safe escaping.
2550 *
2551 * @param {string} name The tag name.
2552 * @param {Object} [attrs] An object with members mapping element names to values
2553 * @param {string|mw.html.Raw|mw.html.Cdata|null} [contents=null] The contents of the element.
2554 *
2555 * - string: Text to be escaped.
2556 * - null: The element is treated as void with short closing form, e.g. `<br/>`.
2557 * - this.Raw: The raw value is directly included.
2558 * - this.Cdata: The raw value is directly included. An exception is
2559 * thrown if it contains any illegal ETAGO delimiter.
2560 * See <https://www.w3.org/TR/html401/appendix/notes.html#h-B.3.2>.
2561 * @return {string} HTML
2562 */
2563 element: function ( name, attrs, contents ) {
2564 var v, attrName, s = '<' + name;
2565
2566 if ( attrs ) {
2567 for ( attrName in attrs ) {
2568 v = attrs[ attrName ];
2569 // Convert name=true, to name=name
2570 if ( v === true ) {
2571 v = attrName;
2572 // Skip name=false
2573 } else if ( v === false ) {
2574 continue;
2575 }
2576 s += ' ' + attrName + '="' + this.escape( String( v ) ) + '"';
2577 }
2578 }
2579 if ( contents === undefined || contents === null ) {
2580 // Self close tag
2581 s += '/>';
2582 return s;
2583 }
2584 // Regular open tag
2585 s += '>';
2586 switch ( typeof contents ) {
2587 case 'string':
2588 // Escaped
2589 s += this.escape( contents );
2590 break;
2591 case 'number':
2592 case 'boolean':
2593 // Convert to string
2594 s += String( contents );
2595 break;
2596 default:
2597 if ( contents instanceof this.Raw ) {
2598 // Raw HTML inclusion
2599 s += contents.value;
2600 } else if ( contents instanceof this.Cdata ) {
2601 // CDATA
2602 if ( /<\/[a-zA-z]/.test( contents.value ) ) {
2603 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
2604 }
2605 s += contents.value;
2606 } else {
2607 throw new Error( 'mw.html.element: Invalid type of contents' );
2608 }
2609 }
2610 s += '</' + name + '>';
2611 return s;
2612 },
2613
2614 /**
2615 * Wrapper object for raw HTML passed to mw.html.element().
2616 *
2617 * @class mw.html.Raw
2618 * @constructor
2619 * @param {string} value
2620 */
2621 Raw: function ( value ) {
2622 this.value = value;
2623 },
2624
2625 /**
2626 * Wrapper object for CDATA element contents passed to mw.html.element()
2627 *
2628 * @class mw.html.Cdata
2629 * @constructor
2630 * @param {string} value
2631 */
2632 Cdata: function ( value ) {
2633 this.value = value;
2634 }
2635 };
2636 }() ),
2637
2638 // Skeleton user object, extended by the 'mediawiki.user' module.
2639 /**
2640 * @class mw.user
2641 * @singleton
2642 */
2643 user: {
2644 /**
2645 * @property {mw.Map}
2646 */
2647 options: new Map(),
2648 /**
2649 * @property {mw.Map}
2650 */
2651 tokens: new Map()
2652 },
2653
2654 // OOUI widgets specific to MediaWiki
2655 widgets: {},
2656
2657 /**
2658 * Registry and firing of events.
2659 *
2660 * MediaWiki has various interface components that are extended, enhanced
2661 * or manipulated in some other way by extensions, gadgets and even
2662 * in core itself.
2663 *
2664 * This framework helps streamlining the timing of when these other
2665 * code paths fire their plugins (instead of using document-ready,
2666 * which can and should be limited to firing only once).
2667 *
2668 * Features like navigating to other wiki pages, previewing an edit
2669 * and editing itself – without a refresh – can then retrigger these
2670 * hooks accordingly to ensure everything still works as expected.
2671 *
2672 * Example usage:
2673 *
2674 * mw.hook( 'wikipage.content' ).add( fn ).remove( fn );
2675 * mw.hook( 'wikipage.content' ).fire( $content );
2676 *
2677 * Handlers can be added and fired for arbitrary event names at any time. The same
2678 * event can be fired multiple times. The last run of an event is memorized
2679 * (similar to `$(document).ready` and `$.Deferred().done`).
2680 * This means if an event is fired, and a handler added afterwards, the added
2681 * function will be fired right away with the last given event data.
2682 *
2683 * Like Deferreds and Promises, the mw.hook object is both detachable and chainable.
2684 * Thus allowing flexible use and optimal maintainability and authority control.
2685 * You can pass around the `add` and/or `fire` method to another piece of code
2686 * without it having to know the event name (or `mw.hook` for that matter).
2687 *
2688 * var h = mw.hook( 'bar.ready' );
2689 * new mw.Foo( .. ).fetch( { callback: h.fire } );
2690 *
2691 * Note: Events are documented with an underscore instead of a dot in the event
2692 * name due to jsduck not supporting dots in that position.
2693 *
2694 * @class mw.hook
2695 */
2696 hook: ( function () {
2697 var lists = {};
2698
2699 /**
2700 * Create an instance of mw.hook.
2701 *
2702 * @method hook
2703 * @member mw
2704 * @param {string} name Name of hook.
2705 * @return {mw.hook}
2706 */
2707 return function ( name ) {
2708 var list = hasOwn.call( lists, name ) ?
2709 lists[ name ] :
2710 lists[ name ] = $.Callbacks( 'memory' );
2711
2712 return {
2713 /**
2714 * Register a hook handler
2715 *
2716 * @param {...Function} handler Function to bind.
2717 * @chainable
2718 */
2719 add: list.add,
2720
2721 /**
2722 * Unregister a hook handler
2723 *
2724 * @param {...Function} handler Function to unbind.
2725 * @chainable
2726 */
2727 remove: list.remove,
2728
2729 // eslint-disable-next-line valid-jsdoc
2730 /**
2731 * Run a hook.
2732 *
2733 * @param {...Mixed} data
2734 * @chainable
2735 */
2736 fire: function () {
2737 return list.fireWith.call( this, null, slice.call( arguments ) );
2738 }
2739 };
2740 };
2741 }() )
2742 };
2743
2744 // Alias $j to jQuery for backwards compatibility
2745 // @deprecated since 1.23 Use $ or jQuery instead
2746 mw.log.deprecate( window, '$j', $, 'Use $ or jQuery instead.' );
2747
2748 /**
2749 * Log a message to window.console, if possible.
2750 *
2751 * Useful to force logging of some errors that are otherwise hard to detect (i.e., this logs
2752 * also in production mode). Gets console references in each invocation instead of caching the
2753 * reference, so that debugging tools loaded later are supported (e.g. Firebug Lite in IE).
2754 *
2755 * @private
2756 * @param {string} topic Stream name passed by mw.track
2757 * @param {Object} data Data passed by mw.track
2758 * @param {Error} [data.exception]
2759 * @param {string} data.source Error source
2760 * @param {string} [data.module] Name of module which caused the error
2761 */
2762 function logError( topic, data ) {
2763 /* eslint-disable no-console */
2764 var msg,
2765 e = data.exception,
2766 source = data.source,
2767 module = data.module,
2768 console = window.console;
2769
2770 if ( console && console.log ) {
2771 msg = ( e ? 'Exception' : 'Error' ) + ' in ' + source;
2772 if ( module ) {
2773 msg += ' in module ' + module;
2774 }
2775 msg += ( e ? ':' : '.' );
2776 console.log( msg );
2777
2778 // If we have an exception object, log it to the warning channel to trigger
2779 // proper stacktraces in browsers that support it.
2780 if ( e && console.warn ) {
2781 console.warn( e );
2782 }
2783 }
2784 /* eslint-enable no-console */
2785 }
2786
2787 // Subscribe to error streams
2788 mw.trackSubscribe( 'resourceloader.exception', logError );
2789 mw.trackSubscribe( 'resourceloader.assert', logError );
2790
2791 /**
2792 * Fired when all modules associated with the page have finished loading.
2793 *
2794 * @event resourceloader_loadEnd
2795 * @member mw.hook
2796 */
2797 $( function () {
2798 var loading, modules;
2799
2800 modules = mw.loader.getModuleNames().filter( function ( module ) {
2801 return mw.loader.getState( module ) === 'loading';
2802 } );
2803 // We only need a callback, not any actual module. First try a single using()
2804 // for all loading modules. If one fails, fall back to tracking each module
2805 // separately via $.when(), this is expensive.
2806 loading = mw.loader.using( modules ).catch( function () {
2807 var all = modules.map( function ( module ) {
2808 return mw.loader.using( module ).catch( function () {
2809 return $.Deferred().resolve();
2810 } );
2811 } );
2812 return $.when.apply( $, all );
2813 } );
2814 loading.then( function () {
2815 if ( window.performance && performance.mark ) {
2816 performance.mark( 'mwLoadEnd' );
2817 }
2818 mw.hook( 'resourceloader.loadEnd' ).fire();
2819 } );
2820 } );
2821
2822 // Attach to window and globally alias
2823 window.mw = window.mediaWiki = mw;
2824 }( jQuery ) );