/*

 * Copyright (c) 2012, 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.packager.internal.windows;

import jdk.packager.internal.*;

import jdk.packager.internal.ConfigException;

import jdk.packager.internal.Arguments;

import jdk.packager.internal.UnsupportedPlatformException;

import jdk.packager.internal.resources.windows.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.packager.internal.windows.WindowsBundlerParam.*;

public class WinMsiBundler  extends AbstractBundler {

    private static final ResourceBundle I18N =

            ResourceBundle.getBundle(

            "jdk.packager.internal.resources.windows.WinMsiBundler");

    public static final BundlerParamInfo<WinAppBundler> APP_BUNDLER =

            new WindowsBundlerParam<>(

            I18N.getString("param.app-bundler.name"),

            I18N.getString("param.app-bundler.description"),

            "win.app.bundler",

            WinAppBundler.class,

            params -> new WinAppBundler(),

            null);

    public static final BundlerParamInfo<Boolean> CAN_USE_WIX36 =

            new WindowsBundlerParam<>(

            I18N.getString("param.can-use-wix36.name"),

            I18N.getString("param.can-use-wix36.description"),

            "win.msi.canUseWix36",

            Boolean.class,

            params -> false,

            (s, p) -> Boolean.valueOf(s));

    public static final BundlerParamInfo<File> CONFIG_ROOT =

            new WindowsBundlerParam<>(

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

            I18N.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> MSI_IMAGE_DIR =

            new WindowsBundlerParam<>(

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

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

            "win.msi.imageDir",

            File.class,

            params -> {

                File imagesRoot = IMAGES_ROOT.fetchFrom(params);

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

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

            },

            (s, p) -> null);

    public static final BundlerParamInfo<File> WIN_APP_IMAGE =

            new WindowsBundlerParam<>(

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

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

            "win.app.image",

            File.class,

            null,

            (s, p) -> null);

    public static final StandardBundlerParam<Boolean> MSI_SYSTEM_WIDE  =

            new StandardBundlerParam<>(

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

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

                    Arguments.CLIOptions.WIN_PER_USER_INSTALLATION.getId(),

                    Boolean.class,

                    params -> true, // MSIs default to system wide

                    // valueOf(null) is false,

                    // and we actually do want null

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

                            : Boolean.valueOf(s)

            );

    public static final StandardBundlerParam<String> PRODUCT_VERSION =

            new StandardBundlerParam<>(

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

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

                    "win.msi.productVersion",

                    String.class,

                    VERSION::fetchFrom,

                    (s, p) -> s

            );

    public static final BundlerParamInfo<UUID> UPGRADE_UUID =

            new WindowsBundlerParam<>(

            I18N.getString("param.upgrade-uuid.name"),

            I18N.getString("param.upgrade-uuid.description"),

            Arguments.CLIOptions.WIN_MSI_UPGRADE_UUID.getId(),

            UUID.class,

            params -> UUID.randomUUID(), // TODO check to see

                    // if identifier is a valid UUID during default

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

    private static final String TOOL_CANDLE = "candle.exe";

    private static final String TOOL_LIGHT = "light.exe";

    // autodetect just v3.7, v3.8, 3.9, 3.10 and 3.11

    private static final String AUTODETECT_DIRS =

            ";C:\\Program Files (x86)\\WiX Toolset v3.11\\bin;"

            + "C:\\Program Files\\WiX Toolset v3.11\\bin;"

            + "C:\\Program Files (x86)\\WiX Toolset v3.10\\bin;"

            + "C:\\Program Files\\WiX Toolset v3.10\\bin;"

            + "C:\\Program Files (x86)\\WiX Toolset v3.9\\bin;"

            + "C:\\Program Files\\WiX Toolset v3.9\\bin;"

            + "C:\\Program Files (x86)\\WiX Toolset v3.8\\bin;"

            + "C:\\Program Files\\WiX Toolset v3.8\\bin;"

            + "C:\\Program Files (x86)\\WiX Toolset v3.7\\bin;"

            + "C:\\Program Files\\WiX Toolset v3.7\\bin";

    public static final BundlerParamInfo<String> TOOL_CANDLE_EXECUTABLE =

            new WindowsBundlerParam<>(

            I18N.getString("param.candle-path.name"),

            I18N.getString("param.candle-path.description"),

            "win.msi.candle.exe",

            String.class,

            params -> {

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

                        AUTODETECT_DIRS).split(";")) {

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

                    if (f.isFile()) {

                        return f.toString();

                    }

                }

                return null;

            },

            null);

    public static final BundlerParamInfo<String> TOOL_LIGHT_EXECUTABLE =

            new WindowsBundlerParam<>(

            I18N.getString("param.light-path.name"),

            I18N.getString("param.light-path.description"),

            "win.msi.light.exe",

            String.class,

            params -> {

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

                        AUTODETECT_DIRS).split(";")) {

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

                    if (f.isFile()) {

                        return f.toString();

                    }

                }

                return null;

            },

            null);

    public static final StandardBundlerParam<Boolean> MENU_HINT =

        new WindowsBundlerParam<>(

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

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

                Arguments.CLIOptions.WIN_MENU_HINT.getId(),

                Boolean.class,

                params -> false,

                // valueOf(null) is false,

                // and we actually do want null in some cases

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

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

        );

    public static final StandardBundlerParam<Boolean> SHORTCUT_HINT =

        new WindowsBundlerParam<>(

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

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

                Arguments.CLIOptions.WIN_SHORTCUT_HINT.getId(),

                Boolean.class,

                params -> false,

                // valueOf(null) is false,

                // and we actually do want null in some cases

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

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

        );

    public WinMsiBundler() {

        super();

        baseResourceLoader = WinResources.class;

    }

    @Override

    public String getName() {

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

    }

    @Override

    public String getDescription() {

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

    }

    @Override

    public String getID() {

        return "msi";

    }

    @Override

    public String getBundleType() {

        return "INSTALLER";

    }

    @Override

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

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

        results.addAll(WinAppBundler.getAppBundleParameters());

        results.addAll(getMsiBundleParameters());

        return results;

    }

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

        return Arrays.asList(

                DESCRIPTION,

                MENU_GROUP,

                MENU_HINT,

                PRODUCT_VERSION,

                SHORTCUT_HINT,

                MSI_SYSTEM_WIDE,

                VENDOR,

                LICENSE_FILE,

                INSTALLDIR_CHOOSER

        );

    }

    @Override

    public File execute(

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

        return bundle(params, 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("version (\\d+.\\d+)");

                Matcher matcher = pattern.matcher(content);

                if (matcher.find()) {

                    String v = matcher.group(1);

                    version = new Double(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();

            // not interested in the output

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

            double version = ve.getVersion();

            Log.verbose(MessageFormat.format(

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

                    I18N.getString("error.parameters-null"),

                    I18N.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).doValidate(p);

            double candleVersion =

                    findToolVersion(TOOL_CANDLE_EXECUTABLE.fetchFrom(p));

            double lightVersion =

                    findToolVersion(TOOL_LIGHT_EXECUTABLE.fetchFrom(p));

            // WiX 3.0+ is required

            double minVersion = 3.0f;

            boolean bad = false;

            if (candleVersion < minVersion) {

                Log.verbose(MessageFormat.format(

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

                        TOOL_CANDLE, candleVersion, minVersion));

                bad = true;

            }

            if (lightVersion < minVersion) {

                Log.verbose(MessageFormat.format(

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

                        TOOL_LIGHT, lightVersion, minVersion));

                bad = true;

            }

            if (bad){

                throw new ConfigException(

                        I18N.getString("error.no-wix-tools"),

                        I18N.getString("error.no-wix-tools.advice"));

            }

            if (lightVersion >= 3.6f) {

                Log.verbose(I18N.getString("message.use-wix36-features"));

                p.put(CAN_USE_WIX36.getID(), Boolean.TRUE);

            }

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

            String version = PRODUCT_VERSION.fetchFrom(p);

            if (!isVersionStringValid(version)) {

                throw new ConfigException(

                        MessageFormat.format(I18N.getString(

                                "error.version-string-wrong-format"), version),

                        MessageFormat.format(I18N.getString(

                                "error.version-string-wrong-format.advice"),

                                PRODUCT_VERSION.getID()));

            }

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

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

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

                                I18N.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(I18N.getString(

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

                            MessageFormat.format(I18N.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);

            }

        }

    }

    // http://msdn.microsoft.com/en-us/library/aa370859%28v=VS.85%29.aspx

    // The format of the string is as follows:

    //     major.minor.build

    // The first field is the major version and has a maximum value of 255.

    // The second field is the minor version and has a maximum value of 255.

    // The third field is called the build version or the update version and

    // has a maximum value of 65,535.

    static boolean isVersionStringValid(String v) {

        if (v == null) {

            return true;

        }

        String p[] = v.split("\\.");

        if (p.length > 3) {

            Log.verbose(I18N.getString(

                    "message.version-string-too-many-components"));

            return false;

        }

        try {

            int val = Integer.parseInt(p[0]);

            if (val < 0 || val > 255) {

                Log.verbose(I18N.getString(

                        "error.version-string-major-out-of-range"));

                return false;

            }

            if (p.length > 1) {

                val = Integer.parseInt(p[1]);

                if (val < 0 || val > 255) {

                    Log.verbose(I18N.getString(

                            "error.version-string-minor-out-of-range"));

                    return false;

                }

            }

            if (p.length > 2) {

                val = Integer.parseInt(p[2]);

                if (val < 0 || val > 65535) {

                    Log.verbose(I18N.getString(

                            "error.version-string-build-out-of-range"));

                    return false;

                }

            }

        } catch (NumberFormatException ne) {

            Log.verbose(I18N.getString("error.version-string-part-not-number"));

            Log.verbose(ne);

            return false;

        }

        return true;

    }

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

            // copy everything from appImage dir into appDir/name

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

        } else {

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

                    MSI_IMAGE_DIR.fetchFrom(p), true);

        }

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