@@ -9,6 +9,7 @@ package org.apache.tools.ant.taskdefs.file;
import java.io.File; import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.util.ArrayList;
import java.util.Enumeration; import java.util.Enumeration;
import java.util.Hashtable; import java.util.Hashtable;
import java.util.Vector; import java.util.Vector;
@@ -42,35 +43,36 @@ import org.apache.tools.ant.util.SourceFileScanner;
* @author <A href="gholam@xtra.co.nz">Michael McCallum</A> * @author <A href="gholam@xtra.co.nz">Michael McCallum</A>
* @author <a href="mailto:umagesh@rediffmail.com">Magesh Umasankar</a> * @author <a href="mailto:umagesh@rediffmail.com">Magesh Umasankar</a>
*/ */
public class Copy extends Task
public class Copy
extends Task
{ {
protected File file = null ;// the source file
protected File destFile = null ;// the destination file
protected File destDir = null ;// the destination directory
protected Vector filesets = new Vector();
private File m_file ;// the source file
private File m_destFile ;// the destination file
private File m_destDir ;// the destination directory
private Vector m_ filesets = new Vector();
protected boolean filtering = false ;
protected boolean preserveLastModified = false ;
protected boolean forceOverwrite = fals e;
protected boolean flatten = false ;
protected int verbosity = Project.MSG_VERBOSE;
protected boolean includeEmpty = true;
private boolean m_filtering ;
private boolean m_preserveLastModified ;
private boolean m_forceOverwrit e;
private boolean m_flatten ;
private int m_ verbosity = Project.MSG_VERBOSE;
private boolean m_ includeEmpty = true;
protected Hashtable fileCopyMap = new Hashtable();
protected Hashtable dirCopyMap = new Hashtable();
protected Hashtable completeDirMap = new Hashtable();
private Hashtable m_ fileCopyMap = new Hashtable();
private Hashtable m_ dirCopyMap = new Hashtable();
private Hashtable m_ completeDirMap = new Hashtable();
protected Mapper mapperElement = null ;
private Vector filterSets = new Vector();
private Mapper m_mapperElement ;
private Vector m_ filterSets = new Vector();
/** /**
* Sets a single source file to copy. * Sets a single source file to copy.
* *
* @param file The new File value * @param file The new File value
*/ */
public void setFile( File file )
public void setFile( final File file )
{ {
this. file = file;
m_ file = file;
} }
/** /**
@@ -78,9 +80,9 @@ public class Copy extends Task
* *
* @param filtering The new Filtering value * @param filtering The new Filtering value
*/ */
public void setFiltering( boolean filtering )
public void setFiltering( final boolean filtering )
{ {
this. filtering = filtering;
m_ filtering = filtering;
} }
/** /**
@@ -91,9 +93,9 @@ public class Copy extends Task
* *
* @param flatten The new Flatten value * @param flatten The new Flatten value
*/ */
public void setFlatten( boolean flatten )
public void setFlatten( final boolean flatten )
{ {
this. flatten = flatten;
m_ flatten = flatten;
} }
/** /**
@@ -101,9 +103,9 @@ public class Copy extends Task
* *
* @param includeEmpty The new IncludeEmptyDirs value * @param includeEmpty The new IncludeEmptyDirs value
*/ */
public void setIncludeEmptyDirs( boolean includeEmpty )
public void setIncludeEmptyDirs( final boolean includeEmpty )
{ {
this. includeEmpty = includeEmpty;
m_ includeEmpty = includeEmpty;
} }
/** /**
@@ -111,9 +113,9 @@ public class Copy extends Task
* *
* @param overwrite The new Overwrite value * @param overwrite The new Overwrite value
*/ */
public void setOverwrite( boolean overwrite )
public void setOverwrite( final boolean overwrite )
{ {
this. forceOverwrite = overwrite;
m_ forceOverwrite = overwrite;
} }
/** /**
@@ -121,9 +123,9 @@ public class Copy extends Task
* *
* @param preserve The new PreserveLastModified value * @param preserve The new PreserveLastModified value
*/ */
public void setPreserveLastModified( boolean preserve )
public void setPreserveLastModified( final boolean preserve )
{ {
preserveLastModified = preserve;
m_ preserveLastModified = preserve;
} }
/** /**
@@ -131,9 +133,9 @@ public class Copy extends Task
* *
* @param destDir The new Todir value * @param destDir The new Todir value
*/ */
public void setTodir( File destDir )
public void setTodir( final File destDir )
{ {
this. destDir = destDir;
m_ destDir = destDir;
} }
/** /**
@@ -141,9 +143,9 @@ public class Copy extends Task
* *
* @param destFile The new Tofile value * @param destFile The new Tofile value
*/ */
public void setTofile( File destFile )
public void setTofile( final File destFile )
{ {
this. destFile = destFile;
m_ destFile = destFile;
} }
/** /**
@@ -151,15 +153,15 @@ public class Copy extends Task
* *
* @param verbose The new Verbose value * @param verbose The new Verbose value
*/ */
public void setVerbose( boolean verbose )
public void setVerbose( final boolean verbose )
{ {
if( verbose ) if( verbose )
{ {
this. verbosity = Project.MSG_INFO;
m_ verbosity = Project.MSG_INFO;
} }
else else
{ {
this. verbosity = Project.MSG_VERBOSE;
m_ verbosity = Project.MSG_VERBOSE;
} }
} }
@@ -168,9 +170,9 @@ public class Copy extends Task
* *
* @param set The feature to be added to the Fileset attribute * @param set The feature to be added to the Fileset attribute
*/ */
public void addFileset( FileSet set )
public void addFileset( final FileSet set )
{ {
filesets.addElement( set );
m_ filesets.addElement( set );
} }
/** /**
@@ -180,8 +182,8 @@ public class Copy extends Task
*/ */
public FilterSet createFilterSet() public FilterSet createFilterSet()
{ {
FilterSet filterSet = new FilterSet();
filterSets.addElement( filterSet );
final FilterSet filterSet = new FilterSet();
m_ filterSets.addElement( filterSet );
return filterSet; return filterSet;
} }
@@ -194,12 +196,12 @@ public class Copy extends Task
public Mapper createMapper() public Mapper createMapper()
throws TaskException throws TaskException
{ {
if( mapperElement != null )
if( m_m apperElement != null )
{ {
throw new TaskException( "Cannot define more than one mapper" ); throw new TaskException( "Cannot define more than one mapper" );
} }
mapperElement = new Mapper( project );
return mapperElement;
m_m apperElement = new Mapper( project );
return m_m apperElement;
} }
/** /**
@@ -214,51 +216,52 @@ public class Copy extends Task
validateAttributes(); validateAttributes();
// deal with the single file // deal with the single file
if( file != null )
if( m_ file != null )
{ {
if( file.exists() )
if( m_ file.exists() )
{ {
if( destFile == null )
if( m_ destFile == null )
{ {
destFile = new File( destDir, file.getName() );
m_ destFile = new File( m_ destDir, m_ file.getName() );
} }
if( forceOverwrite ||
( file.lastModified() > destFile.lastModified() ) )
if( m_ forceOverwrite ||
( m_ file.lastModified() > m_ destFile.lastModified() ) )
{ {
fileCopyMap.put( file.getAbsolutePath(), destFile.getAbsolutePath() );
m_ fileCopyMap.put( m_ file.getAbsolutePath(), m_ destFile.getAbsolutePath() );
} }
else else
{ {
log( file + " omitted as " + destFile + " is up to date.",
log( m_ file + " omitted as " + m_ destFile + " is up to date.",
Project.MSG_VERBOSE ); Project.MSG_VERBOSE );
} }
} }
else else
{ {
String message = "Could not find file " String message = "Could not find file "
+ file.getAbsolutePath() + " to copy.";
+ m_ file.getAbsolutePath() + " to copy.";
getLogger().info( message ); getLogger().info( message );
throw new TaskException( message ); throw new TaskException( message );
} }
} }
// deal with the filesets // deal with the filesets
for( int i = 0; i < filesets.size(); i++ )
for( int i = 0; i < m_ filesets.size(); i++ )
{ {
FileSet fs = (FileSet) filesets.elementAt( i );
DirectoryScanner ds = fs .getDirectoryScanner( project );
File fromDir = fs .getDir( project );
String[] srcFiles = d s.getIncludedFiles();
String[] srcDirs = d s.getIncludedDirectories();
boolean isEverythingIncluded = d s.isEverythingIncluded();
if( isEverythingIncluded
&& !flatten && mapperElement == null )
final FileSet fileSet = (FileSet)m_ filesets.elementAt( i );
final DirectoryScanner scanner = fileSet .getDirectoryScanner( project );
final File fromDir = fileSet .getDir( project );
final String[] srcFiles = scanner .getIncludedFiles();
final String[] srcDirs = scanner .getIncludedDirectories();
final boolean isEverythingIncluded = scanner .isEverythingIncluded();
if( isEverythingIncluded && !m_flatten && null == m_mapperElement )
{ {
completeDirMap.put( fromDir, destDir );
m_ completeDirMap.put( fromDir, m_ destDir );
} }
scan( fromDir, destDir, srcFiles, srcDirs );
scan( fromDir, m_destDir, srcFiles, srcDirs );
} }
// do all the copy operations now... // do all the copy operations now...
@@ -266,9 +269,9 @@ public class Copy extends Task
// clean up destDir again - so this instance can be used a second // clean up destDir again - so this instance can be used a second
// time without throwing an exception // time without throwing an exception
if( destFile != null )
if( null != m_ destFile )
{ {
destDir = null;
m_ destDir = null;
} }
} }
@@ -279,39 +282,51 @@ public class Copy extends Task
*/ */
protected Vector getFilterSets() protected Vector getFilterSets()
{ {
return filterSets;
return m_ filterSets;
} }
protected void buildMap( File fromDir, File toDir, String[] names,
FileNameMapper mapper, Hashtable map )
protected void buildMap( final File fromDir,
final File toDir,
final String[] names,
final FileNameMapper mapper,
final Hashtable map )
throws TaskException throws TaskException
{ {
final String[] toCopy = buildFilenameList( names, mapper, fromDir, toDir );
for( int i = 0; i < toCopy.length; i++ )
{
final String destFilename = mapper.mapFileName( toCopy[ i ] )[ 0 ];
final File src = new File( fromDir, toCopy[ i ] );
final File dest = new File( toDir, destFilename );
map.put( src.getAbsolutePath(), dest.getAbsolutePath() );
}
}
String[] toCopy = null;
if( forceOverwrite )
private String[] buildFilenameList( final String[] names,
final FileNameMapper mapper,
final File fromDir,
final File toDir )
throws TaskException
{
if( m_forceOverwrite )
{ {
Vector v = new Vector();
final ArrayList list = new ArrayList( names.length );
for( int i = 0; i < names.length; i++ ) for( int i = 0; i < names.length; i++ )
{ {
if( mapper.mapFileName( names[ i ] ) != null )
final String name = names[ i ];
if( null != mapper.mapFileName( name ) )
{ {
v.addElement( names[ i ] );
list.add( name );
} }
} }
toCopy = new String[ v.size() ];
v.copyInto( toCopy );
return (String[])list.toArray( new String[ list.size() ] );
} }
else else
{ {
SourceFileScanner ds = new SourceFileScanner( this );
toCopy = ds.restrict( names, fromDir, toDir, mapper );
}
for( int i = 0; i < toCopy.length; i++ )
{
File src = new File( fromDir, toCopy[ i ] );
File dest = new File( toDir, mapper.mapFileName( toCopy[ i ] )[ 0 ] );
map.put( src.getAbsolutePath(), dest.getAbsolutePath() );
final SourceFileScanner scanner = new SourceFileScanner( this );
return scanner.restrict( names, fromDir, toDir, mapper );
} }
} }
@@ -322,61 +337,56 @@ public class Copy extends Task
protected void doFileOperations() protected void doFileOperations()
throws TaskException throws TaskException
{ {
if( fileCopyMap.size() > 0 )
if( m_ fileCopyMap.size() > 0 )
{ {
getLogger().info( "Copying " + fileCopyMap.size() +
" file" + ( fileCopyMap.size() == 1 ? "" : "s" ) +
" to " + destDir.getAbsolutePath() );
getLogger().info( "Copying " + m_ fileCopyMap.size() +
" file" + ( m_ fileCopyMap.size() == 1 ? "" : "s" ) +
" to " + m_ destDir.getAbsolutePath() );
Enumeration e = fileCopyMap.keys();
Enumeration e = m_ fileCopyMap.keys();
while( e.hasMoreElements() ) while( e.hasMoreElements() )
{ {
String fromFile = (String)e.nextElement(); String fromFile = (String)e.nextElement();
String toFile = (String)fileCopyMap.get( fromFile );
String toFile = (String)m_ fileCopyMap.get( fromFile );
if( fromFile.equals( toFile ) ) if( fromFile.equals( toFile ) )
{ {
log( "Skipping self-copy of " + fromFile, verbosity );
getLogger().info( "Skipping self-copy of " + fromFile );
continue; continue;
} }
try try
{ {
log( "Copying " + fromFile + " to " + toFile, verbosity );
getLogger().info( "Copying " + fromFile + " to " + toFile );
FilterSetCollection executionFilters = new FilterSetCollection();
if( filtering )
{
executionFilters.addFilterSet( project.getGlobalFilterSet() );
}
for( Enumeration filterEnum = filterSets.elements(); filterEnum.hasMoreElements(); )
{
executionFilters.addFilterSet( (FilterSet)filterEnum.nextElement() );
}
final FilterSetCollection executionFilters = buildFilterSet();
final File src = new File( fromFile ); final File src = new File( fromFile );
final File dest = new File( toFile ); final File dest = new File( toFile );
if( forceOverwrite )
if( m_forceOverwrite )
{ {
FileUtil.forceDelete( dest ); FileUtil.forceDelete( dest );
} }
FileUtils.newFileUtils().copyFile( src, dest, executionFilters ); FileUtils.newFileUtils().copyFile( src, dest, executionFilters );
if( preserveLastModified )
if( m_preserveLastModified )
{ {
dest.setLastModified( src.lastModified() ); dest.setLastModified( src.lastModified() );
} }
} }
catch( IOException ioe )
catch( final IOException ioe )
{ {
String msg = "Failed to copy " + fromFile + " to " + toFile
+ " due to " + ioe.getMessage();
final String msg = "Failed to copy " + fromFile + " to " +
toFile + " due to " + ioe.getMessage();
throw new TaskException( msg, ioe ); throw new TaskException( msg, ioe );
} }
} }
} }
if( includeEmpty )
if( m_ includeEmpty )
{ {
Enumeration e = dirCopyMap.elements();
Enumeration e = m_ dirCopyMap.elements();
int count = 0; int count = 0;
while( e.hasMoreElements() ) while( e.hasMoreElements() )
{ {
@@ -399,11 +409,26 @@ public class Copy extends Task
getLogger().info( "Copied " + count + getLogger().info( "Copied " + count +
" empty director" + " empty director" +
( count == 1 ? "y" : "ies" ) + ( count == 1 ? "y" : "ies" ) +
" to " + destDir.getAbsolutePath() );
" to " + m_ destDir.getAbsolutePath() );
} }
} }
} }
private FilterSetCollection buildFilterSet()
{
final FilterSetCollection executionFilters = new FilterSetCollection();
if( m_filtering )
{
executionFilters.addFilterSet( project.getGlobalFilterSet() );
}
for( final Enumeration filterEnum = m_filterSets.elements(); filterEnum.hasMoreElements(); )
{
executionFilters.addFilterSet( (FilterSet)filterEnum.nextElement() );
}
return executionFilters;
}
/** /**
* Compares source files to destination files to see if they should be * Compares source files to destination files to see if they should be
* copied. * copied.
@@ -417,11 +442,11 @@ public class Copy extends Task
throws TaskException throws TaskException
{ {
FileNameMapper mapper = null; FileNameMapper mapper = null;
if( mapperElement != null )
if( m_m apperElement != null )
{ {
mapper = mapperElement.getImplementation();
mapper = m_m apperElement.getImplementation();
} }
else if( flatten )
else if( m_ flatten )
{ {
mapper = new FlatFileNameMapper(); mapper = new FlatFileNameMapper();
} }
@@ -430,11 +455,11 @@ public class Copy extends Task
mapper = new IdentityMapper(); mapper = new IdentityMapper();
} }
buildMap( fromDir, toDir, files, mapper, fileCopyMap );
buildMap( fromDir, toDir, files, mapper, m_ fileCopyMap );
if( includeEmpty )
if( m_ includeEmpty )
{ {
buildMap( fromDir, toDir, dirs, mapper, dirCopyMap );
buildMap( fromDir, toDir, dirs, mapper, m_ dirCopyMap );
} }
} }
@@ -451,45 +476,45 @@ public class Copy extends Task
protected void validateAttributes() protected void validateAttributes()
throws TaskException throws TaskException
{ {
if( file == null && filesets.size() == 0 )
if( m_ file == null && m_ filesets.size() == 0 )
{ {
throw new TaskException( "Specify at least one source - a file or a fileset." ); throw new TaskException( "Specify at least one source - a file or a fileset." );
} }
if( destFile != null && destDir != null )
if( m_ destFile != null && m_ destDir != null )
{ {
throw new TaskException( "Only one of tofile and todir may be set." ); throw new TaskException( "Only one of tofile and todir may be set." );
} }
if( destFile == null && destDir == null )
if( m_ destFile == null && m_ destDir == null )
{ {
throw new TaskException( "One of tofile or todir must be set." ); throw new TaskException( "One of tofile or todir must be set." );
} }
if( file != null && file.exists() && file.isDirectory() )
if( m_ file != null && m_ file.exists() && m_ file.isDirectory() )
{ {
throw new TaskException( "Use a fileset to copy directories." ); throw new TaskException( "Use a fileset to copy directories." );
} }
if( destFile != null && filesets.size() > 0 )
if( m_ destFile != null && m_ filesets.size() > 0 )
{ {
if( filesets.size() > 1 )
if( m_ filesets.size() > 1 )
{ {
throw new TaskException( throw new TaskException(
"Cannot concatenate multiple files into a single file." ); "Cannot concatenate multiple files into a single file." );
} }
else else
{ {
FileSet fs = (FileSet)filesets.elementAt( 0 );
FileSet fs = (FileSet)m_ filesets.elementAt( 0 );
DirectoryScanner ds = fs.getDirectoryScanner( project ); DirectoryScanner ds = fs.getDirectoryScanner( project );
String[] srcFiles = ds.getIncludedFiles(); String[] srcFiles = ds.getIncludedFiles();
if( srcFiles.length > 0 ) if( srcFiles.length > 0 )
{ {
if( file == null )
if( m_ file == null )
{ {
file = new File( srcFiles[ 0 ] );
filesets.removeElementAt( 0 );
m_ file = new File( srcFiles[ 0 ] );
m_ filesets.removeElementAt( 0 );
} }
else else
{ {
@@ -505,9 +530,59 @@ public class Copy extends Task
} }
} }
if( destFile != null )
if( m_ destFile != null )
{ {
destDir = new File( destFile.getParent() );// be 1.1 friendly
m_ destDir = new File( m_ destFile.getParent() );// be 1.1 friendly
} }
} }
protected Vector getFilesets()
{
return m_filesets;
}
protected boolean isFiltering()
{
return m_filtering;
}
protected boolean isForceOverwrite()
{
return m_forceOverwrite;
}
protected int getVerbosity()
{
return m_verbosity;
}
protected boolean isIncludeEmpty()
{
return m_includeEmpty;
}
protected Hashtable getFileCopyMap()
{
return m_fileCopyMap;
}
protected Hashtable getDirCopyMap()
{
return m_dirCopyMap;
}
protected Hashtable getCompleteDirMap()
{
return m_completeDirMap;
}
protected File getDestDir()
{
return m_destDir;
}
protected void setForceOverwrite( final boolean forceOverwrite )
{
m_forceOverwrite = forceOverwrite;
}
} }
Peter Donald