Skip to content

Usenet streaming with a WebDAV server and a SABnzbd-compatible API

C#

Added test-rclone-connection api.

nzbdav-dev0db4bb347c72
diff --git a/backend/Api/Controllers/TestRcloneConnection/TestRcloneConnectionController.cs b/backend/Api/Controllers/TestRcloneConnection/TestRcloneConnectionController.cs
new file mode 100644
index 00000000..08e37b65
--- /dev/null
+++ b/backend/Api/Controllers/TestRcloneConnection/TestRcloneConnectionController.cs
@@ -0,0 +1,42 @@
+using Microsoft.AspNetCore.Mvc;
+using NzbWebDAV.Clients.Rclone;
+
+namespace NzbWebDAV.Api.Controllers.TestRcloneConnection;
+
+[ApiController]
+[Route("api/test-rclone-connection")]
+public class TestRcloneConnectionController() : BaseApiController
+{
+ private static async Task<TestRcloneConnectionResponse> TestRcloneConnection(TestRcloneConnectionRequest request)
+ {
+ try
+ {
+ var result = await RcloneClient
+ .TestConnection(request.Host, request.User, request.Pass)
+ .ConfigureAwait(false);
+
+ return new TestRcloneConnectionResponse
+ {
+ Status = true,
+ Connected = result.Success,
+ Error = result.Error
+ };
+ }
+ catch (Exception e)
+ {
+ return new TestRcloneConnectionResponse
+ {
+ Status = true,
+ Connected = false,
+ Error = e.Message
+ };
+ }
+ }
+
+ protected override async Task<IActionResult> HandleRequest()
+ {
+ var request = new TestRcloneConnectionRequest(HttpContext);
+ var response = await TestRcloneConnection(request).ConfigureAwait(false);
+ return Ok(response);
+ }
+}
\ No newline at end of file
diff --git a/backend/Api/Controllers/TestRcloneConnection/TestRcloneConnectionRequest.cs b/backend/Api/Controllers/TestRcloneConnection/TestRcloneConnectionRequest.cs
new file mode 100644
index 00000000..2bf5ae9c
--- /dev/null
+++ b/backend/Api/Controllers/TestRcloneConnection/TestRcloneConnectionRequest.cs
@@ -0,0 +1,19 @@
+using Microsoft.AspNetCore.Http;
+
+namespace NzbWebDAV.Api.Controllers.TestRcloneConnection;
+
+public class TestRcloneConnectionRequest
+{
+ public string Host { get; init; }
+ public string? User { get; init; }
+ public string? Pass { get; init; }
+
+ public TestRcloneConnectionRequest(HttpContext context)
+ {
+ Host = context.Request.Form["host"].FirstOrDefault()
+ ?? throw new BadHttpRequestException("Rclone host is required");
+
+ User = context.Request.Form["user"].FirstOrDefault();
+ Pass = context.Request.Form["pass"].FirstOrDefault();
+ }
+}
diff --git a/backend/Api/Controllers/TestRcloneConnection/TestRcloneConnectionResponse.cs b/backend/Api/Controllers/TestRcloneConnection/TestRcloneConnectionResponse.cs
new file mode 100644
index 00000000..2e57682b
--- /dev/null
+++ b/backend/Api/Controllers/TestRcloneConnection/TestRcloneConnectionResponse.cs
@@ -0,0 +1,6 @@
+namespace NzbWebDAV.Api.Controllers.TestRcloneConnection;
+
+public class TestRcloneConnectionResponse : BaseApiResponse
+{
+ public bool Connected { get; set; }
+}
diff --git a/backend/Clients/Rclone/RcloneClient.cs b/backend/Clients/Rclone/RcloneClient.cs
index 0e39d54e..267d0e50 100644
--- a/backend/Clients/Rclone/RcloneClient.cs
+++ b/backend/Clients/Rclone/RcloneClient.cs
@@ -141,9 +141,27 @@ public class RcloneClient
}
}
- private static async Task<T> Post<T>(string endpoint, object? body) where T : RcloneResponse, new()
+ /// <summary>
+ /// Test connectivity to a rclone RC server with the given credentials.
+ /// </summary>
+ public static async Task<RcloneResponse> TestConnection(string host, string? user, string? pass)
+ {
+ var result = await Post<CoreVersionResponse>(host, user, pass, "core/version", null);
+ if (result.Success && string.IsNullOrEmpty(result.Version))
+ return new RcloneResponse { Success = false, Error = "Connected but received empty version" };
+ return result;
+ }
+
+ private static async Task<T> Post<T>
+ (
+ string host,
+ string? user,
+ string? pass,
+ string endpoint,
+ object? body
+ ) where T : RcloneResponse, new()
{
- var url = $"{Host}/{endpoint}";
+ var url = $"{host}/{endpoint}";
var request = new HttpRequestMessage(HttpMethod.Post, url);
if (body != null)
@@ -156,7 +174,7 @@ public class RcloneClient
request.Content = new StringContent("{}", Encoding.UTF8, "application/json");
}
- AddAuthHeader(request);
+ AddAuthHeader(request, user, pass);
try
{
@@ -205,12 +223,15 @@ public class RcloneClient
}
}
- private static void AddAuthHeader(HttpRequestMessage request)
+ private static Task<T> Post<T>(string endpoint, object? body) where T : RcloneResponse, new()
+ => Post<T>(Host!, User, Pass, endpoint, body);
+
+ private static void AddAuthHeader(HttpRequestMessage request, string? user, string? pass)
{
- if (string.IsNullOrEmpty(User) && string.IsNullOrEmpty(Pass))
+ if (string.IsNullOrEmpty(user) && string.IsNullOrEmpty(pass))
return;
- var credentials = $"{User ?? ""}:{Pass ?? ""}";
+ var credentials = $"{user ?? ""}:{pass ?? ""}";
var encodedCredentials = Convert.ToBase64String(Encoding.UTF8.GetBytes(credentials));
request.Headers.Authorization = new AuthenticationHeaderValue("Basic", encodedCredentials);
}