data/src/Core/FS/FS.ts

import { FileInfo } from "@/FileSystem/FileInfo";
import { dynamicImports } from "../DynamicImports";
import { DataFormat, IData } from "./FSInterfaces";

/**
 * Adds an extension if missing.
 *
 * @param  {FileInfo} params   The parameters describing the text file.
 * @param  {string} defaultExt The default extension to use.
 * @returns {FileInfo} The parameters with the extension added to the filename
 *     field.
 */
// function _addExt(params: FileInfo, defaultExt: string): FileInfo {
//     // Get the extension from the filename
//     // *****

//     // Set some default values.
//     params.ext = params.ext || defaultExt;
//     // params.compress = params.compress || false;

//     // If ext doesn't start with a period, add one.
//     if (params.ext.charAt(0) !== ".") {
//         params.ext = "." + params.ext;
//     }

//     // If fileName doesn't end in the string contained in params.ext (case
//     // insensitive), add it. Use endsWith
//     if (!params.name.toLowerCase().endsWith(params.ext.toLowerCase())) {
//         params.name += params.ext;
//     }

//     return params;
// }

/**
 * Saves a text file.
 *
 * @param  {FileInfo} params The parameters describing the text file.
 * @returns {Promise<any>} A promise that resolves after saving the file.
 */
export function saveTxt(params: FileInfo): Promise<any> {
    // Add .txt extension if
    // params = _addExt(params, ".txt");

    // If doesn't end in ".zip" (case insensitive), add it.
    const validCompressedExts = [".zip", ".molmoda", ".biotite"];
    if (
        params.compressedName &&
        !validCompressedExts.some((ext) =>
            params.compressedName?.toLowerCase().endsWith(ext)
        )
    ) {
        params.compressedName += ".zip";
    }

    if (params.compressedName) {
        return saveZipWithTxtFiles(params.compressedName, [params]);
    }

    // Don't compress the output
    return dynamicImports.fileSaver.module.then((fileSaver: any) => {
        const blob = new Blob([params.contents as string], {
            type: "text/plain;charset=utf-8",
        });
        fileSaver.saveAs(blob, params.name);
        return;
    });

    // const promises: Promise<any>[] = [dynamicImports.fileSaver.module];
    // if (params.compress) {
    //  promises.push(dynamicImports.jsZip.module);
    // }
}

/**
 * Saves an SVG file.
 *
 * @param  {FileInfo} params The parameters describing the SVG file.
 *              The `contents` should be the SVG string.
 *              The `name` should be the desired filename (e.g., "image.svg").
 * @returns {Promise<any>} A promise that resolves after saving the file.
 */
export function saveSvg(params: FileInfo): Promise<any> {
    // Ensure the filename ends with .svg
    if (!params.name.toLowerCase().endsWith(".svg")) {
        params.name += ".svg";
    }

    // If a compressedName is provided, save as a zip containing the SVG file.
    // This part remains consistent with saveTxt for compressed outputs.
    const validCompressedExts = [".zip", ".molmoda", ".biotite"];
    if (
        params.compressedName &&
        !validCompressedExts.some((ext) =>
            params.compressedName?.toLowerCase().endsWith(ext)
        )
    ) {
        params.compressedName += ".zip";
    }

    if (params.compressedName) {
        // To save as a zip, we need to ensure the FileInfo for the SVG
        // within the zip has the correct .svg extension.
        // The saveZipWithTxtFiles function expects FileInfo objects.
        // We'll create a new FileInfo for the SVG content to be zipped.
        const svgFileInfoForZip = new FileInfo({
            name: params.name, // Already ensured to end with .svg
            contents: params.contents,
            // No compressedName for the file *inside* the zip
        });
        return saveZipWithTxtFiles(params.compressedName, [svgFileInfoForZip]);
    }

    // Save directly as an SVG file (not compressed)
    return dynamicImports.fileSaver.module.then((fileSaver: any) => {
        const blob = new Blob([params.contents as string], {
            type: "image/svg+xml", // Correct MIME type for SVG
        });
        fileSaver.saveAs(blob, params.name);
        return;
    });
}

/**
 * Creates a zip file blob from a list of FileInfo objects.
 *
 * @param {FileInfo[]} files An array of FileInfo objects to include in the zip.
 * @returns {Promise<Blob>} A promise that resolves with the zip file as a Blob.
 */
export function createZipBlob(files: FileInfo[]): Promise<Blob> {
    return dynamicImports.jsZip.module.then((JSZip: any) => {
        const zip = new JSZip();
        files.forEach((file) => {
            zip.file(file.name, file.contents, {
                compression: "DEFLATE",
                // Note: Below doesn't seem to improve compression, so
                // comment out.
                // compressionOptions: {
                //     compressionOptions: 9
                // }
            });
        });
        return zip.generateAsync({ type: "blob" });
    });
}

/**
 * Saves a zip file containing one or more text files.
 *
 * @param  {string} compressedName The parameters describing the zip file.
 * @param  {FileInfo[]} files      A list of parameters describing the text
 *                                 files to add to the zip file.
 * @returns {Promise<any>} A promise that resolves after saving the zip file.
 */
export function saveZipWithTxtFiles(
    compressedName: string,
    files: FileInfo[]
): Promise<any> {
    // compressedName = _addExt(compressedName, ".zip");
    // files = files.map((file) => _addExt(file, ".txt"));
    const makeZipPromise = createZipBlob(files);

    const promises: Promise<any>[] = [
        dynamicImports.fileSaver.module,
        makeZipPromise,
    ];

    return Promise.all(promises).then((payload: any[]) => {
        const fileSaver = payload[0];
        const zipBlob = payload[1];
        fileSaver.saveAs(zipBlob, compressedName);
        return;
    });
}

/**
 * Converts a dataURI to a Blob.
 *
 * @param  {string} dataURI The dataURI to convert.
 * @returns {Blob} The Blob representing the dataURI.
 */
function _dataURIToBlob(dataURI: string): Blob {
    // see https://stackoverflow.com/questions/12168909/blob-from-dataurl

    // convert base64 to raw binary data held in a string doesn't handle
    // URLEncoded DataURIs - see SO answer #6850276 for code that does this
    const byteString = atob(dataURI.split(",")[1]);

    // separate out the mime component
    const mimeString = dataURI.split(",")[0].split(":")[1].split(";")[0];

    // write the bytes of the string to an ArrayBuffer
    const ab = new ArrayBuffer(byteString.length);

    // create a view into the buffer
    const ia = new Uint8Array(ab);

    // set the bytes of the buffer to the correct values
    for (let i = 0; i < byteString.length; i++) {
        ia[i] = byteString.charCodeAt(i);
    }

    // write the ArrayBuffer to a blob, and you're done
    return new Blob([ab], { type: mimeString });
}

/**
 * Saves a dataURI representing a PNG image to a file.
 *
 * @param  {string} fileName The name of the file to save.
 * @param  {string} pngUri   The dataURI representing the PNG image.
 */
export function savePngUri(fileName: string, pngUri: string) {
    dynamicImports.fileSaver.module
        .then((fileSaver) => {
            const blob = _dataURIToBlob(pngUri);
            fileSaver.saveAs(blob, fileName);
            return;
        })
        .catch((err: any) => {
            throw err;
        });
}

/**
 * Given a string of compressed data (representing a zip file), get the contents
 * of a text file in it.
 *
 * @param  {string} s          The compressed data.
 * @returns {Promise<FileInfo[]>} A promise that resolves to the contents of the
 *     file(s). Always an array, even if only one file is returned.
 */
export function uncompress(s: string): Promise<FileInfo[]> {
    const getZipObjPromise = dynamicImports.jsZip.module.then((JSZip) => {
        return JSZip.loadAsync(s);
    });

    // if (fileName !== undefined) {
    //     return getZipObjPromise.then((zip: any) => {
    //         return [zip.file(fileName).async("string")];
    //     });
    // } else {
    let fileNames: string[];
    // let fileSizes: number[];
    return getZipObjPromise
        .then((zip: any) => {
            fileNames = Object.keys(zip.files);
            // fileSizes = zip.files.map((file: any) => file.size);
            const promises = fileNames.map((f) => zip.files[f].async("string"));
            return Promise.all(promises);
        })
        .then((fileContents: string[]) => {
            const fileInfos: FileInfo[] = [];
            for (let i = 0; i < fileNames.length; i++) {
                const fileName = fileNames[i];
                if (fileName.startsWith("__MACOSX")) {
                    continue;
                }
                if (fileName.startsWith(".")) {
                    continue;
                }

                const contents = fileContents[i];

                fileInfos.push(
                    new FileInfo({
                        name: fileName.split("/").pop() as string, // basename
                        // Getting file size not supported with zip. You could
                        // implement, though.
                        // size: 0,
                        contents: contents,
                        // type: type,
                    })
                );
            }
            return fileInfos;
        });
    // }
}

/**
 * Saves tabular data to a file.
 *
 * @param {IData}  data      The data to save.
 * @param {string} filename  The name of the file to save.
 * @param {DataFormat | string} format   The format to save the data in.
 */
export function saveData(
    data: IData,
    filename: string,
    format: DataFormat | string
) {
    if (format === DataFormat.JSON) {
        saveTxt(
            new FileInfo({
                name: filename,
                contents: JSON.stringify(data.rows, null, 2),
            })
        );
    } else {
        Promise.all([
            dynamicImports.exceljs.module,
            dynamicImports.fileSaver.module,
        ])
            .then(async ([ExcelJS, fileSaver]) => {
                const workbook = new ExcelJS.Workbook();
                const worksheet = workbook.addWorksheet("Sheet1");

                worksheet.columns = data.headers.map((header) => ({
                    header: header,
                    key: header,
                }));

                worksheet.addRows(data.rows);

                const fileExtension = filename.split(".").pop()?.toLowerCase();
                let buffer: ArrayBuffer;
                let blobType: string;

                if (fileExtension === "xlsx") {
                    buffer = await workbook.xlsx.writeBuffer();
                    blobType =
                        "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
                } else if (fileExtension === "csv") {
                    buffer = await workbook.csv.writeBuffer();
                    blobType = "text/csv;charset=utf-8;";
                } else {
                    // Fallback for when format is passed but not in filename
                    if (format === DataFormat.XLSX) {
                        buffer = await workbook.xlsx.writeBuffer();
                        blobType =
                            "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
                    } else if (format === DataFormat.CSV) {
                        buffer = await workbook.csv.writeBuffer();
                        blobType = "text/csv;charset=utf-8;";
                    } else {
                        console.error("Unsupported format for saving:", format);
                        return;
                    }
                }
                const blob = new Blob([buffer], { type: blobType });
                fileSaver.saveAs(blob, filename);
                return;
            })
            .catch((err: any) => {
                throw err;
            });
    }
}