Add category change for downloads with no additional hardlinks

README.md

@@ -14,7 +14,8 @@ cleanuperr was created primarily to address malicious files, such as `*.lnk` or
 > - Remove and block downloads that reached a maximum number of strikes.
 > - Remove downloads blocked by qBittorrent or by cleanuperr's **content blocker**.
 > - Trigger a search for downloads removed from the *arrs.
-> - Clean up downloads that have been seeding for a certain amount of time.
+> - Remove downloads that have been seeding for a certain amount of time.
+> - Remove downloads that have no hardlinks (have been upgraded by the *arrs).
 > - Notify on strike or download removal.
 > - Ignore certain torrent hashes, categories, tags or trackers from processing.
 
@@ -176,31 +177,41 @@ services:
       - LOGGING__FILE__PATH=/var/logs/
       - LOGGING__ENHANCED=true
 
+      # triggers
       - TRIGGERS__QUEUECLEANER=0 0/5 * * * ?
       - TRIGGERS__CONTENTBLOCKER=0 0/5 * * * ?
       - TRIGGERS__DOWNLOADCLEANER=0 0 * * * ?
 
+      # queue cleaner
       - QUEUECLEANER__ENABLED=true
       - QUEUECLEANER__IGNORED_DOWNLOADS_PATH=/ignored.txt
       - QUEUECLEANER__RUNSEQUENTIALLY=true
+
+      # failed imports
       - QUEUECLEANER__IMPORT_FAILED_MAX_STRIKES=5
       - QUEUECLEANER__IMPORT_FAILED_IGNORE_PRIVATE=false
       - QUEUECLEANER__IMPORT_FAILED_DELETE_PRIVATE=false
       # - QUEUECLEANER__IMPORT_FAILED_IGNORE_PATTERNS__0=title mismatch
       # - QUEUECLEANER__IMPORT_FAILED_IGNORE_PATTERNS__1=manual import required
+
+      # stalled downloads
       - QUEUECLEANER__STALLED_MAX_STRIKES=5
       - QUEUECLEANER__STALLED_RESET_STRIKES_ON_PROGRESS=false
       - QUEUECLEANER__STALLED_IGNORE_PRIVATE=false
       - QUEUECLEANER__STALLED_DELETE_PRIVATE=false
 
+      # content blocker
       - CONTENTBLOCKER__ENABLED=true
       - CONTENTBLOCKER__IGNORED_DOWNLOADS_PATH=/ignored.txt
       - CONTENTBLOCKER__IGNORE_PRIVATE=false
       - CONTENTBLOCKER__DELETE_PRIVATE=false
 
+      # download cleaner
       - DOWNLOADCLEANER__ENABLED=true
       - DOWNLOADCLEANER__IGNORED_DOWNLOADS_PATH=/ignored.txt
       - DOWNLOADCLEANER__DELETE_PRIVATE=false
+
+      # remove seeding downloads
       - DOWNLOADCLEANER__CATEGORIES__0__NAME=tv-sonarr
       - DOWNLOADCLEANER__CATEGORIES__0__MAX_RATIO=-1
       - DOWNLOADCLEANER__CATEGORIES__0__MIN_SEED_TIME=0
@@ -209,6 +220,17 @@ services:
       - DOWNLOADCLEANER__CATEGORIES__1__MAX_RATIO=-1
       - DOWNLOADCLEANER__CATEGORIES__1__MIN_SEED_TIME=0
       - DOWNLOADCLEANER__CATEGORIES__1__MAX_SEED_TIME=240
+      # remove downloads with no hardlinks
+      - DOWNLOADCLEANER__CATEGORIES__2__NAME=cleanuperr-unlinked
+      - DOWNLOADCLEANER__CATEGORIES__2__MAX_RATIO=-1
+      - DOWNLOADCLEANER__CATEGORIES__2__MIN_SEED_TIME=0
+      - DOWNLOADCLEANER__CATEGORIES__2__MAX_SEED_TIME=0
+
+      # change category for downloads with no hardlinks
+      - DOWNLOADCLEANER__UNLINKED_TARGET_CATEGORY=cleanuperr-unlinked
+      - DOWNLOADCLEANER__UNLINKED_IGNORED_ROOT_DIR=/downloads
+      - DOWNLOADCLEANER__UNLINKED_CATEGORIES__0=tv-sonarr
+      - DOWNLOADCLEANER__UNLINKED_CATEGORIES__1=radarr
 
       - DOWNLOAD_CLIENT=none
       # OR

code/Common/Configuration/DownloadCleaner/Category.cs → code/Common/Configuration/DownloadCleaner/CleanCategory.cs

@@ -3,7 +3,7 @@
 
 namespace Common.Configuration.DownloadCleaner;
 
-public sealed record Category : IConfig
+public sealed record CleanCategory : IConfig
 {
     public required string Name { get; init; }
 

code/Common/Configuration/DownloadCleaner/DownloadCleanerConfig.cs

@@ -8,15 +8,24 @@ public sealed record DownloadCleanerConfig : IJobConfig, IIgnoredDownloadsConfig
     public const string SectionName = "DownloadCleaner";
 
     public bool Enabled { get; init; }
-    
-    public List<Category>? Categories { get; init; }
+
+    public List<CleanCategory>? Categories { get; init; }
 
     [ConfigurationKeyName("DELETE_PRIVATE")]
     public bool DeletePrivate { get; init; }
 
     [ConfigurationKeyName("IGNORED_DOWNLOADS_PATH")]
     public string? IgnoredDownloadsPath { get; init; }
 
+    [ConfigurationKeyName("UNLINKED_TARGET_CATEGORY")]
+    public string UnlinkedTargetCategory { get; init; } = "cleanuperr-unlinked";
+
+    [ConfigurationKeyName("UNLINKED_IGNORED_ROOT_DIR")]
+    public string UnlinkedIgnoredRootDir { get; init; } = string.Empty;
+
+    [ConfigurationKeyName("UNLINKED_CATEGORIES")]
+    public List<string>? UnlinkedCategories { get; init; }
+
     public void Validate()
     {
         if (!Enabled)
@@ -31,9 +40,34 @@ public void Validate()
 
         if (Categories?.GroupBy(x => x.Name).Any(x => x.Count() > 1) is true)
         {
-            throw new ValidationException("duplicated categories found");
+            throw new ValidationException("duplicated clean categories found");
         }
 
         Categories?.ForEach(x => x.Validate());
+
+        if (string.IsNullOrEmpty(UnlinkedTargetCategory))
+        {
+            return;
+        }
+
+        if (UnlinkedCategories?.Count is null or 0)
+        {
+            throw new ValidationException("no unlinked categories configured");
+        }
+
+        if (UnlinkedCategories.Contains(UnlinkedTargetCategory))
+        {
+            throw new ValidationException($"{SectionName.ToUpperInvariant()}__UNLINKED_TARGET_CATEGORY should not be present in {SectionName.ToUpperInvariant()}__UNLINKED_CATEGORIES");
+        }
+
+        if (UnlinkedCategories.Any(string.IsNullOrEmpty))
+        {
+            throw new ValidationException("empty unlinked category filter found");
+        }
+
+        if (!string.IsNullOrEmpty(UnlinkedIgnoredRootDir) && !Directory.Exists(UnlinkedIgnoredRootDir))
+        {
+            throw new ValidationException($"{UnlinkedIgnoredRootDir} root directory does not exist");
+        }
     }
 }

code/Common/Configuration/Notification/NotificationConfig.cs

@@ -15,8 +15,16 @@ public abstract record NotificationConfig
 
     [ConfigurationKeyName("ON_DOWNLOAD_CLEANED")]
     public bool OnDownloadCleaned { get; init; }
+
+    [ConfigurationKeyName("ON_CATEGORY_CHANGED")]
+    public bool OnCategoryChanged { get; init; }
 
-    public bool IsEnabled => OnImportFailedStrike || OnStalledStrike || OnQueueItemDeleted || OnDownloadCleaned;
+    public bool IsEnabled =>
+        OnImportFailedStrike ||
+        OnStalledStrike ||
+        OnQueueItemDeleted ||
+        OnDownloadCleaned ||
+        OnCategoryChanged;
 
     public abstract bool IsValid();
 }

code/Common/Exceptions/FatalException.cs

@@ -0,0 +1,12 @@
+namespace Common.Exceptions;
+
+public class FatalException : Exception
+{
+    public FatalException()
+    {
+    }
+
+    public FatalException(string message) : base(message)
+    {
+    }
+}

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

@@ -23,14 +23,17 @@ public sealed record DownloadStatus
     [JsonProperty("total_done")]
     public long TotalDone { get; init; }
 
-    public string? Label { get; init; }
+    public string? Label { get; set; }
 
     [JsonProperty("seeding_time")]
     public long SeedingTime { get; init; }
 
     public float Ratio { get; init; }
 
     public required IReadOnlyList<Tracker> Trackers { get; init; }
+
+    [JsonProperty("download_location")]
+    public required string DownloadLocation { get; init; }
 }
 
 public sealed record Tracker

code/Executable/DependencyInjection/MainDI.cs

@@ -17,7 +17,9 @@ public static IServiceCollection AddInfrastructure(this IServiceCollection servi
             .AddLogging(builder => builder.ClearProviders().AddConsole())
             .AddHttpClients(configuration)
             .AddConfiguration(configuration)
-            .AddMemoryCache()
+            .AddMemoryCache(options => {
+                options.ExpirationScanFrequency = TimeSpan.FromMinutes(1);
+            })
             .AddServices()
             .AddQuartzServices(configuration)
             .AddNotifications(configuration)
@@ -27,6 +29,7 @@ public static IServiceCollection AddInfrastructure(this IServiceCollection servi
                 config.AddConsumer<NotificationConsumer<StalledStrikeNotification>>();
                 config.AddConsumer<NotificationConsumer<QueueItemDeletedNotification>>();
                 config.AddConsumer<NotificationConsumer<DownloadCleanedNotification>>();
+                config.AddConsumer<NotificationConsumer<CategoryChangedNotification>>();
 
                 config.UsingInMemory((context, cfg) =>
                 {
@@ -36,6 +39,7 @@ public static IServiceCollection AddInfrastructure(this IServiceCollection servi
                         e.ConfigureConsumer<NotificationConsumer<StalledStrikeNotification>>(context);
                         e.ConfigureConsumer<NotificationConsumer<QueueItemDeletedNotification>>(context);
                         e.ConfigureConsumer<NotificationConsumer<DownloadCleanedNotification>>(context);
+                        e.ConfigureConsumer<NotificationConsumer<CategoryChangedNotification>>(context);
                         e.ConcurrentMessageLimit = 1;
                         e.PrefetchCount = 1;
                     });

code/Executable/DependencyInjection/ServicesDI.cs

@@ -10,6 +10,7 @@
 using Infrastructure.Verticals.DownloadClient.Deluge;
 using Infrastructure.Verticals.DownloadClient.QBittorrent;
 using Infrastructure.Verticals.DownloadClient.Transmission;
+using Infrastructure.Verticals.Files;
 using Infrastructure.Verticals.ItemStriker;
 using Infrastructure.Verticals.QueueCleaner;
 
@@ -27,14 +28,17 @@ public static IServiceCollection AddServices(this IServiceCollection services) =
             .AddTransient<ContentBlocker>()
             .AddTransient<DownloadCleaner>()
             .AddTransient<IFilenameEvaluator, FilenameEvaluator>()
+            .AddTransient<IHardLinkFileService, HardLinkFileService>()
+            .AddTransient<UnixHardLinkFileService>()
+            .AddTransient<WindowsHardLinkFileService>()
             .AddTransient<DummyDownloadService>()
             .AddTransient<QBitService>()
             .AddTransient<DelugeService>()
             .AddTransient<TransmissionService>()
             .AddTransient<ArrQueueIterator>()
             .AddTransient<DownloadServiceFactory>()
+            .AddTransient<IStriker, Striker>()
             .AddSingleton<BlocklistProvider>()
-            .AddSingleton<IStriker, Striker>()
             .AddSingleton<IgnoredDownloadsProvider<QueueCleanerConfig>>()
             .AddSingleton<IgnoredDownloadsProvider<ContentBlockerConfig>>()
             .AddSingleton<IgnoredDownloadsProvider<DownloadCleanerConfig>>();

code/Executable/appsettings.Development.json

@@ -25,13 +25,13 @@
     "Enabled": true,
     "RunSequentially": true,
     "IGNORED_DOWNLOADS_PATH": "../test/data/cleanuperr/ignored_downloads",
-    "IMPORT_FAILED_MAX_STRIKES": 5,
+    "IMPORT_FAILED_MAX_STRIKES": 3,
     "IMPORT_FAILED_IGNORE_PRIVATE": true,
     "IMPORT_FAILED_DELETE_PRIVATE": false,
     "IMPORT_FAILED_IGNORE_PATTERNS": [
       "file is a sample"
     ],
-    "STALLED_MAX_STRIKES": 5,
+    "STALLED_MAX_STRIKES": 3,
     "STALLED_RESET_STRIKES_ON_PROGRESS": true,
     "STALLED_IGNORE_PRIVATE": true,
     "STALLED_DELETE_PRIVATE": false,
@@ -51,9 +51,15 @@
         "Name": "tv-sonarr",
         "MAX_RATIO": -1,
         "MIN_SEED_TIME": 0,
-        "MAX_SEED_TIME": -1
+        "MAX_SEED_TIME": 240
       }
     ],
+    "UNLINKED_TARGET_CATEGORY": "cleanuperr-unlinked",
+    "UNLINKED_IGNORED_ROOT_DIR": "",
+    "UNLINKED_CATEGORIES": [
+      "tv-sonarr",
+      "radarr"
+    ],
     "IGNORED_DOWNLOADS_PATH": "../test/data/cleanuperr/ignored_downloads"
   },
   "DOWNLOAD_CLIENT": "qbittorrent",

code/Executable/appsettings.json

@@ -37,6 +37,9 @@
     "Enabled": false,
     "DELETE_PRIVATE": false,
     "CATEGORIES": [],
+    "UNLINKED_TARGET_CATEGORY": "cleanuperr-unlinked",
+    "UNLINKED_IGNORED_ROOT_DIR": "",
+    "UNLINKED_CATEGORIES": [],
     "IGNORED_DOWNLOADS_PATH": ""
   },
   "DOWNLOAD_CLIENT": "none",

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

@@ -1,9 +1,10 @@
-using Common.Configuration.ContentBlocker;
+using Common.Configuration.ContentBlocker;
 using Common.Configuration.DownloadCleaner;
 using Common.Configuration.QueueCleaner;
 using Infrastructure.Interceptors;
 using Infrastructure.Verticals.ContentBlocker;
 using Infrastructure.Verticals.DownloadClient;
+using Infrastructure.Verticals.Files;
 using Infrastructure.Verticals.ItemStriker;
 using Infrastructure.Verticals.Notifications;
 using Microsoft.Extensions.Caching.Memory;
@@ -56,6 +57,7 @@ public TestDownloadService CreateSut(
         var filenameEvaluator = Substitute.For<IFilenameEvaluator>();
         var notifier = Substitute.For<INotificationPublisher>();
         var dryRunInterceptor = Substitute.For<IDryRunInterceptor>();
+        var hardlinkFileService = Substitute.For<IHardLinkFileService>();
 
         return new TestDownloadService(
             Logger,
@@ -66,7 +68,8 @@ public TestDownloadService CreateSut(
             filenameEvaluator,
             Striker,
             notifier,
-            dryRunInterceptor
+            dryRunInterceptor,
+            hardlinkFileService
         );
     }
 

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

@@ -111,7 +111,7 @@ public ShouldCleanDownloadTests(DownloadServiceFixture fixture) : base(fixture)
         public void WhenRatioAndMinSeedTimeReached_ShouldReturnTrue()
         {
             // Arrange
-            Category category = new()
+            CleanCategory category = new()
             {
                 Name = "test",
                 MaxRatio = 1.0,
@@ -137,7 +137,7 @@ public void WhenRatioAndMinSeedTimeReached_ShouldReturnTrue()
         public void WhenRatioReachedAndMinSeedTimeNotReached_ShouldReturnFalse()
         {
             // Arrange
-            Category category = new()
+            CleanCategory category = new()
             {
                 Name = "test",
                 MaxRatio = 1.0,
@@ -163,7 +163,7 @@ public void WhenRatioReachedAndMinSeedTimeNotReached_ShouldReturnFalse()
         public void WhenMaxSeedTimeReached_ShouldReturnTrue()
         {
             // Arrange
-            Category category = new()
+            CleanCategory category = new()
             {
                 Name = "test",
                 MaxRatio = -1,
@@ -189,7 +189,7 @@ public void WhenMaxSeedTimeReached_ShouldReturnTrue()
         public void WhenNeitherConditionMet_ShouldReturnFalse()
         {
             // Arrange
-            Category category = new()
+            CleanCategory category = new()
             {
                 Name = "test",
                 MaxRatio = 2.0,