Application commands

@attrs.define(
    eq=False,
    order=False,
    hash=False,
    field_transformer=attrs_validator(name_validator, skip_fields=["default_locale"]),
)
class LocalisedName(LocalisedField):
    """A localisation object for names."""

    def __repr__(self) -> str:
        return super().__repr__()

@attrs.define(
    eq=False,
    order=False,
    hash=False,
    field_transformer=attrs_validator(desc_validator, skip_fields=["default_locale"]),
)
class LocalisedDesc(LocalisedField):
    """A localisation object for descriptions."""

    def __repr__(self) -> str:
        return super().__repr__()

class OptionType(IntEnum):
    """Option types supported by slash commands."""

    SUB_COMMAND = 1
    SUB_COMMAND_GROUP = 2
    STRING = 3
    INTEGER = 4
    BOOLEAN = 5
    USER = 6
    CHANNEL = 7
    ROLE = 8
    MENTIONABLE = 9
    NUMBER = 10
    ATTACHMENT = 11

    @classmethod
    def resolvable_types(cls) -> tuple["OptionType", ...]:
        """A tuple of all resolvable types."""
        return cls.USER, cls.CHANNEL, cls.ROLE, cls.MENTIONABLE, cls.ATTACHMENT

    @classmethod
    def static_types(cls) -> tuple["OptionType", ...]:
        """A tuple of all static types."""
        return cls.STRING, cls.INTEGER, cls.BOOLEAN, cls.NUMBER

    @classmethod
    def command_types(cls) -> tuple["OptionType", ...]:
        """A tuple of all command types."""
        return cls.SUB_COMMAND, cls.SUB_COMMAND_GROUP

    @classmethod
    def from_type(cls, t: type) -> "OptionType | None":
        """
        Convert data types to their corresponding OptionType.

        Args:
            t: The datatype to convert

        Returns:
            OptionType or None

        """
        if issubclass(t, str):
            return cls.STRING
        if issubclass(t, int):
            return cls.INTEGER
        if issubclass(t, bool):
            return cls.BOOLEAN
        if issubclass(t, BaseUser):
            return cls.USER
        if issubclass(t, channel.BaseChannel):
            return cls.CHANNEL
        if issubclass(t, Role):
            return cls.ROLE
        if issubclass(t, float):
            return cls.NUMBER

class CallbackType(IntEnum):
    """Types of callback supported by interaction response."""

    PONG = 1
    CHANNEL_MESSAGE_WITH_SOURCE = 4
    DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE = 5
    DEFERRED_UPDATE_MESSAGE = 6
    UPDATE_MESSAGE = 7
    AUTOCOMPLETE_RESULT = 8
    MODAL = 9

@attrs.define(eq=False, order=False, hash=False, kw_only=True)
class InteractionCommand(BaseCommand):
    """
    Represents a discord abstract interaction command.

    Attributes:
        scope: Denotes whether its global or for specific guild.
        default_member_permissions: What permissions members need to have by default to use this command.
        dm_permission: Should this command be available in DMs.
        cmd_id: The id of this command given by discord.
        callback: The coroutine to callback when this interaction is received.

    """

    name: LocalisedName | str = attrs.field(
        repr=False,
        metadata=docs("1-32 character name") | no_export_meta,
        converter=LocalisedName.converter,
    )
    scopes: List["Snowflake_Type"] = attrs.field(
        default=[GLOBAL_SCOPE],
        converter=to_snowflake_list,
        metadata=docs("The scopes of this interaction. Global or guild ids") | no_export_meta,
    )
    default_member_permissions: Optional["Permissions"] = attrs.field(
        repr=False,
        default=None,
        metadata=docs("What permissions members need to have by default to use this command"),
    )
    dm_permission: bool = attrs.field(repr=False, default=True, metadata=docs("Whether this command is enabled in DMs"))
    cmd_id: Dict[str, "Snowflake_Type"] = attrs.field(
        repr=False, factory=dict, metadata=docs("The unique IDs of this commands") | no_export_meta
    )  # scope: cmd_id
    callback: Callable[..., Coroutine] = attrs.field(
        repr=False,
        default=None,
        metadata=docs("The coroutine to call when this interaction is received") | no_export_meta,
    )
    auto_defer: "AutoDefer" = attrs.field(
        default=MISSING,
        metadata=docs("A system to automatically defer this command after a set duration") | no_export_meta,
    )
    nsfw: bool = attrs.field(repr=False, default=False, metadata=docs("This command should only work in NSFW channels"))
    _application_id: "Snowflake_Type" = attrs.field(repr=False, default=None, converter=optional(to_snowflake))

    def __attrs_post_init__(self) -> None:
        if self.callback is not None and hasattr(self.callback, "auto_defer"):
            self.auto_defer = self.callback.auto_defer

        super().__attrs_post_init__()

    def to_dict(self) -> dict:
        data = super().to_dict()

        if self.default_member_permissions is not None:
            data["default_member_permissions"] = str(int(self.default_member_permissions))
        else:
            data["default_member_permissions"] = None

        return data

    def mention(self, scope: Optional["Snowflake_Type"] = None) -> str:
        """
        Returns a string that would mention the interaction.

        Args:
            scope: If the command is available in multiple scope, specify which scope to get the mention for. Defaults to the first available one if not specified.

        Returns:
            The markdown mention.
        """
        if scope:
            cmd_id = self.get_cmd_id(scope=scope)
        else:
            cmd_id = next(iter(self.cmd_id.values()))

        return f"</{self.resolved_name}:{cmd_id}>"

    @property
    def resolved_name(self) -> str:
        """A representation of this interaction's name."""
        return str(self.name)

    def get_localised_name(self, locale: str) -> str:
        return self.name.get_locale(locale)

    def get_cmd_id(self, scope: "Snowflake_Type") -> "Snowflake_Type":
        return self.cmd_id.get(scope, self.cmd_id.get(GLOBAL_SCOPE, None))

    @property
    def is_subcommand(self) -> bool:
        return False

    async def _permission_enforcer(self, ctx: "BaseContext") -> bool:
        """A check that enforces Discord permissions."""
        # I wish this wasn't needed, but unfortunately Discord permissions cant be trusted to actually prevent usage
        return ctx.guild is not None if self.dm_permission is False else True

    def is_enabled(self, ctx: "BaseContext") -> bool:
        """
        Check if this command is enabled in the given context.

        Args:
            ctx: The context to check.

        Returns:
            Whether this command is enabled in the given context.
        """
        if not self.dm_permission and ctx.guild is None:
            return False
        if self.dm_permission and ctx.guild is None:
            # remaining checks are impossible if this is a DM and DMs are enabled
            return True

        if self.nsfw and not ctx.channel.is_nsfw():
            return False
        if cmd_perms := ctx.guild.command_permissions.get(self.get_cmd_id(ctx.guild.id)):
            if not cmd_perms.is_enabled_in_context(ctx):
                return False
        if self.default_member_permissions is not None:
            channel_perms = ctx.author.channel_permissions(ctx.channel)
            if any(perm not in channel_perms for perm in self.default_member_permissions):
                return False
        return True

@attrs.define(eq=False, order=False, hash=False, kw_only=True)
class ContextMenu(InteractionCommand):
    """
    Represents a discord context menu.

    Attributes:
        name: The name of this entry.
        type: The type of entry (user or message).

    """

    name: LocalisedField = attrs.field(
        repr=False, metadata=docs("1-32 character name"), converter=LocalisedField.converter
    )
    type: CommandType = attrs.field(repr=False, metadata=docs("The type of command, defaults to 1 if not specified"))

    @type.validator
    def _type_validator(self, attribute: str, value: int) -> None:
        if not isinstance(value, CommandType):
            if value not in CommandType.__members__.values():
                raise ValueError("Context Menu type not recognised, please consult the docs.")
        elif value == CommandType.CHAT_INPUT:
            raise ValueError(
                "The CHAT_INPUT type is basically slash commands. Please use the @slash_command() " "decorator instead."
            )

    def to_dict(self) -> dict:
        data = super().to_dict()

        data["name"] = str(self.name)
        return data

@attrs.define(eq=False, order=False, hash=False, kw_only=False)
class SlashCommandChoice(DictSerializationMixin):
    """
    Represents a discord slash command choice.

    Attributes:
        name: The name the user will see
        value: The data sent to your code when this choice is used

    """

    name: LocalisedField | str = attrs.field(repr=False, converter=LocalisedField.converter)
    value: Union[str, int, float] = attrs.field(
        repr=False,
    )

    def as_dict(self) -> dict:
        return {
            "name": str(self.name),
            "value": self.value,
            "name_localizations": self.name.to_locale_dict(),
        }

@attrs.define(eq=False, order=False, hash=False, kw_only=False)
class SlashCommandOption(DictSerializationMixin):
    """
    Represents a discord slash command option.

    Attributes:
        name: The name of this option
        type: The type of option
        description: The description of this option
        required: "This option must be filled to use the command"
        choices: A list of choices the user has to pick between
        channel_types: The channel types permitted. The option needs to be a channel
        min_value: The minimum value permitted. The option needs to be an integer or float
        max_value: The maximum value permitted. The option needs to be an integer or float
        min_length: The minimum length of text a user can input. The option needs to be a string
        max_length: The maximum length of text a user can input. The option needs to be a string
        argument_name: The name of the argument to be used in the function. If not given, assumed to be the same as the name of the option

    """

    name: LocalisedName | str = attrs.field(repr=False, converter=LocalisedName.converter)
    type: Union[OptionType, int] = attrs.field(
        repr=False,
    )
    description: LocalisedDesc | str | str = attrs.field(
        repr=False, default="No Description Set", converter=LocalisedDesc.converter
    )
    required: bool = attrs.field(repr=False, default=True)
    autocomplete: bool = attrs.field(repr=False, default=False)
    choices: List[Union[SlashCommandChoice, Dict]] = attrs.field(repr=False, factory=list)
    channel_types: Optional[list[Union[ChannelType, int]]] = attrs.field(repr=False, default=None)
    min_value: Optional[float] = attrs.field(repr=False, default=None)
    max_value: Optional[float] = attrs.field(repr=False, default=None)
    min_length: Optional[int] = attrs.field(repr=False, default=None)
    max_length: Optional[int] = attrs.field(repr=False, default=None)
    argument_name: Optional[str] = attrs.field(repr=False, default=None)

    @type.validator
    def _type_validator(self, attribute: str, value: int) -> None:
        if value in (OptionType.SUB_COMMAND, OptionType.SUB_COMMAND_GROUP):
            raise ValueError(
                "Options cannot be SUB_COMMAND or SUB_COMMAND_GROUP. If you want to use subcommands, "
                "see the @sub_command() decorator."
            )

    @channel_types.validator
    def _channel_types_validator(self, attribute: str, value: Optional[list[OptionType]]) -> None:
        if value is not None:
            if self.type != OptionType.CHANNEL:
                raise ValueError("The option needs to be CHANNEL to use this")

            allowed_int = [channel_type.value for channel_type in ChannelType]
            for item in value:
                if (item not in allowed_int) and (item not in ChannelType):
                    raise ValueError(f"{value} is not allowed here")

    @min_value.validator
    def _min_value_validator(self, attribute: str, value: Optional[float]) -> None:
        if value is not None:
            if self.type not in [OptionType.INTEGER, OptionType.NUMBER]:
                raise ValueError("`min_value` can only be supplied with int or float options")

            if self.type == OptionType.INTEGER and isinstance(value, float):
                raise ValueError("`min_value` needs to be an int in an int option")

            if self.max_value is not None and self.min_value is not None and self.max_value < self.min_value:
                raise ValueError("`min_value` needs to be <= than `max_value`")

    @max_value.validator
    def _max_value_validator(self, attribute: str, value: Optional[float]) -> None:
        if value is not None:
            if self.type not in (OptionType.INTEGER, OptionType.NUMBER):
                raise ValueError("`max_value` can only be supplied with int or float options")

            if self.type == OptionType.INTEGER and isinstance(value, float):
                raise ValueError("`max_value` needs to be an int in an int option")

            if self.max_value and self.min_value and self.max_value < self.min_value:
                raise ValueError("`min_value` needs to be <= than `max_value`")

    @min_length.validator
    def _min_length_validator(self, attribute: str, value: Optional[int]) -> None:
        if value is not None:
            if self.type != OptionType.STRING:
                raise ValueError("`min_length` can only be supplied with string options")

            if self.max_length is not None and self.min_length is not None and self.max_length < self.min_length:
                raise ValueError("`min_length` needs to be <= than `max_length`")

            if self.min_length < 0:
                raise ValueError("`min_length` needs to be >= 0")

    @max_length.validator
    def _max_length_validator(self, attribute: str, value: Optional[int]) -> None:
        if value is not None:
            if self.type != OptionType.STRING:
                raise ValueError("`max_length` can only be supplied with string options")

            if self.min_length is not None and self.max_length is not None and self.max_length < self.min_length:
                raise ValueError("`min_length` needs to be <= than `max_length`")

            if self.max_length < 1:
                raise ValueError("`max_length` needs to be >= 1")

    def as_dict(self) -> dict:
        data = attrs.asdict(self)
        data.pop("argument_name", None)
        data["name"] = str(self.name)
        data["description"] = str(self.description)
        data["choices"] = [
            choice.as_dict() if isinstance(choice, SlashCommandChoice) else choice for choice in self.choices
        ]
        data["name_localizations"] = self.name.to_locale_dict()
        data["description_localizations"] = self.description.to_locale_dict()

        return data

@attrs.define()
class SlashCommandParameter:
    name: str = attrs.field()
    type: typing.Any = attrs.field()
    kind: inspect._ParameterKind = attrs.field()
    default: typing.Any = attrs.field(default=MISSING)
    converter: typing.Optional[typing.Callable] = attrs.field(default=None)
    _option_name: typing.Optional[str] = attrs.field(default=None)

    @property
    def option_name(self) -> str:
        return self._option_name or self.name

@attrs.define(eq=False, order=False, hash=False, kw_only=True)
class SlashCommand(InteractionCommand):
    name: LocalisedName | str = attrs.field(repr=False, converter=LocalisedName.converter)
    description: LocalisedDesc | str = attrs.field(
        repr=False, default="No Description Set", converter=LocalisedDesc.converter
    )

    group_name: LocalisedName | str = attrs.field(
        repr=False, default=None, metadata=no_export_meta, converter=LocalisedName.converter
    )
    group_description: LocalisedDesc | str = attrs.field(
        repr=False,
        default="No Description Set",
        metadata=no_export_meta,
        converter=LocalisedDesc.converter,
    )

    sub_cmd_name: LocalisedName | str = attrs.field(
        repr=False, default=None, metadata=no_export_meta, converter=LocalisedName.converter
    )
    sub_cmd_description: LocalisedDesc | str = attrs.field(
        repr=False,
        default="No Description Set",
        metadata=no_export_meta,
        converter=LocalisedDesc.converter,
    )

    options: List[Union[SlashCommandOption, Dict]] = attrs.field(repr=False, factory=list)
    autocomplete_callbacks: dict = attrs.field(repr=False, factory=dict, metadata=no_export_meta)

    parameters: dict[str, SlashCommandParameter] = attrs.field(
        repr=False,
        factory=dict,
        metadata=no_export_meta,
    )
    _uses_arg: bool = attrs.field(repr=False, default=False, metadata=no_export_meta)

    @property
    def resolved_name(self) -> str:
        return (
            f"{self.name}"
            f"{f' {self.group_name}' if bool(self.group_name) else ''}"
            f"{f' {self.sub_cmd_name}' if bool(self.sub_cmd_name) else ''}"
        )

    def get_localised_name(self, locale: str) -> str:
        return (
            f"{self.name.get_locale(locale)}"
            f"{f' {self.group_name.get_locale(locale)}' if bool(self.group_name) else ''}"
            f"{f' {self.sub_cmd_name.get_locale(locale)}' if bool(self.sub_cmd_name) else ''}"
        )

    @property
    def is_subcommand(self) -> bool:
        return bool(self.sub_cmd_name)

    def __attrs_post_init__(self) -> None:
        if self.callback is not None and hasattr(self.callback, "options"):
            if not self.options:
                self.options = []
            self.options += self.callback.options

        super().__attrs_post_init__()

    def _add_option_from_anno_method(self, name: str, option: SlashCommandOption) -> None:
        if not self.options:
            self.options = []

        if option.name is None:
            option.name = name
        else:
            option.argument_name = name

        self.options.append(option)

    def _parse_parameters(self) -> None:  # noqa: C901
        """
        Parses the parameters that this command has into a form i.py can use.

        This is purposely separated like this to allow "lazy parsing" - parsing
        as the command is added to a bot rather than being parsed immediately.
        This allows variables like "self" to be filtered out, and is useful for
        potential future additions.

        For slash commands, it is also much faster than inspecting the parameters
        each time the command is called.
        It also allows for us to deal with the "annotation method", where users
        put their options in the annotations itself.
        """
        if self.callback is None or self.parameters:
            return

        if self.has_binding:
            callback = functools.partial(self.callback, None, None)
        else:
            callback = functools.partial(self.callback, None)

        for param in get_parameters(callback).values():
            if param.kind == inspect._ParameterKind.VAR_POSITIONAL:
                self._uses_arg = True
                continue

            if param.kind == inspect._ParameterKind.VAR_KEYWORD:
                # in case it was set before
                # we prioritize **kwargs over *args
                self._uses_arg = False
                continue

            our_param = SlashCommandParameter(param.name, param.annotation, param.kind)
            our_param.default = param.default if param.default is not inspect._empty else MISSING

            if param.annotation is not inspect._empty:
                anno = param.annotation
                converter = None

                if _is_optional(anno):
                    anno = _remove_optional(anno)

                if isinstance(anno, SlashCommandOption):
                    # annotation method, get option and add it in
                    self._add_option_from_anno_method(param.name, anno)

                if isinstance(anno, Converter):
                    converter = anno
                elif typing.get_origin(anno) == Annotated:
                    if option := _get_option_from_annotated(anno):
                        # also annotation method
                        self._add_option_from_anno_method(param.name, option)

                    converter = _get_converter_from_annotated(anno)

                if converter:
                    our_param.converter = self._get_converter_function(converter, our_param.name)

            self.parameters[param.name] = our_param

        if self.options:
            for option in self.options:
                maybe_argument_name = (
                    option.argument_name if isinstance(option, SlashCommandOption) else option.get("argument_name")
                )
                if maybe_argument_name:
                    name = option.name if isinstance(option, SlashCommandOption) else option["name"]
                    try:
                        self.parameters[maybe_argument_name]._option_name = str(name)
                    except KeyError:
                        raise ValueError(
                            f'Argument name "{maybe_argument_name}" for "{name}" does not match any parameter in {self.resolved_name}\'s function.'
                        ) from None

    def to_dict(self) -> dict:
        data = super().to_dict()

        if self.is_subcommand:
            data["name"] = str(self.sub_cmd_name)
            data["description"] = str(self.sub_cmd_description)
            data["name_localizations"] = self.sub_cmd_name.to_locale_dict()
            data["description_localizations"] = self.sub_cmd_description.to_locale_dict()
            data.pop("default_member_permissions", None)
            data.pop("dm_permission", None)
            data.pop("nsfw", None)
        else:
            data["name_localizations"] = self.name.to_locale_dict()
            data["description_localizations"] = self.description.to_locale_dict()
        return data

    @options.validator
    def options_validator(self, attribute: str, value: List) -> None:
        if value:
            if not isinstance(value, list):
                raise TypeError("Options attribute must be either None or a list of options")
            if len(value) > SLASH_CMD_MAX_OPTIONS:
                raise ValueError(f"Slash commands can only hold {SLASH_CMD_MAX_OPTIONS} options")
            if value != sorted(
                value,
                key=lambda x: x.required if isinstance(x, SlashCommandOption) else x["required"],
                reverse=True,
            ):
                raise ValueError("Required options must go before optional options")

    def autocomplete(self, option_name: str) -> Callable[..., Coroutine]:
        """A decorator to declare a coroutine as an option autocomplete."""

        def wrapper(call: Callable[..., Coroutine]) -> Callable[..., Coroutine]:
            if not asyncio.iscoroutinefunction(call):
                raise TypeError("autocomplete must be coroutine")
            self.autocomplete_callbacks[option_name] = call

            if self.options:
                # automatically set the option's autocomplete attribute to True
                for opt in self.options:
                    if isinstance(opt, dict) and str(opt["name"]) == option_name:
                        opt["autocomplete"] = True
                    elif isinstance(opt, SlashCommandOption) and str(opt.name) == option_name:
                        opt.autocomplete = True

            return call

        option_name = option_name.lower()
        return wrapper

    def group(
        self, name: str | None = None, description: str = "No Description Set", inherit_checks: bool = True
    ) -> "SlashCommand":
        return SlashCommand(
            name=self.name,
            description=self.description,
            group_name=name,
            group_description=description,
            scopes=self.scopes,
            default_member_permissions=self.default_member_permissions,
            dm_permission=self.dm_permission,
            checks=self.checks.copy() if inherit_checks else [],
        )

    def subcommand(
        self,
        sub_cmd_name: Absent[LocalisedName | str] = MISSING,
        group_name: LocalisedName | str = None,
        sub_cmd_description: Absent[LocalisedDesc | str] = MISSING,
        group_description: Absent[LocalisedDesc | str] = MISSING,
        options: List[Union[SlashCommandOption, Dict]] | None = None,
        nsfw: bool = False,
        inherit_checks: bool = True,
    ) -> Callable[..., "SlashCommand"]:
        def wrapper(call: Callable[..., Coroutine]) -> "SlashCommand":
            nonlocal sub_cmd_name, sub_cmd_description

            if not asyncio.iscoroutinefunction(call):
                raise TypeError("Subcommand must be coroutine")

            if sub_cmd_description is MISSING:
                sub_cmd_description = call.__doc__ or "No Description Set"
            if sub_cmd_name is MISSING:
                sub_cmd_name = call.__name__

            return SlashCommand(
                name=self.name,
                description=self.description,
                group_name=group_name or self.group_name,
                group_description=group_description or self.group_description,
                sub_cmd_name=sub_cmd_name,
                sub_cmd_description=sub_cmd_description,
                default_member_permissions=self.default_member_permissions,
                dm_permission=self.dm_permission,
                options=options,
                callback=call,
                scopes=self.scopes,
                nsfw=nsfw,
                checks=self.checks.copy() if inherit_checks else [],
            )

        return wrapper

    async def call_callback(self, callback: typing.Callable, ctx: "InteractionContext") -> None:
        if not self.parameters:
            if self._uses_arg:
                return await self.call_with_binding(callback, ctx, *ctx.args)
            return await self.call_with_binding(callback, ctx)

        kwargs_copy = ctx.kwargs.copy()

        new_args = []
        new_kwargs = {}

        for param in self.parameters.values():
            value = kwargs_copy.pop(param.option_name, MISSING)
            if value is MISSING:
                continue

            if converter := param.converter:
                value = await maybe_coroutine(converter, ctx, value)

            if param.kind == inspect.Parameter.POSITIONAL_ONLY:
                new_args.append(value)
            else:
                new_kwargs[param.name] = value

        # i do want to address one thing: what happens if you have both *args and **kwargs
        # in your argument?
        # i would say passing in values for both makes sense... but they're very likely
        # going to overlap and cause issues and confusion
        # for the sake of simplicty, i.py assumes kwargs takes priority over args
        if kwargs_copy:
            if self._uses_arg:
                new_args.extend(kwargs_copy.values())
            else:
                new_kwargs |= kwargs_copy

        return await self.call_with_binding(callback, ctx, *new_args, **new_kwargs)