ed24af3065fe30494da71f8d15313f1a8172780d
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.
21 var slice
= Array
.prototype.slice
,
22 mwLoaderTrack
= mw
.track
,
23 trackCallbacks
= $.Callbacks( 'memory' ),
25 hasOwn
= Object
.prototype.hasOwnProperty
;
28 * Object constructor for messages.
30 * Similar to the Message class in MediaWiki PHP.
32 * Format defaults to 'text'.
38 * 'hello': 'Hello world',
39 * 'hello-user': 'Hello, $1!',
40 * 'welcome-user': 'Welcome back to $2, $1! Last visit by $1: $3'
43 * obj = new mw.Message( mw.messages, 'hello' );
44 * mw.log( obj.text() );
47 * obj = new mw.Message( mw.messages, 'hello-user', [ 'John Doe' ] );
48 * mw.log( obj.text() );
51 * obj = new mw.Message( mw.messages, 'welcome-user', [ 'John Doe', 'Wikipedia', '2 hours ago' ] );
52 * mw.log( obj.text() );
53 * // Welcome back to Wikipedia, John Doe! Last visit by John Doe: 2 hours ago
55 * // Using mw.message shortcut
56 * obj = mw.message( 'hello-user', 'John Doe' );
57 * mw.log( obj.text() );
60 * // Using mw.msg shortcut
61 * str = mw.msg( 'hello-user', 'John Doe' );
65 * // Different formats
66 * obj = new mw.Message( mw.messages, 'hello-user', [ 'John "Wiki" <3 Doe' ] );
68 * obj.format = 'text';
69 * str = obj.toString();
74 * // Hello, John "Wiki" <3 Doe!
76 * mw.log( obj.escaped() );
77 * // Hello, John "Wiki" <3 Doe!
82 * @param {mw.Map} map Message store
84 * @param {Array} [parameters]
86 function Message( map
, key
, parameters
) {
90 this.parameters
= parameters
=== undefined ? [] : slice
.call( parameters
);
96 * Get parsed contents of the message.
98 * The default parser does simple $N replacements and nothing else.
99 * This may be overridden to provide a more complex message parser.
100 * The primary override is in the mediawiki.jqueryMsg module.
102 * This function will not be called for nonexistent messages.
104 * @return {string} Parsed message
106 parser: function () {
107 return mw
.format
.apply( null, [ this.map
.get( this.key
) ].concat( this.parameters
) );
111 * Add (does not replace) parameters for `$N` placeholder values.
113 * @param {Array} parameters
114 * @return {mw.Message}
117 params: function ( parameters
) {
119 for ( i
= 0; i
< parameters
.length
; i
++ ) {
120 this.parameters
.push( parameters
[ i
] );
126 * Convert message object to its string form based on current format.
128 * @return {string} Message as a string in the current form, or `<key>` if key
131 toString: function () {
134 if ( !this.exists() ) {
135 // Use ⧼key⧽ as text if key does not exist
136 // Err on the side of safety, ensure that the output
137 // is always html safe in the event the message key is
138 // missing, since in that case its highly likely the
139 // message key is user-controlled.
140 // '⧼' is used instead of '<' to side-step any
141 // double-escaping issues.
142 // (Keep synchronised with Message::toString() in PHP.)
143 return '⧼' + mw
.html
.escape( this.key
) + '⧽';
146 if ( this.format
=== 'plain' || this.format
=== 'text' || this.format
=== 'parse' ) {
147 text
= this.parser();
150 if ( this.format
=== 'escaped' ) {
151 text
= this.parser();
152 text
= mw
.html
.escape( text
);
159 * Change format to 'parse' and convert message to string
161 * If jqueryMsg is loaded, this parses the message text from wikitext
162 * (where supported) to HTML
164 * Otherwise, it is equivalent to plain.
166 * @return {string} String form of parsed message
169 this.format
= 'parse';
170 return this.toString();
174 * Change format to 'plain' and convert message to string
176 * This substitutes parameters, but otherwise does not change the
179 * @return {string} String form of plain message
182 this.format
= 'plain';
183 return this.toString();
187 * Change format to 'text' and convert message to string
189 * If jqueryMsg is loaded, {{-transformation is done where supported
190 * (such as {{plural:}}, {{gender:}}, {{int:}}).
192 * Otherwise, it is equivalent to plain
194 * @return {string} String form of text message
197 this.format
= 'text';
198 return this.toString();
202 * Change the format to 'escaped' and convert message to string
204 * This is equivalent to using the 'text' format (see #text), then
205 * HTML-escaping the output.
207 * @return {string} String form of html escaped message
209 escaped: function () {
210 this.format
= 'escaped';
211 return this.toString();
215 * Check if a message exists
220 exists: function () {
221 return this.map
.exists( this.key
);
231 * @inheritdoc mw.inspect#runReports
234 mw
.inspect = function () {
235 var args
= arguments
;
236 mw
.loader
.using( 'mediawiki.inspect', function () {
237 mw
.inspect
.runReports
.apply( mw
.inspect
, args
);
242 * Format a string. Replace $1, $2 ... $N with positional arguments.
244 * Used by Message#parser().
247 * @param {string} formatString Format string
248 * @param {...Mixed} parameters Values for $N replacements
249 * @return {string} Formatted string
251 mw
.format = function ( formatString
) {
252 var parameters
= slice
.call( arguments
, 1 );
253 return formatString
.replace( /\$(\d+)/g, function ( str
, match
) {
254 var index
= parseInt( match
, 10 ) - 1;
255 return parameters
[ index
] !== undefined ? parameters
[ index
] : '$' + match
;
259 // Expose Message constructor
260 mw
.Message
= Message
;
263 * Get a message object.
265 * Shortcut for `new mw.Message( mw.messages, key, parameters )`.
268 * @param {string} key Key of message to get
269 * @param {...Mixed} parameters Values for $N replacements
270 * @return {mw.Message}
272 mw
.message = function ( key
) {
273 var parameters
= slice
.call( arguments
, 1 );
274 return new Message( mw
.messages
, key
, parameters
);
278 * Get a message string using the (default) 'text' format.
280 * Shortcut for `mw.message( key, parameters... ).text()`.
283 * @param {string} key Key of message to get
284 * @param {...Mixed} parameters Values for $N replacements
287 mw
.msg = function () {
288 return mw
.message
.apply( mw
.message
, arguments
).toString();
292 * Track an analytic event.
294 * This method provides a generic means for MediaWiki JavaScript code to capture state
295 * information for analysis. Each logged event specifies a string topic name that describes
296 * the kind of event that it is. Topic names consist of dot-separated path components,
297 * arranged from most general to most specific. Each path component should have a clear and
298 * well-defined purpose.
300 * Data handlers are registered via `mw.trackSubscribe`, and receive the full set of
301 * events that match their subcription, including those that fired before the handler was
304 * @param {string} topic Topic name
305 * @param {Object} [data] Data describing the event, encoded as an object
307 mw
.track = function ( topic
, data
) {
308 mwLoaderTrack( topic
, data
);
309 trackCallbacks
.fire( mw
.trackQueue
);
313 * Register a handler for subset of analytic events, specified by topic.
315 * Handlers will be called once for each tracked event, including any events that fired before the
316 * handler was registered; 'this' is set to a plain object with a 'timeStamp' property indicating
317 * the exact time at which the event fired, a string 'topic' property naming the event, and a
318 * 'data' property which is an object of event-specific data. The event topic and event data are
319 * also passed to the callback as the first and second arguments, respectively.
321 * @param {string} topic Handle events whose name starts with this string prefix
322 * @param {Function} callback Handler to call for each matching tracked event
323 * @param {string} callback.topic
324 * @param {Object} [callback.data]
326 mw
.trackSubscribe = function ( topic
, callback
) {
328 function handler( trackQueue
) {
330 for ( ; seen
< trackQueue
.length
; seen
++ ) {
331 event
= trackQueue
[ seen
];
332 if ( event
.topic
.indexOf( topic
) === 0 ) {
333 callback
.call( event
, event
.topic
, event
.data
);
338 trackHandlers
.push( [ handler
, callback
] );
340 trackCallbacks
.add( handler
);
344 * Stop handling events for a particular handler
346 * @param {Function} callback
348 mw
.trackUnsubscribe = function ( callback
) {
349 trackHandlers
= trackHandlers
.filter( function ( fns
) {
350 if ( fns
[ 1 ] === callback
) {
351 trackCallbacks
.remove( fns
[ 0 ] );
352 // Ensure the tuple is removed to avoid holding on to closures
359 // Fire events from before track() triggred fire()
360 trackCallbacks
.fire( mw
.trackQueue
);
363 * Registry and firing of events.
365 * MediaWiki has various interface components that are extended, enhanced
366 * or manipulated in some other way by extensions, gadgets and even
369 * This framework helps streamlining the timing of when these other
370 * code paths fire their plugins (instead of using document-ready,
371 * which can and should be limited to firing only once).
373 * Features like navigating to other wiki pages, previewing an edit
374 * and editing itself – without a refresh – can then retrigger these
375 * hooks accordingly to ensure everything still works as expected.
379 * mw.hook( 'wikipage.content' ).add( fn ).remove( fn );
380 * mw.hook( 'wikipage.content' ).fire( $content );
382 * Handlers can be added and fired for arbitrary event names at any time. The same
383 * event can be fired multiple times. The last run of an event is memorized
384 * (similar to `$(document).ready` and `$.Deferred().done`).
385 * This means if an event is fired, and a handler added afterwards, the added
386 * function will be fired right away with the last given event data.
388 * Like Deferreds and Promises, the mw.hook object is both detachable and chainable.
389 * Thus allowing flexible use and optimal maintainability and authority control.
390 * You can pass around the `add` and/or `fire` method to another piece of code
391 * without it having to know the event name (or `mw.hook` for that matter).
393 * var h = mw.hook( 'bar.ready' );
394 * new mw.Foo( .. ).fetch( { callback: h.fire } );
396 * Note: Events are documented with an underscore instead of a dot in the event
397 * name due to jsduck not supporting dots in that position.
401 mw
.hook
= ( function () {
405 * Create an instance of mw.hook.
409 * @param {string} name Name of hook.
412 return function ( name
) {
413 var list
= hasOwn
.call( lists
, name
) ?
415 lists
[ name
] = $.Callbacks( 'memory' );
419 * Register a hook handler
421 * @param {...Function} handler Function to bind.
427 * Unregister a hook handler
429 * @param {...Function} handler Function to unbind.
437 * @param {...Mixed} data
442 return list
.fireWith
.call( this, null, slice
.call( arguments
) );
449 * HTML construction helper functions
456 * output = Html.element( 'div', {}, new Html.Raw(
457 * Html.element( 'img', { src: '<' } )
459 * mw.log( output ); // <div><img src="<"/></div>
464 mw
.html
= ( function () {
465 function escapeCallback( s
) {
482 * Escape a string for HTML.
484 * Converts special characters to HTML entities.
486 * mw.html.escape( '< > \' & "' );
487 * // Returns < > ' & "
489 * @param {string} s The string to escape
490 * @return {string} HTML
492 escape: function ( s
) {
493 return s
.replace( /['"<>&]/g, escapeCallback
);
497 * Create an HTML element string, with safe escaping.
499 * @param {string} name The tag name.
500 * @param {Object} [attrs] An object with members mapping element names to values
501 * @param {string|mw.html.Raw|mw.html.Cdata|null} [contents=null] The contents of the element.
503 * - string: Text to be escaped.
504 * - null: The element is treated as void with short closing form, e.g. `<br/>`.
505 * - this.Raw: The raw value is directly included.
506 * - this.Cdata: The raw value is directly included. An exception is
507 * thrown if it contains any illegal ETAGO delimiter.
508 * See <https://www.w3.org/TR/html401/appendix/notes.html#h-B.3.2>.
509 * @return {string} HTML
511 element: function ( name
, attrs
, contents
) {
512 var v
, attrName
, s
= '<' + name
;
515 for ( attrName
in attrs
) {
516 v
= attrs
[ attrName
];
517 // Convert name=true, to name=name
521 } else if ( v
=== false ) {
524 s
+= ' ' + attrName
+ '="' + this.escape( String( v
) ) + '"';
527 if ( contents
=== undefined || contents
=== null ) {
534 switch ( typeof contents
) {
537 s
+= this.escape( contents
);
542 s
+= String( contents
);
545 if ( contents
instanceof this.Raw
) {
546 // Raw HTML inclusion
548 } else if ( contents
instanceof this.Cdata
) {
550 if ( /<\/[a-zA-z]/.test( contents
.value
) ) {
551 throw new Error( 'mw.html.element: Illegal end tag found in CDATA' );
555 throw new Error( 'mw.html.element: Invalid type of contents' );
558 s
+= '</' + name
+ '>';
563 * Wrapper object for raw HTML passed to mw.html.element().
567 * @param {string} value
569 Raw: function ( value
) {
574 * Wrapper object for CDATA element contents passed to mw.html.element()
576 * @class mw.html.Cdata
578 * @param {string} value
580 Cdata: function ( value
) {
587 * Execute a function as soon as one or more required modules are ready.
589 * Example of inline dependency on OOjs:
591 * mw.loader.using( 'oojs', function () {
592 * OO.compare( [ 1 ], [ 1 ] );
595 * Example of inline dependency obtained via `require()`:
597 * mw.loader.using( [ 'mediawiki.util' ], function ( require ) {
598 * var util = require( 'mediawiki.util' );
601 * Since MediaWiki 1.23 this also returns a promise.
603 * Since MediaWiki 1.28 the promise is resolved with a `require` function.
606 * @param {string|Array} dependencies Module name or array of modules names the
607 * callback depends on to be ready before executing
608 * @param {Function} [ready] Callback to execute when all dependencies are ready
609 * @param {Function} [error] Callback to execute if one or more dependencies failed
610 * @return {jQuery.Promise} With a `require` function
612 mw
.loader
.using = function ( dependencies
, ready
, error
) {
613 var deferred
= $.Deferred();
615 // Allow calling with a single dependency as a string
616 if ( typeof dependencies
=== 'string' ) {
617 dependencies
= [ dependencies
];
621 deferred
.done( ready
);
624 deferred
.fail( error
);
628 // Resolve entire dependency map
629 dependencies
= mw
.loader
.resolve( dependencies
);
631 return deferred
.reject( e
).promise();
634 mw
.loader
.enqueue( dependencies
, function () {
635 deferred
.resolve( mw
.loader
.require
);
636 }, deferred
.reject
);
638 return deferred
.promise();
641 // Alias $j to jQuery for backwards compatibility
642 // @deprecated since 1.23 Use $ or jQuery instead
643 mw
.log
.deprecate( window
, '$j', $, 'Use $ or jQuery instead.' );