rusty_oss/actions/
delete_objects.rs

1use std::iter;
2use std::time::Duration;
3
4use md5::{Digest, Md5};
5use serde::Serialize;
6use time::OffsetDateTime;
7use url::Url;
8
9use crate::actions::Method;
10use crate::actions::OSSAction;
11use crate::signing::sign;
12use crate::sorting_iter::SortingIterator;
13use crate::{Bucket, Credentials, Map};
14
15/// Delete multiple objects from a bucket using a single `POST` request.
16///
17/// Find out more about `DeleteObjects` from the [OSS API Reference][api]
18///
19/// [api]: https://help.aliyun.com/zh/oss/developer-reference/deletemultipleobjects
20#[derive(Debug, Clone)]
21pub struct DeleteObjects<'a, I> {
22    bucket: &'a Bucket,
23    credentials: Option<&'a Credentials>,
24    objects: I,
25    quiet: bool,
26
27    query: Map<'a>,
28    headers: Map<'a>,
29}
30
31impl<'a, I> DeleteObjects<'a, I> {
32    #[inline]
33    pub fn new(bucket: &'a Bucket, credentials: Option<&'a Credentials>, objects: I) -> Self {
34        Self {
35            bucket,
36            credentials,
37            objects,
38            quiet: false,
39            query: Map::new(),
40            headers: Map::new(),
41        }
42    }
43
44    pub fn quiet(&self) -> bool {
45        self.quiet
46    }
47
48    pub fn set_quiet(&mut self, quiet: bool) {
49        self.quiet = quiet;
50    }
51}
52
53#[derive(Debug, Clone, Default)]
54pub struct ObjectIdentifier {
55    pub key: String,
56    pub version_id: Option<String>,
57}
58
59impl ObjectIdentifier {
60    pub fn new(key: String) -> Self {
61        Self {
62            key,
63            ..Default::default()
64        }
65    }
66}
67
68impl<'a, I> DeleteObjects<'a, I>
69where
70    I: Iterator<Item = &'a ObjectIdentifier>,
71{
72    pub fn body_with_md5(self) -> (String, String) {
73        #[derive(Serialize)]
74        #[serde(rename = "Delete")]
75        struct DeleteSerde<'a> {
76            #[serde(rename = "Object")]
77            objects: Vec<Object<'a>>,
78            #[serde(rename = "Quiet")]
79            quiet: Option<bool>,
80        }
81        #[derive(Serialize)]
82        #[serde(rename = "Delete")]
83        struct Object<'a> {
84            #[serde(rename = "$value")]
85            nodes: Vec<Node<'a>>,
86        }
87
88        #[derive(Serialize)]
89        enum Node<'a> {
90            Key(&'a str),
91            VersionId(&'a str),
92        }
93
94        let objects: Vec<Object<'a>> = self
95            .objects
96            .map(|o| {
97                let mut nodes = vec![Node::Key(o.key.as_str())];
98                if let Some(ref version_id) = o.version_id {
99                    nodes.push(Node::VersionId(version_id.as_str()));
100                }
101                Object { nodes }
102            })
103            .collect();
104
105        let req = DeleteSerde {
106            objects,
107            quiet: self.quiet.then(|| true),
108        };
109
110        let body = quick_xml::se::to_string(&req).unwrap();
111
112        let content_md5 = crate::base64::encode(Md5::digest(body.as_bytes()));
113        (body, content_md5)
114    }
115}
116
117impl<'a, I> OSSAction<'a> for DeleteObjects<'a, I>
118where
119    I: Iterator<Item = &'a ObjectIdentifier>,
120{
121    const METHOD: Method = Method::Post;
122
123    fn query_mut(&mut self) -> &mut Map<'a> {
124        &mut self.query
125    }
126
127    fn headers_mut(&mut self) -> &mut Map<'a> {
128        &mut self.headers
129    }
130
131    fn sign_with_time(&self, expires_in: Duration, time: &OffsetDateTime) -> Url {
132        let url = self.bucket.base_url().clone();
133        let query = SortingIterator::new(iter::once(("delete", "1")), self.query.iter());
134
135        match self.credentials {
136            Some(credentials) => sign(
137                time,
138                Method::Post,
139                url,
140                credentials.key(),
141                credentials.secret(),
142                credentials.token(),
143                self.bucket.region(),
144                expires_in.as_secs(),
145                query,
146                self.headers.iter(),
147            ),
148            None => crate::signing::util::add_query_params(url, query),
149        }
150    }
151}
152
153#[cfg(test)]
154mod tests {
155    use pretty_assertions::assert_eq;
156    use time::OffsetDateTime;
157
158    use crate::{Bucket, Credentials, UrlStyle};
159
160    use super::*;
161
162    #[test]
163    fn oss_example() {
164        // Fri, 24 May 2013 00:00:00 GMT
165        let date = OffsetDateTime::from_unix_timestamp(1369353600).unwrap();
166        let expires_in = Duration::from_secs(86400);
167
168        let endpoint = "https://oss-cn-hangzhou.aliyuncs.com".parse().unwrap();
169        let bucket = Bucket::new(
170            endpoint,
171            UrlStyle::VirtualHost,
172            "examplebucket",
173            "cn-hangzhou",
174        )
175        .unwrap();
176        let credentials = Credentials::new(
177            "access_key_id",
178            "access_key_secret",
179        );
180
181        let objects = [
182            ObjectIdentifier {
183                key: "123".to_owned(),
184                ..Default::default()
185            },
186            ObjectIdentifier {
187                key: "456".to_owned(),
188                version_id: Some("ver1234".to_owned()),
189            },
190        ];
191        let action = DeleteObjects::new(&bucket, Some(&credentials), objects.iter());
192
193        let url = action.sign_with_time(expires_in, &date);
194        let expected = "https://examplebucket.oss-cn-hangzhou.aliyuncs.com/?delete=1&x-oss-additional-headers=host&x-oss-credential=access_key_id%2F20130524%2Fcn-hangzhou%2Foss%2Faliyun_v4_request&x-oss-date=20130524T000000Z&x-oss-expires=86400&x-oss-signature-version=OSS4-HMAC-SHA256&x-oss-signature=b2d1a8a3818834f42fd4b828f5a461d74dc396ffef3540f834ed872fba693cfe";
195
196        assert_eq!(expected, url.as_str());
197    }
198
199    #[test]
200    fn anonymous_custom_query() {
201        let expires_in = Duration::from_secs(86400);
202
203        let endpoint = "https://oss-cn-hangzhou.aliyuncs.com".parse().unwrap();
204        let bucket = Bucket::new(
205            endpoint,
206            UrlStyle::VirtualHost,
207            "examplebucket",
208            "cn-hangzhou",
209        )
210        .unwrap();
211
212        let objects = [
213            ObjectIdentifier {
214                key: "123".to_owned(),
215                ..Default::default()
216            },
217            ObjectIdentifier {
218                key: "456".to_owned(),
219                version_id: Some("ver1234".to_owned()),
220            },
221        ];
222        let action = DeleteObjects::new(&bucket, None, objects.iter());
223        let url = action.sign(expires_in);
224        let expected = "https://examplebucket.oss-cn-hangzhou.aliyuncs.com/?delete=1";
225
226        assert_eq!(expected, url.as_str());
227    }
228}
rusty_oss/actions/delete_objects.rs

rusty_oss/actions/
delete_objects.rs
