/*

 * 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.jpackager.internal;

import jdk.jpackager.internal.*;

import jdk.jpackager.internal.Arguments;

import jdk.jpackager.internal.resources.LinuxResources;

import javax.imageio.ImageIO;

import java.awt.image.BufferedImage;

import java.io.*;

import java.nio.file.Files;

import java.nio.file.attribute.PosixFilePermission;

import java.nio.file.attribute.PosixFilePermissions;

import java.text.MessageFormat;

import java.util.*;

import java.util.logging.Level;

import java.util.logging.Logger;

import java.util.regex.Matcher;

import java.util.regex.Pattern;

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

import static jdk.jpackager.internal.LinuxAppBundler.LINUX_INSTALL_DIR;

import static

        jdk.jpackager.internal.LinuxAppBundler.LINUX_PACKAGE_DEPENDENCIES;

public class LinuxRpmBundler extends AbstractBundler {

    private static final ResourceBundle I18N = ResourceBundle.getBundle(

            "jdk.jpackager.internal.resources.LinuxRpmBundler");

    public static final BundlerParamInfo<LinuxAppBundler> APP_BUNDLER =

            new StandardBundlerParam<>(

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

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

            "linux.app.bundler",

            LinuxAppBundler.class,

            params -> new LinuxAppBundler(),

            null);

    public static final BundlerParamInfo<File> RPM_IMAGE_DIR =

            new StandardBundlerParam<>(

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

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

            "linux.rpm.imageDir",

            File.class,

            params -> {

                File imagesRoot = IMAGES_ROOT.fetchFrom(params);

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

                return new File(imagesRoot, "linux-rpm.image");

            },

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

    public static final BundlerParamInfo<File> CONFIG_ROOT =

            new StandardBundlerParam<>(

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

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

            "configRoot",

            File.class,

            params ->  new File(BUILD_ROOT.fetchFrom(params), "linux"),

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

    // Fedora rules for package naming are used here

    // https://fedoraproject.org/wiki/Packaging:NamingGuidelines?rd=Packaging/NamingGuidelines

    //

    // all Fedora packages must be named using only the following ASCII

    // characters. These characters are displayed here:

    //

    // abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._+

    //

    private static final Pattern RPM_BUNDLE_NAME_PATTERN =

            Pattern.compile("[a-z\\d\\+\\-\\.\\_]+", Pattern.CASE_INSENSITIVE);

    public static final BundlerParamInfo<String> BUNDLE_NAME =

            new StandardBundlerParam<> (

            I18N.getString("param.bundle-name.name"),

            I18N.getString("param.bundle-name.description"),

            Arguments.CLIOptions.LINUX_BUNDLE_NAME.getId(),

            String.class,

            params -> {

                String nm = APP_NAME.fetchFrom(params);

                if (nm == null) return null;

                // make sure to lower case and spaces become dashes

                nm = nm.toLowerCase().replaceAll("[ ]", "-");

                return nm;

            },

            (s, p) -> {

                if (!RPM_BUNDLE_NAME_PATTERN.matcher(s).matches()) {

                    String msgKey = "error.invalid-value-for-package-name";

                    throw new IllegalArgumentException(

                            new ConfigException(MessageFormat.format(

                                    I18N.getString(msgKey), s),

                                    I18N.getString(msgKey + ".advice")));

                }

                return s;

            }

        );

    public static final BundlerParamInfo<String> LICENSE_TYPE =

        new StandardBundlerParam<>(

                I18N.getString("param.license-type.name"),

                I18N.getString("param.license-type.description"),

                Arguments.CLIOptions.LINUX_RPM_LICENSE_TYPE.getId(),

                String.class,

                params -> I18N.getString("param.license-type.default"),

                (s, p) -> s

        );

    public static final BundlerParamInfo<String> XDG_FILE_PREFIX =

            new StandardBundlerParam<> (

            I18N.getString("param.xdg-prefix.name"),

            I18N.getString("param.xdg-prefix.description"),

            "linux.xdg-prefix",

            String.class,

            params -> {

                try {

                    String vendor;

                    if (params.containsKey(VENDOR.getID())) {

                        vendor = VENDOR.fetchFrom(params);

                    } else {

                        vendor = "jpackager";

                    }

                    String appName = APP_FS_NAME.fetchFrom(params);

                    return (vendor + "-" + appName).replaceAll("\\s", "");

                } catch (Exception e) {

                    if (Log.isDebug()) {

                        e.printStackTrace();

                    }

                }

                return "unknown-MimeInfo.xml";

            },

            (s, p) -> s);

    private final static String DEFAULT_ICON = "javalogo_white_32.png";

    private final static String DEFAULT_SPEC_TEMPLATE = "template.spec";

    private final static String DEFAULT_DESKTOP_FILE_TEMPLATE =

            "template.desktop";

    public final static String TOOL_RPMBUILD = "rpmbuild";

    public final static double TOOL_RPMBUILD_MIN_VERSION = 4.0d;

    public LinuxRpmBundler() {

        super();

        baseResourceLoader = LinuxResources.class;

    }

    public static boolean testTool(String toolName, double minVersion) {

        try (ByteArrayOutputStream baos = new ByteArrayOutputStream();

                PrintStream ps = new PrintStream(baos)) {

            ProcessBuilder pb = new ProcessBuilder(toolName, "--version");

            IOUtils.exec(pb, Log.isDebug(), false, ps);

                    //not interested in the above's output

            String content = new String(baos.toByteArray());

            Pattern pattern = Pattern.compile(" (\\d+\\.\\d+)");

            Matcher matcher = pattern.matcher(content);

            if (matcher.find()) {

                String v = matcher.group(1);

                double version = Double.parseDouble(v);

                return minVersion <= version;

            } else {

               return false;

            }

        } catch (Exception e) {

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

                    "message.test-for-tool"), toolName, e.getMessage()));

            return false;

        }

    }

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

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

                                I18N.getString("error.license-missing"),

                                MessageFormat.format(

                                I18N.getString("error.license-missing.advice"),

                                license));

                    }

                }

            }

            // validate presense of required tools

            if (!testTool(TOOL_RPMBUILD, TOOL_RPMBUILD_MIN_VERSION)){

                throw new ConfigException(

                    MessageFormat.format(

                        I18N.getString("error.cannot-find-rpmbuild"),

                        TOOL_RPMBUILD_MIN_VERSION),

                    MessageFormat.format(

                        I18N.getString("error.cannot-find-rpmbuild.advice"),

                        TOOL_RPMBUILD_MIN_VERSION));

            }

            // 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 == null || mimes.isEmpty()) {

                        String msgKey =

                                "error.no-content-types-for-file-association";

                        throw new ConfigException(

                                MessageFormat.format(I18N.getString(msgKey), i),

                                I18N.getString(msgKey + ".advice"));

                    } else if (mimes.size() > 1) {

                        String msgKey =

                                "error.no-content-types-for-file-association";

                        throw new ConfigException(

                                MessageFormat.format(I18N.getString(msgKey), i),

                                I18N.getString(msgKey + ".advice"));

                    }

                }

            }

            // bundle name has some restrictions

            // the string converter will throw an exception if invalid

            BUNDLE_NAME.getStringConverter().apply(BUNDLE_NAME.fetchFrom(p), p);

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

                    RPM_IMAGE_DIR.fetchFrom(p), true);

        }

        return appDir != null;

    }

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

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

            throw new RuntimeException(MessageFormat.format(

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

                    outdir.getAbsolutePath()));

        }

        if (!outdir.canWrite()) {

            throw new RuntimeException(MessageFormat.format(

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

                    outdir.getAbsolutePath()));

        }

        File imageDir = RPM_IMAGE_DIR.fetchFrom(p);

        try {

            imageDir.mkdirs();

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

                return buildRPM(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;

            }

        }

    }

    /*

     * set permissions with a string like "rwxr-xr-x"

     *

     * This cannot be directly backport to 22u which is built with 1.6

     */

    private void setPermissions(File file, String permissions) {

        Set<PosixFilePermission> filePermissions =

                PosixFilePermissions.fromString(permissions);

        try {

            if (file.exists()) {

                Files.setPosixFilePermissions(file.toPath(), filePermissions);

            }

        } catch (IOException ex) {

            Logger.getLogger(LinuxDebBundler.class.getName()).log(

                    Level.SEVERE, null, ex);

        }

    }

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

        StringBuilder sb = new StringBuilder();

        for (String f: LICENSE_FILE.fetchFrom(params)) {

            if (sb.length() != 0) {

                sb.append("\n");

            }

            sb.append("%doc ");

            sb.append(LINUX_INSTALL_DIR.fetchFrom(params));

            sb.append("/");

            sb.append(APP_FS_NAME.fetchFrom(params));

            sb.append("/app/");

            sb.append(f);

        }

        return sb.toString();

    }

    private boolean prepareProjectConfig(Map<String, ? super Object> params)

            throws IOException {

        Map<String, String> data = createReplacementData(params);

        File rootDir =

            LinuxAppBundler.getRootDir(RPM_IMAGE_DIR.fetchFrom(params), params);

        // prepare installer icon

        File iconTarget = getConfig_IconFile(rootDir, params);

        File icon = LinuxAppBundler.ICON_PNG.fetchFrom(params);

        if (!Arguments.CREATE_JRE_INSTALLER.fetchFrom(params)) {

            if (icon == null || !icon.exists()) {

                fetchResource(LinuxAppBundler.BUNDLER_PREFIX

                        + iconTarget.getName(),

                        I18N.getString("resource.menu-icon"),

                        DEFAULT_ICON,

                        iconTarget,

                        VERBOSE.fetchFrom(params),

                        DROP_IN_RESOURCES_ROOT.fetchFrom(params));

            } else {

                fetchResource(LinuxAppBundler.BUNDLER_PREFIX

                        + iconTarget.getName(),

                        I18N.getString("resource.menu-icon"),

                        icon,

                        iconTarget,

                        VERBOSE.fetchFrom(params),

                        DROP_IN_RESOURCES_ROOT.fetchFrom(params));

            }

        }

        StringBuilder installScripts = new StringBuilder();

        StringBuilder removeScripts = new StringBuilder();

        for (Map<String, ? super Object> secondaryLauncher :

                SECONDARY_LAUNCHERS.fetchFrom(params)) {

            Map<String, String> secondaryLauncherData =

                    createReplacementData(secondaryLauncher);

            secondaryLauncherData.put("APPLICATION_FS_NAME",

                    data.get("APPLICATION_FS_NAME"));

            secondaryLauncherData.put("DESKTOP_MIMES", "");

            // prepare desktop shortcut

            Writer w = new BufferedWriter(new FileWriter(

                    getConfig_DesktopShortcutFile(rootDir, secondaryLauncher)));

            String content = preprocessTextResource(

                    LinuxAppBundler.BUNDLER_PREFIX

                            + getConfig_DesktopShortcutFile(rootDir,

                                    secondaryLauncher).getName(),

                    I18N.getString("resource.menu-shortcut-descriptor"),

                    DEFAULT_DESKTOP_FILE_TEMPLATE, secondaryLauncherData,

                    VERBOSE.fetchFrom(params),

                    DROP_IN_RESOURCES_ROOT.fetchFrom(params));

            w.write(content);

            w.close();

            // prepare installer icon

            iconTarget = getConfig_IconFile(rootDir, secondaryLauncher);

            icon = LinuxAppBundler.ICON_PNG.fetchFrom(secondaryLauncher);

            if (icon == null || !icon.exists()) {

                fetchResource(LinuxAppBundler.BUNDLER_PREFIX

                        + iconTarget.getName(),

                        I18N.getString("resource.menu-icon"),

                        DEFAULT_ICON,

                        iconTarget,

                        VERBOSE.fetchFrom(params),

                        DROP_IN_RESOURCES_ROOT.fetchFrom(params));

            } else {

                fetchResource(LinuxAppBundler.BUNDLER_PREFIX

                        + iconTarget.getName(),

                        I18N.getString("resource.menu-icon"),

                        icon,

                        iconTarget,

                        VERBOSE.fetchFrom(params),

                        DROP_IN_RESOURCES_ROOT.fetchFrom(params));

            }

            // post copying of desktop icon

            installScripts.append("xdg-desktop-menu install --novendor ");

            installScripts.append(LINUX_INSTALL_DIR.fetchFrom(params));

            installScripts.append("/");

            installScripts.append(data.get("APPLICATION_FS_NAME"));

            installScripts.append("/");

            installScripts.append(secondaryLauncherData.get(

                    "APPLICATION_LAUNCHER_FILENAME"));

            installScripts.append(".desktop\n");

            // preun cleanup of desktop icon

            removeScripts.append("xdg-desktop-menu uninstall --novendor ");

            removeScripts.append(LINUX_INSTALL_DIR.fetchFrom(params));

            removeScripts.append("/");

            removeScripts.append(data.get("APPLICATION_FS_NAME"));

            removeScripts.append("/");

            removeScripts.append(secondaryLauncherData.get(

                    "APPLICATION_LAUNCHER_FILENAME"));

            removeScripts.append(".desktop\n");

        }

        data.put("SECONDARY_LAUNCHERS_INSTALL", installScripts.toString());

        data.put("SECONDARY_LAUNCHERS_REMOVE", removeScripts.toString());

        StringBuilder cdsScript = new StringBuilder();

        data.put("APP_CDS_CACHE", cdsScript.toString());

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

                FILE_ASSOCIATIONS.fetchFrom(params);

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

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

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

        if (associations != null) {

            String mimeInfoFile = XDG_FILE_PREFIX.fetchFrom(params)

                    + "-MimeInfo.xml";

            StringBuilder mimeInfo = new StringBuilder(

                "<?xml version=\"1.0\"?>\n<mime-info xmlns="

                +"'http://www.freedesktop.org/standards/shared-mime-info'>\n");

            StringBuilder registrations = new StringBuilder();

            StringBuilder deregistrations = new StringBuilder();

            StringBuilder desktopMimes = new StringBuilder("MimeType=");

            boolean addedEntry = false;

            for (Map<String, ? super Object> assoc : associations) {

                //  <mime-type type="application/x-vnd.awesome">

                //    <comment>Awesome document</comment>

                //    <glob pattern="*.awesome"/>

                //    <glob pattern="*.awe"/>

                //  </mime-type>

                if (assoc == null) {

                    continue;

                }

                String description = FA_DESCRIPTION.fetchFrom(assoc);

                File faIcon = FA_ICON.fetchFrom(assoc); //TODO FA_ICON_PNG

                List<String> extensions = FA_EXTENSIONS.fetchFrom(assoc);

                if (extensions == null) {

                    Log.verbose(I18N.getString(

                        "message.creating-association-with-null-extension"));

                }

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

                if (mimes == null || mimes.isEmpty()) {

                    continue;

                }

                String thisMime = mimes.get(0);

                String dashMime = thisMime.replace('/', '-');

                mimeInfo.append("  <mime-type type='")

                        .append(thisMime)

                        .append("'>\n");

                if (description != null && !description.isEmpty()) {

                    mimeInfo.append("    <comment>")

                            .append(description)

                            .append("</comment>\n");

                }

                if (extensions != null) {

                    for (String ext : extensions) {