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.

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

8258246: sun.net.www.ParseUtil.decode throws java.lang.IllegalArgumentException: Error decoding percent encoded characters #23383

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ public void addFile(String s) {
private static URL toFileURL(String s) {
try {
File f = new File(s).getCanonicalFile();
return ParseUtil.fileToEncodedURL(f);
return f.toPath().toUri().toURL();
} catch (IOException e) {
return null;
}
Expand Down
16 changes: 0 additions & 16 deletions src/java.base/share/classes/sun/net/www/ParseUtil.java
Original file line number Diff line number Diff line change
Expand Up @@ -229,22 +229,6 @@ public static String decode(String s) {
return sb.toString();
}

public static URL fileToEncodedURL(File file)
throws MalformedURLException
{
String path = file.getAbsolutePath();
path = ParseUtil.encodePath(path);
if (!path.startsWith("/")) {
path = "/" + path;
}
if (!path.endsWith("/") && file.isDirectory()) {
path = path + "/";
}
@SuppressWarnings("deprecation")
var result = new URL("file", "", path);
return result;
}

public static java.net.URI toURI(URL url) {
String protocol = url.getProtocol();
String auth = url.getAuthority();
Expand Down
197 changes: 197 additions & 0 deletions test/jdk/jdk/internal/loader/URLClassPath/ClassPathUnicodeChars.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,197 @@
/*
* Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/

import java.io.OutputStream;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.Enumeration;
import java.util.jar.JarEntry;
import java.util.jar.JarOutputStream;
import java.util.jar.Manifest;

import jdk.internal.loader.Resource;
import jdk.internal.loader.URLClassPath;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import static java.nio.charset.StandardCharsets.US_ASCII;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assumptions.abort;

/*
* @test
* @bug 8258246
* @summary verify that when locating resources, the URLClassPath can function properly
* when classpath elements contain Unicode characters with two, three or four
* byte UTF-8 encodings
* @modules java.base/jdk.internal.loader
* @run junit ClassPathUnicodeChars
*/
public class ClassPathUnicodeChars {

private static final Path SCRATCH_DIR = Path.of(".").normalize();
private static final String RESOURCE_NAME = "foo.txt";
private static final String TWO_BYTE_CHAR = "\u00C4";
private static final String THREE_BYTE_CHAR = "\u20AC";
private static final String FOUR_BYTE_CHAR = "\uD83D\uDE00";

private static Path TWO_BYTE_CHAR_DIR;
private static Path THREE_BYTE_CHAR_DIR;
private static Path FOUR_BYTE_CHAR_DIR;
private static Path JAR_FILE_IN_TWO_BYTE_CHAR_DIR;
private static Path JAR_FILE_IN_THREE_BYTE_CHAR_DIR;
private static Path JAR_FILE_IN_FOUR_BYTE_CHAR_DIR;
private static int NUM_EXPECTED_LOCATED_RESOURCES;

@BeforeAll
static void beforeAll() throws Exception {
try {
TWO_BYTE_CHAR_DIR = Files.createTempDirectory(SCRATCH_DIR, TWO_BYTE_CHAR);
THREE_BYTE_CHAR_DIR = Files.createTempDirectory(SCRATCH_DIR, THREE_BYTE_CHAR);
FOUR_BYTE_CHAR_DIR = Files.createTempDirectory(SCRATCH_DIR, FOUR_BYTE_CHAR);
} catch (IllegalArgumentException iae) {
iae.printStackTrace(); // for debug purpose
// if we can't create a directory with these characters in their
// path name then skip the entire test
abort("Skipping test since directory couldn't be created: " + iae);
}
// successful creation of the dir, continue with the test
Files.createFile(TWO_BYTE_CHAR_DIR.resolve(RESOURCE_NAME));
Files.createFile(THREE_BYTE_CHAR_DIR.resolve(RESOURCE_NAME));
Files.createFile(FOUR_BYTE_CHAR_DIR.resolve(RESOURCE_NAME));

// create jar files containing the resource
JAR_FILE_IN_TWO_BYTE_CHAR_DIR = Files.createTempDirectory(SCRATCH_DIR, TWO_BYTE_CHAR)
.resolve("foo.jar");
JAR_FILE_IN_THREE_BYTE_CHAR_DIR = Files.createTempDirectory(SCRATCH_DIR, THREE_BYTE_CHAR)
.resolve("foo.jar");
JAR_FILE_IN_FOUR_BYTE_CHAR_DIR = Files.createTempDirectory(SCRATCH_DIR, FOUR_BYTE_CHAR)
.resolve("foo.jar");
for (Path jarFile : Arrays.asList(
JAR_FILE_IN_TWO_BYTE_CHAR_DIR,
JAR_FILE_IN_THREE_BYTE_CHAR_DIR,
JAR_FILE_IN_FOUR_BYTE_CHAR_DIR)) {
final Manifest manifest = new Manifest();
manifest.getMainAttributes().putValue("Manifest-Version", "1.0");
try (OutputStream fos = Files.newOutputStream(jarFile);
JarOutputStream jos = new JarOutputStream(fos, manifest)) {

final JarEntry jarEntry = new JarEntry(RESOURCE_NAME);
jos.putNextEntry(jarEntry);
jos.write("hello".getBytes(US_ASCII));
jos.closeEntry();
}
}
// We expect to find the resource in all classpath elements.
NUM_EXPECTED_LOCATED_RESOURCES = 6;
}

/**
* Constructs a URLClassPath and then exercises the URLClassPath.findResource()
* and URLClassPath.findResources() methods and expects them to return the
* expected
* resources.
*/
@Test
void testFindResource() {
// start an empty URL classpath
final URLClassPath urlc = new URLClassPath(new URL[0]);
final String[] classpathElements = getClassPathElements();
try {
// use addFile() to construct classpath
for (final String path : classpathElements) {
urlc.addFile(path);
}
// findResource()
assertNotNull(urlc.findResource(RESOURCE_NAME), "findResource() failed to locate"
+ " resource: " + RESOURCE_NAME + " in classpath: "
+ Arrays.toString(classpathElements));
// findResources()
final Enumeration<URL> locatedResources = urlc.findResources(RESOURCE_NAME);
assertNotNull(locatedResources, "findResources() failed to"
+ " locate resource: " + RESOURCE_NAME + " in classpath: "
+ Arrays.toString(classpathElements));
int numFound = 0;
while (locatedResources.hasMoreElements()) {
System.out.println("located " + locatedResources.nextElement()
+ " for resource " + RESOURCE_NAME);
numFound++;
}
assertEquals(NUM_EXPECTED_LOCATED_RESOURCES, numFound,
"unexpected number of resources located for " + RESOURCE_NAME);
} finally {
urlc.closeLoaders();
}
}

/**
* Constructs a URLClassPath and then exercises the URLClassPath.getResource()
* and URLClassPath.getResources() methods and expects them to return the
* expected
* resources.
*/
@Test
void testGetResource() {
// start an empty URL classpath
final URLClassPath urlc = new URLClassPath(new URL[0]);
final String[] classpathElements = getClassPathElements();
try {
// use addFile() to construct classpath
for (final String path : classpathElements) {
urlc.addFile(path);
}
// getResource()
assertNotNull(urlc.getResource(RESOURCE_NAME), "getResource() failed to locate"
+ " resource: " + RESOURCE_NAME + " in classpath: "
+ Arrays.toString(classpathElements));
// getResources()
final Enumeration<Resource> locatedResources = urlc.getResources(RESOURCE_NAME);
assertNotNull(locatedResources, "getResources() failed to"
+ " locate resource: " + RESOURCE_NAME + " in classpath: "
+ Arrays.toString(classpathElements));
int numFound = 0;
while (locatedResources.hasMoreElements()) {
System.out.println("located " + locatedResources.nextElement().getURL()
+ " for resource " + RESOURCE_NAME);
numFound++;
}
assertEquals(NUM_EXPECTED_LOCATED_RESOURCES, numFound,
"unexpected number of resources located for " + RESOURCE_NAME);
} finally {
urlc.closeLoaders();
}
}

private static String[] getClassPathElements() {
return new String[] {
TWO_BYTE_CHAR_DIR.toString(),
THREE_BYTE_CHAR_DIR.toString(),
FOUR_BYTE_CHAR_DIR.toString(),
JAR_FILE_IN_TWO_BYTE_CHAR_DIR.toString(),
JAR_FILE_IN_THREE_BYTE_CHAR_DIR.toString(),
JAR_FILE_IN_FOUR_BYTE_CHAR_DIR.toString()
};
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,9 @@ static void beforeAll() throws Exception {
jos.write("hello".getBytes(US_ASCII));
jos.closeEntry();
}
// Even if the resource is present in more than one classpath element,
// we expect it to be found by the URLClassPath only in the path which has just ascii
// characters. URLClassPath currently doesn't have the ability to serve resources
// from paths containing emoji character(s).
NUM_EXPECTED_LOCATED_RESOURCES = 1;
// We expect to find the resource in all but the first (non-existent)
// classpath element.
NUM_EXPECTED_LOCATED_RESOURCES = 3;
}

/**
Expand Down Expand Up @@ -171,9 +169,9 @@ void testGetResource() {
}

private static String[] getClassPathElements() {
// Maintain the order - in context of this test, paths with emojis
// or those which can't serve the resource should come before the
// path that can serve the resource.
// Maintain the order - in context of this test, the path that can't
// serve the resource should come before the paths that can serve the
// resource.
return new String[]{
// non-existent path
ASCII_DIR.resolve("non-existent").toString(),
Expand Down