plugin collectors

AlexanderDotH · May 4, 2023 · 4c6643c · 4c6643c
1 parent b42d88d
commit 4c6643c
Show file tree

Hide file tree

Showing 7 changed files with 136 additions and 9 deletions.
diff --git a/OpenLyricsClient/Backend/Collector/Artwork/Providers/Plugin/PluginArtworkCollector.cs b/OpenLyricsClient/Backend/Collector/Artwork/Providers/Plugin/PluginArtworkCollector.cs
@@ -0,0 +1,39 @@
+using OpenLyricsClient.Backend.Plugins;
+using OpenLyricsClient.Backend.Structure.Song;
+using System.Linq;
+using System.Threading.Tasks;
+
+namespace OpenLyricsClient.Backend.Collector.Artwork.Providers.Plugin
+{
+    internal class PluginArtworkCollector : IArtworkCollector
+    {
+        public string CollectorName()
+        {
+            return "Plugin";
+        }
+
+        async public Task<Structure.Artwork.Artwork> GetArtwork(SongResponseObject songResponseObject)
+        {
+            Structure.Artwork.Artwork collectedData = new Structure.Artwork.Artwork();
+            foreach (IPlugin plugin in Core.INSTANCE.PluginManager.GetPluginsByScope(PluginScope.ArtworkCollector).OrderByDescending((IPlugin plugin) => plugin.GetCollectedArtworkQuality()))
+            {
+                Structure.Artwork.Artwork? data = await plugin.CollectArtwork(songResponseObject);
+                if (data != null && data != collectedData)
+                {
+                    collectedData = data;
+                    break;
+                }
+            }
+            return collectedData;
+        }
+
+        public int Quality()
+        {
+            IPlugin? plugin = Core.INSTANCE.PluginManager.GetPluginsByScope(PluginScope.ArtworkCollector).MaxBy((IPlugin plugin) => plugin.GetCollectedArtworkQuality());
+            if (plugin == null)
+                return -1;
+            else
+                return plugin.GetCollectedArtworkQuality();
+        }
+    }
+}
diff --git a/OpenLyricsClient/Backend/Collector/Lyrics/LyricCollector.cs b/OpenLyricsClient/Backend/Collector/Lyrics/LyricCollector.cs
@@ -6,6 +6,7 @@
 using OpenLyricsClient.Backend.Collector.Lyrics.Providers.NetEase;
 using OpenLyricsClient.Backend.Collector.Lyrics.Providers.NetEaseV2;
 using OpenLyricsClient.Backend.Collector.Lyrics.Providers.OpenLyricsClient;
+using OpenLyricsClient.Backend.Collector.Lyrics.Providers.Plugin;
 using OpenLyricsClient.Backend.Collector.Lyrics.Providers.Textyl;
 using OpenLyricsClient.Backend.Events;
 using OpenLyricsClient.Backend.Events.EventArgs;
@@ -35,6 +36,7 @@ public LyricCollector()
             this._lyricCollectors.Add(new NetEaseV2Collector());
             this._lyricCollectors.Add(new TextylCollector());
             this._lyricCollectors.Add(new OpenLyricsClientCollector());
+            this._lyricCollectors.Add(new PluginLyricsCollector());
         }
 
         public async Task CollectLyrics(SongResponseObject songResponseObject)
@@ -63,8 +65,8 @@ public async Task CollectLyrics(SongResponseObject songResponseObject)
                 if (lyricData.LyricReturnCode != LyricReturnCode.SUCCESS)
                     continue;
 
-                foreach (IPlugin plugin in Core.INSTANCE.PluginManager.GetPlugins().Where((plugin) => plugin.Scope.HasFlag(PluginScope.LyricsPostprocess)))
-                    lyricData = plugin.ProcessLyrics(songResponseObject, lyricData);
+                foreach (IPlugin plugin in Core.INSTANCE.PluginManager.GetPluginsByScope(PluginScope.LyricsPostprocess))
+                    lyricData = await plugin.ProcessLyrics(songResponseObject, lyricData);
 
                 Core.INSTANCE.CacheManager.WriteToCache(songResponseObject.SongRequestObject, lyricData);
                 return;

diff --git a/OpenLyricsClient/Backend/Collector/Lyrics/Providers/Plugin/PluginLyricsCollector.cs b/OpenLyricsClient/Backend/Collector/Lyrics/Providers/Plugin/PluginLyricsCollector.cs
@@ -0,0 +1,40 @@
+using OpenLyricsClient.Backend.Plugins;
+using OpenLyricsClient.Backend.Structure.Lyrics;
+using OpenLyricsClient.Backend.Structure.Song;
+using System.Linq;
+using System.Threading.Tasks;
+
+namespace OpenLyricsClient.Backend.Collector.Lyrics.Providers.Plugin
+{
+    internal class PluginLyricsCollector : ILyricsCollector
+    {
+        public string CollectorName()
+        {
+            return "Plugin";
+        }
+
+        public async Task<LyricData> GetLyrics(SongResponseObject songResponseObject)
+        {
+            LyricData collectedData = new LyricData();
+            foreach (IPlugin plugin in Core.INSTANCE.PluginManager.GetPluginsByScope(PluginScope.LyricsCollector).OrderByDescending((IPlugin plugin) => plugin.GetCollectedLyricsQuality()))
+            {
+                LyricData? data = await plugin.CollectLyrics(songResponseObject);
+                if (data != null && data != collectedData)
+                {
+                    collectedData = data;
+                    break;
+                }
+            }
+            return collectedData;
+        }
+
+        public int ProviderQuality()
+        {
+            IPlugin? plugin = Core.INSTANCE.PluginManager.GetPluginsByScope(PluginScope.LyricsCollector).MaxBy((IPlugin plugin) => plugin.GetCollectedLyricsQuality());
+            if (plugin == null)
+                return -1;
+            else
+                return plugin.GetCollectedLyricsQuality();
+        }
+    }
+}
diff --git a/OpenLyricsClient/Backend/Collector/Song/Providers/Plugin/PluginSongCollector.cs b/OpenLyricsClient/Backend/Collector/Song/Providers/Plugin/PluginSongCollector.cs
@@ -0,0 +1,39 @@
+using OpenLyricsClient.Backend.Plugins;
+using OpenLyricsClient.Backend.Structure.Song;
+using System.Linq;
+using System.Threading.Tasks;
+
+namespace OpenLyricsClient.Backend.Collector.Song.Providers.Plugin
+{
+    internal class PluginSongCollector : ISongCollector
+    {
+        public string CollectorName()
+        {
+            return "Plugin";
+        }
+
+        async public Task<SongResponseObject> GetSong(SongRequestObject songRequestObject)
+        {
+            SongResponseObject collectedData = new SongResponseObject();
+            foreach (IPlugin plugin in Core.INSTANCE.PluginManager.GetPluginsByScope(PluginScope.SongCollector).OrderByDescending((IPlugin plugin) => plugin.GetCollectedSongQuality()))
+            {
+                SongResponseObject? data = await plugin.CollectSong(songRequestObject);
+                if (data != null && data != collectedData)
+                {
+                    collectedData = data;
+                    break;
+                }
+            }
+            return collectedData;
+        }
+
+        public int ProviderQuality()
+        {
+            IPlugin? plugin = Core.INSTANCE.PluginManager.GetPluginsByScope(PluginScope.SongCollector).MaxBy((IPlugin plugin) => plugin.GetCollectedSongQuality());
+            if (plugin == null)
+                return -1;
+            else
+                return plugin.GetCollectedSongQuality();
+        }
+    }
+}
diff --git a/OpenLyricsClient/Backend/Plugins/IPlugin.cs b/OpenLyricsClient/Backend/Plugins/IPlugin.cs
@@ -11,6 +11,12 @@ namespace OpenLyricsClient.Backend.Plugins
     public interface IPlugin
     {
         PluginScope Scope { get; }
-        LyricData ProcessLyrics(SongResponseObject songResponse, LyricData lyrics);
+        Task<LyricData> ProcessLyrics(SongResponseObject songResponse, LyricData lyrics);
+        Task<LyricData?> CollectLyrics(SongResponseObject songResponseObject);
+        int GetCollectedLyricsQuality();
+        Task<SongResponseObject?> CollectSong(SongRequestObject songRequestObject);
+        int GetCollectedSongQuality();
+        Task<Structure.Artwork.Artwork?> CollectArtwork(SongResponseObject songResponseObject);
+        int GetCollectedArtworkQuality();
     }
 }
diff --git a/OpenLyricsClient/Backend/Plugins/PluginManager.cs b/OpenLyricsClient/Backend/Plugins/PluginManager.cs
@@ -44,6 +44,8 @@ public void LoadPlugins()
             }
         }
 
-        public List<IPlugin> GetPlugins() => _plugins;
+        public IEnumerable<IPlugin> GetPlugins() => _plugins;
+
+        public IEnumerable<IPlugin> GetPluginsByScope(PluginScope scope) => GetPlugins().Where((plugin) => plugin.Scope.HasFlag(scope));
     }
 }
diff --git a/OpenLyricsClient/Backend/Plugins/PluginScope.cs b/OpenLyricsClient/Backend/Plugins/PluginScope.cs
@@ -1,8 +1,4 @@
 using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace OpenLyricsClient.Backend.Plugins
 {
@@ -11,6 +7,9 @@ public enum PluginScope
     {
         Dummy = 1,
         LyricsPostprocess = 2,
-        LyricsViewRendering = 4
+        LyricsViewRendering = 4,
+        LyricsCollector = 8,
+        SongCollector = 16,
+        ArtworkCollector = 32
     }
 }