InternalProviderModuleInfo.java

/*
 * This file is part of NucleusFramework for Bukkit, licensed under the MIT License (MIT).
 *
 * Copyright (c) JCThePants (www.jcwhatever.com)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.jcwhatever.nucleus.internal.providers;

import com.jcwhatever.nucleus.Nucleus;
import com.jcwhatever.nucleus.providers.IProviderInfo;
import com.jcwhatever.nucleus.storage.IDataNode;
import com.jcwhatever.nucleus.utils.CollectionUtils;
import com.jcwhatever.nucleus.utils.modules.YamlModuleInfo;

import org.bukkit.Bukkit;
import org.bukkit.plugin.Plugin;

import java.util.Collections;
import java.util.List;
import java.util.jar.JarFile;

/**
 * Module info for a provider.
 */
public final class InternalProviderModuleInfo extends YamlModuleInfo implements IProviderInfo {

    private String _version;
    private int _logicalVersion;
    private String _description;
    private String _moduleClassName;
    private List<String> _bukkitDepends;
    private List<String> _bukkitSoftDepends;

    /**
     * Constructor.
     *
     * @param jarFile  The jar file that contains the module info.
     */
    public InternalProviderModuleInfo(JarFile jarFile) {
        super(Nucleus.getPlugin(), "provider.yml", jarFile);
    }

    @Override
    public String getVersion() {
        return _version;
    }

    @Override
    public int getLogicalVersion() {
        return _logicalVersion;
    }

    @Override
    public String getDescription() {
        return _description;
    }

    @Override
    public String getModuleClassName() {
        return _moduleClassName;
    }

    @Override
    public List<String> getBukkitDepends() {
        return Collections.unmodifiableList(_bukkitDepends);
    }

    @Override
    public List<String> getBukkitSoftDepends() {
        return Collections.unmodifiableList(_bukkitSoftDepends);
    }

    /**
     * Determine if required dependencies are ready.
     */
    public boolean isDependsReady() {
        return isDependsReady(getBukkitDepends());
    }

    /**
     * Determine if optional dependencies are ready.
     */
    public boolean isSoftDependsReady() {
        return isDependsReady(getBukkitSoftDepends());
    }

    @Override
    protected boolean onLoad(IDataNode dataNode) {

        _version = dataNode.getString("version", "");
        _logicalVersion = dataNode.getInteger("logical-version", 0);
        _description = dataNode.getString("description", "");
        _moduleClassName = dataNode.getString("main");

        _bukkitDepends = dataNode.getStringList(
                "bukkit-depends", CollectionUtils.unmodifiableList(String.class));

        _bukkitSoftDepends = dataNode.getStringList(
                "bukkit-soft-depends", CollectionUtils.unmodifiableList(String.class));

        return _moduleClassName != null;
    }

    private boolean isDependsReady(List<String> depends) {
        for (String name : depends) {
            Plugin plugin = Bukkit.getPluginManager().getPlugin(name);
            if (plugin == null || !plugin.isEnabled())
                return false;
        }
        return true;
    }
}