Escape keys for files and folders

Author: nickrolfe

extractor/src/extractor.rs

@@ -190,6 +190,24 @@ pub fn extract(
     Ok(Program(visitor.trap_writer.trap_output))
 }
 
+/// Escapes a string for use in a TRAP key, by replacing special characters with
+/// HTML entities.
+fn escape_key(s: &str) -> String {
+    let mut escaped = String::new();
+    for c in s.chars() {
+        match c {
+            '&' => escaped.push_str("&"),
+            '{' => escaped.push_str("{"),
+            '}' => escaped.push_str("}"),
+            '"' => escaped.push_str("""),
+            '@' => escaped.push_str("@"),
+            '#' => escaped.push_str("#"),
+            _ => escaped.push(c),
+        }
+    }
+    escaped
+}
+
 /// Normalizes the path according the common CodeQL specification. Assumes that
 /// `path` has already been canonicalized using `std::fs::canonicalize`.
 fn normalize_path(path: &Path) -> String {
@@ -230,11 +248,11 @@ fn normalize_path(path: &Path) -> String {
 }
 
 fn full_id_for_file(path: &Path) -> String {
-    format!("{};sourcefile", normalize_path(path))
+    format!("{};sourcefile", escape_key(&normalize_path(path)))
 }
 
 fn full_id_for_folder(path: &Path) -> String {
-    format!("{};folder", normalize_path(path))
+    format!("{};folder", escape_key(&normalize_path(path)))
 }
 
 struct ChildNode {
@@ -731,3 +749,16 @@ fn limit_string_test() {
     assert_eq!("hi ☹", limit_string(&"hi ☹☹".to_owned(), 6));
     assert_eq!("hi ", limit_string(&"hi ☹☹".to_owned(), 5));
 }
+
+#[test]
+fn escape_key_test() {
+    assert_eq!("foo!", escape_key("foo!"));
+    assert_eq!("foo{}", escape_key("foo{}"));
+    assert_eq!("{}", escape_key("{}"));
+    assert_eq!("", escape_key(""));
+    assert_eq!("/path/to/foo.rb", escape_key("/path/to/foo.rb"));
+    assert_eq!(
+        "/path/to/foo&{}"@#.rb",
+        escape_key("/path/to/foo&{}\"@#.rb")
+    );
+}