SaaS CMS has officially launched! Learn more now.

Minesh Shah (Netcel)
Feb 28, 2023
  2333
(5 votes)

URL Rewrites in CMS12 (.Net 6)

URL rewriting is a common technique used in web applications to create user-friendly URLs that are easier to understand, provide consistency and have SEO benefits. In the past, URL rewriting was commonly accomplished using IIS URL Rewrite module. However, with the release of .NET Core, the process of rewriting URLs has undergone some changes.

Microsoft has introduced a new URL rewriting middleware called Microsoft.AspNetCore.Rewrite. This middleware is part of the ASP.NET Core framework and is designed to rewrite URLs in a much more flexible and efficient way.

One of the key benefits of using the Microsoft.AspNetCore.Rewrite middleware is that it allows URL rewriting without requiring IIS or any other web server. This means that we can create Optimizely Solutions that are completely self-contained and can be run on any platform.

Here is an example of how to use the Microsoft.AspNetCore.Rewrite middleware in .NET 6 to handle some common conventions like redirecting to https, enforcing lowercase urls and adding trailing slash to the end of all URLs:

Lower Case URL – Implement IRule Base Rule

    public class LowercaseUrlsRule : IRule
    {
        public int StatusCode { get; } = (int)HttpStatusCode.MovedPermanently;

        public void ApplyRule(RewriteContext context)
        {
            HttpRequest request = context.HttpContext.Request;
            PathString path = context.HttpContext.Request.Path;
            HostString host = context.HttpContext.Request.Host;

            if (path.HasValue && path.Value.Any(char.IsUpper) || host.HasValue && host.Value.Any(char.IsUpper))
            {
                HttpResponse response = context.HttpContext.Response;
                response.StatusCode = StatusCode;
                response.Headers[HeaderNames.Location] = (request.Scheme + "://" + host.Value + request.PathBase.Value + request.Path.Value).ToLower() + request.QueryString;
                context.Result = RuleResult.EndResponse;
            }
            else
            {
                context.Result = RuleResult.ContinueRules;
            }
        }
    }

Use Rules in Middleware Startup.cs

In the example below we are using the RewriteOptions class to define paths that should be negated, and adding the rules for forcing HTTPS, Lowercase and Trailing Slashes. I have explicitly added below app.UseStaticFiles() so the rules do not get added to files like css, javascript or images.

        app.UseStaticFiles();

        var options = new RewriteOptions()
            .Add(context =>
                {
                    if (context.HttpContext.Request.Path.StartsWithSegments("/util") || 
                        context.HttpContext.Request.Path.StartsWithSegments("/episerver") || 
                        context.HttpContext.Request.Path.StartsWithSegments("/modules"))
                    {
                        context.Result = RuleResult.SkipRemainingRules;
                    }
                })
            // Redirect to HTTPS
            .AddRedirectToHttpsPermanent()
            // Enforce lower case. 
            .Add(new LowercaseUrlsRule())
            // Enforce trailing slash.
            .AddRedirect("(.*[^/])$", "$1/");



        app.UseRewriter(options);

These techniques are not Optimizely specific and can be applied to any .Net Solution, more info on IRule based rewrites can be found here

Feb 28, 2023

Comments

EVT
EVT Jul 25, 2023 10:37 AM

Row

response.Headers[HeaderNames.Location] = url.ToLowerInvariant() + request.QueryString;

fails if there is a non ascii character in the URL. Perhaps it should be changed to 

response.Headers[HeaderNames.Location] = UriHelper.Encode(new Uri((request.Scheme + "://" + host.Value + request.PathBase.Value + request.Path.Value).ToLower() + request.QueryString));

Tim Hilton
Tim Hilton Jan 12, 2024 05:19 PM

Thanks for a useful article Minesh.

Just a point to note, these redirects are processing sequentially causing a number of redirects if mutiple conditions are met. 

For example if the url has uppercase characters and a missing trailling slash the response is 301 lowercase > 302 trailling slash > 200 ok.

A minor update to the LowercaseUrlsRule, to resolve the other conditions at the same time helps this.

string slash = !path.Value.EndsWith("/") ? "/" : string.Empty;
string lowerPath = $"https://{host.Value}{request.PathBase.Value}{request.Path.Value}{slash}".ToLower();
...

Please login to comment.
Latest blogs
Optimizely SaaS CMS Concepts and Terminologies

Whether you're a new user of Optimizely CMS or a veteran who have been through the evolution of it, the SaaS CMS is bringing some new concepts and...

Patrick Lam | Jul 15, 2024

How to have a link plugin with extra link id attribute in TinyMce

Introduce Optimizely CMS Editing is using TinyMce for editing rich-text content. We need to use this control a lot in CMS site for kind of WYSWYG...

Binh Nguyen Thi | Jul 13, 2024

Create your first demo site with Optimizely SaaS/Visual Builder

Hello everyone, We are very excited about the launch of our SaaS CMS and the new Visual Builder that comes with it. Since it is the first time you'...

Patrick Lam | Jul 11, 2024

Integrate a CMP workflow step with CMS

As you might know Optimizely has an integration where you can create and edit pages in the CMS directly from the CMP. One of the benefits of this i...

Marcus Hoffmann | Jul 10, 2024

GetNextSegment with empty Remaining causing fuzzes

Optimizely CMS offers you to create partial routers. This concept allows you display content differently depending on the routed content in the URL...

David Drouin-Prince | Jul 8, 2024 | Syndicated blog

Product Listing Page - using Graph

Optimizely Graph makes it possible to query your data in an advanced way, by using GraphQL. Querying data, using facets and search phrases, is very...

Jonas Bergqvist | Jul 5, 2024