@rhyster/wow-casc-dbc 2.7.6 → 2.8.1

package/dist/parsers/installFile.d.ts

@@ -0,0 +1,19 @@
+interface InstallTag {
+    name: string;
+    type: number;
+    files: boolean[];
+}
+interface InstallFile {
+    name: string;
+    hash: string;
+    size: number;
+    tags: InstallTag[];
+}
+interface InstallData {
+    tags: InstallTag[];
+    files: InstallFile[];
+}
+declare const parseInstallFile: (inputBuffer: Buffer, eKey: string, cKey: string) => InstallData;
+export default parseInstallFile;
+export type { InstallFile, InstallData };
+//# sourceMappingURL=installFile.d.ts.map

package/dist/parsers/installFile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"installFile.d.ts","sourceRoot":"","sources":["../../src/parsers/installFile.ts"],"names":[],"mappings":"AAcA,UAAU,UAAU;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,EAAE,CAAC;CACpB;AAED,UAAU,WAAW;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,UAAU,EAAE,CAAC;CACtB;AAED,UAAU,WAAW;IACjB,IAAI,EAAE,UAAU,EAAE,CAAC;IACnB,KAAK,EAAE,WAAW,EAAE,CAAC;CACxB;AAED,QAAA,MAAM,gBAAgB,gBAAiB,MAAM,QAAQ,MAAM,QAAQ,MAAM,KAAG,WA4E3E,CAAC;AAEF,eAAe,gBAAgB,CAAC;AAEhC,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhyster/wow-casc-dbc",
-  "version": "2.7.6",
+  "version": "2.8.1",
   "description": "Fetch World of Warcraft data files from CASC and parse DBC/DB2 files.",
   "type": "module",
   "exports": {
@@ -38,10 +38,10 @@
   "author": "Rhythm",
   "license": "MIT",
   "devDependencies": {
-    "@rhyster/eslint-config": "^1.6.12",
+    "@rhyster/eslint-config": "^1.6.13",
     "@types/async": "^3.2.24",
     "@types/cli-progress": "^3.11.6",
-    "@types/node": "^22.10.2",
+    "@types/node": "^22.10.3",
     "eslint": "^9.17.0",
     "tsx": "^4.19.2",
     "typescript": "^5.7.2",

package/src/client.ts

@@ -15,6 +15,7 @@ import getNameHash from './jenkins96.ts';
 import parseArchiveIndex from './parsers/archiveIndex.ts';
 import { parseCDNConfig, parseBuildConfig } from './parsers/config.ts';
 import parseEncodingFile from './parsers/encodingFile.ts';
+import parseInstallFile from './parsers/installFile.ts';
 import { parseProductVersions, parseProductCDNs } from './parsers/productConfig.ts';
 import parseRootFile, { LocaleFlags, ContentFlags } from './parsers/rootFile.ts';
 import { resolveCDNHost, formatFileSize } from './utils.ts';
@@ -24,6 +25,7 @@ import type ADBReader from './adb.ts';
 import type { MissingKeyBlock } from './blte.ts';
 import type { ArchiveIndex } from './parsers/archiveIndex.ts';
 import type { EncodingData } from './parsers/encodingFile.ts';
+import type { InstallFile, InstallData } from './parsers/installFile.ts';
 import type { Version } from './parsers/productConfig.ts';
 import type { FileInfo, RootData } from './parsers/rootFile.ts';
 
@@ -32,6 +34,7 @@ interface ClientPreloadData {
     archives: Map<string, ArchiveIndex>,
     encoding: EncodingData,
     rootFile: RootData,
+    install: InstallData,
 }
 
 interface FileFetchResultFull {
@@ -196,11 +199,23 @@ export default class CASCClient {
         const encoding = parseEncodingFile(encodingBuffer, encodingEKey, encodingCKey);
         this.log(LogLevel.info, `Parsed encoding table (${encoding.cKey2EKey.size.toString()} entries)`);
 
+        const getBuildConfigKeys = (configText: string): [string, string] => {
+            if (configText.includes(' ')) {
+                const [cKey, eKey] = configText.split(' ');
+                return [cKey, eKey];
+            }
+
+            const cKey = configText;
+            const eKeys = encoding.cKey2EKey.get(cKey);
+            assert(eKeys !== undefined, `Failing to find encoding key for ${cKey}`);
+
+            const eKey = typeof eKeys === 'string' ? eKeys : eKeys[0];
+
+            return [cKey, eKey];
+        };
+
         this.log(LogLevel.info, 'Loading root table...');
-        const rootCKey = buildConfig.root;
-        const rootEKeys = encoding.cKey2EKey.get(rootCKey);
-        assert(rootEKeys !== undefined, 'Failing to find EKey for root table.');
-        const rootEKey = typeof rootEKeys === 'string' ? rootEKeys : rootEKeys[0];
+        const [rootCKey, rootEKey] = getBuildConfigKeys(buildConfig.root);
         const rootBuffer = await getDataFile(prefixes, rootEKey, 'build', this.version.BuildConfig, {
             name: 'root',
             showProgress: this.logLevel >= LogLevel.info,
@@ -212,11 +227,25 @@ export default class CASCClient {
         const rootFile = parseRootFile(rootBuffer, rootEKey, rootCKey);
         this.log(LogLevel.info, `Parsed root file (${rootFile.fileDataID2CKey.size.toString()} entries, ${rootFile.nameHash2FileDataID.size.toString()} hashes)`);
 
+        this.log(LogLevel.info, 'Loading install manifest...');
+        const [installCKey, installEKey] = getBuildConfigKeys(buildConfig.install);
+        const installBuffer = await getDataFile(prefixes, installEKey, 'build', this.version.BuildConfig, {
+            name: 'install',
+            showProgress: this.logLevel >= LogLevel.info,
+            showAttemptFail: this.logLevel >= LogLevel.warn,
+        });
+        this.log(LogLevel.info, `Loaded install manifest (${formatFileSize(installBuffer.byteLength)})`);
+
+        this.log(LogLevel.info, 'Parsing install manifest...');
+        const install = parseInstallFile(installBuffer, installEKey, installCKey);
+        this.log(LogLevel.info, `Parsed install manifest (${install.tags.length.toString()} tags, ${install.files.length.toString()} files)`);
+
         this.preload = {
             prefixes,
             archives,
             encoding,
             rootFile,
+            install,
         };
     }
 
@@ -337,6 +366,14 @@ export default class CASCClient {
         return rootFile.fileDataID2CKey.get(fileDataID);
     }
 
+    getContentKeysFromInstall(name: string): InstallFile[] | undefined {
+        assert(this.preload, 'Client not initialized');
+
+        const { install } = this.preload;
+
+        return install.files.filter((file) => file.name === name);
+    }
+
     async getFileByContentKey(cKey: string, allowMissingKey?: false): Promise<FileFetchResultFull>;
     async getFileByContentKey(cKey: string, allowMissingKey: true): Promise<FileFetchResult>;
     async getFileByContentKey(cKey: string, allowMissingKey = false): Promise<FileFetchResult> {
@@ -402,6 +439,8 @@ export type {
     ClientPreloadData,
     ArchiveIndex,
     EncodingData,
+    InstallFile,
+    InstallData,
     RootData,
     FileInfo,
     FileFetchResultFull,

package/src/dbd.ts

@@ -135,8 +135,8 @@ export default class DBDParser {
         const versionChunk = chunks.find((chunk) => chunk.find((line) => {
             const layoutsMatch = PATTERN_LAYOUT.exec(line);
             const layouts = layoutsMatch?.[1].split(',').map((v) => v.trim().toLowerCase());
-            return layouts?.includes(layoutHashHex);
-        }));
+            return layouts?.includes(layoutHashHex) === true;
+        }) !== undefined);
 
         assert(versionChunk, `No version definition found for layout hash ${layoutHashHex}`);
 

package/src/index.ts

@@ -11,6 +11,8 @@ export type {
     ClientPreloadData,
     ArchiveIndex,
     EncodingData,
+    InstallFile,
+    InstallData,
     RootData,
     FileInfo,
     FileFetchResultFull,

package/src/parsers/installFile.ts

@@ -0,0 +1,113 @@
+import assert from 'node:assert';
+import crypto from 'node:crypto';
+
+import BLTEReader from '../blte.ts';
+
+const INSTALL_MAGIC = 0x494e;
+
+const MAGIC_OFFSET = 0;
+const VERSION_OFFSET = 2;
+const HASH_SIZE_OFFSET = 3;
+const NUM_TAGS_OFFSET = 4;
+const NUM_ENTRIES_OFFSET = 6;
+const TAGS_OFFSET = 10;
+
+interface InstallTag {
+    name: string,
+    type: number,
+    files: boolean[],
+}
+
+interface InstallFile {
+    name: string,
+    hash: string,
+    size: number,
+    tags: InstallTag[],
+}
+
+interface InstallData {
+    tags: InstallTag[],
+    files: InstallFile[],
+}
+
+const parseInstallFile = (inputBuffer: Buffer, eKey: string, cKey: string): InstallData => {
+    const reader = new BLTEReader(inputBuffer, eKey);
+    reader.processBytes();
+
+    const { buffer } = reader;
+
+    const installHash = crypto.createHash('md5').update(buffer).digest('hex');
+    assert(installHash === cKey, `Invalid root hash: expected ${cKey}, got ${installHash}`);
+
+    const magic = buffer.readUInt16BE(MAGIC_OFFSET);
+    assert(magic === INSTALL_MAGIC, `Invalid install magic: ${magic.toString(16).padStart(4, '0')}`);
+
+    const version = buffer.readUInt8(VERSION_OFFSET);
+    const hashSize = buffer.readUInt8(HASH_SIZE_OFFSET);
+    const numTags = buffer.readUInt16BE(NUM_TAGS_OFFSET);
+    const numEntries = buffer.readUInt32BE(NUM_ENTRIES_OFFSET);
+
+    assert(version === 1, `Invalid install version: ${version.toString()}`);
+
+    let pointer = TAGS_OFFSET;
+
+    const tags: InstallTag[] = [];
+    for (let i = 0; i < numTags; i += 1) {
+        const startOffset = pointer;
+        while (buffer[pointer] !== 0x00) {
+            pointer += 1;
+        }
+
+        const name = buffer.toString('utf-8', startOffset, pointer);
+        pointer += 1;
+
+        const type = buffer.readUInt16BE(pointer);
+        pointer += 2;
+
+        const files = [];
+        const finalOffset = pointer + Math.ceil(numEntries / 8);
+        while (pointer < finalOffset) {
+            const byte = buffer.readUInt8(pointer);
+            pointer += 1;
+
+            for (let j = 7; j >= 0; j -= 1) {
+                // eslint-disable-next-line no-bitwise
+                files.push((byte & (1 << j)) > 0);
+            }
+        }
+
+        tags.push({ name, type, files });
+    }
+
+    const files: InstallFile[] = [];
+    for (let i = 0; i < numEntries; i += 1) {
+        const startOffset = pointer;
+        while (buffer[pointer] !== 0x00) {
+            pointer += 1;
+        }
+
+        const name = buffer.toString('utf-8', startOffset, pointer);
+        pointer += 1;
+
+        const hash = buffer.toString('hex', pointer, pointer + hashSize);
+        pointer += hashSize;
+
+        const size = buffer.readUInt32BE(pointer);
+        pointer += 4;
+
+        const fileTags = tags.filter((tag) => tag.files[i]);
+
+        files.push({
+            name,
+            hash,
+            size,
+            tags: fileTags,
+        });
+    }
+
+    return { tags, files };
+};
+
+export default parseInstallFile;
+
+export type { InstallFile, InstallData };