package org.codehaus.plexus.archiver.zip;
/**
*
* Copyright 2004 The Apache Software Foundation
*
* 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.
*/
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.Map;
import java.util.Stack;
import java.util.zip.CRC32;
import org.codehaus.plexus.archiver.AbstractArchiver;
import org.codehaus.plexus.archiver.ArchiveEntry;
import org.codehaus.plexus.archiver.Archiver;
import org.codehaus.plexus.archiver.ArchiverException;
import org.codehaus.plexus.archiver.ResourceIterator;
import org.codehaus.plexus.archiver.UnixStat;
import org.codehaus.plexus.archiver.util.ResourceUtils;
import org.codehaus.plexus.components.io.resources.PlexusIoFileResource;
import org.codehaus.plexus.components.io.resources.PlexusIoResource;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.IOUtil;
/**
* @version $Revision$ $Date$
*/
@SuppressWarnings({"NullableProblems", "UnusedDeclaration"})
public abstract class AbstractZipArchiver
extends AbstractArchiver
{
private String comment;
/**
* Encoding to use for filenames, defaults to the platform's
* default encoding.
*/
private String encoding;
private boolean doCompress = true;
private boolean recompressAddedZips = true;
private boolean doUpdate = false;
// shadow of the above if the value is altered in execute
private boolean savedDoUpdate = false;
protected String archiveType = "zip";
/*
* Whether the original compression of entries coming from a ZIP
* archive should be kept (for example when updating an archive).
*/
//not used: private boolean keepCompression = false;
private boolean doFilesonly = false;
protected Hashtable<String, String> entries = new Hashtable<String, String>();
protected Hashtable<String, String> addedDirs = new Hashtable<String, String>();
private static final long EMPTY_CRC = new CRC32().getValue();
protected boolean doubleFilePass = false;
protected boolean skipWriting = false;
/**
* @deprecated Use {@link Archiver#setDuplicateBehavior(String)} instead.
*/
protected String duplicate = Archiver.DUPLICATES_SKIP;
/**
* true when we are adding new files into the Zip file, as opposed
* to adding back the unchanged files
*/
protected boolean addingNewFiles = false;
/**
* Whether the file modification times will be rounded up to the
* next even number of seconds.
*/
private boolean roundUp = true;
// Renamed version of original file, if it exists
private File renamedFile = null;
private File zipFile;
private boolean success;
private ZipOutputStream zOut;
public String getComment()
{
return comment;
}
public void setComment( String comment )
{
this.comment = comment;
}
public String getEncoding()
{
return encoding;
}
public void setEncoding( String encoding )
{
this.encoding = encoding;
}
public void setCompress( boolean compress )
{
this.doCompress = compress;
}
public boolean isCompress()
{
return doCompress;
}
public boolean isRecompressAddedZips()
{
return recompressAddedZips;
}
public void setRecompressAddedZips( boolean recompressAddedZips )
{
this.recompressAddedZips = recompressAddedZips;
}
public void setUpdateMode( boolean update )
{
this.doUpdate = update;
savedDoUpdate = doUpdate;
}
public boolean isInUpdateMode()
{
return doUpdate;
}
/**
* If true, emulate Sun's jar utility by not adding parent directories;
* optional, defaults to false.
* @param f true to emilate sun jar utility
*/
public void setFilesonly( boolean f )
{
doFilesonly = f;
}
public boolean isFilesonly()
{
return doFilesonly;
}
/**
* Whether the file modification times will be rounded up to the
* next even number of seconds.
* <p/>
* <p>Zip archives store file modification times with a
* granularity of two seconds, so the times will either be rounded
* up or down. If you round down, the archive will always seem
* out-of-date when you rerun the task, so the default is to round
* up. Rounding up may lead to a different type of problems like
* JSPs inside a web archive that seem to be slightly more recent
* than precompiled pages, rendering precompilation useless.</p>
* @param r true to round
*/
public void setRoundUp( boolean r )
{
roundUp = r;
}
public boolean isRoundUp()
{
return roundUp;
}
protected void execute()
throws ArchiverException, IOException
{
if ( ! checkForced() )
{
return;
}
if ( doubleFilePass )
{
skipWriting = true;
createArchiveMain();
skipWriting = false;
createArchiveMain();
}
else
{
createArchiveMain();
}
finalizeZipOutputStream( zOut );
}
protected void finalizeZipOutputStream( ZipOutputStream zOut )
throws IOException, ArchiverException
{
}
private void createArchiveMain()
throws ArchiverException, IOException
{
//noinspection deprecation
if ( !Archiver.DUPLICATES_SKIP.equals( duplicate ) )
{
//noinspection deprecation
setDuplicateBehavior( duplicate );
}
ResourceIterator iter = getResources();
if ( !iter.hasNext() && !hasVirtualFiles() )
{
throw new ArchiverException( "You must set at least one file." );
}
zipFile = getDestFile();
if ( zipFile == null )
{
throw new ArchiverException( "You must set the destination " + archiveType + "file." );
}
if ( zipFile.exists() && !zipFile.isFile() )
{
throw new ArchiverException( zipFile + " isn't a file." );
}
if ( zipFile.exists() && !zipFile.canWrite() )
{
throw new ArchiverException( zipFile + " is read-only." );
}
// Whether or not an actual update is required -
// we don't need to update if the original file doesn't exist
addingNewFiles = true;
if ( doUpdate && !zipFile.exists() )
{
doUpdate = false;
getLogger().debug( "ignoring update attribute as " + archiveType + " doesn't exist." );
}
success = false;
if ( doUpdate )
{
renamedFile = FileUtils.createTempFile( "zip", ".tmp", zipFile.getParentFile() );
renamedFile.deleteOnExit();
try
{
FileUtils.rename( zipFile, renamedFile );
}
catch ( SecurityException e )
{
getLogger().debug( e.toString() );
throw new ArchiverException( "Not allowed to rename old file (" + zipFile.getAbsolutePath()
+ ") to temporary file", e );
}
catch ( IOException e )
{
getLogger().debug( e.toString() );
throw new ArchiverException( "Unable to rename old file (" + zipFile.getAbsolutePath()
+ ") to temporary file", e );
}
}
String action = doUpdate ? "Updating " : "Building ";
getLogger().info( action + archiveType + ": " + zipFile.getAbsolutePath() );
if ( !skipWriting )
{
zOut = new ZipOutputStream( zipFile );
zOut.setEncoding( encoding );
if ( doCompress )
{
zOut.setMethod( ZipOutputStream.DEFLATED );
}
else
{
zOut.setMethod( ZipOutputStream.STORED );
}
}
initZipOutputStream( zOut );
// Add the new files to the archive.
addResources( iter, zOut );
// If we've been successful on an update, delete the
// temporary file
if ( doUpdate )
{
if ( !renamedFile.delete() )
{
getLogger().warn( "Warning: unable to delete temporary file " + renamedFile.getName() );
}
}
success = true;
}
protected Map<String, Long> getZipEntryNames( File file )
throws IOException
{
if ( !file.exists() || !doUpdate )
{
//noinspection unchecked
return Collections.EMPTY_MAP;
}
final Map<String, Long> entries = new HashMap<String, Long>();
final ZipFile zipFile = new ZipFile( file );
for ( Enumeration en = zipFile.getEntries(); en.hasMoreElements(); )
{
ZipEntry ze = (ZipEntry) en.nextElement();
entries.put( ze.getName(), ze.getLastModificationTime());
}
return entries;
}
protected boolean isFileAdded( ArchiveEntry entry, Map entries )
{
return !entries.containsKey( entry.getName() );
}
protected boolean isFileUpdated( ArchiveEntry entry, Map entries )
{
Long l = (Long) entries.get( entry.getName() );
return l != null && (l == -1 || !ResourceUtils.isUptodate(entry.getResource(), l));
}
/**
* Add the given resources.
*
* @param resources the resources to add
* @param zOut the stream to write to
*/
@SuppressWarnings({"JavaDoc"})
protected final void addResources( ResourceIterator resources, ZipOutputStream zOut )
throws IOException, ArchiverException
{
File base = null;
while ( resources.hasNext() )
{
ArchiveEntry entry = resources.next();
String name = entry.getName();
name = name.replace( File.separatorChar, '/' );
if ( "".equals( name ) )
{
continue;
}
if ( entry.getResource().isDirectory() && !name.endsWith( "/" ) )
{
name = name + "/";
}
addParentDirs( base, name, zOut, "" );
if ( entry.getResource().isFile() )
{
zipFile( entry, zOut, name );
}
else
{
zipDir( entry.getResource(), zOut, name, entry.getMode() );
}
}
}
/**
* Ensure all parent dirs of a given entry have been added.
*/
@SuppressWarnings({"JavaDoc"})
protected final void addParentDirs( File baseDir, String entry, ZipOutputStream zOut, String prefix )
throws IOException
{
if ( !doFilesonly && getIncludeEmptyDirs() )
{
Stack<String> directories = new Stack<String>();
// Don't include the last entry itself if it's
// a dir; it will be added on its own.
int slashPos = entry.length() - ( entry.endsWith( "/" ) ? 1 : 0 );
while ( ( slashPos = entry.lastIndexOf( '/', slashPos - 1 ) ) != -1 )
{
String dir = entry.substring( 0, slashPos + 1 );
if ( addedDirs.contains( prefix + dir ) )
{
break;
}
directories.push( dir );
}
while ( !directories.isEmpty() )
{
String dir = directories.pop();
File f;
if ( baseDir != null )
{
f = new File( baseDir, dir );
}
else
{
f = new File( dir );
}
final PlexusIoFileResource res = new PlexusIoFileResource( f );
zipDir( res, zOut, prefix + dir, getRawDefaultDirectoryMode() );
}
}
}
private void readWithZipStats(InputStream in, byte[] header, ZipEntry ze, ByteArrayOutputStream bos) throws IOException {
byte[] buffer = new byte[8 * 1024];
CRC32 cal2 = new CRC32();
long size = 0;
for (byte aHeader : header) {
cal2.update(aHeader);
size++;
}
int count = 0;
do
{
size += count;
cal2.update( buffer, 0, count );
if (bos != null)
{
bos.write( buffer, 0, count );
}
count = in.read( buffer, 0, buffer.length );
}
while ( count != -1 );
ze.setSize(size);
ze.setCrc(cal2.getValue());
}
public static long copy( final InputStream input,
final OutputStream output,
final int bufferSize )
throws IOException
{
final byte[] buffer = new byte[bufferSize];
long size = 0;
int n;
while ( -1 != ( n = input.read( buffer ) ) )
{
size += n;
output.write( buffer, 0, n );
}
return size;
}
/**
* Adds a new entry to the archive, takes care of duplicates as well.
*
* @param in the stream to read data for the entry from.
* @param zOut the stream to write to.
* @param vPath the name this entry shall have in the archive.
* @param lastModified last modification time for the entry.
* @param fromArchive the original archive we are copying this
* entry from, will be null if we are not copying from an archive.
* @param mode the Unix permissions to set.
*/
@SuppressWarnings({"JavaDoc"})
protected void zipFile( InputStream in, ZipOutputStream zOut, String vPath, long lastModified, File fromArchive,
int mode )
throws IOException, ArchiverException
{
getLogger().debug( "adding entry " + vPath );
entries.put( vPath, vPath );
if ( !skipWriting )
{
ZipEntry ze = new ZipEntry( vPath );
ze.setTime( lastModified );
byte[] header = new byte[4];
int read = in.read(header);
boolean compressThis = doCompress;
if (!recompressAddedZips && isZipHeader(header)){
compressThis = false;
}
ze.setMethod( compressThis ? ZipEntry.DEFLATED : ZipEntry.STORED );
ze.setUnixMode( UnixStat.FILE_FLAG | mode );
/*
* ZipOutputStream.putNextEntry expects the ZipEntry to
* know its size and the CRC sum before you start writing
* the data when using STORED mode - unless it is seekable.
*
* This forces us to process the data twice.
*/
if (zOut.isSeekable() || compressThis) {
zOut.putNextEntry( ze );
if (read > 0) zOut.write(header, 0, read);
IOUtil.copy( in, zOut, 8 * 1024);
} else {
if (in.markSupported())
{
in.mark( Integer.MAX_VALUE );
readWithZipStats(in, header, ze, null);
in.reset();
zOut.putNextEntry(ze);
if (read > 0) zOut.write(header, 0, read);
IOUtil.copy(in, zOut, 8 * 1024);
}
else
{
// Store data into a byte[]
ByteArrayOutputStream bos = new ByteArrayOutputStream(128 * 1024);
readWithZipStats(in, header, ze, bos);
zOut.putNextEntry(ze);
if (read > 0) zOut.write(header, 0, read);
bos.writeTo( zOut);
}
}
}
}
private boolean isZipHeader(byte[] header) {
return header[0] == 0x50 && header[1] == 0x4b && header[2] == 03 && header[3] == 04;
}
/**
* Method that gets called when adding from java.io.File instances.
* <p/>
* <p>This implementation delegates to the six-arg version.</p>
*
* @param entry the file to add to the archive
* @param zOut the stream to write to
* @param vPath the name this entry shall have in the archive
*/
@SuppressWarnings({"JavaDoc"})
protected void zipFile( ArchiveEntry entry, ZipOutputStream zOut, String vPath )
throws IOException, ArchiverException
{
if ( ResourceUtils.isSame( entry.getResource(), getDestFile() ) )
{
throw new ArchiverException( "A zip file cannot include itself" );
}
InputStream in = entry.getInputStream();
try
{
// ZIPs store time with a granularity of 2 seconds, round up
final long lastModified = entry.getResource().getLastModified() + ( roundUp ? 1999 : 0 );
zipFile( in, zOut, vPath, lastModified, null, entry.getMode() );
}
catch ( IOException e )
{
throw new ArchiverException( "IOException when zipping " + entry.getName() + ": " + e.getMessage(), e );
}
finally
{
IOUtil.close( in );
}
}
/**
*
*/
protected void zipDir( PlexusIoResource dir, ZipOutputStream zOut, String vPath, int mode )
throws IOException
{
if ( addedDirs.get( vPath ) != null )
{
// don't add directories we've already added.
// no warning if we try, it is harmless in and of itself
return;
}
getLogger().debug( "adding directory " + vPath );
addedDirs.put( vPath, vPath );
if ( !skipWriting )
{
ZipEntry ze = new ZipEntry( vPath );
if ( dir != null && dir.isExisting() )
{
// ZIPs store time with a granularity of 2 seconds, round up
final long lastModified = dir.getLastModified() + ( roundUp ? 1999 : 0 );
ze.setTime( lastModified );
}
else
{
// ZIPs store time with a granularity of 2 seconds, round up
ze.setTime( System.currentTimeMillis() + ( roundUp ? 1999 : 0 ) );
}
ze.setSize( 0 );
ze.setMethod( ZipEntry.STORED );
// This is faintly ridiculous:
ze.setCrc( EMPTY_CRC );
ze.setUnixMode( mode );
zOut.putNextEntry( ze );
}
}
/**
* Create an empty zip file
*
* @param zipFile The file
* @return true for historic reasons
*/
@SuppressWarnings({"JavaDoc"})
protected boolean createEmptyZip( File zipFile )
throws ArchiverException
{
// In this case using java.util.zip will not work
// because it does not permit a zero-entry archive.
// Must create it manually.
getLogger().info( "Note: creating empty " + archiveType + " archive " + zipFile );
OutputStream os = null;
try
{
os = new FileOutputStream( zipFile );
// Cf. PKZIP specification.
byte[] empty = new byte[22];
empty[0] = 80; // P
empty[1] = 75; // K
empty[2] = 5;
empty[3] = 6;
// remainder zeros
os.write( empty );
}
catch ( IOException ioe )
{
throw new ArchiverException( "Could not create empty ZIP archive " + "(" + ioe.getMessage() + ")", ioe );
}
finally
{
IOUtil.close( os );
}
return true;
}
/**
* Do any clean up necessary to allow this instance to be used again.
* <p/>
* <p>When we get here, the Zip file has been closed and all we
* need to do is to reset some globals.</p>
* <p/>
* <p>This method will only reset globals that have been changed
* during execute(), it will not alter the attributes or nested
* child elements. If you want to reset the instance so that you
* can later zip a completely different set of files, you must use
* the reset method.</p>
*
* @see #reset
*/
protected void cleanUp()
{
super.cleanUp();
addedDirs.clear();
entries.clear();
addingNewFiles = false;
doUpdate = savedDoUpdate;
success = false;
zOut = null;
renamedFile = null;
zipFile = null;
}
/**
* Makes this instance reset all attributes to their default
* values and forget all children.
*
* @see #cleanUp
*/
public void reset()
{
setDestFile( null );
// duplicate = "add";
archiveType = "zip";
doCompress = true;
doUpdate = false;
doFilesonly = false;
encoding = null;
}
/**
* method for subclasses to override
*/
protected void initZipOutputStream( ZipOutputStream zOut )
throws IOException, ArchiverException
{
}
/**
* method for subclasses to override
*/
public boolean isSupportingForced()
{
return true;
}
protected boolean revert( StringBuffer messageBuffer )
{
int initLength = messageBuffer.length();
// delete a bogus ZIP file (but only if it's not the original one)
if ( ( !doUpdate || renamedFile != null ) && !zipFile.delete() )
{
messageBuffer.append( " (and the archive is probably corrupt but I could not delete it)" );
}
if ( doUpdate && renamedFile != null )
{
try
{
FileUtils.rename( renamedFile, zipFile );
}
catch ( IOException e )
{
messageBuffer.append( " (and I couldn't rename the temporary file " );
messageBuffer.append( renamedFile.getName() );
messageBuffer.append( " back)" );
}
}
return messageBuffer.length() == initLength;
}
protected void close()
throws IOException
{
// Close the output stream.
try
{
if ( zOut != null )
{
zOut.close();
}
}
catch ( IOException ex )
{
// If we're in this finally clause because of an
// exception, we don't really care if there's an
// exception when closing the stream. E.g. if it
// throws "ZIP file must have at least one entry",
// because an exception happened before we added
// any files, then we must swallow this
// exception. Otherwise, the error that's reported
// will be the close() error, which is not the
// real cause of the problem.
if ( success )
{
throw ex;
}
}
}
protected String getArchiveType()
{
return archiveType;
}
}