Merge pull request #1931 from podsvirov/vcpkg-export-ifw

[vcpkg-export-ifw] Maintenance Tool

2 files changed, 106 insertions, 5 deletions

diff --git a/scripts/ifw/maintenance.qs b/scripts/ifw/maintenance.qs
new file mode 100644
index 000000000..5cdad7225
--- /dev/null
+++ b/scripts/ifw/maintenance.qs
@@ -0,0 +1,46 @@
+// constructor
+function Component()
+{
+    installer.installationStarted.connect(this, Component.prototype.onInstallationStarted);
+}
+
+Component.prototype.onInstallationStarted = function()
+{
+    if (component.updateRequested() || component.installationRequested()) {
+        if (installer.value("os") == "win")
+            component.installerbaseBinaryPath = "@TargetDir@/tempmaintenancetool.exe";
+        installer.setInstallerBaseBinary(component.installerbaseBinaryPath);
+    }
+}
+
+Component.prototype.createOperations = function()
+{
+    // call the base createOperations
+    component.createOperations();
+
+    // only for windows online installer
+    if ( installer.value("os") == "win" && !installer.isOfflineOnly() )
+    {
+        // shortcut to add or remove packages
+        component.addOperation( "CreateShortcut",
+                                "@TargetDir@/maintenancetool.exe",
+                                "@StartMenuDir@/Manage vcpkg.lnk",
+                                " --manage-packages");
+        // shortcut to update packages
+        component.addOperation( "CreateShortcut",
+                                "@TargetDir@/maintenancetool.exe",
+                                "@StartMenuDir@/Update vcpkg.lnk",
+                                " --updater");
+    }
+
+    // create uninstall link only for windows
+    if (installer.value("os") == "win")
+    {
+        // shortcut to uninstaller
+        component.addOperation( "CreateShortcut",
+                                "@TargetDir@/maintenancetool.exe",
+                                "@StartMenuDir@/Uninstall vcpkg.lnk",
+                                " --uninstall");
+    }
+}
+
diff --git a/toolsrc/src/commands_export_ifw.cpp b/toolsrc/src/commands_export_ifw.cpp
index 0dc8a7d31..191dbb763 100644
--- a/toolsrc/src/commands_export_ifw.cpp
+++ b/toolsrc/src/commands_export_ifw.cpp
@@ -270,12 +270,62 @@ namespace vcpkg::Commands::Export::IFW
 <Installer>
     <Name>vcpkg</Name>
     <Version>1.0.0</Version>
+    <StartMenuDir>vcpkg</StartMenuDir>
     <TargetDir>@RootDir@/src/vcpkg</TargetDir>%s
 </Installer>
 )###",
                               formatted_repo_url));
     }
 
+    void export_maintenance_tool(const fs::path& ifw_packages_dir_path, const VcpkgPaths& paths)
+    {
+        System::println("Exporting maintenance tool... ");
+
+        std::error_code ec;
+        Files::Filesystem& fs = paths.get_filesystem();
+
+        const fs::path& installerbase_exe = paths.get_ifw_installerbase_exe();
+        fs::path tempmaintenancetool = ifw_packages_dir_path / "maintenance" / "data" / "tempmaintenancetool.exe";
+        fs.create_directories(tempmaintenancetool.parent_path(), ec);
+        Checks::check_exit(VCPKG_LINE_INFO,
+                           !ec,
+                           "Could not create directory for package file %s",
+                           tempmaintenancetool.generic_string());
+        fs.copy_file(installerbase_exe, tempmaintenancetool, fs::copy_options::overwrite_existing, ec);
+        Checks::check_exit(
+            VCPKG_LINE_INFO, !ec, "Could not write package file %s", tempmaintenancetool.generic_string());
+
+        fs::path package_xml_file_path = ifw_packages_dir_path / "maintenance" / "meta" / "package.xml";
+        fs::path package_xml_dir_path = package_xml_file_path.parent_path();
+        fs.create_directories(package_xml_dir_path, ec);
+        Checks::check_exit(VCPKG_LINE_INFO,
+                           !ec,
+                           "Could not create directory for package file %s",
+                           package_xml_file_path.generic_string());
+        fs.write_contents(package_xml_file_path,
+                          Strings::format(
+                              R"###(<?xml version="1.0"?>
+<Package>
+    <DisplayName>Maintenance Tool</DisplayName>
+    <Description>Maintenance Tool</Description>
+    <Version>1.0.0</Version>
+    <ReleaseDate>%s</ReleaseDate>
+    <Script>maintenance.qs</Script>
+    <Essential>true</Essential>
+    <Virtual>true</Virtual>
+    <ForcedInstallation>true</ForcedInstallation>
+</Package>
+)###",
+                              create_release_date()));
+        const fs::path script_source = paths.root / "scripts" / "ifw" / "maintenance.qs";
+        const fs::path script_destination = ifw_packages_dir_path / "maintenance" / "meta" / "maintenance.qs";
+        fs.copy_file(script_source, script_destination, fs::copy_options::overwrite_existing, ec);
+        Checks::check_exit(
+            VCPKG_LINE_INFO, !ec, "Could not write package file %s", script_destination.generic_string());
+
+        System::println("Exporting maintenance tool... done");
+    }
+
     void do_repository(const std::string& export_id, const Options& ifw_options, const VcpkgPaths& paths)
     {
         const fs::path& repogen_exe = paths.get_ifw_repogen_exe();
@@ -343,14 +393,12 @@ namespace vcpkg::Commands::Export::IFW
                    const Options& ifw_options,
                    const VcpkgPaths& paths)
     {
-        const fs::path ifw_packages_dir_path = get_packages_dir_path(export_id, ifw_options, paths);
-        const fs::path config_file = get_config_file_path(export_id, ifw_options, paths);
-
-        System::println("Exporting packages %s... ", ifw_packages_dir_path.generic_string());
-
         std::error_code ec;
         Files::Filesystem& fs = paths.get_filesystem();
 
+        // Prepare packages directory
+        const fs::path ifw_packages_dir_path = get_packages_dir_path(export_id, ifw_options, paths);
+
         fs.remove_all(ifw_packages_dir_path, ec);
         Checks::check_exit(VCPKG_LINE_INFO,
                            !ec,
@@ -361,6 +409,11 @@ namespace vcpkg::Commands::Export::IFW
         Checks::check_exit(
             VCPKG_LINE_INFO, !ec, "Could not create packages directory %s", ifw_packages_dir_path.generic_string());
 
+        // Export maintenance tool
+        export_maintenance_tool(ifw_packages_dir_path, paths);
+
+        System::println("Exporting packages %s... ", ifw_packages_dir_path.generic_string());
+
         // execute the plan
         std::map<std::string, const ExportPlanAction*> unique_packages;
         std::set<std::string> unique_triplets;
@@ -395,6 +448,8 @@ namespace vcpkg::Commands::Export::IFW
 
         System::println("Exporting packages %s... done", ifw_packages_dir_path.generic_string());
 
+        const fs::path config_file = get_config_file_path(export_id, ifw_options, paths);
+
         System::println("Generating configuration %s...", config_file.generic_string());
 
         // Unique packages