2 * JavaScript backwards-compatibility alternatives and other convenience functions
6 trimLeft : function( str
) {
7 return str
=== null ? '' : str
.toString().replace( /^\s+/, '' );
9 trimRight : function( str
) {
11 '' : str
.toString().replace( /\s+$/, '' );
13 ucFirst : function( str
) {
14 return str
.substr( 0, 1 ).toUpperCase() + str
.substr( 1 );
16 escapeRE : function( str
) {
17 return str
.replace ( /([\\{}()|.?*+\-^$\[\]])/g, "\\$1" );
19 isDomElement : function( el
) {
20 return !!el
&& !!el
.nodeType
;
22 isEmpty : function( v
) {
24 if ( v
=== "" || v
=== 0 || v
=== "0" || v
=== null
25 || v
=== false || typeof v
=== 'undefined' )
29 // the for-loop could potentially contain prototypes
30 // to avoid that we check it's length first
31 if ( v
.length
=== 0 ) {
34 if ( typeof v
=== 'object' ) {
42 compareArray : function( arrThis
, arrAgainst
) {
43 if ( arrThis
.length
!= arrAgainst
.length
) {
46 for ( var i
= 0; i
< arrThis
.length
; i
++ ) {
47 if ( arrThis
[i
] instanceof Array
) {
48 if ( !$.compareArray( arrThis
[i
], arrAgainst
[i
] ) ) {
51 } else if ( arrThis
[i
] !== arrAgainst
[i
] ) {
57 compareObject : function( objectA
, objectB
) {
59 // Do a simple check if the types match
60 if ( typeof objectA
== typeof objectB
) {
62 // Only loop over the contents if it really is an object
63 if ( typeof objectA
== 'object' ) {
64 // If they are aliases of the same object (ie. mw and mediaWiki) return now
65 if ( objectA
=== objectB
) {
69 // Iterate over each property
70 for ( prop
in objectA
) {
71 // Check if this property is also present in the other object
72 if ( prop
in objectB
) {
73 // Compare the types of the properties
74 var type
= typeof objectA
[prop
];
75 if ( type
== typeof objectB
[prop
] ) {
76 // Recursively check objects inside this one
79 if ( !$.compareObject( objectA
[prop
], objectB
[prop
] ) ) {
84 // Functions need to be strings to compare them properly
85 if ( objectA
[prop
].toString() !== objectB
[prop
].toString() ) {
91 if ( objectA
[prop
] !== objectB
[prop
] ) {
103 // Check for properties in B but not in A
104 // This is about 15% faster (tested in Safari 5 and Firefox 3.6)
105 // ...than incrementing a count variable in the above and below loops
106 // See also: http://www.mediawiki.org/wiki/ResourceLoader/Default_modules/compareObject_test#Results
107 for ( prop
in objectB
) {
108 if ( !( prop
in objectA
) ) {
122 * Core MediaWiki JavaScript Library
126 window
.mediaWiki
= new ( function( $ ) {
130 /* Private Members */
132 // List of messages that have been requested to be loaded
133 var messageQueue
= {};
138 * An object which allows single and multiple get/set/exists functionality
139 * on a list of key / value pairs.
141 * @param {boolean} global Whether to get/set/exists values on the window
142 * object or a private object
144 function Map( global
) {
145 this.values
= ( global
=== true ) ? window
: {};
149 * Gets the value of a key, or a list of key/value pairs for an array of keys.
151 * If called with no arguments, all values will be returned.
153 * @param selection mixed Key or array of keys to get values for
154 * @param fallback mixed Value to use in case key(s) do not exist (optional)
156 Map
.prototype.get = function( selection
, fallback
) {
157 if ( typeof selection
=== 'object' ) {
158 selection
= $.makeArray( selection
);
160 for ( var i
= 0; i
< selection
.length
; i
++ ) {
161 results
[selection
[i
]] = this.get( selection
[i
], fallback
);
164 } else if ( typeof selection
=== 'string' ) {
165 if ( typeof this.values
[selection
] === 'undefined' ) {
166 if ( typeof fallback
!== 'undefined' ) {
171 return this.values
[selection
];
177 * Sets one or multiple key/value pairs.
179 * @param selection mixed Key or object of key/value pairs to set
180 * @param value mixed Value to set (optional, only in use when key is a string)
182 Map
.prototype.set = function( selection
, value
) {
183 if ( typeof selection
=== 'object' ) {
184 for ( var s
in selection
) {
185 this.values
[s
] = selection
[s
];
188 } else if ( typeof selection
=== 'string' && typeof value
!== 'undefined' ) {
189 this.values
[selection
] = value
;
196 * Checks if one or multiple keys exist.
198 * @param selection mixed Key or array of keys to check
199 * @return boolean Existence of key(s)
201 Map
.prototype.exists = function( selection
) {
202 if ( typeof selection
=== 'object' ) {
203 for ( var s
= 0; s
< selection
.length
; s
++ ) {
204 if ( !( selection
[s
] in this.values
) ) {
210 return selection
in this.values
;
215 * Message object, similar to Message in PHP
217 function Message( map
, key
, parameters
) {
218 this.format
= 'parse';
221 this.parameters
= typeof parameters
=== 'undefined' ? [] : $.makeArray( parameters
);
225 * Appends parameters for replacement
227 * @param parameters mixed First in a list of variadic arguments to append as message parameters
229 Message
.prototype.params = function( parameters
) {
230 for ( var i
= 0; i
< parameters
.length
; i
++ ) {
231 this.parameters
[this.parameters
.length
] = parameters
[i
];
237 * Converts message object to it's string form based on the state of format
239 * @return {string} String form of message
241 Message
.prototype.toString = function() {
242 if ( !this.map
.exists( this.key
) ) {
243 // Return <key> if key does not exist
244 return '<' + this.key
+ '>';
246 var text
= this.map
.get( this.key
);
247 var parameters
= this.parameters
;
248 text
= text
.replace( /\$(\d+)/g, function( string
, match
) {
249 var index
= parseInt( match
, 10 ) - 1;
250 return index
in parameters
? parameters
[index
] : '$' + match
;
253 if ( this.format
=== 'plain' ) {
256 if ( this.format
=== 'escaped' ) {
257 // According to Message.php this needs {{-transformation, which is
259 return mw
.html
.escape( text
);
262 /* This should be fixed up when we have a parser
263 if ( this.format === 'parse' && 'language' in mediaWiki ) {
264 text = mw.language.parse( text );
271 * Changes format to parse and converts message to string
273 * @return {string} String form of parsed message
275 Message
.prototype.parse = function() {
276 this.format
= 'parse';
277 return this.toString();
281 * Changes format to plain and converts message to string
283 * @return {string} String form of plain message
285 Message
.prototype.plain = function() {
286 this.format
= 'plain';
287 return this.toString();
291 * Changes the format to html escaped and converts message to string
293 * @return {string} String form of html escaped message
295 Message
.prototype.escaped = function() {
296 this.format
= 'escaped';
297 return this.toString();
301 * Checks if message exists
303 * @return {string} String form of parsed message
305 Message
.prototype.exists = function() {
306 return this.map
.exists( this.key
);
314 /* Private Members */
320 this.options
= new Map();
325 * Generates a random user session ID (32 alpha-numeric characters).
327 * This information would potentially be stored in a cookie to identify a user during a
328 * session or series of sessions. It's uniqueness should not be depended on.
330 * @return string random set of 32 alpha-numeric characters
332 function generateId() {
334 var seed
= '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
335 for ( var i
= 0, r
; i
< 32; i
++ ) {
336 r
= Math
.floor( Math
.random() * seed
.length
);
337 id
+= seed
.substring( r
, r
+ 1 );
343 * Gets the current user's name.
345 * @return mixed user name string or null if users is anonymous
347 this.name = function() {
348 return mw
.config
.get( 'wgUserName' );
352 * Checks if the current user is anonymous.
356 this.anonymous = function() {
357 return that
.name() ? false : true;
361 * Gets a random session ID automatically generated and kept in a cookie.
363 * This ID is ephemeral for everyone, staying in their browser only until they close
366 * Do not use this method before the first call to mw.loader.go(), it depends on
367 * jquery.cookie, which is added to the first pay-load just after mediaWiki is defined, but
368 * won't be loaded until the first call to go().
370 * @return string user name or random session ID
372 this.sessionId = function () {
373 var sessionId
= $.cookie( 'mediaWiki.user.sessionId' );
374 if ( typeof sessionId
== 'undefined' || sessionId
=== null ) {
375 sessionId
= generateId();
376 $.cookie( 'mediaWiki.user.sessionId', sessionId
, { 'expires': null, 'path': '/' } );
382 * Gets the current user's name or a random ID automatically generated and kept in a cookie.
384 * This ID is persistent for anonymous users, staying in their browser up to 1 year. The
385 * expiration time is reset each time the ID is queried, so in most cases this ID will
386 * persist until the browser's cookies are cleared or the user doesn't visit for 1 year.
388 * Do not use this method before the first call to mw.loader.go(), it depends on
389 * jquery.cookie, which is added to the first pay-load just after mediaWiki is defined, but
390 * won't be loaded until the first call to go().
392 * @return string user name or random session ID
394 this.id = function() {
395 var name
= that
.name();
399 var id
= $.cookie( 'mediaWiki.user.id' );
400 if ( typeof id
== 'undefined' || id
=== null ) {
403 // Set cookie if not set, or renew it if already set
404 $.cookie( 'mediaWiki.user.id', id
, { 'expires': 365, 'path': '/' } );
409 * Gets the user's bucket, placing them in one at random based on set odds if needed.
411 * @param key String: Name of bucket
412 * @param options Object: Bucket configuration options
413 * @param options.buckets Object: List of bucket-name/relative-probability pairs (required,
414 * must have at least one pair)
415 * @param options.version Number: Version of bucket test, changing this forces rebucketing
416 * (optional, default: 0)
417 * @param options.tracked Boolean: Track the event of bucketing through the API module of
418 * the ClickTracking extension (optional, default: false)
419 * @param options.expires Number: Length of time (in days) until the user gets rebucketed
420 * (optional, default: 30)
421 * @return String: Bucket name - the randomly chosen key of the options.buckets object
424 * mw.user.bucket( 'test', {
425 * 'buckets': { 'ignored': 50, 'control': 25, 'test': 25 },
431 this.bucket = function( key
, options
) {
432 options
= $.extend( {
438 var cookie
= $.cookie( 'mediaWiki.user.bucket:' + key
);
441 // Bucket information is stored as 2 integers, together as version:bucket like: "1:2"
442 if ( typeof cookie
=== 'string' && cookie
.length
> 2 && cookie
.indexOf( ':' ) > 0 ) {
443 var parts
= cookie
.split( ':' );
444 if ( parts
.length
> 1 && parts
[0] == options
.version
) {
445 version
= Number( parts
[0] );
446 bucket
= String( parts
[1] );
449 if ( bucket
=== null ) {
450 if ( !$.isPlainObject( options
.buckets
) ) {
451 throw 'Invalid buckets error. Object expected for options.buckets.';
453 version
= Number( options
.version
);
456 for ( k
in options
.buckets
) {
457 range
+= options
.buckets
[k
];
459 // Select random value within range
460 var rand
= Math
.random() * range
;
461 // Determine which bucket the value landed in
463 for ( k
in options
.buckets
) {
465 total
+= options
.buckets
[k
];
466 if ( total
>= rand
) {
470 if ( options
.tracked
) {
471 mw
.loader
.using( 'jquery.clickTracking', function() {
473 'mediaWiki.user.bucket:' + key
+ '@' + version
+ ':' + bucket
478 'mediaWiki.user.bucket:' + key
,
479 version
+ ':' + bucket
,
480 { 'path': '/', 'expires': Number( options
.expires
) }
490 * Dummy function which in debug mode can be replaced with a function that
491 * does something clever
493 this.log = function() { };
496 * Make the Map-class publicly available
501 * List of configuration values
503 * Dummy placeholder. Initiated in startUp module as a new instance of mw.Map().
504 * If $wgLegacyJavaScriptGlobals is true, this Map will have its values
505 * in the global window object.
510 * Information about the current user
512 this.user
= new User();
515 * Localization system
517 this.messages
= new this.Map();
522 * Gets a message object, similar to wfMessage()
524 * @param key string Key of message to get
525 * @param parameters mixed First argument in a list of variadic arguments, each a parameter for $
528 this.message = function( key
, parameters
) {
529 // Support variadic arguments
530 if ( typeof parameters
!== 'undefined' ) {
531 parameters
= $.makeArray( arguments
);
536 return new Message( mw
.messages
, key
, parameters
);
540 * Gets a message string, similar to wfMsg()
542 * @param key string Key of message to get
543 * @param parameters mixed First argument in a list of variadic arguments, each a parameter for $
546 this.msg = function( key
, parameters
) {
547 return mw
.message
.apply( mw
.message
, arguments
).toString();
551 * Client-side module loader which integrates with the MediaWiki ResourceLoader
553 this.loader
= new ( function() {
555 /* Private Members */
558 * Mapping of registered modules
560 * The jquery module is pre-registered, because it must have already
561 * been provided for this object to have been built, and in debug mode
562 * jquery would have been provided through a unique loader request,
563 * making it impossible to hold back registration of jquery until after
569 * 'dependencies': ['required module', 'required module', ...], (or) function() {}
570 * 'state': 'registered', 'loading', 'loaded', 'ready', or 'error'
571 * 'script': function() {},
572 * 'style': 'css code string',
573 * 'messages': { 'key': 'value' },
574 * 'version': ############## (unix timestamp)
579 // List of modules which will be loaded as when ready
581 // List of modules to be loaded
583 // List of callback functions waiting for modules to be ready to be called
585 // Flag indicating that requests should be suspended
586 var suspended
= true;
587 // Flag inidicating that document ready has occured
589 // Marker element for adding dynamic styles
590 var $marker
= $( 'head meta[name=ResourceLoaderDynamicStyles]' );
592 /* Private Methods */
594 function compare( a
, b
) {
595 if ( a
.length
!= b
.length
) {
598 for ( var i
= 0; i
< b
.length
; i
++ ) {
599 if ( $.isArray( a
[i
] ) ) {
600 if ( !compare( a
[i
], b
[i
] ) ) {
604 if ( a
[i
] !== b
[i
] ) {
612 * Generates an ISO8601 "basic" string from a UNIX timestamp
614 function formatVersionNumber( timestamp
) {
615 function pad( a
, b
, c
) {
616 return [a
< 10 ? '0' + a
: a
, b
< 10 ? '0' + b
: b
, c
< 10 ? '0' + c
: c
].join( '' );
619 d
.setTime( timestamp
* 1000 );
621 pad( d
.getUTCFullYear(), d
.getUTCMonth() + 1, d
.getUTCDate() ), 'T',
622 pad( d
.getUTCHours(), d
.getUTCMinutes(), d
.getUTCSeconds() ), 'Z'
627 * Recursively resolves dependencies and detects circular references
629 function recurse( module
, resolved
, unresolved
) {
630 if ( typeof registry
[module
] === 'undefined' ) {
631 throw new Error( 'Unknown dependency: ' + module
);
633 // Resolves dynamic loader function and replaces it with its own results
634 if ( $.isFunction( registry
[module
].dependencies
) ) {
635 registry
[module
].dependencies
= registry
[module
].dependencies();
636 // Ensures the module's dependencies are always in an array
637 if ( typeof registry
[module
].dependencies
!== 'object' ) {
638 registry
[module
].dependencies
= [registry
[module
].dependencies
];
641 // Tracks down dependencies
642 for ( var n
= 0; n
< registry
[module
].dependencies
.length
; n
++ ) {
643 if ( $.inArray( registry
[module
].dependencies
[n
], resolved
) === -1 ) {
644 if ( $.inArray( registry
[module
].dependencies
[n
], unresolved
) !== -1 ) {
646 'Circular reference detected: ' + module
+
647 ' -> ' + registry
[module
].dependencies
[n
]
650 recurse( registry
[module
].dependencies
[n
], resolved
, unresolved
);
653 resolved
[resolved
.length
] = module
;
654 unresolved
.splice( $.inArray( module
, unresolved
), 1 );
658 * Gets a list of module names that a module depends on in their proper dependency order
660 * @param module string module name or array of string module names
661 * @return list of dependencies
662 * @throws Error if circular reference is detected
664 function resolve( module
) {
665 // Allow calling with an array of module names
666 if ( typeof module
=== 'object' ) {
668 for ( var m
= 0; m
< module
.length
; m
++ ) {
669 var dependencies
= resolve( module
[m
] );
670 for ( var n
= 0; n
< dependencies
.length
; n
++ ) {
671 modules
[modules
.length
] = dependencies
[n
];
675 } else if ( typeof module
=== 'string' ) {
676 // Undefined modules have no dependencies
677 if ( !( module
in registry
) ) {
681 recurse( module
, resolved
, [] );
684 throw new Error( 'Invalid module argument: ' + module
);
688 * Narrows a list of module names down to those matching a specific
689 * state. Possible states are 'undefined', 'registered', 'loading',
690 * 'loaded', or 'ready'
692 * @param states string or array of strings of module states to filter by
693 * @param modules array list of module names to filter (optional, all modules
694 * will be used by default)
695 * @return array list of filtered module names
697 function filter( states
, modules
) {
698 // Allow states to be given as a string
699 if ( typeof states
=== 'string' ) {
702 // If called without a list of modules, build and use a list of all modules
703 var list
= [], module
;
704 if ( typeof modules
=== 'undefined' ) {
706 for ( module
in registry
) {
707 modules
[modules
.length
] = module
;
710 // Build a list of modules which are in one of the specified states
711 for ( var s
= 0; s
< states
.length
; s
++ ) {
712 for ( var m
= 0; m
< modules
.length
; m
++ ) {
713 if ( typeof registry
[modules
[m
]] === 'undefined' ) {
714 // Module does not exist
715 if ( states
[s
] == 'undefined' ) {
717 list
[list
.length
] = modules
[m
];
720 // Module exists, check state
721 if ( registry
[modules
[m
]].state
=== states
[s
] ) {
723 list
[list
.length
] = modules
[m
];
732 * Executes a loaded module, making it ready to use
734 * @param module string module name to execute
736 function execute( module
, callback
) {
737 var _fn
= 'mw.loader::execute> ';
738 if ( typeof registry
[module
] === 'undefined' ) {
739 throw new Error( 'Module has not been registered yet: ' + module
);
740 } else if ( registry
[module
].state
=== 'registered' ) {
741 throw new Error( 'Module has not been requested from the server yet: ' + module
);
742 } else if ( registry
[module
].state
=== 'loading' ) {
743 throw new Error( 'Module has not completed loading yet: ' + module
);
744 } else if ( registry
[module
].state
=== 'ready' ) {
745 throw new Error( 'Module has already been loaded: ' + module
);
748 if ( $.isPlainObject( registry
[module
].style
) ) {
749 for ( var media
in registry
[module
].style
) {
750 var style
= registry
[module
].style
[media
];
751 if ( $.isArray( style
) ) {
752 for ( var i
= 0; i
< style
.length
; i
++ ) {
753 $marker
.before( mw
.html
.element( 'link', {
759 } else if ( typeof style
=== 'string' ) {
760 $marker
.before( mw
.html
.element(
762 { 'type': 'text/css', 'media': media
},
763 new mw
.html
.Cdata( style
)
768 // Add localizations to message system
769 if ( $.isPlainObject( registry
[module
].messages
) ) {
770 mw
.messages
.set( registry
[module
].messages
);
774 var script
= registry
[module
].script
;
775 if ( $.isArray( script
) ) {
777 for ( var i
= 0; i
< script
.length
; i
++ ) {
778 registry
[module
].state
= 'loading';
779 addScript( script
[i
], function() {
780 if ( ++done
== script
.length
) {
781 registry
[module
].state
= 'ready';
783 if ( $.isFunction( callback
) ) {
789 } else if ( $.isFunction( script
) ) {
791 registry
[module
].state
= 'ready';
793 if ( $.isFunction( callback
) ) {
798 // This needs to NOT use mw.log because these errors are common in production mode
799 // and not in debug mode, such as when a symbol that should be global isn't exported
800 if ( window
.console
&& typeof window
.console
.log
=== 'function' ) {
801 console
.log( _fn
+ 'Exception thrown by ' + module
+ ': ' + e
.message
);
804 registry
[module
].state
= 'error';
809 * Automatically executes jobs and modules which are pending with satistifed dependencies.
811 * This is used when dependencies are satisfied, such as when a module is executed.
813 function handlePending() {
815 // Run jobs who's dependencies have just been met
816 for ( var j
= 0; j
< jobs
.length
; j
++ ) {
818 filter( 'ready', jobs
[j
].dependencies
),
819 jobs
[j
].dependencies
) )
821 if ( $.isFunction( jobs
[j
].ready
) ) {
828 // Execute modules who's dependencies have just been met
829 for ( var r
in registry
) {
830 if ( registry
[r
].state
== 'loaded' ) {
832 filter( ['ready'], registry
[r
].dependencies
),
833 registry
[r
].dependencies
) )
840 // Run error callbacks of jobs affected by this condition
841 for ( var j
= 0; j
< jobs
.length
; j
++ ) {
842 if ( $.inArray( module
, jobs
[j
].dependencies
) !== -1 ) {
843 if ( $.isFunction( jobs
[j
].error
) ) {
854 * Adds a dependencies to the queue with optional callbacks to be run
855 * when the dependencies are ready or fail
857 * @param dependencies string module name or array of string module names
858 * @param ready function callback to execute when all dependencies are ready
859 * @param error function callback to execute when any dependency fails
861 function request( dependencies
, ready
, error
) {
862 // Allow calling by single module name
863 if ( typeof dependencies
=== 'string' ) {
864 dependencies
= [dependencies
];
865 if ( dependencies
[0] in registry
) {
866 for ( var n
= 0; n
< registry
[dependencies
[0]].dependencies
.length
; n
++ ) {
867 dependencies
[dependencies
.length
] =
868 registry
[dependencies
[0]].dependencies
[n
];
872 // Add ready and error callbacks if they were given
873 if ( arguments
.length
> 1 ) {
874 jobs
[jobs
.length
] = {
875 'dependencies': filter(
876 ['undefined', 'registered', 'loading', 'loaded'],
882 // Queue up any dependencies that are undefined or registered
883 dependencies
= filter( ['undefined', 'registered'], dependencies
);
884 for ( var n
= 0; n
< dependencies
.length
; n
++ ) {
885 if ( $.inArray( dependencies
[n
], queue
) === -1 ) {
886 queue
[queue
.length
] = dependencies
[n
];
893 function sortQuery(o
) {
894 var sorted
= {}, key
, a
= [];
896 if ( o
.hasOwnProperty( key
) ) {
901 for ( key
= 0; key
< a
.length
; key
++ ) {
902 sorted
[a
[key
]] = o
[a
[key
]];
908 * Converts a module map of the form { foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }
909 * to a query string of the form foo.bar,baz|bar.baz,quux
911 function buildModulesString( moduleMap
) {
913 for ( var prefix
in moduleMap
) {
914 var p
= prefix
=== '' ? '' : prefix
+ '.';
915 arr
.push( p
+ moduleMap
[prefix
].join( ',' ) );
917 return arr
.join( '|' ).replace( /\./g, '!' );
921 * Adds a script tag to the body, either using document.write or low-level DOM manipulation,
922 * depending on whether document-ready has occured yet.
924 * @param src String: URL to script, will be used as the src attribute in the script tag
925 * @param callback Function: Optional callback which will be run when the script is done
927 function addScript( src
, callback
) {
929 // jQuery's getScript method is NOT better than doing this the old-fassioned way
930 // because jQuery will eval the script's code, and errors will not have sane
932 var script
= document
.createElement( 'script' );
933 script
.setAttribute( 'src', src
);
934 script
.setAttribute( 'type', 'text/javascript' );
935 if ( $.isFunction( callback
) ) {
937 // Attach handlers for all browsers -- this is based on jQuery.getScript
938 script
.onload
= script
.onreadystatechange = function() {
943 || this.readyState
=== "loaded"
944 || this.readyState
=== "complete"
949 // Handle memory leak in IE
950 script
.onload
= script
.onreadystatechange
= null;
951 if ( script
.parentNode
) {
952 script
.parentNode
.removeChild( script
);
957 document
.body
.appendChild( script
);
959 document
.write( mw
.html
.element(
960 'script', { 'type': 'text/javascript', 'src': src
}, ''
962 if ( $.isFunction( callback
) ) {
963 // Document.write is synchronous, so this is called when it's done
972 * Requests dependencies from server, loading and executing when things when ready.
974 this.work = function() {
975 // Appends a list of modules to the batch
976 for ( var q
= 0; q
< queue
.length
; q
++ ) {
977 // Only request modules which are undefined or registered
978 if ( !( queue
[q
] in registry
) || registry
[queue
[q
]].state
== 'registered' ) {
979 // Prevent duplicate entries
980 if ( $.inArray( queue
[q
], batch
) === -1 ) {
981 batch
[batch
.length
] = queue
[q
];
982 // Mark registered modules as loading
983 if ( queue
[q
] in registry
) {
984 registry
[queue
[q
]].state
= 'loading';
989 // Clean up the queue
991 // After document ready, handle the batch
992 if ( !suspended
&& batch
.length
) {
993 // Always order modules alphabetically to help reduce cache
994 // misses for otherwise identical content
996 // Build a list of request parameters
998 'skin': mw
.config
.get( 'skin' ),
999 'lang': mw
.config
.get( 'wgUserLanguage' ),
1000 'debug': mw
.config
.get( 'debug' )
1002 // Extend request parameters with a list of modules in the batch
1004 // Split into groups
1006 for ( var b
= 0; b
< batch
.length
; b
++ ) {
1007 var group
= registry
[batch
[b
]].group
;
1008 if ( !( group
in groups
) ) {
1011 groups
[group
][groups
[group
].length
] = batch
[b
];
1013 for ( var group
in groups
) {
1014 // Calculate the highest timestamp
1016 for ( var g
= 0; g
< groups
[group
].length
; g
++ ) {
1017 if ( registry
[groups
[group
][g
]].version
> version
) {
1018 version
= registry
[groups
[group
][g
]].version
;
1021 var reqBase
= $.extend( { 'version': formatVersionNumber( version
) }, base
);
1022 var reqBaseLength
= $.param( reqBase
).length
;
1024 var limit
= mw
.config
.get( 'wgResourceLoaderMaxQueryLength', -1 );
1025 // We may need to split up the request to honor the query string length limit
1026 // So build it piece by piece
1027 var l
= reqBaseLength
+ 9; // '&modules='.length == 9
1029 reqs
[0] = {}; // { prefix: [ suffixes ] }
1030 for ( var i
= 0; i
< groups
[group
].length
; i
++ ) {
1031 // Determine how many bytes this module would add to the query string
1032 var lastDotIndex
= groups
[group
][i
].lastIndexOf( '.' );
1033 // Note that these substr() calls work even if lastDotIndex == -1
1034 var prefix
= groups
[group
][i
].substr( 0, lastDotIndex
);
1035 var suffix
= groups
[group
][i
].substr( lastDotIndex
+ 1 );
1036 var bytesAdded
= prefix
in reqs
[r
] ?
1037 suffix
.length
+ 3 : // '%2C'.length == 3
1038 groups
[group
][i
].length
+ 3; // '%7C'.length == 3
1040 // If the request would become too long, create a new one,
1041 // but don't create empty requests
1042 if ( limit
> 0 && reqs
[r
] != {} && l
+ bytesAdded
> limit
) {
1043 // This request would become too long, create a new one
1046 l
= reqBaseLength
+ 9;
1048 if ( !( prefix
in reqs
[r
] ) ) {
1049 reqs
[r
][prefix
] = [];
1051 reqs
[r
][prefix
].push( suffix
);
1054 for ( var r
= 0; r
< reqs
.length
; r
++ ) {
1055 requests
[requests
.length
] = $.extend(
1056 { 'modules': buildModulesString( reqs
[r
] ) }, reqBase
1060 // Clear the batch - this MUST happen before we append the
1061 // script element to the body or it's possible that the script
1062 // will be locally cached, instantly load, and work the batch
1063 // again, all before we've cleared it causing each request to
1064 // include modules which are already loaded
1066 // Asynchronously append a script tag to the end of the body
1067 for ( var r
= 0; r
< requests
.length
; r
++ ) {
1068 requests
[r
] = sortQuery( requests
[r
] );
1069 var src
= mw
.config
.get( 'wgLoadScript' ) + '?' + $.param( requests
[r
] );
1076 * Registers a module, letting the system know about it and its
1077 * dependencies. loader.js files contain calls to this function.
1079 this.register = function( module
, version
, dependencies
, group
) {
1080 // Allow multiple registration
1081 if ( typeof module
=== 'object' ) {
1082 for ( var m
= 0; m
< module
.length
; m
++ ) {
1083 if ( typeof module
[m
] === 'string' ) {
1084 mw
.loader
.register( module
[m
] );
1085 } else if ( typeof module
[m
] === 'object' ) {
1086 mw
.loader
.register
.apply( mw
.loader
, module
[m
] );
1092 if ( typeof module
!== 'string' ) {
1093 throw new Error( 'module must be a string, not a ' + typeof module
);
1095 if ( typeof registry
[module
] !== 'undefined' ) {
1096 throw new Error( 'module already implemeneted: ' + module
);
1098 // List the module as registered
1099 registry
[module
] = {
1100 'state': 'registered',
1101 'group': typeof group
=== 'string' ? group
: null,
1103 'version': typeof version
!== 'undefined' ? parseInt( version
, 10 ) : 0
1105 if ( typeof dependencies
=== 'string' ) {
1106 // Allow dependencies to be given as a single module name
1107 registry
[module
].dependencies
= [dependencies
];
1108 } else if ( typeof dependencies
=== 'object' || $.isFunction( dependencies
) ) {
1109 // Allow dependencies to be given as an array of module names
1110 // or a function which returns an array
1111 registry
[module
].dependencies
= dependencies
;
1116 * Implements a module, giving the system a course of action to take
1117 * upon loading. Results of a request for one or more modules contain
1118 * calls to this function.
1120 * All arguments are required.
1122 * @param module String: Name of module
1123 * @param script Mixed: Function of module code or String of URL to be used as the src
1124 * attribute when adding a script element to the body
1125 * @param style Object: Object of CSS strings keyed by media-type or Object of lists of URLs
1126 * keyed by media-type
1127 * @param msgs Object: List of key/value pairs to be passed through mw.messages.set
1129 this.implement = function( module
, script
, style
, msgs
) {
1131 if ( typeof module
!== 'string' ) {
1132 throw new Error( 'module must be a string, not a ' + typeof module
);
1134 if ( !$.isFunction( script
) && !$.isArray( script
) ) {
1135 throw new Error( 'script must be a function or an array, not a ' + typeof script
);
1137 if ( !$.isPlainObject( style
) ) {
1138 throw new Error( 'style must be an object or a string, not a ' + typeof style
);
1140 if ( !$.isPlainObject( msgs
) ) {
1141 throw new Error( 'msgs must be an object, not a ' + typeof msgs
);
1143 // Automatically register module
1144 if ( typeof registry
[module
] === 'undefined' ) {
1145 mw
.loader
.register( module
);
1147 // Check for duplicate implementation
1148 if ( typeof registry
[module
] !== 'undefined'
1149 && typeof registry
[module
].script
!== 'undefined' )
1151 throw new Error( 'module already implemeneted: ' + module
);
1153 // Mark module as loaded
1154 registry
[module
].state
= 'loaded';
1155 // Attach components
1156 registry
[module
].script
= script
;
1157 registry
[module
].style
= style
;
1158 registry
[module
].messages
= msgs
;
1159 // Execute or queue callback
1161 filter( ['ready'], registry
[module
].dependencies
),
1162 registry
[module
].dependencies
) )
1171 * Executes a function as soon as one or more required modules are ready
1173 * @param dependencies string or array of strings of modules names the callback
1174 * dependencies to be ready before
1176 * @param ready function callback to execute when all dependencies are ready (optional)
1177 * @param error function callback to execute when if dependencies have a errors (optional)
1179 this.using = function( dependencies
, ready
, error
) {
1181 if ( typeof dependencies
!== 'object' && typeof dependencies
!== 'string' ) {
1182 throw new Error( 'dependencies must be a string or an array, not a ' +
1183 typeof dependencies
);
1185 // Allow calling with a single dependency as a string
1186 if ( typeof dependencies
=== 'string' ) {
1187 dependencies
= [dependencies
];
1189 // Resolve entire dependency map
1190 dependencies
= resolve( dependencies
);
1191 // If all dependencies are met, execute ready immediately
1192 if ( compare( filter( ['ready'], dependencies
), dependencies
) ) {
1193 if ( $.isFunction( ready
) ) {
1197 // If any dependencies have errors execute error immediately
1198 else if ( filter( ['error'], dependencies
).length
) {
1199 if ( $.isFunction( error
) ) {
1203 // Since some dependencies are not yet ready, queue up a request
1205 request( dependencies
, ready
, error
);
1210 * Loads an external script or one or more modules for future use
1212 * @param modules mixed either the name of a module, array of modules,
1213 * or a URL of an external script or style
1214 * @param type string mime-type to use if calling with a URL of an
1215 * external script or style; acceptable values are "text/css" and
1216 * "text/javascript"; if no type is provided, text/javascript is
1219 this.load = function( modules
, type
) {
1221 if ( typeof modules
!== 'object' && typeof modules
!== 'string' ) {
1222 throw new Error( 'modules must be a string or an array, not a ' +
1225 // Allow calling with an external script or single dependency as a string
1226 if ( typeof modules
=== 'string' ) {
1227 // Support adding arbitrary external scripts
1228 if ( modules
.substr( 0, 7 ) == 'http://' || modules
.substr( 0, 8 ) == 'https://' ) {
1229 if ( type
=== 'text/css' ) {
1230 $( 'head' ).append( $( '<link />', {
1236 } else if ( type
=== 'text/javascript' || typeof type
=== 'undefined' ) {
1237 addScript( modules
);
1243 // Called with single module
1244 modules
= [modules
];
1246 // Resolve entire dependency map
1247 modules
= resolve( modules
);
1248 // If all modules are ready, nothing dependency be done
1249 if ( compare( filter( ['ready'], modules
), modules
) ) {
1252 // If any modules have errors return false
1253 else if ( filter( ['error'], modules
).length
) {
1256 // Since some modules are not yet ready, queue up a request
1264 * Flushes the request queue and begin executing load requests on demand
1266 this.go = function() {
1272 * Changes the state of a module
1274 * @param module string module name or object of module name/state pairs
1275 * @param state string state name
1277 this.state = function( module
, state
) {
1278 if ( typeof module
=== 'object' ) {
1279 for ( var m
in module
) {
1280 mw
.loader
.state( m
, module
[m
] );
1284 if ( !( module
in registry
) ) {
1285 mw
.loader
.register( module
);
1287 registry
[module
].state
= state
;
1291 * Gets the version of a module
1293 * @param module string name of module to get version for
1295 this.version = function( module
) {
1296 if ( module
in registry
&& 'version' in registry
[module
] ) {
1297 return formatVersionNumber( registry
[module
].version
);
1302 /* Cache document ready status */
1304 $(document
).ready( function() { ready
= true; } );
1307 /** HTML construction helper functions */
1308 this.html
= new ( function () {
1309 var escapeCallback = function( s
) {
1325 * Escape a string for HTML. Converts special characters to HTML entities.
1326 * @param s The string to escape
1328 this.escape = function( s
) {
1329 return s
.replace( /['"<>&]/g, escapeCallback
);
1333 * Wrapper object for raw HTML passed to mw.html.element().
1335 this.Raw = function( value
) {
1340 * Wrapper object for CDATA element contents passed to mw.html.element()
1342 this.Cdata = function( value
) {
1347 * Create an HTML element string, with safe escaping.
1349 * @param name The tag name.
1350 * @param attrs An object with members mapping element names to values
1351 * @param contents The contents of the element. May be either:
1352 * - string: The string is escaped.
1353 * - null or undefined: The short closing form is used, e.g. <br/>.
1354 * - this.Raw: The value attribute is included without escaping.
1355 * - this.Cdata: The value attribute is included, and an exception is
1356 * thrown if it contains an illegal ETAGO delimiter.
1357 * See http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.3.2
1361 * return h.element( 'div', {},
1362 * new h.Raw( h.element( 'img', {src: '<'} ) ) );
1363 * Returns <div><img src="<"/></div>
1365 this.element = function( name
, attrs
, contents
) {
1367 for ( var attrName
in attrs
) {
1368 s
+= ' ' + attrName
+ '="' + this.escape( attrs
[attrName
] ) + '"';
1370 if ( typeof contents
== 'undefined' || contents
=== null ) {
1377 if ( typeof contents
=== 'string') {
1379 s
+= this.escape( contents
);
1380 } else if ( contents
instanceof this.Raw
) {
1381 // Raw HTML inclusion
1382 s
+= contents
.value
;
1383 } else if ( contents
instanceof this.Cdata
) {
1385 if ( /<\/[a-zA-z]/.test( contents
.value
) ) {
1386 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
1388 s
+= contents
.value
;
1390 throw new Error( 'mw.html.element: Invalid type of contents' );
1392 s
+= '</' + name
+ '>';
1397 /* Extension points */
1403 // Alias $j to jQuery for backwards compatibility
1405 window
.mw
= mediaWiki
;
1407 /* Auto-register from pre-loaded startup scripts */
1409 if ( $.isFunction( startUp
) ) {
1414 // Add jQuery Cookie to initial payload (used in mw.user)
1415 mw
.loader
.load( 'jquery.cookie' );