(Tcl) Zip Append Files and Entry Type

See more Zip Examples

Demonstrates appending files to a zip object for writing a .zip. Also explains the "entry type".

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set zip [new_CkZip]

# entry is a CkZipEntry

set zipPath "c:/temp/qa_output/out.zip"

# Initialize the zip object with the path of the .zip to be created.
CkZip_NewZip $zip $zipPath

# Recursively append to the zip object the paths of the files and directories in a directory tree.
# At this point we are not creating the .zip, nor are we reading the contents of the files.
# We are simply appending references to the files and directories in the local filesystem
# that will get processed when WriteZip is called.
set recurse 1
set saveExtraPath 0
set archiveOnly 0
set includeHidden 1
set includeSystem 0
set success [CkZip_AppendFilesEx $zip "c:/temp/files_to_zip" $recurse $saveExtraPath $archiveOnly $includeHidden $includeSystem]
if {$success == 0} then {
    puts [CkZip_lastErrorText $zip]
    delete_CkZip $zip
    exit
}

# Note: We can iterate over the references to the files that will be processed when zipping:
set count [CkZip_get_NumEntries $zip]
set i 0
while {$i < $count} {
    set entry [CkZip_GetEntryByIndex $zip $i]
    puts [CkZipEntry_fileName $entry] entryType = [CkZipEntry_get_EntryType $entry]
    delete_CkZipEntry $entry

    set i [expr $i + 1]
}
puts "----"

# Sample output for the above loop:
# The entry type = 1, because these are entries that are references to files in the local filesystem
# that are to be processed when the zip is written.

# hamlet.xml entryType = 1
# hello.pdf entryType = 1
# ...
# ...

# Possible entry type values:
# 0 - Mapped Entry: An entry in an existing Zip file.
# 1 - File Entry: A file not yet in memory, but referenced. These entries are added by calling AppendFiles, AppendFilesEx, AppendOneFileOrDir, etc.
# 2 - Data Entry: An entry containing uncompressed data from memory. These entries are added by calling AppendData, AppendString, etc.
# 3 - Null Entry: An entry that no longer exists in the .zip.
# 4 - New Directory Entry: A directory entry added by calling AppendNewDir. 

# The application can continue to add additional entries.
# For example:
# eTemp is a CkZipEntry
set eTemp [CkZip_AppendString $zip "helloWorld.txt" "Hello World"]
delete_CkZipEntry $eTemp

# Now let's have a look at what will get zipped when we write the zip:
set count [CkZip_get_NumEntries $zip]
set i 0
while {$i < $count} {
    set entry [CkZip_GetEntryByIndex $zip $i]
    puts [CkZipEntry_fileName $entry] entryType = [CkZipEntry_get_EntryType $entry]
    delete_CkZipEntry $entry

    set i [expr $i + 1]
}
puts "----"

# You can see that "helloWorld.txt" is added. 
# Its entryType = 2, which means it is in-memory data (it is not a reference to a file in the local filesystem).

# hamlet.xml entryType = 1
# hello.pdf entryType = 1
# ...
# ...
# helloWorld.txt entryType = 2

# ----------------------------------------------------------------------------
# Now we'll write the zip to a .zip file.
CkZip_put_FileName $zip $zipPath
set success [CkZip_WriteZip $zip]
if {$success == 0} then {
    puts [CkZip_lastErrorText $zip]
    delete_CkZip $zip
    exit
}

# Let's look again at the entries in the .zip
set count [CkZip_get_NumEntries $zip]
set i 0
while {$i < $count} {
    set entry [CkZip_GetEntryByIndex $zip $i]
    puts [CkZipEntry_fileName $entry] entryType = [CkZipEntry_get_EntryType $entry]
    delete_CkZipEntry $entry

    set i [expr $i + 1]
}
puts "----"

# After writing the .zip, the entry types change to 0.
# Entry type 0 indicates that it's a "mapped entry", which is an entry in an existing (and currently open) .zip file.

# hamlet.xml entryType = 0
# hello.pdf entryType = 0
# ...
# ...
# helloWorld.txt entryType = 0

# ----------------------------------------------------------------------------
# If desired, we could continue adding additional entries of any kind (files or data) to the currently open .zip archive...

set eTemp [CkZip_AppendString $zip "helloWorld2.txt" "Hello World 2"]
delete_CkZipEntry $eTemp

# Write the .zip, including the new entries..
set success [CkZip_WriteZip $zip]
if {$success == 0} then {
    puts [CkZip_lastErrorText $zip]
    delete_CkZip $zip
    exit
}

# Finally, let's look again at the entries in the .zip
set count [CkZip_get_NumEntries $zip]
set i 0
while {$i < $count} {
    set entry [CkZip_GetEntryByIndex $zip $i]
    puts [CkZipEntry_fileName $entry] entryType = [CkZipEntry_get_EntryType $entry]
    delete_CkZipEntry $entry

    set i [expr $i + 1]
}
puts "----"

# hamlet.xml entryType = 0
# hello.pdf entryType = 0
# ...
# ...
# helloWorld.txt entryType = 0
# helloWorld2.txt entryType = 0

CkZip_CloseZip $zip

puts "Success"

delete_CkZip $zip