mas_handlers/graphql/model/
site_config.rs

1// Copyright 2024 New Vector Ltd.
2// Copyright 2024 The Matrix.org Foundation C.I.C.
3//
4// SPDX-License-Identifier: AGPL-3.0-only
5// Please see LICENSE in the repository root for full details.
6
7#![allow(clippy::str_to_string)] // ComplexObject macro uses &str.to_string()
8
9use async_graphql::{ComplexObject, Enum, ID, SimpleObject};
10use url::Url;
11
12pub const SITE_CONFIG_ID: &str = "site_config";
13pub const CAPTCHA_CONFIG_ID: &str = "captcha_config";
14
15#[derive(SimpleObject)]
16#[graphql(complex)]
17#[allow(clippy::struct_excessive_bools)]
18pub struct SiteConfig {
19    /// The configuration of CAPTCHA provider.
20    captcha_config: Option<CaptchaConfig>,
21
22    /// The server name of the homeserver.
23    server_name: String,
24
25    /// The URL to the privacy policy.
26    policy_uri: Option<Url>,
27
28    /// The URL to the terms of service.
29    tos_uri: Option<Url>,
30
31    /// Imprint to show in the footer.
32    imprint: Option<String>,
33
34    /// Whether users can change their email.
35    email_change_allowed: bool,
36
37    /// Whether users can change their display name.
38    display_name_change_allowed: bool,
39
40    /// Whether passwords are enabled for login.
41    password_login_enabled: bool,
42
43    /// Whether passwords are enabled and users can change their own passwords.
44    password_change_allowed: bool,
45
46    /// Whether passwords are enabled and users can register using a password.
47    password_registration_enabled: bool,
48
49    /// Whether users can delete their own account.
50    account_deactivation_allowed: bool,
51
52    /// Minimum password complexity, from 0 to 4, in terms of a zxcvbn score.
53    /// The exact scorer (including dictionaries and other data tables)
54    /// in use is <https://crates.io/crates/zxcvbn>.
55    minimum_password_complexity: u8,
56}
57
58#[derive(SimpleObject)]
59#[graphql(complex)]
60pub struct CaptchaConfig {
61    /// Which Captcha service is being used
62    pub service: CaptchaService,
63
64    /// The site key used by the instance
65    pub site_key: String,
66}
67
68/// Which Captcha service is being used
69#[derive(Enum, Debug, Clone, Copy, PartialEq, Eq)]
70pub enum CaptchaService {
71    RecaptchaV2,
72    CloudflareTurnstile,
73    HCaptcha,
74}
75
76#[ComplexObject]
77impl SiteConfig {
78    /// The ID of the site configuration.
79    pub async fn id(&self) -> ID {
80        SITE_CONFIG_ID.into()
81    }
82}
83
84impl SiteConfig {
85    /// Create a new [`SiteConfig`] from the data model
86    /// [`mas_data_model:::SiteConfig`].
87    pub fn new(data_model: &mas_data_model::SiteConfig) -> Self {
88        Self {
89            captcha_config: data_model.captcha.as_ref().map(CaptchaConfig::new),
90            server_name: data_model.server_name.clone(),
91            policy_uri: data_model.policy_uri.clone(),
92            tos_uri: data_model.tos_uri.clone(),
93            imprint: data_model.imprint.clone(),
94            email_change_allowed: data_model.email_change_allowed,
95            display_name_change_allowed: data_model.displayname_change_allowed,
96            password_login_enabled: data_model.password_login_enabled,
97            password_change_allowed: data_model.password_change_allowed,
98            password_registration_enabled: data_model.password_registration_enabled,
99            account_deactivation_allowed: data_model.account_deactivation_allowed,
100            minimum_password_complexity: data_model.minimum_password_complexity,
101        }
102    }
103}
104
105#[ComplexObject]
106impl CaptchaConfig {
107    pub async fn id(&self) -> ID {
108        CAPTCHA_CONFIG_ID.into()
109    }
110}
111
112impl CaptchaConfig {
113    /// Create a new [`CaptchaConfig`] from the data model
114    /// [`mas_data_model:::CaptchaConfig`].
115    pub fn new(data_model: &mas_data_model::CaptchaConfig) -> Self {
116        Self {
117            service: match data_model.service {
118                mas_data_model::CaptchaService::RecaptchaV2 => CaptchaService::RecaptchaV2,
119                mas_data_model::CaptchaService::CloudflareTurnstile => {
120                    CaptchaService::CloudflareTurnstile
121                }
122                mas_data_model::CaptchaService::HCaptcha => CaptchaService::HCaptcha,
123            },
124            site_key: data_model.site_key.clone(),
125        }
126    }
127}
mas_handlers/graphql/model/site_config.rs

mas_handlers/graphql/model/
site_config.rs
