tagctl 1.2.1

Adds or removes tags to given paths inside square brackets or to extended attributes
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
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

/*
Copyright (C) 2022  Kody VB
This file is part of Tagctl.

Tagctl is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version.

Tagctl 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 General Public License for more
details.

You should have received a copy of the GNU General Public License along with
Tagctl. If not, see <https://www.gnu.org/licenses/>.
*/

use crate::cli;
use crate::shared_logic;
use regex::Regex;
use std::path::{Path, PathBuf};

pub fn add_tag(path: &Path, data: &cli::Args) {
    // Adds tag to a path using existing [], or creating new [] if not already there
    if !path.exists() {
        eprintln!(
            "Error: Couldn't find expected file: \"{}\"",
            path.to_str().unwrap()
        );
        return;
    }

    let current_stem: String = path.file_stem().unwrap().to_str().unwrap().to_owned();
    let tag: String = if data.tag_varies {
        shared_logic::convert_tag_characters(path, &data.tag)
    } else {
        data.tag.clone()
    };

    if tag_in_brackets(&current_stem, &tag, &data.delimiter) {
        if data.verbose {
            println!("Ignored: {}", path.to_str().unwrap());
        }
        return;
    }

    let mut new_name: String;
    if contains_brackets(&current_stem) {
        new_name = add_tag_to_brackets(&current_stem, &tag, &data.delimiter);
    } else {
        new_name = String::from(&current_stem);
        new_name.push('[');
        new_name.push_str(&tag);
        new_name.push(']');
    }

    if path.extension().is_some() {
        new_name.push('.');
        new_name.push_str(path.extension().unwrap().to_str().unwrap());
    }

    let final_path: PathBuf = get_valid_path(path.parent().unwrap(), &new_name);
    if data.verbose {
        println!(
            "Moving: \"{}\" -> \"{}\"",
            path.to_str().unwrap(),
            final_path.to_str().unwrap()
        );
    }
    std::fs::rename(path.to_str().unwrap(), final_path.to_str().unwrap())
        .map_err(|err| {
            eprintln!(
                "Couldn't rename: \"{}\" -> \"{}\"\nerror: {}",
                path.to_str().unwrap(),
                final_path.to_str().unwrap(),
                err
            );
        })
        .ok();
}

pub fn remove_tag(path: &Path, data: &cli::Args) {
    // Removes tag from Path, removing [] if empty afterwards
    if !path.exists() {
        eprintln!(
            "Error: Couldn't find expected file: \"{}\"",
            path.to_str().unwrap()
        );
        return;
    }

    let current_stem: String = path.file_stem().unwrap().to_str().unwrap().to_owned();
    let tag: String = if data.tag_varies {
        shared_logic::convert_tag_characters(path, &data.tag)
    } else {
        data.tag.clone()
    };

    if !tag_in_brackets(&current_stem, &tag, &data.delimiter) {
        if data.verbose {
            println!("Ignored: \"{}\"", path.to_str().unwrap());
        }
        return;
    }

    let mut new_name: String = remove_tag_from_brackets(&current_stem, &tag, &data.delimiter);
    if path.extension().is_some() {
        new_name.push('.');
        new_name.push_str(path.extension().unwrap().to_str().unwrap());
    }

    let final_path: PathBuf = get_valid_path(path.parent().unwrap(), &new_name);
    if data.verbose {
        println!(
            "Moving: \"{}\" -> \"{}\"",
            path.to_str().unwrap(),
            final_path.to_str().unwrap()
        );
    }
    std::fs::rename(path.to_str().unwrap(), final_path.to_str().unwrap())
        .map_err(|err| {
            eprintln!(
                "Couldn't rename: \"{}\" -> \"{}\"\nerror: {}",
                path.to_str().unwrap(),
                final_path.to_str().unwrap(),
                err
            );
        })
        .ok();
}

pub fn remove_all_tags(path: &Path, data: &cli::Args) {
    // Removes all tags and [] from path
    if !path.exists() {
        eprintln!(
            "Error: Couldn't find expected file: \"{}\"",
            path.to_str().unwrap()
        );
        return;
    }

    let current_stem: String = path.file_stem().unwrap().to_str().unwrap().to_owned();
    if !contains_brackets(&current_stem) {
        if data.verbose {
            println!("Ignored: \"{}\"", path.to_str().unwrap());
        }
        return;
    }

    let mut new_name: String = String::new();
    let indices: (usize, usize) = get_bracket_indices(&current_stem);
    new_name.push_str(&current_stem.clone()[..indices.0]);
    new_name.push_str(&current_stem.clone()[indices.1..]);

    if path.extension().is_some() {
        new_name.push('.');
        new_name.push_str(path.extension().unwrap().to_str().unwrap());
    }

    let final_path: PathBuf = get_valid_path(path.parent().unwrap(), &new_name);
    if data.verbose {
        println!(
            "Moving: \"{}\" -> \"{}\"",
            path.to_str().unwrap(),
            final_path.to_str().unwrap()
        );
    }
    std::fs::rename(path.to_str().unwrap(), final_path.to_str().unwrap())
        .map_err(|err| {
            eprintln!(
                "Couldn't rename: \"{}\" -> \"{}\"\nerror: {}",
                path.to_str().unwrap(),
                final_path.to_str().unwrap(),
                err
            );
        })
        .ok();
}

pub fn get_valid_path(directory: &Path, name: &str) -> PathBuf {
    // If the name already exists in the directory, add ~# to the end, where # is the lowest available number
    let re = Regex::new("~[0-9]+$").unwrap();
    let mut new_name: String = String::from(name);
    if re.is_match(name) {
        let indices = re.find(name).unwrap();
        new_name = new_name[..indices.start()].to_owned();
    }
    if !directory.join(new_name.clone()).exists() {
        return directory.join(new_name);
    }

    let mut count: u32 = 1;
    new_name.push('~');
    while directory
        .join(new_name.clone() + count.clone().to_string().as_str())
        .exists()
    {
        count += 1;
    }
    new_name.push_str(count.to_string().as_str());
    directory.join(new_name)
}

pub fn add_tag_to_brackets(name: &str, tag: &str, delimiter: &str) -> String {
    // Adds tag to existing brackets
    let mut bracket_list: Vec<String> = split_bracket_contents(name, delimiter);
    bracket_list.push(tag.to_owned());
    let bracket_string: String = bracket_list.join(delimiter);
    let indices: (usize, usize) = get_bracket_indices(name);
    let mut new_name: String = name[..=indices.0].to_owned();
    new_name.push_str(&bracket_string);
    new_name.push_str(&name[indices.1 - 1..name.len()]);
    new_name
}

pub fn remove_tag_from_brackets(name: &str, tag: &str, delimiter: &str) -> String {
    // Removes tag from brackets, removing brackets if emptied afterwards, and
    // returns new name as string
    let mut bracket_list: Vec<String> = split_bracket_contents(name, delimiter);
    if bracket_list.contains(&tag.to_owned()) {
        bracket_list.remove(bracket_list.iter().position(|r| r == tag).unwrap());
    }

    let mut new_name: String = String::new();
    let indices: (usize, usize) = get_bracket_indices(name);
    if bracket_list.is_empty() {
        new_name.push_str(&name.to_owned()[..indices.0]);
        new_name.push_str(&name.to_owned()[indices.1..]);
        return new_name;
    }

    let bracket_string: String = bracket_list.join(delimiter);
    new_name.push_str(&name.to_owned()[..indices.0]);
    new_name.push('[');
    new_name.push_str(&bracket_string);
    new_name.push(']');
    new_name.push_str(&name.to_owned()[indices.1..]);
    new_name
}

pub fn get_bracket_indices(name: &str) -> (usize, usize) {
    // Returns the indices that the left and right brackets are at so the new
    // tags can replace what's in them
    let indices = Regex::new("\\[.*?\\]").unwrap().find(name).unwrap();
    (indices.start(), indices.end())
}

pub fn tag_in_brackets(name: &str, tag: &str, delimiter: &str) -> bool {
    // Tells whether or not a given tag is in [] within a given string
    if !contains_brackets(name) {
        return false;
    }
    let bracket_list: Vec<String> = split_bracket_contents(name, delimiter);
    if !(bracket_list.contains(&tag.to_owned())) {
        return false;
    }
    true
}

pub fn contains_brackets(name: &str) -> bool {
    // Tells whether or not a given string contains []
    Regex::new("\\[.*?\\]").unwrap().is_match(name)
}

pub fn split_bracket_contents(name: &str, delimiter: &str) -> Vec<String> {
    // Returns list of everything between first [ and ]
    let pattern = Regex::new("\\[.*?\\]").unwrap();
    let mut inside_brackets = pattern.find(name).unwrap().as_str().to_owned();
    inside_brackets = inside_brackets[1..inside_brackets.len() - 1].to_owned();
    let mut bracket_list = vec![];
    for each_item in inside_brackets.split(delimiter) {
        bracket_list.push(each_item.to_owned());
    }
    bracket_list
}