embed.py

# cython: language_level=3
# Copyright (c) 2021-present Pycord Development
#
# 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 datetime import datetime
from typing import Any

from .color import Color
from .missing import MISSING, Maybe, MissingEnum
from .types import (
    Author as DiscordAuthor,
    Embed as DiscordEmbed,
    Field as DiscordField,
    Footer as DiscordFooter,
    Image as DiscordImage,
    Provider as DiscordProvider,
    Thumbnail as DiscordThumbnail,
    Video as DiscordVideo,
)
from .utils import remove_undefined


# pure data classes, no user interaction.
class Provider:
    def __init__(self, data: DiscordProvider) -> None:
        self.name: MissingEnum | str = data.get('name', MISSING)
        self.url: MissingEnum | str = data.get('url', MISSING)


class Video:
    def __init__(self, data: DiscordVideo) -> None:
        self.url: MissingEnum | str = data.get('url', MISSING)
        self.proxy_url: MissingEnum | str = data.get('proxy_url', MISSING)
        self.width: MissingEnum | int = data.get('width', MISSING)
        self.height: MissingEnum | int = data.get('height', MISSING)


class Thumbnail:
    def __init__(self, url: str) -> None:
        self.url: str = url
        self.proxy_url: str | MissingEnum = MISSING
        self.height: MissingEnum | int = MISSING
        self.width: MissingEnum | int = MISSING

    @classmethod
    def _from_data(cls, data: DiscordThumbnail) -> 'Thumbnail':
        self = cls(data['url'])
        self.proxy_url = data.get('proxy_url', MissingEnum)
        self.height = data.get('height', MissingEnum)
        self.width = data.get('width', MissingEnum)
        return self

    def _to_data(self) -> dict[str, Any]:
        return remove_undefined(url=self.url)


class Image:
    def __init__(self, url: str) -> None:
        self.url: str = url
        self.proxy_url: str | MissingEnum = MISSING
        self.height: MissingEnum | int = MISSING
        self.width: MissingEnum | int = MISSING

    @classmethod
    def _from_data(cls, data: DiscordImage) -> 'Image':
        self = cls(data['url'])
        self.proxy_url = data.get('proxy_url', MissingEnum)
        self.height = data.get('height', MissingEnum)
        self.width = data.get('width', MissingEnum)
        return self

    def _to_data(self) -> dict[str, Any]:
        return remove_undefined(url=self.url)


class Footer:
    def __init__(self, text: str, icon_url: str | MissingEnum = MISSING) -> None:
        self.text = text
        self.icon_url = icon_url
        self.proxy_icon_url: MissingEnum | str = MISSING

    @classmethod
    def _from_data(cls, data: DiscordFooter) -> 'Footer':
        self = cls(data['text'], data.get('icon_url', MISSING))
        self.proxy_icon_url = data.get('proxy_icon_url', MISSING)
        return self

    def _to_data(self) -> dict[str, Any]:
        return remove_undefined(text=self.text, icon_url=self.icon_url)


class Author:
    def __init__(
        self,
        name: str,
        icon_url: str | MissingEnum = MISSING,
        url: str | MissingEnum = MISSING,
    ) -> None:
        self.name = name
        self.url = url
        self.icon_url = icon_url
        self.proxy_icon_url: MissingEnum | str = MISSING

    @classmethod
    def _from_data(cls, data: DiscordAuthor) -> 'Author':
        self = cls(data['name'], data.get('icon_url', MISSING, data['url']))
        self.proxy_icon_url = data.get('proxy_icon_url', MISSING)
        return self

    def _to_data(self) -> dict[str, Any]:
        return remove_undefined(name=self.name, url=self.url, icon_url=self.icon_url)


class Field:
    def __init__(
        self, name: str, value: str, inline: bool | MissingEnum = MISSING
    ) -> None:
        self.name = name
        self.value = value
        self.inline = inline

    @classmethod
    def _from_data(cls, data: DiscordField) -> 'Field':
        return cls(data['name'], data['value'], data.get('field', MISSING))

    def _to_data(self) -> dict[str, Any]:
        return remove_undefined(name=self.name, value=self.value, inline=self.inline)


# settable:
# footer
# fields
# image
# thumbnail
# author
# NOTE: this is the only class not having data being parsed in __init__ because of it being used mostly by users.
class Embed:
    def __init__(
        self,
        *,
        title: str,
        description: str | MissingEnum = MISSING,
        url: str | MissingEnum = MISSING,
        timestamp: datetime | MissingEnum = MISSING,
        color: Color | MissingEnum = MISSING,
        thumbnail: Thumbnail | MissingEnum = MISSING,
        author: Author | MissingEnum = MISSING,
        footer: Footer | MissingEnum = MISSING,
        image: Image | MissingEnum = MISSING,
        fields: list[Field] = None,
    ) -> None:
        if fields is None:
            fields = []
        self.thumbnail = thumbnail
        self.author = author
        self.footer = footer
        self.image = image
        self.fields = fields
        self.title = title
        self.description = description
        self.url = url
        self.timestamp = timestamp
        self.color = color

    @classmethod
    def _from_data(cls, data: DiscordEmbed) -> None:
        color = Color(data.get('color')) if data.get('color') is not None else None
        thumbnail = (
            Thumbnail._from_data(data.get('thumbnail'))
            if data.get('thumbnail') is not None
            else None
        )
        video = Video(data.get('video')) if data.get('video') is not None else None
        provider = (
            Provider(data.get('provider')) if data.get('provider') is not None else None
        )
        author = (
            Author._from_data(data.get('author'))
            if data.get('author') is not None
            else None
        )
        footer = (
            Footer._from_data(data.get('footer'))
            if data.get('footer') is not None
            else None
        )
        image = (
            Image._from_data(data.get('thumbnail'))
            if data.get('thumbnail') is not None
            else None
        )
        fields = [Field._from_data(field) for field in data.get('fields', [])]

        self = cls(
            title=data.get('title'),
            description=data.get('description'),
            url=data.get('url'),
            timestamp=datetime.fromisoformat(data.get('timestamp'))
            if data.get('timestamp') is not None
            else None,
            color=color,
            footer=footer,
            image=image,
            thumbnail=thumbnail,
            author=author,
            fields=fields,
        )
        self.video = video
        self.provider = provider

    def _to_data(self) -> dict[str, Any]:
        color = self.color.value if self.color else None
        thumbnail = self.thumbnail._to_data() if self.thumbnail else MISSING
        author = self.author._to_data() if self.author else MISSING
        footer = self.footer._to_data() if self.footer else MISSING
        image = self.image._to_data() if self.image else MISSING
        fields = [field._to_data() for field in self.fields]
        timestamp = self.timestamp.isoformat() if self.timestamp else MISSING

        return remove_undefined(
            title=self.title,
            description=self.description,
            url=self.url,
            color=color,
            timestamp=timestamp,
            thumbnail=thumbnail,
            footer=footer,
            author=author,
            image=image,
            fields=fields,
        )