3
0
Fork 0
mirror of https://github.com/ZeppelinBot/Zeppelin.git synced 2025-07-07 11:07:19 +00:00

better timeout validations

Signed-off-by: GitHub <noreply@github.com>
This commit is contained in:
Tiago R 2023-11-26 15:33:56 +00:00 committed by GitHub
parent b47db15ad2
commit 3898a06c71
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 34 additions and 9 deletions

View file

@ -9,6 +9,8 @@ export enum ERRORS {
INVALID_USER, INVALID_USER,
INVALID_MUTE_ROLE_ID, INVALID_MUTE_ROLE_ID,
MUTE_ROLE_ABOVE_ZEP, MUTE_ROLE_ABOVE_ZEP,
USER_ABOVE_ZEP,
USER_NOT_MODERATABLE,
} }
export const RECOVERABLE_PLUGIN_ERROR_MESSAGES = { export const RECOVERABLE_PLUGIN_ERROR_MESSAGES = {
@ -20,6 +22,8 @@ export const RECOVERABLE_PLUGIN_ERROR_MESSAGES = {
[ERRORS.INVALID_USER]: "Invalid user", [ERRORS.INVALID_USER]: "Invalid user",
[ERRORS.INVALID_MUTE_ROLE_ID]: "Specified mute role is not valid", [ERRORS.INVALID_MUTE_ROLE_ID]: "Specified mute role is not valid",
[ERRORS.MUTE_ROLE_ABOVE_ZEP]: "Specified mute role is above Zeppelin in the role hierarchy", [ERRORS.MUTE_ROLE_ABOVE_ZEP]: "Specified mute role is above Zeppelin in the role hierarchy",
[ERRORS.USER_ABOVE_ZEP]: "Cannot mute user, specified user is above Zeppelin in the role hierarchy",
[ERRORS.USER_NOT_MODERATABLE]: "Cannot mute user, specified user is not moderatable",
}; };
export class RecoverablePluginError extends Error { export class RecoverablePluginError extends Error {

View file

@ -1,5 +1,6 @@
import moment from "moment-timezone"; import moment from "moment-timezone";
import { MuteTypes } from "../../../data/MuteTypes"; import { MuteTypes } from "../../../data/MuteTypes";
import { noop } from "../../../utils.js";
import { LogsPlugin } from "../../Logs/LogsPlugin"; import { LogsPlugin } from "../../Logs/LogsPlugin";
import { RoleManagerPlugin } from "../../RoleManager/RoleManagerPlugin"; import { RoleManagerPlugin } from "../../RoleManager/RoleManagerPlugin";
import { getTimeoutExpiryTime } from "../functions/getTimeoutExpiryTime"; import { getTimeoutExpiryTime } from "../functions/getTimeoutExpiryTime";
@ -25,7 +26,7 @@ export const ReapplyActiveMuteOnJoinEvt = mutesEvt({
if (!member.isCommunicationDisabled()) { if (!member.isCommunicationDisabled()) {
const expiresAt = mute.expires_at ? moment.utc(mute.expires_at).valueOf() : null; const expiresAt = mute.expires_at ? moment.utc(mute.expires_at).valueOf() : null;
const timeoutExpiresAt = getTimeoutExpiryTime(expiresAt); const timeoutExpiresAt = getTimeoutExpiryTime(expiresAt);
await member.disableCommunicationUntil(timeoutExpiresAt); await member.disableCommunicationUntil(timeoutExpiresAt).catch(noop);
} }
} }

View file

@ -1,4 +1,4 @@
import { Snowflake } from "discord.js"; import { PermissionsBitField, Snowflake } from "discord.js";
import humanizeDuration from "humanize-duration"; import humanizeDuration from "humanize-duration";
import { GuildPluginData } from "knub"; import { GuildPluginData } from "knub";
import { ERRORS, RecoverablePluginError } from "../../../RecoverablePluginError"; import { ERRORS, RecoverablePluginError } from "../../../RecoverablePluginError";
@ -91,6 +91,7 @@ export async function muteUser(
rolesToRestore = currentUserRoles.filter((x) => (<string[]>restoreRoles).includes(x)); rolesToRestore = currentUserRoles.filter((x) => (<string[]>restoreRoles).includes(x));
} }
const zep = await pluginData.guild.members.fetchMe();
if (muteType === MuteTypes.Role) { if (muteType === MuteTypes.Role) {
// Verify the configured mute role is valid // Verify the configured mute role is valid
const actualMuteRole = pluginData.guild.roles.cache.get(muteRole!); const actualMuteRole = pluginData.guild.roles.cache.get(muteRole!);
@ -103,12 +104,11 @@ export async function muteUser(
} }
// Verify the mute role is not above Zep's roles // Verify the mute role is not above Zep's roles
const zep = await pluginData.guild.members.fetchMe();
const zepRoles = pluginData.guild.roles.cache.filter((x) => zep.roles.cache.has(x.id)); const zepRoles = pluginData.guild.roles.cache.filter((x) => zep.roles.cache.has(x.id));
if (zepRoles.size === 0 || !zepRoles.some((zepRole) => zepRole.position > actualMuteRole.position)) { if (zepRoles.size === 0 || !zepRoles.some((zepRole) => zepRole.position > actualMuteRole.position)) {
lock.unlock(); lock.unlock();
logs.logBotAlert({ logs.logBotAlert({
body: `Cannot mute users, specified mute role is above Zeppelin in the role hierarchy`, body: `Cannot mute user, specified mute role is above Zeppelin in the role hierarchy`,
}); });
throw new RecoverablePluginError(ERRORS.MUTE_ROLE_ABOVE_ZEP, pluginData.guild); throw new RecoverablePluginError(ERRORS.MUTE_ROLE_ABOVE_ZEP, pluginData.guild);
} }
@ -117,6 +117,23 @@ export async function muteUser(
pluginData.getPlugin(RoleManagerPlugin).addPriorityRole(member.id, muteRole!); pluginData.getPlugin(RoleManagerPlugin).addPriorityRole(member.id, muteRole!);
} }
} else { } else {
if (!member.manageable) {
lock.unlock();
logs.logBotAlert({
body: `Cannot mute user, specified user is above Zeppelin in the role hierarchy`,
});
throw new RecoverablePluginError(ERRORS.USER_ABOVE_ZEP, pluginData.guild);
}
if (!member.moderatable || member.permissions.has(PermissionsBitField.Flags.Administrator)) {
// redundant safety, since canActOn already checks this
lock.unlock();
logs.logBotAlert({
body: `Cannot mute user, specified user is not moderatable`,
});
throw new RecoverablePluginError(ERRORS.USER_NOT_MODERATABLE, pluginData.guild);
}
await member.disableCommunicationUntil(timeoutUntil); await member.disableCommunicationUntil(timeoutUntil);
} }

View file

@ -3,7 +3,7 @@ import { GuildPluginData } from "knub";
import moment from "moment-timezone"; import moment from "moment-timezone";
import { MAX_TIMEOUT_DURATION } from "../../../data/Mutes"; import { MAX_TIMEOUT_DURATION } from "../../../data/Mutes";
import { Mute } from "../../../data/entities/Mute"; import { Mute } from "../../../data/entities/Mute";
import { DBDateFormat, resolveMember } from "../../../utils"; import { DBDateFormat, noop, resolveMember } from "../../../utils";
import { MutesPluginType } from "../types"; import { MutesPluginType } from "../types";
export async function renewTimeoutMute(pluginData: GuildPluginData<MutesPluginType>, mute: Mute) { export async function renewTimeoutMute(pluginData: GuildPluginData<MutesPluginType>, mute: Mute) {
@ -24,6 +24,6 @@ export async function renewTimeoutMute(pluginData: GuildPluginData<MutesPluginTy
} }
const expiryTimestamp = moment.utc(newExpiryTime).valueOf(); const expiryTimestamp = moment.utc(newExpiryTime).valueOf();
await member.disableCommunicationUntil(expiryTimestamp); await member.disableCommunicationUntil(expiryTimestamp).catch(noop);
await pluginData.state.mutes.updateTimeoutExpiresAt(mute.user_id, expiryTimestamp); await pluginData.state.mutes.updateTimeoutExpiresAt(mute.user_id, expiryTimestamp);
} }

View file

@ -1,4 +1,4 @@
import { Snowflake } from "discord.js"; import { PermissionsBitField, Snowflake } from "discord.js";
import humanizeDuration from "humanize-duration"; import humanizeDuration from "humanize-duration";
import { GuildPluginData } from "knub"; import { GuildPluginData } from "knub";
import { CaseTypes } from "../../../data/CaseTypes"; import { CaseTypes } from "../../../data/CaseTypes";
@ -54,8 +54,11 @@ export async function unmuteUser(
} }
// Update timeout // Update timeout
if (existingMute?.type === MuteTypes.Timeout || createdMute?.type === MuteTypes.Timeout) { if (member && (existingMute?.type === MuteTypes.Timeout || createdMute?.type === MuteTypes.Timeout)) {
await member?.disableCommunicationUntil(timeoutExpiresAt); if (!member.manageable || !member.moderatable || member.permissions.has(PermissionsBitField.Flags.Administrator))
return null;
await member.disableCommunicationUntil(timeoutExpiresAt);
await pluginData.state.mutes.updateTimeoutExpiresAt(userId, timeoutExpiresAt); await pluginData.state.mutes.updateTimeoutExpiresAt(userId, timeoutExpiresAt);
} }
} else { } else {