/*

 * Copyright (c) 2015, 2016, 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.tools.jlink.internal;

import java.io.File;

import java.io.IOException;

import java.io.PrintWriter;

import java.lang.module.Configuration;

import java.lang.module.ModuleFinder;

import java.lang.reflect.Layer;

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 jdk.tools.jlink.internal.plugins.ExcludeFilesPlugin;

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

import jdk.tools.jlink.plugin.Plugin;

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

import jdk.tools.jlink.builder.DefaultImageBuilder;

import jdk.tools.jlink.builder.ImageBuilder;

import jdk.tools.jlink.plugin.PluginException;

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

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

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

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

/**

 *

 * 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> {

        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[] aliases;

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

            this.hasArg = hasArg;

            this.processing = processing;

            this.aliases = aliases;

            this.hidden = hidden;

        }

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

            this(hasArg, processing, false, aliases);

        }

        public boolean isHidden() {

            return hidden;

        }

        public boolean matches(String opt) {

            for (String a : aliases) {

                if (a.equals(opt)) {

                    return true;

                } else if (opt.startsWith("--")

                        && (hasArg && opt.startsWith(a + "="))) {

                    return true;

                }

            }

            return false;

        }

        public boolean ignoreRest() {

            return false;

        }

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

            processing.process(task, opt, arg);

        }

        public String[] aliases() {

            return aliases;

        }

    }

    private static class PlugOption extends Option<PluginsOptions> {

        public PlugOption(boolean hasArg,

                Processing<PluginsOptions> processing, boolean hidden, String... aliases) {

            super(hasArg, processing, hidden, aliases);

        }

        public PlugOption(boolean hasArg,

                Processing<PluginsOptions> processing, String... aliases) {

            super(hasArg, processing, aliases);

        }

    }

    private final class PluginsOptions {

        private static final String PLUGINS_PATH = "--plugin-module-path";

        private static final String POST_PROCESS = "--post-process-path";

        private Layer pluginsLayer = Layer.boot();

        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<PlugOption> pluginsOptions = new ArrayList<>();

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

        private PluginsOptions(String pp) throws BadArgs {

            if (pp != null) {

                String[] dirs = pp.split(File.pathSeparator);

                List<Path> paths = new ArrayList<>(dirs.length);

                for (String dir : dirs) {

                    paths.add(Paths.get(dir));

                }

                pluginsLayer = createPluginsLayer(paths);

            }

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

            for (Plugin plugin : PluginRepository.

                    getPlugins(pluginsLayer)) {

                if (!Utils.isDisabled(plugin)) {

                    addOrderedPluginOptions(plugin, optionsSeen);

                }

            }

            mainOptions.add(new PlugOption(false,

                    (task, opt, arg) -> {

                        // This option is handled prior

                        // to have the options parsed.

                    },

                    "--plugin-module-path"));

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

                Path path = Paths.get(arg);

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

                    throw newBadArgs("err.existing.image.must.exist");

                }

                existingImage = path.toAbsolutePath();

            }, true, POST_PROCESS));

            mainOptions.add(new PlugOption(true,

                    (task, opt, arg) -> {

                        lastSorter = arg;

                    },

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

            mainOptions.add(new PlugOption(false,

                    (task, opt, arg) -> {

                        listPlugins = true;

                    },

                    "--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);

            PlugOption plugOption

                    = new PlugOption(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

                                if (arg.indexOf(':') == -1) {

                                    // 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);

                                    }

                                }

                            },

                            "--" + option);

            pluginsOptions.add(plugOption);

            if (Utils.isFunctional(plugin)) {

                if (Utils.isAutoEnabled(plugin)) {

                    addEmptyArgumentMap(plugin);

                }

                if (plugin instanceof DefaultCompressPlugin) {

                    plugOption

                        = new PlugOption(false,

                            (task, opt, arg) -> {

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

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

                            }, "-c");

                    mainOptions.add(plugOption);

                } else if (plugin instanceof StripDebugPlugin) {

                    plugOption

                        = new PlugOption(false,

                            (task, opt, arg) -> {

                                addArgumentMap(plugin);

                            }, "-G");

                    mainOptions.add(plugOption);

                } else if (plugin instanceof ExcludeJmodSectionPlugin) {

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

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

                            m.put(ExcludeJmodSectionPlugin.NAME,

                                  ExcludeJmodSectionPlugin.MAN_PAGES);

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

                    mainOptions.add(plugOption);

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

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

                        m.put(ExcludeJmodSectionPlugin.NAME,

                              ExcludeJmodSectionPlugin.INCLUDE_HEADER_FILES);

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

                    mainOptions.add(plugOption);

                }

            }

        }

        private PlugOption getOption(String name) throws BadArgs {

            for (PlugOption o : pluginsOptions) {

                if (o.matches(name)) {

                    return o;

                }

            }

            for (PlugOption o : mainOptions) {

                if (o.matches(name)) {

                    return o;

                }

            }

            return null;

        }

        private PluginsConfiguration getPluginsConfig(Path output

                    ) 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<>();

            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) {

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

                }

                if (!Utils.isDisabled(plugin)) {

                    pluginsList.add(plugin);

                }

            }

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

            ImageBuilder builder = null;

            if (output != null) {

                builder = new DefaultImageBuilder(output);

            }

            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;

        OptionsHelper(List<Option<T>> options) {

            this.options = options;

        }

        private boolean hasArgument(String optionName) throws BadArgs {

            Option<?> opt = getOption(optionName);

            if (opt == null) {

                opt = pluginOptions.getOption(optionName);

                if (opt == null) {

                    throw new BadArgs("err.unknown.option", optionName).

                            showUsage(true);

                }

            }

            return opt.hasArg;

        }

        public boolean shouldListPlugins() {

            return pluginOptions.listPlugins;

        }

        private String getPluginsPath(String[] args) throws BadArgs {

            String pp = null;

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

                if (args[i].equals(PluginsOptions.PLUGINS_PATH)) {

                    if (i == args.length - 1) {

                        throw new BadArgs("err.no.plugins.path").showUsage(true);

                    } else {

                        i += 1;

                        pp = args[i];

                        if (!pp.isEmpty() && pp.charAt(0) == '-') {

                            throw new BadArgs("err.no.plugins.path").showUsage(true);

                        }

                        break;

                    }

                }

            }

            return pp;

        }

        // used by jimage. Return unhandled arguments like "create", "describe".

        public List<String> handleOptions(T task, String[] args) throws BadArgs {

            return handleOptions(task, args, true);

        }

        // used by jlink. No unhandled arguments like "create", "describe".

        void handleOptionsNoUnhandled(T task, String[] args) throws BadArgs {

            handleOptions(task, args, false);

        }

        // shared code that handles options for both jlink and jimage. jimage uses arguments like

        // "create", "describe" etc. as "task names". Those arguments are unhandled here and returned

        // as "unhandled arguments list". jlink does not want such arguments. "collectUnhandled" flag

        // tells whether to allow for unhandled arguments or not.

        private List<String> handleOptions(T task, String[] args, boolean collectUnhandled) throws BadArgs {

            // findbugs warning, copy instead of keeping a reference.

            command = Arrays.copyOf(args, args.length);

            // Must extract it prior to do any option analysis.

            // Required to interpret custom plugin options.

            // Unit tests can call Task multiple time in same JVM.

            pluginOptions = new PluginsOptions(getPluginsPath(args));

            // First extract plugins path if any

            String pp = null;

            List<String> filteredArgs = new ArrayList<>();

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

                if (args[i].equals(PluginsOptions.PLUGINS_PATH)) {

                    if (i == args.length - 1) {

                        throw new BadArgs("err.no.plugins.path").showUsage(true);

                    } else {

                        warning("warn.thirdparty.plugins.enabled");

                        log.println(bundleHelper.getMessage("warn.thirdparty.plugins"));

                        i += 1;

                        String arg = args[i];

                        if (!arg.isEmpty() && arg.charAt(0) == '-') {

                            throw new BadArgs("err.no.plugins.path").showUsage(true);

                        }

                        pp = args[i];

                    }

                } else {

                    filteredArgs.add(args[i]);

                }

            }

            String[] arr = new String[filteredArgs.size()];

            args = filteredArgs.toArray(arr);

            List<String> rest = collectUnhandled? new ArrayList<>() : null;

            // process options

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

                if (args[i].charAt(0) == '-') {

                    String name = args[i];

                    PlugOption pluginOption = null;

                    Option<T> option = getOption(name);

                    if (option == null) {

                        pluginOption = pluginOptions.getOption(name);