PacketTypeLookup.java

package com.comphenix.protocol;

import java.util.Collection;
import java.util.Collections;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

import com.comphenix.protocol.PacketType.Protocol;
import com.comphenix.protocol.PacketType.Sender;
import com.comphenix.protocol.collections.IntegerMap;
import com.google.common.base.Preconditions;
import com.google.common.collect.HashMultimap;
import com.google.common.collect.Multimap;

/**
 * Retrieve a packet type based on its version and ID, optionally with protocol and sender too.
 * @author Kristian
 */
class PacketTypeLookup {

    public static class ProtocolSenderLookup {
        // Unroll lookup for performance reasons
        public final IntegerMap<PacketType> HANDSHAKE_CLIENT = new IntegerMap<>();
        public final IntegerMap<PacketType> HANDSHAKE_SERVER = new IntegerMap<>();
        public final IntegerMap<PacketType> GAME_CLIENT = new IntegerMap<>();
        public final IntegerMap<PacketType> GAME_SERVER = new IntegerMap<>();
        public final IntegerMap<PacketType> STATUS_CLIENT = new IntegerMap<>();
        public final IntegerMap<PacketType> STATUS_SERVER = new IntegerMap<>();
        public final IntegerMap<PacketType> LOGIN_CLIENT = new IntegerMap<>();
        public final IntegerMap<PacketType> LOGIN_SERVER = new IntegerMap<>();
        public final IntegerMap<PacketType> CONFIGURATION_CLIENT = new IntegerMap<>();
        public final IntegerMap<PacketType> CONFIGURATION_SERVER = new IntegerMap<>();
        
        /**
         * Retrieve the correct integer map for a specific protocol and sender.
         * @param protocol - the protocol.
         * @param sender - the sender.
         * @return The integer map of packets.
         */
        public IntegerMap<PacketType> getMap(Protocol protocol, Sender sender) {
            switch (protocol) {
                case HANDSHAKING: 
                    return sender == Sender.CLIENT ? HANDSHAKE_CLIENT : HANDSHAKE_SERVER;
                case PLAY:
                    return sender == Sender.CLIENT ? GAME_CLIENT : GAME_SERVER;
                case STATUS:
                    return sender == Sender.CLIENT ? STATUS_CLIENT : STATUS_SERVER;
                case LOGIN:
                    return sender == Sender.CLIENT ? LOGIN_CLIENT : LOGIN_SERVER;
                case CONFIGURATION:
                    return sender == Sender.CLIENT ? CONFIGURATION_CLIENT : CONFIGURATION_SERVER;
                default:
                    throw new IllegalArgumentException("Unable to find protocol " + protocol);
            }
        }
    }

    public static class ClassLookup {
        // Unroll lookup for performance reasons
        public final Map<String, PacketType> HANDSHAKE_CLIENT = new ConcurrentHashMap<>();
        public final Map<String, PacketType> HANDSHAKE_SERVER = new ConcurrentHashMap<>();
        public final Map<String, PacketType> GAME_CLIENT = new ConcurrentHashMap<>();
        public final Map<String, PacketType> GAME_SERVER = new ConcurrentHashMap<>();
        public final Map<String, PacketType> STATUS_CLIENT = new ConcurrentHashMap<>();
        public final Map<String, PacketType> STATUS_SERVER = new ConcurrentHashMap<>();
        public final Map<String, PacketType> LOGIN_CLIENT = new ConcurrentHashMap<>();
        public final Map<String, PacketType> LOGIN_SERVER = new ConcurrentHashMap<>();
        public final Map<String, PacketType> CONFIGURATION_CLIENT = new ConcurrentHashMap<>();
        public final Map<String, PacketType> CONFIGURATION_SERVER = new ConcurrentHashMap<>();

        /**
         * Retrieve the correct integer map for a specific protocol and sender.
         * @param protocol - the protocol.
         * @param sender - the sender.
         * @return The integer map of packets.
         */
        public Map<String, PacketType> getMap(Protocol protocol, Sender sender) {
            switch (protocol) {
                case HANDSHAKING: 
                    return sender == Sender.CLIENT ? HANDSHAKE_CLIENT : HANDSHAKE_SERVER;
                case PLAY:
                    return sender == Sender.CLIENT ? GAME_CLIENT : GAME_SERVER;
                case STATUS:
                    return sender == Sender.CLIENT ? STATUS_CLIENT : STATUS_SERVER;
                case LOGIN:
                    return sender == Sender.CLIENT ? LOGIN_CLIENT : LOGIN_SERVER;
                case CONFIGURATION:
                    return sender == Sender.CLIENT ? CONFIGURATION_CLIENT : CONFIGURATION_SERVER;
                default:
                    throw new IllegalArgumentException("Unable to find protocol " + protocol);
            }
        }
    }
    
    // Packets for 1.7.2
    private final ProtocolSenderLookup idLookup = new ProtocolSenderLookup();

    // Packets for 1.8+
    private final ClassLookup classLookup = new ClassLookup();

    // Packets based on name
    private final Multimap<String, PacketType> nameLookup = HashMultimap.create();

    /**
     * Add a collection of packet types to the lookup.
     * @param types - the types to add.
     */
    public PacketTypeLookup addPacketTypes(Iterable<? extends PacketType> types) {
        Preconditions.checkNotNull(types, "types cannot be NULL");
        
        for (PacketType type : types) {
            // Skip unknown current packets
            if (type.getCurrentId() != PacketType.UNKNOWN_PACKET) {
                idLookup.getMap(type.getProtocol(), type.getSender()).put(type.getCurrentId(), type);
                classLookup.getMap(type.getProtocol(), type.getSender()).put(type.getClassNames().get(0), type);
            }
            nameLookup.put(type.name(), type);
        }
        return this;
    }
    
    /**
     * Retrieve a packet type from a legacy (1.6.4 and below) packet ID.
     * @param packetId - the legacy packet ID.
     * @return The corresponding packet type, or NULL if not found.
     * @deprecated no longer works and will always return null
     */
    @Deprecated
    public PacketType getFromLegacy(int packetId) {
    	return null;
    }
    
    /**
     * Retrieve an unmodifiable view of all the packet types with this name.
     * @param name - the name.
     * @return The packet types, usually one.
     */
    public Collection<PacketType> getFromName(String name) {
        return Collections.unmodifiableCollection(nameLookup.get(name));
    }
    
    /**
     * Retrieve a packet type from a legacy (1.6.4 and below) packet ID.
     * @param packetId - the legacy packet ID.
     * @param preference - which packet type to look for first.
     * @return The corresponding packet type, or NULL if not found.
     * @deprecated no longer works and will always return null
     */
    @Deprecated
    public PacketType getFromLegacy(int packetId, Sender preference) {
    	return null;
    }
    
    /**
     * Retrieve a packet type from a protocol, sender and packet ID.
     * @param protocol - the current protocol.
     * @param sender - the sender.
     * @param packetId - the packet ID.
     * @return The corresponding packet type, or NULL if not found.
     * @deprecated IDs are no longer reliable
     */
    @Deprecated
    public PacketType getFromCurrent(Protocol protocol, Sender sender, int packetId) {
        return idLookup.getMap(protocol, sender).get(packetId);
    }

    public PacketType getFromCurrent(Protocol protocol, Sender sender, String name) {
        return classLookup.getMap(protocol, sender).get(name);
    }

    public ClassLookup getClassLookup() {
        return classLookup;
    }
}