Add ability for non-vital cache package action.

4 files changed, 88 insertions, 13 deletions

diff --git a/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs b/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs
index bb34a33e..fe9322ce 100644
--- a/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs
+++ b/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs
@@ -280,6 +280,9 @@ namespace WixToolset.Mba.Core
         /// <inheritdoc/>
         public event EventHandler<DetectRelatedBundlePackageEventArgs> DetectRelatedBundlePackage;
 
+        /// <inheritdoc/>
+        public event EventHandler<CachePackageNonVitalValidationFailureEventArgs> CachePackageNonVitalValidationFailure;
+
         /// <summary>
         /// Entry point that is called when the bootstrapper application is ready to run.
         /// </summary>
@@ -1376,6 +1379,18 @@ namespace WixToolset.Mba.Core
             }
         }
 
+        /// <summary>
+        /// Called by the engine, raises the <see cref="CachePackageNonVitalValidationFailure"/> event.
+        /// </summary>
+        protected virtual void OnCachePackageNonVitalValidationFailure(CachePackageNonVitalValidationFailureEventArgs args)
+        {
+            EventHandler<CachePackageNonVitalValidationFailureEventArgs> handler = this.CachePackageNonVitalValidationFailure;
+            if (null != handler)
+            {
+                handler(this, args);
+            }
+        }
+
         #region IBootstrapperApplication Members
 
         int IBootstrapperApplication.BAProc(int message, IntPtr pvArgs, IntPtr pvResults, IntPtr pvContext)
@@ -1570,6 +1585,7 @@ namespace WixToolset.Mba.Core
             this.OnPlanPackageBegin(args);
 
             pRequestedState = args.State;
+            pRequestedCacheType = args.CacheType;
             fCancel = args.Cancel;
             return args.HResult;
         }
@@ -1728,9 +1744,9 @@ namespace WixToolset.Mba.Core
             return args.HResult;
         }
 
-        int IBootstrapperApplication.OnCachePackageBegin(string wzPackageId, int cCachePayloads, long dw64PackageCacheSize, ref bool fCancel)
+        int IBootstrapperApplication.OnCachePackageBegin(string wzPackageId, int cCachePayloads, long dw64PackageCacheSize, bool fVital, ref bool fCancel)
         {
-            CachePackageBeginEventArgs args = new CachePackageBeginEventArgs(wzPackageId, cCachePayloads, dw64PackageCacheSize, fCancel);
+            CachePackageBeginEventArgs args = new CachePackageBeginEventArgs(wzPackageId, cCachePayloads, dw64PackageCacheSize, fVital, fCancel);
             this.OnCachePackageBegin(args);
 
             fCancel = args.Cancel;
@@ -2131,6 +2147,15 @@ namespace WixToolset.Mba.Core
             return args.HResult;
         }
 
+        int IBootstrapperApplication.OnCachePackageNonVitalValidationFailure(string wzPackageId, int hrStatus, BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION recommendation, ref BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION action)
+        {
+            CachePackageNonVitalValidationFailureEventArgs args = new CachePackageNonVitalValidationFailureEventArgs(wzPackageId, hrStatus, recommendation, action);
+            this.OnCachePackageNonVitalValidationFailure(args);
+
+            action = args.Action;
+            return args.HResult;
+        }
+
         #endregion
     }
 }
diff --git a/src/api/burn/WixToolset.Mba.Core/EventArgs.cs b/src/api/burn/WixToolset.Mba.Core/EventArgs.cs
index be113700..2b414d91 100644
--- a/src/api/burn/WixToolset.Mba.Core/EventArgs.cs
+++ b/src/api/burn/WixToolset.Mba.Core/EventArgs.cs
@@ -1930,12 +1930,13 @@ namespace WixToolset.Mba.Core
     public class CachePackageBeginEventArgs : CancellableHResultEventArgs
     {
         /// <summary />
-        public CachePackageBeginEventArgs(string packageId, int cachePayloads, long packageCacheSize, bool cancelRecommendation)
+        public CachePackageBeginEventArgs(string packageId, int cachePayloads, long packageCacheSize, bool vital, bool cancelRecommendation)
             : base(cancelRecommendation)
         {
             this.PackageId = packageId;
             this.CachePayloads = cachePayloads;
             this.PackageCacheSize = packageCacheSize;
+            this.Vital = vital;
         }
 
         /// <summary>
@@ -1952,6 +1953,11 @@ namespace WixToolset.Mba.Core
         /// Gets the size on disk required by the specific package.
         /// </summary>
         public long PackageCacheSize { get; private set; }
+
+        /// <summary>
+        /// If caching a package is not vital, then acquisition will be skipped unless the BA opts in through <see cref="IDefaultBootstrapperApplication.CachePackageNonVitalValidationFailure"/>.
+        /// </summary>
+        public bool Vital { get; private set; }
     }
 
     /// <summary>
@@ -2482,4 +2488,23 @@ namespace WixToolset.Mba.Core
         /// </summary>
         public string Version { get; private set; }
     }
+
+    /// <summary>
+    /// Event arguments for <see cref="IDefaultBootstrapperApplication.CachePackageNonVitalValidationFailure"/>
+    /// </summary>
+    [Serializable]
+    public class CachePackageNonVitalValidationFailureEventArgs : ActionEventArgs<BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION>
+    {
+        /// <summary />
+        public CachePackageNonVitalValidationFailureEventArgs(string packageId, int hrStatus, BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION recommendation, BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION action)
+            : base(hrStatus, recommendation, action)
+        {
+            this.PackageId = packageId;
+        }
+
+        /// <summary>
+        /// Gets the identity of the package that was being validated.
+        /// </summary>
+        public string PackageId { get; private set; }
+    }
 }
diff --git a/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs b/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs
index 8ce99808..87da2191 100644
--- a/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs
+++ b/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs
@@ -553,17 +553,13 @@ namespace WixToolset.Mba.Core
         /// <summary>
         /// See <see cref="IDefaultBootstrapperApplication.CachePackageBegin"/>.
         /// </summary>
-        /// <param name="wzPackageId"></param>
-        /// <param name="cCachePayloads"></param>
-        /// <param name="dw64PackageCacheSize"></param>
-        /// <param name="fCancel"></param>
-        /// <returns></returns>
         [PreserveSig]
         [return: MarshalAs(UnmanagedType.I4)]
         int OnCachePackageBegin(
             [MarshalAs(UnmanagedType.LPWStr)] string wzPackageId,
             [MarshalAs(UnmanagedType.U4)] int cCachePayloads,
             [MarshalAs(UnmanagedType.U8)] long dw64PackageCacheSize,
+            [MarshalAs(UnmanagedType.Bool)] bool fVital,
             [MarshalAs(UnmanagedType.Bool)] ref bool fCancel
             );
 
@@ -672,11 +668,6 @@ namespace WixToolset.Mba.Core
         /// <summary>
         /// See <see cref="IDefaultBootstrapperApplication.CachePackageComplete"/>.
         /// </summary>
-        /// <param name="wzPackageId"></param>
-        /// <param name="hrStatus"></param>
-        /// <param name="recommendation"></param>
-        /// <param name="action"></param>
-        /// <returns></returns>
         [PreserveSig]
         [return: MarshalAs(UnmanagedType.I4)]
         int OnCachePackageComplete(
@@ -1184,6 +1175,18 @@ namespace WixToolset.Mba.Core
             [MarshalAs(UnmanagedType.LPWStr)] string wzVersion,
             [MarshalAs(UnmanagedType.Bool)] ref bool fCancel
             );
+
+        /// <summary>
+        /// See <see cref="IDefaultBootstrapperApplication.CachePackageNonVitalValidationFailure"/>.
+        /// </summary>
+        [PreserveSig]
+        [return: MarshalAs(UnmanagedType.I4)]
+        int OnCachePackageNonVitalValidationFailure(
+            [MarshalAs(UnmanagedType.LPWStr)] string wzPackageId,
+            int hrStatus,
+            BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION recommendation,
+            ref BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION action
+            );
     }
 
     /// <summary>
@@ -1871,6 +1874,23 @@ namespace WixToolset.Mba.Core
     }
 
     /// <summary>
+    /// The available actions for <see cref="IDefaultBootstrapperApplication.CachePackageNonVitalValidationFailure"/>
+    /// </summary>
+    public enum BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION
+    {
+        /// <summary>
+        /// 
+        /// </summary>
+        None,
+
+        /// <summary>
+        /// Instructs the engine to try to acquire the package so execution can use it.
+        /// Most of the time this is used for installing the package during rollback.
+        /// </summary>
+        Acquire,
+    }
+
+    /// <summary>
     /// The available actions for <see cref="IDefaultBootstrapperApplication.CacheVerifyComplete"/>.
     /// </summary>
     public enum BOOTSTRAPPER_CACHEVERIFYCOMPLETE_ACTION
diff --git a/src/api/burn/WixToolset.Mba.Core/IDefaultBootstrapperApplication.cs b/src/api/burn/WixToolset.Mba.Core/IDefaultBootstrapperApplication.cs
index 2535f756..2fa88bdb 100644
--- a/src/api/burn/WixToolset.Mba.Core/IDefaultBootstrapperApplication.cs
+++ b/src/api/burn/WixToolset.Mba.Core/IDefaultBootstrapperApplication.cs
@@ -94,6 +94,11 @@ namespace WixToolset.Mba.Core
         event EventHandler<CachePackageCompleteEventArgs> CachePackageComplete;
 
         /// <summary>
+        /// Fired when the engine failed validating a package in the package cache that is non-vital to execution.
+        /// </summary>
+        event EventHandler<CachePackageNonVitalValidationFailureEventArgs> CachePackageNonVitalValidationFailure;
+
+        /// <summary>
         /// Fired when the engine begins the extraction of the payload from the container.
         /// </summary>
         event EventHandler<CachePayloadExtractBeginEventArgs> CachePayloadExtractBegin;