@sie-js/vkp 1.0.0 → 1.0.2

package/examples/get-bad-patches.js

@@ -0,0 +1,122 @@
+import iconv from 'iconv-lite';
+import fs from 'fs';
+import path from 'path';
+import { Blob } from "buffer";
+import { globSync } from 'glob';
+import { vkpParse, vkpDetectContent } from '../src/index.js';
+import child_process from 'child_process';
+
+const PATCHES_DIR = `${import.meta.dirname}/../../patches/patches`;
+
+for (let file of readFiles(PATCHES_DIR)) {
+	if (!file.match(/\.vkp$/))
+		continue;
+
+	let patchText = iconv.decode(fs.readFileSync(`${PATCHES_DIR}/${file}`), 'windows1251').replace(/(\r\n|\n)/g, '\n');
+	let patchUrl = patchText.match(/Details: (https?:\/\/.*?)$/m)[1];
+
+	let detectedType = vkpDetectContent(patchText);
+	if (detectedType == "DOWNLOAD_STUB") {
+		let patchId = path.basename(file).split('-')[0];
+
+		let [additionalFile] = globSync(`${PATCHES_DIR}/*/${patchId}-*.{rar,zip}`);
+		if (!additionalFile) {
+			console.error(`${file} - is download stub, but additional file not found!`);
+			continue;
+		}
+
+		let archive = await getFilesFromArchive(additionalFile);
+
+		let extractedPatches = [];
+		for (let entry of archive.lsarContents) {
+			if (entry.XADFileName.match(/\.vkp$/i)) {
+				patchText = (await extractFileFromArchive(additionalFile, entry.XADIndex)).toString('utf-8');
+				analyzePatch(patchUrl, additionalFile, entry.XADFileName, patchText);
+			}
+		}
+	} else {
+		analyzePatch(patchUrl, file, null, patchText);
+	}
+}
+
+function analyzePatch(patchUrl, file, subfile, patchText) {
+	let location = subfile ? `${file} -> ${subfile}` : file;
+
+	let vkp = vkpParse(patchText, {
+		allowEmptyOldData:	true,
+		allowPlaceholders:	true,
+	});
+
+	if (vkp.warnings.length || vkp.errors.length) {
+		console.log(`[${location}](${patchUrl})`);
+
+		for (let warn of vkp.warnings) {
+			console.log(`Warning: ${warn.message}`);
+			console.log("```");
+			console.log(warn.codeFrame(patchText));
+			console.log("```");
+			console.log("");
+		}
+
+		for (let err of vkp.errors) {
+			console.log(`Error: ${err.message}`);
+			console.log("```");
+			console.log(err.codeFrame(patchText));
+			console.log("```");
+			console.log("");
+		}
+
+		console.log("");
+	}
+}
+
+function readFiles(dir, base, files) {
+	base = base || "";
+	files = files || [];
+	fs.readdirSync(dir, {withFileTypes: true}).forEach((entry) => {
+		if (entry.isDirectory()) {
+			readFiles(dir + "/" + entry.name, base + entry.name + "/", files);
+		} else {
+			files.push(base + entry.name);
+		}
+	});
+	return files;
+}
+
+async function getFilesFromArchive(file) {
+	return new Promise((resolve, reject) => {
+		let proc = child_process.spawn("lsar", ["-j", file], { encoding: 'utf-8' });
+		let json = "";
+		proc.stdout.on('data', (chunk) => json += chunk);
+		proc.on('error', (e) => reject(e));
+		proc.on('close', (status) => {
+			try {
+				if (status != 0)
+					throw new Error(`Invalid archive [status=${status}]: ${file}`);
+				resolve(JSON.parse(json));
+			} catch (e) {
+				reject(e);
+			}
+			proc = json = null;
+		});
+	});
+}
+
+function extractFileFromArchive(file, index) {
+	return new Promise((resolve, reject) => {
+		let proc = child_process.spawn("unar", ["-i", "-o", "-", file, index]);
+		let buffer = [];
+		proc.stdout.on('data', (chunk) => buffer.push(chunk));
+		proc.on('error', (e) => reject(e));
+		proc.on('close', (status) => {
+			try {
+				if (status != 0)
+					throw new Error(`Invalid archive [status=${status}]: ${file}`);
+				resolve(Buffer.concat(buffer));
+			} catch (e) {
+				reject(e);
+			}
+			proc = buffer = null;
+		});
+	});
+}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@sie-js/vkp",
-	"version": "1.0.0",
-	"description": "",
+	"version": "1.0.2",
+	"description": "Parser and utils for the .VKP files format which is used in the V-Klay.",
 	"main": "src/index.js",
 	"type": "module",
 	"scripts": {
@@ -18,5 +18,8 @@
 	"devDependencies": {
 		"glob": "^10.3.12",
 		"jest": "^29.7.0"
+	},
+	"repository": {
+		"url": "git+https://github.com/siemens-mobile-hacks/node-sie-vkp.git"
 	}
 }

package/src/index.js

@@ -59,7 +59,7 @@ function vkpParse(text, options) {
 			if (pragmas.old_equal_ff && !oldData)
 				oldData = Buffer.alloc(newData.length).fill(0xFF);
 
-			if (oldData&& oldData.length < newData.length)
+			if (oldData && oldData.length < newData.length)
 				vkp.errors.push(new VkpParseError(`Old data (${oldData.length} bytes) is less than new data (${newData.length} bytes)`, data.old.loc));
 
 			if (pragmas.warn_no_old_on_apply && !oldData) {
@@ -107,10 +107,10 @@ function vkpDetectContent(text) {
 	let trimmedText = text.replace(/\/\*.*?\*\//gs, '').replace(/(\/\/|;|#).*?$/mg, '');
 	if (trimmedText.match(/^\s*(0x[a-f0-9]+|[a-f0-9]+)\s*:[^\\/]/mi))
 		return "PATCH";
+	if (text.match(/;!(к патчу прикреплён файл|There is a file attached to this patch), https?:\/\//i))
+		return "DOWNLOAD_STUB";
 	if (!trimmedText.trim().length)
 		return "EMPTY";
-	if (text.match(/;!к патчу прикреплён файл, https?:\/\//i))
-		return "DOWNLOAD_STUB";
 	return "UNKNOWN";
 }