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