Merge branch 'main' of https://github.com/python-discord/sir-lancebot

7 files changed, 57 insertions, 34 deletions

diff --git a/bot/__init__.py b/bot/__init__.py
index ae53a5a5..3136c863 100644
--- a/bot/__init__.py
+++ b/bot/__init__.py
@@ -43,6 +43,11 @@ if os.name == "nt":
 
 monkey_patches.patch_typing()
 
+# This patches any convertors that use PartialMessage, but not the PartialMessageConverter itself
+# as library objects are made by this mapping.
+# https://github.com/Rapptz/discord.py/blob/1a4e73d59932cdbe7bf2c281f25e32529fc7ae1f/discord/ext/commands/converter.py#L984-L1004
+commands.converter.PartialMessageConverter = monkey_patches.FixedPartialMessageConverter
+
 # Monkey-patch discord.py decorators to use the both the Command and Group subclasses which supports root aliases.
 # Must be patched before any cogs are added.
 commands.command = partial(commands.command, cls=monkey_patches.Command)
diff --git a/bot/constants.py b/bot/constants.py
index f4b1cab0..854fbe55 100644
--- a/bot/constants.py
+++ b/bot/constants.py
@@ -23,6 +23,7 @@ __all__ = (
     "Reddit",
     "RedisConfig",
     "RedirectOutput",
+    "PYTHON_PREFIX"
     "MODERATION_ROLES",
     "STAFF_ROLES",
     "WHITELISTED_CHANNELS",
@@ -34,6 +35,8 @@ __all__ = (
 log = logging.getLogger(__name__)
 
 
+PYTHON_PREFIX = "!"
+
 @dataclasses.dataclass
 class AdventOfCodeLeaderboard:
     id: str
diff --git a/bot/exts/core/error_handler.py b/bot/exts/core/error_handler.py
index fd2123e7..676a1e70 100644
--- a/bot/exts/core/error_handler.py
+++ b/bot/exts/core/error_handler.py
@@ -12,7 +12,7 @@ from sentry_sdk import push_scope
 from bot.bot import Bot
 from bot.constants import Channels, Colours, ERROR_REPLIES, NEGATIVE_REPLIES, RedirectOutput
 from bot.utils.decorators import InChannelCheckFailure, InMonthCheckFailure
-from bot.utils.exceptions import APIError, UserNotPlayingError
+from bot.utils.exceptions import APIError, MovedCommandError, UserNotPlayingError
 
 log = logging.getLogger(__name__)
 
@@ -130,6 +130,14 @@ class CommandErrorHandler(commands.Cog):
             )
             return
 
+        if isinstance(error, MovedCommandError):
+            description = (
+                f"This command, `{ctx.prefix}{ctx.command.qualified_name}` has moved to `{error.new_command_name}`.\n"
+                f"Please use `{error.new_command_name}` instead."
+            )
+            await ctx.send(embed=self.error_embed(description, NEGATIVE_REPLIES))
+            return
+
         with push_scope() as scope:
             scope.user = {
                 "id": ctx.author.id,
diff --git a/bot/exts/holidays/valentines/be_my_valentine.py b/bot/exts/holidays/valentines/be_my_valentine.py
index 4d454c3a..1572d474 100644
--- a/bot/exts/holidays/valentines/be_my_valentine.py
+++ b/bot/exts/holidays/valentines/be_my_valentine.py
@@ -7,14 +7,16 @@ import discord
 from discord.ext import commands
 
 from bot.bot import Bot
-from bot.constants import Channels, Colours, Lovefest, Month
+from bot.constants import Channels, Colours, Lovefest, Month, PYTHON_PREFIX
 from bot.utils.decorators import in_month
-from bot.utils.extensions import invoke_help_command
+from bot.utils.exceptions import MovedCommandError
 
 log = logging.getLogger(__name__)
 
 HEART_EMOJIS = [":heart:", ":gift_heart:", ":revolving_hearts:", ":sparkling_heart:", ":two_hearts:"]
 
+MOVED_COMMAND = f"{PYTHON_PREFIX}subscribe"
+
 
 class BeMyValentine(commands.Cog):
     """A cog that sends Valentines to other users!"""
@@ -30,40 +32,14 @@ class BeMyValentine(commands.Cog):
         return loads(p.read_text("utf8"))
 
     @in_month(Month.FEBRUARY)
-    @commands.group(name="lovefest")
+    @commands.command(name="lovefest", help=f"NOTE: This command has been moved to {MOVED_COMMAND}")
     async def lovefest_role(self, ctx: commands.Context) -> None:
         """
-        Subscribe or unsubscribe from the lovefest role.
-
-        The lovefest role makes you eligible to receive anonymous valentines from other users.
+        Deprecated lovefest role command.
 
-        1) use the command \".lovefest sub\" to get the lovefest role.
-        2) use the command \".lovefest unsub\" to get rid of the lovefest role.
+        This command has been moved to bot, and will be removed in the future.
         """
-        if not ctx.invoked_subcommand:
-            await invoke_help_command(ctx)
-
-    @lovefest_role.command(name="sub")
-    async def add_role(self, ctx: commands.Context) -> None:
-        """Adds the lovefest role."""
-        user = ctx.author
-        role = ctx.guild.get_role(Lovefest.role_id)
-        if role not in ctx.author.roles:
-            await user.add_roles(role)
-            await ctx.send("The Lovefest role has been added !")
-        else:
-            await ctx.send("You already have the role !")
-
-    @lovefest_role.command(name="unsub")
-    async def remove_role(self, ctx: commands.Context) -> None:
-        """Removes the lovefest role."""
-        user = ctx.author
-        role = ctx.guild.get_role(Lovefest.role_id)
-        if role not in ctx.author.roles:
-            await ctx.send("You dont have the lovefest role.")
-        else:
-            await user.remove_roles(role)
-            await ctx.send("The lovefest role has been successfully removed!")
+        raise MovedCommandError(MOVED_COMMAND)
 
     @commands.cooldown(1, 1800, commands.BucketType.user)
     @commands.group(name="bemyvalentine", invoke_without_command=True)
diff --git a/bot/exts/utilities/bookmark.py b/bot/exts/utilities/bookmark.py
index a11c366b..b50205a0 100644
--- a/bot/exts/utilities/bookmark.py
+++ b/bot/exts/utilities/bookmark.py
@@ -102,7 +102,7 @@ class Bookmark(commands.Cog):
                     "You must either provide a valid message to bookmark, or reply to one."
                     "\n\nThe lookup strategy for a message is as follows (in order):"
                     "\n1. Lookup by '{channel ID}-{message ID}' (retrieved by shift-clicking on 'Copy ID')"
-                    "\n2. Lookup by message ID (the message **must** have been sent after the bot last started)"
+                    "\n2. Lookup by message ID (the message **must** be in the context channel)"
                     "\n3. Lookup by message URL"
                 )
             target_message = ctx.message.reference.resolved
diff --git a/bot/monkey_patches.py b/bot/monkey_patches.py
index fa6627d1..19965c19 100644
--- a/bot/monkey_patches.py
+++ b/bot/monkey_patches.py
@@ -1,10 +1,12 @@
 import logging
+import re
 from datetime import datetime, timedelta
 
 from discord import Forbidden, http
 from discord.ext import commands
 
 log = logging.getLogger(__name__)
+MESSAGE_ID_RE = re.compile(r'(?P<message_id>[0-9]{15,20})$')
 
 
 class Command(commands.Command):
@@ -65,3 +67,25 @@ def patch_typing() -> None:
             pass
 
     http.HTTPClient.send_typing = honeybadger_type
+
+
+class FixedPartialMessageConverter(commands.PartialMessageConverter):
+    """
+    Make the Message converter infer channelID from the given context if only a messageID is given.
+
+    Discord.py's Message converter is supposed to infer channelID based
+    on ctx.channel if only a messageID is given. A refactor commit, linked below,
+    a few weeks before d.py's archival broke this defined behaviour of the converter.
+    Currently, if only a messageID is given to the converter, it will only find that message
+    if it's in the bot's cache.
+
+    https://github.com/Rapptz/discord.py/commit/1a4e73d59932cdbe7bf2c281f25e32529fc7ae1f
+    """
+
+    @staticmethod
+    def _get_id_matches(ctx: commands.Context, argument: str) -> tuple[int, int, int]:
+        """Inserts ctx.channel.id before calling super method if argument is just a messageID."""
+        match = MESSAGE_ID_RE.match(argument)
+        if match:
+            argument = f"{ctx.channel.id}-{match.group('message_id')}"
+        return commands.PartialMessageConverter._get_id_matches(ctx, argument)
diff --git a/bot/utils/exceptions.py b/bot/utils/exceptions.py
index bf0e5813..3cd96325 100644
--- a/bot/utils/exceptions.py
+++ b/bot/utils/exceptions.py
@@ -15,3 +15,10 @@ class APIError(Exception):
         self.api = api
         self.status_code = status_code
         self.error_msg = error_msg
+
+
+class MovedCommandError(Exception):
+    """Raised when a command has moved locations."""
+
+    def __init__(self, new_command_name: str):
+        self.new_command_name = new_command_name