Merge branch 'release/4.3.0'

Jericho · Jericho · commit 497c8f28a0c9 · 2020-04-30T21:59:16.000-04:00
diff --git a/Source/HttpMultipartParser.UnitTests/ParserScenarios/EmptyForm.cs b/Source/HttpMultipartParser.UnitTests/ParserScenarios/EmptyForm.cs
@@ -9,7 +9,7 @@ namespace HttpMultipartParser.UnitTests.ParserScenarios
     public class EmptyForm
     {
         private static readonly string _testData = TestUtil.TrimAllLines(
-           @"------WebKitFormBoundaryb4SfPlH9Bv7c2PKS--"
+            @"------WebKitFormBoundaryb4SfPlH9Bv7c2PKS--"
         );
 
         private static readonly TestData _testCase = new TestData(
diff --git a/Source/HttpMultipartParser.UnitTests/ParserScenarios/FileIsLast.cs b/Source/HttpMultipartParser.UnitTests/ParserScenarios/FileIsLast.cs
@@ -20,8 +20,8 @@ public class FileIsLast
             Content-Disposition: form-data; name=""files[]""; filename=""Capture.JPG""
             Content-Type: image/jpeg
 
-             BinaryData
-             -----------------------------41952539122868--"
+            BinaryData
+            -----------------------------41952539122868--"
         );
 
         private static readonly TestData _testCase = new TestData(
diff --git a/Source/HttpMultipartParser.UnitTests/ParserScenarios/MixedSingleByteAndMultiByteWidth.cs b/Source/HttpMultipartParser.UnitTests/ParserScenarios/MixedSingleByteAndMultiByteWidth.cs
@@ -17,8 +17,8 @@ public class MixedSingleByteAndMultiByteWidth
             Content-Disposition: form-data; name=""files[]""; filename=""تست.jpg""
             Content-Type: image/jpeg
 
-             BinaryData
-             -----------------------------41952539122868--"
+            BinaryData
+            -----------------------------41952539122868--"
         );
 
         private static readonly TestData _testCase = new TestData(
diff --git a/Source/HttpMultipartParser.UnitTests/ParserScenarios/MultipleFilesWithEmptyName.cs b/Source/HttpMultipartParser.UnitTests/ParserScenarios/MultipleFilesWithEmptyName.cs
@@ -14,21 +14,21 @@ public class MultipleFilesWithEmptyName
     {
         private static readonly string _testData = TestUtil.TrimAllLines(
             @"--boundry
-              Content-Disposition: form-data; name="""";filename=""file1.txt"";
-              Content-Type: text/plain
+            Content-Disposition: form-data; name="""";filename=""file1.txt"";
+            Content-Type: text/plain
 
-              THIS IS TEXT FILE 1
-              --boundry
-              Content-Disposition: form-data; name="""";filename=""file2.txt"";
-              Content-Type: text/plain
+            THIS IS TEXT FILE 1
+            --boundry
+            Content-Disposition: form-data; name="""";filename=""file2.txt"";
+            Content-Type: text/plain
 
-              THIS IS TEXT FILE 2 !!!
-              --boundry
-              Content-Disposition: form-data; name="""";filename=""file3.txt"";
-              Content-Type: text/plain
+            THIS IS TEXT FILE 2 !!!
+            --boundry
+            Content-Disposition: form-data; name="""";filename=""file3.txt"";
+            Content-Type: text/plain
 
-              This is text file 3 1234567890
-              --boundry--"
+            This is text file 3 1234567890
+            --boundry--"
         );
 
         private static readonly TestData _testCase = new TestData(
diff --git a/Source/HttpMultipartParser.UnitTests/ParserScenarios/MultipleFilesWithOmittedName.cs b/Source/HttpMultipartParser.UnitTests/ParserScenarios/MultipleFilesWithOmittedName.cs
@@ -12,22 +12,23 @@ namespace HttpMultipartParser.UnitTests.ParserScenarios
     /// </summary>
     public class MultipleFilesWithOmittedName
     {
-        private static readonly string _testData = TestUtil.TrimAllLines(@"--boundry
-              Content-Disposition: form-data; filename=""file1.txt"";
-              Content-Type: text/plain
+        private static readonly string _testData = TestUtil.TrimAllLines(
+            @"--boundry
+            Content-Disposition: form-data; filename=""file1.txt"";
+            Content-Type: text/plain
 
-              THIS IS TEXT FILE 1
-              --boundry
-              Content-Disposition: form-data; filename=""file2.txt"";
-              Content-Type: text/plain
+            THIS IS TEXT FILE 1
+            --boundry
+            Content-Disposition: form-data; filename=""file2.txt"";
+            Content-Type: text/plain
 
-              THIS IS TEXT FILE 2 !!!
-              --boundry
-              Content-Disposition: form-data; filename=""file3.txt"";
-              Content-Type: text/plain
+            THIS IS TEXT FILE 2 !!!
+            --boundry
+            Content-Disposition: form-data; filename=""file3.txt"";
+            Content-Type: text/plain
 
-              This is text file 3 1234567890
-              --boundry--"
+            This is text file 3 1234567890
+            --boundry--"
         );
 
         private static readonly TestData _testCase = new TestData(
diff --git a/Source/HttpMultipartParser.UnitTests/ParserScenarios/UnclosedBoundary.cs b/Source/HttpMultipartParser.UnitTests/ParserScenarios/UnclosedBoundary.cs
@@ -10,10 +10,10 @@ public class UnclosedBoundary
     {
         private static readonly string _testData = TestUtil.TrimAllLines(
             @"------51523
-              Content-Disposition: form-data; name=""value""
+            Content-Disposition: form-data; name=""value""
               
-              my value
-              ------51523"
+            my value
+            ------51523"
         );
 
         private static readonly TestData _testCase = new TestData(
diff --git a/Source/HttpMultipartParser/HttpMultipartParser.csproj b/Source/HttpMultipartParser/HttpMultipartParser.csproj
@@ -40,7 +40,7 @@
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
     <PackageReference Include="Microsoft.IO.RecyclableMemoryStream" Version="1.3.3" />
     <PackageReference Include="StyleCop.Analyzers" Version="1.1.118" PrivateAssets="All" />
-    <PackageReference Include="System.Buffers" Version="4.5.0" />
+    <PackageReference Include="System.Buffers" Version="4.5.1" />
   </ItemGroup>
   
   <ItemGroup Condition=" !$(TargetFramework.StartsWith('netstandard')) ">
diff --git a/Source/HttpMultipartParser/MultipartStreamPart.cs b/Source/HttpMultipartParser/MultipartStreamPart.cs
diff --git a/Source/HttpMultipartParser/StreamingMultipartFormDataParser.cs b/Source/HttpMultipartParser/StreamingMultipartFormDataParser.cs
@@ -48,6 +48,11 @@ public class StreamingMultipartFormDataParser
         /// <summary>
         ///     The default buffer size.
         /// </summary>
+        /// <remarks>
+        ///     4096 is the optimal buffer size as it matches the internal buffer of a StreamReader
+        ///     See: http://stackoverflow.com/a/129318/203133
+        ///     See: http://msdn.microsoft.com/en-us/library/9kstw824.aspx (under remarks).
+        /// </remarks>
         private const int DefaultBufferSize = 4096;
 
         #endregion
@@ -153,9 +158,6 @@ public StreamingMultipartFormDataParser(Stream stream, Encoding encoding)
         public StreamingMultipartFormDataParser(Stream stream, string boundary, Encoding encoding)
             : this(stream, boundary, encoding, DefaultBufferSize)
         {
-            // 4096 is the optimal buffer size as it matches the internal buffer of a StreamReader
-            // See: http://stackoverflow.com/a/129318/203133
-            // See: http://msdn.microsoft.com/en-us/library/9kstw824.aspx (under remarks)
         }
 
         /// <summary>
@@ -403,6 +405,24 @@ private static async Task<string> DetectBoundaryAsync(RebufferableBinaryReader r
             return boundary;
         }
 
+        /// <summary>
+        /// Use a few assumptions to determine if a section contains a file or a "data" parameter.
+        /// </summary>
+        /// <param name="parameters">The section parameters.</param>
+        /// <returns>true if the section contains a file, false otherwise.</returns>
+        private static bool IsFilePart(IDictionary<string, string> parameters)
+        {
+            // If a section contains filename, then it's a file.
+            if (parameters.ContainsKey("filename")) return true;
+
+            // If the section is missing the filename and the name, then it's a file.
+            // For example, images in an mjpeg stream have neither a name nor a filename.
+            else if (!parameters.ContainsKey("name")) return true;
+
+            // In all other cases, we assume it's a "data" parameter.
+            return false;
+        }
+
         /// <summary>
         ///     Finds the next sequence of newlines in the input stream.
         /// </summary>
@@ -1055,11 +1075,8 @@ private void ParseSection(RebufferableBinaryReader reader)
             // Now that we've consumed all the parameters we're up to the body. We're going to do
             // different things depending on if we're parsing a, relatively small, form value or a
             // potentially large file.
-            if (parameters.ContainsKey("filename"))
+            if (IsFilePart(parameters))
             {
-                // Right now we assume that if a section contains filename then it is a file.
-                // This assumption needs to be checked, it holds true in firefox but is untested for other
-                // browsers.
                 ParseFilePart(parameters, reader);
             }
             else
@@ -1149,11 +1166,8 @@ private async Task ParseSectionAsync(RebufferableBinaryReader reader, Cancellati
             // Now that we've consumed all the parameters we're up to the body. We're going to do
             // different things depending on if we're parsing a, relatively small, form value or a
             // potentially large file.
-            if (parameters.ContainsKey("filename"))
+            if (IsFilePart(parameters))
             {
-                // Right now we assume that if a section contains filename then it is a file.
-                // This assumption needs to be checked, it holds true in firefox but is untested for other
-                // browsers.
                 await ParseFilePartAsync(parameters, reader, cancellationToken).ConfigureAwait(false);
             }
             else
diff --git a/build.cake b/build.cake
@@ -8,7 +8,7 @@
 #tool nuget:?package=GitVersion.CommandLine&version=5.2.4
 #tool nuget:?package=GitReleaseManager&version=0.11.0
 #tool nuget:?package=OpenCover&version=4.7.922
-#tool nuget:?package=ReportGenerator&version=4.5.2
+#tool nuget:?package=ReportGenerator&version=4.5.6
 #tool nuget:?package=coveralls.io&version=1.4.2
 #tool nuget:?package=xunit.runner.console&version=2.4.1
 

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ namespace HttpMultipartParser.UnitTests.ParserScenarios`
`9`	`9`	`public class EmptyForm`
`10`	`10`	`{`
`11`	`11`	`private static readonly string _testData = TestUtil.TrimAllLines(`
`12`		`- @"------WebKitFormBoundaryb4SfPlH9Bv7c2PKS--"`
	`12`	`+ @"------WebKitFormBoundaryb4SfPlH9Bv7c2PKS--"`
`13`	`13`	`);`
`14`	`14`
`15`	`15`	`private static readonly TestData _testCase = new TestData(`