PluginModelParser.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 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.plugin.parameter.PluginParameterFactory;
import net.sf.gridarta.utils.XmlUtils;
import net.sf.gridarta.utils.xml.ElementsIterable;
import nu.xom.Attribute;
import nu.xom.Element;
import nu.xom.Elements;
import nu.xom.ParentNode;
import nu.xom.Text;
import org.apache.log4j.Category;
import org.apache.log4j.Logger;
import org.jetbrains.annotations.NotNull;
 
public class PluginModelParser<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
 
    @NotNull
    private static final String AUTO_BOOT = "autoboot";
 
    @NotNull
    private static final String FILTER = "filter";
 
    @NotNull
    private static final String BASH = "bash";
 
    @NotNull
    private static final Category LOG = Logger.getLogger(PluginModelParser.class);
 
    @NotNull
    private final PluginParameterFactory<G, A, R> pluginParameterFactory;
 
    public PluginModelParser(@NotNull final PluginParameterFactory<G, A, R> pluginParameterFactory) {
        this.pluginParameterFactory = pluginParameterFactory;
    }
 
    @NotNull
    public Plugin<G, A, R> fromXML(@NotNull final Element node) {
        final Plugin<G, A, R> pluginModel = new Plugin<>(XmlUtils.getChild(node, "name").getValue().trim(), pluginParameterFactory);
        pluginModel.setCode(XmlUtils.getChild(node, "code").getValue().trim());
        boolean isAutoBoot = false;
        boolean isFilter = false;
        boolean isScript = false;
        final Elements modeElements = node.getChildElements("mode");
        if (modeElements.size() == 0) {
            isScript = true;
        } else {
            for (final Element modeChild : new ElementsIterable(modeElements.get(0).getChildElements())) {
                final boolean value = Boolean.valueOf(modeChild.getValue());
                final String name = modeChild.getLocalName();
                if (name.equalsIgnoreCase(AUTO_BOOT) && value) {
                    isAutoBoot = true;
                } else if (name.equalsIgnoreCase(FILTER) && value) {
                    isFilter = true;
                } else if (name.equalsIgnoreCase(BASH) && value) {
                    isScript = true;
                }
            }
        }
        pluginModel.setAutoBoot(isAutoBoot);
        pluginModel.setFilter(isFilter);
        pluginModel.setScript(isScript);
        for (final Element parameter : new ElementsIterable(node.getChildElements("parameter"))) {
            PluginParameter<G, A, R, ?> pluginParameter;
            try {
                pluginParameter = pluginParameterFactory.createParameter(parameter);
            } catch (final NoSuchParameterException ex) {
                LOG.warn("Parameter type " + ex.getMessage() + " in plugin " + pluginModel + " is unknown");
                pluginParameter = pluginParameterFactory.createStringParameter(parameter);
            }
            pluginModel.addParameter(pluginParameter);
        }
        pluginModel.resetModified();
        return pluginModel;
    }
 
    @NotNull
    public Element toXML(@NotNull final Plugin<G, A, R> plugin) {
        final Element root = new Element("script");
        final Element name = new Element("name");
        final Element code = new Element("code");
        name.appendChild(plugin.getName());
        code.appendChild(new Text(plugin.getCode()));
        code.addAttribute(new Attribute("xml:space", "http://www.w3.org/XML/1998/namespace", "preserve"));
        root.appendChild(name);
        root.appendChild(code);
        final ParentNode modes = new Element("mode");
 
        final Element autoBoot = new Element(AUTO_BOOT);
        autoBoot.appendChild(Boolean.toString(plugin.isAutoBoot()));
        final Element bash = new Element(BASH);
        bash.appendChild(Boolean.toString(plugin.isScript()));
        final Element filter = new Element(FILTER);
        filter.appendChild(Boolean.toString(plugin.isFilter()));
        modes.appendChild(autoBoot);
        modes.appendChild(bash);
        modes.appendChild(filter);
 
        root.appendChild(modes);
        for (final PluginParameter<G, A, R, ?> pluginParameter : plugin) {
            root.appendChild(plugin.toXML(pluginParameter));
        }
        return root;
    }
 
}