Add conversion for BootstrapperApplicationDll and bal:UseUILanguages.

4 files changed, 237 insertions, 8 deletions

diff --git a/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj b/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj
index f0ea99c6..1d4f09dd 100644
--- a/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj
+++ b/src/WixToolset.Converters.Symbolizer/WixToolset.Converters.Symbolizer.csproj
@@ -30,6 +30,6 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
-    <PackageReference Include="Nerdbank.GitVersioning" Version="3.1.91" PrivateAssets="All" />
+    <PackageReference Include="Nerdbank.GitVersioning" Version="3.3.37" PrivateAssets="All" />
   </ItemGroup>
 </Project>
diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs
index 2100b22d..c83ef551 100644
--- a/src/WixToolset.Converters/WixConverter.cs
+++ b/src/WixToolset.Converters/WixConverter.cs
@@ -31,6 +31,7 @@ namespace WixToolset.Converters
         private const char XDocumentNewLine = '\n'; // XDocument normalizes "\r\n" to just "\n".
         private static readonly XNamespace WixNamespace = "http://wixtoolset.org/schemas/v4/wxs";
         private static readonly XNamespace Wix3Namespace = "http://schemas.microsoft.com/wix/2006/wi";
+        private static readonly XNamespace WixBalNamespace = "http://wixtoolset.org/schemas/v4/wxs/bal";
         private static readonly XNamespace WixUtilNamespace = "http://wixtoolset.org/schemas/v4/wxs/util";
         private static readonly XNamespace WixFirewallNamespace = "http://wixtoolset.org/schemas/v4/wxs/firewall";
 
@@ -40,6 +41,7 @@ namespace WixToolset.Converters
         private static readonly XName InstallExecuteSequenceElementName = WixNamespace + "InstallExecuteSequence";
         private static readonly XName InstallUISequenceSequenceElementName = WixNamespace + "InstallUISequence";
         private static readonly XName BootstrapperApplicationElementName = WixNamespace + "BootstrapperApplication";
+        private static readonly XName BootstrapperApplicationDllElementName = WixNamespace + "BootstrapperApplicationDll";
         private static readonly XName EmbeddedChainerElementName = WixNamespace + "EmbeddedChainer";
         private static readonly XName ColumnElementName = WixNamespace + "Column";
         private static readonly XName ComponentElementName = WixNamespace + "Component";
@@ -77,6 +79,7 @@ namespace WixToolset.Converters
         private static readonly XName UITextElementName = WixNamespace + "UIText";
         private static readonly XName VariableElementName = WixNamespace + "Variable";
         private static readonly XName VerbElementName = WixNamespace + "Verb";
+        private static readonly XName BalUseUILanguagesName = WixBalNamespace + "UseUILanguages";
         private static readonly XName UtilCloseApplicationElementName = WixUtilNamespace + "CloseApplication";
         private static readonly XName UtilPermissionExElementName = WixUtilNamespace + "PermissionEx";
         private static readonly XName UtilRegistrySearchName = WixUtilNamespace + "RegistrySearch";
@@ -453,10 +456,83 @@ namespace WixToolset.Converters
 
         private void ConvertBootstrapperApplicationElement(XElement element)
         {
-            if (this.SourceVersion < 4 && null == element.Attribute("DpiAwareness") &&
-                this.OnError(ConverterTestType.AssignBootstrapperApplicationDpiAwareness, element, "The BootstrapperApplication DpiAwareness attribute is being set to 'unaware' to ensure it remains the same as the v3 default"))
+            var xUseUILanguages = element.Attribute(BalUseUILanguagesName);
+            if (xUseUILanguages != null &&
+                this.OnError(ConverterTestType.BalUseUILanguagesDeprecated, element, "bal:UseUILanguages is deprecated, 'true' is now the standard behavior."))
             {
-                element.Add(new XAttribute("DpiAwareness", "unaware"));
+                xUseUILanguages.Remove();
+            }
+
+            var xBADll = element.Elements(BootstrapperApplicationDllElementName).FirstOrDefault();
+            if (xBADll == null)
+            {
+                xBADll = this.CreateBootstrapperApplicationDllElement(element);
+
+                if (xBADll != null)
+                {
+                    element.Add(Environment.NewLine);
+                    element.Add(xBADll);
+                    element.Add(Environment.NewLine);
+                }
+            }
+        }
+
+        private XElement CreateBootstrapperApplicationDllElement(XElement element)
+        {
+            XElement xBADll = null;
+            var xSource = element.Attribute("SourceFile");
+            var xDpiAwareness = element.Attribute("DpiAwareness");
+
+            if (xSource != null)
+            {
+                if (xBADll != null || CreateBADllElement(element, out xBADll))
+                {
+                    MoveAttribute(element, "SourceFile", xBADll);
+                    MoveAttribute(element, "Name", xBADll);
+                }
+            }
+            else if (xDpiAwareness != null || this.SourceVersion < 4) // older code might be relying on old behavior of first Payload element being the BA dll.
+            {
+                var xFirstChild = element.Elements().FirstOrDefault();
+                if (xFirstChild?.Name == PayloadElementName)
+                {
+                    if (xBADll != null || CreateBADllElement(element, out xBADll))
+                    {
+                        var attributes = xFirstChild.Attributes().ToList();
+                        xFirstChild.Remove();
+
+                        foreach (var attribute in attributes)
+                        {
+                            xBADll.Add(attribute);
+                        }
+                    }
+                }
+                else
+                {
+                    this.OnError(ConverterTestType.BootstrapperApplicationDllRequired, element, "The new BootstrapperApplicationDll element is required but could not be added automatically since the bootstrapper application dll was not directly specified.");
+                }
+            }
+
+            if (xDpiAwareness != null)
+            {
+                if (xBADll != null || CreateBADllElement(element, out xBADll))
+                {
+                    MoveAttribute(element, "DpiAwareness", xBADll);
+                }
+            }
+            else if (this.SourceVersion < 4 && xBADll != null &&
+                this.OnError(ConverterTestType.AssignBootstrapperApplicationDpiAwareness, element, "The BootstrapperApplicationDll DpiAwareness attribute is being set to 'unaware' to ensure it remains the same as the v3 default"))
+            {
+                xBADll.Add(new XAttribute("DpiAwareness", "unaware"));
+            }
+
+            return xBADll;
+
+            bool CreateBADllElement(XObject node, out XElement xCreatedBADll)
+            {
+                var create = this.OnError(ConverterTestType.BootstrapperApplicationDll, node, "The bootstrapper application dll is now specified in the BootstrapperApplicationDll element.");
+                xCreatedBADll = create ? new XElement(BootstrapperApplicationDllElementName) : null;
+                return create;
             }
         }
 
@@ -1489,6 +1565,21 @@ namespace WixToolset.Converters
             /// Verb/@Target can't be converted.
             /// </summary>
             VerbTargetNotConvertable,
+
+            /// <summary>
+            /// The bootstrapper application dll is now specified in its own element.
+            /// </summary>
+            BootstrapperApplicationDll,
+
+            /// <summary>
+            /// The new bootstrapper application dll element is required.
+            /// </summary>
+            BootstrapperApplicationDllRequired,
+
+            /// <summary>
+            /// bal:UseUILanguages is deprecated, 'true' is now the standard behavior.
+            /// </summary>
+            BalUseUILanguagesDeprecated,
         }
     }
 }
diff --git a/src/WixToolset.Converters/WixToolset.Converters.csproj b/src/WixToolset.Converters/WixToolset.Converters.csproj
index 424a393b..46eb54ea 100644
--- a/src/WixToolset.Converters/WixToolset.Converters.csproj
+++ b/src/WixToolset.Converters/WixToolset.Converters.csproj
@@ -22,6 +22,6 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
-    <PackageReference Include="Nerdbank.GitVersioning" Version="3.1.91" PrivateAssets="All" />
+    <PackageReference Include="Nerdbank.GitVersioning" Version="3.3.37" PrivateAssets="All" />
   </ItemGroup>
 </Project>
diff --git a/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs b/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs
index 68a8afc8..dc5bae00 100644
--- a/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs
+++ b/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs
@@ -12,12 +12,14 @@ namespace WixToolsetTest.Converters
     public class BootstrapperApplicationFixture : BaseConverterFixture
     {
         [Fact]
-        public void SetsDpiUnawareFromV3()
+        public void CantCreateBootstrapperApplicationDllFromV3PayloadGroupRef()
         {
             var parse = String.Join(Environment.NewLine,
                 "<Wix xmlns='http://schemas.microsoft.com/wix/2006/wi'>",
                 "  <Fragment>",
-                "    <BootstrapperApplication Id='ba' />",
+                "    <BootstrapperApplication Id='ba'>",
+                "      <PayloadGroupRef Id='baPayloads' />",
+                "    </BootstrapperApplication>",
                 "  </Fragment>",
                 "</Wix>");
 
@@ -25,7 +27,9 @@ namespace WixToolsetTest.Converters
             {
                 "<Wix xmlns=\"http://wixtoolset.org/schemas/v4/wxs\">",
                 "  <Fragment>",
-                "    <BootstrapperApplication Id=\"ba\" DpiAwareness=\"unaware\" />",
+                "    <BootstrapperApplication Id=\"ba\">",
+                "      <PayloadGroupRef Id=\"baPayloads\" />",
+                "    </BootstrapperApplication>",
                 "  </Fragment>",
                 "</Wix>"
             };
@@ -43,6 +47,76 @@ namespace WixToolsetTest.Converters
         }
 
         [Fact]
+        public void CreateBootstrapperApplicationDllFromV3()
+        {
+            var parse = String.Join(Environment.NewLine,
+                "<Wix xmlns='http://schemas.microsoft.com/wix/2006/wi'>",
+                "  <Fragment>",
+                "    <BootstrapperApplication Id='ba' SourceFile='ba.dll' />",
+                "  </Fragment>",
+                "</Wix>");
+
+            var expected = new[]
+            {
+                "<Wix xmlns=\"http://wixtoolset.org/schemas/v4/wxs\">",
+                "  <Fragment>",
+                "    <BootstrapperApplication Id=\"ba\">",
+                "<BootstrapperApplicationDll SourceFile=\"ba.dll\" DpiAwareness=\"unaware\" />",
+                "</BootstrapperApplication>",
+                "  </Fragment>",
+                "</Wix>"
+            };
+
+            var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo);
+
+            var messaging = new MockMessaging();
+            var converter = new WixConverter(messaging, 2, null, null);
+
+            var errors = converter.ConvertDocument(document);
+            Assert.Equal(3, errors);
+
+            var actualLines = UnformattedDocumentLines(document);
+            WixAssert.CompareLineByLine(expected, actualLines);
+        }
+
+        [Fact]
+        public void CreateBootstrapperApplicationDllFromV3Payload()
+        {
+            var parse = String.Join(Environment.NewLine,
+                "<Wix xmlns='http://schemas.microsoft.com/wix/2006/wi'>",
+                "  <Fragment>",
+                "    <BootstrapperApplication Id='ba'>",
+                "      <Payload SourceFile='ba.dll' />",
+                "    </BootstrapperApplication>",
+                "  </Fragment>",
+                "</Wix>");
+
+            var expected = new[]
+            {
+                "<Wix xmlns=\"http://wixtoolset.org/schemas/v4/wxs\">",
+                "  <Fragment>",
+                "    <BootstrapperApplication Id=\"ba\">",
+                "      ",
+                "    ",
+                "<BootstrapperApplicationDll SourceFile=\"ba.dll\" DpiAwareness=\"unaware\" />",
+                "</BootstrapperApplication>",
+                "  </Fragment>",
+                "</Wix>"
+            };
+
+            var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo);
+
+            var messaging = new MockMessaging();
+            var converter = new WixConverter(messaging, 2, null, null);
+
+            var errors = converter.ConvertDocument(document);
+            Assert.Equal(3, errors);
+
+            var actualLines = UnformattedDocumentLines(document);
+            WixAssert.CompareLineByLine(expected, actualLines);
+        }
+
+        [Fact]
         public void DoesntSetDpiUnawareFromV4()
         {
             var parse = String.Join(Environment.NewLine,
@@ -72,5 +146,69 @@ namespace WixToolsetTest.Converters
             var actualLines = UnformattedDocumentLines(document);
             WixAssert.CompareLineByLine(expected, actualLines);
         }
+
+        [Fact]
+        public void KeepsDpiAwarenessFromV4()
+        {
+            var parse = String.Join(Environment.NewLine,
+                "<Wix xmlns='http://wixtoolset.org/schemas/v4/wxs'>",
+                "  <Fragment>",
+                "    <BootstrapperApplication Id='ba' SourceFile='ba.dll' DpiAwareness='system' />",
+                "  </Fragment>",
+                "</Wix>");
+
+            var expected = new[]
+            {
+                "<Wix xmlns=\"http://wixtoolset.org/schemas/v4/wxs\">",
+                "  <Fragment>",
+                "    <BootstrapperApplication Id=\"ba\">",
+                "<BootstrapperApplicationDll SourceFile=\"ba.dll\" DpiAwareness=\"system\" />",
+                "</BootstrapperApplication>",
+                "  </Fragment>",
+                "</Wix>"
+            };
+
+            var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo);
+
+            var messaging = new MockMessaging();
+            var converter = new WixConverter(messaging, 2, null, null);
+
+            var errors = converter.ConvertDocument(document);
+            Assert.Equal(1, errors);
+
+            var actualLines = UnformattedDocumentLines(document);
+            WixAssert.CompareLineByLine(expected, actualLines);
+        }
+
+        [Fact]
+        public void RemovesBalUseUILanguages()
+        {
+            var parse = String.Join(Environment.NewLine,
+                "<Wix xmlns='http://schemas.microsoft.com/wix/2006/wi' xmlns:bal='http://schemas.microsoft.com/wix/BalExtension'>",
+                "  <Fragment>",
+                "    <BootstrapperApplication Id='ba' bal:UseUILanguages='true' />",
+                "  </Fragment>",
+                "</Wix>");
+
+            var expected = new[]
+            {
+                "<Wix xmlns=\"http://wixtoolset.org/schemas/v4/wxs\" xmlns:bal=\"http://wixtoolset.org/schemas/v4/wxs/bal\">",
+                "  <Fragment>",
+                "    <BootstrapperApplication Id=\"ba\" />",
+                "  </Fragment>",
+                "</Wix>"
+            };
+
+            var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo);
+
+            var messaging = new MockMessaging();
+            var converter = new WixConverter(messaging, 2, null, null);
+
+            var errors = converter.ConvertDocument(document);
+            Assert.Equal(4, errors);
+
+            var actualLines = UnformattedDocumentLines(document);
+            WixAssert.CompareLineByLine(expected, actualLines);
+        }
     }
 }