Integrate ForwardCompatible and RelatedBundle changes in Burn headers.

4 files changed, 134 insertions, 35 deletions

diff --git a/src/WixToolset.Mba.Core/BootstrapperApplication.cs b/src/WixToolset.Mba.Core/BootstrapperApplication.cs
index 1812c80b..b6c0dd0d 100644
--- a/src/WixToolset.Mba.Core/BootstrapperApplication.cs
+++ b/src/WixToolset.Mba.Core/BootstrapperApplication.cs
@@ -226,6 +226,9 @@ namespace WixToolset.Mba.Core
         /// <inheritdoc/>
         public event EventHandler<SystemRestorePointCompleteEventArgs> SystemRestorePointComplete;
 
+        /// <inheritdoc/>
+        public event EventHandler<PlanForwardCompatibleBundleEventArgs> PlanForwardCompatibleBundle;
+
         /// <summary>
         /// Entry point that is called when the bootstrapper application is ready to run.
         /// </summary>
@@ -1083,6 +1086,18 @@ namespace WixToolset.Mba.Core
             }
         }
 
+        /// <summary>
+        /// Called by the engine, raises the <see cref="PlanForwardCompatibleBundle"/> event.
+        /// </summary>
+        protected virtual void OnPlanForwardCompatibleBundle(PlanForwardCompatibleBundleEventArgs args)
+        {
+            EventHandler<PlanForwardCompatibleBundleEventArgs> handler = this.PlanForwardCompatibleBundle;
+            if (null != handler)
+            {
+                handler(this, args);
+            }
+        }
+
         #region IBootstrapperApplication Members
 
         int IBootstrapperApplication.OnStartup()
@@ -1120,13 +1135,12 @@ namespace WixToolset.Mba.Core
             return args.HResult;
         }
 
-        int IBootstrapperApplication.OnDetectForwardCompatibleBundle(string wzBundleId, RelationType relationType, string wzBundleTag, bool fPerMachine, string wzVersion, ref bool fCancel, ref bool fIgnoreBundle)
+        int IBootstrapperApplication.OnDetectForwardCompatibleBundle(string wzBundleId, RelationType relationType, string wzBundleTag, bool fPerMachine, string wzVersion, bool fMissingFromCache, ref bool fCancel)
         {
-            DetectForwardCompatibleBundleEventArgs args = new DetectForwardCompatibleBundleEventArgs(wzBundleId, relationType, wzBundleTag, fPerMachine, wzVersion, fCancel, fIgnoreBundle);
+            DetectForwardCompatibleBundleEventArgs args = new DetectForwardCompatibleBundleEventArgs(wzBundleId, relationType, wzBundleTag, fPerMachine, wzVersion, fMissingFromCache, fCancel);
             this.OnDetectForwardCompatibleBundle(args);
 
             fCancel = args.Cancel;
-            fIgnoreBundle = args.IgnoreBundle;
             return args.HResult;
         }
 
@@ -1159,9 +1173,9 @@ namespace WixToolset.Mba.Core
             return args.HResult;
         }
 
-        int IBootstrapperApplication.OnDetectRelatedBundle(string wzProductCode, RelationType relationType, string wzBundleTag, bool fPerMachine, string wzVersion, RelatedOperation operation, ref bool fCancel)
+        int IBootstrapperApplication.OnDetectRelatedBundle(string wzProductCode, RelationType relationType, string wzBundleTag, bool fPerMachine, string wzVersion, RelatedOperation operation, bool fMissingFromCache, ref bool fCancel)
         {
-            DetectRelatedBundleEventArgs args = new DetectRelatedBundleEventArgs(wzProductCode, relationType, wzBundleTag, fPerMachine, wzVersion, operation, fCancel);
+            DetectRelatedBundleEventArgs args = new DetectRelatedBundleEventArgs(wzProductCode, relationType, wzBundleTag, fPerMachine, wzVersion, operation, fMissingFromCache, fCancel);
             this.OnDetectRelatedBundle(args);
 
             fCancel = args.Cancel;
@@ -1656,6 +1670,16 @@ namespace WixToolset.Mba.Core
             return args.HResult;
         }
 
+        int IBootstrapperApplication.OnPlanForwardCompatibleBundle(string wzBundleId, RelationType relationType, string wzBundleTag, bool fPerMachine, string wzVersion, bool fRecommendedIgnoreBundle, ref bool fCancel, ref bool fIgnoreBundle)
+        {
+            PlanForwardCompatibleBundleEventArgs args = new PlanForwardCompatibleBundleEventArgs(wzBundleId, relationType, wzBundleTag, fPerMachine, wzVersion, fRecommendedIgnoreBundle, fCancel, fIgnoreBundle);
+            this.OnPlanForwardCompatibleBundle(args);
+
+            fCancel = args.Cancel;
+            fIgnoreBundle = args.IgnoreBundle;
+            return args.HResult;
+        }
+
         int IBootstrapperApplication.BAProc(int message, IntPtr pvArgs, IntPtr pvResults, IntPtr pvContext)
         {
             switch (message)
diff --git a/src/WixToolset.Mba.Core/EventArgs.cs b/src/WixToolset.Mba.Core/EventArgs.cs
index 56705769..7e7cbd11 100644
--- a/src/WixToolset.Mba.Core/EventArgs.cs
+++ b/src/WixToolset.Mba.Core/EventArgs.cs
@@ -226,22 +226,13 @@ namespace WixToolset.Mba.Core
     }
 
     /// <summary>
-    /// Additional arguments used when detected a forward compatible bundle.
+    /// Event arguments for <see cref="IDefaultBootstrapperApplication.DetectForwardCompatibleBundle"/>
     /// </summary>
     [Serializable]
     public class DetectForwardCompatibleBundleEventArgs : CancellableHResultEventArgs
     {
-        /// <summary>
-        /// Creates a new instance of the <see cref="DetectUpdateBeginEventArgs"/> class.
-        /// </summary>
-        /// <param name="bundleId">The identity of the forward compatible bundle.</param>
-        /// <param name="relationType">Relationship type for this forward compatible bundle.</param>
-        /// <param name="bundleTag">The tag of the forward compatible bundle.</param>
-        /// <param name="perMachine">Whether the detected forward compatible bundle is per machine.</param>
-        /// <param name="version">The version of the forward compatible bundle detected.</param>
-        /// <param name="cancelRecommendation">The cancel recommendation from the engine.</param>
-        /// <param name="ignoreBundleRecommendation">The ignore recommendation from the engine.</param>
-        public DetectForwardCompatibleBundleEventArgs(string bundleId, RelationType relationType, string bundleTag, bool perMachine, string version, bool cancelRecommendation, bool ignoreBundleRecommendation)
+        /// <summary />
+        public DetectForwardCompatibleBundleEventArgs(string bundleId, RelationType relationType, string bundleTag, bool perMachine, string version, bool missingFromCache, bool cancelRecommendation)
             : base(cancelRecommendation)
         {
             this.BundleId = bundleId;
@@ -249,7 +240,7 @@ namespace WixToolset.Mba.Core
             this.BundleTag = bundleTag;
             this.PerMachine = perMachine;
             this.Version = version;
-            this.IgnoreBundle = ignoreBundleRecommendation;
+            this.MissingFromCache = missingFromCache;
         }
 
         /// <summary>
@@ -278,9 +269,9 @@ namespace WixToolset.Mba.Core
         public string Version { get; private set; }
 
         /// <summary>
-        /// Instructs the engine whether to use the forward compatible bundle.
+        /// Whether the forward compatible bundle is missing from the package cache.
         /// </summary>
-        public bool IgnoreBundle { get; set; }
+        public bool MissingFromCache { get; set; }
     }
 
     /// <summary>
@@ -408,22 +399,13 @@ namespace WixToolset.Mba.Core
     }
 
     /// <summary>
-    /// Additional arguments used when a related bundle has been detected for a bundle.
+    /// Event arguments for <see cref="IDefaultBootstrapperApplication.DetectRelatedBundle"/>
     /// </summary>
     [Serializable]
     public class DetectRelatedBundleEventArgs : CancellableHResultEventArgs
     {
-        /// <summary>
-        /// Creates a new instance of the <see cref="DetectRelatedBundleEventArgs"/> class.
-        /// </summary>
-        /// <param name="productCode">The identity of the related package bundle.</param>
-        /// <param name="relationType">Relationship type for this related bundle.</param>
-        /// <param name="bundleTag">The tag of the related package bundle.</param>
-        /// <param name="perMachine">Whether the detected bundle is per machine.</param>
-        /// <param name="version">The version of the related bundle detected.</param>
-        /// <param name="operation">The operation that will be taken on the detected bundle.</param>
-        /// <param name="cancelRecommendation">The recommendation from the engine.</param>
-        public DetectRelatedBundleEventArgs(string productCode, RelationType relationType, string bundleTag, bool perMachine, string version, RelatedOperation operation, bool cancelRecommendation)
+        /// <summary />
+        public DetectRelatedBundleEventArgs(string productCode, RelationType relationType, string bundleTag, bool perMachine, string version, RelatedOperation operation, bool missingFromCache, bool cancelRecommendation)
             : base(cancelRecommendation)
         {
             this.ProductCode = productCode;
@@ -432,6 +414,7 @@ namespace WixToolset.Mba.Core
             this.PerMachine = perMachine;
             this.Version = version;
             this.Operation = operation;
+            this.MissingFromCache = missingFromCache;
         }
 
         /// <summary>
@@ -463,6 +446,11 @@ namespace WixToolset.Mba.Core
         /// Gets the operation that will be taken on the detected bundle.
         /// </summary>
         public RelatedOperation Operation { get; private set; }
+
+        /// <summary>
+        /// Whether the related bundle is missing from the package cache.
+        /// </summary>
+        public bool MissingFromCache { get; set; }
     }
 
     /// <summary>
@@ -1010,6 +998,61 @@ namespace WixToolset.Mba.Core
     }
 
     /// <summary>
+    /// Event arguments for <see cref="IDefaultBootstrapperApplication.PlanForwardCompatibleBundle"/>
+    /// </summary>
+    [Serializable]
+    public class PlanForwardCompatibleBundleEventArgs : CancellableHResultEventArgs
+    {
+        /// <summary />
+        public PlanForwardCompatibleBundleEventArgs(string bundleId, RelationType relationType, string bundleTag, bool perMachine, string version, bool recommendedIgnoreBundle, bool cancelRecommendation, bool ignoreBundle)
+            : base(cancelRecommendation)
+        {
+            this.BundleId = bundleId;
+            this.RelationType = relationType;
+            this.BundleTag = bundleTag;
+            this.PerMachine = perMachine;
+            this.Version = version;
+            this.RecommendedIgnoreBundle = recommendedIgnoreBundle;
+            this.IgnoreBundle = ignoreBundle;
+        }
+
+        /// <summary>
+        /// Gets the identity of the forward compatible bundle detected.
+        /// </summary>
+        public string BundleId { get; private set; }
+
+        /// <summary>
+        /// Gets the relationship type of the forward compatible bundle.
+        /// </summary>
+        public RelationType RelationType { get; private set; }
+
+        /// <summary>
+        /// Gets the tag of the forward compatible bundle.
+        /// </summary>
+        public string BundleTag { get; private set; }
+
+        /// <summary>
+        /// Gets whether the forward compatible bundle is per machine.
+        /// </summary>
+        public bool PerMachine { get; private set; }
+
+        /// <summary>
+        /// Gets the version of the forward compatible bundle.
+        /// </summary>
+        public string Version { get; private set; }
+
+        /// <summary>
+        /// Gets the recommendation of whether the engine should use the forward compatible bundle.
+        /// </summary>
+        public bool RecommendedIgnoreBundle { get; set; }
+
+        /// <summary>
+        /// Gets or sets whether the engine will use the forward compatible bundle.
+        /// </summary>
+        public bool IgnoreBundle { get; set; }
+    }
+
+    /// <summary>
     /// Additional arguments used when the engine has begun installing the bundle.
     /// </summary>
     [Serializable]
diff --git a/src/WixToolset.Mba.Core/IBootstrapperApplication.cs b/src/WixToolset.Mba.Core/IBootstrapperApplication.cs
index 4812c038..14cb8fd5 100644
--- a/src/WixToolset.Mba.Core/IBootstrapperApplication.cs
+++ b/src/WixToolset.Mba.Core/IBootstrapperApplication.cs
@@ -64,8 +64,8 @@ namespace WixToolset.Mba.Core
         /// <param name="wzBundleTag"></param>
         /// <param name="fPerMachine"></param>
         /// <param name="wzVersion"></param>
+        /// <param name="fMissingFromCache"></param>
         /// <param name="fCancel"></param>
-        /// <param name="fIgnoreBundle"></param>
         /// <returns></returns>
         [PreserveSig]
         [return: MarshalAs(UnmanagedType.I4)]
@@ -75,8 +75,8 @@ namespace WixToolset.Mba.Core
             [MarshalAs(UnmanagedType.LPWStr)] string wzBundleTag,
             [MarshalAs(UnmanagedType.Bool)] bool fPerMachine,
             [MarshalAs(UnmanagedType.LPWStr)] string wzVersion,
-            [MarshalAs(UnmanagedType.Bool)] ref bool fCancel,
-            [MarshalAs(UnmanagedType.Bool)] ref bool fIgnoreBundle
+            [MarshalAs(UnmanagedType.Bool)] bool fMissingFromCache,
+            [MarshalAs(UnmanagedType.Bool)] ref bool fCancel
             );
 
         /// <summary>
@@ -143,6 +143,7 @@ namespace WixToolset.Mba.Core
         /// <param name="fPerMachine"></param>
         /// <param name="wzVersion"></param>
         /// <param name="operation"></param>
+        /// <param name="fMissingFromCache"></param>
         /// <param name="fCancel"></param>
         /// <returns></returns>
         [PreserveSig]
@@ -154,6 +155,7 @@ namespace WixToolset.Mba.Core
             [MarshalAs(UnmanagedType.Bool)] bool fPerMachine,
             [MarshalAs(UnmanagedType.LPWStr)] string wzVersion,
             [MarshalAs(UnmanagedType.U4)] RelatedOperation operation,
+            [MarshalAs(UnmanagedType.Bool)] bool fMissingFromCache,
             [MarshalAs(UnmanagedType.Bool)] ref bool fCancel
             );
 
@@ -1001,6 +1003,31 @@ namespace WixToolset.Mba.Core
             );
 
         /// <summary>
+        /// See <see cref="IDefaultBootstrapperApplication.PlanForwardCompatibleBundle"/>.
+        /// </summary>
+        /// <param name="wzBundleId"></param>
+        /// <param name="relationType"></param>
+        /// <param name="wzBundleTag"></param>
+        /// <param name="fPerMachine"></param>
+        /// <param name="wzVersion"></param>
+        /// <param name="fRecommendedIgnoreBundle"></param>
+        /// <param name="fCancel"></param>
+        /// <param name="fIgnoreBundle"></param>
+        /// <returns></returns>
+        [PreserveSig]
+        [return: MarshalAs(UnmanagedType.I4)]
+        int OnPlanForwardCompatibleBundle(
+            [MarshalAs(UnmanagedType.LPWStr)] string wzBundleId,
+            [MarshalAs(UnmanagedType.U4)] RelationType relationType,
+            [MarshalAs(UnmanagedType.LPWStr)] string wzBundleTag,
+            [MarshalAs(UnmanagedType.Bool)] bool fPerMachine,
+            [MarshalAs(UnmanagedType.LPWStr)] string wzVersion,
+            [MarshalAs(UnmanagedType.Bool)] bool fRecommendedIgnoreBundle,
+            [MarshalAs(UnmanagedType.Bool)] ref bool fCancel,
+            [MarshalAs(UnmanagedType.Bool)] ref bool fIgnoreBundle
+            );
+
+        /// <summary>
         /// Low level method that is called directly from the engine.
         /// </summary>
         /// <param name="message"></param>
diff --git a/src/WixToolset.Mba.Core/IDefaultBootstrapperApplication.cs b/src/WixToolset.Mba.Core/IDefaultBootstrapperApplication.cs
index 5803a26a..269d4955 100644
--- a/src/WixToolset.Mba.Core/IDefaultBootstrapperApplication.cs
+++ b/src/WixToolset.Mba.Core/IDefaultBootstrapperApplication.cs
@@ -230,6 +230,11 @@ namespace WixToolset.Mba.Core
         event EventHandler<PlanCompleteEventArgs> PlanComplete;
 
         /// <summary>
+        /// Fired when the engine is about to plan a forward compatible bundle.
+        /// </summary>
+        event EventHandler<PlanForwardCompatibleBundleEventArgs> PlanForwardCompatibleBundle;
+
+        /// <summary>
         /// Fired when the engine has completed planning a package.
         /// </summary>
         event EventHandler<PlannedPackageEventArgs> PlannedPackage;