PluginManager.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.BorderLayout;
import java.awt.CardLayout;
import java.awt.Color;
import java.awt.Component;
import java.awt.Container;
import java.awt.GridLayout;
import java.util.HashMap;
import java.util.Map;
import javax.swing.AbstractListModel;
import javax.swing.JButton;
import javax.swing.JFrame;
import javax.swing.JList;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.ListModel;
import javax.swing.ListSelectionModel;
import javax.swing.border.LineBorder;
import net.sf.gridarta.gui.dialog.plugin.parameter.PluginParameterViewFactory;
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.Plugin;
import net.sf.gridarta.plugin.PluginModel;
import net.sf.gridarta.plugin.PluginModelListener;
import net.sf.gridarta.utils.ActionBuilderUtils;
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 org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class PluginManager<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
 
    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
 
    @NotNull
    private final JFrame frame = new JFrame(ActionBuilderUtils.getString(ACTION_BUILDER, "pluginManagerTitle"));
 
    @NotNull
    private final JList<Plugin<G, A, R>> scripts;
 
    @NotNull
    private final CardLayout scriptLayout = new CardLayout();
 
    @NotNull
    private final Container scriptPanel = new JPanel(scriptLayout);
 
    @NotNull
    private final PluginController<G, A, R> pluginController;
 
    @NotNull
    private final PluginModel<G, A, R> pluginModel;
 
    @NotNull
    private final PluginParameterViewFactory<G, A, R> pluginParameterViewFactory;
 
    @NotNull
    private final ResourceIcons resourceIcons;
 
    //TODO fix a memory leak. If a script is remove, it stays in hash map along with it's visual component
 
    @NotNull
    private final Map<Plugin<G, A, R>, PluginEditor<G, A, R>> components = new HashMap<>();
 
    public PluginManager(@NotNull final Component parent, @NotNull final PluginController<G, A, R> pluginController, @NotNull final PluginModel<G, A, R> pluginModel, @NotNull final PluginParameterViewFactory<G, A, R> pluginParameterViewFactory, @NotNull final ResourceIcons resourceIcons) {
        this.pluginController = pluginController;
        this.pluginModel = pluginModel;
        this.pluginParameterViewFactory = pluginParameterViewFactory;
        this.resourceIcons = resourceIcons;
        frame.getContentPane().setLayout(new BorderLayout());
        final ListModel<Plugin<G, A, R>> listModel = new AbstractListModel<Plugin<G, A, R>>() {
 
            private static final long serialVersionUID = 1L;
 
            private final PluginModelListener<G, A, R> scriptModelListener = new PluginModelListener<G, A, R>() {
 
                @Override
                public void pluginCreated(@NotNull final Plugin<G, A, R> plugin) {
                    fireContentsChanged(scripts, 0, PluginManager.this.pluginModel.getPluginCount() + 1);
                }
 
                @Override
                public void pluginDeleted(@NotNull final Plugin<G, A, R> plugin) {
                    fireContentsChanged(scripts, 0, PluginManager.this.pluginModel.getPluginCount() + 1);
                }
 
                @Override
                public void pluginRegistered(@NotNull final Plugin<G, A, R> plugin) {
                    fireContentsChanged(scripts, 0, PluginManager.this.pluginModel.getPluginCount() + 1);
                }
 
                @Override
                public void pluginUnregistered(@NotNull final Plugin<G, A, R> plugin) {
                    fireContentsChanged(scripts, 0, PluginManager.this.pluginModel.getPluginCount() + 1);
                }
 
            };
 
            {
                PluginManager.this.pluginModel.addPluginModelListener(scriptModelListener);
            }
 
            @Nullable
            @Override
            public Plugin<G, A, R> getElementAt(final int index) {
                return PluginManager.this.pluginModel.getPlugin(index);
            }
 
            @Override
            public int getSize() {
                return PluginManager.this.pluginModel.getPluginCount();
            }
        };
 
        scripts = new JList<>(listModel);
        scripts.addListSelectionListener(e -> {
            if (!e.getValueIsAdjusting()) {
                showScript(scripts.getSelectedValue());
            }
        });
        scripts.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
        scripts.setBorder(new LineBorder(Color.black, 1));
        scripts.setSelectedIndex(0);
 
        final Container bottomLeft = new JPanel(new GridLayout(2, 1));
        bottomLeft.add(new JButton(ACTION_BUILDER.createAction(false, "pluginManagerNewScript", this)));
        bottomLeft.add(new JButton(ACTION_BUILDER.createAction(false, "pluginManagerRemoveScript", this)));
 
        final Container left = new JPanel(new BorderLayout());
        left.add(scripts, BorderLayout.CENTER);
        left.add(bottomLeft, BorderLayout.SOUTH);
 
        frame.getContentPane().add(left, BorderLayout.WEST);
        frame.getContentPane().add(scriptPanel, BorderLayout.CENTER);
        frame.pack();
        frame.setLocationRelativeTo(parent);
    }
 
    private void showScript(@Nullable final Plugin<G, A, R> plugin) {
        /* using a card layout is a necessary trick as
         * simply removing previous component and putting
         * the new one in the JPanel lead to problem unless
         * we recreate the component each time
         * (the validate process goes strangely and only portions
         * of component are redrawn until window resize :s)
         */
        if (plugin == null) {
            return;
        }
 
        PluginEditor<G, A, R> pluginEditor = components.get(plugin);
        if (pluginEditor == null) {
            pluginEditor = new PluginEditor<>(plugin, pluginController, pluginModel, pluginParameterViewFactory, resourceIcons);
            components.put(plugin, pluginEditor);
            scriptPanel.add(pluginEditor.getComponent(), Integer.toString(pluginEditor.hashCode()));
        }
        scriptLayout.show(scriptPanel, Integer.toString(pluginEditor.hashCode()));
    }
 
    private void removeScript(@NotNull final Plugin<G, A, R> plugin) {
        final PluginEditor<?, ?, ?> scriptEditor = components.get(plugin);
        if (scriptEditor != null) {
            components.remove(plugin);
            scriptPanel.remove(scriptEditor.getComponent());
        }
    }
 
    public void show() {
        frame.setVisible(true);
    }
 
    @ActionMethod
    public void pluginManagerNewScript() {
        final String name = JOptionPane.showInputDialog(scripts, ActionBuilderUtils.getString(ACTION_BUILDER, "pluginManagerNewScriptTitle"));
        if (name == null) {
            return;
        }
 
        final Plugin<G, A, R> plugin = pluginModel.newPlugin(name, "//input your beanshell Code");
        if (plugin == null) {
            final String title = ActionBuilderUtils.getString(ACTION_BUILDER, "pluginManagerNewScriptExists.title");
            final String message = ActionBuilderUtils.format(ACTION_BUILDER, "pluginManagerNewScriptExists.message", name);
            JOptionPane.showMessageDialog(scripts, message, title, JOptionPane.WARNING_MESSAGE);
            return;
        }
 
        showScript(plugin);
    }
 
    @ActionMethod
    public void pluginManagerRemoveScript() {
        final Plugin<G, A, R> plugin = scripts.getSelectedValue();
        if (plugin == null) {
            return;
        }
 
        final String title = ActionBuilderUtils.getString(ACTION_BUILDER, "pluginManagerRemoveScriptConfirm.title");
        final String message = ActionBuilderUtils.format(ACTION_BUILDER, "pluginManagerRemoveScriptConfirm.message", plugin.getName());
        if (JOptionPane.showConfirmDialog(scripts, message, title, JOptionPane.YES_NO_OPTION) != JOptionPane.YES_OPTION) {
            return;
        }
 
        pluginModel.removePlugin(plugin);
        scripts.setSelectedIndex(0);
        removeScript(plugin);
    }
 
}