bugfix/v3.17.x.x/repairing-progress-bar-for-unarchive-package (#187)

* Added progress bytes for files. Chnaged mapHashExtractedFiles - always can get hash

* Added progress bytes for modified files

* Changed lib for pack1 unpackage

* Added checking the size of downloaded files when checking size of disk

* Changed copy to move files for added files in diff

* Refactoring size of files for modified files and unarchive package in diff

* Refactoring

* Added skipping downloading a package if it is all downloaded

* Refactoring checking the size of downloaded files when checking size of disk

* Refactoring

* Update changelog and version

* Refactoring, remove HashExtractedFile

* Refactoring

Co-authored-by: Jakub Szczyrk <Jakub Szczyrk>

Author: Szczyrk

Assets/Editor/Tests/Pack1UnarchiverTest.cs

@@ -30,9 +30,8 @@ public void Unpack()
         string metaPath = TestFixtures.GetFilePath("pack1/test.pack1.meta");
         string metaString = File.ReadAllText(metaPath);
         Pack1Meta meta = Pack1Meta.Parse(metaString);
-
-        MapHashExtractedFiles mapHashExtractedFiles = new MapHashExtractedFiles();
-        var pack1Unarchiver = new Pack1Unarchiver(archivePath, meta, _tempDir, mapHashExtractedFiles, Key);
+        
+        var pack1Unarchiver = new Pack1Unarchiver(archivePath, meta, _tempDir, Key);
         pack1Unarchiver.Unarchive(new CancellationToken());
 
         Assert.True(Directory.Exists(Path.Combine(_tempDir, "dir")));

Assets/Editor/Tests/UnarchiverTest.cs

@@ -53,8 +53,7 @@ private void CheckConsistency(string sourceDirPath, string dirPath)
     [Test]
     public void Unarchive()
     {
-        MapHashExtractedFiles mapHashExtractedFiles = new MapHashExtractedFiles();
-        var unarchiver = new ZipUnarchiver(TestFixtures.GetFilePath("unarchiver-test/zip.zip"), _dirPath, mapHashExtractedFiles);
+        var unarchiver = new ZipUnarchiver(TestFixtures.GetFilePath("unarchiver-test/zip.zip"), _dirPath);
 
         unarchiver.Unarchive(CancellationToken.Empty);
 
@@ -64,8 +63,7 @@ public void Unarchive()
     [Test]
     public void CancelUnarchive()
     {
-        MapHashExtractedFiles mapHashExtractedFiles = new MapHashExtractedFiles();
-        var unarchiver = new ZipUnarchiver(TestFixtures.GetFilePath("unarchiver-test/zip.zip"), _dirPath, mapHashExtractedFiles);
+        var unarchiver = new ZipUnarchiver(TestFixtures.GetFilePath("unarchiver-test/zip.zip"), _dirPath);
 
         CancellationTokenSource source = new CancellationTokenSource();
         source.Cancel();
@@ -76,8 +74,7 @@ public void CancelUnarchive()
     [Test]
     public void UnarchiveCorruptedArchive()
     {
-        MapHashExtractedFiles mapHashExtractedFiles = new MapHashExtractedFiles();
-        var unarchiver = new ZipUnarchiver(TestFixtures.GetFilePath("unarchiver-test/corrupted-zip.zip"), _dirPath, mapHashExtractedFiles);
+        var unarchiver = new ZipUnarchiver(TestFixtures.GetFilePath("unarchiver-test/corrupted-zip.zip"), _dirPath);
 
         Assert.That(() => unarchiver.Unarchive(CancellationToken.Empty), Throws.Exception);
     }
@@ -86,9 +83,8 @@ public void UnarchiveCorruptedArchive()
     public void UnarchiveWithPassword()
     {
         string password = "\x08\x07\x18\x24" + "123==";
-
-        MapHashExtractedFiles mapHashExtractedFiles = new MapHashExtractedFiles();
-        var unarchiver = new ZipUnarchiver(TestFixtures.GetFilePath("unarchiver-test/password-zip.zip"), _dirPath, mapHashExtractedFiles, password);
+        
+        var unarchiver = new ZipUnarchiver(TestFixtures.GetFilePath("unarchiver-test/password-zip.zip"), _dirPath, password);
 
         unarchiver.Unarchive(CancellationToken.Empty);
 
@@ -98,8 +94,7 @@ public void UnarchiveWithPassword()
     [Test]
     public void ProgressReporting()
     {
-        MapHashExtractedFiles mapHashExtractedFiles = new MapHashExtractedFiles();
-        var unarchiver = new ZipUnarchiver(TestFixtures.GetFilePath("unarchiver-test/zip.zip"), _dirPath, mapHashExtractedFiles);
+        var unarchiver = new ZipUnarchiver(TestFixtures.GetFilePath("unarchiver-test/zip.zip"), _dirPath);
 
         int? lastAmount = null;
         int? lastEntry = null;

Assets/PatchKit Patcher/Scripts/AppData/FileSystem/FileOperations.cs

@@ -159,5 +159,16 @@ private static void MoveInternal(string sourceFilePath, string destinationFilePa
                 throw;
             }
         }
+
+        public static long GetSizeFile(string filePath)
+        {
+            if (string.IsNullOrEmpty(filePath))
+            {
+                return 0;
+            }
+            
+            FileInfo fInfo = new FileInfo(filePath);
+            return fInfo.Exists ? fInfo.Length : 0;
+        }
     }
 }

Assets/PatchKit Patcher/Scripts/AppData/Local/MapHashExtractedFiles.cs

@@ -2,7 +2,7 @@
 using System.IO;
 using System.Security.Cryptography;
 using System.Text;
-using Ionic.Zlib;
+using System.IO.Compression;
 using PatchKit.Network;
 using PatchKit.Unity.Patcher.AppData.FileSystem;
 using PatchKit.Unity.Patcher.Cancellation;
@@ -40,9 +40,7 @@ public class Pack1Unarchiver : IUnarchiver
         /// The range (in bytes) of the partial pack1 source file
         /// </summary>
         private readonly BytesRange _range;
-
-        private MapHashExtractedFiles _mapHashExtractedFiles;
-
+        
         public event UnarchiveProgressChangedHandler UnarchiveProgressChanged;
 
         // set to true to continue unpacking on error. Check HasErrors later to see if there are any
@@ -51,24 +49,23 @@ public class Pack1Unarchiver : IUnarchiver
         // After Unarchive() finishes if this set to true, there were unpacking errors.
         public bool HasErrors { get; private set; }
 
-        public Pack1Unarchiver(string packagePath, Pack1Meta metaData, string destinationDirPath, MapHashExtractedFiles mapHashExtractedFiles, string key, string suffix = "")
-            : this(packagePath, metaData, destinationDirPath, mapHashExtractedFiles, Encoding.ASCII.GetBytes(key), suffix, new BytesRange(0, -1))
+        public Pack1Unarchiver(string packagePath, Pack1Meta metaData, string destinationDirPath, string key, string suffix = "")
+            : this(packagePath, metaData, destinationDirPath, Encoding.ASCII.GetBytes(key), suffix, new BytesRange(0, -1))
         {
             // do nothing
         }
 
-        public Pack1Unarchiver(string packagePath, Pack1Meta metaData, string destinationDirPath, MapHashExtractedFiles mapHashExtractedFiles, string key, string suffix, BytesRange range)
-            : this(packagePath, metaData, destinationDirPath, mapHashExtractedFiles, Encoding.ASCII.GetBytes(key), suffix, range)
+        public Pack1Unarchiver(string packagePath, Pack1Meta metaData, string destinationDirPath, string key, string suffix, BytesRange range)
+            : this(packagePath, metaData, destinationDirPath, Encoding.ASCII.GetBytes(key), suffix, range)
         {
             // do nothing
         }
 
-        private Pack1Unarchiver(string packagePath, Pack1Meta metaData, string destinationDirPath, MapHashExtractedFiles mapHashExtractedFiles, byte[] key, string suffix, BytesRange range)
+        private Pack1Unarchiver(string packagePath, Pack1Meta metaData, string destinationDirPath, byte[] key, string suffix, BytesRange range)
         {
             Checks.ArgumentFileExists(packagePath, "packagePath");
             Checks.ArgumentDirectoryExists(destinationDirPath, "destinationDirPath");
             Checks.ArgumentNotNull(suffix, "suffix");
-            Checks.ArgumentNotNull(mapHashExtractedFiles, "mapHashExtractedFiles");
 
             if (range.Start == 0)
             {
@@ -85,7 +82,6 @@ private Pack1Unarchiver(string packagePath, Pack1Meta metaData, string destinati
             _destinationDirPath = destinationDirPath;
             _suffix = suffix;
             _range = range;
-            _mapHashExtractedFiles = mapHashExtractedFiles;
 
             using (var sha256 = SHA256.Create())
             {
@@ -203,7 +199,7 @@ private void Unpack(Pack1Meta.FileEntry file, Action<double> progress, Cancellat
 
         private void UnpackDirectory(Pack1Meta.FileEntry file, CancellationToken cancellationToken)
         {
-            string destPath = Path.Combine(_destinationDirPath, _mapHashExtractedFiles.Add(file.Name));
+            string destPath = Path.Combine(_destinationDirPath, HashCalculator.ComputeMD5Hash(file.Name));
 
             DebugLogger.Log("Creating directory " + destPath);
             DirectoryOperations.CreateDirectory(destPath, cancellationToken);
@@ -212,7 +208,7 @@ private void UnpackDirectory(Pack1Meta.FileEntry file, CancellationToken cancell
 
         private void UnpackSymlink(Pack1Meta.FileEntry file)
         {
-            string destPath = Path.Combine(_destinationDirPath, _mapHashExtractedFiles.Add(file.Name));
+            string destPath = Path.Combine(_destinationDirPath, HashCalculator.ComputeMD5Hash(file.Name));
             DebugLogger.Log("Creating symlink: " + destPath);
             // TODO: how to create a symlink?
         }
@@ -234,7 +230,7 @@ private DecompressorCreator ResolveDecompressor(Pack1Meta meta)
 
         private void UnpackRegularFile(Pack1Meta.FileEntry file, Action<double> onProgress, CancellationToken cancellationToken, string destinationDirPath = null)
         {
-            string destPath = Path.Combine(destinationDirPath == null ? _destinationDirPath : destinationDirPath, _mapHashExtractedFiles.Add(file.Name) + _suffix);
+            string destPath = Path.Combine(destinationDirPath == null ? _destinationDirPath : destinationDirPath, HashCalculator.ComputeMD5Hash(file.Name) + _suffix);
 
             DebugLogger.LogFormat("Unpacking regular file {0} to {1}", file, destPath);
 

Assets/PatchKit Patcher/Scripts/AppData/Local/MapHashExtractedFiles.cs.meta

@@ -17,7 +17,6 @@ public class ZipUnarchiver : IUnarchiver
         private readonly string _password;
 
         private bool _unarchiveHasBeenCalled;
-        private MapHashExtractedFiles _mapHashExtractedFiles;
 
         public event UnarchiveProgressChangedHandler UnarchiveProgressChanged;
 
@@ -27,11 +26,10 @@ public class ZipUnarchiver : IUnarchiver
         // not used
         public bool HasErrors { get; private set; }
 
-        public ZipUnarchiver(string packagePath, string destinationDirPath, MapHashExtractedFiles mapHashExtractedFiles, string password = null)
+        public ZipUnarchiver(string packagePath, string destinationDirPath, string password = null)
         {
             Checks.ArgumentFileExists(packagePath, "packagePath");
             Checks.ArgumentDirectoryExists(destinationDirPath, "destinationDirPath");
-            Checks.ArgumentNotNull(mapHashExtractedFiles, "mapHashExtractedFiles");
 
             DebugLogger.LogConstructor();
             DebugLogger.LogVariable(packagePath, "packagePath");
@@ -40,7 +38,6 @@ public ZipUnarchiver(string packagePath, string destinationDirPath, MapHashExtra
             _packagePath = packagePath;
             _destinationDirPath = destinationDirPath;
             _password = password;
-            _mapHashExtractedFiles = mapHashExtractedFiles;
         }
 
         public void Unarchive(CancellationToken cancellationToken)
@@ -73,7 +70,7 @@ public void Unarchive(CancellationToken cancellationToken)
         private void UnarchiveEntry(ZipEntry zipEntry)
         {
             DebugLogger.Log(string.Format("Unarchiving entry {0}", zipEntry.FileName));
-            string destPath = Path.Combine(_destinationDirPath, _mapHashExtractedFiles.Add(zipEntry.FileName));
+            string destPath = Path.Combine(_destinationDirPath, HashCalculator.ComputeMD5Hash(zipEntry.FileName));
             using (var target = new FileStream(destPath, FileMode.Create))
             {
                 zipEntry.Extract(target);