-/*
- * JavaScript backwards-compatibility alternatives and other convenience functions
- */
-
-jQuery.extend({
- trimLeft : function( str ) {
- return str === null ? '' : str.toString().replace( /^\s+/, '' );
- },
- trimRight : function( str ) {
- return str === null ?
- '' : str.toString().replace( /\s+$/, '' );
- },
- ucFirst : function( str ) {
- return str.substr( 0, 1 ).toUpperCase() + str.substr( 1 );
- },
- escapeRE : function( str ) {
- return str.replace ( /([\\{}()|.?*+\-^$\[\]])/g, "\\$1" );
- },
- isDomElement : function( el ) {
- return !!el && !!el.nodeType;
- },
- isEmpty : function( v ) {
- var key;
- if ( v === "" || v === 0 || v === "0" || v === null
- || v === false || typeof v === 'undefined' )
- {
- return true;
- }
- // the for-loop could potentially contain prototypes
- // to avoid that we check it's length first
- if ( v.length === 0 ) {
- return true;
- }
- if ( typeof v === 'object' ) {
- for ( key in v ) {
- return false;
- }
- return true;
- }
- return false;
- },
- compareArray : function( arrThis, arrAgainst ) {
- if ( arrThis.length != arrAgainst.length ) {
- return false;
- }
- for ( var i = 0; i < arrThis.length; i++ ) {
- if ( arrThis[i] instanceof Array ) {
- if ( !$.compareArray( arrThis[i], arrAgainst[i] ) ) {
- return false;
- }
- } else if ( arrThis[i] !== arrAgainst[i] ) {
- return false;
- }
- }
- return true;
- },
- compareObject : function( objectA, objectB ) {
-
- // Do a simple check if the types match
- if ( typeof objectA == typeof objectB ) {
-
- // Only loop over the contents if it really is an object
- if ( typeof objectA == 'object' ) {
- // If they are aliases of the same object (ie. mw and mediaWiki) return now
- if ( objectA === objectB ) {
- return true;
- } else {
- var prop;
- // Iterate over each property
- for ( prop in objectA ) {
- // Check if this property is also present in the other object
- if ( prop in objectB ) {
- // Compare the types of the properties
- var type = typeof objectA[prop];
- if ( type == typeof objectB[prop] ) {
- // Recursively check objects inside this one
- switch ( type ) {
- case 'object' :
- if ( !$.compareObject( objectA[prop], objectB[prop] ) ) {
- return false;
- }
- break;
- case 'function' :
- // Functions need to be strings to compare them properly
- if ( objectA[prop].toString() !== objectB[prop].toString() ) {
- return false;
- }
- break;
- default:
- // Strings, numbers
- if ( objectA[prop] !== objectB[prop] ) {
- return false;
- }
- break;
- }
- } else {
- return false;
- }
- } else {
- return false;
- }
- }
- // Check for properties in B but not in A
- // This is about 15% faster (tested in Safari 5 and Firefox 3.6)
- // ...than incrementing a count variable in the above and below loops
- // See also: http://www.mediawiki.org/wiki/ResourceLoader/Default_modules/compareObject_test#Results
- for ( prop in objectB ) {
- if ( !( prop in objectA ) ) {
- return false;
- }
- }
- }
- }
- } else {
- return false;
- }
- return true;
- }
-});
-
/*
* Core MediaWiki JavaScript Library
*/
-// Attach to window
-window.mediaWiki = new ( function( $ ) {
-
- /* Constants */
+var mw = ( function ( $, undefined ) {
+"use strict";
/* Private Members */
- // List of messages that have been requested to be loaded
- var messageQueue = {};
-
- /* Prototypes */
+ var hasOwn = Object.prototype.hasOwnProperty;
+ /* Object constructors */
/**
- * An object which allows single and multiple get/set/exists functionality
- * on a list of key / value pairs.
+ * Map
+ *
+ * Creates an object that can be read from or written to from prototype functions
+ * that allow both single and multiple variables at once.
*
- * @param {boolean} global Whether to get/set/exists values on the window
- * object or a private object
+ * @param global boolean Whether to store the values in the global window
+ * object or a exclusively in the object property 'values'.
+ * @return Map
*/
function Map( global ) {
- this.values = ( global === true ) ? window : {};
+ this.values = global === true ? window : {};
+ return this;
}
- /**
- * Gets the value of a key, or a list of key/value pairs for an array of keys.
- *
- * If called with no arguments, all values will be returned.
- *
- * @param selection mixed Key or array of keys to get values for
- * @param fallback mixed Value to use in case key(s) do not exist (optional)
- */
- Map.prototype.get = function( selection, fallback ) {
- if ( typeof selection === 'object' ) {
- selection = $.makeArray( selection );
- var results = {};
- for ( var i = 0; i < selection.length; i++ ) {
- results[selection[i]] = this.get( selection[i], fallback );
- }
- return results;
- } else if ( typeof selection === 'string' ) {
- if ( typeof this.values[selection] === 'undefined' ) {
- if ( typeof fallback !== 'undefined' ) {
- return fallback;
+ Map.prototype = {
+ /**
+ * Get the value of one or multiple a keys.
+ *
+ * If called with no arguments, all values will be returned.
+ *
+ * @param selection mixed String key or array of keys to get values for.
+ * @param fallback mixed Value to use in case key(s) do not exist (optional).
+ * @return mixed If selection was a string returns the value or null,
+ * If selection was an array, returns an object of key/values (value is null if not found),
+ * If selection was not passed or invalid, will return the 'values' object member (be careful as
+ * objects are always passed by reference in JavaScript!).
+ * @return Values as a string or object, null if invalid/inexistant.
+ */
+ get: function ( selection, fallback ) {
+ var results, i;
+
+ if ( $.isArray( selection ) ) {
+ selection = $.makeArray( selection );
+ results = {};
+ for ( i = 0; i < selection.length; i += 1 ) {
+ results[selection[i]] = this.get( selection[i], fallback );
+ }
+ return results;
+ } else if ( typeof selection === 'string' ) {
+ if ( this.values[selection] === undefined ) {
+ if ( fallback !== undefined ) {
+ return fallback;
+ }
+ return null;
}
- return null;
+ return this.values[selection];
}
- return this.values[selection];
- }
- return this.values;
- };
-
- /**
- * Sets one or multiple key/value pairs.
- *
- * @param selection mixed Key or object of key/value pairs to set
- * @param value mixed Value to set (optional, only in use when key is a string)
- */
- Map.prototype.set = function( selection, value ) {
- if ( typeof selection === 'object' ) {
- for ( var s in selection ) {
- this.values[s] = selection[s];
+ if ( selection === undefined ) {
+ return this.values;
+ } else {
+ return null; // invalid selection key
}
- return true;
- } else if ( typeof selection === 'string' && typeof value !== 'undefined' ) {
- this.values[selection] = value;
- return true;
- }
- return false;
- };
+ },
- /**
- * Checks if one or multiple keys exist.
- *
- * @param selection mixed Key or array of keys to check
- * @return boolean Existence of key(s)
- */
- Map.prototype.exists = function( selection ) {
- if ( typeof selection === 'object' ) {
- for ( var s = 0; s < selection.length; s++ ) {
- if ( !( selection[s] in this.values ) ) {
- return false;
+ /**
+ * Sets one or multiple key/value pairs.
+ *
+ * @param selection {mixed} String key or array of keys to set values for.
+ * @param value {mixed} Value to set (optional, only in use when key is a string)
+ * @return {Boolean} This returns true on success, false on failure.
+ */
+ set: function ( selection, value ) {
+ var s;
+
+ if ( $.isPlainObject( selection ) ) {
+ for ( s in selection ) {
+ this.values[s] = selection[s];
}
+ return true;
+ } else if ( typeof selection === 'string' && value !== undefined ) {
+ this.values[selection] = value;
+ return true;
}
- return true;
- } else {
- return selection in this.values;
- }
- };
-
- /**
- * Message object, similar to Message in PHP
- */
- function Message( map, key, parameters ) {
- this.format = 'parse';
- this.map = map;
- this.key = key;
- this.parameters = typeof parameters === 'undefined' ? [] : $.makeArray( parameters );
- }
+ return false;
+ },
- /**
- * Appends parameters for replacement
- *
- * @param parameters mixed First in a list of variadic arguments to append as message parameters
- */
- Message.prototype.params = function( parameters ) {
- for ( var i = 0; i < parameters.length; i++ ) {
- this.parameters[this.parameters.length] = parameters[i];
- }
- return this;
- };
+ /**
+ * Checks if one or multiple keys exist.
+ *
+ * @param selection {mixed} String key or array of keys to check
+ * @return {Boolean} Existence of key(s)
+ */
+ exists: function ( selection ) {
+ var s;
- /**
- * Converts message object to it's string form based on the state of format
- *
- * @return {string} String form of message
- */
- Message.prototype.toString = function() {
- if ( !this.map.exists( this.key ) ) {
- // Return <key> if key does not exist
- return '<' + this.key + '>';
- }
- var text = this.map.get( this.key );
- var parameters = this.parameters;
- text = text.replace( /\$(\d+)/g, function( string, match ) {
- var index = parseInt( match, 10 ) - 1;
- return index in parameters ? parameters[index] : '$' + match;
- } );
-
- if ( this.format === 'plain' ) {
- return text;
- }
- if ( this.format === 'escaped' ) {
- // According to Message.php this needs {{-transformation, which is
- // still todo
- return mw.html.escape( text );
- }
-
- /* This should be fixed up when we have a parser
- if ( this.format === 'parse' && 'language' in mediaWiki ) {
- text = mw.language.parse( text );
+ if ( $.isArray( selection ) ) {
+ for ( s = 0; s < selection.length; s += 1 ) {
+ if ( this.values[selection[s]] === undefined ) {
+ return false;
+ }
+ }
+ return true;
+ } else {
+ return this.values[selection] !== undefined;
+ }
}
- */
- return text;
};
/**
- * Changes format to parse and converts message to string
+ * Message
*
- * @return {string} String form of parsed message
- */
- Message.prototype.parse = function() {
- this.format = 'parse';
- return this.toString();
- };
-
- /**
- * Changes format to plain and converts message to string
+ * Object constructor for messages,
+ * similar to the Message class in MediaWiki PHP.
*
- * @return {string} String form of plain message
+ * @param map Map Instance of mw.Map
+ * @param key String
+ * @param parameters Array
+ * @return Message
*/
- Message.prototype.plain = function() {
+ function Message( map, key, parameters ) {
this.format = 'plain';
- return this.toString();
- };
-
- /**
- * Changes the format to html escaped and converts message to string
- *
- * @return {string} String form of html escaped message
- */
- Message.prototype.escaped = function() {
- this.format = 'escaped';
- return this.toString();
- };
-
- /**
- * Checks if message exists
- *
- * @return {string} String form of parsed message
- */
- Message.prototype.exists = function() {
- return this.map.exists( this.key );
- };
-
- /**
- * User object
- */
- function User() {
-
- /* Private Members */
-
- var that = this;
-
- /* Public Members */
-
- this.options = new Map();
-
- /* Public Methods */
-
- /**
- * Generates a random user session ID (32 alpha-numeric characters).
- *
- * This information would potentially be stored in a cookie to identify a user during a
- * session or series of sessions. It's uniqueness should not be depended on.
- *
- * @return string random set of 32 alpha-numeric characters
- */
- function generateId() {
- var id = '';
- var seed = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
- for ( var i = 0, r; i < 32; i++ ) {
- r = Math.floor( Math.random() * seed.length );
- id += seed.substring( r, r + 1 );
- }
- return id;
- }
-
- /**
- * Gets the current user's name.
- *
- * @return mixed user name string or null if users is anonymous
- */
- this.name = function() {
- return mw.config.get( 'wgUserName' );
- };
+ this.map = map;
+ this.key = key;
+ this.parameters = parameters === undefined ? [] : $.makeArray( parameters );
+ return this;
+ }
+ Message.prototype = {
/**
- * Checks if the current user is anonymous.
+ * Simple message parser, does $N replacement and nothing else.
+ * This may be overridden to provide a more complex message parser.
*
- * @return boolean
+ * This function will not be called for nonexistent messages.
*/
- this.anonymous = function() {
- return that.name() ? false : true;
- };
-
+ parser: function() {
+ var parameters = this.parameters;
+ return this.map.get( this.key ).replace( /\$(\d+)/g, function ( str, match ) {
+ var index = parseInt( match, 10 ) - 1;
+ return parameters[index] !== undefined ? parameters[index] : '$' + match;
+ } );
+ },
+
/**
- * Gets a random session ID automatically generated and kept in a cookie.
- *
- * This ID is ephemeral for everyone, staying in their browser only until they close
- * their browser.
- *
- * Do not use this method before the first call to mw.loader.go(), it depends on
- * jquery.cookie, which is added to the first pay-load just after mediaWiki is defined, but
- * won't be loaded until the first call to go().
- *
- * @return string user name or random session ID
+ * Appends (does not replace) parameters for replacement to the .parameters property.
+ *
+ * @param parameters Array
+ * @return Message
*/
- this.sessionId = function () {
- var sessionId = $.cookie( 'mediaWiki.user.sessionId' );
- if ( typeof sessionId == 'undefined' || sessionId === null ) {
- sessionId = generateId();
- $.cookie( 'mediaWiki.user.sessionId', sessionId, { 'expires': null, 'path': '/' } );
+ params: function ( parameters ) {
+ var i;
+ for ( i = 0; i < parameters.length; i += 1 ) {
+ this.parameters.push( parameters[i] );
}
- return sessionId;
- };
+ return this;
+ },
/**
- * Gets the current user's name or a random ID automatically generated and kept in a cookie.
- *
- * This ID is persistent for anonymous users, staying in their browser up to 1 year. The
- * expiration time is reset each time the ID is queried, so in most cases this ID will
- * persist until the browser's cookies are cleared or the user doesn't visit for 1 year.
- *
- * Do not use this method before the first call to mw.loader.go(), it depends on
- * jquery.cookie, which is added to the first pay-load just after mediaWiki is defined, but
- * won't be loaded until the first call to go().
- *
- * @return string user name or random session ID
+ * Converts message object to it's string form based on the state of format.
+ *
+ * @return string Message as a string in the current form or <key> if key does not exist.
*/
- this.id = function() {
- var name = that.name();
- if ( name ) {
- return name;
+ toString: function() {
+ var text;
+
+ if ( !this.exists() ) {
+ // Use <key> as text if key does not exist
+ if ( this.format !== 'plain' ) {
+ // format 'escape' and 'parse' need to have the brackets and key html escaped
+ return mw.html.escape( '<' + this.key + '>' );
+ }
+ return '<' + this.key + '>';
}
- var id = $.cookie( 'mediaWiki.user.id' );
- if ( typeof id == 'undefined' || id === null ) {
- id = generateId();
+
+ if ( this.format === 'plain' ) {
+ // @todo FIXME: Although not applicable to core Message,
+ // Plugins like jQueryMsg should be able to distinguish
+ // between 'plain' (only variable replacement and plural/gender)
+ // and actually parsing wikitext to HTML.
+ text = this.parser();
}
- // Set cookie if not set, or renew it if already set
- $.cookie( 'mediaWiki.user.id', id, { 'expires': 365, 'path': '/' } );
- return id;
- };
- /**
- * Gets the user's bucket, placing them in one at random based on set odds if needed.
- *
- * @param key String: Name of bucket
- * @param options Object: Bucket configuration options
- * @param options.buckets Object: List of bucket-name/relative-probability pairs (required,
- * must have at least one pair)
- * @param options.version Number: Version of bucket test, changing this forces rebucketing
- * (optional, default: 0)
- * @param options.tracked Boolean: Track the event of bucketing through the API module of
- * the ClickTracking extension (optional, default: false)
- * @param options.expires Number: Length of time (in days) until the user gets rebucketed
- * (optional, default: 30)
- * @return String: Bucket name - the randomly chosen key of the options.buckets object
- *
- * @example
- * mw.user.bucket( 'test', {
- * 'buckets': { 'ignored': 50, 'control': 25, 'test': 25 },
- * 'version': 1,
- * 'tracked': true,
- * 'expires': 7
- * } );
- */
- this.bucket = function( key, options ) {
- options = $.extend( {
- 'buckets': {},
- 'version': 0,
- 'tracked': false,
- 'expires': 30
- }, options || {} );
- var cookie = $.cookie( 'mediaWiki.user.bucket:' + key );
- var bucket = null;
- var version = 0;
- // Bucket information is stored as 2 integers, together as version:bucket like: "1:2"
- if ( typeof cookie === 'string' && cookie.length > 2 && cookie.indexOf( ':' ) > 0 ) {
- var parts = cookie.split( ':' );
- if ( parts.length > 1 && parts[0] == options.version ) {
- version = Number( parts[0] );
- bucket = String( parts[1] );
- }
+ if ( this.format === 'escaped' ) {
+ text = this.parser();
+ text = mw.html.escape( text );
}
- if ( bucket === null ) {
- if ( !$.isPlainObject( options.buckets ) ) {
- throw 'Invalid buckets error. Object expected for options.buckets.';
- }
- version = Number( options.version );
- // Find range
- var range = 0, k;
- for ( k in options.buckets ) {
- range += options.buckets[k];
- }
- // Select random value within range
- var rand = Math.random() * range;
- // Determine which bucket the value landed in
- var total = 0;
- for ( k in options.buckets ) {
- bucket = k;
- total += options.buckets[k];
- if ( total >= rand ) {
- break;
- }
- }
- if ( options.tracked ) {
- mw.loader.using( 'jquery.clickTracking', function() {
- $.trackAction(
- 'mediaWiki.user.bucket:' + key + '@' + version + ':' + bucket
- );
- } );
- }
- $.cookie(
- 'mediaWiki.user.bucket:' + key,
- version + ':' + bucket,
- { 'path': '/', 'expires': Number( options.expires ) }
- );
+
+ if ( this.format === 'parse' ) {
+ text = this.parser();
}
- return bucket;
- };
- }
-
- /* Public Members */
-
- /*
- * Dummy function which in debug mode can be replaced with a function that
- * does something clever
- */
- this.log = function() { };
-
- /*
- * Make the Map-class publicly available
- */
- this.Map = Map;
- /*
- * List of configuration values
- *
- * Dummy placeholder. Initiated in startUp module as a new instance of mw.Map().
- * If $wgLegacyJavaScriptGlobals is true, this Map will have its values
- * in the global window object.
- */
- this.config = null;
+ return text;
+ },
- /*
- * Information about the current user
- */
- this.user = new User();
+ /**
+ * Changes format to parse and converts message to string
+ *
+ * @return {string} String form of parsed message
+ */
+ parse: function() {
+ this.format = 'parse';
+ return this.toString();
+ },
- /*
- * Localization system
- */
- this.messages = new this.Map();
+ /**
+ * Changes format to plain and converts message to string
+ *
+ * @return {string} String form of plain message
+ */
+ plain: function() {
+ this.format = 'plain';
+ return this.toString();
+ },
- /* Public Methods */
+ /**
+ * Changes the format to html escaped and converts message to string
+ *
+ * @return {string} String form of html escaped message
+ */
+ escaped: function() {
+ this.format = 'escaped';
+ return this.toString();
+ },
- /**
- * Gets a message object, similar to wfMessage()
- *
- * @param key string Key of message to get
- * @param parameters mixed First argument in a list of variadic arguments, each a parameter for $
- * replacement
- */
- this.message = function( key, parameters ) {
- // Support variadic arguments
- if ( typeof parameters !== 'undefined' ) {
- parameters = $.makeArray( arguments );
- parameters.shift();
- } else {
- parameters = [];
+ /**
+ * Checks if message exists
+ *
+ * @return {string} String form of parsed message
+ */
+ exists: function() {
+ return this.map.exists( this.key );
}
- return new Message( mw.messages, key, parameters );
- };
-
- /**
- * Gets a message string, similar to wfMsg()
- *
- * @param key string Key of message to get
- * @param parameters mixed First argument in a list of variadic arguments, each a parameter for $
- * replacement
- */
- this.msg = function( key, parameters ) {
- return mw.message.apply( mw.message, arguments ).toString();
};
- /**
- * Client-side module loader which integrates with the MediaWiki ResourceLoader
- */
- this.loader = new ( function() {
-
- /* Private Members */
+ return {
+ /* Public Members */
/**
- * Mapping of registered modules
- *
- * The jquery module is pre-registered, because it must have already
- * been provided for this object to have been built, and in debug mode
- * jquery would have been provided through a unique loader request,
- * making it impossible to hold back registration of jquery until after
- * mediawiki.
- *
- * Format:
- * {
- * 'moduleName': {
- * 'dependencies': ['required module', 'required module', ...], (or) function() {}
- * 'state': 'registered', 'loading', 'loaded', 'ready', or 'error'
- * 'script': function() {},
- * 'style': 'css code string',
- * 'messages': { 'key': 'value' },
- * 'version': ############## (unix timestamp)
- * }
- * }
+ * Dummy function which in debug mode can be replaced with a function that
+ * emulates console.log in console-less environments.
*/
- var registry = {};
- // List of modules which will be loaded as when ready
- var batch = [];
- // List of modules to be loaded
- var queue = [];
- // List of callback functions waiting for modules to be ready to be called
- var jobs = [];
- // Flag indicating that requests should be suspended
- var suspended = true;
- // Flag inidicating that document ready has occured
- var ready = false;
- // Marker element for adding dynamic styles
- var $marker = $( 'head meta[name=ResourceLoaderDynamicStyles]' );
-
- /* Private Methods */
-
- function compare( a, b ) {
- if ( a.length != b.length ) {
- return false;
- }
- for ( var i = 0; i < b.length; i++ ) {
- if ( $.isArray( a[i] ) ) {
- if ( !compare( a[i], b[i] ) ) {
- return false;
- }
- }
- if ( a[i] !== b[i] ) {
- return false;
- }
- }
- return true;
- }
-
+ log: function() { },
+
/**
- * Generates an ISO8601 "basic" string from a UNIX timestamp
+ * @var constructor Make the Map constructor publicly available.
*/
- function formatVersionNumber( timestamp ) {
- function pad( a, b, c ) {
- return [a < 10 ? '0' + a : a, b < 10 ? '0' + b : b, c < 10 ? '0' + c : c].join( '' );
- }
- var d = new Date();
- d.setTime( timestamp * 1000 );
- return [
- pad( d.getUTCFullYear(), d.getUTCMonth() + 1, d.getUTCDate() ), 'T',
- pad( d.getUTCHours(), d.getUTCMinutes(), d.getUTCSeconds() ), 'Z'
- ].join( '' );
- }
+ Map: Map,
/**
- * Recursively resolves dependencies and detects circular references
+ * @var constructor Make the Message constructor publicly available.
*/
- function recurse( module, resolved, unresolved ) {
- if ( typeof registry[module] === 'undefined' ) {
- throw new Error( 'Unknown dependency: ' + module );
- }
- // Resolves dynamic loader function and replaces it with its own results
- if ( $.isFunction( registry[module].dependencies ) ) {
- registry[module].dependencies = registry[module].dependencies();
- // Ensures the module's dependencies are always in an array
- if ( typeof registry[module].dependencies !== 'object' ) {
- registry[module].dependencies = [registry[module].dependencies];
- }
- }
- // Tracks down dependencies
- for ( var n = 0; n < registry[module].dependencies.length; n++ ) {
- if ( $.inArray( registry[module].dependencies[n], resolved ) === -1 ) {
- if ( $.inArray( registry[module].dependencies[n], unresolved ) !== -1 ) {
- throw new Error(
- 'Circular reference detected: ' + module +
- ' -> ' + registry[module].dependencies[n]
- );
- }
- recurse( registry[module].dependencies[n], resolved, unresolved );
- }
- }
- resolved[resolved.length] = module;
- unresolved.splice( $.inArray( module, unresolved ), 1 );
- }
-
+ Message: Message,
+
/**
- * Gets a list of module names that a module depends on in their proper dependency order
+ * List of configuration values
*
- * @param module string module name or array of string module names
- * @return list of dependencies
- * @throws Error if circular reference is detected
+ * Dummy placeholder. Initiated in startUp module as a new instance of mw.Map().
+ * If $wgLegacyJavaScriptGlobals is true, this Map will have its values
+ * in the global window object.
*/
- function resolve( module ) {
- // Allow calling with an array of module names
- if ( typeof module === 'object' ) {
- var modules = [];
- for ( var m = 0; m < module.length; m++ ) {
- var dependencies = resolve( module[m] );
- for ( var n = 0; n < dependencies.length; n++ ) {
- modules[modules.length] = dependencies[n];
- }
- }
- return modules;
- } else if ( typeof module === 'string' ) {
- // Undefined modules have no dependencies
- if ( !( module in registry ) ) {
- return [];
- }
- var resolved = [];
- recurse( module, resolved, [] );
- return resolved;
- }
- throw new Error( 'Invalid module argument: ' + module );
- }
-
+ config: null,
+
/**
- * Narrows a list of module names down to those matching a specific
- * state. Possible states are 'undefined', 'registered', 'loading',
- * 'loaded', or 'ready'
+ * @var object
*
- * @param states string or array of strings of module states to filter by
- * @param modules array list of module names to filter (optional, all modules
- * will be used by default)
- * @return array list of filtered module names
+ * Empty object that plugins can be installed in.
*/
- function filter( states, modules ) {
- // Allow states to be given as a string
- if ( typeof states === 'string' ) {
- states = [states];
- }
- // If called without a list of modules, build and use a list of all modules
- var list = [], module;
- if ( typeof modules === 'undefined' ) {
- modules = [];
- for ( module in registry ) {
- modules[modules.length] = module;
- }
- }
- // Build a list of modules which are in one of the specified states
- for ( var s = 0; s < states.length; s++ ) {
- for ( var m = 0; m < modules.length; m++ ) {
- if ( typeof registry[modules[m]] === 'undefined' ) {
- // Module does not exist
- if ( states[s] == 'undefined' ) {
- // OK, undefined
- list[list.length] = modules[m];
- }
- } else {
- // Module exists, check state
- if ( registry[modules[m]].state === states[s] ) {
- // OK, correct state
- list[list.length] = modules[m];
- }
- }
- }
- }
- return list;
- }
-
+ libs: {},
+
+ /* Extension points */
+
+ legacy: {},
+
+ /**
+ * Localization system
+ */
+ messages: new Map(),
+
+ /* Public Methods */
+
/**
- * Executes a loaded module, making it ready to use
+ * Gets a message object, similar to wfMessage()
*
- * @param module string module name to execute
+ * @param key string Key of message to get
+ * @param parameter_1 mixed First argument in a list of variadic arguments,
+ * each a parameter for $N replacement in messages.
+ * @return Message
*/
- function execute( module, callback ) {
- var _fn = 'mw.loader::execute> ';
- if ( typeof registry[module] === 'undefined' ) {
- throw new Error( 'Module has not been registered yet: ' + module );
- } else if ( registry[module].state === 'registered' ) {
- throw new Error( 'Module has not been requested from the server yet: ' + module );
- } else if ( registry[module].state === 'loading' ) {
- throw new Error( 'Module has not completed loading yet: ' + module );
- } else if ( registry[module].state === 'ready' ) {
- throw new Error( 'Module has already been loaded: ' + module );
+ message: function ( key, parameter_1 /* [, parameter_2] */ ) {
+ var parameters;
+ // Support variadic arguments
+ if ( parameter_1 !== undefined ) {
+ parameters = $.makeArray( arguments );
+ parameters.shift();
+ } else {
+ parameters = [];
}
- // Add styles
- if ( $.isPlainObject( registry[module].style ) ) {
- for ( var media in registry[module].style ) {
- var style = registry[module].style[media];
- if ( $.isArray( style ) ) {
- for ( var i = 0; i < style.length; i++ ) {
- $marker.before( mw.html.element( 'link', {
- 'type': 'text/css',
- 'rel': 'stylesheet',
- 'href': style[i]
- } ) );
- }
- } else if ( typeof style === 'string' ) {
- $marker.before( mw.html.element(
- 'style',
- { 'type': 'text/css', 'media': media },
- new mw.html.Cdata( style )
- ) );
- }
- }
- }
- // Add localizations to message system
- if ( $.isPlainObject( registry[module].messages ) ) {
- mw.messages.set( registry[module].messages );
- }
- // Execute script
- try {
- var script = registry[module].script;
- if ( $.isArray( script ) ) {
- var done = 0;
- for ( var i = 0; i < script.length; i++ ) {
- registry[module].state = 'loading';
- addScript( script[i], function() {
- if ( ++done == script.length ) {
- registry[module].state = 'ready';
- handlePending();
- if ( $.isFunction( callback ) ) {
- callback();
- }
- }
- } );
- }
- } else if ( $.isFunction( script ) ) {
- script( jQuery );
- registry[module].state = 'ready';
- handlePending();
- if ( $.isFunction( callback ) ) {
- callback();
- }
- }
- } catch ( e ) {
- // This needs to NOT use mw.log because these errors are common in production mode
- // and not in debug mode, such as when a symbol that should be global isn't exported
- if ( window.console && typeof window.console.log === 'function' ) {
- console.log( _fn + 'Exception thrown by ' + module + ': ' + e.message );
- console.log( e );
- }
- registry[module].state = 'error';
- }
- }
-
+ return new Message( mw.messages, key, parameters );
+ },
+
/**
- * Automatically executes jobs and modules which are pending with satistifed dependencies.
- *
- * This is used when dependencies are satisfied, such as when a module is executed.
+ * Gets a message string, similar to wfMsg()
+ *
+ * @param key string Key of message to get
+ * @param parameters mixed First argument in a list of variadic arguments,
+ * each a parameter for $N replacement in messages.
+ * @return String.
*/
- function handlePending() {
- try {
- // Run jobs who's dependencies have just been met
- for ( var j = 0; j < jobs.length; j++ ) {
- if ( compare(
- filter( 'ready', jobs[j].dependencies ),
- jobs[j].dependencies ) )
- {
- if ( $.isFunction( jobs[j].ready ) ) {
- jobs[j].ready();
- }
- jobs.splice( j, 1 );
- j--;
+ msg: function ( key, parameters ) {
+ return mw.message.apply( mw.message, arguments ).toString();
+ },
+
+ /**
+ * Client-side module loader which integrates with the MediaWiki ResourceLoader
+ */
+ loader: ( function() {
+
+ /* Private Members */
+
+ /**
+ * Mapping of registered modules
+ *
+ * The jquery module is pre-registered, because it must have already
+ * been provided for this object to have been built, and in debug mode
+ * jquery would have been provided through a unique loader request,
+ * making it impossible to hold back registration of jquery until after
+ * mediawiki.
+ *
+ * For exact details on support for script, style and messages, look at
+ * mw.loader.implement.
+ *
+ * Format:
+ * {
+ * 'moduleName': {
+ * 'version': ############## (unix timestamp),
+ * 'dependencies': ['required.foo', 'bar.also', ...], (or) function() {}
+ * 'group': 'somegroup', (or) null,
+ * 'source': 'local', 'someforeignwiki', (or) null
+ * 'state': 'registered', 'loading', 'loaded', 'ready', 'error' or 'missing'
+ * 'script': ...,
+ * 'style': ...,
+ * 'messages': { 'key': 'value' },
+ * }
+ * }
+ */
+ var registry = {},
+ /**
+ * Mapping of sources, keyed by source-id, values are objects.
+ * Format:
+ * {
+ * 'sourceId': {
+ * 'loadScript': 'http://foo.bar/w/load.php'
+ * }
+ * }
+ */
+ sources = {},
+ // List of modules which will be loaded as when ready
+ batch = [],
+ // List of modules to be loaded
+ queue = [],
+ // List of callback functions waiting for modules to be ready to be called
+ jobs = [],
+ // Flag indicating that document ready has occured
+ ready = false,
+ // Whether we should try to load scripts in a blocking way
+ // Set with setBlocking()
+ blocking = false,
+ // Selector cache for the marker element. Use getMarker() to get/use the marker!
+ $marker = null;
+
+ /* Cache document ready status */
+
+ $(document).ready( function () {
+ ready = true;
+ } );
+
+ /* Private methods */
+
+ function getMarker(){
+ // Cached ?
+ if ( $marker ) {
+ return $marker;
+ } else {
+ $marker = $( 'meta[name="ResourceLoaderDynamicStyles"]' );
+ if ( $marker.length ) {
+ return $marker;
}
+ mw.log( 'getMarker> No <meta name="ResourceLoaderDynamicStyles"> found, inserting dynamically.' );
+ $marker = $( '<meta>' ).attr( 'name', 'ResourceLoaderDynamicStyles' ).appendTo( 'head' );
+ return $marker;
}
- // Execute modules who's dependencies have just been met
- for ( var r in registry ) {
- if ( registry[r].state == 'loaded' ) {
- if ( compare(
- filter( ['ready'], registry[r].dependencies ),
- registry[r].dependencies ) )
- {
- execute( r );
- }
- }
+ }
+
+ function compare( a, b ) {
+ var i;
+ if ( a.length !== b.length ) {
+ return false;
}
- } catch ( e ) {
- // Run error callbacks of jobs affected by this condition
- for ( var j = 0; j < jobs.length; j++ ) {
- if ( $.inArray( module, jobs[j].dependencies ) !== -1 ) {
- if ( $.isFunction( jobs[j].error ) ) {
- jobs[j].error();
+ for ( i = 0; i < b.length; i += 1 ) {
+ if ( $.isArray( a[i] ) ) {
+ if ( !compare( a[i], b[i] ) ) {
+ return false;
}
- jobs.splice( j, 1 );
- j--;
}
- }
- }
- }
-
- /**
- * Adds a dependencies to the queue with optional callbacks to be run
- * when the dependencies are ready or fail
- *
- * @param dependencies string module name or array of string module names
- * @param ready function callback to execute when all dependencies are ready
- * @param error function callback to execute when any dependency fails
- */
- function request( dependencies, ready, error ) {
- // Allow calling by single module name
- if ( typeof dependencies === 'string' ) {
- dependencies = [dependencies];
- if ( dependencies[0] in registry ) {
- for ( var n = 0; n < registry[dependencies[0]].dependencies.length; n++ ) {
- dependencies[dependencies.length] =
- registry[dependencies[0]].dependencies[n];
+ if ( a[i] !== b[i] ) {
+ return false;
}
}
+ return true;
}
- // Add ready and error callbacks if they were given
- if ( arguments.length > 1 ) {
- jobs[jobs.length] = {
- 'dependencies': filter(
- ['undefined', 'registered', 'loading', 'loaded'],
- dependencies ),
- 'ready': ready,
- 'error': error
- };
+
+ /**
+ * Generates an ISO8601 "basic" string from a UNIX timestamp
+ */
+ function formatVersionNumber( timestamp ) {
+ var pad = function ( a, b, c ) {
+ return [a < 10 ? '0' + a : a, b < 10 ? '0' + b : b, c < 10 ? '0' + c : c].join( '' );
+ },
+ d = new Date();
+ d.setTime( timestamp * 1000 );
+ return [
+ pad( d.getUTCFullYear(), d.getUTCMonth() + 1, d.getUTCDate() ), 'T',
+ pad( d.getUTCHours(), d.getUTCMinutes(), d.getUTCSeconds() ), 'Z'
+ ].join( '' );
}
- // Queue up any dependencies that are undefined or registered
- dependencies = filter( ['undefined', 'registered'], dependencies );
- for ( var n = 0; n < dependencies.length; n++ ) {
- if ( $.inArray( dependencies[n], queue ) === -1 ) {
- queue[queue.length] = dependencies[n];
+
+ /**
+ * Recursively resolves dependencies and detects circular references
+ */
+ function recurse( module, resolved, unresolved ) {
+ var n, deps, len;
+
+ if ( registry[module] === undefined ) {
+ throw new Error( 'Unknown dependency: ' + module );
}
- }
- // Work the queue
- mw.loader.work();
- }
+ // Resolves dynamic loader function and replaces it with its own results
+ if ( $.isFunction( registry[module].dependencies ) ) {
+ registry[module].dependencies = registry[module].dependencies();
+ // Ensures the module's dependencies are always in an array
+ if ( typeof registry[module].dependencies !== 'object' ) {
+ registry[module].dependencies = [registry[module].dependencies];
+ }
+ }
+ // Tracks down dependencies
+ deps = registry[module].dependencies;
+ len = deps.length;
+ for ( n = 0; n < len; n += 1 ) {
+ if ( $.inArray( deps[n], resolved ) === -1 ) {
+ if ( $.inArray( deps[n], unresolved ) !== -1 ) {
+ throw new Error(
+ 'Circular reference detected: ' + module +
+ ' -> ' + deps[n]
+ );
+ }
- function sortQuery(o) {
- var sorted = {}, key, a = [];
- for ( key in o ) {
- if ( o.hasOwnProperty( key ) ) {
- a.push( key );
+ // Add to unresolved
+ unresolved[unresolved.length] = module;
+ recurse( deps[n], resolved, unresolved );
+ // module is at the end of unresolved
+ unresolved.pop();
+ }
}
+ resolved[resolved.length] = module;
}
- a.sort();
- for ( key = 0; key < a.length; key++ ) {
- sorted[a[key]] = o[a[key]];
- }
- return sorted;
- }
-
- /**
- * Converts a module map of the form { foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }
- * to a query string of the form foo.bar,baz|bar.baz,quux
- */
- function buildModulesString( moduleMap ) {
- var arr = [];
- for ( var prefix in moduleMap ) {
- var p = prefix === '' ? '' : prefix + '.';
- arr.push( p + moduleMap[prefix].join( ',' ) );
+
+ /**
+ * Gets a list of module names that a module depends on in their proper dependency order
+ *
+ * @param module string module name or array of string module names
+ * @return list of dependencies, including 'module'.
+ * @throws Error if circular reference is detected
+ */
+ function resolve( module ) {
+ var modules, m, deps, n, resolved;
+
+ // Allow calling with an array of module names
+ if ( $.isArray( module ) ) {
+ modules = [];
+ for ( m = 0; m < module.length; m += 1 ) {
+ deps = resolve( module[m] );
+ for ( n = 0; n < deps.length; n += 1 ) {
+ modules[modules.length] = deps[n];
+ }
+ }
+ return modules;
+ } else if ( typeof module === 'string' ) {
+ resolved = [];
+ recurse( module, resolved, [] );
+ return resolved;
+ }
+ throw new Error( 'Invalid module argument: ' + module );
}
- return arr.join( '|' ).replace( /\./g, '!' );
- }
-
- /**
- * Adds a script tag to the body, either using document.write or low-level DOM manipulation,
- * depending on whether document-ready has occured yet.
- *
- * @param src String: URL to script, will be used as the src attribute in the script tag
- * @param callback Function: Optional callback which will be run when the script is done
- */
- function addScript( src, callback ) {
- if ( ready ) {
- // jQuery's getScript method is NOT better than doing this the old-fassioned way
- // because jQuery will eval the script's code, and errors will not have sane
- // line numbers.
- var script = document.createElement( 'script' );
- script.setAttribute( 'src', src );
- script.setAttribute( 'type', 'text/javascript' );
- if ( $.isFunction( callback ) ) {
- script.onload = script.onreadystatechange = callback;
+
+ /**
+ * Narrows a list of module names down to those matching a specific
+ * state (see comment on top of this scope for a list of valid states).
+ * One can also filter for 'unregistered', which will return the
+ * modules names that don't have a registry entry.
+ *
+ * @param states string or array of strings of module states to filter by
+ * @param modules array list of module names to filter (optional, by default the entire
+ * registry is used)
+ * @return array list of filtered module names
+ */
+ function filter( states, modules ) {
+ var list, module, s, m;
+
+ // Allow states to be given as a string
+ if ( typeof states === 'string' ) {
+ states = [states];
}
- document.body.appendChild( script );
- } else {
- document.write( mw.html.element(
- 'script', { 'type': 'text/javascript', 'src': src }, ''
- ) );
- if ( $.isFunction( callback ) ) {
- // Document.write is synchronous, so this is called when it's done
- callback();
+ // If called without a list of modules, build and use a list of all modules
+ list = [];
+ if ( modules === undefined ) {
+ modules = [];
+ for ( module in registry ) {
+ modules[modules.length] = module;
+ }
}
+ // Build a list of modules which are in one of the specified states
+ for ( s = 0; s < states.length; s += 1 ) {
+ for ( m = 0; m < modules.length; m += 1 ) {
+ if ( registry[modules[m]] === undefined ) {
+ // Module does not exist
+ if ( states[s] === 'unregistered' ) {
+ // OK, undefined
+ list[list.length] = modules[m];
+ }
+ } else {
+ // Module exists, check state
+ if ( registry[modules[m]].state === states[s] ) {
+ // OK, correct state
+ list[list.length] = modules[m];
+ }
+ }
+ }
+ }
+ return list;
}
- }
-
- /* Public Methods */
-
- /**
- * Requests dependencies from server, loading and executing when things when ready.
- */
- this.work = function() {
- // Appends a list of modules to the batch
- for ( var q = 0; q < queue.length; q++ ) {
- // Only request modules which are undefined or registered
- if ( !( queue[q] in registry ) || registry[queue[q]].state == 'registered' ) {
- // Prevent duplicate entries
- if ( $.inArray( queue[q], batch ) === -1 ) {
- batch[batch.length] = queue[q];
- // Mark registered modules as loading
- if ( queue[q] in registry ) {
- registry[queue[q]].state = 'loading';
+
+ /**
+ * Automatically executes jobs and modules which are pending with satistifed dependencies.
+ *
+ * This is used when dependencies are satisfied, such as when a module is executed.
+ */
+ function handlePending( module ) {
+ var j, r;
+
+ try {
+ // Run jobs who's dependencies have just been met
+ for ( j = 0; j < jobs.length; j += 1 ) {
+ if ( compare(
+ filter( 'ready', jobs[j].dependencies ),
+ jobs[j].dependencies ) )
+ {
+ if ( $.isFunction( jobs[j].ready ) ) {
+ jobs[j].ready();
+ }
+ jobs.splice( j, 1 );
+ j -= 1;
+ }
+ }
+ // Execute modules who's dependencies have just been met
+ for ( r in registry ) {
+ if ( registry[r].state === 'loaded' ) {
+ if ( compare(
+ filter( ['ready'], registry[r].dependencies ),
+ registry[r].dependencies ) )
+ {
+ execute( r );
+ }
+ }
+ }
+ } catch ( e ) {
+ // Run error callbacks of jobs affected by this condition
+ for ( j = 0; j < jobs.length; j += 1 ) {
+ if ( $.inArray( module, jobs[j].dependencies ) !== -1 ) {
+ if ( $.isFunction( jobs[j].error ) ) {
+ jobs[j].error( e, module );
+ }
+ jobs.splice( j, 1 );
+ j -= 1;
}
}
}
}
- // Clean up the queue
- queue = [];
- // After document ready, handle the batch
- if ( !suspended && batch.length ) {
- // Always order modules alphabetically to help reduce cache
- // misses for otherwise identical content
- batch.sort();
- // Build a list of request parameters
- var base = {
- 'skin': mw.config.get( 'skin' ),
- 'lang': mw.config.get( 'wgUserLanguage' ),
- 'debug': mw.config.get( 'debug' )
- };
- // Extend request parameters with a list of modules in the batch
- var requests = [];
- // Split into groups
- var groups = {};
- for ( var b = 0; b < batch.length; b++ ) {
- var group = registry[batch[b]].group;
- if ( !( group in groups ) ) {
- groups[group] = [];
+
+ /**
+ * Adds a script tag to the DOM, either using document.write or low-level DOM manipulation,
+ * depending on whether document-ready has occured yet and whether we are in blocking mode.
+ *
+ * @param src String: URL to script, will be used as the src attribute in the script tag
+ * @param callback Function: Optional callback which will be run when the script is done
+ */
+ function addScript( src, callback ) {
+ var done = false, script, head;
+ if ( ready || !blocking ) {
+ // jQuery's getScript method is NOT better than doing this the old-fashioned way
+ // because jQuery will eval the script's code, and errors will not have sane
+ // line numbers.
+ script = document.createElement( 'script' );
+ script.setAttribute( 'src', src );
+ script.setAttribute( 'type', 'text/javascript' );
+ if ( $.isFunction( callback ) ) {
+ // Attach handlers for all browsers (based on jQuery.ajax)
+ script.onload = script.onreadystatechange = function() {
+
+ if (
+ !done
+ && (
+ !script.readyState
+ || /loaded|complete/.test( script.readyState )
+ )
+ ) {
+
+ done = true;
+
+ // Handle memory leak in IE
+ script.onload = script.onreadystatechange = null;
+
+ callback();
+
+ if ( script.parentNode ) {
+ script.parentNode.removeChild( script );
+ }
+
+ // Dereference the script
+ script = undefined;
+ }
+ };
+ }
+
+ if ( window.opera ) {
+ // Appending to the <head> blocks rendering completely in Opera,
+ // so append to the <body> after document ready. This means the
+ // scripts only start loading after the document has been rendered,
+ // but so be it. Opera users don't deserve faster web pages if their
+ // browser makes it impossible
+ $( function() { document.body.appendChild( script ); } );
+ } else {
+ // IE-safe way of getting the <head> . document.documentElement.head doesn't
+ // work in scripts that run in the <head>
+ head = document.getElementsByTagName( 'head' )[0];
+ ( document.body || head ).appendChild( script );
}
- groups[group][groups[group].length] = batch[b];
+ } else {
+ document.write( mw.html.element(
+ 'script', { 'type': 'text/javascript', 'src': src }, ''
+ ) );
+ if ( $.isFunction( callback ) ) {
+ // Document.write is synchronous, so this is called when it's done
+ // FIXME: that's a lie. doc.write isn't actually synchronous
+ callback();
+ }
+ }
+ }
+
+ /**
+ * Executes a loaded module, making it ready to use
+ *
+ * @param module string module name to execute
+ */
+ function execute( module, callback ) {
+ var style, media, i, script, markModuleReady, nestedAddScript;
+
+ if ( registry[module] === undefined ) {
+ throw new Error( 'Module has not been registered yet: ' + module );
+ } else if ( registry[module].state === 'registered' ) {
+ throw new Error( 'Module has not been requested from the server yet: ' + module );
+ } else if ( registry[module].state === 'loading' ) {
+ throw new Error( 'Module has not completed loading yet: ' + module );
+ } else if ( registry[module].state === 'ready' ) {
+ throw new Error( 'Module has already been loaded: ' + module );
}
- for ( var group in groups ) {
- // Calculate the highest timestamp
- var version = 0;
- for ( var g = 0; g < groups[group].length; g++ ) {
- if ( registry[groups[group][g]].version > version ) {
- version = registry[groups[group][g]].version;
+
+ // Add styles
+ if ( $.isPlainObject( registry[module].style ) ) {
+ for ( media in registry[module].style ) {
+ style = registry[module].style[media];
+ if ( $.isArray( style ) ) {
+ for ( i = 0; i < style.length; i += 1 ) {
+ getMarker().before( mw.html.element( 'link', {
+ 'type': 'text/css',
+ 'media': media,
+ 'rel': 'stylesheet',
+ 'href': style[i]
+ } ) );
+ }
+ } else if ( typeof style === 'string' ) {
+ getMarker().before( mw.html.element( 'style', {
+ 'type': 'text/css',
+ 'media': media
+ }, new mw.html.Cdata( style ) ) );
}
}
- var reqBase = $.extend( { 'version': formatVersionNumber( version ) }, base );
- var reqBaseLength = $.param( reqBase ).length;
- var reqs = [];
- var limit = mw.config.get( 'wgResourceLoaderMaxQueryLength', -1 );
- // We may need to split up the request to honor the query string length limit
- // So build it piece by piece
- var l = reqBaseLength + 9; // '&modules='.length == 9
- var r = 0;
- reqs[0] = {}; // { prefix: [ suffixes ] }
- for ( var i = 0; i < groups[group].length; i++ ) {
- // Determine how many bytes this module would add to the query string
- var lastDotIndex = groups[group][i].lastIndexOf( '.' );
- // Note that these substr() calls work even if lastDotIndex == -1
- var prefix = groups[group][i].substr( 0, lastDotIndex );
- var suffix = groups[group][i].substr( lastDotIndex + 1 );
- var bytesAdded = prefix in reqs[r] ?
- suffix.length + 3 : // '%2C'.length == 3
- groups[group][i].length + 3; // '%7C'.length == 3
-
- // If the request would become too long, create a new one,
- // but don't create empty requests
- if ( limit > 0 && reqs[r] != {} && l + bytesAdded > limit ) {
- // This request would become too long, create a new one
- r++;
- reqs[r] = {};
- l = reqBaseLength + 9;
+ }
+ // Add localizations to message system
+ if ( $.isPlainObject( registry[module].messages ) ) {
+ mw.messages.set( registry[module].messages );
+ }
+ // Execute script
+ try {
+ script = registry[module].script;
+ markModuleReady = function() {
+ registry[module].state = 'ready';
+ handlePending( module );
+ if ( $.isFunction( callback ) ) {
+ callback();
}
- if ( !( prefix in reqs[r] ) ) {
- reqs[r][prefix] = [];
+ };
+ nestedAddScript = function ( arr, callback, i ) {
+ // Recursively call addScript() in its own callback
+ // for each element of arr.
+ if ( i >= arr.length ) {
+ // We're at the end of the array
+ callback();
+ return;
}
- reqs[r][prefix].push( suffix );
- l += bytesAdded;
+
+ addScript( arr[i], function() {
+ nestedAddScript( arr, callback, i + 1 );
+ } );
+ };
+
+ if ( $.isArray( script ) ) {
+ registry[module].state = 'loading';
+ nestedAddScript( script, markModuleReady, 0 );
+ } else if ( $.isFunction( script ) ) {
+ script( $ );
+ markModuleReady();
}
- for ( var r = 0; r < reqs.length; r++ ) {
- requests[requests.length] = $.extend(
- { 'modules': buildModulesString( reqs[r] ) }, reqBase
- );
+ } catch ( e ) {
+ // This needs to NOT use mw.log because these errors are common in production mode
+ // and not in debug mode, such as when a symbol that should be global isn't exported
+ if ( window.console && typeof window.console.log === 'function' ) {
+ console.log( 'mw.loader::execute> Exception thrown by ' + module + ': ' + e.message );
}
- }
- // Clear the batch - this MUST happen before we append the
- // script element to the body or it's possible that the script
- // will be locally cached, instantly load, and work the batch
- // again, all before we've cleared it causing each request to
- // include modules which are already loaded
- batch = [];
- // Asynchronously append a script tag to the end of the body
- for ( var r = 0; r < requests.length; r++ ) {
- requests[r] = sortQuery( requests[r] );
- var src = mw.config.get( 'wgLoadScript' ) + '?' + $.param( requests[r] );
- addScript( src );
+ registry[module].state = 'error';
+ throw e;
}
}
- };
-
- /**
- * Registers a module, letting the system know about it and its
- * dependencies. loader.js files contain calls to this function.
- */
- this.register = function( module, version, dependencies, group ) {
- // Allow multiple registration
- if ( typeof module === 'object' ) {
- for ( var m = 0; m < module.length; m++ ) {
- if ( typeof module[m] === 'string' ) {
- mw.loader.register( module[m] );
- } else if ( typeof module[m] === 'object' ) {
- mw.loader.register.apply( mw.loader, module[m] );
+
+ /**
+ * Adds a dependencies to the queue with optional callbacks to be run
+ * when the dependencies are ready or fail
+ *
+ * @param dependencies string module name or array of string module names
+ * @param ready function callback to execute when all dependencies are ready
+ * @param error function callback to execute when any dependency fails
+ */
+ function request( dependencies, ready, error ) {
+ var regItemDeps, regItemDepLen, n;
+
+ // Allow calling by single module name
+ if ( typeof dependencies === 'string' ) {
+ dependencies = [dependencies];
+ if ( registry[dependencies[0]] !== undefined ) {
+ // Cache repetitively accessed deep level object member
+ regItemDeps = registry[dependencies[0]].dependencies;
+ // Cache to avoid looped access to length property
+ regItemDepLen = regItemDeps.length;
+ for ( n = 0; n < regItemDepLen; n += 1 ) {
+ dependencies[dependencies.length] = regItemDeps[n];
+ }
}
}
- return;
- }
- // Validate input
- if ( typeof module !== 'string' ) {
- throw new Error( 'module must be a string, not a ' + typeof module );
- }
- if ( typeof registry[module] !== 'undefined' ) {
- throw new Error( 'module already implemeneted: ' + module );
- }
- // List the module as registered
- registry[module] = {
- 'state': 'registered',
- 'group': typeof group === 'string' ? group : null,
- 'dependencies': [],
- 'version': typeof version !== 'undefined' ? parseInt( version, 10 ) : 0
- };
- if ( typeof dependencies === 'string' ) {
- // Allow dependencies to be given as a single module name
- registry[module].dependencies = [dependencies];
- } else if ( typeof dependencies === 'object' || $.isFunction( dependencies ) ) {
- // Allow dependencies to be given as an array of module names
- // or a function which returns an array
- registry[module].dependencies = dependencies;
- }
- };
-
- /**
- * Implements a module, giving the system a course of action to take
- * upon loading. Results of a request for one or more modules contain
- * calls to this function.
- *
- * All arguments are required.
- *
- * @param module String: Name of module
- * @param script Mixed: Function of module code or String of URL to be used as the src
- * attribute when adding a script element to the body
- * @param style Object: Object of CSS strings keyed by media-type or Object of lists of URLs
- * keyed by media-type
- * as the href attribute when adding a link element to the head
- * @param msgs Object: List of key/value pairs to be passed through mw.messages.set
- */
- this.implement = function( module, script, style, msgs ) {
- // Validate input
- if ( typeof module !== 'string' ) {
- throw new Error( 'module must be a string, not a ' + typeof module );
- }
- if ( !$.isFunction( script ) && !$.isArray( script ) ) {
- throw new Error( 'script must be a function or an array, not a ' + typeof script );
- }
- if ( !$.isPlainObject( style ) ) {
- throw new Error( 'style must be a object or a string, not a ' + typeof style );
- }
- if ( !$.isPlainObject( msgs ) ) {
- throw new Error( 'msgs must be an object, not a ' + typeof msgs );
- }
- // Automatically register module
- if ( typeof registry[module] === 'undefined' ) {
- mw.loader.register( module );
- }
- // Check for duplicate implementation
- if ( typeof registry[module] !== 'undefined'
- && typeof registry[module].script !== 'undefined' )
- {
- throw new Error( 'module already implemeneted: ' + module );
- }
- // Mark module as loaded
- registry[module].state = 'loaded';
- // Attach components
- registry[module].script = script;
- registry[module].style = style;
- registry[module].messages = msgs;
- // Execute or queue callback
- if ( compare(
- filter( ['ready'], registry[module].dependencies ),
- registry[module].dependencies ) )
- {
- execute( module );
- } else {
- request( module );
- }
- };
-
- /**
- * Executes a function as soon as one or more required modules are ready
- *
- * @param dependencies string or array of strings of modules names the callback
- * dependencies to be ready before
- * executing
- * @param ready function callback to execute when all dependencies are ready (optional)
- * @param error function callback to execute when if dependencies have a errors (optional)
- */
- this.using = function( dependencies, ready, error ) {
- // Validate input
- if ( typeof dependencies !== 'object' && typeof dependencies !== 'string' ) {
- throw new Error( 'dependencies must be a string or an array, not a ' +
- typeof dependencies );
- }
- // Allow calling with a single dependency as a string
- if ( typeof dependencies === 'string' ) {
- dependencies = [dependencies];
- }
- // Resolve entire dependency map
- dependencies = resolve( dependencies );
- // If all dependencies are met, execute ready immediately
- if ( compare( filter( ['ready'], dependencies ), dependencies ) ) {
- if ( $.isFunction( ready ) ) {
- ready();
+ // Add ready and error callbacks if they were given
+ if ( arguments.length > 1 ) {
+ jobs[jobs.length] = {
+ 'dependencies': filter(
+ ['registered', 'loading', 'loaded'],
+ dependencies
+ ),
+ 'ready': ready,
+ 'error': error
+ };
}
- }
- // If any dependencies have errors execute error immediately
- else if ( filter( ['error'], dependencies ).length ) {
- if ( $.isFunction( error ) ) {
- error();
+ // Queue up any dependencies that are registered
+ dependencies = filter( ['registered'], dependencies );
+ for ( n = 0; n < dependencies.length; n += 1 ) {
+ if ( $.inArray( dependencies[n], queue ) === -1 ) {
+ queue[queue.length] = dependencies[n];
+ }
}
+ // Work the queue
+ mw.loader.work();
}
- // Since some dependencies are not yet ready, queue up a request
- else {
- request( dependencies, ready, error );
- }
- };
-
- /**
- * Loads an external script or one or more modules for future use
- *
- * @param modules mixed either the name of a module, array of modules,
- * or a URL of an external script or style
- * @param type string mime-type to use if calling with a URL of an
- * external script or style; acceptable values are "text/css" and
- * "text/javascript"; if no type is provided, text/javascript is
- * assumed
- */
- this.load = function( modules, type ) {
- // Validate input
- if ( typeof modules !== 'object' && typeof modules !== 'string' ) {
- throw new Error( 'modules must be a string or an array, not a ' +
- typeof modules );
- }
- // Allow calling with an external script or single dependency as a string
- if ( typeof modules === 'string' ) {
- // Support adding arbitrary external scripts
- if ( modules.substr( 0, 7 ) == 'http://' || modules.substr( 0, 8 ) == 'https://' ) {
- if ( type === 'text/css' ) {
- $( 'head' ).append( $( '<link />', {
- rel: 'stylesheet',
- type: 'text/css',
- href: modules
- } ) );
- return true;
- } else if ( type === 'text/javascript' || typeof type === 'undefined' ) {
- addScript( modules );
- return true;
+
+ function sortQuery(o) {
+ var sorted = {}, key, a = [];
+ for ( key in o ) {
+ if ( hasOwn.call( o, key ) ) {
+ a.push( key );
}
- // Unknown type
- return false;
}
- // Called with single module
- modules = [modules];
- }
- // Resolve entire dependency map
- modules = resolve( modules );
- // If all modules are ready, nothing dependency be done
- if ( compare( filter( ['ready'], modules ), modules ) ) {
- return true;
- }
- // If any modules have errors return false
- else if ( filter( ['error'], modules ).length ) {
- return false;
- }
- // Since some modules are not yet ready, queue up a request
- else {
- request( modules );
- return true;
- }
- };
-
- /**
- * Flushes the request queue and begin executing load requests on demand
- */
- this.go = function() {
- suspended = false;
- mw.loader.work();
- };
-
- /**
- * Changes the state of a module
- *
- * @param module string module name or object of module name/state pairs
- * @param state string state name
- */
- this.state = function( module, state ) {
- if ( typeof module === 'object' ) {
- for ( var m in module ) {
- mw.loader.state( m, module[m] );
+ a.sort();
+ for ( key = 0; key < a.length; key += 1 ) {
+ sorted[a[key]] = o[a[key]];
}
- return;
- }
- if ( !( module in registry ) ) {
- mw.loader.register( module );
+ return sorted;
}
- registry[module].state = state;
- };
-
- /**
- * Gets the version of a module
- *
- * @param module string name of module to get version for
- */
- this.version = function( module ) {
- if ( module in registry && 'version' in registry[module] ) {
- return formatVersionNumber( registry[module].version );
+
+ /**
+ * Converts a module map of the form { foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }
+ * to a query string of the form foo.bar,baz|bar.baz,quux
+ */
+ function buildModulesString( moduleMap ) {
+ var arr = [], p, prefix;
+ for ( prefix in moduleMap ) {
+ p = prefix === '' ? '' : prefix + '.';
+ arr.push( p + moduleMap[prefix].join( ',' ) );
+ }
+ return arr.join( '|' );
}
- return null;
- };
-
- /* Cache document ready status */
-
- $(document).ready( function() { ready = true; } );
- } )();
-
- /** HTML construction helper functions */
- this.html = new ( function () {
- var escapeCallback = function( s ) {
- switch ( s ) {
- case "'":
- return ''';
- case '"':
- return '"';
- case '<':
- return '<';
- case '>':
- return '>';
- case '&':
- return '&';
+
+ /**
+ * Asynchronously append a script tag to the end of the body
+ * that invokes load.php
+ * @param moduleMap {Object}: Module map, see buildModulesString()
+ * @param currReqBase {Object}: Object with other parameters (other than 'modules') to use in the request
+ * @param sourceLoadScript {String}: URL of load.php
+ */
+ function doRequest( moduleMap, currReqBase, sourceLoadScript ) {
+ var request = $.extend(
+ { 'modules': buildModulesString( moduleMap ) },
+ currReqBase
+ );
+ request = sortQuery( request );
+ // Asynchronously append a script tag to the end of the body
+ // Append &* to avoid triggering the IE6 extension check
+ addScript( sourceLoadScript + '?' + $.param( request ) + '&*' );
}
- };
-
- /**
- * Escape a string for HTML. Converts special characters to HTML entities.
- * @param s The string to escape
- */
- this.escape = function( s ) {
- return s.replace( /['"<>&]/g, escapeCallback );
- };
-
- /**
- * Wrapper object for raw HTML passed to mw.html.element().
- */
- this.Raw = function( value ) {
- this.value = value;
- };
+
+ /* Public Methods */
+ return {
+ /**
+ * Requests dependencies from server, loading and executing when things when ready.
+ */
+ work: function () {
+ var reqBase, splits, maxQueryLength, q, b, bSource, bGroup, bSourceGroup,
+ source, group, g, i, modules, maxVersion, sourceLoadScript,
+ currReqBase, currReqBaseLength, moduleMap, l,
+ lastDotIndex, prefix, suffix, bytesAdded;
+
+ // Build a list of request parameters common to all requests.
+ reqBase = {
+ skin: mw.config.get( 'skin' ),
+ lang: mw.config.get( 'wgUserLanguage' ),
+ debug: mw.config.get( 'debug' )
+ };
+ // Split module batch by source and by group.
+ splits = {};
+ maxQueryLength = mw.config.get( 'wgResourceLoaderMaxQueryLength', -1 );
+
+ // Appends a list of modules from the queue to the batch
+ for ( q = 0; q < queue.length; q += 1 ) {
+ // Only request modules which are registered
+ if ( registry[queue[q]] !== undefined && registry[queue[q]].state === 'registered' ) {
+ // Prevent duplicate entries
+ if ( $.inArray( queue[q], batch ) === -1 ) {
+ batch[batch.length] = queue[q];
+ // Mark registered modules as loading
+ registry[queue[q]].state = 'loading';
+ }
+ }
+ }
+ // Early exit if there's nothing to load...
+ if ( !batch.length ) {
+ return;
+ }
+
+ // The queue has been processed into the batch, clear up the queue.
+ queue = [];
+
+ // Always order modules alphabetically to help reduce cache
+ // misses for otherwise identical content.
+ batch.sort();
+
+ // Split batch by source and by group.
+ for ( b = 0; b < batch.length; b += 1 ) {
+ bSource = registry[batch[b]].source;
+ bGroup = registry[batch[b]].group;
+ if ( splits[bSource] === undefined ) {
+ splits[bSource] = {};
+ }
+ if ( splits[bSource][bGroup] === undefined ) {
+ splits[bSource][bGroup] = [];
+ }
+ bSourceGroup = splits[bSource][bGroup];
+ bSourceGroup[bSourceGroup.length] = batch[b];
+ }
+
+ // Clear the batch - this MUST happen before we append any
+ // script elements to the body or it's possible that a script
+ // will be locally cached, instantly load, and work the batch
+ // again, all before we've cleared it causing each request to
+ // include modules which are already loaded.
+ batch = [];
+
+ for ( source in splits ) {
+
+ sourceLoadScript = sources[source].loadScript;
+
+ for ( group in splits[source] ) {
+
+ // Cache access to currently selected list of
+ // modules for this group from this source.
+ modules = splits[source][group];
+
+ // Calculate the highest timestamp
+ maxVersion = 0;
+ for ( g = 0; g < modules.length; g += 1 ) {
+ if ( registry[modules[g]].version > maxVersion ) {
+ maxVersion = registry[modules[g]].version;
+ }
+ }
+
+ currReqBase = $.extend( { 'version': formatVersionNumber( maxVersion ) }, reqBase );
+ currReqBaseLength = $.param( currReqBase ).length;
+ moduleMap = {};
+ // We may need to split up the request to honor the query string length limit,
+ // so build it piece by piece.
+ l = currReqBaseLength + 9; // '&modules='.length == 9
+
+ moduleMap = {}; // { prefix: [ suffixes ] }
+
+ for ( i = 0; i < modules.length; i += 1 ) {
+ // Determine how many bytes this module would add to the query string
+ lastDotIndex = modules[i].lastIndexOf( '.' );
+ // Note that these substr() calls work even if lastDotIndex == -1
+ prefix = modules[i].substr( 0, lastDotIndex );
+ suffix = modules[i].substr( lastDotIndex + 1 );
+ bytesAdded = moduleMap[prefix] !== undefined
+ ? suffix.length + 3 // '%2C'.length == 3
+ : modules[i].length + 3; // '%7C'.length == 3
+
+ // If the request would become too long, create a new one,
+ // but don't create empty requests
+ if ( maxQueryLength > 0 && !$.isEmptyObject( moduleMap ) && l + bytesAdded > maxQueryLength ) {
+ // This request would become too long, create a new one
+ // and fire off the old one
+ doRequest( moduleMap, currReqBase, sourceLoadScript );
+ moduleMap = {};
+ l = currReqBaseLength + 9;
+ }
+ if ( moduleMap[prefix] === undefined ) {
+ moduleMap[prefix] = [];
+ }
+ moduleMap[prefix].push( suffix );
+ l += bytesAdded;
+ }
+ // If there's anything left in moduleMap, request that too
+ if ( !$.isEmptyObject( moduleMap ) ) {
+ doRequest( moduleMap, currReqBase, sourceLoadScript );
+ }
+ }
+ }
+ },
+
+ /**
+ * Register a source.
+ *
+ * @param id {String}: Short lowercase a-Z string representing a source, only used internally.
+ * @param props {Object}: Object containing only the loadScript property which is a url to
+ * the load.php location of the source.
+ * @return {Boolean}
+ */
+ addSource: function ( id, props ) {
+ var source;
+ // Allow multiple additions
+ if ( typeof id === 'object' ) {
+ for ( source in id ) {
+ mw.loader.addSource( source, id[source] );
+ }
+ return true;
+ }
+
+ if ( sources[id] !== undefined ) {
+ throw new Error( 'source already registered: ' + id );
+ }
+
+ sources[id] = props;
+
+ return true;
+ },
+
+ /**
+ * Registers a module, letting the system know about it and its
+ * properties. Startup modules contain calls to this function.
+ *
+ * @param module {String}: Module name
+ * @param version {Number}: Module version number as a timestamp (falls backs to 0)
+ * @param dependencies {String|Array|Function}: One string or array of strings of module
+ * names on which this module depends, or a function that returns that array.
+ * @param group {String}: Group which the module is in (optional, defaults to null)
+ * @param source {String}: Name of the source. Defaults to local.
+ */
+ register: function ( module, version, dependencies, group, source ) {
+ var m;
+ // Allow multiple registration
+ if ( typeof module === 'object' ) {
+ for ( m = 0; m < module.length; m += 1 ) {
+ // module is an array of module names
+ if ( typeof module[m] === 'string' ) {
+ mw.loader.register( module[m] );
+ // module is an array of arrays
+ } else if ( typeof module[m] === 'object' ) {
+ mw.loader.register.apply( mw.loader, module[m] );
+ }
+ }
+ return;
+ }
+ // Validate input
+ if ( typeof module !== 'string' ) {
+ throw new Error( 'module must be a string, not a ' + typeof module );
+ }
+ if ( registry[module] !== undefined ) {
+ throw new Error( 'module already registered: ' + module );
+ }
+ // List the module as registered
+ registry[module] = {
+ 'version': version !== undefined ? parseInt( version, 10 ) : 0,
+ 'dependencies': [],
+ 'group': typeof group === 'string' ? group : null,
+ 'source': typeof source === 'string' ? source: 'local',
+ 'state': 'registered'
+ };
+ if ( typeof dependencies === 'string' ) {
+ // Allow dependencies to be given as a single module name
+ registry[module].dependencies = [dependencies];
+ } else if ( typeof dependencies === 'object' || $.isFunction( dependencies ) ) {
+ // Allow dependencies to be given as an array of module names
+ // or a function which returns an array
+ registry[module].dependencies = dependencies;
+ }
+ },
+
+ /**
+ * Implements a module, giving the system a course of action to take
+ * upon loading. Results of a request for one or more modules contain
+ * calls to this function.
+ *
+ * All arguments are required.
+ *
+ * @param module String: Name of module
+ * @param script Mixed: Function of module code or String of URL to be used as the src
+ * attribute when adding a script element to the body
+ * @param style Object: Object of CSS strings keyed by media-type or Object of lists of URLs
+ * keyed by media-type
+ * @param msgs Object: List of key/value pairs to be passed through mw.messages.set
+ */
+ implement: function ( module, script, style, msgs ) {
+ // Validate input
+ if ( typeof module !== 'string' ) {
+ throw new Error( 'module must be a string, not a ' + typeof module );
+ }
+ if ( !$.isFunction( script ) && !$.isArray( script ) ) {
+ throw new Error( 'script must be a function or an array, not a ' + typeof script );
+ }
+ if ( !$.isPlainObject( style ) ) {
+ throw new Error( 'style must be an object, not a ' + typeof style );
+ }
+ if ( !$.isPlainObject( msgs ) ) {
+ throw new Error( 'msgs must be an object, not a ' + typeof msgs );
+ }
+ // Automatically register module
+ if ( registry[module] === undefined ) {
+ mw.loader.register( module );
+ }
+ // Check for duplicate implementation
+ if ( registry[module] !== undefined && registry[module].script !== undefined ) {
+ throw new Error( 'module already implemented: ' + module );
+ }
+ // Mark module as loaded
+ registry[module].state = 'loaded';
+ // Attach components
+ registry[module].script = script;
+ registry[module].style = style;
+ registry[module].messages = msgs;
+ // Execute or queue callback
+ if ( compare(
+ filter( ['ready'], registry[module].dependencies ),
+ registry[module].dependencies ) )
+ {
+ execute( module );
+ }
+ },
+
+ /**
+ * Executes a function as soon as one or more required modules are ready
+ *
+ * @param dependencies {String|Array} Module name or array of modules names the callback
+ * dependends on to be ready before executing
+ * @param ready {Function} callback to execute when all dependencies are ready (optional)
+ * @param error {Function} callback to execute when if dependencies have a errors (optional)
+ */
+ using: function ( dependencies, ready, error ) {
+ var tod = typeof dependencies;
+ // Validate input
+ if ( tod !== 'object' && tod !== 'string' ) {
+ throw new Error( 'dependencies must be a string or an array, not a ' + tod );
+ }
+ // Allow calling with a single dependency as a string
+ if ( tod === 'string' ) {
+ dependencies = [dependencies];
+ }
+ // Resolve entire dependency map
+ dependencies = resolve( dependencies );
+ // If all dependencies are met, execute ready immediately
+ if ( compare( filter( ['ready'], dependencies ), dependencies ) ) {
+ if ( $.isFunction( ready ) ) {
+ ready();
+ }
+ }
+ // If any dependencies have errors execute error immediately
+ else if ( filter( ['error'], dependencies ).length ) {
+ if ( $.isFunction( error ) ) {
+ error( new Error( 'one or more dependencies have state "error"' ),
+ dependencies );
+ }
+ }
+ // Since some dependencies are not yet ready, queue up a request
+ else {
+ request( dependencies, ready, error );
+ }
+ },
+
+ /**
+ * Loads an external script or one or more modules for future use
+ *
+ * @param modules {mixed} Either the name of a module, array of modules,
+ * or a URL of an external script or style
+ * @param type {String} mime-type to use if calling with a URL of an
+ * external script or style; acceptable values are "text/css" and
+ * "text/javascript"; if no type is provided, text/javascript is assumed.
+ */
+ load: function ( modules, type ) {
+ var filtered, m;
+
+ // Validate input
+ if ( typeof modules !== 'object' && typeof modules !== 'string' ) {
+ throw new Error( 'modules must be a string or an array, not a ' + typeof modules );
+ }
+ // Allow calling with an external url or single dependency as a string
+ if ( typeof modules === 'string' ) {
+ // Support adding arbitrary external scripts
+ if ( /^(https?:)?\/\//.test( modules ) ) {
+ if ( type === 'text/css' ) {
+ $( 'head' ).append( $( '<link>', {
+ rel: 'stylesheet',
+ type: 'text/css',
+ href: modules
+ } ) );
+ return;
+ } else if ( type === 'text/javascript' || type === undefined ) {
+ addScript( modules );
+ return;
+ }
+ // Unknown type
+ throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type );
+ }
+ // Called with single module
+ modules = [modules];
+ }
- /**
- * Wrapper object for CDATA element contents passed to mw.html.element()
- */
- this.Cdata = function( value ) {
- this.value = value;
- };
+ // Filter out undefined modules, otherwise resolve() will throw
+ // an exception for trying to load an undefined module.
+ // Undefined modules are acceptable here in load(), because load() takes
+ // an array of unrelated modules, whereas the modules passed to
+ // using() are related and must all be loaded.
+ for ( filtered = [], m = 0; m < modules.length; m += 1 ) {
+ if ( registry[modules[m]] !== undefined ) {
+ filtered[filtered.length] = modules[m];
+ }
+ }
- /**
- * Create an HTML element string, with safe escaping.
- *
- * @param name The tag name.
- * @param attrs An object with members mapping element names to values
- * @param contents The contents of the element. May be either:
- * - string: The string is escaped.
- * - null or undefined: The short closing form is used, e.g. <br/>.
- * - this.Raw: The value attribute is included without escaping.
- * - this.Cdata: The value attribute is included, and an exception is
- * thrown if it contains an illegal ETAGO delimiter.
- * See http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.3.2
- *
- * Example:
- * var h = mw.html;
- * return h.element( 'div', {},
- * new h.Raw( h.element( 'img', {src: '<'} ) ) );
- * Returns <div><img src="<"/></div>
- */
- this.element = function( name, attrs, contents ) {
- var s = '<' + name;
- for ( var attrName in attrs ) {
- s += ' ' + attrName + '="' + this.escape( attrs[attrName] ) + '"';
- }
- if ( typeof contents == 'undefined' || contents === null ) {
- // Self close tag
- s += '/>';
- return s;
- }
- // Regular open tag
- s += '>';
- if ( typeof contents === 'string') {
- // Escaped
- s += this.escape( contents );
- } else if ( contents instanceof this.Raw ) {
- // Raw HTML inclusion
- s += contents.value;
- } else if ( contents instanceof this.Cdata ) {
- // CDATA
- if ( /<\/[a-zA-z]/.test( contents.value ) ) {
- throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
+ // Resolve entire dependency map
+ filtered = resolve( filtered );
+ // If all modules are ready, nothing dependency be done
+ if ( compare( filter( ['ready'], filtered ), filtered ) ) {
+ return;
+ }
+ // If any modules have errors
+ else if ( filter( ['error'], filtered ).length ) {
+ return;
+ }
+ // Since some modules are not yet ready, queue up a request
+ else {
+ request( filtered );
+ return;
+ }
+ },
+
+ /**
+ * Changes the state of a module
+ *
+ * @param module {String|Object} module name or object of module name/state pairs
+ * @param state {String} state name
+ */
+ state: function ( module, state ) {
+ var m;
+ if ( typeof module === 'object' ) {
+ for ( m in module ) {
+ mw.loader.state( m, module[m] );
+ }
+ return;
+ }
+ if ( registry[module] === undefined ) {
+ mw.loader.register( module );
+ }
+ registry[module].state = state;
+ },
+
+ /**
+ * Gets the version of a module
+ *
+ * @param module string name of module to get version for
+ */
+ getVersion: function ( module ) {
+ if ( registry[module] !== undefined && registry[module].version !== undefined ) {
+ return formatVersionNumber( registry[module].version );
+ }
+ return null;
+ },
+
+ /**
+ * @deprecated since 1.18 use mw.loader.getVersion() instead
+ */
+ version: function () {
+ return mw.loader.getVersion.apply( mw.loader, arguments );
+ },
+
+ /**
+ * Gets the state of a module
+ *
+ * @param module string name of module to get state for
+ */
+ getState: function ( module ) {
+ if ( registry[module] !== undefined && registry[module].state !== undefined ) {
+ return registry[module].state;
+ }
+ return null;
+ },
+
+ /**
+ * Get names of all registered modules.
+ *
+ * @return {Array}
+ */
+ getModuleNames: function () {
+ return $.map( registry, function ( i, key ) {
+ return key;
+ } );
+ },
+
+ /**
+ * Enable or disable blocking. If blocking is enabled and
+ * document ready has not yet occurred, scripts will be loaded
+ * in a blocking way (using document.write) rather than
+ * asynchronously using DOM manipulation
+ *
+ * @param b {Boolean} True to enable blocking, false to disable it
+ */
+ setBlocking: function( b ) {
+ blocking = b;
+ },
+
+ /**
+ * For backwards-compatibility with Squid-cached pages. Loads mw.user
+ */
+ go: function () {
+ mw.loader.load( 'mediawiki.user' );
+ }
+ };
+ }() ),
+
+ /** HTML construction helper functions */
+ html: ( function () {
+ function escapeCallback( s ) {
+ switch ( s ) {
+ case "'":
+ return ''';
+ case '"':
+ return '"';
+ case '<':
+ return '<';
+ case '>':
+ return '>';
+ case '&':
+ return '&';
}
- s += contents.value;
- } else {
- throw new Error( 'mw.html.element: Invalid type of contents' );
}
- s += '</' + name + '>';
- return s;
- };
- } )();
-
- /* Extension points */
- this.legacy = {};
-
-} )( jQuery );
+ return {
+ /**
+ * Escape a string for HTML. Converts special characters to HTML entities.
+ * @param s The string to escape
+ */
+ escape: function ( s ) {
+ return s.replace( /['"<>&]/g, escapeCallback );
+ },
+
+ /**
+ * Wrapper object for raw HTML passed to mw.html.element().
+ * @constructor
+ */
+ Raw: function ( value ) {
+ this.value = value;
+ },
+
+ /**
+ * Wrapper object for CDATA element contents passed to mw.html.element()
+ * @constructor
+ */
+ Cdata: function ( value ) {
+ this.value = value;
+ },
+
+ /**
+ * Create an HTML element string, with safe escaping.
+ *
+ * @param name The tag name.
+ * @param attrs An object with members mapping element names to values
+ * @param contents The contents of the element. May be either:
+ * - string: The string is escaped.
+ * - null or undefined: The short closing form is used, e.g. <br/>.
+ * - this.Raw: The value attribute is included without escaping.
+ * - this.Cdata: The value attribute is included, and an exception is
+ * thrown if it contains an illegal ETAGO delimiter.
+ * See http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.3.2
+ *
+ * Example:
+ * var h = mw.html;
+ * return h.element( 'div', {},
+ * new h.Raw( h.element( 'img', {src: '<'} ) ) );
+ * Returns <div><img src="<"/></div>
+ */
+ element: function ( name, attrs, contents ) {
+ var v, attrName, s = '<' + name;
+
+ for ( attrName in attrs ) {
+ v = attrs[attrName];
+ // Convert name=true, to name=name
+ if ( v === true ) {
+ v = attrName;
+ // Skip name=false
+ } else if ( v === false ) {
+ continue;
+ }
+ s += ' ' + attrName + '="' + this.escape( String( v ) ) + '"';
+ }
+ if ( contents === undefined || contents === null ) {
+ // Self close tag
+ s += '/>';
+ return s;
+ }
+ // Regular open tag
+ s += '>';
+ switch ( typeof contents ) {
+ case 'string':
+ // Escaped
+ s += this.escape( contents );
+ break;
+ case 'number':
+ case 'boolean':
+ // Convert to string
+ s += String( contents );
+ break;
+ default:
+ if ( contents instanceof this.Raw ) {
+ // Raw HTML inclusion
+ s += contents.value;
+ } else if ( contents instanceof this.Cdata ) {
+ // CDATA
+ if ( /<\/[a-zA-z]/.test( contents.value ) ) {
+ throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
+ }
+ s += contents.value;
+ } else {
+ throw new Error( 'mw.html.element: Invalid type of contents' );
+ }
+ }
+ s += '</' + name + '>';
+ return s;
+ }
+ };
+ })()
+ };
+
+})( jQuery );
// Alias $j to jQuery for backwards compatibility
window.$j = jQuery;
-window.mw = mediaWiki;
-/* Auto-register from pre-loaded startup scripts */
+// Attach to window and globally alias
+window.mw = window.mediaWiki = mw;
-if ( $.isFunction( startUp ) ) {
+// Auto-register from pre-loaded startup scripts
+if ( typeof startUp !== 'undefined' && jQuery.isFunction( startUp ) ) {
startUp();
- delete startUp;
+ startUp = undefined;
}
-
-// Add jQuery Cookie to initial payload (used in mw.user)
-mw.loader.load( 'jquery.cookie' );
dépôts / lhc / web / wiklou.git / blobdiff