added separate strikes for downloading metadata

README.md

@@ -183,15 +183,16 @@ services:
       - QUEUECLEANER__ENABLED=true
       - QUEUECLEANER__IGNORED_DOWNLOADS_PATH=/ignored.txt
       - QUEUECLEANER__RUNSEQUENTIALLY=true
-      - QUEUECLEANER__IMPORT_FAILED_MAX_STRIKES=5
+      - QUEUECLEANER__IMPORT_FAILED_MAX_STRIKES=3
       - 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
-      - QUEUECLEANER__STALLED_MAX_STRIKES=5
+      - QUEUECLEANER__STALLED_MAX_STRIKES=3
       - QUEUECLEANER__STALLED_RESET_STRIKES_ON_PROGRESS=false
       - QUEUECLEANER__STALLED_IGNORE_PRIVATE=false
       - QUEUECLEANER__STALLED_DELETE_PRIVATE=false
+      - QUEUECLEANER__DOWNLOADING_METADATA_MAX_STRIKES=3
 
       - CONTENTBLOCKER__ENABLED=true
       - CONTENTBLOCKER__IGNORED_DOWNLOADS_PATH=/ignored.txt

code/Common/Configuration/QueueCleaner/QueueCleanerConfig.cs

@@ -24,7 +24,7 @@ public sealed record QueueCleanerConfig : IJobConfig, IIgnoredDownloadsConfig
     public bool ImportFailedDeletePrivate { get; init; }
     
     [ConfigurationKeyName("IMPORT_FAILED_IGNORE_PATTERNS")]
-    public List<string>? ImportFailedIgnorePatterns { get; init; }
+    public IReadOnlyList<string>? ImportFailedIgnorePatterns { get; init; }
     
     [ConfigurationKeyName("STALLED_MAX_STRIKES")]
     public ushort StalledMaxStrikes { get; init; }
@@ -38,16 +38,24 @@ public sealed record QueueCleanerConfig : IJobConfig, IIgnoredDownloadsConfig
     [ConfigurationKeyName("STALLED_DELETE_PRIVATE")]
     public bool StalledDeletePrivate { get; init; }
 
+    [ConfigurationKeyName("DOWNLOADING_METADATA_MAX_STRIKES")]
+    public ushort DownloadingMetadataMaxStrikes { get; init; }
+    
     public void Validate()
     {
         if (ImportFailedMaxStrikes is > 0 and < 3)
         {
-            throw new ValidationException("the minimum value for IMPORT_FAILED_MAX_STRIKES must be 3");
+            throw new ValidationException($"the minimum value for {SectionName.ToUpperInvariant()}__IMPORT_FAILED_MAX_STRIKES must be 3");
         }
 
         if (StalledMaxStrikes is > 0 and < 3)
         {
-            throw new ValidationException("the minimum value for STALLED_MAX_STRIKES must be 3");
+            throw new ValidationException($"the minimum value for {SectionName.ToUpperInvariant()}__STALLED_MAX_STRIKES must be 3");
+        }
+        
+        if (DownloadingMetadataMaxStrikes is > 0 and < 3)
+        {
+            throw new ValidationException($"the minimum value for {SectionName.ToUpperInvariant()}__DOWNLOADING_METADATA_MAX_STRIKES must be 3");
         }
     }
 }

code/Domain/Enums/DeleteReason.cs

@@ -1,8 +1,12 @@
-namespace Domain.Enums;
+namespace Domain.Enums;
 
 public enum DeleteReason
 {
+    None,
     Stalled,
     ImportFailed,
-    AllFilesBlocked
+    DownloadingMetadata,
+    AllFilesSkipped,
+    AllFilesSkippedByQBit,
+    AllFilesBlocked,
 }

code/Domain/Enums/StrikeType.cs

@@ -3,5 +3,6 @@
 public enum StrikeType
 {
     Stalled,
+    DownloadingMetadata,
     ImportFailed
 }

code/Executable/appsettings.Development.json

@@ -25,16 +25,17 @@
     "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
+    "STALLED_DELETE_PRIVATE": false,
+    "DOWNLOADING_METADATA_MAX_STRIKES": 3
   },
   "DownloadCleaner": {
     "Enabled": false,

code/Executable/appsettings.json

@@ -31,7 +31,8 @@
     "STALLED_MAX_STRIKES": 0,
     "STALLED_RESET_STRIKES_ON_PROGRESS": false,
     "STALLED_IGNORE_PRIVATE": false,
-    "STALLED_DELETE_PRIVATE": false
+    "STALLED_DELETE_PRIVATE": false,
+    "DOWNLOADING_METADATA_MAX_STRIKES": 0
   },
   "DownloadCleaner": {
     "Enabled": false,

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

@@ -105,13 +105,14 @@ public class DownloadServiceTests : IClassFixture<DownloadServiceFixture>
             // Arrange
             const string hash = "test-hash";
             const string itemName = "test-item";
-            _fixture.Striker.StrikeAndCheckLimit(hash, itemName, 3, StrikeType.Stalled)
+            StrikeType strikeType = StrikeType.Stalled;
+            _fixture.Striker.StrikeAndCheckLimit(hash, itemName, 3, strikeType)
                 .Returns(true);
             
             TestDownloadService sut = _fixture.CreateSut();
 
             // Act
-            bool result = await sut.StrikeAndCheckLimit(hash, itemName);
+            bool result = await sut.StrikeAndCheckLimit(hash, itemName, strikeType);
 
             // Assert
             result.ShouldBeTrue();

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

@@ -3,6 +3,7 @@ using System.Text.RegularExpressions;
 using Common.Configuration.ContentBlocker;
 using Common.Configuration.DownloadCleaner;
 using Common.Configuration.QueueCleaner;
+using Domain.Enums;
 using Infrastructure.Interceptors;
 using Infrastructure.Verticals.ContentBlocker;
 using Infrastructure.Verticals.DownloadClient;
@@ -45,6 +46,6 @@ public class TestDownloadService : DownloadService
 
     // Expose protected methods for testing
     public new void ResetStrikesOnProgress(string hash, long downloaded) => base.ResetStrikesOnProgress(hash, downloaded);
-    public new Task<bool> StrikeAndCheckLimit(string hash, string itemName) => base.StrikeAndCheckLimit(hash, itemName);
+    public new Task<bool> StrikeAndCheckLimit(string hash, string itemName, StrikeType strikeType) => base.StrikeAndCheckLimit(hash, itemName, strikeType);
     public new SeedingCheckResult ShouldCleanDownload(double ratio, TimeSpan seedingTime, Category category) => base.ShouldCleanDownload(ratio, seedingTime, category);
 }

code/Infrastructure/Verticals/Arr/ArrClient.cs

@@ -114,7 +114,12 @@ public abstract class ArrClient : IArrClient
         return false;
     }
     
-    public virtual async Task DeleteQueueItemAsync(ArrInstance arrInstance, QueueRecord record, bool removeFromClient)
+    public virtual async Task DeleteQueueItemAsync(
+        ArrInstance arrInstance,
+        QueueRecord record,
+        bool removeFromClient,
+        DeleteReason deleteReason
+    )
     {
         UriBuilder uriBuilder = new(arrInstance.Url);
         uriBuilder.Path = $"{uriBuilder.Path.TrimEnd('/')}/{GetQueueDeleteUrlPath(record.Id).TrimStart('/')}";
@@ -130,8 +135,9 @@ public abstract class ArrClient : IArrClient
             
             _logger.LogInformation(
                 removeFromClient
-                    ? "queue item deleted | {url} | {title}"
-                    : "queue item removed from arr | {url} | {title}",
+                    ? "queue item deleted with reason {reason} | {url} | {title}"
+                    : "queue item removed from arr with reason {reason} | {url} | {title}",
+                deleteReason.ToString(),
                 arrInstance.Url,
                 record.Title
             );

code/Infrastructure/Verticals/Arr/Interfaces/IArrClient.cs

@@ -11,7 +11,7 @@ public interface IArrClient
 
     Task<bool> ShouldRemoveFromQueue(InstanceType instanceType, QueueRecord record, bool isPrivateDownload);
 
-    Task DeleteQueueItemAsync(ArrInstance arrInstance, QueueRecord record, bool removeFromClient);
+    Task DeleteQueueItemAsync(ArrInstance arrInstance, QueueRecord record, bool removeFromClient, DeleteReason deleteReason);
     
     Task RefreshItemsAsync(ArrInstance arrInstance, HashSet<SearchItem>? items);
     

code/Infrastructure/Verticals/ContentBlocker/ContentBlocker.cs

@@ -142,7 +142,7 @@ public sealed class ContentBlocker : GenericHandler
                     removeFromClient = false;
                 }
                 
-                await arrClient.DeleteQueueItemAsync(instance, record, removeFromClient);
+                await arrClient.DeleteQueueItemAsync(instance, record, removeFromClient, DeleteReason.AllFilesBlocked);
                 await _notifier.NotifyQueueItemDeleted(removeFromClient, DeleteReason.AllFilesBlocked);
             }
         });

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

@@ -65,6 +65,8 @@ public class DelugeService : DownloadService, IDelugeService
             return result;
         }
         
+        result.IsPrivate = download.Private;
+        
         if (ignoredDownloads.Count > 0 && download.ShouldIgnore(ignoredDownloads))
         {
             _logger.LogInformation("skip | download is ignored | {name}", download.Name);
@@ -79,6 +81,7 @@ public class DelugeService : DownloadService, IDelugeService
         {
             _logger.LogDebug(exception, "failed to find torrent {hash} in the download client", hash);
         }
+        
 
         bool shouldRemove = contents?.Contents?.Count > 0;
         
@@ -92,17 +95,15 @@ public class DelugeService : DownloadService, IDelugeService
 
         if (shouldRemove)
         {
-            result.DeleteReason = DeleteReason.AllFilesBlocked;
+            // remove if all files are unwanted
+            result.ShouldRemove = true;
+            result.DeleteReason = DeleteReason.AllFilesSkipped;
+            return result;
         }
         
-        result.ShouldRemove = shouldRemove || await IsItemStuckAndShouldRemove(download);
-        result.IsPrivate = download.Private;
+        // remove if download is stuck
+        (result.ShouldRemove, result.DeleteReason) = await IsItemStuckAndShouldRemove(download);
 
-        if (!shouldRemove && result.ShouldRemove)
-        {
-            result.DeleteReason = DeleteReason.Stalled;
-        }
-        
         return result;
     }
 
@@ -295,33 +296,33 @@ public class DelugeService : DownloadService, IDelugeService
         await _client.ChangeFilesPriority(hash, sortedPriorities);
     }
     
-    private async Task<bool> IsItemStuckAndShouldRemove(TorrentStatus status)
+    private async Task<(bool, DeleteReason)> IsItemStuckAndShouldRemove(TorrentStatus status)
     {
         if (_queueCleanerConfig.StalledMaxStrikes is 0)
         {
-            return false;
+            return (false, default);
         }
         
         if (_queueCleanerConfig.StalledIgnorePrivate && status.Private)
         {
             // ignore private trackers
             _logger.LogDebug("skip stalled check | download is private | {name}", status.Name);
-            return false;
+            return (false, default);
         }
         
         if (status.State is null || !status.State.Equals("Downloading", StringComparison.InvariantCultureIgnoreCase))
         {
-            return false;
+            return (false, default);
         }
 
         if (status.Eta > 0)
         {
-            return false;
+            return (false, default);
         }
         
         ResetStrikesOnProgress(status.Hash!, status.TotalDone);
 
-        return await StrikeAndCheckLimit(status.Hash!, status.Name!);
+        return (await StrikeAndCheckLimit(status.Hash!, status.Name!, StrikeType.Stalled), DeleteReason.Stalled);
     }
     
     private static void ProcessFiles(Dictionary<string, DelugeFileOrDirectory>? contents, Action<string, DelugeFileOrDirectory> processFile)

code/Infrastructure/Verticals/DownloadClient/DownloadService.cs

@@ -100,10 +100,11 @@ public abstract class DownloadService : IDownloadService
     /// </summary>
     /// <param name="hash">The torrent hash.</param>
     /// <param name="itemName">The name or title of the item.</param>
+    /// <param name="strikeType"></param>
     /// <returns>True if the limit has been reached; otherwise, false.</returns>
-    protected async Task<bool> StrikeAndCheckLimit(string hash, string itemName)
+    protected async Task<bool> StrikeAndCheckLimit(string hash, string itemName, StrikeType strikeType)
     {
-        return await _striker.StrikeAndCheckLimit(hash, itemName, _queueCleanerConfig.StalledMaxStrikes, StrikeType.Stalled);
+        return await _striker.StrikeAndCheckLimit(hash, itemName, _queueCleanerConfig.StalledMaxStrikes, strikeType);
     }
     
     protected SeedingCheckResult ShouldCleanDownload(double ratio, TimeSpan seedingTime, Category category)

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

@@ -96,30 +96,26 @@ public class QBitService : DownloadService, IQBitService
                            bool.TryParse(dictValue?.ToString(), out bool boolValue)
                            && boolValue;
 
-        // if all files were blocked by qBittorrent
-        if (download is { CompletionOn: not null, Downloaded: null or 0 })
-        {
-            result.ShouldRemove = true;
-            result.DeleteReason = DeleteReason.AllFilesBlocked;
-            return result;
-        }
-
         IReadOnlyList<TorrentContent>? files = await _client.GetTorrentContentsAsync(hash);
 
-        // if all files are marked as skip
         if (files?.Count is > 0 && files.All(x => x.Priority is TorrentContentPriority.Skip))
         {
             result.ShouldRemove = true;
-            result.DeleteReason = DeleteReason.AllFilesBlocked;
+            
+            // if all files were blocked by qBittorrent
+            if (download is { CompletionOn: not null, Downloaded: null or 0 })
+            {
+                result.DeleteReason = DeleteReason.AllFilesSkippedByQBit;
+                return result;
+            }
+            
+            // remove if all files are unwanted
+            result.DeleteReason = DeleteReason.AllFilesSkipped;
             return result;
         }
 
-        result.ShouldRemove = await IsItemStuckAndShouldRemove(download, result.IsPrivate);
-
-        if (result.ShouldRemove)
-        {
-            result.DeleteReason = DeleteReason.Stalled;
-        }
+        // remove if download is stuck
+        (result.ShouldRemove, result.DeleteReason) = await IsItemStuckAndShouldRemove(download, result.IsPrivate);
 
         return result;
     }
@@ -337,30 +333,41 @@ public class QBitService : DownloadService, IQBitService
         _client.Dispose();
     }
 
-    private async Task<bool> IsItemStuckAndShouldRemove(TorrentInfo torrent, bool isPrivate)
+    private async Task<(bool, DeleteReason)> IsItemStuckAndShouldRemove(TorrentInfo torrent, bool isPrivate)
     {
-        if (_queueCleanerConfig.StalledMaxStrikes is 0)
+        if (_queueCleanerConfig.StalledMaxStrikes is 0 && _queueCleanerConfig.DownloadingMetadataMaxStrikes is 0)
         {
-            return false;
-        }
-        
-        if (_queueCleanerConfig.StalledIgnorePrivate && isPrivate)
-        {
-            // ignore private trackers
-            _logger.LogDebug("skip stalled check | download is private | {name}", torrent.Name);
-            return false;
+            return (false, DeleteReason.None);
         }
         
         if (torrent.State is not TorrentState.StalledDownload and not TorrentState.FetchingMetadata
             and not TorrentState.ForcedFetchingMetadata)
         {
             // ignore other states
-            return false;
+            return (false, DeleteReason.None);
         }
 
-        ResetStrikesOnProgress(torrent.Hash, torrent.Downloaded ?? 0);
+        if (_queueCleanerConfig.StalledMaxStrikes > 0 && torrent.State is TorrentState.StalledDownload)
+        {
+            if (_queueCleanerConfig.StalledIgnorePrivate && isPrivate)
+            {
+                // ignore private trackers
+                _logger.LogDebug("skip stalled check | download is private | {name}", torrent.Name);
+            }
+            else
+            {
+                ResetStrikesOnProgress(torrent.Hash, torrent.Downloaded ?? 0);
+            
+                return (await StrikeAndCheckLimit(torrent.Hash, torrent.Name, StrikeType.Stalled), DeleteReason.Stalled);
+            }
+        }
 
-        return await StrikeAndCheckLimit(torrent.Hash, torrent.Name);
+        if (_queueCleanerConfig.DownloadingMetadataMaxStrikes > 0)
+        {
+            return (await StrikeAndCheckLimit(torrent.Hash, torrent.Name, StrikeType.DownloadingMetadata), DeleteReason.DownloadingMetadata);
+        }
+
+        return (false, DeleteReason.None);
     }
 
     private async Task<IReadOnlyList<TorrentTracker>> GetTrackersAsync(string hash)

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

@@ -119,17 +119,15 @@ public class TransmissionService : DownloadService, ITransmissionService
         
         if (shouldRemove)
         {
+            // remove if all files are unwanted
+            result.ShouldRemove = true;
             result.DeleteReason = DeleteReason.AllFilesBlocked;
+            return result;
         }
 
-        // remove if all files are unwanted or download is stuck
-        result.ShouldRemove = shouldRemove || await IsItemStuckAndShouldRemove(download);
+        // remove if download is stuck
+        (result.ShouldRemove, result.DeleteReason) = await IsItemStuckAndShouldRemove(download);
 
-        if (!shouldRemove && result.ShouldRemove)
-        {
-            result.DeleteReason = DeleteReason.Stalled;
-        }
-        
         return result;
     }
 
@@ -338,34 +336,34 @@ public class TransmissionService : DownloadService, ITransmissionService
         });
     }
     
-    private async Task<bool> IsItemStuckAndShouldRemove(TorrentInfo torrent)
+    private async Task<(bool, DeleteReason)> IsItemStuckAndShouldRemove(TorrentInfo torrent)
     {
         if (_queueCleanerConfig.StalledMaxStrikes is 0)
         {
-            return false;
+            return (false, default);
         }
         
         if (_queueCleanerConfig.StalledIgnorePrivate && (torrent.IsPrivate ?? false))
         {
             // ignore private trackers
             _logger.LogDebug("skip stalled check | download is private | {name}", torrent.Name);
-            return false;
+            return (false, default);
         }
         
         if (torrent.Status is not 4)
         {
             // not in downloading state
-            return false;
+            return (false, default);
         }
 
         if (torrent.Eta > 0)
         {
-            return false;
+            return (false, default);
         }
         
         ResetStrikesOnProgress(torrent.HashString!, torrent.DownloadedEver ?? 0);
 
-        return await StrikeAndCheckLimit(torrent.HashString!, torrent.Name!);
+        return (await StrikeAndCheckLimit(torrent.HashString!, torrent.Name!, StrikeType.Stalled), DeleteReason.Stalled);
     }
 
     private async Task<TorrentInfo?> GetTorrentAsync(string hash)

code/Infrastructure/Verticals/QueueCleaner/QueueCleaner.cs

@@ -119,9 +119,9 @@ public sealed class QueueCleaner : GenericHandler
 
                 bool removeFromClient = true;
 
-                if (stalledCheckResult.IsPrivate)
+                if (stalledCheckResult is { IsPrivate: true, DeleteReason: not DeleteReason.DownloadingMetadata })
                 {
-                    if (stalledCheckResult.ShouldRemove && !_config.StalledDeletePrivate)
+                    if (stalledCheckResult is { ShouldRemove: true, DeleteReason: DeleteReason.Stalled } && !_config.StalledDeletePrivate)
                     {
                         removeFromClient = false;
                     }
@@ -132,7 +132,7 @@ public sealed class QueueCleaner : GenericHandler
                     }
                 }
                 
-                await arrClient.DeleteQueueItemAsync(instance, record, removeFromClient);
+                await arrClient.DeleteQueueItemAsync(instance, record, removeFromClient, deleteReason);
                 await _notifier.NotifyQueueItemDeleted(removeFromClient, deleteReason);
             }
         });

code/test/docker-compose.yml

@@ -193,13 +193,14 @@ services:
       - QUEUECLEANER__ENABLED=true
       - QUEUECLEANER__IGNORED_DOWNLOADS_PATH=/ignored
       - QUEUECLEANER__RUNSEQUENTIALLY=true
-      - QUEUECLEANER__IMPORT_FAILED_MAX_STRIKES=5
+      - QUEUECLEANER__IMPORT_FAILED_MAX_STRIKES=3
       - QUEUECLEANER__IMPORT_FAILED_IGNORE_PRIVATE=true
       - QUEUECLEANER__IMPORT_FAILED_DELETE_PRIVATE=false
       - QUEUECLEANER__IMPORT_FAILED_IGNORE_PATTERNS__0=file is a sample
-      - QUEUECLEANER__STALLED_MAX_STRIKES=5
+      - QUEUECLEANER__STALLED_MAX_STRIKES=3
       - QUEUECLEANER__STALLED_IGNORE_PRIVATE=true
       - QUEUECLEANER__STALLED_DELETE_PRIVATE=false
+      - QUEUECLEANER__DOWNLOADING_METADATA_MAX_STRIKES=3
 
       - CONTENTBLOCKER__ENABLED=true
       - CONTENTBLOCKER__IGNORED_DOWNLOADS_PATH=/ignored

variables.md

@@ -152,7 +152,7 @@
 #### **`QUEUECLEANER__STALLED_MAX_STRIKES`**
 - Number of strikes before removing a stalled download.
 - Set to `0` to never remove stalled downloads.
-- A strike is given when an item is stalled (not downloading) or stuck while downloading metadata.
+- A strike is given when an item is stalled (not downloading).
 - Type: Integer
 - Default: `0`
 - Required: No.
@@ -184,6 +184,19 @@
 > [!WARNING]
 > Setting `QUEUECLEANER__STALLED_DELETE_PRIVATE=true` means you don't care about seeding, ratio, H&R and potentially losing your private tracker account.
 
+#### **`QUEUECLEANER__DOWNLOADING_METADATA_MAX_STRIKES`**
+- Number of strikes before removing a download stuck while downloading metadata.
+- Set to `0` to never remove downloads stuck at `downloading metadata`.
+- A strike is given when an item is stuck while downloading metadata.
+- Type: Integer
+- Default: `0`
+- Required: No.
+> [!NOTE]
+> If not set to `0`, the minimum value is `3`.
+
+> [!IMPORTANT]
+> `QUEUECLEANER__DOWNLOADING_METADATA_MAX_STRIKES` works only for qBitTorrent.
+
 #
 
 ### Content Blocker settings
@@ -317,7 +330,7 @@
 >
 > For Deluge, the category name is the name of the label.
 >
-> For Transmission, the category name is the last directory from the save location.
+> For Transmission, the category name is the last directory from the save location (e.g. `myCategory` from `/downloads/path/myCategory`).
 
 #### **`DOWNLOADCLEANER__CATEGORIES__0__MAX_RATIO`**
 - Maximum ratio to reach before removing a download.