Fix too long path for unpacking. Checking path length on Windows

Author: Jakub Szczyrk

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

@@ -0,0 +1,31 @@
+using System.Collections.Generic;
+
+namespace PatchKit.Unity.Patcher.AppData.Local
+{
+    public class MapHashExtractedFiles
+    {
+        private static Dictionary<string, string> MapHash = new Dictionary<string, string>();
+
+        public static void Clear()
+        {
+            MapHash.Clear();
+        }
+        
+        public static string Add(string path)
+        {
+            string nameHash = HashCalculator.ComputeMD5Hash(path);
+            MapHash.Add(path, nameHash);
+            return nameHash;
+        }
+
+        public static bool TryGetHash(string path,out string nameHash)
+        {
+            if (MapHash.TryGetValue(path, out nameHash))
+            {
+                return true;
+            }
+
+            return false;
+        }
+    }
+}

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

@@ -34,13 +34,7 @@ public static Pack1Meta ParseFromFile(string filename)
         public static Pack1Meta Parse(string content)
         {
             DebugLogger.Log(content);
-            Pack1Meta pack = JsonConvert.DeserializeObject<Pack1Meta>(content);
-            foreach (var fileEntry in pack.Files)
-            {
-                fileEntry.Hash = HashCalculator.ComputeMD5Hash(fileEntry.Name);
-            }
-
-            return pack;
+            return JsonConvert.DeserializeObject<Pack1Meta>(content);
         }
         #endregion
 
@@ -51,8 +45,6 @@ public class FileEntry
         {
             public string Name { get; set; }
 
-            public string Hash { get; set; }
-
             public string Type { get; set; }
 
             public string Target { get; set; }

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

@@ -199,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, file.Hash);
+            string destPath = Path.Combine(_destinationDirPath, MapHashExtractedFiles.Add(file.Name));
 
             DebugLogger.Log("Creating directory " + destPath);
             DirectoryOperations.CreateDirectory(destPath, cancellationToken);
@@ -208,7 +208,7 @@ private void UnpackDirectory(Pack1Meta.FileEntry file, CancellationToken cancell
 
         private void UnpackSymlink(Pack1Meta.FileEntry file)
         {
-            string destPath = Path.Combine(_destinationDirPath, file.Hash);
+            string destPath = Path.Combine(_destinationDirPath, MapHashExtractedFiles.Add(file.Name));
             DebugLogger.Log("Creating symlink: " + destPath);
             // TODO: how to create a symlink?
         }
@@ -230,7 +230,8 @@ 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, file.Hash + _suffix);
+            string destPath = Path.Combine(destinationDirPath == null ? _destinationDirPath : destinationDirPath, MapHashExtractedFiles.Add(file.Name) + _suffix);
+
             DebugLogger.LogFormat("Unpacking regular file {0} to {1}", file, destPath);
 
             if (file.Size == null)
@@ -285,8 +286,7 @@ private void UnpackRegularFile(Pack1Meta.FileEntry file, Action<double> onProgre
                     }
                 }
             }
-            //Rename
-            //File.Move(destPath, finePath);
+
             DebugLogger.Log("File " + file.Name + " unpacked successfully!");
         }
 

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

@@ -1,4 +1,5 @@
-using Ionic.Zip;
+using System.IO;
+using Ionic.Zip;
 using PatchKit.Unity.Patcher.Debug;
 using PatchKit.Unity.Patcher.Cancellation;
 
@@ -69,8 +70,13 @@ public void Unarchive(CancellationToken cancellationToken)
         private void UnarchiveEntry(ZipEntry zipEntry)
         {
             DebugLogger.Log(string.Format("Unarchiving entry {0}", zipEntry.FileName));
-
-            zipEntry.Extract(_destinationDirPath, ExtractExistingFileAction.OverwriteSilently);
+            MemoryStream memoryStream = new MemoryStream();
+            string destPath = Path.Combine(_destinationDirPath, HashCalculator.ComputeMD5Hash(zipEntry.FileName));
+            zipEntry.Extract(memoryStream);
+            using (var target = new FileStream(destPath, FileMode.Create))
+            {
+                memoryStream.WriteTo(target);
+            }
         }
 
         protected virtual void OnUnarchiveProgressChanged(string name, bool isFile, int entry, int amount, double entryProgress)

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

@@ -53,6 +53,12 @@ public void Update(CancellationToken cancellationToken)
 
             DebugLogger.LogVariable(latestVersionId, "latestVersionId");
 
+#if UNITY_STANDALONE_WIN
+            var checkPathLengthCommand = commandFactory.CreateCheckPathLengthCommandForContent(latestVersionId, _context, cancellationToken);
+            checkPathLengthCommand.Prepare(_status, cancellationToken);
+            checkPathLengthCommand.Execute(cancellationToken);
+#endif
+            
             var checkDiskSpaceCommand = commandFactory.CreateCheckDiskSpaceCommandForContent(latestVersionId, _context, cancellationToken);
             checkDiskSpaceCommand.Prepare(_status, cancellationToken);
             checkDiskSpaceCommand.Execute(cancellationToken);

Assets/PatchKit Patcher/Scripts/AppUpdater/AppUpdaterContentStrategy.cs

@@ -68,6 +68,12 @@ public void Update(CancellationToken cancellationToken)
             geolocateCommand.Prepare(_status, cancellationToken);
             geolocateCommand.Execute(cancellationToken);
 
+#if UNITY_STANDALONE_WIN
+            var checkPathLengthCommand = commandFactory.CreateCheckPathLengthCommandForDiff(latestVersionId, _context, cancellationToken);
+            checkPathLengthCommand.Prepare(_status, cancellationToken);
+            checkPathLengthCommand.Execute(cancellationToken);
+#endif
+            
             var checkDiskSpaceCommand = commandFactory.CreateCheckDiskSpaceCommandForDiff(latestVersionId, _context, cancellationToken);
             checkDiskSpaceCommand.Prepare(_status, cancellationToken);
             checkDiskSpaceCommand.Execute(cancellationToken);

Assets/PatchKit Patcher/Scripts/AppUpdater/AppUpdaterDiffStrategy.cs

@@ -133,5 +133,17 @@ public IGeolocateCommand CreateGeolocateCommand()
             var geolocateCommand = new GeolocateCommand();
             return geolocateCommand;
         }
+        
+        public ICheckPathLengthCommand CreateCheckPathLengthCommandForDiff(int versionId, AppUpdaterContext context, CancellationToken cancellationToken)
+        {
+            AppDiffSummary diffSummary = context.App.RemoteMetaData.GetDiffSummary(versionId, cancellationToken);
+            return new CheckPathLengthCommand(diffSummary, context.App.LocalDirectory.Path);
+        }
+
+        public ICheckPathLengthCommand CreateCheckPathLengthCommandForContent(int versionId, AppUpdaterContext context, CancellationToken cancellationToken)
+        {
+            AppContentSummary contentSummary = context.App.RemoteMetaData.GetContentSummary(versionId, cancellationToken);
+            return new CheckPathLengthCommand(contentSummary, context.App.LocalDirectory.Path);
+        }
     }
 }

Assets/PatchKit Patcher/Scripts/AppUpdater/Commands/AppUpdaterCommandFactory.cs

@@ -0,0 +1,92 @@
+using System.IO;
+using PatchKit.Api.Models.Main;
+using PatchKit.Unity.Patcher.AppUpdater.Status;
+using PatchKit.Unity.Patcher.Cancellation;
+using PatchKit.Unity.Patcher.Debug;
+
+
+namespace PatchKit.Unity.Patcher.AppUpdater.Commands
+{
+    public class CheckPathLengthCommand : ICheckPathLengthCommand
+    {
+        private static readonly DebugLogger DebugLogger = new DebugLogger(typeof(CheckPathLengthCommand));
+
+        private readonly AppContentSummary? _contentSummary;
+        private readonly AppDiffSummary? _diffSummary;
+        private readonly string _localDirectoryPath;
+        private OperationStatus _status;
+
+        public CheckPathLengthCommand(AppContentSummary contentSummary, string localDirectoryPath)
+        {
+            Checks.ArgumentNotNull(localDirectoryPath, "localDirectoryPath");
+
+            _contentSummary = contentSummary;
+            _localDirectoryPath = localDirectoryPath;
+        }
+
+        public CheckPathLengthCommand(AppDiffSummary diffSummary, string localDirectoryPath)
+        {
+            Checks.ArgumentNotNull(localDirectoryPath, "localDirectoryPath");
+
+            _diffSummary = diffSummary;
+            _localDirectoryPath = localDirectoryPath;
+        }
+   
+        public void Execute(CancellationToken cancellationToken)
+        {
+            _status.IsActive.Value = true;
+            _status.IsIdle.Value = true;
+
+            try
+            {
+                string pathFile;
+                if (UseContentSummary())
+                {
+                    foreach (AppContentSummaryFile contentSummaryFile in _contentSummary.Value.Files)
+                    {
+                        pathFile = Path.Combine(_localDirectoryPath, contentSummaryFile.Path);
+                        
+                        if (pathFile.Length > 259)
+                        {
+                            throw new FilePathTooLongException(string.Format(
+                                "Cannot install file {0}, the destination path length has exceeded Windows path length limit (260).",
+                                pathFile));
+                        }
+                    }
+                }
+                else
+                {
+                    foreach (string contentSummaryFile in _diffSummary.Value.AddedFiles)
+                    {
+                        pathFile = Path.Combine(_localDirectoryPath, contentSummaryFile);
+                        if (pathFile.Length > 259)
+                        {
+                            throw new FilePathTooLongException(string.Format(
+                                "Cannot install file {0}, the destination path length has exceeded Windows path length limit (260).",
+                                pathFile));
+                        }
+                    }
+                }
+            }
+            finally
+            {
+                _status.IsActive.Value = false;
+            }
+        }
+        
+        private bool UseContentSummary()
+        {
+            return _contentSummary != null;
+        }
+        
+        public void Prepare(UpdaterStatus status, CancellationToken cancellationToken)
+        {
+            _status = new OperationStatus
+            {
+                Weight = {Value = 0.00001},
+                Description = {Value = "Check path length..."}
+            };
+            status.RegisterOperation(_status);
+        }
+    }
+}