RFC: Netx - implement -Xclearcache command line option

[Deepak Bhole]

* Omair Majid <omajid at redhat.com> [2010-09-30 16:10]:
> Hi,
> 
> I posted this patch way back in 2009, but it looks like it got lost/ignored.
> 
> On 07/30/2009 05:18 PM, Omair Majid wrote:
> >The attached patch adds the option -Xclearcache to Netx.
> >
> 
> Which (and I neglected to explain this last time) makes javaws clean
> out its cache by deleting the contents of ~/.netx/cache/
> 

Hmm, what happens if I have another netx app running and javaws is called 
with -Xclearcache? AFAIK the code has no provisioning to detect if a
cache file has been deleted, and to re-download it... does it?

Deepak

> >ChangeLog:
> >2009-07-30 Omair Majid <omajid at redhat.com>
> >
> >* rt/net/sourceforge/jnlp/cache/CacheUtil.java
> >(clearCache): New function.
> >* rt/net/sourceforge/jnlp/resources/Messages.properties: Add
> >BXclearcache.
> >* rt/net/sourceforge/jnlp/runtime/Boot.java
> >Add -Xclearcache to helpMessage.
> >(run): Check for option -Xclearcache and call CacheUtil.clearCache.
> >* rt/net/sourceforge/jnlp/util/FileUtils.java
> >(recursiveDelete): New function.
> >
> 
> I am attaching an updated version. Any thoughts?
> 
> Cheers,
> Omair

> diff -r 674b1799df8c netx/net/sourceforge/jnlp/cache/CacheUtil.java
> --- a/netx/net/sourceforge/jnlp/cache/CacheUtil.java	Wed Sep 29 13:37:46 2010 -0700
> +++ b/netx/net/sourceforge/jnlp/cache/CacheUtil.java	Thu Sep 30 16:04:06 2010 -0400
> @@ -129,6 +129,25 @@
>      }
>  
>      /**
> +     * Clears the cache by deleting all the Netx cache files
> +     */
> +    public static void clearCache() {
> +        File cacheDir = new File(JNLPRuntime.getBaseDir() + File.separator + "cache");
> +        if (!(cacheDir.isDirectory())) {
> +            return;
> +        }
> +
> +        if (JNLPRuntime.isDebug()) {
> +            System.err.println("Clearing cache directory: " + cacheDir);
> +        }
> +        try {
> +            FileUtils.recursiveDelete(cacheDir, JNLPRuntime.getBaseDir());
> +        } catch (IOException e) {
> +            throw new RuntimeException(e);
> +        }
> +    }
> +
> +    /**
>       * Returns whether there is a version of the URL contents in the
>       * cache and it is up to date.  This method may not return
>       * immediately.
> diff -r 674b1799df8c netx/net/sourceforge/jnlp/resources/Messages.properties
> --- a/netx/net/sourceforge/jnlp/resources/Messages.properties	Wed Sep 29 13:37:46 2010 -0700
> +++ b/netx/net/sourceforge/jnlp/resources/Messages.properties	Thu Sep 30 16:04:06 2010 -0400
> @@ -138,6 +138,7 @@
>  BOViewer    = Shows the trusted certificate viewer.
>  BOUmask     = Sets the umask for files created by an application.
>  BXnofork    = Do not create another JVM.
> +BXclearcache= Clean the JNLP application cache.
>  BOHelp      = Print this message and exit.
>  
>  # Cache
> diff -r 674b1799df8c netx/net/sourceforge/jnlp/runtime/Boot.java
> --- a/netx/net/sourceforge/jnlp/runtime/Boot.java	Wed Sep 29 13:37:46 2010 -0700
> +++ b/netx/net/sourceforge/jnlp/runtime/Boot.java	Thu Sep 30 16:04:06 2010 -0400
> @@ -40,6 +40,7 @@
>  import net.sourceforge.jnlp.ParseException;
>  import net.sourceforge.jnlp.PropertyDesc;
>  import net.sourceforge.jnlp.ResourcesDesc;
> +import net.sourceforge.jnlp.cache.CacheUtil;
>  import net.sourceforge.jnlp.cache.UpdatePolicy;
>  import net.sourceforge.jnlp.security.VariableX509TrustManager;
>  import net.sourceforge.jnlp.security.viewer.CertificateViewer;
> @@ -114,6 +115,7 @@
>          + "  -strict               "+R("BOStrict")+"\n"
>          + "  -umask=value          "+R("BOUmask")+"\n"
>          + "  -Xnofork              "+R("BXnofork")+"\n"
> +        + "  -Xclearcache          "+R("BXclearcache")+"\n"
>          + "  -help                 "+R("BOHelp")+"\n";
>  
>      private static final String doubleArgs = "-basedir -jnlp -arg -param -property -update";
> @@ -202,6 +204,17 @@
>          JNLPRuntime.setSecurityEnabled(null == getOption("-nosecurity"));
>          JNLPRuntime.initialize(true);
>  
> +        /*
> +         * FIXME
> +         * This should have been done with the rest of the argument parsing
> +         * code. But we need to know what the cache and base directories are,
> +         * and baseDir is initialized here
> +         */
> +        if (null != getOption("-Xclearcache")) {
> +            CacheUtil.clearCache();
> +            return null;
> +        }
> +
>          try {
>              new Launcher().launch(getFile());
>          }
> diff -r 674b1799df8c netx/net/sourceforge/jnlp/util/FileUtils.java
> --- a/netx/net/sourceforge/jnlp/util/FileUtils.java	Wed Sep 29 13:37:46 2010 -0700
> +++ b/netx/net/sourceforge/jnlp/util/FileUtils.java	Thu Sep 30 16:04:06 2010 -0400
> @@ -17,6 +17,9 @@
>  package net.sourceforge.jnlp.util;
>  
>  import java.io.File;
> +import java.io.IOException;
> +
> +import net.sourceforge.jnlp.runtime.JNLPRuntime;
>  
>  /**
>   * This class contains a few file-related utility functions.
> @@ -68,4 +71,36 @@
>          return filename;
>      }
>  
> +    /**
> +     * Recursively delete everything under a directory. Works on either files or
> +     * directories
> +     *
> +     * @param file the file object representing what to delete. Can be either a
> +     *        file or a directory.
> +     * @param base the directory under which the file and its subdirectories must be located
> +     * @throws IOException on an io exception or if trying to delete something
> +     *         outside the base
> +     */
> +    public static void recursiveDelete(File file, File base) throws IOException {
> +        if (JNLPRuntime.isDebug()) {
> +            System.err.println("Deleting: " + file);
> +        }
> +
> +        if (!(file.getCanonicalPath().startsWith(base.getCanonicalPath()))) {
> +            throw new IOException("Trying to delete a file outside Netx's basedir: "
> +                    + file.getCanonicalPath());
> +        }
> +
> +        if (file.isDirectory()) {
> +            File[] children = file.listFiles();
> +            for (int i = 0; i < children.length; i++) {
> +                recursiveDelete(children[i], base);
> +            }
> +        }
> +        if (!file.delete()) {
> +            throw new IOException("Unable to delete file: " + file);
> +        }
> +
> +    }
> +
>  }