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