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

/**
 *############################################################################
 * 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.greenstone.gatherer.DebugStream;
import org.greenstone.gatherer.shell.GShell;
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());
        DebugStream.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 it's 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) {
        DebugStream.printStackTrace(exception);
    }
    }


    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) {
        DebugStream.printStackTrace(exception);
    }
    }


    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
        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)) {
            zos.putNextEntry(new ZipEntry(relative_file_path));

            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 = bis.read(data, 0, 1024)) > -1) {
                zos.write(data, 0, bytes_read);
            }
            bis.close();
            }
        }
        }
    }
    catch (Exception exception) {
        DebugStream.printStackTrace(exception);
    }
    }


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

    public boolean shouldIncludeFileContent(String relative_file_path);
    }


    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;
    }
    }


    // ----------------------------------------------------------------------------------------------------


    static private String unixStylePath(String path)
    {
    String unix_path = path.replace('\\','/');
    return unix_path;
    }


    /**
     * Method to handle zipping up of a file (not a directory).
     * Called by {@link zipup(String, String, String, GShell, String, String)} and {@link dirFunc(ZipOutputStream, String, int, GShell, boolean, String, String)}
     *
     * @param zos the zip output stream, as a <strong>ZipOutputStream</strong>
     * @param file_path the <strong>String</strong> containing the path to the file/directory tozip up
     * @param prefix_strip the <strong>int</strong> used to substring the file_path
     * @param source the <strong>GShell</strong> object that is calling this method, so that we can check to see if the process has been cancelled.
     *               This is null if GShell is not the calling object.
     * @param accept_expr a <strong>String</strong> containing a regular expression of files to include in the archive. All other files will be excluded.
     *                    There is a special case of ".*doc.xml", where the doc.xml files will be parsed to only include their metadata.
     * @param reject_expr a <strong>String</strong> containing a regular expression of files not to include in the archive.
     * @return boolean - true if the zip was created successfully(?).
     * @see dirFunc(ZipOutputStream, String, int, GShell, boolean, String, String) 
     * @see zipup(String, String, String, GShell, String, String)
     */
    static private boolean zipFunc(ZipOutputStream zos, String file_path, int prefix_strip, GShell source, boolean encountered_file, String accept_expr, String reject_expr) 
    {
    String new_file_path = file_path;

    if((reject_expr != "") && (file_path.matches(reject_expr))) {
        // matches reject expression
        //DebugStream.println("File \'" + file_path + "\' matches the reject expression \'" + reject_expr + "\'");
        return encountered_file;
    }

    if ((accept_expr != "") && (!file_path.matches(accept_expr))) {
        // does not match accept expression
        //DebugStream.println("File \'" + file_path + "\' doesn't match accept expression \'" + accept_expr + "\'");
        return encountered_file;
    }

    //Special case: we only want the metadata. Parse the xml files.
    if(accept_expr.compareTo(".*doc.xml") == 0) {
        DebugStream.println("Only want to get metadata");
        Document old_document = XMLTools.parseXMLFile(new File(file_path));
        NodeList content = old_document.getElementsByTagName("Content");

        try {
        for(int i=content.getLength()-1; i >= 0; i--) {
            //Remove all content - just leave the metadata.
            content.item(i).getParentNode().removeChild(content.item(i));
        }
        }
        catch (Exception ex) {
        ex.printStackTrace();
        }

        new_file_path = file_path.substring(0, file_path.lastIndexOf(File.separator) + 1) + "new.xml";
        //Is there any better way than writing out as a new file, then reading back in??
        XMLTools.writeXMLFile(new File(new_file_path), old_document);
    }

    // Using try is required because of file io.
    try {
        // Exit if pressed cancel.
        if (source != null && source.hasSignalledStop()) {
        return false;
        }

        // Create a Zip Entry and put it into the archive (no data yet).

        // Strip off col_dir prefix
        String zip_path = file_path.substring(prefix_strip);
        // Zip files use '/' for directory separator
        String unix_style_path = unixStylePath(zip_path);

        ZipEntry fileEntry = new ZipEntry(unix_style_path);
        zos.putNextEntry(fileEntry);

        // Create a file input stream and a buffered input stream.
        FileInputStream fis = new FileInputStream(new_file_path);
        BufferedInputStream bis = new BufferedInputStream(fis);
        
        // Create a byte array object named data and declare byte count variable.
        byte[] data = new byte[1024];
        int byteCount;
        // Create a loop that reads from the buffered input stream and writes
        // to the zip output stream until the bis has been entirely read.
        while ((byteCount = bis.read(data, 0, 1024)) > -1) {
        //Check for cancell
        if(source != null) {
            if(source.hasSignalledStop()) {
            break;
            }
        }
        zos.write(data, 0, byteCount);
        }
        encountered_file = true;
    } 
    catch (IOException e) {
        e.printStackTrace();
    }
    
    DebugStream.println("Zipping up: " + file_path);
    return encountered_file;
    }

    /**
     * Method to handle ziping up of a directory. This is called by {@link zipup(String, String, String, GShell, String, String)}
     *
     * @param zos the <strong>ZipOutputStream</strong> to output to.
     * @param dir_name the directory name to zip, as a <strong>String</strong>
     * @param prefix_strip the <strong>int</strong> used to substring the file_path
     * @param source the <strong>GShell</strong> object that is calling this method, so that we can check to see if the process has been cancelled.
     *               This is null if GShell is not the calling object.
     * @param encountered_file ??What's this??
     * @param accept_expr a <strong>String</strong> containing a regular expression of files to include in the archive. All other files will be excluded.
     * @param reject_expr a <strong>String</strong> containing a regular expression of files not to include in the archive.
     *
     * @see zipup(String, String, String, GShell, String, String)
     * @see zipFunc(ZipOutputStream, String, int, GShell, boolean, String, String) 
     */
    static private boolean dirFunc (ZipOutputStream zos, String dir_name, int prefix_strip, GShell source, boolean encountered_file, String accept_expr, String reject_expr) 
    {
    File dirObj = new File(dir_name);

    if (dirObj.exists() == true) {
        if (dirObj.isDirectory() == true) {
        // Create an array of File objects, one for each file or directory in dirObj.
        File [] fileList = dirObj.listFiles();
        
        // Loop through File array and display.
        for (int i = 0; i < fileList.length; i++) {
            if(source != null && source.hasSignalledStop()) { break; }
            File file = fileList[i];
            if (file.isDirectory()) {
            String dir_path = file.getPath();
            String zip_path = dir_path.substring(prefix_strip);
            // Zip files use '/' for directory separator
            String unix_style_path 
                = unixStylePath(zip_path+File.separator);
            ZipEntry dirEntry = new ZipEntry(unix_style_path);

            try {
                zos.putNextEntry(dirEntry);
            } 
            catch (IOException e) {
                e.printStackTrace();
            }

            encountered_file = dirFunc(zos, dir_path, prefix_strip, source, encountered_file, accept_expr, reject_expr);
            } else if (file.isFile()) {
            // Call the zipFunc function
            String file_path = fileList[i].getPath();
            encountered_file = zipFunc(zos,file_path,prefix_strip, source, encountered_file, accept_expr, reject_expr);
            }
        }
        } 
        else { 
        System.err.println (dir_name+" is not a directory."); 
        }
    } 
    else { 
        System.err.println ("Directory "+dir_name+" does not exist."); 
    }
    return encountered_file;
    }
    
    /**
     * Method to zip up a given file or directory associated with a particular collection.
     * This method mainly called from {@link GShell}, with a few exceptions. The zip files produced are used
     * to pass files (new files to add, metadata, etc) between the GLI applet and the Greenstone server.
     * The actual zipping of files and directories is handled by {@link zipFunc(ZipOutputStream, String, int, GShell, boolean, String, String) and
     * {@link dirFunc(ZipOutputStream, String, int, GShell, boolean, String, String)} respectfully.
     *
     * @param col_dir the path to the collect directory, as a <strong>String</strong>
     * @param col_name the collection name, as as <strong>String</strong>
     * @param dir_or_file the directory or file within the collection to zip up, as a <strong>String</strong>
     * @param source the <strong>GShell</strong> object that is calling this method, so that we can check to see if the process has been cancelled.
     *               This is null if GShell is not the calling object.
     * @param accept_expr a <strong>String</strong> containing a regular expression of files to include in the archive. All other files will be excluded.
     * @param reject_expr a <strong>String</strong> containing a regular expression of files not to include in the archive.
     *
     * @see zipFunc(ZipOutputStream, String, int, GShell, boolean, String, String) 
     * @see dirFunc(ZipOutputStream, String, int, GShell, boolean, String, String) 
     */
    static public boolean zipup(String col_dir, String col_name, String dir_or_file, GShell source, String accept_expr, String reject_expr)
    {
    if (!col_dir.endsWith(File.separator)) {
        col_dir += File.separator;
    }

    int prefix_strip = col_dir.length();
    boolean encountered_file = false;

    String zip_fname = col_dir + col_name + ".zip";
    String zip_dir_or_file = col_dir + col_name + File.separator + dir_or_file;
    File zip_dof = new File(zip_dir_or_file);

    try {
        FileOutputStream fos = new FileOutputStream(zip_fname);
        ZipOutputStream zos = new ZipOutputStream(fos);
        
        if (zip_dof.exists()) {
        if (zip_dof.isDirectory()) {
            String zip_dir = zip_dir_or_file;
            encountered_file = dirFunc(zos, zip_dir, prefix_strip, source, encountered_file, accept_expr, reject_expr);
        }
        else {
            String zip_full_file = zip_dir_or_file; 
            String zip_path = zip_full_file.substring(prefix_strip);

            for (int i=1; i<zip_path.length(); i++) {
            String ch = String.valueOf(zip_path.charAt(i));

            if (ch.equals(File.separator)) {
                String dir_path = zip_path.substring(0,i);
                // Zip files use '/' for directory separator
                String unix_style_path 
                = unixStylePath(dir_path+File.separator);
                ZipEntry dirEntry = new ZipEntry(unix_style_path);
                zos.putNextEntry(dirEntry);
            }
            }
            encountered_file = zipFunc(zos, zip_full_file, prefix_strip, source, encountered_file, accept_expr, reject_expr);
        }
        }
        else {
        System.err.println("Warning: " + zip_dir_or_file + " does not exist!");
        }
        
        // Close the file output streams for both the file and the zip.
        zos.flush();
        zos.close();
        fos.close();
    } 
    catch (IOException exception) {
        DebugStream.printStackTrace(exception);
        return false;
    }
    return encountered_file;
    } 


    /**
     * Method to unzip a zip file associated with a particular collection.
     * The location and name of the zip file should be derrived from the collection. Please see below for details.
     *
     * @param col_dir the path to the collection directory, as a <strong>String</strong>. This is where the zip file should be located.
     * @param col_name the name of the collection, as a <strong>String</strong>. This should be the name of the zip file (with a  .zip extension).
     */
    static public void unzip(String col_dir, String col_name)
    {
    if (!col_dir.endsWith(File.separator)) {
        col_dir += File.separator;
    }

    String zip_fname = col_dir + col_name + ".zip";
    // int zip_mode = ZipFile.OPEN_READ | ZipFile.OPEN_DELETE;
    int zip_mode = ZipFile.OPEN_READ; 

    try {
        File cfile = new File(zip_fname);
        ZipFile zipfile = new ZipFile(cfile, zip_mode);
        
        Enumeration e = zipfile.entries(); 
        while (e.hasMoreElements()) {
        ZipEntry zipentry = (ZipEntry) e.nextElement();
        String zentryname = col_dir + zipentry.getName();
        File zfile = new File(zentryname);
        DebugStream.println("    Unzipping: " + zentryname);

        if (zipentry.isDirectory()) {
            // Create named directory, if it doesn't already exist
            if (!zfile.exists() && !zfile.mkdirs()) {
            System.err.println("Error: unable to create directory " + zfile);
            }
        }
        else {
            // Write out file to disk

            //Make sure it's parent directory exists.
            File dir = new File(zfile.getParent());
            dir.mkdirs();

            // set up input stream
            InputStream zis = zipfile.getInputStream(zipentry); 
            BufferedInputStream bzis = new BufferedInputStream(zis); 
            DataInputStream dbzis = new DataInputStream(bzis);
            
            // set up output stream
            FileOutputStream fzos = new FileOutputStream(zentryname);
            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();
        }
        }

        zipfile.close();

        // delete zip file
        boolean file_deleted = cfile.delete();
        if (file_deleted) {
        System.err.println("Zip file " + cfile.toString() + " deleted");
        }
        else {
        System.err.println("Zip file " + cfile.toString() + " NOT deleted");
        }


    } 
    catch (ZipException error) {
        System.err.println("Error: Unable to open '"+zip_fname+"'");
        System.err.println("This maybe caused by the zip file being empty.");
        DebugStream.printStackTrace(error);
    }

    catch (Exception error) {
        error.printStackTrace();
    }
    }


    /** 
     * Method which unzips a given metadata resoure.
     * @param jar_zip_fname The name of the jar file as a <strong>String</strong>.
     * @param dst_dir The destination directory for unzipping, also as a <strong>String</strong>.
     * @see JarTools.extractFromJar(String, String, boolean)
     */
    static public void unzipFromJar(String jar_zip_fname, String dst_dir) {

    File file = null;
    if (!dst_dir.endsWith(File.separator)) {
        dst_dir += File.separator;
    }

    JarTools.extractFromJar(jar_zip_fname,dst_dir,true);

    String zip_ofname = dst_dir + jar_zip_fname;
    File zip_file = new File(zip_ofname);

    try {
        ZipFile zipfile = new ZipFile(zip_file);
        
        Enumeration e = zipfile.entries(); 
        while (e.hasMoreElements()) {
        ZipEntry zipentry = (ZipEntry) e.nextElement();
        String zentryname = dst_dir + zipentry.getName();
        DebugStream.println("    Unzipping: " + zentryname);

        if (zipentry.isDirectory()) {
            // Create named directory, if it doesn't already exist
            File zip_entry_file = new File(zentryname);
            if (!zip_entry_file.exists() && !zip_entry_file.mkdirs()) {
            System.err.println("Error: unable to create directory " + zip_entry_file);
            }
        }
        else {
            // Write out file to disk

            // set up input stream
            InputStream zis = zipfile.getInputStream(zipentry); 
            BufferedInputStream bzis = new BufferedInputStream(zis); 
            DataInputStream dbzis = new DataInputStream(bzis);
            
            // set up output stream
            FileOutputStream fzos = new FileOutputStream(zentryname);
            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();
            bfzos.close();
        }
        }
    } 
    catch (ZipException error) {
        System.err.println("Error: Unable to open '"+zip_file.getAbsolutePath()+"'");
        DebugStream.printStackTrace(error);
    }

    catch (Exception error) {
        error.printStackTrace();
    }
    }
}