ruma_client_api/media/
get_content_as_filename.rs

Help
1//! `GET /_matrix/media/*/download/{serverName}/{mediaId}/{fileName}`
2//!
3//! Retrieve content from the media store, specifying a filename to return.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixmediav3downloadservernamemediaidfilename
9
10    use std::time::Duration;
11
12    use http::header::{CONTENT_DISPOSITION, CONTENT_TYPE};
13    use ruma_common::{
14        api::{request, response, Metadata},
15        http_headers::ContentDisposition,
16        metadata, IdParseError, MxcUri, OwnedServerName,
17    };
18
19    use crate::http_headers::CROSS_ORIGIN_RESOURCE_POLICY;
20
21    const METADATA: Metadata = metadata! {
22        method: GET,
23        rate_limited: false,
24        authentication: None,
25        history: {
26            1.0 => "/_matrix/media/r0/download/:server_name/:media_id/:filename",
27            1.1 => "/_matrix/media/v3/download/:server_name/:media_id/:filename",
28            1.11 => deprecated,
29        }
30    };
31
32    /// Request type for the `get_media_content_as_filename` endpoint.
33    #[request(error = crate::Error)]
34    #[deprecated = "\
35        Since Matrix 1.11, clients should use `authenticated_media::get_content_as_filename::v1::Request` \
36        instead if the homeserver supports it.\
37    "]
38    pub struct Request {
39        /// The server name from the mxc:// URI (the authoritory component).
40        #[ruma_api(path)]
41        pub server_name: OwnedServerName,
42
43        /// The media ID from the mxc:// URI (the path component).
44        #[ruma_api(path)]
45        pub media_id: String,
46
47        /// The filename to return in the `Content-Disposition` header.
48        #[ruma_api(path)]
49        pub filename: String,
50
51        /// Whether to fetch media deemed remote.
52        ///
53        /// Used to prevent routing loops. Defaults to `true`.
54        #[ruma_api(query)]
55        #[serde(
56            default = "ruma_common::serde::default_true",
57            skip_serializing_if = "ruma_common::serde::is_true"
58        )]
59        pub allow_remote: bool,
60
61        /// The maximum duration that the client is willing to wait to start receiving data, in the
62        /// case that the content has not yet been uploaded.
63        ///
64        /// The default value is 20 seconds.
65        #[ruma_api(query)]
66        #[serde(
67            with = "ruma_common::serde::duration::ms",
68            default = "ruma_common::media::default_download_timeout",
69            skip_serializing_if = "ruma_common::media::is_default_download_timeout"
70        )]
71        pub timeout_ms: Duration,
72
73        /// Whether the server may return a 307 or 308 redirect response that points at the
74        /// relevant media content.
75        ///
76        /// Unless explicitly set to `true`, the server must return the media content itself.
77        #[ruma_api(query)]
78        #[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
79        pub allow_redirect: bool,
80    }
81
82    /// Response type for the `get_media_content_as_filename` endpoint.
83    #[response(error = crate::Error)]
84    pub struct Response {
85        /// The content that was previously uploaded.
86        #[ruma_api(raw_body)]
87        pub file: Vec<u8>,
88
89        /// The content type of the file that was previously uploaded.
90        #[ruma_api(header = CONTENT_TYPE)]
91        pub content_type: Option<String>,
92
93        /// The value of the `Content-Disposition` HTTP header, possibly containing the name of the
94        /// file that was previously uploaded.
95        #[ruma_api(header = CONTENT_DISPOSITION)]
96        pub content_disposition: Option<ContentDisposition>,
97
98        /// The value of the `Cross-Origin-Resource-Policy` HTTP header.
99        ///
100        /// See [MDN] for the syntax.
101        ///
102        /// [MDN]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cross-Origin-Resource-Policy#syntax
103        #[ruma_api(header = CROSS_ORIGIN_RESOURCE_POLICY)]
104        pub cross_origin_resource_policy: Option<String>,
105    }
106
107    #[allow(deprecated)]
108    impl Request {
109        /// Creates a new `Request` with the given media ID, server name and filename.
110        pub fn new(media_id: String, server_name: OwnedServerName, filename: String) -> Self {
111            Self {
112                media_id,
113                server_name,
114                filename,
115                allow_remote: true,
116                timeout_ms: ruma_common::media::default_download_timeout(),
117                allow_redirect: false,
118            }
119        }
120
121        /// Creates a new `Request` with the given url and filename.
122        pub fn from_url(url: &MxcUri, filename: String) -> Result<Self, IdParseError> {
123            let (server_name, media_id) = url.parts()?;
124
125            Ok(Self::new(media_id.to_owned(), server_name.to_owned(), filename))
126        }
127    }
128
129    impl Response {
130        /// Creates a new `Response` with the given file.
131        ///
132        /// The Cross-Origin Resource Policy defaults to `cross-origin`.
133        pub fn new(
134            file: Vec<u8>,
135            content_type: String,
136            content_disposition: ContentDisposition,
137        ) -> Self {
138            Self {
139                file,
140                content_type: Some(content_type),
141                content_disposition: Some(content_disposition),
142                cross_origin_resource_policy: Some("cross-origin".to_owned()),
143            }
144        }
145    }
146}
ruma_client_api/media/get_content_as_filename.rs

ruma_client_api/media/
get_content_as_filename.rs
