Try our conversational search powered by Generative AI!

Deane Barker
Sep 3, 2010
  5877
(2 votes)

Correcting All Raw URLs Inside a String of HTML

If you create a link inside an EPiServer page to another EPiServer page, the link that gets embedded in the HTML is not friendly.  It looks something like this:

/Templates/PageTypes/TextPage.aspx?id=66

EPiServer corrects these links very late in the page lifecycle – actually in a response filter after the entire page has been generated.  This way, it’s sure to correct links no matter where on the page they might be.

What I noticed, however, is that these links were only getting corrected for Web forms.  More specifically, they were only getting corrected for anything with a “text/html” content type.

This was usually fine because I could change the response type, but sometimes it was an issue, especially when doing Ajax callbacks.  You often send those back as some plain text format like JSON, and you form the response at the code level, concatening the raw values of properties into a string.  Before long, you notice that your links aren’t corrected in blocks of HTML.

It’s not hard to get the friendly URL from a PageData object:

UrlBuilder url = new UrlBuilder(pd.LinkURL);
UrlRewriteProvider.ConvertToExternal(url, somePageData.PageLink, UTF8Encoding.UTF8);
string theFriendlyURl = url.ToString();

This is great to go from a PageData object to a friendly URL.  What I found to be much tricker, however, was if I had a big string of HTML with a bunch of embedded links and I needed to correct them all before working with the string.

When I was in Sweden for the Partner Summit, I posed this question to Magnus Stråle.  I was awfully grateful when he took the time to dig through EPiServer’s unit tests to find a chunk of code for me.  It’s distilled down to this function:

private string CorrectLinks(string rawHtml)
{
    var toExternal = new FriendlyHtmlRewriteToExternal(UrlBuilder.RebaseKind.ToRootRelative);
    return toExternal.RewriteString(
        new UrlBuilder(HttpContext.Current.Request.Path),
        new UrlBuilder(HttpContext.Current.Request.RawUrl),
        HttpContext.Current.Response.ContentEncoding,
        rawHtml);
}

This will take a string of HTML, correct all the links inside of it, and return another string, ready for insertion into any response, be it text, JSON, or whatever.

Thanks to Magnus for taking the time to help me solve this.

Sep 03, 2010

Comments

Mari Jørgensen
Mari Jørgensen Sep 21, 2010 10:33 AM

Nice one!

Sep 21, 2010 10:33 AM

Nice. :)

Alex Judd
Alex Judd Jan 31, 2011 07:49 PM

Interestingly this caused absolute chaos in a situation where we _did_ want to pass parameters using the URL string (GET parameters) as the page renderer tried to read our ?parameter=value set as well and use it as a page ID.

To get around this [trial and error found this out], add your own parameters with the ¶meter=value as the pageID will be by default the first parameter and want to use the ?parameter=value tag, and then EPiServer converts this to a ?parameter=tag automatically once it has tidied up the URLs in the page.

Very clever when you know how!

Please login to comment.
Latest blogs
Optimizely Web... 6 Game Changing Features in 2024

If you are interested in learning about what's new within Optimizely Web, you are in the right place. Carry on reading to learn about the 6 greates...

Jon Jones | Mar 3, 2024 | Syndicated blog

Headless forms reloaded (beta)

Forms is used on the vast majority of CMS installations. But using Forms in a headless setup is a bit of pain since the rendering pipeline is based...

MartinOttosen | Mar 1, 2024

Uploading blobs to Optimizely DXP via PowerShell

We had a client moving from an On-Prem v11 Optimizely instance to DXP v12 and we had a lot of blobs (over 40 GB) needing uploading to DXP as a part...

Nick Hamlin | Mar 1, 2024 | Syndicated blog

DbLocalizationProvider v8.0 Released

I’m pleased to announce that Localization Provider v8.0 is finally out.

valdis | Feb 28, 2024 | Syndicated blog