Escape single quotes while translating dropped Win32 paths (#18007)

a4lg · DHowett · commit f9e962c29804 · 2025-02-03T13:08:47.000-06:00
When file/folder is dropped to the terminal, its path is translated and quoted with a pair of single quotes if necessary. However, the terminal control does not escape single quotes (allowed in the Win32 subsystem) that need escapes when translated. On the translation styles other than `"none"` (note: all other translation styles are currently intended for the POSIX shell), it causes incorrect path to be pasted when the path contains one or more single quotes (see #18006 for an example). With this commit, the terminal control escapes a single quote with a valid escape sequence `'\''` (finish quote, print a single quote then begin quote again) when the path translation is required. * Changed escape sequence from `'"'"'` to much shorter `'\''`. * Reflected comments by the reviewer. * Overhaul after addition of multiple path translation styles (not just WSL but Cygwin and MSYS). * More clarification both in the code and in the commit message. * Minor clarification both in the code and in the commit message. * #18006 * #16214 * #18195 This is a follow-up of #16214 and #18195, fixing #18006. Closes #18006 Supersedes 7878728 (cherry picked from commit ae90d52) Service-Card-Id: PVTI_lADOAF3p4s4AmhmQzgVEvdU Service-Version: 1.22
diff --git a/src/cascadia/TerminalControl/TermControl.cpp b/src/cascadia/TerminalControl/TermControl.cpp
@@ -66,6 +66,8 @@ namespace winrt::Microsoft::Terminal::Control::implementation
             /* Cygwin */ L"/cygdrive/",
             /* MSYS2 */ L"/",
         };
+        static constexpr wil::zwstring_view sSingleQuoteEscape = L"'\\''";
+        static constexpr auto cchSingleQuoteEscape = sSingleQuoteEscape.size();
 
         if (translationStyle == PathTranslationStyle::None)
         {
@@ -75,6 +77,16 @@ namespace winrt::Microsoft::Terminal::Control::implementation
         // All of the other path translation modes current result in /-delimited paths
         std::replace(fullPath.begin(), fullPath.end(), L'\\', L'/');
 
+        // Escape single quotes, assuming translated paths are always quoted by a pair of single quotes.
+        size_t pos = 0;
+        while ((pos = fullPath.find(L'\'', pos)) != std::wstring::npos)
+        {
+            // ' -> '\'' (for POSIX shell)
+            fullPath.replace(pos, 1, sSingleQuoteEscape);
+            // Arithmetic overflow cannot occur here.
+            pos += cchSingleQuoteEscape;
+        }
+
         if (fullPath.size() >= 2 && fullPath.at(1) == L':')
         {
             // C:/foo/bar -> Cc/foo/bar
