org.devzendo.xplp.MacOSXAppLauncherCreator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of CrossPlatformLauncherPlugin Show documentation
A Maven plugin that creates launchers for Windows (using Janel), Mac OS X (creating a .app structure, or tree with shell script) or Linux (using a shell script). (Apache License v2) 2008-2013 Matt Gumbley, DevZendo.org
The newest version!
/**
 * Copyright (C) 2008-2010 Matt Gumbley, DevZendo.org 
 *
 * 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 org.devzendo.xplp;

import java.io.File;
import java.io.IOException;
import java.util.Properties;
import java.util.Set;

import org.apache.maven.artifact.Artifact;
import org.apache.maven.plugin.AbstractMojo;


/**
 * Creates a Mac OS X launcher directory structure.
 * See
 * http://developer.apple.com/documentation/Java/Conceptual/Java14Development/03-JavaDeployment/JavaDeployment.html
 * for details.
 * 
 * @author matt
 *
 */
public final class MacOSXAppLauncherCreator extends LauncherCreator {
    private static final String LINE_SEPARATOR = System.getProperty("line.separator");
    private final String mFileType;
    private final String mIconsFileName;
    private final String mBundleSignature;
    private final String mBundleOsType;
    private final String mBundleTypeName;
    private final String mLauncherType;

    /**
     * @param mojo the parent mojo class
     * @param outputDirectory where to create the .app structure 
     * @param mainClassName the main class
     * @param applicationName the name of the application
     * @param libraryDirectory where the libraries are stored
     * @param transitiveArtifacts the set of transitive artifact dependencies
     * @param resourceDirectories the project's resource directories
     * @param parameterProperties the plugin configuration parameters, as properties
     * @param systemProperties an array of name=value system properties
     * @param vmArguments an array of arguments to the VM
     * @param narClassifierTypes an array of NAR classifier:types
     * @param launcherType the launcher type, Console or GUI
     * @param fileType the file type (currently unused)
     * @param iconsFileName the name of the icons file
     * @param bundleSignature the bundle signature
     * @param bundleOsType the bundle OS type
     * @param bundleTypeName the bundle type name
     */
    public MacOSXAppLauncherCreator(final AbstractMojo mojo,
            final File outputDirectory,
            final String mainClassName,
            final String applicationName,
            final String libraryDirectory,
            final Set transitiveArtifacts,
            final Set resourceDirectories,
            final Properties parameterProperties,
            final String[] systemProperties,
            final String[] vmArguments,
            final String[] narClassifierTypes,
            final String launcherType,
            final String fileType,
            final String iconsFileName,
            final String bundleSignature,
            final String bundleOsType,
            final String bundleTypeName) {
        super(mojo, outputDirectory, mainClassName,
            applicationName, libraryDirectory,
            transitiveArtifacts, resourceDirectories,
            parameterProperties, systemProperties, vmArguments,
            narClassifierTypes);
        mFileType = fileType;
        mIconsFileName = iconsFileName;
        mBundleSignature = bundleSignature;
        mBundleOsType = bundleOsType;
        mBundleTypeName = bundleTypeName;
        mLauncherType = launcherType;
    }

    private void validate() {
        if (mIconsFileName == null || mIconsFileName.length() == 0) {
            final String message = "No iconsFileName specified - this is mandatory for Mac OS X";
            getMojo().getLog().warn(message);
            throw new IllegalStateException(message);
        }
        if (mBundleSignature == null || mBundleSignature.length() == 0) {
            final String message = "No bundleSignature specified - this is mandatory for Mac OS X";
            getMojo().getLog().warn(message);
            throw new IllegalStateException(message);
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void createLauncher() throws IOException {
        validate();
        getParameterProperties().put("xplp.macosxsystemproperties", systemPropertiesAsPlistDict(getSystemProperties()));
        getParameterProperties().put("xplp.macosxvmoptionsarray", vmArgumentsAsPlistArray(getVmArguments()));
        getParameterProperties().put("xplp.macosxclasspatharray", transitiveArtifactsAsPlistArray(getTransitiveArtifacts()));

        getMojo().getLog().info("Launcher type:     " + mLauncherType);
        getMojo().getLog().info("Icons file name:   " + mIconsFileName);
        getMojo().getLog().info("File type:         " + mFileType);
        getMojo().getLog().info("Bundle signature:  " + mBundleSignature);
        getMojo().getLog().info("Bundle OS type:    " + mBundleOsType);
        getMojo().getLog().info("Bundle type name:  " + mBundleTypeName);
        
        final File osOutputDir = new File(getOutputDirectory(), "macosx");
        final File appDir = new File(osOutputDir, getApplicationName() + ".app");
        final File contentsDir = new File(appDir, "Contents");
        final File macOSDir = new File(contentsDir, "MacOS");
        final File resourcesDir = new File(contentsDir, "Resources");
        final File libDir = new File(resourcesDir, "Java/lib");
        osOutputDir.mkdirs();
        appDir.mkdirs();
        contentsDir.mkdirs();
        macOSDir.mkdirs();
        resourcesDir.mkdirs();
        libDir.mkdirs();
        final boolean allDirsOK = osOutputDir.exists()
            && appDir.exists() && contentsDir.exists()
            && macOSDir.exists() && resourcesDir.exists() 
            && libDir.exists();
        if (!allDirsOK) {
            throw new IOException("Could not create required directories under " + appDir.getAbsolutePath());
        }
        
        final File javaApplicationStub = new File(macOSDir, "JavaApplicationStub");
        copyPluginResource("macosx/JavaApplicationStub", javaApplicationStub);
        makeExecutable(javaApplicationStub);
        
        copyProjectResource(mIconsFileName, new File(resourcesDir, mIconsFileName));
        
        copyInterpolatedPluginResource("macosx/Info.plist", new File(contentsDir, "Info.plist"));
        copyInterpolatedPluginResource("macosx/PkgInfo", new File(contentsDir, "PkgInfo"));
        
        copyTransitiveArtifacts(libDir);
    }

    private String vmArgumentsAsPlistArray(final String[] vmArguments) {
        final StringBuilder argsAsArray = new StringBuilder();
        if (vmArguments.length > 0) {
            argsAsArray.append("        VMOptions");
            argsAsArray.append(LINE_SEPARATOR);
            argsAsArray.append("        ");
            argsAsArray.append(LINE_SEPARATOR);
            for (final String vmArg : vmArguments) {
                argsAsArray.append("           ");
                argsAsArray.append(vmArg);
                argsAsArray.append("");
                argsAsArray.append(LINE_SEPARATOR);
            }
            argsAsArray.append("        ");
            argsAsArray.append(LINE_SEPARATOR);
        }
        return argsAsArray.toString();
    }

    private String systemPropertiesAsPlistDict(final String[] systemProperties) {
        final StringBuilder propsAsDictEntries = new StringBuilder();
        for (int i = 0; i < systemProperties.length; i++) {
            final String prop = systemProperties[i];
            appendSystemProperty(propsAsDictEntries, prop);
            propsAsDictEntries.append(LINE_SEPARATOR);
        }
        return propsAsDictEntries.toString();
    }

    private void appendSystemProperty(
            final StringBuilder propsAsDictEntries,
            final String prop) {
        final String[] split = prop.split("\\s*=\\s*");
        propsAsDictEntries.append("            ");
        propsAsDictEntries.append(split[0]);
        propsAsDictEntries.append("");
        propsAsDictEntries.append(LINE_SEPARATOR);
        propsAsDictEntries.append("            ");
        propsAsDictEntries.append(split[1]);
        propsAsDictEntries.append("");
    }

    private String transitiveArtifactsAsPlistArray(final Set transitiveArtifacts) {
        final StringBuilder libsAsArtifacts = new StringBuilder();
        final Set transitiveArtifactFileNames = getTransitiveJarOrNarArtifactFileNames(transitiveArtifacts);
        for (final String fileName : transitiveArtifactFileNames) {
            libsAsArtifacts.append("            $JAVAROOT/lib/");
            libsAsArtifacts.append(fileName);
            libsAsArtifacts.append("");
            libsAsArtifacts.append(LINE_SEPARATOR);
        }

        return libsAsArtifacts.toString();
    }
}