HttpMultipartParser

Provides character based and byte based stream-like read operations over multiple streams and provides methods to add data to the front of the buffer.

Holds the streams to read from, the stream on the top of the stack will be read first.

Initializes a new instance of the class with the default encoding of UTF8.

Initializes a new instance of the class.

The encoding to use for character based operations.

Gets or sets the current encoding.

Returns true if there is any data left to read.

True or false.

Returns the reader on the top of the stack but does not remove it.

The .

Returns the reader on the top of the stack and removes it.

The .

Pushes data to the front of the stack. The most recently pushed data will be read first.

The data to add to the stack.

Pushes data to the front of the stack. The most recently pushed data will be read first.

The data to add to the stack. The zero-based byte offset in buffer at which to begin copying bytes to the current stream. The maximum number of bytes to write.

Reads a single byte as an integer from the stack. Returns -1 if no data is left to read.

The that was read.

Reads the specified number of bytes from the stack, starting from a specified point in the byte array.

The buffer to read data into. The index of buffer to start reading into. The number of bytes to read into the buffer. The number of bytes read into buffer. This might be less than the number of bytes requested if that many bytes are not available, or it might be zero if the end of the stream is reached.

Reads the specified number of characters from the stack, starting from a specified point in the byte array.

The buffer to read data into. The index of buffer to start reading into. The number of characters to read into the buffer. The number of characters read into buffer. This might be less than the number of bytes requested if that many bytes are not available, or it might be zero if the end of the stream is reached.

Reads the specified number of characters from the stack, starting from a specified point in the byte array.

A byte array containing all the data up to but not including the next newline in the stack.

Reads a line from the stack delimited by the newline for this platform. The newline characters will not be included in the stream.

This will be set to true if we did not end on a newline but instead found the end of our data. The containing the line.

Reads a line from the stack delimited by the newline for this platform. The newline characters will not be included in the stream.

The containing the line.

Reads a line from the stack delimited by the newline for this platform. The newline characters will not be included in the stream.

This will be set to true if we did not end on a newline but instead found the end of our data. The containing the line.

Removes the current reader from the stack and ensures it is correctly destroyed and then returns the next available reader. If no reader is available this method returns null.

The next reader.

The default buffer size.

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).

The mimetypes that are considered a file by default.

The default encoding used by the parser when developer does not specify the encoding.

The FileStreamDelegate defining functions that can handle file stream data from this parser. Delegates can assume that the data is sequential i.e. the data received by any delegates will be the data immediately following any previously received data.

The name of the multipart data. The name of the file. The content type of the multipart data. The content disposition of the multipart data. Some of the data from the file (not necessarily all of the data). The length of data in buffer. Each chunk (or "part") in a given file is sequentially numbered, starting at zero. Properties other than the "well known" ones (such as name, filename, content-type, etc.) associated with a file stream.

The StreamClosedDelegate defining functions that can handle stream being closed.

The ParameterDelegate defining functions that can handle multipart parameter data.

The parsed parameter part.

The BinaryParameterDelegate defining functions that can handle multipart parameter data.

The parsed parameter part.

Class containing various extension methods.

Returns true if the parameter has any values. False otherwise.

The multipart form parser. The name of the parameter. True if the parameter exists. False otherwise.

Returns the value of a parameter or null if it doesn't exist. You should only use this method if you're sure the parameter has only one value. If you need to support multiple values use GetParameterValues.

The multipart form parser. The name of the parameter. One of the enumeration values that specifies how the strings will be compared. The value of the parameter.

Returns the values of a parameter or an empty enumerable if the parameter doesn't exist.

The multipart form parser. The name of the parameter. One of the enumeration values that specifies how the strings will be compared. The values of the parameter.

Represents a single file extracted from a multipart/form-data stream.

Initializes a new instance of the class.

The name of the input field used for the upload. The name of the file. The file data. The content type. The content disposition.

Initializes a new instance of the class.

The name of the input field used for the upload. The name of the file. The file data. Additional properties associated with this file. The content type. The content disposition.

Gets the data.

Gets the file name.

Gets the name.

Gets the content-type. Defaults to text/plain if unspecified.

Gets the content-disposition. Defaults to form-data if unspecified.

Gets the additional properties associated with this file. An additional property is any property other than the "well known" ones such as name, filename, content-type, etc.

Provides methods to parse a multipart/form-data stream into it's parameters and file data.

Gets the mapping of parameters parsed files. The name of a given field maps to the parsed file data.

Gets the parameters. Several ParameterPartBinary may share the same name.

Provides methods to parse a multipart/form-data stream into it's parameters and file data.

Gets the mapping of parameters parsed files. The name of a given field maps to the parsed file data.

Gets the parameters. Several ParameterParts may share the same name.

Provides methods to parse a multipart/form-data stream into it's parameters and file data.

Gets or sets the FileHandler. Delegates attached to this property will receive sequential file stream data from this parser.

Gets or sets the ParameterHandler. Delegates attached to this property will receive parameter data.

Gets or sets the StreamClosedHandler. Delegates attached to this property will be notified when the source stream is exhausted.

Execute the parser. This should be called after all handlers have been set.

Execute the parser asynchronously. This should be called after all handlers have been set.

The cancellation token. The asynchronous task.

Provides methods to parse a multipart/form-data stream into it's parameters and file data.

Gets or sets the FileHandler. Delegates attached to this property will receive sequential file stream data from this parser.

Gets or sets the ParameterHandler. Delegates attached to this property will receive parameter data.

Gets or sets the StreamClosedHandler. Delegates attached to this property will be notified when the source stream is exhausted.

Execute the parser. This should be called after all handlers have been set.

Execute the parser asynchronously. This should be called after all handlers have been set.

The cancellation token. The asynchronous task.

Provides methods to parse a multipart/form-data stream into it's parameters and file data.

A parameter is defined as any non-file data passed in the multipart stream. For example any form fields would be considered a parameter. The parser determines if a section is a file or not based on the presence or absence of the filename argument for the Content-Type header. If filename is set then the section is assumed to be a file, otherwise it is assumed to be parameter data.


                   Stream multipartStream = GetTheMultipartStream();
                   string boundary = GetTheBoundary();
                   var parser = new MultipartFormDataParser(multipartStream, boundary, Encoding.UTF8);
            
                   // Grab the parameters (non-file data). Key is based on the name field
                   var username = parser.Parameters["username"].Data;
                   var password = parser.parameters["password"].Data;
            
                   // Grab the first files data
                   var file = parser.Files.First();
                   var filename = file.FileName;
                   var filestream = file.Data;


                 // In the context of WCF you can get the boundary from the HTTP
                 // request
                 public ResponseClass MyMethod(Stream multipartData)
                 {
                     // First we need to get the boundary from the header, this is sent
                     // with the HTTP request. We can do that in WCF using the WebOperationConext:
                     var type = WebOperationContext.Current.IncomingRequest.Headers["Content-Type"];
            
                     // Now we want to strip the boundary out of the Content-Type, currently the string
                     // looks like: "multipart/form-data; boundary=---------------------124123qase124"
                     var boundary = type.Substring(type.IndexOf('=')+1);
            
                     // Now that we've got the boundary we can parse our multipart and use it as normal
                     var parser = new MultipartFormDataParser(data, boundary, Encoding.UTF8);
            
                     ...
                 }

Initializes a new instance of the class.

Gets the mapping of parameters parsed files. The name of a given field maps to the parsed file data.

Gets the parameters. Several ParameterParts may share the same name.

Parse the stream into a new instance of the class with the boundary, input encoding and buffer size.

The stream containing the multipart data. The encoding of the multipart data. The size of the buffer to use for parsing the multipart form data. This must be larger then (size of boundary + 4 + # bytes in newline). List of mimetypes that should be detected as file. By default the parser will throw an exception if it encounters an invalid part. Set this to true to ignore invalid parts. A new instance of the class.

Parse the stream into a new instance of the class with the boundary, input encoding and buffer size.

The stream containing the multipart data. The multipart/form-data boundary. This should be the value returned by the request header. The encoding of the multipart data. The size of the buffer to use for parsing the multipart form data. This must be larger then (size of boundary + 4 + # bytes in newline). List of mimetypes that should be detected as file. By default the parser will throw an exception if it encounters an invalid part. Set this to true to ignore invalid parts. A new instance of the class.

Asynchronously parse the stream into a new instance of the class with the boundary, input encoding and buffer size.

Parse the stream with the boundary, input encoding and buffer size.

Provides methods to parse a multipart/form-data stream into it's parameters and file data.


                   Stream multipartStream = GetTheMultipartStream();
                   string boundary = GetTheBoundary();
                   var parser = new MultipartFormDataParser(multipartStream, boundary, Encoding.UTF8);
            
                   // Grab the parameters (non-file data). Key is based on the name field
                   var username = parser.Parameters["username"].Data;
                   var password = parser.parameters["password"].Data;
            
                   // Grab the first files data
                   var file = parser.Files.First();
                   var filename = file.FileName;
                   var filestream = file.Data;


                 // In the context of WCF you can get the boundary from the HTTP
                 // request
                 public ResponseClass MyMethod(Stream multipartData)
                 {
                     // First we need to get the boundary from the header, this is sent
                     // with the HTTP request. We can do that in WCF using the WebOperationConext:
                     var type = WebOperationContext.Current.IncomingRequest.Headers["Content-Type"];
            
                     // Now we want to strip the boundary out of the Content-Type, currently the string
                     // looks like: "multipart/form-data; boundary=---------------------124123qase124"
                     var boundary = type.Substring(type.IndexOf('=')+1);
            
                     // Now that we've got the boundary we can parse our multipart and use it as normal
                     var parser = new MultipartFormDataParser(data, boundary, Encoding.UTF8);
            
                     ...
                 }

Initializes a new instance of the class.

Gets the mapping of parameters parsed files. The name of a given field maps to the parsed file data.

Gets the parameters. Several ParameterParts may share the same name.

Parse the stream into a new instance of the class with the boundary, input encoding and buffer size.

Asynchronously parse the stream into a new instance of the class with the boundary, input encoding and buffer size.

Parse the stream with the boundary, input encoding and buffer size.

Represents a parsing problem occurring within the MultipartFormDataParser.

Initializes a new instance of the class.

The message.

Represents a single parameter extracted from a multipart/form-data stream.

For our purposes a "parameter" is defined as any non-file data in the multipart/form-data stream.

Initializes a new instance of the class.

The name. The data.

Gets the data.

Gets the name.

Represents the binary data of a single parameter extracted from a multipart/form-data stream.

For our purposes a "parameter" is defined as any non-file data in the multipart/form-data stream.

Initializes a new instance of the class.

The name. The data.

Gets the data.

Gets the name.

Get the binary data expressed as a string.

The binary data expressed as a string.

Get the binary data expressed as a string.

The encoding used to convert the binary data into a string. The binary data expressed as a string.

Provides methods to interpret and read a stream as either character or binary data similar to a and provides the ability to push data onto the front of the stream.

The size of the buffer to use when reading new data.

The encoding to use for character based operations.

The stream to read raw data from.

The stream stack to store buffered data.

Initializes a new instance of the class. Default encoding of UTF8 will be used.

The input stream to read from.

Initializes a new instance of the class.

The input stream to read from. The encoding to use for character based operations. The buffer size to use for new buffers.

Adds data to the front of the stream. The most recently buffered data will be read first.

The data to buffer.

Adds data to the front of the stream. The most recently buffered data will be read first.

The data to buffer. The zero-based byte offset in buffer at which to begin copying bytes to the current stream. The maximum number of bytes to write.

Adds the string to the front of the stream. The most recently buffered data will be read first.

The data.

Reads a single byte as an integer from the stream. Returns -1 if no data is left to read.

The that was read.

Reads the specified number of bytes from the stream, starting from a specified point in the byte array.

Reads the specified number of characters from the stream, starting from a specified point in the byte array.

The buffer to read data into. The index of buffer to start reading into. The number of characters to read into the buffer. The number of characters read into buffer. This might be less than the number of characters requested if that many characters are not available, or it might be zero if the end of the stream is reached.

Reads a series of bytes delimited by the byte encoding of newline for this platform. The newline bytes will not be included in the return data.

A byte array containing all the data up to but not including the next newline in the stack.

Reads a line from the stack delimited by the newline for this platform. The newline characters will not be included in the stream.

The containing the line or null if end of stream.

Asynchronously reads a single byte as an integer from the stream. Returns -1 if no data is left to read.

The cancellation token. The that was read.

Asynchronously reads the specified number of bytes from the stream, starting from a specified point in the byte array.

The buffer to read data into. The index of buffer to start reading into. The number of bytes to read into the buffer. The cancellation token. The number of bytes read into buffer. This might be less than the number of bytes requested if that many bytes are not available, or it might be zero if the end of the stream is reached.

Asynchronously reads the specified number of characters from the stream, starting from a specified point in the byte array.

The buffer to read data into. The index of buffer to start reading into. The number of characters to read into the buffer. The cancellation token. The number of characters read into buffer. This might be less than the number of characters requested if that many characters are not available, or it might be zero if the end of the stream is reached.

Asynchronously reads a series of bytes delimited by the byte encoding of newline for this platform. The newline bytes will not be included in the return data.

The cancellation token. A byte array containing all the data up to but not including the next newline in the stack.

Asynchronously reads a line from the stack delimited by the newline for this platform. The newline characters will not be included in the stream.

The cancellation token. The containing the line or null if end of stream.

Determines the byte order marking offset (if any) from the given buffer.

The buffer to examine. The representing the length of the byte order marking.

Reads more data from the stream into the stream stack.

The number of bytes read into the stream stack as an .

Asynchronously reads more data from the stream into the stream stack.

The cancellation token. The number of bytes read into the stream stack as an .

Push the data read from the stream into the stream stack.

The data that was read from the stream. The number of bytes read from the stream.

Provides methods to parse a multipart/form-data stream into it's parameters and file data.


                   Stream multipartStream = GetTheMultipartStream();
                   string boundary = GetTheBoundary();
                   var parser = new StreamingMultipartFormDataParser(multipartStream, boundary, Encoding.UTF8);
            
                   // Set up our delegates for how we want to handle recieved data.
                   // In our case parameters will be written to a dictionary and files
                   // will be written to a filestream
                   parser.ParameterHandler += parameter => AddToDictionary(parameter);
                   parser.FileHandler += (name, fileName, type, disposition, buffer, bytes) => WriteDataToFile(fileName, buffer, bytes);
                   parser.Run();

List of mimetypes that should be detected as file.

The stream we are parsing.

Determines if we should throw an exception when we enconter an invalid part or ignore it.

The boundary of the multipart message as a string.

The boundary of the multipart message as a byte string encoded with CurrentEncoding.

The end boundary of the multipart message as a string.

The end boundary of the multipart message as a byte string encoded with CurrentEncoding.

Determines if we have consumed the end boundary binary and determines if we are done parsing.

Initializes a new instance of the class with the boundary, stream, input encoding and buffer size.

Begins executing the parser. This should be called after all handlers have been set.

Begins executing the parser asynchronously. This should be called after all handlers have been set.

The cancellation token. The asynchronous task.

Gets the binary buffer size.

Gets the encoding.

Gets or sets the FileHandler. Delegates attached to this property will receive sequential file stream data from this parser.

Gets or sets the ParameterHandler. Delegates attached to this property will receive parameter data.

Gets or sets the StreamClosedHandler. Delegates attached to this property will be notified when the source stream is exhausted.

Detects the boundary from the input stream. Assumes that the current position of the reader is the start of the file and therefore the beginning of the boundary.

As of version 8.2.0 (released in June 2023), we ignore blank lines at the start of the stream. In previous version, an exception was thrown if any blank line was present before the boundary marker. The binary reader to parse. The boundary string.

Detects the boundary from the input stream. Assumes that the current position of the reader is the start of the file and therefore the beginning of the boundary.

Use a few assumptions to determine if a section contains a file.

The section parameters. true if the section contains a file, false otherwise.

Use a few assumptions to determine if a section contains a "data" parameter.

The section parameters. true if the section contains a data parameter, false otherwise.

Finds the next sequence of newlines in the input stream.

The data to search. The offset to start searching at. The maximum number of bytes (starting from offset) to search. The offset of the next newline.

Calculates the length of the next found newline. data[offset] is the start of the space to search.

The data containing the newline. The offset of the start of the newline. The length in bytes of the newline sequence.

Begins the parsing of the stream into objects.

The multipart/form-data binary reader to parse from. thrown on finding unexpected data such as a boundary before we are ready for one.

Begins the asynchronous parsing of the stream into objects.

The multipart/form-data binary reader to parse from. The cancellation token. The asynchronous task. thrown on finding unexpected data such as a boundary before we are ready for one.

Parses a section of the stream that is known to be file data.

The header parameters of this file. The StreamReader to read the data from.

Asynchronously parses a section of the stream that is known to be file data.

The header parameters of this file, expects "name" and "filename" to be valid keys. The StreamReader to read the data from. The cancellation token. The asynchronous task.

Parses a section of the stream that is known to be parameter data.

The header parameters of this section. "name" must be a valid key. The StreamReader to read the data from. thrown if unexpected data is found such as running out of stream before hitting the boundary.

Asynchronously parses a section of the stream that is known to be parameter data.

The header parameters of this section. "name" must be a valid key. The StreamReader to read the data from. The cancellation token. The asynchronous task. thrown if unexpected data is found such as running out of stream before hitting the boundary.

Skip a section of the stream. This is used when a section is deemed to be invalid and the developer has requested to ignore invalid parts.

The StreamReader to read the data from. thrown if unexpected data is found such as running out of stream before hitting the boundary.

Asynchronously skip a section of the stream. This is used when a section is deemed to be invalid and the developer has requested to ignore invalid parts.

The StreamReader to read the data from. The cancellation token. The asynchronous task. thrown if unexpected data is found such as running out of stream before hitting the boundary.

Parses the header of the next section of the multipart stream and determines if it contains file data or parameter data.

The StreamReader to read data from. thrown if unexpected data is hit such as end of stream.

Asynchronously parses the header of the next section of the multipart stream and determines if it contains file data or parameter data.

The StreamReader to read data from. The cancellation token. The asynchronous task. thrown if unexpected data is hit such as end of stream.

Splits a line by semicolons but ignores semicolons in quotes.

The line to split. The split strings.

Check if there are parameters other than the "well known" parameters associated with this file. This is quite rare but, as an example, the Alexa service includes a "content-ID" parameter with each file.

A dictionary of parameters.

Provides methods to parse a multipart/form-data stream into it's parameters and file data.


                   Stream multipartStream = GetTheMultipartStream();
                   string boundary = GetTheBoundary();
                   var parser = new StreamingMultipartFormDataParser(multipartStream, boundary, Encoding.UTF8);
            
                   // Set up our delegates for how we want to handle recieved data.
                   // In our case parameters will be written to a dictionary and files
                   // will be written to a filestream
                   parser.ParameterHandler += parameter => AddToDictionary(parameter);
                   parser.FileHandler += (name, fileName, type, disposition, buffer, bytes) => WriteDataToFile(fileName, buffer, bytes);
                   parser.Run();

List of mimetypes that should be detected as file.

The stream we are parsing.

Determines if we should throw an exception when we enconter an invalid part or ignore it.

The boundary of the multipart message as a string.

Initializes a new instance of the class with the boundary, stream, input encoding and buffer size.

Begins executing the parser. This should be called after all handlers have been set.

Begins executing the parser asynchronously. This should be called after all handlers have been set.

The cancellation token. The asynchronous task.

Gets the binary buffer size.

Gets the encoding.

Gets or sets the FileHandler. Delegates attached to this property will receive sequential file stream data from this parser.

Gets or sets the ParameterHandler. Delegates attached to this property will receive parameter data.

Gets or sets the StreamClosedHandler. Delegates attached to this property will be notified when the source stream is exhausted.

Provides methods to find a subsequence within a sequence.

Finds if a sequence exists within another sequence.

The sequence to search. The sequence to look for. The start position of the found sequence or -1 if nothing was found.

Finds if a sequence exists within another sequence.

The sequence to search. The sequence to look for. The length of the haystack to consider for searching. The start position of the found sequence or -1 if nothing was found. Inspired by https://stackoverflow.com/a/39021296/153084 .