Expose overridable variable APIs in balutil and Mba.Core.

Fixes #4777

10 files changed, 230 insertions, 9 deletions

diff --git a/src/api/burn/WixToolset.Mba.Core/BootstrapperCommand.cs b/src/api/burn/WixToolset.Mba.Core/BootstrapperCommand.cs
index 65dde0f4..345e0448 100644
--- a/src/api/burn/WixToolset.Mba.Core/BootstrapperCommand.cs
+++ b/src/api/burn/WixToolset.Mba.Core/BootstrapperCommand.cs
@@ -3,6 +3,7 @@
 namespace WixToolset.Mba.Core
 {
     using System;
+    using System.Collections.Generic;
     using System.ComponentModel;
     using System.Runtime.InteropServices;
 
@@ -11,8 +12,6 @@ namespace WixToolset.Mba.Core
     /// </summary>
     public sealed class BootstrapperCommand : IBootstrapperCommand
     {
-        private readonly string commandLine;
-
         /// <summary>
         /// 
         /// </summary>
@@ -45,7 +44,7 @@ namespace WixToolset.Mba.Core
             this.Action = action;
             this.Display = display;
             this.Restart = restart;
-            this.commandLine = commandLine;
+            this.CommandLine = commandLine;
             this.CmdShow = cmdShow;
             this.Resume = resume;
             this.SplashScreen = splashScreen;
@@ -66,7 +65,7 @@ namespace WixToolset.Mba.Core
         public Restart Restart { get; }
 
         /// <inheritdoc/>
-        public string[] CommandLineArgs => GetCommandLineArgs(this.commandLine);
+        public string CommandLine { get; }
 
         /// <inheritdoc/>
         public int CmdShow { get; }
@@ -92,6 +91,49 @@ namespace WixToolset.Mba.Core
         /// <inheritdoc/>
         public string BootstrapperApplicationDataPath { get; }
 
+        /// <inheritdoc/>
+        public IMbaCommand ParseCommandLine()
+        {
+            var args = ParseCommandLineToArgs(this.CommandLine);
+            var unknownArgs = new List<string>();
+            var variables = new List<KeyValuePair<string, string>>();
+
+            foreach (var arg in args)
+            {
+                var unknownArg = false;
+
+                if (arg[0] == '-' || arg[0] == '/')
+                {
+                    unknownArg = true;
+                }
+                else
+                {
+                    var index = arg.IndexOf('=');
+                    if (index == -1)
+                    {
+                        unknownArg = true;
+                    }
+                    else
+                    {
+                        var name = arg.Substring(0, index);
+                        var value = arg.Substring(index + 1);
+                        variables.Add(new KeyValuePair<string, string>(name, value));
+                    }
+                }
+
+                if (unknownArg)
+                {
+                    unknownArgs.Add(arg);
+                }
+            }
+
+            return new MbaCommand
+            {
+                UnknownCommandLineArgs = unknownArgs.ToArray(),
+                Variables = variables.ToArray(),
+            };
+        }
+
         /// <summary>
         /// Gets the command line arguments as a string array.
         /// </summary>
@@ -102,7 +144,7 @@ namespace WixToolset.Mba.Core
         /// <remarks>
         /// This method uses the same parsing as the operating system which handles quotes and spaces correctly.
         /// </remarks>
-        public static string[] GetCommandLineArgs(string commandLine)
+        public static string[] ParseCommandLineToArgs(string commandLine)
         {
             if (null == commandLine)
             {
diff --git a/src/api/burn/WixToolset.Mba.Core/BundleInfo.cs b/src/api/burn/WixToolset.Mba.Core/BundleInfo.cs
index 3d5d535d..4a533bf9 100644
--- a/src/api/burn/WixToolset.Mba.Core/BundleInfo.cs
+++ b/src/api/burn/WixToolset.Mba.Core/BundleInfo.cs
@@ -23,6 +23,9 @@ namespace WixToolset.Mba.Core
         public string LogVariable { get; internal set; }
 
         /// <inheritdoc/>
+        public IOverridableVariables OverridableVariables { get; internal set; }
+
+        /// <inheritdoc/>
         public IDictionary<string, IPackageInfo> Packages { get; internal set; }
 
         internal BundleInfo()
@@ -78,6 +81,8 @@ namespace WixToolset.Mba.Core
 
             bundle.LogVariable = BootstrapperApplicationData.GetAttribute(bundleNode, "LogPathVariable");
 
+            bundle.OverridableVariables = OverridableVariablesInfo.ParseFromXml(root);
+
             bundle.Packages = PackageInfo.ParsePackagesFromXml(root);
 
             return bundle;
diff --git a/src/api/burn/WixToolset.Mba.Core/IBootstrapperCommand.cs b/src/api/burn/WixToolset.Mba.Core/IBootstrapperCommand.cs
index e861813f..b7baa55c 100644
--- a/src/api/burn/WixToolset.Mba.Core/IBootstrapperCommand.cs
+++ b/src/api/burn/WixToolset.Mba.Core/IBootstrapperCommand.cs
@@ -25,13 +25,12 @@ namespace WixToolset.Mba.Core
         Restart Restart { get; }
 
         /// <summary>
-        /// Gets the command line arguments as a string array.
+        /// Gets the command line arguments.
         /// </summary>
         /// <returns>
-        /// Array of command line arguments not handled by the engine.
+        /// Command line arguments not handled by the engine.
         /// </returns>
-        /// <exception type="Win32Exception">The command line could not be parsed into an array.</exception>
-        string[] CommandLineArgs { get; }
+        string CommandLine { get; }
 
         /// <summary>
         /// Hint for the initial visibility of the window.
@@ -72,5 +71,14 @@ namespace WixToolset.Mba.Core
         /// Gets path to BootstrapperApplicationData.xml.
         /// </summary>
         string BootstrapperApplicationDataPath { get; }
+
+        /// <summary>
+        /// Parses the command line arguments into an <see cref="IMbaCommand"/>.
+        /// </summary>
+        /// <returns>
+        /// The parsed information.
+        /// </returns>
+        /// <exception type="Win32Exception">The command line could not be parsed.</exception>
+        IMbaCommand ParseCommandLine();
     }
 }
diff --git a/src/api/burn/WixToolset.Mba.Core/IBundleInfo.cs b/src/api/burn/WixToolset.Mba.Core/IBundleInfo.cs
index f4a82f36..35decc88 100644
--- a/src/api/burn/WixToolset.Mba.Core/IBundleInfo.cs
+++ b/src/api/burn/WixToolset.Mba.Core/IBundleInfo.cs
@@ -22,6 +22,11 @@ namespace WixToolset.Mba.Core
         /// <summary>
         /// 
         /// </summary>
+        IOverridableVariables OverridableVariables { get; }
+
+        /// <summary>
+        /// 
+        /// </summary>
         IDictionary<string, IPackageInfo> Packages { get; }
 
         /// <summary>
diff --git a/src/api/burn/WixToolset.Mba.Core/IMbaCommand.cs b/src/api/burn/WixToolset.Mba.Core/IMbaCommand.cs
new file mode 100644
index 00000000..a3ad68d8
--- /dev/null
+++ b/src/api/burn/WixToolset.Mba.Core/IMbaCommand.cs
@@ -0,0 +1,30 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
+
+namespace WixToolset.Mba.Core
+{
+    using System.Collections.Generic;
+
+    /// <summary>
+    /// Command information parsed from the command line.
+    /// </summary>
+    public interface IMbaCommand
+    {
+        /// <summary>
+        /// The command line arguments not parsed into <see cref="IBootstrapperCommand"/> or <see cref="IMbaCommand"/>.
+        /// </summary>
+        string[] UnknownCommandLineArgs { get; }
+
+        /// <summary>
+        /// The variables that were parsed from the command line.
+        /// Key = variable name, Value = variable value.
+        /// </summary>
+        KeyValuePair<string, string>[] Variables { get; }
+
+        /// <summary>
+        /// Sets overridable variables from the command line.
+        /// </summary>
+        /// <param name="overridableVariables">The overridable variable information from <see cref="IBootstrapperApplicationData"/>.</param>
+        /// <param name="engine">The engine.</param>
+        void SetOverridableVariables(IOverridableVariables overridableVariables, IEngine engine);
+    }
+}
diff --git a/src/api/burn/WixToolset.Mba.Core/IOverridableVariableInfo.cs b/src/api/burn/WixToolset.Mba.Core/IOverridableVariableInfo.cs
new file mode 100644
index 00000000..d01dead3
--- /dev/null
+++ b/src/api/burn/WixToolset.Mba.Core/IOverridableVariableInfo.cs
@@ -0,0 +1,15 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
+
+namespace WixToolset.Mba.Core
+{
+    /// <summary>
+    /// Overridable variable from the BA manifest.
+    /// </summary>
+    public interface IOverridableVariableInfo
+    {
+        /// <summary>
+        /// The Variable name.
+        /// </summary>
+        string Name { get; }
+    }
+}
\ No newline at end of file
diff --git a/src/api/burn/WixToolset.Mba.Core/IOverridableVariables.cs b/src/api/burn/WixToolset.Mba.Core/IOverridableVariables.cs
new file mode 100644
index 00000000..3944913b
--- /dev/null
+++ b/src/api/burn/WixToolset.Mba.Core/IOverridableVariables.cs
@@ -0,0 +1,17 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
+
+namespace WixToolset.Mba.Core
+{
+    using System.Collections.Generic;
+
+    /// <summary>
+    /// Overridable variable information from the BA manifest.
+    /// </summary>
+    public interface IOverridableVariables
+    {
+        /// <summary>
+        /// Variable Dictionary of variable name to <see cref="IOverridableVariableInfo"/>.
+        /// </summary>
+        IDictionary<string, IOverridableVariableInfo> Variables { get; }
+    }
+}
\ No newline at end of file
diff --git a/src/api/burn/WixToolset.Mba.Core/MbaCommand.cs b/src/api/burn/WixToolset.Mba.Core/MbaCommand.cs
new file mode 100644
index 00000000..e7e49607
--- /dev/null
+++ b/src/api/burn/WixToolset.Mba.Core/MbaCommand.cs
@@ -0,0 +1,33 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
+
+namespace WixToolset.Mba.Core
+{
+    using System.Collections.Generic;
+
+    /// <summary>
+    /// Default implementation of <see cref="IMbaCommand"/>.
+    /// </summary>
+    internal sealed class MbaCommand : IMbaCommand
+    {
+        public string[] UnknownCommandLineArgs { get; internal set; }
+
+        public KeyValuePair<string, string>[] Variables { get; internal set; }
+
+        internal MbaCommand() { }
+
+        public void SetOverridableVariables(IOverridableVariables overridableVariables, IEngine engine)
+        {
+            foreach (var kvp in this.Variables)
+            {
+                if (!overridableVariables.Variables.TryGetValue(kvp.Key, out var overridableVariable))
+                {
+                    engine.Log(LogLevel.Error, string.Format("Ignoring attempt to set non-overridable variable: '{0}'.", kvp.Key));
+                }
+                else
+                {
+                    engine.SetVariableString(overridableVariable.Name, kvp.Value, false);
+                }
+            }
+        }
+    }
+}
diff --git a/src/api/burn/WixToolset.Mba.Core/OverridableVariableInfo.cs b/src/api/burn/WixToolset.Mba.Core/OverridableVariableInfo.cs
new file mode 100644
index 00000000..b8e85c34
--- /dev/null
+++ b/src/api/burn/WixToolset.Mba.Core/OverridableVariableInfo.cs
@@ -0,0 +1,15 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
+
+namespace WixToolset.Mba.Core
+{
+    /// <summary>
+    /// Default implementation of <see cref="IOverridableVariableInfo"/>.
+    /// </summary>
+    internal class OverridableVariableInfo : IOverridableVariableInfo
+    {
+        /// <inheritdoc />
+        public string Name { get; internal set; }
+
+        internal OverridableVariableInfo() { }
+    }
+}
diff --git a/src/api/burn/WixToolset.Mba.Core/OverridableVariables.cs b/src/api/burn/WixToolset.Mba.Core/OverridableVariables.cs
new file mode 100644
index 00000000..855ce9a9
--- /dev/null
+++ b/src/api/burn/WixToolset.Mba.Core/OverridableVariables.cs
@@ -0,0 +1,51 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
+
+namespace WixToolset.Mba.Core
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Xml;
+    using System.Xml.XPath;
+
+    /// <summary>
+    /// Default implementation of <see cref="IOverridableVariables"/>.
+    /// </summary>
+    public class OverridableVariablesInfo : IOverridableVariables
+    {
+        /// <inheritdoc />
+        public IDictionary<string, IOverridableVariableInfo> Variables { get; internal set; }
+
+        internal OverridableVariablesInfo() { }
+
+        /// <summary>
+        /// Parses the overridable variable info from the BA manifest.
+        /// </summary>
+        /// <param name="root">XML root</param>
+        /// <returns>The parsed information.</returns>
+        public static IOverridableVariables ParseFromXml(XPathNavigator root)
+        {
+            XmlNamespaceManager namespaceManager = new XmlNamespaceManager(root.NameTable);
+            namespaceManager.AddNamespace("p", BootstrapperApplicationData.XMLNamespace);
+            XPathNodeIterator nodes = root.Select("/p:BootstrapperApplicationData/p:WixStdbaOverridableVariable", namespaceManager);
+
+            var overridableVariables = new OverridableVariablesInfo();
+            overridableVariables.Variables = new Dictionary<string, IOverridableVariableInfo>();
+
+            foreach (XPathNavigator node in nodes)
+            {
+                var variable = new OverridableVariableInfo();
+
+                string name = BootstrapperApplicationData.GetAttribute(node, "Name");
+                if (name == null)
+                {
+                    throw new Exception("Failed to get name for overridable variable.");
+                }
+                variable.Name = name;
+
+                overridableVariables.Variables.Add(variable.Name, variable);
+            }
+
+            return overridableVariables;
+        }
+    }
+}