/*
 * Copyright (c) 2014, 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 com.oracle.bundlers.mac;

import static com.oracle.bundlers.StandardBundlerParam.*;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.Writer;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.ResourceBundle;

import com.oracle.bundlers.AbstractBundler;
import com.oracle.bundlers.BundlerParamInfo;
import com.oracle.bundlers.StandardBundlerParam;

import com.sun.javafx.tools.packager.Log;
import com.sun.javafx.tools.packager.bundlers.BundleType;
import com.sun.javafx.tools.packager.bundlers.ConfigException;
import com.sun.javafx.tools.packager.bundlers.IOUtils;
import com.sun.javafx.tools.packager.bundlers.UnsupportedPlatformException;
import com.sun.javafx.tools.resource.mac.MacResources;

public class MacDaemonBundler extends AbstractBundler {

    private static final ResourceBundle I18N =
            ResourceBundle.getBundle("com.oracle.bundlers.mac.MacDaemonBundler");
    
    private static final String TEMPLATE_LAUNCHD_PLIST  = "launchd.plist.template";

    public final static String MAC_BUNDLER_PREFIX =
            BUNDLER_PREFIX + "macosx" + File.separator;
    
    public static final BundlerParamInfo<File> CONFIG_ROOT = new StandardBundlerParam<>(
            I18N.getString("param.config-root.name"),
            I18N.getString("param.config-root.description"),
            "configRoot",
            File.class,
            null,
            params -> {
                File configRoot = new File(BUILD_ROOT.fetchFrom(params), "macosx");
                configRoot.mkdirs();
                return configRoot;
            },
            false,
            (s, p) -> new File(s));

    public MacDaemonBundler() {
        super();
        baseResourceLoader = MacResources.class;
    }
    
    private File getConfig_LaunchdPlist(Map<String, ? super Object> params) {
        return new File(CONFIG_ROOT.fetchFrom(params), "launchd.plist");
    }
    
    private void prepareConfigFiles(Map<String, ? super Object> params) throws IOException {
        File launchdPlistFile = getConfig_LaunchdPlist(params);
        launchdPlistFile.createNewFile();
        writeLaunchdPlist(launchdPlistFile, params);
    }

    private String getDaemonIdentifier(Map<String, ? super Object> params) {
        return IDENTIFIER.fetchFrom(params).toLowerCase() + ".daemon";
    }

    public String getAppName(Map<String, ? super Object> params) {
        return APP_NAME.fetchFrom(params) + ".app";
    }
    
    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);
        }
    }
    
    private String getDaemonLauncherPath(Map<String, ? super Object> params) {
        return "/Applications/" + getAppName(params) +
                "/Contents/MacOS/" + getLauncherName(params);
    }

    private void writeLaunchdPlist(File file, Map<String, ? super Object> params)
            throws IOException
    {
        Log.verbose("Preparing launchd.plist: "+file.getAbsolutePath());
        
        Map<String, String> data = new HashMap<>();

        data.put("DEPLOY_DAEMON_IDENTIFIER", getDaemonIdentifier(params));
        data.put("DEPLOY_DAEMON_LAUNCHER_PATH", getDaemonLauncherPath(params));        
        data.put("DEPLOY_RUN_AT_LOAD", String.valueOf((START_ON_INSTALL.fetchFrom(params))));
        data.put("DEPLOY_KEEP_ALIVE", String.valueOf((RUN_AT_STARTUP.fetchFrom(params))));

        Writer w = new BufferedWriter(new FileWriter(file));
        w.write(preprocessTextResource(
                MAC_BUNDLER_PREFIX + getConfig_LaunchdPlist(params).getName(),
                "Bundle launchd config file", TEMPLATE_LAUNCHD_PLIST, data,
                VERBOSE.fetchFrom(params)));
        w.close();
    }
    
    protected void cleanupConfigFiles(Map<String, ? super Object> params) {
        if (CONFIG_ROOT.fetchFrom(params) != null) {
            if (getConfig_LaunchdPlist(params) != null) {
                getConfig_LaunchdPlist(params).delete();
            }
        }
    }
    
    /*
     * Creates the following structure
     * 
     *  <package-name>
     *      Library
     *          LaunchDaemons
     *              plist file
     */
    public File doBundle(Map<String, ? super Object> params, File outputDirectory, boolean dependentTask) {
        
        File rootDirectory = null;

        try {            
            File file = BUILD_ROOT.fetchFrom(params);

            //prepare config resources (we will copy them to the bundle later)
            // NB: explicitly saving them to simplify customization
            prepareConfigFiles(params);

            // Create directory structure
            rootDirectory = new File(outputDirectory, APP_NAME.fetchFrom(params) + ".daemon");
            IOUtils.deleteRecursive(rootDirectory);
            rootDirectory.mkdirs();

            if (!dependentTask) {
                Log.info("Creating daemon component: " + rootDirectory.getAbsolutePath());
            }
            
            File libraryDirectory = new File(rootDirectory, "Library");
            libraryDirectory.mkdirs();

            File launchDaemonsDirectory = new File(libraryDirectory, "LaunchDaemons");
            launchDaemonsDirectory.mkdirs();

            // Generate launchd.plist
            IOUtils.copyFile(getConfig_LaunchdPlist(params),
                     new File(launchDaemonsDirectory,
                             IDENTIFIER.fetchFrom(params).toLowerCase() + ".launchd.plist"));
            
        } catch(IOException ex) {
            Log.verbose(ex);
            return null;
        } finally {
            if (!VERBOSE.fetchFrom(params)) {
                //cleanup
                cleanupConfigFiles(params);
            } else {
                Log.info("Config files are saved to " +
                        CONFIG_ROOT.fetchFrom(params).getAbsolutePath()  +
                        ". Use them to customize package.");
            }
        }
        
        return rootDirectory;
    }

    //////////////////////////////////////////////////////////////////////////////////
    // Implement Bundler
    //////////////////////////////////////////////////////////////////////////////////
    
    @Override
    public String getName() {
        return "Mac Daemon Component";
    }

    @Override
    public String getDescription() {
        return "Mac Daemon Component - contains configuration files describing daemons.";
    }

    @Override
    public String getID() {
        return "mac.daemon";
    }

    @Override
    public BundleType getBundleType() {
        return BundleType.IMAGE;
    }

    @Override
    public Collection<BundlerParamInfo<?>> getBundleParameters() {
        // TODO Auto-generated method stub
        return null;
    }

    @Override
    public boolean validate(Map<String, ? super Object> params)
            throws UnsupportedPlatformException, ConfigException
    {
        try {
            logParameters(params);
            return doValidate(params);
        } catch (RuntimeException re) {
            throw new ConfigException(re);
        }

    }

    public boolean doValidate(Map<String, ? super Object> p)
            throws UnsupportedPlatformException, ConfigException
    {
        if (!System.getProperty("os.name").toLowerCase().contains("os x")) {
            throw new UnsupportedPlatformException();
        }
        
        return true;
    }
    
    @Override
    public File execute(Map<String, ? super Object> params, File outputParentDir) {
        return doBundle(params, outputParentDir, false);
    }

}