From fb54576f1d05e82ba47cd718c4c4f8b3bad624c9 Mon Sep 17 00:00:00 2001
From: Sean Hall <r.sean.hall@gmail.com>
Date: Fri, 18 Mar 2022 20:15:33 -0500
Subject: Give BA process id and option to wait for cancelled process to exit.

---
 .../WixToolset.Mba.Core/BootstrapperApplication.cs | 25 +++++++++++++++
 src/api/burn/WixToolset.Mba.Core/EventArgs.cs      | 36 ++++++++++++++++++++++
 .../IBootstrapperApplication.cs                    | 32 +++++++++++++++++++
 .../IDefaultBootstrapperApplication.cs             |  5 +++
 4 files changed, 98 insertions(+)

(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 8a2e0e93..5ed064fa 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<PlanRestoreRelatedBundleEventArgs> PlanRestoreRelatedBundle;
 
+        /// <inheritdoc/>
+        public event EventHandler<ExecuteProcessCancelEventArgs> ExecuteProcessCancel;
+
         /// <summary>
         /// Entry point that is called when the bootstrapper application is ready to run.
         /// </summary>
@@ -1369,6 +1372,19 @@ namespace WixToolset.Mba.Core
             }
         }
 
+        /// <summary>
+        /// Called by the engine, raises the <see cref="ExecuteProcessCancel"/> event.
+        /// </summary>
+        /// <param name="args">Additional arguments for this event.</param>
+        protected virtual void OnExecuteProcessCancel(ExecuteProcessCancelEventArgs args)
+        {
+            EventHandler<ExecuteProcessCancelEventArgs> handler = this.ExecuteProcessCancel;
+            if (null != handler)
+            {
+                handler(this, args);
+            }
+        }
+
         #region IBootstrapperApplication Members
 
         int IBootstrapperApplication.BAProc(int message, IntPtr pvArgs, IntPtr pvResults, IntPtr pvContext)
@@ -2119,6 +2135,15 @@ namespace WixToolset.Mba.Core
             return args.HResult;
         }
 
+        int IBootstrapperApplication.OnExecuteProcessCancel(string wzPackageId, int processId, BOOTSTRAPPER_EXECUTEPROCESSCANCEL_ACTION recommendation, ref BOOTSTRAPPER_EXECUTEPROCESSCANCEL_ACTION pAction)
+        {
+            ExecuteProcessCancelEventArgs args = new ExecuteProcessCancelEventArgs(wzPackageId, processId, recommendation, pAction);
+            this.OnExecuteProcessCancel(args);
+
+            pAction = 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 c93c2885..c2c73067 100644
--- a/src/api/burn/WixToolset.Mba.Core/EventArgs.cs
+++ b/src/api/burn/WixToolset.Mba.Core/EventArgs.cs
@@ -2488,4 +2488,40 @@ namespace WixToolset.Mba.Core
         /// </summary>
         public RequestState State { get; set; }
     }
+
+    /// <summary>
+    /// Event arguments for <see cref="IDefaultBootstrapperApplication.ExecuteProcessCancel"/>
+    /// </summary>
+    [Serializable]
+    public class ExecuteProcessCancelEventArgs : HResultEventArgs
+    {
+        /// <summary />
+        public ExecuteProcessCancelEventArgs(string packageId, int processId, BOOTSTRAPPER_EXECUTEPROCESSCANCEL_ACTION recommendation, BOOTSTRAPPER_EXECUTEPROCESSCANCEL_ACTION action)
+        {
+            this.PackageId = packageId;
+            this.ProcessId = processId;
+            this.Recommendation = recommendation;
+            this.Action = action;
+        }
+
+        /// <summary>
+        /// Gets the identity of the package.
+        /// </summary>
+        public string PackageId { get; private set; }
+
+        /// <summary>
+        /// Gets the process id.
+        /// </summary>
+        public int ProcessId { get; private set; }
+
+        /// <summary>
+        /// Gets the recommended action from the engine.
+        /// </summary>
+        public BOOTSTRAPPER_EXECUTEPROCESSCANCEL_ACTION Recommendation { get; private set; }
+
+        /// <summary>
+        /// Gets or sets the action to be performed. This is passed back to the engine.
+        /// </summary>
+        public BOOTSTRAPPER_EXECUTEPROCESSCANCEL_ACTION Action { get; set; }
+    }
 }
diff --git a/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs b/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs
index d4fe8320..1786eecd 100644
--- a/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs
+++ b/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs
@@ -1170,6 +1170,18 @@ namespace WixToolset.Mba.Core
             [MarshalAs(UnmanagedType.I4)] int hrRecommended,
             [MarshalAs(UnmanagedType.I4)] ref int hrStatus
             );
+
+        /// <summary>
+        /// See <see cref="IDefaultBootstrapperApplication.ExecuteProcessCancel"/>.
+        /// </summary>
+        [PreserveSig]
+        [return: MarshalAs(UnmanagedType.I4)]
+        int OnExecuteProcessCancel(
+            [MarshalAs(UnmanagedType.LPWStr)] string wzPackageId,
+            int processId,
+            [MarshalAs(UnmanagedType.I4)] BOOTSTRAPPER_EXECUTEPROCESSCANCEL_ACTION recommendation,
+            [MarshalAs(UnmanagedType.I4)] ref BOOTSTRAPPER_EXECUTEPROCESSCANCEL_ACTION pAction
+            );
     }
 
     /// <summary>
@@ -1906,6 +1918,26 @@ namespace WixToolset.Mba.Core
         Suspend,
     }
 
+    /// <summary>
+    /// The available actions for <see cref="IDefaultBootstrapperApplication.ExecuteProcessCancel"/>.
+    /// </summary>
+    public enum BOOTSTRAPPER_EXECUTEPROCESSCANCEL_ACTION
+    {
+        /// <summary>
+        /// Instructs the engine to stop waiting for the process to exit.
+        /// The package is immediately considered to have failed with ERROR_INSTALL_USEREXIT.
+        /// The engine will never rollback the package.
+        /// </summary>
+        Abandon,
+
+        /// <summary>
+        /// Instructs the engine to wait for the process to exit.
+        /// Once the process has exited, the package is considered to have failed with ERROR_INSTALL_USEREXIT.
+        /// This allows the engine to rollback the package if necessary.
+        /// </summary>
+        Wait,
+    }
+
     /// <summary>
     /// The result of evaluating a condition from a package.
     /// </summary>
diff --git a/src/api/burn/WixToolset.Mba.Core/IDefaultBootstrapperApplication.cs b/src/api/burn/WixToolset.Mba.Core/IDefaultBootstrapperApplication.cs
index c9284b69..21d99b32 100644
--- a/src/api/burn/WixToolset.Mba.Core/IDefaultBootstrapperApplication.cs
+++ b/src/api/burn/WixToolset.Mba.Core/IDefaultBootstrapperApplication.cs
@@ -243,6 +243,11 @@ namespace WixToolset.Mba.Core
         /// </summary>
         event EventHandler<ExecutePackageCompleteEventArgs> ExecutePackageComplete;
 
+        /// <summary>
+        /// Fired when a package that spawned a process is cancelled.
+        /// </summary>
+        event EventHandler<ExecuteProcessCancelEventArgs> ExecuteProcessCancel;
+
         /// <summary>
         /// Fired when the engine executes one or more patches targeting a product.
         /// </summary>
-- 
cgit v1.2.3-55-g6feb