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