Incorporate refactoring of WixToolset.Core assemblies

8 files changed, 257 insertions, 25 deletions

diff --git a/src/WixToolset.Data/Bind/BindResult.cs b/src/WixToolset.Data/Bind/BindResult.cs
new file mode 100644
index 00000000..917bebca
--- /dev/null
+++ b/src/WixToolset.Data/Bind/BindResult.cs
@@ -0,0 +1,19 @@
+// 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.Data.Bind
+{
+    using System.Collections.Generic;
+
+    public class BindResult
+    {
+        public BindResult(IEnumerable<FileTransfer> fileTransfers, IEnumerable<string> contentFilePaths)
+        {
+            this.FileTransfers = fileTransfers;
+            this.ContentFilePaths = contentFilePaths;
+        }
+
+        public IEnumerable<FileTransfer> FileTransfers { get; }
+
+        public IEnumerable<string> ContentFilePaths { get; }
+    }
+}
\ No newline at end of file
diff --git a/src/WixToolset.Data/Bind/BindStage.cs b/src/WixToolset.Data/Bind/BindStage.cs
new file mode 100644
index 00000000..500ea288
--- /dev/null
+++ b/src/WixToolset.Data/Bind/BindStage.cs
@@ -0,0 +1,27 @@
+// 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.Data.Bind
+{
+    /// <summary>
+    /// Bind stage of a file.. The reason we need this is to change the ResolveFile behavior based on if
+    /// dynamic bindpath plugin is desirable. We cannot change the signature of ResolveFile since it might
+    /// break existing implementers which derived from BinderFileManager
+    /// </summary>
+    public enum BindStage
+    {
+        /// <summary>
+        /// Normal binding
+        /// </summary>
+        Normal,
+
+        /// <summary>
+        /// Bind the file path of the target build file
+        /// </summary>
+        Target,
+
+        /// <summary>
+        /// Bind the file path of the updated build file
+        /// </summary>
+        Updated,
+    }
+}
diff --git a/src/WixToolset.Data/Bind/FileTransfer.cs b/src/WixToolset.Data/Bind/FileTransfer.cs
new file mode 100644
index 00000000..178934e8
--- /dev/null
+++ b/src/WixToolset.Data/Bind/FileTransfer.cs
@@ -0,0 +1,111 @@
+// 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.Data.Bind
+{
+    using System;
+    using System.IO;
+
+    /// <summary>
+    /// Structure used for all file transfer information.
+    /// </summary>
+    public class FileTransfer
+    {
+        /// <summary>Source path to file.</summary>
+        public string Source { get; set; }
+
+        /// <summary>Destination path for file.</summary>
+        public string Destination { get; set; }
+
+        /// <summary>Flag if file should be moved (optimal).</summary>
+        public bool Move { get; set; }
+
+        /// <summary>Optional source line numbers where this file transfer orginated.</summary>
+        public SourceLineNumber SourceLineNumbers { get; set; }
+
+        /// <summary>Optional type of file this transfer is moving or copying.</summary>
+        public string Type { get; set; }
+
+        /// <summary>Indicates whether the file transer was a built by this build or copied from other some build.</summary>
+        public bool Built { get; set; }
+
+        /// <summary>Set during layout of media when the file transfer when the source and target resolve to the same path.</summary>
+        public bool Redundant { get; set; }
+
+        /// <summary>
+        /// Prefer the TryCreate() method to create FileTransfer objects.
+        /// </summary>
+        /// <param name="source">Source path to file.</param>
+        /// <param name="destination">Destination path for file.</param>
+        /// <param name="move">File if file should be moved (optimal).</param>
+        /// <param name="type">Optional type of file this transfer is transferring.</param>
+        /// <param name="sourceLineNumbers">Optional source line numbers wher this transfer originated.</param>
+        public FileTransfer(string source, string destination, bool move, string type = null, SourceLineNumber sourceLineNumbers = null)
+        {
+            this.Source = source;
+            this.Destination = destination;
+            this.Move = move;
+
+            this.Type = type;
+            this.SourceLineNumbers = sourceLineNumbers;
+        }
+
+        /// <summary>
+        /// Creates a file transfer if the source and destination are different.
+        /// </summary>
+        /// <param name="source">Source path to file.</param>
+        /// <param name="destination">Destination path for file.</param>
+        /// <param name="move">File if file should be moved (optimal).</param>
+        /// <param name="type">Optional type of file this transfer is transferring.</param>
+        /// <param name="sourceLineNumbers">Optional source line numbers where this transfer originated.</param>
+        /// <returns>true if the source and destination are the different, false if no file transfer is created.</returns>
+        public static bool TryCreate(string source, string destination, bool move, string type, SourceLineNumber sourceLineNumbers, out FileTransfer transfer)
+        {
+            string sourceFullPath = GetValidatedFullPath(sourceLineNumbers, source);
+
+            string fileLayoutFullPath = GetValidatedFullPath(sourceLineNumbers, destination);
+
+            // if the current source path (where we know that the file already exists) and the resolved
+            // path as dictated by the Directory table are not the same, then propagate the file.  The
+            // image that we create may have already been done by some other process other than the linker, so 
+            // there is no reason to copy the files to the resolved source if they are already there.
+            if (String.Equals(sourceFullPath, fileLayoutFullPath, StringComparison.OrdinalIgnoreCase))
+            {
+                transfer = null;
+                return false;
+            }
+
+            transfer = new FileTransfer(source, destination, move, type, sourceLineNumbers);
+            return true;
+        }
+
+        private static string GetValidatedFullPath(SourceLineNumber sourceLineNumbers, string path)
+        {
+            string result;
+
+            try
+            {
+                result = Path.GetFullPath(path);
+
+                string filename = Path.GetFileName(result);
+
+                foreach (string reservedName in Common.ReservedFileNames)
+                {
+                    if (reservedName.Equals(filename, StringComparison.OrdinalIgnoreCase))
+                    {
+                        throw new WixException(WixDataErrors.InvalidFileName(sourceLineNumbers, path));
+                    }
+                }
+            }
+            catch (System.ArgumentException)
+            {
+                throw new WixException(WixDataErrors.InvalidFileName(sourceLineNumbers, path));
+            }
+            catch (System.IO.PathTooLongException)
+            {
+                throw new WixException(WixDataErrors.PathTooLong(sourceLineNumbers, path));
+            }
+
+            return result;
+        }
+    }
+}
diff --git a/src/WixToolset.Data/BindPath.cs b/src/WixToolset.Data/BindPath.cs
new file mode 100644
index 00000000..823a57c9
--- /dev/null
+++ b/src/WixToolset.Data/BindPath.cs
@@ -0,0 +1,60 @@
+// 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.Data
+{
+    using System;
+    using WixToolset.Data.Bind;
+
+    /// <summary>
+    /// Bind path representation.
+    /// </summary>
+    public class BindPath
+    {
+        /// <summary>
+        /// Creates an unnamed bind path.
+        /// </summary>
+        /// <param name="path">Path for the bind path.</param>
+        public BindPath(string path) : this(String.Empty, path, BindStage.Normal)
+        {
+        }
+
+        /// <summary>
+        /// Creates a named bind path.
+        /// </summary>
+        /// <param name="name">Name of the bind path.</param>
+        /// <param name="path">Path for the bind path.</param>
+        /// <param name="stage">Stage for the bind path.</param>
+        public BindPath(string name, string path, BindStage stage = BindStage.Normal)
+        {
+            this.Name = name;
+            this.Path = path;
+            this.Stage = stage;
+        }
+
+        /// <summary>
+        /// Name of the bind path or String.Empty if the path is unnamed.
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary>
+        /// Path for the bind path.
+        /// </summary>
+        public string Path { get; set; }
+
+        /// <summary>
+        /// Stage for the bind path.
+        /// </summary>
+        public BindStage Stage { get; set; }
+
+        /// <summary>
+        /// Parses a normal bind path from its string representation
+        /// </summary>
+        /// <param name="bindPath">String representation of bind path that looks like: [name=]path</param>
+        /// <returns>Parsed normal bind path.</returns>
+        public static BindPath Parse(string bindPath)
+        {
+            string[] namedPath = bindPath.Split(new char[] { '=' }, 2);
+            return (1 == namedPath.Length) ? new BindPath(namedPath[0]) : new BindPath(namedPath[0], namedPath[1]);
+        }
+    }
+}
diff --git a/src/WixToolset.Data/Common.cs b/src/WixToolset.Data/Common.cs
index f01b4591..8d6ef7b4 100644
--- a/src/WixToolset.Data/Common.cs
+++ b/src/WixToolset.Data/Common.cs
@@ -15,6 +15,8 @@ namespace WixToolset.Data
 
         internal static readonly XNamespace W3SchemaPrefix = "http://www.w3.org/";
 
+        internal 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" };
+
         private static readonly Regex LegalIdentifierCharacters = new Regex(@"^[_A-Za-z][0-9A-Za-z_\.]*$", RegexOptions.Compiled);
 
         internal static string GetFileHash(FileInfo fileInfo)
diff --git a/src/WixToolset.Data/ILibraryBinaryFileResolver.cs b/src/WixToolset.Data/ILibraryBinaryFileResolver.cs
deleted file mode 100644
index b438429c..00000000
--- a/src/WixToolset.Data/ILibraryBinaryFileResolver.cs
+++ /dev/null
@@ -1,9 +0,0 @@
-// 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.Data
-{
-    public interface ILibraryBinaryFileResolver
-    {
-        string Resolve(SourceLineNumber sourceLineNumber, string table, string path);
-    }
-}
diff --git a/src/WixToolset.Data/Identifier.cs b/src/WixToolset.Data/Identifier.cs
new file mode 100644
index 00000000..96acc997
--- /dev/null
+++ b/src/WixToolset.Data/Identifier.cs
@@ -0,0 +1,28 @@
+// 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.Data
+{
+    /// <summary>
+    /// Class to define the identifier and access for a row.
+    /// </summary>
+    public class Identifier
+    {
+        public static Identifier Invalid = new Identifier(null, AccessModifier.Private);
+
+        public Identifier(string id, AccessModifier access)
+        {
+            this.Id = id;
+            this.Access = access;
+        }
+
+        /// <summary>
+        /// Access modifier for a row.
+        /// </summary>
+        public AccessModifier Access { get; }
+
+        /// <summary>
+        /// Identifier for the row.
+        /// </summary>
+        public string Id { get; }
+    }
+}
diff --git a/src/WixToolset.Data/LocalizedControl.cs b/src/WixToolset.Data/LocalizedControl.cs
index 50315b29..979f9fde 100644
--- a/src/WixToolset.Data/LocalizedControl.cs
+++ b/src/WixToolset.Data/LocalizedControl.cs
@@ -18,30 +18,27 @@ namespace WixToolset.Data
             this.Text = text;
         }
 
-        public string Dialog { get; set; }
+        public string Dialog { get; }
 
-        public string Control { get; set; }
+        public string Control { get; }
 
-        public int X { get; private set; }
+        public int X { get; }
 
-        public int Y { get; private set; }
+        public int Y { get; }
 
-        public int Width { get; private set; }
+        public int Width { get; }
 
-        public int Height { get; private set; }
+        public int Height { get; }
 
-        public int Attributes { get; private set; }
+        public int Attributes { get; }
 
-        public string Text { get; private set; }
+        public string Text { get; }
 
         /// <summary>
         /// Get key for a localized control.
         /// </summary>
         /// <returns>The localized control id.</returns>
-        public string GetKey()
-        {
-            return LocalizedControl.GetKey(this.Dialog, this.Control);
-        }
+        public string GetKey() => LocalizedControl.GetKey(this.Dialog, this.Control);
 
         /// <summary>
         /// Get key for a localized control.
@@ -49,9 +46,6 @@ namespace WixToolset.Data
         /// <param name="dialog">The optional id of the control's dialog.</param>
         /// <param name="control">The id of the control.</param>
         /// <returns>The localized control id.</returns>
-        public static string GetKey(string dialog, string control)
-        {
-            return String.Concat(String.IsNullOrEmpty(dialog) ? String.Empty : dialog, "/", String.IsNullOrEmpty(control) ? String.Empty : control);
-        }
+        public static string GetKey(string dialog, string control) => String.Concat(dialog, "/", control);
     }
 }