GroovyCondition.java

/*
 * Lilith - a log event viewer.
 * Copyright (C) 2007-2016 Joern Huxhorn
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package de.huxhorn.lilith.conditions;

import de.huxhorn.sulky.conditions.Condition;
import de.huxhorn.sulky.groovy.GroovyInstance;
import groovy.lang.Binding;
import groovy.lang.Script;
import java.io.File;
import java.io.IOException;
import java.io.ObjectInputStream;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class GroovyCondition
	implements LilithCondition, SearchStringCondition
{
	private static final long serialVersionUID = 907179107764473874L;

	private final Logger logger = LoggerFactory.getLogger(GroovyCondition.class);

	private String scriptFileName;
	private String searchString;
	private transient String scriptName;
	private transient GroovyInstance groovyInstance;

	public GroovyCondition()
	{
		this(null);
	}

	public GroovyCondition(String scriptFileName)
	{
		setScriptFileName(scriptFileName);
	}

	public GroovyCondition(String scriptFileName, String searchString)
	{
		setScriptFileName(scriptFileName);
		setSearchString(searchString);
	}

	public String getSearchString()
	{
		return searchString;
	}

	public void setSearchString(String searchString)
	{
		this.searchString = searchString;
	}

	public void setScriptFileName(String scriptFileName)
	{
		if(groovyInstance == null)
		{
			groovyInstance=new GroovyInstance();
		}
		this.scriptFileName = scriptFileName;
		groovyInstance.setGroovyFileName(scriptFileName);
		if(scriptFileName != null)
		{
			File scriptFile = new File(scriptFileName);
			this.scriptName = scriptFile.getName();
		}
	}

	public String getScriptFileName()
	{
		return scriptFileName;
	}

	public boolean isTrue(Object o)
	{
		Object instance = groovyInstance.getInstance();

		if(instance == null)
		{
			logger.warn("Couldn't retrieve condition!\n{}", groovyInstance.getErrorMessage(), groovyInstance.getErrorCause());
			return false;
		}

		try
		{
			if(instance instanceof Condition)
			{
				Condition condition = (Condition) instance;
				return condition.isTrue(o);
			}

			if(instance instanceof Script)
			{
				Script script = (Script) instance;

				Binding binding = new Binding();
				binding.setVariable("input", o);
				binding.setVariable("searchString", searchString);
				binding.setVariable("logger", logger);

				script.setBinding(binding);
				Object result = script.run();
				return !(result == null || result.equals(Boolean.FALSE));
			}
			logger.warn("Expected either Condition or Script but got {} instead!", instance.getClass().getName());
			return false;
		}
		catch(Throwable t)
		{
			logger.warn("Exception while executing '{}'!", scriptFileName, t);
			return false;
		}
	}

	private void readObject(ObjectInputStream in)
		throws IOException, ClassNotFoundException
	{
		in.defaultReadObject();
		setScriptFileName(this.scriptFileName);
	}

	@Override
	public boolean equals(Object o)
	{
		if(this == o) return true;
		if(!(o instanceof GroovyCondition)) return false;

		GroovyCondition that = (GroovyCondition) o;

		if(scriptFileName != null ? !scriptFileName.equals(that.scriptFileName) : that.scriptFileName != null)
		{
			return false;
		}
		return !(searchString != null ? !searchString.equals(that.searchString) : that.searchString != null);

	}

	@Override
	public int hashCode()
	{
		int result = scriptFileName != null ? scriptFileName.hashCode() : 0;
		result = 31 * result + (searchString != null ? searchString.hashCode() : 0);
		return result;
	}

	@Override
	public String toString()
	{
		StringBuilder result = new StringBuilder();
		result.append(getDescription());
		if(searchString != null)
		{
			result.append("(");
			result.append(searchString);
			result.append(")");
		}
		return result.toString();
	}

	public GroovyCondition clone()
		throws CloneNotSupportedException
	{
		GroovyCondition result = (GroovyCondition) super.clone();
		result.setScriptFileName(result.scriptFileName);
		return result;
	}

	public String getDescription()
	{
		return scriptName;
	}
}