Skip to content

Commit

Permalink
parse command to list of arguments
Browse files Browse the repository at this point in the history
  • Loading branch information
@ndtoan96
ndtoan96 committed Sep 27, 2023
1 parent 8e93d6f commit 8d24382
Show file tree
Hide file tree
Showing 3 changed files with 127 additions and 181 deletions.
1 change: 0 additions & 1 deletion Cargo.lock
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion core/Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ yazi-prebuild = "^0"

[target.'cfg(target_os = "windows")'.dependencies]
clipboard-win = "^4"
nom = "^7"

[target.'cfg(not(target_os = "netbsd"))'.dependencies]
trash = "^3"
306 changes: 127 additions & 179 deletions core/src/external/shell.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ use anyhow::Result;
use tokio::process::{Child, Command};

pub struct ShellOpt {
pub cmd: OsString,
pub args: Vec<OsString>,
pub piped: bool,
pub cmd: OsString,
pub args: Vec<OsString>,
pub piped: bool,
pub orphan: bool,
}

Expand Down Expand Up @@ -37,11 +37,11 @@ pub fn shell(opt: ShellOpt) -> Result<Child> {
#[cfg(target_os = "windows")]
{
let args: Vec<String> = opt.args.iter().map(|s| s.to_string_lossy().to_string()).collect();
let expanded_cmd = cmdexpand::expand_cmd(opt.cmd.to_string_lossy().as_ref(), &args)?;
let expanded_args = cmdparse::parse_cmd_to_args(opt.cmd.to_string_lossy().as_ref(), &args);
Ok(
Command::new("cmd")
.arg("/C")
.arg(expanded_cmd)
.args(&expanded_args)
.stdin(if opt.piped { Stdio::piped() } else { Stdio::inherit() })
.stdout(if opt.piped { Stdio::piped() } else { Stdio::inherit() })
.stderr(if opt.piped { Stdio::piped() } else { Stdio::inherit() })
Expand All @@ -52,210 +52,158 @@ pub fn shell(opt: ShellOpt) -> Result<Child> {
}

#[cfg(target_os = "windows")]
mod cmdexpand {
use anyhow::{anyhow, Result};
use nom::{
branch::alt,
bytes::complete::{is_not, tag, take_while1},
character::complete::{alpha1, alphanumeric0, anychar, char, digit1, space0, space1},
combinator::recognize,
multi::{many0, many1},
sequence::{delimited, pair, preceded, tuple},
IResult,
};

enum CommandPart<'a> {
Space(&'a str),
Text(&'a str),
}

enum TextPart<'a> {
NormalText(&'a str),
PercentNumber(usize),
PercentStar,
}

#[derive(Debug, Copy, Clone)]
enum Quote {
DoubleQuote,
SingleQuote,
NoQuote,
}

pub fn expand_cmd<T>(cmd: &str, args: &[T]) -> Result<String>
mod cmdparse {
pub fn parse_cmd_to_args<T>(cmd: &str, args: &[T]) -> Vec<String>
where
T: AsRef<str>,
{
let parts = parse_cmd(cmd)?;
let mut expanded = String::new();
for part in parts {
match part {
CommandPart::Space(s) => expanded.push_str(s),
CommandPart::Text(text) => {
expanded.push_str(&expand_text(text, args)?);
let mut iter = cmd.chars().peekable();
let mut expanded_args = Vec::new();

while let Some(c) = iter.peek() {
if c.is_whitespace() {
while iter.peek().is_some_and(|_c| _c.is_whitespace()) {
iter.next();
}
} else if *c == '\'' {
iter.next();
let mut text = String::new();
loop {
if iter.peek().is_none() {
break;
}
if iter.peek().is_some_and(|_c| *_c == '\'') {
iter.next();
break;
}
get_next_char(&mut iter, &mut text, args);
}
expanded_args.push(text);
} else if *c == '"' {
iter.next();
let mut text = String::new();
loop {
if iter.peek().is_none() {
break;
}
if iter.peek().is_some_and(|_c| *_c == '"') {
iter.next();
break;
}
get_next_char(&mut iter, &mut text, args);
}
expanded_args.push(text);
} else {
if *c == '%' {
let mut tmp_iter = iter.clone();
tmp_iter.next();
if tmp_iter.peek().is_some_and(|_c| *_c == '*') {
iter.next();
iter.next();
for arg in args {
expanded_args.push(arg.as_ref().to_string())
}
continue;
}
}

let mut text = String::new();
loop {
if iter.peek().is_none() || iter.peek().is_some_and(|_c| _c.is_whitespace()) {
break;
}
get_next_char(&mut iter, &mut text, args);
}
expanded_args.push(text);
}
}
Ok(expanded)

expanded_args
}

fn expand_text<T>(text: &str, args: &[T]) -> Result<String>
where
fn get_next_char<T>(
iter: &mut std::iter::Peekable<std::str::Chars<'_>>,
text: &mut String,
args: &[T],
) where
T: AsRef<str>,
{
let quote = if text.starts_with("\"") {
Quote::DoubleQuote
} else if text.starts_with("'") {
Quote::SingleQuote
} else {
Quote::NoQuote
};

let parts = parse_text(text)?;
let mut expanded = String::new();
for part in parts {
match part {
TextPart::NormalText(s) => expanded.push_str(s),
TextPart::PercentNumber(i) => {
if i > 0 {
let replace_text = args
.get(i - 1)
.map(|content| preprocess(content.as_ref(), quote))
.unwrap_or_default();
expanded.push_str(&replace_text);
} else {
// Does not support %0, replace it with ""
}
let ch = iter.next().unwrap();
if ch == '\\' {
match iter.next() {
Some('n') => text.push('\n'),
Some('r') => text.push('\r'),
Some('t') => text.push('\t'),
Some(x) => text.push(x),
None => (),
}
} else if ch == '%' {
if iter.peek().is_some_and(|_c| *_c == '*') {
iter.next();
text.push_str(&args.iter().map(|value| value.as_ref()).collect::<Vec<&str>>().join(" "));
} else {
let mut num = String::new();
while iter.peek().is_some_and(|_c| _c.is_numeric()) {
num.push(iter.next().unwrap());
}
TextPart::PercentStar => {
for (i, arg) in args.iter().enumerate() {
expanded.push_str(&preprocess(arg.as_ref(), quote));
if i + 1 < args.len() {
expanded.push_str(" ");
}
if num.is_empty() {
text.push('%');
} else {
let i: usize = num.parse().unwrap();
if i > 0 {
text.push_str(args.get(i - 1).map(|value| value.as_ref()).unwrap_or_default());
}
}
}
} else {
text.push(ch);
}
Ok(expanded)
}

fn escaped_char(input: &str) -> IResult<&str, &str> {
recognize(pair(char('\\'), anychar))(input)
}

fn parse_cmd(cmd: &str) -> Result<Vec<CommandPart>> {
fn double_quote_text(input: &str) -> IResult<&str, &str> {
recognize(delimited(char('"'), many0(alt((is_not("\"\\"), escaped_char))), char('"')))(input)
}

fn single_quote_text(input: &str) -> IResult<&str, &str> {
recognize(delimited(char('\''), many0(alt((is_not("'"), escaped_char))), char('\'')))(input)
}

fn no_quote_text(input: &str) -> IResult<&str, &str> {
take_while1(|c: char| !c.is_whitespace())(input)
}
#[cfg(test)]
mod tests {
use super::*;

let (_, (leading_space, command_name, args, trailing_space)) = tuple((
space0,
alt((double_quote_text, single_quote_text, no_quote_text)),
many0(pair(space1, alt((double_quote_text, single_quote_text, no_quote_text)))),
space0,
))(cmd)
.map_err(|_| anyhow!("Cannot parse command `{cmd}`"))?;
let mut parts = Vec::new();
if !leading_space.is_empty() {
parts.push(CommandPart::Space(leading_space));
}
parts.push(CommandPart::Text(command_name));
for (space, arg) in args {
parts.push(CommandPart::Space(space));
parts.push(CommandPart::Text(arg));
}
if !trailing_space.is_empty() {
parts.push(CommandPart::Space(trailing_space));
}
Ok(parts)
}
#[test]
fn test_no_quote() {
let args = parse_cmd_to_args("echo abc xyz %1 %2", &["111", "222"]);
assert_eq!(args, vec!["echo", "abc", "xyz", "111", "222"]);

fn parse_text(text: &str) -> Result<Vec<TextPart>> {
fn variable_name(input: &str) -> IResult<&str, &str> {
recognize(pair(alt((alpha1, tag("_"))), alt((alphanumeric0, tag("_")))))(input)
let args = parse_cmd_to_args(" echo abc xyz %1 %2 ", &["111", "222"]);
assert_eq!(args, vec!["echo", "abc", "xyz", "111", "222"]);
}

fn variable_placeholder(input: &str) -> IResult<&str, TextPart> {
let (input, output) = recognize(tuple((char('%'), variable_name, char('%'))))(input)?;
Ok((input, TextPart::NormalText(output)))
}
#[test]
fn test_single_quote() {
let args = parse_cmd_to_args("echo 'abc xyz' '%1' %2", &["111", "222"]);
assert_eq!(args, vec!["echo", "abc xyz", "111", "222"]);

fn normal_text(input: &str) -> IResult<&str, TextPart> {
let (input, output) = recognize(many1(alt((escaped_char, is_not("\\%")))))(input)?;
Ok((input, TextPart::NormalText(output)))
let args = parse_cmd_to_args("echo 'abc \"\"xyz' '%1' %2", &["111", "222"]);
assert_eq!(args, vec!["echo", "abc \"\"xyz", "111", "222"]);
}

fn percent_star(input: &str) -> IResult<&str, TextPart> {
let (input, _) = tag("%*")(input)?;
Ok((input, TextPart::PercentStar))
#[test]
fn test_double_quote() {
let args = parse_cmd_to_args("echo \"abc ' 'xyz\" \"%1\" %2 %3", &["111", "222"]);
assert_eq!(args, vec!["echo", "abc ' 'xyz", "111", "222", ""]);
}

fn percent_number(input: &str) -> IResult<&str, TextPart> {
let (input, output) = preceded(char('%'), digit1)(input)?;
let num: usize = output.parse().unwrap();
Ok((input, TextPart::PercentNumber(num)))
#[test]
fn test_escaped() {
let args = parse_cmd_to_args("echo \"a\tbc ' 'x\nyz\" \"\\%1\" %2 %3", &["111", "22 2"]);
assert_eq!(args, vec!["echo", "a\tbc ' 'x\nyz", "%1", "22 2", ""]);
}

let (_, parts) =
many0(alt((normal_text, percent_star, percent_number, variable_placeholder)))(text)
.map_err(|_| anyhow!("Cannot parse text `{text}`"))?;
Ok(parts)
}

// Preprocess the content inside %x before replacing it in the command text
// to make sure white space and quote inside %x does not mess up the command.
fn preprocess(content: &str, quote: Quote) -> String {
let inner_space = content.chars().any(|c| c.is_whitespace());
match (quote, inner_space) {
(Quote::NoQuote, true) => format!("\"{}\"", content.replace("\"", "\\\"")),
(Quote::NoQuote, false) => content.to_string(),
(Quote::SingleQuote, _) => content.replace("'", "\\'").to_string(),
(Quote::DoubleQuote, _) => content.replace("\"", "\\\"").to_string(),
}
}
#[test]
fn test_percent_star() {
let args = parse_cmd_to_args("echo %* xyz", &["111", "222"]);
assert_eq!(args, vec!["echo", "111", "222", "xyz"]);

#[cfg(test)]
mod tests {
use super::*;
let args = parse_cmd_to_args("echo '%*' xyz", &["111", "222"]);
assert_eq!(args, vec!["echo", "111 222", "xyz"]);

#[test]
fn test_expand_arguments() {
assert_eq!(expand_cmd("echo %1", &["abc"]).unwrap(), "echo abc");
assert_eq!(expand_cmd("echo %2", &["abc", "def"]).unwrap(), "echo def");
assert_eq!(expand_cmd("echo %1", &["abc def"]).unwrap(), "echo \"abc def\"");
assert_eq!(expand_cmd("echo %1", &["\"abc\""]).unwrap(), "echo \"abc\"");
assert_eq!(
expand_cmd(r#"echo "hello %1""#, &[r#""world""#]).unwrap(),
r#"echo "hello \"world\"""#
);
assert_eq!(
expand_cmd(r#"echo "hello %1""#, &[r#""my king""#]).unwrap(),
r#"echo "hello \"my king\"""#
);
assert_eq!(
expand_cmd(r#"echo "hello %1""#, &["my king"]).unwrap(),
r#"echo "hello my king""#
);
assert_eq!(
expand_cmd(r#"echo %1"#, &["cmd /C \"run something\""]).unwrap(),
r#"echo "cmd /C \"run something\"""#
);
assert_eq!(expand_cmd("cmd %*", &["abc", "def ghk"]).unwrap(), r#"cmd abc "def ghk""#);
assert_eq!(expand_cmd("cmd a\\%*", &["abc", "def ghk"]).unwrap(), r#"cmd a\%*"#);
assert_eq!(
expand_cmd(r#"cmd "Hello \"world"#, &Vec::<String>::new()).unwrap(),
r#"cmd "Hello \"world"#
);
assert_eq!(expand_cmd(r#" a "b \"%1\"" "#, &["c", "d"]).unwrap(), r#" a "b \"c\"" "#);
let args = parse_cmd_to_args("echo -C%* xyz", &["111", "222"]);
assert_eq!(args, vec!["echo", "-C111 222", "xyz"]);
}
}
}

0 comments on commit 8d24382

Please sign in to comment.