2 * Core MediaWiki JavaScript Library
5 var mw
= new ( function( $, undefined ) {
10 var hasOwn
= Object
.prototype.hasOwnProperty
;
12 /* Object constructors */
17 * Creates an object that can be read from or written to from prototype functions
18 * that allow both single and multiple variables at once.
20 * @param global boolean Whether to store the values in the global window
21 * object or a exclusively in the object property 'values'.
24 function Map( global
) {
25 this.values
= global
=== true ? window
: {};
31 * Get the value of one or multiple a keys.
33 * If called with no arguments, all values will be returned.
35 * @param selection mixed String key or array of keys to get values for.
36 * @param fallback mixed Value to use in case key(s) do not exist (optional).
37 * @return mixed If selection was a string returns the value or null,
38 * If selection was an array, returns an object of key/values (value is null if not found),
39 * If selection was not passed or invalid, will return the 'values' object member (be careful as
40 * objects are always passed by reference in JavaScript!).
41 * @return Values as a string or object, null if invalid/inexistant.
43 get: function( selection
, fallback
) {
46 if ( $.isArray( selection
) ) {
47 selection
= $.makeArray( selection
);
49 for ( i
= 0; i
< selection
.length
; i
+= 1 ) {
50 results
[selection
[i
]] = this.get( selection
[i
], fallback
);
53 } else if ( typeof selection
=== 'string' ) {
54 if ( this.values
[selection
] === undefined ) {
55 if ( fallback
!== undefined ) {
60 return this.values
[selection
];
62 if ( selection
=== undefined ) {
65 return null; // invalid selection key
70 * Sets one or multiple key/value pairs.
72 * @param selection {mixed} String key or array of keys to set values for.
73 * @param value {mixed} Value to set (optional, only in use when key is a string)
74 * @return {Boolean} This returns true on success, false on failure.
76 set: function( selection
, value
) {
79 if ( $.isPlainObject( selection
) ) {
80 for ( s
in selection
) {
81 this.values
[s
] = selection
[s
];
84 } else if ( typeof selection
=== 'string' && value
!== undefined ) {
85 this.values
[selection
] = value
;
92 * Checks if one or multiple keys exist.
94 * @param selection {mixed} String key or array of keys to check
95 * @return {Boolean} Existence of key(s)
97 exists: function( selection
) {
100 if ( $.isArray( selection
) ) {
101 for ( s
= 0; s
< selection
.length
; s
+= 1 ) {
102 if ( this.values
[selection
[s
]] === undefined ) {
108 return this.values
[selection
] !== undefined;
116 * Object constructor for messages,
117 * similar to the Message class in MediaWiki PHP.
119 * @param map Map Instance of mw.Map
121 * @param parameters Array
124 function Message( map
, key
, parameters
) {
125 this.format
= 'plain';
128 this.parameters
= parameters
=== undefined ? [] : $.makeArray( parameters
);
132 Message
.prototype = {
134 * Appends (does not replace) parameters for replacement to the .parameters property.
136 * @param parameters Array
139 params: function( parameters
) {
141 for ( i
= 0; i
< parameters
.length
; i
+= 1 ) {
142 this.parameters
.push( parameters
[i
] );
148 * Converts message object to it's string form based on the state of format.
150 * @return string Message as a string in the current form or <key> if key does not exist.
152 toString: function() {
153 if ( !this.map
.exists( this.key
) ) {
154 // Use <key> as text if key does not exist
155 if ( this.format
!== 'plain' ) {
156 // format 'escape' and 'parse' need to have the brackets and key html escaped
157 return mw
.html
.escape( '<' + this.key
+ '>' );
159 return '<' + this.key
+ '>';
161 var text
= this.map
.get( this.key
),
162 parameters
= this.parameters
;
164 text
= text
.replace( /\$(\d+)/g, function( str
, match
) {
165 var index
= parseInt( match
, 10 ) - 1;
166 return parameters
[index
] !== undefined ? parameters
[index
] : '$' + match
;
169 if ( this.format
=== 'plain' ) {
172 if ( this.format
=== 'escaped' ) {
173 // According to Message.php this needs {{-transformation, which is
175 return mw
.html
.escape( text
);
178 /* This should be fixed up when we have a parser
179 if ( this.format === 'parse' && 'language' in mw ) {
180 text = mw.language.parse( text );
187 * Changes format to parse and converts message to string
189 * @return {string} String form of parsed message
192 this.format
= 'parse';
193 return this.toString();
197 * Changes format to plain and converts message to string
199 * @return {string} String form of plain message
202 this.format
= 'plain';
203 return this.toString();
207 * Changes the format to html escaped and converts message to string
209 * @return {string} String form of html escaped message
211 escaped: function() {
212 this.format
= 'escaped';
213 return this.toString();
217 * Checks if message exists
219 * @return {string} String form of parsed message
222 return this.map
.exists( this.key
);
229 * Dummy function which in debug mode can be replaced with a function that
230 * emulates console.log in console-less environments.
232 this.log = function() { };
235 * @var constructor Make the Map constructor publicly available.
240 * List of configuration values
242 * Dummy placeholder. Initiated in startUp module as a new instance of mw.Map().
243 * If $wgLegacyJavaScriptGlobals is true, this Map will have its values
244 * in the global window object.
251 * Empty object that plugins can be installed in.
256 * Localization system
258 this.messages
= new this.Map();
263 * Gets a message object, similar to wfMessage()
265 * @param key string Key of message to get
266 * @param parameter_1 mixed First argument in a list of variadic arguments,
267 * each a parameter for $N replacement in messages.
270 this.message = function( key
, parameter_1
/* [, parameter_2] */ ) {
272 // Support variadic arguments
273 if ( parameter_1
!== undefined ) {
274 parameters
= $.makeArray( arguments
);
279 return new Message( mw
.messages
, key
, parameters
);
283 * Gets a message string, similar to wfMsg()
285 * @param key string Key of message to get
286 * @param parameters mixed First argument in a list of variadic arguments,
287 * each a parameter for $N replacement in messages.
290 this.msg = function( key
, parameters
) {
291 return mw
.message
.apply( mw
.message
, arguments
).toString();
295 * Client-side module loader which integrates with the MediaWiki ResourceLoader
297 this.loader
= new ( function() {
299 /* Private Members */
302 * Mapping of registered modules
304 * The jquery module is pre-registered, because it must have already
305 * been provided for this object to have been built, and in debug mode
306 * jquery would have been provided through a unique loader request,
307 * making it impossible to hold back registration of jquery until after
310 * For exact details on support for script, style and messages, look at
311 * mw.loader.implement.
316 * 'version': ############## (unix timestamp),
317 * 'dependencies': ['required.foo', 'bar.also', ...], (or) function() {}
318 * 'group': 'somegroup', (or) null,
319 * 'source': 'local', 'someforeignwiki', (or) null
320 * 'state': 'registered', 'loading', 'loaded', 'ready', or 'error'
323 * 'messages': { 'key': 'value' },
329 * Mapping of sources, keyed by source-id, values are objects.
333 * 'loadScript': 'http://foo.bar/w/load.php'
338 // List of modules which will be loaded as when ready
340 // List of modules to be loaded
342 // List of callback functions waiting for modules to be ready to be called
344 // Flag inidicating that document ready has occured
346 // Selector cache for the marker element. Use getMarker() to get/use the marker!
349 /* Private Methods */
351 function getMarker(){
356 $marker
= $( 'meta[name="ResourceLoaderDynamicStyles"]' );
357 if ( $marker
.length
) {
360 mw
.log( 'getMarker> No <meta name="ResourceLoaderDynamicStyles"> found, inserting dynamically.' );
361 $marker
= $( '<meta>' ).attr( 'name', 'ResourceLoaderDynamicStyles' ).appendTo( 'head' );
366 function compare( a
, b
) {
368 if ( a
.length
!== b
.length
) {
371 for ( i
= 0; i
< b
.length
; i
+= 1 ) {
372 if ( $.isArray( a
[i
] ) ) {
373 if ( !compare( a
[i
], b
[i
] ) ) {
377 if ( a
[i
] !== b
[i
] ) {
385 * Generates an ISO8601 "basic" string from a UNIX timestamp
387 function formatVersionNumber( timestamp
) {
388 var pad = function( a
, b
, c
) {
389 return [a
< 10 ? '0' + a
: a
, b
< 10 ? '0' + b
: b
, c
< 10 ? '0' + c
: c
].join( '' );
392 d
.setTime( timestamp
* 1000 );
394 pad( d
.getUTCFullYear(), d
.getUTCMonth() + 1, d
.getUTCDate() ), 'T',
395 pad( d
.getUTCHours(), d
.getUTCMinutes(), d
.getUTCSeconds() ), 'Z'
400 * Recursively resolves dependencies and detects circular references
402 function recurse( module
, resolved
, unresolved
) {
405 if ( registry
[module
] === undefined ) {
406 throw new Error( 'Unknown dependency: ' + module
);
408 // Resolves dynamic loader function and replaces it with its own results
409 if ( $.isFunction( registry
[module
].dependencies
) ) {
410 registry
[module
].dependencies
= registry
[module
].dependencies();
411 // Ensures the module's dependencies are always in an array
412 if ( typeof registry
[module
].dependencies
!== 'object' ) {
413 registry
[module
].dependencies
= [registry
[module
].dependencies
];
416 // Tracks down dependencies
417 deps
= registry
[module
].dependencies
;
419 for ( n
= 0; n
< len
; n
+= 1 ) {
420 if ( $.inArray( deps
[n
], resolved
) === -1 ) {
421 if ( $.inArray( deps
[n
], unresolved
) !== -1 ) {
423 'Circular reference detected: ' + module
+
427 recurse( deps
[n
], resolved
, unresolved
);
430 resolved
[resolved
.length
] = module
;
431 unresolved
.splice( $.inArray( module
, unresolved
), 1 );
435 * Gets a list of module names that a module depends on in their proper dependency order
437 * @param module string module name or array of string module names
438 * @return list of dependencies
439 * @throws Error if circular reference is detected
441 function resolve( module
) {
442 var modules
, m
, deps
, n
, resolved
;
444 // Allow calling with an array of module names
445 if ( $.isArray( module
) ) {
447 for ( m
= 0; m
< module
.length
; m
+= 1 ) {
448 deps
= resolve( module
[m
] );
449 for ( n
= 0; n
< deps
.length
; n
+= 1 ) {
450 modules
[modules
.length
] = deps
[n
];
454 } else if ( typeof module
=== 'string' ) {
455 // Undefined modules have no dependencies
456 if ( registry
[module
] === undefined ) {
460 recurse( module
, resolved
, [] );
463 throw new Error( 'Invalid module argument: ' + module
);
467 * Narrows a list of module names down to those matching a specific
468 * state. Possible states are 'undefined', 'registered', 'loading',
469 * 'loaded', or 'ready'
471 * @param states string or array of strings of module states to filter by
472 * @param modules array list of module names to filter (optional, all modules
473 * will be used by default)
474 * @return array list of filtered module names
476 function filter( states
, modules
) {
477 var list
, module
, s
, m
;
479 // Allow states to be given as a string
480 if ( typeof states
=== 'string' ) {
483 // If called without a list of modules, build and use a list of all modules
485 if ( modules
=== undefined ) {
487 for ( module
in registry
) {
488 modules
[modules
.length
] = module
;
491 // Build a list of modules which are in one of the specified states
492 for ( s
= 0; s
< states
.length
; s
+= 1 ) {
493 for ( m
= 0; m
< modules
.length
; m
+= 1 ) {
494 if ( registry
[modules
[m
]] === undefined ) {
495 // Module does not exist
496 if ( states
[s
] === 'undefined' ) {
498 list
[list
.length
] = modules
[m
];
501 // Module exists, check state
502 if ( registry
[modules
[m
]].state
=== states
[s
] ) {
504 list
[list
.length
] = modules
[m
];
513 * Executes a loaded module, making it ready to use
515 * @param module string module name to execute
517 function execute( module
, callback
) {
518 var style
, media
, i
, script
, markModuleReady
, nestedAddScript
;
520 if ( registry
[module
] === undefined ) {
521 throw new Error( 'Module has not been registered yet: ' + module
);
522 } else if ( registry
[module
].state
=== 'registered' ) {
523 throw new Error( 'Module has not been requested from the server yet: ' + module
);
524 } else if ( registry
[module
].state
=== 'loading' ) {
525 throw new Error( 'Module has not completed loading yet: ' + module
);
526 } else if ( registry
[module
].state
=== 'ready' ) {
527 throw new Error( 'Module has already been loaded: ' + module
);
531 if ( $.isPlainObject( registry
[module
].style
) ) {
532 for ( media
in registry
[module
].style
) {
533 style
= registry
[module
].style
[media
];
534 if ( $.isArray( style
) ) {
535 for ( i
= 0; i
< style
.length
; i
+= 1 ) {
536 getMarker().before( mw
.html
.element( 'link', {
543 } else if ( typeof style
=== 'string' ) {
544 getMarker().before( mw
.html
.element( 'style', {
547 }, new mw
.html
.Cdata( style
) ) );
551 // Add localizations to message system
552 if ( $.isPlainObject( registry
[module
].messages
) ) {
553 mw
.messages
.set( registry
[module
].messages
);
557 script
= registry
[module
].script
;
558 markModuleReady = function() {
559 registry
[module
].state
= 'ready';
560 handlePending( module
);
561 if ( $.isFunction( callback
) ) {
565 nestedAddScript = function( arr
, callback
, i
) {
566 // Recursively call addScript() in its own callback
567 // for each element of arr.
568 if ( i
>= arr
.length
) {
569 // We're at the end of the array
574 addScript( arr
[i
], function() {
575 nestedAddScript( arr
, callback
, i
+ 1 );
579 if ( $.isArray( script
) ) {
580 registry
[module
].state
= 'loading';
581 nestedAddScript( script
, markModuleReady
, 0 );
582 } else if ( $.isFunction( script
) ) {
587 // This needs to NOT use mw.log because these errors are common in production mode
588 // and not in debug mode, such as when a symbol that should be global isn't exported
589 if ( window
.console
&& typeof window
.console
.log
=== 'function' ) {
590 console
.log( 'mw.loader::execute> Exception thrown by ' + module
+ ': ' + e
.message
);
592 registry
[module
].state
= 'error';
598 * Automatically executes jobs and modules which are pending with satistifed dependencies.
600 * This is used when dependencies are satisfied, such as when a module is executed.
602 function handlePending( module
) {
606 // Run jobs who's dependencies have just been met
607 for ( j
= 0; j
< jobs
.length
; j
+= 1 ) {
609 filter( 'ready', jobs
[j
].dependencies
),
610 jobs
[j
].dependencies
) )
612 if ( $.isFunction( jobs
[j
].ready
) ) {
619 // Execute modules who's dependencies have just been met
620 for ( r
in registry
) {
621 if ( registry
[r
].state
=== 'loaded' ) {
623 filter( ['ready'], registry
[r
].dependencies
),
624 registry
[r
].dependencies
) )
631 // Run error callbacks of jobs affected by this condition
632 for ( j
= 0; j
< jobs
.length
; j
+= 1 ) {
633 if ( $.inArray( module
, jobs
[j
].dependencies
) !== -1 ) {
634 if ( $.isFunction( jobs
[j
].error
) ) {
635 jobs
[j
].error( e
, module
);
645 * Adds a dependencies to the queue with optional callbacks to be run
646 * when the dependencies are ready or fail
648 * @param dependencies string module name or array of string module names
649 * @param ready function callback to execute when all dependencies are ready
650 * @param error function callback to execute when any dependency fails
652 function request( dependencies
, ready
, error
) {
653 var regItemDeps
, regItemDepLen
, n
;
655 // Allow calling by single module name
656 if ( typeof dependencies
=== 'string' ) {
657 dependencies
= [dependencies
];
658 if ( registry
[dependencies
[0]] !== undefined ) {
659 // Cache repetitively accessed deep level object member
660 regItemDeps
= registry
[dependencies
[0]].dependencies
;
661 // Cache to avoid looped access to length property
662 regItemDepLen
= regItemDeps
.length
;
663 for ( n
= 0; n
< regItemDepLen
; n
+= 1 ) {
664 dependencies
[dependencies
.length
] = regItemDeps
[n
];
668 // Add ready and error callbacks if they were given
669 if ( arguments
.length
> 1 ) {
670 jobs
[jobs
.length
] = {
671 'dependencies': filter(
672 ['undefined', 'registered', 'loading', 'loaded'],
679 // Queue up any dependencies that are undefined or registered
680 dependencies
= filter( ['undefined', 'registered'], dependencies
);
681 for ( n
= 0; n
< dependencies
.length
; n
+= 1 ) {
682 if ( $.inArray( dependencies
[n
], queue
) === -1 ) {
683 queue
[queue
.length
] = dependencies
[n
];
690 function sortQuery(o
) {
691 var sorted
= {}, key
, a
= [];
693 if ( hasOwn
.call( o
, key
) ) {
698 for ( key
= 0; key
< a
.length
; key
+= 1 ) {
699 sorted
[a
[key
]] = o
[a
[key
]];
705 * Converts a module map of the form { foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }
706 * to a query string of the form foo.bar,baz|bar.baz,quux
708 function buildModulesString( moduleMap
) {
709 var arr
= [], p
, prefix
;
710 for ( prefix
in moduleMap
) {
711 p
= prefix
=== '' ? '' : prefix
+ '.';
712 arr
.push( p
+ moduleMap
[prefix
].join( ',' ) );
714 return arr
.join( '|' );
718 * Adds a script tag to the body, either using document.write or low-level DOM manipulation,
719 * depending on whether document-ready has occured yet.
721 * @param src String: URL to script, will be used as the src attribute in the script tag
722 * @param callback Function: Optional callback which will be run when the script is done
724 function addScript( src
, callback
) {
725 var done
= false, script
;
727 // jQuery's getScript method is NOT better than doing this the old-fashioned way
728 // because jQuery will eval the script's code, and errors will not have sane
730 script
= document
.createElement( 'script' );
731 script
.setAttribute( 'src', src
);
732 script
.setAttribute( 'type', 'text/javascript' );
733 if ( $.isFunction( callback
) ) {
734 // Attach handlers for all browsers (based on jQuery.ajax)
735 script
.onload
= script
.onreadystatechange = function() {
741 || /loaded|complete/.test( script
.readyState
)
747 // Handle memory leak in IE
748 script
.onload
= script
.onreadystatechange
= null;
752 if ( script
.parentNode
) {
753 script
.parentNode
.removeChild( script
);
756 // Dereference the script
761 document
.body
.appendChild( script
);
763 document
.write( mw
.html
.element(
764 'script', { 'type': 'text/javascript', 'src': src
}, ''
766 if ( $.isFunction( callback
) ) {
767 // Document.write is synchronous, so this is called when it's done
774 * Asynchronously append a script tag to the end of the body
775 * that invokes load.php
776 * @param moduleMap {Object}: Module map, see buildModulesString()
777 * @param currReqBase {Object}: Object with other parameters (other than 'modules') to use in the request
778 * @param sourceLoadScript {String}: URL of load.php
780 function doRequest( moduleMap
, currReqBase
, sourceLoadScript
) {
781 var request
= $.extend(
782 { 'modules': buildModulesString( moduleMap
) },
785 request
= sortQuery( request
);
786 // Asynchronously append a script tag to the end of the body
787 // Append &* to avoid triggering the IE6 extension check
788 addScript( sourceLoadScript
+ '?' + $.param( request
) + '&*' );
794 * Requests dependencies from server, loading and executing when things when ready.
796 this.work = function() {
797 var reqBase
, splits
, maxQueryLength
, q
, b
, bSource
, bGroup
, bSourceGroup
,
798 source
, group
, g
, i
, modules
, maxVersion
, sourceLoadScript
,
799 currReqBase
, currReqBaseLength
, moduleMap
, l
,
800 lastDotIndex
, prefix
, suffix
, bytesAdded
;
802 // Build a list of request parameters common to all requests.
804 skin
: mw
.config
.get( 'skin' ),
805 lang
: mw
.config
.get( 'wgUserLanguage' ),
806 debug
: mw
.config
.get( 'debug' )
808 // Split module batch by source and by group.
810 maxQueryLength
= mw
.config
.get( 'wgResourceLoaderMaxQueryLength', -1 );
812 // Appends a list of modules from the queue to the batch
813 for ( q
= 0; q
< queue
.length
; q
+= 1 ) {
814 // Only request modules which are undefined or registered
815 if ( registry
[queue
[q
]] === undefined || registry
[queue
[q
]].state
=== 'registered' ) {
816 // Prevent duplicate entries
817 if ( $.inArray( queue
[q
], batch
) === -1 ) {
818 batch
[batch
.length
] = queue
[q
];
819 // Mark registered modules as loading
820 if ( registry
[queue
[q
]] !== undefined ) {
821 registry
[queue
[q
]].state
= 'loading';
826 // Early exit if there's nothing to load...
827 if ( !batch
.length
) {
831 // The queue has been processed into the batch, clear up the queue.
834 // Always order modules alphabetically to help reduce cache
835 // misses for otherwise identical content.
838 // Split batch by source and by group.
839 for ( b
= 0; b
< batch
.length
; b
+= 1 ) {
840 bSource
= registry
[batch
[b
]].source
;
841 bGroup
= registry
[batch
[b
]].group
;
842 if ( splits
[bSource
] === undefined ) {
843 splits
[bSource
] = {};
845 if ( splits
[bSource
][bGroup
] === undefined ) {
846 splits
[bSource
][bGroup
] = [];
848 bSourceGroup
= splits
[bSource
][bGroup
];
849 bSourceGroup
[bSourceGroup
.length
] = batch
[b
];
852 // Clear the batch - this MUST happen before we append any
853 // script elements to the body or it's possible that a script
854 // will be locally cached, instantly load, and work the batch
855 // again, all before we've cleared it causing each request to
856 // include modules which are already loaded.
859 for ( source
in splits
) {
861 sourceLoadScript
= sources
[source
].loadScript
;
863 for ( group
in splits
[source
] ) {
865 // Cache access to currently selected list of
866 // modules for this group from this source.
867 modules
= splits
[source
][group
];
869 // Calculate the highest timestamp
871 for ( g
= 0; g
< modules
.length
; g
+= 1 ) {
872 if ( registry
[modules
[g
]].version
> maxVersion
) {
873 maxVersion
= registry
[modules
[g
]].version
;
877 currReqBase
= $.extend( { 'version': formatVersionNumber( maxVersion
) }, reqBase
);
878 currReqBaseLength
= $.param( currReqBase
).length
;
880 // We may need to split up the request to honor the query string length limit,
881 // so build it piece by piece.
882 l
= currReqBaseLength
+ 9; // '&modules='.length == 9
884 moduleMap
= {}; // { prefix: [ suffixes ] }
886 for ( i
= 0; i
< modules
.length
; i
+= 1 ) {
887 // Determine how many bytes this module would add to the query string
888 lastDotIndex
= modules
[i
].lastIndexOf( '.' );
889 // Note that these substr() calls work even if lastDotIndex == -1
890 prefix
= modules
[i
].substr( 0, lastDotIndex
);
891 suffix
= modules
[i
].substr( lastDotIndex
+ 1 );
892 bytesAdded
= moduleMap
[prefix
] !== undefined
893 ? suffix
.length
+ 3 // '%2C'.length == 3
894 : modules
[i
].length
+ 3; // '%7C'.length == 3
896 // If the request would become too long, create a new one,
897 // but don't create empty requests
898 if ( maxQueryLength
> 0 && !$.isEmptyObject( moduleMap
) && l
+ bytesAdded
> maxQueryLength
) {
899 // This request would become too long, create a new one
900 // and fire off the old one
901 doRequest( moduleMap
, currReqBase
, sourceLoadScript
);
903 l
= currReqBaseLength
+ 9;
905 if ( moduleMap
[prefix
] === undefined ) {
906 moduleMap
[prefix
] = [];
908 moduleMap
[prefix
].push( suffix
);
911 // If there's anything left in moduleMap, request that too
912 if ( !$.isEmptyObject( moduleMap
) ) {
913 doRequest( moduleMap
, currReqBase
, sourceLoadScript
);
922 * @param id {String}: Short lowercase a-Z string representing a source, only used internally.
923 * @param props {Object}: Object containing only the loadScript property which is a url to
924 * the load.php location of the source.
927 this.addSource = function( id
, props
) {
929 // Allow multiple additions
930 if ( typeof id
=== 'object' ) {
931 for ( source
in id
) {
932 mw
.loader
.addSource( source
, id
[source
] );
937 if ( sources
[id
] !== undefined ) {
938 throw new Error( 'source already registered: ' + id
);
947 * Registers a module, letting the system know about it and its
948 * properties. Startup modules contain calls to this function.
950 * @param module {String}: Module name
951 * @param version {Number}: Module version number as a timestamp (falls backs to 0)
952 * @param dependencies {String|Array|Function}: One string or array of strings of module
953 * names on which this module depends, or a function that returns that array.
954 * @param group {String}: Group which the module is in (optional, defaults to null)
955 * @param source {String}: Name of the source. Defaults to local.
957 this.register = function( module
, version
, dependencies
, group
, source
) {
959 // Allow multiple registration
960 if ( typeof module
=== 'object' ) {
961 for ( m
= 0; m
< module
.length
; m
+= 1 ) {
962 // module is an array of module names
963 if ( typeof module
[m
] === 'string' ) {
964 mw
.loader
.register( module
[m
] );
965 // module is an array of arrays
966 } else if ( typeof module
[m
] === 'object' ) {
967 mw
.loader
.register
.apply( mw
.loader
, module
[m
] );
973 if ( typeof module
!== 'string' ) {
974 throw new Error( 'module must be a string, not a ' + typeof module
);
976 if ( registry
[module
] !== undefined ) {
977 throw new Error( 'module already implemented: ' + module
);
979 // List the module as registered
981 'version': version
!== undefined ? parseInt( version
, 10 ) : 0,
983 'group': typeof group
=== 'string' ? group
: null,
984 'source': typeof source
=== 'string' ? source
: 'local',
985 'state': 'registered'
987 if ( typeof dependencies
=== 'string' ) {
988 // Allow dependencies to be given as a single module name
989 registry
[module
].dependencies
= [dependencies
];
990 } else if ( typeof dependencies
=== 'object' || $.isFunction( dependencies
) ) {
991 // Allow dependencies to be given as an array of module names
992 // or a function which returns an array
993 registry
[module
].dependencies
= dependencies
;
998 * Implements a module, giving the system a course of action to take
999 * upon loading. Results of a request for one or more modules contain
1000 * calls to this function.
1002 * All arguments are required.
1004 * @param module String: Name of module
1005 * @param script Mixed: Function of module code or String of URL to be used as the src
1006 * attribute when adding a script element to the body
1007 * @param style Object: Object of CSS strings keyed by media-type or Object of lists of URLs
1008 * keyed by media-type
1009 * @param msgs Object: List of key/value pairs to be passed through mw.messages.set
1011 this.implement = function( module
, script
, style
, msgs
) {
1013 if ( typeof module
!== 'string' ) {
1014 throw new Error( 'module must be a string, not a ' + typeof module
);
1016 if ( !$.isFunction( script
) && !$.isArray( script
) ) {
1017 throw new Error( 'script must be a function or an array, not a ' + typeof script
);
1019 if ( !$.isPlainObject( style
) ) {
1020 throw new Error( 'style must be an object, not a ' + typeof style
);
1022 if ( !$.isPlainObject( msgs
) ) {
1023 throw new Error( 'msgs must be an object, not a ' + typeof msgs
);
1025 // Automatically register module
1026 if ( registry
[module
] === undefined ) {
1027 mw
.loader
.register( module
);
1029 // Check for duplicate implementation
1030 if ( registry
[module
] !== undefined && registry
[module
].script
!== undefined ) {
1031 throw new Error( 'module already implemented: ' + module
);
1033 // Mark module as loaded
1034 registry
[module
].state
= 'loaded';
1035 // Attach components
1036 registry
[module
].script
= script
;
1037 registry
[module
].style
= style
;
1038 registry
[module
].messages
= msgs
;
1039 // Execute or queue callback
1041 filter( ['ready'], registry
[module
].dependencies
),
1042 registry
[module
].dependencies
) )
1051 * Executes a function as soon as one or more required modules are ready
1053 * @param dependencies {String|Array} Module name or array of modules names the callback
1054 * dependends on to be ready before executing
1055 * @param ready {Function} callback to execute when all dependencies are ready (optional)
1056 * @param error {Function} callback to execute when if dependencies have a errors (optional)
1058 this.using = function( dependencies
, ready
, error
) {
1059 var tod
= typeof dependencies
;
1061 if ( tod
!== 'object' && tod
!== 'string' ) {
1062 throw new Error( 'dependencies must be a string or an array, not a ' + tod
);
1064 // Allow calling with a single dependency as a string
1065 if ( tod
=== 'string' ) {
1066 dependencies
= [dependencies
];
1068 // Resolve entire dependency map
1069 dependencies
= resolve( dependencies
);
1070 // If all dependencies are met, execute ready immediately
1071 if ( compare( filter( ['ready'], dependencies
), dependencies
) ) {
1072 if ( $.isFunction( ready
) ) {
1076 // If any dependencies have errors execute error immediately
1077 else if ( filter( ['error'], dependencies
).length
) {
1078 if ( $.isFunction( error
) ) {
1079 error( new Error( 'one or more dependencies have state "error"' ),
1083 // Since some dependencies are not yet ready, queue up a request
1085 request( dependencies
, ready
, error
);
1090 * Loads an external script or one or more modules for future use
1092 * @param modules {mixed} Either the name of a module, array of modules,
1093 * or a URL of an external script or style
1094 * @param type {String} mime-type to use if calling with a URL of an
1095 * external script or style; acceptable values are "text/css" and
1096 * "text/javascript"; if no type is provided, text/javascript is assumed.
1098 this.load = function( modules
, type
) {
1100 if ( typeof modules
!== 'object' && typeof modules
!== 'string' ) {
1101 throw new Error( 'modules must be a string or an array, not a ' + typeof modules
);
1103 // Allow calling with an external script or single dependency as a string
1104 if ( typeof modules
=== 'string' ) {
1105 // Support adding arbitrary external scripts
1106 if ( /^(https?:)?\/\//.test( modules
) ) {
1107 if ( type
=== 'text/css' ) {
1108 $( 'head' ).append( $( '<link/>', {
1114 } else if ( type
=== 'text/javascript' || type
=== undefined ) {
1115 addScript( modules
);
1121 // Called with single module
1122 modules
= [modules
];
1124 // Resolve entire dependency map
1125 modules
= resolve( modules
);
1126 // If all modules are ready, nothing dependency be done
1127 if ( compare( filter( ['ready'], modules
), modules
) ) {
1130 // If any modules have errors return false
1131 else if ( filter( ['error'], modules
).length
) {
1134 // Since some modules are not yet ready, queue up a request
1142 * Changes the state of a module
1144 * @param module {String|Object} module name or object of module name/state pairs
1145 * @param state {String} state name
1147 this.state = function( module
, state
) {
1149 if ( typeof module
=== 'object' ) {
1150 for ( m
in module
) {
1151 mw
.loader
.state( m
, module
[m
] );
1155 if ( registry
[module
] === undefined ) {
1156 mw
.loader
.register( module
);
1158 registry
[module
].state
= state
;
1162 * Gets the version of a module
1164 * @param module string name of module to get version for
1166 this.getVersion = function( module
) {
1167 if ( registry
[module
] !== undefined && registry
[module
].version
!== undefined ) {
1168 return formatVersionNumber( registry
[module
].version
);
1174 * @deprecated since 1.18 use mw.loader.getVersion() instead
1176 this.version = function() {
1177 return mw
.loader
.getVersion
.apply( mw
.loader
, arguments
);
1181 * Gets the state of a module
1183 * @param module string name of module to get state for
1185 this.getState = function( module
) {
1186 if ( registry
[module
] !== undefined && registry
[module
].state
!== undefined ) {
1187 return registry
[module
].state
;
1193 * Get names of all registered modules.
1197 this.getModuleNames = function() {
1198 return $.map( registry
, function( i
, key
) {
1204 * For backwards-compatibility with Squid-cached pages. Loads mw.user
1206 this.go = function() { mw
.loader
.load( 'mediawiki.user' ); };
1208 /* Cache document ready status */
1210 $(document
).ready( function() { ready
= true; } );
1213 /** HTML construction helper functions */
1214 this.html
= new ( function () {
1215 var escapeCallback = function( s
) {
1231 * Escape a string for HTML. Converts special characters to HTML entities.
1232 * @param s The string to escape
1234 this.escape = function( s
) {
1235 return s
.replace( /['"<>&]/g, escapeCallback
);
1239 * Wrapper object for raw HTML passed to mw.html.element().
1241 this.Raw = function( value
) {
1246 * Wrapper object for CDATA element contents passed to mw.html.element()
1248 this.Cdata = function( value
) {
1253 * Create an HTML element string, with safe escaping.
1255 * @param name The tag name.
1256 * @param attrs An object with members mapping element names to values
1257 * @param contents The contents of the element. May be either:
1258 * - string: The string is escaped.
1259 * - null or undefined: The short closing form is used, e.g. <br/>.
1260 * - this.Raw: The value attribute is included without escaping.
1261 * - this.Cdata: The value attribute is included, and an exception is
1262 * thrown if it contains an illegal ETAGO delimiter.
1263 * See http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.3.2
1267 * return h.element( 'div', {},
1268 * new h.Raw( h.element( 'img', {src: '<'} ) ) );
1269 * Returns <div><img src="<"/></div>
1271 this.element = function( name
, attrs
, contents
) {
1272 var v
, attrName
, s
= '<' + name
;
1274 for ( attrName
in attrs
) {
1275 v
= attrs
[attrName
];
1276 // Convert name=true, to name=name
1280 } else if ( v
=== false ) {
1283 s
+= ' ' + attrName
+ '="' + this.escape( String( v
) ) + '"';
1285 if ( contents
=== undefined || contents
=== null ) {
1292 switch ( typeof contents
) {
1295 s
+= this.escape( contents
);
1299 // Convert to string
1300 s
+= String( contents
);
1303 if ( contents
instanceof this.Raw
) {
1304 // Raw HTML inclusion
1305 s
+= contents
.value
;
1306 } else if ( contents
instanceof this.Cdata
) {
1308 if ( /<\/[a-zA-z]/.test( contents
.value
) ) {
1309 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
1311 s
+= contents
.value
;
1313 throw new Error( 'mw.html.element: Invalid type of contents' );
1316 s
+= '</' + name
+ '>';
1321 /* Extension points */
1327 // Alias $j to jQuery for backwards compatibility
1330 // Attach to window and globally alias
1331 window
.mw
= window
.mediaWiki
= mw
;
1333 // Auto-register from pre-loaded startup scripts
1334 if ( typeof startUp
!== 'undefined' && jQuery
.isFunction( startUp
) ) {
1336 startUp
= undefined;