ali_oss_rs/blocking/

object.rs

use std::path::Path;

use base64::{prelude::BASE64_STANDARD, Engine};
use reqwest::StatusCode;

use crate::{
    error::Error,
    object_common::{
        build_copy_object_request, build_delete_multiple_objects_request, build_get_object_request, build_head_object_request, build_put_object_request,
        build_restore_object_request, AppendObjectOptions, AppendObjectResult, CopyObjectOptions, CopyObjectResult, DeleteMultipleObjectsConfig,
        DeleteMultipleObjectsResult, DeleteObjectOptions, DeleteObjectResult, GetObjectMetadataOptions, GetObjectOptions, GetObjectResult, HeadObjectOptions,
        ObjectMetadata, PutObjectOptions, PutObjectResult, RestoreObjectRequest, RestoreObjectResult,
    },
    request::{OssRequest, RequestMethod},
    util::{validate_bucket_name, validate_object_key, validate_path},
    RequestBody, Result,
};

use super::{BytesBody, Client};

pub trait ObjectOperations {
    /// Uploads a file to a specified bucket and object key.
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/putobject>
    fn put_object_from_file<S1, S2, P>(&self, bucket_name: S1, object_key: S2, file_path: P, options: Option<PutObjectOptions>) -> Result<PutObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
        P: AsRef<Path>;

    /// Create an object from buffer. If you are going to upload a large file, it is recommended to use `upload_file` instead.
    /// And, it is recommended to set `mime_type` in `options`
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/putobject>
    fn put_object_from_buffer<S1, S2, B>(&self, bucket_name: S1, object_key: S2, buffer: B, options: Option<PutObjectOptions>) -> Result<PutObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
        B: Into<Vec<u8>>;

    /// Create an object from base64 string.
    /// And, it is recommended to set `mime_type` in `options`
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/putobject>
    fn put_object_from_base64<S1, S2, S3>(
        &self,
        bucket_name: S1,
        object_key: S2,
        base64_string: S3,
        options: Option<PutObjectOptions>,
    ) -> Result<PutObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
        S3: AsRef<str>;

    /// Append object.
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/appendobject>
    fn append_object_from_file<S1, S2, P>(
        &self,
        bucket_name: S1,
        object_key: S2,
        file_path: P,
        position: u64,
        options: Option<AppendObjectOptions>,
    ) -> Result<AppendObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
        P: AsRef<Path>;

    /// Append object from buffer. suitable for small size content
    /// And, it is recommended to set `mime_type` in `options`
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/putobject>
    fn append_object_from_buffer<S1, S2, B>(
        &self,
        bucket_name: S1,
        object_key: S2,
        buffer: B,
        position: u64,
        options: Option<AppendObjectOptions>,
    ) -> Result<AppendObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
        B: Into<Vec<u8>>;

    /// Append object from base64 string. suitable for small size content
    /// And, it is recommended to set `mime_type` in `options`
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/putobject>
    fn append_object_from_base64<S1, S2, S3>(
        &self,
        bucket_name: S1,
        object_key: S2,
        base64_string: S3,
        position: u64,
        options: Option<AppendObjectOptions>,
    ) -> Result<AppendObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
        S3: AsRef<str>;

    /// Uploads a file to a specified bucket and object key.
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/getobject>
    fn get_object_to_file<S1, S2, P>(&self, bucket_name: S1, object_key: S2, file_path: P, options: Option<GetObjectOptions>) -> Result<GetObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
        P: AsRef<Path>;

    /// Get object content into memory (bytes array).
    ///
    /// Large files can consume significant memory, exercise caution when using this function.
    fn get_object_to_buffer<S1, S2>(&self, bucket_name: S1, object_key: S2, options: Option<GetObjectOptions>) -> Result<Vec<u8>>
    where
        S1: AsRef<str> + Send,
        S2: AsRef<str> + Send;

    /// Create a "folder"
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/putobject>
    fn create_folder<S1, S2>(&self, bucket_name: S1, object_key: S2) -> Result<()>
    where
        S1: AsRef<str>,
        S2: AsRef<str>;

    /// Delete a "folder". if the folder contains any object, it will not be deleted
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/deleteobject>
    fn delete_folder<S1, S2>(&self, bucket_name: S1, object_key: S2) -> Result<()>
    where
        S1: AsRef<str>,
        S2: AsRef<str>;

    /// Get object metadata
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/getobjectmeta>
    fn get_object_metadata<S1, S2>(&self, bucket_name: S1, object_key: S2, options: Option<GetObjectMetadataOptions>) -> Result<ObjectMetadata>
    where
        S1: AsRef<str>,
        S2: AsRef<str>;

    /// Check if the object exists or not using get object metadata
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/getobjectmeta>
    fn exists<S1, S2>(&self, bucket_name: S1, object_key: S2, options: Option<GetObjectMetadataOptions>) -> Result<bool>
    where
        S1: AsRef<str>,
        S2: AsRef<str>;

    /// Head object
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/headobject>
    fn head_object<S1, S2>(&self, bucket_name: S1, object_key: S2, options: Option<HeadObjectOptions>) -> Result<ObjectMetadata>
    where
        S1: AsRef<str>,
        S2: AsRef<str>;

    /// Copy files (Objects) between the same or different Buckets within the same region.
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/copyobject>
    fn copy_object<S1, S2, S3, S4>(
        &self,
        source_bucket_name: S1,
        source_object_key: S2,
        dest_bucket_name: S3,
        dest_object_key: S4,
        options: Option<CopyObjectOptions>,
    ) -> Result<CopyObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
        S3: AsRef<str>,
        S4: AsRef<str>;

    /// Delete an object
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/deleteobject>
    fn delete_object<S1, S2>(&self, bucket_name: S1, object_key: S2, options: Option<DeleteObjectOptions>) -> Result<DeleteObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>;

    /// Delete multiple objects
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/deletemultipleobjects>
    fn delete_multiple_objects<S1, S2>(&self, bucket_name: S1, config: DeleteMultipleObjectsConfig<'_, S2>) -> Result<DeleteMultipleObjectsResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>;

    /// Restore object
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/restoreobject>
    fn restore_object<S1, S2>(&self, bucket_name: S1, object_key: S2, config: RestoreObjectRequest) -> Result<RestoreObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>;

    /// Clean retored object
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/cleanrestoredobject>
    fn clean_restored_object<S1, S2>(&self, bucket_name: S1, object_key: S2) -> Result<()>
    where
        S1: AsRef<str>,
        S2: AsRef<str>;
}

impl ObjectOperations for Client {
    /// Uploads a file to a specified bucket and object key.
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/putobject>
    fn put_object_from_file<S1, S2, P>(&self, bucket_name: S1, object_key: S2, file_path: P, options: Option<PutObjectOptions>) -> Result<PutObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
        P: AsRef<Path>,
    {
        let bucket_name = bucket_name.as_ref();
        let object_key = object_key.as_ref();

        let object_key = object_key.strip_prefix("/").unwrap_or(object_key);
        let object_key = object_key.strip_suffix("/").unwrap_or(object_key);

        let file_path = file_path.as_ref();

        let with_callback = if let Some(opt) = &options { opt.callback.is_some() } else { false };

        let request = build_put_object_request(bucket_name, object_key, RequestBody::File(file_path.to_path_buf(), None), &options)?;

        let (headers, content) = self.do_request::<String>(request)?;

        if with_callback {
            Ok(PutObjectResult::CallbackResponse(content))
        } else {
            Ok(PutObjectResult::ApiResponse(headers.into()))
        }
    }

    /// Create an object from buffer. If you are going to upload a large file, it is recommended to use `upload_file` instead.
    /// And, it is recommended to set `mime_type` in `options`
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/putobject>
    fn put_object_from_buffer<S1, S2, B>(&self, bucket_name: S1, object_key: S2, buffer: B, options: Option<PutObjectOptions>) -> Result<PutObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
        B: Into<Vec<u8>>,
    {
        let bucket_name = bucket_name.as_ref();
        let object_key = object_key.as_ref();

        let object_key = object_key.strip_prefix("/").unwrap_or(object_key);
        let object_key = object_key.strip_suffix("/").unwrap_or(object_key);

        let with_callback = if let Some(opt) = &options { opt.callback.is_some() } else { false };

        let request = build_put_object_request(bucket_name, object_key, RequestBody::Bytes(buffer.into()), &options)?;

        let (headers, content) = self.do_request::<String>(request)?;

        if with_callback {
            Ok(PutObjectResult::CallbackResponse(content))
        } else {
            Ok(PutObjectResult::ApiResponse(headers.into()))
        }
    }

    /// Create an object from base64 string.
    /// And, it is recommended to set `mime_type` in `options`
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/putobject>
    fn put_object_from_base64<S1, S2, S3>(
        &self,
        bucket_name: S1,
        object_key: S2,
        base64_string: S3,
        options: Option<PutObjectOptions>,
    ) -> Result<PutObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
        S3: AsRef<str>,
    {
        let data = if let Ok(d) = BASE64_STANDARD.decode(base64_string.as_ref()) {
            d
        } else {
            return Err(Error::Other("Decoding base64 string failed".to_string()));
        };

        self.put_object_from_buffer(bucket_name, object_key, data, options)
    }

    /// Append object.
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/appendobject>
    fn append_object_from_file<S1, S2, P>(
        &self,
        bucket_name: S1,
        object_key: S2,
        file_path: P,
        position: u64,
        options: Option<AppendObjectOptions>,
    ) -> Result<AppendObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
        P: AsRef<Path>,
    {
        let bucket_name = bucket_name.as_ref();
        let object_key = object_key.as_ref();

        let object_key = object_key.strip_prefix("/").unwrap_or(object_key);
        let object_key = object_key.strip_suffix("/").unwrap_or(object_key);

        let file_path = file_path.as_ref();

        let mut request = build_put_object_request(bucket_name, object_key, RequestBody::File(file_path.to_path_buf(), None), &options)?;

        // alter the request method and add append object query parameters
        request = request
            .method(RequestMethod::Post)
            .add_query("append", "")
            .add_query("position", position.to_string());

        let (headers, _) = self.do_request::<()>(request)?;

        Ok(headers.into())
    }

    /// Append object from buffer. suitable for small size content
    /// And, it is recommended to set `mime_type` in `options`
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/putobject>
    fn append_object_from_buffer<S1, S2, B>(
        &self,
        bucket_name: S1,
        object_key: S2,
        buffer: B,
        position: u64,
        options: Option<AppendObjectOptions>,
    ) -> Result<AppendObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
        B: Into<Vec<u8>>,
    {
        let bucket_name = bucket_name.as_ref();
        let object_key = object_key.as_ref();

        let object_key = object_key.strip_prefix("/").unwrap_or(object_key);
        let object_key = object_key.strip_suffix("/").unwrap_or(object_key);

        let mut request = build_put_object_request(bucket_name, object_key, RequestBody::Bytes(buffer.into()), &options)?;

        // alter the request method and add append object query parameters
        request = request
            .method(RequestMethod::Post)
            .add_query("append", "")
            .add_query("position", position.to_string());

        let (headers, _) = self.do_request::<()>(request)?;

        Ok(headers.into())
    }

    /// Append object from base64 string. suitable for small size content
    /// And, it is recommended to set `mime_type` in `options`
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/putobject>
    fn append_object_from_base64<S1, S2, S3>(
        &self,
        bucket_name: S1,
        object_key: S2,
        base64_string: S3,
        position: u64,
        options: Option<AppendObjectOptions>,
    ) -> Result<AppendObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
        S3: AsRef<str>,
    {
        let data = if let Ok(d) = BASE64_STANDARD.decode(base64_string.as_ref()) {
            d
        } else {
            return Err(Error::Other("Decoding base64 string failed".to_string()));
        };

        self.append_object_from_buffer(bucket_name, object_key, data, position, options)
    }

    /// Uploads a file to a specified bucket and object key.
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/getobject>
    fn get_object_to_file<S1, S2, P>(&self, bucket_name: S1, object_key: S2, file_path: P, options: Option<GetObjectOptions>) -> Result<GetObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
        P: AsRef<Path>,
    {
        let bucket_name = bucket_name.as_ref();
        let object_key = object_key.as_ref();
        let file_path = file_path.as_ref();

        let file_path = if file_path.is_relative() {
            file_path.canonicalize()?
        } else {
            file_path.to_path_buf()
        };

        if !validate_path(&file_path) {
            return Err(Error::Other(format!("invalid file path: {:?}", file_path.as_os_str().to_str())));
        }

        // check parent path
        if let Some(parent_path) = file_path.parent() {
            if !parent_path.exists() {
                std::fs::create_dir_all(parent_path)?;
            }
        }

        let request = build_get_object_request(bucket_name, object_key, &options)?;

        let (_, mut stream) = self.do_request::<BytesBody>(request)?;

        stream.save_to_file(file_path)?;

        Ok(GetObjectResult)
    }

    /// Get object content into memory (bytes array).
    ///
    /// Large files can consume significant memory, exercise caution when using this function.
    fn get_object_to_buffer<S1, S2>(&self, bucket_name: S1, object_key: S2, options: Option<GetObjectOptions>) -> Result<Vec<u8>>
    where
        S1: AsRef<str> + Send,
        S2: AsRef<str> + Send
    {
        let bucket_name = bucket_name.as_ref();
        let object_key = object_key.as_ref();

        let request = build_get_object_request(bucket_name, object_key, &options)?;

        let (_, stream) = self.do_request::<BytesBody>(request)?;

        stream.save_to_buffer()
    }

    /// Create a "folder"
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/putobject>
    fn create_folder<S1, S2>(&self, bucket_name: S1, object_key: S2) -> Result<()>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
    {
        let bucket_name = bucket_name.as_ref();
        let object_key = object_key.as_ref();
        let object_key = object_key.strip_prefix("/").unwrap_or(object_key);
        let object_key = if object_key.ends_with("/") {
            object_key.to_string()
        } else {
            format!("{}/", object_key)
        };

        if !validate_bucket_name(bucket_name) {
            return Err(Error::Other(format!("invalid bucket name: {}", bucket_name)));
        }

        let request = OssRequest::new()
            .method(RequestMethod::Put)
            .bucket(bucket_name)
            .object(object_key)
            .body(RequestBody::Empty)
            .content_length(0);

        let _ = self.do_request::<()>(request)?;

        Ok(())
    }

    /// Delete a "folder". if the folder contains any object, it will not be deleted
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/deleteobject>
    fn delete_folder<S1, S2>(&self, bucket_name: S1, object_key: S2) -> Result<()>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
    {
        let bucket_name = bucket_name.as_ref();
        let object_key = object_key.as_ref();
        let object_key = object_key.strip_prefix("/").unwrap_or(object_key);
        let object_key = if object_key.ends_with("/") {
            object_key.to_string()
        } else {
            format!("{}/", object_key)
        };

        if !validate_bucket_name(bucket_name) {
            return Err(Error::Other(format!("invalid bucket name: {}", bucket_name)));
        }

        let request = OssRequest::new().method(RequestMethod::Delete).bucket(bucket_name).object(object_key);

        let _ = self.do_request::<()>(request)?;

        Ok(())
    }

    /// Get object metadata
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/getobjectmeta>
    fn get_object_metadata<S1, S2>(&self, bucket_name: S1, object_key: S2, options: Option<GetObjectMetadataOptions>) -> Result<ObjectMetadata>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
    {
        let bucket_name = bucket_name.as_ref();
        let object_key = object_key.as_ref();

        if !validate_bucket_name(bucket_name) {
            return Err(Error::Other(format!("invalid bucket name: {}", bucket_name)));
        }

        if !validate_object_key(object_key) {
            return Err(Error::Other(format!("invalid object key: {}", object_key)));
        }

        let mut request = OssRequest::new()
            .method(RequestMethod::Head)
            .bucket(bucket_name)
            .object(object_key)
            .add_query("objectMeta", "");

        if let Some(options) = &options {
            if let Some(s) = &options.version_id {
                request = request.add_query("versionId", s);
            }
        }

        let (headers, _) = self.do_request::<()>(request)?;
        Ok(ObjectMetadata::from(headers))
    }

    /// Check if the object exists or not using get object metadata
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/getobjectmeta>
    fn exists<S1, S2>(&self, bucket_name: S1, object_key: S2, options: Option<GetObjectMetadataOptions>) -> Result<bool>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
    {
        match self.get_object_metadata(bucket_name, object_key, options) {
            Ok(_) => Ok(true),
            Err(e) => match e {
                Error::StatusError(status) if status == StatusCode::NOT_FOUND => Ok(false),
                _ => Err(e),
            },
        }
    }

    /// Head object
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/headobject>
    fn head_object<S1, S2>(&self, bucket_name: S1, object_key: S2, options: Option<HeadObjectOptions>) -> Result<ObjectMetadata>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
    {
        let bucket_name = bucket_name.as_ref();
        let object_key = object_key.as_ref();

        let request = build_head_object_request(bucket_name, object_key, &options)?;

        let (headers, _) = self.do_request::<()>(request)?;
        Ok(ObjectMetadata::from(headers))
    }

    /// Copy files (Objects) between the same or different Buckets within the same region.
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/copyobject>
    fn copy_object<S1, S2, S3, S4>(
        &self,
        source_bucket_name: S1,
        source_object_key: S2,
        dest_bucket_name: S3,
        dest_object_key: S4,
        options: Option<CopyObjectOptions>,
    ) -> Result<CopyObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
        S3: AsRef<str>,
        S4: AsRef<str>,
    {
        let request = build_copy_object_request(
            source_bucket_name.as_ref(),
            source_object_key.as_ref(),
            dest_bucket_name.as_ref(),
            dest_object_key.as_ref(),
            &options,
        )?;

        let (_, _) = self.do_request::<()>(request)?;

        Ok(CopyObjectResult)
    }

    /// Delete an object
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/deleteobject>
    fn delete_object<S1, S2>(&self, bucket_name: S1, object_key: S2, options: Option<DeleteObjectOptions>) -> Result<DeleteObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
    {
        let bucket_name = bucket_name.as_ref();
        let object_key = object_key.as_ref();

        if !validate_bucket_name(bucket_name) {
            return Err(Error::Other(format!("invalid bucket name: {}", bucket_name)));
        }

        if !validate_object_key(object_key) {
            return Err(Error::Other(format!("invalid object key: {}", object_key)));
        }

        let mut request = OssRequest::new().method(RequestMethod::Delete).bucket(bucket_name).object(object_key);

        if let Some(options) = options {
            if let Some(s) = options.version_id {
                request = request.add_query("versionId", s);
            }
        }

        let _ = self.do_request::<()>(request)?;

        Ok(DeleteObjectResult)
    }

    /// Delete multiple objects
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/deletemultipleobjects>
    fn delete_multiple_objects<S1, S2>(&self, bucket_name: S1, config: DeleteMultipleObjectsConfig<'_, S2>) -> Result<DeleteMultipleObjectsResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
    {
        let request = build_delete_multiple_objects_request(bucket_name.as_ref(), config)?;

        let (_, content) = self.do_request::<String>(request)?;

        DeleteMultipleObjectsResult::from_xml(&content)
    }

    /// Restore object
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/restoreobject>
    fn restore_object<S1, S2>(&self, bucket_name: S1, object_key: S2, config: RestoreObjectRequest) -> Result<RestoreObjectResult>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
    {
        let request = build_restore_object_request(bucket_name.as_ref(), object_key.as_ref(), config)?;
        let (headers, _) = self.do_request::<()>(request)?;
        Ok(headers.into())
    }

    /// Clean retored object
    ///
    /// Official document: <https://help.aliyun.com/zh/oss/developer-reference/cleanrestoredobject>
    fn clean_restored_object<S1, S2>(&self, bucket_name: S1, object_key: S2) -> Result<()>
    where
        S1: AsRef<str>,
        S2: AsRef<str>,
    {
        let bucket_name = bucket_name.as_ref();
        let object_key = object_key.as_ref();

        if !validate_bucket_name(bucket_name) {
            return Err(Error::Other(format!("invalid bucket name: {}", bucket_name)));
        }

        if !validate_object_key(object_key) {
            return Err(Error::Other(format!("invalid object key: {}", object_key)));
        }
        let request = OssRequest::new()
            .method(RequestMethod::Post)
            .bucket(bucket_name)
            .object(object_key)
            .add_query("cleanRestoredObject", "");

        let _ = self.do_request::<()>(request)?;

        Ok(())
    }
}

#[cfg(all(test, feature = "blocking"))]
mod test_object_blocking {
    use std::{collections::HashMap, sync::Once};

    use base64::{prelude::BASE64_STANDARD, Engine};
    use uuid::Uuid;

    use crate::{
        blocking::{object::ObjectOperations, Client},
        common::{ObjectType, StorageClass},
        object_common::{
            CallbackBodyParameter, CallbackBuilder, DeleteMultipleObjectsConfig, GetObjectOptionsBuilder, PutObjectApiResponse, PutObjectOptions,
            PutObjectOptionsBuilder, PutObjectResult, RestoreObjectRequest,
        },
        util,
    };

    static INIT: Once = Once::new();

    fn setup() {
        INIT.call_once(|| {
            simple_logger::init_with_level(log::Level::Debug).unwrap();
            dotenvy::dotenv().unwrap();
        });
    }

    #[test]
    fn test_upload_file_1_blocking() {
        log::debug!("test upload file with no options");
        setup();

        let client = Client::from_env();

        let object = format!("rust-sdk-test/{}.pdf", uuid::Uuid::new_v4());

        let result = client.put_object_from_file("yuanyq", &object, "/home/yuanyq/Downloads/test-pdf-output.pdf", None);

        log::debug!("{:?}", result);

        assert!(result.is_ok());

        let ret = result.unwrap();
        if let PutObjectResult::ApiResponse(PutObjectApiResponse {
            request_id: _,
            etag: _,
            content_md5,
            hash_crc64ecma: _,
            version_id: _,
        }) = ret
        {
            assert_eq!("u3j3ZJAf4d4uOHz4BNcXiw==", content_md5);
        } else {
            panic!("md5 match failed");
        }

        assert!(client.exists("yuanyq", &object, None).unwrap());

        let _ = client.delete_object("yuanyq", &object, None);

        let response = client.exists("yuanyq", &object, None);
        log::debug!("{:#?}", response);

        assert!(!response.unwrap());
    }

    #[test]
    fn test_upload_file_2_blocking() {
        log::debug!("test upload file with meta data set");
        setup();

        let client = Client::from_env();

        let options = PutObjectOptions {
            tags: HashMap::from([("purpose".to_string(), "test".to_string()), ("where".to_string(), "beijing".to_string())]),

            metadata: HashMap::from([
                ("x-oss-meta-who".to_string(), "yuanyu".to_string()),
                ("x-oss-meta-when".to_string(), "now or later".to_string()),
            ]),

            ..Default::default()
        };

        let object = format!("rust-sdk-test/{}.pdf", uuid::Uuid::new_v4());

        let result = client.put_object_from_file("yuanyq", &object, "/home/yuanyq/Downloads/云教材发布与管理系统-用户手册.pdf", Some(options));

        log::debug!("{:?}", result);

        assert!(result.is_ok());

        let ret = result.unwrap();
        if let PutObjectResult::ApiResponse(PutObjectApiResponse {
            request_id: _,
            etag: _,
            content_md5,
            hash_crc64ecma: _,
            version_id: _,
        }) = ret
        {
            assert_eq!("m6YFnp+xXeBIXkiWnqFi9w==", content_md5);
        }

        let _ = client.delete_object("yuanyq", &object, None);

        let response = client.exists("yuanyq", &object, None);
        log::debug!("{:#?}", response);

        assert!(!response.unwrap());
    }

    #[test]
    fn test_upload_file_3_blocking() {
        log::debug!("test upload file and set to Archive storage class");
        setup();

        let client = Client::from_env();

        let options = PutObjectOptions {
            storage_class: Some(StorageClass::Archive),
            ..Default::default()
        };

        let object = format!("rust-sdk-test/{}.mp4", uuid::Uuid::new_v4());

        let result = client.put_object_from_file("yuanyq", &object, "/home/yuanyq/Pictures/demo.mp4", Some(options));

        log::debug!("{:?}", result);

        assert!(result.is_ok());

        let ret = result.unwrap();
        if let PutObjectResult::ApiResponse(PutObjectApiResponse {
            request_id: _,
            etag: _,
            content_md5,
            hash_crc64ecma: _,
            version_id: _,
        }) = ret
        {
            assert_eq!("8TAE7tQlHGArvhVzfooeyw==", content_md5);
        }

        let _ = client.delete_object("yuanyq", &object, None);

        let response = client.exists("yuanyq", &object, None);
        log::debug!("{:#?}", response);

        assert!(!response.unwrap());
    }

    #[test]
    fn test_create_folder_1_blocking() {
        log::debug!("test create folder");
        setup();

        let client = Client::from_env();

        let result = client.create_folder("yuanyq", "rust-sdk-test/test-folder/");

        log::debug!("{:?}", result);

        assert!(result.is_ok())
    }

    #[test]
    fn test_delete_folder_blocking() {
        log::debug!("test delete folder");
        setup();

        let client = Client::from_env();

        let bucket = "yuanyq";
        let object = format!("rust-sdk-test/{}/", Uuid::new_v4());

        client.create_folder(bucket, &object).unwrap();

        let response = client.delete_folder(bucket, &object);
        assert!(response.is_ok());
    }

    #[test]
    fn test_download_file_1_blocking() {
        log::debug!("test download object to local file");
        setup();
        let client = Client::from_env();

        let output_file = format!("/home/yuanyq/Downloads/ali-oss-rs-test/{}.zip", Uuid::new_v4());

        let result = client.get_object_to_file("yuanyq", "rust-sdk-test/katex.zip", &output_file, None);

        assert!(result.is_ok());

        let md5_hash = util::file_md5(&output_file);
        assert_eq!("pIPky6/KtraaoNqF76ia8Q==", md5_hash);

        std::fs::remove_file(&output_file).unwrap();
        log::debug!("local file {} is deleted", output_file);
    }

    #[test]
    fn test_download_file_2_blocking() {
        log::debug!("test download file with range header");
        setup();
        let client = Client::from_env();

        let output_file = format!("/home/yuanyq/Downloads/ali-oss-rs-test/{}.zip.1", Uuid::new_v4());

        let options = GetObjectOptionsBuilder::new().range("bytes=0-499").build();

        let result = client.get_object_to_file("yuanyq", "rust-sdk-test/katex.zip", &output_file, Some(options));

        assert!(result.is_ok());

        let file_meta = std::fs::metadata(&output_file).unwrap();

        assert_eq!(500, file_meta.len());

        std::fs::remove_file(&output_file).unwrap();
    }

    #[test]
    fn test_download_file_3_blocking() {
        setup();
        let client = Client::from_env();

        let invalid_files = [
            "/home/yuanyq/Downloads/ali-oss-rs-test>/katex.zip.1",
            "/home/yuanyq/Downloads/ali-oss-rs-test|/katex;.zip.1",
            "/home/yuanyq/Downloads/ali-oss-rs-test\0/katex.zip.1",
        ];

        for output_file in invalid_files {
            let options = GetObjectOptionsBuilder::new().range("bytes=0-499").build();

            let result = client.get_object_to_file("yuanyq", "rust-sdk-test/katex.zip", output_file, Some(options));

            assert!(result.is_err());

            log::debug!("{}", result.unwrap_err());
        }
    }

    #[test]
    fn test_get_object_to_buf_blocking() {
        setup();
        let client = Client::from_env();
        let bucket_name = "mi-dev-public";
        let object_key = "quiz_template.xls";
        // 9b98f68671ec239958e58a6813960ab5
        let buf = client.get_object_to_buffer(bucket_name, object_key, None).unwrap();
        let d = md5::compute(&buf).to_vec();
        assert_eq!(hex::encode(&d), "9b98f68671ec239958e58a6813960ab5");
    }

    #[test]
    fn test_get_object_metadata_blocking() {
        setup();
        let client = Client::from_env();

        let result = client.get_object_metadata("yuanyq", "rust-sdk-test/Oracle_VirtualBox_Extension_Pack-7.1.4.vbox-extpack", None);

        assert!(result.is_ok());

        let meta = result.unwrap();
        log::debug!("{:?}", meta);
        assert_eq!(22966826, meta.content_length);
        assert_eq!("B752E1A13502E231AC4AA0E1D91F887C", meta.etag);
        assert_eq!(Some(7873641174252289613u64), meta.hash_crc64ecma);
        assert_eq!(Some("Tue, 18 Feb 2025 15:03:23 GMT".to_string()), meta.last_modified);
    }

    #[test]
    fn test_head_object_blocking() {
        setup();
        let client = Client::from_env();

        let result = client.head_object("yuanyq", "rust-sdk-test/Oracle_VirtualBox_Extension_Pack-7.1.4.vbox-extpack", None);

        assert!(result.is_ok());

        let meta = result.unwrap();
        log::debug!("{:#?}", meta);
        assert_eq!(22966826, meta.content_length);
        assert_eq!("B752E1A13502E231AC4AA0E1D91F887C", meta.etag);
        assert_eq!(Some(7873641174252289613), meta.hash_crc64ecma);
        assert_eq!(Some("Tue, 18 Feb 2025 15:03:23 GMT".to_string()), meta.last_modified);
        assert_eq!(Some(ObjectType::Normal), meta.object_type);
        assert_eq!(Some(StorageClass::Standard), meta.storage_class);
    }

    /// Copy object in same bucket
    #[test]
    fn test_copy_object_1_blocking() {
        log::debug!("test copy object within the same bucket");
        setup();
        let client = Client::from_env();

        let source_bucket = "yuanyq";
        let source_object = "rust-sdk-test/katex.zip";

        let dest_bucket = "yuanyq";
        let dest_object = format!("rust-sdk-test/katex-{}.zip", Uuid::new_v4());

        let ret = client.copy_object(source_bucket, source_object, dest_bucket, &dest_object, None);

        assert!(ret.is_ok());

        let source_meta = client.get_object_metadata(source_bucket, source_object, None).unwrap();
        let dest_meta = client.get_object_metadata(dest_bucket, &dest_object, None).unwrap();

        assert_eq!(source_meta.etag, dest_meta.etag);

        client.delete_object("yuanyq", &dest_object, None).unwrap();
    }

    /// Copy object across buckets
    #[test]
    fn test_copy_object_2_blocking() {
        log::debug!("test copy object accross buckets");
        setup();
        let client = Client::from_env();

        let source_bucket = "yuanyq";
        let source_object = "rust-sdk-test/katex.zip";

        let dest_bucket = "yuanyq-2";
        let dest_object = format!("rust-sdk-test/katex-{}.zip", Uuid::new_v4());

        let ret = client.copy_object(source_bucket, source_object, dest_bucket, &dest_object, None);

        assert!(ret.is_ok());

        let source_meta = client.get_object_metadata(source_bucket, source_object, None).unwrap();
        let dest_meta = client.get_object_metadata(dest_bucket, &dest_object, None).unwrap();

        assert_eq!(source_meta.etag, dest_meta.etag);

        client.delete_object(dest_bucket, &dest_object, None).unwrap();
    }

    #[test]
    fn test_create_object_from_buffer_blocking() {
        log::debug!("test create object from buffer");

        setup();
        let client = Client::from_env();

        let bucket = "yuanyq";
        let object = format!("rust-sdk-test/{}.jpg", Uuid::new_v4());

        let options = PutObjectOptionsBuilder::new().mime_type("image/jpeg").build();

        let buffer = std::fs::read("/home/yuanyq/Pictures/f69e41cb1642c3360bd5bb6e700a0ecb.jpeg").unwrap();

        let md5 = "1ziAOyOVKo5/xAIvbUEQJA==";

        let ret = client.put_object_from_buffer(bucket, &object, buffer, Some(options));

        log::debug!("{:?}", ret);

        assert!(ret.is_ok());

        let meta = client.head_object(bucket, &object, None).unwrap();
        assert_eq!(Some(md5.to_string()), meta.content_md5);

        client.delete_object(bucket, &object, None).unwrap();
    }

    #[test]
    fn test_create_object_from_base64_blocking() {
        log::debug!("test create object from base64 string");
        setup();
        let client = Client::from_env();

        let bucket = "yuanyq";
        let object = format!("rust-sdk-test/{}.jpg", Uuid::new_v4());

        let options = PutObjectOptionsBuilder::new().mime_type("image/jpeg").build();

        let buffer = std::fs::read("/home/yuanyq/Pictures/f69e41cb1642c3360bd5bb6e700a0ecb.jpeg").unwrap();
        let base64 = BASE64_STANDARD.encode(&buffer);
        let md5 = "1ziAOyOVKo5/xAIvbUEQJA==";

        let ret = client.put_object_from_base64(bucket, &object, base64, Some(options));

        assert!(ret.is_ok());

        let meta = client.head_object(bucket, &object, None).unwrap();
        assert_eq!(Some(md5.to_string()), meta.content_md5);

        client.delete_object(bucket, &object, None).unwrap();
    }

    #[test]
    fn test_append_object_1_blocking() {
        log::debug!("test append object from file");
        setup();
        let client = Client::from_env();

        let bucket = "yuanyq";
        let object = format!("rust-sdk-test/{}.jpg", Uuid::new_v4());

        let file1 = "/home/yuanyq/Pictures/test-image-part-1.data";
        let file2 = "/home/yuanyq/Pictures/test-image-part-2.data";
        let file3 = "/home/yuanyq/Pictures/test-image-part-3.data";

        let ret1 = client.append_object_from_file(bucket, &object, file1, 0, None);

        assert!(ret1.is_ok());

        let next_pos = ret1.unwrap().next_append_position;
        assert_eq!(61929, next_pos);

        let ret2 = client.append_object_from_file(bucket, &object, file2, next_pos, None);
        assert!(ret2.is_ok());

        let next_pos = ret2.unwrap().next_append_position;
        assert_eq!(61929 * 2, next_pos);

        let ret3 = client.append_object_from_file(bucket, &object, file3, next_pos, None);
        assert!(ret3.is_ok());

        let meta = client.head_object(bucket, &object, None);

        assert_eq!(185786, meta.unwrap().content_length);

        client.delete_object(bucket, &object, None).unwrap();
    }

    #[test]
    fn test_append_object_from_buffer_blocking() {
        log::debug!("format append object from buffer");
        setup();
        let client = Client::from_env();

        let bucket = "yuanyq";
        let object = format!("rust-sdk-test/{}.jpg", Uuid::new_v4());

        let file1 = "/home/yuanyq/Pictures/test-image-part-1.data";
        let file2 = "/home/yuanyq/Pictures/test-image-part-2.data";
        let file3 = "/home/yuanyq/Pictures/test-image-part-3.data";

        let buffer1 = std::fs::read(file1).unwrap();
        let buffer2 = std::fs::read(file2).unwrap();
        let buffer3 = std::fs::read(file3).unwrap();

        let ret1 = client.append_object_from_buffer(bucket, &object, buffer1, 0, None);
        assert!(ret1.is_ok());

        let next_pos = ret1.unwrap().next_append_position;
        assert_eq!(61929, next_pos);

        let ret2 = client.append_object_from_buffer(bucket, &object, buffer2, next_pos, None);
        assert!(ret2.is_ok());

        let next_pos = ret2.unwrap().next_append_position;
        assert_eq!(61929 * 2, next_pos);

        let ret3 = client.append_object_from_buffer(bucket, &object, buffer3, next_pos, None);
        assert!(ret3.is_ok());

        let meta = client.head_object(bucket, &object, None);
        assert_eq!(185786, meta.unwrap().content_length);

        client.delete_object(bucket, &object, None).unwrap();
    }

    #[test]
    fn test_append_object_from_base64_blocking() {
        log::debug!("test append object from base64 string");
        setup();
        let client = Client::from_env();

        let bucket = "yuanyq";
        let object = format!("rust-sdk-test/{}.jpg", Uuid::new_v4());

        let file1 = "/home/yuanyq/Pictures/test-image-part-1.data";
        let file2 = "/home/yuanyq/Pictures/test-image-part-2.data";
        let file3 = "/home/yuanyq/Pictures/test-image-part-3.data";

        let buffer1 = std::fs::read(file1).unwrap();
        let buffer2 = std::fs::read(file2).unwrap();
        let buffer3 = std::fs::read(file3).unwrap();

        let s1 = BASE64_STANDARD.encode(buffer1);
        let s2 = BASE64_STANDARD.encode(buffer2);
        let s3 = BASE64_STANDARD.encode(buffer3);

        let ret1 = client.append_object_from_base64(bucket, &object, s1, 0, None);
        assert!(ret1.is_ok());

        let next_pos = ret1.unwrap().next_append_position;
        assert_eq!(61929, next_pos);

        let ret2 = client.append_object_from_base64(bucket, &object, s2, next_pos, None);
        assert!(ret2.is_ok());

        let next_pos = ret2.unwrap().next_append_position;
        assert_eq!(61929 * 2, next_pos);

        let ret3 = client.append_object_from_base64(bucket, &object, s3, next_pos, None);
        assert!(ret3.is_ok());

        let meta = client.head_object(bucket, &object, None);
        assert_eq!(185786, meta.unwrap().content_length);

        client.delete_object(bucket, &object, None).unwrap();
    }

    #[test]
    fn test_delete_multiple_objects_blocking() {
        setup();
        let client = Client::from_env();

        let local_files = [
            "/home/yuanyq/Pictures/01-01.jpg",
            "/home/yuanyq/Pictures/01-02.jpg",
            "/home/yuanyq/Pictures/01-03.png",
            "/home/yuanyq/Pictures/01-04.jpg",
            "/home/yuanyq/Pictures/01-05.png",
        ];

        let keys = [
            format!("rust-sdk-test/{}.jpg", Uuid::new_v4()),
            format!("rust-sdk-test/{}.jpg", Uuid::new_v4()),
            format!("rust-sdk-test/{}.png", Uuid::new_v4()),
            format!("rust-sdk-test/{}.jpg", Uuid::new_v4()),
            format!("rust-sdk-test/{}.png", Uuid::new_v4()),
        ];

        for i in 0..5 {
            let file = local_files[i];
            let object = &keys[i];
            client.put_object_from_file("yuanyq", object, file, None).unwrap();
        }

        let response = client.delete_multiple_objects("yuanyq", DeleteMultipleObjectsConfig::FromKeys(&keys));

        log::debug!("{:#?}", response);

        assert!(response.is_ok());

        let result = response.unwrap();
        assert_eq!(5, result.items.len());

        for s in keys {
            assert!(result.items.iter().any(|item| item.key == s));
        }
    }

    #[test]
    fn test_put_object_from_file_with_callback_blocking() {
        setup();
        let client = Client::from_env();

        let bucket = "yuanyq".to_string();
        let object = format!("rust-sdk-test/{}.webp", Uuid::new_v4());
        let file = "/home/yuanyq/Pictures/test-1.webp".to_string();

        let cb = CallbackBuilder::new("https://your-callback.domain.com/oss-callback-test.php")
            .body_parameter(CallbackBodyParameter::OssBucket("the_bucket"))
            .body_parameter(CallbackBodyParameter::OssObject("the_object_key"))
            .body_parameter(CallbackBodyParameter::OssETag("the_etag"))
            .body_parameter(CallbackBodyParameter::OssSize("the_size"))
            .body_parameter(CallbackBodyParameter::OssCrc64("the_crc"))
            .body_parameter(CallbackBodyParameter::OssClientIp("the_client_ip"))
            .body_parameter(CallbackBodyParameter::OssContentMd5("the_content_md5"))
            .body_parameter(CallbackBodyParameter::OssMimeType("the_mime_type"))
            .body_parameter(CallbackBodyParameter::OssImageWidth("the_image_width"))
            .body_parameter(CallbackBodyParameter::OssImageHeight("the_image_height"))
            .body_parameter(CallbackBodyParameter::OssImageFormat("the_image_format"))
            .body_parameter(CallbackBodyParameter::Custom("my-key", "my-prop", "hello world".to_string()))
            .body_parameter(CallbackBodyParameter::Constant("my-key-constant", "the-value"))
            .body_parameter(CallbackBodyParameter::Literal("k1".to_string(), "${x:v1}".to_string()))
            .custom_variable("v1", "this is value of v1")
            .build();

        let options = PutObjectOptionsBuilder::new().callback(cb).build();

        let response = client.put_object_from_file(bucket, &object, &file, Some(options));
        assert!(response.is_ok());

        let ret = response.unwrap();

        log::debug!("{:#?}", ret);

        client.delete_object("yuanyq", &object, None).unwrap();
    }

    #[test]
    fn test_put_object_from_buffer_with_callback_blocking() {
        log::debug!("test put object from buffer with callback");
        setup();
        let client = Client::from_env();

        let bucket = "yuanyq".to_string();
        let object = format!("rust-sdk-test/{}.webp", Uuid::new_v4());
        let file = "/home/yuanyq/Pictures/test-1.webp".to_string();

        let data = std::fs::read(&file).unwrap();

        let cb = CallbackBuilder::new("https://your-callback.domain.com/oss-callback-test.php")
            .body_parameter(CallbackBodyParameter::OssBucket("the_bucket"))
            .body_parameter(CallbackBodyParameter::OssObject("the_object_key"))
            .body_parameter(CallbackBodyParameter::OssETag("the_etag"))
            .body_parameter(CallbackBodyParameter::OssSize("the_size"))
            .body_parameter(CallbackBodyParameter::OssCrc64("the_crc"))
            .body_parameter(CallbackBodyParameter::OssClientIp("the_client_ip"))
            .body_parameter(CallbackBodyParameter::OssContentMd5("the_content_md5"))
            .body_parameter(CallbackBodyParameter::OssMimeType("the_mime_type"))
            .body_parameter(CallbackBodyParameter::OssImageWidth("the_image_width"))
            .body_parameter(CallbackBodyParameter::OssImageHeight("the_image_height"))
            .body_parameter(CallbackBodyParameter::OssImageFormat("the_image_format"))
            .body_parameter(CallbackBodyParameter::Custom("my-key", "my-prop", "hello world".to_string()))
            .body_parameter(CallbackBodyParameter::Constant("my-key-constant", "the-value"))
            .body_parameter(CallbackBodyParameter::Literal("k1".to_string(), "${x:v1}".to_string()))
            .custom_variable("v1", "this is value of v1")
            .build();

        let options = PutObjectOptionsBuilder::new().callback(cb).build();

        let response = client.put_object_from_buffer(bucket, &object, data, Some(options));
        assert!(response.is_ok());

        let ret = response.unwrap();

        log::debug!("{:#?}", ret);

        client.delete_object("yuanyq", &object, None).unwrap();
    }

    #[test]
    fn test_restore_object_blocking() {
        log::debug!("test restore archived object");
        setup();
        let client = Client::from_env();

        let bucket = "yuanyq".to_string();
        let file = "/home/yuanyq/Pictures/test-1.webp";
        let object = format!("rust-sdk-test/{}.webp", Uuid::new_v4());

        let options = PutObjectOptionsBuilder::new().storage_class(StorageClass::Archive).build();
        client.put_object_from_file(&bucket, &object, file, Some(options)).unwrap();

        let response = client.restore_object(&bucket, object, RestoreObjectRequest { days: 2, ..Default::default() });

        assert!(response.is_ok());

        let ret = response.unwrap();
        log::debug!("{:#?}", ret);
    }

    #[test]
    fn test_put_object_from_file_with_options_blocking() {
        setup();
        let client = Client::from_env();

        let bucket = "yuanyq".to_string();
        let object = format!("rust-sdk-test/{}.webp", Uuid::new_v4());
        let file = "/home/yuanyq/Pictures/test-5.webp";

        let options = PutObjectOptionsBuilder::new()
            .metadata("x-oss-meta-who", "me")
            .metadata("x-oss-meta-user-id", "123456")
            .tag("source", "ubuntu")
            .tag("purpose", "test rust sdk")
            .build();

        let response = client.put_object_from_file(&bucket, &object, file, Some(options));
        assert!(response.is_ok());

        let result = response.unwrap();
        if let PutObjectResult::ApiResponse(PutObjectApiResponse {
            request_id: _,
            etag: _,
            content_md5,
            hash_crc64ecma: _,
            version_id: _,
        }) = result
        {
            assert_eq!("gbqycESJX3i9b8aB/3Y7ZQ==", content_md5);
        } else {
            panic!("file md5 validation failed");
        }

        client.delete_object(&bucket, &object, None).unwrap();
    }
}