/*

 * Copyright (c) 2012, 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.nio.file.Paths;

import java.text.MessageFormat;

import java.util.*;

import java.util.regex.Pattern;

import javax.xml.stream.XMLOutputFactory;

import javax.xml.stream.XMLStreamException;

import javax.xml.stream.XMLStreamWriter;

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

/**

 * WinMsiBundler

 *

 * Produces .msi installer from application image. Uses WiX Toolkit to build

 * .msi installer.

 * <p>

 * {@link #execute} method creates a number of source files with the description

 * of installer to be processed by WiX tools. Generated source files are stored

 * in "config" subdirectory next to "app" subdirectory in the root work

 * directory. The following WiX source files are generated:

 * <ul>

 * <li>main.wxs. Main source file with the installer description

 * <li>bundle.wxi. Source file with application and Java run-time directory tree

 * description. This source file is included from main.wxs

 * <li>icons.wxi. Source file with the list of icons used by the application.

 * This source file is included from main.wxs

 * </ul>

 * <p>

 * main.wxs file is a copy of main.wxs resource from

 * jdk.jpackage.internal.resources package. It is parametrized with the

 * following WiX variables:

 * <ul>

 * <li>JpAppName. Name of the application. Set to the value of --name command

 * line option

 * <li>JpAppVersion. Version of the application. Set to the value of

 * --app-version command line option

 * <li>JpAppVendor. Vendor of the application. Set to the value of --vendor

 * command line option

 * <li>JpAppDescription. Description of the application. Set to the value of

 * --description command line option

 * <li>JpProductCode. Set to product code UUID of the application. Random value

 * generated by jpackage every time {@link #execute} method is called

 * <li>JpProductUpgradeCode. Set to upgrade code UUID of the application. Random

 * value generated by jpackage every time {@link #execute} method is called if

 * --win-upgrade-uuid command line option is not specified. Otherwise this

 * variable is set to the value of --win-upgrade-uuid command line option

 * <li>JpAllowDowngrades. Set to "yes" if --win-upgrade-uuid command line option

 * was specified. Undefined otherwise

 * <li>JpLicenseRtf. Set to the value of --license-file command line option.

 * Undefined is --license-file command line option was not specified

 * <li>JpInstallDirChooser. Set to "yes" if --win-dir-chooser command line

 * option was specified. Undefined otherwise

 * <li>JpConfigDir. Absolute path to the directory with generated WiX source

 * files.

 * <li>JpIsSystemWide. Set to "yes" if --win-per-user-install command line

 * option was not specified. Undefined otherwise

 * <li>JpWixVersion36OrNewer. Set to "yes" if WiX Toolkit v3.6 or newer is used.

 * Undefined otherwise

 * </ul>

 */

public class WinMsiBundler  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<Boolean> CAN_USE_WIX36 =

            new WindowsBundlerParam<>(

            "win.msi.canUseWix36",

            Boolean.class,

            params -> false,

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

    public static final BundlerParamInfo<File> MSI_IMAGE_DIR =

            new WindowsBundlerParam<>(

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

            "win.app.image",

            File.class,

            null,

            (s, p) -> null);

    public static final StandardBundlerParam<Boolean> MSI_SYSTEM_WIDE  =

            new StandardBundlerParam<>(

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

                    "win.msi.productVersion",

                    String.class,

                    VERSION::fetchFrom,

                    (s, p) -> s

            );

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

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

    private static String getCandlePath() {

        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;

    }

    private static String getLightPath() {

        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;

    }

    public static final StandardBundlerParam<Boolean> MENU_HINT =

        new WindowsBundlerParam<>(

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

                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)

        );

    @Override

    public String getName() {

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

    }

    @Override

    public String getID() {

        return "msi";

    }

    @Override

    public String getBundleType() {

        return "INSTALLER";

    }

    @Override

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

            File outputParentDir) throws PackagerException {

        return bundle(params, outputParentDir);

    }

    @Override

    public boolean supported(boolean platformInstaller) {

        return isSupported();

    }

    public static boolean isSupported() {

        try {

            return validateWixTools();

        } catch (Exception e) {

            return false;

        }

    }

    private static String findToolVersion(String toolName) {

        try {

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

            ProcessBuilder pb = new ProcessBuilder(

                    toolName,

                    "/?");

            VersionExtractor ve = new VersionExtractor("version (\\d+.\\d+)");

            // not interested in the output

            IOUtils.exec(pb, true, ve);

            String 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 null;

        }

    }

    public static boolean validateWixTools() {

        String candleVersion = findToolVersion(getCandlePath());

        String lightVersion = findToolVersion(getLightPath());

        // WiX 3.0+ is required

        String minVersion = "3.0";

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

            Log.verbose(MessageFormat.format(

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

                    TOOL_CANDLE, candleVersion, minVersion));

            return false;

        }

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

            Log.verbose(MessageFormat.format(

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

                    TOOL_LIGHT, lightVersion, minVersion));

            return false;

        }

        return true;

    }

    @Override

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

            throws ConfigException {

        try {

            if (params == 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

            if (!validateWixTools()){

                throw new ConfigException(

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

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

            }

            String lightVersion = findToolVersion(getLightPath());

            if (!VersionExtractor.isLessThan(lightVersion, "3.6")) {

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

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

            }

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

            String version = PRODUCT_VERSION.fetchFrom(params);

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

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

                    }

                }

            }

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

                throws PackagerException, IOException {

        File appImage = StandardBundlerParam.getPredefinedAppImage(params);

        File appDir = null;

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

        if (appImage != null) {

            appDir = new File(MSI_IMAGE_DIR.fetchFrom(params),

                    APP_NAME.fetchFrom(params));

            // copy everything from appImage dir into appDir/name

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

        } else {

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

                    MSI_IMAGE_DIR.fetchFrom(params), true);

        }

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

        String licenseFile = LICENSE_FILE.fetchFrom(params);

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

                    lfile.getName());

            IOUtils.copyFile(lfile, destFile);

            destFile.setWritable(true);

            ensureByMutationFileIsRTF(destFile);

        }

        // copy file association icons

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

                FILE_ASSOCIATIONS.fetchFrom(params);

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

            File icon = FA_ICON.fetchFrom(fa);

            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 appDir != null;

    }

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

            throws PackagerException {

        IOUtils.writableOutputDir(outdir.toPath());

        // validate we have valid tools before continuing

        String light = getLightPath();

        String candle = getCandlePath();

        if (light == null || !new File(light).isFile() ||

            candle == null || !new File(candle).isFile()) {

            Log.verbose(MessageFormat.format(

                   I18N.getString("message.light-file-string"), light));

            Log.verbose(MessageFormat.format(

                   I18N.getString("message.candle-file-string"), candle));

            throw new PackagerException("error.no-wix-tools");

        }

        Map<String, String> wixVars = null;

        File imageDir = MSI_IMAGE_DIR.fetchFrom(params);

        try {

            imageDir.mkdirs();

            boolean menuShortcut = MENU_HINT.fetchFrom(params);

            boolean desktopShortcut = SHORTCUT_HINT.fetchFrom(params);

            if (!menuShortcut && !desktopShortcut) {

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

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

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

            }

            prepareBasicProjectConfig(params);

            if (prepareProto(params)) {

                wixVars = prepareWiXConfig(params);

                File configScriptSrc = getConfig_Script(params);

                if (configScriptSrc.exists()) {

                    // we need to be running post script in the image folder

                    // NOTE: Would it be better to generate it to the image

                    // folder and save only if "verbose" is requested?

                    // for now we replicate it

                    File configScript =

                        new File(imageDir, configScriptSrc.getName());

                    IOUtils.copyFile(configScriptSrc, configScript);

                    Log.verbose(MessageFormat.format(

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

                            configScript.getAbsolutePath()));

                    IOUtils.run("wscript", configScript);

                }

                return buildMSI(params, wixVars, outdir);