python-client-sdk/revolt/user.py

from __future__ import annotations

from typing import TYPE_CHECKING, NamedTuple, Optional, Union
from weakref import WeakValueDictionary

from .asset import Asset, PartialAsset
from .channel import DMChannel, GroupDMChannel
from .enums import PresenceType, RelationshipType
from .flags import UserBadges
from .messageable import Messageable
from .permissions import UserPermissions
from .utils import Ulid

if TYPE_CHECKING:
    from .member import Member
    from .state import State
    from .types import File
    from .types import Status as StatusPayload
    from .types import User as UserPayload
    from .types import UserProfile as UserProfileData
    from .server import Server

__all__ = ("User", "Status", "Relation", "UserProfile")

class Relation(NamedTuple):
    """A namedtuple representing a relation between the bot and a user"""
    type: RelationshipType
    user: User

class Status(NamedTuple):
    """A namedtuple representing a users status"""
    text: Optional[str]
    presence: Optional[PresenceType]

class UserProfile(NamedTuple):
    """A namedtuple representing a users profile"""
    content: Optional[str]
    background: Optional[Asset]

class User(Messageable, Ulid):
    """Represents a user

    Attributes
    -----------
    id: :class:`str`
        The users id
    bot: :class:`bool`
        Whether or not the user is a bot
    owner_id: Optional[:class:`str`]
        The bot's owner id if the user is a bot
    badges: :class:`UserBadges`
        The users badges
    online: :class:`bool`
        Whether or not the user is online
    flags: :class:`int`
        The user flags
    relations: list[:class:`Relation`]
        A list of the users relations
    relationship: Optional[:class:`RelationshipType`]
        The relationship between the user and the bot
    status: Optional[:class:`Status`]
        The users status
    dm_channel: Optional[:class:`DMChannel`]
        The dm channel between the client and the user, this will only be set if the client has dm'ed the user or :meth:`User.open_dm` was run
    privileged: :class:`bool`
        Whether the user is privileged
    """
    __flattern_attributes__: tuple[str, ...] = ("id", "bot", "owner_id", "badges", "online", "flags", "relations", "relationship", "status", "masquerade_avatar", "masquerade_name", "original_name", "original_avatar", "profile", "dm_channel", "privileged")
    __slots__: tuple[str, ...] = (*__flattern_attributes__, "state", "_members")

    def __init__(self, data: UserPayload, state: State):
        self.state = state
        self._members: WeakValueDictionary[str, Member] = WeakValueDictionary()  # we store all member versions of this user to avoid having to check every guild when needing to update.
        self.id: str = data["_id"]
        self.original_name: str = data["username"]
        self.dm_channel: DMChannel | None = None

        bot = data.get("bot")

        self.bot: bool
        self.owner_id: str | None

        if bot:
            self.bot = True
            self.owner_id = bot["owner"]
        else:
            self.bot = False
            self.owner_id = None

        self.badges: UserBadges = UserBadges._from_value(data.get("badges", 0))
        self.online: bool = data.get("online", False)
        self.flags: int = data.get("flags", 0)
        self.privileged: bool = data.get("privileged", False)

        avatar = data.get("avatar")
        self.original_avatar: Asset | None = Asset(avatar, state) if avatar else None

        relations: list[Relation] = []

        for relation in data.get("relations", []):
            user = state.get_user(relation["_id"])
            if user:
                relations.append(Relation(RelationshipType(relation["status"]), user))
        self.relations: list[Relation] = relations

        relationship = data.get("relationship")
        self.relationship: RelationshipType | None = RelationshipType(relationship) if relationship else None

        status = data.get("status")
        self.status: Status | None

        if status:
            presence = status.get("presence")
            self.status = Status(status.get("text"), PresenceType(presence) if presence else None) if status else None
        else:
            self.status = None

        self.profile: Optional[UserProfile] = None

        self.masquerade_avatar: Optional[PartialAsset] = None
        self.masquerade_name: Optional[str] = None

    def get_permissions(self) -> UserPermissions:
        """Gets the permissions for the user

        Returns
        --------
        :class:`UserPermissions`
            The users permissions
        """
        permissions = UserPermissions()

        if self.relationship in [RelationshipType.friend, RelationshipType.user]:
            return UserPermissions.all()

        elif self.relationship in [RelationshipType.blocked, RelationshipType.blocked_other]:
            return UserPermissions(access=True)

        elif self.relationship in [RelationshipType.incoming_friend_request, RelationshipType.outgoing_friend_request]:
            permissions.access = True

        for channel in self.state.channels.values():
            if (isinstance(channel, (GroupDMChannel, DMChannel)) and self.id in channel.recipient_ids) or any(self.id in (m.id for m in server.members) for server in self.state.servers.values()):
                if self.state.me.bot or self.bot:
                    permissions.send_message = True

                permissions.access = True
                permissions.view_profile = True

        return permissions

    def has_permissions(self, **permissions: bool) -> bool:
        """Computes if the user has the specified permissions

        Parameters
        -----------
        permissions: :class:`bool`
            The permissions to check, this also accepted `False` if you need to check if the user does not have the permission

        Returns
        --------
        :class:`bool`
            Whether or not they have the permissions
        """
        perms = self.get_permissions()

        return all([getattr(perms, key, False) == value for key, value in permissions.items()])

    async def _get_channel_id(self):
        if not self.dm_channel:
            payload = await self.state.http.open_dm(self.id)
            self.dm_channel = DMChannel(payload, self.state)

        return self.id

    @property
    def owner(self) -> User:
        """:class:`User` the owner of the bot account"""

        if not self.owner_id:
            raise LookupError

        return self.state.get_user(self.owner_id)

    @property
    def name(self) -> str:
        """:class:`str` The name the user is displaying, this includes there orginal name and masqueraded name"""
        return self.masquerade_name or self.original_name

    @property
    def avatar(self) -> Union[Asset, PartialAsset, None]:
        """Optional[:class:`Asset`] The avatar the member is displaying, this includes there orginal avatar and masqueraded avatar"""
        return self.masquerade_avatar or self.original_avatar

    @property
    def mention(self) -> str:
        """:class:`str`: Returns a string that allows you to mention the given user."""
        return f"<@{self.id}>"

    def _update(self, *, status: Optional[StatusPayload] = None, profile: Optional[UserProfileData] = None, avatar: Optional[File] = None, online: Optional[bool] = None):
        if status is not None:
            presence = status.get("presence")
            self.status = Status(status.get("text"), PresenceType(presence) if presence else None)

        if profile is not None:
            if background_file := profile.get("background"):
                background = Asset(background_file, self.state)
            else:
                background = None

            self.profile = UserProfile(profile.get("content"), background)

        if avatar is not None:
            self.original_avatar = Asset(avatar, self.state)

        if online is not None:
            self.online = online

        # update user infomation for all members

        if self.__class__ is User:
            for member in self._members.values():
                User._update(member, status=status, profile=profile, avatar=avatar, online=online)

    async def default_avatar(self) -> bytes:
        """Returns the default avatar for this user

        Returns
        --------
        :class:`bytes`
            The bytes of the image
        """
        return await self.state.http.fetch_default_avatar(self.id)

    async def fetch_profile(self) -> UserProfile:
        """Fetches the user's profile

        Returns
        --------
        :class:`UserProfile`
            The user's profile
        """
        if profile := self.profile:
            return profile

        payload = await self.state.http.fetch_profile(self.id)

        if file := payload.get("background"):
            background = Asset(file, self.state)
        else:
            background = None

        self.profile = UserProfile(payload.get("content"), background)
        return self.profile

    def to_member(self, server: Server) -> Member:
        """Gets the member instance for this user for a specific server.

        Roughly equivelent to:

        .. code-block:: python

            member = server.get_member(user.id)


        Parameters
        -----------
        server: :class:`Server`
            The server to get the member for

        Returns
        --------
        :class:`Member`
            The member

        Raises
        -------
        :class:`LookupError`

        """
        try:
            return self._members[server.id]
        except IndexError:
            raise LookupError from None