feat: Context Menu API (#496)
This commit is contained in:
parent
40395d562a
commit
1b199ec5d8
141
src/api/ContextMenu.ts
Normal file
141
src/api/ContextMenu.ts
Normal file
@ -0,0 +1,141 @@
|
|||||||
|
/*
|
||||||
|
* Vencord, a modification for Discord's desktop app
|
||||||
|
* Copyright (c) 2023 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 type { ReactElement } from "react";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param children The rendered context menu elements
|
||||||
|
* @param args Any arguments passed into making the context menu, like the guild, channel, user or message for example
|
||||||
|
*/
|
||||||
|
export type NavContextMenuPatchCallback = (children: Array<React.ReactElement>, args?: Array<any>) => void;
|
||||||
|
/**
|
||||||
|
* @param The navId of the context menu being patched
|
||||||
|
* @param children The rendered context menu elements
|
||||||
|
* @param args Any arguments passed into making the context menu, like the guild, channel, user or message for example
|
||||||
|
*/
|
||||||
|
export type GlobalContextMenuPatchCallback = (navId: string, children: Array<React.ReactElement>, args?: Array<any>) => void;
|
||||||
|
|
||||||
|
const ContextMenuLogger = new Logger("ContextMenu");
|
||||||
|
|
||||||
|
export const navPatches = new Map<string, Set<NavContextMenuPatchCallback>>();
|
||||||
|
export const globalPatches = new Set<GlobalContextMenuPatchCallback>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add a context menu patch
|
||||||
|
* @param navId The navId(s) for the context menu(s) to patch
|
||||||
|
* @param patch The patch to be applied
|
||||||
|
*/
|
||||||
|
export function addContextMenuPatch(navId: string | Array<string>, patch: NavContextMenuPatchCallback) {
|
||||||
|
if (!Array.isArray(navId)) navId = [navId];
|
||||||
|
for (const id of navId) {
|
||||||
|
let contextMenuPatches = navPatches.get(id);
|
||||||
|
if (!contextMenuPatches) {
|
||||||
|
contextMenuPatches = new Set();
|
||||||
|
navPatches.set(id, contextMenuPatches);
|
||||||
|
}
|
||||||
|
|
||||||
|
contextMenuPatches.add(patch);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add a global context menu patch that fires the patch for all context menus
|
||||||
|
* @param patch The patch to be applied
|
||||||
|
*/
|
||||||
|
export function addGlobalContextMenuPatch(patch: GlobalContextMenuPatchCallback) {
|
||||||
|
globalPatches.add(patch);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove a context menu patch
|
||||||
|
* @param navId The navId(s) for the context menu(s) to remove the patch
|
||||||
|
* @param patch The patch to be removed
|
||||||
|
* @returns Wheter the patch was sucessfully removed from the context menu(s)
|
||||||
|
*/
|
||||||
|
export function removeContextMenuPatch<T extends string | Array<string>>(navId: T, patch: NavContextMenuPatchCallback): T extends string ? boolean : Array<boolean> {
|
||||||
|
const navIds = Array.isArray(navId) ? navId : [navId as string];
|
||||||
|
|
||||||
|
const results = navIds.map(id => navPatches.get(id)?.delete(patch) ?? false);
|
||||||
|
|
||||||
|
return (Array.isArray(navId) ? results : results[0]) as T extends string ? boolean : Array<boolean>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove a global context menu patch
|
||||||
|
* @returns Wheter the patch was sucessfully removed
|
||||||
|
*/
|
||||||
|
export function removeGlobalContextMenuPatch(patch: GlobalContextMenuPatchCallback): boolean {
|
||||||
|
return globalPatches.delete(patch);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A helper function for finding the children array of a group nested inside a context menu based on the id of one of its childs
|
||||||
|
* @param id The id of the child
|
||||||
|
*/
|
||||||
|
export function findGroupChildrenByChildId(id: string, children: Array<React.ReactElement>, itemsArray?: Array<React.ReactElement>): Array<React.ReactElement> | null {
|
||||||
|
for (const child of children) {
|
||||||
|
if (child === null) continue;
|
||||||
|
|
||||||
|
if (child.props?.id === id) return itemsArray ?? null;
|
||||||
|
|
||||||
|
let nextChildren = child.props?.children;
|
||||||
|
if (nextChildren) {
|
||||||
|
if (!Array.isArray(nextChildren)) {
|
||||||
|
nextChildren = [nextChildren];
|
||||||
|
child.props.children = nextChildren;
|
||||||
|
}
|
||||||
|
|
||||||
|
const found = findGroupChildrenByChildId(id, nextChildren, nextChildren);
|
||||||
|
if (found !== null) return found;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ContextMenuProps {
|
||||||
|
contextMenuApiArguments?: Array<any>;
|
||||||
|
navId: string;
|
||||||
|
children: Array<ReactElement>;
|
||||||
|
"aria-label": string;
|
||||||
|
onSelect: (() => void) | undefined;
|
||||||
|
onClose: (callback: (...args: Array<any>) => any) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function _patchContextMenu(props: ContextMenuProps) {
|
||||||
|
const contextMenuPatches = navPatches.get(props.navId);
|
||||||
|
|
||||||
|
if (contextMenuPatches) {
|
||||||
|
for (const patch of contextMenuPatches) {
|
||||||
|
try {
|
||||||
|
patch(props.children, props.contextMenuApiArguments);
|
||||||
|
} catch (err) {
|
||||||
|
ContextMenuLogger.error(`Patch for ${props.navId} errored,`, err);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const patch of globalPatches) {
|
||||||
|
try {
|
||||||
|
patch(props.navId, props.children, props.contextMenuApiArguments);
|
||||||
|
} catch (err) {
|
||||||
|
ContextMenuLogger.error("Global patch errored,", err);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
@ -18,6 +18,7 @@
|
|||||||
|
|
||||||
import * as $Badges from "./Badges";
|
import * as $Badges from "./Badges";
|
||||||
import * as $Commands from "./Commands";
|
import * as $Commands from "./Commands";
|
||||||
|
import * as $ContextMenu from "./ContextMenu";
|
||||||
import * as $DataStore from "./DataStore";
|
import * as $DataStore from "./DataStore";
|
||||||
import * as $MemberListDecorators from "./MemberListDecorators";
|
import * as $MemberListDecorators from "./MemberListDecorators";
|
||||||
import * as $MessageAccessories from "./MessageAccessories";
|
import * as $MessageAccessories from "./MessageAccessories";
|
||||||
@ -93,3 +94,8 @@ export const Styles = $Styles;
|
|||||||
* An API allowing you to display notifications
|
* An API allowing you to display notifications
|
||||||
*/
|
*/
|
||||||
export const Notifications = $Notifications;
|
export const Notifications = $Notifications;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An api allowing you to patch and add/remove items to/from context menus
|
||||||
|
*/
|
||||||
|
export const ContextMenu = $ContextMenu;
|
||||||
|
69
src/plugins/apiContextMenu.ts
Normal file
69
src/plugins/apiContextMenu.ts
Normal file
@ -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 { Settings } from "@api/settings";
|
||||||
|
import { Devs } from "@utils/constants";
|
||||||
|
import definePlugin from "@utils/types";
|
||||||
|
import { addListener, removeListener } from "@webpack";
|
||||||
|
|
||||||
|
function listener(exports: any, id: number) {
|
||||||
|
if (typeof exports !== "object" || exports === null) return;
|
||||||
|
|
||||||
|
for (const key in exports) if (key.length <= 3) {
|
||||||
|
const prop = exports[key];
|
||||||
|
if (typeof prop !== "function") continue;
|
||||||
|
|
||||||
|
const str = Function.prototype.toString.call(prop);
|
||||||
|
if (str.includes('path:["empty"]')) {
|
||||||
|
Vencord.Plugins.patches.push({
|
||||||
|
plugin: "ContextMenuAPI",
|
||||||
|
all: true,
|
||||||
|
noWarn: true,
|
||||||
|
find: "navId:",
|
||||||
|
replacement: {
|
||||||
|
/** Regex explanation
|
||||||
|
* Use of https://blog.stevenlevithan.com/archives/mimic-atomic-groups to mimick atomic groups: (?=(...))\1
|
||||||
|
* Match ${id} and look behind it for the first match of `<variable name>=`: ${id}(?=(\i)=.+?)
|
||||||
|
* Match rest of the code until it finds `<variable name>.${key},{`: .+?\2\.${key},{
|
||||||
|
*/
|
||||||
|
match: RegExp(`(?=(${id}(?<=(\\i)=.+?).+?\\2\\.${key},{))\\1`, "g"),
|
||||||
|
replace: "$&contextMenuApiArguments:arguments,"
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
removeListener(listener);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (Settings.plugins.ContextMenuAPI.enabled) addListener(listener);
|
||||||
|
|
||||||
|
export default definePlugin({
|
||||||
|
name: "ContextMenuAPI",
|
||||||
|
description: "API for adding/removing items to/from context menus.",
|
||||||
|
authors: [Devs.Nuckyz],
|
||||||
|
patches: [
|
||||||
|
{
|
||||||
|
find: "♫ (つ。◕‿‿◕。)つ ♪",
|
||||||
|
replacement: {
|
||||||
|
match: /(?<=function \i\((\i)\){)(?=var \i,\i=\i\.navId)/,
|
||||||
|
replace: (_, props) => `Vencord.Api.ContextMenu._patchContextMenu(${props});`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
});
|
@ -92,9 +92,11 @@ function patchPush() {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const numberId = Number(id);
|
||||||
|
|
||||||
for (const callback of listeners) {
|
for (const callback of listeners) {
|
||||||
try {
|
try {
|
||||||
callback(exports);
|
callback(exports, numberId);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.error("Error in webpack listener", err);
|
logger.error("Error in webpack listener", err);
|
||||||
}
|
}
|
||||||
@ -104,17 +106,17 @@ function patchPush() {
|
|||||||
try {
|
try {
|
||||||
if (filter(exports)) {
|
if (filter(exports)) {
|
||||||
subscriptions.delete(filter);
|
subscriptions.delete(filter);
|
||||||
callback(exports);
|
callback(exports, numberId);
|
||||||
} else if (typeof exports === "object") {
|
} else if (typeof exports === "object") {
|
||||||
if (exports.default && filter(exports.default)) {
|
if (exports.default && filter(exports.default)) {
|
||||||
subscriptions.delete(filter);
|
subscriptions.delete(filter);
|
||||||
callback(exports.default);
|
callback(exports.default, numberId);
|
||||||
}
|
}
|
||||||
|
|
||||||
for (const nested in exports) if (nested.length <= 3) {
|
for (const nested in exports) if (nested.length <= 3) {
|
||||||
if (exports[nested] && filter(exports[nested])) {
|
if (exports[nested] && filter(exports[nested])) {
|
||||||
subscriptions.delete(filter);
|
subscriptions.delete(filter);
|
||||||
callback(exports[nested]);
|
callback(exports[nested], numberId);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -57,7 +57,7 @@ export const filters = {
|
|||||||
export const subscriptions = new Map<FilterFn, CallbackFn>();
|
export const subscriptions = new Map<FilterFn, CallbackFn>();
|
||||||
export const listeners = new Set<CallbackFn>();
|
export const listeners = new Set<CallbackFn>();
|
||||||
|
|
||||||
export type CallbackFn = (mod: any) => void;
|
export type CallbackFn = (mod: any, id: number) => void;
|
||||||
|
|
||||||
export function _initWebpack(instance: typeof window.webpackChunkdiscord_app) {
|
export function _initWebpack(instance: typeof window.webpackChunkdiscord_app) {
|
||||||
if (cache !== void 0) throw "no.";
|
if (cache !== void 0) throw "no.";
|
||||||
@ -86,18 +86,23 @@ export const find = traceFunction("find", function find(filter: FilterFn, getDef
|
|||||||
const mod = cache[key];
|
const mod = cache[key];
|
||||||
if (!mod?.exports) continue;
|
if (!mod?.exports) continue;
|
||||||
|
|
||||||
if (filter(mod.exports))
|
if (filter(mod.exports)) {
|
||||||
return mod.exports;
|
return isWaitFor ? [mod.exports, Number(key)] : mod.exports;
|
||||||
|
}
|
||||||
|
|
||||||
if (typeof mod.exports !== "object") continue;
|
if (typeof mod.exports !== "object") continue;
|
||||||
|
|
||||||
if (mod.exports.default && filter(mod.exports.default))
|
if (mod.exports.default && filter(mod.exports.default)) {
|
||||||
return getDefault ? mod.exports.default : mod.exports;
|
const found = getDefault ? mod.exports.default : mod.exports;
|
||||||
|
return isWaitFor ? [found, Number(key)] : found;
|
||||||
|
}
|
||||||
|
|
||||||
// the length check makes search about 20% faster
|
// the length check makes search about 20% faster
|
||||||
for (const nestedMod in mod.exports) if (nestedMod.length <= 3) {
|
for (const nestedMod in mod.exports) if (nestedMod.length <= 3) {
|
||||||
const nested = mod.exports[nestedMod];
|
const nested = mod.exports[nestedMod];
|
||||||
if (nested && filter(nested)) return nested;
|
if (nested && filter(nested)) {
|
||||||
|
return isWaitFor ? [nested, Number(key)] : nested;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -112,7 +117,7 @@ export const find = traceFunction("find", function find(filter: FilterFn, getDef
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return null;
|
return isWaitFor ? [null, null] : null;
|
||||||
});
|
});
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -347,8 +352,8 @@ export function waitFor(filter: string | string[] | FilterFn, callback: Callback
|
|||||||
else if (typeof filter !== "function")
|
else if (typeof filter !== "function")
|
||||||
throw new Error("filter must be a string, string[] or function, got " + typeof filter);
|
throw new Error("filter must be a string, string[] or function, got " + typeof filter);
|
||||||
|
|
||||||
const existing = find(filter!, true, true);
|
const [existing, id] = find(filter!, true, true);
|
||||||
if (existing) return void callback(existing);
|
if (existing) return void callback(existing, id);
|
||||||
|
|
||||||
subscriptions.set(filter, callback);
|
subscriptions.set(filter, callback);
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user