Skip to content

Use relative paths in downloads output. #1618

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

Merged
BillyONeal merged 1 commit into from
Mar 21, 2025
Merged

Use relative paths in downloads output. #1618

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
2 changes: 2 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 @@ -90,6 +90,7 @@ namespace vcpkg
const std::string& url,
View<std::string> headers,
const Path& download_path,
StringView display_path,
const Optional<std::string>& maybe_sha512);

bool download_file_asset_cached(DiagnosticContext& context,
Expand All @@ -99,6 +100,7 @@ namespace vcpkg
View<std::string> urls,
View<std::string> headers,
const Path& download_path,
StringView display_path,
const Optional<std::string>& maybe_sha512);

bool store_to_asset_cache(DiagnosticContext& context,
Expand Down
56 changes: 32 additions & 24 deletions src/vcpkg/base/downloads.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1000,7 +1000,10 @@ namespace vcpkg

// Make sure the directories are present, otherwise fopen_s fails
const auto dir = download_path_part_path.parent_path();
fs.create_directories(dir, VCPKG_LINE_INFO);
if (!dir.empty())
{
fs.create_directories(dir, VCPKG_LINE_INFO);
}

WinHttpSession s;
if (!s.open(context, sanitized_url))
Expand Down Expand Up @@ -1349,7 +1352,7 @@ namespace vcpkg
const AssetCachingSettings& asset_cache_settings,
const Filesystem& fs,
const Path& download_path,
StringView target_filename,
StringView display_path,
const StringView* maybe_sha512,
std::string* out_sha512)
{
Expand All @@ -1362,7 +1365,7 @@ namespace vcpkg

auto raw_read_url = Strings::replace_all(*read_template, "<SHA>", *maybe_sha512);
SanitizedUrl sanitized_read_url{raw_read_url, asset_cache_settings.m_secrets};
context.statusln(msg::format(msgAssetCacheConsult, msg::path = target_filename, msg::url = sanitized_read_url));
context.statusln(msg::format(msgAssetCacheConsult, msg::path = display_path, msg::url = sanitized_read_url));
return try_download_file(context,
machine_readable_progress,
fs,
Expand Down Expand Up @@ -1416,7 +1419,7 @@ namespace vcpkg
View<std::string> raw_urls,
const std::vector<SanitizedUrl>& sanitized_urls,
const Path& download_path,
StringView target_filename,
StringView display_path,
const StringView* maybe_sha512,
std::string* out_sha512)
{
Expand All @@ -1432,7 +1435,7 @@ namespace vcpkg
Checks::unreachable(VCPKG_LINE_INFO);
}

context.statusln(msg::format(msgAssetCacheConsultScript, msg::path = target_filename));
context.statusln(msg::format(msgAssetCacheConsultScript, msg::path = display_path));
const auto download_path_part_path = fmt::format("{}.{}.part", download_path, get_process_id());
Lazy<std::string> escaped_url;
const auto escaped_dpath = Command(download_path_part_path).extract();
Expand Down Expand Up @@ -1569,7 +1572,7 @@ namespace vcpkg
View<std::string> raw_urls,
const std::vector<SanitizedUrl>& sanitized_urls,
const Path& download_path,
StringView target_filename,
StringView display_path,
const StringView* maybe_sha512,
std::string* out_sha512)
{
Expand All @@ -1578,7 +1581,7 @@ namespace vcpkg
asset_cache_settings,
fs,
download_path,
target_filename,
display_path,
maybe_sha512,
out_sha512))
{
Expand All @@ -1590,7 +1593,7 @@ namespace vcpkg
raw_urls,
sanitized_urls,
download_path,
target_filename,
display_path,
maybe_sha512,
out_sha512);
case DownloadPrognosis::NetworkErrorProxyMightHelp: return DownloadPrognosis::NetworkErrorProxyMightHelp;
Expand All @@ -1599,7 +1602,7 @@ namespace vcpkg
}
static void report_download_success_and_maybe_upload(DiagnosticContext& context,
const Path& download_path,
StringView target_filename,
StringView display_path,
const AssetCachingSettings& asset_cache_settings,
const StringView* maybe_sha512)
{
Expand All @@ -1608,8 +1611,8 @@ namespace vcpkg
{
auto raw_upload_url = Strings::replace_all(*url_template, "<SHA>", *maybe_sha512);
SanitizedUrl sanitized_upload_url{raw_upload_url, asset_cache_settings.m_secrets};
context.statusln(msg::format(
msgDownloadSuccesfulUploading, msg::path = target_filename, msg::url = sanitized_upload_url));
context.statusln(
msg::format(msgDownloadSuccesfulUploading, msg::path = display_path, msg::url = sanitized_upload_url));
WarningDiagnosticContext wdc{context};
if (!store_to_asset_cache(wdc,
raw_upload_url,
Expand All @@ -1620,13 +1623,13 @@ namespace vcpkg
{
context.report(DiagnosticLine{DiagKind::Warning,
msg::format(msgFailedToStoreBackToMirror,
msg::path = target_filename,
msg::path = display_path,
msg::url = sanitized_upload_url)});
}
}
else
{
context.statusln(msg::format(msgDownloadSuccesful, msg::path = target_filename));
context.statusln(msg::format(msgDownloadSuccesful, msg::path = display_path));
}
}

Expand All @@ -1637,6 +1640,7 @@ namespace vcpkg
const std::string& url,
View<std::string> headers,
const Path& download_path,
StringView display_path,
const Optional<std::string>& maybe_sha512)
{
return download_file_asset_cached(context,
Expand All @@ -1646,6 +1650,7 @@ namespace vcpkg
View<std::string>(&url, 1),
headers,
download_path,
display_path,
maybe_sha512);
}

Expand All @@ -1656,6 +1661,7 @@ namespace vcpkg
View<std::string> raw_urls,
View<std::string> headers,
const Path& download_path,
StringView display_path,
const StringView* maybe_sha512,
std::string* out_sha512)
{
Expand All @@ -1681,7 +1687,6 @@ namespace vcpkg
std::vector<SanitizedUrl> sanitized_urls =
Util::fmap(raw_urls, [&](const std::string& url) { return SanitizedUrl{url, {}}; });
const auto last_sanitized_url = sanitized_urls.end();
const auto target_filename = download_path.filename();
bool can_read_asset_cache = false;
if (asset_cache_settings.m_read_url_template.has_value() && maybe_sha512)
{
Expand All @@ -1703,12 +1708,12 @@ namespace vcpkg
if (can_read_asset_cache)
{
context.statusln(
msg::format(msgDownloadingAssetShaToFile, msg::sha = *maybe_sha512, msg::path = download_path));
msg::format(msgDownloadingAssetShaToFile, msg::sha = *maybe_sha512, msg::path = display_path));
}
else
{
context.report_error(msg::format(
msgDownloadingAssetShaWithoutAssetCache, msg::sha = *maybe_sha512, msg::path = download_path));
msgDownloadingAssetShaWithoutAssetCache, msg::sha = *maybe_sha512, msg::path = display_path));
return false;
}
}
Expand All @@ -1723,7 +1728,7 @@ namespace vcpkg
{
// this will emit msgAssetCacheMissBlockOrigin below, this message just ensures the filename is mentioned in
// the output at all
context.statusln(msg::format(msgDownloadingFile, msg::path = target_filename));
context.statusln(msg::format(msgDownloadingFile, msg::path = display_path));
}

DownloadPrognosis asset_cache_prognosis = DownloadPrognosis::Success;
Expand All @@ -1737,7 +1742,7 @@ namespace vcpkg
raw_urls,
sanitized_urls,
download_path,
target_filename,
display_path,
maybe_sha512,
out_sha512)))
{
Expand Down Expand Up @@ -1794,13 +1799,12 @@ namespace vcpkg
else if (raw_urls.size() == 1)
{
context.statusln(
msg::format(msgDownloadingUrlToFile, msg::url = *first_sanitized_url, msg::path = target_filename));
msg::format(msgDownloadingUrlToFile, msg::url = *first_sanitized_url, msg::path = display_path));
}
else
{
context.statusln(msg::format(msgDownloadingFileFirstAuthoritativeSource,
msg::path = target_filename,
msg::url = *first_sanitized_url));
context.statusln(msg::format(
msgDownloadingFileFirstAuthoritativeSource, msg::path = display_path, msg::url = *first_sanitized_url));
}

if (check_combine_download_prognosis(authoritative_prognosis,
Expand All @@ -1817,7 +1821,7 @@ namespace vcpkg
asset_cache_attempt_context.handle();
authoritative_attempt_context.handle();
report_download_success_and_maybe_upload(
context, download_path, target_filename, asset_cache_settings, maybe_sha512);
context, download_path, display_path, asset_cache_settings, maybe_sha512);
return true;
}

Expand All @@ -1838,7 +1842,7 @@ namespace vcpkg
asset_cache_attempt_context.handle();
authoritative_attempt_context.handle();
report_download_success_and_maybe_upload(
context, download_path, target_filename, asset_cache_settings, maybe_sha512);
context, download_path, display_path, asset_cache_settings, maybe_sha512);
return true;
}
}
Expand Down Expand Up @@ -1867,6 +1871,7 @@ namespace vcpkg
View<std::string> raw_urls,
View<std::string> headers,
const Path& download_path,
StringView display_path,
const Optional<std::string>& maybe_sha512_mixed_case)
{
if (auto sha512_mixed_case = maybe_sha512_mixed_case.get())
Expand All @@ -1884,6 +1889,7 @@ namespace vcpkg
raw_urls,
headers,
download_path,
display_path,
nullptr,
&actual_sha512))
{
Expand All @@ -1902,6 +1908,7 @@ namespace vcpkg
raw_urls,
headers,
download_path,
display_path,
&sha512sv,
nullptr);
}
Expand All @@ -1913,6 +1920,7 @@ namespace vcpkg
raw_urls,
headers,
download_path,
display_path,
nullptr,
nullptr);
}
Expand Down
5 changes: 4 additions & 1 deletion src/vcpkg/commands.download.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,13 @@ namespace vcpkg

void command_download_and_exit(const VcpkgCmdArguments& args, const Filesystem& fs)
{
// Note that we must NOT make a VcpkgPaths because that will chdir
auto parsed = args.parse_arguments(CommandDownloadMetadata);
auto asset_cache_settings =
parse_download_configuration(args.asset_sources_template()).value_or_exit(VCPKG_LINE_INFO);
auto file = fs.absolute(parsed.command_arguments[0], VCPKG_LINE_INFO);

const Path file = parsed.command_arguments[0];
const StringView display_path = file.is_absolute() ? file.filename() : file.native();
auto sha = get_sha512_check(parsed);

// Is this a store command?
Expand Down Expand Up @@ -150,6 +152,7 @@ namespace vcpkg
urls,
headers,
file,
display_path,
sha))
{
Checks::exit_success(VCPKG_LINE_INFO);
Expand Down
18 changes: 14 additions & 4 deletions src/vcpkg/configure-environment.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,8 @@ namespace vcpkg
const Path& download_root)
{
#if defined(VCPKG_STANDALONE_BUNDLE_SHA)
const auto bundle_tarball = download_root / "vcpkg-standalone-bundle-" VCPKG_BASE_VERSION_AS_STRING ".tar.gz";
static constexpr StringLiteral tarball_name = "vcpkg-standalone-bundle-" VCPKG_BASE_VERSION_AS_STRING ".tar.gz";
const auto bundle_tarball = download_root / tarball_name;
context.statusln(msg::format(msgDownloadingVcpkgStandaloneBundle, msg::version = VCPKG_BASE_VERSION_AS_STRING));
const auto bundle_uri =
"https://github.com/microsoft/vcpkg-tool/releases/download/" VCPKG_BASE_VERSION_AS_STRING
Expand All @@ -123,12 +124,14 @@ namespace vcpkg
bundle_uri,
{},
bundle_tarball,
tarball_name,
MACRO_TO_STRING(VCPKG_STANDALONE_BUNDLE_SHA)))
{
return nullopt;
}
#else // ^^^ VCPKG_STANDALONE_BUNDLE_SHA / !VCPKG_STANDALONE_BUNDLE_SHA vvv
const auto bundle_tarball = download_root / "vcpkg-standalone-bundle-latest.tar.gz";
static constexpr StringLiteral latest_tarball_name = "vcpkg-standalone-bundle-latest.tar.gz";
const auto bundle_tarball = download_root / latest_tarball_name;
context.report(DiagnosticLine{DiagKind::Warning, msg::format(msgDownloadingVcpkgStandaloneBundleLatest)});
std::error_code ec;
fs.remove(bundle_tarball, ec);
Expand All @@ -140,8 +143,15 @@ namespace vcpkg

const auto bundle_uri =
"https://github.com/microsoft/vcpkg-tool/releases/latest/download/vcpkg-standalone-bundle.tar.gz";
if (!download_file_asset_cached(
context, null_sink, asset_cache_settings, fs, bundle_uri, {}, bundle_tarball, nullopt))
if (!download_file_asset_cached(context,
null_sink,
asset_cache_settings,
fs,
bundle_uri,
{},
bundle_tarball,
latest_tarball_name,
nullopt))
{
return nullopt;
}
Expand Down
1 change: 1 addition & 0 deletions src/vcpkg/tools.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -842,6 +842,7 @@ namespace vcpkg
tool_data.url,
{},
download_path,
tool_data.download_subpath,
tool_data.sha512))
{
Checks::exit_fail(VCPKG_LINE_INFO);
Expand Down