/*
* Copyright (c) 2014, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package jdk.jpackage.internal;
import jdk.jpackage.internal.BundlerParamInfo;
import jdk.jpackage.internal.StandardBundlerParam;
import jdk.jpackage.internal.Arguments;
import jdk.jpackage.internal.Log;
import jdk.jpackage.internal.ConfigException;
import jdk.jpackage.internal.IOUtils;
import jdk.jpackage.internal.Platform;
import jdk.jpackage.internal.UnsupportedPlatformException;
import jdk.jpackage.internal.MacAppImageBuilder;
import jdk.jpackage.internal.resources.MacResources;
import java.io.File;
import java.io.IOException;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.ResourceBundle;
import static jdk.jpackage.internal.StandardBundlerParam.*;
import static jdk.jpackage.internal.MacAppBundler.*;
public class MacAppStoreBundler extends MacBaseInstallerBundler {
private static final ResourceBundle I18N =
ResourceBundle.getBundle(
"jdk.jpackage.internal.resources.MacAppStoreBundler");
private static final String TEMPLATE_BUNDLE_ICON_HIDPI =
"GenericAppHiDPI.icns";
private final static String DEFAULT_ENTITLEMENTS =
"MacAppStore.entitlements";
private final static String DEFAULT_INHERIT_ENTITLEMENTS =
"MacAppStore_Inherit.entitlements";
public static final BundlerParamInfo<String> MAC_APP_STORE_APP_SIGNING_KEY =
new StandardBundlerParam<>(
I18N.getString("param.signing-key-app.name"),
I18N.getString("param.signing-key-app.description"),
"mac.signing-key-app",
String.class,
params -> {
String result = MacBaseInstallerBundler.findKey(
"3rd Party Mac Developer Application: " +
SIGNING_KEY_USER.fetchFrom(params),
SIGNING_KEYCHAIN.fetchFrom(params),
VERBOSE.fetchFrom(params));
if (result != null) {
MacCertificate certificate = new MacCertificate(result,
VERBOSE.fetchFrom(params));
if (!certificate.isValid()) {
Log.error(MessageFormat.format(
I18N.getString("error.certificate.expired"),
result));
}
}
return result;
},
(s, p) -> s);
public static final BundlerParamInfo<String> MAC_APP_STORE_PKG_SIGNING_KEY =
new StandardBundlerParam<>(
I18N.getString("param.signing-key-pkg.name"),
I18N.getString("param.signing-key-pkg.description"),
"mac.signing-key-pkg",
String.class,
params -> {
String result = MacBaseInstallerBundler.findKey(
"3rd Party Mac Developer Installer: " +
SIGNING_KEY_USER.fetchFrom(params),
SIGNING_KEYCHAIN.fetchFrom(params),
VERBOSE.fetchFrom(params));
if (result != null) {
MacCertificate certificate = new MacCertificate(
result, VERBOSE.fetchFrom(params));
if (!certificate.isValid()) {
Log.error(MessageFormat.format(
I18N.getString("error.certificate.expired"),
result));
}
}
return result;
},
(s, p) -> s);
public static final StandardBundlerParam<File> MAC_APP_STORE_ENTITLEMENTS =
new StandardBundlerParam<>(
I18N.getString("param.mac-app-store-entitlements.name"),
I18N.getString("param.mac-app-store-entitlements.description"),
Arguments.CLIOptions.MAC_APP_STORE_ENTITLEMENTS.getId(),
File.class,
params -> null,
(s, p) -> new File(s));
public static final BundlerParamInfo<String> INSTALLER_SUFFIX =
new StandardBundlerParam<> (
I18N.getString("param.installer-suffix.name"),
I18N.getString("param.installer-suffix.description"),
"mac.app-store.installerName.suffix",
String.class,
params -> "-MacAppStore",
(s, p) -> s);
public MacAppStoreBundler() {
super();
baseResourceLoader = MacResources.class;
}
//@Override
public File bundle(Map<String, ? super Object> p, File outdir) {
Log.verbose(MessageFormat.format(I18N.getString(
"message.building-bundle"), APP_NAME.fetchFrom(p)));
if (!outdir.isDirectory() && !outdir.mkdirs()) {
throw new RuntimeException(MessageFormat.format(I18N.getString(
"error.cannot-create-output-dir"),
outdir.getAbsolutePath()));
}
if (!outdir.canWrite()) {
throw new RuntimeException(MessageFormat.format(I18N.getString(
"error.cannot-write-to-output-dir"),
outdir.getAbsolutePath()));
}
// first, load in some overrides
// icns needs @2 versions, so load in the @2 default
p.put(DEFAULT_ICNS_ICON.getID(), TEMPLATE_BUNDLE_ICON_HIDPI);
// now we create the app
File appImageDir = APP_IMAGE_BUILD_ROOT.fetchFrom(p);
try {
appImageDir.mkdirs();
try {
MacAppImageBuilder.addNewKeychain(p);
} catch (InterruptedException e) {
Log.error(e.getMessage());
}
// first, make sure we don't use the local signing key
p.put(DEVELOPER_ID_APP_SIGNING_KEY.getID(), null);
File appLocation = prepareAppBundle(p, false);
prepareEntitlements(p);
String signingIdentity = MAC_APP_STORE_APP_SIGNING_KEY.fetchFrom(p);
String identifierPrefix = BUNDLE_ID_SIGNING_PREFIX.fetchFrom(p);
String entitlementsFile = getConfig_Entitlements(p).toString();
String inheritEntitlements =
getConfig_Inherit_Entitlements(p).toString();
MacAppImageBuilder.signAppBundle(p, appLocation.toPath(),
signingIdentity, identifierPrefix,
entitlementsFile, inheritEntitlements);
MacAppImageBuilder.restoreKeychainList(p);
ProcessBuilder pb;
// create the final pkg file
File finalPKG = new File(outdir, INSTALLER_NAME.fetchFrom(p)
+ INSTALLER_SUFFIX.fetchFrom(p)
+ ".pkg");
outdir.mkdirs();
String installIdentify =
MAC_APP_STORE_PKG_SIGNING_KEY.fetchFrom(p);
List<String> buildOptions = new ArrayList<>();
buildOptions.add("productbuild");
buildOptions.add("--component");
buildOptions.add(appLocation.toString());
buildOptions.add("/Applications");
buildOptions.add("--sign");
buildOptions.add(installIdentify);
buildOptions.add("--product");
buildOptions.add(appLocation + "/Contents/Info.plist");
String keychainName = SIGNING_KEYCHAIN.fetchFrom(p);
if (keychainName != null && !keychainName.isEmpty()) {
buildOptions.add("--keychain");
buildOptions.add(keychainName);
}
buildOptions.add(finalPKG.getAbsolutePath());
pb = new ProcessBuilder(buildOptions);
IOUtils.exec(pb, false);
return finalPKG;
} catch (Exception ex) {
Log.error("App Store Ready Bundle failed : " + ex.getMessage());
Log.verbose(ex);
return null;
} finally {
try {
if (appImageDir != null &&
PREDEFINED_APP_IMAGE.fetchFrom(p) == null &&
(PREDEFINED_RUNTIME_IMAGE.fetchFrom(p) == null ||
!Arguments.CREATE_JRE_INSTALLER.fetchFrom(p)) &&
!Log.isDebug() &&
!Log.isVerbose()) {
IOUtils.deleteRecursive(appImageDir);
} else if (appImageDir != null) {
Log.verbose(MessageFormat.format(I18N.getString(
"mesasge.intermediate-bundle-location"),
appImageDir.getAbsolutePath()));
}
//cleanup
cleanupConfigFiles(p);
} catch (IOException ex) {
//noinspection ReturnInsideFinallyBlock
Log.debug(ex.getMessage());
return null;
}
}
}
protected void cleanupConfigFiles(Map<String, ? super Object> params) {
if (Log.isDebug() || Log.isVerbose()) {
return;
}
if (getConfig_Entitlements(params) != null) {
getConfig_Entitlements(params).delete();
}
if (getConfig_Inherit_Entitlements(params) != null) {
getConfig_Inherit_Entitlements(params).delete();
}
if (PREDEFINED_APP_IMAGE.fetchFrom(params) == null) {
APP_BUNDLER.fetchFrom(params).cleanupConfigFiles(params);
}
}
private File getConfig_Entitlements(Map<String, ? super Object> params) {
return new File(CONFIG_ROOT.fetchFrom(params),
APP_NAME.fetchFrom(params) + ".entitlements");
}
private File getConfig_Inherit_Entitlements(
Map<String, ? super Object> params) {
return new File(CONFIG_ROOT.fetchFrom(params),
APP_NAME.fetchFrom(params) + "_Inherit.entitlements");
}
private void prepareEntitlements(Map<String, ? super Object> params)
throws IOException {
File entitlements = MAC_APP_STORE_ENTITLEMENTS.fetchFrom(params);
if (entitlements == null || !entitlements.exists()) {
fetchResource(getEntitlementsFileName(params),
I18N.getString("resource.mac-app-store-entitlements"),
DEFAULT_ENTITLEMENTS,
getConfig_Entitlements(params),
VERBOSE.fetchFrom(params),
DROP_IN_RESOURCES_ROOT.fetchFrom(params));
} else {
fetchResource(getEntitlementsFileName(params),
I18N.getString("resource.mac-app-store-entitlements"),
entitlements,
getConfig_Entitlements(params),
VERBOSE.fetchFrom(params),
DROP_IN_RESOURCES_ROOT.fetchFrom(params));
}
fetchResource(getInheritEntitlementsFileName(params),
I18N.getString("resource.mac-app-store-inherit-entitlements"),
DEFAULT_INHERIT_ENTITLEMENTS,
getConfig_Inherit_Entitlements(params),
VERBOSE.fetchFrom(params),
DROP_IN_RESOURCES_ROOT.fetchFrom(params));
}
private String getEntitlementsFileName(Map<String, ? super Object> params) {
return BUNDLER_PREFIX + APP_NAME.fetchFrom(params) + ".entitlements";
}
private String getInheritEntitlementsFileName(
Map<String, ? super Object> params) {
return BUNDLER_PREFIX + APP_NAME.fetchFrom(params)
+ "_Inherit.entitlements";
}
///////////////////////////////////////////////////////////////////////
// Implement Bundler
///////////////////////////////////////////////////////////////////////
@Override
public String getName() {
return I18N.getString("bundler.name");
}
@Override
public String getDescription() {
return I18N.getString("bundler.description");
}
@Override
public String getID() {
return "mac.appStore";
}
@Override
public Collection<BundlerParamInfo<?>> getBundleParameters() {
Collection<BundlerParamInfo<?>> results = new LinkedHashSet<>();
results.addAll(getAppBundleParameters());
results.addAll(getMacAppStoreBundleParameters());
return results;
}
public Collection<BundlerParamInfo<?>> getMacAppStoreBundleParameters() {
Collection<BundlerParamInfo<?>> results = new LinkedHashSet<>();
results.addAll(getAppBundleParameters());
results.remove(DEVELOPER_ID_APP_SIGNING_KEY);
results.addAll(Arrays.asList(
INSTALLER_SUFFIX,
MAC_APP_STORE_APP_SIGNING_KEY,
MAC_APP_STORE_ENTITLEMENTS,
MAC_APP_STORE_PKG_SIGNING_KEY,
SIGNING_KEYCHAIN
));
return results;
}
@Override
public boolean validate(Map<String, ? super Object> params)
throws UnsupportedPlatformException, ConfigException {
try {
if (Platform.getPlatform() != Platform.MAC) {
throw new UnsupportedPlatformException();
}
if (params == null) {
throw new ConfigException(
I18N.getString("error.parameters-null"),
I18N.getString("error.parameters-null.advice"));
}
// hdiutil is always available so there's no need to test for
// availability.
// run basic validation to ensure requirements are met
// TODO Mac App Store apps cannot use the system runtime
// we are not interested in return code, only possible exception
validateAppImageAndBundeler(params);
// reject explicitly set to not sign
if (!Optional.ofNullable(MacAppImageBuilder.
SIGN_BUNDLE.fetchFrom(params)).orElse(Boolean.TRUE)) {
throw new ConfigException(
I18N.getString("error.must-sign-app-store"),
I18N.getString("error.must-sign-app-store.advice"));
}
// make sure we have settings for signatures
if (MAC_APP_STORE_APP_SIGNING_KEY.fetchFrom(params) == null) {
throw new ConfigException(
I18N.getString("error.no-app-signing-key"),
I18N.getString("error.no-app-signing-key.advice"));
}
if (MAC_APP_STORE_PKG_SIGNING_KEY.fetchFrom(params) == null) {
throw new ConfigException(
I18N.getString("error.no-pkg-signing-key"),
I18N.getString("error.no-pkg-signing-key.advice"));
}
// things we could check...
// check the icons, make sure it has hidpi icons
// check the category,
// make sure it fits in the list apple has provided
// validate bundle identifier is reverse dns
// check for \a+\.\a+\..
return true;
} catch (RuntimeException re) {
if (re.getCause() instanceof ConfigException) {
throw (ConfigException) re.getCause();
} else {
throw new ConfigException(re);
}
}
}
@Override
public File execute(Map<String, ? super Object> params,
File outputParentDir) {
return bundle(params, outputParentDir);
}
@Override
public boolean supported() {
return !Arguments.isJreInstaller() &&
Platform.getPlatform() == Platform.MAC;
}
}