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