Integrate ForwardCompatible and RelatedBundle changes in Burn headers.

8 files changed, 68 insertions, 11 deletions

diff --git a/src/balutil/balutil.vcxproj b/src/balutil/balutil.vcxproj
index 1c9a2372..2510b966 100644
--- a/src/balutil/balutil.vcxproj
+++ b/src/balutil/balutil.vcxproj
@@ -2,7 +2,7 @@
 <!-- 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.BootstrapperCore.Native.4.0.94\build\WixToolset.BootstrapperCore.Native.props" Condition="Exists('..\..\packages\WixToolset.BootstrapperCore.Native.4.0.94\build\WixToolset.BootstrapperCore.Native.props')" />
+  <Import Project="..\..\packages\WixToolset.BootstrapperCore.Native.4.0.99\build\WixToolset.BootstrapperCore.Native.props" Condition="Exists('..\..\packages\WixToolset.BootstrapperCore.Native.4.0.99\build\WixToolset.BootstrapperCore.Native.props')" />
   <Import Project="..\..\packages\WixToolset.DUtil.4.0.64\build\WixToolset.DUtil.props" Condition="Exists('..\..\packages\WixToolset.DUtil.4.0.64\build\WixToolset.DUtil.props')" />
 
   <ItemGroup Label="ProjectConfigurations">
@@ -98,7 +98,7 @@
     <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.BootstrapperCore.Native.4.0.94\build\WixToolset.BootstrapperCore.Native.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\WixToolset.BootstrapperCore.Native.4.0.94\build\WixToolset.BootstrapperCore.Native.props'))" />
+    <Error Condition="!Exists('..\..\packages\WixToolset.BootstrapperCore.Native.4.0.99\build\WixToolset.BootstrapperCore.Native.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\WixToolset.BootstrapperCore.Native.4.0.99\build\WixToolset.BootstrapperCore.Native.props'))" />
     <Error Condition="!Exists('..\..\packages\WixToolset.DUtil.4.0.64\build\WixToolset.DUtil.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\WixToolset.DUtil.4.0.64\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>
diff --git a/src/balutil/inc/BAFunctions.h b/src/balutil/inc/BAFunctions.h
index 6d36ad8c..66852efa 100644
--- a/src/balutil/inc/BAFunctions.h
+++ b/src/balutil/inc/BAFunctions.h
@@ -73,6 +73,7 @@ enum BA_FUNCTIONS_MESSAGE
     BA_FUNCTIONS_MESSAGE_ONSYSTEMRESTOREPOINTBEGIN = BOOTSTRAPPER_APPLICATION_MESSAGE_ONSYSTEMRESTOREPOINTBEGIN,
     BA_FUNCTIONS_MESSAGE_ONSYSTEMRESTOREPOINTCOMPLETE = BOOTSTRAPPER_APPLICATION_MESSAGE_ONSYSTEMRESTOREPOINTCOMPLETE,
     BA_FUNCTIONS_MESSAGE_ONPLANNEDPACKAGE = BOOTSTRAPPER_APPLICATION_MESSAGE_ONPLANNEDPACKAGE,
+    BA_FUNCTIONS_MESSAGE_ONPLANFORWARDCOMPATIBLEBUNDLE = BOOTSTRAPPER_APPLICATION_MESSAGE_ONPLANFORWARDCOMPATIBLEBUNDLE,
 
     BA_FUNCTIONS_MESSAGE_ONTHEMELOADED = 1024,
     BA_FUNCTIONS_MESSAGE_WNDPROC,
diff --git a/src/balutil/inc/BalBaseBAFunctions.h b/src/balutil/inc/BalBaseBAFunctions.h
index 55ed8cbe..0164269c 100644
--- a/src/balutil/inc/BalBaseBAFunctions.h
+++ b/src/balutil/inc/BalBaseBAFunctions.h
@@ -104,8 +104,8 @@ public: // IBootstrapperApplication
         __in_z LPCWSTR /*wzBundleTag*/,
         __in BOOL /*fPerMachine*/,
         __in LPCWSTR /*wzVersion*/,
-        __inout BOOL* /*pfCancel*/,
-        __inout BOOL* /*pfIgnoreBundle*/
+        __in BOOL /*fMissingFromCache*/,
+        __inout BOOL* /*pfCancel*/
         )
     {
         return S_OK;
@@ -150,6 +150,7 @@ public: // IBootstrapperApplication
         __in BOOL /*fPerMachine*/,
         __in LPCWSTR /*wzVersion*/,
         __in BOOTSTRAPPER_RELATED_OPERATION /*operation*/,
+        __in BOOL /*fMissingFromCache*/,
         __inout BOOL* /*pfCancel*/
         )
     {
@@ -660,6 +661,20 @@ public: // IBootstrapperApplication
         return S_OK;
     }
 
+    virtual STDMETHODIMP OnPlanForwardCompatibleBundle(
+        __in_z LPCWSTR /*wzBundleId*/,
+        __in BOOTSTRAPPER_RELATION_TYPE /*relationType*/,
+        __in_z LPCWSTR /*wzBundleTag*/,
+        __in BOOL /*fPerMachine*/,
+        __in LPCWSTR /*wzVersion*/,
+        __in BOOL /*fRecommendedIgnoreBundle*/,
+        __inout BOOL* /*pfCancel*/,
+        __inout BOOL* /*pfIgnoreBundle*/
+        )
+    {
+        return S_OK;
+    }
+
     virtual STDMETHODIMP_(HRESULT) BAProc(
         __in BOOTSTRAPPER_APPLICATION_MESSAGE /*message*/,
         __in const LPVOID /*pvArgs*/,
diff --git a/src/balutil/inc/BalBaseBAFunctionsProc.h b/src/balutil/inc/BalBaseBAFunctionsProc.h
index 1b11c300..e1de800a 100644
--- a/src/balutil/inc/BalBaseBAFunctionsProc.h
+++ b/src/balutil/inc/BalBaseBAFunctionsProc.h
@@ -108,6 +108,7 @@ static HRESULT WINAPI BalBaseBAFunctionsProc(
         case BA_FUNCTIONS_MESSAGE_ONSYSTEMRESTOREPOINTBEGIN:
         case BA_FUNCTIONS_MESSAGE_ONSYSTEMRESTOREPOINTCOMPLETE:
         case BA_FUNCTIONS_MESSAGE_ONPLANNEDPACKAGE:
+        case BA_FUNCTIONS_MESSAGE_ONPLANFORWARDCOMPATIBLEBUNDLE:
             hr = BalBaseBootstrapperApplicationProc((BOOTSTRAPPER_APPLICATION_MESSAGE)message, pvArgs, pvResults, pvContext);
             break;
         case BA_FUNCTIONS_MESSAGE_ONTHEMELOADED:
diff --git a/src/balutil/inc/BalBaseBootstrapperApplication.h b/src/balutil/inc/BalBaseBootstrapperApplication.h
index ff1d07fd..c9211e0f 100644
--- a/src/balutil/inc/BalBaseBootstrapperApplication.h
+++ b/src/balutil/inc/BalBaseBootstrapperApplication.h
@@ -102,8 +102,8 @@ public: // IBootstrapperApplication
         __in_z LPCWSTR /*wzBundleTag*/,
         __in BOOL /*fPerMachine*/,
         __in LPCWSTR /*wzVersion*/,
-        __inout BOOL* pfCancel,
-        __inout BOOL* /*pfIgnoreBundle*/
+        __in BOOL /*fMissingFromCache*/,
+        __inout BOOL* pfCancel
         )
     {
         *pfCancel |= CheckCanceled();
@@ -151,6 +151,7 @@ public: // IBootstrapperApplication
         __in BOOL /*fPerMachine*/,
         __in LPCWSTR /*wzVersion*/,
         __in BOOTSTRAPPER_RELATED_OPERATION /*operation*/,
+        __in BOOL /*fMissingFromCache*/,
         __inout BOOL* pfCancel
         )
     {
@@ -845,6 +846,21 @@ public: // IBootstrapperApplication
         return S_OK;
     }
 
+    virtual STDMETHODIMP OnPlanForwardCompatibleBundle(
+        __in_z LPCWSTR /*wzBundleId*/,
+        __in BOOTSTRAPPER_RELATION_TYPE /*relationType*/,
+        __in_z LPCWSTR /*wzBundleTag*/,
+        __in BOOL /*fPerMachine*/,
+        __in LPCWSTR /*wzVersion*/,
+        __in BOOL /*fRecommendedIgnoreBundle*/,
+        __inout BOOL* pfCancel,
+        __inout BOOL* /*pfIgnoreBundle*/
+        )
+    {
+        *pfCancel |= CheckCanceled();
+        return S_OK;
+    }
+
     virtual STDMETHODIMP_(HRESULT) BAProc(
         __in BOOTSTRAPPER_APPLICATION_MESSAGE /*message*/,
         __in const LPVOID /*pvArgs*/,
diff --git a/src/balutil/inc/BalBaseBootstrapperApplicationProc.h b/src/balutil/inc/BalBaseBootstrapperApplicationProc.h
index d971a2eb..d8a6590b 100644
--- a/src/balutil/inc/BalBaseBootstrapperApplicationProc.h
+++ b/src/balutil/inc/BalBaseBootstrapperApplicationProc.h
@@ -78,7 +78,7 @@ static HRESULT BalBaseBAProcOnDetectForwardCompatibleBundle(
     __inout BA_ONDETECTFORWARDCOMPATIBLEBUNDLE_RESULTS* pResults
     )
 {
-    return pBA->OnDetectForwardCompatibleBundle(pArgs->wzBundleId, pArgs->relationType, pArgs->wzBundleTag, pArgs->fPerMachine, pArgs->wzVersion, &pResults->fCancel, &pResults->fIgnoreBundle);
+    return pBA->OnDetectForwardCompatibleBundle(pArgs->wzBundleId, pArgs->relationType, pArgs->wzBundleTag, pArgs->fPerMachine, pArgs->wzVersion, pArgs->fMissingFromCache, &pResults->fCancel);
 }
 
 static HRESULT BalBaseBAProcOnDetectUpdateBegin(
@@ -114,7 +114,7 @@ static HRESULT BalBaseBAProcOnDetectRelatedBundle(
     __inout BA_ONDETECTRELATEDBUNDLE_RESULTS* pResults
     )
 {
-    return pBA->OnDetectRelatedBundle(pArgs->wzBundleId, pArgs->relationType, pArgs->wzBundleTag, pArgs->fPerMachine, pArgs->wzVersion, pArgs->operation, &pResults->fCancel);
+    return pBA->OnDetectRelatedBundle(pArgs->wzBundleId, pArgs->relationType, pArgs->wzBundleTag, pArgs->fPerMachine, pArgs->wzVersion, pArgs->operation, pArgs->fMissingFromCache, &pResults->fCancel);
 }
 
 static HRESULT BalBaseBAProcOnDetectPackageBegin(
@@ -585,6 +585,15 @@ static HRESULT BalBaseBAProcOnSystemRestorePointComplete(
     return pBA->OnSystemRestorePointComplete(pArgs->hrStatus);
 }
 
+static HRESULT BalBaseBAProcOnPlanForwardCompatibleBundle(
+    __in IBootstrapperApplication* pBA,
+    __in BA_ONPLANFORWARDCOMPATIBLEBUNDLE_ARGS* pArgs,
+    __inout BA_ONPLANFORWARDCOMPATIBLEBUNDLE_RESULTS* pResults
+    )
+{
+    return pBA->OnPlanForwardCompatibleBundle(pArgs->wzBundleId, pArgs->relationType, pArgs->wzBundleTag, pArgs->fPerMachine, pArgs->wzVersion, pArgs->fRecommendedIgnoreBundle, &pResults->fCancel, &pResults->fIgnoreBundle);
+}
+
 /*******************************************************************
 BalBaseBootstrapperApplicationProc - requires pvContext to be of type IBootstrapperApplication.
                                      Provides a default mapping between the new message based BA interface and
@@ -796,6 +805,9 @@ static HRESULT WINAPI BalBaseBootstrapperApplicationProc(
         case BOOTSTRAPPER_APPLICATION_MESSAGE_ONPLANNEDPACKAGE:
             hr = BalBaseBAProcOnPlannedPackage(pBA, reinterpret_cast<BA_ONPLANNEDPACKAGE_ARGS*>(pvArgs), reinterpret_cast<BA_ONPLANNEDPACKAGE_RESULTS*>(pvResults));
             break;
+        case BOOTSTRAPPER_APPLICATION_MESSAGE_ONPLANFORWARDCOMPATIBLEBUNDLE:
+            hr = BalBaseBAProcOnPlanForwardCompatibleBundle(pBA, reinterpret_cast<BA_ONPLANFORWARDCOMPATIBLEBUNDLE_ARGS*>(pvArgs), reinterpret_cast<BA_ONPLANFORWARDCOMPATIBLEBUNDLE_RESULTS*>(pvResults));
+            break;
         }
     }
 
diff --git a/src/balutil/inc/IBootstrapperApplication.h b/src/balutil/inc/IBootstrapperApplication.h
index 01d0bb8a..ed70d8fe 100644
--- a/src/balutil/inc/IBootstrapperApplication.h
+++ b/src/balutil/inc/IBootstrapperApplication.h
@@ -33,8 +33,8 @@ DECLARE_INTERFACE_IID_(IBootstrapperApplication, IUnknown, "53C31D56-49C0-426B-A
         __in_z LPCWSTR wzBundleTag,
         __in BOOL fPerMachine,
         __in_z LPCWSTR wzVersion,
-        __inout BOOL* pfCancel,
-        __inout BOOL* pfIgnoreBundle
+        __in BOOL fMissingFromCache,
+        __inout BOOL* pfCancel
         ) = 0;
 
     // OnDetectUpdateBegin - called when the engine begins detection for bundle update.
@@ -71,6 +71,7 @@ DECLARE_INTERFACE_IID_(IBootstrapperApplication, IUnknown, "53C31D56-49C0-426B-A
         __in BOOL fPerMachine,
         __in_z LPCWSTR wzVersion,
         __in BOOTSTRAPPER_RELATED_OPERATION operation,
+        __in BOOL fMissingFromCache,
         __inout BOOL* pfCancel
         ) = 0;
 
@@ -540,6 +541,17 @@ DECLARE_INTERFACE_IID_(IBootstrapperApplication, IUnknown, "53C31D56-49C0-426B-A
         __in HRESULT hrStatus
         ) = 0;
 
+    STDMETHOD(OnPlanForwardCompatibleBundle)(
+        __in_z LPCWSTR wzBundleId,
+        __in BOOTSTRAPPER_RELATION_TYPE relationType,
+        __in_z LPCWSTR wzBundleTag,
+        __in BOOL fPerMachine,
+        __in_z LPCWSTR wzVersion,
+        __in BOOL fRecommendedIgnoreBundle,
+        __inout BOOL* pfCancel,
+        __inout BOOL* pfIgnoreBundle
+        ) = 0;
+
     // BAProc - The PFN_BOOTSTRAPPER_APPLICATION_PROC can call this method to give the BA raw access to the callback from the engine.
     //          This might be used to help the BA support more than one version of the engine.
     STDMETHOD(BAProc)(
diff --git a/src/balutil/packages.config b/src/balutil/packages.config
index 1ac5d2ac..76baf58e 100644
--- a/src/balutil/packages.config
+++ b/src/balutil/packages.config
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="Nerdbank.GitVersioning" version="3.3.37" targetFramework="native" developmentDependency="true" />
-  <package id="WixToolset.BootstrapperCore.Native" version="4.0.94" targetFramework="native" />
+  <package id="WixToolset.BootstrapperCore.Native" version="4.0.99" targetFramework="native" />
   <package id="WixToolset.DUtil" version="4.0.64" targetFramework="native" />
 </packages>
\ No newline at end of file