CommandHelpers.py

# Helper functions for Discord application commands
from Logger import Logger, LogLevel
from discord import Interaction, app_commands
import traceback, re
from TextWrapper import TextLibrary

UserIdReg = re.compile("\<\@([0-9]+)\>") # pyright: ignore[reportInvalidStringEscapeSequence]
Messages:TextLibrary = TextLibrary()

# This transformer allows us to take in a discord id (as the default int is too small)
# and properly convert it to a value that we can use to observe Discord data
class BaseIdTransformer(app_commands.Transformer):
  async def OnTransform(self, interaction: Interaction, TargetId:int) -> int:
    return TargetId

  async def transform(self, interaction: Interaction, value: str) -> int:
    # Capture any mention targets
    matches = UserIdReg.match(value)
    if (matches is not None):
      value = matches.group(1)

    # Check if the value is numeric
    if (not value.isnumeric()):
      return -1

    ConvertedValue:int = int(value)
    # Prevent any targets on the bot
    if (interaction.client.user is not None and ConvertedValue == interaction.client.user.id):
      return -1
    return await self.OnTransform(interaction, ConvertedValue)

# This transformer checks to see if the given id is a real discord User.
class TargetIdTransformer(BaseIdTransformer):
  async def OnTransform(self, interaction: Interaction, TargetId:int) -> int:
    if (await interaction.client.UserAccountExists(TargetId)): # pyright: ignore[reportAttributeAccessIssue]
      return TargetId
    else:
      return -1

# This transformer is just a named copy of the BaseIdTransformer
class ServerIdTransformer(BaseIdTransformer):
  pass

# Simple error handling logger, so that we aren't completely bogging down the application run log with
# errors and such.
async def CommandErrorHandler(interaction: Interaction, error: app_commands.AppCommandError):
  ErrorType = type(error)
  ErrorMsg:str = ""
  if (interaction.command is None):
    Logger.Log(LogLevel.Error, f"Failed to process command error {error}, interaction.command is none")
    return

  InteractionName:str = interaction.command.name
  if (ErrorType == app_commands.CommandOnCooldown):
    ErrorMsg = Messages["cmds_error"]["on_cooldown"].format(cmd=InteractionName)
  elif (ErrorType == app_commands.MissingPermissions):
    ErrorMsg = Messages["cmds_error"]["no_permission"].format(cmd=InteractionName)
  elif (ErrorType == app_commands.MissingRole):
    ErrorMsg = Messages["cmds_error"]["missing_roles"].format(cmd=InteractionName)
  elif (ErrorType == app_commands.CheckFailure):
    if (InteractionName == "activate"):
      ErrorMsg = Messages["cmds"]["check"]["need_activate"]
    else:
      ErrorMsg = Messages["cmds"]["check"]["change_settings"]
  else:
    Logger.Log(LogLevel.Error, f"Encountered error running command /{InteractionName}: {str(error)} ```{traceback.format_exc(limit=3)}```")
    ErrorMsg = Messages["cmds_error"]["general"]

  await interaction.response.send_message(ErrorMsg, ephemeral=True, delete_after=10.0)