Minor mw.loader fixes
[lhc/web/wiklou.git] / resources / mediawiki / mediawiki.js
1 /*
2 * Core MediaWiki JavaScript Library
3 */
4
5 // Attach to window and globally alias
6 window.mw = window.mediaWiki = new ( function( $ ) {
7
8 /* Private Members */
9
10 /**
11 * @var object List of messages that have been requested to be loaded.
12 */
13 var messageQueue = {};
14
15 /* Object constructors */
16
17 /**
18 * Map
19 *
20 * Creates an object that can be read from or written to from prototype functions
21 * that allow both single and multiple variables at once.
22 *
23 * @param global boolean Whether to store the values in the global window
24 * object or a exclusively in the object property 'values'.
25 * @return Map
26 */
27 function Map( global ) {
28 this.values = ( global === true ) ? window : {};
29 return this;
30 }
31
32 /**
33 * Get the value of one or multiple a keys.
34 *
35 * If called with no arguments, all values will be returned.
36 *
37 * @param selection mixed String key or array of keys to get values for.
38 * @param fallback mixed Value to use in case key(s) do not exist (optional).
39 * @return mixed If selection was a string returns the value or null,
40 * If selection was an array, returns an object of key/values (value is null if not found),
41 * If selection was not passed or invalid, will return the 'values' object member (be careful as
42 * objects are always passed by reference in JavaScript!).
43 * @return Values as a string or object, null if invalid/inexistant.
44 */
45 Map.prototype.get = function( selection, fallback ) {
46 if ( $.isArray( selection ) ) {
47 selection = $.makeArray( selection );
48 var results = {};
49 for ( var i = 0; i < selection.length; i++ ) {
50 results[selection[i]] = this.get( selection[i], fallback );
51 }
52 return results;
53 } else if ( typeof selection === 'string' ) {
54 if ( this.values[selection] === undefined ) {
55 if ( fallback !== undefined ) {
56 return fallback;
57 }
58 return null;
59 }
60 return this.values[selection];
61 }
62 if ( selection === undefined ) {
63 return this.values;
64 } else {
65 return null; // invalid selection key
66 }
67 };
68
69 /**
70 * Sets one or multiple key/value pairs.
71 *
72 * @param selection mixed String key or array of keys to set values for.
73 * @param value mixed Value to set (optional, only in use when key is a string)
74 * @return bool This returns true on success, false on failure.
75 */
76 Map.prototype.set = function( selection, value ) {
77 if ( $.isPlainObject( selection ) ) {
78 for ( var s in selection ) {
79 this.values[s] = selection[s];
80 }
81 return true;
82 } else if ( typeof selection === 'string' && value !== undefined ) {
83 this.values[selection] = value;
84 return true;
85 }
86 return false;
87 };
88
89 /**
90 * Checks if one or multiple keys exist.
91 *
92 * @param selection mixed String key or array of keys to check
93 * @return boolean Existence of key(s)
94 */
95 Map.prototype.exists = function( selection ) {
96 if ( typeof selection === 'object' ) {
97 for ( var s = 0; s < selection.length; s++ ) {
98 if ( !( selection[s] in this.values ) ) {
99 return false;
100 }
101 }
102 return true;
103 } else {
104 return selection in this.values;
105 }
106 };
107
108 /**
109 * Message
110 *
111 * Object constructor for messages,
112 * similar to the Message class in MediaWiki PHP.
113 *
114 * @param map Map Instance of mw.Map
115 * @param key String
116 * @param parameters Array
117 * @return Message
118 */
119 function Message( map, key, parameters ) {
120 this.format = 'parse';
121 this.map = map;
122 this.key = key;
123 this.parameters = parameters === undefined ? [] : $.makeArray( parameters );
124 return this;
125 }
126
127 /**
128 * Appends (does not replace) parameters for replacement to the .parameters property.
129 *
130 * @param parameters Array
131 * @return Message
132 */
133 Message.prototype.params = function( parameters ) {
134 for ( var i = 0; i < parameters.length; i++ ) {
135 this.parameters.push( parameters[i] );
136 }
137 return this;
138 };
139
140 /**
141 * Converts message object to it's string form based on the state of format.
142 *
143 * @return string Message as a string in the current form or <key> if key does not exist.
144 */
145 Message.prototype.toString = function() {
146 if ( !this.map.exists( this.key ) ) {
147 // Return <key> if key does not exist
148 return '<' + this.key + '>';
149 }
150 var text = this.map.get( this.key );
151 parameters = this.parameters;
152
153 text = text.replace( /\$(\d+)/g, function( string, match ) {
154 var index = parseInt( match, 10 ) - 1;
155 return index in parameters ? parameters[index] : '$' + match;
156 } );
157
158 if ( this.format === 'plain' ) {
159 return text;
160 }
161 if ( this.format === 'escaped' ) {
162 // According to Message.php this needs {{-transformation, which is
163 // still todo
164 return mw.html.escape( text );
165 }
166
167 /* This should be fixed up when we have a parser
168 if ( this.format === 'parse' && 'language' in mw ) {
169 text = mw.language.parse( text );
170 }
171 */
172 return text;
173 };
174
175 /**
176 * Changes format to parse and converts message to string
177 *
178 * @return {string} String form of parsed message
179 */
180 Message.prototype.parse = function() {
181 this.format = 'parse';
182 return this.toString();
183 };
184
185 /**
186 * Changes format to plain and converts message to string
187 *
188 * @return {string} String form of plain message
189 */
190 Message.prototype.plain = function() {
191 this.format = 'plain';
192 return this.toString();
193 };
194
195 /**
196 * Changes the format to html escaped and converts message to string
197 *
198 * @return {string} String form of html escaped message
199 */
200 Message.prototype.escaped = function() {
201 this.format = 'escaped';
202 return this.toString();
203 };
204
205 /**
206 * Checks if message exists
207 *
208 * @return {string} String form of parsed message
209 */
210 Message.prototype.exists = function() {
211 return this.map.exists( this.key );
212 };
213
214 /* Public Members */
215
216 /*
217 * Dummy function which in debug mode can be replaced with a function that
218 * emulates console.log in console-less environments.
219 */
220 this.log = function() { };
221
222 /**
223 * @var constructor Make the Map constructor publicly available.
224 */
225 this.Map = Map;
226
227 /**
228 * List of configuration values
229 *
230 * Dummy placeholder. Initiated in startUp module as a new instance of mw.Map().
231 * If $wgLegacyJavaScriptGlobals is true, this Map will have its values
232 * in the global window object.
233 */
234 this.config = null;
235
236 /**
237 * @var object
238 *
239 * Empty object that plugins can be installed in.
240 */
241 this.libs = {};
242
243 /*
244 * Localization system
245 */
246 this.messages = new this.Map();
247
248 /* Public Methods */
249
250 /**
251 * Gets a message object, similar to wfMessage()
252 *
253 * @param key string Key of message to get
254 * @param parameter_1 mixed First argument in a list of variadic arguments,
255 * each a parameter for $N replacement in messages.
256 * @return Message
257 */
258 this.message = function( key, parameter_1 /* [, parameter_2] */ ) {
259 var parameters;
260 // Support variadic arguments
261 if ( parameter_1 !== undefined ) {
262 parameters = $.makeArray( arguments );
263 parameters.shift();
264 } else {
265 parameters = [];
266 }
267 return new Message( mw.messages, key, parameters );
268 };
269
270 /**
271 * Gets a message string, similar to wfMsg()
272 *
273 * @param key string Key of message to get
274 * @param parameters mixed First argument in a list of variadic arguments,
275 * each a parameter for $N replacement in messages.
276 * @return String.
277 */
278 this.msg = function( key, parameters ) {
279 return mw.message.apply( mw.message, arguments ).toString();
280 };
281
282 /**
283 * Client-side module loader which integrates with the MediaWiki ResourceLoader
284 */
285 this.loader = new ( function() {
286
287 /* Private Members */
288
289 /**
290 * Mapping of registered modules
291 *
292 * The jquery module is pre-registered, because it must have already
293 * been provided for this object to have been built, and in debug mode
294 * jquery would have been provided through a unique loader request,
295 * making it impossible to hold back registration of jquery until after
296 * mediawiki.
297 *
298 * Format:
299 * {
300 * 'moduleName': {
301 * 'dependencies': ['required module', 'required module', ...], (or) function() {}
302 * 'state': 'registered', 'loading', 'loaded', 'ready', or 'error'
303 * 'script': function() {},
304 * 'style': 'css code string',
305 * 'messages': { 'key': 'value' },
306 * 'version': ############## (unix timestamp)
307 * }
308 */
309 var registry = {},
310 // List of modules which will be loaded as when ready
311 batch = [],
312 // List of modules to be loaded
313 queue = [],
314 // List of callback functions waiting for modules to be ready to be called
315 jobs = [],
316 // Flag inidicating that document ready has occured
317 ready = false,
318 // Selector cache for the marker element. Use getMarker() to get/use the marker!
319 $marker = null;
320
321 /* Private Methods */
322
323 function getMarker(){
324 // Cached ?
325 if ( $marker ) {
326 return $marker;
327 } else {
328 $marker = $( 'meta[name="ResourceLoaderDynamicStyles"]' );
329 if ( $marker.length ) {
330 return $marker;
331 }
332 mw.log( 'getMarker> No <meta name="ResourceLoaderDynamicStyles"> found, inserting dynamically.' );
333 $marker = $( '<meta>' ).attr( 'name', 'ResourceLoaderDynamicStyles' ).appendTo( 'head' );
334 return $marker;
335 }
336 }
337
338 function compare( a, b ) {
339 if ( a.length !== b.length ) {
340 return false;
341 }
342 for ( var i = 0; i < b.length; i++ ) {
343 if ( $.isArray( a[i] ) ) {
344 if ( !compare( a[i], b[i] ) ) {
345 return false;
346 }
347 }
348 if ( a[i] !== b[i] ) {
349 return false;
350 }
351 }
352 return true;
353 }
354
355 /**
356 * Generates an ISO8601 "basic" string from a UNIX timestamp
357 */
358 function formatVersionNumber( timestamp ) {
359 var pad = function( a, b, c ) {
360 return [a < 10 ? '0' + a : a, b < 10 ? '0' + b : b, c < 10 ? '0' + c : c].join( '' );
361 },
362 d = new Date().setTime( timestamp * 1000 );
363 return [
364 pad( d.getUTCFullYear(), d.getUTCMonth() + 1, d.getUTCDate() ), 'T',
365 pad( d.getUTCHours(), d.getUTCMinutes(), d.getUTCSeconds() ), 'Z'
366 ].join( '' );
367 }
368
369 /**
370 * Recursively resolves dependencies and detects circular references
371 */
372 function recurse( module, resolved, unresolved ) {
373 if ( registry[module] === undefined ) {
374 throw new Error( 'Unknown dependency: ' + module );
375 }
376 // Resolves dynamic loader function and replaces it with its own results
377 if ( $.isFunction( registry[module].dependencies ) ) {
378 registry[module].dependencies = registry[module].dependencies();
379 // Ensures the module's dependencies are always in an array
380 if ( typeof registry[module].dependencies !== 'object' ) {
381 registry[module].dependencies = [registry[module].dependencies];
382 }
383 }
384 // Tracks down dependencies
385 for ( var n = 0; n < registry[module].dependencies.length; n++ ) {
386 if ( $.inArray( registry[module].dependencies[n], resolved ) === -1 ) {
387 if ( $.inArray( registry[module].dependencies[n], unresolved ) !== -1 ) {
388 throw new Error(
389 'Circular reference detected: ' + module +
390 ' -> ' + registry[module].dependencies[n]
391 );
392 }
393 recurse( registry[module].dependencies[n], resolved, unresolved );
394 }
395 }
396 resolved[resolved.length] = module;
397 unresolved.splice( $.inArray( module, unresolved ), 1 );
398 }
399
400 /**
401 * Gets a list of module names that a module depends on in their proper dependency order
402 *
403 * @param module string module name or array of string module names
404 * @return list of dependencies
405 * @throws Error if circular reference is detected
406 */
407 function resolve( module ) {
408 // Allow calling with an array of module names
409 if ( typeof module === 'object' ) {
410 var modules = [];
411 for ( var m = 0; m < module.length; m++ ) {
412 var dependencies = resolve( module[m] );
413 for ( var n = 0; n < dependencies.length; n++ ) {
414 modules[modules.length] = dependencies[n];
415 }
416 }
417 return modules;
418 } else if ( typeof module === 'string' ) {
419 // Undefined modules have no dependencies
420 if ( !( module in registry ) ) {
421 return [];
422 }
423 var resolved = [];
424 recurse( module, resolved, [] );
425 return resolved;
426 }
427 throw new Error( 'Invalid module argument: ' + module );
428 }
429
430 /**
431 * Narrows a list of module names down to those matching a specific
432 * state. Possible states are 'undefined', 'registered', 'loading',
433 * 'loaded', or 'ready'
434 *
435 * @param states string or array of strings of module states to filter by
436 * @param modules array list of module names to filter (optional, all modules
437 * will be used by default)
438 * @return array list of filtered module names
439 */
440 function filter( states, modules ) {
441 // Allow states to be given as a string
442 if ( typeof states === 'string' ) {
443 states = [states];
444 }
445 // If called without a list of modules, build and use a list of all modules
446 var list = [], module;
447 if ( modules === undefined ) {
448 modules = [];
449 for ( module in registry ) {
450 modules[modules.length] = module;
451 }
452 }
453 // Build a list of modules which are in one of the specified states
454 for ( var s = 0; s < states.length; s++ ) {
455 for ( var m = 0; m < modules.length; m++ ) {
456 if ( registry[modules[m]] === undefined ) {
457 // Module does not exist
458 if ( states[s] === 'undefined' ) {
459 // OK, undefined
460 list[list.length] = modules[m];
461 }
462 } else {
463 // Module exists, check state
464 if ( registry[modules[m]].state === states[s] ) {
465 // OK, correct state
466 list[list.length] = modules[m];
467 }
468 }
469 }
470 }
471 return list;
472 }
473
474 /**
475 * Executes a loaded module, making it ready to use
476 *
477 * @param module string module name to execute
478 */
479 function execute( module, callback ) {
480 if ( registry[module] === undefined ) {
481 throw new Error( 'Module has not been registered yet: ' + module );
482 } else if ( registry[module].state === 'registered' ) {
483 throw new Error( 'Module has not been requested from the server yet: ' + module );
484 } else if ( registry[module].state === 'loading' ) {
485 throw new Error( 'Module has not completed loading yet: ' + module );
486 } else if ( registry[module].state === 'ready' ) {
487 throw new Error( 'Module has already been loaded: ' + module );
488 }
489 // Add styles
490 var style;
491 if ( $.isPlainObject( registry[module].style ) ) {
492 for ( var media in registry[module].style ) {
493 style = registry[module].style[media];
494 if ( $.isArray( style ) ) {
495 for ( var i = 0; i < style.length; i++ ) {
496 getMarker().before( mw.html.element( 'link', {
497 'type': 'text/css',
498 'rel': 'stylesheet',
499 'href': style[i]
500 } ) );
501 }
502 } else if ( typeof style === 'string' ) {
503 getMarker().before( mw.html.element(
504 'style',
505 { 'type': 'text/css', 'media': media },
506 new mw.html.Cdata( style )
507 ) );
508 }
509 }
510 }
511 // Add localizations to message system
512 if ( $.isPlainObject( registry[module].messages ) ) {
513 mw.messages.set( registry[module].messages );
514 }
515 // Execute script
516 try {
517 var script = registry[module].script,
518 markModuleReady = function() {
519 registry[module].state = 'ready';
520 handlePending( module );
521 if ( $.isFunction( callback ) ) {
522 callback();
523 }
524 };
525
526 if ( $.isArray( script ) ) {
527 var done = 0;
528 if ( script.length === 0 ) {
529 // No scripts in this module? Let's dive out early.
530 markModuleReady();
531 }
532 for ( var i = 0; i < script.length; i++ ) {
533 registry[module].state = 'loading';
534 addScript( script[i], function() {
535 if ( ++done === script.length ) {
536 markModuleReady();
537 }
538 } );
539 }
540 } else if ( $.isFunction( script ) ) {
541 script( jQuery );
542 markModuleReady();
543 }
544 } catch ( e ) {
545 // This needs to NOT use mw.log because these errors are common in production mode
546 // and not in debug mode, such as when a symbol that should be global isn't exported
547 if ( window.console && typeof window.console.log === 'function' ) {
548 console.log( 'mw.loader::execute> Exception thrown by ' + module + ': ' + e.message );
549 }
550 registry[module].state = 'error';
551 throw e;
552 }
553 }
554
555 /**
556 * Automatically executes jobs and modules which are pending with satistifed dependencies.
557 *
558 * This is used when dependencies are satisfied, such as when a module is executed.
559 */
560 function handlePending( module ) {
561 try {
562 // Run jobs who's dependencies have just been met
563 for ( var j = 0; j < jobs.length; j++ ) {
564 if ( compare(
565 filter( 'ready', jobs[j].dependencies ),
566 jobs[j].dependencies ) )
567 {
568 if ( $.isFunction( jobs[j].ready ) ) {
569 jobs[j].ready();
570 }
571 jobs.splice( j, 1 );
572 j--;
573 }
574 }
575 // Execute modules who's dependencies have just been met
576 for ( var r in registry ) {
577 if ( registry[r].state === 'loaded' ) {
578 if ( compare(
579 filter( ['ready'], registry[r].dependencies ),
580 registry[r].dependencies ) )
581 {
582 execute( r );
583 }
584 }
585 }
586 } catch ( e ) {
587 // Run error callbacks of jobs affected by this condition
588 for ( var j = 0; j < jobs.length; j++ ) {
589 if ( $.inArray( module, jobs[j].dependencies ) !== -1 ) {
590 if ( $.isFunction( jobs[j].error ) ) {
591 jobs[j].error();
592 }
593 jobs.splice( j, 1 );
594 j--;
595 }
596 }
597 }
598 }
599
600 /**
601 * Adds a dependencies to the queue with optional callbacks to be run
602 * when the dependencies are ready or fail
603 *
604 * @param dependencies string module name or array of string module names
605 * @param ready function callback to execute when all dependencies are ready
606 * @param error function callback to execute when any dependency fails
607 */
608 function request( dependencies, ready, error ) {
609 // Allow calling by single module name
610 if ( typeof dependencies === 'string' ) {
611 dependencies = [dependencies];
612 if ( dependencies[0] in registry ) {
613 for ( var n = 0; n < registry[dependencies[0]].dependencies.length; n++ ) {
614 dependencies[dependencies.length] = registry[dependencies[0]].dependencies[n];
615 }
616 }
617 }
618 // Add ready and error callbacks if they were given
619 if ( arguments.length > 1 ) {
620 jobs[jobs.length] = {
621 'dependencies': filter(
622 ['undefined', 'registered', 'loading', 'loaded'],
623 dependencies
624 ),
625 'ready': ready,
626 'error': error
627 };
628 }
629 // Queue up any dependencies that are undefined or registered
630 dependencies = filter( ['undefined', 'registered'], dependencies );
631 for ( var n = 0; n < dependencies.length; n++ ) {
632 if ( $.inArray( dependencies[n], queue ) === -1 ) {
633 queue[queue.length] = dependencies[n];
634 }
635 }
636 // Work the queue
637 mw.loader.work();
638 }
639
640 function sortQuery(o) {
641 var sorted = {}, key, a = [];
642 for ( key in o ) {
643 if ( o.hasOwnProperty( key ) ) {
644 a.push( key );
645 }
646 }
647 a.sort();
648 for ( key = 0; key < a.length; key++ ) {
649 sorted[a[key]] = o[a[key]];
650 }
651 return sorted;
652 }
653
654 /**
655 * Converts a module map of the form { foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }
656 * to a query string of the form foo.bar,baz|bar.baz,quux
657 */
658 function buildModulesString( moduleMap ) {
659 var arr = [], p;
660 for ( var prefix in moduleMap ) {
661 p = prefix === '' ? '' : prefix + '.';
662 arr.push( p + moduleMap[prefix].join( ',' ) );
663 }
664 return arr.join( '|' );
665 }
666
667 /**
668 * Adds a script tag to the body, either using document.write or low-level DOM manipulation,
669 * depending on whether document-ready has occured yet.
670 *
671 * @param src String: URL to script, will be used as the src attribute in the script tag
672 * @param callback Function: Optional callback which will be run when the script is done
673 */
674 function addScript( src, callback ) {
675 if ( ready ) {
676 // jQuery's getScript method is NOT better than doing this the old-fassioned way
677 // because jQuery will eval the script's code, and errors will not have sane
678 // line numbers.
679 var done = false,
680 script = document.createElement( 'script' );
681 script.setAttribute( 'src', src );
682 script.setAttribute( 'type', 'text/javascript' );
683 if ( $.isFunction( callback ) ) {
684 // Attach handlers for all browsers -- this is based on jQuery.getScript
685 script.onload = script.onreadystatechange = function() {
686 if (
687 !done
688 && (
689 !this.readyState
690 || this.readyState === 'loaded'
691 || this.readyState === 'complete'
692 )
693 ) {
694 done = true;
695 callback();
696 // Handle memory leak in IE
697 script.onload = script.onreadystatechange = null;
698 if ( script.parentNode ) {
699 script.parentNode.removeChild( script );
700 }
701 }
702 };
703 }
704 document.body.appendChild( script );
705 } else {
706 document.write( mw.html.element(
707 'script', { 'type': 'text/javascript', 'src': src }, ''
708 ) );
709 if ( $.isFunction( callback ) ) {
710 // Document.write is synchronous, so this is called when it's done
711 callback();
712 }
713 }
714 }
715
716 /* Public Methods */
717
718 /**
719 * Requests dependencies from server, loading and executing when things when ready.
720 */
721 this.work = function() {
722 // Build a list of request parameters
723 var base = {
724 'skin': mw.config.get( 'skin' ),
725 'lang': mw.config.get( 'wgUserLanguage' ),
726 'debug': mw.config.get( 'debug' )
727 },
728 // Extend request parameters with a list of modules in the batch
729 requests = [],
730 // Split into groups
731 groups = {};
732
733 // Appends a list of modules to the batch
734 for ( var q = 0; q < queue.length; q++ ) {
735 // Only request modules which are undefined or registered
736 if ( !( queue[q] in registry ) || registry[queue[q]].state === 'registered' ) {
737 // Prevent duplicate entries
738 if ( $.inArray( queue[q], batch ) === -1 ) {
739 batch[batch.length] = queue[q];
740 // Mark registered modules as loading
741 if ( queue[q] in registry ) {
742 registry[queue[q]].state = 'loading';
743 }
744 }
745 }
746 }
747 // Early exit if there's nothing to load
748 if ( !batch.length ) {
749 return;
750 }
751 // Clean up the queue
752 queue = [];
753 // Always order modules alphabetically to help reduce cache
754 // misses for otherwise identical content
755 batch.sort();
756 for ( var b = 0; b < batch.length; b++ ) {
757 var bGroup = registry[batch[b]].group;
758 if ( !( bGroup in groups ) ) {
759 groups[bGroup] = [];
760 }
761 groups[bGroup][groups[bGroup].length] = batch[b];
762 }
763 for ( var group in groups ) {
764 // Calculate the highest timestamp
765 var version = 0;
766 for ( var g = 0; g < groups[group].length; g++ ) {
767 if ( registry[groups[group][g]].version > version ) {
768 version = registry[groups[group][g]].version;
769 }
770 }
771
772 var reqBase = $.extend( { 'version': formatVersionNumber( version ) }, base ),
773 reqBaseLength = $.param( reqBase ).length,
774 reqs = [],
775 limit = mw.config.get( 'wgResourceLoaderMaxQueryLength', -1 ),
776 // We may need to split up the request to honor the query string length limit,
777 // so build it piece by piece.
778 l = reqBaseLength + 9, // '&modules='.length == 9
779 r = 0;
780
781 reqs[0] = {}; // { prefix: [ suffixes ] }
782
783 for ( var i = 0; i < groups[group].length; i++ ) {
784 // Determine how many bytes this module would add to the query string
785 var lastDotIndex = groups[group][i].lastIndexOf( '.' ),
786 // Note that these substr() calls work even if lastDotIndex == -1
787 prefix = groups[group][i].substr( 0, lastDotIndex ),
788 suffix = groups[group][i].substr( lastDotIndex + 1 ),
789 bytesAdded = prefix in reqs[r]
790 ? suffix.length + 3 // '%2C'.length == 3
791 : groups[group][i].length + 3; // '%7C'.length == 3
792
793 // If the request would become too long, create a new one,
794 // but don't create empty requests
795 if ( limit > 0 && !$.isEmptyObject( reqs[r] ) && l + bytesAdded > limit ) {
796 // This request would become too long, create a new one
797 r++;
798 reqs[r] = {};
799 l = reqBaseLength + 9;
800 }
801 if ( !( prefix in reqs[r] ) ) {
802 reqs[r][prefix] = [];
803 }
804 reqs[r][prefix].push( suffix );
805 l += bytesAdded;
806 }
807 for ( var r = 0; r < reqs.length; r++ ) {
808 requests[requests.length] = $.extend(
809 { 'modules': buildModulesString( reqs[r] ) }, reqBase
810 );
811 }
812 }
813 // Clear the batch - this MUST happen before we append the
814 // script element to the body or it's possible that the script
815 // will be locally cached, instantly load, and work the batch
816 // again, all before we've cleared it causing each request to
817 // include modules which are already loaded
818 batch = [];
819 // Asynchronously append a script tag to the end of the body
820 for ( var r = 0; r < requests.length; r++ ) {
821 requests[r] = sortQuery( requests[r] );
822 // Append &* to avoid triggering the IE6 extension check
823 var src = mw.config.get( 'wgLoadScript' ) + '?' + $.param( requests[r] ) + '&*';
824 addScript( src );
825 }
826 };
827
828 /**
829 * Registers a module, letting the system know about it and its
830 * dependencies. loader.js files contain calls to this function.
831 */
832 this.register = function( module, version, dependencies, group ) {
833 // Allow multiple registration
834 if ( typeof module === 'object' ) {
835 for ( var m = 0; m < module.length; m++ ) {
836 if ( typeof module[m] === 'string' ) {
837 mw.loader.register( module[m] );
838 } else if ( typeof module[m] === 'object' ) {
839 mw.loader.register.apply( mw.loader, module[m] );
840 }
841 }
842 return;
843 }
844 // Validate input
845 if ( typeof module !== 'string' ) {
846 throw new Error( 'module must be a string, not a ' + typeof module );
847 }
848 if ( registry[module] !== undefined ) {
849 throw new Error( 'module already implemented: ' + module );
850 }
851 // List the module as registered
852 registry[module] = {
853 'state': 'registered',
854 'group': typeof group === 'string' ? group : null,
855 'dependencies': [],
856 'version': version !== undefined ? parseInt( version, 10 ) : 0
857 };
858 if ( typeof dependencies === 'string' ) {
859 // Allow dependencies to be given as a single module name
860 registry[module].dependencies = [dependencies];
861 } else if ( typeof dependencies === 'object' || $.isFunction( dependencies ) ) {
862 // Allow dependencies to be given as an array of module names
863 // or a function which returns an array
864 registry[module].dependencies = dependencies;
865 }
866 };
867
868 /**
869 * Implements a module, giving the system a course of action to take
870 * upon loading. Results of a request for one or more modules contain
871 * calls to this function.
872 *
873 * All arguments are required.
874 *
875 * @param module String: Name of module
876 * @param script Mixed: Function of module code or String of URL to be used as the src
877 * attribute when adding a script element to the body
878 * @param style Object: Object of CSS strings keyed by media-type or Object of lists of URLs
879 * keyed by media-type
880 * @param msgs Object: List of key/value pairs to be passed through mw.messages.set
881 */
882 this.implement = function( module, script, style, msgs ) {
883 // Validate input
884 if ( typeof module !== 'string' ) {
885 throw new Error( 'module must be a string, not a ' + typeof module );
886 }
887 if ( !$.isFunction( script ) && !$.isArray( script ) ) {
888 throw new Error( 'script must be a function or an array, not a ' + typeof script );
889 }
890 if ( !$.isPlainObject( style ) ) {
891 throw new Error( 'style must be an object, not a ' + typeof style );
892 }
893 if ( !$.isPlainObject( msgs ) ) {
894 throw new Error( 'msgs must be an object, not a ' + typeof msgs );
895 }
896 // Automatically register module
897 if ( registry[module] === undefined ) {
898 mw.loader.register( module );
899 }
900 // Check for duplicate implementation
901 if ( registry[module] !== undefined && registry[module].script !== undefined ) {
902 throw new Error( 'module already implemeneted: ' + module );
903 }
904 // Mark module as loaded
905 registry[module].state = 'loaded';
906 // Attach components
907 registry[module].script = script;
908 registry[module].style = style;
909 registry[module].messages = msgs;
910 // Execute or queue callback
911 if ( compare(
912 filter( ['ready'], registry[module].dependencies ),
913 registry[module].dependencies ) )
914 {
915 execute( module );
916 } else {
917 request( module );
918 }
919 };
920
921 /**
922 * Executes a function as soon as one or more required modules are ready
923 *
924 * @param dependencies string or array of strings of modules names the callback
925 * dependencies to be ready before executing
926 * @param ready function callback to execute when all dependencies are ready (optional)
927 * @param error function callback to execute when if dependencies have a errors (optional)
928 */
929 this.using = function( dependencies, ready, error ) {
930 var tod = typeof dependencies;
931 // Validate input
932 if ( tod !== 'object' && tod !== 'string' ) {
933 throw new Error( 'dependencies must be a string or an array, not a ' + tod );
934 }
935 // Allow calling with a single dependency as a string
936 if ( tod === 'string' ) {
937 dependencies = [dependencies];
938 }
939 // Resolve entire dependency map
940 dependencies = resolve( dependencies );
941 // If all dependencies are met, execute ready immediately
942 if ( compare( filter( ['ready'], dependencies ), dependencies ) ) {
943 if ( $.isFunction( ready ) ) {
944 ready();
945 }
946 }
947 // If any dependencies have errors execute error immediately
948 else if ( filter( ['error'], dependencies ).length ) {
949 if ( $.isFunction( error ) ) {
950 error();
951 }
952 }
953 // Since some dependencies are not yet ready, queue up a request
954 else {
955 request( dependencies, ready, error );
956 }
957 };
958
959 /**
960 * Loads an external script or one or more modules for future use
961 *
962 * @param modules mixed either the name of a module, array of modules,
963 * or a URL of an external script or style
964 * @param type string mime-type to use if calling with a URL of an
965 * external script or style; acceptable values are "text/css" and
966 * "text/javascript"; if no type is provided, text/javascript is assumed.
967 */
968 this.load = function( modules, type ) {
969 // Validate input
970 if ( typeof modules !== 'object' && typeof modules !== 'string' ) {
971 throw new Error( 'modules must be a string or an array, not a ' + typeof modules );
972 }
973 // Allow calling with an external script or single dependency as a string
974 if ( typeof modules === 'string' ) {
975 // Support adding arbitrary external scripts
976 if ( modules.substr( 0, 7 ) === 'http://' || modules.substr( 0, 8 ) === 'https://' ) {
977 if ( type === 'text/css' ) {
978 $( 'head' ).append( $( '<link/>', {
979 rel: 'stylesheet',
980 type: 'text/css',
981 href: modules
982 } ) );
983 return true;
984 } else if ( type === 'text/javascript' || type === undefined ) {
985 addScript( modules );
986 return true;
987 }
988 // Unknown type
989 return false;
990 }
991 // Called with single module
992 modules = [modules];
993 }
994 // Resolve entire dependency map
995 modules = resolve( modules );
996 // If all modules are ready, nothing dependency be done
997 if ( compare( filter( ['ready'], modules ), modules ) ) {
998 return true;
999 }
1000 // If any modules have errors return false
1001 else if ( filter( ['error'], modules ).length ) {
1002 return false;
1003 }
1004 // Since some modules are not yet ready, queue up a request
1005 else {
1006 request( modules );
1007 return true;
1008 }
1009 };
1010
1011 /**
1012 * Changes the state of a module
1013 *
1014 * @param module string module name or object of module name/state pairs
1015 * @param state string state name
1016 */
1017 this.state = function( module, state ) {
1018 if ( typeof module === 'object' ) {
1019 for ( var m in module ) {
1020 mw.loader.state( m, module[m] );
1021 }
1022 return;
1023 }
1024 if ( !( module in registry ) ) {
1025 mw.loader.register( module );
1026 }
1027 registry[module].state = state;
1028 };
1029
1030 /**
1031 * Gets the version of a module
1032 *
1033 * @param module string name of module to get version for
1034 */
1035 this.getVersion = function( module ) {
1036 if ( module in registry && 'version' in registry[module] ) {
1037 return formatVersionNumber( registry[module].version );
1038 }
1039 return null;
1040 };
1041
1042 /**
1043 * @deprecated use mw.loader.getVersion() instead
1044 */
1045 this.version = function() {
1046 return mw.loader.getVersion.apply( mw.loader, arguments );
1047 };
1048
1049 /**
1050 * Gets the state of a module
1051 *
1052 * @param module string name of module to get state for
1053 */
1054 this.getState = function( module ) {
1055 if ( module in registry && 'state' in registry[module] ) {
1056 return registry[module].state;
1057 }
1058 return null;
1059 };
1060
1061 /* Cache document ready status */
1062
1063 $(document).ready( function() { ready = true; } );
1064 } )();
1065
1066 /** HTML construction helper functions */
1067 this.html = new ( function () {
1068 var escapeCallback = function( s ) {
1069 switch ( s ) {
1070 case "'":
1071 return '&#039;';
1072 case '"':
1073 return '&quot;';
1074 case '<':
1075 return '&lt;';
1076 case '>':
1077 return '&gt;';
1078 case '&':
1079 return '&amp;';
1080 }
1081 };
1082
1083 /**
1084 * Escape a string for HTML. Converts special characters to HTML entities.
1085 * @param s The string to escape
1086 */
1087 this.escape = function( s ) {
1088 return s.replace( /['"<>&]/g, escapeCallback );
1089 };
1090
1091 /**
1092 * Wrapper object for raw HTML passed to mw.html.element().
1093 */
1094 this.Raw = function( value ) {
1095 this.value = value;
1096 };
1097
1098 /**
1099 * Wrapper object for CDATA element contents passed to mw.html.element()
1100 */
1101 this.Cdata = function( value ) {
1102 this.value = value;
1103 };
1104
1105 /**
1106 * Create an HTML element string, with safe escaping.
1107 *
1108 * @param name The tag name.
1109 * @param attrs An object with members mapping element names to values
1110 * @param contents The contents of the element. May be either:
1111 * - string: The string is escaped.
1112 * - null or undefined: The short closing form is used, e.g. <br/>.
1113 * - this.Raw: The value attribute is included without escaping.
1114 * - this.Cdata: The value attribute is included, and an exception is
1115 * thrown if it contains an illegal ETAGO delimiter.
1116 * See http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.3.2
1117 *
1118 * Example:
1119 * var h = mw.html;
1120 * return h.element( 'div', {},
1121 * new h.Raw( h.element( 'img', {src: '<'} ) ) );
1122 * Returns <div><img src="&lt;"/></div>
1123 */
1124 this.element = function( name, attrs, contents ) {
1125 var s = '<' + name;
1126 for ( var attrName in attrs ) {
1127 s += ' ' + attrName + '="' + this.escape( attrs[attrName] ) + '"';
1128 }
1129 if ( contents === undefined || contents === null ) {
1130 // Self close tag
1131 s += '/>';
1132 return s;
1133 }
1134 // Regular open tag
1135 s += '>';
1136 if ( typeof contents === 'string' ) {
1137 // Escaped
1138 s += this.escape( contents );
1139 } else if ( contents instanceof this.Raw ) {
1140 // Raw HTML inclusion
1141 s += contents.value;
1142 } else if ( contents instanceof this.Cdata ) {
1143 // CDATA
1144 if ( /<\/[a-zA-z]/.test( contents.value ) ) {
1145 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
1146 }
1147 s += contents.value;
1148 } else {
1149 throw new Error( 'mw.html.element: Invalid type of contents' );
1150 }
1151 s += '</' + name + '>';
1152 return s;
1153 };
1154 } )();
1155
1156 /* Extension points */
1157
1158 this.legacy = {};
1159
1160 } )( jQuery );
1161
1162 // Alias $j to jQuery for backwards compatibility
1163 window.$j = jQuery;
1164
1165 /* Auto-register from pre-loaded startup scripts */
1166
1167 if ( jQuery.isFunction( startUp ) ) {
1168 startUp();
1169 delete startUp;
1170 }