notify.growl.GrowlNotifier Maven / Gradle / Ivy

Go to download
package notify.growl;

import javax.script.ScriptEngine;
import javax.script.ScriptEngineManager;
import javax.script.ScriptException;

import notify.MessageType;
import notify.Notifier;
import notify.UnableToNotifyException;
import notify.internal.BaseNotifier;

/**
 * Notify with Growl using AppleScript and Java Script engine.
 * 
 * @see http ://www.jayway.com/2011/04/12/send-growl-notifications-on-os-x-using-a -java-6-script-engine-and-applescript/
 * 
 * @author Tobias S??dergren, Jayway
 * @author francois wauquier
 */
public class GrowlNotifier extends BaseNotifier implements Notifier {

	private static final String GROWL_APPLICATION = "com.Growl.GrowlHelperApp";

	private static final String APPLICATION_NAME = "java.Notify";

	private ScriptEngine appleScriptEngine;

	private boolean registered;

	public GrowlNotifier() {
		super();
	}

	public ScriptEngine createScriptEngine() {
		ScriptEngineManager scriptEngineManager = new ScriptEngineManager();
		return scriptEngineManager.getEngineByName("AppleScript");
	}

	public void registerApplication(String[] notifications) throws ScriptException {
		String script = script().add("tell application id ").quote(GROWL_APPLICATION).nextRow("set the availableList to ").array(notifications).nextRow("set the enabledList to ").array(notifications)
				.nextRow("register as application ").quote(APPLICATION_NAME).add(" all notifications availableList default notifications enabledList").nextRow("end tell").get();
		executeScript(script);
	}

	@Override
	public boolean isSupported() {
		try {
            createScriptEngineIfNecessary();
            registerIfNecessary();
		} catch (IllegalStateException e) {
			return false;
		} catch (UnableToNotifyException ignored) {
            return false;
        }
		return appleScriptEngine != null && registered && isGrowlEnabled();
	}

    private void createScriptEngineIfNecessary() {
        if (appleScriptEngine == null) {
            this.appleScriptEngine = createScriptEngine();
        }
    }

    @Override
	public void notify(MessageType messageType, String title, String message) {
        createScriptEngineIfNecessary();
        registerIfNecessary();
		notify(messageType.name(), prefix(messageType) + title, message);
	}

    private void registerIfNecessary() {
		if (!registered) {
			if (appleScriptEngine == null) {
				throw new IllegalStateException("You are trying to notify with Growl on a non-supported OS");
			}
			try {
				registerApplication(new String[] { "NONE", "INFO", "WARNING", "ERROR" });
			} catch (ScriptException e) {
				throw new UnableToNotifyException("Unable to register Growl Application", e);
			}
			registered = true;
		}
	}

	public void notify(String notificationName, String title, String message) {
		String script = script().add("tell application id ").quote(GROWL_APPLICATION).nextRow("notify with name ").quote(notificationName).add(" title ").quote(title).add(" description ").quote(message)
				.add(" application name ").quote(APPLICATION_NAME).nextRow("end tell").get();
		try {
			executeScript(script);
		} catch (ScriptException e) {
			throw new UnableToNotifyException("Unable to notify with Growl", e);
		}
	}

	private boolean isGrowlEnabled() {
		String script = script().add("tell application ").quote("System Events").nextRow("return count of (every process whose bundle identifier is ").quote(GROWL_APPLICATION).add(") > 0")
				.nextRow("end tell").get();
		long count = executeScript(script, 0L);
		return count > 0;
	}

	@SuppressWarnings("unchecked")
	private  T executeScript(String script, T defaultValue) {
		try {
			return (T) appleScriptEngine.eval(script, appleScriptEngine.getContext());
		} catch (ScriptException e) {
			return defaultValue;
		}
	}

	private void executeScript(String script) throws ScriptException {
		appleScriptEngine.eval(script, appleScriptEngine.getContext());
	}

	private AppleScriptBuilder script() {
		return new AppleScriptBuilder();
	}
}