Skip to content

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

C#

Send websocket messages for queue/history updates.

nzbdav-devbb633e24b4ff
diff --git a/backend/Api/SabControllers/AddFile/AddFileController.cs b/backend/Api/SabControllers/AddFile/AddFileController.cs
index b78507cb..142fcf61 100644
--- a/backend/Api/SabControllers/AddFile/AddFileController.cs
+++ b/backend/Api/SabControllers/AddFile/AddFileController.cs
@@ -1,10 +1,13 @@
using System.Text;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
+using NzbWebDAV.Api.SabControllers.GetQueue;
using NzbWebDAV.Config;
using NzbWebDAV.Database;
using NzbWebDAV.Database.Models;
+using NzbWebDAV.Exceptions;
using NzbWebDAV.Queue;
+using NzbWebDAV.Websocket;
using Usenet.Nzb;
namespace NzbWebDAV.Api.SabControllers.AddFile;
@@ -13,7 +16,8 @@ public class AddFileController(
HttpContext httpContext,
DavDatabaseClient dbClient,
QueueManager queueManager,
- ConfigManager configManager
+ ConfigManager configManager,
+ WebsocketManager websocketManager
) : SabApiController.BaseController(httpContext, configManager)
{
public async Task<AddFileResponse> AddFileAsync(AddFileRequest request)
@@ -40,6 +44,8 @@ public class AddFileController(
};
dbClient.Ctx.QueueItems.Add(queueItem);
await dbClient.Ctx.SaveChangesAsync(request.CancellationToken);
+ var message = GetQueueResponse.QueueSlot.FromQueueItem(queueItem).ToJson();
+ _ = websocketManager.SendMessage(WebsocketTopic.QueueItemAdded, message);
// return response
return new AddFileResponse()
diff --git a/backend/Api/SabControllers/AddUrl/AddUrlController.cs b/backend/Api/SabControllers/AddUrl/AddUrlController.cs
index 17fece46..683dad30 100644
--- a/backend/Api/SabControllers/AddUrl/AddUrlController.cs
+++ b/backend/Api/SabControllers/AddUrl/AddUrlController.cs
@@ -4,6 +4,7 @@ using NzbWebDAV.Api.SabControllers.AddFile;
using NzbWebDAV.Config;
using NzbWebDAV.Database;
using NzbWebDAV.Queue;
+using NzbWebDAV.Websocket;
namespace NzbWebDAV.Api.SabControllers.AddUrl;
@@ -11,12 +12,13 @@ public class AddUrlController(
HttpContext httpContext,
DavDatabaseClient dbClient,
QueueManager queueManager,
- ConfigManager configManager
+ ConfigManager configManager,
+ WebsocketManager websocketManager
) : SabApiController.BaseController(httpContext, configManager)
{
public async Task<AddUrlResponse> AddUrlAsync(AddUrlRequest request)
{
- var controller = new AddFileController(httpContext, dbClient, queueManager, configManager);
+ var controller = new AddFileController(httpContext, dbClient, queueManager, configManager, websocketManager);
var response = await controller.AddFileAsync(request);
return new AddUrlResponse()
{
diff --git a/backend/Api/SabControllers/GetHistory/GetHistoryController.cs b/backend/Api/SabControllers/GetHistory/GetHistoryController.cs
index da579c1a..12c8fd4a 100644
--- a/backend/Api/SabControllers/GetHistory/GetHistoryController.cs
+++ b/backend/Api/SabControllers/GetHistory/GetHistoryController.cs
@@ -25,24 +25,7 @@ public class GetHistoryController(
// get slots
var slots = historyItems
- .Select(historyItem => new GetHistoryResponse.HistorySlot()
- {
- NzoId = historyItem.Id.ToString(),
- NzbName = historyItem.FileName,
- JobName = historyItem.JobName,
- Category = historyItem.Category,
- Status = historyItem.DownloadStatus,
- SizeInBytes = historyItem.TotalSegmentBytes,
- DownloadPath = Path.Join(new[]
- {
- configManager.GetRcloneMountDir(),
- DavItem.SymlinkFolder.Name,
- historyItem.Category,
- historyItem.JobName
- }),
- DownloadTimeSeconds = historyItem.DownloadTimeSeconds,
- FailMessage = historyItem.FailMessage ?? "",
- })
+ .Select(x => GetHistoryResponse.HistorySlot.FromHistoryItem(x, configManager.GetRcloneMountDir()))
.ToList();
// return response
diff --git a/backend/Api/SabControllers/GetHistory/GetHistoryResponse.cs b/backend/Api/SabControllers/GetHistory/GetHistoryResponse.cs
index 15807804..f0f9e9b8 100644
--- a/backend/Api/SabControllers/GetHistory/GetHistoryResponse.cs
+++ b/backend/Api/SabControllers/GetHistory/GetHistoryResponse.cs
@@ -43,5 +43,27 @@ public class GetHistoryResponse : SabBaseResponse
[JsonPropertyName("fail_message")]
public string FailMessage { get; set; }
+
+ public static HistorySlot FromHistoryItem(HistoryItem historyItem, string mountDir)
+ {
+ return new HistorySlot()
+ {
+ NzoId = historyItem.Id.ToString(),
+ NzbName = historyItem.FileName,
+ JobName = historyItem.JobName,
+ Category = historyItem.Category,
+ Status = historyItem.DownloadStatus,
+ SizeInBytes = historyItem.TotalSegmentBytes,
+ DownloadPath = Path.Join(new[]
+ {
+ mountDir,
+ DavItem.SymlinkFolder.Name,
+ historyItem.Category,
+ historyItem.JobName
+ }),
+ DownloadTimeSeconds = historyItem.DownloadTimeSeconds,
+ FailMessage = historyItem.FailMessage ?? "",
+ };
+ }
}
}
\ No newline at end of file
diff --git a/backend/Api/SabControllers/GetQueue/GetQueueController.cs b/backend/Api/SabControllers/GetQueue/GetQueueController.cs
index d33afded..7d4dbae9 100644
--- a/backend/Api/SabControllers/GetQueue/GetQueueController.cs
+++ b/backend/Api/SabControllers/GetQueue/GetQueueController.cs
@@ -31,19 +31,8 @@ public class GetQueueController(
.Select((queueItem, index) =>
{
var percentage = (queueItem == inProgressQueueItem ? progressPercentage : 0)!.Value;
- return new GetQueueResponse.QueueSlot
- {
- Index = index,
- NzoId = queueItem!.Id.ToString(),
- Priority = queueItem.Priority.ToString(),
- Filename = queueItem.FileName,
- Category = queueItem.Category,
- Percentage = percentage.ToString()!,
- Status = queueItem == inProgressQueueItem ? "Downloading" : "Queued",
- TimeLeft = TimeSpan.Zero,
- SizeInMB = FormatSizeMB(queueItem.TotalSegmentBytes),
- SizeLeftInMB = FormatSizeMB((100 - percentage) * queueItem.TotalSegmentBytes / 100),
- };
+ var status = queueItem == inProgressQueueItem ? "Downloading" : "Queued";
+ return GetQueueResponse.QueueSlot.FromQueueItem(queueItem!, index, percentage, status);
})
.ToList();
@@ -58,12 +47,6 @@ public class GetQueueController(
};
}
- private static string FormatSizeMB(long bytes)
- {
- var megabytes = bytes / (1024.0 * 1024.0);
- return megabytes.ToString("0.00");
- }
-
protected override async Task<IActionResult> Handle()
{
var request = new GetQueueRequest(httpContext);
diff --git a/backend/Api/SabControllers/GetQueue/GetQueueResponse.cs b/backend/Api/SabControllers/GetQueue/GetQueueResponse.cs
index 57cd768a..f928f1aa 100644
--- a/backend/Api/SabControllers/GetQueue/GetQueueResponse.cs
+++ b/backend/Api/SabControllers/GetQueue/GetQueueResponse.cs
@@ -1,5 +1,6 @@
using System.Text.Json;
using System.Text.Json.Serialization;
+using NzbWebDAV.Database.Models;
namespace NzbWebDAV.Api.SabControllers.GetQueue;
@@ -49,6 +50,35 @@ public class GetQueueResponse : SabBaseResponse
[JsonPropertyName("mbleft")]
public string SizeLeftInMB { get; init; }
+
+ public static QueueSlot FromQueueItem
+ (
+ QueueItem queueItem,
+ int index = 0,
+ int progressPercentage = 0,
+ string status = "Queued"
+ )
+ {
+ return new QueueSlot
+ {
+ Index = index,
+ NzoId = queueItem!.Id.ToString(),
+ Priority = queueItem.Priority.ToString(),
+ Filename = queueItem.FileName,
+ Category = queueItem.Category,
+ Percentage = progressPercentage.ToString()!,
+ Status = status,
+ TimeLeft = TimeSpan.Zero,
+ SizeInMB = FormatSizeMB(queueItem.TotalSegmentBytes),
+ SizeLeftInMB = FormatSizeMB((100 - progressPercentage) * queueItem.TotalSegmentBytes / 100),
+ };
+ }
+
+ private static string FormatSizeMB(long bytes)
+ {
+ var megabytes = bytes / (1024.0 * 1024.0);
+ return megabytes.ToString("0.00");
+ }
}
public class SabnzbdQueueTimeConverter : JsonConverter<TimeSpan>
diff --git a/backend/Api/SabControllers/RemoveFromHistory/RemoveFromHistoryController.cs b/backend/Api/SabControllers/RemoveFromHistory/RemoveFromHistoryController.cs
index d4d7d557..1b089a59 100644
--- a/backend/Api/SabControllers/RemoveFromHistory/RemoveFromHistoryController.cs
+++ b/backend/Api/SabControllers/RemoveFromHistory/RemoveFromHistoryController.cs
@@ -5,13 +5,15 @@ using NzbWebDAV.Config;
using NzbWebDAV.Database;
using NzbWebDAV.Database.Models;
using NzbWebDAV.Extensions;
+using NzbWebDAV.Websocket;
namespace NzbWebDAV.Api.SabControllers.RemoveFromHistory;
public class RemoveFromHistoryController(
HttpContext httpContext,
DavDatabaseClient dbClient,
- ConfigManager configManager
+ ConfigManager configManager,
+ WebsocketManager websocketManager
) : SabApiController.BaseController(httpContext, configManager)
{
public async Task<RemoveFromHistoryResponse> RemoveFromHistory(RemoveFromHistoryRequest request)
@@ -23,6 +25,7 @@ public class RemoveFromHistoryController(
dbClient.Ctx.HistoryItems.Remove(historyItem);
await dbClient.Ctx.SaveChangesAsync(request.CancellationToken);
await transaction.CommitAsync(request.CancellationToken);
+ _ = websocketManager.SendMessage(WebsocketTopic.HistoryItemRemoved, request.NzoId);
return new RemoveFromHistoryResponse() { Status = true };
}
diff --git a/backend/Api/SabControllers/RemoveFromQueue/RemoveFromQueueController.cs b/backend/Api/SabControllers/RemoveFromQueue/RemoveFromQueueController.cs
index 5e6a4560..1d0206c7 100644
--- a/backend/Api/SabControllers/RemoveFromQueue/RemoveFromQueueController.cs
+++ b/backend/Api/SabControllers/RemoveFromQueue/RemoveFromQueueController.cs
@@ -3,6 +3,7 @@ using Microsoft.AspNetCore.Mvc;
using NzbWebDAV.Config;
using NzbWebDAV.Database;
using NzbWebDAV.Queue;
+using NzbWebDAV.Websocket;
namespace NzbWebDAV.Api.SabControllers.RemoveFromQueue;
@@ -10,12 +11,14 @@ public class RemoveFromQueueController(
HttpContext httpContext,
DavDatabaseClient dbClient,
QueueManager queueManager,
- ConfigManager configManager
+ ConfigManager configManager,
+ WebsocketManager websocketManager
) : SabApiController.BaseController(httpContext, configManager)
{
public async Task<RemoveFromQueueResponse> RemoveFromQueue(RemoveFromQueueRequest request)
{
await queueManager.RemoveQueueItemAsync(request.NzoId, dbClient);
+ _ = websocketManager.SendMessage(WebsocketTopic.QueueItemRemoved, request.NzoId);
return new RemoveFromQueueResponse() { Status = true };
}
diff --git a/backend/Api/SabControllers/SabApiController.cs b/backend/Api/SabControllers/SabApiController.cs
index de77476a..d4b949e4 100644
--- a/backend/Api/SabControllers/SabApiController.cs
+++ b/backend/Api/SabControllers/SabApiController.cs
@@ -14,6 +14,7 @@ using NzbWebDAV.Database;
using NzbWebDAV.Extensions;
using NzbWebDAV.Queue;
using NzbWebDAV.Utils;
+using NzbWebDAV.Websocket;
namespace NzbWebDAV.Api.SabControllers;
@@ -22,7 +23,8 @@ namespace NzbWebDAV.Api.SabControllers;
public class SabApiController(
DavDatabaseClient dbClient,
ConfigManager configManager,
- QueueManager queueManager
+ QueueManager queueManager,
+ WebsocketManager websocketManager
) : ControllerBase
{
[HttpGet]
@@ -65,25 +67,34 @@ public class SabApiController(
switch (HttpContext.GetQueryParam("mode"))
{
case "version":
- return new GetVersionController(HttpContext, configManager);
+ return new GetVersionController(
+ HttpContext, configManager);
case "get_config":
- return new GetConfigController(HttpContext, configManager);
+ return new GetConfigController(
+ HttpContext, configManager);
case "fullstatus":
- return new GetFullStatusController(HttpContext, configManager);
+ return new GetFullStatusController(
+ HttpContext, configManager);
case "addfile":
- return new AddFileController(HttpContext, dbClient, queueManager, configManager);
+ return new AddFileController(
+ HttpContext, dbClient, queueManager, configManager, websocketManager);
case "addurl":
- return new AddUrlController(HttpContext, dbClient, queueManager, configManager);
+ return new AddUrlController(
+ HttpContext, dbClient, queueManager, configManager, websocketManager);
case "queue" when HttpContext.GetQueryParam("name") == "delete":
- return new RemoveFromQueueController(HttpContext, dbClient, queueManager, configManager);
+ return new RemoveFromQueueController(
+ HttpContext, dbClient, queueManager, configManager, websocketManager);
case "queue":
- return new GetQueueController(HttpContext, dbClient, queueManager, configManager);
+ return new GetQueueController(
+ HttpContext, dbClient, queueManager, configManager);
case "history" when HttpContext.GetQueryParam("name") == "delete":
- return new RemoveFromHistoryController(HttpContext, dbClient, configManager);
+ return new RemoveFromHistoryController(
+ HttpContext, dbClient, configManager, websocketManager);
case "history":
- return new GetHistoryController(HttpContext, dbClient, configManager);
+ return new GetHistoryController(
+ HttpContext, dbClient, configManager);
default:
throw new BadHttpRequestException("Invalid mode");
diff --git a/backend/Exceptions/ObjectExtensions.cs b/backend/Exceptions/ObjectExtensions.cs
new file mode 100644
index 00000000..f8c294b0
--- /dev/null
+++ b/backend/Exceptions/ObjectExtensions.cs
@@ -0,0 +1,11 @@
+using System.Text.Json;
+
+namespace NzbWebDAV.Exceptions;
+
+public static class ObjectExtensions
+{
+ public static string ToJson(this object obj)
+ {
+ return JsonSerializer.Serialize(obj);
+ }
+}
\ No newline at end of file
diff --git a/backend/Queue/QueueItemProcessor.cs b/backend/Queue/QueueItemProcessor.cs
index 6ae58ec9..63f04b15 100644
--- a/backend/Queue/QueueItemProcessor.cs
+++ b/backend/Queue/QueueItemProcessor.cs
@@ -1,14 +1,17 @@
using System.Text;
using Microsoft.EntityFrameworkCore;
+using NzbWebDAV.Api.SabControllers.GetHistory;
using NzbWebDAV.Clients;
using NzbWebDAV.Config;
using NzbWebDAV.Database;
using NzbWebDAV.Database.Models;
+using NzbWebDAV.Exceptions;
using NzbWebDAV.Extensions;
using NzbWebDAV.Queue.FileAggregators;
using NzbWebDAV.Queue.FileProcessors;
using NzbWebDAV.Queue.Validators;
using NzbWebDAV.Utils;
+using NzbWebDAV.Websocket;
using Serilog;
using Usenet.Nzb;
@@ -19,6 +22,7 @@ public class QueueItemProcessor(
DavDatabaseClient dbClient,
UsenetStreamingClient usenetClient,
ConfigManager configManager,
+ WebsocketManager websocketManager,
IProgress<int> progress,
CancellationToken ct
)
@@ -27,6 +31,7 @@ public class QueueItemProcessor(
{
// initialize
var startTime = DateTime.Now;
+ _ = websocketManager.SendMessage(WebsocketTopic.QueueItemStatus, $"{queueItem.Id}|Downloading");
// process the job
try
@@ -63,6 +68,7 @@ public class QueueItemProcessor(
dbClient.Ctx.QueueItems.Attach(queueItem);
dbClient.Ctx.Entry(queueItem).Property(x => x.PauseUntil).IsModified = true;
await dbClient.Ctx.SaveChangesAsync();
+ _ = websocketManager.SendMessage(WebsocketTopic.QueueItemStatus, $"{queueItem.Id}|Queued");
}
catch (Exception ex)
{
@@ -211,8 +217,13 @@ public class QueueItemProcessor(
{
dbClient.Ctx.ChangeTracker.Clear();
var mountFolder = databaseOperations?.Invoke();
+ var mountDirectory = configManager.GetRcloneMountDir();
+ var historyItem = CreateHistoryItem(mountFolder, startTime, error);
+ var historySlot = GetHistoryResponse.HistorySlot.FromHistoryItem(historyItem, mountDirectory);
dbClient.Ctx.QueueItems.Remove(queueItem);
- dbClient.Ctx.HistoryItems.Add(CreateHistoryItem(mountFolder, startTime, error));
+ dbClient.Ctx.HistoryItems.Add(historyItem);
await dbClient.Ctx.SaveChangesAsync(ct);
+ _ = websocketManager.SendMessage(WebsocketTopic.QueueItemRemoved, queueItem.Id.ToString());
+ _ = websocketManager.SendMessage(WebsocketTopic.HistoryItemAdded, historySlot.ToJson());
}
}
\ No newline at end of file
diff --git a/backend/Queue/QueueManager.cs b/backend/Queue/QueueManager.cs
index fa972f99..7240536d 100644
--- a/backend/Queue/QueueManager.cs
+++ b/backend/Queue/QueueManager.cs
@@ -2,6 +2,8 @@
using NzbWebDAV.Config;
using NzbWebDAV.Database;
using NzbWebDAV.Database.Models;
+using NzbWebDAV.Utils;
+using NzbWebDAV.Websocket;
using Serilog;
namespace NzbWebDAV.Queue;
@@ -14,11 +16,17 @@ public class QueueManager : IDisposable
private readonly CancellationTokenSource? _cancellationTokenSource;
private readonly SemaphoreSlim _semaphore = new(1, 1);
private readonly ConfigManager _configManager;
+ private readonly WebsocketManager _websocketManager;
- public QueueManager(UsenetStreamingClient usenetClient, ConfigManager configManager)
+ public QueueManager(
+ UsenetStreamingClient usenetClient,
+ ConfigManager configManager,
+ WebsocketManager websocketManager
+ )
{
_usenetClient = usenetClient;
_configManager = configManager;
+ _websocketManager = websocketManager;
_cancellationTokenSource = new CancellationTokenSource();
_ = ProcessQueueAsync(_cancellationTokenSource.Token);
}
@@ -93,7 +101,7 @@ public class QueueManager : IDisposable
{
var progressHook = new Progress<int>();
var task = new QueueItemProcessor(
- queueItem, dbClient, _usenetClient, _configManager, progressHook, cts.Token
+ queueItem, dbClient, _usenetClient, _configManager, _websocketManager, progressHook, cts.Token
).ProcessAsync();
var inProgressQueueItem = new InProgressQueueItem()
{
@@ -102,8 +110,13 @@ public class QueueManager : IDisposable
ProgressPercentage = 0,
CancellationTokenSource = cts
};
+ var debounce = DebounceUtil.CreateDebounce(TimeSpan.FromMilliseconds(200));
progressHook.ProgressChanged += (_, progress) =>
+ {
inProgressQueueItem.ProgressPercentage = progress;
+ var message = $"{queueItem.Id}|{progress}";
+ debounce(() => _websocketManager.SendMessage(WebsocketTopic.QueueItemProgress, message));
+ };
return inProgressQueueItem;
}
diff --git a/backend/WebDav/DatabaseStore.cs b/backend/WebDav/DatabaseStore.cs
index ad4bb4fa..ce67e0a7 100644
--- a/backend/WebDav/DatabaseStore.cs
+++ b/backend/WebDav/DatabaseStore.cs
@@ -5,6 +5,7 @@ using NzbWebDAV.Config;
using NzbWebDAV.Database;
using NzbWebDAV.Database.Models;
using NzbWebDAV.Queue;
+using NzbWebDAV.Websocket;
namespace NzbWebDAV.WebDav;
@@ -13,7 +14,8 @@ public class DatabaseStore(
DavDatabaseClient dbClient,
ConfigManager configManager,
UsenetStreamingClient usenetClient,
- QueueManager queueManager
+ QueueManager queueManager,
+ WebsocketManager websocketManager
) : IStore
{
private readonly DatabaseStoreCollection _root = new(
@@ -22,7 +24,8 @@ public class DatabaseStore(
dbClient,
configManager,
usenetClient,
- queueManager
+ queueManager,
+ websocketManager
);
public async Task<IStoreItem?> GetItemAsync(string path, CancellationToken cancellationToken)
diff --git a/backend/WebDav/DatabaseStoreCollection.cs b/backend/WebDav/DatabaseStoreCollection.cs
index 13a1d299..a66d283e 100644
--- a/backend/WebDav/DatabaseStoreCollection.cs
+++ b/backend/WebDav/DatabaseStoreCollection.cs
@@ -9,6 +9,7 @@ using NzbWebDAV.Extensions;
using NzbWebDAV.Queue;
using NzbWebDAV.WebDav.Base;
using NzbWebDAV.WebDav.Requests;
+using NzbWebDAV.Websocket;
namespace NzbWebDAV.WebDav;
@@ -18,7 +19,8 @@ public class DatabaseStoreCollection(
DavDatabaseClient dbClient,
ConfigManager configManager,
UsenetStreamingClient usenetClient,
- QueueManager queueManager
+ QueueManager queueManager,
+ WebsocketManager websocketManager
) : BaseStoreCollection
{
public override string Name => davDirectory.Name;
@@ -99,17 +101,23 @@ public class DatabaseStoreCollection(
return davItem.Type switch
{
DavItem.ItemType.IdsRoot =>
- new DatabaseStoreIdsCollection(davItem.Name, "", httpContext, dbClient, usenetClient, configManager),
+ new DatabaseStoreIdsCollection(
+ davItem.Name, "", httpContext, dbClient, usenetClient, configManager),
DavItem.ItemType.Directory when davItem.Id == DavItem.NzbFolder.Id =>
- new DatabaseStoreWatchFolder(davItem, httpContext, dbClient, configManager, usenetClient, queueManager),
+ new DatabaseStoreWatchFolder(
+ davItem, httpContext, dbClient, configManager, usenetClient, queueManager, websocketManager),
DavItem.ItemType.Directory =>
- new DatabaseStoreCollection(davItem, httpContext, dbClient, configManager, usenetClient, queueManager),
+ new DatabaseStoreCollection(
+ davItem, httpContext, dbClient, configManager, usenetClient, queueManager, websocketManager),
DavItem.ItemType.SymlinkRoot =>
- new DatabaseStoreSymlinkCollection(davItem, dbClient, configManager),
+ new DatabaseStoreSymlinkCollection(
+ davItem, dbClient, configManager),
DavItem.ItemType.NzbFile =>
- new DatabaseStoreNzbFile(davItem, httpContext, dbClient, usenetClient, configManager),
+ new DatabaseStoreNzbFile(
+ davItem, httpContext, dbClient, usenetClient, configManager),
DavItem.ItemType.RarFile =>
- new DatabaseStoreRarFile(davItem, httpContext, dbClient, usenetClient, configManager),
+ new DatabaseStoreRarFile(
+ davItem, httpContext, dbClient, usenetClient, configManager),
_ => throw new ArgumentException("Unrecognized directory child type.")
};
}
diff --git a/backend/WebDav/DatabaseStoreWatchFolder.cs b/backend/WebDav/DatabaseStoreWatchFolder.cs
index b233cc7a..4a21f7a7 100644
--- a/backend/WebDav/DatabaseStoreWatchFolder.cs
+++ b/backend/WebDav/DatabaseStoreWatchFolder.cs
@@ -10,6 +10,7 @@ using NzbWebDAV.Database;
using NzbWebDAV.Database.Models;
using NzbWebDAV.Queue;
using NzbWebDAV.WebDav.Requests;
+using NzbWebDAV.Websocket;
namespace NzbWebDAV.WebDav;
@@ -19,8 +20,17 @@ public class DatabaseStoreWatchFolder(
DavDatabaseClient dbClient,
ConfigManager configManager,
UsenetStreamingClient usenetClient,
- QueueManager queueManager
-) : DatabaseStoreCollection(davDirectory, httpContext, dbClient, configManager, usenetClient, queueManager)
+ QueueManager queueManager,
+ WebsocketManager websocketManager
+) : DatabaseStoreCollection(
+ davDirectory,
+ httpContext,
+ dbClient,
+ configManager,
+ usenetClient,
+ queueManager,
+ websocketManager
+)
{
protected override async Task<IStoreItem?> GetItemAsync(GetItemRequest request)
{
@@ -41,7 +51,7 @@ public class DatabaseStoreWatchFolder(
protected override async Task<StoreItemResult> CreateItemAsync(CreateItemRequest request)
{
- var controller = new AddFileController(null!, dbClient, queueManager, configManager);
+ var controller = new AddFileController(null!, dbClient, queueManager, configManager, websocketManager);
using var streamReader = new StreamReader(request.Stream);
var nzbFileContents = await streamReader.ReadToEndAsync(request.CancellationToken);
var addFileRequest = new AddFileRequest()
@@ -65,7 +75,7 @@ public class DatabaseStoreWatchFolder(
protected override async Task<DavStatusCode> DeleteItemAsync(DeleteItemRequest request)
{
- var controller = new RemoveFromQueueController(null!, dbClient, queueManager, configManager);
+ var controller = new RemoveFromQueueController(null!, dbClient, queueManager, configManager, websocketManager);
// get the item to delete
var item = await dbClient.Ctx.QueueItems
diff --git a/backend/Websocket/WebsocketManager.cs b/backend/Websocket/WebsocketManager.cs
index aa100f52..5e391268 100644
--- a/backend/Websocket/WebsocketManager.cs
+++ b/backend/Websocket/WebsocketManager.cs
@@ -2,6 +2,7 @@
using System.Text;
using System.Text.Json;
using Microsoft.AspNetCore.Http;
+using NzbWebDAV.Exceptions;
using NzbWebDAV.Utils;
using Serilog;
@@ -10,7 +11,7 @@ namespace NzbWebDAV.Websocket;
public class WebsocketManager
{
private readonly HashSet<WebSocket> _authenticatedSockets = [];
- private readonly Dictionary<string, string> _lastMessage = new();
+ private readonly Dictionary<WebsocketTopic, string> _lastMessage = new();
public async Task HandleRoute(HttpContext context)
{
@@ -29,10 +30,11 @@ public class WebsocketManager
_authenticatedSockets.Add(webSocket);
// send current state for all topics
- List<KeyValuePair<string, string>>? lastMessage = null;
+ List<KeyValuePair<WebsocketTopic, string>>? lastMessage;
lock (_lastMessage) lastMessage = _lastMessage.ToList();
foreach (var message in lastMessage)
- await SendMessage(webSocket, message.Key, message.Value);
+ if (message.Key.Type == WebsocketTopic.TopicType.State)
+ await SendMessage(webSocket, message.Key, message.Value);
// wait for the socket to disconnect
await WaitForDisconnected(webSocket);
@@ -50,13 +52,13 @@ public class WebsocketManager
/// </summary>
/// <param name="topic">The topic of the message to send</param>
/// <param name="message">The message to send</param>
- public Task SendMessage(string topic, string message)
+ public Task SendMessage(WebsocketTopic topic, string message)
{
lock (_lastMessage) _lastMessage[topic] = message;
List<WebSocket>? authenticatedSockets;
lock (_authenticatedSockets) authenticatedSockets = _authenticatedSockets.ToList();
var topicMessage = new TopicMessage(topic, message);
- var bytes = new ArraySegment<byte>(Encoding.UTF8.GetBytes(topicMessage.ToString()));
+ var bytes = new ArraySegment<byte>(Encoding.UTF8.GetBytes(topicMessage.ToJson()));
return Task.WhenAll(authenticatedSockets.Select(x => SendMessage(x, bytes)));
}
@@ -91,10 +93,10 @@ public class WebsocketManager
/// <param name="socket">The websocket to send the message to.</param>
/// <param name="topic">The topic of the message to send</param>
/// <param name="message">The message to send</param>
- private static async Task SendMessage(WebSocket socket, string topic, string message)
+ private static async Task SendMessage(WebSocket socket, WebsocketTopic topic, string message)
{
var topicMessage = new TopicMessage(topic, message);
- var bytes = new ArraySegment<byte>(Encoding.UTF8.GetBytes(topicMessage.ToString()));
+ var bytes = new ArraySegment<byte>(Encoding.UTF8.GetBytes(topicMessage.ToJson()));
await SendMessage(socket, bytes);
}
@@ -149,10 +151,9 @@ public class WebsocketManager
await socket.CloseAsync(WebSocketCloseStatus.PolicyViolation, "Unauthorized", CancellationToken.None);
}
- private sealed class TopicMessage(string topic, string message)
+ private sealed class TopicMessage(WebsocketTopic topic, string message)
{
- public string Topic { get; } = topic;
+ public string Topic { get; } = topic.Name;
public string Message { get; } = message;
- public override string ToString() => JsonSerializer.Serialize(this);
}
}
\ No newline at end of file
diff --git a/backend/Websocket/WebsocketTopic.cs b/backend/Websocket/WebsocketTopic.cs
index 2b50d9a8..881361cb 100644
--- a/backend/Websocket/WebsocketTopic.cs
+++ b/backend/Websocket/WebsocketTopic.cs
@@ -1,7 +1,31 @@
namespace NzbWebDAV.Websocket;
-public static class WebsocketTopic
+public class WebsocketTopic
{
- public const string UsenetConnections = "cxs";
- public const string SymlinkTaskProgress = "stp";
+ // Stateful topics
+ public static readonly WebsocketTopic UsenetConnections = new("cxs", TopicType.State);
+ public static readonly WebsocketTopic SymlinkTaskProgress = new("stp", TopicType.State);
+ public static readonly WebsocketTopic QueueItemStatus = new("qs", TopicType.State);
+ public static readonly WebsocketTopic QueueItemProgress = new("qp", TopicType.State);
+
+ // Eventful topics
+ public static readonly WebsocketTopic QueueItemAdded = new("qa", TopicType.Event);
+ public static readonly WebsocketTopic QueueItemRemoved = new("qr", TopicType.Event);
+ public static readonly WebsocketTopic HistoryItemAdded = new("ha", TopicType.Event);
+ public static readonly WebsocketTopic HistoryItemRemoved = new("hr", TopicType.Event);
+
+ public readonly string Name;
+ public readonly TopicType Type;
+
+ private WebsocketTopic(string name, TopicType type)
+ {
+ Name = name;
+ Type = type;
+ }
+
+ public enum TopicType
+ {
+ State,
+ Event
+ }
}
\ No newline at end of file