Merging resourceloader branch into trunk. Full documentation is at http://www.mediawi...
[lhc/web/wiklou.git] / resources / mediawiki / mediawiki.js
1 /*
2 * JavaScript backwards-compatibility and support
3 */
4
5 // Make calling .indexOf() on an array work on older browsers
6 if ( typeof Array.prototype.indexOf === 'undefined' ) {
7 Array.prototype.indexOf = function( needle ) {
8 for ( var i = 0; i < this.length; i++ ) {
9 if ( this[i] === needle ) {
10 return i;
11 }
12 }
13 return -1;
14 };
15 }
16 // Add array comparison functionality
17 if ( typeof Array.prototype.compare === 'undefined' ) {
18 Array.prototype.compare = function( against ) {
19 if ( this.length != against.length ) {
20 return false;
21 }
22 for ( var i = 0; i < against.length; i++ ) {
23 if ( this[i].compare ) {
24 if ( !this[i].compare( against[i] ) ) {
25 return false;
26 }
27 }
28 if ( this[i] !== against[i] ) {
29 return false;
30 }
31 }
32 return true;
33 };
34 }
35
36 /*
37 * Core MediaWiki JavaScript Library
38 */
39 // Attach to window
40 window.mediaWiki = new ( function( $ ) {
41
42 /* Constants */
43
44 // This will not change until we are 100% ready to turn off legacy globals
45 const LEGACY_GLOBALS = true;
46
47 /* Members */
48
49 this.legacy = LEGACY_GLOBALS ? window : {};
50
51 /* Methods */
52
53 /*
54 * Dummy function which in debug mode can be replaced with a function that does something clever
55 */
56 this.log = function() { };
57 /*
58 * An object which allows single and multiple existence, setting and getting on a list of key / value pairs
59 */
60 this.config = new ( function() {
61
62 /* Private Members */
63
64 var that = this;
65 // List of configuration values - in legacy mode these configurations were ALL in the global space
66 var values = LEGACY_GLOBALS ? window : {};
67
68 /* Public Methods */
69
70 /**
71 * Sets one or multiple configuration values using a key and a value or an object of keys and values
72 */
73 this.set = function( keys, value ) {
74 if ( typeof keys === 'object' ) {
75 for ( var k in keys ) {
76 values[k] = keys[k];
77 }
78 } else if ( typeof keys === 'string' && typeof value !== 'undefined' ) {
79 values[keys] = value;
80 }
81 };
82 /**
83 * Gets one or multiple configuration values using a key and an optional fallback or an array of keys
84 */
85 this.get = function( keys, fallback ) {
86 if ( typeof keys === 'object' ) {
87 var result = {};
88 for ( var k = 0; k < keys.length; k++ ) {
89 if ( typeof values[keys[k]] !== 'undefined' ) {
90 result[keys[k]] = values[keys[k]];
91 }
92 }
93 return result;
94 } else if ( typeof keys === 'string' ) {
95 if ( typeof values[keys] === 'undefined' ) {
96 return typeof fallback !== 'undefined' ? fallback : null;
97 } else {
98 return values[keys];
99 }
100 } else {
101 return values;
102 }
103 };
104 /**
105 * Checks if one or multiple configuration fields exist
106 */
107 this.exists = function( keys ) {
108 if ( typeof keys === 'object' ) {
109 for ( var k = 0; k < keys.length; k++ ) {
110 if ( !( keys[k] in values ) ) {
111 return false;
112 }
113 }
114 return true;
115 } else {
116 return keys in values;
117 }
118 };
119 } )();
120 /*
121 * Localization system
122 */
123 this.msg = new ( function() {
124
125 /* Private Members */
126
127 var that = this;
128 // List of localized messages
129 var messages = {};
130
131 /* Public Methods */
132
133 this.set = function( keys, value ) {
134 if ( typeof keys === 'object' ) {
135 for ( var k in keys ) {
136 messages[k] = keys[k];
137 }
138 } else if ( typeof keys === 'string' && typeof value !== 'undefined' ) {
139 messages[keys] = value;
140 }
141 };
142 this.get = function( key, args ) {
143 if ( !( key in messages ) ) {
144 return '<' + key + '>';
145 }
146 var msg = messages[key];
147 if ( typeof args == 'object' || typeof args == 'array' ) {
148 for ( var a = 0; a < args.length; a++ ) {
149 msg = msg.replace( '\$' + ( parseInt( a ) + 1 ), args[a] );
150 }
151 } else if ( typeof args == 'string' || typeof args == 'number' ) {
152 msg = msg.replace( '$1', args );
153 }
154 return msg;
155 };
156 } )();
157 /*
158 * Client-side module loader which integrates with the MediaWiki ResourceLoader
159 */
160 this.loader = new ( function() {
161
162 /* Private Members */
163
164 var that = this;
165 /*
166 * Mapping of registered modules
167 *
168 * The jquery module is pre-registered, because it must have already been provided for this object to have
169 * been built, and in debug mode jquery would have been provided through a unique loader request, making it
170 * impossible to hold back registration of jquery until after mediawiki.
171 *
172 * Format:
173 * {
174 * 'moduleName': {
175 * 'dependencies': ['required module', 'required module', ...], (or) function() {}
176 * 'state': 'registered', 'loading', 'loaded', 'ready', or 'error'
177 * 'script': function() {},
178 * 'style': 'css code string',
179 * 'messages': { 'key': 'value' },
180 * 'version': ############## (unix timestamp)
181 * }
182 * }
183 */
184 var registry = {};
185 // List of modules which will be loaded as when ready
186 var batch = [];
187 // List of modules to be loaded
188 var queue = [];
189 // List of callback functions waiting for modules to be ready to be called
190 var jobs = [];
191 // Flag indicating that requests should be suspended
192 var suspended = true;
193 // Flag inidicating that document ready has occured
194 var ready = false;
195
196 /* Private Methods */
197
198 /**
199 * Generates an ISO8601 string from a UNIX timestamp
200 */
201 function formatVersionNumber( timestamp ) {
202 var date = new Date();
203 date.setTime( timestamp * 1000 );
204 function pad1( n ) {
205 return n < 10 ? '0' + n : n
206 }
207 function pad2( n ) {
208 return n < 10 ? '00' + n : ( n < 100 ? '0' + n : n );
209 }
210 return date.getUTCFullYear() + '-' +
211 pad1( date.getUTCMonth() + 1 ) + '-' +
212 pad1( date.getUTCDate() ) + 'T' +
213 pad1( date.getUTCHours() ) + ':' +
214 pad1( date.getUTCMinutes() ) + ':' +
215 pad1( date.getUTCSeconds() ) +
216 'Z';
217 }
218 /**
219 * Recursively resolves dependencies and detects circular references
220 */
221 function recurse( module, resolved, unresolved ) {
222 unresolved[unresolved.length] = module;
223 // Resolves dynamic loader function and replaces it with it's own results
224 if ( typeof registry[module].dependencies === 'function' ) {
225 registry[module].dependencies = registry[module].dependencies();
226 // Gaurantees the module's dependencies are always in an array
227 if ( typeof registry[module].dependencies !== 'object' ) {
228 registry[module].dependencies = [registry[module].dependencies];
229 }
230 }
231 // Tracks down dependencies
232 for ( var n = 0; n < registry[module].dependencies.length; n++ ) {
233 if ( resolved.indexOf( registry[module].dependencies[n] ) === -1 ) {
234 if ( unresolved.indexOf( registry[module].dependencies[n] ) !== -1 ) {
235 throw new Error(
236 'Circular reference detected: ' + module + ' -> ' + registry[module].dependencies[n]
237 );
238 }
239 recurse( registry[module].dependencies[n], resolved, unresolved );
240 }
241 }
242 resolved[resolved.length] = module;
243 unresolved.splice( unresolved.indexOf( module ), 1 );
244 }
245 /**
246 * Gets a list of modules names that a module dependencies in their proper dependency order
247 *
248 * @param mixed string module name or array of string module names
249 * @return list of dependencies
250 * @throws Error if circular reference is detected
251 */
252 function resolve( module, resolved, unresolved ) {
253 // Allow calling with an array of module names
254 if ( typeof module === 'object' ) {
255 var modules = [];
256 for ( var m = 0; m < module.length; m++ ) {
257 var dependencies = resolve( module[m] );
258 for ( var n = 0; n < dependencies.length; n++ ) {
259 modules[modules.length] = dependencies[n];
260 }
261 }
262 return modules;
263 } else if ( typeof module === 'string' ) {
264 // Undefined modules have no dependencies
265 if ( !( module in registry ) ) {
266 return [];
267 }
268 var resolved = [];
269 recurse( module, resolved, [] );
270 return resolved;
271 }
272 throw new Error( 'Invalid module argument: ' + module );
273 };
274 /**
275 * Narrows a list of module names down to those matching a specific state. Possible states are 'undefined',
276 * 'registered', 'loading', 'loaded', or 'ready'
277 *
278 * @param mixed string or array of strings of module states to filter by
279 * @param array list of module names to filter (optional, all modules will be used by default)
280 * @return array list of filtered module names
281 */
282 function filter( states, modules ) {
283 // Allow states to be given as a string
284 if ( typeof states === 'string' ) {
285 states = [states];
286 }
287 // If called without a list of modules, build and use a list of all modules
288 var list = [];
289 if ( typeof modules === 'undefined' ) {
290 modules = [];
291 for ( module in registry ) {
292 modules[modules.length] = module;
293 }
294 }
295 // Build a list of modules which are in one of the specified states
296 for ( var s = 0; s < states.length; s++ ) {
297 for ( var m = 0; m < modules.length; m++ ) {
298 if (
299 ( states[s] == 'undefined' && typeof registry[modules[m]] === 'undefined' ) ||
300 ( typeof registry[modules[m]] === 'object' && registry[modules[m]].state === states[s] )
301 ) {
302 list[list.length] = modules[m];
303 }
304 }
305 }
306 return list;
307 }
308 /**
309 * Executes a loaded module, making it ready to use
310 *
311 * @param string module name to execute
312 */
313 function execute( module ) {
314 if ( typeof registry[module] === 'undefined' ) {
315 throw new Error( 'Module has not been registered yet: ' + module );
316 } else if ( registry[module].state === 'registered' ) {
317 throw new Error( 'Module has not been requested from the server yet: ' + module );
318 } else if ( registry[module].state === 'loading' ) {
319 throw new Error( 'Module has not completed loading yet: ' + module );
320 } else if ( registry[module].state === 'ready' ) {
321 throw new Error( 'Module has already been loaded: ' + module );
322 }
323 // Add style sheet to document
324 if ( typeof registry[module].style === 'string' && registry[module].style.length ) {
325 $( 'head' ).append( '<style type="text/css">' + registry[module].style + '</style>' );
326 }
327 // Add localizations to message system
328 if ( typeof registry[module].messages === 'object' ) {
329 mediaWiki.msg.set( registry[module].messages );
330 }
331 // Execute script
332 try {
333 registry[module].script();
334 registry[module].state = 'ready';
335 // Run jobs who's dependencies have just been met
336 for ( var j = 0; j < jobs.length; j++ ) {
337 if ( filter( 'ready', jobs[j].dependencies ).compare( jobs[j].dependencies ) ) {
338 if ( typeof jobs[j].ready === 'function' ) {
339 jobs[j].ready();
340 }
341 jobs.splice( j, 1 );
342 j--;
343 }
344 }
345 // Execute modules who's dependencies have just been met
346 for ( r in registry ) {
347 if ( registry[r].state == 'loaded' ) {
348 if ( filter( ['ready'], registry[r].dependencies ).compare( registry[r].dependencies ) ) {
349 execute( r );
350 }
351 }
352 }
353 } catch ( e ) {
354 mediaWiki.log( 'Exception thrown by ' + module + ': ' + e.message );
355 mediaWiki.log( e );
356 registry[module].state = 'error';
357 // Run error callbacks of jobs affected by this condition
358 for ( var j = 0; j < jobs.length; j++ ) {
359 if ( jobs[j].dependencies.indexOf( module ) !== -1 ) {
360 if ( typeof jobs[j].error === 'function' ) {
361 jobs[j].error();
362 }
363 jobs.splice( j, 1 );
364 j--;
365 }
366 }
367 }
368 }
369 /**
370 * Adds a dependencies to the queue with optional callbacks to be run when the dependencies are ready or fail
371 *
372 * @param mixed string moulde name or array of string module names
373 * @param function ready callback to execute when all dependencies are ready
374 * @param function error callback to execute when any dependency fails
375 */
376 function request( dependencies, ready, error ) {
377 // Allow calling by single module name
378 if ( typeof dependencies === 'string' ) {
379 dependencies = [dependencies];
380 if ( dependencies[0] in registry ) {
381 for ( var n = 0; n < registry[dependencies[0]].dependencies.length; n++ ) {
382 dependencies[dependencies.length] = registry[dependencies[0]].dependencies[n];
383 }
384 }
385 }
386 // Add ready and error callbacks if they were given
387 if ( arguments.length > 1 ) {
388 jobs[jobs.length] = {
389 'dependencies': filter( ['undefined', 'registered', 'loading', 'loaded'], dependencies ),
390 'ready': ready,
391 'error': error
392 };
393 }
394 // Queue up any dependencies that are undefined or registered
395 dependencies = filter( ['undefined', 'registered'], dependencies );
396 for ( var n = 0; n < dependencies.length; n++ ) {
397 if ( queue.indexOf( dependencies[n] ) === -1 ) {
398 queue[queue.length] = dependencies[n];
399 }
400 }
401 // Work the queue
402 that.work();
403 }
404
405 /* Public Methods */
406
407 /**
408 * Requests dependencies from server, loading and executing when things when ready.
409 */
410 this.work = function() {
411 // Appends a list of modules to the batch
412 for ( var q = 0; q < queue.length; q++ ) {
413 // Only request modules which are undefined or registered
414 if ( !( queue[q] in registry ) || registry[queue[q]].state == 'registered' ) {
415 // Prevent duplicate entries
416 if ( batch.indexOf( queue[q] ) === -1 ) {
417 batch[batch.length] = queue[q];
418 // Mark registered modules as loading
419 if ( queue[q] in registry ) {
420 registry[queue[q]].state = 'loading';
421 }
422 }
423 }
424 }
425 // Clean up the queue
426 queue = [];
427 // After document ready, handle the batch
428 if ( !suspended && batch.length ) {
429 // Always order modules alphabetically to help reduce cache misses for otherwise identical content
430 batch.sort();
431 // Build a list of request parameters
432 var base = {
433 'skin': mediaWiki.config.get( 'skin' ),
434 'lang': mediaWiki.config.get( 'wgUserLanguage' ),
435 'debug': mediaWiki.config.get( 'debug' )
436 };
437 // Extend request parameters with a list of modules in the batch
438 var requests = [];
439 if ( base.debug == '1' ) {
440 for ( var b = 0; b < batch.length; b++ ) {
441 requests[requests.length] = $.extend(
442 { 'modules': batch[b], 'version': registry[batch[b]].version }, base
443 );
444 }
445 } else {
446 // Calculate the highest timestamp
447 var version = 0;
448 for ( var b = 0; b < batch.length; b++ ) {
449 if ( registry[batch[b]].version > version ) {
450 version = registry[batch[b]].version;
451 }
452 }
453 requests[requests.length] = $.extend(
454 { 'modules': batch.join( '|' ), 'version': formatVersionNumber( version ) }, base
455 );
456 }
457 // Clear the batch - this MUST happen before we append the script element to the body or it's
458 // possible that the script will be locally cached, instantly load, and work the batch again,
459 // all before we've cleared it causing each request to include modules which are already loaded
460 batch = [];
461 // Asynchronously append a script tag to the end of the body
462 function request() {
463 var html = '';
464 for ( var r = 0; r < requests.length; r++ ) {
465 // Build out the HTML
466 var src = mediaWiki.config.get( 'server' ) + '/load.php?' + $.param( requests[r] );
467 html += '<script type="text/javascript" src="' + src + '"></script>';
468 }
469 return html;
470 }
471 // Load asynchronously after doumument ready
472 if ( ready ) {
473 setTimeout( function() { $( 'body' ).append( request() ); }, 0 )
474 } else {
475 document.write( request() );
476 }
477 }
478 };
479 /**
480 * Registers a module, letting the system know about it and it's dependencies. loader.js files contain calls
481 * to this function.
482 */
483 this.register = function( module, version, dependencies, status ) {
484 // Allow multiple registration
485 if ( typeof module === 'object' ) {
486 for ( var m = 0; m < module.length; m++ ) {
487 if ( typeof module[m] === 'string' ) {
488 that.register( module[m] );
489 } else if ( typeof module[m] === 'object' ) {
490 that.register.apply( that, module[m] );
491 }
492 }
493 return;
494 }
495 // Validate input
496 if ( typeof module !== 'string' ) {
497 throw new Error( 'module must be a string, not a ' + typeof module );
498 }
499 if ( typeof registry[module] !== 'undefined' && typeof status === 'undefined' ) {
500 throw new Error( 'module already implemeneted: ' + module );
501 }
502 // List the module as registered
503 registry[module] = {
504 'state': typeof status === 'string' ? status : 'registered',
505 'dependencies': [],
506 'version': typeof version !== 'undefined' ? parseInt( version ) : 0
507 };
508 if ( typeof dependencies === 'string' ) {
509 // Allow dependencies to be given as a single module name
510 registry[module].dependencies = [dependencies];
511 } else if ( typeof dependencies === 'object' || typeof dependencies === 'function' ) {
512 // Allow dependencies to be given as an array of module names or a function which returns an array
513 registry[module].dependencies = dependencies;
514 }
515 };
516 /**
517 * Implements a module, giving the system a course of action to take upon loading. Results of a request for
518 * one or more modules contain calls to this function.
519 */
520 this.implement = function( module, script, style, localization ) {
521 // Automaically register module
522 if ( typeof registry[module] === 'undefined' ) {
523 that.register( module );
524 }
525 // Validate input
526 if ( typeof script !== 'function' ) {
527 throw new Error( 'script must be a function, not a ' + typeof script );
528 }
529 if ( typeof style !== 'undefined' && typeof style !== 'string' ) {
530 throw new Error( 'style must be a string, not a ' + typeof style );
531 }
532 if ( typeof localization !== 'undefined' && typeof localization !== 'object' ) {
533 throw new Error( 'localization must be an object, not a ' + typeof localization );
534 }
535 if ( typeof registry[module] !== 'undefined' && typeof registry[module].script !== 'undefined' ) {
536 throw new Error( 'module already implemeneted: ' + module );
537 }
538 // Mark module as loaded
539 registry[module].state = 'loaded';
540 // Attach components
541 registry[module].script = script;
542 if ( typeof style === 'string' ) {
543 registry[module].style = style;
544 }
545 if ( typeof localization === 'object' ) {
546 registry[module].messages = localization;
547 }
548 // Execute or queue callback
549 if ( filter( ['ready'], registry[module].dependencies ).compare( registry[module].dependencies ) ) {
550 execute( module );
551 } else {
552 request( module );
553 }
554 };
555 /**
556 * Executes a function as soon as one or more required modules are ready
557 *
558 * @param mixed string or array of strings of modules names the callback dependencies to be ready before
559 * executing
560 * @param function callback to execute when all dependencies are ready (optional)
561 * @param function callback to execute when if dependencies have a errors (optional)
562 */
563 this.using = function( dependencies, ready, error ) {
564 // Validate input
565 if ( typeof dependencies !== 'object' && typeof dependencies !== 'string' ) {
566 throw new Error( 'dependencies must be a string or an array, not a ' + typeof dependencies )
567 }
568 // Allow calling with a single dependency as a string
569 if ( typeof dependencies === 'string' ) {
570 dependencies = [dependencies];
571 }
572 // Resolve entire dependency map
573 dependencies = resolve( dependencies );
574 // If all dependencies are met, execute ready immediately
575 if ( filter( ['ready'], dependencies ).compare( dependencies ) ) {
576 if ( typeof ready !== 'function' ) {
577 ready();
578 }
579 }
580 // If any dependencies have errors execute error immediately
581 else if ( filter( ['error'], dependencies ).length ) {
582 if ( typeof error === 'function' ) {
583 error();
584 }
585 }
586 // Since some dependencies are not yet ready, queue up a request
587 else {
588 request( dependencies, ready, error );
589 }
590 };
591 /**
592 * Loads one or more modules for future use
593 */
594 this.load = function( modules ) {
595 // Validate input
596 if ( typeof modules !== 'object' && typeof modules !== 'string' ) {
597 throw new Error( 'dependencies must be a string or an array, not a ' + typeof dependencies )
598 }
599 // Allow calling with a single dependency as a string
600 if ( typeof modules === 'string' ) {
601 modules = [modules];
602 }
603 // Resolve entire dependency map
604 modules = resolve( modules );
605 // If all modules are ready, nothing dependency be done
606 if ( filter( ['ready'], modules ).compare( modules ) ) {
607 return true;
608 }
609 // If any modules have errors return false
610 else if ( filter( ['error'], modules ).length ) {
611 return false;
612 }
613 // Since some modules are not yet ready, queue up a request
614 else {
615 request( modules );
616 return true;
617 }
618 };
619 /**
620 * Flushes the request queue and begin executing load requests on demand
621 */
622 this.go = function() {
623 suspended = false;
624 that.work();
625 };
626 /**
627 * Changes the state of a module
628 *
629 * @param mixed module string module name or object of module name/state pairs
630 * @param string state string state name
631 */
632 this.state = function( module, state ) {
633 if ( typeof module === 'object' ) {
634 for ( var m in module ) {
635 that.state( m, module[m] );
636 }
637 return;
638 }
639 if ( module in registry ) {
640 registry[module].state = state;
641 }
642 };
643
644 /* Cache document ready status */
645
646 $(document).ready( function() { ready = true; } );
647 } )();
648
649 /* Extension points */
650
651 this.util = {};
652 this.legacy = {};
653
654 } )( jQuery );
655
656
657 /* Auto-register from pre-loaded startup scripts */
658
659 if ( typeof window['startUp'] === 'function' ) {
660 window['startUp']();
661 delete window['startUp'];
662 }