Skip to content
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

Jump to bottom

urlencode spaces before calling curl #1230

Merged
merged 1 commit into from
Oct 17, 2023
Merged

urlencode spaces before calling curl #1230

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
8 changes: 8 additions & 0 deletions include/vcpkg/base/downloads.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,12 @@ namespace vcpkg
};

Optional<CurlProgressData> try_parse_curl_progress_data(StringView curl_progress_line);

// Replaces spaces with %20 for purposes of including in a URL.
// This is typically used to filter a command line passed to `x-download` or similar which
// might contain spaces that we, in turn, pass to curl.
//
// Notably, callers of this function can't use Strings::percent_encode because the URL
// is likely to contain query parameters or similar.
std::string url_encode_spaces(StringView url);
}
14 changes: 14 additions & 0 deletions src/vcpkg-test/downloads.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,3 +164,17 @@ TEST_CASE ("try_parse_curl_progress_data", "[downloads]")
REQUIRE(out.current_speed == 683 * 1024);
}
}

TEST_CASE ("url_encode_spaces", "[downloads]")
{
REQUIRE(url_encode_spaces("https://example.com?query=value&query2=value2") ==
"https://example.com?query=value&query2=value2");
REQUIRE(url_encode_spaces("https://example.com/a/b?query=value&query2=value2") ==
"https://example.com/a/b?query=value&query2=value2");
REQUIRE(url_encode_spaces("https://example.com/a%20space/b?query=value&query2=value2") ==
"https://example.com/a%20space/b?query=value&query2=value2");
REQUIRE(url_encode_spaces("https://example.com/a space/b?query=value&query2=value2") ==
"https://example.com/a%20space/b?query=value&query2=value2");
REQUIRE(url_encode_spaces("https://example.com/a space/b?query=value&query2=value2") ==
"https://example.com/a%20%20space/b?query=value&query2=value2");
}
16 changes: 9 additions & 7 deletions src/vcpkg/base/downloads.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ namespace vcpkg
}
for (auto&& url : urls)
{
cmd.string_arg(url);
cmd.string_arg(url_encode_spaces(url));
}

std::vector<std::string> lines;
Expand Down Expand Up @@ -465,7 +465,7 @@ namespace vcpkg
}
for (auto&& url : url_pairs)
{
cmd.string_arg(url.first).string_arg("-o").string_arg(url.second);
cmd.string_arg(url_encode_spaces(url.first)).string_arg("-o").string_arg(url.second);
}
auto res =
cmd_execute_and_stream_lines(cmd, [out](StringView line) {
Expand Down Expand Up @@ -536,8 +536,8 @@ namespace vcpkg
std::string res = "Authorization: Bearer " + github_token;
cmd.string_arg("-H").string_arg(res);
cmd.string_arg("-H").string_arg("X-GitHub-Api-Version: 2022-11-28");
cmd.string_arg(
Strings::concat("https://github.com/gitapi/repos/", github_repository, "/dependency-graph/snapshots"));
cmd.string_arg(Strings::concat(
"https://github.com/gitapi/repos/", url_encode_spaces(github_repository), "/dependency-graph/snapshots"));
cmd.string_arg("-d").string_arg("@-");
int code = 0;
auto result = cmd_execute_and_stream_lines(
Expand Down Expand Up @@ -579,7 +579,7 @@ namespace vcpkg
// HTTP headers are ignored for FTP clients
Command cmd;
cmd.string_arg("curl");
cmd.string_arg(url);
cmd.string_arg(url_encode_spaces(url));
cmd.string_arg("-T").string_arg(file);
auto maybe_res = cmd_execute_and_capture_output(cmd);
if (auto res = maybe_res.get())
Expand Down Expand Up @@ -664,7 +664,7 @@ namespace vcpkg
cmd.string_arg("--data-raw").string_arg(data);
}

cmd.string_arg(url);
cmd.string_arg(url_encode_spaces(url));

return flatten_out(cmd_execute_and_capture_output(cmd), "curl");
}
Expand Down Expand Up @@ -838,7 +838,7 @@ namespace vcpkg
cmd.string_arg("curl")
.string_arg("--fail")
.string_arg("-L")
.string_arg(url)
.string_arg(url_encode_spaces(url))
.string_arg("--create-dirs")
.string_arg("--output")
.string_arg(download_path_part_path);
Expand Down Expand Up @@ -1192,4 +1192,6 @@ namespace vcpkg

return result;
}

std::string url_encode_spaces(StringView url) { return Strings::replace_all(url, StringLiteral{" "}, "%20"); }
}