MediaBrowser.Providers/Plugins/ListenBrainz/ListenBrainzPlugin.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

using System;
using System.Collections.Generic;
using MediaBrowser.Common.Configuration;
using MediaBrowser.Common.Plugins;
using MediaBrowser.Controller.Plugins;
using MediaBrowser.Model.Plugins;
using MediaBrowser.Model.Serialization;
using MediaBrowser.Providers.Plugins.ListenBrainz.Configuration;

namespace MediaBrowser.Providers.Plugins.ListenBrainz;

/// <summary>
/// ListenBrainz plugin instance.
/// </summary>
public class ListenBrainzPlugin : BasePlugin<PluginConfiguration>, IHasWebPages, IHasEmbeddedImage
{
    /// <summary>
    /// Initializes a new instance of the <see cref="ListenBrainzPlugin"/> class.
    /// </summary>
    /// <param name="applicationPaths">Instance of the <see cref="IApplicationPaths"/> interface.</param>
    /// <param name="xmlSerializer">Instance of the <see cref="IXmlSerializer"/> interface.</param>
    public ListenBrainzPlugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer)
        : base(applicationPaths, xmlSerializer)
    {
        Instance = this;
    }

    /// <summary>
    /// Gets the current plugin instance.
    /// </summary>
    public static ListenBrainzPlugin? Instance { get; private set; }

    /// <inheritdoc />
    public override Guid Id => new("a5b2e8c1-9d4f-4a3b-8c7e-6f1a2b3c4d5e");

    /// <inheritdoc />
    public override string Name => "ListenBrainz Similarity Provider";

    /// <inheritdoc />
    public override string Description => "Get similar artist recommendations from ListenBrainz Labs.";

    /// <inheritdoc />
    public override string ConfigurationFileName => "Jellyfin.Plugin.ListenBrainz.xml";

    /// <inheritdoc />
    public string ImageResourceName => GetType().Namespace + ".Configuration.ListenBrainz_logo.svg";

    /// <inheritdoc />
    public IEnumerable<PluginPageInfo> GetPages()
    {
        var resourcePrefix = GetType().Namespace + ".Configuration.";
        yield return new PluginPageInfo
        {
            Name = Name,
            EmbeddedResourcePath = resourcePrefix + "config.html"
        };
        yield return new PluginPageInfo
        {
            Name = Name + "Notice",
            EmbeddedResourcePath = resourcePrefix + "NOTICE.md"
        };
    }
}