Followup r108184: per CR, blocking loads in debug mode were broken because debug...
[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 compare( a, b ) {
394 var i;
395 if ( a.length !== b.length ) {
396 return false;
397 }
398 for ( i = 0; i < b.length; i += 1 ) {
399 if ( $.isArray( a[i] ) ) {
400 if ( !compare( a[i], b[i] ) ) {
401 return false;
402 }
403 }
404 if ( a[i] !== b[i] ) {
405 return false;
406 }
407 }
408 return true;
409 }
410
411 /**
412 * Generates an ISO8601 "basic" string from a UNIX timestamp
413 */
414 function formatVersionNumber( timestamp ) {
415 var pad = function ( a, b, c ) {
416 return [a < 10 ? '0' + a : a, b < 10 ? '0' + b : b, c < 10 ? '0' + c : c].join( '' );
417 },
418 d = new Date();
419 d.setTime( timestamp * 1000 );
420 return [
421 pad( d.getUTCFullYear(), d.getUTCMonth() + 1, d.getUTCDate() ), 'T',
422 pad( d.getUTCHours(), d.getUTCMinutes(), d.getUTCSeconds() ), 'Z'
423 ].join( '' );
424 }
425
426 /**
427 * Recursively resolves dependencies and detects circular references
428 */
429 function recurse( module, resolved, unresolved ) {
430 var n, deps, len;
431
432 if ( registry[module] === undefined ) {
433 throw new Error( 'Unknown dependency: ' + module );
434 }
435 // Resolves dynamic loader function and replaces it with its own results
436 if ( $.isFunction( registry[module].dependencies ) ) {
437 registry[module].dependencies = registry[module].dependencies();
438 // Ensures the module's dependencies are always in an array
439 if ( typeof registry[module].dependencies !== 'object' ) {
440 registry[module].dependencies = [registry[module].dependencies];
441 }
442 }
443 // Tracks down dependencies
444 deps = registry[module].dependencies;
445 len = deps.length;
446 for ( n = 0; n < len; n += 1 ) {
447 if ( $.inArray( deps[n], resolved ) === -1 ) {
448 if ( $.inArray( deps[n], unresolved ) !== -1 ) {
449 throw new Error(
450 'Circular reference detected: ' + module +
451 ' -> ' + deps[n]
452 );
453 }
454
455 // Add to unresolved
456 unresolved[unresolved.length] = module;
457 recurse( deps[n], resolved, unresolved );
458 // module is at the end of unresolved
459 unresolved.pop();
460 }
461 }
462 resolved[resolved.length] = module;
463 }
464
465 /**
466 * Gets a list of module names that a module depends on in their proper dependency order
467 *
468 * @param module string module name or array of string module names
469 * @return list of dependencies, including 'module'.
470 * @throws Error if circular reference is detected
471 */
472 function resolve( module ) {
473 var modules, m, deps, n, resolved;
474
475 // Allow calling with an array of module names
476 if ( $.isArray( module ) ) {
477 modules = [];
478 for ( m = 0; m < module.length; m += 1 ) {
479 deps = resolve( module[m] );
480 for ( n = 0; n < deps.length; n += 1 ) {
481 modules[modules.length] = deps[n];
482 }
483 }
484 return modules;
485 } else if ( typeof module === 'string' ) {
486 resolved = [];
487 recurse( module, resolved, [] );
488 return resolved;
489 }
490 throw new Error( 'Invalid module argument: ' + module );
491 }
492
493 /**
494 * Narrows a list of module names down to those matching a specific
495 * state (see comment on top of this scope for a list of valid states).
496 * One can also filter for 'unregistered', which will return the
497 * modules names that don't have a registry entry.
498 *
499 * @param states string or array of strings of module states to filter by
500 * @param modules array list of module names to filter (optional, by default the entire
501 * registry is used)
502 * @return array list of filtered module names
503 */
504 function filter( states, modules ) {
505 var list, module, s, m;
506
507 // Allow states to be given as a string
508 if ( typeof states === 'string' ) {
509 states = [states];
510 }
511 // If called without a list of modules, build and use a list of all modules
512 list = [];
513 if ( modules === undefined ) {
514 modules = [];
515 for ( module in registry ) {
516 modules[modules.length] = module;
517 }
518 }
519 // Build a list of modules which are in one of the specified states
520 for ( s = 0; s < states.length; s += 1 ) {
521 for ( m = 0; m < modules.length; m += 1 ) {
522 if ( registry[modules[m]] === undefined ) {
523 // Module does not exist
524 if ( states[s] === 'unregistered' ) {
525 // OK, undefined
526 list[list.length] = modules[m];
527 }
528 } else {
529 // Module exists, check state
530 if ( registry[modules[m]].state === states[s] ) {
531 // OK, correct state
532 list[list.length] = modules[m];
533 }
534 }
535 }
536 }
537 return list;
538 }
539
540 /**
541 * Automatically executes jobs and modules which are pending with satistifed dependencies.
542 *
543 * This is used when dependencies are satisfied, such as when a module is executed.
544 */
545 function handlePending( module ) {
546 var j, r;
547
548 try {
549 // Run jobs whose dependencies have just been met
550 for ( j = 0; j < jobs.length; j += 1 ) {
551 if ( compare(
552 filter( 'ready', jobs[j].dependencies ),
553 jobs[j].dependencies ) )
554 {
555 if ( $.isFunction( jobs[j].ready ) ) {
556 jobs[j].ready();
557 }
558 jobs.splice( j, 1 );
559 j -= 1;
560 }
561 }
562 // Execute modules whose dependencies have just been met
563 for ( r in registry ) {
564 if ( registry[r].state === 'loaded' ) {
565 if ( compare(
566 filter( ['ready'], registry[r].dependencies ),
567 registry[r].dependencies ) )
568 {
569 execute( r );
570 }
571 }
572 }
573 } catch ( e ) {
574 // Run error callbacks of jobs affected by this condition
575 for ( j = 0; j < jobs.length; j += 1 ) {
576 if ( $.inArray( module, jobs[j].dependencies ) !== -1 ) {
577 if ( $.isFunction( jobs[j].error ) ) {
578 jobs[j].error( e, module );
579 }
580 jobs.splice( j, 1 );
581 j -= 1;
582 }
583 }
584 }
585 }
586
587 /**
588 * Adds a script tag to the DOM, either using document.write or low-level DOM manipulation,
589 * depending on whether document-ready has occured yet and whether we are in blocking mode.
590 *
591 * @param src String: URL to script, will be used as the src attribute in the script tag
592 * @param callback Function: Optional callback which will be run when the script is done
593 */
594 function addScript( src, callback, blocking ) {
595 var done = false, script, head;
596 if ( ready || !blocking ) {
597 // jQuery's getScript method is NOT better than doing this the old-fashioned way
598 // because jQuery will eval the script's code, and errors will not have sane
599 // line numbers.
600 script = document.createElement( 'script' );
601 script.setAttribute( 'src', src );
602 script.setAttribute( 'type', 'text/javascript' );
603 if ( $.isFunction( callback ) ) {
604 // Attach handlers for all browsers (based on jQuery.ajax)
605 script.onload = script.onreadystatechange = function() {
606
607 if (
608 !done
609 && (
610 !script.readyState
611 || /loaded|complete/.test( script.readyState )
612 )
613 ) {
614
615 done = true;
616
617 // Handle memory leak in IE
618 script.onload = script.onreadystatechange = null;
619
620 callback();
621
622 if ( script.parentNode ) {
623 script.parentNode.removeChild( script );
624 }
625
626 // Dereference the script
627 script = undefined;
628 }
629 };
630 }
631
632 if ( window.opera ) {
633 // Appending to the <head> blocks rendering completely in Opera,
634 // so append to the <body> after document ready. This means the
635 // scripts only start loading after the document has been rendered,
636 // but so be it. Opera users don't deserve faster web pages if their
637 // browser makes it impossible
638 $( function() { document.body.appendChild( script ); } );
639 } else {
640 // IE-safe way of getting the <head> . document.documentElement.head doesn't
641 // work in scripts that run in the <head>
642 head = document.getElementsByTagName( 'head' )[0];
643 ( document.body || head ).appendChild( script );
644 }
645 } else {
646 document.write( mw.html.element(
647 'script', { 'type': 'text/javascript', 'src': src }, ''
648 ) );
649 if ( $.isFunction( callback ) ) {
650 // Document.write is synchronous, so this is called when it's done
651 // FIXME: that's a lie. doc.write isn't actually synchronous
652 callback();
653 }
654 }
655 }
656
657 /**
658 * Executes a loaded module, making it ready to use
659 *
660 * @param module string module name to execute
661 */
662 function execute( module, callback ) {
663 var style, media, i, script, markModuleReady, nestedAddScript;
664
665 if ( registry[module] === undefined ) {
666 throw new Error( 'Module has not been registered yet: ' + module );
667 } else if ( registry[module].state === 'registered' ) {
668 throw new Error( 'Module has not been requested from the server yet: ' + module );
669 } else if ( registry[module].state === 'loading' ) {
670 throw new Error( 'Module has not completed loading yet: ' + module );
671 } else if ( registry[module].state === 'ready' ) {
672 throw new Error( 'Module has already been loaded: ' + module );
673 }
674
675 // Add styles
676 if ( $.isPlainObject( registry[module].style ) ) {
677 for ( media in registry[module].style ) {
678 style = registry[module].style[media];
679 if ( $.isArray( style ) ) {
680 for ( i = 0; i < style.length; i += 1 ) {
681 getMarker().before( mw.html.element( 'link', {
682 'type': 'text/css',
683 'media': media,
684 'rel': 'stylesheet',
685 'href': style[i]
686 } ) );
687 }
688 } else if ( typeof style === 'string' ) {
689 getMarker().before( mw.html.element( 'style', {
690 'type': 'text/css',
691 'media': media
692 }, new mw.html.Cdata( style ) ) );
693 }
694 }
695 }
696 // Add localizations to message system
697 if ( $.isPlainObject( registry[module].messages ) ) {
698 mw.messages.set( registry[module].messages );
699 }
700 // Execute script
701 try {
702 script = registry[module].script;
703 markModuleReady = function() {
704 registry[module].state = 'ready';
705 handlePending( module );
706 if ( $.isFunction( callback ) ) {
707 callback();
708 }
709 };
710 nestedAddScript = function ( arr, callback, blocking, i ) {
711 // Recursively call addScript() in its own callback
712 // for each element of arr.
713 if ( i >= arr.length ) {
714 // We're at the end of the array
715 callback();
716 return;
717 }
718
719 addScript( arr[i], function() {
720 nestedAddScript( arr, callback, blocking, i + 1 );
721 }, blocking );
722 };
723
724 if ( $.isArray( script ) ) {
725 registry[module].state = 'loading';
726 nestedAddScript( script, markModuleReady, registry[module].blocking, 0 );
727 } else if ( $.isFunction( script ) ) {
728 script( $ );
729 markModuleReady();
730 }
731 } catch ( e ) {
732 // This needs to NOT use mw.log because these errors are common in production mode
733 // and not in debug mode, such as when a symbol that should be global isn't exported
734 if ( window.console && typeof window.console.log === 'function' ) {
735 console.log( 'mw.loader::execute> Exception thrown by ' + module + ': ' + e.message );
736 }
737 registry[module].state = 'error';
738 throw e;
739 }
740 }
741
742 /**
743 * Adds a dependencies to the queue with optional callbacks to be run
744 * when the dependencies are ready or fail
745 *
746 * @param dependencies string module name or array of string module names
747 * @param ready function callback to execute when all dependencies are ready
748 * @param error function callback to execute when any dependency fails
749 * @param blocking (optional) If true, load modules in a blocking fashion if
750 * document ready has not yet occurred
751 */
752 function request( dependencies, ready, error, blocking ) {
753 var regItemDeps, regItemDepLen, n;
754
755 // Allow calling by single module name
756 if ( typeof dependencies === 'string' ) {
757 dependencies = [dependencies];
758 if ( registry[dependencies[0]] !== undefined ) {
759 // Cache repetitively accessed deep level object member
760 regItemDeps = registry[dependencies[0]].dependencies;
761 // Cache to avoid looped access to length property
762 regItemDepLen = regItemDeps.length;
763 for ( n = 0; n < regItemDepLen; n += 1 ) {
764 dependencies[dependencies.length] = regItemDeps[n];
765 }
766 }
767 }
768 // Add ready and error callbacks if they were given
769 if ( arguments.length > 1 ) {
770 jobs[jobs.length] = {
771 'dependencies': filter(
772 ['registered', 'loading', 'loaded'],
773 dependencies
774 ),
775 'ready': ready,
776 'error': error
777 };
778 }
779 // Queue up any dependencies that are registered
780 dependencies = filter( ['registered'], dependencies );
781 for ( n = 0; n < dependencies.length; n += 1 ) {
782 if ( $.inArray( dependencies[n], queue ) === -1 ) {
783 queue[queue.length] = dependencies[n];
784 if ( blocking ) {
785 // Mark this module as blocking in the registry
786 registry[dependencies[n]].blocking = true;
787 }
788 }
789 }
790 // Work the queue
791 mw.loader.work();
792 }
793
794 function sortQuery(o) {
795 var sorted = {}, key, a = [];
796 for ( key in o ) {
797 if ( hasOwn.call( o, key ) ) {
798 a.push( key );
799 }
800 }
801 a.sort();
802 for ( key = 0; key < a.length; key += 1 ) {
803 sorted[a[key]] = o[a[key]];
804 }
805 return sorted;
806 }
807
808 /**
809 * Converts a module map of the form { foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }
810 * to a query string of the form foo.bar,baz|bar.baz,quux
811 */
812 function buildModulesString( moduleMap ) {
813 var arr = [], p, prefix;
814 for ( prefix in moduleMap ) {
815 p = prefix === '' ? '' : prefix + '.';
816 arr.push( p + moduleMap[prefix].join( ',' ) );
817 }
818 return arr.join( '|' );
819 }
820
821 /**
822 * Asynchronously append a script tag to the end of the body
823 * that invokes load.php
824 * @param moduleMap {Object}: Module map, see buildModulesString()
825 * @param currReqBase {Object}: Object with other parameters (other than 'modules') to use in the request
826 * @param sourceLoadScript {String}: URL of load.php
827 * @param blocking {Boolean}: If true, use a blocking request if document ready has not yet occurred
828 */
829 function doRequest( moduleMap, currReqBase, sourceLoadScript, blocking ) {
830 var request = $.extend(
831 { 'modules': buildModulesString( moduleMap ) },
832 currReqBase
833 );
834 request = sortQuery( request );
835 // Asynchronously append a script tag to the end of the body
836 // Append &* to avoid triggering the IE6 extension check
837 addScript( sourceLoadScript + '?' + $.param( request ) + '&*', null, blocking );
838 }
839
840 /* Public Methods */
841 return {
842 /**
843 * Requests dependencies from server, loading and executing when things when ready.
844 */
845 work: function () {
846 var reqBase, splits, maxQueryLength, q, b, bSource, bGroup, bSourceGroup,
847 source, group, g, i, modules, maxVersion, sourceLoadScript,
848 currReqBase, currReqBaseLength, moduleMap, l,
849 lastDotIndex, prefix, suffix, bytesAdded, blocking;
850
851 // Build a list of request parameters common to all requests.
852 reqBase = {
853 skin: mw.config.get( 'skin' ),
854 lang: mw.config.get( 'wgUserLanguage' ),
855 debug: mw.config.get( 'debug' )
856 };
857 // Split module batch by source and by group.
858 splits = {};
859 maxQueryLength = mw.config.get( 'wgResourceLoaderMaxQueryLength', -1 );
860
861 // Appends a list of modules from the queue to the batch
862 for ( q = 0; q < queue.length; q += 1 ) {
863 // Only request modules which are registered
864 if ( registry[queue[q]] !== undefined && registry[queue[q]].state === 'registered' ) {
865 // Prevent duplicate entries
866 if ( $.inArray( queue[q], batch ) === -1 ) {
867 batch[batch.length] = queue[q];
868 // Mark registered modules as loading
869 registry[queue[q]].state = 'loading';
870 }
871 }
872 }
873 // Early exit if there's nothing to load...
874 if ( !batch.length ) {
875 return;
876 }
877
878 // The queue has been processed into the batch, clear up the queue.
879 queue = [];
880
881 // Always order modules alphabetically to help reduce cache
882 // misses for otherwise identical content.
883 batch.sort();
884
885 // Split batch by source and by group.
886 for ( b = 0; b < batch.length; b += 1 ) {
887 bSource = registry[batch[b]].source;
888 bGroup = registry[batch[b]].group;
889 if ( splits[bSource] === undefined ) {
890 splits[bSource] = {};
891 }
892 if ( splits[bSource][bGroup] === undefined ) {
893 splits[bSource][bGroup] = [];
894 }
895 bSourceGroup = splits[bSource][bGroup];
896 bSourceGroup[bSourceGroup.length] = batch[b];
897 }
898
899 // Clear the batch - this MUST happen before we append any
900 // script elements to the body or it's possible that a script
901 // will be locally cached, instantly load, and work the batch
902 // again, all before we've cleared it causing each request to
903 // include modules which are already loaded.
904 batch = [];
905
906 for ( source in splits ) {
907
908 sourceLoadScript = sources[source].loadScript;
909
910 for ( group in splits[source] ) {
911
912 // Cache access to currently selected list of
913 // modules for this group from this source.
914 modules = splits[source][group];
915
916 // Calculate the highest timestamp
917 maxVersion = 0;
918 for ( g = 0; g < modules.length; g += 1 ) {
919 if ( registry[modules[g]].version > maxVersion ) {
920 maxVersion = registry[modules[g]].version;
921 }
922 }
923
924 currReqBase = $.extend( { 'version': formatVersionNumber( maxVersion ) }, reqBase );
925 currReqBaseLength = $.param( currReqBase ).length;
926 blocking = false;
927 // We may need to split up the request to honor the query string length limit,
928 // so build it piece by piece.
929 l = currReqBaseLength + 9; // '&modules='.length == 9
930
931 moduleMap = {}; // { prefix: [ suffixes ] }
932
933 for ( i = 0; i < modules.length; i += 1 ) {
934 // Determine how many bytes this module would add to the query string
935 lastDotIndex = modules[i].lastIndexOf( '.' );
936 // Note that these substr() calls work even if lastDotIndex == -1
937 prefix = modules[i].substr( 0, lastDotIndex );
938 suffix = modules[i].substr( lastDotIndex + 1 );
939 bytesAdded = moduleMap[prefix] !== undefined
940 ? suffix.length + 3 // '%2C'.length == 3
941 : modules[i].length + 3; // '%7C'.length == 3
942
943 // If the request would become too long, create a new one,
944 // but don't create empty requests
945 if ( maxQueryLength > 0 && !$.isEmptyObject( moduleMap ) && l + bytesAdded > maxQueryLength ) {
946 // This request would become too long, create a new one
947 // and fire off the old one
948 doRequest( moduleMap, currReqBase, sourceLoadScript, blocking );
949 moduleMap = {};
950 blocking = false;
951 l = currReqBaseLength + 9;
952 }
953 if ( moduleMap[prefix] === undefined ) {
954 moduleMap[prefix] = [];
955 }
956 moduleMap[prefix].push( suffix );
957 if ( registry[modules[i]].blocking ) {
958 // If this module is blocking, make the entire request blocking
959 // This is slightly suboptimal, but in practice mixing of blocking
960 // and non-blocking modules will only occur in debug mode.
961 blocking = true;
962 }
963 l += bytesAdded;
964 }
965 // If there's anything left in moduleMap, request that too
966 if ( !$.isEmptyObject( moduleMap ) ) {
967 doRequest( moduleMap, currReqBase, sourceLoadScript, blocking );
968 }
969 }
970 }
971 },
972
973 /**
974 * Register a source.
975 *
976 * @param id {String}: Short lowercase a-Z string representing a source, only used internally.
977 * @param props {Object}: Object containing only the loadScript property which is a url to
978 * the load.php location of the source.
979 * @return {Boolean}
980 */
981 addSource: function ( id, props ) {
982 var source;
983 // Allow multiple additions
984 if ( typeof id === 'object' ) {
985 for ( source in id ) {
986 mw.loader.addSource( source, id[source] );
987 }
988 return true;
989 }
990
991 if ( sources[id] !== undefined ) {
992 throw new Error( 'source already registered: ' + id );
993 }
994
995 sources[id] = props;
996
997 return true;
998 },
999
1000 /**
1001 * Registers a module, letting the system know about it and its
1002 * properties. Startup modules contain calls to this function.
1003 *
1004 * @param module {String}: Module name
1005 * @param version {Number}: Module version number as a timestamp (falls backs to 0)
1006 * @param dependencies {String|Array|Function}: One string or array of strings of module
1007 * names on which this module depends, or a function that returns that array.
1008 * @param group {String}: Group which the module is in (optional, defaults to null)
1009 * @param source {String}: Name of the source. Defaults to local.
1010 */
1011 register: function ( module, version, dependencies, group, source ) {
1012 var m;
1013 // Allow multiple registration
1014 if ( typeof module === 'object' ) {
1015 for ( m = 0; m < module.length; m += 1 ) {
1016 // module is an array of module names
1017 if ( typeof module[m] === 'string' ) {
1018 mw.loader.register( module[m] );
1019 // module is an array of arrays
1020 } else if ( typeof module[m] === 'object' ) {
1021 mw.loader.register.apply( mw.loader, module[m] );
1022 }
1023 }
1024 return;
1025 }
1026 // Validate input
1027 if ( typeof module !== 'string' ) {
1028 throw new Error( 'module must be a string, not a ' + typeof module );
1029 }
1030 if ( registry[module] !== undefined ) {
1031 throw new Error( 'module already registered: ' + module );
1032 }
1033 // List the module as registered
1034 registry[module] = {
1035 'version': version !== undefined ? parseInt( version, 10 ) : 0,
1036 'dependencies': [],
1037 'group': typeof group === 'string' ? group : null,
1038 'source': typeof source === 'string' ? source: 'local',
1039 'state': 'registered'
1040 };
1041 if ( typeof dependencies === 'string' ) {
1042 // Allow dependencies to be given as a single module name
1043 registry[module].dependencies = [dependencies];
1044 } else if ( typeof dependencies === 'object' || $.isFunction( dependencies ) ) {
1045 // Allow dependencies to be given as an array of module names
1046 // or a function which returns an array
1047 registry[module].dependencies = dependencies;
1048 }
1049 },
1050
1051 /**
1052 * Implements a module, giving the system a course of action to take
1053 * upon loading. Results of a request for one or more modules contain
1054 * calls to this function.
1055 *
1056 * All arguments are required.
1057 *
1058 * @param module String: Name of module
1059 * @param script Mixed: Function of module code or String of URL to be used as the src
1060 * attribute when adding a script element to the body
1061 * @param style Object: Object of CSS strings keyed by media-type or Object of lists of URLs
1062 * keyed by media-type
1063 * @param msgs Object: List of key/value pairs to be passed through mw.messages.set
1064 */
1065 implement: function ( module, script, style, msgs ) {
1066 // Validate input
1067 if ( typeof module !== 'string' ) {
1068 throw new Error( 'module must be a string, not a ' + typeof module );
1069 }
1070 if ( !$.isFunction( script ) && !$.isArray( script ) ) {
1071 throw new Error( 'script must be a function or an array, not a ' + typeof script );
1072 }
1073 if ( !$.isPlainObject( style ) ) {
1074 throw new Error( 'style must be an object, not a ' + typeof style );
1075 }
1076 if ( !$.isPlainObject( msgs ) ) {
1077 throw new Error( 'msgs must be an object, not a ' + typeof msgs );
1078 }
1079 // Automatically register module
1080 if ( registry[module] === undefined ) {
1081 mw.loader.register( module );
1082 }
1083 // Check for duplicate implementation
1084 if ( registry[module] !== undefined && registry[module].script !== undefined ) {
1085 throw new Error( 'module already implemented: ' + module );
1086 }
1087 // Mark module as loaded
1088 registry[module].state = 'loaded';
1089 // Attach components
1090 registry[module].script = script;
1091 registry[module].style = style;
1092 registry[module].messages = msgs;
1093 // Execute or queue callback
1094 if ( compare(
1095 filter( ['ready'], registry[module].dependencies ),
1096 registry[module].dependencies ) )
1097 {
1098 execute( module );
1099 }
1100 },
1101
1102 /**
1103 * Executes a function as soon as one or more required modules are ready
1104 *
1105 * @param dependencies {String|Array} Module name or array of modules names the callback
1106 * dependends on to be ready before executing
1107 * @param ready {Function} callback to execute when all dependencies are ready (optional)
1108 * @param error {Function} callback to execute when if dependencies have a errors (optional)
1109 */
1110 using: function ( dependencies, ready, error ) {
1111 var tod = typeof dependencies;
1112 // Validate input
1113 if ( tod !== 'object' && tod !== 'string' ) {
1114 throw new Error( 'dependencies must be a string or an array, not a ' + tod );
1115 }
1116 // Allow calling with a single dependency as a string
1117 if ( tod === 'string' ) {
1118 dependencies = [dependencies];
1119 }
1120 // Resolve entire dependency map
1121 dependencies = resolve( dependencies );
1122 // If all dependencies are met, execute ready immediately
1123 if ( compare( filter( ['ready'], dependencies ), dependencies ) ) {
1124 if ( $.isFunction( ready ) ) {
1125 ready();
1126 }
1127 }
1128 // If any dependencies have errors execute error immediately
1129 else if ( filter( ['error'], dependencies ).length ) {
1130 if ( $.isFunction( error ) ) {
1131 error( new Error( 'one or more dependencies have state "error"' ),
1132 dependencies );
1133 }
1134 }
1135 // Since some dependencies are not yet ready, queue up a request
1136 else {
1137 request( dependencies, ready, error );
1138 }
1139 },
1140
1141 /**
1142 * Loads an external script or one or more modules for future use
1143 *
1144 * @param modules {mixed} Either the name of a module, array of modules,
1145 * or a URL of an external script or style
1146 * @param type {String} mime-type to use if calling with a URL of an
1147 * external script or style; acceptable values are "text/css" and
1148 * "text/javascript"; if no type is provided, text/javascript is assumed.
1149 * @param blocking {Boolean} (optional) If true, load modules in a blocking
1150 * fashion if document ready has not yet occurred
1151 */
1152 load: function ( modules, type, blocking ) {
1153 var filtered, m;
1154
1155 // Validate input
1156 if ( typeof modules !== 'object' && typeof modules !== 'string' ) {
1157 throw new Error( 'modules must be a string or an array, not a ' + typeof modules );
1158 }
1159 // Allow calling with an external url or single dependency as a string
1160 if ( typeof modules === 'string' ) {
1161 // Support adding arbitrary external scripts
1162 if ( /^(https?:)?\/\//.test( modules ) ) {
1163 if ( type === 'text/css' ) {
1164 $( 'head' ).append( $( '<link>', {
1165 rel: 'stylesheet',
1166 type: 'text/css',
1167 href: modules
1168 } ) );
1169 return;
1170 } else if ( type === 'text/javascript' || type === undefined ) {
1171 addScript( modules, null, blocking );
1172 return;
1173 }
1174 // Unknown type
1175 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type );
1176 }
1177 // Called with single module
1178 modules = [modules];
1179 }
1180
1181 // Filter out undefined modules, otherwise resolve() will throw
1182 // an exception for trying to load an undefined module.
1183 // Undefined modules are acceptable here in load(), because load() takes
1184 // an array of unrelated modules, whereas the modules passed to
1185 // using() are related and must all be loaded.
1186 for ( filtered = [], m = 0; m < modules.length; m += 1 ) {
1187 if ( registry[modules[m]] !== undefined ) {
1188 filtered[filtered.length] = modules[m];
1189 }
1190 }
1191
1192 // Resolve entire dependency map
1193 filtered = resolve( filtered );
1194 // If all modules are ready, nothing dependency be done
1195 if ( compare( filter( ['ready'], filtered ), filtered ) ) {
1196 return;
1197 }
1198 // If any modules have errors
1199 else if ( filter( ['error'], filtered ).length ) {
1200 return;
1201 }
1202 // Since some modules are not yet ready, queue up a request
1203 else {
1204 request( filtered, null, null, blocking );
1205 return;
1206 }
1207 },
1208
1209 /**
1210 * Changes the state of a module
1211 *
1212 * @param module {String|Object} module name or object of module name/state pairs
1213 * @param state {String} state name
1214 */
1215 state: function ( module, state ) {
1216 var m;
1217 if ( typeof module === 'object' ) {
1218 for ( m in module ) {
1219 mw.loader.state( m, module[m] );
1220 }
1221 return;
1222 }
1223 if ( registry[module] === undefined ) {
1224 mw.loader.register( module );
1225 }
1226 registry[module].state = state;
1227 },
1228
1229 /**
1230 * Gets the version of a module
1231 *
1232 * @param module string name of module to get version for
1233 */
1234 getVersion: function ( module ) {
1235 if ( registry[module] !== undefined && registry[module].version !== undefined ) {
1236 return formatVersionNumber( registry[module].version );
1237 }
1238 return null;
1239 },
1240
1241 /**
1242 * @deprecated since 1.18 use mw.loader.getVersion() instead
1243 */
1244 version: function () {
1245 return mw.loader.getVersion.apply( mw.loader, arguments );
1246 },
1247
1248 /**
1249 * Gets the state of a module
1250 *
1251 * @param module string name of module to get state for
1252 */
1253 getState: function ( module ) {
1254 if ( registry[module] !== undefined && registry[module].state !== undefined ) {
1255 return registry[module].state;
1256 }
1257 return null;
1258 },
1259
1260 /**
1261 * Get names of all registered modules.
1262 *
1263 * @return {Array}
1264 */
1265 getModuleNames: function () {
1266 return $.map( registry, function ( i, key ) {
1267 return key;
1268 } );
1269 },
1270
1271 /**
1272 * For backwards-compatibility with Squid-cached pages. Loads mw.user
1273 */
1274 go: function () {
1275 mw.loader.load( 'mediawiki.user' );
1276 }
1277 };
1278 }() ),
1279
1280 /** HTML construction helper functions */
1281 html: ( function () {
1282 function escapeCallback( s ) {
1283 switch ( s ) {
1284 case "'":
1285 return '&#039;';
1286 case '"':
1287 return '&quot;';
1288 case '<':
1289 return '&lt;';
1290 case '>':
1291 return '&gt;';
1292 case '&':
1293 return '&amp;';
1294 }
1295 }
1296
1297 return {
1298 /**
1299 * Escape a string for HTML. Converts special characters to HTML entities.
1300 * @param s The string to escape
1301 */
1302 escape: function ( s ) {
1303 return s.replace( /['"<>&]/g, escapeCallback );
1304 },
1305
1306 /**
1307 * Wrapper object for raw HTML passed to mw.html.element().
1308 * @constructor
1309 */
1310 Raw: function ( value ) {
1311 this.value = value;
1312 },
1313
1314 /**
1315 * Wrapper object for CDATA element contents passed to mw.html.element()
1316 * @constructor
1317 */
1318 Cdata: function ( value ) {
1319 this.value = value;
1320 },
1321
1322 /**
1323 * Create an HTML element string, with safe escaping.
1324 *
1325 * @param name The tag name.
1326 * @param attrs An object with members mapping element names to values
1327 * @param contents The contents of the element. May be either:
1328 * - string: The string is escaped.
1329 * - null or undefined: The short closing form is used, e.g. <br/>.
1330 * - this.Raw: The value attribute is included without escaping.
1331 * - this.Cdata: The value attribute is included, and an exception is
1332 * thrown if it contains an illegal ETAGO delimiter.
1333 * See http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.3.2
1334 *
1335 * Example:
1336 * var h = mw.html;
1337 * return h.element( 'div', {},
1338 * new h.Raw( h.element( 'img', {src: '<'} ) ) );
1339 * Returns <div><img src="&lt;"/></div>
1340 */
1341 element: function ( name, attrs, contents ) {
1342 var v, attrName, s = '<' + name;
1343
1344 for ( attrName in attrs ) {
1345 v = attrs[attrName];
1346 // Convert name=true, to name=name
1347 if ( v === true ) {
1348 v = attrName;
1349 // Skip name=false
1350 } else if ( v === false ) {
1351 continue;
1352 }
1353 s += ' ' + attrName + '="' + this.escape( String( v ) ) + '"';
1354 }
1355 if ( contents === undefined || contents === null ) {
1356 // Self close tag
1357 s += '/>';
1358 return s;
1359 }
1360 // Regular open tag
1361 s += '>';
1362 switch ( typeof contents ) {
1363 case 'string':
1364 // Escaped
1365 s += this.escape( contents );
1366 break;
1367 case 'number':
1368 case 'boolean':
1369 // Convert to string
1370 s += String( contents );
1371 break;
1372 default:
1373 if ( contents instanceof this.Raw ) {
1374 // Raw HTML inclusion
1375 s += contents.value;
1376 } else if ( contents instanceof this.Cdata ) {
1377 // CDATA
1378 if ( /<\/[a-zA-z]/.test( contents.value ) ) {
1379 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
1380 }
1381 s += contents.value;
1382 } else {
1383 throw new Error( 'mw.html.element: Invalid type of contents' );
1384 }
1385 }
1386 s += '</' + name + '>';
1387 return s;
1388 }
1389 };
1390 })()
1391 };
1392
1393 })( jQuery );
1394
1395 // Alias $j to jQuery for backwards compatibility
1396 window.$j = jQuery;
1397
1398 // Attach to window and globally alias
1399 window.mw = window.mediaWiki = mw;
1400
1401 // Auto-register from pre-loaded startup scripts
1402 if ( typeof startUp !== 'undefined' && jQuery.isFunction( startUp ) ) {
1403 startUp();
1404 startUp = undefined;
1405 }