Add support for replies to help snippets (#3538)

* Added get_reference_message helper

* Implemented get_reference_message in get_command_ctx

* Moved the ctx.send variant of get_command_ctx to the else branch

* Moved get_reference message from ext/info/tags.py to utils/messages.py

* Added functionality from get_reference_message

* Added send_or_reply helper

* Make send_or_reply return the discord.Message instead of None

* Change the use of bare get_reference_message for the send_or_reply helper to avoid repetition

* Refactor get_reference_message to avoid fetching messages manually and include else in the try block for clarity.

* Add a check for referece.message_id for fetch_message to not complaint, and now referenced_message can be taken from cache or fetched

* Reconstruct the reference to avoid HTTPException in case the reply can't succesfuly get the reference

* Update the docstring to match current behavior

* Fix the send_or_reply indentation

Author: Saber0324

bot/exts/info/pep.py

@@ -6,6 +6,7 @@
 
 from bot.bot import Bot
 from bot.log import get_logger
+from bot.utils.messages import send_or_reply
 
 log = get_logger(__name__)
 
@@ -93,8 +94,7 @@ async def pep_command(self, ctx: Context, pep_number: int) -> None:
                 colour=Colour.red(),
             )
 
-        await ctx.send(embed=embed)
-
+        await send_or_reply(ctx, embed)
 
 async def setup(bot: Bot) -> None:
     """Load the PEP cog."""

bot/exts/info/resources.py

@@ -5,6 +5,7 @@
 from discord.ext import commands
 
 from bot.bot import Bot
+from bot.utils.messages import send_or_reply
 
 REGEX_CONSECUTIVE_NON_LETTERS = r"[^A-Za-z0-9]+"
 RESOURCE_URL = "https://www.pythondiscord.com/resources/"
@@ -61,7 +62,7 @@ async def resources_command(self, ctx: commands.Context, *, resource_topic: str
                         f"of hand-selected learning resources that we "
                         f"regularly recommend to both beginners and experts."
         )
-        await ctx.send(embed=embed)
+        await send_or_reply(ctx, embed)
 
 
 async def setup(bot: Bot) -> None:

bot/exts/info/source.py

@@ -9,6 +9,7 @@
 from bot.bot import Bot
 from bot.constants import URLs
 from bot.exts.info.tags import TagIdentifier
+from bot.utils.messages import send_or_reply
 
 SourceObject = commands.HelpCommand | commands.Command | commands.Cog | TagIdentifier | commands.ExtensionNotLoaded
 
@@ -40,12 +41,14 @@ async def source_command(
             embed = Embed(title="Bot's GitHub Repository")
             embed.add_field(name="Repository", value=f"[Go to GitHub]({URLs.github_bot_repo})")
             embed.set_thumbnail(url="https://avatars1.githubusercontent.com/u/9919")
-            await ctx.send(embed=embed)
+
+            await send_or_reply(ctx, embed)
             return
 
         obj, source_type = await self.get_source_object(ctx, source_item)
         embed = await self.build_embed(obj, source_type)
-        await ctx.send(embed=embed)
+
+        await send_or_reply(ctx, embed)
 
     @staticmethod
     async def get_source_object(ctx: commands.Context, argument: str) -> tuple[SourceObject, SourceType]:

bot/exts/info/tags.py

@@ -13,7 +13,7 @@
 from bot.bot import Bot
 from bot.log import get_logger
 from bot.pagination import LinePaginator
-from bot.utils.messages import wait_for_deletion
+from bot.utils.messages import send_or_reply, wait_for_deletion
 
 log = get_logger(__name__)
 
@@ -305,7 +305,7 @@ async def get_command_ctx(
         if embed is not COOLDOWN.obj:
 
             await wait_for_deletion(
-                await ctx.send(embed=embed),
+                await send_or_reply(ctx, embed),
                 (ctx.author.id,)
             )
         # A valid tag was found and was either sent, or is on cooldown

bot/utils/messages.py

@@ -7,7 +7,7 @@
 from itertools import zip_longest
 
 import discord
-from discord import Message
+from discord import DeletedReferencedMessage, Embed, Message
 from discord.ext.commands import Context
 from pydis_core.site_api import ResponseCodeError
 from pydis_core.utils import scheduling
@@ -285,3 +285,35 @@ async def upload_log(
         raise
 
     return f"{URLs.site_logs_view}/{response['id']}"
+
+async def get_reference_message(ctx: Context) -> Message | None:
+    """Return a message reference if the reference exists and it does not refer to the author of the message."""
+    if (ctx.message.reference is None
+        or ctx.message.reference.message_id is None):
+        return None
+    try:
+        referenced_message = (
+        ctx.message.reference.resolved
+        or ctx.message.reference.cached_message
+        or await ctx.fetch_message(ctx.message.reference.message_id)
+        )
+    except (discord.Forbidden, discord.NotFound):
+        return None
+    else:
+        if referenced_message is None or isinstance(referenced_message, DeletedReferencedMessage):
+            return None
+        if referenced_message.author == ctx.author:
+            return None
+        return referenced_message
+
+async def send_or_reply(ctx: Context, embed: Embed) -> Message:
+    """
+    Sends the bot message as a reply if the callers message has a reference.
+
+    If the callers message does not have a reference or the reference is deleted,
+    the bot messsage is sent without replying.
+    """
+    if message_reference := await get_reference_message(ctx):
+        reference = message_reference.to_reference(fail_if_not_exists=False)
+        return await ctx.send(embed=embed, reference=reference)
+    return await ctx.send(embed=embed)