add ViewRaw plugin & MiniPopover API (#275)

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

.gitignore

@@ -18,3 +18,6 @@ lerna-debug.log*
 *.tsbuildinfo
 
 src/userplugins
+
+ExtensionCache/
+settings/

src/api/MessagePopover.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 Logger from "@utils/Logger";
+import { Channel, Message } from "discord-types/general";
+import type { MouseEventHandler } from "react";
+
+const logger = new Logger("MessagePopover");
+
+export interface ButtonItem {
+    key?: string,
+    label: string,
+    icon: React.ComponentType<any>,
+    message: Message,
+    channel: Channel,
+    onClick?: MouseEventHandler<HTMLButtonElement>,
+    onContextMenu?: MouseEventHandler<HTMLButtonElement>;
+}
+
+export type getButtonItem = (message: Message) => ButtonItem | null;
+
+export const buttons = new Map<string, getButtonItem>();
+
+export function addButton(
+    identifier: string,
+    item: getButtonItem,
+) {
+    buttons.set(identifier, item);
+}
+
+export function removeButton(identifier: string) {
+    buttons.delete(identifier);
+}
+
+export function _buildPopoverElements(
+    msg: Message,
+    makeButton: (item: ButtonItem) => React.ComponentType
+) {
+    const items = [] as React.ComponentType[];
+
+    for (const [identifier, getItem] of buttons.entries()) {
+        try {
+            const item = getItem(msg);
+            if (item) {
+                item.key ??= identifier;
+                items.push(makeButton(item));
+            }
+        } catch (err) {
+            logger.error(`[${identifier}]`, err);
+        }
+    }
+
+    return items;
+}

src/api/index.ts

@@ -21,6 +21,7 @@ import * as $Commands from "./Commands";
 import * as $DataStore from "./DataStore";
 import * as $MessageAccessories from "./MessageAccessories";
 import * as $MessageEventsAPI from "./MessageEvents";
+import * as $MessagePopover from "./MessagePopover";
 import * as $Notices from "./Notices";
 import * as $ServerList from "./ServerList";
 
@@ -59,6 +60,10 @@ const DataStore = $DataStore;
  * An API allowing you to add custom components as message accessories
  */
 const MessageAccessories = $MessageAccessories;
+/**
+ * An API allowing you to add custom buttons in the message popover
+ */
+const MessagePopover = $MessagePopover;
 /**
  * An API allowing you to add badges to user profiles
  */
@@ -68,4 +73,4 @@ const Badges = $Badges;
  */
 const ServerList = $ServerList;
 
-export { Badges, Commands, DataStore, MessageAccessories, MessageEvents, Notices, ServerList };
+export { Badges, Commands, DataStore, MessageAccessories, MessageEvents, MessagePopover, Notices, ServerList };

src/plugins/apiMessagePopover.ts

@@ -0,0 +1,33 @@
+/*
+ * 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 { Devs } from "@utils/constants";
+import definePlugin from "@utils/types";
+
+export default definePlugin({
+    name: "MessagePopoverAPI",
+    description: "API to add buttons to message popovers.",
+    authors: [Devs.KingFish],
+    patches: [{
+        find: "Messages.MESSAGE_UTILITIES_A11Y_LABEL",
+        replacement: {
+            match: /(message:(.).{0,100}Fragment,\{children:\[)(.{0,90}renderPopout:.{0,200}message_reaction_emoji_picker.+?return (.{1,3})\(.{0,30}"add-reaction")/,
+            replace: "$1...Vencord.Api.MessagePopover._buildPopoverElements($2,$4),$3"
+        }
+    }],
+});

src/plugins/hideAttachments.tsx

@@ -17,11 +17,10 @@
 */
 
 import { get, set } from "@api/DataStore";
+import { addButton, removeButton } from "@api/MessagePopover";
 import { Devs } from "@utils/constants";
-import Logger from "@utils/Logger";
 import definePlugin from "@utils/types";
 import { ChannelStore, FluxDispatcher } from "@webpack/common";
-import { Message } from "discord-types/general";
 
 let style: HTMLStyleElement;
 
@@ -49,13 +48,7 @@ export default definePlugin({
     name: "HideAttachments",
     description: "Hide attachments and Embeds for individual messages via hover button",
     authors: [Devs.Ven],
-    patches: [{
+    dependencies: ["MessagePopoverAPI"],
-        find: "Messages.MESSAGE_UTILITIES_A11Y_LABEL",
-        replacement: {
-            match: /(message:(.).{0,100}Fragment,\{children:\[)(.{0,40}renderPopout:.{0,200}message_reaction_emoji_picker.+?return (.{1,3})\(.{0,30}"add-reaction")/,
-            replace: "$1Vencord.Plugins.plugins.HideAttachments.renderButton($2, $4),$3"
-        }
-    }],
 
     async start() {
         style = document.createElement("style");
@@ -64,11 +57,26 @@ export default definePlugin({
 
         await getHiddenMessages();
         await this.buildCss();
+
+        addButton("HideAttachments", msg => {
+            if (!msg.attachments.length && !msg.embeds.length) return null;
+
+            const isHidden = hiddenMessages.has(msg.id);
+
+            return {
+                label: isHidden ? "Show Attachments" : "Hide Attachments",
+                icon: isHidden ? ImageVisible : ImageInvisible,
+                message: msg,
+                channel: ChannelStore.getChannel(msg.channel_id),
+                onClick: () => this.toggleHide(msg.id)
+            };
+        });
     },
 
     stop() {
         style.remove();
         hiddenMessages.clear();
+        removeButton("HideAttachments");
     },
 
     async buildCss() {
@@ -86,26 +94,6 @@ export default definePlugin({
         `;
     },
 
-    renderButton(msg: Message, makeItem: (data: any) => React.ComponentType) {
-        try {
-            if (!msg.attachments.length && !msg.embeds.length) return null;
-
-            const isHidden = hiddenMessages.has(msg.id);
-
-            return makeItem({
-                key: "HideAttachments",
-                label: isHidden ? "Show Attachments" : "Hide Attachments",
-                icon: isHidden ? ImageVisible : ImageInvisible,
-                message: msg,
-                channel: ChannelStore.getChannel(msg.channel_id),
-                onClick: () => this.toggleHide(msg.id)
-            });
-        } catch (err) {
-            new Logger("HideAttachments").error(err);
-            return null;
-        }
-    },
-
     async toggleHide(id: string) {
         const ids = await getHiddenMessages();
         if (!ids.delete(id))

src/plugins/quickMention.tsx

@@ -16,9 +16,11 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
+import { addButton, removeButton } from "@api/MessagePopover";
 import { Devs } from "@utils/constants";
 import definePlugin from "@utils/types";
 import { findLazy } from "@webpack";
+import { ChannelStore } from "@webpack/common";
 
 const ComponentDispatch = findLazy(m => m.emitter?._events?.INSERT_TEXT);
 
@@ -26,29 +28,22 @@ export default definePlugin({
     name: "QuickMention",
     authors: [Devs.kemo],
     description: "Adds a quick mention button to the message actions bar",
+    dependencies: ["MessagePopoverAPI"],
 
-    patches: [
+    start() {
-        {
+        addButton("QuickMention", msg => {
-            find: "Messages.MESSAGE_UTILITIES_A11Y_LABEL",
+            return {
-            replacement: {
+                label: "Quick Mention",
-                match: /(null,)(.{1,3}&&!.{1,3}\?(.{1,3})\(\{key:"reply",label:.{1,10}\.Messages\.MESSAGE_ACTION_REPLY,icon:.{1,10},channel:(.+?),message:(.+?),onClick:.+?\}\))/,
+                icon: this.Icon,
-                replace: (m, post, og, functionName, channelVar, messageVar) => {
+                message: msg,
-
+                channel: ChannelStore.getChannel(msg.channel_id),
-                    const functionSig =
+                onClick: () => ComponentDispatch.dispatchToLastSubscribed("INSERT_TEXT", { rawText: `<@${msg.author.id}> ` })
-                        `${functionName}({
+            };
-                        key: "QuickMention",
+        });
-                        label: "Mention",
+    },
-                        icon: Vencord.Plugins.plugins.QuickMention.Icon,
+    stop() {
-                        channel: ${channelVar},
+        removeButton("QuickMention");
-                        message: ${messageVar},
+    },
-                        onClick: ()=> Vencord.Plugins.plugins.QuickMention.onClick(${messageVar})
-                    })`;
-
-                    return `${post}${functionSig},${og}`;
-                }
-            }
-        }
-    ],
 
     Icon: () => (
         <svg
@@ -63,6 +58,4 @@ export default definePlugin({
             />
         </svg>
     ),
-
-    onClick: (message: any) => ComponentDispatch.dispatchToLastSubscribed("INSERT_TEXT", { rawText: `<@${message.author.id}> ` })
 });

src/plugins/viewRaw.tsx

@@ -0,0 +1,147 @@
+/*
+ * 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 { addButton, removeButton } from "@api/MessagePopover";
+import ErrorBoundary from "@components/ErrorBoundary";
+import { Flex } from "@components/Flex";
+import { Devs } from "@utils/constants";
+import { copyWithToast } from "@utils/misc";
+import { closeModal, ModalCloseButton, ModalContent, ModalHeader, ModalRoot, ModalSize, openModal } from "@utils/modal";
+import definePlugin from "@utils/types";
+import { Button, ChannelStore, Forms, Margins, Parser } from "@webpack/common";
+import { Message } from "discord-types/general";
+
+
+const CopyIcon = () => {
+    return <svg viewBox="0 0 512.002 512.002" fill="currentColor" aria-hidden="true" width="22" height="22">
+        <path d="M462.002,92.002h-42.001V50c0-27.57-22.43-50-50-50h-320c-27.57,0-50,22.43-50,50v320.002c0,27.57,22.43,50,50,50h42.001    v42c0,27.57,22.43,50,50,50h320c27.57,0,50-22.43,50-50v-320C512.001,114.432,489.573,92.002,462.002,92.002z M50.001,400.002    c-16.542,0-30-13.458-30-30V50c0-16.542,13.458-30,30-30h320c16.542,0,30,13.458,30,30v320.002c0,16.542-13.458,30-30,30H50.001z     M492.002,462.002c0,16.542-13.458,30-30,30h-320c-16.542,0-30-13.458-30-30v-42h257.999c27.57,0,50-22.43,50-50v-258h42.001    c16.542,0,30,13.458,30,30V462.002z" />
+        <path d="M462.024,457.002H170.98c-5.522,0-10,4.478-10,10c0,5.523,4.478,10,10,10h291.043c5.522,0,10-4.477,10-10    S467.546,457.002,462.024,457.002z" />
+        <path d="M142.25,457.002h-0.27c-5.522,0-10,4.478-10,10c0,5.523,4.478,10,10,10h0.27c5.523,0,10-4.477,10-10    S147.773,457.002,142.25,457.002z" />
+        <path d="M110.035,35h-0.27c-5.522,0-10,4.478-10,10s4.478,10,10,10h0.27c5.522,0,10-4.478,10-10S115.558,35,110.035,35z" />
+        <path d="M81.036,35H50.001c-5.522,0-10,4.478-10,10s4.478,10,10,10h31.034c5.523,0,10.001-4.478,10.001-10S86.558,35,81.036,35z" />
+        <path d="M122.084,246.829l-0.008-0.008l-14.8-30.002c5.407-2.305,10.07-5.975,13.466-10.537c3.725-5.006,5.931-11.08,5.931-17.604    c0-8.588-3.248-15.902-9.743-21.965c-3.196-2.992-6.739-5.242-10.627-6.744c-3.891-1.506-8.097-2.258-12.612-2.258H64.936    c-2.793,0-5.327,1.145-7.163,2.996c-1.832,1.85-2.968,4.396-2.968,7.205v82.777c0,2.896,1.137,5.338,2.893,7.105    c0.962,0.969,2.107,1.728,3.349,2.246c1.249,0.52,2.597,0.797,3.953,0.797c2.49,0,5.028-0.92,7.096-2.967    c1.004-0.99,1.761-2.09,2.271-3.297c0.516-1.221,0.771-2.516,0.771-3.885v-31.139h10.844l17.862,36.184l-0.004,0.005    c1.315,2.699,3.416,4.4,5.763,5.201c1.275,0.434,2.616,0.596,3.938,0.502c1.317-0.094,2.618-0.44,3.812-1.022    c2.307-1.123,4.237-3.123,5.179-5.881h0.002c0.45-1.307,0.639-2.609,0.564-3.904C123.023,249.327,122.684,248.058,122.084,246.829    z M106.124,190.85c-0.438,1.795-1.473,3.546-3.189,5.07c-1.205,1.039-2.538,1.838-3.996,2.395c-1.45,0.553-3.02,0.865-4.704,0.934    v-0.006H75.138v-21.221H93.69c3.19,0,5.9,0.893,7.984,2.328c1.83,1.26,3.187,2.939,3.96,4.791    C106.393,186.957,106.591,188.942,106.124,190.85z" />
+        <path d="M364.199,163.706c-1.12-2.354-3.136-4.285-5.777-5.254l-0.055-0.016c-2.721-0.916-5.49-0.688-7.823,0.439    c-2.349,1.135-4.243,3.172-5.193,5.861v0.008l-19.568,55.744l-19.571-55.816h-0.001c-0.705-2.352-2.14-4.141-3.935-5.322    c-1.589-1.047-3.458-1.609-5.345-1.656c-1.887-0.047-3.801,0.42-5.479,1.43c-1.938,1.164-3.553,3.031-4.445,5.637h0.002    l-19.564,55.73l-19.569-55.746l-0.008-0.016c-0.997-2.779-2.938-4.752-5.235-5.846c-1.222-0.584-2.552-0.918-3.899-0.99    c-1.34-0.074-2.701,0.115-3.991,0.578c-2.347,0.842-4.429,2.57-5.701,5.24c-1.206,2.529-1.354,5.119-0.441,7.766l0.005,0.009    l29.181,83.133l0.016,0.047c1.186,3.139,3.318,5.213,5.775,6.234c1.141,0.473,2.355,0.717,3.581,0.73    c1.219,0.016,2.438-0.197,3.595-0.635c2.602-0.982,4.914-3.084,6.238-6.268l0.039-0.109l19.595-55.779l20.043,56.877l0.047,0.125    c0.967,2.25,2.404,3.912,4.071,4.99c1.666,1.078,3.544,1.563,5.408,1.465c1.854-0.096,3.686-0.764,5.274-1.992    c1.666-1.289,3.059-3.191,3.899-5.686l29.251-83.133C365.546,168.825,365.317,166.053,364.199,163.706z" />
+        <path d="M226.7,247.37l-0.008-0.031l-8.818-21.24l-0.003,0.002l-25.528-61.617h0.001c-1.024-2.709-3.167-4.654-5.674-5.645    c-1.165-0.461-2.429-0.715-3.708-0.742c-1.28-0.027-2.565,0.178-3.773,0.635c-2.393,0.906-4.479,2.764-5.647,5.719l0.005,0.002    l-25.54,61.719h-0.003l-8.818,21.168v0.008c-1.076,2.607-1,5.383-0.008,7.783c0.994,2.408,2.91,4.433,5.51,5.527l0.038,0.023    c2.619,1.035,5.435,1.064,7.886,0.041c2.295-0.955,4.242-2.813,5.384-5.6l6.147-14.877h37.566l6.148,14.877    c1.175,2.844,3.171,4.674,5.459,5.609c1.261,0.518,2.601,0.752,3.932,0.73c1.324-0.021,2.642-0.295,3.865-0.801    c2.418-0.998,4.496-2.9,5.579-5.547l0.008-0.016C227.723,252.523,227.723,249.945,226.7,247.37z M172.552,219.938l10.344-25.01    l10.416,25.01H172.552z" />
+    </svg>;
+};
+
+function sortObject<T extends object>(obj: T): T {
+    return Object.fromEntries(Object.entries(obj).sort(([k1], [k2]) => k1.localeCompare(k2))) as T;
+}
+
+function cleanMessage(msg: Message) {
+    const clone = sortObject(JSON.parse(JSON.stringify(msg)));
+    for (const key in clone.author) {
+        switch (key) {
+            case "id":
+            case "username":
+            case "usernameNormalized":
+            case "discriminator":
+            case "avatar":
+            case "bot":
+            case "system":
+            case "publicFlags":
+                break;
+            default:
+                // phone number, email, etc
+                delete clone.author[key];
+        }
+    }
+
+    // message logger added properties
+    const cloneAny = clone as any;
+    delete cloneAny.editHistory;
+    delete cloneAny.deleted;
+    cloneAny.attachments?.forEach(a => delete a.deleted);
+
+    return clone;
+}
+
+function CodeBlock(props: { content: string, lang: string; }) {
+    return (
+        // make text selectable
+        <div style={{ userSelect: "text" }}>
+            {Parser.defaultRules.codeBlock.react(props, null, {})}
+        </div>
+    );
+}
+
+function openViewRawModal(msg: Message) {
+    msg = cleanMessage(msg);
+    const msgJson = JSON.stringify(msg, null, 4);
+
+    const key = openModal(props => (
+        <ErrorBoundary>
+            <ModalRoot {...props} size={ModalSize.LARGE}>
+                <ModalHeader>
+                    <Forms.FormTitle tag="h1">View Raw</Forms.FormTitle>
+                    <ModalCloseButton onClick={() => closeModal(key)} />
+                </ModalHeader>
+                <ModalContent style={{ padding: "1em" }}>
+                    <Flex style={{ marginBottom: "1em", marginTop: "1em" }}>
+                        <Button onClick={() => copyWithToast(msg.content, "Content copied to clipboard!")}>
+                            Copy Raw Content
+                        </Button>
+                        <Button onClick={() => copyWithToast(msgJson, "Message data copied to clipboard!")}>
+                            Copy Message JSON
+                        </Button>
+                    </Flex>
+
+                    {!!msg.content && (
+                        <>
+                            <Forms.FormTitle tag="h5">Content</Forms.FormTitle>
+                            <CodeBlock content={msg.content} lang="" />
+                            <Forms.FormDivider classes={Margins.marginBottom20} />
+                        </>
+                    )}
+
+                    <Forms.FormTitle tag="h5">Message Data</Forms.FormTitle>
+                    <CodeBlock content={msgJson} lang="json" />
+                </ModalContent >
+            </ModalRoot >
+        </ErrorBoundary >
+    ));
+}
+
+export default definePlugin({
+    name: "ViewRaw",
+    description: "Copy and view the raw content/data of any message.",
+    authors: [Devs.KingFish, Devs.Ven],
+    dependencies: ["MessagePopoverAPI"],
+
+    start() {
+        addButton("ViewRaw", msg => {
+            return {
+                label: "View Raw (Left Click) / Copy Raw (Right Click)",
+                icon: CopyIcon,
+                message: msg,
+                channel: ChannelStore.getChannel(msg.channel_id),
+                onClick: () => openViewRawModal(msg),
+                onContextMenu: e => {
+                    e.preventDefault();
+                    e.stopPropagation();
+                    copyWithToast(msg.content);
+                }
+            };
+        });
+    },
+
+    stop() {
+        removeButton("CopyRawMessage");
+    }
+});

src/utils/constants.ts

@@ -156,5 +156,9 @@ export const Devs = Object.freeze({
     Luna: {
         name: "Luny",
         id: 821472922140803112n
+    },
+    KingFish: {
+        name: "King Fish",
+        id: 499400512559382538n
     }
 });

src/utils/misc.tsx

@@ -16,7 +16,7 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
-import { React } from "@webpack/common";
+import { Clipboard, React, Toasts } from "@webpack/common";
 
 /**
  * Makes a lazy function. On first call, the value is computed.
@@ -175,5 +175,25 @@ export function suppressErrors<F extends Function>(name: string, func: F, thisOb
  */
 export function makeCodeblock(text: string, language?: string) {
     const chars = "```";
-    return `${chars}${language || ""}\n${text}\n${chars}`;
+    return `${chars}${language || ""}\n${text.replaceAll("```", "\\`\\`\\`")}\n${chars}`;
+}
+
+export function copyWithToast(text: string, toastMessage = "Copied to clipboard!") {
+    if (Clipboard.SUPPORTS_COPY) {
+        Clipboard.copy(text);
+    } else {
+        toastMessage = "Your browser does not support copying to clipboard";
+    }
+    Toasts.show({
+        message: toastMessage,
+        id: Toasts.genId(),
+        type: Toasts.Type.SUCCESS
+    });
+}
+
+/**
+ * Check if obj is a true object: of type "object" and not null or array
+ */
+export function isObject(obj: unknown): obj is object {
+    return typeof obj === "object" && obj !== null && !Array.isArray(obj);
 }