Adds a UI component to view and edit program settings (#134)

* adds primitive window to view existing settings

* working and completed

* remove commented out code

* remove unnecessary usings

Author: LeftofZen

Dat/FileParsing/ByteReader.cs

@@ -1,5 +1,4 @@
 using OpenLoco.Dat.Types;
-using Zenith.Core;
 
 namespace OpenLoco.Dat.FileParsing
 {

Definitions/Migrations/20241013053058_InitialCreate.cs

@@ -1,12 +1,11 @@
-using System;
-using Microsoft.EntityFrameworkCore.Migrations;
+using Microsoft.EntityFrameworkCore.Migrations;
 
 #nullable disable
 
 namespace Definitions.Migrations
 {
-    /// <inheritdoc />
-    public partial class InitialCreate : Migration
+	/// <inheritdoc />
+	public partial class InitialCreate : Migration
     {
         /// <inheritdoc />
         protected override void Up(MigrationBuilder migrationBuilder)

Gui/EditorSettings.cs

@@ -1,5 +1,10 @@
+using OpenLoco.Common.Logging;
+using OpenLoco.Dat;
+using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Text.Json;
+using System.Text.Json.Serialization;
 
 namespace OpenLoco.Gui
 {
@@ -24,56 +29,81 @@ public HashSet<string> ObjDataDirectories
 		}
 		HashSet<string> objDataDirectories;
 
-		public string DataDirectory
+		public bool AutoObjectDiscoveryAndUpload { get; set; }
+
+		public bool UseHttps { get; set; }
+		public string ServerAddressHttp { get; set; } = "http://openloco.leftofzen.dev/";
+		public string ServerAddressHttps { get; set; } = "https://openloco.leftofzen.dev/";
+
+		public string DownloadFolder { get; set; } = string.Empty;
+
+		[JsonIgnore]
+		public string IndexFileName
+			=> GetObjDataFullPath(ObjectIndex.DefaultIndexFileName);
+
+		public string GetObjDataFullPath(string fileName)
+			=> Path.Combine(ObjDataDirectory, fileName);
+
+		[JsonIgnore]
+		public const string DefaultFileName = "settings.json"; // "settings-dev.json" for dev, "settings.json" for prod
+
+		[JsonIgnore]
+		static readonly JsonSerializerOptions SerializerOptions = new() { WriteIndented = true, AllowTrailingCommas = true };
+
+		public static EditorSettings Load(string filename, ILogger logger)
 		{
-			get => dataDirectory;
-			set
+			if (!File.Exists(filename))
 			{
-				dataDirectory = value;
-				DataDirectories ??= [];
-				_ = DataDirectories.Add(dataDirectory);
+				logger.Info($"Settings file doesn't exist; creating now at \"{filename}\"");
+				var newSettings = new EditorSettings();
+				Save(newSettings, filename, logger);
+				return newSettings;
 			}
-		}
-		string dataDirectory;
 
-		public HashSet<string> DataDirectories
-		{
-			get => dataDirectories ??= [];
-			set => dataDirectories = value;
+			var text = File.ReadAllText(filename);
+			var settings = JsonSerializer.Deserialize<EditorSettings>(text, options: SerializerOptions); // todo: try-catch this for invalid settings files
+			ArgumentNullException.ThrowIfNull(settings);
+			return settings;
 		}
-		HashSet<string> dataDirectories;
 
-		public string SCV5Directory
+		public void Save(string filename, ILogger logger)
+			=> Save(this, filename, logger);
+
+		static void Save(EditorSettings settings, string filename, ILogger logger)
 		{
-			get => scv5Directory;
-			set
+			var text = JsonSerializer.Serialize(settings, options: SerializerOptions);
+
+			var parentDir = Path.GetDirectoryName(filename);
+			if (parentDir != null && !Directory.Exists(parentDir))
 			{
-				scv5Directory = value;
-				SCV5Directories ??= [];
-				_ = SCV5Directories.Add(scv5Directory);
+				_ = Directory.CreateDirectory(parentDir);
 			}
-		}
-		string scv5Directory;
 
-		public HashSet<string> SCV5Directories
-		{
-			get => scv5Directories ??= [];
-			set => scv5Directories = value;
+			try
+			{
+				File.WriteAllText(filename, text);
+			}
+			catch (Exception ex)
+			{
+				logger.Error(ex);
+			}
 		}
-		HashSet<string> scv5Directories;
-
-		public bool AutoObjectDiscoveryAndUpload { get; set; }
 
-		public bool UseHttps { get; set; }
-		public string ServerAddressHttp { get; set; } = "http://openloco.leftofzen.dev/";
-		public string ServerAddressHttps { get; set; } = "https://openloco.leftofzen.dev/";
+		public bool Validate(ILogger logger)
+		{
+			if (string.IsNullOrEmpty(ObjDataDirectory))
+			{
+				logger.Warning("Invalid settings file: Object directory was null or empty");
+				return false;
+			}
 
-		public string PaletteFile { get; set; } = "palette.png";
-		public string IndexFileName { get; set; } = "objectIndex.json"; // this should be the same as ObjectIndex.IndexFileName
-		public string G1DatFileName { get; set; } = "g1.DAT";
-		public string DownloadFolder { get; set; } = string.Empty;
+			if (!Directory.Exists(ObjDataDirectory))
+			{
+				logger.Warning($"Invalid settings file: Directory \"{ObjDataDirectory}\" does not exist");
+				return false;
+			}
 
-		public string GetObjDataFullPath(string fileName) => Path.Combine(ObjDataDirectory, fileName);
-		public string GetDataFullPath(string fileName) => Path.Combine(DataDirectory, fileName);
+			return true;
+		}
 	}
 }

Gui/Models/ObjectEditorModel.cs

@@ -15,7 +15,6 @@
 using System.IO;
 using System.Linq;
 using System.Net.Http;
-using System.Text.Json;
 using System.Threading;
 using System.Threading.Tasks;
 
@@ -50,11 +49,10 @@ public class ObjectEditorModel
 		public const string ApplicationName = "OpenLoco Object Editor";
 		public const string LoggingFileName = "objectEditor.log";
 
-		public static string SettingsPath => Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), ApplicationName);
-
-		public static string SettingsFile => Path.Combine(SettingsPath, Environment.GetEnvironmentVariable("ENV_SETTINGS_FILE") ?? "settings.json"); // "settings-dev.json" for dev, "settings.json" for prod
-
-		public static string LoggingFile => Path.Combine(SettingsPath, LoggingFileName);
+		// stores settings.json, objectEditor.log, etc
+		public static string ProgramDataPath => Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), ApplicationName);
+		public static string SettingsFile => Path.Combine(ProgramDataPath, Environment.GetEnvironmentVariable("ENV_SETTINGS_FILE") ?? EditorSettings.DefaultFileName);
+		public static string LoggingFile => Path.Combine(ProgramDataPath, LoggingFileName);
 
 		public ObservableCollection<LogLine> LoggerObservableLogs = [];
 
@@ -65,9 +63,9 @@ public ObjectEditorModel()
 			Logger = new Logger();
 			LoggerObservableLogs = [];
 			Logger.LogAdded += (sender, laea) => Dispatcher.UIThread.Post(() => LoggerObservableLogs.Insert(0, laea.Log));
-			//Logger.LogAdded += (sender, laea) => File.AppendAllLines(LoggingFile, [laea.Log.ToString()]);
 
 			LoadSettings();
+			InitialiseDownloadDirectory();
 
 			var serverAddress = Settings!.UseHttps ? Settings.ServerAddressHttps : Settings.ServerAddressHttp;
 
@@ -82,38 +80,26 @@ public ObjectEditorModel()
 			}
 		}
 
-		public void LoadSettings()
+		void LoadSettings()
 		{
-			if (!File.Exists(SettingsFile))
-			{
-				Logger.Info($"Settings file doesn't exist; creating now at \"{SettingsFile}\"");
-				Settings = new();
-				SaveSettings();
-				return;
-			}
-
-			var text = File.ReadAllText(SettingsFile);
-			var settings = JsonSerializer.Deserialize<EditorSettings>(text, options: new() { WriteIndented = true }); // todo: try-catch this for invalid settings files
-			ArgumentNullException.ThrowIfNull(settings);
-
-			Settings = settings!;
-			InitialiseDownloadDirectory();
+			Settings = EditorSettings.Load(SettingsFile, Logger);
 
-			if (ValidateSettings(Settings, Logger) && File.Exists(IndexFilename))
+			if (Settings.Validate(Logger))
 			{
 				Logger.Info("Settings loaded and validated successfully.");
 			}
 			else
 			{
 				Logger.Error("Unable to validate settings file - please delete it and it will be recreated on next editor start-up.");
 			}
+
 		}
 
 		void InitialiseDownloadDirectory()
 		{
 			if (string.IsNullOrEmpty(Settings.DownloadFolder))
 			{
-				Settings.DownloadFolder = Path.Combine(SettingsPath, "downloads");
+				Settings.DownloadFolder = Path.Combine(ProgramDataPath, "downloads");
 			}
 
 			if (!Directory.Exists(Settings.DownloadFolder))
@@ -123,52 +109,6 @@ void InitialiseDownloadDirectory()
 			}
 		}
 
-		public string IndexFilename
-			=> Settings.GetObjDataFullPath(Settings.IndexFileName);
-
-		static bool ValidateSettings(EditorSettings settings, ILogger? logger)
-		{
-			if (settings == null)
-			{
-				logger?.Error("Invalid settings file: Unable to deserialise settings file");
-				return false;
-			}
-
-			if (string.IsNullOrEmpty(settings.ObjDataDirectory))
-			{
-				logger?.Warning("Invalid settings file: Object directory was null or empty");
-				return false;
-			}
-
-			if (!Directory.Exists(settings.ObjDataDirectory))
-			{
-				logger?.Warning($"Invalid settings file: Directory \"{settings.ObjDataDirectory}\" does not exist");
-				return false;
-			}
-
-			return true;
-		}
-
-		public void SaveSettings()
-		{
-			var text = JsonSerializer.Serialize(Settings, options: new() { WriteIndented = true });
-
-			var parentDir = Path.GetDirectoryName(SettingsFile);
-			if (parentDir != null && !Directory.Exists(parentDir))
-			{
-				_ = Directory.CreateDirectory(parentDir);
-			}
-
-			try
-			{
-				File.WriteAllText(SettingsFile, text);
-			}
-			catch (Exception ex)
-			{
-				Logger.Error(ex);
-			}
-		}
-
 		public bool TryLoadObject(FileSystemItem filesystemItem, out UiDatLocoFile? uiLocoFile)
 		{
 			if (string.IsNullOrEmpty(filesystemItem.Filename))
@@ -309,59 +249,6 @@ public bool TryLoadObject(FileSystemItem filesystemItem, out UiDatLocoFile? uiLo
 			return true;
 		}
 
-		public bool LoadDataDirectory(string directory)
-		{
-			if (!Directory.Exists(directory))
-			{
-				Logger.Warning("Invalid directory: doesn't exist");
-				return false;
-			}
-
-			Settings.DataDirectory = directory;
-
-			var allDataFiles = Directory.GetFiles(Settings.DataDirectory).Select(f => Path.GetFileName(f).ToLower()).ToHashSet();
-
-			void LoadKnownData(HashSet<string> allFilesInDir, HashSet<string> knownFilenames, Dictionary<string, byte[]> dict)
-			{
-				dict.Clear();
-				var expectedMusicFiles = knownFilenames.Select(f => f.ToLower());
-				foreach (var music in expectedMusicFiles)
-				{
-					var matching = allFilesInDir.Where(f => f.EndsWith(music));
-					if (matching.Any())
-					{
-						dict.Add(music, File.ReadAllBytes(Path.Combine(Settings.DataDirectory, music)));
-						_ = allFilesInDir.RemoveWhere(f => f.EndsWith(music));
-					}
-				}
-			}
-
-			LoadKnownData(allDataFiles, [.. OriginalDataFiles.Music.Keys], Music);
-			LoadKnownData(allDataFiles, [.. OriginalDataFiles.MiscellaneousTracks.Keys], MiscellaneousTracks);
-			LoadKnownData(allDataFiles, [OriginalDataFiles.SoundEffect], SoundEffects);
-			LoadKnownData(allDataFiles, OriginalDataFiles.Tutorials, Tutorials);
-
-			//MiscFiles = [.. allDataFiles];
-
-			// load G1 only for now since we need it for palette
-			//G1 = SawyerStreamReader.LoadG1(Settings.GetDataFullPath(Settings.G1DatFileName));
-
-			//LoadPalette(); // update palette from g1
-
-			//await SaveSettings();
-
-			return true;
-		}
-
-		// this method will load any supported file type
-		//public void LoadDirectory(string directory)
-		//{
-		//	var allFiles = Directory.GetFiles(directory, "*.dat|*.sv5|*.sc5", SearchOption.AllDirectories);
-		//}
-
-		//public void LoadObjDirectory(string directory)
-		//	=> LoadObjDirectory(directory, new Progress<float>(), true);
-
 		static Task? indexerTask;
 		static readonly SemaphoreSlim taskLock = new(1, 1);
 
@@ -393,15 +280,15 @@ async Task LoadObjDirectoryAsyncCore(string directory, IProgress<float> progress
 			}
 
 			Settings.ObjDataDirectory = directory;
-			SaveSettings();
+			Settings.Save(SettingsFile, Logger);
 
-			if (useExistingIndex && File.Exists(IndexFilename))
+			if (useExistingIndex && File.Exists(Settings.IndexFileName))
 			{
 				var exception = false;
 
 				try
 				{
-					ObjectIndex = await ObjectIndex.LoadIndexAsync(IndexFilename) ?? ObjectIndex;
+					ObjectIndex = await ObjectIndex.LoadIndexAsync(Settings.IndexFileName) ?? ObjectIndex;
 				}
 				catch (Exception ex)
 				{
@@ -433,7 +320,7 @@ async Task RecreateIndex(string directory, IProgress<float> progress)
 			{
 				Logger.Info("Recreating index file");
 				ObjectIndex = await ObjectIndex.CreateIndexAsync(directory, Logger, progress);
-				ObjectIndex?.SaveIndex(IndexFilename);
+				ObjectIndex?.SaveIndex(Settings.IndexFileName);
 			}
 		}
 

Gui/ViewModels/DatTypes/MusicViewModel.cs

@@ -43,7 +43,7 @@ static string GetDisplayName(string filename)
 		public override void Save()
 		{
 			var savePath = CurrentFile.FileLocation == FileLocation.Local
-				? Path.Combine(Model.Settings.DataDirectory, CurrentFile.Filename)
+				? CurrentFile.Filename
 				: Path.Combine(Model.Settings.DownloadFolder, Path.ChangeExtension(CurrentFile.DisplayName, ".dat"));
 
 			Logger?.Info($"Saving music to {savePath}");

Gui/ViewModels/DatTypes/SoundEffectsViewModel.cs

@@ -1,4 +1,4 @@
-using OpenLoco.Dat.Data;
+using OpenLoco.Dat.Data;
 using OpenLoco.Dat.FileParsing;
 using OpenLoco.Gui.Models;
 using PropertyModels.Extensions;
@@ -30,7 +30,7 @@ public override void Load()
 		public override void Save()
 		{
 			var savePath = CurrentFile.FileLocation == FileLocation.Local
-				? Path.Combine(Model.Settings.DataDirectory, CurrentFile.Filename)
+				? CurrentFile.Filename
 				: Path.Combine(Model.Settings.DownloadFolder, Path.ChangeExtension(CurrentFile.DisplayName, ".dat"));
 
 			Logger?.Info($"Saving sound effects to {savePath}");