Handling URL requests with different file extensions in Sitecore

Hey there! Welcome to "Sitecore Series"

Post is all about handling URL requests with different file extensions in Sitecore. 

In Sitecore, we usually add presentation in items, but what if we want the data to be displayed from the files added in webroot with .txt, .html or any other extensions? 

Example Scenarios:

1) Displaying a security file (mysitedomainurl/security.txt)

2) Loading a custom 404 page instead of default error page when the request is handled by IIS (mysitedomainurl/404.aspx or mysitedomainurl/404.html)


Here is the solution for different scenarios:

Allowing specific extensions:

Apply patch by adding required extensions as below:


<processor type= "Sitecore.Pipelines.PreprocessRequest.FilterUrlExtensions, Sitecore.Kernel">
<param desc="Allowed extensions (comma seperated)">.txt, .html</param>
</processor>

Allowing all extensions:


<processor type= "Sitecore.Pipelines.PreprocessRequest.FilterUrlExtensions, Sitecore.Kernel">
<param desc="Allowed extensions (comma seperated)">*</param>
</processor>

Blocking specific extensions:


<processor type= "Sitecore.Pipelines.PreprocessRequest.FilterUrlExtensions, Sitecore.Kernel">
<param desc="Blocked extensions (comma seperated)">.php</param>
</processor>


Complete Patch File:


<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
<sitecore>
<pipelines>
<preprocessRequest>
<processor type= "Sitecore.Pipelines.PreprocessRequest.FilterUrlExtensions, Sitecore.Kernel">
<param desc="Allowed extensions (comma seperated)">.txt, .html</param>
</processor>
</preprocessRequest>
</pipelines>
</sitecore>
</configuration>


Additional Info:

In case of url requests with file extensions, Sitecore will only process the requests contains allowed extensions.

All other file extension requests are redirected to default 404 error page, served by IIS. Want to know the details about redirecting it to the custom 404 page created in Sitecore in this scenario? 

Refer my post on displaying custom 404 page for un allowed file extensions in Sitecore.


Hope this post helps you. Happy Sitecoring... 😊

Comments

Post a Comment

Popular posts from this blog

Overwriting sxa content field in solr document

  Hey ,  there! Welcome to "Sitecore Series" Post is all about sharing the details about "Sitecore SXA search functionality and how to overwrite sxa content field". Sxa search is not returning results even some fields contains the searched text? want to know why it is not searchable and how to fix this?  Trying to generate a search query by passing an extra text like user category/content category and expecting a result with only the matched results where the item in droplist is selected with the same category? but not able to get the expected result? Then this post is for you: Sxa Search Functionality: When Sxa search is configured, if user searched any text in the searchbox it returns the matched result but have you observed this? content that is searchable is actually limits to only few fields content.  By Default the search is limits to single line, multi line and sxa tag fields content.  Sitecore Creates a computed field called "sxacontent_txm" and st
Read more

Displaying Custom 404 error page for urls with unallowed file extension in sitecore

Hey , there! Welcome to "Sitecore Series" Post is all about displaying custom 404 page for unallowed file extension requests. In Sitecore, we have an option to allow required file extensions and only the allowed file extensions are processed by Sitecore. (Not Sure? How to configure file extensions? Refer my previous post on allowing or blocking specific file extensions in Sitecore) When the custom 404 page is configured, Sitecore will process the URL and maps it with the associated file in webroot or item in Sitecore and displays it. If the file/item is not available, then it will display a custom 404 page. In case of unallowed file extensions, Sitecore will not process the request. Request is directly handled by IIS and redirects to default error page. Oh no! user is seeing default error page, not a good user experience.  Want to know how to configure a custom error page in this scenario? Yeah, this post is for you.   Refer below for the solution: Existing custom 404 page c
Read more

How to specify custom richtext menu as default richtext field setting when no source is specified for richtext field in sitecore

Image
  Hey ,  there! Welcome to "Sitecore Series" Post is all about sharing the details about "Richtext field setting in templates and setting custom menu or adding a new menu as default setting to display a different menu in richtext editor" While creating template fields, if the field type is richtext then we have an option to specify the setting item in the source. Based on the setting item, richtext menu will be displayed.  Below are the different settings provided by sitecore: 1) /sitecore/system/Settings/Html Editor Profiles/Rich Text Full 2) /sitecore/system/Settings/Html Editor Profiles/Rich Text IDE 3) /sitecore/system/Settings/Html Editor Profiles/Rich Text Limited 4) /sitecore/system/Settings/Html Editor Profiles/Rich Text Medium 5) /sitecore/system/Settings/Html Editor Profiles/Rich Text Default Based on the setting provided, richtext menu options will vary. If "Rich Text Full" setting is specified, richtext menu contains several options and if &quo
Read more

How to rebuild custom solr index programmatically in Sitecore

Image
Hey ,  there! Welcome to "Sitecore Series" Post is all about sharing the details regarding custom index rebuild through code. Sitecore rebuilds indexes data but it does not rebuild indexes very frequently, all depends on the indexing strategies specified for that index. In Sitecore, we have an option to rebuild indexes under control panel and the index rebuild can be performed manually but if we want the index to be rebuild after some operation is done or after some time span? Let's achieve this through scheduler. Create a scheduler to perform index rebuild operation.  1) scheduler : using Sitecore.Data.Items; using Sitecore.Diagnostics; using Sitecore.Tasks; namespace Testing.Feature.Testing.Scheduler { public class TestIndexRunScheduler { public void Execute(Item[] items, CommandItem command, ScheduleItem scheduleItem) { try { //Rebuild Index //Fetch the index to perform rebuild opera
Read more

Rendering Parameters and Rendering Parameter Templates in Sitecore

Image
Hey ,  there! Welcome to "Sitecore Series" Post is all about sharing the details about rendering parameters and accessing rendering parameters in code. What are rendering parameters? Rendering parameters are used to pass some extra data to a rendering and to give some control to content author on rendering display. Scenarios: 1) To handle a requirement , where the rendering to be displayed with different background colors. 2) To display a component in different ways based on the value selection. 3) Applying different css classes to the rendering. 1) How to Create Rendering Parameters: Let's take a look at below steps to understand the rendering parameters creation. As we all know the data templates are created from "standard template" but for rendering parameters the template to be created from  "Standard Rendering Parameters Template" Here is the path for the Standard Rendering Parameters Template: Templates/System/Layout/Rendering Parameters/Standard
Read more

Accessing Items from Sitecore Database in different scenarios

Hey ,  there! Welcome to "Sitecore Series" Post is all about sharing the details about "Accessing items from Databases and about Sitecore.Context.Database in different scenarios". Sitecore.Context.Database.GetItem() returning null even the items exists in the Database? Want to know more details why this is not returning any results or null? You are on right place, check below for details. Let's dig into different scenarios and ways to access database to understand more about this: Different ways to access Databases: 1) Sitecore.Data.Database database = Sitecore.Context.Database; 2) Sitecore.Data.Database database = Sitecore.Configuration.Factory.GetDatabase("master"); 3) Sitecore.Data.Database database = Sitecore.Data.Database.GetDatabase("master"); Last 2 approaches works as expected, but the issue here is we have hardcoded the database values. In the 2&3 approaches, if the piece of code is executed from CD site it will throw an error
Read more