/*

 * Copyright (c) 2014, 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.File;

import java.io.IOException;

import java.lang.module.ModuleDescriptor;

import java.lang.module.ModuleDescriptor.Version;

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.Date;

import java.util.LinkedHashSet;

import java.util.List;

import java.util.Map;

import java.util.Optional;

import java.util.ResourceBundle;

import java.util.Set;

import java.util.HashSet;

import java.util.function.BiFunction;

import java.util.function.Function;

import java.util.jar.Attributes;

import java.util.jar.JarFile;

import java.util.jar.Manifest;

import java.util.stream.Collectors;

/**

 * StandardBundlerParam

 *

 * A parameter to a bundler.

 *

 * Also contains static definitions of all of the common bundler parameters.

 * (additional platform specific and mode specific bundler parameters

 * are defined in each of the specific bundlers)

 *

 * Also contains static methods that operate on maps of parameters.

 */

class StandardBundlerParam<T> extends BundlerParamInfo<T> {

    private static final ResourceBundle I18N = ResourceBundle.getBundle(

            "jdk.jpackage.internal.resources.MainResources");

    private static final String JAVABASEJMOD = "java.base.jmod";

    private final static String DEFAULT_VERSION = "1.0";

    private final static String DEFAULT_RELEASE = "1";

    StandardBundlerParam(String id, Class<T> valueType,

            Function<Map<String, ? super Object>, T> defaultValueFunction,

            BiFunction<String, Map<String, ? super Object>, T> stringConverter)

    {

        this.id = id;

        this.valueType = valueType;

        this.defaultValueFunction = defaultValueFunction;

        this.stringConverter = stringConverter;

    }

    static final StandardBundlerParam<RelativeFileSet> APP_RESOURCES =

            new StandardBundlerParam<>(

                    BundleParams.PARAM_APP_RESOURCES,

                    RelativeFileSet.class,

                    null, // no default.  Required parameter

                    null  // no string translation,

                          // tool must provide complex type

            );

    @SuppressWarnings("unchecked")

    static final

            StandardBundlerParam<List<RelativeFileSet>> APP_RESOURCES_LIST =

            new StandardBundlerParam<>(

                    BundleParams.PARAM_APP_RESOURCES + "List",

                    (Class<List<RelativeFileSet>>) (Object) List.class,

                    // Default is appResources, as a single item list

                    p -> new ArrayList<>(Collections.singletonList(

                            APP_RESOURCES.fetchFrom(p))),

                    StandardBundlerParam::createAppResourcesListFromString

            );

    static final StandardBundlerParam<String> SOURCE_DIR =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.INPUT.getId(),

                    String.class,

                    p -> null,

                    (s, p) -> {

                        String value = String.valueOf(s);

                        if (value.charAt(value.length() - 1) ==

                                File.separatorChar) {

                            return value.substring(0, value.length() - 1);

                        }

                        else {

                            return value;

                        }

                    }

            );

    // note that each bundler is likely to replace this one with

    // their own converter

    static final StandardBundlerParam<RelativeFileSet> MAIN_JAR =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.MAIN_JAR.getId(),

                    RelativeFileSet.class,

                    params -> {

                        extractMainClassInfoFromAppResources(params);

                        return (RelativeFileSet) params.get("mainJar");

                    },

                    (s, p) -> getMainJar(s, p)

            );

    static final StandardBundlerParam<String> CLASSPATH =

            new StandardBundlerParam<>(

                    "classpath",

                    String.class,

                    params -> {

                        extractMainClassInfoFromAppResources(params);

                        String cp = (String) params.get("classpath");

                        return cp == null ? "" : cp;

                    },

                    (s, p) -> s

            );

    static final StandardBundlerParam<String> MAIN_CLASS =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.APPCLASS.getId(),

                    String.class,

                    params -> {

                        if (isRuntimeInstaller(params)) {

                            return null;

                        }

                        extractMainClassInfoFromAppResources(params);

                        String s = (String) params.get(

                                BundleParams.PARAM_APPLICATION_CLASS);

                        if (s == null) {

                            s = JLinkBundlerHelper.getMainClass(params);

                            if (s.length() == 0) {

                                s = null;

                            }

                        }

                        return s;

                    },

                    (s, p) -> s

            );

    static final StandardBundlerParam<File> PREDEFINED_RUNTIME_IMAGE =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.PREDEFINED_RUNTIME_IMAGE.getId(),

                    File.class,

                    params -> null,

                    (s, p) -> new File(s)

            );

    static final StandardBundlerParam<String> APP_NAME =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.NAME.getId(),

                    String.class,

                    params -> {

                        String s = MAIN_CLASS.fetchFrom(params);

                        if (s != null) {

                            int idx = s.lastIndexOf(".");

                            if (idx >= 0) {

                                return s.substring(idx+1);

                            }

                            return s;

                        } else if (isRuntimeInstaller(params)) {

                            File f = PREDEFINED_RUNTIME_IMAGE.fetchFrom(params);

                            if (f != null) {

                                return f.getName();

                            }

                        }

                        return null;

                    },

                    (s, p) -> s

            );

    static final StandardBundlerParam<File> ICON =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.ICON.getId(),

                    File.class,

                    params -> null,

                    (s, p) -> new File(s)

            );

    static final StandardBundlerParam<String> VENDOR =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.VENDOR.getId(),

                    String.class,

                    params -> I18N.getString("param.vendor.default"),

                    (s, p) -> s

            );

    static final StandardBundlerParam<String> DESCRIPTION =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.DESCRIPTION.getId(),

                    String.class,

                    params -> params.containsKey(APP_NAME.getID())

                            ? APP_NAME.fetchFrom(params)

                            : I18N.getString("param.description.default"),

                    (s, p) -> s

            );

    static final StandardBundlerParam<String> COPYRIGHT =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.COPYRIGHT.getId(),

                    String.class,

                    params -> MessageFormat.format(I18N.getString(

                            "param.copyright.default"), new Date()),

                    (s, p) -> s

            );

    @SuppressWarnings("unchecked")

    static final StandardBundlerParam<List<String>> ARGUMENTS =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.ARGUMENTS.getId(),

                    (Class<List<String>>) (Object) List.class,

                    params -> Collections.emptyList(),

                    (s, p) -> null

            );

    @SuppressWarnings("unchecked")

    static final StandardBundlerParam<List<String>> JAVA_OPTIONS =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.JAVA_OPTIONS.getId(),

                    (Class<List<String>>) (Object) List.class,

                    params -> Collections.emptyList(),

                    (s, p) -> Arrays.asList(s.split("\n\n"))

            );

    // note that each bundler is likely to replace this one with

    // their own converter

    static final StandardBundlerParam<String> VERSION =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.VERSION.getId(),

                    String.class,

                    params -> getDefaultAppVersion(params),

                    (s, p) -> s

            );

    static final StandardBundlerParam<String> RELEASE =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.RELEASE.getId(),

                    String.class,

                    params -> DEFAULT_RELEASE,

                    (s, p) -> s

            );

    @SuppressWarnings("unchecked")

    public static final StandardBundlerParam<String> LICENSE_FILE =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.LICENSE_FILE.getId(),

                    String.class,

                    params -> null,

                    (s, p) -> s

            );

    static final StandardBundlerParam<File> TEMP_ROOT =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.TEMP_ROOT.getId(),

                    File.class,

                    params -> {

                        try {

                            return Files.createTempDirectory(

                                    "jdk.jpackage").toFile();

                        } catch (IOException ioe) {

                            return null;

                        }

                    },

                    (s, p) -> new File(s)

            );

    public static final StandardBundlerParam<File> CONFIG_ROOT =

            new StandardBundlerParam<>(

                "configRoot",

                File.class,

                params -> {

                    File root =

                            new File(TEMP_ROOT.fetchFrom(params), "config");

                    root.mkdirs();

                    return root;

                },

                (s, p) -> null

            );

    static final StandardBundlerParam<String> IDENTIFIER =

            new StandardBundlerParam<>(

                    "identifier.default",

                    String.class,

                    params -> {

                        String s = MAIN_CLASS.fetchFrom(params);

                        if (s == null) return null;

                        int idx = s.lastIndexOf(".");

                        if (idx >= 1) {

                            return s.substring(0, idx);

                        }

                        return s;

                    },

                    (s, p) -> s

            );

    static final StandardBundlerParam<Boolean> VERBOSE  =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.VERBOSE.getId(),

                    Boolean.class,

                    params -> false,

                    // valueOf(null) is false, and we actually do want null

                    (s, p) -> (s == null || "null".equalsIgnoreCase(s)) ?

                            true : Boolean.valueOf(s)

            );

    static final StandardBundlerParam<File> RESOURCE_DIR =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.RESOURCE_DIR.getId(),

                    File.class,

                    params -> null,

                    (s, p) -> new File(s)

            );

    static final BundlerParamInfo<String> INSTALL_DIR =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.INSTALL_DIR.getId(),

                    String.class,

                     params -> null,

                    (s, p) -> s

    );

    static final StandardBundlerParam<File> PREDEFINED_APP_IMAGE =

            new StandardBundlerParam<>(

            Arguments.CLIOptions.PREDEFINED_APP_IMAGE.getId(),

            File.class,

            params -> null,

            (s, p) -> new File(s));

    @SuppressWarnings("unchecked")

    static final StandardBundlerParam<List<Map<String, ? super Object>>> ADD_LAUNCHERS =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.ADD_LAUNCHER.getId(),

                    (Class<List<Map<String, ? super Object>>>) (Object)

                            List.class,

                    params -> new ArrayList<>(1),

                    // valueOf(null) is false, and we actually do want null

                    (s, p) -> null

            );

    @SuppressWarnings("unchecked")

    static final StandardBundlerParam

            <List<Map<String, ? super Object>>> FILE_ASSOCIATIONS =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.FILE_ASSOCIATIONS.getId(),

                    (Class<List<Map<String, ? super Object>>>) (Object)

                            List.class,

                    params -> new ArrayList<>(1),

                    // valueOf(null) is false, and we actually do want null

                    (s, p) -> null

            );

    @SuppressWarnings("unchecked")

    static final StandardBundlerParam<List<String>> FA_EXTENSIONS =

            new StandardBundlerParam<>(

                    "fileAssociation.extension",

                    (Class<List<String>>) (Object) List.class,

                    params -> null, // null means not matched to an extension

                    (s, p) -> Arrays.asList(s.split("(,|\\s)+"))

            );

    @SuppressWarnings("unchecked")

    static final StandardBundlerParam<List<String>> FA_CONTENT_TYPE =

            new StandardBundlerParam<>(

                    "fileAssociation.contentType",

                    (Class<List<String>>) (Object) List.class,

                    params -> null,

                            // null means not matched to a content/mime type

                    (s, p) -> Arrays.asList(s.split("(,|\\s)+"))

            );

    static final StandardBundlerParam<String> FA_DESCRIPTION =

            new StandardBundlerParam<>(

                    "fileAssociation.description",

                    String.class,

                    params -> APP_NAME.fetchFrom(params) + " File",

                    null

            );

    static final StandardBundlerParam<File> FA_ICON =

            new StandardBundlerParam<>(

                    "fileAssociation.icon",

                    File.class,

                    ICON::fetchFrom,

                    (s, p) -> new File(s)

            );

    @SuppressWarnings("unchecked")

    static final BundlerParamInfo<List<Path>> MODULE_PATH =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.MODULE_PATH.getId(),

                    (Class<List<Path>>) (Object)List.class,

                    p -> { return getDefaultModulePath(); },

                    (s, p) -> {

                        List<Path> modulePath = Arrays.asList(s

                                .split(File.pathSeparator)).stream()

                                .map(ss -> new File(ss).toPath())

                                .collect(Collectors.toList());

                        Path javaBasePath = null;

                        if (modulePath != null) {

                            javaBasePath = JLinkBundlerHelper

                                    .findPathOfModule(modulePath, JAVABASEJMOD);

                        } else {

                            modulePath = new ArrayList<Path>();

                        }

                        // Add the default JDK module path to the module path.

                        if (javaBasePath == null) {

                            List<Path> jdkModulePath = getDefaultModulePath();

                            if (jdkModulePath != null) {

                                modulePath.addAll(jdkModulePath);

                                javaBasePath =

                                        JLinkBundlerHelper.findPathOfModule(

                                        modulePath, JAVABASEJMOD);

                            }

                        }

                        if (javaBasePath == null ||

                                !Files.exists(javaBasePath)) {

                            Log.error(String.format(I18N.getString(

                                    "warning.no.jdk.modules.found")));

                        }

                        return modulePath;

                    });

    static final BundlerParamInfo<String> MODULE =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.MODULE.getId(),

                    String.class,

                    p -> null,

                    (s, p) -> {

                        return String.valueOf(s);

                    });

    @SuppressWarnings("unchecked")

    static final BundlerParamInfo<Set<String>> ADD_MODULES =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.ADD_MODULES.getId(),

                    (Class<Set<String>>) (Object) Set.class,

                    p -> new LinkedHashSet<String>(),

                    (s, p) -> new LinkedHashSet<>(Arrays.asList(s.split(",")))

            );

    @SuppressWarnings("unchecked")

    static final BundlerParamInfo<Set<String>> LIMIT_MODULES =

            new StandardBundlerParam<>(

                    "limit-modules",

                    (Class<Set<String>>) (Object) Set.class,

                    p -> new LinkedHashSet<String>(),

                    (s, p) -> new LinkedHashSet<>(Arrays.asList(s.split(",")))

            );

    static boolean isRuntimeInstaller(Map<String, ? super Object> params) {

        if (params.containsKey(MODULE.getID()) ||

                params.containsKey(MAIN_JAR.getID()) ||

                params.containsKey(PREDEFINED_APP_IMAGE.getID())) {

            return false; // we are building or are given an application

        }

        // runtime installer requires --runtime-image, if this is false

        // here then we should have thrown error validating args.

        return params.containsKey(PREDEFINED_RUNTIME_IMAGE.getID());

    }

    static File getPredefinedAppImage(Map<String, ? super Object> params) {

        File applicationImage = null;

        if (PREDEFINED_APP_IMAGE.fetchFrom(params) != null) {

            applicationImage = PREDEFINED_APP_IMAGE.fetchFrom(params);

            if (!applicationImage.exists()) {

                throw new RuntimeException(

                        MessageFormat.format(I18N.getString(

                                "message.app-image-dir-does-not-exist"),

                                PREDEFINED_APP_IMAGE.getID(),

                                applicationImage.toString()));

            }

        }