diff options
| author | Cody Robibero <cody@robibe.ro> | 2026-11-20 07:15:13 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-11-20 07:15:13 -0500 |
| commit | 8ae05ce9dcd08b870d543d8ef4f10f3c609d63df (patch) | |
| tree | af353653e7e8cd25e287ffac49d0fa938bd8abf7 | |
| parent | 92dd250d8f713c86d24ad8f62eb9758e242bcf23 (diff) | |
| parent | c5cb2c8e506279191758f571590d59753e98dfe2 (diff) | |
Merge pull request #17578 from dkanada/obsolete-filter
add setting to disable obsolete endpoints
| -rw-r--r-- | Jellyfin.Server/Extensions/ApiServiceCollectionExtensions.cs | 9 | ||||
| -rw-r--r-- | Jellyfin.Server/Filters/ObsoleteEndpointConvention.cs | 29 | ||||
| -rw-r--r-- | Jellyfin.Server/Filters/ObsoleteEndpointFilter.cs | 26 | ||||
| -rw-r--r-- | Jellyfin.Server/Startup.cs | 2 | ||||
| -rw-r--r-- | MediaBrowser.Model/Configuration/ServerConfiguration.cs | 5 |
5 files changed, 69 insertions, 2 deletions
diff --git a/Jellyfin.Server/Extensions/ApiServiceCollectionExtensions.cs b/Jellyfin.Server/Extensions/ApiServiceCollectionExtensions.cs index a767e7e5c7..e4aed9451c 100644 --- a/Jellyfin.Server/Extensions/ApiServiceCollectionExtensions.cs +++ b/Jellyfin.Server/Extensions/ApiServiceCollectionExtensions.cs @@ -27,6 +27,7 @@ using Jellyfin.Server.Configuration; using Jellyfin.Server.Filters; using MediaBrowser.Common.Api; using MediaBrowser.Common.Net; +using MediaBrowser.Model.Configuration; using MediaBrowser.Model.Entities; using Microsoft.AspNetCore.Authentication; using Microsoft.AspNetCore.Authorization; @@ -109,8 +110,9 @@ namespace Jellyfin.Server.Extensions /// <param name="serviceCollection">The service collection.</param> /// <param name="pluginAssemblies">An IEnumerable containing all plugin assemblies with API controllers.</param> /// <param name="config">The <see cref="NetworkConfiguration"/>.</param> + /// <param name="serverConfiguration">The <see cref="ServerConfiguration"/>.</param> /// <returns>The MVC builder.</returns> - public static IMvcBuilder AddJellyfinApi(this IServiceCollection serviceCollection, IEnumerable<Assembly> pluginAssemblies, NetworkConfiguration config) + public static IMvcBuilder AddJellyfinApi(this IServiceCollection serviceCollection, IEnumerable<Assembly> pluginAssemblies, NetworkConfiguration config, ServerConfiguration serverConfiguration) { IMvcBuilder mvcBuilder = serviceCollection .AddCors() @@ -131,6 +133,11 @@ namespace Jellyfin.Server.Extensions opts.OutputFormatters.Add(new XmlOutputFormatter()); opts.ModelBinderProviders.Insert(0, new NullableEnumModelBinderProvider()); + + if (!serverConfiguration.EnableObsoleteEndpoints) + { + opts.Conventions.Add(new ObsoleteEndpointConvention()); + } }) // Clear app parts to avoid other assemblies being picked up diff --git a/Jellyfin.Server/Filters/ObsoleteEndpointConvention.cs b/Jellyfin.Server/Filters/ObsoleteEndpointConvention.cs new file mode 100644 index 0000000000..c53b61a4d3 --- /dev/null +++ b/Jellyfin.Server/Filters/ObsoleteEndpointConvention.cs @@ -0,0 +1,29 @@ +using System; +using System.Linq; +using Microsoft.AspNetCore.Mvc.ApplicationModels; + +namespace Jellyfin.Server.Filters +{ + /// <summary> + /// Searches for actions and controllers marked with <see cref="ObsoleteAttribute"/> and applies a custom filter. + /// </summary> + public class ObsoleteEndpointConvention : IApplicationModelConvention + { + /// <inheritdoc /> + public void Apply(ApplicationModel application) + { + foreach (var controller in application.Controllers) + { + var isControllerObsolete = controller.Attributes.OfType<ObsoleteAttribute>().Any(); + + foreach (var action in controller.Actions) + { + if (isControllerObsolete || action.Attributes.OfType<ObsoleteAttribute>().Any()) + { + action.Filters.Add(new ObsoleteEndpointFilter()); + } + } + } + } + } +} diff --git a/Jellyfin.Server/Filters/ObsoleteEndpointFilter.cs b/Jellyfin.Server/Filters/ObsoleteEndpointFilter.cs new file mode 100644 index 0000000000..b2c02fd516 --- /dev/null +++ b/Jellyfin.Server/Filters/ObsoleteEndpointFilter.cs @@ -0,0 +1,26 @@ +using System.Threading.Tasks; +using Microsoft.AspNetCore.Http; +using Microsoft.AspNetCore.Mvc; +using Microsoft.AspNetCore.Mvc.Filters; + +namespace Jellyfin.Server.Filters; + +/// <summary> +/// Short circuits an obsolete endpoint to return an error code. +/// </summary> +public class ObsoleteEndpointFilter : IAsyncActionFilter +{ + /// <inheritdoc/> + public Task OnActionExecutionAsync(ActionExecutingContext context, ActionExecutionDelegate next) + { + var obsoleteResponse = new + { + error = "Endpoint Obsolete", + message = "This endpoint has been manually disabled. You can revert this with the EnableObsoleteEndpoints setting." + }; + + context.Result = new ObjectResult(obsoleteResponse) { StatusCode = StatusCodes.Status410Gone }; + + return Task.CompletedTask; + } +} diff --git a/Jellyfin.Server/Startup.cs b/Jellyfin.Server/Startup.cs index 560a419945..7aef47d438 100644 --- a/Jellyfin.Server/Startup.cs +++ b/Jellyfin.Server/Startup.cs @@ -70,7 +70,7 @@ namespace Jellyfin.Server options.HttpsPort = _serverApplicationHost.HttpsPort; }); - services.AddJellyfinApi(_serverApplicationHost.GetApiPluginAssemblies(), _serverConfigurationManager.GetNetworkConfiguration()); + services.AddJellyfinApi(_serverApplicationHost.GetApiPluginAssemblies(), _serverConfigurationManager.GetNetworkConfiguration(), _serverConfigurationManager.Configuration); services.AddJellyfinDbContext(_serverApplicationHost.ConfigurationManager, _configuration); services.AddJellyfinApiSwagger(); diff --git a/MediaBrowser.Model/Configuration/ServerConfiguration.cs b/MediaBrowser.Model/Configuration/ServerConfiguration.cs index ac5c12304e..97a996c479 100644 --- a/MediaBrowser.Model/Configuration/ServerConfiguration.cs +++ b/MediaBrowser.Model/Configuration/ServerConfiguration.cs @@ -288,4 +288,9 @@ public class ServerConfiguration : BaseApplicationConfiguration /// Gets or sets a value indicating whether old authorization methods are allowed. /// </summary> public bool EnableLegacyAuthorization { get; set; } + + /// <summary> + /// Gets or sets a value indicating whether obsolete endpoints are allowed. + /// </summary> + public bool EnableObsoleteEndpoints { get; set; } = true; } |
