events: Implment MSC4380 Invite Blocking.

matrix-org/matrix-spec-proposals#4380

Signed-off-by: Jason Volk <jason@zemos.net>

Author: jevolk

crates/ruma-client-api/Cargo.toml

@@ -54,6 +54,7 @@ unstable-msc4191 = []
 # Thread subscription support.
 unstable-msc4306 = []
 unstable-msc4308 = []
+unstable-msc4380 = []
 
 [dependencies]
 as_variant = { workspace = true }

crates/ruma-client-api/src/error.rs

@@ -166,6 +166,13 @@ pub enum ErrorKind {
     /// The desired user name is not valid.
     InvalidUsername,
 
+    /// `M_INVITE_BLOCKED`
+    ///
+    /// The invite was interdicted by moderation tools or configured access controls without having
+    /// been witnessed by the user.
+    #[cfg(feature = "unstable-msc4380")]
+    InviteBlocked,
+
     /// `M_LIMIT_EXCEEDED`
     ///
     /// The request has been refused due to [rate limiting]: too many requests have been sent in a
@@ -446,6 +453,8 @@ impl ErrorKind {
             ErrorKind::InvalidParam => ErrorCode::InvalidParam,
             ErrorKind::InvalidRoomState => ErrorCode::InvalidRoomState,
             ErrorKind::InvalidUsername => ErrorCode::InvalidUsername,
+            #[cfg(feature = "unstable-msc4380")]
+            ErrorKind::InviteBlocked => ErrorCode::InviteBlocked,
             ErrorKind::LimitExceeded { .. } => ErrorCode::LimitExceeded,
             ErrorKind::MissingParam => ErrorCode::MissingParam,
             ErrorKind::MissingToken => ErrorCode::MissingToken,
@@ -616,6 +625,16 @@ pub enum ErrorCode {
     /// The desired user name is not valid.
     InvalidUsername,
 
+    /// `M_INVITE_BLOCKED`
+    ///
+    /// The invite was interdicted by moderation tools or configured access controls without having
+    /// been witnessed by the user.
+    ///
+    /// Unstable prefix intentionally shared with MSC4155 for compatibility.
+    #[cfg(feature = "unstable-msc4380")]
+    #[ruma_enum(rename = "ORG.MATRIX.MSC4155.INVITE_BLOCKED")]
+    InviteBlocked,
+
     /// `M_LIMIT_EXCEEDED`
     ///
     /// The request has been refused due to [rate limiting]: too many requests have been sent in a

crates/ruma-client-api/src/error/kind_serde.rs

@@ -198,6 +198,8 @@ impl<'de> Visitor<'de> for ErrorKindVisitor {
             ErrorCode::InvalidParam => ErrorKind::InvalidParam,
             ErrorCode::InvalidRoomState => ErrorKind::InvalidRoomState,
             ErrorCode::InvalidUsername => ErrorKind::InvalidUsername,
+            #[cfg(feature = "unstable-msc4380")]
+            ErrorCode::InviteBlocked => ErrorKind::InviteBlocked,
             ErrorCode::LimitExceeded => ErrorKind::LimitExceeded {
                 retry_after: retry_after_ms
                     .map(from_json_value::<UInt>)

crates/ruma-events/Cargo.toml

@@ -54,6 +54,7 @@ unstable-msc4319 = []
 unstable-msc4334 = ["dep:language-tags"]
 unstable-msc4359 = []
 unstable-msc4362 = []
+unstable-msc4380 = []
 
 # Allow some mandatory fields to be missing, defaulting them to an empty string
 # in deserialization.

crates/ruma-events/src/enums.rs

@@ -35,6 +35,9 @@ event_enum! {
         #[ruma_enum(ident = DoNotDisturb, alias = "m.do_not_disturb")]
         "dm.filament.do_not_disturb" => super::do_not_disturb,
         "m.identity_server" => super::identity_server,
+        #[cfg(feature = "unstable-msc4380")]
+        #[ruma_enum(ident = InvitePermissionConfig, alias = "m.invite_permission_config")]
+        "org.matrix.msc4380.invite_permission_config" => super::invite_permission_config,
         "m.ignored_user_list" => super::ignored_user_list,
         "m.push_rules" => super::push_rules,
         "m.secret_storage.default_key" => super::secret_storage::default_key,

crates/ruma-events/src/invite_permission_config.rs

@@ -0,0 +1,65 @@
+//! Types for the [`m.invite_permission_config`] account data event.
+//!
+//! [`m.invite_permission_config`]: https://github.com/matrix-org/matrix-spec-proposals/pull/4380
+
+use ruma_macros::EventContent;
+use serde::{Deserialize, Serialize};
+
+/// The content of an `m.invite_permission_config` event.
+///
+/// A single property: `block_all`.
+#[derive(Clone, Debug, Default, Deserialize, Serialize, EventContent)]
+#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
+#[ruma_event(
+    kind = GlobalAccountData,
+    type = "m.invite_permission_config",
+    alias = "org.matrix.msc4380.invite_permission_config",
+)]
+pub struct InvitePermissionConfigEventContent {
+    /// When set to true, indicates that the user does not wish to receive *any* room invites, and
+    /// they should be blocked.
+    pub block_all: bool,
+}
+
+impl InvitePermissionConfigEventContent {
+    /// Creates a new `InvitePermissionConfigEventContent` from the desired boolean state.
+    pub fn new(block_all: bool) -> Self {
+        Self { block_all }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use assert_matches2::assert_matches;
+    use serde_json::{from_value as from_json_value, json, to_value as to_json_value};
+
+    use super::InvitePermissionConfigEventContent;
+    use crate::AnyGlobalAccountDataEvent;
+
+    #[test]
+    fn serialization() {
+        let invite_permission_config = InvitePermissionConfigEventContent::new(true);
+
+        let json = json!({
+            "block_all": true
+        });
+
+        assert_eq!(to_json_value(invite_permission_config).unwrap(), json);
+    }
+
+    #[test]
+    fn deserialization() {
+        let json = json!({
+            "content": {
+                "block_all": true
+            },
+            "type": "m.invite_permission_config"
+        });
+
+        assert_matches!(
+            from_json_value::<AnyGlobalAccountDataEvent>(json),
+            Ok(AnyGlobalAccountDataEvent::InvitePermissionConfig(ev))
+        );
+        assert!(ev.content.block_all);
+    }
+}

crates/ruma-events/src/lib.rs

@@ -162,6 +162,8 @@ pub mod ignored_user_list;
 pub mod image;
 #[cfg(feature = "unstable-msc2545")]
 pub mod image_pack;
+#[cfg(feature = "unstable-msc4380")]
+pub mod invite_permission_config;
 pub mod key;
 #[cfg(feature = "unstable-msc3488")]
 pub mod location;