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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
/**
* 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
* 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
* 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
* 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.
*/
( 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
*/
mw.Feedback = function ( options ) {
if ( options === undefined ) {
options = {};
}
if ( options.api === undefined ) {
options.api = new mw.Api();
}
if ( options.title === undefined ) {
options.title = new mw.Title( 'Feedback' );
}
if ( options.dialogTitleMessageKey === undefined ) {
options.dialogTitleMessageKey = 'feedback-submit';
}
if ( options.bugsLink === undefined ) {
options.bugsLink = '//bugzilla.wikimedia.org/enter_bug.cgi';
}
if ( options.bugsListLink === undefined ) {
options.bugsListLink = '//bugzilla.wikimedia.org/query.cgi';
}
$.extend( this, options );
this.setup();
};
mw.Feedback.prototype = {
setup: function () {
var fb = this;
var $feedbackPageLink = $( '<a>' )
.attr( { 'href': fb.title.getUrl(), 'target': '_blank' } )
.css( { 'white-space': 'nowrap' } );
var $bugNoteLink = $( '<a>' ).attr( { 'href': '#' } ).click( function () {
fb.displayBugs();
} );
var $bugsListLink = $( '<a>' ).attr( { 'href': fb.bugsListLink, 'target': '_blank' } );
// TODO: Use a stylesheet instead of these inline styles
this.$dialog =
$( '<div style="position: relative;"></div>' ).append(
$( '<div class="feedback-mode feedback-form"></div>' ).append(
$( '<small>' ).append(
$( '<p>' ).msg(
'feedback-bugornote',
$bugNoteLink,
fb.title.getNameText(),
$feedbackPageLink.clone()
)
),
$( '<div style="margin-top: 1em;"></div>' ).append(
mw.msg( 'feedback-subject' ),
$( '<br>' ),
$( '<input type="text" class="feedback-subject" name="subject" maxlength="60" style="width: 99%;"/>' )
),
$( '<div style="margin-top: 0.4em;"></div>' ).append(
mw.msg( 'feedback-message' ),
$( '<br>' ),
$( '<textarea name="message" class="feedback-message" style="width: 99%;" rows="5" cols="60"></textarea>' )
)
),
$( '<div class="feedback-mode feedback-bugs"></div>' ).append(
$( '<p>' ).msg( 'feedback-bugcheck', $bugsListLink )
),
$( '<div class="feedback-mode feedback-submitting" style="text-align: center; margin: 3em 0;"></div>' ).append(
mw.msg( 'feedback-adding' ),
$( '<br/>' ),
$( '<span class="feedback-spinner"></span>' )
),
$( '<div class="feedback-mode feedback-thanks" style="text-align: center; margin:1em"></div>' ).msg(
'feedback-thanks', fb.title.getNameText(), $feedbackPageLink.clone()
),
$( '<div class="feedback-mode feedback-error" style="position: relative;"></div>' ).append(
$( '<div class="feedback-error-msg style="color: #990000; margin-top: 0.4em;"></div>' )
)
);
// undo some damage from dialog css
this.$dialog.find( 'a' ).css( {
color: '#0645ad'
} );
this.$dialog.dialog({
width: 500,
autoOpen: false,
title: mw.msg( this.dialogTitleMessageKey ),
modal: true,
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 ) {
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
},
displaySubmitting: function () {
this.display( 'submitting' );
},
displayBugs: function () {
var fb = this;
this.display( 'bugs' );
var 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 fb = this;
this.display( 'thanks' );
var 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}
*/
displayForm: function ( contents ) {
var fb = this;
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 () {
fb.submit();
};
formButtons[ mw.msg( 'feedback-cancel' ) ] = function () {
fb.cancel();
};
this.$dialog.dialog( { buttons: formButtons } ); // put the buttons back
},
displayError: function ( message ) {
var fb = this;
this.display( 'error' );
this.$dialog.find( '.feedback-error-msg' ).msg( message );
var closeButton = {};
closeButton[ mw.msg( 'feedback-close' ) ] = function () {
fb.$dialog.dialog( 'close' );
};
this.$dialog.dialog( { buttons: closeButton } );
},
cancel: function () {
this.$dialog.dialog( 'close' );
},
submit: function () {
var subject, message,
fb = this;
function ok( result ) {
if ( result.edit !== undefined ) {
if ( result.edit.result === 'Success' ) {
fb.displayThanks();
} else {
// unknown API result
fb.displayError( 'feedback-error1' );
}
} else {
// edit failed
fb.displayError( 'feedback-error2' );
}
}
function err( code, info ) {
// ajax request failed
fb.displayError( 'feedback-error3' );
}
// 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.
* @param {Object} optional prefilled contents for the feedback form. Object with properties:
* subject: {String}
* message: {String}
*/
launch: function ( contents ) {
this.displayForm( contents );
this.$dialog.dialog( 'open' );
this.subjectInput.focus();
}
};
}( mediaWiki, jQuery ) );
|
