PluginModel.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 java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.Map;
import java.util.TreeMap;
import java.util.concurrent.CopyOnWriteArrayList;
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.PluginParameterFactory;
import nu.xom.Document;
import nu.xom.Element;
import nu.xom.ParsingException;
import nu.xom.Serializer;
import org.apache.log4j.Category;
import org.apache.log4j.Logger;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.xml.sax.SAXException;
 
public class PluginModel<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> implements Iterable<Plugin<G, A, R>> {
 
    @NotNull
    private static final Category LOG = Logger.getLogger(PluginModel.class);
 
    @NotNull
    private final PluginParameterFactory<G, A, R> pluginParameterFactory;
 
    @NotNull
    private final PluginModelParser<G, A, R> pluginModelParser;
 
    @NotNull
    private final Map<String, Plugin<G, A, R>> plugins = new TreeMap<>();
 
    @NotNull
    private final Collection<PluginModelListener<G, A, R>> listeners = new CopyOnWriteArrayList<>();
 
    public PluginModel(@NotNull final PluginParameterFactory<G, A, R> pluginParameterFactory, @NotNull final PluginModelParser<G, A, R> pluginModelParser) {
        this.pluginParameterFactory = pluginParameterFactory;
        this.pluginModelParser = pluginModelParser;
    }
 
    @Nullable
    public Plugin<G, A, R> getPlugin(@NotNull final String name) {
        return plugins.get(name);
    }
 
    public int getPluginCount() {
        return plugins.size();
    }
 
    @Nullable
    public Plugin<G, A, R> getPlugin(final int index) {
        final Iterator<Plugin<G, A, R>> it = plugins.values().iterator();
        Plugin<G, A, R> m = null;
        int i = index;
        while (it.hasNext() && i-- >= 0) {
            m = it.next();
        }
        return i >= 0 ? null : m;
    }
 
    public boolean addPlugin(@NotNull final Plugin<G, A, R> plugin) {
        if (plugins.containsKey(plugin.getName())) {
            return false;
        }
 
        plugins.put(plugin.getName(), plugin);
        firePluginCreatedEvent(plugin);
        firePluginRegisteredEvent(plugin);
        return true;
    }
 
    public void addPlugin(@NotNull final File file) {
        try {
            addPlugin(PluginModelLoader.loadXML(pluginModelParser, file));
        } catch (final IOException ex) {
            LOG.warn("can't load plugin: " + ex.getMessage());
        } catch (final ParsingException | SAXException ex) {
            LOG.warn("can't parse plugin: " + ex.getMessage());
        }
    }
 
    public void removePlugin(@NotNull final Plugin<G, A, R> plugin) {
        if (!plugins.containsKey(plugin.getName())) {
            throw new IllegalArgumentException("plugin does not exist: " + plugin.getName());
        }
 
        firePluginUnregisteredEvent(plugin);
        firePluginDeletedEvent(plugin);
        plugins.remove(plugin.getName());
    }
 
    public void savePlugin(@NotNull final Plugin<G, A, R> plugin, @NotNull final File file) throws IOException {
        try (FileOutputStream fos = new FileOutputStream(file)) {
            final Element root = pluginModelParser.toXML(plugin);
            final Document d = new Document(root);
            final Serializer serializer = new Serializer(fos, "UTF-8");
            serializer.setIndent(2);
            serializer.write(d);
        }
    }
 
    public void addPluginModelListener(@NotNull final PluginModelListener<G, A, R> listener) {
        listeners.add(listener);
    }
 
    public void removePluginModelListener(@NotNull final PluginModelListener<G, A, R> listener) {
        listeners.remove(listener);
    }
 
    private void firePluginCreatedEvent(@NotNull final Plugin<G, A, R> plugin) {
        for (final PluginModelListener<G, A, R> listener : listeners) {
            listener.pluginCreated(plugin);
        }
    }
 
    private void firePluginDeletedEvent(@NotNull final Plugin<G, A, R> plugin) {
        for (final PluginModelListener<G, A, R> listener : listeners) {
            listener.pluginDeleted(plugin);
        }
    }
 
    private void firePluginRegisteredEvent(@NotNull final Plugin<G, A, R> plugin) {
        for (final PluginModelListener<G, A, R> listener : listeners) {
            listener.pluginRegistered(plugin);
        }
    }
 
    private void firePluginUnregisteredEvent(@NotNull final Plugin<G, A, R> plugin) {
        for (final PluginModelListener<G, A, R> listener : listeners) {
            listener.pluginUnregistered(plugin);
        }
    }
 
    @NotNull
    @Override
    public Iterator<Plugin<G, A, R>> iterator() {
        return Collections.unmodifiableCollection(plugins.values()).iterator();
    }
 
    public void reRegister(@NotNull final Plugin<G, A, R> plugin) {
        firePluginUnregisteredEvent(plugin);
        firePluginRegisteredEvent(plugin);
    }
 
    @Nullable
    public Plugin<G, A, R> newPlugin(@NotNull final String name, @NotNull final String code) {
        final Plugin<G, A, R> plugin = new Plugin<>(name, pluginParameterFactory);
        plugin.setCode(code);
        return addPlugin(plugin) ? plugin : null;
    }
 
}