/*
 * Copyright (c) 2011, 2017, 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 com.sun.javafx.tools.packager;

import com.oracle.tools.packager.*;
import com.oracle.tools.packager.RelativeFileSet;
import com.oracle.tools.packager.jnlp.JNLPBundler;
import com.sun.javafx.tools.packager.bundlers.*;
import com.sun.javafx.tools.packager.bundlers.Bundler.BundleType;
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import java.util.TreeSet;

import jdk.packager.internal.legacy.JLinkBundlerHelper;

import static com.oracle.tools.packager.jnlp.JNLPBundler.*;

@Deprecated
public class DeployParams extends CommonParams {
    public enum RunMode {
        WEBSTART, EMBEDDED, STANDALONE, ALL
    }

    final List<RelativeFileSet> resources = new ArrayList<>();

    String id;
    String title;
    String vendor;
    String email;
    String description;
    String category;
    String licenseType;
    String copyright;
    String version;
    Boolean systemWide;
    Boolean serviceHint;
    Boolean signBundle;
    Boolean installdirChooser;
    Boolean singleton;

    String applicationClass;
    String preloader;

    List<Param> params;
    List<HtmlParam> htmlParams;
    List<String> arguments; //unnamed arguments

    // Java 9 modules support
    String addModules = null;
    String limitModules = null;
    Boolean stripNativeCommands = null;
    Boolean detectmods = null;
    String modulePath = null;
    String module = null;
    String debugPort = null;
    String srcdir;

    int width;
    int height;
    String embeddedWidth = null;
    String embeddedHeight = null;

    String appName;
    String codebase;

    boolean embedJNLP = true;
    @Deprecated final boolean embedCertificates = false;
    boolean allPermissions = false;
    String updateMode = "background";
    boolean isExtension = false;
    boolean isSwingApp = false;

    Boolean needShortcut = null;
    Boolean needMenu = null;
    Boolean needInstall = null;

    String outfile;
    //if true then we cobundle js and image files needed
    // for web deployment with the application
    boolean includeDT;

    String placeholder = "'javafx-app-placeholder'";
    String appId = null;

    // didn't have a setter...
    boolean offlineAllowed = true;

    List<JSCallback> callbacks = null;

    //list of HTML templates to process
    List<Template> templates = new LinkedList<>();

    String jrePlatform = PackagerLib.JAVAFX_VERSION+"+";
    String fxPlatform = PackagerLib.JAVAFX_VERSION+"+";
    File javaRuntimeToUse = null;
    boolean javaRuntimeWasSet = false;

    //list of jvm args (in theory string can contain spaces and need to be escaped
    List<String> jvmargs = new LinkedList<>();
    Map<String, String> jvmUserArgs = new LinkedHashMap<>();

    //list of jvm properties (can also be passed as VM args
    // but keeping them separate make it a bit more convinient for JNLP generation)
    Map<String, String> properties = new LinkedHashMap<>();

    // raw arguments to the bundler
    Map<String, ? super Object> bundlerArguments = new LinkedHashMap<>();

    String fallbackApp = null;

    public void setJavaRuntimeSource(File src) {
        javaRuntimeToUse = src;
        javaRuntimeWasSet = true;
    }

    public void setCodebase(String codebase) {
        this.codebase = codebase;
    }

    public void setId(String id) {
        this.id = id;
    }

    public void setCategory(String category) {
        this.category = category;
    }

    public void setLicenseType(String licenseType) {
        this.licenseType = licenseType;
    }

    public void setCopyright(String copyright) {
        this.copyright = copyright;
    }

    public void setVersion(String version) {
        this.version = version;
    }

    public void setSystemWide(Boolean systemWide) {
        this.systemWide = systemWide;
    }

    public void setServiceHint(Boolean serviceHint) {
        this.serviceHint = serviceHint;
    }

    public void setInstalldirChooser(Boolean installdirChooser) {
        this.installdirChooser = installdirChooser;
    }

    public void setSingleton(Boolean singleton) {
        this.singleton = singleton;
    }

    public void setSignBundle(Boolean signBundle) {
        this.signBundle = signBundle;
    }

    public void setJRE(String v) {
        jrePlatform = v;
    }

    public void setSwingAppWithEmbeddedJavaFX(boolean v) {
        isSwingApp = v;
    }

    public void setNeedInstall(boolean b) {
        needInstall = b;
    }

    public void setOfflineAllowed(boolean b) {
        offlineAllowed = b;
    }

    public void setNeedShortcut(Boolean b) {
        needShortcut = b;
    }

    public void setNeedMenu(Boolean b) {
        needMenu = b;
    }

    public void setEmbeddedDimensions(String w, String h) {
        embeddedWidth = w;
        embeddedHeight = h;
    }

    public void setFallback(String v) {
        if (v == null) {
            return;
        }

        if ("none".equals(v) || "null".equals(v)) {
            fallbackApp = null;
        } else {
            fallbackApp = v;
        }
    }

    public void setJavafx(String v) {
        fxPlatform = v;
    }

    public void addJvmArg(String v) {
        jvmargs.add(v);
    }

    public void addJvmUserArg(String n, String v) {
        jvmUserArgs.put(n, v);
    }

    public void addJvmProperty(String n, String v) {
        properties.put(n, v);
    }

    public void setAllPermissions(boolean allPermissions) {
        this.allPermissions = allPermissions;
    }

    public void setAppName(String appName) {
        this.appName = appName;
    }

    public void setArguments(List<String> args) {
        this.arguments = args;
    }

    public void addAddModule(String value) {
        if (addModules == null) {
            addModules = value;
        }
        else {
            addModules += "," + value;
        }
    }

    public void addLimitModule(String value) {
        if (limitModules == null) {
            limitModules = value;
        }
        else {
            limitModules += "," + value;
        }
    }

    public void setModulePath(String value) {
        this.modulePath = value;
    }

    public void setModule(String value) {
        this.module = value;
    }

    public void setDebug(String value) {
        this.debugPort = value;
    }

    public void setStripNativeCommands(boolean value) {
        this.stripNativeCommands = value;
    }

    public void setDetectModules(boolean value) {
        this.detectmods = value;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public void setEmbedJNLP(boolean embedJNLP) {
        this.embedJNLP = embedJNLP;
    }

    @Deprecated
    public void setEmbedCertifcates(boolean v) {
        if (v) {
            System.out.println("JavaFX Packager no longer supports embedding certificates in JNLP files.  Setting will be ignored.");
        }
    }

    public void setPlaceholder(String p) {
        placeholder = p;
    }

    public void setAppId(String id) {
        appId = id;
    }

    public void setHeight(int height) {
        this.height = height;
    }

    public void setHtmlParams(List<HtmlParam> htmlParams) {
        this.htmlParams = htmlParams;
    }

    public void setOutfile(String outfile) {
        this.outfile = outfile;
    }

    public void setParams(List<Param> params) {
        this.params = params;
    }

    public void setPreloader(String preloader) {
        this.preloader = preloader;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public void setUpdateMode(String updateMode) {
        this.updateMode = updateMode;
    }

    public void setVendor(String vendor) {
        this.vendor = vendor;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public void setWidth(int width) {
        this.width = width;
    }

    public void setExtension(boolean isExtension) {
        this.isExtension = isExtension;
    }

    public void setApplicationClass(String applicationClass) {
        this.applicationClass = applicationClass;
    }

    public void setIncludeDT(boolean doEmbed) {
        includeDT = doEmbed;
    }

    public void setJSCallbacks(List<JSCallback> list) {
        callbacks = list;
    }

    public void addCallback(String name, String cmd) {
        if (callbacks == null) {
            callbacks = new ArrayList<>();
        }

        callbacks.add(new JSCallback(name, cmd));
    }

    static class Template {
        File in;
        File out;

        Template(File in, File out) {
            this.in = in;
            this.out = out;
        }
    }

    public void addTemplate(File in, File out) {
        templates.add(new Template(in, out));
    }

    //we need to expand as in some cases
    // (most notably javapackager)
    //we may get "." as filename and assumption is we include
    // everything in the given folder
    // (IOUtils.copyfiles() have recursive behavior)
    List<File> expandFileset(File root) {
        List<File> files = new LinkedList<>();
        if (com.oracle.tools.packager.IOUtils.isNotSymbolicLink(root)) {
            if (root.isDirectory()) {
                File[] children = root.listFiles();
                if (children != null) {
                    for (File f : children) {
                        files.addAll(expandFileset(f));
                    }
                }
            } else {
                files.add(root);
            }
        }
        return files;
    }

    @Override
    public void addResource(File baseDir, String path) {
        File file = new File(baseDir, path);
        //normalize top level dir
        // to strip things like "." in the path
        // or it can confuse symlink detection logic
        file = file.getAbsoluteFile();

        if (baseDir == null) {
            baseDir = file.getParentFile();
        }
        resources.add(new RelativeFileSet(baseDir, new LinkedHashSet<>(expandFileset(file))));
    }

    @Override
    public void addResource(File baseDir, File file) {
        //normalize initial file
        // to strip things like "." in the path
        // or it can confuse symlink detection logic
        file = file.getAbsoluteFile();

        if (baseDir == null) {
            baseDir = file.getParentFile();
        }
        resources.add(new RelativeFileSet(baseDir, new LinkedHashSet<>(expandFileset(file))));
    }

    public void addResource(File baseDir, String path, String type) {
        addResource(baseDir, createFile(baseDir, path), type);
    }

    public void addResource(File baseDir, File file, String type) {
        addResource(baseDir, file, "eager", type, null, null);
    }

    public void addResource(File baseDir, File file, String mode, String type, String os, String arch) {
        Set<File> singleFile = new LinkedHashSet<>();
        singleFile.add(file);
        if (baseDir == null) {
            baseDir = file.getParentFile();
        }
        RelativeFileSet rfs = new RelativeFileSet(baseDir, singleFile);
        rfs.setArch(arch);
        rfs.setMode(mode);
        rfs.setOs(os);
        rfs.setType(parseTypeFromString(type, file));
        resources.add(rfs);
    }

    private RelativeFileSet.Type parseTypeFromString(String type, File file) {
        if (type == null) {
            if (file.getName().endsWith(".jar")) {
                return RelativeFileSet.Type.jar;
            } else if (file.getName().endsWith(".jnlp")) {
                return RelativeFileSet.Type.jnlp;
            } else {
                return RelativeFileSet.Type.UNKNOWN;
            }
        } else {
            return RelativeFileSet.Type.valueOf(type);
        }
    }

    private static File createFile(final File baseDir, final String path) {
        final File testFile = new File(path);
        return testFile.isAbsolute()
                ? testFile
                : new File(baseDir == null
                    ? null
                    : baseDir.getAbsolutePath(),
                      path);
    }


    @Override
    public void validate() throws PackagerException {
        if (outdir == null) {
            throw new PackagerException("ERR_MissingArgument", "-outdir");
        }

        if (getBundleType() == BundleType.JNLP && outfile == null) {
            throw new PackagerException("ERR_MissingArgument", "-outfile");
        }

        if (module == null) {
            if (resources.isEmpty()) {
                throw new PackagerException("ERR_MissingAppResources");
            }
            if (applicationClass == null) {
                throw new PackagerException("ERR_MissingArgument", "-appclass");
            }
        }
    }

    public boolean validateForJNLP() {
        boolean result = false;

        // Success
        if (applicationClass != null && !applicationClass.isEmpty() &&
            (getBundleType() == BundleType.JNLP)) {
            result = true;
        }

        // Failed
        if ((module != null && !module.isEmpty()) ||
            (addModules != null && !addModules.isEmpty()) ||
            (limitModules != null && !limitModules.isEmpty()) |
            (modulePath != null && !modulePath.isEmpty()) ||
            getBundleType() == BundleType.INSTALLER ||
            getBundleType() == BundleType.NATIVE ||
            getBundleType() == BundleType.IMAGE) {

            result = false;
        }

        return result;
    }

    public boolean validateForBundle() {
        boolean result = false;

        // Success
        if (((applicationClass != null && !applicationClass.isEmpty()) ||
            (module != null && !module.isEmpty()))) {
            result = true;
        }

        return result;
    }

    //could be icon or splash
    static class Icon {
        final static int UNDEFINED = -1;

        String href;
        String kind;
        int width = UNDEFINED;
        int height = UNDEFINED;
        int depth = UNDEFINED;
        RunMode mode = RunMode.WEBSTART;

        Icon(String href, String kind, int w, int h, int d, RunMode m) {
            mode = m;
            this.href = href;
            this.kind = kind;
            if (w > 0) {
                width = w;
            }
            if (h > 0) {
                height = h;
            }
            if (d > 0) {
                depth = d;
            }
        }
    }

    List<Icon> icons = new LinkedList<>();

    public void addIcon(String href, String kind, int w, int h, int d, RunMode m) {
        icons.add(new Icon(href, kind, w, h, d, m));
    }

    BundleType bundleType = BundleType.NONE;
    String targetFormat = null; //means any

    public void setBundleType(BundleType type) {
        bundleType = type;
    }

    public BundleType getBundleType() {
        return bundleType;
    }

    public void setTargetFormat(String t) {
        targetFormat = t;
    }

    public String getTargetFormat() {
        return targetFormat;
    }

    private String getArch() {
        String arch = System.getProperty("os.arch").toLowerCase();

        if ("x86".equals(arch) || "i386".equals(arch) || "i486".equals(arch)
                || "i586".equals(arch) || "i686".equals(arch)) {
            arch = "x86";
        } else if ("x86_64".equals(arch) || "amd64".equals("arch")) {
            arch = "x86_64";
        }

        return arch;
    }

    static final Set<String> multi_args = new TreeSet<>(Arrays.asList(
            StandardBundlerParam.JVM_PROPERTIES.getID(),
            StandardBundlerParam.JVM_OPTIONS.getID(),
            StandardBundlerParam.USER_JVM_OPTIONS.getID(),
            StandardBundlerParam.ARGUMENTS.getID(),
            StandardBundlerParam.MODULE_PATH.getID(),
            StandardBundlerParam.ADD_MODULES.getID(),
            StandardBundlerParam.LIMIT_MODULES.getID(),
            StandardBundlerParam.STRIP_NATIVE_COMMANDS.getID(),
            JLinkBundlerHelper.DETECT_MODULES.getID()
    ));

    @SuppressWarnings("unchecked")
    public void addBundleArgument(String key, Object value) {
        // special hack for multi-line arguments
        if (multi_args.contains(key) && value instanceof String) {
            Object existingValue = bundlerArguments.get(key);
            if (existingValue instanceof String) {
                bundlerArguments.put(key, existingValue + "\n\n" + value);
            } else if (existingValue instanceof List) {
                ((List)existingValue).add(value);
            } else if (existingValue instanceof Map && ((String)value).contains("=")) {
                String[] mapValues = ((String)value).split("=", 2);
                ((Map)existingValue).put(mapValues[0], mapValues[1]);
            } else {
                bundlerArguments.put(key, value);
            }
        } else {
            bundlerArguments.put(key, value);
        }
    }

    public BundleParams getBundleParams() {
        BundleParams bundleParams = new BundleParams();

        //construct app resources
        //  relative to output folder!
        String currentOS = System.getProperty("os.name").toLowerCase();
        String currentArch = getArch();

        for (RelativeFileSet rfs : resources) {
            String os = rfs.getOs();
            String arch = rfs.getArch();
            //skip resources for other OS
            // and nativelib jars (we are including raw libraries)
            if ((os == null || currentOS.contains(os.toLowerCase())) &&
                    (arch == null || currentArch.startsWith(arch.toLowerCase()))
                    && rfs.getType() != RelativeFileSet.Type.nativelib) {
                if (rfs.getType() == RelativeFileSet.Type.license) {
                    for (String s : rfs.getIncludedFiles()) {
                        bundleParams.addLicenseFile(s);
                    }
                }
            }
        }

        bundleParams.setAppResourcesList(resources);

        bundleParams.setIdentifier(id);

        if (javaRuntimeWasSet) {
            bundleParams.setRuntime(javaRuntimeToUse);
        }
        bundleParams.setApplicationClass(applicationClass);
        bundleParams.setPrelaoderClass(preloader);
        bundleParams.setName(this.appName);
        bundleParams.setAppVersion(version);
        bundleParams.setType(bundleType);
        bundleParams.setBundleFormat(targetFormat);
        bundleParams.setVendor(vendor);
        bundleParams.setEmail(email);
        bundleParams.setShortcutHint(needShortcut);
        bundleParams.setMenuHint(needMenu);
        putUnlessNull(INSTALL_HINT.getID(), needInstall);
        bundleParams.setSystemWide(systemWide);
        bundleParams.setServiceHint(serviceHint);
        bundleParams.setInstalldirChooser(installdirChooser);
        bundleParams.setSingleton(singleton);
        bundleParams.setSignBundle(signBundle);
        bundleParams.setCopyright(copyright);
        bundleParams.setApplicationCategory(category);
        bundleParams.setLicenseType(licenseType);
        bundleParams.setDescription(description);
        bundleParams.setTitle(title);
        if (verbose) bundleParams.setVerbose(true);

        bundleParams.setJvmProperties(properties);
        bundleParams.setJvmargs(jvmargs);
        bundleParams.setJvmUserArgs(jvmUserArgs);
        bundleParams.setArguments(arguments);

        if (addModules != null && !addModules.isEmpty()) {
            bundleParams.setAddModules(addModules);
        }

        if (limitModules != null && !limitModules.isEmpty()) {
            bundleParams.setLimitModules(limitModules);
        }

        if (stripNativeCommands != null) {
            bundleParams.setStripNativeCommands(stripNativeCommands);
        }

        bundleParams.setSrcDir(srcdir);

        if (modulePath != null && !modulePath.isEmpty()) {
            bundleParams.setModulePath(modulePath);
        }

        if (module != null && !module.isEmpty()) {
            bundleParams.setMainModule(module);
        }

        if (debugPort != null && !debugPort.isEmpty()) {
            bundleParams.setDebug(debugPort);
        }

        if (detectmods != null) {
            bundleParams.setDetectMods(detectmods);
        }

        File appIcon = null;
        List<Map<String, ? super Object>> bundlerIcons = new ArrayList<>();
        for (Icon ic: icons) {
            //NB: in theory we should be paying attention to RunMode but
            // currently everything is marked as webstart internally and runmode
            // is not publicly documented property
            if (/* (ic.mode == RunMode.ALL || ic.mode == RunMode.STANDALONE) && */
                (ic.kind == null || ic.kind.equals("default")))
            {
                //could be full path or something relative to the output folder
                appIcon = new File(ic.href);
                if (!appIcon.exists()) {
                    com.oracle.tools.packager.Log.debug("Icon [" + ic.href + "] is not valid absolute path. " +
                            "Assume it is relative to the output dir.");
                    appIcon = new File(outdir, ic.href);
                }
            }

            Map<String, ? super Object> iconInfo = new TreeMap<>();
            if (ic.href != null) iconInfo.put(ICONS_HREF.getID(), ic.href);
            if (ic.kind != null) iconInfo.put(ICONS_KIND.getID(), ic.kind);
            if (ic.width > 0)    iconInfo.put(ICONS_WIDTH.getID(), Integer.toString(ic.width));
            if (ic.height > 0)   iconInfo.put(ICONS_HEIGHT.getID(), Integer.toString(ic.height));
            if (ic.depth > 0)    iconInfo.put(ICONS_DEPTH.getID(), Integer.toString(ic.depth));

            if (!iconInfo.isEmpty()) bundlerIcons.add(iconInfo);
        }
        putUnlessNullOrEmpty(ICONS.getID(), bundlerIcons);

        bundleParams.setIcon(appIcon);

        Map<String, String> paramsMap = new TreeMap<>();
        if (params != null) {
            for (Param p : params) {
                paramsMap.put(p.name, p.value);
            }
        }
        putUnlessNullOrEmpty(JNLPBundler.APP_PARAMS.getID(), paramsMap);

        Map<String, String> unescapedHtmlParams = new TreeMap<>();
        Map<String, String> escapedHtmlParams = new TreeMap<>();
        if (htmlParams != null) {
            for (HtmlParam hp : htmlParams) {
                if (hp.needEscape) {
                    escapedHtmlParams.put(hp.name, hp.value);
                } else {
                    unescapedHtmlParams.put(hp.name, hp.value);
                }
            }
        }
        putUnlessNullOrEmpty(JNLPBundler.APPLET_PARAMS.getID(), unescapedHtmlParams);
        putUnlessNullOrEmpty(ESCAPED_APPLET_PARAMS.getID(), escapedHtmlParams);


        putUnlessNull(WIDTH.getID(), width);
        putUnlessNull(HEIGHT.getID(), height);
        putUnlessNull(EMBEDDED_WIDTH.getID(), embeddedWidth);
        putUnlessNull(EMBEDDED_HEIGHT.getID(), embeddedHeight);

        putUnlessNull(CODEBASE.getID(), codebase);
        putUnlessNull(EMBED_JNLP.getID(), embedJNLP);
        // embedCertificates
        putUnlessNull(ALL_PERMISSIONS.getID(), allPermissions);
        putUnlessNull(UPDATE_MODE.getID(), updateMode);
        putUnlessNull(EXTENSION.getID(), isExtension);
        putUnlessNull(SWING_APP.getID(), isSwingApp);

        putUnlessNull(OUT_FILE.getID(), outfile);
        putUnlessNull(INCLUDE_DT.getID(), includeDT);
        putUnlessNull(PLACEHOLDER.getID(), placeholder);
        putUnlessNull(OFFLINE_ALLOWED.getID(), offlineAllowed);

        Map<String, String> callbacksMap = new TreeMap<>();
        if (callbacks != null) {
            for (JSCallback callback : callbacks) {
                callbacksMap.put(callback.getName(), callback.getCmd());
            }
        }
        putUnlessNull(JS_CALLBACKS.getID(), callbacksMap);

        Map<File, File> templatesMap = new TreeMap<>();
        if (templates != null) {
            for (Template template : templates) {
                templatesMap.put(template.in, template.out);
            }
        }
        putUnlessNull(TEMPLATES.getID(), templatesMap);

        putUnlessNull(FX_PLATFORM.getID(), fxPlatform);
        putUnlessNull(JRE_PLATFORM.getID(), jrePlatform);

        putUnlessNull(FALLBACK_APP.getID(), fallbackApp);

        // check for collisions
        TreeSet<String> keys = new TreeSet<>(bundlerArguments.keySet());
        keys.retainAll(bundleParams.getBundleParamsAsMap().keySet());

        if (!keys.isEmpty()) {
            throw new RuntimeException("Deploy Params and Bundler Arguments overlap in the following values:" + keys.toString());
        }

        bundleParams.addAllBundleParams(bundlerArguments);

        return bundleParams;
    }

    public void putUnlessNull(String param, Object value) {
        if (value != null) {
            bundlerArguments.put(param, value);
        }
    }

    public void putUnlessNullOrEmpty(String param, Map<?, ?> value) {
        if (value != null && !value.isEmpty()) {
            bundlerArguments.put(param, value);
        }
    }

    public void putUnlessNullOrEmpty(String param, Collection<?> value) {
        if (value != null && !value.isEmpty()) {
            bundlerArguments.put(param, value);
        }
    }
}