De classes logger. Sets up framework to allow bot messages to be passed to logger (#1304)

* De classes logger. Sets up framework to allow bot messages to be passed to logger

* Formatting

* Formatting, security fixes

* Formatting

Author: ajax146

techsupport_bot/commands/echo.py

@@ -14,6 +14,7 @@
 
 from core import auxiliary, cogs
 from discord.ext import commands
+from functions import logger as function_logger
 
 if TYPE_CHECKING:
     import bot
@@ -72,10 +73,32 @@ async def echo_channel(
             )
             return
 
-        await channel.send(content=message)
+        sent_message = await channel.send(content=message)
 
         await auxiliary.send_confirm_embed(message="Message sent", channel=ctx.channel)
 
+        config = self.bot.guild_configs[str(channel.guild.id)]
+
+        # Don't allow logging if extension is disabled
+        if "logger" not in config.enabled_extensions:
+            return
+
+        target_logging_channel = await function_logger.pre_log_checks(
+            self.bot, config, channel
+        )
+        if not target_logging_channel:
+            return
+
+        await function_logger.send_message(
+            self.bot,
+            sent_message,
+            ctx.author,
+            channel,
+            target_logging_channel,
+            content_override=message,
+            special_flags=["Echo command"],
+        )
+
     @auxiliary.with_typing
     @echo.command(
         name="user",

techsupport_bot/commands/factoids.py

@@ -34,6 +34,7 @@
 from core import auxiliary, cogs, custom_errors, extensionconfig
 from discord import app_commands
 from discord.ext import commands
+from functions import logger as function_logger
 
 if TYPE_CHECKING:
     import bot
@@ -873,7 +874,9 @@ async def response(
 
         try:
             # define the message and send it
-            await ctx.reply(content=content, embed=embed, mention_author=not mentions)
+            sent_message = await ctx.reply(
+                content=content, embed=embed, mention_author=not mentions
+            )
             # log it in the logging channel with type info and generic content
             config = self.bot.guild_configs[str(ctx.guild.id)]
             log_channel = config.get("logging_channel")
@@ -898,12 +901,15 @@ async def response(
                 exception=exception,
             )
             # Sends the raw factoid instead of the embed as fallback
-            await ctx.reply(
+            sent_message = await ctx.reply(
                 f"{mentions+' ' if mentions else ''}{factoid.message}",
                 mention_author=not mentions,
             )
 
         await self.send_to_irc(ctx.channel, ctx.message, factoid.message)
+        await self.send_to_logger(
+            sent_message, ctx.author, ctx.channel, factoid.message
+        )
 
     async def send_to_irc(
         self: Self,
@@ -929,6 +935,44 @@ async def send_to_irc(
             factoid_message=factoid_message,
         )
 
+    async def send_to_logger(
+        self: Self,
+        factoid_message_object: discord.Message,
+        factoid_caller: discord.Member,
+        channel: discord.abc.GuildChannel | discord.Thread,
+        factoid_message: str,
+    ) -> None:
+        """Send a factoid call to the logger function
+
+        Args:
+            factoid_message_object (discord.Message): The message that the factoid is sent in
+            factoid_caller (discord.Member): The person who called the factoid
+            channel (discord.abc.GuildChannel | discord.Thread): The channel the
+                factoid was sent in
+            factoid_message (str): The plaintext message content of the factoid
+        """
+        config = self.bot.guild_configs[str(channel.guild.id)]
+
+        # Don't allow logging if extension is disabled
+        if "logger" not in config.enabled_extensions:
+            return
+
+        target_logging_channel = await function_logger.pre_log_checks(
+            self.bot, config, channel
+        )
+        if not target_logging_channel:
+            return
+
+        await function_logger.send_message(
+            self.bot,
+            factoid_message_object,
+            factoid_caller,
+            channel,
+            target_logging_channel,
+            content_override=factoid_message,
+            special_flags=["Factoid call"],
+        )
+
     @factoid_app_group.command(
         name="call",
         description="Calls a factoid from the database and sends it publicy in the channel.",
@@ -1054,6 +1098,11 @@ async def factoid_call_command(
             interaction.channel, interaction.message, factoid.message
         )
 
+        sent_message = await interaction.original_response()
+        await self.send_to_logger(
+            sent_message, interaction.user, interaction.channel, factoid.message
+        )
+
     # -- Factoid job related functions --
     async def kickoff_jobs(self: Self) -> None:
         """Gets a list of cron jobs and starts them"""
@@ -1230,6 +1279,7 @@ async def cronjob(
                 message = await channel.send(content=factoid.message)
 
             await self.send_to_irc(channel, message, factoid.message)
+            await self.send_to_logger(message, ctx.author, ctx.channel, factoid.message)
 
     @commands.group(
         brief="Executes a factoid command",

techsupport_bot/commands/relay.py

@@ -12,6 +12,7 @@
 from core import auxiliary, cogs
 from discord.ext import commands
 from functions import automod
+from functions import logger as function_logger
 
 if TYPE_CHECKING:
     import bot
@@ -447,7 +448,30 @@ async def send_message_from_irc(self: Self, split_message: dict[str, str]) -> No
 
         embed = self.generate_sent_message_embed(split_message=split_message)
 
-        await discord_channel.send(content=mentions_string, embed=embed)
+        sent_message = await discord_channel.send(content=mentions_string, embed=embed)
+
+        config = self.bot.guild_configs[str(discord_channel.guild.id)]
+        # Don't allow logging if extension is disabled
+        if "logger" not in config.enabled_extensions:
+            return
+        target_logging_channel = await function_logger.pre_log_checks(
+            self.bot, config, discord_channel
+        )
+        if not target_logging_channel:
+            return
+
+        irc_message_content = split_message["content"]
+        irc_message_hostmask = split_message["hostmask"]
+
+        await function_logger.send_message(
+            self.bot,
+            sent_message,
+            discord_channel.guild.me,
+            discord_channel,
+            target_logging_channel,
+            content_override=irc_message_content,
+            special_flags=[f"IRC Message from: {irc_message_hostmask}"],
+        )
 
     def get_mentions(
         self: Self, message: str, channel: discord.abc.Messageable

techsupport_bot/functions/__init__.py

@@ -1,4 +1,5 @@
 """Functions are commandless cogs"""
 
 from .automod import *
+from .logger import *
 from .nickname import *