feat: add possibility to specify elevated roles (#85)

markokajzer · Jul 12, 2020 · 0b02319 · 0b02319
1 parent dc18b1a
commit 0b02319
Show file tree

Hide file tree

Showing 12 changed files with 52 additions and 16 deletions.
diff --git a/config/config.example.json b/config/config.example.json
@@ -11,5 +11,6 @@
   "stayInChannel": false,
   "timeout": 10,
   "deafen": false,
-  "game": ""
+  "game": "",
+  "elevatedRoles": ["sound remover", "moderator"]
 }
diff --git a/src/bot/commands/AvatarCommand.ts b/src/bot/commands/AvatarCommand.ts
@@ -1,8 +1,9 @@
-import { ClientUser, Message, Permissions } from 'discord.js';
+import { ClientUser, Message } from 'discord.js';
 
 import Config from '@config/Config';
 import localize from '@util/i18n/localize';
 import UserCommand from './base/UserCommand';
+import userHasElevatedRole from './helpers/userHasElevatedRole';
 
 export default class AvatarCommand implements UserCommand {
   public readonly TRIGGERS = ['avatar'];
@@ -22,7 +23,9 @@ export default class AvatarCommand implements UserCommand {
 
   public run(message: Message, params: string[]) {
     if (!message.member) return;
-    if (!message.member.hasPermission(Permissions.FLAGS.ADMINISTRATOR!)) return;
+
+    const allowedToRunCommand = userHasElevatedRole(message.member);
+    if (!allowedToRunCommand) return;
 
     if (params.length === this.NUMBER_OF_PARAMETERS && params[0] === 'remove') {
       this.user.setAvatar('');

diff --git a/src/bot/commands/ConfigCommand.ts b/src/bot/commands/ConfigCommand.ts
@@ -1,8 +1,9 @@
-import { ClientUser, Message, Permissions } from 'discord.js';
+import { ClientUser, Message } from 'discord.js';
 
 import Config from '@config/Config';
 import localize from '@util/i18n/localize';
 import Command from './base/Command';
+import userHasElevatedRole from './helpers/userHasElevatedRole';
 
 export default class ConfigCommand implements Command {
   public readonly TRIGGERS = ['config', 'set'];
@@ -22,7 +23,9 @@ export default class ConfigCommand implements Command {
 
   public run(message: Message, params: string[]) {
     if (!message.member) return;
-    if (!message.member.hasPermission(Permissions.FLAGS.ADMINISTRATOR!)) return;
+
+    const allowedToRunCommand = userHasElevatedRole(message.member);
+    if (!allowedToRunCommand) return;
 
     if (params.length < this.NUMBER_OF_PARAMETERS) {
       message.channel.send(this.USAGE);

diff --git a/src/bot/commands/IgnoreCommand.ts b/src/bot/commands/IgnoreCommand.ts
@@ -1,16 +1,19 @@
-import { Message, Permissions } from 'discord.js';
+import { Message } from 'discord.js';
 
 import * as ignoreList from '@util/db/IgnoreList';
 import localize from '@util/i18n/localize';
 import Command from './base/Command';
+import userHasElevatedRole from './helpers/userHasElevatedRole';
 
 export default class IgnoreCommand implements Command {
   public readonly TRIGGERS = ['ignore'];
   public readonly USAGE = 'Usage: !ignore <user>';
 
   public run(message: Message) {
     if (!message.member) return;
-    if (!message.member.hasPermission(Permissions.FLAGS.ADMINISTRATOR!)) return;
+
+    const allowedToRunCommand = userHasElevatedRole(message.member);
+    if (!allowedToRunCommand) return;
 
     const { users } = message.mentions;
     if (users.size < 1) {

diff --git a/src/bot/commands/RemoveCommand.ts b/src/bot/commands/RemoveCommand.ts
@@ -1,11 +1,12 @@
 import fs from 'fs';
 
-import { Message, Permissions } from 'discord.js';
+import { Message } from 'discord.js';
 
 import * as sounds from '@util/db/Sounds';
 import localize from '@util/i18n/localize';
 import { existsSound, getPathForSound } from '@util/SoundUtil';
 import Command from './base/Command';
+import userHasElevatedRole from './helpers/userHasElevatedRole';
 
 export default class RemoveCommand implements Command {
   public readonly TRIGGERS = ['remove'];
@@ -14,7 +15,9 @@ export default class RemoveCommand implements Command {
 
   public run(message: Message, params: string[]) {
     if (!message.member) return;
-    if (!message.member.hasPermission(Permissions.FLAGS.ADMINISTRATOR!)) return;
+
+    const allowedToRunCommand = userHasElevatedRole(message.member);
+    if (!allowedToRunCommand) return;
 
     if (params.length !== this.NUMBER_OF_PARAMETERS) {
       message.channel.send(this.USAGE);

diff --git a/src/bot/commands/RenameCommand.ts b/src/bot/commands/RenameCommand.ts
@@ -1,11 +1,12 @@
 import fs from 'fs';
 
-import { Message, Permissions } from 'discord.js';
+import { Message } from 'discord.js';
 
 import * as soundsDb from '@util/db/Sounds';
 import localize from '@util/i18n/localize';
 import { getExtensionForSound, getSounds } from '@util/SoundUtil';
 import Command from './base/Command';
+import userHasElevatedRole from './helpers/userHasElevatedRole';
 
 export default class RenameCommand implements Command {
   public readonly TRIGGERS = ['rename'];
@@ -14,7 +15,9 @@ export default class RenameCommand implements Command {
 
   public run(message: Message, params: string[]) {
     if (!message.member) return;
-    if (!message.member.hasPermission(Permissions.FLAGS.ADMINISTRATOR!)) return;
+
+    const allowedToRunCommand = userHasElevatedRole(message.member);
+    if (!allowedToRunCommand) return;
 
     if (params.length !== this.NUMBER_OF_PARAMETERS) {
       message.channel.send(this.USAGE);

diff --git a/src/bot/commands/TagCommand.ts b/src/bot/commands/TagCommand.ts
@@ -1,9 +1,10 @@
-import { Message, Permissions } from 'discord.js';
+import { Message } from 'discord.js';
 
 import * as sounds from '@util/db/Sounds';
 import localize from '@util/i18n/localize';
 import { getSounds } from '@util/SoundUtil';
 import Command from './base/Command';
+import userHasElevatedRole from './helpers/userHasElevatedRole';
 
 export default class TagCommand implements Command {
   public readonly TRIGGERS = ['tag'];
@@ -30,7 +31,9 @@ export default class TagCommand implements Command {
 
     if (params[0] === 'clear') {
       if (!message.member) return;
-      if (!message.member.hasPermission(Permissions.FLAGS.ADMINISTRATOR!)) return;
+
+      const allowedToRunCommand = userHasElevatedRole(message.member);
+      if (allowedToRunCommand) return;
 
       sounds.clearTags(sound);
       return;

diff --git a/src/bot/commands/UnignoreCommand.ts b/src/bot/commands/UnignoreCommand.ts
@@ -1,16 +1,19 @@
-import { Message, Permissions } from 'discord.js';
+import { Message } from 'discord.js';
 
 import * as ignoreList from '@util/db/IgnoreList';
 import localize from '@util/i18n/localize';
 import Command from './base/Command';
+import userHasElevatedRole from './helpers/userHasElevatedRole';
 
 export default class UnignoreCommand implements Command {
   public readonly TRIGGERS = ['unignore'];
   public readonly USAGE = 'Usage: !unignore <user>';
 
   public run(message: Message) {
     if (!message.member) return;
-    if (!message.member.hasPermission(Permissions.FLAGS.ADMINISTRATOR!)) return;
+
+    const allowedToRunCommand = userHasElevatedRole(message.member);
+    if (!allowedToRunCommand) return;
 
     const { users } = message.mentions;
     if (users.size < 1) {

diff --git a/src/bot/commands/helpers/userHasElevatedRole.ts b/src/bot/commands/helpers/userHasElevatedRole.ts
@@ -0,0 +1,11 @@
+import { config } from '@util/Container';
+import { GuildMember, Permissions } from 'discord.js';
+
+const userHasElevatedRole = (member: GuildMember) =>
+  member.roles.cache.some(
+    r =>
+      config.elevatedRoles.includes(r.name) ||
+      member.hasPermission(Permissions.FLAGS.ADMINISTRATOR!)
+  );
+
+export default userHasElevatedRole;
diff --git a/src/config/Config.ts b/src/config/Config.ts
@@ -18,6 +18,7 @@ export default class Config implements ConfigInterface {
   public timeout!: number;
   public deafen!: boolean;
   public game!: string;
+  public elevatedRoles!: string[];
 
   private readonly CONFIG_PATH = path.join(process.cwd(), 'config', 'config.json');
   private readonly MODIFIABLE_FIELDS = [

diff --git a/src/config/ConfigInterface.ts b/src/config/ConfigInterface.ts
@@ -15,4 +15,5 @@ export default interface ConfigInterface {
   timeout?: number;
   deafen?: boolean;
   game?: string;
+  elevatedRoles: string[];
 }
diff --git a/src/config/DefaultConfig.ts b/src/config/DefaultConfig.ts
@@ -13,7 +13,8 @@ const DEFAULT_CONFIG: ConfigInterface = {
   stayInChannel: false,
   timeout: 10, // Minutes
   deafen: false,
-  game: 'SoundBoard'
+  game: 'SoundBoard',
+  elevatedRoles: ['Moderator']
 };
 
 export default DEFAULT_CONFIG;