From 0b07f9107c5b033913f5c4cbeb906ae6dafc2d77 Mon Sep 17 00:00:00 2001 From: Sven Gothel Date: Sun, 7 Sep 2014 07:58:39 +0200 Subject: Bug 908: Fix URI/URL double encoding, ensuring encoded/decoded variants are used properly (Added unit test) Bug 908 was caused by confusing URI encoded parts (e.g. scheme-specific-part) and it's decoded variant. This especially happened due to: - the fact, that the encoded and unencoded variant uses the same String type, - the URI/URL decoding differs, is not complete (e.g. %20 .. SPACE remains in decoded part), - and does not comply w/ RFC 2396 and RFC 3986 (encoding), e.g. not all RESERVED chars are encoded. In branch 'v2.3.0_branch', we will introduce our own Uri and Uri.Encoded class to solve above issue by replacing all URI usage w/ Uri. - Backporting results of own Uri class introduction in branch 'v2.3.0_branch' - Ensure the encoded URI parts are used where required, i.e. IOUtil.compose(..) etc - TestNetIOURIReservedCharsBug908: Automated test, launching GlueGen jar file from an odd pathname. --- src/java/com/jogamp/common/util/IOUtil.java | 211 +++++++-------------------- src/java/com/jogamp/common/util/JarUtil.java | 44 +++--- 2 files changed, 78 insertions(+), 177 deletions(-) (limited to 'src/java/com/jogamp/common/util') diff --git a/src/java/com/jogamp/common/util/IOUtil.java b/src/java/com/jogamp/common/util/IOUtil.java index c6548e4..5819fbc 100644 --- a/src/java/com/jogamp/common/util/IOUtil.java +++ b/src/java/com/jogamp/common/util/IOUtil.java @@ -204,7 +204,6 @@ public class IOUtil { * Copy the specified input stream to a byte array, which is being returned. */ public static byte[] copyStream2ByteArray(InputStream stream) throws IOException { - // FIXME: Shall enforce a BufferedInputStream ? if( !(stream instanceof BufferedInputStream) ) { stream = new BufferedInputStream(stream); } @@ -495,149 +494,17 @@ public class IOUtil { } /** - * Converts an {@link URI} to an {@link URL} while using a non encoded path. - *

- * A file scheme path, i.e. path following file:, is converted as follows:
- *
- File file = new File( {@link #decodeFromURI(String) decodeFromURI}( specificURI.getPath() ) );
- String uriFilePath = {@link #encodeFilePathToURI(String) encodeFilePathToURI}( file.getPath() );
- *
- * above conversion results in a decoded file path appropriate to be used by subsequent file i/o operations (JarFile, zip, ..). - *

- *

- * Otherwise the default {@link URL} translation {@link URI#toURL()} is being used. - *

- *

- * The following cases are considered: - *

- *

- *

- * Note that a given {@link URI#getAuthority() authority} for file schemes is preserved to support window's shares. - *

- *

- * Tested w/ unit test com.jogamp.common.util.TestIOUtilURIHandling - *

+ * Simply returns {@link URI#toURL()}. * @param uri * @return * @throws IOException * @throws IllegalArgumentException * @throws URISyntaxException + * + * @deprecated Useless */ public static URL toURL(final URI uri) throws IOException, IllegalArgumentException, URISyntaxException { - URL url = null; - final String uriSchema = uri.getScheme(); - final boolean isJar = IOUtil.JAR_SCHEME.equals(uriSchema); - final URI specificURI = isJar ? JarUtil.getJarSubURI(uri) : uri; - final boolean hasJarSubURI = specificURI != uri; - final String authorityS; - { - final String authority = specificURI.getAuthority(); - authorityS = ( null == authority ) ? "" : "//"+authority; - } - - if( DEBUG ) { - System.err.println("IOUtil.toURL.0: isJAR "+isJar+", hasSubURI "+hasJarSubURI+PlatformPropsImpl.NEWLINE+ - "\t, uri "+uri+PlatformPropsImpl.NEWLINE+ - "\t str -> "+specificURI.toString()+PlatformPropsImpl.NEWLINE+ - "\t ascii -> "+specificURI.toASCIIString()+PlatformPropsImpl.NEWLINE+ - "\t ssp -> "+specificURI.getSchemeSpecificPart()+PlatformPropsImpl.NEWLINE+ - "\t frag -> "+specificURI.getFragment()+PlatformPropsImpl.NEWLINE+ - "\t auth -> "+authorityS+PlatformPropsImpl.NEWLINE+ /* "//user-info@host:port" */ - "\t path -> "+specificURI.getPath()+PlatformPropsImpl.NEWLINE+ - "\t path.decoded -> "+decodeFromURI( specificURI.getPath() ) ); - } - int mode = 0; - if( IOUtil.FILE_SCHEME.equals( specificURI.getScheme() ) ) { - File f; - try { - f = new File( decodeFromURI( specificURI.getPath() ) ); // validates uri, uses decoded uri.getPath() and normalizes it - } catch(final Exception iae) { - if( DEBUG ) { - System.err.println("Caught "+iae.getClass().getSimpleName()+": new File("+decodeFromURI( specificURI.getPath() )+") failed: "+iae.getMessage()); - iae.printStackTrace(); - } - f = null; - } - if( null != f ) { - String urlS = null; - try { - final String fPath = f.getPath(); - final String fPathUriS = encodeFilePathToURI(fPath); - /** - * Below 'url = f.toURI().toURL()' Doesn't work, since it uses encoded path, - * but we need the decoded path due to subsequent file access. - * URI: jar:file:/C:/gluegen/build-x86_64%20%c3%b6%c3%a4%20lala/gluegen-rt.jar!/ - * File: file:/C:/gluegen/build-x86_64%20öä%20lala/gluegen-rt.jar - * URI: fUri file:/C:/gluegen/build-x86_64%20öä%20lala/gluegen-rt.jar - * URL: fUrl file:/C:/gluegen/build-x86_64%20öä%20lala/gluegen-rt.jar - * - * Goal: file:/C:/gluegen/build-x86_64 öä lala/gluegen-rt.jar!/ - */ - if(DEBUG) { - try { - final URI fUri = f.toURI(); - final URL fUrl = fUri.toURL(); - System.err.println("IOUtil.toURL.1b: fUri "+fUri+PlatformPropsImpl.NEWLINE+ - "\t, fUrl "+fUrl); - } catch (final Exception ee) { - System.err.println("Caught "+ee.getClass().getSimpleName()+": f.toURI().toURL() failed: "+ee.getMessage()); - ee.printStackTrace(); - } - } - if( !hasJarSubURI ) { - urlS = IOUtil.FILE_SCHEME+IOUtil.SCHEME_SEPARATOR+authorityS+fPathUriS; - if( DEBUG ) { - System.err.println("IOUtil.toURL.1: authorityS "+authorityS+", fPath "+fPath+PlatformPropsImpl.NEWLINE+ - "\t -> "+fPathUriS+PlatformPropsImpl.NEWLINE+ - "\t -> "+urlS); - } - url = new URL(urlS); - mode = 1; - } else { - final String jarEntry = JarUtil.getJarEntry(uri); - final String post = isJar ? IOUtil.JAR_SCHEME_SEPARATOR + jarEntry : ""; - urlS = uriSchema+IOUtil.SCHEME_SEPARATOR+IOUtil.FILE_SCHEME+IOUtil.SCHEME_SEPARATOR+authorityS+fPathUriS+post; - if( DEBUG ) { - System.err.println("IOUtil.toURL.2: authorityS "+authorityS+", fPath "+fPath+PlatformPropsImpl.NEWLINE+ - "\t -> "+fPathUriS+PlatformPropsImpl.NEWLINE+ - "\t, jarEntry "+jarEntry+PlatformPropsImpl.NEWLINE+ - "\t, post "+post+PlatformPropsImpl.NEWLINE+ - "\t -> "+urlS); - } - url = new URL(urlS); - mode = 2; - } - } catch (final Exception mue) { - if( DEBUG ) { - System.err.println("Caught "+mue.getClass().getSimpleName()+": new URL("+urlS+") failed: "+mue.getMessage()); - mue.printStackTrace(); - } - } - } - } - if( null == url ) { - try { - url = uri.toURL(); - mode = 3; - } catch (final Exception e) { - if( DEBUG ) { - System.err.println("Caught "+e.getClass().getSimpleName()+": "+uri+".toURL() failed: "+e.getMessage()); - e.printStackTrace(); - } - } - } - if( DEBUG ) { - System.err.println("IOUtil.toURL.X: mode "+mode+", "+uri+PlatformPropsImpl.NEWLINE+ - "\t -> "+url); - } - return url; + return uri.toURL(); } /*** @@ -849,15 +716,16 @@ public class IOUtil { *

* * @param baseURI denotes a URI to a directory ending w/ '/', or a file. In the latter case the file's directory is being used. - * @param relativePath denotes a relative file to the baseLocation's parent directory + * @param relativePath denotes a relative file to the baseLocation's parent directory (URI encoded) * @throws URISyntaxException if path is empty or has no parent directory available while resolving ../ */ public static URI getRelativeOf(final URI baseURI, final String relativePath) throws URISyntaxException { - return compose(baseURI.getScheme(), baseURI.getSchemeSpecificPart(), relativePath, baseURI.getFragment()); + return compose(baseURI.getScheme(), baseURI.getRawSchemeSpecificPart(), relativePath, baseURI.getRawFragment()); } /** * Wraps {@link #getRelativeOf(URI, String)} for convenience. + * @param relativePath denotes a relative file to the baseLocation's parent directory (URI encoded) * @throws IOException */ public static URL getRelativeOf(final URL baseURL, final String relativePath) throws IOException { @@ -902,7 +770,19 @@ public class IOUtil { schemeSpecificPart = schemeSpecificPart + relativePath; } schemeSpecificPart = cleanPathString( schemeSpecificPart ); - return new URI(scheme, null == query ? schemeSpecificPart : schemeSpecificPart + "?" + query, fragment); + final StringBuilder uri = new StringBuilder(); + uri.append(scheme); + uri.append(':'); + uri.append(schemeSpecificPart); + if ( null != query ) { + uri.append('?'); + uri.append(query); + } + if ( null != fragment ) { + uri.append('#'); + uri.append(fragment); + } + return new URI(uri.toString()); } private static final Pattern patternSpaceRaw = Pattern.compile(" "); @@ -913,9 +793,10 @@ public class IOUtil { * + * @deprecated Useless */ - public static String encodeToURI(final String s) { - return patternSpaceRaw.matcher(s).replaceAll("%20"); + public static String encodeToURI(final String vanilla) { + return patternSpaceRaw.matcher(vanilla).replaceAll("%20"); // Uri TODO: Uri.encode(vanilla, Uri.PATH_MIN_LEGAL); } /** @@ -923,9 +804,10 @@ public class IOUtil { * + * @deprecated Use {@link #decodeURIIfFilePath(URI)} */ - public static String decodeFromURI(final String s) { - return patternSpaceEnc.matcher(s).replaceAll(" "); + public static String decodeFromURI(final String encodedUri) { + return patternSpaceEnc.matcher(encodedUri).replaceAll(" "); // Uri TODO: Uri.decode(encoded); } private static final Pattern patternSingleBS = Pattern.compile("\\\\{1}"); @@ -934,7 +816,7 @@ public class IOUtil { /** * Encodes file path characters not complying w/ RFC 2396 and the {@link URI#URI(String)} ctor. *

- * Implementation processes the filePath if {@link File#separatorChar} != '/' + * Implementation processes the filePath if {@link File#separatorChar} == '\\' * as follows: *