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
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
#![warn(missing_docs)]
#![forbid(unsafe_code)]
pub mod error;
pub mod storage;

use std::path::PathBuf;
use std::str::FromStr;

pub use crate::error::{Error, Result};
use clap::{Parser, Subcommand};

use crossbeam_channel::Sender;
use derive_more::Display;
pub use storage::{
    XvcLocalStorage, XvcStorage, XvcStorageEvent, XvcStorageGuid, XvcStorageOperations,
};

use xvc_ecs;
use xvc_ecs::XvcStore;

use xvc_core::XvcRoot;
use xvc_logging::XvcOutputLine;

/// Storage (on the cloud) management commands
#[derive(Debug, Parser)]
#[command(name = "storage", about = "")]
pub struct StorageCLI {
    #[command(subcommand)]
    pub subcommand: StorageSubCommand,
}

/// Remote subcommands
#[derive(Debug, Clone, Parser)]
#[command(about = "Manage storages containing tracked file content")]
pub enum StorageSubCommand {
    /// list all remotes
    #[command()]
    List,
    /// Remove a remote
    #[command()]
    Remove {
        /// Name of the remote to be deleted
        #[arg(long)]
        name: String,
    },

    #[command(subcommand)]
    New(StorageNewSubCommand),
}

/// Add new remotes
#[derive(Debug, Clone, Subcommand)]
#[command(about = "add new remotes")]
pub enum StorageNewSubCommand {
    /// add a new local remote
    #[command()]
    Local {
        /// Directory to be set as a remote
        #[arg(long)]
        path: PathBuf,
        #[arg(long, short)]
        name: String,
    },

    /// add a new generic remote
    #[command()]
    Generic {
        /// Name of the remote
        ///
        /// This must be unique among all remotes of the project
        #[arg(long = "name", short = 'n')]
        name: String,
        /// Command to initialize the remote. This command is run once after defining the remote.
        ///
        /// You can use {URL} and {DIR}  as shortcuts.
        #[arg(long = "init", short = 'i')]
        init_command: String,
        /// Command to list the files in remote
        ///
        /// You can use {URL} and {DIR} placeholders and define values for these with --url and --dir options.
        #[arg(long = "list", short = 'l')]
        list_command: String,
        /// Command to download a file from remote.
        ///
        /// You can use {URL} and {DIR} placeholders and define values for these with --url and --dir options.
        #[arg(long = "download", short = 'd')]
        download_command: String,
        /// Command to upload a file to remote.
        ///
        /// You can use {URL} and {DIR} placeholders and define values for these with --url and --dir options.
        #[arg(long = "upload", short = 'u')]
        upload_command: String,
        /// The delete command to remove a file from remote
        /// You can use {URL} and {DIR} placeholders and define values for these with --url and --dir options.
        #[arg(long = "delete", short = 'D')]
        delete_command: String,
        /// Number of maximum processes to run simultaneously
        #[arg(long = "processes", short = 'M', default_value_t = 1)]
        max_processes: usize,
        /// You can set a string to replace {URL} placeholder in commands
        #[arg(long)]
        url: Option<String>,
        /// You can set a string to replace {DIR} placeholder in commands
        #[arg(long)]
        storage_dir: Option<String>,
    },

    /// add a new rsync remote
    #[command()]
    Rsync {
        /// Name of the remote
        ///
        /// This must be unique among all remotes of the project
        #[arg(long = "name", short = 'n')]
        name: String,
        /// Hostname for the connection in the form host.example.com  (without @, : or protocol)
        #[arg(long)]
        host: String,
        /// Port number for the connection in the form 22.
        /// Doesn't add port number to connection string if not given.
        #[arg(long)]
        port: Option<usize>,
        /// User name for the connection, the part before @ in user@example.com (without @,
        /// hostname).
        /// User name isn't included in connection strings if not given.
        #[arg(long)]
        user: Option<String>,
        /// Remote directory in the host to store the files.
        #[arg(long)]
        storage_dir: String,
    },

    #[cfg(feature = "s3")]
    /// Add a new S3 remote
    #[command()]
    S3 {
        /// Name of the remote
        ///
        /// This must be unique among all remotes of the project
        #[arg(long = "name", short = 'n')]
        name: String,
        /// You can set a directory in the bucket with this prefix
        #[arg(long, default_value = "")]
        remote_prefix: String,
        /// S3 bucket name
        #[arg(long)]
        bucket_name: String,
        /// AWS region
        #[arg(long)]
        region: String,
    },

    #[cfg(feature = "minio")]
    /// Add a new Minio remote
    #[command()]
    Minio {
        /// Name of the remote
        ///
        /// This must be unique among all remotes of the project
        #[arg(long = "name", short = 'n')]
        name: String,
        /// Minio server url in the form https://myserver.example.com:9090
        #[arg(long)]
        endpoint: String,
        /// Bucket name
        #[arg(long)]
        bucket_name: String,
        /// Region of the server
        #[arg(long)]
        region: String,
        /// You can set a directory in the bucket with this prefix
        #[arg(long, default_value = "")]
        remote_prefix: String,
    },

    #[cfg(feature = "digital-ocean")]
    /// Add a new Digital Ocean remote
    #[command()]
    DigitalOcean {
        /// Name of the remote
        ///
        /// This must be unique among all remotes of the project
        #[arg(long = "name", short = 'n')]
        name: String,
        /// Bucket name
        #[arg(long)]
        bucket_name: String,
        /// Region of the server
        #[arg(long)]
        region: String,
        /// You can set a directory in the bucket with this prefix
        #[arg(long, default_value = "")]
        remote_prefix: String,
    },

    #[cfg(feature = "r2")]
    /// Add a new R2 remote
    #[command()]
    R2 {
        /// Name of the remote
        ///
        /// This must be unique among all remotes of the project
        #[arg(long = "name", short = 'n')]
        name: String,
        /// R2 account ID
        #[arg(long)]
        account_id: String,
        /// Bucket name
        #[arg(long)]
        bucket_name: String,
        /// You can set a directory in the bucket with this prefix
        #[arg(long, default_value = "")]
        remote_prefix: String,
    },

    #[cfg(feature = "gcs")]
    /// Add a new Google Cloud Storage remote
    #[command()]
    Gcs {
        /// Name of the remote
        ///
        /// This must be unique among all remotes of the project
        #[arg(long = "name", short = 'n')]
        name: String,
        /// Bucket name
        #[arg(long)]
        bucket_name: String,
        /// Region of the server, e.g., europe-west3
        #[arg(long)]
        region: String,
        /// You can set a directory in the bucket with this prefix
        #[arg(long, default_value = "")]
        remote_prefix: String,
    },

    #[cfg(feature = "wasabi")]
    /// Add a new Wasabi remote
    #[command()]
    Wasabi {
        /// Name of the remote
        ///
        /// This must be unique among all remotes of the project
        #[arg(long = "name", short = 'n')]
        name: String,
        /// Bucket name
        #[arg(long)]
        bucket_name: String,
        /// Endpoint for the server, complete with the region if there is
        ///
        /// e.g. for eu-central-1 region, use s3.eu-central-1.wasabisys.com as the endpoint.
        #[arg(long, default_value = "s3.wasabisys.com")]
        endpoint: String,
        /// You can set a directory in the bucket with this prefix
        #[arg(long, default_value = "")]
        storage_prefix: String,
    },
}

/// Specifies a storage by either a name or a GUID.
///
/// Name is specified with `--name` option of most of the storage types.
/// Guid is generated or loaded in [XvcStorageOperations::init] operations and
/// kept in Storage structs.
#[derive(Debug, Clone, PartialEq, Eq, Display)]
pub enum StorageIdentifier {
    Name(String),
    Uuid(uuid::Uuid),
}

impl FromStr for StorageIdentifier {
    /// This tries to parse `s` as a [Uuid]. If it can't it
    /// considers it a name.
    ///
    /// The only way this fails is when `s` cannot be converted to string.
    /// That's very unlikely.
    fn from_str(s: &str) -> Result<Self> {
        match uuid::Uuid::parse_str(s) {
            Ok(uuid) => Ok(Self::Uuid(uuid)),
            Err(_) => Ok(Self::Name(s.to_string())),
        }
    }

    type Err = crate::Error;
}

/// Entry point for `xvc storage` group of commands.
///
/// It matches the subcommand in [StorageCLI::subcommand] and runs the
/// appropriate function.
///
/// Other arguments are passed to subcommands.
pub fn cmd_storage(
    input: std::io::StdinLock,
    output_snd: Sender<XvcOutputLine>,
    xvc_root: &XvcRoot,
    opts: StorageCLI,
) -> Result<()> {
    match opts.subcommand {
        StorageSubCommand::List => cmd_storage_list(input, output_snd, xvc_root),
        StorageSubCommand::Remove { name } => cmd_storage_remove(input, output_snd, xvc_root, name),
        StorageSubCommand::New(new) => cmd_storage_new(input, output_snd, xvc_root, new),
    }
}

/// Configure a new storage. 
/// 
/// The available storages and their configuration is dependent to compilation.
/// In minimum, it includes [local][cmd_storage_new_local] and
/// [generic][cmd_storage_new_generic]. 
/// 
/// This function matches [StorageNewSubCommand] and calls the appropriate
/// function from child modules. Most of the available options are behind 
/// feature flags, that also guard the modules. 
fn cmd_storage_new(
    input: std::io::StdinLock,
    output_snd: Sender<XvcOutputLine>,
    xvc_root: &XvcRoot,
    sc: StorageNewSubCommand,
) -> Result<()> {
    match sc {
        StorageNewSubCommand::Local { path, name } => {
            storage::local::cmd_storage_new_local(input, output_snd, xvc_root, path, name)
        }
        StorageNewSubCommand::Generic {
            name,
            init_command,
            list_command,
            download_command,
            upload_command,
            delete_command,
            max_processes,
            url,
            storage_dir: remote_dir,
        } => storage::generic::cmd_storage_new_generic(
            input,
            output_snd,
            xvc_root,
            name,
            url,
            remote_dir,
            max_processes,
            init_command,
            list_command,
            download_command,
            upload_command,
            delete_command,
        ),
        #[cfg(feature = "s3")]
        StorageNewSubCommand::S3 {
            name,
            remote_prefix,
            bucket_name,
            region,
        } => storage::s3::cmd_new_s3(
            input,
            output_snd,
            xvc_root,
            name,
            region,
            bucket_name,
            remote_prefix,
        ),
        #[cfg(feature = "minio")]
        StorageNewSubCommand::Minio {
            name,
            endpoint,
            bucket_name,
            remote_prefix,
            region,
        } => storage::minio::cmd_new_minio(
            input,
            output_snd,
            xvc_root,
            name,
            endpoint,
            bucket_name,
            region,
            remote_prefix,
        ),
        #[cfg(feature = "digital-ocean")]
        StorageNewSubCommand::DigitalOcean {
            name,
            bucket_name,
            region,
            remote_prefix,
        } => storage::digital_ocean::cmd_new_digital_ocean(
            input,
            output_snd,
            xvc_root,
            name,
            bucket_name,
            region,
            remote_prefix,
        ),
        #[cfg(feature = "r2")]
        StorageNewSubCommand::R2 {
            name,
            account_id,
            bucket_name,
            remote_prefix,
        } => storage::r2::cmd_new_r2(
            input,
            output_snd,
            xvc_root,
            name,
            account_id,
            bucket_name,
            remote_prefix,
        ),
        #[cfg(feature = "gcs")]
        StorageNewSubCommand::Gcs {
            name,
            bucket_name,
            region,
            remote_prefix,
        } => storage::gcs::cmd_new_gcs(
            input,
            output_snd,
            xvc_root,
            name,
            bucket_name,
            region,
            remote_prefix,
        ),
        #[cfg(feature = "wasabi")]
        StorageNewSubCommand::Wasabi {
            name,
            bucket_name,
            endpoint,
            storage_prefix,
        } => storage::wasabi::cmd_new_wasabi(
            input,
            output_snd,
            xvc_root,
            name,
            bucket_name,
            endpoint,
            storage_prefix,
        ),
        StorageNewSubCommand::Rsync {
            name,
            host,
            port,
            user,
            storage_dir,
        } => storage::rsync::cmd_new_rsync(
            input,
            output_snd,
            xvc_root,
            name,
            host,
            port,
            user,
            storage_dir,
        ),
    }
}

/// Removes a storage from the configurations. 
/// 
/// This doesn't remove the history associated with them. 
fn cmd_storage_remove(
    input: std::io::StdinLock,
    output_snd: Sender<XvcOutputLine>,
    xvc_root: &XvcRoot,
    name: String,
) -> Result<()> {
    todo!()
}

/// Lists all available storages. 
/// 
/// It runs [XvcStorage::display] and lists all elements line by line to
/// `output_snd`. 
fn cmd_storage_list(
    _input: std::io::StdinLock,
    output_snd: Sender<XvcOutputLine>,
    xvc_root: &XvcRoot,
) -> Result<()> {
    let store: XvcStore<XvcStorage> = xvc_root.load_store()?;

    for (_, s) in store.iter() {
        output_snd.send(XvcOutputLine::Output(format!("{}\n", s)))?;
    }

    Ok(())
}