Writethrough when saving files

HebaruSan · HebaruSan · commit bb1dadfef4ee · 2025-06-14T11:40:49.000-05:00
diff --git a/Core/Configuration/JsonConfiguration.cs b/Core/Configuration/JsonConfiguration.cs
@@ -295,8 +295,8 @@ private void OnPropertyChanged([CallerMemberName] string? name = null)
         // </summary>
         private void SaveConfig()
         {
-            File.WriteAllText(configFile,
-                              JsonConvert.SerializeObject(config, Formatting.Indented));
+            JsonConvert.SerializeObject(config, Formatting.Indented)
+                       .WriteThroughTo(configFile);
         }
 
         /// <summary>
diff --git a/Core/Configuration/StabilityToleranceConfig.cs b/Core/Configuration/StabilityToleranceConfig.cs
@@ -5,6 +5,8 @@
 
 using Newtonsoft.Json;
 
+using CKAN.Extensions;
+
 namespace CKAN.Configuration
 {
     [JsonObject(MemberSerialization.OptIn)]
@@ -27,7 +29,8 @@ public bool Save()
         {
             try
             {
-                File.WriteAllText(path, JsonConvert.SerializeObject(this, Formatting.Indented));
+                JsonConvert.SerializeObject(this, Formatting.Indented)
+                           .WriteThroughTo(path);
                 return true;
             }
             catch
diff --git a/Core/Extensions/IOExtensions.cs b/Core/Extensions/IOExtensions.cs
@@ -17,6 +17,25 @@ public static class IOExtensions
         public static DriveInfo? GetDrive(this DirectoryInfo dir)
             => Utilities.DefaultIfThrows(() => new DriveInfo(dir.FullName));
 
+        /// <summary>
+        /// File.WriteAllText replacement that doesn't sometimes write all NULs instead on Windows.
+        /// https://stackoverflow.com/questions/54078564
+        /// </summary>
+        /// <param name="contents">The string to write</param>
+        /// <param name="path">Where to save it</param>
+        public static void WriteThroughTo(this string contents, string path)
+        {
+            using (var stream = File.Create(path, contents.Length + 1,
+                                            FileOptions.WriteThrough))
+            using (var writer = new StreamWriter(stream))
+            {
+                writer.Write(contents);
+                // If we don't Flush, the file can be truncated,
+                // and if we Close, the 'using' block throws an exception
+                writer.Flush();
+            }
+        }
+
         /// <summary>
         /// A version of Stream.CopyTo with progress updates.
         /// </summary>
diff --git a/Core/GameInstance.cs b/Core/GameInstance.cs
@@ -15,6 +15,7 @@
 using CKAN.Configuration;
 using CKAN.Games;
 using CKAN.Versioning;
+using CKAN.Extensions;
 
 namespace CKAN
 {
@@ -138,16 +139,14 @@ public void SetCompatibleVersions(List<GameVersion> compatibleVersions)
 
         private void SaveCompatibleVersions()
         {
-            File.WriteAllText(
-                CompatibleGameVersionsFile(),
-                JsonConvert.SerializeObject(new CompatibleGameVersions()
+            JsonConvert.SerializeObject(new CompatibleGameVersions()
                 {
                     GameVersionWhenWritten = Version()?.ToString(),
                     Versions               = _compatibleVersions.Select(v => v.ToString())
                                                                 .OfType<string>()
                                                                 .ToList()
                 })
-            );
+                .WriteThroughTo(CompatibleGameVersionsFile());
             GameVersionWhenCompatibleVersionsWereStored = Version();
         }
 
@@ -203,7 +202,8 @@ public string[] InstallFilters
             #pragma warning disable IDE0027
             set
             {
-                File.WriteAllText(InstallFiltersFile, JsonConvert.SerializeObject(value));
+                JsonConvert.SerializeObject(value)
+                           .WriteThroughTo(InstallFiltersFile);
             }
             #pragma warning restore IDE0027
         }
diff --git a/Core/Games/KerbalSpaceProgram/GameVersionProviders/KspBuildMap.cs b/Core/Games/KerbalSpaceProgram/GameVersionProviders/KspBuildMap.cs
@@ -9,6 +9,7 @@
 
 using CKAN.IO;
 using CKAN.Versioning;
+using CKAN.Extensions;
 
 namespace CKAN.Games.KerbalSpaceProgram.GameVersionProviders
 {
@@ -144,7 +145,7 @@ private bool TrySetRemoteBuildMap(string? userAgent)
                 {
                     // Save to disk if parse succeeds
                     new FileInfo(cachedBuildMapPath).Directory?.Create();
-                    File.WriteAllText(cachedBuildMapPath, json);
+                    json.WriteThroughTo(cachedBuildMapPath);
                     return true;
                 }
             }
diff --git a/Core/Games/KerbalSpaceProgram2.cs b/Core/Games/KerbalSpaceProgram2.cs
@@ -156,7 +156,7 @@ public void RefreshVersions(string? userAgent)
 
                     // Save to disk if download and parse succeeds
                     new FileInfo(cachedBuildMapPath).Directory?.Create();
-                    File.WriteAllText(cachedBuildMapPath, json);
+                    json.WriteThroughTo(cachedBuildMapPath);
                 }
             }
             catch (Exception e)
diff --git a/Core/Net/NetFileCache.cs b/Core/Net/NetFileCache.cs
@@ -674,7 +674,7 @@ private string GetFileHash(string                     filePath,
                     cache.Add(filePath, hash);
                     if (Path.GetDirectoryName(hashFile) == cachePath.FullName)
                     {
-                        File.WriteAllText(hashFile, hash);
+                        hash.WriteThroughTo(hashFile);
                     }
                     return hash;
                 }
diff --git a/Core/Registry/Tags/ModuleTagList.cs b/Core/Registry/Tags/ModuleTagList.cs
@@ -3,6 +3,7 @@
 using Newtonsoft.Json;
 
 using CKAN.IO;
+using CKAN.Extensions;
 
 namespace CKAN
 {
@@ -32,7 +33,8 @@ public bool Save(string path)
         {
             try
             {
-                File.WriteAllText(path, JsonConvert.SerializeObject(this, Formatting.Indented));
+                JsonConvert.SerializeObject(this, Formatting.Indented)
+                           .WriteThroughTo(path);
                 return true;
             }
             catch
diff --git a/Core/SuppressedCompatWarningIdentifiers.cs b/Core/SuppressedCompatWarningIdentifiers.cs
@@ -5,6 +5,7 @@
 using log4net;
 
 using CKAN.Versioning;
+using CKAN.Extensions;
 
 namespace CKAN
 {
@@ -36,7 +37,8 @@ public static SuppressedCompatWarningIdentifiers LoadFrom(GameVersion? gameVer,
 
         public void SaveTo(string filename)
         {
-            File.WriteAllText(filename, JsonConvert.SerializeObject(this));
+            JsonConvert.SerializeObject(this)
+                       .WriteThroughTo(filename);
         }
 
         private static readonly ILog log = LogManager.GetLogger(typeof(SuppressedCompatWarningIdentifiers));
diff --git a/Core/Types/CkanModule.cs b/Core/Types/CkanModule.cs
@@ -14,6 +14,7 @@
 
 using CKAN.Versioning;
 using CKAN.Games;
+using CKAN.Extensions;
 
 namespace CKAN
 {
@@ -461,7 +462,7 @@ public static CkanModule FromFile(string filename)
 
         public static void ToFile(CkanModule module, string filename)
         {
-            File.WriteAllText(filename, ToJson(module));
+            ToJson(module).WriteThroughTo(filename);
         }
 
         public static string ToJson(CkanModule module)
diff --git a/Core/Types/Labels/ModuleLabelList.cs b/Core/Types/Labels/ModuleLabelList.cs
@@ -8,6 +8,7 @@
 using Newtonsoft.Json;
 
 using CKAN.IO;
+using CKAN.Extensions;
 
 namespace CKAN
 {
@@ -72,7 +73,8 @@ public bool Save(string path)
         {
             try
             {
-                File.WriteAllText(path, JsonConvert.SerializeObject(this, Formatting.Indented));
+                JsonConvert.SerializeObject(this, Formatting.Indented)
+                           .WriteThroughTo(path);
                 return true;
             }
             catch
diff --git a/Core/Types/TimeLog.cs b/Core/Types/TimeLog.cs
@@ -3,6 +3,7 @@
 using System.Diagnostics;
 
 using Newtonsoft.Json;
+using CKAN.Extensions;
 
 namespace CKAN
 {
@@ -29,7 +30,8 @@ public static string GetPath(string dir)
 
         public void Save(string path)
         {
-            File.WriteAllText(path, JsonConvert.SerializeObject(this, Formatting.Indented));
+            JsonConvert.SerializeObject(this, Formatting.Indented)
+                       .WriteThroughTo(path);
         }
 
         public override string ToString()
diff --git a/GUI/Model/GUIConfiguration.cs b/GUI/Model/GUIConfiguration.cs
@@ -10,6 +10,7 @@
 using Newtonsoft.Json;
 
 using CKAN.IO;
+using CKAN.Extensions;
 
 namespace CKAN.GUI
 {
@@ -147,8 +148,8 @@ public Point WindowLoc
 
         public void Save(GameInstance instance)
         {
-            File.WriteAllText(ConfigPath(instance),
-                              JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented));
+            JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented)
+                       .WriteThroughTo(ConfigPath(instance));
         }
 
         public static DateTime LastWriteTime(GameInstance instance)
diff --git a/GUI/URLHandlers.cs b/GUI/URLHandlers.cs
@@ -7,6 +7,8 @@
 using System.Runtime.Versioning;
 #endif
 
+using CKAN.Extensions;
+
 using IniParser;
 using IniParser.Exceptions;
 using IniParser.Model;
@@ -193,7 +195,7 @@ private static void RegisterURLHandler_Linux()
                 File.Delete(handlerPath);
             }
 
-            File.WriteAllText(handlerPath, "");
+            "".WriteThroughTo(handlerPath);
             data = parser.ReadFile(handlerPath);
             data.Sections.AddSection("Desktop Entry");
             data["Desktop Entry"].AddKey("Version", "1.0");
diff --git a/Netkan/Program.cs b/Netkan/Program.cs
@@ -201,7 +201,7 @@ private static void WriteCkan(string? outputDir, JObject json)
                 var serializer = new JsonSerializer();
                 serializer.Serialize(jwriter, json);
 
-                File.WriteAllText(finalPath, swriter + Environment.NewLine);
+                (swriter + Environment.NewLine).WriteThroughTo(finalPath);
             }
             Log.InfoFormat("Transformation written to {0}", finalPath);
         }

Original file line number	Diff line number	Diff line change
`@@ -295,8 +295,8 @@ private void OnPropertyChanged([CallerMemberName] string? name = null)`
`295`	`295`	`// </summary>`
`296`	`296`	`private void SaveConfig()`
`297`	`297`	`{`
`298`		`- File.WriteAllText(configFile,`
`299`		`- JsonConvert.SerializeObject(config, Formatting.Indented));`
	`298`	`+ JsonConvert.SerializeObject(config, Formatting.Indented)`
	`299`	`+ .WriteThroughTo(configFile);`
`300`	`300`	`}`
`301`	`301`
`302`	`302`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,8 @@`
`5`	`5`
`6`	`6`	`using Newtonsoft.Json;`
`7`	`7`
	`8`	`+using CKAN.Extensions;`
	`9`	`+`
`8`	`10`	`namespace CKAN.Configuration`
`9`	`11`	`{`
`10`	`12`	`[JsonObject(MemberSerialization.OptIn)]`
`@@ -27,7 +29,8 @@ public bool Save()`
`27`	`29`	`{`
`28`	`30`	`try`
`29`	`31`	`{`
`30`		`- File.WriteAllText(path, JsonConvert.SerializeObject(this, Formatting.Indented));`
	`32`	`+ JsonConvert.SerializeObject(this, Formatting.Indented)`
	`33`	`+ .WriteThroughTo(path);`
`31`	`34`	`return true;`
`32`	`35`	`}`
`33`	`36`	`catch`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`	`using CKAN.Configuration;`
`16`	`16`	`using CKAN.Games;`
`17`	`17`	`using CKAN.Versioning;`
	`18`	`+using CKAN.Extensions;`
`18`	`19`
`19`	`20`	`namespace CKAN`
`20`	`21`	`{`
`@@ -138,16 +139,14 @@ public void SetCompatibleVersions(List<GameVersion> compatibleVersions)`
`138`	`139`
`139`	`140`	`private void SaveCompatibleVersions()`
`140`	`141`	`{`
`141`		`- File.WriteAllText(`
`142`		`- CompatibleGameVersionsFile(),`
`143`		`- JsonConvert.SerializeObject(new CompatibleGameVersions()`
	`142`	`+ JsonConvert.SerializeObject(new CompatibleGameVersions()`
`144`	`143`	`{`
`145`	`144`	`GameVersionWhenWritten = Version()?.ToString(),`
`146`	`145`	`Versions = _compatibleVersions.Select(v => v.ToString())`
`147`	`146`	`.OfType<string>()`
`148`	`147`	`.ToList()`
`149`	`148`	`})`
`150`		`- );`
	`149`	`+ .WriteThroughTo(CompatibleGameVersionsFile());`
`151`	`150`	`GameVersionWhenCompatibleVersionsWereStored = Version();`
`152`	`151`	`}`
`153`	`152`
`@@ -203,7 +202,8 @@ public string[] InstallFilters`
`203`	`202`	`#pragma warning disable IDE0027`
`204`	`203`	`set`
`205`	`204`	`{`
`206`		`- File.WriteAllText(InstallFiltersFile, JsonConvert.SerializeObject(value));`
	`205`	`+ JsonConvert.SerializeObject(value)`
	`206`	`+ .WriteThroughTo(InstallFiltersFile);`
`207`	`207`	`}`
`208`	`208`	`#pragma warning restore IDE0027`
`209`	`209`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`
`10`	`10`	`using CKAN.IO;`
`11`	`11`	`using CKAN.Versioning;`
	`12`	`+using CKAN.Extensions;`
`12`	`13`
`13`	`14`	`namespace CKAN.Games.KerbalSpaceProgram.GameVersionProviders`
`14`	`15`	`{`
`@@ -144,7 +145,7 @@ private bool TrySetRemoteBuildMap(string? userAgent)`
`144`	`145`	`{`
`145`	`146`	`// Save to disk if parse succeeds`
`146`	`147`	`new FileInfo(cachedBuildMapPath).Directory?.Create();`
`147`		`- File.WriteAllText(cachedBuildMapPath, json);`
	`148`	`+ json.WriteThroughTo(cachedBuildMapPath);`
`148`	`149`	`return true;`
`149`	`150`	`}`
`150`	`151`	`}`
Original file line number	Diff line number	Diff line change
`@@ -156,7 +156,7 @@ public void RefreshVersions(string? userAgent)`
`156`	`156`
`157`	`157`	`// Save to disk if download and parse succeeds`
`158`	`158`	`new FileInfo(cachedBuildMapPath).Directory?.Create();`
`159`		`- File.WriteAllText(cachedBuildMapPath, json);`
	`159`	`+ json.WriteThroughTo(cachedBuildMapPath);`
`160`	`160`	`}`
`161`	`161`	`}`
`162`	`162`	`catch (Exception e)`
Original file line number	Diff line number	Diff line change
`@@ -674,7 +674,7 @@ private string GetFileHash(string filePath,`
`674`	`674`	`cache.Add(filePath, hash);`
`675`	`675`	`if (Path.GetDirectoryName(hashFile) == cachePath.FullName)`
`676`	`676`	`{`
`677`		`- File.WriteAllText(hashFile, hash);`
	`677`	`+ hash.WriteThroughTo(hashFile);`
`678`	`678`	`}`
`679`	`679`	`return hash;`
`680`	`680`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`using Newtonsoft.Json;`
`4`	`4`
`5`	`5`	`using CKAN.IO;`
	`6`	`+using CKAN.Extensions;`
`6`	`7`
`7`	`8`	`namespace CKAN`
`8`	`9`	`{`
`@@ -32,7 +33,8 @@ public bool Save(string path)`
`32`	`33`	`{`
`33`	`34`	`try`
`34`	`35`	`{`
`35`		`- File.WriteAllText(path, JsonConvert.SerializeObject(this, Formatting.Indented));`
	`36`	`+ JsonConvert.SerializeObject(this, Formatting.Indented)`
	`37`	`+ .WriteThroughTo(path);`
`36`	`38`	`return true;`
`37`	`39`	`}`
`38`	`40`	`catch`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`using log4net;`
`6`	`6`
`7`	`7`	`using CKAN.Versioning;`
	`8`	`+using CKAN.Extensions;`
`8`	`9`
`9`	`10`	`namespace CKAN`
`10`	`11`	`{`
`@@ -36,7 +37,8 @@ public static SuppressedCompatWarningIdentifiers LoadFrom(GameVersion? gameVer,`
`36`	`37`
`37`	`38`	`public void SaveTo(string filename)`
`38`	`39`	`{`
`39`		`- File.WriteAllText(filename, JsonConvert.SerializeObject(this));`
	`40`	`+ JsonConvert.SerializeObject(this)`
	`41`	`+ .WriteThroughTo(filename);`
`40`	`42`	`}`
`41`	`43`
`42`	`44`	`private static readonly ILog log = LogManager.GetLogger(typeof(SuppressedCompatWarningIdentifiers));`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`
`15`	`15`	`using CKAN.Versioning;`
`16`	`16`	`using CKAN.Games;`
	`17`	`+using CKAN.Extensions;`
`17`	`18`
`18`	`19`	`namespace CKAN`
`19`	`20`	`{`
`@@ -461,7 +462,7 @@ public static CkanModule FromFile(string filename)`
`461`	`462`
`462`	`463`	`public static void ToFile(CkanModule module, string filename)`
`463`	`464`	`{`
`464`		`- File.WriteAllText(filename, ToJson(module));`
	`465`	`+ ToJson(module).WriteThroughTo(filename);`
`465`	`466`	`}`
`466`	`467`
`467`	`468`	`public static string ToJson(CkanModule module)`