Make jre Include / Exclude configurable

gamma · gamma · commit 127087b6b32e · 2018-05-17T14:23:35.000+02:00
This will allow OSX users to change the included and excluded files of a java runtime if needed.
diff --git a/src/com/inet/gradle/setup/dmg/AbstractOSXApplicationBuilder.java b/src/com/inet/gradle/setup/dmg/AbstractOSXApplicationBuilder.java
@@ -187,9 +187,16 @@ protected void bundleJre() {
         }
         task.getProject().getLogger().lifecycle( "\tbundle JRE: " + jreDir );
 
-        Runtime runtime = new Runtime();
-        runtime.appendIncludes( new String[] { "jre/bin/java" } );
-        runtime.setDir( jreDir );
+        Runtime runtime = new Runtime( jreDir );
+        if ( task instanceof Dmg ) {
+            List<String> include = ((Dmg)task).getJreIncludes();
+            List<String> exclude = ((Dmg)task).getJreExclude();
+
+            runtime.appendIncludes( include.toArray( new String[include.size()] ) );
+            runtime.appendExcludes( exclude.toArray( new String[exclude.size()] ) );
+        } else {
+            runtime.appendIncludes( new String[] { "jre/bin/java" } );
+        }
 
         appBundler.addConfiguredRuntime( runtime );
     }
diff --git a/src/com/inet/gradle/setup/dmg/Dmg.java b/src/com/inet/gradle/setup/dmg/Dmg.java
@@ -17,6 +17,7 @@
 
 import java.io.File;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 
 import org.gradle.api.internal.project.ProjectInternal;
@@ -31,7 +32,7 @@
 
 /**
  * The dmg Gradle task. It build a dmg package for Mac.
- * 
+ *
  * @author Volker Berlin
  */
 public class Dmg extends AbstractUnixSetupTask {
@@ -48,6 +49,10 @@ public class Dmg extends AbstractUnixSetupTask {
 
     private List<PreferencesLink>          preferencesLink = new ArrayList<>();
 
+    private List<String>                   jreIncludes = Arrays.asList( "bin/java" );
+
+    private List<String>                   jreExclude = new ArrayList<>();
+
     /**
      * Create the task.
      */
@@ -66,7 +71,7 @@ public void build() {
 
     /**
      * Return width of Finder view
-     * 
+     *
      * @return width of Finder view
      */
     public Integer getWindowWidth() {
@@ -75,7 +80,7 @@ public Integer getWindowWidth() {
 
     /**
      * Set width of Finder view
-     * 
+     *
      * @param windowWidth width of Finder view
      */
     public void setWindowWidth( Integer windowWidth ) {
@@ -84,7 +89,7 @@ public void setWindowWidth( Integer windowWidth ) {
 
     /**
      * Return height of Finder view
-     * 
+     *
      * @return height of Finder view
      */
     public Integer getWindowHeight() {
@@ -93,7 +98,7 @@ public Integer getWindowHeight() {
 
     /**
      * Set height of Finder view
-     * 
+     *
      * @param windowHeight of Finder view
      */
     public void setWindowHeight( Integer windowHeight ) {
@@ -102,7 +107,7 @@ public void setWindowHeight( Integer windowHeight ) {
 
     /**
      * Return size of icons in Finder view
-     * 
+     *
      * @return size of icons in Finder view
      */
     public Integer getIconSize() {
@@ -111,7 +116,7 @@ public Integer getIconSize() {
 
     /**
      * Set size of icons in Finder view
-     * 
+     *
      * @param iconSize of icons in Finder view
      */
     public void setIconSize( Integer iconSize ) {
@@ -120,7 +125,7 @@ public void setIconSize( Integer iconSize ) {
 
     /**
      * Return background Image for Finder View
-     * 
+     *
      * @return background Image for Finder View
      */
     public File getBackgroundImage() {
@@ -132,7 +137,7 @@ public File getBackgroundImage() {
 
     /**
      * Set background Image for Finder View
-     * 
+     *
      * @param backgroundFile Image for Finder View
      */
     public void setBackgroundImage( File backgroundFile ) {
@@ -141,7 +146,7 @@ public void setBackgroundImage( File backgroundFile ) {
 
     /**
      * Return font size for Finder View
-     * 
+     *
      * @return font size for Finder View
      */
     public Integer getFontSize() {
@@ -150,7 +155,7 @@ public Integer getFontSize() {
 
     /**
      * Set font size for Finder View
-     * 
+     *
      * @param fontSize size for Finder View
      */
     public void setFontSize( Integer fontSize ) {
@@ -159,7 +164,7 @@ public void setFontSize( Integer fontSize ) {
 
     /**
      * Set the needed information for signing the setup.
-     * 
+     *
      * @param closue the data for signing
      */
     public void setCodeSign( Closure<OSXCodeSign<Dmg, SetupBuilder>> closue ) {
@@ -169,7 +174,7 @@ public void setCodeSign( Closure<OSXCodeSign<Dmg, SetupBuilder>> closue ) {
 
     /**
      * Get the SignTool configuration if set
-     * 
+     *
      * @return the settings or null
      */
     public OSXCodeSign<Dmg, SetupBuilder> getCodeSign() {
@@ -179,7 +184,7 @@ public OSXCodeSign<Dmg, SetupBuilder> getCodeSign() {
     /**
      * Return the welcome page list
      * Allowed Format: rtf, rtfd, txt, html
-     * 
+     *
      * @return welcome page
      */
     public List<LocalizedResource> getConclusionPages() {
@@ -189,7 +194,7 @@ public List<LocalizedResource> getConclusionPages() {
     /**
      * Set the welcome page
      * Allowed Format: rtf, rtfd, txt, html
-     * 
+     *
      * @param conclusionPage which is shown at the end
      */
     public void conclusionPage( Object conclusionPage ) {
@@ -199,7 +204,7 @@ public void conclusionPage( Object conclusionPage ) {
     /**
      * Return the welcome page list
      * Allowed Format: rtf, rtfd, txt, html
-     * 
+     *
      * @return welcome page
      */
     public List<LocalizedResource> getWelcomePages() {
@@ -209,7 +214,7 @@ public List<LocalizedResource> getWelcomePages() {
     /**
      * Set the welcome page
      * Allowed Format: rtf, rtfd, txt, html
-     * 
+     *
      * @param welcomePage welcome page file
      */
     public void welcomePage( Object welcomePage ) {
@@ -218,7 +223,7 @@ public void welcomePage( Object welcomePage ) {
 
     /**
      * Return the background image for the setup
-     * 
+     *
      * @return background image
      */
     public File getSetupBackgroundImage() {
@@ -230,7 +235,7 @@ public File getSetupBackgroundImage() {
 
     /**
      * Set the background image for the setup
-     * 
+     *
      * @param setupBackground to set
      */
     public void setSetupBackgroundImage( Object setupBackground ) {
@@ -256,7 +261,7 @@ public void setSetupIcon( Object setupIcon ) {
 
     /**
      * Return the list of preferences links
-     * 
+     *
      * @return preferences links
      */
     public List<PreferencesLink> getPreferencesLinks() {
@@ -265,10 +270,42 @@ public List<PreferencesLink> getPreferencesLinks() {
 
     /**
      * Set a preferences link
-     * 
+     *
      * @param link the link
      */
     public void preferencesLink( Object link ) {
         preferencesLink.add( ConfigureUtil.configure( (Closure<?>)link, new PreferencesLink() ) );
     }
+
+    /**
+     * Get a list of string - defining files - that should be included in the bundled JRE
+     * @return the jreIncludes
+     */
+    public List<String> getJreIncludes() {
+        return jreIncludes;
+    }
+
+    /**
+     * Set a list of string - defining files - that should be included in the bundled JRE
+     * @param jreIncludes the jreIncludes to set
+     */
+    public void setJreIncludes( List<String> jreIncludes ) {
+        this.jreIncludes = jreIncludes;
+    }
+
+    /**
+     * Get a list of string - defining files - that should be excluded from the bundled JRE
+     * @return the jreExclude
+     */
+    public List<String> getJreExclude() {
+        return jreExclude;
+    }
+
+    /**
+     * Set a list of string - defining files - that should be excluded from the bundled JRE
+     * @param jreExclude the jreExclude to set
+     */
+    public void setJreExclude( List<String> jreExclude ) {
+        this.jreExclude = jreExclude;
+    }
 }
diff --git a/src/com/oracle/appbundler/Runtime.java b/src/com/oracle/appbundler/Runtime.java
@@ -35,6 +35,15 @@
 
 public class Runtime extends FileSet {
 
+    /**
+     * Constructor with the jre directory to use
+     * @param jreDir
+     */
+    public Runtime( File jreDir ) {
+        super();
+        setDir( jreDir );
+    }
+
     /* Override to provide canonical path so that runtime can be specified
      * via a version-agnostic path (relative link, e.g. `current-jre`) while
      * still preserving the original runtime directory name, e.g. `jre1.8.0_45.jre`.
@@ -49,19 +58,58 @@ public File getDir() {
         }
     }
 
+    /**
+     * {@inheritsDoc}
+     */
+    @Override
+    public void appendIncludes( String[] includes ) {
+        patchIncludeExcludes( includes );
+        super.appendIncludes( includes );
+    }
+
+    /**
+     * {@inheritsDoc}
+     */
+    @Override
+    public void appendExcludes( String[] excludes ) {
+        patchIncludeExcludes( excludes );
+        super.appendIncludes( excludes );
+    }
+
+    /**
+     * Patch the include and exclude directories to
+     * provide only jre relevant entries
+     * @param includExclude the list of includes or excludes to check
+     */
+    private void patchIncludeExcludes( String[] includExclude ) {
+        boolean isJDK = new File(getDir(), "jre").isDirectory();
+        if ( isJDK ) {
+            for( int i = 0; i < includExclude.length; i++ ) {
+                if ( !includExclude[i].startsWith( "jre/" ) ) {
+                    includExclude[i] = "jre/" + includExclude[i];
+                }
+            }
+        }
+    }
+
+    /**
+     * check the type of the runtime set.
+     * If it is a JDK we want to exclude certain predefined entries
+     */
     private void detectType() {
         boolean isJDK = new File(getDir(), "jre").isDirectory();
 
+        appendIncludes(new String[] {
+                        "lib/",
+                        "COPYRIGHT",
+                        "LICENSE",
+                        "README",
+                        "THIRDPARTYLICENSEREADME-JAVAFX.txt",
+                        "THIRDPARTYLICENSEREADME.txt",
+                        "Welcome.html"
+        });
+
         if (isJDK) {
-            appendIncludes(new String[] {
-                    "jre/lib/",
-                    "jreCOPYRIGHT",
-                    "jre/LICENSE",
-                    "jre/README",
-                    "jre/THIRDPARTYLICENSEREADME-JAVAFX.txt",
-                    "jre/THIRDPARTYLICENSEREADME.txt",
-                    "jre/Welcome.html"
-            });
             appendExcludes(new String[] {
                     "jre/lib/deploy/",
                     "jre/lib/deploy.jar",
@@ -70,20 +118,16 @@ private void detectType() {
                     "jre/lib/libnpjp2.dylib",
                     "jre/lib/plugin.jar",
                     "jre/lib/security/javaws.policy"
-                });
-        } else {
-            appendIncludes(new String[] {
-                    "lib/",
-                    "COPYRIGHT",
-                    "LICENSE",
-                    "README",
-                    "THIRDPARTYLICENSEREADME-JAVAFX.txt",
-                    "THIRDPARTYLICENSEREADME.txt",
-                    "Welcome.html"
             });
         }
     }
 
+    /**
+     * Finally copy the files of the jre
+     * @param targetDir where to copy
+     * @param project the project we're working on
+     * @throws IOException in case of errors
+     */
     void copyTo(File targetDir, Project project) throws IOException {
         detectType();
 
