Merge "CologneBlue rewrite: get rid of some extra ugly HTML"
[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 parameter_1 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, parameter_1 /* [, parameter_2] */ ) {
298 var parameters;
299 // Support variadic arguments
300 if ( parameter_1 !== 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 function compare( a, b ) {
477 var i;
478 if ( a.length !== b.length ) {
479 return false;
480 }
481 for ( i = 0; i < b.length; i += 1 ) {
482 if ( $.isArray( a[i] ) ) {
483 if ( !compare( a[i], b[i] ) ) {
484 return false;
485 }
486 }
487 if ( a[i] !== b[i] ) {
488 return false;
489 }
490 }
491 return true;
492 }
493
494 /**
495 * Generates an ISO8601 "basic" string from a UNIX timestamp
496 */
497 function formatVersionNumber( timestamp ) {
498 var pad = function ( a, b, c ) {
499 return [a < 10 ? '0' + a : a, b < 10 ? '0' + b : b, c < 10 ? '0' + c : c].join( '' );
500 },
501 d = new Date();
502 d.setTime( timestamp * 1000 );
503 return [
504 pad( d.getUTCFullYear(), d.getUTCMonth() + 1, d.getUTCDate() ), 'T',
505 pad( d.getUTCHours(), d.getUTCMinutes(), d.getUTCSeconds() ), 'Z'
506 ].join( '' );
507 }
508
509 /**
510 * Resolves dependencies and detects circular references.
511 *
512 * @param module String Name of the top-level module whose dependencies shall be
513 * resolved and sorted.
514 * @param resolved Array Returns a topological sort of the given module and its
515 * dependencies, such that later modules depend on earlier modules. The array
516 * contains the module names. If the array contains already some module names,
517 * this function appends its result to the pre-existing array.
518 * @param unresolved Object [optional] Hash used to track the current dependency
519 * chain; used to report loops in the dependency graph.
520 * @throws Error if any unregistered module or a dependency loop is encountered
521 */
522 function sortDependencies( module, resolved, unresolved ) {
523 var n, deps, len;
524
525 if ( registry[module] === undefined ) {
526 throw new Error( 'Unknown dependency: ' + module );
527 }
528 // Resolves dynamic loader function and replaces it with its own results
529 if ( $.isFunction( registry[module].dependencies ) ) {
530 registry[module].dependencies = registry[module].dependencies();
531 // Ensures the module's dependencies are always in an array
532 if ( typeof registry[module].dependencies !== 'object' ) {
533 registry[module].dependencies = [registry[module].dependencies];
534 }
535 }
536 if ( $.inArray( module, resolved ) !== -1 ) {
537 // Module already resolved; nothing to do.
538 return;
539 }
540 // unresolved is optional, supply it if not passed in
541 if ( !unresolved ) {
542 unresolved = {};
543 }
544 // Tracks down dependencies
545 deps = registry[module].dependencies;
546 len = deps.length;
547 for ( n = 0; n < len; n += 1 ) {
548 if ( $.inArray( deps[n], resolved ) === -1 ) {
549 if ( unresolved[deps[n]] ) {
550 throw new Error(
551 'Circular reference detected: ' + module +
552 ' -> ' + deps[n]
553 );
554 }
555
556 // Add to unresolved
557 unresolved[module] = true;
558 sortDependencies( deps[n], resolved, unresolved );
559 delete unresolved[module];
560 }
561 }
562 resolved[resolved.length] = module;
563 }
564
565 /**
566 * Gets a list of module names that a module depends on in their proper dependency
567 * order.
568 *
569 * @param module string module name or array of string module names
570 * @return list of dependencies, including 'module'.
571 * @throws Error if circular reference is detected
572 */
573 function resolve( module ) {
574 var m, resolved;
575
576 // Allow calling with an array of module names
577 if ( $.isArray( module ) ) {
578 resolved = [];
579 for ( m = 0; m < module.length; m += 1 ) {
580 sortDependencies( module[m], resolved );
581 }
582 return resolved;
583 }
584
585 if ( typeof module === 'string' ) {
586 resolved = [];
587 sortDependencies( module, resolved );
588 return resolved;
589 }
590
591 throw new Error( 'Invalid module argument: ' + module );
592 }
593
594 /**
595 * Narrows a list of module names down to those matching a specific
596 * state (see comment on top of this scope for a list of valid states).
597 * One can also filter for 'unregistered', which will return the
598 * modules names that don't have a registry entry.
599 *
600 * @param states string or array of strings of module states to filter by
601 * @param modules array list of module names to filter (optional, by default the entire
602 * registry is used)
603 * @return array list of filtered module names
604 */
605 function filter( states, modules ) {
606 var list, module, s, m;
607
608 // Allow states to be given as a string
609 if ( typeof states === 'string' ) {
610 states = [states];
611 }
612 // If called without a list of modules, build and use a list of all modules
613 list = [];
614 if ( modules === undefined ) {
615 modules = [];
616 for ( module in registry ) {
617 modules[modules.length] = module;
618 }
619 }
620 // Build a list of modules which are in one of the specified states
621 for ( s = 0; s < states.length; s += 1 ) {
622 for ( m = 0; m < modules.length; m += 1 ) {
623 if ( registry[modules[m]] === undefined ) {
624 // Module does not exist
625 if ( states[s] === 'unregistered' ) {
626 // OK, undefined
627 list[list.length] = modules[m];
628 }
629 } else {
630 // Module exists, check state
631 if ( registry[modules[m]].state === states[s] ) {
632 // OK, correct state
633 list[list.length] = modules[m];
634 }
635 }
636 }
637 }
638 return list;
639 }
640
641 /**
642 * Determine whether all dependencies are in state 'ready', which means we may
643 * execute the module or job now.
644 *
645 * @param dependencies Array dependencies (module names) to be checked.
646 *
647 * @return Boolean true if all dependencies are in state 'ready', false otherwise
648 */
649 function allReady( dependencies ) {
650 return filter( 'ready', dependencies ).length === dependencies.length;
651 }
652
653 /**
654 * Log a message to window.console, if possible. Useful to force logging of some
655 * errors that are otherwise hard to detect (I.e., this logs also in production mode).
656 * Gets console references in each invocation, so that delayed debugging tools work
657 * fine. No need for optimization here, which would only result in losing logs.
658 *
659 * @param msg String text for the log entry.
660 * @param e Error [optional] to also log.
661 */
662 function log( msg, e ) {
663 var console = window.console;
664 if ( console && console.log ) {
665 console.log( msg );
666 // If we have an exception object, log it through .error() to trigger
667 // proper stacktraces in browsers that support it. There are no (known)
668 // browsers that don't support .error(), that do support .log() and
669 // have useful exception handling through .log().
670 if ( e && console.error ) {
671 console.error( e );
672 }
673 }
674 }
675
676 /**
677 * A module has entered state 'ready', 'error', or 'missing'. Automatically update pending jobs
678 * and modules that depend upon this module. if the given module failed, propagate the 'error'
679 * state up the dependency tree; otherwise, execute all jobs/modules that now have all their
680 * dependencies satisfied. On jobs depending on a failed module, run the error callback, if any.
681 *
682 * @param module String name of module that entered one of the states 'ready', 'error', or 'missing'.
683 */
684 function handlePending( module ) {
685 var j, job, hasErrors, m, stateChange;
686
687 // Modules.
688 if ( $.inArray( registry[module].state, ['error', 'missing'] ) !== -1 ) {
689 // If the current module failed, mark all dependent modules also as failed.
690 // Iterate until steady-state to propagate the error state upwards in the
691 // dependency tree.
692 do {
693 stateChange = false;
694 for ( m in registry ) {
695 if ( $.inArray( registry[m].state, ['error', 'missing'] ) === -1 ) {
696 if ( filter( ['error', 'missing'], registry[m].dependencies ).length > 0 ) {
697 registry[m].state = 'error';
698 stateChange = true;
699 }
700 }
701 }
702 } while ( stateChange );
703 }
704
705 // Execute all jobs whose dependencies are either all satisfied or contain at least one failed module.
706 for ( j = 0; j < jobs.length; j += 1 ) {
707 hasErrors = filter( ['error', 'missing'], jobs[j].dependencies ).length > 0;
708 if ( hasErrors || allReady( jobs[j].dependencies ) ) {
709 // All dependencies satisfied, or some have errors
710 job = jobs[j];
711 jobs.splice( j, 1 );
712 j -= 1;
713 try {
714 if ( hasErrors ) {
715 throw new Error ("Module " + module + " failed.");
716 } else {
717 if ( $.isFunction( job.ready ) ) {
718 job.ready();
719 }
720 }
721 } catch ( e ) {
722 if ( $.isFunction( job.error ) ) {
723 try {
724 job.error( e, [module] );
725 } catch ( ex ) {
726 // A user-defined operation raised an exception. Swallow to protect
727 // our state machine!
728 log( 'Exception thrown by job.error()', ex );
729 }
730 }
731 }
732 }
733 }
734
735 if ( registry[module].state === 'ready' ) {
736 // The current module became 'ready'. Recursively execute all dependent modules that are loaded
737 // and now have all dependencies satisfied.
738 for ( m in registry ) {
739 if ( registry[m].state === 'loaded' && allReady( registry[m].dependencies ) ) {
740 execute( m );
741 }
742 }
743 }
744 }
745
746 /**
747 * Adds a script tag to the DOM, either using document.write or low-level DOM manipulation,
748 * depending on whether document-ready has occurred yet and whether we are in async mode.
749 *
750 * @param src String: URL to script, will be used as the src attribute in the script tag
751 * @param callback Function: Optional callback which will be run when the script is done
752 */
753 function addScript( src, callback, async ) {
754 /*jshint evil:true */
755 var script, head,
756 done = false;
757
758 // Using isReady directly instead of storing it locally from
759 // a $.fn.ready callback (bug 31895).
760 if ( $.isReady || async ) {
761 // jQuery's getScript method is NOT better than doing this the old-fashioned way
762 // because jQuery will eval the script's code, and errors will not have sane
763 // line numbers.
764 script = document.createElement( 'script' );
765 script.setAttribute( 'src', src );
766 script.setAttribute( 'type', 'text/javascript' );
767 if ( $.isFunction( callback ) ) {
768 // Attach handlers for all browsers (based on jQuery.ajax)
769 script.onload = script.onreadystatechange = function () {
770
771 if (
772 !done
773 && (
774 !script.readyState
775 || /loaded|complete/.test( script.readyState )
776 )
777 ) {
778
779 done = true;
780
781 callback();
782
783 // Handle memory leak in IE. This seems to fail in
784 // IE7 sometimes (Permission Denied error when
785 // accessing script.parentNode) so wrap it in
786 // a try catch.
787 try {
788 script.onload = script.onreadystatechange = null;
789 if ( script.parentNode ) {
790 script.parentNode.removeChild( script );
791 }
792
793 // Dereference the script
794 script = undefined;
795 } catch ( e ) { }
796 }
797 };
798 }
799
800 if ( window.opera ) {
801 // Appending to the <head> blocks rendering completely in Opera,
802 // so append to the <body> after document ready. This means the
803 // scripts only start loading after the document has been rendered,
804 // but so be it. Opera users don't deserve faster web pages if their
805 // browser makes it impossible
806 $( function () { document.body.appendChild( script ); } );
807 } else {
808 // IE-safe way of getting the <head> . document.documentElement.head doesn't
809 // work in scripts that run in the <head>
810 head = document.getElementsByTagName( 'head' )[0];
811 ( document.body || head ).appendChild( script );
812 }
813 } else {
814 document.write( mw.html.element(
815 'script', { 'type': 'text/javascript', 'src': src }, ''
816 ) );
817 if ( $.isFunction( callback ) ) {
818 // Document.write is synchronous, so this is called when it's done
819 // FIXME: that's a lie. doc.write isn't actually synchronous
820 callback();
821 }
822 }
823 }
824
825 /**
826 * Executes a loaded module, making it ready to use
827 *
828 * @param module string module name to execute
829 */
830 function execute( module ) {
831 var key, value, media, i, script, markModuleReady, nestedAddScript;
832
833 if ( registry[module] === undefined ) {
834 throw new Error( 'Module has not been registered yet: ' + module );
835 } else if ( registry[module].state === 'registered' ) {
836 throw new Error( 'Module has not been requested from the server yet: ' + module );
837 } else if ( registry[module].state === 'loading' ) {
838 throw new Error( 'Module has not completed loading yet: ' + module );
839 } else if ( registry[module].state === 'ready' ) {
840 throw new Error( 'Module has already been loaded: ' + module );
841 }
842
843 /**
844 * Define loop-function here for efficiency
845 * and to avoid re-using badly scoped variables.
846 */
847 function addLink( media, url ) {
848 var el = document.createElement( 'link' );
849 getMarker().before( el ); // IE: Insert in dom before setting href
850 el.rel = 'stylesheet';
851 if ( media && media !== 'all' ) {
852 el.media = media;
853 }
854 el.href = url;
855 }
856
857 // Process styles (see also mw.loader.implement)
858 // * back-compat: { <media>: css }
859 // * back-compat: { <media>: [url, ..] }
860 // * { "css": [css, ..] }
861 // * { "url": { <media>: [url, ..] } }
862 if ( $.isPlainObject( registry[module].style ) ) {
863 for ( key in registry[module].style ) {
864 value = registry[module].style[key];
865 media = undefined;
866
867 if ( key !== 'url' && key !== 'css' ) {
868 // Backwards compatibility, key is a media-type
869 if ( typeof value === 'string' ) {
870 // back-compat: { <media>: css }
871 // Ignore 'media' because it isn't supported (nor was it used).
872 // Strings are pre-wrapped in "@media". The media-type was just ""
873 // (because it had to be set to something).
874 // This is one of the reasons why this format is no longer used.
875 addEmbeddedCSS( value );
876 } else {
877 // back-compat: { <media>: [url, ..] }
878 media = key;
879 key = 'bc-url';
880 }
881 }
882
883 // Array of css strings in key 'css',
884 // or back-compat array of urls from media-type
885 if ( $.isArray( value ) ) {
886 for ( i = 0; i < value.length; i += 1 ) {
887 if ( key === 'bc-url' ) {
888 // back-compat: { <media>: [url, ..] }
889 addLink( media, value[i] );
890 } else if ( key === 'css' ) {
891 // { "css": [css, ..] }
892 addEmbeddedCSS( value[i] );
893 }
894 }
895 // Not an array, but a regular object
896 // Array of urls inside media-type key
897 } else if ( typeof value === 'object' ) {
898 // { "url": { <media>: [url, ..] } }
899 $.each( value, addLink );
900 }
901 }
902 }
903
904 // Add localizations to message system
905 if ( $.isPlainObject( registry[module].messages ) ) {
906 mw.messages.set( registry[module].messages );
907 }
908
909 // Execute script
910 try {
911 script = registry[module].script;
912 markModuleReady = function () {
913 registry[module].state = 'ready';
914 handlePending( module );
915 };
916 nestedAddScript = function ( arr, callback, async, i ) {
917 // Recursively call addScript() in its own callback
918 // for each element of arr.
919 if ( i >= arr.length ) {
920 // We're at the end of the array
921 callback();
922 return;
923 }
924
925 addScript( arr[i], function () {
926 nestedAddScript( arr, callback, async, i + 1 );
927 }, async );
928 };
929
930 if ( $.isArray( script ) ) {
931 registry[module].state = 'loading';
932 nestedAddScript( script, markModuleReady, registry[module].async, 0 );
933 } else if ( $.isFunction( script ) ) {
934 registry[module].state = 'ready';
935 script( $ );
936 handlePending( module );
937 }
938 } catch ( e ) {
939 // This needs to NOT use mw.log because these errors are common in production mode
940 // and not in debug mode, such as when a symbol that should be global isn't exported
941 log( 'Exception thrown by ' + module + ': ' + e.message, e );
942 registry[module].state = 'error';
943 handlePending( module );
944 }
945 }
946
947 /**
948 * Adds a dependencies to the queue with optional callbacks to be run
949 * when the dependencies are ready or fail
950 *
951 * @param dependencies string module name or array of string module names
952 * @param ready function callback to execute when all dependencies are ready
953 * @param error function callback to execute when any dependency fails
954 * @param async (optional) If true, load modules asynchronously even if
955 * document ready has not yet occurred
956 */
957 function request( dependencies, ready, error, async ) {
958 var regItemDeps, regItemDepLen, n;
959
960 // Allow calling by single module name
961 if ( typeof dependencies === 'string' ) {
962 dependencies = [dependencies];
963 }
964
965 // Add ready and error callbacks if they were given
966 if ( ready !== undefined || error !== undefined ) {
967 jobs[jobs.length] = {
968 'dependencies': filter(
969 ['registered', 'loading', 'loaded'],
970 dependencies
971 ),
972 'ready': ready,
973 'error': error
974 };
975 }
976
977 // Queue up any dependencies that are registered
978 dependencies = filter( ['registered'], dependencies );
979 for ( n = 0; n < dependencies.length; n += 1 ) {
980 if ( $.inArray( dependencies[n], queue ) === -1 ) {
981 queue[queue.length] = dependencies[n];
982 if ( async ) {
983 // Mark this module as async in the registry
984 registry[dependencies[n]].async = true;
985 }
986 }
987 }
988
989 // Work the queue
990 mw.loader.work();
991 }
992
993 function sortQuery(o) {
994 var sorted = {}, key, a = [];
995 for ( key in o ) {
996 if ( hasOwn.call( o, key ) ) {
997 a.push( key );
998 }
999 }
1000 a.sort();
1001 for ( key = 0; key < a.length; key += 1 ) {
1002 sorted[a[key]] = o[a[key]];
1003 }
1004 return sorted;
1005 }
1006
1007 /**
1008 * Converts a module map of the form { foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }
1009 * to a query string of the form foo.bar,baz|bar.baz,quux
1010 */
1011 function buildModulesString( moduleMap ) {
1012 var arr = [], p, prefix;
1013 for ( prefix in moduleMap ) {
1014 p = prefix === '' ? '' : prefix + '.';
1015 arr.push( p + moduleMap[prefix].join( ',' ) );
1016 }
1017 return arr.join( '|' );
1018 }
1019
1020 /**
1021 * Asynchronously append a script tag to the end of the body
1022 * that invokes load.php
1023 * @param moduleMap {Object}: Module map, see buildModulesString()
1024 * @param currReqBase {Object}: Object with other parameters (other than 'modules') to use in the request
1025 * @param sourceLoadScript {String}: URL of load.php
1026 * @param async {Boolean}: If true, use an asynchrounous request even if document ready has not yet occurred
1027 */
1028 function doRequest( moduleMap, currReqBase, sourceLoadScript, async ) {
1029 var request = $.extend(
1030 { 'modules': buildModulesString( moduleMap ) },
1031 currReqBase
1032 );
1033 request = sortQuery( request );
1034 // Asynchronously append a script tag to the end of the body
1035 // Append &* to avoid triggering the IE6 extension check
1036 addScript( sourceLoadScript + '?' + $.param( request ) + '&*', null, async );
1037 }
1038
1039 /* Public Methods */
1040 return {
1041 addStyleTag: addStyleTag,
1042
1043 /**
1044 * Requests dependencies from server, loading and executing when things when ready.
1045 */
1046 work: function () {
1047 var reqBase, splits, maxQueryLength, q, b, bSource, bGroup, bSourceGroup,
1048 source, group, g, i, modules, maxVersion, sourceLoadScript,
1049 currReqBase, currReqBaseLength, moduleMap, l,
1050 lastDotIndex, prefix, suffix, bytesAdded, async;
1051
1052 // Build a list of request parameters common to all requests.
1053 reqBase = {
1054 skin: mw.config.get( 'skin' ),
1055 lang: mw.config.get( 'wgUserLanguage' ),
1056 debug: mw.config.get( 'debug' )
1057 };
1058 // Split module batch by source and by group.
1059 splits = {};
1060 maxQueryLength = mw.config.get( 'wgResourceLoaderMaxQueryLength', -1 );
1061
1062 // Appends a list of modules from the queue to the batch
1063 for ( q = 0; q < queue.length; q += 1 ) {
1064 // Only request modules which are registered
1065 if ( registry[queue[q]] !== undefined && registry[queue[q]].state === 'registered' ) {
1066 // Prevent duplicate entries
1067 if ( $.inArray( queue[q], batch ) === -1 ) {
1068 batch[batch.length] = queue[q];
1069 // Mark registered modules as loading
1070 registry[queue[q]].state = 'loading';
1071 }
1072 }
1073 }
1074 // Early exit if there's nothing to load...
1075 if ( !batch.length ) {
1076 return;
1077 }
1078
1079 // The queue has been processed into the batch, clear up the queue.
1080 queue = [];
1081
1082 // Always order modules alphabetically to help reduce cache
1083 // misses for otherwise identical content.
1084 batch.sort();
1085
1086 // Split batch by source and by group.
1087 for ( b = 0; b < batch.length; b += 1 ) {
1088 bSource = registry[batch[b]].source;
1089 bGroup = registry[batch[b]].group;
1090 if ( splits[bSource] === undefined ) {
1091 splits[bSource] = {};
1092 }
1093 if ( splits[bSource][bGroup] === undefined ) {
1094 splits[bSource][bGroup] = [];
1095 }
1096 bSourceGroup = splits[bSource][bGroup];
1097 bSourceGroup[bSourceGroup.length] = batch[b];
1098 }
1099
1100 // Clear the batch - this MUST happen before we append any
1101 // script elements to the body or it's possible that a script
1102 // will be locally cached, instantly load, and work the batch
1103 // again, all before we've cleared it causing each request to
1104 // include modules which are already loaded.
1105 batch = [];
1106
1107 for ( source in splits ) {
1108
1109 sourceLoadScript = sources[source].loadScript;
1110
1111 for ( group in splits[source] ) {
1112
1113 // Cache access to currently selected list of
1114 // modules for this group from this source.
1115 modules = splits[source][group];
1116
1117 // Calculate the highest timestamp
1118 maxVersion = 0;
1119 for ( g = 0; g < modules.length; g += 1 ) {
1120 if ( registry[modules[g]].version > maxVersion ) {
1121 maxVersion = registry[modules[g]].version;
1122 }
1123 }
1124
1125 currReqBase = $.extend( { 'version': formatVersionNumber( maxVersion ) }, reqBase );
1126 // For user modules append a user name to the request.
1127 if ( group === "user" && mw.config.get( 'wgUserName' ) !== null ) {
1128 currReqBase.user = mw.config.get( 'wgUserName' );
1129 }
1130 currReqBaseLength = $.param( currReqBase ).length;
1131 async = true;
1132 // We may need to split up the request to honor the query string length limit,
1133 // so build it piece by piece.
1134 l = currReqBaseLength + 9; // '&modules='.length == 9
1135
1136 moduleMap = {}; // { prefix: [ suffixes ] }
1137
1138 for ( i = 0; i < modules.length; i += 1 ) {
1139 // Determine how many bytes this module would add to the query string
1140 lastDotIndex = modules[i].lastIndexOf( '.' );
1141 // Note that these substr() calls work even if lastDotIndex == -1
1142 prefix = modules[i].substr( 0, lastDotIndex );
1143 suffix = modules[i].substr( lastDotIndex + 1 );
1144 bytesAdded = moduleMap[prefix] !== undefined
1145 ? suffix.length + 3 // '%2C'.length == 3
1146 : modules[i].length + 3; // '%7C'.length == 3
1147
1148 // If the request would become too long, create a new one,
1149 // but don't create empty requests
1150 if ( maxQueryLength > 0 && !$.isEmptyObject( moduleMap ) && l + bytesAdded > maxQueryLength ) {
1151 // This request would become too long, create a new one
1152 // and fire off the old one
1153 doRequest( moduleMap, currReqBase, sourceLoadScript, async );
1154 moduleMap = {};
1155 async = true;
1156 l = currReqBaseLength + 9;
1157 }
1158 if ( moduleMap[prefix] === undefined ) {
1159 moduleMap[prefix] = [];
1160 }
1161 moduleMap[prefix].push( suffix );
1162 if ( !registry[modules[i]].async ) {
1163 // If this module is blocking, make the entire request blocking
1164 // This is slightly suboptimal, but in practice mixing of blocking
1165 // and async modules will only occur in debug mode.
1166 async = false;
1167 }
1168 l += bytesAdded;
1169 }
1170 // If there's anything left in moduleMap, request that too
1171 if ( !$.isEmptyObject( moduleMap ) ) {
1172 doRequest( moduleMap, currReqBase, sourceLoadScript, async );
1173 }
1174 }
1175 }
1176 },
1177
1178 /**
1179 * Register a source.
1180 *
1181 * @param id {String}: Short lowercase a-Z string representing a source, only used internally.
1182 * @param props {Object}: Object containing only the loadScript property which is a url to
1183 * the load.php location of the source.
1184 * @return {Boolean}
1185 */
1186 addSource: function ( id, props ) {
1187 var source;
1188 // Allow multiple additions
1189 if ( typeof id === 'object' ) {
1190 for ( source in id ) {
1191 mw.loader.addSource( source, id[source] );
1192 }
1193 return true;
1194 }
1195
1196 if ( sources[id] !== undefined ) {
1197 throw new Error( 'source already registered: ' + id );
1198 }
1199
1200 sources[id] = props;
1201
1202 return true;
1203 },
1204
1205 /**
1206 * Registers a module, letting the system know about it and its
1207 * properties. Startup modules contain calls to this function.
1208 *
1209 * @param module {String}: Module name
1210 * @param version {Number}: Module version number as a timestamp (falls backs to 0)
1211 * @param dependencies {String|Array|Function}: One string or array of strings of module
1212 * names on which this module depends, or a function that returns that array.
1213 * @param group {String}: Group which the module is in (optional, defaults to null)
1214 * @param source {String}: Name of the source. Defaults to local.
1215 */
1216 register: function ( module, version, dependencies, group, source ) {
1217 var m;
1218 // Allow multiple registration
1219 if ( typeof module === 'object' ) {
1220 for ( m = 0; m < module.length; m += 1 ) {
1221 // module is an array of module names
1222 if ( typeof module[m] === 'string' ) {
1223 mw.loader.register( module[m] );
1224 // module is an array of arrays
1225 } else if ( typeof module[m] === 'object' ) {
1226 mw.loader.register.apply( mw.loader, module[m] );
1227 }
1228 }
1229 return;
1230 }
1231 // Validate input
1232 if ( typeof module !== 'string' ) {
1233 throw new Error( 'module must be a string, not a ' + typeof module );
1234 }
1235 if ( registry[module] !== undefined ) {
1236 throw new Error( 'module already registered: ' + module );
1237 }
1238 // List the module as registered
1239 registry[module] = {
1240 'version': version !== undefined ? parseInt( version, 10 ) : 0,
1241 'dependencies': [],
1242 'group': typeof group === 'string' ? group : null,
1243 'source': typeof source === 'string' ? source: 'local',
1244 'state': 'registered'
1245 };
1246 if ( typeof dependencies === 'string' ) {
1247 // Allow dependencies to be given as a single module name
1248 registry[module].dependencies = [dependencies];
1249 } else if ( typeof dependencies === 'object' || $.isFunction( dependencies ) ) {
1250 // Allow dependencies to be given as an array of module names
1251 // or a function which returns an array
1252 registry[module].dependencies = dependencies;
1253 }
1254 },
1255
1256 /**
1257 * Implements a module, giving the system a course of action to take
1258 * upon loading. Results of a request for one or more modules contain
1259 * calls to this function.
1260 *
1261 * All arguments are required.
1262 *
1263 * @param {String} module Name of module
1264 * @param {Function|Array} script Function with module code or Array of URLs to
1265 * be used as the src attribute of a new <script> tag.
1266 * @param {Object} style Should follow one of the following patterns:
1267 * { "css": [css, ..] }
1268 * { "url": { <media>: [url, ..] } }
1269 * And for backwards compatibility (needs to be supported forever due to caching):
1270 * { <media>: css }
1271 * { <media>: [url, ..] }
1272 *
1273 * The reason css strings are not concatenated anymore is bug 31676. We now check
1274 * whether it's safe to extend the stylesheet (see canExpandStylesheetWith).
1275 *
1276 * @param {Object} msgs List of key/value pairs to be passed through mw.messages.set
1277 */
1278 implement: function ( module, script, style, msgs ) {
1279 // Validate input
1280 if ( typeof module !== 'string' ) {
1281 throw new Error( 'module must be a string, not a ' + typeof module );
1282 }
1283 if ( !$.isFunction( script ) && !$.isArray( script ) ) {
1284 throw new Error( 'script must be a function or an array, not a ' + typeof script );
1285 }
1286 if ( !$.isPlainObject( style ) ) {
1287 throw new Error( 'style must be an object, not a ' + typeof style );
1288 }
1289 if ( !$.isPlainObject( msgs ) ) {
1290 throw new Error( 'msgs must be an object, not a ' + typeof msgs );
1291 }
1292 // Automatically register module
1293 if ( registry[module] === undefined ) {
1294 mw.loader.register( module );
1295 }
1296 // Check for duplicate implementation
1297 if ( registry[module] !== undefined && registry[module].script !== undefined ) {
1298 throw new Error( 'module already implemented: ' + module );
1299 }
1300 // Attach components
1301 registry[module].script = script;
1302 registry[module].style = style;
1303 registry[module].messages = msgs;
1304 // The module may already have been marked as erroneous
1305 if ( $.inArray( registry[module].state, ['error', 'missing'] ) === -1 ) {
1306 registry[module].state = 'loaded';
1307 if ( allReady( registry[module].dependencies ) ) {
1308 execute( module );
1309 }
1310 }
1311 },
1312
1313 /**
1314 * Executes a function as soon as one or more required modules are ready
1315 *
1316 * @param dependencies {String|Array} Module name or array of modules names the callback
1317 * dependends on to be ready before executing
1318 * @param ready {Function} callback to execute when all dependencies are ready (optional)
1319 * @param error {Function} callback to execute when if dependencies have a errors (optional)
1320 */
1321 using: function ( dependencies, ready, error ) {
1322 var tod = typeof dependencies;
1323 // Validate input
1324 if ( tod !== 'object' && tod !== 'string' ) {
1325 throw new Error( 'dependencies must be a string or an array, not a ' + tod );
1326 }
1327 // Allow calling with a single dependency as a string
1328 if ( tod === 'string' ) {
1329 dependencies = [dependencies];
1330 }
1331 // Resolve entire dependency map
1332 dependencies = resolve( dependencies );
1333 if ( allReady( dependencies ) ) {
1334 // Run ready immediately
1335 if ( $.isFunction( ready ) ) {
1336 ready();
1337 }
1338 } else if ( filter( ['error', 'missing'], dependencies ).length ) {
1339 // Execute error immediately if any dependencies have errors
1340 if ( $.isFunction( error ) ) {
1341 error( new Error( 'one or more dependencies have state "error" or "missing"' ),
1342 dependencies );
1343 }
1344 } else {
1345 // Not all dependencies are ready: queue up a request
1346 request( dependencies, ready, error );
1347 }
1348 },
1349
1350 /**
1351 * Loads an external script or one or more modules for future use
1352 *
1353 * @param modules {mixed} Either the name of a module, array of modules,
1354 * or a URL of an external script or style
1355 * @param type {String} mime-type to use if calling with a URL of an
1356 * external script or style; acceptable values are "text/css" and
1357 * "text/javascript"; if no type is provided, text/javascript is assumed.
1358 * @param async {Boolean} (optional) If true, load modules asynchronously
1359 * even if document ready has not yet occurred. If false (default),
1360 * block before document ready and load async after. If not set, true will
1361 * be assumed if loading a URL, and false will be assumed otherwise.
1362 */
1363 load: function ( modules, type, async ) {
1364 var filtered, m, module;
1365
1366 // Validate input
1367 if ( typeof modules !== 'object' && typeof modules !== 'string' ) {
1368 throw new Error( 'modules must be a string or an array, not a ' + typeof modules );
1369 }
1370 // Allow calling with an external url or single dependency as a string
1371 if ( typeof modules === 'string' ) {
1372 // Support adding arbitrary external scripts
1373 if ( /^(https?:)?\/\//.test( modules ) ) {
1374 if ( async === undefined ) {
1375 // Assume async for bug 34542
1376 async = true;
1377 }
1378 if ( type === 'text/css' ) {
1379 $( 'head' ).append( $( '<link>', {
1380 rel: 'stylesheet',
1381 type: 'text/css',
1382 href: modules
1383 } ) );
1384 return;
1385 }
1386 if ( type === 'text/javascript' || type === undefined ) {
1387 addScript( modules, null, async );
1388 return;
1389 }
1390 // Unknown type
1391 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type );
1392 }
1393 // Called with single module
1394 modules = [modules];
1395 }
1396
1397 // Filter out undefined modules, otherwise resolve() will throw
1398 // an exception for trying to load an undefined module.
1399 // Undefined modules are acceptable here in load(), because load() takes
1400 // an array of unrelated modules, whereas the modules passed to
1401 // using() are related and must all be loaded.
1402 for ( filtered = [], m = 0; m < modules.length; m += 1 ) {
1403 module = registry[modules[m]];
1404 if ( module !== undefined ) {
1405 if ( $.inArray( module.state, ['error', 'missing'] ) === -1 ) {
1406 filtered[filtered.length] = modules[m];
1407 }
1408 }
1409 }
1410
1411 if ( filtered.length === 0 ) {
1412 return;
1413 }
1414 // Resolve entire dependency map
1415 filtered = resolve( filtered );
1416 // If all modules are ready, nothing to be done
1417 if ( allReady( filtered ) ) {
1418 return;
1419 }
1420 // If any modules have errors: also quit.
1421 if ( filter( ['error', 'missing'], filtered ).length ) {
1422 return;
1423 }
1424 // Since some modules are not yet ready, queue up a request.
1425 request( filtered, null, null, async );
1426 },
1427
1428 /**
1429 * Changes the state of a module
1430 *
1431 * @param module {String|Object} module name or object of module name/state pairs
1432 * @param state {String} state name
1433 */
1434 state: function ( module, state ) {
1435 var m;
1436
1437 if ( typeof module === 'object' ) {
1438 for ( m in module ) {
1439 mw.loader.state( m, module[m] );
1440 }
1441 return;
1442 }
1443 if ( registry[module] === undefined ) {
1444 mw.loader.register( module );
1445 }
1446 if ( $.inArray(state, ['ready', 'error', 'missing']) !== -1
1447 && registry[module].state !== state ) {
1448 // Make sure pending modules depending on this one get executed if their
1449 // dependencies are now fulfilled!
1450 registry[module].state = state;
1451 handlePending( module );
1452 } else {
1453 registry[module].state = state;
1454 }
1455 },
1456
1457 /**
1458 * Gets the version of a module
1459 *
1460 * @param module string name of module to get version for
1461 */
1462 getVersion: function ( module ) {
1463 if ( registry[module] !== undefined && registry[module].version !== undefined ) {
1464 return formatVersionNumber( registry[module].version );
1465 }
1466 return null;
1467 },
1468
1469 /**
1470 * @deprecated since 1.18 use mw.loader.getVersion() instead
1471 */
1472 version: function () {
1473 return mw.loader.getVersion.apply( mw.loader, arguments );
1474 },
1475
1476 /**
1477 * Gets the state of a module
1478 *
1479 * @param module string name of module to get state for
1480 */
1481 getState: function ( module ) {
1482 if ( registry[module] !== undefined && registry[module].state !== undefined ) {
1483 return registry[module].state;
1484 }
1485 return null;
1486 },
1487
1488 /**
1489 * Get names of all registered modules.
1490 *
1491 * @return {Array}
1492 */
1493 getModuleNames: function () {
1494 return $.map( registry, function ( i, key ) {
1495 return key;
1496 } );
1497 },
1498
1499 /**
1500 * For backwards-compatibility with Squid-cached pages. Loads mw.user
1501 */
1502 go: function () {
1503 mw.loader.load( 'mediawiki.user' );
1504 }
1505 };
1506 }() ),
1507
1508 /** HTML construction helper functions */
1509 html: ( function () {
1510 function escapeCallback( s ) {
1511 switch ( s ) {
1512 case "'":
1513 return '&#039;';
1514 case '"':
1515 return '&quot;';
1516 case '<':
1517 return '&lt;';
1518 case '>':
1519 return '&gt;';
1520 case '&':
1521 return '&amp;';
1522 }
1523 }
1524
1525 return {
1526 /**
1527 * Escape a string for HTML. Converts special characters to HTML entities.
1528 * @param s The string to escape
1529 */
1530 escape: function ( s ) {
1531 return s.replace( /['"<>&]/g, escapeCallback );
1532 },
1533
1534 /**
1535 * Wrapper object for raw HTML passed to mw.html.element().
1536 * @constructor
1537 */
1538 Raw: function ( value ) {
1539 this.value = value;
1540 },
1541
1542 /**
1543 * Wrapper object for CDATA element contents passed to mw.html.element()
1544 * @constructor
1545 */
1546 Cdata: function ( value ) {
1547 this.value = value;
1548 },
1549
1550 /**
1551 * Create an HTML element string, with safe escaping.
1552 *
1553 * @param name The tag name.
1554 * @param attrs An object with members mapping element names to values
1555 * @param contents The contents of the element. May be either:
1556 * - string: The string is escaped.
1557 * - null or undefined: The short closing form is used, e.g. <br/>.
1558 * - this.Raw: The value attribute is included without escaping.
1559 * - this.Cdata: The value attribute is included, and an exception is
1560 * thrown if it contains an illegal ETAGO delimiter.
1561 * See http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.3.2
1562 *
1563 * Example:
1564 * var h = mw.html;
1565 * return h.element( 'div', {},
1566 * new h.Raw( h.element( 'img', {src: '<'} ) ) );
1567 * Returns <div><img src="&lt;"/></div>
1568 */
1569 element: function ( name, attrs, contents ) {
1570 var v, attrName, s = '<' + name;
1571
1572 for ( attrName in attrs ) {
1573 v = attrs[attrName];
1574 // Convert name=true, to name=name
1575 if ( v === true ) {
1576 v = attrName;
1577 // Skip name=false
1578 } else if ( v === false ) {
1579 continue;
1580 }
1581 s += ' ' + attrName + '="' + this.escape( String( v ) ) + '"';
1582 }
1583 if ( contents === undefined || contents === null ) {
1584 // Self close tag
1585 s += '/>';
1586 return s;
1587 }
1588 // Regular open tag
1589 s += '>';
1590 switch ( typeof contents ) {
1591 case 'string':
1592 // Escaped
1593 s += this.escape( contents );
1594 break;
1595 case 'number':
1596 case 'boolean':
1597 // Convert to string
1598 s += String( contents );
1599 break;
1600 default:
1601 if ( contents instanceof this.Raw ) {
1602 // Raw HTML inclusion
1603 s += contents.value;
1604 } else if ( contents instanceof this.Cdata ) {
1605 // CDATA
1606 if ( /<\/[a-zA-z]/.test( contents.value ) ) {
1607 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
1608 }
1609 s += contents.value;
1610 } else {
1611 throw new Error( 'mw.html.element: Invalid type of contents' );
1612 }
1613 }
1614 s += '</' + name + '>';
1615 return s;
1616 }
1617 };
1618 }() ),
1619
1620 // Skeleton user object. mediawiki.user.js extends this
1621 user: {
1622 options: new Map(),
1623 tokens: new Map()
1624 }
1625 };
1626
1627 }( jQuery ) );
1628
1629 // Alias $j to jQuery for backwards compatibility
1630 window.$j = jQuery;
1631
1632 // Attach to window and globally alias
1633 window.mw = window.mediaWiki = mw;
1634
1635 // Auto-register from pre-loaded startup scripts
1636 if ( jQuery.isFunction( window.startUp ) ) {
1637 window.startUp();
1638 window.startUp = undefined;
1639 }