com.paypal.butterfly.utilities.operations.file.ApplyZip Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of butterfly-utilities Show documentation
null
There is a newer version: 3.2.7
package com.paypal.butterfly.utilities.operations.file;

import com.paypal.butterfly.extensions.api.TOExecutionResult;
import com.paypal.butterfly.extensions.api.TransformationContext;
import com.paypal.butterfly.extensions.api.TransformationOperation;
import com.paypal.butterfly.extensions.api.exception.TransformationDefinitionException;
import com.paypal.butterfly.extensions.api.exception.TransformationOperationException;
import net.lingala.zip4j.core.ZipFile;
import net.lingala.zip4j.exception.ZipException;
import org.apache.commons.io.FileUtils;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.nio.channels.Channels;
import java.nio.channels.ReadableByteChannel;

/**
 * Applies the contents of a zip file, whose location is set as a URL,
 * into the transformed application, preserving the relative folders
 * structure inside the zip file.
 *
 * @author facarvalho
 */
public class ApplyZip extends TransformationOperation {

    private static final String DESCRIPTION = "Download, decompress and place contents of zip file %s at %s";

    private URL zipFileUrl;

    public ApplyZip() {
    }

    /**
     * Applies the contents of a zip file, whose location is set as a URL,
     * into the transformed application, preserving the relative folders
     * structure inside the zip file.
     *
     * @param zipFileUrl URL string to locate the zip file to be applied
     */
    public ApplyZip(String zipFileUrl) {
        try {
            checkForBlankString("Zip file URL", zipFileUrl);
            setZipFileUrl(new URL(zipFileUrl));
        } catch (MalformedURLException e) {
            throw new TransformationDefinitionException("Malformed zip file URL", e);
        }
    }

    /**
     * Applies the contents of a zip file, whose location is set as a URL,
     * into the transformed application, preserving the relative folders
     * structure inside the zip file.
     *
     * @param zipFileUrl URL to locate the zip file to be applied
     */
    public ApplyZip(URL zipFileUrl) {
        setZipFileUrl(zipFileUrl);
    }

    public ApplyZip setZipFileUrl(URL zipFileUrl) {
        checkForNull("Zip file URL", zipFileUrl);
        this.zipFileUrl = zipFileUrl;
        return this;
    }

    public URL getZipFileUrl() {
        return zipFileUrl;
    }

    @Override
    public String getDescription() {
        return String.format(DESCRIPTION, zipFileUrl.getFile(), getRelativePath());
    }

    @Override
    @edu.umd.cs.findbugs.annotations.SuppressFBWarnings (value="NP_ALWAYS_NULL_EXCEPTION")
    protected TOExecutionResult execution(File transformedAppFolder, TransformationContext transformationContext) {
        // Folder where the zip file is supposed to be extracted
        File folder = getAbsoluteFile(transformedAppFolder, transformationContext);
        FileOutputStream fileOutputStream = null;
        TOExecutionResult result = null;
        File zipFileDescriptor = null;
        ReadableByteChannel readableByteChannel = null;
        try {
            readableByteChannel = Channels.newChannel(zipFileUrl.openStream());

            int p = zipFileUrl.getPath().lastIndexOf("/") + 1;
            String fileName = zipFileUrl.getPath().substring(p);

            zipFileDescriptor = new File(folder, fileName);
            fileOutputStream = new FileOutputStream(zipFileDescriptor);
            fileOutputStream.getChannel().transferFrom(readableByteChannel, 0, Long.MAX_VALUE);

            ZipFile zipFile = new ZipFile(zipFileDescriptor);
            zipFile.extractAll(zipFileDescriptor.getParent());

            String details = String.format("Zip file '%s' has been downloaded and decompressed into %s", zipFileUrl.getFile(), getRelativePath(transformedAppFolder, zipFileDescriptor.getParentFile()));
            result = TOExecutionResult.success(this, details);
        } catch (ZipException | IOException e) {
            result = TOExecutionResult.error(this, new TransformationOperationException("File could not be unzipped", e));
        } finally {
            if (fileOutputStream != null) {
                try {
                    fileOutputStream.close();
                } catch (IOException e) {
                    result.addWarning(e);
                }
            }
            if (readableByteChannel != null) {
                try {
                    readableByteChannel.close();
                } catch (IOException e) {
                    result.addWarning(e);
                }
            }
            if (zipFileDescriptor != null) {
                FileUtils.deleteQuietly(zipFileDescriptor);
            }
        }
        return result;
    }

}