adammurdoch 2002/10/23 03:58:52
Added: vfs/src/java/org/apache/commons/vfs/tasks
AbstractSyncTask.java CopyTask.java DeleteTask.java
MoveTask.java tasks.properties
Log:
Added initial (and very rough) move, copy, and delete tasks.
Revision Changes Path
1.1
jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/tasks/AbstractSyncTask.java
Index: AbstractSyncTask.java
===================================================================
/*
* Copyright (C) The Apache Software Foundation. All rights reserved.
*
* This software is published under the terms of the Apache Software License
* version 1.1, a copy of which has been included with this distribution in
* the LICENSE.txt file.
*/
package org.apache.commons.vfs.tasks;
import java.util.ArrayList;
import java.util.List;
import org.apache.commons.vfs.FileObject;
import org.apache.commons.vfs.FileSystemException;
import org.apache.commons.vfs.FileType;
import org.apache.commons.vfs.NameScope;
import org.apache.commons.vfs.Selectors;
import org.apache.commons.vfs.FileName;
import org.apache.commons.vfs.util.Messages;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;
/**
* An abstract file synchronization task. Scans a set of source files and
* folders, and a destination folder, and performs actions on missing and
* out-of-date files. Specifically, performs actions on the following:
* <ul>
* <li>Missing destination file.
* <li>Missing source file.
* <li>Out-of-date destination file.
* <li>Up-to-date destination file.
*
* @author <a href="mailto:adammurdoch@;apache.org">Adam Murdoch</a>
* @version $Revision: 1.1 $ $Date: 2002/10/23 10:58:52 $
*
* @todo Detect collisions when more than one source files map to the same dest file
* @todo Deal with case where dest file maps to a child of one of the source files
* @todo Scan destination directory
* @todo Use visitors
* @todo Check last modified time
* @todo Deal with case where dest file already exists and is incorrect type (not
file, not a folder)
* @todo Add default excludes
* @todo Allow selector, mapper, filters, etc to be specified.
*/
public abstract class AbstractSyncTask
extends VfsTask
{
private final ArrayList srcFiles = new ArrayList();
private String destFileUrl;
private String destDirUrl;
/**
* Sets the destination file.
*/
public void setDestFile( final String destFile )
{
this.destFileUrl = destFile;
}
/**
* Sets the destination directory.
*/
public void setDestDir( final String destDir )
{
this.destDirUrl = destDir;
}
/**
* Sets the source file
*/
public void setSrc( final String srcFile )
{
final SourceInfo src = new SourceInfo();
src.setFile( srcFile );
addConfiguredSrc( src );
}
/**
* Adds a nested <src> element.
*/
public void addConfiguredSrc( final SourceInfo srcInfo )
throws BuildException
{
if ( srcInfo.file == null )
{
final String message = Messages.getString(
"vfs.tasks/sync.no-source-file.error" );
throw new BuildException( message );
}
srcFiles.add( srcInfo );
}
/**
* Executes this task.
*/
public void execute() throws BuildException
{
// Validate
if ( destFileUrl == null && destDirUrl == null )
{
final String message =
Messages.getString( "vfs.tasks/sync.no-destination.error" );
throw new BuildException( message );
}
if ( destFileUrl != null && destDirUrl != null )
{
final String message =
Messages.getString( "vfs.tasks/sync.too-many-destinations.error" );
throw new BuildException( message );
}
if ( srcFiles.size() == 0 )
{
final String message = Messages.getString(
"vfs.tasks/sync.no-source-files.warn" );
log( message, Project.MSG_WARN );
return;
}
// Perform the sync
try
{
if ( destFileUrl != null )
{
handleSingleFile();
}
else
{
handleFiles();
}
}
catch ( final BuildException e )
{
throw e;
}
catch ( final Exception e )
{
throw new BuildException( e.getMessage(), e );
}
}
/**
* Copies the source files to the destination.
*/
private void handleFiles() throws Exception
{
// Locate the destination folder, and make sure it exists
final FileObject destFolder = resolveFile( destDirUrl );
destFolder.create( FileType.FOLDER );
// Locate the source files, and make sure they exist
final ArrayList srcs = new ArrayList();
for ( int i = 0; i < srcFiles.size(); i++ )
{
// Locate the source file, and make sure it exists
final SourceInfo src = (SourceInfo)srcFiles.get( i );
final FileObject srcFile = resolveFile( src.file );
if ( !srcFile.exists() )
{
final String message =
Messages.getString( "vfs.tasks/sync.src-file-no-exist.error",
srcFile );
throw new BuildException( message );
}
srcs.add( srcFile );
}
// Scan the destination files
// Scan the source files
for ( int i = 0; i < srcs.size(); i++ )
{
final FileObject rootFile = (FileObject)srcs.get( i );
final FileName rootName = rootFile.getName();
if ( rootFile.getType() == FileType.FILE )
{
// Build the destination file name
final FileObject destFile = destFolder.resolveFile(
rootName.getBaseName(), NameScope.DESCENDENT );
// Do the copy
handleFile( rootFile, destFile );
}
else
{
// Find matching files
final List files = rootFile.findFiles( Selectors.SELECT_FILES );
final int count = files.size();
for ( int j = 0; j < count; j++ )
{
final FileObject srcFile = (FileObject)files.get( j );
// Build the destination file name
final String relName =
rootName.getRelativeName( srcFile.getName() );
final FileObject destFile =
destFolder.resolveFile( relName, NameScope.DESCENDENT );
// Do the copy
handleFile( srcFile, destFile );
}
}
}
}
/**
* Copies a single file.
*/
private void handleSingleFile() throws Exception
{
// Make sure there is exactly one source file, and that it exists
// and is a file.
if ( srcFiles.size() > 1 )
{
final String message =
Messages.getString( "vfs.tasks/sync.too-many-source-files.error" );
throw new BuildException( message );
}
final SourceInfo src = (SourceInfo)srcFiles.get( 0 );
final FileObject srcFile = resolveFile( src.file );
if ( !srcFile.exists() || srcFile.getType() != FileType.FILE )
{
final String message =
Messages.getString( "vfs.tasks/sync.source-not-file.error", srcFile
);
throw new BuildException( message );
}
// Locate the destination file
final FileObject destFile = resolveFile( destFileUrl );
// Do the copy
handleFile( srcFile, destFile );
}
/**
* Handles a single source file.
* @param srcFile
* @param destFile
* @throws FileSystemException
*/
protected abstract void handleFile( final FileObject srcFile,
final FileObject destFile )
throws FileSystemException;
/**
* Information about a source file.
*/
public static class SourceInfo
{
private String file;
public void setFile( final String file )
{
this.file = file;
}
}
}
1.1
jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/tasks/CopyTask.java
Index: CopyTask.java
===================================================================
/*
* Copyright (C) The Apache Software Foundation. All rights reserved.
*
* This software is published under the terms of the Apache Software License
* version 1.1, a copy of which has been included with this distribution in
* the LICENSE.txt file.
*/
package org.apache.commons.vfs.tasks;
import org.apache.commons.vfs.FileObject;
import org.apache.commons.vfs.FileSystemException;
import org.apache.commons.vfs.Selectors;
/**
* An Ant task that copies files.
*
* @author <a href="mailto:adammurdoch@;apache.org">Adam Murdoch</a>
* @version $Revision: 1.1 $ $Date: 2002/10/23 10:58:52 $
*
* @todo Copy folders that do not contain files
*/
public class CopyTask
extends AbstractSyncTask
{
protected void handleFile( final FileObject srcFile,
final FileObject destFile )
throws FileSystemException
{
log( "Copying " + srcFile + " to " + destFile );
destFile.copyFrom( srcFile, Selectors.SELECT_SELF );
}
}
1.1
jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/tasks/DeleteTask.java
Index: DeleteTask.java
===================================================================
/*
* Copyright (C) The Apache Software Foundation. All rights reserved.
*
* This software is published under the terms of the Apache Software License
* version 1.1, a copy of which has been included with this distribution in
* the LICENSE.txt file.
*/
package org.apache.commons.vfs.tasks;
import org.apache.tools.ant.BuildException;
import org.apache.commons.vfs.util.Messages;
import org.apache.commons.vfs.FileObject;
import org.apache.commons.vfs.Selectors;
/**
* An Ant task that deletes matching files.
*
* @author <a href="mailto:adammurdoch@;apache.org">Adam Murdoch</a>
* @version $Revision: 1.1 $ $Date: 2002/10/23 10:58:52 $
*
* @todo Allow selector to be specified.
*/
public class DeleteTask
extends VfsTask
{
private String file;
/**
* Sets the file/folder to delete.
* @param file
*/
public void setFile( final String file )
{
this.file = file;
}
/**
* Executes this task.
*/
public void execute() throws BuildException
{
if ( file == null )
{
final String message = Messages.getString(
"vfs.tasks/delete.no-source-files.error" );
throw new BuildException( message );
}
try
{
final FileObject srcFile = resolveFile( file );
log( "Deleting " + srcFile );
//srcFile.delete( Selectors.SELECT_ALL );
}
catch ( final Exception e )
{
throw new BuildException( e );
}
}
}
1.1
jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/tasks/MoveTask.java
Index: MoveTask.java
===================================================================
/*
* Copyright (C) The Apache Software Foundation. All rights reserved.
*
* This software is published under the terms of the Apache Software License
* version 1.1, a copy of which has been included with this distribution in
* the LICENSE.txt file.
*/
package org.apache.commons.vfs.tasks;
import org.apache.commons.vfs.FileObject;
import org.apache.commons.vfs.FileSystemException;
import org.apache.commons.vfs.Selectors;
/**
* An Ant task that moves files.
*
* @author <a href="mailto:adammurdoch@;apache.org">Adam Murdoch</a>
* @version $Revision: 1.1 $ $Date: 2002/10/23 10:58:52 $
*
* @todo Delete matching folders
*/
public class MoveTask
extends CopyTask
{
/**
* Handles a single source file.
*/
protected void handleFile( final FileObject srcFile,
final FileObject destFile )
throws FileSystemException
{
super.handleFile( srcFile, destFile );
log( "Deleting " + srcFile );
srcFile.delete( Selectors.SELECT_SELF );
}
}
1.1
jakarta-commons-sandbox/vfs/src/java/org/apache/commons/vfs/tasks/tasks.properties
Index: tasks.properties
===================================================================
v-copy=org.apache.commons.vfs.tasks.CopyTask
v-move=org.apache.commons.vfs.tasks.MoveTask
v-delete=org.apache.commons.vfs.tasks.DeleteTask
v-show-file=org.apache.commons.vfs.tasks.ShowFileTask
--
To unsubscribe, e-mail: <mailto:commons-dev-unsubscribe@;jakarta.apache.org>
For additional commands, e-mail: <mailto:commons-dev-help@;jakarta.apache.org>
