Reopening this PR for merging TwitchCog into develop

.env

@@ -0,0 +1 @@
+secrets.env

.gitignore

@@ -1,6 +1,6 @@
-*.env
 **/__pycache__
 test-file.py
 /src/cogs/TestCog.py
 .vscode
-.idea
+.idea
+secrets.env

README.md

@@ -224,28 +224,52 @@ In your `.env` file the `TWITCH_SUB_SECRET` should be a string that is 10-100 ch
 The `TWITCH_CALLBACK` is the URL to your HTTPS server. For testing you can use `ngrok`: 
 - Run `ngrok http 443` and copy the `https` URL **not** the `htttp` URL and use that as your `TWITCH_CALLBACK` variable.
 
-#### !twitch createhook [optional: channel_mention] [optional: hook name]  
-* Creates a Discord Webhook bound to the channel the command was executed in, unless a channel is given, and with a default name unless a name is given.  
+#### !twitch createhook \<channel mention> \<hook name>
+* Aliases: `newhook, makehook, addhook`
+* Creates a new Discord Webhook bound to the mentioned channel. 
+  The name will be prefixed with the Twitch Cog Webhook prefix to distinguish Twitch hooks from other Webhooks.
+  The Webhooks created with the Twitch Cog do not need the prefix used in the name in order to reference them.
+* *Requires `administrator` permission in Discord*
 
 #### !twitch deletehook \<hook name>  
 * Deletes the given Discord Webhook.  
+* *Requires `administrator` permission in Discord*
 
-#### !twitch add \<twitch handle | twitch url> [optional: custom message]  
-* Adds a Twitch channel to be tracked in the current Discord server.  
-* *__If a custom message is given, it must be surrounded by double quotes__*: `!twitch add <twitch_handle> "custom_message"`  
+#### !twitch add \<twitch handle | twitch url> \<webhook name> [optional: custom message]  
+* Adds a Twitch channel to be tracked in the given Webhook.
+  This means when the channel goes live, its notification will be posted to the given Webhook.
+  A channel can be tied to more than one Webhook.
+  The custom message can be left empty, but when not, it will be used in the live notification.
+  A preview of what a notification looks like can be seen with the `!twitch preview <twitch handle> <webhook name>` command.
+* *__If a custom message is given, it must be surrounded by double quotes__*: `!twitch add <twitch_handle> <webhook name> "custom_message"`  
+* *Requires `administrator` permission in Discord*
 
-#### !twitch remove \<twitch handle>  
-* Removes a Twitch channel from being tracked in the current Discord server.  
+#### !twitch remove \<twitch handle>  \<webhook name>
+* Removes a Twitch channel from being tracked in the given Webhook.
+* *Requires `administrator` permission in Discord*
 
-#### !twitch list  
-* Shows a list of all the currently tracked Twitch accounts and their custom messages.  
+#### !twitch list [optional: webhook name] 
+* Shows a list of all the currently tracked Twitch accounts and their custom messages for the given Webhook.
+If no Webhook name is given, it shows the information for all Twitch Webhooks.
+* *Requires `administrator` permission in Discord*
 
-#### !twitch setmessage \<twitch handle> [optional: custom message]  
-* Sets the custom message of a Twitch channel. Can be left empty if the custom message is to be removed.  
-* *__If a custom message is given, it must be surrounded by double quotes__*: `!twitch setmessage <twitch_handle> "custom_message"`  
+#### !twitch webhooks
+* Shows a list of the current Webhooks for the Twitch Cog.
+* *Requires `administrator` permission in Discord*
+
+#### !twitch setmessage \<twitch handle> \<webhook name> [optional: custom message]  
+* Sets the custom message of a Twitch channel for the given Webhook. 
+  Can be left empty if the custom message is to be removed. 
+* *__If a custom message is given, it must be surrounded by double quotes__*: `!twitch setmessage <twitch_handle> <webhook name> "custom_message"` 
+* *Requires `administrator` permission in Discord*
 
-#### !twitch getmessage \<twitch handle>  
-* Gets the currently set custom message for a Twitch channel.  
+#### !twitch getmessage \<twitch handle>  [optional: webhook name]
+* Gets the currently set custom message for a Twitch channel for the given Webhook.
+If no Webhook name is given, it shows a list of all the custom messages for the Webhooks the channel is tracked in.
+* *Requires `administrator` permission in Discord*
+
+#### !twitch preview \<twitch handle> \<webhook name>
+* Shows a preview of the live notification for a given channel for the given Webhook.
 
 </details>  
 

docker-compose.yml

@@ -3,7 +3,9 @@ version: "3"
 services:
   db:
     environment:
-      - POSTGRES_PASSWORD=Pass2020!
+      - POSTGRES_USER=${PG_USER}
+      - POSTGRES_PASSWORD=${PG_PWD}
+      - POSTGRES_DB=${PG_DATABASE}
     image: "postgres:11"
     restart: unless-stopped
     volumes:
@@ -16,12 +18,9 @@ services:
     env_file: secrets.env
     environment:
       - PG_HOST=db
-      - PG_DATABASE=esportsbot
-      - PG_USER=postgres
-      - PG_PWD=Pass2020!
-      - ENABLE_TWITTER=False
-      - ENABLE_TWITCH=False
     restart: unless-stopped
+    ports:
+      - 443:443
 
   pg_admin:
     depends_on:

src/esportsbot/base_functions.py

@@ -2,12 +2,6 @@
 from esportsbot.models import Voicemaster_master, Voicemaster_slave, Guild_info
 
 
-async def send_to_log_channel(self, guild_id, msg):
-    db_logging_call = DBGatewayActions().get(Guild_info, guild_id=guild_id)
-    if db_logging_call.log_channel_id:
-        await self.bot.get_channel(db_logging_call.log_channel_id).send(msg)
-
-
 def role_id_from_mention(pre_clean_data: str) -> int:
     """Extracts the ID of a role from a role mention.
     Will also accept strings containing a role ID, and will reject invalid integers with a ValueError.

src/esportsbot/cogs/AdminCog.py

@@ -1,7 +1,7 @@
-from discord.ext import commands
-from esportsbot.base_functions import send_to_log_channel
 import os
 
+from discord.ext import commands
+
 devs = os.getenv("DEV_IDS").replace(" ", "").split(",")
 
 
@@ -29,11 +29,13 @@ def is_dev(ctx):
     @commands.has_permissions(manage_messages=True)
     async def clear_messages(self, ctx, amount=5):
         await ctx.channel.purge(limit=int(amount) + 1)
-        await send_to_log_channel(
-            self,
-            ctx.author.guild.id,
-            self.STRINGS['channel_cleared'].format(author_mention=ctx.author.mention,
-                                                   message_amount=amount)
+        await self.bot.adminLog(
+            ctx.message,
+            {
+                "Cog": str(type(self)),
+                "Message": self.STRINGS['channel_cleared'].format(author_mention=ctx.author.mention,
+                                                                  message_amount=amount)
+            }
         )
 
     @commands.command(

src/esportsbot/cogs/DefaultRoleCog.py

@@ -1,7 +1,7 @@
 from discord.ext import commands
+from esportsbot.base_functions import role_id_from_mention
 from esportsbot.db_gateway import DBGatewayActions
 from esportsbot.models import Guild_info
-from esportsbot.base_functions import role_id_from_mention, send_to_log_channel
 
 
 class DefaultRoleCog(commands.Cog):
@@ -18,13 +18,23 @@ async def on_member_join(self, member):
         if guild.default_role_id:
             default_role = member.guild.get_role(guild.default_role_id)
             await member.add_roles(default_role)
-            await send_to_log_channel(
-                self,
-                member.guild.id,
-                f"{member.mention} has joined the server and received the {default_role.mention} role"
+            await self.bot.adminLog(
+                None,
+                {
+                    "Cog": str(type(self)),
+                    "Message": f"{member.mention} has joined the server and received the {default_role.mention} role"
+                },
+                guildID=member.guild.id
             )
         else:
-            await send_to_log_channel(self, member.guild.id, f"{member.mention} has joined the server")
+            await self.bot.adminLog(
+                None,
+                {
+                    "Cog": str(type(self)),
+                    "Message": f"{member.mention} has joined the server"
+                },
+                guildID=member.guild.id
+            )
 
     @commands.command(
         name="setdefaultrole",
@@ -46,11 +56,15 @@ async def setdefaultrole(self, ctx, given_role_id):
 
             await ctx.channel.send(self.STRINGS['default_role_set'].format(role_id=cleaned_role_id))
             default_role = ctx.author.guild.get_role(cleaned_role_id)
-            await send_to_log_channel(
-                self,
-                ctx.author.guild.id,
-                self.STRINGS['default_role_set_log'].format(author=ctx.author.mention,
-                                                            role_mention=default_role.mention)
+            await self.bot.adminLog(
+                ctx.message,
+                {
+                    "Cog":
+                    str(type(self)),
+                    "Message":
+                    self.STRINGS['default_role_set_log'].format(author=ctx.author.mention,
+                                                                role_mention=default_role.mention)
+                }
             )
         else:
             await ctx.channel.send(self.STRINGS['default_role_set_missing_params'])
@@ -88,10 +102,12 @@ async def removedefaultrole(self, ctx):
             guild.default_role_id = None
             DBGatewayActions().update(guild)
             await ctx.channel.send(self.STRINGS['default_role_removed'])
-            await send_to_log_channel(
-                self,
-                ctx.author.guild.id,
-                self.STRINGS['default_role_removed_log'].format(author_mention=ctx.author.mention)
+            await self.bot.adminLog(
+                ctx.message,
+                {
+                    "Cog": str(type(self)),
+                    "Message": self.STRINGS['default_role_removed_log'].format(author_mention=ctx.author.mention)
+                }
             )
         else:
             await ctx.channel.send(self.STRINGS['default_role_missing'])

src/esportsbot/cogs/LogChannelCog.py

@@ -1,7 +1,7 @@
 from discord.ext import commands
+from esportsbot.base_functions import channel_id_from_mention
 from esportsbot.db_gateway import DBGatewayActions
 from esportsbot.models import Guild_info
-from esportsbot.base_functions import channel_id_from_mention, send_to_log_channel
 
 
 class LogChannelCog(commands.Cog):
@@ -22,10 +22,12 @@ async def setlogchannel(self, ctx, given_channel_id=None):
             db_item = Guild_info(guild_id=ctx.guild.id, log_channel_id=cleaned_channel_id)
             DBGatewayActions().create(db_item)
             await ctx.channel.send(self.STRINGS["channel_set"].format(channel_id=cleaned_channel_id))
-            await send_to_log_channel(
-                self,
-                ctx.author.guild.id,
-                self.STRINGS["channel_set_notify_in_channel"].format(author_mention=ctx.author.mention),
+            await self.bot.adminLog(
+                ctx.message,
+                {
+                    "Cog": str(type(self)),
+                    "Message": self.STRINGS["channel_set_notify_in_channel"].format(author_mention=ctx.author.mention)
+                }
             )
             return
 
@@ -37,10 +39,12 @@ async def setlogchannel(self, ctx, given_channel_id=None):
         guild.log_channel_id = cleaned_channel_id
         DBGatewayActions().update(guild)
         await ctx.channel.send(self.STRINGS["channel_set"].format(channel_id=cleaned_channel_id))
-        await send_to_log_channel(
-            self,
-            ctx.author.guild.id,
-            self.STRINGS["channel_set_notify_in_channel"].format(author_mention=ctx.author.mention),
+        await self.bot.adminLog(
+            ctx.message,
+            {
+                "Cog": str(type(self)),
+                "Message": self.STRINGS["channel_set_notify_in_channel"].format(author_mention=ctx.author.mention)
+            }
         )
 
     @commands.command(name="getlogchannel", usage="", help="Gets the server logging channel for bot actions")