Skip to content

Node.js based forum software built for the modern web

15.6 KB
Raw Blame
'use strict';


define('forum/chats/messages', [
	'components', 'hooks', 'modals', 'alerts',
	'messages', 'api', 'forum/topic/images', 'imagesloaded', 'translator',
], function (
	components, hooks, modals, alerts, messagesModule, api, images, imagesLoaded, tx
) {
	const messages = {};

	messages.sendMessage = async function (roomId, inputEl) {
		let message = inputEl.val();
		if (!message.trim().length) {
			return;
		}
		const chatContent = inputEl.parents(`[component="chat/messages"][data-roomid="${roomId}"]`);
		inputEl.val('').trigger('input');

		const chatComposer = inputEl.parents('[component="chat/composer"]');
		messages.updateRemainingLength(chatComposer);
		messages.updateTextAreaHeight(chatContent);
		const payload = { roomId, message };
		({ roomId, message } = await hooks.fire('filter:chat.send', payload));
		const replyToEl = chatComposer.find('[component="chat/composer/replying-to"]');
		const toMid = replyToEl.attr('data-tomid');

		api.post(`/chats/${roomId}`, { message, toMid: toMid }).then(() => {
			hooks.fire('action:chat.sent', { roomId, message });
			replyToEl.addClass('hidden');
			replyToEl.attr('data-tomid', '');
		}).catch((err) => {
			inputEl.val(message).trigger('input');
			messages.updateRemainingLength(chatComposer);
			messages.updateTextAreaHeight(chatContent);
			if (err.message === '[[error:email-not-confirmed-chat]]') {
				return messagesModule.showEmailConfirmWarning(err.message);
			}

			alerts.alert({
				alert_id: 'chat_spam_error',
				title: '[[global:alert.error]]',
				message: err.message,
				type: 'danger',
				timeout: 10000,
			});
		});
	};

	messages.updateRemainingLength = function (parent) {
		const element = parent.find('[component="chat/input"]');
		parent.find('[component="chat/message/length"]').text(element.val().length);
		const remainingLength = config.maximumChatMessageLength - element.val().length;
		parent.find('[component="chat/message/remaining"]').text(remainingLength)
			.toggleClass('fw-bold text-danger', remainingLength < 0)
			.toggleClass('text-muted', remainingLength >= 0);
		hooks.fire('action:chat.updateRemainingLength', {
			parent: parent,
		});
	};

	messages.updateTextAreaHeight = function (chatContentEl) {
		const textarea = chatContentEl.find('[component="chat/input"]');
		textarea.css({ height: messages.calcAutoTextAreaHeight(textarea) + 'px' });
	};

	messages.calcAutoTextAreaHeight = function (textarea) {
		const scrollHeight = textarea.prop('scrollHeight');
		const borderTopWidth = parseFloat(textarea.css('border-top-width'), 10) || 0;
		const borderBottomWidth = parseFloat(textarea.css('border-bottom-width'), 10) || 0;
		return scrollHeight + borderTopWidth + borderBottomWidth;
	};

	function autoresizeTextArea(textarea) {
		textarea.css({ height: messages.calcAutoTextAreaHeight(textarea) + 'px' });
		textarea.on('input', function () {
			textarea.css({ height: 0 });
			textarea.css({ height: messages.calcAutoTextAreaHeight(textarea) + 'px' });
		});
	}

	messages.appendChatMessage = async function (chatContentEl, data) {
		const lastMsgEl = chatContentEl.find('.chat-message').last();
		const lastSpeaker = parseInt(lastMsgEl.attr('data-uid'), 10);
		const lasttimestamp = parseInt(lastMsgEl.attr('data-timestamp'), 10);
		if (!Array.isArray(data)) {
			data.newSet = data.toMid || lastSpeaker !== parseInt(data.fromuid, 10) ||
				parseInt(data.timestamp, 10) > parseInt(lasttimestamp, 10) + (1000 * 60 * 3);
			data.index = parseInt(lastMsgEl.attr('data-index'), 10) + 1;
		}

		const html = await messages.parseMessage(data);
		onMessagesParsed(chatContentEl, html, data);
	};

	function onMessagesParsed(chatContentEl, html, msgData) {
		const newMessage = $(html);
		const isAtBottom = messages.isAtBottom(chatContentEl);
		newMessage.addClass('new');
		newMessage.appendTo(chatContentEl);
		messages.onMessagesAddedToDom(newMessage);
		if (isAtBottom || msgData.self) {
			// remove some message elements if there are too many
			const chatMsgEls = chatContentEl.find('[data-mid]');
			if (chatMsgEls.length > 150) {
				const removeCount = chatMsgEls.length - 150;
				chatMsgEls.slice(0, removeCount).remove();
				chatContentEl.find('[data-mid].new').removeClass('new');
			}

			messages.scrollToBottomAfterImageLoad(chatContentEl);
			const $composer = chatContentEl.siblings('[component="chat/composer"]');
			if ($composer.length && ajaxify.data?.template?.chats) {
				$composer[0].scrollIntoView(true);
			}
		}

		hooks.fire('action:chat.received', {
			messageEl: newMessage,
		});
	}

	messages.onMessagesAddedToDom = function (messageEls) {
		messageEls.find('.timeago').timeago();
		messageEls.find('img:not(.not-responsive)').addClass('img-fluid');
		messageEls.find('img:not(.emoji)').each(function () {
			images.wrapImageInLink($(this));
		});
		hooks.fire('action:chat.onMessagesAddedToDom', { messageEls });
	};

	messages.parseMessage = function (data) {
		const tplData = {
			messages: data,
			isAdminOrGlobalMod: app.user.isAdmin || app.user.isGlobalMod,
		};
		if (Array.isArray(data)) {
			return app.parseAndTranslate('partials/chats/messages', tplData);
		}
		return app.parseAndTranslate('partials/chats/' + (data.system ? 'system-message' : 'message'), tplData);
	};

	messages.isAtBottom = function (containerEl, threshold) {
		if (containerEl.length) {
			const distanceToBottom = containerEl[0].scrollHeight - (
				containerEl.outerHeight() + containerEl.scrollTop()
			);
			return distanceToBottom < (threshold || 100);
		}
	};
	messages.scrollToBottomAfterImageLoad = function (containerEl) {
		if (containerEl && containerEl.length) {
			const msgBodyEls = containerEl[0].querySelectorAll('[component="chat/message/body"]');
			imagesLoaded(msgBodyEls, () => {
				messages.scrollToBottom(containerEl);
			});
		}
	};

	messages.scrollToMessageAfterImageLoad = function (containerEl, msgEl) {
		if (containerEl.length && msgEl.length) {
			const msgBodyEls = containerEl[0].querySelectorAll('[component="chat/message/body"]');
			imagesLoaded(msgBodyEls, () => {
				messages.scrollToMessage(msgEl);
			});
		}
	};

	messages.scrollToMessage = function (msgEl) {
		if (msgEl && msgEl.length) {
			msgEl[0].scrollIntoView(true);
			msgEl.addClass('highlight-pulse');
			setTimeout(() => {
				msgEl.removeClass('highlight-pulse');
			}, 5000);
		}
	};

	messages.scrollToBottom = function (containerEl) {
		if (containerEl && containerEl.length) {
			containerEl.attr('data-ignore-next-scroll', 1);
			containerEl.scrollTop(containerEl[0].scrollHeight - containerEl.height());
			containerEl.parents('[component="chat/message/window"]')
				.find('[component="chat/messages/scroll-up-alert"]')
				.addClass('hidden');
		}
	};

	messages.wrapImagesInLinks = function (containerEl) {
		containerEl.find('[component="chat/message/body"] img:not(.emoji)').each(function () {
			images.wrapImageInLink($(this));
		});
	};

	messages.toggleScrollUpAlert = function (containerEl) {
		const isAtBottom = messages.isAtBottom(containerEl, 300);
		containerEl.parents('[component="chat/message/window"]')
			.find('[component="chat/messages/scroll-up-alert"]')
			.toggleClass('hidden', isAtBottom);
	};

	messages.prepReplyTo = async function (msgEl, chatMessageWindow) {
		const chatContent = chatMessageWindow.find('[component="chat/message/content"]');
		const composerEl = chatMessageWindow.find('[component="chat/composer"]');
		const mid = msgEl.attr('data-mid');
		const replyToEl = composerEl.find('[component="chat/composer/replying-to"]');
		replyToEl.attr('data-tomid', mid)
			.find('[component="chat/composer/replying-to-text"]')
			.translateHtml(tx.compile('modules:chat.replying-to', tx.escape(msgEl.attr('data-displayname'))));
		replyToEl.removeClass('hidden');
		replyToEl.find('[component="chat/composer/replying-to-cancel"]').off('click')
			.on('click', () => {
				replyToEl.attr('data-tomid', '');
				replyToEl.addClass('hidden');
			});

		if (chatContent.length && messages.isAtBottom(chatContent)) {
			messages.scrollToBottom(chatContent);
		}
		composerEl.find('[component="chat/input"]').trigger('focus');
	};

	messages.prepEdit = async function (msgEl, mid, roomId) {
		const { content: raw } = await api.get(`/chats/${roomId}/messages/${mid}/raw`);
		const editEl = await app.parseAndTranslate('partials/chats/edit-message', {
			rawContent: raw,
		});
		const messageBody = msgEl.find(`[component="chat/message/body"]`);
		const messageControls = msgEl.find(`[component="chat/message/controls"]`);
		const chatContent = messageBody.parents('[component="chat/message/content"]');

		const isAtBottom = messages.isAtBottom(chatContent);
		messageBody.addClass('hidden');
		messageControls.addClass('hidden');
		editEl.insertAfter(messageBody);

		const textarea = editEl.find('textarea');

		textarea.focus().putCursorAtEnd();
		autoresizeTextArea(textarea);

		if (chatContent.length && isAtBottom) {
			messages.scrollToBottom(chatContent);
		}

		const chats = await app.require('forum/chats');
		const autoCompleteEl = chats.createAutoComplete(0, textarea, {
			placement: 'bottom',
		});

		function finishEdit() {
			messageBody.removeClass('hidden');
			messageControls.removeClass('hidden');
			editEl.remove();
			if (autoCompleteEl) {
				autoCompleteEl.destroy();
			}
		}
		textarea.on('keyup', (e) => {
			if (e.key === 'Escape') {
				finishEdit();
			}
		});
		editEl.find('[data-action="cancel"]').on('click', finishEdit);

		editEl.find('[data-action="save"]').on('click', function () {
			const message = textarea.val();
			if (!message.trim().length) {
				return;
			}
			api.put(`/chats/${roomId}/messages/${mid}`, { message }).then(() => {
				finishEdit();
				hooks.fire('action:chat.edited', { roomId, message, mid });
			}).catch((err) => {
				textarea.val(message).trigger('input');
				alerts.error(err);
			});
		});

		hooks.fire('action:chat.prepEdit', {
			msgEl: msgEl,
			messageId: mid,
			roomId: roomId,
			editEl: editEl,
			messageBody: messageBody,
		});
	};

	messages.addSocketListeners = function () {
		socket.removeListener('event:chats.edit', onChatMessageEdited);
		socket.on('event:chats.edit', onChatMessageEdited);

		socket.removeListener('event:chats.delete', onChatMessageDeleted);
		socket.on('event:chats.delete', onChatMessageDeleted);

		socket.removeListener('event:chats.restore', onChatMessageRestored);
		socket.on('event:chats.restore', onChatMessageRestored);

		socket.removeListener('connect', onChatReconnect);
		socket.on('connect', onChatReconnect);
	};

	async function onChatMessageEdited(data) {
		await Promise.all(data.messages.map(async (message) => {
			const self = parseInt(message.fromuid, 10) === parseInt(app.user.uid, 10);
			message.self = self ? 1 : 0;
			const html = await messages.parseMessage(message);
			const msgEl = components.get('chat/message', message.mid);
			if (msgEl.length) {
				const componentsToReplace = [
					'[component="chat/message/body"]',
					'[component="chat/message/edited"]',
				];
				componentsToReplace.forEach((cmp) => {
					msgEl.find(cmp).replaceWith(html.find(cmp));
				});
				messages.onMessagesAddedToDom(components.get('chat/message', message.mid));
			}
			const parentEl = $(`[component="chat/message/parent"][data-parent-mid="${message.mid}"]`);
			if (parentEl.length) {
				parentEl.find('[component="chat/message/parent/content"]').html(
					html.find('[component="chat/message/body"]').html()
				);
				messages.onMessagesAddedToDom(
					$(`[component="chat/message/parent"][data-parent-mid="${message.mid}"]`)
				);
			}
		}));
	}

	function onChatMessageDeleted(messageId) {
		const msgEl = components.get('chat/message', messageId);
		const parentEl = $(`[component="chat/message/parent"][data-parent-mid="${messageId}"]`);
		const isSelf = parseInt(msgEl.attr('data-uid'), 10) === app.user.uid;
		const isParentSelf = parseInt(parentEl.attr('data-uid'), 10) === app.user.uid;
		msgEl.toggleClass('deleted', true);
		parentEl.toggleClass('deleted', true);
		if (!isSelf) {
			msgEl.find('[component="chat/message/body"]').html('<p></p>')
				.translateText('[[modules:chat.message-deleted]]');
		}
		if (!isParentSelf) {
			parentEl.find('[component="chat/message/parent/content"]').html('<p></p>')
				.translateText('[[modules:chat.message-deleted]]');
		}
	}

	function onChatMessageRestored(message) {
		const msgEl = components.get('chat/message', message.messageId);
		const parentEl = $(`[component="chat/message/parent"][data-parent-mid="${message.messageId}"]`);
		const isSelf = parseInt(msgEl.attr('data-uid'), 10) === app.user.uid;
		const isParentSelf = parseInt(parentEl.attr('data-uid'), 10) === app.user.uid;
		msgEl.toggleClass('deleted', false);
		parentEl.toggleClass('deleted', false);
		if (!isSelf) {
			msgEl.find('[component="chat/message/body"]')
				.html(message.content);
			messages.onMessagesAddedToDom(components.get('chat/message', message.messageId));
		}

		if (!isParentSelf && parentEl.length) {
			parentEl.find('[component="chat/message/parent/content"]')
				.html(message.content);
			messages.onMessagesAddedToDom($(`[component="chat/message/parent"][data-parent-mid="${message.messageId}"]`));
		}
	}

	function onChatReconnect() {
		$('[component="chat/message/content"]').each(function () {
			const chatContentEl = $(this);
			const roomId = chatContentEl.attr('data-roomid');
			const uid = (ajaxify.data?.template?.chats && ajaxify.data?.uid) || app.user.uid;
			const isAtBottom = messages.isAtBottom(chatContentEl);
			messages.loadMoreMessages(chatContentEl, uid, roomId, 1)
				.then(() => {
					if (isAtBottom) {
						messages.scrollToBottomAfterImageLoad(chatContentEl);
					}
				}).catch(alerts.error);
		});
	}

	messages.loadMoreMessages = async function (chatContentEl, uid, roomId, direction) {
		const msgEls = chatContentEl.children('[data-mid]').not('.new');
		const afterEl = direction > 0 ? msgEls.last() : msgEls.first();
		const start = parseInt(afterEl.attr('data-index'), 10) || 0;

		const data = await api.get(`/chats/${roomId}/messages`, { uid, start, direction });
		let messageData = data.messages;
		if (!messageData) {
			return;
		}
		messageData = messageData.filter(function (chatMsg) {
			const msgOnDom = chatContentEl.find(`[component="chat/message"][data-mid="${chatMsg.messageId}"]`);
			msgOnDom.removeClass('new');
			return !msgOnDom.length;
		});
		if (!messageData.length) {
			return;
		}
		const html = await messages.parseMessage(messageData);
		chatContentEl.attr('data-ignore-next-scroll', 1);
		if (direction > 0) {
			html.insertAfter(afterEl);
			messages.onMessagesAddedToDom(html);
		} else {
			const currentScrollTop = chatContentEl.scrollTop();
			const previousHeight = chatContentEl[0].scrollHeight;
			chatContentEl.prepend(html);
			messages.onMessagesAddedToDom(html);
			chatContentEl.scrollTop((chatContentEl[0].scrollHeight - previousHeight) + currentScrollTop);
		}
	};

	messages.delete = function (messageId, roomId) {
		modals.confirm('[[modules:chat.delete-message-confirm]]', function (ok) {
			if (!ok) {
				return;
			}

			api.del(`/chats/${roomId}/messages/${encodeURIComponent(messageId)}/state`, {}).then(() => {
				components.get('chat/message', messageId).toggleClass('deleted', true);
			}).catch(alerts.error);
		});
	};

	messages.restore = function (messageId, roomId) {
		api.put(`/chats/${roomId}/messages/${encodeURIComponent(messageId)}/state`, {}).then(() => {
			components.get('chat/message', messageId).toggleClass('deleted', false);
		}).catch(alerts.error);
	};

	messages.purge = function (messageId, roomId) {
		modals.confirm('[[modules:chat.purge-message-confirm]]', function (ok) {
			if (!ok) {
				return;
			}

			api.del(`/chats/${roomId}/messages/${encodeURIComponent(messageId)}`, {}).then(() => {
				components.get('chat/message', messageId).remove();
			}).catch(alerts.error);
		});
	};

	return messages;
});