e1c1b1aa72
Prevent double rendering of attachments by multiple entries into `MessageView::render` using promises.
466 lines
17 KiB
JavaScript
466 lines
17 KiB
JavaScript
/* eslint-disable */
|
||
|
||
/* global Whisper: false */
|
||
|
||
(function () {
|
||
'use strict';
|
||
window.Whisper = window.Whisper || {};
|
||
|
||
const { Attachment } = window.Signal.Types;
|
||
const { context: migrationContext } = window.Signal.Migrations;
|
||
|
||
var URL_REGEX = /(^|[\s\n]|<br\/?>)((?:https?|ftp):\/\/[\-A-Z0-9\u00A0-\uD7FF\uE000-\uFDCF\uFDF0-\uFFFD+\u0026\u2019@#\/%?=()~_|!:,.;]*[\-A-Z0-9+\u0026@#\/%=~()_|])/gi;
|
||
|
||
var ErrorIconView = Whisper.View.extend({
|
||
templateName: 'error-icon',
|
||
className: 'error-icon-container',
|
||
initialize: function() {
|
||
if (this.model.name === 'UnregisteredUserError') {
|
||
this.$el.addClass('unregistered-user-error');
|
||
}
|
||
}
|
||
});
|
||
var NetworkErrorView = Whisper.View.extend({
|
||
tagName: 'span',
|
||
className: 'hasRetry',
|
||
templateName: 'hasRetry',
|
||
render_attributes: function() {
|
||
var messageNotSent;
|
||
|
||
if (!this.model.someRecipientsFailed()) {
|
||
messageNotSent = i18n('messageNotSent');
|
||
}
|
||
|
||
return {
|
||
messageNotSent: messageNotSent,
|
||
resend: i18n('resend')
|
||
};
|
||
}
|
||
});
|
||
var SomeFailedView = Whisper.View.extend({
|
||
tagName: 'span',
|
||
className: 'some-failed',
|
||
templateName: 'some-failed',
|
||
render_attributes: {
|
||
someFailed: i18n('someRecipientsFailed')
|
||
}
|
||
});
|
||
var TimerView = Whisper.View.extend({
|
||
templateName: 'hourglass',
|
||
initialize: function() {
|
||
this.listenTo(this.model, 'unload', this.remove);
|
||
},
|
||
update: function() {
|
||
if (this.timeout) {
|
||
clearTimeout(this.timeout);
|
||
this.timeout = null;
|
||
}
|
||
if (this.model.isExpired()) {
|
||
return this;
|
||
}
|
||
if (this.model.isExpiring()) {
|
||
this.render();
|
||
var totalTime = this.model.get('expireTimer') * 1000;
|
||
var remainingTime = this.model.msTilExpire();
|
||
var elapsed = (totalTime - remainingTime) / totalTime;
|
||
this.$('.sand').css('transform', 'translateY(' + elapsed*100 + '%)');
|
||
this.$el.css('display', 'inline-block');
|
||
this.timeout = setTimeout(this.update.bind(this), Math.max(totalTime / 100, 500));
|
||
}
|
||
return this;
|
||
}
|
||
});
|
||
|
||
Whisper.ExpirationTimerUpdateView = Whisper.View.extend({
|
||
tagName: 'li',
|
||
className: 'expirationTimerUpdate advisory',
|
||
templateName: 'expirationTimerUpdate',
|
||
id: function() {
|
||
return this.model.id;
|
||
},
|
||
initialize: function() {
|
||
this.conversation = this.model.getExpirationTimerUpdateSource();
|
||
this.listenTo(this.conversation, 'change', this.render);
|
||
this.listenTo(this.model, 'unload', this.remove);
|
||
},
|
||
render_attributes: function() {
|
||
var seconds = this.model.get('expirationTimerUpdate').expireTimer;
|
||
var timerMessage;
|
||
|
||
var timerUpdate = this.model.get('expirationTimerUpdate');
|
||
var prettySeconds = Whisper.ExpirationTimerOptions.getName(seconds);
|
||
|
||
if (timerUpdate && timerUpdate.fromSync) {
|
||
timerMessage = i18n('timerSetOnSync', prettySeconds);
|
||
} else if (this.conversation.id === textsecure.storage.user.getNumber()) {
|
||
timerMessage = i18n('youChangedTheTimer', prettySeconds);
|
||
} else {
|
||
timerMessage = i18n('theyChangedTheTimer', [
|
||
this.conversation.getTitle(),
|
||
prettySeconds,
|
||
]);
|
||
}
|
||
return { content: timerMessage };
|
||
}
|
||
});
|
||
|
||
Whisper.KeyChangeView = Whisper.View.extend({
|
||
tagName: 'li',
|
||
className: 'keychange advisory',
|
||
templateName: 'keychange',
|
||
id: function() {
|
||
return this.model.id;
|
||
},
|
||
initialize: function() {
|
||
this.conversation = this.model.getModelForKeyChange();
|
||
this.listenTo(this.conversation, 'change', this.render);
|
||
this.listenTo(this.model, 'unload', this.remove);
|
||
},
|
||
events: {
|
||
'click .content': 'showIdentity'
|
||
},
|
||
render_attributes: function() {
|
||
return {
|
||
content: this.model.getNotificationText()
|
||
};
|
||
},
|
||
showIdentity: function() {
|
||
this.$el.trigger('show-identity', this.conversation);
|
||
}
|
||
});
|
||
|
||
Whisper.VerifiedChangeView = Whisper.View.extend({
|
||
tagName: 'li',
|
||
className: 'verified-change advisory',
|
||
templateName: 'verified-change',
|
||
id: function() {
|
||
return this.model.id;
|
||
},
|
||
initialize: function() {
|
||
this.conversation = this.model.getModelForVerifiedChange();
|
||
this.listenTo(this.conversation, 'change', this.render);
|
||
this.listenTo(this.model, 'unload', this.remove);
|
||
},
|
||
events: {
|
||
'click .content': 'showIdentity'
|
||
},
|
||
render_attributes: function() {
|
||
var key;
|
||
|
||
if (this.model.get('verified')) {
|
||
if (this.model.get('local')) {
|
||
key = 'youMarkedAsVerified';
|
||
} else {
|
||
key = 'youMarkedAsVerifiedOtherDevice';
|
||
}
|
||
return {
|
||
icon: 'verified',
|
||
content: i18n(key, this.conversation.getTitle())
|
||
};
|
||
}
|
||
|
||
if (this.model.get('local')) {
|
||
key = 'youMarkedAsNotVerified';
|
||
} else {
|
||
key = 'youMarkedAsNotVerifiedOtherDevice';
|
||
}
|
||
|
||
return {
|
||
icon: 'shield',
|
||
content: i18n(key, this.conversation.getTitle())
|
||
};
|
||
},
|
||
showIdentity: function() {
|
||
this.$el.trigger('show-identity', this.conversation);
|
||
}
|
||
});
|
||
|
||
Whisper.MessageView = Whisper.View.extend({
|
||
tagName: 'li',
|
||
templateName: 'message',
|
||
id: function() {
|
||
return this.model.id;
|
||
},
|
||
initialize: function() {
|
||
// loadedAttachmentViews :: Promise (Array AttachmentView) | null
|
||
this.loadedAttachmentViews = null;
|
||
|
||
this.listenTo(this.model, 'change:errors', this.onErrorsChanged);
|
||
this.listenTo(this.model, 'change:body', this.render);
|
||
this.listenTo(this.model, 'change:delivered', this.renderDelivered);
|
||
this.listenTo(this.model, 'change:read_by', this.renderRead);
|
||
this.listenTo(this.model, 'change:expirationStartTimestamp', this.renderExpiring);
|
||
this.listenTo(this.model, 'change', this.renderSent);
|
||
this.listenTo(this.model, 'change:flags change:group_update', this.renderControl);
|
||
this.listenTo(this.model, 'destroy', this.onDestroy);
|
||
this.listenTo(this.model, 'unload', this.onUnload);
|
||
this.listenTo(this.model, 'expired', this.onExpired);
|
||
this.listenTo(this.model, 'pending', this.renderPending);
|
||
this.listenTo(this.model, 'done', this.renderDone);
|
||
this.timeStampView = new Whisper.ExtendedTimestampView();
|
||
|
||
this.contact = this.model.isIncoming() ? this.model.getContact() : null;
|
||
if (this.contact) {
|
||
this.listenTo(this.contact, 'change:color', this.updateColor);
|
||
}
|
||
},
|
||
events: {
|
||
'click .retry': 'retryMessage',
|
||
'click .error-icon': 'select',
|
||
'click .timestamp': 'select',
|
||
'click .status': 'select',
|
||
'click .some-failed': 'select',
|
||
'click .error-message': 'select'
|
||
},
|
||
retryMessage: function() {
|
||
var retrys = _.filter(this.model.get('errors'),
|
||
this.model.isReplayableError.bind(this.model));
|
||
_.map(retrys, 'number').forEach(function(number) {
|
||
this.model.resend(number);
|
||
}.bind(this));
|
||
},
|
||
onExpired: function() {
|
||
this.$el.addClass('expired');
|
||
this.$el.find('.bubble').one('webkitAnimationEnd animationend', function(e) {
|
||
if (e.target === this.$('.bubble')[0]) {
|
||
this.remove();
|
||
}
|
||
}.bind(this));
|
||
|
||
// Failsafe: if in the background, animation events don't fire
|
||
setTimeout(this.remove.bind(this), 1000);
|
||
},
|
||
/* jshint ignore:start */
|
||
onUnload: async function() {
|
||
if (this.avatarView) {
|
||
this.avatarView.remove();
|
||
}
|
||
if (this.errorIconView) {
|
||
this.errorIconView.remove();
|
||
}
|
||
if (this.networkErrorView) {
|
||
this.networkErrorView.remove();
|
||
}
|
||
if (this.someFailedView) {
|
||
this.someFailedView.remove();
|
||
}
|
||
if (this.timeStampView) {
|
||
this.timeStampView.remove();
|
||
}
|
||
|
||
const views = await this.loadedAttachmentViews;
|
||
views.forEach(view => view.unload());
|
||
|
||
// No need to handle this one, since it listens to 'unload' itself:
|
||
// this.timerView
|
||
|
||
this.remove();
|
||
},
|
||
/* jshint ignore:end */
|
||
onDestroy: function() {
|
||
if (this.$el.hasClass('expired')) {
|
||
return;
|
||
}
|
||
this.onUnload();
|
||
},
|
||
select: function(e) {
|
||
this.$el.trigger('select', {message: this.model});
|
||
e.stopPropagation();
|
||
},
|
||
className: function() {
|
||
return ['entry', this.model.get('type')].join(' ');
|
||
},
|
||
renderPending: function() {
|
||
this.$el.addClass('pending');
|
||
},
|
||
renderDone: function() {
|
||
this.$el.removeClass('pending');
|
||
},
|
||
renderSent: function() {
|
||
if (this.model.isOutgoing()) {
|
||
this.$el.toggleClass('sent', !!this.model.get('sent'));
|
||
}
|
||
},
|
||
renderDelivered: function() {
|
||
if (this.model.get('delivered')) { this.$el.addClass('delivered'); }
|
||
},
|
||
renderRead: function() {
|
||
if (!_.isEmpty(this.model.get('read_by'))) {
|
||
this.$el.addClass('read');
|
||
}
|
||
},
|
||
onErrorsChanged: function() {
|
||
if (this.model.isIncoming()) {
|
||
this.render();
|
||
} else {
|
||
this.renderErrors();
|
||
}
|
||
},
|
||
renderErrors: function() {
|
||
var errors = this.model.get('errors');
|
||
|
||
|
||
this.$('.error-icon-container').remove();
|
||
if (this.errorIconView) {
|
||
this.errorIconView.remove();
|
||
this.errorIconView = null;
|
||
}
|
||
if (_.size(errors) > 0) {
|
||
if (this.model.isIncoming()) {
|
||
this.$('.content').text(this.model.getDescription()).addClass('error-message');
|
||
}
|
||
this.errorIconView = new ErrorIconView({ model: errors[0] });
|
||
this.errorIconView.render().$el.appendTo(this.$('.bubble'));
|
||
}
|
||
|
||
this.$('.meta .hasRetry').remove();
|
||
if (this.networkErrorView) {
|
||
this.networkErrorView.remove();
|
||
this.networkErrorView = null;
|
||
}
|
||
if (this.model.hasNetworkError()) {
|
||
this.networkErrorView = new NetworkErrorView({model: this.model});
|
||
this.$('.meta').prepend(this.networkErrorView.render().el);
|
||
}
|
||
|
||
this.$('.meta .some-failed').remove();
|
||
if (this.someFailedView) {
|
||
this.someFailedView.remove();
|
||
this.someFailedView = null;
|
||
}
|
||
if (this.model.someRecipientsFailed()) {
|
||
this.someFailedView = new SomeFailedView();
|
||
this.$('.meta').prepend(this.someFailedView.render().el);
|
||
}
|
||
},
|
||
renderControl: function() {
|
||
if (this.model.isEndSession() || this.model.isGroupUpdate()) {
|
||
this.$el.addClass('control');
|
||
var content = this.$('.content');
|
||
content.text(this.model.getDescription());
|
||
emoji_util.parse(content);
|
||
} else {
|
||
this.$el.removeClass('control');
|
||
}
|
||
},
|
||
renderExpiring: function() {
|
||
if (!this.timerView) {
|
||
this.timerView = new TimerView({ model: this.model });
|
||
}
|
||
this.timerView.setElement(this.$('.timer'));
|
||
this.timerView.update();
|
||
},
|
||
render: function() {
|
||
var contact = this.model.isIncoming() ? this.model.getContact() : null;
|
||
this.$el.html(
|
||
Mustache.render(_.result(this, 'template', ''), {
|
||
message: this.model.get('body'),
|
||
timestamp: this.model.get('sent_at'),
|
||
sender: (contact && contact.getTitle()) || '',
|
||
avatar: (contact && contact.getAvatar()),
|
||
profileName: (contact && contact.getProfileName()),
|
||
}, this.render_partials())
|
||
);
|
||
this.timeStampView.setElement(this.$('.timestamp'));
|
||
this.timeStampView.update();
|
||
|
||
this.renderControl();
|
||
|
||
var body = this.$('.body');
|
||
|
||
emoji_util.parse(body);
|
||
|
||
if (body.length > 0) {
|
||
var escaped = body.html();
|
||
body.html(escaped.replace(/\n/g, '<br>').replace(URL_REGEX, "$1<a href='$2' target='_blank'>$2</a>"));
|
||
}
|
||
|
||
this.renderSent();
|
||
this.renderDelivered();
|
||
this.renderRead();
|
||
this.renderErrors();
|
||
this.renderExpiring();
|
||
|
||
|
||
// NOTE: We have to do this in the background (`then` instead of `await`)
|
||
// as our code / Backbone seems to rely on `render` synchronously returning
|
||
// `this` instead of `Promise MessageView` (this):
|
||
// eslint-disable-next-line more/no-then
|
||
this.loadAttachmentViews().then(views => this.renderAttachmentViews(views));
|
||
|
||
return this;
|
||
},
|
||
updateColor: function() {
|
||
var bubble = this.$('.bubble');
|
||
|
||
// this.contact is known to be non-null if we're registered for color changes
|
||
var color = this.contact.getColor();
|
||
if (color) {
|
||
bubble.removeClass(Whisper.Conversation.COLORS);
|
||
bubble.addClass(color);
|
||
}
|
||
this.avatarView = new (Whisper.View.extend({
|
||
templateName: 'avatar',
|
||
render_attributes: { avatar: this.contact.getAvatar() }
|
||
}))();
|
||
this.$('.avatar').replaceWith(this.avatarView.render().$('.avatar'));
|
||
},
|
||
/* eslint-enable */
|
||
/* jshint ignore:start */
|
||
loadAttachmentViews() {
|
||
if (this.loadedAttachmentViews !== null) {
|
||
return this.loadedAttachmentViews;
|
||
}
|
||
|
||
const loadData = Attachment.loadData(migrationContext.readAttachmentData);
|
||
const attachments = this.model.get('attachments');
|
||
const loadedAttachmentViews = Promise.all(attachments.map(attachment =>
|
||
new Promise(async (resolve) => {
|
||
const attachmentWithData = await loadData(attachment);
|
||
const view = new Whisper.AttachmentView({
|
||
model: attachmentWithData,
|
||
timestamp: this.model.get('sent_at'),
|
||
});
|
||
|
||
this.listenTo(view, 'update', () => {
|
||
// NOTE: Can we do without `updated` flag now that we use promises?
|
||
view.updated = true;
|
||
resolve(view);
|
||
});
|
||
|
||
view.render();
|
||
})));
|
||
|
||
// Memoize attachment views to avoid double loading:
|
||
this.loadedAttachmentViews = loadedAttachmentViews;
|
||
|
||
return loadedAttachmentViews;
|
||
},
|
||
renderAttachmentViews(views) {
|
||
views.forEach(view => this.renderAttachmentView(view));
|
||
},
|
||
renderAttachmentView(view) {
|
||
if (!view.updated) {
|
||
throw new Error('Invariant violation:' +
|
||
' Cannot render an attachment view that isn’t ready');
|
||
}
|
||
|
||
const parent = this.$('.attachments')[0];
|
||
const isViewAlreadyChild = parent === view.el.parentNode;
|
||
if (isViewAlreadyChild) {
|
||
return;
|
||
}
|
||
|
||
if (view.el.parentNode) {
|
||
view.el.parentNode.removeChild(view.el);
|
||
}
|
||
|
||
this.trigger('beforeChangeHeight');
|
||
this.$('.attachments').append(view.el);
|
||
view.setElement(view.el);
|
||
this.trigger('afterChangeHeight');
|
||
},
|
||
/* jshint ignore:end */
|
||
/* eslint-disable */
|
||
});
|
||
})();
|