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