Merge pull request #1028 from twpol/feature/use-native-compression

Replace all compression code with System.IO.Compression

Author: cjakeman

Source/Launcher/Program.cs

@@ -116,8 +116,6 @@ static void CheckOR(List<string> missingFiles, string path)
                 // Required libraries:
                 "GNU.Gettext.dll",
                 "GNU.Gettext.WinForms.dll",
-                "ICSharpCode.SharpZipLib.dll",
-                "DotNetZip.dll",
                 @"Native/X86/OpenAL32.dll",
                 @"Native/X64/OpenAL32.dll",
                 // Programs:
@@ -142,4 +140,4 @@ static int SafeReadKey(RegistryKey key, string name, int defaultValue)
             }
         }
     }
-}
+}

Source/Menu/ImportExportSaveForm.cs

@@ -19,7 +19,7 @@
 using System.Diagnostics;
 using System.Drawing;
 using System.IO;
-using System.IO.Packaging;  // Needs Project > Add reference > .NET > Component name = WindowsBase
+using System.IO.Compression;
 using System.Windows.Forms;
 using GNU.Gettext;
 using GNU.Gettext.WinForms;
@@ -69,8 +69,6 @@ private void bExport_Click(object sender, EventArgs e)
             // Create a Zip-compatible file/compressed folder containing:
             // all files with the same stem (i.e. *.save, *.png, *.replay, *.txt)
 
-            // For Zip, see http://weblogs.asp.net/jgalloway/archive/2007/10/25/creating-zip-archives-in-net-without-an-external-library-like-sharpziplib.aspx
-
             // Copy files to new package in folder save_packs
 			var fullFilePath = Path.Combine(UserSettings.UserDataFolder, Save.File);
             var toFile = Path.GetFileNameWithoutExtension(Save.File) + "." + SavePackFileExtension;
@@ -117,56 +115,35 @@ void UpdateFileList(string message)
 
         static void AddFileToZip(string zipFilename, string fileToAdd)
         {
-            using (var zip = Package.Open(zipFilename, FileMode.OpenOrCreate))
+            using (var zip = ZipFile.Open(zipFilename, ZipArchiveMode.Update))
             {
-                var destFilename = @".\" + Path.GetFileName(fileToAdd);
-                var uri = PackUriHelper.CreatePartUri(new Uri(destFilename, UriKind.Relative));
-                if (zip.PartExists(uri))
-                {
-                    zip.DeletePart(uri);
-                }
-                var part = zip.CreatePart(uri, "", CompressionOption.Normal);
-                using (var source = new FileStream(fileToAdd, FileMode.Open, FileAccess.Read))
-                {
-                    using (var destination = part.GetStream())
-                    {
-                        CopyStream(source, destination);
-                    }
-                }
+                zip.CreateEntryFromFile(fileToAdd, Path.GetFileName(fileToAdd), CompressionLevel.Optimal);
             }
         }
 
-
         static void ExtractFilesFromZip(string zipFilename, string path)
         {
-            using (var zip = Package.Open(zipFilename, FileMode.Open, FileAccess.Read))
+            using (var zip = ZipFile.OpenRead(zipFilename))
             {
-                foreach (var part in zip.GetParts())
+                foreach (var part in zip.Entries)
                 {
-                    var fileName = Path.Combine(path, part.Uri.ToString().TrimStart('/').Replace("%20", " "));
-                    try
-                    {
-                        using (var destination = new FileStream(fileName, FileMode.Create))
+                    // Older save packs have an extra root file we don't need
+                    if (part.FullName == "[Content_Types].xml") continue;
+
+                    // Older save packs have percent-encoded paths
+                    var fileName = Path.GetFullPath(Path.Combine(path, part.FullName.Replace("%20", " ")));
+
+                    try {
+                        if (Path.GetFileName(fileName).Length > 0)
                         {
-                            using (var source = part.GetStream())
-                            {
-                                CopyStream(source, destination);
-                            }
+                            Directory.CreateDirectory(Path.GetDirectoryName(fileName));
+                            part.ExtractToFile(fileName, true);
                         }
                     }
                     catch { } // Ignore attempts to copy to a destination file locked by another process as
                     // ResumeForm locks PNG of selected save.
                 }
             }
         }
-
-        static void CopyStream(Stream source, Stream target)
-        {
-            const int bufferSize = 0x1000;
-            var buffer = new byte[bufferSize];
-            var bytesRead = 0;
-            while ((bytesRead = source.Read(buffer, 0, bufferSize)) > 0)
-                target.Write(buffer, 0, bytesRead);
-        }
     }
 }

Source/Menu/Menu.csproj

@@ -32,8 +32,8 @@
     </Reference>
     <Reference Include="PresentationFramework" />
     <Reference Include="System.DirectoryServices" />
+    <Reference Include="System.IO.Compression" />
     <Reference Include="System.Net.Http" />
-    <Reference Include="WindowsBase" />
   </ItemGroup>
   <ItemGroup>
     <Compile Update="KeyInputControl.cs">

Source/Orts.Parsers.Msts/Orts.Parsers.Msts.csproj

@@ -19,6 +19,5 @@
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
     <PackageReference Include="MonoGame.Framework.WindowsDX" Version="3.8.0.1641" />
-    <PackageReference Include="SharpZipLib" Version="1.4.1" />
   </ItemGroup>
 </Project>

Source/Orts.Parsers.Msts/SBR.cs

@@ -15,12 +15,12 @@
 // You should have received a copy of the GNU General Public License
 // along with Open Rails.  If not, see <http://www.gnu.org/licenses/>.
 
-using ICSharpCode.SharpZipLib.Zip.Compression.Streams;
 using Microsoft.Xna.Framework;
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
+using System.IO.Compression;
 using System.Text;
 
 namespace Orts.Parsers.Msts
@@ -60,7 +60,9 @@ public static SBR Open(string filename)
             // SIMISA@@  means uncompressed
             if (headerString.StartsWith("SIMISA@F"))
             {
-                fb = new InflaterInputStream(fb);
+                // Skip over the 2 byte zlib header and onto the DEFLATE stream itself
+                fb.Read(buffer, 16, 2);
+                fb = new DeflateStream(fb, CompressionMode.Decompress);
             }
             else if (headerString.StartsWith("\r\nSIMISA"))
             {

Source/Orts.Updater/Orts.Updater.csproj

@@ -16,14 +16,14 @@
     <DocumentationFile>..\..\Program\Orts.Updater.xml</DocumentationFile>
   </PropertyGroup>
   <ItemGroup>
+    <Reference Include="System.IO.Compression" />
     <Reference Include="System.Security" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\Orts.Common\Orts.Common.csproj" />
     <ProjectReference Include="..\Orts.Settings\Orts.Settings.csproj" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="DotNetZip" Version="1.16.0" />
     <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.355802">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>

Source/Orts.Updater/UpdateManager.cs

@@ -15,7 +15,6 @@
 // You should have received a copy of the GNU General Public License
 // along with Open Rails.  If not, see <http://www.gnu.org/licenses/>.
 
-using Ionic.Zip;
 using Newtonsoft.Json;
 using ORTS.Common;
 using ORTS.Settings;
@@ -24,6 +23,7 @@
 using System.ComponentModel;
 using System.Diagnostics;
 using System.IO;
+using System.IO.Compression;
 using System.Linq;
 using System.Net;
 using System.Runtime.InteropServices;
@@ -413,14 +413,22 @@ void DownloadUpdate(int progressMin, int progressLength)
 
         void ExtractUpdate(int progressMin, int progressLength)
         {
-            using (var zip = ZipFile.Read(FileUpdateStage))
+            using (var zip = ZipFile.OpenRead(FileUpdateStage))
             {
-                zip.ExtractProgress += (object sender, ExtractProgressEventArgs e) =>
+                for (var index = 0; index < zip.Entries.Count; index++)
                 {
-                    if (e.EventType == ZipProgressEventType.Extracting_BeforeExtractEntry)
-                        TriggerApplyProgressChanged(progressMin + progressLength * e.EntriesExtracted / e.EntriesTotal);
-                };
-                zip.ExtractAll(PathUpdateStage, ExtractExistingFileAction.OverwriteSilently);
+                    TriggerApplyProgressChanged(progressMin + progressLength * index / zip.Entries.Count);
+
+                    var absolutePath = Path.GetFullPath(Path.Combine(PathUpdateStage, zip.Entries[index].FullName));
+                    if (!absolutePath.StartsWith(PathUpdateStage))
+                        throw new IOException("Invalid update: attempting to extract outside staging area");
+
+                    if (Path.GetFileName(absolutePath).Length > 0)
+                    {
+                        Directory.CreateDirectory(Path.GetDirectoryName(absolutePath));
+                        zip.Entries[index].ExtractToFile(absolutePath, true);
+                    }
+                }
             }
 
             File.Delete(FileUpdateStage);