This repository has been archived on 2023-03-18. You can view files and clone it, but cannot push or open issues or pull requests.
osr-discourse-src/plugins/chat/assets/javascripts/discourse/components/chat-composer.js
Martin Brennan d3f02a1270
FEATURE: Generic hashtag autocomplete lookup and markdown cooking (#18937)
This commit fleshes out and adds functionality for the new `#hashtag` search and
lookup system, still hidden behind the `enable_experimental_hashtag_autocomplete`
feature flag.

**Serverside**

We have two plugin API registration methods that are used to define data sources
(`register_hashtag_data_source`) and hashtag result type priorities depending on
the context (`register_hashtag_type_in_context`). Reading the comments in plugin.rb
should make it clear what these are doing. Reading the `HashtagAutocompleteService`
in full will likely help a lot as well.

Each data source is responsible for providing its own **lookup** and **search**
method that returns hashtag results based on the arguments provided. For example,
the category hashtag data source has to take into account parent categories and
how they relate, and each data source has to define their own icon to use for the
hashtag, and so on.

The `Site` serializer has two new attributes that source data from `HashtagAutocompleteService`.
There is `hashtag_icons` that is just a simple array of all the different icons that
can be used for allowlisting in our markdown pipeline, and there is `hashtag_context_configurations`
that is used to store the type priority orders for each registered context.

When sending emails, we cannot render the SVG icons for hashtags, so
we need to change the HTML hashtags to the normal `#hashtag` text.

**Markdown**

The `hashtag-autocomplete.js` file is where I have added the new `hashtag-autocomplete`
markdown rule, and like all of our rules this is used to cook the raw text on both the clientside
and on the serverside using MiniRacer. Only on the server side do we actually reach out to
the database with the `hashtagLookup` function, on the clientside we just render a plainer
version of the hashtag HTML. Only in the composer preview do we do further lookups based
on this.

This rule is the first one (that I can find) that uses the `currentUser` based on a passed
in `user_id` for guardian checks in markdown rendering code. This is the `last_editor_id`
for both the post and chat message. In some cases we need to cook without a user present,
so the `Discourse.system_user` is used in this case.

**Chat Channels**

This also contains the changes required for chat so that chat channels can be used
as a data source for hashtag searches and lookups. This data source will only be
used when `enable_experimental_hashtag_autocomplete` is `true`, so we don't have
to worry about channel results suddenly turning up.

------

**Known Rough Edges**

- Onebox excerpts will not render the icon svg/use tags, I plan to address that in a follow up PR
- Selecting a hashtag + pressing the Quote button will result in weird behaviour, I plan to address that in a follow up PR
- Mixed hashtag contexts for hashtags without a type suffix will not work correctly, e.g. #ux which is both a category and a channel slug will resolve to a category when used inside a post or within a [chat] transcript in that post. Users can get around this manually by adding the correct suffix, for example ::channel. We may get to this at some point in future
- Icons will not show for the hashtags in emails since SVG support is so terrible in email (this is not likely to be resolved, but still noting for posterity)
- Additional refinements and review fixes wil
2022-11-21 08:37:06 +10:00

733 lines
20 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import { isEmpty } from "@ember/utils";
import Component from "@ember/component";
import showModal from "discourse/lib/show-modal";
import discourseComputed, {
afterRender,
bind,
} from "discourse-common/utils/decorators";
import I18n from "I18n";
import TextareaTextManipulation from "discourse/mixins/textarea-text-manipulation";
import userSearch from "discourse/lib/user-search";
import { action } from "@ember/object";
import { cancel, next, schedule, throttle } from "@ember/runloop";
import { cloneJSON } from "discourse-common/lib/object";
import { findRawTemplate } from "discourse-common/lib/raw-templates";
import { emojiSearch, isSkinTonableEmoji } from "pretty-text/emoji";
import { emojiUrlFor } from "discourse/lib/text";
import { inject as service } from "@ember/service";
import { readOnly, reads } from "@ember/object/computed";
import { SKIP } from "discourse/lib/autocomplete";
import { Promise } from "rsvp";
import { translations } from "pretty-text/emoji/data";
import { channelStatusName } from "discourse/plugins/chat/discourse/models/chat-channel";
import { setupHashtagAutocomplete } from "discourse/lib/hashtag-autocomplete";
import {
chatComposerButtons,
chatComposerButtonsDependentKeys,
} from "discourse/plugins/chat/discourse/lib/chat-composer-buttons";
const THROTTLE_MS = 150;
export default Component.extend(TextareaTextManipulation, {
chatChannel: null,
lastChatChannelId: null,
chat: service(),
classNames: ["chat-composer-container"],
classNameBindings: ["emojiPickerVisible:with-emoji-picker"],
userSilenced: readOnly("details.user_silenced"),
chatEmojiReactionStore: service("chat-emoji-reaction-store"),
chatEmojiPickerManager: service("chat-emoji-picker-manager"),
chatStateManager: service("chat-state-manager"),
editingMessage: null,
onValueChange: null,
timer: null,
value: "",
inProgressUploads: null,
composerEventPrefix: "chat",
composerFocusSelector: ".chat-composer-input",
canAttachUploads: reads("siteSettings.chat_allow_uploads"),
isNetworkUnreliable: reads("chat.isNetworkUnreliable"),
@discourseComputed(...chatComposerButtonsDependentKeys())
inlineButtons() {
return chatComposerButtons(this, "inline");
},
@discourseComputed(...chatComposerButtonsDependentKeys())
dropdownButtons() {
return chatComposerButtons(this, "dropdown");
},
@discourseComputed("chatEmojiPickerManager.{opened,context}")
emojiPickerVisible(picker) {
return picker.opened && picker.context === "chat-composer";
},
@discourseComputed("chatStateManager.isFullPage")
fileUploadElementId(fullPage) {
return fullPage ? "chat-full-page-uploader" : "chat-widget-uploader";
},
init() {
this._super(...arguments);
this.appEvents.on("chat-composer:reply-to-set", this, "_replyToMsgChanged");
this.appEvents.on(
"upload-mixin:chat-composer-uploader:in-progress-uploads",
this,
"_inProgressUploadsChanged"
);
this.setProperties({
inProgressUploads: [],
_uploads: [],
});
},
didInsertElement() {
this._super(...arguments);
this._textarea = this.element.querySelector(".chat-composer-input");
this._$textarea = $(this._textarea);
this._applyCategoryHashtagAutocomplete(this._$textarea);
this._applyEmojiAutocomplete(this._$textarea);
this.appEvents.on("chat:focus-composer", this, "_focusTextArea");
this.appEvents.on("chat:insert-text", this, "insertText");
this._focusTextArea();
this.appEvents.on("chat:modify-selection", this, "_modifySelection");
this.appEvents.on(
"chat:open-insert-link-modal",
this,
"_openInsertLinkModal"
);
document.addEventListener("visibilitychange", this._blurInput);
document.addEventListener("resume", this._blurInput);
document.addEventListener("freeze", this._blurInput);
this.set("ready", true);
},
_modifySelection(opts = { type: null }) {
const sel = this.getSelected("", { lineVal: true });
if (opts.type === "bold") {
this.applySurround(sel, "**", "**", "bold_text");
} else if (opts.type === "italic") {
this.applySurround(sel, "_", "_", "italic_text");
} else if (opts.type === "code") {
this.applySurround(sel, "`", "`", "code_text");
}
},
_openInsertLinkModal() {
const selected = this.getSelected("", { lineVal: true });
const linkText = selected?.value;
showModal("insert-hyperlink").setProperties({
linkText,
toolbarEvent: {
addText: (text) => this.addText(selected, text),
},
});
},
willDestroyElement() {
this._super(...arguments);
this.appEvents.off(
"chat-composer:reply-to-set",
this,
"_replyToMsgChanged"
);
this.appEvents.off(
"upload-mixin:chat-composer-uploader:in-progress-uploads",
this,
"_inProgressUploadsChanged"
);
if (this.timer) {
cancel(this.timer);
this.timer = null;
}
this.appEvents.off("chat:focus-composer", this, "_focusTextArea");
this.appEvents.off("chat:insert-text", this, "insertText");
this.appEvents.off("chat:modify-selection", this, "_modifySelection");
this.appEvents.off(
"chat:open-insert-link-modal",
this,
"_openInsertLinkModal"
);
document.removeEventListener("visibilitychange", this._blurInput);
document.removeEventListener("resume", this._blurInput);
document.removeEventListener("freeze", this._blurInput);
},
// It is important that this is keyDown and not keyUp, otherwise
// we add new lines to chat message on send and on edit, because
// you cannot prevent default with a keyUp event -- it is like trying
// to shut the gate after the horse has already bolted!
keyDown(event) {
if (this.site.mobileView || event.altKey || event.metaKey) {
return;
}
// keyCode for 'Enter'
if (event.keyCode === 13) {
if (event.shiftKey) {
// Shift+Enter: insert newline
return;
}
// Ctrl+Enter, plain Enter: send
if (!event.ctrlKey) {
// if we are inside a code block just insert newline
const { pre } = this.getSelected(null, { lineVal: true });
if (this.isInside(pre, /(^|\n)```/g)) {
return;
}
}
this.sendClicked();
return false;
}
if (
event.key === "ArrowUp" &&
this._messageIsEmpty() &&
!this.editingMessage
) {
event.preventDefault();
this.onEditLastMessageRequested();
}
if (event.keyCode === 27) {
// keyCode for 'Escape'
if (this.replyToMsg) {
this.set("value", "");
this._replyToMsgChanged(null);
return false;
} else if (this.editingMessage) {
this.set("value", "");
this.cancelEditing();
return false;
} else {
this._textarea.blur();
}
}
},
didReceiveAttrs() {
this._super(...arguments);
if (
!this.editingMessage &&
this.draft &&
this.chatChannel?.canModifyMessages(this.currentUser)
) {
// uses uploads from draft here...
this.setProperties({
value: this.draft.value,
replyToMsg: this.draft.replyToMsg,
});
this._syncUploads(this.draft.uploads);
this.setInReplyToMsg(this.draft.replyToMsg);
}
if (this.editingMessage && !this.loading) {
this.setProperties({
replyToMsg: null,
value: this.editingMessage.message,
});
this._syncUploads(this.editingMessage.uploads);
this._focusTextArea({ ensureAtEnd: true, resizeTextarea: false });
}
this.set("lastChatChannelId", this.chatChannel.id);
this.resizeTextarea();
},
// the chat-composer needs to be able to set the internal list of uploads
// for chat-composer-uploads to preload in existing uploads for drafts
// and for when messages are being edited.
//
// the opposite is true as well -- when an upload is completed the chat-composer
// needs its internal state updated so drafts can be saved, which is handled
// by the uploadsChanged action
_syncUploads(newUploads = []) {
const currentUploadIds = this._uploads.mapBy("id");
const newUploadIds = newUploads.mapBy("id");
// don't need to load the uploads into chat-composer-uploads if
// nothing has changed otherwise we would rerender for no reason
if (
currentUploadIds.length === newUploadIds.length &&
newUploadIds.every((newUploadId) =>
currentUploadIds.includes(newUploadId)
)
) {
return;
}
this.set("_uploads", cloneJSON(newUploads));
this.appEvents.trigger("chat-composer:load-uploads", this._uploads);
},
_inProgressUploadsChanged(inProgressUploads) {
next(() => {
if (this.isDestroying || this.isDestroyed) {
return;
}
this.set("inProgressUploads", inProgressUploads);
});
},
_replyToMsgChanged(replyToMsg) {
this.set("replyToMsg", replyToMsg);
this.onValueChange?.(this.value, this._uploads, replyToMsg);
},
@action
onTextareaInput(value) {
this.set("value", value);
this.resizeTextarea();
// throttle, not debounce, because we do eventually want to react during the typing
this.timer = throttle(this, this._handleTextareaInput, THROTTLE_MS);
},
@bind
_handleTextareaInput() {
this._applyUserAutocomplete();
this.onValueChange?.(this.value, this._uploads, this.replyToMsg);
},
@bind
_blurInput() {
document.activeElement?.blur();
},
@action
uploadClicked() {
this.element.querySelector(`#${this.fileUploadElementId}`).click();
},
@bind
didSelectEmoji(emoji) {
const code = `:${emoji}:`;
this.chatEmojiReactionStore.track(code);
this.addText(this.getSelected(), code);
},
@action
insertDiscourseLocalDate() {
showModal("discourse-local-dates-create-modal").setProperties({
insertDate: (markup) => {
this.addText(this.getSelected(), markup);
},
});
},
// text-area-manipulation mixin override
addText() {
this._super(...arguments);
this.resizeTextarea();
},
_applyUserAutocomplete() {
if (this.siteSettings.enable_mentions) {
$(this._textarea).autocomplete({
template: findRawTemplate("user-selector-autocomplete"),
key: "@",
width: "100%",
treatAsTextarea: true,
autoSelectFirstSuggestion: true,
transformComplete: (v) => v.username || v.name,
dataSource: (term) => userSearch({ term, includeGroups: true }),
afterComplete: (text) => {
this.set("value", text);
this._focusTextArea();
},
});
}
},
_applyCategoryHashtagAutocomplete($textarea) {
setupHashtagAutocomplete(
this.site.hashtag_configurations["chat-composer"],
$textarea,
this.siteSettings,
(value) => {
this.set("value", value);
return this._focusTextArea();
}
);
},
_applyEmojiAutocomplete($textarea) {
if (!this.siteSettings.enable_emoji) {
return;
}
$textarea.autocomplete({
template: findRawTemplate("emoji-selector-autocomplete"),
key: ":",
afterComplete: (text) => {
this.set("value", text);
this._focusTextArea();
},
treatAsTextarea: true,
onKeyUp: (text, cp) => {
const matches =
/(?:^|[\s.\?,@\/#!%&*;:\[\]{}=\-_()])(:(?!:).?[\w-]*:?(?!:)(?:t\d?)?:?) ?$/gi.exec(
text.substring(0, cp)
);
if (matches && matches[1]) {
return [matches[1]];
}
},
transformComplete: (v) => {
if (v.code) {
this.chatEmojiReactionStore.track(v.code);
return `${v.code}:`;
} else {
$textarea.autocomplete({ cancel: true });
this.set("emojiPickerIsActive", true);
return "";
}
},
dataSource: (term) => {
return new Promise((resolve) => {
const full = `:${term}`;
term = term.toLowerCase();
// We need to avoid quick emoji autocomplete cause it can interfere with quick
// typing, set minimal length to 2
let minLength = Math.max(
this.siteSettings.emoji_autocomplete_min_chars,
2
);
if (term.length < minLength) {
return resolve(SKIP);
}
// bypass :-p and other common typed smileys
if (
!term.match(
/[^-\{\}\[\]\(\)\*_\<\>\\\/].*[^-\{\}\[\]\(\)\*_\<\>\\\/]/
)
) {
return resolve(SKIP);
}
if (term === "") {
if (this.chatEmojiReactionStore.favorites.length) {
return resolve(this.chatEmojiReactionStore.favorites.slice(0, 5));
} else {
return resolve([
"slight_smile",
"smile",
"wink",
"sunny",
"blush",
]);
}
}
// note this will only work for emojis starting with :
// eg: :-)
const emojiTranslation =
this.get("site.custom_emoji_translation") || {};
const allTranslations = Object.assign(
{},
translations,
emojiTranslation
);
if (allTranslations[full]) {
return resolve([allTranslations[full]]);
}
const match = term.match(/^:?(.*?):t([2-6])?$/);
if (match) {
const name = match[1];
const scale = match[2];
if (isSkinTonableEmoji(name)) {
if (scale) {
return resolve([`${name}:t${scale}`]);
} else {
return resolve([2, 3, 4, 5, 6].map((x) => `${name}:t${x}`));
}
}
}
const options = emojiSearch(term, {
maxResults: 5,
diversity: this.chatEmojiReactionStore.diversity,
});
return resolve(options);
})
.then((list) => {
if (list === SKIP) {
return;
}
return list.map((code) => ({ code, src: emojiUrlFor(code) }));
})
.then((list) => {
if (list?.length) {
list.push({ label: I18n.t("composer.more_emoji"), term });
}
return list;
});
},
});
},
@afterRender
_focusTextArea(opts = { ensureAtEnd: false, resizeTextarea: true }) {
if (this.chatChannel.isDraft) {
return;
}
if (!this._textarea) {
return;
}
if (opts.resizeTextarea) {
this.resizeTextarea();
}
if (opts.ensureAtEnd) {
this._textarea.setSelectionRange(this.value.length, this.value.length);
}
if (this.capabilities.isIpadOS || this.site.mobileView) {
return;
}
schedule("afterRender", () => {
this._textarea?.focus();
});
},
@action
onEmojiSelected(code) {
this.emojiSelected(code);
this.set("emojiPickerIsActive", false);
},
@discourseComputed(
"chatChannel.{id,chatable.users.[]}",
"canInteractWithChat"
)
disableComposer(channel, canInteractWithChat) {
return (
(channel.isDraft && isEmpty(channel?.chatable?.users)) ||
!canInteractWithChat ||
!channel.canModifyMessages(this.currentUser)
);
},
@discourseComputed("userSilenced", "chatChannel.{chatable.users.[],id}")
placeholder(userSilenced, chatChannel) {
if (!chatChannel.canModifyMessages(this.currentUser)) {
return I18n.t("chat.placeholder_new_message_disallowed", {
status: channelStatusName(chatChannel.status).toLowerCase(),
});
}
if (chatChannel.isDraft) {
return I18n.t("chat.placeholder_start_conversation", {
usernames: chatChannel?.chatable?.users?.length
? chatChannel.chatable.users.mapBy("username").join(", ")
: "...",
});
}
if (userSilenced) {
return I18n.t("chat.placeholder_silenced");
} else {
return this.messageRecipient(chatChannel);
}
},
messageRecipient(chatChannel) {
if (chatChannel.isDirectMessageChannel) {
const directMessageRecipients = chatChannel.chatable.users;
if (
directMessageRecipients.length === 1 &&
directMessageRecipients[0].id === this.currentUser.id
) {
return I18n.t("chat.placeholder_self");
}
return I18n.t("chat.placeholder_others", {
messageRecipient: directMessageRecipients
.map((u) => u.name || `@${u.username}`)
.join(", "),
});
} else {
return I18n.t("chat.placeholder_others", {
messageRecipient: `#${chatChannel.title}`,
});
}
},
@discourseComputed(
"value",
"loading",
"disableComposer",
"inProgressUploads.[]"
)
sendDisabled(value, loading, disableComposer, inProgressUploads) {
if (loading || disableComposer || inProgressUploads.length > 0) {
return true;
}
return !this._messageIsValid();
},
@action
sendClicked() {
if (this.site.mobileView) {
// prevents android to hide the keyboard after sending a message
// we do a focusTextarea later but it's too late for android
document.querySelector(this.composerFocusSelector).focus();
}
if (this.sendDisabled) {
return;
}
this.editingMessage
? this.internalEditMessage()
: this.internalSendMessage();
},
@action
internalSendMessage() {
return this.sendMessage(this.value, this._uploads).then(this.reset);
},
@action
internalEditMessage() {
return this.editMessage(
this.editingMessage,
this.value,
this._uploads
).then(this.reset);
},
_messageIsValid() {
const validLength =
(this.value || "").trim().length >=
(this.siteSettings.chat_minimum_message_length || 0);
if (this.canAttachUploads) {
if (this._messageIsEmpty()) {
// If message is empty, an an upload must present for sending to be enabled
return this._uploads.length;
} else {
// Message is non-empty. Make sure it's long enough to be valid.
return validLength;
}
}
// Attachments are disabled so for a message to be valid it must be long enough.
return validLength;
},
_messageIsEmpty() {
return (this.value || "").trim() === "";
},
@action
reset() {
if (this.isDestroyed || this.isDestroying) {
return;
}
this.setProperties({
value: "",
inReplyMsg: null,
});
this._syncUploads([]);
this._focusTextArea({ ensureAtEnd: true, resizeTextarea: true });
this.onValueChange?.(this.value, this._uploads, this.replyToMsg);
},
@action
cancelReplyTo() {
this.set("replyToMsg", null);
this.setInReplyToMsg(null);
this.onValueChange?.(this.value, this._uploads, this.replyToMsg);
},
@action
cancelEditing() {
this.onCancelEditing();
this._focusTextArea({ ensureAtEnd: true, resizeTextarea: true });
},
_cursorIsOnEmptyLine() {
const selectionStart = this._textarea.selectionStart;
if (selectionStart === 0) {
return true;
} else if (this._textarea.value.charAt(selectionStart - 1) === "\n") {
return true;
} else {
return false;
}
},
@action
uploadsChanged(uploads) {
this.set("_uploads", cloneJSON(uploads));
this.onValueChange?.(this.value, this._uploads, this.replyToMsg);
},
@action
onTextareaFocusIn(target) {
if (!this.capabilities.isIOS) {
return;
}
// hack to prevent the whole viewport
// to move on focus input
target = document.querySelector(".chat-composer-input");
target.style.transform = "translateY(-99999px)";
target.focus();
window.requestAnimationFrame(() => {
window.requestAnimationFrame(() => {
target.style.transform = "";
});
});
},
@action
resizeTextarea() {
schedule("afterRender", () => {
if (!this._textarea) {
return;
}
// this is a quirk which forces us to `auto` first or textarea
// won't resize
this._textarea.style.height = "auto";
// +1 is to workaround a rounding error visible on electron
// causing scrollbars to show when they shouldnt
this._textarea.style.height = this._textarea.scrollHeight + 1 + "px";
});
},
});