Access to multipart form data file names fix jooby-project#1676

jknack · jknack · commit 37f4fa77c2b4 · 2020-05-03T21:53:34.000-03:00
diff --git a/jooby/src/main/java/io/jooby/FileUpload.java b/jooby/src/main/java/io/jooby/FileUpload.java
@@ -31,6 +31,14 @@
  * @author edgar
  */
 public interface FileUpload {
+
+  /**
+   * File key. That's the field form name, not the file name. Example:
+   *
+   * @return File key. That's the field form name, not the file name.
+   */
+  @Nonnull String getName();
+
   /**
    * Name of file upload.
    * @return Name of file upload.
diff --git a/modules/jooby-jetty/src/main/java/io/jooby/internal/jetty/JettyFileUpload.java b/modules/jooby-jetty/src/main/java/io/jooby/internal/jetty/JettyFileUpload.java
@@ -9,6 +9,7 @@
 import io.jooby.SneakyThrows;
 import org.eclipse.jetty.http.MultiPartFormInputStream;
 
+import javax.annotation.Nonnull;
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.file.Files;
@@ -21,6 +22,10 @@ public JettyFileUpload(MultiPartFormInputStream.MultiPart upload) {
     this.upload = upload;
   }
 
+  @Nonnull @Override public String getName() {
+    return upload.getName();
+  }
+
   @Override public String getFileName() {
     return upload.getSubmittedFileName();
   }
diff --git a/modules/jooby-netty/src/main/java/io/jooby/internal/netty/NettyFileUpload.java b/modules/jooby-netty/src/main/java/io/jooby/internal/netty/NettyFileUpload.java
@@ -10,6 +10,7 @@
 import io.netty.buffer.ByteBufInputStream;
 import io.netty.handler.codec.http.multipart.DiskFileUpload;
 
+import javax.annotation.Nonnull;
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.file.Files;
@@ -26,6 +27,10 @@ public NettyFileUpload(Path basedir,
     this.upload = upload;
   }
 
+  @Nonnull @Override public String getName() {
+    return upload.getName();
+  }
+
   @Override public byte[] bytes() {
     try {
       if (upload.isInMemory()) {
diff --git a/modules/jooby-utow/src/main/java/io/jooby/internal/utow/UtowContext.java b/modules/jooby-utow/src/main/java/io/jooby/internal/utow/UtowContext.java
@@ -535,7 +535,7 @@ private void formData(Formdata form, FormData data) {
         Deque<FormData.FormValue> values = data.get(path);
         for (FormData.FormValue value : values) {
           if (value.isFileItem()) {
-            ((Multipart) form).put(path, new UtowFileUpload(value));
+            ((Multipart) form).put(path, new UtowFileUpload(path, value));
           } else {
             form.put(path, value.getValue());
           }
diff --git a/modules/jooby-utow/src/main/java/io/jooby/internal/utow/UtowFileUpload.java b/modules/jooby-utow/src/main/java/io/jooby/internal/utow/UtowFileUpload.java
@@ -11,6 +11,7 @@
 import io.undertow.server.handlers.form.FormData;
 import io.undertow.util.Headers;
 
+import javax.annotation.Nonnull;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
@@ -19,8 +20,10 @@
 public class UtowFileUpload implements FileUpload {
 
   private final FormData.FormValue upload;
+  private final String name;
 
-  public UtowFileUpload(FormData.FormValue upload) {
+  public UtowFileUpload(String name, FormData.FormValue upload) {
+    this.name = name;
     this.upload = upload;
   }
 
@@ -46,6 +49,10 @@ public UtowFileUpload(FormData.FormValue upload) {
     }
   }
 
+  @Nonnull @Override public String getName() {
+    return name;
+  }
+
   @Override public String getFileName() {
     return upload.getFileName();
   }
diff --git a/modules/jooby-utow/src/test/java/io/jooby/internal/utow/UtowFileUploadTest.java b/modules/jooby-utow/src/test/java/io/jooby/internal/utow/UtowFileUploadTest.java
@@ -22,7 +22,7 @@ public void shouldGetFileSize() throws IOException {
     FormData.FormValue upload = mock(FormData.FormValue.class);
     when(upload.getFileItem()).thenReturn(fileItem);
 
-    assertEquals(fileSize, new UtowFileUpload(upload).getFileSize());
+    assertEquals(fileSize, new UtowFileUpload("file", upload).getFileSize());
   }
 
   @Test
@@ -35,6 +35,6 @@ public void shouldGetUnknownFileSize() throws IOException {
     FormData.FormValue upload = mock(FormData.FormValue.class);
     when(upload.getFileItem()).thenReturn(fileItem);
 
-    assertEquals(fileSize, new UtowFileUpload(upload).getFileSize());
+    assertEquals(fileSize, new UtowFileUpload("file", upload).getFileSize());
   }
 }
diff --git a/tests/src/test/java/io/jooby/Issue1676.java b/tests/src/test/java/io/jooby/Issue1676.java
@@ -0,0 +1,33 @@
+package io.jooby;
+
+import io.jooby.junit.ServerTest;
+import io.jooby.junit.ServerTestRunner;
+import okhttp3.MultipartBody;
+
+import java.util.stream.Collectors;
+
+import static okhttp3.RequestBody.create;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class Issue1676 {
+  @ServerTest
+  public void shouldParseFileKeyFromMultipartUpload(ServerTestRunner runner) {
+    String content = "Proin pulvinar purus ac lacus pharetra, tristique fringilla lacus finibus. "
+        + "Praesent bibendum tellus feugiat euismod sollicitudin. Integer sed sem vestibulum sem "
+        + "imperdiet blandit. Vivamus in lorem quis orci gravida hendrerit.";
+    runner.define(app -> {
+      app.post("/1676", ctx ->
+          ctx.files().stream()
+              .collect(Collectors.toMap(FileUpload::getName, FileUpload::getFileName))
+      );
+    }).ready(client -> {
+      client.post("/1676", new MultipartBody.Builder()
+          .setType(MultipartBody.FORM)
+          .addFormDataPart("filekey", "19kb.txt",
+              create(content, okhttp3.MediaType.parse("text/plain")))
+          .build(), rsp -> {
+        assertEquals("{filekey=19kb.txt}", rsp.body().string());
+      });
+    });
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -535,7 +535,7 @@ private void formData(Formdata form, FormData data) {`
`535`	`535`	`Deque<FormData.FormValue> values = data.get(path);`
`536`	`536`	`for (FormData.FormValue value : values) {`
`537`	`537`	`if (value.isFileItem()) {`
`538`		`- ((Multipart) form).put(path, new UtowFileUpload(value));`
	`538`	`+ ((Multipart) form).put(path, new UtowFileUpload(path, value));`
`539`	`539`	`} else {`
`540`	`540`	`form.put(path, value.getValue());`
`541`	`541`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`	`import io.undertow.server.handlers.form.FormData;`
`12`	`12`	`import io.undertow.util.Headers;`
`13`	`13`
	`14`	`+import javax.annotation.Nonnull;`
`14`	`15`	`import java.io.ByteArrayOutputStream;`
`15`	`16`	`import java.io.IOException;`
`16`	`17`	`import java.io.InputStream;`
`@@ -19,8 +20,10 @@`
`19`	`20`	`public class UtowFileUpload implements FileUpload {`
`20`	`21`
`21`	`22`	`private final FormData.FormValue upload;`
	`23`	`+ private final String name;`
`22`	`24`
`23`		`- public UtowFileUpload(FormData.FormValue upload) {`
	`25`	`+ public UtowFileUpload(String name, FormData.FormValue upload) {`
	`26`	`+ this.name = name;`
`24`	`27`	`this.upload = upload;`
`25`	`28`	`}`
`26`	`29`
`@@ -46,6 +49,10 @@ public UtowFileUpload(FormData.FormValue upload) {`
`46`	`49`	`}`
`47`	`50`	`}`
`48`	`51`
	`52`	`+ @Nonnull @Override public String getName() {`
	`53`	`+ return name;`
	`54`	`+ }`
	`55`	`+`
`49`	`56`	`@Override public String getFileName() {`
`50`	`57`	`return upload.getFileName();`
`51`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ public void shouldGetFileSize() throws IOException {`
`22`	`22`	`FormData.FormValue upload = mock(FormData.FormValue.class);`
`23`	`23`	`when(upload.getFileItem()).thenReturn(fileItem);`
`24`	`24`
`25`		`- assertEquals(fileSize, new UtowFileUpload(upload).getFileSize());`
	`25`	`+ assertEquals(fileSize, new UtowFileUpload("file", upload).getFileSize());`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`@Test`
`@@ -35,6 +35,6 @@ public void shouldGetUnknownFileSize() throws IOException {`
`35`	`35`	`FormData.FormValue upload = mock(FormData.FormValue.class);`
`36`	`36`	`when(upload.getFileItem()).thenReturn(fileItem);`
`37`	`37`
`38`		`- assertEquals(fileSize, new UtowFileUpload(upload).getFileSize());`
	`38`	`+ assertEquals(fileSize, new UtowFileUpload("file", upload).getFileSize());`
`39`	`39`	`}`
`40`	`40`	`}`