From b333deb7312107a629920737a0e9cd56936a35a5 Mon Sep 17 00:00:00 2001 From: Vendicated Date: Tue, 2 Jul 2024 00:17:40 +0200 Subject: [PATCH 1/3] improve settings ui (again) --- .stylelintrc.json | 8 +- src/components/Icons.tsx | 15 +++ src/components/VencordSettings/ThemesTab.tsx | 88 ++++++++--------- src/components/VencordSettings/VencordTab.tsx | 77 ++++++--------- .../VencordSettings/quickActions.css | 34 +++++++ .../VencordSettings/quickActions.tsx | 39 ++++++++ .../VencordSettings/settingsStyles.css | 20 ---- src/utils/misc.ts | 2 +- src/webpack/common/types/utils.d.ts | 62 +++++++++++- src/webpack/common/utils.ts | 52 +++++----- src/webpack/webpack.ts | 98 ++++++++++--------- 11 files changed, 309 insertions(+), 186 deletions(-) create mode 100644 src/components/VencordSettings/quickActions.css create mode 100644 src/components/VencordSettings/quickActions.tsx diff --git a/.stylelintrc.json b/.stylelintrc.json index 6449c3f29..ec2549762 100644 --- a/.stylelintrc.json +++ b/.stylelintrc.json @@ -1,6 +1,12 @@ { "extends": "stylelint-config-standard", "rules": { - "indentation": 4 + "indentation": 4, + "selector-class-pattern": [ + "^[a-z][a-zA-Z0-9]*(-[a-z0-9][a-zA-Z0-9]*)*$", + { + "message": "Expected class selector to be kebab-case with camelCase segments" + } + ] } } diff --git a/src/components/Icons.tsx b/src/components/Icons.tsx index d82ce0b00..7ba078d33 100644 --- a/src/components/Icons.tsx +++ b/src/components/Icons.tsx @@ -392,6 +392,21 @@ export function PaintbrushIcon(props: IconProps) { ); } +export function PencilIcon(props: IconProps) { + return ( + + + + ); +} + const WebsiteIconDark = "/assets/e1e96d89e192de1997f73730db26e94f.svg"; const WebsiteIconLight = "/assets/730f58bcfd5a57a5e22460c445a0c6cf.svg"; const GithubIconLight = "/assets/3ff98ad75ac94fa883af5ed62d17c459.svg"; diff --git a/src/components/VencordSettings/ThemesTab.tsx b/src/components/VencordSettings/ThemesTab.tsx index 2eb91cb82..016371bed 100644 --- a/src/components/VencordSettings/ThemesTab.tsx +++ b/src/components/VencordSettings/ThemesTab.tsx @@ -19,21 +19,21 @@ import { useSettings } from "@api/Settings"; import { classNameFactory } from "@api/Styles"; import { Flex } from "@components/Flex"; -import { DeleteIcon } from "@components/Icons"; +import { DeleteIcon, FolderIcon, PaintbrushIcon, PencilIcon, PlusIcon, RestartIcon } from "@components/Icons"; import { Link } from "@components/Link"; -import PluginModal from "@components/PluginSettings/PluginModal"; +import { openPluginModal } from "@components/PluginSettings/PluginModal"; import type { UserThemeHeader } from "@main/themes"; import { openInviteModal } from "@utils/discord"; import { Margins } from "@utils/margins"; import { classes } from "@utils/misc"; -import { openModal } from "@utils/modal"; import { showItemInFolder } from "@utils/native"; import { useAwaiter } from "@utils/react"; import { findByPropsLazy, findLazy } from "@webpack"; -import { Button, Card, Forms, React, showToast, TabBar, TextArea, useEffect, useRef, useState } from "@webpack/common"; +import { Card, Forms, React, showToast, TabBar, TextArea, useEffect, useRef, useState } from "@webpack/common"; import type { ComponentType, Ref, SyntheticEvent } from "react"; import { AddonCard } from "./AddonCard"; +import { QuickAction, QuickActionCard } from "./quickActions"; import { SettingsTab, wrapTab } from "./shared"; type FileInput = ComponentType<{ @@ -213,60 +213,52 @@ function ThemesTab() { - + <> {IS_WEB ? ( - + + Upload Theme + + + } + Icon={PlusIcon} + /> ) : ( - + Icon={FolderIcon} + /> )} - - + + VencordNative.quickCss.openEditor()} + Icon={PaintbrushIcon} + /> {Vencord.Settings.plugins.ClientTheme.enabled && ( - + openPluginModal(Vencord.Plugins.plugins.ClientTheme)} + Icon={PencilIcon} + /> )} - +
{userThemes?.map(theme => ( diff --git a/src/components/VencordSettings/VencordTab.tsx b/src/components/VencordSettings/VencordTab.tsx index d13b43fb2..97f82e777 100644 --- a/src/components/VencordSettings/VencordTab.tsx +++ b/src/components/VencordSettings/VencordTab.tsx @@ -21,15 +21,16 @@ import { useSettings } from "@api/Settings"; import { classNameFactory } from "@api/Styles"; import DonateButton from "@components/DonateButton"; import { openPluginModal } from "@components/PluginSettings/PluginModal"; +import { gitRemote } from "@shared/vencordUserAgent"; import { Margins } from "@utils/margins"; import { identity } from "@utils/misc"; import { relaunch, showItemInFolder } from "@utils/native"; import { useAwaiter } from "@utils/react"; -import { Button, Card, Forms, React, Select, Switch, TooltipContainer } from "@webpack/common"; -import { ComponentType } from "react"; +import { Button, Card, Forms, React, Select, Switch } from "@webpack/common"; import { Flex, FolderIcon, GithubIcon, LogIcon, PaintbrushIcon, RestartIcon } from ".."; import { openNotificationSettingsModal } from "./NotificationSettings"; +import { QuickAction, QuickActionCard } from "./quickActions"; import { SettingsTab, wrapTab } from "./shared"; const cl = classNameFactory("vc-settings-"); @@ -41,17 +42,6 @@ type KeysOfType = { [K in keyof Object]: Object[K] extends Type ? K : never; }[keyof Object]; -const iconWithTooltip = (Icon: ComponentType<{ className?: string; }>, tooltip: string) => () => ( - - - -); - -const NotificationLogIcon = iconWithTooltip(LogIcon, "Open Notification Log"); -const QuickCssIcon = iconWithTooltip(PaintbrushIcon, "Edit QuickCSS"); -const RelaunchIcon = iconWithTooltip(RestartIcon, "Relaunch Discord"); -const OpenSettingsDirIcon = iconWithTooltip(FolderIcon, "Open Settings Directory"); -const OpenGithubIcon = iconWithTooltip(GithubIcon, "View Vencord's GitHub Repository"); function VencordSettings() { const [settingsDir, , settingsDirPending] = useAwaiter(VencordNative.settings.getSettingsDir, { @@ -111,44 +101,37 @@ function VencordSettings() { - - - + + + VencordNative.quickCss.openEditor()} + /> {!IS_WEB && ( - + )} {!IS_WEB && ( - + showItemInFolder(settingsDir)} + /> )} - - + VencordNative.native.openExternal("https://github.com/" + gitRemote)} + /> + diff --git a/src/components/VencordSettings/quickActions.css b/src/components/VencordSettings/quickActions.css new file mode 100644 index 000000000..897bc8c81 --- /dev/null +++ b/src/components/VencordSettings/quickActions.css @@ -0,0 +1,34 @@ +.vc-settings-quickActions-card { + display: grid; + grid-template-columns: repeat(auto-fill, minmax(200px, max-content)); + gap: 0.5em; + justify-content: center; + padding: 0.5em 0; + margin-bottom: 1em; +} + +.vc-settings-quickActions-pill { + all: unset; + + background: var(--background-secondary); + color: var(--header-secondary); + display: flex; + align-items: center; + gap: 0.5em; + padding: 8px 12px; + border-radius: 9999px; +} + +.vc-settings-quickActions-pill:hover { + background: var(--background-secondary-alt); +} + +.vc-settings-quickActions-pill:focus-visible { + outline: 2px solid var(--focus-primary); + outline-offset: 2px; +} + +.vc-settings-quickActions-img { + width: 24px; + height: 24px; +} diff --git a/src/components/VencordSettings/quickActions.tsx b/src/components/VencordSettings/quickActions.tsx new file mode 100644 index 000000000..6cc57180a --- /dev/null +++ b/src/components/VencordSettings/quickActions.tsx @@ -0,0 +1,39 @@ +/* + * Vencord, a Discord client mod + * Copyright (c) 2024 Vendicated and contributors + * SPDX-License-Identifier: GPL-3.0-or-later + */ + +import "./quickActions.css"; + +import { classNameFactory } from "@api/Styles"; +import { Card } from "@webpack/common"; +import type { ComponentType, PropsWithChildren, ReactNode } from "react"; + +const cl = classNameFactory("vc-settings-quickActions-"); + +export interface QuickActionProps { + Icon: ComponentType<{ className?: string; }>; + text: ReactNode; + action?: () => void; + disabled?: boolean; +} + +export function QuickAction(props: QuickActionProps) { + const { Icon, action, text, disabled } = props; + + return ( + + ); +} + +export function QuickActionCard(props: PropsWithChildren) { + return ( + + {props.children} + + ); +} diff --git a/src/components/VencordSettings/settingsStyles.css b/src/components/VencordSettings/settingsStyles.css index 6e8826c52..13558be21 100644 --- a/src/components/VencordSettings/settingsStyles.css +++ b/src/components/VencordSettings/settingsStyles.css @@ -10,26 +10,6 @@ margin-bottom: -2px; } -.vc-settings-quick-actions-card { - color: var(--text-normal); - padding: 1em; - display: flex; - justify-content: space-evenly; - gap: 1em; - flex-wrap: wrap; - align-items: center; - margin-bottom: 1em; -} - -.vc-settings-quick-actions-card button { - min-width: unset; -} - -.vc-settings-quick-actions-img { - width: 30px; - height: 30px; -} - .vc-settings-donate { display: flex; flex-direction: row; diff --git a/src/utils/misc.ts b/src/utils/misc.ts index 7d6b4affc..28c371c5b 100644 --- a/src/utils/misc.ts +++ b/src/utils/misc.ts @@ -24,7 +24,7 @@ import { DevsById } from "./constants"; * Calls .join(" ") on the arguments * classes("one", "two") => "one two" */ -export function classes(...classes: Array) { +export function classes(...classes: Array) { return classes.filter(Boolean).join(" "); } diff --git a/src/webpack/common/types/utils.d.ts b/src/webpack/common/types/utils.d.ts index ee3f69944..ce1e3e268 100644 --- a/src/webpack/common/types/utils.d.ts +++ b/src/webpack/common/types/utils.d.ts @@ -16,7 +16,7 @@ * along with this program. If not, see . */ -import { Guild, GuildMember } from "discord-types/general"; +import { Guild, GuildMember, User } from "discord-types/general"; import type { ReactNode } from "react"; import { LiteralUnion } from "type-fest"; @@ -256,3 +256,63 @@ export interface PopoutActions { close(key: string): void; setAlwaysOnTop(key: string, alwaysOnTop: boolean): void; } + +export type UserNameUtilsTagInclude = LiteralUnion<"auto" | "always" | "never", string>; +export interface UserNameUtilsTagOptions { + forcePomelo?: boolean; + identifiable?: UserNameUtilsTagInclude; + decoration?: UserNameUtilsTagInclude; + mode?: "full" | "username"; +} + +export interface UsernameUtils { + getGlobalName(user: User): string; + getFormattedName(user: User, useTagInsteadOfUsername?: boolean): string; + getName(user: User): string; + useName(user: User): string; + getUserTag(user: User, options?: UserNameUtilsTagOptions): string; + useUserTag(user: User, options?: UserNameUtilsTagOptions): string; + + + useDirectMessageRecipient: any; + humanizeStatus: any; +} + +export class DisplayProfile { + userId: string; + banner?: string; + bio?: string; + pronouns?: string; + accentColor?: number; + themeColors?: number[]; + popoutAnimationParticleType?: any; + profileEffectId?: string; + _userProfile?: any; + _guildMemberProfile?: any; + canUsePremiumProfileCustomization: boolean; + canEditThemes: boolean; + premiumGuildSince: Date | null; + premiumSince: Date | null; + premiumType?: number; + primaryColor?: number; + + getBadges(): Array<{ + id: string; + description: string; + icon: string; + link?: string; + }>; + getBannerURL(options: { canAnimate: boolean; size: number; }): string; + getLegacyUsername(): string | null; + hasFullProfile(): boolean; + hasPremiumCustomization(): boolean; + hasThemeColors(): boolean; + isUsingGuildMemberBanner(): boolean; + isUsingGuildMemberBio(): boolean; + isUsingGuildMemberPronouns(): boolean; +} + +export interface DisplayProfileUtils { + getDisplayProfile(userId: string, guildId?: string, customStores?: any): DisplayProfile | null; + useDisplayProfile(userId: string, guildId?: string, customStores?: any): DisplayProfile | null; +} diff --git a/src/webpack/common/utils.ts b/src/webpack/common/utils.ts index a6853c84a..280b2ba90 100644 --- a/src/webpack/common/utils.ts +++ b/src/webpack/common/utils.ts @@ -73,6 +73,25 @@ const ToastPosition = { BOTTOM: 1 }; +export interface ToastData { + message: string, + id: string, + /** + * Toasts.Type + */ + type: number, + options?: ToastOptions; +} + +export interface ToastOptions { + /** + * Toasts.Position + */ + position?: number; + component?: React.ReactNode, + duration?: number; +} + export const Toasts = { Type: ToastType, Position: ToastPosition, @@ -81,23 +100,9 @@ export const Toasts = { // hack to merge with the following interface, dunno if there's a better way ...{} as { - show(data: { - message: string, - id: string, - /** - * Toasts.Type - */ - type: number, - options?: { - /** - * Toasts.Position - */ - position?: number; - component?: React.ReactNode, - duration?: number; - }; - }): void; + show(data: ToastData): void; pop(): void; + create(message: string, type: number, options?: ToastOptions): ToastData; } }; @@ -105,18 +110,15 @@ export const Toasts = { waitFor("showToast", m => { Toasts.show = m.showToast; Toasts.pop = m.popToast; + Toasts.create = m.createToast; }); /** * Show a simple toast. If you need more options, use Toasts.show manually */ -export function showToast(message: string, type = ToastType.MESSAGE) { - Toasts.show({ - id: Toasts.genId(), - message, - type - }); +export function showToast(message: string, type = ToastType.MESSAGE, options?: ToastOptions) { + Toasts.show(Toasts.create(message, type, options)); } export const UserUtils = { @@ -172,3 +174,9 @@ export const PopoutActions: t.PopoutActions = mapMangledModuleLazy('type:"POPOUT close: filters.byCode('type:"POPOUT_WINDOW_CLOSE"'), setAlwaysOnTop: filters.byCode('type:"POPOUT_WINDOW_SET_ALWAYS_ON_TOP"'), }); + +export const UsernameUtils: t.UsernameUtils = findByPropsLazy("useName", "getGlobalName"); +export const DisplayProfileUtils: t.DisplayProfileUtils = mapMangledModuleLazy(/=\i\.getUserProfile\(\i\),\i=\i\.getGuildMemberProfile\(/, { + getDisplayProfile: filters.byCode(".getGuildMemberProfile("), + useDisplayProfile: filters.byCode(/\[\i\.\i,\i\.\i],\(\)=>/) +}); diff --git a/src/webpack/webpack.ts b/src/webpack/webpack.ts index f776ab1c3..f21a38d67 100644 --- a/src/webpack/webpack.ts +++ b/src/webpack/webpack.ts @@ -38,31 +38,43 @@ export let cache: WebpackInstance["c"]; export type FilterFn = (mod: any) => boolean; +type PropsFilter = Array; +type CodeFilter = Array; +type StoreNameFilter = string; + +const stringMatches = (s: string, filter: CodeFilter) => + filter.every(f => + typeof f === "string" + ? s.includes(f) + : f.test(s) + ); + export const filters = { - byProps: (...props: string[]): FilterFn => + byProps: (...props: PropsFilter): FilterFn => props.length === 1 ? m => m[props[0]] !== void 0 : m => props.every(p => m[p] !== void 0), - byCode: (...code: string[]): FilterFn => m => { - if (typeof m !== "function") return false; - const s = Function.prototype.toString.call(m); - for (const c of code) { - if (!s.includes(c)) return false; - } - return true; + byCode: (...code: CodeFilter): FilterFn => { + code = code.map(canonicalizeMatch); + return m => { + if (typeof m !== "function") return false; + return stringMatches(Function.prototype.toString.call(m), code); + }; }, - byStoreName: (name: string): FilterFn => m => + byStoreName: (name: StoreNameFilter): FilterFn => m => m.constructor?.displayName === name, - componentByCode: (...code: string[]): FilterFn => { + componentByCode: (...code: CodeFilter): FilterFn => { const filter = filters.byCode(...code); return m => { if (filter(m)) return true; if (!m.$$typeof) return false; - if (m.type && m.type.render) return filter(m.type.render); // memo + forwardRef - if (m.type) return filter(m.type); // memos - if (m.render) return filter(m.render); // forwardRefs + if (m.type) + return m.type.render + ? filter(m.type.render) // memo + forwardRef + : filter(m.type); // memo + if (m.render) return filter(m.render); // forwardRef return false; }; } @@ -245,15 +257,9 @@ export const findBulk = traceFunction("findBulk", function findBulk(...filterFns * Find the id of the first module factory that includes all the given code * @returns string or null */ -export const findModuleId = traceFunction("findModuleId", function findModuleId(...code: string[]) { - outer: +export const findModuleId = traceFunction("findModuleId", function findModuleId(...code: CodeFilter) { for (const id in wreq.m) { - const str = wreq.m[id].toString(); - - for (const c of code) { - if (!str.includes(c)) continue outer; - } - return id; + if (stringMatches(wreq.m[id].toString(), code)) return id; } const err = new Error("Didn't find module with code(s):\n" + code.join("\n")); @@ -272,7 +278,7 @@ export const findModuleId = traceFunction("findModuleId", function findModuleId( * Find the first module factory that includes all the given code * @returns The module factory or null */ -export function findModuleFactory(...code: string[]) { +export function findModuleFactory(...code: CodeFilter) { const id = findModuleId(...code); if (!id) return null; @@ -325,7 +331,7 @@ export function findLazy(filter: FilterFn) { /** * Find the first module that has the specified properties */ -export function findByProps(...props: string[]) { +export function findByProps(...props: PropsFilter) { const res = find(filters.byProps(...props), { isIndirect: true }); if (!res) handleModuleNotFound("findByProps", ...props); @@ -335,7 +341,7 @@ export function findByProps(...props: string[]) { /** * Find the first module that has the specified properties, lazily */ -export function findByPropsLazy(...props: string[]) { +export function findByPropsLazy(...props: PropsFilter) { if (IS_REPORTER) lazyWebpackSearchHistory.push(["findByProps", props]); return proxyLazy(() => findByProps(...props)); @@ -344,7 +350,7 @@ export function findByPropsLazy(...props: string[]) { /** * Find the first function that includes all the given code */ -export function findByCode(...code: string[]) { +export function findByCode(...code: CodeFilter) { const res = find(filters.byCode(...code), { isIndirect: true }); if (!res) handleModuleNotFound("findByCode", ...code); @@ -354,7 +360,7 @@ export function findByCode(...code: string[]) { /** * Find the first function that includes all the given code, lazily */ -export function findByCodeLazy(...code: string[]) { +export function findByCodeLazy(...code: CodeFilter) { if (IS_REPORTER) lazyWebpackSearchHistory.push(["findByCode", code]); return proxyLazy(() => findByCode(...code)); @@ -363,7 +369,7 @@ export function findByCodeLazy(...code: string[]) { /** * Find a store by its displayName */ -export function findStore(name: string) { +export function findStore(name: StoreNameFilter) { const res = find(filters.byStoreName(name), { isIndirect: true }); if (!res) handleModuleNotFound("findStore", name); @@ -373,7 +379,7 @@ export function findStore(name: string) { /** * Find a store by its displayName, lazily */ -export function findStoreLazy(name: string) { +export function findStoreLazy(name: StoreNameFilter) { if (IS_REPORTER) lazyWebpackSearchHistory.push(["findStore", [name]]); return proxyLazy(() => findStore(name)); @@ -382,7 +388,7 @@ export function findStoreLazy(name: string) { /** * Finds the component which includes all the given code. Checks for plain components, memos and forwardRefs */ -export function findComponentByCode(...code: string[]) { +export function findComponentByCode(...code: CodeFilter) { const res = find(filters.componentByCode(...code), { isIndirect: true }); if (!res) handleModuleNotFound("findComponentByCode", ...code); @@ -407,7 +413,7 @@ export function findComponentLazy(filter: FilterFn) { /** * Finds the first component that includes all the given code, lazily */ -export function findComponentByCodeLazy(...code: string[]) { +export function findComponentByCodeLazy(...code: CodeFilter) { if (IS_REPORTER) lazyWebpackSearchHistory.push(["findComponentByCode", code]); return LazyComponent(() => { @@ -421,7 +427,7 @@ export function findComponentByCodeLazy(...code: string[ /** * Finds the first component that is exported by the first prop name, lazily */ -export function findExportedComponentLazy(...props: string[]) { +export function findExportedComponentLazy(...props: PropsFilter) { if (IS_REPORTER) lazyWebpackSearchHistory.push(["findExportedComponent", props]); return LazyComponent(() => { @@ -445,10 +451,13 @@ export function findExportedComponentLazy(...props: stri * closeModal: filters.byCode("key==") * }) */ -export const mapMangledModule = traceFunction("mapMangledModule", function mapMangledModule(code: string, mappers: Record): Record { +export const mapMangledModule = traceFunction("mapMangledModule", function mapMangledModule(code: string | RegExp | CodeFilter, mappers: Record): Record { + if (!Array.isArray(code)) code = [code]; + code = code.map(canonicalizeMatch); + const exports = {} as Record; - const id = findModuleId(code); + const id = findModuleId(...code); if (id === null) return exports; @@ -482,7 +491,7 @@ export const mapMangledModule = traceFunction("mapMangledModule", function mapMa * closeModal: filters.byCode("key==") * }) */ -export function mapMangledModuleLazy(code: string, mappers: Record): Record { +export function mapMangledModuleLazy(code: string | RegExp | CodeFilter, mappers: Record): Record { if (IS_REPORTER) lazyWebpackSearchHistory.push(["mapMangledModule", [code, mappers]]); return proxyLazy(() => mapMangledModule(code, mappers)); @@ -497,7 +506,7 @@ export const ChunkIdsRegex = /\("([^"]+?)"\)/g; * @param matcher A RegExp that returns the chunk ids array as the first capture group and the entry point id as the second. Defaults to a matcher that captures the first lazy chunk loading found in the module factory * @returns A promise that resolves with a boolean whether the chunks were loaded */ -export async function extractAndLoadChunks(code: string[], matcher: RegExp = DefaultExtractAndLoadChunksRegex) { +export async function extractAndLoadChunks(code: CodeFilter, matcher: RegExp = DefaultExtractAndLoadChunksRegex) { const module = findModuleFactory(...code); if (!module) { const err = new Error("extractAndLoadChunks: Couldn't find module factory"); @@ -562,7 +571,7 @@ export async function extractAndLoadChunks(code: string[], matcher: RegExp = Def * @param matcher A RegExp that returns the chunk ids array as the first capture group and the entry point id as the second. Defaults to a matcher that captures the first lazy chunk loading found in the module factory * @returns A function that returns a promise that resolves with a boolean whether the chunks were loaded, on first call */ -export function extractAndLoadChunksLazy(code: string[], matcher = DefaultExtractAndLoadChunksRegex) { +export function extractAndLoadChunksLazy(code: CodeFilter, matcher = DefaultExtractAndLoadChunksRegex) { if (IS_REPORTER) lazyWebpackSearchHistory.push(["extractAndLoadChunks", [code, matcher]]); return makeLazy(() => extractAndLoadChunks(code, matcher)); @@ -572,7 +581,7 @@ export function extractAndLoadChunksLazy(code: string[], matcher = DefaultExtrac * Wait for a module that matches the provided filter to be registered, * then call the callback with the module as the first argument */ -export function waitFor(filter: string | string[] | FilterFn, callback: CallbackFn, { isIndirect = false }: { isIndirect?: boolean; } = {}) { +export function waitFor(filter: string | PropsFilter | FilterFn, callback: CallbackFn, { isIndirect = false }: { isIndirect?: boolean; } = {}) { if (IS_REPORTER && !isIndirect) lazyWebpackSearchHistory.push(["waitFor", Array.isArray(filter) ? filter : [filter]]); if (typeof filter === "string") @@ -593,21 +602,18 @@ export function waitFor(filter: string | string[] | FilterFn, callback: Callback /** * Search modules by keyword. This searches the factory methods, * meaning you can search all sorts of things, displayName, methodName, strings somewhere in the code, etc - * @param filters One or more strings or regexes + * @param code One or more strings or regexes * @returns Mapping of found modules */ -export function search(...filters: Array) { +export function search(...code: CodeFilter) { const results = {} as Record; const factories = wreq.m; - outer: + for (const id in factories) { const factory = factories[id].original ?? factories[id]; - const str: string = factory.toString(); - for (const filter of filters) { - if (typeof filter === "string" && !str.includes(filter)) continue outer; - if (filter instanceof RegExp && !filter.test(str)) continue outer; - } - results[id] = factory; + + if (stringMatches(factory.toString(), code)) + results[id] = factory; } return results; From bc34d72b57f9d3aecbb34202e8f806ed377d1891 Mon Sep 17 00:00:00 2001 From: Nuckyz <61953774+Nuckyz@users.noreply.github.com> Date: Tue, 2 Jul 2024 20:00:05 -0300 Subject: [PATCH 2/3] Support regex in webpack finds --- src/debug/runReporter.ts | 4 +- src/webpack/api.tsx | 91 ++++++++++++++++++++-------------------- 2 files changed, 47 insertions(+), 48 deletions(-) diff --git a/src/debug/runReporter.ts b/src/debug/runReporter.ts index 24bc138df..33ef2e97b 100644 --- a/src/debug/runReporter.ts +++ b/src/debug/runReporter.ts @@ -140,7 +140,7 @@ async function runReporter() { if (filter.$$vencordProps != null) { const filterName = filter.$$vencordProps[0]; - parsedFilter = `${filterName}(${filter.$$vencordProps.slice(1).map((arg: any) => JSON.stringify(arg)).join(", ")})`; + parsedFilter = `${filterName}(${filter.$$vencordProps.slice(1).map((arg: any) => arg instanceof RegExp ? String(arg) : JSON.stringify(arg)).join(", ")})`; } else { parsedFilter = String(filter).slice(0, 147) + "..."; } @@ -150,7 +150,7 @@ async function runReporter() { logMessage += `(${JSON.stringify(code)}, {\n${parsedFailedMappers.map(([key, parsedFilter]) => `\t${key}: ${parsedFilter}`).join(",\n")}\n})`; } else { - logMessage += `(${filterName.length ? `${filterName}(` : ""}${parsedArgs.map(arg => JSON.stringify(arg)).join(", ")})${filterName.length ? ")" : ""}`; + logMessage += `(${filterName.length ? `${filterName}(` : ""}${parsedArgs.map(arg => arg instanceof RegExp ? String(arg) : JSON.stringify(arg)).join(", ")})${filterName.length ? ")" : ""}`; } ReporterLogger.log("Webpack Find Fail:", logMessage); diff --git a/src/webpack/api.tsx b/src/webpack/api.tsx index be1bc9344..2bc027ba9 100644 --- a/src/webpack/api.tsx +++ b/src/webpack/api.tsx @@ -62,13 +62,24 @@ if (IS_DEV && IS_DISCORD_DESKTOP) { }, 0); } +export type PropsFilter = Array; +export type CodeFilter = Array; +export type StoreNameFilter = string; + export type FilterFn = ((module: any) => boolean) & { - $$vencordProps?: string[]; + $$vencordProps?: Array; $$vencordIsFactoryFilter?: boolean; }; +const stringMatches = (s: string, filter: CodeFilter) => + filter.every(f => + typeof f === "string" + ? s.includes(f) + : (f.global && (f.lastIndex = 0), f.test(s)) + ); + export const filters = { - byProps: (...props: string[]): FilterFn => { + byProps: (...props: PropsFilter): FilterFn => { const filter: FilterFn = props.length === 1 ? m => m?.[props[0]] !== void 0 : m => props.every(p => m?.[p] !== void 0); @@ -77,28 +88,25 @@ export const filters = { return filter; }, - byCode: (...code: string[]): FilterFn => { + byCode: (...code: CodeFilter): FilterFn => { + code = code.map(canonicalizeMatch); const filter: FilterFn = m => { if (typeof m !== "function") return false; - const s = String(m); - for (const c of code) { - if (!s.includes(c)) return false; - } - return true; + return stringMatches(String(m), code); }; filter.$$vencordProps = ["byCode", ...code]; return filter; }, - byStoreName: (name: string): FilterFn => { + byStoreName: (name: StoreNameFilter): FilterFn => { const filter: FilterFn = m => m?.constructor?.displayName === name; filter.$$vencordProps = ["byStoreName", name]; return filter; }, - byComponentCode: (...code: string[]): FilterFn => { + byComponentCode: (...code: CodeFilter): FilterFn => { const byCodeFilter = filters.byCode(...code); const filter: FilterFn = m => { let inner = m; @@ -118,7 +126,7 @@ export const filters = { return filter; }, - byFactoryCode: (...code: string[]): FilterFn => { + byFactoryCode: (...code: CodeFilter): FilterFn => { const byCodeFilter = filters.byCode(...code); byCodeFilter.$$vencordProps = ["byFactoryCode", ...code]; @@ -133,7 +141,7 @@ export const webpackSearchHistory = [] as Array<["waitFor" | "find" | "findCompo function printFilter(filter: FilterFn) { if (filter.$$vencordProps != null) { const props = filter.$$vencordProps; - return `${props[0]}(${props.slice(1).map(arg => JSON.stringify(arg)).join(", ")})`; + return `${props[0]}(${props.slice(1).map(arg => arg instanceof RegExp ? String(arg) : JSON.stringify(arg)).join(", ")})`; } return String(filter); @@ -263,9 +271,9 @@ export function findComponent(filter: FilterFn, parse: ( * @param parse A function that takes the found component as its first argument and returns a component. Useful if you want to wrap the found component in something. Defaults to the original component * @returns The component if found, or a noop component */ -export function findExportedComponent(...props: string[] | [...string[], (component: any) => LazyComponentType]) { +export function findExportedComponent(...props: PropsFilter | [...PropsFilter, (component: any) => LazyComponentType]) { const parse = (typeof props.at(-1) === "function" ? props.pop() : m => m) as (component: any) => LazyComponentType; - const newProps = props as string[]; + const newProps = props as PropsFilter; const filter = filters.byProps(...newProps); @@ -308,9 +316,9 @@ export function findExportedComponent(...props: string[] * @param parse A function that takes the found component as its first argument and returns a component. Useful if you want to wrap the found component in something. Defaults to the original component * @returns The component if found, or a noop component */ -export function findComponentByCode(...code: string[] | [...string[], (component: any) => LazyComponentType]) { +export function findComponentByCode(...code: CodeFilter | [...CodeFilter, (component: any) => LazyComponentType]) { const parse = (typeof code.at(-1) === "function" ? code.pop() : m => m) as (component: any) => LazyComponentType; - const newCode = code as string[]; + const newCode = code as CodeFilter; const ComponentResult = findComponent(filters.byComponentCode(...newCode), parse, { isIndirect: true }); @@ -327,9 +335,9 @@ export function findComponentByCode(...code: string[] | * @param props A list of props to search the module or exports for * @param parse A function that takes the find result as its first argument and returns something. Useful if you want to use a value from the find result, instead of all of it. Defaults to the find result itself */ -export function findByProps(...props: string[] | [...string[], (mod: any) => T]) { +export function findByProps(...props: PropsFilter | [...PropsFilter, (mod: any) => T]) { const parse = (typeof props.at(-1) === "function" ? props.pop() : m => m) as (mod: any) => T; - const newProps = props as string[]; + const newProps = props as PropsFilter; const result = find(filters.byProps(...newProps), parse, { isIndirect: true }); @@ -348,9 +356,9 @@ export function findByProps(...props: string[] | [...string[], (mod: an * @param props A list of props to search the module or exports for * @param parse A function that takes the find result as its first argument and returns something. Useful if you want to use a value from the find result, instead of all of it. Defaults to the find result itself */ -export function findByPropsAndExtract(...props: string[] | [...string[], (mod: any) => T]) { +export function findByPropsAndExtract(...props: PropsFilter | [...PropsFilter, (mod: any) => T]) { const parse = (typeof props.at(-1) === "function" ? props.pop() : m => m) as (mod: any) => T; - const newProps = props as string[]; + const newProps = props as PropsFilter; const result = find(filters.byProps(...newProps), m => parse(m[newProps[0]]), { isIndirect: true }); @@ -367,9 +375,9 @@ export function findByPropsAndExtract(...props: string[] | [...string[] * @param code A list of code to search each export for * @param parse A function that takes the find result as its first argument and returns something. Useful if you want to use a value from the find result, instead of all of it. Defaults to the find result itself */ -export function findByCode(...code: string[] | [...string[], (mod: any) => T]) { +export function findByCode(...code: CodeFilter | [...CodeFilter, (mod: any) => T]) { const parse = (typeof code.at(-1) === "function" ? code.pop() : m => m) as (mod: any) => T; - const newCode = code as string[]; + const newCode = code as CodeFilter; const result = find(filters.byCode(...newCode), parse, { isIndirect: true }); @@ -385,7 +393,7 @@ export function findByCode(...code: string[] | [...string[], (mod: any) * * @param name The store name */ -export function findStore(name: string) { +export function findStore(name: StoreNameFilter) { const result = find(filters.byStoreName(name), m => m, { isIndirect: true }); if (IS_REPORTER) { @@ -401,9 +409,9 @@ export function findStore(name: string) { * @param code A list of code to search each factory for * @param parse A function that takes the find result as its first argument and returns something. Useful if you want to use a value from the find result, instead of all of it. Defaults to the find result itself */ -export function findByFactoryCode(...code: string[] | [...string[], (mod: any) => T]) { +export function findByFactoryCode(...code: CodeFilter | [...CodeFilter, (mod: any) => T]) { const parse = (typeof code.at(-1) === "function" ? code.pop() : m => m) as (mod: any) => T; - const newCode = code as string[]; + const newCode = code as CodeFilter; const result = find(filters.byFactoryCode(...newCode), parse, { isIndirect: true }); @@ -428,7 +436,7 @@ export function findByFactoryCode(...code: string[] | [...string[], (mo * @param mappers Mappers to create the non mangled exports object * @returns Unmangled exports as specified in mappers */ -export function mapMangledModule(code: string | string[], mappers: Record) { +export function mapMangledModule(code: string | RegExp | CodeFilter, mappers: Record) { const mapping = {} as Record; const setters = {} as Record void>; @@ -481,7 +489,7 @@ export function mapMangledModule(code: string | string[], /** * Find the first module factory that includes all the given code. */ -export function findModuleFactory(...code: string[]) { +export function findModuleFactory(...code: CodeFilter) { const filter = filters.byFactoryCode(...code); const [proxy, setInnerValue] = proxyInner(`Webpack module factory find matched no module. Filter: ${printFilter(filter)}`, "Webpack find with proxy called on a primitive value."); @@ -533,7 +541,7 @@ export const ChunkIdsRegex = /\("([^"]+?)"\)/g; * @param matcher A RegExp that returns the chunk ids array as the first capture group and the entry point id as the second. Defaults to a matcher that captures the first lazy chunk loading found in the module factory * @returns A function that returns a promise that resolves with a boolean whether the chunks were loaded, on first call */ -export function extractAndLoadChunksLazy(code: string | string[], matcher: RegExp = DefaultExtractAndLoadChunksRegex) { +export function extractAndLoadChunksLazy(code: string | RegExp | CodeFilter, matcher: RegExp = DefaultExtractAndLoadChunksRegex) { const module = findModuleFactory(...Array.isArray(code) ? code : [code]); const extractAndLoadChunks = makeLazy(async () => { @@ -805,16 +813,9 @@ export const cacheFindBulk = traceFunction("cacheFindBulk", function cacheFindBu /** * Find the id of the first already loaded module factory that includes all the given code. */ -export const cacheFindModuleId = traceFunction("cacheFindModuleId", function cacheFindModuleId(...code: string[]) { - outer: +export const cacheFindModuleId = traceFunction("cacheFindModuleId", function cacheFindModuleId(...code: CodeFilter) { for (const id in wreq.m) { - const str = String(wreq.m[id]); - - for (const c of code) { - if (!str.includes(c)) continue outer; - } - - return id; + if (stringMatches(String(wreq.m[id]), code)) return id; } const err = new Error("Didn't find module with code(s):\n" + code.join("\n")); @@ -829,12 +830,12 @@ export const cacheFindModuleId = traceFunction("cacheFindModuleId", function cac /** * Find the first already loaded module factory that includes all the given code. */ -export function cacheFindModuleFactory(...code: string[]) { +export const cacheFindModuleFactory = traceFunction("cacheFindModuleFactory", function cacheFindModuleFactory(...code: CodeFilter) { const id = cacheFindModuleId(...code); if (id == null) return; return wreq.m[id]; -} +}); /** * Search modules by keyword. This searches the factory methods, @@ -843,18 +844,16 @@ export function cacheFindModuleFactory(...code: string[]) { * @param filters One or more strings or regexes * @returns Mapping of found modules */ -export function search(...filters: Array) { +export function search(...filters: CodeFilter) { const results = {} as Record; const factories = wreq.m; - outer: + for (const id in factories) { const factory = factories[id]; - const factoryStr = String(factory); - for (const filter of filters) { - if (typeof filter === "string" && !factoryStr.includes(filter)) continue outer; - if (filter instanceof RegExp && !filter.test(factoryStr)) continue outer; + + if (stringMatches(String(factory), filters)) { + results[id] = factory; } - results[id] = factory; } return results; From 3331ed215592389411ae8e87c7301740d1ccbb63 Mon Sep 17 00:00:00 2001 From: Nuckyz <61953774+Nuckyz@users.noreply.github.com> Date: Tue, 2 Jul 2024 20:01:15 -0300 Subject: [PATCH 3/3] forgot this --- src/webpack/api.tsx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/webpack/api.tsx b/src/webpack/api.tsx index 2bc027ba9..48861c76d 100644 --- a/src/webpack/api.tsx +++ b/src/webpack/api.tsx @@ -841,17 +841,17 @@ export const cacheFindModuleFactory = traceFunction("cacheFindModuleFactory", fu * Search modules by keyword. This searches the factory methods, * meaning you can search all sorts of things, methodName, strings somewhere in the code, etc. * - * @param filters One or more strings or regexes + * @param code One or more strings or regexes * @returns Mapping of found modules */ -export function search(...filters: CodeFilter) { +export function search(...code: CodeFilter) { const results = {} as Record; const factories = wreq.m; for (const id in factories) { const factory = factories[id]; - if (stringMatches(String(factory), filters)) { + if (stringMatches(String(factory), code)) { results[id] = factory; } }