use separate cache folder for online objects so keep user downloads folder clean

Author: LeftofZen

Gui/EditorSettings.cs

@@ -42,6 +42,7 @@ public HashSet<string> ObjDataDirectories
 
 	public string ObjectIndicesFolder { get; set; } = string.Empty;
 	public string DownloadFolder { get; set; } = string.Empty;
+	public string CacheFolder { get; set; } = string.Empty;
 
 	public string LocomotionSteamObjDataFolder { get; set; } = string.Empty;
 	public string LocomotionGoGObjDataFolder { get; set; } = string.Empty;
@@ -120,19 +121,25 @@ public bool Validate(ILogger logger)
 
 		if (!Directory.Exists(ObjDataDirectory))
 		{
-			logger.Warning($"Invalid settings file: Directory \"{ObjDataDirectory}\" does not exist");
+			logger.Warning($"Invalid settings file: ObjData folder \"{ObjDataDirectory}\" does not exist");
 			return false;
 		}
 
-		if (!Directory.Exists(DownloadFolder))
+		if (!string.IsNullOrEmpty(CacheFolder) && !Directory.Exists(CacheFolder))
 		{
-			logger.Warning($"Invalid settings file: Directory \"{DownloadFolder}\" does not exist");
+			logger.Warning($"Invalid settings file: Cache folder \"{CacheFolder}\" does not exist");
 			return false;
 		}
 
-		if (!Directory.Exists(ObjectIndicesFolder))
+		if (!string.IsNullOrEmpty(DownloadFolder) && !Directory.Exists(DownloadFolder))
 		{
-			logger.Warning($"Invalid settings file: Directory \"{ObjectIndicesFolder}\" does not exist");
+			logger.Warning($"Invalid settings file: Download folder \"{DownloadFolder}\" does not exist");
+			return false;
+		}
+
+		if (!string.IsNullOrEmpty(ObjectIndicesFolder) && !Directory.Exists(ObjectIndicesFolder))
+		{
+			logger.Warning($"Invalid settings file: Object index folder \"{ObjectIndicesFolder}\" does not exist");
 			return false;
 		}
 

Gui/Models/ObjectEditorModel.cs

@@ -73,8 +73,9 @@ public ObjectEditorModel()
 		// settings must be loaded or else the rest of the app cannot start
 		ArgumentNullException.ThrowIfNull(Settings);
 
-		InitialiseObjectIndiciesDirectory();
-		InitialiseDownloadDirectory();
+		Settings.ObjectIndicesFolder = InitialiseDirectory(Settings.ObjectIndicesFolder, "objectIndices");
+		Settings.CacheFolder = InitialiseDirectory(Settings.CacheFolder, "cache");
+		Settings.DownloadFolder = InitialiseDirectory(Settings.DownloadFolder, "downloads");
 
 		ObjectServiceClient = new(Settings, Logger);
 	}
@@ -134,32 +135,20 @@ void LoadSettings()
 		}
 	}
 
-	void InitialiseObjectIndiciesDirectory()
+	string InitialiseDirectory(string folder, string defaultName)
 	{
-		if (string.IsNullOrEmpty(Settings.ObjectIndicesFolder))
+		if (string.IsNullOrEmpty(folder))
 		{
-			Settings.ObjectIndicesFolder = Path.Combine(ProgramDataPath, "objectIndices");
+			folder = Path.Combine(ProgramDataPath, defaultName);
 		}
 
-		if (!Directory.Exists(Settings.ObjectIndicesFolder))
+		if (!Directory.Exists(folder))
 		{
-			Logger.Info($"Object indices folder doesn't exist; creating now at \"{Settings.ObjectIndicesFolder}\"");
-			_ = Directory.CreateDirectory(Settings.ObjectIndicesFolder);
+			Logger.Info($"\"{defaultName}\" folder doesn't exist; creating now at \"{folder}\"");
+			_ = Directory.CreateDirectory(folder);
 		}
-	}
 
-	void InitialiseDownloadDirectory()
-	{
-		if (string.IsNullOrEmpty(Settings.DownloadFolder))
-		{
-			Settings.DownloadFolder = Path.Combine(ProgramDataPath, "downloads");
-		}
-
-		if (!Directory.Exists(Settings.DownloadFolder))
-		{
-			Logger.Info($"Download folder doesn't exist; creating now at \"{Settings.DownloadFolder}\"");
-			_ = Directory.CreateDirectory(Settings.DownloadFolder);
-		}
+		return folder;
 	}
 
 	public bool TryLoadObject(FileSystemItem filesystemItem, out LocoUIObjectModel? uiLocoFile)
@@ -260,7 +249,7 @@ bool TryLoadOnlineFile(FileSystemItem filesystemItem, out LocoUIObjectModel? loc
 
 				var filename = Path.GetInvalidFileNameChars().Aggregate(datObject.DatName, (current, c) => current.Replace(c, '_'));
 				filename = $"{filename}-{datObject.ObjectId}.dat";
-				var pathname = Path.Combine(Settings.DownloadFolder, filename);
+				var pathname = Path.Combine(Settings.CacheFolder, filename);
 				if (!File.Exists(pathname))
 				{
 					File.WriteAllBytes(pathname, datFile);

Gui/PlatformSpecific.cs

@@ -29,7 +29,7 @@ static void FolderOpenInDesktopCore(string directory, string? filename = null)
 	{
 		if (!Directory.Exists(directory))
 		{
-			throw new ArgumentException("The specified folder does not exist. Folder=\"{directory}\"", nameof(directory));
+			throw new ArgumentException($"The specified folder does not exist. Folder=\"{directory}\"", nameof(directory));
 		}
 
 		// Platform-specific command construction

Gui/ViewModels/EditorSettingsWindowViewModel.cs

@@ -76,7 +76,14 @@ public string OpenLocoObjDataFolder
 		set => Model.OpenLocoObjDataFolder = value;
 	}
 
-	[PathBrowsable(PathBrowsableType.Directory), Category(UserObjectFolderCategory), DisplayName("Downloads"), Description("The folder to store downloaded objects.")]
+	[PathBrowsable(PathBrowsableType.Directory), Category(UserObjectFolderCategory), DisplayName("Cache"), Description("The folder to store cached downloaded objects.")]
+	public string CacheFolder
+	{
+		get => Model.CacheFolder;
+		set => Model.CacheFolder = value;
+	}
+
+	[PathBrowsable(PathBrowsableType.Directory), Category(UserObjectFolderCategory), DisplayName("Downloads"), Description("The folder to store user-downloaded objects.")]
 	public string DownloadFolder
 	{
 		get => Model.DownloadFolder;

Gui/ViewModels/MainWindowViewModel.cs

@@ -36,6 +36,7 @@ public class MainWindowViewModel : ViewModelBase
 
 	public ObservableCollection<MenuItemViewModel> ObjDataItems { get; init; } = [];
 
+	public ReactiveCommand<Unit, Unit> OpenCacheFolder { get; }
 	public ReactiveCommand<Unit, Unit> OpenDownloadFolder { get; }
 	public ReactiveCommand<Unit, Unit> OpenSettingsFolder { get; }
 	public ReactiveCommand<Unit, Task> OpenSingleObject { get; }
@@ -118,6 +119,7 @@ public MainWindowViewModel()
 		PopulateObjDataMenu();
 
 		OpenSingleObject = ReactiveCommand.Create(LoadSingleObject);
+		OpenCacheFolder = ReactiveCommand.Create(() => PlatformSpecific.FolderOpenInDesktop(Model.Settings.CacheFolder, Model.Logger));
 		OpenDownloadFolder = ReactiveCommand.Create(() => PlatformSpecific.FolderOpenInDesktop(Model.Settings.DownloadFolder, Model.Logger));
 		OpenSettingsFolder = ReactiveCommand.Create(() => PlatformSpecific.FolderOpenInDesktop(ObjectEditorModel.ProgramDataPath, Model.Logger));
 		OpenG1 = ReactiveCommand.Create(LoadG1);

Gui/Views/MainWindow.axaml

@@ -191,7 +191,8 @@
 				<MenuItem Header="_Settings">
 					<MenuItem Command="{Binding EditSettingsCommand}" Header="Edit settings"/>
 					<MenuItem Command="{Binding OpenSettingsFolder}" Header="Open settings folder"/>
-					<MenuItem Command="{Binding OpenDownloadFolder}" Header="Open downloads folder"/>
+					<MenuItem Command="{Binding OpenDownloadFolder}" Header="Open user downloads folder"/>
+					<MenuItem Command="{Binding OpenCacheFolder}" Header="Open cached objects folder"/>
 					<MenuItem Command="{Binding ShowLogsCommand}" Header="Show logs"/>
 				</MenuItem>
 			</Menu>