Skip to content
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

Jump to bottom

Add support RFC 5987 for attribute filename* in HTTP header Content-Disposition #4647

Merged
merged 8 commits into from
Jan 14, 2021
Merged

Add support RFC 5987 for attribute filename* in HTTP header Content-Disposition #4647

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4522d94
Add support RFC 5987 for attribute filename* in HTTP header Content-D…
aserkes Nov 29, 2020
9c1437b
Update year in Copyright comments
aserkes Nov 30, 2020
3089053
Fix problem with capital letters, add more filename patterns for tests
aserkes Dec 5, 2020
109e685
code refactoring
aserkes Dec 7, 2020
b8fac12
Encode a filename parameter if it is not encoded, throw an exception …
aserkes Jan 4, 2021
7d4d5d5
All charsets for the filename* parameter are permitted
aserkes Jan 7, 2021
b523c01
Refactoring
aserkes Jan 8, 2021
10ca154
Update year in Copyright comments
aserkes Jan 13, 2021
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
11 changes: 10 additions & 1 deletion media/multipart/src/main/java/org/glassfish/jersey/media/multipart/ContentDisposition.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2010, 2019 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2010, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
Expand All @@ -20,6 +20,7 @@
import java.util.Collections;
import java.util.Date;
import java.util.Map;
import java.util.regex.Pattern;

import org.glassfish.jersey.message.internal.HttpDateFormat;
import org.glassfish.jersey.message.internal.HttpHeaderReader;
Expand All @@ -40,6 +41,9 @@ public class ContentDisposition {
private Date modificationDate;
private Date readDate;
private long size;
private static final Pattern FILENAME_EXT_VALUE_PATTERN =
Pattern.compile("(UTF-8|ISO-8859-1)'([a-z]{2,8}(-[a-z0-9]+)?)?'(%[a-f0-9]{2}|[a-z0-9!#$&+.^_`|~-])+",
Pattern.CASE_INSENSITIVE);

protected ContentDisposition(final String type, final String fileName, final Date creationDate,
final Date modificationDate, final Date readDate, final long size) {
Expand Down Expand Up @@ -183,6 +187,11 @@ protected void addLongParameter(final StringBuilder sb, final String name, final
private void createParameters() throws ParseException {
fileName = parameters.get("filename");

String fileNameExt = parameters.get("filename*");
if (fileNameExt != null && FILENAME_EXT_VALUE_PATTERN.matcher(fileNameExt).matches()) {
fileName = fileNameExt;
}

creationDate = createDate("creation-date");

modificationDate = createDate("modification-date");
Expand Down
132 changes: 131 additions & 1 deletion tests/e2e/src/test/java/org/glassfish/jersey/tests/api/ContentDispositionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2014, 2018 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2014, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
Expand Down Expand Up @@ -97,6 +97,136 @@ public void testToString() {
assertEquals(header, contentDisposition.toString());
}

@Test
public void testFileNameExt() {
final Date date = new Date();
final String dateString = HttpDateFormat.getPreferredDateFormat().format(date);
final String fileName = "test.file";

try {
//correct fileNameExt
String fileNameExt = "testExt.file";
final String prefixHeader = contentDispositionType + ";filename=\"" + fileName + "\";"
+ "creation-date=\"" + dateString + "\";modification-date=\"" + dateString + "\";read-date=\""
+ dateString + "\";size=1222" + ";name=\"testData\";" + "filename*=\"";
String header = prefixHeader + fileNameExt + "\"";
ContentDisposition contentDisposition =
new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileName, contentDisposition.getFileName());

//correct fileNameExt
fileNameExt = "ISO-8859-1'language-us'abc%a1abc%a2%b1!#$&+.^_`|~-";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileNameExt, contentDisposition.getFileName());

//correct fileNameExt
fileNameExt = "UTF-8'us'fileName.txt";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileNameExt, contentDisposition.getFileName());

//incorrect fileNameExt
fileNameExt = "utf-8'languageTooLong'fileName.txt";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileName, contentDisposition.getFileName());

//correct fileNameExt
fileNameExt = "utf-8''a";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileNameExt, contentDisposition.getFileName());

//incorrect fileNameExt
fileNameExt = "utf-8'lang-'a";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileName, contentDisposition.getFileName());

//correct fileNameExt
fileNameExt = "ISO-8859-1'language-us'a";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileNameExt, contentDisposition.getFileName());

//correct fileNameExt
fileNameExt = "ISO-8859-1'language-us'a%a1";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileNameExt, contentDisposition.getFileName());

//incorrect fileNameExt
fileNameExt = "ISO-8859-1'language-us'a%z1";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileName, contentDisposition.getFileName());

//correct fileNameExt
fileNameExt = "ISO-8859-1'language-us'abc%a1abc%a2%b1";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileNameExt, contentDisposition.getFileName());

//incorrect fileNameExt
fileNameExt = "ISO-8859-1'language-us'a%";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileName, contentDisposition.getFileName());

//correct fileNameExt
fileNameExt = "ISO-8859-1'language-us'abc%a1abc%a2%b1!#$&+.^_`|~-";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileNameExt, contentDisposition.getFileName());

//correct fileNameExt
fileNameExt = "ISO-8859-1'language-us'abc%a1abc%a2%b1!#$&+.^_`|~-";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileNameExt, contentDisposition.getFileName());

//correct fileNameExt
fileNameExt = "iso-8859-1'language-us'abc.TXT";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileNameExt, contentDisposition.getFileName());

//incorrect fileNameExt
fileNameExt = "ISO-8859-1'language-us'";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileName, contentDisposition.getFileName());

//incorrect fileNameExt
fileNameExt = "ISO-8859-1'language-us'c:\\file.txt";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileName, contentDisposition.getFileName());

//incorrect fileNameExt
fileNameExt = "ISO-8859-1'language-us'home/file.txt";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileName, contentDisposition.getFileName());

//incorrect fileNameExt
fileNameExt = "ISO-8859-1'language-us'李.txt";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileName, contentDisposition.getFileName());

//correct fileNameExt
fileNameExt = "ISO-8859-1'language-us'FILEname.tXt";
header = prefixHeader + fileNameExt + "\"";
contentDisposition = new ContentDisposition(HttpHeaderReader.newInstance(header), true);
assertEquals(fileNameExt, contentDisposition.getFileName());
senivam marked this conversation as resolved.
Show resolved Hide resolved

} catch (ParseException ex) {
fail(ex.getMessage());
}
}

protected void assertContentDisposition(final ContentDisposition contentDisposition, Date date) {
assertNotNull(contentDisposition);
assertEquals(contentDispositionType, contentDisposition.getType());
Expand Down