neozipkit 0.2.1 → 0.3.0

package/src/server/ZipKitServer.ts

@@ -1,305 +0,0 @@
-/**
- * ZipKitServer
- * Copyright (c) 2025 NeoWare, Inc. All rights reserved.
- * 
- * Server-side implementation of ZipKit that passes through all functions
- * directly to the parent ZipKit class. This class provides a consistent interface
- * for server environments and ensures all ZipKit functionality is available.
- */
-
-import * as fs from 'fs';
-import * as path from 'path';
-import { v4 as uuidv4 } from 'uuid';
-import { exit } from 'process';
-
-import ZipKit,{ CompressOptions, ZipEntry, TIMESTAMP_METADATA, TIMESTAMP_SUBMITTED, CMP_METHOD } from '../shared/ZipKit';
-import * as Headers from '../shared/constants/Headers';
-import { upgradeOTS as upgradeZipOts, createCertificateOts as createCertificateOtsFile, createOtsMetadataEntry } from '../blockchain/ZipKitOTS';
-
-// Re-export everything from ZipKit
-export * from '../shared/ZipKit';
-export { Headers };
-
-/**
- * This implementation is optimized for server environments and handles all
- * ZIP operations including compression, extraction, encryption, and file management.
- */
-export default class ZipKitServer extends ZipKit {
-  /**
-   * Creates a new ZipKitServer instance
-   * 
-   * Initializes the parent ZipKit class and logs environment support information
-   * for diagnostic purposes.
-   */
-  constructor() {
-    super();      // Call the parent constructor
-  }
-    
-  /**
-   * Loads a ZIP file from the filesystem for updating/creating operations
-   * 
-   * Attempts to read an existing ZIP file, but creates a new empty archive if
-   * the file doesn't exist. This method is used when adding or updating entries
-   * in an archive, handling both new and existing ZIP files gracefully.
-   * 
-   * @param zipFile - Path to the ZIP file to load or create
-   */
-  loadZipFile(zipFile: string): void {
-    let inBuffer: Buffer | null = null;
-    let fdIn: number | null = null;
-
-    try {
-      if (fs.existsSync(zipFile)) {
-        fdIn = fs.openSync(zipFile, 'r');
-        const stats = fs.fstatSync(fdIn);
-        inBuffer = Buffer.alloc(stats.size);
-        // inBuffer is allocated above; ensure non-null for readSync
-        fs.readSync(fdIn, inBuffer as Buffer, 0, stats.size, 0);
-      } else {
-        // File doesn't exist, use an empty buffer
-        inBuffer = Buffer.alloc(0);
-      }
-    } catch (error) {
-      console.log('Warning: Could not open existing file. Creating new archive.');
-      inBuffer = Buffer.alloc(0);
-    } finally {
-      if (fdIn !== null) {
-        fs.closeSync(fdIn);
-      }
-    }
-
-    // Initialize empty buffer if null
-    const buffer: Buffer = inBuffer ?? Buffer.alloc(0);
-    super.loadZip(buffer);
-  }
-
-  /**
-   * Loads a ZIP file from the filesystem for extraction and listing operations
-   * 
-   * Reads an existing ZIP file and throws an error if the file doesn't exist.
-   * Use this method when working with existing archives that need to be extracted.
-   * 
-   * @param zipFile - Path to the ZIP file to load
-   * @throws Error if the file doesn't exist or can't be read
-   */
-  loadUnzipFile(zipFile: string): void {
-    try {
-      // Check if the file exists before trying to read it
-      if (!fs.existsSync(zipFile)) {
-        console.error(`Error: Zip file "${zipFile}" does not exist`);
-        exit(1);
-      }
-      
-      const inBuffer = fs.readFileSync(zipFile);
-      super.loadZip(inBuffer);
-    } catch (error) {
-      console.error(`Error: Failed to read zip file "${zipFile}"`);
-      exit(1);
-    }
-  }
-
-  /**
-   * Adds a single file to the ZIP archive
-   * @param filename - Path to the file to be added
-   * @param comment - Optional comment for the file entry
-   * 
-   * Handles:
-   * - Creating/updating ZipEntry objects
-   * - Setting file attributes and timestamps
-   * - Respecting freshen (-f) and update (-u) flags
-   * - Setting compression method
-   */
-  addFile(filename: string, freshen: boolean = false, update: boolean = false): void {
-    let entry = super.getZipEntry(filename);
-    if (!entry) {
-      // Check for Freshen option
-      if (freshen) return;
-      entry = super.createZipEntry(filename);
-    } else if (!update) {
-      // Mark this entry as not being updated
-      entry.isUpdated = false;
-      return;
-    }
-    entry.platform = process.platform;
-
-    // Correctly retrieve file stats
-    let attr = fs.statSync(filename); // Synchronously get the stats of the file
-
-    entry.uncompressedSize = attr.size;
-
-    // Set the DOS file time/date based on the Date stamp of the file.
-    const utcDate = new Date(attr.mtime.getTime());
-    entry.timeDateDOS = entry.setDateTime(utcDate);
-    entry.universalTime = Math.floor(attr.mtime.getTime() / 1000); // Store Unix timestamp
-
-    // Set Unix UID/GID if on Unix-like system
-    if (process.platform !== 'win32') {
-      entry.uid = attr.uid;
-      entry.gid = attr.gid;
-    }
-
-    // Use attr.mode for file permissions
-    entry.isDirectory = attr.isDirectory();
-    let _fattr = (attr.mode & 0xfff) | (entry.isDirectory ? 0x4000 : 0x8000);
-    entry.extFileAttr = ((_fattr << 16) | (entry.isDirectory ? 0x10 : 0)) >>> 0;
-  }
-  
-  /**
-   * Processes files to be added to the ZIP archive
-   * Creates ZipEntry objects for each file and initiates the compression process
-   */
-  addFiles(files: string[], freshen: boolean = false, update: boolean = false) {
-    let filesAdded = 0;
-    for (var i=0; files[i] != undefined; i++) {
-      const filename = String(files[i]);
-      // Skip arguments that look like options (start with hyphen but aren't files)
-      if (filename.startsWith('-') && !fs.existsSync(filename)) {
-        console.warn(`Warning: Skipping '${filename}' which appears to be an option, not a file.`);
-        continue;
-      }
-      
-      this.addFile(filename, freshen, update);
-      filesAdded++;
-    }
-  
-    return filesAdded;
-  }
-
-  /**
-   * Creates a ZIP file
-   */
-  async createZip(zipFile: string, compressOptions: CompressOptions) {
-  
-    // Ensure the directory structure for the output file exists
-    const outputDir = path.dirname(zipFile);
-    if (!fs.existsSync(outputDir)) {
-      fs.mkdirSync(outputDir, { recursive: true });
-    }
-  
-    // Generate a unique temporary file name in the output directory
-    const _tempZipFile = path.join(outputDir, `neozip-${uuidv4()}.zip`);
-  
-    // Open or create the .zip file for writing
-    const fd = fs.openSync(_tempZipFile, 'w');
-  
-    let offset = await super.createZipFileData(compressOptions, {
-      onReadEntryData: (entry: ZipEntry) => {
-        try {
-          return fs.readFileSync(entry.filename);
-        } catch (error) {
-          throw new Error(`Failed to read file: ${entry.filename}`);
-        }
-      },
-      onOutputBuffer: (buffer: Buffer) => {
-        fs.writeSync(fd, buffer);
-      },
-      onEntryDone: (entry: ZipEntry, status: string) => {
-        console.log(`${status} ${entry.filename} to ${zipFile}`);
-      } 
-    });
-    
-    // Write the metadata entry to the .zip fi
-    await super.finishZipFileData(
-      offset, 
-      function onOutputBuffer(buffer: Buffer) {
-        fs.writeSync(fd, buffer);
-      },
-      undefined
-    );
-  
-    // Close the .zip file
-    fs.closeSync(fd);
-    
-    // Delete the existing .zip file if it exists
-    if (fs.existsSync(zipFile)) {
-      fs.unlinkSync(zipFile);
-    }
-  
-    // Replace the existing .zip file with the temporary file
-    fs.renameSync(_tempZipFile, zipFile);
-  }
-
-  /**
-   * Creates a ZIP file with OpenTimestamps (OTS) metadata
-   */
-  // async createZipOTS(zipFile: string, compressOptions: CompressOptions) {
-  
-  //   // Ensure the directory structure for the output file exists
-  //   const outputDir = path.dirname(zipFile);
-  //   if (!fs.existsSync(outputDir)) {
-  //     fs.mkdirSync(outputDir, { recursive: true });
-  //   }
-  
-  //   // Generate a unique temporary file name in the output directory
-  //   const _tempZipFile = path.join(outputDir, `neozip-${uuidv4()}.zip`);
-  
-  //   // Open or create the .zip file for writing
-  //   const fd = fs.openSync(_tempZipFile, 'w');
-  
-  //   let offset = await super.createZipFileData(compressOptions, {
-  //     onReadEntryData: (entry: ZipEntry) => {
-  //       try {
-  //         return fs.readFileSync(entry.filename);
-  //       } catch (error) {
-  //         throw new Error(`Failed to read file: ${entry.filename}`);
-  //       }
-  //     },
-  //     onOutputBuffer: (buffer: Buffer) => {
-  //       fs.writeSync(fd, buffer);
-  //     },
-  //     onEntryDone: (entry: ZipEntry, status: string) => {
-  //       console.log(`${status} ${entry.filename} to ${zipFile}`);
-  //     } 
-  //   });
-  
-  //   // Timestamp the zip file to the Bitcoin blockchain
-  //   let _metadataEntry = null;
-  
-  //   console.log('Timestamping to Bitcoin blockchain...');
-  //   const _merkleRoot = super.getMerkleRoot();
-  //   console.log('Merkle Root: ' + _merkleRoot);
-  //   const _ots = await createTimestamp(_merkleRoot);
-  //   _metadataEntry = super.createTimestampMetadataEntry(_ots);
-  
-  //   // Write the metadata entry to the .zip fi
-  //   await super.finishZipFileData(
-  //     offset, 
-  //     function onOutputBuffer(buffer: Buffer) {
-  //       fs.writeSync(fd, buffer);
-  //     },
-  //     _metadataEntry || undefined
-  //   );
-  
-  //   // Close the .zip file
-  //   fs.closeSync(fd);
-    
-  //   // Delete the existing .zip file if it exists
-  //   if (fs.existsSync(zipFile)) {
-  //     fs.unlinkSync(zipFile);
-  //   }
-  
-  //   // Replace the existing .zip file with the temporary file
-  //   fs.renameSync(_tempZipFile, zipFile);
-  // }
-
-  /**
-   * Removes specified files from the ZIP archive
-   * Deletes matching ZipEntry objects and rebuilds the archive if any files were removed
-   */
-  deleteFiles(delFiles: string[]): number {
-
-    super.getDirectory();
-    let filesDel = 0;
-    delFiles.forEach(fname => {
-      const deleted = super.deleteFile(fname);
-      if (deleted) {
-        console.log('   deleting: ' + fname + "\n");
-        ++filesDel;
-      } else {
-        console.log('   warning: name not found: ' + fname + "\n"); 
-      }
-    })
-
-    return filesDel;
-  }
-}