From 6be0e91d1b7282febd39415fd33e6d3f6a0b0581 Mon Sep 17 00:00:00 2001 From: AbooMinister25 Date: Mon, 8 Aug 2022 18:09:24 -0400 Subject: Refactored methods _get_discord_message, _get_text_and_embed, and _convert_embed into bot/utils/messages.py --- bot/utils/messages.py | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 71 insertions(+), 1 deletion(-) (limited to 'bot/utils/messages.py') diff --git a/bot/utils/messages.py b/bot/utils/messages.py index a6c035f9..ccc8b61c 100644 --- a/bot/utils/messages.py +++ b/bot/utils/messages.py @@ -1,5 +1,12 @@ +import logging import re -from typing import Optional +from typing import Callable, Optional, Union + +from discord import Embed, Message +from discord.ext import commands +from discord.ext.commands import Context, MessageConverter + +log = logging.getLogger(__name__) def sub_clyde(username: Optional[str]) -> Optional[str]: @@ -17,3 +24,66 @@ def sub_clyde(username: Optional[str]) -> Optional[str]: return re.sub(r"(clyd)(e)", replace_e, username, flags=re.I) else: return username # Empty string or None + + +async def get_discord_message(ctx: Context, text: str) -> Union[Message, str]: + """ + Attempts to convert a given `text` to a discord Message object and return it. + + Conversion will succeed if given a discord Message ID or link. + Returns `text` if the conversion fails. + """ + try: + text = await MessageConverter().convert(ctx, text) + except commands.BadArgument: + log.debug(f"Input '{text:.20}...' is not a valid Discord Message") + + return text + + +async def get_text_and_embed(ctx: Context, text: str) -> tuple[str, Optional[Embed]]: + """ + Attempts to extract the text and embed from a possible link to a discord Message. + + Does not retrieve the text and embed from the Message if it is in a channel the user does + not have read permissions in. + + Returns a tuple of: + str: If `text` is a valid discord Message, the contents of the message, else `text`. + Optional[Embed]: The embed if found in the valid Message, else None + """ + embed: Optional[Embed] = None + + msg = await get_discord_message(ctx, text) + # Ensure the user has read permissions for the channel the message is in + if isinstance(msg, Message): + permissions = msg.channel.permissions_for(ctx.author) + if permissions.read_messages: + text = msg.clean_content + # Take first embed because we can't send multiple embeds + if msg.embeds: + embed = msg.embeds[0] + + return (text, embed) + + +def convert_embed(func: Callable[[str, ], str], embed: Embed) -> Embed: + """ + Converts the text in an embed using a given conversion function, then return the embed. + + Only modifies the following fields: title, description, footer, fields + """ + embed_dict = embed.to_dict() + + embed_dict["title"] = func(embed_dict.get("title", "")) + embed_dict["description"] = func(embed_dict.get("description", "")) + + if "footer" in embed_dict: + embed_dict["footer"]["text"] = func(embed_dict["footer"].get("text", "")) + + if "fields" in embed_dict: + for field in embed_dict["fields"]: + field["name"] = func(field.get("name", "")) + field["value"] = func(field.get("value", "")) + + return Embed.from_dict(embed_dict) -- cgit v1.2.3 From f0455f9ae865e5d424e84cafdb52bc17f25b3db5 Mon Sep 17 00:00:00 2001 From: AbooMinister25 Date: Mon, 8 Aug 2022 20:44:18 -0400 Subject: Refactored get_discord_message to not unnecessarily log, and cleaned up uwu_command --- bot/exts/fun/uwu.py | 26 +++++++++----------------- bot/utils/messages.py | 8 ++------ 2 files changed, 11 insertions(+), 23 deletions(-) (limited to 'bot/utils/messages.py') diff --git a/bot/exts/fun/uwu.py b/bot/exts/fun/uwu.py index 60a5834d..83497893 100644 --- a/bot/exts/fun/uwu.py +++ b/bot/exts/fun/uwu.py @@ -11,9 +11,6 @@ from discord.ext.commands import Cog, Context, clean_content from bot.bot import Bot from bot.utils import helpers, messages -if t.TYPE_CHECKING: - from bot.exts.fun.fun import Fun # pragma: no cover - WORD_REPLACE = { "small": "smol", "cute": "kawaii~", @@ -180,21 +177,16 @@ class Uwu(Cog): await clean_content(fix_channel_mentions=True).convert(ctx, text) - fun_cog: t.Optional[Fun] = ctx.bot.get_cog("Fun") - - if fun_cog: - # Grabs the text from the embed for uwuification - if embeds: - embed = messages.convert_embed(self._uwuify, embeds[0]) - else: - # Parse potential message links in text - text, embed = await messages.get_text_and_embed(ctx, text) - - # If an embed is found, grab and uwuify its text - if embed: - embed = messages.convert_embed(self._uwuify, embed) + # Grabs the text from the embed for uwuification + if embeds: + embed = messages.convert_embed(self._uwuify, embeds[0]) else: - embed = None + # Parse potential message links in text + text, embed = await messages.get_text_and_embed(ctx, text) + + # If an embed is found, grab and uwuify its text + if embed: + embed = messages.convert_embed(self._uwuify, embed) # Adds the text harvested from an embed to be put into another quote block. if text: diff --git a/bot/utils/messages.py b/bot/utils/messages.py index ccc8b61c..71b634e8 100644 --- a/bot/utils/messages.py +++ b/bot/utils/messages.py @@ -3,7 +3,6 @@ import re from typing import Callable, Optional, Union from discord import Embed, Message -from discord.ext import commands from discord.ext.commands import Context, MessageConverter log = logging.getLogger(__name__) @@ -33,10 +32,7 @@ async def get_discord_message(ctx: Context, text: str) -> Union[Message, str]: Conversion will succeed if given a discord Message ID or link. Returns `text` if the conversion fails. """ - try: - text = await MessageConverter().convert(ctx, text) - except commands.BadArgument: - log.debug(f"Input '{text:.20}...' is not a valid Discord Message") + text = await MessageConverter().convert(ctx, text) return text @@ -64,7 +60,7 @@ async def get_text_and_embed(ctx: Context, text: str) -> tuple[str, Optional[Emb if msg.embeds: embed = msg.embeds[0] - return (text, embed) + return text, embed def convert_embed(func: Callable[[str, ], str], embed: Embed) -> Embed: -- cgit v1.2.3 From 2354d05a1a3ec029a5d85d753e5147c000f53044 Mon Sep 17 00:00:00 2001 From: AbooMinister25 Date: Tue, 9 Aug 2022 18:48:39 -0400 Subject: Add error handling to get_discord_message --- bot/utils/messages.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'bot/utils/messages.py') diff --git a/bot/utils/messages.py b/bot/utils/messages.py index 71b634e8..b0c95583 100644 --- a/bot/utils/messages.py +++ b/bot/utils/messages.py @@ -3,6 +3,7 @@ import re from typing import Callable, Optional, Union from discord import Embed, Message +from discord.ext import commands from discord.ext.commands import Context, MessageConverter log = logging.getLogger(__name__) @@ -32,7 +33,10 @@ async def get_discord_message(ctx: Context, text: str) -> Union[Message, str]: Conversion will succeed if given a discord Message ID or link. Returns `text` if the conversion fails. """ - text = await MessageConverter().convert(ctx, text) + try: + text = await MessageConverter().convert(ctx, text) + except commands.BadArgument: + pass return text -- cgit v1.2.3