From 12c7877932d8ca03eb854ac17e0e9aeeea896e55 Mon Sep 17 00:00:00 2001 From: jRimbault Date: Fri, 21 Aug 2020 18:41:36 +0200 Subject: [PATCH] fix: $EDITOR argument parsing (#1595) Fixed editor argument parsing by properly splitting whitespace with the same procedure used by shell. --- Cargo.lock | 7 +++++++ Cargo.toml | 1 + src/configure.rs | 54 ++++++++++++++++++++++-------------------------- 3 files changed, 33 insertions(+), 29 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 664d4caf..35d81489 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1187,6 +1187,12 @@ dependencies = [ "opaque-debug", ] +[[package]] +name = "shell-words" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6fa3938c99da4914afedd13bf3d79bcb6c277d1b2c398d23257a304d9e1b074" + [[package]] name = "starship" version = "0.44.0" @@ -1215,6 +1221,7 @@ dependencies = [ "rayon", "regex", "serde_json", + "shell-words", "starship_module_config_derive", "sysinfo", "tempfile", diff --git a/Cargo.toml b/Cargo.toml index 962a12df..09fd96f1 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -63,6 +63,7 @@ notify-rust = { version = "4.0.0", optional = true } # Optional/http: attohttpc = { version = "0.15.0", optional = true, default-features = false, features = ["tls", "form"] } native-tls = { version = "0.2", optional = true } +shell-words = "1.0.0" [target.'cfg(windows)'.dependencies] winapi = { version = "0.3", features = [ diff --git a/src/configure.rs b/src/configure.rs index 0c9cc184..efd9007d 100644 --- a/src/configure.rs +++ b/src/configure.rs @@ -10,7 +10,10 @@ use std::io::Write; use toml::map::Map; use toml::Value; +#[cfg(not(windows))] const STD_EDITOR: &str = "vi"; +#[cfg(windows)] +const STD_EDITOR: &str = "notepad.exe"; pub fn update_configuration(name: &str, value: &str) { let config_path = get_config_path(); @@ -61,17 +64,12 @@ pub fn update_configuration(name: &str, value: &str) { pub fn edit_configuration() { let config_path = get_config_path(); - let editor_cmd = get_editor(); + let editor_cmd = shell_words::split(&get_editor()).expect("Unmatched quotes found in $EDITOR."); - let mut cmd_iter = editor_cmd - .to_str() - .expect("environment variable contains invalid unicode") - .split_whitespace(); - - let editor = cmd_iter.next().unwrap_or(STD_EDITOR); - let args: Vec<_> = cmd_iter.collect(); - - let command = Command::new(editor).args(args).arg(config_path).status(); + let command = Command::new(&editor_cmd[0]) + .args(&editor_cmd[1..]) + .arg(config_path) + .status(); match command { Ok(_) => (), @@ -80,7 +78,7 @@ pub fn edit_configuration() { eprintln!( "Error: editor {:?} was not found. Did you set your $EDITOR or $VISUAL \ environment variables correctly?", - editor + editor_cmd ); eprintln!("Full error: {:?}", error); std::process::exit(1) @@ -90,16 +88,16 @@ pub fn edit_configuration() { }; } -fn get_editor() -> OsString { - get_editor_internal(env::var_os("VISUAL"), env::var_os("EDITOR")) +fn get_editor() -> String { + get_editor_internal(env::var("VISUAL").ok(), env::var("EDITOR").ok()) } -fn get_editor_internal(visual: Option, editor: Option) -> OsString { - let mut editor_name = visual.unwrap_or_else(|| "".into()); +fn get_editor_internal(visual: Option, editor: Option) -> String { + let editor_name = visual.unwrap_or_else(|| "".into()); if !editor_name.is_empty() { return editor_name; } - editor_name = editor.unwrap_or_else(|| "".into()); + let editor_name = editor.unwrap_or_else(|| "".into()); if !editor_name.is_empty() { return editor_name; } @@ -107,16 +105,14 @@ fn get_editor_internal(visual: Option, editor: Option) -> Os } fn get_config_path() -> OsString { - let config_path = env::var_os("STARSHIP_CONFIG").unwrap_or_else(|| "".into()); - if config_path.is_empty() { - dirs_next::home_dir() - .expect("couldn't find home directory") - .join(".config/starship.toml") - .as_os_str() - .to_owned() - } else { - config_path + if let Some(config_path) = env::var_os("STARSHIP_CONFIG") { + return config_path; } + dirs_next::home_dir() + .expect("couldn't find home directory") + .join(".config") + .join("starship.toml") + .into() } #[cfg(test)] @@ -149,12 +145,12 @@ mod tests { #[test] fn visual_empty_editor_empty() { let actual = get_editor_internal(Some("".into()), Some("".into())); - assert_eq!("vi", actual); + assert_eq!(STD_EDITOR, actual); } #[test] fn visual_empty_editor_not_set() { let actual = get_editor_internal(Some("".into()), None); - assert_eq!("vi", actual); + assert_eq!(STD_EDITOR, actual); } #[test] @@ -165,11 +161,11 @@ mod tests { #[test] fn visual_not_set_editor_empty() { let actual = get_editor_internal(None, Some("".into())); - assert_eq!("vi", actual); + assert_eq!(STD_EDITOR, actual); } #[test] fn visual_not_set_editor_not_set() { let actual = get_editor_internal(None, None); - assert_eq!("vi", actual); + assert_eq!(STD_EDITOR, actual); } }