Experimental BDBD support

Author: Marlamin

DBCD.Tests/ReadingTest.cs

@@ -81,6 +81,16 @@ public void TestWDC5Reading()
             Assert.AreEqual("Dragon Isles", row["MapName_lang"]);
         }
 
+        [TestMethod]
+        public void TestWDC5ReadingBDBDNoCache()
+        {
+            DBCD dbcd = new(wagoDBCProvider, GithubBDBDProvider.GetStream(true));
+            IDBCDStorage storage = dbcd.Load("Map", "10.2.5.52432");
+
+            var row = storage[2574];
+            Assert.AreEqual("Dragon Isles", row["MapName_lang"]);
+        }
+
         [TestMethod]
         public void TestSparseReading()
         {
@@ -110,7 +120,7 @@ public void TestEncryptedInfo()
 
             foreach (var section in storage.GetEncryptedSections())
             {
-                System.Console.WriteLine($"Found encrypted section encrypted with key {section.Key} containing {section.Value} rows");
+                Console.WriteLine($"Found encrypted section encrypted with key {section.Key} containing {section.Value} rows");
             }
         }
 

DBCD/DBCD.cs

@@ -1,6 +1,9 @@
-using DBCD.Providers;
 using DBCD.IO;
+using DBCD.Providers;
+using DBDefsLib;
 using System;
+using System.Collections.Generic;
+using System.IO;
 
 namespace DBCD
 {
@@ -9,21 +12,65 @@ public class DBCD
     {
         private readonly IDBCProvider dbcProvider;
         private readonly IDBDProvider dbdProvider;
+
+        private readonly bool useBDBD;
+        private readonly Dictionary<string, Structs.TableInfo> BDBDCache;
+
+        /// <summary>
+        /// Creates a DBCD instance that uses the given DBC and DBD providers.
+        /// </summary>
+        /// <param name="dbcProvider">The IDBCProvider for DBC files.</param>
+        /// <param name="dbdProvider">The IDBDProvider for DBD files.</param>
         public DBCD(IDBCProvider dbcProvider, IDBDProvider dbdProvider)
         {
             this.dbcProvider = dbcProvider;
             this.dbdProvider = dbdProvider;
+            this.useBDBD = false;
         }
 
+        /// <summary>
+        /// Creates a DBCD instance that uses the given DBC provider and BDBD stream.
+        /// </summary>
+        /// <param name="dbcProvider">The IDBCProvider for DBC files.</param>
+        /// <param name="bdbdStream">The stream for a BDBD (Binary DBD) file to load all definitions from.</param>
+        public DBCD(IDBCProvider dbcProvider, Stream bdbdStream)
+        {
+            this.dbcProvider = dbcProvider;
+            this.useBDBD = true;
+            this.BDBDCache = BDBDReader.Read(bdbdStream);
+        }
+
+        /// <summary>
+        /// Loads a table by its name, and optionally build/locale.
+        /// </summary>
+        /// <param name="tableName">The name of the DBC/DB2 table to load.</param>
+        /// <param name="build">The source build of the table formatted as x.x.x.xxxxx (optional, recommended in general but required for tables older than Legion).</param>
+        /// <param name="locale">The locale to use (optional, recommended for DBC files from WotLK or older).</param>
+        /// <returns>An instance of <see cref="IDBCDStorage"/> representing the loaded table.</returns>
         public IDBCDStorage Load(string tableName, string build = null, Locale locale = Locale.None)
         {
             var dbcStream = this.dbcProvider.StreamForTableName(tableName, build);
-            var dbdStream = this.dbdProvider.StreamForTableName(tableName, build);
+
+            Structs.DBDefinition databaseDefinition;
+
+            if (!useBDBD)
+            {
+                var dbdStream = this.dbdProvider.StreamForTableName(tableName, build);
+                var dbdReader = new DBDReader();
+                databaseDefinition = dbdReader.Read(dbdStream);
+            }
+            else
+            {
+                if (!BDBDCache.TryGetValue(tableName, out var tableInfo))
+                    throw new FileNotFoundException($"Table {tableName} not found in BDBD.");
+
+                databaseDefinition = tableInfo.dbd;
+            }
 
             var builder = new DBCDBuilder(locale);
 
             var dbReader = new DBParser(dbcStream);
-            var definition = builder.Build(dbReader, dbdStream, tableName, build);
+            var definition = builder.Build(dbReader, databaseDefinition, tableName, build);
 
             var type = typeof(DBCDStorage<>).MakeGenericType(definition.Item1);
 

DBCD/DBCDBuilder.cs

@@ -35,16 +35,10 @@ internal DBCDBuilder(Locale locale = Locale.None)
             this.locale = locale;
         }
 
-        internal Tuple<Type, DBCDInfo> Build(DBParser dbcReader, Stream dbd, string name, string build)
+        internal Tuple<Type, DBCDInfo> Build(DBParser dbcReader, Structs.DBDefinition databaseDefinition, string name, string build)
         {
-            var dbdReader = new DBDReader();
-
             if (name == null)
-            {
                 name = Guid.NewGuid().ToString();
-            }
-
-            var databaseDefinition = dbdReader.Read(dbd);
 
             Structs.VersionDefinitions? versionDefinition = null;
 

DBCD/Providers/GithubBDBDProvider.cs

@@ -0,0 +1,47 @@
+using System;
+using System.IO;
+using System.Net.Http;
+
+namespace DBCD.Providers
+{
+    public static class GithubBDBDProvider
+    {
+        public static string BDBDUrl = "https://github.com/wowdev/WoWDBDefs/releases/latest/download/all.bdbd";
+
+        private static string CachePath { get; } = "BDBDCache/";
+        private static readonly TimeSpan CacheExpiryTime = new TimeSpan(1, 0, 0, 0);
+
+        public static Stream GetStream(bool forceNew = false)
+        {
+            var currentFile = Path.Combine(CachePath, "all.bdbd");
+            if (File.Exists(currentFile))
+            {
+                var fileInfo = new FileInfo(currentFile);
+                if (fileInfo.Length == 0)
+                {
+                    File.Delete(currentFile);
+                }
+                else
+                {
+                    if (!forceNew && DateTime.Now - fileInfo.LastWriteTime < CacheExpiryTime)
+                        return new MemoryStream(File.ReadAllBytes(currentFile));
+                }
+            }
+
+            if (!Directory.Exists(CachePath))
+                Directory.CreateDirectory(CachePath);
+
+            var bdbdStream = new MemoryStream();
+            using (var fileStream = new FileStream(currentFile, FileMode.Create, FileAccess.Write))
+            using (var client = new HttpClient())
+            {
+                var response = client.GetAsync(BDBDUrl).Result;
+                response.EnsureSuccessStatusCode();
+                response.Content.CopyToAsync(bdbdStream).Wait();
+                bdbdStream.CopyTo(fileStream);
+                bdbdStream.Position = 0;
+            }
+            return bdbdStream;
+        }
+    }
+}

Directory.Build.props

@@ -2,7 +2,7 @@
   <PropertyGroup>
     <DebugType>embedded</DebugType>
     <LangVersion>latest</LangVersion>
-    <Version>2.1.2</Version>
+    <Version>2.1.3</Version>
   </PropertyGroup>
   <PropertyGroup>
     <Authors>WoWDev</Authors>