Plan MSI transactions

src/WixToolset.Mba.Core/BootstrapperApplication.cs

@@ -88,6 +88,9 @@ protected BootstrapperApplication(IEngine engine)
         /// <inheritdoc/>
         public event EventHandler<PlanPackageBeginEventArgs> PlanPackageBegin;
 
+        /// <inheritdoc/>
+        public event EventHandler<PlanMsiTransactionEventArgs> PlanMsiTransaction;
+
         /// <inheritdoc/>
         public event EventHandler<PlanPatchTargetEventArgs> PlanPatchTarget;
 
@@ -522,6 +525,19 @@ protected virtual void OnPlanPatchTarget(PlanPatchTargetEventArgs args)
             }
         }
 
+        /// <summary>
+        /// Called by the engine, raises the <see cref="PlanMsiTransaction"/> event.
+        /// </summary>
+        /// <param name="args">Additional arguments for this event.</param>
+        protected virtual void OnPlanMsiTransaction(PlanMsiTransactionEventArgs args)
+        {
+            EventHandler<PlanMsiTransactionEventArgs> handler = this.PlanMsiTransaction;
+            if (null != handler)
+            {
+                handler(this, args);
+            }
+        }
+
         /// <summary>
         /// Called by the engine, raises the <see cref="PlanMsiFeature"/> event.
         /// </summary>
@@ -1398,6 +1414,15 @@ int IBootstrapperApplication.OnPlanPatchTarget(string wzPackageId, string wzProd
             return args.HResult;
         }
 
+        int IBootstrapperApplication.OnPlanMsiTransaction(string wzPackageId, bool fTransaction, ref bool pfTransaction)
+        {
+            PlanMsiTransactionEventArgs args = new PlanMsiTransactionEventArgs(wzPackageId, fTransaction);
+            this.OnPlanMsiTransaction(args);
+
+            pfTransaction = args.Transaction;
+            return 0;
+        }
+
         int IBootstrapperApplication.OnPlanMsiFeature(string wzPackageId, string wzFeatureId, FeatureState recommendedState, ref FeatureState pRequestedState, ref bool fCancel)
         {
             PlanMsiFeatureEventArgs args = new PlanMsiFeatureEventArgs(wzPackageId, wzFeatureId, recommendedState, pRequestedState, fCancel);

src/WixToolset.Mba.Core/EventArgs.cs

@@ -770,6 +770,36 @@ public PlanPackageBeginEventArgs(string packageId, PackageState currentState, bo
         public RequestState State { get; set; }
     }
 
+    /// <summary>
+    /// Additional arguments used when the engine has plans an MSI transaction.
+    /// </summary>
+    [Serializable]
+    public class PlanMsiTransactionEventArgs : EventArgs
+    {
+        /// <summary>
+        /// Creates a new instance of the <see cref="PlanMsiTransactionEventArgs"/> class.
+        /// </summary>
+        /// <param name="transactionId">The identity of the transaction to plan for.</param>
+        /// <param name="fTransaction">Whether or not an MSI transaction can be used in the rollback boundary.</param>
+        public PlanMsiTransactionEventArgs(string transactionId, bool fTransaction)
+        {
+            this.TransactionId = transactionId;
+            this.Transaction = fTransaction;
+        }
+
+        /// <summary>
+        /// Gets the identity of the transaction to plan for.
+        /// </summary>
+        public string TransactionId { get; private set; }
+
+        /// <summary>
+        /// Whether or not an MSI transaction will be used in the rollback boundary.
+        /// When false on entry, then an MSI tranaction is either not authored or not supported on the target machine. In this case, setting the value to true has no effect.
+        /// When true on entry, setting to false will disable the transaction and packages will be installed without a wrapping MSI transaction.
+        /// </summary>
+        public bool Transaction { get; set; }
+    }
+
     /// <summary>
     /// Event arguments for <see cref="IDefaultBootstrapperApplication.PlanPatchTarget"/>
     /// </summary>

src/WixToolset.Mba.Core/IBootstrapperApplication.cs

@@ -346,6 +346,21 @@ int OnPlanPatchTarget(
             [MarshalAs(UnmanagedType.Bool)] ref bool fCancel
             );
 
+        /// <summary>
+        /// See <see cref="IDefaultBootstrapperApplication.PlanMsiTransaction"/>.
+        /// </summary>
+        /// <param name="wzTransactionId"></param>
+        /// <param name="fTransaction"></param>
+        /// <param name="pfTransaction"></param>
+        /// <returns></returns>
+        [PreserveSig]
+        [return: MarshalAs(UnmanagedType.I4)]
+        int OnPlanMsiTransaction(
+            [MarshalAs(UnmanagedType.LPWStr)] string wzTransactionId,
+            [MarshalAs(UnmanagedType.Bool)] bool fTransaction,
+            [MarshalAs(UnmanagedType.Bool)] ref bool pfTransaction
+            );
+
         /// <summary>
         /// See <see cref="IDefaultBootstrapperApplication.PlanMsiFeature"/>.
         /// </summary>

src/WixToolset.Mba.Core/IDefaultBootstrapperApplication.cs

@@ -303,6 +303,11 @@ public interface IDefaultBootstrapperApplication : IBootstrapperApplication
         /// </summary>
         event EventHandler<PlanPackageCompleteEventArgs> PlanPackageComplete;
 
+        /// <summary>
+        /// Fired when the engine has plans an MSI transaction.
+        /// </summary>
+        event EventHandler<PlanMsiTransactionEventArgs> PlanMsiTransaction;
+
         /// <summary>
         /// Fired when the engine is about to plan a target of an MSP package.
         /// </summary>

src/balutil/inc/BAFunctions.h

@@ -29,6 +29,7 @@ enum BA_FUNCTIONS_MESSAGE
     BA_FUNCTIONS_MESSAGE_ONPLANRELATEDBUNDLE = BOOTSTRAPPER_APPLICATION_MESSAGE_ONPLANRELATEDBUNDLE,
     BA_FUNCTIONS_MESSAGE_ONPLANPACKAGEBEGIN = BOOTSTRAPPER_APPLICATION_MESSAGE_ONPLANPACKAGEBEGIN,
     BA_FUNCTIONS_MESSAGE_ONPLANPATCHTARGET = BOOTSTRAPPER_APPLICATION_MESSAGE_ONPLANPATCHTARGET,
+    BA_FUNCTIONS_MESSAGE_ONPLANMSITRANSACTION = BOOTSTRAPPER_APPLICATION_MESSAGE_ONPLANMSITRANSACTION,
     BA_FUNCTIONS_MESSAGE_ONPLANMSIFEATURE = BOOTSTRAPPER_APPLICATION_MESSAGE_ONPLANMSIFEATURE,
     BA_FUNCTIONS_MESSAGE_ONPLANPACKAGECOMPLETE = BOOTSTRAPPER_APPLICATION_MESSAGE_ONPLANPACKAGECOMPLETE,
     BA_FUNCTIONS_MESSAGE_ONAPPLYBEGIN = BOOTSTRAPPER_APPLICATION_MESSAGE_ONAPPLYBEGIN,

src/balutil/inc/BalBaseBAFunctions.h

@@ -277,6 +277,15 @@ class CBalBaseBAFunctions : public IBAFunctions
         return S_OK;
     }
 
+    virtual STDMETHODIMP OnPlanMsiTransaction(
+        __in_z LPCWSTR /*wzTransactionId*/,
+        __in BOOL /*fTransaction*/,
+        __out BOOL* /*pfTransaction*/
+        )
+    {
+        return S_OK;
+    }
+
     virtual STDMETHODIMP OnPlanMsiFeature(
         __in_z LPCWSTR /*wzPackageId*/,
         __in_z LPCWSTR /*wzFeatureId*/,

src/balutil/inc/BalBaseBAFunctionsProc.h

@@ -64,6 +64,7 @@ static HRESULT WINAPI BalBaseBAFunctionsProc(
         case BA_FUNCTIONS_MESSAGE_ONPLANRELATEDBUNDLE:
         case BA_FUNCTIONS_MESSAGE_ONPLANPACKAGEBEGIN:
         case BA_FUNCTIONS_MESSAGE_ONPLANPATCHTARGET:
+        case BA_FUNCTIONS_MESSAGE_ONPLANMSITRANSACTION:
         case BA_FUNCTIONS_MESSAGE_ONPLANMSIFEATURE:
         case BA_FUNCTIONS_MESSAGE_ONPLANPACKAGECOMPLETE:
         case BA_FUNCTIONS_MESSAGE_ONAPPLYBEGIN:

src/balutil/inc/BalBaseBootstrapperApplication.h

@@ -287,6 +287,15 @@ class CBalBaseBootstrapperApplication : public IBootstrapperApplication
         return S_OK;
     }
 
+    virtual STDMETHODIMP OnPlanMsiTransaction(
+        __in_z LPCWSTR /*wzTransactionId*/,
+        __in BOOL /*fTransaction*/,
+        __out BOOL* /*pfTransaction*/
+        )
+    {
+        return S_OK;
+    }
+
     virtual STDMETHODIMP OnPlanMsiFeature(
         __in_z LPCWSTR /*wzPackageId*/,
         __in_z LPCWSTR /*wzFeatureId*/,

src/balutil/inc/BalBaseBootstrapperApplicationProc.h

@@ -189,6 +189,15 @@ static HRESULT BalBaseBAProcOnPlanPatchTarget(
     return pBA->OnPlanPatchTarget(pArgs->wzPackageId, pArgs->wzProductCode, pArgs->recommendedState, &pResults->requestedState, &pResults->fCancel);
 }
 
+static HRESULT BalBaseBAProcOnPlanMsiTransaction(
+    __in IBootstrapperApplication* pBA,
+    __in BA_ONPLANMSITRANSACTION_ARGS* pArgs,
+    __inout BA_ONPLANMSITRANSACTION_RESULTS* pResults
+    )
+{
+    return pBA->OnPlanMsiTransaction(pArgs->wzTransactionId, pArgs->fTransaction, &pResults->fTransaction);
+}
+
 static HRESULT BalBaseBAProcOnPlanMsiFeature(
     __in IBootstrapperApplication* pBA,
     __in BA_ONPLANMSIFEATURE_ARGS* pArgs,

src/balutil/inc/IBootstrapperApplication.h

@@ -180,6 +180,13 @@ DECLARE_INTERFACE_IID_(IBootstrapperApplication, IUnknown, "53C31D56-49C0-426B-A
         __inout BOOL* pfCancel
         ) = 0;
 
+    // OnPlanMsiTransaction - called when the engine plans an MSI transaction.
+    STDMETHOD(OnPlanMsiTransaction)(
+        __in_z LPCWSTR wzTransactionId,
+        __in BOOL fTransaction,
+        __out BOOL* pfTransaction
+        ) = 0;
+
     // OnPlanMsiFeature - called when the engine plans a feature in an
     //                    MSI package.
     STDMETHOD(OnPlanMsiFeature)(