misc: Use filename when uploading unencrypted media

This will rename the uploaded file in the media server so it references the original one.

Author: jmartinesp

crates/matrix-sdk-base/src/media.rs

@@ -142,6 +142,9 @@ pub trait MediaEventContent {
     /// Returns `None` if `Self` has no file.
     fn source(&self) -> Option<MediaSource>;
 
+    /// Get the name of the uploaded file for `Self`.
+    fn filename(&self) -> Option<String>;
+
     /// Get the source of the thumbnail for `Self`.
     ///
     /// Returns `None` if `Self` has no thumbnail.
@@ -153,6 +156,10 @@ impl MediaEventContent for StickerEventContent {
         Some(MediaSource::from(self.source.clone()))
     }
 
+    fn filename(&self) -> Option<String> {
+        None
+    }
+
     fn thumbnail_source(&self) -> Option<MediaSource> {
         None
     }
@@ -163,6 +170,10 @@ impl MediaEventContent for AudioMessageEventContent {
         Some(self.source.clone())
     }
 
+    fn filename(&self) -> Option<String> {
+        self.filename.clone()
+    }
+
     fn thumbnail_source(&self) -> Option<MediaSource> {
         None
     }
@@ -173,6 +184,10 @@ impl MediaEventContent for FileMessageEventContent {
         Some(self.source.clone())
     }
 
+    fn filename(&self) -> Option<String> {
+        self.filename.clone()
+    }
+
     fn thumbnail_source(&self) -> Option<MediaSource> {
         self.info.as_ref()?.thumbnail_source.clone()
     }
@@ -183,6 +198,10 @@ impl MediaEventContent for ImageMessageEventContent {
         Some(self.source.clone())
     }
 
+    fn filename(&self) -> Option<String> {
+        self.filename.clone()
+    }
+
     fn thumbnail_source(&self) -> Option<MediaSource> {
         self.info
             .as_ref()
@@ -196,6 +215,10 @@ impl MediaEventContent for VideoMessageEventContent {
         Some(self.source.clone())
     }
 
+    fn filename(&self) -> Option<String> {
+        self.filename.clone()
+    }
+
     fn thumbnail_source(&self) -> Option<MediaSource> {
         self.info
             .as_ref()
@@ -209,6 +232,10 @@ impl MediaEventContent for LocationMessageEventContent {
         None
     }
 
+    fn filename(&self) -> Option<String> {
+        None
+    }
+
     fn thumbnail_source(&self) -> Option<MediaSource> {
         self.info.as_ref()?.thumbnail_source.clone()
     }

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

@@ -821,21 +821,24 @@ pub enum AttachmentSource {
     /// An attachment loaded from a file.
     ///
     /// The bytes and the filename will be read from the file at the given path.
-    File(PathBuf),
+    File { filename: Option<String>, path: PathBuf },
 }
 
 impl AttachmentSource {
     /// Try to convert this attachment source into a `(bytes, filename)` tuple.
     pub(crate) fn try_into_bytes_and_filename(self) -> Result<(Vec<u8>, String), Error> {
         match self {
             Self::Data { bytes, filename } => Ok((bytes, filename)),
-            Self::File(path) => {
-                let filename = path
-                    .file_name()
-                    .ok_or(Error::InvalidAttachmentFileName)?
-                    .to_str()
-                    .ok_or(Error::InvalidAttachmentFileName)?
-                    .to_owned();
+            Self::File { path, filename } => {
+                let filename = if let Some(filename) = filename {
+                    filename
+                } else {
+                    path.file_name()
+                        .ok_or(Error::InvalidAttachmentFileName)?
+                        .to_str()
+                        .ok_or(Error::InvalidAttachmentFileName)?
+                        .to_owned()
+                };
                 let bytes = fs::read(&path).map_err(|_| Error::InvalidAttachmentData)?;
                 Ok((bytes, filename))
             }
@@ -848,7 +851,7 @@ where
     P: Into<PathBuf>,
 {
     fn from(value: P) -> Self {
-        Self::File(value.into())
+        Self::File { path: value.into(), filename: None }
     }
 }
 

crates/matrix-sdk/src/account.rs

@@ -264,7 +264,7 @@ impl Account {
     ///
     /// [`Media::upload()`]: crate::Media::upload
     pub async fn upload_avatar(&self, content_type: &Mime, data: Vec<u8>) -> Result<OwnedMxcUri> {
-        let upload_response = self.client.media().upload(content_type, data, None).await?;
+        let upload_response = self.client.media().upload(content_type, data, None, None).await?;
         self.set_avatar_url(Some(&upload_response.content_uri)).await?;
         Ok(upload_response.content_uri)
     }

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

@@ -91,7 +91,7 @@ where
 
             let response = client
                 .media()
-                .upload(&mime::APPLICATION_OCTET_STREAM, buf, request_config)
+                .upload(&mime::APPLICATION_OCTET_STREAM, buf, None, request_config)
                 .with_send_progress_observable(send_progress)
                 .await?;
 

crates/matrix-sdk/src/media.rs

@@ -190,8 +190,10 @@ impl Media {
     /// # let mut client = Client::new(homeserver).await?;
     /// let image = fs::read("/home/example/my-cat.jpg")?;
     ///
-    /// let response =
-    ///     client.media().upload(&mime::IMAGE_JPEG, image, None).await?;
+    /// let response = client
+    ///     .media()
+    ///     .upload(&mime::IMAGE_JPEG, image, Some("my-cat.jpg".to_string()), None)
+    ///     .await?;
     ///
     /// println!("Cat URI: {}", response.content_uri);
     /// # anyhow::Ok(()) };
@@ -200,13 +202,15 @@ impl Media {
         &self,
         content_type: &Mime,
         data: Vec<u8>,
+        filename: Option<String>,
         request_config: Option<RequestConfig>,
     ) -> SendMediaUploadRequest {
         let request_config = request_config.unwrap_or_else(|| {
             self.client.request_config().timeout(Self::reasonable_upload_timeout(&data))
         });
 
         let request = assign!(media::create_content::v3::Request::new(data), {
+            filename,
             content_type: Some(content_type.essence_str().to_owned()),
         });
 
@@ -721,13 +725,16 @@ impl Media {
         &self,
         content_type: &Mime,
         data: Vec<u8>,
+        filename: Option<String>,
         thumbnail: Option<Thumbnail>,
         send_progress: SharedObservable<TransmissionProgress>,
     ) -> Result<(MediaSource, Option<(MediaSource, Box<ThumbnailInfo>)>)> {
         let upload_thumbnail = self.upload_thumbnail(thumbnail, send_progress.clone());
 
         let upload_attachment = async move {
-            self.upload(content_type, data, None).with_send_progress_observable(send_progress).await
+            self.upload(content_type, data, filename, None)
+                .with_send_progress_observable(send_progress)
+                .await
         };
 
         let (thumbnail, response) = try_join(upload_thumbnail, upload_attachment).await?;
@@ -749,7 +756,7 @@ impl Media {
         let (data, content_type, thumbnail_info) = thumbnail.into_parts();
 
         let response = self
-            .upload(&content_type, data, None)
+            .upload(&content_type, data, None, None)
             .with_send_progress_observable(send_progress)
             .await?;
         let url = response.content_uri;

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

@@ -2247,6 +2247,7 @@ impl Room {
                     // TODO: get rid of this clone; wait for Ruma to use `Bytes` or something
                     // similar.
                     data.clone(),
+                    Some(filename.clone()),
                     thumbnail,
                     send_progress,
                 )
@@ -2514,7 +2515,7 @@ impl Room {
     ) -> Result<send_state_event::v3::Response> {
         self.ensure_room_joined()?;
 
-        let upload_response = self.client.media().upload(mime, data, None).await?;
+        let upload_response = self.client.media().upload(mime, data, None, None).await?;
         let mut info = info.unwrap_or_default();
         info.blurhash = upload_response.blurhash;
         info.mimetype = Some(mime.to_string());

crates/matrix-sdk/src/test_utils/mocks/mod.rs

@@ -2444,6 +2444,11 @@ impl<'a> MockEndpoint<'a, UploadEndpoint> {
         Self { mock: self.mock.and(header("content-type", content_type)), ..self }
     }
 
+    /// Expect the filename query param to match the provided value.
+    pub fn expect_filename(self, filename: &str) -> Self {
+        Self { mock: self.mock.and(query_param("filename", filename)), ..self }
+    }
+
     /// Returns a redact endpoint that emulates success, i.e. the redaction
     /// event has been sent with the given event id.
     pub fn ok(self, mxc_id: &MxcUri) -> MatrixMock<'a> {

crates/matrix-sdk/tests/integration/room/attachment/mod.rs

@@ -120,6 +120,7 @@ async fn test_room_attachment_send_info() {
 
     mock.mock_upload()
         .expect_mime_type("image/jpeg")
+        .expect_filename("image.jpg")
         .ok(mxc_uri!("mxc://example.com/AQwafuaFswefuhsfAFAgsw"))
         .mock_once()
         .mount()