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 31a582eee5a85bf7d9f5634006cda1859cedc1ef
Author: Lukasz Lenart <[email protected]>
AuthorDate: Sat Dec 16 16:11:37 2023 +0100

    WW-5371 Migrates modern upload change to JakartaEE
---
 .../multipart/AbstractMultiPartRequest.java        |  2 +
 .../multipart/JakartaMultiPartRequest.java         | 57 +++++++++++++---------
 .../org/apache/struts2/struts-messages.properties  | 50 ++++++++++++++++---
 .../ActionFileUploadInterceptorTest.java           | 10 ++--
 .../interceptor/FileUploadInterceptorTest.java     | 10 ++--
 5 files changed, 94 insertions(+), 35 deletions(-)

diff --git 
a/core/src/main/java/org/apache/struts2/dispatcher/multipart/AbstractMultiPartRequest.java
 
b/core/src/main/java/org/apache/struts2/dispatcher/multipart/AbstractMultiPartRequest.java
index e46470ea2..256fea051 100644
--- 
a/core/src/main/java/org/apache/struts2/dispatcher/multipart/AbstractMultiPartRequest.java
+++ 
b/core/src/main/java/org/apache/struts2/dispatcher/multipart/AbstractMultiPartRequest.java
@@ -36,6 +36,8 @@ import java.util.Locale;
  */
 public abstract class AbstractMultiPartRequest implements MultiPartRequest {
 
+    protected static final String 
STRUTS_MESSAGES_UPLOAD_ERROR_PARAMETER_TOO_LONG_KEY = 
"struts.messages.upload.error.parameter.too.long";
+
     private static final Logger LOG = 
LogManager.getLogger(AbstractMultiPartRequest.class);
 
     /**
diff --git 
a/core/src/main/java/org/apache/struts2/dispatcher/multipart/JakartaMultiPartRequest.java
 
b/core/src/main/java/org/apache/struts2/dispatcher/multipart/JakartaMultiPartRequest.java
index 09c068471..ca5afd9dd 100644
--- 
a/core/src/main/java/org/apache/struts2/dispatcher/multipart/JakartaMultiPartRequest.java
+++ 
b/core/src/main/java/org/apache/struts2/dispatcher/multipart/JakartaMultiPartRequest.java
@@ -18,23 +18,12 @@
  */
 package org.apache.struts2.dispatcher.multipart;
 
-import java.io.File;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.UncheckedIOException;
-import java.nio.charset.Charset;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.Enumeration;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-
+import jakarta.servlet.http.HttpServletRequest;
 import org.apache.commons.fileupload2.core.DiskFileItem;
 import org.apache.commons.fileupload2.core.DiskFileItemFactory;
 import org.apache.commons.fileupload2.core.FileItem;
 import org.apache.commons.fileupload2.core.FileUploadByteCountLimitException;
+import org.apache.commons.fileupload2.core.FileUploadContentTypeException;
 import org.apache.commons.fileupload2.core.FileUploadException;
 import org.apache.commons.fileupload2.core.FileUploadFileCountLimitException;
 import org.apache.commons.fileupload2.core.FileUploadSizeException;
@@ -45,7 +34,18 @@ import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.apache.struts2.dispatcher.LocalizedMessage;
 
-import jakarta.servlet.http.HttpServletRequest;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.UncheckedIOException;
+import java.nio.charset.Charset;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Enumeration;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
 
 /**
  * Multipart form data request adapter for Jakarta Commons Fileupload package.
@@ -77,13 +77,24 @@ public class JakartaMultiPartRequest extends 
AbstractMultiPartRequest {
             LocalizedMessage errorMessage;
             if (e instanceof FileUploadByteCountLimitException) {
                 FileUploadByteCountLimitException ex = 
(FileUploadByteCountLimitException) e;
-                errorMessage = buildErrorMessage(e, new 
Object[]{ex.getFileName(), ex.getPermitted(), ex.getActualSize()});
+                errorMessage = buildErrorMessage(e, new Object[]{
+                        ex.getFieldName(), ex.getFileName(), 
ex.getPermitted(), ex.getActualSize()
+                });
             } else if (e instanceof FileUploadFileCountLimitException) {
                 FileUploadFileCountLimitException ex = 
(FileUploadFileCountLimitException) e;
-                errorMessage = buildErrorMessage(e, new 
Object[]{ex.getPermitted()});
+                errorMessage = buildErrorMessage(e, new Object[]{
+                        ex.getPermitted(), ex.getActualSize()
+                });
             } else if (e instanceof FileUploadSizeException) {
                 FileUploadSizeException ex = (FileUploadSizeException) e;
-                errorMessage = buildErrorMessage(e, new 
Object[]{ex.getPermitted(), ex.getActualSize()});
+                errorMessage = buildErrorMessage(e, new Object[]{
+                        ex.getPermitted(), ex.getActualSize()
+                });
+            } else if (e instanceof FileUploadContentTypeException) {
+                FileUploadContentTypeException ex = 
(FileUploadContentTypeException) e;
+                errorMessage = buildErrorMessage(e, new Object[]{
+                        ex.getContentType()
+                });
             } else {
                 errorMessage = buildErrorMessage(e, new Object[]{});
             }
@@ -149,8 +160,8 @@ public class JakartaMultiPartRequest extends 
AbstractMultiPartRequest {
             long size = item.getSize();
             if (size > maxStringLength) {
                 LOG.debug("Form field {} of size {} bytes exceeds limit of 
{}.", sanitizeNewlines(item.getFieldName()), size, maxStringLength);
-                String errorKey = 
"struts.messages.upload.error.parameter.too.long";
-                LocalizedMessage localizedMessage = new 
LocalizedMessage(this.getClass(), errorKey, null,
+                LocalizedMessage localizedMessage = new 
LocalizedMessage(this.getClass(),
+                        STRUTS_MESSAGES_UPLOAD_ERROR_PARAMETER_TOO_LONG_KEY, 
null,
                         new Object[]{item.getFieldName(), maxStringLength, 
size});
                 if (!errors.contains(localizedMessage)) {
                     errors.add(localizedMessage);
@@ -174,7 +185,7 @@ public class JakartaMultiPartRequest extends 
AbstractMultiPartRequest {
         DiskFileItemFactory fac = createDiskFileItemFactory(saveDir);
         JakartaServletFileUpload upload = createServletFileUpload(fac);
 
-        
+
         return upload.parseRequest(createRequestContext(servletRequest));
     }
 
@@ -252,9 +263,9 @@ public class JakartaMultiPartRequest extends 
AbstractMultiPartRequest {
                 }
             }
             UploadedFile uploadedFile = 
StrutsUploadedFile.Builder.create(storeLocation)
-                .withContentType(fileItem.getContentType())
-                .withOriginalName(fileItem.getName())
-                .build();
+                    .withContentType(fileItem.getContentType())
+                    .withOriginalName(fileItem.getName())
+                    .build();
             fileList.add(uploadedFile);
         }
 
diff --git 
a/core/src/main/resources/org/apache/struts2/struts-messages.properties 
b/core/src/main/resources/org/apache/struts2/struts-messages.properties
index d122d6393..beaa0927d 100644
--- a/core/src/main/resources/org/apache/struts2/struts-messages.properties
+++ b/core/src/main/resources/org/apache/struts2/struts-messages.properties
@@ -16,24 +16,62 @@
 # specific language governing permissions and limitations
 # under the License.
 #
+# WARNING! This file is the exact copy of struts-messages.properties!
+# See https://issues.apache.org/jira/browse/WW-4195 for more details!
+
 struts.messages.invalid.token=The form has already been processed or no token 
was supplied, please try again.
 struts.internal.invalid.token=Form token {0} does not match the session token 
{1}.
 
 struts.messages.bypass.request=Bypassing {0}/{1}
 struts.messages.current.file=File {0} {1} {2} {3}
+# 0 - input name
 struts.messages.invalid.file=Could not find a Filename for {0}. Verify that a 
valid file was submitted.
+# 0 - original filename
 struts.messages.invalid.content.type=Could not find a Content-Type for {0}. 
Verify that a valid file was submitted.
 struts.messages.removing.file=Removing file {0} {1}
 struts.messages.error.uploading=Error uploading: {0}
-struts.messages.error.file.too.large=File {0} is too large to be uploaded. 
Maximum allowed size is {4} bytes!
-struts.messages.upload.error.parameter.too.long=The request parameter "{0}" 
was too long.  Max length allowed is {1}, but found {2}!
+# 0 - input name
+# 1 - original filename
+# 2 - file name after uploading the file
+# 3 - size of the uploaded files
+# 4 - maximum allowed size
+struts.messages.error.file.too.large=The file is too large to be uploaded: {0} 
"{1}" "{2}" has size {3} and allowed mx size is {4}
+# 0 - field name
+# 1 - max string length
+# 2 - actual size
+struts.messages.upload.error.parameter.too.long=The request parameter "{0}" 
was too long. Max length allowed is {1}, but found {2}!
+# 0 - input name
+# 1 - original filename
+# 2 - file name after uploading the file
+# 3 - content type of the file
 struts.messages.error.content.type.not.allowed=Content-Type not allowed: {0} 
"{1}" "{2}" {3}
+# 0 - input name
+# 1 - original filename
+# 2 - file name after uploading the file
+# 3 - content type of the file
 struts.messages.error.file.extension.not.allowed=File extension not allowed: 
{0} "{1}" "{2}" {3}
-
 # dedicated messages used to handle various problems with file upload - check 
{@link JakartaMultiPartRequest#parse(HttpServletRequest, String)}
-struts.messages.upload.error.FileUploadSizeException=Request exceeded allowed 
size limit! Max size allowed is: {0}!
-struts.messages.upload.error.FileUploadFileCountLimitException=Request 
exceeded allowed number of files! Max allowed files number is: {0}!
-struts.messages.upload.error.FileUploadByteCountLimitException=File in request 
exceeded allowed file size limit! Max file size allowed is: {1}!
+# params depend on exception being handled
+# FileUploadByteCountLimitException
+# 0 - field name
+# 1 - file name
+# 2 - permitted
+# 3 - actual size
+struts.messages.upload.error.FileUploadByteCountLimitException=File {1} 
assigned to {0} exceeded allowed size limit! Max size allowed is: {2} but file 
was: {3}!
+
+# FileUploadFileCountLimitException
+# 0 - limit
+struts.messages.upload.error.FileUploadFileCountLimitException=Request 
exceeded allowed number of files! Permitted number of files is: {0}!
+
+# FileUploadSizeException
+# 1 - permitted size
+# 2 - actual size
+struts.messages.upload.error.FileUploadSizeException=Request exceeded allowed 
size limit! Max size allowed is: {0} but request was: {1}!
+
+# FileUploadContentTypeException
+# 0 - content type
+struts.messages.upload.error.FileUploadContentTypeException=Request has wrong 
content type: {0}!
+
 struts.messages.upload.error.FileUploadException=Error uploading: {0}!
 
 devmode.notification=Developer Notification (set struts.devMode to false to 
disable this message):\n{0}
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 408dedb7b..17de7a040 100644
--- 
a/core/src/test/java/org/apache/struts2/interceptor/ActionFileUploadInterceptorTest.java
+++ 
b/core/src/test/java/org/apache/struts2/interceptor/ActionFileUploadInterceptorTest.java
@@ -394,7 +394,10 @@ public class ActionFileUploadInterceptorTest extends 
StrutsInternalTestCase {
 
         assertNull(action.getUploadFiles());
         assertEquals(1, action.getActionErrors().size());
-        assertEquals("Request exceeded allowed number of files! Max allowed 
files number is: 3!", action.getActionErrors().iterator().next());
+        assertEquals(
+                "Request exceeded allowed number of files! Permitted number of 
files is: 3!",
+                action.getActionErrors().iterator().next()
+        );
     }
 
     public void testMultipartRequestMaxFileSize() throws Exception {
@@ -430,8 +433,9 @@ public class ActionFileUploadInterceptorTest extends 
StrutsInternalTestCase {
         Collection<String> errors = action.getActionErrors();
         assertEquals(1, errors.size());
         String msg = errors.iterator().next();
+        // FIXME: the expected size is 40 - length of the string
         assertEquals(
-            "File in request exceeded allowed file size limit! Max file size 
allowed is: 10 but file deleteme.txt was: 40!",
+            "File deleteme.txt assigned to file exceeded allowed size limit! 
Max size allowed is: 10 but file was: 10!",
             msg);
     }
 
@@ -477,7 +481,7 @@ public class ActionFileUploadInterceptorTest extends 
StrutsInternalTestCase {
         assertEquals(1, errors.size());
         String msg = errors.iterator().next();
         assertEquals(
-            "The request parameter \"normalFormField2\" was too long.  Max 
length allowed is 20, but found 27!",
+            "The request parameter \"normalFormField2\" was too long. Max 
length allowed is 20, but found 27!",
             msg);
     }
 
diff --git 
a/core/src/test/java/org/apache/struts2/interceptor/FileUploadInterceptorTest.java
 
b/core/src/test/java/org/apache/struts2/interceptor/FileUploadInterceptorTest.java
index d3d24ac78..cb40a4b7a 100644
--- 
a/core/src/test/java/org/apache/struts2/interceptor/FileUploadInterceptorTest.java
+++ 
b/core/src/test/java/org/apache/struts2/interceptor/FileUploadInterceptorTest.java
@@ -424,7 +424,10 @@ public class FileUploadInterceptorTest extends 
StrutsInternalTestCase {
         HttpParameters parameters = mai.getInvocationContext().getParameters();
         assertEquals(0, parameters.keySet().size());
         assertEquals(1, action.getActionErrors().size());
-        assertEquals("Request exceeded allowed number of files! Max allowed 
files number is: 3!", action.getActionErrors().iterator().next());
+        assertEquals(
+                "Request exceeded allowed number of files! Permitted number of 
files is: 3!",
+                action.getActionErrors().iterator().next()
+        );
     }
 
     public void testMultipartRequestMaxFileSize() throws Exception {
@@ -461,8 +464,9 @@ public class FileUploadInterceptorTest extends 
StrutsInternalTestCase {
         Collection<String> errors = action.getActionErrors();
         assertEquals(1, errors.size());
         String msg = errors.iterator().next();
+        // FIXME: the expected size is 40 - length of the string
         assertEquals(
-                "File in request exceeded allowed file size limit! Max file 
size allowed is: 10!",
+                "File deleteme.txt assigned to file exceeded allowed size 
limit! Max size allowed is: 10 but file was: 10!",
                 msg);
     }
 
@@ -511,7 +515,7 @@ public class FileUploadInterceptorTest extends 
StrutsInternalTestCase {
         assertEquals(1, errors.size());
         String msg = errors.iterator().next();
         assertEquals(
-                "The request parameter \"normalFormField2\" was too long.  Max 
length allowed is 20, but found 27!",
+                "The request parameter \"normalFormField2\" was too long. Max 
length allowed is 20, but found 27!",
                 msg);
     }
 

Reply via email to