forked from dathere/qsv
-
Notifications
You must be signed in to change notification settings - Fork 0
/
foreach.rs
296 lines (248 loc) · 11.3 KB
/
foreach.rs
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
static USAGE: &str = r#"
Execute a shell command once per line in given CSV file.
NOTE: Windows users are recommended to use Git Bash as their terminal when
running this command. Download it from https://git-scm.com/downloads. When installing,
be sure to select "Use Git from the Windows Command Prompt" to ensure that the
necessary Unix tools are available in the terminal.
WARNING: This command can be dangerous. Be careful when using it with
untrusted input.
Or per @thadguidry:
Please ensure when using foreach to use trusted arguments, variables, scripts, etc.
If you don't do due diligence and blindly use untrusted parts... foreach can indeed
become a footgun and possibly fry your computer, eat your lunch, and expose an entire
datacenter to a cancerous virus in your unvetted batch file you grabbed from some
stranger on the internet that runs...FOR EACH LINE in your CSV file. GASP!"
Examples:
Delete all files whose filenames are listed in the filename column:
$ qsv foreach filename 'rm {}' assets.csv
Execute a command that outputs CSV once per record without repeating headers:
$ qsv foreach query --unify 'search --year 2020 {}' queries.csv > results.csv
Same as above but with an additional column containing the current value:
$ qsv foreach query -u -c from_query 'search {}' queries.csv > results.csv
For more examples, see https://github.com/dathere/qsv/blob/master/tests/test_foreach.rs.
Usage:
qsv foreach [options] <column> <command> [<input>]
qsv foreach --help
foreach arguments:
column The column to use as input for the command.
command The command to execute. Use "{}" to substitute the value
of the current input file line.
If you need to execute multiple commands, use a shell
script. See foreach_multiple_commands_with_shell_script()
in tests/test_foreach.rs for an example.
input The CSV file to read. If not provided, will read from stdin.
foreach options:
-u, --unify If the output of the executed command is a CSV,
unify the result by skipping headers on each
subsequent command. Does not work when --dry-run is true.
-c, --new-column <name> If unifying, add a new column with given name
and copying the value of the current input file line.
--dry-run <file|boolean> If set to true (the default for safety reasons), the commands are
sent to stdout instead of executing them.
If set to a file, the commands will be written to the specified
text file instead of executing them.
Only if set to false will the commands be actually executed.
[default: true]
Common options:
-h, --help Display this message
-n, --no-headers When set, the file will be considered to have no
headers.
-d, --delimiter <arg> The field delimiter for reading CSV data.
Must be a single character. (default: ,)
-p, --progressbar Show progress bars. Not valid for stdin.
"#;
#[cfg(target_family = "unix")]
use std::os::unix::ffi::OsStrExt;
#[allow(unused_imports)]
use std::{
ffi::{OsStr, OsString},
io::{self, BufReader, BufWriter, Read, Write},
process::{Command, Stdio},
str::FromStr,
};
#[cfg(feature = "feature_capable")]
use indicatif::{ProgressBar, ProgressDrawTarget};
#[cfg(target_family = "windows")]
use local_encoding::windows::multi_byte_to_wide_char;
use regex::bytes::{NoExpand, Regex};
use serde::Deserialize;
use crate::{
config::{Config, Delimiter},
select::SelectColumns,
util, CliResult,
};
#[derive(Deserialize)]
struct Args {
arg_column: SelectColumns,
arg_command: String,
arg_input: Option<String>,
flag_unify: bool,
flag_new_column: Option<String>,
flag_dry_run: String,
flag_no_headers: bool,
flag_delimiter: Option<Delimiter>,
flag_progressbar: bool,
}
pub fn run(argv: &[&str]) -> CliResult<()> {
let args: Args = util::get_args(USAGE, argv)?;
let rconfig = Config::new(args.arg_input.as_ref())
.delimiter(args.flag_delimiter)
.no_headers(args.flag_no_headers)
.select(args.arg_column);
let mut rdr = rconfig.reader()?;
let mut wtr = Config::new(None).writer()?;
#[allow(clippy::trivial_regex)]
// template_pattern matches pairs of curly braces, e.g. "{}".
let template_pattern = Regex::new(r"\{\}")?;
// splitter_pattern gets all the arguments to the command as tokens.
// The regular expression matches any sequence of characters that consists of one or more word
// characters (`a-z`, `A-Z`, `0-9`, `_`, `.`, `+`, `-`), or any of the following three types of
// quoted strings: double-quoted strings ("..."), single-quoted strings ('...'), or
// backtick-quoted strings (`...`).
let splitter_pattern = Regex::new(r#"(?:[a-zA-Z0-9_.+-]+|"[^"]*"|'[^']*'|`[^`]*`)"#)?;
// cleaner_pattern removes the quotes or backticks from the quoted strings matched by
// splitter_pattern.
let cleaner_pattern = Regex::new(r#"(?:^["'`]|["'`]$)"#)?;
let headers = rdr.byte_headers()?.clone();
let sel = rconfig.selection(&headers)?;
let column_index = *sel.iter().next().unwrap();
let mut dry_run_fname = String::new();
let dry_run = match args.flag_dry_run.as_str() {
str if str.eq_ignore_ascii_case("true") => true,
str if str.eq_ignore_ascii_case("false") => false,
file_str => {
// if the value is not "true" or "false" case-insensitive, it's a file name
// check if we can create the file
let file = std::fs::File::create(file_str);
match file {
Ok(_) => {
dry_run_fname = file_str.to_string();
true
},
Err(e) => {
return fail_incorrectusage_clierror!("Error creating dry-run file: {e}");
},
}
},
};
if dry_run && args.flag_unify {
return fail_incorrectusage_clierror!("Cannot use --unify with --dry-run");
}
if args.flag_new_column.is_some() && !args.flag_unify {
return fail_incorrectusage_clierror!("Cannot use --new-column without --unify");
}
// create a dry-run text file to write the commands to
let mut dry_run_file: Box<dyn Write> = Box::new(BufWriter::new(if dry_run {
if dry_run_fname.is_empty() {
// if dry_run_fname is empty, then we are writing to stdout
Box::new(std::io::stdout()) as Box<dyn Write>
} else {
Box::new(std::fs::File::create(&dry_run_fname)?) as Box<dyn Write>
}
} else {
// we're not doing a dry-run, so we don't need to write to a file
// to satisfy the compiler, we'll just write to /dev/null
Box::new(io::sink()) as Box<dyn Write>
}));
let mut record = csv::ByteRecord::new();
let mut output_headers_written = false;
let mut cmd_args_string;
// prep progress bar
#[cfg(feature = "feature_capable")]
let show_progress =
(args.flag_progressbar || util::get_envvar_flag("QSV_PROGRESSBAR")) && !rconfig.is_stdin();
#[cfg(feature = "feature_capable")]
let progress = ProgressBar::with_draw_target(None, ProgressDrawTarget::stderr_with_hz(5));
#[cfg(feature = "feature_capable")]
if show_progress {
util::prep_progress(&progress, util::count_rows(&rconfig)?);
} else {
progress.set_draw_target(ProgressDrawTarget::hidden());
}
while rdr.read_byte_record(&mut record)? {
#[cfg(feature = "feature_capable")]
if show_progress {
progress.inc(1);
}
let current_value = &record[column_index];
let templated_command = template_pattern
.replace_all(args.arg_command.as_bytes(), current_value)
.to_vec();
#[allow(unused_mut)]
let mut command_pieces = splitter_pattern.find_iter(&templated_command);
#[cfg(target_family = "unix")]
let prog = OsStr::from_bytes(command_pieces.next().unwrap().as_bytes());
#[cfg(target_family = "windows")]
let command_bytes = command_pieces.next().unwrap().as_bytes();
#[cfg(target_family = "windows")]
let command_wide_char = multi_byte_to_wide_char(65001, 0, command_bytes).unwrap();
#[cfg(target_family = "windows")]
let prog_str = OsString::from_str(command_wide_char.as_str()).unwrap();
#[cfg(target_family = "windows")]
let prog = prog_str.as_os_str();
let cmd_args: Vec<String> = command_pieces
.map(|piece| {
let clean_piece = cleaner_pattern.replace_all(piece.as_bytes(), NoExpand(b""));
simdutf8::basic::from_utf8(&clean_piece)
.unwrap_or_default()
.to_string()
})
.collect();
if dry_run {
#[cfg(target_family = "unix")]
let prog_str = simdutf8::basic::from_utf8(prog.as_bytes()).unwrap_or_default();
#[cfg(target_family = "windows")]
let prog_str = simdutf8::basic::from_utf8(prog.as_encoded_bytes()).unwrap_or_default();
cmd_args_string = cmd_args.join(" ");
dry_run_file.write_all(format!("{prog_str} {cmd_args_string}\n").as_bytes())?;
continue;
}
if args.flag_unify {
let mut cmd = Command::new(prog)
.args(cmd_args)
.stdout(Stdio::piped())
.stderr(Stdio::inherit())
.spawn()?;
{
let stdout = cmd.stdout.as_mut().unwrap();
let stdout_reader = BufReader::new(stdout);
let mut stdout_rdr = csv::ReaderBuilder::new()
.delimiter(match &args.flag_delimiter {
Some(delimiter) => delimiter.as_byte(),
None => b',',
})
.has_headers(true)
.from_reader(stdout_reader);
let mut output_record = csv::ByteRecord::new();
if !output_headers_written {
let mut headers = stdout_rdr.byte_headers()?.clone();
if let Some(name) = &args.flag_new_column {
headers.push_field(name.as_bytes());
}
wtr.write_byte_record(&headers)?;
output_headers_written = true;
}
while stdout_rdr.read_byte_record(&mut output_record)? {
if args.flag_new_column.is_some() {
output_record.push_field(current_value);
}
wtr.write_byte_record(&output_record)?;
}
}
cmd.wait()?;
} else {
let mut cmd = Command::new(prog)
.args(cmd_args)
.stdout(Stdio::inherit())
.stderr(Stdio::inherit())
.spawn()?;
cmd.wait()?;
}
}
#[cfg(feature = "feature_capable")]
if show_progress {
util::finish_progress(&progress);
}
dry_run_file.flush()?;
Ok(wtr.flush()?)
}