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