rusty_s3/actions/multipart_upload/
list_parts.rs

1use std::io::BufRead;
2use std::iter;
3use std::time::Duration;
4
5use jiff::Timestamp;
6use serde::Deserialize;
7use url::Url;
8
9use crate::actions::Method;
10use crate::actions::S3Action;
11use crate::signing::sign;
12use crate::sorting_iter::SortingIterator;
13use crate::{Bucket, Credentials, Map};
14
15/// Lists the parts that have been uploaded for a specific multipart upload.
16///
17/// If `next_part_number_marker` is `Some` the response is truncated, and the
18/// rest of the list can be retrieved by reusing the `ListParts` action
19/// but with `part_number_marker` set to the value of `next_part_number_marker`
20/// received in the previous response.
21///
22/// Find out more about `ListParts` from the [AWS API Reference][api]
23///
24/// [api]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
25#[derive(Debug, Clone)]
26pub struct ListParts<'a> {
27    bucket: &'a Bucket,
28    credentials: Option<&'a Credentials>,
29    object: &'a str,
30    upload_id: &'a str,
31
32    query: Map<'a>,
33    headers: Map<'a>,
34}
35
36#[allow(clippy::module_name_repetitions)]
37#[derive(Debug, Clone, Deserialize)]
38pub struct ListPartsResponse {
39    #[serde(rename = "Part")]
40    #[serde(default)]
41    pub parts: Vec<PartsContent>,
42    #[serde(rename = "MaxParts")]
43    pub max_parts: u16,
44    #[serde(rename = "IsTruncated")]
45    is_truncated: bool,
46    #[serde(rename = "NextPartNumberMarker")]
47    pub next_part_number_marker: Option<u16>,
48}
49
50#[derive(Debug, Clone, Deserialize)]
51pub struct PartsContent {
52    #[serde(rename = "PartNumber")]
53    pub number: u16,
54    #[serde(rename = "ETag")]
55    pub etag: String,
56    #[serde(rename = "LastModified")]
57    pub last_modified: String,
58    #[serde(rename = "Size")]
59    pub size: u64,
60}
61
62impl<'a> ListParts<'a> {
63    #[must_use]
64    pub const fn new(
65        bucket: &'a Bucket,
66        credentials: Option<&'a Credentials>,
67        object: &'a str,
68        upload_id: &'a str,
69    ) -> Self {
70        Self {
71            bucket,
72            credentials,
73            object,
74            upload_id,
75
76            query: Map::new(),
77            headers: Map::new(),
78        }
79    }
80
81    pub fn set_max_parts(&mut self, max_parts: u16) {
82        self.query.insert("max-parts", max_parts.to_string());
83    }
84
85    pub fn set_part_number_marker(&mut self, part_number_marker: u16) {
86        self.query
87            .insert("part-number-marker", part_number_marker.to_string());
88    }
89
90    /// Parse the XML response from S3 into a struct
91    ///
92    /// # Errors
93    ///
94    /// Will return an error if the XML cannot be deserialized
95    pub fn parse_response(s: impl AsRef<[u8]>) -> Result<ListPartsResponse, quick_xml::DeError> {
96        Self::parse_response_from_reader(&mut s.as_ref())
97    }
98
99    /// Parse the XML response from S3 into a struct
100    ///
101    /// # Errors
102    ///
103    /// Will return an error if the XML cannot be deserialized
104    pub fn parse_response_from_reader(
105        s: impl BufRead,
106    ) -> Result<ListPartsResponse, quick_xml::DeError> {
107        let mut parts: ListPartsResponse = quick_xml::de::from_reader(s)?;
108        if !parts.is_truncated {
109            parts.next_part_number_marker = None;
110        }
111        Ok(parts)
112    }
113}
114
115impl<'a> S3Action<'a> for ListParts<'a> {
116    const METHOD: Method = Method::Get;
117
118    fn query_mut(&mut self) -> &mut Map<'a> {
119        &mut self.query
120    }
121
122    fn headers_mut(&mut self) -> &mut Map<'a> {
123        &mut self.headers
124    }
125
126    fn sign_with_time(&self, expires_in: Duration, time: &Timestamp) -> Url {
127        let url = self.bucket.object_url(self.object).unwrap();
128        let query =
129            SortingIterator::new(iter::once(("uploadId", self.upload_id)), self.query.iter());
130
131        match self.credentials {
132            Some(credentials) => sign(
133                time,
134                Self::METHOD,
135                url,
136                credentials.key(),
137                credentials.secret(),
138                credentials.token(),
139                self.bucket.region(),
140                expires_in.as_secs(),
141                query,
142                self.headers.iter(),
143            ),
144            None => crate::signing::util::add_query_params(url, query),
145        }
146    }
147}
148
149#[cfg(test)]
150mod tests {
151    use pretty_assertions::assert_eq;
152
153    use crate::{Bucket, Credentials, UrlStyle};
154
155    use super::*;
156
157    #[test]
158    fn aws_example() {
159        // Fri, 24 May 2013 00:00:00 GMT
160        let date = Timestamp::from_second(1369353600).unwrap();
161        let expires_in = Duration::from_secs(86400);
162
163        let endpoint = "https://s3.amazonaws.com".parse().unwrap();
164        let bucket = Bucket::new(
165            endpoint,
166            UrlStyle::VirtualHost,
167            "examplebucket",
168            "us-east-1",
169        )
170        .unwrap();
171        let credentials = Credentials::new(
172            "AKIAIOSFODNN7EXAMPLE",
173            "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
174        );
175
176        let mut action = ListParts::new(&bucket, Some(&credentials), "test.txt", "abcd");
177        action.set_max_parts(100);
178        let url = action.sign_with_time(expires_in, &date);
179        let expected = "https://examplebucket.s3.amazonaws.com/test.txt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20130524%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20130524T000000Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&max-parts=100&uploadId=abcd&X-Amz-Signature=10a814258808a79054a80e2aff66e95faba686648eb50bd143fe7fe7d6d7b6ce";
180        assert_eq!(expected, url.as_str());
181
182        let mut action = ListParts::new(&bucket, Some(&credentials), "test.txt", "abcd");
183        action.set_max_parts(50);
184        action.set_part_number_marker(100);
185        let url = action.sign_with_time(expires_in, &date);
186        let expected = "https://examplebucket.s3.amazonaws.com/test.txt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20130524%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20130524T000000Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&max-parts=50&part-number-marker=100&uploadId=abcd&X-Amz-Signature=ea8eecb4f2534d606474497e6088ceb262081bf7c5a289ff0598aafdd66055da";
187        assert_eq!(expected, url.as_str());
188    }
189
190    #[test]
191    fn anonymous_custom_query() {
192        let expires_in = Duration::from_secs(86400);
193
194        let endpoint = "https://s3.amazonaws.com".parse().unwrap();
195        let bucket = Bucket::new(
196            endpoint,
197            UrlStyle::VirtualHost,
198            "examplebucket",
199            "us-east-1",
200        )
201        .unwrap();
202
203        let mut action = ListParts::new(&bucket, None, "test.txt", "abcd");
204        action.set_max_parts(100);
205        let url = action.sign(expires_in);
206        let expected =
207            "https://examplebucket.s3.amazonaws.com/test.txt?max-parts=100&uploadId=abcd";
208        assert_eq!(expected, url.as_str());
209
210        let mut action = ListParts::new(&bucket, None, "test.txt", "abcd");
211        action.set_max_parts(50);
212        action.set_part_number_marker(100);
213        let url = action.sign(expires_in);
214        let expected = "https://examplebucket.s3.amazonaws.com/test.txt?max-parts=50&part-number-marker=100&uploadId=abcd";
215        assert_eq!(expected, url.as_str());
216    }
217
218    #[test]
219    fn parse() {
220        let input = r#"
221        <?xml version="1.0" encoding="UTF-8"?>
222        <ListPartsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
223          <Bucket>example-bucket</Bucket>
224          <Key>example-object</Key>
225          <UploadId>XXBsb2FkIElEIGZvciBlbHZpbmcncyVcdS1tb3ZpZS5tMnRzEEEwbG9hZA</UploadId>
226          <Initiator>
227              <ID>arn:aws:iam::111122223333:user/some-user-11116a31-17b5-4fb7-9df5-b288870f11xx</ID>
228              <DisplayName>umat-user-11116a31-17b5-4fb7-9df5-b288870f11xx</DisplayName>
229          </Initiator>
230          <Owner>
231            <ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>
232            <DisplayName>someName</DisplayName>
233          </Owner>
234          <StorageClass>STANDARD</StorageClass>
235          <PartNumberMarker>1</PartNumberMarker>
236          <NextPartNumberMarker>3</NextPartNumberMarker>
237          <MaxParts>2</MaxParts>
238          <IsTruncated>true</IsTruncated>
239          <Part>
240            <PartNumber>2</PartNumber>
241            <LastModified>2010-11-10T20:48:34.000Z</LastModified>
242            <ETag>"7778aef83f66abc1fa1e8477f296d394"</ETag>
243            <Size>10485760</Size>
244          </Part>
245          <Part>
246            <PartNumber>3</PartNumber>
247            <LastModified>2010-11-10T20:48:33.000Z</LastModified>
248            <ETag>"aaaa18db4cc2f85cedef654fccc4a4x8"</ETag>
249            <Size>10485760</Size>
250          </Part>
251        </ListPartsResult>
252        "#;
253
254        let parsed = ListParts::parse_response(input).unwrap();
255        assert_eq!(parsed.parts.len(), 2);
256
257        let part_1 = &parsed.parts[0];
258        assert_eq!(part_1.etag, "\"7778aef83f66abc1fa1e8477f296d394\"");
259        assert_eq!(part_1.number, 2);
260        assert_eq!(part_1.last_modified, "2010-11-10T20:48:34.000Z");
261        assert_eq!(part_1.size, 10485760);
262
263        let part_2 = &parsed.parts[1];
264        assert_eq!(part_2.etag, "\"aaaa18db4cc2f85cedef654fccc4a4x8\"");
265        assert_eq!(part_2.number, 3);
266        assert_eq!(part_2.last_modified, "2010-11-10T20:48:33.000Z");
267        assert_eq!(part_2.size, 10485760);
268
269        assert_eq!(parsed.max_parts, 2);
270        assert_eq!(parsed.next_part_number_marker, Some(3));
271    }
272
273    #[test]
274    fn parse_no_parts() {
275        let input = r#"
276        <?xml version="1.0" encoding="UTF-8"?>
277        <ListPartsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
278          <Bucket>example-bucket</Bucket>
279          <Key>example-object</Key>
280          <UploadId>XXBsb2FkIElEIGZvciBlbHZpbmcncyVcdS1tb3ZpZS5tMnRzEEEwbG9hZA</UploadId>
281          <Initiator>
282              <ID>arn:aws:iam::111122223333:user/some-user-11116a31-17b5-4fb7-9df5-b288870f11xx</ID>
283              <DisplayName>umat-user-11116a31-17b5-4fb7-9df5-b288870f11xx</DisplayName>
284          </Initiator>
285          <Owner>
286            <ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>
287            <DisplayName>someName</DisplayName>
288          </Owner>
289          <StorageClass>STANDARD</StorageClass>
290          <PartNumberMarker>1</PartNumberMarker>
291          <MaxParts>2</MaxParts>
292          <IsTruncated>false</IsTruncated>
293        </ListPartsResult>
294        "#;
295
296        let parsed = ListParts::parse_response(input).unwrap();
297        assert!(parsed.parts.is_empty());
298        assert_eq!(parsed.max_parts, 2);
299        assert!(parsed.next_part_number_marker.is_none());
300    }
301}
rusty_s3/actions/multipart_upload/list_parts.rs

rusty_s3/actions/multipart_upload/
list_parts.rs
