1 /*jslint browser: true, continue: true, white: true, forin: true*/
4 * Core MediaWiki JavaScript Library
7 var mw
= ( function ( $, undefined ) {
12 var hasOwn
= Object
.prototype.hasOwnProperty
;
13 /* Object constructors */
18 * Creates an object that can be read from or written to from prototype functions
19 * that allow both single and multiple variables at once.
21 * @param global boolean Whether to store the values in the global window
22 * object or a exclusively in the object property 'values'.
25 function Map( global
) {
26 this.values
= global
=== true ? window
: {};
32 * Get the value of one or multiple a keys.
34 * If called with no arguments, all values will be returned.
36 * @param selection mixed String key or array of keys to get values for.
37 * @param fallback mixed Value to use in case key(s) do not exist (optional).
38 * @return mixed If selection was a string returns the value or null,
39 * If selection was an array, returns an object of key/values (value is null if not found),
40 * If selection was not passed or invalid, will return the 'values' object member (be careful as
41 * objects are always passed by reference in JavaScript!).
42 * @return Values as a string or object, null if invalid/inexistant.
44 get: function ( selection
, fallback
) {
47 if ( $.isArray( selection
) ) {
48 selection
= $.makeArray( selection
);
50 for ( i
= 0; i
< selection
.length
; i
+= 1 ) {
51 results
[selection
[i
]] = this.get( selection
[i
], fallback
);
56 if ( typeof selection
=== 'string' ) {
57 if ( this.values
[selection
] === undefined ) {
58 if ( fallback
!== undefined ) {
63 return this.values
[selection
];
66 if ( selection
=== undefined ) {
70 // invalid selection key
75 * Sets one or multiple key/value pairs.
77 * @param selection {mixed} String key or array of keys to set values for.
78 * @param value {mixed} Value to set (optional, only in use when key is a string)
79 * @return {Boolean} This returns true on success, false on failure.
81 set: function ( selection
, value
) {
84 if ( $.isPlainObject( selection
) ) {
85 for ( s
in selection
) {
86 this.values
[s
] = selection
[s
];
90 if ( typeof selection
=== 'string' && value
!== undefined ) {
91 this.values
[selection
] = value
;
98 * Checks if one or multiple keys exist.
100 * @param selection {mixed} String key or array of keys to check
101 * @return {Boolean} Existence of key(s)
103 exists: function ( selection
) {
106 if ( $.isArray( selection
) ) {
107 for ( s
= 0; s
< selection
.length
; s
+= 1 ) {
108 if ( this.values
[selection
[s
]] === undefined ) {
114 return this.values
[selection
] !== undefined;
121 * Object constructor for messages,
122 * similar to the Message class in MediaWiki PHP.
124 * @param map Map Instance of mw.Map
126 * @param parameters Array
129 function Message( map
, key
, parameters
) {
130 this.format
= 'plain';
133 this.parameters
= parameters
=== undefined ? [] : $.makeArray( parameters
);
137 Message
.prototype = {
139 * Simple message parser, does $N replacement and nothing else.
140 * This may be overridden to provide a more complex message parser.
142 * This function will not be called for nonexistent messages.
145 var parameters
= this.parameters
;
146 return this.map
.get( this.key
).replace( /\$(\d+)/g, function ( str
, match
) {
147 var index
= parseInt( match
, 10 ) - 1;
148 return parameters
[index
] !== undefined ? parameters
[index
] : '$' + match
;
153 * Appends (does not replace) parameters for replacement to the .parameters property.
155 * @param parameters Array
158 params: function ( parameters
) {
160 for ( i
= 0; i
< parameters
.length
; i
+= 1 ) {
161 this.parameters
.push( parameters
[i
] );
167 * Converts message object to it's string form based on the state of format.
169 * @return string Message as a string in the current form or <key> if key does not exist.
171 toString: function() {
174 if ( !this.exists() ) {
175 // Use <key> as text if key does not exist
176 if ( this.format
!== 'plain' ) {
177 // format 'escape' and 'parse' need to have the brackets and key html escaped
178 return mw
.html
.escape( '<' + this.key
+ '>' );
180 return '<' + this.key
+ '>';
183 if ( this.format
=== 'plain' ) {
184 // @todo FIXME: Although not applicable to core Message,
185 // Plugins like jQueryMsg should be able to distinguish
186 // between 'plain' (only variable replacement and plural/gender)
187 // and actually parsing wikitext to HTML.
188 text
= this.parser();
191 if ( this.format
=== 'escaped' ) {
192 text
= this.parser();
193 text
= mw
.html
.escape( text
);
196 if ( this.format
=== 'parse' ) {
197 text
= this.parser();
204 * Changes format to parse and converts message to string
206 * @return {string} String form of parsed message
209 this.format
= 'parse';
210 return this.toString();
214 * Changes format to plain and converts message to string
216 * @return {string} String form of plain message
219 this.format
= 'plain';
220 return this.toString();
224 * Changes the format to html escaped and converts message to string
226 * @return {string} String form of html escaped message
228 escaped: function() {
229 this.format
= 'escaped';
230 return this.toString();
234 * Checks if message exists
236 * @return {string} String form of parsed message
239 return this.map
.exists( this.key
);
247 * Dummy function which in debug mode can be replaced with a function that
248 * emulates console.log in console-less environments.
253 * @var constructor Make the Map constructor publicly available.
258 * @var constructor Make the Message constructor publicly available.
263 * List of configuration values
265 * Dummy placeholder. Initiated in startUp module as a new instance of mw.Map().
266 * If $wgLegacyJavaScriptGlobals is true, this Map will have its values
267 * in the global window object.
274 * Empty object that plugins can be installed in.
278 /* Extension points */
283 * Localization system
290 * Gets a message object, similar to wfMessage()
292 * @param key string Key of message to get
293 * @param parameter_1 mixed First argument in a list of variadic arguments,
294 * each a parameter for $N replacement in messages.
297 message: function ( key
, parameter_1
/* [, parameter_2] */ ) {
299 // Support variadic arguments
300 if ( parameter_1
!== undefined ) {
301 parameters
= $.makeArray( arguments
);
306 return new Message( mw
.messages
, key
, parameters
);
310 * Gets a message string, similar to wfMsg()
312 * @param key string Key of message to get
313 * @param parameters mixed First argument in a list of variadic arguments,
314 * each a parameter for $N replacement in messages.
317 msg: function ( /* key, parameter_1, parameter_2, .. */ ) {
318 return mw
.message
.apply( mw
.message
, arguments
).toString();
322 * Client-side module loader which integrates with the MediaWiki ResourceLoader
324 loader
: ( function () {
326 /* Private Members */
329 * Mapping of registered modules
331 * The jquery module is pre-registered, because it must have already
332 * been provided for this object to have been built, and in debug mode
333 * jquery would have been provided through a unique loader request,
334 * making it impossible to hold back registration of jquery until after
337 * For exact details on support for script, style and messages, look at
338 * mw.loader.implement.
343 * 'version': ############## (unix timestamp),
344 * 'dependencies': ['required.foo', 'bar.also', ...], (or) function() {}
345 * 'group': 'somegroup', (or) null,
346 * 'source': 'local', 'someforeignwiki', (or) null
347 * 'state': 'registered', 'loading', 'loaded', 'ready', 'error' or 'missing'
350 * 'messages': { 'key': 'value' },
356 * Mapping of sources, keyed by source-id, values are objects.
360 * 'loadScript': 'http://foo.bar/w/load.php'
365 // List of modules which will be loaded as when ready
367 // List of modules to be loaded
369 // List of callback functions waiting for modules to be ready to be called
371 // Flag indicating that document ready has occured
373 // Selector cache for the marker element. Use getMarker() to get/use the marker!
376 /* Cache document ready status */
378 $(document
).ready( function () {
382 /* Private methods */
384 function getMarker() {
390 $marker
= $( 'meta[name="ResourceLoaderDynamicStyles"]' );
391 if ( $marker
.length
) {
394 mw
.log( 'getMarker> No <meta name="ResourceLoaderDynamicStyles"> found, inserting dynamically.' );
395 $marker
= $( '<meta>' ).attr( 'name', 'ResourceLoaderDynamicStyles' ).appendTo( 'head' );
401 * Create a new style tag and add it to the DOM.
403 * @param text String: CSS text
404 * @param $nextnode mixed: [optional] An Element or jQuery object for an element where
405 * the style tag should be inserted before. Otherwise appended to the <head>.
406 * @return HTMLStyleElement
408 function addStyleTag( text
, $nextnode
) {
409 var s
= document
.createElement( 'style' );
411 s
.rel
= 'stylesheet';
412 // Insert into document before setting cssText (bug 33305)
414 // If a raw element, create a jQuery object, otherwise use directly
415 if ( $nextnode
.nodeType
) {
416 $nextnode
= $( $nextnode
);
418 $nextnode
.before( s
);
420 document
.getElementsByTagName('head')[0].appendChild( s
);
422 if ( s
.styleSheet
) {
423 s
.styleSheet
.cssText
= text
; // IE
425 // Safari sometimes borks on null
426 s
.appendChild( document
.createTextNode( String( text
) ) );
431 function addInlineCSS( css
) {
432 var $style
, style
, $newStyle
;
433 $style
= getMarker().prev();
434 // Disable <style> tag recycling/concatenation because of bug 34669
435 if ( false && $style
.is( 'style' ) && $style
.data( 'ResourceLoaderDynamicStyleTag' ) === true ) {
436 // There's already a dynamic <style> tag present, append to it. This recycling of
437 // <style> tags is for bug 31676 (can't have more than 32 <style> tags in IE)
438 style
= $style
.get( 0 );
439 if ( style
.styleSheet
) {
440 style
.styleSheet
.cssText
+= css
; // IE
442 style
.appendChild( document
.createTextNode( String( css
) ) );
445 $newStyle
= $( addStyleTag( css
, getMarker() ) )
446 .data( 'ResourceLoaderDynamicStyleTag', true );
450 function compare( a
, b
) {
452 if ( a
.length
!== b
.length
) {
455 for ( i
= 0; i
< b
.length
; i
+= 1 ) {
456 if ( $.isArray( a
[i
] ) ) {
457 if ( !compare( a
[i
], b
[i
] ) ) {
461 if ( a
[i
] !== b
[i
] ) {
469 * Generates an ISO8601 "basic" string from a UNIX timestamp
471 function formatVersionNumber( timestamp
) {
472 var pad = function ( a
, b
, c
) {
473 return [a
< 10 ? '0' + a
: a
, b
< 10 ? '0' + b
: b
, c
< 10 ? '0' + c
: c
].join( '' );
476 d
.setTime( timestamp
* 1000 );
478 pad( d
.getUTCFullYear(), d
.getUTCMonth() + 1, d
.getUTCDate() ), 'T',
479 pad( d
.getUTCHours(), d
.getUTCMinutes(), d
.getUTCSeconds() ), 'Z'
484 * Recursively resolves dependencies and detects circular references
486 function recurse( module
, resolved
, unresolved
) {
489 if ( registry
[module
] === undefined ) {
490 throw new Error( 'Unknown dependency: ' + module
);
492 // Resolves dynamic loader function and replaces it with its own results
493 if ( $.isFunction( registry
[module
].dependencies
) ) {
494 registry
[module
].dependencies
= registry
[module
].dependencies();
495 // Ensures the module's dependencies are always in an array
496 if ( typeof registry
[module
].dependencies
!== 'object' ) {
497 registry
[module
].dependencies
= [registry
[module
].dependencies
];
500 // Tracks down dependencies
501 deps
= registry
[module
].dependencies
;
503 for ( n
= 0; n
< len
; n
+= 1 ) {
504 if ( $.inArray( deps
[n
], resolved
) === -1 ) {
505 if ( $.inArray( deps
[n
], unresolved
) !== -1 ) {
507 'Circular reference detected: ' + module
+
513 unresolved
[unresolved
.length
] = module
;
514 recurse( deps
[n
], resolved
, unresolved
);
515 // module is at the end of unresolved
519 resolved
[resolved
.length
] = module
;
523 * Gets a list of module names that a module depends on in their proper dependency order
525 * @param module string module name or array of string module names
526 * @return list of dependencies, including 'module'.
527 * @throws Error if circular reference is detected
529 function resolve( module
) {
530 var modules
, m
, deps
, n
, resolved
;
532 // Allow calling with an array of module names
533 if ( $.isArray( module
) ) {
535 for ( m
= 0; m
< module
.length
; m
+= 1 ) {
536 deps
= resolve( module
[m
] );
537 for ( n
= 0; n
< deps
.length
; n
+= 1 ) {
538 modules
[modules
.length
] = deps
[n
];
544 if ( typeof module
=== 'string' ) {
546 recurse( module
, resolved
, [] );
550 throw new Error( 'Invalid module argument: ' + module
);
554 * Narrows a list of module names down to those matching a specific
555 * state (see comment on top of this scope for a list of valid states).
556 * One can also filter for 'unregistered', which will return the
557 * modules names that don't have a registry entry.
559 * @param states string or array of strings of module states to filter by
560 * @param modules array list of module names to filter (optional, by default the entire
562 * @return array list of filtered module names
564 function filter( states
, modules
) {
565 var list
, module
, s
, m
;
567 // Allow states to be given as a string
568 if ( typeof states
=== 'string' ) {
571 // If called without a list of modules, build and use a list of all modules
573 if ( modules
=== undefined ) {
575 for ( module
in registry
) {
576 modules
[modules
.length
] = module
;
579 // Build a list of modules which are in one of the specified states
580 for ( s
= 0; s
< states
.length
; s
+= 1 ) {
581 for ( m
= 0; m
< modules
.length
; m
+= 1 ) {
582 if ( registry
[modules
[m
]] === undefined ) {
583 // Module does not exist
584 if ( states
[s
] === 'unregistered' ) {
586 list
[list
.length
] = modules
[m
];
589 // Module exists, check state
590 if ( registry
[modules
[m
]].state
=== states
[s
] ) {
592 list
[list
.length
] = modules
[m
];
601 * Automatically executes jobs and modules which are pending with satistifed dependencies.
603 * This is used when dependencies are satisfied, such as when a module is executed.
605 function handlePending( module
) {
609 // Run jobs whose dependencies have just been met
610 for ( j
= 0; j
< jobs
.length
; j
+= 1 ) {
612 filter( 'ready', jobs
[j
].dependencies
),
613 jobs
[j
].dependencies
) )
615 var callback
= jobs
[j
].ready
;
618 if ( $.isFunction( callback
) ) {
623 // Execute modules whose dependencies have just been met
624 for ( r
in registry
) {
625 if ( registry
[r
].state
=== 'loaded' ) {
627 filter( ['ready'], registry
[r
].dependencies
),
628 registry
[r
].dependencies
) )
635 // Run error callbacks of jobs affected by this condition
636 for ( j
= 0; j
< jobs
.length
; j
+= 1 ) {
637 if ( $.inArray( module
, jobs
[j
].dependencies
) !== -1 ) {
638 if ( $.isFunction( jobs
[j
].error
) ) {
639 jobs
[j
].error( e
, module
);
650 * Adds a script tag to the DOM, either using document.write or low-level DOM manipulation,
651 * depending on whether document-ready has occured yet and whether we are in async mode.
653 * @param src String: URL to script, will be used as the src attribute in the script tag
654 * @param callback Function: Optional callback which will be run when the script is done
656 function addScript( src
, callback
, async
) {
657 var done
= false, script
, head
;
658 if ( ready
|| async
) {
659 // jQuery's getScript method is NOT better than doing this the old-fashioned way
660 // because jQuery will eval the script's code, and errors will not have sane
662 script
= document
.createElement( 'script' );
663 script
.setAttribute( 'src', src
);
664 script
.setAttribute( 'type', 'text/javascript' );
665 if ( $.isFunction( callback
) ) {
666 // Attach handlers for all browsers (based on jQuery.ajax)
667 script
.onload
= script
.onreadystatechange = function() {
673 || /loaded|complete/.test( script
.readyState
)
681 // Handle memory leak in IE. This seems to fail in
682 // IE7 sometimes (Permission Denied error when
683 // accessing script.parentNode) so wrap it in
686 script
.onload
= script
.onreadystatechange
= null;
687 if ( script
.parentNode
) {
688 script
.parentNode
.removeChild( script
);
691 // Dereference the script
698 if ( window
.opera
) {
699 // Appending to the <head> blocks rendering completely in Opera,
700 // so append to the <body> after document ready. This means the
701 // scripts only start loading after the document has been rendered,
702 // but so be it. Opera users don't deserve faster web pages if their
703 // browser makes it impossible
704 $( function() { document
.body
.appendChild( script
); } );
706 // IE-safe way of getting the <head> . document.documentElement.head doesn't
707 // work in scripts that run in the <head>
708 head
= document
.getElementsByTagName( 'head' )[0];
709 ( document
.body
|| head
).appendChild( script
);
712 document
.write( mw
.html
.element(
713 'script', { 'type': 'text/javascript', 'src': src
}, ''
715 if ( $.isFunction( callback
) ) {
716 // Document.write is synchronous, so this is called when it's done
717 // FIXME: that's a lie. doc.write isn't actually synchronous
724 * Executes a loaded module, making it ready to use
726 * @param module string module name to execute
728 function execute( module
, callback
) {
729 var style
, media
, i
, script
, markModuleReady
, nestedAddScript
;
731 if ( registry
[module
] === undefined ) {
732 throw new Error( 'Module has not been registered yet: ' + module
);
733 } else if ( registry
[module
].state
=== 'registered' ) {
734 throw new Error( 'Module has not been requested from the server yet: ' + module
);
735 } else if ( registry
[module
].state
=== 'loading' ) {
736 throw new Error( 'Module has not completed loading yet: ' + module
);
737 } else if ( registry
[module
].state
=== 'ready' ) {
738 throw new Error( 'Module has already been loaded: ' + module
);
742 if ( $.isPlainObject( registry
[module
].style
) ) {
743 // 'media' type ignored, see documentation of mw.loader.implement
744 for ( media
in registry
[module
].style
) {
745 style
= registry
[module
].style
[media
];
746 if ( $.isArray( style
) ) {
747 for ( i
= 0; i
< style
.length
; i
+= 1 ) {
748 getMarker().before( mw
.html
.element( 'link', {
754 } else if ( typeof style
=== 'string' ) {
755 addInlineCSS( style
);
759 // Add localizations to message system
760 if ( $.isPlainObject( registry
[module
].messages
) ) {
761 mw
.messages
.set( registry
[module
].messages
);
765 script
= registry
[module
].script
;
766 markModuleReady = function() {
767 registry
[module
].state
= 'ready';
768 handlePending( module
);
769 if ( $.isFunction( callback
) ) {
773 nestedAddScript = function ( arr
, callback
, async
, i
) {
774 // Recursively call addScript() in its own callback
775 // for each element of arr.
776 if ( i
>= arr
.length
) {
777 // We're at the end of the array
782 addScript( arr
[i
], function() {
783 nestedAddScript( arr
, callback
, async
, i
+ 1 );
787 if ( $.isArray( script
) ) {
788 registry
[module
].state
= 'loading';
789 nestedAddScript( script
, markModuleReady
, registry
[module
].async
, 0 );
790 } else if ( $.isFunction( script
) ) {
795 // This needs to NOT use mw.log because these errors are common in production mode
796 // and not in debug mode, such as when a symbol that should be global isn't exported
797 if ( window
.console
&& typeof window
.console
.log
=== 'function' ) {
798 console
.log( 'mw.loader::execute> Exception thrown by ' + module
+ ': ' + e
.message
);
801 registry
[module
].state
= 'error';
806 * Adds a dependencies to the queue with optional callbacks to be run
807 * when the dependencies are ready or fail
809 * @param dependencies string module name or array of string module names
810 * @param ready function callback to execute when all dependencies are ready
811 * @param error function callback to execute when any dependency fails
812 * @param async (optional) If true, load modules asynchronously even if
813 * document ready has not yet occurred
815 function request( dependencies
, ready
, error
, async
) {
816 var regItemDeps
, regItemDepLen
, n
;
818 // Allow calling by single module name
819 if ( typeof dependencies
=== 'string' ) {
820 dependencies
= [dependencies
];
821 if ( registry
[dependencies
[0]] !== undefined ) {
822 // Cache repetitively accessed deep level object member
823 regItemDeps
= registry
[dependencies
[0]].dependencies
;
824 // Cache to avoid looped access to length property
825 regItemDepLen
= regItemDeps
.length
;
826 for ( n
= 0; n
< regItemDepLen
; n
+= 1 ) {
827 dependencies
[dependencies
.length
] = regItemDeps
[n
];
832 // Add ready and error callbacks if they were given
833 if ( ready
!== undefined || error
!== undefined ) {
834 jobs
[jobs
.length
] = {
835 'dependencies': filter(
836 ['registered', 'loading', 'loaded'],
844 // Queue up any dependencies that are registered
845 dependencies
= filter( ['registered'], dependencies
);
846 for ( n
= 0; n
< dependencies
.length
; n
+= 1 ) {
847 if ( $.inArray( dependencies
[n
], queue
) === -1 ) {
848 queue
[queue
.length
] = dependencies
[n
];
850 // Mark this module as async in the registry
851 registry
[dependencies
[n
]].async
= true;
860 function sortQuery(o
) {
861 var sorted
= {}, key
, a
= [];
863 if ( hasOwn
.call( o
, key
) ) {
868 for ( key
= 0; key
< a
.length
; key
+= 1 ) {
869 sorted
[a
[key
]] = o
[a
[key
]];
875 * Converts a module map of the form { foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }
876 * to a query string of the form foo.bar,baz|bar.baz,quux
878 function buildModulesString( moduleMap
) {
879 var arr
= [], p
, prefix
;
880 for ( prefix
in moduleMap
) {
881 p
= prefix
=== '' ? '' : prefix
+ '.';
882 arr
.push( p
+ moduleMap
[prefix
].join( ',' ) );
884 return arr
.join( '|' );
888 * Asynchronously append a script tag to the end of the body
889 * that invokes load.php
890 * @param moduleMap {Object}: Module map, see buildModulesString()
891 * @param currReqBase {Object}: Object with other parameters (other than 'modules') to use in the request
892 * @param sourceLoadScript {String}: URL of load.php
893 * @param async {Boolean}: If true, use an asynchrounous request even if document ready has not yet occurred
895 function doRequest( moduleMap
, currReqBase
, sourceLoadScript
, async
) {
896 var request
= $.extend(
897 { 'modules': buildModulesString( moduleMap
) },
900 request
= sortQuery( request
);
901 // Asynchronously append a script tag to the end of the body
902 // Append &* to avoid triggering the IE6 extension check
903 addScript( sourceLoadScript
+ '?' + $.param( request
) + '&*', null, async
);
908 addStyleTag
: addStyleTag
,
911 * Requests dependencies from server, loading and executing when things when ready.
914 var reqBase
, splits
, maxQueryLength
, q
, b
, bSource
, bGroup
, bSourceGroup
,
915 source
, group
, g
, i
, modules
, maxVersion
, sourceLoadScript
,
916 currReqBase
, currReqBaseLength
, moduleMap
, l
,
917 lastDotIndex
, prefix
, suffix
, bytesAdded
, async
;
919 // Build a list of request parameters common to all requests.
921 skin
: mw
.config
.get( 'skin' ),
922 lang
: mw
.config
.get( 'wgUserLanguage' ),
923 debug
: mw
.config
.get( 'debug' )
925 // Split module batch by source and by group.
927 maxQueryLength
= mw
.config
.get( 'wgResourceLoaderMaxQueryLength', -1 );
929 // Appends a list of modules from the queue to the batch
930 for ( q
= 0; q
< queue
.length
; q
+= 1 ) {
931 // Only request modules which are registered
932 if ( registry
[queue
[q
]] !== undefined && registry
[queue
[q
]].state
=== 'registered' ) {
933 // Prevent duplicate entries
934 if ( $.inArray( queue
[q
], batch
) === -1 ) {
935 batch
[batch
.length
] = queue
[q
];
936 // Mark registered modules as loading
937 registry
[queue
[q
]].state
= 'loading';
941 // Early exit if there's nothing to load...
942 if ( !batch
.length
) {
946 // The queue has been processed into the batch, clear up the queue.
949 // Always order modules alphabetically to help reduce cache
950 // misses for otherwise identical content.
953 // Split batch by source and by group.
954 for ( b
= 0; b
< batch
.length
; b
+= 1 ) {
955 bSource
= registry
[batch
[b
]].source
;
956 bGroup
= registry
[batch
[b
]].group
;
957 if ( splits
[bSource
] === undefined ) {
958 splits
[bSource
] = {};
960 if ( splits
[bSource
][bGroup
] === undefined ) {
961 splits
[bSource
][bGroup
] = [];
963 bSourceGroup
= splits
[bSource
][bGroup
];
964 bSourceGroup
[bSourceGroup
.length
] = batch
[b
];
967 // Clear the batch - this MUST happen before we append any
968 // script elements to the body or it's possible that a script
969 // will be locally cached, instantly load, and work the batch
970 // again, all before we've cleared it causing each request to
971 // include modules which are already loaded.
974 for ( source
in splits
) {
976 sourceLoadScript
= sources
[source
].loadScript
;
978 for ( group
in splits
[source
] ) {
980 // Cache access to currently selected list of
981 // modules for this group from this source.
982 modules
= splits
[source
][group
];
984 // Calculate the highest timestamp
986 for ( g
= 0; g
< modules
.length
; g
+= 1 ) {
987 if ( registry
[modules
[g
]].version
> maxVersion
) {
988 maxVersion
= registry
[modules
[g
]].version
;
992 currReqBase
= $.extend( { 'version': formatVersionNumber( maxVersion
) }, reqBase
);
993 currReqBaseLength
= $.param( currReqBase
).length
;
995 // We may need to split up the request to honor the query string length limit,
996 // so build it piece by piece.
997 l
= currReqBaseLength
+ 9; // '&modules='.length == 9
999 moduleMap
= {}; // { prefix: [ suffixes ] }
1001 for ( i
= 0; i
< modules
.length
; i
+= 1 ) {
1002 // Determine how many bytes this module would add to the query string
1003 lastDotIndex
= modules
[i
].lastIndexOf( '.' );
1004 // Note that these substr() calls work even if lastDotIndex == -1
1005 prefix
= modules
[i
].substr( 0, lastDotIndex
);
1006 suffix
= modules
[i
].substr( lastDotIndex
+ 1 );
1007 bytesAdded
= moduleMap
[prefix
] !== undefined
1008 ? suffix
.length
+ 3 // '%2C'.length == 3
1009 : modules
[i
].length
+ 3; // '%7C'.length == 3
1011 // If the request would become too long, create a new one,
1012 // but don't create empty requests
1013 if ( maxQueryLength
> 0 && !$.isEmptyObject( moduleMap
) && l
+ bytesAdded
> maxQueryLength
) {
1014 // This request would become too long, create a new one
1015 // and fire off the old one
1016 doRequest( moduleMap
, currReqBase
, sourceLoadScript
, async
);
1019 l
= currReqBaseLength
+ 9;
1021 if ( moduleMap
[prefix
] === undefined ) {
1022 moduleMap
[prefix
] = [];
1024 moduleMap
[prefix
].push( suffix
);
1025 if ( !registry
[modules
[i
]].async
) {
1026 // If this module is blocking, make the entire request blocking
1027 // This is slightly suboptimal, but in practice mixing of blocking
1028 // and async modules will only occur in debug mode.
1033 // If there's anything left in moduleMap, request that too
1034 if ( !$.isEmptyObject( moduleMap
) ) {
1035 doRequest( moduleMap
, currReqBase
, sourceLoadScript
, async
);
1042 * Register a source.
1044 * @param id {String}: Short lowercase a-Z string representing a source, only used internally.
1045 * @param props {Object}: Object containing only the loadScript property which is a url to
1046 * the load.php location of the source.
1049 addSource: function ( id
, props
) {
1051 // Allow multiple additions
1052 if ( typeof id
=== 'object' ) {
1053 for ( source
in id
) {
1054 mw
.loader
.addSource( source
, id
[source
] );
1059 if ( sources
[id
] !== undefined ) {
1060 throw new Error( 'source already registered: ' + id
);
1063 sources
[id
] = props
;
1069 * Registers a module, letting the system know about it and its
1070 * properties. Startup modules contain calls to this function.
1072 * @param module {String}: Module name
1073 * @param version {Number}: Module version number as a timestamp (falls backs to 0)
1074 * @param dependencies {String|Array|Function}: One string or array of strings of module
1075 * names on which this module depends, or a function that returns that array.
1076 * @param group {String}: Group which the module is in (optional, defaults to null)
1077 * @param source {String}: Name of the source. Defaults to local.
1079 register: function ( module
, version
, dependencies
, group
, source
) {
1081 // Allow multiple registration
1082 if ( typeof module
=== 'object' ) {
1083 for ( m
= 0; m
< module
.length
; m
+= 1 ) {
1084 // module is an array of module names
1085 if ( typeof module
[m
] === 'string' ) {
1086 mw
.loader
.register( module
[m
] );
1087 // module is an array of arrays
1088 } else if ( typeof module
[m
] === 'object' ) {
1089 mw
.loader
.register
.apply( mw
.loader
, module
[m
] );
1095 if ( typeof module
!== 'string' ) {
1096 throw new Error( 'module must be a string, not a ' + typeof module
);
1098 if ( registry
[module
] !== undefined ) {
1099 throw new Error( 'module already registered: ' + module
);
1101 // List the module as registered
1102 registry
[module
] = {
1103 'version': version
!== undefined ? parseInt( version
, 10 ) : 0,
1105 'group': typeof group
=== 'string' ? group
: null,
1106 'source': typeof source
=== 'string' ? source
: 'local',
1107 'state': 'registered'
1109 if ( typeof dependencies
=== 'string' ) {
1110 // Allow dependencies to be given as a single module name
1111 registry
[module
].dependencies
= [dependencies
];
1112 } else if ( typeof dependencies
=== 'object' || $.isFunction( dependencies
) ) {
1113 // Allow dependencies to be given as an array of module names
1114 // or a function which returns an array
1115 registry
[module
].dependencies
= dependencies
;
1120 * Implements a module, giving the system a course of action to take
1121 * upon loading. Results of a request for one or more modules contain
1122 * calls to this function.
1124 * All arguments are required.
1126 * @param module String: Name of module
1127 * @param script Mixed: Function of module code or String of URL to be used as the src
1128 * attribute when adding a script element to the body
1129 * @param style Object: Object of CSS strings keyed by media-type or Object of lists of URLs
1130 * keyed by media-type. Media-type should be "all" or "", actual types are not supported
1131 * right now due to the way execute() processes the stylesheets (they are concatenated
1132 * into a single <style> tag). In the past these weren't concatenated together (which is
1133 * these are keyed by media-type), but bug 31676 forces us to. In practice this is not a
1134 * problem because ResourceLoader only generates stylesheets for media-type all (e.g. print
1135 * stylesheets are wrapped in @media print {} and concatenated with the others).
1136 * @param msgs Object: List of key/value pairs to be passed through mw.messages.set
1138 implement: function ( module
, script
, style
, msgs
) {
1140 if ( typeof module
!== 'string' ) {
1141 throw new Error( 'module must be a string, not a ' + typeof module
);
1143 if ( !$.isFunction( script
) && !$.isArray( script
) ) {
1144 throw new Error( 'script must be a function or an array, not a ' + typeof script
);
1146 if ( !$.isPlainObject( style
) ) {
1147 throw new Error( 'style must be an object, not a ' + typeof style
);
1149 if ( !$.isPlainObject( msgs
) ) {
1150 throw new Error( 'msgs must be an object, not a ' + typeof msgs
);
1152 // Automatically register module
1153 if ( registry
[module
] === undefined ) {
1154 mw
.loader
.register( module
);
1156 // Check for duplicate implementation
1157 if ( registry
[module
] !== undefined && registry
[module
].script
!== undefined ) {
1158 throw new Error( 'module already implemented: ' + module
);
1160 // Mark module as loaded
1161 registry
[module
].state
= 'loaded';
1162 // Attach components
1163 registry
[module
].script
= script
;
1164 registry
[module
].style
= style
;
1165 registry
[module
].messages
= msgs
;
1166 // Execute or queue callback
1168 filter( ['ready'], registry
[module
].dependencies
),
1169 registry
[module
].dependencies
) )
1176 * Executes a function as soon as one or more required modules are ready
1178 * @param dependencies {String|Array} Module name or array of modules names the callback
1179 * dependends on to be ready before executing
1180 * @param ready {Function} callback to execute when all dependencies are ready (optional)
1181 * @param error {Function} callback to execute when if dependencies have a errors (optional)
1183 using: function ( dependencies
, ready
, error
) {
1184 var tod
= typeof dependencies
;
1186 if ( tod
!== 'object' && tod
!== 'string' ) {
1187 throw new Error( 'dependencies must be a string or an array, not a ' + tod
);
1189 // Allow calling with a single dependency as a string
1190 if ( tod
=== 'string' ) {
1191 dependencies
= [dependencies
];
1193 // Resolve entire dependency map
1194 dependencies
= resolve( dependencies
);
1195 // If all dependencies are met, execute ready immediately
1196 if ( compare( filter( ['ready'], dependencies
), dependencies
) ) {
1197 if ( $.isFunction( ready
) ) {
1201 // If any dependencies have errors execute error immediately
1202 else if ( filter( ['error'], dependencies
).length
) {
1203 if ( $.isFunction( error
) ) {
1204 error( new Error( 'one or more dependencies have state "error"' ),
1208 // Since some dependencies are not yet ready, queue up a request
1210 request( dependencies
, ready
, error
);
1215 * Loads an external script or one or more modules for future use
1217 * @param modules {mixed} Either the name of a module, array of modules,
1218 * or a URL of an external script or style
1219 * @param type {String} mime-type to use if calling with a URL of an
1220 * external script or style; acceptable values are "text/css" and
1221 * "text/javascript"; if no type is provided, text/javascript is assumed.
1222 * @param async {Boolean} (optional) If true, load modules asynchronously
1223 * even if document ready has not yet occurred. If false (default),
1224 * block before document ready and load async after. If not set, true will
1225 * be assumed if loading a URL, and false will be assumed otherwise.
1227 load: function ( modules
, type
, async
) {
1231 if ( typeof modules
!== 'object' && typeof modules
!== 'string' ) {
1232 throw new Error( 'modules must be a string or an array, not a ' + typeof modules
);
1234 // Allow calling with an external url or single dependency as a string
1235 if ( typeof modules
=== 'string' ) {
1236 // Support adding arbitrary external scripts
1237 if ( /^(https?:)?\/\//.test( modules
) ) {
1238 if ( async
=== undefined ) {
1239 // Assume async for bug 34542
1242 if ( type
=== 'text/css' ) {
1243 $( 'head' ).append( $( '<link>', {
1250 if ( type
=== 'text/javascript' || type
=== undefined ) {
1251 addScript( modules
, null, async
);
1255 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type
);
1257 // Called with single module
1258 modules
= [modules
];
1261 // Filter out undefined modules, otherwise resolve() will throw
1262 // an exception for trying to load an undefined module.
1263 // Undefined modules are acceptable here in load(), because load() takes
1264 // an array of unrelated modules, whereas the modules passed to
1265 // using() are related and must all be loaded.
1266 for ( filtered
= [], m
= 0; m
< modules
.length
; m
+= 1 ) {
1267 if ( registry
[modules
[m
]] !== undefined ) {
1268 filtered
[filtered
.length
] = modules
[m
];
1272 // Resolve entire dependency map
1273 filtered
= resolve( filtered
);
1274 // If all modules are ready, nothing dependency be done
1275 if ( compare( filter( ['ready'], filtered
), filtered
) ) {
1278 // If any modules have errors
1279 if ( filter( ['error'], filtered
).length
) {
1282 // Since some modules are not yet ready, queue up a request
1283 request( filtered
, null, null, async
);
1288 * Changes the state of a module
1290 * @param module {String|Object} module name or object of module name/state pairs
1291 * @param state {String} state name
1293 state: function ( module
, state
) {
1295 if ( typeof module
=== 'object' ) {
1296 for ( m
in module
) {
1297 mw
.loader
.state( m
, module
[m
] );
1301 if ( registry
[module
] === undefined ) {
1302 mw
.loader
.register( module
);
1304 registry
[module
].state
= state
;
1308 * Gets the version of a module
1310 * @param module string name of module to get version for
1312 getVersion: function ( module
) {
1313 if ( registry
[module
] !== undefined && registry
[module
].version
!== undefined ) {
1314 return formatVersionNumber( registry
[module
].version
);
1320 * @deprecated since 1.18 use mw.loader.getVersion() instead
1322 version: function () {
1323 return mw
.loader
.getVersion
.apply( mw
.loader
, arguments
);
1327 * Gets the state of a module
1329 * @param module string name of module to get state for
1331 getState: function ( module
) {
1332 if ( registry
[module
] !== undefined && registry
[module
].state
!== undefined ) {
1333 return registry
[module
].state
;
1339 * Get names of all registered modules.
1343 getModuleNames: function () {
1344 return $.map( registry
, function ( i
, key
) {
1350 * For backwards-compatibility with Squid-cached pages. Loads mw.user
1353 mw
.loader
.load( 'mediawiki.user' );
1358 /** HTML construction helper functions */
1359 html
: ( function () {
1360 function escapeCallback( s
) {
1377 * Escape a string for HTML. Converts special characters to HTML entities.
1378 * @param s The string to escape
1380 escape: function ( s
) {
1381 return s
.replace( /['"<>&]/g, escapeCallback
);
1385 * Wrapper object for raw HTML passed to mw.html.element().
1388 Raw: function ( value
) {
1393 * Wrapper object for CDATA element contents passed to mw.html.element()
1396 Cdata: function ( value
) {
1401 * Create an HTML element string, with safe escaping.
1403 * @param name The tag name.
1404 * @param attrs An object with members mapping element names to values
1405 * @param contents The contents of the element. May be either:
1406 * - string: The string is escaped.
1407 * - null or undefined: The short closing form is used, e.g. <br/>.
1408 * - this.Raw: The value attribute is included without escaping.
1409 * - this.Cdata: The value attribute is included, and an exception is
1410 * thrown if it contains an illegal ETAGO delimiter.
1411 * See http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.3.2
1415 * return h.element( 'div', {},
1416 * new h.Raw( h.element( 'img', {src: '<'} ) ) );
1417 * Returns <div><img src="<"/></div>
1419 element: function ( name
, attrs
, contents
) {
1420 var v
, attrName
, s
= '<' + name
;
1422 for ( attrName
in attrs
) {
1423 v
= attrs
[attrName
];
1424 // Convert name=true, to name=name
1428 } else if ( v
=== false ) {
1431 s
+= ' ' + attrName
+ '="' + this.escape( String( v
) ) + '"';
1433 if ( contents
=== undefined || contents
=== null ) {
1440 switch ( typeof contents
) {
1443 s
+= this.escape( contents
);
1447 // Convert to string
1448 s
+= String( contents
);
1451 if ( contents
instanceof this.Raw
) {
1452 // Raw HTML inclusion
1453 s
+= contents
.value
;
1454 } else if ( contents
instanceof this.Cdata
) {
1456 if ( /<\/[a-zA-z]/.test( contents
.value
) ) {
1457 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
1459 s
+= contents
.value
;
1461 throw new Error( 'mw.html.element: Invalid type of contents' );
1464 s
+= '</' + name
+ '>';
1470 // Skeleton user object. mediawiki.user.js extends this
1479 // Alias $j to jQuery for backwards compatibility
1482 // Attach to window and globally alias
1483 window
.mw
= window
.mediaWiki
= mw
;
1485 // Auto-register from pre-loaded startup scripts
1486 if ( jQuery
.isFunction( window
.startUp
) ) {
1488 window
.startUp
= undefined;