4 * @author Ryan Kaldari, 2010
5 * @author Neil Kandalgaonkar, 2010-11
6 * @author Moriel Schottlender, 2015
11 * This is a way of getting simple feedback from users. It's useful
12 * for testing new features -- users can give you feedback without
13 * the difficulty of opening a whole new talk page. For this reason,
14 * it also tends to collect a wider range of both positive and negative
15 * comments. However you do need to tend to the feedback page. It will
16 * get long relatively quickly, and you often get multiple messages
17 * reporting the same issue.
19 * It takes the form of thing on your page which, when clicked, opens a small
20 * dialog box. Submitting that dialog box appends its contents to a
21 * wiki page that you specify, as a new section.
23 * This feature works with any content model that defines a
24 * `mw.messagePoster.MessagePoster`.
26 * Minimal usage example:
28 * var feedback = new mw.Feedback();
29 * $( '#myButton' ).click( function () { feedback.launch(); } );
31 * You can also launch the feedback form with a prefilled subject and body.
32 * See the docs for the #launch() method.
36 * @param {Object} [config] Configuration object
37 * @cfg {mw.Title} [title="Feedback"] The title of the page where you collect
39 * @cfg {string} [apiUrl] api.php URL if the feedback page is on another wiki
40 * @cfg {string} [dialogTitleMessageKey="feedback-dialog-title"] Message key for the
41 * title of the dialog box
42 * @cfg {mw.Uri|string} [bugsLink="//phabricator.wikimedia.org/maniphest/task/edit/form/1/"] URL where
44 * @cfg {mw.Uri|string} [bugsListLink="//phabricator.wikimedia.org/maniphest/query/advanced"] URL
45 * where bugs can be listed
46 * @cfg {boolean} [showUseragentCheckbox=false] Show a Useragent agreement checkbox as part of the form.
47 * @cfg {boolean} [useragentCheckboxMandatory=false] Make the Useragent checkbox mandatory.
48 * @cfg {string|jQuery} [useragentCheckboxMessage] Supply a custom message for the useragent checkbox.
49 * defaults to the message 'feedback-terms'.
51 mw
.Feedback
= function MwFeedback( config
) {
52 config
= config
|| {};
54 this.dialogTitleMessageKey
= config
.dialogTitleMessageKey
|| 'feedback-dialog-title';
56 // Feedback page title
57 this.feedbackPageTitle
= config
.title
|| new mw
.Title( 'Feedback' );
59 this.messagePosterPromise
= mw
.messagePoster
.factory
.create( this.feedbackPageTitle
, config
.apiUrl
);
62 this.bugsTaskSubmissionLink
= config
.bugsLink
|| '//phabricator.wikimedia.org/maniphest/task/edit/form/1/';
63 this.bugsTaskListLink
= config
.bugsListLink
|| '//phabricator.wikimedia.org/maniphest/query/advanced';
66 this.useragentCheckboxShow
= !!config
.showUseragentCheckbox
;
67 this.useragentCheckboxMandatory
= !!config
.useragentCheckboxMandatory
;
68 this.useragentCheckboxMessage
= config
.useragentCheckboxMessage
||
69 $( '<p>' ).append( mw
.msg( 'feedback-terms' ) );
72 this.thankYouDialog
= new OO
.ui
.MessageDialog();
76 OO
.initClass( mw
.Feedback
);
78 /* Static Properties */
79 mw
.Feedback
.static.windowManager
= null;
80 mw
.Feedback
.static.dialog
= null;
85 * Respond to dialog submit event. If the information was
86 * submitted successfully, open a MessageDialog to thank the user.
88 * @param {string} [status] A status of the end of operation
89 * of the main feedback dialog. Empty if the dialog was
90 * dismissed with no action or the user followed the button
91 * to the external task reporting site.
93 mw
.Feedback
.prototype.onDialogSubmit = function ( status
) {
96 if ( status
!== 'submitted' ) {
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' ),
119 // Show the message dialog
120 this.constructor.static.windowManager
.openWindow(
127 * Modify the display form, and then open it, focusing interface on the subject.
129 * @param {Object} [contents] Prefilled contents for the feedback form.
130 * @param {string} [contents.subject] The subject of the feedback, as plaintext
131 * @param {string} [contents.message] The content of the feedback, as wikitext
133 mw
.Feedback
.prototype.launch = function ( contents
) {
135 if ( !this.constructor.static.dialog
) {
136 this.constructor.static.dialog
= new mw
.Feedback
.Dialog();
137 this.constructor.static.dialog
.connect( this, { submit
: 'onDialogSubmit' } );
139 if ( !this.constructor.static.windowManager
) {
140 this.constructor.static.windowManager
= new OO
.ui
.WindowManager();
141 this.constructor.static.windowManager
.addWindows( [
142 this.constructor.static.dialog
,
146 .append( this.constructor.static.windowManager
.$element
);
149 this.constructor.static.windowManager
.openWindow(
150 this.constructor.static.dialog
,
152 title
: mw
.msg( this.dialogTitleMessageKey
),
154 messagePosterPromise
: this.messagePosterPromise
,
155 title
: this.feedbackPageTitle
,
156 dialogTitleMessageKey
: this.dialogTitleMessageKey
,
157 bugsTaskSubmissionLink
: this.bugsTaskSubmissionLink
,
158 bugsTaskListLink
: this.bugsTaskListLink
,
160 show
: this.useragentCheckboxShow
,
161 mandatory
: this.useragentCheckboxMandatory
,
162 message
: this.useragentCheckboxMessage
174 * @extends OO.ui.ProcessDialog
177 * @param {Object} config Configuration object
179 mw
.Feedback
.Dialog
= function mwFeedbackDialog( config
) {
180 // Parent constructor
181 mw
.Feedback
.Dialog
.parent
.call( this, config
);
184 this.feedbackPageTitle
= null;
186 this.$element
.addClass( 'mwFeedback-Dialog' );
189 OO
.inheritClass( mw
.Feedback
.Dialog
, OO
.ui
.ProcessDialog
);
191 /* Static properties */
192 mw
.Feedback
.Dialog
.static.name
= 'mwFeedbackDialog';
193 mw
.Feedback
.Dialog
.static.title
= mw
.msg( 'feedback-dialog-title' );
194 mw
.Feedback
.Dialog
.static.size
= 'medium';
195 mw
.Feedback
.Dialog
.static.actions
= [
198 label
: mw
.msg( 'feedback-submit' ),
199 flags
: [ 'primary', 'progressive' ]
203 label
: mw
.msg( 'feedback-external-bug-report-button' ),
208 label
: mw
.msg( 'feedback-cancel' ),
216 mw
.Feedback
.Dialog
.prototype.initialize = function () {
217 var feedbackSubjectFieldLayout
, feedbackMessageFieldLayout
,
218 feedbackFieldsetLayout
, termsOfUseLabel
;
221 mw
.Feedback
.Dialog
.parent
.prototype.initialize
.call( this );
223 this.feedbackPanel
= new OO
.ui
.PanelLayout( {
229 this.$spinner
= $( '<div>' )
230 .addClass( 'feedback-spinner' );
233 this.feedbackMessageLabel
= new OO
.ui
.LabelWidget( {
234 classes
: [ 'mw-feedbackDialog-welcome-message' ]
236 this.feedbackSubjectInput
= new OO
.ui
.TextInputWidget( {
237 indicator
: 'required'
239 this.feedbackMessageInput
= new OO
.ui
.MultilineTextInputWidget( {
242 feedbackSubjectFieldLayout
= new OO
.ui
.FieldLayout( this.feedbackSubjectInput
, {
243 label
: mw
.msg( 'feedback-subject' )
245 feedbackMessageFieldLayout
= new OO
.ui
.FieldLayout( this.feedbackMessageInput
, {
246 label
: mw
.msg( 'feedback-message' )
248 feedbackFieldsetLayout
= new OO
.ui
.FieldsetLayout( {
249 items
: [ feedbackSubjectFieldLayout
, feedbackMessageFieldLayout
],
250 classes
: [ 'mw-feedbackDialog-feedback-form' ]
253 // Useragent terms of use
254 this.useragentCheckbox
= new OO
.ui
.CheckboxInputWidget();
255 this.useragentFieldLayout
= new OO
.ui
.FieldLayout( this.useragentCheckbox
, {
256 classes
: [ 'mw-feedbackDialog-feedback-terms' ],
260 termsOfUseLabel
= new OO
.ui
.LabelWidget( {
261 classes
: [ 'mw-feedbackDialog-feedback-termsofuse' ],
262 label
: $( '<p>' ).append( mw
.msg( 'feedback-termsofuse' ) )
265 this.feedbackPanel
.$element
.append(
266 this.feedbackMessageLabel
.$element
,
267 feedbackFieldsetLayout
.$element
,
268 this.useragentFieldLayout
.$element
,
269 termsOfUseLabel
.$element
273 this.feedbackSubjectInput
.connect( this, { change
: 'validateFeedbackForm' } );
274 this.feedbackMessageInput
.connect( this, { change
: 'validateFeedbackForm' } );
275 this.feedbackMessageInput
.connect( this, { change
: 'updateSize' } );
276 this.useragentCheckbox
.connect( this, { change
: 'validateFeedbackForm' } );
278 this.$body
.append( this.feedbackPanel
.$element
);
282 * Validate the feedback form
284 mw
.Feedback
.Dialog
.prototype.validateFeedbackForm = function () {
287 !this.useragentMandatory
||
288 this.useragentCheckbox
.isSelected()
290 this.feedbackSubjectInput
.getValue()
293 this.actions
.setAbilities( { submit
: isValid
} );
299 mw
.Feedback
.Dialog
.prototype.getBodyHeight = function () {
300 return this.feedbackPanel
.$element
.outerHeight( true );
306 mw
.Feedback
.Dialog
.prototype.getSetupProcess = function ( data
) {
307 return mw
.Feedback
.Dialog
.parent
.prototype.getSetupProcess
.call( this, data
)
309 var plainMsg
, parsedMsg
,
310 settings
= data
.settings
;
311 data
.contents
= data
.contents
|| {};
313 // Prefill subject/message
314 this.feedbackSubjectInput
.setValue( data
.contents
.subject
);
315 this.feedbackMessageInput
.setValue( data
.contents
.message
);
318 this.messagePosterPromise
= settings
.messagePosterPromise
;
319 this.setBugReportLink( settings
.bugsTaskSubmissionLink
);
320 this.feedbackPageTitle
= settings
.title
;
321 this.feedbackPageName
= settings
.title
.getNameText();
322 this.feedbackPageUrl
= settings
.title
.getUrl();
324 // Useragent checkbox
325 if ( settings
.useragentCheckbox
.show
) {
326 this.useragentFieldLayout
.setLabel( settings
.useragentCheckbox
.message
);
329 this.useragentMandatory
= settings
.useragentCheckbox
.mandatory
;
330 this.useragentFieldLayout
.toggle( settings
.useragentCheckbox
.show
);
332 // HACK: Setting a link in the messages doesn't work. There is already a report
333 // about this, and the bug report offers a somewhat hacky work around that
334 // includes setting a separate message to be parsed.
335 // We want to make sure the user can configure both the title of the page and
336 // a separate url, so this must be allowed to parse correctly.
337 // See https://phabricator.wikimedia.org/T49395#490610
339 'feedback-dialog-temporary-message':
340 '<a href="' + this.feedbackPageUrl
+ '" target="_blank">' + this.feedbackPageName
+ '</a>'
342 plainMsg
= mw
.message( 'feedback-dialog-temporary-message' ).plain();
343 mw
.messages
.set( { 'feedback-dialog-temporary-message-parsed': plainMsg
} );
344 parsedMsg
= mw
.message( 'feedback-dialog-temporary-message-parsed' );
345 this.feedbackMessageLabel
.setLabel(
348 .append( mw
.message( 'feedback-dialog-intro', parsedMsg
).parse() )
351 this.validateFeedbackForm();
358 mw
.Feedback
.Dialog
.prototype.getReadyProcess = function ( data
) {
359 return mw
.Feedback
.Dialog
.parent
.prototype.getReadyProcess
.call( this, data
)
361 this.feedbackSubjectInput
.focus();
368 mw
.Feedback
.Dialog
.prototype.getActionProcess = function ( action
) {
369 if ( action
=== 'cancel' ) {
370 return new OO
.ui
.Process( function () {
371 this.close( { action
: action
} );
373 } else if ( action
=== 'external' ) {
374 return new OO
.ui
.Process( function () {
375 // Open in a new window
376 window
.open( this.getBugReportLink(), '_blank' );
380 } else if ( action
=== 'submit' ) {
381 return new OO
.ui
.Process( function () {
383 userAgentMessage
= ':' +
385 mw
.msg( 'feedback-useragent' ) +
387 mw
.html
.escape( navigator
.userAgent
) +
389 subject
= this.feedbackSubjectInput
.getValue(),
390 message
= this.feedbackMessageInput
.getValue();
392 // Add user agent if checkbox is selected
393 if ( this.useragentCheckbox
.isSelected() ) {
394 message
= userAgentMessage
+ message
;
398 return this.messagePosterPromise
.then( function ( poster
) {
399 return fb
.postMessage( poster
, subject
, message
);
401 fb
.status
= 'error4';
402 mw
.log
.warn( 'Feedback report failed because MessagePoster could not be fetched' );
403 } ).then( function () {
406 return fb
.getErrorMessage();
410 // Fallback to parent handler
411 return mw
.Feedback
.Dialog
.parent
.prototype.getActionProcess
.call( this, action
);
415 * Returns an error message for the current status.
419 * @return {OO.ui.Error}
421 mw
.Feedback
.Dialog
.prototype.getErrorMessage = function () {
422 // Messages: feedback-error1, feedback-error2, feedback-error3, feedback-error4
423 return new OO
.ui
.Error( mw
.msg( 'feedback-' + this.status
) );
431 * @param {mw.messagePoster.MessagePoster} poster Poster implementation used to leave feedback
432 * @param {string} subject Subject of message
433 * @param {string} message Body of message
434 * @return {jQuery.Promise} Promise representing success of message posting action
436 mw
.Feedback
.Dialog
.prototype.postMessage = function ( poster
, subject
, message
) {
442 ).then( function () {
443 fb
.status
= 'submitted';
444 }, function ( mainCode
, secondaryCode
, details
) {
445 if ( mainCode
=== 'api-fail' ) {
446 if ( secondaryCode
=== 'http' ) {
447 fb
.status
= 'error3';
448 // ajax request failed
449 mw
.log
.warn( 'Feedback report failed with HTTP error: ' + details
.textStatus
);
451 fb
.status
= 'error2';
452 mw
.log
.warn( 'Feedback report failed with API error: ' + secondaryCode
);
455 fb
.status
= 'error1';
463 mw
.Feedback
.Dialog
.prototype.getTeardownProcess = function ( data
) {
464 return mw
.Feedback
.Dialog
.parent
.prototype.getTeardownProcess
.call( this, data
)
465 .first( function () {
466 this.emit( 'submit', this.status
, this.feedbackPageName
, this.feedbackPageUrl
);
469 this.feedbackPageTitle
= null;
470 this.feedbackSubjectInput
.setValue( '' );
471 this.feedbackMessageInput
.setValue( '' );
472 this.useragentCheckbox
.setSelected( false );
477 * Set the bug report link
479 * @param {string} link Link to the external bug report form
481 mw
.Feedback
.Dialog
.prototype.setBugReportLink = function ( link
) {
482 this.bugReportLink
= link
;
486 * Get the bug report link
488 * @return {string} Link to the external bug report form
490 mw
.Feedback
.Dialog
.prototype.getBugReportLink = function () {
491 return this.bugReportLink
;
494 }( mediaWiki
, jQuery
) );