Add queue for massbans
This commit is contained in:
parent
0ea1ab4b46
commit
c30c9f6224
3 changed files with 98 additions and 64 deletions
|
@ -34,7 +34,7 @@ import { Member, Message } from "eris";
|
||||||
import { kickMember } from "./functions/kickMember";
|
import { kickMember } from "./functions/kickMember";
|
||||||
import { banUserId } from "./functions/banUserId";
|
import { banUserId } from "./functions/banUserId";
|
||||||
import { MassmuteCmd } from "./commands/MassmuteCmd";
|
import { MassmuteCmd } from "./commands/MassmuteCmd";
|
||||||
import { trimPluginDescription } from "../../utils";
|
import { MINUTES, trimPluginDescription } from "../../utils";
|
||||||
import { DeleteCaseCmd } from "./commands/DeleteCaseCmd";
|
import { DeleteCaseCmd } from "./commands/DeleteCaseCmd";
|
||||||
import { TimeAndDatePlugin } from "../TimeAndDate/TimeAndDatePlugin";
|
import { TimeAndDatePlugin } from "../TimeAndDate/TimeAndDatePlugin";
|
||||||
import { GuildTempbans } from "../../data/GuildTempbans";
|
import { GuildTempbans } from "../../data/GuildTempbans";
|
||||||
|
@ -44,6 +44,7 @@ import { mapToPublicFn } from "../../pluginUtils";
|
||||||
import { onModActionsEvent } from "./functions/onModActionsEvent";
|
import { onModActionsEvent } from "./functions/onModActionsEvent";
|
||||||
import { offModActionsEvent } from "./functions/offModActionsEvent";
|
import { offModActionsEvent } from "./functions/offModActionsEvent";
|
||||||
import { updateCase } from "./functions/updateCase";
|
import { updateCase } from "./functions/updateCase";
|
||||||
|
import { Queue } from "../../Queue";
|
||||||
|
|
||||||
const defaultOptions = {
|
const defaultOptions = {
|
||||||
config: {
|
config: {
|
||||||
|
@ -197,6 +198,9 @@ export const ModActionsPlugin = zeppelinGuildPlugin<ModActionsPluginType>()("mod
|
||||||
state.unloaded = false;
|
state.unloaded = false;
|
||||||
state.outdatedTempbansTimeout = null;
|
state.outdatedTempbansTimeout = null;
|
||||||
state.ignoredEvents = [];
|
state.ignoredEvents = [];
|
||||||
|
// Massbans can take a while depending on rate limits,
|
||||||
|
// so we're giving each massban 15 minutes to complete before launching the next massban
|
||||||
|
state.massbanQueue = new Queue(15 * MINUTES);
|
||||||
|
|
||||||
state.events = new EventEmitter();
|
state.events = new EventEmitter();
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
import { modActionsCmd, IgnoredEventType } from "../types";
|
import { modActionsCmd, IgnoredEventType } from "../types";
|
||||||
import { commandTypeHelpers as ct } from "../../../commandTypes";
|
import { commandTypeHelpers as ct } from "../../../commandTypes";
|
||||||
import { canActOn, sendErrorMessage, hasPermission, sendSuccessMessage } from "../../../pluginUtils";
|
import { canActOn, sendErrorMessage, hasPermission, sendSuccessMessage } from "../../../pluginUtils";
|
||||||
import { resolveUser, resolveMember, stripObjectToScalars, noop } from "../../../utils";
|
import { resolveUser, resolveMember, stripObjectToScalars, noop, MINUTES } from "../../../utils";
|
||||||
import { isBanned } from "../functions/isBanned";
|
import { isBanned } from "../functions/isBanned";
|
||||||
import { readContactMethodsFromArgs } from "../functions/readContactMethodsFromArgs";
|
import { readContactMethodsFromArgs } from "../functions/readContactMethodsFromArgs";
|
||||||
import { formatReasonWithAttachments } from "../functions/formatReasonWithAttachments";
|
import { formatReasonWithAttachments } from "../functions/formatReasonWithAttachments";
|
||||||
|
@ -14,6 +14,7 @@ import { CasesPlugin } from "../../../plugins/Cases/CasesPlugin";
|
||||||
import { LogType } from "../../../data/LogType";
|
import { LogType } from "../../../data/LogType";
|
||||||
import { performance } from "perf_hooks";
|
import { performance } from "perf_hooks";
|
||||||
import { humanizeDurationShort } from "../../../humanizeDurationShort";
|
import { humanizeDurationShort } from "../../../humanizeDurationShort";
|
||||||
|
import { load } from "js-yaml";
|
||||||
|
|
||||||
export const MassbanCmd = modActionsCmd({
|
export const MassbanCmd = modActionsCmd({
|
||||||
trigger: "massban",
|
trigger: "massban",
|
||||||
|
@ -53,73 +54,100 @@ export const MassbanCmd = modActionsCmd({
|
||||||
}
|
}
|
||||||
|
|
||||||
// Show a loading indicator since this can take a while
|
// Show a loading indicator since this can take a while
|
||||||
const loadingMsg = await msg.channel.createMessage("Banning...");
|
const initialLoadingText =
|
||||||
|
pluginData.state.massbanQueue.length === 0
|
||||||
|
? "Banning..."
|
||||||
|
: "Massban queued. Waiting for previous massban to finish.";
|
||||||
|
const loadingMsg = await msg.channel.createMessage(initialLoadingText);
|
||||||
|
|
||||||
// Ban each user and count failed bans (if any)
|
const waitTimeStart = performance.now();
|
||||||
const startTime = performance.now();
|
const waitingInterval = setInterval(() => {
|
||||||
const failedBans: string[] = [];
|
const waitTime = humanizeDurationShort(performance.now() - waitTimeStart);
|
||||||
const casesPlugin = pluginData.getPlugin(CasesPlugin);
|
loadingMsg
|
||||||
for (const [i, userId] of args.userIds.entries()) {
|
.edit(`Massban queued. Still waiting for previous massban to finish (waited ${waitTime}).`)
|
||||||
try {
|
.catch(() => clearInterval(waitingInterval));
|
||||||
// Ignore automatic ban cases and logs
|
}, 1 * MINUTES);
|
||||||
// We create our own cases below and post a single "mass banned" log instead
|
|
||||||
ignoreEvent(pluginData, IgnoredEventType.Ban, userId, 120 * 1000);
|
|
||||||
pluginData.state.serverLogs.ignoreLog(LogType.MEMBER_BAN, userId, 120 * 1000);
|
|
||||||
|
|
||||||
await pluginData.guild.banMember(userId, 1, banReason != null ? encodeURIComponent(banReason) : undefined);
|
pluginData.state.massbanQueue.add(async () => {
|
||||||
|
clearInterval(waitingInterval);
|
||||||
|
|
||||||
await casesPlugin.createCase({
|
if (pluginData.state.unloaded) {
|
||||||
userId,
|
void loadingMsg.delete().catch(noop);
|
||||||
modId: msg.author.id,
|
return;
|
||||||
type: CaseTypes.Ban,
|
}
|
||||||
reason: `Mass ban: ${banReason}`,
|
|
||||||
postInCaseLogOverride: false,
|
void loadingMsg.edit("Banning...").catch(noop);
|
||||||
|
|
||||||
|
// Ban each user and count failed bans (if any)
|
||||||
|
const startTime = performance.now();
|
||||||
|
const failedBans: string[] = [];
|
||||||
|
const casesPlugin = pluginData.getPlugin(CasesPlugin);
|
||||||
|
for (const [i, userId] of args.userIds.entries()) {
|
||||||
|
if (pluginData.state.unloaded) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
// Ignore automatic ban cases and logs
|
||||||
|
// We create our own cases below and post a single "mass banned" log instead
|
||||||
|
ignoreEvent(pluginData, IgnoredEventType.Ban, userId, 120 * 1000);
|
||||||
|
pluginData.state.serverLogs.ignoreLog(LogType.MEMBER_BAN, userId, 120 * 1000);
|
||||||
|
|
||||||
|
await pluginData.guild.banMember(userId, 1, banReason != null ? encodeURIComponent(banReason) : undefined);
|
||||||
|
|
||||||
|
await casesPlugin.createCase({
|
||||||
|
userId,
|
||||||
|
modId: msg.author.id,
|
||||||
|
type: CaseTypes.Ban,
|
||||||
|
reason: `Mass ban: ${banReason}`,
|
||||||
|
postInCaseLogOverride: false,
|
||||||
|
});
|
||||||
|
|
||||||
|
pluginData.state.events.emit("ban", userId, banReason);
|
||||||
|
} catch {
|
||||||
|
failedBans.push(userId);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Send a status update every 10 bans
|
||||||
|
if ((i + 1) % 10 === 0) {
|
||||||
|
loadingMsg.edit(`Banning... ${i + 1}/${args.userIds.length}`).catch(noop);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const totalTime = performance.now() - startTime;
|
||||||
|
const formattedTimeTaken = humanizeDurationShort(totalTime);
|
||||||
|
|
||||||
|
// Clear loading indicator
|
||||||
|
loadingMsg.delete().catch(noop);
|
||||||
|
|
||||||
|
const successfulBanCount = args.userIds.length - failedBans.length;
|
||||||
|
if (successfulBanCount === 0) {
|
||||||
|
// All bans failed - don't create a log entry and notify the user
|
||||||
|
sendErrorMessage(pluginData, msg.channel, "All bans failed. Make sure the IDs are valid.");
|
||||||
|
} else {
|
||||||
|
// Some or all bans were successful. Create a log entry for the mass ban and notify the user.
|
||||||
|
pluginData.state.serverLogs.log(LogType.MASSBAN, {
|
||||||
|
mod: stripObjectToScalars(msg.author),
|
||||||
|
count: successfulBanCount,
|
||||||
|
reason: banReason,
|
||||||
});
|
});
|
||||||
|
|
||||||
pluginData.state.events.emit("ban", userId, banReason);
|
if (failedBans.length) {
|
||||||
} catch {
|
sendSuccessMessage(
|
||||||
failedBans.push(userId);
|
pluginData,
|
||||||
|
msg.channel,
|
||||||
|
`Banned ${successfulBanCount} users in ${formattedTimeTaken}, ${
|
||||||
|
failedBans.length
|
||||||
|
} failed: ${failedBans.join(" ")}`,
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
sendSuccessMessage(
|
||||||
|
pluginData,
|
||||||
|
msg.channel,
|
||||||
|
`Banned ${successfulBanCount} users successfully in ${formattedTimeTaken}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
});
|
||||||
// Send a status update every 10 bans
|
|
||||||
if ((i + 1) % 10 === 0) {
|
|
||||||
loadingMsg.edit(`Banning... ${i + 1}/${args.userIds.length}`).catch(noop);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const totalTime = performance.now() - startTime;
|
|
||||||
const formattedTimeTaken = humanizeDurationShort(totalTime);
|
|
||||||
|
|
||||||
// Clear loading indicator
|
|
||||||
loadingMsg.delete().catch(noop);
|
|
||||||
|
|
||||||
const successfulBanCount = args.userIds.length - failedBans.length;
|
|
||||||
if (successfulBanCount === 0) {
|
|
||||||
// All bans failed - don't create a log entry and notify the user
|
|
||||||
sendErrorMessage(pluginData, msg.channel, "All bans failed. Make sure the IDs are valid.");
|
|
||||||
} else {
|
|
||||||
// Some or all bans were successful. Create a log entry for the mass ban and notify the user.
|
|
||||||
pluginData.state.serverLogs.log(LogType.MASSBAN, {
|
|
||||||
mod: stripObjectToScalars(msg.author),
|
|
||||||
count: successfulBanCount,
|
|
||||||
reason: banReason,
|
|
||||||
});
|
|
||||||
|
|
||||||
if (failedBans.length) {
|
|
||||||
sendSuccessMessage(
|
|
||||||
pluginData,
|
|
||||||
msg.channel,
|
|
||||||
`Banned ${successfulBanCount} users in ${formattedTimeTaken}, ${failedBans.length} failed: ${failedBans.join(
|
|
||||||
" ",
|
|
||||||
)}`,
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
sendSuccessMessage(
|
|
||||||
pluginData,
|
|
||||||
msg.channel,
|
|
||||||
`Banned ${successfulBanCount} users successfully in ${formattedTimeTaken}`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
|
@ -10,6 +10,7 @@ import { TextChannel } from "eris";
|
||||||
import { GuildTempbans } from "../../data/GuildTempbans";
|
import { GuildTempbans } from "../../data/GuildTempbans";
|
||||||
import Timeout = NodeJS.Timeout;
|
import Timeout = NodeJS.Timeout;
|
||||||
import { EventEmitter } from "events";
|
import { EventEmitter } from "events";
|
||||||
|
import { Queue } from "../../Queue";
|
||||||
|
|
||||||
export const ConfigSchema = t.type({
|
export const ConfigSchema = t.type({
|
||||||
dm_on_warn: t.boolean,
|
dm_on_warn: t.boolean,
|
||||||
|
@ -72,6 +73,7 @@ export interface ModActionsPluginType extends BasePluginType {
|
||||||
unloaded: boolean;
|
unloaded: boolean;
|
||||||
outdatedTempbansTimeout: Timeout | null;
|
outdatedTempbansTimeout: Timeout | null;
|
||||||
ignoredEvents: IIgnoredEvent[];
|
ignoredEvents: IIgnoredEvent[];
|
||||||
|
massbanQueue: Queue;
|
||||||
|
|
||||||
events: ModActionsEventEmitter;
|
events: ModActionsEventEmitter;
|
||||||
};
|
};
|
||||||
|
|
Loading…
Add table
Reference in a new issue