PluginMessageLibrary.java

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2025 Dreamfire Studio
 *
 * 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.dreamfirestudios.dreamcore.DreamMessagingChannel;
 
import com.google.common.io.ByteArrayDataInput;
import com.google.common.io.ByteStreams;
import org.bukkit.entity.Player;
import org.bukkit.plugin.java.JavaPlugin;
import org.bukkit.plugin.messaging.PluginMessageListener;
 
import java.io.ByteArrayInputStream;
import java.io.DataInputStream;
import java.util.logging.Level;
 
public abstract class PluginMessageLibrary implements PluginMessageListener {
 
    public String getChannelName(JavaPlugin plugin) {
        return DreamPluginMessage.BUNGEE_CHANNEL;
    }
 
    @Override
    public final void onPluginMessageReceived(String channel, Player player, byte[] message) {
        final JavaPlugin plugin = getOwningPlugin();
        if (plugin == null) return;
 
        if (!getChannelName(plugin).equals(channel)) return;
 
        try {
            final ByteArrayDataInput in = ByteStreams.newDataInput(message);
            final String sub = in.readUTF(); // e.g., "PlayerCount", "Forward", etc.
 
            switch (sub) {
                case DreamPluginMessage.SUB_PLAYER_COUNT: {
                    final String server = in.readUTF();
                    final int count = in.readInt();
                    onPlayerCount(server, count);
                    break;
                }
 
                case DreamPluginMessage.SUB_FORWARD: {
                    final String subChannel = in.readUTF();
                    final short len = in.readShort();
                    final byte[] payload = new byte[len];
                    in.readFully(payload);
                    onForward(subChannel, payload, player);
                    break;
                }
 
                case DreamPluginMessage.SUB_FORWARD_TO_PLAYER: {
                    final String subChannel = in.readUTF();
                    final short len = in.readShort();
                    final byte[] payload = new byte[len];
                    in.readFully(payload);
                    onForwardToPlayer(subChannel, payload, player);
                    break;
                }
 
                default:
                    onUnknownSubchannel(sub, message, player);
                    break;
            }
        } catch (Throwable t) {
            plugin.getLogger().log(Level.SEVERE, "Error handling plugin message on " + channel, t);
        }
    }
 
    protected abstract JavaPlugin getOwningPlugin();
 
    /* ===================== Overridable hooks ===================== */
 
    protected void onPlayerCount(String server, int count) {
        JavaPlugin plugin = getOwningPlugin();
        if (plugin != null) {
            plugin.getLogger().info("PlayerCount for " + server + ": " + count);
        }
    }
 
    protected void onForward(String subChannel, byte[] payload, Player receiver) {
        // no-op default
    }
 
    protected void onForwardToPlayer(String subChannel, byte[] payload, Player receiver) {
        // no-op default
    }
 
    protected void onUnknownSubchannel(String sub, byte[] raw, Player player) {
        JavaPlugin plugin = getOwningPlugin();
        if (plugin != null) {
            plugin.getLogger().fine("Unknown Bungee subchannel: " + sub);
        }
    }
}