igir
Version:
🕹 A zero-setup ROM collection manager that sorts, filters, extracts or archives, patches, and reports on collections of any size on any OS.
104 lines (103 loc) • 4.29 kB
JavaScript
import FsPoly from '../../polyfill/fsPoly.js';
import IOFile from '../../polyfill/ioFile.js';
import IgirException from '../exceptions/igirException.js';
import Patch from './patch.js';
class PPFHeader {
static FILE_SIGNATURE = Buffer.from('PPF');
version;
undoDataAvailable;
constructor(version, undoDataAvailable) {
this.version = version;
this.undoDataAvailable = undoDataAvailable;
}
static async fromIOFile(inputRomFile, patchFile) {
const header = (await patchFile.readNext(5)).toString();
if (!header.startsWith(PPFHeader.FILE_SIGNATURE.toString())) {
throw new IgirException(`PPF patch header is invalid: ${patchFile.getPathLike().toString()}`);
}
const encoding = (await patchFile.readNext(1)).readUInt8();
const version = encoding + 1;
if (!header.endsWith(`${version}0`)) {
throw new IgirException(`PPF patch header has an invalid version: ${patchFile.getPathLike().toString()}`);
}
patchFile.skipNext(50); // description
let blockCheckEnabled = false;
let undoDataAvailable = false;
if (version === 2) {
const sourceSize = (await patchFile.readNext(4)).readUInt32LE();
if (inputRomFile.getSize() !== sourceSize) {
throw new IgirException(`PPF patch expected ROM size of ${FsPoly.sizeReadable(sourceSize)}: ${patchFile.getPathLike().toString()}`);
}
blockCheckEnabled = true;
}
else if (version === 3) {
patchFile.skipNext(1); // image type
blockCheckEnabled = (await patchFile.readNext(1)).readUInt8() === 0x01;
undoDataAvailable = (await patchFile.readNext(1)).readUInt8() === 0x01;
patchFile.skipNext(1); // dummy
}
else {
throw new IgirException(`PPF v${version} isn't supported: ${patchFile.getPathLike().toString()}`);
}
if (blockCheckEnabled) {
patchFile.skipNext(1024);
}
return new PPFHeader(version, undoDataAvailable);
}
}
/**
* @see https://winningeleven-games.com/thread-9609-post-29416.html#pid29416
* @see https://github.com/meunierd/ppf/blob/master/ppfdev/PPF3.txt
*/
export default class PPFPatch extends Patch {
static SUPPORTED_EXTENSIONS = ['.ppf'];
static FILE_SIGNATURE = PPFHeader.FILE_SIGNATURE;
static patchFrom(file) {
const crcBefore = Patch.getCrcFromPath(file.getExtractedFilePath());
return new PPFPatch(file, crcBefore);
}
async createPatchedFile(inputRomFile, outputRomPath) {
return this.getFile().extractToTempIOFile('r', async (patchFile) => {
const header = await PPFHeader.fromIOFile(inputRomFile, patchFile);
return PPFPatch.writeOutputFile(inputRomFile, outputRomPath, patchFile, header);
});
}
static async writeOutputFile(inputRomFile, outputRomPath, patchFile, header) {
await inputRomFile.extractToFile(outputRomPath);
const targetFile = await IOFile.fileFrom(outputRomPath, 'r+');
try {
while (!patchFile.isEOF()) {
await PPFPatch.applyPatchBlock(patchFile, targetFile, header);
}
}
finally {
await targetFile.close();
}
}
static async applyPatchBlock(patchFile, targetFile, header) {
const peek = (await patchFile.peekNext(18)).toString();
if (!peek) {
// End of file
return;
}
if (peek === '@BEGIN_FILE_ID.DIZ') {
// TODO(cemmer): handle?
return;
}
let offset = 0;
if (header.version === 2) {
offset = (await patchFile.readNext(4)).readUInt32LE();
}
else if (header.version === 3) {
offset =
(await patchFile.readNext(4)).readUInt32LE() +
(await patchFile.readNext(4)).readUInt32LE() * 0x1_00_00_00_00;
}
const bytesToChange = (await patchFile.readNext(1)).readUInt8();
const data = await patchFile.readNext(bytesToChange);
if (header.undoDataAvailable) {
patchFile.skipNext(bytesToChange);
}
await targetFile.writeAt(data, offset);
}
}