Switch to named pipes

Unregister package on uninstall Remove unneeded files Cleanup
2026-04-05 02:36:19 +02:00 · 2022-06-07 10:23:01 +02:00
parent 0fbb14cb95
commit c6d8ac5834
13 changed files with 514 additions and 243 deletions
--- a/installer/PowerToysSetup/Product.wxs
+++ b/installer/PowerToysSetup/Product.wxs
@@ -221,8 +221,11 @@
            <Custom Action="UnApplyModulesRegistryChangeSets" Before="RemoveFiles">
                Installed AND (REMOVE="ALL")
            </Custom>
+			<Custom Action="UnRegisterContextMenuPackages" Before="RemoveFiles">
+				Installed AND (REMOVE="ALL")
+			</Custom>

-            <!-- TODO: Use to activate embedded MSIX -->
+			<!-- TODO: Use to activate embedded MSIX -->
            <!--<Custom Action="UninstallEmbeddedMSIXTask" After="InstallFinalize">
        Installed AND (REMOVE="ALL")
      </Custom>-->
@@ -369,8 +372,16 @@
                      DllEntry="UnApplyModulesRegistryChangeSetsCA"
                  />

+		<CustomAction Id="UnRegisterContextMenuPackages"
+                      Return="ignore"
+			          Impersonate="yes"
+			          Execute="deferred"
+			          BinaryKey="PTCustomActions"
+			          DllEntry="UnRegisterContextMenuPackagesCA"
+                  />

-        <!-- Close 'PowerToys.exe' before uninstall-->
+
+		<!-- Close 'PowerToys.exe' before uninstall-->
        <Property Id="MSIRESTARTMANAGERCONTROL" Value="DisableShutdown" />
        <Property Id="MSIFASTINSTALL" Value="DisableShutdown" />
        <util:CloseApplication CloseMessage="yes" Target="PowerToys.exe" ElevatedCloseMessage="yes" RebootPrompt="no" TerminateProcess="0" />
--- a/installer/PowerToysSetupCustomActions/CustomAction.cpp
+++ b/installer/PowerToysSetupCustomActions/CustomAction.cpp
@@ -11,6 +11,10 @@
 #include "../../src/common/updating/installer.h"
 #include "../../src/common/version/version.h"

+#include <winrt/Windows.ApplicationModel.h>
+#include <winrt/Windows.Foundation.h>
+#include <winrt/Windows.Management.Deployment.h>
+
 using namespace std;

 HINSTANCE DLL_HANDLE = nullptr;
@@ -912,7 +916,7 @@ LExit:
    if (!SUCCEEDED(hr))
    {
        PMSIHANDLE hRecord = MsiCreateRecord(0);
-        MsiRecordSetString(hRecord, 0, TEXT("Filed to iminstall virtual camera driver"));
+        MsiRecordSetString(hRecord, 0, TEXT("Failed to uninstall virtual camera driver"));
        MsiProcessMessage(hInstall, INSTALLMESSAGE(INSTALLMESSAGE_WARNING + MB_OK), hRecord);
    }

@@ -920,6 +924,78 @@ LExit:
    return WcaFinalize(er);
 }

+UINT __stdcall UnRegisterContextMenuPackagesCA(MSIHANDLE hInstall)
+{
+    using namespace winrt::Windows::Foundation;
+    using namespace winrt::Windows::Management::Deployment;
+
+    HRESULT hr = S_OK;
+    UINT er = ERROR_SUCCESS;
+
+    hr = WcaInitialize(hInstall, "UnRegisterContextMenuPackagesCA"); // original func name is too long
+
+    try
+    {
+        // Packages to unregister
+        const std::vector<std::wstring> packagesToRemoveDisplayName{ { L"PowerRenameContextMenu" } };
+
+        PackageManager packageManager;
+
+        for (auto const& package : packageManager.FindPackages())
+        {
+            const auto& packageFullName = std::wstring{ package.Id().FullName() };
+
+            for (const auto& packageToRemove : packagesToRemoveDisplayName)
+            {
+                if (packageFullName.contains(packageToRemove))
+                {
+                    auto deploymentOperation{ packageManager.RemovePackageAsync(packageFullName) };
+                    deploymentOperation.get();
+
+                    // Check the status of the operation
+                    if (deploymentOperation.Status() == AsyncStatus::Error)
+                    {
+                        auto deploymentResult{ deploymentOperation.GetResults() };
+                        auto errorCode = deploymentOperation.ErrorCode();
+                        auto errorText = deploymentResult.ErrorText();
+
+                        Logger::error(L"Unregister {} package failed. ErrorCode: {}, ErrorText: {}", packageFullName, std::to_wstring(errorCode), errorText);
+
+                        er = ERROR_INSTALL_FAILURE;
+                    }
+                    else if (deploymentOperation.Status() == AsyncStatus::Canceled)
+                    {
+                        Logger::error(L"Unregister {} package canceled.", packageFullName);
+
+                        er = ERROR_INSTALL_FAILURE;
+                    }
+                    else if (deploymentOperation.Status() == AsyncStatus::Completed)
+                    {
+                        Logger::info(L"Unregister {} package completed.", packageFullName);
+                    }
+                    else
+                    {
+                        Logger::debug(L"Unregister {} package started.", packageFullName);
+                    }
+                }
+
+            }
+        }
+    }
+    catch (std::exception e)
+    {
+        std::string errorMessage{ "Exception thrown while trying to unregister sparse packages: " };
+        errorMessage += e.what();
+        Logger::error(errorMessage);
+
+        er = ERROR_INSTALL_FAILURE;
+    }
+
+    er = er == ERROR_SUCCESS ? (SUCCEEDED(hr) ? ERROR_SUCCESS : ERROR_INSTALL_FAILURE) : er;
+    return WcaFinalize(er);
+}
+
+
 UINT __stdcall TerminateProcessesCA(MSIHANDLE hInstall)
 {
    HRESULT hr = S_OK;
--- a/installer/PowerToysSetupCustomActions/CustomAction.def
+++ b/installer/PowerToysSetupCustomActions/CustomAction.def
@@ -14,10 +14,10 @@ EXPORTS
 	TelemetryLogRepairCancelCA
 	TelemetryLogRepairFailCA
 	TerminateProcessesCA
-	TerminateProcessesCA
 	CertifyVirtualCameraDriverCA
 	InstallVirtualCameraDriverCA
 	InstallEmbeddedMSIXCA
 	UnApplyModulesRegistryChangeSetsCA
 	UninstallVirtualCameraDriverCA
+	UnRegisterContextMenuPackagesCA
 	UninstallEmbeddedMSIXCA
--- a/installer/PowerToysSetupCustomActions/PowerToysSetupCustomActions.vcxproj
+++ b/installer/PowerToysSetupCustomActions/PowerToysSetupCustomActions.vcxproj
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="15.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
-  <Import Project="..\wix.props"
-    Condition="Exists('..\wix.props')" />
+  <Import Project="..\packages\Microsoft.Windows.CppWinRT.2.0.220418.1\build\native\Microsoft.Windows.CppWinRT.props" Condition="Exists('..\packages\Microsoft.Windows.CppWinRT.2.0.220418.1\build\native\Microsoft.Windows.CppWinRT.props')" />
+  <Import Project="..\wix.props" Condition="Exists('..\wix.props')" />
  <PropertyGroup Label="Globals">
    <ProjectGuid>{32f3882b-f2d6-4586-b5ed-11e39e522bd3}</ProjectGuid>
    <Keyword>Win32Proj</Keyword>
@@ -43,7 +43,6 @@
    <LinkIncremental>false</LinkIncremental>
    <IncludePath>..\..\src\common\Telemetry;$(IncludePath)</IncludePath>
  </PropertyGroup>
-
  <ItemDefinitionGroup>
    <ClCompile>
      <AdditionalIncludeDirectories>inc;..\..\src\;..\..\src\common\Telemetry;telemetry;$(WixSdkPath)VS2017\inc;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
@@ -56,7 +55,6 @@
      <ModuleDefinitionFile>CustomAction.def</ModuleDefinitionFile>
    </Link>
  </ItemDefinitionGroup>
-
  <ItemDefinitionGroup>
    <ClCompile>
      <PreprocessorDefinitions>WIN64;%(PreprocessorDefinitions)</PreprocessorDefinitions>
@@ -65,7 +63,6 @@
      <AdditionalLibraryDirectories>$(WixSdkPath)VS2017\lib\$(Platform);%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
    </Link>
  </ItemDefinitionGroup>
-
  <ItemDefinitionGroup Condition="'$(Configuration)'=='Debug'">
    <ClCompile>
      <Optimization>Disabled</Optimization>
@@ -127,5 +124,14 @@
    </ProjectReference>
  </ItemGroup>
  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
-  <ImportGroup Label="ExtensionTargets" />
+  <ImportGroup Label="ExtensionTargets">
+    <Import Project="..\packages\Microsoft.Windows.CppWinRT.2.0.220418.1\build\native\Microsoft.Windows.CppWinRT.targets" Condition="Exists('..\packages\Microsoft.Windows.CppWinRT.2.0.220418.1\build\native\Microsoft.Windows.CppWinRT.targets')" />
+  </ImportGroup>
+  <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
+    <PropertyGroup>
+      <ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them.  For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
+    </PropertyGroup>
+    <Error Condition="!Exists('..\packages\Microsoft.Windows.CppWinRT.2.0.220418.1\build\native\Microsoft.Windows.CppWinRT.props')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\Microsoft.Windows.CppWinRT.2.0.220418.1\build\native\Microsoft.Windows.CppWinRT.props'))" />
+    <Error Condition="!Exists('..\packages\Microsoft.Windows.CppWinRT.2.0.220418.1\build\native\Microsoft.Windows.CppWinRT.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\Microsoft.Windows.CppWinRT.2.0.220418.1\build\native\Microsoft.Windows.CppWinRT.targets'))" />
+  </Target>
 </Project>
--- a/installer/PowerToysSetupCustomActions/packages.config
+++ b/installer/PowerToysSetupCustomActions/packages.config
@@ -1,3 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
+  <package id="Microsoft.Windows.CppWinRT" version="2.0.220418.1" targetFramework="native" />
 </packages>