matrix_sdk/encryption/
futures.rs

1// Copyright 2023 The Matrix.org Foundation C.I.C.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! Named futures returned from methods on types in
16//! [the `encryption` module][super].
17
18#![deny(unreachable_pub)]
19
20use std::{future::IntoFuture, io::Read};
21
22use eyeball::{SharedObservable, Subscriber};
23use matrix_sdk_common::boxed_into_future;
24use ruma::events::room::EncryptedFile;
25
26use crate::{Client, Media, Result, TransmissionProgress, config::RequestConfig};
27
28/// Future returned by [`Client::upload_encrypted_file`].
29#[allow(missing_debug_implementations)]
30pub struct UploadEncryptedFile<'a, R: ?Sized> {
31    client: Client,
32    reader: &'a mut R,
33    send_progress: SharedObservable<TransmissionProgress>,
34    request_config: Option<RequestConfig>,
35}
36
37impl<'a, R: ?Sized> UploadEncryptedFile<'a, R> {
38    pub(crate) fn new(client: &Client, reader: &'a mut R) -> Self {
39        Self {
40            client: client.clone(),
41            reader,
42            send_progress: Default::default(),
43            request_config: None,
44        }
45    }
46
47    /// Replace the default `SharedObservable` used for tracking upload
48    /// progress.
49    ///
50    /// Note that any subscribers obtained from
51    /// [`subscribe_to_send_progress`][Self::subscribe_to_send_progress]
52    /// will be invalidated by this.
53    pub fn with_send_progress_observable(
54        mut self,
55        send_progress: SharedObservable<TransmissionProgress>,
56    ) -> Self {
57        self.send_progress = send_progress;
58        self
59    }
60
61    /// Replace the default request config used for the upload request.
62    ///
63    /// The timeout value will be overridden with a reasonable default, based on
64    /// the size of the encrypted payload.
65    pub fn with_request_config(mut self, request_config: RequestConfig) -> Self {
66        self.request_config = Some(request_config);
67        self
68    }
69
70    /// Get a subscriber to observe the progress of sending the request body.
71    pub fn subscribe_to_send_progress(&self) -> Subscriber<TransmissionProgress> {
72        self.send_progress.subscribe()
73    }
74}
75
76impl<'a, R> IntoFuture for UploadEncryptedFile<'a, R>
77where
78    R: Read + Send + ?Sized + 'a,
79{
80    type Output = Result<EncryptedFile>;
81    boxed_into_future!(extra_bounds: 'a);
82
83    fn into_future(self) -> Self::IntoFuture {
84        let Self { client, reader, send_progress, request_config } = self;
85        Box::pin(async move {
86            let mut encryptor = matrix_sdk_base::crypto::AttachmentEncryptor::new(reader);
87
88            let mut buf = Vec::new();
89            encryptor.read_to_end(&mut buf)?;
90
91            // Override the reasonable upload timeout value, based on the size
92            // of the encrypted payload.
93            let request_config =
94                request_config.map(|config| config.timeout(Media::reasonable_upload_timeout(&buf)));
95
96            let response = client
97                .media()
98                .upload(&mime::APPLICATION_OCTET_STREAM, buf, request_config)
99                .with_send_progress_observable(send_progress)
100                .await?;
101
102            let file: EncryptedFile = {
103                let keys = encryptor.finish();
104                EncryptedFile::new(response.content_uri, keys.encryption_info, keys.hashes)
105            };
106
107            Ok(file)
108        })
109    }
110}
matrix_sdk/encryption/futures.rs

matrix_sdk/encryption/
futures.rs
