Skip to content

Implement UNC path mangling for OSC 7 via WSL #20094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lhecker wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Implement UNC path mangling for OSC 7 via WSL #20094

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
99c748c
Implement UNC path mangling for OSC 7 via WSL
lhecker Apr 8, 2026
05282a3
Begone
lhecker Apr 8, 2026
9748965
Add a test for the OSC 7 style mangling, fix wsl
DHowett Apr 14, 2026
a240d3e
turn the big mangling test into a table
DHowett Apr 14, 2026
71db278
Merge remote-tracking branch 'origin/main' into dev/lhecker/osc-7-wsl
lhecker Apr 17, 2026
d7250ac
Avoid IsValidDirectory for WSL mangling
lhecker Apr 17, 2026
e3deb12
AuditMode fixes
lhecker Apr 17, 2026
d22203f
Missed one
lhecker Apr 17, 2026
4b9df53
Merge remote-tracking branch 'origin/main' into dev/lhecker/osc-7-wsl
lhecker Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/cascadia/TerminalApp/TerminalPage.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1600,7 +1600,7 @@ namespace winrt::TerminalApp::implementation

// Replace the Starting directory with the CWD, if given
const auto workingDirectory = control.WorkingDirectory();
if (Utils::IsValidDirectory(workingDirectory.c_str()))
if (!workingDirectory.empty())
{
controlSettings.DefaultSettings()->StartingDirectory(workingDirectory);
}
Expand Down Expand Up @@ -3607,7 +3607,7 @@ namespace winrt::TerminalApp::implementation
profile = GetClosestProfileForDuplicationOfProfile(profile);
controlSettings = Settings::TerminalSettings::CreateWithProfile(_settings, profile);
const auto workingDirectory = tabImpl->GetActiveTerminalControl().WorkingDirectory();
if (Utils::IsValidDirectory(workingDirectory.c_str()))
if (!workingDirectory.empty())
{
controlSettings.DefaultSettings()->StartingDirectory(workingDirectory);
}
Expand Down
2 changes: 1 addition & 1 deletion src/cascadia/TerminalApp/TerminalPaneContent.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ namespace winrt::TerminalApp::implementation

args.Profile(::Microsoft::Console::Utils::GuidToString(_profile.Guid()));
// If we know the user's working directory use it instead of the profile.
if (const auto dir = _control.WorkingDirectory(); ::Microsoft::Console::Utils::IsValidDirectory(dir.c_str()))
if (const auto dir = _control.WorkingDirectory(); !dir.empty())
{
args.StartingDirectory(dir);
}
Expand Down
6 changes: 4 additions & 2 deletions src/cascadia/TerminalControl/ControlCore.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1693,8 +1693,10 @@ namespace winrt::Microsoft::Terminal::Control::implementation

void ControlCore::OpenCWD()
{
const auto workingDirectory = WorkingDirectory();
ShellExecute(nullptr, nullptr, L"explorer", workingDirectory.c_str(), nullptr, SW_SHOW);
if (const auto cwd = WorkingDirectory(); Utils::IsValidDirectory(cwd.c_str()))
{
ShellExecute(nullptr, nullptr, L"explorer", cwd.c_str(), nullptr, SW_SHOW);
}
}

void ControlCore::ClearQuickFix()
Expand Down
8 changes: 7 additions & 1 deletion src/cascadia/TerminalSettingsModel/ActionMap.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
#include "AllShortcutActions.h"
#include "ActionMap.h"
#include "Command.h"

#include <til/io.h>

#include "ActionMap.g.cpp"
Expand Down Expand Up @@ -1289,7 +1290,12 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
winrt::hstring currentWorkingDirectory)
{
// enumerate all the parent directories we want to import snippets from
std::filesystem::path directory{ std::wstring_view{ currentWorkingDirectory } };
std::filesystem::path directory;
if (::Microsoft::Console::Utils::IsValidDirectory(currentWorkingDirectory.c_str()))
{
directory.assign(std::wstring_view{ currentWorkingDirectory });
}
Comment thread
DHowett marked this conversation as resolved.

std::vector<std::filesystem::path> directories;
while (!directory.empty())
{
Expand Down
208 changes: 60 additions & 148 deletions src/types/ut_types/UtilsTests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,165 +356,77 @@ void UtilsTests::TestMangleWSLPaths()
{
// Continue on failures
const WEX::TestExecution::DisableVerifyExceptions disableExceptionsScope;
const SetVerifyOutput verifySettings{ VerifyOutputSettings::LogOnlyFailures };

const auto startingDirectory{ L"SENTINEL" };
// MUST MANGLE
{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(wsl)", startingDirectory);
VERIFY_ARE_EQUAL(LR"("wsl" --cd "SENTINEL" )", commandline);
VERIFY_ARE_EQUAL(L"", path);
}

{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(wsl -d X)", startingDirectory);
VERIFY_ARE_EQUAL(LR"("wsl" --cd "SENTINEL" -d X)", commandline);
VERIFY_ARE_EQUAL(L"", path);
}

{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(wsl -d X ~/bin/sh)", startingDirectory);
VERIFY_ARE_EQUAL(LR"("wsl" --cd "SENTINEL" -d X ~/bin/sh)", commandline);
VERIFY_ARE_EQUAL(L"", path);
}

{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(wsl.exe)", startingDirectory);
VERIFY_ARE_EQUAL(LR"("wsl.exe" --cd "SENTINEL" )", commandline);
VERIFY_ARE_EQUAL(L"", path);
}

{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(wsl.exe -d X)", startingDirectory);
VERIFY_ARE_EQUAL(LR"("wsl.exe" --cd "SENTINEL" -d X)", commandline);
VERIFY_ARE_EQUAL(L"", path);
}

{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(wsl.exe -d X ~/bin/sh)", startingDirectory);
VERIFY_ARE_EQUAL(LR"("wsl.exe" --cd "SENTINEL" -d X ~/bin/sh)", commandline);
VERIFY_ARE_EQUAL(L"", path);
}

{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"("wsl")", startingDirectory);
VERIFY_ARE_EQUAL(LR"("wsl" --cd "SENTINEL" )", commandline);
VERIFY_ARE_EQUAL(L"", path);
}

{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"("wsl.exe")", startingDirectory);
VERIFY_ARE_EQUAL(LR"("wsl.exe" --cd "SENTINEL" )", commandline);
VERIFY_ARE_EQUAL(L"", path);
}

{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"("wsl" -d X)", startingDirectory);
VERIFY_ARE_EQUAL(LR"("wsl" --cd "SENTINEL" -d X)", commandline);
VERIFY_ARE_EQUAL(L"", path);
}

{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"("wsl.exe" -d X)", startingDirectory);
VERIFY_ARE_EQUAL(LR"("wsl.exe" --cd "SENTINEL" -d X)", commandline);
VERIFY_ARE_EQUAL(L"", path);
}

{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"("C:\Windows\system32\wsl.exe" -d X)", startingDirectory);
VERIFY_ARE_EQUAL(LR"("C:\Windows\system32\wsl.exe" --cd "SENTINEL" -d X)", commandline);
VERIFY_ARE_EQUAL(L"", path);
}

{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"("C:\windows\system32\wsl" -d X)", startingDirectory);
VERIFY_ARE_EQUAL(LR"("C:\windows\system32\wsl" --cd "SENTINEL" -d X)", commandline);
VERIFY_ARE_EQUAL(L"", path);
}

{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(wsl ~/bin)", startingDirectory);
VERIFY_ARE_EQUAL(LR"("wsl" --cd "SENTINEL" ~/bin)", commandline);
VERIFY_ARE_EQUAL(L"", path);
}
wchar_t computerName[64];
DWORD computerNameLen = ARRAYSIZE(computerName);
THROW_IF_WIN32_BOOL_FALSE(GetComputerNameExW(ComputerNamePhysicalDnsHostname, computerName, &computerNameLen));

// MUST NOT MANGLE
{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"("C:\wsl.exe" -d X)", startingDirectory);
VERIFY_ARE_EQUAL(LR"("C:\wsl.exe" -d X)", commandline);
VERIFY_ARE_EQUAL(startingDirectory, path);
}

{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(C:\wsl.exe)", startingDirectory);
VERIFY_ARE_EQUAL(LR"(C:\wsl.exe)", commandline);
VERIFY_ARE_EQUAL(startingDirectory, path);
}

{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(wsl --cd C:\)", startingDirectory);
VERIFY_ARE_EQUAL(LR"(wsl --cd C:\)", commandline);
VERIFY_ARE_EQUAL(startingDirectory, path);
}

{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(wsl ~)", startingDirectory);
VERIFY_ARE_EQUAL(LR"(wsl ~)", commandline);
VERIFY_ARE_EQUAL(startingDirectory, path);
}
const auto startingDirectory{ L"SENTINEL" };
const auto expectedUserProfilePath = wil::GetEnvironmentVariableW<std::wstring>(L"USERPROFILE");
const auto osc7 = fmt::format(FMT_COMPILE(LR"(\\{}\home\user)"), &computerName[0]);

struct Test
{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(wsl ~ -d Ubuntu)", startingDirectory);
VERIFY_ARE_EQUAL(LR"(wsl ~ -d Ubuntu)", commandline);
VERIFY_ARE_EQUAL(startingDirectory, path);
}
std::wstring_view commandline;
std::wstring_view startingDirectory;
std::wstring_view expectedCommandline;
std::wstring_view expectedPath;
} testCases[] = {
// clang-format off
// command line plus starting directory should become new command line and new starting directory
// MUST MANGLE
{ LR"(wsl)", startingDirectory, LR"("wsl" --cd "SENTINEL" )", L"" },
{ LR"(wsl -d X)", startingDirectory, LR"("wsl" --cd "SENTINEL" -d X)", L"" },
{ LR"(wsl -d X ~/bin/sh)", startingDirectory, LR"("wsl" --cd "SENTINEL" -d X ~/bin/sh)", L"" },
{ LR"(wsl.exe)", startingDirectory, LR"("wsl.exe" --cd "SENTINEL" )", L"" },
{ LR"(wsl.exe -d X)", startingDirectory, LR"("wsl.exe" --cd "SENTINEL" -d X)", L"" },
{ LR"(wsl.exe -d X ~/bin/sh)", startingDirectory, LR"("wsl.exe" --cd "SENTINEL" -d X ~/bin/sh)", L"" },
{ LR"("wsl")", startingDirectory, LR"("wsl" --cd "SENTINEL" )", L"" },
{ LR"("wsl.exe")", startingDirectory, LR"("wsl.exe" --cd "SENTINEL" )", L"" },
{ LR"("wsl" -d X)", startingDirectory, LR"("wsl" --cd "SENTINEL" -d X)", L"" },
{ LR"("wsl.exe" -d X)", startingDirectory, LR"("wsl.exe" --cd "SENTINEL" -d X)", L"" },
{ LR"("C:\Windows\system32\wsl.exe" -d X)", startingDirectory, LR"("C:\Windows\system32\wsl.exe" --cd "SENTINEL" -d X)", L"" },
{ LR"("C:\windows\system32\wsl" -d X)", startingDirectory, LR"("C:\windows\system32\wsl" --cd "SENTINEL" -d X)", L"" },
{ LR"(wsl ~/bin)", startingDirectory, LR"("wsl" --cd "SENTINEL" ~/bin)", L"" },

// Any wsl.exe is treated as a WSL profile, regardless of directory.
{ LR"("C:\wsl.exe" -d X)", startingDirectory, LR"("C:\wsl.exe" --cd "SENTINEL" -d X)", L"" },
{ LR"(C:\wsl.exe)", startingDirectory, LR"("C:\wsl.exe" --cd "SENTINEL" )", L"" },

// MUST NOT MANGLE
{ LR"(wsl --cd C:\)", startingDirectory, LR"(wsl --cd C:\)", startingDirectory },
{ LR"(wsl ~)", startingDirectory, LR"(wsl ~)", startingDirectory },
{ LR"(wsl ~ -d Ubuntu)", startingDirectory, LR"(wsl ~ -d Ubuntu)", startingDirectory },

{
// Test for GH#11994 - make sure `//wsl$/` paths get mangled back to
// `\\wsl$\`, to workaround a potential bug in `wsl --cd`
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(wsl -d Ubuntu)", LR"(//wsl$/Ubuntu/home/user)");
VERIFY_ARE_EQUAL(LR"("wsl" --cd "\\wsl$\Ubuntu\home\user" -d Ubuntu)", commandline);
VERIFY_ARE_EQUAL(L"", path);
}
{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(wsl -d Ubuntu)", LR"(\\wsl$\Ubuntu\home\user)");
VERIFY_ARE_EQUAL(LR"("wsl" --cd "\\wsl$\Ubuntu\home\user" -d Ubuntu)", commandline);
VERIFY_ARE_EQUAL(L"", path);
}
{ LR"(wsl -d Ubuntu)", LR"(//wsl$/Ubuntu/home/user)", LR"("wsl" --cd "\\wsl$\Ubuntu\home\user" -d Ubuntu)", L"" },
{ LR"(wsl -d Ubuntu)", LR"(\\wsl$\Ubuntu\home\user)", LR"("wsl" --cd "\\wsl$\Ubuntu\home\user" -d Ubuntu)", L"" },

{
// Same, but with `wsl.localhost`
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(wsl -d Ubuntu)", LR"(//wsl.localhost/Ubuntu/home/user)");
VERIFY_ARE_EQUAL(LR"("wsl" --cd "\\wsl.localhost\Ubuntu\home\user" -d Ubuntu)", commandline);
VERIFY_ARE_EQUAL(L"", path);
}
{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(wsl -d Ubuntu)", LR"(\\wsl.localhost\Ubuntu\home\user)");
VERIFY_ARE_EQUAL(LR"("wsl" --cd "\\wsl.localhost\Ubuntu\home\user" -d Ubuntu)", commandline);
VERIFY_ARE_EQUAL(L"", path);
}

/// Tests for GH #12353
{ LR"(wsl -d Ubuntu)", LR"(//wsl.localhost/Ubuntu/home/user)", LR"("wsl" --cd "\\wsl.localhost\Ubuntu\home\user" -d Ubuntu)", L"" },
{ LR"(wsl -d Ubuntu)", LR"(\\wsl.localhost\Ubuntu\home\user)", LR"("wsl" --cd "\\wsl.localhost\Ubuntu\home\user" -d Ubuntu)", L"" },

/// Tests for OSC 7-style file URI to UNC path mangling
{ LR"(wsl -d Ubuntu)", osc7, LR"("wsl" --cd "/home/user" -d Ubuntu)", L"" },

/// Tests for GH #12353
{ LR"(wsl -d Ubuntu)", L"~", LR"("wsl" --cd "~" -d Ubuntu)", L"" },
{ LR"(wsl ~ -d Ubuntu)", L"~", LR"(wsl ~ -d Ubuntu)", expectedUserProfilePath },
{ LR"(ubuntu ~ -d Ubuntu)", L"~", LR"(ubuntu ~ -d Ubuntu)", expectedUserProfilePath },
{ LR"(powershell.exe)", L"~", LR"(powershell.exe)", expectedUserProfilePath },
// clang-format on
};

const auto expectedUserProfilePath = wil::ExpandEnvironmentStringsW<std::wstring>(L"%USERPROFILE%");
{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(wsl -d Ubuntu)", L"~");
VERIFY_ARE_EQUAL(LR"("wsl" --cd "~" -d Ubuntu)", commandline);
VERIFY_ARE_EQUAL(L"", path);
}
{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(wsl ~ -d Ubuntu)", L"~");
VERIFY_ARE_EQUAL(LR"(wsl ~ -d Ubuntu)", commandline);
VERIFY_ARE_EQUAL(expectedUserProfilePath, path);
}
{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(ubuntu ~ -d Ubuntu)", L"~");
VERIFY_ARE_EQUAL(LR"(ubuntu ~ -d Ubuntu)", commandline);
VERIFY_ARE_EQUAL(expectedUserProfilePath, path);
}
size_t i = 0;
for (auto&& testCase : testCases)
{
auto [commandline, path] = MangleStartingDirectoryForWSL(LR"(powershell.exe)", L"~");
VERIFY_ARE_EQUAL(LR"(powershell.exe)", commandline);
VERIFY_ARE_EQUAL(expectedUserProfilePath, path);
auto testMessage{ WEX::Common::NoThrowString{}.Format(L"test case %zu", i) };
auto [actualCommandline, actualPath] = MangleStartingDirectoryForWSL(testCase.commandline, testCase.startingDirectory);
VERIFY_ARE_EQUAL(testCase.expectedCommandline, actualCommandline, testMessage);
VERIFY_ARE_EQUAL(testCase.expectedPath, actualPath, testMessage);
++i;
}
}
#endif
Expand Down
Loading
Loading