Port support for ISO/IEC 19770-2:2105 (aka SWID Tags-2)

Fixes wixtoolset/issues#8380

6 files changed, 41 insertions, 31 deletions

diff --git a/src/engine/apply.cpp b/src/engine/apply.cpp
index 77080c76..dc40c50d 100644
--- a/src/engine/apply.cpp
+++ b/src/engine/apply.cpp
@@ -435,7 +435,7 @@ extern "C" HRESULT ApplyUnregister(
     }
     else
     {
-        hr = RegistrationSessionEnd(&pEngineState->registration, &pEngineState->packages, resumeMode, restart, pEngineState->plan.dependencyRegistrationAction);
+        hr = RegistrationSessionEnd(&pEngineState->registration, &pEngineState->variables, &pEngineState->packages, resumeMode, restart, pEngineState->plan.dependencyRegistrationAction);
         ExitOnFailure(hr, "Failed to end session in per-user process.");
     }
 
diff --git a/src/engine/elevation.cpp b/src/engine/elevation.cpp
index 1737bf5b..82d5a9b1 100644
--- a/src/engine/elevation.cpp
+++ b/src/engine/elevation.cpp
@@ -156,6 +156,7 @@ static HRESULT OnSessionResume(
 static HRESULT OnSessionEnd(
     __in BURN_PACKAGES* pPackages,
     __in BURN_REGISTRATION* pRegistration,
+    __in BURN_VARIABLES* pVariables,
     __in BYTE* pbData,
     __in DWORD cbData
     );
@@ -1650,7 +1651,7 @@ static HRESULT ProcessElevatedChildMessage(
         break;
 
     case BURN_ELEVATION_MESSAGE_TYPE_SESSION_END:
-        hrResult = OnSessionEnd(pContext->pPackages, pContext->pRegistration, (BYTE*)pMsg->pvData, pMsg->cbData);
+        hrResult = OnSessionEnd(pContext->pPackages, pContext->pRegistration, pContext->pVariables, (BYTE*)pMsg->pvData, pMsg->cbData);
         break;
 
     case BURN_ELEVATION_MESSAGE_TYPE_SAVE_STATE:
@@ -1969,6 +1970,7 @@ LExit:
 static HRESULT OnSessionEnd(
     __in BURN_PACKAGES* pPackages,
     __in BURN_REGISTRATION* pRegistration,
+    __in BURN_VARIABLES* pVariables,
     __in BYTE* pbData,
     __in DWORD cbData
     )
@@ -1990,7 +1992,7 @@ static HRESULT OnSessionEnd(
     ExitOnFailure(hr, "Failed to read dependency registration action.");
 
     // suspend session in per-machine process
-    hr = RegistrationSessionEnd(pRegistration, pPackages, (BURN_RESUME_MODE)dwResumeMode, (BOOTSTRAPPER_APPLY_RESTART)dwRestart, (BURN_DEPENDENCY_REGISTRATION_ACTION)dwDependencyRegistrationAction);
+    hr = RegistrationSessionEnd(pRegistration, pVariables, pPackages, (BURN_RESUME_MODE)dwResumeMode, (BOOTSTRAPPER_APPLY_RESTART)dwRestart, (BURN_DEPENDENCY_REGISTRATION_ACTION)dwDependencyRegistrationAction);
     ExitOnFailure(hr, "Failed to suspend registration session.");
 
 LExit:
diff --git a/src/engine/engine.vcxproj b/src/engine/engine.vcxproj
index e418e6f4..666b3f37 100644
--- a/src/engine/engine.vcxproj
+++ b/src/engine/engine.vcxproj
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
 <Project DefaultTargets="Build" ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
-  <Import Project="..\..\packages\WixToolset.DUtil.4.0.65\build\WixToolset.DUtil.props" Condition="Exists('..\..\packages\WixToolset.DUtil.4.0.65\build\WixToolset.DUtil.props')" />
+  <Import Project="..\..\packages\WixToolset.DUtil.4.0.67\build\WixToolset.DUtil.props" Condition="Exists('..\..\packages\WixToolset.DUtil.4.0.67\build\WixToolset.DUtil.props')" />
   <ItemGroup Label="ProjectConfigurations">
     <ProjectConfiguration Include="Debug|Win32">
       <Configuration>Debug</Configuration>
@@ -165,7 +165,7 @@ rc.exe -fo "$(OutDir)engine.res" "$(IntDir)engine.messages.rc"</Command>
     <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\WixToolset.DUtil.4.0.65\build\WixToolset.DUtil.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\WixToolset.DUtil.4.0.65\build\WixToolset.DUtil.props'))" />
+    <Error Condition="!Exists('..\..\packages\WixToolset.DUtil.4.0.67\build\WixToolset.DUtil.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\WixToolset.DUtil.4.0.67\build\WixToolset.DUtil.props'))" />
     <Error Condition="!Exists('..\..\packages\Nerdbank.GitVersioning.3.3.37\build\Nerdbank.GitVersioning.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\Nerdbank.GitVersioning.3.3.37\build\Nerdbank.GitVersioning.targets'))" />
   </Target>
 </Project>
\ No newline at end of file
diff --git a/src/engine/packages.config b/src/engine/packages.config
index 84e3078b..1d09f0a7 100644
--- a/src/engine/packages.config
+++ b/src/engine/packages.config
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="Nerdbank.GitVersioning" version="3.3.37" targetFramework="native" developmentDependency="true" />
-  <package id="WixToolset.DUtil" version="4.0.65" targetFramework="native" />
+  <package id="WixToolset.DUtil" version="4.0.67" targetFramework="native" />
 </packages>
\ No newline at end of file
diff --git a/src/engine/registration.cpp b/src/engine/registration.cpp
index fc5ae627..b8a2283f 100644
--- a/src/engine/registration.cpp
+++ b/src/engine/registration.cpp
@@ -31,6 +31,7 @@ const LPCWSTR REGISTRY_BUNDLE_UNINSTALL_STRING = L"UninstallString";
 const LPCWSTR REGISTRY_BUNDLE_RESUME_COMMAND_LINE = L"BundleResumeCommandLine";
 const LPCWSTR REGISTRY_BUNDLE_VERSION_MAJOR = L"VersionMajor";
 const LPCWSTR REGISTRY_BUNDLE_VERSION_MINOR = L"VersionMinor";
+const LPCWSTR SWIDTAG_FOLDER = L"swidtag";
 
 // internal function declarations
 
@@ -67,11 +68,11 @@ static HRESULT FormatUpdateRegistrationKey(
     __out_z LPWSTR* psczKey
     );
 static HRESULT WriteSoftwareTags(
-    __in BOOL fPerMachine,
+    __in BURN_VARIABLES* pVariables,
     __in BURN_SOFTWARE_TAGS* pSoftwareTags
     );
 static HRESULT RemoveSoftwareTags(
-    __in BOOL fPerMachine,
+    __in BURN_VARIABLES* pVariables,
     __in BURN_SOFTWARE_TAGS* pSoftwareTags
     );
 static HRESULT WriteUpdateRegistration(
@@ -392,6 +393,7 @@ extern "C" void RegistrationUninitialize(
         {
             ReleaseStr(pRegistration->softwareTags.rgSoftwareTags[i].sczFilename);
             ReleaseStr(pRegistration->softwareTags.rgSoftwareTags[i].sczRegid);
+            ReleaseStr(pRegistration->softwareTags.rgSoftwareTags[i].sczPath);
             ReleaseStr(pRegistration->softwareTags.rgSoftwareTags[i].sczTag);
         }
 
@@ -778,7 +780,7 @@ extern "C" HRESULT RegistrationSessionBegin(
 
         if (pRegistration->softwareTags.cSoftwareTags)
         {
-            hr = WriteSoftwareTags(pRegistration->fPerMachine, &pRegistration->softwareTags);
+            hr = WriteSoftwareTags(pVariables, &pRegistration->softwareTags);
             ExitOnFailure(hr, "Failed to write software tags.");
         }
 
@@ -867,6 +869,7 @@ LExit:
  *******************************************************************/
 extern "C" HRESULT RegistrationSessionEnd(
     __in BURN_REGISTRATION* pRegistration,
+    __in BURN_VARIABLES* pVariables,
     __in BURN_PACKAGES* pPackages,
     __in BURN_RESUME_MODE resumeMode,
     __in BOOTSTRAPPER_APPLY_RESTART restart,
@@ -920,7 +923,7 @@ extern "C" HRESULT RegistrationSessionEnd(
             RemoveUpdateRegistration(pRegistration);
         }
 
-        RemoveSoftwareTags(pRegistration->fPerMachine, &pRegistration->softwareTags);
+        RemoveSoftwareTags(pVariables, &pRegistration->softwareTags);
 
         // Delete registration key.
         hr = RegDelete(pRegistration->hkRoot, pRegistration->sczRegistrationKey, REG_KEY_DEFAULT, FALSE);
@@ -1063,6 +1066,9 @@ static HRESULT ParseSoftwareTagsFromXml(
             hr = XmlGetAttributeEx(pixnNode, L"Regid", &pSoftwareTag->sczRegid);
             ExitOnFailure(hr, "Failed to get @Regid.");
 
+            hr = XmlGetAttributeEx(pixnNode, L"Path", &pSoftwareTag->sczPath);
+            ExitOnFailure(hr, "Failed to get @Path.");
+
             hr = XmlGetText(pixnNode, &bstrTagXml);
             ExitOnFailure(hr, "Failed to get SoftwareTag text.");
 
@@ -1370,30 +1376,30 @@ LExit:
 }
 
 static HRESULT WriteSoftwareTags(
-    __in BOOL fPerMachine,
+    __in BURN_VARIABLES* pVariables,
     __in BURN_SOFTWARE_TAGS* pSoftwareTags
     )
 {
     HRESULT hr = S_OK;
     LPWSTR sczRootFolder = NULL;
-    LPWSTR sczRegidFolder = NULL;
+    LPWSTR sczTagFolder = NULL;
     LPWSTR sczPath = NULL;
 
-    hr = PathGetKnownFolder(fPerMachine ? CSIDL_COMMON_APPDATA : CSIDL_LOCAL_APPDATA, &sczRootFolder);
-    ExitOnFailure(hr, "Failed to find local %hs appdata directory.", fPerMachine ? "per-machine" : "per-user");
-
     for (DWORD iTag = 0; iTag < pSoftwareTags->cSoftwareTags; ++iTag)
     {
         BURN_SOFTWARE_TAG* pSoftwareTag = pSoftwareTags->rgSoftwareTags + iTag;
 
-        hr = PathConcat(sczRootFolder, pSoftwareTag->sczRegid, &sczRegidFolder);
-        ExitOnFailure(hr, "Failed to allocate regid folder path.");
+        hr = VariableFormatString(pVariables, pSoftwareTag->sczPath, &sczRootFolder, NULL);
+        ExitOnFailure(hr, "Failed to format tag folder path.");
 
-        hr = PathConcat(sczRegidFolder, pSoftwareTag->sczFilename, &sczPath);
+        hr = PathConcat(sczRootFolder, SWIDTAG_FOLDER, &sczTagFolder);
         ExitOnFailure(hr, "Failed to allocate regid folder path.");
 
-        hr = DirEnsureExists(sczRegidFolder, NULL);
-        ExitOnFailure(hr, "Failed to create regid folder: %ls", sczRegidFolder);
+        hr = PathConcat(sczTagFolder, pSoftwareTag->sczFilename, &sczPath);
+        ExitOnFailure(hr, "Failed to allocate regid file path.");
+
+        hr = DirEnsureExists(sczTagFolder, NULL);
+        ExitOnFailure(hr, "Failed to create regid folder: %ls", sczTagFolder);
 
         hr = FileWrite(sczPath, FILE_ATTRIBUTE_NORMAL, reinterpret_cast<LPBYTE>(pSoftwareTag->sczTag), lstrlenA(pSoftwareTag->sczTag), NULL);
         ExitOnFailure(hr, "Failed to write tag xml to file: %ls", sczPath);
@@ -1401,44 +1407,44 @@ static HRESULT WriteSoftwareTags(
 
 LExit:
     ReleaseStr(sczPath);
-    ReleaseStr(sczRegidFolder);
+    ReleaseStr(sczTagFolder);
     ReleaseStr(sczRootFolder);
 
     return hr;
 }
 
 static HRESULT RemoveSoftwareTags(
-    __in BOOL fPerMachine,
+    __in BURN_VARIABLES* pVariables,
     __in BURN_SOFTWARE_TAGS* pSoftwareTags
     )
 {
     HRESULT hr = S_OK;
     LPWSTR sczRootFolder = NULL;
-    LPWSTR sczRegidFolder = NULL;
+    LPWSTR sczTagFolder = NULL;
     LPWSTR sczPath = NULL;
 
-    hr = PathGetKnownFolder(fPerMachine ? CSIDL_COMMON_APPDATA : CSIDL_LOCAL_APPDATA, &sczRootFolder);
-    ExitOnFailure(hr, "Failed to find local %hs appdata directory.", fPerMachine ? "per-machine" : "per-user");
-
     for (DWORD iTag = 0; iTag < pSoftwareTags->cSoftwareTags; ++iTag)
     {
         BURN_SOFTWARE_TAG* pSoftwareTag = pSoftwareTags->rgSoftwareTags + iTag;
 
-        hr = PathConcat(sczRootFolder, pSoftwareTag->sczRegid, &sczRegidFolder);
-        ExitOnFailure(hr, "Failed to allocate regid folder path.");
+        hr = VariableFormatString(pVariables, pSoftwareTag->sczPath, &sczRootFolder, NULL);
+        ExitOnFailure(hr, "Failed to format tag folder path.");
 
-        hr = PathConcat(sczRegidFolder, pSoftwareTag->sczFilename, &sczPath);
+        hr = PathConcat(sczRootFolder, SWIDTAG_FOLDER, &sczTagFolder);
         ExitOnFailure(hr, "Failed to allocate regid folder path.");
 
+        hr = PathConcat(sczTagFolder, pSoftwareTag->sczFilename, &sczPath);
+        ExitOnFailure(hr, "Failed to allocate regid file path.");
+
         // Best effort to delete the software tag file and the regid folder.
         FileEnsureDelete(sczPath);
 
-        ::RemoveDirectoryW(sczRegidFolder);
+        DirDeleteEmptyDirectoriesToRoot(sczTagFolder, 0);
     }
 
 LExit:
     ReleaseStr(sczPath);
-    ReleaseStr(sczRegidFolder);
+    ReleaseStr(sczTagFolder);
     ReleaseStr(sczRootFolder);
 
     return hr;
diff --git a/src/engine/registration.h b/src/engine/registration.h
index 39fee65f..ed0641eb 100644
--- a/src/engine/registration.h
+++ b/src/engine/registration.h
@@ -77,6 +77,7 @@ typedef struct _BURN_SOFTWARE_TAG
 {
     LPWSTR sczFilename;
     LPWSTR sczRegid;
+    LPWSTR sczPath;
     LPSTR sczTag;
 } BURN_SOFTWARE_TAG;
 
@@ -198,6 +199,7 @@ HRESULT RegistrationSessionResume(
     );
 HRESULT RegistrationSessionEnd(
     __in BURN_REGISTRATION* pRegistration,
+    __in BURN_VARIABLES* pVariables,
     __in BURN_PACKAGES* pPackages,
     __in BURN_RESUME_MODE resumeMode,
     __in BOOTSTRAPPER_APPLY_RESTART restart,