2 * This file is currently loaded as part of the 'mediawiki' module and therefore
3 * concatenated to mediawiki.js and executed at the same time. This file exists
4 * to help prepare for splitting up the 'mediawiki' module.
5 * This effort is tracked at https://phabricator.wikimedia.org/T192623
9 * - mediawiki.js will be reduced to the minimum needed to define mw.loader and
10 * mw.config, and then moved to its own private "mediawiki.loader" module that
11 * can be embedded within the StartupModule response.
13 * - mediawiki.base.js and other files in this directory will remain part of the
14 * "mediawiki" module, and will remain a default/implicit dependency for all
15 * regular modules, just like jquery and wikibits already are.
20 var slice
= Array
.prototype.slice
,
21 mwLoaderTrack
= mw
.track
,
22 trackCallbacks
= $.Callbacks( 'memory' ),
27 * Object constructor for messages.
29 * Similar to the Message class in MediaWiki PHP.
31 * Format defaults to 'text'.
37 * 'hello': 'Hello world',
38 * 'hello-user': 'Hello, $1!',
39 * 'welcome-user': 'Welcome back to $2, $1! Last visit by $1: $3'
42 * obj = new mw.Message( mw.messages, 'hello' );
43 * mw.log( obj.text() );
46 * obj = new mw.Message( mw.messages, 'hello-user', [ 'John Doe' ] );
47 * mw.log( obj.text() );
50 * obj = new mw.Message( mw.messages, 'welcome-user', [ 'John Doe', 'Wikipedia', '2 hours ago' ] );
51 * mw.log( obj.text() );
52 * // Welcome back to Wikipedia, John Doe! Last visit by John Doe: 2 hours ago
54 * // Using mw.message shortcut
55 * obj = mw.message( 'hello-user', 'John Doe' );
56 * mw.log( obj.text() );
59 * // Using mw.msg shortcut
60 * str = mw.msg( 'hello-user', 'John Doe' );
64 * // Different formats
65 * obj = new mw.Message( mw.messages, 'hello-user', [ 'John "Wiki" <3 Doe' ] );
67 * obj.format = 'text';
68 * str = obj.toString();
73 * // Hello, John "Wiki" <3 Doe!
75 * mw.log( obj.escaped() );
76 * // Hello, John "Wiki" <3 Doe!
81 * @param {mw.Map} map Message store
83 * @param {Array} [parameters]
85 function Message( map
, key
, parameters
) {
89 this.parameters
= parameters
=== undefined ? [] : slice
.call( parameters
);
95 * Get parsed contents of the message.
97 * The default parser does simple $N replacements and nothing else.
98 * This may be overridden to provide a more complex message parser.
99 * The primary override is in the mediawiki.jqueryMsg module.
101 * This function will not be called for nonexistent messages.
103 * @return {string} Parsed message
105 parser: function () {
106 var text
= this.map
.get( this.key
);
108 mw
.config
.get( 'wgUserLanguage' ) === 'qqx' &&
109 ( !text
|| text
=== '(' + this.key
+ ')' )
111 text
= '(' + this.key
+ '$*)';
113 return mw
.format
.apply( null, [ text
].concat( this.parameters
) );
117 * Add (does not replace) parameters for `$N` placeholder values.
119 * @param {Array} parameters
120 * @return {mw.Message}
123 params: function ( parameters
) {
125 for ( i
= 0; i
< parameters
.length
; i
++ ) {
126 this.parameters
.push( parameters
[ i
] );
132 * Convert message object to its string form based on current format.
134 * @return {string} Message as a string in the current form, or `<key>` if key
137 toString: function () {
140 if ( !this.exists() ) {
141 // Use ⧼key⧽ as text if key does not exist
142 // Err on the side of safety, ensure that the output
143 // is always html safe in the event the message key is
144 // missing, since in that case its highly likely the
145 // message key is user-controlled.
146 // '⧼' is used instead of '<' to side-step any
147 // double-escaping issues.
148 // (Keep synchronised with Message::toString() in PHP.)
149 return '⧼' + mw
.html
.escape( this.key
) + '⧽';
152 if ( this.format
=== 'plain' || this.format
=== 'text' || this.format
=== 'parse' ) {
153 text
= this.parser();
156 if ( this.format
=== 'escaped' ) {
157 text
= this.parser();
158 text
= mw
.html
.escape( text
);
165 * Change format to 'parse' and convert message to string
167 * If jqueryMsg is loaded, this parses the message text from wikitext
168 * (where supported) to HTML
170 * Otherwise, it is equivalent to plain.
172 * @return {string} String form of parsed message
175 this.format
= 'parse';
176 return this.toString();
180 * Change format to 'plain' and convert message to string
182 * This substitutes parameters, but otherwise does not change the
185 * @return {string} String form of plain message
188 this.format
= 'plain';
189 return this.toString();
193 * Change format to 'text' and convert message to string
195 * If jqueryMsg is loaded, {{-transformation is done where supported
196 * (such as {{plural:}}, {{gender:}}, {{int:}}).
198 * Otherwise, it is equivalent to plain
200 * @return {string} String form of text message
203 this.format
= 'text';
204 return this.toString();
208 * Change the format to 'escaped' and convert message to string
210 * This is equivalent to using the 'text' format (see #text), then
211 * HTML-escaping the output.
213 * @return {string} String form of html escaped message
215 escaped: function () {
216 this.format
= 'escaped';
217 return this.toString();
221 * Check if a message exists
226 exists: function () {
227 if ( mw
.config
.get( 'wgUserLanguage' ) === 'qqx' ) {
230 return this.map
.exists( this.key
);
240 * @inheritdoc mw.inspect#runReports
243 mw
.inspect = function () {
244 var args
= arguments
;
246 mw
.loader
.using( 'mediawiki.inspect', function () {
247 mw
.inspect
.runReports
.apply( mw
.inspect
, args
);
252 * Replace $* with a list of parameters for &uselang=qqx.
256 * @param {string} formatString Format string
257 * @param {Array} parameters Values for $N replacements
258 * @return {string} Transformed format string
260 mw
.internalDoTransformFormatForQqx = function ( formatString
, parameters
) {
261 var parametersString
;
262 if ( formatString
.indexOf( '$*' ) !== -1 ) {
263 parametersString
= '';
264 if ( parameters
.length
) {
265 parametersString
= ': ' + parameters
.map( function ( _
, i
) {
266 return '$' + ( i
+ 1 );
269 return formatString
.replace( '$*', parametersString
);
275 * Format a string. Replace $1, $2 ... $N with positional arguments.
277 * Used by Message#parser().
280 * @param {string} formatString Format string
281 * @param {...Mixed} parameters Values for $N replacements
282 * @return {string} Formatted string
284 mw
.format = function ( formatString
) {
285 var parameters
= slice
.call( arguments
, 1 );
286 formatString
= mw
.internalDoTransformFormatForQqx( formatString
, parameters
);
287 return formatString
.replace( /\$(\d+)/g, function ( str
, match
) {
288 var index
= parseInt( match
, 10 ) - 1;
289 return parameters
[ index
] !== undefined ? parameters
[ index
] : '$' + match
;
293 // Expose Message constructor
294 mw
.Message
= Message
;
297 * Get a message object.
299 * Shortcut for `new mw.Message( mw.messages, key, parameters )`.
302 * @param {string} key Key of message to get
303 * @param {...Mixed} parameters Values for $N replacements
304 * @return {mw.Message}
306 mw
.message = function ( key
) {
307 var parameters
= slice
.call( arguments
, 1 );
308 return new Message( mw
.messages
, key
, parameters
);
312 * Get a message string using the (default) 'text' format.
314 * Shortcut for `mw.message( key, parameters... ).text()`.
317 * @param {string} key Key of message to get
318 * @param {...Mixed} parameters Values for $N replacements
321 mw
.msg = function () {
322 return mw
.message
.apply( mw
.message
, arguments
).toString();
326 * Track an analytic event.
328 * This method provides a generic means for MediaWiki JavaScript code to capture state
329 * information for analysis. Each logged event specifies a string topic name that describes
330 * the kind of event that it is. Topic names consist of dot-separated path components,
331 * arranged from most general to most specific. Each path component should have a clear and
332 * well-defined purpose.
334 * Data handlers are registered via `mw.trackSubscribe`, and receive the full set of
335 * events that match their subcription, including those that fired before the handler was
338 * @param {string} topic Topic name
339 * @param {Object} [data] Data describing the event, encoded as an object
341 mw
.track = function ( topic
, data
) {
342 mwLoaderTrack( topic
, data
);
343 trackCallbacks
.fire( mw
.trackQueue
);
347 * Register a handler for subset of analytic events, specified by topic.
349 * Handlers will be called once for each tracked event, including any events that fired before the
350 * handler was registered; 'this' is set to a plain object with a 'timeStamp' property indicating
351 * the exact time at which the event fired, a string 'topic' property naming the event, and a
352 * 'data' property which is an object of event-specific data. The event topic and event data are
353 * also passed to the callback as the first and second arguments, respectively.
355 * @param {string} topic Handle events whose name starts with this string prefix
356 * @param {Function} callback Handler to call for each matching tracked event
357 * @param {string} callback.topic
358 * @param {Object} [callback.data]
360 mw
.trackSubscribe = function ( topic
, callback
) {
362 function handler( trackQueue
) {
364 for ( ; seen
< trackQueue
.length
; seen
++ ) {
365 event
= trackQueue
[ seen
];
366 if ( event
.topic
.indexOf( topic
) === 0 ) {
367 callback
.call( event
, event
.topic
, event
.data
);
372 trackHandlers
.push( [ handler
, callback
] );
374 trackCallbacks
.add( handler
);
378 * Stop handling events for a particular handler
380 * @param {Function} callback
382 mw
.trackUnsubscribe = function ( callback
) {
383 trackHandlers
= trackHandlers
.filter( function ( fns
) {
384 if ( fns
[ 1 ] === callback
) {
385 trackCallbacks
.remove( fns
[ 0 ] );
386 // Ensure the tuple is removed to avoid holding on to closures
393 // Fire events from before track() triggered fire()
394 trackCallbacks
.fire( mw
.trackQueue
);
397 * Registry and firing of events.
399 * MediaWiki has various interface components that are extended, enhanced
400 * or manipulated in some other way by extensions, gadgets and even
403 * This framework helps streamlining the timing of when these other
404 * code paths fire their plugins (instead of using document-ready,
405 * which can and should be limited to firing only once).
407 * Features like navigating to other wiki pages, previewing an edit
408 * and editing itself – without a refresh – can then retrigger these
409 * hooks accordingly to ensure everything still works as expected.
413 * mw.hook( 'wikipage.content' ).add( fn ).remove( fn );
414 * mw.hook( 'wikipage.content' ).fire( $content );
416 * Handlers can be added and fired for arbitrary event names at any time. The same
417 * event can be fired multiple times. The last run of an event is memorized
418 * (similar to `$(document).ready` and `$.Deferred().done`).
419 * This means if an event is fired, and a handler added afterwards, the added
420 * function will be fired right away with the last given event data.
422 * Like Deferreds and Promises, the mw.hook object is both detachable and chainable.
423 * Thus allowing flexible use and optimal maintainability and authority control.
424 * You can pass around the `add` and/or `fire` method to another piece of code
425 * without it having to know the event name (or `mw.hook` for that matter).
427 * var h = mw.hook( 'bar.ready' );
428 * new mw.Foo( .. ).fetch( { callback: h.fire } );
430 * Note: Events are documented with an underscore instead of a dot in the event
431 * name due to jsduck not supporting dots in that position.
435 mw
.hook
= ( function () {
436 var lists
= Object
.create( null );
439 * Create an instance of mw.hook.
443 * @param {string} name Name of hook.
446 return function ( name
) {
447 var list
= lists
[ name
] || ( lists
[ name
] = $.Callbacks( 'memory' ) );
451 * Register a hook handler
453 * @param {...Function} handler Function to bind.
459 * Unregister a hook handler
461 * @param {...Function} handler Function to unbind.
469 * @param {...Mixed} data
474 return list
.fireWith
.call( this, null, slice
.call( arguments
) );
481 * HTML construction helper functions
488 * output = Html.element( 'div', {}, new Html.Raw(
489 * Html.element( 'img', { src: '<' } )
491 * mw.log( output ); // <div><img src="<"/></div>
496 mw
.html
= ( function () {
497 function escapeCallback( s
) {
514 * Escape a string for HTML.
516 * Converts special characters to HTML entities.
518 * mw.html.escape( '< > \' & "' );
519 * // Returns < > ' & "
521 * @param {string} s The string to escape
522 * @return {string} HTML
524 escape: function ( s
) {
525 return s
.replace( /['"<>&]/g, escapeCallback
);
529 * Create an HTML element string, with safe escaping.
531 * @param {string} name The tag name.
532 * @param {Object} [attrs] An object with members mapping element names to values
533 * @param {string|mw.html.Raw|mw.html.Cdata|null} [contents=null] The contents of the element.
535 * - string: Text to be escaped.
536 * - null: The element is treated as void with short closing form, e.g. `<br/>`.
537 * - this.Raw: The raw value is directly included.
538 * - this.Cdata: The raw value is directly included. An exception is
539 * thrown if it contains any illegal ETAGO delimiter.
540 * See <https://www.w3.org/TR/html401/appendix/notes.html#h-B.3.2>.
541 * @return {string} HTML
543 element: function ( name
, attrs
, contents
) {
544 var v
, attrName
, s
= '<' + name
;
547 for ( attrName
in attrs
) {
548 v
= attrs
[ attrName
];
549 // Convert name=true, to name=name
553 } else if ( v
=== false ) {
556 s
+= ' ' + attrName
+ '="' + this.escape( String( v
) ) + '"';
559 if ( contents
=== undefined || contents
=== null ) {
566 switch ( typeof contents
) {
569 s
+= this.escape( contents
);
574 s
+= String( contents
);
577 if ( contents
instanceof this.Raw
) {
578 // Raw HTML inclusion
580 } else if ( contents
instanceof this.Cdata
) {
582 if ( /<\/[a-zA-z]/.test( contents
.value
) ) {
583 throw new Error( 'Illegal end tag found in CDATA' );
587 throw new Error( 'Invalid type of contents' );
590 s
+= '</' + name
+ '>';
595 * Wrapper object for raw HTML passed to mw.html.element().
599 * @param {string} value
601 Raw: function ( value
) {
606 * Wrapper object for CDATA element contents passed to mw.html.element()
608 * @class mw.html.Cdata
610 * @param {string} value
612 Cdata: function ( value
) {
619 * Execute a function as soon as one or more required modules are ready.
621 * Example of inline dependency on OOjs:
623 * mw.loader.using( 'oojs', function () {
624 * OO.compare( [ 1 ], [ 1 ] );
627 * Example of inline dependency obtained via `require()`:
629 * mw.loader.using( [ 'mediawiki.util' ], function ( require ) {
630 * var util = require( 'mediawiki.util' );
633 * Since MediaWiki 1.23 this also returns a promise.
635 * Since MediaWiki 1.28 the promise is resolved with a `require` function.
638 * @param {string|Array} dependencies Module name or array of modules names the
639 * callback depends on to be ready before executing
640 * @param {Function} [ready] Callback to execute when all dependencies are ready
641 * @param {Function} [error] Callback to execute if one or more dependencies failed
642 * @return {jQuery.Promise} With a `require` function
644 mw
.loader
.using = function ( dependencies
, ready
, error
) {
645 var deferred
= $.Deferred();
647 // Allow calling with a single dependency as a string
648 if ( !Array
.isArray( dependencies
) ) {
649 dependencies
= [ dependencies
];
653 deferred
.done( ready
);
656 deferred
.fail( error
);
660 // Resolve entire dependency map
661 dependencies
= mw
.loader
.resolve( dependencies
);
663 return deferred
.reject( e
).promise();
668 function () { deferred
.resolve( mw
.loader
.require
); },
672 return deferred
.promise();
676 * Load a script by URL.
680 * mw.loader.getScript(
681 * 'https://example.org/x-1.0.0.js'
683 * .then( function () {
684 * // Script succeeded. You can use X now.
685 * }, function ( e ) {
686 * // Script failed. X is not avaiable
687 * mw.log.error( e.message ); // => "Failed to load script"
692 * @param {string} url Script URL
693 * @return {jQuery.Promise} Resolved when the script is loaded
695 mw
.loader
.getScript = function ( url
) {
696 return $.ajax( url
, { dataType
: 'script', cache
: true } )
697 .catch( function () {
698 throw new Error( 'Failed to load script' );
702 // Alias $j to jQuery for backwards compatibility
703 // @deprecated since 1.23 Use $ or jQuery instead
704 mw
.log
.deprecate( window
, '$j', $, 'Use $ or jQuery instead.' );
706 // Process callbacks for Grade A that require modules.
708 // Replace temporary RLQ implementation from startup.js with the
709 // final implementation that also processes callbacks that can
710 // require modules. It must also support late arrivals of
711 // plain callbacks. (T208093)
713 push: function ( entry
) {
714 if ( typeof entry
=== 'function' ) {
717 mw
.loader
.using( entry
[ 0 ], entry
[ 1 ] );
721 while ( queue
[ 0 ] ) {
722 window
.RLQ
.push( queue
.shift() );