rusty_s3/actions/

delete_objects.rs

use std::iter;
use std::time::Duration;

use instant_xml::{FromXml, ToXml};
use jiff::Timestamp;
use md5::{Digest as _, Md5};
use url::Url;

use crate::actions::{Method, S3_XML_NS, S3Action};
use crate::signing::sign;
use crate::sorting_iter::SortingIterator;
use crate::{Bucket, Credentials, Map};

/// Delete multiple objects from a bucket using a single `POST` request.
///
/// Find out more about `DeleteObjects` from the [AWS API Reference][api]
///
/// [api]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html
#[derive(Debug, Clone)]
pub struct DeleteObjects<'a, I> {
    bucket: &'a Bucket,
    credentials: Option<&'a Credentials>,
    objects: I,
    quiet: bool,

    query: Map<'a>,
    headers: Map<'a>,
}

impl<'a, I> DeleteObjects<'a, I> {
    #[inline]
    pub const fn new(bucket: &'a Bucket, credentials: Option<&'a Credentials>, objects: I) -> Self {
        Self {
            bucket,
            credentials,
            objects,
            quiet: false,
            query: Map::new(),
            headers: Map::new(),
        }
    }

    pub const fn quiet(&self) -> bool {
        self.quiet
    }

    pub const fn set_quiet(&mut self, quiet: bool) {
        self.quiet = quiet;
    }
}

#[derive(Debug, Clone, Default)]
pub struct ObjectIdentifier {
    pub key: String,
    pub version_id: Option<String>,
}

impl ObjectIdentifier {
    #[must_use]
    pub fn new(key: String) -> Self {
        Self {
            key,
            ..Default::default()
        }
    }
}

#[derive(Debug, Clone, FromXml)]
#[xml(rename = "DeleteResult", ns(S3_XML_NS))]
pub struct DeleteObjectsResponse {
    pub deleted: Vec<DeletedObject>,
    #[xml(rename = "Error")]
    pub errors: Vec<ErrorObject>,
}

#[derive(Debug, Clone, FromXml)]
#[xml(rename = "Deleted", ns(S3_XML_NS))]
pub struct DeletedObject {
    #[xml(rename = "Key")]
    pub key: String,
    #[xml(rename = "VersionId")]
    pub version_id: Option<String>,
    #[xml(rename = "DeleteMarker")]
    pub delete_marker: Option<bool>,
    #[xml(rename = "DeleteMarkerVersionId")]
    pub delete_marker_version_id: Option<String>,
}

#[derive(Debug, Clone, FromXml)]
#[xml(rename = "Error", ns(S3_XML_NS))]
pub struct ErrorObject {
    #[xml(rename = "Key")]
    pub key: String,
    #[xml(rename = "VersionId")]
    pub version_id: Option<String>,
    #[xml(rename = "Code")]
    pub code: String,
    #[xml(rename = "Message")]
    pub message: String,
}

impl DeleteObjectsResponse {
    /// Parse the XML response from S3 into a struct.
    ///
    /// # Errors
    ///
    /// Returns an error if the XML response could not be parsed.
    pub fn parse(s: &str) -> Result<Self, instant_xml::Error> {
        instant_xml::from_str(s)
    }
}

impl<'a, I> DeleteObjects<'a, I>
where
    I: Iterator<Item = &'a ObjectIdentifier>,
{
    /// Generate the XML body for the request.
    ///
    /// # Panics
    ///
    /// Panics if XML serialization fails, which shouldn't happen in practice.
    pub fn body_with_md5(self) -> (String, String) {
        #[derive(ToXml)]
        #[xml(rename = "Delete")]
        struct DeleteBody<'a> {
            objects: Vec<Object<'a>>,
            #[xml(rename = "Quiet")]
            quiet: Option<bool>,
        }
        #[derive(ToXml)]
        #[xml(rename = "Object")]
        struct Object<'a> {
            #[xml(rename = "Key")]
            key: &'a str,
            #[xml(rename = "VersionId")]
            version_id: Option<&'a str>,
        }

        let objects: Vec<Object<'a>> = self
            .objects
            .map(|o| Object {
                key: o.key.as_str(),
                version_id: o.version_id.as_deref(),
            })
            .collect();

        let req = DeleteBody {
            objects,
            quiet: self.quiet.then_some(true),
        };

        let body = instant_xml::to_string(&req).unwrap();

        let content_md5 = crate::base64::encode(Md5::digest(body.as_bytes()));
        (body, content_md5)
    }
}

impl<'a, I> S3Action<'a> for DeleteObjects<'a, I>
where
    I: Iterator<Item = &'a ObjectIdentifier>,
{
    const METHOD: Method = Method::Post;

    fn query_mut(&mut self) -> &mut Map<'a> {
        &mut self.query
    }

    fn headers_mut(&mut self) -> &mut Map<'a> {
        &mut self.headers
    }

    fn sign_with_time(&self, expires_in: Duration, time: &Timestamp) -> Url {
        let url = self.bucket.base_url().clone();
        let query = SortingIterator::new(iter::once(("delete", "1")), self.query.iter());

        match self.credentials {
            Some(credentials) => sign(
                time,
                Self::METHOD,
                url,
                credentials.key(),
                credentials.secret(),
                credentials.token(),
                self.bucket.region(),
                expires_in.as_secs(),
                query,
                self.headers.iter(),
            ),
            None => crate::signing::util::add_query_params(url, query),
        }
    }
}

#[cfg(test)]
mod tests {
    use pretty_assertions::assert_eq;

    use crate::{Bucket, Credentials, UrlStyle};

    use super::*;

    #[test]
    fn aws_example() {
        // Fri, 24 May 2013 00:00:00 GMT
        let date = Timestamp::from_second(1369353600).unwrap();
        let expires_in = Duration::from_secs(86400);

        let endpoint = "https://s3.amazonaws.com".parse().unwrap();
        let bucket = Bucket::new(
            endpoint,
            UrlStyle::VirtualHost,
            "examplebucket",
            "us-east-1",
        )
        .unwrap();
        let credentials = Credentials::new(
            "AKIAIOSFODNN7EXAMPLE",
            "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
        );

        let objects = [
            ObjectIdentifier {
                key: "123".to_owned(),
                ..Default::default()
            },
            ObjectIdentifier {
                key: "456".to_owned(),
                version_id: Some("ver1234".to_owned()),
            },
        ];
        let action = DeleteObjects::new(&bucket, Some(&credentials), objects.iter());

        let url = action.sign_with_time(expires_in, &date);
        let expected = "https://examplebucket.s3.amazonaws.com/?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&delete=1&X-Amz-Signature=0e6170ba8cb7873da76b7fb63638658607f484265935099b3d8cea5195af843c";

        assert_eq!(expected, url.as_str());
    }

    #[test]
    fn anonymous_custom_query() {
        let expires_in = Duration::from_secs(86400);

        let endpoint = "https://s3.amazonaws.com".parse().unwrap();
        let bucket = Bucket::new(
            endpoint,
            UrlStyle::VirtualHost,
            "examplebucket",
            "us-east-1",
        )
        .unwrap();

        let objects = [
            ObjectIdentifier {
                key: "123".to_owned(),
                ..Default::default()
            },
            ObjectIdentifier {
                key: "456".to_owned(),
                version_id: Some("ver1234".to_owned()),
            },
        ];
        let action = DeleteObjects::new(&bucket, None, objects.iter());
        let url = action.sign(expires_in);
        let expected = "https://examplebucket.s3.amazonaws.com/?delete=1";

        assert_eq!(expected, url.as_str());
    }

    #[test]
    fn parse_response_success() {
        let input = r#"<?xml version="1.0" encoding="UTF-8"?>
        <DeleteResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
            <Deleted>
                <Key>duck.jpg</Key>
                <VersionId>ver1234</VersionId>
                <DeleteMarker>true</DeleteMarker>
                <DeleteMarkerVersionId>del1234</DeleteMarkerVersionId>
            </Deleted>
            <Deleted>
                <Key>duck2.jpg</Key>
            </Deleted>
        </DeleteResult>
        "#;

        let parsed = DeleteObjectsResponse::parse(input).unwrap();
        assert_eq!(parsed.deleted.len(), 2);
        assert_eq!(parsed.errors.len(), 0);

        let deleted = &parsed.deleted[0];
        assert_eq!(deleted.key, "duck.jpg");
        assert_eq!(deleted.version_id, Some("ver1234".to_string()));
        assert_eq!(deleted.delete_marker, Some(true));
        assert_eq!(
            deleted.delete_marker_version_id,
            Some("del1234".to_string())
        );

        let deleted = &parsed.deleted[1];
        assert_eq!(deleted.key, "duck2.jpg");
        assert!(deleted.version_id.is_none());
        assert!(deleted.delete_marker.is_none());
        assert!(deleted.delete_marker_version_id.is_none());
    }

    #[test]
    fn parse_response_errors() {
        let input = r#"<?xml version="1.0" encoding="UTF-8"?>
        <DeleteResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
            <Error>
                <Key>idk.txt</Key>
                <Code>ErrorCode</Code>
                <Message>Error message</Message>
            </Error>
            <Error>
                <Key>idk2.txt</Key>
                <VersionId>ver2</VersionId>
                <Code>ErrorCode2</Code>
                <Message>Error message 2</Message>
            </Error>
        </DeleteResult>
        "#;

        let parsed = DeleteObjectsResponse::parse(input).unwrap();
        assert_eq!(parsed.deleted.len(), 0);
        assert_eq!(parsed.errors.len(), 2);

        let error = &parsed.errors[0];
        assert_eq!(error.key, "idk.txt");
        assert!(error.version_id.is_none());
        assert_eq!(error.code, "ErrorCode");
        assert_eq!(error.message, "Error message");

        let error = &parsed.errors[1];
        assert_eq!(error.key, "idk2.txt");
        assert_eq!(error.version_id, Some("ver2".to_string()));
        assert_eq!(error.code, "ErrorCode2");
        assert_eq!(error.message, "Error message 2");
    }
}