From dea657295df261bb0e3e4d620eeae321531e3a11 Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Tue, 14 Jun 2022 15:09:49 -0500 Subject: Add ability for non-vital cache package action. --- .../WixToolset.Mba.Core/BootstrapperApplication.cs | 29 ++++++++++++++-- src/api/burn/WixToolset.Mba.Core/EventArgs.cs | 27 ++++++++++++++- .../IBootstrapperApplication.cs | 40 ++++++++++++++++------ .../IDefaultBootstrapperApplication.cs | 5 +++ 4 files changed, 88 insertions(+), 13 deletions(-) (limited to 'src/api/burn/WixToolset.Mba.Core') 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 /// public event EventHandler DetectRelatedBundlePackage; + /// + public event EventHandler CachePackageNonVitalValidationFailure; + /// /// Entry point that is called when the bootstrapper application is ready to run. /// @@ -1376,6 +1379,18 @@ namespace WixToolset.Mba.Core } } + /// + /// Called by the engine, raises the event. + /// + protected virtual void OnCachePackageNonVitalValidationFailure(CachePackageNonVitalValidationFailureEventArgs args) + { + EventHandler 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 { /// - 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; } /// @@ -1952,6 +1953,11 @@ namespace WixToolset.Mba.Core /// Gets the size on disk required by the specific package. /// public long PackageCacheSize { get; private set; } + + /// + /// If caching a package is not vital, then acquisition will be skipped unless the BA opts in through . + /// + public bool Vital { get; private set; } } /// @@ -2482,4 +2488,23 @@ namespace WixToolset.Mba.Core /// public string Version { get; private set; } } + + /// + /// Event arguments for + /// + [Serializable] + public class CachePackageNonVitalValidationFailureEventArgs : ActionEventArgs + { + /// + public CachePackageNonVitalValidationFailureEventArgs(string packageId, int hrStatus, BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION recommendation, BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION action) + : base(hrStatus, recommendation, action) + { + this.PackageId = packageId; + } + + /// + /// Gets the identity of the package that was being validated. + /// + 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 /// /// See . /// - /// - /// - /// - /// - /// [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 /// /// See . /// - /// - /// - /// - /// - /// [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 ); + + /// + /// See . + /// + [PreserveSig] + [return: MarshalAs(UnmanagedType.I4)] + int OnCachePackageNonVitalValidationFailure( + [MarshalAs(UnmanagedType.LPWStr)] string wzPackageId, + int hrStatus, + BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION recommendation, + ref BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION action + ); } /// @@ -1870,6 +1873,23 @@ namespace WixToolset.Mba.Core Retry, } + /// + /// The available actions for + /// + public enum BOOTSTRAPPER_CACHEPACKAGENONVITALVALIDATIONFAILURE_ACTION + { + /// + /// + /// + None, + + /// + /// 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. + /// + Acquire, + } + /// /// The available actions for . /// 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 @@ -93,6 +93,11 @@ namespace WixToolset.Mba.Core /// event EventHandler CachePackageComplete; + /// + /// Fired when the engine failed validating a package in the package cache that is non-vital to execution. + /// + event EventHandler CachePackageNonVitalValidationFailure; + /// /// Fired when the engine begins the extraction of the payload from the container. /// -- cgit v1.2.3-55-g6feb