Obsoleted MimeReader.OnMultipartBoundary() and OnMultipartEndBoundary()

Replaced OnMultipartBoundary() with
* OnMultipartBoundaryBegin()
* OnMultipartBoundaryRead()
* OnMultipartBoundaryEnd()

Replaced OnMultipartEndBoundary() with
* OnMultipartEndBoundaryBegin()
* OnMultipartEndBoundaryRead()
* OnMultipartEndBoundaryEnd()

This will allow implementers to clone the *exact* boundary marker that was
encountered in the original stream, including any trailing whitespace.

Author: jstedfast

MimeKit/AsyncMimeReader.cs

@@ -291,13 +291,50 @@ async Task StepHeadersAsync (CancellationToken cancellationToken)
 			await OnHeadersEndAsync (headerBlockBegin, headersBeginLineNumber, headerBlockEnd, lineNumber, cancellationToken).ConfigureAwait (false);
 		}
 
-		bool SkipBoundaryMarker (bool endBoundary)
+		async Task<bool> SkipBoundaryMarkerAsync (string boundary, bool endBoundary, CancellationToken cancellationToken)
 		{
+			long beginOffset = GetOffset (inputIndex);
+			int beginLineNumber = lineNumber;
+			int startIndex = inputIndex;
+			bool result;
+
+			if (endBoundary)
+				await OnMultipartEndBoundaryBeginAsync (beginOffset, beginLineNumber, cancellationToken).ConfigureAwait (false);
+			else
+				await OnMultipartBoundaryBeginAsync (beginOffset, beginLineNumber, cancellationToken).ConfigureAwait (false);
+
 			unsafe {
 				fixed (byte* inbuf = input) {
-					return SkipBoundaryMarker (inbuf, endBoundary);
+					result = SkipBoundaryMarkerInternal (inbuf, endBoundary);
 				}
 			}
+
+			int count = inputIndex - startIndex;
+
+			if (endBoundary)
+				await OnMultipartEndBoundaryReadAsync (input, startIndex, count, beginOffset, beginLineNumber, cancellationToken).ConfigureAwait (false);
+			else
+				await OnMultipartBoundaryReadAsync (input, startIndex, count, beginOffset, beginLineNumber, cancellationToken).ConfigureAwait (false);
+
+			long endOffset = GetOffset (inputIndex);
+
+			if (endBoundary) {
+				await OnMultipartEndBoundaryEndAsync (beginOffset, beginLineNumber, endOffset, cancellationToken).ConfigureAwait (false);
+
+#pragma warning disable 618
+				// Obsolete
+				await OnMultipartEndBoundaryAsync (boundary, beginOffset, endOffset, beginLineNumber, cancellationToken).ConfigureAwait (false);
+#pragma warning restore 618
+			} else {
+				await OnMultipartBoundaryEndAsync (beginOffset, beginLineNumber, endOffset, cancellationToken).ConfigureAwait (false);
+
+#pragma warning disable 618
+				// Obsolete
+				await OnMultipartBoundaryAsync (boundary, beginOffset, endOffset, beginLineNumber, cancellationToken).ConfigureAwait (false);
+#pragma warning restore 618
+			}
+
+			return result;
 		}
 
 		async Task<MimeParserState> StepAsync (CancellationToken cancellationToken)
@@ -497,18 +534,13 @@ async Task MultipartScanEpilogueAsync (CancellationToken cancellationToken)
 
 		async Task MultipartScanSubpartsAsync (ContentType multipartContentType, int depth, CancellationToken cancellationToken)
 		{
-			var boundaryOffset = GetOffset (inputIndex);
-
 			do {
 				// skip over the boundary marker
-				if (!SkipBoundaryMarker (endBoundary: false)) {
-					await OnMultipartBoundaryAsync (multipartContentType.Boundary, boundaryOffset, GetOffset (inputIndex), lineNumber, cancellationToken).ConfigureAwait (false);
+				if (!await SkipBoundaryMarkerAsync (multipartContentType.Boundary, endBoundary: false, cancellationToken).ConfigureAwait (false)) {
 					boundary = BoundaryType.Eos;
 					return;
 				}
 
-				await OnMultipartBoundaryAsync (multipartContentType.Boundary, boundaryOffset, GetOffset (inputIndex), lineNumber - 1, cancellationToken).ConfigureAwait (false);
-
 				var beginLineNumber = lineNumber;
 
 				// Note: When parsing non-toplevel parts, the header parser will never result in the Error state.
@@ -517,10 +549,9 @@ async Task MultipartScanSubpartsAsync (ContentType multipartContentType, int dep
 
 				if (state == MimeParserState.Boundary) {
 					if (headerCount == 0) {
-						if (boundary == BoundaryType.ImmediateBoundary) {
-							//beginOffset = GetOffset (inputIndex);
+						if (boundary == BoundaryType.ImmediateBoundary)
 							continue;
-						}
+
 						return;
 					}
 
@@ -565,8 +596,6 @@ async Task MultipartScanSubpartsAsync (ContentType multipartContentType, int dep
 					await OnMimePartEndAsync (type, currentBeginOffset, beginLineNumber, currentHeadersEndOffset, endOffset, lines, cancellationToken).ConfigureAwait (false);
 					break;
 				}
-
-				boundaryOffset = endOffset;
 			} while (boundary == BoundaryType.ImmediateBoundary);
 		}
 
@@ -598,14 +627,7 @@ async Task<int> ConstructMultipartAsync (ContentType contentType, int depth, Can
 
 			if (boundary == BoundaryType.ImmediateEndBoundary) {
 				// consume the end boundary and read the epilogue (if there is one)
-				// FIXME: multipart.WriteEndBoundary = true;
-
-				var boundaryOffset = GetOffset (inputIndex);
-				var boundaryLineNumber = lineNumber;
-
-				SkipBoundaryMarker (endBoundary: true);
-
-				await OnMultipartEndBoundaryAsync (marker, boundaryOffset, GetOffset (inputIndex), boundaryLineNumber, cancellationToken).ConfigureAwait (false);
+				await SkipBoundaryMarkerAsync (marker, endBoundary: true, cancellationToken).ConfigureAwait (false);
 
 				PopBoundary ();
 
@@ -616,8 +638,6 @@ async Task<int> ConstructMultipartAsync (ContentType contentType, int depth, Can
 				return GetLineCount (beginLineNumber, beginOffset, endOffset);
 			}
 
-			// FIXME: multipart.WriteEndBoundary = false;
-
 			// We either found the end of the stream or we found a parent's boundary
 			PopBoundary ();
 

MimeKit/ExperimentalMimeParser.cs

@@ -593,33 +593,17 @@ protected override void OnMultipartBegin (ContentType contentType, long beginOff
 			depth++;
 		}
 
-		/// <summary>
-		/// Called when a multipart boundary is encountered in the stream.
-		/// </summary>
-		/// <remarks>
-		/// Called when a multipart boundary is encountered in the stream.
-		/// </remarks>
-		/// <param name="boundary">The multipart boundary string.</param>
-		/// <param name="beginOffset">The offset into the stream where the boundary marker began.</param>
-		/// <param name="endOffset">The offset into the stream where the boundary marker ended.</param>
-		/// <param name="lineNumber">The line number where the boundary marker was found in the stream.</param>
-		/// <param name="cancellationToken">The cancellation token.</param>
-		protected override void OnMultipartBoundary (string boundary, long beginOffset, long endOffset, int lineNumber, CancellationToken cancellationToken)
-		{
-		}
-
 		/// <summary>
 		/// Called when a multipart end boundary is encountered in the stream.
 		/// </summary>
 		/// <remarks>
 		/// Called when a multipart end boundary is encountered in the stream.
 		/// </remarks>
-		/// <param name="boundary">The multipart boundary string.</param>
 		/// <param name="beginOffset">The offset into the stream where the boundary marker began.</param>
-		/// <param name="endOffset">The offset into the stream where the boundary marker ended.</param>
 		/// <param name="lineNumber">The line number where the boundary marker was found in the stream.</param>
+		/// <param name="endOffset">The offset into the stream where the boundary marker ended.</param>
 		/// <param name="cancellationToken">The cancellation token.</param>
-		protected override void OnMultipartEndBoundary (string boundary, long beginOffset, long endOffset, int lineNumber, CancellationToken cancellationToken)
+		protected override void OnMultipartEndBoundaryEnd (long beginOffset, int lineNumber, long endOffset, CancellationToken cancellationToken)
 		{
 			var multipart = (Multipart) stack.Peek ();