X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=resources%2Fmediawiki%2Fmediawiki.feedback.js;h=1afe51eff6fd1659bb5d9aad374f279ccf018f31;hb=4d8cff99e75c690a418dd887152d90b9d08844ad;hp=8a9435ec7da9754cf82d3af3039cd36d1f754ff8;hpb=7047be59eb3afcff1d8f5a91f5906d6d9b1c2167;p=lhc%2Fweb%2Fwiklou.git diff --git a/resources/mediawiki/mediawiki.feedback.js b/resources/mediawiki/mediawiki.feedback.js index 8a9435ec7d..1afe51eff6 100644 --- a/resources/mediawiki/mediawiki.feedback.js +++ b/resources/mediawiki/mediawiki.feedback.js @@ -1,45 +1,43 @@ -/** - * mediawiki.Feedback +/** + * mediawiki.feedback * * @author Ryan Kaldari, 2010 * @author Neil Kandalgaonkar, 2010-11 * @since 1.19 * * This is a way of getting simple feedback from users. It's useful - * for testing new features -- users can give you feedback without + * for testing new features -- users can give you feedback without * the difficulty of opening a whole new talk page. For this reason, * it also tends to collect a wider range of both positive and negative - * comments. However you do need to tend to the feedback page. It will - * get long relatively quickly, and you often get multiple messages + * comments. However you do need to tend to the feedback page. It will + * get long relatively quickly, and you often get multiple messages * reporting the same issue. * * It takes the form of thing on your page which, when clicked, opens a small - * dialog box. Submitting that dialog box appends its contents to a + * dialog box. Submitting that dialog box appends its contents to a * wiki page that you specify, as a new section. * * Not compatible with LiquidThreads. - * + * * Minimal example in how to use it: - * + * * var feedback = new mw.Feedback(); - * $( '#myButton' ).click( function() { feedback.launch(); } ); - * - * You can also launch the feedback form with a prefilled subject and body. - * See the docs for the launch() method. + * $( '#myButton' ).click( function () { feedback.launch(); } ); + * + * You can also launch the feedback form with a prefilled subject and body. + * See the docs for the launch() method. */ -( function( mw, $, undefined ) { - +( function ( mw, $ ) { /** * Thingy for collecting user feedback on a wiki page * @param {Array} options -- optional, all properties optional. - * api: {mw.Api} if omitted, will just create a standard API - * title: {mw.Title} the title of the page where you collect feedback. Defaults to "Feedback". - * dialogTitleMessageKey: {String} message key for the title of the dialog box - * bugsLink: {mw.Uri|String} url where bugs can be posted - * bugsListLink: {mw.Uri|String} url where bugs can be listed + * api: {mw.Api} if omitted, will just create a standard API + * title: {mw.Title} the title of the page where you collect feedback. Defaults to "Feedback". + * dialogTitleMessageKey: {String} message key for the title of the dialog box + * bugsLink: {mw.Uri|String} url where bugs can be posted + * bugsListLink: {mw.Uri|String} url where bugs can be listed */ - mw.Feedback = function( options ) { - + mw.Feedback = function ( options ) { if ( options === undefined ) { options = {}; } @@ -69,162 +67,200 @@ }; mw.Feedback.prototype = { - setup: function() { - var _this = this; - - - var $feedbackPageLink = $( '' ) - .attr( { 'href': _this.title.getUrl(), 'target': '_blank' } ) - .css( { 'white-space': 'nowrap' } ); - - var $bugNoteLink = $( '' ).attr( { 'href': '#' } ).click( function() { _this.displayBugs(); } ); - - var $bugsListLink = $( '' ).attr( { 'href': _this.bugsListLink, 'target': '_blank' } ); - - this.$dialog = - $( '
' ).append( + setup: function () { + var $feedbackPageLink, + $bugNoteLink, + $bugsListLink, + fb = this; + + $feedbackPageLink = $( '' ) + .attr( { + href: fb.title.getUrl(), + target: '_blank' + } ) + .css( { + whiteSpace: 'nowrap' + } ); + + $bugNoteLink = $( '' ).attr( { href: '#' } ).click( function () { + fb.displayBugs(); + } ); + + $bugsListLink = $( '' ).attr( { + href: fb.bugsListLink, + target: '_blank' + } ); + + // TODO: Use a stylesheet instead of these inline styles + this.$dialog = + $( '
' ).append( $( '
' ).append( - $( '' ).append( - $( '

' ).msg( - 'feedback-bugornote', + $( '' ).append( + $( '

' ).msg( + 'feedback-bugornote', $bugNoteLink, - _this.title.getNameText(), - $feedbackPageLink.clone() + fb.title.getNameText(), + $feedbackPageLink.clone() ) ), - $( '

' ).append( - mw.msg( 'feedback-subject' ), - $( '
' ), - $( '' ) + $( '
' ).append( + mw.msg( 'feedback-subject' ), + $( '
' ), + $( '' ) ), - $( '
' ).append( - mw.msg( 'feedback-message' ), - $( '
' ), - $( '' ) + $( '
' ).append( + mw.msg( 'feedback-message' ), + $( '
' ), + $( '' ) ) ), - $( '' ).append( + $( '' ).append( $( '

' ).msg( 'feedback-bugcheck', $bugsListLink ) ), - $( '

' ).append( - mw.msg( 'feedback-adding' ), - $( '
' ), - $( '' ) + $( '' ).append( + mw.msg( 'feedback-adding' ), + $( '
' ), + $( '' ) ), - $( '' ).msg( - 'feedback-thanks', _this.title.getNameText(), $feedbackPageLink.clone() + $( '' ).msg( + 'feedback-thanks', fb.title.getNameText(), $feedbackPageLink.clone() ), - $( '' ).append( - $( '' ) + $( '' ).append( + $( '' ) ) ); // undo some damage from dialog css - this.$dialog.find( 'a' ).css( { 'color': '#0645ad' } ); + this.$dialog.find( 'a' ).css( { + color: '#0645ad' + } ); this.$dialog.dialog({ width: 500, autoOpen: false, title: mw.msg( this.dialogTitleMessageKey ), modal: true, - buttons: _this.buttons - }); + buttons: fb.buttons + }); this.subjectInput = this.$dialog.find( 'input.feedback-subject' ).get(0); this.messageInput = this.$dialog.find( 'textarea.feedback-message' ).get(0); }, - display: function( s ) { + display: function ( s ) { this.$dialog.dialog( { buttons:{} } ); // hide the buttons this.$dialog.find( '.feedback-mode' ).hide(); // hide everything - this.$dialog.find( '.feedback-' + s ).show(); // show the desired div + this.$dialog.find( '.feedback-' + s ).show(); // show the desired div }, - displaySubmitting: function() { + displaySubmitting: function () { this.display( 'submitting' ); }, - displayBugs: function() { - var _this = this; + displayBugs: function () { + var fb = this, + bugsButtons = {}; this.display( 'bugs' ); - var bugsButtons = {}; - bugsButtons[ mw.msg( 'feedback-bugnew' ) ] = function() { window.open( _this.bugsLink, '_blank' ); }; - bugsButtons[ mw.msg( 'feedback-cancel' ) ] = function() { _this.cancel(); }; - this.$dialog.dialog( { buttons: bugsButtons } ); + bugsButtons[ mw.msg( 'feedback-bugnew' ) ] = function () { + window.open( fb.bugsLink, '_blank' ); + }; + bugsButtons[ mw.msg( 'feedback-cancel' ) ] = function () { + fb.cancel(); + }; + this.$dialog.dialog( { + buttons: bugsButtons + } ); }, - displayThanks: function() { - var _this = this; + displayThanks: function () { + var fb = this, + closeButton = {}; this.display( 'thanks' ); - var closeButton = {}; - closeButton[ mw.msg( 'feedback-close' ) ] = function() { _this.$dialog.dialog( 'close' ); }; - this.$dialog.dialog( { buttons: closeButton } ); + closeButton[ mw.msg( 'feedback-close' ) ] = function () { + fb.$dialog.dialog( 'close' ); + }; + this.$dialog.dialog( { + buttons: closeButton + } ); }, /** * Display the feedback form * @param {Object} optional prefilled contents for the feedback form. Object with properties: - * subject: {String} - * message: {String} + * subject: {String} + * message: {String} */ - displayForm: function( contents ) { - var _this = this; - this.subjectInput.value = (contents && contents.subject) ? contents.subject : ''; - this.messageInput.value = (contents && contents.message) ? contents.message : ''; - - this.display( 'form' ); + displayForm: function ( contents ) { + var fb = this, + formButtons = {}; + this.subjectInput.value = ( contents && contents.subject ) ? contents.subject : ''; + this.messageInput.value = ( contents && contents.message ) ? contents.message : ''; + + this.display( 'form' ); // Set up buttons for dialog box. We have to do it the hard way since the json keys are localized - var formButtons = {}; - formButtons[ mw.msg( 'feedback-submit' ) ] = function() { _this.submit(); }; - formButtons[ mw.msg( 'feedback-cancel' ) ] = function() { _this.cancel(); }; + formButtons[ mw.msg( 'feedback-submit' ) ] = function () { + fb.submit(); + }; + formButtons[ mw.msg( 'feedback-cancel' ) ] = function () { + fb.cancel(); + }; this.$dialog.dialog( { buttons: formButtons } ); // put the buttons back }, - displayError: function( message ) { + displayError: function ( message ) { + var fb = this, + closeButton = {}; this.display( 'error' ); - this.$dialog.find( '.feedback-error-msg' ).msg( message ); + this.$dialog.find( '.feedback-error-msg' ).msg( message ); + closeButton[ mw.msg( 'feedback-close' ) ] = function () { + fb.$dialog.dialog( 'close' ); + }; + this.$dialog.dialog( { buttons: closeButton } ); }, - cancel: function() { + cancel: function () { this.$dialog.dialog( 'close' ); }, - submit: function() { - var _this = this; - - // get the values to submit - var subject = this.subjectInput.value; - - var message = "User agent: " + navigator.userAgent + "\n\n" - + this.messageInput.value; - if ( message.indexOf( '~~~' ) == -1 ) { - message += " ~~~~"; - } - - this.displaySubmitting(); + submit: function () { + var subject, message, + fb = this; - var ok = function( result ) { + function ok( result ) { if ( result.edit !== undefined ) { if ( result.edit.result === 'Success' ) { - _this.displayThanks(); + fb.displayThanks(); } else { - _this.displayError( 'feedback-error1' ); // unknown API result + // unknown API result + fb.displayError( 'feedback-error1' ); } } else { - displayError( 'feedback-error2' ); // edit failed + // edit failed + fb.displayError( 'feedback-error2' ); } - }; + } - var err = function( code, info ) { - displayError( 'feedback-error3' ); // ajax request failed - }; - - this.api.newSection( this.title, subject, message, ok, err ); + function err() { + // ajax request failed + fb.displayError( 'feedback-error3' ); + } - }, // close submit button function + // Get the values to submit. + subject = this.subjectInput.value; + // We used to include "mw.html.escape( navigator.userAgent )" but there are legal issues + // with posting this without their explicit consent + message = this.messageInput.value; + if ( message.indexOf( '~~~' ) === -1 ) { + message += ' ~~~~'; + } + + this.displaySubmitting(); + + this.api.newSection( this.title, subject, message, ok, err ); + }, /** * Modify the display form, and then open it, focusing interface on the subject. @@ -232,13 +268,12 @@ * subject: {String} * message: {String} */ - launch: function( contents ) { + launch: function ( contents ) { this.displayForm( contents ); this.$dialog.dialog( 'open' ); this.subjectInput.focus(); - } + } }; - -} )( window.mediaWiki, jQuery ); +}( mediaWiki, jQuery ) );