388 lines
16 KiB
TypeScript
388 lines
16 KiB
TypeScript
/*
|
|
* Vencord, a Discord client mod
|
|
* Copyright (c) 2024 Vendicated and contributors
|
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
|
*/
|
|
|
|
import { Settings } from "@api/Settings";
|
|
import { Logger } from "@utils/Logger";
|
|
import { UNCONFIGURABLE_PROPERTIES } from "@utils/misc";
|
|
import { canonicalizeMatch, canonicalizeReplacement } from "@utils/patches";
|
|
import { PatchReplacement } from "@utils/types";
|
|
|
|
import { traceFunction } from "../debug/Tracer";
|
|
import { patches } from "../plugins";
|
|
import { _initWebpack, beforeInitListeners, factoryListeners, ModuleFactory, moduleListeners, OnChunksLoaded, subscriptions, WebpackRequire, wreq } from ".";
|
|
|
|
const logger = new Logger("WebpackInterceptor", "#8caaee");
|
|
const initCallbackRegex = canonicalizeMatch(/{return \i\(".+?"\)}/);
|
|
|
|
const allProxiedModules = new Set<WebpackRequire["m"]>();
|
|
|
|
const modulesProxyHandler: ProxyHandler<WebpackRequire["m"]> = {
|
|
...Object.fromEntries(Object.getOwnPropertyNames(Reflect).map(propName =>
|
|
[propName, (...args: any[]) => Reflect[propName](...args)]
|
|
)),
|
|
get: (target, p) => {
|
|
const propValue = Reflect.get(target, p);
|
|
|
|
// If the property is not a number, we are not dealing with a module factory
|
|
// $$vencordOriginal means the factory is already patched, $$vencordRequired means it has already been required
|
|
// and replaced with the original
|
|
// @ts-ignore
|
|
if (propValue == null || Number.isNaN(Number(p)) || propValue.$$vencordOriginal != null || propValue.$$vencordRequired === true) {
|
|
return propValue;
|
|
}
|
|
|
|
// This patches factories if eagerPatches are disabled
|
|
const patchedFactory = patchFactory(p, propValue);
|
|
Reflect.set(target, p, patchedFactory);
|
|
|
|
return patchedFactory;
|
|
},
|
|
set: (target, p, newValue) => {
|
|
// $$vencordRequired means we are resetting the factory to its original after being required
|
|
// If the property is not a number, we are not dealing with a module factory
|
|
if (!Settings.eagerPatches || newValue?.$$vencordRequired === true || Number.isNaN(Number(p))) {
|
|
return Reflect.set(target, p, newValue);
|
|
}
|
|
|
|
const existingFactory = Reflect.get(target, p);
|
|
|
|
// Check if this factory is already patched
|
|
// @ts-ignore
|
|
if (existingFactory?.$$vencordOriginal === newValue) {
|
|
return true;
|
|
}
|
|
|
|
const patchedFactory = patchFactory(p, newValue);
|
|
|
|
// Modules are only patched once, so we need to set the patched factory on all the modules
|
|
for (const proxiedModules of allProxiedModules) {
|
|
Reflect.set(proxiedModules, p, patchedFactory);
|
|
}
|
|
|
|
return true;
|
|
},
|
|
ownKeys: target => {
|
|
const keys = Reflect.ownKeys(target);
|
|
for (const key of UNCONFIGURABLE_PROPERTIES) {
|
|
if (!keys.includes(key)) keys.push(key);
|
|
}
|
|
return keys;
|
|
}
|
|
};
|
|
|
|
// wreq.O is the webpack onChunksLoaded function
|
|
// Discord uses it to await for all the chunks to be loaded before initializing the app
|
|
// We monkey patch it to also monkey patch the initialize app callback to get immediate access to the webpack require and run our listeners before doing it
|
|
Object.defineProperty(Function.prototype, "O", {
|
|
configurable: true,
|
|
|
|
set(this: WebpackRequire, onChunksLoaded: WebpackRequire["O"]) {
|
|
// When using react devtools or other extensions, or even when discord loads the sentry, we may also catch their webpack here.
|
|
// This ensures we actually got the right one
|
|
// this.e (wreq.e) is the method for loading a chunk, and only the main webpack has it
|
|
const { stack } = new Error();
|
|
if ((stack?.includes("discord.com") || stack?.includes("discordapp.com")) && String(this.e).includes("Promise.all")) {
|
|
logger.info("Found main WebpackRequire.onChunksLoaded");
|
|
|
|
delete (Function.prototype as any).O;
|
|
|
|
const originalOnChunksLoaded = onChunksLoaded;
|
|
onChunksLoaded = function (result, chunkIds, callback, priority) {
|
|
if (callback != null && initCallbackRegex.test(callback.toString())) {
|
|
Object.defineProperty(this, "O", {
|
|
value: originalOnChunksLoaded,
|
|
configurable: true,
|
|
enumerable: true,
|
|
writable: true
|
|
});
|
|
|
|
const wreq = this;
|
|
|
|
const originalCallback = callback;
|
|
callback = function (this: unknown) {
|
|
logger.info("Patched initialize app callback invoked, initializing our internal references to WebpackRequire and running beforeInitListeners");
|
|
_initWebpack(wreq);
|
|
|
|
for (const beforeInitListener of beforeInitListeners) {
|
|
beforeInitListener(wreq);
|
|
}
|
|
|
|
originalCallback.apply(this, arguments as any);
|
|
};
|
|
|
|
callback.toString = originalCallback.toString.bind(originalCallback);
|
|
arguments[2] = callback;
|
|
}
|
|
|
|
originalOnChunksLoaded.apply(this, arguments as any);
|
|
} as WebpackRequire["O"];
|
|
|
|
onChunksLoaded.toString = originalOnChunksLoaded.toString.bind(originalOnChunksLoaded);
|
|
|
|
// Returns whether a chunk has been loaded
|
|
Object.defineProperty(onChunksLoaded, "j", {
|
|
configurable: true,
|
|
|
|
set(v: OnChunksLoaded["j"]) {
|
|
// @ts-ignore
|
|
delete onChunksLoaded.j;
|
|
onChunksLoaded.j = v;
|
|
originalOnChunksLoaded.j = v;
|
|
}
|
|
});
|
|
}
|
|
|
|
Object.defineProperty(this, "O", {
|
|
value: onChunksLoaded,
|
|
configurable: true,
|
|
enumerable: true,
|
|
writable: true
|
|
});
|
|
}
|
|
});
|
|
|
|
// wreq.m is the webpack object containing module factories.
|
|
// This is pre-populated with module factories, and is also populated via webpackGlobal.push
|
|
// The sentry module also has their own webpack with a pre-populated module factories object, so this also targets that
|
|
// We replace its prototype with our proxy, which is responsible for patching the module factories
|
|
Object.defineProperty(Function.prototype, "m", {
|
|
configurable: true,
|
|
|
|
set(this: WebpackRequire, originalModules: WebpackRequire["m"]) {
|
|
// When using react devtools or other extensions, we may also catch their webpack here.
|
|
// This ensures we actually got the right one
|
|
const { stack } = new Error();
|
|
if ((stack?.includes("discord.com") || stack?.includes("discordapp.com")) && !Array.isArray(originalModules)) {
|
|
logger.info("Found Webpack module factory", stack.match(/\/assets\/(.+?\.js)/)?.[1] ?? "");
|
|
|
|
// The new object which will contain the factories
|
|
const proxiedModules: WebpackRequire["m"] = {};
|
|
|
|
for (const id in originalModules) {
|
|
// If we have eagerPatches enabled we have to patch the pre-populated factories
|
|
if (Settings.eagerPatches) {
|
|
proxiedModules[id] = patchFactory(id, originalModules[id]);
|
|
} else {
|
|
proxiedModules[id] = originalModules[id];
|
|
}
|
|
|
|
// Clear the original object so pre-populated factories are patched if eagerPatches are disabled
|
|
delete originalModules[id];
|
|
}
|
|
|
|
// @ts-ignore
|
|
originalModules.$$proxiedModules = proxiedModules;
|
|
allProxiedModules.add(proxiedModules);
|
|
Object.setPrototypeOf(originalModules, new Proxy(proxiedModules, modulesProxyHandler));
|
|
}
|
|
|
|
Object.defineProperty(this, "m", {
|
|
value: originalModules,
|
|
configurable: true,
|
|
enumerable: true,
|
|
writable: true
|
|
});
|
|
}
|
|
});
|
|
|
|
let webpackNotInitializedLogged = false;
|
|
|
|
function patchFactory(id: PropertyKey, factory: ModuleFactory) {
|
|
for (const factoryListener of factoryListeners) {
|
|
try {
|
|
factoryListener(factory);
|
|
} catch (err) {
|
|
logger.error("Error in Webpack factory listener:\n", err, factoryListener);
|
|
}
|
|
}
|
|
|
|
const originalFactory = factory;
|
|
const patchedBy = new Set<string>();
|
|
|
|
// Discords Webpack chunks for some ungodly reason contain random
|
|
// newlines. Cyn recommended this workaround and it seems to work fine,
|
|
// however this could potentially break code, so if anything goes weird,
|
|
// this is probably why.
|
|
// Additionally, `[actual newline]` is one less char than "\n", so if Discord
|
|
// ever targets newer browsers, the minifier could potentially use this trick and
|
|
// cause issues.
|
|
//
|
|
// 0, prefix is to turn it into an expression: 0,function(){} would be invalid syntax without the 0,
|
|
let code: string = "0," + factory.toString().replaceAll("\n", "");
|
|
|
|
for (let i = 0; i < patches.length; i++) {
|
|
const patch = patches[i];
|
|
if (patch.predicate && !patch.predicate()) continue;
|
|
|
|
const moduleMatches = typeof patch.find === "string"
|
|
? code.includes(patch.find)
|
|
: patch.find.test(code);
|
|
|
|
if (!moduleMatches) continue;
|
|
|
|
patchedBy.add(patch.plugin);
|
|
|
|
const executePatch = traceFunction(`patch by ${patch.plugin}`, (match: string | RegExp, replace: string) => code.replace(match, replace));
|
|
const previousFactory = factory;
|
|
const previousCode = code;
|
|
|
|
// We change all patch.replacement to array in plugins/index
|
|
for (const replacement of patch.replacement as PatchReplacement[]) {
|
|
if (replacement.predicate && !replacement.predicate()) continue;
|
|
|
|
const lastFactory = factory;
|
|
const lastCode = code;
|
|
|
|
canonicalizeReplacement(replacement, patch.plugin);
|
|
|
|
try {
|
|
const newCode = executePatch(replacement.match, replacement.replace as string);
|
|
if (newCode === code) {
|
|
if (!patch.noWarn) {
|
|
logger.warn(`Patch by ${patch.plugin} had no effect (Module id is ${String(id)}): ${replacement.match}`);
|
|
if (IS_DEV) {
|
|
logger.debug("Function Source:\n", code);
|
|
}
|
|
}
|
|
|
|
if (patch.group) {
|
|
logger.warn(`Undoing patch group ${patch.find} by ${patch.plugin} because replacement ${replacement.match} had no effect`);
|
|
factory = previousFactory;
|
|
code = previousCode;
|
|
patchedBy.delete(patch.plugin);
|
|
break;
|
|
}
|
|
|
|
continue;
|
|
}
|
|
|
|
code = newCode;
|
|
factory = (0, eval)(`// Webpack Module ${String(id)} - Patched by ${[...patchedBy].join(", ")}\n${newCode}\n//# sourceURL=WebpackModule${String(id)}`);
|
|
} catch (err) {
|
|
logger.error(`Patch by ${patch.plugin} errored (Module id is ${String(id)}): ${replacement.match}\n`, err);
|
|
|
|
if (IS_DEV) {
|
|
const changeSize = code.length - lastCode.length;
|
|
const match = lastCode.match(replacement.match)!;
|
|
|
|
// Use 200 surrounding characters of context
|
|
const start = Math.max(0, match.index! - 200);
|
|
const end = Math.min(lastCode.length, match.index! + match[0].length + 200);
|
|
// (changeSize may be negative)
|
|
const endPatched = end + changeSize;
|
|
|
|
const context = lastCode.slice(start, end);
|
|
const patchedContext = code.slice(start, endPatched);
|
|
|
|
// inline require to avoid including it in !IS_DEV builds
|
|
const diff = (require("diff") as typeof import("diff")).diffWordsWithSpace(context, patchedContext);
|
|
let fmt = "%c %s ";
|
|
const elements = [] as string[];
|
|
for (const d of diff) {
|
|
const color = d.removed
|
|
? "red"
|
|
: d.added
|
|
? "lime"
|
|
: "grey";
|
|
fmt += "%c%s";
|
|
elements.push("color:" + color, d.value);
|
|
}
|
|
|
|
logger.errorCustomFmt(...Logger.makeTitle("white", "Before"), context);
|
|
logger.errorCustomFmt(...Logger.makeTitle("white", "After"), patchedContext);
|
|
const [titleFmt, ...titleElements] = Logger.makeTitle("white", "Diff");
|
|
logger.errorCustomFmt(titleFmt + fmt, ...titleElements, ...elements);
|
|
}
|
|
|
|
patchedBy.delete(patch.plugin);
|
|
|
|
if (patch.group) {
|
|
logger.warn(`Undoing patch group ${patch.find} by ${patch.plugin} because replacement ${replacement.match} errored`);
|
|
factory = previousFactory;
|
|
code = previousCode;
|
|
break;
|
|
}
|
|
|
|
factory = lastFactory;
|
|
code = lastCode;
|
|
}
|
|
}
|
|
|
|
if (!patch.all) patches.splice(i--, 1);
|
|
}
|
|
|
|
const patchedFactory: ModuleFactory = (module, exports, require) => {
|
|
// @ts-ignore
|
|
originalFactory.$$vencordRequired = true;
|
|
for (const proxiedModules of allProxiedModules) {
|
|
proxiedModules[id] = originalFactory;
|
|
}
|
|
|
|
if (wreq == null && IS_DEV) {
|
|
if (!webpackNotInitializedLogged) {
|
|
webpackNotInitializedLogged = true;
|
|
logger.error("WebpackRequire was not initialized, running modules without patches instead.");
|
|
}
|
|
|
|
return void originalFactory(module, exports, require);
|
|
}
|
|
|
|
try {
|
|
factory(module, exports, require);
|
|
} catch (err) {
|
|
// Just rethrow Discord errors
|
|
if (factory === originalFactory) throw err;
|
|
|
|
logger.error("Error in patched module", err);
|
|
return void originalFactory(module, exports, require);
|
|
}
|
|
|
|
// Webpack sometimes sets the value of module.exports directly, so assign exports to it to make sure we properly handle it
|
|
exports = module.exports;
|
|
if (exports == null) return;
|
|
|
|
// There are (at the time of writing) 11 modules exporting the window
|
|
// Make these non enumerable to improve webpack search performance
|
|
if (exports === window && require.c) {
|
|
Object.defineProperty(require.c, id, {
|
|
value: require.c[id],
|
|
configurable: true,
|
|
enumerable: false,
|
|
writable: true
|
|
});
|
|
return;
|
|
}
|
|
|
|
for (const callback of moduleListeners) {
|
|
try {
|
|
callback(exports, id);
|
|
} catch (err) {
|
|
logger.error("Error in Webpack module listener:\n", err, callback);
|
|
}
|
|
}
|
|
|
|
for (const [filter, callback] of subscriptions) {
|
|
try {
|
|
if (filter(exports)) {
|
|
subscriptions.delete(filter);
|
|
callback(exports, id);
|
|
} else if (exports.default && filter(exports.default)) {
|
|
subscriptions.delete(filter);
|
|
callback(exports.default, id);
|
|
}
|
|
} catch (err) {
|
|
logger.error("Error while firing callback for Webpack subscription:\n", err, filter, callback);
|
|
}
|
|
}
|
|
};
|
|
|
|
patchedFactory.toString = originalFactory.toString.bind(originalFactory);
|
|
// @ts-ignore
|
|
patchedFactory.$$vencordOriginal = originalFactory;
|
|
|
|
return patchedFactory;
|
|
}
|