asset.py

# -*- coding: utf-8 -*-

"""
The MIT License (MIT)

Copyright (c) 2015-2021 Rapptz & (c) 2021-present mccoderpy

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
"""
from __future__ import annotations

import io

from typing import (
    BinaryIO,
    Optional,
    TYPE_CHECKING,
    Union
)

if TYPE_CHECKING:
    from os import PathLike
    from .state import ConnectionState
    from .oauth2 import (
        OAuth2Client,
        PartialGuild,
        GuildMember,
        User as OAuth2User
    )
    from .user import User
    from .member import Member
    from .sticker import Sticker, GuildSticker, StickerPack
    from .guild import Guild
    from .emoji import Emoji
    from .partial_emoji import PartialEmoji
    from .scheduled_event import GuildScheduledEvent
    from .types.snowflake import SnowflakeID
    
    HAS_HTTP_CONNECTION = Union[ConnectionState, OAuth2Client]


from .errors import DiscordException, InvalidArgument
from . import utils

__all__ = (
    'Asset',
)

VALID_STATIC_FORMATS = frozenset({"jpeg", "jpg", "webp", "png"})
VALID_AVATAR_FORMATS = VALID_STATIC_FORMATS | {"gif"}


class Asset:
    """Represents a CDN asset on Discord.

    .. container:: operations

        .. describe:: str(x)

            Returns the URL of the CDN asset.

        .. describe:: len(x)

            Returns the length of the CDN asset's URL.

        .. describe:: bool(x)

            Checks if the Asset has a URL.

        .. describe:: x == y

            Checks if the asset is equal to another asset.

        .. describe:: x != y

            Checks if the asset is not equal to another asset.

        .. describe:: hash(x)

            Returns the hash of the asset.
    """
    __slots__ = ('_state', '_url')

    BASE = 'https://cdn.discordapp.com'

    def __init__(
            self,
            state: HAS_HTTP_CONNECTION,
            url: Optional[str] = None
    ):
        self._state: HAS_HTTP_CONNECTION = state
        self._url: Optional[str] = url

    @classmethod
    def _from_avatar(
            cls,
            state: HAS_HTTP_CONNECTION,
            user: Union[User, OAuth2User],
            *,
            format=None,
            static_format='webp',
            size=1024
    ):
        if not utils.valid_icon_size(size):
            raise InvalidArgument("size must be a power of 2 between 16 and 4096")
        if format is not None and format not in VALID_AVATAR_FORMATS:
            raise InvalidArgument("format must be None or one of {}".format(VALID_AVATAR_FORMATS))
        if format == "gif" and not user.is_avatar_animated():
            raise InvalidArgument("non animated avatars do not support gif format")
        if static_format not in VALID_STATIC_FORMATS:
            raise InvalidArgument("static_format must be one of {}".format(VALID_STATIC_FORMATS))

        if user.avatar is None:
            return user.default_avatar_url

        if format is None:
            format = 'gif' if user.is_avatar_animated() else static_format

        return cls(state, '/avatars/{0.id}/{0.avatar}.{1}?size={2}'.format(user, format, size))

    @classmethod
    def _from_guild_avatar(
            cls,
            state: HAS_HTTP_CONNECTION,
            member: Union[Member, GuildMember],
            *,
            format=None,
            static_format='webp',
            size=1024
    ):
        if not utils.valid_icon_size(size):
            raise InvalidArgument("size must be a power of 2 between 16 and 4096")
        if format is not None and format not in VALID_AVATAR_FORMATS:
            raise InvalidArgument("format must be None or one of {}".format(VALID_AVATAR_FORMATS))
        if format == "gif" and not member.is_guild_avatar_animated():
            raise InvalidArgument("non animated avatars do not support gif format")
        if static_format not in VALID_STATIC_FORMATS:
            raise InvalidArgument("static_format must be one of {}".format(VALID_STATIC_FORMATS))

        if member.guild_avatar is None:
            return member.avatar_url

        if format is None:
            format = 'gif' if member.is_guild_avatar_animated() else static_format

        return cls(
            state,
            '/guilds/{0.guild.id}/users/{0.id}/avatars/{0.guild_avatar}.{1}?size={2}'.format(member, format, size)
        )

    @classmethod
    def _from_avatar_decoration(
            cls,
            state: HAS_HTTP_CONNECTION,
            user: Union[User, OAuth2User],
            *,
            format=None,
            static_format='webp',
            size=1024
    ):
        if not utils.valid_icon_size(size):
            raise InvalidArgument("size must be a power of 2 between 16 and 4096")
        if format is not None and format not in VALID_AVATAR_FORMATS:
            raise InvalidArgument(f"format must be None or one of {VALID_AVATAR_FORMATS}")
        if static_format not in VALID_STATIC_FORMATS:
            raise InvalidArgument(f"static_format must be one of {VALID_STATIC_FORMATS}")

        if user.avatar_decoration is None:
            return None

        return cls(state, '/avatar-decoration-presets/{0.avatar_decoration}.{1}?size={2}'.format(user, format, size))

    @classmethod
    def _from_banner(
            cls,
            state: HAS_HTTP_CONNECTION,
            user,
            *,
            format=None,
            static_format='webp',
            size=1024
    ):
        if not user.banner:
            return None
        if not utils.valid_icon_size(size):
            raise InvalidArgument("size must be a power of 2 between 16 and 4096")
        if format is not None and format not in VALID_AVATAR_FORMATS:
            raise InvalidArgument("format must be None or one of {}".format(VALID_AVATAR_FORMATS))
        if format == "gif" and not user.is_banner_animated():
            raise InvalidArgument("non animated avatars do not support gif format")
        if static_format not in VALID_STATIC_FORMATS:
            raise InvalidArgument("static_format must be one of {}".format(VALID_STATIC_FORMATS))

        if format is None:
            format = 'gif' if user.is_banner_animated() else static_format

        return cls(state, f'/banners/{user.id}/{user.banner}.{format}?size={size}')

    @classmethod
    def _from_guild_banner(
            cls,
            state: HAS_HTTP_CONNECTION,
            member: Member,
            *,
            format=None,
            static_format='webp',
            size=1024
    ):
        if not member.guild_banner:
            return None
        if not utils.valid_icon_size(size):
            raise InvalidArgument("size must be a power of 2 between 16 and 4096")
        if format is not None and format not in VALID_AVATAR_FORMATS:
            raise InvalidArgument("format must be None or one of {}".format(VALID_AVATAR_FORMATS))
        if format == "gif" and not member.is_banner_animated():
            raise InvalidArgument("non animated avatars do not support gif format")
        if static_format not in VALID_STATIC_FORMATS:
            raise InvalidArgument("static_format must be one of {}".format(VALID_STATIC_FORMATS))

        if format is None:
            format = 'gif' if member.is_banner_animated() else static_format

        return cls(
            state,
            '/guilds/{0.guild.id}/users/{0.id}/banners/{0.guild_banner}.{1}?size={2}'.format(member, format, size)
        )

    @classmethod
    def _from_icon(
            cls,
            state: HAS_HTTP_CONNECTION,
            object,
            path,
            *,
            format='webp',
            size=1024
    ):
        if object.icon is None:
            return cls(state)

        if not utils.valid_icon_size(size):
            raise InvalidArgument("size must be a power of 2 between 16 and 4096")
        if format not in VALID_STATIC_FORMATS:
            raise InvalidArgument("format must be None or one of {}".format(VALID_STATIC_FORMATS))

        url = '/{0}-icons/{1.id}/{1.icon}.{2}?size={3}'.format(path, object, format, size)
        return cls(state, url)

    @classmethod
    def _from_cover_image(
            cls,
            state: HAS_HTTP_CONNECTION,
            obj,
            *,
            format='webp',
            size=1024
    ):
        if obj.cover_image is None:
            return cls(state)

        if not utils.valid_icon_size(size):
            raise InvalidArgument("size must be a power of 2 between 16 and 4096")
        if format not in VALID_STATIC_FORMATS:
            raise InvalidArgument("format must be None or one of {}".format(VALID_STATIC_FORMATS))

        url = '/app-assets/{0.id}/store/{0.cover_image}.{1}?size={2}'.format(obj, format, size)
        return cls(state, url)

    @classmethod
    def _from_guild_image(
            cls,
            state: HAS_HTTP_CONNECTION,
            id: SnowflakeID,
            hash: str,
            key: str,
            *,
            format='webp',
            size=1024
    ):
        if not utils.valid_icon_size(size):
            raise InvalidArgument("size must be a power of 2 between 16 and 4096")
        if format not in VALID_STATIC_FORMATS:
            raise InvalidArgument("format must be one of {}".format(VALID_STATIC_FORMATS))

        if hash is None:
            return cls(state)

        url = '/{key}/{0}/{1}.{2}?size={3}'
        return cls(state, url.format(id, hash, format, size, key=key))

    @classmethod
    def _from_guild_icon(
            cls,
            state: HAS_HTTP_CONNECTION,
            guild: Union[Guild, PartialGuild],
            *,
            format=None,
            static_format='webp',
            size=1024
    ):
        if not utils.valid_icon_size(size):
            raise InvalidArgument("size must be a power of 2 between 16 and 4096")
        if format is not None and format not in VALID_AVATAR_FORMATS:
            raise InvalidArgument("format must be one of {}".format(VALID_AVATAR_FORMATS))
        if format == "gif" and not guild.is_icon_animated():
            raise InvalidArgument("non animated guild icons do not support gif format")
        if static_format not in VALID_STATIC_FORMATS:
            raise InvalidArgument("static_format must be one of {}".format(VALID_STATIC_FORMATS))

        if guild.icon is None:
            return cls(state)

        if format is None:
            format = 'gif' if guild.is_icon_animated() else static_format

        return cls(state, '/icons/{0.id}/{0.icon}.{1}?size={2}'.format(guild, format, size))

    @classmethod
    def _from_sticker(
            cls,
            state: HAS_HTTP_CONNECTION,
            sticker: Union[Sticker, GuildSticker],
            *,
            format=None
    ):
        return cls(state, f'/stickers/{sticker.id}.{format}')

    @classmethod
    def _from_sticker_pack(
            cls,
            state: HAS_HTTP_CONNECTION,
            sticker_pack: StickerPack,
            format='png',
            size=1024
    ):
        if not utils.valid_icon_size(size):
            raise InvalidArgument("size must be a power of 2 between 16 and 4096")
        if format is not None and format not in VALID_STATIC_FORMATS:
            raise InvalidArgument("format must be None or one of {}".format(VALID_AVATAR_FORMATS))
        return cls(state, f'/app-assets/710982414301790216/store/{sticker_pack.banner_asset_id}.{format}?size={size}')

    @classmethod
    def _from_emoji(
            cls,
            state: HAS_HTTP_CONNECTION,
            emoji: Union[Emoji, PartialEmoji],
            *,
            format=None,
            static_format='png'
    ):
        if format is not None and format not in VALID_AVATAR_FORMATS:
            raise InvalidArgument("format must be None or one of {}".format(VALID_AVATAR_FORMATS))
        if format == "gif" and not emoji.animated:
            raise InvalidArgument("non animated emoji's do not support gif format")
        if static_format not in VALID_STATIC_FORMATS:
            raise InvalidArgument("static_format must be one of {}".format(VALID_STATIC_FORMATS))
        if format is None:
            format = 'gif' if emoji.animated else static_format
        return cls(state, '/emojis/{0.id}.{1}'.format(emoji, format))

    @classmethod
    def _from_guild_event(
            cls,
            state: HAS_HTTP_CONNECTION,
            event: GuildScheduledEvent,
            *,
            format=None,
            static_format='png',
            size=1024
    ):
        if not utils.valid_icon_size(size):
            raise InvalidArgument("size must be a power of 2 between 16 and 4096")
        if format is not None and format not in VALID_AVATAR_FORMATS:
            raise InvalidArgument("format must be None or one of {}".format(VALID_AVATAR_FORMATS))
        if static_format not in VALID_STATIC_FORMATS:
            raise InvalidArgument("static_format must be one of {}".format(VALID_STATIC_FORMATS))
        return cls(state, '/guild-events/{0.id}/{0.image}.{1}?size={2}'.format(event, format, size))

    def __str__(self):
        return self.BASE + self._url if self._url is not None else ''

    def __len__(self):
        if self._url:
            return len(self.BASE + self._url)
        return 0

    def __bool__(self):
        return self._url is not None

    def __repr__(self):
        return '<Asset url={0._url!r}>'.format(self)

    def __eq__(self, other):
        return isinstance(other, Asset) and self._url == other._url

    def __ne__(self, other):
        return not self.__eq__(other)

    def __hash__(self):
        return hash(self._url)

    async def read(self) -> bytes:
        """|coro|

        Retrieves the content of this asset as a :class:`bytes` object.

        .. warning::

            :class:`PartialEmoji` won't have a connection state if user created,
            and a URL won't be present if a custom image isn't associated with
            the asset, e.g. a guild with no custom icon.

        .. versionadded:: 1.1

        Raises
        ------
        DiscordException
            There was no valid URL or internal connection state.
        HTTPException
            Downloading the asset failed.
        NotFound
            The asset was deleted.

        Returns
        -------
        :class:`bytes`
            The content of the asset.
        """
        if not self._url:
            raise DiscordException('Invalid asset (no URL provided)')

        if self._state is None:
            raise DiscordException('Invalid state (no ConnectionState provided)')

        return await self._state.http.get_from_cdn(self.BASE + self._url)

    async def save(self, fp: Union[BinaryIO, PathLike], *, seek_begin: bool = True) -> int:
        """|coro|

        Saves this asset into a file-like object.

        Parameters
        ----------
        fp: Union[BinaryIO, :class:`os.PathLike`]
            Same as in :meth:`Attachment.save`.
        seek_begin: :class:`bool`
            Same as in :meth:`Attachment.save`.

        Raises
        ------
        DiscordException
            There was no valid URL or internal connection state.
        HTTPException
            Downloading the asset failed.
        NotFound
            The asset was deleted.

        Returns
        --------
        :class:`int`
            The number of bytes written.
        """

        data = await self.read()
        if isinstance(fp, io.IOBase) and fp.writable():
            written = fp.write(data)
            if seek_begin:
                fp.seek(0)
            return written
        else:
            with open(fp, 'wb') as f:
                return f.write(data)