de.perdian.maven.plugins.macosappbundler.mojo.BundleMojo Maven / Gradle / Ivy

Go to download
/*
 * macOS app bundler Maven plugin
 * Copyright 2019 Christian Seifert
 * Copyright 2020 Håvard Bakke
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package de.perdian.maven.plugins.macosappbundler.mojo;

import java.io.File;
import java.io.IOException;

import de.perdian.maven.plugins.macosappbundler.mojo.model.*;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.Validate;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;

import de.perdian.maven.plugins.macosappbundler.mojo.impl.AppGenerator;
import de.perdian.maven.plugins.macosappbundler.mojo.impl.DmgGenerator;

/**
 * Create all artifacts to publish a Java application as macOS application bundle.
 */

@Mojo(name = "bundle", requiresDependencyResolution = ResolutionScope.RUNTIME, defaultPhase = LifecyclePhase.PACKAGE)
public class BundleMojo extends AbstractMojo {

    @Parameter(defaultValue = "${project}", readonly = true, required = true)
    private MavenProject project = null;

    @Parameter(required = true)
    private PlistConfiguration plist = null;

    @Parameter
    private AppConfiguration app = new AppConfiguration();

    @Parameter
    private DmgConfiguration dmg = new DmgConfiguration();

    @Parameter
    private JdkConfiguration jdk = new JdkConfiguration();

    @Parameter
    private NativeBinaryType nativeBinary = NativeBinaryType.UNIVERSAL;

    @Override
    public void execute() throws MojoExecutionException {
        Validate.notNull(this.getProject(), "MavenProject cannot be null");
        if (StringUtils.isEmpty(this.plist.JVMMainClassName) && StringUtils.isEmpty(this.plist.JVMMainModuleName)) {
            throw new MojoExecutionException("Neither 'JVMMainClassName' nor 'JVMMainModuleName' have been defined!");
        } else if (StringUtils.isNotEmpty(this.plist.JVMMainClassName) && StringUtils.isNotEmpty(this.plist.JVMMainModuleName)) {
            throw new MojoExecutionException("Both 'JVMMainClassName' and 'JVMMainModuleName' have been defined! Make sure to define only one to signalize whether to use a classic classpath application or a moduel application.");
        } else {

            this.plist.CFBundleDisplayName = StringUtils.defaultIfEmpty(this.plist.CFBundleDisplayName, this.project.getName());
            this.plist.CFBundleName = StringUtils.defaultIfEmpty(this.plist.CFBundleName, this.project.getName());
            this.plist.CFBundleDevelopmentRegion = StringUtils.defaultIfEmpty(this.plist.CFBundleDevelopmentRegion, "English");
            this.plist.CFBundleIdentifier = StringUtils.defaultIfEmpty(this.plist.CFBundleIdentifier, this.project.getGroupId() + "." + this.project.getArtifactId());
            this.plist.CFBundleShortVersionString = StringUtils.defaultIfEmpty(this.plist.CFBundleShortVersionString, this.project.getVersion());
            this.plist.CFBundleExecutable = StringUtils.defaultIfEmpty(this.plist.CFBundleExecutable, "JavaLauncher");
            this.plist.CFBundlePackageType = StringUtils.defaultIfEmpty(this.plist.CFBundlePackageType, "APPL");

            String appName = StringUtils.defaultString(this.plist.CFBundleName, this.project.getBuild().getFinalName());
            File targetDirectory = new File(this.project.getBuild().getDirectory());
            File appDirectory = new File(targetDirectory, appName + ".app");
            if (!appDirectory.exists()) {
                this.getLog().info("Creating app directory at: " + appDirectory.getAbsolutePath());
                appDirectory.mkdirs();
            }
            AppGenerator appGenerator = new AppGenerator(this.plist, this.app, this.getLog());
            appGenerator.setIncludeJdk(this.jdk.include);
            appGenerator.setJdkLocation(this.jdk.location);
            appGenerator.setNativeBinaryType(this.nativeBinary);
            appGenerator.generateApp(this.project, appDirectory);

            if (this.dmg.generate) {
                File bundleDirectory = new File(targetDirectory, "bundle");
                File dmgFile = new File(targetDirectory, this.createDmgFileName(appName));
                DmgGenerator dmgGenerator = new DmgGenerator(this.dmg, appName, this.getLog());
                dmgGenerator.generateDmg(this.project, appDirectory, bundleDirectory, dmgFile);
                try {
                    FileUtils.deleteDirectory(bundleDirectory);
                } catch (IOException e) {
                    this.getLog().debug("Cannot delete bundle directory at: " + bundleDirectory.getAbsolutePath(), e);
                }
            }

        }
    }

    private String createDmgFileName(String appName) {
        if (this.dmg.appendVersion) {
            return appName + "_" + this.project.getVersion() + ".dmg";
        } else if (this.dmg.dmgFileName == null || this.dmg.dmgFileName.isEmpty()) {
            return appName + ".dmg";
        } else {
            return this.dmg.dmgFileName + ".dmg";
        }
    }

    public MavenProject getProject() {
        return this.project;
    }
    public void setProject(MavenProject project) {
        this.project = project;
    }

}