Skip to content

clangd(PathMapping): normalize mixed WSL/Windows URIs #155191

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
wants to merge 1 commit into
base: main
Choose a base branch
from
+92 −5
Open

clangd(PathMapping): normalize mixed WSL/Windows URIs #155191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
75 changes: 70 additions & 5 deletions clang-tools-extra/clangd/PathMapping.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
#include "llvm/Support/Error.h"
#include "llvm/Support/Path.h"
#include <algorithm>
#include <cctype>
#include <optional>
#include <tuple>

Expand All @@ -28,20 +29,84 @@ std::optional<std::string> doPathMapping(llvm::StringRef S,
llvm::consumeError(Uri.takeError());
return std::nullopt;
}

std::string BodyStr = (*Uri).body().str();
std::replace(BodyStr.begin(), BodyStr.end(), '\\', '/');

bool DidPreferEmbeddedDrive = false;
if (BodyStr.rfind("/mnt/", 0) == 0 && BodyStr.size() > 6) {
for (size_t i = 0; i + 2 < BodyStr.size(); ++i) {
if (std::isalpha((unsigned char)BodyStr[i]) && BodyStr[i + 1] == ':' &&
BodyStr[i + 2] == '/') {
BodyStr = std::string("/") + BodyStr.substr(i);
DidPreferEmbeddedDrive = true;
break;
}
}
}

if (Dir == PathMapping::Direction::ClientToServer && DidPreferEmbeddedDrive) {
if (BodyStr.size() >= 3 && BodyStr[0] == '/' &&
std::isalpha((unsigned char)BodyStr[1]) && BodyStr[2] == ':') {
return URI((*Uri).scheme(), (*Uri).authority(), BodyStr).toString();
}
}

llvm::StringRef BodyRef(BodyStr);
for (const auto &Mapping : Mappings) {
const std::string &From = Dir == PathMapping::Direction::ClientToServer
? Mapping.ClientPath
: Mapping.ServerPath;
const std::string &To = Dir == PathMapping::Direction::ClientToServer
? Mapping.ServerPath
: Mapping.ClientPath;
llvm::StringRef Body = Uri->body();
if (Body.consume_front(From) && (Body.empty() || Body.front() == '/')) {
std::string MappedBody = (To + Body).str();
return URI(Uri->scheme(), Uri->authority(), MappedBody)
.toString();
llvm::StringRef Working = BodyRef;
if (Working.consume_front(From)) {
if (From.empty() || From.back() == '/' || Working.empty() ||
Working.front() == '/') {
llvm::StringRef Adjusted = Working;

char MappingDrive = 0;
if (To.size() >= 3 && To[0] == '/' &&
std::isalpha((unsigned char)To[1]) && To[2] == ':')
MappingDrive = To[1];
if (MappingDrive) {
for (size_t i = 0; i + 2 < (size_t)Working.size(); ++i) {
char c = Working[i];
if (std::isalpha((unsigned char)c) && Working[i + 1] == ':' &&
Working[i + 2] == '/') {
if (std::tolower((unsigned char)c) ==
std::tolower((unsigned char)MappingDrive)) {
Adjusted = Working.substr(i + 3);
break;
}
}
}
}
std::string MappedBody = (To + Adjusted).str();
return URI((*Uri).scheme(), (*Uri).authority(), MappedBody).toString();
}
}
}

if (Dir == PathMapping::Direction::ServerToClient) {
for (const auto &Mapping : Mappings) {
const std::string &From = Mapping.ServerPath;
const std::string &To = Mapping.ClientPath;
if (From.empty())
continue;
llvm::StringRef W = BodyRef;
if (W.starts_with(From)) {
llvm::StringRef Rest = W.substr(From.size());
if (Rest.empty() || Rest.front() == '/') {
std::string MappedBody = (To + Rest).str();
return URI((*Uri).scheme(), (*Uri).authority(), MappedBody)
.toString();
}
}
}
}

return std::nullopt;
}

Expand Down
22 changes: 22 additions & 0 deletions clang-tools-extra/clangd/unittests/PathMappingTests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,28 @@ TEST(ApplyPathMappingTests, MapsKeys) {
EXPECT_EQ(*Params, *ExpectedParams);
}


TEST(DoPathMappingTests, HandlesEncodedWindowsFragmentsInbound) {
// Simulate a client sending a WSL-style path that embeds an encoded Windows
// fragment (percent-encoded backslashes and drive letter). The server should
// normalize and map it to a Windows-style path.
PathMappings Mappings{{"/mnt/c/", "/C:/"}};
const char *Orig = "file:///mnt/c/projects/cod2-asi/C:%5cUsers%5caukx%5cprojects%5ccod2-asi%5csrc%5cedge_detection.h";
std::optional<std::string> Mapped = doPathMapping(Orig, PathMapping::Direction::ClientToServer, Mappings);
ASSERT_TRUE(bool(Mapped));
EXPECT_EQ(*Mapped, std::string("file:///C:/Users/aukx/projects/cod2-asi/src/edge_detection.h"));
}

TEST(DoPathMappingTests, HandlesWindowsToWslOutbound) {
// Server returns Windows-style URIs; they should be mapped back to the
// client's WSL-style paths before sending out.
PathMappings Mappings{{"/mnt/c/", "/C:/"}};
const char *Orig = "file:///C:/projects/cod2-asi/src/edge_detection.h";
std::optional<std::string> Mapped = doPathMapping(Orig, PathMapping::Direction::ServerToClient, Mappings);
ASSERT_TRUE(bool(Mapped));
EXPECT_EQ(*Mapped, std::string("file:///mnt/c/projects/cod2-asi/src/edge_detection.h"));
}

} // namespace
} // namespace clangd
} // namespace clang