AbstractScriptRunner.java

/**   
 * License Agreement for OpenSearchServer
 *
 * Copyright (C) 2013 Emmanuel Keller / Jaeksoft
 * 
 * http://www.open-search-server.com
 * 
 * This file is part of OpenSearchServer.
 *
 * OpenSearchServer 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.
 *
 * OpenSearchServer 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 OpenSearchServer. 
 *  If not, see <http://www.gnu.org/licenses/>.
 **/

package com.jaeksoft.searchlib.script;

import java.io.Closeable;

import org.apache.commons.lang3.exception.ExceptionUtils;

import com.jaeksoft.searchlib.Logging;
import com.jaeksoft.searchlib.config.Config;
import com.jaeksoft.searchlib.util.InfoCallback;
import com.jaeksoft.searchlib.util.Variables;

public abstract class AbstractScriptRunner implements Closeable {

	private final boolean externalContext;
	private final ScriptCommandContext context;
	private int errorCount;
	private int ignoredCount;
	private int lineCount;

	protected AbstractScriptRunner(Config config, Variables variables,
			InfoCallback taskLog) {
		this.externalContext = false;
		this.context = new ScriptCommandContext(config, taskLog);
		this.context.addVariables(variables);
	}

	protected AbstractScriptRunner(ScriptCommandContext context) {
		this.externalContext = true;
		this.context = context;
	}

	protected abstract void beforeRun(final ScriptCommandContext context)
			throws ScriptException;

	protected abstract ScriptLine nextScriptLine(
			final ScriptCommandContext context) throws ScriptException;

	protected abstract void updateScriptLine(
			final ScriptCommandContext context, final ScriptLine scriptLine,
			final String errorMsg) throws ScriptException;

	public final void run() throws ScriptException {
		try {
			beforeRun(context);
			errorCount = 0;
			ignoredCount = 0;
			lineCount = 0;
			CommandEnum[] commandFinder = null;
			String lastScriptError = null;
			ScriptLine scriptLine = null;
			while ((scriptLine = nextScriptLine(context)) != null) {
				String currentScriptError = null;
				lineCount++;
				try {
					CommandEnum commandEnum = CommandEnum
							.find(scriptLine.command);
					if (commandFinder != null) {
						// On error next_command is active, looking for next
						// statement
						boolean bFind = false;
						for (CommandEnum cmd : commandFinder) {
							if (cmd == commandEnum) {
								bFind = true;
								break;
							}
						}
						if (!bFind) {
							ignoredCount++;
							updateScriptLine(context, scriptLine, "ignored");
							continue;
						}
						commandFinder = null;
					}
					CommandAbstract commandAbstract = commandEnum
							.getNewInstance();
					commandAbstract.run(context, scriptLine.id,
							scriptLine.parameters);
				} catch (ScriptException.ExitException e) {
					break;
				} catch (ScriptException.NextCommandException e) {
					commandFinder = e.nextCommands;
				} catch (Exception e) {
					Throwable t = ExceptionUtils.getRootCause(e);
					currentScriptError = t != null ? ExceptionUtils
							.getMessage(t) : ExceptionUtils.getMessage(e);
					lastScriptError = currentScriptError;
					errorCount++;
					switch (context.getOnError()) {
					case FAILURE:
						throw new ScriptException(e);
					case RESUME:
						Logging.warn(e);
						break;
					case NEXT_COMMAND:
						Logging.warn(e);
						commandFinder = context.getOnErrorNextCommands();
						break;
					}
				}
				updateScriptLine(context, scriptLine, currentScriptError);
			}
			afterRun(context, lastScriptError);
		} finally {
			close();
		}
	}

	protected abstract void afterRun(final ScriptCommandContext context,
			final String lastScriptError) throws ScriptException;

	public int getErrorCount() {
		return errorCount;
	}

	public int getIgnoredCount() {
		return ignoredCount;
	}

	public int getLineCount() {
		return lineCount;
	}

	public int getUpdatedDocumentCount() {
		return context == null ? 0 : context.getUpdatedDocumentCount();
	}

	@Override
	public void close() {
		if (context != null && !externalContext)
			context.close();
	}
}