Skip to main content

Blog

Home
About Us
What We Do
ContactUs
Blog
Sign In
  
Go Search
Other Blogs
There are no items in this list.
Home > Blog 

Include and Exclude Constraints in ASP.NET MVC

Otherwise known as a white list or black list for route tokens, this simple IRouteConstraint is coming in handy and I thought i would share:

  1. public enum ListConstraintType {
  2.     Exclude,
  3.     Include
  4. }
  6. public class ListConstraint : IRouteConstraint {
  7.     public ListConstraintType ListType { get; set; }
  8.     public IList<string> List { get; set; }
  10.     public ListConstraint() : this(ListConstraintType.Include, new string[] { }) { }
  11.     public ListConstraint(params string[] list) : this(ListConstraintType.Include, list) { }
  12.     public ListConstraint(ListConstraintType listType, params string[] list) {
  13.         if (list == null) throw new ArgumentNullException("list");
  15.         this.ListType = listType;
  16.         this.List = new List<string>(list);
  17.     }
  19.     public bool Match(HttpContextBase httpContext, Route route, string parameterName, RouteValueDictionary values, RouteDirection routeDirection) {
  20.         if (string.IsNullOrEmpty(parameterName)) throw new ArgumentNullException("parameterName");
  21.         if (values == null) throw new ArgumentNullException("values");
  23.         string value = values[parameterName.ToLower()] as string;
  24.         bool found = this.List.Any(s => s.Equals(value, StringComparison.OrdinalIgnoreCase));
  26.         return this.ListType == ListConstraintType.Include ? found : !found;
  27.     }
  28. }

You can then use the ListConstraint like this:

  1. public static void RegisterRoutes(RouteCollection routes) {
  2.     routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
  3.     routes.IgnoreRoute("content/{*pathInfo}");
  4.     routes.IgnoreRoute("favicon.ico");
  6.     routes.MapRoute(
  7.         "UserShortcuts",
  8.         "{action}/{id}",
  9.         new { controller = "user", id = "" },
  10.         new { action = new ListConstraint(ListConstraintType.Include, "signin", "signout") }
  11.     );
  13.     routes.MapRoute(
  14.         "HomeShortcuts",
  15.         "{action}",
  16.         new { controller = "home" },
  17.         new { action = new ListConstraint("sitemap", "contact") } //default Include
  18.     );
  20.     routes.MapRoute(
  21.         "Default",
  22.         "{controller}/{action}/{id}",
  23.         new { controller = "home", action = "index", id = "" },
  24.         new { id = new ListConstraint(ListConstraintType.Exclude, "123") }
  25.     );
  26. }
  28. protected void Application_Start() {
  29.     RegisterRoutes(RouteTable.Routes);
  30. }

Which then allows only those included constraints to use the UserShortcuts route:

Or prevents the id of 123 from being used on the Default route:

 

Hope folks find this useful,

Jason Conway

Posted at 10/23/2009 8:16 PM by Jason Conway | Category: Development | Permalink | Email this Post | Comments (0)

Aliasing and Localizing Routes in ASP.NET MVC

I had come across a forum post where someone wanted to localize urls in the RouteTable and I thought I would come up with my first stab at a better solution.  What I discovered turned out to be a pretty simple way of what I am calling ‘Aliasing Routes’ where a route token can have an alias value as a localized value.

DOWNLOAD – My entire MvcSamples VSTS solution (complete with Moq and 100% code coverage)

This is how you do it (the complete source is available for download above):

Step 1: Persistence – we need a way to store the aliases, so I created a custom ConfigurationSection (an external file or database would also work) that looks like this when complete:

  1. <aliasRoutes>
  2.   <routes>
  3.     <add token="controller" value="home" aliases="inicio, beginning, baile, start" />
  4.     <add token="controller" value="about" aliases="info, sobre, more, additional" />
  5.     <add token="action" value="signin" aliases="login, logon, ingresar, anmelden" />
  6.   </routes>
  7. </aliasRoutes>

Step 2: Module – we need a way to inspect route data and change route values when applicable, so I derived from UrlRoutingModule that looks like this when complete:

  1. public class AliasRoutingModule : UrlRoutingModule {
  2.     protected static readonly object itemsKey = new object();
  4.     private class RequestInfo {
  5.         public string OriginalPath { get; set; }
  6.         public IHttpHandler HttpHandler { get; set; }
  7.     }
  9.     public override void PostMapRequestHandler(HttpContextBase context) {
  10.         Guard.AgainstNullParameter(context, "context");
  12.         RequestInfo info = context.Items[itemsKey] as RequestInfo;
  13.         if (info == null) return;
  15.         context.RewritePath(info.OriginalPath);
  16.         context.Handler = info.HttpHandler;
  17.     }
  19.     public override void PostResolveRequestCache(HttpContextBase context) {
  20.         Guard.AgainstNullParameter(context, "context");
  22.         RouteData routeData = this.RouteCollection.GetRouteData(context);
  23.         if (routeData == null) return;
  25.         IRouteHandler routeHandler = routeData.RouteHandler;
  26.         if (routeHandler == null) throw new InvalidOperationException("No RouteHandler identified");
  27.         if (routeHandler is StopRoutingHandler) return;
  29.         IDictionary<string, object> values = new Dictionary<string, object>(routeData.Values);
  30.         AliasRoutesSection section = SectionRepository.Current.AliasRoutes;
  32.         //*** magic happens here
  33.         foreach (string token in values.Keys) {
  34.             string alias = values[token].ToString();
  35.             string value = section.Routes.GetValue(token, alias);
  37.             if (value != null) routeData.Values[token] = value;
  38.         }
  40.         RequestContext requestContext = new RequestContext(context, routeData);
  41.         IHttpHandler httpHandler = routeHandler.GetHttpHandler(requestContext);
  42.         if (httpHandler == null) throw new InvalidOperationException("No HttpHandler identified");
  44.         RequestInfo info = new RequestInfo {
  45.             OriginalPath = context.Request.Path,
  46.             HttpHandler = httpHandler
  47.         };
  49.         context.Items[itemsKey] = info;
  50.         context.RewritePath("~/UrlRouting.axd");
  51.     }
  52. }

Step 3: Web Config – need to change our UrlRoutingModule registration in the web.config to the new AliasRoutingModule:

  1.   <httpModules>
  2.     <add name="ScriptModule"
  3.          type="System.Web.Handlers.ScriptModule, System.Web.Extensions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35"/>
  4.     <add name="AliasRoutingModule"
  5.          type="Salient6.MvcSamples.Web.Modules.AliasRoutingModule"/>
  6.   </httpModules>
  7. </system.web>

Step 4: RegisterRoutes – our Global stays clean and manageable:

  1. public static void RegisterRoutes(RouteCollection routes) {
  2.     routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
  3.     routes.IgnoreRoute("content/{*pathInfo}");
  4.     routes.IgnoreRoute("favicon.ico");
  6.     routes.MapRoute(
  7.         "Default",                                              
  8.         "{controller}/{action}/{id}",                           
  9.         new { controller = "home", action = "index", id = "" }
  10.     );
  11. }

Step 5: Browser – we should be able to get to the Home Controller now by navigating to /start:

Alias Route Start

OR something way cooler like /inicio/anmelden  which is a combination of Controller and Action aliases!

Alias Route Start

What’s nice about this is you can alias and/or localize your url without having to MapRoute, you can make changes in the config without having to recompile, and you can mix and match aliases as long as they resolve to a valid endpoint!

Anyway, I hope folks find this useful!

Jason Conway

kick it on DotNetKicks.com

Posted at 10/22/2009 5:21 PM by Jason Conway | Category: Development | Permalink | Email this Post | Comments (0)

10/23/2009

Include and Exclude Constraints in ASP.NET MVC

Otherwise known as a white list or black list for route tokens, this simple IRouteConstraint is coming in handy and I thought i would share:

  1. public enum ListConstraintType {
  2.     Exclude,
  3.     Include
  4. }
  6. public class ListConstraint : IRouteConstraint {
  7.     public ListConstraintType ListType { get; set; }
  8.     public IList<string> List { get; set; }
  10.     public ListConstraint() : this(ListConstraintType.Include, new string[] { }) { }
  11.     public ListConstraint(params string[] list) : this(ListConstraintType.Include, list) { }
  12.     public ListConstraint(ListConstraintType listType, params string[] list) {
  13.         if (list == null) throw new ArgumentNullException("list");
  15.         this.ListType = listType;
  16.         this.List = new List<string>(list);
  17.     }
  19.     public bool Match(HttpContextBase httpContext, Route route, string parameterName, RouteValueDictionary values, RouteDirection routeDirection) {
  20.         if (string.IsNullOrEmpty(parameterName)) throw new ArgumentNullException("parameterName");
  21.         if (values == null) throw new ArgumentNullException("values");
  23.         string value = values[parameterName.ToLower()] as string;
  24.         bool found = this.List.Any(s => s.Equals(value, StringComparison.OrdinalIgnoreCase));
  26.         return this.ListType == ListConstraintType.Include ? found : !found;
  27.     }
  28. }

You can then use the ListConstraint like this:

  1. public static void RegisterRoutes(RouteCollection routes) {
  2.     routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
  3.     routes.IgnoreRoute("content/{*pathInfo}");
  4.     routes.IgnoreRoute("favicon.ico");
  6.     routes.MapRoute(
  7.         "UserShortcuts",
  8.         "{action}/{id}",
  9.         new { controller = "user", id = "" },
  10.         new { action = new ListConstraint(ListConstraintType.Include, "signin", "signout") }
  11.     );
  13.     routes.MapRoute(
  14.         "HomeShortcuts",
  15.         "{action}",
  16.         new { controller = "home" },
  17.         new { action = new ListConstraint("sitemap", "contact") } //default Include
  18.     );
  20.     routes.MapRoute(
  21.         "Default",
  22.         "{controller}/{action}/{id}",
  23.         new { controller = "home", action = "index", id = "" },
  24.         new { id = new ListConstraint(ListConstraintType.Exclude, "123") }
  25.     );
  26. }
  28. protected void Application_Start() {
  29.     RegisterRoutes(RouteTable.Routes);
  30. }

Which then allows only those included constraints to use the UserShortcuts route:

Or prevents the id of 123 from being used on the Default route:

 

Hope folks find this useful,

Jason Conway

Posted at 8:16 PM by Jason Conway | Category: Development | Permalink | Email this Post | Comments (0)

10/22/2009

Aliasing and Localizing Routes in ASP.NET MVC

I had come across a forum post where someone wanted to localize urls in the RouteTable and I thought I would come up with my first stab at a better solution.  What I discovered turned out to be a pretty simple way of what I am calling ‘Aliasing Routes’ where a route token can have an alias value as a localized value.

DOWNLOAD – My entire MvcSamples VSTS solution (complete with Moq and 100% code coverage)

This is how you do it (the complete source is available for download above):

Step 1: Persistence – we need a way to store the aliases, so I created a custom ConfigurationSection (an external file or database would also work) that looks like this when complete:

  1. <aliasRoutes>
  2.   <routes>
  3.     <add token="controller" value="home" aliases="inicio, beginning, baile, start" />
  4.     <add token="controller" value="about" aliases="info, sobre, more, additional" />
  5.     <add token="action" value="signin" aliases="login, logon, ingresar, anmelden" />
  6.   </routes>
  7. </aliasRoutes>

Step 2: Module – we need a way to inspect route data and change route values when applicable, so I derived from UrlRoutingModule that looks like this when complete:

  1. public class AliasRoutingModule : UrlRoutingModule {
  2.     protected static readonly object itemsKey = new object();
  4.     private class RequestInfo {
  5.         public string OriginalPath { get; set; }
  6.         public IHttpHandler HttpHandler { get; set; }
  7.     }
  9.     public override void PostMapRequestHandler(HttpContextBase context) {
  10.         Guard.AgainstNullParameter(context, "context");
  12.         RequestInfo info = context.Items[itemsKey] as RequestInfo;
  13.         if (info == null) return;
  15.         context.RewritePath(info.OriginalPath);
  16.         context.Handler = info.HttpHandler;
  17.     }
  19.     public override void PostResolveRequestCache(HttpContextBase context) {
  20.         Guard.AgainstNullParameter(context, "context");
  22.         RouteData routeData = this.RouteCollection.GetRouteData(context);
  23.         if (routeData == null) return;
  25.         IRouteHandler routeHandler = routeData.RouteHandler;
  26.         if (routeHandler == null) throw new InvalidOperationException("No RouteHandler identified");
  27.         if (routeHandler is StopRoutingHandler) return;
  29.         IDictionary<string, object> values = new Dictionary<string, object>(routeData.Values);
  30.         AliasRoutesSection section = SectionRepository.Current.AliasRoutes;
  32.         //*** magic happens here
  33.         foreach (string token in values.Keys) {
  34.             string alias = values[token].ToString();
  35.             string value = section.Routes.GetValue(token, alias);
  37.             if (value != null) routeData.Values[token] = value;
  38.         }
  40.         RequestContext requestContext = new RequestContext(context, routeData);
  41.         IHttpHandler httpHandler = routeHandler.GetHttpHandler(requestContext);
  42.         if (httpHandler == null) throw new InvalidOperationException("No HttpHandler identified");
  44.         RequestInfo info = new RequestInfo {
  45.             OriginalPath = context.Request.Path,
  46.             HttpHandler = httpHandler
  47.         };
  49.         context.Items[itemsKey] = info;
  50.         context.RewritePath("~/UrlRouting.axd");
  51.     }
  52. }

Step 3: Web Config – need to change our UrlRoutingModule registration in the web.config to the new AliasRoutingModule:

  1.   <httpModules>
  2.     <add name="ScriptModule"
  3.          type="System.Web.Handlers.ScriptModule, System.Web.Extensions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35"/>
  4.     <add name="AliasRoutingModule"
  5.          type="Salient6.MvcSamples.Web.Modules.AliasRoutingModule"/>
  6.   </httpModules>
  7. </system.web>

Step 4: RegisterRoutes – our Global stays clean and manageable:

  1. public static void RegisterRoutes(RouteCollection routes) {
  2.     routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
  3.     routes.IgnoreRoute("content/{*pathInfo}");
  4.     routes.IgnoreRoute("favicon.ico");
  6.     routes.MapRoute(
  7.         "Default",                                              
  8.         "{controller}/{action}/{id}",                           
  9.         new { controller = "home", action = "index", id = "" }
  10.     );
  11. }

Step 5: Browser – we should be able to get to the Home Controller now by navigating to /start:

Alias Route Start

OR something way cooler like /inicio/anmelden  which is a combination of Controller and Action aliases!

Alias Route Start

What’s nice about this is you can alias and/or localize your url without having to MapRoute, you can make changes in the config without having to recompile, and you can mix and match aliases as long as they resolve to a valid endpoint!

Anyway, I hope folks find this useful!

Jason Conway

kick it on DotNetKicks.com

Posted at 5:21 PM by Jason Conway | Category: Development | Permalink | Email this Post | Comments (0)

 ‭(Hidden)‬ Admin Links

 Recent Posts
Include and Exclude Constraints in ASP.NET MVC
Aliasing and Localizing Routes in ASP.NET MVC