imag-ref 0.10.1

Part of the imag core distribution: imag-ref command
Documentation 
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

//
// imag - the personal information management suite for the commandline
// Copyright (C) 2015-2020 Matthias Beyer <mail@beyermatthias.de> and contributors
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; version
// 2.1 of the License.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//

use std::path::PathBuf;

use clap::{Arg, App, ArgMatches, SubCommand};
use failure::Fallible as Result;

use libimagstore::storeid::StoreId;
use libimagstore::storeid::IntoStoreId;
use libimagrt::runtime::IdPathProvider;

pub fn build_ui<'a>(app: App<'a, 'a>) -> App<'a, 'a> {
    app
        .subcommand(SubCommand::with_name("deref")
                    .about("'Dereference a ref. This prints the Path(es) of the referenced file(s)")
                    .version("0.1")
                    .arg(Arg::with_name("ID")
                         .index(1)
                         .takes_value(true)
                         .required(false)
                         .multiple(true)
                         .help("The id of the store entry to dereference.")
                         .value_name("ID"))

                    .arg(Arg::with_name("ignore-noref")
                         .long("ignore-noref")
                         .takes_value(false)
                         .required(false)
                         .multiple(false)
                         .help("Ignore store entries which are not refs and do not print error message"))

                    .arg(Arg::with_name("override-basepath")
                         .long("basepath-setting")
                         .short("B")
                         .takes_value(true)
                         .required(false)
                         .multiple(false)
                         .help("Override the basepath key to look up in the configuration"))
                    )

        .subcommand(SubCommand::with_name("remove")
                .about("Remove a reference from an entry")
                .version("0.1")
                .arg(Arg::with_name("ID")
                     .index(1)
                     .takes_value(true)
                     .required(false)
                     .multiple(true)
                     .help("Remove the reference from this store entry")
                     .value_name("ENTRIES"))

                .arg(Arg::with_name("ignore-noref")
                     .long("ignore-noref")
                     .takes_value(false)
                     .required(false)
                     .multiple(false)
                     .help("Ignore store entries which are not refs and do not print error message"))
                )

        .subcommand(SubCommand::with_name("create")
                .about("Create a reference to a file")
                .version("0.1")
                .arg(Arg::with_name("ID")
                     .index(1)
                     .takes_value(true)
                     .required(true)
                     .multiple(false)
                     .help("Create a reference with that ID in the store. If the store id exists, it will be made into a reference.")
                     .value_name("ID"))

                .arg(Arg::with_name("path")
                     .index(2)
                     .takes_value(true)
                     .required(true)
                     .multiple(false)
                     .help("The path to refer to. If there is no basepath configuration in the config file for the path this file is located at, the operation will error.")
                     .value_name("ID"))

                .arg(Arg::with_name("force")
                     .long("force")
                     .takes_value(false)
                     .required(false)
                     .multiple(false)
                     .help("Use force to override existing references"))
                )

        .subcommand(SubCommand::with_name("list-dead")
                .about("List all dead references")
                .version("0.1")
                .arg(Arg::with_name("ID")
                     .index(1)
                     .takes_value(true)
                     .required(false)
                     .multiple(true)
                     .help("Filter these IDs for dead ones")
                     .value_name("ID"))

                .arg(Arg::with_name("list-dead-pathes")
                     .long("pathes")
                     .takes_value(false)
                     .required(false)
                     .multiple(false)
                     .conflicts_with("list-dead-ids")
                     .help("List pathes which do not exist anymore but are referenced from imag entries"))

                .arg(Arg::with_name("list-dead-ids")
                     .long("ids")
                     .takes_value(false)
                     .required(false)
                     .multiple(false)
                     .conflicts_with("list-dead-pathes")
                     .help("List ids of entries which refer to a path that does not exist"))
                )

}

pub struct PathProvider;
impl IdPathProvider for PathProvider {
    fn get_ids(matches: &ArgMatches) -> Result<Option<Vec<StoreId>>> {
        fn get_id_paths(subm: &ArgMatches) -> Result<Option<Vec<StoreId>>> {
            subm.values_of("ID")
                .map(|v| v
                     .map(PathBuf::from)
                     .map(|pb| pb.into_storeid())
                     .collect::<Result<Vec<_>>>()
                )
                .transpose()
        }

        match matches.subcommand() {
            ("deref", Some(subm)) => get_id_paths(subm),
            ("remove", Some(subm)) => get_id_paths(subm),
            ("list-dead", Some(subm)) => get_id_paths(subm),
            ("create", _) => Err(format_err!("Command does not get IDs as input")),
            (other, _) => Err(format_err!("Not a known command: {}", other)),
        }
    }
}