Add scenario tables and list route (#127)

* start adding tables

* working scenario/list route

* undo removal of semaphores for loading obj dirs

* check if downloaded file exists before writing it

Author: LeftofZen

DatabaseExporter/Program.cs

@@ -16,13 +16,15 @@
 var authors = JsonSerializer.Serialize<IEnumerable<string>>(db.Authors.Select(a => a.Name).ToList().Order(), jsonOptions);
 var tags = JsonSerializer.Serialize<IEnumerable<string>>(db.Tags.Select(t => t.Name).ToList().Order(), jsonOptions);
 var licences = JsonSerializer.Serialize<IEnumerable<LicenceJsonRecord>>(db.Licences.Select(l => new LicenceJsonRecord(l.Name, l.Text)).ToList().OrderBy(l => l.Name), jsonOptions);
-var modpacks = JsonSerializer.Serialize<IEnumerable<ModpackJsonRecord>>(db.Modpacks.Select(m => new ModpackJsonRecord(m.Name, m.Author)).ToList().OrderBy(m => m.Name), jsonOptions);
+var objectPacks = JsonSerializer.Serialize<IEnumerable<ObjectPackJsonRecord>>(db.ObjectPacks.Select(m => new ObjectPackJsonRecord(m.Name, m.Description, m.Author)).ToList().OrderBy(m => m.Name), jsonOptions);
+//var scv5Files = JsonSerializer.Serialize<IEnumerable<?>>(db.Licences.Select(l => new LicenceJsonRecord(l.Name, l.Text)).ToList().OrderBy(l => l.Name), jsonOptions);
+//var scv5FilePacks = JsonSerializer.Serialize<IEnumerable<SCV5FilePackJsonRecord>>(db.ObjectPacks.Select(m => new SCV5FilePackJsonRecord(m.Name, m.Description, m.Author)).ToList().OrderBy(m => m.Name), jsonOptions);
 
 var objs = new List<ObjectMetadata>();
 
 foreach (var o in db.Objects
 		.Include(l => l.Licence)
-		.Select(x => new ExpandedTblLocoObject(x, x.Authors, x.Tags, x.Modpacks))
+		.Select(x => new ExpandedTblLocoObject(x, x.Authors, x.Tags, x.ObjectPacks))
 		.ToList()
 		.OrderBy(x => x.Object.UniqueName))
 {
@@ -33,7 +35,7 @@
 		o.Object.Description,
 		o.Authors.Select(a => a.Name).ToList(),
 		o.Tags.Select(t => t.Name).ToList(),
-		o.Modpacks.Select(m => m.Name).ToList(),
+		o.ObjectPacks.Select(m => m.Name).ToList(),
 		o.Object.Licence?.Name,
 		o.Object.Availability,
 		o.Object.ObjectSource);
@@ -47,7 +49,9 @@
 File.WriteAllText("Q:\\Games\\Locomotion\\Database\\authors.json", authors);
 File.WriteAllText("Q:\\Games\\Locomotion\\Database\\tags.json", tags);
 File.WriteAllText("Q:\\Games\\Locomotion\\Database\\licences.json", licences);
-File.WriteAllText("Q:\\Games\\Locomotion\\Database\\modpacks.json", modpacks);
+File.WriteAllText("Q:\\Games\\Locomotion\\Database\\objectPacks.json", objectPacks);
 File.WriteAllText("Q:\\Games\\Locomotion\\Database\\objectMetadata.json", objects);
+//File.WriteAllText("Q:\\Games\\Locomotion\\Database\\scv5Files.json", objectPacks);
+//File.WriteAllText("Q:\\Games\\Locomotion\\Database\\scv5FilePacks.json", objects);
 
 Console.WriteLine("done");

DatabaseSeeder/Program.cs

@@ -41,7 +41,7 @@ static void SeedDb(LocoDb db, bool deleteExisting)
 		Console.WriteLine("Clearing database");
 		_ = db.Objects.ExecuteDelete();
 		_ = db.Tags.ExecuteDelete();
-		_ = db.Modpacks.ExecuteDelete();
+		_ = db.ObjectPacks.ExecuteDelete();
 		_ = db.Authors.ExecuteDelete();
 		_ = db.Licences.ExecuteDelete();
 		_ = db.SaveChanges(); // not necessary since ExecuteDelete auto-saves
@@ -98,14 +98,14 @@ static void SeedDb(LocoDb db, bool deleteExisting)
 
 	// ...
 
-	if (!db.Modpacks.Any())
+	if (!db.ObjectPacks.Any())
 	{
-		Console.WriteLine("Seeding Modpacks");
+		Console.WriteLine("Seeding ObjectPacks");
 
-		var modpacks = JsonSerializer.Deserialize<IEnumerable<ModpackJsonRecord>>(File.ReadAllText("Q:\\Games\\Locomotion\\Server\\modpacks.json"), jsonOptions);
+		var modpacks = JsonSerializer.Deserialize<IEnumerable<ObjectPackJsonRecord>>(File.ReadAllText("Q:\\Games\\Locomotion\\Server\\objectPacks.json"), jsonOptions);
 		if (modpacks != null)
 		{
-			db.AddRange(modpacks.Select(x => new TblModpack() { Name = x.Name, Author = x.Author == null ? null : db.Authors.Single(a => a.Name == x.Author) }));
+			db.AddRange(modpacks.Select(x => new TblLocoObjectPack() { Name = x.Name, Author = x.Author == null ? null : db.Authors.Single(a => a.Name == x.Author) }));
 			_ = db.SaveChanges();
 		}
 	}
@@ -139,7 +139,7 @@ static void SeedDb(LocoDb db, bool deleteExisting)
 
 			var authors = meta.Authors == null ? null : db.Authors.Where(x => meta.Authors.Contains(x.Name)).ToList();
 			var tags = meta.Tags == null ? null : db.Tags.Where(x => meta.Tags.Contains(x.Name)).ToList();
-			var modpacks = meta.Modpacks == null ? null : db.Modpacks.Where(x => meta.Modpacks.Contains(x.Name)).ToList();
+			var objectPacks = meta.ObjectPacks == null ? null : db.ObjectPacks.Where(x => meta.ObjectPacks.Contains(x.Name)).ToList();
 			var licence = meta.Licence == null ? null : db.Licences.Where(x => x.Name == meta.Licence).First();
 
 			var tblLocoObject = new TblLocoObject()
@@ -156,7 +156,7 @@ static void SeedDb(LocoDb db, bool deleteExisting)
 				LastEditDate = null,
 				UploadDate = DateTimeOffset.Now,
 				Tags = tags ?? [],
-				Modpacks = modpacks ?? [],
+				ObjectPacks = objectPacks ?? [],
 				Availability = meta!.ObjectAvailability,
 				Licence = licence,
 			};

Definitions/DTO/DtoDatObjectWithMetadata.cs

@@ -19,7 +19,7 @@ public record DtoDatObjectWithMetadata(
 		DateTimeOffset? LastEditDate,
 		DateTimeOffset UploadDate,
 		ICollection<TblTag> Tags,
-		ICollection<TblModpack> Modpacks,
+		ICollection<TblLocoObjectPack> ObjectPacks,
 		ObjectAvailability Availability,
 		TblLicence? Licence);
 }

Definitions/Database/LocoDb.cs

@@ -7,9 +7,11 @@ public class LocoDb : DbContext
 	{
 		public DbSet<TblAuthor> Authors => Set<TblAuthor>();
 		public DbSet<TblTag> Tags => Set<TblTag>();
-		public DbSet<TblModpack> Modpacks => Set<TblModpack>();
 		public DbSet<TblLocoObject> Objects => Set<TblLocoObject>();
+		public DbSet<TblLocoObjectPack> ObjectPacks => Set<TblLocoObjectPack>();
 		public DbSet<TblLicence> Licences => Set<TblLicence>();
+		public DbSet<TblSCV5File> SCV5Files => Set<TblSCV5File>();
+		public DbSet<TblSCV5FilePack> SCV5FilePacks => Set<TblSCV5FilePack>();
 
 		public LocoDb()
 		{ }
@@ -25,9 +27,15 @@ protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
 			}
 		}
 
-		protected override void OnModelCreating(ModelBuilder modelBuilder) => modelBuilder.Entity<TblLocoObject>()
-			.Property(b => b.UploadDate)
-			.HasDefaultValueSql("datetime(datetime('now', 'localtime'), 'utc')"); // this is necessary, it seems like a bug in sqlite
+		protected override void OnModelCreating(ModelBuilder modelBuilder)
+		{
+			modelBuilder.Entity<TblLocoObject>()
+				.Property(b => b.UploadDate)
+				.HasDefaultValueSql("datetime(datetime('now', 'localtime'), 'utc')"); // this is necessary, it seems like a bug in sqlite
+			modelBuilder.Entity<TblSCV5File>()
+				.Property(b => b.UploadDate)
+				.HasDefaultValueSql("datetime(datetime('now', 'localtime'), 'utc')"); // this is necessary, it seems like a bug in sqlite
+		}
 
 		public bool DoesObjectExist(S5Header s5Header, out TblLocoObject? existingObject)
 		 => DoesObjectExist(s5Header.Name, s5Header.Checksum, out existingObject);

Definitions/Database/TblAuthor.cs

@@ -3,7 +3,7 @@ namespace OpenLoco.Definitions.Database
 	public class TblAuthor
 	{
 		public int Id { get; set; }
-		public string Name { get; set; }
+		public required string Name { get; set; }
 
 		public ICollection<TblLocoObject> Objects { get; set; }
 	}

Definitions/Database/TblLocoObject.cs

@@ -13,7 +13,7 @@ public class TblLocoObject
 
 		public required string UniqueName { get; set; }
 
-		#region OriginalDatdata
+		#region OriginalDatData
 
 		public required string DatName { get; set; }
 
@@ -42,7 +42,7 @@ public class TblLocoObject
 
 		public ICollection<TblTag> Tags { get; set; }
 
-		public ICollection<TblModpack> Modpacks { get; set; }
+		public ICollection<TblLocoObjectPack> ObjectPacks { get; set; } // aka modpack
 
 		public ObjectAvailability Availability { get; set; }
 

Definitions/Database/TblModpack.cs renamed to Definitions/Database/TblLocoObjectPack.cs

@@ -3,11 +3,13 @@
 namespace OpenLoco.Definitions.Database
 {
 	[Index(nameof(Name), IsUnique = true)]
-	public class TblModpack
+	public class TblLocoObjectPack
 	{
 		public int Id { get; set; }
 
-		public string Name { get; set; }
+		public required string Name { get; set; }
+
+		public string? Description { get; set; }
 
 		public TblAuthor? Author { get; set; }
 

Definitions/Database/TblSCV5File.cs

@@ -0,0 +1,42 @@
+using Microsoft.EntityFrameworkCore;
+using OpenLoco.Dat.Data;
+using System.ComponentModel.DataAnnotations.Schema;
+
+namespace OpenLoco.Definitions.Database
+{
+	[Index(nameof(DatName), nameof(DatChecksum), IsDescending = [true, false], IsUnique = true)]
+	[Index(nameof(UniqueName), IsUnique = true)]
+	public class TblSCV5File
+	{
+		public int Id { get; set; }
+
+		public required string UniqueName { get; set; }
+
+		#region OriginalDatData
+
+		public required string DatName { get; set; }
+
+		public required uint DatChecksum { get; set; }
+
+		#endregion
+
+		public ObjectSource ObjectSource { get; set; }
+
+		public string? Description { get; set; }
+
+		public ICollection<TblAuthor> Authors { get; set; }
+
+		public DateTimeOffset? CreationDate { get; set; }
+
+		public DateTimeOffset? LastEditDate { get; set; }
+
+		[DatabaseGenerated(DatabaseGeneratedOption.Computed)]
+		public DateTimeOffset UploadDate { get; set; }
+
+		public ICollection<TblTag> Tags { get; set; }
+
+		public ICollection<TblSCV5FilePack> SCV5FilePacks { get; set; }
+
+		public TblLicence? Licence { get; set; }
+	}
+}

Definitions/Database/TblSCV5FilePack.cs

@@ -0,0 +1,18 @@
+using Microsoft.EntityFrameworkCore;
+
+namespace OpenLoco.Definitions.Database
+{
+	[Index(nameof(Name), IsUnique = true)]
+	public class TblSCV5FilePack
+	{
+		public required int Id { get; set; }
+
+		public required string Name { get; set; }
+
+		public string? Description { get; set; }
+
+		public TblAuthor? Author { get; set; }
+
+		public ICollection<TblSCV5File> Files { get; set; }
+	}
+}

Definitions/SourceData/ExpandedTblLocoObject.cs

@@ -3,5 +3,5 @@
 namespace OpenLoco.Definitions.SourceData
 {
 	// this must be done because eager-loading related many-to-many data in entity framework is recursive and cannot be turned off...
-	public record ExpandedTblLocoObject(TblLocoObject Object, ICollection<TblAuthor> Authors, ICollection<TblTag> Tags, ICollection<TblModpack> Modpacks);
+	public record ExpandedTblLocoObject(TblLocoObject Object, ICollection<TblAuthor> Authors, ICollection<TblTag> Tags, ICollection<TblLocoObjectPack> ObjectPacks);
 }