Support wixout and extract Resolve and Layout from Binder

1 files changed, 188 insertions, 0 deletions

diff --git a/src/WixToolset.Core/Layout.cs b/src/WixToolset.Core/Layout.cs
new file mode 100644
index 00000000..d7322a12
--- /dev/null
+++ b/src/WixToolset.Core/Layout.cs
@@ -0,0 +1,188 @@
+// 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.Collections.Generic;
+    using System.IO;
+    using System.Linq;
+    using WixToolset.Core.Bind;
+    using WixToolset.Data;
+    using WixToolset.Data.Bind;
+    using WixToolset.Data.Tuples;
+    using WixToolset.Extensibility;
+    using WixToolset.Extensibility.Services;
+
+    /// <summary>
+    /// Layout for the WiX toolset.
+    /// </summary>
+    public sealed class Layout
+    {
+        public Layout(IServiceProvider serviceProvider, IEnumerable<FileTransfer> fileTransfers, IEnumerable<string> contentFilePaths, string contentsFile, string outputsFile, string builtOutputsFile, bool suppressAclReset)
+        {
+            this.ServiceProvider = serviceProvider;
+            this.FileTransfers = fileTransfers;
+            this.ContentFilePaths = contentFilePaths;
+            this.ContentsFile = contentsFile;
+            this.OutputsFile = outputsFile;
+            this.BuiltOutputsFile = builtOutputsFile;
+            this.SuppressAclReset = suppressAclReset;
+            this.Messaging = this.ServiceProvider.GetService<IMessaging>();
+        }
+
+        private IServiceProvider ServiceProvider { get; }
+
+        private IEnumerable<FileTransfer> FileTransfers { get; }
+
+        private IEnumerable<string> ContentFilePaths { get; }
+
+        private string ContentsFile { get; }
+
+        private string OutputsFile { get; }
+
+        private string BuiltOutputsFile { get; }
+
+        private bool SuppressAclReset { get; }
+
+        private IMessaging Messaging { get; }
+
+        public void Execute()
+        {
+            var extensionManager = this.ServiceProvider.GetService<IExtensionManager>();
+
+            var context = this.ServiceProvider.GetService<ILayoutContext>();
+            context.Messaging = this.Messaging;
+            context.Extensions = extensionManager.Create<ILayoutExtension>();
+            context.FileSystemExtensions = extensionManager.Create<IFileSystemExtension>();
+            context.FileTransfers = this.FileTransfers;
+            context.ContentFilePaths = this.ContentFilePaths;
+            context.ContentsFile = this.ContentsFile;
+            context.OutputPdbPath = this.OutputsFile;
+            context.BuiltOutputsFile = this.BuiltOutputsFile;
+            context.SuppressAclReset = this.SuppressAclReset;
+
+            // Pre-layout.
+            //
+            foreach (var extension in context.Extensions)
+            {
+                extension.PreLayout(context);
+            }
+
+            try
+            {
+                // Final step in binding that transfers (moves/copies) all files generated into the appropriate
+                // location in the source image.
+                if (context.FileTransfers?.Any() == true)
+                {
+                    this.Messaging.Write(VerboseMessages.LayingOutMedia());
+
+                    var command = new TransferFilesCommand(context.Messaging, context.FileSystemExtensions, context.FileTransfers, context.SuppressAclReset);
+                    command.Execute();
+                }
+            }
+            finally
+            {
+                if (!String.IsNullOrEmpty(context.ContentsFile) && context.ContentFilePaths != null)
+                {
+                    this.CreateContentsFile(context.ContentsFile, context.ContentFilePaths);
+                }
+
+                if (!String.IsNullOrEmpty(context.OutputsFile) && context.FileTransfers != null)
+                {
+                    this.CreateOutputsFile(context.OutputsFile, context.FileTransfers, context.OutputPdbPath);
+                }
+
+                if (!String.IsNullOrEmpty(context.BuiltOutputsFile) && context.FileTransfers != null)
+                {
+                    this.CreateBuiltOutputsFile(context.BuiltOutputsFile, context.FileTransfers, context.OutputPdbPath);
+                }
+            }
+
+            // Post-layout.
+            foreach (var extension in context.Extensions)
+            {
+                extension.PostLayout();
+            }
+        }
+
+        /// <summary>
+        /// Writes the paths to the content files to a text file.
+        /// </summary>
+        /// <param name="path">Path to write file.</param>
+        /// <param name="contentFilePaths">Collection of paths to content files that will be written to file.</param>
+        private void CreateContentsFile(string path, IEnumerable<string> contentFilePaths)
+        {
+            var directory = Path.GetDirectoryName(path);
+            Directory.CreateDirectory(directory);
+
+            using (var contents = new StreamWriter(path, false))
+            {
+                foreach (string contentPath in contentFilePaths)
+                {
+                    contents.WriteLine(contentPath);
+                }
+            }
+        }
+
+        /// <summary>
+        /// Writes the paths to the output files to a text file.
+        /// </summary>
+        /// <param name="path">Path to write file.</param>
+        /// <param name="fileTransfers">Collection of files that were transferred to the output directory.</param>
+        /// <param name="pdbPath">Optional path to created .wixpdb.</param>
+        private void CreateOutputsFile(string path, IEnumerable<FileTransfer> fileTransfers, string pdbPath)
+        {
+            var directory = Path.GetDirectoryName(path);
+            Directory.CreateDirectory(directory);
+
+            using (var outputs = new StreamWriter(path, false))
+            {
+                foreach (FileTransfer fileTransfer in fileTransfers)
+                {
+                    // Don't list files where the source is the same as the destination since
+                    // that might be the only place the file exists. The outputs file is often
+                    // used to delete stuff and losing the original source would be bad.
+                    if (!fileTransfer.Redundant)
+                    {
+                        outputs.WriteLine(fileTransfer.Destination);
+                    }
+                }
+
+                if (!String.IsNullOrEmpty(pdbPath))
+                {
+                    outputs.WriteLine(Path.GetFullPath(pdbPath));
+                }
+            }
+        }
+
+        /// <summary>
+        /// Writes the paths to the built output files to a text file.
+        /// </summary>
+        /// <param name="path">Path to write file.</param>
+        /// <param name="fileTransfers">Collection of files that were transferred to the output directory.</param>
+        /// <param name="pdbPath">Optional path to created .wixpdb.</param>
+        private void CreateBuiltOutputsFile(string path, IEnumerable<FileTransfer> fileTransfers, string pdbPath)
+        {
+            var directory = Path.GetDirectoryName(path);
+            Directory.CreateDirectory(directory);
+
+            using (var outputs = new StreamWriter(path, false))
+            {
+                foreach (FileTransfer fileTransfer in fileTransfers)
+                {
+                    // Only write the built file transfers. Also, skip redundant
+                    // files for the same reason spelled out in this.CreateOutputsFile().
+                    if (fileTransfer.Built && !fileTransfer.Redundant)
+                    {
+                        outputs.WriteLine(fileTransfer.Destination);
+                    }
+                }
+
+                if (!String.IsNullOrEmpty(pdbPath))
+                {
+                    outputs.WriteLine(Path.GetFullPath(pdbPath));
+                }
+            }
+        }
+    }
+}