Handle SRAM saving failure.

Author: SuuperW

src/BizHawk.Client.Common/Api/Classes/EmuClientApi.cs

@@ -158,6 +158,7 @@ public bool OpenRom(string path)
 
 		public void RebootCore() => _mainForm.RebootCore();
 
+		// TODO: Change return type to FileWriteResult.
 		public void SaveRam() => _mainForm.FlushSaveRAM();
 
 		// TODO: Change return type to FileWriteResult.

src/BizHawk.Client.Common/DialogControllerExtensions.cs

@@ -68,13 +68,40 @@ public static void ErrorMessageBox(
 		{
 			Debug.Assert(fileResult.IsError && fileResult.Exception != null, "Error box must have an error.");
 
-			string prefix = prefixMessage == null ? "" : prefixMessage + "\n";
+			string prefix = prefixMessage ?? "";
 			dialogParent.ModalMessageBox(
-				text: $"{prefix}{fileResult.UserFriendlyErrorMessage()}\n{fileResult.Exception!.Message}",
+				text: $"{prefix}\n{fileResult.UserFriendlyErrorMessage()}\n{fileResult.Exception!.Message}",
 				caption: "Error",
 				icon: EMsgBoxIcon.Error);
 		}
 
+		/// <summary>
+		/// If the action fails, asks the user if they want to try again.
+		/// The user will be repeatedly asked if they want to try again until either success or the user says no.
+		/// </summary>
+		/// <returns>Returns true on success or if the user said no. Returns false if the user said cancel.</returns>
+		public static bool DoWithTryAgainBox(
+			this IDialogParent dialogParent,
+			Func<FileWriteResult> action,
+			string message)
+		{
+			FileWriteResult fileResult = action();
+			while (fileResult.IsError)
+			{
+				string prefix = message ?? "";
+				bool? askResult = dialogParent.ModalMessageBox3(
+						text: $"{prefix} Do you want to try again?\n\nError details:" +
+							$"{fileResult.UserFriendlyErrorMessage()}\n{fileResult.Exception!.Message}",
+						caption: "Error",
+						icon: EMsgBoxIcon.Error);
+				if (askResult == null) return false;
+				if (askResult == false) return true;
+				if (askResult == true) fileResult = action();
+			}
+
+			return true;
+		}
+
 		/// <summary>Creates and shows a <c>System.Windows.Forms.OpenFileDialog</c> or equivalent with the receiver (<paramref name="dialogParent"/>) as its parent</summary>
 		/// <param name="discardCWDChange"><c>OpenFileDialog.RestoreDirectory</c> (isn't this useless when specifying <paramref name="initDir"/>? keeping it for backcompat)</param>
 		/// <param name="filter"><c>OpenFileDialog.Filter</c></param>

src/BizHawk.Client.Common/FileWriter.cs

@@ -39,6 +39,23 @@ private FileWriter(FileWritePaths paths, FileStream stream)
 			_stream = stream;
 		}
 
+		public static FileWriteResult Write(string path, byte[] bytes, string? backupPath = null)
+		{
+			FileWriteResult<FileWriter> createResult = Create(path);
+			if (createResult.IsError) return createResult;
+
+			try
+			{
+				createResult.Value!.Stream.Write(bytes);
+			}
+			catch (Exception ex)
+			{
+				return new(FileWriteEnum.FailedDuringWrite, createResult.Value!.Paths, ex);
+			}
+
+			return createResult.Value.CloseAndDispose(backupPath);
+		}
+
 
 		/// <summary>
 		/// Create a FileWriter instance, or return an error if unable to access the file.

src/BizHawk.Client.Common/IMainFormForApi.cs

@@ -48,7 +48,7 @@ public interface IMainFormForApi
 		void EnableRewind(bool enabled);
 
 		/// <remarks>only referenced from <c>EmuClientApi</c></remarks>
-		bool FlushSaveRAM(bool autosave = false);
+		FileWriteResult FlushSaveRAM(bool autosave = false);
 
 		/// <remarks>only referenced from <c>EmuClientApi</c></remarks>
 		void FrameAdvance(bool discardApiHawkSurfaces = true);

src/BizHawk.Client.EmuHawk/MainForm.Events.cs

@@ -316,7 +316,7 @@ private bool LoadstateCurrentSlot()
 
 		private void FlushSaveRAMMenuItem_Click(object sender, EventArgs e)
 		{
-			FlushSaveRAM();
+			ShowMessageIfError(() => FlushSaveRAM(), "Failed to flush saveram!");
 		}
 
 		private void ReadonlyMenuItem_Click(object sender, EventArgs e)

src/BizHawk.Client.EmuHawk/MainForm.Hotkey.cs

@@ -76,7 +76,7 @@ void SelectAndLoadFromSlot(int slot)
 					LoadMostRecentROM();
 					break;
 				case "Flush SaveRAM":
-					FlushSaveRAM();
+					FlushSaveRAMMenuItem_Click(null, null);
 					break;
 				case "Display FPS":
 					ToggleFps();

src/BizHawk.Client.EmuHawk/MainForm.cs

@@ -1840,6 +1840,7 @@ public bool RunLibretroCoreChooser()
 
 		// countdown for saveram autoflushing
 		public int AutoFlushSaveRamIn { get; set; }
+		private bool AutoFlushSaveRamFailed;
 
 		private void SetStatusBar()
 		{
@@ -2063,7 +2064,7 @@ private void LoadSaveRam()
 			}
 		}
 
-		public bool FlushSaveRAM(bool autosave = false)
+		public FileWriteResult FlushSaveRAM(bool autosave = false)
 		{
 			if (Emulator.HasSaveRam())
 			{
@@ -2077,51 +2078,11 @@ public bool FlushSaveRAM(bool autosave = false)
 					path = Config.PathEntries.SaveRamAbsolutePath(Game, MovieSession.Movie);
 				}
 
-				var file = new FileInfo(path);
-				var newPath = $"{path}.new";
-				var newFile = new FileInfo(newPath);
-				var backupPath = $"{path}.bak";
-				var backupFile = new FileInfo(backupPath);
-
 				var saveram = Emulator.AsSaveRam().CloneSaveRam()!;
-
-				try
-				{
-					Directory.CreateDirectory(file.DirectoryName!);
-					using (var fs = File.Create(newPath))
-					{
-						fs.Write(saveram, 0, saveram.Length);
-						fs.Flush(flushToDisk: true);
-					}
-
-					if (file.Exists)
-					{
-						if (Config.BackupSaveram)
-						{
-							if (backupFile.Exists)
-							{
-								backupFile.Delete();
-							}
-
-							file.MoveTo(backupPath);
-						}
-						else
-						{
-							file.Delete();
-						}
-					}
-
-					newFile.MoveTo(path);
-				}
-				catch (IOException e)
-				{
-					AddOnScreenMessage("Failed to flush saveram!");
-					Console.Error.WriteLine(e);
-					return false;
-				}
+				return FileWriter.Write(path, saveram, $"{path}.bak");
 			}
 
-			return true;
+			return new();
 		}
 
 		private void RewireSound()
@@ -3180,8 +3141,22 @@ private void StepRunLoop_Core(bool force = false)
 					AutoFlushSaveRamIn--;
 					if (AutoFlushSaveRamIn <= 0)
 					{
-						FlushSaveRAM(true);
-						AutoFlushSaveRamIn = Config.FlushSaveRamFrames;
+						FileWriteResult result = FlushSaveRAM(true);
+						if (result.IsError)
+						{
+							// For autosave, allow one failure before bothering the user.
+							if (AutoFlushSaveRamFailed)
+							{
+								this.ErrorMessageBox(result, "Failed to flush saveram!");
+							}
+							AutoFlushSaveRamFailed = true;
+							AutoFlushSaveRamIn = Math.Min(600, Config.FlushSaveRamFrames);
+						}
+						else
+						{
+							AutoFlushSaveRamFailed = false;
+							AutoFlushSaveRamIn = Config.FlushSaveRamFrames;
+						}
 					}
 				}
 				// why not skip audio if the user doesn't want sound
@@ -4101,41 +4076,34 @@ private bool CloseGame(bool clearSram = false)
 				var path = Config.PathEntries.SaveRamAbsolutePath(Game, MovieSession.Movie);
 				if (File.Exists(path))
 				{
-					File.Delete(path);
-					AddOnScreenMessage("SRAM cleared.");
+					bool clearResult = this.DoWithTryAgainBox(() => {
+						try
+						{
+							File.Delete(path);
+							AddOnScreenMessage("SRAM cleared.");
+							return new();
+						}
+						catch (Exception ex)
+						{
+							return new(FileWriteEnum.FailedToDeleteGeneric, new(path, ""), ex);
+						}
+					}, "Failed to clear SRAM.");
+					if (!clearResult)
+					{
+						return false;
+					}
 				}
 			}
 			else if (Emulator.HasSaveRam())
 			{
-				while (true)
-				{
-					if (FlushSaveRAM()) break;
-
-					var result = ShowMessageBox3(
-						owner: this,
-						"Failed flushing the game's Save RAM to your disk.\n" +
-						"Do you want to try again?",
-						"IOError while writing SaveRAM",
-						EMsgBoxIcon.Error);
-
-					if (result is false) break;
-					if (result is null) return false;
-				}
+				bool flushResult = this.DoWithTryAgainBox(
+					() => FlushSaveRAM(),
+					"Failed flushing the game's Save RAM to your disk.");
+				if (!flushResult) return false;
 			}
 
-			bool? tryAgain = null;
-			do
-			{
-				FileWriteResult stateSaveResult = AutoSaveStateIfConfigured();
-				if (stateSaveResult.IsError)
-				{
-					tryAgain = this.ShowMessageBox3(
-						$"Failed to auto-save state. Do you want to try again?\n\nError details:\n{stateSaveResult.UserFriendlyErrorMessage()}\n{stateSaveResult.Exception.Message}",
-						"IOError while writing savestate",
-						EMsgBoxIcon.Error);
-					if (tryAgain == null) return false;
-				}
-			} while (tryAgain == true);
+			bool stateSaveResult = this.DoWithTryAgainBox(AutoSaveStateIfConfigured, "Failed to auto-save state.");
+			if (!stateSaveResult) return false;
 
 			StopAv();
 
@@ -4414,11 +4382,7 @@ public FileWriteResult SaveQuickSave(int slot, bool suppressOSD = false)
 		/// </summary>
 		private void SaveQuickSaveAndShowError(int slot)
 		{
-			FileWriteResult result = SaveQuickSave(slot);
-			if (result.IsError)
-			{
-				this.ErrorMessageBox(result, "Quick save failed.");
-			}
+			ShowMessageIfError(() => SaveQuickSave(slot), "Quick save failed.");
 		}
 
 		public bool EnsureCoreIsAccurate()
@@ -4488,11 +4452,9 @@ private void SaveStateAs()
 				initFileName: $"{SaveStatePrefix()}.QuickSave0.State");
 			if (shouldSaveResult is not null)
 			{
-				FileWriteResult saveResult = SaveState(path: shouldSaveResult, userFriendlyStateName: shouldSaveResult);
-				if (saveResult.IsError)
-				{
-					this.ErrorMessageBox(saveResult, "Unable to save.");
-				}
+				ShowMessageIfError(
+					() => SaveState(path: shouldSaveResult, userFriendlyStateName: shouldSaveResult),
+					"Unable to save state.");
 			}
 
 			if (Tools.IsLoaded<TAStudio>())
@@ -4783,6 +4745,15 @@ public bool ShowMessageBox2(
 					_ => null,
 				};
 
+		public void ShowMessageIfError(Func<FileWriteResult> action, string message)
+		{
+			FileWriteResult result = action();
+			if (result.IsError)
+			{
+				this.ErrorMessageBox(result, message);
+			}
+		}
+
 		public void StartSound() => Sound.StartSound();
 		public void StopSound() => Sound.StopSound();