#2 add options, #19 fix IP parser, update extensions.

Tratcher · Tratcher · commit 5e3c7cbbf0a9 · 2015-12-15T15:28:14.000-08:00
diff --git a/BasicMiddleware.sln b/BasicMiddleware.sln
@@ -1,7 +1,7 @@
 ﻿
 Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 14
-VisualStudioVersion = 14.0.23107.0
+VisualStudioVersion = 14.0.24720.0
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "Microsoft.AspNet.HttpOverrides", "src\Microsoft.AspNet.HttpOverrides\Microsoft.AspNet.HttpOverrides.xproj", "{517308C3-B477-4B01-B461-CAB9C10B6928}"
 EndProject
@@ -24,6 +24,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples", "samples", "{9587
 EndProject
 Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "ResponseBufferingSample", "samples\ResponseBufferingSample\ResponseBufferingSample.xproj", "{E5C55B80-7827-40EB-B661-32B0E0E431CA}"
 EndProject
+Project("{8BB2217D-0F2D-49D1-97BC-3654ED321F3B}") = "HttpOverridesSample", "samples\HttpOverridesSample\HttpOverridesSample.xproj", "{7F95478D-E1D4-4A64-BA42-B041591A96EB}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -50,6 +52,10 @@ Global
 		{E5C55B80-7827-40EB-B661-32B0E0E431CA}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{E5C55B80-7827-40EB-B661-32B0E0E431CA}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{E5C55B80-7827-40EB-B661-32B0E0E431CA}.Release|Any CPU.Build.0 = Release|Any CPU
+		{7F95478D-E1D4-4A64-BA42-B041591A96EB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{7F95478D-E1D4-4A64-BA42-B041591A96EB}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{7F95478D-E1D4-4A64-BA42-B041591A96EB}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{7F95478D-E1D4-4A64-BA42-B041591A96EB}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -60,5 +66,6 @@ Global
 		{2363D0DD-A3BF-437E-9B64-B33AE132D875} = {A5076D28-FA7E-4606-9410-FEDD0D603527}
 		{F5F1D123-9C81-4A9E-8644-AA46B8E578FB} = {8437B0F3-3894-4828-A945-A9187F37631D}
 		{E5C55B80-7827-40EB-B661-32B0E0E431CA} = {9587FE9F-5A17-42C4-8021-E87F59CECB98}
+		{7F95478D-E1D4-4A64-BA42-B041591A96EB} = {9587FE9F-5A17-42C4-8021-E87F59CECB98}
 	EndGlobalSection
 EndGlobal
diff --git a/samples/HttpOverridesSample/HttpOverridesSample.xproj b/samples/HttpOverridesSample/HttpOverridesSample.xproj
@@ -0,0 +1,25 @@
+﻿<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="14.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <VisualStudioVersion Condition="'$(VisualStudioVersion)' == ''">14.0</VisualStudioVersion>
+    <VSToolsPath Condition="'$(VSToolsPath)' == ''">$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)</VSToolsPath>
+  </PropertyGroup>
+
+  <Import Project="$(VSToolsPath)\DNX\Microsoft.DNX.Props" Condition="'$(VSToolsPath)' != ''" />
+  <PropertyGroup Label="Globals">
+    <ProjectGuid>7f95478d-e1d4-4a64-ba42-b041591a96eb</ProjectGuid>
+    <RootNamespace>HttpOverridesSample</RootNamespace>
+    <BaseIntermediateOutputPath Condition="'$(BaseIntermediateOutputPath)'=='' ">..\..\artifacts\obj\$(MSBuildProjectName)</BaseIntermediateOutputPath>
+    <OutputPath Condition="'$(OutputPath)'=='' ">..\..\artifacts\bin\$(MSBuildProjectName)\</OutputPath>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <SchemaVersion>2.0</SchemaVersion>
+  </PropertyGroup>
+  <ItemGroup>
+    <DnxInvisibleContent Include="bower.json" />
+    <DnxInvisibleContent Include=".bowerrc" />
+    <DnxInvisibleContent Include="package.json" />
+  </ItemGroup>
+  <Import Project="$(VSToolsPath)\DNX\Microsoft.DNX.targets" Condition="'$(VSToolsPath)' != ''" />
+</Project>
diff --git a/samples/HttpOverridesSample/Properties/launchSettings.json b/samples/HttpOverridesSample/Properties/launchSettings.json
@@ -0,0 +1,25 @@
+{
+  "iisSettings": {
+    "windowsAuthentication": false,
+    "anonymousAuthentication": true,
+    "iisExpress": {
+      "applicationUrl": "http://localhost:1658/",
+      "sslPort": 0
+    }
+  },
+  "profiles": {
+    "IIS Express": {
+      "commandName": "IISExpress",
+      "launchBrowser": true,
+      "environmentVariables": {
+        "ASPNET_ENVIRONMENT": "Development"
+      }
+    },
+    "web": {
+      "commandName": "web",
+      "environmentVariables": {
+        "ASPNET_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}
diff --git a/samples/HttpOverridesSample/Startup.cs b/samples/HttpOverridesSample/Startup.cs
@@ -0,0 +1,36 @@
+﻿using Microsoft.AspNet.Builder;
+using Microsoft.AspNet.Hosting;
+using Microsoft.AspNet.Http;
+using Microsoft.AspNet.HttpOverrides;
+
+namespace HttpOverridesSample
+{
+    public class Startup
+    {
+        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
+        public void Configure(IApplicationBuilder app)
+        {
+            app.UseIISPlatformHandler();
+            app.UseOverrideHeaders(options =>
+            {
+                options.ForwardedOptions = ForwardedHeaders.All;
+            });
+            app.UseHttpMethodOverride();
+
+            app.Run(async (context) =>
+            {
+                foreach (var header in context.Request.Headers)
+                {
+                    await context.Response.WriteAsync($"{header.Key}: {header.Value}\r\n");
+                }
+                await context.Response.WriteAsync($"Method: {context.Request.Method}\r\n");
+                await context.Response.WriteAsync($"Scheme: {context.Request.Scheme}\r\n");
+                await context.Response.WriteAsync($"RemoteIP: {context.Connection.RemoteIpAddress}\r\n");
+                await context.Response.WriteAsync($"RemotePort: {context.Connection.RemotePort}\r\n");
+            });
+        }
+
+        // Entry point for the application.
+        public static void Main(string[] args) => WebApplication.Run<Startup>(args);
+    }
+}
diff --git a/samples/HttpOverridesSample/hosting.json b/samples/HttpOverridesSample/hosting.json
@@ -0,0 +1,3 @@
+﻿{
+  "server": "Microsoft.AspNet.Server.Kestrel"
+}
diff --git a/samples/HttpOverridesSample/project.json b/samples/HttpOverridesSample/project.json
@@ -0,0 +1,26 @@
+﻿{
+  "version": "1.0.0-*",
+  "compilationOptions": {
+    "emitEntryPoint": true
+  },
+  "dependencies": {
+    "Microsoft.AspNet.IISPlatformHandler": "1.0.0-*",
+    "Microsoft.AspNet.Server.Kestrel": "1.0.0-*",
+    "Microsoft.AspNet.HttpOverrides": "1.0.0-*"
+  },
+  "commands": {
+    "web": "HttpOverridesSample"
+  },
+  "frameworks": {
+    "dnx451": { },
+    "dnxcore50": { }
+  },
+  "exclude": [
+    "wwwroot",
+    "node_modules"
+  ],
+  "publishExclude": [
+    "**.user",
+    "**.vspscc"
+  ]
+}
diff --git a/samples/HttpOverridesSample/wwwroot/web.config b/samples/HttpOverridesSample/wwwroot/web.config
@@ -0,0 +1,9 @@
+﻿<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <system.webServer>
+    <handlers>
+      <add name="httpPlatformHandler" path="*" verb="*" modules="httpPlatformHandler" resourceType="Unspecified"/>
+    </handlers>
+    <httpPlatform processPath="%DNX_PATH%" arguments="%DNX_ARGS%" stdoutLogEnabled="false" startupTimeLimit="3600"/>
+  </system.webServer>
+</configuration>
diff --git a/src/Microsoft.AspNet.HttpOverrides/HttpMethodOverrideExtensions.cs b/src/Microsoft.AspNet.HttpOverrides/HttpMethodOverrideExtensions.cs
@@ -1,6 +1,7 @@
 ﻿// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
+using System;
 using Microsoft.AspNet.HttpOverrides;
 
 namespace Microsoft.AspNet.Builder
@@ -14,7 +15,11 @@ public static class HttpMethodOverrideExtensions
         /// <returns></returns>
         public static IApplicationBuilder UseHttpMethodOverride(this IApplicationBuilder builder)
         {
-            return builder.Use(next => new HttpMethodOverrideMiddleware(next).Invoke);
+            if (builder == null)
+            {
+                throw new ArgumentNullException(nameof(builder));
+            }
+            return builder.Use(next => new HttpMethodOverrideMiddleware(next, new HttpMethodOverrideOptions()).Invoke);
         }
 
         /// <summary>
@@ -23,9 +28,19 @@ public static IApplicationBuilder UseHttpMethodOverride(this IApplicationBuilder
         /// <param name="builder"></param>
         /// <param name="formFieldInput">Denotes the element that contains the name of the resulting method type.</param>
         /// <returns></returns>
-        public static IApplicationBuilder UseHttpMethodOverride(this IApplicationBuilder builder, string formFieldInput)
+        public static IApplicationBuilder UseHttpMethodOverride(this IApplicationBuilder builder, Action<HttpMethodOverrideOptions> configureOptions)
         {
-            return builder.Use(next => new HttpMethodOverrideMiddleware(next, formFieldInput).Invoke);
+            if (builder == null)
+            {
+                throw new ArgumentNullException(nameof(builder));
+            }
+            if (configureOptions == null)
+            {
+                throw new ArgumentNullException(nameof(configureOptions));
+            }
+            var options = new HttpMethodOverrideOptions();
+            configureOptions(options);
+            return builder.Use(next => new HttpMethodOverrideMiddleware(next, options).Invoke);
         }
     }
 }
diff --git a/src/Microsoft.AspNet.HttpOverrides/HttpMethodOverrideMiddleware.cs b/src/Microsoft.AspNet.HttpOverrides/HttpMethodOverrideMiddleware.cs
@@ -3,7 +3,6 @@
 
 using System;
 using System.Threading.Tasks;
-using Microsoft.AspNet.Builder;
 using Microsoft.AspNet.Http;
 
 namespace Microsoft.AspNet.HttpOverrides
@@ -12,24 +11,32 @@ public class HttpMethodOverrideMiddleware
     {
         private const string xHttpMethodOverride = "X-Http-Method-Override";
         private readonly RequestDelegate _next;
-        private readonly string _formFieldName;
+        private readonly HttpMethodOverrideOptions _options;
 
-        public HttpMethodOverrideMiddleware(RequestDelegate next, string formFieldName = null)
+        public HttpMethodOverrideMiddleware(RequestDelegate next, HttpMethodOverrideOptions options)
         {
+            if (next == null)
+            {
+                throw new ArgumentNullException(nameof(next));
+            }
+            if (options == null)
+            {
+                throw new ArgumentNullException(nameof(options));
+            }
             _next = next;
-            _formFieldName = formFieldName;
+            _options = options;
         }
 
         public async Task Invoke(HttpContext context)
         {
             if (string.Equals(context.Request.Method,"POST", StringComparison.OrdinalIgnoreCase))
             {
-                if (_formFieldName != null)
+                if (_options.FormFieldName != null)
                 {
                     if (context.Request.HasFormContentType)
                     {
                         var form = await context.Request.ReadFormAsync();
-                        var methodType = form[_formFieldName];
+                        var methodType = form[_options.FormFieldName];
                         if (!string.IsNullOrEmpty(methodType))
                         {
                             context.Request.Method = methodType;
diff --git a/src/Microsoft.AspNet.HttpOverrides/HttpMethodOverrideOptions.cs b/src/Microsoft.AspNet.HttpOverrides/HttpMethodOverrideOptions.cs
@@ -0,0 +1,14 @@
+﻿// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+namespace Microsoft.AspNet.HttpOverrides
+{
+    public class HttpMethodOverrideOptions
+    {
+        /// <summary>
+        /// Denotes the form element that contains the name of the resulting method type.
+        /// If not set the X-Http-Method-Override header will be used.
+        /// </summary>
+        public string FormFieldName { get; set; }
+    }
+}
diff --git a/src/Microsoft.AspNet.HttpOverrides/IPEndPointParser.cs b/src/Microsoft.AspNet.HttpOverrides/IPEndPointParser.cs
@@ -0,0 +1,73 @@
+﻿// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System.Net;
+
+namespace Microsoft.AspNet.HttpOverrides
+{
+    public static class IPEndPointParser
+    {
+        public static bool TryParse(string addressWithPort, out IPEndPoint endpoint)
+        {
+            string addressPart = null;
+            string portPart = null;
+            IPAddress address;
+            endpoint = null;
+
+            var lastColonIndex = addressWithPort.LastIndexOf(':');
+            if (lastColonIndex > 0)
+            {
+                // IPv4 with port or IPv6
+                var closingIndex = addressWithPort.LastIndexOf(']');
+                if (closingIndex > 0)
+                {
+                    // IPv6 with brackets
+                    addressPart = addressWithPort.Substring(1, closingIndex - 1);
+                    if (closingIndex < lastColonIndex)
+                    {
+                        // IPv6 with port [::1]:80
+                        portPart = addressWithPort.Substring(lastColonIndex + 1);
+                    }
+                }
+                else
+                {
+                    // IPv6 without port or IPv4
+                    var firstColonIndex = addressWithPort.IndexOf(':');
+                    if (firstColonIndex != lastColonIndex)
+                    {
+                        // IPv6 ::1
+                        addressPart = addressWithPort;
+                    }
+                    else
+                    {
+                        // IPv4 with port 127.0.0.1:123
+                        addressPart = addressWithPort.Substring(0, firstColonIndex);
+                        portPart = addressWithPort.Substring(firstColonIndex + 1);
+                    }
+                }
+            }
+            else
+            {
+                // IPv4 without port
+                addressPart = addressWithPort;
+            }
+
+            if (IPAddress.TryParse(addressPart, out address))
+            {
+                if (portPart != null)
+                {
+                    int port;
+                    if (int.TryParse(portPart, out port))
+                    {
+                        endpoint = new IPEndPoint(address, port);
+                        return true;
+                    }
+                    return false;
+                }
+                endpoint = new IPEndPoint(address, 0);
+                return true;
+            }
+            return false;
+        }
+    }
+}
diff --git a/src/Microsoft.AspNet.HttpOverrides/OverrideHeaderExtensions.cs b/src/Microsoft.AspNet.HttpOverrides/OverrideHeaderExtensions.cs
@@ -1,6 +1,7 @@
 ﻿// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
+using System;
 using Microsoft.AspNet.HttpOverrides;
 
 namespace Microsoft.AspNet.Builder
@@ -13,8 +14,18 @@ public static class OverrideHeaderExtensions
         /// <param name="builder"></param>
         /// <param name="options">Enables the different override options.</param>
         /// <returns></returns>
-        public static IApplicationBuilder UseOverrideHeaders(this IApplicationBuilder builder, OverrideHeaderMiddlewareOptions options)
+        public static IApplicationBuilder UseOverrideHeaders(this IApplicationBuilder builder, Action<OverrideHeaderOptions> configureOptions)
         {
+            if (builder == null)
+            {
+                throw new ArgumentNullException(nameof(builder));
+            }
+            if (configureOptions == null)
+            {
+                throw new ArgumentNullException(nameof(configureOptions));
+            }
+            var options = new OverrideHeaderOptions();
+            configureOptions(options);
             return builder.Use(next => new OverrideHeaderMiddleware(next, options).Invoke);
         }
     }
diff --git a/src/Microsoft.AspNet.HttpOverrides/OverrideHeaderMiddleware.cs b/src/Microsoft.AspNet.HttpOverrides/OverrideHeaderMiddleware.cs
diff --git a/src/Microsoft.AspNet.HttpOverrides/OverrideHeaderOptions.cs b/src/Microsoft.AspNet.HttpOverrides/OverrideHeaderOptions.cs
diff --git a/test/Microsoft.AspNet.Buffering.Tests/Microsoft.AspNet.Buffering.Tests.xproj b/test/Microsoft.AspNet.Buffering.Tests/Microsoft.AspNet.Buffering.Tests.xproj
diff --git a/test/Microsoft.AspNet.HttpOverrides.Tests/IPEndPointParserTest.cs b/test/Microsoft.AspNet.HttpOverrides.Tests/IPEndPointParserTest.cs
diff --git a/test/Microsoft.AspNet.HttpOverrides.Tests/OverrideHeaderMiddlewareTest.cs b/test/Microsoft.AspNet.HttpOverrides.Tests/OverrideHeaderMiddlewareTest.cs

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "server": "Microsoft.AspNet.Server.Kestrel"`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,6 @@`
`3`	`3`
`4`	`4`	`using System;`
`5`	`5`	`using System.Threading.Tasks;`
`6`		`-using Microsoft.AspNet.Builder;`
`7`	`6`	`using Microsoft.AspNet.Http;`
`8`	`7`
`9`	`8`	`namespace Microsoft.AspNet.HttpOverrides`
`@@ -12,24 +11,32 @@ public class HttpMethodOverrideMiddleware`
`12`	`11`	`{`
`13`	`12`	`private const string xHttpMethodOverride = "X-Http-Method-Override";`
`14`	`13`	`private readonly RequestDelegate _next;`
`15`		`- private readonly string _formFieldName;`
	`14`	`+ private readonly HttpMethodOverrideOptions _options;`
`16`	`15`
`17`		`- public HttpMethodOverrideMiddleware(RequestDelegate next, string formFieldName = null)`
	`16`	`+ public HttpMethodOverrideMiddleware(RequestDelegate next, HttpMethodOverrideOptions options)`
`18`	`17`	`{`
	`18`	`+ if (next == null)`
	`19`	`+ {`
	`20`	`+ throw new ArgumentNullException(nameof(next));`
	`21`	`+ }`
	`22`	`+ if (options == null)`
	`23`	`+ {`
	`24`	`+ throw new ArgumentNullException(nameof(options));`
	`25`	`+ }`
`19`	`26`	`_next = next;`
`20`		`- _formFieldName = formFieldName;`
	`27`	`+ _options = options;`
`21`	`28`	`}`
`22`	`29`
`23`	`30`	`public async Task Invoke(HttpContext context)`
`24`	`31`	`{`
`25`	`32`	`if (string.Equals(context.Request.Method,"POST", StringComparison.OrdinalIgnoreCase))`
`26`	`33`	`{`
`27`		`- if (_formFieldName != null)`
	`34`	`+ if (_options.FormFieldName != null)`
`28`	`35`	`{`
`29`	`36`	`if (context.Request.HasFormContentType)`
`30`	`37`	`{`
`31`	`38`	`var form = await context.Request.ReadFormAsync();`
`32`		`- var methodType = form[_formFieldName];`
	`39`	`+ var methodType = form[_options.FormFieldName];`
`33`	`40`	`if (!string.IsNullOrEmpty(methodType))`
`34`	`41`	`{`
`35`	`42`	`context.Request.Method = methodType;`