andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add an HTML5 encoder mode for HttpPostRequestEncoder

Browse Source
This commit is contained in:
Ionuț G. Stan 2013-12-22 03:25:00 +02:00 committed by Trustin Lee
parent a0714d1da3
commit 709be30442
4 changed files with 245 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
codec-http/src/main/java/io/netty/handler/codec/http/multipart/HttpPostRequestEncoder.java
View File

@ -54,15 +54,26 @@ public class HttpPostRequestEncoder implements ChunkedInput<HttpContent> {
*/
public enum EncoderMode {
/**
* Legacy mode which should work for most. It is known to not work with OAUTH. For OAUTH use
* {@link EncoderMode#RFC3986}. The W3C form recommentations this for submitting post form data.
* Legacy mode which should work for most. It is known to not work with OAUTH. For OAUTH use
* {@link EncoderMode#RFC3986}. The W3C form recommentations this for submitting post form data.
*/
RFC1738,
/**
* Mode which is more new and is used for OAUTH
*/
RFC3986
RFC3986,
/**
* The HTML5 spec disallows mixed mode in multipart/form-data
* requests. More concretely this means that more files submitted
* under the same name will not be encoded using mixed mode, but
* will be treated as distinct fields.
*
* Reference:
* http://www.w3.org/TR/html5/forms.html#multipart-form-data
*/
HTML5
}
private static final Map<Pattern, String> percentEncodings = new HashMap<Pattern, String>();
@ -371,7 +382,7 @@ public class HttpPostRequestEncoder implements ChunkedInput<HttpContent> {
}
/**
* Add a series of Files associated with one File parameter (implied Mixed mode in Multipart)
* Add a series of Files associated with one File parameter
*
* @param name
* the name of the parameter
@ -533,7 +544,8 @@ public class HttpPostRequestEncoder implements ChunkedInput<HttpContent> {
duringMixedMode = false;
}
} else {
if (currentFileUpload != null && currentFileUpload.getName().equals(fileUpload.getName())) {
if (encoderMode != EncoderMode.HTML5 && currentFileUpload != null
&& currentFileUpload.getName().equals(fileUpload.getName())) {
// create a new mixed mode (from previous file)
// change multipart body header of previous file into
@ -552,21 +564,23 @@ public class HttpPostRequestEncoder implements ChunkedInput<HttpContent> {
// * Content-Type: multipart/mixed; boundary=BbC04y
// *
// * --BbC04y
// * Content-Disposition: file; filename="file1.txt"
// * Content-Disposition: attachment; filename="file1.txt"
// Content-Type: text/plain
initMixedMultipart();
InternalAttribute pastAttribute = (InternalAttribute) multipartHttpDatas.get(multipartHttpDatas
.size() - 2);
// remove past size
globalBodySize -= pastAttribute.size();
String replacement = HttpPostBodyUtil.CONTENT_DISPOSITION + ": " + HttpPostBodyUtil.FORM_DATA
String replacement = "--" + multipartDataBoundary + "\r\n";
replacement += HttpPostBodyUtil.CONTENT_DISPOSITION + ": " + HttpPostBodyUtil.FORM_DATA
+ "; " + HttpPostBodyUtil.NAME + "=\"" + fileUpload.getName() + "\"\r\n";
replacement += HttpHeaders.Names.CONTENT_TYPE + ": " + HttpPostBodyUtil.MULTIPART_MIXED + "; "
+ HttpHeaders.Values.BOUNDARY + '=' + multipartMixedBoundary + "\r\n\r\n";
replacement += "--" + multipartMixedBoundary + "\r\n";
replacement += HttpPostBodyUtil.CONTENT_DISPOSITION + ": " + HttpPostBodyUtil.FILE + "; "
replacement += HttpPostBodyUtil.CONTENT_DISPOSITION + ": " + HttpPostBodyUtil.ATTACHMENT + "; "
+ HttpPostBodyUtil.FILENAME + "=\"" + fileUpload.getFilename() + "\"\r\n";
pastAttribute.setValue(replacement, 1);
pastAttribute.setValue("", 2);
// update past size
globalBodySize += pastAttribute.size();
@ -590,8 +604,8 @@ public class HttpPostRequestEncoder implements ChunkedInput<HttpContent> {
// add mixedmultipart delimiter, mixedmultipart body header and
// Data to multipart list
internal.addValue("--" + multipartMixedBoundary + "\r\n");
// Content-Disposition: file; filename="file1.txt"
internal.addValue(HttpPostBodyUtil.CONTENT_DISPOSITION + ": " + HttpPostBodyUtil.FILE + "; "
// Content-Disposition: attachment; filename="file1.txt"
internal.addValue(HttpPostBodyUtil.CONTENT_DISPOSITION + ": " + HttpPostBodyUtil.ATTACHMENT + "; "
+ HttpPostBodyUtil.FILENAME + "=\"" + fileUpload.getFilename() + "\"\r\n");
} else {
internal.addValue("--" + multipartDataBoundary + "\r\n");

219
codec-http/src/test/java/io/netty/handler/codec/http/multipart/HttpPostRequestEncoderTest.java Normal file
View File

@ -0,0 +1,219 @@
/*
* Copyright 2013 The Netty Project
*
* The Netty Project licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package io.netty.handler.codec.http.multipart;
import static org.junit.Assert.assertEquals;
import org.junit.Test;
import java.io.File;
import java.lang.reflect.Field;
import java.util.List;
import io.netty.handler.codec.http.multipart.HttpPostRequestEncoder.EncoderMode;
import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.handler.codec.http.DefaultFullHttpRequest;
import io.netty.handler.codec.http.HttpMethod;
import io.netty.handler.codec.http.HttpVersion;
import io.netty.util.CharsetUtil;
/** {@link HttpPostRequestEncoder} test case. */
public class HttpPostRequestEncoderTest {
@Test
public void testSingleFileUpload() throws Exception {
DefaultFullHttpRequest request = new DefaultFullHttpRequest(HttpVersion.HTTP_1_1,
HttpMethod.POST, "http://localhost");
HttpPostRequestEncoder encoder = new HttpPostRequestEncoder(request, true);
File file1 = new File(getClass().getResource("/file-01.txt").toURI());
encoder.addBodyAttribute("foo", "bar");
encoder.addBodyFileUpload("quux", file1, "text/plain", false);
String multipartDataBoundary = getEncoderField(encoder, "multipartDataBoundary");
String content = getRequestBody(encoder);
String expected = "--" + multipartDataBoundary + "\r\n" +
"Content-Disposition: form-data; name=\"foo\"" + "\r\n" +
"Content-Type: text/plain; charset=UTF-8" + "\r\n" +
"\r\n" +
"bar" +
"\r\n" +
"--" + multipartDataBoundary + "\r\n" +
"Content-Disposition: form-data; name=\"quux\"; filename=\"file-01.txt\"" + "\r\n" +
"Content-Type: text/plain" + "\r\n" +
"Content-Transfer-Encoding: binary" + "\r\n" +
"\r\n" +
"File 01\n" +
"\r\n" +
"--" + multipartDataBoundary + "--" + "\r\n";
assertEquals(expected, content);
}
@Test
public void testMultiFileUploadInMixedMode() throws Exception {
DefaultFullHttpRequest request = new DefaultFullHttpRequest(HttpVersion.HTTP_1_1,
HttpMethod.POST, "http://localhost");
HttpPostRequestEncoder encoder = new HttpPostRequestEncoder(request, true);
File file1 = new File(getClass().getResource("/file-01.txt").toURI());
File file2 = new File(getClass().getResource("/file-02.txt").toURI());
encoder.addBodyAttribute("foo", "bar");
encoder.addBodyFileUpload("quux", file1, "text/plain", false);
encoder.addBodyFileUpload("quux", file2, "text/plain", false);
// We have to query the value of these two fields before finalizing
// the request, which unsets one of them.
String multipartDataBoundary = getEncoderField(encoder, "multipartDataBoundary");
String multipartMixedBoundary = getEncoderField(encoder, "multipartMixedBoundary");
String content = getRequestBody(encoder);
String expected = "--" + multipartDataBoundary + "\r\n" +
"Content-Disposition: form-data; name=\"foo\"" + "\r\n" +
"Content-Type: text/plain; charset=UTF-8" + "\r\n" +
"\r\n" +
"bar" + "\r\n" +
"--" + multipartDataBoundary + "\r\n" +
"Content-Disposition: form-data; name=\"quux\"" + "\r\n" +
"Content-Type: multipart/mixed; boundary=" + multipartMixedBoundary + "\r\n" +
"\r\n" +
"--" + multipartMixedBoundary + "\r\n" +
"Content-Disposition: attachment; filename=\"file-02.txt\"" + "\r\n" +
"Content-Type: text/plain" + "\r\n" +
"Content-Transfer-Encoding: binary" + "\r\n" +
"\r\n" +
"File 01\n" +
"\r\n" +
"--" + multipartMixedBoundary + "\r\n" +
"Content-Disposition: attachment; filename=\"file-02.txt\"" + "\r\n" +
"Content-Type: text/plain" + "\r\n" +
"Content-Transfer-Encoding: binary" + "\r\n" +
"\r\n" +
"File 02\n" +
"\r\n" +
"--" + multipartMixedBoundary + "--" + "\r\n" +
"--" + multipartDataBoundary + "--" + "\r\n";
assertEquals(expected, content);
}
@Test
public void testSinleFileUploadInHtml5Mode() throws Exception {
DefaultFullHttpRequest request = new DefaultFullHttpRequest(HttpVersion.HTTP_1_1,
HttpMethod.POST, "http://localhost");
DefaultHttpDataFactory factory = new DefaultHttpDataFactory(DefaultHttpDataFactory.MINSIZE);
HttpPostRequestEncoder encoder = new HttpPostRequestEncoder(factory,
request, true, CharsetUtil.UTF_8, EncoderMode.HTML5);
File file1 = new File(getClass().getResource("/file-01.txt").toURI());
File file2 = new File(getClass().getResource("/file-02.txt").toURI());
encoder.addBodyAttribute("foo", "bar");
encoder.addBodyFileUpload("quux", file1, "text/plain", false);
encoder.addBodyFileUpload("quux", file2, "text/plain", false);
String multipartDataBoundary = getEncoderField(encoder, "multipartDataBoundary");
String content = getRequestBody(encoder);
String expected = "--" + multipartDataBoundary + "\r\n" +
"Content-Disposition: form-data; name=\"foo\"" + "\r\n" +
"Content-Type: text/plain; charset=UTF-8" + "\r\n" +
"\r\n" +
"bar" + "\r\n" +
"--" + multipartDataBoundary + "\r\n" +
"Content-Disposition: form-data; name=\"quux\"; filename=\"file-01.txt\"" + "\r\n" +
"Content-Type: text/plain" + "\r\n" +
"Content-Transfer-Encoding: binary" + "\r\n" +
"\r\n" +
"File 01\n" + "\r\n" +
"--" + multipartDataBoundary + "\r\n" +
"Content-Disposition: form-data; name=\"quux\"; filename=\"file-02.txt\"" + "\r\n" +
"Content-Type: text/plain" + "\r\n" +
"Content-Transfer-Encoding: binary" + "\r\n" +
"\r\n" +
"File 02\n" +
"\r\n" +
"--" + multipartDataBoundary + "--" + "\r\n";
assertEquals(expected, content);
}
@Test
public void testMultiFileUploadInHtml5Mode() throws Exception {
DefaultFullHttpRequest request = new DefaultFullHttpRequest(HttpVersion.HTTP_1_1,
HttpMethod.POST, "http://localhost");
DefaultHttpDataFactory factory = new DefaultHttpDataFactory(DefaultHttpDataFactory.MINSIZE);
HttpPostRequestEncoder encoder = new HttpPostRequestEncoder(factory,
request, true, CharsetUtil.UTF_8, EncoderMode.HTML5);
File file1 = new File(getClass().getResource("/file-01.txt").toURI());
encoder.addBodyAttribute("foo", "bar");
encoder.addBodyFileUpload("quux", file1, "text/plain", false);
String multipartDataBoundary = getEncoderField(encoder, "multipartDataBoundary");
String content = getRequestBody(encoder);
String expected = "--" + multipartDataBoundary + "\r\n" +
"Content-Disposition: form-data; name=\"foo\"" + "\r\n" +
"Content-Type: text/plain; charset=UTF-8" + "\r\n" +
"\r\n" +
"bar" +
"\r\n" +
"--" + multipartDataBoundary + "\r\n" +
"Content-Disposition: form-data; name=\"quux\"; filename=\"file-01.txt\"" + "\r\n" +
"Content-Type: text/plain" + "\r\n" +
"Content-Transfer-Encoding: binary" + "\r\n" +
"\r\n" +
"File 01\n" +
"\r\n" +
"--" + multipartDataBoundary + "--" + "\r\n";
assertEquals(expected, content);
}
private String getRequestBody(HttpPostRequestEncoder encoder) throws Exception {
encoder.finalizeRequest();
List<InterfaceHttpData> chunks = getEncoderField(encoder, "multipartHttpDatas");
ByteBuf[] buffers = new ByteBuf[chunks.size()];
for (int i = 0; i < buffers.length; i++) {
InterfaceHttpData data = chunks.get(i);
if (data instanceof InternalAttribute) {
buffers[i] = ((InternalAttribute) data).toByteBuf();
} else if (data instanceof HttpData) {
buffers[i] = ((HttpData) data).getByteBuf();
}
}
return Unpooled.wrappedBuffer(buffers).toString(CharsetUtil.UTF_8);
}
private <A> A getEncoderField(HttpPostRequestEncoder encoder, String fieldName) throws Exception {
return this.<A, HttpPostRequestEncoder>getField(encoder, HttpPostRequestEncoder.class, fieldName);
}
@SuppressWarnings("unchecked")
private <A, T> A getField(T instance, Class<T> klass, String fieldName) throws Exception {
Field requestField = klass.getDeclaredField(fieldName);
requestField.setAccessible(true);
return (A) requestField.get(instance);
}
}

1
codec-http/src/test/resources/file-01.txt Normal file
View File

@ -0,0 +1 @@
File 01

1
codec-http/src/test/resources/file-02.txt Normal file
View File

@ -0,0 +1 @@
File 02