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

1 files changed, 308 insertions, 0 deletions

diff --git a/src/tools/heat/DirectoryHarvester.cs b/src/tools/heat/DirectoryHarvester.cs
new file mode 100644
index 00000000..c1cc3edb
--- /dev/null
+++ b/src/tools/heat/DirectoryHarvester.cs
@@ -0,0 +1,308 @@
+// 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
+{
+    using System;
+    using System.IO;
+    using WixToolset.Data;
+    using WixToolset.Harvesters.Data;
+    using WixToolset.Harvesters.Extensibility;
+    using Wix = WixToolset.Harvesters.Serialize;
+
+    /// <summary>
+    /// Harvest WiX authoring for a directory from the file system.
+    /// </summary>
+    public sealed class DirectoryHarvester : BaseHarvesterExtension
+    {
+        private FileHarvester fileHarvester;
+
+        private const string ComponentPrefix = "cmp";
+        private const string DirectoryPrefix = "dir";
+        private const string FilePrefix = "fil";
+
+        /// <summary>
+        /// Instantiate a new DirectoryHarvester.
+        /// </summary>
+        public DirectoryHarvester()
+        {
+            this.fileHarvester = new FileHarvester();
+            this.SetUniqueIdentifiers = true;
+        }
+
+        /// <summary>
+        /// Gets or sets what type of elements are to be generated.
+        /// </summary>
+        /// <value>The type of elements being generated.</value>
+        public GenerateType GenerateType { get; set; }
+
+        /// <summary>
+        /// Gets or sets the option to keep empty directories.
+        /// </summary>
+        /// <value>The option to keep empty directories.</value>
+        public bool KeepEmptyDirectories { get; set; }
+
+        /// <summary>
+        /// Gets or sets the rooted DirectoryRef Id if the user has supplied it.
+        /// </summary>
+        /// <value>The DirectoryRef Id to use as the root.</value>
+        public string RootedDirectoryRef { get; set; }
+
+        /// <summary>
+        /// Gets of sets the option to set unique identifiers.
+        /// </summary>
+        /// <value>The option to set unique identifiers.</value>
+        public bool SetUniqueIdentifiers { get; set; }
+
+        /// <summary>
+        /// Gets or sets the option to suppress including the root directory as an element.
+        /// </summary>
+        /// <value>The option to suppress including the root directory as an element.</value>
+        public bool SuppressRootDirectory { get; set; }
+
+        /// <summary>
+        /// Harvest a directory.
+        /// </summary>
+        /// <param name="argument">The path of the directory.</param>
+        /// <returns>The harvested directory.</returns>
+        public override Wix.Fragment[] Harvest(string argument)
+        {
+            if (null == argument)
+            {
+                throw new ArgumentNullException("argument");
+            }
+
+            Wix.IParentElement harvestParent = this.HarvestDirectory(argument, true, this.GenerateType);
+            Wix.ISchemaElement harvestElement;
+
+            if (this.GenerateType == GenerateType.PayloadGroup)
+            {
+                Wix.PayloadGroup payloadGroup = (Wix.PayloadGroup)harvestParent;
+                payloadGroup.Id = this.RootedDirectoryRef;
+                harvestElement = payloadGroup;
+            }
+            else
+            {
+                Wix.Directory directory = (Wix.Directory)harvestParent;
+
+                Wix.DirectoryRef directoryRef = new Wix.DirectoryRef();
+                directoryRef.Id = this.RootedDirectoryRef;
+
+                if (this.SuppressRootDirectory)
+                {
+                    foreach (Wix.ISchemaElement element in directory.Children)
+                    {
+                        directoryRef.AddChild(element);
+                    }
+                }
+                else
+                {
+                    directoryRef.AddChild(directory);
+                }
+                harvestElement = directoryRef;
+            }
+
+            Wix.Fragment fragment = new Wix.Fragment();
+            fragment.AddChild(harvestElement);
+
+            return new Wix.Fragment[] { fragment };
+        }
+
+        /// <summary>
+        /// Harvest a directory.
+        /// </summary>
+        /// <param name="path">The path of the directory.</param>
+        /// <param name="harvestChildren">The option to harvest child directories and files.</param>
+        /// <returns>The harvested directory.</returns>
+        public Wix.Directory HarvestDirectory(string path, bool harvestChildren)
+        {
+            if (null == path)
+            {
+                throw new ArgumentNullException("path");
+            }
+
+            return (Wix.Directory)this.HarvestDirectory(path, harvestChildren, GenerateType.Components);
+        }
+
+        /// <summary>
+        /// Harvest a directory.
+        /// </summary>
+        /// <param name="path">The path of the directory.</param>
+        /// <param name="harvestChildren">The option to harvest child directories and files.</param>
+        /// <param name="generateType">The type to generate.</param>
+        /// <returns>The harvested directory.</returns>
+        private Wix.IParentElement HarvestDirectory(string path, bool harvestChildren, GenerateType generateType)
+        {
+            if (File.Exists(path))
+            {
+                throw new WixException(ErrorMessages.ExpectedDirectoryGotFile("dir", path));
+            }
+
+            if (null == this.RootedDirectoryRef)
+            {
+                this.RootedDirectoryRef = "TARGETDIR";
+            }
+
+            // use absolute paths
+            path = Path.GetFullPath(path);
+
+            // Remove any trailing separator to ensure Path.GetFileName() will return the directory name.
+            path = path.TrimEnd(Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar);
+
+            Wix.IParentElement harvestParent;
+            if (generateType == GenerateType.PayloadGroup)
+            {
+                harvestParent = new Wix.PayloadGroup();
+            }
+            else
+            {
+                Wix.Directory directory = new Wix.Directory();
+                directory.Name = Path.GetFileName(path);
+                directory.FileSource = path;
+
+                if (this.SetUniqueIdentifiers)
+                {
+                    if (this.SuppressRootDirectory)
+                    {
+                        directory.Id = this.Core.GenerateIdentifier(DirectoryPrefix, this.RootedDirectoryRef);
+                    }
+                    else
+                    {
+                        directory.Id = this.Core.GenerateIdentifier(DirectoryPrefix, this.RootedDirectoryRef, directory.Name);
+                    }
+                }
+                harvestParent = directory;
+            }
+
+            if (harvestChildren)
+            {
+                try
+                {
+                    int fileCount = this.HarvestDirectory(path, "SourceDir\\", harvestParent, generateType);
+
+                    if (generateType != GenerateType.PayloadGroup)
+                    {
+                        // its an error to not harvest anything with the option to keep empty directories off
+                        if (0 == fileCount && !this.KeepEmptyDirectories)
+                        {
+                            throw new WixException(HarvesterErrors.EmptyDirectory(path));
+                        }
+                    }
+                }
+                catch (DirectoryNotFoundException)
+                {
+                    throw new WixException(HarvesterErrors.DirectoryNotFound(path));
+                }
+            }
+
+            return harvestParent;
+        }
+
+        /// <summary>
+        /// Harvest a directory.
+        /// </summary>
+        /// <param name="path">The path of the directory.</param>
+        /// <param name="relativePath">The relative path that will be used when harvesting.</param>
+        /// <param name="harvestParent">The directory for this path.</param>
+        /// <param name="generateType"></param>
+        /// <returns>The number of files harvested.</returns>
+        private int HarvestDirectory(string path, string relativePath, Wix.IParentElement harvestParent, GenerateType generateType)
+        {
+            int fileCount = 0;
+            Wix.Directory directory = generateType != GenerateType.PayloadGroup ? (Wix.Directory)harvestParent : null;
+
+            // harvest the child directories
+            foreach (string childDirectoryPath in Directory.GetDirectories(path))
+            {
+                var childDirectoryName = Path.GetFileName(childDirectoryPath);
+                Wix.IParentElement newParent;
+                Wix.Directory childDirectory = null;
+
+                if (generateType == GenerateType.PayloadGroup)
+                {
+                    newParent = harvestParent;
+                }
+                else
+                {
+                    childDirectory = new Wix.Directory();
+                    newParent = childDirectory;
+
+                    childDirectory.Name = childDirectoryName;
+                    childDirectory.FileSource = childDirectoryPath;
+
+                    if (this.SetUniqueIdentifiers)
+                    {
+                        childDirectory.Id = this.Core.GenerateIdentifier(DirectoryPrefix, directory.Id, childDirectory.Name);
+                    }
+                }
+
+                int childFileCount = this.HarvestDirectory(childDirectoryPath, String.Concat(relativePath, childDirectoryName, "\\"), newParent, generateType);
+
+                if (generateType != GenerateType.PayloadGroup)
+                {
+                    // keep the directory if it contained any files (or empty directories are being kept)
+                    if (0 < childFileCount || this.KeepEmptyDirectories)
+                    {
+                        directory.AddChild(childDirectory);
+                    }
+                }
+
+                fileCount += childFileCount;
+            }
+
+            // harvest the files
+            string[] files = Directory.GetFiles(path);
+            if (0 < files.Length)
+            {
+                foreach (string filePath in Directory.GetFiles(path))
+                {
+                    string fileName = Path.GetFileName(filePath);
+                    string source = String.Concat(relativePath, fileName);
+
+                    Wix.ISchemaElement newChild;
+                    if (generateType == GenerateType.PayloadGroup)
+                    {
+                        Wix.Payload payload = new Wix.Payload();
+                        newChild = payload;
+
+                        payload.SourceFile = source;
+                    }
+                    else
+                    {
+                        Wix.Component component = new Wix.Component();
+                        newChild = component;
+
+                        Wix.File file = this.fileHarvester.HarvestFile(filePath);
+                        file.Source = source;
+
+                        if (this.SetUniqueIdentifiers)
+                        {
+                            file.Id = this.Core.GenerateIdentifier(FilePrefix, directory.Id, fileName);
+                            component.Id = this.Core.GenerateIdentifier(ComponentPrefix, directory.Id, file.Id);
+                        }
+
+                        component.AddChild(file);
+                    }
+
+                    harvestParent.AddChild(newChild);
+                }
+            }
+            else if (generateType != GenerateType.PayloadGroup && 0 == fileCount && this.KeepEmptyDirectories)
+            {
+                Wix.Component component = new Wix.Component();
+                component.KeyPath = Wix.YesNoType.yes;
+
+                if (this.SetUniqueIdentifiers)
+                {
+                    component.Id = this.Core.GenerateIdentifier(ComponentPrefix, directory.Id);
+                }
+
+                Wix.CreateFolder createFolder = new Wix.CreateFolder();
+                component.AddChild(createFolder);
+
+                directory.AddChild(component);
+            }
+
+            return fileCount + files.Length;
+        }
+    }
+}