From 4cd1c4e06145434ca940ac828772dc47b9d9738e Mon Sep 17 00:00:00 2001
From: Sean Hall <r.sean.hall@gmail.com>
Date: Sun, 13 Mar 2022 23:45:32 -0500
Subject: Allow the BA to override the bundle relation type during plan.

---
 .../WixToolset.Mba.Core/BootstrapperApplication.cs | 26 ++++++++++
 src/api/burn/WixToolset.Mba.Core/EventArgs.cs      | 31 +++++++++++
 .../IBootstrapperApplication.cs                    | 60 +++++++++++++++++++++-
 .../IDefaultBootstrapperApplication.cs             |  5 ++
 4 files changed, 121 insertions(+), 1 deletion(-)

(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 1df992be..fd36cf26 100644
--- a/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs
+++ b/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs
@@ -88,6 +88,9 @@ namespace WixToolset.Mba.Core
         /// <inheritdoc/>
         public event EventHandler<PlanRelatedBundleEventArgs> PlanRelatedBundle;
 
+        /// <inheritdoc/>
+        public event EventHandler<PlanRelatedBundleTypeEventArgs> PlanRelatedBundleType;
+
         /// <inheritdoc/>
         public event EventHandler<PlanRollbackBoundaryEventArgs> PlanRollbackBoundary;
 
@@ -533,6 +536,19 @@ namespace WixToolset.Mba.Core
             }
         }
 
+        /// <summary>
+        /// Called by the engine, raises the <see cref="PlanRelatedBundleType"/> event.
+        /// </summary>
+        /// <param name="args">Additional arguments for this event.</param>
+        protected virtual void OnPlanRelatedBundleType(PlanRelatedBundleTypeEventArgs args)
+        {
+            EventHandler<PlanRelatedBundleTypeEventArgs> handler = this.PlanRelatedBundleType;
+            if (null != handler)
+            {
+                handler(this, args);
+            }
+        }
+
         /// <summary>
         /// Called by the engine, raises the <see cref="PlanRollbackBoundary"/> event.
         /// </summary>
@@ -1514,6 +1530,16 @@ namespace WixToolset.Mba.Core
             return args.HResult;
         }
 
+        int IBootstrapperApplication.OnPlanRelatedBundleType(string wzBundleId, RelatedBundlePlanType recommendedType, ref RelatedBundlePlanType pRequestedType, ref bool fCancel)
+        {
+            PlanRelatedBundleTypeEventArgs args = new PlanRelatedBundleTypeEventArgs(wzBundleId, recommendedType, pRequestedType, fCancel);
+            this.OnPlanRelatedBundleType(args);
+
+            pRequestedType = args.Type;
+            fCancel = args.Cancel;
+            return args.HResult;
+        }
+
         int IBootstrapperApplication.OnPlanRollbackBoundary(string wzRollbackBoundaryId, bool fRecommendedTransaction, ref bool fTransaction, ref bool fCancel)
         {
             PlanRollbackBoundaryEventArgs args = new PlanRollbackBoundaryEventArgs(wzRollbackBoundaryId, fRecommendedTransaction, fTransaction, fCancel);
diff --git a/src/api/burn/WixToolset.Mba.Core/EventArgs.cs b/src/api/burn/WixToolset.Mba.Core/EventArgs.cs
index 816757cc..d8ec7998 100644
--- a/src/api/burn/WixToolset.Mba.Core/EventArgs.cs
+++ b/src/api/burn/WixToolset.Mba.Core/EventArgs.cs
@@ -745,6 +745,37 @@ namespace WixToolset.Mba.Core
         public RequestState State { get; set; }
     }
 
+    /// <summary>
+    /// Event arguments for <see cref="IDefaultBootstrapperApplication.PlanRelatedBundleType"/>
+    /// </summary>
+    [Serializable]
+    public class PlanRelatedBundleTypeEventArgs : CancellableHResultEventArgs
+    {
+        /// <summary />
+        public PlanRelatedBundleTypeEventArgs(string bundleId, RelatedBundlePlanType recommendedType, RelatedBundlePlanType type, bool cancelRecommendation)
+            : base(cancelRecommendation)
+        {
+            this.BundleId = bundleId;
+            this.RecommendedType = recommendedType;
+            this.Type = type;
+        }
+
+        /// <summary>
+        /// Gets the identity of the bundle to plan for.
+        /// </summary>
+        public string BundleId { get; private set; }
+
+        /// <summary>
+        /// Gets the recommended plan type for the bundle.
+        /// </summary>
+        public RelatedBundlePlanType RecommendedType { get; private set; }
+
+        /// <summary>
+        /// Gets or sets the plan type for the bundle.
+        /// </summary>
+        public RelatedBundlePlanType Type { get; set; }
+    }
+
     /// <summary>
     /// Event arguments for <see cref="IDefaultBootstrapperApplication.PlanPackageBegin"/>
     /// </summary>
diff --git a/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs b/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs
index 489e3b6d..4ab0f8d9 100644
--- a/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs
+++ b/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs
@@ -1148,6 +1148,18 @@ namespace WixToolset.Mba.Core
             [MarshalAs(UnmanagedType.U4)] ref RequestState pRequestedState,
             [MarshalAs(UnmanagedType.Bool)] ref bool fCancel
             );
+
+        /// <summary>
+        /// See <see cref="IDefaultBootstrapperApplication.PlanRelatedBundleType"/>.
+        /// </summary>
+        [PreserveSig]
+        [return: MarshalAs(UnmanagedType.I4)]
+        int OnPlanRelatedBundleType(
+            [MarshalAs(UnmanagedType.LPWStr)] string wzBundleId,
+            [MarshalAs(UnmanagedType.U4)] RelatedBundlePlanType recommendedType,
+            [MarshalAs(UnmanagedType.U4)] ref RelatedBundlePlanType pRequestedType,
+            [MarshalAs(UnmanagedType.Bool)] ref bool fCancel
+            );
     }
 
     /// <summary>
@@ -1669,7 +1681,12 @@ namespace WixToolset.Mba.Core
         /// <summary>
         /// 
         /// </summary>
-        Dependent,
+        DependentAddon,
+
+        /// <summary>
+        /// 
+        /// </summary>
+        DependentPatch,
 
         /// <summary>
         /// 
@@ -1677,6 +1694,47 @@ namespace WixToolset.Mba.Core
         Update,
     }
 
+    /// <summary>
+    /// The planned relation type for related bundles.
+    /// </summary>
+    public enum RelatedBundlePlanType
+    {
+        /// <summary>
+        /// 
+        /// </summary>
+        None,
+
+        /// <summary>
+        /// 
+        /// </summary>
+        Downgrade,
+
+        /// <summary>
+        /// 
+        /// </summary>
+        Upgrade,
+
+        /// <summary>
+        /// 
+        /// </summary>
+        Addon,
+
+        /// <summary>
+        /// 
+        /// </summary>
+        Patch,
+
+        /// <summary>
+        /// 
+        /// </summary>
+        DependentAddon,
+
+        /// <summary>
+        /// 
+        /// </summary>
+        DependentPatch,
+    }
+
     /// <summary>
     /// One or more reasons why the application is requested to be closed or is being closed.
     /// </summary>
diff --git a/src/api/burn/WixToolset.Mba.Core/IDefaultBootstrapperApplication.cs b/src/api/burn/WixToolset.Mba.Core/IDefaultBootstrapperApplication.cs
index c237cb9d..ebd1580b 100644
--- a/src/api/burn/WixToolset.Mba.Core/IDefaultBootstrapperApplication.cs
+++ b/src/api/burn/WixToolset.Mba.Core/IDefaultBootstrapperApplication.cs
@@ -333,6 +333,11 @@ namespace WixToolset.Mba.Core
         /// </summary>
         event EventHandler<PlanRelatedBundleEventArgs> PlanRelatedBundle;
 
+        /// <summary>
+        /// Fired when the engine has begun planning the related bundle relation type.
+        /// </summary>
+        event EventHandler<PlanRelatedBundleTypeEventArgs> PlanRelatedBundleType;
+
         /// <summary>
         /// Fired when the engine has begun planning an upgrade related bundle for restoring in case of failure.
         /// </summary>
-- 
cgit v1.2.3-55-g6feb