| blob | c25e32767eb71639c65730a7377ce1b15f41a06f |
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';
15 var mw,
16 hasOwn = Object.prototype.hasOwnProperty,
17 slice = Array.prototype.slice,
18 trackCallbacks = $.Callbacks( 'memory' ),
19 trackHandlers = [],
20 trackQueue = [];
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 = {};
66 // Override #set to also set the global variable
67 this.set = function ( selection, value ) {
68 var s;
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 };
83 return;
84 }
86 this.values = values || {};
87 }
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 }
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;
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 }
137 if ( typeof selection === 'string' ) {
138 if ( !hasOwn.call( this.values, selection ) ) {
139 return fallback;
140 }
141 return this.values[ selection ];
142 }
144 if ( selection === undefined ) {
145 return this.values;
146 }
148 // Invalid selection key
149 return null;
150 },
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;
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 },
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;
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 };
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 "Wiki" <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 }
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 },
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++ ) {
288 this.parameters.push( parameters[ i ] );
289 }
290 return this;
291 },
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;
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 }
311 if ( this.format === 'plain' || this.format === 'text' || this.format === 'parse' ) {
312 text = this.parser();
313 }
315 if ( this.format === 'escaped' ) {
316 text = this.parser();
317 text = mw.html.escape( text );
318 }
320 return text;
321 },
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 },
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 },
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 },
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 },
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 };
390 /**
391 * @class mw
392 */
393 mw = {
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 }() ),
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} formatString 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 },
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 },
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 }
477 trackHandlers.push( [ handler, callback ] );
479 trackCallbacks.add( handler );
480 },
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 },
498 // Expose Map constructor
499 Map: Map,
501 // Expose Message constructor
502 Message: Message,
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,
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: {},
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: {},
540 /**
541 * Store for messages.
542 *
543 * @property {mw.Map}
544 */
545 messages: new Map(),
547 /**
548 * Store for templates associated with a module.
549 *
550 * @property {mw.Map}
551 */
552 templates: new Map(),
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 },
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 },
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 console = window.console;
594 /**
595 * @class mw.log
596 * @singleton
597 */
599 /**
600 * Write a message the console's warning channel.
601 * Actions not supported by the browser console are silently ignored.
602 *
603 * @param {...string} msg Messages to output to console
604 */
605 log.warn = console && console.warn && Function.prototype.bind ?
606 Function.prototype.bind.call( console.warn, console ) :
607 $.noop;
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 = console && console.error && Function.prototype.bind ?
619 Function.prototype.bind.call( console.error, console ) :
620 $.noop;
622 /**
623 * Create a property in a host object that, when accessed, will produce
624 * a deprecation warning in the console with backtrace.
625 *
626 * @param {Object} obj Host object of deprecated property
627 * @param {string} key Name of property to create in `obj`
628 * @param {Mixed} val The value this property should return when accessed
629 * @param {string} [msg] Optional text to include in the deprecation message
630 */
631 log.deprecate = !Object.defineProperty ? function ( obj, key, val ) {
632 obj[ key ] = val;
633 } : function ( obj, key, val, msg ) {
634 msg = 'Use of "' + key + '" is deprecated.' + ( msg ? ( ' ' + msg ) : '' );
635 // Support: IE8
636 // Can throw on Object.defineProperty.
637 try {
638 Object.defineProperty( obj, key, {
639 configurable: true,
640 enumerable: true,
641 get: function () {
642 mw.track( 'mw.deprecate', key );
643 mw.log.warn( msg );
644 return val;
645 },
646 set: function ( newVal ) {
647 mw.track( 'mw.deprecate', key );
648 mw.log.warn( msg );
649 val = newVal;
650 }
651 } );
652 } catch ( err ) {
653 // Fallback to creating a copy of the value to the object.
654 obj[ key ] = val;
655 }
656 };
658 return log;
659 }() ),
661 /**
662 * Client for ResourceLoader server end point.
663 *
664 * This client is in charge of maintaining the module registry and state
665 * machine, initiating network (batch) requests for loading modules, as
666 * well as dependency resolution and execution of source code.
667 *
668 * For more information, refer to
669 * <https://www.mediawiki.org/wiki/ResourceLoader/Features>
670 *
671 * @class mw.loader
672 * @singleton
673 */
674 loader: ( function () {
676 /**
677 * Fired via mw.track on various resource loading errors.
678 *
679 * @event resourceloader_exception
680 * @param {Error|Mixed} e The error that was thrown. Almost always an Error
681 * object, but in theory module code could manually throw something else, and that
682 * might also end up here.
683 * @param {string} [module] Name of the module which caused the error. Omitted if the
684 * error is not module-related or the module cannot be easily identified due to
685 * batched handling.
686 * @param {string} source Source of the error. Possible values:
687 *
688 * - style: stylesheet error (only affects old IE where a special style loading method
689 * is used)
690 * - load-callback: exception thrown by user callback
691 * - module-execute: exception thrown by module code
692 * - store-eval: could not evaluate module code cached in localStorage
693 * - store-localstorage-init: localStorage or JSON parse error in mw.loader.store.init
694 * - store-localstorage-json: JSON conversion error in mw.loader.store.set
695 * - store-localstorage-update: localStorage or JSON conversion error in mw.loader.store.update
696 */
698 /**
699 * Fired via mw.track on resource loading error conditions.
700 *
701 * @event resourceloader_assert
702 * @param {string} source Source of the error. Possible values:
703 *
704 * - bug-T59567: failed to cache script due to an Opera function -> string conversion
705 * bug; see <https://phabricator.wikimedia.org/T59567> for details
706 */
708 /**
709 * Mapping of registered modules.
710 *
711 * See #implement and #execute for exact details on support for script, style and messages.
712 *
713 * Format:
714 *
715 * {
716 * 'moduleName': {
717 * // From mw.loader.register()
718 * 'version': '########' (hash)
719 * 'dependencies': ['required.foo', 'bar.also', ...], (or) function () {}
720 * 'group': 'somegroup', (or) null
721 * 'source': 'local', (or) 'anotherwiki'
722 * 'skip': 'return !!window.Example', (or) null
723 *
724 * // Set from execute() or mw.loader.state()
725 * 'state': 'registered', 'loaded', 'loading', 'ready', 'error', or 'missing'
726 *
727 * // Optionally added at run-time by mw.loader.implement()
728 * 'skipped': true
729 * 'script': closure, array of urls, or string
730 * 'style': { ... } (see #execute)
731 * 'messages': { 'key': 'value', ... }
732 * }
733 * }
734 *
735 * State machine:
736 *
737 * - `registered`:
738 * The module is known to the system but not yet requested.
739 * Meta data is registered via mw.loader#register. Calls to that method are
740 * generated server-side by the startup module.
741 * - `loading`:
742 * The module is requested through mw.loader (either directly or as dependency of
743 * another module). The client will be fetching module contents from the server.
744 * The contents are then stashed in the registry via mw.loader#implement.
745 * - `loaded`:
746 * The module has been requested from the server and stashed via mw.loader#implement.
747 * If the module has no more dependencies in-fight, the module will be executed
748 * right away. Otherwise execution is deferred, controlled via #handlePending.
749 * - `executing`:
750 * The module is being executed.
751 * - `ready`:
752 * The module has been successfully executed.
753 * - `error`:
754 * The module (or one of its dependencies) produced an error during execution.
755 * - `missing`:
756 * The module was registered client-side and requested, but the server denied knowledge
757 * of the module's existence.
758 *
759 * @property
760 * @private
761 */
762 var registry = {},
763 // Mapping of sources, keyed by source-id, values are strings.
764 //
765 // Format:
766 //
767 // {
768 // 'sourceId': 'http://example.org/w/load.php'
769 // }
770 //
771 sources = {},
773 // List of modules which will be loaded as when ready
774 batch = [],
776 // List of modules to be loaded
777 queue = [],
779 /**
780 * List of callback jobs waiting for modules to be ready.
781 *
782 * Jobs are created by #request() and run by #handlePending().
783 *
784 * Typically when a job is created for a module, the job's dependencies contain
785 * both the module being requested and all its recursive dependencies.
786 *
787 * Format:
788 *
789 * {
790 * 'dependencies': [ module names ],
791 * 'ready': Function callback
792 * 'error': Function callback
793 * }
794 *
795 * @property {Object[]} jobs
796 * @private
797 */
798 jobs = [],
800 // Selector cache for the marker element. Use getMarker() to get/use the marker!
801 $marker = null,
803 // For #addEmbeddedCSS
804 cssBuffer = '',
805 cssBufferTimer = null,
806 cssCallbacks = $.Callbacks();
808 function getMarker() {
809 if ( !$marker ) {
810 // Cache
811 $marker = $( 'meta[name="ResourceLoaderDynamicStyles"]' );
812 if ( !$marker.length ) {
813 mw.log( 'No <meta name="ResourceLoaderDynamicStyles"> found, inserting dynamically' );
814 $marker = $( '<meta>' ).attr( 'name', 'ResourceLoaderDynamicStyles' ).appendTo( 'head' );
815 }
816 }
817 return $marker;
818 }
820 /**
821 * Create a new style element and add it to the DOM.
822 *
823 * @private
824 * @param {string} text CSS text
825 * @param {HTMLElement|jQuery} [nextnode=document.head] The element where the style tag
826 * should be inserted before
827 * @return {HTMLElement} Reference to the created style element
828 */
829 function newStyleTag( text, nextnode ) {
830 var s = document.createElement( 'style' );
831 // Support: IE
832 // Must attach to document before setting cssText (bug 33305)
833 if ( nextnode ) {
834 $( nextnode ).before( s );
835 } else {
836 document.getElementsByTagName( 'head' )[ 0 ].appendChild( s );
837 }
838 if ( s.styleSheet ) {
839 // Support: IE6-10
840 // Old IE ignores appended text nodes, access stylesheet directly.
841 s.styleSheet.cssText = text;
842 } else {
843 // Standard behaviour
844 s.appendChild( document.createTextNode( text ) );
845 }
846 return s;
847 }
849 /**
850 * Add a bit of CSS text to the current browser page.
851 *
852 * The CSS will be appended to an existing ResourceLoader-created `<style>` tag
853 * or create a new one based on whether the given `cssText` is safe for extension.
854 *
855 * @param {string} [cssText=cssBuffer] If called without cssText,
856 * the internal buffer will be inserted instead.
857 * @param {Function} [callback]
858 */
859 function addEmbeddedCSS( cssText, callback ) {
860 var $style, styleEl, newCssText;
862 function fireCallbacks() {
863 var oldCallbacks = cssCallbacks;
864 // Reset cssCallbacks variable so it's not polluted by any calls to
865 // addEmbeddedCSS() from one of the callbacks (T105973)
866 cssCallbacks = $.Callbacks();
867 oldCallbacks.fire().empty();
868 }
870 if ( callback ) {
871 cssCallbacks.add( callback );
872 }
874 // Yield once before creating the <style> tag. This lets multiple stylesheets
875 // accumulate into one buffer, allowing us to reduce how often new stylesheets
876 // are inserted in the browser. Appending a stylesheet and waiting for the
877 // browser to repaint is fairly expensive. (T47810)
878 if ( cssText ) {
879 // Don't extend the buffer if the item needs its own stylesheet.
880 // Keywords like `@import` are only valid at the start of a stylesheet (T37562).
881 if ( !cssBuffer || cssText.slice( 0, '@import'.length ) !== '@import' ) {
882 // Linebreak for somewhat distinguishable sections
883 cssBuffer += '\n' + cssText;
884 // TODO: Using requestAnimationFrame would perform better by not injecting
885 // styles while the browser is busy painting.
886 if ( !cssBufferTimer ) {
887 cssBufferTimer = setTimeout( function () {
888 // Support: Firefox < 13
889 // Firefox 12 has non-standard behaviour of passing a number
890 // as first argument to a setTimeout callback.
891 // http://benalman.com/news/2009/07/the-mysterious-firefox-settime/
892 addEmbeddedCSS();
893 } );
894 }
895 return;
896 }
898 // This is a scheduled flush for the buffer
899 } else {
900 cssBufferTimer = null;
901 cssText = cssBuffer;
902 cssBuffer = '';
903 }
905 // By default, always create a new <style>. Appending text to a <style>
906 // tag is bad as it means the contents have to be re-parsed (bug 45810).
907 //
908 // Except, of course, in IE 9 and below. In there we default to re-using and
909 // appending to a <style> tag due to the IE stylesheet limit (bug 31676).
910 if ( 'documentMode' in document && document.documentMode <= 9 ) {
912 $style = getMarker().prev();
913 // Verify that the element before the marker actually is a
914 // <style> tag and one that came from ResourceLoader
915 // (not some other style tag or even a `<meta>` or `<script>`).
916 if ( $style.data( 'ResourceLoaderDynamicStyleTag' ) ) {
917 // There's already a dynamic <style> tag present and
918 // we are able to append more to it.
919 styleEl = $style.get( 0 );
920 // Support: IE6-10
921 if ( styleEl.styleSheet ) {
922 try {
923 // Support: IE9
924 // We can't do styleSheet.cssText += cssText, since IE9 mangles this property on
925 // write, dropping @media queries from the CSS text. If we read it and used its
926 // value, we would accidentally apply @media-specific styles to all media. (T108727)
927 if ( document.documentMode === 9 ) {
928 newCssText = $style.data( 'ResourceLoaderDynamicStyleTag' ) + cssText;
929 styleEl.styleSheet.cssText = newCssText;
930 $style.data( 'ResourceLoaderDynamicStyleTag', newCssText );
931 } else {
932 styleEl.styleSheet.cssText += cssText;
933 }
934 } catch ( e ) {
935 mw.track( 'resourceloader.exception', { exception: e, source: 'stylesheet' } );
936 }
937 } else {
938 styleEl.appendChild( document.createTextNode( cssText ) );
939 }
940 fireCallbacks();
941 return;
942 }
943 }
945 $style = $( newStyleTag( cssText, getMarker() ) );
947 if ( document.documentMode === 9 ) {
948 // Support: IE9
949 // Preserve original CSS text because IE9 mangles it on write
950 $style.data( 'ResourceLoaderDynamicStyleTag', cssText );
951 } else {
952 $style.data( 'ResourceLoaderDynamicStyleTag', true );
953 }
955 fireCallbacks();
956 }
958 /**
959 * @since 1.26
960 * @param {Array} modules List of module names
961 * @return {string} Hash of concatenated version hashes.
962 */
963 function getCombinedVersion( modules ) {
964 var hashes = $.map( modules, function ( module ) {
965 return registry[ module ].version;
966 } );
967 // Trim for consistency with server-side ResourceLoader::makeHash. It also helps
968 // save precious space in the limited query string. Otherwise modules are more
969 // likely to require multiple HTTP requests.
970 return sha1( hashes.join( '' ) ).slice( 0, 12 );
971 }
973 /**
974 * Determine whether all dependencies are in state 'ready', which means we may
975 * execute the module or job now.
976 *
977 * @private
978 * @param {Array} modules Names of modules to be checked
979 * @return {boolean} True if all modules are in state 'ready', false otherwise
980 */
981 function allReady( modules ) {
982 var i;
983 for ( i = 0; i < modules.length; i++ ) {
984 if ( mw.loader.getState( modules[ i ] ) !== 'ready' ) {
985 return false;
986 }
987 }
988 return true;
989 }
991 /**
992 * Determine whether all dependencies are in state 'ready', which means we may
993 * execute the module or job now.
994 *
995 * @private
996 * @param {Array} modules Names of modules to be checked
997 * @return {boolean} True if no modules are in state 'error' or 'missing', false otherwise
998 */
999 function anyFailed( modules ) {
1000 var i, state;
1001 for ( i = 0; i < modules.length; i++ ) {
1002 state = mw.loader.getState( modules[ i ] );
1003 if ( state === 'error' || state === 'missing' ) {
1004 return true;
1005 }
1006 }
1007 return false;
1008 }
1010 /**
1011 * A module has entered state 'ready', 'error', or 'missing'. Automatically update
1012 * pending jobs and modules that depend upon this module. If the given module failed,
1013 * propagate the 'error' state up the dependency tree. Otherwise, go ahead an execute
1014 * all jobs/modules now having their dependencies satisfied.
1015 *
1016 * Jobs that depend on a failed module, will have their error callback ran (if any).
1017 *
1018 * @private
1019 * @param {string} module Name of module that entered one of the states 'ready', 'error', or 'missing'.
1020 */
1021 function handlePending( module ) {
1022 var j, job, hasErrors, m, stateChange;
1024 if ( registry[ module ].state === 'error' || registry[ module ].state === 'missing' ) {
1025 // If the current module failed, mark all dependent modules also as failed.
1026 // Iterate until steady-state to propagate the error state upwards in the
1027 // dependency tree.
1028 do {
1029 stateChange = false;
1030 for ( m in registry ) {
1031 if ( registry[ m ].state !== 'error' && registry[ m ].state !== 'missing' ) {
1032 if ( anyFailed( registry[ m ].dependencies ) ) {
1033 registry[ m ].state = 'error';
1034 stateChange = true;
1035 }
1036 }
1037 }
1038 } while ( stateChange );
1039 }
1041 // Execute all jobs whose dependencies are either all satisfied or contain at least one failed module.
1042 for ( j = 0; j < jobs.length; j++ ) {
1043 hasErrors = anyFailed( jobs[ j ].dependencies );
1044 if ( hasErrors || allReady( jobs[ j ].dependencies ) ) {
1045 // All dependencies satisfied, or some have errors
1046 job = jobs[ j ];
1047 jobs.splice( j, 1 );
1048 j -= 1;
1049 try {
1050 if ( hasErrors ) {
1051 if ( $.isFunction( job.error ) ) {
1052 job.error( new Error( 'Module ' + module + ' has failed dependencies' ), [ module ] );
1053 }
1054 } else {
1055 if ( $.isFunction( job.ready ) ) {
1056 job.ready();
1057 }
1058 }
1059 } catch ( e ) {
1060 // A user-defined callback raised an exception.
1061 // Swallow it to protect our state machine!
1062 mw.track( 'resourceloader.exception', { exception: e, module: module, source: 'load-callback' } );
1063 }
1064 }
1065 }
1067 if ( registry[ module ].state === 'ready' ) {
1068 // The current module became 'ready'. Set it in the module store, and recursively execute all
1069 // dependent modules that are loaded and now have all dependencies satisfied.
1070 mw.loader.store.set( module, registry[ module ] );
1071 for ( m in registry ) {
1072 if ( registry[ m ].state === 'loaded' && allReady( registry[ m ].dependencies ) ) {
1073 execute( m );
1074 }
1075 }
1076 }
1077 }
1079 /**
1080 * Resolve dependencies and detect circular references.
1081 *
1082 * @private
1083 * @param {string} module Name of the top-level module whose dependencies shall be
1084 * resolved and sorted.
1085 * @param {Array} resolved Returns a topological sort of the given module and its
1086 * dependencies, such that later modules depend on earlier modules. The array
1087 * contains the module names. If the array contains already some module names,
1088 * this function appends its result to the pre-existing array.
1089 * @param {Object} [unresolved] Hash used to track the current dependency
1090 * chain; used to report loops in the dependency graph.
1091 * @throws {Error} If any unregistered module or a dependency loop is encountered
1092 */
1093 function sortDependencies( module, resolved, unresolved ) {
1094 var i, deps, skip;
1096 if ( !hasOwn.call( registry, module ) ) {
1097 throw new Error( 'Unknown dependency: ' + module );
1098 }
1100 if ( registry[ module ].skip !== null ) {
1101 /*jshint evil:true */
1102 skip = new Function( registry[ module ].skip );
1103 registry[ module ].skip = null;
1104 if ( skip() ) {
1105 registry[ module ].skipped = true;
1106 registry[ module ].dependencies = [];
1107 registry[ module ].state = 'ready';
1108 handlePending( module );
1109 return;
1110 }
1111 }
1113 // Resolves dynamic loader function and replaces it with its own results
1114 if ( $.isFunction( registry[ module ].dependencies ) ) {
1115 registry[ module ].dependencies = registry[ module ].dependencies();
1116 // Ensures the module's dependencies are always in an array
1117 if ( typeof registry[ module ].dependencies !== 'object' ) {
1118 registry[ module ].dependencies = [ registry[ module ].dependencies ];
1119 }
1120 }
1121 if ( $.inArray( module, resolved ) !== -1 ) {
1122 // Module already resolved; nothing to do
1123 return;
1124 }
1125 // Create unresolved if not passed in
1126 if ( !unresolved ) {
1127 unresolved = {};
1128 }
1129 // Tracks down dependencies
1130 deps = registry[ module ].dependencies;
1131 for ( i = 0; i < deps.length; i++ ) {
1132 if ( $.inArray( deps[ i ], resolved ) === -1 ) {
1133 if ( unresolved[ deps[ i ] ] ) {
1134 throw new Error( mw.format(
1135 'Circular reference detected: $1 -> $2',
1136 module,
1137 deps[ i ]
1138 ) );
1139 }
1141 // Add to unresolved
1142 unresolved[ module ] = true;
1143 sortDependencies( deps[ i ], resolved, unresolved );
1144 }
1145 }
1146 resolved.push( module );
1147 }
1149 /**
1150 * Get names of module that a module depends on, in their proper dependency order.
1151 *
1152 * @private
1153 * @param {string[]} modules Array of string module names
1154 * @return {Array} List of dependencies, including 'module'.
1155 */
1156 function resolve( modules ) {
1157 var resolved = [];
1158 $.each( modules, function ( idx, module ) {
1159 sortDependencies( module, resolved );
1160 } );
1161 return resolved;
1162 }
1164 /**
1165 * Load and execute a script.
1166 *
1167 * @private
1168 * @param {string} src URL to script, will be used as the src attribute in the script tag
1169 * @return {jQuery.Promise}
1170 */
1171 function addScript( src ) {
1172 return $.ajax( {
1173 url: src,
1174 dataType: 'script',
1175 // Force jQuery behaviour to be for crossDomain. Otherwise jQuery would use
1176 // XHR for a same domain request instead of <script>, which changes the request
1177 // headers (potentially missing a cache hit), and reduces caching in general
1178 // since browsers cache XHR much less (if at all). And XHR means we retreive
1179 // text, so we'd need to $.globalEval, which then messes up line numbers.
1180 crossDomain: true,
1181 cache: true
1182 } );
1183 }
1185 /**
1186 * Utility function for execute()
1187 *
1188 * @ignore
1189 */
1190 function addLink( media, url ) {
1191 var el = document.createElement( 'link' );
1192 // Support: IE
1193 // Insert in document *before* setting href
1194 getMarker().before( el );
1195 el.rel = 'stylesheet';
1196 if ( media && media !== 'all' ) {
1197 el.media = media;
1198 }
1199 // If you end up here from an IE exception "SCRIPT: Invalid property value.",
1200 // see #addEmbeddedCSS, bug 31676, and bug 47277 for details.
1201 el.href = url;
1202 }
1204 /**
1205 * Executes a loaded module, making it ready to use
1206 *
1207 * @private
1208 * @param {string} module Module name to execute
1209 */
1210 function execute( module ) {
1211 var key, value, media, i, urls, cssHandle, checkCssHandles, runScript,
1212 cssHandlesRegistered = false;
1214 if ( !hasOwn.call( registry, module ) ) {
1215 throw new Error( 'Module has not been registered yet: ' + module );
1216 }
1217 if ( registry[ module ].state !== 'loaded' ) {
1218 throw new Error( 'Module in state "' + registry[ module ].state + '" may not be executed: ' + module );
1219 }
1221 registry[ module ].state = 'executing';
1223 runScript = function () {
1224 var script, markModuleReady, nestedAddScript, legacyWait,
1225 // Expand to include dependencies since we have to exclude both legacy modules
1226 // and their dependencies from the legacyWait (to prevent a circular dependency).
1227 legacyModules = resolve( mw.config.get( 'wgResourceLoaderLegacyModules', [] ) );
1228 try {
1229 script = registry[ module ].script;
1230 markModuleReady = function () {
1231 registry[ module ].state = 'ready';
1232 handlePending( module );
1233 };
1234 nestedAddScript = function ( arr, callback, i ) {
1235 // Recursively call addScript() in its own callback
1236 // for each element of arr.
1237 if ( i >= arr.length ) {
1238 // We're at the end of the array
1239 callback();
1240 return;
1241 }
1243 addScript( arr[ i ] ).always( function () {
1244 nestedAddScript( arr, callback, i + 1 );
1245 } );
1246 };
1248 legacyWait = ( $.inArray( module, legacyModules ) !== -1 )
1249 ? $.Deferred().resolve()
1250 : mw.loader.using( legacyModules );
1252 legacyWait.always( function () {
1253 if ( $.isArray( script ) ) {
1254 nestedAddScript( script, markModuleReady, 0 );
1255 } else if ( $.isFunction( script ) ) {
1256 // Pass jQuery twice so that the signature of the closure which wraps
1257 // the script can bind both '$' and 'jQuery'.
1258 script( $, $ );
1259 markModuleReady();
1260 } else if ( typeof script === 'string' ) {
1261 // Site and user modules are a legacy scripts that run in the global scope.
1262 // This is transported as a string instead of a function to avoid needing
1263 // to use string manipulation to undo the function wrapper.
1264 if ( module === 'user' ) {
1265 // Implicit dependency on the site module. Not real dependency because
1266 // it should run after 'site' regardless of whether it succeeds or fails.
1267 mw.loader.using( 'site' ).always( function () {
1268 $.globalEval( script );
1269 markModuleReady();
1270 } );
1271 } else {
1272 $.globalEval( script );
1273 markModuleReady();
1274 }
1275 } else {
1276 // Module without script
1277 markModuleReady();
1278 }
1279 } );
1280 } catch ( e ) {
1281 // This needs to NOT use mw.log because these errors are common in production mode
1282 // and not in debug mode, such as when a symbol that should be global isn't exported
1283 registry[ module ].state = 'error';
1284 mw.track( 'resourceloader.exception', { exception: e, module: module, source: 'module-execute' } );
1285 handlePending( module );
1286 }
1287 };
1289 // Add localizations to message system
1290 if ( registry[ module ].messages ) {
1291 mw.messages.set( registry[ module ].messages );
1292 }
1294 // Initialise templates
1295 if ( registry[ module ].templates ) {
1296 mw.templates.set( module, registry[ module ].templates );
1297 }
1299 // Make sure we don't run the scripts until all stylesheet insertions have completed.
1300 ( function () {
1301 var pending = 0;
1302 checkCssHandles = function () {
1303 // cssHandlesRegistered ensures we don't take off too soon, e.g. when
1304 // one of the cssHandles is fired while we're still creating more handles.
1305 if ( cssHandlesRegistered && pending === 0 && runScript ) {
1306 runScript();
1307 runScript = undefined; // Revoke
1308 }
1309 };
1310 cssHandle = function () {
1311 var check = checkCssHandles;
1312 pending++;
1313 return function () {
1314 if ( check ) {
1315 pending--;
1316 check();
1317 check = undefined; // Revoke
1318 }
1319 };
1320 };
1321 }() );
1323 // Process styles (see also mw.loader.implement)
1324 // * back-compat: { <media>: css }
1325 // * back-compat: { <media>: [url, ..] }
1326 // * { "css": [css, ..] }
1327 // * { "url": { <media>: [url, ..] } }
1328 if ( registry[ module ].style ) {
1329 for ( key in registry[ module ].style ) {
1330 value = registry[ module ].style[ key ];
1331 media = undefined;
1333 if ( key !== 'url' && key !== 'css' ) {
1334 // Backwards compatibility, key is a media-type
1335 if ( typeof value === 'string' ) {
1336 // back-compat: { <media>: css }
1337 // Ignore 'media' because it isn't supported (nor was it used).
1338 // Strings are pre-wrapped in "@media". The media-type was just ""
1339 // (because it had to be set to something).
1340 // This is one of the reasons why this format is no longer used.
1341 addEmbeddedCSS( value, cssHandle() );
1342 } else {
1343 // back-compat: { <media>: [url, ..] }
1344 media = key;
1345 key = 'bc-url';
1346 }
1347 }
1349 // Array of css strings in key 'css',
1350 // or back-compat array of urls from media-type
1351 if ( $.isArray( value ) ) {
1352 for ( i = 0; i < value.length; i++ ) {
1353 if ( key === 'bc-url' ) {
1354 // back-compat: { <media>: [url, ..] }
1355 addLink( media, value[ i ] );
1356 } else if ( key === 'css' ) {
1357 // { "css": [css, ..] }
1358 addEmbeddedCSS( value[ i ], cssHandle() );
1359 }
1360 }
1361 // Not an array, but a regular object
1362 // Array of urls inside media-type key
1363 } else if ( typeof value === 'object' ) {
1364 // { "url": { <media>: [url, ..] } }
1365 for ( media in value ) {
1366 urls = value[ media ];
1367 for ( i = 0; i < urls.length; i++ ) {
1368 addLink( media, urls[ i ] );
1369 }
1370 }
1371 }
1372 }
1373 }
1375 // Kick off.
1376 cssHandlesRegistered = true;
1377 checkCssHandles();
1378 }
1380 /**
1381 * Adds a dependencies to the queue with optional callbacks to be run
1382 * when the dependencies are ready or fail
1383 *
1384 * @private
1385 * @param {string|string[]} dependencies Module name or array of string module names
1386 * @param {Function} [ready] Callback to execute when all dependencies are ready
1387 * @param {Function} [error] Callback to execute when any dependency fails
1388 */
1389 function request( dependencies, ready, error ) {
1390 // Allow calling by single module name
1391 if ( typeof dependencies === 'string' ) {
1392 dependencies = [ dependencies ];
1393 }
1395 // Add ready and error callbacks if they were given
1396 if ( ready !== undefined || error !== undefined ) {
1397 jobs.push( {
1398 // Narrow down the list to modules that are worth waiting for
1399 dependencies: $.grep( dependencies, function ( module ) {
1400 var state = mw.loader.getState( module );
1401 return state === 'registered' || state === 'loaded' || state === 'loading' || state === 'executing';
1402 } ),
1403 ready: ready,
1404 error: error
1405 } );
1406 }
1408 $.each( dependencies, function ( idx, module ) {
1409 var state = mw.loader.getState( module );
1410 // Only queue modules that are still in the initial 'registered' state
1411 // (not ones already loading, ready or error).
1412 if ( state === 'registered' && $.inArray( module, queue ) === -1 ) {
1413 // Private modules must be embedded in the page. Don't bother queuing
1414 // these as the server will deny them anyway (T101806).
1415 if ( registry[ module ].group === 'private' ) {
1416 registry[ module ].state = 'error';
1417 handlePending( module );
1418 return;
1419 }
1420 queue.push( module );
1421 }
1422 } );
1424 mw.loader.work();
1425 }
1427 function sortQuery( o ) {
1428 var key,
1429 sorted = {},
1430 a = [];
1432 for ( key in o ) {
1433 if ( hasOwn.call( o, key ) ) {
1434 a.push( key );
1435 }
1436 }
1437 a.sort();
1438 for ( key = 0; key < a.length; key++ ) {
1439 sorted[ a[ key ] ] = o[ a[ key ] ];
1440 }
1441 return sorted;
1442 }
1444 /**
1445 * Converts a module map of the form { foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }
1446 * to a query string of the form foo.bar,baz|bar.baz,quux
1447 *
1448 * @private
1449 */
1450 function buildModulesString( moduleMap ) {
1451 var p, prefix,
1452 arr = [];
1454 for ( prefix in moduleMap ) {
1455 p = prefix === '' ? '' : prefix + '.';
1456 arr.push( p + moduleMap[ prefix ].join( ',' ) );
1457 }
1458 return arr.join( '|' );
1459 }
1461 /**
1462 * Load modules from load.php
1463 *
1464 * @private
1465 * @param {Object} moduleMap Module map, see #buildModulesString
1466 * @param {Object} currReqBase Object with other parameters (other than 'modules') to use in the request
1467 * @param {string} sourceLoadScript URL of load.php
1468 */
1469 function doRequest( moduleMap, currReqBase, sourceLoadScript ) {
1470 var request = $.extend(
1471 { modules: buildModulesString( moduleMap ) },
1472 currReqBase
1473 );
1474 request = sortQuery( request );
1475 addScript( sourceLoadScript + '?' + $.param( request ) );
1476 }
1478 /**
1479 * Resolve indexed dependencies.
1480 *
1481 * ResourceLoader uses an optimization to save space which replaces module names in
1482 * dependency lists with the index of that module within the array of module
1483 * registration data if it exists. The benefit is a significant reduction in the data
1484 * size of the startup module. This function changes those dependency lists back to
1485 * arrays of strings.
1486 *
1487 * @param {Array} modules Modules array
1488 */
1489 function resolveIndexedDependencies( modules ) {
1490 $.each( modules, function ( idx, module ) {
1491 if ( module[ 2 ] ) {
1492 module[ 2 ] = $.map( module[ 2 ], function ( dep ) {
1493 return typeof dep === 'number' ? modules[ dep ][ 0 ] : dep;
1494 } );
1495 }
1496 } );
1497 }
1499 /* Public Members */
1500 return {
1501 /**
1502 * The module registry is exposed as an aid for debugging and inspecting page
1503 * state; it is not a public interface for modifying the registry.
1504 *
1505 * @see #registry
1506 * @property
1507 * @private
1508 */
1509 moduleRegistry: registry,
1511 /**
1512 * @inheritdoc #newStyleTag
1513 * @method
1514 */
1515 addStyleTag: newStyleTag,
1517 /**
1518 * Batch-request queued dependencies from the server.
1519 */
1520 work: function () {
1521 var reqBase, splits, maxQueryLength, q, b, bSource, bGroup, bSourceGroup,
1522 source, concatSource, origBatch, group, i, modules, sourceLoadScript,
1523 currReqBase, currReqBaseLength, moduleMap, l,
1524 lastDotIndex, prefix, suffix, bytesAdded;
1526 // Build a list of request parameters common to all requests.
1527 reqBase = {
1528 skin: mw.config.get( 'skin' ),
1529 lang: mw.config.get( 'wgUserLanguage' ),
1530 debug: mw.config.get( 'debug' )
1531 };
1532 // Split module batch by source and by group.
1533 splits = {};
1534 maxQueryLength = mw.config.get( 'wgResourceLoaderMaxQueryLength', 2000 );
1536 // Appends a list of modules from the queue to the batch
1537 for ( q = 0; q < queue.length; q++ ) {
1538 // Only request modules which are registered
1539 if ( hasOwn.call( registry, queue[ q ] ) && registry[ queue[ q ] ].state === 'registered' ) {
1540 // Prevent duplicate entries
1541 if ( $.inArray( queue[ q ], batch ) === -1 ) {
1542 batch.push( queue[ q ] );
1543 // Mark registered modules as loading
1544 registry[ queue[ q ] ].state = 'loading';
1545 }
1546 }
1547 }
1549 mw.loader.store.init();
1550 if ( mw.loader.store.enabled ) {
1551 concatSource = [];
1552 origBatch = batch;
1553 batch = $.grep( batch, function ( module ) {
1554 var source = mw.loader.store.get( module );
1555 if ( source ) {
1556 concatSource.push( source );
1557 return false;
1558 }
1559 return true;
1560 } );
1561 try {
1562 $.globalEval( concatSource.join( ';' ) );
1563 } catch ( err ) {
1564 // Not good, the cached mw.loader.implement calls failed! This should
1565 // never happen, barring ResourceLoader bugs, browser bugs and PEBKACs.
1566 // Depending on how corrupt the string is, it is likely that some
1567 // modules' implement() succeeded while the ones after the error will
1568 // never run and leave their modules in the 'loading' state forever.
1570 // Since this is an error not caused by an individual module but by
1571 // something that infected the implement call itself, don't take any
1572 // risks and clear everything in this cache.
1573 mw.loader.store.clear();
1574 // Re-add the ones still pending back to the batch and let the server
1575 // repopulate these modules to the cache.
1576 // This means that at most one module will be useless (the one that had
1577 // the error) instead of all of them.
1578 mw.track( 'resourceloader.exception', { exception: err, source: 'store-eval' } );
1579 origBatch = $.grep( origBatch, function ( module ) {
1580 return registry[ module ].state === 'loading';
1581 } );
1582 batch = batch.concat( origBatch );
1583 }
1584 }
1586 // Early exit if there's nothing to load...
1587 if ( !batch.length ) {
1588 return;
1589 }
1591 // The queue has been processed into the batch, clear up the queue.
1592 queue = [];
1594 // Always order modules alphabetically to help reduce cache
1595 // misses for otherwise identical content.
1596 batch.sort();
1598 // Split batch by source and by group.
1599 for ( b = 0; b < batch.length; b++ ) {
1600 bSource = registry[ batch[ b ] ].source;
1601 bGroup = registry[ batch[ b ] ].group;
1602 if ( !hasOwn.call( splits, bSource ) ) {
1603 splits[ bSource ] = {};
1604 }
1605 if ( !hasOwn.call( splits[ bSource ], bGroup ) ) {
1606 splits[ bSource ][ bGroup ] = [];
1607 }
1608 bSourceGroup = splits[ bSource ][ bGroup ];
1609 bSourceGroup.push( batch[ b ] );
1610 }
1612 // Clear the batch - this MUST happen before we append any
1613 // script elements to the body or it's possible that a script
1614 // will be locally cached, instantly load, and work the batch
1615 // again, all before we've cleared it causing each request to
1616 // include modules which are already loaded.
1617 batch = [];
1619 for ( source in splits ) {
1621 sourceLoadScript = sources[ source ];
1623 for ( group in splits[ source ] ) {
1625 // Cache access to currently selected list of
1626 // modules for this group from this source.
1627 modules = splits[ source ][ group ];
1629 currReqBase = $.extend( {
1630 version: getCombinedVersion( modules )
1631 }, reqBase );
1632 // For user modules append a user name to the request.
1633 if ( group === 'user' && mw.config.get( 'wgUserName' ) !== null ) {
1634 currReqBase.user = mw.config.get( 'wgUserName' );
1635 }
1636 currReqBaseLength = $.param( currReqBase ).length;
1637 // We may need to split up the request to honor the query string length limit,
1638 // so build it piece by piece.
1639 l = currReqBaseLength + 9; // '&modules='.length == 9
1641 moduleMap = {}; // { prefix: [ suffixes ] }
1643 for ( i = 0; i < modules.length; i++ ) {
1644 // Determine how many bytes this module would add to the query string
1645 lastDotIndex = modules[ i ].lastIndexOf( '.' );
1647 // If lastDotIndex is -1, substr() returns an empty string
1648 prefix = modules[ i ].substr( 0, lastDotIndex );
1649 suffix = modules[ i ].slice( lastDotIndex + 1 );
1651 bytesAdded = hasOwn.call( moduleMap, prefix )
1652 ? suffix.length + 3 // '%2C'.length == 3
1653 : modules[ i ].length + 3; // '%7C'.length == 3
1655 // If the request would become too long, create a new one,
1656 // but don't create empty requests
1657 if ( maxQueryLength > 0 && !$.isEmptyObject( moduleMap ) && l + bytesAdded > maxQueryLength ) {
1658 // This request would become too long, create a new one
1659 // and fire off the old one
1660 doRequest( moduleMap, currReqBase, sourceLoadScript );
1661 moduleMap = {};
1662 l = currReqBaseLength + 9;
1663 mw.track( 'resourceloader.splitRequest', { maxQueryLength: maxQueryLength } );
1664 }
1665 if ( !hasOwn.call( moduleMap, prefix ) ) {
1666 moduleMap[ prefix ] = [];
1667 }
1668 moduleMap[ prefix ].push( suffix );
1669 l += bytesAdded;
1670 }
1671 // If there's anything left in moduleMap, request that too
1672 if ( !$.isEmptyObject( moduleMap ) ) {
1673 doRequest( moduleMap, currReqBase, sourceLoadScript );
1674 }
1675 }
1676 }
1677 },
1679 /**
1680 * Register a source.
1681 *
1682 * The #work() method will use this information to split up requests by source.
1683 *
1684 * mw.loader.addSource( 'mediawikiwiki', '//www.mediawiki.org/w/load.php' );
1685 *
1686 * @param {string|Object} id Source ID, or object mapping ids to load urls
1687 * @param {string} loadUrl Url to a load.php end point
1688 * @throws {Error} If source id is already registered
1689 */
1690 addSource: function ( id, loadUrl ) {
1691 var source;
1692 // Allow multiple additions
1693 if ( typeof id === 'object' ) {
1694 for ( source in id ) {
1695 mw.loader.addSource( source, id[ source ] );
1696 }
1697 return;
1698 }
1700 if ( hasOwn.call( sources, id ) ) {
1701 throw new Error( 'source already registered: ' + id );
1702 }
1704 sources[ id ] = loadUrl;
1705 },
1707 /**
1708 * Register a module, letting the system know about it and its properties.
1709 *
1710 * The startup modules contain calls to this method.
1711 *
1712 * When using multiple module registration by passing an array, dependencies that
1713 * are specified as references to modules within the array will be resolved before
1714 * the modules are registered.
1715 *
1716 * @param {string|Array} module Module name or array of arrays, each containing
1717 * a list of arguments compatible with this method
1718 * @param {string|number} version Module version hash (falls backs to empty string)
1719 * Can also be a number (timestamp) for compatibility with MediaWiki 1.25 and earlier.
1720 * @param {string|Array|Function} dependencies One string or array of strings of module
1721 * names on which this module depends, or a function that returns that array.
1722 * @param {string} [group=null] Group which the module is in
1723 * @param {string} [source='local'] Name of the source
1724 * @param {string} [skip=null] Script body of the skip function
1725 */
1726 register: function ( module, version, dependencies, group, source, skip ) {
1727 var i;
1728 // Allow multiple registration
1729 if ( typeof module === 'object' ) {
1730 resolveIndexedDependencies( module );
1731 for ( i = 0; i < module.length; i++ ) {
1732 // module is an array of module names
1733 if ( typeof module[ i ] === 'string' ) {
1734 mw.loader.register( module[ i ] );
1735 // module is an array of arrays
1736 } else if ( typeof module[ i ] === 'object' ) {
1737 mw.loader.register.apply( mw.loader, module[ i ] );
1738 }
1739 }
1740 return;
1741 }
1742 // Validate input
1743 if ( typeof module !== 'string' ) {
1744 throw new Error( 'module must be a string, not a ' + typeof module );
1745 }
1746 if ( hasOwn.call( registry, module ) ) {
1747 throw new Error( 'module already registered: ' + module );
1748 }
1749 // List the module as registered
1750 registry[ module ] = {
1751 version: version !== undefined ? String( version ) : '',
1752 dependencies: [],
1753 group: typeof group === 'string' ? group : null,
1754 source: typeof source === 'string' ? source : 'local',
1755 state: 'registered',
1756 skip: typeof skip === 'string' ? skip : null
1757 };
1758 if ( typeof dependencies === 'string' ) {
1759 // Allow dependencies to be given as a single module name
1760 registry[ module ].dependencies = [ dependencies ];
1761 } else if ( typeof dependencies === 'object' || $.isFunction( dependencies ) ) {
1762 // Allow dependencies to be given as an array of module names
1763 // or a function which returns an array
1764 registry[ module ].dependencies = dependencies;
1765 }
1766 },
1768 /**
1769 * Implement a module given the components that make up the module.
1770 *
1771 * When #load or #using requests one or more modules, the server
1772 * response contain calls to this function.
1773 *
1774 * All arguments are required.
1775 *
1776 * @param {string} module Name of module
1777 * @param {Function|Array} script Function with module code or Array of URLs to
1778 * be used as the src attribute of a new `<script>` tag.
1779 * @param {Object} [style] Should follow one of the following patterns:
1780 *
1781 * { "css": [css, ..] }
1782 * { "url": { <media>: [url, ..] } }
1783 *
1784 * And for backwards compatibility (needs to be supported forever due to caching):
1785 *
1786 * { <media>: css }
1787 * { <media>: [url, ..] }
1788 *
1789 * The reason css strings are not concatenated anymore is bug 31676. We now check
1790 * whether it's safe to extend the stylesheet.
1791 *
1792 * @param {Object} [messages] List of key/value pairs to be added to mw#messages.
1793 * @param {Object} [templates] List of key/value pairs to be added to mw#templates.
1794 */
1795 implement: function ( module, script, style, messages, templates ) {
1796 // Validate input
1797 if ( typeof module !== 'string' ) {
1798 throw new Error( 'module must be of type string, not ' + typeof module );
1799 }
1800 if ( script && !$.isFunction( script ) && !$.isArray( script ) && typeof script !== 'string' ) {
1801 throw new Error( 'script must be of type function, array, or script; not ' + typeof script );
1802 }
1803 if ( style && !$.isPlainObject( style ) ) {
1804 throw new Error( 'style must be of type object, not ' + typeof style );
1805 }
1806 if ( messages && !$.isPlainObject( messages ) ) {
1807 throw new Error( 'messages must be of type object, not a ' + typeof messages );
1808 }
1809 if ( templates && !$.isPlainObject( templates ) ) {
1810 throw new Error( 'templates must be of type object, not a ' + typeof templates );
1811 }
1812 // Automatically register module
1813 if ( !hasOwn.call( registry, module ) ) {
1814 mw.loader.register( module );
1815 }
1816 // Check for duplicate implementation
1817 if ( hasOwn.call( registry, module ) && registry[ module ].script !== undefined ) {
1818 throw new Error( 'module already implemented: ' + module );
1819 }
1820 // Attach components
1821 registry[ module ].script = script || null;
1822 registry[ module ].style = style || null;
1823 registry[ module ].messages = messages || null;
1824 registry[ module ].templates = templates || null;
1825 // The module may already have been marked as erroneous
1826 if ( $.inArray( registry[ module ].state, [ 'error', 'missing' ] ) === -1 ) {
1827 registry[ module ].state = 'loaded';
1828 if ( allReady( registry[ module ].dependencies ) ) {
1829 execute( module );
1830 }
1831 }
1832 },
1834 /**
1835 * Execute a function as soon as one or more required modules are ready.
1836 *
1837 * Example of inline dependency on OOjs:
1838 *
1839 * mw.loader.using( 'oojs', function () {
1840 * OO.compare( [ 1 ], [ 1 ] );
1841 * } );
1842 *
1843 * @param {string|Array} dependencies Module name or array of modules names the callback
1844 * dependends on to be ready before executing
1845 * @param {Function} [ready] Callback to execute when all dependencies are ready
1846 * @param {Function} [error] Callback to execute if one or more dependencies failed
1847 * @return {jQuery.Promise}
1848 * @since 1.23 this returns a promise
1849 */
1850 using: function ( dependencies, ready, error ) {
1851 var deferred = $.Deferred();
1853 // Allow calling with a single dependency as a string
1854 if ( typeof dependencies === 'string' ) {
1855 dependencies = [ dependencies ];
1856 } else if ( !$.isArray( dependencies ) ) {
1857 // Invalid input
1858 throw new Error( 'Dependencies must be a string or an array' );
1859 }
1861 if ( ready ) {
1862 deferred.done( ready );
1863 }
1864 if ( error ) {
1865 deferred.fail( error );
1866 }
1868 // Resolve entire dependency map
1869 dependencies = resolve( dependencies );
1870 if ( allReady( dependencies ) ) {
1871 // Run ready immediately
1872 deferred.resolve();
1873 } else if ( anyFailed( dependencies ) ) {
1874 // Execute error immediately if any dependencies have errors
1875 deferred.reject(
1876 new Error( 'One or more dependencies failed to load' ),
1877 dependencies
1878 );
1879 } else {
1880 // Not all dependencies are ready: queue up a request
1881 request( dependencies, deferred.resolve, deferred.reject );
1882 }
1884 return deferred.promise();
1885 },
1887 /**
1888 * Load an external script or one or more modules.
1889 *
1890 * @param {string|Array} modules Either the name of a module, array of modules,
1891 * or a URL of an external script or style
1892 * @param {string} [type='text/javascript'] MIME type to use if calling with a URL of an
1893 * external script or style; acceptable values are "text/css" and
1894 * "text/javascript"; if no type is provided, text/javascript is assumed.
1895 */
1896 load: function ( modules, type ) {
1897 var filtered, l;
1899 // Validate input
1900 if ( typeof modules !== 'object' && typeof modules !== 'string' ) {
1901 throw new Error( 'modules must be a string or an array, not a ' + typeof modules );
1902 }
1903 // Allow calling with a url or single dependency as a string
1904 if ( typeof modules === 'string' ) {
1905 // "https://example.org/x.js", "http://example.org/x.js", "//example.org/x.js", "/x.js"
1906 if ( /^(https?:)?\/?\//.test( modules ) ) {
1907 if ( type === 'text/css' ) {
1908 // Support: IE 7-8
1909 // Use properties instead of attributes as IE throws security
1910 // warnings when inserting a <link> tag with a protocol-relative
1911 // URL set though attributes - when on HTTPS. See bug 41331.
1912 l = document.createElement( 'link' );
1913 l.rel = 'stylesheet';
1914 l.href = modules;
1915 $( 'head' ).append( l );
1916 return;
1917 }
1918 if ( type === 'text/javascript' || type === undefined ) {
1919 addScript( modules );
1920 return;
1921 }
1922 // Unknown type
1923 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type );
1924 }
1925 // Called with single module
1926 modules = [ modules ];
1927 }
1929 // Filter out undefined modules, otherwise resolve() will throw
1930 // an exception for trying to load an undefined module.
1931 // Undefined modules are acceptable here in load(), because load() takes
1932 // an array of unrelated modules, whereas the modules passed to
1933 // using() are related and must all be loaded.
1934 filtered = $.grep( modules, function ( module ) {
1935 var state = mw.loader.getState( module );
1936 return state !== null && state !== 'error' && state !== 'missing';
1937 } );
1939 if ( filtered.length === 0 ) {
1940 return;
1941 }
1942 // Resolve entire dependency map
1943 filtered = resolve( filtered );
1944 // If all modules are ready, or if any modules have errors, nothing to be done.
1945 if ( allReady( filtered ) || anyFailed( filtered ) ) {
1946 return;
1947 }
1948 // Since some modules are not yet ready, queue up a request.
1949 request( filtered, undefined, undefined );
1950 },
1952 /**
1953 * Change the state of one or more modules.
1954 *
1955 * @param {string|Object} module Module name or object of module name/state pairs
1956 * @param {string} state State name
1957 */
1958 state: function ( module, state ) {
1959 var m;
1961 if ( typeof module === 'object' ) {
1962 for ( m in module ) {
1963 mw.loader.state( m, module[ m ] );
1964 }
1965 return;
1966 }
1967 if ( !hasOwn.call( registry, module ) ) {
1968 mw.loader.register( module );
1969 }
1970 if ( $.inArray( state, [ 'ready', 'error', 'missing' ] ) !== -1
1971 && registry[ module ].state !== state ) {
1972 // Make sure pending modules depending on this one get executed if their
1973 // dependencies are now fulfilled!
1974 registry[ module ].state = state;
1975 handlePending( module );
1976 } else {
1977 registry[ module ].state = state;
1978 }
1979 },
1981 /**
1982 * Get the version of a module.
1983 *
1984 * @param {string} module Name of module
1985 * @return {string|null} The version, or null if the module (or its version) is not
1986 * in the registry.
1987 */
1988 getVersion: function ( module ) {
1989 if ( !hasOwn.call( registry, module ) || registry[ module ].version === undefined ) {
1990 return null;
1991 }
1992 return registry[ module ].version;
1993 },
1995 /**
1996 * Get the state of a module.
1997 *
1998 * @param {string} module Name of module
1999 * @return {string|null} The state, or null if the module (or its state) is not
2000 * in the registry.
2001 */
2002 getState: function ( module ) {
2003 if ( !hasOwn.call( registry, module ) || registry[ module ].state === undefined ) {
2004 return null;
2005 }
2006 return registry[ module ].state;
2007 },
2009 /**
2010 * Get the names of all registered modules.
2011 *
2012 * @return {Array}
2013 */
2014 getModuleNames: function () {
2015 return $.map( registry, function ( i, key ) {
2016 return key;
2017 } );
2018 },
2020 /**
2021 * @inheritdoc mw.inspect#runReports
2022 * @method
2023 */
2024 inspect: function () {
2025 var args = slice.call( arguments );
2026 mw.loader.using( 'mediawiki.inspect', function () {
2027 mw.inspect.runReports.apply( mw.inspect, args );
2028 } );
2029 },
2031 /**
2032 * On browsers that implement the localStorage API, the module store serves as a
2033 * smart complement to the browser cache. Unlike the browser cache, the module store
2034 * can slice a concatenated response from ResourceLoader into its constituent
2035 * modules and cache each of them separately, using each module's versioning scheme
2036 * to determine when the cache should be invalidated.
2037 *
2038 * @singleton
2039 * @class mw.loader.store
2040 */
2041 store: {
2042 // Whether the store is in use on this page.
2043 enabled: null,
2045 // Modules whose string representation exceeds 100 kB are ineligible
2046 // for storage due to bug T66721.
2047 MODULE_SIZE_MAX: 100000,
2049 // The contents of the store, mapping '[module name]@[version]' keys
2050 // to module implementations.
2051 items: {},
2053 // Cache hit stats
2054 stats: { hits: 0, misses: 0, expired: 0 },
2056 /**
2057 * Construct a JSON-serializable object representing the content of the store.
2058 *
2059 * @return {Object} Module store contents.
2060 */
2061 toJSON: function () {
2062 return { items: mw.loader.store.items, vary: mw.loader.store.getVary() };
2063 },
2065 /**
2066 * Get the localStorage key for the entire module store. The key references
2067 * $wgDBname to prevent clashes between wikis which share a common host.
2068 *
2069 * @return {string} localStorage item key
2070 */
2071 getStoreKey: function () {
2072 return 'MediaWikiModuleStore:' + mw.config.get( 'wgDBname' );
2073 },
2075 /**
2076 * Get a key on which to vary the module cache.
2077 *
2078 * @return {string} String of concatenated vary conditions.
2079 */
2080 getVary: function () {
2081 return [
2082 mw.config.get( 'skin' ),
2083 mw.config.get( 'wgResourceLoaderStorageVersion' ),
2084 mw.config.get( 'wgUserLanguage' )
2085 ].join( ':' );
2086 },
2088 /**
2089 * Get a key for a specific module. The key format is '[name]@[version]'.
2090 *
2091 * @param {string} module Module name
2092 * @return {string|null} Module key or null if module does not exist
2093 */
2094 getModuleKey: function ( module ) {
2095 return hasOwn.call( registry, module ) ?
2096 ( module + '@' + registry[ module ].version ) : null;
2097 },
2099 /**
2100 * Initialize the store.
2101 *
2102 * Retrieves store from localStorage and (if successfully retrieved) decoding
2103 * the stored JSON value to a plain object.
2104 *
2105 * The try / catch block is used for JSON & localStorage feature detection.
2106 * See the in-line documentation for Modernizr's localStorage feature detection
2107 * code for a full account of why we need a try / catch:
2108 * <https://github.com/Modernizr/Modernizr/blob/v2.7.1/modernizr.js#L771-L796>.
2109 */
2110 init: function () {
2111 var raw, data;
2113 if ( mw.loader.store.enabled !== null ) {
2114 // Init already ran
2115 return;
2116 }
2118 if ( !mw.config.get( 'wgResourceLoaderStorageEnabled' ) ) {
2119 // Disabled by configuration.
2120 // Clear any previous store to free up space. (T66721)
2121 mw.loader.store.clear();
2122 mw.loader.store.enabled = false;
2123 return;
2124 }
2125 if ( mw.config.get( 'debug' ) ) {
2126 // Disable module store in debug mode
2127 mw.loader.store.enabled = false;
2128 return;
2129 }
2131 try {
2132 raw = localStorage.getItem( mw.loader.store.getStoreKey() );
2133 // If we get here, localStorage is available; mark enabled
2134 mw.loader.store.enabled = true;
2135 data = JSON.parse( raw );
2136 if ( data && typeof data.items === 'object' && data.vary === mw.loader.store.getVary() ) {
2137 mw.loader.store.items = data.items;
2138 return;
2139 }
2140 } catch ( e ) {
2141 mw.track( 'resourceloader.exception', { exception: e, source: 'store-localstorage-init' } );
2142 }
2144 if ( raw === undefined ) {
2145 // localStorage failed; disable store
2146 mw.loader.store.enabled = false;
2147 } else {
2148 mw.loader.store.update();
2149 }
2150 },
2152 /**
2153 * Retrieve a module from the store and update cache hit stats.
2154 *
2155 * @param {string} module Module name
2156 * @return {string|boolean} Module implementation or false if unavailable
2157 */
2158 get: function ( module ) {
2159 var key;
2161 if ( !mw.loader.store.enabled ) {
2162 return false;
2163 }
2165 key = mw.loader.store.getModuleKey( module );
2166 if ( key in mw.loader.store.items ) {
2167 mw.loader.store.stats.hits++;
2168 return mw.loader.store.items[ key ];
2169 }
2170 mw.loader.store.stats.misses++;
2171 return false;
2172 },
2174 /**
2175 * Stringify a module and queue it for storage.
2176 *
2177 * @param {string} module Module name
2178 * @param {Object} descriptor The module's descriptor as set in the registry
2179 */
2180 set: function ( module, descriptor ) {
2181 var args, key, src;
2183 if ( !mw.loader.store.enabled ) {
2184 return false;
2185 }
2187 key = mw.loader.store.getModuleKey( module );
2189 if (
2190 // Already stored a copy of this exact version
2191 key in mw.loader.store.items ||
2192 // Module failed to load
2193 descriptor.state !== 'ready' ||
2194 // Unversioned, private, or site-/user-specific
2195 ( !descriptor.version || $.inArray( descriptor.group, [ 'private', 'user' ] ) !== -1 ) ||
2196 // Partial descriptor
2197 $.inArray( undefined, [ descriptor.script, descriptor.style,
2198 descriptor.messages, descriptor.templates ] ) !== -1
2199 ) {
2200 // Decline to store
2201 return false;
2202 }
2204 try {
2205 args = [
2206 JSON.stringify( module ),
2207 typeof descriptor.script === 'function' ?
2208 String( descriptor.script ) :
2209 JSON.stringify( descriptor.script ),
2210 JSON.stringify( descriptor.style ),
2211 JSON.stringify( descriptor.messages ),
2212 JSON.stringify( descriptor.templates )
2213 ];
2214 // Attempted workaround for a possible Opera bug (bug T59567).
2215 // This regex should never match under sane conditions.
2216 if ( /^\s*\(/.test( args[ 1 ] ) ) {
2217 args[ 1 ] = 'function' + args[ 1 ];
2218 mw.track( 'resourceloader.assert', { source: 'bug-T59567' } );
2219 }
2220 } catch ( e ) {
2221 mw.track( 'resourceloader.exception', { exception: e, source: 'store-localstorage-json' } );
2222 return;
2223 }
2225 src = 'mw.loader.implement(' + args.join( ',' ) + ');';
2226 if ( src.length > mw.loader.store.MODULE_SIZE_MAX ) {
2227 return false;
2228 }
2229 mw.loader.store.items[ key ] = src;
2230 mw.loader.store.update();
2231 },
2233 /**
2234 * Iterate through the module store, removing any item that does not correspond
2235 * (in name and version) to an item in the module registry.
2236 */
2237 prune: function () {
2238 var key, module;
2240 if ( !mw.loader.store.enabled ) {
2241 return false;
2242 }
2244 for ( key in mw.loader.store.items ) {
2245 module = key.slice( 0, key.indexOf( '@' ) );
2246 if ( mw.loader.store.getModuleKey( module ) !== key ) {
2247 mw.loader.store.stats.expired++;
2248 delete mw.loader.store.items[ key ];
2249 } else if ( mw.loader.store.items[ key ].length > mw.loader.store.MODULE_SIZE_MAX ) {
2250 // This value predates the enforcement of a size limit on cached modules.
2251 delete mw.loader.store.items[ key ];
2252 }
2253 }
2254 },
2256 /**
2257 * Clear the entire module store right now.
2258 */
2259 clear: function () {
2260 mw.loader.store.items = {};
2261 localStorage.removeItem( mw.loader.store.getStoreKey() );
2262 },
2264 /**
2265 * Sync in-memory store back to localStorage.
2266 *
2267 * This function debounces updates. When called with a flush already pending,
2268 * the call is coalesced into the pending update. The call to
2269 * localStorage.setItem will be naturally deferred until the page is quiescent.
2270 *
2271 * Because localStorage is shared by all pages from the same origin, if multiple
2272 * pages are loaded with different module sets, the possibility exists that
2273 * modules saved by one page will be clobbered by another. But the impact would
2274 * be minor and the problem would be corrected by subsequent page views.
2275 *
2276 * @method
2277 */
2278 update: ( function () {
2279 var hasPendingWrite = false;
2281 function flushWrites() {
2282 var data, key;
2283 if ( !hasPendingWrite || !mw.loader.store.enabled ) {
2284 return;
2285 }
2287 mw.loader.store.prune();
2288 key = mw.loader.store.getStoreKey();
2289 try {
2290 // Replacing the content of the module store might fail if the new
2291 // contents would exceed the browser's localStorage size limit. To
2292 // avoid clogging the browser with stale data, always remove the old
2293 // value before attempting to set the new one.
2294 localStorage.removeItem( key );
2295 data = JSON.stringify( mw.loader.store );
2296 localStorage.setItem( key, data );
2297 } catch ( e ) {
2298 mw.track( 'resourceloader.exception', { exception: e, source: 'store-localstorage-update' } );
2299 }
2301 hasPendingWrite = false;
2302 }
2304 return function () {
2305 if ( !hasPendingWrite ) {
2306 hasPendingWrite = true;
2307 mw.requestIdleCallback( flushWrites );
2308 }
2309 };
2310 }() )
2311 }
2312 };
2313 }() ),
2315 /**
2316 * HTML construction helper functions
2317 *
2318 * @example
2319 *
2320 * var Html, output;
2321 *
2322 * Html = mw.html;
2323 * output = Html.element( 'div', {}, new Html.Raw(
2324 * Html.element( 'img', { src: '<' } )
2325 * ) );
2326 * mw.log( output ); // <div><img src="<"/></div>
2327 *
2328 * @class mw.html
2329 * @singleton
2330 */
2331 html: ( function () {
2332 function escapeCallback( s ) {
2333 switch ( s ) {
2334 case '\'':
2335 return ''';
2336 case '"':
2337 return '"';
2338 case '<':
2339 return '<';
2340 case '>':
2341 return '>';
2342 case '&':
2343 return '&';
2344 }
2345 }
2347 return {
2348 /**
2349 * Escape a string for HTML.
2350 *
2351 * Converts special characters to HTML entities.
2352 *
2353 * mw.html.escape( '< > \' & "' );
2354 * // Returns < > ' & "
2355 *
2356 * @param {string} s The string to escape
2357 * @return {string} HTML
2358 */
2359 escape: function ( s ) {
2360 return s.replace( /['"<>&]/g, escapeCallback );
2361 },
2363 /**
2364 * Create an HTML element string, with safe escaping.
2365 *
2366 * @param {string} name The tag name.
2367 * @param {Object} [attrs] An object with members mapping element names to values
2368 * @param {string|mw.html.Raw|mw.html.Cdata|null} [contents=null] The contents of the element.
2369 *
2370 * - string: Text to be escaped.
2371 * - null: The element is treated as void with short closing form, e.g. `<br/>`.
2372 * - this.Raw: The raw value is directly included.
2373 * - this.Cdata: The raw value is directly included. An exception is
2374 * thrown if it contains any illegal ETAGO delimiter.
2375 * See <http://www.w3.org/TR/html401/appendix/notes.html#h-B.3.2>.
2376 * @return {string} HTML
2377 */
2378 element: function ( name, attrs, contents ) {
2379 var v, attrName, s = '<' + name;
2381 if ( attrs ) {
2382 for ( attrName in attrs ) {
2383 v = attrs[ attrName ];
2384 // Convert name=true, to name=name
2385 if ( v === true ) {
2386 v = attrName;
2387 // Skip name=false
2388 } else if ( v === false ) {
2389 continue;
2390 }
2391 s += ' ' + attrName + '="' + this.escape( String( v ) ) + '"';
2392 }
2393 }
2394 if ( contents === undefined || contents === null ) {
2395 // Self close tag
2396 s += '/>';
2397 return s;
2398 }
2399 // Regular open tag
2400 s += '>';
2401 switch ( typeof contents ) {
2402 case 'string':
2403 // Escaped
2404 s += this.escape( contents );
2405 break;
2406 case 'number':
2407 case 'boolean':
2408 // Convert to string
2409 s += String( contents );
2410 break;
2411 default:
2412 if ( contents instanceof this.Raw ) {
2413 // Raw HTML inclusion
2414 s += contents.value;
2415 } else if ( contents instanceof this.Cdata ) {
2416 // CDATA
2417 if ( /<\/[a-zA-z]/.test( contents.value ) ) {
2418 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
2419 }
2420 s += contents.value;
2421 } else {
2422 throw new Error( 'mw.html.element: Invalid type of contents' );
2423 }
2424 }
2425 s += '</' + name + '>';
2426 return s;
2427 },
2429 /**
2430 * Wrapper object for raw HTML passed to mw.html.element().
2431 *
2432 * @class mw.html.Raw
2433 */
2434 Raw: function ( value ) {
2435 this.value = value;
2436 },
2438 /**
2439 * Wrapper object for CDATA element contents passed to mw.html.element()
2440 *
2441 * @class mw.html.Cdata
2442 */
2443 Cdata: function ( value ) {
2444 this.value = value;
2445 }
2446 };
2447 }() ),
2449 // Skeleton user object, extended by the 'mediawiki.user' module.
2450 /**
2451 * @class mw.user
2452 * @singleton
2453 */
2454 user: {
2455 /**
2456 * @property {mw.Map}
2457 */
2458 options: new Map(),
2459 /**
2460 * @property {mw.Map}
2461 */
2462 tokens: new Map()
2463 },
2465 // OOUI widgets specific to MediaWiki
2466 widgets: {},
2468 /**
2469 * Registry and firing of events.
2470 *
2471 * MediaWiki has various interface components that are extended, enhanced
2472 * or manipulated in some other way by extensions, gadgets and even
2473 * in core itself.
2474 *
2475 * This framework helps streamlining the timing of when these other
2476 * code paths fire their plugins (instead of using document-ready,
2477 * which can and should be limited to firing only once).
2478 *
2479 * Features like navigating to other wiki pages, previewing an edit
2480 * and editing itself – without a refresh – can then retrigger these
2481 * hooks accordingly to ensure everything still works as expected.
2482 *
2483 * Example usage:
2484 *
2485 * mw.hook( 'wikipage.content' ).add( fn ).remove( fn );
2486 * mw.hook( 'wikipage.content' ).fire( $content );
2487 *
2488 * Handlers can be added and fired for arbitrary event names at any time. The same
2489 * event can be fired multiple times. The last run of an event is memorized
2490 * (similar to `$(document).ready` and `$.Deferred().done`).
2491 * This means if an event is fired, and a handler added afterwards, the added
2492 * function will be fired right away with the last given event data.
2493 *
2494 * Like Deferreds and Promises, the mw.hook object is both detachable and chainable.
2495 * Thus allowing flexible use and optimal maintainability and authority control.
2496 * You can pass around the `add` and/or `fire` method to another piece of code
2497 * without it having to know the event name (or `mw.hook` for that matter).
2498 *
2499 * var h = mw.hook( 'bar.ready' );
2500 * new mw.Foo( .. ).fetch( { callback: h.fire } );
2501 *
2502 * Note: Events are documented with an underscore instead of a dot in the event
2503 * name due to jsduck not supporting dots in that position.
2504 *
2505 * @class mw.hook
2506 */
2507 hook: ( function () {
2508 var lists = {};
2510 /**
2511 * Create an instance of mw.hook.
2512 *
2513 * @method hook
2514 * @member mw
2515 * @param {string} name Name of hook.
2516 * @return {mw.hook}
2517 */
2518 return function ( name ) {
2519 var list = hasOwn.call( lists, name ) ?
2520 lists[ name ] :
2521 lists[ name ] = $.Callbacks( 'memory' );
2523 return {
2524 /**
2525 * Register a hook handler
2526 *
2527 * @param {...Function} handler Function to bind.
2528 * @chainable
2529 */
2530 add: list.add,
2532 /**
2533 * Unregister a hook handler
2534 *
2535 * @param {...Function} handler Function to unbind.
2536 * @chainable
2537 */
2538 remove: list.remove,
2540 /**
2541 * Run a hook.
2542 *
2543 * @param {...Mixed} data
2544 * @chainable
2545 */
2546 fire: function () {
2547 return list.fireWith.call( this, null, slice.call( arguments ) );
2548 }
2549 };
2550 };
2551 }() )
2552 };
2554 // Alias $j to jQuery for backwards compatibility
2555 // @deprecated since 1.23 Use $ or jQuery instead
2556 mw.log.deprecate( window, '$j', $, 'Use $ or jQuery instead.' );
2558 /**
2559 * Log a message to window.console, if possible.
2560 *
2561 * Useful to force logging of some errors that are otherwise hard to detect (i.e., this logs
2562 * also in production mode). Gets console references in each invocation instead of caching the
2563 * reference, so that debugging tools loaded later are supported (e.g. Firebug Lite in IE).
2564 *
2565 * @private
2566 * @method log_
2567 * @param {string} topic Stream name passed by mw.track
2568 * @param {Object} data Data passed by mw.track
2569 * @param {Error} [data.exception]
2570 * @param {string} data.source Error source
2571 * @param {string} [data.module] Name of module which caused the error
2572 */
2573 function log( topic, data ) {
2574 var msg,
2575 e = data.exception,
2576 source = data.source,
2577 module = data.module,
2578 console = window.console;
2580 if ( console && console.log ) {
2581 msg = ( e ? 'Exception' : 'Error' ) + ' in ' + source;
2582 if ( module ) {
2583 msg += ' in module ' + module;
2584 }
2585 msg += ( e ? ':' : '.' );
2586 console.log( msg );
2588 // If we have an exception object, log it to the error channel to trigger a
2589 // proper stacktraces in browsers that support it. No fallback as we have no browsers
2590 // that don't support error(), but do support log().
2591 if ( e && console.error ) {
2592 console.error( String( e ), e );
2593 }
2594 }
2595 }
2597 // Subscribe to error streams
2598 mw.trackSubscribe( 'resourceloader.exception', log );
2599 mw.trackSubscribe( 'resourceloader.assert', log );
2601 /**
2602 * Fired when all modules associated with the page have finished loading.
2603 *
2604 * @event resourceloader_loadEnd
2605 * @member mw.hook
2606 */
2607 $( function () {
2608 var loading = $.grep( mw.loader.getModuleNames(), function ( module ) {
2609 return mw.loader.getState( module ) === 'loading';
2610 } );
2611 // In order to use jQuery.when (which stops early if one of the promises got rejected)
2612 // cast any loading failures into successes. We only need a callback, not the module.
2613 loading = $.map( loading, function ( module ) {
2614 return mw.loader.using( module ).then( null, function () {
2615 return $.Deferred().resolve();
2616 } );
2617 } );
2618 $.when.apply( $, loading ).then( function () {
2619 mwPerformance.mark( 'mwLoadEnd' );
2620 mw.hook( 'resourceloader.loadEnd' ).fire();
2621 } );
2622 } );
2624 // Attach to window and globally alias
2625 window.mw = window.mediaWiki = mw;
2626 }( jQuery ) );