From 14b785d188647ae896c5d20869ab6bcc967fcfc2 Mon Sep 17 00:00:00 2001
From: KGT1 <kilian.gamn@gmx.de>
Date: Tue, 1 Apr 2025 01:46:01 +0200
Subject: [PATCH] Preserve SplashscreenLocation when updating branding config
 (#13756)

* add BrandingOptionsDto and add branding endpoints

* refactor new HttpGet Configuration Branding into existing API calls

* Add BrandingOptions to _ignoredConfigurations for openAPI

* rename BrandOptionsDto to BrandingOptionsDto
---
 .../Controllers/BrandingController.cs         | 13 ++++++++--
 .../Controllers/ConfigurationController.cs    | 25 +++++++++++++++++++
 .../Filters/AdditionalModelFilter.cs          |  2 +-
 .../Branding/BrandingOptions.cs               |  7 ------
 .../Branding/BrandingOptionsDto.cs            | 25 +++++++++++++++++++
 5 files changed, 62 insertions(+), 10 deletions(-)
 create mode 100644 MediaBrowser.Model/Branding/BrandingOptionsDto.cs

diff --git a/Jellyfin.Api/Controllers/BrandingController.cs b/Jellyfin.Api/Controllers/BrandingController.cs
index 3c2c4b4dbd..1d948ff206 100644
--- a/Jellyfin.Api/Controllers/BrandingController.cs
+++ b/Jellyfin.Api/Controllers/BrandingController.cs
@@ -29,9 +29,18 @@ public class BrandingController : BaseJellyfinApiController
     /// <returns>An <see cref="OkResult"/> containing the branding configuration.</returns>
     [HttpGet("Configuration")]
     [ProducesResponseType(StatusCodes.Status200OK)]
-    public ActionResult<BrandingOptions> GetBrandingOptions()
+    public ActionResult<BrandingOptionsDto> GetBrandingOptions()
     {
-        return _serverConfigurationManager.GetConfiguration<BrandingOptions>("branding");
+        var brandingOptions = _serverConfigurationManager.GetConfiguration<BrandingOptions>("branding");
+
+        var brandingOptionsDto = new BrandingOptionsDto
+        {
+            LoginDisclaimer = brandingOptions.LoginDisclaimer,
+            CustomCss = brandingOptions.CustomCss,
+            SplashscreenEnabled = brandingOptions.SplashscreenEnabled
+        };
+
+        return brandingOptionsDto;
     }
 
     /// <summary>
diff --git a/Jellyfin.Api/Controllers/ConfigurationController.cs b/Jellyfin.Api/Controllers/ConfigurationController.cs
index abe8bec2db..8dcaebf6db 100644
--- a/Jellyfin.Api/Controllers/ConfigurationController.cs
+++ b/Jellyfin.Api/Controllers/ConfigurationController.cs
@@ -9,6 +9,7 @@ using Jellyfin.Extensions.Json;
 using MediaBrowser.Common.Api;
 using MediaBrowser.Controller.Configuration;
 using MediaBrowser.Controller.MediaEncoding;
+using MediaBrowser.Model.Branding;
 using MediaBrowser.Model.Configuration;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Http;
@@ -119,6 +120,30 @@ public class ConfigurationController : BaseJellyfinApiController
         return new MetadataOptions();
     }
 
+    /// <summary>
+    /// Updates branding configuration.
+    /// </summary>
+    /// <param name="configuration">Branding configuration.</param>
+    /// <response code="204">Branding configuration updated.</response>
+    /// <returns>Update status.</returns>
+    [HttpPost("Configuration/Branding")]
+    [Authorize(Policy = Policies.RequiresElevation)]
+    [ProducesResponseType(StatusCodes.Status204NoContent)]
+    public ActionResult UpdateBrandingConfiguration([FromBody, Required] BrandingOptionsDto configuration)
+    {
+        // Get the current branding configuration to preserve SplashscreenLocation
+        var currentBranding = (BrandingOptions)_configurationManager.GetConfiguration("branding");
+
+        // Update only the properties from BrandingOptionsDto
+        currentBranding.LoginDisclaimer = configuration.LoginDisclaimer;
+        currentBranding.CustomCss = configuration.CustomCss;
+        currentBranding.SplashscreenEnabled = configuration.SplashscreenEnabled;
+
+        _configurationManager.SaveConfiguration("branding", currentBranding);
+
+        return NoContent();
+    }
+
     /// <summary>
     /// Updates the path to the media encoder.
     /// </summary>
diff --git a/Jellyfin.Server/Filters/AdditionalModelFilter.cs b/Jellyfin.Server/Filters/AdditionalModelFilter.cs
index bf38f741cd..4cd0fc231e 100644
--- a/Jellyfin.Server/Filters/AdditionalModelFilter.cs
+++ b/Jellyfin.Server/Filters/AdditionalModelFilter.cs
@@ -25,7 +25,7 @@ namespace Jellyfin.Server.Filters
     public class AdditionalModelFilter : IDocumentFilter
     {
         // Array of options that should not be visible in the api spec.
-        private static readonly Type[] _ignoredConfigurations = { typeof(MigrationOptions) };
+        private static readonly Type[] _ignoredConfigurations = { typeof(MigrationOptions), typeof(MediaBrowser.Model.Branding.BrandingOptions) };
         private readonly IServerConfigurationManager _serverConfigurationManager;
 
         /// <summary>
diff --git a/MediaBrowser.Model/Branding/BrandingOptions.cs b/MediaBrowser.Model/Branding/BrandingOptions.cs
index c6580598b4..5ec6b0dd4b 100644
--- a/MediaBrowser.Model/Branding/BrandingOptions.cs
+++ b/MediaBrowser.Model/Branding/BrandingOptions.cs
@@ -1,5 +1,3 @@
-using System.Text.Json.Serialization;
-
 namespace MediaBrowser.Model.Branding;
 
 /// <summary>
@@ -27,10 +25,5 @@ public class BrandingOptions
     /// <summary>
     /// Gets or sets the splashscreen location on disk.
     /// </summary>
-    /// <remarks>
-    /// Not served via the API.
-    /// Only used to save the custom uploaded user splashscreen in the configuration file.
-    /// </remarks>
-    [JsonIgnore]
     public string? SplashscreenLocation { get; set; }
 }
diff --git a/MediaBrowser.Model/Branding/BrandingOptionsDto.cs b/MediaBrowser.Model/Branding/BrandingOptionsDto.cs
new file mode 100644
index 0000000000..c0d8cb31c2
--- /dev/null
+++ b/MediaBrowser.Model/Branding/BrandingOptionsDto.cs
@@ -0,0 +1,25 @@
+namespace MediaBrowser.Model.Branding;
+
+/// <summary>
+/// The branding options DTO for API use.
+/// This DTO excludes SplashscreenLocation to prevent it from being updated via API.
+/// </summary>
+public class BrandingOptionsDto
+{
+    /// <summary>
+    /// Gets or sets the login disclaimer.
+    /// </summary>
+    /// <value>The login disclaimer.</value>
+    public string? LoginDisclaimer { get; set; }
+
+    /// <summary>
+    /// Gets or sets the custom CSS.
+    /// </summary>
+    /// <value>The custom CSS.</value>
+    public string? CustomCss { get; set; }
+
+    /// <summary>
+    /// Gets or sets a value indicating whether to enable the splashscreen.
+    /// </summary>
+    public bool SplashscreenEnabled { get; set; } = false;
+}