Don't to do HTML entity decoding for multi-part form fields

pkg/http_server/test/http_multipart_test.dart

 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 import "package:http_server/http_server.dart";
 import "package:mime/mime.dart";
 import "package:unittest/unittest.dart";
 import 'dart:async';
 import 'dart:io';
 import 'dart:convert';
 
 class FormField {
   final String name;
   final value;

[kustermann, 2014/11/18 16:34:20]

Document that 'value' is either String or List<int> here.

[Søren Gjesse, 2014/11/19 07:41:05]

Done.

   final String contentType;
   final String filename;
 
   FormField(String this.name,
             this.value,
             {String this.contentType,
              String this.filename});
 
   bool operator==(other) {
     if (value.length != other.value.length) return false;
     for (int i = 0; i < value.length; i++) {
       if (value[i] != other.value[i]) {
         return false;
       }
     }
     return name == other.name &&
            contentType == other.contentType &&
            filename == other.filename;
   }

[kustermann, 2014/11/18 16:34:20]

If this one overrides operator== it should also override hashCode!

[Søren Gjesse, 2014/11/19 07:41:05]

Oops. Just used name.hashCode.

 
   String toString() {
     return "FormField('$name', '$value', '$contentType', '$filename')";
   }
 }
 
 void postDataTest(List<int> message,
                   String contentType,
                   String boundary,
-                  List<FormField> expectedFields) {
+                  List<FormField> expectedFields,
+                  {defaultEncoding: LATIN1}) {
   HttpServer.bind("127.0.0.1", 0).then((server) {
     server.listen((request) {
       String boundary = request.headers.contentType.parameters['boundary'];
       request
           .transform(new MimeMultipartTransformer(boundary))
           .map((part) => HttpMultipartFormData.parse(
-              part, defaultEncoding: LATIN1))
+              part, defaultEncoding: defaultEncoding))
           .map((multipart) {
             var future;
             if (multipart.isText) {
               future = multipart
                   .fold(new StringBuffer(), (b, s) => b..write(s))
                   .then((b) => b.toString());

[kustermann, 2014/11/18 16:34:20]

Maybe just do a

future = multipart.join('')

here?

[Søren Gjesse, 2014/11/19 07:41:05]

Done.

             } else {
               future = multipart
                   .fold([], (b, s) => b..addAll(s));

[kustermann, 2014/11/18 16:34:20]

future = multipart.toList()

[Søren Gjesse, 2014/11/19 07:41:05]

toList does not have the addAll semantics.

             }
             return future
                 .then((data) {
                   String contentType;
                   if (multipart.contentType != null) {
                     contentType = multipart.contentType.mimeType;
                   }
                   return new FormField(
                       multipart.contentDisposition.parameters['name'],
                       data,
                       contentType: contentType,
                       filename:
                           multipart.contentDisposition.parameters['filename']);
                 });
           })
           .fold([], (l, f) => l..add(f))

[kustermann, 2014/11/18 16:34:20]

Just do a '.toList()' instead ?

[Søren Gjesse, 2014/11/19 07:41:05]

Done.

           .then(Future.wait)
           .then((fields) {
             expect(fields, equals(expectedFields));
             request.response.close().then((_) => server.close());
           });
     });
     var client = new HttpClient();
     client.post('127.0.0.1', server.port, '/')
         .then((request) {
           request.headers.set('content-type',
@@ skipping 93 matching lines @@
 
   postDataTest(message,
                'multipart/form-data',
                '----WebKitFormBoundaryQSql8kDALM7tAkC1',
                [new FormField('submit-name', 'Test'),
                 new FormField('files',
                               data,
                               contentType: 'application/octet-stream',
                               filename: 'VERSION')]);
 
+  // In Chrome, Safari and Firefox HTML entity encoding might be used for
+  // values in form fields. The HTML entity encoding for ひらがな is
+  // ひらがな
   message = [
       45, 45, 45, 45, 45, 45, 87, 101, 98, 75, 105, 116, 70, 111, 114, 109, 66,
       111, 117, 110, 100, 97, 114, 121, 118, 65, 86, 122, 117, 103, 75, 77, 116,
       90, 98, 121, 87, 111, 66, 71, 13, 10, 67, 111, 110, 116, 101, 110, 116,
       45, 68, 105, 115, 112, 111, 115, 105, 116, 105, 111, 110, 58, 32, 102,
       111, 114, 109, 45, 100, 97, 116, 97, 59, 32, 110, 97, 109, 101, 61, 34,
       110, 97, 109, 101, 34, 13, 10, 13, 10, 38, 35, 49, 50, 52, 48, 50, 59, 38,
       35, 49, 50, 52, 50, 53, 59, 38, 35, 49, 50, 51, 54, 52, 59, 38, 35, 49,
       50, 51, 57, 52, 59, 13, 10, 45, 45, 45, 45, 45, 45, 87, 101, 98, 75, 105,
       116, 70, 111, 114, 109, 66, 111, 117, 110, 100, 97, 114, 121, 118, 65, 86,
       122, 117, 103, 75, 77, 116, 90, 98, 121, 87, 111, 66, 71, 45, 45, 13, 10];
 
   postDataTest(message,
                'multipart/form-data',
                '----WebKitFormBoundaryvAVzugKMtZbyWoBG',
-               [new FormField('name', 'ひらがな')]);
+               [new FormField('name', 'ひらがな')],
+               defaultEncoding: UTF8);
+
+  // The UTF-8 encoding of ひらがな is
+  // [227, 129, 178, 227, 130, 137, 227, 129, 140, 227, 129, 170].
+  message = [
+      45, 45, 45, 45, 45, 45, 87, 101, 98, 75, 105, 116, 70, 111, 114, 109, 66,
+      111, 117, 110, 100, 97, 114, 121, 71, 88, 116, 66, 114, 99, 106, 120, 104,
+      101, 75, 101, 78, 54, 105, 48, 13, 10, 67, 111, 110, 116, 101, 110, 116,
+      45, 68, 105, 115, 112, 111, 115, 105, 116, 105, 111, 110, 58, 32, 102,
+      111, 114, 109, 45, 100, 97, 116, 97, 59, 32, 110, 97, 109, 101, 61, 34,
+      116, 101, 115, 116, 34, 13, 10, 13, 10, 227, 129, 178, 227, 130, 137, 227,
+      129, 140, 227, 129, 170, 13, 10, 45, 45, 45, 45, 45, 45, 87, 101, 98, 75,
+      105, 116, 70, 111, 114, 109, 66, 111, 117, 110, 100, 97, 114, 121, 71, 88,
+      116, 66, 114, 99, 106, 120, 104, 101, 75, 101, 78, 54, 105, 48, 45, 45, 13,

[kustermann, 2014/11/18 16:34:20]

long line 

[Søren Gjesse, 2014/11/19 07:41:05]

Done.

+      10];
+
+  postDataTest(message,
+               'multipart/form-data',
+               '----WebKitFormBoundaryGXtBrcjxheKeN6i0',
+               [new FormField('test', 'ひらがな')],
+               defaultEncoding: UTF8);
 
   message = [
       45, 45, 45, 45, 45, 45, 87, 101, 98, 75, 105, 116, 70, 111, 114, 109, 66,
       111, 117, 110, 100, 97, 114, 121, 102, 101, 48, 69, 122, 86, 49, 97, 78,
       121, 115, 68, 49, 98, 80, 104, 13, 10, 67, 111, 110, 116, 101, 110, 116,
       45, 68, 105, 115, 112, 111, 115, 105, 116, 105, 111, 110, 58, 32, 102,
       111, 114, 109, 45, 100, 97, 116, 97, 59, 32, 110, 97, 109, 101, 61, 34,
       110, 97, 109, 101, 34, 13, 10, 13, 10, 248, 118, 13, 10, 45, 45, 45, 45,
       45, 45, 87, 101, 98, 75, 105, 116, 70, 111, 114, 109, 66, 111, 117, 110,
       100, 97, 114, 121, 102, 101, 48, 69, 122, 86, 49, 97, 78, 121, 115, 68,
       49, 98, 80, 104, 45, 45, 13, 10];
 
   postDataTest(message,
                'multipart/form-data',
                '----WebKitFormBoundaryfe0EzV1aNysD1bPh',
                [new FormField('name', 'øv')]);
 }
 
 
 void main() {
   testEmptyPostData();
   testPostData();
 }