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