Skip to content

WW-5461 Extends UploadedFile with inputName field #1041

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 6, 2024
Merged

WW-5461 Extends UploadedFile with inputName field #1041

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions apps/showcase/src/main/java/org/apache/struts2/showcase/fileupload/FileUploadAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ public class FileUploadAction extends ActionSupport implements UploadedFilesAwar
private String fileName;
private String caption;
private String originalName;
private String inputName;

public String input() throws Exception {
return SUCCESS;
Expand All @@ -58,6 +59,10 @@ public String getOriginalName() {
return originalName;
}

public String getInputName() {
return inputName;
}

public Object getUploadedFile() {
return uploadedFile.getContent();
}
Expand Down Expand Up @@ -85,5 +90,6 @@ public void withUploadedFiles(List<UploadedFile> uploadedFiles) {
this.fileName = uploadedFile.getName();
this.contentType = uploadedFile.getContentType();
this.originalName = uploadedFile.getOriginalName();
this.inputName = uploadedFile.getInputName();
}
}
45 changes: 23 additions & 22 deletions apps/showcase/src/main/webapp/WEB-INF/fileupload/upload-success.jsp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,51 +1,52 @@
<!--
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* regarding copyright ownership. The ASF 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
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
* 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
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
-->
<%@ page
language="java"
contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
language="java"
contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8" %>
<%@ taglib prefix="s" uri="/struts-tags" %>
<html>
<head>
<title>Struts2 Showcase - Fileupload sample</title>
<title>Struts2 Showcase - Fileupload sample</title>
</head>

<body>
<div class="page-header">
<h1>Fileupload sample</h1>
<h1>Fileupload sample</h1>
</div>

<div class="container-fluid">
<div class="row">
<div class="col-md-12">
<ul>
<li>ContentType: <s:property value="contentType" /></li>
<li>FileName: <s:property value="fileName" /></li>
<li>Original FileName: <s:property value="originalName" /></li>
<li>File: <s:property value="uploadedFile" /></li>
<li>Size: <s:property value="uploadSize" /></li>
<li>Caption: <s:property value="caption" /></li>
</ul>
</div>
</div>
<div class="row">
<div class="col-md-12">
<ul>
<li>ContentType: <s:property value="contentType"/></li>
<li>FileName: <s:property value="fileName"/></li>
<li>Original FileName: <s:property value="originalName"/></li>
<li>File: <s:property value="uploadedFile"/></li>
<li>Caption: <s:property value="caption"/></li>
<li>Size: <s:property value="uploadSize"/></li>
<li>Input name: <s:property value="inputName"/></li>
</ul>
</div>
</div>
</div>

</body>
Expand Down
3 changes: 2 additions & 1 deletion apps/showcase/src/test/java/it/org/apache/struts2/showcase/FileUploadTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ public void testSimpleFileUpload() throws Exception {
"ContentType: text/plain",
"Original FileName: " + tempFile.getName(),
"Caption: some caption",
"Size: 12"
"Size: 12",
"Input name: upload"
);
}
}
Expand Down
1 change: 1 addition & 0 deletions core/src/main/java/org/apache/struts2/dispatcher/multipart/JakartaMultiPartRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ protected void processFileField(DiskFileItem item) {
.create(item.getPath().toFile())
.withOriginalName(item.getName())
.withContentType(item.getContentType())
.withInputName(item.getFieldName())
.build();
values.add(uploadedFile);
}
Expand Down
1 change: 1 addition & 0 deletions .../src/main/java/org/apache/struts2/dispatcher/multipart/JakartaStreamMultiPartRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,7 @@ protected void createUploadedFile(FileItemInput fileItemInput, File file) {
.create(file)
.withOriginalName(fileName)
.withContentType(fileItemInput.getContentType())
.withInputName(fileItemInput.getFieldName())
.build();

if (uploadedFiles.containsKey(fieldName)) {
Expand Down
24 changes: 19 additions & 5 deletions core/src/main/java/org/apache/struts2/dispatcher/multipart/StrutsUploadedFile.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,13 @@ public class StrutsUploadedFile implements UploadedFile {
private final File file;
private final String contentType;
private final String originalName;
private final String inputName;

private StrutsUploadedFile(File file, String contentType, String originalName) {
private StrutsUploadedFile(File file, String contentType, String originalName, String inputName) {
this.file = file;
this.contentType = contentType;
this.originalName = originalName;
this.inputName = inputName;
}

@Override
Expand Down Expand Up @@ -72,18 +74,25 @@ public String getOriginalName() {
return originalName;
}

@Override
public String getInputName() {
return inputName;
}

@Override
public String toString() {
return "StrutsUploadedFile{" +
"contentType='" + contentType + '\'' +
", originalName='" + originalName + '\'' +
'}';
"contentType='" + contentType + '\'' +
", originalName='" + originalName + '\'' +
", inputName='" + inputName + '\'' +
'}';
}

public static class Builder {
private final File file;
private String contentType;
private String originalName;
private String inputName;

private Builder(File file) {
this.file = file;
Expand All @@ -103,8 +112,13 @@ public Builder withOriginalName(String originalName) {
return this;
}

public Builder withInputName(String inputName) {
this.inputName = inputName;
return this;
}

public UploadedFile build() {
return new StrutsUploadedFile(this.file, this.contentType, this.originalName);
return new StrutsUploadedFile(this.file, this.contentType, this.originalName, this.inputName);
}
}
}
9 changes: 9 additions & 0 deletions core/src/main/java/org/apache/struts2/dispatcher/multipart/UploadedFile.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,13 @@ public interface UploadedFile extends Serializable {
*/
String getContentType();

/**
* Represents a name of the input file, eg.:
* "myFile" in case of <input type="file" name="myFile">
*
* @return name of the input file field
* @since 6.7.0
*/
String getInputName();

}
16 changes: 16 additions & 0 deletions core/src/test/java/org/apache/struts2/dispatcher/multipart/AbstractMultiPartRequestTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,8 @@ public void uploadedFilesToDisk() throws IOException {
.isEqualTo("test1.csv");
assertThat(file.getContentType())
.isEqualTo("text/csv");
assertThat(file.getInputName())
.isEqualTo("file1");
assertThat(file.getContent()).asInstanceOf(InstanceOfAssertFactories.FILE)
.exists()
.content()
Expand All @@ -114,6 +116,8 @@ public void uploadedFilesToDisk() throws IOException {
.isEqualTo("test2.csv");
assertThat(file.getContentType())
.isEqualTo("text/csv");
assertThat(file.getInputName())
.isEqualTo("file2");
assertThat(file.getContent())
.asInstanceOf(InstanceOfAssertFactories.FILE)
.exists()
Expand Down Expand Up @@ -152,6 +156,8 @@ public void uploadedMultipleFilesToDisk() throws IOException {
.isEqualTo("test1.csv");
assertThat(file.getContentType())
.isEqualTo("text/csv");
assertThat(file.getInputName())
.isEqualTo("file1");
assertThat(file.getContent()).asInstanceOf(InstanceOfAssertFactories.FILE)
.exists()
.content()
Expand All @@ -164,6 +170,8 @@ public void uploadedMultipleFilesToDisk() throws IOException {
.isEqualTo("test2.csv");
assertThat(file.getContentType())
.isEqualTo("text/csv");
assertThat(file.getInputName())
.isEqualTo("file1");
assertThat(file.getContent())
.asInstanceOf(InstanceOfAssertFactories.FILE)
.exists()
Expand Down Expand Up @@ -202,6 +210,8 @@ public void uploadedFilesWithLargeBuffer() throws IOException {
.isEqualTo("test1.csv");
assertThat(file.getContentType())
.isEqualTo("text/csv");
assertThat(file.getInputName())
.isEqualTo("file1");
assertThat(file.getContent())
.asInstanceOf(InstanceOfAssertFactories.FILE)
.exists()
Expand All @@ -213,6 +223,8 @@ public void uploadedFilesWithLargeBuffer() throws IOException {
.isTrue();
assertThat(file.getOriginalName())
.isEqualTo("test2.csv");
assertThat(file.getInputName())
.isEqualTo("file2");
assertThat(file.getContent())
.asInstanceOf(InstanceOfAssertFactories.FILE)
.exists()
Expand Down Expand Up @@ -249,6 +261,8 @@ public void cleanUp() throws IOException {
.isEqualTo("test1.csv");
assertThat(file.getContentType())
.isEqualTo("text/csv");
assertThat(file.getInputName())
.isEqualTo("file1");
assertThat(file.getContent()).asInstanceOf(InstanceOfAssertFactories.FILE)
.exists()
.content()
Expand All @@ -261,6 +275,8 @@ public void cleanUp() throws IOException {
.isEqualTo("test2.csv");
assertThat(file.getContentType())
.isEqualTo("text/csv");
assertThat(file.getInputName())
.isEqualTo("file2");
assertThat(file.getContent())
.asInstanceOf(InstanceOfAssertFactories.FILE)
.exists()
Expand Down
5 changes: 5 additions & 0 deletions core/src/test/java/org/apache/struts2/interceptor/ActionFileUploadInterceptorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,11 @@ public String getOriginalName() {
public String getContentType() {
return null;
}

@Override
public String getInputName() {
return null;
}
};

private MockHttpServletRequest request;
Expand Down
Loading