Write autosaves into a sub-directory with timestamps to make autosaves friendly for multiple-instance mapping

Author: Rampastring

docs/Manual.md

@@ -86,4 +86,6 @@ If you have a multi-monitor setup, when maximized with F11, WAE fills the monito
 
 WAE automatically saves a backup of your map every few minutes to prevent data loss in case of crash of the system or editor.
 
-**Auto-save does not overwrite your open map file**, but instead the save is written as `autosave.map` inside WAE's directory. If you encounter a crash or other issues that would cause work to be lost, you can find the `autosave.map` file from WAE's directory, copy it and continue your work from it.
+**Auto-save does not overwrite your open map file**, but instead the save is written to a subdirectory called `AutoSaves` inside WAE's directory. If you encounter a crash or other issues that would cause work to be lost, you can find the latest autosave file from WAE's directory, copy it and continue your work from it.
+
+Auto-saves older than one day are purged automatically. The latest 5 auto-saves are never purged automatically.

src/TSMapEditor/Misc/AutosaveTimer.cs

@@ -1,6 +1,8 @@
 using Rampastring.Tools;
 using System;
+using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using TSMapEditor.Models;
 using TSMapEditor.Settings;
 
@@ -16,11 +18,16 @@ public AutosaveTimer(Map map)
 
         private readonly Map map;
 
+        private const string AutoSavesDirectory = "AutoSaves";
+        private const string MapFileExtension = ".map";
+
         public TimeSpan AutoSaveTime { get; set; }
 
         private void DoSave()
         {
-            map.AutoSave(Path.Combine(Path.GetDirectoryName(Environment.ProcessPath), "autosave.map"));
+            var now = DateTime.Now;
+            string timestamp = $"{now.Year}_{now.Month:D2}_{now.Day:D2}_{now.Hour:D2}_{now.Second:D2}";
+            map.AutoSave(Path.Combine(Path.GetDirectoryName(Environment.ProcessPath), AutoSavesDirectory, $"autosave_{timestamp}{MapFileExtension}"));
         }
 
         public string Update(TimeSpan elapsedTime)
@@ -51,5 +58,62 @@ public string Update(TimeSpan elapsedTime)
 
             return null;
         }
+
+
+        /// <summary>
+        /// Purges old auto-saves from the autosaves directory.
+        /// </summary>
+        public static void Purge()
+        {
+            Logger.Log("Purging old auto-saves.");
+
+            string path = Path.Combine(Path.GetDirectoryName(Environment.ProcessPath), AutoSavesDirectory);
+
+            if (!Directory.Exists(path))
+            {
+                Logger.Log("Auto-saves directory does not exist!");
+                return;
+            }
+
+            string[] filePaths = Directory.GetFiles(path);
+            List<FileInfo> mapFileInfos = new List<FileInfo>();
+            foreach (string filePath in filePaths)
+            {
+                if (!filePath.EndsWith(MapFileExtension))
+                    continue;
+
+                FileInfo fileInfo = new FileInfo(filePath);
+
+                if (fileInfo.CreationTime < DateTime.Now.AddDays(-1))
+                    mapFileInfos.Add(fileInfo);
+            }
+
+            // Leave the latest 5 files. Purge everything else.
+            mapFileInfos = mapFileInfos.OrderBy(fileInfo => fileInfo.CreationTime).Reverse().ToList();
+            const int leaveCount = 5;
+            int purgeCount = mapFileInfos.Count - leaveCount;
+
+            if (purgeCount <= 0)
+            {
+                Logger.Log("There are not enough old auto-saves to purge.");
+                return;
+            }
+
+            Logger.Log($"Found {purgeCount} autosaves to purge.");
+
+            for (int i = leaveCount; i < mapFileInfos.Count; i++)
+            {
+                var autosavePath = mapFileInfos[i].FullName;
+
+                try
+                {
+                    File.Delete(autosavePath);
+                }
+                catch (IOException ex)
+                {
+                    Logger.Log($"Failed to delete auto-save {Path.GetFileName(autosavePath)}. Exception message: " + ex.Message);
+                }
+            }
+        }
     }
 }

src/TSMapEditor/Models/Map.cs

@@ -39,6 +39,7 @@ public class Map : IMap
         public event EventHandler<CellLightingEventArgs> CellLightingModified;
         public event EventHandler MapManuallySaved;
         public event EventHandler MapAutoSaved;
+        public event EventHandler MapSaveFailed;
         public event EventHandler PreSave;
         public event EventHandler PostSave;
 
@@ -385,7 +386,16 @@ private void Write(string filePath = null)
 
             string savePath = filePath ?? LoadedINI.FileName;
 
-            LoadedINI.WriteIniFile(savePath);
+            try
+            {
+                Directory.CreateDirectory(Path.GetDirectoryName(savePath));
+                LoadedINI.WriteIniFile(savePath);
+            }
+            catch (IOException ex)
+            {
+                Logger.Log($"Saving map failed! Path: {savePath}, exception message: {ex.Message}");
+                MapSaveFailed?.Invoke(ex, EventArgs.Empty);
+            }
 
             PostSave?.Invoke(this, EventArgs.Empty);
         }

src/TSMapEditor/Rendering/GameClass.cs

@@ -8,6 +8,7 @@
 using System.Text;
 using System.Threading;
 using TSMapEditor.CCEngine;
+using TSMapEditor.Misc;
 using TSMapEditor.Settings;
 using TSMapEditor.UI;
 
@@ -51,6 +52,7 @@ public GameClass()
 
             Constants.Init();
             new UserSettings();
+            AutosaveTimer.Purge();
 
             graphics = new GraphicsDeviceManager(this);
             graphics.HardwareModeSwitch = false;

src/TSMapEditor/UI/UIManager.cs

@@ -353,9 +353,9 @@ private void InitAutoSaveAndSaveNotifications()
             };
 
             map.MapAutoSaved += (s, e) => notificationManager.AddNotification("Map auto-saved.");
+            map.MapSaveFailed += (s, e) => notificationManager.AddNotification("Saving map failed! Please see the log file for details.");
         }
 
-
         private void RefreshWindowTitle()
         {
             string baseTitle = "C&C World-Altering Editor (WAE) - {0}";