org.apache.ant.compress.taskdefs.Zip Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ant-compress Show documentation
Show all versions of ant-compress Show documentation
Provides tasks and types that deal with AR, CPIO, TAR, DUMP and
ZIP archives as well as BZIP2, PACK200, GZIP and XZ compressed files
based on Apache Commons Compress.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.ant.compress.taskdefs;
import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.util.HashMap;
import java.util.Map;
import java.util.zip.Deflater;
import org.apache.ant.compress.util.ZipStreamFactory;
import org.apache.ant.compress.resources.ZipFileSet;
import org.apache.commons.compress.archivers.ArchiveEntry;
import org.apache.commons.compress.archivers.ArchiveOutputStream;
import org.apache.commons.compress.archivers.zip.Zip64Mode;
import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
import org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream;
import org.apache.tools.ant.types.ArchiveFileSet;
import org.apache.tools.ant.types.EnumeratedAttribute;
import org.apache.tools.ant.types.Resource;
/**
* Creates zip archives.
*/
public class Zip extends ArchiveBase {
private int level = Deflater.DEFAULT_COMPRESSION;
private String comment = "";
private boolean keepCompression = false;
private boolean fallBackToUTF8 = false;
private boolean useLanguageEncodingFlag = true;
private UnicodeExtraField createUnicodeExtraFields = UnicodeExtraField.NEVER;
private Zip64Enum zip64Mode = Zip64Enum.AS_NEEDED;
public Zip() {
setFactory(new ZipStreamFactory() {
public ArchiveOutputStream getArchiveStream(OutputStream stream,
String encoding)
throws IOException {
ZipArchiveOutputStream o =
(ZipArchiveOutputStream) super.getArchiveStream(stream,
encoding);
configure(o);
return o;
}
public ArchiveOutputStream getArchiveOutputStream(File f,
String encoding)
throws IOException {
ZipArchiveOutputStream o = (ZipArchiveOutputStream)
super.getArchiveOutputStream(f, encoding);
configure(o);
return o;
}
});
setEntryBuilder(
new ArchiveBase.EntryBuilder() {
public ArchiveEntry buildEntry(ArchiveBase.ResourceWithFlags r) {
boolean isDir = r.getResource().isDirectory();
ZipArchiveEntry ent = new ZipArchiveEntry(r.getName());
ent.setTime(round(r.getResource().getLastModified(), 2000));
ent.setSize(isDir ? 0 : r.getResource().getSize());
if (!isDir && r.getCollectionFlags().hasModeBeenSet()) {
ent.setUnixMode(r.getCollectionFlags().getMode());
} else if (isDir
&& r.getCollectionFlags().hasDirModeBeenSet()) {
ent.setUnixMode(r.getCollectionFlags().getDirMode());
} else if (r.getResourceFlags().hasModeBeenSet()) {
ent.setUnixMode(r.getResourceFlags().getMode());
} else {
ent.setUnixMode(isDir
? ArchiveFileSet.DEFAULT_DIR_MODE
: ArchiveFileSet.DEFAULT_FILE_MODE);
}
if (r.getResourceFlags().getZipExtraFields() != null) {
ent.setExtraFields(r.getResourceFlags()
.getZipExtraFields());
}
if (keepCompression
&& r.getResourceFlags().hasCompressionMethod()) {
ent.setMethod(r.getResourceFlags()
.getCompressionMethod());
}
return ent;
}
});
setFileSetBuilder(new ArchiveBase.FileSetBuilder() {
public ArchiveFileSet buildFileSet(Resource dest) {
ArchiveFileSet afs = new ZipFileSet();
afs.setSrcResource(dest);
return afs;
}
});
}
/**
* Set the compression level to use. Default is
* Deflater.DEFAULT_COMPRESSION.
* @param level compression level.
*/
public void setLevel(int level) {
this.level = level;
}
/**
* Comment to use for archive.
*
* @param comment The content of the comment.
*/
public void setComment(String comment) {
this.comment = comment;
}
/**
* Whether the original compression of entries coming from a ZIP
* archive should be kept (for example when updating an archive).
* Default is false.
* @param keep if true, keep the original compression
*/
public void setKeepCompression(boolean keep) {
keepCompression = keep;
}
/**
* Whether to fall back to UTF-8 if a name cannot be encoded using
* the specified encoding.
*
* Defaults to false.
*/
public void setFallBackToUTF8(boolean b) {
fallBackToUTF8 = b;
}
/**
* Whether to set the language encoding flag.
*/
public void setUseLanguageEncodingFlag(boolean b) {
useLanguageEncodingFlag = b;
}
/**
* Whether Unicode extra fields will be created.
*/
public void setCreateUnicodeExtraFields(UnicodeExtraField b) {
createUnicodeExtraFields = b;
}
/**
* Whether to create Zip64 extended information.
*
* @since Apache Compress Antlib 1.1
*/
public void setZip64Mode(Zip64Enum mode) {
zip64Mode = mode;
}
private void configure(ZipArchiveOutputStream o) {
o.setLevel(level);
o.setComment(comment);
o.setFallbackToUTF8(fallBackToUTF8);
o.setUseLanguageEncodingFlag(useLanguageEncodingFlag);
o.setCreateUnicodeExtraFields(createUnicodeExtraFields.getPolicy());
o.setUseZip64(zip64Mode.getPolicy());
}
/**
* Policiy for creation of Unicode extra fields: never, always or
* not-encodeable.
*/
public static final class UnicodeExtraField extends EnumeratedAttribute {
private static final Map POLICIES = new HashMap();
private static final String NEVER_KEY = "never";
private static final String ALWAYS_KEY = "always";
private static final String N_E_KEY = "not-encodeable";
static {
POLICIES.put(NEVER_KEY,
ZipArchiveOutputStream.UnicodeExtraFieldPolicy.NEVER);
POLICIES.put(ALWAYS_KEY,
ZipArchiveOutputStream.UnicodeExtraFieldPolicy.ALWAYS);
POLICIES.put(N_E_KEY,
ZipArchiveOutputStream.UnicodeExtraFieldPolicy
.NOT_ENCODEABLE);
}
public String[] getValues() {
return new String[] {NEVER_KEY, ALWAYS_KEY, N_E_KEY};
}
public static final UnicodeExtraField NEVER =
new UnicodeExtraField(NEVER_KEY);
private UnicodeExtraField(String name) {
setValue(name);
}
public UnicodeExtraField() {
}
public ZipArchiveOutputStream.UnicodeExtraFieldPolicy getPolicy() {
return (ZipArchiveOutputStream.UnicodeExtraFieldPolicy)
POLICIES.get(getValue());
}
}
/**
* Policiy for creation of Zip64 extended information: never, always or
* as-needed.
* @since Apache Compress Antlib 1.1
*/
public static final class Zip64Enum extends EnumeratedAttribute {
private static final Map POLICIES = new HashMap();
private static final String NEVER_KEY = "never";
private static final String ALWAYS_KEY = "always";
private static final String A_N_KEY = "as-needed";
static {
POLICIES.put(NEVER_KEY, Zip64Mode.Never);
POLICIES.put(ALWAYS_KEY, Zip64Mode.Always);
POLICIES.put(A_N_KEY, Zip64Mode.AsNeeded);
}
public String[] getValues() {
return new String[] {NEVER_KEY, ALWAYS_KEY, A_N_KEY};
}
public static final Zip64Enum AS_NEEDED = new Zip64Enum(A_N_KEY);
private Zip64Enum(String name) {
setValue(name);
}
public Zip64Enum() {
}
public Zip64Mode getPolicy() {
return (Zip64Mode) POLICIES.get(getValue());
}
}
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy