514 lines
19 KiB
TypeScript
514 lines
19 KiB
TypeScript
/*
|
|
* Vencord, a modification for Discord's desktop app
|
|
* Copyright (c) 2022 Vendicated and contributors
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
import "./messageLogger.css";
|
|
|
|
import { findGroupChildrenByChildId, NavContextMenuPatchCallback } from "@api/ContextMenu";
|
|
import { updateMessage } from "@api/MessageUpdater";
|
|
import { Settings } from "@api/Settings";
|
|
import { disableStyle, enableStyle } from "@api/Styles";
|
|
import ErrorBoundary from "@components/ErrorBoundary";
|
|
import { Devs } from "@utils/constants";
|
|
import { proxyLazy } from "@utils/lazy";
|
|
import { Logger } from "@utils/Logger";
|
|
import { classes } from "@utils/misc";
|
|
import definePlugin, { OptionType } from "@utils/types";
|
|
import { findByCodeLazy, findByPropsLazy } from "@webpack";
|
|
import { ChannelStore, FluxDispatcher, i18n, Menu, MessageStore, Parser, SelectedChannelStore, Timestamp, UserStore, useStateFromStores } from "@webpack/common";
|
|
import { Message } from "discord-types/general";
|
|
|
|
import overlayStyle from "./deleteStyleOverlay.css?managed";
|
|
import textStyle from "./deleteStyleText.css?managed";
|
|
import { openHistoryModal } from "./HistoryModal";
|
|
|
|
interface MLMessage extends Message {
|
|
deleted?: boolean;
|
|
editHistory?: { timestamp: Date; content: string; }[];
|
|
firstEditTimestamp?: Date;
|
|
}
|
|
|
|
const styles = findByPropsLazy("edited", "communicationDisabled", "isSystemMessage");
|
|
const getMessage = findByCodeLazy('replace(/^\\n+|\\n+$/g,"")');
|
|
|
|
function addDeleteStyle() {
|
|
if (Settings.plugins.MessageLogger.deleteStyle === "text") {
|
|
enableStyle(textStyle);
|
|
disableStyle(overlayStyle);
|
|
} else {
|
|
disableStyle(textStyle);
|
|
enableStyle(overlayStyle);
|
|
}
|
|
}
|
|
|
|
const REMOVE_HISTORY_ID = "ml-remove-history";
|
|
const TOGGLE_DELETE_STYLE_ID = "ml-toggle-style";
|
|
const patchMessageContextMenu: NavContextMenuPatchCallback = (children, props) => {
|
|
const { message } = props;
|
|
const { deleted, editHistory, id, channel_id } = message;
|
|
|
|
if (!deleted && !editHistory?.length) return;
|
|
|
|
toggle: {
|
|
if (!deleted) break toggle;
|
|
|
|
const domElement = document.getElementById(`chat-messages-${channel_id}-${id}`);
|
|
if (!domElement) break toggle;
|
|
|
|
children.push((
|
|
<Menu.MenuItem
|
|
id={TOGGLE_DELETE_STYLE_ID}
|
|
key={TOGGLE_DELETE_STYLE_ID}
|
|
label="Toggle Deleted Highlight"
|
|
action={() => domElement.classList.toggle("messagelogger-deleted")}
|
|
/>
|
|
));
|
|
}
|
|
|
|
children.push((
|
|
<Menu.MenuItem
|
|
id={REMOVE_HISTORY_ID}
|
|
key={REMOVE_HISTORY_ID}
|
|
label="Remove Message History"
|
|
color="danger"
|
|
action={() => {
|
|
if (deleted) {
|
|
FluxDispatcher.dispatch({
|
|
type: "MESSAGE_DELETE",
|
|
channelId: channel_id,
|
|
id,
|
|
mlDeleted: true
|
|
});
|
|
} else {
|
|
message.editHistory = [];
|
|
}
|
|
}}
|
|
/>
|
|
));
|
|
};
|
|
|
|
const patchChannelContextMenu: NavContextMenuPatchCallback = (children, { channel }) => {
|
|
const messages = MessageStore.getMessages(channel?.id) as MLMessage[];
|
|
if (!messages?.some(msg => msg.deleted || msg.editHistory?.length)) return;
|
|
|
|
const group = findGroupChildrenByChildId("mark-channel-read", children) ?? children;
|
|
group.push(
|
|
<Menu.MenuItem
|
|
id="vc-ml-clear-channel"
|
|
label="Clear Message Log"
|
|
color="danger"
|
|
action={() => {
|
|
messages.forEach(msg => {
|
|
if (msg.deleted)
|
|
FluxDispatcher.dispatch({
|
|
type: "MESSAGE_DELETE",
|
|
channelId: channel.id,
|
|
id: msg.id,
|
|
mlDeleted: true
|
|
});
|
|
else
|
|
updateMessage(channel.id, msg.id, {
|
|
editHistory: []
|
|
});
|
|
});
|
|
}}
|
|
/>
|
|
);
|
|
};
|
|
|
|
export function parseEditContent(content: string, message: Message) {
|
|
return Parser.parse(content, true, {
|
|
channelId: message.channel_id,
|
|
messageId: message.id,
|
|
allowLinks: true,
|
|
allowHeading: true,
|
|
allowList: true,
|
|
allowEmojiLinks: true,
|
|
viewingChannelId: SelectedChannelStore.getChannelId(),
|
|
});
|
|
}
|
|
|
|
export default definePlugin({
|
|
name: "MessageLogger",
|
|
description: "Temporarily logs deleted and edited messages.",
|
|
authors: [Devs.rushii, Devs.Ven, Devs.AutumnVN, Devs.Nickyux, Devs.Kyuuhachi],
|
|
dependencies: ["MessageUpdaterAPI"],
|
|
|
|
contextMenus: {
|
|
"message": patchMessageContextMenu,
|
|
"channel-context": patchChannelContextMenu,
|
|
"user-context": patchChannelContextMenu,
|
|
"gdm-context": patchChannelContextMenu
|
|
},
|
|
|
|
start() {
|
|
addDeleteStyle();
|
|
},
|
|
|
|
renderEdits: ErrorBoundary.wrap(({ message: { id: messageId, channel_id: channelId } }: { message: Message; }) => {
|
|
const message = useStateFromStores(
|
|
[MessageStore],
|
|
() => MessageStore.getMessage(channelId, messageId) as MLMessage,
|
|
null,
|
|
(oldMsg, newMsg) => oldMsg?.editHistory === newMsg?.editHistory
|
|
);
|
|
|
|
return Settings.plugins.MessageLogger.inlineEdits && (
|
|
<>
|
|
{message.editHistory?.map(edit => (
|
|
<div className="messagelogger-edited">
|
|
{parseEditContent(edit.content, message)}
|
|
<Timestamp
|
|
timestamp={edit.timestamp}
|
|
isEdited={true}
|
|
isInline={false}
|
|
>
|
|
<span className={styles.edited}>{" "}({i18n.Messages.MESSAGE_EDITED})</span>
|
|
</Timestamp>
|
|
</div>
|
|
))}
|
|
</>
|
|
);
|
|
}, { noop: true }),
|
|
|
|
makeEdit(newMessage: any, oldMessage: any): any {
|
|
return {
|
|
timestamp: new Date(newMessage.edited_timestamp),
|
|
content: oldMessage.content
|
|
};
|
|
},
|
|
|
|
options: {
|
|
deleteStyle: {
|
|
type: OptionType.SELECT,
|
|
description: "The style of deleted messages",
|
|
default: "text",
|
|
options: [
|
|
{ label: "Red text", value: "text", default: true },
|
|
{ label: "Red overlay", value: "overlay" }
|
|
],
|
|
onChange: () => addDeleteStyle()
|
|
},
|
|
logDeletes: {
|
|
type: OptionType.BOOLEAN,
|
|
description: "Whether to log deleted messages",
|
|
default: true,
|
|
},
|
|
collapseDeleted: {
|
|
type: OptionType.BOOLEAN,
|
|
description: "Whether to collapse deleted messages, similar to blocked messages",
|
|
default: false
|
|
},
|
|
logEdits: {
|
|
type: OptionType.BOOLEAN,
|
|
description: "Whether to log edited messages",
|
|
default: true,
|
|
},
|
|
inlineEdits: {
|
|
type: OptionType.BOOLEAN,
|
|
description: "Whether to display edit history as part of message content",
|
|
default: true
|
|
},
|
|
ignoreBots: {
|
|
type: OptionType.BOOLEAN,
|
|
description: "Whether to ignore messages by bots",
|
|
default: false
|
|
},
|
|
ignoreSelf: {
|
|
type: OptionType.BOOLEAN,
|
|
description: "Whether to ignore messages by yourself",
|
|
default: false
|
|
},
|
|
ignoreUsers: {
|
|
type: OptionType.STRING,
|
|
description: "Comma-separated list of user IDs to ignore",
|
|
default: ""
|
|
},
|
|
ignoreChannels: {
|
|
type: OptionType.STRING,
|
|
description: "Comma-separated list of channel IDs to ignore",
|
|
default: ""
|
|
},
|
|
ignoreGuilds: {
|
|
type: OptionType.STRING,
|
|
description: "Comma-separated list of guild IDs to ignore",
|
|
default: ""
|
|
},
|
|
},
|
|
|
|
handleDelete(cache: any, data: { ids: string[], id: string; mlDeleted?: boolean; }, isBulk: boolean) {
|
|
try {
|
|
if (cache == null || (!isBulk && !cache.has(data.id))) return cache;
|
|
|
|
const mutate = (id: string) => {
|
|
const msg = cache.get(id);
|
|
if (!msg) return;
|
|
|
|
const EPHEMERAL = 64;
|
|
const shouldIgnore = data.mlDeleted ||
|
|
(msg.flags & EPHEMERAL) === EPHEMERAL ||
|
|
this.shouldIgnore(msg);
|
|
|
|
if (shouldIgnore) {
|
|
cache = cache.remove(id);
|
|
} else {
|
|
cache = cache.update(id, m => m
|
|
.set("deleted", true)
|
|
.set("attachments", m.attachments.map(a => (a.deleted = true, a))));
|
|
}
|
|
};
|
|
|
|
if (isBulk) {
|
|
data.ids.forEach(mutate);
|
|
} else {
|
|
mutate(data.id);
|
|
}
|
|
} catch (e) {
|
|
new Logger("MessageLogger").error("Error during handleDelete", e);
|
|
}
|
|
return cache;
|
|
},
|
|
|
|
shouldIgnore(message: any, isEdit = false) {
|
|
const { ignoreBots, ignoreSelf, ignoreUsers, ignoreChannels, ignoreGuilds, logEdits, logDeletes } = Settings.plugins.MessageLogger;
|
|
const myId = UserStore.getCurrentUser().id;
|
|
|
|
return ignoreBots && message.author?.bot ||
|
|
ignoreSelf && message.author?.id === myId ||
|
|
ignoreUsers.includes(message.author?.id) ||
|
|
ignoreChannels.includes(message.channel_id) ||
|
|
ignoreChannels.includes(ChannelStore.getChannel(message.channel_id)?.parent_id) ||
|
|
(isEdit ? !logEdits : !logDeletes) ||
|
|
ignoreGuilds.includes(ChannelStore.getChannel(message.channel_id)?.guild_id) ||
|
|
// Ignore Venbot in the support channel
|
|
(message.channel_id === "1026515880080842772" && message.author?.id === "1017176847865352332");
|
|
},
|
|
|
|
EditMarker({ message, className, children, ...props }: any) {
|
|
return (
|
|
<span
|
|
{...props}
|
|
className={classes("messagelogger-edit-marker", className)}
|
|
onClick={() => openHistoryModal(message)}
|
|
aria-role="button"
|
|
>
|
|
{children}
|
|
</span>
|
|
);
|
|
},
|
|
|
|
Messages: proxyLazy(() => ({
|
|
DELETED_MESSAGE_COUNT: getMessage("{count, plural, =0 {No deleted messages} one {{count} deleted message} other {{count} deleted messages}}")
|
|
})),
|
|
|
|
patches: [
|
|
{
|
|
// MessageStore
|
|
find: '"MessageStore"',
|
|
replacement: [
|
|
{
|
|
// Add deleted=true to all target messages in the MESSAGE_DELETE event
|
|
match: /MESSAGE_DELETE:function\((\i)\){let.+?((?:\i\.){2})getOrCreate.+?},/,
|
|
replace:
|
|
"MESSAGE_DELETE:function($1){" +
|
|
" var cache = $2getOrCreate($1.channelId);" +
|
|
" cache = $self.handleDelete(cache, $1, false);" +
|
|
" $2commit(cache);" +
|
|
"},"
|
|
},
|
|
{
|
|
// Add deleted=true to all target messages in the MESSAGE_DELETE_BULK event
|
|
match: /MESSAGE_DELETE_BULK:function\((\i)\){let.+?((?:\i\.){2})getOrCreate.+?},/,
|
|
replace:
|
|
"MESSAGE_DELETE_BULK:function($1){" +
|
|
" var cache = $2getOrCreate($1.channelId);" +
|
|
" cache = $self.handleDelete(cache, $1, true);" +
|
|
" $2commit(cache);" +
|
|
"},"
|
|
},
|
|
{
|
|
// Add current cached content + new edit time to cached message's editHistory
|
|
match: /(MESSAGE_UPDATE:function\((\i)\).+?)\.update\((\i)/,
|
|
replace: "$1" +
|
|
".update($3,m =>" +
|
|
" (($2.message.flags & 64) === 64 || $self.shouldIgnore($2.message, true)) ? m :" +
|
|
" $2.message.edited_timestamp && $2.message.content !== m.content ?" +
|
|
" m.set('editHistory',[...(m.editHistory || []), $self.makeEdit($2.message, m)]) :" +
|
|
" m" +
|
|
")" +
|
|
".update($3"
|
|
},
|
|
{
|
|
// fix up key (edit last message) attempting to edit a deleted message
|
|
match: /(?<=getLastEditableMessage\(\i\)\{.{0,200}\.find\((\i)=>)/,
|
|
replace: "!$1.deleted &&"
|
|
}
|
|
]
|
|
},
|
|
|
|
{
|
|
// Message domain model
|
|
find: "}addReaction(",
|
|
replacement: [
|
|
{
|
|
match: /this\.customRenderedContent=(\i)\.customRenderedContent,/,
|
|
replace: "this.customRenderedContent = $1.customRenderedContent," +
|
|
"this.deleted = $1.deleted || false," +
|
|
"this.editHistory = $1.editHistory || []," +
|
|
"this.firstEditTimestamp = $1.firstEditTimestamp || this.editedTimestamp || this.timestamp,"
|
|
}
|
|
]
|
|
},
|
|
|
|
{
|
|
// Updated message transformer(?)
|
|
find: "THREAD_STARTER_MESSAGE?null===",
|
|
replacement: [
|
|
{
|
|
// Pass through editHistory & deleted & original attachments to the "edited message" transformer
|
|
match: /(?<=null!=\i\.edited_timestamp\)return )\i\(\i,\{reactions:(\i)\.reactions.{0,50}\}\)/,
|
|
replace:
|
|
"Object.assign($&,{ deleted:$1.deleted, editHistory:$1.editHistory, firstEditTimestamp:$1.firstEditTimestamp })"
|
|
},
|
|
|
|
{
|
|
// Construct new edited message and add editHistory & deleted (ref above)
|
|
// Pass in custom data to attachment parser to mark attachments deleted as well
|
|
match: /attachments:(\i)\((\i)\)/,
|
|
replace:
|
|
"attachments: $1((() => {" +
|
|
" if ($self.shouldIgnore($2)) return $2;" +
|
|
" let old = arguments[1]?.attachments;" +
|
|
" if (!old) return $2;" +
|
|
" let new_ = $2.attachments?.map(a => a.id) ?? [];" +
|
|
" let diff = old.filter(a => !new_.includes(a.id));" +
|
|
" old.forEach(a => a.deleted = true);" +
|
|
" $2.attachments = [...diff, ...$2.attachments];" +
|
|
" return $2;" +
|
|
"})())," +
|
|
"deleted: arguments[1]?.deleted," +
|
|
"editHistory: arguments[1]?.editHistory," +
|
|
"firstEditTimestamp: new Date(arguments[1]?.firstEditTimestamp ?? $2.editedTimestamp ?? $2.timestamp)"
|
|
},
|
|
{
|
|
// Preserve deleted attribute on attachments
|
|
match: /(\((\i)\){return null==\2\.attachments.+?)spoiler:/,
|
|
replace:
|
|
"$1deleted: arguments[0]?.deleted," +
|
|
"spoiler:"
|
|
}
|
|
]
|
|
},
|
|
|
|
{
|
|
// Attachment renderer
|
|
find: ".removeMosaicItemHoverButton",
|
|
group: true,
|
|
replacement: [
|
|
{
|
|
match: /(className:\i,item:\i),/,
|
|
replace: "$1,item: deleted,"
|
|
},
|
|
{
|
|
match: /\[\i\.obscured\]:.+?,/,
|
|
replace: "$& 'messagelogger-deleted-attachment': deleted,"
|
|
}
|
|
]
|
|
},
|
|
|
|
{
|
|
// Base message component renderer
|
|
find: "Message must not be a thread starter message",
|
|
replacement: [
|
|
{
|
|
// Append messagelogger-deleted to classNames if deleted
|
|
match: /\)\("li",\{(.+?),className:/,
|
|
replace: ")(\"li\",{$1,className:(arguments[0].message.deleted ? \"messagelogger-deleted \" : \"\")+"
|
|
}
|
|
]
|
|
},
|
|
|
|
{
|
|
// Message content renderer
|
|
find: "Messages.MESSAGE_EDITED,\")\"",
|
|
replacement: [
|
|
{
|
|
// Render editHistory in the deepest div for message content
|
|
match: /(\)\("div",\{id:.+?children:\[)/,
|
|
replace: "$1 (!!arguments[0].message.editHistory?.length && $self.renderEdits(arguments[0])),"
|
|
},
|
|
{
|
|
// Make edit marker clickable
|
|
match: /"span",\{(?=className:\i\.edited,)/,
|
|
replace: "$self.EditMarker,{message:arguments[0].message,"
|
|
}
|
|
]
|
|
},
|
|
|
|
{
|
|
// ReferencedMessageStore
|
|
find: '"ReferencedMessageStore"',
|
|
replacement: [
|
|
{
|
|
match: /MESSAGE_DELETE:function\((\i)\).+?},/,
|
|
replace: "MESSAGE_DELETE:function($1){},"
|
|
},
|
|
{
|
|
match: /MESSAGE_DELETE_BULK:function\((\i)\).+?},/,
|
|
replace: "MESSAGE_DELETE_BULK:function($1){},"
|
|
}
|
|
]
|
|
},
|
|
|
|
{
|
|
// Message context base menu
|
|
find: "useMessageMenu:",
|
|
replacement: [
|
|
{
|
|
// Remove the first section if message is deleted
|
|
match: /children:(\[""===.+?\])/,
|
|
replace: "children:arguments[0].message.deleted?[]:$1"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
// Message grouping
|
|
find: "NON_COLLAPSIBLE.has(",
|
|
replacement: {
|
|
match: /if\((\i)\.blocked\)return \i\.\i\.MESSAGE_GROUP_BLOCKED;/,
|
|
replace: '$&else if($1.deleted) return"MESSAGE_GROUP_DELETED";',
|
|
},
|
|
predicate: () => Settings.plugins.MessageLogger.collapseDeleted
|
|
},
|
|
{
|
|
// Message group rendering
|
|
find: "Messages.NEW_MESSAGES_ESTIMATED_WITH_DATE",
|
|
replacement: [
|
|
{
|
|
match: /(\i).type===\i\.\i\.MESSAGE_GROUP_BLOCKED\|\|/,
|
|
replace: '$&$1.type==="MESSAGE_GROUP_DELETED"||',
|
|
},
|
|
{
|
|
match: /(\i).type===\i\.\i\.MESSAGE_GROUP_BLOCKED\?.*?:/,
|
|
replace: '$&$1.type==="MESSAGE_GROUP_DELETED"?$self.Messages.DELETED_MESSAGE_COUNT:',
|
|
},
|
|
],
|
|
predicate: () => Settings.plugins.MessageLogger.collapseDeleted
|
|
}
|
|
]
|
|
});
|