Class ZipFile
- All Implemented Interfaces:
Closeable
,AutoCloseable
java.util.ZipFile
.
This class adds support for file name encodings other than UTF-8
(which is required to work on ZIP files created by native zip tools
and is able to skip a preamble like the one found in self
extracting archives. Furthermore it returns instances of
org.apache.commons.compress.archivers.zip.ZipArchiveEntry
instead of java.util.zip.ZipEntry
.
It doesn't extend java.util.zip.ZipFile
as it would
have to reimplement all methods anyway. Like
java.util.ZipFile
, it uses SeekableByteChannel under the
covers and supports compressed and uncompressed entries. As of
Apache Commons Compress 1.3 it also transparently supports Zip64
extensions and thus individual entries and archives larger than 4
GB or with more than 65536 entries.
The method signatures mimic the ones of
java.util.zip.ZipFile
, with a couple of exceptions:
- There is no getName method.
- entries has been renamed to getEntries.
- getEntries and getEntry return
org.apache.commons.compress.archivers.zip.ZipArchiveEntry
instances. - close is allowed to throw IOException.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate class
Lock-free implementation of BoundedInputStream.private static class
Extends ZipArchiveEntry to store the offset within the archive.private static final class
private static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final SeekableByteChannel
The actual data source.private final String
File name of actual source.(package private) static final int
private long
private long
private long
private static final int
Offset of the field that holds the disk number of the first central directory entry inside the "End of central directory record" relative to the start of the "End of central directory record".private static final int
Offset of the field that holds the location of the first central directory entry inside the "End of central directory record" relative to the start of the "End of central directory record".private static final int
Offset of the field that holds the location of the first central directory entry inside the "End of central directory record" relative to the "number of the disk with the start of the central directory".private static final int
Length of a "central directory" entry structure without file name, extra fields or comment.private static final long
private final ByteBuffer
private final byte[]
private boolean
Whether the file is closed.private final ByteBuffer
private final byte[]
private final String
The encoding to use for file names and the file comment.private final List<ZipArchiveEntry>
List of entries in the order they appear inside the central directory.private static final int
private final boolean
Whether the zip archive is a split zip archiveprivate static final long
Number of bytes in local file header up to the "length of file name" entry.private static final int
Maximum length of the "End of central directory record" with a file comment.(package private) static final int
Length of the "End of central directory record" - which is supposed to be the last structure of the archive - without file comment.private final Map<String,
LinkedList<ZipArchiveEntry>> Maps String to list of ZipArchiveEntrys, name -> actual entries.(package private) static final int
private final Comparator<ZipArchiveEntry>
Compares two ZipArchiveEntries based on their offset within the archive.private static final byte[]
private static final int
private static final int
private static final int
private static final int
private final ByteBuffer
private final byte[]
private final boolean
Whether to look for and use Unicode extra fields.private final ByteBuffer
private final byte[]
private static final int
Offset of the field that holds the disk number of the first central directory entry inside the "Zip64 end of central directory record" relative to the start of the "Zip64 end of central directory record".private static final int
Offset of the field that holds the location of the first central directory entry inside the "Zip64 end of central directory record" relative to the start of the "Zip64 end of central directory record".private static final int
Offset of the field that holds the location of the first central directory entry inside the "Zip64 end of central directory record" relative to the "number of the disk with the start of the central directory".private static final int
Length of the "Zip64 end of central directory locator" - which should be right in front of the "end of central directory record" if one is present at all.private static final int
Offset of the field that holds the location of the "Zip64 end of central directory record" inside the "Zip64 end of central directory locator" relative to the start of the "Zip64 end of central directory locator".private final ZipEncoding
The zip encoding to use for file names and the file comment. -
Constructor Summary
ConstructorsModifierConstructorDescriptionOpens the given file for reading, assuming "UTF8" for file names.Opens the given file for reading, assuming the specified encoding for file names and scanning for unicode extra fields.Opens the given file for reading, assuming the specified encoding for file names.Opens the given file for reading, assuming the specified encoding for file names.Opens the given file for reading, assuming "UTF8".Opens the given file for reading, assuming the specified encoding for file names, scanning unicode extra fields.ZipFile
(SeekableByteChannel channel) Opens the given channel for reading, assuming "UTF8" for file names.ZipFile
(SeekableByteChannel channel, String encoding) Opens the given channel for reading, assuming the specified encoding for file names.ZipFile
(SeekableByteChannel channel, String archiveName, String encoding, boolean useUnicodeExtraFields) Opens the given channel for reading, assuming the specified encoding for file names.ZipFile
(SeekableByteChannel channel, String archiveName, String encoding, boolean useUnicodeExtraFields, boolean ignoreLocalFileHeader) Opens the given channel for reading, assuming the specified encoding for file names.private
ZipFile
(SeekableByteChannel channel, String archiveName, String encoding, boolean useUnicodeExtraFields, boolean closeOnError, boolean ignoreLocalFileHeader) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Whether this class is able to read the given entry.void
close()
Closes the archive.static void
closeQuietly
(ZipFile zipfile) close a zipfile quietly; throw no io fault, do nothing on a null parametervoid
copyRawEntries
(ZipArchiveOutputStream target, ZipArchiveEntryPredicate predicate) Transfer selected entries from this zipfile to a given #ZipArchiveOutputStream.private BoundedArchiveInputStream
createBoundedInputStream
(long start, long remaining) Creates new BoundedInputStream, according to implementation of underlying archive channel.private void
protected void
finalize()
Ensures that the close method of this zipfile is called when there are no more references to it.private long
The encoding to use for file names and the file comment.Returns all entries.getEntries
(String name) Returns all named entries in the same order they appear within the archive's central directory.Returns all entries in physical order.Returns all named entries in the same order their contents appear within the archive.Returns a named entry - ornull
if no entry by that name exists.Returns an InputStream for reading the contents of the given entry.Expose the raw stream of the archive entry (compressed form).getUnixSymlink
(ZipArchiveEntry entry) Convenience method to return the entry's content as a String if isUnixSymlink() returns true for it, otherwise returns null.private Map<ZipArchiveEntry,
ZipFile.NameAndComment> Reads the central directory of the given archive and populates the internal tables with ZipArchiveEntry instances.private void
Searches for either the "Zip64 end of central directory locator" or the "End of central dir record", parses it and positions the stream at the first central directory record.private void
Parses the "End of central dir record" and positions the stream at the first central directory record.private void
Parses the "Zip64 end of central directory locator", finds the "Zip64 end of central directory record" using the parsed information, parses that and positions the stream at the first central directory record.private void
Searches for the and positions the stream at the start of the "End of central dir record".private void
Reads an individual entry of the central directory, creats an ZipArchiveEntry from it and adds it to the global maps.private void
resolveLocalFileHeaderData
(Map<ZipArchiveEntry, ZipFile.NameAndComment> entriesWithoutUTF8Flag) Walks through all recorded entries and adds the data available from the local file header.private void
private int[]
private void
If the entry holds a Zip64 extended information extra field, read sizes from there if the entry's sizes are set to 0xFFFFFFFFF, do the same for the offset of the local file header.private void
skipBytes
(int count) Skips the given number of bytes or throws an EOFException if skipping failed.private boolean
Checks whether the archive starts with a LFH.private boolean
tryToLocateSignature
(long minDistanceFromEnd, long maxDistanceFromEnd, byte[] sig) Searches the archive backwards from minDistance to maxDistance for the given signature, positions the RandomaccessFile right at the signature if it has been found.
-
Field Details
-
HASH_SIZE
private static final int HASH_SIZE- See Also:
-
NIBLET_MASK
static final int NIBLET_MASK- See Also:
-
BYTE_SHIFT
static final int BYTE_SHIFT- See Also:
-
POS_0
private static final int POS_0- See Also:
-
POS_1
private static final int POS_1- See Also:
-
POS_2
private static final int POS_2- See Also:
-
POS_3
private static final int POS_3- See Also:
-
ONE_ZERO_BYTE
private static final byte[] ONE_ZERO_BYTE -
entries
List of entries in the order they appear inside the central directory. -
nameMap
Maps String to list of ZipArchiveEntrys, name -> actual entries. -
encoding
The encoding to use for file names and the file comment.For a list of possible values see http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html. Defaults to UTF-8.
-
zipEncoding
The zip encoding to use for file names and the file comment. -
archiveName
File name of actual source. -
archive
The actual data source. -
useUnicodeExtraFields
private final boolean useUnicodeExtraFieldsWhether to look for and use Unicode extra fields. -
closed
private volatile boolean closedWhether the file is closed. -
isSplitZipArchive
private final boolean isSplitZipArchiveWhether the zip archive is a split zip archive -
dwordBuf
private final byte[] dwordBuf -
wordBuf
private final byte[] wordBuf -
cfhBuf
private final byte[] cfhBuf -
shortBuf
private final byte[] shortBuf -
dwordBbuf
-
wordBbuf
-
cfhBbuf
-
shortBbuf
-
centralDirectoryStartDiskNumber
private long centralDirectoryStartDiskNumber -
centralDirectoryStartRelativeOffset
private long centralDirectoryStartRelativeOffset -
centralDirectoryStartOffset
private long centralDirectoryStartOffset -
CFH_LEN
private static final int CFH_LENLength of a "central directory" entry structure without file name, extra fields or comment.- See Also:
-
CFH_SIG
private static final long CFH_SIG -
MIN_EOCD_SIZE
static final int MIN_EOCD_SIZELength of the "End of central directory record" - which is supposed to be the last structure of the archive - without file comment.- See Also:
-
MAX_EOCD_SIZE
private static final int MAX_EOCD_SIZEMaximum length of the "End of central directory record" with a file comment.- See Also:
-
CFD_LOCATOR_OFFSET
private static final int CFD_LOCATOR_OFFSETOffset of the field that holds the location of the first central directory entry inside the "End of central directory record" relative to the start of the "End of central directory record".- See Also:
-
CFD_DISK_OFFSET
private static final int CFD_DISK_OFFSETOffset of the field that holds the disk number of the first central directory entry inside the "End of central directory record" relative to the start of the "End of central directory record".- See Also:
-
CFD_LOCATOR_RELATIVE_OFFSET
private static final int CFD_LOCATOR_RELATIVE_OFFSETOffset of the field that holds the location of the first central directory entry inside the "End of central directory record" relative to the "number of the disk with the start of the central directory".- See Also:
-
ZIP64_EOCDL_LENGTH
private static final int ZIP64_EOCDL_LENGTHLength of the "Zip64 end of central directory locator" - which should be right in front of the "end of central directory record" if one is present at all.- See Also:
-
ZIP64_EOCDL_LOCATOR_OFFSET
private static final int ZIP64_EOCDL_LOCATOR_OFFSETOffset of the field that holds the location of the "Zip64 end of central directory record" inside the "Zip64 end of central directory locator" relative to the start of the "Zip64 end of central directory locator".- See Also:
-
ZIP64_EOCD_CFD_LOCATOR_OFFSET
private static final int ZIP64_EOCD_CFD_LOCATOR_OFFSETOffset of the field that holds the location of the first central directory entry inside the "Zip64 end of central directory record" relative to the start of the "Zip64 end of central directory record".- See Also:
-
ZIP64_EOCD_CFD_DISK_OFFSET
private static final int ZIP64_EOCD_CFD_DISK_OFFSETOffset of the field that holds the disk number of the first central directory entry inside the "Zip64 end of central directory record" relative to the start of the "Zip64 end of central directory record".- See Also:
-
ZIP64_EOCD_CFD_LOCATOR_RELATIVE_OFFSET
private static final int ZIP64_EOCD_CFD_LOCATOR_RELATIVE_OFFSETOffset of the field that holds the location of the first central directory entry inside the "Zip64 end of central directory record" relative to the "number of the disk with the start of the central directory".- See Also:
-
LFH_OFFSET_FOR_FILENAME_LENGTH
private static final long LFH_OFFSET_FOR_FILENAME_LENGTHNumber of bytes in local file header up to the "length of file name" entry.- See Also:
-
offsetComparator
Compares two ZipArchiveEntries based on their offset within the archive.Won't return any meaningful results if one of the entries isn't part of the archive at all.
- Since:
- 1.1
-
-
Constructor Details
-
ZipFile
Opens the given file for reading, assuming "UTF8" for file names.- Parameters:
f
- the archive.- Throws:
IOException
- if an error occurs while reading the file.
-
ZipFile
Opens the given file for reading, assuming "UTF8".- Parameters:
name
- name of the archive.- Throws:
IOException
- if an error occurs while reading the file.
-
ZipFile
Opens the given file for reading, assuming the specified encoding for file names, scanning unicode extra fields.- Parameters:
name
- name of the archive.encoding
- the encoding to use for file names, use null for the platform's default encoding- Throws:
IOException
- if an error occurs while reading the file.
-
ZipFile
Opens the given file for reading, assuming the specified encoding for file names and scanning for unicode extra fields.- Parameters:
f
- the archive.encoding
- the encoding to use for file names, use null for the platform's default encoding- Throws:
IOException
- if an error occurs while reading the file.
-
ZipFile
Opens the given file for reading, assuming the specified encoding for file names.- Parameters:
f
- the archive.encoding
- the encoding to use for file names, use null for the platform's default encodinguseUnicodeExtraFields
- whether to use InfoZIP Unicode Extra Fields (if present) to set the file names.- Throws:
IOException
- if an error occurs while reading the file.
-
ZipFile
public ZipFile(File f, String encoding, boolean useUnicodeExtraFields, boolean ignoreLocalFileHeader) throws IOException Opens the given file for reading, assuming the specified encoding for file names.By default the central directory record and all local file headers of the archive will be read immediately which may take a considerable amount of time when the archive is big. The
ignoreLocalFileHeader
parameter can be set totrue
which restricts parsing to the central directory. Unfortunately the local file header may contain information not present inside of the central directory which will not be available when the argument is set totrue
. This includes the content of the Unicode extra field, so settingignoreLocalFileHeader
totrue
meansuseUnicodeExtraFields
will be ignored effectively. AlsogetRawInputStream(org.apache.commons.compress.archivers.zip.ZipArchiveEntry)
is always going to returnnull
ifignoreLocalFileHeader
istrue
.- Parameters:
f
- the archive.encoding
- the encoding to use for file names, use null for the platform's default encodinguseUnicodeExtraFields
- whether to use InfoZIP Unicode Extra Fields (if present) to set the file names.ignoreLocalFileHeader
- whether to ignore information stored inside the local file header (see the notes in this method's javadoc)- Throws:
IOException
- if an error occurs while reading the file.- Since:
- 1.19
-
ZipFile
Opens the given channel for reading, assuming "UTF8" for file names.SeekableInMemoryByteChannel
allows you to read from an in-memory archive.- Parameters:
channel
- the archive.- Throws:
IOException
- if an error occurs while reading the file.- Since:
- 1.13
-
ZipFile
Opens the given channel for reading, assuming the specified encoding for file names.SeekableInMemoryByteChannel
allows you to read from an in-memory archive.- Parameters:
channel
- the archive.encoding
- the encoding to use for file names, use null for the platform's default encoding- Throws:
IOException
- if an error occurs while reading the file.- Since:
- 1.13
-
ZipFile
public ZipFile(SeekableByteChannel channel, String archiveName, String encoding, boolean useUnicodeExtraFields) throws IOException Opens the given channel for reading, assuming the specified encoding for file names.SeekableInMemoryByteChannel
allows you to read from an in-memory archive.- Parameters:
channel
- the archive.archiveName
- name of the archive, used for error messages only.encoding
- the encoding to use for file names, use null for the platform's default encodinguseUnicodeExtraFields
- whether to use InfoZIP Unicode Extra Fields (if present) to set the file names.- Throws:
IOException
- if an error occurs while reading the file.- Since:
- 1.13
-
ZipFile
public ZipFile(SeekableByteChannel channel, String archiveName, String encoding, boolean useUnicodeExtraFields, boolean ignoreLocalFileHeader) throws IOException Opens the given channel for reading, assuming the specified encoding for file names.SeekableInMemoryByteChannel
allows you to read from an in-memory archive.By default the central directory record and all local file headers of the archive will be read immediately which may take a considerable amount of time when the archive is big. The
ignoreLocalFileHeader
parameter can be set totrue
which restricts parsing to the central directory. Unfortunately the local file header may contain information not present inside of the central directory which will not be available when the argument is set totrue
. This includes the content of the Unicode extra field, so settingignoreLocalFileHeader
totrue
meansuseUnicodeExtraFields
will be ignored effectively. AlsogetRawInputStream(org.apache.commons.compress.archivers.zip.ZipArchiveEntry)
is always going to returnnull
ifignoreLocalFileHeader
istrue
.- Parameters:
channel
- the archive.archiveName
- name of the archive, used for error messages only.encoding
- the encoding to use for file names, use null for the platform's default encodinguseUnicodeExtraFields
- whether to use InfoZIP Unicode Extra Fields (if present) to set the file names.ignoreLocalFileHeader
- whether to ignore information stored inside the local file header (see the notes in this method's javadoc)- Throws:
IOException
- if an error occurs while reading the file.- Since:
- 1.19
-
ZipFile
private ZipFile(SeekableByteChannel channel, String archiveName, String encoding, boolean useUnicodeExtraFields, boolean closeOnError, boolean ignoreLocalFileHeader) throws IOException - Throws:
IOException
-
-
Method Details
-
getEncoding
The encoding to use for file names and the file comment.- Returns:
- null if using the platform's default character encoding.
-
close
Closes the archive.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
- if an error occurs closing the archive.
-
closeQuietly
close a zipfile quietly; throw no io fault, do nothing on a null parameter- Parameters:
zipfile
- file to close, can be null
-
getEntries
Returns all entries.Entries will be returned in the same order they appear within the archive's central directory.
- Returns:
- all entries as
ZipArchiveEntry
instances
-
getEntriesInPhysicalOrder
Returns all entries in physical order.Entries will be returned in the same order their contents appear within the archive.
- Returns:
- all entries as
ZipArchiveEntry
instances - Since:
- 1.1
-
getEntry
Returns a named entry - ornull
if no entry by that name exists.If multiple entries with the same name exist the first entry in the archive's central directory by that name is returned.
- Parameters:
name
- name of the entry.- Returns:
- the ZipArchiveEntry corresponding to the given name - or
null
if not present.
-
getEntries
Returns all named entries in the same order they appear within the archive's central directory.- Parameters:
name
- name of the entry.- Returns:
- the Iterable<ZipArchiveEntry> corresponding to the given name
- Since:
- 1.6
-
getEntriesInPhysicalOrder
Returns all named entries in the same order their contents appear within the archive.- Parameters:
name
- name of the entry.- Returns:
- the Iterable<ZipArchiveEntry> corresponding to the given name
- Since:
- 1.6
-
canReadEntryData
Whether this class is able to read the given entry.May return false if it is set up to use encryption or a compression method that hasn't been implemented yet.
- Parameters:
ze
- the entry- Returns:
- whether this class is able to read the given entry.
- Since:
- 1.1
-
getRawInputStream
Expose the raw stream of the archive entry (compressed form).This method does not relate to how/if we understand the payload in the stream, since we really only intend to move it on to somewhere else.
- Parameters:
ze
- The entry to get the stream for- Returns:
- The raw input stream containing (possibly) compressed data.
- Since:
- 1.11
-
copyRawEntries
public void copyRawEntries(ZipArchiveOutputStream target, ZipArchiveEntryPredicate predicate) throws IOException Transfer selected entries from this zipfile to a given #ZipArchiveOutputStream. Compression and all other attributes will be as in this file.This method transfers entries based on the central directory of the zip file.
- Parameters:
target
- The zipArchiveOutputStream to write the entries topredicate
- A predicate that selects which entries to write- Throws:
IOException
- on error
-
getInputStream
Returns an InputStream for reading the contents of the given entry.- Parameters:
ze
- the entry to get the stream for.- Returns:
- a stream to read the entry from. The returned stream
implements
InputStreamStatistics
. - Throws:
IOException
- if unable to create an input stream from the zipentry
-
getUnixSymlink
Convenience method to return the entry's content as a String if isUnixSymlink() returns true for it, otherwise returns null.
This method assumes the symbolic link's file name uses the same encoding that as been specified for this ZipFile.
- Parameters:
entry
- ZipArchiveEntry object that represents the symbolic link- Returns:
- entry's content as a String
- Throws:
IOException
- problem with content's input stream- Since:
- 1.5
-
finalize
Ensures that the close method of this zipfile is called when there are no more references to it. -
populateFromCentralDirectory
private Map<ZipArchiveEntry,ZipFile.NameAndComment> populateFromCentralDirectory() throws IOExceptionReads the central directory of the given archive and populates the internal tables with ZipArchiveEntry instances.The ZipArchiveEntrys will know all data that can be obtained from the central directory alone, but not the data that requires the local file header or additional data to be read.
- Returns:
- a map of zipentries that didn't have the language encoding flag set when read.
- Throws:
IOException
-
readCentralDirectoryEntry
private void readCentralDirectoryEntry(Map<ZipArchiveEntry, ZipFile.NameAndComment> noUTF8Flag) throws IOExceptionReads an individual entry of the central directory, creats an ZipArchiveEntry from it and adds it to the global maps.- Parameters:
noUTF8Flag
- map used to collect entries that don't have their UTF-8 flag set and whose name will be set by data read from the local file header later. The current entry may be added to this map.- Throws:
IOException
-
sanityCheckLFHOffset
- Throws:
IOException
-
setSizesAndOffsetFromZip64Extra
If the entry holds a Zip64 extended information extra field, read sizes from there if the entry's sizes are set to 0xFFFFFFFFF, do the same for the offset of the local file header.Ensures the Zip64 extra either knows both compressed and uncompressed size or neither of both as the internal logic in ExtraFieldUtils forces the field to create local header data even if they are never used - and here a field with only one size would be invalid.
- Throws:
IOException
-
positionAtCentralDirectory
Searches for either the "Zip64 end of central directory locator" or the "End of central dir record", parses it and positions the stream at the first central directory record.- Throws:
IOException
-
positionAtCentralDirectory64
Parses the "Zip64 end of central directory locator", finds the "Zip64 end of central directory record" using the parsed information, parses that and positions the stream at the first central directory record. Expects stream to be positioned right behind the "Zip64 end of central directory locator"'s signature.- Throws:
IOException
-
positionAtCentralDirectory32
Parses the "End of central dir record" and positions the stream at the first central directory record. Expects stream to be positioned at the beginning of the "End of central dir record".- Throws:
IOException
-
positionAtEndOfCentralDirectoryRecord
Searches for the and positions the stream at the start of the "End of central dir record".- Throws:
IOException
-
tryToLocateSignature
private boolean tryToLocateSignature(long minDistanceFromEnd, long maxDistanceFromEnd, byte[] sig) throws IOException Searches the archive backwards from minDistance to maxDistance for the given signature, positions the RandomaccessFile right at the signature if it has been found.- Throws:
IOException
-
skipBytes
Skips the given number of bytes or throws an EOFException if skipping failed.- Throws:
IOException
-
resolveLocalFileHeaderData
private void resolveLocalFileHeaderData(Map<ZipArchiveEntry, ZipFile.NameAndComment> entriesWithoutUTF8Flag) throws IOExceptionWalks through all recorded entries and adds the data available from the local file header.Also records the offsets for the data to read from the entries.
- Throws:
IOException
-
fillNameMap
private void fillNameMap() -
setDataOffset
- Throws:
IOException
-
getDataOffset
- Throws:
IOException
-
startsWithLocalFileHeader
Checks whether the archive starts with a LFH. If it doesn't, it may be an empty archive.- Throws:
IOException
-
createBoundedInputStream
Creates new BoundedInputStream, according to implementation of underlying archive channel.
-