Implement custom emoji uploading

Author: object-Object

CHANGELOG.md

@@ -8,6 +8,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 
 ### Changed
 
+* Implemented a system for custom application emoji, currently only used by the "apps icon" when resending a private message publicly.
 * Updated discord.py to `2.5.0`.
 
 ## `0.2.2` - 2025-02-17

bot/src/ghutils/cogs/commands/sync.py

@@ -35,6 +35,13 @@ async def sync_all(self, ctx: GHUtilsContext):
 
         await ctx.reply("Synced global slash commands to all guilds.")
 
+    @sync.command(name="emoji", aliases=["emojis", "emotes"])
+    async def sync_emoji(self, ctx: GHUtilsContext):
+        async with ctx.channel.typing():
+            await self.bot.sync_custom_emojis()
+
+        await ctx.reply("Synced custom bot emojis.")
+
     @commands.group(invoke_without_command=True)
     @commands.guild_only()
     async def clear(self, ctx: GHUtilsContext):

bot/src/ghutils/cogs/events.py

@@ -17,6 +17,7 @@ class EventsCog(GHUtilsCog):
     async def on_ready(self):
         logger.info(f"Logged in as {self.bot.user}")
         self.bot.add_dynamic_items(PermanentDeleteButton)
+        await self.bot.fetch_custom_emojis()
 
     @Cog.listener()
     async def on_interaction(self, interaction: Interaction):

bot/src/ghutils/core/bot.py

@@ -5,7 +5,7 @@
 from typing import Any
 
 import yaml
-from discord import Color, CustomActivity, Intents, Interaction
+from discord import Color, CustomActivity, Emoji, Intents, Interaction
 from discord.app_commands import AppCommandContext, AppInstallationType
 from discord.ext import commands
 from discord.ext.commands import Bot, Context, NoEntryPointError
@@ -21,7 +21,7 @@
 from .env import GHUtilsEnv
 from .translator import GHUtilsTranslator
 from .tree import GHUtilsCommandTree
-from .types import LoginState
+from .types import CustomEmoji, LoginState
 
 logger = logging.getLogger(__name__)
 
@@ -50,6 +50,7 @@ def __post_init__(self):
         self.engine = create_engine(self.env.db_url)
         self.start_time = datetime.now()
         self.language_colors = self._load_language_colors()
+        self._custom_emoji = dict[CustomEmoji, Emoji]()
 
     @classmethod
     def of(cls, interaction: Interaction):
@@ -139,3 +140,34 @@ def get_language_color(self, language: str) -> Color:
         gh_default: Color = Color.from_str("#1B1F24")
 
         return self.language_colors.get(language, gh_default)
+
+    async def fetch_custom_emojis(self):
+        logger.info("Fetching custom emojis")
+
+        application_emojis = {
+            emoji.name: emoji for emoji in await self.fetch_application_emojis()
+        }
+
+        self._custom_emoji.clear()
+        for custom_emoji in CustomEmoji:
+            if emoji := application_emojis.get(custom_emoji.name):
+                self._custom_emoji[custom_emoji] = emoji
+            else:
+                logger.warning(
+                    f"Failed to find custom emoji (try running `sync emoji` command): {custom_emoji.name}"
+                )
+
+    async def sync_custom_emojis(self):
+        logger.info("Syncing/uploading custom emojis")
+        self._custom_emoji.clear()
+        for custom_emoji in CustomEmoji:
+            self._custom_emoji[custom_emoji] = await self.create_application_emoji(
+                name=custom_emoji.name,
+                image=custom_emoji.load_image(),
+            )
+
+    def get_custom_emoji(self, custom_emoji: CustomEmoji) -> Emoji:
+        emoji = self._custom_emoji.get(custom_emoji)
+        if emoji is None:
+            raise ValueError(f"Failed to find custom emoji: {custom_emoji.name}")
+        return emoji

bot/src/ghutils/core/types.py

@@ -1,7 +1,26 @@
 from enum import Enum, auto
 
+from typing_extensions import deprecated
+
+from ghutils.resources import get_resource
+
 
 class LoginState(Enum):
     LOGGED_IN = auto()
     LOGGED_OUT = auto()
     EXPIRED = auto()
+
+
+class CustomEmoji(Enum):
+    apps_icon = "apps_icon.png"
+
+    def __init__(self, filename: str):
+        self.filename = filename
+
+    @property
+    @deprecated("Use name or filename instead", category=None)
+    def value(self):
+        return super().value
+
+    def load_image(self) -> bytes:
+        return get_resource(f"emoji/{self.filename}").read_bytes()

bot/src/ghutils/resources/emoji/apps_icon.png

@@ -3,16 +3,14 @@
 from re import Match
 from typing import Any, Literal, Self
 
-from discord import (
-    Embed,
-    Interaction,
-    PartialEmoji,
-    ui,
-)
+from discord import Embed, Interaction, ui
 from discord.app_commands import Command, ContextMenu
 from discord.ui import Button, DynamicItem, Item, View
 from discord.utils import MISSING
 
+from ghutils.core.bot import GHUtilsBot
+from ghutils.core.types import CustomEmoji
+
 from .commands import AnyCommand
 
 type MessageVisibility = Literal["public", "private"]
@@ -76,10 +74,10 @@ def _get_view(
                     label = f"{interaction.user.name} used /{command_name}"
                 case _:
                     label = f"Sent by {interaction.user.name}"
+            bot = GHUtilsBot.of(interaction)
             view.add_item(
                 Button(
-                    # FIXME: remove hardcoded emoji id
-                    emoji=PartialEmoji(name="apps_icon", id=1279865345250693151),
+                    emoji=bot.get_custom_emoji(CustomEmoji.apps_icon),
                     label=label,
                     disabled=True,
                 )