MSC2530: added the ability to send media with captions

bindings/matrix-sdk-ffi/src/timeline/mod.rs

@@ -38,8 +38,8 @@ use ruma::{
         receipt::ReceiptThread,
         relation::Annotation,
         room::message::{
-            ForwardThread, LocationMessageEventContent, MessageType,
-            RoomMessageEventContentWithoutRelation,
+            FormattedBody as RumaFormattedBody, ForwardThread, LocationMessageEventContent,
+            MessageType, RoomMessageEventContentWithoutRelation
         },
         AnyMessageLikeEventContent,
     },
@@ -56,14 +56,14 @@ use crate::{
     client::ProgressWatcher,
     error::{ClientError, RoomError},
     helpers::unwrap_or_clone_arc,
-    ruma::{AssetType, AudioInfo, FileInfo, ImageInfo, PollKind, ThumbnailInfo, VideoInfo},
+    ruma::{AssetType, AudioInfo, FileInfo, FormattedBody, ImageInfo, PollKind, ThumbnailInfo, VideoInfo},
     task_handle::TaskHandle,
     RUNTIME,
 };
 
-mod content;
+use self::content::{Reaction, ReactionSenderData, TimelineItemContent};
 
-pub use self::content::{Reaction, ReactionSenderData, TimelineItemContent};
+mod content;
 
 #[derive(uniffi::Object)]
 #[repr(transparent)]
@@ -106,12 +106,18 @@ impl Timeline {
 
     async fn send_attachment(
         &self,
+        caption: Option<String>,
+        formatted: Option<FormattedBody>,
         url: String,
         mime_type: Mime,
         attachment_config: AttachmentConfig,
         progress_watcher: Option<Box<dyn ProgressWatcher>>,
     ) -> Result<(), RoomError> {
-        let request = self.inner.send_attachment(url, mime_type, attachment_config);
+        let formatted: Option<RumaFormattedBody> = match formatted {
+            Some(p) => Some(RumaFormattedBody::from(p)),
+            None => None
+        };
+        let request = self.inner.send_attachment(caption, formatted, url, mime_type, attachment_config);
         if let Some(progress_watcher) = progress_watcher {
             let mut subscriber = request.subscribe_to_send_progress();
             RUNTIME.spawn(async move {
@@ -215,6 +221,8 @@ impl Timeline {
 
     pub fn send_image(
         self: Arc<Self>,
+        caption: Option<String>,
+        formatted: Option<FormattedBody>,
         url: String,
         thumbnail_url: Option<String>,
         image_info: ImageInfo,
@@ -240,12 +248,14 @@ impl Timeline {
                 _ => AttachmentConfig::new().info(attachment_info),
             };
 
-            self.send_attachment(url, mime_type, attachment_config, progress_watcher).await
+            self.send_attachment(caption, formatted, url, mime_type, attachment_config, progress_watcher).await
         }))
     }
 
     pub fn send_video(
         self: Arc<Self>,
+        caption: Option<String>,
+        formatted: Option<FormattedBody>,
         url: String,
         thumbnail_url: Option<String>,
         video_info: VideoInfo,
@@ -271,12 +281,14 @@ impl Timeline {
                 _ => AttachmentConfig::new().info(attachment_info),
             };
 
-            self.send_attachment(url, mime_type, attachment_config, progress_watcher).await
+            self.send_attachment(caption, formatted, url, mime_type, attachment_config, progress_watcher).await
         }))
     }
 
     pub fn send_audio(
         self: Arc<Self>,
+        caption: Option<String>,
+        formatted: Option<FormattedBody>,
         url: String,
         audio_info: AudioInfo,
         progress_watcher: Option<Box<dyn ProgressWatcher>>,
@@ -293,12 +305,14 @@ impl Timeline {
             let attachment_info = AttachmentInfo::Audio(base_audio_info);
             let attachment_config = AttachmentConfig::new().info(attachment_info);
 
-            self.send_attachment(url, mime_type, attachment_config, progress_watcher).await
+            self.send_attachment(caption, formatted, url, mime_type, attachment_config, progress_watcher).await
         }))
     }
 
     pub fn send_voice_message(
         self: Arc<Self>,
+        caption: Option<String>,
+        formatted: Option<FormattedBody>,
         url: String,
         audio_info: AudioInfo,
         waveform: Vec<u16>,
@@ -317,7 +331,7 @@ impl Timeline {
                 AttachmentInfo::Voice { audio_info: base_audio_info, waveform: Some(waveform) };
             let attachment_config = AttachmentConfig::new().info(attachment_info);
 
-            self.send_attachment(url, mime_type, attachment_config, progress_watcher).await
+            self.send_attachment(caption, formatted, url, mime_type, attachment_config, progress_watcher).await
         }))
     }
 
@@ -339,7 +353,7 @@ impl Timeline {
             let attachment_info = AttachmentInfo::File(base_file_info);
             let attachment_config = AttachmentConfig::new().info(attachment_info);
 
-            self.send_attachment(url, mime_type, attachment_config, progress_watcher).await
+            self.send_attachment(None, None, url, mime_type, attachment_config, progress_watcher).await
         }))
     }
 

crates/matrix-sdk-ui/src/timeline/futures.rs

@@ -4,12 +4,15 @@ use eyeball::{SharedObservable, Subscriber};
 use matrix_sdk::{attachment::AttachmentConfig, TransmissionProgress};
 use matrix_sdk_base::boxed_into_future;
 use mime::Mime;
+use ruma::events::room::message::FormattedBody;
 use tracing::{Instrument as _, Span};
 
 use super::{Error, Timeline};
 
 pub struct SendAttachment<'a> {
     timeline: &'a Timeline,
+    caption: Option<String>,
+    formatted: Option<FormattedBody>,
     url: String,
     mime_type: Mime,
     config: AttachmentConfig,
@@ -20,12 +23,16 @@ pub struct SendAttachment<'a> {
 impl<'a> SendAttachment<'a> {
     pub(crate) fn new(
         timeline: &'a Timeline,
+        caption: Option<String>,
+        formatted: Option<FormattedBody>,
         url: String,
         mime_type: Mime,
         config: AttachmentConfig,
     ) -> Self {
         Self {
             timeline,
+            caption,
+            formatted,
             url,
             mime_type,
             config,
@@ -47,9 +54,9 @@ impl<'a> IntoFuture for SendAttachment<'a> {
     boxed_into_future!(extra_bounds: 'a);
 
     fn into_future(self) -> Self::IntoFuture {
-        let Self { timeline, url, mime_type, config, tracing_span, send_progress } = self;
+        let Self { timeline, caption, formatted, url, mime_type, config, tracing_span, send_progress } = self;
         let fut = async move {
-            let body = Path::new(&url)
+            let urlbody = Path::new(&url)
                 .file_name()
                 .ok_or(Error::InvalidAttachmentFileName)?
                 .to_str()
@@ -58,7 +65,7 @@ impl<'a> IntoFuture for SendAttachment<'a> {
 
             timeline
                 .room()
-                .send_attachment(body, &mime_type, data, config)
+                .send_attachment(caption, formatted, urlbody, &mime_type, data, config)
                 .with_send_progress_observable(send_progress)
                 .await
                 .map_err(|_| Error::FailedSendingAttachment)?;

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

@@ -45,8 +45,7 @@ use ruma::{
         relation::Annotation,
         room::{
             message::{
-                AddMentions, ForwardThread, OriginalRoomMessageEvent, ReplacementMetadata,
-                RoomMessageEventContent, RoomMessageEventContentWithoutRelation,
+                AddMentions, FormattedBody, ForwardThread, OriginalRoomMessageEvent, ReplacementMetadata, RoomMessageEventContent, RoomMessageEventContentWithoutRelation
             },
             redaction::RoomRedactionEventContent,
         },
@@ -513,6 +512,10 @@ impl Timeline {
     ///
     /// # Arguments
     ///
+    /// * `caption` - The url for the file to be sent
+    ///
+    /// * `formatted` - The url for the file to be sent
+    ///
     /// * `url` - The url for the file to be sent
     ///
     /// * `mime_type` - The attachment's mime type
@@ -523,11 +526,13 @@ impl Timeline {
     #[instrument(skip_all)]
     pub fn send_attachment(
         &self,
+        caption: Option<String>,
+        formatted: Option<FormattedBody>,
         url: String,
         mime_type: Mime,
         config: AttachmentConfig,
     ) -> SendAttachment<'_> {
-        SendAttachment::new(self, url, mime_type, config)
+        SendAttachment::new(self, caption, formatted, url, mime_type, config)
     }
 
     /// Retry sending a message that previously failed to send.

crates/matrix-sdk/src/attachment.rs

@@ -332,6 +332,8 @@ impl Default for AttachmentConfig {
 /// if let Some(room) = client.get_room(&room_id) {
 ///     room.send_attachment(
 ///         "My favorite cat",
+///         None,
+///         "my_favorite_cat.jpg",
 ///         &mime::IMAGE_JPEG,
 ///         image,
 ///         config,

crates/matrix-sdk/src/encryption/mod.rs

@@ -49,8 +49,8 @@ use ruma::{
     assign,
     events::room::{
         message::{
-            AudioMessageEventContent, FileInfo, FileMessageEventContent, ImageMessageEventContent,
-            MessageType, VideoInfo, VideoMessageEventContent,
+            AudioMessageEventContent, FileInfo, FileMessageEventContent, FormattedBody, 
+            ImageMessageEventContent, MessageType, VideoInfo, VideoMessageEventContent
         },
         ImageInfo, MediaSource, ThumbnailInfo,
     },
@@ -298,10 +298,13 @@ impl Client {
     }
 
     /// Encrypt and upload the file to be read from `reader` and construct an
-    /// attachment message with `body`, `content_type`, `info` and `thumbnail`.
+    /// attachment message with `body`, `content_type`, `info` and `thumbnail`,
+    /// optionanly with `formatted` and `filename`.
     pub(crate) async fn prepare_encrypted_attachment_message(
         &self,
-        body: &str,
+        caption: Option<String>,
+        formatted: Option<FormattedBody>,
+        url: &str,
         content_type: &mime::Mime,
         data: Vec<u8>,
         info: Option<AttachmentInfo>,
@@ -321,6 +324,15 @@ impl Client {
         let ((thumbnail_source, thumbnail_info), file) =
             try_join(upload_thumbnail, upload_attachment).await?;
 
+        let body: &str = match &caption {
+            Some(p) => p,
+            None => url,
+        };
+        let filename = match &caption {
+            Some(p) => Some(String::from(p)),
+            None => None
+        };
+
         Ok(match content_type.type_() {
             mime::IMAGE => {
                 let info = assign!(info.map(ImageInfo::from).unwrap_or_default(), {
@@ -329,7 +341,9 @@ impl Client {
                     thumbnail_info
                 });
                 let content = assign!(ImageMessageEventContent::encrypted(body.to_owned(), file), {
-                    info: Some(Box::new(info))
+                    info: Some(Box::new(info)),
+                    formatted: formatted,
+                    filename: filename
                 });
                 MessageType::Image(content)
             }
@@ -1435,29 +1449,28 @@ impl Encryption {
 
 #[cfg(all(test, not(target_arch = "wasm32")))]
 mod tests {
-    use std::time::Duration;
-
     use matrix_sdk_base::SessionMeta;
     use matrix_sdk_test::{
-        async_test, test_json, GlobalAccountDataTestEvent, JoinedRoomBuilder, StateTestEvent,
-        SyncResponseBuilder, DEFAULT_TEST_ROOM_ID,
+        async_test, DEFAULT_TEST_ROOM_ID, GlobalAccountDataTestEvent, JoinedRoomBuilder, StateTestEvent,
+        SyncResponseBuilder, test_json,
     };
     use ruma::{
         device_id, event_id,
         events::{reaction::ReactionEventContent, relation::Annotation},
         user_id,
     };
     use serde_json::json;
+    use std::time::Duration;
     use wiremock::{
         matchers::{header, method, path_regex},
         Mock, MockServer, ResponseTemplate,
     };
 
     use crate::{
+        Client,
         config::RequestConfig,
         matrix_auth::{MatrixSession, MatrixSessionTokens},
         test_utils::logged_in_client,
-        Client,
     };
 
     #[async_test]

crates/matrix-sdk/src/media.rs

@@ -30,9 +30,9 @@ use ruma::{
     assign,
     events::room::{
         message::{
-            self, AudioInfo, AudioMessageEventContent, FileInfo, FileMessageEventContent,
-            ImageMessageEventContent, MessageType, UnstableAudioDetailsContentBlock,
-            UnstableVoiceContentBlock, VideoInfo, VideoMessageEventContent,
+            self, AudioInfo, AudioMessageEventContent, FileInfo, FileMessageEventContent, 
+            FormattedBody, ImageMessageEventContent, MessageType, UnstableAudioDetailsContentBlock, 
+            UnstableVoiceContentBlock, VideoInfo, VideoMessageEventContent
         },
         ImageInfo, MediaSource, ThumbnailInfo,
     },
@@ -437,10 +437,13 @@ impl Media {
     }
 
     /// Upload the file bytes in `data` and construct an attachment
-    /// message with `body`, `content_type`, `info` and `thumbnail`.
+    /// message with `body`, `content_type`, `info` and `thumbnail`,
+    /// optionally with `formatted` and `filename`.
     pub(crate) async fn prepare_attachment_message(
         &self,
-        body: &str,
+        caption: Option<String>,
+        formatted: Option<FormattedBody>,
+        url: &str,
         content_type: &Mime,
         data: Vec<u8>,
         info: Option<AttachmentInfo>,
@@ -459,6 +462,14 @@ impl Media {
         let ((thumbnail_source, thumbnail_info), response) =
             try_join(upload_thumbnail, upload_attachment).await?;
 
+        let body: &str = match &caption {
+            Some(p) => p,
+            None => url,
+        };
+        let filename = match &caption {
+            Some(_) => Some(String::from(url)),
+            None => None
+        };
         let url = response.content_uri;
 
         Ok(match content_type.type_() {
@@ -469,12 +480,17 @@ impl Media {
                     thumbnail_info,
                 });
                 MessageType::Image(
-                    ImageMessageEventContent::plain(body.to_owned(), url).info(Box::new(info)),
+                    ImageMessageEventContent::plain(body.to_owned(), url)
+                        .info(Box::new(info))
+                        .filename(filename)
+                        .formatted(formatted),
                 )
             }
             mime::AUDIO => {
                 let audio_message_event_content =
-                    message::AudioMessageEventContent::plain(body.to_owned(), url);
+                    message::AudioMessageEventContent::plain(body.to_owned(), url)
+                        .filename(filename)
+                        .formatted(formatted);
                 MessageType::Audio(update_audio_message_event(
                     audio_message_event_content,
                     content_type,
@@ -488,7 +504,10 @@ impl Media {
                     thumbnail_info
                 });
                 MessageType::Video(
-                    VideoMessageEventContent::plain(body.to_owned(), url).info(Box::new(info)),
+                    VideoMessageEventContent::plain(body.to_owned(), url)
+                        .info(Box::new(info))
+                        .filename(filename)
+                        .formatted(formatted)
                 )
             }
             _ => {
@@ -498,7 +517,10 @@ impl Media {
                     thumbnail_info
                 });
                 MessageType::File(
-                    FileMessageEventContent::plain(body.to_owned(), url).info(Box::new(info)),
+                    FileMessageEventContent::plain(body.to_owned(), url)
+                        .info(Box::new(info))
+                        .filename(filename)
+                        .formatted(formatted),
                 )
             }
         })