Skip to content

Commit

Permalink
wc: fix escaping
Browse files Browse the repository at this point in the history
GNU wc only escapes file names with newlines in them.
  • Loading branch information
jtracey committed Dec 27, 2024
1 parent d3db8dc commit ff8a31e
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 14 deletions.
2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ windows = ["feat_os_windows"]
nightly = []
test_unimplemented = []
expensive_tests = []
# "test_risky_names" == enable tests that create problematic file names (would make a network share inaccessible to Windows, breaks SVN on Mac OS, etc.)
test_risky_names = []
# * only build `uudoc` when `--feature uudoc` is activated
uudoc = ["zip", "dep:uuhelp_parser"]
## features
Expand Down
4 changes: 3 additions & 1 deletion build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ pub fn main() {
#[allow(clippy::match_same_arms)]
match krate.as_ref() {
"default" | "macos" | "unix" | "windows" | "selinux" | "zip" => continue, // common/standard feature names
"nightly" | "test_unimplemented" | "expensive_tests" => continue, // crate-local custom features
"nightly" | "test_unimplemented" | "expensive_tests" | "test_risky_names" => {
continue
} // crate-local custom features
"uudoc" => continue, // is not a utility
"test" => continue, // over-ridden with 'uu_test' to avoid collision with rust core crate 'test'
s if s.starts_with(FEATURE_PREFIX) => continue, // crate feature sets
Expand Down
33 changes: 20 additions & 13 deletions src/uu/wc/src/wc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -255,13 +255,17 @@ impl<'a> Input<'a> {
}

/// Converts input to title that appears in stats.
fn to_title(&self) -> Option<Cow<str>> {
fn to_title(&self) -> Option<Cow<OsStr>> {
match self {
Self::Path(path) => Some(match path.to_str() {
Some(s) if !s.contains('\n') => Cow::Borrowed(s),
_ => Cow::Owned(escape_name_wrapper(path.as_os_str())),
}),
Self::Stdin(StdinKind::Explicit) => Some(Cow::Borrowed(STDIN_REPR)),
Self::Path(path) => {
let path = path.as_os_str();
if path.to_string_lossy().contains('\n') {
Some(Cow::Owned(quoting_style::escape_name(path, QS_ESCAPE)))
} else {
Some(Cow::Borrowed(path))
}
}
Self::Stdin(StdinKind::Explicit) => Some(Cow::Borrowed(OsStr::new(STDIN_REPR))),
Self::Stdin(StdinKind::Implicit) => None,
}
}
Expand Down Expand Up @@ -852,14 +856,17 @@ fn wc(inputs: &Inputs, settings: &Settings) -> UResult<()> {
let maybe_title = input.to_title();
let maybe_title_str = maybe_title.as_deref();
if let Err(err) = print_stats(settings, &word_count, maybe_title_str, number_width) {
let title = maybe_title_str.unwrap_or("<stdin>");
show!(err.map_err_context(|| format!("failed to print result for {title}")));
let title = maybe_title_str.unwrap_or(OsStr::new("<stdin>"));
show!(err.map_err_context(|| format!(
"failed to print result for {}",
title.to_string_lossy()
)));
}
}
}

if settings.total_when.is_total_row_visible(num_inputs) {
let title = are_stats_visible.then_some("total");
let title = are_stats_visible.then_some(OsStr::new("total"));
if let Err(err) = print_stats(settings, &total_word_count, title, number_width) {
show!(err.map_err_context(|| "failed to print total".into()));
}
Expand All @@ -873,7 +880,7 @@ fn wc(inputs: &Inputs, settings: &Settings) -> UResult<()> {
fn print_stats(
settings: &Settings,
result: &WordCount,
title: Option<&str>,
title: Option<&OsStr>,
number_width: usize,
) -> io::Result<()> {
let mut stdout = io::stdout().lock();
Expand All @@ -893,8 +900,8 @@ fn print_stats(
}

if let Some(title) = title {
writeln!(stdout, "{space}{title}")
} else {
writeln!(stdout)
write!(stdout, "{space}")?;
stdout.write_all(&uucore::os_str_as_bytes_lossy(title))?;
}
writeln!(stdout)
}
26 changes: 26 additions & 0 deletions tests/by-util/test_wc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,32 @@ fn test_gnu_compatible_quotation() {
.stdout_is("0 0 0 'some-dir1/12'$'\\n''34.txt'\n");
}

#[cfg(feature = "test_risky_names")]
#[test]
fn test_non_unicode_names() {
let scene = TestScenario::new(util_name!());
let target1 = uucore::os_str_from_bytes(b"some-dir1/1\xC0\n.txt")
.expect("Only unix platforms can test non-unicode names");
let target2 = uucore::os_str_from_bytes(b"some-dir1/2\xC0\t.txt")
.expect("Only unix platforms can test non-unicode names");
let at = &scene.fixtures;
at.mkdir("some-dir1");
at.touch(&target1);
at.touch(&target2);
scene
.ucmd()
.args(&[target1, target2])
.run()
.stdout_is_bytes(
[
b"0 0 0 'some-dir1/1'$'\\300\\n''.txt'\n".to_vec(),
b"0 0 0 some-dir1/2\xC0\t.txt\n".to_vec(),
b"0 0 0 total\n".to_vec(),
]
.concat(),
);
}

#[test]
fn test_multiple_default() {
new_ucmd!()
Expand Down

0 comments on commit ff8a31e

Please sign in to comment.