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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
use std::fmt::Display;

use bytesize::ByteSize;
use serde::{Deserialize, Serialize};
use time::{Date, OffsetDateTime, Weekday};

use crate::api::server::ServerId;

/// Unique StorageBox ID.
///
/// Simple wrapper around a u32, to avoid confusion with for example [`ServerId`](crate::api::server::ServerId)
/// and to make it intuitive what kind of argument you need to give to functions like [`AsyncRobot::get_storagebox`](crate::AsyncRobot::get_storagebox()).
///
/// Using a plain integer means it isn't clear what the argument is, is it a counter of my servers, where the argument
/// is in range `0..N` where `N` is the number of storageboxes in my account, or is it a limiter, like get first `N`
/// storageboxes, for example.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct StorageBoxId(pub u32);

impl From<u32> for StorageBoxId {
    fn from(value: u32) -> Self {
        StorageBoxId(value)
    }
}

impl From<StorageBoxId> for u32 {
    fn from(value: StorageBoxId) -> Self {
        value.0
    }
}

impl Display for StorageBoxId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.0.fmt(f)
    }
}

impl PartialEq<u32> for StorageBoxId {
    fn eq(&self, other: &u32) -> bool {
        self.0.eq(other)
    }
}

/// Reference to a storagebox.
///
/// Does not contain disk, access or reachability information.
#[derive(Debug, Clone, Deserialize)]
pub struct StorageBoxReference {
    /// Unique ID for this storagebox.
    pub id: StorageBoxId,

    /// Login/username used for accessing the storagebox.
    pub login: String,

    /// Human-readable name for the storage box.
    pub name: String,

    /// Product name, such as `BX06`.
    pub product: String,

    /// Indicates whether the storagebox has been cancelled.
    pub cancelled: bool,

    /// Indicates if the storagebox is locked.
    pub locked: bool,

    /// Datacenter location of the storagebox, e.g. `FSN1`.
    pub location: String,

    /// Server which this storagebox is linked to.
    pub linked_server: Option<ServerId>,

    /// Date until which this storagebox has been paid for.
    pub paid_until: Date,
}

/// Storage Box
#[derive(Debug, Clone, Deserialize)]
pub struct StorageBox {
    /// Unique ID for this storagebox.
    pub id: StorageBoxId,

    /// Login/username used for accessing the storagebox.
    pub login: String,

    /// Human-readable name for the storage box.
    pub name: String,

    /// Product name, such as `BX06`.
    pub product: String,

    /// Indicates whether the storagebox has been cancelled.
    pub cancelled: bool,

    /// Indicates if the storagebox is locked.
    pub locked: bool,

    /// Datacenter location of the storagebox, e.g. `FSN1`.
    pub location: String,

    /// Server which this storagebox is linked to.
    pub linked_server: Option<ServerId>,

    /// Date until which this storagebox has been paid for.
    pub paid_until: Date,

    /// Servername through which the storagebox can be accessed.
    pub server: String,

    /// Name of the host system for the storagebox.
    pub host_system: String,

    /// Disk usage and quota.
    #[serde(flatten)]
    pub disk: Disk,

    /// If enabled, a snapshots directory is mounted at from which
    /// data can be copied.
    ///
    /// See more at: <https://docs.hetzner.com/robot/storage-box/snapshots/>
    #[serde(rename = "zfs")]
    pub snapshot_directory: bool,

    /// Accessibility.
    #[serde(flatten)]
    pub accessibility: Accessibility,
}

/// Disk usage and quota information for a storagebox.
#[derive(Debug, Clone, Deserialize)]
pub struct Disk {
    /// Storage quota.
    #[serde(rename = "disk_quota", with = "crate::conversion::mib")]
    pub quota: ByteSize,

    /// Storage usage in total (combined data & snapshots).
    #[serde(rename = "disk_usage", with = "crate::conversion::mib")]
    pub total: ByteSize,

    /// Storage used by data.
    #[serde(rename = "disk_usage_data", with = "crate::conversion::mib")]
    pub data: ByteSize,

    /// Storage used by snapshots.
    #[serde(rename = "disk_usage_snapshots", with = "crate::conversion::mib")]
    pub snapshots: ByteSize,
}

/// Accessibility covers the availability of different services one might
/// use to access the storagebox.
#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct Accessibility {
    /// Indicates whether the storagebox is accessible via WebDAV.
    pub webdav: bool,

    /// Indicates whether the storagebox is available over Samba.
    pub samba: bool,

    /// Indicates whether the storagebox is accessible via SSH.
    pub ssh: bool,

    /// Indicates whether the server is externally reachable.
    pub external_reachability: bool,
}

/// A snapshot is a point-in-time backup of the storagebox, which can be
/// used to restore the storagebox to the captured state..
#[derive(Debug, Clone, Deserialize)]
pub struct Snapshot {
    /// Name of the snapshot.
    pub name: String,

    /// Point in time at which the snapshot was taken.
    #[serde(with = "time::serde::rfc3339")]
    pub timestamp: OffsetDateTime,

    /// Size of the snapshot.
    #[serde(with = "crate::conversion::mib")]
    pub size: ByteSize,

    /// Size of the filesystem.
    #[serde(with = "crate::conversion::mib")]
    pub filesystem_size: ByteSize,

    /// Indicates whether the snapshot was produced by an
    /// automatic or manual process.
    pub automatic: bool,

    /// Optional comment associated with the snapshot.
    pub comment: String,
}

/// Short summary of the newly created snapshot.
#[derive(Debug, Clone, Deserialize)]
pub struct CreatedSnapshot {
    /// Name of the snapshot.
    pub name: String,

    /// Point in time at which the snapshot was taken.
    #[serde(with = "time::serde::rfc3339")]
    pub timestamp: OffsetDateTime,

    /// Size of the snapshot.
    #[serde(with = "crate::conversion::mib")]
    pub size: ByteSize,
}

/// Snapshot plans periodically take snapshots of the underlying storagebox.
#[derive(Default, Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
pub struct SnapshotPlan {
    /// Indicates whether the snapshot plan is enabled or not.
    pub status: PlanStatus,

    /// Minute at which to take the snapshot.
    #[serde(default)]
    pub minute: u8,

    /// Hour at which to take the snapshot.
    #[serde(default)]
    pub hour: u8,

    /// Day of week on which to take snapshot.
    #[serde(
        default,
        with = "crate::conversion::weekday_plus_one",
        skip_serializing_if = "Option::is_none"
    )]
    pub day_of_week: Option<Weekday>,

    /// 1-indexed day of month on which to take a snapshot.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub day_of_month: Option<u8>,

    /// Maximum number of snapshots to keep around for this plan.
    ///
    /// Stand-alone storageboxes are limited to 10 snapshots, while linked
    /// storageboxes are limited to only 2.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub max_snapshots: Option<u8>,
}

impl SnapshotPlan {
    /// Daily snapshots taken at the given time.
    pub fn daily(hour: u8, minute: u8) -> SnapshotPlan {
        SnapshotPlan {
            status: PlanStatus::Enabled,
            minute,
            hour,
            day_of_week: None,
            day_of_month: None,
            max_snapshots: None,
        }
    }

    /// Weekly snapshots taken on the given day of the week and time.
    pub fn weekly(day: Weekday, hour: u8, minute: u8) -> SnapshotPlan {
        SnapshotPlan {
            status: PlanStatus::Enabled,
            minute,
            hour,
            day_of_week: Some(day),
            day_of_month: None,
            max_snapshots: None,
        }
    }

    /// Monthly snapshots taken at the given day of the month and time.
    pub fn monthly(day: u8, hour: u8, minute: u8) -> SnapshotPlan {
        SnapshotPlan {
            status: PlanStatus::Enabled,
            minute,
            hour,
            day_of_week: None,
            day_of_month: Some(day),
            max_snapshots: None,
        }
    }

    /// Limit the maximum number of snapshots to keep.
    ///
    /// Stand-alone storageboxes are limited to 10 snapshots, while linked
    /// storageboxes are limited to only 2.
    pub fn with_limit(mut self, max_snapshots: u8) -> SnapshotPlan {
        self.max_snapshots = Some(max_snapshots);
        self
    }
}

/// Indicates whether the snapshot plan is enabled or not.
#[derive(Default, Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
pub enum PlanStatus {
    /// Plan is enabled.
    Enabled,
    /// Plan is disabled.
    #[default]
    Disabled,
}

/// Describes a sub-account for the storabox.
#[derive(Debug, Clone, Deserialize)]
pub struct Subaccount {
    /// Username for the sub-account.
    pub username: SubaccountId,

    /// Account ID for the storagebox itself.
    pub accountid: String,

    /// Hostname for the storagebox server.
    pub server: String,

    /// Home directory of the sub-account.
    pub homedirectory: String,

    /// Accessibility options for the sub-account.
    #[serde(flatten)]
    pub accessibility: Accessibility,

    /// Indicates whether the sub-account is limited to read-only access.
    pub readonly: Permission,

    /// Timestamp at which the sub-account was created.
    #[serde(deserialize_with = "crate::conversion::assume_berlin_timezone")]
    pub createtime: OffsetDateTime,

    /// Comment or description associated with the sub-account
    pub comment: String,
}

/// Describes a sub-account for the storabox.
#[derive(Debug, Clone, Deserialize)]
pub struct CreatedSubaccount {
    /// Username for the sub-account.
    pub username: SubaccountId,

    /// Password for the created sub-account
    pub password: String,

    /// Account ID for the storagebox itself.
    pub accountid: String,

    /// Hostname for the storagebox server.
    pub server: String,

    /// Home directory of the sub-account.
    pub homedirectory: String,
}

/// Unique Storagebox sub-account ID.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct SubaccountId(pub String);

impl From<String> for SubaccountId {
    fn from(value: String) -> Self {
        SubaccountId(value)
    }
}

impl From<&str> for SubaccountId {
    fn from(value: &str) -> Self {
        SubaccountId(value.to_string())
    }
}

impl From<SubaccountId> for String {
    fn from(value: SubaccountId) -> Self {
        value.0
    }
}

impl Display for SubaccountId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.0.fmt(f)
    }
}

impl PartialEq<str> for SubaccountId {
    fn eq(&self, other: &str) -> bool {
        self.0.eq(other)
    }
}

/// Permissions of the sub-account.
#[derive(Default, Debug, Clone, Copy, PartialEq, Eq)]
pub enum Permission {
    /// Subaccount is only able to read from the storagebox/directory
    #[default]
    ReadOnly,
    /// Subaccount can read, write, create and delete within the storagebox/directory
    ReadWrite,
}

impl Serialize for Permission {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        serializer.serialize_bool(match self {
            Permission::ReadOnly => true,
            Permission::ReadWrite => false,
        })
    }
}

impl<'de> Deserialize<'de> for Permission {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        Ok(match bool::deserialize(deserializer)? {
            true => Permission::ReadOnly,
            false => Permission::ReadWrite,
        })
    }
}

#[cfg(test)]
mod tests {
    use crate::api::storagebox::{StorageBoxId, SubaccountId};

    use super::Permission;

    #[test]
    fn storagebox_id() {
        assert_eq!(StorageBoxId(10), StorageBoxId::from(10));

        assert_eq!(u32::from(StorageBoxId(10)), 10);
        assert_eq!(StorageBoxId(10), 10);
    }

    #[test]
    fn subaccount_id() {
        assert_eq!(
            SubaccountId::from("sub-1".to_string()),
            SubaccountId::from("sub-1")
        );

        assert_eq!(&SubaccountId("sub-2".to_string()), "sub-2")
    }

    #[test]
    fn permission_deserialization() {
        let permission = Permission::ReadOnly;

        assert_eq!(
            permission,
            serde_json::from_str::<Permission>(&serde_json::to_string(&permission).unwrap())
                .unwrap()
        );

        let permission = Permission::ReadWrite;

        assert_eq!(
            permission,
            serde_json::from_str::<Permission>(&serde_json::to_string(&permission).unwrap())
                .unwrap()
        );
    }
}