Merge remote-tracking branch 'origin/leaderboard'

Author: SpectacleBot

src/tux/modules/features/logging.py

@@ -0,0 +1,152 @@
+"""
+Logging service for tracking message edits and deletions.
+
+This module implements a logging system that sends message delete and edit events
+to a designated private log channel, helping moderators track changes.
+"""
+
+import discord
+from discord.ext import commands
+
+from tux.core.base_cog import BaseCog
+from tux.core.bot import Tux
+from tux.ui.embeds import EmbedCreator, EmbedType
+
+
+class Logging(BaseCog):
+    """Discord cog for logging message events.
+
+    This cog monitors message deletions and edits and logs them to the
+    configured private log channel for the guild.
+    """
+
+    @commands.Cog.listener()
+    async def on_message_delete(self, message: discord.Message) -> None:
+        """Handle message delete events.
+
+        Parameters
+        ----------
+        message : discord.Message
+            The message that was deleted.
+        """
+        # Skip bots, DMs, and non-guild channels to ensure channel has .mention
+        if (
+            message.author.bot
+            or not message.guild
+            or not isinstance(message.channel, discord.abc.GuildChannel)
+        ):
+            return
+
+        # Skip if maintenance mode is enabled
+        if getattr(self.bot, "maintenance_mode", False):
+            return
+
+        private_log_id = await self.db.guild_config.get_private_log_id(message.guild.id)
+        if not private_log_id:
+            return
+
+        channel = message.guild.get_channel(private_log_id)
+        if not isinstance(channel, discord.TextChannel):
+            return
+
+        embed = EmbedCreator.create_embed(
+            embed_type=EmbedType.INFO,
+            title="Message Deleted",
+            description=(
+                f"**Author:** {message.author.mention} (`{message.author.id}`)\n"
+                f"**Channel:** {message.channel.mention} (`{message.channel.id}`)\n\n"
+                f"**Content:**\n{message.content or '*No content (attachment or embed only)*'}"
+            ),
+            custom_author_text=str(message.author),
+            custom_author_icon_url=message.author.display_avatar.url,
+            message_timestamp=discord.utils.utcnow(),
+        )
+
+        # Handle attachments
+        if message.attachments:
+            attachment_info = "\n".join(
+                [f"[{a.filename}]({a.url})" for a in message.attachments],
+            )
+            embed.add_field(name="Attachments", value=attachment_info, inline=False)
+
+        await channel.send(embed=embed)
+
+    @commands.Cog.listener()
+    async def on_message_edit(
+        self,
+        before: discord.Message,
+        after: discord.Message,
+    ) -> None:
+        """Handle message edit events.
+
+        Parameters
+        ----------
+        before : discord.Message
+            The message state before the edit.
+        after : discord.Message
+            The message state after the edit.
+        """
+        # Skip bots, DMs, and non-guild channels to ensure channel has .mention
+        if (
+            before.author.bot
+            or not before.guild
+            or not isinstance(before.channel, discord.abc.GuildChannel)
+        ):
+            return
+
+        # Skip if content didn't change (e.g. only embeds/pins changed)
+        if before.content == after.content:
+            return
+
+        # Skip if maintenance mode is enabled
+        if getattr(self.bot, "maintenance_mode", False):
+            return
+
+        private_log_id = await self.db.guild_config.get_private_log_id(before.guild.id)
+        if not private_log_id:
+            return
+
+        channel = before.guild.get_channel(private_log_id)
+        if not isinstance(channel, discord.TextChannel):
+            return
+
+        embed = EmbedCreator.create_embed(
+            embed_type=EmbedType.INFO,
+            title="Message Edited",
+            description=(
+                f"**Author:** {before.author.mention} (`{before.author.id}`)\n"
+                f"**Channel:** {before.channel.mention} (`{before.channel.id}`)\n"
+                f"**Jump:** [Click here to jump]({after.jump_url})"
+            ),
+            custom_author_text=str(before.author),
+            custom_author_icon_url=before.author.display_avatar.url,
+            message_timestamp=discord.utils.utcnow(),
+        )
+
+        # Truncate content to fit in embed fields (max 1024 chars)
+        def truncate(text: str) -> str:
+            return (text[:1021] + "...") if len(text) > 1024 else text
+
+        embed.add_field(
+            name="Before",
+            value=truncate(before.content or "*No content*"),
+            inline=False,
+        )
+        embed.add_field(
+            name="After",
+            value=truncate(after.content or "*No content*"),
+            inline=False,
+        )
+
+        await channel.send(embed=embed)
+
+
+async def setup(bot: Tux) -> None:
+    """Set up the Logging cog.
+
+    Parameters
+    ----------
+    bot : Tux
+        The bot instance.
+    """
+    await bot.add_cog(Logging(bot))

src/tux/plugins/spectacle/__init__.py

@@ -0,0 +1,5 @@
+"""Custom plugins package for user-defined extensions.
+
+This package is intended for custom modules created by self-hosters.
+Modules placed here will be automatically discovered and loaded by the bot.
+"""

src/tux/plugins/spectacle/leaderboard.py

@@ -0,0 +1,64 @@
+"""Spectacle Studios Discord Servers - XP Leaderboard Plugin."""
+
+import discord
+from discord import app_commands
+from discord.ext import commands
+
+from tux.core.base_cog import BaseCog
+from tux.core.bot import Tux
+from tux.modules.features.levels import LevelsService
+from tux.ui.embeds import EmbedCreator, EmbedType
+
+
+class Leaderboard(BaseCog):
+    """Manage and expose the XP leaderboard functionality.
+
+    This cog provides commands that allow users to view XP rankings and related
+    leaderboard information within the Discord server.
+    """
+
+    def __init__(self, bot: Tux) -> None:
+        super().__init__(bot)
+
+        self.levels_service = LevelsService(bot)
+
+    @commands.command(name="leaderboard", aliases=["lb", "top"])
+    @app_commands.guild_only()
+    async def leaderboard(self, ctx: commands.Context[Tux]) -> None:
+        """Show the XP leaderboard for the current Discord server.
+
+        This command responds with a placeholder message until the leaderboard
+        functionality is fully implemented.
+        """
+        await ctx.defer()
+
+        top_members = await self.levels_service.db.levels.get_top_members(0, 10)
+        embed = EmbedCreator.create_embed(
+            embed_type=EmbedType.INFO,
+            title="XP Leaderboard",
+            message_timestamp=discord.utils.utcnow(),
+        )
+        for member in top_members:
+            try:
+                user = await self.bot.fetch_user(member.member_id)
+                embed.add_field(
+                    name=f"{user.name}",
+                    value=f"{int(member.xp):,d}",
+                    inline=False,
+                )
+            except discord.NotFound:
+                embed.add_field(
+                    name="Unknown user",
+                    value=f"{int(member.xp):,d}",
+                    inline=False,
+                )
+
+        await ctx.send(embed=embed)
+
+
+async def setup(bot: Tux) -> None:
+    """Register the leaderboard cog with the bot.
+
+    This function initializes the leaderboard plugin and adds it to the running bot instance.
+    """
+    await bot.add_cog(Leaderboard(bot))