Add ability to customize file versioning rules for MsiPackage and MspPackage.

Fixes #5911

3 files changed, 38 insertions, 12 deletions

diff --git a/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs b/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs
index b6fdca1e..0520463f 100644
--- a/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs
+++ b/src/api/burn/WixToolset.Mba.Core/BootstrapperApplication.cs
@@ -1433,15 +1433,16 @@ namespace WixToolset.Mba.Core
             return args.HResult;
         }
 
-        int IBootstrapperApplication.OnPlanMsiPackage(string wzPackageId, bool fExecute, ActionState action, ref bool fCancel, ref BURN_MSI_PROPERTY actionMsiProperty, ref INSTALLUILEVEL uiLevel, ref bool fDisableExternalUiHandler)
+        int IBootstrapperApplication.OnPlanMsiPackage(string wzPackageId, bool fExecute, ActionState action, BOOTSTRAPPER_MSI_FILE_VERSIONING recommendedFileVersioning, ref bool fCancel, ref BURN_MSI_PROPERTY actionMsiProperty, ref INSTALLUILEVEL uiLevel, ref bool fDisableExternalUiHandler, ref BOOTSTRAPPER_MSI_FILE_VERSIONING fileVersioning)
         {
-            PlanMsiPackageEventArgs args = new PlanMsiPackageEventArgs(wzPackageId, fExecute, action, fCancel, actionMsiProperty, uiLevel, fDisableExternalUiHandler);
+            PlanMsiPackageEventArgs args = new PlanMsiPackageEventArgs(wzPackageId, fExecute, action, recommendedFileVersioning, fCancel, actionMsiProperty, uiLevel, fDisableExternalUiHandler, fileVersioning);
             this.OnPlanMsiPackage(args);
 
             fCancel = args.Cancel;
             actionMsiProperty = args.ActionMsiProperty;
             uiLevel = args.UiLevel;
             fDisableExternalUiHandler = args.DisableExternalUiHandler;
+            fileVersioning = args.FileVersioning;
             return args.HResult;
         }
 
diff --git a/src/api/burn/WixToolset.Mba.Core/EventArgs.cs b/src/api/burn/WixToolset.Mba.Core/EventArgs.cs
index 04e7b579..556db821 100644
--- a/src/api/burn/WixToolset.Mba.Core/EventArgs.cs
+++ b/src/api/burn/WixToolset.Mba.Core/EventArgs.cs
@@ -902,15 +902,17 @@ namespace WixToolset.Mba.Core
     public class PlanMsiPackageEventArgs : CancellableHResultEventArgs
     {
         /// <summary />
-        public PlanMsiPackageEventArgs(string packageId, bool shouldExecute, ActionState action, bool cancelRecommendation, BURN_MSI_PROPERTY actionMsiProperty, INSTALLUILEVEL uiLevel, bool disableExternalUiHandler)
+        public PlanMsiPackageEventArgs(string packageId, bool shouldExecute, ActionState action, BOOTSTRAPPER_MSI_FILE_VERSIONING recommendedFileVersioning, bool cancelRecommendation, BURN_MSI_PROPERTY actionMsiProperty, INSTALLUILEVEL uiLevel, bool disableExternalUiHandler, BOOTSTRAPPER_MSI_FILE_VERSIONING fileVersioning)
             : base(cancelRecommendation)
         {
             this.PackageId = packageId;
             this.ShouldExecute = shouldExecute;
             this.Action = action;
+            this.RecommendedFileVersioning = recommendedFileVersioning;
             this.ActionMsiProperty = actionMsiProperty;
             this.UiLevel = uiLevel;
             this.DisableExternalUiHandler = disableExternalUiHandler;
+            this.FileVersioning = fileVersioning;
         }
 
         /// <summary>
@@ -929,6 +931,11 @@ namespace WixToolset.Mba.Core
         public ActionState Action { get; private set; }
 
         /// <summary>
+        /// Gets the recommended file versioning for the package.
+        /// </summary>
+        public BOOTSTRAPPER_MSI_FILE_VERSIONING RecommendedFileVersioning { get; private set; }
+
+        /// <summary>
         /// Gets or sets the requested MSI property to add.
         /// </summary>
         public BURN_MSI_PROPERTY ActionMsiProperty { get; set; }
@@ -942,6 +949,11 @@ namespace WixToolset.Mba.Core
         /// Gets or sets whether Burn is requested to set up an external UI handler.
         /// </summary>
         public bool DisableExternalUiHandler { get; set; }
+
+        /// <summary>
+        /// Gets or sets the requested file versioning.
+        /// </summary>
+        public BOOTSTRAPPER_MSI_FILE_VERSIONING FileVersioning { get; set; }
     }
 
     /// <summary>
diff --git a/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs b/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs
index 07c1a23b..259c407f 100644
--- a/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs
+++ b/src/api/burn/WixToolset.Mba.Core/IBootstrapperApplication.cs
@@ -373,24 +373,18 @@ namespace WixToolset.Mba.Core
         /// <summary>
         /// See <see cref="IDefaultBootstrapperApplication.PlanMsiPackage"/>.
         /// </summary>
-        /// <param name="wzPackageId"></param>
-        /// <param name="fExecute"></param>
-        /// <param name="action"></param>
-        /// <param name="fCancel"></param>
-        /// <param name="actionMsiProperty"></param>
-        /// <param name="uiLevel"></param>
-        /// <param name="fDisableExternalUiHandler"></param>
-        /// <returns></returns>
         [PreserveSig]
         [return: MarshalAs(UnmanagedType.I4)]
         int OnPlanMsiPackage(
             [MarshalAs(UnmanagedType.LPWStr)] string wzPackageId,
             [MarshalAs(UnmanagedType.Bool)] bool fExecute,
             [MarshalAs(UnmanagedType.U4)] ActionState action,
+            [MarshalAs(UnmanagedType.U4)] BOOTSTRAPPER_MSI_FILE_VERSIONING recommendedFileVersioning,
             [MarshalAs(UnmanagedType.Bool)] ref bool fCancel,
             [MarshalAs(UnmanagedType.U4)] ref BURN_MSI_PROPERTY actionMsiProperty,
             [MarshalAs(UnmanagedType.U4)] ref INSTALLUILEVEL uiLevel,
-            [MarshalAs(UnmanagedType.Bool)] ref bool fDisableExternalUiHandler
+            [MarshalAs(UnmanagedType.Bool)] ref bool fDisableExternalUiHandler,
+            [MarshalAs(UnmanagedType.U4)] ref BOOTSTRAPPER_MSI_FILE_VERSIONING fileVersioning
             );
 
         /// <summary>
@@ -1852,6 +1846,25 @@ namespace WixToolset.Mba.Core
     }
 
     /// <summary>
+    /// The file versioning options for REINSTALLMODE, see https://docs.microsoft.com/en-us/windows/win32/msi/reinstallmode.
+    /// </summary>
+    public enum BOOTSTRAPPER_MSI_FILE_VERSIONING
+    {
+        /// <summary>
+        /// o
+        /// </summary>
+        Older,
+        /// <summary>
+        /// e
+        /// </summary>
+        Equal,
+        /// <summary>
+        /// a
+        /// </summary>
+        All,
+    }
+
+    /// <summary>
     /// The property Burn will add so the MSI can know the planned action for the package.
     /// </summary>
     public enum BURN_MSI_PROPERTY