forked from mozilla/fxa-content-server
-
Notifications
You must be signed in to change notification settings - Fork 0
/
base.js
499 lines (417 loc) · 13.9 KB
/
base.js
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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
'use strict';
define([
'underscore',
'backbone',
'jquery',
'p-promise',
'lib/session',
'lib/auth-errors',
'lib/fxa-client',
'lib/url',
'lib/strings',
'lib/ephemeral-messages'
],
function (_, Backbone, $, p, Session, AuthErrors, FxaClient, Url, Strings, EphemeralMessages) {
var ENTER_BUTTON_CODE = 13;
var DEFAULT_TITLE = window.document.title;
var EPHEMERAL_MESSAGE_ANIMATION_MS = 150;
// Share one ephemeral messages across all views. View can be
// intialized with an ephemeralMessages for testing.
var ephemeralMessages = new EphemeralMessages();
var BaseView = Backbone.View.extend({
constructor: function (options) {
options = options || {};
this.subviews = [];
this.window = options.window || window;
this.translator = options.translator || this.window.translator;
this.router = options.router || this.window.router;
this.ephemeralMessages = options.ephemeralMessages || ephemeralMessages;
this.fxaClient = new FxaClient();
Backbone.View.call(this, options);
},
/**
* Render the view - Rendering is done asynchronously.
*
* Two functions can be overridden to perform data validation:
* * beforeRender - called before rendering occurs. Can be used
* to perform data validation. Return a promise to
* perform an asynchronous check. Return false or a promise
* that resolves to false to prevent rendering.
* * afterRender - called after the rendering occurs. Can be used
* to print an error message after the view is already rendered.
*/
render: function () {
var self = this;
console.log("Accounts, base view, render called");
return p()
.then(function () {
return self.isUserAuthorized();
})
.then(function (isUserAuthorized) {
if (! isUserAuthorized) {
// user is not authorized, make them sign in.
self.navigate('signin', {
error: t('Session expired. Sign in to continue.')
});
return false;
}
return self.beforeRender();
})
.then(function (shouldRender) {
// rendering is opt out.
if (shouldRender === false) {
return false;
}
return p().then(function () {
self.destroySubviews();
self.$el.html(self.template(self.getContext()));
})
.then(_.bind(self.afterRender, self))
.then(function () {
self.showEphemeralMessages();
self.setTitleFromView();
console.log("Accounts, base view, render called, promise finished?");
return true;
});
});
},
showEphemeralMessages: function () {
var success = this.ephemeralMessages.get('success');
if (success) {
this.displaySuccess(success);
}
var error = this.ephemeralMessages.get('error');
if (error) {
this.displayError(error);
}
},
/**
* Checks if the user is authorized to view the page. Currently
* the only check is if the user is signed in and the page requires
* authentication, but this could be extended to other types of
* authorization as well.
*/
isUserAuthorized: function() {
if (this.mustAuth) {
console.debug('base; validated if isSignedIn to FxA'); // RBx remove me or add trigger to a specialized event listener
return this.fxaClient.isSignedIn(Session.sessionToken);
}
return true;
},
setTitleFromView: function () {
var title = DEFAULT_TITLE;
var titleText = this.$('h1').text();
var subText = this.$('h2').text();
if (titleText && subText) {
title = titleText + ': ' + subText;
} else if (titleText) {
title = titleText;
}
this.window.document.title = title;
},
getContext: function () {
var ctx = this.context() || {};
ctx.t = _.bind(this.translate, this);
return ctx;
},
translate: function () {
var self = this;
return function (text) {
return self.translator.get(text, self.getContext());
};
},
context: function () {
// Implement in subclasses
},
beforeRender: function () {
// Implement in subclasses. If returns false, or if returns a promise
// that resolves to false, then the view is not rendered.
// Useful if the view must immediately redirect to another view.
},
afterRender: function () {
// Implement in subclasses
},
// called after the view is visible.
afterVisible: function () {
// make a huge assumption and say if the device does not have touch,
// it's a desktop device and autofocus can be applied without
// hiding part of the screen. The no-touch class is added by env-test
if ($('html').hasClass('no-touch')) {
// only elements that are visibile can be focused. When embedded in
// about:accounts, the content is hidden when the first "focus" is
// done. Keep trying to focus until the element is actually focused,
// and then stop trying.
var autofocusEl = this.$('[autofocus]');
var self = this;
var attemptFocus = function () {
if (autofocusEl.is(':focus')) {
return;
}
self.focus(autofocusEl);
setTimeout(attemptFocus, 50);
};
attemptFocus();
}
},
assign: function (view, selector) {
view.setElement(this.$(selector));
view.render();
},
destroy: function (remove) {
if (this.beforeDestroy) {
this.beforeDestroy();
}
if (remove) {
this.remove();
} else {
this.stopListening();
this.$el.off();
}
this.destroySubviews();
this.trigger('destroyed');
},
trackSubview: function (view) {
if (!_.contains(this.subviews, view)) {
this.subviews.push(view);
view.on('destroyed', _.bind(this.untrackSubview, this, view));
}
return view;
},
untrackSubview: function (view) {
this.subviews = _.without(this.subviews, view);
return view;
},
destroySubviews: function () {
_.invoke(this.subviews, 'destroy');
this.subviews = [];
},
isSubviewTracked: function (view) {
return _.indexOf(this.subviews, view) > -1;
},
/**
* Display a success message
* @method displaySuccess
* If msg is not given, the contents of the .success element's text
* will not be updated.
*/
displaySuccess: function (msg) {
this.hideError();
if (msg) {
this.$('.success').text(this.translator.get(msg));
}
this.$('.success').slideDown(EPHEMERAL_MESSAGE_ANIMATION_MS);
this.trigger('success', msg);
this._isSuccessVisible = true;
},
hideSuccess: function () {
this.$('.success').slideUp(EPHEMERAL_MESSAGE_ANIMATION_MS);
this._isSuccessVisible = false;
},
/**
* Return true if the success message is visible
*/
isSuccessVisible: function () {
return !!this._isSuccessVisible;
},
/**
* Display an error message.
* @method translateError
* @param {string} err - an error object
* @param {object} errors - optional Errors object that transforms codes into messages
*
* @return {string} translated error text (if available), untranslated
* error text otw.
*/
translateError: function (err, errors) {
errors = errors || AuthErrors;
var msg = errors.toMessage(err);
var context = errors.toContext(err);
var translated = this.translator.get(msg, context);
return translated;
},
/**
* Display an error message.
* @method displayError
* @param {string} err - If err is not given, the contents of the
* `.error` element's text will not be updated.
* @param {object} errors - optional Errors object that transforms codes into messages
*
* @return {string} translated error text (if available), untranslated
* error text otw.
*/
displayError: function (err, errors) {
this.hideSuccess();
this.$('.spinner').hide();
var translated = this.translateError(err, errors);
if (translated) {
this.$('.error').text(translated);
}
this.$('.error').slideDown(EPHEMERAL_MESSAGE_ANIMATION_MS);
this.trigger('error', translated);
this._isErrorVisible = true;
return translated;
},
/**
* Display an error message that may contain HTML. Marked unsafe
* because msg could contain XSS. Use with caution and never
* with unsanitized user generated content.
*
* @method displayErrorUnsafe
* @param {string} err - If err is not given, the contents of the
* `.error` element's text will not be updated.
* @param {object} errors - optional Errors object that transforms codes into messages
*
* @return {string} translated error text (if available), untranslated
* error text otw.
*/
displayErrorUnsafe: function (err, errors) {
this.hideSuccess();
this.$('.spinner').hide();
var translated = this.translateError(err, errors);
if (translated) {
this.$('.error').html(translated);
}
this.$('.error').slideDown(EPHEMERAL_MESSAGE_ANIMATION_MS);
this.trigger('error', translated);
this._isErrorVisible = true;
return translated;
},
hideError: function () {
this.$('.error').slideUp(EPHEMERAL_MESSAGE_ANIMATION_MS);
this._isErrorVisible = false;
},
isErrorVisible: function () {
return !!this._isErrorVisible;
},
back: function (event) {
if (event) {
event.preventDefault();
}
this.window.history.back();
},
backOnEnter: function (event) {
if (event.which === ENTER_BUTTON_CODE) {
this.window.history.back();
}
},
/**
* navigate to another screen
*/
navigate: function (page, options) {
options = options || {};
if (options.success) {
this.ephemeralMessages.set('success', options.success);
}
if (options.error) {
this.ephemeralMessages.set('error', options.error);
}
this.router.navigate(page, { trigger: true });
},
/**
* Safely focus an element
*/
focus: function (which) {
try {
var focusEl = this.$(which);
// place the cursor at the end of the input when the
// element is focused.
focusEl.one('focus', function () {
try {
this.selectionStart = this.selectionEnd = this.value.length;
} catch (e) {
// This can blow up on password fields in Chrome. Drop the error on
// the ground, for whatever reason, it still behaves as we expect.
}
});
focusEl.get(0).focus();
} catch (e) {
// IE can blow up if the element is not visible.
}
},
/**
* Invoke the specified handler with the given event. Handler
* can either be a function or a string. If a string, looks for
* the handler on `this`.
*
* @method invokeHandler
* @param {string || function} handler.
*/
invokeHandler: function (handler/*, args...*/) {
// convert a name to a function.
if (typeof handler === 'string') {
handler = this[handler];
if (typeof handler !== 'function') {
console.warn(handler + ' is an invalid function name');
}
}
if (typeof handler === 'function') {
var args = [].slice.call(arguments, 1);
// If an `arguments` type object was passed in as the first item,
// then use that as the arguments list. Otherwise, use all arguments.
if (_.isArguments(args[0])) {
args = args[0];
}
return handler.apply(this, args);
}
},
/**
* Import an item from the URL search parameters into the current context
*/
importSearchParam: function (itemName) {
var search = this.window.location.search;
this[itemName] = Url.searchParam(itemName, search);
if (! this[itemName]) {
var err = Strings.interpolate(t('missing search parameter: %(itemName)s'), { itemName: itemName });
throw new Error(err);
}
}
});
/**
* Return a backbone compatible event handler that
* prevents the default action, then calls the specified handler.
* @method Baseview.preventDefaultThen
* handler can be either a string or a function. If a string, this[handler]
* will be called. Handler called with context of "this" view and is passed
* the event
*/
BaseView.preventDefaultThen = function (handler) {
return function (event) {
if (event) {
event.preventDefault();
}
var args = [].slice.call(arguments, 0);
args.unshift(handler);
return this.invokeHandler.apply(this, args);
};
};
/**
* Completely cancel an event (preventDefault, stopPropagation), then call
* the handler
* @method BaseView.cancelEventThen
*/
BaseView.cancelEventThen = function (handler) {
return function (event) {
if (event) {
event.preventDefault();
event.stopPropagation();
}
var args = [].slice.call(arguments, 0);
args.unshift(handler);
return this.invokeHandler.apply(this, args);
};
};
/**
* t is a wrapper that is used for string extraction. The extraction
* script looks for t(...), and the translator will eventually
* translate it. t is put onto BaseView instead of
* Translator to reduce the number of dependencies in the views.
*/
function t(str) {
return str;
}
BaseView.t = t;
return BaseView;
});