Adding new modmail system within the guild

cogs/modmail/modmail.py

@@ -0,0 +1,319 @@
+# Method to ask the user if they want to be anonymous or not
+import asyncio
+import datetime
+import random
+
+import discord
+from discord import Embed
+from discord.ext import commands
+
+import db
+from settings import enso_embedmod_colours, blank_space, hammyMention
+
+
+def AnonOrNot(author):
+    # Set up embed to let the user how to start sending modmail
+    AnonModMailEmbed = Embed(title="**Want to send it Anonymously?**",
+                             colour=enso_embedmod_colours,
+                             timestamp=datetime.datetime.utcnow())
+
+    AnonModMailEmbed.set_thumbnail(url=author.avatar_url)
+    AnonModMailEmbed.set_footer(text=f"Sent by {author}")
+
+    fields = [(blank_space, "**We understand that for some things, you may want to remain Anonymous."
+                            "\nFeel free to use the reactions below to choose!**", False),
+              (blank_space, "**Use :white_check_mark: for** `Yes`", True),
+              (blank_space, "**Use :x: for** `No`", True),
+              (blank_space, blank_space, True),
+              (blank_space,
+               "This will make sure that Staff do not know who is sending the mail."
+               "\nAgain, purely negative feedback will not be considered.", True)]
+
+    for name, value, inline in fields:
+        AnonModMailEmbed.add_field(name=name, value=value, inline=inline)
+
+    return AnonModMailEmbed
+
+
+# Method to send an embed to to let the user know to type into chat
+def SendInstructions(author):
+    # Set up embed to let the user know that they have aborted the modmail
+    SendModMailEmbed = Embed(title="**Please enter a message for it to be sent to the staff!**",
+                             colour=enso_embedmod_colours,
+                             timestamp=datetime.datetime.utcnow())
+
+    SendModMailEmbed.set_thumbnail(url=author.avatar_url)
+    SendModMailEmbed.set_footer(text=f"Sent by {author}")
+
+    fields = [("**Make sure that the message is above 50 characters!**",
+               "**Include as much detail as possible :P**",
+               False)]
+
+    for name, value, inline in fields:
+        SendModMailEmbed.add_field(name=name, value=value, inline=inline)
+
+    return SendModMailEmbed
+
+
+# Method to let the user know that the message must be above 50 characters
+def ErrorHandling(author):
+    # Set up embed to let the user know that the message must be above 50 characters
+    ErrorHandlingEmbed = Embed(title="**Uh Oh! Please make sure the message is above 50 characters!**",
+                               colour=enso_embedmod_colours,
+                               timestamp=datetime.datetime.utcnow())
+
+    ErrorHandlingEmbed.set_thumbnail(url=author.avatar_url)
+    ErrorHandlingEmbed.set_footer(text=f"Sent by {author}")
+
+    fields = [("Please enter in a message which is above 50 characters!",
+               "**This helps us reduce spam and allows you to include more detail in your mail!**",
+               False)]
+
+    for name, value, inline in fields:
+        ErrorHandlingEmbed.add_field(name=name, value=value, inline=inline)
+
+    return ErrorHandlingEmbed
+
+
+# Method to send an embed into chat to let the user know that their mail has been sent successfully
+def MessageSentConfirmation(author):
+    # Set up embed to let the user know that they have sent the mail
+    ConfirmationEmbed = Embed(title="**Message relayed to Staff!!**",
+                              colour=enso_embedmod_colours,
+                              timestamp=datetime.datetime.utcnow())
+
+    ConfirmationEmbed.set_thumbnail(url=author.avatar_url)
+    ConfirmationEmbed.set_footer(text=f"Sent by {author}")
+
+    fields = [("Thank you for your input! The staff team appreciate it very much!",
+               f"\n As mentioned previously, please don't be hesistant to DM {hammyMention} for anything! :P",
+               False)]
+
+    for name, value, inline in fields:
+        ConfirmationEmbed.add_field(name=name, value=value, inline=inline)
+
+    return ConfirmationEmbed
+
+
+# Method to actually allow the message to be sent to #mod-mail
+def SendMsgToModMail(self, msg, author):
+    if self.anon:
+
+        avatars = ["https://cdn.discordapp.com/embed/avatars/0.png",
+                   "https://cdn.discordapp.com/embed/avatars/1.png",
+                   "https://cdn.discordapp.com/embed/avatars/2.png",
+                   "https://cdn.discordapp.com/embed/avatars/3.png",
+                   "https://cdn.discordapp.com/embed/avatars/4.png"]
+
+        embed = Embed(title="Modmail",
+                      colour=enso_embedmod_colours,
+                      timestamp=datetime.datetime.utcnow())
+
+        embed.set_thumbnail(url=random.choice(avatars))
+        embed.set_footer(text=f"Sent By Anon Member")
+
+        fields = [("Member", "Anon Member", False),
+                  ("Message", msg.content, False)]
+
+        for name, value, inline in fields:
+            embed.add_field(name=name, value=value, inline=inline)
+
+        return embed
+
+    else:
+        embed = Embed(title="Modmail",
+                      colour=enso_embedmod_colours,
+                      timestamp=datetime.datetime.utcnow())
+
+        embed.set_thumbnail(url=author.avatar_url)
+        embed.set_footer(text=f"Sent By {author}")
+
+        fields = [("Member", author, False),
+                  ("Message", msg.content, False)]
+
+        for name, value, inline in fields:
+            embed.add_field(name=name, value=value, inline=inline)
+
+        return embed
+
+
+# Set up the Cog
+class Modmail(commands.Cog):
+    def __init__(self, bot):
+        self.bot = bot
+        self.anon = None
+
+    # Setting up Listener to listen for reactions within the modmail channel created
+    @commands.Cog.listener()
+    async def on_raw_reaction_add(self, payload):
+        self.anon = None
+
+        # A check that makes sure that the reaction is done by the bot
+        def check(m):
+            return m == self.bot.user
+
+        # If the member is not a user, do nothing
+        if not check:
+            return
+        else:
+            # Find a role corresponding to the Emoji name.
+            guildid = payload.guild_id
+
+            # Use database connection
+            with db.connection() as conn:
+
+                # Get the author's row from the Members Table
+                select_query = """SELECT * FROM moderatormail WHERE guildID = (?)"""
+                val = guildid,
+                cursor = conn.cursor()
+
+                # Execute the SQL Query
+                cursor.execute(select_query, val)
+                result = cursor.fetchone()
+
+                guild_id = int(result[0])
+                channel_id = int(result[1])
+                message_id = int(result[2])
+                modmail_channel_id = int(result[3])
+
+            if payload.guild_id == guild_id:
+                if payload.channel_id == channel_id:
+                    if payload.message_id == message_id:
+                        if payload.emoji.name == "✅":
+                            # Get the guild
+                            guild = self.bot.get_guild(payload.guild_id)
+                            # Get the member
+                            member = guild.get_member(payload.user_id)
+                            # Get the setup modmail channel
+                            channel = guild.get_channel(payload.channel_id)
+                            # Get the modmail logging channel
+                            modmail_channel = guild.get_channel(modmail_channel_id)
+
+                            # Fetch the message and remove the reaction
+                            reaction = await channel.fetch_message(message_id)
+                            await reaction.remove_reaction('✅', member)
+
+                            # Setting up the channel permissions for the new channel that will be created
+                            overwrites = {
+                                guild.default_role: discord.PermissionOverwrite(read_messages=False),
+                                guild.me: discord.PermissionOverwrite(read_messages=True),
+                                member: discord.PermissionOverwrite(read_messages=True, send_messages=True)
+                            }
+
+                            # Saving this for later within when discord.py 1.4 comes out
+                            # cat = await guild.create_category_channel(member.name, overwrites=overwrites)
+
+                            # Create the text channel
+                            user_channel = await guild.create_text_channel(member.name, overwrites=overwrites,
+                                                                           position=0)
+
+                            # Mention the user to make sure that they get pinged
+                            mention = await user_channel.send(member.mention)
+                            await mention.delete()
+
+                            # Send the embed if they want to remain anonymous or not
+                            Anon_or_Not = await user_channel.send(embed=AnonOrNot(member))
+                            # Add reactions to the message
+                            await Anon_or_Not.add_reaction('✅')
+                            await Anon_or_Not.add_reaction('❌')
+
+                            # Checking if the user reacted with ✅ with response to sending staff a message
+                            def emoji_check(reaction, user):
+                                return user == member and str(reaction.emoji) in ['✅', '❌']
+
+                            # Surround with try/except to catch any exceptions that may occur
+                            try:
+                                # Wait for the user to add a reaction
+                                reaction, user = await self.bot.wait_for('reaction_add', timeout=120.0,
+                                                                         check=emoji_check)
+                            except Exception as ex:
+                                print(ex)
+                                return
+                            else:
+                                if str(reaction.emoji) == "✅":
+                                    self.anon = True
+
+                                    # Delete the old embed
+                                    await Anon_or_Not.delete()
+
+                                    # Tell the user to type their mail into the chat
+                                    instructions = await user_channel.send(embed=SendInstructions(member))
+
+                                    # Making sure that the reply is from the author
+                                    def check(m):
+                                        return m.author == payload.member and user_channel.id == instructions.channel.id
+
+                                    # Wait for the message from the author
+                                    msg = await self.bot.wait_for('message', check=check, timeout=300)
+
+                                    # Making sure that the message is below 50 characters and the message was sent in the channel
+                                    while len(msg.content) < 50 and msg.channel == user_channel:
+                                        await user_channel.send(embed=ErrorHandling(member))
+
+                                        # Wait for the message from the author
+                                        msg = await self.bot.wait_for('message', check=check, timeout=300)
+
+                                    if len(msg.content) > 50 and msg.channel == user_channel:
+                                        # Delete the previous embed
+                                        await instructions.delete()
+                                        # Send the message to the modmail channel
+                                        await modmail_channel.send(embed=SendMsgToModMail(self, msg, member))
+
+                                        # Make sure the user knows that their message has been sent
+                                        await user_channel.send(embed=MessageSentConfirmation(member))
+
+                                        # Let the user read the message for 5 seconds
+                                        await asyncio.sleep(5)
+                                
+                                        await user_channel.delete()
+                                        # Log the message within the database
+                                        # logModMail(ctx, self.anon, msg)
+                                    else:
+                                        await user_channel.delete()
+
+                                if str(reaction.emoji) == "❌":
+                                    self.anon = False
+
+                                    # Delete the old embed
+                                    await Anon_or_Not.delete()
+
+                                    # Tell the user to type their mail into the chat
+                                    instructions = await user_channel.send(embed=SendInstructions(member))
+
+                                    # Making sure that the reply is from the author
+                                    def check(m):
+                                        return m.author == payload.member and user_channel.id == instructions.channel.id
+
+                                    # Wait for the message from the author
+                                    msg = await self.bot.wait_for('message', check=check, timeout=300)
+
+                                    # Making sure that the message is below 50 characters and the message was sent in the channel
+                                    while len(msg.content) < 50 and msg.channel == user_channel:
+                                        await user_channel.send(embed=ErrorHandling(member))
+
+                                        # Wait for the message from the author again
+                                        msg = await self.bot.wait_for('message', check=check, timeout=300)
+
+                                    if len(msg.content) > 50 and msg.channel == user_channel:
+                                        # Delete the previous embed
+                                        await instructions.delete()
+                                        # Send the message to the modmail channel
+                                        await modmail_channel.send(embed=SendMsgToModMail(self, msg, member))
+
+                                        # Make sure the user knows that their message has been sent
+                                        await user_channel.send(embed=MessageSentConfirmation(member))
+
+                                        # Let the user read the message for 5 seconds
+                                        await asyncio.sleep(5)
+
+                                        await user_channel.delete()
+
+                                    else:
+                                        await user_channel.delete()
+
+                                    # Log the message within the database
+                                    # logModMail(ctx, self.anon, msg)
+
+
+def setup(bot):
+    bot.add_cog(Modmail(bot))