From d65e8d70442ecc2c03372abf5f81c65c6ab189a6 Mon Sep 17 00:00:00 2001 From: crobibero Date: Sun, 6 Dec 2020 19:40:43 -0700 Subject: [PATCH 1/3] Redirect robots.txt if hosting web content --- .../ApiApplicationBuilderExtensions.cs | 10 ++++ .../Middleware/RobotsRedirectionMiddleware.cs | 47 +++++++++++++++++++ Jellyfin.Server/Startup.cs | 2 + 3 files changed, 59 insertions(+) create mode 100644 Jellyfin.Server/Middleware/RobotsRedirectionMiddleware.cs diff --git a/Jellyfin.Server/Extensions/ApiApplicationBuilderExtensions.cs b/Jellyfin.Server/Extensions/ApiApplicationBuilderExtensions.cs index 6bf6f383fc..a56e159590 100644 --- a/Jellyfin.Server/Extensions/ApiApplicationBuilderExtensions.cs +++ b/Jellyfin.Server/Extensions/ApiApplicationBuilderExtensions.cs @@ -107,5 +107,15 @@ namespace Jellyfin.Server.Extensions { return appBuilder.UseMiddleware(); } + + /// + /// Adds robots.txt redirection to the application pipeline. + /// + /// The application builder. + /// The updated application builder. + public static IApplicationBuilder UseRobotsRedirection(this IApplicationBuilder appBuilder) + { + return appBuilder.UseMiddleware(); + } } } diff --git a/Jellyfin.Server/Middleware/RobotsRedirectionMiddleware.cs b/Jellyfin.Server/Middleware/RobotsRedirectionMiddleware.cs new file mode 100644 index 0000000000..9d40d74fe9 --- /dev/null +++ b/Jellyfin.Server/Middleware/RobotsRedirectionMiddleware.cs @@ -0,0 +1,47 @@ +using System; +using System.Threading.Tasks; +using Microsoft.AspNetCore.Http; +using Microsoft.Extensions.Logging; + +namespace Jellyfin.Server.Middleware +{ + /// + /// Redirect requests to robots.txt to web/robots.txt. + /// + public class RobotsRedirectionMiddleware + { + private readonly RequestDelegate _next; + private readonly ILogger _logger; + + /// + /// Initializes a new instance of the class. + /// + /// The next delegate in the pipeline. + /// The logger. + public RobotsRedirectionMiddleware( + RequestDelegate next, + ILogger logger) + { + _next = next; + _logger = logger; + } + + /// + /// Executes the middleware action. + /// + /// The current HTTP context. + /// The async task. + public async Task Invoke(HttpContext httpContext) + { + var localPath = httpContext.Request.Path.ToString(); + if (string.Equals(localPath, "/robots.txt", StringComparison.OrdinalIgnoreCase)) + { + _logger.LogDebug("Redirecting robots.txt request to web/robots.txt"); + httpContext.Response.Redirect("web/robots.txt"); + return; + } + + await _next(httpContext).ConfigureAwait(false); + } + } +} \ No newline at end of file diff --git a/Jellyfin.Server/Startup.cs b/Jellyfin.Server/Startup.cs index aa3ef53500..306a52ce8f 100644 --- a/Jellyfin.Server/Startup.cs +++ b/Jellyfin.Server/Startup.cs @@ -142,6 +142,8 @@ namespace Jellyfin.Server RequestPath = "/web", ContentTypeProvider = extensionProvider }); + + mainApp.UseRobotsRedirection(); } mainApp.UseAuthentication(); From b66abf0556802f2278acdfed9fb5d4292cd3f122 Mon Sep 17 00:00:00 2001 From: crobibero Date: Thu, 10 Dec 2020 08:17:02 -0700 Subject: [PATCH 2/3] Add support back for /emby and /mediabrowser routes --- .../ApiApplicationBuilderExtensions.cs | 13 +++++ .../Middleware/PathTrimMiddleware.cs | 54 +++++++++++++++++++ Jellyfin.Server/Startup.cs | 2 + 3 files changed, 69 insertions(+) create mode 100644 Jellyfin.Server/Middleware/PathTrimMiddleware.cs diff --git a/Jellyfin.Server/Extensions/ApiApplicationBuilderExtensions.cs b/Jellyfin.Server/Extensions/ApiApplicationBuilderExtensions.cs index a56e159590..492adfbffc 100644 --- a/Jellyfin.Server/Extensions/ApiApplicationBuilderExtensions.cs +++ b/Jellyfin.Server/Extensions/ApiApplicationBuilderExtensions.cs @@ -117,5 +117,18 @@ namespace Jellyfin.Server.Extensions { return appBuilder.UseMiddleware(); } + + /// + /// Adds /emby and /mediabrowser route trimming to the application pipeline. + /// + /// + /// This must be injected before any path related middleware. + /// + /// The application builder. + /// The updated application builder. + public static IApplicationBuilder UsePathTrim(this IApplicationBuilder appBuilder) + { + return appBuilder.UseMiddleware(); + } } } diff --git a/Jellyfin.Server/Middleware/PathTrimMiddleware.cs b/Jellyfin.Server/Middleware/PathTrimMiddleware.cs new file mode 100644 index 0000000000..6360cba500 --- /dev/null +++ b/Jellyfin.Server/Middleware/PathTrimMiddleware.cs @@ -0,0 +1,54 @@ +using System; +using System.Threading.Tasks; +using Microsoft.AspNetCore.Http; +using Microsoft.Extensions.Logging; + +namespace Jellyfin.Server.Middleware +{ + /// + /// Removes /emby and /mediabrowser from requested route. + /// + public class PathTrimMiddleware + { + private const string EmbyPath = "/emby"; + private const string MediabrowserPath = "/mediabrowser"; + + private readonly RequestDelegate _next; + private readonly ILogger _logger; + + /// + /// Initializes a new instance of the class. + /// + /// The next delegate in the pipeline. + /// The logger. + public PathTrimMiddleware( + RequestDelegate next, + ILogger logger) + { + _next = next; + _logger = logger; + } + + /// + /// Executes the middleware action. + /// + /// The current HTTP context. + /// The async task. + public async Task Invoke(HttpContext httpContext) + { + var localPath = httpContext.Request.Path.ToString(); + if (localPath.StartsWith(EmbyPath, StringComparison.OrdinalIgnoreCase)) + { + httpContext.Request.Path = localPath[EmbyPath.Length..]; + _logger.LogDebug("Removing {EmbyPath} from route.", EmbyPath); + } + else if (localPath.StartsWith(MediabrowserPath, StringComparison.OrdinalIgnoreCase)) + { + httpContext.Request.Path = localPath[MediabrowserPath.Length..]; + _logger.LogDebug("Removing {MediabrowserPath} from route.", MediabrowserPath); + } + + await _next(httpContext).ConfigureAwait(false); + } + } +} \ No newline at end of file diff --git a/Jellyfin.Server/Startup.cs b/Jellyfin.Server/Startup.cs index 306a52ce8f..3395d2413f 100644 --- a/Jellyfin.Server/Startup.cs +++ b/Jellyfin.Server/Startup.cs @@ -128,6 +128,8 @@ namespace Jellyfin.Server mainApp.UseHttpsRedirection(); } + // This must be injected before any path related middleware. + mainApp.UsePathTrim(); mainApp.UseStaticFiles(); if (appConfig.HostWebClient()) { From 69d581033b227c38cf810d4943aebe9aa421e33a Mon Sep 17 00:00:00 2001 From: crobibero Date: Fri, 11 Dec 2020 07:17:06 -0700 Subject: [PATCH 3/3] Use a more descriptive middleware name --- .../Extensions/ApiApplicationBuilderExtensions.cs | 2 +- ...ddleware.cs => LegacyEmbyRouteRewriteMiddleware.cs} | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) rename Jellyfin.Server/Middleware/{PathTrimMiddleware.cs => LegacyEmbyRouteRewriteMiddleware.cs} (83%) diff --git a/Jellyfin.Server/Extensions/ApiApplicationBuilderExtensions.cs b/Jellyfin.Server/Extensions/ApiApplicationBuilderExtensions.cs index 492adfbffc..88e2b4152b 100644 --- a/Jellyfin.Server/Extensions/ApiApplicationBuilderExtensions.cs +++ b/Jellyfin.Server/Extensions/ApiApplicationBuilderExtensions.cs @@ -128,7 +128,7 @@ namespace Jellyfin.Server.Extensions /// The updated application builder. public static IApplicationBuilder UsePathTrim(this IApplicationBuilder appBuilder) { - return appBuilder.UseMiddleware(); + return appBuilder.UseMiddleware(); } } } diff --git a/Jellyfin.Server/Middleware/PathTrimMiddleware.cs b/Jellyfin.Server/Middleware/LegacyEmbyRouteRewriteMiddleware.cs similarity index 83% rename from Jellyfin.Server/Middleware/PathTrimMiddleware.cs rename to Jellyfin.Server/Middleware/LegacyEmbyRouteRewriteMiddleware.cs index 6360cba500..fdd8974d2b 100644 --- a/Jellyfin.Server/Middleware/PathTrimMiddleware.cs +++ b/Jellyfin.Server/Middleware/LegacyEmbyRouteRewriteMiddleware.cs @@ -8,22 +8,22 @@ namespace Jellyfin.Server.Middleware /// /// Removes /emby and /mediabrowser from requested route. /// - public class PathTrimMiddleware + public class LegacyEmbyRouteRewriteMiddleware { private const string EmbyPath = "/emby"; private const string MediabrowserPath = "/mediabrowser"; private readonly RequestDelegate _next; - private readonly ILogger _logger; + private readonly ILogger _logger; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// /// The next delegate in the pipeline. /// The logger. - public PathTrimMiddleware( + public LegacyEmbyRouteRewriteMiddleware( RequestDelegate next, - ILogger logger) + ILogger logger) { _next = next; _logger = logger;