1 /*
   2  * Copyright (c) 2018, 2019, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package jdk.jpackage.internal;
  27 
  28 import java.util.Collection;
  29 import java.util.HashMap;
  30 import java.util.Map;
  31 import java.io.File;
  32 import jdk.jpackage.internal.Arguments.CLIOptions;
  33 
  34 /*
  35  * AddLauncherArguments
  36  *
  37  * Processes a add-launcher properties file to create the Map of
  38  * bundle params applicable to the add-launcher:
  39  *
  40  * BundlerParams p = (new AddLauncherArguments(file)).getLauncherMap();
  41  *
  42  * A add-launcher is another executable program generated by either the
  43  * create-app-image mode or the create-installer mode.
  44  * The add-launcher may be the same program with different configuration,
  45  * or a completely different program created from the same files.
  46  *
  47  * There may be multiple add-launchers, each created by using the
  48  * command line arg "--add-launcher <file path>
  49  *
  50  * The add-launcher properties file may have any of:
  51  *
  52  * appVersion
  53  * module
  54  * add-modules
  55  * main-jar
  56  * main-class
  57  * icon
  58  * arguments
  59  * java-options
  60  * win-console
  61  *
  62  */
  63 class AddLauncherArguments {
  64 
  65     private final String name;
  66     private final String filename;
  67     private Map<String, String> allArgs;
  68     private Map<String, ? super Object> bundleParams;
  69 
  70     AddLauncherArguments(String name, String filename) {
  71         this.name = name;
  72         this.filename = filename;
  73     }
  74 
  75     private void initLauncherMap() {
  76         if (bundleParams != null) {
  77             return;
  78         }
  79 
  80         allArgs = Arguments.getPropertiesFromFile(filename);
  81         allArgs.put(CLIOptions.NAME.getId(), name);
  82 
  83         bundleParams = new HashMap<>();
  84         String mainJar = getOptionValue(CLIOptions.MAIN_JAR);
  85         String mainClass = getOptionValue(CLIOptions.APPCLASS);
  86         String module = getOptionValue(CLIOptions.MODULE);
  87 
  88         if (module != null && mainClass != null) {
  89             putUnlessNull(bundleParams, CLIOptions.MODULE.getId(),
  90                     module + "/" + mainClass);
  91         } else if (module != null) {
  92             putUnlessNull(bundleParams, CLIOptions.MODULE.getId(),
  93                     module);
  94         } else {
  95             putUnlessNull(bundleParams, CLIOptions.MAIN_JAR.getId(),
  96                     mainJar);
  97             putUnlessNull(bundleParams, CLIOptions.APPCLASS.getId(),
  98                     mainClass);
  99         }
 100 
 101         putUnlessNull(bundleParams, CLIOptions.NAME.getId(),
 102                 getOptionValue(CLIOptions.NAME));
 103 
 104         putUnlessNull(bundleParams, CLIOptions.VERSION.getId(),
 105                 getOptionValue(CLIOptions.VERSION));
 106 
 107         putUnlessNull(bundleParams,
 108                 CLIOptions.ADD_MODULES.getId(),
 109                 getOptionValue(CLIOptions.ADD_MODULES));
 110 
 111         putUnlessNull(bundleParams,
 112                 CLIOptions.WIN_CONSOLE_HINT.getId(),
 113                 getOptionValue(CLIOptions.WIN_CONSOLE_HINT));
 114 
 115         String value = getOptionValue(CLIOptions.ICON);
 116         putUnlessNull(bundleParams, CLIOptions.ICON.getId(),
 117                 (value == null) ? null : new File(value));
 118 
 119         String argumentStr = getOptionValue(CLIOptions.ARGUMENTS);
 120         putUnlessNullOrEmpty(bundleParams,
 121                 CLIOptions.ARGUMENTS.getId(),
 122                 Arguments.getArgumentList(argumentStr));
 123 
 124         String jvmargsStr = getOptionValue(CLIOptions.JAVA_OPTIONS);
 125         putUnlessNullOrEmpty(bundleParams,
 126                 CLIOptions.JAVA_OPTIONS.getId(),
 127                 Arguments.getArgumentList(jvmargsStr));
 128     }
 129 
 130     private String getOptionValue(CLIOptions option) {
 131         if (option == null || allArgs == null) {
 132             return null;
 133         }
 134 
 135         String id = option.getId();
 136 
 137         if (allArgs.containsKey(id)) {
 138             return allArgs.get(id);
 139         }
 140 
 141         return null;
 142     }
 143 
 144     Map<String, ? super Object> getLauncherMap() {
 145         initLauncherMap();
 146         return bundleParams;
 147     }
 148 
 149     private void putUnlessNull(Map<String, ? super Object> params,
 150             String param, Object value) {
 151         if (value != null) {
 152             params.put(param, value);
 153         }
 154     }
 155 
 156     private void putUnlessNullOrEmpty(Map<String, ? super Object> params,
 157             String param, Collection<?> value) {
 158         if (value != null && !value.isEmpty()) {
 159             params.put(param, value);
 160         }
 161     }
 162 
 163     private void putUnlessNullOrEmpty(Map<String, ? super Object> params,
 164             String param, Map<?, ?> value) {
 165         if (value != null && !value.isEmpty()) {
 166             params.put(param, value);
 167         }
 168     }
 169 
 170     static Map<String, ? super Object> merge(
 171             Map<String, ? super Object> original,
 172             Map<String, ? super Object> additional) {
 173         Map<String, ? super Object> tmp = new HashMap<>(original);
 174         if (additional.containsKey("module")) {
 175             tmp.remove("main-jar");
 176             tmp.remove("main-class");
 177         } else if (additional.containsKey("main-jar")) {
 178             tmp.remove("module");
 179             // should we only remove add-modules when it wasn't actually passed
 180             // but was inferred or empty ?
 181             tmp.remove("add-modules");
 182         }
 183         tmp.putAll(additional);
 184         return tmp;
 185     }
 186 
 187 }