StyAndCo/zeppelin
3
0
Fork 0
mirror of https://github.com/ZeppelinBot/Zeppelin.git synced 2025-05-10 12:25:02 +00:00
Code Releases Activity

Centralize periodic checks for mutes, tempbans, vcalerts, reminders, and scheduled posts

Browse source 
This should result in a significant performance improvement.
The new method is also more precise than the old one, allowing
the aforementioned checks to be performed with second-precision.
This commit is contained in:
Dragory 2021-09-25 21:33:59 +03:00
parent c84d1a0be1
commit c7751a9da1
No known key found for this signature in database
GPG key ID: 5F387BA66DF8AAC1
55 changed files with 883 additions and 366 deletions
Download patch file Download diff file Expand all files Collapse all files

11
backend/src/plugins/Mutes/MutesPlugin.ts
View file

@ -15,12 +15,13 @@ import { MutesCmd } from "./commands/MutesCmd";
import { ClearActiveMuteOnMemberBanEvt } from "./events/ClearActiveMuteOnMemberBanEvt";
import { ClearActiveMuteOnRoleRemovalEvt } from "./events/ClearActiveMuteOnRoleRemovalEvt";
import { ReapplyActiveMuteOnJoinEvt } from "./events/ReapplyActiveMuteOnJoinEvt";
import { clearExpiredMutes } from "./functions/clearExpiredMutes";
import { muteUser } from "./functions/muteUser";
import { offMutesEvent } from "./functions/offMutesEvent";
import { onMutesEvent } from "./functions/onMutesEvent";
import { unmuteUser } from "./functions/unmuteUser";
import { ConfigSchema, MutesPluginType } from "./types";
import { onGuildEvent } from "../../data/GuildEvents";
import { clearMute } from "./functions/clearMute";
const defaultOptions = {
config: {
@ -113,15 +114,13 @@ export const MutesPlugin = zeppelinGuildPlugin<MutesPluginType>()({
},
afterLoad(pluginData) {
clearExpiredMutes(pluginData);
pluginData.state.muteClearIntervalId = setInterval(
() => clearExpiredMutes(pluginData),
EXPIRED_MUTE_CHECK_INTERVAL,
pluginData.state.unregisterGuildEventListener = onGuildEvent(pluginData.guild.id, "expiredMute", (mute) =>
clearMute(pluginData, mute),
);
},
beforeUnload(pluginData) {
clearInterval(pluginData.state.muteClearIntervalId);
pluginData.state.unregisterGuildEventListener();
pluginData.state.events.removeAllListeners();
},
});

50
backend/src/plugins/Mutes/functions/clearExpiredMutes.ts
View file

@ -1,50 +0,0 @@
import { Snowflake } from "discord.js";
import { GuildPluginData } from "knub";
import { memberToTemplateSafeMember } from "../../../utils/templateSafeObjects";
import { LogType } from "../../../data/LogType";
import { resolveMember, UnknownUser, verboseUserMention } from "../../../utils";
import { memberRolesLock } from "../../../utils/lockNameHelpers";
import { MutesPluginType } from "../types";
import { LogsPlugin } from "../../Logs/LogsPlugin";
export async function clearExpiredMutes(pluginData: GuildPluginData<MutesPluginType>) {
const expiredMutes = await pluginData.state.mutes.getExpiredMutes();
for (const mute of expiredMutes) {
const member = await resolveMember(pluginData.client, pluginData.guild, mute.user_id, true);
if (member) {
try {
const lock = await pluginData.locks.acquire(memberRolesLock(member));
const muteRole = pluginData.config.get().mute_role;
if (muteRole) {
await member.roles.remove(muteRole);
}
if (mute.roles_to_restore) {
const guildRoles = pluginData.guild.roles.cache;
const newRoles = [...member.roles.cache.keys()].filter((roleId) => roleId !== muteRole);
for (const toRestore of mute.roles_to_restore) {
if (guildRoles.has(toRestore) && toRestore !== muteRole && !newRoles.includes(toRestore)) {
newRoles.push(toRestore);
}
}
await member.roles.set(newRoles);
}
lock.unlock();
} catch {
pluginData.getPlugin(LogsPlugin).logBotAlert({
body: `Failed to remove mute role from ${verboseUserMention(member.user)}`,
});
}
}
await pluginData.state.mutes.clear(mute.user_id);
pluginData.getPlugin(LogsPlugin).logMemberMuteExpired({
member: member || new UnknownUser({ id: mute.user_id }),
});
pluginData.state.events.emit("unmute", mute.user_id);
}
}

55
backend/src/plugins/Mutes/functions/clearMute.ts Normal file
View file

@ -0,0 +1,55 @@
import { Mute } from "../../../data/entities/Mute";
import { resolveMember, verboseUserMention } from "../../../utils";
import { memberRolesLock } from "../../../utils/lockNameHelpers";
import { LogsPlugin } from "../../Logs/LogsPlugin";
import { GuildPluginData } from "knub";
import { MutesPluginType } from "../types";
import { clearExpiringMute } from "../../../data/loops/expiringMutesLoop";
import { GuildMember } from "discord.js";
export async function clearMute(
pluginData: GuildPluginData<MutesPluginType>,
mute: Mute | null = null,
member: GuildMember | null = null,
) {
if (mute) {
clearExpiringMute(mute);
}
if (!member && mute) {
member = await resolveMember(pluginData.client, pluginData.guild, mute.user_id, true);
}
if (member) {
const lock = await pluginData.locks.acquire(memberRolesLock(member));
try {
const muteRole = pluginData.config.get().mute_role;
if (muteRole) {
await member.roles.remove(muteRole);
}
if (mute?.roles_to_restore) {
const guildRoles = pluginData.guild.roles.cache;
const newRoles = [...member.roles.cache.keys()].filter((roleId) => roleId !== muteRole);
for (const toRestore of mute?.roles_to_restore) {
if (guildRoles.has(toRestore) && toRestore !== muteRole && !newRoles.includes(toRestore)) {
newRoles.push(toRestore);
}
}
await member.roles.set(newRoles);
}
lock.unlock();
} catch {
pluginData.getPlugin(LogsPlugin).logBotAlert({
body: `Failed to remove mute role from ${verboseUserMention(member.user)}`,
});
} finally {
lock.unlock();
}
}
if (mute) {
await pluginData.state.mutes.clear(mute.user_id);
}
}

12
backend/src/plugins/Mutes/functions/muteUser.ts
View file

@ -4,7 +4,6 @@ import { GuildPluginData } from "knub";
import { userToTemplateSafeUser } from "../../../utils/templateSafeObjects";
import { CaseTypes } from "../../../data/CaseTypes";
import { Case } from "../../../data/entities/Case";
import { LogType } from "../../../data/LogType";
import { LogsPlugin } from "../../../plugins/Logs/LogsPlugin";
import { ERRORS, RecoverablePluginError } from "../../../RecoverablePluginError";
import { renderTemplate, TemplateSafeValueContainer } from "../../../templateFormatter";
@ -19,7 +18,12 @@ import {
import { muteLock } from "../../../utils/lockNameHelpers";
import { CasesPlugin } from "../../Cases/CasesPlugin";
import { MuteOptions, MutesPluginType } from "../types";
import { Mute } from "../../../data/entities/Mute";
import { registerExpiringMute } from "../../../data/loops/expiringMutesLoop";
/**
* TODO: Clean up this function
*/
export async function muteUser(
pluginData: GuildPluginData<MutesPluginType>,
userId: string,
@ -132,6 +136,7 @@ export async function muteUser(
// If the user is already muted, update the duration of their existing mute
const existingMute = await pluginData.state.mutes.findExistingMuteForUserId(user.id);
let finalMute: Mute;
let notifyResult: UserNotificationResult = { method: null, success: true };
if (existingMute) {
@ -139,10 +144,13 @@ export async function muteUser(
rolesToRestore = Array.from(new Set([...existingMute.roles_to_restore, ...rolesToRestore]));
}
await pluginData.state.mutes.updateExpiryTime(user.id, muteTime, rolesToRestore);
finalMute = (await pluginData.state.mutes.findExistingMuteForUserId(user.id))!;
} else {
await pluginData.state.mutes.addMute(user.id, muteTime, rolesToRestore);
finalMute = await pluginData.state.mutes.addMute(user.id, muteTime, rolesToRestore);
}
registerExpiringMute(finalMute);
const template = existingMute
? config.update_mute_message
: muteTime

30
backend/src/plugins/Mutes/functions/unmuteUser.ts
View file

@ -11,6 +11,7 @@ import { CaseArgs } from "../../Cases/types";
import { MutesPluginType, UnmuteResult } from "../types";
import { memberHasMutedRole } from "./memberHasMutedRole";
import { LogsPlugin } from "../../Logs/LogsPlugin";
import { clearMute } from "./clearMute";
export async function unmuteUser(
pluginData: GuildPluginData<MutesPluginType>,
@ -34,34 +35,7 @@ export async function unmuteUser(
}
} else {
// Unmute immediately
if (member) {
const lock = await pluginData.locks.acquire(memberRolesLock(member));
const muteRole = pluginData.config.get().mute_role;
if (muteRole && member.roles.cache.has(muteRole as Snowflake)) {
await member.roles.remove(muteRole as Snowflake);
}
if (existingMute?.roles_to_restore) {
const guildRoles = pluginData.guild.roles.cache;
const newRoles = [...member.roles.cache.keys()].filter((roleId) => roleId !== muteRole);
for (const toRestore of existingMute.roles_to_restore) {
if (guildRoles.has(toRestore) && toRestore !== muteRole && !newRoles.includes(toRestore)) {
newRoles.push(toRestore);
}
}
await member.roles.set(newRoles);
}
lock.unlock();
} else {
// tslint:disable-next-line:no-console
console.warn(
`Member ${userId} not found in guild ${pluginData.guild.name} (${pluginData.guild.id}) when attempting to unmute`,
);
}
if (existingMute) {
await pluginData.state.mutes.clear(userId);
}
clearMute(pluginData, existingMute);
}
const timeUntilUnmute = unmuteTime && humanizeDuration(unmuteTime);

2
backend/src/plugins/Mutes/types.ts
View file

@ -52,7 +52,7 @@ export interface MutesPluginType extends BasePluginType {
serverLogs: GuildLogs;
archives: GuildArchives;
muteClearIntervalId: Timeout;
unregisterGuildEventListener: () => void;
events: MutesEventEmitter;
};