X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/19e297c21b10b1b8a3acad5e73fc71dcb35db44a..6932310fd58ebef145fa01eb76edf7150284d8ea:/resources/src/mediawiki/api/messages.js

diff --git a/resources/src/mediawiki/api/messages.js b/resources/src/mediawiki/api/messages.js
new file mode 100644
index 00000000..a1a49996
--- /dev/null
+++ b/resources/src/mediawiki/api/messages.js
@@ -0,0 +1,78 @@
+/**
+ * Allows to retrieve a specific or a set of
+ * messages to be added to mw.messages and returned
+ * by the Api.
+ *
+ * @class mw.Api.plugin.messages
+ * @since 1.27
+ */
+( function ( mw, $ ) {
+	'use strict';
+
+	$.extend( mw.Api.prototype, {
+		/**
+		 * Get a set of messages.
+		 *
+		 * @param {Array} messages Messages to retrieve
+		 * @param {Object} [options] Additional parameters for the API call
+		 * @return {jQuery.Promise}
+		 */
+		getMessages: function ( messages, options ) {
+			options = options || {};
+			return this.get( $.extend( {
+				action: 'query',
+				meta: 'allmessages',
+				ammessages: messages,
+				amlang: mw.config.get( 'wgUserLanguage' ),
+				formatversion: 2
+			}, options ) ).then( function ( data ) {
+				var result = {};
+
+				$.each( data.query.allmessages, function ( i, obj ) {
+					if ( !obj.missing ) {
+						result[ obj.name ] = obj.content;
+					}
+				} );
+
+				return result;
+			} );
+		},
+
+		/**
+		 * Loads a set of messages and add them to mw.messages.
+		 *
+		 * @param {Array} messages Messages to retrieve
+		 * @param {Object} [options] Additional parameters for the API call
+		 * @return {jQuery.Promise}
+		 */
+		loadMessages: function ( messages, options ) {
+			return this.getMessages( messages, options ).then( $.proxy( mw.messages, 'set' ) );
+		},
+
+		/**
+		 * Loads a set of messages and add them to mw.messages. Only messages that are not already known
+		 * are loaded. If all messages are known, the returned promise is resolved immediately.
+		 *
+		 * @param {Array} messages Messages to retrieve
+		 * @param {Object} [options] Additional parameters for the API call
+		 * @return {jQuery.Promise}
+		 */
+		loadMessagesIfMissing: function ( messages, options ) {
+			var missing = messages.filter( function ( msg ) {
+				return !mw.message( msg ).exists();
+			} );
+
+			if ( missing.length === 0 ) {
+				return $.Deferred().resolve();
+			}
+
+			return this.getMessages( missing, options ).then( $.proxy( mw.messages, 'set' ) );
+		}
+	} );
+
+	/**
+	 * @class mw.Api
+	 * @mixins mw.Api.plugin.messages
+	 */
+
+}( mediaWiki, jQuery ) );