dépôts / lhc / web / wiklou.git / blob
? search:


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