fix carriage returns

Author: tanner0101

Sources/FormData/Field.swift

@@ -7,9 +7,9 @@ import Multipart
     Headers and body reside in the Part.
 */
 public struct Field {
-    var name: String
-    var filename: String?
-    var part: Multipart.Part
+    public var name: String
+    public var filename: String?
+    public var part: Multipart.Part
 
     public init(name: String, filename: String?, part: Multipart.Part) {
         self.name = name

Sources/FormData/FormData+BytesConvertible.swift

@@ -8,12 +8,9 @@ import HTTP
     parser.
 */
 public final class Parser {
-    /// The multipart boundary being used.
-    public let boundary: Bytes
-    
     /// The underlying multipart parser.
     /// Subscribe to preamble and epilogue events.
-    public let multipartParser: Multipart.Parser
+    public let multipart: Multipart.Parser
 
     /// A callback type for handling parsed form-data fields.
     public typealias FieldCallback = (Field) -> ()
@@ -23,11 +20,10 @@ public final class Parser {
     public var onField: FieldCallback?
 
     /// Create a new Form Data parser.
-    public init(boundary: Bytes) {
-        self.boundary = boundary
-        multipartParser = Multipart.Parser(boundary: boundary)
+    public init(multipart: Multipart.Parser) {
+        self.multipart = multipart
 
-        multipartParser.onPart = { part in
+        self.multipart.onPart = { part in
             if let contentDisposition = part.headers[.contentDisposition] {
                 let parser = ContentDispositionParser()
 
@@ -60,13 +56,4 @@ public final class Parser {
             }
         }
     }
-    
-    /**
-        The main method for passing bytes into the parser.
-     
-        @see `Multipart.Parser.parse` for performance notes.
-    */
-    public func parse(_ bytes: Bytes) throws {
-        try multipartParser.parse(bytes)
-    }
 }

Sources/FormData/Parser.swift

@@ -6,16 +6,13 @@ import Multipart
     suitable for an HTTP response or request body.
  */
 public final class Serializer {
-    /// The multipart boundary being used.
-    public let boundary: Bytes
 
     /// The underlying multipart serializer.
     /// Use to serialize preamble and epilogue.
-    public let multipartSerializer: Multipart.Serializer
+    public let multipart: Multipart.Serializer
 
-    public init(boundary: Bytes) {
-        self.boundary = boundary
-        multipartSerializer = Multipart.Serializer(boundary: boundary)
+    public init(multipart: Multipart.Serializer) {
+        self.multipart = multipart
     }
 
     /**
@@ -40,6 +37,6 @@ public final class Serializer {
         }
 
         part.headers["Content-Disposition"] = contentDisposition
-        try multipartSerializer.serialize(part)
+        try multipart.serialize(part)
     }
 }

Sources/FormData/Serializer.swift

@@ -34,7 +34,7 @@ final class HeaderParser {
     func parse(_ byte: Byte) throws {
         main: switch state {
         case .none:
-            if byte == .newLine {
+            if byte == .newLine  {
                 break main
             }
 

Sources/Multipart/HeaderParser.swift

@@ -121,6 +121,12 @@ public final class Parser {
             throw Error.hasAlreadyFinished
         }
 
+        // we only care about new lines
+        // this requires that all line endings be `\n` or `\r\n`
+        if byte == .carriageReturn {
+            return
+        }
+        
         switch state {
         case .preamble(let bodyEndIndex):
             try boundaryParser.parse(byte)

Sources/Multipart/Parser.swift

@@ -61,18 +61,18 @@ public final class Serializer {
 
         serialize([.hyphen, .hyphen])
         serialize(boundary)
-        serialize(.newLine)
+        serialize([.carriageReturn, .newLine])
         for (key, value) in part.headers {
             serialize(key.key.bytes)
             serialize(.colon)
             serialize(.space)
             serialize(value.bytes)
-            serialize(.newLine)
+            serialize([.carriageReturn, .newLine])
         }
-        serialize(.newLine)
+        serialize([.carriageReturn, .newLine])
 
         serialize(part.body)
-        serialize(.newLine)
+        serialize([.carriageReturn, .newLine])
 
         partsSerialized = true
     }
@@ -93,7 +93,7 @@ public final class Serializer {
         serialize([.hyphen, .hyphen])
         serialize(boundary)
         serialize([.hyphen, .hyphen])
-        serialize(.newLine)
+        serialize([.carriageReturn, .newLine])
         serialize(epilogue)
 
         epilogueSerialized = true

Sources/Multipart/Serializer.swift

@@ -1,20 +1,17 @@
 import Foundation
 import XCTest
 @testable import FormData
+import Multipart
 
 class ParserTests: XCTestCase {
     static var allTests = [
-        ("testInit", testInit),
         ("testFormData", testFormData),
+        ("testWebkit", testWebkit),
     ]
 
-    func testInit() throws {
-        let parser = try Parser(boundary: "foo")
-        XCTAssertEqual(parser.boundary, "foo".bytes)
-    }
-    
     func testFormData() throws {
-        let parser = try Parser(boundary: "---------------------------9051914041544843365972754266")
+        let multipart = try Multipart.Parser(boundary: "---------------------------9051914041544843365972754266")
+        let parser = FormData.Parser(multipart: multipart)
 
         var message = ""
 
@@ -42,7 +39,7 @@ class ParserTests: XCTestCase {
             fields[field.name] = field
         }
 
-        try parser.parse(message)
+        try parser.multipart.parse(message)
 
         XCTAssertEqual(fields.count, 3)
 
@@ -54,4 +51,30 @@ class ParserTests: XCTestCase {
         XCTAssertEqual(fields["file1"]?.filename, "a.txt")
         XCTAssertEqual(fields["file2"]?.filename, "a.html")
     }
+    
+    func testWebkit() throws {
+        var message = ""
+
+        message += "------WebKitFormBoundaryezkRLRyEVe1aMUVZ\r\n"
+        message += "Content-Disposition: form-data; name=\"file\"; filename=\"Screen Shot 2017-01-13 at 3.05.26 PM.png\"\r\n"
+        message += "Content-Type: image/png\r\n"
+        message += "\r\n"
+        message += "PNG\n"
+        message += "\n"
+        message += "\n"
+        message += "------WebKitFormBoundaryezkRLRyEVe1aMUVZ--\r\n"
+        
+        let multipart = try Multipart.Parser(boundary: "----WebKitFormBoundaryezkRLRyEVe1aMUVZ")
+        let parser = FormData.Parser(multipart: multipart)
+        
+        var fields: [String: Field] = [:]
+        
+        parser.onField = { field in
+            fields[field.name] = field
+        }
+        
+        try parser.multipart.parse(message)
+        
+        XCTAssertEqual(fields["file"]?.filename, "Screen Shot 2017-01-13 at 3.05.26 PM.png")
+    }
 }

Tests/FormDataTests/ParserTests.swift

@@ -7,15 +7,8 @@ import HTTP
 
 class SerializerTests: XCTestCase {
     static var allTests = [
-        ("testInit", testInit),
         ("testBasic", testBasic),
     ]
-
-    
-    func testInit() throws {
-        let serializer = try FormData.Serializer(boundary: "foo")
-        XCTAssertEqual(serializer.boundary, "foo".bytes)
-    }
 
     public func testBasic() throws {
         let part1 = Part(headers: [
@@ -27,30 +20,31 @@ class SerializerTests: XCTestCase {
         let field1 = Field(name: "title", filename: nil, part: part1)
         let field2 = Field(name: "image", filename: "image.jpg", part: part2)
 
-        let serializer = try FormData.Serializer(boundary: "boundary42")
+        let multipart = try Multipart.Serializer(boundary: "boundary42")
+        let serializer = FormData.Serializer(multipart: multipart)
 
         var serialized: Bytes = []
 
-        serializer.multipartSerializer.onSerialize = { bytes in
+        serializer.multipart.onSerialize = { bytes in
             serialized += bytes
         }
 
         try serializer.serialize(field1)
         try serializer.serialize(field2)
-        try serializer.multipartSerializer.finish()
+        try serializer.multipart.finish()
 
         var expected = ""
 
-        expected += "--boundary42\n"
-        expected += "Content-Disposition: form-data; name=\"title\"\n"
-        expected += "Content-Type: text/plain; charset=us-ascii\n"
-        expected += "\n"
-        expected += "Systems should choose the 'best' type based on the local environment and references, in some cases even through user interaction.\n"
-        expected += "--boundary42\n"
-        expected += "Content-Disposition: form-data; name=\"image\"; filename=\"image.jpg\"\n"
-        expected += "\n"
-        expected += "Test123\n"
-        expected += "--boundary42--\n"
+        expected += "--boundary42\r\n"
+        expected += "Content-Disposition: form-data; name=\"title\"\r\n"
+        expected += "Content-Type: text/plain; charset=us-ascii\r\n"
+        expected += "\r\n"
+        expected += "Systems should choose the 'best' type based on the local environment and references, in some cases even through user interaction.\r\n"
+        expected += "--boundary42\r\n"
+        expected += "Content-Disposition: form-data; name=\"image\"; filename=\"image.jpg\"\r\n"
+        expected += "\r\n"
+        expected += "Test123\r\n"
+        expected += "--boundary42--\r\n"
 
         XCTAssertEqual(serialized.string, expected)
     }

Tests/FormDataTests/SerializerTests.swift

@@ -36,15 +36,15 @@ class SerializerTests: XCTestCase {
 
         var expected = ""
 
-        expected += "--boundary42\n"
-        expected += "Content-Type: text/plain; charset=us-ascii\n"
-        expected += "X-Test: 42\n"
-        expected += "\n"
-        expected += "Systems should choose the 'best' type based on the local environment and references, in some cases even through user interaction.\n"
-        expected += "--boundary42\n"
-        expected += "\n"
-        expected += "Test123\n"
-        expected += "--boundary42--\n"
+        expected += "--boundary42\r\n"
+        expected += "Content-Type: text/plain; charset=us-ascii\r\n"
+        expected += "X-Test: 42\r\n"
+        expected += "\r\n"
+        expected += "Systems should choose the 'best' type based on the local environment and references, in some cases even through user interaction.\r\n"
+        expected += "--boundary42\r\n"
+        expected += "\r\n"
+        expected += "Test123\r\n"
+        expected += "--boundary42--\r\n"
 
         XCTAssertEqual(serialized.string, expected)
     }