GeneXusSftp client remove function implementation (#747)

genexuslabs · Dec 23, 2022 · 8b3ba79 · 8b3ba79
1 parent 5ea83ed
commit 8b3ba79
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 3 deletions.
diff --git a/...rc/extensions/SecurityAPI/dotnet/dotnetframework/GeneXusSftp/Commons/ISftpClientObject.cs b/...rc/extensions/SecurityAPI/dotnet/dotnetframework/GeneXusSftp/Commons/ISftpClientObject.cs
@@ -18,7 +18,8 @@ public abstract class ISftpClientObject : SecurityAPIObject
 		public abstract bool Get(string remoteFilePath, string localDir);
 #pragma warning restore CA1716 // Identifiers should not match keywords
 		public abstract void Disconnect();
+		public abstract bool Rm(string remoteFilePath);
 
-        public abstract string GetWorkingDirectory();
+		public abstract string GetWorkingDirectory();
     }
 }
diff --git a/dotnet/src/extensions/SecurityAPI/dotnet/dotnetframework/GeneXusSftp/Sftp/SftpClient.cs b/dotnet/src/extensions/SecurityAPI/dotnet/dotnetframework/GeneXusSftp/Sftp/SftpClient.cs
@@ -267,7 +267,45 @@ public override bool Get(String remoteFilePath, String localDir)
             return true;
         }
 
-        [SecuritySafeCritical]
+		[SecuritySafeCritical]
+		public override bool Rm(String remoteFilePath)
+		{
+			if (SecurityUtils.compareStrings("", remoteFilePath) || remoteFilePath == null || remoteFilePath.IndexOfAny(Path.GetInvalidPathChars()) >= 0)
+			{
+				this.error.setError("SF018", "remoteFilePath cannot be empty");
+				return false;
+			}
+
+			if (this.channel == null || !this.channel.IsConnected)
+			{
+				this.error.setError("SF019", "The channel is invalid, reconect");
+				return false;
+			}
+			string rDir = "";
+			if (this.channel.WorkingDirectory.Contains("/"))
+			{
+				remoteFilePath = $"/{remoteFilePath.Replace(@"\", "/")}";
+
+				rDir += this.channel.WorkingDirectory + remoteFilePath;
+			}
+			else
+			{
+
+				rDir = this.channel.WorkingDirectory + remoteFilePath;
+			}
+			try
+			{
+				this.channel.DeleteFile(rDir);
+			}
+			catch (Exception e)
+			{
+				this.error.setError("SF008", e.Message);
+				return false;
+			}
+			return true;
+		}
+
+		[SecuritySafeCritical]
         public override void Disconnect()
         {
             if (this.channel != null && this.channel.IsConnected)

diff --git a/dotnet/src/extensions/SecurityAPI/test/dotnetframework/SecurityAPITest/Sftp/TestSftp.cs b/dotnet/src/extensions/SecurityAPI/test/dotnetframework/SecurityAPITest/Sftp/TestSftp.cs
@@ -1,4 +1,4 @@
-using SecurityAPITest.SecurityAPICommons.commons;
+using SecurityAPITest.SecurityAPICommons.commons;
 using NUnit.Framework;
 using Sftp.GeneXusSftp;
 using System.IO;
@@ -61,6 +61,18 @@ private void TestGet(SftpClient client)
 			True(get, client);
 		}
 
+		private void TestRm(SftpClient client)
+		{
+			bool get = client.Rm(remoteFilePath);
+			True(get, client);
+		}
+
+		private void TestGetFalse(SftpClient client)
+		{
+			bool get = client.Get(remoteFilePath, localDir);
+			False(get, client);
+		}
+
 		[Test]
 		public void TestWithUserPassword()
 		{
@@ -75,6 +87,22 @@ public void TestWithUserPassword()
 			client.Disconnect();
 		}
 
+
+		[Test]
+		public void TestRemove()
+		{
+			SftpOptions options = new SftpOptions();
+			options.Host = host;
+			options.User = user;
+			options.Password = password;
+			options.AllowHostKeyChecking = false;
+			SftpClient client = TestConnection(options);
+			TestPut(client);
+			TestRm(client);
+			TestGetFalse(client);
+			client.Disconnect();
+		}
+
 		[Test]
 		public void TestWithKey()
 		{