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