This is an automated email from the ASF dual-hosted git repository. lukaszlenart pushed a commit to branch fix/after-rebase in repository https://gitbox.apache.org/repos/asf/struts.git
commit 19642a5e6979471459b1bfa81de70762b7689152 Author: Lukasz Lenart <[email protected]> AuthorDate: Sat Dec 16 13:58:52 2023 +0100 WW-5371 Migrates modern upload change to JakartaEE --- .../multipart/JakartaStreamMultiPartRequest.java | 13 +--- .../multipart/MultiPartRequestWrapper.java | 20 ++--- .../interceptor/ActionFileUploadInterceptor.java | 9 +-- .../ActionFileUploadInterceptorTest.java | 87 +++++++++++----------- 4 files changed, 61 insertions(+), 68 deletions(-) diff --git a/core/src/main/java/org/apache/struts2/dispatcher/multipart/JakartaStreamMultiPartRequest.java b/core/src/main/java/org/apache/struts2/dispatcher/multipart/JakartaStreamMultiPartRequest.java index 80ef58097..90ef7a047 100644 --- a/core/src/main/java/org/apache/struts2/dispatcher/multipart/JakartaStreamMultiPartRequest.java +++ b/core/src/main/java/org/apache/struts2/dispatcher/multipart/JakartaStreamMultiPartRequest.java @@ -18,17 +18,12 @@ */ package org.apache.struts2.dispatcher.multipart; +import org.apache.commons.fileupload2.core.DiskFileItem; +import org.apache.commons.fileupload2.core.DiskFileItemFactory; import org.apache.commons.fileupload2.jakarta.JakartaServletFileUpload; import org.apache.commons.fileupload2.core.FileUploadSizeException; import org.apache.commons.fileupload2.core.FileItemInputIterator; import org.apache.commons.fileupload2.core.FileItemInput; -import org.apache.commons.fileupload.FileItemIterator; -import org.apache.commons.fileupload.FileItemStream; -import org.apache.commons.fileupload.FileUploadBase; -import org.apache.commons.fileupload.FileUploadBase.FileSizeLimitExceededException; -import org.apache.commons.fileupload.FileUploadException; -import org.apache.commons.fileupload.servlet.ServletFileUpload; -import org.apache.commons.fileupload.util.Streams; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; import org.apache.struts2.dispatcher.LocalizedMessage; @@ -223,7 +218,7 @@ public class JakartaStreamMultiPartRequest extends AbstractMultiPartRequest { // Interface with Commons FileUpload API // Using the Streaming API - JakartaServletFileUpload servletFileUpload = new JakartaServletFileUpload(); + JakartaServletFileUpload<DiskFileItem, DiskFileItemFactory> servletFileUpload = new JakartaServletFileUpload<>(); if (maxSize != null) { servletFileUpload.setSizeMax(maxSize); } @@ -447,8 +442,6 @@ public class JakartaStreamMultiPartRequest extends AbstractMultiPartRequest { */ public static class FileInfo implements Serializable { - private static final long serialVersionUID = 1083158552766906037L; - private final File file; private final String contentType; private final String originalName; diff --git a/core/src/main/java/org/apache/struts2/dispatcher/multipart/MultiPartRequestWrapper.java b/core/src/main/java/org/apache/struts2/dispatcher/multipart/MultiPartRequestWrapper.java index c2871d423..c4f7b9dc6 100644 --- a/core/src/main/java/org/apache/struts2/dispatcher/multipart/MultiPartRequestWrapper.java +++ b/core/src/main/java/org/apache/struts2/dispatcher/multipart/MultiPartRequestWrapper.java @@ -55,9 +55,9 @@ public class MultiPartRequestWrapper extends StrutsRequestWrapper { protected static final Logger LOG = LogManager.getLogger(MultiPartRequestWrapper.class); - private Collection<LocalizedMessage> errors; - private MultiPartRequest multi; - private Locale defaultLocale = Locale.ENGLISH; + private final Collection<LocalizedMessage> errors; + private final MultiPartRequest multi; + private Locale defaultLocale; /** * Process file downloads and log any errors. @@ -84,7 +84,7 @@ public class MultiPartRequestWrapper extends StrutsRequestWrapper { } catch (IOException e) { LOG.warn(e.getMessage(), e); addError(buildErrorMessage(e, new Object[] {e.getMessage()})); - } + } } public MultiPartRequestWrapper(MultiPartRequest multiPartRequest, HttpServletRequest request, String saveDir, LocaleProvider provider) { @@ -185,12 +185,12 @@ public class MultiPartRequestWrapper extends StrutsRequestWrapper { /** * @see jakarta.servlet.http.HttpServletRequest#getParameterMap() */ - public Map getParameterMap() { + public Map<String, String[]> getParameterMap() { Map<String, String[]> map = new HashMap<>(); - Enumeration enumeration = getParameterNames(); + Enumeration<String> enumeration = getParameterNames(); while (enumeration.hasMoreElements()) { - String name = (String) enumeration.nextElement(); + String name = enumeration.nextElement(); map.put(name, this.getParameterValues(name)); } @@ -200,7 +200,7 @@ public class MultiPartRequestWrapper extends StrutsRequestWrapper { /** * @see jakarta.servlet.http.HttpServletRequest#getParameterNames() */ - public Enumeration getParameterNames() { + public Enumeration<String> getParameterNames() { if (multi == null) { return super.getParameterNames(); } else { @@ -251,8 +251,8 @@ public class MultiPartRequestWrapper extends StrutsRequestWrapper { * @param params2 the second enumeration. * @return a single Enumeration of all elements from both Enumerations. */ - protected Enumeration mergeParams(Enumeration params1, Enumeration params2) { - Vector temp = new Vector(); + protected Enumeration<String> mergeParams(Enumeration<String> params1, Enumeration<String> params2) { + Vector<String> temp = new Vector<>(); while (params1.hasMoreElements()) { temp.add(params1.nextElement()); diff --git a/core/src/main/java/org/apache/struts2/interceptor/ActionFileUploadInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/ActionFileUploadInterceptor.java index c42d125af..3cd0529ae 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/ActionFileUploadInterceptor.java +++ b/core/src/main/java/org/apache/struts2/interceptor/ActionFileUploadInterceptor.java @@ -21,13 +21,13 @@ package org.apache.struts2.interceptor; import com.opensymphony.xwork2.ActionInvocation; import com.opensymphony.xwork2.ActionProxy; import com.opensymphony.xwork2.interceptor.ValidationAware; +import jakarta.servlet.http.HttpServletRequest; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; import org.apache.struts2.action.UploadedFilesAware; import org.apache.struts2.dispatcher.multipart.MultiPartRequestWrapper; import org.apache.struts2.dispatcher.multipart.UploadedFile; -import javax.servlet.http.HttpServletRequest; import java.util.ArrayList; import java.util.Enumeration; import java.util.List; @@ -134,7 +134,7 @@ public class ActionFileUploadInterceptor extends AbstractFileUploadInterceptor { */ public String intercept(ActionInvocation invocation) throws Exception { HttpServletRequest request = invocation.getInvocationContext().getServletRequest(); - if (!(request instanceof MultiPartRequestWrapper)) { + if (!(request instanceof MultiPartRequestWrapper multiWrapper)) { if (LOG.isDebugEnabled()) { ActionProxy proxy = invocation.getProxy(); LOG.debug(getTextMessage(STRUTS_MESSAGES_BYPASS_REQUEST_KEY, new String[]{proxy.getNamespace(), proxy.getActionName()})); @@ -142,15 +142,12 @@ public class ActionFileUploadInterceptor extends AbstractFileUploadInterceptor { return invocation.invoke(); } - MultiPartRequestWrapper multiWrapper = (MultiPartRequestWrapper) request; - - if (!(invocation.getAction() instanceof UploadedFilesAware)) { + if (!(invocation.getAction() instanceof UploadedFilesAware action)) { LOG.debug("Action: {} doesn't implement: {}, ignoring file upload", invocation.getProxy().getActionName(), UploadedFilesAware.class.getSimpleName()); return invocation.invoke(); } - UploadedFilesAware action = (UploadedFilesAware) invocation.getAction(); applyValidation(action, multiWrapper); diff --git a/core/src/test/java/org/apache/struts2/interceptor/ActionFileUploadInterceptorTest.java b/core/src/test/java/org/apache/struts2/interceptor/ActionFileUploadInterceptorTest.java index 51747b147..408dedb7b 100644 --- a/core/src/test/java/org/apache/struts2/interceptor/ActionFileUploadInterceptorTest.java +++ b/core/src/test/java/org/apache/struts2/interceptor/ActionFileUploadInterceptorTest.java @@ -25,7 +25,9 @@ import com.opensymphony.xwork2.ValidationAwareSupport; import com.opensymphony.xwork2.mock.MockActionInvocation; import com.opensymphony.xwork2.mock.MockActionProxy; import com.opensymphony.xwork2.util.ClassLoaderUtil; -import org.apache.commons.fileupload.servlet.ServletFileUpload; +import jakarta.servlet.http.HttpServletRequest; +import org.apache.commons.fileupload2.jakarta.JakartaServletDiskFileUpload; +import org.apache.commons.fileupload2.jakarta.JakartaServletFileUpload; import org.apache.struts2.ServletActionContext; import org.apache.struts2.StrutsInternalTestCase; import org.apache.struts2.action.UploadedFilesAware; @@ -35,7 +37,6 @@ import org.apache.struts2.dispatcher.multipart.StrutsUploadedFile; import org.apache.struts2.dispatcher.multipart.UploadedFile; import org.springframework.mock.web.MockHttpServletRequest; -import javax.servlet.http.HttpServletRequest; import java.io.File; import java.net.URI; import java.net.URL; @@ -290,13 +291,14 @@ public class ActionFileUploadInterceptorTest extends StrutsInternalTestCase { req.addHeader("Content-type", "multipart/form-data; boundary=---1234"); // inspired by the unit tests for jakarta commons fileupload - String content = ("-----1234\r\n" + - "Content-Disposition: form-data; name=\"file\"; filename=\"deleteme.txt\"\r\n" + - "Content-Type: text/html\r\n" + - "\r\n" + - "Unit test of ActionFileUploadInterceptor" + - "\r\n" + - "-----1234--\r\n"); + String content = (""" + -----1234\r + Content-Disposition: form-data; name="file"; filename="deleteme.txt"\r + Content-Type: text/html\r + \r + Unit test of ActionFileUploadInterceptor\r + -----1234--\r + """); req.setContent(content.getBytes(StandardCharsets.US_ASCII)); MyFileUploadAction action = new MyFileUploadAction(); @@ -340,7 +342,7 @@ public class ActionFileUploadInterceptorTest extends StrutsInternalTestCase { endline; req.setContent(content.getBytes()); - assertTrue(ServletFileUpload.isMultipartContent(req)); + assertTrue(JakartaServletDiskFileUpload.isMultipartContent(req)); MyFileUploadAction action = new MyFileUploadAction(); container.inject(action); @@ -377,7 +379,7 @@ public class ActionFileUploadInterceptorTest extends StrutsInternalTestCase { endline; req.setContent(content.getBytes()); - assertTrue(ServletFileUpload.isMultipartContent(req)); + assertTrue(JakartaServletFileUpload.isMultipartContent(req)); MyFileUploadAction action = new MyFileUploadAction(); container.inject(action); @@ -402,13 +404,14 @@ public class ActionFileUploadInterceptorTest extends StrutsInternalTestCase { req.addHeader("Content-type", "multipart/form-data; boundary=---1234"); // inspired by the unit tests for jakarta commons fileupload - String content = ("-----1234\r\n" + - "Content-Disposition: form-data; name=\"file\"; filename=\"deleteme.txt\"\r\n" + - "Content-Type: text/html\r\n" + - "\r\n" + - "Unit test of ActionFileUploadInterceptor" + - "\r\n" + - "-----1234--\r\n"); + String content = (""" + -----1234\r + Content-Disposition: form-data; name="file"; filename="deleteme.txt"\r + Content-Type: text/html\r + \r + Unit test of ActionFileUploadInterceptor\r + -----1234--\r + """); req.setContent(content.getBytes(StandardCharsets.US_ASCII)); MyFileUploadAction action = container.inject(MyFileUploadAction.class); @@ -439,23 +442,22 @@ public class ActionFileUploadInterceptorTest extends StrutsInternalTestCase { req.addHeader("Content-type", "multipart/form-data; boundary=---1234"); // inspired by the unit tests for jakarta commons fileupload - String content = ("-----1234\r\n" + - "Content-Disposition: form-data; name=\"file\"; filename=\"deleteme.txt\"\r\n" + - "Content-Type: text/html\r\n" + - "\r\n" + - "Unit test of ActionFileUploadInterceptor" + - "\r\n" + - "-----1234\r\n" + - "Content-Disposition: form-data; name=\"normalFormField1\"\r\n" + - "\r\n" + - "it works" + - "\r\n" + - "-----1234\r\n" + - "Content-Disposition: form-data; name=\"normalFormField2\"\r\n" + - "\r\n" + - "long string should not work" + - "\r\n" + - "-----1234--\r\n"); + String content = (""" + -----1234\r + Content-Disposition: form-data; name="file"; filename="deleteme.txt"\r + Content-Type: text/html\r + \r + Unit test of ActionFileUploadInterceptor\r + -----1234\r + Content-Disposition: form-data; name="normalFormField1"\r + \r + it works\r + -----1234\r + Content-Disposition: form-data; name="normalFormField2"\r + \r + long string should not work\r + -----1234--\r + """); req.setContent(content.getBytes(StandardCharsets.US_ASCII)); MyFileUploadAction action = container.inject(MyFileUploadAction.class); @@ -486,13 +488,14 @@ public class ActionFileUploadInterceptorTest extends StrutsInternalTestCase { req.addHeader("Content-type", "multipart/form-data; boundary=---1234"); // inspired by the unit tests for jakarta commons fileupload - String content = ("-----1234\r\n" + - "Content-Disposition: form-data; name=\"file\"; filename=\"deleteme.txt\"\r\n" + - "Content-Type: text/html\r\n" + - "\r\n" + - "Unit test of ActionFileUploadInterceptor" + - "\r\n" + - "-----1234--\r\n"); + String content = (""" + -----1234\r + Content-Disposition: form-data; name="file"; filename="deleteme.txt"\r + Content-Type: text/html\r + \r + Unit test of ActionFileUploadInterceptor\r + -----1234--\r + """); req.setContent(content.getBytes(StandardCharsets.US_ASCII)); MyFileUploadAction action = container.inject(MyFileUploadAction.class);
