resources/src/mediawiki/mediawiki.feedback.js

   1 /*!
   2  * mediawiki.feedback
   3  *
   4  * @author Ryan Kaldari, 2010
   5  * @author Neil Kandalgaonkar, 2010-11
   6  * @author Moriel Schottlender, 2015
   7  * @since 1.19
   8  */
   9 /*jshint esversion:5 */
  10 /*global OO*/
  11 ( function ( mw, $ ) {
  12         /**
  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.
  20          *
  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.
  24          *
  25          * This feature works with any content model that defines a
  26          * `mw.messagePoster.MessagePoster`.
  27          *
  28          * Minimal usage example:
  29          *
  30          *     var feedback = new mw.Feedback();
  31          *     $( '#myButton' ).click( function () { feedback.launch(); } );
  32          *
  33          * You can also launch the feedback form with a prefilled subject and body.
  34          * See the docs for the #launch() method.
  35          *
  36          * @class
  37          * @constructor
  38          * @param {Object} [config] Configuration object
  39          * @cfg {mw.Title} [title="Feedback"] The title of the page where you collect
  40          *  feedback.
  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
  45          *  bugs can be posted
  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'.
  52          */
  53         mw.Feedback = function MwFeedback( config ) {
  54                 config = config || {};
  55
  56                 this.dialogTitleMessageKey = config.dialogTitleMessageKey || 'feedback-dialog-title';
  57
  58                 // Feedback page title
  59                 this.feedbackPageTitle = config.title || new mw.Title( 'Feedback' );
  60
  61                 this.messagePosterPromise = mw.messagePoster.factory.create( this.feedbackPageTitle, config.apiUrl );
  62
  63                 // Links
  64                 this.bugsTaskSubmissionLink = config.bugsLink || '//phabricator.wikimedia.org/maniphest/task/edit/form/1/';
  65                 this.bugsTaskListLink = config.bugsListLink || '//phabricator.wikimedia.org/maniphest/query/advanced';
  66
  67                 // Terms of use
  68                 this.useragentCheckboxShow = !!config.showUseragentCheckbox;
  69                 this.useragentCheckboxMandatory = !!config.useragentCheckboxMandatory;
  70                 this.useragentCheckboxMessage = config.useragentCheckboxMessage ||
  71                         $( '<p>' ).append( mw.msg( 'feedback-terms' ) );
  72
  73                 // Message dialog
  74                 this.thankYouDialog = new OO.ui.MessageDialog();
  75         };
  76
  77         /* Initialize */
  78         OO.initClass( mw.Feedback );
  79
  80         /* Static Properties */
  81         mw.Feedback.static.windowManager = null;
  82         mw.Feedback.static.dialog = null;
  83
  84         /* Methods */
  85
  86         /**
  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.
  90          *
  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.
  95          */
  96         mw.Feedback.prototype.onDialogSubmit = function ( status ) {
  97                 var dialogConfig = {};
  98                 switch ( status ) {
  99                         case 'submitted':
 100                                 dialogConfig = {
 101                                         title: mw.msg( 'feedback-thanks-title' ),
 102                                         message: $( '<span>' ).msg(
 103                                                 'feedback-thanks',
 104                                                 this.feedbackPageTitle.getNameText(),
 105                                                 $( '<a>' ).attr( {
 106                                                         target: '_blank',
 107                                                         href: this.feedbackPageTitle.getUrl()
 108                                                 } )
 109                                         ),
 110                                         actions: [
 111                                                 {
 112                                                         action: 'accept',
 113                                                         label: mw.msg( 'feedback-close' ),
 114                                                         flags: 'primary'
 115                                                 }
 116                                         ]
 117                                 };
 118                                 break;
 119                         case 'error1':
 120                         case 'error2':
 121                         case 'error3':
 122                         case 'error4':
 123                                 dialogConfig = {
 124                                         title: mw.msg( 'feedback-error-title' ),
 125                                         message: mw.msg( 'feedback-' + status ),
 126                                         actions: [
 127                                                 {
 128                                                         action: 'accept',
 129                                                         label: mw.msg( 'feedback-close' ),
 130                                                         flags: 'primary'
 131                                                 }
 132                                         ]
 133                                 };
 134                                 break;
 135                 }
 136
 137                 // Show the message dialog
 138                 if ( !$.isEmptyObject( dialogConfig ) ) {
 139                         this.constructor.static.windowManager.openWindow(
 140                                 this.thankYouDialog,
 141                                 dialogConfig
 142                         );
 143                 }
 144         };
 145
 146         /**
 147          * Modify the display form, and then open it, focusing interface on the subject.
 148          *
 149          * @param {Object} [contents] Prefilled contents for the feedback form.
 150          * @param {string} [contents.subject] The subject of the feedback, as plaintext
 151          * @param {string} [contents.message] The content of the feedback, as wikitext
 152          */
 153         mw.Feedback.prototype.launch = function ( contents ) {
 154                 // Dialog
 155                 if ( !this.constructor.static.dialog ) {
 156                         this.constructor.static.dialog = new mw.Feedback.Dialog();
 157                         this.constructor.static.dialog.connect( this, { submit: 'onDialogSubmit' } );
 158                 }
 159                 if ( !this.constructor.static.windowManager ) {
 160                         this.constructor.static.windowManager = new OO.ui.WindowManager();
 161                         this.constructor.static.windowManager.addWindows( [
 162                                 this.constructor.static.dialog,
 163                                 this.thankYouDialog
 164                         ] );
 165                         $( 'body' )
 166                                 .append( this.constructor.static.windowManager.$element );
 167                 }
 168                 // Open the dialog
 169                 this.constructor.static.windowManager.openWindow(
 170                         this.constructor.static.dialog,
 171                         {
 172                                 title: mw.msg( this.dialogTitleMessageKey ),
 173                                 settings: {
 174                                         messagePosterPromise: this.messagePosterPromise,
 175                                         title: this.feedbackPageTitle,
 176                                         dialogTitleMessageKey: this.dialogTitleMessageKey,
 177                                         bugsTaskSubmissionLink: this.bugsTaskSubmissionLink,
 178                                         bugsTaskListLink: this.bugsTaskListLink,
 179                                         useragentCheckbox: {
 180                                                 show: this.useragentCheckboxShow,
 181                                                 mandatory: this.useragentCheckboxMandatory,
 182                                                 message: this.useragentCheckboxMessage
 183                                         }
 184                                 },
 185                                 contents: contents
 186                         }
 187                 );
 188         };
 189
 190         /**
 191          * mw.Feedback Dialog
 192          *
 193          * @class
 194          * @extends OO.ui.ProcessDialog
 195          *
 196          * @constructor
 197          * @param {Object} config Configuration object
 198          */
 199         mw.Feedback.Dialog = function mwFeedbackDialog( config ) {
 200                 // Parent constructor
 201                 mw.Feedback.Dialog.parent.call( this, config );
 202
 203                 this.status = '';
 204                 this.feedbackPageTitle = null;
 205                 // Initialize
 206                 this.$element.addClass( 'mwFeedback-Dialog' );
 207         };
 208
 209         OO.inheritClass( mw.Feedback.Dialog, OO.ui.ProcessDialog );
 210
 211         /* Static properties */
 212         mw.Feedback.Dialog.static.name = 'mwFeedbackDialog';
 213         mw.Feedback.Dialog.static.title = mw.msg( 'feedback-dialog-title' );
 214         mw.Feedback.Dialog.static.size = 'medium';
 215         mw.Feedback.Dialog.static.actions = [
 216                 {
 217                         action: 'submit',
 218                         label: mw.msg( 'feedback-submit' ),
 219                         flags: [ 'primary', 'constructive' ]
 220                 },
 221                 {
 222                         action: 'external',
 223                         label: mw.msg( 'feedback-external-bug-report-button' ),
 224                         flags: 'constructive'
 225                 },
 226                 {
 227                         action: 'cancel',
 228                         label: mw.msg( 'feedback-cancel' ),
 229                         flags: 'safe'
 230                 }
 231         ];
 232
 233         /**
 234          * @inheritdoc
 235          */
 236         mw.Feedback.Dialog.prototype.initialize = function () {
 237                 var feedbackSubjectFieldLayout, feedbackMessageFieldLayout,
 238                         feedbackFieldsetLayout, termsOfUseLabel;
 239
 240                 // Parent method
 241                 mw.Feedback.Dialog.parent.prototype.initialize.call( this );
 242
 243                 this.feedbackPanel = new OO.ui.PanelLayout( {
 244                         scrollable: false,
 245                         expanded: false,
 246                         padded: true
 247                 } );
 248
 249                 this.$spinner = $( '<div>' )
 250                         .addClass( 'feedback-spinner' );
 251
 252                 // Feedback form
 253                 this.feedbackMessageLabel = new OO.ui.LabelWidget( {
 254                         classes: [ 'mw-feedbackDialog-welcome-message' ]
 255                 } );
 256                 this.feedbackSubjectInput = new OO.ui.TextInputWidget( {
 257                         indicator: 'required',
 258                         multiline: false
 259                 } );
 260                 this.feedbackMessageInput = new OO.ui.TextInputWidget( {
 261                         autosize: true,
 262                         multiline: true
 263                 } );
 264                 feedbackSubjectFieldLayout = new OO.ui.FieldLayout( this.feedbackSubjectInput, {
 265                         label: mw.msg( 'feedback-subject' )
 266                 } );
 267                 feedbackMessageFieldLayout = new OO.ui.FieldLayout( this.feedbackMessageInput, {
 268                         label: mw.msg( 'feedback-message' )
 269                 } );
 270                 feedbackFieldsetLayout = new OO.ui.FieldsetLayout( {
 271                         items: [ feedbackSubjectFieldLayout, feedbackMessageFieldLayout ],
 272                         classes: [ 'mw-feedbackDialog-feedback-form' ]
 273                 } );
 274
 275                 // Useragent terms of use
 276                 this.useragentCheckbox = new OO.ui.CheckboxInputWidget();
 277                 this.useragentFieldLayout = new OO.ui.FieldLayout( this.useragentCheckbox, {
 278                         classes: [ 'mw-feedbackDialog-feedback-terms' ],
 279                         align: 'inline'
 280                 } );
 281
 282                 termsOfUseLabel = new OO.ui.LabelWidget( {
 283                         classes: [ 'mw-feedbackDialog-feedback-termsofuse' ],
 284                         label: $( '<p>' ).append( mw.msg( 'feedback-termsofuse' ) )
 285                 } );
 286
 287                 this.feedbackPanel.$element.append(
 288                         this.feedbackMessageLabel.$element,
 289                         feedbackFieldsetLayout.$element,
 290                         this.useragentFieldLayout.$element,
 291                         termsOfUseLabel.$element
 292                 );
 293
 294                 // Events
 295                 this.feedbackSubjectInput.connect( this, { change: 'validateFeedbackForm' } );
 296                 this.feedbackMessageInput.connect( this, { change: 'validateFeedbackForm' } );
 297                 this.feedbackMessageInput.connect( this, { change: 'updateSize' } );
 298                 this.useragentCheckbox.connect( this, { change: 'validateFeedbackForm' } );
 299
 300                 this.$body.append( this.feedbackPanel.$element );
 301         };
 302
 303         /**
 304          * Validate the feedback form
 305          */
 306         mw.Feedback.Dialog.prototype.validateFeedbackForm = function () {
 307                 var isValid = (
 308                                 (
 309                                         !this.useragentMandatory ||
 310                                         this.useragentCheckbox.isSelected()
 311                                 ) &&
 312                                 this.feedbackSubjectInput.getValue()
 313                         );
 314
 315                 this.actions.setAbilities( { submit:  isValid } );
 316         };
 317
 318         /**
 319          * @inheritdoc
 320          */
 321         mw.Feedback.Dialog.prototype.getBodyHeight = function () {
 322                 return this.feedbackPanel.$element.outerHeight( true );
 323         };
 324
 325         /**
 326          * @inheritdoc
 327          */
 328         mw.Feedback.Dialog.prototype.getSetupProcess = function ( data ) {
 329                 return mw.Feedback.Dialog.parent.prototype.getSetupProcess.call( this, data )
 330                         .next( function () {
 331                                 var plainMsg, parsedMsg,
 332                                         settings = data.settings;
 333                                 data.contents = data.contents || {};
 334
 335                                 // Prefill subject/message
 336                                 this.feedbackSubjectInput.setValue( data.contents.subject );
 337                                 this.feedbackMessageInput.setValue( data.contents.message );
 338
 339                                 this.status = '';
 340                                 this.messagePosterPromise = settings.messagePosterPromise;
 341                                 this.setBugReportLink( settings.bugsTaskSubmissionLink );
 342                                 this.feedbackPageTitle = settings.title;
 343                                 this.feedbackPageName = settings.title.getNameText();
 344                                 this.feedbackPageUrl = settings.title.getUrl();
 345
 346                                 // Useragent checkbox
 347                                 if ( settings.useragentCheckbox.show ) {
 348                                         this.useragentFieldLayout.setLabel( settings.useragentCheckbox.message );
 349                                 }
 350
 351                                 this.useragentMandatory = settings.useragentCheckbox.mandatory;
 352                                 this.useragentFieldLayout.toggle( settings.useragentCheckbox.show );
 353
 354                                 // HACK: Setting a link in the messages doesn't work. There is already a report
 355                                 // about this, and the bug report offers a somewhat hacky work around that
 356                                 // includes setting a separate message to be parsed.
 357                                 // We want to make sure the user can configure both the title of the page and
 358                                 // a separate url, so this must be allowed to parse correctly.
 359                                 // See https://phabricator.wikimedia.org/T49395#490610
 360                                 mw.messages.set( {
 361                                         'feedback-dialog-temporary-message':
 362                                                 '<a href="' + this.feedbackPageUrl + '" target="_blank">' + this.feedbackPageName + '</a>'
 363                                 } );
 364                                 plainMsg = mw.message( 'feedback-dialog-temporary-message' ).plain();
 365                                 mw.messages.set( { 'feedback-dialog-temporary-message-parsed': plainMsg } );
 366                                 parsedMsg = mw.message( 'feedback-dialog-temporary-message-parsed' );
 367                                 this.feedbackMessageLabel.setLabel(
 368                                         // Double-parse
 369                                         $( '<span>' )
 370                                                 .append( mw.message( 'feedback-dialog-intro', parsedMsg ).parse() )
 371                                 );
 372
 373                                 this.validateFeedbackForm();
 374                         }, this );
 375         };
 376
 377         /**
 378          * @inheritdoc
 379          */
 380         mw.Feedback.Dialog.prototype.getReadyProcess = function ( data ) {
 381                 return mw.Feedback.Dialog.parent.prototype.getReadyProcess.call( this, data )
 382                         .next( function () {
 383                                 this.feedbackSubjectInput.focus();
 384                         }, this );
 385         };
 386
 387         /**
 388          * @inheritdoc
 389          */
 390         mw.Feedback.Dialog.prototype.getActionProcess = function ( action ) {
 391                 if ( action === 'cancel' ) {
 392                         return new OO.ui.Process( function () {
 393                                 this.close( { action: action } );
 394                         }, this );
 395                 } else if ( action === 'external' ) {
 396                         return new OO.ui.Process( function () {
 397                                 // Open in a new window
 398                                 window.open( this.getBugReportLink(), '_blank' );
 399                                 // Close the dialog
 400                                 this.close();
 401                         }, this );
 402                 } else if ( action === 'submit' ) {
 403                         return new OO.ui.Process( function () {
 404                                 var fb = this,
 405                                         userAgentMessage = ':' +
 406                                                 '<small>' +
 407                                                 mw.msg( 'feedback-useragent' ) +
 408                                                 ' ' +
 409                                                 mw.html.escape( navigator.userAgent ) +
 410                                                 '</small>\n\n',
 411                                         subject = this.feedbackSubjectInput.getValue(),
 412                                         message = this.feedbackMessageInput.getValue();
 413
 414                                 // Add user agent if checkbox is selected
 415                                 if ( this.useragentCheckbox.isSelected() ) {
 416                                         message = userAgentMessage + message;
 417                                 }
 418
 419                                 // Post the message
 420                                 return this.messagePosterPromise.then( function ( poster ) {
 421                                         return fb.postMessage( poster, subject, message );
 422                                 }, function () {
 423                                         fb.status = 'error4';
 424                                         mw.log.warn( 'Feedback report failed because MessagePoster could not be fetched' );
 425                                 } ).always( function () {
 426                                         fb.close();
 427                                 } );
 428                         }, this );
 429                 }
 430                 // Fallback to parent handler
 431                 return mw.Feedback.Dialog.parent.prototype.getActionProcess.call( this, action );
 432         };
 433
 434         /**
 435          * Posts the message
 436          *
 437          * @private
 438          *
 439          * @param {mw.messagePoster.MessagePoster} poster Poster implementation used to leave feedback
 440          * @param {string} subject Subject of message
 441          * @param {string} message Body of message
 442          * @return {jQuery.Promise} Promise representing success of message posting action
 443          */
 444         mw.Feedback.Dialog.prototype.postMessage = function ( poster, subject, message ) {
 445                 var fb = this;
 446
 447                 return poster.post(
 448                         subject,
 449                         message
 450                 ).then( function () {
 451                         fb.status = 'submitted';
 452                 }, function ( mainCode, secondaryCode, details ) {
 453                         if ( mainCode === 'api-fail' ) {
 454                                 if ( secondaryCode === 'http' ) {
 455                                         fb.status = 'error3';
 456                                         // ajax request failed
 457                                         mw.log.warn( 'Feedback report failed with HTTP error: ' +  details.textStatus );
 458                                 } else {
 459                                         fb.status = 'error2';
 460                                         mw.log.warn( 'Feedback report failed with API error: ' +  secondaryCode );
 461                                 }
 462                         } else {
 463                                 fb.status = 'error1';
 464                         }
 465                 } );
 466         };
 467
 468         /**
 469          * @inheritdoc
 470          */
 471         mw.Feedback.Dialog.prototype.getTeardownProcess = function ( data ) {
 472                 return mw.Feedback.Dialog.parent.prototype.getTeardownProcess.call( this, data )
 473                         .first( function () {
 474                                 this.emit( 'submit', this.status, this.feedbackPageName, this.feedbackPageUrl );
 475                                 // Cleanup
 476                                 this.status = '';
 477                                 this.feedbackPageTitle = null;
 478                                 this.feedbackSubjectInput.setValue( '' );
 479                                 this.feedbackMessageInput.setValue( '' );
 480                                 this.useragentCheckbox.setSelected( false );
 481                         }, this );
 482         };
 483
 484         /**
 485          * Set the bug report link
 486          *
 487          * @param {string} link Link to the external bug report form
 488          */
 489         mw.Feedback.Dialog.prototype.setBugReportLink = function ( link ) {
 490                 this.bugReportLink = link;
 491         };
 492
 493         /**
 494          * Get the bug report link
 495          *
 496          * @return {string} Link to the external bug report form
 497          */
 498         mw.Feedback.Dialog.prototype.getBugReportLink = function () {
 499                 return this.bugReportLink;
 500         };
 501
 502 }( mediaWiki, jQuery ) );