2 * Core MediaWiki JavaScript Library
5 var mw
= ( function ( $, undefined ) {
10 var hasOwn
= Object
.prototype.hasOwnProperty
;
11 /* Object constructors */
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.
19 * @param global boolean Whether to store the values in the global window
20 * object or a exclusively in the object property 'values'.
23 function Map( global
) {
24 this.values
= global
=== true ? window
: {};
30 * Get the value of one or multiple a keys.
32 * If called with no arguments, all values will be returned.
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.
42 get: function ( selection
, fallback
) {
45 if ( $.isArray( selection
) ) {
46 selection
= $.makeArray( selection
);
48 for ( i
= 0; i
< selection
.length
; i
+= 1 ) {
49 results
[selection
[i
]] = this.get( selection
[i
], fallback
);
52 } else if ( typeof selection
=== 'string' ) {
53 if ( this.values
[selection
] === undefined ) {
54 if ( fallback
!== undefined ) {
59 return this.values
[selection
];
61 if ( selection
=== undefined ) {
64 return null; // invalid selection key
69 * Sets one or multiple key/value pairs.
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.
75 set: function ( selection
, value
) {
78 if ( $.isPlainObject( selection
) ) {
79 for ( s
in selection
) {
80 this.values
[s
] = selection
[s
];
83 } else if ( typeof selection
=== 'string' && value
!== undefined ) {
84 this.values
[selection
] = value
;
91 * Checks if one or multiple keys exist.
93 * @param selection {mixed} String key or array of keys to check
94 * @return {Boolean} Existence of key(s)
96 exists: function ( selection
) {
99 if ( $.isArray( selection
) ) {
100 for ( s
= 0; s
< selection
.length
; s
+= 1 ) {
101 if ( this.values
[selection
[s
]] === undefined ) {
107 return this.values
[selection
] !== undefined;
115 * Object constructor for messages,
116 * similar to the Message class in MediaWiki PHP.
118 * @param map Map Instance of mw.Map
120 * @param parameters Array
123 function Message( map
, key
, parameters
) {
124 this.format
= 'plain';
127 this.parameters
= parameters
=== undefined ? [] : $.makeArray( parameters
);
131 Message
.prototype = {
133 * Simple message parser, does $N replacement and nothing else.
134 * This may be overridden to provide a more complex message parser.
136 * This function will not be called for nonexistent messages.
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
;
147 * Appends (does not replace) parameters for replacement to the .parameters property.
149 * @param parameters Array
152 params: function ( parameters
) {
154 for ( i
= 0; i
< parameters
.length
; i
+= 1 ) {
155 this.parameters
.push( parameters
[i
] );
161 * Converts message object to it's string form based on the state of format.
163 * @return string Message as a string in the current form or <key> if key does not exist.
165 toString: function() {
166 if ( !this.exists( ) ) {
167 // Use <key> as text if key does not exist
168 if ( this.format
!== 'plain' ) {
169 // format 'escape' and 'parse' need to have the brackets and key html escaped
170 return mw
.html
.escape( '<' + this.key
+ '>' );
172 return '<' + this.key
+ '>';
176 if ( this.format
=== 'plain' ) {
177 // FIXME this is wrong. There should be a way
178 // to tell parser() whether we're looking for
179 // plain text or HTML, but I don't know jQueryMsg
180 // well enough to implement this.
181 // Currently it always outputs HTML
182 text
= this.parser();
185 if ( this.format
=== 'escaped' ) {
186 text
= this.parser();
187 text
= mw
.html
.escape( text
);
190 if ( this.format
=== 'parse' ) {
191 text
= this.parser();
198 * Changes format to parse and converts message to string
200 * @return {string} String form of parsed message
203 this.format
= 'parse';
204 return this.toString();
208 * Changes format to plain and converts message to string
210 * @return {string} String form of plain message
213 this.format
= 'plain';
214 return this.toString();
218 * Changes the format to html escaped and converts message to string
220 * @return {string} String form of html escaped message
222 escaped: function() {
223 this.format
= 'escaped';
224 return this.toString();
228 * Checks if message exists
230 * @return {string} String form of parsed message
233 return this.map
.exists( this.key
);
241 * Dummy function which in debug mode can be replaced with a function that
242 * emulates console.log in console-less environments.
247 * @var constructor Make the Map constructor publicly available.
252 * @var constructor Make the Message constructor publicly available.
257 * List of configuration values
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.
268 * Empty object that plugins can be installed in.
272 /* Extension points */
277 * Localization system
284 * Gets a message object, similar to wfMessage()
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.
291 message: function ( key
, parameter_1
/* [, parameter_2] */ ) {
293 // Support variadic arguments
294 if ( parameter_1
!== undefined ) {
295 parameters
= $.makeArray( arguments
);
300 return new Message( mw
.messages
, key
, parameters
);
304 * Gets a message string, similar to wfMsg()
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.
311 msg: function ( key
, parameters
) {
312 return mw
.message
.apply( mw
.message
, arguments
).toString();
316 * Client-side module loader which integrates with the MediaWiki ResourceLoader
318 loader
: ( function() {
320 /* Private Members */
323 * Mapping of registered modules
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
331 * For exact details on support for script, style and messages, look at
332 * mw.loader.implement.
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'
344 * 'messages': { 'key': 'value' },
350 * Mapping of sources, keyed by source-id, values are objects.
354 * 'loadScript': 'http://foo.bar/w/load.php'
359 // List of modules which will be loaded as when ready
361 // List of modules to be loaded
363 // List of callback functions waiting for modules to be ready to be called
365 // Flag indicating that document ready has occured
367 // Whether we should try to load scripts in a blocking way
368 // Set with setBlocking()
370 // Selector cache for the marker element. Use getMarker() to get/use the marker!
373 /* Cache document ready status */
375 $(document
).ready( function () {
379 /* Private methods */
381 function getMarker(){
386 $marker
= $( 'meta[name="ResourceLoaderDynamicStyles"]' );
387 if ( $marker
.length
) {
390 mw
.log( 'getMarker> No <meta name="ResourceLoaderDynamicStyles"> found, inserting dynamically.' );
391 $marker
= $( '<meta>' ).attr( 'name', 'ResourceLoaderDynamicStyles' ).appendTo( 'head' );
396 function compare( a
, b
) {
398 if ( a
.length
!== b
.length
) {
401 for ( i
= 0; i
< b
.length
; i
+= 1 ) {
402 if ( $.isArray( a
[i
] ) ) {
403 if ( !compare( a
[i
], b
[i
] ) ) {
407 if ( a
[i
] !== b
[i
] ) {
415 * Generates an ISO8601 "basic" string from a UNIX timestamp
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( '' );
422 d
.setTime( timestamp
* 1000 );
424 pad( d
.getUTCFullYear(), d
.getUTCMonth() + 1, d
.getUTCDate() ), 'T',
425 pad( d
.getUTCHours(), d
.getUTCMinutes(), d
.getUTCSeconds() ), 'Z'
430 * Recursively resolves dependencies and detects circular references
432 function recurse( module
, resolved
, unresolved
) {
435 if ( registry
[module
] === undefined ) {
436 throw new Error( 'Unknown dependency: ' + module
);
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
];
446 // Tracks down dependencies
447 deps
= registry
[module
].dependencies
;
449 for ( n
= 0; n
< len
; n
+= 1 ) {
450 if ( $.inArray( deps
[n
], resolved
) === -1 ) {
451 if ( $.inArray( deps
[n
], unresolved
) !== -1 ) {
453 'Circular reference detected: ' + module
+
459 unresolved
[unresolved
.length
] = module
;
460 recurse( deps
[n
], resolved
, unresolved
);
461 // module is at the end of unresolved
465 resolved
[resolved
.length
] = module
;
469 * Gets a list of module names that a module depends on in their proper dependency order
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
475 function resolve( module
) {
476 var modules
, m
, deps
, n
, resolved
;
478 // Allow calling with an array of module names
479 if ( $.isArray( module
) ) {
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
];
488 } else if ( typeof module
=== 'string' ) {
490 recurse( module
, resolved
, [] );
493 throw new Error( 'Invalid module argument: ' + module
);
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.
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
505 * @return array list of filtered module names
507 function filter( states
, modules
) {
508 var list
, module
, s
, m
;
510 // Allow states to be given as a string
511 if ( typeof states
=== 'string' ) {
514 // If called without a list of modules, build and use a list of all modules
516 if ( modules
=== undefined ) {
518 for ( module
in registry
) {
519 modules
[modules
.length
] = module
;
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' ) {
529 list
[list
.length
] = modules
[m
];
532 // Module exists, check state
533 if ( registry
[modules
[m
]].state
=== states
[s
] ) {
535 list
[list
.length
] = modules
[m
];
544 * Automatically executes jobs and modules which are pending with satistifed dependencies.
546 * This is used when dependencies are satisfied, such as when a module is executed.
548 function handlePending( module
) {
552 // Run jobs who's dependencies have just been met
553 for ( j
= 0; j
< jobs
.length
; j
+= 1 ) {
555 filter( 'ready', jobs
[j
].dependencies
),
556 jobs
[j
].dependencies
) )
558 if ( $.isFunction( jobs
[j
].ready
) ) {
565 // Execute modules who's dependencies have just been met
566 for ( r
in registry
) {
567 if ( registry
[r
].state
=== 'loaded' ) {
569 filter( ['ready'], registry
[r
].dependencies
),
570 registry
[r
].dependencies
) )
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
);
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.
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
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
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() {
614 || /loaded|complete/.test( script
.readyState
)
620 // Handle memory leak in IE
621 script
.onload
= script
.onreadystatechange
= null;
625 if ( script
.parentNode
) {
626 script
.parentNode
.removeChild( script
);
629 // Dereference the script
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
); } );
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
);
649 document
.write( mw
.html
.element(
650 'script', { 'type': 'text/javascript', 'src': src
}, ''
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
661 * Executes a loaded module, making it ready to use
663 * @param module string module name to execute
665 function execute( module
, callback
) {
666 var style
, media
, i
, script
, markModuleReady
, nestedAddScript
;
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
);
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', {
691 } else if ( typeof style
=== 'string' ) {
692 getMarker().before( mw
.html
.element( 'style', {
695 }, new mw
.html
.Cdata( style
) ) );
699 // Add localizations to message system
700 if ( $.isPlainObject( registry
[module
].messages
) ) {
701 mw
.messages
.set( registry
[module
].messages
);
705 script
= registry
[module
].script
;
706 markModuleReady = function() {
707 registry
[module
].state
= 'ready';
708 handlePending( module
);
709 if ( $.isFunction( callback
) ) {
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
722 addScript( arr
[i
], function() {
723 nestedAddScript( arr
, callback
, i
+ 1 );
727 if ( $.isArray( script
) ) {
728 registry
[module
].state
= 'loading';
729 nestedAddScript( script
, markModuleReady
, 0 );
730 } else if ( $.isFunction( script
) ) {
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
);
740 registry
[module
].state
= 'error';
746 * Adds a dependencies to the queue with optional callbacks to be run
747 * when the dependencies are ready or fail
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
753 function request( dependencies
, ready
, error
) {
754 var regItemDeps
, regItemDepLen
, n
;
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
];
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'],
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
];
791 function sortQuery(o
) {
792 var sorted
= {}, key
, a
= [];
794 if ( hasOwn
.call( o
, key
) ) {
799 for ( key
= 0; key
< a
.length
; key
+= 1 ) {
800 sorted
[a
[key
]] = o
[a
[key
]];
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
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( ',' ) );
815 return arr
.join( '|' );
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
825 function doRequest( moduleMap
, currReqBase
, sourceLoadScript
) {
826 var request
= $.extend(
827 { 'modules': buildModulesString( moduleMap
) },
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
) + '&*' );
839 * Requests dependencies from server, loading and executing when things when ready.
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
;
847 // Build a list of request parameters common to all requests.
849 skin
: mw
.config
.get( 'skin' ),
850 lang
: mw
.config
.get( 'wgUserLanguage' ),
851 debug
: mw
.config
.get( 'debug' )
853 // Split module batch by source and by group.
855 maxQueryLength
= mw
.config
.get( 'wgResourceLoaderMaxQueryLength', -1 );
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';
869 // Early exit if there's nothing to load...
870 if ( !batch
.length
) {
874 // The queue has been processed into the batch, clear up the queue.
877 // Always order modules alphabetically to help reduce cache
878 // misses for otherwise identical content.
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
] = {};
888 if ( splits
[bSource
][bGroup
] === undefined ) {
889 splits
[bSource
][bGroup
] = [];
891 bSourceGroup
= splits
[bSource
][bGroup
];
892 bSourceGroup
[bSourceGroup
.length
] = batch
[b
];
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.
902 for ( source
in splits
) {
904 sourceLoadScript
= sources
[source
].loadScript
;
906 for ( group
in splits
[source
] ) {
908 // Cache access to currently selected list of
909 // modules for this group from this source.
910 modules
= splits
[source
][group
];
912 // Calculate the highest timestamp
914 for ( g
= 0; g
< modules
.length
; g
+= 1 ) {
915 if ( registry
[modules
[g
]].version
> maxVersion
) {
916 maxVersion
= registry
[modules
[g
]].version
;
920 currReqBase
= $.extend( { 'version': formatVersionNumber( maxVersion
) }, reqBase
);
921 currReqBaseLength
= $.param( currReqBase
).length
;
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
927 moduleMap
= {}; // { prefix: [ suffixes ] }
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
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
);
946 l
= currReqBaseLength
+ 9;
948 if ( moduleMap
[prefix
] === undefined ) {
949 moduleMap
[prefix
] = [];
951 moduleMap
[prefix
].push( suffix
);
954 // If there's anything left in moduleMap, request that too
955 if ( !$.isEmptyObject( moduleMap
) ) {
956 doRequest( moduleMap
, currReqBase
, sourceLoadScript
);
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.
970 addSource: function ( id
, props
) {
972 // Allow multiple additions
973 if ( typeof id
=== 'object' ) {
974 for ( source
in id
) {
975 mw
.loader
.addSource( source
, id
[source
] );
980 if ( sources
[id
] !== undefined ) {
981 throw new Error( 'source already registered: ' + id
);
990 * Registers a module, letting the system know about it and its
991 * properties. Startup modules contain calls to this function.
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.
1000 register: function ( module
, version
, dependencies
, group
, source
) {
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
] );
1016 if ( typeof module
!== 'string' ) {
1017 throw new Error( 'module must be a string, not a ' + typeof module
);
1019 if ( registry
[module
] !== undefined ) {
1020 throw new Error( 'module already registered: ' + module
);
1022 // List the module as registered
1023 registry
[module
] = {
1024 'version': version
!== undefined ? parseInt( version
, 10 ) : 0,
1026 'group': typeof group
=== 'string' ? group
: null,
1027 'source': typeof source
=== 'string' ? source
: 'local',
1028 'state': 'registered'
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
;
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.
1045 * All arguments are required.
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
1054 implement: function ( module
, script
, style
, msgs
) {
1056 if ( typeof module
!== 'string' ) {
1057 throw new Error( 'module must be a string, not a ' + typeof module
);
1059 if ( !$.isFunction( script
) && !$.isArray( script
) ) {
1060 throw new Error( 'script must be a function or an array, not a ' + typeof script
);
1062 if ( !$.isPlainObject( style
) ) {
1063 throw new Error( 'style must be an object, not a ' + typeof style
);
1065 if ( !$.isPlainObject( msgs
) ) {
1066 throw new Error( 'msgs must be an object, not a ' + typeof msgs
);
1068 // Automatically register module
1069 if ( registry
[module
] === undefined ) {
1070 mw
.loader
.register( module
);
1072 // Check for duplicate implementation
1073 if ( registry
[module
] !== undefined && registry
[module
].script
!== undefined ) {
1074 throw new Error( 'module already implemented: ' + module
);
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
1084 filter( ['ready'], registry
[module
].dependencies
),
1085 registry
[module
].dependencies
) )
1092 * Executes a function as soon as one or more required modules are ready
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)
1099 using: function ( dependencies
, ready
, error
) {
1100 var tod
= typeof dependencies
;
1102 if ( tod
!== 'object' && tod
!== 'string' ) {
1103 throw new Error( 'dependencies must be a string or an array, not a ' + tod
);
1105 // Allow calling with a single dependency as a string
1106 if ( tod
=== 'string' ) {
1107 dependencies
= [dependencies
];
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
) ) {
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"' ),
1124 // Since some dependencies are not yet ready, queue up a request
1126 request( dependencies
, ready
, error
);
1131 * Loads an external script or one or more modules for future use
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.
1139 load: function ( modules
, type
) {
1143 if ( typeof modules
!== 'object' && typeof modules
!== 'string' ) {
1144 throw new Error( 'modules must be a string or an array, not a ' + typeof modules
);
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 if ( /^(https?:)?\/\//.test( modules
) ) {
1150 if ( type
=== 'text/css' ) {
1151 $( 'head' ).append( $( '<link>', {
1157 } else if ( type
=== 'text/javascript' || type
=== undefined ) {
1158 addScript( modules
);
1162 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type
);
1164 // Called with single module
1165 modules
= [modules
];
1168 // Filter out undefined modules, otherwise resolve() will throw
1169 // an exception for trying to load an undefined module.
1170 // Undefined modules are acceptable here in load(), because load() takes
1171 // an array of unrelated modules, whereas the modules passed to
1172 // using() are related and must all be loaded.
1173 for ( filtered
= [], m
= 0; m
< modules
.length
; m
+= 1 ) {
1174 if ( registry
[modules
[m
]] !== undefined ) {
1175 filtered
[filtered
.length
] = modules
[m
];
1179 // Resolve entire dependency map
1180 filtered
= resolve( filtered
);
1181 // If all modules are ready, nothing dependency be done
1182 if ( compare( filter( ['ready'], filtered
), filtered
) ) {
1185 // If any modules have errors
1186 else if ( filter( ['error'], filtered
).length
) {
1189 // Since some modules are not yet ready, queue up a request
1191 request( filtered
);
1197 * Changes the state of a module
1199 * @param module {String|Object} module name or object of module name/state pairs
1200 * @param state {String} state name
1202 state: function ( module
, state
) {
1204 if ( typeof module
=== 'object' ) {
1205 for ( m
in module
) {
1206 mw
.loader
.state( m
, module
[m
] );
1210 if ( registry
[module
] === undefined ) {
1211 mw
.loader
.register( module
);
1213 registry
[module
].state
= state
;
1217 * Gets the version of a module
1219 * @param module string name of module to get version for
1221 getVersion: function ( module
) {
1222 if ( registry
[module
] !== undefined && registry
[module
].version
!== undefined ) {
1223 return formatVersionNumber( registry
[module
].version
);
1229 * @deprecated since 1.18 use mw.loader.getVersion() instead
1231 version: function () {
1232 return mw
.loader
.getVersion
.apply( mw
.loader
, arguments
);
1236 * Gets the state of a module
1238 * @param module string name of module to get state for
1240 getState: function ( module
) {
1241 if ( registry
[module
] !== undefined && registry
[module
].state
!== undefined ) {
1242 return registry
[module
].state
;
1248 * Get names of all registered modules.
1252 getModuleNames: function () {
1253 return $.map( registry
, function ( i
, key
) {
1259 * Enable or disable blocking. If blocking is enabled and
1260 * document ready has not yet occurred, scripts will be loaded
1261 * in a blocking way (using document.write) rather than
1262 * asynchronously using DOM manipulation
1264 * @param b {Boolean} True to enable blocking, false to disable it
1266 setBlocking: function( b
) {
1271 * For backwards-compatibility with Squid-cached pages. Loads mw.user
1274 mw
.loader
.load( 'mediawiki.user' );
1279 /** HTML construction helper functions */
1280 html
: ( function () {
1281 function escapeCallback( s
) {
1298 * Escape a string for HTML. Converts special characters to HTML entities.
1299 * @param s The string to escape
1301 escape: function ( s
) {
1302 return s
.replace( /['"<>&]/g, escapeCallback
);
1306 * Wrapper object for raw HTML passed to mw.html.element().
1309 Raw: function ( value
) {
1314 * Wrapper object for CDATA element contents passed to mw.html.element()
1317 Cdata: function ( value
) {
1322 * Create an HTML element string, with safe escaping.
1324 * @param name The tag name.
1325 * @param attrs An object with members mapping element names to values
1326 * @param contents The contents of the element. May be either:
1327 * - string: The string is escaped.
1328 * - null or undefined: The short closing form is used, e.g. <br/>.
1329 * - this.Raw: The value attribute is included without escaping.
1330 * - this.Cdata: The value attribute is included, and an exception is
1331 * thrown if it contains an illegal ETAGO delimiter.
1332 * See http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.3.2
1336 * return h.element( 'div', {},
1337 * new h.Raw( h.element( 'img', {src: '<'} ) ) );
1338 * Returns <div><img src="<"/></div>
1340 element: function ( name
, attrs
, contents
) {
1341 var v
, attrName
, s
= '<' + name
;
1343 for ( attrName
in attrs
) {
1344 v
= attrs
[attrName
];
1345 // Convert name=true, to name=name
1349 } else if ( v
=== false ) {
1352 s
+= ' ' + attrName
+ '="' + this.escape( String( v
) ) + '"';
1354 if ( contents
=== undefined || contents
=== null ) {
1361 switch ( typeof contents
) {
1364 s
+= this.escape( contents
);
1368 // Convert to string
1369 s
+= String( contents
);
1372 if ( contents
instanceof this.Raw
) {
1373 // Raw HTML inclusion
1374 s
+= contents
.value
;
1375 } else if ( contents
instanceof this.Cdata
) {
1377 if ( /<\/[a-zA-z]/.test( contents
.value
) ) {
1378 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
1380 s
+= contents
.value
;
1382 throw new Error( 'mw.html.element: Invalid type of contents' );
1385 s
+= '</' + name
+ '>';
1394 // Alias $j to jQuery for backwards compatibility
1397 // Attach to window and globally alias
1398 window
.mw
= window
.mediaWiki
= mw
;
1400 // Auto-register from pre-loaded startup scripts
1401 if ( typeof startUp
!== 'undefined' && jQuery
.isFunction( startUp
) ) {
1403 startUp
= undefined;