Merge pull request #31 from matthewflegg/dev

Added a dropdown for the ~blacklistremove command

Author: v0idzdev

README.md

@@ -24,6 +24,9 @@
 
 ## 📢 **Commands List**
 
+* We use `...argument` to denote a **list of arguments**, like `argument a`, `argument b`, etc...
+* We use `argument?` to denote an **optional argument**. You can use the command **with** or **without** one.<br><br>
+
 ### 🧭 Contents
 
 * **[Help Commands](#-help-commands)**
@@ -47,16 +50,18 @@ Sends an embed linking to **this page**.
 
 ### 🔑 Admin Commands
 
-> **~clear `number of messages`**
+> **~clear `number of messages?`**
 
-Clears a specified number of messages from a text channel.<br>
+Clears a specified number of messages from a text channel. Using the command on its own will clear **all** messages<br>
 **Requires**: `Manage Messages`
 
 > **~blacklist | ~bladd**
 
 Allows the user to choose words to ban on the server with a dropdown menu.<br>
 **Requires**: `Manage Messages`
 
+❗ Optionally, you can type words after the command if you'd prefer not to use the dropdown.
+
 > **~clearblacklist | ~blclear**
 
 Clears the blacklist for the server.<br>
@@ -69,12 +74,12 @@ Shows the blacklist for the server.<br>
 
 ⚠️ Other users will be able to see the words on the list. Only use this in an admin/mod-only channel.
 
-> **~blacklistremove | ~blrem `word a` `word b` `word c` `...`**
+> **~blacklistremove | ~blrem `...words?`**
 
-Removes one or more words from the server's blacklist.<br>
+Allows the user to choose words to remove from the blacklist with a dropdown menu.<br>
 **Requires**: `Manage Messages`
 
-❗ We're currently working on updating this command to use a drop-down in the same way `~blacklist` does.<br>
+❗ Optionally, you can type words after the command if you'd prefer not to use the dropdown.
 
 > **~kick `member` `reason?`**
 
@@ -161,7 +166,7 @@ Deletes all reaction role messages for a particular role.<br>
 
 ❓ Currently, we're testing out **[slash commands](https://support.discord.com/hc/en-us/articles/1500000368501-Slash-Commands-FAQ)** for this category.
 
-> **~choose `option a` `option b` `option c?` `...`** or **/choose `option a` `option b` `option c?` `...`**
+> **~choose `...options`** or **/choose `...options`**
 
 Randomly chooses an option from a list. Use quote marks "" around the options if they are longer than one word.
 

cogs/admin/admin_cog.py

@@ -6,7 +6,7 @@
 
 import discord
 from discord.ext import commands
-from utils.buttons import BlacklistClearButton, ClearMessagesView, DropdownView
+from utils.buttons import BlacklistClearButton, BlacklistRemoveView, ClearMessagesView, DropdownView
 from utils.functions import lift_ban, sanction
 
 FILEPATH = "files/blacklist.json"
@@ -107,7 +107,7 @@ async def unban(self, ctx: commands.Context, user: discord.User):
     @commands.command(aliases=["bladd"])
     @commands.has_permissions(manage_messages=True)
     @commands.cooldown(1, 2, commands.BucketType.user)
-    async def blacklist(self, ctx: commands.Context, *, words: str = None):
+    async def blacklist(self, ctx: commands.Context, *, words: str=None):
         """
         ⚙️ Bans words from being used.
 
@@ -123,6 +123,7 @@ async def blacklist(self, ctx: commands.Context, *, words: str = None):
             )
             view.message = await ctx.send(embed=embed, view=view)
             return
+
         id = str(ctx.guild.id)
         words = [word.lower() for word in words.split(" ")]
 
@@ -212,7 +213,7 @@ async def showblacklist(self, ctx: commands.Context):
 
     @commands.command(aliases=["blrem"])
     @commands.has_permissions(manage_messages=True)
-    async def blacklistremove(self, ctx: commands.Context, *, words: str):
+    async def blacklistremove(self, ctx: commands.Context, *, words: str=None):
         """
         ⚙️ Removes a word from the list of banned words.
 
@@ -221,6 +222,15 @@ async def blacklistremove(self, ctx: commands.Context, *, words: str):
         ~blacklistremove | ~blrem <...words>
         ```
         """
+        if not words:
+            view = BlacklistRemoveView(ctx)
+            embed = discord.Embed(
+                title="🛠️ Please enter one or more words to remove from the blacklist."
+            )
+
+            view.message = await ctx.send(embed=embed, view=view)
+            return
+
         id = str(ctx.guild.id)
         words = {word.lower() for word in words.split(" ")}
 

files/blacklist.json

@@ -1,9 +1,6 @@
 {
     "953054451999072276": [
-        "prick",
-        "poop",
-        "cunt",
-        "retard",
-        "asshole"
+        "asshole",
+        "arse"
     ]
 }

handlers/event_handler.py

@@ -71,11 +71,14 @@ async def on_member_remove(self, member: discord.Member):
         if channel is not None:
             await channel.send(f"👋🏻 Goodbye, **{member.name}**.")
 
-    @commands.Cog.listener()
+    @commands.Cog.listener() # This throws an AttributeError but it isn't really an issue
     async def on_message(self, message: discord.Message):
         """
         Called when a message is sent.
         """
+        if not message.guild:
+            return
+
         blacklist = self.client.cache.blacklist
 
         if (

utils/buttons.py

@@ -1,6 +1,7 @@
-from typing import Optional
-
+import black
 import discord
+
+from typing import Optional
 from discord.ext import commands
 
 FILEPATH = "files/blacklist.json"
@@ -130,7 +131,7 @@ def __init__(
         view: discord.ui.View,
         drop: discord.ui.Select,
         *,
-        title: str = "🔑 Enter a word to blacklist:",
+        title: str = "🔒 Add a Word to the Blacklist",
     ) -> None:
         super().__init__(title=title)
         self.view = view
@@ -234,7 +235,7 @@ async def send_modal(
     )
     async def submit(self, interaction: discord.Interaction, button: discord.Button):
         await interaction.response.defer()
-        values = self.drop.words
+        values = [value.lower() for value in self.drop.words]
         id = str(interaction.guild_id)
         if not values:
             print(values)
@@ -267,3 +268,179 @@ async def abort(self, interaction: discord.Interaction, button: discord.Button):
             f"❌ {interaction.user.mention}: Aborting command!", ephemeral=True
         )
         await self.disable_all_buttons(interaction)
+
+
+class BlacklistRemoveModal(discord.ui.Modal):
+    def __init__(
+        self,
+        view: discord.ui.View,
+        drop: discord.ui.Select,
+        *,
+        title: str="🔒 Remove a Word From the Blacklist"
+    ) -> None:
+        super().__init__(title=title)
+
+        self.view = view
+        self.drop = drop
+        self.text = discord.ui.TextInput(
+            label="Word", placeholder="🔑 Enter a word to remove from the blacklist:", max_length=100
+        )
+
+        self.add_item(self.text)
+
+    async def on_submit(self, interaction: discord.Interaction) -> None:
+        await interaction.response.defer()
+        text_value = self.text.value
+
+        if not text_value:
+            return
+
+        if self.drop.options[0].label == "\u200b":
+            self.drop.options.pop(0)
+
+        option = discord.SelectOption(label=text_value, default=True)
+
+        self.drop.append_option(option)
+        self.drop.max_values = len(self.drop.options)
+        self.drop.words.append(text_value)
+
+        await interaction.message.edit(view=self.view)
+        return await super().on_submit(interaction=interaction)
+
+
+class BlacklistRemoveDropdown(discord.ui.Select):
+    def __init__(self, ctx: commands.Context):
+        self.ctx = ctx
+
+        options = [discord.SelectOption(label="\u200b", default=False)]
+        self.words = []
+
+        super().__init__(
+            placeholder="📃 Choose words to remove from the blacklist...",
+            min_values=1,
+            max_values=len(options),
+            options=options
+        )
+
+    async def interaction_check(self, interaction: discord.Interaction) -> bool:
+        """
+        Prevents users who weren't the command sender from using buttons.
+        """
+        if interaction.user.id == self.ctx.author.id:
+            return True
+        else:
+            await interaction.response.send_message(
+                f"❌ {interaction.user.mention}: This isn't your interaction!",
+                ephemeral=True,
+            )
+            return False
+
+    async def callback(self, interaction: discord.Interaction):
+        await interaction.response.defer()
+
+        if not self.values:
+            return await interaction.followup.send(
+                f"❌ {interaction.user.mention}: You need to select one or more than one words to remove from the blacklist!",
+                ephemeral=True,
+            )
+
+        self.words = self.values
+        return
+
+
+class BlacklistRemoveView(discord.ui.View):
+    def __init__(self, ctx: commands.Context, *, timeout: Optional[float] = 180):
+        super().__init__()
+        self.ctx = ctx
+        self.drop = BlacklistRemoveDropdown(ctx)
+        self.add_item(self.drop)
+
+    async def interaction_check(self, interaction: discord.Interaction) -> bool:
+        """
+        Prevents users who weren't the command sender from using buttons.
+        """
+        if interaction.user.id == self.ctx.author.id:
+            return True
+        else:
+            await interaction.response.send_message(
+                f"❌ {interaction.user.mention}: This isn't your interaction!",
+                ephemeral=True,
+            )
+            return False
+
+    async def disable_all_buttons(self, interaction: discord.Interaction = None):
+        """
+        Disables all buttons.
+        """
+        interaction = interaction or self
+        self.drop.disabled = True
+        for child in self.children:
+            child.disabled = True
+        await interaction.message.edit(view=self)
+        self.stop()
+
+    @discord.ui.button(
+        label="Enter a New Word", style=discord.ButtonStyle.blurple, emoji="💬"
+    )
+    async def send_modal(
+        self, interaction: discord.Interaction, button: discord.Button
+    ):
+        modal = BlacklistRemoveModal(self, self.drop)
+        await interaction.response.send_modal(modal)
+
+    @discord.ui.button(
+        label="Submit Words", style=discord.ButtonStyle.green, emoji="👍🏻"
+    )
+    async def submit(self, interaction: discord.Interaction, button: discord.Button):
+        await interaction.response.defer()
+
+        values = [value.lower() for value in self.drop.words]
+        id = str(interaction.guild.id)
+
+        if not values:
+            print(values)
+
+            return await interaction.followup.send(
+                f"❌ {interaction.user.mention}: You need to have at least one word selected!",
+                ephemeral=True,
+            )
+
+        blacklist = interaction.client.cache.blacklist
+
+        if id not in blacklist.keys():
+            return await interaction.followup.send(
+                f"❌ {interaction.user.mention}: This server does not have any words blacklisted.",
+                ephemeral=True
+            )
+
+        print(values)
+        words = set(values) & set(blacklist[id])
+        print(values, words)
+
+        if not words:
+            return await interaction.followup.send(
+                f"❌ {interaction.user.mention}: Sorry. Those words are not in the blacklist.",
+                ephemeral=True,
+            )
+
+        for word in words:
+            blacklist[id].remove(word)
+
+        interaction.client.update_json(FILEPATH, blacklist)
+
+        embed = discord.Embed(
+            title=f"🛠️ Words successfully removed.",
+            description=" ".join(f"`{word}`" for word in words),
+        )
+
+        if len(values) > len(words):
+            embed.set_footer(text="⚠️ Some words were duplicates and were not added.")
+
+        await interaction.followup.send(embed=embed)
+
+    @discord.ui.button(label="Abort", style=discord.ButtonStyle.red, emoji="👎🏻")
+    async def abort(self, interaction: discord.Interaction, button: discord.Button):
+        await interaction.response.send_message(
+            f"❌ {interaction.user.mention}: Aborting command!", ephemeral=True
+        )
+        await self.disable_all_buttons(interaction)