de.schlichtherle.util.zip.ZipFile Maven / Gradle / Ivy
/*
* Copyright (C) 2005-2010 Schlichtherle IT Services
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package de.schlichtherle.util.zip;
import de.schlichtherle.io.rof.ReadOnlyFile;
import de.schlichtherle.io.util.SynchronizedInputStream;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.util.Enumeration;
import java.util.zip.ZipException;
/**
* Drop-in replacement for {@link java.util.zip.ZipFile java.util.zip.ZipFile}.
*
* Where the constructors of this class accept a {@code charset}
* parameter, this is used to decode comments and entry names in the ZIP file.
* However, if an entry has bit 11 set in its General Purpose Bit Flag,
* then this parameter is ignored and "UTF-8" is used for this entry.
* This is in accordance to Appendix D of PKWARE's ZIP File Format
* Specification, version 6.3.0 and later.
*
* This class is able to skip a preamble like the one found in self extracting
* archives.
*
* Note that the entries returned by this class are instances of
* {@code de.schlichtherle.util.zip.ZipEntry} instead of
* {@code java.util.zip.ZipEntry}.
*
* This class is thread-safe.
*
* @author Christian Schlichtherle
* @version $Id: ZipFile.java,v 1.5 2010/08/31 11:38:49 christian_schlichtherle Exp $
* @see ZipOutputStream
*/
public class ZipFile extends BasicZipFile {
private final String name;
/**
* Equivalent to {@link #ZipFile(String, String, boolean, boolean)
* ZipFile(name, DEFAULT_CHARSET, true, false)}
*/
public ZipFile(String name)
throws NullPointerException,
FileNotFoundException,
ZipException,
IOException {
super(name, DEFAULT_CHARSET, true, false);
this.name = name;
}
/**
* Equivalent to {@link #ZipFile(String, String, boolean, boolean)
* ZipFile(name, charset, true, false)}
*/
public ZipFile(String name, String charset)
throws NullPointerException,
UnsupportedEncodingException,
FileNotFoundException,
ZipException,
IOException {
super(name, charset, true, false);
this.name = name;
}
/**
* Opens the ZIP file identified by the given path name for reading its
* entries.
*
* @param name The path name of the file.
* @param charset The charset to use for decoding entry names and ZIP file
* comment.
* @param preambled If this is {@code true}, then the ZIP file may have a
* preamble.
* Otherwise, the ZIP file must start with either a Local File
* Header (LFH) signature or an End Of Central Directory (EOCD)
* Header, causing this constructor to fail if the file is actually
* a false positive ZIP file, i.e. not compatible to the ZIP File
* Format Specification.
* This may be useful to read Self Extracting ZIP files (SFX), which
* usually contain the application code required for extraction in
* the preamble.
* @param postambled If this is {@code true}, then the ZIP file may have a
* postamble of arbitrary length.
* Otherwise, the ZIP file must not have a postamble which exceeds
* 64KB size, including the End Of Central Directory record
* (i.e. including the ZIP file comment), causing this constructor
* to fail if the file is actually a false positive ZIP file, i.e.
* not compatible to the ZIP File Format Specification.
* This may be useful to read Self Extracting ZIP files (SFX) with
* large postambles.
* @throws NullPointerException If {@code name} or {@code charset} is
* {@code null}.
* @throws UnsupportedEncodingException If charset is not supported by
* this JVM.
* @throws FileNotFoundException If the file cannot get opened for reading.
* @throws ZipException If the file is not compatible with the ZIP File
* Format Specification.
* @throws IOException On any other I/O related issue.
*/
public ZipFile(
String name,
String charset,
boolean preambled,
boolean postambled)
throws NullPointerException,
UnsupportedEncodingException,
FileNotFoundException,
ZipException,
IOException {
super(name, charset, preambled, postambled);
this.name = name;
}
/**
* Equivalent to {@link #ZipFile(File, String, boolean, boolean)
* ZipFile(file, DEFAULT_CHARSET, true, false)}
*/
public ZipFile(File file)
throws NullPointerException,
FileNotFoundException,
ZipException,
IOException {
super(file, DEFAULT_CHARSET, true, false);
this.name = file.getPath();
}
/**
* Equivalent to {@link #ZipFile(File, String, boolean, boolean)
* ZipFile(file, charset, true, false)}
*/
public ZipFile(File file, String charset)
throws NullPointerException,
UnsupportedEncodingException,
FileNotFoundException,
ZipException,
IOException {
super(file, charset, true, false);
this.name = file.getPath();
}
/**
* Opens the given {@link File} for reading its entries.
*
* @param file The file.
* @param charset The charset to use for decoding entry names and ZIP file
* comment.
* @param preambled If this is {@code true}, then the ZIP file may have a
* preamble.
* Otherwise, the ZIP file must start with either a Local File
* Header (LFH) signature or an End Of Central Directory (EOCD)
* Header, causing this constructor to fail if the file is actually
* a false positive ZIP file, i.e. not compatible to the ZIP File
* Format Specification.
* This may be useful to read Self Extracting ZIP files (SFX), which
* usually contain the application code required for extraction in
* the preamble.
* @param postambled If this is {@code true}, then the ZIP file may have a
* postamble of arbitrary length.
* Otherwise, the ZIP file must not have a postamble which exceeds
* 64KB size, including the End Of Central Directory record
* (i.e. including the ZIP file comment), causing this constructor
* to fail if the file is actually a false positive ZIP file, i.e.
* not compatible to the ZIP File Format Specification.
* This may be useful to read Self Extracting ZIP files (SFX) with
* large postambles.
* @throws NullPointerException If {@code file} or {@code charset} is
* {@code null}.
* @throws UnsupportedEncodingException If charset is not supported by
* this JVM.
* @throws FileNotFoundException If the file cannot get opened for reading.
* @throws ZipException If the file is not compatible with the ZIP File
* Format Specification.
* @throws IOException On any other I/O related issue.
*/
public ZipFile(
File file,
String charset,
boolean preambled,
boolean postambled)
throws NullPointerException,
UnsupportedEncodingException,
FileNotFoundException,
ZipException,
IOException {
super(file, charset, preambled, postambled);
this.name = file.getPath();
}
/**
* Equivalent to {@link #ZipFile(ReadOnlyFile, String, boolean, boolean)
* ZipFile(rof, DEFAULT_CHARSET, true, false)}
*/
public ZipFile(ReadOnlyFile rof)
throws NullPointerException,
FileNotFoundException,
ZipException,
IOException {
super(rof, DEFAULT_CHARSET, true, false);
this.name = null;
}
/**
* Equivalent to {@link #ZipFile(ReadOnlyFile, String, boolean, boolean)
* ZipFile(rof, charset, true, false)}
*/
public ZipFile(ReadOnlyFile rof, String charset)
throws NullPointerException,
UnsupportedEncodingException,
FileNotFoundException,
ZipException,
IOException {
super(rof, charset, true, false);
this.name = null;
}
/**
* Opens the given {@link ReadOnlyFile} for reading its entries.
*
* @param rof The random access read only file.
* @param charset The charset to use for decoding entry names and ZIP file
* comment.
* @param preambled If this is {@code true}, then the ZIP file may have a
* preamble.
* Otherwise, the ZIP file must start with either a Local File
* Header (LFH) signature or an End Of Central Directory (EOCD)
* Header, causing this constructor to fail if the file is actually
* a false positive ZIP file, i.e. not compatible to the ZIP File
* Format Specification.
* This may be useful to read Self Extracting ZIP files (SFX), which
* usually contain the application code required for extraction in
* the preamble.
* @param postambled If this is {@code true}, then the ZIP file may have a
* postamble of arbitrary length.
* Otherwise, the ZIP file must not have a postamble which exceeds
* 64KB size, including the End Of Central Directory record
* (i.e. including the ZIP file comment), causing this constructor
* to fail if the file is actually a false positive ZIP file, i.e.
* not compatible to the ZIP File Format Specification.
* This may be useful to read Self Extracting ZIP files (SFX) with
* large postambles.
* @throws NullPointerException If {@code rof} or {@code charset} is
* {@code null}.
* @throws UnsupportedEncodingException If charset is not supported by
* this JVM.
* @throws FileNotFoundException If the file cannot get opened for reading.
* @throws ZipException If the file is not compatible with the ZIP File
* Format Specification.
* @throws IOException On any other I/O related issue.
*/
public ZipFile(
ReadOnlyFile rof,
String charset,
boolean preambled,
boolean postambled)
throws NullPointerException,
UnsupportedEncodingException,
FileNotFoundException,
ZipException,
IOException {
super(rof, charset, preambled, postambled);
this.name = null;
}
/**
* Returns the path name of the ZIP file or {@code null} if this object
* was created with a {@link ReadOnlyFile}.
*
* @since TrueZIP 6.8
*/
public String getName() {
return name;
}
/** Enumerates clones of all entries in this ZIP file. */
public synchronized Enumeration entries() {
return new Enumeration() {
Enumeration e = ZipFile.super.entries();
public boolean hasMoreElements() {
return e.hasMoreElements();
}
public Object nextElement() {
return ((ZipEntry) e.nextElement()).clone();
}
};
}
/**
* Returns a clone of the {@link ZipEntry} for the given name or
* {@code null} if no entry with that name exists.
*
* @param name Name of the ZIP entry.
*/
public synchronized ZipEntry getEntry(String name) {
ZipEntry ze = super.getEntry(name);
return ze != null ? (ZipEntry) ze.clone() : null;
}
public synchronized InputStream getPreambleInputStream() throws IOException {
return new SynchronizedInputStream(
super.getPreambleInputStream(),
this);
}
public synchronized InputStream getPostambleInputStream() throws IOException {
return new SynchronizedInputStream(
super.getPostambleInputStream(),
this);
}
public synchronized boolean busy() {
return super.busy();
}
protected synchronized InputStream getInputStream(
String name, boolean check, boolean inflate)
throws IOException {
final InputStream in = super.getInputStream(name, check, inflate);
return in != null ? new SynchronizedInputStream(in, this) : null;
}
public synchronized void close() throws IOException {
super.close();
}
}