/*

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

import java.nio.charset.Charset;

import java.nio.file.Files;

import java.text.MessageFormat;

import java.util.*;

import static jdk.jpackage.internal.WindowsBundlerParam.*;

public class WinExeBundler extends AbstractBundler {

    private static final ResourceBundle I18N = ResourceBundle.getBundle(

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

    public static final BundlerParamInfo<WinAppBundler> APP_BUNDLER =

            new WindowsBundlerParam<>(

            "win.app.bundler",

            WinAppBundler.class,

            params -> new WinAppBundler(),

            null);

    public static final BundlerParamInfo<File> EXE_IMAGE_DIR =

            new WindowsBundlerParam<>(

            "win.exe.imageDir",

            File.class,

            params -> {

                File imagesRoot = IMAGES_ROOT.fetchFrom(params);

                if (!imagesRoot.exists()) imagesRoot.mkdirs();

                return new File(imagesRoot, "win-exe.image");

            },

            (s, p) -> null);

    public static final BundlerParamInfo<File> WIN_APP_IMAGE =

            new WindowsBundlerParam<>(

            "win.app.image",

            File.class,

            null,

            (s, p) -> null);

    public static final BundlerParamInfo<UUID> UPGRADE_UUID =

            new WindowsBundlerParam<>(

            Arguments.CLIOptions.WIN_UPGRADE_UUID.getId(),

            UUID.class,

            params -> UUID.randomUUID(),

            (s, p) -> UUID.fromString(s));

    public static final StandardBundlerParam<Boolean> EXE_SYSTEM_WIDE  =

            new StandardBundlerParam<>(

            Arguments.CLIOptions.WIN_PER_USER_INSTALLATION.getId(),

            Boolean.class,

            params -> true, // default to system wide

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

                    : Boolean.valueOf(s)

            );

    public static final StandardBundlerParam<String> PRODUCT_VERSION =

            new StandardBundlerParam<>(

                    "win.msi.productVersion",

                    String.class,

                    VERSION::fetchFrom,

                    (s, p) -> s

            );

    public static final StandardBundlerParam<Boolean> MENU_HINT =

        new WindowsBundlerParam<>(

                Arguments.CLIOptions.WIN_MENU_HINT.getId(),

                Boolean.class,

                params -> false,

                (s, p) -> (s == null ||

                        "null".equalsIgnoreCase(s))? true : Boolean.valueOf(s)

        );

    public static final StandardBundlerParam<Boolean> SHORTCUT_HINT =

        new WindowsBundlerParam<>(

                Arguments.CLIOptions.WIN_SHORTCUT_HINT.getId(),

                Boolean.class,

                params -> false,

                (s, p) -> (s == null ||

                       "null".equalsIgnoreCase(s))? false : Boolean.valueOf(s)

        );

    private final static String DEFAULT_EXE_PROJECT_TEMPLATE = "template.iss";

    private final static String DEFAULT_JRE_EXE_TEMPLATE = "template.jre.iss";

    private static final String TOOL_INNO_SETUP_COMPILER = "iscc.exe";

    public static final BundlerParamInfo<String>

            TOOL_INNO_SETUP_COMPILER_EXECUTABLE = new WindowsBundlerParam<>(

            "win.exe.iscc.exe",

            String.class,

            params -> {

                for (String dirString : (System.getenv("PATH")

                        + ";C:\\Program Files (x86)\\Inno Setup 5;"

                        + "C:\\Program Files\\Inno Setup 5").split(";")) {

                    File f = new File(dirString.replace("\"", ""),

                            TOOL_INNO_SETUP_COMPILER);

                    if (f.isFile()) {

                        return f.toString();

                    }

                }

                return null;

            },

            null);

    @Override

    public String getName() {

        return getString("exe.bundler.name");

    }

    @Override

    public String getDescription() {

        return getString("exe.bundler.description");

    }

    @Override

    public String getID() {

        return "exe";

    }

    @Override

    public String getBundleType() {

        return "INSTALLER";

    }

    @Override

    public Collection<BundlerParamInfo<?>> getBundleParameters() {

        Collection<BundlerParamInfo<?>> results = new LinkedHashSet<>();

        results.addAll(WinAppBundler.getAppBundleParameters());

        results.addAll(getExeBundleParameters());

        return results;

    }

    public static Collection<BundlerParamInfo<?>> getExeBundleParameters() {

        return Arrays.asList(

                DESCRIPTION,

                COPYRIGHT,

                LICENSE_FILE,

                MENU_GROUP,

                MENU_HINT,

                SHORTCUT_HINT,

                EXE_SYSTEM_WIDE,

                VENDOR,

                INSTALLDIR_CHOOSER

        );

    }

    @Override

    public File execute(Map<String, ? super Object> p,

            File outputParentDir) throws PackagerException {

        return bundle(p, outputParentDir);

    }

    @Override

    public boolean supported(boolean platformInstaller) {

        return (Platform.getPlatform() == Platform.WINDOWS);

    }

    private static String findToolVersion(String toolName) {

        try {

            if (toolName == null || "".equals(toolName)) return null;

            ProcessBuilder pb = new ProcessBuilder(

                    toolName,

                    "/?");

            VersionExtractor ve =

                    new VersionExtractor("Inno Setup (\\d+.?\\d*)");

            IOUtils.exec(pb, Log.isDebug(), true, ve);

            // not interested in the output

            String version = ve.getVersion();

            Log.verbose(MessageFormat.format(

                    getString("message.tool-version"), toolName, version));

            return version;

        } catch (Exception e) {

            if (Log.isDebug()) {

                Log.verbose(e);

            }

            return null;

        }

    }

    @Override

    public boolean validate(Map<String, ? super Object> p)

            throws UnsupportedPlatformException, ConfigException {

        try {

            if (p == null) throw new ConfigException(

                      getString("error.parameters-null"),

                      getString("error.parameters-null.advice"));

            // run basic validation to ensure requirements are met

            // we are not interested in return code, only possible exception

            APP_BUNDLER.fetchFrom(p).validate(p);

            // make sure some key values don't have newlines

            for (BundlerParamInfo<String> pi : Arrays.asList(

                    APP_NAME,

                    COPYRIGHT,

                    DESCRIPTION,

                    MENU_GROUP,

                    VENDOR,

                    VERSION)

            ) {

                String v = pi.fetchFrom(p);

                if (v.contains("\n") | v.contains("\r")) {

                    throw new ConfigException("Parmeter '" + pi.getID() +

                            "' cannot contain a newline.",

                            " Change the value of '" + pi.getID() +

                            " so that it does not contain any newlines");

                }

            }

            // exe bundlers trim the copyright to 100 characters,

            // tell them this will happen

            if (COPYRIGHT.fetchFrom(p).length() > 100) {

                throw new ConfigException(

                        getString("error.copyright-is-too-long"),

                        getString("error.copyright-is-too-long.advice"));

            }

            String innoVersion = findToolVersion(

                    TOOL_INNO_SETUP_COMPILER_EXECUTABLE.fetchFrom(p));

            //Inno Setup 5+ is required

            String minVersion = "5.0";

            if (VersionExtractor.isLessThan(innoVersion, minVersion)) {

                Log.error(MessageFormat.format(

                        getString("message.tool-wrong-version"),

                        TOOL_INNO_SETUP_COMPILER, innoVersion, minVersion));

                throw new ConfigException(

                        getString("error.iscc-not-found"),

                        getString("error.iscc-not-found.advice"));

            }

            /********* validate bundle parameters *************/

            // only one mime type per association, at least one file extension

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

                    FILE_ASSOCIATIONS.fetchFrom(p);

            if (associations != null) {

                for (int i = 0; i < associations.size(); i++) {

                    Map<String, ? super Object> assoc = associations.get(i);

                    List<String> mimes = FA_CONTENT_TYPE.fetchFrom(assoc);

                    if (mimes.size() > 1) {

                        throw new ConfigException(MessageFormat.format(

                                getString("error.too-many-content-"

                                + "types-for-file-association"), i),

                                getString("error.too-many-content-"

                                + "types-for-file-association.advice"));

                    }

                }

            }

            return true;

        } catch (RuntimeException re) {

            if (re.getCause() instanceof ConfigException) {

                throw (ConfigException) re.getCause();

            } else {

                throw new ConfigException(re);

            }

        }

    }

    private boolean prepareProto(Map<String, ? super Object> p)

                throws PackagerException, IOException {

        File appImage = StandardBundlerParam.getPredefinedAppImage(p);

        File appDir = null;

        // we either have an application image or need to build one

        if (appImage != null) {

            appDir = new File(

                    EXE_IMAGE_DIR.fetchFrom(p), APP_NAME.fetchFrom(p));

            // copy everything from appImage dir into appDir/name

            IOUtils.copyRecursive(appImage.toPath(), appDir.toPath());

        } else {

            appDir = APP_BUNDLER.fetchFrom(p).doBundle(p,

                    EXE_IMAGE_DIR.fetchFrom(p), true);

        }

        if (appDir == null) {

            return false;

        }

        p.put(WIN_APP_IMAGE.getID(), appDir);

        String licenseFile = LICENSE_FILE.fetchFrom(p);

        if (licenseFile != null) {

            // need to copy license file to the working directory and convert to rtf if needed

            File lfile = new File(licenseFile);

            File destFile = new File(CONFIG_ROOT.fetchFrom(p), lfile.getName());

            IOUtils.copyFile(lfile, destFile);

            ensureByMutationFileIsRTF(destFile);

        }

        // copy file association icons

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

                FILE_ASSOCIATIONS.fetchFrom(p);

        for (Map<String, ? super Object> fa : fileAssociations) {

            File icon = FA_ICON.fetchFrom(fa); // TODO FA_ICON_ICO

            if (icon == null) {

                continue;

            }

            File faIconFile = new File(appDir, icon.getName());

            if (icon.exists()) {

                try {

                    IOUtils.copyFile(icon, faIconFile);

                } catch (IOException e) {

                    Log.verbose(e);

                }

            }

        }

        return true;

    }

    public File bundle(Map<String, ? super Object> p, File outdir)

            throws PackagerException {

        if (!outdir.isDirectory() && !outdir.mkdirs()) {

            throw new PackagerException("error.cannot-create-output-dir",

                    outdir.getAbsolutePath());

        }

        if (!outdir.canWrite()) {

            throw new PackagerException("error.cannot-write-to-output-dir",

                    outdir.getAbsolutePath());

        }

        String tempDirectory = WindowsDefender.getUserTempDirectory();

        if (Arguments.CLIOptions.context().userProvidedBuildRoot) {

            tempDirectory = TEMP_ROOT.fetchFrom(p).getAbsolutePath();

        }

        if (WindowsDefender.isThereAPotentialWindowsDefenderIssue(

                tempDirectory)) {

            Log.error(MessageFormat.format(

                    getString("message.potential.windows.defender.issue"),

                    tempDirectory));

        }

        // validate we have valid tools before continuing

        String iscc = TOOL_INNO_SETUP_COMPILER_EXECUTABLE.fetchFrom(p);

        if (iscc == null || !new File(iscc).isFile()) {

            Log.verbose(getString("error.iscc-not-found"));

            Log.verbose(MessageFormat.format(

                    getString("message.iscc-file-string"), iscc));

            throw new PackagerException("error.iscc-not-found");

        }

        File imageDir = EXE_IMAGE_DIR.fetchFrom(p);

        try {

            imageDir.mkdirs();

            boolean menuShortcut = MENU_HINT.fetchFrom(p);

            boolean desktopShortcut = SHORTCUT_HINT.fetchFrom(p);

            if (!menuShortcut && !desktopShortcut) {

                // both can not be false - user will not find the app

                Log.verbose(getString("message.one-shortcut-required"));

                p.put(MENU_HINT.getID(), true);

            }

            if (prepareProto(p) && prepareProjectConfig(p)) {

                File configScript = getConfig_Script(p);

                if (configScript.exists()) {

                    Log.verbose(MessageFormat.format(

                            getString("message.running-wsh-script"),

                            configScript.getAbsolutePath()));

                    IOUtils.run("wscript", configScript, VERBOSE.fetchFrom(p));

                }

                return buildEXE(p, outdir);

            }

            return null;

        } catch (IOException ex) {

            Log.verbose(ex);

            throw new PackagerException(ex);

        }

    }

    // name of post-image script

    private File getConfig_Script(Map<String, ? super Object> p) {

        return new File(EXE_IMAGE_DIR.fetchFrom(p),

                APP_NAME.fetchFrom(p) + "-post-image.wsf");

    }

    private String getAppIdentifier(Map<String, ? super Object> p) {

        String nm = UPGRADE_UUID.fetchFrom(p).toString();

        // limitation of innosetup

        if (nm.length() > 126) {

            Log.error(getString("message-truncating-id"));

            nm = nm.substring(0, 126);

        }

        return nm;

    }

    private String getLicenseFile(Map<String, ? super Object> p) {

        String licenseFile = LICENSE_FILE.fetchFrom(p);

        if (licenseFile != null) {

            File lfile = new File(licenseFile);

            File destFile = new File(CONFIG_ROOT.fetchFrom(p), lfile.getName());

            String filePath = destFile.getAbsolutePath();

            if (filePath.contains(" ")) {

                return "\"" + filePath + "\"";

            } else {

                return filePath;

            }

        }

        return null;

    }

    void validateValueAndPut(Map<String, String> data, String key,

                BundlerParamInfo<String> param,

                Map<String, ? super Object> p) throws IOException {

        String value = param.fetchFrom(p);

        if (value.contains("\r") || value.contains("\n")) {

            throw new IOException("Configuration Parameter " +

                     param.getID() + " cannot contain multiple lines of text");

        }

        data.put(key, innosetupEscape(value));

    }

    private String innosetupEscape(String value) {

        if (value == null) {

            return "";

        }

        if (value.contains("\"") || !value.trim().equals(value)) {

            value = "\"" + value.replace("\"", "\"\"") + "\"";

        }

        return value;

    }

    boolean prepareMainProjectFile(Map<String, ? super Object> p)

            throws IOException {

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

        data.put("PRODUCT_APP_IDENTIFIER",

                innosetupEscape(getAppIdentifier(p)));

        validateValueAndPut(data, "INSTALL_DIR", WINDOWS_INSTALL_DIR, p);

        validateValueAndPut(data, "INSTALLER_NAME", APP_NAME, p);

        validateValueAndPut(data, "APPLICATION_VENDOR", VENDOR, p);

        validateValueAndPut(data, "APPLICATION_VERSION", VERSION, p);

        validateValueAndPut(data, "INSTALLER_FILE_NAME",

                INSTALLER_FILE_NAME, p);

        data.put("LAUNCHER_NAME",

                innosetupEscape(WinAppBundler.getAppName(p)));

        data.put("APPLICATION_LAUNCHER_FILENAME",

                innosetupEscape(WinAppBundler.getLauncherName(p)));

        data.put("APPLICATION_DESKTOP_SHORTCUT",

                SHORTCUT_HINT.fetchFrom(p) ? "returnTrue" : "returnFalse");

        data.put("APPLICATION_MENU_SHORTCUT",

                MENU_HINT.fetchFrom(p) ? "returnTrue" : "returnFalse");

        validateValueAndPut(data, "APPLICATION_GROUP", MENU_GROUP, p);

        validateValueAndPut(data, "APPLICATION_COPYRIGHT", COPYRIGHT, p);

        data.put("APPLICATION_LICENSE_FILE",

                innosetupEscape(getLicenseFile(p)));

        data.put("DISABLE_DIR_PAGE",

                INSTALLDIR_CHOOSER.fetchFrom(p) ? "No" : "Yes");

        Boolean isSystemWide = EXE_SYSTEM_WIDE.fetchFrom(p);

        if (isSystemWide) {

            data.put("APPLICATION_INSTALL_ROOT", "{pf}");

            data.put("APPLICATION_INSTALL_PRIVILEGE", "admin");

        } else {

            data.put("APPLICATION_INSTALL_ROOT", "{localappdata}");

            data.put("APPLICATION_INSTALL_PRIVILEGE", "lowest");

        }

        data.put("ARCHITECTURE_BIT_MODE", "x64");

        validateValueAndPut(data, "RUN_FILENAME", APP_NAME, p);

        validateValueAndPut(data, "APPLICATION_DESCRIPTION",

                DESCRIPTION, p);

        data.put("APPLICATION_SERVICE", "returnFalse");

        data.put("APPLICATION_NOT_SERVICE", "returnFalse");

        data.put("APPLICATION_APP_CDS_INSTALL", "returnFalse");

        data.put("START_ON_INSTALL", "");

        data.put("STOP_ON_UNINSTALL", "");

        data.put("RUN_AT_STARTUP", "");

        String imagePathString =

                WIN_APP_IMAGE.fetchFrom(p).toPath().toAbsolutePath().toString();

        data.put("APPLICATION_IMAGE", innosetupEscape(imagePathString));

        Log.verbose("setting APPLICATION_IMAGE to " +

                innosetupEscape(imagePathString) + " for InnoSetup");