Update backup/info.json

.docs/backup.md

@@ -10,6 +10,14 @@ Backup allows you to export a JSON list of all of your installed repositories an
 [p]cog load backup
 ```
 
+## Version Compatibility
+
+As of commit [1edb08a](https://www.coastalcommits.com/SeaswimmerTheFsh/SeaCogs/commit/1edb08a1271f12098ca0bed11a735f7162cedd14), the Backup cog no longer supports Red versions older than 3.5.6. If you want to use the cog on an earlier version (3.5.0 - 3.5.5), install the cog pinned to this commit: `43464db6a7c51bc69282b1ae3dc507a4aae851de`.
+
+```bash
+[p]cog installversion sea-cogs 43464db6a7c51bc69282b1ae3dc507a4aae851de backup
+```
+
 ## Commands
 
 ### backup export

.docs/pterodactyl/configuration.md

@@ -39,7 +39,9 @@ Default value:
 tellraw @a ["",{"text":".$N ","color":".$C","insertion":"<@.$I>","hoverEvent":{"action":"show_text","contents":"Shift click to mention this user inside Discord"}},{"text":"(DISCORD):","color":"blue","clickEvent":{"action":"open_url","value":".$V"},"hoverEvent":{"action":"show_text","contents":"Click to join the Discord Server"}},{"text":" .$M","color":"white"}]
 ```
 
-## `consolechannel`
+## `console`
+
+### `channel`
 
 /// admonition | Only give access to the console channel to people you trust!
     type: danger
@@ -63,6 +65,21 @@ This is to prevent the console channel from flooding and getting backed up by Di
 
 Default value: `None`
 
+### `commands`
+
+/// admonition | This has no effect on the `[p]pterodactyl command` text command, or the matching slash command.
+    type: danger
+If you want to disable the ability to execute commands on the server through Discord, use the following commands:
+`[p]pterodactyl config console commands False` - this command
+`[p]command disable pterodactyl command` - disables the text command that lets you execute commands on the server
+`[p]slash disable pterodactyl` - due to how slash commands are laid out, this is the only way to disable the ability to execute commands on the server
+`[p]slash sync` - apply above slash command change
+///
+
+This option determines if commands sent to the console channel will be sent to the Pterodactyl console.
+
+Default value: `False`
+
 ## `invite`
 
 This option determines what url the chat command will substitute in for the Discord invite placeholder.
@@ -136,6 +153,41 @@ This option determines which server's websocket to connect to. See [Getting Star
 
 Default value: `None`
 
+## `topic`
+
+### `host`
+
+This option determines the hostname of your server that will be used to retrieve server information.
+
+### `port`
+
+This option determines the port of your server that will be used to retrieve server information.
+
+Default value: `25565`
+
+### `text`
+
+This option determines what the channel topic will be set to.
+
+Available placeholders:
+
+- `.$H` - replaced with the server's hostname
+- `.$O` - replaced with the server's port
+
+Available with a Minecraft server:
+
+- `.$I` - replaced with the server's ip address
+- `.$M` - replaced with maximum player count
+- `.$P` - replaced with current online player count
+- `.$V` - replaced with the server's current version
+- `.$D` - replaced with the server's description / message of the day
+
+Default value:
+
+```
+Server IP: .$H\nServer Players: .$P/.$M
+```
+
 ## `url`
 
 This option determines what panel the cog will send requests to. See [Getting Started](getting-started.md#getting-server-information) for more information on this.

.forgejo/workflows/config/.pylintrc

@@ -17,4 +17,5 @@
     import-outside-toplevel,
     import-self,
     relative-beyond-top-level,
-    too-many-instance-attributes
+    too-many-instance-attributes,
+    duplicate-code

.forgejo/workflows/workflow.yaml

@@ -17,11 +17,11 @@ jobs:
         run: poetry install --with dev --no-root
 
       - name: Analysing code with Ruff
-        run: ruff check $(git ls-files '*.py')
+        run: ./.venv/bin/ruff check $(git ls-files '*.py')
         continue-on-error: true
 
       - name: Analysing code with Pylint
-        run: pylint --rcfile=.forgejo/workflows/config/.pylintrc $(git ls-files '*.py')
+        run: ./.venv/bin/pylint --rcfile=.forgejo/workflows/config/.pylintrc $(git ls-files '*.py')
 
   Build Documentation (MkDocs):
     runs-on: docker
@@ -42,7 +42,7 @@ jobs:
         run: |
           export SITE_URL="https://$CI_ACTION_REF_NAME_SLUG.seacogs.coastalcommits.com"
           export EDIT_URI="src/branch/$CI_ACTION_REF_NAME/.docs"
-          mkdocs build -v
+          ./.venv/bin/mkdocs build -v
 
       - name: Deploy documentation
         run: |

.gitignore

@@ -1,3 +1,4 @@
 .cache
 .vscode
 site
+.venv

antipolls/__init__.py

@@ -0,0 +1,5 @@
+from .antipolls import AntiPolls
+
+
+async def setup(bot):
+    await bot.add_cog(AntiPolls(bot))

antipolls/antipolls.py

@@ -0,0 +1,180 @@
+#   _____                         _
+#  / ____|                       (_)
+# | (___   ___  __ _ _____      ___ _ __ ___  _ __ ___   ___ _ __
+#  \___ \ / _ \/ _` / __\ \ /\ / / | '_ ` _ \| '_ ` _ \ / _ \ '__|
+#  ____) |  __/ (_| \__ \\ V  V /| | | | | | | | | | | |  __/ |
+# |_____/ \___|\__,_|___/ \_/\_/ |_|_| |_| |_|_| |_| |_|\___|_|
+
+import discord
+from red_commons.logging import getLogger
+from redbot.core import commands
+from redbot.core.bot import Config, Red
+from redbot.core.utils.chat_formatting import humanize_list
+
+
+class AntiPolls(commands.Cog):
+    """AntiPolls deletes messages that contain polls, with a configurable per-guild role and channel whitelist and support for default Discord permissions (Manage Messages)."""
+
+    __author__ = ["SeaswimmerTheFsh"]
+    __version__ = "1.0.0"
+    __documentation__ = "https://seacogs.coastalcommits.com/antipolls/"
+
+    def __init__(self, bot: Red):
+        super().__init__()
+        self.bot = bot
+        self.logger = getLogger("red.SeaCogs.AntiPolls")
+        self.config = Config.get_conf(self, identifier=23517395243, force_registration=True)
+        self.config.register_guild(
+            role_whitelist=[],
+            channel_whitelist=[],
+            manage_messages=True,
+        )
+        if not self.bot.intents.message_content:
+            self.logger.error("Message Content intent is not enabled, cog will not load.")
+            raise RuntimeError("This cog requires the Message Content intent to function. To prevent potentially destructive behavior, the cog will not load without the intent enabled.")
+
+    def format_help_for_context(self, ctx: commands.Context) -> str:
+        pre_processed = super().format_help_for_context(ctx) or ""
+        n = "\n" if "\n\n" not in pre_processed else ""
+        text = [
+            f"{pre_processed}{n}",
+            f"Cog Version: **{self.__version__}**",
+            f"Author: {humanize_list(self.__author__)}",
+            f"Documentation: {self.__documentation__}",
+        ]
+        return "\n".join(text)
+
+    async def red_delete_data_for_user(self, **kwargs): # pylint: disable=unused-argument
+        """Nothing to delete."""
+        return
+
+    @commands.Cog.listener('on_message')
+    async def polls_listener(self, message: discord.Message) -> None:
+        if message.guild is None:
+            return self.logger.verbose("Message in direct messages ignored")
+
+        if message.author.bot:
+            return self.logger.verbose("Message from bot ignored")
+
+        if await self.bot.cog_disabled_in_guild(self, message.guild):
+            return self.logger.verbose("Message ignored, cog is disabled in guild %s", message.guild.id)
+
+        guild_config = await self.config.guild(message.guild).all()
+
+        if guild_config['manage_messages'] is True and message.author.guild_permissions.manage_messages:
+            return self.logger.verbose("Message from user with Manage Messages permission ignored")
+
+        if message.channel.id in guild_config['channel_whitelist']:
+            return self.logger.verbose("Message in whitelisted channel %s ignored", message.channel.id)
+
+        if any(role.id in guild_config['role_whitelist'] for role in message.author.roles):
+            return self.logger.verbose("Message from whitelisted role %s ignored", message.author.roles)
+
+        if not message.content and not message.embeds and not message.attachments and not message.stickers:
+            self.logger.trace("Message %s is a poll, attempting to delete", message.id)
+
+            try:
+                await message.delete()
+            except discord.HTTPException as e:
+                return self.logger.error("Failed to delete message: %s", e)
+
+            return self.logger.trace("Deleted poll message %s", message.id)
+        self.logger.verbose("Message %s is not a poll, ignoring", message.id)
+
+    @commands.group(name="antipolls", aliases=["ap"])
+    @commands.guild_only()
+    @commands.admin_or_permissions(manage_guild=True)
+    async def antipolls(self, ctx: commands.Context) -> None:
+        """Manage AntiPolls settings."""
+
+    @antipolls.group(name="roles")
+    async def antipolls_roles(self, ctx: commands.Context) -> None:
+        """Manage role whitelist."""
+
+    @antipolls_roles.command(name="add")
+    async def antipolls_roles_add(self, ctx: commands.Context, *roles: discord.Role) -> None:
+        """Add roles to the whitelist."""
+        async with self.config.guild(ctx.guild).role_whitelist() as role_whitelist:
+            role_whitelist: list
+            failed: list[discord.Role] = []
+            for role in roles:
+                if role.id in role_whitelist:
+                    failed.append(role)
+                    continue
+                role_whitelist.append(role.id)
+        await ctx.tick()
+        if failed:
+            await ctx.send(f"The following roles were already in the whitelist: {humanize_list([role.mention for role in failed])}", delete_after=10)
+
+    @antipolls_roles.command(name="remove")
+    async def antipolls_roles_remove(self, ctx: commands.Context, *roles: discord.Role) -> None:
+        """Remove roles from the whitelist."""
+        async with self.config.guild(ctx.guild).role_whitelist() as role_whitelist:
+            role_whitelist: list
+            failed: list[discord.Role] = []
+            for role in roles:
+                if role.id not in role_whitelist:
+                    failed.append(role)
+                    continue
+                role_whitelist.remove(role.id)
+        await ctx.tick()
+        if failed:
+            await ctx.send(f"The following roles were not in the whitelist: {humanize_list([role.mention for role in failed])}", delete_after=10)
+
+    @antipolls_roles.command(name="list")
+    async def antipolls_roles_list(self, ctx: commands.Context) -> None:
+        """List roles in the whitelist."""
+        role_whitelist = await self.config.guild(ctx.guild).role_whitelist()
+        if not role_whitelist:
+            return await ctx.send("No roles in the whitelist.")
+        roles = [ctx.guild.get_role(role) for role in role_whitelist]
+        await ctx.send(humanize_list([role.mention for role in roles]))
+
+    @antipolls.group(name="channels")
+    async def antipolls_channels(self, ctx: commands.Context) -> None:
+        """Manage channel whitelist."""
+
+    @antipolls_channels.command(name="add")
+    async def antipolls_channels_add(self, ctx: commands.Context, *channels: discord.TextChannel) -> None:
+        """Add channels to the whitelist."""
+        async with self.config.guild(ctx.guild).channel_whitelist() as channel_whitelist:
+            channel_whitelist: list
+            failed: list[discord.TextChannel] = []
+            for channel in channels:
+                if channel.id in channel_whitelist:
+                    failed.append(channel)
+                    continue
+                channel_whitelist.append(channel.id)
+        await ctx.tick()
+        if failed:
+            await ctx.send(f"The following channels were already in the whitelist: {humanize_list([channel.mention for channel in failed])}", delete_after=10)
+
+    @antipolls_channels.command(name="remove")
+    async def antipolls_channels_remove(self, ctx: commands.Context, *channels: discord.TextChannel) -> None:
+        """Remove channels from the whitelist."""
+        async with self.config.guild(ctx.guild).channel_whitelist() as channel_whitelist:
+            channel_whitelist: list
+            failed: list[discord.TextChannel] = []
+            for channel in channels:
+                if channel.id not in channel_whitelist:
+                    failed.append(channel)
+                    continue
+                channel_whitelist.remove(channel.id)
+        await ctx.tick()
+        if failed:
+            await ctx.send(f"The following channels were not in the whitelist: {humanize_list([channel.mention for channel in failed])}", delete_after=10)
+
+    @antipolls_channels.command(name="list")
+    async def antipolls_channels_list(self, ctx: commands.Context) -> None:
+        """List channels in the whitelist."""
+        channel_whitelist = await self.config.guild(ctx.guild).channel_whitelist()
+        if not channel_whitelist:
+            return await ctx.send("No channels in the whitelist.")
+        channels = [ctx.guild.get_channel(channel) for channel in channel_whitelist]
+        await ctx.send(humanize_list([channel.mention for channel in channels]))
+
+    @antipolls.command(name="managemessages")
+    async def antipolls_managemessages(self, ctx: commands.Context, enabled: bool) -> None:
+        """Toggle Manage Messages permission check."""
+        await self.config.guild(ctx.guild).manage_messages.set(enabled)
+        await ctx.tick()

antipolls/info.json

@@ -0,0 +1,17 @@
+{
+  "author" : ["SeaswimmerTheFsh (seasw.)"],
+  "install_msg" : "Thank you for installing AntiPolls!\nYou can find the source code of this cog [here](https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs).",
+  "name" : "AntiPolls",
+  "short" : "AntiPolls deletes messages that contain polls.",
+  "description" : "AntiPolls deletes messages that contain polls, with a configurable per-guild role and channel whitelist and support for default Discord permissions (Manage Messages).",
+  "end_user_data_statement" : "This cog does not store any user data.",
+  "hidden": false,
+  "disabled": false,
+  "min_bot_version": "3.5.0",
+  "min_python_version": [3, 10, 0],
+  "tags": [
+      "automod",
+      "automoderation",
+      "polls"
+  ]
+}

aurora/aurora.py

@@ -13,14 +13,12 @@ from datetime import datetime, timedelta, timezone
 from math import ceil
 
 import discord
-import humanize
 from discord.ext import tasks
-from pytimeparse2 import disable_dateutil, parse
 from redbot.core import app_commands, commands, data_manager
 from redbot.core.app_commands import Choice
 from redbot.core.bot import Red
-from redbot.core.utils.chat_formatting import (box, error, humanize_list,
+from redbot.core.commands.converter import parse_relativedelta, parse_timedelta
-                                               warning)
+from redbot.core.utils.chat_formatting import box, error, humanize_list, humanize_timedelta, warning
 
 from aurora.importers.aurora import ImportAuroraView
 from aurora.importers.galacticbot import ImportGalacticBotView
@@ -29,17 +27,10 @@ from aurora.menus.guild import Guild
 from aurora.menus.immune import Immune
 from aurora.menus.overrides import Overrides
 from aurora.utilities.config import config, register_config
-from aurora.utilities.database import (connect, create_guild_table, fetch_case,
+from aurora.utilities.database import connect, create_guild_table, fetch_case, mysql_log
-                                       mysql_log)
+from aurora.utilities.factory import addrole_embed, case_factory, changes_factory, evidenceformat_factory, guild_embed, immune_embed, message_factory, overrides_embed
-from aurora.utilities.factory import (addrole_embed, case_factory,
-                                      changes_factory, evidenceformat_factory,
-                                      guild_embed, immune_embed,
-                                      message_factory, overrides_embed)
 from aurora.utilities.logger import logger
-from aurora.utilities.utils import (check_moddable, check_permissions,
+from aurora.utilities.utils import check_moddable, check_permissions, convert_timedelta_to_str, fetch_channel_dict, fetch_user_dict, generate_dict, log, send_evidenceformat, timedelta_from_relativedelta
-                                    convert_timedelta_to_str,
-                                    fetch_channel_dict, fetch_user_dict,
-                                    generate_dict, log, send_evidenceformat)
 
 
 class Aurora(commands.Cog):
@@ -48,7 +39,8 @@ class Aurora(commands.Cog):
     This cog stores all of its data in an SQLite database."""
 
     __author__ = ["SeaswimmerTheFsh"]
-    __version__ = "2.0.6"
+    __version__ = "2.1.2"
+    __documentation__ = "https://seacogs.coastalcommits.com/aurora/"
 
     async def red_delete_data_for_user(self, *, requester, user_id: int):
         if requester == "discord_deleted_user":
@@ -84,7 +76,6 @@ class Aurora(commands.Cog):
         super().__init__()
         self.bot = bot
         register_config(config)
-        disable_dateutil()
         self.handle_expiry.start()
 
     def format_help_for_context(self, ctx: commands.Context) -> str:
@@ -94,6 +85,7 @@ class Aurora(commands.Cog):
             f"{pre_processed}{n}",
             f"Cog Version: **{self.__version__}**",
             f"Author: {humanize_list(self.__author__)}",
+            f"Documentation: {self.__documentation__}",
         ]
         return "\n".join(text)
 
@@ -332,13 +324,10 @@ class Aurora(commands.Cog):
             return
 
         if duration is not None:
-            try:
+            parsed_time = parse_timedelta(duration)
-                parsed_time = parse(
+            if parsed_time is None:
-                    sval=duration, as_timedelta=True, raise_exception=True
-                )
-            except ValueError:
                 await interaction.response.send_message(
-                    error("Please provide a valid duration!"), ephemeral=True
+                    content=error("Please provide a valid duration!"), ephemeral=True
                 )
                 return
         else:
@@ -383,10 +372,10 @@ class Aurora(commands.Cog):
 
         await target.add_roles(
             role,
-            reason=f"Role added by {interaction.user.id}{(' for ' + {humanize.precisedelta(parsed_time)} if parsed_time != 'NULL' else '')} for: {reason}",
+            reason=f"Role added by {interaction.user.id}{(' for ' + {humanize_timedelta(timedelta=parsed_time)} if parsed_time != 'NULL' else '')} for: {reason}",
         )
         response: discord.WebhookMessage = await interaction.followup.send(
-            content=f"{target.mention} has been given the {role.mention} role{(' for ' + {humanize.precisedelta(parsed_time)} if parsed_time != 'NULL' else '')}!\n**Reason** - `{reason}`"
+            content=f"{target.mention} has been given the {role.mention} role{(' for ' + {humanize_timedelta(timedelta=parsed_time)} if parsed_time != 'NULL' else '')}!\n**Reason** - `{reason}`"
         )
 
         moderation_id = await mysql_log(
@@ -400,7 +389,7 @@ class Aurora(commands.Cog):
             reason,
         )
         await response.edit(
-            content=f"{target.mention} has been given the {role.mention} role{(' for ' + {humanize.precisedelta(parsed_time)} if parsed_time != 'NULL' else '')}! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`",
+            content=f"{target.mention} has been given the {role.mention} role{(' for ' + {humanize_timedelta(timedelta=parsed_time)} if parsed_time != 'NULL' else '')}! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`",
         )
         await log(interaction, moderation_id)
 
@@ -440,16 +429,15 @@ class Aurora(commands.Cog):
             return
 
         try:
-            parsed_time = parse(sval=duration, as_timedelta=True, raise_exception=True)
+            parsed_time = parse_timedelta(duration, maximum=timedelta(days=28))
-        except ValueError:
+            if parsed_time is None:
                 await interaction.response.send_message(
                     error("Please provide a valid duration!"), ephemeral=True
                 )
                 return
-
+        except commands.BadArgument:
-        if parsed_time.total_seconds() / 1000 > 2419200000:
             await interaction.response.send_message(
-                error("Please provide a duration that is less than 28 days.")
+                error("Please provide a duration that is less than 28 days."), ephemeral=True
             )
             return
 
@@ -458,7 +446,7 @@ class Aurora(commands.Cog):
         )
 
         await interaction.response.send_message(
-            content=f"{target.mention} has been muted for {humanize.precisedelta(parsed_time)}!\n**Reason** - `{reason}`"
+            content=f"{target.mention} has been muted for {humanize_timedelta(timedelta=parsed_time)}!\n**Reason** - `{reason}`"
         )
 
         if silent is None:
@@ -489,7 +477,7 @@ class Aurora(commands.Cog):
             reason,
         )
         await interaction.edit_original_response(
-            content=f"{target.mention} has been muted for {humanize.precisedelta(parsed_time)}! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`"
+            content=f"{target.mention} has been muted for {humanize_timedelta(timedelta=parsed_time)}! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`"
         )
         await log(interaction, moderation_id)
 
@@ -684,18 +672,22 @@ class Aurora(commands.Cog):
             pass
 
         if duration:
-            try:
+            parsed_time = parse_relativedelta(duration)
-                parsed_time = parse(
+            if parsed_time is None:
-                    sval=duration, as_timedelta=True, raise_exception=True
+                await interaction.response.send_message(
+                    content=error("Please provide a valid duration!"), ephemeral=True
                 )
+                return
+            try:
+                parsed_time = timedelta_from_relativedelta(parsed_time)
             except ValueError:
                 await interaction.response.send_message(
-                    error("Please provide a valid duration!"), ephemeral=True
+                    content=error("Please provide a valid duration!"), ephemeral=True
                 )
                 return
 
             await interaction.response.send_message(
-                content=f"{target.mention} has been banned for {humanize.precisedelta(parsed_time)}!\n**Reason** - `{reason}`"
+                content=f"{target.mention} has been banned for {humanize_timedelta(timedelta=parsed_time)}!\n**Reason** - `{reason}`"
             )
 
             try:
@@ -729,7 +721,7 @@ class Aurora(commands.Cog):
                 reason,
             )
             await interaction.edit_original_response(
-                content=f"{target.mention} has been banned for {humanize.precisedelta(parsed_time)}! (Case `#{moderation_id}`)\n**Reason** - `{reason}`"
+                content=f"{target.mention} has been banned for {humanize_timedelta(timedelta=parsed_time)}! (Case `#{moderation_id}`)\n**Reason** - `{reason}`"
             )
             await log(interaction, moderation_id)
 
@@ -1069,9 +1061,9 @@ class Aurora(commands.Cog):
                     }
                 )
                 duration_embed = (
-                    f"{humanize.precisedelta(td)} | <t:{case['end_timestamp']}:R>"
+                    f"{humanize_timedelta(timedelta=td)} | <t:{case['end_timestamp']}:R>"
                     if bool(case["expired"]) is False
-                    else f"{humanize.precisedelta(td)} | Expired"
+                    else f"{humanize_timedelta(timedelta=td)} | Expired"
                 )
                 field_value += f"\n**Duration:** {duration_embed}"
 
@@ -1380,11 +1372,8 @@ class Aurora(commands.Cog):
             case_dict = await fetch_case(case, interaction.guild.id)
             if case_dict:
                 if duration:
-                    try:
+                    parsed_time = parse_timedelta(duration)
-                        parsed_time = parse(
+                    if parsed_time is None:
-                            sval=duration, as_timedelta=True, raise_exception=True
-                        )
-                    except ValueError:
                         await interaction.response.send_message(
                             error("Please provide a valid duration!"), ephemeral=True
                         )
@@ -1497,6 +1486,7 @@ class Aurora(commands.Cog):
 
     @tasks.loop(minutes=1)
     async def handle_expiry(self):
+        await self.bot.wait_until_red_ready()
         current_time = time.time()
         database = connect()
         cursor = database.cursor()
@@ -1700,15 +1690,34 @@ class Aurora(commands.Cog):
             )
 
     @aurora.command(aliases=["tdc", "td", "timedeltaconvert"])
-    async def timedelta(self, ctx: commands.Context, *, duration: str):
+    async def timedelta(self, ctx: commands.Context, *, duration: str) -> None:
-        """This command converts a duration to a [`timedelta`](https://docs.python.org/3/library/datetime.html#datetime.timedelta) Python object.
+        """Convert a string to a timedelta.
+
+        This command converts a duration to a [`timedelta`](https://docs.python.org/3/library/datetime.html#datetime.timedelta) Python object.
+        You cannot convert years or months as they are not fixed units. Use `[p]aurora relativedelta` for that.
 
         **Example usage**
         `[p]aurora timedelta 1 day 15hr 82 minutes 52s`
         **Output**
         `1 day, 16:22:52`"""
-        try:
+        parsed_time = parse_timedelta(duration)
-            parsed_time = parse(duration, as_timedelta=True, raise_exception=True)
+        if parsed_time is None:
-            await ctx.send(f"`{str(parsed_time)}`")
-        except ValueError:
             await ctx.send(error("Please provide a convertible value!"))
+            return
+        await ctx.send(f"`{parsed_time}`")
+
+    @aurora.command(aliases=["rdc", "rd", "relativedeltaconvert"])
+    async def relativedelta(self, ctx: commands.Context, *, duration: str) -> None:
+        """Convert a string to a relativedelta.
+
+        This command converts a duration to a [`relativedelta`](https://dateutil.readthedocs.io/en/stable/relativedelta.html) Python object.
+
+        **Example usage**
+        `[p]aurora relativedelta 3 years 1 day 15hr 82 minutes 52s`
+        **Output**
+        `relativedelta(years=+3, days=+1, hours=+15, minutes=+82, seconds=+52)`"""
+        parsed_time = parse_relativedelta(duration)
+        if parsed_time is None:
+            await ctx.send(error("Please provide a convertible value!"))
+            return
+        await ctx.send(f"`{parsed_time}`")

aurora/info.json

@@ -5,7 +5,6 @@
   "short" : "A full replacement for Red's core Mod cogs.",
   "description" : "Aurora is a fully-featured moderation system. It is heavily inspired by GalacticBot, and is designed to be a more user-friendly alternative to Red's core Mod cogs. This cog stores all of its data in an SQLite database.",
   "end_user_data_statement" : "This cog stores the following information:\n- User IDs of accounts who moderate users or are moderated\n- Guild IDs of guilds with the cog enabled\n- Timestamps of moderations\n- Other information relating to moderations",
-  "requirements": ["humanize", "pytimeparse2"],
   "hidden": false,
   "disabled": false,
   "min_bot_version": "3.5.0",

aurora/menus/addrole.py

@@ -17,12 +17,13 @@ class Addrole(ui.View):
             await interaction.response.send_message(error("You must have the manage guild permission to add roles to the addrole whitelist."), ephemeral=True)
             return
         await interaction.response.defer()
-        addrole_whitelist: list = await config.guild(self.ctx.guild).addrole_whitelist()
+        async with config.guild(self.ctx.guild).addrole_whitelist() as addrole_whitelist:
-        if select.values[0].id in addrole_whitelist:
+            addrole_whitelist: list # type hint
-            addrole_whitelist.remove(select.values[0].id)
+            for value in select.values:
+                if value.id in addrole_whitelist:
+                    addrole_whitelist.remove(value.id)
                 else:
-            addrole_whitelist.append(select.values[0].id)
+                    addrole_whitelist.append(value.id)
-        await config.guild(self.ctx.guild).addrole_whitelist.set(addrole_whitelist)
         await interaction.message.edit(embed=await addrole_embed(self.ctx))
 
     @ui.button(label="Clear", style=ButtonStyle.red, row=1)

aurora/menus/guild.py

@@ -31,6 +31,16 @@ class Guild(ui.View):
         await config.guild(interaction.guild).use_discord_permissions.set(not current_setting)
         await interaction.message.edit(embed=await guild_embed(self.ctx))
 
+    @ui.button(label="Respect Hierarchy", style=ButtonStyle.green, row=0)
+    async def respect_heirarchy(self, interaction: Interaction, button: ui.Button): # pylint: disable=unused-argument
+        if not interaction.user.guild_permissions.manage_guild and not interaction.user.guild_permissions.administrator:
+            await interaction.response.send_message("You must have the manage guild permission to change this setting.", ephemeral=True)
+            return
+        await interaction.response.defer()
+        current_setting = await config.guild(interaction.guild).respect_hierarchy()
+        await config.guild(interaction.guild).respect_hierarchy.set(not current_setting)
+        await interaction.message.edit(embed=await guild_embed(self.ctx))
+
     @ui.button(label="Ignore Modlog", style=ButtonStyle.green, row=0)
     async def ignore_modlog(self, interaction: Interaction, button: ui.Button): # pylint: disable=unused-argument
         if not interaction.user.guild_permissions.manage_guild and not interaction.user.guild_permissions.administrator:

aurora/menus/immune.py

@@ -17,13 +17,13 @@ class Immune(ui.View):
             await interaction.response.send_message(error("You must have the manage guild permission to add immune roles."), ephemeral=True)
             return
         await interaction.response.defer()
-        immune_roles: list = await config.guild(self.ctx.guild).immune_roles()
+        async with config.guild(self.ctx.guild).immune_roles() as immune_roles:
-        for role in select.values:
+            immune_roles: list # type hint
-            if role.id in immune_roles:
+            for value in select.values:
-                immune_roles.remove(role.id)
+                if value.id in immune_roles:
+                    immune_roles.remove(value.id)
                 else:
-                immune_roles.append(role.id)
+                    immune_roles.append(value.id)
-        await config.guild(self.ctx.guild).immune_roles.set(immune_roles)
         await interaction.message.edit(embed=await immune_embed(self.ctx))
 
     @ui.button(label="Clear", style=ButtonStyle.red, row=1)

aurora/utilities/config.py

@@ -7,6 +7,7 @@ def register_config(config_obj: Config):
     config_obj.register_guild(
         show_moderator=True,
         use_discord_permissions=True,
+        respect_hierarchy=True,
         ignore_modlog=True,
         ignore_other_bots=True,
         dm_users=True,

aurora/utilities/factory.py

@@ -2,11 +2,11 @@
 from datetime import datetime, timedelta
 from typing import Union
 
-import humanize
 from discord import (Color, Embed, Guild, Interaction, InteractionMessage,
                      Member, Role, User)
 from redbot.core import commands
-from redbot.core.utils.chat_formatting import bold, box, error, warning
+from redbot.core.utils.chat_formatting import (bold, box, error,
+                                               humanize_timedelta, warning)
 
 from aurora.utilities.config import config
 from aurora.utilities.utils import (fetch_channel_dict, fetch_user_dict,
@@ -51,7 +51,7 @@ async def message_factory(
         guild_name = guild.name
 
     if moderation_type in ["tempbanned", "muted"] and duration:
-        embed_duration = f" for {humanize.precisedelta(duration)}"
+        embed_duration = f" for {humanize_timedelta(timedelta=duration)}"
     else:
         embed_duration = ""
 
@@ -141,9 +141,9 @@ async def log_factory(
                 }
             )
             duration_embed = (
-                f"{humanize.precisedelta(td)} | <t:{case_dict['end_timestamp']}:R>"
+                f"{humanize_timedelta(timedelta=td)} | <t:{case_dict['end_timestamp']}:R>"
                 if case_dict["expired"] == "0"
-                else str(humanize.precisedelta(td))
+                else str(humanize_timedelta(timedelta=td))
             )
             embed.description = (
                 embed.description
@@ -204,7 +204,7 @@ async def log_factory(
             )
             embed.description = (
                 embed.description
-                + f"\n**Duration:** {humanize.precisedelta(td)} | <t:{case_dict['end_timestamp']}:R>"
+                + f"\n**Duration:** {humanize_timedelta(timedelta=td)} | <t:{case_dict['end_timestamp']}:R>"
             )
 
         embed.add_field(name="Reason", value=box(case_dict["reason"]), inline=False)
@@ -255,9 +255,9 @@ async def case_factory(interaction: Interaction, case_dict: dict) -> Embed:
             }
         )
         duration_embed = (
-            f"{humanize.precisedelta(td)} | <t:{case_dict['end_timestamp']}:R>"
+            f"{humanize_timedelta(timedelta=td)} | <t:{case_dict['end_timestamp']}:R>"
             if bool(case_dict["expired"]) is False
-            else str(humanize.precisedelta(td))
+            else str(humanize_timedelta(timedelta=td))
         )
         embed.description += f"\n**Duration:** {duration_embed}\n**Expired:** {bool(case_dict['expired'])}"
 
@@ -379,7 +379,7 @@ async def evidenceformat_factory(interaction: Interaction, case_dict: dict) -> s
     if case_dict["duration"] != "NULL":
         hours, minutes, seconds = map(int, case_dict["duration"].split(":"))
         td = timedelta(hours=hours, minutes=minutes, seconds=seconds)
-        content += f"\nDuration: {humanize.precisedelta(td)}"
+        content += f"\nDuration: {humanize_timedelta(timedelta=td)}"
 
     content += f"\nReason: {case_dict['reason']}"
 
@@ -455,6 +455,7 @@ async def guild_embed(ctx: commands.Context) -> Embed:
             ctx.guild
         ).history_inline_pagesize(),
         "auto_evidenceformat": await config.guild(ctx.guild).auto_evidenceformat(),
+        "respect_hierarchy": await config.guild(ctx.guild).respect_hierarchy(),
     }
 
     channel = ctx.guild.get_channel(guild_settings["log_channel"])
@@ -471,6 +472,9 @@ async def guild_embed(ctx: commands.Context) -> Embed:
         + bold("Use Discord Permissions: ")
         + get_bool_emoji(guild_settings["use_discord_permissions"]),
         "- "
+        + bold("Respect Hierarchy: ")
+        + get_bool_emoji(guild_settings["respect_hierarchy"]),
+        "- "
         + bold("Ignore Modlog: ")
         + get_bool_emoji(guild_settings["ignore_modlog"]),
         "- "
@@ -510,15 +514,29 @@ async def guild_embed(ctx: commands.Context) -> Embed:
 async def addrole_embed(ctx: commands.Context) -> Embed:
     """Generates a configuration menu field value for a guild's addrole whitelist."""
 
-    whitelist = await config.guild(ctx.guild).addrole_whitelist()
+    roles = []
-    if whitelist:
+    async with config.guild(ctx.guild).addrole_whitelist() as whitelist:
-        whitelist = [
+        for role in whitelist:
-            ctx.guild.get_role(role).mention or error(f"`{role}` (Not Found)")
+            evalulated_role = ctx.guild.get_role(role) or error(f"`{role}` (Not Found)")
-            for role in whitelist
+            if isinstance(evalulated_role, Role):
-        ]
+                roles.append({
-        whitelist = "\n".join(whitelist)
+                    "id": evalulated_role.id,
+                    "mention": evalulated_role.mention,
+                    "position": evalulated_role.position
+                })
             else:
-        whitelist = warning("No roles are on the addrole whitelist!")
+                roles.append({
+                    "id": role,
+                    "mention": error(f"`{role}` (Not Found)"),
+                    "position": 0
+                })
+
+    if roles:
+        roles = sorted(roles, key=lambda x: x["position"], reverse=True)
+        roles = [role["mention"] for role in roles]
+        whitelist_str = "\n".join(roles)
+    else:
+        whitelist_str = warning("No roles are on the addrole whitelist!")
 
     e = await _config(ctx)
     e.title += ": Addrole Whitelist"
@@ -526,8 +544,8 @@ async def addrole_embed(ctx: commands.Context) -> Embed:
         "Use the select menu below to manage this guild's addrole whitelist."
     )
 
-    if len(whitelist) > 4000 and len(whitelist) < 5000:
+    if len(whitelist_str) > 4000 and len(whitelist_str) < 5000:
-        lines = whitelist.split("\n")
+        lines = whitelist_str.split("\n")
         chunks = []
         chunk = ""
         for line in lines:
@@ -541,21 +559,35 @@ async def addrole_embed(ctx: commands.Context) -> Embed:
         for chunk in chunks:
             e.add_field(name="", value=chunk)
     else:
-        e.description += "\n\n" + whitelist
+        e.description += "\n\n" + whitelist_str
 
     return e
 
 
 async def immune_embed(ctx: commands.Context) -> Embed:
-    """Generates a configuration menu field value for a guild's immune roles."""
+    """Generates a configuration menu embed for a guild's immune roles."""
 
-    immune_roles = await config.guild(ctx.guild).immune_roles()
+    roles = []
-    if immune_roles:
+    async with config.guild(ctx.guild).immune_roles() as immune_roles:
-        immune_str = [
+        for role in immune_roles:
-            ctx.guild.get_role(role).mention or error(f"`{role}` (Not Found)")
+            evalulated_role = ctx.guild.get_role(role) or error(f"`{role}` (Not Found)")
-            for role in immune_roles
+            if isinstance(evalulated_role, Role):
-        ]
+                roles.append({
-        immune_str = "\n".join(immune_str)
+                    "id": evalulated_role.id,
+                    "mention": evalulated_role.mention,
+                    "position": evalulated_role.position
+                })
+            else:
+                roles.append({
+                    "id": role,
+                    "mention": error(f"`{role}` (Not Found)"),
+                    "position": 0
+                })
+
+    if roles:
+        roles = sorted(roles, key=lambda x: x["position"], reverse=True)
+        roles = [role["mention"] for role in roles]
+        immune_str = "\n".join(roles)
     else:
         immune_str = warning("No roles are set as immune roles!")
 

aurora/utilities/logger.py

@@ -1,3 +1,3 @@
 from red_commons.logging import getLogger
 
-logger = getLogger("red.seacogs.aurora")
+logger = getLogger("red.SeaCogs.Aurora")

aurora/utilities/utils.py

@@ -1,8 +1,10 @@
 # pylint: disable=cyclic-import
 import json
+from datetime import datetime
 from datetime import timedelta as td
-from typing import Union
+from typing import Optional, Union
 
+from dateutil.relativedelta import relativedelta as rd
 from discord import Guild, Interaction, Member, SelectOption, User
 from discord.errors import Forbidden, NotFound
 from redbot.core import commands
@@ -75,7 +77,7 @@ async def check_moddable(
         return False
 
     if isinstance(target, Member):
-        if interaction.user.top_role <= target.top_role:
+        if interaction.user.top_role <= target.top_role and await config.guild(interaction.guild).respect_hierarchy() is True:
             await interaction.response.send_message(
                 content=error(
                     "You cannot moderate members with a higher role than you!"
@@ -248,7 +250,7 @@ def convert_timedelta_to_str(timedelta: td) -> str:
     return f"{hours}:{minutes}:{seconds}"
 
 
-def get_bool_emoji(value: bool) -> str:
+def get_bool_emoji(value: Optional[bool]) -> str:
     """Returns a unicode emoji based on a boolean value."""
     if value is True:
         return "\N{WHITE HEAVY CHECK MARK}"
@@ -283,3 +285,9 @@ def create_pagesize_options() -> list[SelectOption]:
             )
         )
     return options
+
+def timedelta_from_relativedelta(relativedelta: rd) -> td:
+    """Converts a relativedelta object to a timedelta object."""
+    now = datetime.now()
+    then = now - relativedelta
+    return now - then

backup/backup.py

@@ -14,8 +14,7 @@ from redbot.cogs.downloader import errors
 from redbot.cogs.downloader.converters import InstalledCog
 from redbot.core import commands
 from redbot.core.bot import Red
-from redbot.core.utils.chat_formatting import (error, humanize_list,
+from redbot.core.utils.chat_formatting import error, humanize_list, text_to_file
-                                               text_to_file)
 
 
 # pylint: disable=protected-access
@@ -23,12 +22,13 @@ class Backup(commands.Cog):
     """A utility to make reinstalling repositories and cogs after migrating the bot far easier."""
 
     __author__ = ["SeaswimmerTheFsh"]
-    __version__ = "1.0.1"
+    __version__ = "1.1.0"
+    __documentation__ = "https://seacogs.coastalcommits.com/backup/"
 
     def __init__(self, bot: Red):
         super().__init__()
         self.bot = bot
-        self.logger = getLogger("red.seacogs.backup")
+        self.logger = getLogger("red.SeaCogs.Backup")
 
     def format_help_for_context(self, ctx: commands.Context) -> str:
         pre_processed = super().format_help_for_context(ctx) or ""
@@ -37,6 +37,7 @@ class Backup(commands.Cog):
             f"{pre_processed}{n}",
             f"Cog Version: **{self.__version__}**",
             f"Author: {humanize_list(self.__author__)}",
+            f"Documentation: {self.__documentation__}",
         ]
         return "\n".join(text)
 
@@ -159,17 +160,15 @@ class Backup(commands.Cog):
                     )
                     self.logger.debug("Repository %s already exists", name)
 
-                # This is commented out because errors.AuthenticationError is not yet implemented in Red 3.5.5's Downloader cog.
+                except errors.AuthenticationError as err:
-                # Rather, it is only in the development version and will be added in version 3.5.6 (or whatever the next version is).
+                    repo_e.append(f"Authentication error while adding repository {name}. See logs for more information.")
-                # except errors.AuthenticationError as err:
+                    self.logger.exception(
-                #     repo_e.append(f"Authentication error while adding repository {name}. See logs for more information.")
+                        "Something went wrong whilst cloning %s (to revision %s)",
-                #     self.logger.exception(
+                        url,
-                #         "Something went wrong whilst cloning %s (to revision %s)",
+                        branch,
-                #         url,
+                        exc_info=err,
-                #         branch,
+                    )
-                #         exc_info=err,
+                    continue
-                #     )
-                #     continue
 
                 except errors.CloningError as err:
                     repo_e.append(

backup/info.json

@@ -7,8 +7,8 @@
   "end_user_data_statement" : "This cog does not store end user data.",
   "hidden": false,
   "disabled": false,
-  "min_bot_version": "3.5.0",
+  "min_bot_version": "3.5.6",
-  "max_bot_version": "3.5.5",
+  "max_bot_version": "3.5.9",
   "min_python_version": [3, 9, 0],
   "tags": [
     "utility",

bible/bible.py

@@ -6,11 +6,14 @@
 # |_____/ \___|\__,_|___/ \_/\_/ |_|_| |_| |_|_| |_| |_|\___|_|
 
 import random
+from io import BytesIO
 
 import aiohttp
-from discord import Embed
+import numpy as np
+from discord import Colour, Embed, File
+from PIL import Image
 from red_commons.logging import getLogger
-from redbot.core import Config, commands
+from redbot.core import Config, commands, data_manager
 from redbot.core.bot import Red
 from redbot.core.utils.chat_formatting import error, humanize_list
 
@@ -22,7 +25,8 @@ class Bible(commands.Cog):
     """Retrieve Bible verses from the API.bible API."""
 
     __author__ = ["SeaswimmerTheFsh"]
-    __version__ = "1.0.1"
+    __version__ = "1.1.0"
+    __documentation__ = "https://seacogs.coastalcommits.com/bible/"
 
     def __init__(self, bot: Red):
         super().__init__()
@@ -31,7 +35,7 @@ class Bible(commands.Cog):
         self.config = Config.get_conf(
             self, identifier=481923957134912, force_registration=True
         )
-        self.logger = getLogger("red.seacogs.bible")
+        self.logger = getLogger("red.SeaCogs.Bible")
         self.config.register_global(bible="de4e12af7f28f599-02")
         self.config.register_user(bible=None)
 
@@ -42,9 +46,26 @@ class Bible(commands.Cog):
             f"{pre_processed}{n}",
             f"Cog Version: **{self.__version__}**",
             f"Author: {humanize_list(self.__author__)}",
+            f"Documentation: {self.__documentation__}",
         ]
         return "\n".join(text)
 
+    def get_icon(self, color: Colour) -> File:
+        """Get the docs.api.bible favicon with a given color."""
+        image_path = data_manager.bundled_data_path(self) / "api.bible-logo.png"
+        image = Image.open(image_path)
+        image = image.convert("RGBA")
+        data = np.array(image)
+        red, green, blue, alpha = data.T # pylint: disable=unused-variable
+        white_areas = (red == 255) & (blue == 255) & (green == 255)
+        data[..., :-1][white_areas.T] = color.to_rgb()
+        image = Image.fromarray(data)
+
+        with BytesIO() as image_binary:
+            image.save(image_binary, "PNG")
+            image_binary.seek(0)
+            return File(image_binary, filename="icon.png", description="API.Bible Icon")
+
     async def translate_book_name(self, bible_id: str, book_name: str) -> str:
         """Translate a book name to a book ID."""
         book_name_list = [
@@ -246,15 +267,17 @@ class Bible(commands.Cog):
             return
 
         if await ctx.embed_requested():
+            icon = self.get_icon(await ctx.embed_color())
             embed = Embed(
                 title=f"{passage['reference']}",
                 description=passage["content"].replace("¶ ", ""),
-                color=await self.bot.get_embed_color(ctx.channel),
+                color=await ctx.embed_color(),
             )
             embed.set_footer(
-                text=f"{ctx.prefix}bible passage - Powered by API.Bible - {version.abbreviationLocal} ({version.languageLocal}, {version.descriptionLocal})"
+                text=f"{ctx.prefix}bible passage - Powered by API.Bible - {version.abbreviationLocal} ({version.languageLocal}, {version.descriptionLocal})",
+                icon_url="attachment://icon.png"
             )
-            await ctx.send(embed=embed)
+            await ctx.send(embed=embed, file=icon)
         else:
             await ctx.send(f"## {passage['reference']}\n{passage['content']}")
 
@@ -286,14 +309,16 @@ class Bible(commands.Cog):
             return
 
         if await ctx.embed_requested():
+            icon = self.get_icon(await ctx.embed_color())
             embed = Embed(
                 title=f"{passage['reference']}",
                 description=passage["content"].replace("¶ ", ""),
-                color=await self.bot.get_embed_color(ctx.channel),
+                color=await ctx.embed_color(),
             )
             embed.set_footer(
-                text=f"{ctx.prefix}bible random - Powered by API.Bible - {version.abbreviationLocal} ({version.languageLocal}, {version.descriptionLocal})"
+                text=f"{ctx.prefix}bible random - Powered by API.Bible - {version.abbreviationLocal} ({version.languageLocal}, {version.descriptionLocal})",
+                icon_url="attachment://icon.png"
             )
-            await ctx.send(embed=embed)
+            await ctx.send(embed=embed, file=icon)
         else:
             await ctx.send(f"## {passage['reference']}\n{passage['content']}")

bible/info.json

@@ -9,6 +9,7 @@
   "disabled": false,
   "min_bot_version": "3.5.0",
   "min_python_version": [3, 10, 0],
+  "requirements": ["numpy", "pillow"],
   "tags": [
     "fun",
     "utility",

mkdocs.yml

@@ -29,7 +29,7 @@ nav:
 plugins:
   - git-authors
   - search
-  - social
+  #- social
   - git-revision-date-localized:
       enable_creation_date: true
       type: timeago

nerdify/nerdify.py

@@ -18,7 +18,8 @@ class Nerdify(commands.Cog):
     """Nerdify your text."""
 
     __author__ = ["SeaswimmerTheFsh"]
-    __version__ = "1.3.3"
+    __version__ = "1.3.4"
+    __documentation__ = "https://seacogs.coastalcommits.com/nerdify/"
 
     def __init__(self, bot):
         self.bot = bot
@@ -30,6 +31,7 @@ class Nerdify(commands.Cog):
             f"{pre_processed}{n}",
             f"Cog Version: **{self.__version__}**",
             f"Author: {chat_formatting.humanize_list(self.__author__)}",
+            f"Documentation: {self.__documentation__}"
         ]
         return "\n".join(text)
 

pterodactyl/config.py

@@ -7,6 +7,7 @@ def register_config(config_obj: Config) -> None:
         base_url=None,
         server_id=None,
         console_channel=None,
+        console_commands_enabled=False,
         current_status='',
         chat_regex=r"^\[\d{2}:\d{2}:\d{2}\sINFO\]: (?!\[(?:Server|Rcon)\])(?:<|\[)(\w+)(?:>|\]) (.*)",
         server_regex=r"^\[\d{2}:\d{2}:\d{2} INFO\]:(?: \[Not Secure\])? \[(?:Server|Rcon)\] (.*)",
@@ -14,6 +15,9 @@ def register_config(config_obj: Config) -> None:
         leave_regex=r"^\[\d{2}:\d{2}:\d{2} INFO\]: ([^<\n]+) left the game$",
         achievement_regex=r"^\[\d{2}:\d{2}:\d{2} INFO\]: (.*) has (made the advancement|completed the challenge) \[(.*)\]$",
         chat_command='tellraw @a ["",{"text":".$N ","color":".$C","insertion":"<@.$I>","hoverEvent":{"action":"show_text","contents":"Shift click to mention this user inside Discord"}},{"text":"(DISCORD):","color":"blue","clickEvent":{"action":"open_url","value":".$V"},"hoverEvent":{"action":"show_text","contents":"Click to join the Discord Server"}},{"text":" .$M","color":"white"}]', # noqa: E501
+        topic='Server IP: .$H\nServer Players: .$P/.$M',
+        topic_hostname=None,
+        topic_port=25565,
         api_endpoint="minecraft",
         chat_channel=None,
         startup_msg='Server started!',

pterodactyl/logger.py

@@ -1,4 +1,9 @@
+from red_commons import logging
 from red_commons.logging import getLogger
 
-logger = getLogger('red.seacogs.pterodactyl')
+logger = getLogger('red.SeaCogs.Pterodactyl')
-websocket_logger = getLogger('red.seacogs.pterodactyl.websocket')
+websocket_logger = getLogger('red.SeaCogs.Pterodactyl.websocket')
+if logger.level >= logging.VERBOSE:
+    websocket_logger.setLevel(logging.logging.INFO)
+elif logger.level < logging.VERBOSE:
+    websocket_logger.setLevel(logging.logging.DEBUG)

pterodactyl/mcsrvstatus.py

@@ -0,0 +1,10 @@
+import aiohttp
+
+
+async def get_status(host, port = 25565) -> tuple[bool, dict]:
+    async with aiohttp.ClientSession() as session:
+        async with session.get(f'https://api.mcsrvstat.us/2/{host}:{port}') as response:
+            response = await response.json()
+            if response['online']:
+                return (True, response)
+            return (False, response)

pterodactyl/pterodactyl.py

@@ -1,16 +1,18 @@
 import asyncio
 import json
-from typing import Mapping, Optional, Union
+from typing import Mapping, Optional, Tuple, Union
 
 import discord
 import websockets
+from discord.ext import tasks
 from pydactyl import PterodactylClient
 from redbot.core import app_commands, commands
 from redbot.core.app_commands import Choice
 from redbot.core.bot import Red
-from redbot.core.utils.chat_formatting import box, error
+from redbot.core.utils.chat_formatting import box, error, humanize_list
 from redbot.core.utils.views import ConfirmView
 
+from pterodactyl import mcsrvstatus
 from pterodactyl.config import config, register_config
 from pterodactyl.logger import logger
 
@@ -18,6 +20,10 @@ from pterodactyl.logger import logger
 class Pterodactyl(commands.Cog):
     """Pterodactyl allows you to manage your Pterodactyl Panel from Discord."""
 
+    __author__ = ["SeaswimmerTheFsh"]
+    __version__ = "2.0.0"
+    __documentation__ = "https://seacogs.coastalcommits.com/pterodactyl/"
+
     def __init__(self, bot: Red):
         self.bot = bot
         self.client: Optional[PterodactylClient] = None
@@ -25,12 +31,22 @@ class Pterodactyl(commands.Cog):
         self.websocket: Optional[websockets.WebSocketClientProtocol] = None
         self.retry_counter: int = 0
         register_config(config)
-
-    async def cog_load(self) -> None:
-        self.retry_counter = 0
         self.task = self.get_task()
+        self.update_topic.start()
+
+    def format_help_for_context(self, ctx: commands.Context) -> str:
+        pre_processed = super().format_help_for_context(ctx) or ""
+        n = "\n" if "\n\n" not in pre_processed else ""
+        text = [
+            f"{pre_processed}{n}",
+            f"Cog Version: **{self.__version__}**",
+            f"Author: {humanize_list(self.__author__)}",
+            f"Documentation: {self.__documentation__}",
+        ]
+        return "\n".join(text)
 
     async def cog_unload(self) -> None:
+        self.update_topic.cancel()
         self.task.cancel()
         self.retry_counter = 0
         await self.client._session.close() # pylint: disable=protected-access
@@ -56,11 +72,26 @@ class Pterodactyl(commands.Cog):
             else:
                 logger.info("Retry limit reached. Stopping task.")
 
+    @tasks.loop(minutes=6)
+    async def update_topic(self):
+        await self.bot.wait_until_red_ready()
+        topic = await self.get_topic()
+        console = self.bot.get_channel(await config.console_channel())
+        chat = self.bot.get_channel(await config.chat_channel())
+        if console:
+            await console.edit(topic=topic)
+        if chat:
+            await chat.edit(topic=topic)
+
     @commands.Cog.listener()
     async def on_message_without_command(self, message: discord.Message) -> None:
         if message.channel.id == await config.console_channel() and message.author.bot is False:
+            if await config.console_commands_enabled() is False:
+                await message.channel.send("Console commands are disabled.")
+                logger.debug("Received console command from %s, but console commands are disabled: %s", message.author.id, message.content)
+                return
             logger.debug("Received console command from %s: %s", message.author.id, message.content)
-            await message.channel.send(f"Received console command from {message.author.id}: {message.content[:1900]}")
+            await message.channel.send(f"Received console command from {message.author.id}: {message.content[:1900]}", allowed_mentions=discord.AllowedMentions.none())
             try:
                 await self.websocket.send(json.dumps({"event": "send command", "args": [message.content]}))
             except websockets.exceptions.ConnectionClosed as e:
@@ -72,7 +103,7 @@ class Pterodactyl(commands.Cog):
             logger.debug("Received chat message from %s: %s", message.author.id, message.content)
             channel = self.bot.get_channel(await config.console_channel())
             if channel:
-                await channel.send(f"Received chat message from {message.author.id}: {message.content[:1900]}")
+                await channel.send(f"Received chat message from {message.author.id}: {message.content[:1900]}", allowed_mentions=discord.AllowedMentions.none())
             msg = json.dumps({"event": "send command", "args": [await self.get_chat_command(message)]})
             logger.debug("Sending chat message to server:\n%s", msg)
             try:
@@ -83,13 +114,41 @@ class Pterodactyl(commands.Cog):
                 self.retry_counter = 0
                 self.task = self.get_task()
 
+    async def get_topic(self) -> str:
+        topic: str = await config.topic()
+        placeholders = {
+            "H": await config.topic_hostname() or "unset",
+            "O": str(await config.topic_port()),
+        }
+        if await config.api_endpoint() == "minecraft":
+            status, response = await mcsrvstatus.get_status(await config.topic_hostname(), await config.topic_port())
+            if status:
+                placeholders.update({
+                    "I": response['ip'],
+                    "M": str(response['players']['max']),
+                    "P": str(response['players']['online']),
+                    "V": response['version'],
+                    "D": response['motd']['clean'][0] if response['motd']['clean'] else "unset",
+                })
+            else:
+                placeholders.update({
+                    "I": response['ip'],
+                    "M": "0",
+                    "P": "0",
+                    "V": "Server Offline",
+                    "D": "Server Offline",
+                })
+        for key, value in placeholders.items():
+            topic = topic.replace('.$' + key, value)
+        return topic
+
     async def get_chat_command(self, message: discord.Message) -> str:
         command: str = await config.chat_command()
         placeholders = {
             "C": str(message.author.color),
             "D": message.author.discriminator,
             "I": str(message.author.id),
-            "M": message.content.replace('"',''),
+            "M": message.content.replace('"','').replace("\n", " "),
             "N": message.author.display_name,
             "U": message.author.name,
             "V": await config.invite() or "use [p]pterodactyl config invite to change me",
@@ -98,6 +157,22 @@ class Pterodactyl(commands.Cog):
             command = command.replace('.$' + key, value)
         return command
 
+    async def get_player_list(self) -> Optional[Tuple[str, list]]:
+        if await config.api_endpoint() == "minecraft":
+            status, response = await mcsrvstatus.get_status(await config.topic_hostname(), await config.topic_port())
+            if status and 'list' in response['players']:
+                output_str = '\n'.join(response['players']['list'])
+                return output_str, response['players']['list']
+            return None
+
+    async def get_player_list_embed(self, ctx: Union[commands.Context, discord.Interaction]) -> Optional[discord.Embed]:
+        player_list = await self.get_player_list()
+        if player_list:
+            embed = discord.Embed(color=await self.bot.get_embed_color(ctx.channel), title="Players Online")
+            embed.description = player_list[0]
+            return embed
+        return None
+
     async def power(self, ctx: Union[discord.Interaction, commands.Context], action: str, action_ing: str, warning: str = '') -> None:
         if isinstance(ctx, discord.Interaction):
             author = ctx.user
@@ -111,7 +186,7 @@ class Pterodactyl(commands.Cog):
                 return await ctx.response.send_message(f"Server is already {action_ing}.", ephemeral=True)
             return await ctx.send(f"Server is already {action_ing}.")
 
-        if current_status in ["starting", "stopping"]:
+        if current_status in ["starting", "stopping"] and action != "kill":
             if isinstance(ctx, discord.Interaction):
                 return await ctx.response.send_message("Another power action is already in progress.", ephemeral=True)
             return await ctx.send("Another power action is already in progress.")
@@ -148,7 +223,7 @@ class Pterodactyl(commands.Cog):
         channel = self.bot.get_channel(await config.console_channel())
         if isinstance(ctx, discord.Interaction):
             if channel:
-                await channel.send(f"Received console command from {ctx.user.id}: {command[:1900]}")
+                await channel.send(f"Received console command from {ctx.user.id}: {command[:1900]}", allowed_mentions=discord.AllowedMentions.none())
             try:
                 await self.websocket.send(json.dumps({"event": "send command", "args": [command]}))
                 await ctx.response.send_message(f"Command sent to server. {box(command, 'json')}", ephemeral=True)
@@ -160,7 +235,7 @@ class Pterodactyl(commands.Cog):
                 self.task = self.get_task()
         else:
             if channel:
-                await channel.send(f"Received console command from {ctx.author.id}: {command[:1900]}")
+                await channel.send(f"Received console command from {ctx.author.id}: {command[:1900]}", allowed_mentions=discord.AllowedMentions.none())
             try:
                 await self.websocket.send(json.dumps({"event": "send command", "args": [command]}))
                 await ctx.send(f"Command sent to server. {box(command, 'json')}")
@@ -191,6 +266,15 @@ class Pterodactyl(commands.Cog):
             The command to send to the server."""
         return await self.send_command(interaction, command)
 
+    @slash_pterodactyl.command(name = "players", description = "Retrieve a list of players on the server.")
+    async def slash_pterodactyl_players(self, interaction: discord.Interaction) -> None:
+        """Retrieve a list of players on the server."""
+        e = await self.get_player_list_embed(interaction)
+        if e:
+            await interaction.response.send_message(embed=e, ephemeral=True)
+        else:
+            await interaction.response.send_message("No players online.", ephemeral=True)
+
     @slash_pterodactyl.command(name = "power", description = "Send power actions to the server.")
     @app_commands.choices(action=[
         Choice(name="Start", value="start"),
@@ -207,12 +291,23 @@ class Pterodactyl(commands.Cog):
             The action to perform on the server."""
         if action.value == "kill":
             return await self.power(interaction, action.value, "stopping... (forcefully killed)", warning="**⚠️ Forcefully killing the server process can corrupt data in some cases. ⚠️**\n")
+        if action.value == "stop":
+            return await self.power(interaction, action.value, "stopping...")
         return await self.power(interaction, action.value, f"{action.value}ing...")
 
     @commands.group(autohelp = True, name = "pterodactyl", aliases = ["ptero"])
     async def pterodactyl(self, ctx: commands.Context) -> None:
         """Pterodactyl allows you to manage your Pterodactyl Panel from Discord."""
 
+    @pterodactyl.command(name = "players", aliases=["list", "online", "playerlist", "who"])
+    async def pterodactyl_players(self, ctx: commands.Context) -> None:
+        """Retrieve a list of players on the server."""
+        e = await self.get_player_list_embed(ctx)
+        if e:
+            await ctx.send(embed=e)
+        else:
+            await ctx.send("No players online.")
+
     @pterodactyl.command(name = "command", aliases = ["cmd", "execute", "exec"])
     @commands.admin()
     async def pterodactyl_command(self, ctx: commands.Context, *, command: str) -> None:
@@ -272,18 +367,60 @@ class Pterodactyl(commands.Cog):
         self.retry_counter = 0
         self.task = self.get_task()
 
-    @pterodactyl_config.command(name = "consolechannel")
+    @pterodactyl_config.group(name = "console")
+    async def pterodactyl_config_console(self, ctx: commands.Context):
+        """Configure console settings."""
+
+    @pterodactyl_config_console.command(name = "channel")
     async def pterodactyl_config_console_channel(self, ctx: commands.Context, channel: discord.TextChannel) -> None:
         """Set the channel to send console output to."""
         await config.console_channel.set(channel.id)
         await ctx.send(f"Console channel set to {channel.mention}")
 
+    @pterodactyl_config_console.command(name = "commands")
+    async def pterodactyl_config_console_commands(self, ctx: commands.Context, enabled: bool) -> None:
+        """Enable or disable console commands."""
+        await config.console_commands_enabled.set(enabled)
+        await ctx.send(f"Console commands set to {enabled}")
+
     @pterodactyl_config.command(name = "invite")
     async def pterodactyl_config_invite(self, ctx: commands.Context, invite: str) -> None:
         """Set the invite link for your server."""
         await config.invite.set(invite)
         await ctx.send(f"Invite link set to {invite}")
 
+    @pterodactyl_config.group(name = "topic")
+    async def pterodactyl_config_topic(self, ctx: commands.Context):
+        """Set the topic for the console and chat channels."""
+
+    @pterodactyl_config_topic.command(name = "host", aliases = ["hostname", "ip"])
+    async def pterodactyl_config_topic_host(self, ctx: commands.Context, host: str) -> None:
+        """Set the hostname or IP address of your server."""
+        await config.topic_hostname.set(host)
+        await ctx.send(f"Hostname/IP set to `{host}`")
+
+    @pterodactyl_config_topic.command(name = "port")
+    async def pterodactyl_config_topic_port(self, ctx: commands.Context, port: int) -> None:
+        """Set the port of your server."""
+        await config.topic_port.set(port)
+        await ctx.send(f"Port set to `{port}`")
+
+    @pterodactyl_config_topic.command(name = "text")
+    async def pterodactyl_config_topic_text(self, ctx: commands.Context, *, text: str) -> None:
+        """Set the text for the console and chat channels.
+
+        Available placeholders:
+        - `.$H` (hostname)
+        - `.$O` (port)
+        Available for Minecraft servers:
+        - `.$I` (ip)
+        - `.$M` (max players)
+        - `.$P` (players online)
+        - `.$V` (version)
+        - `.$D` (description / Message of the Day)"""
+        await config.topic.set(text)
+        await ctx.send(f"Topic set to:\n{box(text, 'yaml')}")
+
     @pterodactyl_config.group(name = "chat")
     async def pterodactyl_config_chat(self, ctx: commands.Context):
         """Configure chat settings."""
@@ -408,7 +545,7 @@ class Pterodactyl(commands.Cog):
                 await view.wait()
                 if view.result is True:
                     blacklist.update({name: regex})
-                    await msg.edit(f"Updated `{name}` in the regex blacklist.\n{box(regex, 're')}")
+                    await msg.edit(content=f"Updated `{name}` in the regex blacklist.\n{box(regex, 're')}")
                 else:
                     await msg.edit(content="Cancelled.")
 
@@ -423,7 +560,7 @@ class Pterodactyl(commands.Cog):
                 await view.wait()
                 if view.result is True:
                     del blacklist[name]
-                    await msg.edit(content="Removed `{name}` from the regex blacklist.")
+                    await msg.edit(content=f"Removed `{name}` from the regex blacklist.")
                 else:
                     await msg.edit(content="Cancelled.")
             else:
@@ -435,6 +572,7 @@ class Pterodactyl(commands.Cog):
         base_url = await config.base_url()
         server_id = await config.server_id()
         console_channel = await config.console_channel()
+        console_commands_enabled = await config.console_commands_enabled()
         chat_channel = await config.chat_channel()
         chat_command = await config.chat_command()
         chat_regex = await config.chat_regex()
@@ -450,10 +588,14 @@ class Pterodactyl(commands.Cog):
         api_endpoint = await config.api_endpoint()
         invite = await config.invite()
         regex_blacklist: dict = await config.regex_blacklist()
+        topic_text = await config.topic()
+        topic_hostname = await config.topic_hostname()
+        topic_port = await config.topic_port()
         embed = discord.Embed(color = await ctx.embed_color(), title="Pterodactyl Configuration")
         embed.description = f"""**Base URL:** {base_url}
                        **Server ID:** `{server_id}`
                        **Console Channel:** <#{console_channel}>
+                       **Console Commands:** {self.get_bool_str(console_commands_enabled)}
                        **Chat Channel:** <#{chat_channel}>
                        **Startup Message:** {startup_msg}
                        **Shutdown Message:** {shutdown_msg}
@@ -463,6 +605,10 @@ class Pterodactyl(commands.Cog):
                        **API Endpoint:** `{api_endpoint}`
                        **Invite:** {invite}
 
+                        **Topic Hostname:** `{topic_hostname}`
+                        **Topic Port:** `{topic_port}`
+                        **Topic Text:** {box(topic_text, 'yaml')}
+
                        **Chat Command:** {box(chat_command, 'json')}
                        **Chat Regex:** {box(chat_regex, 're')}
                        **Server Regex:** {box(server_regex, 're')}

pterodactyl/websocket.py

@@ -15,6 +15,7 @@ from pterodactyl.pterodactyl import Pterodactyl
 
 
 async def establish_websocket_connection(coginstance: Pterodactyl) -> None:
+    await coginstance.bot.wait_until_red_ready()
     base_url = await config.base_url()
     base_url = base_url[:-1] if base_url.endswith('/') else base_url
 
@@ -52,18 +53,18 @@ async def establish_websocket_connection(coginstance: Pterodactyl) -> None:
                     if await config.mask_ip() is True:
                         content = mask_ip(content)
 
-                    channel = coginstance.bot.get_channel(await config.console_channel())
+                    console_channel = coginstance.bot.get_channel(await config.console_channel())
-                    if channel is not None:
+                    chat_channel = coginstance.bot.get_channel(await config.chat_channel())
+                    if console_channel is not None:
                         if content.startswith('['):
                             pagified_content = pagify(content, delims=[" ", "\n"])
                             for page in pagified_content:
-                                await channel.send(content=page, allowed_mentions=discord.AllowedMentions.none())
+                                await console_channel.send(content=page, allowed_mentions=discord.AllowedMentions.none())
 
                     server_message = await check_if_server_message(content)
                     if server_message:
-                        channel = coginstance.bot.get_channel(await config.chat_channel())
+                        if chat_channel is not None:
-                        if channel is not None:
+                            await chat_channel.send(server_message if len(server_message) < 2000 else server_message[:1997] + '...', allowed_mentions=discord.AllowedMentions.none())
-                            await channel.send(server_message if len(server_message) < 2000 else server_message[:1997] + '...', allowed_mentions=discord.AllowedMentions.none())
 
                     chat_message = await check_if_chat_message(content)
                     if chat_message:
@@ -75,30 +76,27 @@ async def establish_websocket_connection(coginstance: Pterodactyl) -> None:
 
                     join_message = await check_if_join_message(content)
                     if join_message:
-                        channel = coginstance.bot.get_channel(await config.chat_channel())
+                        if chat_channel is not None:
-                        if channel is not None:
+                            if coginstance.bot.embed_requested(chat_channel):
-                            if coginstance.bot.embed_requested(channel):
+                                await chat_channel.send(embed=await generate_join_leave_embed(join_message, True))
-                                await channel.send(embed=await generate_join_leave_embed(join_message, True))
                             else:
-                                await channel.send(f"{join_message} joined the game", allowed_mentions=discord.AllowedMentions.none())
+                                await chat_channel.send(f"{join_message} joined the game", allowed_mentions=discord.AllowedMentions.none())
 
                     leave_message = await check_if_leave_message(content)
                     if leave_message:
-                        channel = coginstance.bot.get_channel(await config.chat_channel())
+                        if chat_channel is not None:
-                        if channel is not None:
+                            if coginstance.bot.embed_requested(chat_channel):
-                            if coginstance.bot.embed_requested(channel):
+                                await chat_channel.send(embed=await generate_join_leave_embed(leave_message, False))
-                                await channel.send(embed=await generate_join_leave_embed(leave_message, False))
                             else:
-                                await channel.send(f"{leave_message} left the game", allowed_mentions=discord.AllowedMentions.none())
+                                await chat_channel.send(f"{leave_message} left the game", allowed_mentions=discord.AllowedMentions.none())
 
                     achievement_message = await check_if_achievement_message(content)
                     if achievement_message:
-                        channel = coginstance.bot.get_channel(await config.chat_channel())
+                        if chat_channel is not None:
-                        if channel is not None:
+                            if coginstance.bot.embed_requested(chat_channel):
-                            if coginstance.bot.embed_requested(channel):
+                                await chat_channel.send(embed=await generate_achievement_embed(achievement_message['username'], achievement_message['achievement'], achievement_message['challenge']))
-                                await channel.send(embed=await generate_achievement_embed(achievement_message['username'], achievement_message['achievement'], achievement_message['challenge']))
                             else:
-                                await channel.send(f"{achievement_message['username']} has {'completed the challenge' if achievement_message['challenge'] else 'made the advancement'} {achievement_message['achievement']}")
+                                await chat_channel.send(f"{achievement_message['username']} has {'completed the challenge' if achievement_message['challenge'] else 'made the advancement'} {achievement_message['achievement']}")
 
             if message['event'] == 'status':
                 old_status = await config.current_status()

pyproject.toml

@@ -5,20 +5,21 @@ description = "My assorted cogs for Red-DiscordBot."
 authors = ["SeaswimmerTheFsh"]
 license = "MPL 2"
 readme = "README.md"
+package-mode = false
 
 [tool.poetry.dependencies]
 python = ">=3.11,<3.12"
 Red-DiscordBot = "^3.5.5"
-pytimeparse2 = "^1.7.1"
-humanize = "^4.8.0"
 py-dactyl = "^2.0.4"
 websockets = "^12.0"
+pillow = "^10.3.0"
+numpy = "^1.26.4"
 
 [tool.poetry.group.dev]
 optional = true
 
 [tool.poetry.group.dev.dependencies]
-ruff = "^0.2.1"
+ruff = "^0.3.1"
 pylint = "^3.1.0"
 
 [tool.poetry.group.docs]