From f3c96bcab560cb09355e9366eac3f4195479d95d Mon Sep 17 00:00:00 2001
From: Jacob Hoover <jacob.hoover@greenheck.com>
Date: Fri, 11 Jun 2021 17:05:06 -0500
Subject: Allow access to persisted variables from related bundles.

Implements #3704
---
 src/burn/engine/registration.cpp                |  92 ++++++++++++
 src/burn/test/BurnUnitTest/RegistrationTest.cpp | 178 ++++++++++++++++++++++--
 src/burn/test/BurnUnitTest/precomp.h            |   1 +
 src/libs/dutil/WixToolset.DUtil/butil.cpp       | 105 ++++++++++++--
 src/libs/dutil/WixToolset.DUtil/inc/butil.h     |  11 +-
 src/libs/dutil/WixToolset.DUtil/inc/regutil.h   |   8 ++
 src/libs/dutil/WixToolset.DUtil/regutil.cpp     |  47 +++++++
 7 files changed, 420 insertions(+), 22 deletions(-)

diff --git a/src/burn/engine/registration.cpp b/src/burn/engine/registration.cpp
index eed1fee2..4088004d 100644
--- a/src/burn/engine/registration.cpp
+++ b/src/burn/engine/registration.cpp
@@ -32,6 +32,7 @@ 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";
+const LPCWSTR REGISTRY_BUNDLE_VARIABLE_KEY = L"variables";
 
 // internal function declarations
 
@@ -909,6 +910,7 @@ extern "C" HRESULT RegistrationSessionEnd(
 {
     HRESULT hr = S_OK;
     LPWSTR sczRebootRequiredKey = NULL;
+    LPWSTR sczVariableKey = NULL;
     HKEY hkRebootRequired = NULL;
     HKEY hkRegistration = NULL;
 
@@ -956,6 +958,17 @@ extern "C" HRESULT RegistrationSessionEnd(
 
         RemoveSoftwareTags(pVariables, &pRegistration->softwareTags);
 
+        // build variable registry key path
+        hr = StrAllocFormatted(&sczVariableKey, L"%s\\%s", pRegistration->sczRegistrationKey, REGISTRY_BUNDLE_VARIABLE_KEY);
+        ExitOnFailure(hr, "Failed to build variable registry key path.");
+
+        // Delete registration variable key.
+        hr = RegDelete(pRegistration->hkRoot, sczVariableKey, REG_KEY_DEFAULT, FALSE);
+        if (E_FILENOTFOUND != hr)
+        {
+            ExitOnFailure(hr, "Failed to delete registration variable key: %ls", sczVariableKey);
+        }
+
         // Delete registration key.
         hr = RegDelete(pRegistration->hkRoot, pRegistration->sczRegistrationKey, REG_KEY_DEFAULT, FALSE);
         if (E_FILENOTFOUND != hr)
@@ -985,6 +998,7 @@ extern "C" HRESULT RegistrationSessionEnd(
 LExit:
     ReleaseRegKey(hkRegistration);
     ReleaseRegKey(hkRebootRequired);
+    ReleaseStr(sczVariableKey);
     ReleaseStr(sczRebootRequiredKey);
 
     return hr;
@@ -1001,6 +1015,15 @@ extern "C" HRESULT RegistrationSaveState(
     )
 {
     HRESULT hr = S_OK;
+    BURN_VARIABLES variables = { };
+    SIZE_T iBuffer_Unused = 0;
+    HKEY hkRegistration = NULL;
+    LPWSTR sczVariableKey = NULL;
+    LPWSTR sczVariableValue = NULL;
+    LPWSTR sczValueName = NULL;
+    DWORD dwType = 0;
+    DWORD dwNumberOfExistingValues = 0;
+
 
     // write data to file
     hr = FileWrite(pRegistration->sczStateFile, FILE_ATTRIBUTE_NORMAL, pbBuffer, cbBuffer, NULL);
@@ -1011,7 +1034,76 @@ extern "C" HRESULT RegistrationSaveState(
     }
     ExitOnFailure(hr, "Failed to write state to file: %ls", pRegistration->sczStateFile);
 
+    ::InitializeCriticalSection(&variables.csAccess);
+
+    hr = VariableDeserialize(&variables, TRUE, pbBuffer, cbBuffer, &iBuffer_Unused);
+    ExitOnFailure(hr, "Failed to read variables.");
+
+    // build variable registry key path
+    hr = StrAllocFormatted(&sczVariableKey, L"%s\\%s", pRegistration->sczRegistrationKey, REGISTRY_BUNDLE_VARIABLE_KEY);
+    ExitOnFailure(hr, "Failed to build variable registry key path.");
+
+    // open registration variable key
+    hr = RegCreate(pRegistration->hkRoot, sczVariableKey, KEY_WRITE | KEY_QUERY_VALUE, &hkRegistration);
+    ExitOnFailure(hr, "Failed to create registration variable key.");
+
+    hr = RegQueryInfoKey(hkRegistration, 0, 0, 0, 0, 0, 0, &dwNumberOfExistingValues, 0, 0, 0, 0);
+    ExitOnFailure(hr, "Failed to query registration variable count.");
+
+    for (DWORD i = dwNumberOfExistingValues; i >= 0; --i)
+    {
+        hr = RegValueEnum(hkRegistration, i, &sczValueName, &dwType);
+
+        if (E_NOMOREITEMS == hr)
+        {
+            hr = S_OK;
+            break;
+        }
+
+        ExitOnFailure(hr, "Failed to enumerate value %u", i);
+
+        hr = RegDeleteValue(hkRegistration, sczValueName);
+        ExitOnFailure(hr, "Failed to delete registration variable value.");
+    }
+
+    // Write variables.
+    for (DWORD i = 0; i < variables.cVariables; ++i)
+    {
+        BURN_VARIABLE* pVariable = &variables.rgVariables[i];
+
+        // Write variable value.
+        switch (pVariable->Value.Type)
+        {
+        case BURN_VARIANT_TYPE_NONE:
+            hr = RegWriteNone(hkRegistration, pVariable->sczName);
+            ExitOnFailure(hr, "Failed to set variable value.");
+            break;
+        case BURN_VARIANT_TYPE_NUMERIC: __fallthrough;
+        case BURN_VARIANT_TYPE_VERSION: __fallthrough;
+        case BURN_VARIANT_TYPE_FORMATTED: __fallthrough;
+        case BURN_VARIANT_TYPE_STRING:
+            hr = BVariantGetString(&pVariable->Value, &sczVariableValue);
+            ExitOnFailure(hr, "Failed to get variable value.");
+
+            hr = RegWriteString(hkRegistration, pVariable->sczName, sczVariableValue);
+            ExitOnFailure(hr, "Failed to set variable value.");
+
+            ReleaseNullStrSecure(sczVariableValue);
+
+            break;
+        default:
+            hr = E_INVALIDARG;
+            ExitOnFailure(hr, "Unsupported variable type.");
+        }
+
+    }
 LExit:
+    VariablesUninitialize(&variables);
+    ReleaseStr(sczValueName);
+    ReleaseStr(sczVariableValue);
+    ReleaseStr(sczVariableKey);
+    ReleaseRegKey(hkRegistration);
+
     return hr;
 }
 
diff --git a/src/burn/test/BurnUnitTest/RegistrationTest.cpp b/src/burn/test/BurnUnitTest/RegistrationTest.cpp
index 96bdb2bf..298d4631 100644
--- a/src/burn/test/BurnUnitTest/RegistrationTest.cpp
+++ b/src/burn/test/BurnUnitTest/RegistrationTest.cpp
@@ -8,9 +8,12 @@
 #define HKCU_PATH L"SOFTWARE\\WiX_Burn_UnitTest\\HKCU"
 #define REGISTRY_UNINSTALL_KEY L"SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall"
 #define REGISTRY_RUN_KEY L"SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\RunOnce"
+#define TEST_BUNDLE_ID L"{D54F896D-1952-43e6-9C67-B5652240618C}"
+#define TEST_BUNDLE_UPGRADE_CODE L"{89FDAE1F-8CC1-48B9-B930-3945E0D3E7F0}"
 
 #define TEST_UNINSTALL_KEY L"HKEY_CURRENT_USER\\" HKCU_PATH L"\\" REGISTRY_UNINSTALL_KEY L"\\{D54F896D-1952-43e6-9C67-B5652240618C}"
 #define TEST_RUN_KEY L"HKEY_CURRENT_USER\\" HKCU_PATH L"\\" REGISTRY_RUN_KEY
+#define TEST_VARIABLE_KEY L"HKEY_CURRENT_USER\\" HKCU_PATH L"\\" REGISTRY_UNINSTALL_KEY L"\\{D54F896D-1952-43e6-9C67-B5652240618C}\\variables"
 
 
 static LSTATUS APIENTRY RegistrationTest_RegCreateKeyExW(
@@ -496,30 +499,153 @@ namespace Bootstrapper
             }
         }
 
-        [Fact(Skip = "Currently fails")]
-        void ResumeTest()
+        [Fact]
+        void DUtilButilTest()
         {
             HRESULT hr = S_OK;
             IXMLDOMElement* pixeBundle = NULL;
             LPWSTR sczCurrentProcess = NULL;
+            LPWSTR sczValue = NULL;
+            LPWSTR sczRelatedBundleId = NULL;
+            DWORD dwRelatedBundleIndex = 0;
             BURN_VARIABLES variables = { };
             BURN_USER_EXPERIENCE userExperience = { };
             BOOTSTRAPPER_COMMAND command = { };
             BURN_REGISTRATION registration = { };
             BURN_LOGGING logging = { };
             BURN_PACKAGES packages = { };
-            BYTE rgbData[256] = { };
-            BOOTSTRAPPER_RESUME_TYPE resumeType = BOOTSTRAPPER_RESUME_TYPE_NONE;
             BYTE* pbBuffer = NULL;
             SIZE_T cbBuffer = 0;
+            
             String^ cacheDirectory = Path::Combine(Path::Combine(Environment::GetFolderPath(Environment::SpecialFolder::LocalApplicationData), gcnew String(L"Package Cache")), gcnew String(L"{D54F896D-1952-43e6-9C67-B5652240618C}"));
             try
             {
-                for (DWORD i = 0; i < 256; ++i)
+                // set mock API's
+                RegFunctionOverride(RegistrationTest_RegCreateKeyExW, RegistrationTest_RegOpenKeyExW, RegistrationTest_RegDeleteKeyExW, NULL, NULL, NULL, NULL, NULL, NULL);
+
+                Registry::CurrentUser->CreateSubKey(gcnew String(HKCU_PATH));
+
+                logging.sczPath = L"BurnUnitTest.txt";
+
+                LPCWSTR wzDocument =
+                    L"<Bundle>"
+                    L"    <UX>"
+                    L"        <Payload Id='ux.dll' FilePath='ux.dll' Packaging='embedded' SourcePath='ux.dll' Hash='000000000000' />"
+                    L"    </UX>"
+                    L"    <RelatedBundle Id='" TEST_BUNDLE_UPGRADE_CODE "' Action='Upgrade' />"
+                    L"    <Registration Id='" TEST_BUNDLE_ID "' Tag='foo' ProviderKey='" TEST_BUNDLE_ID "' Version='1.0.0.0' ExecutableName='setup.exe' PerMachine='no'>"
+                    L"        <Arp Register='yes' Publisher='WiX Toolset' DisplayName='RegisterBasicTest' DisplayVersion='1.0.0.0' />"
+                    L"    </Registration>"
+                    L"    <Variable Id='MyBurnVariable1' Type='numeric' Value='0' Hidden='no' Persisted='yes' />"
+                    L"    <Variable Id='MyBurnVariable2' Type='string' Value='foo' Hidden='no' Persisted='yes' />"
+                    L"    <Variable Id='MyBurnVariable3' Type='version' Value='v1.1-alpha' Hidden='no' Persisted='yes' />"
+                    L"    <Variable Id='MyBurnVariable4' Type='string' Value='foo' Hidden='no' Persisted='no' />"
+                    L"    <CommandLine Variables='upperCase' />"
+                    L"</Bundle>";
+
+                // load XML document
+                LoadBundleXmlHelper(wzDocument, &pixeBundle);
+
+                hr = VariableInitialize(&variables);
+                TestThrowOnFailure(hr, L"Failed to initialize variables.");
+
+                hr = VariablesParseFromXml(&variables, pixeBundle);
+                TestThrowOnFailure(hr, L"Failed to parse variables from XML.");
+
+                hr = UserExperienceParseFromXml(&userExperience, pixeBundle);
+                TestThrowOnFailure(hr, L"Failed to parse UX from XML.");
+
+                hr = RegistrationParseFromXml(&registration, pixeBundle);
+                TestThrowOnFailure(hr, L"Failed to parse registration from XML.");
+
+                hr = PlanSetResumeCommand(&registration, BOOTSTRAPPER_ACTION_INSTALL, &command, &logging);
+                TestThrowOnFailure(hr, L"Failed to set registration resume command.");
+
+                hr = PathForCurrentProcess(&sczCurrentProcess, NULL);
+                TestThrowOnFailure(hr, L"Failed to get current process path.");
+
+                // begin session
+                hr = RegistrationSessionBegin(sczCurrentProcess, &registration, &variables, BURN_REGISTRATION_ACTION_OPERATIONS_WRITE_REGISTRATION, BURN_DEPENDENCY_REGISTRATION_ACTION_REGISTER, 0, BOOTSTRAPPER_REGISTRATION_TYPE_INPROGRESS);
+                TestThrowOnFailure(hr, L"Failed to register bundle.");
+
+                VariableSetNumericHelper(&variables, L"MyBurnVariable1", 42);
+                VariableSetStringHelper(&variables, L"MyBurnVariable2", L"bar", FALSE);
+                VariableSetVersionHelper(&variables, L"MyBurnVariable3", L"v1.0-beta");
+
+                hr = VariableSerialize(&variables, TRUE, &pbBuffer, &cbBuffer);
+                TestThrowOnFailure(hr, "Failed to serialize variables.");
+
+                if (!Directory::Exists(cacheDirectory))
                 {
-                    rgbData[i] = (BYTE)i;
+                    Directory::CreateDirectory(cacheDirectory);
                 }
 
+                hr = RegistrationSaveState(&registration, pbBuffer, cbBuffer);
+                TestThrowOnFailure(hr, L"Failed to save state.");
+
+                ReleaseNullBuffer(pbBuffer);
+                cbBuffer = 0;
+                // Verify the variables exist
+                Assert::Equal<String^>(gcnew String(L"42"), (String^)Registry::GetValue(gcnew String(TEST_VARIABLE_KEY), gcnew String(L"MyBurnVariable1"), nullptr));
+                Assert::Equal<String^>(gcnew String(L"bar"), (String^)Registry::GetValue(gcnew String(TEST_VARIABLE_KEY), gcnew String(L"MyBurnVariable2"), nullptr));
+                Assert::Equal<String^>(gcnew String(L"1.0-beta"), (String^)Registry::GetValue(gcnew String(TEST_VARIABLE_KEY), gcnew String(L"MyBurnVariable3"), nullptr));
+                Assert::Empty((System::Collections::IEnumerable ^)Registry::GetValue(gcnew String(TEST_VARIABLE_KEY), gcnew String(L"WixBundleForcedRestartPackage"), nullptr));
+
+                hr = StrAlloc(&sczRelatedBundleId, MAX_GUID_CHARS + 1);
+
+                // Verify we can find ourself via the UpgradeCode
+                hr = BundleEnumRelatedBundle(TEST_BUNDLE_UPGRADE_CODE, BUNDLE_INSTALL_CONTEXT_USER, &dwRelatedBundleIndex, sczRelatedBundleId);
+                TestThrowOnFailure(hr, L"Failed to enumerate related bundle.");
+                Assert::Equal<String^>(gcnew String(TEST_BUNDLE_ID), gcnew String(sczRelatedBundleId));
+
+                // Verify we can read the bundle variables via the API
+                hr = BundleGetBundleVariable(TEST_BUNDLE_ID, L"MyBurnVariable1", &sczValue);
+                TestThrowOnFailure(hr, L"Failed to read MyBurnVariable1.");
+                Assert::Equal<String^>(gcnew String(L"42"), gcnew String(sczValue));
+
+                // end session
+                hr = RegistrationSessionEnd(&registration, &variables, &packages, BURN_RESUME_MODE_NONE, BOOTSTRAPPER_APPLY_RESTART_NONE, BURN_DEPENDENCY_REGISTRATION_ACTION_UNREGISTER, BOOTSTRAPPER_REGISTRATION_TYPE_NONE);
+                TestThrowOnFailure(hr, L"Failed to unregister bundle.");
+            }
+            finally
+            {
+                ReleaseStr(sczRelatedBundleId);
+                ReleaseStr(sczCurrentProcess);
+                ReleaseObject(pixeBundle);
+                UserExperienceUninitialize(&userExperience);
+                RegistrationUninitialize(&registration);
+                VariablesUninitialize(&variables);
+
+                Registry::CurrentUser->DeleteSubKeyTree(gcnew String(ROOT_PATH));
+                if (Directory::Exists(cacheDirectory))
+                {
+                    Directory::Delete(cacheDirectory, true);
+                }
+
+                RegFunctionOverride(NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);
+            }
+        }
+
+        [Fact]//(Skip = "Currently fails")]
+        void ResumeTest()
+        {
+            HRESULT hr = S_OK;
+            IXMLDOMElement* pixeBundle = NULL;
+            LPWSTR sczCurrentProcess = NULL;
+            LPWSTR sczValue = NULL;
+            BURN_VARIABLES variables = { };
+            BURN_USER_EXPERIENCE userExperience = { };
+            BOOTSTRAPPER_COMMAND command = { };
+            BURN_REGISTRATION registration = { };
+            BURN_LOGGING logging = { };
+            BURN_PACKAGES packages = { };
+            BOOTSTRAPPER_RESUME_TYPE resumeType = BOOTSTRAPPER_RESUME_TYPE_NONE;
+            BYTE* pbBuffer = NULL;
+            SIZE_T cbBuffer = 0;
+            SIZE_T piBuffer = 0;
+            String^ cacheDirectory = Path::Combine(Path::Combine(Environment::GetFolderPath(Environment::SpecialFolder::LocalApplicationData), gcnew String(L"Package Cache")), gcnew String(L"{D54F896D-1952-43e6-9C67-B5652240618C}"));
+            try
+            {
                 // set mock API's
                 RegFunctionOverride(RegistrationTest_RegCreateKeyExW, RegistrationTest_RegOpenKeyExW, RegistrationTest_RegDeleteKeyExW, NULL, NULL, NULL, NULL, NULL, NULL);
 
@@ -535,6 +661,10 @@ namespace Bootstrapper
                     L"    <Registration Id='{D54F896D-1952-43e6-9C67-B5652240618C}' UpgradeCode='{D54F896D-1952-43e6-9C67-B5652240618C}' Tag='foo' ProviderKey='foo' Version='1.0.0.0' ExecutableName='setup.exe' PerMachine='no'>"
                     L"        <Arp Register='yes' Publisher='WiX Toolset' DisplayName='RegisterBasicTest' DisplayVersion='1.0.0.0' />"
                     L"    </Registration>"
+                    L"    <Variable Id='MyBurnVariable1' Type='numeric' Value='0' Hidden='no' Persisted='yes' />"
+                    L"    <Variable Id='MyBurnVariable2' Type='string' Value='foo' Hidden='no' Persisted='yes' />"
+                    L"    <Variable Id='MyBurnVariable3' Type='version' Value='v1.1-alpha' Hidden='no' Persisted='yes' />"
+                    L"    <CommandLine Variables='upperCase' />"
                     L"</Bundle>";
 
                 // load XML document
@@ -543,6 +673,9 @@ namespace Bootstrapper
                 hr = VariableInitialize(&variables);
                 TestThrowOnFailure(hr, L"Failed to initialize variables.");
 
+                hr = VariablesParseFromXml(&variables, pixeBundle);
+                TestThrowOnFailure(hr, L"Failed to parse variables from XML.");
+
                 hr = UserExperienceParseFromXml(&userExperience, pixeBundle);
                 TestThrowOnFailure(hr, L"Failed to parse UX from XML.");
 
@@ -565,9 +698,33 @@ namespace Bootstrapper
                 hr = RegistrationSessionBegin(sczCurrentProcess, &registration, &variables, BURN_REGISTRATION_ACTION_OPERATIONS_WRITE_REGISTRATION, BURN_DEPENDENCY_REGISTRATION_ACTION_REGISTER, 0, BOOTSTRAPPER_REGISTRATION_TYPE_INPROGRESS);
                 TestThrowOnFailure(hr, L"Failed to register bundle.");
 
-                hr = RegistrationSaveState(&registration, rgbData, sizeof(rgbData));
+                VariableSetNumericHelper(&variables, L"MyBurnVariable1", 42);
+                VariableSetStringHelper(&variables, L"MyBurnVariable2", L"bar", FALSE);
+                VariableSetVersionHelper(&variables, L"MyBurnVariable3", L"v1.0-beta");
+
+                hr = VariableSerialize(&variables, TRUE, &pbBuffer, &cbBuffer);
+                TestThrowOnFailure(hr, "Failed to serialize variables.");
+
+                if (!Directory::Exists(cacheDirectory))
+                {
+                    Directory::CreateDirectory(cacheDirectory);
+                }
+
+                hr = RegistrationSaveState(&registration, pbBuffer, cbBuffer);
                 TestThrowOnFailure(hr, L"Failed to save state.");
 
+                ReleaseNullBuffer(pbBuffer);
+                cbBuffer = 0;
+                // Verify the variables exist
+                Assert::Equal<String^>(gcnew String(L"42"), (String^)Registry::GetValue(gcnew String(TEST_VARIABLE_KEY), gcnew String(L"MyBurnVariable1"), nullptr));
+                Assert::Equal<String^>(gcnew String(L"bar"), (String^)Registry::GetValue(gcnew String(TEST_VARIABLE_KEY), gcnew String(L"MyBurnVariable2"), nullptr));
+                Assert::Equal<String^>(gcnew String(L"1.0-beta"), (String^)Registry::GetValue(gcnew String(TEST_VARIABLE_KEY), gcnew String(L"MyBurnVariable3"), nullptr));
+                Assert::Empty((System::Collections::IEnumerable^)Registry::GetValue(gcnew String(TEST_VARIABLE_KEY), gcnew String(L"WixBundleForcedRestartPackage"), nullptr));
+
+                hr = BundleGetBundleVariable(TEST_BUNDLE_ID, L"MyBurnVariable1", &sczValue);
+                TestThrowOnFailure(hr, L"Failed to read MyBurnVariable1.");
+                Assert::Equal<String^>(gcnew String(L"42"), gcnew String(sczValue));
+
                 // read interrupted resume type
                 hr = RegistrationDetectResumeType(&registration, &resumeType);
                 TestThrowOnFailure(hr, L"Failed to read interrupted resume type.");
@@ -591,8 +748,11 @@ namespace Bootstrapper
                 hr = RegistrationLoadState(&registration, &pbBuffer, &cbBuffer);
                 TestThrowOnFailure(hr, L"Failed to load state.");
 
-                Assert::Equal((SIZE_T)sizeof(rgbData), cbBuffer);
-                Assert::True(0 == memcmp(pbBuffer, rgbData, sizeof(rgbData)));
+                hr = VariableDeserialize(&variables, TRUE, pbBuffer, cbBuffer, &piBuffer);
+                TestThrowOnFailure(hr, L"Failed to deserialize variables.");
+
+                //Assert::Equal((SIZE_T)sizeof(rgbData), cbBuffer);
+                //Assert::True(0 == memcmp(pbBuffer, rgbData, sizeof(rgbData)));
 
                 // write active resume mode
                 hr = RegistrationSessionResume(&registration, &variables, BOOTSTRAPPER_REGISTRATION_TYPE_INPROGRESS);
diff --git a/src/burn/test/BurnUnitTest/precomp.h b/src/burn/test/BurnUnitTest/precomp.h
index d2b57d61..78c44d39 100644
--- a/src/burn/test/BurnUnitTest/precomp.h
+++ b/src/burn/test/BurnUnitTest/precomp.h
@@ -30,6 +30,7 @@
 #include <xmlutil.h>
 #include <dictutil.h>
 #include <deputil.h>
+#include <butil.h>
 
 #include "BootstrapperEngine.h"
 #include "BootstrapperApplication.h"
diff --git a/src/libs/dutil/WixToolset.DUtil/butil.cpp b/src/libs/dutil/WixToolset.DUtil/butil.cpp
index e04b52e9..cda2a658 100644
--- a/src/libs/dutil/WixToolset.DUtil/butil.cpp
+++ b/src/libs/dutil/WixToolset.DUtil/butil.cpp
@@ -20,6 +20,7 @@
 const LPCWSTR BUNDLE_REGISTRATION_REGISTRY_UNINSTALL_KEY = L"SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall";
 const LPCWSTR BUNDLE_REGISTRATION_REGISTRY_BUNDLE_UPGRADE_CODE = L"BundleUpgradeCode";
 const LPCWSTR BUNDLE_REGISTRATION_REGISTRY_BUNDLE_PROVIDER_KEY = L"BundleProviderKey";
+const LPCWSTR BUNDLE_REGISTRATION_REGISTRY_BUNDLE_VARIABLE_KEY = L"variables";
 
 // Forward declarations.
 /********************************************************************
@@ -29,10 +30,13 @@ NOTE: caller is responsible for closing key
 ********************************************************************/
 static HRESULT OpenBundleKey(
     __in_z LPCWSTR wzBundleId,
-    __in BUNDLE_INSTALL_CONTEXT context, 
-    __inout HKEY *key);
-
+    __in BUNDLE_INSTALL_CONTEXT context,
+    __in_opt LPCWSTR szSubKey,
+    __inout HKEY* key);
 
+/********************************************************************
+BundleGetBundleInfo - Read the registration data for a gven bundle
+********************************************************************/
 extern "C" HRESULT DAPI BundleGetBundleInfo(
   __in_z LPCWSTR wzBundleId,
   __in_z LPCWSTR wzAttribute,
@@ -43,7 +47,6 @@ extern "C" HRESULT DAPI BundleGetBundleInfo(
     Assert(wzBundleId && wzAttribute);
 
     HRESULT hr = S_OK;
-    BUNDLE_INSTALL_CONTEXT context = BUNDLE_INSTALL_CONTEXT_MACHINE;
     LPWSTR sczValue = NULL;
     HKEY hkBundle = NULL;
     DWORD cchSource = 0;
@@ -55,8 +58,8 @@ extern "C" HRESULT DAPI BundleGetBundleInfo(
         ButilExitOnFailure(hr = E_INVALIDARG, "An invalid parameter was passed to the function.");
     }
 
-    if (FAILED(hr = OpenBundleKey(wzBundleId, context = BUNDLE_INSTALL_CONTEXT_MACHINE, &hkBundle)) &&
-        FAILED(hr = OpenBundleKey(wzBundleId, context = BUNDLE_INSTALL_CONTEXT_USER, &hkBundle)))
+    if (FAILED(hr = OpenBundleKey(wzBundleId, BUNDLE_INSTALL_CONTEXT_MACHINE, NULL, &hkBundle)) &&
+        FAILED(hr = OpenBundleKey(wzBundleId, BUNDLE_INSTALL_CONTEXT_USER, NULL, &hkBundle)))
     {
         ButilExitOnFailure(E_FILENOTFOUND == hr ? HRESULT_FROM_WIN32(ERROR_UNKNOWN_PRODUCT) : hr, "Failed to locate bundle uninstall key path.");
     }
@@ -108,7 +111,10 @@ LExit:
     return hr;
 }
 
-HRESULT DAPI BundleEnumRelatedBundle(
+/********************************************************************
+********************************************************************/
+
+extern "C" HRESULT DAPI BundleEnumRelatedBundle(
   __in_z LPCWSTR wzUpgradeCode,
   __in BUNDLE_INSTALL_CONTEXT context,
   __inout PDWORD pdwStartIndex,
@@ -231,11 +237,80 @@ LExit:
     return hr;
 }
 
+/********************************************************************
+BundleGetBundleVariable - Queries the bundle installation metadata for a given variable,
+the caller is expected to free the memory returned vis psczValue
+RETURNS:
+S_OK
+ Success, if the variable had a value, it's returned in psczValue
+E_INVALIDARG
+ An invalid parameter was passed to the function.
+HRESULT_FROM_WIN32(ERROR_UNKNOWN_PRODUCT)
+ The bundle is not installed
+HRESULT_FROM_WIN32(ERROR_UNKNOWN_PROPERTY)
+ The variable is unrecognized
+E_NOTIMPL:
+ Tried to read a bundle variable for a type which has not been implemented
+
+All other returns are unexpected returns from other dutil methods.
+********************************************************************/
+
+extern "C" HRESULT DAPI BundleGetBundleVariable(
+    __in_z LPCWSTR wzBundleId,
+    __in_z LPCWSTR wzVariable,
+    __deref_out_z LPWSTR * psczValue
+)
+{
+    Assert(wzBundleId && wzVariable);
+
+    HRESULT hr = S_OK;
+    BUNDLE_INSTALL_CONTEXT context = BUNDLE_INSTALL_CONTEXT_MACHINE;
+    HKEY hkBundle = NULL;
+    DWORD dwType = 0;
+
+    if (!wzBundleId || !wzVariable || !psczValue)
+    {
+        ButilExitOnFailure(hr = E_INVALIDARG, "An invalid parameter was passed to the function.");
+    }
+
+    if (FAILED(hr = OpenBundleKey(wzBundleId, context = BUNDLE_INSTALL_CONTEXT_MACHINE, BUNDLE_REGISTRATION_REGISTRY_BUNDLE_VARIABLE_KEY, &hkBundle)) &&
+        FAILED(hr = OpenBundleKey(wzBundleId, context = BUNDLE_INSTALL_CONTEXT_USER, BUNDLE_REGISTRATION_REGISTRY_BUNDLE_VARIABLE_KEY, &hkBundle)))
+    {
+        ButilExitOnFailure(E_FILENOTFOUND == hr ? HRESULT_FROM_WIN32(ERROR_UNKNOWN_PRODUCT) : hr, "Failed to locate bundle uninstall key variable path.");
+    }
+
+    // If the bundle doesn't have the shared variable defined, return ERROR_UNKNOWN_PROPERTY
+    hr = RegGetType(hkBundle, wzVariable, &dwType);
+    ButilExitOnFailure(E_FILENOTFOUND == hr ? HRESULT_FROM_WIN32(ERROR_UNKNOWN_PROPERTY) : hr, "Failed to locate bundle variable.");
+
+    switch (dwType)
+    {
+    case REG_SZ:
+        hr = RegReadString(hkBundle, wzVariable, psczValue);
+        ButilExitOnFailure(hr, "Failed to read string shared variable.");
+        break;
+    case REG_NONE:
+        hr = S_OK;
+        break;
+    default:
+        ButilExitOnFailure(hr = E_NOTIMPL, "Reading bundle variable of type 0x%x not implemented.", dwType);
+
+    }
+
+LExit:
+    ReleaseRegKey(hkBundle);
 
+    return hr;
+
+}
+/********************************************************************
+*
+********************************************************************/
 HRESULT OpenBundleKey(
     __in_z LPCWSTR wzBundleId,
-    __in BUNDLE_INSTALL_CONTEXT context, 
-    __inout HKEY *key)
+    __in BUNDLE_INSTALL_CONTEXT context,
+    __in_opt LPCWSTR szSubKey,
+    __inout HKEY* key)
 {
     Assert(key && wzBundleId);
     AssertSz(NULL == *key, "*key should be null");
@@ -244,9 +319,16 @@ HRESULT OpenBundleKey(
     HKEY hkRoot = BUNDLE_INSTALL_CONTEXT_USER == context ? HKEY_CURRENT_USER : HKEY_LOCAL_MACHINE;
     LPWSTR sczKeypath = NULL;
 
-    hr = StrAllocFormatted(&sczKeypath, L"%ls\\%ls", BUNDLE_REGISTRATION_REGISTRY_UNINSTALL_KEY, wzBundleId);
+    if (szSubKey)
+    {
+        hr = StrAllocFormatted(&sczKeypath, L"%ls\\%ls\\%ls", BUNDLE_REGISTRATION_REGISTRY_UNINSTALL_KEY, wzBundleId, szSubKey);
+    }
+    else
+    {
+        hr = StrAllocFormatted(&sczKeypath, L"%ls\\%ls", BUNDLE_REGISTRATION_REGISTRY_UNINSTALL_KEY, wzBundleId);
+    }
     ButilExitOnFailure(hr, "Failed to allocate bundle uninstall key path.");
-    
+
     hr = RegOpen(hkRoot, sczKeypath, KEY_READ, key);
     ButilExitOnFailure(hr, "Failed to open bundle uninstall key path.");
 
@@ -255,3 +337,4 @@ LExit:
 
     return hr;
 }
+
diff --git a/src/libs/dutil/WixToolset.DUtil/inc/butil.h b/src/libs/dutil/WixToolset.DUtil/inc/butil.h
index d1ec73bc..d910c113 100644
--- a/src/libs/dutil/WixToolset.DUtil/inc/butil.h
+++ b/src/libs/dutil/WixToolset.DUtil/inc/butil.h
@@ -6,11 +6,11 @@
 extern "C" {
 #endif
 
-enum BUNDLE_INSTALL_CONTEXT
+typedef enum BUNDLE_INSTALL_CONTEXT
 {
     BUNDLE_INSTALL_CONTEXT_MACHINE,
     BUNDLE_INSTALL_CONTEXT_USER,
-};
+} BUNDLE_INSTALL_CONTEXT;
 
 
 /********************************************************************
@@ -55,6 +55,13 @@ HRESULT DAPI BundleEnumRelatedBundle(
   __out_ecount(MAX_GUID_CHARS+1)  LPWSTR lpBundleIdBuf
     );
 
+HRESULT DAPI BundleGetBundleVariable(
+    __in_z LPCWSTR wzBundleId,
+    __in_z LPCWSTR wzVariable,
+    __deref_out_z LPWSTR* psczValue
+);
+
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/src/libs/dutil/WixToolset.DUtil/inc/regutil.h b/src/libs/dutil/WixToolset.DUtil/inc/regutil.h
index 75284940..fcf13054 100644
--- a/src/libs/dutil/WixToolset.DUtil/inc/regutil.h
+++ b/src/libs/dutil/WixToolset.DUtil/inc/regutil.h
@@ -178,6 +178,10 @@ HRESULT DAPI RegReadVersion(
     __in_z_opt LPCWSTR wzName,
     __out DWORD64* pdw64Version
     );
+HRESULT DAPI RegReadNone(
+    __in HKEY hk,
+    __in_z_opt LPCWSTR wzName
+);
 HRESULT DAPI RegReadNumber(
     __in HKEY hk,
     __in_z_opt LPCWSTR wzName,
@@ -211,6 +215,10 @@ HRESULT DAPI RegWriteStringFormatted(
     __in __format_string LPCWSTR szFormat,
     ...
     );
+HRESULT DAPI RegWriteNone(
+    __in HKEY hk,
+    __in_z_opt LPCWSTR wzName
+);
 HRESULT DAPI RegWriteNumber(
     __in HKEY hk,
     __in_z_opt LPCWSTR wzName,
diff --git a/src/libs/dutil/WixToolset.DUtil/regutil.cpp b/src/libs/dutil/WixToolset.DUtil/regutil.cpp
index cb617932..458d8586 100644
--- a/src/libs/dutil/WixToolset.DUtil/regutil.cpp
+++ b/src/libs/dutil/WixToolset.DUtil/regutil.cpp
@@ -672,6 +672,34 @@ LExit:
     return hr;
 }
 
+/********************************************************************
+ RegReadNone - reads a NONE registry key value.
+
+*********************************************************************/
+extern "C" HRESULT DAPI RegReadNone(
+    __in HKEY hk,
+    __in_z_opt LPCWSTR wzName)
+{
+    HRESULT hr = S_OK;
+    DWORD er = ERROR_SUCCESS;
+    DWORD dwType = 0;
+
+    er = vpfnRegQueryValueExW(hk, wzName, NULL, &dwType, NULL, NULL);
+    if (E_FILENOTFOUND == HRESULT_FROM_WIN32(er))
+    {
+        ExitFunction1(hr = E_FILENOTFOUND);
+    }
+    RegExitOnWin32Error(er, hr, "Failed to query registry key value.");
+
+    if (REG_NONE != dwType)
+    {
+        hr = HRESULT_FROM_WIN32(ERROR_INVALID_DATATYPE);
+        RegExitOnRootFailure(hr, "Error reading version registry value due to unexpected data type: %u", dwType);
+    }
+
+LExit:
+    return hr;
+}
 
 /********************************************************************
  RegReadNumber - reads a DWORD registry key value as a number.
@@ -885,6 +913,25 @@ LExit:
     return hr;
 }
 
+/********************************************************************
+ RegWriteNone - writes a registry key value as none.
+
+*********************************************************************/
+extern "C" HRESULT DAPI RegWriteNone(
+    __in HKEY hk,
+    __in_z_opt LPCWSTR wzName
+)
+{
+    HRESULT hr = S_OK;
+    DWORD er = ERROR_SUCCESS;
+
+    er = vpfnRegSetValueExW(hk, wzName, 0, REG_NONE, NULL, NULL);
+    RegExitOnWin32Error(er, hr, "Failed to set %ls value.", wzName);
+
+LExit:
+    return hr;
+}
+
 /********************************************************************
  RegWriteNumber - writes a registry key value as a number.
 
-- 
cgit v1.2.3-55-g6feb