Improved cabinet handling

7 files changed, 498 insertions, 4 deletions

diff --git a/src/WixToolset.Core.Native/Cabinet.cs b/src/WixToolset.Core.Native/Cabinet.cs
new file mode 100644
index 00000000..27b0ec74
--- /dev/null
+++ b/src/WixToolset.Core.Native/Cabinet.cs
@@ -0,0 +1,199 @@
+// 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.Native
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Linq;
+
+    /// <summary>
+    /// Wrapper class around interop with wixcab.dll to compress files into a cabinet.
+    /// </summary>
+    public sealed class Cabinet
+    {
+        private const string CompressionLevelVariable = "WIX_COMPRESSION_LEVEL";
+        private static readonly char[] TextLineSplitter = new[] { '\t' };
+
+        public Cabinet(string path)
+        {
+            this.Path = path;
+        }
+
+        public string Path { get; }
+
+        /// <summary>
+        /// Creates a cabinet.
+        /// </summary>
+        /// <param name="cabPath">Path of cabinet to create.</param>
+        /// <param name="compressionLevel">Level of compression to apply.</param>
+        /// <param name="maxFiles">Maximum number of files that will be added to cabinet.</param>
+        /// <param name="maxSize">Maximum size of cabinet.</param>
+        /// <param name="maxThresh">Maximum threshold for each cabinet.</param>
+        public void Compress(IEnumerable<CabinetCompressFile> files, CabinetCompressionLevel compressionLevel, int maxSize = 0, int maxThresh = 0)
+        {
+            var compressionLevelVariable = Environment.GetEnvironmentVariable(CompressionLevelVariable);
+
+            // Override authored compression level if environment variable is present.
+            if (!String.IsNullOrEmpty(compressionLevelVariable))
+            {
+                if (!Enum.TryParse(compressionLevelVariable, true, out compressionLevel))
+                {
+                    //throw new WixException(WixErrors.IllegalEnvironmentVariable(CompressionLevelVariable, compressionLevelVariable));
+                    throw new ArgumentException();
+                }
+            }
+
+            var wixnative = new WixNativeExe("smartcab", this.Path, Convert.ToInt32(compressionLevel), files.Count(), maxSize, maxThresh);
+
+            foreach (var file in files)
+            {
+                wixnative.AddStdinLine(file.ToWixNativeStdinLine());
+            }
+
+            wixnative.Run();
+
+#if TOOD_ERROR_HANDLING
+            catch (COMException ce)
+            {
+                // If we get a "the file exists" error, we must have a full temp directory - so report the issue
+                if (0x80070050 == unchecked((uint)ce.ErrorCode))
+                {
+                    throw new WixException(WixErrors.FullTempDirectory("WSC", Path.GetTempPath()));
+                }
+
+                throw;
+            }
+#endif
+        }
+
+        /// <summary>
+        /// Enumerates all files in a cabinet.
+        /// </summary>
+        /// <returns>>List of CabinetFileInfo</returns>
+        public List<CabinetFileInfo> Enumerate()
+        {
+            var wixnative = new WixNativeExe("enumcab", this.Path);
+            var lines = wixnative.Run();
+
+            var fileInfoList = new List<CabinetFileInfo>();
+
+            foreach (var line in lines)
+            {
+                if (String.IsNullOrEmpty(line))
+                {
+                    continue;
+                }
+
+                var data = line.Split(TextLineSplitter, StringSplitOptions.None);
+
+                var size = Convert.ToInt32(data[1]);
+                var date = Convert.ToInt32(data[2]);
+                var time = Convert.ToInt32(data[3]);
+
+                fileInfoList.Add(new CabinetFileInfo(data[0], size, date, time));
+            }
+
+            return fileInfoList;
+        }
+
+        /// <summary>
+        /// Extracts all the files from a cabinet to a directory.
+        /// </summary>
+        /// <param name="outputFolder">Directory to extract files to.</param>
+        public void Extract(string outputFolder)
+        {
+            if (!outputFolder.EndsWith("\\", StringComparison.Ordinal))
+            {
+                outputFolder += "\\";
+            }
+
+            var wixnative = new WixNativeExe("extractcab", this.Path, outputFolder);
+            wixnative.Run();
+        }
+
+#if TOOD_ERROR_HANDLING
+        /// <summary>
+        /// Adds a file to the cabinet with an optional MSI file hash.
+        /// </summary>
+        /// <param name="file">The file to add.</param>
+        /// <param name="token">The token for the file.</param>
+        /// <param name="fileHash">The MSI file hash of the file.</param>
+        //private void AddFile(string file, string token, MsiInterop.MSIFILEHASHINFO fileHash)
+        //{
+        //    try
+        //    {
+        //        NativeMethods.CreateCabAddFile(file, token, fileHash, this.handle);
+        //    }
+        //    catch (COMException ce)
+        //    {
+        //        if (0x80004005 == unchecked((uint)ce.ErrorCode)) // E_FAIL
+        //        {
+        //            throw new WixException(WixErrors.CreateCabAddFileFailed());
+        //        }
+        //        else if (0x80070070 == unchecked((uint)ce.ErrorCode)) // ERROR_DISK_FULL
+        //        {
+        //            throw new WixException(WixErrors.CreateCabInsufficientDiskSpace());
+        //        }
+        //        else
+        //        {
+        //            throw;
+        //        }
+        //    }
+        //    catch (DirectoryNotFoundException)
+        //    {
+        //        throw new WixFileNotFoundException(file);
+        //    }
+        //    catch (FileNotFoundException)
+        //    {
+        //        throw new WixFileNotFoundException(file);
+        //    }
+        //}
+
+        /// <summary>
+        /// Complete/commit the cabinet - this must be called before Dispose so that errors will be
+        /// reported on the same thread.
+        /// </summary>
+        /// <param name="newCabNamesCallBackAddress">Address of Binder's callback function for Cabinet Splitting</param>
+        public void Complete(IntPtr newCabNamesCallBackAddress)
+        {
+            if (IntPtr.Zero != this.handle)
+            {
+                try
+                {
+                    if (newCabNamesCallBackAddress != IntPtr.Zero && this.maxSize != 0)
+                    {
+                        NativeMethods.CreateCabFinish(this.handle, newCabNamesCallBackAddress);
+                    }
+                    else
+                    {
+                        NativeMethods.CreateCabFinish(this.handle, IntPtr.Zero);
+                    }
+
+                    GC.SuppressFinalize(this);
+                    this.disposed = true;
+                }
+                catch (COMException ce)
+                {
+                    //if (0x80004005 == unchecked((uint)ce.ErrorCode)) // E_FAIL
+                    //{
+                    //    // This error seems to happen, among other situations, when cabbing more than 0xFFFF files
+                    //    throw new WixException(WixErrors.FinishCabFailed());
+                    //}
+                    //else if (0x80070070 == unchecked((uint)ce.ErrorCode)) // ERROR_DISK_FULL
+                    //{
+                    //    throw new WixException(WixErrors.CreateCabInsufficientDiskSpace());
+                    //}
+                    //else
+                    //{
+                    //    throw;
+                    //}
+                }
+                finally
+                {
+                    this.handle = IntPtr.Zero;
+                }
+            }
+        }
+#endif
+    }
+}
diff --git a/src/WixToolset.Core.Native/CabinetCompressFile.cs b/src/WixToolset.Core.Native/CabinetCompressFile.cs
new file mode 100644
index 00000000..6778f4a1
--- /dev/null
+++ b/src/WixToolset.Core.Native/CabinetCompressFile.cs
@@ -0,0 +1,65 @@
+// 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.Native
+{
+    /// <summary>
+    /// Information to compress file into a cabinet.
+    /// </summary>
+    public sealed class CabinetCompressFile
+    {
+        /// <summary>
+        /// Cabinet compress file.
+        /// </summary>
+        /// <param name="path">Path to file to add.</param>
+        /// <param name="token">The token for the file.</param>
+        public CabinetCompressFile(string path, string token)
+        {
+            this.Path = path;
+            this.Token = token;
+            this.Hash = null;
+        }
+
+        /// <summary>
+        /// Cabinet compress file.
+        /// </summary>
+        /// <param name="path">Path to file to add.</param>
+        /// <param name="token">The token for the file.</param>
+        /// <param name="hash1">Hash 1</param>
+        /// <param name="hash2">Hash 2</param>
+        /// <param name="hash3">Hash 3</param>
+        /// <param name="hash4">Hash 4</param>
+        public CabinetCompressFile(string path, string token, int hash1, int hash2, int hash3, int hash4)
+        {
+            this.Path = path;
+            this.Token = token;
+            this.Hash = new[] { hash1, hash2, hash3, hash4 };
+        }
+
+        /// <summary>
+        /// Gets the path to the file to compress.
+        /// </summary>
+        public string Path { get; }
+
+        /// <summary>
+        /// Gets the token for the file to compress.
+        /// </summary>
+        public string Token { get; }
+
+        /// <summary>
+        /// Gets the hash of the file to compress.
+        /// </summary>
+        public int[] Hash { get; }
+
+        internal string ToWixNativeStdinLine()
+        {
+            if (this.Hash == null)
+            {
+                return $"{this.Path}\t{this.Token}";
+            }
+            else
+            {
+                return $"{this.Path}\t{this.Token}\t{this.Hash[0]}\t{this.Hash[1]}\t{this.Hash[2]}\t{this.Hash[3]}";
+            }
+        }
+    }
+}
diff --git a/src/WixToolset.Core.Native/CabinetCompressionLevel.cs b/src/WixToolset.Core.Native/CabinetCompressionLevel.cs
new file mode 100644
index 00000000..fce1ff41
--- /dev/null
+++ b/src/WixToolset.Core.Native/CabinetCompressionLevel.cs
@@ -0,0 +1,25 @@
+// 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.Native
+{
+    /// <summary>
+    /// Compression level to use when creating cabinet.
+    /// </summary>
+    public enum CabinetCompressionLevel
+    {
+        /// <summary>Use no compression.</summary>
+        None,
+
+        /// <summary>Use low compression.</summary>
+        Low,
+
+        /// <summary>Use medium compression.</summary>
+        Medium,
+
+        /// <summary>Use high compression.</summary>
+        High,
+
+        /// <summary>Use ms-zip compression.</summary>
+        Mszip
+    }
+}
\ No newline at end of file
diff --git a/src/WixToolset.Core.Native/CabinetFileInfo.cs b/src/WixToolset.Core.Native/CabinetFileInfo.cs
new file mode 100644
index 00000000..ea229121
--- /dev/null
+++ b/src/WixToolset.Core.Native/CabinetFileInfo.cs
@@ -0,0 +1,67 @@
+// 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.Native
+{
+    using System;
+
+    /// <summary>
+    /// Properties of a file in a cabinet.
+    /// </summary>
+    public sealed class CabinetFileInfo
+    {
+        /// <summary>
+        /// Constructs CabinetFileInfo
+        /// </summary>
+        /// <param name="fileId">File Id</param>
+        /// <param name="size">Size of file</param>
+        /// <param name="date">Last modified date</param>
+        /// <param name="time">Last modified time</param>
+        public CabinetFileInfo(string fileId, int size, int date, int time)
+        {
+            this.FileId = fileId;
+            this.Size = size;
+            this.Date = date;
+            this.Time = time;
+        }
+
+        /// <summary>
+        /// Gets the file Id of the file.
+        /// </summary>
+        /// <value>file Id</value>
+        public string FileId { get; }
+
+        /// <summary>
+        /// Gets modified date (DOS format).
+        /// </summary>
+        public int Date { get; }
+
+        /// <summary>
+        /// Gets modified time (DOS format).
+        /// </summary>
+        public int Time { get; }
+
+        /// <summary>
+        /// Gets the size of the file in bytes.
+        /// </summary>
+        public int Size { get; }
+
+        /// <summary>
+        /// Compares this file info's date and time with another datetime.
+        /// </summary>
+        /// <param name="dateTime">Date and time to compare with/</param>
+        /// <returns>
+        /// For some reason DateTime.ToLocalTime() does not match kernel32.dll FileTimeToLocalFileTime().
+        /// Since cabinets store date and time with the kernel32.dll functions, we need to convert DateTime
+        /// to local file time using the kernel32.dll functions.
+        /// </returns>
+        public bool SameAsDateTime(DateTime dateTime)
+        {
+            long filetime = dateTime.ToFileTime();
+            long localTime = 0;
+            NativeMethods.FileTimeToLocalFileTime(ref filetime, ref localTime);
+            NativeMethods.FileTimeToDosDateTime(ref localTime, out var cabDate, out var cabTime);
+
+            return this.Date == cabDate && this.Time == cabTime;
+        }
+    }
+}
diff --git a/src/WixToolset.Core.Native/WixNativeExe.cs b/src/WixToolset.Core.Native/WixNativeExe.cs
new file mode 100644
index 00000000..8626bea3
--- /dev/null
+++ b/src/WixToolset.Core.Native/WixNativeExe.cs
@@ -0,0 +1,115 @@
+// 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.Native
+{
+    using System;
+    using System.Collections.Generic;
+    using System.ComponentModel;
+    using System.Diagnostics;
+    using System.IO;
+    using System.Reflection;
+
+    internal class WixNativeExe
+    {
+        private const int FiveMinutesInMilliseconds = 300000;
+        private static readonly string PathToWixNativeExe;
+
+        private readonly string commandLine;
+        private readonly List<string> stdinLines = new List<string>();
+
+        static WixNativeExe()
+        {
+            PathToWixNativeExe = Path.Combine(Path.GetDirectoryName(new Uri(Assembly.GetExecutingAssembly().CodeBase).LocalPath), "x86\\wixnative.exe");
+        }
+
+        public WixNativeExe(params object[] args)
+        {
+            this.commandLine = String.Join(" ", QuoteArgumentsAsNecesary(args));
+        }
+
+        public void AddStdinLine(string line)
+        {
+            this.stdinLines.Add(line);
+        }
+
+        public void AddStdinLines(IEnumerable<string> lines)
+        {
+            this.stdinLines.AddRange(lines);
+        }
+
+        public IEnumerable<string> Run()
+        {
+            var wixNativeInfo = new ProcessStartInfo(PathToWixNativeExe, this.commandLine)
+            {
+                RedirectStandardInput = true,
+                RedirectStandardOutput = true,
+                CreateNoWindow = true,
+                ErrorDialog = false,
+                UseShellExecute = false
+            };
+
+            var stdoutLines = new List<string>();
+
+            using (var process = Process.Start(wixNativeInfo))
+            {
+                process.OutputDataReceived += (s, a) => stdoutLines.Add(a.Data);
+                process.BeginOutputReadLine();
+
+                if (this.stdinLines.Count > 0)
+                {
+                    foreach (var line in this.stdinLines)
+                    {
+                        process.StandardInput.WriteLine(line);
+                    }
+
+                    // Trailing blank line indicates stdin complete.
+                    process.StandardInput.WriteLine();
+                }
+
+                if (process.WaitForExit(FiveMinutesInMilliseconds))
+                {
+                    // If the process successfully exits documentation says we need to wait again
+                    // without a timeout to ensure that all of the redirected output is captured.
+                    //
+                    process.WaitForExit();
+                }
+
+                if (process.ExitCode != 0)
+                {
+                    throw new Win32Exception(process.ExitCode);
+                }
+            }
+
+            return stdoutLines;
+        }
+
+        private static IEnumerable<string> QuoteArgumentsAsNecesary(object[] args)
+        {
+            foreach (var arg in args)
+            {
+                if (arg is string str)
+                {
+                    if (String.IsNullOrEmpty(str))
+                    {
+                    }
+                    else if (str.Contains(" ") && !str.StartsWith("\""))
+                    {
+                        yield return $"\"{str}\"";
+                    }
+                    else
+                    {
+                        yield return str;
+                    }
+                }
+                else if (arg is int i)
+                {
+                    yield return i.ToString();
+                }
+                else
+                {
+                    throw new ArgumentException(nameof(args));
+                }
+            }
+        }
+    }
+}
diff --git a/src/WixToolset.Core.Native/WixToolset.Core.Native.csproj b/src/WixToolset.Core.Native/WixToolset.Core.Native.csproj
index 3e66d84e..aa87186b 100644
--- a/src/WixToolset.Core.Native/WixToolset.Core.Native.csproj
+++ b/src/WixToolset.Core.Native/WixToolset.Core.Native.csproj
@@ -3,6 +3,7 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <NuspecFile>$(MSBuildThisFileName).nuspec</NuspecFile>
+    <Description>Core Native</Description>
     <!-- <BeforePack>SetNuspecProperties</BeforePack> -->
   </PropertyGroup>
 
@@ -10,9 +11,26 @@
     <PackageReference Include="Nerdbank.GitVersioning" Version="2.0.41" PrivateAssets="all" />
   </ItemGroup>
 
-  <!-- <ItemGroup>
-    <ProjectReference Include="..\winterop\winterop.vcxproj" ExcludeAssets="All" />
-  </ItemGroup> -->
+  <Target Name="BuildWixNative"
+          BeforeTargets="GetCopyToOutputDirectoryItems">
+    <MSBuild Projects="..\wixnative\wixnative.vcxproj" Properties="Platform=Win32" />
+    <MSBuild Projects="..\wixnative\wixnative.vcxproj" Properties="Platform=x64" />
+
+    <ItemGroup>
+      <NativeProjectOutput Include="$(OutputPath)..\Win32\*.exe;$(OutputPath)..\Win32\*.pdb">
+        <TargetRelativeFolder>x86\</TargetRelativeFolder>
+      </NativeProjectOutput>
+      <NativeProjectOutput Include="$(OutputPath)..\x64\*.exe;$(OutputPath)..\x64\*.pdb">
+        <TargetRelativeFolder>x64\</TargetRelativeFolder>
+      </NativeProjectOutput>
+
+      <AllItemsFullPathWithTargetPath Include="@(NativeProjectOutput->'%(FullPath)')">
+        <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+        <TargetPath>%(TargetRelativeFolder)%(Filename)%(Extension)</TargetPath>
+      </AllItemsFullPathWithTargetPath>
+    </ItemGroup>
+  </Target>
+
   <Target Name="SetNuspecProperties"
           AfterTargets="Build">
     <PropertyGroup>
diff --git a/src/WixToolset.Core.Native/WixToolset.Core.Native.nuspec b/src/WixToolset.Core.Native/WixToolset.Core.Native.nuspec
index 68d154c8..6a96167e 100644
--- a/src/WixToolset.Core.Native/WixToolset.Core.Native.nuspec
+++ b/src/WixToolset.Core.Native/WixToolset.Core.Native.nuspec
@@ -10,15 +10,20 @@
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <description>$description$</description>
     <copyright>$copyright$</copyright>
-
+<!--
     <dependencies>
       <dependency id="runtime.win-x86.WixToolset.Core.Native" version="$version$" />
       <dependency id="runtime.win-x64.WixToolset.Core.Native" version="$version$" />
     </dependencies>
+     -->
   </metadata>
 
   <files>
     <file src="$id$.dll" target="lib\netstandard2.0" />
     <file src="$id$.pdb" target="lib\netstandard2.0" />
+    <file src="..\Win32\wixnative.exe" target="lib\netstandard2.0\x86" />
+    <file src="..\Win32\wixnative.pdb" target="lib\netstandard2.0\x86" />
+    <file src="..\x64\wixnative.exe" target="lib\netstandard2.0\x64" />
+    <file src="..\x64\wixnative.pdb" target="lib\netstandard2.0\x64" />
   </files>
 </package>