Create WixToolset.Heat.nupkg to distribute heat.exe and Heat targets

Moves Heat functionality to the "tools" layer and packages it all
up in WixToolset.Heat.nupkg for distribution in WiX v4.

Completes 6838

10 files changed, 486 insertions, 0 deletions

diff --git a/src/tools/heat/Extensibility/BaseHarvesterExtension.cs b/src/tools/heat/Extensibility/BaseHarvesterExtension.cs
new file mode 100644
index 00000000..02696d5b
--- /dev/null
+++ b/src/tools/heat/Extensibility/BaseHarvesterExtension.cs
@@ -0,0 +1,26 @@
+// 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.Harvesters.Extensibility
+{
+    using Wix = WixToolset.Harvesters.Serialize;
+
+    /// <summary>
+    /// The base harvester extension.  Any of these methods can be overridden to change
+    /// the behavior of the harvester.
+    /// </summary>
+    public abstract class BaseHarvesterExtension : IHarvesterExtension
+    {
+        /// <summary>
+        /// Gets or sets the harvester core for the extension.
+        /// </summary>
+        /// <value>The harvester core for the extension.</value>
+        public IHarvesterCore Core { get; set; }
+
+        /// <summary>
+        /// Harvest a WiX document.
+        /// </summary>
+        /// <param name="argument">The argument for harvesting.</param>
+        /// <returns>The harvested Fragments.</returns>
+        public abstract Wix.Fragment[] Harvest(string argument);
+    }
+}
diff --git a/src/tools/heat/Extensibility/BaseHeatExtension.cs b/src/tools/heat/Extensibility/BaseHeatExtension.cs
new file mode 100644
index 00000000..b76aaf62
--- /dev/null
+++ b/src/tools/heat/Extensibility/BaseHeatExtension.cs
@@ -0,0 +1,55 @@
+// 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.Harvesters.Extensibility
+{
+    using System;
+    using WixToolset.Harvesters.Data;
+
+    /// <summary>
+    /// An extension for the WiX Toolset Harvester application.
+    /// </summary>
+    public abstract class BaseHeatExtension : IHeatExtension
+    {
+        /// <summary>
+        /// Gets or sets the heat core for the extension.
+        /// </summary>
+        /// <value>The heat core for the extension.</value>
+        public IHeatCore Core { get; set; }
+
+        /// <summary>
+        /// Gets the supported command line types for this extension.
+        /// </summary>
+        /// <value>The supported command line types for this extension.</value>
+        public virtual HeatCommandLineOption[] CommandLineTypes
+        {
+            get { return null; }
+        }
+
+        /// <summary>
+        /// Parse the command line options for this extension.
+        /// </summary>
+        /// <param name="type">The active harvester type.</param>
+        /// <param name="args">The option arguments.</param>
+        public virtual void ParseOptions(string type, string[] args)
+        {
+        }
+
+        /// <summary>
+        /// Determines if the index refers to an argument.
+        /// </summary>
+        /// <param name="args"></param>
+        /// <param name="index"></param>
+        /// <returns></returns>
+        public static bool IsValidArg(string[] args, int index)
+        {
+            if (args.Length <= index || String.IsNullOrEmpty(args[index]) || '/' == args[index][0] || '-' == args[index][0])
+            {
+                return false;
+            }
+            else
+            {
+                return true;
+            }
+        }
+    }
+}
diff --git a/src/tools/heat/Extensibility/BaseMutatorExtension.cs b/src/tools/heat/Extensibility/BaseMutatorExtension.cs
new file mode 100644
index 00000000..c36a8ed1
--- /dev/null
+++ b/src/tools/heat/Extensibility/BaseMutatorExtension.cs
@@ -0,0 +1,202 @@
+// 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.Harvesters.Extensibility
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Text;
+    using Wix = WixToolset.Harvesters.Serialize;
+
+    /// <summary>
+    /// The base mutator extension.  Any of these methods can be overridden to change
+    /// the behavior of the mutator.
+    /// </summary>
+    public abstract class BaseMutatorExtension : IMutatorExtension
+    {
+        /// <summary>
+        /// Gets or sets the mutator core for the extension.
+        /// </summary>
+        /// <value>The mutator core for the extension.</value>
+        public IHarvesterCore Core { get; set; }
+
+        /// <summary>
+        /// Gets the sequence of the extension.
+        /// </summary>
+        /// <value>The sequence of the extension.</value>
+        public abstract int Sequence { get; }
+
+        /// <summary>
+        /// Mutate a WiX document.
+        /// </summary>
+        /// <param name="wix">The Wix document element.</param>
+        public virtual void Mutate(Wix.Wix wix)
+        {
+        }
+
+        /// <summary>
+        /// Mutate a WiX document as a string.
+        /// </summary>
+        /// <param name="wixString">The Wix document element as a string.</param>
+        /// <returns>The mutated Wix document as a string.</returns>
+        public virtual string Mutate(string wixString)
+        {
+            return wixString;
+        }
+
+        /// <summary>
+        /// Generate unique MSI identifiers.
+        /// </summary>
+        protected class IdentifierGenerator
+        {
+            /// <summary>
+            /// 
+            /// </summary>
+            public const int MaxProductIdentifierLength = 72;
+
+            /// <summary>
+            /// 
+            /// </summary>
+            public const int MaxModuleIdentifierLength = 35;
+
+            private string baseName;
+            private int maxLength;
+            private Dictionary<string, object> existingIdentifiers;
+            private Dictionary<string, object> possibleIdentifiers;
+            private IHarvesterCore harvesterCore;
+
+            /// <summary>
+            /// Instantiate a new IdentifierGenerator.
+            /// </summary>
+            /// <param name="baseName">The base resource name to use if a resource name contains no usable characters.</param>
+            /// <param name="harvesterCore"></param>
+            public IdentifierGenerator(string baseName, IHarvesterCore harvesterCore)
+            {
+                this.baseName = baseName;
+                this.maxLength = IdentifierGenerator.MaxProductIdentifierLength;
+                this.existingIdentifiers = new Dictionary<string, object>(StringComparer.OrdinalIgnoreCase);
+                this.possibleIdentifiers = new Dictionary<string, object>(StringComparer.OrdinalIgnoreCase);
+                this.harvesterCore = harvesterCore;
+            }
+
+            /// <summary>
+            /// Gets or sets the maximum length for generated identifiers.
+            /// </summary>
+            /// <value>Maximum length for generated identifiers. (Default is 72.)</value>
+            public int MaxIdentifierLength
+            {
+                get { return this.maxLength; }
+                set { this.maxLength = value; }
+            }
+
+            /// <summary>
+            /// Index an existing identifier for collision detection.
+            /// </summary>
+            /// <param name="identifier">The identifier.</param>
+            public void IndexExistingIdentifier(string identifier)
+            {
+                if (null == identifier)
+                {
+                    throw new ArgumentNullException("identifier");
+                }
+
+                this.existingIdentifiers[identifier] = null;
+            }
+
+            /// <summary>
+            /// Index a resource name for collision detection.
+            /// </summary>
+            /// <param name="name">The resource name.</param>
+            public void IndexName(string name)
+            {
+                if (null == name)
+                {
+                    throw new ArgumentNullException("name");
+                }
+
+                string identifier = this.CreateIdentifier(name, 0);
+
+                if (this.possibleIdentifiers.ContainsKey(identifier))
+                {
+                    this.possibleIdentifiers[identifier] = String.Empty;
+                }
+                else
+                {
+                    this.possibleIdentifiers.Add(identifier, null);
+                }
+            }
+
+            /// <summary>
+            /// Get the identifier for the given resource name.
+            /// </summary>
+            /// <param name="name">The resource name.</param>
+            /// <returns>A legal MSI identifier.</returns>
+            public string GetIdentifier(string name)
+            {
+                if (null == name)
+                {
+                    throw new ArgumentNullException("name");
+                }
+
+                for (int i = 0; i <= Int32.MaxValue; i++)
+                {
+                    string identifier = this.CreateIdentifier(name, i);
+
+                    if (this.existingIdentifiers.ContainsKey(identifier) || // already used
+                        (0 == i && 0 != this.possibleIdentifiers.Count && null != this.possibleIdentifiers[identifier]) || // needs an index because its duplicated
+                        (0 != i && this.possibleIdentifiers.ContainsKey(identifier))) // collides with another possible identifier
+                    {
+                        continue;
+                    }
+                    else // use this identifier
+                    {
+                        this.existingIdentifiers.Add(identifier, null);
+
+                        return identifier;
+                    }
+                }
+
+                throw new InvalidOperationException("Could not find a unique identifier for the given resource name.");
+            }
+
+            /// <summary>
+            /// Create a legal MSI identifier from a resource name and an index.
+            /// </summary>
+            /// <param name="name">The name of the resource for which an identifier should be created.</param>
+            /// <param name="index">An index to append to the end of the identifier to make it unique.</param>
+            /// <returns>A legal MSI identifier.</returns>
+            public string CreateIdentifier(string name, int index)
+            {
+                if (null == name)
+                {
+                    throw new ArgumentNullException("name");
+                }
+
+                StringBuilder identifier = new StringBuilder();
+
+                // Convert the name to a standard MSI identifier
+                identifier.Append(this.harvesterCore.CreateIdentifierFromFilename(name));
+
+                // no legal identifier characters were found, use the base id instead
+                if (0 == identifier.Length)
+                {
+                    identifier.Append(this.baseName);
+                }
+
+                // truncate the identifier if it's too long (reserve 3 characters for up to 99 collisions)
+                int adjustedMaxLength = this.MaxIdentifierLength - (index != 0 ? 3 : 0);
+                if (adjustedMaxLength < identifier.Length)
+                {
+                    identifier.Length = adjustedMaxLength;
+                }
+
+                // if the index is not zero, then append it to the identifier name
+                if (0 != index)
+                {
+                    identifier.AppendFormat("_{0}", index);
+                }
+
+                return identifier.ToString();
+            }
+        }
+    }
+}
diff --git a/src/tools/heat/Extensibility/IHarvester.cs b/src/tools/heat/Extensibility/IHarvester.cs
new file mode 100644
index 00000000..6d363b50
--- /dev/null
+++ b/src/tools/heat/Extensibility/IHarvester.cs
@@ -0,0 +1,31 @@
+// 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.Harvesters.Extensibility
+{
+    using Wix = WixToolset.Harvesters.Serialize;
+
+    /// <summary>
+    /// Interface for the harvester.
+    /// </summary>
+    public interface IHarvester
+    {
+        /// <summary>
+        /// Gets or sets the harvester core for the extension.
+        /// </summary>
+        /// <value>The harvester core for the extension.</value>
+        IHarvesterCore Core { get; }
+
+        /// <summary>
+        /// Gets or sets the extension.
+        /// </summary>
+        /// <value>The extension.</value>
+        IHarvesterExtension Extension { get; set; }
+
+        /// <summary>
+        /// Harvest wix authoring.
+        /// </summary>
+        /// <param name="argument">The argument for harvesting.</param>
+        /// <returns>The harvested wix authoring.</returns>
+        Wix.Wix Harvest(string argument);
+    }
+}
diff --git a/src/tools/heat/Extensibility/IHarvesterCore.cs b/src/tools/heat/Extensibility/IHarvesterCore.cs
new file mode 100644
index 00000000..3c34b8a1
--- /dev/null
+++ b/src/tools/heat/Extensibility/IHarvesterCore.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.Harvesters.Extensibility
+{
+    using WixToolset.Extensibility.Services;
+
+    /// <summary>
+    /// The WiX Toolset harvester core.
+    /// </summary>
+    public interface IHarvesterCore
+    {
+        /// <summary>
+        /// 
+        /// </summary>
+        IMessaging Messaging { get; set; }
+
+        /// <summary>
+        /// Gets or sets the value of the extension argument passed to heat.
+        /// </summary>
+        /// <value>The extension argument.</value>
+        string ExtensionArgument { get; set; }
+
+        /// <summary>
+        /// Gets or sets the value of the root directory that is being harvested.
+        /// </summary>
+        /// <value>The root directory being harvested.</value>
+        string RootDirectory { get; set; }
+
+        /// <summary>
+        /// Create an identifier based on passed file name
+        /// </summary>
+        /// <param name="filename">File name to generate identifer from</param>
+        /// <returns></returns>
+        string CreateIdentifierFromFilename(string filename);
+
+        /// <summary>
+        /// Generate an identifier by hashing data from the row.
+        /// </summary>
+        /// <param name="prefix">Three letter or less prefix for generated row identifier.</param>
+        /// <param name="args">Information to hash.</param>
+        /// <returns>The generated identifier.</returns>
+        string GenerateIdentifier(string prefix, params string[] args);
+
+        /// <summary>
+        /// Resolves a file's path if the Wix.File.Source value starts with "SourceDir\".
+        /// </summary>
+        /// <param name="fileSource">The Wix.File.Source value with "SourceDir\".</param>
+        /// <returns>The full path of the file.</returns>
+        string ResolveFilePath(string fileSource);
+    }
+}
diff --git a/src/tools/heat/Extensibility/IHarvesterExtension.cs b/src/tools/heat/Extensibility/IHarvesterExtension.cs
new file mode 100644
index 00000000..5125ea32
--- /dev/null
+++ b/src/tools/heat/Extensibility/IHarvesterExtension.cs
@@ -0,0 +1,14 @@
+// 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.Harvesters.Extensibility
+{
+    using Wix = WixToolset.Harvesters.Serialize;
+
+#pragma warning disable 1591 // TODO: add documentation
+    public interface IHarvesterExtension
+    {
+        IHarvesterCore Core { get; set; }
+
+        Wix.Fragment[] Harvest(string argument);
+    }
+}
diff --git a/src/tools/heat/Extensibility/IHeatCore.cs b/src/tools/heat/Extensibility/IHeatCore.cs
new file mode 100644
index 00000000..0aa01b62
--- /dev/null
+++ b/src/tools/heat/Extensibility/IHeatCore.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.Harvesters.Extensibility
+{
+    using WixToolset.Extensibility.Services;
+
+    /// <summary>
+    /// The WiX Toolset Harvester application core.
+    /// </summary>
+    public interface IHeatCore
+    {
+        /// <summary>
+        /// Gets the harvester.
+        /// </summary>
+        /// <value>The harvester.</value>
+        IHarvester Harvester { get; }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        IMessaging Messaging { get; }
+
+        /// <summary>
+        /// Gets the mutator.
+        /// </summary>
+        /// <value>The mutator.</value>
+        IMutator Mutator { get; }
+    }
+}
diff --git a/src/tools/heat/Extensibility/IHeatExtension.cs b/src/tools/heat/Extensibility/IHeatExtension.cs
new file mode 100644
index 00000000..8a00da37
--- /dev/null
+++ b/src/tools/heat/Extensibility/IHeatExtension.cs
@@ -0,0 +1,16 @@
+// 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.Harvesters.Extensibility
+{
+    using WixToolset.Harvesters.Data;
+
+#pragma warning disable 1591 // TODO: add documentation
+    public interface IHeatExtension
+    {
+        IHeatCore Core { get; set; }
+
+        HeatCommandLineOption[] CommandLineTypes { get; }
+
+        void ParseOptions(string type, string[] args);
+    }
+}
diff --git a/src/tools/heat/Extensibility/IMutator.cs b/src/tools/heat/Extensibility/IMutator.cs
new file mode 100644
index 00000000..c936339e
--- /dev/null
+++ b/src/tools/heat/Extensibility/IMutator.cs
@@ -0,0 +1,44 @@
+// 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.Harvesters.Extensibility
+{
+    using Wix = WixToolset.Harvesters.Serialize;
+
+    /// <summary>
+    /// Interface for a mutator.
+    /// </summary>
+    public interface IMutator
+    {
+        /// <summary>
+        /// Gets or sets the harvester core for the extension.
+        /// </summary>
+        /// <value>The harvester core for the extension.</value>
+        IHarvesterCore Core { get; }
+
+        /// <summary>
+        /// Gets or sets the value of the extension argument passed to heat.
+        /// </summary>
+        /// <value>The extension argument.</value>
+        string ExtensionArgument { get; }
+
+        /// <summary>
+        /// Adds a mutator extension.
+        /// </summary>
+        /// <param name="mutatorExtension">The mutator extension to add.</param>
+        void AddExtension(IMutatorExtension mutatorExtension);
+
+        /// <summary>
+        /// Mutate a WiX document.
+        /// </summary>
+        /// <param name="wix">The Wix document element.</param>
+        /// <returns>true if mutation was successful</returns>
+        bool Mutate(Wix.Wix wix);
+
+        /// <summary>
+        /// Mutate a WiX document.
+        /// </summary>
+        /// <param name="wixString">The Wix document as a string.</param>
+        /// <returns>The mutated Wix document as a string if mutation was successful, else null.</returns>
+        string Mutate(string wixString);
+    }
+}
diff --git a/src/tools/heat/Extensibility/IMutatorExtension.cs b/src/tools/heat/Extensibility/IMutatorExtension.cs
new file mode 100644
index 00000000..b81f586e
--- /dev/null
+++ b/src/tools/heat/Extensibility/IMutatorExtension.cs
@@ -0,0 +1,18 @@
+// 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.Harvesters.Extensibility
+{
+    using Wix = WixToolset.Harvesters.Serialize;
+
+#pragma warning disable 1591 // TODO: add documentation
+    public interface IMutatorExtension
+    {
+        IHarvesterCore Core { get; set; }
+
+        int Sequence { get; }
+
+        void Mutate(Wix.Wix wix);
+
+        string Mutate(string wixString);
+    }
+}