MessageLogger: add context menu option to clear channel history (#2008)

Co-authored-by: vee <vendicated@riseup.net>

src/api/MessageUpdater.ts

@@ -14,7 +14,7 @@ import { Message } from "discord-types/general";
  * @param messageId The message id
  * @param fields The fields of the message to change. Leave empty if you just want to re-render
  */
-export function updateMessage(channelId: string, messageId: string, fields?: Partial<Message>) {
+export function updateMessage(channelId: string, messageId: string, fields?: Partial<Message & Record<string, any>>) {
     const channelMessageCache = MessageCache.getOrCreate(channelId);
     if (!channelMessageCache.has(messageId)) return;
 

src/plugins/messageLogger/index.tsx

@@ -18,7 +18,8 @@
 
 import "./messageLogger.css";
 
-import { NavContextMenuPatchCallback } from "@api/ContextMenu";
+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";
@@ -26,11 +27,17 @@ import { Devs } from "@utils/constants";
 import { Logger } from "@utils/Logger";
 import definePlugin, { OptionType } from "@utils/types";
 import { findByPropsLazy } from "@webpack";
-import { ChannelStore, FluxDispatcher, i18n, Menu, Parser, Timestamp, UserStore } from "@webpack/common";
+import { ChannelStore, FluxDispatcher, i18n, Menu, MessageStore, Parser, Timestamp, UserStore, useStateFromStores } from "@webpack/common";
+import { Message } from "discord-types/general";
 
 import overlayStyle from "./deleteStyleOverlay.css?managed";
 import textStyle from "./deleteStyleText.css?managed";
 
+interface MLMessage extends Message {
+    deleted?: boolean;
+    editHistory?: { timestamp: Date; content: string; }[];
+}
+
 const styles = findByPropsLazy("edited", "communicationDisabled", "isSystemMessage");
 
 function addDeleteStyle() {
@@ -89,35 +96,77 @@ const patchMessageContextMenu: NavContextMenuPatchCallback = (children, props) =
     ));
 };
 
+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 default definePlugin({
     name: "MessageLogger",
     description: "Temporarily logs deleted and edited messages.",
-    authors: [Devs.rushii, Devs.Ven, Devs.AutumnVN],
+    authors: [Devs.rushii, Devs.Ven, Devs.AutumnVN, Devs.Nickyux],
+    dependencies: ["MessageUpdaterAPI"],
 
     contextMenus: {
-        "message": patchMessageContextMenu
+        "message": patchMessageContextMenu,
+        "channel-context": patchChannelContextMenu,
+        "user-context": patchChannelContextMenu,
+        "gdm-context": patchChannelContextMenu
     },
 
     start() {
         addDeleteStyle();
     },
 
-    renderEdit(edit: { timestamp: any, content: string; }) {
+    renderEdits: ErrorBoundary.wrap(({ message: { id: messageId, channel_id: channelId } }: { message: Message; }) => {
-        return (
+        const message = useStateFromStores(
-            <ErrorBoundary noop>
+            [MessageStore],
-                <div className="messagelogger-edited">
+            () => MessageStore.getMessage(channelId, messageId) as MLMessage,
-                    {Parser.parse(edit.content)}
+            null,
-                    <Timestamp
+            (oldMsg, newMsg) => oldMsg.editHistory === newMsg.editHistory
-                        timestamp={edit.timestamp}
-                        isEdited={true}
-                        isInline={false}
-                    >
-                        <span className={styles.edited}>{" "}({i18n.Messages.MESSAGE_EDITED})</span>
-                    </Timestamp>
-                </div>
-            </ErrorBoundary>
         );
-    },
+
+        return (
+            <>
+                {message.editHistory?.map(edit => (
+                    <div className="messagelogger-edited">
+                        {Parser.parse(edit.content)}
+                        <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 {
@@ -222,11 +271,9 @@ export default definePlugin({
             (message.channel_id === "1026515880080842772" && message.author?.id === "1017176847865352332");
     },
 
-    // Based on canary 63b8f1b4f2025213c5cf62f0966625bee3d53136
     patches: [
         {
             // MessageStore
-            // Module 171447
             find: '"MessageStore"',
             replacement: [
                 {
@@ -271,7 +318,6 @@ export default definePlugin({
 
         {
             // Message domain model
-            // Module 451
             find: "}addReaction(",
             replacement: [
                 {
@@ -285,14 +331,8 @@ export default definePlugin({
 
         {
             // Updated message transformer(?)
-            // Module 819525
             find: "THREAD_STARTER_MESSAGE?null===",
             replacement: [
-                // {
-                //     // DEBUG: Log the params of the target function to the patch below
-                //     match: /function N\(e,t\){/,
-                //     replace: "function L(e,t){console.log('pre-transform', e, t);"
-                // },
                 {
                     // Pass through editHistory & deleted & original attachments to the "edited message" transformer
                     match: /(?<=null!=\i\.edited_timestamp\)return )\i\(\i,\{reactions:(\i)\.reactions.{0,50}\}\)/,
@@ -300,11 +340,6 @@ export default definePlugin({
                         "Object.assign($&,{ deleted:$1.deleted, editHistory:$1.editHistory, attachments:$1.attachments })"
                 },
 
-                // {
-                //     // DEBUG: Log the params of the target function to the patch below
-                //     match: /function R\(e\){/,
-                //     replace: "function R(e){console.log('after-edit-transform', arguments);"
-                // },
                 {
                     // Construct new edited message and add editHistory & deleted (ref above)
                     // Pass in custom data to attachment parser to mark attachments deleted as well
@@ -335,7 +370,6 @@ export default definePlugin({
 
         {
             // Attachment renderer
-            // Module 96063
             find: ".removeMosaicItemHoverButton",
             group: true,
             replacement: [
@@ -352,7 +386,6 @@ export default definePlugin({
 
         {
             // Base message component renderer
-            // Module 748241
             find: "Message must not be a thread starter message",
             replacement: [
                 {
@@ -365,20 +398,18 @@ export default definePlugin({
 
         {
             // Message content renderer
-            // Module 43016
             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 > 0 ? arguments[0].message.editHistory.map(edit => $self.renderEdit(edit)) : null), "
+                    replace: "$1 (!!arguments[0].message.editHistory?.length && $self.renderEdits(arguments[0])),"
                 }
             ]
         },
 
         {
             // ReferencedMessageStore
-            // Module 778667
             find: '"ReferencedMessageStore"',
             replacement: [
                 {
@@ -394,7 +425,6 @@ export default definePlugin({
 
         {
             // Message context base menu
-            // Module 600300
             find: "useMessageMenu:",
             replacement: [
                 {
@@ -404,18 +434,5 @@ export default definePlugin({
                 }
             ]
         }
-
-        // {
-        //     // MessageStore caching internals
-        //     // Module 819525
-        //     find: "e.getOrCreate=function(t)",
-        //     replacement: [
-        //         // {
-        //         //     // DEBUG: log getOrCreate return values from MessageStore caching internals
-        //         //     match: /getOrCreate=function(.+?)return/,
-        //         //     replace: "getOrCreate=function$1console.log('getOrCreate',n);return"
-        //         // }
-        //     ]
-        // }
     ]
 });