org.codehaus.plexus.archiver.zip.AbstractZipUnArchiver Maven / Gradle / Ivy
/**
*
* 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.
*/
package org.codehaus.plexus.archiver.zip;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.net.URL;
import java.util.Date;
import java.util.Enumeration;
import javax.annotation.Nonnull;
import org.apache.commons.compress.archivers.zip.UnicodePathExtraField;
import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
import org.apache.commons.compress.archivers.zip.ZipFile;
import org.apache.commons.compress.utils.IOUtils;
import org.codehaus.plexus.archiver.AbstractUnArchiver;
import org.codehaus.plexus.archiver.ArchiverException;
import org.codehaus.plexus.components.io.resources.PlexusIoResource;
/**
* @author Emmanuel Venisse
*/
public abstract class AbstractZipUnArchiver
extends AbstractUnArchiver
{
private static final String NATIVE_ENCODING = "native-encoding";
private String encoding = "UTF8";
public AbstractZipUnArchiver()
{
}
public AbstractZipUnArchiver( final File sourceFile )
{
super( sourceFile );
}
/**
* Sets the encoding to assume for file names and comments.
*
*
* Set to native-encoding if you want your platform's native encoding, defaults to UTF8.
*
*/
public void setEncoding( String encoding )
{
if ( NATIVE_ENCODING.equals( encoding ) )
{
encoding = null;
}
this.encoding = encoding;
}
private static class ZipEntryFileInfo
implements PlexusIoResource
{
private final org.apache.commons.compress.archivers.zip.ZipFile zipFile;
private final ZipArchiveEntry zipEntry;
ZipEntryFileInfo( final org.apache.commons.compress.archivers.zip.ZipFile zipFile,
final ZipArchiveEntry zipEntry )
{
this.zipFile = zipFile;
this.zipEntry = zipEntry;
}
public String getName()
{
try
{
final UnicodePathExtraField unicodePath =
(UnicodePathExtraField) zipEntry.getExtraField( UnicodePathExtraField.UPATH_ID );
return unicodePath != null
? new String( unicodePath.getUnicodeName(), "UTF-8" )
: zipEntry.getName();
}
catch ( final UnsupportedEncodingException e )
{
throw new AssertionError( e );
}
}
@Override
public boolean isDirectory()
{
return zipEntry.isDirectory();
}
@Override
public boolean isFile()
{
return !zipEntry.isDirectory() && !zipEntry.isUnixSymlink();
}
@Override
public boolean isSymbolicLink()
{
return zipEntry.isUnixSymlink();
}
@Nonnull
@Override
public InputStream getContents()
throws IOException
{
return zipFile.getInputStream( zipEntry );
}
@Override
public long getLastModified()
{
final long l = zipEntry.getTime();
return l == 0 ? PlexusIoResource.UNKNOWN_MODIFICATION_DATE : l;
}
@Override
public long getSize()
{
final long l = zipEntry.getSize();
return l == -1 ? PlexusIoResource.UNKNOWN_RESOURCE_SIZE : l;
}
@Override
public URL getURL()
throws IOException
{
return null;
}
@Override
public boolean isExisting()
{
return true;
}
}
@Override
protected void execute()
throws ArchiverException
{
getLogger().debug( "Expanding: " + getSourceFile() + " into " + getDestDirectory() );
org.apache.commons.compress.archivers.zip.ZipFile zf = null;
InputStream in = null;
try
{
zf = new org.apache.commons.compress.archivers.zip.ZipFile( getSourceFile(), encoding, true );
final Enumeration e = zf.getEntriesInPhysicalOrder();
while ( e.hasMoreElements() )
{
final ZipArchiveEntry ze = (ZipArchiveEntry) e.nextElement();
final ZipEntryFileInfo fileInfo = new ZipEntryFileInfo( zf, ze );
if ( isSelected( fileInfo.getName(), fileInfo ) )
{
in = zf.getInputStream( ze );
extractFileIfIncluded( getSourceFile(), getDestDirectory(), in, fileInfo.getName(),
new Date( ze.getTime() ), ze.isDirectory(),
ze.getUnixMode() != 0 ? ze.getUnixMode() : null,
resolveSymlink( zf, ze ) );
in.close();
in = null;
}
}
zf.close();
zf = null;
getLogger().debug( "expand complete" );
}
catch ( final IOException ioe )
{
throw new ArchiverException( "Error while expanding " + getSourceFile().getAbsolutePath(), ioe );
}
finally
{
IOUtils.closeQuietly( in );
IOUtils.closeQuietly( zf );
}
}
private String resolveSymlink( ZipFile zf, ZipArchiveEntry ze )
throws IOException
{
if ( ze.isUnixSymlink() )
{
return zf.getUnixSymlink( ze );
}
else
{
return null;
}
}
private void extractFileIfIncluded( final File sourceFile, final File destDirectory, final InputStream inputStream,
final String name, final Date time, final boolean isDirectory,
final Integer mode, String symlinkDestination )
throws IOException, ArchiverException
{
extractFile( sourceFile, destDirectory, inputStream, name, time, isDirectory, mode, symlinkDestination );
}
@Override
protected void execute( final String path, final File outputDirectory )
throws ArchiverException
{
org.apache.commons.compress.archivers.zip.ZipFile zipFile = null;
InputStream in = null;
try
{
zipFile = new org.apache.commons.compress.archivers.zip.ZipFile( getSourceFile(), encoding, true );
final Enumeration e = zipFile.getEntriesInPhysicalOrder();
while ( e.hasMoreElements() )
{
final ZipArchiveEntry ze = (ZipArchiveEntry) e.nextElement();
final ZipEntryFileInfo fileInfo = new ZipEntryFileInfo( zipFile, ze );
if ( !isSelected( ze.getName(), fileInfo ) )
{
continue;
}
if ( ze.getName().startsWith( path ) )
{
in = zipFile.getInputStream( ze );
extractFileIfIncluded( getSourceFile(), outputDirectory, in,
ze.getName(), new Date( ze.getTime() ), ze.isDirectory(),
ze.getUnixMode() != 0 ? ze.getUnixMode() : null,
resolveSymlink( zipFile, ze ) );
in.close();
in = null;
}
}
zipFile.close();
zipFile = null;
}
catch ( final IOException ioe )
{
throw new ArchiverException( "Error while expanding " + getSourceFile().getAbsolutePath(), ioe );
}
finally
{
IOUtils.closeQuietly( in );
IOUtils.closeQuietly( zipFile );
}
}
}