#include "pch.h" #include #include #include #include #include #include #include #include #include #include #include #include namespace vcpkg::Export { using Dependencies::ExportPlanAction; using Dependencies::ExportPlanType; using Dependencies::RequestType; using Install::InstallDir; static std::string create_nuspec_file_contents(const std::string& raw_exported_dir, const std::string& targets_redirect_path, const std::string& nuget_id, const std::string& nupkg_version) { static constexpr auto CONTENT_TEMPLATE = R"( @NUGET_ID@ @VERSION@ vcpkg Vcpkg NuGet export )"; std::string nuspec_file_content = Strings::replace_all(CONTENT_TEMPLATE, "@NUGET_ID@", nuget_id); nuspec_file_content = Strings::replace_all(std::move(nuspec_file_content), "@VERSION@", nupkg_version); nuspec_file_content = Strings::replace_all(std::move(nuspec_file_content), "@RAW_EXPORTED_DIR@", raw_exported_dir); nuspec_file_content = Strings::replace_all(std::move(nuspec_file_content), "@TARGETS_REDIRECT_PATH@", targets_redirect_path); return nuspec_file_content; } static std::string create_targets_redirect(const std::string& target_path) noexcept { return Strings::format(R"###( )###", target_path, target_path); } static void print_plan(const std::map>& group_by_plan_type) { static constexpr std::array ORDER = {ExportPlanType::ALREADY_BUILT, ExportPlanType::PORT_AVAILABLE_BUT_NOT_BUILT}; static constexpr Build::BuildPackageOptions build_options = {Build::UseHeadVersion::NO, Build::AllowDownloads::YES}; for (const ExportPlanType plan_type : ORDER) { const auto it = group_by_plan_type.find(plan_type); if (it == group_by_plan_type.cend()) { continue; } std::vector cont = it->second; std::sort(cont.begin(), cont.end(), &ExportPlanAction::compare_by_name); const std::string as_string = Strings::join("\n", cont, [](const ExportPlanAction* p) { return Dependencies::to_output_string(p->request_type, p->spec.to_string(), build_options); }); switch (plan_type) { case ExportPlanType::ALREADY_BUILT: System::println("The following packages are already built and will be exported:\n%s", as_string); continue; case ExportPlanType::PORT_AVAILABLE_BUT_NOT_BUILT: System::println("The following packages need to be built:\n%s", as_string); continue; default: Checks::unreachable(VCPKG_LINE_INFO); } } } static std::string create_export_id() { const tm date_time = System::get_current_date_time(); // Format is: YYYYmmdd-HHMMSS // 15 characters + 1 null terminating character will be written for a total of 16 chars char mbstr[16]; const size_t bytes_written = std::strftime(mbstr, sizeof(mbstr), "%Y%m%d-%H%M%S", &date_time); Checks::check_exit(VCPKG_LINE_INFO, bytes_written == 15, "Expected 15 bytes to be written, but %u were written", bytes_written); const std::string date_time_as_string(mbstr); return ("vcpkg-export-" + date_time_as_string); } static fs::path do_nuget_export(const VcpkgPaths& paths, const std::string& nuget_id, const std::string& nuget_version, const fs::path& raw_exported_dir, const fs::path& output_dir) { Files::Filesystem& fs = paths.get_filesystem(); const fs::path& nuget_exe = paths.get_nuget_exe(); // This file will be placed in "build\native" in the nuget package. Therefore, go up two dirs. const std::string targets_redirect_content = create_targets_redirect("../../scripts/buildsystems/msbuild/vcpkg.targets"); const fs::path targets_redirect = paths.buildsystems / "tmp" / "vcpkg.export.nuget.targets"; std::error_code ec; fs.create_directories(paths.buildsystems / "tmp", ec); fs.write_contents(targets_redirect, targets_redirect_content); const std::string nuspec_file_content = create_nuspec_file_contents(raw_exported_dir.string(), targets_redirect.string(), nuget_id, nuget_version); const fs::path nuspec_file_path = paths.buildsystems / "tmp" / "vcpkg.export.nuspec"; fs.write_contents(nuspec_file_path, nuspec_file_content); // -NoDefaultExcludes is needed for ".vcpkg-root" const auto cmd_line = Strings::format(R"("%s" pack -OutputDirectory "%s" "%s" -NoDefaultExcludes > nul)", nuget_exe.u8string(), output_dir.u8string(), nuspec_file_path.u8string()); const int exit_code = System::cmd_execute_clean(cmd_line); Checks::check_exit(VCPKG_LINE_INFO, exit_code == 0, "Error: NuGet package creation failed"); const fs::path output_path = output_dir / (nuget_id + ".nupkg"); return output_path; } struct ArchiveFormat final { enum class BackingEnum { ZIP = 1, SEVEN_ZIP, }; constexpr ArchiveFormat() = delete; constexpr ArchiveFormat(BackingEnum backing_enum, const char* extension, const char* cmake_option) : backing_enum(backing_enum), m_extension(extension), m_cmake_option(cmake_option) { } constexpr operator BackingEnum() const { return backing_enum; } constexpr CStringView extension() const { return this->m_extension; } constexpr CStringView cmake_option() const { return this->m_cmake_option; } private: BackingEnum backing_enum; const char* m_extension; const char* m_cmake_option; }; namespace ArchiveFormatC { constexpr const ArchiveFormat ZIP(ArchiveFormat::BackingEnum::ZIP, "zip", "zip"); constexpr const ArchiveFormat SEVEN_ZIP(ArchiveFormat::BackingEnum::SEVEN_ZIP, "7z", "7zip"); } static fs::path do_archive_export(const VcpkgPaths& paths, const fs::path& raw_exported_dir, const fs::path& output_dir, const ArchiveFormat& format) { const fs::path& cmake_exe = paths.get_cmake_exe(); const std::string exported_dir_filename = raw_exported_dir.filename().u8string(); const std::string exported_archive_filename = Strings::format("%s.%s", exported_dir_filename, format.extension()); const fs::path exported_archive_path = (output_dir / exported_archive_filename); // -NoDefaultExcludes is needed for ".vcpkg-root" const auto cmd_line = Strings::format(R"("%s" -E tar "cf" "%s" --format=%s -- "%s")", cmake_exe.u8string(), exported_archive_path.u8string(), format.cmake_option(), raw_exported_dir.u8string()); const int exit_code = System::cmd_execute_clean(cmd_line); Checks::check_exit( VCPKG_LINE_INFO, exit_code == 0, "Error: %s creation failed", exported_archive_path.generic_string()); return exported_archive_path; } static Optional maybe_lookup(std::unordered_map const& m, std::string const& key) { const auto it = m.find(key); if (it != m.end()) return it->second; return nullopt; } void export_integration_files(const fs::path& raw_exported_dir_path, const VcpkgPaths& paths) { const std::vector integration_files_relative_to_root = { {".vcpkg-root"}, {fs::path{"scripts"} / "buildsystems" / "msbuild" / "applocal.ps1"}, {fs::path{"scripts"} / "buildsystems" / "msbuild" / "vcpkg.targets"}, {fs::path{"scripts"} / "buildsystems" / "vcpkg.cmake"}, {fs::path{"scripts"} / "cmake" / "vcpkg_get_windows_sdk.cmake"}, {fs::path{"scripts"} / "getWindowsSDK.ps1"}, {fs::path{"scripts"} / "getProgramFilesPlatformBitness.ps1"}, {fs::path{"scripts"} / "getProgramFiles32bit.ps1"}, }; for (const fs::path& file : integration_files_relative_to_root) { const fs::path source = paths.root / file; fs::path destination = raw_exported_dir_path / file; Files::Filesystem& fs = paths.get_filesystem(); std::error_code ec; fs.create_directories(destination.parent_path(), ec); Checks::check_exit(VCPKG_LINE_INFO, !ec); fs.copy_file(source, destination, fs::copy_options::overwrite_existing, ec); Checks::check_exit(VCPKG_LINE_INFO, !ec); } } struct ExportArguments { bool dry_run; bool raw; bool nuget; bool ifw; bool zip; bool seven_zip; Optional maybe_nuget_id; Optional maybe_nuget_version; IFW::Options ifw_options; std::vector specs; }; static const std::string OPTION_DRY_RUN = "--dry-run"; static const std::string OPTION_RAW = "--raw"; static const std::string OPTION_NUGET = "--nuget"; static const std::string OPTION_IFW = "--ifw"; static const std::string OPTION_ZIP = "--zip"; static const std::string OPTION_SEVEN_ZIP = "--7zip"; static const std::string OPTION_NUGET_ID = "--nuget-id"; static const std::string OPTION_NUGET_VERSION = "--nuget-version"; static const std::string OPTION_IFW_REPOSITORY_URL = "--ifw-repository-url"; static const std::string OPTION_IFW_PACKAGES_DIR_PATH = "--ifw-packages-directory-path"; static const std::string OPTION_IFW_REPOSITORY_DIR_PATH = "--ifw-repository-directory-path"; static const std::string OPTION_IFW_CONFIG_FILE_PATH = "--ifw-configuration-file-path"; static const std::string OPTION_IFW_INSTALLER_FILE_PATH = "--ifw-installer-file-path"; static const std::array EXPORT_SWITCHES = {{ {OPTION_DRY_RUN, "Do not actually export"}, {OPTION_RAW, "Export to an uncompressed directory"}, {OPTION_NUGET, "Export a NuGet package"}, {OPTION_IFW, "Export to an IFW-based installer"}, {OPTION_ZIP, "Export to a zip file"}, {OPTION_SEVEN_ZIP, "Export to a 7zip (.7z) file"}, }}; static const std::array EXPORT_SETTINGS = {{ {OPTION_NUGET_ID, "Specify the id for the exported NuGet package"}, {OPTION_NUGET_VERSION, "Specify the version for the exported NuGet package"}, {OPTION_IFW_REPOSITORY_URL, "Specify the remote repository URL for the online installer"}, {OPTION_IFW_PACKAGES_DIR_PATH, "Specify the temporary directory path for the repacked packages"}, {OPTION_IFW_REPOSITORY_DIR_PATH, "Specify the directory path for the exported repository"}, {OPTION_IFW_CONFIG_FILE_PATH, "Specify the temporary file path for the installer configuration"}, {OPTION_IFW_INSTALLER_FILE_PATH, "Specify the file path for the exported installer"}, }}; const CommandStructure vcpkg::Export::COMMAND_STRUCTURE = { Help::create_example_string("export zlib zlib:x64-windows boost --nuget"), 0, SIZE_MAX, {EXPORT_SWITCHES, EXPORT_SETTINGS}, nullptr, }; static ExportArguments handle_export_command_arguments(const VcpkgCmdArguments& args, const Triplet& default_triplet) { ExportArguments ret; const auto options = args.parse_arguments(COMMAND_STRUCTURE); // input sanitization ret.specs = Util::fmap(args.command_arguments, [&](auto&& arg) { return Input::check_and_get_package_spec(arg, default_triplet, COMMAND_STRUCTURE.example_text); }); ret.dry_run = options.switches.find(OPTION_DRY_RUN) != options.switches.cend(); ret.raw = options.switches.find(OPTION_RAW) != options.switches.cend(); ret.nuget = options.switches.find(OPTION_NUGET) != options.switches.cend(); ret.ifw = options.switches.find(OPTION_IFW) != options.switches.cend(); ret.zip = options.switches.find(OPTION_ZIP) != options.switches.cend(); ret.seven_zip = options.switches.find(OPTION_SEVEN_ZIP) != options.switches.cend(); if (!ret.raw && !ret.nuget && !ret.ifw && !ret.zip && !ret.seven_zip && !ret.dry_run) { System::println(System::Color::error, "Must provide at least one export type: --raw --nuget --ifw --zip --7zip"); System::print(COMMAND_STRUCTURE.example_text); Checks::exit_fail(VCPKG_LINE_INFO); } struct OptionPair { const std::string& name; Optional& out_opt; }; const auto options_implies = [&](const std::string& main_opt_name, bool main_opt, Span implying_opts) { if (main_opt) { for (auto&& opt : implying_opts) opt.out_opt = maybe_lookup(options.settings, opt.name); } else { for (auto&& opt : implying_opts) Checks::check_exit(VCPKG_LINE_INFO, !maybe_lookup(options.settings, opt.name), "%s is only valid with %s", opt.name, main_opt_name); } }; options_implies(OPTION_NUGET, ret.nuget, { {OPTION_NUGET_ID, ret.maybe_nuget_id}, {OPTION_NUGET_VERSION, ret.maybe_nuget_version}, }); options_implies(OPTION_IFW, ret.ifw, { {OPTION_IFW_REPOSITORY_URL, ret.ifw_options.maybe_repository_url}, {OPTION_IFW_PACKAGES_DIR_PATH, ret.ifw_options.maybe_packages_dir_path}, {OPTION_IFW_REPOSITORY_DIR_PATH, ret.ifw_options.maybe_repository_dir_path}, {OPTION_IFW_CONFIG_FILE_PATH, ret.ifw_options.maybe_config_file_path}, {OPTION_IFW_INSTALLER_FILE_PATH, ret.ifw_options.maybe_installer_file_path}, }); return ret; } static void print_next_step_info(const fs::path& prefix) { const fs::path cmake_toolchain = prefix / "scripts" / "buildsystems" / "vcpkg.cmake"; const CMakeVariable cmake_variable = CMakeVariable("CMAKE_TOOLCHAIN_FILE", cmake_toolchain.generic_string()); System::println("\n" "To use the exported libraries in CMake projects use:" "\n" " %s" "\n", cmake_variable.s); }; static void handle_raw_based_export(Span export_plan, const ExportArguments& opts, const std::string& export_id, const VcpkgPaths& paths) { Files::Filesystem& fs = paths.get_filesystem(); const fs::path export_to_path = paths.root; const fs::path raw_exported_dir_path = export_to_path / export_id; std::error_code ec; fs.remove_all(raw_exported_dir_path, ec); fs.create_directory(raw_exported_dir_path, ec); // execute the plan for (const ExportPlanAction& action : export_plan) { if (action.plan_type != ExportPlanType::ALREADY_BUILT) { Checks::unreachable(VCPKG_LINE_INFO); } const std::string display_name = action.spec.to_string(); System::println("Exporting package %s... ", display_name); const BinaryParagraph& binary_paragraph = action.any_paragraph.binary_control_file.value_or_exit(VCPKG_LINE_INFO).core_paragraph; const InstallDir dirs = InstallDir::from_destination_root( raw_exported_dir_path / "installed", action.spec.triplet().to_string(), raw_exported_dir_path / "installed" / "vcpkg" / "info" / (binary_paragraph.fullstem() + ".list")); Install::install_files_and_write_listfile(paths.get_filesystem(), paths.package_dir(action.spec), dirs); System::println(System::Color::success, "Exporting package %s... done", display_name); } // Copy files needed for integration export_integration_files(raw_exported_dir_path, paths); if (opts.raw) { System::println( System::Color::success, R"(Files exported at: "%s")", raw_exported_dir_path.generic_string()); print_next_step_info(export_to_path); } if (opts.nuget) { System::println("Creating nuget package... "); const std::string nuget_id = opts.maybe_nuget_id.value_or(raw_exported_dir_path.filename().string()); const std::string nuget_version = opts.maybe_nuget_version.value_or("1.0.0"); const fs::path output_path = do_nuget_export(paths, nuget_id, nuget_version, raw_exported_dir_path, export_to_path); System::println(System::Color::success, "Creating nuget package... done"); System::println(System::Color::success, "NuGet package exported at: %s", output_path.generic_string()); System::println(R"( With a project open, go to Tools->NuGet Package Manager->Package Manager Console and paste: Install-Package %s -Source "%s" )" "\n", nuget_id, output_path.parent_path().u8string()); } if (opts.zip) { System::println("Creating zip archive... "); const fs::path output_path = do_archive_export(paths, raw_exported_dir_path, export_to_path, ArchiveFormatC::ZIP); System::println(System::Color::success, "Creating zip archive... done"); System::println(System::Color::success, "Zip archive exported at: %s", output_path.generic_string()); print_next_step_info("[...]"); } if (opts.seven_zip) { System::println("Creating 7zip archive... "); const fs::path output_path = do_archive_export(paths, raw_exported_dir_path, export_to_path, ArchiveFormatC::SEVEN_ZIP); System::println(System::Color::success, "Creating 7zip archive... done"); System::println(System::Color::success, "7zip archive exported at: %s", output_path.generic_string()); print_next_step_info("[...]"); } if (!opts.raw) { fs.remove_all(raw_exported_dir_path, ec); } } void perform_and_exit(const VcpkgCmdArguments& args, const VcpkgPaths& paths, const Triplet& default_triplet) { const auto opts = handle_export_command_arguments(args, default_triplet); for (auto&& spec : opts.specs) Input::check_triplet(spec.triplet(), paths); // create the plan const StatusParagraphs status_db = database_load_check(paths); std::vector export_plan = Dependencies::create_export_plan(paths, opts.specs, status_db); Checks::check_exit(VCPKG_LINE_INFO, !export_plan.empty(), "Export plan cannot be empty"); std::map> group_by_plan_type; Util::group_by(export_plan, &group_by_plan_type, [](const ExportPlanAction& p) { return p.plan_type; }); print_plan(group_by_plan_type); const bool has_non_user_requested_packages = Util::find_if(export_plan, [](const ExportPlanAction& package) -> bool { return package.request_type != RequestType::USER_REQUESTED; }) != export_plan.cend(); if (has_non_user_requested_packages) { System::println(System::Color::warning, "Additional packages (*) need to be exported to complete this operation."); } const auto it = group_by_plan_type.find(ExportPlanType::PORT_AVAILABLE_BUT_NOT_BUILT); if (it != group_by_plan_type.cend() && !it->second.empty()) { System::println(System::Color::error, "There are packages that have not been built."); // No need to show all of them, just the user-requested ones. Dependency resolution will handle the rest. std::vector unbuilt = it->second; Util::erase_remove_if( unbuilt, [](const ExportPlanAction* a) { return a->request_type != RequestType::USER_REQUESTED; }); const auto s = Strings::join(" ", unbuilt, [](const ExportPlanAction* a) { return a->spec.to_string(); }); System::println("To build them, run:\n" " vcpkg install %s", s); Checks::exit_fail(VCPKG_LINE_INFO); } if (opts.dry_run) { Checks::exit_success(VCPKG_LINE_INFO); } std::string export_id = create_export_id(); if (opts.raw || opts.nuget || opts.zip || opts.seven_zip) { handle_raw_based_export(export_plan, opts, export_id, paths); } if (opts.ifw) { IFW::do_export(export_plan, export_id, opts.ifw_options, paths); print_next_step_info("@RootDir@/src/vcpkg"); } Checks::exit_success(VCPKG_LINE_INFO); } }