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