/*

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

import java.io.FileInputStream;

import java.io.IOException;

import java.io.InputStream;

import java.io.Writer;

import java.math.BigInteger;

import java.nio.file.Files;

import java.nio.file.Path;

import java.nio.file.StandardCopyOption;

import java.nio.file.attribute.PosixFilePermission;

import java.text.MessageFormat;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.EnumSet;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import java.util.Objects;

import java.util.Optional;

import java.util.ResourceBundle;

import java.util.Set;

import java.util.concurrent.atomic.AtomicReference;

import java.util.function.Consumer;

import javax.xml.parsers.DocumentBuilder;

import javax.xml.parsers.DocumentBuilderFactory;

import javax.xml.xpath.XPath;

import javax.xml.xpath.XPathConstants;

import javax.xml.xpath.XPathFactory;

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

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

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

public class MacAppImageBuilder extends AbstractAppImageBuilder {

    private static final ResourceBundle I18N = ResourceBundle.getBundle(

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

    private static final String LIBRARY_NAME = "libapplauncher.dylib";

    private static final String TEMPLATE_BUNDLE_ICON = "java.icns";

    private static final String OS_TYPE_CODE = "APPL";

    private static final String TEMPLATE_INFO_PLIST_LITE =

            "Info-lite.plist.template";

    private static final String TEMPLATE_RUNTIME_INFO_PLIST =

            "Runtime-Info.plist.template";

    private final Path root;

    private final Path contentsDir;

    private final Path appDir;

    private final Path javaModsDir;

    private final Path resourcesDir;

    private final Path macOSDir;

    private final Path runtimeDir;

    private final Path runtimeRoot;

    private final Path mdir;

    private static List<String> keyChains;

    public static final BundlerParamInfo<Boolean>

            MAC_CONFIGURE_LAUNCHER_IN_PLIST = new StandardBundlerParam<>(

                    "mac.configure-launcher-in-plist",

                    Boolean.class,

                    params -> Boolean.FALSE,

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

    public static final EnumeratedBundlerParam<String> MAC_CATEGORY =

            new EnumeratedBundlerParam<>(

                    Arguments.CLIOptions.MAC_APP_STORE_CATEGORY.getId(),

                    String.class,

                    params -> "Unknown",

                    (s, p) -> s,

                    MacAppBundler.getMacCategories(),

                    false //strict - for MacStoreBundler this should be strict

            );

    public static final BundlerParamInfo<String> MAC_CF_BUNDLE_NAME =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.MAC_BUNDLE_NAME.getId(),

                    String.class,

                    params -> null,

                    (s, p) -> s);

    public static final BundlerParamInfo<String> MAC_CF_BUNDLE_IDENTIFIER =

            new StandardBundlerParam<>(

                    Arguments.CLIOptions.MAC_BUNDLE_IDENTIFIER.getId(),

                    String.class,

                    params -> {

                        // Get identifier from app image if user provided

                        // app image and did not provide the identifier via CLI.

                        String identifier = extractBundleIdentifier(params);

                        if (identifier != null) {

                            return identifier;

                        }

                        return IDENTIFIER.fetchFrom(params);

                    },

                    (s, p) -> s);

    public static final BundlerParamInfo<String> MAC_CF_BUNDLE_VERSION =

            new StandardBundlerParam<>(

                    "mac.CFBundleVersion",

                    String.class,

                    p -> {

                        String s = VERSION.fetchFrom(p);

                        if (validCFBundleVersion(s)) {

                            return s;

                        } else {

                            return "100";

                        }

                    },

                    (s, p) -> s);

    public static final BundlerParamInfo<File> ICON_ICNS =

            new StandardBundlerParam<>(

            "icon.icns",

            File.class,

            params -> {

                File f = ICON.fetchFrom(params);

                if (f != null && !f.getName().toLowerCase().endsWith(".icns")) {

                    Log.error(MessageFormat.format(

                            I18N.getString("message.icon-not-icns"), f));

                    return null;

                }

                return f;

            },

            (s, p) -> new File(s));

    public static final StandardBundlerParam<Boolean> SIGN_BUNDLE  =

            new StandardBundlerParam<>(

            Arguments.CLIOptions.MAC_SIGN.getId(),

            Boolean.class,

            params -> false,

            // valueOf(null) is false, we actually do want null in some cases

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

                    null : Boolean.valueOf(s)

        );

    public MacAppImageBuilder(Map<String, Object> params, Path imageOutDir)

            throws IOException {

        super(params, imageOutDir.resolve(APP_NAME.fetchFrom(params)

                + ".app/Contents/runtime/Contents/Home"));

        Objects.requireNonNull(imageOutDir);

        this.root = imageOutDir.resolve(APP_NAME.fetchFrom(params) + ".app");

        this.contentsDir = root.resolve("Contents");

        this.appDir = contentsDir.resolve("app");

        this.javaModsDir = appDir.resolve("mods");

        this.resourcesDir = contentsDir.resolve("Resources");

        this.macOSDir = contentsDir.resolve("MacOS");

        this.runtimeDir = contentsDir.resolve("runtime");

        this.runtimeRoot = runtimeDir.resolve("Contents/Home");

        this.mdir = runtimeRoot.resolve("lib");

        Files.createDirectories(appDir);

        Files.createDirectories(resourcesDir);

        Files.createDirectories(macOSDir);

        Files.createDirectories(runtimeDir);

    }

    private void writeEntry(InputStream in, Path dstFile) throws IOException {

        Files.createDirectories(dstFile.getParent());

        Files.copy(in, dstFile);

    }

    public static boolean validCFBundleVersion(String v) {

        // CFBundleVersion (String - iOS, OS X) specifies the build version

        // number of the bundle, which identifies an iteration (released or

        // unreleased) of the bundle. The build version number should be a

        // string comprised of three non-negative, period-separated integers

        // with the first integer being greater than zero. The string should

        // only contain numeric (0-9) and period (.) characters. Leading zeros

        // are truncated from each integer and will be ignored (that is,

        // 1.02.3 is equivalent to 1.2.3). This key is not localizable.

        if (v == null) {

            return false;

        }

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

        if (p.length > 3 || p.length < 1) {

            Log.verbose(I18N.getString(

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

            return false;

        }

        try {

            BigInteger n = new BigInteger(p[0]);

            if (BigInteger.ONE.compareTo(n) > 0) {

                Log.verbose(I18N.getString(

                        "message.version-string-first-number-not-zero"));

                return false;

            }

            if (p.length > 1) {

                n = new BigInteger(p[1]);

                if (BigInteger.ZERO.compareTo(n) > 0) {

                    Log.verbose(I18N.getString(

                            "message.version-string-no-negative-numbers"));

                    return false;

                }

            }

            if (p.length > 2) {

                n = new BigInteger(p[2]);

                if (BigInteger.ZERO.compareTo(n) > 0) {

                    Log.verbose(I18N.getString(

                            "message.version-string-no-negative-numbers"));

                    return false;

                }

            }

        } catch (NumberFormatException ne) {

            Log.verbose(I18N.getString("message.version-string-numbers-only"));

            Log.verbose(ne);

            return false;

        }

        return true;

    }

    @Override

    public Path getAppDir() {

        return appDir;

    }

    @Override

    public Path getAppModsDir() {

        return javaModsDir;

    }

    @Override

    public void prepareApplicationFiles(Map<String, ? super Object> params)

            throws IOException {

        Map<String, ? super Object> originalParams = new HashMap<>(params);

        // Generate PkgInfo

        File pkgInfoFile = new File(contentsDir.toFile(), "PkgInfo");

        pkgInfoFile.createNewFile();

        writePkgInfo(pkgInfoFile);

        Path executable = macOSDir.resolve(getLauncherName(params));

        // create the main app launcher

        try (InputStream is_launcher =

                getResourceAsStream("jpackageapplauncher");

            InputStream is_lib = getResourceAsStream(LIBRARY_NAME)) {

            // Copy executable and library to MacOS folder

            writeEntry(is_launcher, executable);

            writeEntry(is_lib, macOSDir.resolve(LIBRARY_NAME));

        }

        executable.toFile().setExecutable(true, false);

        // generate main app launcher config file

        File cfg = new File(root.toFile(), getLauncherCfgName(params));

        writeCfgFile(params, cfg);

        // create additional app launcher(s) and config file(s)

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

                StandardBundlerParam.ADD_LAUNCHERS.fetchFrom(params);

        for (Map<String, ? super Object> entryPoint : entryPoints) {

            Map<String, ? super Object> tmp =

                    AddLauncherArguments.merge(originalParams, entryPoint);

            // add executable for add launcher

            Path addExecutable = macOSDir.resolve(getLauncherName(tmp));

            try (InputStream is = getResourceAsStream("jpackageapplauncher");) {

                writeEntry(is, addExecutable);

            }

            addExecutable.toFile().setExecutable(true, false);

            // add config file for add launcher

            cfg = new File(root.toFile(), getLauncherCfgName(tmp));

            writeCfgFile(tmp, cfg);

        }

        // Copy class path entries to Java folder

        copyClassPathEntries(appDir, params);

        /*********** Take care of "config" files *******/

        // copy file association icons

        for (Map<String, ?

                super Object> fa : FILE_ASSOCIATIONS.fetchFrom(params)) {

            File f = FA_ICON.fetchFrom(fa);

            if (f != null && f.exists()) {

                try (InputStream in2 = new FileInputStream(f)) {

                    Files.copy(in2, resourcesDir.resolve(f.getName()));

                }

            }

        }

        copyRuntimeFiles(params);

        sign(params);

    }

    @Override

    public void prepareJreFiles(Map<String, ? super Object> params)

            throws IOException {

        copyRuntimeFiles(params);

        sign(params);

    }

    @Override

    File getRuntimeImageDir(File runtimeImageTop) {

        File home = new File(runtimeImageTop, "Contents/Home");

        return (home.exists() ? home : runtimeImageTop);

    }

    private void copyRuntimeFiles(Map<String, ? super Object> params)

            throws IOException {

        // Generate Info.plist

        writeInfoPlist(contentsDir.resolve("Info.plist").toFile(), params);

        // generate java runtime info.plist

        writeRuntimeInfoPlist(

                runtimeDir.resolve("Contents/Info.plist").toFile(), params);

        // copy library

        Path runtimeMacOSDir = Files.createDirectories(

                runtimeDir.resolve("Contents/MacOS"));

        // JDK 9, 10, and 11 have extra '/jli/' subdir

        Path jli = runtimeRoot.resolve("lib/libjli.dylib");

        if (!Files.exists(jli)) {

            jli = runtimeRoot.resolve("lib/jli/libjli.dylib");

        }

        Files.copy(jli, runtimeMacOSDir.resolve("libjli.dylib"));

    }

    private void sign(Map<String, ? super Object> params) throws IOException {

        if (Optional.ofNullable(

                SIGN_BUNDLE.fetchFrom(params)).orElse(Boolean.TRUE)) {

            try {

                addNewKeychain(params);

            } catch (InterruptedException e) {

                Log.error(e.getMessage());

            }

            String signingIdentity =

                    DEVELOPER_ID_APP_SIGNING_KEY.fetchFrom(params);

            if (signingIdentity != null) {

                signAppBundle(params, root, signingIdentity,

                        BUNDLE_ID_SIGNING_PREFIX.fetchFrom(params), null, null);

            }

            restoreKeychainList(params);

        }

    }

    private String getLauncherName(Map<String, ? super Object> params) {

        if (APP_NAME.fetchFrom(params) != null) {

            return APP_NAME.fetchFrom(params);

        } else {

            return MAIN_CLASS.fetchFrom(params);

        }

    }

    public static String getLauncherCfgName(

            Map<String, ? super Object> params) {

        return "Contents/app/" + APP_NAME.fetchFrom(params) + ".cfg";

    }

    private void copyClassPathEntries(Path javaDirectory,

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

        List<RelativeFileSet> resourcesList =

                APP_RESOURCES_LIST.fetchFrom(params);

        if (resourcesList == null) {

            throw new RuntimeException(

                    I18N.getString("message.null-classpath"));

        }

        for (RelativeFileSet classPath : resourcesList) {

            File srcdir = classPath.getBaseDirectory();

            for (String fname : classPath.getIncludedFiles()) {

                copyEntry(javaDirectory, srcdir, fname);

            }

        }

    }

    private String getBundleName(Map<String, ? super Object> params) {

        if (MAC_CF_BUNDLE_NAME.fetchFrom(params) != null) {

            String bn = MAC_CF_BUNDLE_NAME.fetchFrom(params);

            if (bn.length() > 16) {

                Log.error(MessageFormat.format(I18N.getString(

                        "message.bundle-name-too-long-warning"),

                        MAC_CF_BUNDLE_NAME.getID(), bn));

            }

            return MAC_CF_BUNDLE_NAME.fetchFrom(params);

        } else if (APP_NAME.fetchFrom(params) != null) {

            return APP_NAME.fetchFrom(params);

        } else {

            String nm = MAIN_CLASS.fetchFrom(params);

            if (nm.length() > 16) {

                nm = nm.substring(0, 16);

            }

            return nm;

        }

    }

    private void writeRuntimeInfoPlist(File file,

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

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

        String identifier = StandardBundlerParam.isRuntimeInstaller(params) ?

                MAC_CF_BUNDLE_IDENTIFIER.fetchFrom(params) :

                "com.oracle.java." + MAC_CF_BUNDLE_IDENTIFIER.fetchFrom(params);

        data.put("CF_BUNDLE_IDENTIFIER", identifier);

        String name = StandardBundlerParam.isRuntimeInstaller(params) ?

                getBundleName(params): "Java Runtime Image";

        data.put("CF_BUNDLE_NAME", name);

        data.put("CF_BUNDLE_VERSION", VERSION.fetchFrom(params));

        data.put("CF_BUNDLE_SHORT_VERSION_STRING", VERSION.fetchFrom(params));

    }

    private void writeInfoPlist(File file, Map<String, ? super Object> params)

            throws IOException {

        Log.verbose(MessageFormat.format(I18N.getString(

                "message.preparing-info-plist"), file.getAbsolutePath()));

        //prepare config for exe

        //Note: do not need CFBundleDisplayName if we don't support localization

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

        data.put("DEPLOY_ICON_FILE", APP_NAME.fetchFrom(params) + ".icns");

        data.put("DEPLOY_BUNDLE_IDENTIFIER",

                MAC_CF_BUNDLE_IDENTIFIER.fetchFrom(params));

        data.put("DEPLOY_BUNDLE_NAME",

                getBundleName(params));

        data.put("DEPLOY_BUNDLE_COPYRIGHT",

                COPYRIGHT.fetchFrom(params) != null ?

                COPYRIGHT.fetchFrom(params) : "Unknown");

        data.put("DEPLOY_LAUNCHER_NAME", getLauncherName(params));

        data.put("DEPLOY_BUNDLE_SHORT_VERSION",

                VERSION.fetchFrom(params) != null ?

                VERSION.fetchFrom(params) : "1.0.0");

        data.put("DEPLOY_BUNDLE_CFBUNDLE_VERSION",

                MAC_CF_BUNDLE_VERSION.fetchFrom(params) != null ?

                MAC_CF_BUNDLE_VERSION.fetchFrom(params) : "100");

        data.put("DEPLOY_BUNDLE_CATEGORY", MAC_CATEGORY.fetchFrom(params));

        boolean hasMainJar = MAIN_JAR.fetchFrom(params) != null;

        boolean hasMainModule =

                StandardBundlerParam.MODULE.fetchFrom(params) != null;

        if (hasMainJar) {

            data.put("DEPLOY_MAIN_JAR_NAME", MAIN_JAR.fetchFrom(params).

                    getIncludedFiles().iterator().next());

        }

        else if (hasMainModule) {

            data.put("DEPLOY_MODULE_NAME",

                    StandardBundlerParam.MODULE.fetchFrom(params));

        }

        StringBuilder sb = new StringBuilder();

        List<String> jvmOptions = JAVA_OPTIONS.fetchFrom(params);

        String newline = ""; //So we don't add extra line after last append

        for (String o : jvmOptions) {

            sb.append(newline).append(

                    "    <string>").append(o).append("</string>");

            newline = "\n";

        }

        data.put("DEPLOY_JAVA_OPTIONS", sb.toString());

        sb = new StringBuilder();

        List<String> args = ARGUMENTS.fetchFrom(params);

        newline = "";

        // So we don't add unneccessary extra line after last append

        for (String o : args) {

            sb.append(newline).append("    <string>").append(o).append(

                    "</string>");

            newline = "\n";

        }

        data.put("DEPLOY_ARGUMENTS", sb.toString());

        newline = "";

        data.put("DEPLOY_LAUNCHER_CLASS", MAIN_CLASS.fetchFrom(params));