More work on permission utils and eager permission checks

backend/src/plugins/AutoReactions/events/AddReactionsEvt.ts

@@ -4,7 +4,9 @@ import { LogType } from "src/data/LogType";
 import { logger } from "../../../logger";
 import { LogsPlugin } from "../../Logs/LogsPlugin";
 import { Constants, GuildChannel } from "eris";
-import { memberHasChannelPermissions } from "../../../utils/memberHasChannelPermissions";
+import { getMissingChannelPermissions } from "../../../utils/getMissingChannelPermissions";
+import { readChannelPermissions } from "../../../utils/readChannelPermissions";
+import { missingPermissionError } from "../../../utils/missingPermissionError";
 
 const p = Constants.Permissions;
 
@@ -17,16 +19,16 @@ export const AddReactionsEvt = autoReactionsEvt({
     const autoReaction = await pluginData.state.autoReactions.getForChannel(message.channel.id);
     if (!autoReaction) return;
 
-    if (
-      !memberHasChannelPermissions(message.member, message.channel as GuildChannel, [
-        p.readMessages,
-        p.readMessageHistory,
-        p.addReactions,
-      ])
-    ) {
+    const me = pluginData.guild.members.get(pluginData.client.user.id);
+    const missingPermissions = getMissingChannelPermissions(
+      me,
+      message.channel as GuildChannel,
+      readChannelPermissions | p.addReactions,
+    );
+    if (missingPermissions) {
       const logs = pluginData.getPlugin(LogsPlugin);
       logs.log(LogType.BOT_ALERT, {
-        body: `Missing permissions to apply auto-reactions in <#${message.channel.id}>. Ensure I can read messages, read message history, and add reactions.`,
+        body: `Cannot apply auto-reactions in <#${message.channel.id}>. ${missingPermissionError(missingPermissions)}`,
       });
       return;
     }

backend/src/plugins/Automod/actions/addRoles.ts

@@ -1,21 +1,59 @@
 import * as t from "io-ts";
 import { automodAction } from "../helpers";
 import { LogType } from "../../../data/LogType";
-import { asyncMap, resolveMember, tNullable, unique } from "../../../utils";
-import { resolveActionContactMethods } from "../functions/resolveActionContactMethods";
-import { ModActionsPlugin } from "../../ModActions/ModActionsPlugin";
+import { unique } from "../../../utils";
+import { Constants } from "eris";
+import { hasDiscordPermissions } from "../../../utils/hasDiscordPermissions";
+import { LogsPlugin } from "../../Logs/LogsPlugin";
+import { getMissingPermissions } from "../../../utils/getMissingPermissions";
+import { canAssignRole } from "../../../utils/canAssignRole";
+import { missingPermissionError } from "../../../utils/missingPermissionError";
+
+const p = Constants.Permissions;
 
 export const AddRolesAction = automodAction({
   configType: t.array(t.string),
   defaultConfig: [],
 
-  async apply({ pluginData, contexts, actionConfig }) {
+  async apply({ pluginData, contexts, actionConfig, ruleName }) {
     const members = unique(contexts.map(c => c.member).filter(Boolean));
+    const me = pluginData.guild.members.get(pluginData.client.user.id);
+
+    const missingPermissions = getMissingPermissions(me.permission, p.manageRoles);
+    if (missingPermissions) {
+      const logs = pluginData.getPlugin(LogsPlugin);
+      logs.log(LogType.BOT_ALERT, {
+        body: `Cannot add roles in Automod rule **${ruleName}**. ${missingPermissionError(missingPermissions)}`,
+      });
+      return;
+    }
+
+    const rolesToAssign = [];
+    const rolesWeCannotAssign = [];
+    for (const roleId of actionConfig) {
+      if (canAssignRole(pluginData.guild, me, roleId)) {
+        rolesToAssign.push(roleId);
+      } else {
+        rolesWeCannotAssign.push(roleId);
+      }
+    }
+
+    if (rolesWeCannotAssign.length) {
+      const roleNamesWeCannotAssign = rolesWeCannotAssign.map(
+        roleId => pluginData.guild.roles.get(roleId)?.name || roleId,
+      );
+      const logs = pluginData.getPlugin(LogsPlugin);
+      logs.log(LogType.BOT_ALERT, {
+        body: `Unable to assign the following roles in Automod rule **${ruleName}**: **${roleNamesWeCannotAssign.join(
+          "**, **",
+        )}**`,
+      });
+    }
 
     await Promise.all(
       members.map(async member => {
         const memberRoles = new Set(member.roles);
-        for (const roleId of actionConfig) {
+        for (const roleId of rolesToAssign) {
           memberRoles.add(roleId);
         }
 

backend/src/plugins/Automod/actions/removeRoles.ts

@@ -4,19 +4,58 @@ import { LogType } from "../../../data/LogType";
 import { asyncMap, resolveMember, tNullable, unique } from "../../../utils";
 import { resolveActionContactMethods } from "../functions/resolveActionContactMethods";
 import { ModActionsPlugin } from "../../ModActions/ModActionsPlugin";
+import { getMissingPermissions } from "../../../utils/getMissingPermissions";
+import { LogsPlugin } from "../../Logs/LogsPlugin";
+import { missingPermissionError } from "../../../utils/missingPermissionError";
+import { canAssignRole } from "../../../utils/canAssignRole";
+import { Constants } from "eris";
+
+const p = Constants.Permissions;
 
 export const RemoveRolesAction = automodAction({
   configType: t.array(t.string),
 
   defaultConfig: [],
 
-  async apply({ pluginData, contexts, actionConfig }) {
+  async apply({ pluginData, contexts, actionConfig, ruleName }) {
     const members = unique(contexts.map(c => c.member).filter(Boolean));
+    const me = pluginData.guild.members.get(pluginData.client.user.id);
+
+    const missingPermissions = getMissingPermissions(me.permission, p.manageRoles);
+    if (missingPermissions) {
+      const logs = pluginData.getPlugin(LogsPlugin);
+      logs.log(LogType.BOT_ALERT, {
+        body: `Cannot add roles in Automod rule **${ruleName}**. ${missingPermissionError(missingPermissions)}`,
+      });
+      return;
+    }
+
+    const rolesToRemove = [];
+    const rolesWeCannotRemove = [];
+    for (const roleId of actionConfig) {
+      if (canAssignRole(pluginData.guild, me, roleId)) {
+        rolesToRemove.push(roleId);
+      } else {
+        rolesWeCannotRemove.push(roleId);
+      }
+    }
+
+    if (rolesWeCannotRemove.length) {
+      const roleNamesWeCannotRemove = rolesWeCannotRemove.map(
+        roleId => pluginData.guild.roles.get(roleId)?.name || roleId,
+      );
+      const logs = pluginData.getPlugin(LogsPlugin);
+      logs.log(LogType.BOT_ALERT, {
+        body: `Unable to remove the following roles in Automod rule **${ruleName}**: **${roleNamesWeCannotRemove.join(
+          "**, **",
+        )}**`,
+      });
+    }
 
     await Promise.all(
       members.map(async member => {
         const memberRoles = new Set(member.roles);
-        for (const roleId of actionConfig) {
+        for (const roleId of rolesToRemove) {
           memberRoles.delete(roleId);
         }