/*

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

import jdk.jpackage.internal.ConfigException;

import jdk.jpackage.internal.Arguments;

import jdk.jpackage.internal.UnsupportedPlatformException;

import jdk.jpackage.internal.resources.WinResources;

import java.io.*;

import java.nio.charset.Charset;

import java.nio.file.Files;

import java.text.MessageFormat;

import java.util.*;

import java.util.regex.Matcher;

import java.util.regex.Pattern;

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

            getString("param.exe-bundler.name"),

            getString("param.exe-bundler.description"),

            "win.app.bundler",

            WinAppBundler.class,

            params -> new WinAppBundler(),

            null);

    public static final BundlerParamInfo<File> CONFIG_ROOT =

            new WindowsBundlerParam<>(

            getString("param.config-root.name"),

            getString("param.config-root.description"),

            "configRoot",

            File.class,

            params -> {

                File imagesRoot =

                        new File(BUILD_ROOT.fetchFrom(params), "windows");

                imagesRoot.mkdirs();

                return imagesRoot;

            },

            (s, p) -> null);

    public static final BundlerParamInfo<File> EXE_IMAGE_DIR =

            new WindowsBundlerParam<>(

            getString("param.image-dir.name"),

            getString("param.image-dir.description"),

            "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<>(

            getString("param.app-dir.name"),

            getString("param.app-dir.description"),

            "win.app.image",

            File.class,

            null,

            (s, p) -> null);

    public static final StandardBundlerParam<Boolean> EXE_SYSTEM_WIDE  =

            new StandardBundlerParam<>(

            getString("param.system-wide.name"),

            getString("param.system-wide.description"),

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

                    getString("param.product-version.name"),

                    getString("param.product-version.description"),

                    "win.msi.productVersion",

                    String.class,

                    VERSION::fetchFrom,

                    (s, p) -> s

            );

    public static final StandardBundlerParam<Boolean> MENU_HINT =

        new WindowsBundlerParam<>(

                getString("param.menu-shortcut-hint.name"),

                getString("param.menu-shortcut-hint.description"),

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

                getString("param.desktop-shortcut-hint.name"),

                getString("param.desktop-shortcut-hint.description"),

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

            getString("param.iscc-path.name"),

            getString("param.iscc-path.description"),

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

    public WinExeBundler() {

        super();

        baseResourceLoader = WinResources.class;

    }

    @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,

                TITLE,

                VENDOR,

                INSTALLDIR_CHOOSER

        );

    }

    @Override

    public File execute(

            Map<String, ? super Object> p, File outputParentDir) {

        return bundle(p, outputParentDir);

    }

    @Override

    public boolean supported() {

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

    }

    static class VersionExtractor extends PrintStream {

        double version = 0f;

        public VersionExtractor() {

            super(new ByteArrayOutputStream());

        }

        double getVersion() {

            if (version == 0f) {

                String content =

                        new String(((ByteArrayOutputStream) out).toByteArray());

                Pattern pattern = Pattern.compile("Inno Setup (\\d+.?\\d*)");

                Matcher matcher = pattern.matcher(content);

                if (matcher.find()) {

                    String v = matcher.group(1);

                    version = Double.parseDouble(v);

                }

            }

            return version;

        }

    }

    private static double findToolVersion(String toolName) {

        try {

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

            ProcessBuilder pb = new ProcessBuilder(

                    toolName,

                    "/?");

            VersionExtractor ve = new VersionExtractor();

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

            // not interested in the output

            double 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 0f;

        }

    }

    @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,

                    TITLE,

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

            }

            double innoVersion = findToolVersion(

                    TOOL_INNO_SETUP_COMPILER_EXECUTABLE.fetchFrom(p));

            //Inno Setup 5+ is required

            double minVersion = 5.0f;

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

                    }

                }

            }

            // validate license file, if used, exists in the proper place

            if (p.containsKey(LICENSE_FILE.getID())) {

                List<RelativeFileSet> appResourcesList =

                        APP_RESOURCES_LIST.fetchFrom(p);

                for (String license : LICENSE_FILE.fetchFrom(p)) {

                    boolean found = false;

                    for (RelativeFileSet appResources : appResourcesList) {

                        found = found || appResources.contains(license);

                    }

                    if (!found) {

                        throw new ConfigException(

                            MessageFormat.format(getString(

                               "error.license-missing"), license),

                            MessageFormat.format(getString(

                               "error.license-missing.advice"), license));

                    }

                }

            }

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

        List<String> licenseFiles = LICENSE_FILE.fetchFrom(p);

        if (licenseFiles != null) {

            // need to copy license file to the root of win.app.image

            outerLoop:

            for (RelativeFileSet rfs : APP_RESOURCES_LIST.fetchFrom(p)) {

                for (String s : licenseFiles) {

                    if (rfs.contains(s)) {

                        File lfile = new File(rfs.getBaseDirectory(), s);

                        File destFile =

                            new File(appDir.getParentFile(), lfile.getName());

                        IOUtils.copyFile(lfile, destFile);

                        ensureByMutationFileIsRTF(destFile);

                        break outerLoop;

                    }

                }

            }

        }

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

                    e.printStackTrace();

                }

            }

        }

        return true;

    }

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

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

            throw new RuntimeException(MessageFormat.format(

                    getString("error.cannot-create-output-dir"),

                    outdir.getAbsolutePath()));

        }

        if (!outdir.canWrite()) {

            throw new RuntimeException(MessageFormat.format(

                    getString("error.cannot-write-to-output-dir"),

                    outdir.getAbsolutePath()));

        }

        if (WindowsDefender.isThereAPotentialWindowsDefenderIssue()) {

            Log.error(MessageFormat.format(

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

                    WindowsDefender.getUserTempDirectory()));

        }

        // validate we have valid tools before continuing

        String iscc = TOOL_INNO_SETUP_COMPILER_EXECUTABLE.fetchFrom(p);

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

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

            Log.error(MessageFormat.format(

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

            return null;

        }

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

            ex.printStackTrace();

            return null;

        } finally {

            try {

                if (imageDir != null &&

                        PREDEFINED_APP_IMAGE.fetchFrom(p) == null &&

                        (PREDEFINED_RUNTIME_IMAGE.fetchFrom(p) == null ||

                        !Arguments.CREATE_JRE_INSTALLER.fetchFrom(p)) &&

                        !Log.isDebug() &&

                        !Log.isVerbose()) {

                    IOUtils.deleteRecursive(imageDir);

                } else if (imageDir != null) {

                    Log.verbose(MessageFormat.format(

                            I18N.getString("message.debug-working-directory"),

                            imageDir.getAbsolutePath()));

                }

            } catch (IOException ex) {

                // noinspection ReturnInsideFinallyBlock

                Log.debug(ex.getMessage());

                return null;

            }

        }

    }

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

        // limitation of innosetup

        if (nm.length() > 126) {

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

            nm = nm.substring(0, 126);

        }