Refactoring

Jakub Szczyrk · Jakub Szczyrk · commit 6ed13cf76a90 · 2021-04-22T15:43:46.000+02:00
diff --git a/Assets/PatchKit Patcher/Scripts/AppData/Local/MapHashExtractedFiles.cs b/Assets/PatchKit Patcher/Scripts/AppData/Local/MapHashExtractedFiles.cs
@@ -4,21 +4,28 @@ namespace PatchKit.Unity.Patcher.AppData.Local
 {
     public class MapHashExtractedFiles
     {
-        private static Dictionary<string, string> MapHash = new Dictionary<string, string>();
+        private Dictionary<string, string> MapHash = new Dictionary<string, string>();
+        private static MapHashExtractedFiles _instance = new MapHashExtractedFiles();
 
-        public static void Clear()
+        public static MapHashExtractedFiles Instance
+        {
+            get { return _instance; }
+        }
+
+
+        public void Clear()
         {
             MapHash.Clear();
         }
         
-        public static string Add(string path)
+        public string Add(string path)
         {
             string nameHash = HashCalculator.ComputeMD5Hash(path);
             MapHash.Add(path, nameHash);
             return nameHash;
         }
 
-        public static bool TryGetHash(string path,out string nameHash)
+        public bool TryGetHash(string path,out string nameHash)
         {
             if (MapHash.TryGetValue(path, out nameHash))
             {
diff --git a/Assets/PatchKit Patcher/Scripts/AppData/Local/Pack1Unarchiver.cs b/Assets/PatchKit Patcher/Scripts/AppData/Local/Pack1Unarchiver.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, MapHashExtractedFiles.Add(file.Name));
+            string destPath = Path.Combine(_destinationDirPath, MapHashExtractedFiles.Instance.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, MapHashExtractedFiles.Add(file.Name));
+            string destPath = Path.Combine(_destinationDirPath, MapHashExtractedFiles.Instance.Add(file.Name));
             DebugLogger.Log("Creating symlink: " + destPath);
             // TODO: how to create a symlink?
         }
@@ -230,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, MapHashExtractedFiles.Instance.Add(file.Name) + _suffix);
 
             DebugLogger.LogFormat("Unpacking regular file {0} to {1}", file, destPath);
 
diff --git a/Assets/PatchKit Patcher/Scripts/AppData/Local/ZipUnarchiver.cs b/Assets/PatchKit Patcher/Scripts/AppData/Local/ZipUnarchiver.cs
@@ -71,7 +71,7 @@ private void UnarchiveEntry(ZipEntry zipEntry)
         {
             DebugLogger.Log(string.Format("Unarchiving entry {0}", zipEntry.FileName));
             MemoryStream memoryStream = new MemoryStream();
-            string destPath = Path.Combine(_destinationDirPath, HashCalculator.ComputeMD5Hash(zipEntry.FileName));
+            string destPath = Path.Combine(_destinationDirPath, MapHashExtractedFiles.Instance.Add(zipEntry.FileName));
             zipEntry.Extract(memoryStream);
             using (var target = new FileStream(destPath, FileMode.Create))
             {
diff --git a/Assets/PatchKit Patcher/Scripts/AppUpdater/AppUpdaterContentStrategy.cs b/Assets/PatchKit Patcher/Scripts/AppUpdater/AppUpdaterContentStrategy.cs
@@ -54,7 +54,7 @@ public void Update(CancellationToken cancellationToken)
             DebugLogger.LogVariable(latestVersionId, "latestVersionId");
 
 #if UNITY_STANDALONE_WIN
-            var checkPathLengthCommand = commandFactory.CreateCheckPathLengthCommandForContent(latestVersionId, _context, cancellationToken);
+            var checkPathLengthCommand = commandFactory.CreateCheckPathLengthCommand(latestVersionId, _context, cancellationToken);
             checkPathLengthCommand.Prepare(_status, cancellationToken);
             checkPathLengthCommand.Execute(cancellationToken);
 #endif
diff --git a/Assets/PatchKit Patcher/Scripts/AppUpdater/AppUpdaterDiffStrategy.cs b/Assets/PatchKit Patcher/Scripts/AppUpdater/AppUpdaterDiffStrategy.cs
@@ -69,7 +69,7 @@ public void Update(CancellationToken cancellationToken)
             geolocateCommand.Execute(cancellationToken);
 
 #if UNITY_STANDALONE_WIN
-            var checkPathLengthCommand = commandFactory.CreateCheckPathLengthCommandForDiff(latestVersionId, _context, cancellationToken);
+            var checkPathLengthCommand = commandFactory.CreateCheckPathLengthCommand(latestVersionId, _context, cancellationToken);
             checkPathLengthCommand.Prepare(_status, cancellationToken);
             checkPathLengthCommand.Execute(cancellationToken);
 #endif
diff --git a/Assets/PatchKit Patcher/Scripts/AppUpdater/Commands/AppUpdaterCommandFactory.cs b/Assets/PatchKit Patcher/Scripts/AppUpdater/Commands/AppUpdaterCommandFactory.cs
@@ -134,13 +134,7 @@ public IGeolocateCommand CreateGeolocateCommand()
             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)
+        public ICheckPathLengthCommand CreateCheckPathLengthCommand(int versionId, AppUpdaterContext context, CancellationToken cancellationToken)
         {
             AppContentSummary contentSummary = context.App.RemoteMetaData.GetContentSummary(versionId, cancellationToken);
             return new CheckPathLengthCommand(contentSummary, context.App.LocalDirectory.Path);
diff --git a/Assets/PatchKit Patcher/Scripts/AppUpdater/Commands/CheckPathLengthCommand.cs b/Assets/PatchKit Patcher/Scripts/AppUpdater/Commands/CheckPathLengthCommand.cs
@@ -12,7 +12,6 @@ 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;
 
@@ -24,14 +23,6 @@ public CheckPathLengthCommand(AppContentSummary contentSummary, string localDire
             _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;
@@ -40,31 +31,15 @@ public void Execute(CancellationToken cancellationToken)
             try
             {
                 string pathFile;
-                if (UseContentSummary())
+                foreach (AppContentSummaryFile contentSummaryFile in _contentSummary.Value.Files)
                 {
-                    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.Path);
+
+                    if (pathFile.Length > 259)
                     {
-                        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));
-                        }
+                        throw new FilePathTooLongException(string.Format(
+                            "Cannot install file {0}, the destination path length has exceeded Windows path length limit (260).",
+                            pathFile));
                     }
                 }
             }
@@ -73,12 +48,7 @@ public void Execute(CancellationToken cancellationToken)
                 _status.IsActive.Value = false;
             }
         }
-        
-        private bool UseContentSummary()
-        {
-            return _contentSummary != null;
-        }
-        
+
         public void Prepare(UpdaterStatus status, CancellationToken cancellationToken)
         {
             _status = new OperationStatus
diff --git a/Assets/PatchKit Patcher/Scripts/AppUpdater/Commands/InstallContentCommand.cs b/Assets/PatchKit Patcher/Scripts/AppUpdater/Commands/InstallContentCommand.cs
@@ -83,7 +83,7 @@ public override void Execute(CancellationToken cancellationToken)
             Checks.FileExists(_packagePath);
             Assert.IsTrue(_localMetaData.GetRegisteredEntries().Length == 0,
                 "Cannot install content if previous version is still present.");
-            MapHashExtractedFiles.Clear();
+            MapHashExtractedFiles.Instance.Clear();
             
             if (_versionContentSummary.CompressionMethod == "pack1")
             {
@@ -138,14 +138,13 @@ public override void Execute(CancellationToken cancellationToken)
                 for (int i = 0; i < _versionContentSummary.Files.Length; i++)
                 {
                     cancellationToken.ThrowIfCancellationRequested();
-                    string pathFile = _versionContentSummary.Files[i].Path;
+                    string filePath = _versionContentSummary.Files[i].Path;
                     string nameHash;
-                    if (MapHashExtractedFiles.TryGetHash(pathFile, out nameHash))
+                    if (MapHashExtractedFiles.Instance.TryGetHash(filePath, out nameHash))
                     {
-                        var sourceFile = new SourceFile(pathFile, packageDir.Path, usedSuffix, nameHash);
+                        var sourceFile = new SourceFile(filePath, packageDir.Path, usedSuffix, nameHash);
 
-                        if (unarchiver.HasErrors && !sourceFile.Exists()
-                        ) // allow unexistent file only if does not have errors
+                        if (unarchiver.HasErrors && !sourceFile.Exists()) // allow unexistent file only if does not have errors
                         {
                             DebugLogger.LogWarning(
                                 "Skipping unexisting file because I've been expecting unpacking errors: " +
@@ -216,23 +215,23 @@ private void InstallFile(SourceFile sourceFile, CancellationToken cancellationTo
         struct SourceFile
         {
             public string Name { get; private set; }
-            public string Hash { get; private set; }
+            public string HashName { get; private set; }
             private string _suffix;
             private string _root;
 
-            public string FullHashPath { get { return Path.Combine(_root, Hash + _suffix); } }
+            public string FullHashPath { get { return Path.Combine(_root, HashName + _suffix); } }
 
-            public SourceFile(string name, string root, string suffix, string hash)
+            public SourceFile(string name, string root, string suffix, string hashName)
             {
                 Assert.IsNotNull(name);
                 Assert.IsNotNull(root);
                 Assert.IsNotNull(suffix);
-                Assert.IsNotNull(hash);
+                Assert.IsNotNull(hashName);
                 
                 Name = name;
                 _root = root;
                 _suffix = suffix;
-                Hash = hash;
+                HashName = hashName;
             }
 
             public bool Exists()
diff --git a/Assets/PatchKit Patcher/Scripts/AppUpdater/Commands/InstallDiffCommand.cs b/Assets/PatchKit Patcher/Scripts/AppUpdater/Commands/InstallDiffCommand.cs
@@ -147,7 +147,7 @@ public override void Execute(CancellationToken cancellationToken)
                 _logger.LogDebug("Installing diff...");
 
                 base.Execute(cancellationToken);
-                MapHashExtractedFiles.Clear();
+                MapHashExtractedFiles.Instance.Clear();
                 
                 _logger.LogTrace("diffSummary.compressionMethod = " + _diffSummary.CompressionMethod);
 
@@ -471,7 +471,7 @@ private void AddFile(string fileName, string packageDirPath, string suffix, Canc
             }
 #endif
             string nameHash;
-            if (MapHashExtractedFiles.TryGetHash(fileName, out nameHash))
+            if (MapHashExtractedFiles.Instance.TryGetHash(fileName, out nameHash))
             {
                 var sourceFilePath = Path.Combine(packageDirPath, nameHash + suffix);
                 _logger.LogTrace("sourceFilePath = " + sourceFilePath);
diff --git a/Assets/PatchKit Patcher/Scripts/AppUpdater/Commands/RepairFilesCommand.cs b/Assets/PatchKit Patcher/Scripts/AppUpdater/Commands/RepairFilesCommand.cs
@@ -65,7 +65,7 @@ public RepairFilesCommand(
         public override void Execute(CancellationToken cancellationToken)
         {
             base.Execute(cancellationToken);
-            MapHashExtractedFiles.Clear();
+            MapHashExtractedFiles.Instance.Clear();
             
             foreach (var entry in _entries)
             {
@@ -127,7 +127,7 @@ public override void Execute(CancellationToken cancellationToken)
 
                     unarchiver.UnarchiveSingleFile(entry, cancellationToken);
                     string nameHash;
-                    if (MapHashExtractedFiles.TryGetHash(entry.Name, out nameHash))
+                    if (MapHashExtractedFiles.Instance.TryGetHash(entry.Name, out nameHash))
                     {
                         EmplaceFile(Path.Combine(unarchivePath, nameHash + _unpackingSuffix),
                             Path.Combine(_localData.Path, entry.Name), cancellationToken);
diff --git a/Assets/PatchKit Patcher/Scripts/Patcher.cs b/Assets/PatchKit Patcher/Scripts/Patcher.cs
@@ -940,7 +940,7 @@ private void ThreadUpdateApp(bool automatically, CancellationToken cancellationT
 
                     _updaterStatus.Value = null;
                     _updateAppCancellationTokenSource = null;
-                    MapHashExtractedFiles.Clear();
+                    MapHashExtractedFiles.Instance.Clear();
                 }
             }
         }

Original file line number	Diff line number	Diff line change
`@@ -4,21 +4,28 @@ namespace PatchKit.Unity.Patcher.AppData.Local`
`4`	`4`	`{`
`5`	`5`	`public class MapHashExtractedFiles`
`6`	`6`	`{`
`7`		`- private static Dictionary<string, string> MapHash = new Dictionary<string, string>();`
	`7`	`+ private Dictionary<string, string> MapHash = new Dictionary<string, string>();`
	`8`	`+ private static MapHashExtractedFiles _instance = new MapHashExtractedFiles();`
`8`	`9`
`9`		`- public static void Clear()`
	`10`	`+ public static MapHashExtractedFiles Instance`
	`11`	`+ {`
	`12`	`+ get { return _instance; }`
	`13`	`+ }`
	`14`	`+`
	`15`	`+`
	`16`	`+ public void Clear()`
`10`	`17`	`{`
`11`	`18`	`MapHash.Clear();`
`12`	`19`	`}`
`13`	`20`
`14`		`- public static string Add(string path)`
	`21`	`+ public string Add(string path)`
`15`	`22`	`{`
`16`	`23`	`string nameHash = HashCalculator.ComputeMD5Hash(path);`
`17`	`24`	`MapHash.Add(path, nameHash);`
`18`	`25`	`return nameHash;`
`19`	`26`	`}`
`20`	`27`
`21`		`- public static bool TryGetHash(string path,out string nameHash)`
	`28`	`+ public bool TryGetHash(string path,out string nameHash)`
`22`	`29`	`{`
`23`	`30`	`if (MapHash.TryGetValue(path, out nameHash))`
`24`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -199,7 +199,7 @@ private void Unpack(Pack1Meta.FileEntry file, Action<double> progress, Cancellat`
`199`	`199`
`200`	`200`	`private void UnpackDirectory(Pack1Meta.FileEntry file, CancellationToken cancellationToken)`
`201`	`201`	`{`
`202`		`- string destPath = Path.Combine(_destinationDirPath, MapHashExtractedFiles.Add(file.Name));`
	`202`	`+ string destPath = Path.Combine(_destinationDirPath, MapHashExtractedFiles.Instance.Add(file.Name));`
`203`	`203`
`204`	`204`	`DebugLogger.Log("Creating directory " + destPath);`
`205`	`205`	`DirectoryOperations.CreateDirectory(destPath, cancellationToken);`
`@@ -208,7 +208,7 @@ private void UnpackDirectory(Pack1Meta.FileEntry file, CancellationToken cancell`
`208`	`208`
`209`	`209`	`private void UnpackSymlink(Pack1Meta.FileEntry file)`
`210`	`210`	`{`
`211`		`- string destPath = Path.Combine(_destinationDirPath, MapHashExtractedFiles.Add(file.Name));`
	`211`	`+ string destPath = Path.Combine(_destinationDirPath, MapHashExtractedFiles.Instance.Add(file.Name));`
`212`	`212`	`DebugLogger.Log("Creating symlink: " + destPath);`
`213`	`213`	`// TODO: how to create a symlink?`
`214`	`214`	`}`
`@@ -230,7 +230,7 @@ private DecompressorCreator ResolveDecompressor(Pack1Meta meta)`
`230`	`230`
`231`	`231`	`private void UnpackRegularFile(Pack1Meta.FileEntry file, Action<double> onProgress, CancellationToken cancellationToken, string destinationDirPath = null)`
`232`	`232`	`{`
`233`		`- string destPath = Path.Combine(destinationDirPath == null ? _destinationDirPath : destinationDirPath, MapHashExtractedFiles.Add(file.Name) + _suffix);`
	`233`	`+ string destPath = Path.Combine(destinationDirPath == null ? _destinationDirPath : destinationDirPath, MapHashExtractedFiles.Instance.Add(file.Name) + _suffix);`
`234`	`234`
`235`	`235`	`DebugLogger.LogFormat("Unpacking regular file {0} to {1}", file, destPath);`
`236`	`236`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ private void UnarchiveEntry(ZipEntry zipEntry)`
`71`	`71`	`{`
`72`	`72`	`DebugLogger.Log(string.Format("Unarchiving entry {0}", zipEntry.FileName));`
`73`	`73`	`MemoryStream memoryStream = new MemoryStream();`
`74`		`- string destPath = Path.Combine(_destinationDirPath, HashCalculator.ComputeMD5Hash(zipEntry.FileName));`
	`74`	`+ string destPath = Path.Combine(_destinationDirPath, MapHashExtractedFiles.Instance.Add(zipEntry.FileName));`
`75`	`75`	`zipEntry.Extract(memoryStream);`
`76`	`76`	`using (var target = new FileStream(destPath, FileMode.Create))`
`77`	`77`	`{`
Original file line number	Diff line number	Diff line change
`@@ -134,13 +134,7 @@ public IGeolocateCommand CreateGeolocateCommand()`
`134`	`134`	`return geolocateCommand;`
`135`	`135`	`}`
`136`	`136`
`137`		`- public ICheckPathLengthCommand CreateCheckPathLengthCommandForDiff(int versionId, AppUpdaterContext context, CancellationToken cancellationToken)`
`138`		`- {`
`139`		`- AppDiffSummary diffSummary = context.App.RemoteMetaData.GetDiffSummary(versionId, cancellationToken);`
`140`		`- return new CheckPathLengthCommand(diffSummary, context.App.LocalDirectory.Path);`
`141`		`- }`
`142`		`-`
`143`		`- public ICheckPathLengthCommand CreateCheckPathLengthCommandForContent(int versionId, AppUpdaterContext context, CancellationToken cancellationToken)`
	`137`	`+ public ICheckPathLengthCommand CreateCheckPathLengthCommand(int versionId, AppUpdaterContext context, CancellationToken cancellationToken)`
`144`	`138`	`{`
`145`	`139`	`AppContentSummary contentSummary = context.App.RemoteMetaData.GetContentSummary(versionId, cancellationToken);`
`146`	`140`	`return new CheckPathLengthCommand(contentSummary, context.App.LocalDirectory.Path);`
Original file line number	Diff line number	Diff line change
`@@ -147,7 +147,7 @@ public override void Execute(CancellationToken cancellationToken)`
`147`	`147`	`_logger.LogDebug("Installing diff...");`
`148`	`148`
`149`	`149`	`base.Execute(cancellationToken);`
`150`		`- MapHashExtractedFiles.Clear();`
	`150`	`+ MapHashExtractedFiles.Instance.Clear();`
`151`	`151`
`152`	`152`	`_logger.LogTrace("diffSummary.compressionMethod = " + _diffSummary.CompressionMethod);`
`153`	`153`
`@@ -471,7 +471,7 @@ private void AddFile(string fileName, string packageDirPath, string suffix, Canc`
`471`	`471`	`}`
`472`	`472`	`#endif`
`473`	`473`	`string nameHash;`
`474`		`- if (MapHashExtractedFiles.TryGetHash(fileName, out nameHash))`
	`474`	`+ if (MapHashExtractedFiles.Instance.TryGetHash(fileName, out nameHash))`
`475`	`475`	`{`
`476`	`476`	`var sourceFilePath = Path.Combine(packageDirPath, nameHash + suffix);`
`477`	`477`	`_logger.LogTrace("sourceFilePath = " + sourceFilePath);`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public RepairFilesCommand(`
`65`	`65`	`public override void Execute(CancellationToken cancellationToken)`
`66`	`66`	`{`
`67`	`67`	`base.Execute(cancellationToken);`
`68`		`- MapHashExtractedFiles.Clear();`
	`68`	`+ MapHashExtractedFiles.Instance.Clear();`
`69`	`69`
`70`	`70`	`foreach (var entry in _entries)`
`71`	`71`	`{`
`@@ -127,7 +127,7 @@ public override void Execute(CancellationToken cancellationToken)`
`127`	`127`
`128`	`128`	`unarchiver.UnarchiveSingleFile(entry, cancellationToken);`
`129`	`129`	`string nameHash;`
`130`		`- if (MapHashExtractedFiles.TryGetHash(entry.Name, out nameHash))`
	`130`	`+ if (MapHashExtractedFiles.Instance.TryGetHash(entry.Name, out nameHash))`
`131`	`131`	`{`
`132`	`132`	`EmplaceFile(Path.Combine(unarchivePath, nameHash + _unpackingSuffix),`
`133`	`133`	`Path.Combine(_localData.Path, entry.Name), cancellationToken);`