Vencord/src/plugins/index.ts

197 lines
6 KiB
TypeScript
Raw Normal View History

2022-10-21 19:17:06 -04:00
/*
* 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 { registerCommand, unregisterCommand } from "@api/Commands";
2023-05-05 19:36:00 -04:00
import { Settings } from "@api/Settings";
import { Logger } from "@utils/Logger";
import { Patch, Plugin, StartAt } from "@utils/types";
import { FluxDispatcher } from "@webpack/common";
import { FluxEvents } from "@webpack/types";
import Plugins from "~plugins";
import { traceFunction } from "../debug/Tracer";
2022-08-29 12:11:44 -04:00
2022-08-29 14:27:47 -04:00
const logger = new Logger("PluginManager", "#a6d189");
export const PMLogger = logger;
2022-08-29 14:27:47 -04:00
export const plugins = Plugins;
export const patches = [] as Patch[];
const settings = Settings.plugins;
export function isPluginEnabled(p: string) {
return (
Plugins[p]?.required ||
Plugins[p]?.isDependency ||
settings[p]?.enabled
) ?? false;
}
const pluginsValues = Object.values(Plugins);
// First roundtrip to mark and force enable dependencies (only for enabled plugins)
//
// FIXME: might need to revisit this if there's ever nested (dependencies of dependencies) dependencies since this only
// goes for the top level and their children, but for now this works okay with the current API plugins
for (const p of pluginsValues) if (settings[p.name]?.enabled) {
p.dependencies?.forEach(d => {
const dep = Plugins[d];
if (dep) {
settings[d].enabled = true;
dep.isDependency = true;
}
else {
const error = new Error(`Plugin ${p.name} has unresolved dependency ${d}`);
if (IS_DEV)
throw error;
logger.warn(error);
}
});
2022-08-29 14:27:47 -04:00
}
for (const p of pluginsValues) {
if (p.settings) {
p.settings.pluginName = p.name;
p.options ??= {};
for (const [name, def] of Object.entries(p.settings.def)) {
const checks = p.settings.checks?.[name];
p.options[name] = { ...def, ...checks };
}
}
if (p.patches && isPluginEnabled(p.name)) {
for (const patch of p.patches) {
patch.plugin = p.name;
if (!Array.isArray(patch.replacement))
patch.replacement = [patch.replacement];
patches.push(patch);
}
}
}
export const startAllPlugins = traceFunction("startAllPlugins", function startAllPlugins(target: StartAt) {
logger.info(`Starting plugins (stage ${target})`);
for (const name in Plugins)
if (isPluginEnabled(name)) {
const p = Plugins[name];
const startAt = p.startAt ?? StartAt.WebpackReady;
if (startAt !== target) continue;
startPlugin(Plugins[name]);
}
});
export function startDependenciesRecursive(p: Plugin) {
let restartNeeded = false;
const failures: string[] = [];
p.dependencies?.forEach(dep => {
if (!Settings.plugins[dep].enabled) {
startDependenciesRecursive(Plugins[dep]);
// If the plugin has patches, don't start the plugin, just enable it.
Settings.plugins[dep].enabled = true;
if (Plugins[dep].patches) {
logger.warn(`Enabling dependency ${dep} requires restart.`);
restartNeeded = true;
return;
}
const result = startPlugin(Plugins[dep]);
if (!result) failures.push(dep);
}
});
return { restartNeeded, failures };
}
export const startPlugin = traceFunction("startPlugin", function startPlugin(p: Plugin) {
const { name, commands, flux } = p;
2022-10-05 18:11:32 -04:00
if (p.start) {
logger.info("Starting plugin", name);
2022-10-05 18:11:32 -04:00
if (p.started) {
logger.warn(`${name} already started`);
2022-10-05 18:11:32 -04:00
return false;
}
try {
p.start();
p.started = true;
} catch (e) {
logger.error(`Failed to start ${name}\n`, e);
2022-10-05 18:11:32 -04:00
return false;
}
}
if (commands?.length) {
logger.info("Registering commands of plugin", name);
for (const cmd of commands) {
2022-10-05 18:11:32 -04:00
try {
registerCommand(cmd, name);
2022-10-05 18:11:32 -04:00
} catch (e) {
logger.error(`Failed to register command ${cmd.name}\n`, e);
return false;
}
}
}
2022-10-05 18:11:32 -04:00
if (flux) {
for (const event in flux) {
FluxDispatcher.subscribe(event as FluxEvents, flux[event]);
}
}
2022-10-05 18:11:32 -04:00
return true;
}, p => `startPlugin ${p.name}`);
export const stopPlugin = traceFunction("stopPlugin", function stopPlugin(p: Plugin) {
const { name, commands, flux } = p;
2022-10-05 18:11:32 -04:00
if (p.stop) {
logger.info("Stopping plugin", name);
2022-10-05 18:11:32 -04:00
if (!p.started) {
logger.warn(`${name} already stopped`);
2022-10-05 18:11:32 -04:00
return false;
}
try {
p.stop();
p.started = false;
} catch (e) {
logger.error(`Failed to stop ${name}\n`, e);
2022-10-05 18:11:32 -04:00
return false;
}
}
2022-10-05 18:11:32 -04:00
if (commands?.length) {
logger.info("Unregistering commands of plugin", name);
for (const cmd of commands) {
2022-10-05 18:11:32 -04:00
try {
unregisterCommand(cmd.name);
} catch (e) {
logger.error(`Failed to unregister command ${cmd.name}\n`, e);
return false;
}
}
2022-08-29 14:27:47 -04:00
}
2022-10-05 18:11:32 -04:00
if (flux) {
for (const event in flux) {
FluxDispatcher.unsubscribe(event as FluxEvents, flux[event]);
}
}
2022-10-05 18:11:32 -04:00
return true;
}, p => `stopPlugin ${p.name}`);