URL Rewriting Module

OrchardCore.sln

@@ -525,6 +525,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Rules.Core", "s
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Queries.Core", "src\OrchardCore\OrchardCore.Queries.Core\OrchardCore.Queries.Core.csproj", "{61B358F2-702C-40AA-9DF7-7121248FE6DE}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.UrlRewriting", "src\OrchardCore.Modules\OrchardCore.UrlRewriting\OrchardCore.UrlRewriting.csproj", "{D0F8B342-BDA8-44CB-AA43-7A65C79636A2}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -1389,6 +1391,10 @@ Global
 		{61B358F2-702C-40AA-9DF7-7121248FE6DE}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{61B358F2-702C-40AA-9DF7-7121248FE6DE}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{61B358F2-702C-40AA-9DF7-7121248FE6DE}.Release|Any CPU.Build.0 = Release|Any CPU
+		{D0F8B342-BDA8-44CB-AA43-7A65C79636A2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D0F8B342-BDA8-44CB-AA43-7A65C79636A2}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{D0F8B342-BDA8-44CB-AA43-7A65C79636A2}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{D0F8B342-BDA8-44CB-AA43-7A65C79636A2}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -1629,6 +1635,7 @@ Global
 		{E8A1097D-A65A-4B17-A3A2-F50D79552732} = {A066395F-6F73-45DC-B5A6-B4E306110DCE}
 		{4BAA08A2-878C-4B96-86BF-5B3DB2B6C2C7} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}
 		{61B358F2-702C-40AA-9DF7-7121248FE6DE} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}
+		{D0F8B342-BDA8-44CB-AA43-7A65C79636A2} = {A066395F-6F73-45DC-B5A6-B4E306110DCE}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {46A1D25A-78D1-4476-9CBF-25B75E296341}

src/OrchardCore.Modules/OrchardCore.UrlRewriting/AdminMenu.cs

@@ -0,0 +1,38 @@
+using Microsoft.AspNetCore.Routing;
+using Microsoft.Extensions.Localization;
+using OrchardCore.Navigation;
+using OrchardCore.UrlRewriting.Drivers;
+
+namespace OrchardCore.UrlRewriting;
+
+public sealed class AdminMenu : AdminNavigationProvider
+{
+    private static readonly RouteValueDictionary _routeValues = new()
+    {
+        { "area", "OrchardCore.Settings" },
+        { "groupId", UrlRewritingSettingsDisplayDriver.GroupId },
+    };
+
+    public readonly IStringLocalizer S;
+
+    public AdminMenu(IStringLocalizer<AdminMenu> stringLocalizer)
+    {
+        S = stringLocalizer;
+    }
+
+    protected override ValueTask BuildAsync(NavigationBuilder builder)
+    {
+        builder
+            .Add(S["Configuration"], configuration => configuration
+                .Add(S["Settings"], settings => settings
+                   .Add(S["URL Rewriting"], S["URL Rewriting"].PrefixPosition(), seo => seo
+                       .Permission(Permissions.ManageUrlRewriting)
+                       .Action("Index", "Admin", _routeValues)
+                       .LocalNav()
+                    )
+                )
+            );
+
+        return ValueTask.CompletedTask;
+    }
+}

src/OrchardCore.Modules/OrchardCore.UrlRewriting/Drivers/UrlRewritingSettingsDisplayDriver.cs

@@ -0,0 +1,97 @@
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Rewrite;
+using Microsoft.Extensions.Localization;
+using OrchardCore.DisplayManagement.Entities;
+using OrchardCore.DisplayManagement.Handlers;
+using OrchardCore.DisplayManagement.ModelBinding;
+using OrchardCore.DisplayManagement.Views;
+using OrchardCore.Environment.Shell;
+using OrchardCore.UrlRewriting.Models;
+using OrchardCore.UrlRewriting.ViewModels;
+using OrchardCore.Settings;
+using OrchardCore.Mvc.ModelBinding;
+
+namespace OrchardCore.UrlRewriting.Drivers;
+
+internal sealed class UrlRewritingSettingsDisplayDriver : SiteDisplayDriver<UrlRewritingSettings>
+{
+    public const string GroupId = "UrlRewriting";
+
+    private readonly IAuthorizationService _authorizationService;
+    private readonly IHttpContextAccessor _httpContextAccessor;
+    private readonly IShellReleaseManager _shellReleaseManager;
+    internal readonly IStringLocalizer S;
+
+    public UrlRewritingSettingsDisplayDriver(
+        IAuthorizationService authorizationService,
+        IHttpContextAccessor httpContextAccessor,
+        IShellReleaseManager shellReleaseManager,
+        IStringLocalizer<UrlRewritingSettingsDisplayDriver> stringLocalizer)
+    {
+        _authorizationService = authorizationService;
+        _httpContextAccessor = httpContextAccessor;
+        _shellReleaseManager = shellReleaseManager;
+        S = stringLocalizer;
+    }
+
+    protected override string SettingsGroupId => GroupId;
+
+    public override async Task<IDisplayResult> EditAsync(ISite site, UrlRewritingSettings settings, BuildEditorContext context)
+    {
+        var user = _httpContextAccessor.HttpContext?.User;
+
+        if (!await _authorizationService.AuthorizeAsync(user, Permissions.ManageUrlRewriting))
+        {
+            return null;
+        }
+
+        context.AddTenantReloadWarningWrapper();
+
+        return Initialize<UrlRewritingSettingsViewModel>("UrlRewritingSettings_Edit", model =>
+        {
+            model.ApacheModRewrite = settings.ApacheModRewrite;
+        }).Location("Content:1")
+        .OnGroup(SettingsGroupId);
+    }
+
+    public override async Task<IDisplayResult> UpdateAsync(ISite site, UrlRewritingSettings settings, UpdateEditorContext context)
+    {
+        var user = _httpContextAccessor.HttpContext?.User;
+
+        if (!await _authorizationService.AuthorizeAsync(user, Permissions.ManageUrlRewriting))
+        {
+            return null;
+        }
+
+        var model = new UrlRewritingSettingsViewModel();
+
+        await context.Updater.TryUpdateModelAsync(model, Prefix);
+
+        settings.ApacheModRewrite = model.ApacheModRewrite;
+
+        ValidateUrls(settings, context.Updater);
+
+        _shellReleaseManager.RequestRelease();
+
+        return await EditAsync(site, settings, context);
+    }
+
+    private void ValidateUrls(UrlRewritingSettings settings, IUpdateModel updater)
+    {
+        try
+        {
+            var rewriteOptions = new RewriteOptions();
+            using var apacheModRewrite = new StringReader(settings.ApacheModRewrite);
+            rewriteOptions.AddApacheModRewrite(apacheModRewrite);
+        }
+        catch (FormatException ex)
+        {
+            updater.ModelState.AddModelError(Prefix, nameof(UrlRewritingSettingsViewModel.ApacheModRewrite), S["Parsing error: {0}", ex.Message]);
+        }
+        catch (NotImplementedException ex)
+        {
+            updater.ModelState.AddModelError(Prefix, nameof(UrlRewritingSettingsViewModel.ApacheModRewrite), S["Parsing error: {0}", ex.Message]);
+        }
+    }
+}

src/OrchardCore.Modules/OrchardCore.UrlRewriting/Manifest.cs

@@ -0,0 +1,10 @@
+using OrchardCore.Modules.Manifest;
+
+[assembly: Module(
+    Name = "URL Rewriting",
+    Author = ManifestConstants.OrchardCoreTeam,
+    Website = ManifestConstants.OrchardCoreWebsite,
+    Version = ManifestConstants.OrchardCoreVersion,
+    Description = "Enables URL rewrites and redirects for incoming requests.",
+    Category = "Infrastructure"
+)]

src/OrchardCore.Modules/OrchardCore.UrlRewriting/Models/UrlRewritingSettings.cs

@@ -0,0 +1,6 @@
+namespace OrchardCore.UrlRewriting.Models;
+
+public class UrlRewritingSettings
+{
+    public string ApacheModRewrite { get; set; }
+}

src/OrchardCore.Modules/OrchardCore.UrlRewriting/OrchardCore.UrlRewriting.csproj

@@ -0,0 +1,24 @@
+<Project Sdk="Microsoft.NET.Sdk.Razor">
+
+  <PropertyGroup>
+    <AddRazorSupportForMvc>true</AddRazorSupportForMvc>
+    <!-- NuGet properties-->
+    <Title>OrchardCore Rewrite</Title>
+    <Description>
+      $(OCCMSDescription)
+
+      Provides url rewrite capabilities.
+    </Description>
+    <PackageTags>$(PackageTags) OrchardCoreCMS</PackageTags>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <FrameworkReference Include="Microsoft.AspNetCore.App" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.Module.Targets\OrchardCore.Module.Targets.csproj" />
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.Navigation.Core\OrchardCore.Navigation.Core.csproj" />
+  </ItemGroup>
+
+</Project>

src/OrchardCore.Modules/OrchardCore.UrlRewriting/Permissions.cs

@@ -0,0 +1,25 @@
+using OrchardCore.Security.Permissions;
+
+namespace OrchardCore.UrlRewriting;
+
+public sealed class Permissions : IPermissionProvider
+{
+    public static readonly Permission ManageUrlRewriting = new Permission("ManageUrlRewriting", "Manage URLs rewrites");
+
+    private readonly IEnumerable<Permission> _allPermissions =
+    [
+        ManageUrlRewriting,
+    ];
+
+    public Task<IEnumerable<Permission>> GetPermissionsAsync()
+        => Task.FromResult(_allPermissions);
+
+    public IEnumerable<PermissionStereotype> GetDefaultStereotypes() =>
+    [
+        new PermissionStereotype
+        {
+            Name = OrchardCoreConstants.Roles.Administrator,
+            Permissions = _allPermissions,
+        }
+    ];
+}

src/OrchardCore.Modules/OrchardCore.UrlRewriting/Rules/ExcludeAdminUIRule.cs

@@ -0,0 +1,26 @@
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Rewrite;
+
+namespace OrchardCore.UrlRewriting.Rules;
+
+internal sealed class ExcludeAdminUIRule : IRule
+{
+    private readonly PathString _adminUrlPrefix;
+
+    public ExcludeAdminUIRule(string adminUrlPrefix)
+    {
+        _adminUrlPrefix = new PathString("/" + adminUrlPrefix);
+    }
+
+    public void ApplyRule(RewriteContext context)
+    {
+        if (context.HttpContext.Request.Path.StartsWithSegments(_adminUrlPrefix))
+        {
+            context.Result = RuleResult.SkipRemainingRules;
+        }
+        else
+        {
+            context.Result = RuleResult.ContinueRules;
+        }
+    }
+}

src/OrchardCore.Modules/OrchardCore.UrlRewriting/Startup.cs

@@ -0,0 +1,54 @@
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Rewrite;
+using Microsoft.AspNetCore.Routing;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
+using OrchardCore.Admin;
+using OrchardCore.Navigation;
+using OrchardCore.Security.Permissions;
+using OrchardCore.Settings;
+using OrchardCore.Modules;
+using OrchardCore.UrlRewriting.Rules;
+using OrchardCore.UrlRewriting.Models;
+using OrchardCore.UrlRewriting.Drivers;
+using OrchardCore.DisplayManagement.Handlers;
+
+namespace OrchardCore.UrlRewriting;
+
+public sealed class Startup : StartupBase
+{
+    public override int Order
+        => OrchardCoreConstants.ConfigureOrder.InfrastructureService;
+
+    private readonly AdminOptions _adminOptions;
+
+    public Startup(IOptions<AdminOptions> adminOptions)
+    {
+        _adminOptions = adminOptions.Value;
+    }
+
+    public override void ConfigureServices(IServiceCollection services)
+    {
+        services.AddNavigationProvider<AdminMenu>();
+        services.AddSiteDisplayDriver<UrlRewritingSettingsDisplayDriver>();
+        services.AddPermissionProvider<Permissions>();
+    }
+
+    public override async ValueTask ConfigureAsync(IApplicationBuilder app, IEndpointRouteBuilder routes, IServiceProvider serviceProvider)
+    {
+        var siteService = app.ApplicationServices.GetRequiredService<ISiteService>();
+        var modRewriteSettings = await siteService.GetSettingsAsync<UrlRewritingSettings>();
+
+        using var apacheModRewrite = new StringReader(modRewriteSettings.ApacheModRewrite ?? string.Empty);
+
+        var options = new RewriteOptions()
+            .AddApacheModRewrite(apacheModRewrite);
+
+        if (options.Rules.Count > 0)
+        {
+            // Exclude admin ui requests to prevent accidental access bricking by provided rules
+            options.Rules.Insert(0, new ExcludeAdminUIRule(_adminOptions.AdminUrlPrefix));
+            app.UseRewriter(options);
+        }
+    }
+}

src/OrchardCore.Modules/OrchardCore.UrlRewriting/ViewModels/UrlRewritingSettingsViewModel.cs

@@ -0,0 +1,6 @@
+namespace OrchardCore.UrlRewriting.ViewModels;
+
+public class UrlRewritingSettingsViewModel
+{
+    public string ApacheModRewrite { get; set; }
+}

src/OrchardCore.Modules/OrchardCore.UrlRewriting/Views/UrlRewritingSettings.Edit.cshtml

@@ -0,0 +1,7 @@
+@model OrchardCore.UrlRewriting.ViewModels.UrlRewritingSettingsViewModel
+
+<div class="form-group">
+    <label asp-for="ApacheModRewrite" class="form-label">@T["Apache Mod Rewrite"]</label>
+    <textarea asp-for="ApacheModRewrite" type="text" class="form-control"></textarea>
+    <span asp-validation-for="ApacheModRewrite" class="text-danger"></span>
+</div>

src/OrchardCore.Modules/OrchardCore.UrlRewriting/Views/_ViewImports.cshtml

@@ -0,0 +1,5 @@
+@inherits OrchardCore.DisplayManagement.Razor.RazorPage<TModel>
+
+@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
+@addTagHelper *, OrchardCore.DisplayManagement
+@addTagHelper *, OrchardCore.ResourceManagement

src/OrchardCore/OrchardCore.Application.Cms.Core.Targets/OrchardCore.Application.Cms.Core.Targets.csproj

@@ -99,6 +99,7 @@
     <ProjectReference Include="..\..\OrchardCore.Modules\OrchardCore.Redis\OrchardCore.Redis.csproj" PrivateAssets="none" />
     <ProjectReference Include="..\..\OrchardCore.Modules\OrchardCore.Resources\OrchardCore.Resources.csproj" PrivateAssets="none" />
     <ProjectReference Include="..\..\OrchardCore.Modules\OrchardCore.ResponseCompression\OrchardCore.ResponseCompression.csproj" PrivateAssets="none" />
+    <ProjectReference Include="..\..\OrchardCore.Modules\OrchardCore.UrlRewriting\OrchardCore.UrlRewriting.csproj" PrivateAssets="none" />
     <ProjectReference Include="..\..\OrchardCore.Modules\OrchardCore.ReverseProxy\OrchardCore.ReverseProxy.csproj" PrivateAssets="none" />
     <ProjectReference Include="..\..\OrchardCore.Modules\OrchardCore.Rules\OrchardCore.Rules.csproj" PrivateAssets="none" />
     <ProjectReference Include="..\..\OrchardCore.Modules\OrchardCore.Roles\OrchardCore.Roles.csproj" PrivateAssets="none" />