Merge #4462 Use temp dir in instance for mod file transactions

Author: HebaruSan

CHANGELOG.md

@@ -26,6 +26,7 @@ All notable changes to this project will be documented in this file.
 - [ConsoleUI] Recommendations of full changeset in ConsoleUI (#4416 by: HebaruSan)
 - [GUI] Fix GUI exceptions for module not in available modules list (#4431 by: HebaruSan)
 - [Core] Don't clone with symlinks on Linux (#4441 by: HebaruSan)
+- [Core] Use temp dir in instance for mod file transactions (#4462 by: HebaruSan)
 
 ### Internal
 

Core/CKAN-core.csproj

@@ -52,7 +52,7 @@
     <PackageReference Include="System.ComponentModel.Annotations" Version="5.0.0" />
     <PackageReference Include="Autofac" Version="4.9.4" />
     <PackageReference Include="SharpZipLib" Version="1.3.3" />
-    <PackageReference Include="TxFileManager.NETStandard" Version="2.0.0" />
+    <PackageReference Include="TxFileManager" Version="1.5.0.1" />
     <PackageReference Include="log4net" Version="2.0.15" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageReference Include="NJsonSchema" Version="10.9.0" />

Core/GameInstance.cs

@@ -7,7 +7,7 @@
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 
-using ChinhDo.Transactions.FileManager;
+using ChinhDo.Transactions;
 using log4net;
 using Newtonsoft.Json;
 
@@ -73,7 +73,7 @@ private void SetupCkanDirectories()
             log.InfoFormat("Initialising {0}", CkanDir);
 
             // TxFileManager knows if we are in a transaction
-            TxFileManager txFileMgr = new TxFileManager();
+            var txFileMgr = new TxFileManager(CkanDir);
 
             if (!Directory.Exists(CkanDir))
             {

Core/GameInstanceManager.cs

@@ -6,7 +6,7 @@
 using System.Diagnostics.CodeAnalysis;
 
 using Autofac;
-using ChinhDo.Transactions.FileManager;
+using ChinhDo.Transactions;
 using log4net;
 
 using CKAN.IO;
@@ -305,7 +305,7 @@ public void CloneInstance(GameInstance existingInstance,
         public GameInstance FakeInstance(IGame game, string newName, string newPath, GameVersion version,
                                          Dictionary<IDlcDetector, GameVersion>? dlcs = null)
         {
-            TxFileManager fileMgr = new TxFileManager();
+            var txFileMgr = new TxFileManager();
             using (TransactionScope transaction = CkanTransaction.CreateTransactionScope())
             {
                 if (HasInstance(newName))
@@ -326,13 +326,13 @@ public GameInstance FakeInstance(IGame game, string newName, string newPath, Gam
                 log.DebugFormat("Creating folder structure and text files at {0} for {1} version {2}", Path.GetFullPath(newPath), game.ShortName, version.ToString());
 
                 // Create a game root directory, containing a GameData folder, a buildID.txt/buildID64.txt and a readme.txt
-                fileMgr.CreateDirectory(newPath);
-                fileMgr.CreateDirectory(Path.Combine(newPath, game.PrimaryModDirectoryRelative));
+                txFileMgr.CreateDirectory(newPath);
+                txFileMgr.CreateDirectory(Path.Combine(newPath, game.PrimaryModDirectoryRelative));
                 game.RebuildSubdirectories(newPath);
 
                 foreach (var anchor in game.InstanceAnchorFiles)
                 {
-                    fileMgr.WriteAllText(Path.Combine(newPath, anchor),
+                    txFileMgr.WriteAllText(Path.Combine(newPath, anchor),
                                          version.WithoutBuild.ToString());
                 }
 
@@ -341,13 +341,13 @@ public GameInstance FakeInstance(IGame game, string newName, string newPath, Gam
                 {
                     foreach (var b in KspBuildIdVersionProvider.buildIDfilenames)
                     {
-                        fileMgr.WriteAllText(Path.Combine(newPath, b),
+                        txFileMgr.WriteAllText(Path.Combine(newPath, b),
                                              string.Format("build id = {0}", version.Build));
                     }
                 }
 
                 // Create the readme.txt WITHOUT build number
-                fileMgr.WriteAllText(Path.Combine(newPath, "readme.txt"),
+                txFileMgr.WriteAllText(Path.Combine(newPath, "readme.txt"),
                                      string.Format("Version {0}",
                                                    version.WithoutBuild.ToString()));
 
@@ -367,8 +367,8 @@ public GameInstance FakeInstance(IGame game, string newName, string newPath, Gam
                         }
 
                         string dlcDir = Path.Combine(newPath, dlcDetector.InstallPath());
-                        fileMgr.CreateDirectory(dlcDir);
-                        fileMgr.WriteAllText(
+                        txFileMgr.CreateDirectory(dlcDir);
+                        txFileMgr.WriteAllText(
                             Path.Combine(dlcDir, "readme.txt"),
                             string.Format("Version {0}", dlcVersion));
                     }

Core/IO/DirectoryLink.cs

@@ -6,7 +6,7 @@
 using System.Text;
 using Microsoft.Win32.SafeHandles;
 
-using ChinhDo.Transactions.FileManager;
+using ChinhDo.Transactions;
 
 namespace CKAN.IO
 {

Core/IO/HardLink.cs

@@ -8,7 +8,7 @@
 using FILETIME = System.Runtime.InteropServices.ComTypes.FILETIME;
 using FileMode = System.IO.FileMode;
 
-using ChinhDo.Transactions.FileManager;
+using ChinhDo.Transactions;
 using log4net;
 
 namespace CKAN.IO
@@ -44,16 +44,16 @@ public static void Create(string target, string linkPath)
         /// </summary>
         /// <param name="target">The original file</param>
         /// <param name="linkPath">The place where we want to make a link or copy</param>
-        /// <param name="file_transaction">Transaction in case we need to roll back</param>
+        /// <param name="txFileMgr">Transaction in case we need to roll back</param>
         public static void CreateOrCopy(string        target,
                                         string        linkPath,
-                                        TxFileManager file_transaction)
+                                        TxFileManager txFileMgr)
         {
             log.DebugFormat("Creating hard link or copy from {0} to {1}...", target, linkPath);
             if (!CreateImpl(target, linkPath))
             {
                 // If we can't create a hard link (e.g., if the paths are on separate volumes), copy instead
-                file_transaction.Copy(target, linkPath, false);
+                txFileMgr.Copy(target, linkPath, false);
             }
         }
 

Core/IO/InstalledFilesDeduplicator.cs

@@ -3,7 +3,7 @@
 using System.Linq;
 using System.IO;
 
-using ChinhDo.Transactions.FileManager;
+using ChinhDo.Transactions;
 using log4net;
 
 using CKAN.Versioning;
@@ -136,13 +136,13 @@ public void DeduplicateAll(IUser user)
                     log.DebugFormat("Deduplicating all...");
                     using (var tx = CkanTransaction.CreateTransactionScope())
                     {
-                        var file_transaction = new TxFileManager();
+                        var txFileMgr = new TxFileManager();
                         foreach (var grp in fileGroups)
                         {
                             var target = grp.First();
                             foreach (var linkPath in grp.Skip(1))
                             {
-                                file_transaction.Delete(linkPath);
+                                txFileMgr.Delete(linkPath);
                                 // If this fails (e.g., if the files are on different volumes), it throws,
                                 // the transaction is aborted, and all changes are reverted.
                                 HardLink.Create(target, linkPath);
@@ -183,19 +183,19 @@ public void DeduplicateAll(IUser user)
 
         public static void CreateOrCopy(FileInfo      target,
                                         string        linkPath,
-                                        TxFileManager file_transaction)
+                                        TxFileManager txFileMgr)
         {
             if (target.Length >= MinDedupFileSize)
             {
                 // If >=128KiB, try making a hard link, then fall back to copying if it fails
                 log.DebugFormat("Creating a hard link from {0} to {1}...", target, linkPath);
-                HardLink.CreateOrCopy(target.FullName, linkPath, file_transaction);
+                HardLink.CreateOrCopy(target.FullName, linkPath, txFileMgr);
             }
             else
             {
                 // If <128KiB, just copy the file
                 log.DebugFormat("Copying from {0} to {1}...", target, linkPath);
-                file_transaction.Copy(target.FullName, linkPath, false);
+                txFileMgr.Copy(target.FullName, linkPath, false);
             }
         }
 

Core/IO/ModuleInstaller.cs

@@ -7,7 +7,7 @@
 using ICSharpCode.SharpZipLib.Core;
 using ICSharpCode.SharpZipLib.Zip;
 using log4net;
-using ChinhDo.Transactions.FileManager;
+using ChinhDo.Transactions;
 
 using CKAN.Extensions;
 using CKAN.Versioning;
@@ -32,12 +32,13 @@ public ModuleInstaller(GameInstance      inst,
                                IUser             user,
                                CancellationToken cancelToken = default)
         {
-            User        = user;
-            this.cache  = cache;
-            this.config = config;
-            instance    = inst;
+            log.DebugFormat("Creating ModuleInstaller for {0}", inst.GameDir);
+            instance         = inst;
+            // Make a transaction file manager that uses a temp dir in the instance's CKAN dir
+            this.cache       = cache;
+            this.config      = config;
+            User             = user;
             this.cancelToken = cancelToken;
-            log.DebugFormat("Creating ModuleInstaller for {0}", instance.GameDir);
         }
 
         public IUser User { get; set; }
@@ -394,9 +395,9 @@ private List<string> InstallModule(CkanModule
                             // Delete the manually installed DLL transaction-style because we believe we'll be replacing it
                             var toDelete = instance.ToAbsoluteGameDir(dll);
                             log.DebugFormat("Deleting manually installed DLL {0}", toDelete);
-                            TxFileManager file_transaction = new TxFileManager();
-                            file_transaction.Snapshot(toDelete);
-                            file_transaction.Delete(toDelete);
+                            var txFileMgr = new TxFileManager(instance.CkanDir);
+                            txFileMgr.Snapshot(toDelete);
+                            txFileMgr.Delete(toDelete);
                         }
                     }
 
@@ -543,13 +544,13 @@ private static bool StreamsEqual(Stream s1, Stream s2)
         /// fails at a later stage.
         /// </summary>
         /// <param name="files">The files to overwrite</param>
-        private static void DeleteConflictingFiles(IEnumerable<InstallableFile> files)
+        private void DeleteConflictingFiles(IEnumerable<InstallableFile> files)
         {
-            TxFileManager file_transaction = new TxFileManager();
+            var txFileMgr = new TxFileManager(instance.CkanDir);
             foreach (InstallableFile file in files)
             {
                 log.DebugFormat("Trying to delete {0}", file.destination);
-                file_transaction.Delete(file.destination);
+                txFileMgr.Delete(file.destination);
             }
         }
 
@@ -695,6 +696,16 @@ public static List<InstallableFile> FindInstallableFiles(CkanModule   module,
 
         #endregion
 
+        private string? InstallFile(ZipFile          zipfile,
+                                    ZipEntry         entry,
+                                    string           fullPath,
+                                    bool             makeDirs,
+                                    string[]         candidateDuplicates,
+                                    IProgress<long>? progress)
+            => InstallFile(zipfile, entry, fullPath, makeDirs,
+                           new TxFileManager(instance.CkanDir),
+                           candidateDuplicates, progress);
+
         /// <summary>
         /// Copy the entry from the opened zipfile to the path specified.
         /// </summary>
@@ -707,11 +718,10 @@ public static List<InstallableFile> FindInstallableFiles(CkanModule   module,
                                             ZipEntry         entry,
                                             string           fullPath,
                                             bool             makeDirs,
+                                            IFileManager     txFileMgr,
                                             string[]         candidateDuplicates,
                                             IProgress<long>? progress)
         {
-            var file_transaction = new TxFileManager();
-
             if (entry.IsDirectory)
             {
                 // Skip if we're not making directories for this install.
@@ -727,7 +737,7 @@ public static List<InstallableFile> FindInstallableFiles(CkanModule   module,
                     : fullPath;
 
                 log.DebugFormat("Making directory '{0}'", fullPath);
-                file_transaction.CreateDirectory(fullPath);
+                txFileMgr.CreateDirectory(fullPath);
             }
             else
             {
@@ -737,19 +747,19 @@ public static List<InstallableFile> FindInstallableFiles(CkanModule   module,
                 if (makeDirs && Path.GetDirectoryName(fullPath) is string d)
                 {
                     log.DebugFormat("Making parent directory '{0}'", d);
-                    file_transaction.CreateDirectory(d);
+                    txFileMgr.CreateDirectory(d);
                 }
 
                 // We don't allow for the overwriting of files. See #208.
-                if (file_transaction.FileExists(fullPath))
+                if (txFileMgr.FileExists(fullPath))
                 {
                     throw new FileExistsKraken(fullPath);
                 }
 
                 // Snapshot whatever was there before. If there's nothing, this will just
                 // remove our file on rollback. We still need this even though we won't
                 // overwite files, as it ensures deletion on rollback.
-                file_transaction.Snapshot(fullPath);
+                txFileMgr.Snapshot(fullPath);
 
                 // Try making hard links if already installed in another instance (faster, less space)
                 foreach (var installedSource in candidateDuplicates)
@@ -918,7 +928,7 @@ private void Uninstall(string               identifier,
                                Registry             registry,
                                IProgress<long>      progress)
         {
-            var file_transaction = new TxFileManager();
+            var txFileMgr = new TxFileManager(instance.CkanDir);
 
             using (var transaction = CkanTransaction.CreateTransactionScope())
             {
@@ -972,7 +982,7 @@ private void Uninstall(string               identifier,
                             bytesDeleted += new FileInfo(absPath).Length;
                             progress.Report(bytesDeleted);
                             log.DebugFormat("Removing {0}", relPath);
-                            file_transaction.Delete(absPath);
+                            txFileMgr.Delete(absPath);
                         }
                     }
                     catch (FileNotFoundException exc)
@@ -1044,7 +1054,7 @@ private void Uninstall(string               identifier,
                         if (File.Exists(absPath))
                         {
                             log.DebugFormat("Attempting transaction deletion of file {0}", absPath);
-                            file_transaction.Delete(absPath);
+                            txFileMgr.Delete(absPath);
                         }
                         else if (Directory.Exists(absPath))
                         {
@@ -1063,7 +1073,7 @@ private void Uninstall(string               identifier,
 
                     if (notRemovable.Length < 1)
                     {
-                        // We *don't* use our file_transaction to delete files here, because
+                        // We *don't* use our txFileMgr to delete files here, because
                         // it fails if the system's temp directory is on a different device
                         // to KSP. However we *can* safely delete it now we know it's empty,
                         // because the TxFileMgr *will* put it back if there's a file inside that

Core/Net/Net.cs

@@ -7,7 +7,7 @@
 using System.Threading;
 
 using Autofac;
-using ChinhDo.Transactions.FileManager;
+using ChinhDo.Transactions;
 using log4net;
 
 using CKAN.Extensions;
@@ -66,10 +66,10 @@ public static string Download(Uri         url,
                                       IUser?      user      = null)
         {
             user?.RaiseMessage(Properties.Resources.NetDownloading, url);
-            var FileTransaction = new TxFileManager();
+            var txFileMgr = new TxFileManager();
 
             // Generate a temporary file if none is provided.
-            filename ??= FileTransaction.GetTempFileName();
+            filename ??= txFileMgr.CreateTempFileName();
 
             log.DebugFormat("Downloading {0} to {1}", url, filename);
 
@@ -118,7 +118,7 @@ public static string Download(Uri         url,
                     // Clean up our file, it's unlikely to be complete.
                     // We do this even though we're using transactional files, as we may not be in a transaction.
                     log.DebugFormat("Removing {0} after web error failure", filename);
-                    FileTransaction.Delete(filename);
+                    txFileMgr.Delete(filename);
                 }
                 catch
                 {