path: root/entities/src/instance.rs

//! Module containing everything related to an instance.
use isolang::Language;
use serde::{Deserialize, Serialize};
use time::{serde::iso8601, OffsetDateTime};
use url::Url;

use crate::{account::Account, admin, conversion, RuleId};

/// Represents the software instance of Mastodon running on this domain.
///
/// See also [the API documentation](https://docs.joinmastodon.org/entities/Instance/)
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Instance {
    /// The domain name of the instance.
    pub domain: String,
    /// The title of the website.
    pub title: String,
    /// The version of Mastodon installed on the instance.
    pub version: String,
    /// The URL for the source code of the software running on this instance, in keeping with AGPL license requirements.
    pub source_url: String,
    /// A short, plain-text description defined by the admin.
    pub description: String,
    /// Usage data for this instance.
    pub usage: Usage,
    /// An image used to represent this instance.
    pub thumbnail: Thumbnail,
    /// Primary languages of the website and its staff.
    pub languages: Vec<Language>,
    /// Configured values and limits for this website.
    pub configuration: Configuration,
    /// Information about registering for this website.
    pub registrations: Registrations,
    /// Hints related to contacting a representative of the website.
    pub contact: Contact,
    /// An itemized list of rules for this website.
    pub rules: Vec<Rule>,
}

/// Usage data for this instance.
#[derive(Default, Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub struct Usage {
    /// Usage data related to users on this instance.
    pub users: Users,
}

#[derive(Default, Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub struct Users {
    pub active_month: i64,
}

/// An image used to represent this instance.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Thumbnail {
    /// The URL for the thumbnail image.
    pub url: String,
    /// A hash computed by [the BlurHash algorithm](https://github.com/woltapp/blurhash),
    /// for generating colorful preview thumbnails when media has not been
    /// downloaded yet.
    pub blurhash: String,
    /// Links to scaled resolution images, for high DPI screens.
    pub versions: ThumbnailVersions,
}

/// Links to scaled resolution images, for high DPI screens.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ThumbnailVersions {
    /// The URL for the thumbnail image at 1x resolution.
    #[serde(rename = "@1x")]
    pub at_1x: Url,
    /// The URL for the thumbnail image at 2x resolution.
    #[serde(rename = "@2x")]
    pub at_2x: Url,
}

/// Hints related to contacting a representative of the website.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Contact {
    /// An email address that can be messaged regarding inquiries or issues.
    pub email: String,
    /// An account that can be contacted natively over the network regarding inquiries or issues.
    pub account: Account,
}

/// Information about registering for this website.
#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Registrations {
    /// Whether registrations are enabled.
    pub enabled: bool,
    /// Whether registrations require moderator approval.
    pub approval_required: bool,
    /// A custom, HTML-formatted message to be shown when registrations are closed.
    pub message: Option<String>,
}
/// Represents a rule that server users should follow.
///
/// See also [the API documentation](https://docs.joinmastodon.org/entities/Rule/)
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
pub struct Rule {
    /// An identifier for the rule.
    pub id: RuleId,
    /// The rule to be followed.
    pub text: String,
}

/// Represents a domain that is blocked by the instance.
///
/// See also [the API documentation](https://docs.joinmastodon.org/entities/DomainBlock/)
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
pub struct DomainBlock {
    /// The domain which is blocked. This may be obfuscated or partially censored.
    pub domain: String,
    /// The SHA256 hash digest of the domain string.
    pub digest: String,
    /// The level to which the domain is blocked.
    pub severity: admin::domain::BlockSeverity,
    /// Admin's public comment, an optional reason for the domain block.
    pub comment: Option<String>,
}

/// Weekly activity on an instance
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
pub struct Activity {
    /// UNIX Timestamp at midnight at the first day of the week.
    pub week: String,
    /// The number of Statuses created since the week began (cast from an integer)
    #[serde(with = "conversion::string_to::u64")]
    pub statuses: u64,
    /// The number of user logins since the week began (cast from an integer)
    #[serde(with = "conversion::string_to::u64")]
    pub logins: u64,
    /// The number of user registrations since the week began (cast from an integer)
    #[serde(with = "conversion::string_to::u64")]
    pub registrations: u64,
}

/// Configured values and limits for this website.
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
pub struct Configuration {
    /// URLs of interest for clients apps.
    pub urls: configuration::Urls,
    /// Limits related to accounts.
    pub accounts: v1::configuration::Accounts,
    /// Limits related to authoring statuses.
    pub statuses: v1::configuration::Statuses,
    /// Hints for which attachments will be accepted.
    pub media_attachments: v1::configuration::MediaAttachments,
    /// Hints for which attachments will be accepted.
    pub polls: v1::configuration::Polls,
    /// Hints related to translation.
    pub translation: configuration::Translation,
}

/// Represents an extended description for the instance, to be shown on its about page.
///
/// See also [the API documentation](https://docs.joinmastodon.org/entities/ExtendedDescription/)
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
pub struct ExtendedDescription {
    /// A timestamp of when the extended description was last updated.
    #[serde(with = "iso8601")]
    pub updated_at: OffsetDateTime,
    /// The rendered HTML content of the extended description.
    pub content: String,
}

pub mod configuration {
    use serde::{Deserialize, Serialize};
    use url::Url;

    /// Url configurations
    #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
    pub struct Urls {
        /// Url for streaming API, typically a `wss://` url.
        pub streaming: Url,
    }

    /// Hints related to translation.
    #[derive(Debug, Copy, Clone, Deserialize, Serialize, PartialEq, Eq)]
    pub struct Translation {
        /// Whether the Translations API is available on this instance.
        pub enabled: bool,
    }
}

pub mod v1 {
    use isolang::Language;
    use url::Url;

    use super::*;

    /// Obsolete type, see [`super::Instance`]. Represents the software instance
    /// of Mastodon running on this domain.
    ///
    /// See also [the API documentation](https://docs.joinmastodon.org/entities/V1_Instance/)
    #[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
    pub struct Instance {
        /// URI of the current instance
        pub uri: String,
        /// The instance's title.
        pub title: String,
        /// A description for the instance.
        pub description: String,
        /// A short, plain-text description defined by the admin.
        pub short_description: String,
        /// An email address which can be used to contact the
        /// instance administrator.
        pub email: String,
        /// The Mastodon version used by instance.
        pub version: String,
        /// Urls to the streaming api.
        pub urls: Option<Urls>,
        /// Stats about the instance.
        pub stats: Option<Stats>,
        /// Thumbnail of the server image.
        pub thumbnail: Option<Url>,
        /// List of languages used on the server.
        pub languages: Option<Vec<Language>>,
        /// Whether registrations are enabled.
        pub registrations: bool,
        /// Whether registrations require moderator approval.
        pub approval_required: bool,
        /// A user that can be contacted, as an alternative to email.
        pub contact_account: Account,
        /// An itemized list of rules for this website.  
        pub rules: Vec<Rule>,
        /// Configured values and limits for this website.
        pub configuration: Configuration,
    }

    /// Statistics about the Mastodon instance.
    #[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq, Eq)]
    pub struct Stats {
        /// Total users on this instance.
        pub user_count: u64,
        /// Total statuses on this instance.
        pub status_count: u64,
        /// Total domains discovered by this instance.
        pub domain_count: u64,
    }

    #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
    pub struct Configuration {
        /// Limits related to accounts.
        pub accounts: Option<configuration::Accounts>,
        /// Limits related to authoring statuses.
        pub statuses: configuration::Statuses,
        /// Hints for which attachments will be accepted.
        pub media_attachments: configuration::MediaAttachments,
    }

    /// Url configurations
    #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
    pub struct Urls {
        /// Url for streaming API, typically a `wss://` url.
        pub streaming_api: Url,
    }

    pub mod configuration {
        use serde::{Deserialize