All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.commons.compress.archivers.examples.Expander Maven / Gradle / Ivy

Go to download

Apache Commons Compress software defines an API for working with compression and archive formats. These include: bzip2, gzip, pack200, lzma, xz, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4, Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z, arj.

There is a newer version: 1.27.1
Show newest version
/*
 * 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.commons.compress.archivers.examples;

import java.io.BufferedInputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.channels.Channels;
import java.nio.channels.FileChannel;
import java.nio.channels.SeekableByteChannel;
import java.nio.file.Files;
import java.nio.file.StandardOpenOption;
import java.util.Enumeration;

import org.apache.commons.compress.archivers.ArchiveEntry;
import org.apache.commons.compress.archivers.ArchiveException;
import org.apache.commons.compress.archivers.ArchiveInputStream;
import org.apache.commons.compress.archivers.ArchiveStreamFactory;
import org.apache.commons.compress.archivers.sevenz.SevenZFile;
import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
import org.apache.commons.compress.archivers.zip.ZipFile;
import org.apache.commons.compress.utils.IOUtils;

/**
 * Provides a high level API for expanding archives.
 * @since 1.17
 */
public class Expander {

    private interface ArchiveEntrySupplier {
        ArchiveEntry getNextReadableEntry() throws IOException;
    }

    private interface EntryWriter {
        void writeEntryDataTo(ArchiveEntry entry, OutputStream out) throws IOException;
    }

    /**
     * Expands {@code archive} into {@code targetDirectory}.
     *
     * 

Tries to auto-detect the archive's format.

* * @param archive the file to expand * @param targetDirectory the directory to write to * @throws IOException if an I/O error occurs * @throws ArchiveException if the archive cannot be read for other reasons */ public void expand(File archive, File targetDirectory) throws IOException, ArchiveException { String format = null; try (InputStream i = new BufferedInputStream(Files.newInputStream(archive.toPath()))) { format = new ArchiveStreamFactory().detect(i); } expand(format, archive, targetDirectory); } /** * Expands {@code archive} into {@code targetDirectory}. * * @param archive the file to expand * @param targetDirectory the directory to write to * @param format the archive format. This uses the same format as * accepted by {@link ArchiveStreamFactory}. * @throws IOException if an I/O error occurs * @throws ArchiveException if the archive cannot be read for other reasons */ public void expand(String format, File archive, File targetDirectory) throws IOException, ArchiveException { if (prefersSeekableByteChannel(format)) { try (SeekableByteChannel c = FileChannel.open(archive.toPath(), StandardOpenOption.READ)) { expand(format, c, targetDirectory, CloseableConsumer.CLOSING_CONSUMER); } return; } try (InputStream i = new BufferedInputStream(Files.newInputStream(archive.toPath()))) { expand(format, i, targetDirectory, CloseableConsumer.CLOSING_CONSUMER); } } /** * Expands {@code archive} into {@code targetDirectory}. * *

Tries to auto-detect the archive's format.

* *

This method creates a wrapper around the archive stream * which is never closed and thus leaks resources, please use * {@link #expand(InputStream,File,CloseableConsumer)} * instead.

* * @param archive the file to expand * @param targetDirectory the directory to write to * @throws IOException if an I/O error occurs * @throws ArchiveException if the archive cannot be read for other reasons * @deprecated this method leaks resources */ @Deprecated public void expand(InputStream archive, File targetDirectory) throws IOException, ArchiveException { expand(archive, targetDirectory, CloseableConsumer.NULL_CONSUMER); } /** * Expands {@code archive} into {@code targetDirectory}. * *

Tries to auto-detect the archive's format.

* *

This method creates a wrapper around the archive stream and * the caller of this method is responsible for closing it - * probably at the same time as closing the stream itself. The * caller is informed about the wrapper object via the {@code * closeableConsumer} callback as soon as it is no longer needed * by this class.

* * @param archive the file to expand * @param targetDirectory the directory to write to * @param closeableConsumer is informed about the stream wrapped around the passed in stream * @throws IOException if an I/O error occurs * @throws ArchiveException if the archive cannot be read for other reasons * @since 1.19 */ public void expand(InputStream archive, File targetDirectory, CloseableConsumer closeableConsumer) throws IOException, ArchiveException { try (CloseableConsumerAdapter c = new CloseableConsumerAdapter(closeableConsumer)) { expand(c.track(new ArchiveStreamFactory().createArchiveInputStream(archive)), targetDirectory); } } /** * Expands {@code archive} into {@code targetDirectory}. * *

This method creates a wrapper around the archive stream * which is never closed and thus leaks resources, please use * {@link #expand(String,InputStream,File,CloseableConsumer)} * instead.

* * @param archive the file to expand * @param targetDirectory the directory to write to * @param format the archive format. This uses the same format as * accepted by {@link ArchiveStreamFactory}. * @throws IOException if an I/O error occurs * @throws ArchiveException if the archive cannot be read for other reasons * @deprecated this method leaks resources */ @Deprecated public void expand(String format, InputStream archive, File targetDirectory) throws IOException, ArchiveException { expand(format, archive, targetDirectory, CloseableConsumer.NULL_CONSUMER); } /** * Expands {@code archive} into {@code targetDirectory}. * *

This method creates a wrapper around the archive stream and * the caller of this method is responsible for closing it - * probably at the same time as closing the stream itself. The * caller is informed about the wrapper object via the {@code * closeableConsumer} callback as soon as it is no longer needed * by this class.

* * @param archive the file to expand * @param targetDirectory the directory to write to * @param format the archive format. This uses the same format as * accepted by {@link ArchiveStreamFactory}. * @param closeableConsumer is informed about the stream wrapped around the passed in stream * @throws IOException if an I/O error occurs * @throws ArchiveException if the archive cannot be read for other reasons * @since 1.19 */ public void expand(String format, InputStream archive, File targetDirectory, CloseableConsumer closeableConsumer) throws IOException, ArchiveException { try (CloseableConsumerAdapter c = new CloseableConsumerAdapter(closeableConsumer)) { expand(c.track(new ArchiveStreamFactory().createArchiveInputStream(format, archive)), targetDirectory); } } /** * Expands {@code archive} into {@code targetDirectory}. * *

This method creates a wrapper around the archive channel * which is never closed and thus leaks resources, please use * {@link #expand(String,SeekableByteChannel,File,CloseableConsumer)} * instead.

* * @param archive the file to expand * @param targetDirectory the directory to write to * @param format the archive format. This uses the same format as * accepted by {@link ArchiveStreamFactory}. * @throws IOException if an I/O error occurs * @throws ArchiveException if the archive cannot be read for other reasons * @deprecated this method leaks resources */ @Deprecated public void expand(String format, SeekableByteChannel archive, File targetDirectory) throws IOException, ArchiveException { expand(format, archive, targetDirectory, CloseableConsumer.NULL_CONSUMER); } /** * Expands {@code archive} into {@code targetDirectory}. * *

This method creates a wrapper around the archive channel and * the caller of this method is responsible for closing it - * probably at the same time as closing the channel itself. The * caller is informed about the wrapper object via the {@code * closeableConsumer} callback as soon as it is no longer needed * by this class.

* * @param archive the file to expand * @param targetDirectory the directory to write to * @param format the archive format. This uses the same format as * accepted by {@link ArchiveStreamFactory}. * @param closeableConsumer is informed about the stream wrapped around the passed in channel * @throws IOException if an I/O error occurs * @throws ArchiveException if the archive cannot be read for other reasons * @since 1.19 */ public void expand(String format, SeekableByteChannel archive, File targetDirectory, CloseableConsumer closeableConsumer) throws IOException, ArchiveException { try (CloseableConsumerAdapter c = new CloseableConsumerAdapter(closeableConsumer)) { if (!prefersSeekableByteChannel(format)) { expand(format, c.track(Channels.newInputStream(archive)), targetDirectory); } else if (ArchiveStreamFactory.ZIP.equalsIgnoreCase(format)) { expand(c.track(new ZipFile(archive)), targetDirectory); } else if (ArchiveStreamFactory.SEVEN_Z.equalsIgnoreCase(format)) { expand(c.track(new SevenZFile(archive)), targetDirectory); } else { // never reached as prefersSeekableByteChannel only returns true for ZIP and 7z throw new ArchiveException("Don't know how to handle format " + format); } } } /** * Expands {@code archive} into {@code targetDirectory}. * * @param archive the file to expand * @param targetDirectory the directory to write to * @throws IOException if an I/O error occurs * @throws ArchiveException if the archive cannot be read for other reasons */ public void expand(final ArchiveInputStream archive, File targetDirectory) throws IOException, ArchiveException { expand(new ArchiveEntrySupplier() { @Override public ArchiveEntry getNextReadableEntry() throws IOException { ArchiveEntry next = archive.getNextEntry(); while (next != null && !archive.canReadEntryData(next)) { next = archive.getNextEntry(); } return next; } }, new EntryWriter() { @Override public void writeEntryDataTo(ArchiveEntry entry, OutputStream out) throws IOException { IOUtils.copy(archive, out); } }, targetDirectory); } /** * Expands {@code archive} into {@code targetDirectory}. * * @param archive the file to expand * @param targetDirectory the directory to write to * @throws IOException if an I/O error occurs * @throws ArchiveException if the archive cannot be read for other reasons */ public void expand(final ZipFile archive, File targetDirectory) throws IOException, ArchiveException { final Enumeration entries = archive.getEntries(); expand(new ArchiveEntrySupplier() { @Override public ArchiveEntry getNextReadableEntry() throws IOException { ZipArchiveEntry next = entries.hasMoreElements() ? entries.nextElement() : null; while (next != null && !archive.canReadEntryData(next)) { next = entries.hasMoreElements() ? entries.nextElement() : null; } return next; } }, new EntryWriter() { @Override public void writeEntryDataTo(ArchiveEntry entry, OutputStream out) throws IOException { try (InputStream in = archive.getInputStream((ZipArchiveEntry) entry)) { IOUtils.copy(in, out); } } }, targetDirectory); } /** * Expands {@code archive} into {@code targetDirectory}. * * @param archive the file to expand * @param targetDirectory the directory to write to * @throws IOException if an I/O error occurs * @throws ArchiveException if the archive cannot be read for other reasons */ public void expand(final SevenZFile archive, File targetDirectory) throws IOException, ArchiveException { expand(new ArchiveEntrySupplier() { @Override public ArchiveEntry getNextReadableEntry() throws IOException { return archive.getNextEntry(); } }, new EntryWriter() { @Override public void writeEntryDataTo(ArchiveEntry entry, OutputStream out) throws IOException { final byte[] buffer = new byte[8024]; int n; while (-1 != (n = archive.read(buffer))) { out.write(buffer, 0, n); } } }, targetDirectory); } private boolean prefersSeekableByteChannel(String format) { return ArchiveStreamFactory.ZIP.equalsIgnoreCase(format) || ArchiveStreamFactory.SEVEN_Z.equalsIgnoreCase(format); } private void expand(ArchiveEntrySupplier supplier, EntryWriter writer, File targetDirectory) throws IOException { String targetDirPath = targetDirectory.getCanonicalPath(); if (!targetDirPath.endsWith(File.separator)) { targetDirPath += File.separator; } ArchiveEntry nextEntry = supplier.getNextReadableEntry(); while (nextEntry != null) { File f = new File(targetDirectory, nextEntry.getName()); if (!f.getCanonicalPath().startsWith(targetDirPath)) { throw new IOException("Expanding " + nextEntry.getName() + " would create file outside of " + targetDirectory); } if (nextEntry.isDirectory()) { if (!f.isDirectory() && !f.mkdirs()) { throw new IOException("Failed to create directory " + f); } } else { File parent = f.getParentFile(); if (!parent.isDirectory() && !parent.mkdirs()) { throw new IOException("Failed to create directory " + parent); } try (OutputStream o = Files.newOutputStream(f.toPath())) { writer.writeEntryDataTo(nextEntry, o); } } nextEntry = supplier.getNextReadableEntry(); } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy