Move Dependency.wixext into ext

7 files changed, 522 insertions, 0 deletions

diff --git a/src/ext/Dependency/wixext/DependencyCompiler.cs b/src/ext/Dependency/wixext/DependencyCompiler.cs
new file mode 100644
index 00000000..3d6c84a7
--- /dev/null
+++ b/src/ext/Dependency/wixext/DependencyCompiler.cs
@@ -0,0 +1,61 @@
+// 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.Dependency
+{
+    using System.Collections.Generic;
+    using System.Xml.Linq;
+    using WixToolset.Data;
+    using WixToolset.Extensibility;
+    using WixToolset.Extensibility.Data;
+
+    /// <summary>
+    /// The compiler for the WiX Toolset Dependency Extension.
+    /// </summary>
+    public sealed class DependencyCompiler : BaseCompilerExtension
+    {
+        public override XNamespace Namespace => "http://wixtoolset.org/schemas/v4/wxs/dependency";
+
+        /// <summary>
+        /// Processes an attribute for the Compiler.
+        /// </summary>
+        /// <param name="sourceLineNumbers">Source line number for the parent element.</param>
+        /// <param name="parentElement">Parent element of attribute.</param>
+        /// <param name="attribute">Attribute to process.</param>
+        public override void ParseAttribute(Intermediate intermediate, IntermediateSection section, XElement parentElement, XAttribute attribute, IDictionary<string, string> context)
+        {
+            var sourceLineNumbers = this.ParseHelper.GetSourceLineNumbers(parentElement);
+            var addCheck = YesNoType.NotSet;
+            var addRequire = YesNoType.NotSet;
+
+            switch (parentElement.Name.LocalName)
+            {
+                case "Provides":
+                    if (attribute.Name.LocalName == "Check" && parentElement.Parent?.Name.LocalName == "Component")
+                    {
+                        addCheck = this.ParseHelper.GetAttributeYesNoValue(sourceLineNumbers, attribute);
+                    }
+                    break;
+                case "Requires":
+                case "RequiresRef":
+                    if (attribute.Name.LocalName == "Enforce" && parentElement.Parent?.Parent?.Name.LocalName == "Component")
+                    {
+                        addRequire = this.ParseHelper.GetAttributeYesNoValue(sourceLineNumbers, attribute);
+                    }
+                    break;
+            }
+
+            if (addCheck == YesNoType.NotSet && addRequire == YesNoType.NotSet)
+            {
+                this.ParseHelper.UnexpectedAttribute(parentElement, attribute);
+            }
+            else if (addCheck == YesNoType.Yes)
+            {
+                this.ParseHelper.CreateCustomActionReference(sourceLineNumbers, section, "Wix4DependencyCheck", this.Context.Platform, CustomActionPlatforms.X86 | CustomActionPlatforms.X64 | CustomActionPlatforms.ARM64);
+            }
+            else if (addRequire == YesNoType.Yes)
+            {
+                this.ParseHelper.CreateCustomActionReference(sourceLineNumbers, section, "Wix4DependencyRequire", this.Context.Platform, CustomActionPlatforms.X86 | CustomActionPlatforms.X64 | CustomActionPlatforms.ARM64);
+            }
+        }
+    }
+}
diff --git a/src/ext/Dependency/wixext/DependencyDecompiler.cs b/src/ext/Dependency/wixext/DependencyDecompiler.cs
new file mode 100644
index 00000000..31de3097
--- /dev/null
+++ b/src/ext/Dependency/wixext/DependencyDecompiler.cs
@@ -0,0 +1,347 @@
+// 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.Dependency
+{
+#if TODO_CONSIDER_DECOMPILER
+    using System;
+    using System.Collections.Generic;
+    using System.Collections.ObjectModel;
+    using WixToolset;
+    using WixToolset.Data;
+    using WixToolset.Extensibility;
+    using WixToolset.Extensions.Serialize.Dependency;
+    using Dependency = WixToolset.Extensions.Serialize.Dependency;
+    using Wix = WixToolset.Data.Serialize;
+
+    /// <summary>
+    /// The decompiler for the WiX toolset dependency extension.
+    /// </summary>
+    public sealed class DependencyDecompiler : DecompilerExtension
+    {
+        private RegistryKeyValueCollection registryValues;
+        private Dictionary<string, string> keyCache;
+
+        /// <summary>
+        /// Creates a new instance of the <see cref="DependencyDecompiler"/> class.
+        /// </summary>
+        public DependencyDecompiler()
+        {
+            this.registryValues = new RegistryKeyValueCollection();
+            this.keyCache = new Dictionary<string, string>();
+
+            this.TableDefinitions = DependencyExtensionData.GetExtensionTableDefinitions();
+        }
+
+        /// <summary>
+        /// Get the extensions library to be removed.
+        /// </summary>
+        /// <param name="tableDefinitions">Table definitions for library.</param>
+        /// <returns>Library to remove from decompiled output.</returns>
+        public override Library GetLibraryToRemove(TableDefinitionCollection tableDefinitions)
+        {
+            return DependencyExtensionData.GetExtensionLibrary(tableDefinitions);
+        }
+
+        /// <summary>
+        /// Decompiles an extension table.
+        /// </summary>
+        /// <param name="table">The table to decompile.</param>
+        public override void DecompileTable(Table table)
+        {
+            switch (table.Name)
+            {
+                case "WixDependencyProvider":
+                    this.DecompileWixDependencyProviderTable(table);
+                    break;
+
+                case "WixDependency":
+                    this.DecompileWixDependencyTable(table);
+                    break;
+
+                case "WixDependencyRef":
+                    this.DecompileWixDependencyRefTable(table);
+                    break;
+
+                default:
+                    base.DecompileTable(table);
+                    break;
+            }
+        }
+
+        /// <summary>
+        /// Finalize decompilation by removing registry values that the compiler writes.
+        /// </summary>
+        /// <param name="tables">The collection of all tables.</param>
+        public override void Finish(TableIndexedCollection tables)
+        {
+            // Remove generated registry rows.
+            this.FinalizeRegistryTable(tables);
+
+            // Remove extension properties.
+            this.FinalizeProperties();
+        }
+
+        /// <summary>
+        /// Decompiles the WixDependencyProvider table.
+        /// </summary>
+        /// <param name="table">The table to decompile.</param>
+        private void DecompileWixDependencyProviderTable(Table table)
+        {
+            foreach (Row row in table.Rows)
+            {
+                Provides provides = new Provides();
+
+                provides.Id = (string)row[0];
+                provides.Key = (string)row[2];
+
+                if (null != row[3])
+                {
+                    provides.Version = (string)row[3];
+                }
+
+                if (null != row[4])
+                {
+                    provides.DisplayName = (string)row[4];
+                }
+
+                // Nothing to parse for attributes currently.
+
+                Wix.Component component = (Wix.Component)this.Core.GetIndexedElement("Component", (string)row[1]);
+                if (null != component)
+                {
+                    component.AddChild(provides);
+                }
+                else
+                {
+                    this.Core.OnMessage(WixWarnings.ExpectedForeignRow(row.SourceLineNumbers, table.Name, row.GetPrimaryKey(DecompilerConstants.PrimaryKeyDelimiter), "Component_", (string)row[1], "Component"));
+                }
+
+                // Index the provider to parent the RequiresRef elements.
+                this.Core.IndexElement(row, provides);
+
+                // Add the provider-specific registry keys to be removed during finalization.
+                // Only remove specific keys that the compiler writes.
+                string keyProvides = String.Concat(DependencyCommon.RegistryRoot, provides.Key);
+
+                this.registryValues.Add(keyProvides, null);
+                this.registryValues.Add(keyProvides, "Version");
+                this.registryValues.Add(keyProvides, "DisplayName");
+                this.registryValues.Add(keyProvides, "Attributes");
+
+                // Cache the provider key.
+                this.keyCache[provides.Id] = provides.Key;
+            }
+        }
+
+        /// <summary>
+        /// Decompiles the WixDependency table.
+        /// </summary>
+        /// <param name="table">The table to decompile.</param>
+        private void DecompileWixDependencyTable(Table table)
+        {
+            foreach (Row row in table.Rows)
+            {
+                Requires requires = new Requires();
+
+                requires.Id = (string)row[0];
+                requires.ProviderKey = (string)row[1];
+
+                if (null != row[2])
+                {
+                    requires.Minimum = (string)row[2];
+                }
+
+                if (null != row[3])
+                {
+                    requires.Maximum = (string)row[3];
+                }
+
+                if (null != row[4])
+                {
+                    int attributes = (int)row[4];
+
+                    if (0 != (attributes & DependencyCommon.RequiresAttributesMinVersionInclusive))
+                    {
+                        requires.IncludeMinimum = Dependency.YesNoType.yes;
+                    }
+
+                    if (0 != (attributes & DependencyCommon.RequiresAttributesMaxVersionInclusive))
+                    {
+                        requires.IncludeMaximum = Dependency.YesNoType.yes;
+                    }
+                }
+
+                this.Core.RootElement.AddChild(requires);
+
+                // Cache the requires key.
+                this.keyCache[requires.Id] = requires.ProviderKey;
+            }
+        }
+
+        /// <summary>
+        /// Decompiles the WixDependencyRef table.
+        /// </summary>
+        /// <param name="table">The table to decompile.</param>
+        private void DecompileWixDependencyRefTable(Table table)
+        {
+            foreach (Row row in table.Rows)
+            {
+                RequiresRef requiresRef = new RequiresRef();
+
+                requiresRef.Id = (string)row[1];
+
+                Provides provides = (Provides)this.Core.GetIndexedElement("WixDependencyProvider", (string)row[0]);
+                if (null != provides)
+                {
+                    provides.AddChild(requiresRef);
+                }
+                else
+                {
+                    this.Core.OnMessage(WixWarnings.ExpectedForeignRow(row.SourceLineNumbers, table.Name, row.GetPrimaryKey(DecompilerConstants.PrimaryKeyDelimiter), "WixDependencyProvider_", (string)row[0], "WixDependencyProvider"));
+                }
+
+                // Get the cached keys for the provider and dependency IDs and generate registry rows.
+                string providesKey = null;
+                string requiresKey = null;
+
+                if (null != provides && this.keyCache.ContainsKey(provides.Id))
+                {
+                    providesKey = this.keyCache[provides.Id];
+                }
+                else
+                {
+                    this.Core.OnMessage(DependencyWarnings.ProvidesKeyNotFound(row.SourceLineNumbers, provides.Id));
+                }
+
+                if (this.keyCache.ContainsKey(requiresRef.Id))
+                {
+                    requiresKey = this.keyCache[requiresRef.Id];
+                }
+                else
+                {
+                    this.Core.OnMessage(DependencyWarnings.RequiresKeyNotFound(row.SourceLineNumbers, requiresRef.Id));
+                }
+
+                if (!this.Core.EncounteredError)
+                {
+                    // Add the dependency-specific registry keys to be removed during finalization.
+                    // Only remove specific keys that the compiler writes.
+                    string keyRequires = String.Format(@"{0}{1}\{2}\{3}", DependencyCommon.RegistryRoot, requiresKey, DependencyCommon.RegistryDependents, providesKey);
+
+                    this.registryValues.Add(keyRequires, "*");
+                    this.registryValues.Add(keyRequires, "MinVersion");
+                    this.registryValues.Add(keyRequires, "MaxVersion");
+                    this.registryValues.Add(keyRequires, "Attributes");
+                }
+            }
+        }
+
+        /// <summary>
+        /// Removes rows from the Registry table that are generated by this extension.
+        /// </summary>
+        /// <param name="tables">The collection of tables.</param>
+        private void FinalizeRegistryTable(TableIndexedCollection tables)
+        {
+            Table registryTable = tables["Registry"];
+            if (null != registryTable)
+            {
+                foreach (Row registryRow in registryTable.Rows)
+                {
+                    // Check if the compiler writes this registry value; if so, it should be removed.
+                    if (this.registryValues.Contains(registryRow))
+                    {
+                        Wix.ISchemaElement elem = this.Core.GetIndexedElement(registryRow);
+
+                        // If the registry row was found, remove it from its parent.
+                        if (null != elem && null != elem.ParentElement)
+                        {
+                            Wix.IParentElement elemParent = elem.ParentElement as Wix.IParentElement;
+                            if (null != elemParent)
+                            {
+                                elemParent.RemoveChild(elem);
+                            }
+                        }
+                    }
+                }
+            }
+        }
+
+        /// <summary>
+        /// Removes properties defined by this extension.
+        /// </summary>
+        /// <param name="tables">The collection of tables.</param>
+        private void FinalizeProperties()
+        {
+            string[] properties = new string[] { "DISABLEDEPENDENCYCHECK", "IGNOREDEPENDENCIES" };
+            foreach (string property in properties)
+            {
+                Wix.Property elem = this.Core.GetIndexedElement("Property", property) as Wix.Property;
+                if (null != elem)
+                {
+                    // If a value is defined, log a warning we're removing it.
+                    if (!String.IsNullOrEmpty(elem.Value))
+                    {
+                        this.Core.OnMessage(DependencyWarnings.PropertyRemoved(elem.Id));
+                    }
+
+                    // If the property row was found, remove it from its parent.
+                    if (null != elem.ParentElement)
+                    {
+                        Wix.IParentElement elemParent = elem.ParentElement as Wix.IParentElement;
+                        if (null != elemParent)
+                        {
+                            elemParent.RemoveChild(elem);
+                        }
+                    }
+                }
+            }
+        }
+
+        /// <summary>
+        /// Provides an O(1) lookup for registry key and value name pairs for use in the decompiler.
+        /// </summary>
+        private sealed class RegistryKeyValueCollection : KeyedCollection<int, KeyValuePair<string, string>>
+        {
+            /// <summary>
+            /// Adds the registry key and value name pair to the collection if it doesn't already exist.
+            /// </summary>
+            /// <param name="key">The registry key to add.</param>
+            /// <param name="name">The registry value name to add.</param>
+            internal void Add(string key, string name)
+            {
+                KeyValuePair<string, string> pair = new KeyValuePair<string, string>(key, name);
+                if (!this.Contains(pair))
+                {
+                    this.Add(pair);
+                }
+            }
+
+            /// <summary>
+            /// Returns whether the collection contains the registry key and value name pair from the <see cref="Row"/>.
+            /// </summary>
+            /// <param name="row">The registry <see cref="Row"/> to search for.</param>
+            /// <returns>True if the collection contains the registry key and value name pair from the <see cref="Row"/>; otherwise, false.</returns>
+            internal bool Contains(Row row)
+            {
+                if (null == row)
+                {
+                    return false;
+                }
+
+                KeyValuePair<string, string> pair = new KeyValuePair<string, string>((string)row[2], (string)row[3]);
+                return this.Contains(pair);
+            }
+
+            /// <summary>
+            /// Return the hash code of the key and value pair concatenated with a colon as a delimiter.
+            /// </summary>
+            /// <param name="pair">The registry key and value name pair.</param>
+            /// <returns></returns>
+            protected override int GetKeyForItem(KeyValuePair<string, string> pair)
+            {
+                return String.Concat(pair.Key, ":", pair.Value).GetHashCode();
+            }
+        }
+    }
+#endif
+}
diff --git a/src/ext/Dependency/wixext/DependencyExtensionData.cs b/src/ext/Dependency/wixext/DependencyExtensionData.cs
new file mode 100644
index 00000000..2f30c2bf
--- /dev/null
+++ b/src/ext/Dependency/wixext/DependencyExtensionData.cs
@@ -0,0 +1,29 @@
+// 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.Dependency
+{
+    using WixToolset.Data;
+    using WixToolset.Extensibility;
+
+    /// <summary>
+    /// The WiX Toolset Dependency Extension.
+    /// </summary>
+    public sealed class DependencyExtensionData : BaseExtensionData
+    {
+        /// <summary>
+        /// Gets the default culture.
+        /// </summary>
+        /// <value>The default culture.</value>
+        public override string DefaultCulture => "en-US";
+
+        /// <summary>
+        /// Gets the contained .wixlib content.
+        /// </summary>
+        /// <param name="symbolDefinitions">Strong typed symbold definitions.</param>
+        /// <returns>The .wixlib.</returns>
+        public override Intermediate GetLibrary(ISymbolDefinitionCreator symbolDefinitions)
+        {
+            return Intermediate.Load(typeof(DependencyExtensionData).Assembly, "WixToolset.Dependency.dependency.wixlib", symbolDefinitions);
+        }
+    }
+}
diff --git a/src/ext/Dependency/wixext/DependencyExtensionFactory.cs b/src/ext/Dependency/wixext/DependencyExtensionFactory.cs
new file mode 100644
index 00000000..413f99ae
--- /dev/null
+++ b/src/ext/Dependency/wixext/DependencyExtensionFactory.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.Dependency
+{
+    using System;
+    using System.Collections.Generic;
+    using WixToolset.Extensibility;
+
+    public class DependencyExtensionFactory : BaseExtensionFactory
+    {
+        protected override IReadOnlyCollection<Type> ExtensionTypes => new[]
+        {
+            typeof(DependencyCompiler),
+            typeof(DependencyExtensionData),
+        };
+    }
+}
diff --git a/src/ext/Dependency/wixext/WixToolset.Dependency.wixext.csproj b/src/ext/Dependency/wixext/WixToolset.Dependency.wixext.csproj
new file mode 100644
index 00000000..b2663231
--- /dev/null
+++ b/src/ext/Dependency/wixext/WixToolset.Dependency.wixext.csproj
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- 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. -->
+
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>netstandard2.0</TargetFramework>
+    <DebugType>embedded</DebugType>
+    <RootNamespace>WixToolset.Dependency</RootNamespace>
+    <Description>WiX Toolset Dependency Extension</Description>
+    <Title>WiX Toolset Dependency Extension</Title>
+    <IsTool>true</IsTool>
+    <IncludeSymbols>true</IncludeSymbols>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <EmbeddedResource Include="$(OutputPath)..\dependency.wixlib" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\wixlib\dependency.wixproj" ReferenceOutputAssembly="false" Condition=" '$(NCrunch)'=='' " />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="WixToolset.Data" Version="4.0.*" PrivateAssets="all" />
+    <PackageReference Include="WixToolset.Extensibility" Version="4.0.*" PrivateAssets="all" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="all" />
+    <PackageReference Include="Nerdbank.GitVersioning" Version="3.3.37" PrivateAssets="all" />
+  </ItemGroup>
+</Project>
diff --git a/src/ext/Dependency/wixext/WixToolset.Dependency.wixext.nuspec b/src/ext/Dependency/wixext/WixToolset.Dependency.wixext.nuspec
new file mode 100644
index 00000000..ba3eaade
--- /dev/null
+++ b/src/ext/Dependency/wixext/WixToolset.Dependency.wixext.nuspec
@@ -0,0 +1,25 @@
+<?xml version="1.0"?>
+<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
+  <metadata minClientVersion="4.0">
+    <id>$id$</id>
+    <version>$version$</version>
+    <title>$title$</title>
+    <description>$description$</description>
+    <authors>$authors$</authors>
+    <license type="expression">MS-RL</license>
+    <requireLicenseAcceptance>false</requireLicenseAcceptance>
+    <copyright>$copyright$</copyright>
+    <projectUrl>$projectUrl$</projectUrl>
+    <repository type="$repositorytype$" url="$repositoryurl$" commit="$repositorycommit$" />
+  </metadata>
+
+  <files>
+    <file src="$projectFolder$$id$.targets" target="build" />
+
+    <file src="netstandard2.0\$id$.dll" target="tools" />
+
+    <file src="ARM64\*.pdb" target="pdbs\ARM64" />
+    <file src="x86\*.pdb" target="pdbs\x86" />
+    <file src="x64\*.pdb" target="pdbs\x64" />
+  </files>
+</package>
diff --git a/src/ext/Dependency/wixext/WixToolset.Dependency.wixext.targets b/src/ext/Dependency/wixext/WixToolset.Dependency.wixext.targets
new file mode 100644
index 00000000..2b298736
--- /dev/null
+++ b/src/ext/Dependency/wixext/WixToolset.Dependency.wixext.targets
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- 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. -->
+
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="4.0">
+  <PropertyGroup>
+    <WixToolsetDependencyWixextPath Condition=" '$(WixToolsetDependencyWixextPath)' == '' ">$(MSBuildThisFileDirectory)..\tools\WixToolset.Dependency.wixext.dll</WixToolsetDependencyWixextPath>
+  </PropertyGroup>
+  <ItemGroup>
+    <WixExtension Include="$(WixToolsetDependencyWixextPath)" />
+  </ItemGroup>
+</Project>