Skip to content

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

C#

Added .ids root folder within webdav.

nzbdav-deva6395e1bf811
diff --git a/backend/Database/DavDatabaseClient.cs b/backend/Database/DavDatabaseClient.cs
index bd605bfe..8cba2391 100644
--- a/backend/Database/DavDatabaseClient.cs
+++ b/backend/Database/DavDatabaseClient.cs
@@ -7,6 +7,21 @@ public sealed class DavDatabaseClient(DavDatabaseContext ctx)
{
public DavDatabaseContext Ctx => ctx;
+ // file
+ public Task<DavItem?> GetFileById(string id)
+ {
+ var guid = Guid.Parse(id);
+ return ctx.Items.Where(i => i.Id == guid).FirstOrDefaultAsync();
+ }
+
+ public Task<List<DavItem>> GetFilesByIdPrefix(string prefix)
+ {
+ return ctx.Items
+ .Where(i => EF.Functions.Like(i.Id.ToString(), $"{prefix}%"))
+ .Where(i => i.Type == DavItem.ItemType.NzbFile || i.Type == DavItem.ItemType.RarFile)
+ .ToListAsync();
+ }
+
// directory
public Task<List<DavItem>> GetDirectoryChildrenAsync(Guid dirId, CancellationToken ct = default)
{
diff --git a/backend/Database/Migrations/20250819091746_Add-Ids-Root-Directory.Designer.cs b/backend/Database/Migrations/20250819091746_Add-Ids-Root-Directory.Designer.cs
new file mode 100644
index 00000000..b588c24a
--- /dev/null
+++ b/backend/Database/Migrations/20250819091746_Add-Ids-Root-Directory.Designer.cs
@@ -0,0 +1,261 @@
+// <auto-generated />
+using System;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.EntityFrameworkCore.Infrastructure;
+using Microsoft.EntityFrameworkCore.Migrations;
+using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
+using NzbWebDAV.Database;
+
+#nullable disable
+
+namespace NzbWebDAV.Database.Migrations
+{
+ [DbContext(typeof(DavDatabaseContext))]
+ [Migration("20250819091746_Add-Ids-Root-Directory")]
+ partial class AddIdsRootDirectory
+ {
+ /// <inheritdoc />
+ protected override void BuildTargetModel(ModelBuilder modelBuilder)
+ {
+#pragma warning disable 612, 618
+ modelBuilder.HasAnnotation("ProductVersion", "9.0.4");
+
+ modelBuilder.Entity("NzbWebDAV.Database.Models.Account", b =>
+ {
+ b.Property<int>("Type")
+ .HasColumnType("INTEGER");
+
+ b.Property<string>("Username")
+ .HasMaxLength(255)
+ .HasColumnType("TEXT");
+
+ b.Property<string>("PasswordHash")
+ .IsRequired()
+ .HasColumnType("TEXT");
+
+ b.Property<string>("RandomSalt")
+ .IsRequired()
+ .HasColumnType("TEXT");
+
+ b.HasKey("Type", "Username");
+
+ b.ToTable("Accounts", (string)null);
+ });
+
+ modelBuilder.Entity("NzbWebDAV.Database.Models.ConfigItem", b =>
+ {
+ b.Property<string>("ConfigName")
+ .HasColumnType("TEXT");
+
+ b.Property<string>("ConfigValue")
+ .IsRequired()
+ .HasColumnType("TEXT");
+
+ b.HasKey("ConfigName");
+
+ b.ToTable("ConfigItems", (string)null);
+ });
+
+ modelBuilder.Entity("NzbWebDAV.Database.Models.DavItem", b =>
+ {
+ b.Property<Guid>("Id")
+ .HasColumnType("TEXT");
+
+ b.Property<DateTime>("CreatedAt")
+ .HasColumnType("TEXT");
+
+ b.Property<long?>("FileSize")
+ .HasColumnType("INTEGER");
+
+ b.Property<string>("Name")
+ .IsRequired()
+ .HasMaxLength(255)
+ .HasColumnType("TEXT");
+
+ b.Property<Guid?>("ParentId")
+ .HasColumnType("TEXT");
+
+ b.Property<int>("Type")
+ .HasColumnType("INTEGER");
+
+ b.HasKey("Id");
+
+ b.HasIndex("ParentId", "Name")
+ .IsUnique();
+
+ b.ToTable("DavItems", (string)null);
+ });
+
+ modelBuilder.Entity("NzbWebDAV.Database.Models.DavNzbFile", b =>
+ {
+ b.Property<Guid>("Id")
+ .HasColumnType("TEXT");
+
+ b.Property<string>("SegmentIds")
+ .IsRequired()
+ .HasColumnType("TEXT");
+
+ b.HasKey("Id");
+
+ b.ToTable("DavNzbFiles", (string)null);
+ });
+
+ modelBuilder.Entity("NzbWebDAV.Database.Models.DavRarFile", b =>
+ {
+ b.Property<Guid>("Id")
+ .HasColumnType("TEXT");
+
+ b.Property<string>("RarParts")
+ .IsRequired()
+ .HasColumnType("TEXT");
+
+ b.HasKey("Id");
+
+ b.ToTable("DavRarFiles", (string)null);
+ });
+
+ modelBuilder.Entity("NzbWebDAV.Database.Models.HistoryItem", b =>
+ {
+ b.Property<Guid>("Id")
+ .HasColumnType("TEXT");
+
+ b.Property<string>("Category")
+ .IsRequired()
+ .HasColumnType("TEXT");
+
+ b.Property<DateTime>("CreatedAt")
+ .HasColumnType("TEXT");
+
+ b.Property<Guid?>("DownloadDirId")
+ .HasColumnType("TEXT");
+
+ b.Property<int>("DownloadStatus")
+ .HasColumnType("INTEGER");
+
+ b.Property<int>("DownloadTimeSeconds")
+ .HasColumnType("INTEGER");
+
+ b.Property<string>("FailMessage")
+ .HasColumnType("TEXT");
+
+ b.Property<string>("FileName")
+ .IsRequired()
+ .HasColumnType("TEXT");
+
+ b.Property<string>("JobName")
+ .IsRequired()
+ .HasColumnType("TEXT");
+
+ b.Property<long>("TotalSegmentBytes")
+ .HasColumnType("INTEGER");
+
+ b.HasKey("Id");
+
+ b.HasIndex("Category");
+
+ b.HasIndex("CreatedAt");
+
+ b.HasIndex("Category", "CreatedAt");
+
+ b.HasIndex("Category", "DownloadDirId");
+
+ b.ToTable("HistoryItems", (string)null);
+ });
+
+ modelBuilder.Entity("NzbWebDAV.Database.Models.QueueItem", b =>
+ {
+ b.Property<Guid>("Id")
+ .HasColumnType("TEXT");
+
+ b.Property<string>("Category")
+ .IsRequired()
+ .HasColumnType("TEXT");
+
+ b.Property<DateTime>("CreatedAt")
+ .HasColumnType("TEXT");
+
+ b.Property<string>("FileName")
+ .IsRequired()
+ .HasColumnType("TEXT");
+
+ b.Property<string>("JobName")
+ .IsRequired()
+ .HasColumnType("TEXT");
+
+ b.Property<string>("NzbContents")
+ .IsRequired()
+ .HasColumnType("TEXT");
+
+ b.Property<long>("NzbFileSize")
+ .HasColumnType("INTEGER");
+
+ b.Property<DateTime?>("PauseUntil")
+ .HasColumnType("TEXT");
+
+ b.Property<int>("PostProcessing")
+ .HasColumnType("INTEGER");
+
+ b.Property<int>("Priority")
+ .HasColumnType("INTEGER");
+
+ b.Property<long>("TotalSegmentBytes")
+ .HasColumnType("INTEGER");
+
+ b.HasKey("Id");
+
+ b.HasIndex("Category");
+
+ b.HasIndex("CreatedAt");
+
+ b.HasIndex("FileName")
+ .IsUnique();
+
+ b.HasIndex("Priority");
+
+ b.HasIndex("Priority", "CreatedAt");
+
+ b.HasIndex("Category", "Priority", "CreatedAt");
+
+ b.ToTable("QueueItems", (string)null);
+ });
+
+ modelBuilder.Entity("NzbWebDAV.Database.Models.DavItem", b =>
+ {
+ b.HasOne("NzbWebDAV.Database.Models.DavItem", "Parent")
+ .WithMany("Children")
+ .HasForeignKey("ParentId")
+ .OnDelete(DeleteBehavior.Cascade);
+
+ b.Navigation("Parent");
+ });
+
+ modelBuilder.Entity("NzbWebDAV.Database.Models.DavNzbFile", b =>
+ {
+ b.HasOne("NzbWebDAV.Database.Models.DavItem", "DavItem")
+ .WithOne()
+ .HasForeignKey("NzbWebDAV.Database.Models.DavNzbFile", "Id")
+ .OnDelete(DeleteBehavior.Cascade)
+ .IsRequired();
+
+ b.Navigation("DavItem");
+ });
+
+ modelBuilder.Entity("NzbWebDAV.Database.Models.DavRarFile", b =>
+ {
+ b.HasOne("NzbWebDAV.Database.Models.DavItem", "DavItem")
+ .WithOne()
+ .HasForeignKey("NzbWebDAV.Database.Models.DavRarFile", "Id")
+ .OnDelete(DeleteBehavior.Cascade)
+ .IsRequired();
+
+ b.Navigation("DavItem");
+ });
+
+ modelBuilder.Entity("NzbWebDAV.Database.Models.DavItem", b =>
+ {
+ b.Navigation("Children");
+ });
+#pragma warning restore 612, 618
+ }
+ }
+}
diff --git a/backend/Database/Migrations/20250819091746_Add-Ids-Root-Directory.cs b/backend/Database/Migrations/20250819091746_Add-Ids-Root-Directory.cs
new file mode 100644
index 00000000..c876bffd
--- /dev/null
+++ b/backend/Database/Migrations/20250819091746_Add-Ids-Root-Directory.cs
@@ -0,0 +1,40 @@
+using Microsoft.EntityFrameworkCore.Migrations;
+
+#nullable disable
+
+namespace NzbWebDAV.Database.Migrations
+{
+ /// <inheritdoc />
+ public partial class AddIdsRootDirectory : Migration
+ {
+ /// <inheritdoc />
+ protected override void Up(MigrationBuilder migrationBuilder)
+ {
+ migrationBuilder.InsertData(
+ table: "DavItems",
+ columns: new[] { "Id", "ParentId", "Name", "FileSize", "Type" },
+ values: new object[,]
+ {
+ {
+ // Root
+ Guid.Parse("00000000-0000-0000-0000-000000000004"),
+ Guid.Parse("00000000-0000-0000-0000-000000000000"),
+ ".ids",
+ null,
+ 5, // IdsRoot
+ },
+ }
+ );
+ }
+
+ /// <inheritdoc />
+ protected override void Down(MigrationBuilder migrationBuilder)
+ {
+ migrationBuilder.DeleteData(
+ table: "DavItems",
+ keyColumn: "Id",
+ keyValue: Guid.Parse("00000000-0000-0000-0000-000000000004")
+ );
+ }
+ }
+}
diff --git a/backend/Database/Models/DavItem.cs b/backend/Database/Models/DavItem.cs
index c6d1ea0e..15f00e78 100644
--- a/backend/Database/Models/DavItem.cs
+++ b/backend/Database/Models/DavItem.cs
@@ -19,6 +19,7 @@ public class DavItem
SymlinkRoot = 2,
NzbFile = 3,
RarFile = 4,
+ IdsRoot = 5,
}
// navigation helpers
@@ -66,4 +67,13 @@ public class DavItem
FileSize = null,
Type = ItemType.SymlinkRoot,
};
+
+ public static readonly DavItem IdsFolder = new()
+ {
+ Id = Guid.Parse("00000000-0000-0000-0000-000000000004"),
+ ParentId = Root.Id,
+ Name = ".ids",
+ FileSize = null,
+ Type = ItemType.IdsRoot,
+ };
}
\ No newline at end of file
diff --git a/backend/Extensions/DavItemExtensions.cs b/backend/Extensions/DavItemExtensions.cs
index eb063dd0..372f0846 100644
--- a/backend/Extensions/DavItemExtensions.cs
+++ b/backend/Extensions/DavItemExtensions.cs
@@ -10,6 +10,7 @@ public static class DavItemExtensions
DavItem.SymlinkFolder.Id,
DavItem.ContentFolder.Id,
DavItem.NzbFolder.Id,
+ DavItem.IdsFolder.Id,
];
public static bool IsProtected(this DavItem item)
diff --git a/backend/WebDav/DatabaseStoreCollection.cs b/backend/WebDav/DatabaseStoreCollection.cs
index 56b887dd..13a1d299 100644
--- a/backend/WebDav/DatabaseStoreCollection.cs
+++ b/backend/WebDav/DatabaseStoreCollection.cs
@@ -98,6 +98,8 @@ public class DatabaseStoreCollection(
{
return davItem.Type switch
{
+ DavItem.ItemType.IdsRoot =>
+ 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),
DavItem.ItemType.Directory =>
diff --git a/backend/WebDav/DatabaseStoreIdFile.cs b/backend/WebDav/DatabaseStoreIdFile.cs
new file mode 100644
index 00000000..324ce47e
--- /dev/null
+++ b/backend/WebDav/DatabaseStoreIdFile.cs
@@ -0,0 +1,55 @@
+using Microsoft.AspNetCore.Http;
+using NWebDav.Server;
+using NWebDav.Server.Stores;
+using NzbWebDAV.Clients;
+using NzbWebDAV.Config;
+using NzbWebDAV.Database;
+using NzbWebDAV.Database.Models;
+using NzbWebDAV.WebDav.Base;
+using NzbWebDAV.WebDav.Requests;
+using Serilog;
+
+namespace NzbWebDAV.WebDav;
+
+public class DatabaseStoreIdFile(
+ DavItem davItem,
+ HttpContext httpContext,
+ DavDatabaseClient dbClient,
+ UsenetStreamingClient usenetClient,
+ ConfigManager configManager
+) : BaseStoreItem
+{
+ public override string Name => davItem.Id.ToString();
+ public override string UniqueKey => davItem.Id.ToString();
+ public override long FileSize => davItem.FileSize!.Value;
+ public override DateTime CreatedAt => davItem.CreatedAt;
+
+ public override Task<Stream> GetReadableStreamAsync(CancellationToken cancellationToken)
+ {
+ return GetItem(davItem).GetReadableStreamAsync(cancellationToken);
+ }
+
+ protected override Task<DavStatusCode> UploadFromStreamAsync(UploadFromStreamRequest request)
+ {
+ Log.Error("nzb-mounted files cannot be modified.");
+ return Task.FromResult(DavStatusCode.Forbidden);
+ }
+
+ protected override Task<StoreItemResult> CopyAsync(CopyRequest request)
+ {
+ Log.Error("nzb-mounted files cannot be copied.");
+ return Task.FromResult(new StoreItemResult(DavStatusCode.Forbidden));
+ }
+
+ private IStoreItem GetItem(DavItem davItem)
+ {
+ return davItem.Type switch
+ {
+ DavItem.ItemType.NzbFile =>
+ new DatabaseStoreNzbFile(davItem, httpContext, dbClient, usenetClient, configManager),
+ DavItem.ItemType.RarFile =>
+ new DatabaseStoreRarFile(davItem, httpContext, dbClient, usenetClient, configManager),
+ _ => throw new ArgumentException("Unrecognized id child type.")
+ };
+ }
+}
\ No newline at end of file
diff --git a/backend/WebDav/DatabaseStoreIdsCollection.cs b/backend/WebDav/DatabaseStoreIdsCollection.cs
new file mode 100644
index 00000000..34de503e
--- /dev/null
+++ b/backend/WebDav/DatabaseStoreIdsCollection.cs
@@ -0,0 +1,94 @@
+using Microsoft.AspNetCore.Http;
+using NWebDav.Server;
+using NWebDav.Server.Stores;
+using NzbWebDAV.Clients;
+using NzbWebDAV.Config;
+using NzbWebDAV.Database;
+using NzbWebDAV.WebDav.Base;
+using NzbWebDAV.WebDav.Requests;
+
+namespace NzbWebDAV.WebDav;
+
+public class DatabaseStoreIdsCollection(
+ string name,
+ string currentPath,
+ HttpContext httpContext,
+ DavDatabaseClient dbClient,
+ UsenetStreamingClient usenetClient,
+ ConfigManager configManager
+) : BaseStoreCollection
+{
+ public override string Name => name;
+ public override string UniqueKey => currentPath;
+ public override DateTime CreatedAt => default;
+
+ private const int FanningDepth = 5;
+ private const string Alphabet = "0123456789abcdef";
+
+ private readonly string[] _currentPathParts = currentPath.Split(
+ Path.DirectorySeparatorChar,
+ Path.AltDirectorySeparatorChar,
+ StringSplitOptions.RemoveEmptyEntries
+ );
+
+ protected override Task<StoreItemResult> CopyAsync(CopyRequest request)
+ {
+ throw new InvalidOperationException("Files and Directories cannot be copied.");
+ }
+
+ protected override async Task<IStoreItem?> GetItemAsync(GetItemRequest request)
+ {
+ var (dir, ctx, db, usenet, config) = (request.Name, httpContext, dbClient, usenetClient, configManager);
+ if (_currentPathParts.Length < FanningDepth)
+ {
+ if (request.Name.Length != 1) return null;
+ if (!Alphabet.Contains(request.Name[0])) return null;
+ return new DatabaseStoreIdsCollection(dir, Path.Join(currentPath, dir), ctx, db, usenet, config);
+ }
+
+ var item = await dbClient.GetFileById(request.Name);
+ return item == null ? null : new DatabaseStoreIdFile(item, ctx, dbClient, usenet, config);
+ }
+
+ protected override async Task<IStoreItem[]> GetAllItemsAsync(CancellationToken cancellationToken)
+ {
+ var (ctx, db, usenet, config) = (httpContext, dbClient, usenetClient, configManager);
+ if (_currentPathParts.Length < FanningDepth)
+ return Alphabet
+ .Select(x => x.ToString())
+ .Select(x => new DatabaseStoreIdsCollection(x, Path.Join(currentPath, x), ctx, db, usenet, config))
+ .Select(x => x as IStoreItem)
+ .ToArray();
+
+ var idPrefix = string.Join("", _currentPathParts);
+ return (await dbClient.GetFilesByIdPrefix(idPrefix))
+ .Select(x => new DatabaseStoreIdFile(x, ctx, db, usenet, config))
+ .Select(x => x as IStoreItem)
+ .ToArray();
+ }
+
+ protected override Task<StoreItemResult> CreateItemAsync(CreateItemRequest request)
+ {
+ throw new InvalidOperationException("Files cannot be created.");
+ }
+
+ protected override Task<StoreCollectionResult> CreateCollectionAsync(CreateCollectionRequest request)
+ {
+ throw new InvalidOperationException("Directories cannot be created.");
+ }
+
+ protected override bool SupportsFastMove(SupportsFastMoveRequest request)
+ {
+ return false;
+ }
+
+ protected override Task<StoreItemResult> MoveItemAsync(MoveItemRequest request)
+ {
+ throw new InvalidOperationException("Files and Directories cannot be moved.");
+ }
+
+ protected override Task<DavStatusCode> DeleteItemAsync(DeleteItemRequest request)
+ {
+ throw new InvalidOperationException("Files and Directories cannot be deleted.");
+ }
+}
\ No newline at end of file