bugfix: use inbuilt craftbukkit setProfile method if it is available

this helps prevent serializations exceptions for items.
0xRoM · Feb 12, 2021 · 33c0056 · 33c0056
1 parent f595e8b
commit 33c0056
Show file tree

Hide file tree

Showing 12 changed files with 72 additions and 22 deletions.
diff --git a/PlayerHeads-compatibility/PlayerHeads-compatibility-lib/dependency-reduced-pom.xml b/PlayerHeads-compatibility/PlayerHeads-compatibility-lib/dependency-reduced-pom.xml
@@ -3,7 +3,7 @@
   <parent>
     <artifactId>PlayerHeads-compatibility</artifactId>
     <groupId>org.shininet.bukkit</groupId>
-    <version>5.2.14-SNAPSHOT</version>
+    <version>5.2.15-SNAPSHOT</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
   <artifactId>PlayerHeads-compatibility-lib</artifactId>

diff --git a/PlayerHeads-compatibility/PlayerHeads-compatibility-lib/pom.xml b/PlayerHeads-compatibility/PlayerHeads-compatibility-lib/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.shininet.bukkit</groupId>
         <artifactId>PlayerHeads-compatibility</artifactId>
-        <version>5.2.14-SNAPSHOT</version>
+        <version>5.2.15-SNAPSHOT</version>
     </parent>
     <artifactId>PlayerHeads-compatibility-lib</artifactId>
     <packaging>jar</packaging>
@@ -31,7 +31,7 @@
             <!-- This shouldn't be a dep which is packaging: pom -->
             <groupId>${project.groupId}</groupId>
             <artifactId>PlayerHeads-craftbukkit-support</artifactId>
-            <version>5.2.14-SNAPSHOT</version>
+            <version>5.2.15-SNAPSHOT</version>
             <exclusions>
                 <exclusion>
                     <groupId>org.bukkit</groupId>
@@ -67,7 +67,7 @@
             <!-- This shouldn't be a dep which is packaging: pom -->
             <groupId>${project.groupId}</groupId>
             <artifactId>PlayerHeads-craftbukkit-1.8-support</artifactId>
-            <version>5.2.14-SNAPSHOT</version>
+            <version>5.2.15-SNAPSHOT</version>
             <exclusions>
                 <exclusion>
                     <groupId>org.bukkit</groupId>
@@ -79,14 +79,14 @@
             <!-- This shouldn't be a dep which is packaging: pom -->
             <groupId>${project.groupId}</groupId>
             <artifactId>PlayerHeads-craftbukkit-1.13-support</artifactId>
-            <version>5.2.14-SNAPSHOT</version>
+            <version>5.2.15-SNAPSHOT</version>
         </dependency>
 
         <dependency>
             <!-- This shouldn't be a dep which is packaging: pom -->
             <groupId>${project.groupId}</groupId>
             <artifactId>PlayerHeads-paperapi-support</artifactId>
-            <version>5.2.14-SNAPSHOT</version>
+            <version>5.2.15-SNAPSHOT</version>
             <exclusions>
                 <exclusion>
                     <groupId>org.bukkit</groupId>
@@ -107,7 +107,7 @@
             <!-- This shouldn't be a dep which is packaging: pom -->
             <groupId>${project.groupId}</groupId>
             <artifactId>PlayerHeads-glowstone-1.12-support</artifactId>
-            <version>5.2.14-SNAPSHOT</version>
+            <version>5.2.15-SNAPSHOT</version>
             <exclusions>
                 <exclusion>
                     <groupId>org.bukkit</groupId>

diff --git a/PlayerHeads-compatibility/PlayerHeads-craftbukkit-1.13-support/pom.xml b/PlayerHeads-compatibility/PlayerHeads-craftbukkit-1.13-support/pom.xml
@@ -9,7 +9,7 @@
     <parent>
         <artifactId>PlayerHeads-compatibility</artifactId>
         <groupId>org.shininet.bukkit</groupId>
-        <version>5.2.14-SNAPSHOT</version>
+        <version>5.2.15-SNAPSHOT</version>
     </parent>
 
     <organization>
@@ -62,7 +62,7 @@
             <!-- This shouldn't be a dep which is packaging: pom -->
             <groupId>${project.groupId}</groupId>
             <artifactId>PlayerHeads-craftbukkit-support</artifactId>
-            <version>5.2.14-SNAPSHOT</version>
+            <version>5.2.15-SNAPSHOT</version>
             <exclusions>
                 <exclusion>
                     <groupId>org.bukkit</groupId>

diff --git a/PlayerHeads-compatibility/PlayerHeads-craftbukkit-1.8-support/pom.xml b/PlayerHeads-compatibility/PlayerHeads-craftbukkit-1.8-support/pom.xml
@@ -9,7 +9,7 @@
     <parent>
         <artifactId>PlayerHeads-compatibility</artifactId>
         <groupId>org.shininet.bukkit</groupId>
-        <version>5.2.14-SNAPSHOT</version>
+        <version>5.2.15-SNAPSHOT</version>
     </parent>
 
     <organization>
@@ -46,7 +46,7 @@
             <!-- This shouldn't be a dep which is packaging: pom -->
             <groupId>${project.groupId}</groupId>
             <artifactId>PlayerHeads-craftbukkit-support</artifactId>
-            <version>5.2.14-SNAPSHOT</version>
+            <version>5.2.15-SNAPSHOT</version>
             <exclusions>
                 <exclusion>
                     <groupId>org.bukkit</groupId>

diff --git a/PlayerHeads-compatibility/PlayerHeads-craftbukkit-support/pom.xml b/PlayerHeads-compatibility/PlayerHeads-craftbukkit-support/pom.xml
@@ -9,7 +9,7 @@
     <parent>
         <artifactId>PlayerHeads-compatibility</artifactId>
         <groupId>org.shininet.bukkit</groupId>
-        <version>5.2.14-SNAPSHOT</version>
+        <version>5.2.15-SNAPSHOT</version>
     </parent>
 
 

diff --git a/.../main/java/com/github/crashdemons/playerheads/compatibility/craftbukkit/ProfileUtils.java b/.../main/java/com/github/crashdemons/playerheads/compatibility/craftbukkit/ProfileUtils.java
@@ -8,11 +8,10 @@
 import com.github.crashdemons.playerheads.compatibility.CompatibleProfile;
 import com.mojang.authlib.GameProfile;
 import java.lang.reflect.Field;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
 import java.util.UUID;
-import org.bukkit.Bukkit;
-import org.bukkit.OfflinePlayer;
 import org.bukkit.block.Skull;
-import org.bukkit.inventory.meta.ItemMeta;
 import org.bukkit.inventory.meta.SkullMeta;
 
 /**
@@ -32,6 +31,12 @@ private static Field getProfileField(Object skull) throws IllegalArgumentExcepti
         profileField.setAccessible(true);
         return profileField;
     }
+    private static Method getCBProfileMethod(Object skull) throws IllegalArgumentException,NoSuchMethodException,SecurityException,IllegalAccessException{
+        if(!(skull instanceof SkullMeta || skull instanceof Skull)) throw new IllegalArgumentException("Object is not a supported type: SkullMeta or Skull (blockstate)");
+        Method profileMethod = skull.getClass().getDeclaredMethod("setProfile", GameProfile.class);
+        profileMethod.setAccessible(true);
+        return profileMethod;
+    }
 
     //-------------------------------------------------------------------------
 
@@ -47,8 +52,23 @@ public static CompatibleProfile getProfile(Object skull) throws IllegalStateExce
         if(profile==null) return new CompatibleProfileCB();
         return new CompatibleProfileCB(profile);
     }
+
+
+    private static boolean setInternalProfileCB(Object skull, GameProfile profile) throws IllegalStateException{
+        try {
+            getCBProfileMethod(skull).invoke(skull, profile);
+            return true;
+        } catch (NoSuchMethodException | InvocationTargetException | SecurityException | IllegalAccessException error) {
+            return false;
+        }
+    }
+
     public static boolean setInternalProfile(Object skull, GameProfile profile) throws IllegalStateException{
         try {
+            /* in some version of Spigot after 1.8, a method was added to set the profile, which also sets serialization data
+            we shouuld prefer using the craftbukkit method over directly accessing the profile field in order to serialize correctly.
+            */
+            if(setInternalProfileCB(skull,profile)) return true; 
             getProfileField(skull).set(skull, profile);
             return true;
         } catch (IllegalArgumentException | NoSuchFieldException | SecurityException | IllegalAccessException error) {

diff --git a/PlayerHeads-compatibility/PlayerHeads-glowstone-1.12-support/pom.xml b/PlayerHeads-compatibility/PlayerHeads-glowstone-1.12-support/pom.xml
@@ -9,7 +9,7 @@
     <parent>
         <artifactId>PlayerHeads-compatibility</artifactId>
         <groupId>org.shininet.bukkit</groupId>
-        <version>5.2.14-SNAPSHOT</version>
+        <version>5.2.15-SNAPSHOT</version>
     </parent>
 
     <organization>
@@ -83,7 +83,7 @@
             <!-- This shouldn't be a dep which is packaging: pom -->
             <groupId>${project.groupId}</groupId>
             <artifactId>PlayerHeads-paperapi-support</artifactId>
-            <version>5.2.14-SNAPSHOT</version>
+            <version>5.2.15-SNAPSHOT</version>
             <exclusions>
                 <exclusion>
                     <groupId>*</groupId>

diff --git a/PlayerHeads-compatibility/PlayerHeads-paperapi-support/pom.xml b/PlayerHeads-compatibility/PlayerHeads-paperapi-support/pom.xml
@@ -9,7 +9,7 @@
     <parent>
         <artifactId>PlayerHeads-compatibility</artifactId>
         <groupId>org.shininet.bukkit</groupId>
-        <version>5.2.14-SNAPSHOT</version>
+        <version>5.2.15-SNAPSHOT</version>
     </parent>
 
 

diff --git a/...src/main/java/com/github/crashdemons/playerheads/compatibility/paperapi/ProfileUtils.java b/...src/main/java/com/github/crashdemons/playerheads/compatibility/paperapi/ProfileUtils.java
@@ -8,6 +8,8 @@
 import com.destroystokyo.paper.profile.PlayerProfile;
 import com.github.crashdemons.playerheads.compatibility.CompatibleProfile;
 import java.lang.reflect.Field;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
 import java.util.UUID;
 import org.bukkit.block.Skull;
 import org.bukkit.inventory.meta.SkullMeta;
@@ -29,6 +31,12 @@ private static Field getProfileField(Object skull) throws IllegalArgumentExcepti
         profileField.setAccessible(true);
         return profileField;
     }
+    private static Method getPAProfileMethod(Object skull) throws IllegalArgumentException,NoSuchMethodException,SecurityException,IllegalAccessException{
+        if(!(skull instanceof SkullMeta || skull instanceof Skull)) throw new IllegalArgumentException("Object is not a supported type: SkullMeta or Skull (blockstate)");
+        Method profileMethod = skull.getClass().getDeclaredMethod("setProfile", PlayerProfile.class);
+        profileMethod.setAccessible(true);
+        return profileMethod;
+    }
 
     //-------------------------------------------------------------------------
 
@@ -44,8 +52,22 @@ public static CompatibleProfile getProfile(Object skull) throws IllegalStateExce
         if(profile==null) return new CompatibleProfilePA();
         return new CompatibleProfilePA(profile);
     }
+
+    private static boolean setInternalProfilePA(Object skull, PlayerProfile profile) throws IllegalStateException{
+        try {
+            getPAProfileMethod(skull).invoke(skull, profile);
+            return true;
+        } catch (NoSuchMethodException | InvocationTargetException | SecurityException | IllegalAccessException error) {
+            return false;
+        }
+    }
+
     public static boolean setInternalProfile(Object skull, PlayerProfile profile) throws IllegalStateException{
         try {
+            /* in some version of Spigot after 1.8, a method was added to set the profile, which also sets serialization data
+            we shouuld prefer using the craftbukkit method over directly accessing the profile field in order to serialize correctly.
+            */
+            if(setInternalProfilePA(skull,profile)) return true; 
             getProfileField(skull).set(skull, profile);
             return true;
         } catch (IllegalArgumentException | NoSuchFieldException | SecurityException | IllegalAccessException error) {

diff --git a/PlayerHeads-compatibility/pom.xml b/PlayerHeads-compatibility/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.shininet.bukkit</groupId>
         <artifactId>PlayerHeads</artifactId>
-        <version>5.2.14-SNAPSHOT</version>
+        <version>5.2.15-SNAPSHOT</version>
     </parent>
     <artifactId>PlayerHeads-compatibility</artifactId>
     <packaging>pom</packaging>

diff --git a/PlayerHeads-crossversion-plugin/dependency-reduced-pom.xml b/PlayerHeads-crossversion-plugin/dependency-reduced-pom.xml
@@ -3,7 +3,7 @@
   <parent>
     <artifactId>PlayerHeads</artifactId>
     <groupId>org.shininet.bukkit</groupId>
-    <version>5.2.14-SNAPSHOT</version>
+    <version>5.2.15-SNAPSHOT</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
   <groupId>org.shininet.bukkit</groupId>
@@ -190,6 +190,14 @@
           <artifactId>commons-lang</artifactId>
           <groupId>commons-lang</groupId>
         </exclusion>
+        <exclusion>
+          <artifactId>guava</artifactId>
+          <groupId>com.google.guava</groupId>
+        </exclusion>
+        <exclusion>
+          <artifactId>gson</artifactId>
+          <groupId>com.google.code.gson</groupId>
+        </exclusion>
         <exclusion>
           <artifactId>bungeecord-chat</artifactId>
           <groupId>net.md-5</groupId>

diff --git a/PlayerHeads-crossversion-plugin/pom.xml b/PlayerHeads-crossversion-plugin/pom.xml
@@ -47,7 +47,7 @@
             <!-- This shouldn't be a dep which is packaging: pom -->
             <groupId>${project.groupId}</groupId>
             <artifactId>PlayerHeads-core</artifactId>
-            <version>5.2.14-SNAPSHOT</version>
+            <version>5.2.15-SNAPSHOT</version>
             <exclusions>
                 <exclusion>
                     <groupId>org.bukkit</groupId>
@@ -59,7 +59,7 @@
             <!-- This shouldn't be a dep which is packaging: pom -->
             <groupId>${project.groupId}</groupId>
             <artifactId>PlayerHeads-compatibility-lib</artifactId>
-            <version>5.2.14-SNAPSHOT</version>
+            <version>5.2.15-SNAPSHOT</version>
             <scope>compile</scope>
             <exclusions>
                 <exclusion>