8211299: Output of System.out is not printed to CMD on Windows
Submitten-by: almatvee
Reviewed-by: herrick, kcr
/*
* Copyright (c) 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.packager.internal;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.Properties;
import java.util.ResourceBundle;
import java.util.jar.Attributes;
import java.util.jar.JarFile;
import java.util.jar.Manifest;
import java.util.stream.Stream;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import jdk.packager.internal.bundlers.Bundler;
import jdk.packager.internal.bundlers.BundleParams;
public class Arguments {
private static final ResourceBundle I18N = ResourceBundle.getBundle(
"jdk.packager.internal.resources.Arguments");
private static final String IMAGE_MODE = "image";
private static final String INSTALLER_MODE = "installer";
private static final String JRE_INSTALLER_MODE = "jre-installer";
private static final String FA_EXTENSIONS = "extension";
private static final String FA_CONTENT_TYPE = "mime-type";
private static final String FA_DESCRIPTION = "description";
private static final String FA_ICON = "icon";
public static final BundlerParamInfo<Boolean> CREATE_IMAGE =
new StandardBundlerParam<>(
I18N.getString("param.create-image.name"),
I18N.getString("param.create-image.description"),
IMAGE_MODE,
Boolean.class,
p -> Boolean.FALSE,
(s, p) -> (s == null || "null".equalsIgnoreCase(s)) ?
true : Boolean.valueOf(s));
public static final BundlerParamInfo<Boolean> CREATE_INSTALLER =
new StandardBundlerParam<>(
I18N.getString("param.create-installer.name"),
I18N.getString("param.create-installer.description"),
INSTALLER_MODE,
Boolean.class,
p -> Boolean.FALSE,
(s, p) -> (s == null || "null".equalsIgnoreCase(s)) ?
true : Boolean.valueOf(s));
public static final BundlerParamInfo<Boolean> CREATE_JRE_INSTALLER =
new StandardBundlerParam<>(
I18N.getString("param.create-jre-installer.name"),
I18N.getString("param.create-jre-installer.description"),
JRE_INSTALLER_MODE,
Boolean.class,
p -> Boolean.FALSE,
(s, p) -> (s == null || "null".equalsIgnoreCase(s)) ?
true : Boolean.valueOf(s));
// regexp for parsing args (for example, for secondary launchers)
private static Pattern pattern = Pattern.compile(
"(?:(?:([\"'])(?:\\\\\\1|.)*?(?:\\1|$))|(?:\\\\[\"'\\s]|[^\\s]))++");
private DeployParams deployParams = null;
private Bundler.BundleType bundleType = null;
private int pos = 0;
private List<String> argList = null;
private List<CLIOptions> allOptions = null;
private ArrayList<String> files = null;
private String input = null;
private String output = null;
private boolean hasMainJar = false;
private boolean hasMainClass = false;
private boolean hasMainModule = false;
private boolean hasTargetFormat = false;
private boolean hasAppImage = false;
private String mainJarPath = null;
private static boolean echo = false;
private static boolean verbose = false;
private static boolean jreInstaller = false;
private List<jdk.packager.internal.Bundler> platformBundlers = null;
private List<SecondaryLauncherArguments> secondaryLaunchers = null;
private static Map<String, CLIOptions> argIds = new HashMap<>();
private static Map<String, CLIOptions> argShortIds = new HashMap<>();
{
// init maps for parsing arguments
EnumSet<CLIOptions> options = EnumSet.allOf(CLIOptions.class);
options.forEach(option -> {
argIds.put(option.getIdWithPrefix(), option);
if (option.getShortIdWithPrefix() != null) {
argShortIds.put(option.getShortIdWithPrefix(), option);
}
});
}
public Arguments(String[] args) {
initArgumentList(args);
}
public enum CLIOptions {
CREATE_IMAGE(IMAGE_MODE, OptionCategories.MODE, () -> {
context().bundleType = Bundler.BundleType.IMAGE;
context().deployParams.setTargetFormat("image");
setOptionValue(IMAGE_MODE, true);
}),
CREATE_INSTALLER(INSTALLER_MODE, OptionCategories.MODE, () -> {
setOptionValue(INSTALLER_MODE, true);
context().bundleType = Bundler.BundleType.INSTALLER;
String format = "installer";
if (hasNextArg()) {
String arg = popArg();
if (!arg.startsWith("-")) {
format = arg.toLowerCase();
context().hasTargetFormat = true;
} else {
prevArg();
}
}
context().deployParams.setTargetFormat(format);
}),
CREATE_JRE_INSTALLER(JRE_INSTALLER_MODE, OptionCategories.MODE, () -> {
setOptionValue(JRE_INSTALLER_MODE, true);
context().bundleType = Bundler.BundleType.INSTALLER;
String format = "installer";
if (hasNextArg()) {
String arg = popArg();
if (!arg.startsWith("-")) {
format = arg.toLowerCase();
context().hasTargetFormat = true;
} else {
prevArg();
}
}
jreInstaller = true;
context().deployParams.setTargetFormat(format);
context().deployParams.setJreInstaller(true);
}),
INPUT ("input", "i", OptionCategories.PROPERTY, () -> {
context().input = popArg();
setOptionValue("input", context().input);
}),
OUTPUT ("output", "o", OptionCategories.PROPERTY, () -> {
context().output = popArg();
context().deployParams.setOutdir(new File(context().output));
}),
DESCRIPTION ("description", "d", OptionCategories.PROPERTY),
VENDOR ("vendor", OptionCategories.PROPERTY),
APPCLASS ("class", "c", OptionCategories.PROPERTY, () -> {
context().hasMainClass = true;
setOptionValue("class", popArg());
}),
SINGLETON ("singleton", OptionCategories.PROPERTY, () -> {
setOptionValue("singleton", true);
}),
NAME ("name", "n", OptionCategories.PROPERTY),
IDENTIFIER ("identifier", OptionCategories.PROPERTY),
VERBOSE ("verbose", OptionCategories.PROPERTY, () -> {
setOptionValue("verbose", true);
verbose = true;
}),
FILES ("files", "f", OptionCategories.PROPERTY, () -> {
context().files = new ArrayList<>();
String files = popArg();
// TODO: should we split using ' '(space) ?
context().files.addAll(
Arrays.asList(files.split(File.pathSeparator)));
}),
ARGUMENTS ("arguments", "a", OptionCategories.PROPERTY, () -> {
List<String> arguments = getArgumentList(popArg());
setOptionValue("arguments", arguments);
}),
STRIP_NATIVE_COMMANDS ("strip-native-commands",
OptionCategories.PROPERTY, () -> {
setOptionValue("strip-native-commands", true);
}),
ICON ("icon", OptionCategories.PROPERTY),
CATEGORY ("category", OptionCategories.PROPERTY),
COPYRIGHT ("copyright", OptionCategories.PROPERTY),
LICENSE_FILE ("license-file", OptionCategories.PROPERTY),
VERSION ("version", "v", OptionCategories.PROPERTY),
JVM_ARGS ("jvm-args", OptionCategories.PROPERTY, () -> {
List<String> args = getArgumentList(popArg());
args.forEach(a -> setOptionValue("jvm-args", a));
}),
FILE_ASSOCIATIONS ("file-associations",
OptionCategories.PROPERTY, () -> {
Map<String, ? super Object> args = new HashMap<>();
// load .properties file
Map<String, String> initialMap = getPropertiesFromFile(popArg());
String ext = initialMap.get(FA_EXTENSIONS);
if (ext != null) {
args.put(StandardBundlerParam.FA_EXTENSIONS.getID(), ext);
}
String type = initialMap.get(FA_CONTENT_TYPE);
if (type != null) {
args.put(StandardBundlerParam.FA_CONTENT_TYPE.getID(), type);
}
String desc = initialMap.get(FA_DESCRIPTION);
if (desc != null) {
args.put(StandardBundlerParam.FA_DESCRIPTION.getID(), desc);
}
String icon = initialMap.get(FA_ICON);
if (icon != null) {
args.put(StandardBundlerParam.FA_ICON.getID(), icon);
}
ArrayList<Map<String, ? super Object>> associationList =
new ArrayList<Map<String, ? super Object>>();
associationList.add(args);
// check that we really add _another_ value to the list
setOptionValue("file-associations", associationList);
}),
SECONDARY_LAUNCHER ("secondary-launcher",
OptionCategories.PROPERTY, () -> {
context().secondaryLaunchers.add(
new SecondaryLauncherArguments(popArg()));
}),
BUILD_ROOT ("build-root", OptionCategories.PROPERTY),
INSTALL_DIR ("install-dir", OptionCategories.PROPERTY),
ECHO_MODE ("echo-mode", OptionCategories.PROPERTY, () -> {
echo = true;
setOptionValue("echo-mode", true);
}),
PREDEFINED_APP_IMAGE ("app-image", OptionCategories.PROPERTY, ()-> {
setOptionValue("app-image", popArg());
context().hasAppImage = true;
}),
PREDEFINED_RUNTIME_IMAGE ("runtime-image", OptionCategories.PROPERTY),
MAIN_JAR ("main-jar", "j", OptionCategories.PROPERTY, () -> {
context().mainJarPath = popArg();
context().hasMainJar = true;
setOptionValue("main-jar", context().mainJarPath);
}),
MODULE ("module", "m", OptionCategories.MODULAR, () -> {
context().hasMainModule = true;
setOptionValue("module", popArg());
}),
ADD_MODULES ("add-modules", OptionCategories.MODULAR),
MODULE_PATH ("module-path", "p", OptionCategories.MODULAR),
LIMIT_MODULES ("limit-modules", OptionCategories.MODULAR),
MAC_SIGN ("mac-sign", "s", OptionCategories.PLATFORM_MAC, () -> {
setOptionValue("mac-sign", true);
}),
MAC_BUNDLE_NAME ("mac-bundle-name", OptionCategories.PLATFORM_MAC),
MAC_BUNDLE_IDENTIFIER("mac-bundle-identifier",
OptionCategories.PLATFORM_MAC),
MAC_APP_STORE_CATEGORY ("mac-app-store-category",
OptionCategories.PLATFORM_MAC),
MAC_BUNDLE_SIGNING_PREFIX ("mac-bundle-signing-prefix",
OptionCategories.PLATFORM_MAC),
MAC_SIGNING_KEY_NAME ("mac-signing-key-user-name",
OptionCategories.PLATFORM_MAC),
MAC_SIGNING_KEYCHAIN ("mac-signing-keychain",
OptionCategories.PLATFORM_MAC),
MAC_APP_STORE_ENTITLEMENTS ("mac-app-store-entitlements",
OptionCategories.PLATFORM_MAC),
WIN_MENU_HINT ("win-menu", OptionCategories.PLATFORM_WIN, () -> {
setOptionValue("win-menu", true);
}),
WIN_MENU_GROUP ("win-menu-group", OptionCategories.PLATFORM_WIN),
WIN_SHORTCUT_HINT ("win-shortcut",
OptionCategories.PLATFORM_WIN, () -> {
setOptionValue("win-shortcut", true);
}),
WIN_PER_USER_INSTALLATION ("win-per-user-install",
OptionCategories.PLATFORM_WIN, () -> {
setOptionValue("win-per-user-install", false);
}),
WIN_DIR_CHOOSER ("win-dir-chooser",
OptionCategories.PLATFORM_WIN, () -> {
setOptionValue("win-dir-chooser", true);
}),
WIN_REGISTRY_NAME ("win-registry-name", OptionCategories.PLATFORM_WIN),
WIN_MSI_UPGRADE_UUID ("win-upgrade-uuid",
OptionCategories.PLATFORM_WIN),
WIN_CONSOLE_HINT ("win-console", OptionCategories.PLATFORM_WIN, () -> {
setOptionValue("win-console", true);
}),
LINUX_BUNDLE_NAME ("linux-bundle-name",
OptionCategories.PLATFORM_LINUX),
LINUX_DEB_MAINTAINER ("linux-deb-maintainer",
OptionCategories.PLATFORM_LINUX),
LINUX_RPM_LICENSE_TYPE ("linux-rpm-license-type",
OptionCategories.PLATFORM_LINUX),
LINUX_PACKAGE_DEPENDENCIES ("linux-package-deps",
OptionCategories.PLATFORM_LINUX);
private final String id;
private final String shortId;
private final OptionCategories category;
private final ArgAction action;
private static Arguments argContext;
private CLIOptions(String id, OptionCategories category) {
this(id, null, category, null);
}
private CLIOptions(String id, String shortId,
OptionCategories category) {
this(id, shortId, category, null);
}
private CLIOptions(String id,
OptionCategories category, ArgAction action) {
this(id, null, category, action);
}
private CLIOptions(String id, String shortId,
OptionCategories category, ArgAction action) {
this.id = id;
this.shortId = shortId;
this.action = action;
this.category = category;
}
public static void setContext(Arguments context) {
argContext = context;
}
private static Arguments context() {
if (argContext != null) {
return argContext;
} else {
throw new RuntimeException("Argument context is not set.");
}
}
public String getId() {
return this.id;
}
public String getIdWithPrefix() {
String prefix = isMode() ? "create-" : "--";
return prefix + this.id;
}
public String getShortIdWithPrefix() {
return this.shortId == null ? null : "-" + this.shortId;
}
public void execute() {
if (action != null) {
action.execute();
} else {
defaultAction();
}
}
public boolean isMode() {
return category == OptionCategories.MODE;
}
public OptionCategories getCategory() {
return category;
}
private void defaultAction() {
context().deployParams.addBundleArgument(id, popArg());
}
private static void setOptionValue(String option, Object value) {
context().deployParams.addBundleArgument(option, value);
}
private static String popArg() {
nextArg();
return (context().pos >= context().argList.size()) ?
"" : context().argList.get(context().pos);
}
private static String getArg() {
return (context().pos >= context().argList.size()) ?
"" : context().argList.get(context().pos);
}
private static void nextArg() {
context().pos++;
}
private static void prevArg() {
context().pos--;
}
private static boolean hasNextArg() {
return context().pos < context().argList.size();
}
}
public enum OptionCategories {
MODE,
MODULAR,
PROPERTY,
PLATFORM_MAC,
PLATFORM_WIN,
PLATFORM_LINUX;
}
private void initArgumentList(String[] args) {
argList = new ArrayList<>(Arrays.asList(args));
pos = 0;
deployParams = new DeployParams();
bundleType = Bundler.BundleType.NONE;
allOptions = new ArrayList<>();
secondaryLaunchers = new ArrayList<>();
}
public boolean processArguments() throws Exception {
try {
// init context of arguments
CLIOptions.setContext(this);
// parse cmd line
String arg;
CLIOptions option;
for (; CLIOptions.hasNextArg(); CLIOptions.nextArg()) {
arg = CLIOptions.getArg();
// check if it's a CLI option
if ((option = toCLIOption(arg)) != null) {
allOptions.add(option);
option.execute();
} else {
Log.info("Illegal argument ["+arg+"]");
}
}
if (allOptions.isEmpty() || !allOptions.get(0).isMode()) {
// first argument should always be a mode.
Log.info("ERROR: Mode is not specified");
return false;
}
if (!hasAppImage && !hasMainJar && !hasMainModule &&
!hasMainClass && !jreInstaller) {
Log.info("ERROR: Main jar, main class, main module, or app-image "
+ "must be specified.");
} else if (!hasMainModule && !hasMainClass) {
// try to get main-class from manifest
String mainClass = getMainClassFromManifest();
if (mainClass != null) {
CLIOptions.setOptionValue(
CLIOptions.APPCLASS.getId(), mainClass);
}
}
// display warning for arguments that are not supported
// for current configuration.
validateArguments();
addResources(deployParams, input, files);
deployParams.setBundleType(bundleType);
List<Map<String, ? super Object>> launchersAsMap =
new ArrayList<>();
for (SecondaryLauncherArguments sl : secondaryLaunchers) {
launchersAsMap.add(sl.getLauncherMap());
}
deployParams.addBundleArgument(
StandardBundlerParam.SECONDARY_LAUNCHERS.getID(),
launchersAsMap);
// at this point deployParams should be already configured
deployParams.validate();
BundleParams bp = deployParams.getBundleParams();
generateBundle(bp.getBundleParamsAsMap());
} catch (Exception e) {
if (verbose) {
throw e;
} else {
System.err.println(e.getMessage());
if (e.getCause() != null && e.getCause() != e) {
System.err.println(e.getCause().getMessage());
}
System.exit(-1);
}
}
return true;
}
private void validateArguments() {
CLIOptions mode = allOptions.get(0);
for (CLIOptions option : allOptions) {
if(!ValidOptions.checkIfSupported(mode, option)) {
System.out.println("WARNING: argument ["
+ option.getId() + "] is not "
+ "supported for current configuration.");
}
}
}
private List<jdk.packager.internal.Bundler> getPlatformBundlers() {
if (platformBundlers != null) {
return platformBundlers;
}
platformBundlers = new ArrayList<>();
for (jdk.packager.internal.Bundler bundler :
Bundlers.createBundlersInstance().getBundlers(
bundleType.toString())) {
if (hasTargetFormat && deployParams.getTargetFormat() != null &&
!deployParams.getTargetFormat().equalsIgnoreCase(
bundler.getID())) {
continue;
}
if (bundler.supported()) {
platformBundlers.add(bundler);
}
}
return platformBundlers;
}
private void generateBundle(Map<String,? super Object> params)
throws PackagerException {
for (jdk.packager.internal.Bundler bundler : getPlatformBundlers()) {
Map<String, ? super Object> localParams = new HashMap<>(params);
try {
if (bundler.validate(localParams)) {
File result =
bundler.execute(localParams, deployParams.outdir);
bundler.cleanup(localParams);
if (result == null) {
throw new PackagerException("MSG_BundlerFailed",
bundler.getID(), bundler.getName());
}
}
} catch (UnsupportedPlatformException e) {
Log.debug(MessageFormat.format(
I18N.getString("MSG_BundlerPlatformException"),
bundler.getName()));
} catch (ConfigException e) {
Log.debug(e);
if (e.getAdvice() != null) {
Log.info(MessageFormat.format(
I18N.getString("MSG_BundlerConfigException"),
bundler.getName(), e.getMessage(), e.getAdvice()));
} else {
Log.info(MessageFormat.format(I18N.getString(
"MSG_BundlerConfigExceptionNoAdvice"),
bundler.getName(), e.getMessage()));
}
} catch (RuntimeException re) {
Log.info(MessageFormat.format(
I18N.getString("MSG_BundlerRuntimeException"),
bundler.getName(), re.toString()));
Log.debug(re);
}
}
}
private void addResources(CommonParams commonParams,
String inputdir, List<String> inputfiles) {
if (inputdir == null || inputdir.isEmpty()) {
return;
}
File baseDir = new File(inputdir);
if (!baseDir.isDirectory()) {
Log.info(
"Unable to add resources: \"-srcdir\" is not a directory.");
return;
}
List<String> fileNames;
if (inputfiles != null) {
fileNames = inputfiles;
} else {
// "-files" is omitted, all files in input cdir (which
// is a mandatory argument in this case) will be packaged.
fileNames = new ArrayList<>();
try (Stream<Path> files = Files.list(baseDir.toPath())) {
files.forEach(file -> fileNames.add(
file.getFileName().toString()));
} catch (IOException e) {
Log.info("Unable to add resources: " + e.getMessage());
}
}
fileNames.forEach(file -> commonParams.addResource(baseDir, file));
setClasspath(fileNames);
}
private void setClasspath(List<String> inputfiles) {
String classpath = "";
for (String file : inputfiles) {
if (file.endsWith(".jar")) {
classpath += file;
classpath += File.pathSeparator;
}
}
deployParams.addBundleArgument(
StandardBundlerParam.CLASSPATH.getID(), classpath);
}
public static boolean isCLIOption(String arg) {
return toCLIOption(arg) != null;
}
public static CLIOptions toCLIOption(String arg) {
CLIOptions option;
if ((option = argIds.get(arg)) == null) {
option = argShortIds.get(arg);
}
return option;
}
static Map<String, String> getArgumentMap(String inputString) {
Map<String, String> map = new HashMap<>();
List<String> list = getArgumentList(inputString);
for (String pair : list) {
int equals = pair.indexOf("=");
if (equals != -1) {
String key = pair.substring(0, equals);
String value = pair.substring(equals+1, pair.length());
map.put(key, value);
}
}
return map;
}
static Map<String, String> getPropertiesFromFile(String filename) {
Map<String, String> map = new HashMap<>();
// load properties file
File file = new File(filename);
Properties properties = new Properties();
try (FileInputStream in = new FileInputStream(file)) {
properties.load(in);
in.close();
} catch (IOException e) {
Log.info("Exception: " + e.getMessage());
}
for (final String name: properties.stringPropertyNames()) {
map.put(name, properties.getProperty(name));
}
return map;
}
static List<String> getArgumentList(String inputString) {
List<String> list = new ArrayList<>();
if (inputString == null || inputString.isEmpty()) {
return list;
}
// The "pattern" regexp attempts to abide to the rule that
// strings are delimited by whitespace unless surrounded by
// quotes, then it is anything (including spaces) in the quotes.
Matcher m = pattern.matcher(inputString);
while (m.find()) {
String s = inputString.substring(m.start(), m.end()).trim();
// Ensure we do not have an empty string. trim() will take care of
// whitespace only strings. The regex preserves quotes and escaped
// chars so we need to clean them before adding to the List
if (!s.isEmpty()) {
list.add(unquoteIfNeeded(s));
}
}
return list;
}
private static String unquoteIfNeeded(String in) {
if (in == null) {
return null;
}
if (in.isEmpty()) {
return "";
}
// Use code points to preserve non-ASCII chars
StringBuilder sb = new StringBuilder();
int codeLen = in.codePointCount(0, in.length());
int quoteChar = -1;
for (int i = 0; i < codeLen; i++) {
int code = in.codePointAt(i);
if (code == '"' || code == '\'') {
// If quote is escaped make sure to copy it
if (i > 0 && in.codePointAt(i - 1) == '\\') {
sb.deleteCharAt(sb.length() - 1);
sb.appendCodePoint(code);
continue;
}
if (quoteChar != -1) {
if (code == quoteChar) {
// close quote, skip char
quoteChar = -1;
} else {
sb.appendCodePoint(code);
}
} else {
// opening quote, skip char
quoteChar = code;
}
} else {
sb.appendCodePoint(code);
}
}
return sb.toString();
}
private String getMainClassFromManifest() {
if (mainJarPath == null ||
input == null ) {
return null;
}
JarFile jf;
try {
File file = new File(input, mainJarPath);
if (!file.exists()) {
return null;
}
jf = new JarFile(file);
Manifest m = jf.getManifest();
Attributes attrs = (m != null) ? m.getMainAttributes() : null;
if (attrs != null) {
return attrs.getValue(Attributes.Name.MAIN_CLASS);
}
} catch (IOException ignore) {}
return null;
}
public static boolean echoMode() {
return echo;
}
public static boolean verbose() {
return verbose;
}
public static boolean isJreInstaller() {
return jreInstaller;
}
}