com.ibm.watson.developer_cloud.retrieve_and_rank.v1.util.ZipUtils.java Source code

Introduction

Here is the source code for com.ibm.watson.developer_cloud.retrieve_and_rank.v1.util.ZipUtils.java

Source

/**
 * Copyright 2015 IBM Corp. All Rights Reserved.
 * 
 * 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.ibm.watson.developer_cloud.retrieve_and_rank.v1.util;

import static com.ibm.watson.developer_cloud.retrieve_and_rank.v1.util.Messages.CONFIG_NOT_DIR_1;
import static com.ibm.watson.developer_cloud.retrieve_and_rank.v1.util.Messages.ERROR_CREATING_ZIP_1;
import static com.ibm.watson.developer_cloud.retrieve_and_rank.v1.util.Messages.ERROR_READING_FILE_1;
import static com.ibm.watson.developer_cloud.retrieve_and_rank.v1.util.Messages.ERROR_ZIPPING_1;
import static com.ibm.watson.developer_cloud.retrieve_and_rank.v1.util.Messages.bundleName;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;

import org.apache.commons.lang3.StringUtils;

/**
 * Utility class to manage Solr ZIP configuration files.
 */
public class ZipUtils {
    private static final MessageFormatter MSGS = new MessageFormatter(bundleName());

    /**
     * Builds the configuration ZIP file.
     * 
     * @param configName the configuration name
     * @param parentDir the parent directory
     * @return the file
     */
    public static File buildConfigZip(final String configName, final File parentDir) {
        if (!parentDir.isDirectory()) {
            throw new RuntimeException(MSGS.format(CONFIG_NOT_DIR_1, parentDir.toString()));
        }

        final File zipFile = createEmptyZipFile(configName);
        final ZipOutputStream out;
        try {
            out = new ZipOutputStream(new FileOutputStream(zipFile));
        } catch (final FileNotFoundException e) {
            throw new RuntimeException(MSGS.format(ERROR_ZIPPING_1, parentDir.toString()), e);
        }

        try {
            addFilesToZip(parentDir, out, parentDir);
            return zipFile;
        } catch (final IOException e) {
            throw new RuntimeException(MSGS.format(ERROR_ZIPPING_1, parentDir.toString()), e);
        } finally {
            try {
                if (out != null) {
                    out.close();
                }
            } catch (final IOException e) {
                throw new RuntimeException(e);
            }
        }
    }

    /**
     * Creates the empty ZIP file.
     * 
     * @param prefix file name prefix
     * @return the file
     */
    public static File createEmptyZipFile(String prefix) {
        try {
            return File.createTempFile(prefix, ".zip");
        } catch (final IOException e) {
            throw new RuntimeException(MSGS.format(ERROR_CREATING_ZIP_1, prefix + ".zip"), e);
        }
    }

    private static void writeZipEntry(ZipOutputStream out, String name, byte[] data) throws IOException {
        final ZipEntry entry = new ZipEntry(StringUtils.removeStart(name, "/"));
        out.putNextEntry(entry);
        out.write(data, 0, data.length);
        out.closeEntry();
    }

    private static void addFilesToZip(final File currentParentDir, final ZipOutputStream out,
            final File globalParentDir) throws IOException {
        for (final File child : currentParentDir.listFiles()) {
            if (child.isDirectory()) {
                addFilesToZip(child, out, globalParentDir);
            } else if (child.isFile()) {
                writeZipEntry(out, globalParentDir.toURI().relativize(child.toURI()).toString(), readBytes(child));
            }
        }
    }

    private static byte[] readBytes(File file) {
        FileInputStream in = null;
        final byte buffer[] = new byte[(int) file.length()];
        try {
            in = new FileInputStream(file);
            in.read(buffer);
        } catch (final IOException e) {
            MSGS.format(ERROR_READING_FILE_1, file.toString(), e);
        }
        if (in != null) {
            try {
                in.close();
            } catch (final IOException e) {
                // fail quietly
            }
        }
        return buffer;
    }
}