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