revolt_database/models/files/

model.rs

use crate::{Database, FileHash, Metadata};

use iso8601_timestamp::Timestamp;
use revolt_result::Result;

auto_derived_partial!(
    /// File
    pub struct File {
        /// Unique Id
        #[serde(rename = "_id")]
        pub id: String,
        /// Tag / bucket this file was uploaded to
        pub tag: String,
        /// Original filename
        pub filename: String,
        /// Hash of this file
        pub hash: Option<String>, // these are Option<>s to not break file uploads on legacy Autumn

        /// When this file was uploaded
        pub uploaded_at: Option<Timestamp>, // these are Option<>s to not break file uploads on legacy Autumn
        /// ID of user who uploaded this file
        #[serde(skip_serializing_if = "Option::is_none")]
        pub uploader_id: Option<String>, // these are Option<>s to not break file uploads on legacy Autumn

        /// What the file was used for
        #[serde(skip_serializing_if = "Option::is_none")]
        pub used_for: Option<FileUsedFor>,

        /// Whether this file was deleted
        #[serde(skip_serializing_if = "Option::is_none")]
        pub deleted: Option<bool>,
        /// Whether this file was reported
        #[serde(skip_serializing_if = "Option::is_none")]
        pub reported: Option<bool>,

        // !!! DEPRECATED:
        /// Parsed metadata of this file
        pub metadata: Metadata,
        /// Raw content type of this file
        pub content_type: String,
        /// Size of this file (in bytes)
        pub size: isize,

        // TODO: migrate this mess to having:
        // - author_id
        // - parent: Parent { Message(id), User(id), etc }
        #[serde(skip_serializing_if = "Option::is_none")]
        pub message_id: Option<String>,
        #[serde(skip_serializing_if = "Option::is_none")]
        pub user_id: Option<String>,
        #[serde(skip_serializing_if = "Option::is_none")]
        pub server_id: Option<String>,

        /// Id of the object this file is associated with
        #[serde(skip_serializing_if = "Option::is_none")]
        pub object_id: Option<String>,
    },
    "PartialFile"
);

auto_derived!(
    /// Type of object file was used for
    pub enum FileUsedForType {
        Message,
        ServerBanner,
        Emoji,
        UserAvatar,
        WebhookAvatar,
        UserProfileBackground,
        LegacyGroupIcon,
        ChannelIcon,
        ServerIcon,
        RoleIcon,
    }

    /// Information about what the file was used for
    pub struct FileUsedFor {
        /// Type of the object
        #[serde(rename = "type")]
        pub object_type: FileUsedForType,
        /// ID of the object
        pub id: String,
    }
);

impl File {
    /// Get the hash entry for this file
    pub async fn as_hash(&self, db: &Database) -> Result<FileHash> {
        db.fetch_attachment_hash(self.hash.as_ref().unwrap()).await
    }

    /// Use a file for a message attachment
    pub async fn use_attachment(
        db: &Database,
        id: &str,
        parent: &str,
        uploader_id: &str,
    ) -> Result<File> {
        db.find_and_use_attachment(
            id,
            "attachments",
            FileUsedFor {
                id: parent.to_owned(),
                object_type: FileUsedForType::Message,
            },
            uploader_id.to_owned(),
        )
        .await
    }

    /// Use a file for a user profile background
    pub async fn use_background(
        db: &Database,
        id: &str,
        parent: &str,
        uploader_id: &str,
    ) -> Result<File> {
        db.find_and_use_attachment(
            id,
            "backgrounds",
            FileUsedFor {
                id: parent.to_owned(),
                object_type: FileUsedForType::UserProfileBackground,
            },
            uploader_id.to_owned(),
        )
        .await
    }

    /// Use a file for a user avatar
    pub async fn use_user_avatar(
        db: &Database,
        id: &str,
        parent: &str,
        uploader_id: &str,
    ) -> Result<File> {
        db.find_and_use_attachment(
            id,
            "avatars",
            FileUsedFor {
                id: parent.to_owned(),
                object_type: FileUsedForType::UserAvatar,
            },
            uploader_id.to_owned(),
        )
        .await
    }

    /// Use a file for a webhook avatar
    pub async fn use_webhook_avatar(
        db: &Database,
        id: &str,
        parent: &str,
        uploader_id: &str,
    ) -> Result<File> {
        db.find_and_use_attachment(
            id,
            "avatars",
            FileUsedFor {
                id: parent.to_owned(),
                object_type: FileUsedForType::WebhookAvatar,
            },
            uploader_id.to_owned(),
        )
        .await
    }

    /// Use a file for a server icon
    pub async fn use_server_icon(
        db: &Database,
        id: &str,
        parent: &str,
        uploader_id: &str,
    ) -> Result<File> {
        db.find_and_use_attachment(
            id,
            "icons",
            FileUsedFor {
                id: parent.to_owned(),
                object_type: FileUsedForType::ServerIcon,
            },
            uploader_id.to_owned(),
        )
        .await
    }

    /// Use a file for a channel icon
    pub async fn use_channel_icon(
        db: &Database,
        id: &str,
        parent: &str,
        uploader_id: &str,
    ) -> Result<File> {
        db.find_and_use_attachment(
            id,
            "icons",
            FileUsedFor {
                id: parent.to_owned(),
                object_type: FileUsedForType::ChannelIcon,
            },
            uploader_id.to_owned(),
        )
        .await
    }

    /// Use a file for a server banner
    pub async fn use_server_banner(
        db: &Database,
        id: &str,
        parent: &str,
        uploader_id: &str,
    ) -> Result<File> {
        db.find_and_use_attachment(
            id,
            "banners",
            FileUsedFor {
                id: parent.to_owned(),
                object_type: FileUsedForType::ServerBanner,
            },
            uploader_id.to_owned(),
        )
        .await
    }

    /// Use a file for an emoji
    pub async fn use_emoji(
        db: &Database,
        id: &str,
        parent: &str,
        uploader_id: &str,
    ) -> Result<File> {
        db.find_and_use_attachment(
            id,
            "emojis",
            FileUsedFor {
                id: parent.to_owned(),
                object_type: FileUsedForType::Emoji,
            },
            uploader_id.to_owned(),
        )
        .await
    }

    /// Use a file for a role icon
    pub async fn use_role_icon(
        db: &Database,
        id: &str,
        parent: &str,
        uploader_id: &str,
    ) -> Result<File> {
        db.find_and_use_attachment(
            id,
            "icons",
            FileUsedFor {
                id: parent.to_owned(),
                object_type: FileUsedForType::RoleIcon,
            },
            uploader_id.to_owned(),
        )
        .await
    }
}