improve naming of data parts of tables and dtos

LeftofZen · LeftofZen · commit 4c161886583e · 2024-09-19T17:55:21.000+10:00
diff --git a/AvaGui/Models/Metadata.cs b/AvaGui/Models/Metadata.cs
@@ -10,12 +10,12 @@ public class MetadataModel
 	{
 		public MetadataModel(string originalName, uint originalChecksum)
 		{
-			OriginalName = originalName;
-			OriginalChecksum = originalChecksum;
+			DatName = originalName;
+			DatChecksum = originalChecksum;
 		}
 
-		public string OriginalName { get; }
-		public uint OriginalChecksum { get; }
+		public string DatName { get; }
+		public uint DatChecksum { get; }
 		public string? Description { get; set; }
 
 		public ICollection<TblAuthor> Authors { get; set; }
diff --git a/AvaGui/Models/ObjectEditorModel.cs b/AvaGui/Models/ObjectEditorModel.cs
@@ -235,7 +235,7 @@ public bool TryLoadObject(FileSystemItem filesystemItem, out UiLocoFile? uiLocoF
 						}
 					}
 
-					metadata = new MetadataModel(locoObj.OriginalName, locoObj.OriginalChecksum)
+					metadata = new MetadataModel(locoObj.DatName, locoObj.DatChecksum)
 					{
 						Description = locoObj.Description,
 						Authors = locoObj.Authors,
@@ -392,7 +392,7 @@ async Task LoadObjDirectoryAsyncCore(string directory, IProgress<float> progress
 					exception = true;
 				}
 
-				if (exception || ObjectIndex?.Objects == null || ObjectIndex.Objects.Any(x => string.IsNullOrEmpty(x.Filename) || (x is ObjectIndexEntry xx && string.IsNullOrEmpty(xx.ObjectName))))
+				if (exception || ObjectIndex?.Objects == null || ObjectIndex.Objects.Any(x => string.IsNullOrEmpty(x.Filename) || (x is ObjectIndexEntry xx && string.IsNullOrEmpty(xx.DatName))))
 				{
 					Logger.Warning("Index file format has changed or otherwise appears to be malformed - recreating now.");
 					await RecreateIndex(directory, allFiles, progress);
@@ -429,8 +429,8 @@ public async Task CheckForDatFilesNotOnServer()
 			Logger.Debug("Comparing local objects to object repository");
 
 			var localButNotOnline = ObjectIndex.Objects.ExceptBy(ObjectIndexOnline.Objects.Select(
-				x => (x.ObjectName, x.Checksum)),
-				x => (x.ObjectName, x.Checksum)).ToList();
+				x => (x.DatName, x.Checksum)),
+				x => (x.DatName, x.Checksum)).ToList();
 
 			if (localButNotOnline.Count != 0)
 			{
diff --git a/AvaGui/ViewModels/FolderTreeViewModel.cs b/AvaGui/ViewModels/FolderTreeViewModel.cs
@@ -174,7 +174,7 @@ async Task LoadOnlineDirectoryAsync(bool useExistingIndex)
 				Model.ObjectIndexOnline = new ObjectIndex()
 				{
 					Objects = (await Client.GetObjectListAsync(Model.WebClient, Model.Logger))
-					.Select(x => new ObjectIndexEntry(x.UniqueId.ToString(), x.ObjectName, x.ObjectType, x.IsVanilla, x.Checksum, x.VehicleType))
+					.Select(x => new ObjectIndexEntry(x.Id.ToString(), x.DatName, x.ObjectType, x.IsVanilla, x.DatChecksum, x.VehicleType))
 					.ToList(),
 					ObjectsFailed = []
 				};
@@ -196,7 +196,7 @@ static List<FileSystemItemBase> ConstructTreeView(IEnumerable<ObjectIndexEntryBa
 
 			var groupedObjects = index
 				.OfType<ObjectIndexEntry>() // this won't show errored files - should we??
-				.Where(o => (string.IsNullOrEmpty(filenameFilter) || o.ObjectName.Contains(filenameFilter, StringComparison.CurrentCultureIgnoreCase)) && (displayMode == ObjectDisplayMode.All || (displayMode == ObjectDisplayMode.Vanilla == o.IsVanilla)))
+				.Where(o => (string.IsNullOrEmpty(filenameFilter) || o.DatName.Contains(filenameFilter, StringComparison.CurrentCultureIgnoreCase)) && (displayMode == ObjectDisplayMode.All || (displayMode == ObjectDisplayMode.Vanilla == o.IsVanilla)))
 				.GroupBy(o => o.ObjectType)
 				.OrderBy(fsg => fsg.Key.ToString());
 
@@ -211,7 +211,7 @@ static List<FileSystemItemBase> ConstructTreeView(IEnumerable<ObjectIndexEntryBa
 						.OrderBy(vg => vg.Key.ToString()))
 					{
 						var vehicleSubNodes = new ObservableCollection<FileSystemItemBase>(vg
-							.Select(o => new FileSystemItem(o.Filename, o.ObjectName, o.IsVanilla, fileLocation))
+							.Select(o => new FileSystemItem(o.Filename, o.DatName, o.IsVanilla, fileLocation))
 							.OrderBy(o => o.Name));
 
 						if (vg.Key == null)
@@ -230,7 +230,7 @@ static List<FileSystemItemBase> ConstructTreeView(IEnumerable<ObjectIndexEntryBa
 				else
 				{
 					subNodes = new ObservableCollection<FileSystemItemBase>(objGroup
-						.Select(o => new FileSystemItem(o.Filename, o.ObjectName, o.IsVanilla, fileLocation))
+						.Select(o => new FileSystemItem(o.Filename, o.DatName, o.IsVanilla, fileLocation))
 						.OrderBy(o => o.Name));
 				}
 
diff --git a/AvaGui/Views/MainWindow.axaml b/AvaGui/Views/MainWindow.axaml
@@ -224,10 +224,10 @@
 										<RowDefinition Height="Auto"/>
 									</Grid.RowDefinitions>
 									<TextBlock Grid.Row="0" Grid.Column="0" VerticalAlignment="Center" Text="Original Name" Margin="4"/>
-									<TextBox Grid.Row="0" Grid.Column="1" VerticalAlignment="Center" Text="{Binding OriginalName}" IsReadOnly="True" Margin="4" />
+									<TextBox Grid.Row="0" Grid.Column="1" VerticalAlignment="Center" Text="{Binding DatName}" IsReadOnly="True" Margin="4" />
 
 									<TextBlock Grid.Row="1" Grid.Column="0" VerticalAlignment="Center" Text="Original Checksum" Margin="4"/>
-									<TextBox Grid.Row="1" Grid.Column="1" VerticalAlignment="Center" Text="{Binding OriginalChecksum}" IsReadOnly="True" Margin="4" />
+									<TextBox Grid.Row="1" Grid.Column="1" VerticalAlignment="Center" Text="{Binding DatChecksum}" IsReadOnly="True" Margin="4" />
 
 									<TextBlock Grid.Row="2" Grid.Column="0" VerticalAlignment="Center" Text="Description" Margin="4"/>
 									<TextBox Grid.Row="2" Grid.Column="1" VerticalAlignment="Center" Text="{Binding Description}" IsReadOnly="True" Margin="4" />
diff --git a/Common/GlenDbSchema.cs b/Common/GlenDbSchema.cs
@@ -14,7 +14,7 @@ public class GlenDBSchema2
 
 	public class GlenDbData
 	{
-		[JsonPropertyName("C00")] public string ObjectName { get; set; }
+		[JsonPropertyName("C00")] public string DatName { get; set; }
 		[JsonPropertyName("C01")] public string Image { get; set; }
 		[JsonPropertyName("C02")] public string DescriptionAndFile { get; set; }
 		[JsonPropertyName("C03")] public string ClassNumber { get; set; }
@@ -41,7 +41,7 @@ public class GlenDbData
 
 	public class GlenDbData2
 	{
-		[JsonPropertyName("C00")] public string ObjectName { get; set; }
+		[JsonPropertyName("C00")] public string DatName { get; set; }
 		[JsonPropertyName("C01")] public string Image { get; set; }
 		[JsonPropertyName("C02")] public string DescriptionAndFile { get; set; }
 		[JsonPropertyName("C03")] public string ObjectType { get; set; }
diff --git a/Dat/ObjectIndex.cs b/Dat/ObjectIndex.cs
@@ -101,7 +101,7 @@ public abstract record ObjectIndexEntryBase(string Filename);
 
 	public record ObjectIndexEntry(
 		string Filename,
-		string ObjectName,
+		string DatName,
 		ObjectType ObjectType,
 		bool IsVanilla,
 		uint32_t Checksum,
diff --git a/DatabaseExporter/Program.cs b/DatabaseExporter/Program.cs
@@ -24,11 +24,11 @@
 		.Include(l => l.Licence)
 		.Select(x => new ExpandedTblLocoObject(x, x.Authors, x.Tags, x.Modpacks))
 		.ToList()
-		.OrderBy(x => x.Object.Name))
+		.OrderBy(x => x.Object.UniqueName))
 {
 	var obj = new ObjectMetadata(
-		o.Object.OriginalName,
-		o.Object.OriginalChecksum,
+		o.Object.DatName,
+		o.Object.DatChecksum,
 		o.Object.Description,
 		o.Authors.Select(a => a.Name).ToList(),
 		o.Tags.Select(t => t.Name).ToList(),
diff --git a/DatabaseSeeder/Program.cs b/DatabaseSeeder/Program.cs
@@ -121,13 +121,13 @@ static void SeedDb(LocoDb db, bool deleteExisting)
 		var index = ObjectIndex.LoadOrCreateIndex(ObjDirectory);
 
 		var objectMetadata = JsonSerializer.Deserialize<IEnumerable<ObjectMetadata>>(File.ReadAllText("Q:\\Games\\Locomotion\\Server\\objectMetadata.json"), jsonOptions);
-		var objectMetadataDict = objectMetadata!.ToDictionary(x => (x.ObjectName, x.Checksum), x => x);
+		var objectMetadataDict = objectMetadata!.ToDictionary(x => (x.DatName, x.Checksum), x => x);
 
 		var gameReleaseDate = new DateTimeOffset(2004, 09, 07, 0, 0, 0, TimeSpan.Zero);
 
-		foreach (var objIndex in index.Objects.DistinctBy(x => (x.ObjectName, x.Checksum)))
+		foreach (var objIndex in index.Objects.DistinctBy(x => (x.DatName, x.Checksum)))
 		{
-			var metadataKey = (objIndex.ObjectName, objIndex.Checksum);
+			var metadataKey = (objIndex.DatName, objIndex.Checksum);
 			if (!objectMetadataDict.TryGetValue(metadataKey, out var meta))
 			{ }
 
@@ -141,10 +141,10 @@ static void SeedDb(LocoDb db, bool deleteExisting)
 
 			var tblLocoObject = new TblLocoObject()
 			{
-				Name = $"{objIndex.ObjectName}_{objIndex.Checksum}",  // same as server upload name
+				UniqueName = $"{objIndex.DatName}_{objIndex.Checksum}",  // same as server upload name
 				PathOnDisk = objIndex.Filename.Replace('\\', '/'), // make the path linux-compatible
-				OriginalName = objIndex.ObjectName,
-				OriginalChecksum = objIndex.Checksum,
+				DatName = objIndex.DatName,
+				DatChecksum = objIndex.Checksum,
 				IsVanilla = objIndex.IsVanilla,
 				ObjectType = objIndex.ObjectType,
 				VehicleType = objIndex.VehicleType,
@@ -168,7 +168,7 @@ static void SeedDb(LocoDb db, bool deleteExisting)
 	Console.WriteLine("Finished seeding");
 }
 
-static Dictionary<(string ObjectName, string Checksum), GlenDbData2> LoadMetadata(string metadataFile)
+static Dictionary<(string DatName, string Checksum), GlenDbData2> LoadMetadata(string metadataFile)
 {
 	if (!File.Exists(metadataFile))
 	{
@@ -177,7 +177,7 @@ static void SeedDb(LocoDb db, bool deleteExisting)
 
 	var text = File.ReadAllText(metadataFile);
 	var metadata = JsonSerializer.Deserialize<GlenDBSchema2>(text).data;
-	var kvList = metadata.GroupBy(x => (x.ObjectName, uint32_t_LittleToBigEndian(x.Checksum)));
+	var kvList = metadata.GroupBy(x => (x.DatName, uint32_t_LittleToBigEndian(x.Checksum)));
 	return kvList.ToDictionary(x => x.Key, x => x.First());
 }
 
diff --git a/Definitions/DTO/DtoLocoObject.cs b/Definitions/DTO/DtoLocoObject.cs
@@ -5,10 +5,10 @@
 namespace OpenLoco.Definitions.DTO
 {
 	public record DtoLocoObject(
-		int TblLocoObjectId,
-		string Name,
-		string OriginalName,
-		uint OriginalChecksum,
+		int Id,
+		string UniqueName,
+		string DatName,
+		uint DatChecksum,
 		string? OriginalBytes, // base64-encoded
 		bool IsVanilla,
 		ObjectType ObjectType,
diff --git a/Definitions/DTO/DtoObjectIndexEntry.cs b/Definitions/DTO/DtoObjectIndexEntry.cs
@@ -4,10 +4,10 @@
 namespace OpenLoco.Definitions.DTO
 {
 	public record DtoObjectIndexEntry(
-		int UniqueId,
-		string ObjectName,
+		int Id,
+		string DatName,
+		uint DatChecksum,
 		ObjectType ObjectType,
 		bool IsVanilla,
-		uint Checksum,
 		VehicleType? VehicleType);
 }
diff --git a/Definitions/Database/LocoDb.cs b/Definitions/Database/LocoDb.cs
@@ -34,15 +34,15 @@ public bool DoesObjectExist(S5Header s5Header, out TblLocoObject? existingObject
 
 		public bool DoesObjectExist(string originalName, uint originalChecksum, out TblLocoObject? existingObject)
 		{
-			// there's a unique constraint on the composite key index (OriginalName, OriginalChecksum), so check existence first so no exceptions
+			// there's a unique constraint on the composite key index (DatName, DatChecksum), so check existence first so no exceptions
 			// this isn't necessary since we're already filtering in LINQ, but if we were adding to a non-empty database, this would be necessary
 			var existingEntityInDb = Objects
-				.FirstOrDefault(e => e.OriginalName == originalName && e.OriginalChecksum == originalChecksum);
+				.FirstOrDefault(e => e.DatName == originalName && e.DatChecksum == originalChecksum);
 
 			var existingEntityInChangeTracker = ChangeTracker.Entries()
 				.Where(e => e.State == EntityState.Added && e.Entity.GetType() == typeof(TblLocoObject))
 				.Select(e => e.Entity as TblLocoObject)
-				.FirstOrDefault(e => e!.OriginalName == originalName && e.OriginalChecksum == originalChecksum);
+				.FirstOrDefault(e => e!.DatName == originalName && e.DatChecksum == originalChecksum);
 
 			existingObject = existingEntityInDb ?? existingEntityInChangeTracker;
 			return existingObject != null;
diff --git a/Definitions/Database/TblLocoObject.cs b/Definitions/Database/TblLocoObject.cs
@@ -5,22 +5,22 @@
 
 namespace OpenLoco.Definitions.Database
 {
-	[Index(nameof(OriginalName), nameof(OriginalChecksum), IsDescending = [true, false], IsUnique = true)]
-	[Index(nameof(Name), IsUnique = true)]
+	[Index(nameof(DatName), nameof(DatChecksum), IsDescending = [true, false], IsUnique = true)]
+	[Index(nameof(UniqueName), IsUnique = true)]
 	[Index(nameof(PathOnDisk), IsUnique = true)]
 	public class TblLocoObject
 	{
 		public int Id { get; set; }
 
-		public string Name { get; set; }
+		public string UniqueName { get; set; }
 
 		public string PathOnDisk { get; set; }
 
 		#region OriginalDatdata
 
-		public string OriginalName { get; set; }
+		public string DatName { get; set; }
 
-		public uint OriginalChecksum { get; set; }
+		public uint DatChecksum { get; set; }
 
 		#endregion
 
diff --git a/Definitions/Migrations/20240829143539_InitialCreate.Designer.cs b/Definitions/Migrations/20240829143539_InitialCreate.Designer.cs
diff --git a/Definitions/Migrations/20240829143539_InitialCreate.cs b/Definitions/Migrations/20240829143539_InitialCreate.cs
diff --git a/Definitions/Migrations/LocoDbModelSnapshot.cs b/Definitions/Migrations/LocoDbModelSnapshot.cs
diff --git a/Definitions/SourceData/ObjectMetadata.cs b/Definitions/SourceData/ObjectMetadata.cs
diff --git a/ObjectService/Server.cs b/ObjectService/Server.cs

Original file line number	Diff line number	Diff line change
`@@ -10,12 +10,12 @@ public class MetadataModel`
`10`	`10`	`{`
`11`	`11`	`public MetadataModel(string originalName, uint originalChecksum)`
`12`	`12`	`{`
`13`		`- OriginalName = originalName;`
`14`		`- OriginalChecksum = originalChecksum;`
	`13`	`+ DatName = originalName;`
	`14`	`+ DatChecksum = originalChecksum;`
`15`	`15`	`}`
`16`	`16`
`17`		`- public string OriginalName { get; }`
`18`		`- public uint OriginalChecksum { get; }`
	`17`	`+ public string DatName { get; }`
	`18`	`+ public uint DatChecksum { get; }`
`19`	`19`	`public string? Description { get; set; }`
`20`	`20`
`21`	`21`	`public ICollection<TblAuthor> Authors { get; set; }`
Original file line number	Diff line number	Diff line change
`@@ -235,7 +235,7 @@ public bool TryLoadObject(FileSystemItem filesystemItem, out UiLocoFile? uiLocoF`
`235`	`235`	`}`
`236`	`236`	`}`
`237`	`237`
`238`		`- metadata = new MetadataModel(locoObj.OriginalName, locoObj.OriginalChecksum)`
	`238`	`+ metadata = new MetadataModel(locoObj.DatName, locoObj.DatChecksum)`
`239`	`239`	`{`
`240`	`240`	`Description = locoObj.Description,`
`241`	`241`	`Authors = locoObj.Authors,`
`@@ -392,7 +392,7 @@ async Task LoadObjDirectoryAsyncCore(string directory, IProgress<float> progress`
`392`	`392`	`exception = true;`
`393`	`393`	`}`
`394`	`394`
`395`		`- if (exception \|\| ObjectIndex?.Objects == null \|\| ObjectIndex.Objects.Any(x => string.IsNullOrEmpty(x.Filename) \|\| (x is ObjectIndexEntry xx && string.IsNullOrEmpty(xx.ObjectName))))`
	`395`	`+ if (exception \|\| ObjectIndex?.Objects == null \|\| ObjectIndex.Objects.Any(x => string.IsNullOrEmpty(x.Filename) \|\| (x is ObjectIndexEntry xx && string.IsNullOrEmpty(xx.DatName))))`
`396`	`396`	`{`
`397`	`397`	`Logger.Warning("Index file format has changed or otherwise appears to be malformed - recreating now.");`
`398`	`398`	`await RecreateIndex(directory, allFiles, progress);`
`@@ -429,8 +429,8 @@ public async Task CheckForDatFilesNotOnServer()`
`429`	`429`	`Logger.Debug("Comparing local objects to object repository");`
`430`	`430`
`431`	`431`	`var localButNotOnline = ObjectIndex.Objects.ExceptBy(ObjectIndexOnline.Objects.Select(`
`432`		`- x => (x.ObjectName, x.Checksum)),`
`433`		`- x => (x.ObjectName, x.Checksum)).ToList();`
	`432`	`+ x => (x.DatName, x.Checksum)),`
	`433`	`+ x => (x.DatName, x.Checksum)).ToList();`
`434`	`434`
`435`	`435`	`if (localButNotOnline.Count != 0)`
`436`	`436`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,10 +4,10 @@`
`4`	`4`	`namespace OpenLoco.Definitions.DTO`
`5`	`5`	`{`
`6`	`6`	`public record DtoObjectIndexEntry(`
`7`		`- int UniqueId,`
`8`		`- string ObjectName,`
	`7`	`+ int Id,`
	`8`	`+ string DatName,`
	`9`	`+ uint DatChecksum,`
`9`	`10`	`ObjectType ObjectType,`
`10`	`11`	`bool IsVanilla,`
`11`		`- uint Checksum,`
`12`	`12`	`VehicleType? VehicleType);`
`13`	`13`	`}`