Add option to not remove private downloads from the download client (#45)

code/Infrastructure/Verticals/DownloadClient/BlockFilesResult.cs

@@ -0,0 +1,14 @@
+namespace Infrastructure.Verticals.DownloadClient;
+
+public sealed record BlockFilesResult
+{
+    /// <summary>
+    /// True if the download should be removed; otherwise false.
+    /// </summary>
+    public bool ShouldRemove { get; set; }
+    
+    /// <summary>
+    /// True if the download is private; otherwise false.
+    /// </summary>
+    public bool IsPrivate { get; set; }
+}

code/Infrastructure/Verticals/DownloadClient/Deluge/DelugeService.cs

@@ -35,12 +35,12 @@ public sealed class DelugeService : DownloadServiceBase
     }
 
     /// <inheritdoc/>
-    public override async Task<RemoveResult> ShouldRemoveFromArrQueueAsync(string hash)
+    public override async Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash)
     {
         hash = hash.ToLowerInvariant();
         
         DelugeContents? contents = null;
-        RemoveResult result = new();
+        StalledResult result = new();
 
         TorrentStatus? status = await GetTorrentStatus(hash);
         
@@ -76,7 +76,7 @@ public sealed class DelugeService : DownloadServiceBase
     }
 
     /// <inheritdoc/>
-    public override async Task<bool> BlockUnwantedFilesAsync(
+    public override async Task<BlockFilesResult> BlockUnwantedFilesAsync(
         string hash,
         BlocklistType blocklistType,
         ConcurrentBag<string> patterns,
@@ -86,18 +86,21 @@ public sealed class DelugeService : DownloadServiceBase
         hash = hash.ToLowerInvariant();
 
         TorrentStatus? status = await GetTorrentStatus(hash);
+        BlockFilesResult result = new();
         
         if (status?.Hash is null)
         {
             _logger.LogDebug("failed to find torrent {hash} in the download client", hash);
-            return false;
+            return result;
         }
+
+        result.IsPrivate = status.Private;
         
         if (_contentBlockerConfig.IgnorePrivate && status.Private)
         {
             // ignore private trackers
             _logger.LogDebug("skip files check | download is private | {name}", status.Name);
-            return false;
+            return result;
         }
         
         DelugeContents? contents = null;
@@ -113,7 +116,7 @@ public sealed class DelugeService : DownloadServiceBase
 
         if (contents is null)
         {
-            return false;
+            return result;
         }
         
         Dictionary<int, int> priorities = [];
@@ -144,7 +147,7 @@ public sealed class DelugeService : DownloadServiceBase
 
         if (!hasPriorityUpdates)
         {
-            return false;
+            return result;
         }
         
         _logger.LogDebug("changing priorities | torrent {hash}", hash);
@@ -157,12 +160,14 @@ public sealed class DelugeService : DownloadServiceBase
         if (totalUnwantedFiles == totalFiles)
         {
             // Skip marking files as unwanted. The download will be removed completely.
-            return true;
+            result.ShouldRemove = true;
+            
+            return result;
         }
 
         await _client.ChangeFilesPriority(hash, sortedPriorities);
 
-        return false;
+        return result;
     }
     
     /// <inheritdoc/>

code/Infrastructure/Verticals/DownloadClient/DownloadServiceBase.cs

@@ -37,10 +37,10 @@ public abstract class DownloadServiceBase : IDownloadService
 
     public abstract Task LoginAsync();
 
-    public abstract Task<RemoveResult> ShouldRemoveFromArrQueueAsync(string hash);
+    public abstract Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash);
 
     /// <inheritdoc/>
-    public abstract Task<bool> BlockUnwantedFilesAsync(
+    public abstract Task<BlockFilesResult> BlockUnwantedFilesAsync(
         string hash,
         BlocklistType blocklistType,
         ConcurrentBag<string> patterns,

code/Infrastructure/Verticals/DownloadClient/DummyDownloadService.cs

@@ -24,12 +24,12 @@ public sealed class DummyDownloadService : DownloadServiceBase
         return Task.CompletedTask;
     }
 
-    public override Task<RemoveResult> ShouldRemoveFromArrQueueAsync(string hash)
+    public override Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash)
     {
         throw new NotImplementedException();
     }
 
-    public override Task<bool> BlockUnwantedFilesAsync(string hash, BlocklistType blocklistType, ConcurrentBag<string> patterns, ConcurrentBag<Regex> regexes)
+    public override Task<BlockFilesResult> BlockUnwantedFilesAsync(string hash, BlocklistType blocklistType, ConcurrentBag<string> patterns, ConcurrentBag<Regex> regexes)
     {
         throw new NotImplementedException();
     }

code/Infrastructure/Verticals/DownloadClient/IDownloadService.cs

@@ -12,7 +12,7 @@ public interface IDownloadService : IDisposable
     /// Checks whether the download should be removed from the *arr queue.
     /// </summary>
     /// <param name="hash">The download hash.</param>
-    public Task<RemoveResult> ShouldRemoveFromArrQueueAsync(string hash);
+    public Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash);
 
     /// <summary>
     /// Blocks unwanted files from being fully downloaded.
@@ -22,7 +22,7 @@ public interface IDownloadService : IDisposable
     /// <param name="patterns">The patterns to test the files against.</param>
     /// <param name="regexes">The regexes to test the files against.</param>
     /// <returns>True if all files have been blocked; otherwise false.</returns>
-    public Task<bool> BlockUnwantedFilesAsync(
+    public Task<BlockFilesResult> BlockUnwantedFilesAsync(
         string hash,
         BlocklistType blocklistType,
         ConcurrentBag<string> patterns,

code/Infrastructure/Verticals/DownloadClient/QBittorrent/QBitService.cs

@@ -43,9 +43,9 @@ public sealed class QBitService : DownloadServiceBase
     }
 
     /// <inheritdoc/>
-    public override async Task<RemoveResult> ShouldRemoveFromArrQueueAsync(string hash)
+    public override async Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash)
     {
-        RemoveResult result = new();
+        StalledResult result = new();
         TorrentInfo? torrent = (await _client.GetTorrentListAsync(new TorrentListQuery { Hashes = [hash] }))
             .FirstOrDefault();
 
@@ -89,7 +89,7 @@ public sealed class QBitService : DownloadServiceBase
     }
 
     /// <inheritdoc/>
-    public override async Task<bool> BlockUnwantedFilesAsync(
+    public override async Task<BlockFilesResult> BlockUnwantedFilesAsync(
         string hash,
         BlocklistType blocklistType,
         ConcurrentBag<string> patterns,
@@ -98,11 +98,12 @@ public sealed class QBitService : DownloadServiceBase
     {
         TorrentInfo? torrent = (await _client.GetTorrentListAsync(new TorrentListQuery { Hashes = [hash] }))
             .FirstOrDefault();
+        BlockFilesResult result = new();
 
         if (torrent is null)
         {
             _logger.LogDebug("failed to find torrent {hash} in the download client", hash);
-            return false;
+            return result;
         }
         
         TorrentProperties? torrentProperties = await _client.GetTorrentPropertiesAsync(hash);
@@ -110,25 +111,27 @@ public sealed class QBitService : DownloadServiceBase
         if (torrentProperties is null)
         {
             _logger.LogDebug("failed to find torrent properties {hash} in the download client", hash);
-            return false;
+            return result;
         }
 
         bool isPrivate = torrentProperties.AdditionalData.TryGetValue("is_private", out var dictValue) &&
                          bool.TryParse(dictValue?.ToString(), out bool boolValue)
                          && boolValue;
 
+        result.IsPrivate = isPrivate;
+
         if (_contentBlockerConfig.IgnorePrivate && isPrivate)
         {
             // ignore private trackers
             _logger.LogDebug("skip files check | download is private | {name}", torrent.Name);
-            return false;
+            return result;
         }
         
         IReadOnlyList<TorrentContent>? files = await _client.GetTorrentContentsAsync(hash);
 
         if (files is null)
         {
-            return false;
+            return result;
         }
 
         List<int> unwantedFiles = [];
@@ -162,13 +165,15 @@ public sealed class QBitService : DownloadServiceBase
 
         if (unwantedFiles.Count is 0)
         {
-            return false;
+            return result;
         }
         
         if (totalUnwantedFiles == totalFiles)
         {
             // Skip marking files as unwanted. The download will be removed completely.
-            return true;
+            result.ShouldRemove = true;
+            
+            return result;
         }
 
         foreach (int fileIndex in unwantedFiles)
@@ -176,7 +181,7 @@ public sealed class QBitService : DownloadServiceBase
             await _client.SetFilePriorityAsync(hash, fileIndex, TorrentContentPriority.Skip);
         }
         
-        return false;
+        return result;
     }
 
     /// <inheritdoc/>

code/Infrastructure/Verticals/DownloadClient/StalledResult.cs

@@ -1,6 +1,6 @@
 namespace Infrastructure.Verticals.DownloadClient;
 
-public sealed record RemoveResult
+public sealed record StalledResult
 {
     /// <summary>
     /// True if the download should be removed; otherwise false.

code/Infrastructure/Verticals/DownloadClient/Transmission/TransmissionService.cs

@@ -46,9 +46,9 @@ public sealed class TransmissionService : DownloadServiceBase
     }
 
     /// <inheritdoc/>
-    public override async Task<RemoveResult> ShouldRemoveFromArrQueueAsync(string hash)
+    public override async Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash)
     {
-        RemoveResult result = new();
+        StalledResult result = new();
         TorrentInfo? torrent = await GetTorrentAsync(hash);
 
         if (torrent is null)
@@ -82,7 +82,7 @@ public sealed class TransmissionService : DownloadServiceBase
     }
 
     /// <inheritdoc/>
-    public override async Task<bool> BlockUnwantedFilesAsync(
+    public override async Task<BlockFilesResult> BlockUnwantedFilesAsync(
         string hash,
         BlocklistType blocklistType,
         ConcurrentBag<string> patterns,
@@ -90,17 +90,21 @@ public sealed class TransmissionService : DownloadServiceBase
     )
     {
         TorrentInfo? torrent = await GetTorrentAsync(hash);
+        BlockFilesResult result = new();
 
         if (torrent?.FileStats is null || torrent.Files is null)
         {
-            return false;
+            return result;
         }
+
+        bool isPrivate = torrent.IsPrivate ?? false;
+        result.IsPrivate = isPrivate;
         
-        if (_contentBlockerConfig.IgnorePrivate && (torrent.IsPrivate ?? false))
+        if (_contentBlockerConfig.IgnorePrivate && isPrivate)
         {
             // ignore private trackers
             _logger.LogDebug("skip files check | download is private | {name}", torrent.Name);
-            return false;
+            return result;
         }
 
         List<long> unwantedFiles = [];
@@ -134,13 +138,15 @@ public sealed class TransmissionService : DownloadServiceBase
 
         if (unwantedFiles.Count is 0)
         {
-            return false;
+            return result;
         }
 
         if (totalUnwantedFiles == totalFiles)
         {
             // Skip marking files as unwanted. The download will be removed completely.
-            return true;
+            result.ShouldRemove = true;
+            
+            return result;
         }
         
         _logger.LogDebug("changing priorities | torrent {hash}", hash);
@@ -151,7 +157,7 @@ public sealed class TransmissionService : DownloadServiceBase
             FilesUnwanted = unwantedFiles.ToArray(),
         });
 
-        return false;
+        return result;
     }
 
     public override async Task Delete(string hash)