Coverage Report

Coverage Report - org.apache.maven.wagon.providers.ssh.jsch.SftpWagon

Classes in this File

Line Coverage

Branch Coverage

Complexity

SftpWagon

0 %

0/203

0 %

0/80

4,381

 package org.apache.maven.wagon.providers.ssh.jsch;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you 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.File;
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Vector;
 
 import org.apache.maven.wagon.InputData;
 import org.apache.maven.wagon.OutputData;
 import org.apache.maven.wagon.PathUtils;
 import org.apache.maven.wagon.ResourceDoesNotExistException;
 import org.apache.maven.wagon.TransferFailedException;
 import org.apache.maven.wagon.authentication.AuthenticationException;
 import org.apache.maven.wagon.authorization.AuthorizationException;
 import org.apache.maven.wagon.events.TransferEvent;
 import org.apache.maven.wagon.providers.ssh.ScpHelper;
 import org.apache.maven.wagon.repository.RepositoryPermissions;
 import org.apache.maven.wagon.resource.Resource;
 
 import com.jcraft.jsch.ChannelSftp;
 import com.jcraft.jsch.JSchException;
 import com.jcraft.jsch.SftpATTRS;
 import com.jcraft.jsch.SftpException;
 
 /**
  * SFTP protocol wagon.
  *
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
  * @version $Id: SftpWagon.java 1172843 2011-09-19 21:28:04Z hboutemy $
  * @todo [BP] add compression flag
  * @todo see if SftpProgressMonitor allows us to do streaming (without it, we can't do checksums as the input stream is lost)
  * 
  * @plexus.component role="org.apache.maven.wagon.Wagon" 
  *   role-hint="sftp"
  *   instantiation-strategy="per-lookup"
  */
 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;
 
     private ChannelSftp channel;
     
     public void closeConnection()
     {
         if ( channel != null )
         {
             channel.disconnect();
         }
         super.closeConnection();
     }
 
     public void openConnectionInternal()
         throws AuthenticationException
     {
         super.openConnectionInternal();
 
         try
         {
             channel = (ChannelSftp) session.openChannel( SFTP_CHANNEL );
 
             channel.connect();
         }
         catch ( JSchException e )
         {
             throw new AuthenticationException( "Error connecting to remote repository: " + getRepository().getUrl(),
                                                e );
         }
     }
 
     private void returnToParentDirectory( Resource resource )
     {
         try
         {
             String dir = ScpHelper.getResourceDirectory( resource.getName() );
             String[] dirs = PathUtils.dirnames( dir );
             for ( int i = 0; i < dirs.length; i++ )
             {
                 channel.cd( ".." );
             }
         }
         catch ( SftpException e )
         {
             fireTransferDebug( "Error returning to parent directory: " + e.getMessage() );
         }
     }
 
     private void putFile( File source, Resource resource, RepositoryPermissions permissions )
         throws SftpException, TransferFailedException
     {
         resource.setContentLength( source.length() );
         
         resource.setLastModified( source.lastModified() );
         
         String filename = ScpHelper.getResourceFilename( resource.getName() );
 
         firePutStarted( resource, source );
 
         channel.put( source.getAbsolutePath(), filename );
 
         postProcessListeners( resource, source, TransferEvent.REQUEST_PUT );
 
         if ( permissions != null && permissions.getGroup() != null )
         {
             setGroup( filename, permissions );
         }
 
         if ( permissions != null && permissions.getFileMode() != null )
         {
             setFileMode( filename, permissions );
         }
 
         firePutCompleted( resource, source );
     }
 
     private void setGroup( String filename, RepositoryPermissions permissions )
     {
         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" );
         }
         catch ( SftpException e )
         {
             fireTransferDebug( "Not setting group: " + e.getMessage() );            
         }
     }
 
     private void setFileMode( String filename, RepositoryPermissions permissions )
     {
         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" );
         }
         catch ( SftpException e )
         {
             fireTransferDebug( "Not setting mode: " + e.getMessage() );            
         }
     }
 
     private void mkdirs( String resourceName, int mode )
         throws SftpException, TransferFailedException
     {
         String[] dirs = PathUtils.dirnames( resourceName );
         for ( int i = 0; i < dirs.length; i++ )
         {
             mkdir( dirs[i], mode );
 
             channel.cd( dirs[i] );
         }
     }
 
     private void mkdir( 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
                 }
             }
         }
     }
 
     private SftpATTRS changeToRepositoryDirectory( 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 );
             }
 
             if ( filename.length() == 0 )
             {
                 filename = ".";
             }
             
             attrs = channel.stat( filename );
         }
         catch ( SftpException e )
         {
             if ( e.toString().trim().endsWith( "No such file" ) )
             {
                 throw new ResourceDoesNotExistException( e.toString(), e );
             }
             else if ( e.toString().trim().indexOf( "Can't change directory" ) != -1 )
             {
                 throw new ResourceDoesNotExistException( e.toString(), e );
             }   
             else
             {
                 throw e;
             }
         }
         return attrs;
     }
 
     public void putDirectory( File sourceDirectory, String destinationDirectory )
         throws TransferFailedException, ResourceDoesNotExistException, AuthorizationException
     {
         final RepositoryPermissions permissions = repository.getPermissions();
 
         try
         {
             channel.cd( "/" );
             
             String basedir = getRepository().getBasedir();
             int directoryMode = getDirectoryMode( permissions );
             
             mkdirs( basedir + "/", directoryMode );
             
             fireTransferDebug( "Recursively uploading directory " + sourceDirectory.getAbsolutePath() + " as "
                 + destinationDirectory );
             
             mkdirs( destinationDirectory, directoryMode );
             ftpRecursivePut( sourceDirectory, null, ScpHelper.getResourceFilename( destinationDirectory ),
                              directoryMode );
         }
         catch ( SftpException e )
         {
             String msg =
                 "Error occurred while deploying '" + sourceDirectory.getAbsolutePath() + "' " + "to remote repository: "
                     + getRepository().getUrl() + ": " + e.getMessage();
 
             throw new TransferFailedException( msg, e );
         }
     }
 
     private void ftpRecursivePut( File sourceFile, String prefix, String fileName, int directoryMode )
         throws TransferFailedException, SftpException
     {
         final RepositoryPermissions permissions = repository.getPermissions();
 
         if ( sourceFile.isDirectory() )
         {
             if ( !fileName.equals( "." ) )
             {
                 prefix = getFileName( prefix, fileName );
                 mkdir( fileName, directoryMode );
                 channel.cd( fileName );
             }
 
             File[] files = sourceFile.listFiles();
             if ( files != null && files.length > 0 )
             {
                 // Directories first, then files. Let's go deep early.
                 for ( int i = 0; i < files.length; i++ )
                 {
                     if ( files[i].isDirectory() )
                     {
                         ftpRecursivePut( files[i], prefix, files[i].getName(), directoryMode );
                     }
                 }
                 for ( int i = 0; i < files.length; i++ )
                 {
                     if ( !files[i].isDirectory() )
                     {
                         ftpRecursivePut( files[i], prefix, files[i].getName(), directoryMode );
                     }
                 }
             }
             
             channel.cd( ".." );
         }
         else
         {
             Resource resource = ScpHelper.getResource( getFileName( prefix, fileName ) );
 
             firePutInitiated( resource, sourceFile );
 
             putFile( sourceFile, resource, permissions );
         }
     }
 
     private String getFileName( String prefix, String fileName )
     {
         if ( prefix != null )
         {
             prefix = prefix + "/" + fileName;
         }
         else
         {
             prefix = fileName;
         }
         return prefix;
     }
     
     public List getFileList( String destinationDirectory )
         throws TransferFailedException, ResourceDoesNotExistException, AuthorizationException
     {
         if ( destinationDirectory.length() == 0 )
         {
             destinationDirectory = ".";
         }
         
         String filename = ScpHelper.getResourceFilename( destinationDirectory );
 
         String dir = ScpHelper.getResourceDirectory( destinationDirectory );
 
         // we already setuped the root directory. Ignore beginning /
         if ( dir.length() > 0 && dir.charAt( 0 ) == ScpHelper.PATH_SEPARATOR )
         {
             dir = dir.substring( 1 );
         }
 
         try
         {
             SftpATTRS attrs = changeToRepositoryDirectory( dir, filename );
             if ( ( attrs.getPermissions() & S_IFDIR ) == 0 )
             {
                 throw new TransferFailedException( "Remote path is not a directory:" + dir );
             }
 
             Vector fileList = channel.ls( filename );
             List files = new ArrayList( fileList.size() );
             for ( Iterator i = fileList.iterator(); i.hasNext(); )
             {
                 ChannelSftp.LsEntry entry = (ChannelSftp.LsEntry) i.next();
                 
                 String name = entry.getFilename();
                 if ( entry.getAttrs().isDir() )
                 {
                     if ( !name.equals( "." ) && !name.equals( ".." ) )
                     {
                         if ( !name.endsWith( "/" ) )
                         {
                             name += "/";
                         }
                         files.add( name );
                     }
                 }
                 else
                 {
                     files.add( name );
                 }
             }
             return files;
         }
         catch ( SftpException e )
         {
             String msg =
                 "Error occurred while listing '" + destinationDirectory + "' " + "on remote repository: "
                     + getRepository().getUrl() + ": " + e.getMessage();
 
             throw new TransferFailedException( msg, e );
         }
     }
     
     public boolean resourceExists( String resourceName )
         throws TransferFailedException, AuthorizationException
     {
         String filename = ScpHelper.getResourceFilename( resourceName );
 
         String dir = ScpHelper.getResourceDirectory( resourceName );
 
         // we already setuped the root directory. Ignore beginning /
         if ( dir.length() > 0 && dir.charAt( 0 ) == ScpHelper.PATH_SEPARATOR )
         {
             dir = dir.substring( 1 );
         }
 
         try
         {
             changeToRepositoryDirectory( dir, filename );
             
             return true;
         }
         catch ( ResourceDoesNotExistException e )
         {
             return false;
         }
         catch ( SftpException e )
         {
             String msg =
                 "Error occurred while looking for '" + resourceName + "' " + "on remote repository: "
                     + getRepository().getUrl() + ": " + e.getMessage();
 
             throw new TransferFailedException( msg, e );
         }
     }
 
     protected void cleanupGetTransfer( Resource resource )
     {
         returnToParentDirectory( resource );
     }
     
     protected void cleanupPutTransfer( Resource resource )
     {
         returnToParentDirectory( resource );
     }
 
     protected void finishPutTransfer( Resource resource, InputStream input, OutputStream output )
         throws TransferFailedException
     {
         RepositoryPermissions permissions = getRepository().getPermissions();
 
         String filename = ScpHelper.getResourceFilename( resource.getName() );
         if ( permissions != null && permissions.getGroup() != null )
         {
             setGroup( filename, permissions );
         }
         
         if ( permissions != null && permissions.getFileMode() != null )
         {
             setFileMode( filename, permissions );
         }
     }
 
     public void fillInputData( InputData inputData )
         throws TransferFailedException, ResourceDoesNotExistException
     {
         Resource resource = inputData.getResource();
         
         String filename = ScpHelper.getResourceFilename( resource.getName() );
 
         String dir = ScpHelper.getResourceDirectory( resource.getName() );
 
         // we already setuped the root directory. Ignore beginning /
         if ( dir.length() > 0 && dir.charAt( 0 ) == ScpHelper.PATH_SEPARATOR )
         {
             dir = dir.substring( 1 );
         }
 
         try
         {
             SftpATTRS attrs = changeToRepositoryDirectory( dir, filename );
 
             long lastModified = attrs.getMTime() * MILLIS_PER_SEC;
             resource.setContentLength( attrs.getSize() );
 
             resource.setLastModified( lastModified );
             
             inputData.setInputStream( channel.get( filename ) );
         }
         catch ( SftpException e )
         {
             handleGetException( resource, e );
         }
     }
 
     public void fillOutputData( OutputData outputData )
         throws TransferFailedException
     {
         int directoryMode = getDirectoryMode( getRepository().getPermissions() );
 
         Resource resource = outputData.getResource();
         
         try
         {
             channel.cd( "/" );
 
             String basedir = getRepository().getBasedir();
             mkdirs( basedir + "/", directoryMode );
 
             mkdirs( resource.getName(), directoryMode );
 
             String filename = ScpHelper.getResourceFilename( resource.getName() );
             outputData.setOutputStream( channel.put( filename ) );
         }
         catch ( TransferFailedException e )
         {
             fireTransferError( resource, e, TransferEvent.REQUEST_PUT );
 
             throw e;
         }
         catch ( SftpException e )
         {
             fireTransferError( resource, e, TransferEvent.REQUEST_PUT );
 
             String msg =
                 "Error occurred while deploying '" + resource.getName() + "' " + "to remote repository: "
                     + getRepository().getUrl() + ": " + e.getMessage();
 
             throw new TransferFailedException( msg, e );
         }
     }
     
     /**
      * @param permissions repository's permissions
      * @return the directory mode for the repository or <code>-1</code> if it
      *         wasn't set
      */
     public int getDirectoryMode( RepositoryPermissions permissions )
     {
         int ret = -1;
 
         if ( permissions != null )
         {
             ret = getOctalMode( permissions.getDirectoryMode() );
         }
 
         return ret;
     }
 
     public int getOctalMode( String mode )
     {
         int ret;
         try
         {
             ret = Integer.valueOf( mode, 8 ).intValue();
         }
         catch ( NumberFormatException e )
         {
             // TODO: warning level
             fireTransferDebug( "the file mode must be a numerical mode for SFTP" );
             ret = -1;
         }
         return ret;
     }
 }

1		package org.apache.maven.wagon.providers.ssh.jsch;
2
3		/*
4		* Licensed to the Apache Software Foundation (ASF) under one
5		* or more contributor license agreements. See the NOTICE file
6		* distributed with this work for additional information
7		* regarding copyright ownership. The ASF licenses this file
8		* to you under the Apache License, Version 2.0 (the
9		* "License"); you may not use this file except in compliance
10		* with the License. You may obtain a copy of the License at
11		*
12		* http://www.apache.org/licenses/LICENSE-2.0
13		*
14		* Unless required by applicable law or agreed to in writing,
15		* software distributed under the License is distributed on an
16		* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17		* KIND, either express or implied. See the License for the
18		* specific language governing permissions and limitations
19		* under the License.
20		*/
21
22		import java.io.File;
23		import java.io.InputStream;
24		import java.io.OutputStream;
25		import java.util.ArrayList;
26		import java.util.Iterator;
27		import java.util.List;
28		import java.util.Vector;
29
30		import org.apache.maven.wagon.InputData;
31		import org.apache.maven.wagon.OutputData;
32		import org.apache.maven.wagon.PathUtils;
33		import org.apache.maven.wagon.ResourceDoesNotExistException;
34		import org.apache.maven.wagon.TransferFailedException;
35		import org.apache.maven.wagon.authentication.AuthenticationException;
36		import org.apache.maven.wagon.authorization.AuthorizationException;
37		import org.apache.maven.wagon.events.TransferEvent;
38		import org.apache.maven.wagon.providers.ssh.ScpHelper;
39		import org.apache.maven.wagon.repository.RepositoryPermissions;
40		import org.apache.maven.wagon.resource.Resource;
41
42		import com.jcraft.jsch.ChannelSftp;
43		import com.jcraft.jsch.JSchException;
44		import com.jcraft.jsch.SftpATTRS;
45		import com.jcraft.jsch.SftpException;
46
47		/**
48		* SFTP protocol wagon.
49		*
50		* @author <a href="mailto:brett@apache.org">Brett Porter</a>
51		* @version $Id: SftpWagon.java 1172843 2011-09-19 21:28:04Z hboutemy $
52		* @todo [BP] add compression flag
53		* @todo see if SftpProgressMonitor allows us to do streaming (without it, we can't do checksums as the input stream is lost)
54		*
55		* @plexus.component role="org.apache.maven.wagon.Wagon"
56		* role-hint="sftp"
57		* instantiation-strategy="per-lookup"
58		*/
59	0	public class SftpWagon
60		extends AbstractJschWagon
61		{
62		private static final String SFTP_CHANNEL = "sftp";
63
64		private static final int S_IFDIR = 0x4000;
65
66		private static final long MILLIS_PER_SEC = 1000L;
67
68		private ChannelSftp channel;
69
70		public void closeConnection()
71		{
72	0	if ( channel != null )
73		{
74	0	channel.disconnect();
75		}
76	0	super.closeConnection();
77	0	}
78
79		public void openConnectionInternal()
80		throws AuthenticationException
81		{
82	0	super.openConnectionInternal();
83
84		try
85		{
86	0	channel = (ChannelSftp) session.openChannel( SFTP_CHANNEL );
87
88	0	channel.connect();
89		}
90	0	catch ( JSchException e )
91		{
92	0	throw new AuthenticationException( "Error connecting to remote repository: " + getRepository().getUrl(),
93		e );
94	0	}
95	0	}
96
97		private void returnToParentDirectory( Resource resource )
98		{
99		try
100		{
101	0	String dir = ScpHelper.getResourceDirectory( resource.getName() );
102	0	String[] dirs = PathUtils.dirnames( dir );
103	0	for ( int i = 0; i < dirs.length; i++ )
104		{
105	0	channel.cd( ".." );
106		}
107		}
108	0	catch ( SftpException e )
109		{
110	0	fireTransferDebug( "Error returning to parent directory: " + e.getMessage() );
111	0	}
112	0	}
113
114		private void putFile( File source, Resource resource, RepositoryPermissions permissions )
115		throws SftpException, TransferFailedException
116		{
117	0	resource.setContentLength( source.length() );
118
119	0	resource.setLastModified( source.lastModified() );
120
121	0	String filename = ScpHelper.getResourceFilename( resource.getName() );
122
123	0	firePutStarted( resource, source );
124
125	0	channel.put( source.getAbsolutePath(), filename );
126
127	0	postProcessListeners( resource, source, TransferEvent.REQUEST_PUT );
128
129	0	if ( permissions != null && permissions.getGroup() != null )
130		{
131	0	setGroup( filename, permissions );
132		}
133
134	0	if ( permissions != null && permissions.getFileMode() != null )
135		{
136	0	setFileMode( filename, permissions );
137		}
138
139	0	firePutCompleted( resource, source );
140	0	}
141
142		private void setGroup( String filename, RepositoryPermissions permissions )
143		{
144		try
145		{
146	0	int group = Integer.valueOf( permissions.getGroup() ).intValue();
147	0	channel.chgrp( group, filename );
148		}
149	0	catch ( NumberFormatException e )
150		{
151		// TODO: warning level
152	0	fireTransferDebug( "Not setting group: must be a numerical GID for SFTP" );
153		}
154	0	catch ( SftpException e )
155		{
156	0	fireTransferDebug( "Not setting group: " + e.getMessage() );
157	0	}
158	0	}
159
160		private void setFileMode( String filename, RepositoryPermissions permissions )
161		{
162		try
163		{
164	0	int mode = getOctalMode( permissions.getFileMode() );
165	0	channel.chmod( mode, filename );
166		}
167	0	catch ( NumberFormatException e )
168		{
169		// TODO: warning level
170	0	fireTransferDebug( "Not setting mode: must be a numerical mode for SFTP" );
171		}
172	0	catch ( SftpException e )
173		{
174	0	fireTransferDebug( "Not setting mode: " + e.getMessage() );
175	0	}
176	0	}
177
178		private void mkdirs( String resourceName, int mode )
179		throws SftpException, TransferFailedException
180		{
181	0	String[] dirs = PathUtils.dirnames( resourceName );
182	0	for ( int i = 0; i < dirs.length; i++ )
183		{
184	0	mkdir( dirs[i], mode );
185
186	0	channel.cd( dirs[i] );
187		}
188	0	}
189
190		private void mkdir( String dir, int mode )
191		throws TransferFailedException, SftpException
192		{
193		try
194		{
195	0	SftpATTRS attrs = channel.stat( dir );
196	0	if ( ( attrs.getPermissions() & S_IFDIR ) == 0 )
197		{
198	0	throw new TransferFailedException( "Remote path is not a directory:" + dir );
199		}
200		}
201	0	catch ( SftpException e )
202		{
203		// doesn't exist, make it and try again
204	0	channel.mkdir( dir );
205	0	if ( mode != -1 )
206		{
207		try
208		{
209	0	channel.chmod( mode, dir );
210		}
211	0	catch ( SftpException e1 )
212		{
213		// for some extrange reason we recive this exception,
214		// even when chmod success
215	0	}
216		}
217	0	}
218	0	}
219
220		private SftpATTRS changeToRepositoryDirectory( String dir, String filename )
221		throws ResourceDoesNotExistException, SftpException
222		{
223		// This must be called first to ensure that if the file doesn't exist it throws an exception
224		SftpATTRS attrs;
225		try
226		{
227	0	channel.cd( repository.getBasedir() );
228
229	0	if ( dir.length() > 0 )
230		{
231	0	channel.cd( dir );
232		}
233
234	0	if ( filename.length() == 0 )
235		{
236	0	filename = ".";
237		}
238
239	0	attrs = channel.stat( filename );
240		}
241	0	catch ( SftpException e )
242		{
243	0	if ( e.toString().trim().endsWith( "No such file" ) )
244		{
245	0	throw new ResourceDoesNotExistException( e.toString(), e );
246		}
247	0	else if ( e.toString().trim().indexOf( "Can't change directory" ) != -1 )
248		{
249	0	throw new ResourceDoesNotExistException( e.toString(), e );
250		}
251		else
252		{
253	0	throw e;
254		}
255	0	}
256	0	return attrs;
257		}
258
259		public void putDirectory( File sourceDirectory, String destinationDirectory )
260		throws TransferFailedException, ResourceDoesNotExistException, AuthorizationException
261		{
262	0	final RepositoryPermissions permissions = repository.getPermissions();
263
264		try
265		{
266	0	channel.cd( "/" );
267
268	0	String basedir = getRepository().getBasedir();
269	0	int directoryMode = getDirectoryMode( permissions );
270
271	0	mkdirs( basedir + "/", directoryMode );
272
273	0	fireTransferDebug( "Recursively uploading directory " + sourceDirectory.getAbsolutePath() + " as "
274		+ destinationDirectory );
275
276	0	mkdirs( destinationDirectory, directoryMode );
277	0	ftpRecursivePut( sourceDirectory, null, ScpHelper.getResourceFilename( destinationDirectory ),
278		directoryMode );
279		}
280	0	catch ( SftpException e )
281		{
282	0	String msg =
283		"Error occurred while deploying '" + sourceDirectory.getAbsolutePath() + "' " + "to remote repository: "
284		+ getRepository().getUrl() + ": " + e.getMessage();
285
286	0	throw new TransferFailedException( msg, e );
287	0	}
288	0	}
289
290		private void ftpRecursivePut( File sourceFile, String prefix, String fileName, int directoryMode )
291		throws TransferFailedException, SftpException
292		{
293	0	final RepositoryPermissions permissions = repository.getPermissions();
294
295	0	if ( sourceFile.isDirectory() )
296		{
297	0	if ( !fileName.equals( "." ) )
298		{
299	0	prefix = getFileName( prefix, fileName );
300	0	mkdir( fileName, directoryMode );
301	0	channel.cd( fileName );
302		}
303
304	0	File[] files = sourceFile.listFiles();
305	0	if ( files != null && files.length > 0 )
306		{
307		// Directories first, then files. Let's go deep early.
308	0	for ( int i = 0; i < files.length; i++ )
309		{
310	0	if ( files[i].isDirectory() )
311		{
312	0	ftpRecursivePut( files[i], prefix, files[i].getName(), directoryMode );
313		}
314		}
315	0	for ( int i = 0; i < files.length; i++ )
316		{
317	0	if ( !files[i].isDirectory() )
318		{
319	0	ftpRecursivePut( files[i], prefix, files[i].getName(), directoryMode );
320		}
321		}
322		}
323
324	0	channel.cd( ".." );
325	0	}
326		else
327		{
328	0	Resource resource = ScpHelper.getResource( getFileName( prefix, fileName ) );
329
330	0	firePutInitiated( resource, sourceFile );
331
332	0	putFile( sourceFile, resource, permissions );
333		}
334	0	}
335
336		private String getFileName( String prefix, String fileName )
337		{
338	0	if ( prefix != null )
339		{
340	0	prefix = prefix + "/" + fileName;
341		}
342		else
343		{
344	0	prefix = fileName;
345		}
346	0	return prefix;
347		}
348
349		public List getFileList( String destinationDirectory )
350		throws TransferFailedException, ResourceDoesNotExistException, AuthorizationException
351		{
352	0	if ( destinationDirectory.length() == 0 )
353		{
354	0	destinationDirectory = ".";
355		}
356
357	0	String filename = ScpHelper.getResourceFilename( destinationDirectory );
358
359	0	String dir = ScpHelper.getResourceDirectory( destinationDirectory );
360
361		// we already setuped the root directory. Ignore beginning /
362	0	if ( dir.length() > 0 && dir.charAt( 0 ) == ScpHelper.PATH_SEPARATOR )
363		{
364	0	dir = dir.substring( 1 );
365		}
366
367		try
368		{
369	0	SftpATTRS attrs = changeToRepositoryDirectory( dir, filename );
370	0	if ( ( attrs.getPermissions() & S_IFDIR ) == 0 )
371		{
372	0	throw new TransferFailedException( "Remote path is not a directory:" + dir );
373		}
374
375	0	Vector fileList = channel.ls( filename );
376	0	List files = new ArrayList( fileList.size() );
377	0	for ( Iterator i = fileList.iterator(); i.hasNext(); )
378		{
379	0	ChannelSftp.LsEntry entry = (ChannelSftp.LsEntry) i.next();
380
381	0	String name = entry.getFilename();
382	0	if ( entry.getAttrs().isDir() )
383		{
384	0	if ( !name.equals( "." ) && !name.equals( ".." ) )
385		{
386	0	if ( !name.endsWith( "/" ) )
387		{
388	0	name += "/";
389		}
390	0	files.add( name );
391		}
392		}
393		else
394		{
395	0	files.add( name );
396		}
397	0	}
398	0	return files;
399		}
400	0	catch ( SftpException e )
401		{
402	0	String msg =
403		"Error occurred while listing '" + destinationDirectory + "' " + "on remote repository: "
404		+ getRepository().getUrl() + ": " + e.getMessage();
405
406	0	throw new TransferFailedException( msg, e );
407		}
408		}
409
410		public boolean resourceExists( String resourceName )
411		throws TransferFailedException, AuthorizationException
412		{
413	0	String filename = ScpHelper.getResourceFilename( resourceName );
414
415	0	String dir = ScpHelper.getResourceDirectory( resourceName );
416
417		// we already setuped the root directory. Ignore beginning /
418	0	if ( dir.length() > 0 && dir.charAt( 0 ) == ScpHelper.PATH_SEPARATOR )
419		{
420	0	dir = dir.substring( 1 );
421		}
422
423		try
424		{
425	0	changeToRepositoryDirectory( dir, filename );
426
427	0	return true;
428		}
429	0	catch ( ResourceDoesNotExistException e )
430		{
431	0	return false;
432		}
433	0	catch ( SftpException e )
434		{
435	0	String msg =
436		"Error occurred while looking for '" + resourceName + "' " + "on remote repository: "
437		+ getRepository().getUrl() + ": " + e.getMessage();
438
439	0	throw new TransferFailedException( msg, e );
440		}
441		}
442
443		protected void cleanupGetTransfer( Resource resource )
444		{
445	0	returnToParentDirectory( resource );
446	0	}
447
448		protected void cleanupPutTransfer( Resource resource )
449		{
450	0	returnToParentDirectory( resource );
451	0	}
452
453		protected void finishPutTransfer( Resource resource, InputStream input, OutputStream output )
454		throws TransferFailedException
455		{
456	0	RepositoryPermissions permissions = getRepository().getPermissions();
457
458	0	String filename = ScpHelper.getResourceFilename( resource.getName() );
459	0	if ( permissions != null && permissions.getGroup() != null )
460		{
461	0	setGroup( filename, permissions );
462		}
463
464	0	if ( permissions != null && permissions.getFileMode() != null )
465		{
466	0	setFileMode( filename, permissions );
467		}
468	0	}
469
470		public void fillInputData( InputData inputData )
471		throws TransferFailedException, ResourceDoesNotExistException
472		{
473	0	Resource resource = inputData.getResource();
474
475	0	String filename = ScpHelper.getResourceFilename( resource.getName() );
476
477	0	String dir = ScpHelper.getResourceDirectory( resource.getName() );
478
479		// we already setuped the root directory. Ignore beginning /
480	0	if ( dir.length() > 0 && dir.charAt( 0 ) == ScpHelper.PATH_SEPARATOR )
481		{
482	0	dir = dir.substring( 1 );
483		}
484
485		try
486		{
487	0	SftpATTRS attrs = changeToRepositoryDirectory( dir, filename );
488
489	0	long lastModified = attrs.getMTime() * MILLIS_PER_SEC;
490	0	resource.setContentLength( attrs.getSize() );
491
492	0	resource.setLastModified( lastModified );
493
494	0	inputData.setInputStream( channel.get( filename ) );
495		}
496	0	catch ( SftpException e )
497		{
498	0	handleGetException( resource, e );
499	0	}
500	0	}
501
502		public void fillOutputData( OutputData outputData )
503		throws TransferFailedException
504		{
505	0	int directoryMode = getDirectoryMode( getRepository().getPermissions() );
506
507	0	Resource resource = outputData.getResource();
508
509		try
510		{
511	0	channel.cd( "/" );
512
513	0	String basedir = getRepository().getBasedir();
514	0	mkdirs( basedir + "/", directoryMode );
515
516	0	mkdirs( resource.getName(), directoryMode );
517
518	0	String filename = ScpHelper.getResourceFilename( resource.getName() );
519	0	outputData.setOutputStream( channel.put( filename ) );
520		}
521	0	catch ( TransferFailedException e )
522		{
523	0	fireTransferError( resource, e, TransferEvent.REQUEST_PUT );
524
525	0	throw e;
526		}
527	0	catch ( SftpException e )
528		{
529	0	fireTransferError( resource, e, TransferEvent.REQUEST_PUT );
530
531	0	String msg =
532		"Error occurred while deploying '" + resource.getName() + "' " + "to remote repository: "
533		+ getRepository().getUrl() + ": " + e.getMessage();
534
535	0	throw new TransferFailedException( msg, e );
536	0	}
537	0	}
538
539		/**
540		* @param permissions repository's permissions
541		* @return the directory mode for the repository or <code>-1</code> if it
542		* wasn't set
543		*/
544		public int getDirectoryMode( RepositoryPermissions permissions )
545		{
546	0	int ret = -1;
547
548	0	if ( permissions != null )
549		{
550	0	ret = getOctalMode( permissions.getDirectoryMode() );
551		}
552
553	0	return ret;
554		}
555
556		public int getOctalMode( String mode )
557		{
558		int ret;
559		try
560		{
561	0	ret = Integer.valueOf( mode, 8 ).intValue();
562		}
563	0	catch ( NumberFormatException e )
564		{
565		// TODO: warning level
566	0	fireTransferDebug( "the file mode must be a numerical mode for SFTP" );
567	0	ret = -1;
568	0	}
569	0	return ret;
570		}
571		}