Implement QueneCleaner

Author: Meyn

README.md

@@ -7,6 +7,18 @@ Additionally, Tubifarry supports fetching soundtracks from **Sonarr** (series) a
 
 ---
 
+## Table of Contents 📑
+
+1. [Tubifarry for Lidarr 🎶](#tubifarry-for-lidarr-)
+2. [Installation 🚀](#installation-)
+3. [Soulseek (Slskd) Setup 🎧](#soulseek-slskd-setup-)
+4. [YouTube Downloader Setup 🎥](#youtube-downloader-setup-)
+5. [Fetching Soundtracks 🎬🎵](#fetching-soundtracks-from-sonarr-and-radarr-)
+6. [Queue Cleaner 🧹](#queue-cleaner-)
+7. [Troubleshooting 🛠️](#troubleshooting-)
+
+----
+
 ## Installation 🚀  
 To use Tubifarry, ensure your Lidarr setup is on the `plugins` branch. Follow the steps below to get started.  
 
@@ -90,7 +102,24 @@ To enable this feature:
 
 ---
 
-### Troubleshooting 🛠️  
+## Queue Cleaner 🧹  
+
+The **Queue Cleaner** automatically processes items in your Lidarr queue that have **failed to import**. It ensures your library stays organized by handling failed imports based on your preferences.  
+
+1. **Key Options**:  
+   - *Blocklist*: Choose to remove, blocklist, or both for failed imports.  
+   - *Rename*: Automatically rename album folders and tracks using available metadata.  
+   - *Clean Imports*: Decide when to clean—when tracks are missing, metadata is incomplete, or always.  
+   - *Retry Finding Release*: Automatically retry searching for a release if the import fails.  
+
+2. **How to Enable**:  
+   - Navigate to `Settings -> Connect` in Lidarr.  
+   - Add a new connection and select the **Queue Cleaner**.  
+   - Configure the settings to match your needs.  
+
+---
+
+## Troubleshooting 🛠️  
 - **Slskd Download Path Permissions**: Ensure Lidarr has read/write access to the Slskd download path. Verify folder permissions and ensure the user running Lidarr has the necessary access. For Docker setups, confirm the volume is correctly mounted and permissions are set.  
 - **Optional: FFmpeg Issues**: If you choose to use FFmpeg and songs fail to process, verify that FFmpeg is correctly installed and accessible in your system's PATH. If not, try reinstalling or downloading it manually.  
 - **Metadata Issues**: If metadata is not being added to downloaded files, confirm that the files are in a supported format. If using FFmpeg, ensure it is extracting audio to formats like AAC embedded in MP4 containers (check debug logs).  

Tubifarry/Core/AlbumData.cs

@@ -27,6 +27,7 @@ public class AlbumData
 
         // Properties from YoutubeSearchResults
         public int Bitrate { get; set; }
+        public int BitDepth { get; set; }
         public long Duration { get; set; }
 
         // Soulseek
@@ -91,6 +92,8 @@ private string ConstructTitle()
 
             if (AudioFormatHelper.IsLossyFormat(Codec) && calculatedBitrate != 0)
                 title += $" [{Codec} {calculatedBitrate}kbps] [WEB]";
+            if (!AudioFormatHelper.IsLossyFormat(Codec) && BitDepth != 0)
+                title += $" [{Codec} {BitDepth}bit] [WEB]";
             else
                 title += $" [{Codec}] [WEB]";
 

Tubifarry/Download/Clients/Soulseek/SlskdClient.cs

@@ -4,7 +4,6 @@
 using NzbDrone.Common.Extensions;
 using NzbDrone.Common.Http;
 using NzbDrone.Core.Configuration;
-using NzbDrone.Core.History;
 using NzbDrone.Core.Indexers;
 using NzbDrone.Core.Parser.Model;
 using NzbDrone.Core.RemotePathMappings;
@@ -23,7 +22,7 @@ public class SlskdClient : DownloadClientBase<SlskdProviderSettings>
         public override string Name => "Slskd";
         public override string Protocol => nameof(SoulseekDownloadProtocol);
 
-        public SlskdClient(IHttpClient httpClient, IConfigService configService, IDiskProvider diskProvider, IHistoryService history, IRemotePathMappingService remotePathMappingService, Logger logger)
+        public SlskdClient(IHttpClient httpClient, IConfigService configService, IDiskProvider diskProvider, IRemotePathMappingService remotePathMappingService, Logger logger)
             : base(configService, diskProvider, remotePathMappingService, logger) => _httpClient = httpClient;
 
 

Tubifarry/Indexers/Soulseek/SlskdParser.cs

@@ -85,9 +85,13 @@ private AlbumData CreateAlbumData(string searchId, IGrouping<string, SlskdFileDa
             long totalSize = directory.Sum(f => f.Size);
             int totalDuration = directory.Sum(f => f.Length ?? 0);
 
-            int? bitRate = directory.First().BitRate;
-            if (!bitRate.HasValue && totalDuration > 0)
-                bitRate = (int)((totalSize * 8) / (totalDuration * 1000));
+            int? mostCommonBitRate = directory.GroupBy(f => f.BitRate).OrderByDescending(g => g.Count()).FirstOrDefault()?.Key;
+
+            int? mostCommonBitDepth = directory.GroupBy(f => f.BitDepth).OrderByDescending(g => g.Count()).FirstOrDefault()?.Key;
+
+
+            if (!mostCommonBitRate.HasValue && totalDuration > 0)
+                mostCommonBitRate = (int)((totalSize * 8) / (totalDuration * 1000));
 
             List<SlskdFileData>? filesToDownload = directory.GroupBy(f => f.Filename?[..f.Filename.LastIndexOf('\\')]).FirstOrDefault(g => g.Key == directory.Key)?.ToList();
             AudioFormat codec = AudioFormatHelper.GetAudioCodecFromExtension(mostCommonExtension ?? string.Empty);
@@ -99,7 +103,8 @@ private AlbumData CreateAlbumData(string searchId, IGrouping<string, SlskdFileDa
                 ReleaseDate = folderData.Year,
                 ReleaseDateTime = (string.IsNullOrEmpty(folderData.Year) || !int.TryParse(folderData.Year, out int yearInt) ? DateTime.MinValue : new DateTime(yearInt, 1, 1)),
                 Codec = codec,
-                Bitrate = (codec == AudioFormat.MP3 ? AudioFormatHelper.RoundToStandardBitrate(bitRate ?? 0) : bitRate) ?? 0,
+                BitDepth = mostCommonBitDepth ?? 0,
+                Bitrate = (codec == AudioFormat.MP3 ? AudioFormatHelper.RoundToStandardBitrate(mostCommonBitRate ?? 0) : mostCommonBitRate) ?? 0,
                 Size = totalSize,
                 Priotity = folderData.CalculatePriority(),
                 CustomString = JsonConvert.SerializeObject(filesToDownload),

Tubifarry/Notifications/QueueCleaner/ImportFailureNotificationService.cs

@@ -0,0 +1,65 @@
+using NLog;
+using NzbDrone.Common.Extensions;
+using NzbDrone.Core.MediaFiles.Events;
+using NzbDrone.Core.Messaging.Events;
+using NzbDrone.Core.Music;
+using NzbDrone.Core.ThingiProvider;
+
+namespace NzbDrone.Core.Notifications
+{
+    public class ImportFailureNotificationService : IHandle<AlbumImportIncompleteEvent>
+    {
+
+        private readonly INotificationFactory _notificationFactory;
+        private readonly INotificationStatusService _notificationStatusService;
+        private readonly Logger _logger;
+
+        public ImportFailureNotificationService(INotificationFactory notificationFactory, INotificationStatusService notificationStatusService, Logger logger)
+        {
+            _notificationFactory = notificationFactory;
+            _notificationStatusService = notificationStatusService;
+            _logger = logger;
+        }
+
+
+        private bool ShouldHandleArtist(ProviderDefinition definition, Artist artist)
+        {
+            if (definition.Tags.Empty())
+            {
+                _logger.Debug("No tags set for this notification.");
+                return true;
+            }
+
+            if (definition.Tags.Intersect(artist.Tags).Any())
+            {
+                _logger.Debug("Notification and artist have one or more intersecting tags.");
+                return true;
+            }
+            _logger.Debug("{0} does not have any intersecting tags with {1}. Notification will not be sent.", definition.Name, artist.Name);
+            return false;
+        }
+
+
+        public void Handle(AlbumImportIncompleteEvent message)
+        {
+            foreach (INotification? notification in _notificationFactory.OnImportFailureEnabled())
+            {
+                if (notification is not QueueCleaner.QueueCleaner queue)
+                    continue;
+                try
+                {
+                    if (ShouldHandleArtist(notification.Definition, message.TrackedDownload.RemoteAlbum.Artist))
+                    {
+                        queue.CleanImport(message);
+                        _notificationStatusService.RecordSuccess(notification.Definition.Id);
+                    }
+                }
+                catch (Exception ex)
+                {
+                    _notificationStatusService.RecordFailure(notification.Definition.Id);
+                    _logger.Warn(ex, "Unable to send CleanImport: " + notification.Definition.Name);
+                }
+            }
+        }
+    }
+}