/*

 * 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.tools.jlink.internal;

import java.io.IOException;

import java.io.PrintWriter;

import java.nio.file.Files;

import java.nio.file.Path;

import java.nio.file.Paths;

import java.text.MessageFormat;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Collections;

import java.util.HashMap;

import java.util.HashSet;

import java.util.List;

import java.util.Locale;

import java.util.Map;

import java.util.Map.Entry;

import java.util.MissingResourceException;

import java.util.ResourceBundle;

import java.util.Set;

import java.util.stream.Collectors;

import java.util.stream.Stream;

import jdk.tools.jlink.builder.DefaultImageBuilder;

import jdk.tools.jlink.builder.ImageBuilder;

import jdk.tools.jlink.internal.Jlink.PluginsConfiguration;

import jdk.tools.jlink.internal.plugins.DefaultCompressPlugin;

import jdk.tools.jlink.internal.plugins.DefaultStripDebugPlugin;

import jdk.tools.jlink.internal.plugins.ExcludeJmodSectionPlugin;

import jdk.tools.jlink.internal.plugins.PluginsResourceBundle;

import jdk.tools.jlink.plugin.Plugin;

import jdk.tools.jlink.plugin.Plugin.Category;

import jdk.tools.jlink.plugin.PluginException;

/**

 *

 * JLink and JImage tools shared helper.

 */

public final class TaskHelper {

    public static final String JLINK_BUNDLE = "jdk.tools.jlink.resources.jlink";

    public static final String JIMAGE_BUNDLE = "jdk.tools.jimage.resources.jimage";

    private static final String DEFAULTS_PROPERTY = "jdk.jlink.defaults";

    public final class BadArgs extends Exception {

        static final long serialVersionUID = 8765093759964640721L;

        private BadArgs(String key, Object... args) {

            super(bundleHelper.getMessage(key, args));

            this.key = key;

            this.args = args;

        }

        public BadArgs showUsage(boolean b) {

            showUsage = b;

            return this;

        }

        public final String key;

        public final Object[] args;

        public boolean showUsage;

    }

    public static class Option<T> implements Comparable<T> {

        public interface Processing<T> {

            void process(T task, String opt, String arg) throws BadArgs;

        }

        final boolean hasArg;

        final Processing<T> processing;

        final boolean hidden;

        final String name;

        final String shortname;

        final String shortname2;

        final boolean terminalOption;

        public Option(boolean hasArg,

                      Processing<T> processing,

                      boolean hidden,

                      String name,

                      String shortname,

                      String shortname2,

                      boolean isTerminal)

        {

            if (!name.startsWith("--")) {

                throw new RuntimeException("option name missing --, " + name);

            }

            if (!shortname.isEmpty() && !shortname.startsWith("-")) {

                throw new RuntimeException("short name missing -, " + shortname);

            }

            this.hasArg = hasArg;

            this.processing = processing;

            this.hidden = hidden;

            this.name = name;

            this.shortname = shortname;

            this.shortname2 = shortname2;

            this.terminalOption = isTerminal;

        }

        public Option(boolean hasArg,

                      Processing<T> processing,

                      boolean hidden,

                      String name,

                      String shortname,

                      boolean isTerminal)

        {

            this(hasArg, processing, false, name, shortname, "", isTerminal);

        }

        public Option(boolean hasArg, Processing<T> processing, String name, String shortname, boolean isTerminal) {

            this(hasArg, processing, false, name, shortname, "", isTerminal);

        }

        public Option(boolean hasArg, Processing<T> processing, String name, String shortname, String shortname2) {

            this(hasArg, processing, false, name, shortname, shortname2, false);

        }

        public Option(boolean hasArg, Processing<T> processing, String name, String shortname) {

            this(hasArg, processing, false, name, shortname, "", false);

        }

        public Option(boolean hasArg, Processing<T> processing, boolean hidden, String name) {

            this(hasArg, processing, hidden, name, "", "", false);

        }

        public Option(boolean hasArg, Processing<T> processing, String name) {

            this(hasArg, processing, false, name, "", false);

        }

        public boolean isHidden() {

            return hidden;

        }

        public boolean isTerminal() {

            return terminalOption;

        }

        public boolean matches(String opt) {

            return opt.equals(name) ||

                   opt.equals(shortname) ||

                   opt.equals(shortname2) ||

                   hasArg && opt.startsWith("--") && opt.startsWith(name + "=");

         }

        public boolean ignoreRest() {

            return false;

        }

        void process(T task, String opt, String arg) throws BadArgs {

            processing.process(task, opt, arg);

        }

        public String getName() {

            return name;

        }

        public String resourceName() {

            return resourcePrefix() + name.substring(2);

        }

        public String getShortname() {

            return shortname;

        }

        public String resourcePrefix() {

            return "main.opt.";

        }

        @Override

        public int compareTo(Object object) {

            if (!(object instanceof Option<?>)) {

                throw new RuntimeException("comparing non-Option");

            }

            Option<?> option = (Option<?>)object;

            return name.compareTo(option.name);

        }

    }

    private static class PluginOption extends Option<PluginsHelper> {

        public PluginOption(boolean hasArg,

                Processing<PluginsHelper> processing, boolean hidden, String name, String shortname) {

            super(hasArg, processing, hidden, name, shortname, false);

        }

        public PluginOption(boolean hasArg,

                Processing<PluginsHelper> processing, boolean hidden, String name) {

            super(hasArg, processing, hidden, name, "", false);

        }

        public String resourcePrefix() {

            return "plugin.opt.";

        }

    }

    private final class PluginsHelper {

        // Duplicated here so as to avoid a direct dependency on platform specific plugin

        private static final String STRIP_NATIVE_DEBUG_SYMBOLS_NAME = "strip-native-debug-symbols";

        private ModuleLayer pluginsLayer = ModuleLayer.boot();

        private final List<Plugin> plugins;

        private String lastSorter;

        private boolean listPlugins;

        private Path existingImage;

        // plugin to args maps. Each plugin may be used more than once in command line.

        // Each such occurrence results in a Map of arguments. So, there could be multiple

        // args maps per plugin instance.

        private final Map<Plugin, List<Map<String, String>>> pluginToMaps = new HashMap<>();

        private final List<PluginOption> pluginsOptions = new ArrayList<>();

        private final List<PluginOption> mainOptions = new ArrayList<>();

        private PluginsHelper() throws BadArgs {

            plugins = PluginRepository.getPlugins(pluginsLayer);

            Set<String> optionsSeen = new HashSet<>();

            for (Plugin plugin : plugins) {

                if (!Utils.isDisabled(plugin)) {

                    addOrderedPluginOptions(plugin, optionsSeen);

                }

            }

            mainOptions.add(new PluginOption(true, (task, opt, arg) -> {

                    for (Plugin plugin : plugins) {

                        if (plugin.getName().equals(arg)) {

                            pluginToMaps.remove(plugin);

                            return;

                        }

                    }

                    throw newBadArgs("err.no.such.plugin", arg);

                },

                false, "--disable-plugin"));

            mainOptions.add(new PluginOption(true, (task, opt, arg) -> {

                Path path = Paths.get(arg);

                if (!Files.exists(path) || !Files.isDirectory(path)) {

                    throw newBadArgs("err.image.must.exist", path);

                }

                existingImage = path.toAbsolutePath();

            }, true, "--post-process-path"));

            mainOptions.add(new PluginOption(true,

                    (task, opt, arg) -> {

                        lastSorter = arg;

                    },

                    true, "--resources-last-sorter"));

            mainOptions.add(new PluginOption(false,

                    (task, opt, arg) -> {

                        listPlugins = true;

                    },

                    false, "--list-plugins"));

        }

        private List<Map<String, String>> argListFor(Plugin plugin) {

            List<Map<String, String>> mapList = pluginToMaps.get(plugin);

            if (mapList == null) {

                mapList = new ArrayList<>();

                pluginToMaps.put(plugin, mapList);

            }

            return mapList;

        }

        private void addEmptyArgumentMap(Plugin plugin) {

            argListFor(plugin).add(Collections.emptyMap());

        }

        private Map<String, String> addArgumentMap(Plugin plugin) {

            Map<String, String> map = new HashMap<>();

            argListFor(plugin).add(map);

            return map;

        }

        private void addOrderedPluginOptions(Plugin plugin,

            Set<String> optionsSeen) throws BadArgs {

            String option = plugin.getOption();

            if (option == null) {

                return;

            }

            // make sure that more than one plugin does not use the same option!

            if (optionsSeen.contains(option)) {

                throw new BadArgs("err.plugin.mutiple.options",

                        option);

            }

            optionsSeen.add(option);

            PluginOption plugOption

                    = new PluginOption(plugin.hasArguments(),

                            (task, opt, arg) -> {

                                if (!Utils.isFunctional(plugin)) {

                                    throw newBadArgs("err.provider.not.functional",

                                            option);

                                }

                                if (! plugin.hasArguments()) {

                                    addEmptyArgumentMap(plugin);

                                    return;

                                }

                                Map<String, String> m = addArgumentMap(plugin);

                                // handle one or more arguments

                                    // single argument case

                                    m.put(option, arg);

                                } else {

                                    // This option can accept more than one arguments

                                    // like --option_name=arg_value:arg2=value2:arg3=value3

                                    // ":" followed by word char condition takes care of args that

                                    // like Windows absolute paths "C:\foo", "C:/foo" [cygwin] etc.

                                    // This enforces that key names start with a word character.

                                    String[] args = arg.split(":(?=\\w)", -1);

                                    String firstArg = args[0];

                                    if (firstArg.isEmpty()) {

                                        throw newBadArgs("err.provider.additional.arg.error",

                                            option, arg);

                                    }

                                    m.put(option, firstArg);

                                    // process the additional arguments

                                    for (int i = 1; i < args.length; i++) {

                                        String addArg = args[i];

                                        int eqIdx = addArg.indexOf('=');

                                        if (eqIdx == -1) {

                                            throw newBadArgs("err.provider.additional.arg.error",

                                                option, arg);

                                        }

                                        String addArgName = addArg.substring(0, eqIdx);

                                        String addArgValue = addArg.substring(eqIdx+1);

                                        if (addArgName.isEmpty() || addArgValue.isEmpty()) {

                                            throw newBadArgs("err.provider.additional.arg.error",

                                                option, arg);

                                        }

                                        m.put(addArgName, addArgValue);

                                    }

                                }

                            },

                            false, "--" + option);

            pluginsOptions.add(plugOption);

            if (Utils.isFunctional(plugin)) {

                if (Utils.isAutoEnabled(plugin)) {

                    addEmptyArgumentMap(plugin);

                }

                if (plugin instanceof DefaultCompressPlugin) {

                    plugOption

                        = new PluginOption(false,

                            (task, opt, arg) -> {

                                Map<String, String> m = addArgumentMap(plugin);

                                m.put(DefaultCompressPlugin.NAME, DefaultCompressPlugin.LEVEL_2);

                            }, false, "--compress", "-c");

                    mainOptions.add(plugOption);

                } else if (plugin instanceof DefaultStripDebugPlugin) {

                    plugOption

                        = new PluginOption(false,

                            (task, opt, arg) -> {

                                addArgumentMap(plugin);

                            }, false, "--strip-debug", "-G");

                    mainOptions.add(plugOption);

                } else if (plugin instanceof ExcludeJmodSectionPlugin) {

                    plugOption = new PluginOption(false, (task, opt, arg) -> {

                            Map<String, String> m = addArgumentMap(plugin);

                            m.put(ExcludeJmodSectionPlugin.NAME,

                                  ExcludeJmodSectionPlugin.MAN_PAGES);

                        }, false, "--no-man-pages");

                    mainOptions.add(plugOption);

                    plugOption = new PluginOption(false, (task, opt, arg) -> {

                        Map<String, String> m = addArgumentMap(plugin);

                        m.put(ExcludeJmodSectionPlugin.NAME,

                              ExcludeJmodSectionPlugin.INCLUDE_HEADER_FILES);

                    }, false, "--no-header-files");

                    mainOptions.add(plugOption);

                }

            }

        }

        private PluginOption getOption(String name) throws BadArgs {

            for (PluginOption o : pluginsOptions) {

                if (o.matches(name)) {

                    return o;

                }

            }

            for (PluginOption o : mainOptions) {

                if (o.matches(name)) {

                    return o;

                }

            }

            return null;

        }

        private PluginsConfiguration getPluginsConfig(Path output, Map<String, String> launchers

                    ) throws IOException, BadArgs {

            if (output != null) {

                if (Files.exists(output)) {

                    throw new PluginException(PluginsResourceBundle.

                            getMessage("err.dir.already.exits", output));

                }

            }

            List<Plugin> pluginsList = new ArrayList<>();

            Set<String> seenPlugins = new HashSet<>();

            for (Entry<Plugin, List<Map<String, String>>> entry : pluginToMaps.entrySet()) {

                Plugin plugin = entry.getKey();

                List<Map<String, String>> argsMaps = entry.getValue();

                // same plugin option may be used multiple times in command line.

                // we call configure once for each occurrence. It is upto the plugin

                // to 'merge' and/or 'override' arguments.

                for (Map<String, String> map : argsMaps) {

                    try {

                        plugin.configure(Collections.unmodifiableMap(map));

                    } catch (IllegalArgumentException e) {

                        if (JlinkTask.DEBUG) {

                            System.err.println("Plugin " + plugin.getName() + " threw exception with config: " + map);

                            e.printStackTrace();

                        }

                        throw e;

                    }

                }

                if (!Utils.isDisabled(plugin)) {

                    // make sure that --strip-debug and --strip-native-debug-symbols

                    // aren't being used at the same time. --strip-debug invokes --strip-native-debug-symbols on

                    // platforms that support it, so it makes little sense to allow both at the same time.

                    if ((plugin instanceof DefaultStripDebugPlugin && seenPlugins.contains(STRIP_NATIVE_DEBUG_SYMBOLS_NAME)) ||

                        (STRIP_NATIVE_DEBUG_SYMBOLS_NAME.equals(plugin.getName()) && seenPlugins.contains(DefaultStripDebugPlugin.NAME))) {

                        throw new BadArgs("err.plugin.conflicts", "--" + DefaultStripDebugPlugin.NAME,

                                                                "-G",

                                                                "--" + STRIP_NATIVE_DEBUG_SYMBOLS_NAME);

                    }

                    pluginsList.add(plugin);

                    seenPlugins.add(plugin.getName());

                }

            }

            // recreate or postprocessing don't require an output directory.

            ImageBuilder builder = null;

            if (output != null) {

                builder = new DefaultImageBuilder(output, launchers);

            }

            return new Jlink.PluginsConfiguration(pluginsList,

                    builder, lastSorter);

        }

    }

    private static final class ResourceBundleHelper {

        private final ResourceBundle bundle;

        private final ResourceBundle pluginBundle;

        ResourceBundleHelper(String path) {

            Locale locale = Locale.getDefault();

            try {

                bundle = ResourceBundle.getBundle(path, locale);

                pluginBundle = ResourceBundle.getBundle("jdk.tools.jlink.resources.plugins", locale);

            } catch (MissingResourceException e) {

                throw new InternalError("Cannot find jlink resource bundle for locale " + locale);

            }

        }

        String getMessage(String key, Object... args) {

            String val;

            try {

                val = bundle.getString(key);

            } catch (MissingResourceException e) {

                // XXX OK, check in plugin bundle

                val = pluginBundle.getString(key);

            }

            return MessageFormat.format(val, args);

        }

    }

    public final class OptionsHelper<T> {

        private final List<Option<T>> options;

        private String[] command;

        private String defaults;