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.
111 lines (110 loc) • 4.8 kB
JavaScript
import path from 'node:path';
import { ProgressBarSymbol } from '../../console/progressBar.js';
import FsPoly from '../../polyfill/fsPoly.js';
import ArchiveEntry from '../../types/files/archives/archiveEntry.js';
import Chd from '../../types/files/archives/chd/chd.js';
import Dolphin from '../../types/files/archives/dolphin/dolphin.js';
import Maxcso from '../../types/files/archives/maxcso/maxcso.js';
import Rar from '../../types/files/archives/rar.js';
import SevenZip from '../../types/files/archives/sevenZip/sevenZip.js';
import Tar from '../../types/files/archives/tar.js';
import Zip from '../../types/files/archives/zip.js';
import IndexedFiles from '../../types/indexedFiles.js';
import Module from '../module.js';
/**
* This class indexes {@link File}s by their {@link File.hashCode}, and sorts duplicate files by a
* set of preferences.
*/
export default class ROMIndexer extends Module {
options;
constructor(options, progressBar) {
super(progressBar, ROMIndexer.name);
this.options = options;
}
/**
* Index files.
*/
index(files) {
this.progressBar.logTrace(`indexing ${files.length.toLocaleString()} file${files.length === 1 ? '' : 's'}`);
this.progressBar.setSymbol(ProgressBarSymbol.ROM_INDEXING);
this.progressBar.resetProgress(files.length);
// Index the files
const result = IndexedFiles.fromFiles(files);
// Then apply some sorting preferences
Object.keys(result).forEach((checksum) => {
this.sortMap(result[checksum]);
});
this.progressBar.logTrace(`found ${result.getSize()} unique file${result.getSize() === 1 ? '' : 's'}`);
this.progressBar.logTrace('done indexing files');
return result;
}
sortMap(checksumsToFiles) {
const outputDir = this.options.getOutputDirRoot();
const outputDirDisk = FsPoly.diskResolved(outputDir);
[...checksumsToFiles.values()].forEach((files) => files.sort((fileOne, fileTwo) => {
// Prefer un-archived files because they're less expensive to process
const fileOneArchived = ROMIndexer.archiveEntryPriority(fileOne);
const fileTwoArchived = ROMIndexer.archiveEntryPriority(fileTwo);
if (fileOneArchived !== fileTwoArchived) {
return fileOneArchived - fileTwoArchived;
}
// Then, prefer files that are NOT already in the output directory
// This is in case the output file is invalid and we're trying to overwrite it with
// something else. Otherwise, we'll just attempt to overwrite the invalid output file with
// itself, still resulting in an invalid output file.
// TODO(cemmer): only do this when overwriting files in some way?
const fileOneInOutput = path.resolve(fileOne.getFilePath()).startsWith(outputDir) ? 1 : 0;
const fileTwoInOutput = path.resolve(fileTwo.getFilePath()).startsWith(outputDir) ? 1 : 0;
if (fileOneInOutput !== fileTwoInOutput) {
return fileOneInOutput - fileTwoInOutput;
}
/**
* Then, prefer files that are on the same disk for fs efficiency see {@link FsPoly#mv}
*/
if (outputDirDisk) {
// TODO(cemmer): only do this when not copying files?
const fileOneInOutputDisk = path.resolve(fileOne.getFilePath()).startsWith(outputDirDisk)
? 0
: 1;
const fileTwoInOutputDisk = path.resolve(fileTwo.getFilePath()).startsWith(outputDirDisk)
? 0
: 1;
if (fileOneInOutputDisk !== fileTwoInOutputDisk) {
return fileOneInOutputDisk - fileTwoInOutputDisk;
}
}
// Otherwise, be deterministic
return fileOne.toString().localeCompare(fileTwo.toString());
}));
}
/**
* This ordering should match {@link FileFactory#archiveFromArchiveExtension}
*/
static archiveEntryPriority(file) {
if (!(file instanceof ArchiveEntry)) {
return 0;
}
if (file.getArchive() instanceof Zip) {
return 1;
}
if (file.getArchive() instanceof Tar) {
return 2;
}
if (file.getArchive() instanceof Rar) {
return 3;
}
if (file.getArchive() instanceof SevenZip) {
return 4;
}
if (file.getArchive() instanceof Maxcso) {
return 5;
}
if (file.getArchive() instanceof Dolphin) {
return 6;
}
if (file.getArchive() instanceof Chd) {
return 7;
}
return 99;
}
}