MSC4426 : support set/clear/fetch own user status

Cargo.toml

@@ -70,7 +70,7 @@ rand = { version = "0.10.1", default-features = false, features = ["std", "std_r
 regex = { version = "1.12.2", default-features = false }
 reqwest = { version = "0.13.1", default-features = false }
 rmp-serde = { version = "1.3.0", default-features = false }
-ruma = { git = "https://github.com/ruma/ruma", rev = "8beb557b466a43b057c9c155277c77fe8766fadf", features = [
+ruma = { git = "https://github.com/ruma/ruma", rev = "a494c58c541c63042b26380a9238a24bdda4d85c", features = [
     "client-api-c",
     "compat-unset-avatar",
     "compat-upload-signatures",

bindings/matrix-sdk-ffi/Cargo.toml

@@ -24,7 +24,7 @@ crate-type = [
 ]
 
 [features]
-default = ["bundled-sqlite", "unstable-msc4274", "experimental-element-recent-emojis", "experimental-push-secrets", "experimental-search"]
+default = ["bundled-sqlite", "unstable-msc4274", "unstable-msc4426", "experimental-element-recent-emojis", "experimental-push-secrets", "experimental-search"]
 experimental-search = ["matrix-sdk/experimental-search"]
 # Use SQLite for the session storage.
 sqlite = ["matrix-sdk/sqlite"]
@@ -33,6 +33,7 @@ bundled-sqlite = ["sqlite", "matrix-sdk/bundled-sqlite"]
 # Use IndexedDB for the session storage.
 indexeddb = ["matrix-sdk/indexeddb"]
 unstable-msc4274 = ["matrix-sdk-ui/unstable-msc4274"]
+unstable-msc4426 = ["matrix-sdk/unstable-msc4426"]
 # Required when targeting a Javascript environment, like Wasm in a browser.
 js = ["matrix-sdk-ui/js"]
 # Enable sentry error monitoring, not compatible with Wasm platforms.
@@ -88,6 +89,8 @@ ruma = { workspace = true, features = [
     "unstable-msc2545",
     # Room language event type
     "unstable-msc4334",
+    # User status profile fields (m.status, m.call).
+    "unstable-msc4426",
     "unstable-uniffi",
 ] }
 serde.workspace = true

bindings/matrix-sdk-ffi/changelog.d/6616.added.md

@@ -0,0 +1 @@
+Expose [MSC4426] user-status profile fields through the FFI.

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

@@ -75,6 +75,8 @@ use matrix_sdk_ui::{
 };
 use mime::Mime;
 use oauth2::Scope;
+#[cfg(feature = "unstable-msc4426")]
+use ruma::api::client::profile::{Call, Status};
 use ruma::{
     OwnedDeviceId, OwnedMxcUri, OwnedServerName, RoomAliasId, RoomOrAliasId, ServerName,
     api::{
@@ -125,6 +127,8 @@ use super::{
     room::{Room, room_info::RoomInfo},
     session_verification::SessionVerificationController,
 };
+#[cfg(feature = "unstable-msc4426")]
+use crate::ruma::{UserCall, UserStatus};
 use crate::{
     ClientError,
     authentication::{
@@ -2494,6 +2498,17 @@ pub struct UserProfile {
     pub user_id: String,
     pub display_name: Option<String>,
     pub avatar_url: Option<String>,
+
+    /// The user's status (MSC4426 `m.status` profile field), if set.
+    #[cfg(feature = "unstable-msc4426")]
+    pub status: Option<UserStatus>,
+
+    /// Set when the user is in a call (MSC4426 `m.call` profile field).
+    ///
+    /// `None` means the user is not in a call. `Some(UserCall { call_joined_ts:
+    /// None })` means the user is in a call but the join time wasn't recorded.
+    #[cfg(feature = "unstable-msc4426")]
+    pub call: Option<UserCall>,
 }
 
 impl UserProfile {
@@ -2504,7 +2519,20 @@ impl UserProfile {
         let display_name = response.get_static::<DisplayName>()?;
         let avatar_url = response.get_static::<AvatarUrl>()?.map(|url| url.to_string());
 
-        Ok(UserProfile { user_id: user_id.to_string(), display_name, avatar_url })
+        #[cfg(feature = "unstable-msc4426")]
+        let status = response.get_static::<Status>()?.map(UserStatus::from);
+        #[cfg(feature = "unstable-msc4426")]
+        let call = response.get_static::<Call>()?.map(UserCall::from);
+
+        Ok(UserProfile {
+            user_id: user_id.to_string(),
+            display_name,
+            avatar_url,
+            #[cfg(feature = "unstable-msc4426")]
+            status,
+            #[cfg(feature = "unstable-msc4426")]
+            call,
+        })
     }
 }
 
@@ -2514,10 +2542,40 @@ impl From<&search_users::v3::User> for UserProfile {
             user_id: value.user_id.to_string(),
             display_name: value.display_name.clone(),
             avatar_url: value.avatar_url.as_ref().map(|url| url.to_string()),
+            #[cfg(feature = "unstable-msc4426")]
+            status: None,
+            #[cfg(feature = "unstable-msc4426")]
+            call: None,
         }
     }
 }
 
+#[cfg(feature = "unstable-msc4426")]
+#[matrix_sdk_ffi_macros::export]
+impl Client {
+    /// Set the current user's status (MSC4426 `m.status` profile field).
+    ///
+    /// Replaces any existing status. Use [`Self::clear_user_status`] to
+    /// remove it.
+    pub async fn set_user_status(&self, status: UserStatus) -> Result<(), ClientError> {
+        self.inner.account().set_status(status.emoji, status.text).await?;
+        Ok(())
+    }
+
+    /// Clear the current user's status (MSC4426).
+    ///
+    /// Deletes both `m.status` and `m.call` concurrently. Clearing `m.status`
+    /// alone would let `m.call` immediately reappear if the user were in a
+    /// call.
+    pub async fn clear_user_status(&self) -> Result<(), ClientError> {
+        let account = self.inner.account();
+        let (status_res, call_res) = tokio::join!(account.clear_status(), account.clear_call());
+        status_res?;
+        call_res?;
+        Ok(())
+    }
+}
+
 impl Client {
     fn process_session_change(&self, session_change: SessionChange) {
         if let Some(delegate_data) = self.delegate_data.get() {

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

@@ -85,6 +85,11 @@ use ruma::{
     },
     serde::JsonObject,
 };
+#[cfg(feature = "unstable-msc4426")]
+use ruma::{
+    SecondsSinceUnixEpoch,
+    profile::{CallProfileField, StatusProfileField},
+};
 use tracing::info;
 
 use crate::{
@@ -220,6 +225,56 @@ impl From<RumaPresenceState> for PresenceState {
     }
 }
 
+/// A user-set status (MSC4426 `m.status` profile field value).
+#[cfg(feature = "unstable-msc4426")]
+#[derive(Debug, Clone, uniffi::Record)]
+pub struct UserStatus {
+    pub emoji: String,
+    pub text: String,
+}
+
+#[cfg(feature = "unstable-msc4426")]
+impl From<UserStatus> for StatusProfileField {
+    fn from(value: UserStatus) -> Self {
+        Self::new(value.text, value.emoji)
+    }
+}
+
+#[cfg(feature = "unstable-msc4426")]
+impl From<StatusProfileField> for UserStatus {
+    fn from(value: StatusProfileField) -> Self {
+        Self { emoji: value.emoji, text: value.text }
+    }
+}
+
+/// The user's call indicator (MSC4426 `m.call` profile field value).
+///
+/// Presence of a `UserCall` value means the user is in a call. The optional
+/// `call_joined_ts` is the Unix-epoch seconds when they joined, if known.
+#[cfg(feature = "unstable-msc4426")]
+#[derive(Debug, Clone, uniffi::Record)]
+pub struct UserCall {
+    pub call_joined_ts: Option<u64>,
+}
+
+#[cfg(feature = "unstable-msc4426")]
+impl From<CallProfileField> for UserCall {
+    fn from(value: CallProfileField) -> Self {
+        Self { call_joined_ts: value.call_joined_ts.map(|ts| u64::from(ts.get())) }
+    }
+}
+
+#[cfg(feature = "unstable-msc4426")]
+impl From<UserCall> for CallProfileField {
+    fn from(value: UserCall) -> Self {
+        let mut field = CallProfileField::new();
+        field.call_joined_ts = value
+            .call_joined_ts
+            .map(|secs| SecondsSinceUnixEpoch(UInt::try_from(secs).unwrap_or_default()));
+        field
+    }
+}
+
 #[matrix_sdk_ffi_macros::export]
 pub fn message_event_content_new(
     msgtype: MessageType,

crates/matrix-sdk/Cargo.toml

@@ -87,6 +87,9 @@ docsrs = ["e2e-encryption", "sqlite", "indexeddb", "sso-login", "qrcode", "feder
 # Add support for inline media galleries via msgtypes
 unstable-msc4274 = ["ruma/unstable-msc4274", "matrix-sdk-base/unstable-msc4274"]
 
+# Add support for user status profile fields (m.status, m.call).
+unstable-msc4426 = ["ruma/unstable-msc4426"]
+
 experimental-search = ["matrix-sdk-search"]
 
 experimental-element-recent-emojis = ["matrix-sdk-base/experimental-element-recent-emojis"]

crates/matrix-sdk/changelog.d/6616.added.md

@@ -0,0 +1,3 @@
+Added `Account::set_status`, `Account::clear_status`, `Account::set_call`, and
+`Account::clear_call` to write [MSC4426] user-status profile fields (`m.status`
+and `m.call`). All four are gated behind the new `unstable-msc4426` feature.

crates/matrix-sdk/src/account.rs

@@ -28,8 +28,12 @@ use matrix_sdk_base::{
     store::StateStoreExt,
 };
 use mime::Mime;
+#[cfg(feature = "unstable-msc4426")]
+use ruma::SecondsSinceUnixEpoch;
 #[cfg(feature = "experimental-element-recent-emojis")]
 use ruma::api::client::config::set_global_account_data::v3::Request as UpdateGlobalAccountDataRequest;
+#[cfg(feature = "unstable-msc4426")]
+use ruma::profile::{CallProfileField, StatusProfileField};
 use ruma::{
     ClientSecret, MxcUri, OwnedMxcUri, OwnedRoomId, OwnedUserId, RoomId, SessionId, UInt, UserId,
     api::{
@@ -446,6 +450,48 @@ impl Account {
         Ok(response.value)
     }
 
+    /// Set the user's status (MSC4426 `m.status` profile field).
+    ///
+    /// Replaces any existing status. Use [`Self::clear_status`] to remove it.
+    ///
+    /// # Arguments
+    ///
+    /// * `emoji` - the status emoji. The MSC limits this to 32 bytes; not
+    ///   enforced client-side.
+    /// * `text` - the status text. The MSC limits this to 256 bytes; not
+    ///   enforced client-side.
+    #[cfg(feature = "unstable-msc4426")]
+    pub async fn set_status(&self, emoji: String, text: String) -> Result<()> {
+        let value = StatusProfileField::new(text, emoji);
+        self.set_profile_field(ProfileFieldValue::Status(value)).await
+    }
+
+    /// Clear the user's status (deletes the MSC4426 `m.status` profile field).
+    #[cfg(feature = "unstable-msc4426")]
+    pub async fn clear_status(&self) -> Result<()> {
+        self.delete_profile_field(ProfileFieldName::Status).await
+    }
+
+    /// Set the user's call indicator (MSC4426 `m.call` profile field).
+    ///
+    /// # Arguments
+    ///
+    /// * `call_joined_ts` - when the user joined the current call, in seconds
+    ///   since the Unix epoch. `None` if the joined time isn't known.
+    #[cfg(feature = "unstable-msc4426")]
+    pub async fn set_call(&self, call_joined_ts: Option<SecondsSinceUnixEpoch>) -> Result<()> {
+        let mut value = CallProfileField::new();
+        value.call_joined_ts = call_joined_ts;
+        self.set_profile_field(ProfileFieldValue::Call(value)).await
+    }
+
+    /// Clear the user's call indicator (deletes the MSC4426 `m.call` profile
+    /// field).
+    #[cfg(feature = "unstable-msc4426")]
+    pub async fn clear_call(&self) -> Result<()> {
+        self.delete_profile_field(ProfileFieldName::Call).await
+    }
+
     /// Set the given field of our own user's profile.
     ///
     /// [`Client::homeserver_capabilities()`] should be called first to check it

crates/matrix-sdk/src/widget/machine/driver_req.rs

@@ -317,7 +317,7 @@ impl MatrixDriverRequest for SendToDeviceRequest {
 /// and `action`. Defined by [MSC4157](https://github.com/matrix-org/matrix-spec-proposals/pull/4157)
 #[derive(Deserialize, Debug, Clone)]
 pub(crate) struct UpdateDelayedEventRequest {
-    pub(crate) action: update_delayed_event::unstable::UpdateAction,
+    pub(crate) action: update_delayed_event::UpdateAction,
     pub(crate) delay_id: String,
 }
 
@@ -328,10 +328,10 @@ impl From<UpdateDelayedEventRequest> for MatrixDriverRequestData {
 }
 
 impl MatrixDriverRequest for UpdateDelayedEventRequest {
-    type Response = update_delayed_event::unstable::Response;
+    type Response = update_delayed_event::unstable_v1::Response;
 }
 
-impl FromMatrixDriverResponse for update_delayed_event::unstable::Response {
+impl FromMatrixDriverResponse for update_delayed_event::unstable_v1::Response {
     fn from_response(ev: MatrixDriverResponse) -> Option<Self> {
         match ev {
             MatrixDriverResponse::DelayedEventUpdated(response) => Some(response),