de.alpharogroup.file.zip.Zipper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of file-worker Show documentation
Show all versions of file-worker Show documentation
Project that holds utility class for file operations.
/**
* The MIT License
*
* Copyright (C) 2007 Asterios Raptis
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package de.alpharogroup.file.zip;
import java.io.File;
import java.io.FileOutputStream;
import java.io.FilenameFilter;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import java.util.zip.ZipOutputStream;
import de.alpharogroup.file.exceptions.FileDoesNotExistException;
import de.alpharogroup.file.search.FileSearchExtensions;
import de.alpharogroup.io.StreamExtensions;
/**
* The class Zipper.
*
* @version 1.0
* @author Asterios Raptis
*/
public class Zipper implements ZipModel
{
/** The zos. */
private ZipOutputStream zos = null;
/** The file length. */
private long fileLength;
/** The file counter. */
private int fileCounter;
/** The zip level. */
private int zipLevel = -1;
/** The compression method. */
private int compressionMethod = -1;
/** The zip file comment. */
private String zipFileComment;
/** The zip file name. */
private String zipFileName;
/** The directory to zip. */
private File directoryToZip;
/** The file filter. */
private FilenameFilter fileFilter;
/** The zip file. */
private File zipFile;
/** The zip file obj. */
private ZipFile zipFileObj = null;
/** The dir to start. */
private String dirToStart;
/**
* Instantiates a new zipper.
*
* @param dirToZip
* the dir to zip
* @param zipFile
* the zip file
*/
public Zipper(final File dirToZip, final File zipFile)
{
this.initialize(dirToZip, zipFile, null);
}
/**
* Instantiates a new zipper.
*
* @param dirToZip
* the dir to zip
* @param zipFile
* the zip file
* @param filter
* the filter
*/
public Zipper(final File dirToZip, final File zipFile, final FilenameFilter filter)
{
this.initialize(dirToZip, zipFile, filter);
}
/**
* Adds the file.
*
* @param file
* the file
* @throws IOException
* Signals that an I/O exception has occurred.
*/
private void addFile(final File file) throws IOException
{
this.fileLength += file.length();
this.fileCounter++;
final String absolutePath = file.getAbsolutePath();
final int index = absolutePath.indexOf(this.dirToStart);
final String zipEntryName = absolutePath.substring(index, absolutePath.length());
final byte[] b = new byte[(int)file.length()];
final ZipEntry cpZipEntry = new ZipEntry(zipEntryName);
this.zos.putNextEntry(cpZipEntry);
this.zos.write(b, 0, (int)file.length());
this.zos.closeEntry();
}
/**
* Gets the compression method.
*
* @return the compression method {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#getCompressionMethod()
*/
@Override
public int getCompressionMethod()
{
return this.compressionMethod;
}
/**
* Gets the directory to zip.
*
* @return the directory to zip {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#getDirectoryToZip()
*/
@Override
public File getDirectoryToZip()
{
return this.directoryToZip;
}
/**
* Gets the dir to start.
*
* @return the dir to start {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#getDirToStart()
*/
@Override
public String getDirToStart()
{
return this.dirToStart;
}
/**
* Gets the file counter.
*
* @return the file counter {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#getFileCounter()
*/
@Override
public int getFileCounter()
{
return this.fileCounter;
}
/**
* Gets the file filter.
*
* @return the file filter {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#getFileFilter()
*/
@Override
public FilenameFilter getFileFilter()
{
return this.fileFilter;
}
/**
* Gets the file length.
*
* @return the file length {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#getFileLength()
*/
@Override
public long getFileLength()
{
return this.fileLength;
}
/**
* Gets the zip file.
*
* @return the zip file {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#getZipFile()
*/
@Override
public File getZipFile()
{
return this.zipFile;
}
/**
* Gets the zip file comment.
*
* @return the zip file comment {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#getZipFileComment()
*/
@Override
public String getZipFileComment()
{
return this.zipFileComment;
}
/**
* Gets the zip file name.
*
* @return the zip file name {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#getZipFileName()
*/
@Override
public String getZipFileName()
{
return this.zipFileName;
}
/**
* Returns the field zipFileObj.
*
* @return The field zipFileObj.
*/
@Override
public ZipFile getZipFileObj()
{
return this.zipFileObj;
}
/**
* Gets the zip level.
*
* @return the zip level {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#getZipLevel()
*/
@Override
public int getZipLevel()
{
return this.zipLevel;
}
/**
* Initialize.
*
* @param dirToZip
* the dir to zip.
* @param zipFile
* the zip file.
* @param filter
* the filter.
*/
private void initialize(final File dirToZip, final File zipFile, final FilenameFilter filter)
{
this.directoryToZip = dirToZip;
this.dirToStart = this.directoryToZip.getName();
this.zipFile = zipFile;
this.fileLength = 0;
this.fileCounter = 0;
this.setFileFilter(filter);
}
/**
* Sets the compression method.
*
* @param compressionMethod
* the new compression method {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#setCompressionMethod(int)
*/
@Override
public void setCompressionMethod(final int compressionMethod)
{
this.compressionMethod = compressionMethod;
}
/**
* Sets the directory to zip.
*
* @param directoryToZip
* the new directory to zip {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#setDirectoryToZip(java.io.File)
*/
@Override
public void setDirectoryToZip(final File directoryToZip)
{
this.directoryToZip = directoryToZip;
}
/**
* Sets the dir to start.
*
* @param dirToStart
* the new dir to start {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#setDirToStart(java.lang.String)
*/
@Override
public void setDirToStart(final String dirToStart)
{
this.dirToStart = dirToStart;
}
/**
* Sets the file counter.
*
* @param fileCounter
* the new file counter {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#setFileCounter(int)
*/
@Override
public void setFileCounter(final int fileCounter)
{
this.fileCounter = fileCounter;
}
/**
* Sets the file filter.
*
* @param fileFilter
* the new file filter {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#setFileFilter(java.io.FilenameFilter)
*/
@Override
public void setFileFilter(final FilenameFilter fileFilter)
{
this.fileFilter = fileFilter;
}
/**
* Sets the file length.
*
* @param fileLength
* the new file length {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#setFileLength(long)
*/
@Override
public void setFileLength(final long fileLength)
{
this.fileLength = fileLength;
}
/**
* Sets the zip file.
*
* @param zipFile
* the new zip file {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#setZipFile(java.io.File)
*/
@Override
public void setZipFile(final File zipFile)
{
this.zipFile = zipFile;
}
/**
* Sets the zip file comment.
*
* @param zipFileComment
* the new zip file comment {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#setZipFileComment(java.lang.String)
*/
@Override
public void setZipFileComment(final String zipFileComment)
{
this.zipFileComment = zipFileComment;
}
/**
* Sets the zip file name.
*
* @param zipFileName
* the new zip file name {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#setZipFileName(java.lang.String)
*/
@Override
public void setZipFileName(final String zipFileName)
{
this.zipFileName = zipFileName;
}
/**
* Sets the field zipFileObj.
*
* @param zipFileObj
* The zipFileObj to set
*/
@Override
public void setZipFileObj(final ZipFile zipFileObj)
{
this.zipFileObj = zipFileObj;
}
/**
* Sets the zip level.
*
* @param zipLevel
* the new zip level {@inheritDoc}
* @see de.alpharogroup.file.zip.ZipModel#setZipLevel(int)
*/
@Override
public void setZipLevel(final int zipLevel)
{
this.zipLevel = zipLevel;
}
/**
* Zip.
*/
public void zip()
{
FileOutputStream fos = null;
try
{
if (!this.directoryToZip.exists())
{
throw new IOException("Directory with the name " + this.directoryToZip.getName()
+ " does not exist.");
}
if (!this.zipFile.exists())
{
throw new FileDoesNotExistException(
"Zipfile with the name " + this.zipFile.getName() + " does not exist.");
}
fos = new FileOutputStream(this.zipFile);
this.zos = new ZipOutputStream(fos);
if (0 < this.zipLevel)
{
this.zos.setLevel(this.zipLevel);
}
else
{
this.zos.setLevel(9);
}
if (null != this.zipFileComment)
{
this.zos.setComment(this.zipFileComment);
}
if (0 < this.compressionMethod)
{
this.zos.setMethod(this.compressionMethod);
}
this.zipFiles(this.directoryToZip);
this.zos.flush();
this.zos.finish();
this.zos.close();
fos.flush();
fos.close();
fos = null;
this.zos = null;
}
catch (final Exception e)
{
e.printStackTrace();
}
finally
{
StreamExtensions.closeOutputStream(fos);
StreamExtensions.closeOutputStream(this.zos);
}
}
/**
* Zip files.
*
* @param file
* the file
* @throws IOException
* Signals that an I/O exception has occurred.
*/
private void zipFiles(final File file) throws IOException
{
if (file.isDirectory())
{
File[] fList;
List foundedFiles;
if (null != this.fileFilter)
{
final File[] tmpfList = file.listFiles(this.fileFilter);
final List foundedDirs = FileSearchExtensions.listDirs(file);
if (0 < foundedDirs.size())
{
final List tmp = Arrays.asList(tmpfList);
foundedDirs.addAll(tmp);
foundedFiles = foundedDirs;
}
else
{
final List tmp = Arrays.asList(tmpfList);
foundedFiles = tmp;
}
}
else
{
fList = file.listFiles();
final List tmp = Arrays.asList(fList);
foundedFiles = tmp;
}
for (final File foundedFile : foundedFiles)
{
this.zipFiles(foundedFile);
}
}
else
{
this.addFile(file);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy