4 * @author Ryan Kaldari, 2010
5 * @author Neil Kandalgaonkar, 2010-11
6 * @author Moriel Schottlender, 2015
9 /*jshint esversion:5 */
11 ( function ( mw
, $ ) {
13 * This is a way of getting simple feedback from users. It's useful
14 * for testing new features -- users can give you feedback without
15 * the difficulty of opening a whole new talk page. For this reason,
16 * it also tends to collect a wider range of both positive and negative
17 * comments. However you do need to tend to the feedback page. It will
18 * get long relatively quickly, and you often get multiple messages
19 * reporting the same issue.
21 * It takes the form of thing on your page which, when clicked, opens a small
22 * dialog box. Submitting that dialog box appends its contents to a
23 * wiki page that you specify, as a new section.
25 * This feature works with any content model that defines a
26 * `mw.messagePoster.MessagePoster`.
28 * Minimal usage example:
30 * var feedback = new mw.Feedback();
31 * $( '#myButton' ).click( function () { feedback.launch(); } );
33 * You can also launch the feedback form with a prefilled subject and body.
34 * See the docs for the #launch() method.
38 * @param {Object} [config] Configuration object
39 * @cfg {mw.Title} [title="Feedback"] The title of the page where you collect
41 * @cfg {string} [apiUrl] api.php URL if the feedback page is on another wiki
42 * @cfg {string} [dialogTitleMessageKey="feedback-dialog-title"] Message key for the
43 * title of the dialog box
44 * @cfg {mw.Uri|string} [bugsLink="//phabricator.wikimedia.org/maniphest/task/edit/form/1/"] URL where
46 * @cfg {mw.Uri|string} [bugsListLink="//phabricator.wikimedia.org/maniphest/query/advanced"] URL
47 * where bugs can be listed
48 * @cfg {boolean} [showUseragentCheckbox=false] Show a Useragent agreement checkbox as part of the form.
49 * @cfg {boolean} [useragentCheckboxMandatory=false] Make the Useragent checkbox mandatory.
50 * @cfg {string|jQuery} [useragentCheckboxMessage] Supply a custom message for the useragent checkbox.
51 * defaults to the message 'feedback-terms'.
53 mw
.Feedback
= function MwFeedback( config
) {
54 config
= config
|| {};
56 this.dialogTitleMessageKey
= config
.dialogTitleMessageKey
|| 'feedback-dialog-title';
58 // Feedback page title
59 this.feedbackPageTitle
= config
.title
|| new mw
.Title( 'Feedback' );
61 this.messagePosterPromise
= mw
.messagePoster
.factory
.create( this.feedbackPageTitle
, config
.apiUrl
);
64 this.bugsTaskSubmissionLink
= config
.bugsLink
|| '//phabricator.wikimedia.org/maniphest/task/edit/form/1/';
65 this.bugsTaskListLink
= config
.bugsListLink
|| '//phabricator.wikimedia.org/maniphest/query/advanced';
68 this.useragentCheckboxShow
= !!config
.showUseragentCheckbox
;
69 this.useragentCheckboxMandatory
= !!config
.useragentCheckboxMandatory
;
70 this.useragentCheckboxMessage
= config
.useragentCheckboxMessage
||
71 $( '<p>' ).append( mw
.msg( 'feedback-terms' ) );
74 this.thankYouDialog
= new OO
.ui
.MessageDialog();
78 OO
.initClass( mw
.Feedback
);
80 /* Static Properties */
81 mw
.Feedback
.static.windowManager
= null;
82 mw
.Feedback
.static.dialog
= null;
87 * Respond to dialog submit event. If the information was
88 * submitted, either successfully or with an error, open
89 * a MessageDialog to thank the user.
91 * @param {string} [status] A status of the end of operation
92 * of the main feedback dialog. Empty if the dialog was
93 * dismissed with no action or the user followed the button
94 * to the external task reporting site.
96 mw
.Feedback
.prototype.onDialogSubmit = function ( status
) {
97 var dialogConfig
= {};
101 title
: mw
.msg( 'feedback-thanks-title' ),
102 message
: $( '<span>' ).msg(
104 this.feedbackPageTitle
.getNameText(),
107 href
: this.feedbackPageTitle
.getUrl()
113 label
: mw
.msg( 'feedback-close' ),
121 // Show the message dialog
122 if ( !$.isEmptyObject( dialogConfig
) ) {
123 this.constructor.static.windowManager
.openWindow(
131 * Modify the display form, and then open it, focusing interface on the subject.
133 * @param {Object} [contents] Prefilled contents for the feedback form.
134 * @param {string} [contents.subject] The subject of the feedback, as plaintext
135 * @param {string} [contents.message] The content of the feedback, as wikitext
137 mw
.Feedback
.prototype.launch = function ( contents
) {
139 if ( !this.constructor.static.dialog
) {
140 this.constructor.static.dialog
= new mw
.Feedback
.Dialog();
141 this.constructor.static.dialog
.connect( this, { submit
: 'onDialogSubmit' } );
143 if ( !this.constructor.static.windowManager
) {
144 this.constructor.static.windowManager
= new OO
.ui
.WindowManager();
145 this.constructor.static.windowManager
.addWindows( [
146 this.constructor.static.dialog
,
150 .append( this.constructor.static.windowManager
.$element
);
153 this.constructor.static.windowManager
.openWindow(
154 this.constructor.static.dialog
,
156 title
: mw
.msg( this.dialogTitleMessageKey
),
158 messagePosterPromise
: this.messagePosterPromise
,
159 title
: this.feedbackPageTitle
,
160 dialogTitleMessageKey
: this.dialogTitleMessageKey
,
161 bugsTaskSubmissionLink
: this.bugsTaskSubmissionLink
,
162 bugsTaskListLink
: this.bugsTaskListLink
,
164 show
: this.useragentCheckboxShow
,
165 mandatory
: this.useragentCheckboxMandatory
,
166 message
: this.useragentCheckboxMessage
178 * @extends OO.ui.ProcessDialog
181 * @param {Object} config Configuration object
183 mw
.Feedback
.Dialog
= function mwFeedbackDialog( config
) {
184 // Parent constructor
185 mw
.Feedback
.Dialog
.parent
.call( this, config
);
188 this.feedbackPageTitle
= null;
190 this.$element
.addClass( 'mwFeedback-Dialog' );
193 OO
.inheritClass( mw
.Feedback
.Dialog
, OO
.ui
.ProcessDialog
);
195 /* Static properties */
196 mw
.Feedback
.Dialog
.static.name
= 'mwFeedbackDialog';
197 mw
.Feedback
.Dialog
.static.title
= mw
.msg( 'feedback-dialog-title' );
198 mw
.Feedback
.Dialog
.static.size
= 'medium';
199 mw
.Feedback
.Dialog
.static.actions
= [
202 label
: mw
.msg( 'feedback-submit' ),
203 flags
: [ 'primary', 'progressive' ]
207 label
: mw
.msg( 'feedback-external-bug-report-button' ),
212 label
: mw
.msg( 'feedback-cancel' ),
220 mw
.Feedback
.Dialog
.prototype.initialize = function () {
221 var feedbackSubjectFieldLayout
, feedbackMessageFieldLayout
,
222 feedbackFieldsetLayout
, termsOfUseLabel
;
225 mw
.Feedback
.Dialog
.parent
.prototype.initialize
.call( this );
227 this.feedbackPanel
= new OO
.ui
.PanelLayout( {
233 this.$spinner
= $( '<div>' )
234 .addClass( 'feedback-spinner' );
237 this.feedbackMessageLabel
= new OO
.ui
.LabelWidget( {
238 classes
: [ 'mw-feedbackDialog-welcome-message' ]
240 this.feedbackSubjectInput
= new OO
.ui
.TextInputWidget( {
241 indicator
: 'required',
244 this.feedbackMessageInput
= new OO
.ui
.TextInputWidget( {
248 feedbackSubjectFieldLayout
= new OO
.ui
.FieldLayout( this.feedbackSubjectInput
, {
249 label
: mw
.msg( 'feedback-subject' )
251 feedbackMessageFieldLayout
= new OO
.ui
.FieldLayout( this.feedbackMessageInput
, {
252 label
: mw
.msg( 'feedback-message' )
254 feedbackFieldsetLayout
= new OO
.ui
.FieldsetLayout( {
255 items
: [ feedbackSubjectFieldLayout
, feedbackMessageFieldLayout
],
256 classes
: [ 'mw-feedbackDialog-feedback-form' ]
259 // Useragent terms of use
260 this.useragentCheckbox
= new OO
.ui
.CheckboxInputWidget();
261 this.useragentFieldLayout
= new OO
.ui
.FieldLayout( this.useragentCheckbox
, {
262 classes
: [ 'mw-feedbackDialog-feedback-terms' ],
266 termsOfUseLabel
= new OO
.ui
.LabelWidget( {
267 classes
: [ 'mw-feedbackDialog-feedback-termsofuse' ],
268 label
: $( '<p>' ).append( mw
.msg( 'feedback-termsofuse' ) )
271 this.feedbackPanel
.$element
.append(
272 this.feedbackMessageLabel
.$element
,
273 feedbackFieldsetLayout
.$element
,
274 this.useragentFieldLayout
.$element
,
275 termsOfUseLabel
.$element
279 this.feedbackSubjectInput
.connect( this, { change
: 'validateFeedbackForm' } );
280 this.feedbackMessageInput
.connect( this, { change
: 'validateFeedbackForm' } );
281 this.feedbackMessageInput
.connect( this, { change
: 'updateSize' } );
282 this.useragentCheckbox
.connect( this, { change
: 'validateFeedbackForm' } );
284 this.$body
.append( this.feedbackPanel
.$element
);
288 * Validate the feedback form
290 mw
.Feedback
.Dialog
.prototype.validateFeedbackForm = function () {
293 !this.useragentMandatory
||
294 this.useragentCheckbox
.isSelected()
296 this.feedbackSubjectInput
.getValue()
299 this.actions
.setAbilities( { submit
: isValid
} );
305 mw
.Feedback
.Dialog
.prototype.getBodyHeight = function () {
306 return this.feedbackPanel
.$element
.outerHeight( true );
312 mw
.Feedback
.Dialog
.prototype.getSetupProcess = function ( data
) {
313 return mw
.Feedback
.Dialog
.parent
.prototype.getSetupProcess
.call( this, data
)
315 var plainMsg
, parsedMsg
,
316 settings
= data
.settings
;
317 data
.contents
= data
.contents
|| {};
319 // Prefill subject/message
320 this.feedbackSubjectInput
.setValue( data
.contents
.subject
);
321 this.feedbackMessageInput
.setValue( data
.contents
.message
);
324 this.messagePosterPromise
= settings
.messagePosterPromise
;
325 this.setBugReportLink( settings
.bugsTaskSubmissionLink
);
326 this.feedbackPageTitle
= settings
.title
;
327 this.feedbackPageName
= settings
.title
.getNameText();
328 this.feedbackPageUrl
= settings
.title
.getUrl();
330 // Useragent checkbox
331 if ( settings
.useragentCheckbox
.show
) {
332 this.useragentFieldLayout
.setLabel( settings
.useragentCheckbox
.message
);
335 this.useragentMandatory
= settings
.useragentCheckbox
.mandatory
;
336 this.useragentFieldLayout
.toggle( settings
.useragentCheckbox
.show
);
338 // HACK: Setting a link in the messages doesn't work. There is already a report
339 // about this, and the bug report offers a somewhat hacky work around that
340 // includes setting a separate message to be parsed.
341 // We want to make sure the user can configure both the title of the page and
342 // a separate url, so this must be allowed to parse correctly.
343 // See https://phabricator.wikimedia.org/T49395#490610
345 'feedback-dialog-temporary-message':
346 '<a href="' + this.feedbackPageUrl
+ '" target="_blank">' + this.feedbackPageName
+ '</a>'
348 plainMsg
= mw
.message( 'feedback-dialog-temporary-message' ).plain();
349 mw
.messages
.set( { 'feedback-dialog-temporary-message-parsed': plainMsg
} );
350 parsedMsg
= mw
.message( 'feedback-dialog-temporary-message-parsed' );
351 this.feedbackMessageLabel
.setLabel(
354 .append( mw
.message( 'feedback-dialog-intro', parsedMsg
).parse() )
357 this.validateFeedbackForm();
364 mw
.Feedback
.Dialog
.prototype.getReadyProcess = function ( data
) {
365 return mw
.Feedback
.Dialog
.parent
.prototype.getReadyProcess
.call( this, data
)
367 this.feedbackSubjectInput
.focus();
374 mw
.Feedback
.Dialog
.prototype.getActionProcess = function ( action
) {
375 if ( action
=== 'cancel' ) {
376 return new OO
.ui
.Process( function () {
377 this.close( { action
: action
} );
379 } else if ( action
=== 'external' ) {
380 return new OO
.ui
.Process( function () {
381 // Open in a new window
382 window
.open( this.getBugReportLink(), '_blank' );
386 } else if ( action
=== 'submit' ) {
387 return new OO
.ui
.Process( function () {
389 userAgentMessage
= ':' +
391 mw
.msg( 'feedback-useragent' ) +
393 mw
.html
.escape( navigator
.userAgent
) +
395 subject
= this.feedbackSubjectInput
.getValue(),
396 message
= this.feedbackMessageInput
.getValue();
398 // Add user agent if checkbox is selected
399 if ( this.useragentCheckbox
.isSelected() ) {
400 message
= userAgentMessage
+ message
;
404 return this.messagePosterPromise
.then( function ( poster
) {
405 return fb
.postMessage( poster
, subject
, message
);
407 fb
.status
= 'error4';
408 mw
.log
.warn( 'Feedback report failed because MessagePoster could not be fetched' );
409 } ).then( function () {
412 return fb
.getErrorMessage();
416 // Fallback to parent handler
417 return mw
.Feedback
.Dialog
.parent
.prototype.getActionProcess
.call( this, action
);
421 * Returns an error message for the current status.
425 * @return {OO.ui.Error}
427 mw
.Feedback
.Dialog
.prototype.getErrorMessage = function () {
428 switch ( this.status
) {
433 // Messages: feedback-error1, feedback-error2, feedback-error3, feedback-error4
434 return new OO
.ui
.Error( mw
.msg( 'feedback-' + this.status
) );
443 * @param {mw.messagePoster.MessagePoster} poster Poster implementation used to leave feedback
444 * @param {string} subject Subject of message
445 * @param {string} message Body of message
446 * @return {jQuery.Promise} Promise representing success of message posting action
448 mw
.Feedback
.Dialog
.prototype.postMessage = function ( poster
, subject
, message
) {
454 ).then( function () {
455 fb
.status
= 'submitted';
456 }, function ( mainCode
, secondaryCode
, details
) {
457 if ( mainCode
=== 'api-fail' ) {
458 if ( secondaryCode
=== 'http' ) {
459 fb
.status
= 'error3';
460 // ajax request failed
461 mw
.log
.warn( 'Feedback report failed with HTTP error: ' + details
.textStatus
);
463 fb
.status
= 'error2';
464 mw
.log
.warn( 'Feedback report failed with API error: ' + secondaryCode
);
467 fb
.status
= 'error1';
475 mw
.Feedback
.Dialog
.prototype.getTeardownProcess = function ( data
) {
476 return mw
.Feedback
.Dialog
.parent
.prototype.getTeardownProcess
.call( this, data
)
477 .first( function () {
478 this.emit( 'submit', this.status
, this.feedbackPageName
, this.feedbackPageUrl
);
481 this.feedbackPageTitle
= null;
482 this.feedbackSubjectInput
.setValue( '' );
483 this.feedbackMessageInput
.setValue( '' );
484 this.useragentCheckbox
.setSelected( false );
489 * Set the bug report link
491 * @param {string} link Link to the external bug report form
493 mw
.Feedback
.Dialog
.prototype.setBugReportLink = function ( link
) {
494 this.bugReportLink
= link
;
498 * Get the bug report link
500 * @return {string} Link to the external bug report form
502 mw
.Feedback
.Dialog
.prototype.getBugReportLink = function () {
503 return this.bugReportLink
;
506 }( mediaWiki
, jQuery
) );