URL Rewriting Module #16687

arkadiuszwojcik · 2024-09-07T13:02:29Z

This PR partially addresses issue #9027. It introduces a new Rewrite module with, as of now, basic functionality that allows providing rewrite/redirect rules using Apache mod_rewrite syntax. This functionality is very basic but also very flexible, providing a good starting point for more features that might be requested in the future.

Few remaining questions are:

Is proposed name good? Maybe it should be: OrchardCore.Rewrites or OrchardCore.Rewriter
I am not sure about module priority, currently it is: InfrastructureService
Looks like RewriteRules have some limitations regarding absolute addresses. I created issue related to that in aspnetcore project.

Fork update

Sync with upstream repository

Sync with upstrem repo

MikeAlhayek

@arkadiuszwojcik Thank you for this PR.

I am not a fan of the suggested UI. I think it would be much better and user friendly to have a UI similarity to the Tenants, Features, or Notifications UI where user can add a new rule "as a new entry" form.

Also add a way to edit one rule at a time. I also think it would be better to prompt the user with at the following fields:

Title
Description
Pattern
Replacement
SkipRemainingRules.

Or the following fields:

Title
Description
Pattern
SkipRemainingRules.

This way the user can provide meaning title/description for what the rules should actually do.

And even better, you can then easily implement sorting on the UI where one can drag/drop the entries which will change the order of the entries in the options.

Updated

I would rename the module to UrlRewriting

Also, how would this work with other tenants?

For example, if every tenant on my setup uses a subsdomain, can one tenant put a rule that would redirect all of the traffic to their instance instead?

.AddRedirect("^(?!www\\.).*", "https://site1.example.com", statusCode: StatusCodes.Status301MovedPermanently)

Or of every tenant is setup using a prefix, can I just write a rule that would redirect all other tenants to my instances?

.AddRedirect(@"^(.+)/$", "/site1/")

Please confirm that the two rules I shared above, are only applicable on one tenant only and will not impact other tenants.

src/OrchardCore.Modules/OrchardCore.Rewrite/Drivers/RewriteSettingsDisplayDriver.cs

src/OrchardCore.Modules/OrchardCore.Rewrite/Startup.cs

src/OrchardCore.Modules/OrchardCore.Rewrite/Views/RewriteSettings.Edit.cshtml

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

src/OrchardCore.Modules/OrchardCore.Rewrite/Permissions.cs

src/OrchardCore.Modules/OrchardCore.Rewrite/OrchardCore.Rewrite.csproj

arkadiuszwojcik · 2024-09-10T06:37:54Z

@MikeAlhayek, thank you for your comments. Regarding the UI, I think the module should ultimately support both types of URL rewrites: UI-based and text-based. Text-based is more advanced because RewriteRule can be preceded by multiple RewriteCond, which allow for numerous checks based on variables like Cookie, DateTime, UserAgent, etc. These checks are complex to model in a graphical UI. I suggest having two tabs: one for "Simple Mode" with a user-friendly interface, and another for "Advanced Mode". In this PR I just added only advance one.

Regarding multitenancy, the URL rewrite middleware is registered separately for each tenant (each tenant has its own IApplicationBuilder instance), so when a request hits the rewrite middleware, it has already been routed to the proper tenant by OC. I tested a simple case with two tenants to verify that the rewrite rules from one do not affect the other. With this it is impossible to intercept and redirect traffic from other tenant.

MikeAlhayek · 2024-09-10T13:31:02Z

@arkadiuszwojcik yes I understand. You can also model your UI just like Queries UI. This UI allows you to add different types of queries. In your case you can provide the advance rule, but will allow another person to also define a different rule.

Yea the renaming should work as long as the middleware is added after the tenant middle ware.

arkadiuszwojcik · 2024-09-10T19:16:24Z

Regarding the module name, what do you think about 'UrlRewrites' instead of 'UrlRewriting'? To me, it seems much more aligned with the current module names, although I might be wrong.

MikeAlhayek · 2024-09-10T19:18:18Z

Regarding the module name, what do you think about 'UrlRewrites' instead of 'UrlRewriting'? To me, it seems much more aligned with the current module names, although I might be wrong.

Personally, I would go with UrlRewriting.

hishamco · 2024-09-10T20:10:28Z

Is there any reason not to use the URL Rewrite module available in ASP.NET Core? Regardless the issue that you mentioned

arkadiuszwojcik · 2024-09-11T05:07:01Z

Is there any reason not to use the URL Rewrite module available in ASP.NET Core? Regardless the issue that you mentioned

Can you elaborate? This OC module is using ASP.NET Core Rewrite module internally, it just expose way to provide rewrite rules in OC admin menu.

Update:
@hishamco ASP.NET Rewrite middleware allows to define rewrite/redirect rules in few text formats: Apache and IIS, I chosen to use Apache as more popular.

hishamco · 2024-09-11T10:12:56Z

Good, also I have another module on top of my head that might be related URL redirection

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

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

- Permissions refactor work

- Rename Permissions class to UrlRewritingPermissionProvider

github-actions · 2024-09-16T00:03:08Z

This pull request has merge conflicts. Please resolve those before requesting a review.

MikeAlhayek · 2024-09-16T16:55:43Z

@arkadiuszwojcik when you are done addressing my previous feedback, please request my review and I'll review this again.

arkadiuszwojcik · 2024-09-16T17:03:11Z

@MikeAlhayek everything is fixed except suggested UI ... so will it be accepted as it is or should I mark is as draft and start working on more user frendly UI?

MikeAlhayek · 2024-09-16T17:12:39Z

I would rather see the improved UI first. If you don't want to spend lots of time on it, I understand. I would at minimum like to see the UI layout similar to the Queries UI.

Once that is ready, please request my review and I'll test it out and provide you feedback.

arkadiuszwojcik · 2024-10-02T19:27:23Z

@MikeAlhayek took me a while but I managed to crate first version of UI for this module. You can create first rule by editing some recipe by adding dependency to module:

"steps": [
  {
    "name": "feature",
    "enable": [
      ....
      "OrchardCore.UrlRewriting",
    ]
  },

and creation step:

{
  "name": "UrlRewriting",
  "Rules": [
    {
      "Name": "Img rewrite rule",
      "Pattern": "/img/(.*)",
      "Substitution": "/media/$1",
      "Flags": "L"
    }
  ]
}

This rule allow to access images by /img/ url instead of /media/

MikeAlhayek · 2024-10-02T23:32:04Z

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

+
+public sealed class AdminMenu : AdminNavigationProvider
+{
+    public readonly IStringLocalizer S;


Suggested change

public readonly IStringLocalizer S;

internal readonly IStringLocalizer S;

MikeAlhayek · 2024-10-02T23:32:21Z

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

+        builder
+            .Add(S["Configuration"], configuration => configuration
+                .Add(S["URL Rewriting"], S["URL Rewriting"].PrefixPosition(), rewriting => rewriting
+                    .AddClass("urlrewriting").Id("urlrewriting")


Suggested change

.AddClass("urlrewriting").Id("urlrewriting")

.AddClass("urlrewriting")

.Id("urlrewriting")

src/OrchardCore.Modules/OrchardCore.UrlRewriting/Controllers/AdminController.cs

MikeAlhayek · 2024-10-02T23:34:34Z

src/OrchardCore.Modules/OrchardCore.UrlRewriting/Controllers/AdminController.cs

+        return View(shape);
+    }
+
+    [HttpPost, ActionName(nameof(CreateRule))]


Suggested change

[HttpPost, ActionName(nameof(CreateRule))]

[HttpPost]

[ActionName(nameof(CreateRule))]

MikeAlhayek · 2024-10-02T23:36:19Z

src/OrchardCore.Modules/OrchardCore.UrlRewriting/Controllers/AdminController.cs

+        return View(model);
+    }
+
+    [Admin("UrlRewriting/CreateRule", nameof(CreateRule))]


Suggested change

[Admin("UrlRewriting/CreateRule", nameof(CreateRule))]

[Admin("UrlRewriting/CreateRule", "CreateRewritingRule")]

src/OrchardCore.Modules/OrchardCore.UrlRewriting/Views/Admin/Index.cshtml

MikeAlhayek · 2024-10-02T23:51:51Z

src/OrchardCore.Modules/OrchardCore.UrlRewriting/Views/Admin/Index.cshtml

+    </div>
+</form>
+
+<script at="Foot" depends-on="jQuery">


if you can, please don't use jQuery. we are trying to remove jQuery from all of our views

src/OrchardCore.Modules/OrchardCore.UrlRewriting/Views/Admin/Index.cshtml

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

MikeAlhayek · 2024-10-03T00:56:06Z

@arkadiuszwojcik I am going to push some changes to your branch. The display driver need a bit of work. I don't have time now to refactor it.

But here is a general feedback on what needs to be done there:

on the index view, we don't render tables as you are doing. Instead, we render "Name". You can use shapes to render other info like pattern and action if needed under the name using shapes but not hard code them into the index view.
The view model RewriteRuleViewModel should not need to have nested RewriteActionViewModel and RedirectActionViewModel you could replace these two by adding the following properties on the viewmodel directly

public bool AppendQueryString { get; set; } = true;
public RedirectType RedirectType { get; set; } = RedirectType.Found302;
public string Url { get; set; }
public bool SkipFurtherRules { get; set; }

this way you are not using key like RewriteAction.RewriteUrl, RedirectAction.RedirectUrl or RuleError

In the RewriteRuleFiles.Edit.cshtml instead of having to write JS, you could use bootstap toggle instead.
Not required for this PR, but I wish you used the same approach we use in the Queries UI so that the UI will be extensible instead. Because with that structure, you can then add "Rewrite" rule which will have a different (more simple) UI and another separate rule for Redirect with again a simple UI.

This is what we have in the queries UI. When you click "Add Query", you'll get a modal where you can select which query type to create. In your case it would be rule type. Then each query type would have a very simple UI for that rule time without the show/hide and all these properties.

MikeAlhayek · 2024-10-03T14:45:49Z

@arkadiuszwojcik I am making changes to this PR. please don't make any changes. this will improve the PR

MikeAlhayek · 2024-10-03T18:24:48Z

@arkadiuszwojcik I made lots of changes to your PR. The PR now uses the same UI as Queries so it is easily extensible.

To add new rules, all you need is to implement the following

services.AddRewriteRuleSource<UrlRewriteRuleSource>(UrlRewriteRuleSource.SourceName)
    .AddScoped<IDisplayDriver<RewriteRule>, UrlRewriteRuleDisplayDriver>();

Here is what you need to do

Check the logic in Configure method in UrlRewriteRuleSource and UrlRedirectRuleSource
Check the driver for each of the available rules UrlRewriteRuleDisplayDriver and UrlRedirectRuleDisplayDriver.
It would be nice to add the rest of the events to IRewriteRuleHandler like Deleting, Deleted, Saving, Saved
Test the rule to make sure that the configuration is doing the expected behavior.

arkadiuszwojcik and others added 7 commits July 10, 2020 08:29

Sync with upstream OrchardCMS/dev

edcb175

Merge pull request #3 from OrchardCMS/dev

ad39ce7

Fork update

Merge pull request #4 from OrchardCMS/dev

67ff75e

Sync with upstream repository

Merge pull request #5 from OrchardCMS/dev

0c6761b

Sync with upstrem repo

Merge branch 'OrchardCMS:main' into dev

f8ec4e2

Rewrite module

4661da6

Fix warning as errors

49f3939

arkadiuszwojcik marked this pull request as ready for review September 9, 2024 16:11

Update OrchardCore.Rewrite.csproj

d7e6f61

MikeAlhayek requested changes Sep 9, 2024

View reviewed changes

MikeAlhayek changed the title ~~Rewrite module~~ URL Rewriting Module Sep 9, 2024

Code cleanup after code review

171c170

Arkadiusz Wójcik added 2 commits September 11, 2024 19:49

Rename module

0f2914a

Rename classes to match module name

3cbccfb

MikeAlhayek reviewed Sep 13, 2024

View reviewed changes

src/OrchardCore.Modules/OrchardCore.UrlRewriting/AdminMenu.cs Outdated Show resolved Hide resolved

MikeAlhayek reviewed Sep 13, 2024

View reviewed changes

src/OrchardCore.Modules/OrchardCore.UrlRewriting/Drivers/UrlRewritingSettingsDisplayDriver.cs Outdated Show resolved Hide resolved

Arkadiusz Wójcik added 2 commits September 15, 2024 12:21

- Constant for module order

2eeefea

- Permissions refactor work

- Introduce ConfigureOptions

40bf27b

- Rename Permissions class to UrlRewritingPermissionProvider

github-actions bot added the merge conflict label Sep 16, 2024

arkadiuszwojcik and others added 2 commits September 16, 2024 18:47

Merge branch 'OrchardCMS:main' into dev

5a0a436

Merge branch 'dev' into new_rewrite_module

3d86a84

github-actions bot removed the merge conflict label Sep 16, 2024

Arkadiusz Wójcik and others added 11 commits September 18, 2024 23:58

UrlRewriting UI - part 1

6d1f4b4

Merge branch 'OrchardCMS:main' into dev

ff64d23

Merge branch 'dev' into new_rewrite_module

1735f9a

UrlRewriting UI - part 2

8080821

UrlRewriting UI - part 3

23546cb

UrlRewriting UI - part 4

060a19c

Merge branch 'OrchardCMS:main' into dev

61e2ce7

Merge branch 'dev' into new_rewrite_module

397ffa0

Add recipe step

2963137

Mark classes as sealed

7ffe421

Bug fixes

806be17

arkadiuszwojcik requested a review from MikeAlhayek October 2, 2024 19:27

UI fix

8b23ca1

MikeAlhayek requested changes Oct 2, 2024

View reviewed changes

MikeAlhayek added 4 commits October 2, 2024 17:56

Cleanup, add Id to Rules and other things

45d1547

Merge branch 'main' into new_rewrite_module

8fb929f

add site release warning

78d7943

style

f5cd1f5

MikeAlhayek added 3 commits October 3, 2024 11:02

Use Queries like UI and change everything

1f83775

remove old properties from RewriteStep

342d69b

missed method

a1de614

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

URL Rewriting Module #16687

URL Rewriting Module #16687

arkadiuszwojcik commented Sep 7, 2024 •

edited by MikeAlhayek

Loading

MikeAlhayek left a comment •

edited

Loading

arkadiuszwojcik commented Sep 10, 2024

MikeAlhayek commented Sep 10, 2024

arkadiuszwojcik commented Sep 10, 2024

MikeAlhayek commented Sep 10, 2024

hishamco commented Sep 10, 2024

arkadiuszwojcik commented Sep 11, 2024 •

edited

Loading

hishamco commented Sep 11, 2024

github-actions bot commented Sep 16, 2024

MikeAlhayek commented Sep 16, 2024

arkadiuszwojcik commented Sep 16, 2024

MikeAlhayek commented Sep 16, 2024

arkadiuszwojcik commented Oct 2, 2024 •

edited

Loading

MikeAlhayek Oct 2, 2024

MikeAlhayek Oct 2, 2024

MikeAlhayek Oct 2, 2024

MikeAlhayek Oct 2, 2024

MikeAlhayek Oct 2, 2024

MikeAlhayek commented Oct 3, 2024 •

edited

Loading

MikeAlhayek commented Oct 3, 2024

MikeAlhayek commented Oct 3, 2024

	public readonly IStringLocalizer S;
	internal readonly IStringLocalizer S;

	.AddClass("urlrewriting").Id("urlrewriting")
	.AddClass("urlrewriting")
	.Id("urlrewriting")

	[HttpPost, ActionName(nameof(CreateRule))]
	[HttpPost]
	[ActionName(nameof(CreateRule))]

	[Admin("UrlRewriting/CreateRule", nameof(CreateRule))]
	[Admin("UrlRewriting/CreateRule", "CreateRewritingRule")]

URL Rewriting Module #16687

Are you sure you want to change the base?

URL Rewriting Module #16687

Conversation

arkadiuszwojcik commented Sep 7, 2024 • edited by MikeAlhayek Loading

MikeAlhayek left a comment • edited Loading

Choose a reason for hiding this comment

Updated

arkadiuszwojcik commented Sep 10, 2024

MikeAlhayek commented Sep 10, 2024

arkadiuszwojcik commented Sep 10, 2024

MikeAlhayek commented Sep 10, 2024

hishamco commented Sep 10, 2024

arkadiuszwojcik commented Sep 11, 2024 • edited Loading

hishamco commented Sep 11, 2024

github-actions bot commented Sep 16, 2024

MikeAlhayek commented Sep 16, 2024

arkadiuszwojcik commented Sep 16, 2024

MikeAlhayek commented Sep 16, 2024

arkadiuszwojcik commented Oct 2, 2024 • edited Loading

MikeAlhayek Oct 2, 2024

Choose a reason for hiding this comment

MikeAlhayek Oct 2, 2024

Choose a reason for hiding this comment

MikeAlhayek Oct 2, 2024

Choose a reason for hiding this comment

MikeAlhayek Oct 2, 2024

Choose a reason for hiding this comment

MikeAlhayek Oct 2, 2024

Choose a reason for hiding this comment

MikeAlhayek commented Oct 3, 2024 • edited Loading

MikeAlhayek commented Oct 3, 2024

MikeAlhayek commented Oct 3, 2024

arkadiuszwojcik commented Sep 7, 2024 •

edited by MikeAlhayek

Loading

MikeAlhayek left a comment •

edited

Loading

arkadiuszwojcik commented Sep 11, 2024 •

edited

Loading

arkadiuszwojcik commented Oct 2, 2024 •

edited

Loading

MikeAlhayek commented Oct 3, 2024 •

edited

Loading