spaces: Add methods to add/remove space children.

Author: pixlwave

bindings/matrix-sdk-ffi/src/spaces.rs

@@ -87,6 +87,28 @@ impl SpaceService {
         Ok(Arc::new(SpaceRoomList::new(self.inner.space_room_list(space_id).await)))
     }
 
+    pub async fn add_child_to_space(
+        &self,
+        child_id: String,
+        space_id: String,
+    ) -> Result<(), ClientError> {
+        let space_id = RoomId::parse(space_id)?;
+        let child_id = RoomId::parse(child_id)?;
+
+        self.inner.add_child_to_space(child_id, space_id).await.map_err(ClientError::from)
+    }
+
+    pub async fn remove_child_from_space(
+        &self,
+        child_id: String,
+        space_id: String,
+    ) -> Result<(), ClientError> {
+        let space_id = RoomId::parse(space_id)?;
+        let child_id = RoomId::parse(child_id)?;
+
+        self.inner.remove_child_from_space(child_id, space_id).await.map_err(ClientError::from)
+    }
+
     /// Start a space leave process returning a [`LeaveSpaceHandle`] from which
     /// rooms can be retrieved in reversed BFS order starting from the requested
     /// `space_id` graph node. If the room is unknown then an error will be

crates/matrix-sdk-ui/src/spaces/mod.rs

@@ -40,13 +40,13 @@ use matrix_sdk_common::executor::spawn;
 use ruma::{
     OwnedRoomId, RoomId,
     events::{
-        self, SyncStateEvent,
+        self, StateEventType, SyncStateEvent,
         space::{child::SpaceChildEventContent, parent::SpaceParentEventContent},
     },
 };
 use thiserror::Error;
 use tokio::sync::Mutex as AsyncMutex;
-use tracing::error;
+use tracing::{error, warn};
 
 use crate::spaces::{graph::SpaceGraph, leave::LeaveSpaceHandle};
 pub use crate::spaces::{room::SpaceRoom, room_list::SpaceRoomList};
@@ -63,6 +63,14 @@ pub enum Error {
     #[error("Room `{0}` not found")]
     RoomNotFound(OwnedRoomId),
 
+    /// The space parent/child state was missing.
+    #[error("Missing `{0}` for `{1}`")]
+    MissingState(StateEventType, OwnedRoomId),
+
+    /// Failed to set the expected m.space.parent or m.space.child state events.
+    #[error("Failed updating space parent/child relationship")]
+    UpdateRelationship(SDKError),
+
     /// Failed to leave a space.
     #[error("Failed to leave space")]
     LeaveSpace(SDKError),
@@ -204,6 +212,84 @@ impl SpaceService {
         SpaceRoomList::new(self.client.clone(), space_id).await
     }
 
+    pub async fn add_child_to_space(
+        &self,
+        child_id: OwnedRoomId,
+        space_id: OwnedRoomId,
+    ) -> Result<(), Error> {
+        let space_room =
+            self.client.get_room(&space_id).ok_or(Error::RoomNotFound(space_id.to_owned()))?;
+        let child_room =
+            self.client.get_room(&child_id).ok_or(Error::RoomNotFound(child_id.to_owned()))?;
+
+        // Add the child to the space.
+        let child_route = child_room.route().await.map_err(Error::UpdateRelationship)?;
+        space_room
+            .send_state_event_for_key(&child_id, SpaceChildEventContent::new(child_route))
+            .await
+            .map_err(Error::UpdateRelationship)?;
+
+        // Add the space as parent of the child if allowed.
+        if let Some(user_id) = self.client.user_id()
+            && let Ok(power_levels) = space_room.power_levels().await
+            && !power_levels.user_can_send_state(user_id, StateEventType::SpaceParent)
+        {
+            warn!("The current user doesn't have permission to set the child's parent.");
+            return Ok(());
+        }
+        let parent_route = space_room.route().await.map_err(Error::UpdateRelationship)?;
+        child_room
+            .send_state_event_for_key(&space_id, SpaceParentEventContent::new(parent_route))
+            .await
+            .map_err(Error::UpdateRelationship)?;
+
+        Ok(())
+    }
+
+    pub async fn remove_child_from_space(
+        &self,
+        child_id: OwnedRoomId,
+        space_id: OwnedRoomId,
+    ) -> Result<(), Error> {
+        let space_room =
+            self.client.get_room(&space_id).ok_or(Error::RoomNotFound(space_id.to_owned()))?;
+        let child_room =
+            self.client.get_room(&child_id).ok_or(Error::RoomNotFound(child_id.to_owned()))?;
+
+        if space_room
+            .get_state_event_static_for_key::<SpaceChildEventContent, _>(&child_id)
+            .await
+            .is_err()
+        {
+            return Err(Error::MissingState(StateEventType::SpaceChild, child_id));
+        }
+        // Redacting state is a "weird" thing to do, so send {} instead.
+        //
+        // Specifically, "The redaction of the state doesn't participate in state
+        // resolution so behaves quite differently from e.g. sending an empty form of
+        // that state events".
+        space_room
+            .send_state_event_raw("m.space.child", child_id.as_str(), serde_json::json!({}))
+            .await
+            .map_err(Error::UpdateRelationship)?;
+
+        if child_room
+            .get_state_event_static_for_key::<SpaceParentEventContent, _>(&space_id)
+            .await
+            .is_err()
+        {
+            warn!("A space parent event wasn't found on the child room, ignoring.");
+            return Ok(());
+        }
+        // Same as the comment above.
+        child_room
+            .send_state_event_raw("m.space.parent", space_id.as_str(), serde_json::json!({}))
+            .await
+            .map_err(Error::UpdateRelationship)?;
+
+        Ok(())
+    }
+
     /// Start a space leave process returning a [`LeaveSpaceHandle`] from which
     /// rooms can be retrieved in reversed BFS order starting from the requested
     /// `space_id` graph node. If the room is unknown then an error will be