CodeDevMLH/Jellyfin-Seasonals-Plugin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 7 Wiki Activity

feat: add enable/disable toggle for the plugin and update configuration handling

Browse Source
This commit is contained in:
CodeDevMLH
2025-12-28 18:53:25 +01:00
parent fbd77e56fd
commit 737e510a6c
5 changed files with 118 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Jellyfin.Plugin.Seasonals/Configuration/PluginConfiguration.cs
View File

@@ -12,6 +12,7 @@ public class PluginConfiguration : BasePluginConfiguration
/// </summary>
public PluginConfiguration()
{
IsEnabled = true;
SelectedSeason = "none";
AutomateSeasonSelection = true;
@@ -27,6 +28,11 @@ public class PluginConfiguration : BasePluginConfiguration
Easter = new EasterOptions();
}
/// <summary>
/// Gets or sets a value indicating whether the plugin is enabled.
/// </summary>
public bool IsEnabled { get; set; }
/// <summary>
/// Gets or sets the selected season.
/// </summary>

9
Jellyfin.Plugin.Seasonals/Configuration/configPage.html
View File

@@ -24,6 +24,13 @@
<hr style="max-width: 800px; margin: 1em 0;">
<br>
<form id="SeasonalsConfigForm">
<div class="checkboxContainer checkboxContainer-withDescription">
<label class="emby-checkbox-label">
<input id="IsEnabled" name="IsEnabled" type="checkbox" is="emby-checkbox" />
<span>Enable Seasonals</span>
</label>
<div class="fieldDescription">Enable or disable the entire plugin functionality.</div>
</div>
<div class="checkboxContainer checkboxContainer-withDescription">
<label class="emby-checkbox-label">
<input id="AutomateSeasonSelection" name="AutomateSeasonSelection" type="checkbox" is="emby-checkbox" />
@@ -520,6 +527,7 @@
.addEventListener('pageshow', function() {
Dashboard.showLoadingMsg();
ApiClient.getPluginConfiguration(SeasonalsConfig.pluginUniqueId).then(function (config) {
document.querySelector('#IsEnabled').checked = config.IsEnabled;
document.querySelector('#SelectedSeason').value = config.SelectedSeason;
document.querySelector('#AutomateSeasonSelection').checked = config.AutomateSeasonSelection;
@@ -615,6 +623,7 @@
.addEventListener('submit', function(e) {
Dashboard.showLoadingMsg();
ApiClient.getPluginConfiguration(SeasonalsConfig.pluginUniqueId).then(function (config) {
config.IsEnabled = document.querySelector('#IsEnabled').checked;
config.SelectedSeason = document.querySelector('#SelectedSeason').value;
config.AutomateSeasonSelection = document.querySelector('#AutomateSeasonSelection').checked;

11
Jellyfin.Plugin.Seasonals/ScriptInjector.cs
View File

@@ -83,26 +83,26 @@ public class ScriptInjector
/// <summary>
/// Removes the script tag from index.html.
/// </summary>
public void Remove()
public bool Remove()
{
try
{
var webPath = GetWebPath();
if (string.IsNullOrEmpty(webPath))
{
return;
return false;
}
var indexPath = Path.Combine(webPath, "index.html");
if (!File.Exists(indexPath))
{
return;
return false;
}
var content = File.ReadAllText(indexPath);
if (!content.Contains(ScriptTag, StringComparison.Ordinal))
{
return;
return true;
}
// Try to remove with newline first, then just the tag to ensure clean removal
@@ -111,14 +111,17 @@ public class ScriptInjector
File.WriteAllText(indexPath, newContent);
_logger.LogInformation("Successfully removed Seasonals script from index.html.");
return true;
}
catch (UnauthorizedAccessException)
{
_logger.LogWarning("Permission denied when attempting to remove script from index.html.");
return false;
}
catch (Exception ex)
{
_logger.LogError(ex, "Error removing Seasonals script.");
return false;
}
}

92
Jellyfin.Plugin.Seasonals/SeasonalsPlugin.cs
View File

@@ -21,6 +21,7 @@ namespace Jellyfin.Plugin.Seasonals;
public class SeasonalsPlugin : BasePlugin<PluginConfiguration>, IHasWebPages
{
private readonly ScriptInjector _scriptInjector;
private readonly ILoggerFactory _loggerFactory;
/// <summary>
/// Initializes a new instance of the <see cref="Plugin"/> class.
@@ -32,12 +33,47 @@ public class SeasonalsPlugin : BasePlugin<PluginConfiguration>, IHasWebPages
: base(applicationPaths, xmlSerializer)
{
Instance = this;
_loggerFactory = loggerFactory;
_scriptInjector = new ScriptInjector(applicationPaths, loggerFactory.CreateLogger<ScriptInjector>());
if (Configuration.IsEnabled)
{
if (!_scriptInjector.Inject())
{
TryRegisterFallback(loggerFactory.CreateLogger("FileTransformationFallback"));
}
}
else
{
if (!_scriptInjector.Remove()) {
TryRemoveFallback(loggerFactory.CreateLogger("FileTransformationFallback"));
}
}
}
/// <inheritdoc />
public override void UpdateConfiguration(BasePluginConfiguration configuration)
{
var oldConfig = Configuration;
base.UpdateConfiguration(configuration);
if (Configuration.IsEnabled != oldConfig.IsEnabled)
{
if (Configuration.IsEnabled)
{
if (!_scriptInjector.Inject())
{
TryRegisterFallback(_loggerFactory.CreateLogger("FileTransformationFallback"));
}
}
else
{
if (!_scriptInjector.Remove()) {
TryRemoveFallback(_loggerFactory.CreateLogger("FileTransformationFallback"));
}
}
}
}
/// <inheritdoc />
public override string Name => "Seasonals";
@@ -68,10 +104,24 @@ public class SeasonalsPlugin : BasePlugin<PluginConfiguration>, IHasWebPages
try
{
var html = originalContents;
const string inject = "<script src=\"/Seasonals/Resources/seasonals.js\"></script>\n<body";
const string scriptTag = "<script src=\"/Seasonals/Resources/seasonals.js\" defer></script>";
// MARK: I need to remember to remove legacy script tag support in future versions...
const string legacyScriptTag = "<script src=\"/Seasonals/Resources/seasonals.js\"></script>";
if (Instance?.Configuration.IsEnabled != true)
{
// Remove script if present
if (html.Contains("seasonals.js", StringComparison.Ordinal))
{
return html.Replace(scriptTag, "", StringComparison.OrdinalIgnoreCase)
.Replace(legacyScriptTag, "", StringComparison.OrdinalIgnoreCase);
}
return html;
}
if (!html.Contains("seasonals.js", StringComparison.Ordinal))
{
var inject = $"{scriptTag}\n<body";
return html.Replace("<body", inject, StringComparison.OrdinalIgnoreCase);
}
@@ -133,6 +183,44 @@ public class SeasonalsPlugin : BasePlugin<PluginConfiguration>, IHasWebPages
}
}
private void TryRemoveFallback(ILogger logger)
{
try
{
var assembly = AssemblyLoadContext.All
.SelectMany(x => x.Assemblies)
.FirstOrDefault(x => x.FullName?.Contains(".FileTransformation") ?? false);
if (assembly == null)
{
logger.LogWarning("FileTransformation plugin not found. Fallback removal skipped.");
return;
}
var type = assembly.GetType("Jellyfin.Plugin.FileTransformation.PluginInterface");
if (type == null)
{
logger.LogWarning("Jellyfin.Plugin.FileTransformation.PluginInterface not found.");
return;
}
var method = type.GetMethod("RemoveTransformation");
if (method == null)
{
logger.LogWarning("RemoveTransformation method not found.");
return;
}
Guid pluginId = Id is Guid g ? g : Guid.Parse(Id.ToString());
method.Invoke(null, new object[] { pluginId });
logger.LogInformation("Successfully unregistered fallback transformation via FileTransformation plugin.");
}
catch (Exception ex)
{
logger.LogError(ex, "Error attempting to unregister fallback transformation.");
}
}
/// <inheritdoc />
public IEnumerable<PluginPageInfo> GetPages()
{
@@ -142,7 +230,7 @@ public class SeasonalsPlugin : BasePlugin<PluginConfiguration>, IHasWebPages
{
Name = Name,
EnableInMainMenu = true,
MenuIcon = "snowflake",
MenuIcon = "ac_unit",
EmbeddedResourcePath = string.Format(CultureInfo.InvariantCulture, "{0}.Configuration.configPage.html", GetType().Namespace)
}
};

6
manifest.json
View File

@@ -10,11 +10,11 @@
"versions": [
{
"version": "1.4.0.0",
"changelog": "- link settings directly in main menu\n- renamed main plugin script",
"changelog": "- settings linked directly in the main menu\n- renamed main plugin script\n- added enable/disable toggle for the entire plugin",
"targetAbi": "10.11.0.0",
"sourceUrl": "https://git.mahom03-spacecloud.de/CodeDevMLH/Jellyfin-Seasonals-Plugin/releases/download/v1.4.0.0/Jellyfin.Plugin.Seasonals.zip",
"checksum": "5f310da35b94807f90091988b90fa57a",
"timestamp": "2025-12-28T16:18:23Z"
"checksum": "52341fdb5c8f93eabe9063b3d5eb59dd",
"timestamp": "2025-12-28T17:52:46Z"
},
{
"version": "1.3.4.0",