Add q: format prefix to escape sh(1) special characters. Suggested by

someone ages ago and then more recently in GitHub issue 1449.

1 files changed, 29 insertions, 0 deletions

diff --git a/format.c b/format.c
index 4244ff0c..54e33c7a 100644
--- a/format.c
+++ b/format.c
@@ -94,6 +94,7 @@ format_job_cmp(struct format_job *fj1, struct format_job *fj2)
 #define FORMAT_BASENAME 0x2
 #define FORMAT_DIRNAME 0x4
 #define FORMAT_SUBSTITUTE 0x8
+#define FORMAT_QUOTE 0x10
 
 /* Entry in format tree. */
 struct format_entry {
@@ -754,6 +755,23 @@ format_add_cb(struct format_tree *ft, const char *key, format_cb cb)
 	fe->value = NULL;
 }
 
+/* Quote special characters in string. */
+static char *
+format_quote(const char *s)
+{
+	const char	*cp;
+	char		*out, *at;
+
+	at = out = xmalloc(strlen(s) * 2 + 1);
+	for (cp = s; *cp != '\0'; cp++) {
+		if (strchr("|&;<>()$`\\\"'*?[# =%", *cp) != NULL)
+			*at++ = '\\';
+		*at++ = *cp;
+	}
+	*at = '\0';
+	return (out);
+}
+
 /* Find a format entry. */
 static char *
 format_find(struct format_tree *ft, const char *key, int modifiers)
@@ -836,6 +854,11 @@ found:
 		copy = xstrdup(dirname(saved));
 		free(saved);
 	}
+	if (modifiers & FORMAT_QUOTE) {
+		saved = copy;
+		copy = xstrdup(format_quote(saved));
+		free(saved);
+	}
 	return (copy);
 }
 
@@ -976,6 +999,12 @@ format_replace(struct format_tree *ft, const char *key, size_t keylen,
 		modifiers |= FORMAT_TIMESTRING;
 		copy += 2;
 		break;
+	case 'q':
+		if (copy[1] != ':')
+			break;
+		modifiers |= FORMAT_QUOTE;
+		copy += 2;
+		break;
 	case 's':
 		sep = copy[1];
 		if (sep == ':' || !ispunct((u_char)sep))