/*
* Copyright (c) 2012, 2019, 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 java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.PrintStream;
import java.nio.file.Path;
import java.text.MessageFormat;
import java.util.Arrays;
import java.util.Collection;
import java.util.Map;
import java.util.ResourceBundle;
import static jdk.jpackage.internal.WindowsBundlerParam.*;
import static jdk.jpackage.internal.WinMsiBundler.WIN_APP_IMAGE;
public class WinAppBundler extends AbstractImageBundler {
private static final ResourceBundle I18N = ResourceBundle.getBundle(
"jdk.jpackage.internal.resources.WinResources");
static final BundlerParamInfo<File> ICON_ICO =
new StandardBundlerParam<>(
I18N.getString("param.icon-ico.name"),
I18N.getString("param.icon-ico.description"),
"icon.ico",
File.class,
params -> {
File f = ICON.fetchFrom(params);
if (f != null && !f.getName().toLowerCase().endsWith(".ico")) {
Log.error(MessageFormat.format(
I18N.getString("message.icon-not-ico"), f));
return null;
}
return f;
},
(s, p) -> new File(s));
@Override
public boolean validate(Map<String, ? super Object> params)
throws UnsupportedPlatformException, ConfigException {
try {
if (params == null) throw new ConfigException(
I18N.getString("error.parameters-null"),
I18N.getString("error.parameters-null.advice"));
return doValidate(params);
} catch (RuntimeException re) {
if (re.getCause() instanceof ConfigException) {
throw (ConfigException) re.getCause();
} else {
throw new ConfigException(re);
}
}
}
// to be used by chained bundlers, e.g. by EXE bundler to avoid
// skipping validation if p.type does not include "image"
private boolean doValidate(Map<String, ? super Object> p)
throws UnsupportedPlatformException, ConfigException {
if (Platform.getPlatform() != Platform.WINDOWS) {
throw new UnsupportedPlatformException();
}
imageBundleValidation(p);
if (StandardBundlerParam.getPredefinedAppImage(p) != null) {
return true;
}
// Make sure that jpackage.exe exists.
File tool = new File(
System.getProperty("java.home") + "\\bin\\jpackage.exe");
if (!tool.exists()) {
throw new ConfigException(
I18N.getString("error.no-windows-resources"),
I18N.getString("error.no-windows-resources.advice"));
}
return true;
}
private static boolean usePredefineAppName(Map<String, ? super Object> p) {
return (PREDEFINED_APP_IMAGE.fetchFrom(p) != null);
}
private static String appName;
synchronized static String getAppName(
Map<String, ? super Object> p) {
// If we building from predefined app image, then we should use names
// from image and not from CLI.
if (usePredefineAppName(p)) {
if (appName == null) {
// Use WIN_APP_IMAGE here, since we already copy pre-defined
// image to WIN_APP_IMAGE
File appImageDir = WIN_APP_IMAGE.fetchFrom(p);
File appDir = new File(appImageDir.toString() + "\\app");
File [] files = appDir.listFiles(
(File dir, String name) -> name.endsWith(".cfg"));
if (files == null || files.length == 0) {
String name = APP_NAME.fetchFrom(p);
Path exePath = appImageDir.toPath().resolve(name + ".exe");
Path icoPath = appImageDir.toPath().resolve(name + ".ico");
if (exePath.toFile().exists() &&
icoPath.toFile().exists()) {
return name;
} else {
throw new RuntimeException(MessageFormat.format(
I18N.getString("error.cannot-find-launcher"),
appImageDir));
}
} else {
appName = files[0].getName();
int index = appName.indexOf(".");
if (index != -1) {
appName = appName.substring(0, index);
}
if (files.length > 1) {
Log.error(MessageFormat.format(I18N.getString(
"message.multiple-launchers"), appName));
}
}
return appName;
} else {
return appName;
}
}
return APP_NAME.fetchFrom(p);
}
public static String getLauncherName(Map<String, ? super Object> p) {
return getAppName(p) + ".exe";
}
public static String getLauncherCfgName(Map<String, ? super Object> p) {
return "app\\" + getAppName(p) +".cfg";
}
public boolean bundle(Map<String, ? super Object> p, File outputDirectory)
throws PackagerException {
return doBundle(p, outputDirectory, false) != null;
}
File doBundle(Map<String, ? super Object> p, File outputDirectory,
boolean dependentTask) throws PackagerException {
if (RUNTIME_INSTALLER.fetchFrom(p)) {
return doJreBundle(p, outputDirectory, dependentTask);
} else {
return doAppBundle(p, outputDirectory, dependentTask);
}
}
File doJreBundle(Map<String, ? super Object> p, File outputDirectory,
boolean dependentTask) throws PackagerException {
try {
File rootDirectory = createRoot(p, outputDirectory, dependentTask,
APP_NAME.fetchFrom(p), "windowsapp-image-builder");
AbstractAppImageBuilder appBuilder = new WindowsAppImageBuilder(
APP_NAME.fetchFrom(p),
outputDirectory.toPath());
File predefined = PREDEFINED_RUNTIME_IMAGE.fetchFrom(p);
if (predefined == null ) {
JLinkBundlerHelper.generateJre(p, appBuilder);
} else {
return predefined;
}
return rootDirectory;
} catch (PackagerException pe) {
throw pe;
} catch (Exception e) {
Log.verbose(e);
throw new PackagerException(e);
}
}
File doAppBundle(Map<String, ? super Object> p, File outputDirectory,
boolean dependentTask) throws PackagerException {
try {
File rootDirectory = createRoot(p, outputDirectory, dependentTask,
APP_NAME.fetchFrom(p), "windowsapp-image-builder");
AbstractAppImageBuilder appBuilder =
new WindowsAppImageBuilder(p, outputDirectory.toPath());
if (PREDEFINED_RUNTIME_IMAGE.fetchFrom(p) == null ) {
JLinkBundlerHelper.execute(p, appBuilder);
} else {
StandardBundlerParam.copyPredefinedRuntimeImage(p, appBuilder);
}
if (!dependentTask) {
Log.verbose(MessageFormat.format(
I18N.getString("message.result-dir"),
outputDirectory.getAbsolutePath()));
}
return rootDirectory;
} catch (PackagerException pe) {
throw pe;
} catch (Exception e) {
Log.verbose(e);
throw new PackagerException(e);
}
}
@Override
public String getName() {
return I18N.getString("app.bundler.name");
}
@Override
public String getDescription() {
return I18N.getString("app.bundler.description");
}
@Override
public String getID() {
return "windows.app";
}
@Override
public String getBundleType() {
return "IMAGE";
}
@Override
public Collection<BundlerParamInfo<?>> getBundleParameters() {
return getAppBundleParameters();
}
public static Collection<BundlerParamInfo<?>> getAppBundleParameters() {
return Arrays.asList(
APP_NAME,
APP_RESOURCES,
ARGUMENTS,
CLASSPATH,
ICON_ICO,
JVM_OPTIONS,
MAIN_CLASS,
MAIN_JAR,
PREFERENCES_ID,
VERSION,
VERBOSE
);
}
@Override
public File execute(Map<String, ? super Object> params,
File outputParentDir) throws PackagerException {
return doBundle(params, outputParentDir, false);
}
@Override
public boolean supported(boolean platformInstaller) {
return (Platform.getPlatform() == Platform.WINDOWS);
}
}