aboutsummaryrefslogtreecommitdiffstats
path: root/resources/src/mediawiki.widgets/mw.widgets.ExpiryInputWidget.js
blob: 56dfa790a4dc19189a920442e6b63803fc23ebd5 (plain) (blame)
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
/*!
 * MediaWiki Widgets - ExpiryWidget class.
 *
 * @copyright 2018 MediaWiki Widgets Team and others; see AUTHORS.txt
 * @license The MIT License (MIT); see LICENSE.txt
 */
/* global moment */
( function () {

	/**
	 * @classdesc Expiry widget.
	 *
	 * @class mw.widgets.ExpiryWidget
	 * @extends OO.ui.Widget
	 *
	 * @constructor
	 * @description Create a mw.widgets.ExpiryWidget object.
	 * @param {Object} [config] Configuration options
	 */
	mw.widgets.ExpiryWidget = function ( config ) {
		const RFC2822 = 'ddd, DD MMM YYYY HH:mm:ss [GMT]';

		// Config initialization
		config = Object.assign( {}, config );

		this.relativeField = new config.RelativeInputClass( config.relativeInput );
		this.relativeField.$element.addClass( 'mw-widget-ExpiryWidget-relative' );

		// Parent constructor
		mw.widgets.ExpiryWidget.super.call( this, config );

		// Properties
		this.inputSwitch = new OO.ui.ButtonSelectWidget( {
			tabIndex: -1,
			items: [
				new OO.ui.ButtonOptionWidget( {
					data: 'relative',
					icon: 'edit'
				} ),
				new OO.ui.ButtonOptionWidget( {
					data: 'date',
					icon: 'calendar'
				} )
			]
		} );
		this.dateTimeField = new mw.widgets.datetime.DateTimeInputWidget( {
			min: new Date(), // The selected date must at least be now.
			required: config.required
		} );

		// Initially hide the dateTime field.
		this.dateTimeField.toggle( false );
		// Initially set the relative input.
		this.inputSwitch.selectItemByData( 'relative' );

		// Events

		// Toggle the visible inputs.
		this.inputSwitch.on( 'choose', ( event ) => {
			switch ( event.getData() ) {
				case 'date':
					this.dateTimeField.toggle( true );
					this.relativeField.toggle( false );
					break;
				case 'relative':
					this.dateTimeField.toggle( false );
					this.relativeField.toggle( true );
					break;
			}
		} );

		// When the date time field update, update the relative
		// field.
		this.dateTimeField.on( 'change', ( value ) => {
			// Do not alter the visible input.
			if ( this.relativeField.isVisible() ) {
				return;
			}

			// If the value was cleared, do not attempt to parse it.
			if ( !value ) {
				this.relativeField.setValue( value );
				return;
			}

			const datetime = moment( value );

			// If the datetime is invlaid for some reason, reset the relative field.
			if ( !datetime.isValid() ) {
				this.relativeField.setValue( undefined );
			}

			// Set the relative field value. The field only accepts English strings.
			this.relativeField.setValue( datetime.utc().locale( 'en' ).format( RFC2822 ) );
		} );

		// When the relative field update, update the date time field if it's a
		// value that moment understands.
		this.relativeField.on( 'change', ( event ) => {
			// Emit a change event for this widget.
			this.emit( 'change', event );

			// Do not alter the visible input.
			if ( this.dateTimeField.isVisible() ) {
				return;
			}

			// Parsing of free text field may fail, so always check if the date is
			// valid.
			const datetime = moment( event );

			if ( datetime.isValid() ) {
				this.dateTimeField.setValue( datetime.utc().toISOString() );
			} else {
				this.dateTimeField.setValue( undefined );
			}
		} );

		// Initialization
		this.$element
			.addClass( 'mw-widget-ExpiryWidget' )
			.addClass( 'mw-widget-ExpiryWidget-hasDatePicker' )
			.append(
				this.inputSwitch.$element,
				this.dateTimeField.$element,
				this.relativeField.$element
			);

		// Trigger an initial onChange.
		this.relativeField.emit( 'change', this.relativeField.getValue() );
	};

	/* Inheritance */

	OO.inheritClass( mw.widgets.ExpiryWidget, OO.ui.Widget );

	/**
	 * @inheritdoc
	 */
	mw.widgets.ExpiryWidget.static.reusePreInfuseDOM = function ( node, config ) {
		const $relativeElement = $( node ).find( '.mw-widget-ExpiryWidget-relative' );

		config = mw.widgets.ExpiryWidget.super.static.reusePreInfuseDOM( node, config );

		// eslint-disable-next-line no-jquery/no-class-state
		if ( $relativeElement.hasClass( 'oo-ui-textInputWidget' ) ) {
			config.RelativeInputClass = OO.ui.TextInputWidget;
		// eslint-disable-next-line no-jquery/no-class-state
		} else if ( $relativeElement.hasClass( 'mw-widget-selectWithInputWidget' ) ) {
			config.RelativeInputClass = mw.widgets.SelectWithInputWidget;
		}

		config.relativeInput = config.RelativeInputClass.static.reusePreInfuseDOM(
			$relativeElement,
			config.relativeInput
		);

		return config;
	};

	/**
	 * @inheritdoc
	 */
	mw.widgets.ExpiryWidget.static.gatherPreInfuseState = function ( node, config ) {
		const state = mw.widgets.ExpiryWidget.super.static.gatherPreInfuseState( node, config );

		state.relativeInput = config.RelativeInputClass.static.gatherPreInfuseState(
			$( node ).find( '.mw-widget-ExpiryWidget-relative' ),
			config.relativeInput
		);

		return state;
	};

	/**
	 * @inheritdoc
	 */
	mw.widgets.ExpiryWidget.prototype.restorePreInfuseState = function ( state ) {
		mw.widgets.ExpiryWidget.super.prototype.restorePreInfuseState.call( this, state );
		this.relativeField.restorePreInfuseState( state.relativeInput );
	};

	/**
	 * @inheritdoc
	 */
	mw.widgets.ExpiryWidget.prototype.setDisabled = function ( disabled ) {
		mw.widgets.ExpiryWidget.super.prototype.setDisabled.call( this, disabled );
		this.relativeField.setDisabled( disabled );

		if ( this.inputSwitch ) {
			this.inputSwitch.setDisabled( disabled );
		}

		if ( this.dateTimeField ) {
			this.dateTimeField.setDisabled( disabled );
		}
	};

	/**
	 * Gets the value of the widget.
	 *
	 * @return {string}
	 */
	mw.widgets.ExpiryWidget.prototype.getValue = function () {
		return this.relativeField.getValue();
	};

}() );