User.php

<?php

/*
 * This file is a part of the DiscordPHP project.
 *
 * Copyright (c) 2015-present David Cole <david.cole1340@gmail.com>
 *
 * This file is subject to the MIT license that is bundled
 * with this source code in the LICENSE.md file.
 */

namespace Discord\Parts\User;

use Discord\Builders\MessageBuilder;
use Discord\Helpers\BigInt;
use Discord\Http\Endpoint;
use Discord\Parts\Channel\Channel;
use Discord\Parts\Part;
use Discord\Parts\Channel\Message;
use React\Promise\ExtendedPromiseInterface;

use Stringable;
use function React\Promise\resolve;

/**
 * A user is a general user that is not attached to a guild.
 *
 * @link https://discord.com/developers/docs/resources/user
 *
 * @since 2.0.0
 *
 * @property string       $id                     The unique identifier of the user.
 * @property string       $username               The username of the user.
 * @property string       $discriminator          The discriminator of the user.
 * @property string|null  $global_name            The user's display name, if it is set. For bots, this is the application name.
 * @property string       $displayname            The display name of the client.
 * @property ?string      $avatar                 The avatar URL of the user.
 * @property string|null  $avatar_hash            The avatar hash of the user.
 * @property bool|null    $bot                    Whether the user is a bot.
 * @property bool|null    $system                 Whether the user is a Discord system user.
 * @property bool|null    $mfa_enabled            Whether MFA is enabled.
 * @property ?string|null $banner                 The banner URL of the user.
 * @property string|null  $banner_hash            The banner hash of the user.
 * @property ?int|null    $accent_color           The user's banner color encoded as an integer representation of hexadecimal color code.
 * @property string|null  $locale                 User locale.
 * @property bool|null    $verified               Whether the user is verified.
 * @property ?string|null $email                  User email.
 * @property int|null     $flags                  User flags.
 * @property int|null     $premium_type           Type of nitro subscription.
 * @property int|null     $public_flags           Public flags on the user.
 * @property int|null     $avatar_decoration      The user's avatar decoration URL.
 * @property int|null     $avatar_decoration_hash The user's avatar decoration hash.
 *
 * @method ExtendedPromiseInterface<Message> sendMessage(MessageBuilder $builder)
 */
class User extends Part implements Stringable
{
    public const FLAG_DISCORD_EMPLOYEE = (1 << 0);
    public const FLAG_DISCORD_PARTNER = (1 << 1);
    public const FLAG_HYPESQUAD_EVENTS = (1 << 2);
    public const FLAG_BUG_HUNTER_LEVEL_1 = (1 << 3);
    public const FLAG_HOUSE_BRAVERY = (1 << 6);
    public const FLAG_HOUSE_BRILLIANCE = (1 << 7);
    public const FLAG_HOUSE_BALANCE = (1 << 8);
    public const FLAG_EARLY_SUPPORTER = (1 << 9);
    public const FLAG_TEAM_USER = (1 << 10);
    public const FLAG_SYSTEM = (1 << 12);
    public const FLAG_BUG_HUNTER_LEVEL_2 = (1 << 14);
    public const FLAG_VERIFIED_BOT = (1 << 16);
    public const FLAG_VERIFIED_BOT_DEVELOPER = (1 << 17);
    public const FLAG_DISCORD_CERTIFIED_MODERATOR = (1 << 18);
    public const BOT_HTTP_INTERACTIONS = (1 << 19);
    public const FLAG_ACTIVE_DEVELOPER = (1 << 22);

    public const PREMIUM_NONE = 0;
    public const PREMIUM_NITRO_CLASSIC = 1;
    public const PREMIUM_NITRO = 2;
    public const PREMIUM_NITRO_BASIC = 3;

    /**
     * {@inheritDoc}
     */
    protected $fillable = [
        'id',
        'username',
        'discriminator',
        'global_name',
        'avatar',
        'avatar_decoration',
        'bot',
        'system',
        'mfa_enabled',
        'locale',
        'verified',
        'email',
        'flags',
        'banner',
        'accent_color',
        'premium_type',
        'public_flags',
    ];

    /**
     * Gets the private channel for the user.
     *
     * @link https://discord.com/developers/docs/resources/user#create-dm
     *
     * @return ExtendedPromiseInterface<Channel>
     */
    public function getPrivateChannel(): ExtendedPromiseInterface
    {
        if ($channel = $this->discord->private_channels->get('recipient_id', $this->id)) {
            return resolve($channel);
        }

        return $this->http->post(Endpoint::USER_CURRENT_CHANNELS, ['recipient_id' => $this->id])->then(function ($response) {
            $channel = $this->discord->private_channels->create($response, true);
            $this->discord->private_channels->pushItem($channel);

            return $channel;
        });
    }

    /**
     * Sends a message to the user.
     *
     * Takes a `MessageBuilder` or content of the message for the first parameter. If the first parameter
     * is an instance of `MessageBuilder`, the rest of the arguments are disregarded.
     *
     * @link https://discord.com/developers/docs/resources/channel#create-message
     *
     * @param MessageBuilder|string                 $message          The message builder that should be converted into a message, or the string content of the message.
     * @param bool                                  $tts              Whether the message is TTS.
     * @param \Discord\Parts\Embed\Embed|array|null $embed            An embed object or array to send in the message.
     * @param array|null                            $allowed_mentions Allowed mentions object for the message.
     * @param Message|null                          $replyTo          Sends the message as a reply to the given message instance.
     *
     * @return ExtendedPromiseInterface<Message>
     */
    public function sendMessage($message, bool $tts = false, $embed = null, $allowed_mentions = null, ?Message $replyTo = null): ExtendedPromiseInterface
    {
        return $this
            ->getPrivateChannel()
            ->then(fn (Channel $channel) => $channel->sendMessage($message, $tts, $embed, $allowed_mentions, $replyTo));
    }

    /**
     * Broadcasts that you are typing to the channel. Lasts for 5 seconds.
     *
     * @link https://discord.com/developers/docs/resources/channel#trigger-typing-indicator
     *
     * @throws \RuntimeException
     *
     * @return ExtendedPromiseInterface
     */
    public function broadcastTyping(): ExtendedPromiseInterface
    {
        return $this->getPrivateChannel()->then(fn (Channel $channel) => $channel->broadcastTyping());
    }

    /**
     * Returns the display name of the client.
     *
     * @return string Either global_name or username with optional #discriminator.
     */
    protected function getDisplaynameAttribute(): string
    {
        return $this->global_name ?? $this->username.($this->discriminator !== '0' ? '#'.$this->discriminator : '');
    }

    /**
     * Returns the avatar URL for the client.
     *
     * @param string|null $format The image format.
     * @param int         $size   The size of the image.
     *
     * @return string The URL to the client's avatar.
     */
    public function getAvatarAttribute(?string $format = null, int $size = 1024): string
    {
        if (empty($this->attributes['avatar'])) {
            $avatarDiscrim = (($this->discriminator) ? $this->discriminator % 5 : BigInt::shiftRight($this->id, 22) % 6);

            return "https://cdn.discordapp.com/embed/avatars/{$avatarDiscrim}.png?size={$size}";
        }

        if (isset($format)) {
            $allowed = ['png', 'jpg', 'webp', 'gif'];

            if (! in_array(strtolower($format), $allowed)) {
                $format = 'webp';
            }
        } elseif (strpos($this->attributes['avatar'], 'a_') === 0) {
            $format = 'gif';
        } else {
            $format = 'webp';
        }

        return "https://cdn.discordapp.com/avatars/{$this->id}/{$this->attributes['avatar']}.{$format}?size={$size}";
    }

    /**
     * Returns the avatar hash for the client.
     *
     * @return ?string The client avatar's hash.
     */
    protected function getAvatarHashAttribute(): ?string
    {
        return $this->attributes['avatar'];
    }

    /**
     * Returns the avatar decoration URL for the client.
     *
     * @param string|null $format The image format.
     * @param int         $size   The size of the image.
     *
     * @return string|null The URL to the clients avatar decoration.
     */
    public function getAvatarDecorationAttribute(?string $format = null, int $size = 288): ?string
    {
        if (! isset($this->attributes['avatar_decoration'])) {
            return null;
        }

        if (isset($format)) {
            $allowed = ['png', 'jpg', 'webp'];

            if (! in_array(strtolower($format), $allowed)) {
                $format = 'png';
            }
        } elseif (strpos($this->attributes['avatar_decoration'], 'a_') === 0) {
            $format = 'png';
        } else {
            $format = 'png';
        }

        return "https://cdn.discordapp.com/avatar-decorations/{$this->id}/{$this->attributes['avatar_decoration']}.{$format}?size={$size}";
    }

    /**
     * Returns the avatar decoration hash for the client.
     *
     * @return ?string The client avatar decoration's hash.
     */
    protected function getAvatarDecorationHashAttribute(): ?string
    {
        return $this->attributes['avatar_decoration'];
    }

    /**
     * Returns the banner URL for the client.
     *
     * @param string|null $format The image format.
     * @param int         $size   The size of the image.
     *
     * @return string|null The URL to the clients banner.
     */
    public function getBannerAttribute(?string $format = null, int $size = 600): ?string
    {
        if (empty($this->attributes['banner'])) {
            return null;
        }

        if (isset($format)) {
            $allowed = ['png', 'jpg', 'webp', 'gif'];

            if (! in_array(strtolower($format), $allowed)) {
                $format = 'png';
            }
        } elseif (strpos($this->attributes['banner'], 'a_') === 0) {
            $format = 'gif';
        } else {
            $format = 'png';
        }

        return "https://cdn.discordapp.com/banners/{$this->id}/{$this->attributes['banner']}.{$format}?size={$size}";
    }

    /**
     * Returns the banner hash for the client.
     *
     * @return ?string|null The client banner's hash.
     */
    protected function getBannerHashAttribute(): ?string
    {
        return $this->attributes['banner'] ?? null;
    }

    /**
     * Returns a timestamp for when a user's account was created.
     *
     * @return ?float
     */
    public function createdTimestamp()
    {
        return \Discord\getSnowflakeTimestamp($this->id);
    }

    /**
     * {@inheritDoc}
     */
    public function getRepositoryAttributes(): array
    {
        return [
            'user_id' => $this->id,
        ];
    }

    /**
     * Returns a formatted mention.
     *
     * @return string A formatted mention.
     */
    public function __toString(): string
    {
        return "<@{$this->id}>";
    }
}