PluginController.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.gui.dialog.plugin;
 
import java.awt.Component;
import java.io.File;
import java.io.IOException;
import java.util.Map;
import javax.swing.Action;
import javax.swing.JFileChooser;
import javax.swing.JOptionPane;
import net.sf.gridarta.gui.dialog.plugin.parameter.PluginParameterViewFactory;
import net.sf.gridarta.gui.filter.FilterControl;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.filter.Filter;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.plugin.Plugin;
import net.sf.gridarta.plugin.PluginExecutor;
import net.sf.gridarta.plugin.PluginModel;
import net.sf.gridarta.plugin.PluginModelListener;
import net.sf.gridarta.plugin.PluginParameters;
import net.sf.gridarta.utils.ActionUtils;
import net.sf.gridarta.utils.EditorAction;
import net.sf.gridarta.utils.FileChooserUtils;
import net.sf.gridarta.utils.ResourceIcons;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import net.sf.japi.swing.action.ActionMethod;
import net.sf.japi.swing.action.ReflectionAction;
import org.jetbrains.annotations.NotNull;
 
public class PluginController<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> implements EditorAction {
 
    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
 
    @NotNull
    private final PluginModel<G, A, R> pluginModel;
 
    @NotNull
    private final PluginParameters pluginParameters;
 
    @NotNull
    private final PluginView<G, A, R> view;
 
    @NotNull
    private final Component parent;
 
    @NotNull
    private final FilterControl<G, A, R> filterControl;
 
    @NotNull
    private File pluginsDir;
 
    @NotNull
    private final PluginModelListener<G, A, R> pluginModelListener = new PluginModelListener<G, A, R>() {
 
        @Override
        public void pluginCreated(@NotNull final Plugin<G, A, R> plugin) {
            // ignore
        }
 
        @Override
        public void pluginDeleted(@NotNull final Plugin<G, A, R> plugin) {
            // ignore
        }
 
        @Override
        public void pluginRegistered(@NotNull final Plugin<G, A, R> plugin) {
            final String filterName = "(s)" + plugin.getName();
 
            if (plugin.isFilter()) {
                final Filter<?, ?> filter = plugin.getPluginAsFilter(pluginParameters);
                if (filter != null) {
                    filterControl.addFilter(filterName, filter);
                }
            }
 
            if (plugin.isAutoBoot()) {
                plugin.runPlugin(pluginParameters);
            }
        }
 
        @Override
        public void pluginUnregistered(@NotNull final Plugin<G, A, R> plugin) {
            final String filterName = "(s)" + plugin.getName();
            filterControl.removeFilter(filterName);
        }
 
    };
 
    public PluginController(@NotNull final FilterControl<G, A, R> filterControl, @NotNull final PluginModel<G, A, R> pluginModel, @NotNull final PluginParameters pluginParameters, @NotNull final Component parent, @NotNull final PluginParameterViewFactory<G, A, R> pluginParameterViewFactory, @NotNull final File pluginsDir, @NotNull final ResourceIcons resourceIcons) {
        this.parent = parent;
        this.filterControl = filterControl;
        this.pluginModel = pluginModel;
        this.pluginParameters = pluginParameters;
        this.pluginsDir = pluginsDir;
        view = new PluginView<>(this, pluginModel, pluginParameterViewFactory, resourceIcons);
        pluginModel.addPluginModelListener(pluginModelListener);
    }
 
    public boolean canExit() {
        for (final Plugin<G, A, R> plugin : pluginModel) {
            if (plugin.isModified()) {
                final int result = ACTION_BUILDER.showConfirmDialog(parent, JOptionPane.YES_NO_CANCEL_OPTION, JOptionPane.WARNING_MESSAGE, "pluginConfirmSaveChanges", plugin.getName());
                if (result == JOptionPane.YES_OPTION) {
                    if (!savePlugin(plugin)) {
                        return false;
                    }
                } else if (result == JOptionPane.CANCEL_OPTION || result == JOptionPane.CLOSED_OPTION) {
                    return false;
                }
            }
        }
 
        return true;
    }
 
    public void saveAllPlugins() {
        for (final Plugin<G, A, R> plugin : pluginModel) {
            if (!savePlugin(plugin)) {
                return;
            }
        }
    }
 
    private boolean savePlugin(@NotNull final Plugin<G, A, R> plugin) {
        if (!plugin.isModified()) {
            return true;
        }
 
        try {
            final File file = plugin.getFile();
            if (file == null) {
                if (!savePluginAs(plugin, true)) {
                    return false;
                }
            } else {
                pluginModel.savePlugin(plugin, file);
            }
        } catch (final IOException ex) {
            // XXX: notify user
            return false;
        }
 
        plugin.resetModified();
        return true;
    }
 
    public boolean savePluginAs(@NotNull final Plugin<G, A, R> plugin, final boolean updatePluginFile) {
        final JFileChooser chooser = new JFileChooser();
        final File pluginFile = plugin.getFile();
        FileChooserUtils.setCurrentDirectory(chooser, pluginFile == null ? pluginsDir : pluginFile);
        chooser.setDialogTitle("save plugin " + plugin.getName());
        final int result = chooser.showSaveDialog(null);
        if (result != JFileChooser.APPROVE_OPTION) {
            return false;
        }
 
        final File file = chooser.getSelectedFile();
        if (updatePluginFile) {
            plugin.setFile(file);
        }
        pluginsDir = file.getParentFile();
 
        try {
            pluginModel.savePlugin(plugin, file);
        } catch (final IOException ex) {
            return false;
        }
 
        return true;
    }
 
    public void runPlugin(@NotNull final Plugin<G, A, R> plugin) {
        final Plugin<G, A, R> clonedPlugin = plugin.clonePlugin();
 
        final Map<String, Object> runValues = view.getRunValues(clonedPlugin, parent);
        if (runValues == null) {
            return;
        }
 
        final Runnable pluginRunnable = new PluginExecutor<>(pluginModel, pluginParameters).doRunPlugin(clonedPlugin, view.createConsole(clonedPlugin.getName()), runValues);
        if (pluginRunnable == null) {
            return;
        }
 
        final Thread pluginThread = new Thread(pluginRunnable, clonedPlugin.getName());
        pluginThread.start();
        // XXX: drops thread
    }
 
    @ActionMethod
    public void runPlugin(@NotNull final String name) {
        final Plugin<G, A, R> plugin = pluginModel.getPlugin(name);
        if (plugin != null) {
            runPlugin(plugin);
        }
    }
 
    @NotNull
    public PluginView<G, A, R> getView() {
        return view;
    }
 
    @NotNull
    public Action createRunAction(@NotNull final Plugin<G, A, R> plugin) {
        final Action action = ActionUtils.newAction(ACTION_BUILDER, "Plugin", this, "runPlugin");
        action.putValue(ReflectionAction.REFLECTION_ARGUMENTS, new Object[] { plugin.getName(), });
        action.putValue(Action.NAME, ACTION_BUILDER.format("runPlugin.text", plugin.getName()));
        return action;
    }
 
    @Override
    public void setAction(@NotNull final Action action, @NotNull final String name) {
    }
 
}