Merge branch 'devel' into macos

Author: fvarrui

README.md

@@ -30,7 +30,7 @@ Add the following `plugin` tag to your `pom.xml`:
 <plugin>
     <groupId>io.github.fvarrui</groupId>
     <artifactId>javapackager</artifactId>
-    <version>1.6.7</version>
+    <version>1.7.0-SNAPSHOT</version>
     <executions>
         <execution>
             <phase>package</phase>
@@ -78,7 +78,7 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'io.github.fvarrui:javapackager:1.6.7'
+        classpath 'io.github.fvarrui:javapackager:1.7.0-SNAPSHOT'
     }
 }
 

build.gradle

@@ -46,17 +46,17 @@ dependencies {
 	implementation 'org.apache.maven:maven-plugin-api:3.6.0'
 	implementation 'org.codehaus.plexus:plexus-utils:3.1.1'
 	implementation 'org.twdata.maven:mojo-executor:2.3.0'
-	implementation 'commons-io:commons-io:2.6'
+	implementation 'commons-io:commons-io:2.7'
 	implementation 'org.apache.commons:commons-lang3:3.9'
 	implementation 'org.apache.commons:commons-collections4:4.1'
 	implementation 'org.apache.commons:commons-compress:1.21'
-	implementation 'org.apache.velocity:velocity-engine-core:2.0'
+	implementation 'org.apache.velocity:velocity-engine-core:2.3'
 	implementation 'org.vafer:jdeb:1.9'
 	implementation 'net.jsign:jsign-core:3.1'
 	implementation 'org.redline-rpm:redline:1.2.10'
 	implementation 'io.github.fvarrui:launch4j:2.5.2'
 
-	testImplementation 'junit:junit:4.12'
+	testImplementation 'junit:junit:4.13.1'
 
 	compileOnly 'org.apache.maven.plugin-tools:maven-plugin-annotations:3.6.0'
 
@@ -70,8 +70,8 @@ dependencies {
 }
 
 group = 'io.github.fvarrui'
-version = '1.6.7'
-description = 'Hybrid Maven/Gradle plugin to package Java applications as native Windows, MacOS or GNU/Linux executables and create installers for them'
+version = '1.7.0-SNAPSHOT'
+description = 'Hybrid Maven/Gradle plugin to package Java applications as native Windows, Mac OS X or GNU/Linux executables and create installers for them'
 
 sourceCompatibility = JavaVersion.VERSION_1_8
 targetCompatibility = JavaVersion.VERSION_1_8
@@ -86,6 +86,11 @@ publishing {
 	}
 }
 
+java {
+	withSourcesJar()
+	// and/or analogously use “withJavadocJar()� to get a “javadocJar� task
+}
+
 install.repositories.mavenInstaller.pom.with {
 	groupId = project.group
 	artifactId = project.name

src/main/java/io/github/fvarrui/javapackager/model/MacConfig.java

@@ -34,6 +34,8 @@ public class MacConfig implements Serializable {
 	private String developerId = "-";
 	private File entitlements;
 	private File provisionProfile;
+	private File customLauncher;
+	private File customInfoPlist;
 	private boolean codesignApp = true;
 	private InfoPlist infoPlist = new InfoPlist();
 	private boolean hardenedCodesign = true;
@@ -191,6 +193,22 @@ public void setDeveloperId(String developerId) {
 		this.developerId = developerId;
 	}
 
+	public File getCustomLauncher() {
+		return customLauncher;
+	}
+
+	public void setCustomLauncher(File customLauncher) {
+		this.customLauncher = customLauncher;
+	}
+
+	public File getCustomInfoPlist() {
+		return customInfoPlist;
+	}
+
+	public void setCustomInfoPlist(File customInfoPlist) {
+		this.customInfoPlist = customInfoPlist;
+	}
+
 	public File getProvisionProfile() {
 		return provisionProfile;
 	}

src/main/java/io/github/fvarrui/javapackager/model/WindowsConfig.java

@@ -39,6 +39,7 @@ public class WindowsConfig implements Serializable {
 	private boolean generateSetup = true;
 	private boolean generateMsi = true;
 	private boolean generateMsm = false;
+	private boolean setupMutex = true;
 	private String msiUpgradeCode;
 	private boolean wrapJar = true;
 	private LinkedHashMap<String, String> setupLanguages = new LinkedHashMap<>();
@@ -281,6 +282,14 @@ public boolean isDisableWelcomePage() {
 		return disableWelcomePage;
 	}
 
+	public boolean isSetupMutex() {
+		return setupMutex;
+	}
+
+	public void setSetupMutex(boolean setupMutex) {
+		this.setupMutex = setupMutex;
+	}
+
 	public boolean isRemoveOldLibs() {
 		return removeOldLibs;
 	}

src/main/java/io/github/fvarrui/javapackager/packagers/MacPackager.java

@@ -9,6 +9,7 @@
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.SystemUtils;
 
+import io.github.fvarrui.javapackager.model.MacStartup;
 import io.github.fvarrui.javapackager.model.Platform;
 import io.github.fvarrui.javapackager.utils.CommandUtils;
 import io.github.fvarrui.javapackager.utils.FileUtils;
@@ -91,37 +92,50 @@ public File doCreateApp() throws Exception {
 		// copies jarfile to Java folder
 		FileUtils.copyFileToFolder(jarFile, javaFolder);
 
+		processStartupScript();
+
+		processClasspath();
+
+		processInfoPlistFile();
+
+		processProvisionProfileFile();
+
+		codesign();
+
+		return appFile;
+	}
+
+	private void processStartupScript() throws Exception {
+		
 		if (this.administratorRequired) {
 
+			// We need a helper script ("startup") in this case,
+			// which invokes the launcher script/ executable with administrator rights.
+			// TODO: admin script depends on launcher file name 'universalJavaApplicationStub'
+
 			// sets startup file
 			this.executable = new File(macOSFolder, "startup");
 
 			// creates startup file to boot java app
 			VelocityUtils.render("mac/startup.vtl", executable, this);
-			executable.setExecutable(true, false);
-			Logger.info("Startup script file created in " + executable.getAbsolutePath());
-
+			
 		} else {
 
-			// sets startup file
-			this.executable = new File(macOSFolder, "universalJavaApplicationStub");
-			Logger.info("Using " + executable.getAbsolutePath() + " as startup script");
-
-		}
-
-		// copies universalJavaApplicationStub startup file to boot java app
-		File appStubFile = new File(macOSFolder, "universalJavaApplicationStub");
-		String universalJavaApplicationStubResource = null;
-		switch (macConfig.getMacStartup()) {
-		case UNIVERSAL:	universalJavaApplicationStubResource = "universalJavaApplicationStub"; break;
-		case X86_64:	universalJavaApplicationStubResource = "universalJavaApplicationStub.x86_64"; break;
-		case ARM64: 	universalJavaApplicationStubResource = "universalJavaApplicationStub.arm64"; break;
-		case SCRIPT: 	universalJavaApplicationStubResource = "universalJavaApplicationStub.sh"; break;
+			File launcher = macConfig.getCustomLauncher();
+			if(launcher != null && launcher.canRead() && launcher.isFile()){
+				FileUtils.copyFileToFolder(launcher, macOSFolder);
+				this.executable = new File(macOSFolder, launcher.getName());
+			} else {
+				this.executable = preparePrecompiledStartupStub();
+			}
 		}
-		FileUtils.copyResourceToFile("/mac/" + universalJavaApplicationStubResource, appStubFile);
-		appStubFile.setExecutable(true, false);
+		
+		executable.setExecutable(true, false);
+		Logger.info("Startup script file created in " + executable.getAbsolutePath());
+	}
 
-		// process classpath
+	private void processClasspath() {
+		// TODO: Why are we doing this here? I do not see any usage of 'classpath' or 'classpaths' here.
 		classpath = (this.macConfig.isRelocateJar() ? "Java/" : "") + this.jarFile.getName() + (classpath != null ? ":" + classpath : "");
 		classpaths = Arrays.asList(classpath.split("[:;]"));
 		if (!isUseResourcesAsWorkingDir()) {
@@ -131,29 +145,57 @@ public File doCreateApp() throws Exception {
 					.collect(Collectors.toList());
 		}
 		classpath = StringUtils.join(classpaths, ":");
+	}
 
-		// creates and write the Info.plist file
+	/**
+	 * Creates and writes the Info.plist file if no custom file is specified.
+	 * @throws Exception if anything goes wrong
+	 */
+	private void processInfoPlistFile() throws Exception {
 		File infoPlistFile = new File(contentsFolder, "Info.plist");
-		VelocityUtils.render("mac/Info.plist.vtl", infoPlistFile, this);
-		XMLUtils.prettify(infoPlistFile);
-		Logger.info("Info.plist file created in " + infoPlistFile.getAbsolutePath());
-
-		// copy provisionprofile
-		if(macConfig.getProvisionProfile() != null) {
-			// file name must be 'embedded.provisionprofile'
-			FileUtils.copyFileToFile(macConfig.getProvisionProfile(), new File(contentsFolder, "embedded.provisionprofile"));
+		if(macConfig.getCustomInfoPlist() != null && macConfig.getCustomInfoPlist().isFile() && macConfig.getCustomInfoPlist().canRead()){
+			FileUtils.copyFileToFile(macConfig.getCustomInfoPlist(), infoPlistFile);
+		} else {
+			VelocityUtils.render("mac/Info.plist.vtl", infoPlistFile, this);
+			XMLUtils.prettify(infoPlistFile);
 		}
+		Logger.info("Info.plist file created in " + infoPlistFile.getAbsolutePath());
+	}
 
-		// codesigns app folder
+	private void codesign() throws Exception {
 		if (!Platform.mac.isCurrentPlatform()) {
 			Logger.warn("Generated app could not be signed due to current platform is " + Platform.getCurrentPlatform());
 		} else if (!getMacConfig().isCodesignApp()) {
 			Logger.warn("App codesigning disabled");
 		} else {
 			codesign(this.macConfig.getDeveloperId(), this.macConfig.getEntitlements(), this.appFile);
 		}
+	}
 
-		return appFile;
+	private void processProvisionProfileFile() throws Exception {
+		if (macConfig.getProvisionProfile() != null && macConfig.getProvisionProfile().isFile() && macConfig.getProvisionProfile().canRead()) {
+			// file name must be 'embedded.provisionprofile'
+			File provisionProfile = new File(contentsFolder, "embedded.provisionprofile");
+			FileUtils.copyFileToFile(macConfig.getProvisionProfile(), provisionProfile);
+			Logger.info("Provision profile file created from " + "\n" +
+					macConfig.getProvisionProfile() + " to \n" +
+					provisionProfile.getAbsolutePath());
+		}
+	}
+
+	private File preparePrecompiledStartupStub() throws Exception {
+		// sets startup file
+		File appStubFile = new File(macOSFolder, "universalJavaApplicationStub");
+		String universalJavaApplicationStubResource = null;
+		switch (macConfig.getMacStartup()) {
+			case UNIVERSAL:	universalJavaApplicationStubResource = "universalJavaApplicationStub"; break;
+			case X86_64:	universalJavaApplicationStubResource = "universalJavaApplicationStub.x86_64"; break;
+			case ARM64: 	universalJavaApplicationStubResource = "universalJavaApplicationStub.arm64"; break;
+			case SCRIPT: 	universalJavaApplicationStubResource = "universalJavaApplicationStub.sh"; break;
+		}
+		// unixStyleNewLinux=true if startup is a script (this will replace '\r\n' with '\n')
+		FileUtils.copyResourceToFile("/mac/" + universalJavaApplicationStubResource, appStubFile, macConfig.getMacStartup() == MacStartup.SCRIPT);
+		return appStubFile;
 	}
 
 	private void codesign(String developerId, File entitlements, File appFile) throws Exception {

src/main/resources/mac/startup.vtl

@@ -1,4 +1,4 @@
 #!/bin/bash
 # MacOS startup script generated by JavaPackager plugin
 SCRIPTPATH=`cd "$(dirname "$0")" ; pwd`
-osascript -e "do shell script quoted form of \"$SCRIPTPATH\" & \"/universalJavaApplicationStub $@\" with administrator privileges" &
+osascript -e "do shell script quoted form of \"$SCRIPTPATH\" & \"/universalJavaApplicationStub $@\" with administrator privileges" &

src/main/resources/windows/iss.vtl

@@ -47,6 +47,9 @@ PrivilegesRequiredOverridesAllowed=commandline
 #else 
 PrivilegesRequiredOverridesAllowed=commandline dialog
 #end
+#if ($info.winConfig.setupMutex)
+SetupMutex=SetupMutex{#SetupSetting("AppId")}
+#end
 LicenseFile={#MyAppLicense}
 SetupIconFile={#MyAppIcon}
 UninstallDisplayIcon={app}\{#MyAppExeName}