summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/UploadWizard/resources/details/uw.SingleLanguageInputWidget.js
blob: 3edea4ea4c17960075a73c3595bcea4164b4d7ca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
( function ( mw, uw, $, OO ) {

	/**
	 * A single language input field in UploadWizard's "Details" step form.
	 *
	 * @extends uw.DetailsWidget
	 * @constructor
	 * @param {Object} config
	 * @param {Object} config.languages { langcode: text } map of languages
	 * @param {Object} [config.defaultLanguage]
	 * @param {boolean} [config.canBeRemoved=true]
	 * @param {mw.Message} [config.placeholder] Placeholder text for input field
	 * @param {mw.Message} [config.remove] Title text for remove icon
	 * @param {number} [config.minLength=0] Minimum input length
	 * @param {number} [config.maxLength=99999] Maximum input length
	 */
	uw.SingleLanguageInputWidget = function UWSingleLanguageInputWidget( config ) {
		this.config = $.extend( {
			placeholder: mw.message( '' ),
			remove: mw.message( '' ),
			minLength: 0,
			maxLength: 99999
		}, config );

		uw.SingleLanguageInputWidget.parent.call( this );
		uw.ValidationMessageElement.call( this );

		if ( mw.loader.getState( 'ext.uls.mediawiki' ) === 'ready' ) {
			this.languageSelector = new uw.UlsWidget( {
				languages: config.languages,
				classes: [ 'mwe-upwiz-singleLanguageInputWidget-language' ]
			} );
		} else {
			this.languageSelector = new uw.LanguageDropdownWidget( {
				languages: config.languages,
				classes: [ 'mwe-upwiz-singleLanguageInputWidget-language' ]
			} );
		}
		this.languageSelector.setValue( config.defaultLanguage || this.getDefaultLanguage() );

		this.textInput = new OO.ui.MultilineTextInputWidget( {
			classes: [ 'mwe-upwiz-singleLanguageInputWidget-text' ],
			placeholder: this.config.placeholder.exists() ? this.config.placeholder.text() : '',
			autosize: true,
			rows: 2
		} );
		this.removeButton = new OO.ui.ButtonWidget( {
			classes: [ 'mwe-upwiz-singleLanguageInputWidget-removeItem' ],
			icon: 'trash',
			framed: false,
			flags: [ 'destructive' ],
			title: this.config.remove.exists() ? this.config.remove.text() : ''
		} );

		this.removeButton.connect( this, {
			click: 'onRemoveClick'
		} );

		this.languageSelector.connect( this, { select: [ 'emit', 'select' ] } );
		// Aggregate 'change' event
		// (but do not flash warnings in the user's face while they're typing)
		this.textInput.on( 'change', OO.ui.debounce( this.emit.bind( this, 'change' ), 500 ) );

		this.$element.addClass( 'mwe-upwiz-singleLanguageInputWidget' );
		this.$element.append(
			this.languageSelector.getElement(),
			this.textInput.$element
		);
		// HACK: ValidationMessageElement will append messages after this.$body
		this.$body = this.textInput.$element;
		if ( this.config.canBeRemoved !== false ) {
			this.$element.append( this.removeButton.$element );
			this.$body = this.removeButton.$element; // HACK
		}
	};
	OO.inheritClass( uw.SingleLanguageInputWidget, uw.DetailsWidget );
	OO.mixinClass( uw.SingleLanguageInputWidget, uw.ValidationMessageElement );

	/**
	 * Handle remove button click events.
	 *
	 * @private
	 */
	uw.SingleLanguageInputWidget.prototype.onRemoveClick = function () {
		var element = this.getElementGroup();

		if ( element && $.isFunction( element.removeItems ) ) {
			element.removeItems( [ this ] );
		}
	};

	/**
	 * Check if the given language code can be used for inputs.
	 * If not, try finding a similar language code that can be.
	 *
	 * @private
	 * @param {string} code Language code
	 * @param {string} [fallback] Language code to use when there's nothing close,
	 *   defaults to result of #getDefaultLanguage
	 * @return {string|null}
	 */
	uw.SingleLanguageInputWidget.prototype.getClosestAllowedLanguage = function ( code, fallback ) {
		// Is this still needed?
		if ( code === 'nan' || code === 'minnan' ) {
			code = 'zh-min-nan';
		}
		if ( this.config.languages[ code ] ) {
			return code;
		}
		if ( code.lastIndexOf( '-' ) !== -1 ) {
			return this.getClosestAllowedLanguage( code.substring( 0, code.lastIndexOf( '-' ) ) );
		}
		return arguments.length > 1 ? fallback : this.getDefaultLanguage();
	};

	/**
	 * Get the default language to use for inputs.
	 * Choose a sane default based on user preferences and wiki config.
	 *
	 * @private
	 * @return {string}
	 */
	uw.SingleLanguageInputWidget.prototype.getDefaultLanguage = function () {
		var defaultLanguage;

		if ( this.defaultLanguage !== undefined ) {
			return this.defaultLanguage;
		}

		if ( this.getClosestAllowedLanguage( mw.config.get( 'wgUserLanguage' ), null ) ) {
			defaultLanguage = this.getClosestAllowedLanguage( mw.config.get( 'wgUserLanguage' ) );
		} else if ( this.getClosestAllowedLanguage( mw.config.get( 'wgContentLanguage' ), null ) ) {
			defaultLanguage = this.getClosestAllowedLanguage( mw.config.get( 'wgContentLanguage' ) );
		} else if ( this.getClosestAllowedLanguage( 'en', null ) ) {
			defaultLanguage = this.getClosestAllowedLanguage( 'en' );
		} else {
			defaultLanguage = Object.keys( this.config.languages )[ 0 ];
		}

		// Logic copied from MediaWiki:UploadForm.js
		// Per request from Portuguese and Brazilian users, treat Brazilian Portuguese as Portuguese.
		if ( defaultLanguage === 'pt-br' ) {
			defaultLanguage = 'pt';
		// this was also in UploadForm.js, but without the heartwarming justification
		} else if ( defaultLanguage === 'en-gb' ) {
			defaultLanguage = 'en';
		}

		this.defaultLanguage = defaultLanguage;
		return defaultLanguage;
	};

	/**
	 * @inheritdoc
	 */
	uw.SingleLanguageInputWidget.prototype.getErrors = function () {
		var
			errors = [],
			text = this.textInput.getValue().trim();

		if ( text.length !== 0 && text.length < this.config.minLength ) {
			// Empty input is allowed
			errors.push( mw.message( 'mwe-upwiz-error-too-short', this.config.minLength ) );
		}
		if ( text.length > this.config.maxLength ) {
			errors.push( mw.message( 'mwe-upwiz-error-too-long', this.config.maxLength ) );
		}

		return $.Deferred().resolve( errors ).promise();
	};

	/**
	 * @param {object} languages
	 */
	uw.SingleLanguageInputWidget.prototype.updateLanguages = function ( languages ) {
		this.languageSelector.updateLanguages( languages );
	};

	/**
	 * @return {string} language code
	 */
	uw.SingleLanguageInputWidget.prototype.getLanguage = function () {
		return this.languageSelector.getValue();
	};

	/**
	 * @param {string} value language code
	 */
	uw.SingleLanguageInputWidget.prototype.setLanguage = function ( value ) {
		this.languageSelector.setValue( value );
	};

	/**
	 * @return {string} text input
	 */
	uw.SingleLanguageInputWidget.prototype.getText = function () {
		return this.textInput.getValue().trim();
	};

	/**
	 * @param {string} value text input
	 */
	uw.SingleLanguageInputWidget.prototype.setText = function ( value ) {
		this.textInput.setValue( value );
	};

	/**
	 * @inheritdoc
	 */
	uw.SingleLanguageInputWidget.prototype.getWikiText = function () {
		var
			language = this.getLanguage(),
			text = this.getText();

		if ( !text ) {
			return '';
		}

		if ( mw.UploadWizard.config.languageTemplateFixups[ language ] ) {
			language = mw.UploadWizard.config.languageTemplateFixups[ language ];
		}

		return '{{' + language + '|1=' + mw.Escaper.escapeForTemplate( text ) + '}}';
	};

	/**
	 * @inheritdoc
	 * @return {Object} See #setSerialized
	 */
	uw.SingleLanguageInputWidget.prototype.getSerialized = function () {
		return {
			language: this.languageSelector.getValue(),
			text: this.textInput.getValue()
		};
	};

	/**
	 * @inheritdoc
	 * @param {Object} serialized
	 * @param {string} serialized.language Language code
	 * @param {string} serialized.text Text
	 */
	uw.SingleLanguageInputWidget.prototype.setSerialized = function ( serialized ) {
		this.setLanguage( serialized.language );
		this.setText( serialized.text );
	};

}( mediaWiki, mediaWiki.uploadWizard, jQuery, OO ) );