igir/dist/src/modules/fixdatCreator.js

🕹 A zero-setup ROM collection manager that sorts, filters, extracts or archives, patches, and reports on collections of any size on any OS.

import path from 'node:path';
import { ProgressBarSymbol } from '../console/progressBar.js';
import FsPoly from '../polyfill/fsPoly.js';
import IgirHeader from '../types/dats/igirHeader.js';
import LogiqxDAT from '../types/dats/logiqx/logiqxDat.js';
import Module from './module.js';
/**
 * Create a "fixdat" that contains every {@link Game} that has at least one {@link ROM} that wasn't
 * found, and therefore the {@link Game} was not written to the output.
 */
export default class FixdatCreator extends Module {
    options;
    constructor(options, progressBar) {
        super(progressBar, FixdatCreator.name);
        this.options = options;
    }
    /**
     * Create & write a fixdat.
     */
    async create(originalDat, candidates) {
        if (!this.options.shouldFixdat()) {
            return undefined;
        }
        this.progressBar.logTrace(`${originalDat.getName()}: generating a fixdat`);
        this.progressBar.setSymbol(ProgressBarSymbol.WRITING);
        this.progressBar.resetProgress(1);
        /**
         * Create an easily searchable index of every {@link ROM} that has a {@link WriteCandidate}
         */
        const writtenRomHashCodes = new Set(candidates
            .flatMap((candidate) => candidate.getRomsWithFiles())
            .map((romWithFiles) => romWithFiles.getRom())
            .map((rom) => rom.hashCode()));
        // Find all the games that have at least one missing ROM
        const gamesWithMissingRoms = originalDat
            .getGames()
            .filter((game) => !game.getRoms().every((rom) => writtenRomHashCodes.has(rom.hashCode())));
        if (gamesWithMissingRoms.length === 0) {
            this.progressBar.logDebug(`${originalDat.getName()}: not creating a fixdat, all games were found`);
            return undefined;
        }
        const fixdatDir = this.options.getFixdatOutput();
        if (!(await FsPoly.exists(fixdatDir))) {
            await FsPoly.mkdir(fixdatDir, { recursive: true });
        }
        // Construct a new DAT and write it to the output dir
        const header = new IgirHeader('fixdat', originalDat, this.options);
        const fixdat = new LogiqxDAT({ header, games: gamesWithMissingRoms });
        const fixdatContents = fixdat.toXmlDat();
        const fixdatPath = path.join(fixdatDir, fixdat.getFilename());
        this.progressBar.logInfo(`${originalDat.getName()}: writing fixdat to '${fixdatPath}'`);
        await FsPoly.writeFile(fixdatPath, fixdatContents);
        this.progressBar.logTrace(`${originalDat.getName()}: done generating a fixdat`);
        return fixdatPath;
    }
}