Boxlang Zip

BoxLang ZIP Archives

Overview

BoxLang provides the bx:zip component for creating, extracting, listing, and modifying ZIP archives. Supports compression levels, entry filtering, encryption, and reading individual entries without full extraction.

Creating Archives

// Create from directory
bx:zip action="zip"
    file="#expandPath( '/temp/archive.zip' )#"
    source="#expandPath( '/files/documents' )#"

// Overwrite existing
bx:zip action="zip"
    file="#expandPath( '/temp/archive.zip' )#"
    source="#expandPath( '/files' )#"
    overwrite="true"

// Multiple sources with prefixes
bx:zip action="zip" file="#expandPath( '/temp/backup.zip' )#" {
    bx:zipparam source="#expandPath( '/app' )#"    prefix="app"
    bx:zipparam source="#expandPath( '/config' )#" prefix="config"
    bx:zipparam source="#expandPath( '/uploads' )#" prefix="uploads"
}

// Filter by pattern
bx:zip action="zip"
    file="#expandPath( '/temp/pdfs.zip' )#"
    source="#expandPath( '/documents' )#"
    filter="*.pdf"
    recurse="true"

// Compression level (0 = store, 9 = maximum)
bx:zip action="zip"
    file="#expandPath( '/temp/compressed.zip' )#"
    source="#expandPath( '/files' )#"
    compressionLevel="9"

Extracting Archives

// Extract all
bx:zip action="unzip"
    file="#expandPath( '/temp/archive.zip' )#"
    destination="#expandPath( '/extracted' )#"
    overwrite="true"

// Extract specific entry
bx:zip action="unzip"
    file="#expandPath( '/temp/archive.zip' )#"
    destination="#expandPath( '/extracted' )#"
    entryPath="docs/report.pdf"

// Extract filtered subset
bx:zip action="unzip"
    file="#expandPath( '/temp/archive.zip' )#"
    destination="#expandPath( '/pdfs' )#"
    filter="*.pdf"

Listing Contents

// List all entries into a query
bx:zip action="list"
    file="#expandPath( '/temp/archive.zip' )#"
    name="local.zipContents"

for ( var row in zipContents ) {
    println( "#row.name# - #row.size# bytes" )
}

// Read a single file without extracting
bx:zip action="read"
    file="#expandPath( '/temp/archive.zip' )#"
    entryPath="config.json"
    variable="local.configContent"

var config = jsonDeserialize( configContent )

Modifying Archives

// Append file to existing archive
bx:zip action="zip" file="#expandPath( '/temp/archive.zip' )#" {
    bx:zipparam source="#expandPath( '/newfile.txt' )#"
}

// Delete entry
bx:zip action="delete"
    file="#expandPath( '/temp/archive.zip' )#"
    entryPath="oldfile.txt"

// Delete multiple entries
bx:zip action="delete" file="#expandPath( '/temp/archive.zip' )#" {
    bx:zipparam entryPath="temp/*"
    bx:zipparam entryPath="logs/*.log"
}

Encryption

// Create encrypted archive
bx:zip action="zip"
    file="#expandPath( '/temp/secure.zip' )#"
    source="#expandPath( '/sensitive' )#"
    password="SecurePassword123"

// Extract encrypted archive
bx:zip action="unzip"
    file="#expandPath( '/temp/secure.zip' )#"
    destination="#expandPath( '/extracted' )#"
    password="SecurePassword123"

ZIP Service Pattern

class singleton {

    function create( required zipFile, required source, overwrite = false, filter = "*" ) {
        if ( !overwrite && fileExists( zipFile ) ) {
            throw( "ZIP file already exists: #zipFile#" )
        }
        bx:zip action="zip" file="#zipFile#" source="#source#" overwrite="#overwrite#" filter="#filter#"
        return getFileInfo( zipFile )
    }

    function extract( required zipFile, required destination, overwrite = false ) {
        if ( !fileExists( zipFile ) ) {
            throw( "ZIP file not found: #zipFile#" )
        }
        if ( !directoryExists( destination ) ) {
            directoryCreate( destination, createPath: true )
        }
        bx:zip action="unzip" file="#zipFile#" destination="#destination#" overwrite="#overwrite#"
    }

    function list( required zipFile, filter = "*" ) {
        bx:zip action="list" file="#zipFile#" filter="#filter#" name="local.contents"
        var files = []
        for ( var row in contents ) {
            files.append( { name: row.name, size: row.size, modified: row.dateLastModified } )
        }
        return files
    }

    function readEntry( required zipFile, required entryPath ) {
        bx:zip action="read" file="#zipFile#" entryPath="#entryPath#" variable="local.content"
        return content
    }

    function hasEntry( required zipFile, required entryPath ) {
        return list( zipFile ).some( ( e ) -> e.name == entryPath )
    }
}

Application Backup Pattern

function createBackup() {
    var timestamp  = dateFormat( now(), "yyyymmdd_HHnnss" )
    var backupFile = expandPath( "/backups/app_#timestamp#.zip" )
    var backupDir  = getDirectoryFromPath( backupFile )

    if ( !directoryExists( backupDir ) ) {
        directoryCreate( backupDir )
    }

    bx:zip action="zip" file="#backupFile#" {
        bx:zipparam source="#expandPath( '/app' )#"    prefix="app"
        bx:zipparam source="#expandPath( '/config' )#" prefix="config"
        bx:zipparam source="#expandPath( '/uploads' )#" prefix="uploads"
    }

    return { file: backupFile, size: getFileInfo( backupFile ).size, created: now() }
}

Best Practices

• Always wrap ZIP operations in try/catch — archives can be corrupt or locked
• Use temp files for processing; clean up in a finally block
• Validate that source/archive paths exist before operating
• Use getTempFile() for dynamically named temporary archives
• Store encryption passwords in environment variables, never hardcoded
• Check archive size after creation for very large source directories

// ✅ Cleanup pattern
var tempZip = getTempFile( getTempDirectory(), "archive" ) & ".zip"
try {
    bx:zip action="zip" file="#tempZip#" source="#source#"
    // use tempZip...
} catch ( any e ) {
    writeLog( "ZIP failed: #e.message#" )
} finally {
    if ( fileExists( tempZip ) ) {
        fileDelete( tempZip )
    }
}