resources/mediawiki/mediawiki.js

   1 /*
   2  * JavaScript backwards-compatibility alternatives and other convenience functions
   3  */
   4
   5 jQuery.extend({
   6         trimLeft : function( str ) {
   7                 return str === null ? '' : str.toString().replace( /^\s+/, '' );
   8         },
   9         trimRight : function( str ) {
  10                 return str === null ?
  11                                 '' : str.toString().replace( /\s+$/, '' );
  12         },
  13         ucFirst : function( str ) {
  14                 return str.substr( 0, 1 ).toUpperCase() + str.substr( 1, str.length );
  15         },
  16         escapeRE : function( str ) {
  17                 return str.replace ( /([\\{}()|.?*+\-^$\[\]])/g, "\\$1" );
  18         },
  19         // $.isDomElement( document.getElementById('content') ) === true
  20         // $.isDomElement( document.getElementsByClassName('portal') ) === false (array)
  21         // $.isDomElement( document.getElementsByClassName('portal')[0] ) === true
  22         // $.isDomElement( $('#content') ) === false (jQuery object)
  23         // $.isDomElement( $('#content').get(0) ) === true
  24         // $.isDomElement( 'hello world' ) === false
  25         isDomElement : function( el ) {
  26                 return !!el.nodeType;
  27         },
  28         isEmpty : function( v ) {
  29                 var key;
  30                 if ( v === "" || v === 0 || v === "0" || v === null
  31                         || v === false || typeof v === 'undefined' )
  32                 {
  33                         return true;
  34                 }
  35                 // the for-loop could potentially contain prototypes
  36                 // to avoid that we check it's length first
  37                 if ( v.length === 0 ) {
  38                         return true;
  39                 }
  40                 if ( typeof v === 'object' ) {
  41                         for ( key in v ) {
  42                                 return false;
  43                         }
  44                         return true;
  45                 }
  46                 return false;
  47         },
  48         compareArray : function( arrThis, arrAgainst ) {
  49                 if ( arrThis.length != arrAgainst.length ) {
  50                         return false;
  51                 }
  52                 for ( var i = 0; i < arrThis.length; i++ ) {
  53                         if ( arrThis[i] instanceof Array ) {
  54                                 if ( !$.compareArray( arrThis[i], arrAgainst[i] ) ) {
  55                                         return false;
  56                                 }
  57                         } else if ( arrThis[i] !== arrAgainst[i] ) {
  58                                 return false;
  59                         }
  60                 }
  61                 return true;
  62         },
  63         compareObject : function( objectA, objectB ) {
  64
  65                 // Do a simple check if the types match
  66                 if ( typeof( objectA ) == typeof( objectB ) ) {
  67
  68                         // Only loop over the contents if it really is an object
  69                         if ( typeof( objectA ) == 'object' ) {
  70                                 // If they are aliases of the same object (ie. mw and mediaWiki) return now
  71                                 if ( objectA === objectB ) {
  72                                         return true;
  73                                 } else {
  74                                         // Iterate over each property
  75                                         for ( var prop in objectA ) {
  76                                                 // Check if this property is also present in the other object
  77                                                 if ( prop in objectB ) {
  78                                                         // Compare the types of the properties
  79                                                         var type = typeof( objectA[prop] );
  80                                                         if ( type == typeof( objectB[prop] ) ) {
  81                                                                 // Recursively check objects inside this one
  82                                                                 switch ( type ) {
  83                                                                         case 'object' :
  84                                                                                 if ( !$.compareObject( objectA[prop], objectB[prop] ) ) {
  85                                                                                         return false;
  86                                                                                 }
  87                                                                                 break;
  88                                                                         case 'function' :
  89                                                                                 // Functions need to be strings to compare them properly
  90                                                                                 if ( objectA[prop].toString() !== objectB[prop].toString() ) {
  91                                                                                         return false;
  92                                                                                 }
  93                                                                                 break;
  94                                                                         default:
  95                                                                                 // Strings, numbers
  96                                                                                 if ( objectA[prop] !== objectB[prop] ) {
  97                                                                                         return false;
  98                                                                                 }
  99                                                                                 break;
 100                                                                 }
 101                                                         } else {
 102                                                                 return false;
 103                                                         }
 104                                                 } else {
 105                                                         return false;
 106                                                 }
 107                                         }
 108                                         // Check for properties in B but not in A
 109                                         // This is about 15% faster (tested in Safari 5 and Firefox 3.6)
 110                                         // ...than incrementing a count variable in the above and below loops
 111                                         // See also: http://www.mediawiki.org/wiki/ResourceLoader/Default_modules/compareObject_test#Results
 112                                         for ( var prop in objectB ) {
 113                                                 if ( !( prop in objectA ) ) {
 114                                                         return false;
 115                                                 }
 116                                         }
 117                                 }
 118                         }
 119                 } else {
 120                         return false;
 121                 }
 122                 return true;
 123         }
 124 });
 125
 126 /*
 127  * Core MediaWiki JavaScript Library
 128  */
 129
 130 // Attach to window
 131 window.mediaWiki = new ( function( $ ) {
 132
 133         /* Constants */
 134
 135         // This will not change until we are 100% ready to turn off legacy globals
 136         var LEGACY_GLOBALS = true;
 137
 138         /* Private Members */
 139
 140         // List of messages that have been requested to be loaded
 141         var messageQueue = {};
 142
 143         /* Prototypes */
 144
 145         /**
 146          * An object which allows single and multiple get/set/exists functionality
 147          * on a list of key / value pairs.
 148          *
 149          * @param {boolean} global Whether to get/set/exists values on the window
 150          *   object or a private object
 151          */
 152         function Map( global ) {
 153                 this.values = ( global === true ) ? window : {};
 154         }
 155
 156         /**
 157          * Gets the value of a key, or a list of key/value pairs for an array of keys.
 158          *
 159          * If called with no arguments, all values will be returned.
 160          *
 161          * @param selection mixed Key or array of keys to get values for
 162          * @param fallback mixed Value to use in case key(s) do not exist (optional)
 163          */
 164         Map.prototype.get = function( selection, fallback ) {
 165                 if ( typeof selection === 'object' ) {
 166                         selection = $.makeArray( selection );
 167                         var results = {};
 168                         for ( var i = 0; i < selection.length; i++ ) {
 169                                 results[selection[i]] = this.get( selection[i], fallback );
 170                         }
 171                         return results;
 172                 } else if ( typeof selection === 'string' ) {
 173                         if ( typeof this.values[selection] === 'undefined' ) {
 174                                 if ( typeof fallback !== 'undefined' ) {
 175                                         return fallback;
 176                                 }
 177                                 return null;
 178                         }
 179                         return this.values[selection];
 180                 }
 181                 return this.values;
 182         };
 183
 184         /**
 185          * Sets one or multiple key/value pairs.
 186          *
 187          * @param selection mixed Key or object of key/value pairs to set
 188          * @param value mixed Value to set (optional, only in use when key is a string)
 189          */
 190         Map.prototype.set = function( selection, value ) {
 191                 if ( typeof selection === 'object' ) {
 192                         for ( var s in selection ) {
 193                                 this.values[s] = selection[s];
 194                         }
 195                 } else if ( typeof selection === 'string' && typeof value !== 'undefined' ) {
 196                         this.values[selection] = value;
 197                 }
 198         };
 199
 200         /**
 201          * Checks if one or multiple keys exist.
 202          *
 203          * @param selection mixed Key or array of keys to check
 204          * @return boolean Existence of key(s)
 205          */
 206         Map.prototype.exists = function( selection ) {
 207                 if ( typeof selection === 'object' ) {
 208                         for ( var s = 0; s < selection.length; s++ ) {
 209                                 if ( !( selection[s] in this.values ) ) {
 210                                         return false;
 211                                 }
 212                         }
 213                         return true;
 214                 } else {
 215                         return selection in this.values;
 216                 }
 217         };
 218
 219         /**
 220          * Message object, similar to Message in PHP
 221          */
 222         function Message( map, key, parameters ) {
 223                 this.format = 'parse';
 224                 this.map = map;
 225                 this.key = key;
 226                 this.parameters = typeof parameters === 'undefined' ? [] : $.makeArray( parameters );
 227         }
 228
 229         /**
 230          * Appends parameters for replacement
 231          *
 232          * @param parameters mixed First in a list of variadic arguments to append as message parameters
 233          */
 234         Message.prototype.params = function( parameters ) {
 235                 for ( var i = 0; i < parameters.length; i++ ) {
 236                         this.parameters[this.parameters.length] = parameters[i];
 237                 }
 238                 return this;
 239         };
 240
 241         /**
 242          * Converts message object to it's string form based on the state of format
 243          *
 244          * @return {string} String form of message
 245          */
 246         Message.prototype.toString = function() {
 247                 if ( !this.map.exists( this.key ) ) {
 248                         // Return <key> if key does not exist
 249                         return '<' + this.key + '>';
 250                 }
 251                 var text = this.map.get( this.key );
 252                 var parameters = this.parameters;
 253                 text = text.replace( /\$(\d+)/g, function( string, match ) {
 254                         var index = parseInt( match, 10 ) - 1;
 255                         return index in parameters ? parameters[index] : '$' + match;
 256                 } );
 257
 258                 if ( this.format === 'plain' ) {
 259                         return text;
 260                 }
 261                 if ( this.format === 'escaped' ) {
 262                         // According to Message.php this needs {{-transformation, which is
 263                         // still todo
 264                         return mediaWiki.html.escape( text );
 265                 }
 266
 267                 /* This should be fixed up when we have a parser
 268                 if ( this.format === 'parse' && 'language' in mediaWiki ) {
 269                         text = mediaWiki.language.parse( text );
 270                 }
 271                 */
 272                 return text;
 273         };
 274
 275         /**
 276          * Changes format to parse and converts message to string
 277          *
 278          * @return {string} String form of parsed message
 279          */
 280         Message.prototype.parse = function() {
 281                 this.format = 'parse';
 282                 return this.toString();
 283         };
 284
 285         /**
 286          * Changes format to plain and converts message to string
 287          *
 288          * @return {string} String form of plain message
 289          */
 290         Message.prototype.plain = function() {
 291                 this.format = 'plain';
 292                 return this.toString();
 293         };
 294
 295         /**
 296          * Changes the format to html escaped and converts message to string
 297          *
 298          * @return {string} String form of html escaped message
 299          */
 300         Message.prototype.escaped = function() {
 301                 this.format = 'escaped';
 302                 return this.toString();
 303         };
 304
 305         /**
 306          * Checks if message exists
 307          *
 308          * @return {string} String form of parsed message
 309          */
 310         Message.prototype.exists = function() {
 311                 return this.map.exists( this.key );
 312         };
 313
 314         /**
 315          * User object
 316          */
 317         function User() {
 318
 319                 /* Private Members */
 320
 321                 var that = this;
 322
 323                 /* Public Members */
 324
 325                 this.options = new Map();
 326
 327                 /* Public Methods */
 328
 329                 /**
 330                  * Generates a random user session ID (32 alpha-numeric characters).
 331                  *
 332                  * This information would potentially be stored in a cookie to identify a user during a
 333                  * session or series of sessions. It's uniqueness should not be depended on.
 334                  *
 335                  * @return string random set of 32 alpha-numeric characters
 336                  */
 337                 function generateId() {
 338                         var id = '';
 339                         var seed = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
 340                         for ( var i = 0, r; i < 32; i++ ) {
 341                                 r = Math.floor( Math.random() * seed.length );
 342                                 id += seed.substring( r, r + 1 );
 343                         }
 344                         return id;
 345                 }
 346
 347                 /**
 348                  * Gets the current user's name.
 349                  *
 350                  * @return mixed user name string or null if users is anonymous
 351                  */
 352                 this.name = function() {
 353                         return mediaWiki.config.get( 'wgUserName' );
 354                 };
 355
 356                 /**
 357                  * Checks if the current user is anonymous.
 358                  *
 359                  * @return boolean
 360                  */
 361                 this.anonymous = function() {
 362                         return that.name() ? false : true;
 363                 };
 364
 365                 /**
 366                  * Gets a random session ID automatically generated and kept in a cookie.
 367                  *
 368                  * This ID is ephemeral for everyone, staying in their browser only until they close
 369                  * their browser.
 370                  *
 371                  * Do not use this method before the first call to mw.loader.go(), it depends on
 372                  * jquery.cookie, which is added to the first pay-load just after mediaWiki is defined, but
 373                  * won't be loaded until the first call to go().
 374                  *
 375                  * @return string user name or random session ID
 376                  */
 377                 this.sessionId = function () {
 378                         var sessionId = $.cookie( 'mediaWiki.user.sessionId' );
 379                         if ( typeof sessionId == 'undefined' || sessionId === null ) {
 380                                 sessionId = generateId();
 381                                 $.cookie( 'mediaWiki.user.sessionId', sessionId, { 'expires': null, 'path': '/' } );
 382                         }
 383                         return sessionId;
 384                 };
 385
 386                 /**
 387                  * Gets the current user's name or a random ID automatically generated and kept in a cookie.
 388                  *
 389                  * This ID is persistent for anonymous users, staying in their browser up to 1 year. The
 390                  * expiration time is reset each time the ID is queried, so in most cases this ID will
 391                  * persist until the browser's cookies are cleared or the user doesn't visit for 1 year.
 392                  *
 393                  * Do not use this method before the first call to mw.loader.go(), it depends on
 394                  * jquery.cookie, which is added to the first pay-load just after mediaWiki is defined, but
 395                  * won't be loaded until the first call to go().
 396                  *
 397                  * @return string user name or random session ID
 398                  */
 399                 this.id = function() {
 400                         var name = that.name();
 401                         if ( name ) {
 402                                 return name;
 403                         }
 404                         var id = $.cookie( 'mediaWiki.user.id' );
 405                         if ( typeof id == 'undefined' || id === null ) {
 406                                 id = generateId();
 407                         }
 408                         // Set cookie if not set, or renew it if already set
 409                         $.cookie( 'mediaWiki.user.id', id, { 'expires': 365, 'path': '/' } );
 410                         return id;
 411                 };
 412
 413                 /**
 414                  * Gets the user's bucket, placing them in one at random based on set odds if needed.
 415                  *
 416                  * @param key String: Name of bucket
 417                  * @param options Object: Bucket configuration options
 418                  * @param options.buckets Object: List of bucket-name/relative-probability pairs (required,
 419                  * must have at least one pair)
 420                  * @param options.version Number: Version of bucket test, changing this forces rebucketing
 421                  * (optional, default: 0)
 422                  * @param options.tracked Boolean: Track the event of bucketing through the API module of
 423                  * the ClickTracking extension (optional, default: false)
 424                  * @param options.expires Number: Length of time (in days) until the user gets rebucketed
 425                  * (optional, default: 30)
 426                  * @return String: Bucket name - the randomly chosen key of the options.buckets object
 427                  *
 428                  * @example
 429                  *     mw.user.bucket( 'test', {
 430                  *         'buckets': { 'ignored': 50, 'control': 25, 'test': 25 },
 431                  *         'version': 1,
 432                  *         'tracked': true,
 433                  *         'expires': 7
 434                  *     } );
 435                  */
 436                 this.bucket = function( key, options ) {
 437                         options = $.extend( {
 438                                 'buckets': {},
 439                                 'version': 0,
 440                                 'tracked': false,
 441                                 'expires': 30
 442                         }, options || {} );
 443                         var cookie = $.cookie( 'mw.user.bucket-' + key );
 444                         var bucket = null;
 445                         var version = 0;
 446                         // Bucket information is stored as 2 integers, together as version:bucket like: "1:2"
 447                         if ( typeof cookie === 'string' && cookie.length > 2 && cookie.indexOf( ':' ) > 0 ) {
 448                                 var parts = cookie.split( ':' );
 449                                 if ( parts.length > 1 && parts[1] == options.version ) {
 450                                         version = Number( parts[0] );
 451                                         bucket = Number( parts[1] );
 452                                 }
 453                         }
 454                         if ( bucket === null ) {
 455                                 if ( !$.isPlainObject( options.buckets ) ) {
 456                                         throw 'Invalid buckets error. Object expected for options.buckets .';
 457                                 }
 458                                 version = Number( options.version );
 459                                 // Find range
 460                                 var range = 0;
 461                                 for ( var k in options.buckets ) {
 462                                         range += options.buckets[k];
 463                                 }
 464                                 // Select random value within range
 465                                 var rand = Math.random() * range;
 466                                 // Determine which bucket the value landed in
 467                                 var total = 0;
 468                                 for ( var k in options.buckets ) {
 469                                         bucket = k;
 470                                         total += options.buckets[k];
 471                                         if ( total >= rand ) {
 472                                                 break;
 473                                         }
 474                                 }
 475                                 if ( options.tracked ) {
 476                                         mw.loader.using( 'jquery.clickTracking', function() {
 477                                                 $.trackAction( 'mw.user.bucket-' + key + '@' + version + ':' + bucket );
 478                                         } );
 479                                 }
 480                                 $.cookie(
 481                                         'mw.userBuckets-' + key,
 482                                         version + ':' + bucket,
 483                                         { 'path': '/', 'expires': Number( options.expires ) }
 484                                 );
 485                         }
 486                         return bucket;
 487                 };
 488         }
 489
 490         /* Public Members */
 491
 492         /*
 493          * Dummy function which in debug mode can be replaced with a function that
 494          * does something clever
 495          */
 496         this.log = function() { };
 497
 498         /*
 499          * Make the Map-class publicly available
 500          */
 501         this.Map = Map;
 502
 503         /*
 504          * List of configuration values
 505          *
 506          * In legacy mode the values this object wraps will be in the global space
 507          */
 508         this.config = new this.Map( LEGACY_GLOBALS );
 509
 510         /*
 511          * Information about the current user
 512          */
 513         this.user = new User();
 514
 515         /*
 516          * Localization system
 517          */
 518         this.messages = new this.Map();
 519
 520         /* Public Methods */
 521
 522         /**
 523          * Gets a message object, similar to wfMessage()
 524          *
 525          * @param key string Key of message to get
 526          * @param parameters mixed First argument in a list of variadic arguments, each a parameter for $
 527          * replacement
 528          */
 529         this.message = function( key, parameters ) {
 530                 // Support variadic arguments
 531                 if ( typeof parameters !== 'undefined' ) {
 532                         parameters = $.makeArray( arguments );
 533                         parameters.shift();
 534                 } else {
 535                         parameters = [];
 536                 }
 537                 return new Message( mediaWiki.messages, key, parameters );
 538         };
 539
 540         /**
 541          * Gets a message string, similar to wfMsg()
 542          *
 543          * @param key string Key of message to get
 544          * @param parameters mixed First argument in a list of variadic arguments, each a parameter for $
 545          * replacement
 546          */
 547         this.msg = function( key, parameters ) {
 548                 return mediaWiki.message.apply( mediaWiki.message, arguments ).toString();
 549         };
 550
 551         /**
 552          * Client-side module loader which integrates with the MediaWiki ResourceLoader
 553          */
 554         this.loader = new ( function() {
 555
 556                 /* Private Members */
 557
 558                 /**
 559                  * Mapping of registered modules
 560                  *
 561                  * The jquery module is pre-registered, because it must have already
 562                  * been provided for this object to have been built, and in debug mode
 563                  * jquery would have been provided through a unique loader request,
 564                  * making it impossible to hold back registration of jquery until after
 565                  * mediawiki.
 566                  *
 567                  * Format:
 568                  *   {
 569                  *     'moduleName': {
 570                  *       'dependencies': ['required module', 'required module', ...], (or) function() {}
 571                  *       'state': 'registered', 'loading', 'loaded', 'ready', or 'error'
 572                  *       'script': function() {},
 573                  *       'style': 'css code string',
 574                  *       'messages': { 'key': 'value' },
 575                  *       'version': ############## (unix timestamp)
 576                  *     }
 577                  *   }
 578                  */
 579                 var registry = {};
 580                 // List of modules which will be loaded as when ready
 581                 var batch = [];
 582                 // List of modules to be loaded
 583                 var queue = [];
 584                 // List of callback functions waiting for modules to be ready to be called
 585                 var jobs = [];
 586                 // Flag indicating that requests should be suspended
 587                 var suspended = true;
 588                 // Flag inidicating that document ready has occured
 589                 var ready = false;
 590                 // Marker element for adding dynamic styles
 591                 var $marker = $( 'head meta[name=ResourceLoaderDynamicStyles]' );
 592
 593                 /* Private Methods */
 594
 595                 function compare( a, b ) {
 596                         if ( a.length != b.length ) {
 597                                 return false;
 598                         }
 599                         for ( var i = 0; i < b.length; i++ ) {
 600                                 if ( $.isArray( a[i] ) ) {
 601                                         if ( !compare( a[i], b[i] ) ) {
 602                                                 return false;
 603                                         }
 604                                 }
 605                                 if ( a[i] !== b[i] ) {
 606                                         return false;
 607                                 }
 608                         }
 609                         return true;
 610                 }
 611
 612                 /**
 613                  * Generates an ISO8601 "basic" string from a UNIX timestamp
 614                  */
 615                 function formatVersionNumber( timestamp ) {
 616                         function pad( a, b, c ) {
 617                                 return [a < 10 ? '0' + a : a, b < 10 ? '0' + b : b, c < 10 ? '0' + c : c].join( '' );
 618                         }
 619                         var d = new Date();
 620                         d.setTime( timestamp * 1000 );
 621                         return [
 622                                 pad( d.getUTCFullYear(), d.getUTCMonth() + 1, d.getUTCDate() ), 'T',
 623                                 pad( d.getUTCHours(), d.getUTCMinutes(), d.getUTCSeconds() ), 'Z'
 624                         ].join( '' );
 625                 }
 626
 627                 /**
 628                  * Recursively resolves dependencies and detects circular references
 629                  */
 630                 function recurse( module, resolved, unresolved ) {
 631                         if ( typeof registry[module] === 'undefined' ) {
 632                                 throw new Error( 'Unknown dependency: ' + module );
 633                         }
 634                         // Resolves dynamic loader function and replaces it with its own results
 635                         if ( $.isFunction( registry[module].dependencies ) ) {
 636                                 registry[module].dependencies = registry[module].dependencies();
 637                                 // Ensures the module's dependencies are always in an array
 638                                 if ( typeof registry[module].dependencies !== 'object' ) {
 639                                         registry[module].dependencies = [registry[module].dependencies];
 640                                 }
 641                         }
 642                         // Tracks down dependencies
 643                         for ( var n = 0; n < registry[module].dependencies.length; n++ ) {
 644                                 if ( $.inArray( registry[module].dependencies[n], resolved ) === -1 ) {
 645                                         if ( $.inArray( registry[module].dependencies[n], unresolved ) !== -1 ) {
 646                                                 throw new Error(
 647                                                         'Circular reference detected: ' + module +
 648                                                         ' -> ' + registry[module].dependencies[n]
 649                                                 );
 650                                         }
 651                                         recurse( registry[module].dependencies[n], resolved, unresolved );
 652                                 }
 653                         }
 654                         resolved[resolved.length] = module;
 655                         unresolved.splice( $.inArray( module, unresolved ), 1 );
 656                 }
 657
 658                 /**
 659                  * Gets a list of module names that a module depends on in their proper dependency order
 660                  *
 661                  * @param module string module name or array of string module names
 662                  * @return list of dependencies
 663                  * @throws Error if circular reference is detected
 664                  */
 665                 function resolve( module ) {
 666                         // Allow calling with an array of module names
 667                         if ( typeof module === 'object' ) {
 668                                 var modules = [];
 669                                 for ( var m = 0; m < module.length; m++ ) {
 670                                         var dependencies = resolve( module[m] );
 671                                         for ( var n = 0; n < dependencies.length; n++ ) {
 672                                                 modules[modules.length] = dependencies[n];
 673                                         }
 674                                 }
 675                                 return modules;
 676                         } else if ( typeof module === 'string' ) {
 677                                 // Undefined modules have no dependencies
 678                                 if ( !( module in registry ) ) {
 679                                         return [];
 680                                 }
 681                                 var resolved = [];
 682                                 recurse( module, resolved, [] );
 683                                 return resolved;
 684                         }
 685                         throw new Error( 'Invalid module argument: ' + module );
 686                 }
 687
 688                 /**
 689                  * Narrows a list of module names down to those matching a specific
 690                  * state. Possible states are 'undefined', 'registered', 'loading',
 691                  * 'loaded', or 'ready'
 692                  *
 693                  * @param states string or array of strings of module states to filter by
 694                  * @param modules array list of module names to filter (optional, all modules
 695                  *   will be used by default)
 696                  * @return array list of filtered module names
 697                  */
 698                 function filter( states, modules ) {
 699                         // Allow states to be given as a string
 700                         if ( typeof states === 'string' ) {
 701                                 states = [states];
 702                         }
 703                         // If called without a list of modules, build and use a list of all modules
 704                         var list = [], module;
 705                         if ( typeof modules === 'undefined' ) {
 706                                 modules = [];
 707                                 for ( module in registry ) {
 708                                         modules[modules.length] = module;
 709                                 }
 710                         }
 711                         // Build a list of modules which are in one of the specified states
 712                         for ( var s = 0; s < states.length; s++ ) {
 713                                 for ( var m = 0; m < modules.length; m++ ) {
 714                                         if ( typeof registry[modules[m]] === 'undefined' ) {
 715                                                 // Module does not exist
 716                                                 if ( states[s] == 'undefined' ) {
 717                                                         // OK, undefined
 718                                                         list[list.length] = modules[m];
 719                                                 }
 720                                         } else {
 721                                                 // Module exists, check state
 722                                                 if ( registry[modules[m]].state === states[s] ) {
 723                                                         // OK, correct state
 724                                                         list[list.length] = modules[m];
 725                                                 }
 726                                         }
 727                                 }
 728                         }
 729                         return list;
 730                 }
 731
 732                 /**
 733                  * Executes a loaded module, making it ready to use
 734                  *
 735                  * @param module string module name to execute
 736                  */
 737                 function execute( module ) {
 738                         var _fn = 'mw.loader::execute> ';
 739                         if ( typeof registry[module] === 'undefined' ) {
 740                                 throw new Error( 'Module has not been registered yet: ' + module );
 741                         } else if ( registry[module].state === 'registered' ) {
 742                                 throw new Error( 'Module has not been requested from the server yet: ' + module );
 743                         } else if ( registry[module].state === 'loading' ) {
 744                                 throw new Error( 'Module has not completed loading yet: ' + module );
 745                         } else if ( registry[module].state === 'ready' ) {
 746                                 throw new Error( 'Module has already been loaded: ' + module );
 747                         }
 748                         // Add style sheet to document
 749                         if ( typeof registry[module].style === 'string' && registry[module].style.length ) {
 750                                 $marker.before( mediaWiki.html.element( 'style',
 751                                                 { type: 'text/css' },
 752                                                 new mediaWiki.html.Cdata( registry[module].style )
 753                                         ) );
 754                         } else if ( typeof registry[module].style === 'object'
 755                                 && !( $.isArray( registry[module].style ) ) )
 756                         {
 757                                 for ( var media in registry[module].style ) {
 758                                         $marker.before( mediaWiki.html.element( 'style',
 759                                                 { type: 'text/css', media: media },
 760                                                 new mediaWiki.html.Cdata( registry[module].style[media] )
 761                                         ) );
 762                                 }
 763                         }
 764                         // Add localizations to message system
 765                         if ( typeof registry[module].messages === 'object' ) {
 766                                 mediaWiki.messages.set( registry[module].messages );
 767                         }
 768                         // Execute script
 769                         try {
 770                                 registry[module].script( jQuery );
 771                                 registry[module].state = 'ready';
 772                                 // Run jobs who's dependencies have just been met
 773                                 for ( var j = 0; j < jobs.length; j++ ) {
 774                                         if ( compare(
 775                                                 filter( 'ready', jobs[j].dependencies ),
 776                                                 jobs[j].dependencies ) )
 777                                         {
 778                                                 if ( $.isFunction( jobs[j].ready ) ) {
 779                                                         jobs[j].ready();
 780                                                 }
 781                                                 jobs.splice( j, 1 );
 782                                                 j--;
 783                                         }
 784                                 }
 785                                 // Execute modules who's dependencies have just been met
 786                                 for ( var r in registry ) {
 787                                         if ( registry[r].state == 'loaded' ) {
 788                                                 if ( compare(
 789                                                         filter( ['ready'], registry[r].dependencies ),
 790                                                         registry[r].dependencies ) )
 791                                                 {
 792                                                         execute( r );
 793                                                 }
 794                                         }
 795                                 }
 796                         } catch ( e ) {
 797                                 // This needs to NOT use mw.log because these errors are common in production mode
 798                                 // and not in debug mode, such as when a symbol that should be global isn't exported
 799                                 if ( window.console && typeof window.console.log === 'function' ) {
 800                                         console.log( _fn + 'Exception thrown by ' + module + ': ' + e.message );
 801                                         console.log( e );
 802                                 }
 803                                 registry[module].state = 'error';
 804                                 // Run error callbacks of jobs affected by this condition
 805                                 for ( var j = 0; j < jobs.length; j++ ) {
 806                                         if ( $.inArray( module, jobs[j].dependencies ) !== -1 ) {
 807                                                 if ( $.isFunction( jobs[j].error ) ) {
 808                                                         jobs[j].error();
 809                                                 }
 810                                                 jobs.splice( j, 1 );
 811                                                 j--;
 812                                         }
 813                                 }
 814                         }
 815                 }
 816
 817                 /**
 818                  * Adds a dependencies to the queue with optional callbacks to be run
 819                  * when the dependencies are ready or fail
 820                  *
 821                  * @param dependencies string module name or array of string module names
 822                  * @param ready function callback to execute when all dependencies are ready
 823                  * @param error function callback to execute when any dependency fails
 824                  */
 825                 function request( dependencies, ready, error ) {
 826                         // Allow calling by single module name
 827                         if ( typeof dependencies === 'string' ) {
 828                                 dependencies = [dependencies];
 829                                 if ( dependencies[0] in registry ) {
 830                                         for ( var n = 0; n < registry[dependencies[0]].dependencies.length; n++ ) {
 831                                                 dependencies[dependencies.length] =
 832                                                         registry[dependencies[0]].dependencies[n];
 833                                         }
 834                                 }
 835                         }
 836                         // Add ready and error callbacks if they were given
 837                         if ( arguments.length > 1 ) {
 838                                 jobs[jobs.length] = {
 839                                         'dependencies': filter(
 840                                                 ['undefined', 'registered', 'loading', 'loaded'],
 841                                                 dependencies ),
 842                                         'ready': ready,
 843                                         'error': error
 844                                 };
 845                         }
 846                         // Queue up any dependencies that are undefined or registered
 847                         dependencies = filter( ['undefined', 'registered'], dependencies );
 848                         for ( var n = 0; n < dependencies.length; n++ ) {
 849                                 if ( $.inArray( dependencies[n], queue ) === -1 ) {
 850                                         queue[queue.length] = dependencies[n];
 851                                 }
 852                         }
 853                         // Work the queue
 854                         mediaWiki.loader.work();
 855                 }
 856
 857                 function sortQuery(o) {
 858                         var sorted = {}, key, a = [];
 859                         for ( key in o ) {
 860                                 if ( o.hasOwnProperty( key ) ) {
 861                                         a.push( key );
 862                                 }
 863                         }
 864                         a.sort();
 865                         for ( key = 0; key < a.length; key++ ) {
 866                                 sorted[a[key]] = o[a[key]];
 867                         }
 868                         return sorted;
 869                 }
 870
 871                 /* Public Methods */
 872
 873                 /**
 874                  * Requests dependencies from server, loading and executing when things when ready.
 875                  */
 876                 this.work = function() {
 877                         // Appends a list of modules to the batch
 878                         for ( var q = 0; q < queue.length; q++ ) {
 879                                 // Only request modules which are undefined or registered
 880                                 if ( !( queue[q] in registry ) || registry[queue[q]].state == 'registered' ) {
 881                                         // Prevent duplicate entries
 882                                         if ( $.inArray( queue[q], batch ) === -1 ) {
 883                                                 batch[batch.length] = queue[q];
 884                                                 // Mark registered modules as loading
 885                                                 if ( queue[q] in registry ) {
 886                                                         registry[queue[q]].state = 'loading';
 887                                                 }
 888                                         }
 889                                 }
 890                         }
 891                         // Clean up the queue
 892                         queue = [];
 893                         // After document ready, handle the batch
 894                         if ( !suspended && batch.length ) {
 895                                 // Always order modules alphabetically to help reduce cache
 896                                 // misses for otherwise identical content
 897                                 batch.sort();
 898                                 // Build a list of request parameters
 899                                 var base = {
 900                                         'skin': mediaWiki.config.get( 'skin' ),
 901                                         'lang': mediaWiki.config.get( 'wgUserLanguage' ),
 902                                         'debug': mediaWiki.config.get( 'debug' )
 903                                 };
 904                                 // Extend request parameters with a list of modules in the batch
 905                                 var requests = [];
 906                                 // Split into groups
 907                                 var groups = {};
 908                                 for ( var b = 0; b < batch.length; b++ ) {
 909                                         var group = registry[batch[b]].group;
 910                                         if ( !( group in groups ) ) {
 911                                                 groups[group] = [];
 912                                         }
 913                                         groups[group][groups[group].length] = batch[b];
 914                                 }
 915                                 for ( var group in groups ) {
 916                                         // Calculate the highest timestamp
 917                                         var version = 0;
 918                                         for ( var g = 0; g < groups[group].length; g++ ) {
 919                                                 if ( registry[groups[group][g]].version > version ) {
 920                                                         version = registry[groups[group][g]].version;
 921                                                 }
 922                                         }
 923                                         requests[requests.length] = $.extend(
 924                                                 { 'modules': groups[group].join( '|' ), 'version': formatVersionNumber( version ) }, base
 925                                         );
 926                                 }
 927                                 // Clear the batch - this MUST happen before we append the
 928                                 // script element to the body or it's possible that the script
 929                                 // will be locally cached, instantly load, and work the batch
 930                                 // again, all before we've cleared it causing each request to
 931                                 // include modules which are already loaded
 932                                 batch = [];
 933                                 // Asynchronously append a script tag to the end of the body
 934                                 function request() {
 935                                         var html = '';
 936                                         for ( var r = 0; r < requests.length; r++ ) {
 937                                                 requests[r] = sortQuery( requests[r] );
 938                                                 // Build out the HTML
 939                                                 var src = mediaWiki.config.get( 'wgLoadScript' ) + '?' + $.param( requests[r] );
 940                                                 html += mediaWiki.html.element( 'script',
 941                                                         { type: 'text/javascript', src: src }, '' );
 942                                         }
 943                                         return html;
 944                                 }
 945                                 // Load asynchronously after documument ready
 946                                 if ( ready ) {
 947                                         setTimeout( function() { $( 'body' ).append( request() ); }, 0 );
 948                                 } else {
 949                                         document.write( request() );
 950                                 }
 951                         }
 952                 };
 953
 954                 /**
 955                  * Registers a module, letting the system know about it and its
 956                  * dependencies. loader.js files contain calls to this function.
 957                  */
 958                 this.register = function( module, version, dependencies, group ) {
 959                         // Allow multiple registration
 960                         if ( typeof module === 'object' ) {
 961                                 for ( var m = 0; m < module.length; m++ ) {
 962                                         if ( typeof module[m] === 'string' ) {
 963                                                 mediaWiki.loader.register( module[m] );
 964                                         } else if ( typeof module[m] === 'object' ) {
 965                                                 mediaWiki.loader.register.apply( mediaWiki.loader, module[m] );
 966                                         }
 967                                 }
 968                                 return;
 969                         }
 970                         // Validate input
 971                         if ( typeof module !== 'string' ) {
 972                                 throw new Error( 'module must be a string, not a ' + typeof module );
 973                         }
 974                         if ( typeof registry[module] !== 'undefined' ) {
 975                                 throw new Error( 'module already implemeneted: ' + module );
 976                         }
 977                         // List the module as registered
 978                         registry[module] = {
 979                                 'state': 'registered',
 980                                 'group': typeof group === 'string' ? group : null,
 981                                 'dependencies': [],
 982                                 'version': typeof version !== 'undefined' ? parseInt( version, 10 ) : 0
 983                         };
 984                         if ( typeof dependencies === 'string' ) {
 985                                 // Allow dependencies to be given as a single module name
 986                                 registry[module].dependencies = [dependencies];
 987                         } else if ( typeof dependencies === 'object' || $.isFunction( dependencies ) ) {
 988                                 // Allow dependencies to be given as an array of module names
 989                                 // or a function which returns an array
 990                                 registry[module].dependencies = dependencies;
 991                         }
 992                 };
 993
 994                 /**
 995                  * Implements a module, giving the system a course of action to take
 996                  * upon loading. Results of a request for one or more modules contain
 997                  * calls to this function.
 998                  */
 999                 this.implement = function( module, script, style, localization ) {
1000                         // Automatically register module
1001                         if ( typeof registry[module] === 'undefined' ) {
1002                                 mediaWiki.loader.register( module );
1003                         }
1004                         // Validate input
1005                         if ( !$.isFunction( script ) ) {
1006                                 throw new Error( 'script must be a function, not a ' + typeof script );
1007                         }
1008                         if ( typeof style !== 'undefined'
1009                                 && typeof style !== 'string'
1010                                 && typeof style !== 'object' )
1011                         {
1012                                 throw new Error( 'style must be a string or object, not a ' + typeof style );
1013                         }
1014                         if ( typeof localization !== 'undefined'
1015                                 && typeof localization !== 'object' )
1016                         {
1017                                 throw new Error( 'localization must be an object, not a ' + typeof localization );
1018                         }
1019                         if ( typeof registry[module] !== 'undefined'
1020                                 && typeof registry[module].script !== 'undefined' )
1021                         {
1022                                 throw new Error( 'module already implemeneted: ' + module );
1023                         }
1024                         // Mark module as loaded
1025                         registry[module].state = 'loaded';
1026                         // Attach components
1027                         registry[module].script = script;
1028                         if ( typeof style === 'string'
1029                                 || typeof style === 'object' && !( style instanceof Array ) )
1030                         {
1031                                 registry[module].style = style;
1032                         }
1033                         if ( typeof localization === 'object' ) {
1034                                 registry[module].messages = localization;
1035                         }
1036                         // Execute or queue callback
1037                         if ( compare(
1038                                 filter( ['ready'], registry[module].dependencies ),
1039                                 registry[module].dependencies ) )
1040                         {
1041                                 execute( module );
1042                         } else {
1043                                 request( module );
1044                         }
1045                 };
1046
1047                 /**
1048                  * Executes a function as soon as one or more required modules are ready
1049                  *
1050                  * @param dependencies string or array of strings of modules names the callback
1051                  *   dependencies to be ready before
1052                  * executing
1053                  * @param ready function callback to execute when all dependencies are ready (optional)
1054                  * @param error function callback to execute when if dependencies have a errors (optional)
1055                  */
1056                 this.using = function( dependencies, ready, error ) {
1057                         // Validate input
1058                         if ( typeof dependencies !== 'object' && typeof dependencies !== 'string' ) {
1059                                 throw new Error( 'dependencies must be a string or an array, not a ' +
1060                                         typeof dependencies );
1061                         }
1062                         // Allow calling with a single dependency as a string
1063                         if ( typeof dependencies === 'string' ) {
1064                                 dependencies = [dependencies];
1065                         }
1066                         // Resolve entire dependency map
1067                         dependencies = resolve( dependencies );
1068                         // If all dependencies are met, execute ready immediately
1069                         if ( compare( filter( ['ready'], dependencies ), dependencies ) ) {
1070                                 if ( $.isFunction( ready ) ) {
1071                                         ready();
1072                                 }
1073                         }
1074                         // If any dependencies have errors execute error immediately
1075                         else if ( filter( ['error'], dependencies ).length ) {
1076                                 if ( $.isFunction( error ) ) {
1077                                         error();
1078                                 }
1079                         }
1080                         // Since some dependencies are not yet ready, queue up a request
1081                         else {
1082                                 request( dependencies, ready, error );
1083                         }
1084                 };
1085
1086                 /**
1087                  * Loads an external script or one or more modules for future use
1088                  *
1089                  * @param modules mixed either the name of a module, array of modules,
1090                  *   or a URL of an external script or style
1091                  * @param type string mime-type to use if calling with a URL of an
1092                  *   external script or style; acceptable values are "text/css" and
1093                  *   "text/javascript"; if no type is provided, text/javascript is
1094                  *   assumed
1095                  */
1096                 this.load = function( modules, type ) {
1097                         // Validate input
1098                         if ( typeof modules !== 'object' && typeof modules !== 'string' ) {
1099                                 throw new Error( 'modules must be a string or an array, not a ' +
1100                                         typeof modules );
1101                         }
1102                         // Allow calling with an external script or single dependency as a string
1103                         if ( typeof modules === 'string' ) {
1104                                 // Support adding arbitrary external scripts
1105                                 if ( modules.substr( 0, 7 ) == 'http://' || modules.substr( 0, 8 ) == 'https://' ) {
1106                                         if ( type === 'text/css' ) {
1107                                                 $( 'head' ).append( $( '<link />', {
1108                                                         rel: 'stylesheet',
1109                                                         type: 'text/css',
1110                                                         href: modules
1111                                                 } ) );
1112                                                 return true;
1113                                         } else if ( type === 'text/javascript' || typeof type === 'undefined' ) {
1114                                                 var script = mediaWiki.html.element( 'script',
1115                                                         { type: 'text/javascript', src: modules }, '' );
1116                                                 if ( ready ) {
1117                                                         $( 'body' ).append( script );
1118                                                 } else {
1119                                                         document.write( script );
1120                                                 }
1121                                                 return true;
1122                                         }
1123                                         // Unknown type
1124                                         return false;
1125                                 }
1126                                 // Called with single module
1127                                 modules = [modules];
1128                         }
1129                         // Resolve entire dependency map
1130                         modules = resolve( modules );
1131                         // If all modules are ready, nothing dependency be done
1132                         if ( compare( filter( ['ready'], modules ), modules ) ) {
1133                                 return true;
1134                         }
1135                         // If any modules have errors return false
1136                         else if ( filter( ['error'], modules ).length ) {
1137                                 return false;
1138                         }
1139                         // Since some modules are not yet ready, queue up a request
1140                         else {
1141                                 request( modules );
1142                                 return true;
1143                         }
1144                 };
1145
1146                 /**
1147                  * Flushes the request queue and begin executing load requests on demand
1148                  */
1149                 this.go = function() {
1150                         suspended = false;
1151                         mediaWiki.loader.work();
1152                 };
1153
1154                 /**
1155                  * Changes the state of a module
1156                  *
1157                  * @param module string module name or object of module name/state pairs
1158                  * @param state string state name
1159                  */
1160                 this.state = function( module, state ) {
1161                         if ( typeof module === 'object' ) {
1162                                 for ( var m in module ) {
1163                                         mediaWiki.loader.state( m, module[m] );
1164                                 }
1165                                 return;
1166                         }
1167                         if ( !( module in registry ) ) {
1168                                 mediaWiki.loader.register( module );
1169                         }
1170                         registry[module].state = state;
1171                 };
1172
1173                 /**
1174                  * Gets the version of a module
1175                  *
1176                  * @param module string name of module to get version for
1177                  */
1178                 this.version = function( module ) {
1179                         if ( module in registry && 'version' in registry[module] ) {
1180                                 return formatVersionNumber( registry[module].version );
1181                         }
1182                         return null;
1183                 };
1184
1185                 /* Cache document ready status */
1186
1187                 $(document).ready( function() { ready = true; } );
1188         } )();
1189
1190         /** HTML construction helper functions */
1191         this.html = new ( function () {
1192                 function escapeCallback( s ) {
1193                         switch ( s ) {
1194                                 case "'":
1195                                         return '&#039;';
1196                                 case '"':
1197                                         return '&quot;';
1198                                 case '<':
1199                                         return '&lt;';
1200                                 case '>':
1201                                         return '&gt;';
1202                                 case '&':
1203                                         return '&amp;';
1204                         }
1205                 }
1206
1207                 /**
1208                  * Escape a string for HTML. Converts special characters to HTML entities.
1209                  * @param s The string to escape
1210                  */
1211                 this.escape = function( s ) {
1212                         return s.replace( /['"<>&]/g, escapeCallback );
1213                 };
1214
1215                 /**
1216                  * Wrapper object for raw HTML passed to mw.html.element().
1217                  */
1218                 this.Raw = function( value ) {
1219                         this.value = value;
1220                 };
1221
1222                 /**
1223                  * Wrapper object for CDATA element contents passed to mw.html.element()
1224                  */
1225                 this.Cdata = function( value ) {
1226                         this.value = value;
1227                 };
1228
1229                 /**
1230                  * Create an HTML element string, with safe escaping.
1231                  *
1232                  * @param name The tag name.
1233                  * @param attrs An object with members mapping element names to values
1234                  * @param contents The contents of the element. May be either:
1235                  *    - string: The string is escaped.
1236                  *    - null or undefined: The short closing form is used, e.g. <br/>.
1237                  *    - this.Raw: The value attribute is included without escaping.
1238                  *    - this.Cdata: The value attribute is included, and an exception is
1239                  *      thrown if it contains an illegal ETAGO delimiter.
1240                  *      See http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.3.2
1241                  *
1242                  * Example:
1243                  *    var h = mw.html;
1244                  *    return h.element( 'div', {},
1245                  *        new h.Raw( h.element( 'img', {src: '<'} ) ) );
1246                  * Returns <div><img src="&lt;"/></div>
1247                  */
1248                 this.element = function( name, attrs, contents ) {
1249                         var s = '<' + name;
1250                         for ( var attrName in attrs ) {
1251                                 s += ' ' + attrName + '="' + this.escape( attrs[attrName] ) + '"';
1252                         }
1253                         if ( typeof contents == 'undefined' || contents === null ) {
1254                                 // Self close tag
1255                                 s += '/>';
1256                                 return s;
1257                         }
1258                         // Regular open tag
1259                         s += '>';
1260                         if ( typeof contents === 'string') {
1261                                 // Escaped
1262                                 s += this.escape( contents );
1263                         } else if ( contents instanceof this.Raw ) {
1264                                 // Raw HTML inclusion
1265                                 s += contents.value;
1266                         } else if ( contents instanceof this.Cdata ) {
1267                                 // CDATA
1268                                 if ( /<\/[a-zA-z]/.test( contents.value ) ) {
1269                                         throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
1270                                 }
1271                                 s += contents.value;
1272                         } else {
1273                                 throw new Error( 'mw.html.element: Invalid type of contents' );
1274                         }
1275                         s += '</' + name + '>';
1276                         return s;
1277                 };
1278         } )();
1279
1280
1281         /* Extension points */
1282
1283         this.legacy = {};
1284
1285 } )( jQuery );
1286
1287 // Alias $j to jQuery for backwards compatibility
1288 window.$j = jQuery;
1289 window.mw = mediaWiki;
1290
1291 /* Auto-register from pre-loaded startup scripts */
1292
1293 if ( $.isFunction( startUp ) ) {
1294         startUp();
1295         delete startUp;
1296 }
1297
1298 // Add jQuery Cookie to initial payload (used in mediaWiki.user)
1299 mw.loader.load( 'jquery.cookie' );