Fix RH669942: Add support for packEnabled and versionEnabled

This changeset adds support for explicitly using jars with pack200 compression
and versioning. This requires no server side support, but expects the client
to try and find the right jar and fallback to using uncompressed/unversioned
jars if the versioned/compressed ones can not be found.

2011-02-10  Omair Majid  <[email protected]>

    Fix RH669942; Add support for packEnabled and versionEnabled.
    * NEWS: Update with bugfix.
    * netx/net/sourceforge/jnlp/DownloadOptions.java: New file.
    * netx/net/sourceforge/jnlp/JNLPFile.java
    (openURL): Use null for DownloadOptions.
    (getResourceDescs): New method.
    (getResourceDescs(Locale,String,String)): New method.
    * netx/net/sourceforge/jnlp/Launcher.java
    (launchApplication): Add image to downloader with null DownloadOptions.
    * netx/net/sourceforge/jnlp/cache/CacheUtil.java
    (getCachedResource):  Add resource with null DownloadOptions.
    * netx/net/sourceforge/jnlp/cache/Resource.java: Add new field
    downloadLocation.
    (Resource): Initialize downloadLocation.
    (getDownloadLocation): New method.
    (setDownloadLocation): New method.
    * netx/net/sourceforge/jnlp/cache/ResourceTracker.java: Add new field
    downloadOptions.
    (addResource(URL,Version,UpdatePolicy)): Renamed to...
    (addResource(URL,Version,DownloadOptions,UpdatePolicy)): New method.
    (downloadResource): Add support for explicit downloading of packed jars as
    well as content-encoded packed jars.
    (initializeResource): Invokde findBestUrl to find the best url. Set that
    as the download location for the resource.
    (getVersionedResourceURL): Remove.
    (findBestUrl): New method. Use ResourceUrlCreator to get a list of all
    possible urls that can be used to download this resource. Try them one by
    one until one works and return that.
    * netx/net/sourceforge/jnlp/cache/ResourceUrlCreator.java: New file.
    * netx/net/sourceforge/jnlp/runtime/JNLPClassLoader.java
    (initializeResources): Add resource with appropriate download options.
    (activateJars): Likewise.
    (loadClass): Likewise.
    (getDownloadOptionsForJar): New method.

1 files changed, 163 insertions, 0 deletions

diff --git a/netx/net/sourceforge/jnlp/cache/ResourceUrlCreator.java b/netx/net/sourceforge/jnlp/cache/ResourceUrlCreator.java
new file mode 100644
index 0000000..be9844a
--- /dev/null
+++ b/netx/net/sourceforge/jnlp/cache/ResourceUrlCreator.java
@@ -0,0 +1,163 @@
+/* ResourceUrlCreator.java
+   Copyright (C) 2011 Red Hat, Inc
+
+This file is part of IcedTea.
+
+IcedTea is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
+
+IcedTea 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 for more details.
+
+You should have received a copy of the GNU General Public License
+along with IcedTea; see the file COPYING.  If not, write to the
+Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+02110-1301 USA.
+
+Linking this library statically or dynamically with other modules is
+making a combined work based on this library.  Thus, the terms and
+conditions of the GNU General Public License cover the whole
+combination.
+
+As a special exception, the copyright holders of this library give you
+permission to link this library with independent modules to produce an
+executable, regardless of the license terms of these independent
+modules, and to copy and distribute the resulting executable under
+terms of your choice, provided that you also meet, for each linked
+independent module, the terms and conditions of the license of that
+module.  An independent module is a module which is not derived from
+or based on this library.  If you modify this library, you may extend
+this exception to your version of the library, but you are not
+obligated to do so.  If you do not wish to do so, delete this
+exception statement from your version. */
+
+package net.sourceforge.jnlp.cache;
+
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.LinkedList;
+import java.util.List;
+
+import net.sourceforge.jnlp.DownloadOptions;
+
+public class ResourceUrlCreator {
+
+    protected final Resource resource;
+    protected final DownloadOptions downloadOptions;
+
+    public ResourceUrlCreator(Resource resource, DownloadOptions downloadOptions) {
+        this.resource = resource;
+        this.downloadOptions = downloadOptions;
+    }
+
+    /**
+     * Returns a list of URLs that the resources might be downloadable from.
+     * The Resources may not be downloadable from any of them. The returned order is the order
+     * the urls should be attempted in.
+     * @return
+     */
+    public List<URL> getUrls() {
+        List<URL> urls = new LinkedList<URL>();
+        URL url = null;
+
+        if (downloadOptions.useExplicitPack() && downloadOptions.useExplicitVersion()) {
+            url = getUrl(resource, true, true);
+            if (url != null) {
+                urls.add(url);
+            }
+            url = getUrl(resource, false, true);
+            if (url != null) {
+                urls.add(url);
+            }
+            url = getUrl(resource, true, false);
+            if (url != null) {
+                urls.add(url);
+            }
+        } else if (downloadOptions.useExplicitPack()) {
+            url = getUrl(resource, true, false);
+            if (url != null) {
+                urls.add(url);
+            }
+        } else if (downloadOptions.useExplicitVersion()) {
+            url = getUrl(resource, false, true);
+            if (url != null) {
+                urls.add(url);
+            }
+        }
+
+        url = getVersionedUrlUsingQuery(resource);
+        urls.add(url);
+
+        urls.add(resource.getLocation());
+
+        return urls;
+    }
+
+    /**
+     * Returns a url for the resource.
+     * @param resource the resource
+     * @param usePack whether the URL should point to the pack200 file
+     * @param useVersion whether the URL should be modified to include the version
+     * @return a URL for the resource or null if an appropraite URL can not be found
+     */
+    protected URL getUrl(Resource resource, boolean usePack, boolean useVersion) {
+        if (!(usePack || useVersion)) {
+            throw new IllegalArgumentException("either pack200 or version required");
+        }
+
+        String location = resource.getLocation().toString();
+        int lastSlash = resource.getLocation().toString().lastIndexOf('/');
+        if (lastSlash == -1) {
+            return resource.getLocation();
+        }
+        String filename = location.substring(lastSlash + 1);
+        if (useVersion && resource.requestVersion != null) {
+            String parts[] = filename.split("\\.", 2);
+            String name = parts[0];
+            String extension = parts[1];
+            filename = name + "__V" + resource.requestVersion + "." + extension;
+        }
+        if (usePack) {
+            filename = filename.replace(".jar", ".pack.gz");
+        }
+
+        location = location.substring(0, lastSlash + 1) + filename;
+        try {
+            URL newUrl = new URL(location);
+            return newUrl;
+        } catch (MalformedURLException e) {
+            return null;
+        }
+    }
+
+    /**
+     * Returns the URL for a resource, relying on HTTP query for getting the
+     * right version
+     *
+     * @param resource the resource to get the url for
+     */
+    protected URL getVersionedUrlUsingQuery(Resource resource) {
+        String actualLocation = resource.getLocation().getProtocol() + "://"
+                + resource.getLocation().getHost();
+        if (resource.getLocation().getPort() != -1) {
+            actualLocation += ":" + resource.getLocation().getPort();
+        }
+        actualLocation += resource.getLocation().getPath();
+        if (resource.requestVersion != null
+                && resource.requestVersion.isVersionId()) {
+            actualLocation += "?version-id=" + resource.requestVersion;
+        }
+        URL versionedURL;
+        try {
+            versionedURL = new URL(actualLocation);
+        } catch (MalformedURLException e) {
+            return resource.getLocation();
+        }
+        return versionedURL;
+    }
+
+}
\ No newline at end of file