ruma_client_api/media/
get_content.rs

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

ruma_client_api/media/
get_content.rs
