Add option to ignore specific downloads (#79)

README.md

@@ -112,7 +112,7 @@ I've seen a few discussions on this type of naming and I've decided that I didn'
 ## Using cleanuperr's blocklist (works with all supported download clients)
 
 1. Set both `QUEUECLEANER__ENABLED` and `CONTENTBLOCKER__ENABLED` to `true` in your environment variables.
-2. Configure and enable either a **blacklist** or a **whitelist** as described in the [Arr variables](#Arr-variables) section.
+2. Configure and enable either a **blacklist** or a **whitelist** as described in the [Arr variables](variables.md#Arr-settings) section.
 3. Once configured, cleanuperr will perform the following tasks:
    - Execute the **content blocker** job, as explained in the [How it works](#how-it-works) section.
    - Execute the **queue cleaner** job, as explained in the [How it works](#how-it-works) section.
@@ -139,7 +139,9 @@ services:
     restart: unless-stopped
     volumes:
       - ./cleanuperr/logs:/var/logs
+      - ./cleanuperr/ignored.txt:/ignored.txt
     environment:
+      - TZ=America/New_York
       - DRY_RUN=false
 
       - LOGGING__LOGLEVEL=Information
@@ -152,6 +154,7 @@ services:
       - TRIGGERS__DOWNLOADCLEANER=0 0 * * * ?
 
       - QUEUECLEANER__ENABLED=true
+      - QUEUECLEANER__IGNORED_DOWNLOADS_PATH=/ignored.txt
       - QUEUECLEANER__RUNSEQUENTIALLY=true
       - QUEUECLEANER__IMPORT_FAILED_MAX_STRIKES=5
       - QUEUECLEANER__IMPORT_FAILED_IGNORE_PRIVATE=false
@@ -164,10 +167,12 @@ services:
       - QUEUECLEANER__STALLED_DELETE_PRIVATE=false
 
       - CONTENTBLOCKER__ENABLED=true
+      - CONTENTBLOCKER__IGNORED_DOWNLOADS_PATH=/ignored.txt
       - CONTENTBLOCKER__IGNORE_PRIVATE=false
       - CONTENTBLOCKER__DELETE_PRIVATE=false
 
       - DOWNLOADCLEANER__ENABLED=true
+      - DOWNLOADCLEANER__IGNORED_DOWNLOADS_PATH=/ignored.txt
       - DOWNLOADCLEANER__DELETE_PRIVATE=false
       - DOWNLOADCLEANER__CATEGORIES__0__NAME=tv-sonarr
       - DOWNLOADCLEANER__CATEGORIES__0__MAX_RATIO=-1

code/Common/Configuration/ContentBlocker/ContentBlockerConfig.cs

@@ -2,7 +2,7 @@
 
 namespace Common.Configuration.ContentBlocker;
 
-public sealed record ContentBlockerConfig : IJobConfig
+public sealed record ContentBlockerConfig : IJobConfig, IIgnoredDownloadsConfig
 {
     public const string SectionName = "ContentBlocker";
     
@@ -14,6 +14,9 @@ public sealed record ContentBlockerConfig : IJobConfig
     [ConfigurationKeyName("DELETE_PRIVATE")]
     public bool DeletePrivate { get; init; }
 
+    [ConfigurationKeyName("IGNORED_DOWNLOADS_PATH")]
+    public string? IgnoredDownloadsPath { get; init; }
+    
     public void Validate()
     {
     }

code/Common/Configuration/DownloadCleaner/DownloadCleanerConfig.cs

@@ -3,7 +3,7 @@ using Microsoft.Extensions.Configuration;
 
 namespace Common.Configuration.DownloadCleaner;
 
-public sealed record DownloadCleanerConfig : IJobConfig
+public sealed record DownloadCleanerConfig : IJobConfig, IIgnoredDownloadsConfig
 {
     public const string SectionName = "DownloadCleaner";
     
@@ -12,7 +12,10 @@ public sealed record DownloadCleanerConfig : IJobConfig
     public List<Category>? Categories { get; init; }
 
     [ConfigurationKeyName("DELETE_PRIVATE")]
-    public bool DeletePrivate { get; set; }
+    public bool DeletePrivate { get; init; }
+    
+    [ConfigurationKeyName("IGNORED_DOWNLOADS_PATH")]
+    public string? IgnoredDownloadsPath { get; init; }
 
     public void Validate()
     {

code/Common/Configuration/IIgnoredDownloadsConfig.cs

@@ -0,0 +1,6 @@
+namespace Common.Configuration;
+
+public interface IIgnoredDownloadsConfig
+{
+    string? IgnoredDownloadsPath { get; }
+}

code/Common/Configuration/QueueCleaner/QueueCleanerConfig.cs

@@ -2,7 +2,7 @@
 
 namespace Common.Configuration.QueueCleaner;
 
-public sealed record QueueCleanerConfig : IJobConfig
+public sealed record QueueCleanerConfig : IJobConfig, IIgnoredDownloadsConfig
 {
     public const string SectionName = "QueueCleaner";
     
@@ -10,6 +10,9 @@ public sealed record QueueCleanerConfig : IJobConfig
     
     public required bool RunSequentially { get; init; }
     
+    [ConfigurationKeyName("IGNORED_DOWNLOADS_PATH")]
+    public string? IgnoredDownloadsPath { get; init; }
+    
     [ConfigurationKeyName("IMPORT_FAILED_MAX_STRIKES")]
     public ushort ImportFailedMaxStrikes { get; init; }
     

code/Domain/Models/Deluge/Response/TorrentStatus.cs

@@ -23,4 +23,11 @@ public sealed record TorrentStatus
     public long SeedingTime { get; init; }
     
     public float Ratio { get; init; }
+    
+    public required IReadOnlyList<Tracker> Trackers { get; init; }
+}
+
+public sealed record Tracker
+{
+    public required Uri Url { get; init; }
 }

code/Executable/DependencyInjection/MainDI.cs

@@ -62,7 +62,7 @@ public static class MainDI
         services
             .AddHttpClient(nameof(DelugeService), x =>
             {
-                x.Timeout = TimeSpan.FromSeconds(5);
+                x.Timeout = TimeSpan.FromSeconds(config.Timeout);
             })
             .ConfigurePrimaryHttpMessageHandler(_ =>
             {

code/Executable/DependencyInjection/ServicesDI.cs

@@ -1,4 +1,8 @@
-using Infrastructure.Interceptors;
+using Common.Configuration.ContentBlocker;
+using Common.Configuration.DownloadCleaner;
+using Common.Configuration.QueueCleaner;
+using Infrastructure.Interceptors;
+using Infrastructure.Providers;
 using Infrastructure.Verticals.Arr;
 using Infrastructure.Verticals.ContentBlocker;
 using Infrastructure.Verticals.DownloadCleaner;
@@ -30,5 +34,8 @@ public static class ServicesDI
             .AddTransient<ArrQueueIterator>()
             .AddTransient<DownloadServiceFactory>()
             .AddSingleton<BlocklistProvider>()
-            .AddSingleton<IStriker, Striker>();
+            .AddSingleton<IStriker, Striker>()
+            .AddSingleton<IgnoredDownloadsProvider<QueueCleanerConfig>>()
+            .AddSingleton<IgnoredDownloadsProvider<ContentBlockerConfig>>()
+            .AddSingleton<IgnoredDownloadsProvider<DownloadCleanerConfig>>();
 }

code/Executable/HostExtensions.cs

@@ -0,0 +1,23 @@
+using System.Reflection;
+
+namespace Executable;
+
+public static class HostExtensions
+{
+    public static IHost Init(this IHost host)
+    {
+        ILogger<Program> logger = host.Services.GetRequiredService<ILogger<Program>>();
+
+        Version? version = Assembly.GetExecutingAssembly().GetName().Version;
+
+        logger.LogInformation(
+            version is null
+                ? "cleanuperr version not detected"
+                : $"cleanuperr v{version.Major}.{version.Minor}.{version.Build}"
+        );
+        
+        logger.LogInformation("timezone: {tz}", TimeZoneInfo.Local.DisplayName);
+        
+        return host;
+    }
+}

code/Executable/Program.cs

@@ -1,4 +1,4 @@
-using System.Reflection;
+using Executable;
 using Executable.DependencyInjection;
 
 var builder = Host.CreateApplicationBuilder(args);
@@ -7,15 +7,6 @@ builder.Services.AddInfrastructure(builder.Configuration);
 builder.Logging.AddLogging(builder.Configuration);
 
 var host = builder.Build();
-
+host.Init();
-var logger = host.Services.GetRequiredService<ILogger<Program>>();
-
-var version = Assembly.GetExecutingAssembly().GetName().Version;
-
-logger.LogInformation(
-    version is null
-        ? "cleanuperr version not detected"
-        : $"cleanuperr v{version.Major}.{version.Minor}.{version.Build}"
-);
 
 host.Run();

code/Executable/appsettings.Development.json

@@ -18,11 +18,13 @@
   "ContentBlocker": {
     "Enabled": true,
     "IGNORE_PRIVATE": true,
-    "DELETE_PRIVATE": false
+    "DELETE_PRIVATE": false,
+    "IGNORED_DOWNLOADS_PATH": "../test/data/cleanuperr/ignored_downloads"
   },
   "QueueCleaner": {
     "Enabled": true,
     "RunSequentially": true,
+    "IGNORED_DOWNLOADS_PATH": "../test/data/cleanuperr/ignored_downloads",
     "IMPORT_FAILED_MAX_STRIKES": 5,
     "IMPORT_FAILED_IGNORE_PRIVATE": true,
     "IMPORT_FAILED_DELETE_PRIVATE": false,
@@ -44,7 +46,8 @@
         "MIN_SEED_TIME": 0,
         "MAX_SEED_TIME": -1
       }
-    ]
+    ],
+    "IGNORED_DOWNLOADS_PATH": "../test/data/cleanuperr/ignored_downloads"
   },
   "DOWNLOAD_CLIENT": "qbittorrent",
   "qBittorrent": {

code/Executable/appsettings.json

@@ -17,11 +17,13 @@
   },
   "ContentBlocker": {
     "Enabled": false,
-    "IGNORE_PRIVATE": false
+    "IGNORE_PRIVATE": false,
+    "IGNORED_DOWNLOADS_PATH": ""
   },
   "QueueCleaner": {
     "Enabled": true,
     "RunSequentially": true,
+    "IGNORED_DOWNLOADS_PATH": "",
     "IMPORT_FAILED_MAX_STRIKES": 0,
     "IMPORT_FAILED_IGNORE_PRIVATE": false,
     "IMPORT_FAILED_DELETE_PRIVATE": false,
@@ -34,7 +36,8 @@
   "DownloadCleaner": {
     "Enabled": false,
     "DELETE_PRIVATE": false,
-    "CATEGORIES": []
+    "CATEGORIES": [],
+    "IGNORED_DOWNLOADS_PATH": ""
   },
   "DOWNLOAD_CLIENT": "none",
   "qBittorrent": {

code/Infrastructure.Tests/Verticals/DownloadClient/TestDownloadService.cs

@@ -35,12 +35,13 @@ public class TestDownloadService : DownloadService
 
     public override void Dispose() { }
     public override Task LoginAsync() => Task.CompletedTask;
-    public override Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash) => Task.FromResult(new StalledResult());
+    public override Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash, IReadOnlyList<string> ignoredDownloads) => Task.FromResult(new StalledResult());
     public override Task<BlockFilesResult> BlockUnwantedFilesAsync(string hash, BlocklistType blocklistType,
-        ConcurrentBag<string> patterns, ConcurrentBag<Regex> regexes) => Task.FromResult(new BlockFilesResult());
+        ConcurrentBag<string> patterns, ConcurrentBag<Regex> regexes, IReadOnlyList<string> ignoredDownloads) => Task.FromResult(new BlockFilesResult());
     public override Task DeleteDownload(string hash) => Task.CompletedTask;
     public override Task<List<object>?> GetAllDownloadsToBeCleaned(List<Category> categories) => Task.FromResult<List<object>?>(null);
-    public override Task CleanDownloads(List<object> downloads, List<Category> categoriesToClean, HashSet<string> excludedHashes) => Task.CompletedTask;
+    public override Task CleanDownloads(List<object> downloads, List<Category> categoriesToClean, HashSet<string> excludedHashes,
+        IReadOnlyList<string> ignoredDownloads) => Task.CompletedTask;
 
     // Expose protected methods for testing
     public new void ResetStrikesOnProgress(string hash, long downloaded) => base.ResetStrikesOnProgress(hash, downloaded);

code/Infrastructure/Extensions/DelugeExtensions.cs

@@ -0,0 +1,29 @@
+using Domain.Models.Deluge.Response;
+
+namespace Infrastructure.Extensions;
+
+public static class DelugeExtensions
+{
+    public static bool ShouldIgnore(this TorrentStatus download, IReadOnlyList<string> ignoredDownloads)
+    {
+        foreach (string value in ignoredDownloads)
+        {
+            if (download.Hash?.Equals(value, StringComparison.InvariantCultureIgnoreCase) ?? false)
+            {
+                return true;
+            }
+
+            if (download.Label?.Equals(value, StringComparison.InvariantCultureIgnoreCase) ?? false)
+            {
+                return true;
+            }
+            
+            if (download.Trackers.Any(x => x.Url.Host.EndsWith(value, StringComparison.InvariantCultureIgnoreCase)))
+            {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

code/Infrastructure/Extensions/QBitExtensions.cs

@@ -0,0 +1,42 @@
+using QBittorrent.Client;
+
+namespace Infrastructure.Extensions;
+
+public static class QBitExtensions
+{
+    public static bool ShouldIgnore(this TorrentInfo download, IReadOnlyList<string> ignoredDownloads)
+    {
+        foreach (string value in ignoredDownloads)
+        {
+            if (download.Hash.Equals(value, StringComparison.InvariantCultureIgnoreCase))
+            {
+                return true;
+            }
+            
+            if (download.Category.Equals(value, StringComparison.InvariantCultureIgnoreCase))
+            {
+                return true;
+            }
+
+            if (download.Tags.Contains(value, StringComparer.InvariantCultureIgnoreCase))
+            {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    public static bool ShouldIgnore(this TorrentTracker tracker, IReadOnlyList<string> ignoredDownloads)
+    {
+        foreach (string value in ignoredDownloads)
+        {
+            if (tracker.Url.Host.EndsWith(value, StringComparison.InvariantCultureIgnoreCase))
+            {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

code/Infrastructure/Extensions/TransmissionExtensions.cs

@@ -0,0 +1,42 @@
+using Transmission.API.RPC.Entity;
+
+namespace Infrastructure.Extensions;
+
+public static class TransmissionExtensions
+{
+    public static bool ShouldIgnore(this TorrentInfo download, IReadOnlyList<string> ignoredDownloads)
+    {
+        foreach (string value in ignoredDownloads)
+        {
+            if (download.HashString?.Equals(value, StringComparison.InvariantCultureIgnoreCase) ?? false)
+            {
+                return true;
+            }
+
+            if (download.GetCategory().Equals(value, StringComparison.InvariantCultureIgnoreCase))
+            {
+                return true;
+            }
+
+            bool? hasIgnoredTracker = download.Trackers?
+                .Any(x => new Uri(x.Announce!).Host.EndsWith(value, StringComparison.InvariantCultureIgnoreCase));
+            
+            if (hasIgnoredTracker is true)
+            {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    public static string GetCategory(this TorrentInfo download)
+    {
+        if (string.IsNullOrEmpty(download.DownloadDir))
+        {
+            return string.Empty;
+        }
+
+        return Path.GetFileName(Path.TrimEndingDirectorySeparator(download.DownloadDir));
+    }
+}

code/Infrastructure/Helpers/CacheKeys.cs

@@ -11,4 +11,6 @@ public static class CacheKeys
     public static string BlocklistRegexes(InstanceType instanceType) => $"{instanceType.ToString()}_regexes";
     
     public static string Item(string hash) => $"item_{hash}";
+    
+    public static string IgnoredDownloads(string name) => $"{name}_ignored";
 }

code/Infrastructure/Providers/IgnoredDownloadsProvider.cs

@@ -0,0 +1,82 @@
+using Common.Configuration;
+using Infrastructure.Helpers;
+using Microsoft.Extensions.Caching.Memory;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+
+namespace Infrastructure.Providers;
+
+public sealed class IgnoredDownloadsProvider<T>
+    where T : IIgnoredDownloadsConfig
+{
+    private readonly ILogger<IgnoredDownloadsProvider<T>> _logger;
+    private IIgnoredDownloadsConfig _config;
+    private readonly IMemoryCache _cache;
+    private DateTime _lastModified = DateTime.MinValue;
+
+    public IgnoredDownloadsProvider(ILogger<IgnoredDownloadsProvider<T>> logger, IOptionsMonitor<T> config, IMemoryCache cache)
+    {
+        _config = config.CurrentValue;
+        config.OnChange((newValue) => _config = newValue);
+        _logger = logger;
+        _cache = cache;
+
+        if (string.IsNullOrEmpty(_config.IgnoredDownloadsPath))
+        {
+            return;
+        }
+
+        if (!File.Exists(_config.IgnoredDownloadsPath))
+        {
+            throw new FileNotFoundException("file not found", _config.IgnoredDownloadsPath);
+        }
+    }
+
+    public async Task<IReadOnlyList<string>> GetIgnoredDownloads()
+    {
+        if (string.IsNullOrEmpty(_config.IgnoredDownloadsPath))
+        {
+            return Array.Empty<string>();
+        }
+
+        FileInfo fileInfo = new(_config.IgnoredDownloadsPath);
+        
+        if (fileInfo.LastWriteTime > _lastModified ||
+            !_cache.TryGetValue(CacheKeys.IgnoredDownloads(typeof(T).Name), out IReadOnlyList<string>? ignoredDownloads) ||
+            ignoredDownloads is null)
+        {
+            _lastModified = fileInfo.LastWriteTime;
+
+            return await LoadFile();
+        }
+        
+        return ignoredDownloads;
+    }
+
+    private async Task<IReadOnlyList<string>> LoadFile()
+    {
+        try
+        {
+            if (string.IsNullOrEmpty(_config.IgnoredDownloadsPath))
+            {
+                return Array.Empty<string>();
+            }
+
+            string[] ignoredDownloads = (await File.ReadAllLinesAsync(_config.IgnoredDownloadsPath))
+                .Where(x => !string.IsNullOrWhiteSpace(x))
+                .ToArray();
+
+            _cache.Set(CacheKeys.IgnoredDownloads(typeof(T).Name), ignoredDownloads);
+
+            _logger.LogInformation("ignored downloads reloaded");
+
+            return ignoredDownloads;
+        }
+        catch (Exception exception)
+        {
+            _logger.LogError(exception, "error while reading ignored downloads file | {file}", _config.IgnoredDownloadsPath);
+        }
+
+        return Array.Empty<string>();
+    }
+}

code/Infrastructure/Verticals/ContentBlocker/ContentBlocker.cs

@@ -6,6 +6,7 @@ using Common.Configuration.DownloadClient;
 using Domain.Enums;
 using Domain.Models.Arr;
 using Domain.Models.Arr.Queue;
+using Infrastructure.Providers;
 using Infrastructure.Verticals.Arr;
 using Infrastructure.Verticals.Arr.Interfaces;
 using Infrastructure.Verticals.Context;
@@ -22,6 +23,7 @@ public sealed class ContentBlocker : GenericHandler
 {
     private readonly ContentBlockerConfig _config;
     private readonly BlocklistProvider _blocklistProvider;
+    private readonly IgnoredDownloadsProvider<ContentBlockerConfig> _ignoredDownloadsProvider;
 
     public ContentBlocker(
         ILogger<ContentBlocker> logger,
@@ -36,7 +38,8 @@ public sealed class ContentBlocker : GenericHandler
         ArrQueueIterator arrArrQueueIterator,
         BlocklistProvider blocklistProvider,
         DownloadServiceFactory downloadServiceFactory,
-        INotificationPublisher notifier
+        INotificationPublisher notifier,
+        IgnoredDownloadsProvider<ContentBlockerConfig> ignoredDownloadsProvider
     ) : base(
         logger, downloadClientConfig,
         sonarrConfig, radarrConfig, lidarrConfig,
@@ -47,6 +50,7 @@ public sealed class ContentBlocker : GenericHandler
     {
         _config = config.Value;
         _blocklistProvider = blocklistProvider;
+        _ignoredDownloadsProvider = ignoredDownloadsProvider;
     }
 
     public override async Task ExecuteAsync()
@@ -73,6 +77,8 @@ public sealed class ContentBlocker : GenericHandler
 
     protected override async Task ProcessInstanceAsync(ArrInstance instance, InstanceType instanceType)
     {
+        IReadOnlyList<string> ignoredDownloads = await _ignoredDownloadsProvider.GetIgnoredDownloads();
+        
         using var _ = LogContext.PushProperty("InstanceName", instanceType.ToString());
 
         HashSet<SearchItem> itemsToBeRefreshed = [];
@@ -106,13 +112,19 @@ public sealed class ContentBlocker : GenericHandler
                     continue;
                 }
                 
+                if (ignoredDownloads.Contains(record.DownloadId, StringComparer.InvariantCultureIgnoreCase))
+                {
+                    _logger.LogInformation("skip | {title} | ignored", record.Title);
+                    continue;
+                }
+                
                 // push record to context
                 ContextProvider.Set(nameof(QueueRecord), record);
                 
                 _logger.LogDebug("searching unwanted files for {title}", record.Title);
 
                 BlockFilesResult result = await _downloadService
-                    .BlockUnwantedFilesAsync(record.DownloadId, blocklistType, patterns, regexes);
+                    .BlockUnwantedFilesAsync(record.DownloadId, blocklistType, patterns, regexes, ignoredDownloads);
                 
                 if (!result.ShouldRemove)
                 {

code/Infrastructure/Verticals/DownloadCleaner/DownloadCleaner.cs

@@ -3,6 +3,7 @@ using Common.Configuration.DownloadCleaner;
 using Common.Configuration.DownloadClient;
 using Domain.Enums;
 using Domain.Models.Arr.Queue;
+using Infrastructure.Providers;
 using Infrastructure.Verticals.Arr;
 using Infrastructure.Verticals.Arr.Interfaces;
 using Infrastructure.Verticals.DownloadClient;
@@ -17,6 +18,7 @@ namespace Infrastructure.Verticals.DownloadCleaner;
 public sealed class DownloadCleaner : GenericHandler
 {
     private readonly DownloadCleanerConfig _config;
+    private readonly IgnoredDownloadsProvider<DownloadCleanerConfig> _ignoredDownloadsProvider;
     private readonly HashSet<string> _excludedHashes = [];
     
     public DownloadCleaner(
@@ -31,7 +33,8 @@ public sealed class DownloadCleaner : GenericHandler
         LidarrClient lidarrClient,
         ArrQueueIterator arrArrQueueIterator,
         DownloadServiceFactory downloadServiceFactory,
-        INotificationPublisher notifier
+        INotificationPublisher notifier,
+        IgnoredDownloadsProvider<DownloadCleanerConfig> ignoredDownloadsProvider
     ) : base(
         logger, downloadClientConfig,
         sonarrConfig, radarrConfig, lidarrConfig,
@@ -42,6 +45,7 @@ public sealed class DownloadCleaner : GenericHandler
     {
         _config = config.Value;
         _config.Validate();
+        _ignoredDownloadsProvider = ignoredDownloadsProvider;
     }
     
     public override async Task ExecuteAsync()
@@ -58,6 +62,8 @@ public sealed class DownloadCleaner : GenericHandler
             return;
         }
         
+        IReadOnlyList<string> ignoredDownloads = await _ignoredDownloadsProvider.GetIgnoredDownloads();
+        
         await _downloadService.LoginAsync();
 
         List<object>? downloads = await _downloadService.GetAllDownloadsToBeCleaned(_config.Categories);
@@ -75,7 +81,7 @@ public sealed class DownloadCleaner : GenericHandler
         await ProcessArrConfigAsync(_radarrConfig, InstanceType.Radarr, true);
         await ProcessArrConfigAsync(_lidarrConfig, InstanceType.Lidarr, true);
         
-        await _downloadService.CleanDownloads(downloads, _config.Categories, _excludedHashes);
+        await _downloadService.CleanDownloads(downloads, _config.Categories, _excludedHashes, ignoredDownloads);
     }
 
     protected override async Task ProcessInstanceAsync(ArrInstance instance, InstanceType instanceType)

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

@@ -16,6 +16,20 @@ public sealed class DelugeClient
     private readonly DelugeConfig _config;
     private readonly HttpClient _httpClient;
     
+    private static readonly IReadOnlyList<string> Fields =
+    [
+        "hash",
+        "state",
+        "name",
+        "eta",
+        "private",
+        "total_done",
+        "label",
+        "seeding_time",
+        "ratio",
+        "trackers"
+    ];
+    
     public DelugeClient(IOptions<DelugeConfig> config, IHttpClientFactory httpClientFactory)
     {
         _config = config.Value;
@@ -68,7 +82,7 @@ public sealed class DelugeClient
         return await SendRequest<TorrentStatus?>(
             "web.get_torrent_status",
             hash,
-            new[] { "hash", "state", "name", "eta", "private", "total_done", "label", "seeding_time", "ratio" }
+            Fields
         );
     }
     
@@ -77,7 +91,7 @@ public sealed class DelugeClient
         Dictionary<string, TorrentStatus>? downloads = await SendRequest<Dictionary<string, TorrentStatus>?>(
             "core.get_torrents_status",
             "",
-            new[] { "hash", "state", "name", "eta", "private", "total_done", "label", "seeding_time", "ratio" }
+            Fields
         );
         
         return downloads?.Values.ToList();

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

@@ -7,6 +7,7 @@ using Common.Configuration.DownloadClient;
 using Common.Configuration.QueueCleaner;
 using Domain.Enums;
 using Domain.Models.Deluge.Response;
+using Infrastructure.Extensions;
 using Infrastructure.Interceptors;
 using Infrastructure.Verticals.ContentBlocker;
 using Infrastructure.Verticals.Context;
@@ -49,21 +50,27 @@ public class DelugeService : DownloadService, IDelugeService
     }
 
     /// <inheritdoc/>
-    public override async Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash)
+    public override async Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash, IReadOnlyList<string> ignoredDownloads)
     {
         hash = hash.ToLowerInvariant();
         
         DelugeContents? contents = null;
         StalledResult result = new();
 
-        TorrentStatus? status = await _client.GetTorrentStatus(hash);
+        TorrentStatus? download = await _client.GetTorrentStatus(hash);
         
-        if (status?.Hash is null)
+        if (download?.Hash is null)
         {
             _logger.LogDebug("failed to find torrent {hash} in the download client", hash);
             return result;
         }
         
+        if (ignoredDownloads.Count > 0 && download.ShouldIgnore(ignoredDownloads))
+        {
+            _logger.LogInformation("skip | download is ignored | {name}", download.Name);
+            return result;
+        }
+
         try
         {
             contents = await _client.GetTorrentFiles(hash);
@@ -88,8 +95,8 @@ public class DelugeService : DownloadService, IDelugeService
             result.DeleteReason = DeleteReason.AllFilesBlocked;
         }
         
-        result.ShouldRemove = shouldRemove || await IsItemStuckAndShouldRemove(status);
+        result.ShouldRemove = shouldRemove || await IsItemStuckAndShouldRemove(download);
-        result.IsPrivate = status.Private;
+        result.IsPrivate = download.Private;
 
         if (!shouldRemove && result.ShouldRemove)
         {
@@ -100,30 +107,37 @@ public class DelugeService : DownloadService, IDelugeService
     }
 
     /// <inheritdoc/>
-    public override async Task<BlockFilesResult> BlockUnwantedFilesAsync(
+    public override async Task<BlockFilesResult> BlockUnwantedFilesAsync(string hash,
-        string hash,
         BlocklistType blocklistType,
         ConcurrentBag<string> patterns,
-        ConcurrentBag<Regex> regexes
+        ConcurrentBag<Regex> regexes, IReadOnlyList<string> ignoredDownloads)
-    )
     {
         hash = hash.ToLowerInvariant();
 
-        TorrentStatus? status = await _client.GetTorrentStatus(hash);
+        TorrentStatus? download = await _client.GetTorrentStatus(hash);
         BlockFilesResult result = new();
         
-        if (status?.Hash is null)
+        if (download?.Hash is null)
         {
             _logger.LogDebug("failed to find torrent {hash} in the download client", hash);
             return result;
         }
         
-        result.IsPrivate = status.Private;
+        var ceva = await _client.GetTorrentExtended(hash);
         
-        if (_contentBlockerConfig.IgnorePrivate && status.Private)
+        
+        if (ignoredDownloads.Count > 0 && download.ShouldIgnore(ignoredDownloads))
+        {
+            _logger.LogInformation("skip | download is ignored | {name}", download.Name);
+            return result;
+        }
+
+        result.IsPrivate = download.Private;
+        
+        if (_contentBlockerConfig.IgnorePrivate && download.Private)
         {
             // ignore private trackers
-            _logger.LogDebug("skip files check | download is private | {name}", status.Name);
+            _logger.LogDebug("skip files check | download is private | {name}", download.Name);
             return result;
         }
         
@@ -205,7 +219,8 @@ public class DelugeService : DownloadService, IDelugeService
     }
 
     /// <inheritdoc/>
-    public override async Task CleanDownloads(List<object> downloads, List<Category> categoriesToClean, HashSet<string> excludedHashes)
+    public override async Task CleanDownloads(List<object> downloads, List<Category> categoriesToClean, HashSet<string> excludedHashes,
+        IReadOnlyList<string> ignoredDownloads)
     {
         foreach (TorrentStatus download in downloads)
         {
@@ -214,6 +229,12 @@ public class DelugeService : DownloadService, IDelugeService
                 continue;
             }
 
+            if (ignoredDownloads.Count > 0 && download.ShouldIgnore(ignoredDownloads))
+            {
+                _logger.LogInformation("skip | download is ignored | {name}", download.Name);
+                continue;
+            }
+            
             Category? category = categoriesToClean
                 .FirstOrDefault(x => x.Name.Equals(download.Label, StringComparison.InvariantCultureIgnoreCase));
 

code/Infrastructure/Verticals/DownloadClient/DownloadService.cs

@@ -60,15 +60,13 @@ public abstract class DownloadService : IDownloadService
 
     public abstract Task LoginAsync();
 
-    public abstract Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash);
+    public abstract Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash, IReadOnlyList<string> ignoredDownloads);
 
     /// <inheritdoc/>
-    public abstract Task<BlockFilesResult> BlockUnwantedFilesAsync(
+    public abstract Task<BlockFilesResult> BlockUnwantedFilesAsync(string hash,
-        string hash,
         BlocklistType blocklistType,
         ConcurrentBag<string> patterns,
-        ConcurrentBag<Regex> regexes
+        ConcurrentBag<Regex> regexes, IReadOnlyList<string> ignoredDownloads);
-    );
 
     /// <inheritdoc/>
     public abstract Task DeleteDownload(string hash);
@@ -77,7 +75,8 @@ public abstract class DownloadService : IDownloadService
     public abstract Task<List<object>?> GetAllDownloadsToBeCleaned(List<Category> categories);
 
     /// <inheritdoc/>
-    public abstract Task CleanDownloads(List<object> downloads, List<Category> categoriesToClean, HashSet<string> excludedHashes);
+    public abstract Task CleanDownloads(List<object> downloads, List<Category> categoriesToClean, HashSet<string> excludedHashes,
+        IReadOnlyList<string> ignoredDownloads);
 
     protected void ResetStrikesOnProgress(string hash, long downloaded)
     {

code/Infrastructure/Verticals/DownloadClient/DummyDownloadService.cs

@@ -28,12 +28,13 @@ public class DummyDownloadService : DownloadService
         return Task.CompletedTask;
     }
 
-    public override Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash)
+    public override Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash, IReadOnlyList<string> ignoredDownloads)
     {
         throw new NotImplementedException();
     }
 
-    public override Task<BlockFilesResult> 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, IReadOnlyList<string> ignoredDownloads)
     {
         throw new NotImplementedException();
     }
@@ -43,7 +44,8 @@ public class DummyDownloadService : DownloadService
         throw new NotImplementedException();
     }
 
-    public override Task CleanDownloads(List<object> downloads, List<Category> categoriesToClean, HashSet<string> excludedHashes)
+    public override Task CleanDownloads(List<object> downloads, List<Category> categoriesToClean, HashSet<string> excludedHashes,
+        IReadOnlyList<string> ignoredDownloads)
     {
         throw new NotImplementedException();
     }

code/Infrastructure/Verticals/DownloadClient/IDownloadService.cs

@@ -14,7 +14,8 @@ 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<StalledResult> ShouldRemoveFromArrQueueAsync(string hash);
+    /// <param name="ignoredDownloads">Downloads to ignore from processing.</param>
+    public Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash, IReadOnlyList<string> ignoredDownloads);
 
     /// <summary>
     /// Blocks unwanted files from being fully downloaded.
@@ -23,12 +24,13 @@ public interface IDownloadService : IDisposable
     /// <param name="blocklistType">The <see cref="BlocklistType"/>.</param>
     /// <param name="patterns">The patterns to test the files against.</param>
     /// <param name="regexes">The regexes to test the files against.</param>
+    /// <param name="ignoredDownloads">Downloads to ignore from processing.</param>
     /// <returns>True if all files have been blocked; otherwise false.</returns>
-    public Task<BlockFilesResult> BlockUnwantedFilesAsync(
+    public Task<BlockFilesResult> BlockUnwantedFilesAsync(string hash,
-        string hash,
         BlocklistType blocklistType,
         ConcurrentBag<string> patterns,
-        ConcurrentBag<Regex> regexes
+        ConcurrentBag<Regex> regexes,
+        IReadOnlyList<string> ignoredDownloads
     );
 
     /// <summary>
@@ -44,7 +46,9 @@ public interface IDownloadService : IDisposable
     /// <param name="downloads"></param>
     /// <param name="categoriesToClean">The categories that should be cleaned.</param>
     /// <param name="excludedHashes">The hashes that should not be cleaned.</param>
-    public abstract Task CleanDownloads(List<object> downloads, List<Category> categoriesToClean, HashSet<string> excludedHashes);
+    /// <param name="ignoredDownloads">Downloads to ignore from processing.</param>
+    public abstract Task CleanDownloads(List<object> downloads, List<Category> categoriesToClean, HashSet<string> excludedHashes,
+        IReadOnlyList<string> ignoredDownloads);
 
     /// <summary>
     /// Deletes a download item.

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

@@ -7,6 +7,7 @@ using Common.Configuration.DownloadClient;
 using Common.Configuration.QueueCleaner;
 using Common.Helpers;
 using Domain.Enums;
+using Infrastructure.Extensions;
 using Infrastructure.Interceptors;
 using Infrastructure.Verticals.ContentBlocker;
 using Infrastructure.Verticals.Context;
@@ -58,18 +59,27 @@ public class QBitService : DownloadService, IQBitService
     }
 
     /// <inheritdoc/>
-    public override async Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash)
+    public override async Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash, IReadOnlyList<string> ignoredDownloads)
     {
         StalledResult result = new();
-        TorrentInfo? torrent = (await _client.GetTorrentListAsync(new TorrentListQuery { Hashes = [hash] }))
+        TorrentInfo? download = (await _client.GetTorrentListAsync(new TorrentListQuery { Hashes = [hash] }))
             .FirstOrDefault();
 
-        if (torrent is null)
+        if (download is null)
         {
             _logger.LogDebug("failed to find torrent {hash} in the download client", hash);
             return result;
         }
 
+        IReadOnlyList<TorrentTracker> trackers = await GetTrackersAsync(hash);
+        
+        if (ignoredDownloads.Count > 0 &&
+            (download.ShouldIgnore(ignoredDownloads) || trackers.Any(x => x.ShouldIgnore(ignoredDownloads)) is true))
+        {
+            _logger.LogInformation("skip | download is ignored | {name}", download.Name);
+            return result;
+        }
+
         TorrentProperties? torrentProperties = await _client.GetTorrentPropertiesAsync(hash);
 
         if (torrentProperties is null)
@@ -83,7 +93,7 @@ public class QBitService : DownloadService, IQBitService
                            && boolValue;
 
         // if all files were blocked by qBittorrent
-        if (torrent is { CompletionOn: not null, Downloaded: null or 0 })
+        if (download is { CompletionOn: not null, Downloaded: null or 0 })
         {
             result.ShouldRemove = true;
             result.DeleteReason = DeleteReason.AllFilesBlocked;
@@ -100,7 +110,7 @@ public class QBitService : DownloadService, IQBitService
             return result;
         }
 
-        result.ShouldRemove = await IsItemStuckAndShouldRemove(torrent, result.IsPrivate);
+        result.ShouldRemove = await IsItemStuckAndShouldRemove(download, result.IsPrivate);
 
         if (result.ShouldRemove)
         {
@@ -111,23 +121,32 @@ public class QBitService : DownloadService, IQBitService
     }
 
     /// <inheritdoc/>
-    public override async Task<BlockFilesResult> BlockUnwantedFilesAsync(
+    public override async Task<BlockFilesResult> BlockUnwantedFilesAsync(string hash,
-        string hash,
         BlocklistType blocklistType,
         ConcurrentBag<string> patterns,
-        ConcurrentBag<Regex> regexes
+        ConcurrentBag<Regex> regexes,
+        IReadOnlyList<string> ignoredDownloads
     )
     {
-        TorrentInfo? torrent = (await _client.GetTorrentListAsync(new TorrentListQuery { Hashes = [hash] }))
+        TorrentInfo? download = (await _client.GetTorrentListAsync(new TorrentListQuery { Hashes = [hash] }))
             .FirstOrDefault();
         BlockFilesResult result = new();
 
-        if (torrent is null)
+        if (download is null)
         {
             _logger.LogDebug("failed to find torrent {hash} in the download client", hash);
             return result;
         }
         
+        IReadOnlyList<TorrentTracker> trackers = await GetTrackersAsync(hash);
+        
+        if (ignoredDownloads.Count > 0 &&
+            (download.ShouldIgnore(ignoredDownloads) || trackers.Any(x => x.ShouldIgnore(ignoredDownloads)) is true))
+        {
+            _logger.LogInformation("skip | download is ignored | {name}", download.Name);
+            return result;
+        }
+        
         TorrentProperties? torrentProperties = await _client.GetTorrentPropertiesAsync(hash);
 
         if (torrentProperties is null)
@@ -145,7 +164,7 @@ public class QBitService : DownloadService, IQBitService
         if (_contentBlockerConfig.IgnorePrivate && isPrivate)
         {
             // ignore private trackers
-            _logger.LogDebug("skip files check | download is private | {name}", torrent.Name);
+            _logger.LogDebug("skip files check | download is private | {name}", download.Name);
             return result;
         }
         
@@ -218,7 +237,8 @@ public class QBitService : DownloadService, IQBitService
         .ToList();
 
     /// <inheritdoc/>
-    public override async Task CleanDownloads(List<object> downloads, List<Category> categoriesToClean, HashSet<string> excludedHashes)
+    public override async Task CleanDownloads(List<object> downloads, List<Category> categoriesToClean, HashSet<string> excludedHashes,
+        IReadOnlyList<string> ignoredDownloads)
     {
         foreach (TorrentInfo download in downloads)
         {
@@ -227,6 +247,15 @@ public class QBitService : DownloadService, IQBitService
                 continue;
             }
             
+            IReadOnlyList<TorrentTracker> trackers = await GetTrackersAsync(download.Hash);
+
+            if (ignoredDownloads.Count > 0 &&
+                (download.ShouldIgnore(ignoredDownloads) || trackers.Any(x => x.ShouldIgnore(ignoredDownloads)) is true))
+            {
+                _logger.LogInformation("skip | download is ignored | {name}", download.Name);
+                continue;
+            }
+            
             Category? category = categoriesToClean
                 .FirstOrDefault(x => download.Category.Equals(x.Name, StringComparison.InvariantCultureIgnoreCase));
             
@@ -329,4 +358,11 @@ public class QBitService : DownloadService, IQBitService
 
         return await StrikeAndCheckLimit(torrent.Hash, torrent.Name);
     }
+
+    private async Task<IReadOnlyList<TorrentTracker>> GetTrackersAsync(string hash)
+    {
+        return (await _client.GetTorrentTrackersAsync(hash))
+            .Where(x => !x.Url.ToString().Contains("**"))
+            .ToList();
+    }
 }

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

@@ -7,6 +7,7 @@ using Common.Configuration.DownloadClient;
 using Common.Configuration.QueueCleaner;
 using Common.Helpers;
 using Domain.Enums;
+using Infrastructure.Extensions;
 using Infrastructure.Interceptors;
 using Infrastructure.Verticals.ContentBlocker;
 using Infrastructure.Verticals.Context;
@@ -27,6 +28,23 @@ public class TransmissionService : DownloadService, ITransmissionService
     private readonly Client _client;
     private TorrentInfo[]? _torrentsCache;
 
+    private static readonly string[] Fields =
+    [
+        TorrentFields.FILES,
+        TorrentFields.FILE_STATS,
+        TorrentFields.HASH_STRING,
+        TorrentFields.ID,
+        TorrentFields.ETA,
+        TorrentFields.NAME,
+        TorrentFields.STATUS,
+        TorrentFields.IS_PRIVATE,
+        TorrentFields.DOWNLOADED_EVER,
+        TorrentFields.DOWNLOAD_DIR,
+        TorrentFields.SECONDS_SEEDING,
+        TorrentFields.UPLOAD_RATIO,
+        TorrentFields.TRACKERS
+    ];
+
     public TransmissionService(
         IHttpClientFactory httpClientFactory,
         ILogger<TransmissionService> logger,
@@ -60,21 +78,27 @@ public class TransmissionService : DownloadService, ITransmissionService
     }
 
     /// <inheritdoc/>
-    public override async Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash)
+    public override async Task<StalledResult> ShouldRemoveFromArrQueueAsync(string hash, IReadOnlyList<string> ignoredDownloads)
     {
         StalledResult result = new();
-        TorrentInfo? torrent = await GetTorrentAsync(hash);
+        TorrentInfo? download = await GetTorrentAsync(hash);
 
-        if (torrent is null)
+        if (download is null)
         {
             _logger.LogDebug("failed to find torrent {hash} in the download client", hash);
             return result;
         }
         
-        bool shouldRemove = torrent.FileStats?.Length > 0;
+        if (ignoredDownloads.Count > 0 && download.ShouldIgnore(ignoredDownloads))
-        result.IsPrivate = torrent.IsPrivate ?? false;
+        {
+            _logger.LogDebug("skip | download is ignored | {name}", download.Name);
+            return result;
+        }
         
-        foreach (TransmissionTorrentFileStats? stats in torrent.FileStats ?? [])
+        bool shouldRemove = download.FileStats?.Length > 0;
+        result.IsPrivate = download.IsPrivate ?? false;
+
+        foreach (TransmissionTorrentFileStats? stats in download.FileStats ?? [])
         {
             if (!stats.Wanted.HasValue)
             {
@@ -95,7 +119,7 @@ public class TransmissionService : DownloadService, ITransmissionService
         }
 
         // remove if all files are unwanted or download is stuck
-        result.ShouldRemove = shouldRemove || await IsItemStuckAndShouldRemove(torrent);
+        result.ShouldRemove = shouldRemove || await IsItemStuckAndShouldRemove(download);
 
         if (!shouldRemove && result.ShouldRemove)
         {
@@ -106,28 +130,32 @@ public class TransmissionService : DownloadService, ITransmissionService
     }
 
     /// <inheritdoc/>
-    public override async Task<BlockFilesResult> BlockUnwantedFilesAsync(
+    public override async Task<BlockFilesResult> BlockUnwantedFilesAsync(string hash,
-        string hash,
         BlocklistType blocklistType,
         ConcurrentBag<string> patterns,
-        ConcurrentBag<Regex> regexes
+        ConcurrentBag<Regex> regexes, IReadOnlyList<string> ignoredDownloads)
-    )
     {
-        TorrentInfo? torrent = await GetTorrentAsync(hash);
+        TorrentInfo? download = await GetTorrentAsync(hash);
         BlockFilesResult result = new();
 
-        if (torrent?.FileStats is null || torrent.Files is null)
+        if (download?.FileStats is null || download.Files is null)
         {
             return result;
         }
         
-        bool isPrivate = torrent.IsPrivate ?? false;
+        if (ignoredDownloads.Count > 0 && download.ShouldIgnore(ignoredDownloads))
+        {
+            _logger.LogDebug("skip | download is ignored | {name}", download.Name);
+            return result;
+        }
+
+        bool isPrivate = download.IsPrivate ?? false;
         result.IsPrivate = isPrivate;
         
         if (_contentBlockerConfig.IgnorePrivate && isPrivate)
         {
             // ignore private trackers
-            _logger.LogDebug("skip files check | download is private | {name}", torrent.Name);
+            _logger.LogDebug("skip files check | download is private | {name}", download.Name);
             return result;
         }
 
@@ -135,27 +163,27 @@ public class TransmissionService : DownloadService, ITransmissionService
         long totalFiles = 0;
         long totalUnwantedFiles = 0;
         
-        for (int i = 0; i < torrent.Files.Length; i++)
+        for (int i = 0; i < download.Files.Length; i++)
         {
-            if (torrent.FileStats?[i].Wanted == null)
+            if (download.FileStats?[i].Wanted == null)
             {
                 continue;
             }
 
             totalFiles++;
             
-            if (!torrent.FileStats[i].Wanted.Value)
+            if (!download.FileStats[i].Wanted.Value)
             {
                 totalUnwantedFiles++;
                 continue;
             }
 
-            if (_filenameEvaluator.IsValid(torrent.Files[i].Name, blocklistType, patterns, regexes))
+            if (_filenameEvaluator.IsValid(download.Files[i].Name, blocklistType, patterns, regexes))
             {
                 continue;
             }
             
-            _logger.LogInformation("unwanted file found | {file}", torrent.Files[i].Name);
+            _logger.LogInformation("unwanted file found | {file}", download.Files[i].Name);
             unwantedFiles.Add(i);
             totalUnwantedFiles++;
         }
@@ -175,7 +203,7 @@ public class TransmissionService : DownloadService, ITransmissionService
         
         _logger.LogDebug("changing priorities | torrent {hash}", hash);
 
-        await _dryRunInterceptor.InterceptAsync(SetUnwantedFiles, torrent.Id, unwantedFiles.ToArray());
+        await _dryRunInterceptor.InterceptAsync(SetUnwantedFiles, download.Id, unwantedFiles.ToArray());
 
         return result;
     }
@@ -183,22 +211,7 @@ public class TransmissionService : DownloadService, ITransmissionService
     /// <inheritdoc/>
     public override async Task<List<object>?> GetAllDownloadsToBeCleaned(List<Category> categories)
     {
-        string[] fields = [
+        return (await _client.TorrentGetAsync(Fields))
-            TorrentFields.FILES,
-            TorrentFields.FILE_STATS,
-            TorrentFields.HASH_STRING,
-            TorrentFields.ID,
-            TorrentFields.ETA,
-            TorrentFields.NAME,
-            TorrentFields.STATUS,
-            TorrentFields.IS_PRIVATE,
-            TorrentFields.DOWNLOADED_EVER,
-            TorrentFields.DOWNLOAD_DIR,
-            TorrentFields.SECONDS_SEEDING,
-            TorrentFields.UPLOAD_RATIO
-        ];
-            
-        return (await _client.TorrentGetAsync(fields))
             ?.Torrents
             ?.Where(x => !string.IsNullOrEmpty(x.HashString))
             .Where(x => x.Status is 5 or 6)
@@ -219,7 +232,8 @@ public class TransmissionService : DownloadService, ITransmissionService
     }
 
     /// <inheritdoc/>
-    public override async Task CleanDownloads(List<object> downloads, List<Category> categoriesToClean, HashSet<string> excludedHashes)
+    public override async Task CleanDownloads(List<object> downloads, List<Category> categoriesToClean, HashSet<string> excludedHashes,
+        IReadOnlyList<string> ignoredDownloads)
     {
         foreach (TorrentInfo download in downloads)
         {
@@ -228,6 +242,12 @@ public class TransmissionService : DownloadService, ITransmissionService
                 continue;
             }
 
+            if (ignoredDownloads.Count > 0 && download.ShouldIgnore(ignoredDownloads))
+            {
+                _logger.LogDebug("skip | download is ignored | {name}", download.Name);
+                continue;
+            }
+            
             Category? category = categoriesToClean
                 .FirstOrDefault(x =>
                 {
@@ -351,20 +371,8 @@ public class TransmissionService : DownloadService, ITransmissionService
         
         if (_torrentsCache is null || torrent is null)
         {
-            string[] fields = [
-                TorrentFields.FILES,
-                TorrentFields.FILE_STATS,
-                TorrentFields.HASH_STRING,
-                TorrentFields.ID,
-                TorrentFields.ETA,
-                TorrentFields.NAME,
-                TorrentFields.STATUS,
-                TorrentFields.IS_PRIVATE,
-                TorrentFields.DOWNLOADED_EVER
-            ];
-            
             // refresh cache
-            _torrentsCache = (await _client.TorrentGetAsync(fields))
+            _torrentsCache = (await _client.TorrentGetAsync(Fields))
                 ?.Torrents;
         }
         

code/Infrastructure/Verticals/Notifications/NotificationPublisher.cs

@@ -32,7 +32,7 @@ public class NotificationPublisher : INotificationPublisher
             QueueRecord record = ContextProvider.Get<QueueRecord>(nameof(QueueRecord));
             InstanceType instanceType = (InstanceType)ContextProvider.Get<object>(nameof(InstanceType));
             Uri instanceUrl = ContextProvider.Get<Uri>(nameof(ArrInstance) + nameof(ArrInstance.Url));
-            Uri imageUrl = GetImageFromContext(record, instanceType);
+            Uri? imageUrl = GetImageFromContext(record, instanceType);
 
             ArrNotification notification = new()
             {
@@ -63,42 +63,59 @@ public class NotificationPublisher : INotificationPublisher
 
     public virtual async Task NotifyQueueItemDeleted(bool removeFromClient, DeleteReason reason)
     {
-        QueueRecord record = ContextProvider.Get<QueueRecord>(nameof(QueueRecord));
+        try
-        InstanceType instanceType = (InstanceType)ContextProvider.Get<object>(nameof(InstanceType));
-        Uri instanceUrl = ContextProvider.Get<Uri>(nameof(ArrInstance) + nameof(ArrInstance.Url));
-        Uri imageUrl = GetImageFromContext(record, instanceType);
-        
-        QueueItemDeletedNotification notification = new()
         {
-            InstanceType = instanceType,
+            QueueRecord record = ContextProvider.Get<QueueRecord>(nameof(QueueRecord));
-            InstanceUrl = instanceUrl,
+            InstanceType instanceType = (InstanceType)ContextProvider.Get<object>(nameof(InstanceType));
-            Hash = record.DownloadId.ToLowerInvariant(),
+            Uri instanceUrl = ContextProvider.Get<Uri>(nameof(ArrInstance) + nameof(ArrInstance.Url));
-            Title = $"Deleting item from queue with reason: {reason}",
+            Uri? imageUrl = GetImageFromContext(record, instanceType);
-            Description = record.Title,
-            Image = imageUrl,
-            Fields = [new() { Title = "Removed from download client?", Text = removeFromClient ? "Yes" : "No" }]
-        };
 
-        await _dryRunInterceptor.InterceptAsync(Notify<QueueItemDeletedNotification>, notification);
+            QueueItemDeletedNotification notification = new()
+            {
+                InstanceType = instanceType,
+                InstanceUrl = instanceUrl,
+                Hash = record.DownloadId.ToLowerInvariant(),
+                Title = $"Deleting item from queue with reason: {reason}",
+                Description = record.Title,
+                Image = imageUrl,
+                Fields = [new() { Title = "Removed from download client?", Text = removeFromClient ? "Yes" : "No" }]
+            };
+
+            await _dryRunInterceptor.InterceptAsync(Notify<QueueItemDeletedNotification>, notification);
+        }
+        catch (Exception ex)
+        {
+            _logger.LogError(ex, "failed to notify queue item deleted");
+        }
     }
 
     public virtual async Task NotifyDownloadCleaned(double ratio, TimeSpan seedingTime, string categoryName, CleanReason reason)
     {
-        DownloadCleanedNotification notification = new()
+        try
         {
-            Title = $"Cleaned item from download client with reason: {reason}",
+            DownloadCleanedNotification notification = new()
-            Description = ContextProvider.Get<string>("downloadName"),
+            {
-            Fields =
+                Title = $"Cleaned item from download client with reason: {reason}",
-            [
+                Description = ContextProvider.Get<string>("downloadName"),
-                new() { Title = "Hash", Text = ContextProvider.Get<string>("hash").ToLowerInvariant() },
+                Fields =
-                new() { Title = "Category", Text = categoryName.ToLowerInvariant() },
+                [
-                new() { Title = "Ratio", Text = $"{ratio.ToString(CultureInfo.InvariantCulture)}%" },
+                    new() { Title = "Hash", Text = ContextProvider.Get<string>("hash").ToLowerInvariant() },
-                new() { Title = "Seeding hours", Text = $"{Math.Round(seedingTime.TotalHours, 0).ToString(CultureInfo.InvariantCulture)}h" }
+                    new() { Title = "Category", Text = categoryName.ToLowerInvariant() },
-            ],
+                    new() { Title = "Ratio", Text = $"{ratio.ToString(CultureInfo.InvariantCulture)}%" },
-            Level = NotificationLevel.Important
+                    new()
-        };
+                    {
+                        Title = "Seeding hours", Text = $"{Math.Round(seedingTime.TotalHours, 0).ToString(CultureInfo.InvariantCulture)}h"
+                    }
+                ],
+                Level = NotificationLevel.Important
+            };
 
-        await _dryRunInterceptor.InterceptAsync(Notify<DownloadCleanedNotification>, notification);
+            await _dryRunInterceptor.InterceptAsync(Notify<DownloadCleanedNotification>, notification);
+        }
+        catch (Exception ex)
+        {
+            _logger.LogError(ex, "failed to notify download cleaned");
+        }
     }
 
     [DryRunSafeguard]
@@ -107,12 +124,21 @@ public class NotificationPublisher : INotificationPublisher
         return _messageBus.Publish(message);
     }
     
-    private static Uri GetImageFromContext(QueueRecord record, InstanceType instanceType) =>
+    private Uri? GetImageFromContext(QueueRecord record, InstanceType instanceType)
-        instanceType switch
+    {
+        Uri? image = instanceType switch
         {
             InstanceType.Sonarr => record.Series!.Images.FirstOrDefault(x => x.CoverType == "poster")?.RemoteUrl,
             InstanceType.Radarr => record.Movie!.Images.FirstOrDefault(x => x.CoverType == "poster")?.RemoteUrl,
             InstanceType.Lidarr => record.Album!.Images.FirstOrDefault(x => x.CoverType == "cover")?.Url,
             _ => throw new ArgumentOutOfRangeException(nameof(instanceType))
-        } ?? throw new Exception("failed to get image url from context");
+        };
+
+        if (image is null)
+        {
+            _logger.LogWarning("no poster found for {title}", record.Title);
+        }
+        
+        return image;
+    }
 }

code/Infrastructure/Verticals/QueueCleaner/QueueCleaner.cs

@@ -4,6 +4,7 @@ using Common.Configuration.QueueCleaner;
 using Domain.Enums;
 using Domain.Models.Arr;
 using Domain.Models.Arr.Queue;
+using Infrastructure.Providers;
 using Infrastructure.Verticals.Arr;
 using Infrastructure.Verticals.Arr.Interfaces;
 using Infrastructure.Verticals.Context;
@@ -19,6 +20,7 @@ namespace Infrastructure.Verticals.QueueCleaner;
 public sealed class QueueCleaner : GenericHandler
 {
     private readonly QueueCleanerConfig _config;
+    private readonly IgnoredDownloadsProvider<QueueCleanerConfig> _ignoredDownloadsProvider;
 
     public QueueCleaner(
         ILogger<QueueCleaner> logger,
@@ -32,7 +34,8 @@ public sealed class QueueCleaner : GenericHandler
         LidarrClient lidarrClient,
         ArrQueueIterator arrArrQueueIterator,
         DownloadServiceFactory downloadServiceFactory,
-        INotificationPublisher notifier
+        INotificationPublisher notifier,
+        IgnoredDownloadsProvider<QueueCleanerConfig> ignoredDownloadsProvider
     ) : base(
         logger, downloadClientConfig,
         sonarrConfig, radarrConfig, lidarrConfig,
@@ -42,10 +45,13 @@ public sealed class QueueCleaner : GenericHandler
     )
     {
         _config = config.Value;
+        _ignoredDownloadsProvider = ignoredDownloadsProvider;
     }
     
     protected override async Task ProcessInstanceAsync(ArrInstance instance, InstanceType instanceType)
     {
+        IReadOnlyList<string> ignoredDownloads = await _ignoredDownloadsProvider.GetIgnoredDownloads();
+        
         using var _ = LogContext.PushProperty("InstanceName", instanceType.ToString());
         
         HashSet<SearchItem> itemsToBeRefreshed = [];
@@ -75,6 +81,12 @@ public sealed class QueueCleaner : GenericHandler
                     continue;
                 }
                 
+                if (ignoredDownloads.Contains(record.DownloadId, StringComparer.InvariantCultureIgnoreCase))
+                {
+                    _logger.LogInformation("skip | {title} | ignored", record.Title);
+                    continue;
+                }
+                
                 // push record to context
                 ContextProvider.Set(nameof(QueueRecord), record);
 
@@ -83,7 +95,7 @@ public sealed class QueueCleaner : GenericHandler
                 if (_downloadClientConfig.DownloadClient is not Common.Enums.DownloadClient.None && record.Protocol is "torrent")
                 {
                     // stalled download check
-                    stalledCheckResult = await _downloadService.ShouldRemoveFromArrQueueAsync(record.DownloadId);
+                    stalledCheckResult = await _downloadService.ShouldRemoveFromArrQueueAsync(record.DownloadId, ignoredDownloads);
                 }
                 
                 // failed import check

code/test/data/cleanuperr/ignored_downloads

@@ -0,0 +1 @@
+ignored

code/test/docker-compose.yml

@@ -175,6 +175,7 @@ services:
     image: ghcr.io/flmorg/cleanuperr:latest
     container_name: cleanuperr
     environment:
+      - TZ=Europe/Bucharest
       - DRY_RUN=false
 
       - LOGGING__LOGLEVEL=Debug
@@ -190,6 +191,7 @@ services:
       - TRIGGERS__DOWNLOADCLEANER=0/30 * * * * ?
 
       - QUEUECLEANER__ENABLED=true
+      - QUEUECLEANER__IGNORED_DOWNLOADS_PATH=/ignored
       - QUEUECLEANER__RUNSEQUENTIALLY=true
       - QUEUECLEANER__IMPORT_FAILED_MAX_STRIKES=5
       - QUEUECLEANER__IMPORT_FAILED_IGNORE_PRIVATE=true
@@ -200,10 +202,12 @@ services:
       - QUEUECLEANER__STALLED_DELETE_PRIVATE=false
 
       - CONTENTBLOCKER__ENABLED=true
+      - CONTENTBLOCKER__IGNORED_DOWNLOADS_PATH=/ignored
       - CONTENTBLOCKER__IGNORE_PRIVATE=true
       - CONTENTBLOCKER__DELETE_PRIVATE=false
 
       - DOWNLOADCLEANER__ENABLED=true
+      - DOWNLOADCLEANER__IGNORED_DOWNLOADS_PATH=/ignored
       - DOWNLOADCLEANER__DELETE_PRIVATE=false
       - DOWNLOADCLEANER__CATEGORIES__0__NAME=tv-sonarr
       - DOWNLOADCLEANER__CATEGORIES__0__MAX_RATIO=-1
@@ -255,6 +259,7 @@ services:
       # - NOTIFIARR__CHANNEL_ID=discord_channel_id
     volumes:
       - ./data/cleanuperr/logs:/var/logs
+      - ./data/cleanuperr/ignored_downloads:/ignored
     restart: unless-stopped
     depends_on:
       - qbittorrent

variables.md

@@ -12,6 +12,13 @@
 
 ### General settings
 
+**`TZ`**
+- The time zone to use.
+- Type: String.
+- Possible values: Any valid timezone.
+- Default: `UTC`.
+- Required: No.
+
 **`DRY_RUN`**
 - When enabled, simulates irreversible operations (like deletions and notifications) without making actual changes.
 - Type: Boolean.
@@ -69,6 +76,31 @@
 - Default: `true`
 - Required: No.
 
+**`QUEUECLEANER__IGNORED_DOWNLOADS_PATH`**
+- Local path to the file containing ignored downloads.
+- If the contents of the file are changed, they will be reloaded on the next job run.
+- Accepted values:
+  -  torrent hash
+  -  qBitTorrent tag or category
+  -  Deluge label
+  -  Transmission category (last directory from the save location)
+  -  torrent tracker domain
+- Each value needs to be on a new line.
+- Type: String.
+- Default: Empty.
+- Required: No.
+- Example: `/ignored.txt`.
+- Example of file contents:
+    ```
+    fa800a7d7c443a2c3561d1f8f393c089036dade1
+    tv-sonarr
+    qbit-tag
+    mytracker.com
+    ...
+    ```
+>[!IMPORTANT]
+> Some people have experienced problems using Docker where the mounted file would not update inside the container if it was modified on the host. This is a Docker configuration problem and can not be solved by cleanuperr.
+
 **`QUEUECLEANER__RUNSEQUENTIALLY`**
 - Controls whether queue cleaner runs after content blocker instead of in parallel.
 - When `true`, streamlines the cleaning process by running immediately after content blocker.
@@ -171,6 +203,31 @@ QUEUECLEANER__IMPORT_FAILED_IGNORE_PATTERNS__1: "manual import required"
 - Default: `false`
 - Required: No.
 
+**`CONTENTBLOCKER__IGNORED_DOWNLOADS_PATH`**
+- Local path to the file containing ignored downloads.
+- If the contents of the file are changed, they will be reloaded on the next job run.
+- Accepted values:
+  -  torrent hash
+  -  qBitTorrent tag or category
+  -  Deluge label
+  -  Transmission category (last directory from the save location)
+  -  torrent tracker domain
+- Each value needs to be on a new line.
+- Type: String.
+- Default: Empty.
+- Required: No.
+- Example: `/ignored.txt`.
+- Example of file contents:
+    ```
+    fa800a7d7c443a2c3561d1f8f393c089036dade1
+    tv-sonarr
+    qbit-tag
+    mytracker.com
+    ...
+    ```
+>[!IMPORTANT]
+> Some people have experienced problems using Docker where the mounted file would not update inside the container if it was modified on the host. This is a Docker configuration problem and can not be solved by cleanuperr.
+
 **`CONTENTBLOCKER__IGNORE_PRIVATE`**
 - Controls whether to ignore downloads from private trackers.
 - Type: Boolean
@@ -210,6 +267,31 @@ QUEUECLEANER__IMPORT_FAILED_IGNORE_PATTERNS__1: "manual import required"
 - Default: `false`
 - Required: No.
 
+**`DOWNLOADCLEANER__IGNORED_DOWNLOADS_PATH`**
+- Local path to the file containing ignored downloads.
+- If the contents of the file are changed, they will be reloaded on the next job run.
+- Accepted values:
+  -  torrent hash
+  -  qBitTorrent tag or category
+  -  Deluge label
+  -  Transmission category (last directory from the save location)
+  -  torrent tracker domain
+- Each value needs to be on a new line.
+- Type: String.
+- Default: Empty.
+- Required: No.
+- Example: `/ignored.txt`.
+- Example of file contents:
+    ```
+    fa800a7d7c443a2c3561d1f8f393c089036dade1
+    tv-sonarr
+    qbit-tag
+    mytracker.com
+    ...
+    ```
+>[!IMPORTANT]
+> Some people have experienced problems using Docker where the mounted file would not update inside the container if it was modified on the host. This is a Docker configuration problem and can not be solved by cleanuperr.
+
 **`DOWNLOADCLEANER__DELETE_PRIVATE`**
 - Controls whether to delete private downloads.
 - Type: Boolean.
@@ -230,7 +312,7 @@ QUEUECLEANER__IMPORT_FAILED_IGNORE_PATTERNS__1: "manual import required"
 > The category name must match the category that was set in the *arr.
 > For qBittorrent, the category name is the name of the download category.
 > For Deluge, the category name is the name of the label.
-> For Transmission, the category name is the name of the download location.
+> For Transmission, the category name is the last directory from the save location.
 
 **`DOWNLOADCLEANER__CATEGORIES__0__MAX_RATIO`**
 - Maximum ratio to reach before removing a download.