jRay/Jellyfin.Plugin.JRay/Plugin.cs

using System;
using System.Collections.Generic;
using System.Globalization;
using Jellyfin.Plugin.JRay.Configuration;
using Jellyfin.Plugin.JRay.Services;
using MediaBrowser.Common.Configuration;
using MediaBrowser.Common.Plugins;
using MediaBrowser.Model.Plugins;
using MediaBrowser.Model.Serialization;
using Microsoft.Extensions.Logging;

namespace Jellyfin.Plugin.JRay;

/// <summary>
/// The main plugin.
/// </summary>
public class Plugin : BasePlugin<PluginConfiguration>, IHasWebPages
{
    private readonly ILogger<Plugin> _logger;
    private readonly bool _usingFileTransformation;

    /// <summary>
    /// Initializes a new instance of the <see cref="Plugin"/> class.
    /// </summary>
    /// <param name="applicationPaths">Instance of the <see cref="IApplicationPaths"/> interface.</param>
    /// <param name="xmlSerializer">Instance of the <see cref="IXmlSerializer"/> interface.</param>
    /// <param name="logger">The logger.</param>
    public Plugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer, ILogger<Plugin> logger)
        : base(applicationPaths, xmlSerializer)
    {
        Instance = this;
        _logger = logger;

        // The File Transformation plugin rewrites index.html as it is served.
        // Registration is unconditional: the transformation itself checks
        // EnableOverlay at request time, so toggling the setting takes effect
        // without re-registering.
        _usingFileTransformation = FileTransformationRegistration.TryRegister(_logger);

        if (!_usingFileTransformation)
        {
            _logger.LogWarning(
                "JRay: the pause overlay is disabled because the File Transformation plugin " +
                "is not available. Install it from " +
                "https://github.com/IAmParadox27/jellyfin-plugin-file-transformation. " +
                "All other JRay features are unaffected.");
        }

        // JRay never injects into index.html. This only ever *removes* a patch
        // left by an earlier version of JRay, identified by its own marker —
        // see SPEC.md JR-021/JR-022.
        WebClientPatchService.RemoveLegacyPatch(ApplicationPaths, _logger);
    }

    /// <inheritdoc />
    public override string Name => "JRay";

    /// <inheritdoc />
    public override Guid Id => Guid.Parse("96a22d9d-23fd-49bb-8970-5e153817d223");

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

    /// <summary>
    /// Gets a value indicating whether the pause overlay should currently be
    /// served. Read by the File Transformation callback at request time, so
    /// toggling the setting takes effect without re-registering.
    /// </summary>
    internal static bool OverlayEnabled => Instance?.Configuration.EnableOverlay ?? false;

    /// <summary>
    /// Gets a value indicating whether the File Transformation plugin was found
    /// at startup. When it was not, the overlay is disabled and every other JRay
    /// feature continues to work.
    /// </summary>
    internal static bool FileTransformationAvailable => Instance?._usingFileTransformation ?? false;

    /// <inheritdoc />
    public IEnumerable<PluginPageInfo> GetPages()
    {
        return
        [
            new PluginPageInfo
            {
                Name = Name,
                EmbeddedResourcePath = string.Format(CultureInfo.InvariantCulture, "{0}.Configuration.configPage.html", GetType().Namespace)
            }
        ];
    }
}