b2aff4361ceb80e3e2f86af31a38fafdd00b2a50
[lhc/web/wiklou.git] / resources / src / startup / mediawiki.js
1 /**
2 * Base library for MediaWiki.
3 *
4 * Exposed globally as `mw`, with `mediaWiki` as alias.
5 *
6 * @class mw
7 * @alternateClassName mediaWiki
8 * @singleton
9 */
10 /* global $VARS, $CODE */
11
12 ( function () {
13 'use strict';
14
15 var mw, StringSet, log,
16 hasOwn = Object.prototype.hasOwnProperty,
17 trackQueue = [];
18
19 /**
20 * FNV132 hash function
21 *
22 * This function implements the 32-bit version of FNV-1.
23 * It is equivalent to hash( 'fnv132', ... ) in PHP, except
24 * its output is base 36 rather than hex.
25 * See <https://en.wikipedia.org/wiki/FNV_hash_function>
26 *
27 * @private
28 * @param {string} str String to hash
29 * @return {string} hash as an seven-character base 36 string
30 */
31 function fnv132( str ) {
32 /* eslint-disable no-bitwise */
33 var hash = 0x811C9DC5,
34 i;
35
36 for ( i = 0; i < str.length; i++ ) {
37 hash += ( hash << 1 ) + ( hash << 4 ) + ( hash << 7 ) + ( hash << 8 ) + ( hash << 24 );
38 hash ^= str.charCodeAt( i );
39 }
40
41 hash = ( hash >>> 0 ).toString( 36 );
42 while ( hash.length < 7 ) {
43 hash = '0' + hash;
44 }
45
46 return hash;
47 /* eslint-enable no-bitwise */
48 }
49
50 function defineFallbacks() {
51 // <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set>
52 StringSet = window.Set || ( function () {
53 /**
54 * @private
55 * @class
56 */
57 function StringSet() {
58 this.set = Object.create( null );
59 }
60 StringSet.prototype.add = function ( value ) {
61 this.set[ value ] = true;
62 };
63 StringSet.prototype.has = function ( value ) {
64 return value in this.set;
65 };
66 return StringSet;
67 }() );
68 }
69
70 /**
71 * Alias property to the global object.
72 *
73 * @private
74 * @static
75 * @member mw.Map
76 * @param {mw.Map} map
77 * @param {string} key
78 * @param {Mixed} value
79 */
80 function setGlobalMapValue( map, key, value ) {
81 map.values[ key ] = value;
82 log.deprecate(
83 window,
84 key,
85 value,
86 // Deprecation notice for mw.config globals (T58550, T72470)
87 map === mw.config && 'Use mw.config instead.'
88 );
89 }
90
91 /**
92 * Log a message to window.console, if possible.
93 *
94 * Useful to force logging of some errors that are otherwise hard to detect (i.e., this logs
95 * also in production mode). Gets console references in each invocation instead of caching the
96 * reference, so that debugging tools loaded later are supported (e.g. Firebug Lite in IE).
97 *
98 * @private
99 * @param {string} topic Stream name passed by mw.track
100 * @param {Object} data Data passed by mw.track
101 * @param {Error} [data.exception]
102 * @param {string} data.source Error source
103 * @param {string} [data.module] Name of module which caused the error
104 */
105 function logError( topic, data ) {
106 /* eslint-disable no-console */
107 var msg,
108 e = data.exception,
109 source = data.source,
110 module = data.module,
111 console = window.console;
112
113 if ( console && console.log ) {
114 msg = ( e ? 'Exception' : 'Error' ) + ' in ' + source;
115 if ( module ) {
116 msg += ' in module ' + module;
117 }
118 msg += ( e ? ':' : '.' );
119 console.log( msg );
120
121 // If we have an exception object, log it to the warning channel to trigger
122 // proper stacktraces in browsers that support it.
123 if ( e && console.warn ) {
124 console.warn( e );
125 }
126 }
127 /* eslint-enable no-console */
128 }
129
130 /**
131 * Create an object that can be read from or written to via methods that allow
132 * interaction both with single and multiple properties at once.
133 *
134 * @private
135 * @class mw.Map
136 *
137 * @constructor
138 * @param {boolean} [global=false] Whether to synchronise =values to the global
139 * window object (for backwards-compatibility with mw.config; T72470). Values are
140 * copied in one direction only. Changes to globals do not reflect in the map.
141 */
142 function Map( global ) {
143 this.values = Object.create( null );
144 if ( global === true ) {
145 // Override #set to also set the global variable
146 this.set = function ( selection, value ) {
147 var s;
148 if ( arguments.length > 1 ) {
149 if ( typeof selection !== 'string' ) {
150 return false;
151 }
152 setGlobalMapValue( this, selection, value );
153 return true;
154 }
155 if ( typeof selection === 'object' ) {
156 for ( s in selection ) {
157 setGlobalMapValue( this, s, selection[ s ] );
158 }
159 return true;
160 }
161 return false;
162 };
163 }
164 }
165
166 Map.prototype = {
167 constructor: Map,
168
169 /**
170 * Get the value of one or more keys.
171 *
172 * If called with no arguments, all values are returned.
173 *
174 * @param {string|Array} [selection] Key or array of keys to retrieve values for.
175 * @param {Mixed} [fallback=null] Value for keys that don't exist.
176 * @return {Mixed|Object|null} If selection was a string, returns the value,
177 * If selection was an array, returns an object of key/values.
178 * If no selection is passed, a new object with all key/values is returned.
179 */
180 get: function ( selection, fallback ) {
181 var results, i;
182 fallback = arguments.length > 1 ? fallback : null;
183
184 if ( Array.isArray( selection ) ) {
185 results = {};
186 for ( i = 0; i < selection.length; i++ ) {
187 if ( typeof selection[ i ] === 'string' ) {
188 results[ selection[ i ] ] = selection[ i ] in this.values ?
189 this.values[ selection[ i ] ] :
190 fallback;
191 }
192 }
193 return results;
194 }
195
196 if ( typeof selection === 'string' ) {
197 return selection in this.values ?
198 this.values[ selection ] :
199 fallback;
200 }
201
202 if ( selection === undefined ) {
203 results = {};
204 for ( i in this.values ) {
205 results[ i ] = this.values[ i ];
206 }
207 return results;
208 }
209
210 // Invalid selection key
211 return fallback;
212 },
213
214 /**
215 * Set one or more key/value pairs.
216 *
217 * @param {string|Object} selection Key to set value for, or object mapping keys to values
218 * @param {Mixed} [value] Value to set (optional, only in use when key is a string)
219 * @return {boolean} True on success, false on failure
220 */
221 set: function ( selection, value ) {
222 var s;
223 // Use `arguments.length` because `undefined` is also a valid value.
224 if ( arguments.length > 1 ) {
225 if ( typeof selection !== 'string' ) {
226 return false;
227 }
228 this.values[ selection ] = value;
229 return true;
230 }
231 if ( typeof selection === 'object' ) {
232 for ( s in selection ) {
233 this.values[ s ] = selection[ s ];
234 }
235 return true;
236 }
237 return false;
238 },
239
240 /**
241 * Check if one or more keys exist.
242 *
243 * @param {Mixed} selection Key or array of keys to check
244 * @return {boolean} True if the key(s) exist
245 */
246 exists: function ( selection ) {
247 var i;
248 if ( Array.isArray( selection ) ) {
249 for ( i = 0; i < selection.length; i++ ) {
250 if ( typeof selection[ i ] !== 'string' || !( selection[ i ] in this.values ) ) {
251 return false;
252 }
253 }
254 return true;
255 }
256 return typeof selection === 'string' && selection in this.values;
257 }
258 };
259
260 defineFallbacks();
261
262 /* eslint-disable no-console */
263 log = ( function () {
264 /**
265 * Write a verbose message to the browser's console in debug mode.
266 *
267 * This method is mainly intended for verbose logging. It is a no-op in production mode.
268 * In ResourceLoader debug mode, it will use the browser's console if available, with
269 * fallback to creating a console interface in the DOM and logging messages there.
270 *
271 * See {@link mw.log} for other logging methods.
272 *
273 * @member mw
274 * @param {...string} msg Messages to output to console.
275 */
276 var log = function () {},
277 console = window.console;
278
279 // Note: Keep list of methods in sync with restoration in mediawiki.log.js
280 // when adding or removing mw.log methods below!
281
282 /**
283 * Collection of methods to help log messages to the console.
284 *
285 * @class mw.log
286 * @singleton
287 */
288
289 /**
290 * Write a message to the browser console's warning channel.
291 *
292 * This method is a no-op in browsers that don't implement the Console API.
293 *
294 * @param {...string} msg Messages to output to console
295 */
296 log.warn = console && console.warn && Function.prototype.bind ?
297 Function.prototype.bind.call( console.warn, console ) :
298 function () {};
299
300 /**
301 * Write a message to the browser console's error channel.
302 *
303 * Most browsers also print a stacktrace when calling this method if the
304 * argument is an Error object.
305 *
306 * This method is a no-op in browsers that don't implement the Console API.
307 *
308 * @since 1.26
309 * @param {...Mixed} msg Messages to output to console
310 */
311 log.error = console && console.error && Function.prototype.bind ?
312 Function.prototype.bind.call( console.error, console ) :
313 function () {};
314
315 /**
316 * Create a property on a host object that, when accessed, will produce
317 * a deprecation warning in the console.
318 *
319 * @param {Object} obj Host object of deprecated property
320 * @param {string} key Name of property to create in `obj`
321 * @param {Mixed} val The value this property should return when accessed
322 * @param {string} [msg] Optional text to include in the deprecation message
323 * @param {string} [logName=key] Optional custom name for the feature.
324 * This is used instead of `key` in the message and `mw.deprecate` tracking.
325 */
326 log.deprecate = !Object.defineProperty ? function ( obj, key, val ) {
327 obj[ key ] = val;
328 } : function ( obj, key, val, msg, logName ) {
329 var stacks;
330 function maybeLog() {
331 var name,
332 trace = new Error().stack;
333 if ( !stacks ) {
334 stacks = new StringSet();
335 }
336 if ( !stacks.has( trace ) ) {
337 stacks.add( trace );
338 name = logName || key;
339 mw.track( 'mw.deprecate', name );
340 mw.log.warn(
341 'Use of "' + name + '" is deprecated.' + ( msg ? ( ' ' + msg ) : '' )
342 );
343 }
344 }
345 // Support: Safari 5.0
346 // Throws "not supported on DOM Objects" for Node or Element objects (incl. document)
347 // Safari 4.0 doesn't have this method, and it was fixed in Safari 5.1.
348 try {
349 Object.defineProperty( obj, key, {
350 configurable: true,
351 enumerable: true,
352 get: function () {
353 maybeLog();
354 return val;
355 },
356 set: function ( newVal ) {
357 maybeLog();
358 val = newVal;
359 }
360 } );
361 } catch ( err ) {
362 obj[ key ] = val;
363 }
364 };
365
366 return log;
367 }() );
368 /* eslint-enable no-console */
369
370 /**
371 * @class mw
372 */
373 mw = {
374 redefineFallbacksForTest: function () {
375 if ( !window.QUnit ) {
376 throw new Error( 'Reset not allowed outside unit tests' );
377 }
378 defineFallbacks();
379 },
380
381 /**
382 * Get the current time, measured in milliseconds since January 1, 1970 (UTC).
383 *
384 * On browsers that implement the Navigation Timing API, this function will produce
385 * floating-point values with microsecond precision that are guaranteed to be monotonic.
386 * On all other browsers, it will fall back to using `Date`.
387 *
388 * @return {number} Current time
389 */
390 now: function () {
391 // Optimisation: Define the shortcut on first call, not at module definition.
392 var perf = window.performance,
393 navStart = perf && perf.timing && perf.timing.navigationStart;
394
395 // Define the relevant shortcut
396 mw.now = navStart && typeof perf.now === 'function' ?
397 function () { return navStart + perf.now(); } :
398 Date.now;
399
400 return mw.now();
401 },
402
403 /**
404 * List of all analytic events emitted so far.
405 *
406 * @private
407 * @property {Array}
408 */
409 trackQueue: trackQueue,
410
411 track: function ( topic, data ) {
412 trackQueue.push( { topic: topic, timeStamp: mw.now(), data: data } );
413 // The base module extends this method to fire events here
414 },
415
416 /**
417 * Track an early error event via mw.track and send it to the window console.
418 *
419 * @private
420 * @param {string} topic Topic name
421 * @param {Object} data Data describing the event, encoded as an object; see mw#logError
422 */
423 trackError: function ( topic, data ) {
424 mw.track( topic, data );
425 logError( topic, data );
426 },
427
428 // Expose Map constructor
429 Map: Map,
430
431 /**
432 * Map of configuration values.
433 *
434 * Check out [the complete list of configuration values](https://www.mediawiki.org/wiki/Manual:Interface/JavaScript#mw.config)
435 * on mediawiki.org.
436 *
437 * If `$wgLegacyJavaScriptGlobals` is true, this Map will add its values to the
438 * global `window` object.
439 *
440 * @property {mw.Map} config
441 */
442 // Dummy placeholder later assigned in ResourceLoaderStartUpModule
443 config: null,
444
445 /**
446 * Empty object for third-party libraries, for cases where you don't
447 * want to add a new global, or the global is bad and needs containment
448 * or wrapping.
449 *
450 * @property
451 */
452 libs: {},
453
454 /**
455 * Access container for deprecated functionality that can be moved from
456 * from their legacy location and attached to this object (e.g. a global
457 * function that is deprecated and as stop-gap can be exposed through here).
458 *
459 * This was reserved for future use but never ended up being used.
460 *
461 * @deprecated since 1.22 Let deprecated identifiers keep their original name
462 * and use mw.log#deprecate to create an access container for tracking.
463 * @property
464 */
465 legacy: {},
466
467 /**
468 * Store for messages.
469 *
470 * @property {mw.Map}
471 */
472 messages: new Map(),
473
474 /**
475 * Store for templates associated with a module.
476 *
477 * @property {mw.Map}
478 */
479 templates: new Map(),
480
481 // Expose mw.log
482 log: log,
483
484 /**
485 * Client for ResourceLoader server end point.
486 *
487 * This client is in charge of maintaining the module registry and state
488 * machine, initiating network (batch) requests for loading modules, as
489 * well as dependency resolution and execution of source code.
490 *
491 * For more information, refer to
492 * <https://www.mediawiki.org/wiki/ResourceLoader/Features>
493 *
494 * @class mw.loader
495 * @singleton
496 */
497 loader: ( function () {
498
499 /**
500 * Fired via mw.track on various resource loading errors.
501 *
502 * @event resourceloader_exception
503 * @param {Error|Mixed} e The error that was thrown. Almost always an Error
504 * object, but in theory module code could manually throw something else, and that
505 * might also end up here.
506 * @param {string} [module] Name of the module which caused the error. Omitted if the
507 * error is not module-related or the module cannot be easily identified due to
508 * batched handling.
509 * @param {string} source Source of the error. Possible values:
510 *
511 * - style: stylesheet error (only affects old IE where a special style loading method
512 * is used)
513 * - load-callback: exception thrown by user callback
514 * - module-execute: exception thrown by module code
515 * - resolve: failed to sort dependencies for a module in mw.loader.load
516 * - store-eval: could not evaluate module code cached in localStorage
517 * - store-localstorage-init: localStorage or JSON parse error in mw.loader.store.init
518 * - store-localstorage-json: JSON conversion error in mw.loader.store
519 * - store-localstorage-update: localStorage conversion error in mw.loader.store.
520 */
521
522 /**
523 * Fired via mw.track on resource loading error conditions.
524 *
525 * @event resourceloader_assert
526 * @param {string} source Source of the error. Possible values:
527 *
528 * - bug-T59567: failed to cache script due to an Opera function -> string conversion
529 * bug; see <https://phabricator.wikimedia.org/T59567> for details
530 */
531
532 /**
533 * Mapping of registered modules.
534 *
535 * See #implement and #execute for exact details on support for script, style and messages.
536 *
537 * Format:
538 *
539 * {
540 * 'moduleName': {
541 * // From mw.loader.register()
542 * 'version': '########' (hash)
543 * 'dependencies': ['required.foo', 'bar.also', ...]
544 * 'group': 'somegroup', (or) null
545 * 'source': 'local', (or) 'anotherwiki'
546 * 'skip': 'return !!window.Example', (or) null
547 * 'module': export Object
548 *
549 * // Set from execute() or mw.loader.state()
550 * 'state': 'registered', 'loaded', 'loading', 'ready', 'error', or 'missing'
551 *
552 * // Optionally added at run-time by mw.loader.implement()
553 * 'skipped': true
554 * 'script': closure, array of urls, or string
555 * 'style': { ... } (see #execute)
556 * 'messages': { 'key': 'value', ... }
557 * }
558 * }
559 *
560 * State machine:
561 *
562 * - `registered`:
563 * The module is known to the system but not yet required.
564 * Meta data is registered via mw.loader#register. Calls to that method are
565 * generated server-side by the startup module.
566 * - `loading`:
567 * The module was required through mw.loader (either directly or as dependency of
568 * another module). The client will fetch module contents from the server.
569 * The contents are then stashed in the registry via mw.loader#implement.
570 * - `loaded`:
571 * The module has been loaded from the server and stashed via mw.loader#implement.
572 * Once the module has no more dependencies in-flight, the module will be executed,
573 * controlled via #requestPropagation and #doPropagation.
574 * - `executing`:
575 * The module is being executed.
576 * - `ready`:
577 * The module has been successfully executed.
578 * - `error`:
579 * The module (or one of its dependencies) produced an error during execution.
580 * - `missing`:
581 * The module was registered client-side and requested, but the server denied knowledge
582 * of the module's existence.
583 *
584 * @property
585 * @private
586 */
587 var registry = {},
588 // Mapping of sources, keyed by source-id, values are strings.
589 //
590 // Format:
591 //
592 // {
593 // 'sourceId': 'http://example.org/w/load.php'
594 // }
595 //
596 sources = {},
597
598 // For queueModuleScript()
599 handlingPendingRequests = false,
600 pendingRequests = [],
601
602 // List of modules to be loaded
603 queue = [],
604
605 /**
606 * List of callback jobs waiting for modules to be ready.
607 *
608 * Jobs are created by #enqueue() and run by #doPropagation().
609 * Typically when a job is created for a module, the job's dependencies contain
610 * both the required module and all its recursive dependencies.
611 *
612 * Format:
613 *
614 * {
615 * 'dependencies': [ module names ],
616 * 'ready': Function callback
617 * 'error': Function callback
618 * }
619 *
620 * @property {Object[]} jobs
621 * @private
622 */
623 jobs = [],
624
625 // For #requestPropagation() and #doPropagation()
626 willPropagate = false,
627 errorModules = [],
628
629 /**
630 * @private
631 * @property {Array} baseModules
632 */
633 baseModules = $VARS.baseModules,
634
635 /**
636 * For #addEmbeddedCSS() and #addLink()
637 *
638 * @private
639 * @property {HTMLElement|null} marker
640 */
641 marker = document.querySelector( 'meta[name="ResourceLoaderDynamicStyles"]' ),
642
643 // For #addEmbeddedCSS()
644 nextCssBuffer,
645 rAF = window.requestAnimationFrame || setTimeout;
646
647 /**
648 * Create a new style element and add it to the DOM.
649 *
650 * @private
651 * @param {string} text CSS text
652 * @param {Node|null} [nextNode] The element where the style tag
653 * should be inserted before
654 * @return {HTMLElement} Reference to the created style element
655 */
656 function newStyleTag( text, nextNode ) {
657 var el = document.createElement( 'style' );
658 el.appendChild( document.createTextNode( text ) );
659 if ( nextNode && nextNode.parentNode ) {
660 nextNode.parentNode.insertBefore( el, nextNode );
661 } else {
662 document.head.appendChild( el );
663 }
664 return el;
665 }
666
667 /**
668 * @private
669 * @param {Object} cssBuffer
670 */
671 function flushCssBuffer( cssBuffer ) {
672 var i;
673 // Mark this object as inactive now so that further calls to addEmbeddedCSS() from
674 // the callbacks go to a new buffer instead of this one (T105973)
675 cssBuffer.active = false;
676 newStyleTag( cssBuffer.cssText, marker );
677 for ( i = 0; i < cssBuffer.callbacks.length; i++ ) {
678 cssBuffer.callbacks[ i ]();
679 }
680 }
681
682 /**
683 * Add a bit of CSS text to the current browser page.
684 *
685 * The creation and insertion of the `<style>` element is debounced for two reasons:
686 *
687 * - Performing the insertion before the next paint round via requestAnimationFrame
688 * avoids forced or wasted style recomputations, which are expensive in browsers.
689 * - Reduce how often new stylesheets are inserted by letting additional calls to this
690 * function accumulate into a buffer for at least one JavaScript tick. Modules are
691 * received from the server in batches, which means there is likely going to be many
692 * calls to this function in a row within the same tick / the same call stack.
693 * See also T47810.
694 *
695 * @private
696 * @param {string} cssText CSS text to be added in a `<style>` tag.
697 * @param {Function} callback Called after the insertion has occurred
698 */
699 function addEmbeddedCSS( cssText, callback ) {
700 // Create a buffer if:
701 // - We don't have one yet.
702 // - The previous one is closed.
703 // - The next CSS chunk syntactically needs to be at the start of a stylesheet (T37562).
704 if ( !nextCssBuffer || nextCssBuffer.active === false || cssText.slice( 0, '@import'.length ) === '@import' ) {
705 nextCssBuffer = {
706 cssText: '',
707 callbacks: [],
708 active: null
709 };
710 }
711
712 // Linebreak for somewhat distinguishable sections
713 nextCssBuffer.cssText += '\n' + cssText;
714 nextCssBuffer.callbacks.push( callback );
715
716 if ( nextCssBuffer.active === null ) {
717 nextCssBuffer.active = true;
718 // The flushCssBuffer callback has its parameter bound by reference, which means
719 // 1) We can still extend the buffer from our object reference after this point.
720 // 2) We can safely re-assign the variable (not the object) to start a new buffer.
721 rAF( flushCssBuffer.bind( null, nextCssBuffer ) );
722 }
723 }
724
725 /**
726 * @private
727 * @param {Array} modules List of module names
728 * @return {string} Hash of concatenated version hashes.
729 */
730 function getCombinedVersion( modules ) {
731 var hashes = modules.reduce( function ( result, module ) {
732 return result + registry[ module ].version;
733 }, '' );
734 return fnv132( hashes );
735 }
736
737 /**
738 * Determine whether all dependencies are in state 'ready', which means we may
739 * execute the module or job now.
740 *
741 * @private
742 * @param {Array} modules Names of modules to be checked
743 * @return {boolean} True if all modules are in state 'ready', false otherwise
744 */
745 function allReady( modules ) {
746 var i;
747 for ( i = 0; i < modules.length; i++ ) {
748 if ( mw.loader.getState( modules[ i ] ) !== 'ready' ) {
749 return false;
750 }
751 }
752 return true;
753 }
754
755 /**
756 * Determine whether all direct and base dependencies are in state 'ready'
757 *
758 * @private
759 * @param {string} module Name of the module to be checked
760 * @return {boolean} True if all direct/base dependencies are in state 'ready'; false otherwise
761 */
762 function allWithImplicitReady( module ) {
763 return allReady( registry[ module ].dependencies ) &&
764 ( baseModules.indexOf( module ) !== -1 || allReady( baseModules ) );
765 }
766
767 /**
768 * Determine whether all dependencies are in state 'ready', which means we may
769 * execute the module or job now.
770 *
771 * @private
772 * @param {Array} modules Names of modules to be checked
773 * @return {boolean} True if no modules are in state 'error' or 'missing', false otherwise
774 */
775 function anyFailed( modules ) {
776 var i, state;
777 for ( i = 0; i < modules.length; i++ ) {
778 state = mw.loader.getState( modules[ i ] );
779 if ( state === 'error' || state === 'missing' ) {
780 return true;
781 }
782 }
783 return false;
784 }
785
786 /**
787 * Handle propagation of module state changes and reactions to them.
788 *
789 * - When a module reaches a failure state, this should be propagated to
790 * modules that depend on the failed module.
791 * - When a module reaches a final state, pending job callbacks for the
792 * module from mw.loader.using() should be called.
793 * - When a module reaches the 'ready' state from #execute(), consider
794 * executing dependant modules now having their dependencies satisfied.
795 * - When a module reaches the 'loaded' state from mw.loader.implement,
796 * consider executing it, if it has no unsatisfied dependencies.
797 *
798 * @private
799 */
800 function doPropagation() {
801 var errorModule, baseModuleError, module, i, failed, job,
802 didPropagate = true;
803
804 // Keep going until the last iteration performed no actions.
805 do {
806 didPropagate = false;
807
808 // Stage 1: Propagate failures
809 while ( errorModules.length ) {
810 errorModule = errorModules.shift();
811 baseModuleError = baseModules.indexOf( errorModule ) !== -1;
812 for ( module in registry ) {
813 if ( registry[ module ].state !== 'error' && registry[ module ].state !== 'missing' ) {
814 if ( baseModuleError && baseModules.indexOf( module ) === -1 ) {
815 // Propate error from base module to all regular (non-base) modules
816 registry[ module ].state = 'error';
817 didPropagate = true;
818 } else if ( registry[ module ].dependencies.indexOf( errorModule ) !== -1 ) {
819 // Propagate error from dependency to depending module
820 registry[ module ].state = 'error';
821 // .. and propagate it further
822 errorModules.push( module );
823 didPropagate = true;
824 }
825 }
826 }
827 }
828
829 // Stage 2: Execute 'loaded' modules with no unsatisfied dependencies
830 for ( module in registry ) {
831 if ( registry[ module ].state === 'loaded' && allWithImplicitReady( module ) ) {
832 // Recursively execute all dependent modules that were already loaded
833 // (waiting for execution) and no longer have unsatisfied dependencies.
834 // Base modules may have dependencies amongst eachother to ensure correct
835 // execution order. Regular modules wait for all base modules.
836 // eslint-disable-next-line no-use-before-define
837 execute( module );
838 didPropagate = true;
839 }
840 }
841
842 // Stage 3: Invoke job callbacks that are no longer blocked
843 for ( i = 0; i < jobs.length; i++ ) {
844 job = jobs[ i ];
845 failed = anyFailed( job.dependencies );
846 if ( failed || allReady( job.dependencies ) ) {
847 jobs.splice( i, 1 );
848 i -= 1;
849 try {
850 if ( failed && job.error ) {
851 job.error( new Error( 'Module has failed dependencies' ), job.dependencies );
852 } else if ( !failed && job.ready ) {
853 job.ready();
854 }
855 } catch ( e ) {
856 // A user-defined callback raised an exception.
857 // Swallow it to protect our state machine!
858 mw.trackError( 'resourceloader.exception', {
859 exception: e,
860 source: 'load-callback'
861 } );
862 }
863 didPropagate = true;
864 }
865 }
866 } while ( didPropagate );
867
868 willPropagate = false;
869 }
870
871 /**
872 * Request a (debounced) call to doPropagation().
873 *
874 * @private
875 */
876 function requestPropagation() {
877 if ( willPropagate ) {
878 // Already scheduled, or, we're already in a doPropagation stack.
879 return;
880 }
881 willPropagate = true;
882 // Yield for two reasons:
883 // * Allow successive calls to mw.loader.implement() from the same
884 // load.php response, or from the same asyncEval() to be in the
885 // propagation batch.
886 // * Allow the browser to breathe between the reception of
887 // module source code and the execution of it.
888 //
889 // Use a high priority because the user may be waiting for interactions
890 // to start being possible. But, first provide a moment (up to 'timeout')
891 // for native input event handling (e.g. scrolling/typing/clicking).
892 mw.requestIdleCallback( doPropagation, { timeout: 1 } );
893 }
894
895 /**
896 * Update a module's state in the registry and make sure any neccesary
897 * propagation will occur. See #doPropagation for more about propagation.
898 * See #registry for more about how states are used.
899 *
900 * @private
901 * @param {string} module
902 * @param {string} state
903 */
904 function setAndPropagate( module, state ) {
905 registry[ module ].state = state;
906 if ( state === 'loaded' || state === 'ready' || state === 'error' || state === 'missing' ) {
907 if ( state === 'ready' ) {
908 // Queue to later be synced to the local module store.
909 mw.loader.store.add( module );
910 } else if ( state === 'error' || state === 'missing' ) {
911 errorModules.push( module );
912 }
913 requestPropagation();
914 }
915 }
916
917 /**
918 * Resolve dependencies and detect circular references.
919 *
920 * @private
921 * @param {string} module Name of the top-level module whose dependencies shall be
922 * resolved and sorted.
923 * @param {Array} resolved Returns a topological sort of the given module and its
924 * dependencies, such that later modules depend on earlier modules. The array
925 * contains the module names. If the array contains already some module names,
926 * this function appends its result to the pre-existing array.
927 * @param {StringSet} [unresolved] Used to track the current dependency
928 * chain, and to report loops in the dependency graph.
929 * @throws {Error} If any unregistered module or a dependency loop is encountered
930 */
931 function sortDependencies( module, resolved, unresolved ) {
932 var i, deps, skip;
933
934 if ( !hasOwn.call( registry, module ) ) {
935 throw new Error( 'Unknown dependency: ' + module );
936 }
937
938 if ( registry[ module ].skip !== null ) {
939 // eslint-disable-next-line no-new-func
940 skip = new Function( registry[ module ].skip );
941 registry[ module ].skip = null;
942 if ( skip() ) {
943 registry[ module ].skipped = true;
944 registry[ module ].dependencies = [];
945 setAndPropagate( module, 'ready' );
946 return;
947 }
948 }
949
950 if ( resolved.indexOf( module ) !== -1 ) {
951 // Module already resolved; nothing to do
952 return;
953 }
954 // Create unresolved if not passed in
955 if ( !unresolved ) {
956 unresolved = new StringSet();
957 }
958
959 // Add base modules
960 if ( baseModules.indexOf( module ) === -1 ) {
961 baseModules.forEach( function ( baseModule ) {
962 if ( resolved.indexOf( baseModule ) === -1 ) {
963 resolved.push( baseModule );
964 }
965 } );
966 }
967
968 // Tracks down dependencies
969 deps = registry[ module ].dependencies;
970 unresolved.add( module );
971 for ( i = 0; i < deps.length; i++ ) {
972 if ( resolved.indexOf( deps[ i ] ) === -1 ) {
973 if ( unresolved.has( deps[ i ] ) ) {
974 throw new Error(
975 'Circular reference detected: ' + module + ' -> ' + deps[ i ]
976 );
977 }
978
979 sortDependencies( deps[ i ], resolved, unresolved );
980 }
981 }
982 resolved.push( module );
983 }
984
985 /**
986 * Get names of module that a module depends on, in their proper dependency order.
987 *
988 * @private
989 * @param {string[]} modules Array of string module names
990 * @return {Array} List of dependencies, including 'module'.
991 * @throws {Error} If an unregistered module or a dependency loop is encountered
992 */
993 function resolve( modules ) {
994 var i, resolved = [];
995 for ( i = 0; i < modules.length; i++ ) {
996 sortDependencies( modules[ i ], resolved );
997 }
998 return resolved;
999 }
1000
1001 /**
1002 * Like #resolve(), except it will silently ignore modules that
1003 * are missing or have missing dependencies.
1004 *
1005 * @private
1006 * @param {string[]} modules Array of string module names
1007 * @return {Array} List of dependencies.
1008 */
1009 function resolveStubbornly( modules ) {
1010 var i, saved, resolved = [];
1011 for ( i = 0; i < modules.length; i++ ) {
1012 saved = resolved.slice();
1013 try {
1014 sortDependencies( modules[ i ], resolved );
1015 } catch ( err ) {
1016 // This module is unknown or has unknown dependencies.
1017 // Undo any incomplete resolutions made and keep going.
1018 resolved = saved;
1019 mw.trackError( 'resourceloader.exception', {
1020 exception: err,
1021 source: 'resolve'
1022 } );
1023 }
1024 }
1025 return resolved;
1026 }
1027
1028 /**
1029 * Load and execute a script.
1030 *
1031 * @private
1032 * @param {string} src URL to script, will be used as the src attribute in the script tag
1033 * @param {Function} [callback] Callback to run after request resolution
1034 */
1035 function addScript( src, callback ) {
1036 var script = document.createElement( 'script' );
1037 script.src = src;
1038 script.onload = script.onerror = function () {
1039 if ( script.parentNode ) {
1040 script.parentNode.removeChild( script );
1041 }
1042 script = null;
1043 if ( callback ) {
1044 callback();
1045 callback = null;
1046 }
1047 };
1048 document.head.appendChild( script );
1049 }
1050
1051 /**
1052 * Queue the loading and execution of a script for a particular module.
1053 *
1054 * This does for debug mode what runScript() does for production.
1055 *
1056 * @private
1057 * @param {string} src URL of the script
1058 * @param {string} moduleName Name of currently executing module
1059 * @param {Function} callback Callback to run after addScript() resolution
1060 */
1061 function queueModuleScript( src, moduleName, callback ) {
1062 pendingRequests.push( function () {
1063 // Keep in sync with execute()/runScript().
1064 if ( moduleName !== 'jquery' ) {
1065 window.require = mw.loader.require;
1066 window.module = registry[ moduleName ].module;
1067 }
1068 addScript( src, function () {
1069 // 'module.exports' should not persist after the file is executed to
1070 // avoid leakage to unrelated code. 'require' should be kept, however,
1071 // as asynchronous access to 'require' is allowed and expected. (T144879)
1072 delete window.module;
1073 callback();
1074 // Start the next one (if any)
1075 if ( pendingRequests[ 0 ] ) {
1076 pendingRequests.shift()();
1077 } else {
1078 handlingPendingRequests = false;
1079 }
1080 } );
1081 } );
1082 if ( !handlingPendingRequests && pendingRequests[ 0 ] ) {
1083 handlingPendingRequests = true;
1084 pendingRequests.shift()();
1085 }
1086 }
1087
1088 /**
1089 * Utility function for execute()
1090 *
1091 * @ignore
1092 * @param {string} [media] Media attribute
1093 * @param {string} url URL
1094 */
1095 function addLink( media, url ) {
1096 var el = document.createElement( 'link' );
1097
1098 el.rel = 'stylesheet';
1099 if ( media && media !== 'all' ) {
1100 el.media = media;
1101 }
1102 // If you end up here from an IE exception "SCRIPT: Invalid property value.",
1103 // see #addEmbeddedCSS, T33676, T43331, and T49277 for details.
1104 el.href = url;
1105
1106 if ( marker && marker.parentNode ) {
1107 marker.parentNode.insertBefore( el, marker );
1108 } else {
1109 document.head.appendChild( el );
1110 }
1111 }
1112
1113 /**
1114 * @private
1115 * @param {string} code JavaScript code
1116 */
1117 function domEval( code ) {
1118 var script = document.createElement( 'script' );
1119 if ( mw.config.get( 'wgCSPNonce' ) !== false ) {
1120 script.nonce = mw.config.get( 'wgCSPNonce' );
1121 }
1122 script.text = code;
1123 document.head.appendChild( script );
1124 script.parentNode.removeChild( script );
1125 }
1126
1127 /**
1128 * Add one or more modules to the module load queue.
1129 *
1130 * See also #work().
1131 *
1132 * @private
1133 * @param {string[]} dependencies Array of module names in the registry
1134 * @param {Function} [ready] Callback to execute when all dependencies are ready
1135 * @param {Function} [error] Callback to execute when any dependency fails
1136 */
1137 function enqueue( dependencies, ready, error ) {
1138 if ( allReady( dependencies ) ) {
1139 // Run ready immediately
1140 if ( ready !== undefined ) {
1141 ready();
1142 }
1143 return;
1144 }
1145
1146 if ( anyFailed( dependencies ) ) {
1147 if ( error !== undefined ) {
1148 // Execute error immediately if any dependencies have errors
1149 error(
1150 new Error( 'One or more dependencies failed to load' ),
1151 dependencies
1152 );
1153 }
1154 return;
1155 }
1156
1157 // Not all dependencies are ready, add to the load queue...
1158
1159 // Add ready and error callbacks if they were given
1160 if ( ready !== undefined || error !== undefined ) {
1161 jobs.push( {
1162 // Narrow down the list to modules that are worth waiting for
1163 dependencies: dependencies.filter( function ( module ) {
1164 var state = registry[ module ].state;
1165 return state === 'registered' || state === 'loaded' || state === 'loading' || state === 'executing';
1166 } ),
1167 ready: ready,
1168 error: error
1169 } );
1170 }
1171
1172 dependencies.forEach( function ( module ) {
1173 // Only queue modules that are still in the initial 'registered' state
1174 // (not ones already loading, ready or error).
1175 if ( registry[ module ].state === 'registered' && queue.indexOf( module ) === -1 ) {
1176 // Private modules must be embedded in the page. Don't bother queuing
1177 // these as the server will deny them anyway (T101806).
1178 if ( registry[ module ].group === 'private' ) {
1179 setAndPropagate( module, 'error' );
1180 return;
1181 }
1182 queue.push( module );
1183 }
1184 } );
1185
1186 mw.loader.work();
1187 }
1188
1189 /**
1190 * Executes a loaded module, making it ready to use
1191 *
1192 * @private
1193 * @param {string} module Module name to execute
1194 */
1195 function execute( module ) {
1196 var key, value, media, i, urls, cssHandle, siteDeps, siteDepErr, runScript,
1197 cssPending = 0;
1198
1199 if ( registry[ module ].state !== 'loaded' ) {
1200 throw new Error( 'Module in state "' + registry[ module ].state + '" may not be executed: ' + module );
1201 }
1202
1203 registry[ module ].state = 'executing';
1204 $CODE.profileExecuteStart();
1205
1206 runScript = function () {
1207 var script, markModuleReady, nestedAddScript;
1208
1209 $CODE.profileScriptStart();
1210 script = registry[ module ].script;
1211 markModuleReady = function () {
1212 $CODE.profileScriptEnd();
1213 setAndPropagate( module, 'ready' );
1214 };
1215 nestedAddScript = function ( arr, callback, i ) {
1216 // Recursively call queueModuleScript() in its own callback
1217 // for each element of arr.
1218 if ( i >= arr.length ) {
1219 // We're at the end of the array
1220 callback();
1221 return;
1222 }
1223
1224 queueModuleScript( arr[ i ], module, function () {
1225 nestedAddScript( arr, callback, i + 1 );
1226 } );
1227 };
1228
1229 try {
1230 if ( Array.isArray( script ) ) {
1231 nestedAddScript( script, markModuleReady, 0 );
1232 } else if ( typeof script === 'function' ) {
1233 // Keep in sync with queueModuleScript() for debug mode
1234 if ( module === 'jquery' ) {
1235 // This is a special case for when 'jquery' itself is being loaded.
1236 // - The standard jquery.js distribution does not set `window.jQuery`
1237 // in CommonJS-compatible environments (Node.js, AMD, RequireJS, etc.).
1238 // - MediaWiki's 'jquery' module also bundles jquery.migrate.js, which
1239 // in a CommonJS-compatible environment, will use require('jquery'),
1240 // but that can't work when we're still inside that module.
1241 script();
1242 } else {
1243 // Pass jQuery twice so that the signature of the closure which wraps
1244 // the script can bind both '$' and 'jQuery'.
1245 script( window.$, window.$, mw.loader.require, registry[ module ].module );
1246 }
1247 markModuleReady();
1248
1249 } else if ( typeof script === 'string' ) {
1250 // Site and user modules are legacy scripts that run in the global scope.
1251 // This is transported as a string instead of a function to avoid needing
1252 // to use string manipulation to undo the function wrapper.
1253 domEval( script );
1254 markModuleReady();
1255
1256 } else {
1257 // Module without script
1258 markModuleReady();
1259 }
1260 } catch ( e ) {
1261 // Use mw.track instead of mw.log because these errors are common in production mode
1262 // (e.g. undefined variable), and mw.log is only enabled in debug mode.
1263 setAndPropagate( module, 'error' );
1264 $CODE.profileScriptEnd();
1265 mw.trackError( 'resourceloader.exception', {
1266 exception: e,
1267 module: module,
1268 source: 'module-execute'
1269 } );
1270 }
1271 };
1272
1273 // Add localizations to message system
1274 if ( registry[ module ].messages ) {
1275 mw.messages.set( registry[ module ].messages );
1276 }
1277
1278 // Initialise templates
1279 if ( registry[ module ].templates ) {
1280 mw.templates.set( module, registry[ module ].templates );
1281 }
1282
1283 // Adding of stylesheets is asynchronous via addEmbeddedCSS().
1284 // The below function uses a counting semaphore to make sure we don't call
1285 // runScript() until after this module's stylesheets have been inserted
1286 // into the DOM.
1287 cssHandle = function () {
1288 // Increase semaphore, when creating a callback for addEmbeddedCSS.
1289 cssPending++;
1290 return function () {
1291 var runScriptCopy;
1292 // Decrease semaphore, when said callback is invoked.
1293 cssPending--;
1294 if ( cssPending === 0 ) {
1295 // Paranoia:
1296 // This callback is exposed to addEmbeddedCSS, which is outside the execute()
1297 // function and is not concerned with state-machine integrity. In turn,
1298 // addEmbeddedCSS() actually exposes stuff further into the browser (rAF).
1299 // If increment and decrement callbacks happen in the wrong order, or start
1300 // again afterwards, then this branch could be reached multiple times.
1301 // To protect the integrity of the state-machine, prevent that from happening
1302 // by making runScript() cannot be called more than once. We store a private
1303 // reference when we first reach this branch, then deference the original, and
1304 // call our reference to it.
1305 runScriptCopy = runScript;
1306 runScript = undefined;
1307 runScriptCopy();
1308 }
1309 };
1310 };
1311
1312 // Process styles (see also mw.loader.implement)
1313 // * back-compat: { <media>: css }
1314 // * back-compat: { <media>: [url, ..] }
1315 // * { "css": [css, ..] }
1316 // * { "url": { <media>: [url, ..] } }
1317 if ( registry[ module ].style ) {
1318 for ( key in registry[ module ].style ) {
1319 value = registry[ module ].style[ key ];
1320 media = undefined;
1321
1322 if ( key !== 'url' && key !== 'css' ) {
1323 // Backwards compatibility, key is a media-type
1324 if ( typeof value === 'string' ) {
1325 // back-compat: { <media>: css }
1326 // Ignore 'media' because it isn't supported (nor was it used).
1327 // Strings are pre-wrapped in "@media". The media-type was just ""
1328 // (because it had to be set to something).
1329 // This is one of the reasons why this format is no longer used.
1330 addEmbeddedCSS( value, cssHandle() );
1331 } else {
1332 // back-compat: { <media>: [url, ..] }
1333 media = key;
1334 key = 'bc-url';
1335 }
1336 }
1337
1338 // Array of css strings in key 'css',
1339 // or back-compat array of urls from media-type
1340 if ( Array.isArray( value ) ) {
1341 for ( i = 0; i < value.length; i++ ) {
1342 if ( key === 'bc-url' ) {
1343 // back-compat: { <media>: [url, ..] }
1344 addLink( media, value[ i ] );
1345 } else if ( key === 'css' ) {
1346 // { "css": [css, ..] }
1347 addEmbeddedCSS( value[ i ], cssHandle() );
1348 }
1349 }
1350 // Not an array, but a regular object
1351 // Array of urls inside media-type key
1352 } else if ( typeof value === 'object' ) {
1353 // { "url": { <media>: [url, ..] } }
1354 for ( media in value ) {
1355 urls = value[ media ];
1356 for ( i = 0; i < urls.length; i++ ) {
1357 addLink( media, urls[ i ] );
1358 }
1359 }
1360 }
1361 }
1362 }
1363
1364 // End profiling of execute()-self before we call runScript(),
1365 // which we want to measure separately without overlap.
1366 $CODE.profileExecuteEnd();
1367
1368 if ( module === 'user' ) {
1369 // Implicit dependency on the site module. Not a real dependency because it should
1370 // run after 'site' regardless of whether it succeeds or fails.
1371 // Note: This is a simplified version of mw.loader.using(), inlined here because
1372 // mw.loader.using() is part of mediawiki.base (depends on jQuery; T192623).
1373 try {
1374 siteDeps = resolve( [ 'site' ] );
1375 } catch ( e ) {
1376 siteDepErr = e;
1377 runScript();
1378 }
1379 if ( siteDepErr === undefined ) {
1380 enqueue( siteDeps, runScript, runScript );
1381 }
1382 } else if ( cssPending === 0 ) {
1383 // Regular module without styles
1384 runScript();
1385 }
1386 // else: runScript will get called via cssHandle()
1387 }
1388
1389 function sortQuery( o ) {
1390 var key,
1391 sorted = {},
1392 a = [];
1393
1394 for ( key in o ) {
1395 a.push( key );
1396 }
1397 a.sort();
1398 for ( key = 0; key < a.length; key++ ) {
1399 sorted[ a[ key ] ] = o[ a[ key ] ];
1400 }
1401 return sorted;
1402 }
1403
1404 /**
1405 * Converts a module map of the form `{ foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }`
1406 * to a query string of the form `foo.bar,baz|bar.baz,quux`.
1407 *
1408 * See `ResourceLoader::makePackedModulesString()` in PHP, of which this is a port.
1409 * On the server, unpacking is done by `ResourceLoaderContext::expandModuleNames()`.
1410 *
1411 * Note: This is only half of the logic, the other half has to be in #batchRequest(),
1412 * because its implementation needs to keep track of potential string size in order
1413 * to decide when to split the requests due to url size.
1414 *
1415 * @private
1416 * @param {Object} moduleMap Module map
1417 * @return {Object}
1418 * @return {string} return.str Module query string
1419 * @return {Array} return.list List of module names in matching order
1420 */
1421 function buildModulesString( moduleMap ) {
1422 var p, prefix,
1423 str = [],
1424 list = [];
1425
1426 function restore( suffix ) {
1427 return p + suffix;
1428 }
1429
1430 for ( prefix in moduleMap ) {
1431 p = prefix === '' ? '' : prefix + '.';
1432 str.push( p + moduleMap[ prefix ].join( ',' ) );
1433 list.push.apply( list, moduleMap[ prefix ].map( restore ) );
1434 }
1435 return {
1436 str: str.join( '|' ),
1437 list: list
1438 };
1439 }
1440
1441 /**
1442 * Resolve indexed dependencies.
1443 *
1444 * ResourceLoader uses an optimisation to save space which replaces module names in
1445 * dependency lists with the index of that module within the array of module
1446 * registration data if it exists. The benefit is a significant reduction in the data
1447 * size of the startup module. This function changes those dependency lists back to
1448 * arrays of strings.
1449 *
1450 * @private
1451 * @param {Array} modules Modules array
1452 */
1453 function resolveIndexedDependencies( modules ) {
1454 var i, j, deps;
1455 function resolveIndex( dep ) {
1456 return typeof dep === 'number' ? modules[ dep ][ 0 ] : dep;
1457 }
1458 for ( i = 0; i < modules.length; i++ ) {
1459 deps = modules[ i ][ 2 ];
1460 if ( deps ) {
1461 for ( j = 0; j < deps.length; j++ ) {
1462 deps[ j ] = resolveIndex( deps[ j ] );
1463 }
1464 }
1465 }
1466 }
1467
1468 /**
1469 * @private
1470 * @param {Object} params Map of parameter names to values
1471 * @return {string}
1472 */
1473 function makeQueryString( params ) {
1474 return Object.keys( params ).map( function ( key ) {
1475 return encodeURIComponent( key ) + '=' + encodeURIComponent( params[ key ] );
1476 } ).join( '&' );
1477 }
1478
1479 /**
1480 * Create network requests for a batch of modules.
1481 *
1482 * This is an internal method for #work(). This must not be called directly
1483 * unless the modules are already registered, and no request is in progress,
1484 * and the module state has already been set to `loading`.
1485 *
1486 * @private
1487 * @param {string[]} batch
1488 */
1489 function batchRequest( batch ) {
1490 var reqBase, splits, maxQueryLength, b, bSource, bGroup,
1491 source, group, i, modules, sourceLoadScript,
1492 currReqBase, currReqBaseLength, moduleMap, currReqModules, l,
1493 lastDotIndex, prefix, suffix, bytesAdded;
1494
1495 /**
1496 * Start the currently drafted request to the server.
1497 *
1498 * @ignore
1499 */
1500 function doRequest() {
1501 // Optimisation: Inherit (Object.create), not copy ($.extend)
1502 var query = Object.create( currReqBase ),
1503 packed = buildModulesString( moduleMap );
1504 query.modules = packed.str;
1505 // The packing logic can change the effective order, even if the input was
1506 // sorted. As such, the call to getCombinedVersion() must use this
1507 // effective order, instead of currReqModules, as otherwise the combined
1508 // version will not match the hash expected by the server based on
1509 // combining versions from the module query string in-order. (T188076)
1510 query.version = getCombinedVersion( packed.list );
1511 query = sortQuery( query );
1512 addScript( sourceLoadScript + '?' + makeQueryString( query ) );
1513 }
1514
1515 if ( !batch.length ) {
1516 return;
1517 }
1518
1519 // Always order modules alphabetically to help reduce cache
1520 // misses for otherwise identical content.
1521 batch.sort();
1522
1523 // Query parameters common to all requests
1524 reqBase = {
1525 skin: mw.config.get( 'skin' ),
1526 lang: mw.config.get( 'wgUserLanguage' ),
1527 debug: mw.config.get( 'debug' )
1528 };
1529 maxQueryLength = mw.config.get( 'wgResourceLoaderMaxQueryLength', 2000 );
1530
1531 // Split module list by source and by group.
1532 splits = Object.create( null );
1533 for ( b = 0; b < batch.length; b++ ) {
1534 bSource = registry[ batch[ b ] ].source;
1535 bGroup = registry[ batch[ b ] ].group;
1536 if ( !splits[ bSource ] ) {
1537 splits[ bSource ] = Object.create( null );
1538 }
1539 if ( !splits[ bSource ][ bGroup ] ) {
1540 splits[ bSource ][ bGroup ] = [];
1541 }
1542 splits[ bSource ][ bGroup ].push( batch[ b ] );
1543 }
1544
1545 for ( source in splits ) {
1546 sourceLoadScript = sources[ source ];
1547
1548 for ( group in splits[ source ] ) {
1549
1550 // Cache access to currently selected list of
1551 // modules for this group from this source.
1552 modules = splits[ source ][ group ];
1553
1554 // Query parameters common to requests for this module group
1555 // Optimisation: Inherit (Object.create), not copy ($.extend)
1556 currReqBase = Object.create( reqBase );
1557 // User modules require a user name in the query string.
1558 if ( group === 'user' && mw.config.get( 'wgUserName' ) !== null ) {
1559 currReqBase.user = mw.config.get( 'wgUserName' );
1560 }
1561
1562 // In addition to currReqBase, doRequest() will also add 'modules' and 'version'.
1563 // > '&modules='.length === 9
1564 // > '&version=1234567'.length === 16
1565 // > 9 + 16 = 25
1566 currReqBaseLength = makeQueryString( currReqBase ).length + 25;
1567
1568 // We may need to split up the request to honor the query string length limit,
1569 // so build it piece by piece.
1570 l = currReqBaseLength;
1571 moduleMap = Object.create( null ); // { prefix: [ suffixes ] }
1572 currReqModules = [];
1573
1574 for ( i = 0; i < modules.length; i++ ) {
1575 // Determine how many bytes this module would add to the query string
1576 lastDotIndex = modules[ i ].lastIndexOf( '.' );
1577 // If lastDotIndex is -1, substr() returns an empty string
1578 prefix = modules[ i ].substr( 0, lastDotIndex );
1579 suffix = modules[ i ].slice( lastDotIndex + 1 );
1580 bytesAdded = moduleMap[ prefix ] ?
1581 suffix.length + 3 : // '%2C'.length == 3
1582 modules[ i ].length + 3; // '%7C'.length == 3
1583
1584 // If the url would become too long, create a new one, but don't create empty requests
1585 if ( maxQueryLength > 0 && currReqModules.length && l + bytesAdded > maxQueryLength ) {
1586 // Dispatch what we've got...
1587 doRequest();
1588 // .. and start again.
1589 l = currReqBaseLength;
1590 moduleMap = Object.create( null );
1591 currReqModules = [];
1592
1593 mw.track( 'resourceloader.splitRequest', { maxQueryLength: maxQueryLength } );
1594 }
1595 if ( !moduleMap[ prefix ] ) {
1596 moduleMap[ prefix ] = [];
1597 }
1598 l += bytesAdded;
1599 moduleMap[ prefix ].push( suffix );
1600 currReqModules.push( modules[ i ] );
1601 }
1602 // If there's anything left in moduleMap, request that too
1603 if ( currReqModules.length ) {
1604 doRequest();
1605 }
1606 }
1607 }
1608 }
1609
1610 /**
1611 * @private
1612 * @param {string[]} implementations Array containing pieces of JavaScript code in the
1613 * form of calls to mw.loader#implement().
1614 * @param {Function} cb Callback in case of failure
1615 * @param {Error} cb.err
1616 */
1617 function asyncEval( implementations, cb ) {
1618 if ( !implementations.length ) {
1619 return;
1620 }
1621 mw.requestIdleCallback( function () {
1622 try {
1623 domEval( implementations.join( ';' ) );
1624 } catch ( err ) {
1625 cb( err );
1626 }
1627 } );
1628 }
1629
1630 /**
1631 * Make a versioned key for a specific module.
1632 *
1633 * @private
1634 * @param {string} module Module name
1635 * @return {string|null} Module key in format '`[name]@[version]`',
1636 * or null if the module does not exist
1637 */
1638 function getModuleKey( module ) {
1639 return hasOwn.call( registry, module ) ?
1640 ( module + '@' + registry[ module ].version ) : null;
1641 }
1642
1643 /**
1644 * @private
1645 * @param {string} key Module name or '`[name]@[version]`'
1646 * @return {Object}
1647 */
1648 function splitModuleKey( key ) {
1649 var index = key.indexOf( '@' );
1650 if ( index === -1 ) {
1651 return {
1652 name: key,
1653 version: ''
1654 };
1655 }
1656 return {
1657 name: key.slice( 0, index ),
1658 version: key.slice( index + 1 )
1659 };
1660 }
1661
1662 /**
1663 * @private
1664 * @param {string} module
1665 * @param {string|number} [version]
1666 * @param {string[]} [dependencies]
1667 * @param {string} [group]
1668 * @param {string} [source]
1669 * @param {string} [skip]
1670 */
1671 function registerOne( module, version, dependencies, group, source, skip ) {
1672 if ( hasOwn.call( registry, module ) ) {
1673 throw new Error( 'module already registered: ' + module );
1674 }
1675 registry[ module ] = {
1676 // Exposed to execute() for mw.loader.implement() closures.
1677 // Import happens via require().
1678 module: {
1679 exports: {}
1680 },
1681 version: String( version || '' ),
1682 dependencies: dependencies || [],
1683 group: typeof group === 'string' ? group : null,
1684 source: typeof source === 'string' ? source : 'local',
1685 state: 'registered',
1686 skip: typeof skip === 'string' ? skip : null
1687 };
1688 }
1689
1690 /* Public Members */
1691 return {
1692 /**
1693 * The module registry is exposed as an aid for debugging and inspecting page
1694 * state; it is not a public interface for modifying the registry.
1695 *
1696 * @see #registry
1697 * @property
1698 * @private
1699 */
1700 moduleRegistry: registry,
1701
1702 /**
1703 * @inheritdoc #newStyleTag
1704 * @method
1705 */
1706 addStyleTag: newStyleTag,
1707
1708 enqueue: enqueue,
1709
1710 resolve: resolve,
1711
1712 /**
1713 * Start loading of all queued module dependencies.
1714 *
1715 * @private
1716 */
1717 work: function () {
1718 var q, batch, implementations, sourceModules;
1719
1720 batch = [];
1721
1722 // Appends a list of modules from the queue to the batch
1723 for ( q = 0; q < queue.length; q++ ) {
1724 // Only load modules which are registered
1725 if ( hasOwn.call( registry, queue[ q ] ) && registry[ queue[ q ] ].state === 'registered' ) {
1726 // Prevent duplicate entries
1727 if ( batch.indexOf( queue[ q ] ) === -1 ) {
1728 batch.push( queue[ q ] );
1729 // Mark registered modules as loading
1730 registry[ queue[ q ] ].state = 'loading';
1731 }
1732 }
1733 }
1734
1735 // Now that the queue has been processed into a batch, clear the queue.
1736 // This MUST happen before we initiate any eval or network request. Otherwise,
1737 // it is possible for a cached script to instantly trigger the same work queue
1738 // again; all before we've cleared it causing each request to include modules
1739 // which are already loaded.
1740 queue = [];
1741
1742 if ( !batch.length ) {
1743 return;
1744 }
1745
1746 mw.loader.store.init();
1747 if ( mw.loader.store.enabled ) {
1748 implementations = [];
1749 sourceModules = [];
1750 batch = batch.filter( function ( module ) {
1751 var implementation = mw.loader.store.get( module );
1752 if ( implementation ) {
1753 implementations.push( implementation );
1754 sourceModules.push( module );
1755 return false;
1756 }
1757 return true;
1758 } );
1759 asyncEval( implementations, function ( err ) {
1760 var failed;
1761 // Not good, the cached mw.loader.implement calls failed! This should
1762 // never happen, barring ResourceLoader bugs, browser bugs and PEBKACs.
1763 // Depending on how corrupt the string is, it is likely that some
1764 // modules' implement() succeeded while the ones after the error will
1765 // never run and leave their modules in the 'loading' state forever.
1766 mw.loader.store.stats.failed++;
1767
1768 // Since this is an error not caused by an individual module but by
1769 // something that infected the implement call itself, don't take any
1770 // risks and clear everything in this cache.
1771 mw.loader.store.clear();
1772
1773 mw.trackError( 'resourceloader.exception', {
1774 exception: err,
1775 source: 'store-eval'
1776 } );
1777 // Re-add the failed ones that are still pending back to the batch
1778 failed = sourceModules.filter( function ( module ) {
1779 return registry[ module ].state === 'loading';
1780 } );
1781 batchRequest( failed );
1782 } );
1783 }
1784
1785 batchRequest( batch );
1786 },
1787
1788 /**
1789 * Register a source.
1790 *
1791 * The #work() method will use this information to split up requests by source.
1792 *
1793 * mw.loader.addSource( { mediawikiwiki: 'https://www.mediawiki.org/w/load.php' } );
1794 *
1795 * @private
1796 * @param {Object} ids An object mapping ids to load.php end point urls
1797 * @throws {Error} If source id is already registered
1798 */
1799 addSource: function ( ids ) {
1800 var id;
1801 for ( id in ids ) {
1802 if ( hasOwn.call( sources, id ) ) {
1803 throw new Error( 'source already registered: ' + id );
1804 }
1805 sources[ id ] = ids[ id ];
1806 }
1807 },
1808
1809 /**
1810 * Register a module, letting the system know about it and its properties.
1811 *
1812 * The startup module calls this method.
1813 *
1814 * When using multiple module registration by passing an array, dependencies that
1815 * are specified as references to modules within the array will be resolved before
1816 * the modules are registered.
1817 *
1818 * @param {string|Array} modules Module name or array of arrays, each containing
1819 * a list of arguments compatible with this method
1820 * @param {string|number} [version] Module version hash (falls backs to empty string)
1821 * Can also be a number (timestamp) for compatibility with MediaWiki 1.25 and earlier.
1822 * @param {string[]} [dependencies] Array of module names on which this module depends.
1823 * @param {string} [group=null] Group which the module is in
1824 * @param {string} [source='local'] Name of the source
1825 * @param {string} [skip=null] Script body of the skip function
1826 */
1827 register: function ( modules ) {
1828 var i;
1829 if ( typeof modules === 'object' ) {
1830 resolveIndexedDependencies( modules );
1831 // Optimisation: Up to 55% faster.
1832 // Typically called only once, and with a batch.
1833 // See <https://gist.github.com/Krinkle/f06fdb3de62824c6c16f02a0e6ce0e66>
1834 // Benchmarks taught us that the code for adding an object to `registry`
1835 // should actually be inline, or in a simple function that does no
1836 // arguments manipulation, and isn't also the caller itself.
1837 // JS semantics make it hard to optimise recursion to a different
1838 // signature of itself.
1839 for ( i = 0; i < modules.length; i++ ) {
1840 registerOne.apply( null, modules[ i ] );
1841 }
1842 } else {
1843 registerOne.apply( null, arguments );
1844 }
1845 },
1846
1847 /**
1848 * Implement a module given the components that make up the module.
1849 *
1850 * When #load() or #using() requests one or more modules, the server
1851 * response contain calls to this function.
1852 *
1853 * @param {string} module Name of module and current module version. Formatted
1854 * as '`[name]@[version]`". This version should match the requested version
1855 * (from #batchRequest and #registry). This avoids race conditions (T117587).
1856 * For back-compat with MediaWiki 1.27 and earlier, the version may be omitted.
1857 * @param {Function|Array|string} [script] Function with module code, list of URLs
1858 * to load via `<script src>`, or string of module code for `$.globalEval()`.
1859 * @param {Object} [style] Should follow one of the following patterns:
1860 *
1861 * { "css": [css, ..] }
1862 * { "url": { <media>: [url, ..] } }
1863 *
1864 * And for backwards compatibility (needs to be supported forever due to caching):
1865 *
1866 * { <media>: css }
1867 * { <media>: [url, ..] }
1868 *
1869 * The reason css strings are not concatenated anymore is T33676. We now check
1870 * whether it's safe to extend the stylesheet.
1871 *
1872 * @private
1873 * @param {Object} [messages] List of key/value pairs to be added to mw#messages.
1874 * @param {Object} [templates] List of key/value pairs to be added to mw#templates.
1875 */
1876 implement: function ( module, script, style, messages, templates ) {
1877 var split = splitModuleKey( module ),
1878 name = split.name,
1879 version = split.version;
1880 // Automatically register module
1881 if ( !hasOwn.call( registry, name ) ) {
1882 mw.loader.register( name );
1883 }
1884 // Check for duplicate implementation
1885 if ( registry[ name ].script !== undefined ) {
1886 throw new Error( 'module already implemented: ' + name );
1887 }
1888 if ( version ) {
1889 // Without this reset, if there is a version mismatch between the
1890 // requested and received module version, then mw.loader.store would
1891 // cache the response under the requested key. Thus poisoning the cache
1892 // indefinitely with a stale value. (T117587)
1893 registry[ name ].version = version;
1894 }
1895 // Attach components
1896 registry[ name ].script = script || null;
1897 registry[ name ].style = style || null;
1898 registry[ name ].messages = messages || null;
1899 registry[ name ].templates = templates || null;
1900 // The module may already have been marked as erroneous
1901 if ( registry[ name ].state !== 'error' && registry[ name ].state !== 'missing' ) {
1902 setAndPropagate( name, 'loaded' );
1903 }
1904 },
1905
1906 /**
1907 * Load an external script or one or more modules.
1908 *
1909 * This method takes a list of unrelated modules. Use cases:
1910 *
1911 * - A web page will be composed of many different widgets. These widgets independently
1912 * queue their ResourceLoader modules (`OutputPage::addModules()`). If any of them
1913 * have problems, or are no longer known (e.g. cached HTML), the other modules
1914 * should still be loaded.
1915 * - This method is used for preloading, which must not throw. Later code that
1916 * calls #using() will handle the error.
1917 *
1918 * @param {string|Array} modules Either the name of a module, array of modules,
1919 * or a URL of an external script or style
1920 * @param {string} [type='text/javascript'] MIME type to use if calling with a URL of an
1921 * external script or style; acceptable values are "text/css" and
1922 * "text/javascript"; if no type is provided, text/javascript is assumed.
1923 */
1924 load: function ( modules, type ) {
1925 var filtered, l;
1926
1927 // Allow calling with a url or single dependency as a string
1928 if ( typeof modules === 'string' ) {
1929 // "https://example.org/x.js", "http://example.org/x.js", "//example.org/x.js", "/x.js"
1930 if ( /^(https?:)?\/?\//.test( modules ) ) {
1931 if ( type === 'text/css' ) {
1932 l = document.createElement( 'link' );
1933 l.rel = 'stylesheet';
1934 l.href = modules;
1935 document.head.appendChild( l );
1936 return;
1937 }
1938 if ( type === 'text/javascript' || type === undefined ) {
1939 addScript( modules );
1940 return;
1941 }
1942 // Unknown type
1943 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type );
1944 }
1945 // Called with single module
1946 modules = [ modules ];
1947 }
1948
1949 // Filter out top-level modules that are unknown or failed to load before.
1950 filtered = modules.filter( function ( module ) {
1951 var state = mw.loader.getState( module );
1952 return state !== 'error' && state !== 'missing';
1953 } );
1954 // Resolve remaining list using the known dependency tree.
1955 // This also filters out modules with unknown dependencies. (T36853)
1956 filtered = resolveStubbornly( filtered );
1957 // Some modules are not yet ready, add to module load queue.
1958 enqueue( filtered, undefined, undefined );
1959 },
1960
1961 /**
1962 * Change the state of one or more modules.
1963 *
1964 * @param {Object} states Object of module name/state pairs
1965 */
1966 state: function ( states ) {
1967 var module, state;
1968 for ( module in states ) {
1969 state = states[ module ];
1970 if ( !hasOwn.call( registry, module ) ) {
1971 mw.loader.register( module );
1972 }
1973 setAndPropagate( module, state );
1974 }
1975 },
1976
1977 /**
1978 * Get the version of a module.
1979 *
1980 * @param {string} module Name of module
1981 * @return {string|null} The version, or null if the module (or its version) is not
1982 * in the registry.
1983 */
1984 getVersion: function ( module ) {
1985 return hasOwn.call( registry, module ) ? registry[ module ].version : null;
1986 },
1987
1988 /**
1989 * Get the state of a module.
1990 *
1991 * @param {string} module Name of module
1992 * @return {string|null} The state, or null if the module (or its state) is not
1993 * in the registry.
1994 */
1995 getState: function ( module ) {
1996 return hasOwn.call( registry, module ) ? registry[ module ].state : null;
1997 },
1998
1999 /**
2000 * Get the names of all registered modules.
2001 *
2002 * @return {Array}
2003 */
2004 getModuleNames: function () {
2005 return Object.keys( registry );
2006 },
2007
2008 /**
2009 * Get the exported value of a module.
2010 *
2011 * This static method is publicly exposed for debugging purposes
2012 * only and must not be used in production code. In production code,
2013 * please use the dynamically provided `require()` function instead.
2014 *
2015 * In case of lazy-loaded modules via mw.loader#using(), the returned
2016 * Promise provides the function, see #using() for examples.
2017 *
2018 * @private
2019 * @since 1.27
2020 * @param {string} moduleName Module name
2021 * @return {Mixed} Exported value
2022 */
2023 require: function ( moduleName ) {
2024 var state = mw.loader.getState( moduleName );
2025
2026 // Only ready modules can be required
2027 if ( state !== 'ready' ) {
2028 // Module may've forgotten to declare a dependency
2029 throw new Error( 'Module "' + moduleName + '" is not loaded.' );
2030 }
2031
2032 return registry[ moduleName ].module.exports;
2033 },
2034
2035 /**
2036 * On browsers that implement the localStorage API, the module store serves as a
2037 * smart complement to the browser cache. Unlike the browser cache, the module store
2038 * can slice a concatenated response from ResourceLoader into its constituent
2039 * modules and cache each of them separately, using each module's versioning scheme
2040 * to determine when the cache should be invalidated.
2041 *
2042 * @private
2043 * @singleton
2044 * @class mw.loader.store
2045 */
2046 store: {
2047 // Whether the store is in use on this page.
2048 enabled: null,
2049
2050 // Modules whose string representation exceeds 100 kB are
2051 // ineligible for storage. See bug T66721.
2052 MODULE_SIZE_MAX: 100 * 1000,
2053
2054 // The contents of the store, mapping '[name]@[version]' keys
2055 // to module implementations.
2056 items: {},
2057
2058 // Names of modules to be stored during the next update.
2059 // See add() and update().
2060 queue: [],
2061
2062 // Cache hit stats
2063 stats: { hits: 0, misses: 0, expired: 0, failed: 0 },
2064
2065 /**
2066 * Construct a JSON-serializable object representing the content of the store.
2067 *
2068 * @return {Object} Module store contents.
2069 */
2070 toJSON: function () {
2071 return { items: mw.loader.store.items, vary: mw.loader.store.getVary() };
2072 },
2073
2074 /**
2075 * Get the localStorage key for the entire module store. The key references
2076 * $wgDBname to prevent clashes between wikis which share a common host.
2077 *
2078 * @return {string} localStorage item key
2079 */
2080 getStoreKey: function () {
2081 return 'MediaWikiModuleStore:' + mw.config.get( 'wgDBname' );
2082 },
2083
2084 /**
2085 * Get a key on which to vary the module cache.
2086 *
2087 * @return {string} String of concatenated vary conditions.
2088 */
2089 getVary: function () {
2090 return mw.config.get( 'skin' ) + ':' +
2091 mw.config.get( 'wgResourceLoaderStorageVersion' ) + ':' +
2092 mw.config.get( 'wgUserLanguage' );
2093 },
2094
2095 /**
2096 * Initialize the store.
2097 *
2098 * Retrieves store from localStorage and (if successfully retrieved) decoding
2099 * the stored JSON value to a plain object.
2100 *
2101 * The try / catch block is used for JSON & localStorage feature detection.
2102 * See the in-line documentation for Modernizr's localStorage feature detection
2103 * code for a full account of why we need a try / catch:
2104 * <https://github.com/Modernizr/Modernizr/blob/v2.7.1/modernizr.js#L771-L796>.
2105 */
2106 init: function () {
2107 var raw, data;
2108
2109 if ( this.enabled !== null ) {
2110 // Init already ran
2111 return;
2112 }
2113
2114 if (
2115 // Disabled because localStorage quotas are tight and (in Firefox's case)
2116 // shared by multiple origins.
2117 // See T66721, and <https://bugzilla.mozilla.org/show_bug.cgi?id=1064466>.
2118 /Firefox/.test( navigator.userAgent ) ||
2119
2120 // Disabled by configuration.
2121 !mw.config.get( 'wgResourceLoaderStorageEnabled' )
2122 ) {
2123 // Clear any previous store to free up space. (T66721)
2124 this.clear();
2125 this.enabled = false;
2126 return;
2127 }
2128 if ( mw.config.get( 'debug' ) ) {
2129 // Disable module store in debug mode
2130 this.enabled = false;
2131 return;
2132 }
2133
2134 try {
2135 // This a string we stored, or `null` if the key does not (yet) exist.
2136 raw = localStorage.getItem( this.getStoreKey() );
2137 // If we get here, localStorage is available; mark enabled
2138 this.enabled = true;
2139 // If null, JSON.parse() will cast to string and re-parse, still null.
2140 data = JSON.parse( raw );
2141 if ( data && typeof data.items === 'object' && data.vary === this.getVary() ) {
2142 this.items = data.items;
2143 return;
2144 }
2145 } catch ( e ) {
2146 mw.trackError( 'resourceloader.exception', {
2147 exception: e,
2148 source: 'store-localstorage-init'
2149 } );
2150 }
2151
2152 // If we get here, one of four things happened:
2153 //
2154 // 1. localStorage did not contain our store key.
2155 // This means `raw` is `null`, and we're on a fresh page view (cold cache).
2156 // The store was enabled, and `items` starts fresh.
2157 //
2158 // 2. localStorage contained parseable data under our store key,
2159 // but it's not applicable to our current context (see getVary).
2160 // The store was enabled, and `items` starts fresh.
2161 //
2162 // 3. JSON.parse threw (localStorage contained corrupt data).
2163 // This means `raw` contains a string.
2164 // The store was enabled, and `items` starts fresh.
2165 //
2166 // 4. localStorage threw (disabled or otherwise unavailable).
2167 // This means `raw` was never assigned.
2168 // We will disable the store below.
2169 if ( raw === undefined ) {
2170 // localStorage failed; disable store
2171 this.enabled = false;
2172 }
2173 },
2174
2175 /**
2176 * Retrieve a module from the store and update cache hit stats.
2177 *
2178 * @param {string} module Module name
2179 * @return {string|boolean} Module implementation or false if unavailable
2180 */
2181 get: function ( module ) {
2182 var key;
2183
2184 if ( !this.enabled ) {
2185 return false;
2186 }
2187
2188 key = getModuleKey( module );
2189 if ( key in this.items ) {
2190 this.stats.hits++;
2191 return this.items[ key ];
2192 }
2193 this.stats.misses++;
2194 return false;
2195 },
2196
2197 /**
2198 * Queue the name of a module that the next update should consider storing.
2199 *
2200 * @since 1.32
2201 * @param {string} module Module name
2202 */
2203 add: function ( module ) {
2204 if ( !this.enabled ) {
2205 return;
2206 }
2207 this.queue.push( module );
2208 this.requestUpdate();
2209 },
2210
2211 /**
2212 * Add the contents of the named module to the in-memory store.
2213 *
2214 * This method does not guarantee that the module will be stored.
2215 * Inspection of the module's meta data and size will ultimately decide that.
2216 *
2217 * This method is considered internal to mw.loader.store and must only
2218 * be called if the store is enabled.
2219 *
2220 * @private
2221 * @param {string} module Module name
2222 */
2223 set: function ( module ) {
2224 var key, args, src,
2225 descriptor = mw.loader.moduleRegistry[ module ];
2226
2227 key = getModuleKey( module );
2228
2229 if (
2230 // Already stored a copy of this exact version
2231 key in this.items ||
2232 // Module failed to load
2233 !descriptor ||
2234 descriptor.state !== 'ready' ||
2235 // Unversioned, private, or site-/user-specific
2236 !descriptor.version ||
2237 descriptor.group === 'private' ||
2238 descriptor.group === 'user' ||
2239 // Partial descriptor
2240 // (e.g. skipped module, or style module with state=ready)
2241 [ descriptor.script, descriptor.style, descriptor.messages,
2242 descriptor.templates ].indexOf( undefined ) !== -1
2243 ) {
2244 // Decline to store
2245 return;
2246 }
2247
2248 try {
2249 args = [
2250 JSON.stringify( key ),
2251 typeof descriptor.script === 'function' ?
2252 String( descriptor.script ) :
2253 JSON.stringify( descriptor.script ),
2254 JSON.stringify( descriptor.style ),
2255 JSON.stringify( descriptor.messages ),
2256 JSON.stringify( descriptor.templates )
2257 ];
2258 } catch ( e ) {
2259 mw.trackError( 'resourceloader.exception', {
2260 exception: e,
2261 source: 'store-localstorage-json'
2262 } );
2263 return;
2264 }
2265
2266 src = 'mw.loader.implement(' + args.join( ',' ) + ');';
2267 if ( src.length > this.MODULE_SIZE_MAX ) {
2268 return;
2269 }
2270 this.items[ key ] = src;
2271 },
2272
2273 /**
2274 * Iterate through the module store, removing any item that does not correspond
2275 * (in name and version) to an item in the module registry.
2276 */
2277 prune: function () {
2278 var key, module;
2279
2280 for ( key in this.items ) {
2281 module = key.slice( 0, key.indexOf( '@' ) );
2282 if ( getModuleKey( module ) !== key ) {
2283 this.stats.expired++;
2284 delete this.items[ key ];
2285 } else if ( this.items[ key ].length > this.MODULE_SIZE_MAX ) {
2286 // This value predates the enforcement of a size limit on cached modules.
2287 delete this.items[ key ];
2288 }
2289 }
2290 },
2291
2292 /**
2293 * Clear the entire module store right now.
2294 */
2295 clear: function () {
2296 this.items = {};
2297 try {
2298 localStorage.removeItem( this.getStoreKey() );
2299 } catch ( e ) {}
2300 },
2301
2302 /**
2303 * Request a sync of the in-memory store back to persisted localStorage.
2304 *
2305 * This function debounces updates. The debouncing logic should account
2306 * for the following factors:
2307 *
2308 * - Writing to localStorage is an expensive operation that must not happen
2309 * during the critical path of initialising and executing module code.
2310 * Instead, it should happen at a later time after modules have been given
2311 * time and priority to do their thing first.
2312 *
2313 * - This method is called from mw.loader.store.add(), which will be called
2314 * hundreds of times on a typical page, including within the same call-stack
2315 * and eventloop-tick. This is because responses from load.php happen in
2316 * batches. As such, we want to allow all modules from the same load.php
2317 * response to be written to disk with a single flush, not many.
2318 *
2319 * - Repeatedly deleting and creating timers is non-trivial.
2320 *
2321 * - localStorage is shared by all pages from the same origin, if multiple
2322 * pages are loaded with different module sets, the possibility exists that
2323 * modules saved by one page will be clobbered by another. The impact of
2324 * this is minor, it merely causes a less efficient cache use, and the
2325 * problem would be corrected by subsequent page views.
2326 *
2327 * This method is considered internal to mw.loader.store and must only
2328 * be called if the store is enabled.
2329 *
2330 * @private
2331 * @method
2332 */
2333 requestUpdate: ( function () {
2334 var hasPendingWrites = false;
2335
2336 function flushWrites() {
2337 var data, key;
2338
2339 // Remove anything from the in-memory store that came from previous page
2340 // loads that no longer corresponds with current module names and versions.
2341 mw.loader.store.prune();
2342 // Process queued module names, serialise their contents to the in-memory store.
2343 while ( mw.loader.store.queue.length ) {
2344 mw.loader.store.set( mw.loader.store.queue.shift() );
2345 }
2346
2347 key = mw.loader.store.getStoreKey();
2348 try {
2349 // Replacing the content of the module store might fail if the new
2350 // contents would exceed the browser's localStorage size limit. To
2351 // avoid clogging the browser with stale data, always remove the old
2352 // value before attempting to set the new one.
2353 localStorage.removeItem( key );
2354 data = JSON.stringify( mw.loader.store );
2355 localStorage.setItem( key, data );
2356 } catch ( e ) {
2357 mw.trackError( 'resourceloader.exception', {
2358 exception: e,
2359 source: 'store-localstorage-update'
2360 } );
2361 }
2362
2363 // Let the next call to requestUpdate() create a new timer.
2364 hasPendingWrites = false;
2365 }
2366
2367 function onTimeout() {
2368 // Defer the actual write via requestIdleCallback
2369 mw.requestIdleCallback( flushWrites );
2370 }
2371
2372 return function () {
2373 // On the first call to requestUpdate(), create a timer that
2374 // waits at least two seconds, then calls onTimeout.
2375 // The main purpose is to allow the current batch of load.php
2376 // responses to complete before we do anything. This batch can
2377 // trigger many hundreds of calls to requestUpdate().
2378 if ( !hasPendingWrites ) {
2379 hasPendingWrites = true;
2380 setTimeout( onTimeout, 2000 );
2381 }
2382 };
2383 }() )
2384 }
2385 };
2386 }() ),
2387
2388 // Skeleton user object, extended by the 'mediawiki.user' module.
2389 /**
2390 * @class mw.user
2391 * @singleton
2392 */
2393 user: {
2394 /**
2395 * @property {mw.Map}
2396 */
2397 options: new Map(),
2398 /**
2399 * @property {mw.Map}
2400 */
2401 tokens: new Map()
2402 },
2403
2404 // OOUI widgets specific to MediaWiki
2405 widgets: {}
2406
2407 };
2408
2409 // Attach to window and globally alias
2410 window.mw = window.mediaWiki = mw;
2411 }() );