/// <summary>
/// Transfer the specified directory from the source FTP Server onto the remote FTP Server asynchronously using the FXP protocol.
/// You will need to create a valid connection to your remote FTP Server before calling this method.
/// In Update mode, we will only transfer missing files and preserve any extra files on the remote FTP Server. This is useful when you want to simply transfer missing files from an FTP directory.
/// Currently Mirror mode is not implemented.
/// Only transfers the files and folders matching all the rules provided, if any.
/// All exceptions during transfer are caught, and the exception is stored in the related FtpResult object.
/// </summary>
/// <param name="sourceFolder">The full or relative path to the folder on the source FTP Server. If it does not exist, an empty result list is returned.</param>
/// <param name="remoteClient">Valid FTP connection to the destination FTP Server</param>
/// <param name="remoteFolder">The full or relative path to destination folder on the remote FTP Server</param>
/// <param name="mode">Only Update mode is currently implemented</param>
/// <param name="existsMode">If the file exists on disk, should we skip it, resume the download or restart the download?</param>
/// <param name="verifyOptions">Sets if checksum verification is required for a successful download and what to do if it fails verification (See Remarks)</param>
/// <param name="rules">Only files and folders that pass all these rules are downloaded, and the files that don't pass are skipped. In the Mirror mode, the files that fail the rules are also deleted from the local folder.</param>
/// <param name="progress">Provide a callback to track download progress.</param>
/// <param name="token">The token that can be used to cancel the entire process</param>
/// <remarks>
/// If verification is enabled (All options other than <see cref="FtpVerify.None"/>) the hash will be checked against the server. If the server does not support
/// any hash algorithm, then verification is ignored. If only <see cref="FtpVerify.OnlyChecksum"/> is set then the return of this method depends on both a successful
/// upload & verification. Additionally, if any verify option is set and a retry is attempted then overwrite will automatically switch to true for subsequent attempts.
/// If <see cref="FtpVerify.Throw"/> is set and <see cref="FtpError.Throw"/> is <i>not set</i>, then individual verification errors will not cause an exception
/// to propagate from this method.
/// </remarks>
/// <returns>
/// Returns a listing of all the remote files, indicating if they were downloaded, skipped or overwritten.
/// Returns a blank list if nothing was transfered. Never returns null.
/// </returns>
public async Task <List <FtpResult> > TransferDirectoryAsync(string sourceFolder, FtpClient remoteClient, string remoteFolder, FtpFolderSyncMode mode = FtpFolderSyncMode.Update,
FtpRemoteExists existsMode = FtpRemoteExists.Skip, FtpVerify verifyOptions = FtpVerify.None, List <FtpRule> rules = null, IProgress <FtpProgress> progress = null, CancellationToken token = default(CancellationToken))
{
if (sourceFolder.IsBlank())
{
throw new ArgumentException("Required parameter is null or blank.", "sourceFolder");
}
if (remoteFolder.IsBlank())
{
throw new ArgumentException("Required parameter is null or blank.", "remoteFolder");
}
LogFunc(nameof(TransferDirectoryAsync), new object[] { sourceFolder, remoteClient, remoteFolder, mode, existsMode, verifyOptions, (rules.IsBlank() ? null : rules.Count + " rules") });
var results = new List <FtpResult>();
// cleanup the FTP paths
sourceFolder = sourceFolder.GetFtpPath().EnsurePostfix("/");
remoteFolder = remoteFolder.GetFtpPath().EnsurePostfix("/");
// if the source dir does not exist, fail fast
if (!await DirectoryExistsAsync(sourceFolder, token))
{
return(results);
}
// flag to determine if existence checks are required
var checkFileExistence = true;
// ensure the remote dir exists
if (!await remoteClient.DirectoryExistsAsync(remoteFolder, token))
{
await remoteClient.CreateDirectoryAsync(remoteFolder, token);
checkFileExistence = false;
}
// break if task is cancelled
token.ThrowIfCancellationRequested();
// collect paths of the files that should exist (lowercase for CI checks)
var shouldExist = new Dictionary <string, bool>();
// get all the folders in the local directory
var dirListing = (await GetListingAsync(sourceFolder, FtpListOption.Recursive, token)).Where(x => x.Type == FtpFileSystemObjectType.Directory).Select(x => x.FullName).ToArray();
// break if task is cancelled
token.ThrowIfCancellationRequested();
// get all the already existing files
var remoteListing = checkFileExistence ? await remoteClient.GetListingAsync(remoteFolder, FtpListOption.Recursive, token) : null;
// break if task is cancelled
token.ThrowIfCancellationRequested();
// loop thru each folder and ensure it exists #1
var dirsToUpload = GetSubDirectoriesToTransfer(sourceFolder, remoteFolder, rules, results, dirListing);
// break if task is cancelled
token.ThrowIfCancellationRequested();
/*-------------------------------------------------------------------------------------/
* Cancelling after this point would leave the FTP server in an inconsistant state *
*-------------------------------------------------------------------------------------*/
// loop thru each folder and ensure it exists #2
await CreateSubDirectoriesAsync(remoteClient, dirsToUpload, token);
// get all the files in the local directory
var fileListing = (await GetListingAsync(sourceFolder, FtpListOption.Recursive, token)).Where(x => x.Type == FtpFileSystemObjectType.File).Select(x => x.FullName).ToArray();
// loop thru each file and transfer it
var filesToUpload = GetFilesToTransfer(sourceFolder, remoteFolder, rules, results, shouldExist, fileListing);
await TransferServerFilesAsync(filesToUpload, remoteClient, existsMode, verifyOptions, progress, remoteListing, token);
// delete the extra remote files if in mirror mode and the directory was pre-existing
// DeleteExtraServerFiles(mode, shouldExist, remoteListing);
return(results);
}
/// <summary>
/// Transfers a file from the source FTP Server to the destination FTP Server via the FXP protocol asynchronously.
/// </summary>
private async Task <bool> TransferFileFXPInternalAsync(string sourcePath, FtpClient remoteClient, string remotePath, bool createRemoteDir, FtpRemoteExists existsMode,
IProgress <FtpProgress> progress, CancellationToken token, FtpProgress metaProgress)
{
FtpReply reply;
long offset = 0;
bool fileExists = false;
long fileSize = 0;
var ftpFxpSession = await OpenPassiveFXPConnectionAsync(remoteClient, token);
if (ftpFxpSession != null)
{
try {
ftpFxpSession.SourceServer.ReadTimeout = (int)TimeSpan.FromMinutes(30.0).TotalMilliseconds;
ftpFxpSession.TargetServer.ReadTimeout = (int)TimeSpan.FromMinutes(30.0).TotalMilliseconds;
// check if the file exists, and skip, overwrite or append
if (existsMode == FtpRemoteExists.AppendNoCheck)
{
offset = await remoteClient.GetFileSizeAsync(remotePath, token);
if (offset == -1)
{
offset = 0; // start from the beginning
}
}
else
{
fileExists = await remoteClient.FileExistsAsync(remotePath, token);
switch (existsMode)
{
case FtpRemoteExists.Skip:
if (fileExists)
{
LogStatus(FtpTraceLevel.Info, "Skip is selected => Destination file exists => skipping");
//Fix #413 - progress callback isn't called if the file has already been uploaded to the server
//send progress reports
if (progress != null)
{
progress.Report(new FtpProgress(100.0, 0, TimeSpan.FromSeconds(0), sourcePath, remotePath, metaProgress));
}
return(true);
}
break;
case FtpRemoteExists.Overwrite:
if (fileExists)
{
await remoteClient.DeleteFileAsync(remotePath, token);
}
break;
case FtpRemoteExists.Append:
if (fileExists)
{
offset = await remoteClient.GetFileSizeAsync(remotePath, token);
if (offset == -1)
{
offset = 0; // start from the beginning
}
}
break;
}
}
fileSize = await GetFileSizeAsync(sourcePath, token);
// ensure the remote dir exists .. only if the file does not already exist!
if (createRemoteDir && !fileExists)
{
var dirname = remotePath.GetFtpDirectoryName();
if (!await remoteClient.DirectoryExistsAsync(dirname, token))
{
await remoteClient.CreateDirectoryAsync(dirname, token);
}
}
if (offset == 0 && existsMode != FtpRemoteExists.AppendNoCheck)
{
// send command to tell the source server to 'send' the file to the destination server
if (!(reply = await ftpFxpSession.SourceServer.ExecuteAsync($"RETR {sourcePath}", token)).Success)
{
throw new FtpCommandException(reply);
}
//Instruct destination server to store the file
if (!(reply = await ftpFxpSession.TargetServer.ExecuteAsync($"STOR {remotePath}", token)).Success)
{
throw new FtpCommandException(reply);
}
}
else
{
//tell source server to restart / resume
if (!(reply = await ftpFxpSession.SourceServer.ExecuteAsync($"REST {offset}", token)).Success)
{
throw new FtpCommandException(reply);
}
// send command to tell the source server to 'send' the file to the destination server
if (!(reply = await ftpFxpSession.SourceServer.ExecuteAsync($"RETR {sourcePath}", token)).Success)
{
throw new FtpCommandException(reply);
}
//Instruct destination server to append the file
if (!(reply = await ftpFxpSession.TargetServer.ExecuteAsync($"APPE {remotePath}", token)).Success)
{
throw new FtpCommandException(reply);
}
}
var transferStarted = DateTime.Now;
long lastSize = 0;
var sourceFXPTransferReply = ftpFxpSession.SourceServer.GetReplyAsync(token);
var destinationFXPTransferReply = ftpFxpSession.TargetServer.GetReplyAsync(token);
while (!sourceFXPTransferReply.IsCompleted || !destinationFXPTransferReply.IsCompleted)
{
if (remoteClient.EnableThreadSafeDataConnections)
{
// send progress reports
if (progress != null && fileSize != -1)
{
offset = await remoteClient.GetFileSizeAsync(remotePath, token);
if (offset != -1 && lastSize <= offset)
{
long bytesProcessed = offset - lastSize;
lastSize = offset;
ReportProgress(progress, fileSize, offset, bytesProcessed, DateTime.Now - transferStarted, sourcePath, remotePath, metaProgress);
}
}
}
await Task.Delay(1000);
}
FtpTrace.WriteLine(FtpTraceLevel.Info, $"FXP transfer of file {sourcePath} has completed");
await NoopAsync(token);
await remoteClient.NoopAsync(token);
ftpFxpSession.Dispose();
return(true);
}
// Fix: catch all exceptions and dispose off the FTP clients if one occurs
catch (Exception ex) {
ftpFxpSession.Dispose();
throw ex;
}
}
else
{
FtpTrace.WriteLine(FtpTraceLevel.Error, "Failed to open FXP passive Connection");
return(false);
}
}