ls: encode path when using --hyperlink

cakebaker · cakebaker · commit a589406f63fc · 2023-12-10T13:12:20.000+01:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/src/uu/ls/Cargo.toml b/src/uu/ls/Cargo.toml
@@ -32,6 +32,7 @@ uucore = { workspace = true, features = [
 once_cell = { workspace = true }
 selinux = { workspace = true, optional = true }
 hostname = { workspace = true }
+regex = { workspace = true }
 
 [[bin]]
 name = "ls"
diff --git a/src/uu/ls/src/ls.rs b/src/uu/ls/src/ls.rs
@@ -13,6 +13,7 @@ use glob::{MatchOptions, Pattern};
 use lscolors::{LsColors, Style};
 
 use number_prefix::NumberPrefix;
+use regex::{Captures, Regex};
 use std::{cell::OnceCell, num::IntErrorKind};
 use std::{collections::HashSet, io::IsTerminal};
 
@@ -3017,9 +3018,20 @@ fn display_file_name(
         let absolute_path = fs::canonicalize(&path.p_buf).unwrap_or_default();
         let absolute_path = absolute_path.to_string_lossy();
 
-        // TODO encode path
+        let re = Regex::new(r"[^A-Za-z0-9_\-\.:/]").unwrap();
+        // percentage encoding of path
+        let absolute_path = re.replace_all(&absolute_path, |caps: &Captures| -> String {
+            format!("%{:02x}", caps[0].as_bytes().first().unwrap())
+        });
+
+        let filename = if std::io::stdout().is_terminal() {
+            name
+        } else {
+            name.trim_matches('\'').to_string()
+        };
+
         // \x1b = ESC, \x07 = BEL
-        name = format!("\x1b]8;;file://{hostname}{absolute_path}\x07{name}\x1b]8;;\x07");
+        name = format!("\x1b]8;;file://{hostname}{absolute_path}\x07{filename}\x1b]8;;\x07");
     }
 
     if let Some(ls_colors) = &config.color {
diff --git a/tests/by-util/test_ls.rs b/tests/by-util/test_ls.rs
@@ -3890,6 +3890,38 @@ fn test_ls_hyperlink() {
         .stdout_is(format!("{file}\n"));
 }
 
+// spell-checker: disable
+#[test]
+fn test_ls_hyperlink_encode_link() {
+    let (at, mut ucmd) = at_and_ucmd!();
+
+    #[cfg(not(target_os = "windows"))]
+    {
+        at.touch("back\\slash");
+        at.touch("ques?tion");
+    }
+    at.touch("encoded%3Fquestion");
+    at.touch("sp ace");
+
+    let result = ucmd.arg("--hyperlink").succeeds();
+    #[cfg(not(target_os = "windows"))]
+    {
+        assert!(result
+            .stdout_str()
+            .contains("back%5cslash\x07back\\slash\x1b]8;;\x07"));
+        assert!(result
+            .stdout_str()
+            .contains("ques%3ftion\x07ques?tion\x1b]8;;\x07"));
+    }
+    assert!(result
+        .stdout_str()
+        .contains("encoded%253Fquestion\x07encoded%3Fquestion\x1b]8;;\x07"));
+    assert!(result
+        .stdout_str()
+        .contains("sp%20ace\x07sp ace\x1b]8;;\x07"));
+}
+// spell-checker: enable
+
 #[test]
 fn test_ls_color_do_not_reset() {
     let scene: TestScenario = TestScenario::new(util_name!());
