fu r92933 - fix breakage
[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();
363 d.setTime( timestamp * 1000 );
364 return [
365 pad( d.getUTCFullYear(), d.getUTCMonth() + 1, d.getUTCDate() ), 'T',
366 pad( d.getUTCHours(), d.getUTCMinutes(), d.getUTCSeconds() ), 'Z'
367 ].join( '' );
368 }
369
370 /**
371 * Recursively resolves dependencies and detects circular references
372 */
373 function recurse( module, resolved, unresolved ) {
374 if ( registry[module] === undefined ) {
375 throw new Error( 'Unknown dependency: ' + module );
376 }
377 // Resolves dynamic loader function and replaces it with its own results
378 if ( $.isFunction( registry[module].dependencies ) ) {
379 registry[module].dependencies = registry[module].dependencies();
380 // Ensures the module's dependencies are always in an array
381 if ( typeof registry[module].dependencies !== 'object' ) {
382 registry[module].dependencies = [registry[module].dependencies];
383 }
384 }
385 // Tracks down dependencies
386 for ( var n = 0; n < registry[module].dependencies.length; n++ ) {
387 if ( $.inArray( registry[module].dependencies[n], resolved ) === -1 ) {
388 if ( $.inArray( registry[module].dependencies[n], unresolved ) !== -1 ) {
389 throw new Error(
390 'Circular reference detected: ' + module +
391 ' -> ' + registry[module].dependencies[n]
392 );
393 }
394 recurse( registry[module].dependencies[n], resolved, unresolved );
395 }
396 }
397 resolved[resolved.length] = module;
398 unresolved.splice( $.inArray( module, unresolved ), 1 );
399 }
400
401 /**
402 * Gets a list of module names that a module depends on in their proper dependency order
403 *
404 * @param module string module name or array of string module names
405 * @return list of dependencies
406 * @throws Error if circular reference is detected
407 */
408 function resolve( module ) {
409 // Allow calling with an array of module names
410 if ( typeof module === 'object' ) {
411 var modules = [];
412 for ( var m = 0; m < module.length; m++ ) {
413 var dependencies = resolve( module[m] );
414 for ( var n = 0; n < dependencies.length; n++ ) {
415 modules[modules.length] = dependencies[n];
416 }
417 }
418 return modules;
419 } else if ( typeof module === 'string' ) {
420 // Undefined modules have no dependencies
421 if ( !( module in registry ) ) {
422 return [];
423 }
424 var resolved = [];
425 recurse( module, resolved, [] );
426 return resolved;
427 }
428 throw new Error( 'Invalid module argument: ' + module );
429 }
430
431 /**
432 * Narrows a list of module names down to those matching a specific
433 * state. Possible states are 'undefined', 'registered', 'loading',
434 * 'loaded', or 'ready'
435 *
436 * @param states string or array of strings of module states to filter by
437 * @param modules array list of module names to filter (optional, all modules
438 * will be used by default)
439 * @return array list of filtered module names
440 */
441 function filter( states, modules ) {
442 // Allow states to be given as a string
443 if ( typeof states === 'string' ) {
444 states = [states];
445 }
446 // If called without a list of modules, build and use a list of all modules
447 var list = [], module;
448 if ( modules === undefined ) {
449 modules = [];
450 for ( module in registry ) {
451 modules[modules.length] = module;
452 }
453 }
454 // Build a list of modules which are in one of the specified states
455 for ( var s = 0; s < states.length; s++ ) {
456 for ( var m = 0; m < modules.length; m++ ) {
457 if ( registry[modules[m]] === undefined ) {
458 // Module does not exist
459 if ( states[s] === 'undefined' ) {
460 // OK, undefined
461 list[list.length] = modules[m];
462 }
463 } else {
464 // Module exists, check state
465 if ( registry[modules[m]].state === states[s] ) {
466 // OK, correct state
467 list[list.length] = modules[m];
468 }
469 }
470 }
471 }
472 return list;
473 }
474
475 /**
476 * Executes a loaded module, making it ready to use
477 *
478 * @param module string module name to execute
479 */
480 function execute( module, callback ) {
481 if ( registry[module] === undefined ) {
482 throw new Error( 'Module has not been registered yet: ' + module );
483 } else if ( registry[module].state === 'registered' ) {
484 throw new Error( 'Module has not been requested from the server yet: ' + module );
485 } else if ( registry[module].state === 'loading' ) {
486 throw new Error( 'Module has not completed loading yet: ' + module );
487 } else if ( registry[module].state === 'ready' ) {
488 throw new Error( 'Module has already been loaded: ' + module );
489 }
490 // Add styles
491 var style;
492 if ( $.isPlainObject( registry[module].style ) ) {
493 for ( var media in registry[module].style ) {
494 style = registry[module].style[media];
495 if ( $.isArray( style ) ) {
496 for ( var i = 0; i < style.length; i++ ) {
497 getMarker().before( mw.html.element( 'link', {
498 'type': 'text/css',
499 'rel': 'stylesheet',
500 'href': style[i]
501 } ) );
502 }
503 } else if ( typeof style === 'string' ) {
504 getMarker().before( mw.html.element(
505 'style',
506 { 'type': 'text/css', 'media': media },
507 new mw.html.Cdata( style )
508 ) );
509 }
510 }
511 }
512 // Add localizations to message system
513 if ( $.isPlainObject( registry[module].messages ) ) {
514 mw.messages.set( registry[module].messages );
515 }
516 // Execute script
517 try {
518 var script = registry[module].script,
519 markModuleReady = function() {
520 registry[module].state = 'ready';
521 handlePending( module );
522 if ( $.isFunction( callback ) ) {
523 callback();
524 }
525 };
526
527 if ( $.isArray( script ) ) {
528 var done = 0;
529 if ( script.length === 0 ) {
530 // No scripts in this module? Let's dive out early.
531 markModuleReady();
532 }
533 for ( var i = 0; i < script.length; i++ ) {
534 registry[module].state = 'loading';
535 addScript( script[i], function() {
536 if ( ++done === script.length ) {
537 markModuleReady();
538 }
539 } );
540 }
541 } else if ( $.isFunction( script ) ) {
542 script( jQuery );
543 markModuleReady();
544 }
545 } catch ( e ) {
546 // This needs to NOT use mw.log because these errors are common in production mode
547 // and not in debug mode, such as when a symbol that should be global isn't exported
548 if ( window.console && typeof window.console.log === 'function' ) {
549 console.log( 'mw.loader::execute> Exception thrown by ' + module + ': ' + e.message );
550 }
551 registry[module].state = 'error';
552 throw e;
553 }
554 }
555
556 /**
557 * Automatically executes jobs and modules which are pending with satistifed dependencies.
558 *
559 * This is used when dependencies are satisfied, such as when a module is executed.
560 */
561 function handlePending( module ) {
562 try {
563 // Run jobs who's dependencies have just been met
564 for ( var j = 0; j < jobs.length; j++ ) {
565 if ( compare(
566 filter( 'ready', jobs[j].dependencies ),
567 jobs[j].dependencies ) )
568 {
569 if ( $.isFunction( jobs[j].ready ) ) {
570 jobs[j].ready();
571 }
572 jobs.splice( j, 1 );
573 j--;
574 }
575 }
576 // Execute modules who's dependencies have just been met
577 for ( var r in registry ) {
578 if ( registry[r].state === 'loaded' ) {
579 if ( compare(
580 filter( ['ready'], registry[r].dependencies ),
581 registry[r].dependencies ) )
582 {
583 execute( r );
584 }
585 }
586 }
587 } catch ( e ) {
588 // Run error callbacks of jobs affected by this condition
589 for ( var j = 0; j < jobs.length; j++ ) {
590 if ( $.inArray( module, jobs[j].dependencies ) !== -1 ) {
591 if ( $.isFunction( jobs[j].error ) ) {
592 jobs[j].error();
593 }
594 jobs.splice( j, 1 );
595 j--;
596 }
597 }
598 }
599 }
600
601 /**
602 * Adds a dependencies to the queue with optional callbacks to be run
603 * when the dependencies are ready or fail
604 *
605 * @param dependencies string module name or array of string module names
606 * @param ready function callback to execute when all dependencies are ready
607 * @param error function callback to execute when any dependency fails
608 */
609 function request( dependencies, ready, error ) {
610 // Allow calling by single module name
611 if ( typeof dependencies === 'string' ) {
612 dependencies = [dependencies];
613 if ( dependencies[0] in registry ) {
614 for ( var n = 0; n < registry[dependencies[0]].dependencies.length; n++ ) {
615 dependencies[dependencies.length] = registry[dependencies[0]].dependencies[n];
616 }
617 }
618 }
619 // Add ready and error callbacks if they were given
620 if ( arguments.length > 1 ) {
621 jobs[jobs.length] = {
622 'dependencies': filter(
623 ['undefined', 'registered', 'loading', 'loaded'],
624 dependencies
625 ),
626 'ready': ready,
627 'error': error
628 };
629 }
630 // Queue up any dependencies that are undefined or registered
631 dependencies = filter( ['undefined', 'registered'], dependencies );
632 for ( var n = 0; n < dependencies.length; n++ ) {
633 if ( $.inArray( dependencies[n], queue ) === -1 ) {
634 queue[queue.length] = dependencies[n];
635 }
636 }
637 // Work the queue
638 mw.loader.work();
639 }
640
641 function sortQuery(o) {
642 var sorted = {}, key, a = [];
643 for ( key in o ) {
644 if ( o.hasOwnProperty( key ) ) {
645 a.push( key );
646 }
647 }
648 a.sort();
649 for ( key = 0; key < a.length; key++ ) {
650 sorted[a[key]] = o[a[key]];
651 }
652 return sorted;
653 }
654
655 /**
656 * Converts a module map of the form { foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }
657 * to a query string of the form foo.bar,baz|bar.baz,quux
658 */
659 function buildModulesString( moduleMap ) {
660 var arr = [], p;
661 for ( var prefix in moduleMap ) {
662 p = prefix === '' ? '' : prefix + '.';
663 arr.push( p + moduleMap[prefix].join( ',' ) );
664 }
665 return arr.join( '|' );
666 }
667
668 /**
669 * Adds a script tag to the body, either using document.write or low-level DOM manipulation,
670 * depending on whether document-ready has occured yet.
671 *
672 * @param src String: URL to script, will be used as the src attribute in the script tag
673 * @param callback Function: Optional callback which will be run when the script is done
674 */
675 function addScript( src, callback ) {
676 if ( ready ) {
677 // jQuery's getScript method is NOT better than doing this the old-fassioned way
678 // because jQuery will eval the script's code, and errors will not have sane
679 // line numbers.
680 var done = false,
681 script = document.createElement( 'script' );
682 script.setAttribute( 'src', src );
683 script.setAttribute( 'type', 'text/javascript' );
684 if ( $.isFunction( callback ) ) {
685 // Attach handlers for all browsers -- this is based on jQuery.getScript
686 script.onload = script.onreadystatechange = function() {
687 if (
688 !done
689 && (
690 !this.readyState
691 || this.readyState === 'loaded'
692 || this.readyState === 'complete'
693 )
694 ) {
695 done = true;
696 callback();
697 // Handle memory leak in IE
698 script.onload = script.onreadystatechange = null;
699 if ( script.parentNode ) {
700 script.parentNode.removeChild( script );
701 }
702 }
703 };
704 }
705 document.body.appendChild( script );
706 } else {
707 document.write( mw.html.element(
708 'script', { 'type': 'text/javascript', 'src': src }, ''
709 ) );
710 if ( $.isFunction( callback ) ) {
711 // Document.write is synchronous, so this is called when it's done
712 callback();
713 }
714 }
715 }
716
717 /* Public Methods */
718
719 /**
720 * Requests dependencies from server, loading and executing when things when ready.
721 */
722 this.work = function() {
723 // Build a list of request parameters
724 var base = {
725 'skin': mw.config.get( 'skin' ),
726 'lang': mw.config.get( 'wgUserLanguage' ),
727 'debug': mw.config.get( 'debug' )
728 },
729 // Extend request parameters with a list of modules in the batch
730 requests = [],
731 // Split into groups
732 groups = {};
733
734 // Appends a list of modules to the batch
735 for ( var q = 0; q < queue.length; q++ ) {
736 // Only request modules which are undefined or registered
737 if ( !( queue[q] in registry ) || registry[queue[q]].state === 'registered' ) {
738 // Prevent duplicate entries
739 if ( $.inArray( queue[q], batch ) === -1 ) {
740 batch[batch.length] = queue[q];
741 // Mark registered modules as loading
742 if ( queue[q] in registry ) {
743 registry[queue[q]].state = 'loading';
744 }
745 }
746 }
747 }
748 // Early exit if there's nothing to load
749 if ( !batch.length ) {
750 return;
751 }
752 // Clean up the queue
753 queue = [];
754 // Always order modules alphabetically to help reduce cache
755 // misses for otherwise identical content
756 batch.sort();
757 for ( var b = 0; b < batch.length; b++ ) {
758 var bGroup = registry[batch[b]].group;
759 if ( !( bGroup in groups ) ) {
760 groups[bGroup] = [];
761 }
762 groups[bGroup][groups[bGroup].length] = batch[b];
763 }
764 for ( var group in groups ) {
765 // Calculate the highest timestamp
766 var version = 0;
767 for ( var g = 0; g < groups[group].length; g++ ) {
768 if ( registry[groups[group][g]].version > version ) {
769 version = registry[groups[group][g]].version;
770 }
771 }
772
773 var reqBase = $.extend( { 'version': formatVersionNumber( version ) }, base ),
774 reqBaseLength = $.param( reqBase ).length,
775 reqs = [],
776 limit = mw.config.get( 'wgResourceLoaderMaxQueryLength', -1 ),
777 // We may need to split up the request to honor the query string length limit,
778 // so build it piece by piece.
779 l = reqBaseLength + 9, // '&modules='.length == 9
780 r = 0;
781
782 reqs[0] = {}; // { prefix: [ suffixes ] }
783
784 for ( var i = 0; i < groups[group].length; i++ ) {
785 // Determine how many bytes this module would add to the query string
786 var lastDotIndex = groups[group][i].lastIndexOf( '.' ),
787 // Note that these substr() calls work even if lastDotIndex == -1
788 prefix = groups[group][i].substr( 0, lastDotIndex ),
789 suffix = groups[group][i].substr( lastDotIndex + 1 ),
790 bytesAdded = prefix in reqs[r]
791 ? suffix.length + 3 // '%2C'.length == 3
792 : groups[group][i].length + 3; // '%7C'.length == 3
793
794 // If the request would become too long, create a new one,
795 // but don't create empty requests
796 if ( limit > 0 && !$.isEmptyObject( reqs[r] ) && l + bytesAdded > limit ) {
797 // This request would become too long, create a new one
798 r++;
799 reqs[r] = {};
800 l = reqBaseLength + 9;
801 }
802 if ( !( prefix in reqs[r] ) ) {
803 reqs[r][prefix] = [];
804 }
805 reqs[r][prefix].push( suffix );
806 l += bytesAdded;
807 }
808 for ( var r = 0; r < reqs.length; r++ ) {
809 requests[requests.length] = $.extend(
810 { 'modules': buildModulesString( reqs[r] ) }, reqBase
811 );
812 }
813 }
814 // Clear the batch - this MUST happen before we append the
815 // script element to the body or it's possible that the script
816 // will be locally cached, instantly load, and work the batch
817 // again, all before we've cleared it causing each request to
818 // include modules which are already loaded
819 batch = [];
820 // Asynchronously append a script tag to the end of the body
821 for ( var r = 0; r < requests.length; r++ ) {
822 requests[r] = sortQuery( requests[r] );
823 // Append &* to avoid triggering the IE6 extension check
824 var src = mw.config.get( 'wgLoadScript' ) + '?' + $.param( requests[r] ) + '&*';
825 addScript( src );
826 }
827 };
828
829 /**
830 * Registers a module, letting the system know about it and its
831 * dependencies. loader.js files contain calls to this function.
832 */
833 this.register = function( module, version, dependencies, group ) {
834 // Allow multiple registration
835 if ( typeof module === 'object' ) {
836 for ( var m = 0; m < module.length; m++ ) {
837 if ( typeof module[m] === 'string' ) {
838 mw.loader.register( module[m] );
839 } else if ( typeof module[m] === 'object' ) {
840 mw.loader.register.apply( mw.loader, module[m] );
841 }
842 }
843 return;
844 }
845 // Validate input
846 if ( typeof module !== 'string' ) {
847 throw new Error( 'module must be a string, not a ' + typeof module );
848 }
849 if ( registry[module] !== undefined ) {
850 throw new Error( 'module already implemented: ' + module );
851 }
852 // List the module as registered
853 registry[module] = {
854 'state': 'registered',
855 'group': typeof group === 'string' ? group : null,
856 'dependencies': [],
857 'version': version !== undefined ? parseInt( version, 10 ) : 0
858 };
859 if ( typeof dependencies === 'string' ) {
860 // Allow dependencies to be given as a single module name
861 registry[module].dependencies = [dependencies];
862 } else if ( typeof dependencies === 'object' || $.isFunction( dependencies ) ) {
863 // Allow dependencies to be given as an array of module names
864 // or a function which returns an array
865 registry[module].dependencies = dependencies;
866 }
867 };
868
869 /**
870 * Implements a module, giving the system a course of action to take
871 * upon loading. Results of a request for one or more modules contain
872 * calls to this function.
873 *
874 * All arguments are required.
875 *
876 * @param module String: Name of module
877 * @param script Mixed: Function of module code or String of URL to be used as the src
878 * attribute when adding a script element to the body
879 * @param style Object: Object of CSS strings keyed by media-type or Object of lists of URLs
880 * keyed by media-type
881 * @param msgs Object: List of key/value pairs to be passed through mw.messages.set
882 */
883 this.implement = function( module, script, style, msgs ) {
884 // Validate input
885 if ( typeof module !== 'string' ) {
886 throw new Error( 'module must be a string, not a ' + typeof module );
887 }
888 if ( !$.isFunction( script ) && !$.isArray( script ) ) {
889 throw new Error( 'script must be a function or an array, not a ' + typeof script );
890 }
891 if ( !$.isPlainObject( style ) ) {
892 throw new Error( 'style must be an object, not a ' + typeof style );
893 }
894 if ( !$.isPlainObject( msgs ) ) {
895 throw new Error( 'msgs must be an object, not a ' + typeof msgs );
896 }
897 // Automatically register module
898 if ( registry[module] === undefined ) {
899 mw.loader.register( module );
900 }
901 // Check for duplicate implementation
902 if ( registry[module] !== undefined && registry[module].script !== undefined ) {
903 throw new Error( 'module already implemeneted: ' + module );
904 }
905 // Mark module as loaded
906 registry[module].state = 'loaded';
907 // Attach components
908 registry[module].script = script;
909 registry[module].style = style;
910 registry[module].messages = msgs;
911 // Execute or queue callback
912 if ( compare(
913 filter( ['ready'], registry[module].dependencies ),
914 registry[module].dependencies ) )
915 {
916 execute( module );
917 } else {
918 request( module );
919 }
920 };
921
922 /**
923 * Executes a function as soon as one or more required modules are ready
924 *
925 * @param dependencies string or array of strings of modules names the callback
926 * dependencies to be ready before executing
927 * @param ready function callback to execute when all dependencies are ready (optional)
928 * @param error function callback to execute when if dependencies have a errors (optional)
929 */
930 this.using = function( dependencies, ready, error ) {
931 var tod = typeof dependencies;
932 // Validate input
933 if ( tod !== 'object' && tod !== 'string' ) {
934 throw new Error( 'dependencies must be a string or an array, not a ' + tod );
935 }
936 // Allow calling with a single dependency as a string
937 if ( tod === 'string' ) {
938 dependencies = [dependencies];
939 }
940 // Resolve entire dependency map
941 dependencies = resolve( dependencies );
942 // If all dependencies are met, execute ready immediately
943 if ( compare( filter( ['ready'], dependencies ), dependencies ) ) {
944 if ( $.isFunction( ready ) ) {
945 ready();
946 }
947 }
948 // If any dependencies have errors execute error immediately
949 else if ( filter( ['error'], dependencies ).length ) {
950 if ( $.isFunction( error ) ) {
951 error();
952 }
953 }
954 // Since some dependencies are not yet ready, queue up a request
955 else {
956 request( dependencies, ready, error );
957 }
958 };
959
960 /**
961 * Loads an external script or one or more modules for future use
962 *
963 * @param modules mixed either the name of a module, array of modules,
964 * or a URL of an external script or style
965 * @param type string mime-type to use if calling with a URL of an
966 * external script or style; acceptable values are "text/css" and
967 * "text/javascript"; if no type is provided, text/javascript is assumed.
968 */
969 this.load = function( modules, type ) {
970 // Validate input
971 if ( typeof modules !== 'object' && typeof modules !== 'string' ) {
972 throw new Error( 'modules must be a string or an array, not a ' + typeof modules );
973 }
974 // Allow calling with an external script or single dependency as a string
975 if ( typeof modules === 'string' ) {
976 // Support adding arbitrary external scripts
977 if ( modules.substr( 0, 7 ) === 'http://' || modules.substr( 0, 8 ) === 'https://' ) {
978 if ( type === 'text/css' ) {
979 $( 'head' ).append( $( '<link/>', {
980 rel: 'stylesheet',
981 type: 'text/css',
982 href: modules
983 } ) );
984 return true;
985 } else if ( type === 'text/javascript' || type === undefined ) {
986 addScript( modules );
987 return true;
988 }
989 // Unknown type
990 return false;
991 }
992 // Called with single module
993 modules = [modules];
994 }
995 // Resolve entire dependency map
996 modules = resolve( modules );
997 // If all modules are ready, nothing dependency be done
998 if ( compare( filter( ['ready'], modules ), modules ) ) {
999 return true;
1000 }
1001 // If any modules have errors return false
1002 else if ( filter( ['error'], modules ).length ) {
1003 return false;
1004 }
1005 // Since some modules are not yet ready, queue up a request
1006 else {
1007 request( modules );
1008 return true;
1009 }
1010 };
1011
1012 /**
1013 * Changes the state of a module
1014 *
1015 * @param module string module name or object of module name/state pairs
1016 * @param state string state name
1017 */
1018 this.state = function( module, state ) {
1019 if ( typeof module === 'object' ) {
1020 for ( var m in module ) {
1021 mw.loader.state( m, module[m] );
1022 }
1023 return;
1024 }
1025 if ( !( module in registry ) ) {
1026 mw.loader.register( module );
1027 }
1028 registry[module].state = state;
1029 };
1030
1031 /**
1032 * Gets the version of a module
1033 *
1034 * @param module string name of module to get version for
1035 */
1036 this.getVersion = function( module ) {
1037 if ( module in registry && 'version' in registry[module] ) {
1038 return formatVersionNumber( registry[module].version );
1039 }
1040 return null;
1041 };
1042
1043 /**
1044 * @deprecated use mw.loader.getVersion() instead
1045 */
1046 this.version = function() {
1047 return mw.loader.getVersion.apply( mw.loader, arguments );
1048 };
1049
1050 /**
1051 * Gets the state of a module
1052 *
1053 * @param module string name of module to get state for
1054 */
1055 this.getState = function( module ) {
1056 if ( module in registry && 'state' in registry[module] ) {
1057 return registry[module].state;
1058 }
1059 return null;
1060 };
1061
1062 /* Cache document ready status */
1063
1064 $(document).ready( function() { ready = true; } );
1065 } )();
1066
1067 /** HTML construction helper functions */
1068 this.html = new ( function () {
1069 var escapeCallback = function( s ) {
1070 switch ( s ) {
1071 case "'":
1072 return '&#039;';
1073 case '"':
1074 return '&quot;';
1075 case '<':
1076 return '&lt;';
1077 case '>':
1078 return '&gt;';
1079 case '&':
1080 return '&amp;';
1081 }
1082 };
1083
1084 /**
1085 * Escape a string for HTML. Converts special characters to HTML entities.
1086 * @param s The string to escape
1087 */
1088 this.escape = function( s ) {
1089 return s.replace( /['"<>&]/g, escapeCallback );
1090 };
1091
1092 /**
1093 * Wrapper object for raw HTML passed to mw.html.element().
1094 */
1095 this.Raw = function( value ) {
1096 this.value = value;
1097 };
1098
1099 /**
1100 * Wrapper object for CDATA element contents passed to mw.html.element()
1101 */
1102 this.Cdata = function( value ) {
1103 this.value = value;
1104 };
1105
1106 /**
1107 * Create an HTML element string, with safe escaping.
1108 *
1109 * @param name The tag name.
1110 * @param attrs An object with members mapping element names to values
1111 * @param contents The contents of the element. May be either:
1112 * - string: The string is escaped.
1113 * - null or undefined: The short closing form is used, e.g. <br/>.
1114 * - this.Raw: The value attribute is included without escaping.
1115 * - this.Cdata: The value attribute is included, and an exception is
1116 * thrown if it contains an illegal ETAGO delimiter.
1117 * See http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.3.2
1118 *
1119 * Example:
1120 * var h = mw.html;
1121 * return h.element( 'div', {},
1122 * new h.Raw( h.element( 'img', {src: '<'} ) ) );
1123 * Returns <div><img src="&lt;"/></div>
1124 */
1125 this.element = function( name, attrs, contents ) {
1126 var s = '<' + name;
1127 for ( var attrName in attrs ) {
1128 s += ' ' + attrName + '="' + this.escape( attrs[attrName] ) + '"';
1129 }
1130 if ( contents === undefined || contents === null ) {
1131 // Self close tag
1132 s += '/>';
1133 return s;
1134 }
1135 // Regular open tag
1136 s += '>';
1137 if ( typeof contents === 'string' ) {
1138 // Escaped
1139 s += this.escape( contents );
1140 } else if ( contents instanceof this.Raw ) {
1141 // Raw HTML inclusion
1142 s += contents.value;
1143 } else if ( contents instanceof this.Cdata ) {
1144 // CDATA
1145 if ( /<\/[a-zA-z]/.test( contents.value ) ) {
1146 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
1147 }
1148 s += contents.value;
1149 } else {
1150 throw new Error( 'mw.html.element: Invalid type of contents' );
1151 }
1152 s += '</' + name + '>';
1153 return s;
1154 };
1155 } )();
1156
1157 /* Extension points */
1158
1159 this.legacy = {};
1160
1161 } )( jQuery );
1162
1163 // Alias $j to jQuery for backwards compatibility
1164 window.$j = jQuery;
1165
1166 /* Auto-register from pre-loaded startup scripts */
1167
1168 if ( jQuery.isFunction( startUp ) ) {
1169 startUp();
1170 delete startUp;
1171 }