Merge pull request microsoft#165632 from rwe/serialize-message-bash

shellIntegration-bash.sh: escape values in "E" (executed command) and "P" (property KV) codes

Author: Tyriar

src/vs/workbench/contrib/terminal/browser/media/shellIntegration-bash.sh

@@ -37,9 +37,47 @@ if [ -z "$VSCODE_SHELL_INTEGRATION" ]; then
 	builtin return
 fi
 
+# The property (P) and command (E) codes embed values which require escaping.
+# Backslashes are doubled. Non-alphanumeric characters are converted to escaped hex.
+__vsc_escape_value() {
+	# Process text byte by byte, not by codepoint.
+	builtin local LC_ALL=C str="${1}" i byte token out=''
+
+	for (( i=0; i < "${#str}"; ++i )); do
+		byte="${str:$i:1}"
+
+		# Backslashes must be doubled.
+		if [ "$byte" = "\\" ]; then
+			token="\\\\"
+		# Conservatively pass alphanumerics through.
+		elif [[ "$byte" == [0-9A-Za-z] ]]; then
+			token="$byte"
+		# Hex-encode anything else.
+		# (Importantly including: semicolon, newline, and control chars).
+		else
+			# The printf '0x%02X' "'$byte'" converts the character to a hex integer.
+			# See printf's specification:
+			# > If the leading character is a single-quote or double-quote, the value shall be the numeric value in the
+			# > underlying codeset of the character following the single-quote or double-quote.
+			# However, the result is a sign-extended int, so a high bit like 0xD7 becomes 0xFFF…FD7
+			# We mask that word with 0xFF to get lowest 8 bits, and then encode that byte as "\xD7" per our escaping scheme.
+			builtin printf -v token '\\x%02X' "$(( $(builtin printf '0x%X' "'$byte'") & 0xFF ))"
+			#             |________| ^^^ ^^^                        ^^^^^^  ^^^^^^^  |______|
+			#                   |     |  |                            |        |         |
+			# store in `token` -+     |  |   the hex value -----------+        |         |
+			# the '\x…'-prefixed -----+  |   of the byte as an integer --------+         |
+			# 0-padded, two hex digits --+   masked to one byte (due to sign extension) -+
+		fi
+
+		out+="$token"
+	done
+
+	builtin printf '%s\n' "${out}"
+}
+
 # Send the IsWindows property if the environment looks like Windows
 if [[ "$(uname -s)" =~ ^CYGWIN*|MINGW*|MSYS* ]]; then
-	builtin printf "\x1b]633;P;IsWindows=True\x07"
+	builtin printf '\e]633;P;IsWindows=True\a'
 fi
 
 # Allow verifying $BASH_COMMAND doesn't have aliases resolved via history when the right HISTCONTROL
@@ -59,35 +97,35 @@ __vsc_in_command_execution="1"
 __vsc_current_command=""
 
 __vsc_prompt_start() {
-	builtin printf "\033]633;A\007"
+	builtin printf '\e]633;A\a'
 }
 
 __vsc_prompt_end() {
-	builtin printf "\033]633;B\007"
+	builtin printf '\e]633;B\a'
 }
 
 __vsc_update_cwd() {
-	builtin printf "\033]633;P;Cwd=%s\007" "$PWD"
+	builtin printf '\e]633;P;Cwd=%s\a' "$(__vsc_escape_value "$PWD")"
 }
 
 __vsc_command_output_start() {
-	builtin printf "\033]633;C\007"
-	builtin printf "\033]633;E;%s\007" "$__vsc_current_command"
+	builtin printf '\e]633;C\a'
+	builtin printf '\e]633;E;%s\a' "$(__vsc_escape_value "${__vsc_current_command}")"
 }
 
 __vsc_continuation_start() {
-	builtin printf "\033]633;F\007"
+	builtin printf '\e]633;F\a'
 }
 
 __vsc_continuation_end() {
-	builtin printf "\033]633;G\007"
+	builtin printf '\e]633;G\a'
 }
 
 __vsc_command_complete() {
 	if [ "$__vsc_current_command" = "" ]; then
-		builtin printf "\033]633;D\007"
+		builtin printf '\e]633;D\a'
 	else
-		builtin printf "\033]633;D;%s\007" "$__vsc_status"
+		builtin printf '\e]633;D;%s\a' "$__vsc_status"
 	fi
 	__vsc_update_cwd
 }