Merge "Add to/tweak mediawiki and jqueryMsg JS tests, fix comment"
[lhc/web/wiklou.git] / resources / mediawiki / mediawiki.js
1 /*
2 * Core MediaWiki JavaScript Library
3 */
4
5 var mw = ( function ( $, undefined ) {
6 'use strict';
7
8 /* Private Members */
9
10 var hasOwn = Object.prototype.hasOwnProperty,
11 slice = Array.prototype.slice;
12
13 /* Object constructors */
14
15 /**
16 * Creates an object that can be read from or written to from prototype functions
17 * that allow both single and multiple variables at once.
18 * @class mw.Map
19 *
20 * @constructor
21 * @param {boolean} global Whether to store the values in the global window
22 * object or a exclusively in the object property 'values'.
23 */
24 function Map( global ) {
25 this.values = global === true ? window : {};
26 return this;
27 }
28
29 Map.prototype = {
30 /**
31 * Get the value of one or multiple a keys.
32 *
33 * If called with no arguments, all values will be returned.
34 *
35 * @param {string|Array} selection String key or array of keys to get values for.
36 * @param {Mixed} [fallback] Value to use in case key(s) do not exist.
37 * @return mixed If selection was a string returns the value or null,
38 * If selection was an array, returns an object of key/values (value is null if not found),
39 * If selection was not passed or invalid, will return the 'values' object member (be careful as
40 * objects are always passed by reference in JavaScript!).
41 * @return {string|Object|null} Values as a string or object, null if invalid/inexistant.
42 */
43 get: function ( selection, fallback ) {
44 var results, i;
45 // If we only do this in the `return` block, it'll fail for the
46 // call to get() from the mutli-selection block.
47 fallback = arguments.length > 1 ? fallback : null;
48
49 if ( $.isArray( selection ) ) {
50 selection = slice.call( selection );
51 results = {};
52 for ( i = 0; i < selection.length; i++ ) {
53 results[selection[i]] = this.get( selection[i], fallback );
54 }
55 return results;
56 }
57
58 if ( typeof selection === 'string' ) {
59 if ( !hasOwn.call( this.values, selection ) ) {
60 return fallback;
61 }
62 return this.values[selection];
63 }
64
65 if ( selection === undefined ) {
66 return this.values;
67 }
68
69 // invalid selection key
70 return null;
71 },
72
73 /**
74 * Sets one or multiple key/value pairs.
75 *
76 * @param {string|Object} selection String key to set value for, or object mapping keys to values.
77 * @param {Mixed} [value] Value to set (optional, only in use when key is a string)
78 * @return {Boolean} This returns true on success, false on failure.
79 */
80 set: function ( selection, value ) {
81 var s;
82
83 if ( $.isPlainObject( selection ) ) {
84 for ( s in selection ) {
85 this.values[s] = selection[s];
86 }
87 return true;
88 }
89 if ( typeof selection === 'string' && arguments.length > 1 ) {
90 this.values[selection] = value;
91 return true;
92 }
93 return false;
94 },
95
96 /**
97 * Checks if one or multiple keys exist.
98 *
99 * @param {Mixed} selection String key or array of keys to check
100 * @return {boolean} Existence of key(s)
101 */
102 exists: function ( selection ) {
103 var s;
104
105 if ( $.isArray( selection ) ) {
106 for ( s = 0; s < selection.length; s++ ) {
107 if ( typeof selection[s] !== 'string' || !hasOwn.call( this.values, selection[s] ) ) {
108 return false;
109 }
110 }
111 return true;
112 }
113 return typeof selection === 'string' && hasOwn.call( this.values, selection );
114 }
115 };
116
117 /**
118 * Object constructor for messages,
119 * similar to the Message class in MediaWiki PHP.
120 * @class mw.Message
121 *
122 * @constructor
123 * @param {mw.Map} map Message storage
124 * @param {string} key
125 * @param {Array} [parameters]
126 */
127 function Message( map, key, parameters ) {
128 this.format = 'text';
129 this.map = map;
130 this.key = key;
131 this.parameters = parameters === undefined ? [] : slice.call( parameters );
132 return this;
133 }
134
135 Message.prototype = {
136 /**
137 * Simple message parser, does $N replacement and nothing else.
138 *
139 * This may be overridden to provide a more complex message parser.
140 *
141 * The primary override is in mediawiki.jqueryMsg.
142 *
143 * This function will not be called for nonexistent messages.
144 */
145 parser: function () {
146 var parameters = this.parameters;
147 return this.map.get( this.key ).replace( /\$(\d+)/g, function ( str, match ) {
148 var index = parseInt( match, 10 ) - 1;
149 return parameters[index] !== undefined ? parameters[index] : '$' + match;
150 } );
151 },
152
153 /**
154 * Appends (does not replace) parameters for replacement to the .parameters property.
155 *
156 * @param {Array} parameters
157 * @chainable
158 */
159 params: function ( parameters ) {
160 var i;
161 for ( i = 0; i < parameters.length; i += 1 ) {
162 this.parameters.push( parameters[i] );
163 }
164 return this;
165 },
166
167 /**
168 * Converts message object to it's string form based on the state of format.
169 *
170 * @return {string} Message as a string in the current form or `<key>` if key does not exist.
171 */
172 toString: function () {
173 var text;
174
175 if ( !this.exists() ) {
176 // Use <key> as text if key does not exist
177 if ( this.format === 'escaped' || this.format === 'parse' ) {
178 // format 'escaped' and 'parse' need to have the brackets and key html escaped
179 return mw.html.escape( '<' + this.key + '>' );
180 }
181 return '<' + this.key + '>';
182 }
183
184 if ( this.format === 'plain' || this.format === 'text' || this.format === 'parse' ) {
185 text = this.parser();
186 }
187
188 if ( this.format === 'escaped' ) {
189 text = this.parser();
190 text = mw.html.escape( text );
191 }
192
193 return text;
194 },
195
196 /**
197 * Changes format to 'parse' and converts message to string
198 *
199 * If jqueryMsg is loaded, this parses the message text from wikitext
200 * (where supported) to HTML
201 *
202 * Otherwise, it is equivalent to plain.
203 *
204 * @return {string} String form of parsed message
205 */
206 parse: function () {
207 this.format = 'parse';
208 return this.toString();
209 },
210
211 /**
212 * Changes format to 'plain' and converts message to string
213 *
214 * This substitutes parameters, but otherwise does not change the
215 * message text.
216 *
217 * @return {string} String form of plain message
218 */
219 plain: function () {
220 this.format = 'plain';
221 return this.toString();
222 },
223
224 /**
225 * Changes format to 'text' and converts message to string
226 *
227 * If jqueryMsg is loaded, {{-transformation is done where supported
228 * (such as {{plural:}}, {{gender:}}, {{int:}}).
229 *
230 * Otherwise, it is equivalent to plain.
231 */
232 text: function () {
233 this.format = 'text';
234 return this.toString();
235 },
236
237 /**
238 * Changes the format to 'escaped' and converts message to string
239 *
240 * This is equivalent to using the 'text' format (see text method), then
241 * HTML-escaping the output.
242 *
243 * @return {string} String form of html escaped message
244 */
245 escaped: function () {
246 this.format = 'escaped';
247 return this.toString();
248 },
249
250 /**
251 * Checks if message exists
252 *
253 * @see mw.Map#exists
254 * @return {boolean}
255 */
256 exists: function () {
257 return this.map.exists( this.key );
258 }
259 };
260
261 /**
262 * @class mw
263 * @alternateClassName mediaWiki
264 * @singleton
265 */
266 return {
267 /* Public Members */
268
269 /**
270 * Dummy function which in debug mode can be replaced with a function that
271 * emulates console.log in console-less environments.
272 */
273 log: function () { },
274
275 // Make the Map constructor publicly available.
276 Map: Map,
277
278 // Make the Message constructor publicly available.
279 Message: Message,
280
281 /**
282 * List of configuration values
283 *
284 * Dummy placeholder. Initiated in startUp module as a new instance of mw.Map().
285 * If `$wgLegacyJavaScriptGlobals` is true, this Map will have its values
286 * in the global window object.
287 * @property
288 */
289 config: null,
290
291 /**
292 * Empty object that plugins can be installed in.
293 * @property
294 */
295 libs: {},
296
297 /* Extension points */
298
299 /**
300 * @property
301 */
302 legacy: {},
303
304 /**
305 * Localization system
306 * @property {mw.Map}
307 */
308 messages: new Map(),
309
310 /* Public Methods */
311
312 /**
313 * Gets a message object, similar to wfMessage().
314 *
315 * @param {string} key Key of message to get
316 * @param {Mixed...} parameters Parameters for the $N replacements in messages.
317 * @return {mw.Message}
318 */
319 message: function ( key ) {
320 // Variadic arguments
321 var parameters = slice.call( arguments, 1 );
322 return new Message( mw.messages, key, parameters );
323 },
324
325 /**
326 * Gets a message string, similar to wfMessage()
327 *
328 * @see mw.Message#toString
329 * @param {string} key Key of message to get
330 * @param {Mixed...} parameters Parameters for the $N replacements in messages.
331 * @return {string}
332 */
333 msg: function ( /* key, parameters... */ ) {
334 return mw.message.apply( mw.message, arguments ).toString();
335 },
336
337 /**
338 * Client-side module loader which integrates with the MediaWiki ResourceLoader
339 * @class mw.loader
340 * @singleton
341 */
342 loader: ( function () {
343
344 /* Private Members */
345
346 /**
347 * Mapping of registered modules
348 *
349 * The jquery module is pre-registered, because it must have already
350 * been provided for this object to have been built, and in debug mode
351 * jquery would have been provided through a unique loader request,
352 * making it impossible to hold back registration of jquery until after
353 * mediawiki.
354 *
355 * For exact details on support for script, style and messages, look at
356 * mw.loader.implement.
357 *
358 * Format:
359 * {
360 * 'moduleName': {
361 * 'version': ############## (unix timestamp),
362 * 'dependencies': ['required.foo', 'bar.also', ...], (or) function () {}
363 * 'group': 'somegroup', (or) null,
364 * 'source': 'local', 'someforeignwiki', (or) null
365 * 'state': 'registered', 'loading', 'loaded', 'ready', 'error' or 'missing'
366 * 'script': ...,
367 * 'style': ...,
368 * 'messages': { 'key': 'value' },
369 * }
370 * }
371 *
372 * @property
373 * @private
374 */
375 var registry = {},
376 //
377 // Mapping of sources, keyed by source-id, values are objects.
378 // Format:
379 // {
380 // 'sourceId': {
381 // 'loadScript': 'http://foo.bar/w/load.php'
382 // }
383 // }
384 //
385 sources = {},
386 // List of modules which will be loaded as when ready
387 batch = [],
388 // List of modules to be loaded
389 queue = [],
390 // List of callback functions waiting for modules to be ready to be called
391 jobs = [],
392 // Selector cache for the marker element. Use getMarker() to get/use the marker!
393 $marker = null,
394 // Buffer for addEmbeddedCSS.
395 cssBuffer = '';
396
397 /* Private methods */
398
399 function getMarker() {
400 // Cached ?
401 if ( $marker ) {
402 return $marker;
403 }
404
405 $marker = $( 'meta[name="ResourceLoaderDynamicStyles"]' );
406 if ( $marker.length ) {
407 return $marker;
408 }
409 mw.log( 'getMarker> No <meta name="ResourceLoaderDynamicStyles"> found, inserting dynamically.' );
410 $marker = $( '<meta>' ).attr( 'name', 'ResourceLoaderDynamicStyles' ).appendTo( 'head' );
411
412 return $marker;
413 }
414
415 /**
416 * Create a new style tag and add it to the DOM.
417 *
418 * @private
419 * @param {string} text CSS text
420 * @param {Mixed} [nextnode] An Element or jQuery object for an element where
421 * the style tag should be inserted before. Otherwise appended to the `<head>`.
422 * @return {HTMLElement} Node reference to the created `<style>` tag.
423 */
424 function addStyleTag( text, nextnode ) {
425 var s = document.createElement( 'style' );
426 // Insert into document before setting cssText (bug 33305)
427 if ( nextnode ) {
428 // Must be inserted with native insertBefore, not $.fn.before.
429 // When using jQuery to insert it, like $nextnode.before( s ),
430 // then IE6 will throw "Access is denied" when trying to append
431 // to .cssText later. Some kind of weird security measure.
432 // http://stackoverflow.com/q/12586482/319266
433 // Works: jsfiddle.net/zJzMy/1
434 // Fails: jsfiddle.net/uJTQz
435 // Works again: http://jsfiddle.net/Azr4w/ (diff: the next 3 lines)
436 if ( nextnode.jquery ) {
437 nextnode = nextnode.get( 0 );
438 }
439 nextnode.parentNode.insertBefore( s, nextnode );
440 } else {
441 document.getElementsByTagName( 'head' )[0].appendChild( s );
442 }
443 if ( s.styleSheet ) {
444 // IE
445 s.styleSheet.cssText = text;
446 } else {
447 // Other browsers.
448 // (Safari sometimes borks on non-string values,
449 // play safe by casting to a string, just in case.)
450 s.appendChild( document.createTextNode( String( text ) ) );
451 }
452 return s;
453 }
454
455 /**
456 * Checks whether it is safe to add this css to a stylesheet.
457 *
458 * @private
459 * @param {string} cssText
460 * @return {boolean} False if a new one must be created.
461 */
462 function canExpandStylesheetWith( cssText ) {
463 // Makes sure that cssText containing `@import`
464 // rules will end up in a new stylesheet (as those only work when
465 // placed at the start of a stylesheet; bug 35562).
466 return cssText.indexOf( '@import' ) === -1;
467 }
468
469 /**
470 * @param {string} [cssText=cssBuffer] If called without cssText,
471 * the internal buffer will be inserted instead.
472 */
473 function addEmbeddedCSS( cssText ) {
474 var $style, styleEl;
475
476 // Yield once before inserting the <style> tag. There are likely
477 // more calls coming up which we can combine this way.
478 // Appending a stylesheet and waiting for the browser to repaint
479 // is fairly expensive, this reduces it (bug 45810)
480 if ( cssText ) {
481 // Be careful not to extend the buffer with css that needs a new stylesheet
482 if ( !cssBuffer || canExpandStylesheetWith( cssText ) ) {
483 // Linebreak for somewhat distinguishable sections
484 // (the rl-cachekey comment separating each)
485 cssBuffer += '\n' + cssText;
486 // TODO: Use requestAnimationFrame in the future which will
487 // perform even better by not injecting styles while the browser
488 // is paiting.
489 setTimeout( function () {
490 // Can't pass addEmbeddedCSS to setTimeout directly because Firefox
491 // (below version 13) has the non-standard behaviour of passing a
492 // numerical "lateness" value as first argument to this callback
493 // http://benalman.com/news/2009/07/the-mysterious-firefox-settime/
494 addEmbeddedCSS();
495 } );
496 return;
497 }
498
499 // This is a delayed call and we got a buffer still
500 } else if ( cssBuffer ) {
501 cssText = cssBuffer;
502 cssBuffer = '';
503 } else {
504 // This is a delayed call, but buffer is already cleared by
505 // another delayed call.
506 return;
507 }
508
509 // By default, always create a new <style>. Appending text
510 // to a <style> tag means the contents have to be re-parsed (bug 45810).
511 // Except, of course, in IE below 9, in there we default to
512 // re-using and appending to a <style> tag due to the
513 // IE stylesheet limit (bug 31676).
514 if ( 'documentMode' in document && document.documentMode <= 9 ) {
515
516 $style = getMarker().prev();
517 // Verify that the the element before Marker actually is a
518 // <style> tag and one that came from ResourceLoader
519 // (not some other style tag or even a `<meta>` or `<script>`).
520 if ( $style.data( 'ResourceLoaderDynamicStyleTag' ) === true ) {
521 // There's already a dynamic <style> tag present and
522 // canExpandStylesheetWith() gave a green light to append more to it.
523 styleEl = $style.get( 0 );
524 if ( styleEl.styleSheet ) {
525 try {
526 styleEl.styleSheet.cssText += cssText; // IE
527 } catch ( e ) {
528 log( 'addEmbeddedCSS fail\ne.message: ' + e.message, e );
529 }
530 } else {
531 styleEl.appendChild( document.createTextNode( String( cssText ) ) );
532 }
533 return;
534 }
535 }
536
537 $( addStyleTag( cssText, getMarker() ) ).data( 'ResourceLoaderDynamicStyleTag', true );
538 }
539
540 /**
541 * Generates an ISO8601 "basic" string from a UNIX timestamp
542 * @private
543 */
544 function formatVersionNumber( timestamp ) {
545 var d = new Date();
546 function pad( a, b, c ) {
547 return [a < 10 ? '0' + a : a, b < 10 ? '0' + b : b, c < 10 ? '0' + c : c].join( '' );
548 }
549 d.setTime( timestamp * 1000 );
550 return [
551 pad( d.getUTCFullYear(), d.getUTCMonth() + 1, d.getUTCDate() ), 'T',
552 pad( d.getUTCHours(), d.getUTCMinutes(), d.getUTCSeconds() ), 'Z'
553 ].join( '' );
554 }
555
556 /**
557 * Resolves dependencies and detects circular references.
558 *
559 * @private
560 * @param {string} module Name of the top-level module whose dependencies shall be
561 * resolved and sorted.
562 * @param {Array} resolved Returns a topological sort of the given module and its
563 * dependencies, such that later modules depend on earlier modules. The array
564 * contains the module names. If the array contains already some module names,
565 * this function appends its result to the pre-existing array.
566 * @param {Object} [unresolved] Hash used to track the current dependency
567 * chain; used to report loops in the dependency graph.
568 * @throws {Error} If any unregistered module or a dependency loop is encountered
569 */
570 function sortDependencies( module, resolved, unresolved ) {
571 var n, deps, len;
572
573 if ( registry[module] === undefined ) {
574 throw new Error( 'Unknown dependency: ' + module );
575 }
576 // Resolves dynamic loader function and replaces it with its own results
577 if ( $.isFunction( registry[module].dependencies ) ) {
578 registry[module].dependencies = registry[module].dependencies();
579 // Ensures the module's dependencies are always in an array
580 if ( typeof registry[module].dependencies !== 'object' ) {
581 registry[module].dependencies = [registry[module].dependencies];
582 }
583 }
584 if ( $.inArray( module, resolved ) !== -1 ) {
585 // Module already resolved; nothing to do.
586 return;
587 }
588 // unresolved is optional, supply it if not passed in
589 if ( !unresolved ) {
590 unresolved = {};
591 }
592 // Tracks down dependencies
593 deps = registry[module].dependencies;
594 len = deps.length;
595 for ( n = 0; n < len; n += 1 ) {
596 if ( $.inArray( deps[n], resolved ) === -1 ) {
597 if ( unresolved[deps[n]] ) {
598 throw new Error(
599 'Circular reference detected: ' + module +
600 ' -> ' + deps[n]
601 );
602 }
603
604 // Add to unresolved
605 unresolved[module] = true;
606 sortDependencies( deps[n], resolved, unresolved );
607 delete unresolved[module];
608 }
609 }
610 resolved[resolved.length] = module;
611 }
612
613 /**
614 * Gets a list of module names that a module depends on in their proper dependency
615 * order.
616 *
617 * @private
618 * @param {string} module Module name or array of string module names
619 * @return {Array} list of dependencies, including 'module'.
620 * @throws {Error} If circular reference is detected
621 */
622 function resolve( module ) {
623 var m, resolved;
624
625 // Allow calling with an array of module names
626 if ( $.isArray( module ) ) {
627 resolved = [];
628 for ( m = 0; m < module.length; m += 1 ) {
629 sortDependencies( module[m], resolved );
630 }
631 return resolved;
632 }
633
634 if ( typeof module === 'string' ) {
635 resolved = [];
636 sortDependencies( module, resolved );
637 return resolved;
638 }
639
640 throw new Error( 'Invalid module argument: ' + module );
641 }
642
643 /**
644 * Narrows a list of module names down to those matching a specific
645 * state (see comment on top of this scope for a list of valid states).
646 * One can also filter for 'unregistered', which will return the
647 * modules names that don't have a registry entry.
648 *
649 * @private
650 * @param {string|string[]} states Module states to filter by
651 * @param {Array} [modules] List of module names to filter (optional, by default the entire
652 * registry is used)
653 * @return {Array} List of filtered module names
654 */
655 function filter( states, modules ) {
656 var list, module, s, m;
657
658 // Allow states to be given as a string
659 if ( typeof states === 'string' ) {
660 states = [states];
661 }
662 // If called without a list of modules, build and use a list of all modules
663 list = [];
664 if ( modules === undefined ) {
665 modules = [];
666 for ( module in registry ) {
667 modules[modules.length] = module;
668 }
669 }
670 // Build a list of modules which are in one of the specified states
671 for ( s = 0; s < states.length; s += 1 ) {
672 for ( m = 0; m < modules.length; m += 1 ) {
673 if ( registry[modules[m]] === undefined ) {
674 // Module does not exist
675 if ( states[s] === 'unregistered' ) {
676 // OK, undefined
677 list[list.length] = modules[m];
678 }
679 } else {
680 // Module exists, check state
681 if ( registry[modules[m]].state === states[s] ) {
682 // OK, correct state
683 list[list.length] = modules[m];
684 }
685 }
686 }
687 }
688 return list;
689 }
690
691 /**
692 * Determine whether all dependencies are in state 'ready', which means we may
693 * execute the module or job now.
694 *
695 * @private
696 * @param {Array} dependencies Dependencies (module names) to be checked.
697 * @return {boolean} True if all dependencies are in state 'ready', false otherwise
698 */
699 function allReady( dependencies ) {
700 return filter( 'ready', dependencies ).length === dependencies.length;
701 }
702
703 /**
704 * Log a message to window.console, if possible. Useful to force logging of some
705 * errors that are otherwise hard to detect (I.e., this logs also in production mode).
706 * Gets console references in each invocation, so that delayed debugging tools work
707 * fine. No need for optimization here, which would only result in losing logs.
708 *
709 * @private
710 * @param {string} msg text for the log entry.
711 * @param {Error} [e]
712 */
713 function log( msg, e ) {
714 var console = window.console;
715 if ( console && console.log ) {
716 console.log( msg );
717 // If we have an exception object, log it through .error() to trigger
718 // proper stacktraces in browsers that support it. There are no (known)
719 // browsers that don't support .error(), that do support .log() and
720 // have useful exception handling through .log().
721 if ( e && console.error ) {
722 console.error( e );
723 }
724 }
725 }
726
727 /**
728 * A module has entered state 'ready', 'error', or 'missing'. Automatically update pending jobs
729 * and modules that depend upon this module. if the given module failed, propagate the 'error'
730 * state up the dependency tree; otherwise, execute all jobs/modules that now have all their
731 * dependencies satisfied. On jobs depending on a failed module, run the error callback, if any.
732 *
733 * @private
734 * @param {string} module Name of module that entered one of the states 'ready', 'error', or 'missing'.
735 */
736 function handlePending( module ) {
737 var j, job, hasErrors, m, stateChange;
738
739 // Modules.
740 if ( $.inArray( registry[module].state, ['error', 'missing'] ) !== -1 ) {
741 // If the current module failed, mark all dependent modules also as failed.
742 // Iterate until steady-state to propagate the error state upwards in the
743 // dependency tree.
744 do {
745 stateChange = false;
746 for ( m in registry ) {
747 if ( $.inArray( registry[m].state, ['error', 'missing'] ) === -1 ) {
748 if ( filter( ['error', 'missing'], registry[m].dependencies ).length > 0 ) {
749 registry[m].state = 'error';
750 stateChange = true;
751 }
752 }
753 }
754 } while ( stateChange );
755 }
756
757 // Execute all jobs whose dependencies are either all satisfied or contain at least one failed module.
758 for ( j = 0; j < jobs.length; j += 1 ) {
759 hasErrors = filter( ['error', 'missing'], jobs[j].dependencies ).length > 0;
760 if ( hasErrors || allReady( jobs[j].dependencies ) ) {
761 // All dependencies satisfied, or some have errors
762 job = jobs[j];
763 jobs.splice( j, 1 );
764 j -= 1;
765 try {
766 if ( hasErrors ) {
767 throw new Error( 'Module ' + module + ' failed.');
768 } else {
769 if ( $.isFunction( job.ready ) ) {
770 job.ready();
771 }
772 }
773 } catch ( e ) {
774 if ( $.isFunction( job.error ) ) {
775 try {
776 job.error( e, [module] );
777 } catch ( ex ) {
778 // A user-defined operation raised an exception. Swallow to protect
779 // our state machine!
780 log( 'Exception thrown by job.error()', ex );
781 }
782 }
783 }
784 }
785 }
786
787 if ( registry[module].state === 'ready' ) {
788 // The current module became 'ready'. Recursively execute all dependent modules that are loaded
789 // and now have all dependencies satisfied.
790 for ( m in registry ) {
791 if ( registry[m].state === 'loaded' && allReady( registry[m].dependencies ) ) {
792 execute( m );
793 }
794 }
795 }
796 }
797
798 /**
799 * Adds a script tag to the DOM, either using document.write or low-level DOM manipulation,
800 * depending on whether document-ready has occurred yet and whether we are in async mode.
801 *
802 * @private
803 * @param {string} src URL to script, will be used as the src attribute in the script tag
804 * @param {Function} [callback] Callback which will be run when the script is done
805 */
806 function addScript( src, callback, async ) {
807 /*jshint evil:true */
808 var script, head,
809 done = false;
810
811 // Using isReady directly instead of storing it locally from
812 // a $.fn.ready callback (bug 31895).
813 if ( $.isReady || async ) {
814 // Can't use jQuery.getScript because that only uses <script> for cross-domain,
815 // it uses XHR and eval for same-domain scripts, which we don't want because it
816 // messes up line numbers.
817 // The below is based on jQuery ([jquery@1.8.2]/src/ajax/script.js)
818
819 // IE-safe way of getting the <head>. document.head isn't supported
820 // in old IE, and doesn't work when in the <head>.
821 head = document.getElementsByTagName( 'head' )[0] || document.body;
822
823 script = document.createElement( 'script' );
824 script.async = true;
825 script.src = src;
826 if ( $.isFunction( callback ) ) {
827 script.onload = script.onreadystatechange = function () {
828 if (
829 !done
830 && (
831 !script.readyState
832 || /loaded|complete/.test( script.readyState )
833 )
834 ) {
835 done = true;
836
837 // Handle memory leak in IE
838 script.onload = script.onreadystatechange = null;
839
840 // Remove the script
841 if ( script.parentNode ) {
842 script.parentNode.removeChild( script );
843 }
844
845 // Dereference the script
846 script = undefined;
847
848 callback();
849 }
850 };
851 }
852
853 if ( window.opera ) {
854 // Appending to the <head> blocks rendering completely in Opera,
855 // so append to the <body> after document ready. This means the
856 // scripts only start loading after the document has been rendered,
857 // but so be it. Opera users don't deserve faster web pages if their
858 // browser makes it impossible.
859 $( function () {
860 document.body.appendChild( script );
861 } );
862 } else {
863 head.appendChild( script );
864 }
865 } else {
866 document.write( mw.html.element( 'script', { 'src': src }, '' ) );
867 if ( $.isFunction( callback ) ) {
868 // Document.write is synchronous, so this is called when it's done
869 // FIXME: that's a lie. doc.write isn't actually synchronous
870 callback();
871 }
872 }
873 }
874
875 /**
876 * Executes a loaded module, making it ready to use
877 *
878 * @private
879 * @param {string} module Module name to execute
880 */
881 function execute( module ) {
882 var key, value, media, i, urls, script, markModuleReady, nestedAddScript;
883
884 if ( registry[module] === undefined ) {
885 throw new Error( 'Module has not been registered yet: ' + module );
886 } else if ( registry[module].state === 'registered' ) {
887 throw new Error( 'Module has not been requested from the server yet: ' + module );
888 } else if ( registry[module].state === 'loading' ) {
889 throw new Error( 'Module has not completed loading yet: ' + module );
890 } else if ( registry[module].state === 'ready' ) {
891 throw new Error( 'Module has already been loaded: ' + module );
892 }
893
894 /**
895 * Define loop-function here for efficiency
896 * and to avoid re-using badly scoped variables.
897 * @ignore
898 */
899 function addLink( media, url ) {
900 var el = document.createElement( 'link' );
901 getMarker().before( el ); // IE: Insert in dom before setting href
902 el.rel = 'stylesheet';
903 if ( media && media !== 'all' ) {
904 el.media = media;
905 }
906 el.href = url;
907 }
908
909 // Process styles (see also mw.loader.implement)
910 // * back-compat: { <media>: css }
911 // * back-compat: { <media>: [url, ..] }
912 // * { "css": [css, ..] }
913 // * { "url": { <media>: [url, ..] } }
914 if ( $.isPlainObject( registry[module].style ) ) {
915 for ( key in registry[module].style ) {
916 value = registry[module].style[key];
917 media = undefined;
918
919 if ( key !== 'url' && key !== 'css' ) {
920 // Backwards compatibility, key is a media-type
921 if ( typeof value === 'string' ) {
922 // back-compat: { <media>: css }
923 // Ignore 'media' because it isn't supported (nor was it used).
924 // Strings are pre-wrapped in "@media". The media-type was just ""
925 // (because it had to be set to something).
926 // This is one of the reasons why this format is no longer used.
927 addEmbeddedCSS( value );
928 } else {
929 // back-compat: { <media>: [url, ..] }
930 media = key;
931 key = 'bc-url';
932 }
933 }
934
935 // Array of css strings in key 'css',
936 // or back-compat array of urls from media-type
937 if ( $.isArray( value ) ) {
938 for ( i = 0; i < value.length; i += 1 ) {
939 if ( key === 'bc-url' ) {
940 // back-compat: { <media>: [url, ..] }
941 addLink( media, value[i] );
942 } else if ( key === 'css' ) {
943 // { "css": [css, ..] }
944 addEmbeddedCSS( value[i] );
945 }
946 }
947 // Not an array, but a regular object
948 // Array of urls inside media-type key
949 } else if ( typeof value === 'object' ) {
950 // { "url": { <media>: [url, ..] } }
951 for ( media in value ) {
952 urls = value[media];
953 for ( i = 0; i < urls.length; i += 1 ) {
954 addLink( media, urls[i] );
955 }
956 }
957 }
958 }
959 }
960
961 // Add localizations to message system
962 if ( $.isPlainObject( registry[module].messages ) ) {
963 mw.messages.set( registry[module].messages );
964 }
965
966 // Execute script
967 try {
968 script = registry[module].script;
969 markModuleReady = function () {
970 registry[module].state = 'ready';
971 handlePending( module );
972 };
973 nestedAddScript = function ( arr, callback, async, i ) {
974 // Recursively call addScript() in its own callback
975 // for each element of arr.
976 if ( i >= arr.length ) {
977 // We're at the end of the array
978 callback();
979 return;
980 }
981
982 addScript( arr[i], function () {
983 nestedAddScript( arr, callback, async, i + 1 );
984 }, async );
985 };
986
987 if ( $.isArray( script ) ) {
988 registry[module].state = 'loading';
989 nestedAddScript( script, markModuleReady, registry[module].async, 0 );
990 } else if ( $.isFunction( script ) ) {
991 registry[module].state = 'ready';
992 script( $ );
993 handlePending( module );
994 }
995 } catch ( e ) {
996 // This needs to NOT use mw.log because these errors are common in production mode
997 // and not in debug mode, such as when a symbol that should be global isn't exported
998 log( 'Exception thrown by ' + module + ': ' + e.message, e );
999 registry[module].state = 'error';
1000 handlePending( module );
1001 }
1002 }
1003
1004 /**
1005 * Adds a dependencies to the queue with optional callbacks to be run
1006 * when the dependencies are ready or fail
1007 *
1008 * @private
1009 * @param {string|string[]} dependencies Module name or array of string module names
1010 * @param {Function} [ready] Callback to execute when all dependencies are ready
1011 * @param {Function} [error] Callback to execute when any dependency fails
1012 * @param {boolean} [async] If true, load modules asynchronously even if
1013 * document ready has not yet occurred.
1014 */
1015 function request( dependencies, ready, error, async ) {
1016 var n;
1017
1018 // Allow calling by single module name
1019 if ( typeof dependencies === 'string' ) {
1020 dependencies = [dependencies];
1021 }
1022
1023 // Add ready and error callbacks if they were given
1024 if ( ready !== undefined || error !== undefined ) {
1025 jobs[jobs.length] = {
1026 'dependencies': filter(
1027 ['registered', 'loading', 'loaded'],
1028 dependencies
1029 ),
1030 'ready': ready,
1031 'error': error
1032 };
1033 }
1034
1035 // Queue up any dependencies that are registered
1036 dependencies = filter( ['registered'], dependencies );
1037 for ( n = 0; n < dependencies.length; n += 1 ) {
1038 if ( $.inArray( dependencies[n], queue ) === -1 ) {
1039 queue[queue.length] = dependencies[n];
1040 if ( async ) {
1041 // Mark this module as async in the registry
1042 registry[dependencies[n]].async = true;
1043 }
1044 }
1045 }
1046
1047 // Work the queue
1048 mw.loader.work();
1049 }
1050
1051 function sortQuery(o) {
1052 var sorted = {}, key, a = [];
1053 for ( key in o ) {
1054 if ( hasOwn.call( o, key ) ) {
1055 a.push( key );
1056 }
1057 }
1058 a.sort();
1059 for ( key = 0; key < a.length; key += 1 ) {
1060 sorted[a[key]] = o[a[key]];
1061 }
1062 return sorted;
1063 }
1064
1065 /**
1066 * Converts a module map of the form { foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }
1067 * to a query string of the form foo.bar,baz|bar.baz,quux
1068 * @private
1069 */
1070 function buildModulesString( moduleMap ) {
1071 var arr = [], p, prefix;
1072 for ( prefix in moduleMap ) {
1073 p = prefix === '' ? '' : prefix + '.';
1074 arr.push( p + moduleMap[prefix].join( ',' ) );
1075 }
1076 return arr.join( '|' );
1077 }
1078
1079 /**
1080 * Asynchronously append a script tag to the end of the body
1081 * that invokes load.php
1082 * @private
1083 * @param {Object} moduleMap Module map, see #buildModulesString
1084 * @param {Object} currReqBase Object with other parameters (other than 'modules') to use in the request
1085 * @param {string} sourceLoadScript URL of load.php
1086 * @param {boolean} async If true, use an asynchrounous request even if document ready has not yet occurred
1087 */
1088 function doRequest( moduleMap, currReqBase, sourceLoadScript, async ) {
1089 var request = $.extend(
1090 { modules: buildModulesString( moduleMap ) },
1091 currReqBase
1092 );
1093 request = sortQuery( request );
1094 // Asynchronously append a script tag to the end of the body
1095 // Append &* to avoid triggering the IE6 extension check
1096 addScript( sourceLoadScript + '?' + $.param( request ) + '&*', null, async );
1097 }
1098
1099 /* Public Methods */
1100 return {
1101 addStyleTag: addStyleTag,
1102
1103 /**
1104 * Requests dependencies from server, loading and executing when things when ready.
1105 */
1106 work: function () {
1107 var reqBase, splits, maxQueryLength, q, b, bSource, bGroup, bSourceGroup,
1108 source, group, g, i, modules, maxVersion, sourceLoadScript,
1109 currReqBase, currReqBaseLength, moduleMap, l,
1110 lastDotIndex, prefix, suffix, bytesAdded, async;
1111
1112 // Build a list of request parameters common to all requests.
1113 reqBase = {
1114 skin: mw.config.get( 'skin' ),
1115 lang: mw.config.get( 'wgUserLanguage' ),
1116 debug: mw.config.get( 'debug' )
1117 };
1118 // Split module batch by source and by group.
1119 splits = {};
1120 maxQueryLength = mw.config.get( 'wgResourceLoaderMaxQueryLength', -1 );
1121
1122 // Appends a list of modules from the queue to the batch
1123 for ( q = 0; q < queue.length; q += 1 ) {
1124 // Only request modules which are registered
1125 if ( registry[queue[q]] !== undefined && registry[queue[q]].state === 'registered' ) {
1126 // Prevent duplicate entries
1127 if ( $.inArray( queue[q], batch ) === -1 ) {
1128 batch[batch.length] = queue[q];
1129 // Mark registered modules as loading
1130 registry[queue[q]].state = 'loading';
1131 }
1132 }
1133 }
1134 // Early exit if there's nothing to load...
1135 if ( !batch.length ) {
1136 return;
1137 }
1138
1139 // The queue has been processed into the batch, clear up the queue.
1140 queue = [];
1141
1142 // Always order modules alphabetically to help reduce cache
1143 // misses for otherwise identical content.
1144 batch.sort();
1145
1146 // Split batch by source and by group.
1147 for ( b = 0; b < batch.length; b += 1 ) {
1148 bSource = registry[batch[b]].source;
1149 bGroup = registry[batch[b]].group;
1150 if ( splits[bSource] === undefined ) {
1151 splits[bSource] = {};
1152 }
1153 if ( splits[bSource][bGroup] === undefined ) {
1154 splits[bSource][bGroup] = [];
1155 }
1156 bSourceGroup = splits[bSource][bGroup];
1157 bSourceGroup[bSourceGroup.length] = batch[b];
1158 }
1159
1160 // Clear the batch - this MUST happen before we append any
1161 // script elements to the body or it's possible that a script
1162 // will be locally cached, instantly load, and work the batch
1163 // again, all before we've cleared it causing each request to
1164 // include modules which are already loaded.
1165 batch = [];
1166
1167 for ( source in splits ) {
1168
1169 sourceLoadScript = sources[source].loadScript;
1170
1171 for ( group in splits[source] ) {
1172
1173 // Cache access to currently selected list of
1174 // modules for this group from this source.
1175 modules = splits[source][group];
1176
1177 // Calculate the highest timestamp
1178 maxVersion = 0;
1179 for ( g = 0; g < modules.length; g += 1 ) {
1180 if ( registry[modules[g]].version > maxVersion ) {
1181 maxVersion = registry[modules[g]].version;
1182 }
1183 }
1184
1185 currReqBase = $.extend( { version: formatVersionNumber( maxVersion ) }, reqBase );
1186 // For user modules append a user name to the request.
1187 if ( group === 'user' && mw.config.get( 'wgUserName' ) !== null ) {
1188 currReqBase.user = mw.config.get( 'wgUserName' );
1189 }
1190 currReqBaseLength = $.param( currReqBase ).length;
1191 async = true;
1192 // We may need to split up the request to honor the query string length limit,
1193 // so build it piece by piece.
1194 l = currReqBaseLength + 9; // '&modules='.length == 9
1195
1196 moduleMap = {}; // { prefix: [ suffixes ] }
1197
1198 for ( i = 0; i < modules.length; i += 1 ) {
1199 // Determine how many bytes this module would add to the query string
1200 lastDotIndex = modules[i].lastIndexOf( '.' );
1201 // Note that these substr() calls work even if lastDotIndex == -1
1202 prefix = modules[i].substr( 0, lastDotIndex );
1203 suffix = modules[i].substr( lastDotIndex + 1 );
1204 bytesAdded = moduleMap[prefix] !== undefined
1205 ? suffix.length + 3 // '%2C'.length == 3
1206 : modules[i].length + 3; // '%7C'.length == 3
1207
1208 // If the request would become too long, create a new one,
1209 // but don't create empty requests
1210 if ( maxQueryLength > 0 && !$.isEmptyObject( moduleMap ) && l + bytesAdded > maxQueryLength ) {
1211 // This request would become too long, create a new one
1212 // and fire off the old one
1213 doRequest( moduleMap, currReqBase, sourceLoadScript, async );
1214 moduleMap = {};
1215 async = true;
1216 l = currReqBaseLength + 9;
1217 }
1218 if ( moduleMap[prefix] === undefined ) {
1219 moduleMap[prefix] = [];
1220 }
1221 moduleMap[prefix].push( suffix );
1222 if ( !registry[modules[i]].async ) {
1223 // If this module is blocking, make the entire request blocking
1224 // This is slightly suboptimal, but in practice mixing of blocking
1225 // and async modules will only occur in debug mode.
1226 async = false;
1227 }
1228 l += bytesAdded;
1229 }
1230 // If there's anything left in moduleMap, request that too
1231 if ( !$.isEmptyObject( moduleMap ) ) {
1232 doRequest( moduleMap, currReqBase, sourceLoadScript, async );
1233 }
1234 }
1235 }
1236 },
1237
1238 /**
1239 * Register a source.
1240 *
1241 * @param {string} id Short lowercase a-Z string representing a source, only used internally.
1242 * @param {Object} props Object containing only the loadScript property which is a url to
1243 * the load.php location of the source.
1244 * @return {boolean}
1245 */
1246 addSource: function ( id, props ) {
1247 var source;
1248 // Allow multiple additions
1249 if ( typeof id === 'object' ) {
1250 for ( source in id ) {
1251 mw.loader.addSource( source, id[source] );
1252 }
1253 return true;
1254 }
1255
1256 if ( sources[id] !== undefined ) {
1257 throw new Error( 'source already registered: ' + id );
1258 }
1259
1260 sources[id] = props;
1261
1262 return true;
1263 },
1264
1265 /**
1266 * Registers a module, letting the system know about it and its
1267 * properties. Startup modules contain calls to this function.
1268 *
1269 * @param {string} module Module name
1270 * @param {number} version Module version number as a timestamp (falls backs to 0)
1271 * @param {string|Array|Function} dependencies One string or array of strings of module
1272 * names on which this module depends, or a function that returns that array.
1273 * @param {string} [group=null] Group which the module is in
1274 * @param {string} [source='local'] Name of the source
1275 */
1276 register: function ( module, version, dependencies, group, source ) {
1277 var m;
1278 // Allow multiple registration
1279 if ( typeof module === 'object' ) {
1280 for ( m = 0; m < module.length; m += 1 ) {
1281 // module is an array of module names
1282 if ( typeof module[m] === 'string' ) {
1283 mw.loader.register( module[m] );
1284 // module is an array of arrays
1285 } else if ( typeof module[m] === 'object' ) {
1286 mw.loader.register.apply( mw.loader, module[m] );
1287 }
1288 }
1289 return;
1290 }
1291 // Validate input
1292 if ( typeof module !== 'string' ) {
1293 throw new Error( 'module must be a string, not a ' + typeof module );
1294 }
1295 if ( registry[module] !== undefined ) {
1296 throw new Error( 'module already registered: ' + module );
1297 }
1298 // List the module as registered
1299 registry[module] = {
1300 version: version !== undefined ? parseInt( version, 10 ) : 0,
1301 dependencies: [],
1302 group: typeof group === 'string' ? group : null,
1303 source: typeof source === 'string' ? source: 'local',
1304 state: 'registered'
1305 };
1306 if ( typeof dependencies === 'string' ) {
1307 // Allow dependencies to be given as a single module name
1308 registry[module].dependencies = [ dependencies ];
1309 } else if ( typeof dependencies === 'object' || $.isFunction( dependencies ) ) {
1310 // Allow dependencies to be given as an array of module names
1311 // or a function which returns an array
1312 registry[module].dependencies = dependencies;
1313 }
1314 },
1315
1316 /**
1317 * Implements a module, giving the system a course of action to take
1318 * upon loading. Results of a request for one or more modules contain
1319 * calls to this function.
1320 *
1321 * All arguments are required.
1322 *
1323 * @param {string} module Name of module
1324 * @param {Function|Array} script Function with module code or Array of URLs to
1325 * be used as the src attribute of a new `<script>` tag.
1326 * @param {Object} style Should follow one of the following patterns:
1327 * { "css": [css, ..] }
1328 * { "url": { <media>: [url, ..] } }
1329 * And for backwards compatibility (needs to be supported forever due to caching):
1330 * { <media>: css }
1331 * { <media>: [url, ..] }
1332 *
1333 * The reason css strings are not concatenated anymore is bug 31676. We now check
1334 * whether it's safe to extend the stylesheet (see #canExpandStylesheetWith).
1335 *
1336 * @param {Object} msgs List of key/value pairs to be added to {@link mw#messages}.
1337 */
1338 implement: function ( module, script, style, msgs ) {
1339 // Validate input
1340 if ( typeof module !== 'string' ) {
1341 throw new Error( 'module must be a string, not a ' + typeof module );
1342 }
1343 if ( !$.isFunction( script ) && !$.isArray( script ) ) {
1344 throw new Error( 'script must be a function or an array, not a ' + typeof script );
1345 }
1346 if ( !$.isPlainObject( style ) ) {
1347 throw new Error( 'style must be an object, not a ' + typeof style );
1348 }
1349 if ( !$.isPlainObject( msgs ) ) {
1350 throw new Error( 'msgs must be an object, not a ' + typeof msgs );
1351 }
1352 // Automatically register module
1353 if ( registry[module] === undefined ) {
1354 mw.loader.register( module );
1355 }
1356 // Check for duplicate implementation
1357 if ( registry[module] !== undefined && registry[module].script !== undefined ) {
1358 throw new Error( 'module already implemented: ' + module );
1359 }
1360 // Attach components
1361 registry[module].script = script;
1362 registry[module].style = style;
1363 registry[module].messages = msgs;
1364 // The module may already have been marked as erroneous
1365 if ( $.inArray( registry[module].state, ['error', 'missing'] ) === -1 ) {
1366 registry[module].state = 'loaded';
1367 if ( allReady( registry[module].dependencies ) ) {
1368 execute( module );
1369 }
1370 }
1371 },
1372
1373 /**
1374 * Executes a function as soon as one or more required modules are ready
1375 *
1376 * @param {string|Array} dependencies Module name or array of modules names the callback
1377 * dependends on to be ready before executing
1378 * @param {Function} [ready] callback to execute when all dependencies are ready
1379 * @param {Function} [error] callback to execute when if dependencies have a errors
1380 */
1381 using: function ( dependencies, ready, error ) {
1382 var tod = typeof dependencies;
1383 // Validate input
1384 if ( tod !== 'object' && tod !== 'string' ) {
1385 throw new Error( 'dependencies must be a string or an array, not a ' + tod );
1386 }
1387 // Allow calling with a single dependency as a string
1388 if ( tod === 'string' ) {
1389 dependencies = [ dependencies ];
1390 }
1391 // Resolve entire dependency map
1392 dependencies = resolve( dependencies );
1393 if ( allReady( dependencies ) ) {
1394 // Run ready immediately
1395 if ( $.isFunction( ready ) ) {
1396 ready();
1397 }
1398 } else if ( filter( ['error', 'missing'], dependencies ).length ) {
1399 // Execute error immediately if any dependencies have errors
1400 if ( $.isFunction( error ) ) {
1401 error( new Error( 'one or more dependencies have state "error" or "missing"' ),
1402 dependencies );
1403 }
1404 } else {
1405 // Not all dependencies are ready: queue up a request
1406 request( dependencies, ready, error );
1407 }
1408 },
1409
1410 /**
1411 * Loads an external script or one or more modules for future use
1412 *
1413 * @param {string|Array} modules Either the name of a module, array of modules,
1414 * or a URL of an external script or style
1415 * @param {string} [type='text/javascript'] mime-type to use if calling with a URL of an
1416 * external script or style; acceptable values are "text/css" and
1417 * "text/javascript"; if no type is provided, text/javascript is assumed.
1418 * @param {boolean} [async] If true, load modules asynchronously
1419 * even if document ready has not yet occurred. If false, block before
1420 * document ready and load async after. If not set, true will be
1421 * assumed if loading a URL, and false will be assumed otherwise.
1422 */
1423 load: function ( modules, type, async ) {
1424 var filtered, m, module, l;
1425
1426 // Validate input
1427 if ( typeof modules !== 'object' && typeof modules !== 'string' ) {
1428 throw new Error( 'modules must be a string or an array, not a ' + typeof modules );
1429 }
1430 // Allow calling with an external url or single dependency as a string
1431 if ( typeof modules === 'string' ) {
1432 // Support adding arbitrary external scripts
1433 if ( /^(https?:)?\/\//.test( modules ) ) {
1434 if ( async === undefined ) {
1435 // Assume async for bug 34542
1436 async = true;
1437 }
1438 if ( type === 'text/css' ) {
1439 // IE7-8 throws security warnings when inserting a <link> tag
1440 // with a protocol-relative URL set though attributes (instead of
1441 // properties) - when on HTTPS. See also bug #.
1442 l = document.createElement( 'link' );
1443 l.rel = 'stylesheet';
1444 l.href = modules;
1445 $( 'head' ).append( l );
1446 return;
1447 }
1448 if ( type === 'text/javascript' || type === undefined ) {
1449 addScript( modules, null, async );
1450 return;
1451 }
1452 // Unknown type
1453 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type );
1454 }
1455 // Called with single module
1456 modules = [ modules ];
1457 }
1458
1459 // Filter out undefined modules, otherwise resolve() will throw
1460 // an exception for trying to load an undefined module.
1461 // Undefined modules are acceptable here in load(), because load() takes
1462 // an array of unrelated modules, whereas the modules passed to
1463 // using() are related and must all be loaded.
1464 for ( filtered = [], m = 0; m < modules.length; m += 1 ) {
1465 module = registry[modules[m]];
1466 if ( module !== undefined ) {
1467 if ( $.inArray( module.state, ['error', 'missing'] ) === -1 ) {
1468 filtered[filtered.length] = modules[m];
1469 }
1470 }
1471 }
1472
1473 if ( filtered.length === 0 ) {
1474 return;
1475 }
1476 // Resolve entire dependency map
1477 filtered = resolve( filtered );
1478 // If all modules are ready, nothing to be done
1479 if ( allReady( filtered ) ) {
1480 return;
1481 }
1482 // If any modules have errors: also quit.
1483 if ( filter( ['error', 'missing'], filtered ).length ) {
1484 return;
1485 }
1486 // Since some modules are not yet ready, queue up a request.
1487 request( filtered, undefined, undefined, async );
1488 },
1489
1490 /**
1491 * Changes the state of a module
1492 *
1493 * @param {string|Object} module module name or object of module name/state pairs
1494 * @param {string} state state name
1495 */
1496 state: function ( module, state ) {
1497 var m;
1498
1499 if ( typeof module === 'object' ) {
1500 for ( m in module ) {
1501 mw.loader.state( m, module[m] );
1502 }
1503 return;
1504 }
1505 if ( registry[module] === undefined ) {
1506 mw.loader.register( module );
1507 }
1508 if ( $.inArray( state, ['ready', 'error', 'missing'] ) !== -1
1509 && registry[module].state !== state ) {
1510 // Make sure pending modules depending on this one get executed if their
1511 // dependencies are now fulfilled!
1512 registry[module].state = state;
1513 handlePending( module );
1514 } else {
1515 registry[module].state = state;
1516 }
1517 },
1518
1519 /**
1520 * Gets the version of a module
1521 *
1522 * @param {string} module name of module to get version for
1523 */
1524 getVersion: function ( module ) {
1525 if ( registry[module] !== undefined && registry[module].version !== undefined ) {
1526 return formatVersionNumber( registry[module].version );
1527 }
1528 return null;
1529 },
1530
1531 /**
1532 * @deprecated since 1.18 use mw.loader.getVersion() instead
1533 */
1534 version: function () {
1535 return mw.loader.getVersion.apply( mw.loader, arguments );
1536 },
1537
1538 /**
1539 * Gets the state of a module
1540 *
1541 * @param {string} module name of module to get state for
1542 */
1543 getState: function ( module ) {
1544 if ( registry[module] !== undefined && registry[module].state !== undefined ) {
1545 return registry[module].state;
1546 }
1547 return null;
1548 },
1549
1550 /**
1551 * Get names of all registered modules.
1552 *
1553 * @return {Array}
1554 */
1555 getModuleNames: function () {
1556 return $.map( registry, function ( i, key ) {
1557 return key;
1558 } );
1559 },
1560
1561 /**
1562 * For backwards-compatibility with Squid-cached pages. Loads mw.user
1563 */
1564 go: function () {
1565 mw.loader.load( 'mediawiki.user' );
1566 }
1567 };
1568 }() ),
1569
1570 /**
1571 * HTML construction helper functions
1572 * @class mw.html
1573 * @singleton
1574 */
1575 html: ( function () {
1576 function escapeCallback( s ) {
1577 switch ( s ) {
1578 case '\'':
1579 return '&#039;';
1580 case '"':
1581 return '&quot;';
1582 case '<':
1583 return '&lt;';
1584 case '>':
1585 return '&gt;';
1586 case '&':
1587 return '&amp;';
1588 }
1589 }
1590
1591 return {
1592 /**
1593 * Escape a string for HTML. Converts special characters to HTML entities.
1594 * @param {string} s The string to escape
1595 */
1596 escape: function ( s ) {
1597 return s.replace( /['"<>&]/g, escapeCallback );
1598 },
1599
1600 /**
1601 * Wrapper object for raw HTML passed to mw.html.element().
1602 * @class mw.html.Raw
1603 */
1604 Raw: function ( value ) {
1605 this.value = value;
1606 },
1607
1608 /**
1609 * Wrapper object for CDATA element contents passed to mw.html.element()
1610 * @class mw.html.Cdata
1611 */
1612 Cdata: function ( value ) {
1613 this.value = value;
1614 },
1615
1616 /**
1617 * Create an HTML element string, with safe escaping.
1618 *
1619 * @param {string} name The tag name.
1620 * @param {Object} attrs An object with members mapping element names to values
1621 * @param {Mixed} contents The contents of the element. May be either:
1622 * - string: The string is escaped.
1623 * - null or undefined: The short closing form is used, e.g. <br/>.
1624 * - this.Raw: The value attribute is included without escaping.
1625 * - this.Cdata: The value attribute is included, and an exception is
1626 * thrown if it contains an illegal ETAGO delimiter.
1627 * See http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.3.2
1628 *
1629 * Example:
1630 * var h = mw.html;
1631 * return h.element( 'div', {},
1632 * new h.Raw( h.element( 'img', {src: '<'} ) ) );
1633 * Returns <div><img src="&lt;"/></div>
1634 */
1635 element: function ( name, attrs, contents ) {
1636 var v, attrName, s = '<' + name;
1637
1638 for ( attrName in attrs ) {
1639 v = attrs[attrName];
1640 // Convert name=true, to name=name
1641 if ( v === true ) {
1642 v = attrName;
1643 // Skip name=false
1644 } else if ( v === false ) {
1645 continue;
1646 }
1647 s += ' ' + attrName + '="' + this.escape( String( v ) ) + '"';
1648 }
1649 if ( contents === undefined || contents === null ) {
1650 // Self close tag
1651 s += '/>';
1652 return s;
1653 }
1654 // Regular open tag
1655 s += '>';
1656 switch ( typeof contents ) {
1657 case 'string':
1658 // Escaped
1659 s += this.escape( contents );
1660 break;
1661 case 'number':
1662 case 'boolean':
1663 // Convert to string
1664 s += String( contents );
1665 break;
1666 default:
1667 if ( contents instanceof this.Raw ) {
1668 // Raw HTML inclusion
1669 s += contents.value;
1670 } else if ( contents instanceof this.Cdata ) {
1671 // CDATA
1672 if ( /<\/[a-zA-z]/.test( contents.value ) ) {
1673 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
1674 }
1675 s += contents.value;
1676 } else {
1677 throw new Error( 'mw.html.element: Invalid type of contents' );
1678 }
1679 }
1680 s += '</' + name + '>';
1681 return s;
1682 }
1683 };
1684 }() ),
1685
1686 // Skeleton user object. mediawiki.user.js extends this
1687 user: {
1688 options: new Map(),
1689 tokens: new Map()
1690 }
1691 };
1692
1693 }( jQuery ) );
1694
1695 // Alias $j to jQuery for backwards compatibility
1696 window.$j = jQuery;
1697
1698 // Attach to window and globally alias
1699 window.mw = window.mediaWiki = mw;
1700
1701 // Auto-register from pre-loaded startup scripts
1702 if ( jQuery.isFunction( window.startUp ) ) {
1703 window.startUp();
1704 window.startUp = undefined;
1705 }