Merge pull request #259 from proferabg/master

Allow custom enchantments, Fix error printed on ping, Skip decoding on invalid itemstack

Author: Exceptionflug

protocolize-api/src/main/java/dev/simplix/protocolize/api/item/ItemStack.java

@@ -9,6 +9,7 @@
 import io.netty.buffer.Unpooled;
 import lombok.*;
 import lombok.experimental.Accessors;
+import lombok.extern.slf4j.Slf4j;
 import net.querz.nbt.tag.CompoundTag;
 
 import java.util.*;
@@ -20,6 +21,7 @@
  *
  * @author Exceptionflug
  */
+@Slf4j(topic = "Protocolize")
 @Getter
 @Setter
 @Accessors(fluent = true)
@@ -128,11 +130,16 @@ public ItemStack deepClone() {
 
     @Override
     public ItemStack deepClone(int protocolVersion) {
-        ByteBuf buf = Unpooled.buffer();
-        ItemStackSerializer.write(buf, this, protocolVersion);
-        ItemStack itemStack = ItemStackSerializer.read(buf, protocolVersion);
-        buf.release();
-        return itemStack;
+        try {
+            ByteBuf buf = Unpooled.buffer();
+            ItemStackSerializer.write(buf, this, protocolVersion);
+            ItemStack itemStack = ItemStackSerializer.read(buf, protocolVersion);
+            buf.release();
+            return itemStack;
+        } catch (Exception e){
+            log.error("Failed to clone ItemStack", e);
+            return ItemStack.NO_DATA;
+        }
     }
 
     @Override

protocolize-api/src/main/java/dev/simplix/protocolize/api/item/component/EnchantmentsComponent.java

@@ -1,36 +1,41 @@
 package dev.simplix.protocolize.api.item.component;
 
 import dev.simplix.protocolize.api.Protocolize;
+import dev.simplix.protocolize.api.util.Either;
 import dev.simplix.protocolize.data.Enchantment;
 import java.util.Map;
 
 public interface EnchantmentsComponent extends StructuredComponent {
 
-    Map<Enchantment, Integer> getEnchantments();
+    Map<Either<Enchantment, Integer>, Integer> getEnchantments();
 
-    void setEnchantments(Map<Enchantment, Integer> enchantments);
+    void setEnchantments(Map<Either<Enchantment, Integer>, Integer> enchantments);
 
     void removeEnchantment(Enchantment enchantment);
 
+    void removeEnchantment(int enchantmentId);
+
     void addEnchantment(Enchantment enchantment, int level);
 
+    void addEnchantment(int enchantmentId, int level);
+
     void setShowInTooltip(boolean show);
 
     void removeAllEnchantments();
 
-    static EnchantmentsComponent create(Map<Enchantment, Integer> enchantments) {
+    static EnchantmentsComponent create(Map<Either<Enchantment, Integer>, Integer> enchantments) {
         return Protocolize.getService(Factory.class).create(enchantments);
     }
 
-    static EnchantmentsComponent create(Map<Enchantment, Integer> enchantments, boolean showInTooltip) {
+    static EnchantmentsComponent create(Map<Either<Enchantment, Integer>, Integer> enchantments, boolean showInTooltip) {
         return Protocolize.getService(Factory.class).create(enchantments, showInTooltip);
     }
 
     interface Factory {
 
-        EnchantmentsComponent create(Map<Enchantment, Integer> enchantments);
+        EnchantmentsComponent create(Map<Either<Enchantment, Integer>, Integer> enchantments);
 
-        EnchantmentsComponent create(Map<Enchantment, Integer> enchantments, boolean showInTooltip);
+        EnchantmentsComponent create(Map<Either<Enchantment, Integer>, Integer> enchantments, boolean showInTooltip);
 
     }
 

protocolize-api/src/main/java/dev/simplix/protocolize/api/item/component/StoredEnchantmentsComponent.java

@@ -1,37 +1,42 @@
 package dev.simplix.protocolize.api.item.component;
 
 import dev.simplix.protocolize.api.Protocolize;
+import dev.simplix.protocolize.api.util.Either;
 import dev.simplix.protocolize.data.Enchantment;
 
 import java.util.Map;
 
 public interface StoredEnchantmentsComponent extends StructuredComponent {
 
-    Map<Enchantment, Integer> getEnchantments();
+    Map<Either<Enchantment, Integer>, Integer> getEnchantments();
 
-    void setEnchantments(Map<Enchantment, Integer> enchantments);
+    void setEnchantments(Map<Either<Enchantment, Integer>, Integer> enchantments);
 
     void removeEnchantment(Enchantment enchantment);
 
+    void removeEnchantment(int enchantmentId);
+
     void addEnchantment(Enchantment enchantment, int level);
 
+    void addEnchantment(int enchantmentId, int level);
+
     void setShowInTooltip(boolean show);
 
     void removeAllEnchantments();
 
-    static StoredEnchantmentsComponent create(Map<Enchantment, Integer> enchantments) {
+    static StoredEnchantmentsComponent create(Map<Either<Enchantment, Integer>, Integer> enchantments) {
         return Protocolize.getService(Factory.class).create(enchantments);
     }
 
-    static StoredEnchantmentsComponent create(Map<Enchantment, Integer> enchantments, boolean showInTooltip) {
+    static StoredEnchantmentsComponent create(Map<Either<Enchantment, Integer>, Integer> enchantments, boolean showInTooltip) {
         return Protocolize.getService(Factory.class).create(enchantments, showInTooltip);
     }
 
     interface Factory {
 
-        StoredEnchantmentsComponent create(Map<Enchantment, Integer> enchantments);
+        StoredEnchantmentsComponent create(Map<Either<Enchantment, Integer>, Integer> enchantments);
 
-        StoredEnchantmentsComponent create(Map<Enchantment, Integer> enchantments, boolean showInTooltip);
+        StoredEnchantmentsComponent create(Map<Either<Enchantment, Integer>, Integer> enchantments, boolean showInTooltip);
 
     }
 

protocolize-api/src/main/java/dev/simplix/protocolize/api/item/component/exception/InvalidDataComponentTypeException.java

@@ -0,0 +1,8 @@
+package dev.simplix.protocolize.api.item.component.exception;
+
+public class InvalidDataComponentTypeException extends IllegalStateException {
+    public InvalidDataComponentTypeException(int componentId, int protocolVersion) {
+        super("Could not find component type " + componentId + " for protocol version " +
+            protocolVersion + ". This item is not compatible with Protocolize.");
+    }
+}

protocolize-api/src/main/java/dev/simplix/protocolize/api/item/component/exception/InvalidDataComponentVersionException.java

@@ -0,0 +1,9 @@
+package dev.simplix.protocolize.api.item.component.exception;
+
+import dev.simplix.protocolize.api.item.component.StructuredComponentType;
+
+public class InvalidDataComponentVersionException extends IllegalStateException {
+    public InvalidDataComponentVersionException(StructuredComponentType<?> componentType, int protocolVersion) {
+        super("Component " + componentType.getName() + " can not be used on protocol version " + protocolVersion);
+    }
+}

protocolize-velocity/src/main/java/dev/simplix/protocolize/velocity/listener/PlayerListener.java

@@ -59,7 +59,7 @@ public PlayerListener(ProtocolizePlugin plugin) {
     @Subscribe
     public void onPing(ProxyPingEvent event) {
         try {
-            initConnection(event.getConnection());
+            initConnection(event.getConnection(), true);
         } catch (Exception e) {
             log.error("Unable to initialize InboundConnection on ping", e);
         }
@@ -68,7 +68,7 @@ public void onPing(ProxyPingEvent event) {
     @Subscribe
     public void onPreLogin(LoginEvent event) {
         try {
-            initConnection(event.getPlayer());
+            initConnection(event.getPlayer(), false);
         } catch (Exception e) {
             log.error("Unable to initialize InboundConnection on pre login", e);
         }
@@ -88,7 +88,7 @@ public void onDisconnect(DisconnectEvent event) {
         PLAYER_PROVIDER.playerDisconnect(event.getPlayer().getUniqueId());
     }
 
-    private void initConnection(InboundConnection connection) throws ReflectiveOperationException {
+    private void initConnection(InboundConnection connection, boolean isPing) throws ReflectiveOperationException {
         PipelineAccessor accessor = PIPELINE_ACCESSOR_MAP.get(connection.getClass().getName());
         if (accessor == null) {
             throw new UnsupportedOperationException("InboundConnection of type " + connection.getClass().getName()
@@ -102,15 +102,17 @@ private void initConnection(InboundConnection connection) throws ReflectiveOpera
         if (decoderChannelHandler == null) {
             // Ah yes expecting an overridden channel initializer
             ChannelInitializer<Channel> initializer = plugin.currentBackendChannelInitializer();
-            if (initializer.getClass() != ProtocolizeBackendChannelInitializer.class) {
-                log.error("It seems like there is an incompatible plugin installed. Velocity channel initializers are overridden by: {}", initializer.getClass().getName());
-                log.error("Protocolize is unable to work under this circumstances. Please contact the developers of the incompatible " +
-                    "plugin and suggest them to call the initChannel method of the ChannelInitializers before overriding them.");
-                return;
-            } else {
-                // WTF??
-                log.error("Pipeline is not initialized. This is a bug. Please report. Pipeline handlers = {}", pipeline.toMap());
-                log.error("Initializer: {}", initializer.getClass().getName());
+            if(!isPing) {
+                if (initializer.getClass() != ProtocolizeBackendChannelInitializer.class) {
+                    log.error("It seems like there is an incompatible plugin installed. Velocity channel initializers are overridden by: {}", initializer.getClass().getName());
+                    log.error("Protocolize is unable to work under this circumstances. Please contact the developers of the incompatible " +
+                        "plugin and suggest them to call the initChannel method of the ChannelInitializers before overriding them.");
+                    return;
+                } else {
+                    // WTF??
+                    log.error("Pipeline is not initialized. This is a bug. Please report. Pipeline handlers = {}", pipeline.toMap());
+                    log.error("Initializer: {}", initializer.getClass().getName());
+                }
             }
             return;
         }