| blob | 9fff95a5bd58fe5f4199c40c8d8fe765de448106 |
1 /*
2 * JavaScript backwards-compatibility alternatives and other convenience functions
3 */
5 jQuery.extend({
6 trimLeft : function( str ) {
7 return str === null ? '' : str.toString().replace( /^\s+/, '' );
8 },
9 trimRight : function( str ) {
10 return str === null ?
11 '' : str.toString().replace( /\s+$/, '' );
12 },
13 ucFirst : function( str ) {
14 return str.substr( 0, 1 ).toUpperCase() + str.substr( 1 );
15 },
16 escapeRE : function( str ) {
17 return str.replace ( /([\\{}()|.?*+\-^$\[\]])/g, "\\$1" );
18 },
19 isDomElement : function( el ) {
20 return !!el && !!el.nodeType;
21 },
22 isEmpty : function( v ) {
23 var key;
24 if ( v === "" || v === 0 || v === "0" || v === null
25 || v === false || typeof v === 'undefined' )
26 {
27 return true;
28 }
29 // the for-loop could potentially contain prototypes
30 // to avoid that we check it's length first
31 if ( v.length === 0 ) {
32 return true;
33 }
34 if ( typeof v === 'object' ) {
35 for ( key in v ) {
36 return false;
37 }
38 return true;
39 }
40 return false;
41 },
42 compareArray : function( arrThis, arrAgainst ) {
43 if ( arrThis.length != arrAgainst.length ) {
44 return false;
45 }
46 for ( var i = 0; i < arrThis.length; i++ ) {
47 if ( arrThis[i] instanceof Array ) {
48 if ( !$.compareArray( arrThis[i], arrAgainst[i] ) ) {
49 return false;
50 }
51 } else if ( arrThis[i] !== arrAgainst[i] ) {
52 return false;
53 }
54 }
55 return true;
56 },
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 ) {
66 return true;
67 } else {
68 var prop;
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
77 switch ( type ) {
78 case 'object' :
79 if ( !$.compareObject( objectA[prop], objectB[prop] ) ) {
80 return false;
81 }
82 break;
83 case 'function' :
84 // Functions need to be strings to compare them properly
85 if ( objectA[prop].toString() !== objectB[prop].toString() ) {
86 return false;
87 }
88 break;
89 default:
90 // Strings, numbers
91 if ( objectA[prop] !== objectB[prop] ) {
92 return false;
93 }
94 break;
95 }
96 } else {
97 return false;
98 }
99 } else {
100 return false;
101 }
102 }
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 ) ) {
109 return false;
110 }
111 }
112 }
113 }
114 } else {
115 return false;
116 }
117 return true;
118 }
119 });
121 /*
122 * Core MediaWiki JavaScript Library
123 */
125 // Attach to window
126 window.mediaWiki = new ( function( $ ) {
128 /* Constants */
130 /* Private Members */
132 // List of messages that have been requested to be loaded
133 var messageQueue = {};
135 /* Prototypes */
137 /**
138 * An object which allows single and multiple get/set/exists functionality
139 * on a list of key / value pairs.
140 *
141 * @param {boolean} global Whether to get/set/exists values on the window
142 * object or a private object
143 */
144 function Map( global ) {
145 this.values = ( global === true ) ? window : {};
146 }
148 /**
149 * Gets the value of a key, or a list of key/value pairs for an array of keys.
150 *
151 * If called with no arguments, all values will be returned.
152 *
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)
155 */
156 Map.prototype.get = function( selection, fallback ) {
157 if ( typeof selection === 'object' ) {
158 selection = $.makeArray( selection );
159 var results = {};
160 for ( var i = 0; i < selection.length; i++ ) {
161 results[selection[i]] = this.get( selection[i], fallback );
162 }
163 return results;
164 } else if ( typeof selection === 'string' ) {
165 if ( typeof this.values[selection] === 'undefined' ) {
166 if ( typeof fallback !== 'undefined' ) {
167 return fallback;
168 }
169 return null;
170 }
171 return this.values[selection];
172 }
173 return this.values;
174 };
176 /**
177 * Sets one or multiple key/value pairs.
178 *
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)
181 */
182 Map.prototype.set = function( selection, value ) {
183 if ( typeof selection === 'object' ) {
184 for ( var s in selection ) {
185 this.values[s] = selection[s];
186 }
187 return true;
188 } else if ( typeof selection === 'string' && typeof value !== 'undefined' ) {
189 this.values[selection] = value;
190 return true;
191 }
192 return false;
193 };
195 /**
196 * Checks if one or multiple keys exist.
197 *
198 * @param selection mixed Key or array of keys to check
199 * @return boolean Existence of key(s)
200 */
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 ) ) {
205 return false;
206 }
207 }
208 return true;
209 } else {
210 return selection in this.values;
211 }
212 };
214 /**
215 * Message object, similar to Message in PHP
216 */
217 function Message( map, key, parameters ) {
218 this.format = 'parse';
219 this.map = map;
220 this.key = key;
221 this.parameters = typeof parameters === 'undefined' ? [] : $.makeArray( parameters );
222 }
224 /**
225 * Appends parameters for replacement
226 *
227 * @param parameters mixed First in a list of variadic arguments to append as message parameters
228 */
229 Message.prototype.params = function( parameters ) {
230 for ( var i = 0; i < parameters.length; i++ ) {
231 this.parameters[this.parameters.length] = parameters[i];
232 }
233 return this;
234 };
236 /**
237 * Converts message object to it's string form based on the state of format
238 *
239 * @return {string} String form of message
240 */
241 Message.prototype.toString = function() {
242 if ( !this.map.exists( this.key ) ) {
243 // Return <key> if key does not exist
244 return '<' + this.key + '>';
245 }
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;
251 } );
253 if ( this.format === 'plain' ) {
254 return text;
255 }
256 if ( this.format === 'escaped' ) {
257 // According to Message.php this needs {{-transformation, which is
258 // still todo
259 return mw.html.escape( text );
260 }
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 );
265 }
266 */
267 return text;
268 };
270 /**
271 * Changes format to parse and converts message to string
272 *
273 * @return {string} String form of parsed message
274 */
275 Message.prototype.parse = function() {
276 this.format = 'parse';
277 return this.toString();
278 };
280 /**
281 * Changes format to plain and converts message to string
282 *
283 * @return {string} String form of plain message
284 */
285 Message.prototype.plain = function() {
286 this.format = 'plain';
287 return this.toString();
288 };
290 /**
291 * Changes the format to html escaped and converts message to string
292 *
293 * @return {string} String form of html escaped message
294 */
295 Message.prototype.escaped = function() {
296 this.format = 'escaped';
297 return this.toString();
298 };
300 /**
301 * Checks if message exists
302 *
303 * @return {string} String form of parsed message
304 */
305 Message.prototype.exists = function() {
306 return this.map.exists( this.key );
307 };
309 /**
310 * User object
311 */
312 function User() {
314 /* Private Members */
316 var that = this;
318 /* Public Members */
320 this.options = new Map();
322 /* Public Methods */
324 /**
325 * Generates a random user session ID (32 alpha-numeric characters).
326 *
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.
329 *
330 * @return string random set of 32 alpha-numeric characters
331 */
332 function generateId() {
333 var id = '';
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 );
338 }
339 return id;
340 }
342 /**
343 * Gets the current user's name.
344 *
345 * @return mixed user name string or null if users is anonymous
346 */
347 this.name = function() {
348 return mw.config.get( 'wgUserName' );
349 };
351 /**
352 * Checks if the current user is anonymous.
353 *
354 * @return boolean
355 */
356 this.anonymous = function() {
357 return that.name() ? false : true;
358 };
360 /**
361 * Gets a random session ID automatically generated and kept in a cookie.
362 *
363 * This ID is ephemeral for everyone, staying in their browser only until they close
364 * their browser.
365 *
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().
369 *
370 * @return string user name or random session ID
371 */
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': '/' } );
377 }
378 return sessionId;
379 };
381 /**
382 * Gets the current user's name or a random ID automatically generated and kept in a cookie.
383 *
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.
387 *
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().
391 *
392 * @return string user name or random session ID
393 */
394 this.id = function() {
395 var name = that.name();
396 if ( name ) {
397 return name;
398 }
399 var id = $.cookie( 'mediaWiki.user.id' );
400 if ( typeof id == 'undefined' || id === null ) {
401 id = generateId();
402 }
403 // Set cookie if not set, or renew it if already set
404 $.cookie( 'mediaWiki.user.id', id, { 'expires': 365, 'path': '/' } );
405 return id;
406 };
408 /**
409 * Gets the user's bucket, placing them in one at random based on set odds if needed.
410 *
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
422 *
423 * @example
424 * mw.user.bucket( 'test', {
425 * 'buckets': { 'ignored': 50, 'control': 25, 'test': 25 },
426 * 'version': 1,
427 * 'tracked': true,
428 * 'expires': 7
429 * } );
430 */
431 this.bucket = function( key, options ) {
432 options = $.extend( {
433 'buckets': {},
434 'version': 0,
435 'tracked': false,
436 'expires': 30
437 }, options || {} );
438 var cookie = $.cookie( 'mediaWiki.user.bucket:' + key );
439 var bucket = null;
440 var version = 0;
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] );
447 }
448 }
449 if ( bucket === null ) {
450 if ( !$.isPlainObject( options.buckets ) ) {
451 throw 'Invalid buckets error. Object expected for options.buckets.';
452 }
453 version = Number( options.version );
454 // Find range
455 var range = 0, k;
456 for ( k in options.buckets ) {
457 range += options.buckets[k];
458 }
459 // Select random value within range
460 var rand = Math.random() * range;
461 // Determine which bucket the value landed in
462 var total = 0;
463 for ( k in options.buckets ) {
464 bucket = k;
465 total += options.buckets[k];
466 if ( total >= rand ) {
467 break;
468 }
469 }
470 if ( options.tracked ) {
471 mw.loader.using( 'jquery.clickTracking', function() {
472 $.trackAction(
473 'mediaWiki.user.bucket:' + key + '@' + version + ':' + bucket
474 );
475 } );
476 }
477 $.cookie(
478 'mediaWiki.user.bucket:' + key,
479 version + ':' + bucket,
480 { 'path': '/', 'expires': Number( options.expires ) }
481 );
482 }
483 return bucket;
484 };
485 }
487 /* Public Members */
489 /*
490 * Dummy function which in debug mode can be replaced with a function that
491 * does something clever
492 */
493 this.log = function() { };
495 /*
496 * Make the Map-class publicly available
497 */
498 this.Map = Map;
500 /*
501 * List of configuration values
502 *
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.
506 */
507 this.config = null;
509 /*
510 * Information about the current user
511 */
512 this.user = new User();
514 /*
515 * Localization system
516 */
517 this.messages = new this.Map();
519 /* Public Methods */
521 /**
522 * Gets a message object, similar to wfMessage()
523 *
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 $
526 * replacement
527 */
528 this.message = function( key, parameters ) {
529 // Support variadic arguments
530 if ( typeof parameters !== 'undefined' ) {
531 parameters = $.makeArray( arguments );
532 parameters.shift();
533 } else {
534 parameters = [];
535 }
536 return new Message( mw.messages, key, parameters );
537 };
539 /**
540 * Gets a message string, similar to wfMsg()
541 *
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 $
544 * replacement
545 */
546 this.msg = function( key, parameters ) {
547 return mw.message.apply( mw.message, arguments ).toString();
548 };
550 /**
551 * Client-side module loader which integrates with the MediaWiki ResourceLoader
552 */
553 this.loader = new ( function() {
555 /* Private Members */
557 /**
558 * Mapping of registered modules
559 *
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
564 * mediawiki.
565 *
566 * Format:
567 * {
568 * 'moduleName': {
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)
575 * }
576 * }
577 */
578 var registry = {};
579 // List of modules which will be loaded as when ready
580 var batch = [];
581 // List of modules to be loaded
582 var queue = [];
583 // List of callback functions waiting for modules to be ready to be called
584 var jobs = [];
585 // Flag indicating that requests should be suspended
586 var suspended = true;
587 // Flag inidicating that document ready has occured
588 var ready = false;
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 ) {
596 return false;
597 }
598 for ( var i = 0; i < b.length; i++ ) {
599 if ( $.isArray( a[i] ) ) {
600 if ( !compare( a[i], b[i] ) ) {
601 return false;
602 }
603 }
604 if ( a[i] !== b[i] ) {
605 return false;
606 }
607 }
608 return true;
609 }
611 /**
612 * Generates an ISO8601 "basic" string from a UNIX timestamp
613 */
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( '' );
617 }
618 var d = new Date();
619 d.setTime( timestamp * 1000 );
620 return [
621 pad( d.getUTCFullYear(), d.getUTCMonth() + 1, d.getUTCDate() ), 'T',
622 pad( d.getUTCHours(), d.getUTCMinutes(), d.getUTCSeconds() ), 'Z'
623 ].join( '' );
624 }
626 /**
627 * Recursively resolves dependencies and detects circular references
628 */
629 function recurse( module, resolved, unresolved ) {
630 if ( typeof registry[module] === 'undefined' ) {
631 throw new Error( 'Unknown dependency: ' + module );
632 }
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];
639 }
640 }
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 ) {
645 throw new Error(
646 'Circular reference detected: ' + module +
647 ' -> ' + registry[module].dependencies[n]
648 );
649 }
650 recurse( registry[module].dependencies[n], resolved, unresolved );
651 }
652 }
653 resolved[resolved.length] = module;
654 unresolved.splice( $.inArray( module, unresolved ), 1 );
655 }
657 /**
658 * Gets a list of module names that a module depends on in their proper dependency order
659 *
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
663 */
664 function resolve( module ) {
665 // Allow calling with an array of module names
666 if ( typeof module === 'object' ) {
667 var modules = [];
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];
672 }
673 }
674 return modules;
675 } else if ( typeof module === 'string' ) {
676 // Undefined modules have no dependencies
677 if ( !( module in registry ) ) {
678 return [];
679 }
680 var resolved = [];
681 recurse( module, resolved, [] );
682 return resolved;
683 }
684 throw new Error( 'Invalid module argument: ' + module );
685 }
687 /**
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'
691 *
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
696 */
697 function filter( states, modules ) {
698 // Allow states to be given as a string
699 if ( typeof states === 'string' ) {
700 states = [states];
701 }
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' ) {
705 modules = [];
706 for ( module in registry ) {
707 modules[modules.length] = module;
708 }
709 }
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' ) {
716 // OK, undefined
717 list[list.length] = modules[m];
718 }
719 } else {
720 // Module exists, check state
721 if ( registry[modules[m]].state === states[s] ) {
722 // OK, correct state
723 list[list.length] = modules[m];
724 }
725 }
726 }
727 }
728 return list;
729 }
731 /**
732 * Executes a loaded module, making it ready to use
733 *
734 * @param module string module name to execute
735 */
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 );
746 }
747 // Add styles
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', {
754 'type': 'text/css',
755 'rel': 'stylesheet',
756 'href': style[i]
757 } ) );
758 }
759 } else if ( typeof style === 'string' ) {
760 $marker.before( mw.html.element(
761 'style',
762 { 'type': 'text/css', 'media': media },
763 new mw.html.Cdata( style )
764 ) );
765 }
766 }
767 }
768 // Add localizations to message system
769 if ( $.isPlainObject( registry[module].messages ) ) {
770 mw.messages.set( registry[module].messages );
771 }
772 // Execute script
773 try {
774 var script = registry[module].script;
775 if ( $.isArray( script ) ) {
776 var done = 0;
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';
782 handlePending();
783 if ( $.isFunction( callback ) ) {
784 callback();
785 }
786 }
787 } );
788 }
789 } else if ( $.isFunction( script ) ) {
790 script( jQuery );
791 registry[module].state = 'ready';
792 handlePending();
793 if ( $.isFunction( callback ) ) {
794 callback();
795 }
796 }
797 } catch ( e ) {
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 );
802 console.log( e );
803 }
804 registry[module].state = 'error';
805 }
806 }
808 /**
809 * Automatically executes jobs and modules which are pending with satistifed dependencies.
810 *
811 * This is used when dependencies are satisfied, such as when a module is executed.
812 */
813 function handlePending() {
814 try {
815 // Run jobs who's dependencies have just been met
816 for ( var j = 0; j < jobs.length; j++ ) {
817 if ( compare(
818 filter( 'ready', jobs[j].dependencies ),
819 jobs[j].dependencies ) )
820 {
821 if ( $.isFunction( jobs[j].ready ) ) {
822 jobs[j].ready();
823 }
824 jobs.splice( j, 1 );
825 j--;
826 }
827 }
828 // Execute modules who's dependencies have just been met
829 for ( var r in registry ) {
830 if ( registry[r].state == 'loaded' ) {
831 if ( compare(
832 filter( ['ready'], registry[r].dependencies ),
833 registry[r].dependencies ) )
834 {
835 execute( r );
836 }
837 }
838 }
839 } catch ( e ) {
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 ) ) {
844 jobs[j].error();
845 }
846 jobs.splice( j, 1 );
847 j--;
848 }
849 }
850 }
851 }
853 /**
854 * Adds a dependencies to the queue with optional callbacks to be run
855 * when the dependencies are ready or fail
856 *
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
860 */
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];
869 }
870 }
871 }
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'],
877 dependencies ),
878 'ready': ready,
879 'error': error
880 };
881 }
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];
887 }
888 }
889 // Work the queue
890 mw.loader.work();
891 }
893 function sortQuery(o) {
894 var sorted = {}, key, a = [];
895 for ( key in o ) {
896 if ( o.hasOwnProperty( key ) ) {
897 a.push( key );
898 }
899 }
900 a.sort();
901 for ( key = 0; key < a.length; key++ ) {
902 sorted[a[key]] = o[a[key]];
903 }
904 return sorted;
905 }
907 /**
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
910 */
911 function buildModulesString( moduleMap ) {
912 var arr = [];
913 for ( var prefix in moduleMap ) {
914 var p = prefix === '' ? '' : prefix + '.';
915 arr.push( p + moduleMap[prefix].join( ',' ) );
916 }
917 return arr.join( '|' ).replace( /\./g, '!' );
918 }
920 /**
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.
923 *
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
926 */
927 function addScript( src, callback ) {
928 if ( ready ) {
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
931 // line numbers.
932 var script = document.createElement( 'script' );
933 script.setAttribute( 'src', src );
934 script.setAttribute( 'type', 'text/javascript' );
935 if ( $.isFunction( callback ) ) {
936 script.onload = script.onreadystatechange = callback;
937 }
938 document.body.appendChild( script );
939 } else {
940 document.write( mw.html.element(
941 'script', { 'type': 'text/javascript', 'src': src }, ''
942 ) );
943 if ( $.isFunction( callback ) ) {
944 // Document.write is synchronous, so this is called when it's done
945 callback();
946 }
947 }
948 }
950 /* Public Methods */
952 /**
953 * Requests dependencies from server, loading and executing when things when ready.
954 */
955 this.work = function() {
956 // Appends a list of modules to the batch
957 for ( var q = 0; q < queue.length; q++ ) {
958 // Only request modules which are undefined or registered
959 if ( !( queue[q] in registry ) || registry[queue[q]].state == 'registered' ) {
960 // Prevent duplicate entries
961 if ( $.inArray( queue[q], batch ) === -1 ) {
962 batch[batch.length] = queue[q];
963 // Mark registered modules as loading
964 if ( queue[q] in registry ) {
965 registry[queue[q]].state = 'loading';
966 }
967 }
968 }
969 }
970 // Clean up the queue
971 queue = [];
972 // After document ready, handle the batch
973 if ( !suspended && batch.length ) {
974 // Always order modules alphabetically to help reduce cache
975 // misses for otherwise identical content
976 batch.sort();
977 // Build a list of request parameters
978 var base = {
979 'skin': mw.config.get( 'skin' ),
980 'lang': mw.config.get( 'wgUserLanguage' ),
981 'debug': mw.config.get( 'debug' )
982 };
983 // Extend request parameters with a list of modules in the batch
984 var requests = [];
985 // Split into groups
986 var groups = {};
987 for ( var b = 0; b < batch.length; b++ ) {
988 var group = registry[batch[b]].group;
989 if ( !( group in groups ) ) {
990 groups[group] = [];
991 }
992 groups[group][groups[group].length] = batch[b];
993 }
994 for ( var group in groups ) {
995 // Calculate the highest timestamp
996 var version = 0;
997 for ( var g = 0; g < groups[group].length; g++ ) {
998 if ( registry[groups[group][g]].version > version ) {
999 version = registry[groups[group][g]].version;
1000 }
1001 }
1002 var reqBase = $.extend( { 'version': formatVersionNumber( version ) }, base );
1003 var reqBaseLength = $.param( reqBase ).length;
1004 var reqs = [];
1005 var limit = mw.config.get( 'wgResourceLoaderMaxQueryLength', -1 );
1006 // We may need to split up the request to honor the query string length limit
1007 // So build it piece by piece
1008 var l = reqBaseLength + 9; // '&modules='.length == 9
1009 var r = 0;
1010 reqs[0] = {}; // { prefix: [ suffixes ] }
1011 for ( var i = 0; i < groups[group].length; i++ ) {
1012 // Determine how many bytes this module would add to the query string
1013 var lastDotIndex = groups[group][i].lastIndexOf( '.' );
1014 // Note that these substr() calls work even if lastDotIndex == -1
1015 var prefix = groups[group][i].substr( 0, lastDotIndex );
1016 var suffix = groups[group][i].substr( lastDotIndex + 1 );
1017 var bytesAdded = prefix in reqs[r] ?
1018 suffix.length + 3 : // '%2C'.length == 3
1019 groups[group][i].length + 3; // '%7C'.length == 3
1021 // If the request would become too long, create a new one,
1022 // but don't create empty requests
1023 if ( limit > 0 && reqs[r] != {} && l + bytesAdded > limit ) {
1024 // This request would become too long, create a new one
1025 r++;
1026 reqs[r] = {};
1027 l = reqBaseLength + 9;
1028 }
1029 if ( !( prefix in reqs[r] ) ) {
1030 reqs[r][prefix] = [];
1031 }
1032 reqs[r][prefix].push( suffix );
1033 l += bytesAdded;
1034 }
1035 for ( var r = 0; r < reqs.length; r++ ) {
1036 requests[requests.length] = $.extend(
1037 { 'modules': buildModulesString( reqs[r] ) }, reqBase
1038 );
1039 }
1040 }
1041 // Clear the batch - this MUST happen before we append the
1042 // script element to the body or it's possible that the script
1043 // will be locally cached, instantly load, and work the batch
1044 // again, all before we've cleared it causing each request to
1045 // include modules which are already loaded
1046 batch = [];
1047 // Asynchronously append a script tag to the end of the body
1048 for ( var r = 0; r < requests.length; r++ ) {
1049 requests[r] = sortQuery( requests[r] );
1050 var src = mw.config.get( 'wgLoadScript' ) + '?' + $.param( requests[r] );
1051 addScript( src );
1052 }
1053 }
1054 };
1056 /**
1057 * Registers a module, letting the system know about it and its
1058 * dependencies. loader.js files contain calls to this function.
1059 */
1060 this.register = function( module, version, dependencies, group ) {
1061 // Allow multiple registration
1062 if ( typeof module === 'object' ) {
1063 for ( var m = 0; m < module.length; m++ ) {
1064 if ( typeof module[m] === 'string' ) {
1065 mw.loader.register( module[m] );
1066 } else if ( typeof module[m] === 'object' ) {
1067 mw.loader.register.apply( mw.loader, module[m] );
1068 }
1069 }
1070 return;
1071 }
1072 // Validate input
1073 if ( typeof module !== 'string' ) {
1074 throw new Error( 'module must be a string, not a ' + typeof module );
1075 }
1076 if ( typeof registry[module] !== 'undefined' ) {
1077 throw new Error( 'module already implemeneted: ' + module );
1078 }
1079 // List the module as registered
1080 registry[module] = {
1081 'state': 'registered',
1082 'group': typeof group === 'string' ? group : null,
1083 'dependencies': [],
1084 'version': typeof version !== 'undefined' ? parseInt( version, 10 ) : 0
1085 };
1086 if ( typeof dependencies === 'string' ) {
1087 // Allow dependencies to be given as a single module name
1088 registry[module].dependencies = [dependencies];
1089 } else if ( typeof dependencies === 'object' || $.isFunction( dependencies ) ) {
1090 // Allow dependencies to be given as an array of module names
1091 // or a function which returns an array
1092 registry[module].dependencies = dependencies;
1093 }
1094 };
1096 /**
1097 * Implements a module, giving the system a course of action to take
1098 * upon loading. Results of a request for one or more modules contain
1099 * calls to this function.
1100 *
1101 * All arguments are required.
1102 *
1103 * @param module String: Name of module
1104 * @param script Mixed: Function of module code or String of URL to be used as the src
1105 * attribute when adding a script element to the body
1106 * @param style Object: Object of CSS strings keyed by media-type or Object of lists of URLs
1107 * keyed by media-type
1108 * as the href attribute when adding a link element to the head
1109 * @param msgs Object: List of key/value pairs to be passed through mw.messages.set
1110 */
1111 this.implement = function( module, script, style, msgs ) {
1112 // Validate input
1113 if ( typeof module !== 'string' ) {
1114 throw new Error( 'module must be a string, not a ' + typeof module );
1115 }
1116 if ( !$.isFunction( script ) && !$.isArray( script ) ) {
1117 throw new Error( 'script must be a function or an array, not a ' + typeof script );
1118 }
1119 if ( !$.isPlainObject( style ) ) {
1120 throw new Error( 'style must be a object or a string, not a ' + typeof style );
1121 }
1122 if ( !$.isPlainObject( msgs ) ) {
1123 throw new Error( 'msgs must be an object, not a ' + typeof msgs );
1124 }
1125 // Automatically register module
1126 if ( typeof registry[module] === 'undefined' ) {
1127 mw.loader.register( module );
1128 }
1129 // Check for duplicate implementation
1130 if ( typeof registry[module] !== 'undefined'
1131 && typeof registry[module].script !== 'undefined' )
1132 {
1133 throw new Error( 'module already implemeneted: ' + module );
1134 }
1135 // Mark module as loaded
1136 registry[module].state = 'loaded';
1137 // Attach components
1138 registry[module].script = script;
1139 registry[module].style = style;
1140 registry[module].messages = msgs;
1141 // Execute or queue callback
1142 if ( compare(
1143 filter( ['ready'], registry[module].dependencies ),
1144 registry[module].dependencies ) )
1145 {
1146 execute( module );
1147 } else {
1148 request( module );
1149 }
1150 };
1152 /**
1153 * Executes a function as soon as one or more required modules are ready
1154 *
1155 * @param dependencies string or array of strings of modules names the callback
1156 * dependencies to be ready before
1157 * executing
1158 * @param ready function callback to execute when all dependencies are ready (optional)
1159 * @param error function callback to execute when if dependencies have a errors (optional)
1160 */
1161 this.using = function( dependencies, ready, error ) {
1162 // Validate input
1163 if ( typeof dependencies !== 'object' && typeof dependencies !== 'string' ) {
1164 throw new Error( 'dependencies must be a string or an array, not a ' +
1165 typeof dependencies );
1166 }
1167 // Allow calling with a single dependency as a string
1168 if ( typeof dependencies === 'string' ) {
1169 dependencies = [dependencies];
1170 }
1171 // Resolve entire dependency map
1172 dependencies = resolve( dependencies );
1173 // If all dependencies are met, execute ready immediately
1174 if ( compare( filter( ['ready'], dependencies ), dependencies ) ) {
1175 if ( $.isFunction( ready ) ) {
1176 ready();
1177 }
1178 }
1179 // If any dependencies have errors execute error immediately
1180 else if ( filter( ['error'], dependencies ).length ) {
1181 if ( $.isFunction( error ) ) {
1182 error();
1183 }
1184 }
1185 // Since some dependencies are not yet ready, queue up a request
1186 else {
1187 request( dependencies, ready, error );
1188 }
1189 };
1191 /**
1192 * Loads an external script or one or more modules for future use
1193 *
1194 * @param modules mixed either the name of a module, array of modules,
1195 * or a URL of an external script or style
1196 * @param type string mime-type to use if calling with a URL of an
1197 * external script or style; acceptable values are "text/css" and
1198 * "text/javascript"; if no type is provided, text/javascript is
1199 * assumed
1200 */
1201 this.load = function( modules, type ) {
1202 // Validate input
1203 if ( typeof modules !== 'object' && typeof modules !== 'string' ) {
1204 throw new Error( 'modules must be a string or an array, not a ' +
1205 typeof modules );
1206 }
1207 // Allow calling with an external script or single dependency as a string
1208 if ( typeof modules === 'string' ) {
1209 // Support adding arbitrary external scripts
1210 if ( modules.substr( 0, 7 ) == 'http://' || modules.substr( 0, 8 ) == 'https://' ) {
1211 if ( type === 'text/css' ) {
1212 $( 'head' ).append( $( '<link />', {
1213 rel: 'stylesheet',
1214 type: 'text/css',
1215 href: modules
1216 } ) );
1217 return true;
1218 } else if ( type === 'text/javascript' || typeof type === 'undefined' ) {
1219 addScript( modules );
1220 return true;
1221 }
1222 // Unknown type
1223 return false;
1224 }
1225 // Called with single module
1226 modules = [modules];
1227 }
1228 // Resolve entire dependency map
1229 modules = resolve( modules );
1230 // If all modules are ready, nothing dependency be done
1231 if ( compare( filter( ['ready'], modules ), modules ) ) {
1232 return true;
1233 }
1234 // If any modules have errors return false
1235 else if ( filter( ['error'], modules ).length ) {
1236 return false;
1237 }
1238 // Since some modules are not yet ready, queue up a request
1239 else {
1240 request( modules );
1241 return true;
1242 }
1243 };
1245 /**
1246 * Flushes the request queue and begin executing load requests on demand
1247 */
1248 this.go = function() {
1249 suspended = false;
1250 mw.loader.work();
1251 };
1253 /**
1254 * Changes the state of a module
1255 *
1256 * @param module string module name or object of module name/state pairs
1257 * @param state string state name
1258 */
1259 this.state = function( module, state ) {
1260 if ( typeof module === 'object' ) {
1261 for ( var m in module ) {
1262 mw.loader.state( m, module[m] );
1263 }
1264 return;
1265 }
1266 if ( !( module in registry ) ) {
1267 mw.loader.register( module );
1268 }
1269 registry[module].state = state;
1270 };
1272 /**
1273 * Gets the version of a module
1274 *
1275 * @param module string name of module to get version for
1276 */
1277 this.version = function( module ) {
1278 if ( module in registry && 'version' in registry[module] ) {
1279 return formatVersionNumber( registry[module].version );
1280 }
1281 return null;
1282 };
1284 /* Cache document ready status */
1286 $(document).ready( function() { ready = true; } );
1287 } )();
1289 /** HTML construction helper functions */
1290 this.html = new ( function () {
1291 var escapeCallback = function( s ) {
1292 switch ( s ) {
1293 case "'":
1294 return ''';
1295 case '"':
1296 return '"';
1297 case '<':
1298 return '<';
1299 case '>':
1300 return '>';
1301 case '&':
1302 return '&';
1303 }
1304 };
1306 /**
1307 * Escape a string for HTML. Converts special characters to HTML entities.
1308 * @param s The string to escape
1309 */
1310 this.escape = function( s ) {
1311 return s.replace( /['"<>&]/g, escapeCallback );
1312 };
1314 /**
1315 * Wrapper object for raw HTML passed to mw.html.element().
1316 */
1317 this.Raw = function( value ) {
1318 this.value = value;
1319 };
1321 /**
1322 * Wrapper object for CDATA element contents passed to mw.html.element()
1323 */
1324 this.Cdata = function( value ) {
1325 this.value = value;
1326 };
1328 /**
1329 * Create an HTML element string, with safe escaping.
1330 *
1331 * @param name The tag name.
1332 * @param attrs An object with members mapping element names to values
1333 * @param contents The contents of the element. May be either:
1334 * - string: The string is escaped.
1335 * - null or undefined: The short closing form is used, e.g. <br/>.
1336 * - this.Raw: The value attribute is included without escaping.
1337 * - this.Cdata: The value attribute is included, and an exception is
1338 * thrown if it contains an illegal ETAGO delimiter.
1339 * See http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.3.2
1340 *
1341 * Example:
1342 * var h = mw.html;
1343 * return h.element( 'div', {},
1344 * new h.Raw( h.element( 'img', {src: '<'} ) ) );
1345 * Returns <div><img src="<"/></div>
1346 */
1347 this.element = function( name, attrs, contents ) {
1348 var s = '<' + name;
1349 for ( var attrName in attrs ) {
1350 s += ' ' + attrName + '="' + this.escape( attrs[attrName] ) + '"';
1351 }
1352 if ( typeof contents == 'undefined' || contents === null ) {
1353 // Self close tag
1354 s += '/>';
1355 return s;
1356 }
1357 // Regular open tag
1358 s += '>';
1359 if ( typeof contents === 'string') {
1360 // Escaped
1361 s += this.escape( contents );
1362 } else if ( contents instanceof this.Raw ) {
1363 // Raw HTML inclusion
1364 s += contents.value;
1365 } else if ( contents instanceof this.Cdata ) {
1366 // CDATA
1367 if ( /<\/[a-zA-z]/.test( contents.value ) ) {
1368 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
1369 }
1370 s += contents.value;
1371 } else {
1372 throw new Error( 'mw.html.element: Invalid type of contents' );
1373 }
1374 s += '</' + name + '>';
1375 return s;
1376 };
1377 } )();
1379 /* Extension points */
1381 this.legacy = {};
1383 } )( jQuery );
1385 // Alias $j to jQuery for backwards compatibility
1386 window.$j = jQuery;
1387 window.mw = mediaWiki;
1389 /* Auto-register from pre-loaded startup scripts */
1391 if ( $.isFunction( startUp ) ) {
1392 startUp();
1393 delete startUp;
1394 }
1396 // Add jQuery Cookie to initial payload (used in mw.user)
1397 mw.loader.load( 'jquery.cookie' );