375 lines
16 KiB
JavaScript
375 lines
16 KiB
JavaScript
/**
|
|
* @module converse-message-view
|
|
* @copyright 2020, the Converse.js contributors
|
|
* @license Mozilla Public License (MPLv2)
|
|
*/
|
|
import "./utils/html";
|
|
import "@converse/headless/converse-emoji";
|
|
import URI from "urijs";
|
|
import converse from "@converse/headless/converse-core";
|
|
import { BootstrapModal } from "./converse-modal.js";
|
|
import { debounce } from 'lodash'
|
|
import { render } from "lit-html";
|
|
import filesize from "filesize";
|
|
import log from "@converse/headless/log";
|
|
import tpl_file_progress from "templates/file_progress.html";
|
|
import tpl_info from "templates/info.html";
|
|
import tpl_message from "templates/message.html";
|
|
import tpl_message_versions_modal from "templates/message_versions_modal.js";
|
|
import tpl_spinner from "templates/spinner.html";
|
|
import xss from "xss/dist/xss";
|
|
|
|
const { Strophe, dayjs } = converse.env;
|
|
const u = converse.env.utils;
|
|
|
|
|
|
converse.plugins.add('converse-message-view', {
|
|
|
|
dependencies: ["converse-modal", "converse-chatboxviews"],
|
|
|
|
initialize () {
|
|
/* The initialize function gets called as soon as the plugin is
|
|
* loaded by converse.js's plugin machinery.
|
|
*/
|
|
const { _converse } = this;
|
|
const { api } = _converse;
|
|
const { __ } = _converse;
|
|
|
|
|
|
function onTagFoundDuringXSSFilter (tag, html, options) {
|
|
/* This function gets called by the XSS library whenever it finds
|
|
* what it thinks is a new HTML tag.
|
|
*
|
|
* It thinks that something like <https://example.com> is an HTML
|
|
* tag and then escapes the <> chars.
|
|
*
|
|
* We want to avoid this, because it prevents these URLs from being
|
|
* shown properly (whithout the trailing >).
|
|
*
|
|
* The URI lib correctly trims a trailing >, but not a trailing >
|
|
*/
|
|
if (options.isClosing) {
|
|
// Closing tags don't match our use-case
|
|
return;
|
|
}
|
|
const uri = new URI(tag);
|
|
const protocol = uri.protocol().toLowerCase();
|
|
if (!["https", "http", "xmpp", "ftp"].includes(protocol)) {
|
|
// Not a URL, the tag will get filtered as usual
|
|
return;
|
|
}
|
|
if (uri.equals(tag) && `<${tag}>` === html.toLocaleLowerCase()) {
|
|
// We have something like <https://example.com>, and don't want
|
|
// to filter it.
|
|
return html;
|
|
}
|
|
}
|
|
|
|
|
|
api.settings.update({
|
|
'muc_hats_from_vcard': false,
|
|
'show_images_inline': true,
|
|
'time_format': 'HH:mm',
|
|
});
|
|
|
|
_converse.MessageVersionsModal = BootstrapModal.extend({
|
|
id: "message-versions-modal",
|
|
toHTML () {
|
|
return tpl_message_versions_modal(this.model.toJSON());
|
|
}
|
|
});
|
|
|
|
|
|
/**
|
|
* @class
|
|
* @namespace _converse.MessageView
|
|
* @memberOf _converse
|
|
*/
|
|
_converse.MessageView = _converse.ViewWithAvatar.extend({
|
|
events: {
|
|
'click .chat-msg__edit-modal': 'showMessageVersionsModal',
|
|
'click .retry': 'onRetryClicked'
|
|
},
|
|
|
|
initialize () {
|
|
this.debouncedRender = debounce(() => {
|
|
// If the model gets destroyed in the meantime,
|
|
// it no longer has a collection
|
|
if (this.model.collection) {
|
|
this.render();
|
|
}
|
|
}, 50);
|
|
|
|
if (this.model.rosterContactAdded) {
|
|
this.model.rosterContactAdded.then(() => {
|
|
this.listenTo(this.model.contact, 'change:nickname', this.debouncedRender);
|
|
this.debouncedRender();
|
|
});
|
|
}
|
|
|
|
if (this.model.occupant) {
|
|
this.listenTo(this.model.occupant, 'change:affiliation', this.debouncedRender);
|
|
this.listenTo(this.model.occupant, 'change:hats', this.debouncedRender);
|
|
this.listenTo(this.model.occupant, 'change:role', this.debouncedRender);
|
|
this.debouncedRender();
|
|
}
|
|
|
|
this.listenTo(this.model, 'change', this.onChanged);
|
|
this.listenTo(this.model, 'destroy', this.fadeOut);
|
|
this.listenTo(this.model, 'vcard:change', this.debouncedRender);
|
|
},
|
|
|
|
async render () {
|
|
const is_followup = u.hasClass('chat-msg--followup', this.el);
|
|
if (this.model.get('file') && !this.model.get('oob_url')) {
|
|
if (!this.model.file) {
|
|
log.error("Attempted to render a file upload message with no file data");
|
|
return this.el;
|
|
}
|
|
this.renderFileUploadProgresBar();
|
|
} else if (this.model.get('type') === 'error') {
|
|
this.renderErrorMessage();
|
|
} else if (this.model.get('type') === 'info') {
|
|
this.renderInfoMessage();
|
|
} else {
|
|
await this.renderChatMessage();
|
|
}
|
|
is_followup && u.addClass('chat-msg--followup', this.el);
|
|
return this.el;
|
|
},
|
|
|
|
async onChanged (item) {
|
|
// Jot down whether it was edited because the `changed`
|
|
// attr gets removed when this.render() gets called further down.
|
|
const edited = item.changed.edited;
|
|
if (this.model.changed.progress) {
|
|
return this.renderFileUploadProgresBar();
|
|
}
|
|
const isValidChange = prop => Object.prototype.hasOwnProperty.call(this.model.changed, prop);
|
|
const props = ['moderated', 'retracted', 'correcting', 'message', 'type', 'upload', 'received', 'editable'];
|
|
if (props.filter(isValidChange).length) {
|
|
await this.debouncedRender();
|
|
}
|
|
if (edited) {
|
|
this.onMessageEdited();
|
|
}
|
|
},
|
|
|
|
fadeOut () {
|
|
if (api.settings.get('animate')) {
|
|
setTimeout(() => this.remove(), 600);
|
|
u.addClass('fade-out', this.el);
|
|
} else {
|
|
this.remove();
|
|
}
|
|
},
|
|
|
|
async onRetryClicked () {
|
|
this.showSpinner();
|
|
await this.model.error.retry();
|
|
this.model.destroy();
|
|
},
|
|
|
|
showSpinner () {
|
|
this.el.innerHTML = tpl_spinner();
|
|
},
|
|
|
|
onMessageEdited () {
|
|
if (this.model.get('is_archived')) {
|
|
return;
|
|
}
|
|
this.el.addEventListener(
|
|
'animationend',
|
|
() => u.removeClass('onload', this.el),
|
|
{'once': true}
|
|
);
|
|
u.addClass('onload', this.el);
|
|
},
|
|
|
|
replaceElement (msg) {
|
|
if (this.el.parentElement) {
|
|
this.el.parentElement.replaceChild(msg, this.el);
|
|
}
|
|
this.setElement(msg);
|
|
return this.el;
|
|
},
|
|
|
|
transformOOBURL (url) {
|
|
return u.getOOBURLMarkup(_converse, url);
|
|
},
|
|
|
|
async transformBodyText (text) {
|
|
/**
|
|
* Synchronous event which provides a hook for transforming a chat message's body text
|
|
* before the default transformations have been applied.
|
|
* @event _converse#beforeMessageBodyTransformed
|
|
* @param { _converse.MessageView } view - The view representing the message
|
|
* @param { string } text - The message text
|
|
* @example _converse.api.listen.on('beforeMessageBodyTransformed', (view, text) => { ... });
|
|
*/
|
|
await api.trigger('beforeMessageBodyTransformed', this, text, {'Synchronous': true});
|
|
text = this.model.isMeCommand() ? text.substring(4) : text;
|
|
text = xss.filterXSS(text, {'whiteList': {}, 'onTag': onTagFoundDuringXSSFilter});
|
|
text = u.geoUriToHttp(text, api.settings.get("geouri_replacement"));
|
|
text = u.addMentionsMarkup(text, this.model.get('references'), this.model.collection.chatbox);
|
|
text = u.addHyperlinks(text);
|
|
text = u.renderNewLines(text);
|
|
text = u.addEmoji(text);
|
|
/**
|
|
* Synchronous event which provides a hook for transforming a chat message's body text
|
|
* after the default transformations have been applied.
|
|
* @event _converse#afterMessageBodyTransformed
|
|
* @param { _converse.MessageView } view - The view representing the message
|
|
* @param { string } text - The message text
|
|
* @example _converse.api.listen.on('afterMessageBodyTransformed', (view, text) => { ... });
|
|
*/
|
|
await api.trigger('afterMessageBodyTransformed', this, text, {'Synchronous': true});
|
|
return text;
|
|
},
|
|
|
|
async renderChatMessage () {
|
|
await api.waitUntil('emojisInitialized');
|
|
const time = dayjs(this.model.get('time'));
|
|
const is_retracted = this.model.get('retracted') || this.model.get('moderated') === 'retracted';
|
|
const may_be_moderated = this.model.get('type') === 'groupchat' && await this.model.mayBeModerated();
|
|
const retractable= !is_retracted && (this.model.mayBeRetracted() || may_be_moderated);
|
|
const is_groupchat_message = this.model.get('type') === 'groupchat';
|
|
|
|
let hats = [];
|
|
if (is_groupchat_message) {
|
|
if (api.settings.get('muc_hats_from_vcard')) {
|
|
const role = this.model.vcard ? this.model.vcard.get('role') : null;
|
|
hats = role ? role.split(',') : [];
|
|
} else {
|
|
const o = this.model.occupant;
|
|
hats = o && o.get('hats').map(h => h.title).filter(h => h) || [];
|
|
}
|
|
}
|
|
|
|
const msg = u.stringToElement(tpl_message(
|
|
Object.assign(
|
|
this.model.toJSON(), {
|
|
__,
|
|
hats,
|
|
is_groupchat_message,
|
|
is_retracted,
|
|
retractable,
|
|
'extra_classes': this.getExtraMessageClasses(),
|
|
'is_me_message': this.model.isMeCommand(),
|
|
'label_show': __('Show more'),
|
|
'occupant': this.model.occupant,
|
|
'pretty_time': time.format(api.settings.get('time_format')),
|
|
'retraction_text': is_retracted ? this.getRetractionText() : null,
|
|
'time': time.toISOString(),
|
|
'username': this.model.getDisplayName()
|
|
})
|
|
));
|
|
|
|
const url = this.model.get('oob_url');
|
|
url && render(this.transformOOBURL(url), msg.querySelector('.chat-msg__media'));
|
|
|
|
if (!is_retracted) {
|
|
const text = this.model.getMessageText();
|
|
const msg_content = msg.querySelector('.chat-msg__text');
|
|
if (text && text !== url) {
|
|
msg_content.innerHTML = await this.transformBodyText(text);
|
|
if (api.settings.get('show_images_inline')) {
|
|
u.renderImageURLs(_converse, msg_content).then(() => this.triggerRendered());
|
|
}
|
|
}
|
|
}
|
|
if (this.model.get('type') !== 'headline') {
|
|
this.renderAvatar(msg);
|
|
}
|
|
this.replaceElement(msg);
|
|
this.triggerRendered();
|
|
},
|
|
|
|
triggerRendered () {
|
|
if (this.model.collection) {
|
|
// If the model gets destroyed in the meantime, it no
|
|
// longer has a collection.
|
|
this.model.collection.trigger('rendered', this);
|
|
}
|
|
},
|
|
|
|
renderInfoMessage () {
|
|
const msg = u.stringToElement(
|
|
tpl_info(Object.assign(this.model.toJSON(), {
|
|
'extra_classes': 'chat-info',
|
|
'isodate': dayjs(this.model.get('time')).toISOString()
|
|
}))
|
|
);
|
|
return this.replaceElement(msg);
|
|
},
|
|
|
|
getRetractionText () {
|
|
if (this.model.get('type') === 'groupchat' && this.model.get('moderated_by')) {
|
|
const retracted_by_mod = this.model.get('moderated_by');
|
|
const chatbox = this.model.collection.chatbox;
|
|
if (!this.model.mod) {
|
|
this.model.mod =
|
|
chatbox.occupants.findOccupant({'jid': retracted_by_mod}) ||
|
|
chatbox.occupants.findOccupant({'nick': Strophe.getResourceFromJid(retracted_by_mod)});
|
|
}
|
|
const modname = this.model.mod ? this.model.mod.getDisplayName() : 'A moderator';
|
|
return __('%1$s has removed this message', modname);
|
|
} else {
|
|
return __('%1$s has removed this message', this.model.getDisplayName());
|
|
}
|
|
},
|
|
|
|
renderErrorMessage () {
|
|
const msg = u.stringToElement(
|
|
tpl_info(Object.assign(this.model.toJSON(), {
|
|
'extra_classes': 'chat-error',
|
|
'isodate': dayjs(this.model.get('time')).toISOString()
|
|
}))
|
|
);
|
|
return this.replaceElement(msg);
|
|
},
|
|
|
|
renderFileUploadProgresBar () {
|
|
const msg = u.stringToElement(tpl_file_progress(
|
|
Object.assign(this.model.toJSON(), {
|
|
'__': __,
|
|
'filename': this.model.file.name,
|
|
'filesize': filesize(this.model.file.size)
|
|
})));
|
|
this.replaceElement(msg);
|
|
this.renderAvatar();
|
|
},
|
|
|
|
showMessageVersionsModal (ev) {
|
|
ev.preventDefault();
|
|
if (this.model.message_versions_modal === undefined) {
|
|
this.model.message_versions_modal = new _converse.MessageVersionsModal({'model': this.model});
|
|
}
|
|
this.model.message_versions_modal.show(ev);
|
|
},
|
|
|
|
getExtraMessageClasses () {
|
|
const is_retracted = this.model.get('retracted') || this.model.get('moderated') === 'retracted';
|
|
const extra_classes = [
|
|
...(this.model.get('is_delayed') ? ['delayed'] : []), ...(is_retracted ? ['chat-msg--retracted'] : [])
|
|
];
|
|
if (this.model.get('type') === 'groupchat') {
|
|
if (this.model.occupant) {
|
|
extra_classes.push(this.model.occupant.get('role'));
|
|
extra_classes.push(this.model.occupant.get('affiliation'));
|
|
}
|
|
if (this.model.get('sender') === 'them' && this.model.collection.chatbox.isUserMentioned(this.model)) {
|
|
// Add special class to mark groupchat messages
|
|
// in which we are mentioned.
|
|
extra_classes.push('mentioned');
|
|
}
|
|
}
|
|
if (this.model.get('correcting')) {
|
|
extra_classes.push('correcting');
|
|
}
|
|
return extra_classes.filter(c => c).join(" ");
|
|
}
|
|
});
|
|
}
|
|
});
|