/*
- * JavaScript backwards-compatibility and support
+ * JavaScript backwards-compatibility alternatives and other convenience functions
*/
-// Make calling .indexOf() on an array work on older browsers
-if ( typeof Array.prototype.indexOf === 'undefined' ) {
- Array.prototype.indexOf = function( needle ) {
- for ( var i = 0; i < this.length; i++ ) {
- if ( this[i] === needle ) {
- return i;
+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, str.length );
+ },
+ escapeRE : function( str ) {
+ return str.replace ( /([\\{}()|.?*+^$\[\]])/g, "\\$1" );
+ },
+ 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 -1;
- };
-}
-// Add array comparison functionality
-if ( typeof Array.prototype.compare === 'undefined' ) {
- Array.prototype.compare = function( against ) {
- if ( this.length != against.length ) {
+ return false;
+ },
+ compareArray : function( arrThis, arrAgainst ) {
+ if ( arrThis.length != arrAgainst.length ) {
return false;
}
- for ( var i = 0; i < against.length; i++ ) {
- if ( this[i].compare ) {
- if ( !this[i].compare( against[i] ) ) {
+ for ( var i = 0; i < arrThis.length; i++ ) {
+ if ( arrThis[i] instanceof Array ) {
+ if ( !$.compareArray( arrThis[i], arrAgainst[i] ) ) {
return false;
}
- }
- if ( this[i] !== against[i] ) {
+ } else if ( arrThis[i] !== arrAgainst[i] ) {
return false;
}
}
return true;
- };
-}
+ }
+});
/*
* Core MediaWiki JavaScript Library
*/
+
// Attach to window
window.mediaWiki = new ( function( $ ) {
-
+
/* Constants */
-
+
// This will not change until we are 100% ready to turn off legacy globals
var LEGACY_GLOBALS = true;
-
- /* Members */
-
- this.legacy = LEGACY_GLOBALS ? window : {};
-
- /* Methods */
-
- /*
- * Dummy function which in debug mode can be replaced with a function that does something clever
+
+ /* Private Members */
+
+ // List of messages that have been requested to be loaded
+ var messageQueue = {};
+
+ /* Prototypes */
+
+ /**
+ * An object which allows single and multiple get/set/exists functionality
+ * on a list of key / value pairs.
+ *
+ * @param {boolean} global Whether to get/set/exists values on the window
+ * object or a private object
*/
- this.log = function() { };
- /*
- * An object which allows single and multiple existence, setting and getting on a list of key / value pairs
+ function Map( global ) {
+ this.values = ( global === true ) ? window : {};
+ }
+
+ /**
+ * 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)
*/
- this.config = new ( function() {
-
- /* Private Members */
-
- var that = this;
- // List of configuration values - in legacy mode these configurations were ALL in the global space
- var values = LEGACY_GLOBALS ? window : {};
-
- /* Public Methods */
-
- /**
- * Sets one or multiple configuration values using a key and a value or an object of keys and values
- */
- this.set = function( keys, value ) {
- if ( typeof keys === 'object' ) {
- for ( var k in keys ) {
- values[k] = keys[k];
- }
- } else if ( typeof keys === 'string' && typeof value !== 'undefined' ) {
- values[keys] = value;
+ 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 );
}
- };
- /**
- * Gets one or multiple configuration values using a key and an optional fallback or an array of keys
- */
- this.get = function( keys, fallback ) {
- if ( typeof keys === 'object' ) {
- var result = {};
- for ( var k = 0; k < keys.length; k++ ) {
- if ( typeof values[keys[k]] !== 'undefined' ) {
- result[keys[k]] = values[keys[k]];
- }
- }
- return result;
- } else if ( typeof keys === 'string' ) {
- if ( typeof values[keys] === 'undefined' ) {
- return typeof fallback !== 'undefined' ? fallback : null;
- } else {
- return values[keys];
+ return results;
+ } else if ( typeof selection === 'string' ) {
+ if ( typeof this.values[selection] === 'undefined' ) {
+ if ( typeof fallback !== 'undefined' ) {
+ return fallback;
}
- } else {
- return values;
+ return null;
}
- };
- /**
- * Checks if one or multiple configuration fields exist
- */
- this.exists = function( keys ) {
- if ( typeof keys === 'object' ) {
- for ( var k = 0; k < keys.length; k++ ) {
- if ( !( keys[k] in values ) ) {
- return false;
- }
+ 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];
+ }
+ } else if ( typeof selection === 'string' && typeof value !== 'undefined' ) {
+ this.values[selection] = value;
+ }
+ };
+
+ /**
+ * 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 keys === 'object' ) {
+ for ( var s = 0; s < selection.length; s++ ) {
+ if ( !( selection[s] in this.values ) ) {
+ return false;
}
- return true;
- } else {
- return keys in values;
}
- };
- } )();
- /*
- * Localization system
+ 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 );
+ }
+
+ /**
+ * 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;
+ };
+
+ /**
+ * Converts message object to it's string form based on the state of format
+ *
+ * @return {string} String form of message
*/
- this.msg = new ( function() {
-
+ 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;
+ } );
+ /* This should be fixed up when we have a parser
+ if ( this.format === 'parse' && 'language' in mediaWiki ) {
+ text = mediaWiki.language.parse( text );
+ }
+ */
+ return text;
+ };
+
+ /**
+ * Changes format to parse and converts message to string
+ *
+ * @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
+ *
+ * @return {string} String form of plain message
+ */
+ Message.prototype.plain = function() {
+ this.format = 'plain';
+ 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;
- // List of localized messages
- var messages = {};
-
+
+ /* Public Members */
+
+ this.options = new Map();
+
/* Public Methods */
-
- this.set = function( keys, value ) {
- if ( typeof keys === 'object' ) {
- for ( var k in keys ) {
- messages[k] = keys[k];
- }
- } else if ( typeof keys === 'string' && typeof value !== 'undefined' ) {
- messages[keys] = value;
+
+ /*
+ * 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. It's uniqueness should not be depended on.
+ *
+ * @return string random set of 32 alpha-numeric characters
+ */
+ function generateSessionId() {
+ var id = '';
+ var seed = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXTZabcdefghiklmnopqrstuvwxyz';
+ 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 mediaWiki.config.get( 'wgUserName' );
};
- this.get = function( key, args ) {
- if ( !( key in messages ) ) {
- return '<' + key + '>';
- }
- var msg = messages[key];
- if ( typeof args == 'object' || typeof args == 'array' ) {
- for ( var a = 0; a < args.length; a++ ) {
- msg = msg.replace( '\$' + ( parseInt( a ) + 1 ), args[a] );
- }
- } else if ( typeof args == 'string' || typeof args == 'number' ) {
- msg = msg.replace( '$1', args );
+
+ /*
+ * Gets the current user's name or a random session ID automatically generated and kept in
+ * a cookie.
+ *
+ * @return string user name or random session ID
+ */
+ this.sessionId = function () {
+ var name = that.name();
+ if ( name ) {
+ return name;
}
- return msg;
+ var sessionId = $.cookie( 'mediaWiki.user.sessionId' );
+ if ( typeof sessionId == 'undefined' || sessionId == null ) {
+ sessionId = generateSessionId();
+ $.cookie( 'mediaWiki.user.sessionId', sessionId, { 'expires': 30, 'path': '/' } );
+ }
+ return sessionId;
};
- } )();
+ }
+
+ /* Public Members */
+
+ /*
+ * Dummy function which in debug mode can be replaced with a function that
+ * does something clever
+ */
+ this.log = function() { };
+
+ /*
+ * List of configuration values
+ *
+ * In legacy mode the values this object wraps will be in the global space
+ */
+ this.config = new Map( LEGACY_GLOBALS );
+
/*
+ * Information about the current user
+ */
+ this.user = new User();
+
+ /*
+ * Localization system
+ */
+ this.messages = new Map();
+
+ /* Public Methods */
+
+ /**
+ * 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 = [];
+ }
+ return new Message( mediaWiki.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 mediaWiki.message.apply( mediaWiki.message, arguments ).toString();
+ };
+
+ /**
* Client-side module loader which integrates with the MediaWiki ResourceLoader
*/
this.loader = new ( function() {
-
+
/* Private Members */
-
- var that = this;
- /*
+
+ /**
* 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.
- *
+ *
+ * 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': {
var suspended = true;
// Flag inidicating that document ready has occured
var ready = false;
-
+
/* 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;
+ }
+
/**
- * Generates an ISO8601 string from a UNIX timestamp
+ * Generates an ISO8601 "basic" string from a UNIX timestamp
*/
function formatVersionNumber( timestamp ) {
- var date = new Date();
- date.setTime( timestamp * 1000 );
- function pad1( n ) {
- return n < 10 ? '0' + n : n
- }
- function pad2( n ) {
- return n < 10 ? '00' + n : ( n < 100 ? '0' + n : n );
- }
- return date.getUTCFullYear() + '-' +
- pad1( date.getUTCMonth() + 1 ) + '-' +
- pad1( date.getUTCDate() ) + 'T' +
- pad1( date.getUTCHours() ) + ':' +
- pad1( date.getUTCMinutes() ) + ':' +
- pad1( date.getUTCSeconds() ) +
- 'Z';
+ 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( '' );
}
+
/**
* Recursively resolves dependencies and detects circular references
*/
function recurse( module, resolved, unresolved ) {
- unresolved[unresolved.length] = module;
- // Resolves dynamic loader function and replaces it with it's own results
+ if ( typeof registry[module] === 'undefined' ) {
+ throw new Error( 'Unknown dependency: ' + module );
+ }
+ // Resolves dynamic loader function and replaces it with its own results
if ( typeof registry[module].dependencies === 'function' ) {
registry[module].dependencies = registry[module].dependencies();
- // Gaurantees the module's dependencies are always in an array
+ // 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 ( resolved.indexOf( registry[module].dependencies[n] ) === -1 ) {
- if ( unresolved.indexOf( registry[module].dependencies[n] ) !== -1 ) {
+ 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]
+ 'Circular reference detected: ' + module +
+ ' -> ' + registry[module].dependencies[n]
);
}
recurse( registry[module].dependencies[n], resolved, unresolved );
}
}
resolved[resolved.length] = module;
- unresolved.splice( unresolved.indexOf( module ), 1 );
+ unresolved.splice( $.inArray( module, unresolved ), 1 );
}
+
/**
- * Gets a list of modules names that a module dependencies in their proper dependency order
- *
- * @param mixed string module name or array of string module names
+ * 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
* @throws Error if circular reference is detected
*/
return resolved;
}
throw new Error( 'Invalid module argument: ' + module );
- };
+ }
+
/**
- * Narrows a list of module names down to those matching a specific state. Possible states are 'undefined',
- * 'registered', 'loading', 'loaded', or 'ready'
- *
- * @param mixed string or array of strings of module states to filter by
- * @param array list of module names to filter (optional, all modules will be used by default)
+ * Narrows a list of module names down to those matching a specific
+ * state. Possible states are 'undefined', 'registered', 'loading',
+ * 'loaded', or 'ready'
+ *
+ * @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
*/
function filter( states, modules ) {
// 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 (
- ( states[s] == 'undefined' && typeof registry[modules[m]] === 'undefined' ) ||
- ( typeof registry[modules[m]] === 'object' && registry[modules[m]].state === states[s] )
- ) {
- list[list.length] = modules[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;
}
+
/**
* Executes a loaded module, making it ready to use
- *
- * @param string module name to execute
+ *
+ * @param module string module name to execute
*/
function execute( module ) {
if ( typeof registry[module] === 'undefined' ) {
}
// Add style sheet to document
if ( typeof registry[module].style === 'string' && registry[module].style.length ) {
- $( 'head' ).append( '<style type="text/css">' + registry[module].style + '</style>' );
- } else if ( typeof registry[module].style === 'object' ) {
+ $( 'head' )
+ .append( mediaWiki.html.element( 'style',
+ { type: "text/css" },
+ new mediaWiki.html.Cdata( registry[module].style )
+ ) );
+ } else if ( typeof registry[module].style === 'object'
+ && !( registry[module].style instanceof Array ) )
+ {
for ( var media in registry[module].style ) {
- $( 'head' ).append(
- '<style type="text/css" media="' + media + '">' + registry[module].style[media] + '</style>'
- );
+ $( 'head' ).append( mediaWiki.html.element( 'style',
+ { type: 'text/css', media: media },
+ new mediaWiki.html.Cdata( registry[module].style[media] )
+ ) );
}
}
// Add localizations to message system
if ( typeof registry[module].messages === 'object' ) {
- mediaWiki.msg.set( registry[module].messages );
+ mediaWiki.messages.set( registry[module].messages );
}
// Execute script
try {
registry[module].state = 'ready';
// Run jobs who's dependencies have just been met
for ( var j = 0; j < jobs.length; j++ ) {
- if ( filter( 'ready', jobs[j].dependencies ).compare( jobs[j].dependencies ) ) {
+ if ( compare(
+ filter( 'ready', jobs[j].dependencies ),
+ jobs[j].dependencies ) )
+ {
if ( typeof jobs[j].ready === 'function' ) {
jobs[j].ready();
}
// Execute modules who's dependencies have just been met
for ( r in registry ) {
if ( registry[r].state == 'loaded' ) {
- if ( filter( ['ready'], registry[r].dependencies ).compare( registry[r].dependencies ) ) {
+ if ( compare(
+ filter( ['ready'], registry[r].dependencies ),
+ registry[r].dependencies ) )
+ {
execute( r );
}
}
} catch ( e ) {
mediaWiki.log( 'Exception thrown by ' + module + ': ' + e.message );
mediaWiki.log( e );
- registry[module].state = 'error';
+ registry[module].state = 'error';
// Run error callbacks of jobs affected by this condition
for ( var j = 0; j < jobs.length; j++ ) {
- if ( jobs[j].dependencies.indexOf( module ) !== -1 ) {
+ if ( $.inArray( module, jobs[j].dependencies ) !== -1 ) {
if ( typeof jobs[j].error === 'function' ) {
jobs[j].error();
}
}
}
}
+
/**
- * Adds a dependencies to the queue with optional callbacks to be run when the dependencies are ready or fail
- *
- * @param mixed string moulde name or array of string module names
- * @param function ready callback to execute when all dependencies are ready
- * @param function error callback to execute when any dependency fails
+ * 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
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];
+ dependencies[dependencies.length] =
+ registry[dependencies[0]].dependencies[n];
}
}
}
// Add ready and error callbacks if they were given
if ( arguments.length > 1 ) {
jobs[jobs.length] = {
- 'dependencies': filter( ['undefined', 'registered', 'loading', 'loaded'], dependencies ),
+ 'dependencies': filter(
+ ['undefined', 'registered', 'loading', 'loaded'],
+ dependencies ),
'ready': ready,
'error': error
};
// Queue up any dependencies that are undefined or registered
dependencies = filter( ['undefined', 'registered'], dependencies );
for ( var n = 0; n < dependencies.length; n++ ) {
- if ( queue.indexOf( dependencies[n] ) === -1 ) {
+ if ( $.inArray( dependencies[n], queue ) === -1 ) {
queue[queue.length] = dependencies[n];
}
}
// Work the queue
- that.work();
+ mediaWiki.loader.work();
}
-
+
function sortQuery(o) {
var sorted = {}, key, a = [];
for ( key in o ) {
}
return sorted;
}
-
+
/* Public Methods */
-
+
/**
* Requests dependencies from server, loading and executing when things when ready.
*/
// Only request modules which are undefined or registered
if ( !( queue[q] in registry ) || registry[queue[q]].state == 'registered' ) {
// Prevent duplicate entries
- if ( batch.indexOf( queue[q] ) === -1 ) {
+ if ( $.inArray( queue[q], batch ) === -1 ) {
batch[batch.length] = queue[q];
// Mark registered modules as loading
if ( queue[q] in registry ) {
queue = [];
// After document ready, handle the batch
if ( !suspended && batch.length ) {
- // Always order modules alphabetically to help reduce cache misses for otherwise identical content
+ // Always order modules alphabetically to help reduce cache
+ // misses for otherwise identical content
batch.sort();
// Build a list of request parameters
var base = {
};
// Extend request parameters with a list of modules in the batch
var requests = [];
- if ( base.debug == '1' ) {
- for ( var b = 0; b < batch.length; b++ ) {
- requests[requests.length] = $.extend(
- { 'modules': batch[b], 'version': registry[batch[b]].version }, base
- );
+ // 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] = [];
}
- } else {
+ groups[group][groups[group].length] = batch[b];
+ }
+ for ( var group in groups ) {
// Calculate the highest timestamp
var version = 0;
- for ( var b = 0; b < batch.length; b++ ) {
- if ( registry[batch[b]].version > version ) {
- version = registry[batch[b]].version;
+ for ( var g = 0; g < groups[group].length; g++ ) {
+ if ( registry[groups[group][g]].version > version ) {
+ version = registry[groups[group][g]].version;
}
}
requests[requests.length] = $.extend(
- { 'modules': batch.join( '|' ), 'version': formatVersionNumber( version ) }, base
+ { 'modules': groups[group].join( '|' ), 'version': formatVersionNumber( version ) }, base
);
}
- // 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
+ // 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
function request() {
requests[r] = sortQuery( requests[r] );
// Build out the HTML
var src = mediaWiki.config.get( 'wgLoadScript' ) + '?' + $.param( requests[r] );
- html += '<script type="text/javascript" src="' + src + '"></script>';
+ html += mediaWiki.html.element( 'script',
+ { type: 'text/javascript', src: src }, '' );
}
return html;
}
// Load asynchronously after doumument ready
if ( ready ) {
- setTimeout( function() { $( 'body' ).append( request() ); }, 0 )
+ setTimeout( function() { $( 'body' ).append( request() ); }, 0 )
} else {
document.write( request() );
}
}
};
+
/**
- * Registers a module, letting the system know about it and it's dependencies. loader.js files contain calls
- * to this function.
+ * 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, status ) {
+ 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' ) {
- that.register( module[m] );
+ mediaWiki.loader.register( module[m] );
} else if ( typeof module[m] === 'object' ) {
- that.register.apply( that, module[m] );
+ mediaWiki.loader.register.apply( mediaWiki.loader, module[m] );
}
}
return;
if ( typeof module !== 'string' ) {
throw new Error( 'module must be a string, not a ' + typeof module );
}
- if ( typeof registry[module] !== 'undefined' && typeof status === 'undefined' ) {
+ if ( typeof registry[module] !== 'undefined' ) {
throw new Error( 'module already implemeneted: ' + module );
}
// List the module as registered
registry[module] = {
- 'state': typeof status === 'string' ? status : 'registered',
+ 'state': 'registered',
+ 'group': typeof group === 'string' ? group : null,
'dependencies': [],
'version': typeof version !== 'undefined' ? parseInt( version ) : 0
};
// Allow dependencies to be given as a single module name
registry[module].dependencies = [dependencies];
} else if ( typeof dependencies === 'object' || typeof dependencies === 'function' ) {
- // Allow dependencies to be given as an array of module names or a function which returns an array
+ // 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.
+ * 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.
*/
this.implement = function( module, script, style, localization ) {
- // Automaically register module
+ // Automatically register module
if ( typeof registry[module] === 'undefined' ) {
- that.register( module );
+ mediaWiki.loader.register( module );
}
// Validate input
if ( typeof script !== 'function' ) {
throw new Error( 'script must be a function, not a ' + typeof script );
}
- if ( typeof style !== 'undefined' && typeof style !== 'string' && typeof style !== 'object' ) {
+ if ( typeof style !== 'undefined'
+ && typeof style !== 'string'
+ && typeof style !== 'object' )
+ {
throw new Error( 'style must be a string or object, not a ' + typeof style );
}
- if ( typeof localization !== 'undefined' && typeof localization !== 'object' ) {
+ if ( typeof localization !== 'undefined'
+ && typeof localization !== 'object' )
+ {
throw new Error( 'localization must be an object, not a ' + typeof localization );
}
- if ( typeof registry[module] !== 'undefined' && typeof registry[module].script !== 'undefined' ) {
+ 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;
- if ( typeof style === 'string' || typeof style === 'object' ) {
+ if ( typeof style === 'string'
+ || typeof style === 'object' && !( style instanceof Array ) )
+ {
registry[module].style = style;
}
if ( typeof localization === 'object' ) {
registry[module].messages = localization;
}
// Execute or queue callback
- if ( filter( ['ready'], registry[module].dependencies ).compare( registry[module].dependencies ) ) {
+ 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 mixed string or array of strings of modules names the callback dependencies to be ready before
+ *
+ * @param dependencies string or array of strings of modules names the callback
+ * dependencies to be ready before
* executing
- * @param function callback to execute when all dependencies are ready (optional)
- * @param function callback to execute when if dependencies have a errors (optional)
+ * @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 )
+ 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' ) {
// Resolve entire dependency map
dependencies = resolve( dependencies );
// If all dependencies are met, execute ready immediately
- if ( filter( ['ready'], dependencies ).compare( dependencies ) ) {
- if ( typeof ready !== 'function' ) {
+ if ( compare( filter( ['ready'], dependencies ), dependencies ) ) {
+ if ( typeof ready === 'function' ) {
ready();
}
}
request( dependencies, ready, error );
}
};
+
/**
- * Loads one or more modules for future use
+ * 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 ) {
+ this.load = function( modules, type ) {
// Validate input
if ( typeof modules !== 'object' && typeof modules !== 'string' ) {
- throw new Error( 'dependencies must be a string or an array, not a ' + typeof dependencies )
+ throw new Error( 'dependencies must be a string or an array, not a ' +
+ typeof dependencies )
}
- // Allow calling with a single dependency as a string
+ // 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" />' )
+ .attr( 'href', modules ) );
+ return true;
+ } else if ( type === 'text/javascript' || typeof type === 'undefined' ) {
+ var script = mediaWiki.html.element( 'script',
+ { type: 'text/javascript', src: modules }, '' );
+ if ( ready ) {
+ $( 'body' ).append( script );
+ } else {
+ document.write( script );
+ }
+ return true;
+ }
+ // 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 ( filter( ['ready'], modules ).compare( modules ) ) {
+ if ( compare( filter( ['ready'], modules ), modules ) ) {
return true;
}
// If any modules have errors return false
return true;
}
};
+
/**
* Flushes the request queue and begin executing load requests on demand
*/
this.go = function() {
suspended = false;
- that.work();
+ mediaWiki.loader.work();
};
+
/**
* Changes the state of a module
- *
- * @param mixed module string module name or object of module name/state pairs
- * @param string state string state name
+ *
+ * @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 ) {
- that.state( m, module[m] );
+ mediaWiki.loader.state( m, module[m] );
}
return;
}
- if ( module in registry ) {
- registry[module].state = state;
+ if ( !( module in registry ) ) {
+ mediaWiki.loader.register( module );
}
+ 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 );
+ }
+ return null;
+ };
+
/* Cache document ready status */
-
+
$(document).ready( function() { ready = true; } );
} )();
-
+
+ /** HTML construction helper functions */
+ this.html = new ( function () {
+ function escapeCallback( s ) {
+ switch ( s ) {
+ case "'":
+ return ''';
+ case '"':
+ return '"';
+ case '<':
+ return '<';
+ case '>':
+ return '>';
+ case '&':
+ return '&';
+ }
+ }
+
+ /**
+ * 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 mediaWiki.html.element().
+ */
+ this.Raw = function( value ) {
+ this.value = value;
+ };
+
+ /**
+ * Wrapper object for CDATA element contents passed to mediaWiki.html.element()
+ */
+ this.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 = mediaWiki.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 ( 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' );
+ }
+ s += contents.value;
+ } else {
+ throw new Error( 'mw.html.element: Invalid type of contents' );
+ }
+ s += '</' + name + '>';
+ return s;
+ };
+ } )();
+
+
/* Extension points */
-
- this.util = {};
+
this.legacy = {};
-
-} )( jQuery );
+} )( jQuery );
/* Auto-register from pre-loaded startup scripts */
-if ( typeof window['startUp'] === 'function' ) {
- window['startUp']();
- delete window['startUp'];
-}
\ No newline at end of file
+if ( typeof startUp === 'function' ) {
+ startUp();
+ delete startUp;
+}
+
+// Alias $j to jQuery for backwards compatibility
+window.$j = jQuery;
+window.mw = mediaWiki;
dépôts / lhc / web / wiklou.git / blobdiff