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 <i>odd pathname</i>.

2 files changed, 189 insertions, 23 deletions

diff --git a/src/junit/com/jogamp/common/net/TestNetIOURIReservedCharsBug908.java b/src/junit/com/jogamp/common/net/TestNetIOURIReservedCharsBug908.java
new file mode 100644
index 0000000..904fca5
--- /dev/null
+++ b/src/junit/com/jogamp/common/net/TestNetIOURIReservedCharsBug908.java
@@ -0,0 +1,170 @@
+/**
+ * Copyright 2014 JogAmp Community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright notice, this list of
+ *       conditions and the following disclaimer.
+ *
+ *    2. Redistributions in binary form must reproduce the above copyright notice, this list
+ *       of conditions and the following disclaimer in the documentation and/or other materials
+ *       provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * The views and conclusions contained in the software and documentation are those of the
+ * authors and should not be interpreted as representing official policies, either expressed
+ * or implied, of JogAmp Community.
+ */
+
+package com.jogamp.common.net;
+
+import java.io.File;
+import java.io.IOException;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.net.URL;
+import java.net.URLClassLoader;
+
+import org.junit.Assert;
+import org.junit.FixMethodOrder;
+import org.junit.Test;
+import org.junit.runners.MethodSorters;
+
+import com.jogamp.common.os.AndroidVersion;
+import com.jogamp.common.os.Platform;
+import com.jogamp.common.util.IOUtil;
+import com.jogamp.common.util.JarUtil;
+import com.jogamp.common.util.ReflectionUtil;
+import com.jogamp.junit.util.JunitTracer;
+import com.jogamp.junit.util.MiscUtils;
+
+/**
+ * Bug 908: Automated test, launching GlueGen jar file from an <i>odd pathname</i>.
+ * <p>
+ * The currently used jar folder is copied into [1]
+ * <pre>
+ *    [1] build/test/build/TestNetIOURIReservedCharsBug908/test01TempJarCacheOddPath/A\$-B\^-C~-D#-E\]-F\[-öä
+ *    [2] build/test/build/TestNetIOURIReservedCharsBug908/test01TempJarCacheOddPath/A\$-B\^-C~-D#-E\]-F\[-öä/gluegen-rt.jar
+ * </pre>
+ * A ClassLoader w/ the URL [2] is used to issue Platform.initSingleton(),
+ * i.e. issues a whole initialization sequence w/ native jar loading in the new ClassPath.
+ * </p>
+ * <p>
+ * The manual test below on the created odd folder [1] has also succeeded:
+ * <pre>
+ * java \
+ *     -Djogamp.debug.IOUtil -Djogamp.debug.JNILibLoader -Djogamp.debug.TempFileCache \
+ *     -Djogamp.debug.JarUtil -Djogamp.debug.TempJarCache \
+ *     -cp ../build-x86_64/test/build/TestNetIOURIReservedCharsBug908/test01TempJarCacheOddPath/A\$-B\^-C~-D#-E\]-F\[-öä/gluegen-rt.jar \
+ *     com.jogamp.common.GlueGenVersion
+ * </pre>
+ * </p>
+ */
+@FixMethodOrder(MethodSorters.NAME_ASCENDING)
+public class TestNetIOURIReservedCharsBug908 extends JunitTracer {
+    static class TestClassLoader extends URLClassLoader {
+        public TestClassLoader(final URL[] urls) {
+            super(urls);
+        }
+        public TestClassLoader(final URL[] urls, final ClassLoader parent) {
+            super(urls, parent);
+        }
+    }
+
+
+    @Test
+    public void test00TempJarCacheSimplePath() throws IOException, IllegalArgumentException, URISyntaxException {
+        testTempJarCacheOddJarPathImpl("simpletons/", "simpletons/");
+    }
+
+    @Test
+    public void test01TempJarCacheOddPath() throws IOException, IllegalArgumentException, URISyntaxException {
+        // Bug 908, issues w/ windows file path char: $ ^ ~ # [ ]
+        testTempJarCacheOddJarPathImpl("A$-B^-C~-D#-E]-F[-öä/",
+                                    // "A$-B%5E-C~-D#-E]-F[-%C3%B6%C3%A4/");    <- Firefox URI encoding! '#' -> [1]
+                                    //   "A$-B%5E-C~-D%23-E]-F[-%C3%B6%C3%A4/"); <- '[' ']' -> [2]
+                                    "A$-B%5E-C~-D%23-E%5D-F%5B-%C3%B6%C3%A4/");
+        /**
+         * [1] '#'
+            java.lang.IllegalArgumentException: URI has a fragment component
+                   at java.io.File.<init>(Unknown Source)
+                   at com.jogamp.common.net.TestNetIOURIReservedCharsBug908.testTempJarCacheOddJarPathImpl(TestNetIOURIReservedCharsBug908.java:101)
+           [2] '[' ']'
+            java.net.URISyntaxException: Illegal character in path at index 137: file:/usr/local/projects/JOGL/gluegen/build-x86_64/test/build/TestNetIOURIReservedCharsBug908/test01TempJarCacheOddPath/A$-B%5E-C~-D%23-E]-F[-%C3%B6%C3%A4/
+                    at java.net.URI$Parser.fail(Unknown Source)
+                    at java.net.URI$Parser.checkChars(Unknown Source)
+                    at java.net.URI$Parser.parseHierarchical(Unknown Source)
+                    at java.net.URI$Parser.parse(Unknown Source)
+                    at java.net.URI.<init>(Unknown Source)
+                    at com.jogamp.common.net.TestNetIOURIReservedCharsBug908.testTempJarCacheOddJarPathImpl(TestNetIOURIReservedCharsBug908.java:106)
+
+         */
+
+    }
+    private void testTempJarCacheOddJarPathImpl(final String subPathUTF, final String subPathEncoded) throws IOException, IllegalArgumentException, URISyntaxException {
+        if(AndroidVersion.isAvailable) { System.err.println("n/a on Android"); return; }
+
+        final String reservedCharPathUnencoded = "test/build/"+getClass().getSimpleName()+"/"+getTestMethodName()+"/"+subPathUTF;
+        final String reservedCharPathEncoded = "test/build/"+getClass().getSimpleName()+"/"+getTestMethodName()+"/"+subPathEncoded;
+
+        System.err.println("0 Unencoded:             "+reservedCharPathUnencoded);
+        System.err.println("0 Encoded:               "+reservedCharPathEncoded);
+
+        // jar:file:/dir1/dir2/gluegen-rt.jar!/
+        final URI jarFileURI = JarUtil.getJarFileURI(Platform.class.getName(), getClass().getClassLoader());
+        System.err.println("1 jarFileURI:            "+jarFileURI.toString());
+        // gluegen-rt.jar
+        final String jarBasename = JarUtil.getJarBasename(jarFileURI);
+        System.err.println("2 jarBasename:           "+jarBasename);
+
+        // file:/dir1/build/gluegen-rt.jar
+        final URI fileURI = JarUtil.getJarSubURI(jarFileURI);
+        System.err.println("3 fileURI:               "+fileURI.toString());
+        // file:/dir1/build/
+        final URI fileFolderURI = new URI(IOUtil.getParentOf(fileURI.toString()));
+        System.err.println("4 fileFolderURI:         "+fileFolderURI.toString());
+        // file:/dir1/build/test/build/A$-B^-C~-D#-E]-F[/
+        final URI fileNewFolderURI = new URI(fileFolderURI.toString()+reservedCharPathEncoded);
+        System.err.println("5 fileNewFolderURI:      "+fileNewFolderURI.toString());
+
+        final File srcFolder = new File(fileFolderURI);
+        final File dstFolder = new File(fileNewFolderURI);
+        System.err.println("6 srcFolder:             "+srcFolder.toString());
+        System.err.println("7 dstFolder:             "+dstFolder.toString());
+        try {
+            final MiscUtils.CopyStats copyStats = MiscUtils.copy(srcFolder, dstFolder, 1, true);
+            copyStats.dump("Copy ", true);
+            Assert.assertEquals(1, copyStats.totalFolders);
+            Assert.assertTrue(copyStats.totalBytes > 0);
+            Assert.assertEquals(0, copyStats.currentDepth);
+
+            final URI jarFileNewFolderURI = new URI(fileNewFolderURI.toString()+jarBasename);
+            System.err.println("8 jarFileNewFolderURI:   "+jarFileNewFolderURI.toString());
+
+            final URL[] urls = new URL[] { jarFileNewFolderURI.toURL() };
+            System.err.println("url: "+urls[0]);
+
+            final ClassLoader cl = new TestClassLoader(urls, null);
+            ReflectionUtil.callStaticMethod(Platform.class.getName(), "initSingleton", null, null, cl);
+        } finally {
+            // cleanup ? Skip this for now ..
+            // dstFolder.delete();
+        }
+    }
+
+    public static void main(final String args[]) throws IOException {
+        final String tstname = TestNetIOURIReservedCharsBug908.class.getName();
+        org.junit.runner.JUnitCore.main(tstname);
+    }
+
+}
diff --git a/src/junit/com/jogamp/common/net/URIDumpUtil.java b/src/junit/com/jogamp/common/net/URIDumpUtil.java
index 8d94b6d..1a74742 100644
--- a/src/junit/com/jogamp/common/net/URIDumpUtil.java
+++ b/src/junit/com/jogamp/common/net/URIDumpUtil.java
@@ -7,14 +7,14 @@ import java.net.URL;
 
 public class URIDumpUtil {
     public static void showURX(final String urx) throws MalformedURLException, URISyntaxException {
-        System.err.println("XXXXXX "+urx);
+        System.err.println("WWWWWW "+urx);
         showURL(new URL(urx));
         showURI(new URI(urx));
-        System.err.println("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
+        System.err.println("WWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWW");
     }
 
     public static void showURL(final URL url) {
-        System.err.println("YYYYYY URL "+url);
+        System.err.println("XXXXXX URL "+url.toString());
         System.err.println("protocol: "+url.getProtocol());
         System.err.println("auth:     "+url.getAuthority());
         System.err.println("host:     "+url.getHost());
@@ -22,28 +22,24 @@ public class URIDumpUtil {
         System.err.println("file:     "+url.getFile() + " ( path " + url.getPath() + ", query " + url.getQuery() + " ) " );
         System.err.println("ref:      "+url.getRef());
     }
+
     public static void showURI(final URI uri) {
-        System.err.println("ZZZZZZ URI "+uri);
-        // 1 [scheme:]scheme-specific-part[#fragment]
-        System.err.println("1 scheme:      "+uri.getScheme());
-        System.err.println("1 scheme-part: "+uri.getRawSchemeSpecificPart());
-        System.err.println("1 fragment:    "+uri.getRawFragment());
+        showURI("YYYYYY URI "+uri+", isOpaque "+uri.isOpaque()+", isAbs "+uri.isAbsolute(), uri);
+    }
+    public static void showURI(final String message, final URI uri) {
+        System.err.println(message);
 
-        // 2 [scheme:][//authority][path][?query][#fragment]
-        System.err.println("2 scheme:      "+uri.getScheme());
-        System.err.println("2 auth:        "+uri.getRawAuthority());
-        System.err.println("2 path:        "+uri.getRawPath());
-        System.err.println("2 query:       "+uri.getRawQuery());
-        System.err.println("2 fragment:    "+uri.getRawFragment());
+        System.err.println("0.0.0 string:      "+uri.toString());
+        System.err.println("0.0.0 ascii :      "+uri.toASCIIString());
 
-        // 3 [scheme:][//authority][path][?query][#fragment]
-        //   authority: [user-info@]host[:port]
-        System.err.println("3 scheme:      "+uri.getScheme());
-        System.err.println("3 user-info:   "+uri.getRawUserInfo());
-        System.err.println("3 host:        "+uri.getHost());
-        System.err.println("3 port:        "+uri.getPort());
-        System.err.println("3 path:        "+uri.getRawPath());
-        System.err.println("3 query:       "+uri.getRawQuery());
-        System.err.println("3 fragment:    "+uri.getRawFragment());
+        System.err.println("1.0.0 scheme:      "+uri.getScheme());
+        System.err.println("2.0.0 scheme-part: "+uri.getRawSchemeSpecificPart()+" (raw), "+uri.getSchemeSpecificPart()+" (dec)");
+        System.err.println("2.1.0 auth:        "+uri.getRawAuthority()+" (raw), "+uri.getAuthority()+" (dec)");
+        System.err.println("2.1.1 user-info:   "+uri.getRawUserInfo()+" (raw), "+uri.getUserInfo()+" (dec)");
+        System.err.println("2.1.1 host:        "+uri.getHost());
+        System.err.println("2.1.1 port:        "+uri.getPort());
+        System.err.println("2.2.0 path:        "+uri.getRawPath()+" (raw), "+uri.getPath()+" (dec)");
+        System.err.println("2.3.0 query:       "+uri.getRawQuery()+" (raw), "+uri.getQuery()+" (dec)");
+        System.err.println("3.0.0 fragment:    "+uri.getRawFragment()+" (raw), "+uri.getFragment()+" (dec)");
     }
 }