source: trunk/gli/src/org/greenstone/gatherer/util/ZipTools.java@ 12730

/**
 *############################################################################
 * A component of the Greenstone Librarian Interface, part of the Greenstone
 * digital library suite from the New Zealand Digital Library Project at the
 * University of Waikato, New Zealand.
 *
 * Author: David Bainbridge, NZDL Project, University of Waikato, NZ
 *
 * Copyright (C) 2005 New Zealand Digital Library Project
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *############################################################################
 */

package org.greenstone.gatherer.util;


import java.io.*;
import java.util.*;
import java.util.zip.*;
import org.w3c.dom.*;


public class ZipTools
{
    static public void unzipFile(String zip_file_path, String base_directory_path)
    {
    try {
        ZipFile zip_file = new ZipFile(new File(zip_file_path), ZipFile.OPEN_READ);
        
        Enumeration e = zip_file.entries(); 
        while (e.hasMoreElements()) {
        ZipEntry zip_entry = (ZipEntry) e.nextElement();
        File zip_entry_file = new File(base_directory_path + zip_entry.getName());
        // System.err.println("    Unzipping: " + zip_entry_file.getAbsolutePath());

        // Directory case
        if (zip_entry.isDirectory()) {
            // Create named directory, if it doesn't already exist
            if (!zip_entry_file.exists() && !zip_entry_file.mkdirs()) {
            System.err.println("Error: unable to create directory " + zip_entry_file);
            }
        }

        // File case
        else {
            // Write out file to disk

            // Make sure its parent directory exists.
            File dir = new File(zip_entry_file.getParent());
            dir.mkdirs();

            // Set up input stream
            InputStream zis = zip_file.getInputStream(zip_entry); 
            BufferedInputStream bzis = new BufferedInputStream(zis); 
            DataInputStream dbzis = new DataInputStream(bzis);

            // Set up output stream
            FileOutputStream fzos = new FileOutputStream(zip_entry_file);
            BufferedOutputStream bfzos = new BufferedOutputStream(fzos);

            byte[] buf = new byte[1024];
            int len;
            while ((len = dbzis.read(buf)) >= 0) {
            bfzos.write(buf,0,len);
            }

            dbzis.close();
            bzis.close();
            zis.close();

            bfzos.close();
            fzos.close();
        }
        }

        zip_file.close();
    } 
    catch (Exception exception) {
        exception.printStackTrace();
    }
    }


    static public void zipFiles(String zip_file_path, String base_directory_path, String[] relative_file_paths)
    {
    try {
        ZipOutputStream zos = new ZipOutputStream(new FileOutputStream(zip_file_path));
        ZipFilter null_zip_filter = new NullZipFilter();

        // Add each file/directory in turn to the zip file
        for (int i = 0; i < relative_file_paths.length; i++) {
        String relative_file_path = relative_file_paths[i];
        addFileToZip(zos, base_directory_path, relative_file_path, null_zip_filter);
        }

        zos.close();
    }
    catch (Exception exception) {
        exception.printStackTrace();
    }
    }


    static public void addFileToZip(ZipOutputStream zos, String base_directory_path, String relative_file_path, ZipFilter zip_filter)
    {
    File file = new File(base_directory_path + File.separator + relative_file_path);

    // Check that the file/directory exists
    if (!file.exists()) {
        System.err.println("File " + file + " does not exist!");
        return;
    }

    try {
        // Directory case
        if (file.isDirectory()) {
        // Add a zip entry for this directory
        // Actually, don't -- this messes things up completely on Windows and doesn't seem to matter on Linux
        // zos.putNextEntry(new ZipEntry(relative_file_path + File.separator));

        // Apply recursively to each of the children of the directory
        File[] child_files = file.listFiles();
        for (int i = 0; i < child_files.length; i++) {
            addFileToZip(zos, base_directory_path, relative_file_path + File.separator + child_files[i].getName(), zip_filter);
        }
        }

        // File case
        else {
        // Add a zip entry for this file
        if (zip_filter.shouldIncludeFile(relative_file_path)) {
            // Always use Unix style paths in zip files, even on Windows
            zos.putNextEntry(new ZipEntry(relative_file_path.replace('\\', '/')));

            if (zip_filter.shouldIncludeFileContent(relative_file_path)) {
            BufferedInputStream bis = new BufferedInputStream(new FileInputStream(file));
            byte[] data = new byte[1024];
            int bytes_read;
            while ((bytes_read = zip_filter.filterFileContent(bis, data, 1024)) > -1) {
                zos.write(data, 0, bytes_read);
            }
            bis.close();
            }
        }
        }
    }
    catch (Exception exception) {
        exception.printStackTrace();
    }
    }


    public interface ZipFilter
    {
    public boolean shouldIncludeFile(String relative_file_path);

    public boolean shouldIncludeFileContent(String relative_file_path);

    public int filterFileContent(BufferedInputStream bis, byte[] data, int bytes_to_read);
    }


    static public class NullZipFilter
    implements ZipFilter
    {
    public boolean shouldIncludeFile(String relative_file_path)
    {
        // All files are included
        return true;
    }


    public boolean shouldIncludeFileContent(String relative_file_path)
    {
        // Content for all files is included
        return true;
    }


    public int filterFileContent(BufferedInputStream bis, byte[] data, int bytes_to_read)
    {
        try {
        return bis.read(data, 0, bytes_to_read);
        }
        catch (Exception exception) {
        exception.printStackTrace();
        }

        return -1;
    }
    }
}