uid: escape paths

Author: rsteube

action.go

@@ -485,8 +485,8 @@ func (a Action) Uid(scheme, host string, opts ...string) Action {
 		for index, v := range invoked.action.rawValues {
 			uid := url.URL{
 				Scheme: scheme,
-				Host:   host,
-				Path:   v.Value,
+				Host:   url.PathEscape(host),
+				Path:   uid.PathEscape(v.Value),
 			}
 			if len(opts) > 0 {
 				values := uid.Query()

defaultActions.go

@@ -143,7 +143,7 @@ func ActionDirectories() Action {
 				if err != nil {
 					return nil, err
 				}
-				return url.Parse("file://" + abs)
+				return url.Parse("file://" + uid.PathEscape(abs))
 			})
 	}).Tag("directories")
 }
@@ -159,7 +159,7 @@ func ActionFiles(suffix ...string) Action {
 				if err != nil {
 					return nil, err
 				}
-				return url.Parse("file://" + abs)
+				return url.Parse("file://" + uid.PathEscape(abs))
 			})
 	}).Tag("files")
 }
@@ -458,7 +458,7 @@ func ActionExecutables(dirs ...string) Action {
 		}
 		return batch.ToA().
 			UidF(func(s string, uc uid.Context) (*url.URL, error) {
-				return &url.URL{Scheme: "cmd", Host: s}, nil
+				return &url.URL{Scheme: "cmd", Host: uid.PathEscape(s)}, nil
 			})
 	}).Tag("executables")
 }
@@ -480,7 +480,7 @@ func actionDirectoryExecutables(dir string, prefix string, manDescriptions map[s
 				}
 			}
 			return ActionStyledValuesDescribed(vals...).UidF(func(s string, uc uid.Context) (*url.URL, error) {
-				return url.Parse(fmt.Sprintf("file://%v/%v", dir, s)) // TODO trim slash suffix from dir | backslash path possible? (windows)
+				return url.Parse(fmt.Sprintf("file://%v/%v", uid.PathEscape(dir), uid.PathEscape(s))) // TODO trim slash suffix from dir | backslash path possible? (windows)
 			})
 		}
 		return ActionValues()
@@ -555,9 +555,9 @@ func ActionCommands(cmd *cobra.Command) Action {
 
 			switch uid.Path {
 			case "":
-				uid.Path = s
+				uid.Path = url.PathEscape(s)
 			default:
-				uid.Path = uid.Path + "/" + s
+				uid.Path = uid.Path + "/" + url.PathEscape(s)
 			}
 			return uid, nil
 		})

docs/book.toml

@@ -19,4 +19,4 @@ enable = true
 
 [output.linkcheck]
 follow-web-links = true
-exclude = [ 'gnu\.org', '\./.+/out/.+\.gif']
+exclude = [ 'gnu\.org', '\./.+/out/.+\.gif', 'go\.dev', 'microsoft\.com']

example/cmd/_test_files/files_linux.go

@@ -22,6 +22,8 @@ package testfiles
 //go:generate touch -- quote_double_".txt
 //go:generate touch -- quote_both_'".txt
 //go:generate touch -- hash_#.txt
+//go:generate touch -- percent_d_%d.txt
+//go:generate touch -- percent_2f_%2F.txt
 //go:generate touch -- pipe_|.txt
 //go:generate touch -- question_?.txt
 //go:generate touch -- round-bracket_left_(.txt

example/cmd/_test_files/go.mod

@@ -1,3 +1,5 @@
 module github.com/carapace-sh/carapace/example/_test_files
 
+go 1.16
+
 // fix go mod invalid char error: https://github.com/golang/go/issues/26672

pkg/uid/path.go

@@ -0,0 +1,15 @@
+package uid
+
+import (
+	"net/url"
+	"strings"
+)
+
+// PathEscape is like url.PathEscape but keeps '/'.
+func PathEscape(s string) string {
+	segments := strings.Split(s, "/")
+	for index, segment := range segments {
+		segments[index] = url.PathEscape(segment)
+	}
+	return strings.Join(segments, "/")
+}

pkg/uid/uid.go

@@ -21,7 +21,7 @@ type Context interface {
 func Command(cmd *cobra.Command) *url.URL {
 	path := []string{cmd.Name()}
 	for parent := cmd.Parent(); parent != nil; parent = parent.Parent() {
-		path = append(path, parent.Name())
+		path = append(path, url.PathEscape(parent.Name()))
 	}
 	reverse(path) // TODO slices.Reverse
 	return &url.URL{