Implement Soulseek support via Slskd

* Basic Slskd Indexer Support

* Basic Slskd Download Provider

* Refactor classes and fix issues

Author: TypNull

.github/workflows/build.yml

@@ -32,6 +32,23 @@ jobs:
           echo "Extracted version: $TAG_VERSION"
           echo "PACKAGE_VERSION=$TAG_VERSION" >> $GITHUB_ENV
 
+          # Log the extracted version
+          echo "Version: $TAG_VERSION"
+
+          # Check if the version is a pre-release (starts with 0.)
+          if [[ "$TAG_VERSION" == 0.* ]]; then
+            echo "This is a pre-release version."
+            echo "IS_PRERELEASE=true" >> $GITHUB_ENV
+          else
+            echo "This is a stable release."
+            echo "IS_PRERELEASE=false" >> $GITHUB_ENV
+          fi
+
+      - name: Log version and pre-release status
+        run: |
+          echo "Version: $PACKAGE_VERSION"
+          echo "Is Pre-release: $IS_PRERELEASE"
+
       - name: Extract repository name without owner
         id: extract_repo_name
         run: |
@@ -92,6 +109,7 @@ jobs:
         run: |
           echo "COMMIT_MESSAGES: $COMMIT_MESSAGES"
           echo "TAG_DESCRIPTION: $TAG_DESCRIPTION"
+          echo "IS_PRERELEASE: $IS_PRERELEASE"
 
       - name: Create GitHub Release and Upload Artifact
         uses: softprops/action-gh-release@v1
@@ -107,4 +125,4 @@ jobs:
             ### 📦 **Artifact**
             The plugin artifact is attached to this release. Download it below!
           files: |
-            ${{ steps.find_plugin_dir.outputs.PLUGIN_OUTPUT_DIR }}/${{ env.PLUGIN_NAME }}-v${{ env.PACKAGE_VERSION }}.${{ matrix.framework }}.zip
+            ${{ steps.find_plugin_dir.outputs.PLUGIN_OUTPUT_DIR }}/${{ env.PLUGIN_NAME }}-v${{ env.PACKAGE_VERSION }}.${{ matrix.framework }}.zip

README.md

@@ -1,9 +1,10 @@
+Here’s the complete README with the added short notice under the **Troubleshooting** section:
 # Tubifarry for Lidarr 🎶  
 ![Downloads](https://img.shields.io/github/downloads/TypNull/Tubifarry/total)  ![GitHub release (latest by date)](https://img.shields.io/github/v/release/TypNull/Tubifarry)  ![GitHub last commit](https://img.shields.io/github/last-commit/TypNull/Tubifarry)  ![License](https://img.shields.io/github/license/TypNull/Tubifarry)  ![GitHub stars](https://img.shields.io/github/stars/TypNull/Tubifarry)  
 
-Tubifarry is a plugin for **Lidarr** that fetches metadata from **Spotify** and **YouTube**, enabling direct music downloads from YouTube. Built on the foundation of trevTV's projects, it leverages the YouTube API for seamless integration. 🛠️  
+Tubifarry is a versatile plugin for **Lidarr** that enhances your music library by fetching metadata from **Spotify** and enabling direct music downloads from **YouTube**. While it is not explicitly a Spotify-to-YouTube downloader, it leverages the YouTube API to seamlessly integrate music downloads into your Lidarr setup. Built on the foundation of trevTV's projects, Tubifarry also supports **Slskd**, the Soulseek client, as both an **indexer** and **downloader**, allowing you to tap into the vast music collection available on the Soulseek network. 🛠️  
 
-Additionally, Tubifarry supports fetching soundtracks from **Sonarr** (series) and **Radarr** (movies) and adding them to Lidarr using the **Arr-Soundtracks** import list feature. This allows you to easily manage and download soundtracks for your favorite movies and TV shows. 🎬🎵  
+Additionally, Tubifarry supports fetching soundtracks from **Sonarr** (series) and **Radarr** (movies) and adding them to Lidarr using the **Arr-Soundtracks** import list feature. This makes it easy to manage and download soundtracks for your favorite movies and TV shows. 🎬🎵  
 
 ---
 
@@ -26,40 +27,39 @@ To switch to the Plugins Branch:
 ---
 
 ### Plugin Installation 📥  
-
-#### **For Docker Users**:  
-1. **Install the Plugin**:  
-   - In Lidarr, go to `System -> Plugins`.  
-   - Paste `https://github.com/TypNull/Tubifarry` into the GitHub URL box and click **Install**.  
-
-2. **Configure the Indexer**:  
-   - Navigate to `Settings -> Indexers` and click **Add**.  
-   - In the modal, select `Tubifarry` (located under **Other** at the bottom).  
-
-3. **Set Up the Download Client**:  
-   - Go to `Settings -> Download Clients` and click **Add**.  
-   - In the modal, choose `Youtube` (under **Other** at the bottom).  
-   - Set the download path and adjust other settings as needed.  
-   - **Optional**: If using FFmpeg, ensure the FFmpeg path is correctly configured.  
+- In Lidarr, go to `System -> Plugins`.  
+- Paste `https://github.com/TypNull/Tubifarry` into the GitHub URL box and click **Install**.  
 
 ---
 
-### Fetching Soundtracks from Sonarr and Radarr 🎬🎵  
-Tubifarry also supports fetching soundtracks from **Sonarr** (for TV series) and **Radarr** (for movies) and adding them to Lidarr using the **Arr-Soundtracks** import list feature. This allows you to easily manage and download soundtracks for your favorite movies and TV shows.  
+### Soulseek (Slskd) Setup 🎧  
+Tubifarry supports **Slskd**, the Soulseek client, as both an **indexer** and **downloader**. Follow the steps below to configure it.  
 
-To enable this feature:  
-1. **Set Up the Import List**:  
-   - Navigate to `Settings -> Import Lists` in Lidarr.  
-   - Add a new import list and select the option for **Arr-Soundtracks**.  
-   - Configure the settings to match your Sonarr and Radarr instances.  
-   - Provide a cache path to store responses from MusicBrainz for faster lookups.  
+#### **Setting Up the Soulseek Indexer**:  
+1. Navigate to `Settings -> Indexers` and click **Add**.  
+2. Select `Slskd` from the list of indexers.  
+3. Configure the following settings:  
+   - **URL**: The URL of your Slskd instance (e.g., `http://localhost:5030`).  
+   - **API Key**: The API key for your Slskd instance (found in Slskd's settings under 'Options').  
+   - **Include Only Audio Files**: Enable to filter search results to audio files only (beta).  
 
-2. **Enjoy Soundtracks**:  
-   - Once configured, Tubifarry will automatically fetch soundtracks from your Sonarr and Radarr libraries and add them to Lidarr for download and management.  
+#### **Setting Up the Soulseek Download Client**:  
+1. Go to `Settings -> Download Clients` and click **Add**.  
+2. Select `Slskd` from the list of download clients.  
+3. Set the **download path** where downloaded files will be downloaded.  
 
 ---
 
-### Optional: FFmpeg and Audio Quality 🎧  
+### YouTube Downloader Setup 🎥  
+Tubifarry allows you to download music directly from YouTube. Follow the steps below to configure the YouTube downloader.  
+
+#### **Setting Up the YouTube Download Client**:  
+1. Go to `Settings -> Download Clients` and click **Add**.  
+2. Select `Youtube` from the list of download clients.  
+3. Set the download path and adjust other settings as needed.  
+4. **Optional**: If using FFmpeg, ensure the FFmpeg path is correctly configured.  
+
+#### **FFmpeg and Audio Conversion**:  
 1. **FFmpeg**: FFmpeg can be used to extract audio from downloaded files, which are typically embedded in MP4 containers. If you choose to use FFmpeg, ensure it is installed and accessible in your system's PATH or the specified FFmpeg path. If not, the plugin does attempt to download it automatically during setup. Without FFmpeg, songs will be downloaded in their original format, which may not require additional processing.  
 
    **Important Note**: If FFmpeg is not used, Lidarr may incorrectly interpret the MP4 container as corrupt. While FFmpeg usage is **recommended**, it is not strictly necessary. However, to avoid potential issues, you can choose to extract audio without re-encoding, but this may lead to better compatibility with Lidarr.
@@ -76,7 +76,23 @@ To enable this feature:
 
 ---
 
+### Fetching Soundtracks from Sonarr and Radarr 🎬🎵  
+Tubifarry also supports fetching soundtracks from **Sonarr** (for TV series) and **Radarr** (for movies) and adding them to Lidarr using the **Arr-Soundtracks** import list feature. This allows you to easily manage and download soundtracks for your favorite movies and TV shows.  
+
+To enable this feature:  
+1. **Set Up the Import List**:  
+   - Navigate to `Settings -> Import Lists` in Lidarr.  
+   - Add a new import list and select the option for **Arr-Soundtracks**.  
+   - Configure the settings to match your Sonarr and Radarr instances.  
+   - Provide a cache path to store responses from MusicBrainz for faster lookups.  
+
+2. **Enjoy Soundtracks**:  
+   - Once configured, Tubifarry will automatically fetch soundtracks from your Sonarr and Radarr libraries and add them to Lidarr for download and management.  
+
+---
+
 ### 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).  
 - **No Release Found**: If no release is found, YouTube might flag the plugin as a bot (which it technically is). To avoid this and access higher-quality audio, you can log in using cookies.  
@@ -90,7 +106,7 @@ To enable this feature:
 ---
 
 ## Acknowledgments 🙌  
-Special thanks to **trevTV** for laying the groundwork with [Lidarr.Plugin.Tidal](https://github.com/TrevTV/Lidarr.Plugin.Tidal), [Lidarr.Plugin.Deezer](https://github.com/TrevTV/Lidarr.Plugin.Deezer), and [Lidarr.Plugin.Qobuz](https://github.com/TrevTV/Lidarr.Plugin.Qobuz). Additionally, thanks to [IcySnex/YouTubeMusicAPI](https://github.com/IcySnex/YouTubeMusicAPI) for providing the YouTube API. 🎉  
+Special thanks to [**trevTV**](https://github.com/TrevTV) for laying the groundwork with his plugins. Additionally, thanks to [**IcySnex**](https://github.com/IcySnex) for providing the YouTube API. 🎉  
 
 ---
 
@@ -100,8 +116,8 @@ If you'd like to contribute to Tubifarry, feel free to open issues or submit pul
 ---
 
 ## License 📄  
-Tubifarry is licensed under the MIT License. See the [LICENSE](https://github.com/TypNull/Tubifarry/blob/main/LICENSE) file for more details.  
+Tubifarry is licensed under the MIT License. See the [LICENSE](https://github.com/TypNull/Tubifarry/blob/master/LICENSE) file for more details.  
 
 ---
 
-Enjoy seamless music downloads with Tubifarry! 🎧  
+Enjoy seamless music downloads with Tubifarry! 🎧

…farry/Blocklisting/TubifarryBlocklist.cs Tubifarry/Blocklisting/BaseBlocklist.csTubifarry/Blocklisting/TubifarryBlocklist.cs renamed to Tubifarry/Blocklisting/BaseBlocklist.cs Tubifarry/Blocklisting/TubifarryBlocklist.cs renamed to Tubifarry/Blocklisting/BaseBlocklist.cs

@@ -5,15 +5,15 @@
 
 namespace NzbDrone.Core.Blocklisting
 {
-    public class TubifarryBlocklist : IBlocklistForProtocol
+    public abstract class BaseBlocklist<TProtocol> : IBlocklistForProtocol where TProtocol : IDownloadProtocol
     {
         private readonly IBlocklistRepository _blocklistRepository;
 
-        public TubifarryBlocklist(IBlocklistRepository blocklistRepository) => _blocklistRepository = blocklistRepository;
+        public BaseBlocklist(IBlocklistRepository blocklistRepository) => _blocklistRepository = blocklistRepository;
 
-        public string Protocol => nameof(YoutubeDownloadProtocol);
+        public string Protocol => nameof(TProtocol);
 
-        public bool IsBlocklisted(int artistId, ReleaseInfo release) => _blocklistRepository.BlocklistedByTorrentInfoHash(artistId, release.Guid).Any(b => SameRelease(b, release));
+        public bool IsBlocklisted(int artistId, ReleaseInfo release) => _blocklistRepository.BlocklistedByTorrentInfoHash(artistId, release.Guid).Any(b => BaseBlocklist<TProtocol>.SameRelease(b, release));
 
         public Blocklist GetBlocklist(DownloadFailedEvent message) => new()
         {
@@ -30,7 +30,6 @@ public class TubifarryBlocklist : IBlocklistForProtocol
             TorrentInfoHash = message.Data.GetValueOrDefault("guid")
         };
 
-        private bool SameRelease(Blocklist item, ReleaseInfo release) => release.Guid.IsNotNullOrWhiteSpace() ? release.Guid.Equals(item.TorrentInfoHash) : item.Indexer.Equals(release.Indexer, StringComparison.InvariantCultureIgnoreCase);
-
+        private static bool SameRelease(Blocklist item, ReleaseInfo release) => release.Guid.IsNotNullOrWhiteSpace() ? release.Guid.Equals(item.TorrentInfoHash) : item.Indexer.Equals(release.Indexer, StringComparison.InvariantCultureIgnoreCase);
     }
 }

Tubifarry/Blocklisting/Blocklists.cs

@@ -0,0 +1,14 @@
+using NzbDrone.Core.Indexers;
+
+namespace NzbDrone.Core.Blocklisting
+{
+    public class YoutubeBlocklist : BaseBlocklist<YoutubeDownloadProtocol>
+    {
+        public YoutubeBlocklist(IBlocklistRepository blocklistRepository) : base(blocklistRepository) { }
+    }
+
+    public class SoulseekBlocklist : BaseBlocklist<SoulseekDownloadProtocol>
+    {
+        public SoulseekBlocklist(IBlocklistRepository blocklistRepository) : base(blocklistRepository) { }
+    }
+}

Tubifarry/Core/AlbumData.cs

@@ -9,49 +9,58 @@ namespace Tubifarry.Core
     /// </summary>
     public class AlbumData
     {
+        public string IndexerName { get; }
         // Mixed
         public string AlbumId { get; set; } = string.Empty;
 
         // Properties from AlbumInfo
         public string AlbumName { get; set; } = string.Empty;
         public string ArtistName { get; set; } = string.Empty;
-        public string SpotifyUrl { get; set; } = string.Empty;
+        public string InfoUrl { get; set; } = string.Empty;
         public string ReleaseDate { get; set; } = string.Empty;
         public DateTime ReleaseDateTime { get; set; }
         public string ReleaseDatePrecision { get; set; } = string.Empty;
         public int TotalTracks { get; set; }
         public bool ExplicitContent { get; set; }
-        public string CoverUrl { get; set; } = string.Empty;
+        public string CustomString { get; set; } = string.Empty;
         public string CoverResolution { get; set; } = string.Empty;
 
-
         // Properties from YoutubeSearchResults
         public int Bitrate { get; set; }
         public long Duration { get; set; }
 
-        //Not used
+        // Soulseek
+        public long? Size { get; set; }
+        public int Priotity { get; set; }
+
+        // Not used
         public AudioFormat Codec { get; set; } = AudioFormat.AAC;
 
+        public AlbumData(string name) => IndexerName = name;
+
         /// <summary>
         /// Converts AlbumData into a ReleaseInfo object.
         /// </summary>
         public ReleaseInfo ToReleaseInfo() => new()
         {
-            Guid = $"Tubifarry-{AlbumId}-{Bitrate}",
+            Guid = $"{IndexerName}-{AlbumId}-{Bitrate}",
             Artist = ArtistName,
             Album = AlbumName,
             DownloadUrl = AlbumId,
-            InfoUrl = SpotifyUrl,
-            PublishDate = ReleaseDateTime,
+            InfoUrl = InfoUrl,
+            PublishDate = ReleaseDateTime == DateTime.MinValue ? DateTime.UtcNow : ReleaseDateTime,
             DownloadProtocol = nameof(YoutubeDownloadProtocol),
             Title = ConstructTitle(),
             Codec = Codec.ToString(),
             Resolution = CoverResolution,
-            Source = CoverUrl,
+            Source = CustomString,
             Container = Bitrate.ToString(),
-            Size = (Duration > 0 ? Duration : TotalTracks * 300) * Bitrate * 1000 / 8
+            Size = Size ?? (Duration > 0 ? Duration : TotalTracks * 300) * Bitrate * 1000 / 8
         };
 
+        /// <summary>
+        /// Parses the release date based on the precision.
+        /// </summary>
         public void ParseReleaseDate() => ReleaseDateTime = ReleaseDatePrecision switch
         {
             "year" => new DateTime(int.Parse(ReleaseDate), 1, 1),
@@ -67,19 +76,23 @@ public class AlbumData
         private string ConstructTitle()
         {
             string normalizedAlbumName = NormalizeAlbumName(AlbumName);
-            // Start with the basic format: Artist - Album
+
             string title = $"{ArtistName} - {normalizedAlbumName}";
 
-            // Add the release year if available
-            if (ReleaseDateTime.Year > 0)
+            if (ReleaseDateTime != DateTime.MinValue)
                 title += $" - {ReleaseDateTime.Year}";
 
-            // Add the explicit content indicator if applicable
             if (ExplicitContent)
                 title += " [Explicit]";
 
-            // Add the bitrate and source type
-            title += $" [{Codec} {Bitrate}kbps] [WEB]";
+            int calculatedBitrate = Bitrate;
+            if (calculatedBitrate <= 0 && Size.HasValue && Duration > 0)
+                calculatedBitrate = (int)((Size.Value * 8) / (Duration * 1000));
+
+            if (AudioFormatHelper.IsLossyFormat(Codec))
+                title += $" [{Codec} {calculatedBitrate}kbps] [WEB]";
+            else
+                title += $" [{Codec}] [WEB]";
 
             return title;
         }
@@ -89,21 +102,16 @@ private string ConstructTitle()
         /// </summary>
         /// <param name="albumName">The album name to normalize.</param>
         /// <returns>The normalized album name.</returns>
-        private string NormalizeAlbumName(string albumName)
+        private static string NormalizeAlbumName(string albumName)
         {
-            // Handle featuring artists (e.g., "feat.", "ft.", "Feat.", "Ft.", etc.)
             Regex featRegex = new(@"(?i)\b(feat\.|ft\.|featuring)\b", RegexOptions.IgnoreCase);
             if (featRegex.IsMatch(albumName))
             {
-                // Extract the featuring artist(s)
                 Match match = featRegex.Match(albumName);
                 string featuringArtist = albumName.Substring(match.Index + match.Length).Trim();
 
-                // Format the featuring artist(s) in a consistent way
                 albumName = $"{albumName.Substring(0, match.Index).Trim()} (feat. {featuringArtist})";
             }
-
-            // Replace content inside parentheses (except for featuring artists) with curly braces
             albumName = Regex.Replace(albumName, @"\((?!feat\.)[^)]*\)", match => $"{{{match.Value.Trim('(', ')')}}}");
 
             return albumName;