A AppImage generator

Author: fvarrui

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

@@ -10,9 +10,10 @@
  */
 public class LinuxConfig implements Serializable {
 	private static final long serialVersionUID = -1238166997019141904L;
-	
+
 	private boolean generateDeb = true;
 	private boolean generateRpm = true;
+	private boolean generateAppImage = true;
 	private File pngFile;
 	private boolean wrapJar = true;
 
@@ -32,26 +33,34 @@ public void setGenerateRpm(boolean generateRpm) {
 		this.generateRpm = generateRpm;
 	}
 
+	public boolean isGenerateAppImage() {
+		return generateAppImage;
+	}
+
+	public void setGenerateAppImage(boolean generateAppImage) {
+		this.generateAppImage = generateAppImage;
+	}
+
 	public File getPngFile() {
-		return pngFile;	
+		return pngFile;
 	}
 
 	public void setPngFile(File pngFile) {
 		this.pngFile = pngFile;
 	}
-	
+
 	public boolean isWrapJar() {
 		return wrapJar;
 	}
-	
+
 	public void setWrapJar(boolean wrapJar) {
 		this.wrapJar = wrapJar;
 	}
 
 	@Override
 	public String toString() {
-		return "LinuxConfig [generateDeb=" + generateDeb + ", generateRpm=" + generateRpm + ", pngFile=" + pngFile
-				+ ", wrapJar=" + wrapJar + "]";
+		return "LinuxConfig [generateDeb=" + generateDeb + ", generateRpm=" + generateRpm + ", generateAppImage="
+				+ generateAppImage + ", pngFile=" + pngFile + ", wrapJar=" + wrapJar + "]";
 	}
 
 	/**

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

@@ -22,6 +22,7 @@ public Context() {
 		// building tool independent generators
 		getInstallerGenerators(Platform.linux).add(new GenerateDeb());
 		getInstallerGenerators(Platform.linux).add(new GenerateRpm());
+		getInstallerGenerators(Platform.linux).add(new GenerateAppImage());
 		getInstallerGenerators(Platform.mac).add(new GenerateDmg());
 		getInstallerGenerators(Platform.mac).add(new GeneratePkg());
 		getInstallerGenerators(Platform.windows).add(new GenerateSetup());

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

@@ -0,0 +1,85 @@
+package io.github.fvarrui.javapackager.packagers;
+
+import java.io.File;
+import java.io.IOException;
+
+import org.apache.commons.lang3.SystemUtils;
+
+import io.github.fvarrui.javapackager.model.Platform;
+import io.github.fvarrui.javapackager.utils.CommandUtils;
+import io.github.fvarrui.javapackager.utils.FileUtils;
+import io.github.fvarrui.javapackager.utils.Logger;
+
+public class GenerateAppImage extends ArtifactGenerator<LinuxPackager> {
+	
+	private static final int IMAGETOOL_VERSION = 13;
+	private static final String IMAGETOOL_URL = "https://github.com/AppImage/AppImageKit/releases/download/%d/appimagetool-%s.AppImage".formatted(IMAGETOOL_VERSION, SystemUtils.OS_ARCH);
+	
+	public GenerateAppImage() {
+		super("AppImage");
+	}
+	
+	@Override
+	public boolean skip(LinuxPackager packager) {
+
+		if (!packager.getLinuxConfig().isGenerateAppImage()) {
+			return true;
+		}
+		
+		if (!packager.getPlatform().isCurrentPlatform() && !packager.isForceInstaller()) {
+			Logger.warn(getArtifactName() + " cannot be generated due to the target platform (" + packager.getPlatform() + ") is different from the execution platform (" + Platform.getCurrentPlatform() + ")!");
+			return true;
+		}
+		
+		return false;		
+
+	}
+	
+	@Override
+	protected File doApply(LinuxPackager packager) throws Exception {
+
+		File appFolder = packager.getAppFolder();
+		File outputFolder = packager.getOutputDirectory();
+		String name = packager.getName();
+		File executable = packager.getExecutable();
+
+		// output AppImage file
+		File appImage = new File(outputFolder, name + ".AppImage");
+		
+		// AppRun symlink file
+		File appRun = new File(appFolder, "AppRun");
+		
+		// gets/downloads AppImage tool
+		Logger.info("Getting appimagetool...");
+		File appImageTool = getAppImageTool(packager);
+		Logger.info("App image tool found! " + appImageTool);
+		
+		// creates AppRun symlink to startup script
+		Logger.info("Creating AppRun symlink to startup script...");
+		FileUtils.createSymlink(appRun, new File(executable.getName()));
+		
+		// runs appimagetool on appFolder
+		Logger.info("Running appimagetool on " + appFolder);
+		CommandUtils.execute(
+				appImageTool,
+				appFolder,
+				appImage
+			);
+		
+		Logger.info("Setting execution permissions to " + appImage);
+		appImage.setExecutable(true);
+		
+		return appImage;
+	}
+	
+	private File getAppImageTool(LinuxPackager packager) throws IOException {
+		File assetsFolder = packager.getAssetsFolder();
+		File appImageTool = new File(assetsFolder, "appimagetool"); 
+		if (!appImageTool.exists()) {
+			FileUtils.downloadFromUrl(IMAGETOOL_URL, appImageTool);
+			appImageTool.setExecutable(true);
+		}
+		return appImageTool;
+	}
+
+}

src/main/java/io/github/fvarrui/javapackager/utils/FileUtils.java

@@ -298,6 +298,16 @@ public static void downloadFromUrl(URL url, File file) throws IOException {
 		Logger.info("File downloaded from [" + url + "] to [" + file.getAbsolutePath() + "]");
 	}
 
+	/**
+	 * Download a resource from an URL to a file
+	 * @param url URL to download
+	 * @param file File to copy the downloaded resource
+	 * @throws IOException Resource cannot be copied/downloaded
+	 */
+	public static void downloadFromUrl(String url, File file) throws IOException {
+		downloadFromUrl(new URL(url), file);
+	}
+	
 	/**
 	 * Checks if a file exists or is not null
 	 * @param file File