CreateGroups additions

Signed-off-by: Bevan Weiss <bevan.weiss@gmail.com>

6 files changed, 357 insertions, 32 deletions

diff --git a/src/ext/Util/wixext/Symbols/GroupGroupSymbol.cs b/src/ext/Util/wixext/Symbols/GroupGroupSymbol.cs
new file mode 100644
index 00000000..fdd1ee76
--- /dev/null
+++ b/src/ext/Util/wixext/Symbols/GroupGroupSymbol.cs
@@ -0,0 +1,56 @@
+// 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.Util
+{
+    using WixToolset.Data;
+    using WixToolset.Util.Symbols;
+
+    public static partial class UtilSymbolDefinitions
+    {
+        public static readonly IntermediateSymbolDefinition GroupGroup = new IntermediateSymbolDefinition(
+            UtilSymbolDefinitionType.GroupGroup.ToString(),
+            new[]
+            {
+                new IntermediateFieldDefinition(nameof(GroupGroupSymbol.SymbolFields.ParentGroupRef), IntermediateFieldType.String),
+                new IntermediateFieldDefinition(nameof(GroupGroupSymbol.SymbolFields.ChildGroupRef), IntermediateFieldType.String),
+            },
+            typeof(UserGroupSymbol));
+    }
+}
+
+namespace WixToolset.Util.Symbols
+{
+    using WixToolset.Data;
+
+    public class GroupGroupSymbol : IntermediateSymbol
+    {
+        public enum SymbolFields
+        {
+            ParentGroupRef,
+            ChildGroupRef,
+        }
+
+        public GroupGroupSymbol() : base(UtilSymbolDefinitions.GroupGroup, null, null)
+        {
+        }
+
+        public GroupGroupSymbol(SourceLineNumber sourceLineNumber, Identifier id = null) : base(UtilSymbolDefinitions.GroupGroup, sourceLineNumber, id)
+        {
+        }
+
+        public IntermediateField this[GroupGroupSymbol.SymbolFields index] => this.Fields[(int)index];
+
+        public string ParentGroupRef
+        {
+            get => this.Fields[(int)GroupGroupSymbol.SymbolFields.ParentGroupRef].AsString();
+            set => this.Set((int)GroupGroupSymbol.SymbolFields.ParentGroupRef, value);
+        }
+
+        public string ChildGroupRef
+        {
+            get => this.Fields[(int)GroupGroupSymbol.SymbolFields.ChildGroupRef].AsString();
+            set => this.Set((int)GroupGroupSymbol.SymbolFields.ChildGroupRef, value);
+        }
+
+    }
+}
diff --git a/src/ext/Util/wixext/Symbols/GroupSymbol.cs b/src/ext/Util/wixext/Symbols/GroupSymbol.cs
index b378db44..ef1dc33f 100644
--- a/src/ext/Util/wixext/Symbols/GroupSymbol.cs
+++ b/src/ext/Util/wixext/Symbols/GroupSymbol.cs
@@ -11,27 +11,38 @@ namespace WixToolset.Util
             UtilSymbolDefinitionType.Group.ToString(),
             new[]
             {
-                new IntermediateFieldDefinition(nameof(GroupSymbolFields.ComponentRef), IntermediateFieldType.String),
-                new IntermediateFieldDefinition(nameof(GroupSymbolFields.Name), IntermediateFieldType.String),
-                new IntermediateFieldDefinition(nameof(GroupSymbolFields.Domain), IntermediateFieldType.String),
+                new IntermediateFieldDefinition(nameof(GroupSymbol.SymbolFields.ComponentRef), IntermediateFieldType.String),
+                new IntermediateFieldDefinition(nameof(GroupSymbol.SymbolFields.Name), IntermediateFieldType.String),
+                new IntermediateFieldDefinition(nameof(GroupSymbol.SymbolFields.Domain), IntermediateFieldType.String),
             },
             typeof(GroupSymbol));
+
+        public static readonly IntermediateSymbolDefinition Group6 = new IntermediateSymbolDefinition(
+            UtilSymbolDefinitionType.Group6.ToString(),
+            new[]
+            {
+                new IntermediateFieldDefinition(nameof(Group6Symbol.SymbolFields.GroupRef), IntermediateFieldType.String),
+                new IntermediateFieldDefinition(nameof(Group6Symbol.SymbolFields.Comment), IntermediateFieldType.String),
+                new IntermediateFieldDefinition(nameof(Group6Symbol.SymbolFields.Attributes), IntermediateFieldType.Number),
+            },
+            typeof(Group6Symbol));
     }
 }
 
 namespace WixToolset.Util.Symbols
 {
+    using System;
     using WixToolset.Data;
 
-    public enum GroupSymbolFields
-    {
-        ComponentRef,
-        Name,
-        Domain,
-    }
-
     public class GroupSymbol : IntermediateSymbol
     {
+        public enum SymbolFields
+        {
+            ComponentRef,
+            Name,
+            Domain,
+        }
+
         public GroupSymbol() : base(UtilSymbolDefinitions.Group, null, null)
         {
         }
@@ -40,24 +51,74 @@ namespace WixToolset.Util.Symbols
         {
         }
 
-        public IntermediateField this[GroupSymbolFields index] => this.Fields[(int)index];
+        public IntermediateField this[GroupSymbol.SymbolFields index] => this.Fields[(int)index];
 
         public string ComponentRef
         {
-            get => this.Fields[(int)GroupSymbolFields.ComponentRef].AsString();
-            set => this.Set((int)GroupSymbolFields.ComponentRef, value);
+            get => this.Fields[(int)GroupSymbol.SymbolFields.ComponentRef].AsString();
+            set => this.Set((int)GroupSymbol.SymbolFields.ComponentRef, value);
         }
 
         public string Name
         {
-            get => this.Fields[(int)GroupSymbolFields.Name].AsString();
-            set => this.Set((int)GroupSymbolFields.Name, value);
+            get => this.Fields[(int)GroupSymbol.SymbolFields.Name].AsString();
+            set => this.Set((int)GroupSymbol.SymbolFields.Name, value);
         }
 
         public string Domain
         {
-            get => this.Fields[(int)GroupSymbolFields.Domain].AsString();
-            set => this.Set((int)GroupSymbolFields.Domain, value);
+            get => this.Fields[(int)GroupSymbol.SymbolFields.Domain].AsString();
+            set => this.Set((int)GroupSymbol.SymbolFields.Domain, value);
         }
     }
-}
\ No newline at end of file
+
+    public class Group6Symbol : IntermediateSymbol
+    {
+        [Flags]
+        public enum SymbolAttributes
+        {
+            None = 0x00000000,
+            FailIfExists = 0x00000001,
+            UpdateIfExists = 0x00000002,
+            DontRemoveOnUninstall = 0x00000004,
+            DontCreateGroup = 0x00000008,
+            NonVital = 0x00000010,
+            RemoveComment = 0x00000020,
+        }
+
+        public enum SymbolFields
+        {
+            GroupRef,
+            Comment,
+            Attributes,
+        }
+
+        public Group6Symbol() : base(UtilSymbolDefinitions.Group6, null, null)
+        {
+        }
+
+        public Group6Symbol(SourceLineNumber sourceLineNumber, Identifier id = null) : base(UtilSymbolDefinitions.Group6, sourceLineNumber, id)
+        {
+        }
+
+        public IntermediateField this[Group6Symbol.SymbolFields index] => this.Fields[(int)index];
+
+        public string GroupRef
+        {
+            get => this.Fields[(int)Group6Symbol.SymbolFields.GroupRef].AsString();
+            set => this.Set((int)Group6Symbol.SymbolFields.GroupRef, value);
+        }
+
+        public string Comment
+        {
+            get => this.Fields[(int)Group6Symbol.SymbolFields.Comment].AsString();
+            set => this.Set((int)Group6Symbol.SymbolFields.Comment, value);
+        }
+
+        public SymbolAttributes Attributes
+        {
+            get => (SymbolAttributes)this.Fields[(int)Group6Symbol.SymbolFields.Attributes].AsNumber();
+            set => this.Set((int)Group6Symbol.SymbolFields.Attributes, (int)value);
+        }
+    }
+}
diff --git a/src/ext/Util/wixext/Symbols/UtilSymbolDefinitions.cs b/src/ext/Util/wixext/Symbols/UtilSymbolDefinitions.cs
index 8152868f..43d0fca0 100644
--- a/src/ext/Util/wixext/Symbols/UtilSymbolDefinitions.cs
+++ b/src/ext/Util/wixext/Symbols/UtilSymbolDefinitions.cs
@@ -12,6 +12,8 @@ namespace WixToolset.Util
         FileShare,
         FileSharePermissions,
         Group,
+        Group6,
+        GroupGroup,
         Perfmon,
         PerfmonManifest,
         PerformanceCategory,
@@ -59,6 +61,12 @@ namespace WixToolset.Util
                 case UtilSymbolDefinitionType.Group:
                     return UtilSymbolDefinitions.Group;
 
+                case UtilSymbolDefinitionType.Group6:
+                    return UtilSymbolDefinitions.Group6;
+
+                case UtilSymbolDefinitionType.GroupGroup:
+                    return UtilSymbolDefinitions.GroupGroup;
+
                 case UtilSymbolDefinitionType.Perfmon:
                     return UtilSymbolDefinitions.Perfmon;
 
diff --git a/src/ext/Util/wixext/UtilCompiler.cs b/src/ext/Util/wixext/UtilCompiler.cs
index 3bcd2c0b..aff7dd0d 100644
--- a/src/ext/Util/wixext/UtilCompiler.cs
+++ b/src/ext/Util/wixext/UtilCompiler.cs
@@ -139,6 +139,9 @@ namespace WixToolset.Util
                         case "TouchFile":
                             this.ParseTouchFileElement(intermediate, section, element, componentId, componentWin64);
                             break;
+                        case "Group":
+                            this.ParseGroupElement(intermediate, section, element, componentId);
+                            break;
                         case "User":
                             this.ParseUserElement(intermediate, section, element, componentId);
                             break;
@@ -1357,6 +1360,8 @@ namespace WixToolset.Util
             Identifier id = null;
             string domain = null;
             string name = null;
+            string comment = null;
+            Group6Symbol.SymbolAttributes attributes = Group6Symbol.SymbolAttributes.None;
 
             foreach (var attrib in element.Attributes())
             {
@@ -1373,6 +1378,75 @@ namespace WixToolset.Util
                         case "Domain":
                             domain = this.ParseHelper.GetAttributeValue(sourceLineNumbers, attrib);
                             break;
+                        case "Comment":
+                            if (null == componentId)
+                            {
+                                this.Messaging.Write(UtilErrors.IllegalAttributeWithoutComponent(sourceLineNumbers, element.Name.LocalName, attrib.Name.LocalName));
+                            }
+
+                            comment = this.ParseHelper.GetAttributeValue(sourceLineNumbers, attrib);
+                            break;
+                        case "CreateGroup":
+                            if (null == componentId)
+                            {
+                                this.Messaging.Write(UtilErrors.IllegalAttributeWithoutComponent(sourceLineNumbers, element.Name.LocalName, attrib.Name.LocalName));
+                            }
+
+                            if (YesNoType.No == this.ParseHelper.GetAttributeYesNoValue(sourceLineNumbers, attrib))
+                            {
+                                attributes |= Group6Symbol.SymbolAttributes.DontCreateGroup;
+                            }
+                            break;
+                        case "FailIfExists":
+                            if (null == componentId)
+                            {
+                                this.Messaging.Write(UtilErrors.IllegalAttributeWithoutComponent(sourceLineNumbers, element.Name.LocalName, attrib.Name.LocalName));
+                            }
+
+                            if (YesNoType.Yes == this.ParseHelper.GetAttributeYesNoValue(sourceLineNumbers, attrib))
+                            {
+                                attributes |= Group6Symbol.SymbolAttributes.FailIfExists;
+                            }
+                            break;
+                        case "UpdateIfExists":
+                            if (null == componentId)
+                            {
+                                this.Messaging.Write(UtilErrors.IllegalAttributeWithoutComponent(sourceLineNumbers, element.Name.LocalName, attrib.Name.LocalName));
+                            }
+
+                            if (YesNoType.Yes == this.ParseHelper.GetAttributeYesNoValue(sourceLineNumbers, attrib))
+                            {
+                                attributes |= Group6Symbol.SymbolAttributes.UpdateIfExists;
+                            }
+                            break;
+                        case "RemoveComment":
+                            if (YesNoType.Yes == this.ParseHelper.GetAttributeYesNoValue(sourceLineNumbers, attrib))
+                            {
+                                attributes |= Group6Symbol.SymbolAttributes.RemoveComment;
+                            }
+                            break;
+                        case "RemoveOnUninstall":
+                            if (null == componentId)
+                            {
+                                this.Messaging.Write(UtilErrors.IllegalAttributeWithoutComponent(sourceLineNumbers, element.Name.LocalName, attrib.Name.LocalName));
+                            }
+
+                            if (YesNoType.No == this.ParseHelper.GetAttributeYesNoValue(sourceLineNumbers, attrib))
+                            {
+                                attributes |= Group6Symbol.SymbolAttributes.DontRemoveOnUninstall;
+                            }
+                            break;
+                        case "Vital":
+                            if (null == componentId)
+                            {
+                                this.Messaging.Write(UtilErrors.IllegalAttributeWithoutComponent(sourceLineNumbers, element.Name.LocalName, attrib.Name.LocalName));
+                            }
+
+                            if (YesNoType.No == this.ParseHelper.GetAttributeYesNoValue(sourceLineNumbers, attrib))
+                            {
+                                attributes |= Group6Symbol.SymbolAttributes.NonVital;
+                            }
+                            break;
                         default:
                             this.ParseHelper.UnexpectedAttribute(element, attrib);
                             break;
@@ -1389,7 +1463,40 @@ namespace WixToolset.Util
                 id = this.ParseHelper.CreateIdentifier("ugr", componentId, domain, name);
             }
 
-            this.ParseHelper.ParseForExtensionElements(this.Context.Extensions, intermediate, section, element);
+            if (null == name)
+            {
+                this.Messaging.Write(ErrorMessages.ExpectedAttribute(sourceLineNumbers, element.Name.LocalName, "Name"));
+            }
+
+            if (null != comment && (Group6Symbol.SymbolAttributes.RemoveComment & attributes) != 0)
+            {
+                this.Messaging.Write(ErrorMessages.IllegalAttributeWithOtherAttribute(sourceLineNumbers, element.Name.LocalName, "Comment", "RemoveComment"));
+            }
+
+            if (null != componentId)
+            {
+                this.ParseHelper.CreateCustomActionReference(sourceLineNumbers, section, "Wix4ConfigureGroups", this.Context.Platform, CustomActionPlatforms.X86 | CustomActionPlatforms.X64 | CustomActionPlatforms.ARM64);
+            }
+
+            foreach (var child in element.Elements())
+            {
+                if (this.Namespace == child.Name.Namespace)
+                {
+                    switch (child.Name.LocalName)
+                    {
+                        case "GroupRef":
+                            this.ParseGroupRefElement(intermediate, section, child,  id.Id, groupType:true);
+                            break;
+                        default:
+                            //this.ParseHelper.UnexpectedElement(element, child);
+                            break;
+                    }
+                }
+                else
+                {
+                    this.ParseHelper.ParseExtensionElement(this.Context.Extensions, intermediate, section, element, child);
+                }
+            }
 
             if (!this.Messaging.EncounteredError)
             {
@@ -1399,6 +1506,12 @@ namespace WixToolset.Util
                     Name = name,
                     Domain = domain,
                 });
+                section.AddSymbol(new Group6Symbol(sourceLineNumbers, id)
+                {
+                    GroupRef = id.Id,
+                    Comment = comment,
+                    Attributes = attributes,
+                });
             }
         }
 
@@ -1406,8 +1519,9 @@ namespace WixToolset.Util
         /// Parses a GroupRef element
         /// </summary>
         /// <param name="element">Element to parse.</param>
-        /// <param name="userId">Required user id to be joined to the group.</param>
-        private void ParseGroupRefElement(Intermediate intermediate, IntermediateSection section, XElement element, string userId)
+        /// <param name="childId">Required child id to be joined to the group.</param>
+        /// <param name="groupType">whether the child is a group (true) or a user (false)</param>
+        private void ParseGroupRefElement(Intermediate intermediate, IntermediateSection section, XElement element, string childId, bool groupType=false)
         {
             var sourceLineNumbers = this.ParseHelper.GetSourceLineNumbers(element);
             string groupId = null;
@@ -1437,11 +1551,22 @@ namespace WixToolset.Util
 
             if (!this.Messaging.EncounteredError)
             {
-                section.AddSymbol(new UserGroupSymbol(sourceLineNumbers)
+                if (!groupType)
                 {
-                    UserRef = userId,
-                    GroupRef = groupId,
-                });
+                    section.AddSymbol(new UserGroupSymbol(sourceLineNumbers)
+                    {
+                        UserRef = childId,
+                        GroupRef = groupId,
+                    });
+                }
+                else
+                {
+                    section.AddSymbol(new GroupGroupSymbol(sourceLineNumbers)
+                    {
+                        ChildGroupRef = childId,
+                        ParentGroupRef = groupId,
+                    });
+                }
             }
         }
 
@@ -3460,7 +3585,7 @@ namespace WixToolset.Util
                                 this.Messaging.Write(UtilErrors.IllegalElementWithoutComponent(childSourceLineNumbers, child.Name.LocalName));
                             }
 
-                            this.ParseGroupRefElement(intermediate, section, child, id.Id);
+                            this.ParseGroupRefElement(intermediate, section, child, id.Id, groupType:false);
                             break;
                         default:
                             this.ParseHelper.UnexpectedElement(element, child);
diff --git a/src/ext/Util/wixext/UtilDecompiler.cs b/src/ext/Util/wixext/UtilDecompiler.cs
index 52b64889..53b75b8d 100644
--- a/src/ext/Util/wixext/UtilDecompiler.cs
+++ b/src/ext/Util/wixext/UtilDecompiler.cs
@@ -176,6 +176,14 @@ namespace WixToolset.Util
                 case "Wix4Group":
                     this.DecompileGroupTable(table);
                     break;
+                case "Group6":
+                case "Wix6Group":
+                    this.DecompileGroup6Table(table);
+                    break;
+                case "GroupGroup":
+                case "Wix6GroupGroup":
+                    this.DecompileGroupGroup6Table(table);
+                    break;
                 case "Perfmon":
                 case "Wix4Perfmon":
                     this.DecompilePerfmonTable(table);
@@ -427,18 +435,60 @@ namespace WixToolset.Util
         {
             foreach (var row in table.Rows)
             {
-                if (null != row[1])
-                {
-                    this.Messaging.Write(WarningMessages.UnrepresentableColumnValue(row.SourceLineNumbers, table.Name, "Component_", (string)row[1]));
-                }
-
                 this.DecompilerHelper.AddElementToRoot(UtilConstants.GroupName,
                     new XAttribute("Id", row.FieldAsString(0)),
-                    new XAttribute("Name", row.FieldAsString(1)),
+                    new XAttribute("Name", row.FieldAsString(2)),
                     AttributeIfNotNull("Domain", row, 3)
                     );
             }
         }
+        /// <summary>
+        /// Decompile the Group6 table.
+        /// </summary>
+        /// <param name="table">The table to decompile.</param>
+        private void DecompileGroup6Table(Table table)
+        {
+            foreach (var row in table.Rows)
+            {
+                var groupId = row.FieldAsString(0);
+                if (this.DecompilerHelper.TryGetIndexedElement("Group", groupId, out var group))
+                {
+                    var attributes = (Group6Symbol.SymbolAttributes)(row.FieldAsNullableInteger(2) ?? 0);
+                    group.Add(AttributeIfNotNull("Comment", row, 1));
+                    group.Add(AttributeIfTrue("FailIfExists", ((attributes & Group6Symbol.SymbolAttributes.FailIfExists) != 0)));
+                    group.Add(AttributeIfTrue("UpdateIfExists", ((attributes & Group6Symbol.SymbolAttributes.UpdateIfExists) != 0)));
+                    group.Add(AttributeIfTrue("DontRemoveOnUninstall", ((attributes & Group6Symbol.SymbolAttributes.DontRemoveOnUninstall) != 0)));
+                    group.Add(AttributeIfTrue("DontCreateGroup", ((attributes & Group6Symbol.SymbolAttributes.DontCreateGroup) != 0)));
+                    group.Add(AttributeIfTrue("NonVital", ((attributes & Group6Symbol.SymbolAttributes.NonVital) != 0)));
+                    group.Add(AttributeIfTrue("RemoveComment", ((attributes & Group6Symbol.SymbolAttributes.RemoveComment) != 0)));
+                }
+                else
+                {
+                    this.Messaging.Write(WarningMessages.ExpectedForeignRow(row.SourceLineNumbers, table.Name, row.GetPrimaryKey(), "Group_", groupId, "Group"));
+                }
+            }
+        }
+
+
+        /// <summary>
+        /// Decompile the GroupGroup6 table.
+        /// </summary>
+        /// <param name="table">The table to decompile.</param>
+        private void DecompileGroupGroup6Table(Table table)
+        {
+            foreach (var row in table.Rows)
+            {
+                var childId = row.FieldAsString(1);
+                if (this.DecompilerHelper.TryGetIndexedElement("Group", childId, out var group))
+                {
+                    group.Add(new XElement(UtilConstants.GroupRefName, new XAttribute("Id", row.FieldAsString(0))));
+                }
+                else
+                {
+                    this.Messaging.Write(WarningMessages.ExpectedForeignRow(row.SourceLineNumbers, table.Name, row.GetPrimaryKey(), "Parent_", childId, "Group"));
+                }
+            }
+        }
 
         /// <summary>
         /// Decompile the WixInternetShortcut table.
diff --git a/src/ext/Util/wixext/UtilTableDefinitions.cs b/src/ext/Util/wixext/UtilTableDefinitions.cs
index baa1d25b..908b7eea 100644
--- a/src/ext/Util/wixext/UtilTableDefinitions.cs
+++ b/src/ext/Util/wixext/UtilTableDefinitions.cs
@@ -105,6 +105,29 @@ namespace WixToolset.Util
             symbolIdIsPrimaryKey: true
         );
 
+        public static readonly TableDefinition Wix6Group = new TableDefinition(
+            "Wix6Group",
+            UtilSymbolDefinitions.Group6,
+            new[]
+            {
+                        new ColumnDefinition("Group_", ColumnType.String, 72, primaryKey: true, nullable: false, ColumnCategory.Identifier, keyTable: "Wix4Group", keyColumn: 1, description: "Primary key, non-localized token", modularizeType: ColumnModularizeType.Column),
+                        new ColumnDefinition("Comment", ColumnType.String, 255, primaryKey: false, nullable: true, ColumnCategory.Formatted, description: "Group comment", modularizeType: ColumnModularizeType.Property),
+                        new ColumnDefinition("Attributes", ColumnType.Number, 4, primaryKey: false, nullable: true, ColumnCategory.Unknown, minValue: 0, maxValue: 65535, description: "Attributes describing how to create the group"),
+            },
+            symbolIdIsPrimaryKey: false
+        );
+
+        public static readonly TableDefinition Wix6GroupGroup = new TableDefinition(
+            "Wix6GroupGroup",
+            UtilSymbolDefinitions.GroupGroup,
+            new[]
+            {
+                        new ColumnDefinition("Parent_", ColumnType.String, 72, primaryKey: true, nullable: false, ColumnCategory.Identifier, keyTable: "Wix4Group", keyColumn: 1, description: "Parent Group", modularizeType: ColumnModularizeType.Column),
+                        new ColumnDefinition("Child_", ColumnType.String, 72, primaryKey: true, nullable: false, ColumnCategory.Identifier, keyTable: "Wix4Group", keyColumn: 1, description: "Child Group, a member of the Parent Group", modularizeType: ColumnModularizeType.Column),
+            },
+            symbolIdIsPrimaryKey: false
+        );
+
         public static readonly TableDefinition Wix4InternetShortcut = new TableDefinition(
             "Wix4InternetShortcut",
             UtilSymbolDefinitions.WixInternetShortcut,
@@ -302,6 +325,8 @@ namespace WixToolset.Util
             Wix4FileShare,
             Wix4FileSharePermissions,
             Wix4Group,
+            Wix6Group,
+            Wix6GroupGroup,
             Wix4InternetShortcut,
             Wix4PerformanceCategory,
             Wix4Perfmon,