[Installer]Use custom action to copy DSC files on user install (#32799)

* Better fix for installation issues when My Documents on network drive * Fix spellcheck * Improved wxs comment * Created DSCModule folder in install folder; removed DSC modules from resources * Added back newline
2024-11-22 00:03:48 +00:00 · 2024-05-31 10:47:31 +02:00 · 2024-05-31 10:47:31 +02:00 · 1fb632d4a6
commit 1fb632d4a6
parent f859eac18a
5 changed files with 211 additions and 52 deletions
--- a/.github/actions/spell-check/patterns.txt
+++ b/.github/actions/spell-check/patterns.txt
@ -40,6 +40,9 @@
 # tabs in c#
 \$"\\t

+# Hexadecimal character pattern in code
+\\x[0-9a-fA-F][0-9a-fA-F]
+
 # windows line breaks in strings
 \\r\\n

--- a/installer/PowerToysSetup/Core.wxs
+++ b/installer/PowerToysSetup/Core.wxs
@ -46,33 +46,18 @@
      </Component>
    </DirectoryRef>

-    <?if $(var.PerUser) = "true" ?>
-    <DirectoryRef Id="PersonalFolder">
-      <Directory Id="WindowsPowerShellFolder" Name="PowerShell">
-        <Directory Id="PowerShellModulesFolder" Name="Modules">
-          <Directory Id="PowerToysDscFolder" Name="Microsoft.PowerToys.Configure">
-            <Directory Id="PowerToysDscVerFolder" Name="$(var.Version)">
-              <Component Id="PowerToysDSC" Win64="yes" Guid="4A033E3B-6590-43FD-8FBD-27F9DF557F7F">
-                <RegistryValue Root="HKCU"
-                         Key="Software\[Manufacturer]\[ProductName]"
-                         Name="DSCInstalled"
-                         Type="integer"
-                         Value="1"
-                         KeyPath="yes"/>
-                <!-- Don't fail installation because of DSC. Files are marked as not vital. -->
-                <File Vital="no" Source="$(var.RepoDir)\src\dsc\Microsoft.PowerToys.Configure\Generated\Microsoft.PowerToys.Configure\$(var.Version)\Microsoft.PowerToys.Configure.psd1" Id="PTConf.psd1" />
-                <File Vital="no" Source="$(var.RepoDir)\src\dsc\Microsoft.PowerToys.Configure\Generated\Microsoft.PowerToys.Configure\$(var.Version)\Microsoft.PowerToys.Configure.psm1" Id="PTConf.psm1" />
-                <RemoveFolder Id="RemoveThisFolder" On="uninstall" />
-                <RemoveFolder Id="RemovePowerToysDscVerFolder" Directory="PowerToysDscVerFolder" On="uninstall" />
-                <RemoveFolder Id="RemovePowerToysDscFolder" Directory="PowerToysDscFolder" On="uninstall" />
-                <RemoveFolder Id="RemovePowerShellModulesFolder" Directory="PowerShellModulesFolder" On="uninstall" />
-                <RemoveFolder Id="RemoveWindowsPowerShellFolder" Directory="WindowsPowerShellFolder" On="uninstall" />
+    <DirectoryRef Id="DSCModulesReferenceFolder">
+      <Component Id="PowerToysDSCReference" Win64="yes" Guid="40869ACB-0BEB-4911-AE41-5E73BC1586A9">
+        <RegistryKey Root="$(var.RegistryScope)" Key="Software\Classes\powertoys\components">
+          <RegistryValue Type="string" Name="DSCModulesReference" Value="" KeyPath="yes"/>
+        </RegistryKey>
+        <File Source="$(var.RepoDir)\src\dsc\Microsoft.PowerToys.Configure\Generated\Microsoft.PowerToys.Configure\$(var.Version)\Microsoft.PowerToys.Configure.psd1" Id="PTConfReference.psd1" />
+        <File Source="$(var.RepoDir)\src\dsc\Microsoft.PowerToys.Configure\Generated\Microsoft.PowerToys.Configure\$(var.Version)\Microsoft.PowerToys.Configure.psm1" Id="PTConfReference.psm1" />
      </Component>
-            </Directory>
-          </Directory>
-        </Directory>
-      </Directory>
    </DirectoryRef>
+
+    <?if $(var.PerUser) = "true" ?>
+    <!-- DSC module files for PerUser handled in InstallDSCModule custom action. -->
    <?else?>
    <DirectoryRef Id="ProgramFiles64Folder">
      <Directory Id="WindowsPowerShellFolder" Name="WindowsPowerShell">
@ -135,6 +120,7 @@
          <RegistryValue Type="string" Name="RemoveCoreFolder" Value="" KeyPath="yes"/>
        </RegistryKey>
        <RemoveFolder Id="RemoveBaseApplicationsAssetsFolder" Directory="BaseApplicationsAssetsFolder" On="uninstall"/>
+        <RemoveFolder Id="RemoveDSCModulesReferenceFolder" Directory="DSCModulesReferenceFolder" On="uninstall"/>
        <RemoveFolder Id="RemoveWinUI3AppsInstallFolder" Directory="WinUI3AppsInstallFolder" On="uninstall"/>
        <RemoveFolder Id="RemoveWinUI3AppsAssetsFolder" Directory="WinUI3AppsAssetsFolder" On="uninstall"/>
        <RemoveFolder Id="RemoveINSTALLFOLDER" Directory="INSTALLFOLDER" On="uninstall"/>
@ -146,7 +132,10 @@
      <ComponentRef Id="License_rtf" />
      <ComponentRef Id="Notice_md" />
      <ComponentRef Id="DesktopShortcut" />
+      <ComponentRef Id="PowerToysDSCReference" />
+      <?if $(var.PerUser) = "false" ?>
      <ComponentRef Id="PowerToysDSC" />
+      <?endif?>
    </ComponentGroup>
  </Fragment>
 </Wix>
--- a/installer/PowerToysSetup/Product.wxs
+++ b/installer/PowerToysSetup/Product.wxs
@ -136,6 +136,11 @@
      <Custom Action="SetUninstallCommandNotFoundParam" Before="UninstallCommandNotFound" />
      <Custom Action="SetUpgradeCommandNotFoundParam" Before="UpgradeCommandNotFound" />
      <Custom Action="SetApplyModulesRegistryChangeSetsParam" Before="ApplyModulesRegistryChangeSets" />
+
+      <?if $(var.PerUser) = "true" ?>
+      <Custom Action="SetInstallDSCModuleParam" Before="InstallDSCModule" />
+      <?endif?>
+
      <Custom Action="SetUnApplyModulesRegistryChangeSetsParam" Before="UnApplyModulesRegistryChangeSets" />
      <Custom Action="CheckGPO" After="InstallInitialize">
        NOT Installed
@ -149,6 +154,9 @@
      <!--<Custom Action="InstallEmbeddedMSIXTask" After="InstallFinalize">
        NOT Installed
      </Custom>-->
+        <?if $(var.PerUser) = "true" ?>
+        <Custom Action="InstallDSCModule" After="InstallFiles"/>
+        <?endif?>
        <Custom Action="TelemetryLogInstallSuccess" After="InstallFinalize">
        NOT Installed
      </Custom>
@ -177,8 +185,12 @@
      <!--<Custom Action="UninstallEmbeddedMSIXTask" After="InstallFinalize">
        Installed AND (REMOVE="ALL")
      </Custom>-->
+      <?if $(var.PerUser) = "true" ?>
+      <Custom Action="UninstallDSCModule" After="InstallFinalize">
+          Installed AND (REMOVE="ALL")
+      </Custom>
+      <?endif?>
      <Custom Action="TerminateProcesses" Before="InstallValidate" />
-
      <Custom Action="LaunchPowerToys" Before="InstallFinalize">NOT Installed</Custom>

    </InstallExecuteSequence>
@ -211,6 +223,10 @@
                    Property="UnApplyModulesRegistryChangeSets"
                    Value="[INSTALLFOLDER]" />

+    <CustomAction Id="SetInstallDSCModuleParam"
+                    Property="InstallDSCModule"
+                    Value="[INSTALLFOLDER]" />
+
    <CustomAction Id="SetUninstallCommandNotFoundParam"
                    Property="UninstallCommandNotFound"
                    Value="[INSTALLFOLDER]" />
@ -265,6 +281,21 @@
                  DllEntry="UninstallEmbeddedMSIXCA"
                   />

+    <CustomAction Id="InstallDSCModule"
+                  Return="ignore"
+                  Impersonate="yes"
+                  Execute="deferred"
+                  BinaryKey="PTCustomActions"
+                  DllEntry="InstallDSCModuleCA"
+                   />
+
+    <CustomAction Id="UninstallDSCModule"
+                  Return="ignore"
+                  Impersonate="yes"
+                  BinaryKey="PTCustomActions"
+                  DllEntry="UninstallDSCModuleCA"
+                   />
+
      <CustomAction Id="UninstallServicesTask"
                    Return="ignore"
                    Impersonate="yes"
@ -407,6 +438,7 @@
        <Directory Id="INSTALLFOLDER" Name="PowerToys">
          <Directory Id="BaseApplicationsAssetsFolder" Name="Assets">
          </Directory>
+          <Directory Id="DSCModulesReferenceFolder" Name="DSCModules" />
          <Directory Id="WinUI3AppsInstallFolder" Name="WinUI3Apps">
              <Directory Id="WinUI3AppsMicrosoftUIXamlInstallFolder" Name="Microsoft.UI.Xaml">
                <Directory Id="WinUI3AppsMicrosoftUIXamlAssetsInstallFolder" Name="Assets" />
@ -421,9 +453,6 @@
        <Directory Id="ApplicationProgramsFolder" Name="PowerToys (Preview)"/>
      </Directory>
      <Directory Id="DesktopFolder" Name="Desktop" />
-      <?if $(var.PerUser) = "true" ?>
-        <Directory Id="PersonalFolder" Name="UserHomeDocuments" />
-      <?endif?>
    </Directory>
  </Fragment>
 </Wix>
--- a/installer/PowerToysSetupCustomActions/CustomAction.cpp
+++ b/installer/PowerToysSetupCustomActions/CustomAction.cpp
@ -139,6 +139,23 @@ LExit:
    return SUCCEEDED(hr);
 }

+static std::filesystem::path GetUserPowerShellModulesPath()
+{
+    PWSTR myDocumentsBlockPtr;
+
+    if (SUCCEEDED(SHGetKnownFolderPath(FOLDERID_Documents, 0, NULL, &myDocumentsBlockPtr)))
+    {
+        const std::wstring myDocuments{ myDocumentsBlockPtr };
+        CoTaskMemFree(myDocumentsBlockPtr);
+        return std::filesystem::path(myDocuments) / "PowerShell" / "Modules";
+    }
+    else
+    {
+        CoTaskMemFree(myDocumentsBlockPtr);
+        return {};
+    }
+}
+
 UINT __stdcall LaunchPowerToysCA(MSIHANDLE hInstall)
 {
    HRESULT hr = S_OK;
@ -317,6 +334,125 @@ LExit:
    return WcaFinalize(er);
 }

+const wchar_t* DSC_CONFIGURE_PSD1_NAME = L"Microsoft.PowerToys.Configure.psd1";
+const wchar_t* DSC_CONFIGURE_PSM1_NAME = L"Microsoft.PowerToys.Configure.psm1";
+
+UINT __stdcall InstallDSCModuleCA(MSIHANDLE hInstall)
+{
+    HRESULT hr = S_OK;
+    UINT er = ERROR_SUCCESS;
+    std::wstring installationFolder;
+
+    hr = WcaInitialize(hInstall, "InstallDSCModuleCA");
+    ExitOnFailure(hr, "Failed to initialize");
+
+    hr = getInstallFolder(hInstall, installationFolder);
+    ExitOnFailure(hr, "Failed to get installFolder.");
+
+    {
+        const auto baseModulesPath = GetUserPowerShellModulesPath();
+        if (baseModulesPath.empty())
+        {
+            hr = E_FAIL;
+            ExitOnFailure(hr, "Unable to determine Powershell modules path");
+        }
+
+        const auto modulesPath = baseModulesPath / L"Microsoft.PowerToys.Configure" / get_product_version();
+
+        std::error_code errorCode;
+        fs::create_directories(modulesPath, errorCode);
+        if (errorCode)
+        {
+            hr = E_FAIL;
+            ExitOnFailure(hr, "Unable to create Powershell modules folder");
+        }
+
+        for (const auto* filename : { DSC_CONFIGURE_PSD1_NAME, DSC_CONFIGURE_PSM1_NAME })
+        {
+            fs::copy_file(fs::path(installationFolder) / "DSCModules" / filename, modulesPath / filename, fs::copy_options::overwrite_existing, errorCode);
+
+            if (errorCode)
+            {
+                hr = E_FAIL;
+                ExitOnFailure(hr, "Unable to copy Powershell modules file");
+            }
+        }
+    }
+
+LExit:
+    if (SUCCEEDED(hr))
+    {
+        er = ERROR_SUCCESS;
+        Logger::info(L"DSC module was installed!");
+    }
+    else
+    {
+        er = ERROR_INSTALL_FAILURE;
+        Logger::error(L"Couldn't install DSC module!");
+    }
+
+    return WcaFinalize(er);
+}
+
+UINT __stdcall UninstallDSCModuleCA(MSIHANDLE hInstall)
+{
+    HRESULT hr = S_OK;
+    UINT er = ERROR_SUCCESS;
+
+    hr = WcaInitialize(hInstall, "UninstallDSCModuleCA");
+    ExitOnFailure(hr, "Failed to initialize");
+
+    {
+        const auto baseModulesPath = GetUserPowerShellModulesPath();
+        if (baseModulesPath.empty())
+        {
+            hr = E_FAIL;
+            ExitOnFailure(hr, "Unable to determine Powershell modules path");
+        }
+
+        const auto powerToysModulePath = baseModulesPath / L"Microsoft.PowerToys.Configure";
+        const auto versionedModulePath = powerToysModulePath / get_product_version();
+
+        std::error_code errorCode;
+
+        for (const auto* filename : { DSC_CONFIGURE_PSD1_NAME, DSC_CONFIGURE_PSM1_NAME })
+        {
+            fs::remove(versionedModulePath / filename, errorCode);
+
+            if (errorCode)
+            {
+                hr = E_FAIL;
+                ExitOnFailure(hr, "Unable to delete DSC file");
+            }
+        }
+
+        for (const auto* modulePath : { &versionedModulePath, &powerToysModulePath })
+        {
+            fs::remove(*modulePath, errorCode);
+
+            if (errorCode)
+            {
+                hr = E_FAIL;
+                ExitOnFailure(hr, "Unable to delete DSC folder");
+            }
+        }
+    }
+
+LExit:
+    if (SUCCEEDED(hr))
+    {
+        er = ERROR_SUCCESS;
+        Logger::info(L"DSC module was uninstalled!");
+    }
+    else
+    {
+        er = ERROR_INSTALL_FAILURE;
+        Logger::error(L"Couldn't uninstall DSC module!");
+    }
+
+    return WcaFinalize(er);
+}
+
 UINT __stdcall InstallEmbeddedMSIXCA(MSIHANDLE hInstall)
 {
    HRESULT hr = S_OK;
--- a/installer/PowerToysSetupCustomActions/CustomAction.def
+++ b/installer/PowerToysSetupCustomActions/CustomAction.def
@ -18,10 +18,12 @@ EXPORTS
 	CertifyVirtualCameraDriverCA
 	InstallVirtualCameraDriverCA
 	InstallEmbeddedMSIXCA
+	InstallDSCModuleCA
 	UnApplyModulesRegistryChangeSetsCA
 	UninstallVirtualCameraDriverCA
 	UnRegisterContextMenuPackagesCA
 	UninstallEmbeddedMSIXCA
+	UninstallDSCModuleCA
 	UninstallServicesCA
 	UninstallCommandNotFoundModuleCA
 	UpgradeCommandNotFoundModuleCA