Absorb Tag.wixext into Core as SoftwareTag element

Resolves wixtoolset/issues#5949

7 files changed, 355 insertions, 2 deletions

diff --git a/src/WixToolset.Core/Bind/FileFacade.cs b/src/WixToolset.Core/Bind/FileFacade.cs
index ec4e9725..9705cd01 100644
--- a/src/WixToolset.Core/Bind/FileFacade.cs
+++ b/src/WixToolset.Core/Bind/FileFacade.cs
@@ -125,7 +125,7 @@ namespace WixToolset.Core.Bind
 
         public SourceLineNumber SourceLineNumber => this.FileRow == null ? this.FileSymbol.SourceLineNumbers : this.FileRow.SourceLineNumbers;
 
-        public string SourcePath => this.FileRow == null ? this.FileSymbol.Source.Path : this.FileRow.Source;
+        public string SourcePath => this.FileRow == null ? this.FileSymbol.Source?.Path : this.FileRow.Source;
 
         public bool Compressed => this.FileRow == null ? (this.FileSymbol.Attributes & FileSymbolAttributes.Compressed) == FileSymbolAttributes.Compressed : (this.FileRow.Attributes & WindowsInstallerConstants.MsidbFileAttributesCompressed) == WindowsInstallerConstants.MsidbFileAttributesCompressed;
 
diff --git a/src/WixToolset.Core/CompilerCore.cs b/src/WixToolset.Core/CompilerCore.cs
index 1f6d6329..53e0f3fc 100644
--- a/src/WixToolset.Core/CompilerCore.cs
+++ b/src/WixToolset.Core/CompilerCore.cs
@@ -6,7 +6,6 @@ namespace WixToolset.Core
     using System.Collections;
     using System.Collections.Generic;
     using System.Diagnostics;
-    using System.Diagnostics.CodeAnalysis;
     using System.Globalization;
     using System.Reflection;
     using System.Text;
diff --git a/src/WixToolset.Core/CompilerErrors.cs b/src/WixToolset.Core/CompilerErrors.cs
new file mode 100644
index 00000000..da64c376
--- /dev/null
+++ b/src/WixToolset.Core/CompilerErrors.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.Core
+{
+    using WixToolset.Data;
+
+    internal static class CompilerErrors
+    {
+        public static Message IllegalName(SourceLineNumber sourceLineNumbers, string parentElement, string name)
+        {
+            return Message(sourceLineNumbers, Ids.IllegalName, "The Tag/@Name attribute value, '{1}', contains invalid filename identifiers. The Tag/@Name may have defaulted from the {0}/@Name attrbute. If so, use the Tag/@Name attribute to provide a valid filename. Any character except for the follow may be used: \\ ? | > < : / * \".", parentElement, name);
+        }
+
+        public static Message ExampleRegid(SourceLineNumber sourceLineNumbers, string regid)
+        {
+            return Message(sourceLineNumbers, Ids.ExampleRegid, "Regid '{0}' is a placeholder that must be replaced with an appropriate value for your installation. Use the simplified URI for your organization or project.", regid);
+        }
+
+        private static Message Message(SourceLineNumber sourceLineNumber, Ids id, string format, params object[] args)
+        {
+            return new Message(sourceLineNumber, MessageLevel.Error, (int)id, format, args);
+        }
+
+        public enum Ids
+        {
+            IllegalName = 6601,
+            ExampleRegid = 6602,
+        }
+    }
+}
diff --git a/src/WixToolset.Core/Compiler_2.cs b/src/WixToolset.Core/Compiler_2.cs
index 09d56e49..295392c8 100644
--- a/src/WixToolset.Core/Compiler_2.cs
+++ b/src/WixToolset.Core/Compiler_2.cs
@@ -316,6 +316,9 @@ namespace WixToolset.Core
                             string parentName = null;
                             this.ParseSFPCatalogElement(child, ref parentName);
                             break;
+                        case "SoftwareTag":
+                            this.ParsePackageTagElement(child);
+                            break;
                         case "SummaryInformation":
                             this.ParseSummaryInformationElement(child, ref isCodepageSet, ref isPackageNameSet, ref isKeywordsSet, ref isPackageAuthorSet);
                             break;
diff --git a/src/WixToolset.Core/Compiler_Bundle.cs b/src/WixToolset.Core/Compiler_Bundle.cs
index 7a386de7..1ee09166 100644
--- a/src/WixToolset.Core/Compiler_Bundle.cs
+++ b/src/WixToolset.Core/Compiler_Bundle.cs
@@ -346,6 +346,9 @@ namespace WixToolset.Core
                     case "SetVariableRef":
                         this.ParseSimpleRefElement(child, SymbolDefinitions.WixSetVariable);
                         break;
+                    case "SoftwareTag":
+                        this.ParseBundleTagElement(child);
+                        break;
                     case "Update":
                         this.ParseUpdateElement(child);
                         break;
diff --git a/src/WixToolset.Core/Compiler_Patch.cs b/src/WixToolset.Core/Compiler_Patch.cs
index 2fb1affb..83737c43 100644
--- a/src/WixToolset.Core/Compiler_Patch.cs
+++ b/src/WixToolset.Core/Compiler_Patch.cs
@@ -410,6 +410,9 @@ namespace WixToolset.Core
                     case "PropertyRef":
                         this.ParsePatchChildRefElement(child, "Property");
                         break;
+                    case "SoftwareTagRef":
+                        this.ParseTagRefElement(child);
+                        break;
                     case "UIRef":
                         this.ParsePatchChildRefElement(child, "WixUI");
                         break;
diff --git a/src/WixToolset.Core/Compiler_Tag.cs b/src/WixToolset.Core/Compiler_Tag.cs
new file mode 100644
index 00000000..2b3523c8
--- /dev/null
+++ b/src/WixToolset.Core/Compiler_Tag.cs
@@ -0,0 +1,315 @@
+// 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.Core
+{
+    using System;
+    using System.Xml.Linq;
+    using WixToolset.Data;
+    using WixToolset.Data.Symbols;
+
+    /// <summary>
+    /// Compiler of the WiX toolset.
+    /// </summary>
+    internal partial class Compiler : ICompiler
+    {
+        /// <summary>
+        /// Parses a Tag element for Software Id Tag registration under a Bundle element.
+        /// </summary>
+        /// <param name="node">The element to parse.</param>
+        private void ParseBundleTagElement(XElement node)
+        {
+            var sourceLineNumbers = Preprocessor.GetSourceLineNumbers(node);
+            string name = null;
+            string regid = null;
+            string installPath = null;
+
+            foreach (var attrib in node.Attributes())
+            {
+                if (String.IsNullOrEmpty(attrib.Name.NamespaceName) || CompilerCore.WixNamespace == attrib.Name.Namespace)
+                {
+                    switch (attrib.Name.LocalName)
+                    {
+                        case "Name":
+                            name = this.Core.GetAttributeLongFilename(sourceLineNumbers, attrib, false);
+                            break;
+                        case "Regid":
+                            regid = this.Core.GetAttributeValue(sourceLineNumbers, attrib);
+                            break;
+                        case "InstallDirectory":
+                        case "Bitness":
+                            this.Core.Write(ErrorMessages.ExpectedParentWithAttribute(sourceLineNumbers, node.Name.LocalName, attrib.Name.LocalName, "Package"));
+                            break;
+                        case "InstallPath":
+                            installPath = this.Core.GetAttributeValue(sourceLineNumbers, attrib);
+                            break;
+                        default:
+                            this.Core.UnexpectedAttribute(node, attrib);
+                            break;
+                    }
+                }
+                else
+                {
+                    this.Core.ParseExtensionAttribute(node, attrib);
+                }
+            }
+
+            this.Core.ParseForExtensionElements(node);
+
+            if (String.IsNullOrEmpty(name))
+            {
+                name = node.Parent?.Attribute("Name")?.Value;
+
+                if (String.IsNullOrEmpty(name))
+                {
+                    this.Core.Write(ErrorMessages.ExpectedAttribute(sourceLineNumbers, node.Name.LocalName, "Name"));
+                }
+            }
+
+            if (!String.IsNullOrEmpty(name) && !this.Core.IsValidLongFilename(name))
+            {
+                this.Core.Write(CompilerErrors.IllegalName(sourceLineNumbers, node.Name.LocalName, name));
+            }
+
+            if (String.IsNullOrEmpty(regid))
+            {
+                this.Core.Write(ErrorMessages.ExpectedAttribute(sourceLineNumbers, node.Name.LocalName, "Regid"));
+            }
+            else if (regid.Equals("example.com", StringComparison.OrdinalIgnoreCase))
+            {
+                this.Core.Write(CompilerErrors.ExampleRegid(sourceLineNumbers, regid));
+            }
+
+            if (String.IsNullOrEmpty(installPath))
+            {
+                this.Core.Write(ErrorMessages.ExpectedAttribute(sourceLineNumbers, node.Name.LocalName, "InstallPath"));
+            }
+
+            if (!this.Core.EncounteredError)
+            {
+                this.Core.AddSymbol(new WixBundleTagSymbol(sourceLineNumbers)
+                {
+                    Filename = String.Concat(name, ".swidtag"),
+                    Regid = regid,
+                    Name = name,
+                    InstallPath = installPath
+                });
+            }
+        }
+
+        /// <summary>
+        /// Parses a Tag element for Software Id Tag registration under a Package element.
+        /// </summary>
+        /// <param name="node">The element to parse.</param>
+        private void ParsePackageTagElement(XElement node)
+        {
+            var sourceLineNumbers = Preprocessor.GetSourceLineNumbers(node);
+            Identifier id = null;
+            string name = null;
+            string regid = null;
+            string feature = null;
+            string installDirectory = null;
+            var win64 = this.Context.IsCurrentPlatform64Bit;
+
+            foreach (var attrib in node.Attributes())
+            {
+                if (String.IsNullOrEmpty(attrib.Name.NamespaceName) || CompilerCore.WixNamespace == attrib.Name.Namespace)
+                {
+                    switch (attrib.Name.LocalName)
+                    {
+                        case "Id":
+                            id = this.Core.GetAttributeIdentifier(sourceLineNumbers, attrib);
+                            break;
+                        case "Name":
+                            name = this.Core.GetAttributeLongFilename(sourceLineNumbers, attrib, false);
+                            break;
+                        case "Regid":
+                            regid = this.Core.GetAttributeValue(sourceLineNumbers, attrib);
+                            break;
+                        case "Feature":
+                            feature = this.Core.GetAttributeIdentifierValue(sourceLineNumbers, attrib);
+                            break;
+                        case "InstallDirectory":
+                            installDirectory = this.Core.GetAttributeIdentifierValue(sourceLineNumbers, attrib);
+                            break;
+                        case "InstallPath":
+                            this.Core.Write(ErrorMessages.ExpectedParentWithAttribute(sourceLineNumbers, node.Name.LocalName, attrib.Name.LocalName, "Bundle"));
+                            break;
+                        case "Bitness":
+                            var bitnessValue = this.Core.GetAttributeValue(sourceLineNumbers, attrib);
+                            switch (bitnessValue)
+                            {
+                                case "always32":
+                                    win64 = false;
+                                    break;
+                                case "always64":
+                                    win64 = true;
+                                    break;
+                                case "default":
+                                case "":
+                                    break;
+                                default:
+                                    this.Core.Write(ErrorMessages.IllegalAttributeValue(sourceLineNumbers, node.Name.LocalName, attrib.Name.LocalName, bitnessValue, "default", "always32", "always64"));
+                                    break;
+                            }
+                            break;
+                        default:
+                            this.Core.UnexpectedAttribute(node, attrib);
+                            break;
+                    }
+                }
+                else
+                {
+                    this.Core.ParseExtensionAttribute(node, attrib);
+                }
+            }
+
+            this.Core.ParseForExtensionElements(node);
+
+            if (String.IsNullOrEmpty(name))
+            {
+                name = node.Parent?.Attribute("Name")?.Value;
+
+                if (String.IsNullOrEmpty(name))
+                {
+                    this.Core.Write(ErrorMessages.ExpectedAttribute(sourceLineNumbers, node.Name.LocalName, "Name"));
+                }
+            }
+
+            if (!String.IsNullOrEmpty(name) && !this.Core.IsValidLongFilename(name))
+            {
+                this.Core.Write(CompilerErrors.IllegalName(sourceLineNumbers, node.Name.LocalName, name));
+            }
+
+            if (String.IsNullOrEmpty(regid))
+            {
+                this.Core.Write(ErrorMessages.ExpectedAttribute(sourceLineNumbers, node.Name.LocalName, "Regid"));
+            }
+            else if (regid.Equals("example.com", StringComparison.OrdinalIgnoreCase))
+            {
+                this.Core.Write(CompilerErrors.ExampleRegid(sourceLineNumbers, regid));
+                return;
+            }
+            else if (id == null)
+            {
+                id = this.CreateTagId(regid);
+            }
+
+            if (String.IsNullOrEmpty(installDirectory))
+            {
+                this.Core.Write(ErrorMessages.ExpectedAttribute(sourceLineNumbers, node.Name.LocalName, "InstallDirectory"));
+            }
+
+            if (!this.Core.EncounteredError)
+            {
+                var fileName = String.Concat(name, ".swidtag");
+
+                this.Core.CreateSimpleReference(sourceLineNumbers, SymbolDefinitions.Directory, installDirectory);
+                this.Core.AddSymbol(new DirectorySymbol(sourceLineNumbers, id)
+                {
+                    Name = "swidtag",
+                    ParentDirectoryRef = installDirectory,
+                    ComponentGuidGenerationSeed = "4BAD0C8B-3AF0-BFE3-CC83-094749A1C4B1"
+                });
+
+                this.Core.AddSymbol(new ComponentSymbol(sourceLineNumbers, id)
+                {
+                    ComponentId = "*",
+                    DirectoryRef = id.Id,
+                    KeyPath = id.Id,
+                    KeyPathType = ComponentKeyPathType.File,
+                    Location = ComponentLocation.LocalOnly,
+                    Win64 = win64
+                });
+
+                this.Core.AddSymbol(new FileSymbol(sourceLineNumbers, id)
+                {
+                    ComponentRef = id.Id,
+                    Name = fileName,
+                    DiskId = 1,
+                    Attributes = FileSymbolAttributes.ReadOnly,
+                });
+
+                if (!String.IsNullOrEmpty(feature))
+                {
+                    this.Core.CreateSimpleReference(sourceLineNumbers, SymbolDefinitions.Feature, feature);
+                }
+                else
+                {
+                    feature = "WixSwidTag";
+                    this.Core.AddSymbol(new FeatureSymbol(sourceLineNumbers, new Identifier(AccessModifier.Private, feature))
+                    {
+                        Title = "ISO/IEC 19770-2",
+                        Level = 1,
+                        InstallDefault = FeatureInstallDefault.Local,
+                        Display = 0,
+                        DisallowAdvertise = true,
+                        DisallowAbsent = true,
+                    });
+                }
+                this.Core.CreateComplexReference(sourceLineNumbers, ComplexReferenceParentType.Feature, feature, null, ComplexReferenceChildType.Component, id.Id, true);
+
+                this.Core.EnsureTable(sourceLineNumbers, "SoftwareIdentificationTag");
+                this.Core.AddSymbol(new WixProductTagSymbol(sourceLineNumbers, id)
+                {
+                    FileRef = id.Id,
+                    Regid = regid,
+                    Name = name
+                });
+            }
+        }
+
+        /// <summary>
+        /// Parses a TagRef element for Software Id Tag registration under a PatchFamily element.
+        /// </summary>
+        /// <param name="node">The element to parse.</param>
+        private void ParseTagRefElement(XElement node)
+        {
+            var sourceLineNumbers = Preprocessor.GetSourceLineNumbers(node);
+            string regid = null;
+
+            foreach (var attrib in node.Attributes())
+            {
+                if (String.IsNullOrEmpty(attrib.Name.NamespaceName) || CompilerCore.WixNamespace == attrib.Name.Namespace)
+                {
+                    switch (attrib.Name.LocalName)
+                    {
+                        case "Regid":
+                            regid = this.Core.GetAttributeValue(sourceLineNumbers, attrib);
+                            break;
+                        default:
+                            this.Core.UnexpectedAttribute(node, attrib);
+                            break;
+                    }
+                }
+                else
+                {
+                    this.Core.ParseExtensionAttribute(node, attrib);
+                }
+            }
+
+            this.Core.ParseForExtensionElements(node);
+
+            if (String.IsNullOrEmpty(regid))
+            {
+                this.Core.Write(ErrorMessages.ExpectedAttribute(sourceLineNumbers, node.Name.LocalName, "Regid"));
+            }
+            else if (regid.Equals("example.com", StringComparison.OrdinalIgnoreCase))
+            {
+                this.Core.Write(CompilerErrors.ExampleRegid(sourceLineNumbers, regid));
+            }
+
+            if (!this.Core.EncounteredError)
+            {
+                var id = this.CreateTagId(regid);
+
+                this.Core.AddSymbol(new WixPatchRefSymbol(sourceLineNumbers, id)
+                {
+                    Table = SymbolDefinitions.Component.Name,
+                    PrimaryKeys = id.Id
+                });
+            }
+        }
+
+        private Identifier CreateTagId(string regid) => this.Core.CreateIdentifier("tag", regid, ".product.tag");
+    }
+}