logo
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

//! `GET /_matrix/media/*/download/{serverName}/{mediaId}/{fileName}`

pub mod v3 {
    //! `/v3/` ([spec])
    //!
    //! [spec]: https://spec.matrix.org/v1.2/client-server-api/#get_matrixmediav3downloadservernamemediaidfilename

    use ruma_common::{api::ruma_api, IdParseError, MxcUri, ServerName};

    ruma_api! {
        metadata: {
            description: "Retrieve content from the media store, specifying a filename to return.",
            method: GET,
            name: "get_media_content_as_filename",
            r0_path: "/_matrix/media/r0/download/:server_name/:media_id/:filename",
            stable_path: "/_matrix/media/v3/download/:server_name/:media_id/:filename",
            rate_limited: false,
            authentication: None,
            added: 1.0,
        }

        request: {
            /// The media ID from the mxc:// URI (the path component).
            #[ruma_api(path)]
            pub media_id: &'a str,

            /// The server name from the mxc:// URI (the authoritory component).
            #[ruma_api(path)]
            pub server_name: &'a ServerName,

            /// The filename to return in the `Content-Disposition` header.
            #[ruma_api(path)]
            pub filename: &'a str,

            /// Whether to fetch media deemed remote.
            ///
            /// Used to prevent routing loops. Defaults to `true`.
            #[ruma_api(query)]
            #[serde(default = "ruma_common::serde::default_true", skip_serializing_if = "ruma_common::serde::is_true")]
            pub allow_remote: bool,
        }

        response: {
            /// The content that was previously uploaded.
            #[ruma_api(raw_body)]
            pub file: Vec<u8>,

            /// The content type of the file that was previously uploaded.
            #[ruma_api(header = CONTENT_TYPE)]
            pub content_type: Option<String>,

            /// The value of the `Content-Disposition` HTTP header, possibly containing the name of the
            /// file that was previously uploaded.
            ///
            /// See [MDN] for the syntax.
            ///
            /// [MDN]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition#Syntax
            #[ruma_api(header = CONTENT_DISPOSITION)]
            pub content_disposition: Option<String>,
        }

        error: crate::Error
    }

    impl<'a> Request<'a> {
        /// Creates a new `Request` with the given media ID, server name and filename.
        pub fn new(media_id: &'a str, server_name: &'a ServerName, filename: &'a str) -> Self {
            Self { media_id, server_name, filename, allow_remote: true }
        }

        /// Creates a new `Request` with the given url and filename.
        pub fn from_url(url: &'a MxcUri, filename: &'a str) -> Result<Self, IdParseError> {
            let (server_name, media_id) = url.parts()?;

            Ok(Self { media_id, server_name, filename, allow_remote: true })
        }
    }

    impl Response {
        /// Creates a new `Response` with the given file.
        pub fn new(file: Vec<u8>) -> Self {
            Self { file, content_type: None, content_disposition: None }
        }
    }
}