RFC: Netx - implement -Xclearcache command line option

[Deepak Bhole]

* Omair Majid <omajid at redhat.com> [2009-07-30 18:12]:
> Omair Majid wrote:
>> The attached patch adds the option -Xclearcache to Netx.
>
> What I really meant was the patch I am going to attach to the next email  
> I send ;)
>
> Cheers,
> Omair

Assuming you have tested this, go ahead and commit.

Cheers,
Deepak

> diff -r 051ca564791d rt/net/sourceforge/jnlp/cache/CacheUtil.java
> --- a/rt/net/sourceforge/jnlp/cache/CacheUtil.java	Thu Jul 30 04:51:32 2009 -0400
> +++ b/rt/net/sourceforge/jnlp/cache/CacheUtil.java	Thu Jul 30 17:01:27 2009 -0400
> @@ -26,6 +26,7 @@
>  
>  import net.sourceforge.jnlp.*;
>  import net.sourceforge.jnlp.runtime.*;
> +import net.sourceforge.jnlp.util.FileUtils;
>  
>  /**
>   * Provides static methods to interact with the cache, download
> @@ -128,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);
> +        } 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 051ca564791d rt/net/sourceforge/jnlp/resources/Messages.properties
> --- a/rt/net/sourceforge/jnlp/resources/Messages.properties	Thu Jul 30 04:51:32 2009 -0400
> +++ b/rt/net/sourceforge/jnlp/resources/Messages.properties	Thu Jul 30 17:01:27 2009 -0400
> @@ -133,6 +133,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 051ca564791d rt/net/sourceforge/jnlp/runtime/Boot.java
> --- a/rt/net/sourceforge/jnlp/runtime/Boot.java	Thu Jul 30 04:51:32 2009 -0400
> +++ b/rt/net/sourceforge/jnlp/runtime/Boot.java	Thu Jul 30 17:01:27 2009 -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);
>  
> +        /*
> +         * TODO
> +         * 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 051ca564791d rt/net/sourceforge/jnlp/util/FileUtils.java
> --- a/rt/net/sourceforge/jnlp/util/FileUtils.java	Thu Jul 30 04:51:32 2009 -0400
> +++ b/rt/net/sourceforge/jnlp/util/FileUtils.java	Thu Jul 30 17:01:27 2009 -0400
> @@ -14,8 +14,12 @@
>  // License along with this library; if not, write to the Free Software
>  // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
>  
> +package net.sourceforge.jnlp.util;
>  
> -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. 
> @@ -44,5 +48,36 @@
>          String sanitizedName = input.replaceAll("[^a-zA-Z0-9.]", "_");
>          return sanitizedName;
>      }
> -    
> +
> +    /**
> +     * 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. Must be within Netx's basedir
> +     * @throws IOException on an io exception or if trying to delete something
> +     *         outside the basedir
> +     */
> +    public static void recursiveDelete(File file) throws IOException {
> +        if (JNLPRuntime.isDebug()) {
> +            System.err.println("Deleting: " + file);
> +        }
> +        
> +        if (!(file.getCanonicalPath().startsWith(JNLPRuntime.getBaseDir().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]);
> +            }
> +        }
> +        if (!file.delete()) {
> +            throw new IOException("Unable to delete file: " + file);
> +        }
> +
> +    }
> +
>  }