com.alanbuttars.commons.compress.stub.decompress.DecompressArchiveWithStubZipImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-compress Show documentation
Commons Compress is an API which provides a more friendly wrapper around the Apache Commons Compress library.
The newest version!
/*
 * Copyright (C) Alan Buttars
 *
 * 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 com.alanbuttars.commons.compress.stub.decompress;

import static com.alanbuttars.commons.compress.archives.util.Archives.ZIP;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;

import org.apache.commons.compress.archivers.zip.ZipArchiveInputStream;

import com.alanbuttars.commons.compress.archives.input.ArchiveInputStream;
import com.alanbuttars.commons.compress.archives.input.ArchiveInputStreamImpl;
import com.alanbuttars.commons.compress.archives.util.Archives;
import com.alanbuttars.commons.util.annotations.VisibleForTesting;
import com.alanbuttars.commons.util.functions.Function;

/**
 * Extension of {@link DecompressArchiveWithStub} for {@link Archives#ZIP}. For details on the file format, see
 * https://en.wikipedia.org/wiki/Zip_(file_format).
 * 
 * @author Alan Buttars
 *
 */
public class DecompressArchiveWithStubZipImpl extends DecompressArchiveWithStub {

	private boolean allowStoredEntriesWithDataDescriptor;
	private String encoding;
	private boolean useUnicodeExtraFields;

	DecompressArchiveWithStubZipImpl(File source) {
		super(source, ZIP);
		this.allowStoredEntriesWithDataDescriptor = false;
		this.encoding = "UTF8";
		this.useUnicodeExtraFields = true;
	}

	/**
	 * Sets whether the stream will try to read stored entries that use a data descriptor. By default, it is set to
	 * false.
	 */
	public DecompressArchiveWithStubZipImpl andAllowStoredEntriesWithDataDescriptor(boolean allowStoredEntriesWithDataDescriptor) {
		this.allowStoredEntriesWithDataDescriptor = allowStoredEntriesWithDataDescriptor;
		return this;
	}

	/**
	 * Sets the file encoding for the archive. Pass null to use the platform default. By default, it is set
	 * to "UTF8".
	 */
	public DecompressArchiveWithStubZipImpl andEncoding(String encoding) {
		this.encoding = encoding;
		return this;
	}

	/**
	 * Sets whether to use InfoZIP unicode extra fields, if present, to set the file names. By default, it is set to
	 * true.
	 */
	public DecompressArchiveWithStubZipImpl andUseUnicodeExtraFields(boolean useUnicodeExtraFields) {
		this.useUnicodeExtraFields = useUnicodeExtraFields;
		return this;
	}

	@Override
	protected Function decompressionFunction() {
		return new Function() {

			@Override
			public ArchiveInputStream apply(File file) {
				try {
					return createArchiveInputStream(file, allowStoredEntriesWithDataDescriptor, encoding, useUnicodeExtraFields);
				}
				catch (IOException e) {
					throw new RuntimeException(e);
				}
			}

		};
	}

	@VisibleForTesting
	protected ArchiveInputStream createArchiveInputStream(File file, boolean allowStoredEntriesWithDataDescriptor, String encoding, boolean useUnicodeExtraFields) throws IOException {
		FileInputStream fileInputStream = new FileInputStream(file);
		ZipArchiveInputStream archiveInputStream = new ZipArchiveInputStream(fileInputStream, encoding, useUnicodeExtraFields, allowStoredEntriesWithDataDescriptor);
		return new ArchiveInputStreamImpl(archiveInputStream);
	}

}