PluginModelLoader.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.IOException;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.errorview.ErrorView;
import net.sf.gridarta.model.errorview.ErrorViewCategory;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.plugin.parameter.PluginParameterFactory;
import nu.xom.Builder;
import nu.xom.Document;
import nu.xom.Element;
import nu.xom.ParsingException;
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;
import org.xml.sax.XMLReader;
import org.xml.sax.helpers.XMLReaderFactory;
 
public class PluginModelLoader<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
 
    private static final Category LOG = Logger.getLogger(PluginModelLoader.class);
 
    private PluginModelLoader() {
    }
 
    @NotNull
    public static <G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> PluginModel<G, A, R> loadPlugins(@NotNull final PluginParameterFactory<G, A, R> pluginParameterFactory, @NotNull final PluginModelParser<G, A, R> pluginModelParser, @NotNull final ErrorView errorView, @NotNull final File pluginsDir) {
        final PluginModel<G, A, R> pluginModel = new PluginModel<>(pluginParameterFactory, pluginModelParser);
        final File[] files = pluginsDir.listFiles();
        if (files == null) {
            errorView.addWarning(ErrorViewCategory.SCRIPTS_DIR_INVALID, pluginsDir + ": directory not readable");
            return pluginModel;
        }
 
        final int pluginCount = pluginModel.getPluginCount();
        for (final File pluginFile : files) {
            final String name = pluginFile.getName();
            if (!name.startsWith(".") && !name.endsWith("~") && pluginFile.isFile()) {
                try {
                    final Plugin<G, A, R> plugin = loadXML(pluginModelParser, pluginFile);
                    if (pluginModel.getPlugin(plugin.getName()) == null) {
                        if (LOG.isDebugEnabled()) {
                            LOG.debug("storing with code " + plugin.getCode());
                        }
                        pluginModel.addPlugin(plugin);
                    } else {
                        errorView.addWarning(ErrorViewCategory.SCRIPTS_FILE_INVALID, pluginFile + ": duplicate plugin '" + plugin.getName() + "'");
                    }
                } catch (final IOException | ParsingException | SAXException ex) {
                    errorView.addWarning(ErrorViewCategory.SCRIPTS_FILE_INVALID, pluginFile + ": " + ex.getMessage());
                }
            }
        }
        if (LOG.isInfoEnabled()) {
            LOG.info("Loaded " + (pluginModel.getPluginCount() - pluginCount) + " plugins from '" + pluginsDir + "'.");
        }
        return pluginModel;
    }
 
    public static <G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> Plugin<G, A, R> loadXML(@NotNull final PluginModelParser<G, A, R> pluginModelParser, @NotNull final File file) throws IOException, ParsingException, SAXException {
        final XMLReader xmlReader = XMLReaderFactory.createXMLReader();
        final Builder builder = new Builder(xmlReader, false);
        final Document d = builder.build(file);
        return loadXML(pluginModelParser, d, file);
    }
 
    @NotNull
    private static <G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> Plugin<G, A, R> loadXML(@NotNull final PluginModelParser<G, A, R> pluginModelParser, @NotNull final Document doc, @Nullable final File file) throws IOException {
        final Element elt = doc.getRootElement();
        if (elt == null) {
            throw new IOException("plugin file is empty");
        }
        if (!elt.getLocalName().equalsIgnoreCase("script")) {
            throw new IOException("missing root element named \"script\"");
        }
 
        final Plugin<G, A, R> plugin = pluginModelParser.fromXML(elt);
        plugin.setFile(file);
        if (LOG.isDebugEnabled()) {
            LOG.debug("plugin: " + plugin.getName());
        }
 
        return plugin;
    }
 
}