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