@sie-js/vkp 1.0.6 → 2.0.1

package/.prettierrc.json

@@ -1,21 +0,0 @@
-{
-	"arrowParens": "always",
-	"bracketSameLine": false,
-	"bracketSpacing": true,
-	"semi": true,
-	"experimentalTernaries": false,
-	"singleQuote": false,
-	"jsxSingleQuote": false,
-	"quoteProps": "as-needed",
-	"trailingComma": "none",
-	"singleAttributePerLine": false,
-	"htmlWhitespaceSensitivity": "css",
-	"vueIndentScriptAndStyle": false,
-	"proseWrap": "preserve",
-	"insertPragma": false,
-	"printWidth": 200,
-	"requirePragma": false,
-	"tabWidth": 4,
-	"useTabs": true,
-	"embeddedLanguageFormatting": "auto"
-}

package/examples/get-bad-patches.js

@@ -1,122 +0,0 @@
-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/jest.config.js

@@ -1,4 +0,0 @@
-const config = {
-	transform: {},
-};
-export default config;

package/src/VkpParseError.js

@@ -1,68 +0,0 @@
-export class VkpParseError extends Error {
-	loc;
-	hint;
-	constructor(message, loc, hint) {
-		super(`${message} at line ${loc.line} col ${loc.column}${hint ? "\n" + hint : ""}`);
-		this.name = "VkpParseError";
-		this.loc = loc;
-	}
-
-	codeFrame(text) {
-		return codeFrame(text, this.loc.line, this.loc.column);
-	}
-};
-
-export function codeFrame(text, lineNum, colNum) {
-	let lines = text.split(/\r\n|\n/);
-	let maxLineNumLen = lines.length.toString().length + 1;
-	let out = "";
-	let n = 1;
-	for (let line of lines) {
-		if (Math.abs(n - lineNum) > 3) {
-			n++;
-			continue;
-		}
-		out += `${n == lineNum ? '>' : ' '}${n.toString().padStart(maxLineNumLen, ' ')} | ${tab2spaces(line)}\n`;
-		if (n == lineNum) {
-			out += ` ${" ".repeat(maxLineNumLen, ' ')} | ${str2spaces(line.substr(0, colNum - 1))}^\n`;
-		}
-		n++;
-	}
-	return out;
-}
-
-export function getLocByOffset(text, offset) {
-	let line = 0;
-	let column = 1;
-	for (let i = 0; i < text.length; i++) {
-		let c = text.charAt(i);
-		if (c == "\n" || (c == "\r" && text.charAt(i + 1) == "\n")) {
-			column = 1;
-			line++;
-		}
-		if (i == offset)
-			return { line, column };
-	}
-	return { line, column: 1 };
-}
-
-function str2spaces(line) {
-	return tab2spaces(line).replace(/./g, ' ');
-}
-
-function tab2spaces(line) {
-	let newStr = "";
-	let virtualSymbols = 0;
-	for (let i = 0; i < line.length; i++) {
-		let c = line.charAt(i);
-		if (c == "\t") {
-			let spacesCnt = 4 - virtualSymbols % 4;
-			newStr += " ".repeat(spacesCnt);
-			virtualSymbols += spacesCnt;
-		} else {
-			virtualSymbols++;
-			newStr += c;
-		}
-	}
-	return newStr;
-}

package/src/index.js

@@ -1,171 +0,0 @@
-import iconv from 'iconv-lite';
-import { vkpRawParser } from './parser.js';
-import { VkpParseError } from './VkpParseError.js';
-import RTFParser from 'rtf-parser';
-
-const DEFAULT_PRAGMAS = {
-	warn_no_old_on_apply:		true,
-	warn_if_new_exist_on_apply:	true,
-	warn_if_old_exist_on_undo:	true,
-	undo:						true,
-	old_equal_ff:				false,
-};
-
-function vkpParse(text, options) {
-	options = {
-		allowEmptyOldData:	false,
-		allowPlaceholders:	false,
-		...options
-	};
-
-	let vkp = {
-		ast: null,
-		valid: false,
-		writes: [],
-		warnings: [],
-		errors: [],
-	};
-
-	let pragmas = {...DEFAULT_PRAGMAS};
-	let pragma2loc = {};
-	let offsetCorrector;
-
-	vkpRawParser(text, {
-		onPragma(value, loc) {
-			if (value.pragma.action == "enable") {
-				if (pragmas[value.pragma.name]) {
-					vkp.warnings.push(new VkpParseError(`Useless "#pragma ${value.pragma.action} ${value.pragma.name}" has no effect`, loc, `You can safely remove this line.`));
-				} else {
-					pragmas[value.pragma.name] = true;
-					pragma2loc[value.pragma.name] = loc;
-				}
-			} else if (value.pragma.action == "disable") {
-				if (!pragmas[value.pragma.name]) {
-					vkp.warnings.push(new VkpParseError(`Useless "#pragma ${value.pragma.action} ${value.pragma.name}" has no effect`, loc, `You can safely remove this line.`));
-				} else {
-					pragma2loc[value.pragma.name] = loc;
-					pragmas[value.pragma.name] = false;
-				}
-			}
-		},
-		onPatchData(data, loc) {
-			let oldData = data.old ? data.old.buffer : null;
-			let newData = data.new.buffer;
-
-			if (data.new.placeholders > 0) {
-				if (!options.allowPlaceholders)
-					vkp.errors.push(new VkpParseError(`Found placeholder instead of real patch data`, data.new.loc));
-			}
-
-			if (pragmas.old_equal_ff && !oldData)
-				oldData = Buffer.alloc(newData.length).fill(0xFF);
-
-			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) {
-				if (!options.allowEmptyOldData)
-					vkp.warnings.push(new VkpParseError(`Old data is not specified`, data.new.loc, `Undo operation is impossible!`));
-			}
-
-			vkp.writes.push({
-				addr:			(offsetCorrector ? offsetCorrector.value : 0) + data.address,
-				size:			newData.length,
-				old:			oldData,
-				new:			newData,
-				loc,
-				pragmas:		{...pragmas}
-			});
-		},
-		onOffset(value, loc) {
-			offsetCorrector = { value: value.offset, text: value.text, loc };
-		},
-		onWarning(e) {
-			vkp.warnings.push(e);
-		},
-		onError(e) {
-			vkp.errors.push(e);
-		}
-	});
-
-	let unsinishedPragmas = [];
-	for (let k in pragmas) {
-		if (pragmas[k] !== DEFAULT_PRAGMAS[k]) {
-			let cancel = pragmas[k] ? `#pragma disable ${k}` : `#pragma enable ${k}`;
-			vkp.warnings.push(new VkpParseError(`Uncanceled pragma "${k}"`, pragma2loc[k], `Please put "${cancel}" at the end of the patch.`));
-		}
-	}
-
-	if (offsetCorrector && offsetCorrector.value != 0)
-		vkp.warnings.push(new VkpParseError(`Uncanceled offset ${offsetCorrector.text}`, offsetCorrector.loc, `Please put "+0" at the end of the patch.`));
-
-	vkp.valid = (vkp.errors.length == 0);
-
-	return vkp;
-}
-
-function vkpDetectContent(text) {
-	if (text.indexOf('{\\rtf1') >= 0)
-		return "RTF";
-	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";
-	return "UNKNOWN";
-}
-
-// CP1251 -> UTF-8 + CRLF -> LF (with RTF support)
-async function vkpNormalizeWithRTF(text) {
-	if (!Buffer.isBuffer(text))
-		throw new Error(`Patch text is not Buffer!`);
-
-	if (text.indexOf('{\\rtf1') >= 0) {
-		// Strip RTF images
-		while (true) {
-			let pictureIndex = text.indexOf('{\\pict');
-			if (pictureIndex >= 0) {
-				let pictureEndIndex = text.indexOf('}', pictureIndex);
-				if (pictureIndex >= 0) {
-					text = Buffer.concat([ text.slice(0, pictureIndex), text.slice(pictureEndIndex + 1) ]);
-					continue;
-				}
-			}
-			break;
-		}
-
-		text = text.toString('utf-8').replace(/{\\pict.*?\}/gsi, ''); // remove pictures
-		let parsed = await new Promise((resolve, reject) => {
-			RTFParser.string(text, (err, doc) => {
-				if (err) {
-					reject(err);
-				} else {
-					resolve(doc);
-				}
-			});
-		});
-
-		let lines = [];
-		for (let p of parsed.content) {
-			lines.push(p.content.map((s) => s.value).join(''));
-		}
-		return lines.join('\n');
-	}
-	return iconv.decode(text, 'windows-1251').replace(/(\r\n|\n|\r)/g, "\n");
-}
-
-// CP1251 -> UTF-8 + CRLF -> LF
-function vkpNormalize(text) {
-	if (!Buffer.isBuffer(text))
-		throw new Error(`Patch text is not Buffer!`);
-	return iconv.decode(text, 'windows-1251').replace(/(\r\n|\n|\r)/g, "\n");
-}
-
-// UTF-8 -> CP1251 + LF -> CRLF
-function vkpCanonicalize(text) {
-	return iconv.encode(text.replace(/(\r\n|\n|\r)/g, "\r\n"), 'windows-1251');
-}
-
-export { vkpParse, vkpRawParser, vkpNormalize, vkpNormalizeWithRTF, vkpCanonicalize, vkpDetectContent, VkpParseError };