ruma-events 0.34.0

//! Types for the [`m.room.create`] event.
//!
//! [`m.room.create`]: https://spec.matrix.org/v1.18/client-server-api/#mroomcreate

use ruma_common::{
    OwnedEventId, OwnedRoomId, OwnedUserId, RoomVersionId, room::RoomType,
    room_version_rules::RedactionRules,
};
use ruma_macros::EventContent;
use serde::{Deserialize, Serialize};

use crate::{EmptyStateKey, RedactContent, RedactedStateEventContent, StateEventType};

/// The content of an `m.room.create` event.
///
/// This is the first event in a room and cannot be changed.
///
/// It acts as the root of all other events.
#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
#[ruma_event(type = "m.room.create", kind = State, state_key_type = EmptyStateKey, custom_redacted)]
pub struct RoomCreateEventContent {
    /// The `user_id` of the room creator.
    ///
    /// This is set by the homeserver.
    ///
    /// This is required in room versions 1 trough 10, but is removed starting from room version
    /// 11.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[deprecated = "Since Matrix 1.8. This field was removed in Room version 11, clients should use the event's sender instead"]
    pub creator: Option<OwnedUserId>,

    /// Whether or not this room's data should be transferred to other homeservers.
    #[serde(
        rename = "m.federate",
        default = "ruma_common::serde::default_true",
        skip_serializing_if = "ruma_common::serde::is_true"
    )]
    pub federate: bool,

    /// The version of the room.
    ///
    /// Defaults to `RoomVersionId::V1`.
    #[serde(default = "default_room_version_id")]
    pub room_version: RoomVersionId,

    /// A reference to the room this room replaces, if the previous room was upgraded.
    ///
    /// With the `compat-lax-room-create-deser` cargo feature, this field is ignored if its
    /// deserialization fails.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(
        feature = "compat-lax-room-create-deser",
        serde(default, deserialize_with = "ruma_common::serde::default_on_error")
    )]
    pub predecessor: Option<PreviousRoom>,

    /// The room type.
    #[serde(skip_serializing_if = "Option::is_none", rename = "type")]
    pub room_type: Option<RoomType>,

    /// Additional room creators, considered to have "infinite" power level, in room version 12
    /// onwards.
    #[serde(skip_serializing_if = "Vec::is_empty", default)]
    pub additional_creators: Vec<OwnedUserId>,
}

impl RoomCreateEventContent {
    /// Creates a new `RoomCreateEventContent` with the given creator, as required for room versions
    /// 1 through 10.
    pub fn new_v1(creator: OwnedUserId) -> Self {
        #[allow(deprecated)]
        Self {
            creator: Some(creator),
            federate: true,
            room_version: default_room_version_id(),
            predecessor: None,
            room_type: None,
            additional_creators: Vec::new(),
        }
    }

    /// Creates a new `RoomCreateEventContent` with the default values and no creator, as introduced
    /// in room version 11.
    ///
    /// The room version is set to [`RoomVersionId::V11`].
    pub fn new_v11() -> Self {
        #[allow(deprecated)]
        Self {
            creator: None,
            federate: true,
            room_version: RoomVersionId::V11,
            predecessor: None,
            room_type: None,
            additional_creators: Vec::new(),
        }
    }
}

impl RedactContent for RoomCreateEventContent {
    type Redacted = RedactedRoomCreateEventContent;

    fn redact(self, rules: &RedactionRules) -> Self::Redacted {
        #[allow(deprecated)]
        if rules.keep_room_create_content {
            self
        } else {
            Self {
                room_version: default_room_version_id(),
                creator: self.creator,
                ..Self::new_v11()
            }
        }
    }
}

/// A reference to an old room replaced during a room version upgrade.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
pub struct PreviousRoom {
    /// The ID of the old room.
    pub room_id: OwnedRoomId,

    /// The event ID of the last known event in the old room.
    #[deprecated = "\
        This field should be sent by servers when possible for backwards compatibility \
        but clients should not rely on it."]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub event_id: Option<OwnedEventId>,
}

impl PreviousRoom {
    /// Creates a new `PreviousRoom` from the given room ID.
    pub fn new(room_id: OwnedRoomId) -> Self {
        #[allow(deprecated)]
        Self { room_id, event_id: None }
    }
}

/// Used to default the `room_version` field to room version 1.
fn default_room_version_id() -> RoomVersionId {
    RoomVersionId::V1
}

/// Redacted form of [`RoomCreateEventContent`].
///
/// The redaction rules of this event changed with room version 11:
///
/// - In room versions 1 through 10, the `creator` field was preserved during redaction, starting
///   from room version 11 the field is removed.
/// - In room versions 1 through 10, all the other fields were redacted, starting from room version
///   11 all the fields are preserved.
pub type RedactedRoomCreateEventContent = RoomCreateEventContent;

impl RedactedStateEventContent for RedactedRoomCreateEventContent {
    type StateKey = EmptyStateKey;

    fn event_type(&self) -> StateEventType {
        StateEventType::RoomCreate
    }
}

#[cfg(test)]
mod tests {
    use assert_matches2::assert_matches;
    use ruma_common::{RoomVersionId, canonical_json::assert_to_canonical_json_eq, owned_user_id};
    use serde_json::{from_value as from_json_value, json};

    use super::{RoomCreateEventContent, RoomType};

    #[test]
    fn serialization() {
        #[allow(deprecated)]
        let content = RoomCreateEventContent {
            creator: Some(owned_user_id!("@carl:example.com")),
            federate: false,
            room_version: RoomVersionId::V4,
            predecessor: None,
            room_type: None,
            additional_creators: Vec::new(),
        };

        assert_to_canonical_json_eq!(
            content,
            json!({
                "creator": "@carl:example.com",
                "m.federate": false,
                "room_version": "4",
            }),
        );
    }

    #[test]
    fn space_serialization() {
        #[allow(deprecated)]
        let content = RoomCreateEventContent {
            creator: Some(owned_user_id!("@carl:example.com")),
            federate: false,
            room_version: RoomVersionId::V4,
            predecessor: None,
            room_type: Some(RoomType::Space),
            additional_creators: Vec::new(),
        };

        assert_to_canonical_json_eq!(
            content,
            json!({
                "creator": "@carl:example.com",
                "m.federate": false,
                "room_version": "4",
                "type": "m.space",
            }),
        );
    }

    #[test]
    #[cfg(feature = "unstable-msc3417")]
    fn call_serialization() {
        #[allow(deprecated)]
        let content = RoomCreateEventContent {
            creator: Some(owned_user_id!("@carl:example.com")),
            federate: false,
            room_version: RoomVersionId::V4,
            predecessor: None,
            room_type: Some(RoomType::Call),
            additional_creators: Vec::new(),
        };

        assert_to_canonical_json_eq!(
            content,
            json!({
                "creator": "@carl:example.com",
                "m.federate": false,
                "room_version": "4",
                "type": "org.matrix.msc3417.call",
            }),
        );
    }

    #[test]
    #[allow(deprecated)]
    fn deserialization() {
        let json = json!({
            "creator": "@carl:example.com",
            "m.federate": true,
            "room_version": "4"
        });

        let content = from_json_value::<RoomCreateEventContent>(json).unwrap();
        assert_eq!(content.creator.unwrap(), "@carl:example.com");
        assert!(content.federate);
        assert_eq!(content.room_version, RoomVersionId::V4);
        assert_matches!(content.predecessor, None);
        assert_eq!(content.room_type, None);
    }

    #[test]
    #[allow(deprecated)]
    fn space_deserialization() {
        let json = json!({
            "creator": "@carl:example.com",
            "m.federate": true,
            "room_version": "4",
            "type": "m.space"
        });

        let content = from_json_value::<RoomCreateEventContent>(json).unwrap();
        assert_eq!(content.creator.unwrap(), "@carl:example.com");
        assert!(content.federate);
        assert_eq!(content.room_version, RoomVersionId::V4);
        assert_matches!(content.predecessor, None);
        assert_eq!(content.room_type, Some(RoomType::Space));
    }

    #[test]
    #[cfg(feature = "unstable-msc3417")]
    #[allow(deprecated)]
    fn call_deserialization() {
        let json = json!({
            "creator": "@carl:example.com",
            "m.federate": true,
            "room_version": "4",
            "type": "org.matrix.msc3417.call"
        });

        let content = from_json_value::<RoomCreateEventContent>(json).unwrap();
        assert_eq!(content.creator.unwrap(), "@carl:example.com");
        assert!(content.federate);
        assert_eq!(content.room_version, RoomVersionId::V4);
        assert_matches!(content.predecessor, None);
        assert_eq!(content.room_type, Some(RoomType::Call));
    }

    #[test]
    fn deserialize_valid_predecessor() {
        let json = json!({
            "m.federate": true,
            "room_version": "11",
            "predecessor": {
                "room_id": "!room:localhost",
                "event_id": "$eokpnkpn",
            },
        });

        let content = from_json_value::<RoomCreateEventContent>(json).unwrap();
        assert!(content.federate);
        assert_eq!(content.room_version, RoomVersionId::V11);
        assert_matches!(content.predecessor, Some(_));
        assert_eq!(content.room_type, None);

        let content = serde_json::from_str::<RoomCreateEventContent>(
            r#"{"m.federate":true,"room_version":"11","predecessor":{"room_id":"!room:localhost","event_id":"$eokpnkpn"}}"#,
        )
        .unwrap();
        assert!(content.federate);
        assert_eq!(content.room_version, RoomVersionId::V11);
        assert_matches!(content.predecessor, Some(_));
        assert_eq!(content.room_type, None);
    }

    #[test]
    #[cfg(feature = "compat-lax-room-create-deser")]
    fn deserialize_invalid_predecessor() {
        let json = json!({
            "m.federate": true,
            "room_version": "11",
            "predecessor": "!room:localhost",
        });

        let content = from_json_value::<RoomCreateEventContent>(json).unwrap();
        assert!(content.federate);
        assert_eq!(content.room_version, RoomVersionId::V11);
        assert_matches!(content.predecessor, None);
        assert_eq!(content.room_type, None);

        let content = serde_json::from_str::<RoomCreateEventContent>(
            r#"{"m.federate":true,"room_version":"11","predecessor":"!room:localhost"}"#,
        )
        .unwrap();
        assert!(content.federate);
        assert_eq!(content.room_version, RoomVersionId::V11);
        assert_matches!(content.predecessor, None);
        assert_eq!(content.room_type, None);
    }
}