file parameters are back for the result of WebRequest.getParameters() (#836)

rbri · rbri · commit f33fa53e1a55 · 2024-08-03T19:10:27.000+02:00
diff --git a/src/main/java/org/htmlunit/WebRequest.java b/src/main/java/org/htmlunit/WebRequest.java
@@ -343,20 +343,25 @@ public void setEncodingType(final FormEncodingType encodingType) {
     }
 
     /**
-     * Retrieves the request parameters used. Similar to the servlet api function
+     * <p>Retrieves the request parameters used. Similar to the servlet api function
      * getParameterMap() this works depending on the request type and collects the
-     * url parameters and the body stuff.
-     * The value is also normalized - null is converted to an empty string.
-     * In contrast to the servlet api this creates a separate KeyValuePair for every
+     * url parameters and the body stuff.<br>
+     * The value is also normalized - null is converted to an empty string.</p>
+     * <p>In contrast to the servlet api this creates a separate KeyValuePair for every
      * parameter. This means that pairs with the same name can be part of the list. The
-     * servlet api will return a string[] as value for the key in this case.
+     * servlet api will return a string[] as value for the key in this case.<br>
+     * Additionally this method includes also the uploaded files for multipart post
+     * requests.</p>
      *
      * @return the request parameters to use
      */
     public List<NameValuePair> getParameters() {
         // developer note:
-        // this has to be in sync with
-        // org.htmlunit.HttpWebConnection.makeHttpMethod(WebRequest, HttpClientBuilder)
+        // this has to be in sync with org.htmlunit.HttpWebConnection.makeHttpMethod(WebRequest, HttpClientBuilder)
+
+        // developer note:
+        // the spring org.springframework.test.web.servlet.htmlunitHtmlUnitRequestBuilder uses
+        // this method and is sensitive to all the details of the current implementation.
 
         if (HttpMethod.POST != getHttpMethod() && HttpMethod.PUT != getHttpMethod()
                 && HttpMethod.PATCH != getHttpMethod()) {
@@ -402,9 +407,11 @@ public List<NameValuePair> getParameters() {
 
         if (FormEncodingType.MULTIPART == getEncodingType()) {
             final List<NameValuePair> allParameters = new ArrayList<>();
+
+            // the servlet api ignores these parameters but to make spring happy we include them
+            allParameters.addAll(getRequestParameters());
+
             allParameters.addAll(HttpUtils.parseUrlQuery(getUrl().getQuery(), getCharset()));
-            // the servlet api ignores the parameters
-            // allParameters.addAll(getRequestParameters());
             return normalize(allParameters);
         }
 
diff --git a/src/test/java/org/htmlunit/WebRequest2Test.java b/src/test/java/org/htmlunit/WebRequest2Test.java
@@ -31,6 +31,12 @@
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
+import org.apache.commons.fileupload.FileItem;
+import org.apache.commons.fileupload.FileUploadBase;
+import org.apache.commons.fileupload.FileUploadException;
+import org.apache.commons.fileupload.disk.DiskFileItemFactory;
+import org.apache.commons.fileupload.servlet.ServletFileUpload;
+import org.apache.commons.fileupload.servlet.ServletRequestContext;
 import org.apache.commons.lang3.StringUtils;
 import org.htmlunit.junit.BrowserParameterizedRunner;
 import org.htmlunit.junit.BrowserParameterizedRunner.Default;
@@ -354,6 +360,25 @@ private static void bounceToStatic(final HttpServletRequest req, final HttpServl
         private static void bounce(final Writer writer,
                 final HttpServletRequest req, final HttpServletResponse resp) throws IOException {
             writer.write("Parameters: \n");
+
+            // different from the servlet api spring also uses the file upload information
+            try {
+                // if (ServletFileUpload.isMultipartContent(req)) {
+                // ignore the post request check
+                if (FileUploadBase.isMultipartContent(new ServletRequestContext(req))) {
+                    final DiskFileItemFactory factory = new DiskFileItemFactory();
+
+                    final ServletFileUpload upload = new ServletFileUpload(factory);
+                    final List<FileItem> items = upload.parseRequest(req);
+                    for (final FileItem fileItem : items) {
+                        writer.write("  '" + fileItem.getFieldName() + "': '" + fileItem.getString() + "'\n");
+                    }
+                }
+            }
+            catch (final FileUploadException e) {
+                throw new IOException(e);
+            }
+
             // use only getParameterMap() here because we like to have the same behavior
             for (final Map.Entry<String, String[]> entry : req.getParameterMap().entrySet()) {
                 if (entry.getValue() == null) {
