mcs/class/System.Web.Routing/System.Web.Routing/Route.cs

   1 //
   2 // Route.cs
   3 //
   4 // Author:
   5 //      Atsushi Enomoto <atsushi@ximian.com>
   6 //
   7 // Copyright (C) 2008 Novell Inc. http://novell.com
   8 //
   9
  10 //
  11 // Permission is hereby granted, free of charge, to any person obtaining
  12 // a copy of this software and associated documentation files (the
  13 // "Software"), to deal in the Software without restriction, including
  14 // without limitation the rights to use, copy, modify, merge, publish,
  15 // distribute, sublicense, and/or sell copies of the Software, and to
  16 // permit persons to whom the Software is furnished to do so, subject to
  17 // the following conditions:
  18 //
  19 // The above copyright notice and this permission notice shall be
  20 // included in all copies or substantial portions of the Software.
  21 //
  22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  25 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  26 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  27 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  29 //
  30 using System;
  31 using System.Runtime.CompilerServices;
  32 using System.Security.Permissions;
  33 using System.Text.RegularExpressions;
  34 using System.Web;
  35
  36 namespace System.Web.Routing
  37 {
  38 #if NET_4_0
  39         [TypeForwardedFrom ("System.Web.Routing, Version=3.5.0.0, Culture=Neutral, PublicKeyToken=31bf3856ad364e35")]
  40 #endif
  41         [AspNetHostingPermission (SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
  42         [AspNetHostingPermission (SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
  43         public class Route : RouteBase
  44         {
  45                 PatternParser url;
  46
  47                 public RouteValueDictionary Constraints { get; set; }
  48
  49                 public RouteValueDictionary DataTokens { get; set; }
  50
  51                 public RouteValueDictionary Defaults { get; set; }
  52
  53                 public IRouteHandler RouteHandler { get; set; }
  54
  55                 public string Url {
  56                         get { return url != null ? url.Url : String.Empty; }
  57                         set { url = value != null ? new PatternParser (value) : new PatternParser (String.Empty); }
  58                 }
  59
  60                 public Route (string url, IRouteHandler routeHandler)
  61                         : this (url, null, routeHandler)
  62                 {
  63                 }
  64
  65                 public Route (string url, RouteValueDictionary defaults, IRouteHandler routeHandler)
  66                         : this (url, defaults, null, routeHandler)
  67                 {
  68                 }
  69
  70                 public Route (string url, RouteValueDictionary defaults, RouteValueDictionary constraints, IRouteHandler routeHandler)
  71                         : this (url, defaults, constraints, null, routeHandler)
  72                 {
  73                 }
  74
  75                 public Route (string url, RouteValueDictionary defaults, RouteValueDictionary constraints, RouteValueDictionary dataTokens, IRouteHandler routeHandler)
  76                 {
  77                         Url = url;
  78                         Defaults = defaults;
  79                         Constraints = constraints;
  80                         DataTokens = dataTokens;
  81                         RouteHandler = routeHandler;
  82                 }
  83
  84                 public override RouteData GetRouteData (HttpContextBase httpContext)
  85                 {
  86                         var path = httpContext.Request.AppRelativeCurrentExecutionFilePath;
  87                         var pathInfo = httpContext.Request.PathInfo;
  88
  89                         if (!String.IsNullOrEmpty (pathInfo))
  90                                 throw new NotImplementedException ();
  91
  92                         // probably code like this causes ArgumentOutOfRangeException under .NET.
  93                         // It somehow allows such path that is completely equivalent to the Url. Dunno why.
  94                         if (Url != path && path.Substring (0, 2) != "~/")
  95                                 return null;
  96                         path = path.Substring (2);
  97
  98                         var values = url.Match (path, Defaults);
  99                         if (values == null)
 100                                 return null;
 101
 102                         RouteValueDictionary constraints = Constraints;
 103                         if (constraints != null)
 104                                 foreach (var p in constraints)
 105                                         if (!ProcessConstraint (httpContext, p.Value, p.Key, values, RouteDirection.IncomingRequest))
 106                                                 return null;
 107
 108                         var rd = new RouteData (this, RouteHandler);
 109                         RouteValueDictionary rdValues = rd.Values;
 110
 111                         foreach (var p in values)
 112                                 rdValues.Add (p.Key, p.Value);
 113
 114                         RouteValueDictionary dataTokens = DataTokens;
 115                         if (dataTokens != null) {
 116                                 RouteValueDictionary rdDataTokens = rd.DataTokens;
 117                                 foreach (var token in dataTokens)
 118                                         rdDataTokens.Add (token.Key, token.Value);
 119                         }
 120
 121                         return rd;
 122                 }
 123
 124                 public override VirtualPathData GetVirtualPath (RequestContext requestContext, RouteValueDictionary values)
 125                 {
 126                         if (requestContext == null)
 127                                 throw new ArgumentNullException ("requestContext");
 128                         if (url == null)
 129                                 return new VirtualPathData (this, String.Empty);
 130
 131                         // null values is allowed.
 132                         // if (values == null)
 133                         //      values = requestContext.RouteData.Values;
 134
 135                         string s;
 136                         if (!url.BuildUrl (this, requestContext, values, out s))
 137                                 return null;
 138
 139                         return new VirtualPathData (this, s);
 140                 }
 141
 142                 internal static bool ProcessConstraintInternal (HttpContextBase httpContext, Route route, object constraint, string parameterName,
 143                                                                 RouteValueDictionary values, RouteDirection routeDirection, out bool invalidConstraint)
 144                 {
 145                         invalidConstraint = false;
 146                         IRouteConstraint irc = constraint as IRouteConstraint;
 147                         if (irc != null)
 148                                 return irc.Match (httpContext, route, parameterName, values, routeDirection);
 149
 150                         string s = constraint as string;
 151                         if (s != null) {
 152                                 string v = values [parameterName] as string;
 153                                 if (!String.IsNullOrEmpty (v)) {
 154                                         int slen = s.Length;
 155                                         if (slen > 0) {
 156                                                 // Bug #651966 - regexp constraints must be treated
 157                                                 // as absolute expressions
 158                                                 if (s [0] != '^') {
 159                                                         s = "^" + s;
 160                                                         slen++;
 161                                                 }
 162
 163                                                 if (s [slen - 1] != '$')
 164                                                         s += "$";
 165                                         }
 166
 167                                         return Regex.Match (v, s).Success;
 168                                 }
 169                                 return false;
 170                         }
 171
 172                         invalidConstraint = true;
 173                         return false;
 174                 }
 175
 176                 protected virtual bool ProcessConstraint (HttpContextBase httpContext, object constraint, string parameterName, RouteValueDictionary values, RouteDirection routeDirection)
 177                 {
 178                         if (parameterName == null)
 179                                 throw new ArgumentNullException ("parameterName");
 180
 181                         // .NET "compatibility"
 182                         if (values == null)
 183                                 throw new NullReferenceException ();
 184
 185                         bool invalidConstraint;
 186                         bool ret = ProcessConstraintInternal (httpContext, this, constraint, parameterName, values, routeDirection, out invalidConstraint);
 187
 188                         if (invalidConstraint)
 189                                 throw new InvalidOperationException (
 190                                         String.Format (
 191                                                 "Constraint parameter '{0}' on the route with URL '{1}' must have a string value type or be a type which implements IRouteConstraint",
 192                                                 parameterName, Url
 193                                         )
 194                                 );
 195
 196                         return ret;
 197                 }
 198         }
 199 }