org.lanternpowered.server.plugin.InfoPluginContainer.java Source code

Introduction

Here is the source code for org.lanternpowered.server.plugin.InfoPluginContainer.java

Source

/*
 * This file is part of LanternServer, licensed under the MIT License (MIT).
 *
 * Copyright (c) LanternPowered <https://www.lanternpowered.org>
 * Copyright (c) SpongePowered <https://www.spongepowered.org>
 * Copyright (c) contributors
 *
 * 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 org.lanternpowered.server.plugin;

import com.google.common.collect.ImmutableList;
import com.google.common.io.Resources;
import com.google.gson.Gson;
import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import org.spongepowered.plugin.meta.McModInfo;
import org.spongepowered.plugin.meta.PluginMetadata;

import java.io.IOException;
import java.io.StringReader;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.Optional;

import javax.annotation.Nullable;

public class InfoPluginContainer extends AbstractPluginContainer {

    private final ImmutableList<String> authors;
    @Nullable
    private final String description;
    @Nullable
    private final String url;

    public InfoPluginContainer(String id, PluginMetadata pluginMetadata) {
        super(id, pluginMetadata.getName(), pluginMetadata.getVersion());
        this.authors = ImmutableList.copyOf(pluginMetadata.getAuthors());
        this.description = pluginMetadata.getDescription();
        this.url = pluginMetadata.getUrl();
    }

    @Override
    public Optional<String> getDescription() {
        return Optional.ofNullable(this.description);
    }

    @Override
    public Optional<String> getUrl() {
        return Optional.ofNullable(this.url);
    }

    @Override
    public List<String> getAuthors() {
        return this.authors;
    }

    private static final Gson gson = new Gson();

    /**
     * Reads a {code plugin.info} file as {@link PluginMetadata} from the
     * specified plugin id and resource {@link URL}.
     *
     * @param pluginId The plugin id
     * @param url The resource url
     * @return The parsed plugin metadata
     */
    public static PluginMetadata readPluginInfo(String pluginId, URL url) throws IOException {
        final String json = Resources.toString(url, StandardCharsets.UTF_8);
        JsonElement element = gson.fromJson(json, JsonElement.class);
        final JsonObject object;
        if (element.isJsonArray()) {
            // Just get the first element from the array
            object = element.getAsJsonArray().get(0).getAsJsonObject();
        } else {
            // The info is directly serialized as an object, get this object
            // and put it into an array, this is what the McModInfo library
            // supports
            object = element.getAsJsonObject();
            final JsonArray array = new JsonArray();
            array.add(object);
            element = array;
        }
        // Add the 'modid', it is required for the McModInfo
        object.addProperty("modid", pluginId);
        // Convert the element back to json and parse it with the McModInfo library
        final StringReader reader = new StringReader(gson.toJson(element));
        return McModInfo.builder().build().read(reader).get(0);
    }
}