PluginExecutor.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2023 The Gridarta Developers.
 *
 * 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 2 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, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
package net.sf.gridarta.plugin;
 
import bsh.ConsoleInterface;
import bsh.EvalError;
import bsh.Interpreter;
import bsh.TargetError;
import java.io.CharArrayWriter;
import java.io.InputStreamReader;
import java.io.PrintStream;
import java.io.PrintWriter;
import java.io.Reader;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.plugin.parameter.NoSuchParameterException;
import net.sf.gridarta.plugin.parameter.PluginParameter;
import net.sf.gridarta.utils.StringUtils;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
@SuppressWarnings("UseOfSystemOutOrSystemErr")
public class PluginExecutor<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
 
    @NotNull
    private final PluginModel<G, A, R> pluginModel;
 
    @NotNull
    private final PluginParameters pluginParameters;
 
    public PluginExecutor(@NotNull final PluginModel<G, A, R> pluginModel, @NotNull final PluginParameters pluginParameters) {
        this.pluginModel = pluginModel;
        this.pluginParameters = pluginParameters;
    }
 
    public int executePlugin(@NotNull final String plugin, @NotNull final Iterable<String> parameters) {
        final Plugin<G, A, R> modelTemplate = pluginModel.getPlugin(plugin);
        if (modelTemplate == null) {
            System.err.println("plugin " + plugin + " does not exist");
            return 1;
        }
 
        final Plugin<G, A, R> clonedPlugin = modelTemplate.clonePlugin();
        final Map<String, Object> runValues = new HashMap<>();
        for (final String parameter : parameters) {
            final String[] tmp = StringUtils.PATTERN_EQUAL.split(parameter, 2);
            if (tmp.length != 2) {
                System.err.println("syntax error: " + parameter);
                return 1;
            }
 
            final int index = clonedPlugin.getParameter(tmp[0]);
            if (index == -1) {
                final StringBuilder sb = new StringBuilder();
                boolean firstParameter = true;
                for (final PluginParameter<?, ?, ?, ?> clonedParameter : clonedPlugin) {
                    sb.append(firstParameter ? " " : ", ");
                    sb.append(clonedParameter.getName());
                    firstParameter = false;
                }
                System.err.println("plugin " + plugin + " has no parameter " + tmp[0] + "; available parameters:" + sb);
                return 1;
            }
 
            final PluginParameter<G, A, R, ?> clonedParameter;
            try {
                clonedParameter = clonedPlugin.getParameter(index);
            } catch (final NoSuchParameterException ex) {
                throw new AssertionError(ex);
            }
            if (!clonedParameter.setStringValue(tmp[1])) {
                System.out.println("invalid value " + tmp[1] + " for parameter " + tmp[0]);
                return 1;
            }
 
            runValues.put(clonedParameter.getName(), tmp[1]);
        }
        for (final PluginParameter<G, A, R, ?> parameter : clonedPlugin) {
            final String parameterName = parameter.getName();
            if (!runValues.containsKey(parameterName)) {
                final Object parameterValue = parameter.getValueOrNull();
                if (parameterValue == null) {
                    System.err.println("no value for parameter " + parameterName);
                    return 1;
                }
                runValues.put(parameterName, parameterValue);
            }
        }
 
        final ConsoleInterface console = new ConsoleInterface() {
 
            @Override
            public Reader getIn() {
                return new InputStreamReader(System.in);
            }
 
            @Override
            public PrintStream getOut() {
                return System.out;
            }
 
            @Override
            public PrintStream getErr() {
                return System.err;
            }
 
            @Override
            public void println(final Object o) {
                System.out.println(o);
            }
 
            @Override
            public void print(final Object o) {
                System.out.print(o);
            }
 
            @Override
            public void error(final Object o) {
                System.err.println(o);
            }
 
        };
        final BshRunnable<G, A, R> pluginRunnable = doRunPlugin(clonedPlugin, console, runValues);
        if (pluginRunnable == null) {
            return 1;
        }
        final Thread pluginThread = new Thread(pluginRunnable, clonedPlugin.getName());
        pluginThread.start();
        try {
            pluginThread.join();
        } catch (final InterruptedException ignored) {
            pluginThread.interrupt();
            Thread.currentThread().interrupt();
            System.out.println("interrupted");
            return 1;
        }
 
        if (!pluginRunnable.isSuccess()) {
            System.err.println("plugin failed");
            return 1;
        }
 
        return 0;
    }
 
    @Nullable
    public BshRunnable<G, A, R> doRunPlugin(@NotNull final Plugin<G, A, R> plugin, @NotNull final ConsoleInterface console, @NotNull final Map<String, Object> parameters) {
        final Interpreter runner = new Interpreter();
        runner.setConsole(console);
        try {
            pluginParameters.setInterpreterValues(runner, PluginRunMode.BATCH);
            for (final Entry<String, Object> parameter : parameters.entrySet()) {
                runner.set(parameter.getKey(), parameter.getValue());
            }
        } catch (final TargetError ex) {
            final CharArrayWriter charArrayWriter = new CharArrayWriter();
            try {
                try (PrintWriter printWriter = new PrintWriter(charArrayWriter)) {
                    ex.getTarget().printStackTrace(printWriter);
                }
            } finally {
                charArrayWriter.close();
            }
            console.print("target error: " + charArrayWriter);
            return null;
        } catch (final EvalError ex) {
            console.print("evaluation error: " + ex.getMessage());
            return null;
        }
        return new BshRunnable<>(plugin, runner);
    }
 
}