Merge pull request #46 from Lukeuke/feature/add-kpoplyrics

Added KPopLyrics

Author: skuill

LyricsScraperNET.Client/Program.cs

@@ -1,19 +1,13 @@
-using LyricsScraperNET;
-using LyricsScraperNET.Configuration;
-using LyricsScraperNET.Providers.Abstract;
-using LyricsScraperNET.Providers.AZLyrics;
-using LyricsScraperNET.Providers.Genius;
-using LyricsScraperNET.Providers.SongLyrics;
-using LyricsScraperNET.Providers.LyricFind;
-using LyricsScraperNET.Models.Requests;
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
-using Microsoft.Extensions.Hosting;
+using LyricsScraperNET.Configuration;
+using LyricsScraperNET.Models.Requests;
 using LyricsScraperNET.Models.Responses;
-using System.Threading.Tasks;
-using System;
-using Microsoft.Extensions.Logging;
-using System.Threading;
 
 #pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously
 

LyricsScraperNET.Client/appsettings.json

@@ -22,6 +22,10 @@
     "LyricFindOptions": {
       "SearchPriority": 1,
       "Enabled": true
+    },
+    "KPopLyricsOptions": {
+      "SearchPriority": 5,
+      "Enabled": true
     }
   }
 }

LyricsScraperNET/Configuration/ILyricScraperClientConfig.cs

@@ -24,5 +24,6 @@ public interface ILyricScraperClientConfig
         IExternalProviderOptions SongLyricsOptions { get; }
 
         IExternalProviderOptions LyricFindOptions { get; }
+        IExternalProviderOptions KPopLyricsOptions { get; }
     }
 }

LyricsScraperNET/Configuration/LyricScraperClientConfig.cs

@@ -5,6 +5,7 @@
 using LyricsScraperNET.Providers.Musixmatch;
 using LyricsScraperNET.Providers.SongLyrics;
 using System.Text.Json.Serialization;
+using LyricsScraperNET.Providers.KPopLyrics;
 
 namespace LyricsScraperNET.Configuration
 {
@@ -23,6 +24,8 @@ public sealed class LyricScraperClientConfig : ILyricScraperClientConfig
 
         public IExternalProviderOptions LyricFindOptions { get; set; } = new LyricFindOptions();
 
+        public IExternalProviderOptions KPopLyricsOptions { get; set; } = new KPopLyricsOptions();
+
         /// <inheritdoc />
         public bool UseParallelSearch { get; set; } = false;
 
@@ -31,6 +34,7 @@ public sealed class LyricScraperClientConfig : ILyricScraperClientConfig
             || GeniusOptions.Enabled
             || MusixmatchOptions.Enabled
             || SongLyricsOptions.Enabled
-            || LyricFindOptions.Enabled;
+            || LyricFindOptions.Enabled
+            || KPopLyricsOptions.Enabled;
     }
 }

LyricsScraperNET/Configuration/ServiceCollectionExtensions.cs

@@ -4,6 +4,7 @@
 using LyricsScraperNET.Providers.LyricFind;
 using LyricsScraperNET.Providers.Musixmatch;
 using LyricsScraperNET.Providers.SongLyrics;
+using LyricsScraperNET.Providers.KPopLyrics;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;
@@ -24,6 +25,7 @@ public static IServiceCollection AddLyricScraperClientService(
                 services.AddProvider<GeniusOptions, GeniusProvider>(lyricScraperClientConfig);
                 services.AddProvider<SongLyricsOptions, SongLyricsProvider>(lyricScraperClientConfig);
                 services.AddProvider<LyricFindOptions, LyricFindProvider>(lyricScraperClientConfig);
+                services.AddProvider<KPopLyricsOptions, KPopLyricsProvider>(lyricScraperClientConfig);
 
                 services.AddMusixmatchService(lyricScraperClientConfig);
 

LyricsScraperNET/Extensions/LyricsScraperClientExtensions.cs

@@ -1,5 +1,6 @@
 using LyricsScraperNET.Providers.AZLyrics;
 using LyricsScraperNET.Providers.Genius;
+using LyricsScraperNET.Providers.KPopLyrics;
 using LyricsScraperNET.Providers.LyricFind;
 using LyricsScraperNET.Providers.Models;
 using LyricsScraperNET.Providers.Musixmatch;
@@ -39,6 +40,12 @@ public static ILyricsScraperClient WithLyricFind(this ILyricsScraperClient lyric
             return lyricsScraperClient;
         }
 
+        public static ILyricsScraperClient WithKPopLyrics(this ILyricsScraperClient lyricsScraperClient)
+        {
+            lyricsScraperClient.AddProvider(new KPopLyricsProvider());
+            return lyricsScraperClient;
+        }
+
         /// <summary>
         /// Configure LyricsScraperClient with all available providers in <seealso cref="ExternalProviderType"/>.
         /// Search lyrics enabled by default for all providers.
@@ -50,7 +57,8 @@ public static ILyricsScraperClient WithAllProviders(this ILyricsScraperClient ly
                 .WithAZLyrics()
                 .WithMusixmatch()
                 .WithSongLyrics()
-                .WithLyricFind();
+                .WithLyricFind()
+                .WithKPopLyrics();
         }
     }
 }

LyricsScraperNET/Extensions/StringExtensions.cs

@@ -71,5 +71,38 @@ public static string СonvertToDashedFormat(this string input, bool useException
 
             return result;
         }
+
+        public static string CreateCombinedUrlSlug(string artist, string songTitle)
+        {
+            artist = Regex.Replace(artist, @"\([^a-zA-Z0-9\s]*\)", "").Trim();
+            songTitle = Regex.Replace(songTitle, @"\([^a-zA-Z0-9\s]*\)", "").Trim();
+
+            var combined = $"{artist} {songTitle}";
+
+            var slug = string.Empty;
+
+            foreach (var c in combined)
+            {
+                switch (c)
+                {
+                    case ' ':
+                        slug += '-';
+                        break;
+                    case >= 'a' and <= 'z':
+                    case >= 'A' and <= 'Z':
+                    case >= '0' and <= '9':
+                        slug += c;
+                        break;
+                    case '-':
+                        slug += '-';
+                        break;
+                }
+            }
+
+            slug = Regex.Replace(slug, @"-+", "-");
+            slug = slug.Trim('-');
+
+            return slug.ToLower();
+        }
     }
 }

LyricsScraperNET/Providers/KPopLyrics/KPopLyricsOptions.cs

@@ -0,0 +1,29 @@
+using LyricsScraperNET.Providers.Abstract;
+using LyricsScraperNET.Providers.Models;
+
+namespace LyricsScraperNET.Providers.KPopLyrics
+{
+    public class KPopLyricsOptions : IExternalProviderOptions
+    {
+        public ExternalProviderType ExternalProviderType => ExternalProviderType.KPopLyrics;
+        public bool Enabled { get; set; }
+        public int SearchPriority { get; set; } = 5;
+        public string ConfigurationSectionName => "KPopLyricsOptions";
+
+        public override bool Equals(object? obj)
+        {
+            return obj is KPopLyricsOptions options &&
+                   ExternalProviderType == options.ExternalProviderType;
+        }
+
+        public override int GetHashCode()
+        {
+            unchecked
+            {
+                int hash = 17;
+                hash = (hash * 31) + ExternalProviderType.GetHashCode();
+                return hash;
+            }
+        }
+    }
+}

LyricsScraperNET/Providers/KPopLyrics/KPopLyricsParser.cs

@@ -0,0 +1,26 @@
+using System.Linq;
+using System.Text.RegularExpressions;
+using HtmlAgilityPack;
+using LyricsScraperNET.Providers.Abstract;
+
+namespace LyricsScraperNET.Providers.KPopLyrics
+{
+    public class KPopLyricsParser : IExternalProviderLyricParser
+    {
+        public string Parse(string lyric)
+        {
+            var htmlDoc = new HtmlDocument();
+            htmlDoc.LoadHtml(lyric);
+
+            var deEntitizedText = string.Join("\n\n", // <p> -> \n\n
+                htmlDoc.DocumentNode.SelectNodes("//p")
+                    .Select(node => HtmlEntity.DeEntitize(node.InnerHtml
+                        .Replace("<br> ", "\n") // the trailing whitespace after <br> is necessary
+                        .Trim()
+                    )));
+            
+            // remove the tags that are left and trim the text
+            return Regex.Replace(deEntitizedText, "<.*?>", string.Empty).Trim();
+        }
+    }
+}