use std::fmt;
use std::path::{Path, PathBuf};
use std::process::{Command, Stdio};
#[doc(hidden)]
pub enum CommandArg {
Empty,
Literal(String),
Raw(String),
List(Vec<String>),
}
fn shell_quote(value: &str) -> String {
shlex::quote(value).to_string()
}
fn bash_binary_quote(value: &[u8]) -> String {
let value = value
.iter()
.flat_map(|&c| std::ascii::escape_default(c))
.flat_map(|c| char::from_u32(c as u32));
"$'".chars().chain(value).chain("'".chars()).collect()
}
impl fmt::Display for CommandArg {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
use self::CommandArg::*;
match *self {
Empty => write!(f, ""),
Literal(ref value) => write!(f, "{}", shell_quote(value)),
Raw(ref value) => write!(f, "{}", value),
List(ref list) => write!(
f,
"{}",
list.iter()
.map(|x| shell_quote(x))
.collect::<Vec<_>>()
.join(" ")
),
}
}
}
impl<'a, 'b> From<&'a &'b str> for CommandArg {
fn from(value: &&str) -> Self {
CommandArg::Literal(value.to_string())
}
}
impl From<String> for CommandArg {
fn from(value: String) -> Self {
CommandArg::Literal(value)
}
}
impl<'a> From<&'a String> for CommandArg {
fn from(value: &String) -> Self {
CommandArg::Literal(value.to_string())
}
}
impl<'a> From<&'a str> for CommandArg {
fn from(value: &str) -> Self {
CommandArg::Literal(value.to_string())
}
}
impl<'a> From<&'a Path> for CommandArg {
fn from(value: &Path) -> Self {
use std::os::unix::ffi::OsStrExt;
if let Some(s) = value.to_str() {
CommandArg::Literal(s.to_string())
} else {
CommandArg::Raw(bash_binary_quote(value.as_os_str().as_bytes()))
}
}
}
impl<'a> From<&'a PathBuf> for CommandArg {
fn from(value: &PathBuf) -> Self {
value.as_path().into()
}
}
impl<'a, 'b> From<&'a &'b Path> for CommandArg {
fn from(value: &&Path) -> Self {
CommandArg::from(*value)
}
}
impl<'a> From<&'a u64> for CommandArg {
fn from(value: &u64) -> Self {
CommandArg::Literal(value.to_string())
}
}
impl<'a> From<&'a f64> for CommandArg {
fn from(value: &f64) -> Self {
CommandArg::Literal(value.to_string())
}
}
impl<'a> From<&'a i32> for CommandArg {
fn from(value: &i32) -> Self {
CommandArg::Literal(value.to_string())
}
}
impl<'a> From<&'a i64> for CommandArg {
fn from(value: &i64) -> Self {
CommandArg::Literal(value.to_string())
}
}
impl<'a, T> From<&'a [T]> for CommandArg
where
T: fmt::Display,
{
fn from(list: &[T]) -> Self {
CommandArg::List(list.iter().map(|x| format!("{}", x)).collect())
}
}
impl<'a, T> From<&'a Vec<T>> for CommandArg
where
T: fmt::Display,
{
fn from(list: &Vec<T>) -> Self {
CommandArg::from(list.as_slice())
}
}
impl<'a, T> From<&'a Option<T>> for CommandArg
where
T: fmt::Display,
{
fn from(opt: &Option<T>) -> Self {
if let Some(ref value) = *opt {
CommandArg::Literal(format!("{}", value))
} else {
CommandArg::Empty
}
}
}
fn impl_render(script: &str, args: String) -> Result<Command, std::io::Error> {
use std::io::Seek;
use std::io::SeekFrom;
use std::io::Write;
let mut c = Command::new("bash");
let mut tmpf = tempfile::tempfile()?;
tmpf.write_all(args.as_bytes())?;
tmpf.write_all(script.as_bytes())?;
tmpf.seek(SeekFrom::Start(0))?;
c.stdin(Stdio::from(tmpf));
Ok(c)
}
#[doc(hidden)]
pub fn render<S: AsRef<str>>(script: S, args: String) -> Result<Command, std::io::Error> {
impl_render(script.as_ref(), args)
}
pub fn execute(mut cmd: Command) -> Result<(), std::io::Error> {
let r = cmd.status()?;
if !r.success() {
return Err(std::io::Error::new(
std::io::ErrorKind::Other,
format!("bash script failed: {}", r),
));
}
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn quote() {
let strs = [("$''", ""), ("$'foo bar'", "foo bar"), (r"$'\\n'", r"\n")];
for (k, v) in strs.iter() {
assert_eq!(*k, bash_binary_quote(v.as_bytes()));
}
let bins = [(r"$'foo\x07bar'", b"foo\x07bar")];
for (k, v) in bins.iter() {
assert_eq!(*k, bash_binary_quote(*v));
}
}
}