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

import jdk.packager.internal.IOUtils;
import jdk.packager.internal.Log;
import jdk.packager.internal.StandardBundlerParam;
import jdk.packager.internal.JLinkBundlerHelper;
import jdk.packager.internal.ModFile;

import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.text.MessageFormat;
import java.util.List;
import java.util.Map;
import java.util.ResourceBundle;
import java.util.ArrayList;

import static jdk.packager.internal.StandardBundlerParam.*;
import static jdk.packager.internal.StandardBundlerParam.ARGUMENTS;

public abstract class AbstractAppImageBuilder {

    private static final ResourceBundle I18N =
            ResourceBundle.getBundle(
            "jdk.packager.internal.resources.builders.AbstractAppImageBuilder");

    //do not use file separator -
    // we use it for classpath lookup and there / are not platform specific
    public final static String BUNDLER_PREFIX = "package/";

    private final Map<String, Object> properties;
    private final Path root;
    protected List<String> excludeFileList = new ArrayList<>();

    public AbstractAppImageBuilder(Map<String, Object> properties,
            Path root) throws IOException {
        this.properties = properties;
        this.root = root;
        excludeFileList.add(".*\\.diz");
    }

    public abstract InputStream getResourceAsStream(String name);
    public abstract void prepareApplicationFiles() throws IOException;
    public abstract void prepareServerJreFiles() throws IOException;

    public Map<String, Object> getProperties() {
        return this.properties;
    }

    public Path getRoot() {
        return this.root;
    }

    public String getExcludeFileList() {
        return String.join(",", excludeFileList);
    }

    protected void copyEntry(Path appDir, File srcdir, String fname)
            throws IOException {
        Path dest = appDir.resolve(fname);
        Files.createDirectories(dest.getParent());
        File src = new File(srcdir, fname);
        if (src.isDirectory()) {
            IOUtils.copyRecursive(src.toPath(), dest);
        } else {
            Files.copy(src.toPath(), dest);
        }
    }

    protected InputStream locateResource(String publicName, String category,
            String defaultName, File customFile,
            boolean verbose, File publicRoot) throws IOException {
        InputStream is = null;
        boolean customFromClasspath = false;
        boolean customFromFile = false;
        if (publicName != null) {
            if (publicRoot != null) {
                File publicResource = new File(publicRoot, publicName);
                if (publicResource.exists() && publicResource.isFile()) {
                    is = new FileInputStream(publicResource);
                }
            } else {
                is = getResourceAsStream(publicName);
            }
            customFromClasspath = (is != null);
        }
        if (is == null && customFile != null) {
            is = new FileInputStream(customFile);
            customFromFile = (is != null);
        }
        if (is == null && defaultName != null) {
            is = getResourceAsStream(defaultName);
        }
        if (verbose) {
            String msg = null;
            if (customFromClasspath) {
                msg = MessageFormat.format(I18N.getString(
                    "message.using-custom-resource-from-classpath"),
                    category == null ? "" : "[" + category + "] ", publicName);
            } else if (customFromFile) {
                msg = MessageFormat.format(I18N.getString(
                    "message.using-custom-resource-from-file"),
                    category == null ? "" : "[" + category + "] ",
                    customFile.getAbsoluteFile());
            } else if (is != null) {
                msg = MessageFormat.format(I18N.getString(
                    "message.using-default-resource-from-classpath"),
                    category == null ? "" : "[" + category + "] ", publicName);
            } else {
                msg = MessageFormat.format(I18N.getString(
                    "message.using-default-resource"),
                    category == null ? "" : "[" + category + "] ", publicName);
            }
            if (msg != null) {
                Log.info(msg);
            }
        }
        return is;
    }


    protected String preprocessTextResource(String publicName, String category,
            String defaultName, Map<String, String> pairs,
            boolean verbose, File publicRoot) throws IOException {
        InputStream inp = locateResource(publicName, category,
                defaultName, null, verbose, publicRoot);
        if (inp == null) {
            throw new RuntimeException(
                    "Module corrupt? No "+defaultName+" resource!");
        }

        try (InputStream is = inp) {
            //read fully into memory
            ByteArrayOutputStream baos = new ByteArrayOutputStream();
            byte[] buffer = new byte[1024];
            int length;
            while ((length = is.read(buffer)) != -1) {
                baos.write(buffer, 0, length);
            }

            //substitute
            String result = new String(baos.toByteArray());
            for (Map.Entry<String, String> e : pairs.entrySet()) {
                if (e.getValue() != null) {
                    result = result.replace(e.getKey(), e.getValue());
                }
            }
            return result;
        }
    }

    public void writeCfgFile(Map<String, ? super Object> params,
            File cfgFileName, String runtimeLocation) throws IOException {
        cfgFileName.delete();

        File mainJar = JLinkBundlerHelper.getMainJar(params);
        ModFile.ModType mainJarType = ModFile.ModType.Unknown;

        if (mainJar != null) {
            mainJarType = new ModFile(mainJar).getModType();
        }

        String mainModule = StandardBundlerParam.MODULE.fetchFrom(params);

        PrintStream out = new PrintStream(cfgFileName);

        out.println("[Application]");
        out.println("app.name=" + APP_NAME.fetchFrom(params));
        out.println("app.version=" + VERSION.fetchFrom(params));
        out.println("app.preferences.id=" + PREFERENCES_ID.fetchFrom(params));
        out.println("app.runtime=" + runtimeLocation);
        out.println("app.identifier=" + IDENTIFIER.fetchFrom(params));
        out.println("app.classpath=" + String.join(File.pathSeparator,
                CLASSPATH.fetchFrom(params).split("[ :;]")));
        out.println("app.application.instance=" +
                (SINGLETON.fetchFrom(params) ? "single" : "multiple"));

        // The main app is required to be a jar, modular or unnamed.
        if (mainModule != null && 
                (mainJarType == ModFile.ModType.Unknown ||
                mainJarType == ModFile.ModType.ModularJar)) {
            out.println("app.mainmodule=" + mainModule);
        } else {
            String mainClass = JLinkBundlerHelper.getMainClass(params);
            // If the app is contained in an unnamed jar then launch it the
            // legacy way and the main class string must be
            // of the format com/foo/Main
            if (mainJar != null) {
                out.println("app.mainjar="
                        + mainJar.toPath().getFileName().toString());
            }
            if (mainClass != null) {
                out.println("app.mainclass="
                        + mainClass.replaceAll("\\.", "/"));
            }
        }

        String version = JLinkBundlerHelper.getJDKVersion(params);

        if (!version.isEmpty()) {
            out.println("app.java.version=" + version);
        }

        out.println("packager.java.version="
                + System.getProperty("java.version"));

        Integer port = JLinkBundlerHelper.DEBUG.fetchFrom(params);

        if (port != null) {
            out.println(
                    "app.debug=-agentlib:jdwp=transport=dt_socket,"
                    + "server=y,suspend=y,address=localhost:"
                    + port);
        }

        out.println();
        out.println("[JVMOptions]");
        List<String> jvmargs = JVM_OPTIONS.fetchFrom(params);
        for (String arg : jvmargs) {
            out.println(arg);
        }
        Map<String, String> jvmProps = JVM_PROPERTIES.fetchFrom(params);
        for (Map.Entry<String, String> property : jvmProps.entrySet()) {
            out.println("-D" + property.getKey() + "=" + property.getValue());
        }

        out.println();
        out.println("[ArgOptions]");
        List<String> args = ARGUMENTS.fetchFrom(params);
        for (String arg : args) {
            if (arg.endsWith("=") &&
                    (arg.indexOf("=") == arg.lastIndexOf("="))) {
                out.print(arg.substring(0, arg.length() - 1));
                out.println("\\=");
            } else {
                out.println(arg);
            }
        }


        out.close();
    }

    public String getPlatformSpecificModulesFile() {
        return null;
    }

}