|
| 1 | +import * as path from "node:path"; |
| 2 | +import { path7za } from "7zip-bin"; |
| 3 | +import { ILogger } from "@spt/models/spt/utils/ILogger"; |
| 4 | +import * as fs from "fs-extra"; |
| 5 | +import * as Seven from "node-7z"; |
| 6 | +import { inject, injectable } from "tsyringe"; |
| 7 | + |
| 8 | +@injectable() |
| 9 | +export class DatabaseDecompressionUtil { |
| 10 | + private compressedDir: string; |
| 11 | + private assetsDir: string; |
| 12 | + private compiled: boolean; |
| 13 | + |
| 14 | + constructor(@inject("PrimaryLogger") protected logger: ILogger) { |
| 15 | + this.compressedDir = path.normalize("./assets/compressed/database"); |
| 16 | + this.assetsDir = path.normalize("./assets/database"); |
| 17 | + this.compiled = this.isCompiled(); |
| 18 | + } |
| 19 | + |
| 20 | + /** |
| 21 | + * Checks if the application is running in a compiled environment. A simple check is done to see if the relative |
| 22 | + * assets directory exists. If it does not, the application is assumed to be running in a compiled environment. All |
| 23 | + * relative asset paths are different within a compiled environment, so this simple check is sufficient. |
| 24 | + */ |
| 25 | + private isCompiled(): boolean { |
| 26 | + const assetsDir = path.normalize("./assets"); |
| 27 | + return !fs.existsSync(assetsDir); |
| 28 | + } |
| 29 | + |
| 30 | + /** |
| 31 | + * Initializes the database compression utility. |
| 32 | + * |
| 33 | + * This method will decompress all 7-zip archives within the compressed database directory. The decompressed files |
| 34 | + * are placed in their respective directories based on the name and location of the compressed file. |
| 35 | + */ |
| 36 | + public async initialize(): Promise<void> { |
| 37 | + if (this.compiled) { |
| 38 | + this.logger.debug("Skipping database decompression in compiled environment"); |
| 39 | + return; |
| 40 | + } |
| 41 | + |
| 42 | + try { |
| 43 | + const compressedFiles = await this.getCompressedFiles(); |
| 44 | + if (compressedFiles.length === 0) { |
| 45 | + this.logger.debug("No database archives found"); |
| 46 | + return; |
| 47 | + } |
| 48 | + |
| 49 | + for (const compressedFile of compressedFiles) { |
| 50 | + await this.processCompressedFile(compressedFile); |
| 51 | + } |
| 52 | + this.logger.info("Database archives processed"); |
| 53 | + } catch (error) { |
| 54 | + this.logger.error(`Error handling database archives: ${error}`); |
| 55 | + } |
| 56 | + } |
| 57 | + |
| 58 | + /** |
| 59 | + * Retrieves a list of all 7-zip archives within the compressed database directory. |
| 60 | + */ |
| 61 | + private async getCompressedFiles(): Promise<string[]> { |
| 62 | + try { |
| 63 | + const files = await fs.readdir(this.compressedDir); |
| 64 | + const compressedFiles = files.filter((file) => file.endsWith(".7z")); |
| 65 | + return compressedFiles; |
| 66 | + } catch (error) { |
| 67 | + this.logger.error(`Error reading database archive directory: ${error}`); |
| 68 | + return []; |
| 69 | + } |
| 70 | + } |
| 71 | + |
| 72 | + /** |
| 73 | + * Processes a compressed file by checking if the target directory is empty, and if so, decompressing the file into |
| 74 | + * the target directory. |
| 75 | + */ |
| 76 | + private async processCompressedFile(compressedFileName: string): Promise<void> { |
| 77 | + this.logger.info("Processing database archives..."); |
| 78 | + |
| 79 | + const compressedFilePath = path.join(this.compressedDir, compressedFileName); |
| 80 | + const relativeTargetPath = compressedFileName.replace(".7z", ""); |
| 81 | + const targetDir = path.join(this.assetsDir, relativeTargetPath); |
| 82 | + |
| 83 | + try { |
| 84 | + this.logger.debug(`Processing: ${compressedFileName}`); |
| 85 | + |
| 86 | + const isTargetDirEmpty = await this.isDirectoryEmpty(targetDir); |
| 87 | + if (!isTargetDirEmpty) { |
| 88 | + this.logger.debug(`Archive target directory not empty, skipping: ${targetDir}`); |
| 89 | + return; |
| 90 | + } |
| 91 | + |
| 92 | + await this.decompressFile(compressedFilePath, targetDir); |
| 93 | + |
| 94 | + this.logger.debug(`Successfully processed: ${compressedFileName}`); |
| 95 | + } catch (error) { |
| 96 | + this.logger.error(`Error processing ${compressedFileName}: ${error}`); |
| 97 | + } |
| 98 | + } |
| 99 | + |
| 100 | + /** |
| 101 | + * Checks if a directory exists and is empty. |
| 102 | + */ |
| 103 | + private async isDirectoryEmpty(directoryPath: string): Promise<boolean> { |
| 104 | + try { |
| 105 | + const exists = await fs.pathExists(directoryPath); |
| 106 | + if (!exists) { |
| 107 | + return true; // Directory doesn't exist, consider it empty. |
| 108 | + } |
| 109 | + const files = await fs.readdir(directoryPath); |
| 110 | + return files.length === 0; |
| 111 | + } catch (error) { |
| 112 | + this.logger.error(`Error checking if directory is empty ${directoryPath}: ${error}`); |
| 113 | + throw error; |
| 114 | + } |
| 115 | + } |
| 116 | + |
| 117 | + /** |
| 118 | + * Decompresses a 7-zip archive to the target directory. |
| 119 | + */ |
| 120 | + private decompressFile(archivePath: string, destinationPath: string): Promise<void> { |
| 121 | + return new Promise((resolve, reject) => { |
| 122 | + const myStream = Seven.extractFull(archivePath, destinationPath, { |
| 123 | + $bin: path7za, |
| 124 | + overwrite: "a", |
| 125 | + }); |
| 126 | + |
| 127 | + let hadError = false; |
| 128 | + |
| 129 | + myStream.on("end", () => { |
| 130 | + if (!hadError) { |
| 131 | + this.logger.debug(`Decompressed ${archivePath} to ${destinationPath}`); |
| 132 | + resolve(); |
| 133 | + } |
| 134 | + }); |
| 135 | + |
| 136 | + myStream.on("error", (err) => { |
| 137 | + hadError = true; |
| 138 | + this.logger.error(`Error decompressing ${archivePath}: ${err}`); |
| 139 | + reject(err); |
| 140 | + }); |
| 141 | + }); |
| 142 | + } |
| 143 | +} |
0 commit comments