Extract tracking and creating file transfers to ILayoutServices

This refactoring will allow more parts of the pipeline to add files
to be transferred during layout and tracked to participate in
MSBuild up to date checks and cleaning.

5 files changed, 108 insertions, 78 deletions

diff --git a/src/api/wix/WixToolset.Extensibility/Services/IBackendHelper.cs b/src/api/wix/WixToolset.Extensibility/Services/IBackendHelper.cs
index 5c4d9a68..29b8f8e6 100644
--- a/src/api/wix/WixToolset.Extensibility/Services/IBackendHelper.cs
+++ b/src/api/wix/WixToolset.Extensibility/Services/IBackendHelper.cs
@@ -12,7 +12,7 @@ namespace WixToolset.Extensibility.Services
     /// <summary>
     /// Interface provided to help backend extensions.
     /// </summary>
-    public interface IBackendHelper
+    public interface IBackendHelper : ILayoutServices
     {
         /// <summary>
         /// Creates a file facade from a <c>FileSymbol</c> and possible <c>AssemblySymbol</c>.
@@ -37,15 +37,6 @@ namespace WixToolset.Extensibility.Services
         IFileFacade CreateFileFacadeFromMergeModule(FileSymbol fileSymbol);
 
         /// <summary>
-        /// Creates a file transfer and marks it redundant if the source and destination are identical.
-        /// </summary>
-        /// <param name="source">Source for the file transfer.</param>
-        /// <param name="destination">Destination for the file transfer.</param>
-        /// <param name="move">Indicates whether to move or copy the source file.</param>
-        /// <param name="sourceLineNumbers">Optional source line numbers that requested the file transfer.</param>
-        IFileTransfer CreateFileTransfer(string source, string destination, bool move, SourceLineNumber sourceLineNumbers = null);
-
-        /// <summary>
         /// Creates a MSI compatible GUID.
         /// </summary>
         /// <returns>Creates an uppercase GUID with braces.</returns>
@@ -171,13 +162,5 @@ namespace WixToolset.Extensibility.Services
         /// Thus the returned array will always be of length 4.
         /// </remarks>
         string[] SplitMsiFileName(string value);
-
-        /// <summary>
-        /// Creates a tracked file.
-        /// </summary>
-        /// <param name="path">Destination path for the build output.</param>
-        /// <param name="type">Type of tracked file to create.</param>
-        /// <param name="sourceLineNumbers">Optional source line numbers that requested the tracked file.</param>
-        ITrackedFile TrackFile(string path, TrackedFileType type, SourceLineNumber sourceLineNumbers = null);
     }
 }
diff --git a/src/api/wix/WixToolset.Extensibility/Services/ILayoutServices.cs b/src/api/wix/WixToolset.Extensibility/Services/ILayoutServices.cs
new file mode 100644
index 00000000..79f89d29
--- /dev/null
+++ b/src/api/wix/WixToolset.Extensibility/Services/ILayoutServices.cs
@@ -0,0 +1,30 @@
+// 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.Extensibility.Services
+{
+    using WixToolset.Data;
+    using WixToolset.Extensibility.Data;
+
+    /// <summary>
+    /// Interface provided to track files for use by layout later.
+    /// </summary>
+    public interface ILayoutServices
+    {
+        /// <summary>
+        /// Creates a file transfer and marks it redundant if the source and destination are identical.
+        /// </summary>
+        /// <param name="source">Source for the file transfer.</param>
+        /// <param name="destination">Destination for the file transfer.</param>
+        /// <param name="move">Indicates whether to move or copy the source file.</param>
+        /// <param name="sourceLineNumbers">Optional source line numbers that requested the file transfer.</param>
+        IFileTransfer CreateFileTransfer(string source, string destination, bool move, SourceLineNumber sourceLineNumbers = null);
+
+        /// <summary>
+        /// Creates a tracked file.
+        /// </summary>
+        /// <param name="path">Destination path for the build output.</param>
+        /// <param name="type">Type of tracked file to create.</param>
+        /// <param name="sourceLineNumbers">Optional source line numbers that requested the tracked file.</param>
+        ITrackedFile TrackFile(string path, TrackedFileType type, SourceLineNumber sourceLineNumbers = null);
+    }
+}
diff --git a/src/wix/WixToolset.Core/ExtensibilityServices/BackendHelper.cs b/src/wix/WixToolset.Core/ExtensibilityServices/BackendHelper.cs
index cfa78623..9d657e1a 100644
--- a/src/wix/WixToolset.Core/ExtensibilityServices/BackendHelper.cs
+++ b/src/wix/WixToolset.Core/ExtensibilityServices/BackendHelper.cs
@@ -4,7 +4,6 @@ namespace WixToolset.Core.ExtensibilityServices
 {
     using System;
     using System.Collections.Generic;
-    using System.IO;
     using WixToolset.Core.Bind;
     using WixToolset.Data;
     using WixToolset.Data.Symbols;
@@ -12,17 +11,12 @@ namespace WixToolset.Core.ExtensibilityServices
     using WixToolset.Extensibility.Data;
     using WixToolset.Extensibility.Services;
 
-    internal class BackendHelper : IBackendHelper
+    internal class BackendHelper : LayoutServices, IBackendHelper
     {
-        private static readonly string[] ReservedFileNames = { "CON", "PRN", "AUX", "NUL", "COM1", "COM2", "COM3", "COM4", "COM5", "COM6", "COM7", "COM8", "COM9", "LPT1", "LPT2", "LPT3", "LPT4", "LPT5", "LPT6", "LPT7", "LPT8", "LPT9" };
-
-        public BackendHelper(IServiceProvider serviceProvider)
+        public BackendHelper(IServiceProvider serviceProvider) : base(serviceProvider)
         {
-            this.Messaging = serviceProvider.GetService<IMessaging>();
         }
 
-        private IMessaging Messaging { get; }
-
         public IFileFacade CreateFileFacade(FileSymbol file, AssemblySymbol assembly)
         {
             return new FileFacade(file, assembly);
@@ -38,22 +32,6 @@ namespace WixToolset.Core.ExtensibilityServices
             return new FileFacade(true, fileSymbol);
         }
 
-        public IFileTransfer CreateFileTransfer(string source, string destination, bool move, SourceLineNumber sourceLineNumbers = null)
-        {
-            var sourceFullPath = this.GetValidatedFullPath(sourceLineNumbers, source);
-
-            var destinationFullPath = this.GetValidatedFullPath(sourceLineNumbers, destination);
-
-            return (String.IsNullOrEmpty(sourceFullPath) || String.IsNullOrEmpty(destinationFullPath)) ? null : new FileTransfer
-            {
-                Source = sourceFullPath,
-                Destination = destinationFullPath,
-                Move = move,
-                SourceLineNumbers = sourceLineNumbers,
-                Redundant = String.Equals(sourceFullPath, destinationFullPath, StringComparison.OrdinalIgnoreCase)
-            };
-        }
-
         public string CreateGuid()
         {
             return Common.GenerateGuid();
@@ -112,11 +90,6 @@ namespace WixToolset.Core.ExtensibilityServices
             return Common.GetNames(value);
         }
 
-        public ITrackedFile TrackFile(string path, TrackedFileType type, SourceLineNumber sourceLineNumbers = null)
-        {
-            return new TrackedFile(path, type, sourceLineNumbers);
-        }
-
         public bool IsValidBinderVariable(string variable)
         {
             return Common.IsValidBinderVariable(variable);
@@ -141,36 +114,5 @@ namespace WixToolset.Core.ExtensibilityServices
         {
             return Common.IsValidShortFilename(filename, allowWildcards);
         }
-
-        private string GetValidatedFullPath(SourceLineNumber sourceLineNumbers, string path)
-        {
-            try
-            {
-                var result = Path.GetFullPath(path);
-
-                var filename = Path.GetFileName(result);
-
-                foreach (var reservedName in ReservedFileNames)
-                {
-                    if (reservedName.Equals(filename, StringComparison.OrdinalIgnoreCase))
-                    {
-                        this.Messaging.Write(ErrorMessages.InvalidFileName(sourceLineNumbers, path));
-                        return null;
-                    }
-                }
-
-                return result;
-            }
-            catch (ArgumentException)
-            {
-                this.Messaging.Write(ErrorMessages.InvalidFileName(sourceLineNumbers, path));
-            }
-            catch (PathTooLongException)
-            {
-                this.Messaging.Write(ErrorMessages.PathTooLong(sourceLineNumbers, path));
-            }
-
-            return null;
-        }
     }
 }
diff --git a/src/wix/WixToolset.Core/ExtensibilityServices/LayoutServices.cs b/src/wix/WixToolset.Core/ExtensibilityServices/LayoutServices.cs
new file mode 100644
index 00000000..84b43892
--- /dev/null
+++ b/src/wix/WixToolset.Core/ExtensibilityServices/LayoutServices.cs
@@ -0,0 +1,74 @@
+// 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.ExtensibilityServices
+{
+    using System;
+    using System.IO;
+    using WixToolset.Data;
+    using WixToolset.Extensibility.Data;
+    using WixToolset.Extensibility.Services;
+
+    internal class LayoutServices : ILayoutServices
+    {
+        private static readonly string[] ReservedFileNames = { "CON", "PRN", "AUX", "NUL", "COM1", "COM2", "COM3", "COM4", "COM5", "COM6", "COM7", "COM8", "COM9", "LPT1", "LPT2", "LPT3", "LPT4", "LPT5", "LPT6", "LPT7", "LPT8", "LPT9" };
+
+        public LayoutServices(IServiceProvider serviceProvider)
+        {
+            this.Messaging = serviceProvider.GetService<IMessaging>();
+        }
+
+        protected IMessaging Messaging { get; }
+
+        public IFileTransfer CreateFileTransfer(string source, string destination, bool move, SourceLineNumber sourceLineNumbers = null)
+        {
+            var sourceFullPath = this.GetValidatedFullPath(sourceLineNumbers, source);
+
+            var destinationFullPath = this.GetValidatedFullPath(sourceLineNumbers, destination);
+
+            return (String.IsNullOrEmpty(sourceFullPath) || String.IsNullOrEmpty(destinationFullPath)) ? null : new FileTransfer
+            {
+                Source = sourceFullPath,
+                Destination = destinationFullPath,
+                Move = move,
+                SourceLineNumbers = sourceLineNumbers,
+                Redundant = String.Equals(sourceFullPath, destinationFullPath, StringComparison.OrdinalIgnoreCase)
+            };
+        }
+
+        public ITrackedFile TrackFile(string path, TrackedFileType type, SourceLineNumber sourceLineNumbers = null)
+        {
+            return new TrackedFile(path, type, sourceLineNumbers);
+        }
+
+        protected string GetValidatedFullPath(SourceLineNumber sourceLineNumbers, string path)
+        {
+            try
+            {
+                var result = Path.GetFullPath(path);
+
+                var filename = Path.GetFileName(result);
+
+                foreach (var reservedName in ReservedFileNames)
+                {
+                    if (reservedName.Equals(filename, StringComparison.OrdinalIgnoreCase))
+                    {
+                        this.Messaging.Write(ErrorMessages.InvalidFileName(sourceLineNumbers, path));
+                        return null;
+                    }
+                }
+
+                return result;
+            }
+            catch (ArgumentException)
+            {
+                this.Messaging.Write(ErrorMessages.InvalidFileName(sourceLineNumbers, path));
+            }
+            catch (PathTooLongException)
+            {
+                this.Messaging.Write(ErrorMessages.PathTooLong(sourceLineNumbers, path));
+            }
+
+            return null;
+        }
+    }
+}
diff --git a/src/wix/WixToolset.Core/WixToolsetServiceProvider.cs b/src/wix/WixToolset.Core/WixToolsetServiceProvider.cs
index 5d700ba0..de89bb73 100644
--- a/src/wix/WixToolset.Core/WixToolsetServiceProvider.cs
+++ b/src/wix/WixToolset.Core/WixToolsetServiceProvider.cs
@@ -23,6 +23,7 @@ namespace WixToolset.Core
             this.AddService((provider, singletons) => AddSingleton<ISymbolDefinitionCreator>(singletons, new SymbolDefinitionCreator(provider)));
             this.AddService((provider, singletons) => AddSingleton<IParseHelper>(singletons, new ParseHelper(provider)));
             this.AddService((provider, singletons) => AddSingleton<IPreprocessHelper>(singletons, new PreprocessHelper(provider)));
+            this.AddService((provider, singletons) => AddSingleton<ILayoutServices>(singletons, new LayoutServices(provider)));
             this.AddService((provider, singletons) => AddSingleton<IBackendHelper>(singletons, new BackendHelper(provider)));
             this.AddService((provider, singletons) => AddSingleton<IPathResolver>(singletons, new PathResolver()));
             this.AddService((provider, singletons) => AddSingleton<IWixBranding>(singletons, new WixBranding()));