1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
//
// Copyright (c) Dell Inc., or its subsidiaries. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//

//! Implements the API interface for provisioning and managing buckets.
//!
use anyhow::{bail, Context as _, Result};
use crate::client::ObjectstoreClient;
use crate::response::get_content_text;
use derive_builder::Builder;
use reqwest::header::{ACCEPT, AUTHORIZATION, CONTENT_TYPE};
use serde::{Deserialize, Serialize};
use serde_aux::field_attributes::{deserialize_bool_from_anything, deserialize_default_from_null};

#[derive(Clone, Default, Debug, Deserialize, Serialize)]
#[serde(rename_all(serialize = "snake_case", deserialize = "camelCase"))]
pub struct Link {
    pub rel: String,
    pub href: String,
}

#[derive(Clone, Default, Debug, Deserialize, Serialize)]
#[serde(rename_all(serialize = "snake_case", deserialize = "camelCase"))]
pub struct MinMaxGovernor {
    pub enforce_retention: bool,
    #[serde(deserialize_with = "deserialize_default_from_null")]
    pub minimum_fixed_retention: i64,
    // TODO: need to understand the default value
    #[serde(deserialize_with = "deserialize_default_from_null")]
    pub maximum_fixed_retention: i64,
    #[serde(deserialize_with = "deserialize_default_from_null")]
    pub minimum_variable_retention: i64,
    #[serde(deserialize_with = "deserialize_default_from_null")]
    pub maximum_variable_retention: i64,
}

#[derive(Clone, Default, Debug, Deserialize, Serialize)]
#[serde(rename_all(serialize = "snake_case", deserialize = "camelCase"))]
pub struct MetaData {
    pub key_data_type: String,
    pub key_value: String,
    pub metadata_type: String,
}

#[derive(Clone, Default, Debug, Deserialize, Serialize)]
#[serde(rename_all(serialize = "snake_case", deserialize = "camelCase"))]
pub struct SearchMetaData {
    pub is_enabled: bool,
    pub meta_data: Vec<MetaData>,
    pub max_keys: i32,
    pub md_tokens: bool,
}

/// Lables for bucket.
///
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(rename_all = "PascalCase")]
pub struct Tag {
    /// tag key
    pub key: String,
    /// tag value
    pub value: String,
}


#[derive(Builder, Clone, Debug, Default, Deserialize, Serialize)]
#[builder(setter(skip))]
#[serde(rename_all(serialize = "snake_case", deserialize = "camelCase"), rename(serialize = "object_bucket_create"))]
pub struct Bucket {
    #[builder(setter(into))]
    pub name: String,
    pub id: String,
    pub link: Link,
    #[builder(setter(into))]
    pub namespace: String,
    pub replication: String,
    pub locked: bool,
    pub fs_acess_enabled: bool,
    pub soft_quota: String,
    pub created: String,
    pub is_stale_allowed: bool,
    pub object_lock_with_ado_allowed: bool,
    pub is_tso_read_only: bool,
    #[serde(deserialize_with = "deserialize_default_from_null")]
    pub default_object_lock_retention_mode: String,
    #[serde(deserialize_with = "deserialize_default_from_null")]
    pub default_object_lock_retention_years: i32,
    #[serde(deserialize_with = "deserialize_default_from_null")]
    pub default_object_lock_retention_days: i32,
    pub default_retention: i64,
    pub block_size_in_g_b: i64,
    pub auto_commit_period: i64,
    pub notification_size_in_g_b: i64,
    pub block_size_in_count: i64,
    pub notification_size_in_count: i64,
    #[builder(setter(skip = false), default = "false")]
    #[serde(deserialize_with = "deserialize_bool_from_anything")]
    pub is_encryption_enabled: bool,
    pub retention: i64,
    #[serde(deserialize_with = "deserialize_default_from_null")]
    pub default_group: String,
    pub default_group_file_read_permission: bool,
    pub default_group_file_write_permission: bool,
    pub default_group_file_execute_permission: bool,
    pub default_group_dir_read_permission: bool,
    default_group_dir_write_permission: bool,
    pub default_group_dir_execute_permission: bool,
    pub min_max_governor: MinMaxGovernor,
    pub audit_delete_expiration: i64,
    pub enable_advanced_metadata_search: bool,
    #[serde(deserialize_with = "deserialize_default_from_null")]
    pub advanced_metadata_search_target_name: String,
    #[serde(deserialize_with = "deserialize_default_from_null")]
    pub advanced_metadata_search_target_stream: String,
    pub is_empty_bucket_in_progress: bool,
    pub meta_data: SearchMetaData,
    pub local_object_metadata_reads: bool,
    pub apitype: String,
    pub bucket_owner: String,
    #[serde(rename = "TagSet")]
    pub tag_set: Vec<Tag>,
}

// dose not deserialize all the fields for create bucket response
// as the schema does not align with get bucket response
// would issue get bucket request in addition after creation and send the response accordingly
#[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
struct CreateBucketResponse {
    pub name: String,
    pub id: String,
}

#[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
struct ListBucketsResponse {
    // Does not align with API description
    pub object_bucket_list: Vec<Bucket>,
    pub filter: String,
    pub next_marker: Option<String>,
    pub max_buckets: Option<u32>,
    pub next_page_link: Option<String>,
}

impl Bucket {
    pub(crate) fn create(
        client: &mut ObjectstoreClient,
        bucket: Bucket,
    ) -> Result<String> {
        let request_url = format!(
            "{}object/bucket.json",
            client.endpoint,
        );
        let body = serde_xml_rs::to_string(&bucket).unwrap();
        let resp = client
            .management_client
            .http_client
            .post(request_url)
            .header(ACCEPT, "application/json")
            .header(AUTHORIZATION, client.management_client.access_token.as_ref().unwrap())
            .header(CONTENT_TYPE, "application/xml")
            .body(body)
            .send()?;
        let text = get_content_text(resp)?;
        let resp: CreateBucketResponse = serde_json::from_str(&text).with_context(|| {
            format!(
                "Unable to deserialise CreateBucketResponse. Body was: \"{}\"",
                text
            )
        })?;
        Ok(resp.name)
    }

    pub(crate) fn get(
        client: &mut ObjectstoreClient,
        name: &str,
        namespace: &str,
    ) -> Result<Bucket> {
        let request_url = format!(
            "{}object/bucket/{}/info.json?namespace={}",
            client.endpoint,
            name,
            namespace,
        );
        let resp = client
            .management_client
            .http_client
            .get(request_url)
            .header(ACCEPT, "application/json")
            .header(AUTHORIZATION, client.management_client.access_token.as_ref().unwrap())
            .send()?;
        let text = get_content_text(resp)?;
        let resp: Bucket = serde_json::from_str(&text).with_context(|| {
            format!(
                "Unable to deserialise GetBucket. Body was: \"{}\"",
                text
            )
        })?;
        Ok(resp)
    }

    pub(crate) fn delete(
        client: &mut ObjectstoreClient,
        name: &str,
        namespace: &str,
        empty_bucket: bool,
    ) -> Result<()> {
        let request_url = format!(
            "{}object/bucket/{}/deactivate.json?namespace={}&emptyBucket={}",
            client.endpoint,
            name,
            namespace,
            empty_bucket,
        );
        let resp = client
            .management_client
            .http_client
            .post(request_url)
            .header(ACCEPT, "application/json")
            .header(AUTHORIZATION, client.management_client.access_token.as_ref().unwrap())
            .send()?;
        if !resp.status().is_success() {
            bail!("Request failed: {}", resp.text()?);
        } else if resp.status().as_u16() == 202 {
            // TODO: whether to check response
            // it may last for a while
            bail!("Deletion ongoing");
        }
        Ok(())
    }

    pub(crate) fn list(
        client: &mut ObjectstoreClient,
        namespace: &str,
        name_prefix: &str,
    ) -> Result<Vec<Bucket>> {
        let prefix = if name_prefix.is_empty() {
            "".to_string()
        } else {
            format!("&name={}", name_prefix)
        };
        let request_url = format!(
            "{}object/bucket.json?namespace={}{}",
            client.endpoint,
            namespace,
            prefix,
        );
        let resp = client
            .management_client
            .http_client
            .get(request_url)
            .header(ACCEPT, "application/json")
            .header(AUTHORIZATION, client.management_client.access_token.as_ref().unwrap())
            .send()?;
        let text = get_content_text(resp)?;
        let mut resp: ListBucketsResponse = serde_json::from_str(&text).with_context(|| {
            format!(
                "Unable to deserialise ListBuckestResponse. Body was: \"{}\"",
                text
            )
        })?;
        let mut buckets: Vec<Bucket> = vec![];
        buckets.extend(resp.object_bucket_list);
        while let Some(marker) = resp.next_marker {
            let request_url = format!(
                "{}object/bucket.json?namespace={}{}&marker={}",
                client.endpoint,
                namespace,
                prefix,
                marker,
            );
            let response = client
                .management_client
                .http_client
                .get(request_url)
                .header(ACCEPT, "application/json")
                .header(AUTHORIZATION, client.management_client.access_token.as_ref().unwrap())
                .send()?;
            let text = get_content_text(response)?;
            resp = serde_json::from_str(&text).with_context(|| {
                format!(
                    "Unable to deserialise ListBucketsResponse. Body was: \"{}\"",
                    text
                )
            })?;
            buckets.extend(resp.object_bucket_list);
        }
        Ok(buckets)
    }
}