Add original sender profile reply mode

Author: LilasKR

README.md

@@ -168,6 +168,7 @@ The required scopes are:
 And the required permissions:
 - Embed Links
 - Manage Messages
+- Manage Webhooks
 - Read Message History
 - Send Messages
 - Send Messages in Threads

cogs/link_fix.py

@@ -21,6 +21,7 @@
 __all__ = ('LinkFix',)
 
 _logger = logging.getLogger(__name__)
+WEBHOOK_NAME = "FixTweetBot"
 
 
 def get_website(guild: Guild, url: str, spoiler: bool = False) -> WebsiteLink | None:
@@ -136,7 +137,13 @@ async def fix_embeds(
         or (isinstance(channel, discore.Thread) and (channel.locked or channel.archived))):
         return
 
-    async with Typing(channel):
+    if not guild.reply_as_original_sender_profile:
+        async with Typing(channel):
+            rendered_links = [link for link in links if await link.render()]
+            if not rendered_links:
+                return
+            not_sent, messages = await send_fixed_links(rendered_links, guild, original_message)
+    else:
         rendered_links = [link for link in links if await link.render()]
         if not rendered_links:
             return
@@ -200,9 +207,15 @@ async def send_fixed_links(
     links_failed: list[tuple[str, list[WebsiteLink]]] = []
 
     grouped = group_items(rendered_links, 2000)
+    use_original_sender_profile = guild.reply_as_original_sender_profile
+    webhook = await get_or_create_webhook(original_message.channel) if use_original_sender_profile else None
+    if use_original_sender_profile and webhook is None:
+        return [(message_content, links_in_group) for message_content, links_in_group in grouped], messages_sent
 
     for i, (message_content, links_in_group) in enumerate(grouped):
-        if i == 0 and guild.reply_to_message:
+        if webhook is not None:
+            coro = webhook_send(webhook, original_message, message_content, guild.reply_silently)
+        elif i == 0 and guild.reply_to_message:
             coro = discore.fallback_reply(original_message, message_content, silent=guild.reply_silently)
         else:
             coro = original_message.channel.send(message_content, silent=guild.reply_silently)
@@ -216,6 +229,64 @@ async def send_fixed_links(
     return links_failed, messages_sent
 
 
+async def get_or_create_webhook(channel: discore.TextChannel | discore.Thread) -> discore.Webhook | None:
+    """
+    Get or create the webhook used to send messages as the original sender.
+
+    :param channel: the channel to send the fixed links to
+    :return: the webhook to use, if available
+    """
+
+    webhook_channel = channel.parent if isinstance(channel, discore.Thread) else channel
+    if webhook_channel is None:
+        return None
+
+    if not webhook_channel.permissions_for(channel.guild.me).manage_webhooks:
+        return None
+
+    try:
+        webhooks = await webhook_channel.webhooks()
+    except discore.HTTPException:
+        _logger.exception("Failed to fetch webhooks")
+        return None
+    webhook = next((
+        w for w in webhooks
+        if w.name == WEBHOOK_NAME and getattr(w.user, 'id', None) == channel.guild.me.id
+    ), None)
+    if webhook is not None:
+        return webhook
+    sent, webhook = await safe_send_coro(webhook_channel.create_webhook(name=WEBHOOK_NAME), forbidden=True)
+    return webhook if sent else None
+
+
+async def webhook_send(
+        webhook: discore.Webhook,
+        original_message: discore.Message,
+        content: str,
+        silent: bool
+) -> discore.Message:
+    """
+    Send a fixed link using the original sender's display name and avatar.
+
+    :param webhook: the webhook to use
+    :param original_message: the message associated with the context to reply to
+    :param content: the content to send
+    :param silent: whether to send the message silently
+    :return: the message created by the webhook
+    """
+
+    kwargs = {
+        'content': content,
+        'username': original_message.author.display_name,
+        'avatar_url': original_message.author.display_avatar.url,
+        'silent': silent,
+        'wait': True
+    }
+    if isinstance(original_message.channel, discore.Thread):
+        kwargs['thread'] = original_message.channel
+    return await webhook.send(**kwargs)
+
+
 async def wait_for_embed(message: discore.Message) -> bool:
     """
     Wait for the message to have embeds.

database/models/Guild.py

@@ -61,6 +61,7 @@ class Guild(DiscordRepresentation):
         'roles_use_any_rule': bool,
         'reply_to_message': bool,
         'reply_silently': bool,
+        'reply_as_original_sender_profile': bool,
         'webhooks': bool,
         'original_message': OriginalMessage,
         'twitter_view': FxEmbedView,

locales/en-US.yml

@@ -56,6 +56,9 @@ settings:
     read_message_history:
       "true": "🟢 `Read message history` permission"
       "false": "🔴 Missing `read message history` permission"
+    manage_webhooks:
+      "true": "🟢 `Manage webhooks` permission"
+      "false": "🔴 Missing `manage webhooks` permission"
   filters:
     button:
       toggle:
@@ -148,7 +151,7 @@ settings:
   reply_method:
     name: "Reply method"
     description: "Change the behavior on the reply"
-    content: "**Change what to do on the reply**\n- %{state}\n- %{silent}%{perms}"
+    content: "**Change what to do on the reply**\n- %{state}\n- %{silent}\n- %{avatar}%{perms}"
     reply:
       button:
         "true": "Replying"
@@ -163,6 +166,13 @@ settings:
       state:
         "true": "🔕 Send silently"
         "false": "🔔 Send with a notification"
+    original_sender_profile:
+      button:
+        "true": "Send as Original Sender Profile"
+        "false": "Send as Bot Profile"
+      state:
+        "true": "🪪 Send as Original Sender Profile"
+        "false": "🤖 Send as Bot Profile"
   webhooks:
     name: "Webhooks"
     description: "Enable/Disable for webhooks"

locales/ko.yml

@@ -53,6 +53,9 @@ settings:
     read_message_history:
       "true": "🟢 `메시지 기록 보기` 권한"
       "false": "🔴 `메시지 기록 보기` 권한 없음"
+    manage_webhooks:
+      "true": "🟢 `웹후크 관리하기` 권한"
+      "false": "🔴 `웹후크 관리하기` 권한 없음"
   filters:
     button:
       toggle:
@@ -145,7 +148,7 @@ settings:
   reply_method:
     name: "답장 방법"
     description: "답장할 때의 동작 변경하기"
-    content: "**답장할 때 수행할 작업 변경하기**\n- %{state}\n- %{silent}%{perms}"
+    content: "**답장할 때 수행할 작업 변경하기**\n- %{state}\n- %{silent}\n- %{avatar}%{perms}"
     reply:
       button:
         "true": "답장"
@@ -160,6 +163,13 @@ settings:
       state:
         "true": "🔕 조용히 보내기"
         "false": "🔔 알림과 함께 보내기"
+    original_sender_profile:
+      button:
+        "true": "원본 작성자 프로필로 보내기"
+        "false": "봇 프로필로 보내기"
+      state:
+        "true": "🪪 원본 작성자 프로필로 보내기"
+        "false": "🤖 봇 프로필로 보내기"
   webhooks:
     name: "웹후크"
     description: "웹후크 활성화/비활성화하기"

src/settings.py

@@ -1125,6 +1125,7 @@ def __init__(self, interaction: discore.Interaction, view: SettingsView, ctx: Da
         super().__init__(interaction, view, ctx)
         self.reply_to_message = bool(ctx.guild.reply_to_message)
         self.reply_silently = bool(ctx.guild.reply_silently)
+        self.reply_as_original_sender_profile = bool(ctx.guild.reply_as_original_sender_profile)
 
     @property
     async def embed(self) -> discore.Embed:
@@ -1137,21 +1138,29 @@ async def embed(self) -> discore.Embed:
             perms.append('send_messages_in_threads')
         if self.reply_to_message:
             perms.append('read_message_history')
+        if self.reply_as_original_sender_profile:
+            perms.append('manage_webhooks')
         embed = discore.Embed(
             title=f"{self.emoji} {t(self.name)}",
             description=t(
                 'settings.reply_method.content',
                 state=t(f'settings.reply_method.reply.state.{l(self.reply_to_message)}', emoji=self.emoji),
                 silent=t(f'settings.reply_method.silent.state.{l(self.reply_silently)}'),
+                avatar=t(f'settings.reply_method.original_sender_profile.state.{l(self.reply_as_original_sender_profile)}'),
                 perms=format_perms(perms, self.ctx.channel.discord_object))
         )
         discore.set_embed_footer(self.bot, embed)
         return embed
 
     @property
     async def option(self) -> discore.SelectOption:
+        has_missing_perms = (
+            (self.reply_to_message and is_missing_perm(['read_message_history'], self.ctx.channel.discord_object))
+            or (self.reply_as_original_sender_profile
+                and is_missing_perm(['manage_webhooks'], self.ctx.channel.discord_object))
+        )
         return discore.SelectOption(
-            label=('⚠️ ' if self.reply_to_message and is_missing_perm(['read_message_history'], self.ctx.channel.discord_object) else '')
+            label=('⚠️ ' if has_missing_perms else '')
                   + t(self.name),
             value=self.id,
             description=t(self.description),
@@ -1172,7 +1181,13 @@ async def items(self) -> List[discore.ui.Item]:
             custom_id='reply_silently'
         )
         edit_callback(reply_silently_button, self.view, self.toggle_reply_silently)
-        return [reply_to_message_button, reply_silently_button]
+        original_sender_profile_button = discore.ui.Button(
+            style=discore.ButtonStyle.primary if self.reply_as_original_sender_profile else discore.ButtonStyle.secondary,
+            label=t(f'settings.reply_method.original_sender_profile.button.{l(self.reply_as_original_sender_profile)}'),
+            custom_id='reply_as_original_sender_profile'
+        )
+        edit_callback(original_sender_profile_button, self.view, self.toggle_reply_as_original_sender_profile)
+        return [reply_to_message_button, reply_silently_button, original_sender_profile_button]
 
     async def toggle_reply_to_message(self, view: SettingsView, interaction: discore.Interaction, _) -> None:
         self.reply_to_message = not self.reply_to_message
@@ -1184,6 +1199,11 @@ async def toggle_reply_silently(self, view: SettingsView, interaction: discore.I
         self.ctx.guild.update({'reply_silently': self.reply_silently})
         await view.refresh(interaction)
 
+    async def toggle_reply_as_original_sender_profile(self, view: SettingsView, interaction: discore.Interaction, _) -> None:
+        self.reply_as_original_sender_profile = not self.reply_as_original_sender_profile
+        self.ctx.guild.update({'reply_as_original_sender_profile': self.reply_as_original_sender_profile})
+        await view.refresh(interaction)
+
 
 class WebhooksSetting(BaseSetting):
     """Represents the webhooks setting (respond to webhooks or not)"""