Skip to content

ls: validate --block-size before -h/--si overrides it #16025

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Logic769 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

ls: validate --block-size before -h/--si overrides it #16025

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fd24497
ls: validate --block-size before -h/--si overrides it
Logic769 Oct 29, 2026
0baead8
ls: keep the caret when --block-size is rejected under -h or --si
Logic769 Oct 30, 2026
9d2bcef
ls: collect --block-size values with clap
Logic769 Nov 2, 2026
f7b9531
ls: fix clippy redundant closures
Logic769 Nov 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 64 additions & 35 deletions src/uu/ls/src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ use term_grid::SPACES_IN_TAB;
use uucore::{
diagnostics::OptionValue,
display::Quotable,
error::UResult,
error::{UError, UResult},
format::human::SizeFormat,
fsext::MetadataTimeField,
line_ending::LineEnding,
Expand Down Expand Up @@ -622,6 +622,20 @@ fn parse_width(width_match: Option<&String>) -> Result<u16, LsError> {
Ok(ret)
}

/// The report for an invalid `--block-size` value, with the caret under the value.
fn block_size_error(value: &str, diag_args: Option<&[OsString]>) -> Box<dyn UError> {
let ls_error = LsError::BlockSizeParseError(value.to_string());
let message = ls_error.to_string();
let parse_error = parse_size_non_zero_u64(value).expect_err("the value was rejected above");
parse_error.size_value_error(
diag_args,
&OptionValue::with_names(value, None, Some(options::size::BLOCK_SIZE)),
0,
&message,
ls_error,
)
}

/// Parses the tab size value from the command line
fn parse_tab_size(size_str: &str) -> Result<usize, LsError> {
size_str
Expand Down Expand Up @@ -720,53 +734,68 @@ impl Config {
let mut needs_color = extract_color(options);
let hyperlink = extract_hyperlink(options);

let opt_block_size = options.get_one::<String>(options::size::BLOCK_SIZE);
let opt_si = opt_block_size.is_some_and(|x| x == options::size::SI)
|| options.get_flag(options::size::SI);
let opt_hr = opt_block_size.is_some_and(|x| x == options::size::HUMAN_READABLE)
|| options.get_flag(options::size::HUMAN_READABLE);
let opt_kb = options.get_flag(options::size::KIBIBYTES);
// Every --block-size value must be valid, even when a later -h/--si
// overrides it (GNU ls rejects all of them). The last of the size mode
// options on the command line decides the display format.
let block_sizes: Vec<(&String, usize)> = options
.get_many::<String>(options::size::BLOCK_SIZE)
.map(Iterator::collect::<Vec<&String>>)
.unwrap_or_default()
.into_iter()
.zip(
options
.indices_of(options::size::BLOCK_SIZE)
.into_iter()
.flatten(),
)
.collect();

for (value, _) in &block_sizes {
if value.as_str() != options::size::SI
&& value.as_str() != options::size::HUMAN_READABLE
&& parse_size_non_zero_u64(value).is_err()
{
return Err(block_size_error(value, diag_args));
}
}

let size_format = if opt_si {
let mut size_mode: Option<(usize, &str)> = None;
for (value, index) in &block_sizes {
if size_mode.is_none_or(|(latest, _)| *index > latest) {
size_mode = Some((*index, value.as_str()));
}
}
for arg in [options::size::SI, options::size::HUMAN_READABLE] {
if options.get_flag(arg)
&& let Some(index) = options.indices_of(arg).and_then(Iterator::max)
&& size_mode.is_none_or(|(latest, _)| index > latest)
{
size_mode = Some((index, arg));
}
}
let size_mode = size_mode.map(|(_, mode)| mode);

let size_format = if size_mode == Some(options::size::SI) {
SizeFormat::Decimal
} else if opt_hr {
} else if size_mode == Some(options::size::HUMAN_READABLE) {
SizeFormat::Binary
} else {
SizeFormat::Bytes
};

let (file_size_block_size, block_size) = if let Some(opt_block_size) = opt_block_size {
// --block-size command-line argument: parse it, error on invalid
// If --block-size=si or --block-size=human-readable, skip numeric parsing
if opt_si {
let (file_size_block_size, block_size) = if let Some(value) = size_mode {
if value == options::size::SI {
(DEFAULT_FILE_SIZE_BLOCK_SIZE, 1000)
} else if opt_hr {
} else if value == options::size::HUMAN_READABLE {
(DEFAULT_FILE_SIZE_BLOCK_SIZE, DEFAULT_BLOCK_SIZE)
} else {
let size = parse_size_non_zero_u64(opt_block_size).map_err(|error| {
let ls_error = LsError::BlockSizeParseError(opt_block_size.clone());
let message = ls_error.to_string();
error.size_value_error(
diag_args,
&OptionValue::with_names(
opt_block_size,
None,
Some(options::size::BLOCK_SIZE),
),
0,
&message,
ls_error,
)
})?;
// --block-size overrides -k
// --block-size also overrides -k.
let size =
parse_size_non_zero_u64(value).expect("invalid values were rejected above");
(size, size)
}
} else if !opt_si && !opt_hr {
resolve_block_sizes_from_env(opt_kb)
} else if opt_si {
(DEFAULT_FILE_SIZE_BLOCK_SIZE, 1000)
} else {
(DEFAULT_FILE_SIZE_BLOCK_SIZE, DEFAULT_BLOCK_SIZE)
resolve_block_sizes_from_env(options.get_flag(options::size::KIBIBYTES))
};

let long = {
Expand Down
6 changes: 1 addition & 5 deletions src/uu/ls/src/ls.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,6 @@ impl UError for LsError {

#[uucore::main]
pub fn uumain(args: impl uucore::Args) -> UResult<()> {
// The arguments are kept for the caret in SIZE diagnostics, which echoes
// the command line.
let (matches, diag_args) = uucore::clap_localization::handle_clap_result_with_diagnostics(
uu_app(),
args.collect(),
Expand Down Expand Up @@ -608,7 +606,6 @@ pub fn uu_app() -> Command {
.short('h')
.long(options::size::HUMAN_READABLE)
.help(translate!("ls-help-human-readable"))
.overrides_with_all([options::size::BLOCK_SIZE, options::size::SI])
.action(ArgAction::SetTrue),
)
.arg(
Expand All @@ -622,15 +619,14 @@ pub fn uu_app() -> Command {
Arg::new(options::size::SI)
.long(options::size::SI)
.help(translate!("ls-help-si"))
.overrides_with_all([options::size::BLOCK_SIZE, options::size::HUMAN_READABLE])
.action(ArgAction::SetTrue),
)
.arg(
Arg::new(options::size::BLOCK_SIZE)
.long(options::size::BLOCK_SIZE)
.value_name("BLOCK_SIZE")
.help(translate!("ls-help-block-size"))
.overrides_with_all([options::size::SI, options::size::HUMAN_READABLE]),
.action(ArgAction::Append),
)
.arg(
Arg::new(options::INODE)
Expand Down
24 changes: 24 additions & 0 deletions tests/by-util/test_ls.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6640,6 +6640,30 @@ fn test_ls_invalid_block_size() {
.fails_with_code(2)
.no_stdout()
.stderr_is("ls: invalid --block-size argument '0'\n");

// A later -h/--si must not skip validation of an invalid --block-size.
new_ucmd!()
.arg("--block-size=0")
.arg("--si")
.fails_with_code(2)
.no_stdout()
.stderr_is("ls: invalid --block-size argument '0'\n");

new_ucmd!()
.arg("--block-size=invalid")
Comment thread
Logic769 marked this conversation as resolved.
Resolved
.arg("--human-readable")
.fails_with_code(2)
.no_stdout()
.stderr_is("ls: invalid --block-size argument 'invalid'\n");

// --block-size and its value can be two separate arguments.
new_ucmd!()
.arg("--block-size")
.arg("0")
.arg("-h")
.fails_with_code(2)
.no_stdout()
.stderr_is("ls: invalid --block-size argument '0'\n");
}

#[cfg(all(unix, feature = "dd"))]
Expand Down
Loading