Merge pull request #166 from FrendsPlatform/issue-165

SFTP.UploadFiles - Added new parameter AssumeFileExistence
FrendsPlatform · Oct 20, 2023 · 60db2e7 · 60db2e7
2 parents 4a45a17 + 7c2b268
commit 60db2e7
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 4 deletions.
diff --git a/Frends.SFTP.UploadFiles/CHANGELOG.md b/Frends.SFTP.UploadFiles/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## [2.8.0] - 2023-10-18
+### Added 
+- [Breaking] New feature: Added parameter AssumeFileExistence which will when enabled, skip checking if destination file esists and overwrites any existing files automatically.
+
 ## [2.7.2] - 2023-09-20
 ### Fixed
 - Fixed issue with empty destination directory by adding forward slash to the parameter if it's empty.

diff --git a/Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles/Definitions/FileTransporter.cs b/Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles/Definitions/FileTransporter.cs
@@ -562,7 +562,7 @@ private static string GetUserResultMessage(IList<SingleFileTransferResult> resul
             userResultMessage = MessageJoin(userResultMessage,
                 $"{errorMessages.Count} Errors: {string.Join(",\n", errorMessages)}.");
 
-        var transferredFiles = results.Where(x => x.Success).Select(x => x.TransferredFile).ToList();
+        var transferredFiles = results.Where(x => x.Success && !x.ActionSkipped).Select(x => x.TransferredFile).ToList();
         if (transferredFiles.Any())
             userResultMessage = MessageJoin(userResultMessage,
                 $"{transferredFiles.Count} files transferred: {string.Join(",\n", transferredFiles)}.");

diff --git a/Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles/Definitions/Options.cs b/Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles/Definitions/Options.cs
@@ -67,6 +67,15 @@ public class Options
     /// <example>true</example>
     [DefaultValue(true)]
     public bool OperationLog { get; set; }
+
+    /// <summary>
+    /// If enabled, the Task will assume that the destination file exists and skip the checking of the destination file.
+    /// This option will automatically overwrite existing destination file with the same name as the transferred one.
+    /// This can help transfers with server when user has limited permissions to the destination directory e.g. no permission to do lstat command.
+    /// </summary>
+    /// <example>false</example>
+    [DefaultValue(false)]
+    public bool AssumeFileExistence { get; set; }
 }
 
 
diff --git a/Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles/Definitions/SingleFileTransfer.cs b/Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles/Definitions/SingleFileTransfer.cs
@@ -58,7 +58,11 @@ internal SingleFileTransferResult TransferSingleFile()
 
             ExecuteSourceOperationMoveOrRename();
 
-            if (DestinationFileExists(DestinationFileWithMacrosExpanded))
+            if (BatchContext.Options.AssumeFileExistence)
+            {
+                PutDestinationFile(removeExisting: true);
+            }
+            else if (DestinationFileExists(DestinationFileWithMacrosExpanded))
             {
                 DestinationFile = new FileItem(Client.Get(DestinationFileWithMacrosExpanded));
                 switch (BatchContext.Destination.Action)
@@ -73,7 +77,10 @@ internal SingleFileTransferResult TransferSingleFile()
                         throw new DestinationFileExistsException(Path.GetFileName(DestinationFileWithMacrosExpanded));
                 }
             }
-            else PutDestinationFile();
+            else
+            {
+                PutDestinationFile();
+            }
 
             if (BatchContext.Options.PreserveLastModified) RestoreModified();
 

diff --git a/Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles.csproj b/Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles.csproj
@@ -8,7 +8,7 @@
 	  <AssemblyName>Frends.SFTP.UploadFiles</AssemblyName>
 	  <RootNamespace>Frends.SFTP.UploadFiles</RootNamespace>
 
-	  <Version>2.7.2</Version>
+	  <Version>2.8.0</Version>
 	  <Authors>Frends</Authors>
 	  <Copyright>Frends</Copyright>
 	  <Company>Frends</Company>