package org.apache.maven.wagon.providers.ssh.jsch;
/*
* Copyright 2001-2006 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 com.jcraft.jsch.ChannelSftp;
import com.jcraft.jsch.JSchException;
import com.jcraft.jsch.SftpATTRS;
import com.jcraft.jsch.SftpException;
import org.apache.maven.wagon.PathUtils;
import org.apache.maven.wagon.ResourceDoesNotExistException;
import org.apache.maven.wagon.TransferFailedException;
import org.apache.maven.wagon.authorization.AuthorizationException;
import org.apache.maven.wagon.events.TransferEvent;
import org.apache.maven.wagon.repository.RepositoryPermissions;
import org.apache.maven.wagon.resource.Resource;
import java.io.File;
/**
* SFTP protocol wagon.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @version $Id: SftpWagon.java 477248 2006-11-20 16:42:51Z brett $
* @todo [BP] add compression flag
*/
public class SftpWagon
extends AbstractJschWagon
{
private static final String SFTP_CHANNEL = "sftp";
private static final int S_IFDIR = 0x4000;
private static final long MILLIS_PER_SEC = 1000L;
public void put( String basedir, Resource resource, File source )
throws TransferFailedException
{
String resourceName = resource.getName();
String dir = getResourceDirectory( resourceName );
String filename = getResourceFilename( resourceName );
ChannelSftp channel = null;
try
{
channel = (ChannelSftp) session.openChannel( SFTP_CHANNEL );
channel.connect();
RepositoryPermissions permissions = getRepository().getPermissions();
int directoryMode = getDirectoryMode( permissions );
mkdirs( channel, basedir, directoryMode );
channel.cd( basedir );
mkdirs( channel, resourceName, directoryMode );
firePutStarted( resource, source );
channel.put( source.getAbsolutePath(), filename );
postProcessListeners( resource, source, TransferEvent.REQUEST_PUT );
if ( permissions != null && permissions.getGroup() != null )
{
setGroup( channel, filename, permissions );
}
if ( permissions != null && permissions.getFileMode() != null )
{
setFileMode( channel, filename, permissions );
}
firePutCompleted( resource, source );
String[] dirs = PathUtils.dirnames( dir );
for ( int i = 0; i < dirs.length; i++ )
{
channel.cd( ".." );
}
}
catch ( SftpException e )
{
String msg = "Error occured while deploying '" + resourceName + "' " + "to remote repository: " +
getRepository().getUrl();
throw new TransferFailedException( msg, e );
}
catch ( JSchException e )
{
String msg = "Error occured while deploying '" + resourceName + "' " + "to remote repository: " +
getRepository().getUrl();
throw new TransferFailedException( msg, e );
}
finally
{
if ( channel != null )
{
channel.disconnect();
}
}
}
private void setGroup( ChannelSftp channel, String filename, RepositoryPermissions permissions )
throws SftpException
{
try
{
int group = Integer.valueOf( permissions.getGroup() ).intValue();
channel.chgrp( group, filename );
}
catch ( NumberFormatException e )
{
// TODO: warning level
fireTransferDebug( "Not setting group: must be a numerical GID for SFTP" );
}
}
private void setFileMode( ChannelSftp channel, String filename, RepositoryPermissions permissions )
throws SftpException
{
try
{
int mode = getOctalMode( permissions.getFileMode() );
channel.chmod( mode, filename );
}
catch ( NumberFormatException e )
{
// TODO: warning level
fireTransferDebug( "Not setting mode: must be a numerical mode for SFTP" );
}
}
private void mkdirs( ChannelSftp channel, String resourceName, int mode )
throws TransferFailedException, SftpException
{
String[] dirs = PathUtils.dirnames( resourceName );
for ( int i = 0; i < dirs.length; i++ )
{
mkdir( channel, dirs[i], mode );
channel.cd( dirs[i] );
}
}
private void mkdir( ChannelSftp channel, String dir, int mode )
throws TransferFailedException, SftpException
{
try
{
SftpATTRS attrs = channel.stat( dir );
if ( ( attrs.getPermissions() & S_IFDIR ) == 0 )
{
throw new TransferFailedException( "Remote path is not a directory:" + dir );
}
}
catch ( SftpException e )
{
// doesn't exist, make it and try again
channel.mkdir( dir );
if ( mode != -1 )
{
try
{
channel.chmod( mode, dir );
}
catch ( SftpException e1 )
{
// for some extrange reason we recive this exception,
// even when chmod success
}
}
}
}
public boolean getIfNewer( Resource resource, File destination, long timestamp )
throws ResourceDoesNotExistException, TransferFailedException
{
String filename = getResourceFilename( resource.getName() );
String dir = getResourceDirectory( resource.getName() );
// we already setuped the root directory. Ignore beginning /
if ( dir.length() > 0 && dir.charAt( 0 ) == PATH_SEPARATOR )
{
dir = dir.substring( 1 );
}
boolean bDownloaded = true;
try
{
ChannelSftp channel = (ChannelSftp) session.openChannel( SFTP_CHANNEL );
channel.connect();
SftpATTRS attrs = changeToRepositoryDirectory( channel, dir, filename );
if ( timestamp <= 0 || attrs.getMTime() * MILLIS_PER_SEC > timestamp )
{
fireGetStarted( resource, destination );
channel.get( filename, destination.getAbsolutePath() );
postProcessListeners( resource, destination, TransferEvent.REQUEST_GET );
fireGetCompleted( resource, destination );
String[] dirs = PathUtils.dirnames( dir );
for ( int i = 0; i < dirs.length; i++ )
{
channel.cd( ".." );
}
bDownloaded = true;
}
else
{
bDownloaded = false;
}
}
catch ( SftpException e )
{
handleGetException( resource, e, destination );
}
catch ( JSchException e )
{
handleGetException( resource, e, destination );
}
return bDownloaded;
}
private SftpATTRS changeToRepositoryDirectory( ChannelSftp channel, String dir, String filename )
throws ResourceDoesNotExistException, SftpException
{
// This must be called first to ensure that if the file doesn't exist it throws an exception
SftpATTRS attrs;
try
{
channel.cd( repository.getBasedir() );
if ( dir.length() > 0 )
{
channel.cd( dir );
}
attrs = channel.stat( filename );
}
catch ( SftpException e )
{
if ( e.toString().trim().endsWith( "No such file" ) )
{
throw new ResourceDoesNotExistException( e.toString(), e );
}
else
{
throw e;
}
}
return attrs;
}
public void put( File source, String destination )
throws TransferFailedException, ResourceDoesNotExistException, AuthorizationException
{
String basedir = getRepository().getBasedir();
Resource resource = getResource( destination );
firePutInitiated( resource, source );
put( basedir, resource, source );
}
public void get( String resourceName, File destination )
throws TransferFailedException, ResourceDoesNotExistException, AuthorizationException
{
getIfNewer( resourceName, destination, 0 );
}
public boolean getIfNewer( String resourceName, File destination, long timestamp )
throws TransferFailedException, ResourceDoesNotExistException, AuthorizationException
{
createParentDirectories( destination );
Resource resource = getResource( resourceName );
fireGetInitiated( resource, destination );
return getIfNewer( resource, destination, timestamp );
}
}