Rewrite how mob/item/block metadata is tracked/retrieved

Fixes #4720

Changelog.txt

@@ -1,4 +1,9 @@
 Version 2.1.210
+    Fixed a memory leak involving mob metadata
+
+    NOTES:
+    There was a big rewrite in this update relating to how various types of metadata were being tracked/stored/retrieved
+    If you run into issues with this version of mcMMO, please post about it on GitHub
 
 Version 2.1.209
     Fixed a bug where some config files did not get trimmed completely

src/main/java/com/gmail/nossr50/config/PersistentDataConfig.java

@@ -1,6 +1,6 @@
 package com.gmail.nossr50.config;
 
-import com.gmail.nossr50.util.compat.layers.persistentdata.MobMetaFlagType;
+import com.gmail.nossr50.metadata.MobMetaFlagType;
 
 public class PersistentDataConfig extends BukkitConfig {
     private static PersistentDataConfig instance;

src/main/java/com/gmail/nossr50/listeners/EntityListener.java

@@ -10,6 +10,8 @@
 import com.gmail.nossr50.events.fake.FakeEntityTameEvent;
 import com.gmail.nossr50.events.skills.rupture.McMMOEntityDamageByRuptureEvent;
 import com.gmail.nossr50.mcMMO;
+import com.gmail.nossr50.metadata.MobMetaFlagType;
+import com.gmail.nossr50.metadata.MobMetadataService;
 import com.gmail.nossr50.party.PartyManager;
 import com.gmail.nossr50.runnables.TravelingBlockMetaCleanup;
 import com.gmail.nossr50.skills.archery.Archery;
@@ -19,8 +21,6 @@
 import com.gmail.nossr50.skills.taming.TamingManager;
 import com.gmail.nossr50.skills.unarmed.UnarmedManager;
 import com.gmail.nossr50.util.*;
-import com.gmail.nossr50.util.compat.layers.persistentdata.AbstractPersistentDataLayer;
-import com.gmail.nossr50.util.compat.layers.persistentdata.MobMetaFlagType;
 import com.gmail.nossr50.util.player.NotificationManager;
 import com.gmail.nossr50.util.player.UserManager;
 import com.gmail.nossr50.util.random.RandomChanceUtil;
@@ -51,7 +51,7 @@
 
 public class EntityListener implements Listener {
     private final mcMMO pluginRef;
-    private final @NotNull AbstractPersistentDataLayer persistentDataLayer;
+    private final @NotNull MobMetadataService mobMetadataService;
 
     /**
      * We can use this {@link NamespacedKey} for {@link Enchantment} comparisons to
@@ -61,7 +61,7 @@ public class EntityListener implements Listener {
 
     public EntityListener(final mcMMO pluginRef) {
         this.pluginRef = pluginRef;
-        persistentDataLayer = mcMMO.getCompatibilityManager().getPersistentDataLayer();
+        mobMetadataService = mcMMO.getMetadataService().getMobMetadataService();
     }
 
 //    @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
@@ -94,11 +94,11 @@ public void onEntityTransform(EntityTransformEvent event) {
             LivingEntity livingEntity = (LivingEntity) event.getEntity();
 
             //Transfer metadata keys from mob-spawned mobs to new mobs
-            if(persistentDataLayer.hasMobFlags(livingEntity)) {
+            if(mobMetadataService.hasMobFlags(livingEntity)) {
                 for(Entity entity : event.getTransformedEntities()) {
                     if(entity instanceof LivingEntity) {
                         LivingEntity transformedEntity = (LivingEntity) entity;
-                        persistentDataLayer.addMobFlags(livingEntity, transformedEntity);
+                        mobMetadataService.addMobFlags(livingEntity, transformedEntity);
                     }
                 }
             }
@@ -122,8 +122,8 @@ public void onEntityTargetEntity(EntityTargetLivingEntityEvent event) {
             if(event.getEntity() instanceof Enderman) {
                 Enderman enderman = (Enderman) event.getEntity();
 
-                if(!persistentDataLayer.hasMobFlag(MobMetaFlagType.EXPLOITED_ENDERMEN, enderman)) {
-                    persistentDataLayer.flagMetadata(MobMetaFlagType.EXPLOITED_ENDERMEN, enderman);
+                if(!mobMetadataService.hasMobFlag(MobMetaFlagType.EXPLOITED_ENDERMEN, enderman)) {
+                    mobMetadataService.flagMetadata(MobMetaFlagType.EXPLOITED_ENDERMEN, enderman);
                 }
             }
         }
@@ -729,19 +729,19 @@ public void onCreatureSpawn(CreatureSpawnEvent event) {
     }
 
     private void trackSpawnedAndPassengers(LivingEntity livingEntity, MobMetaFlagType mobMetaFlagType) {
-        persistentDataLayer.flagMetadata(mobMetaFlagType, livingEntity);
+        mobMetadataService.flagMetadata(mobMetaFlagType, livingEntity);
 
         for(Entity passenger : livingEntity.getPassengers()) {
             if(passenger != null) {
-                persistentDataLayer.flagMetadata(mobMetaFlagType, livingEntity);
+                mobMetadataService.flagMetadata(mobMetaFlagType, livingEntity);
             }
         }
     }
 
     @EventHandler(ignoreCancelled = true, priority = EventPriority.HIGHEST)
     public void onEntityBreed(EntityBreedEvent event) {
         if(ExperienceConfig.getInstance().isCOTWBreedingPrevented()) {
-            if(persistentDataLayer.hasMobFlag(MobMetaFlagType.COTW_SUMMONED_MOB, event.getFather()) || persistentDataLayer.hasMobFlag(MobMetaFlagType.COTW_SUMMONED_MOB, event.getMother())) {
+            if(mobMetadataService.hasMobFlag(MobMetaFlagType.COTW_SUMMONED_MOB, event.getFather()) || mobMetadataService.hasMobFlag(MobMetaFlagType.COTW_SUMMONED_MOB, event.getMother())) {
                 event.setCancelled(true);
                 Animals mom = (Animals) event.getMother();
                 Animals father = (Animals) event.getFather();
@@ -1007,12 +1007,12 @@ public void onEntityTame(EntityTameEvent event) {
 
         if (!UserManager.hasPlayerDataKey(player)
                 || (ExperienceConfig.getInstance().isNPCInteractionPrevented() && Misc.isNPCEntityExcludingVillagers(livingEntity))
-                || persistentDataLayer.hasMobFlag(MobMetaFlagType.EGG_MOB, livingEntity)
-                || persistentDataLayer.hasMobFlag(MobMetaFlagType.MOB_SPAWNER_MOB, livingEntity)) {
+                || mobMetadataService.hasMobFlag(MobMetaFlagType.EGG_MOB, livingEntity)
+                || mobMetadataService.hasMobFlag(MobMetaFlagType.MOB_SPAWNER_MOB, livingEntity)) {
             return;
         }
 
-        persistentDataLayer.flagMetadata(MobMetaFlagType.PLAYER_TAMED_MOB, livingEntity);
+        mobMetadataService.flagMetadata(MobMetaFlagType.PLAYER_TAMED_MOB, livingEntity);
 
         //Profile not loaded
         if(UserManager.getPlayer(player) == null)

src/main/java/com/gmail/nossr50/mcMMO.java

@@ -18,6 +18,7 @@
 import com.gmail.nossr50.datatypes.skills.PrimarySkillType;
 import com.gmail.nossr50.datatypes.skills.subskills.acrobatics.Roll;
 import com.gmail.nossr50.listeners.*;
+import com.gmail.nossr50.metadata.MetadataService;
 import com.gmail.nossr50.party.PartyManager;
 import com.gmail.nossr50.runnables.SaveTimerTask;
 import com.gmail.nossr50.runnables.backups.CleanBackupsTask;
@@ -77,8 +78,9 @@
 public class mcMMO extends JavaPlugin {
 
 
-    /* Managers */
+    /* Managers & Services */
     private static PlatformManager platformManager;
+    private static MetadataService metadataService;
     private static ChunkManager       placeStore;
     private static RepairableManager  repairableManager;
     private static SalvageableManager salvageableManager;
@@ -175,6 +177,9 @@ public void onEnable() {
             //Platform Manager
             platformManager = new PlatformManager();
 
+            //metadata service
+            metadataService = new MetadataService(this);
+
             //Filter out any debug messages (if debug/verbose logging is not enabled)
             getLogger().setFilter(new LogFilter(this));
 
@@ -466,6 +471,10 @@ public static UpgradeManager getUpgradeManager() {
         return platformManager.getCompatibilityManager();
     }
 
+    public static MetadataService getMetadataService() {
+        return metadataService;
+    }
+
     @Deprecated
     public static void setDatabaseManager(DatabaseManager databaseManager) {
         mcMMO.databaseManager = databaseManager;

src/main/java/com/gmail/nossr50/metadata/BlockMetadataService.java

@@ -0,0 +1,49 @@
+package com.gmail.nossr50.metadata;
+
+import com.gmail.nossr50.mcMMO;
+import org.bukkit.block.Furnace;
+import org.bukkit.persistence.PersistentDataContainer;
+import org.bukkit.persistence.PersistentDataHolder;
+import org.bukkit.persistence.PersistentDataType;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.UUID;
+
+import static com.gmail.nossr50.metadata.MetadataService.NSK_FURNACE_UUID_LEAST_SIG;
+import static com.gmail.nossr50.metadata.MetadataService.NSK_FURNACE_UUID_MOST_SIG;
+
+public class BlockMetadataService {
+
+    private final @NotNull mcMMO pluginRef;
+
+    public BlockMetadataService(@NotNull mcMMO pluginRef) {
+        this.pluginRef = pluginRef;
+    }
+
+    public @Nullable UUID getFurnaceOwner(@NotNull Furnace furnace) {
+        //Get container from entity
+        PersistentDataContainer dataContainer = ((PersistentDataHolder) furnace).getPersistentDataContainer();
+
+        //Too lazy to make a custom data type for this stuff
+        Long mostSigBits = dataContainer.get(NSK_FURNACE_UUID_MOST_SIG, PersistentDataType.LONG);
+        Long leastSigBits = dataContainer.get(NSK_FURNACE_UUID_LEAST_SIG, PersistentDataType.LONG);
+
+        if (mostSigBits != null && leastSigBits != null) {
+            return new UUID(mostSigBits, leastSigBits);
+        } else {
+            return null;
+        }
+    }
+
+    public void setFurnaceOwner(@NotNull Furnace furnace, @NotNull UUID uuid) {
+        PersistentDataContainer dataContainer = ((PersistentDataHolder) furnace).getPersistentDataContainer();
+
+        dataContainer.set(NSK_FURNACE_UUID_MOST_SIG, PersistentDataType.LONG, uuid.getMostSignificantBits());
+        dataContainer.set(NSK_FURNACE_UUID_LEAST_SIG, PersistentDataType.LONG, uuid.getLeastSignificantBits());
+
+        furnace.update();
+    }
+
+
+}

src/main/java/com/gmail/nossr50/metadata/ItemMetadataService.java

@@ -0,0 +1,110 @@
+package com.gmail.nossr50.metadata;
+
+import com.gmail.nossr50.mcMMO;
+import org.bukkit.enchantments.Enchantment;
+import org.bukkit.inventory.ItemStack;
+import org.bukkit.inventory.meta.ItemMeta;
+import org.bukkit.persistence.PersistentDataContainer;
+import org.bukkit.persistence.PersistentDataType;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.List;
+
+import static com.gmail.nossr50.metadata.MetadataService.NSK_SUPER_ABILITY_BOOSTED_ITEM;
+
+public class ItemMetadataService {
+
+    public final @NotNull String LEGACY_ABILITY_TOOL_LORE = "mcMMO Ability Tool";
+    public final @NotNull mcMMO pluginRef;
+
+    public ItemMetadataService(@NotNull mcMMO pluginRef) {
+        this.pluginRef = pluginRef;
+    }
+
+    public void setSuperAbilityBoostedItem(@NotNull ItemStack itemStack, int originalDigSpeed) {
+        if (itemStack.getItemMeta() == null) {
+            mcMMO.p.getLogger().severe("Can not assign persistent data to an item with null item metadata");
+            return;
+        }
+
+        ItemMeta itemMeta = itemStack.getItemMeta();
+        PersistentDataContainer dataContainer = itemMeta.getPersistentDataContainer();
+
+        dataContainer.set(NSK_SUPER_ABILITY_BOOSTED_ITEM, PersistentDataType.INTEGER, originalDigSpeed);
+
+        itemStack.setItemMeta(itemMeta);
+    }
+
+    public boolean isSuperAbilityBoosted(@NotNull ItemStack itemStack) {
+        if (itemStack.getItemMeta() == null)
+            return false;
+
+        ItemMeta itemMeta = itemStack.getItemMeta();
+        //Get container from entity
+        PersistentDataContainer dataContainer = itemMeta.getPersistentDataContainer();
+
+        //If this value isn't null, then the tool can be considered dig speed boosted
+        Integer boostValue = dataContainer.get(NSK_SUPER_ABILITY_BOOSTED_ITEM, PersistentDataType.INTEGER);
+
+        return boostValue != null;
+    }
+
+    public int getSuperAbilityToolOriginalDigSpeed(@NotNull ItemStack itemStack) {
+        //Get container from entity
+        ItemMeta itemMeta = itemStack.getItemMeta();
+
+        if (itemMeta == null)
+            return 0;
+
+        PersistentDataContainer dataContainer = itemMeta.getPersistentDataContainer();
+
+        if (dataContainer.get(NSK_SUPER_ABILITY_BOOSTED_ITEM, PersistentDataType.INTEGER) == null) {
+            mcMMO.p.getLogger().severe("Value should never be null for a boosted item");
+            return 0;
+        } else {
+            //Too lazy to make a custom data type for this stuff
+            Integer boostValue = dataContainer.get(NSK_SUPER_ABILITY_BOOSTED_ITEM, PersistentDataType.INTEGER);
+            return Math.max(boostValue, 0);
+        }
+    }
+
+    public void removeBonusDigSpeedOnSuperAbilityTool(@NotNull ItemStack itemStack) {
+        int originalSpeed = getSuperAbilityToolOriginalDigSpeed(itemStack);
+        ItemMeta itemMeta = itemStack.getItemMeta();
+
+        if(itemMeta != null) {
+            //TODO: can be optimized
+            if (itemMeta.hasEnchant(Enchantment.DIG_SPEED)) {
+                itemMeta.removeEnchant(Enchantment.DIG_SPEED);
+            }
+
+            if (originalSpeed > 0) {
+                itemMeta.addEnchant(Enchantment.DIG_SPEED, originalSpeed, true);
+            }
+
+            PersistentDataContainer dataContainer = itemMeta.getPersistentDataContainer();
+            dataContainer.remove(NSK_SUPER_ABILITY_BOOSTED_ITEM); //Remove persistent data
+
+            //TODO: needed?
+            itemStack.setItemMeta(itemMeta);
+        }
+    }
+
+    public boolean isLegacyAbilityTool(@NotNull ItemStack itemStack) {
+        ItemMeta itemMeta = itemStack.getItemMeta();
+
+        if (itemMeta == null)
+            return false;
+
+        List<String> lore = itemMeta.getLore();
+
+        if (lore == null || lore.isEmpty())
+            return false;
+
+        return lore.contains(LEGACY_ABILITY_TOOL_LORE);
+    }
+
+    public @NotNull String getLegacyAbilityToolLore() {
+        return LEGACY_ABILITY_TOOL_LORE;
+    }
+}

src/main/java/com/gmail/nossr50/metadata/MetadataService.java

@@ -0,0 +1,71 @@
+package com.gmail.nossr50.metadata;
+
+import com.gmail.nossr50.mcMMO;
+import com.gmail.nossr50.util.MetadataConstants;
+import org.bukkit.NamespacedKey;
+import org.jetbrains.annotations.NotNull;
+
+public class MetadataService {
+    private final @NotNull mcMMO pluginRef;
+
+    protected static final @NotNull NamespacedKey NSK_SUPER_ABILITY_BOOSTED_ITEM;
+    protected static final @NotNull NamespacedKey NSK_MOB_SPAWNER_MOB;
+    protected static final @NotNull NamespacedKey NSK_EGG_MOB;
+    protected static final @NotNull NamespacedKey NSK_NETHER_GATE_MOB;
+    protected static final @NotNull NamespacedKey NSK_COTW_SUMMONED_MOB;
+    protected static final @NotNull NamespacedKey NSK_PLAYER_BRED_MOB;
+    protected static final @NotNull NamespacedKey NSK_PLAYER_TAMED_MOB;
+    protected static final @NotNull NamespacedKey NSK_VILLAGER_TRADE_ORIGIN_ITEM;
+    protected static final @NotNull NamespacedKey NSK_EXPLOITED_ENDERMEN;
+    protected static final @NotNull NamespacedKey NSK_FURNACE_UUID_MOST_SIG;
+    protected static final @NotNull NamespacedKey NSK_FURNACE_UUID_LEAST_SIG;
+
+    static {
+        NSK_SUPER_ABILITY_BOOSTED_ITEM = getNamespacedKey(MetadataConstants.METADATA_KEY_SUPER_ABILITY_BOOSTED_ITEM);
+        NSK_MOB_SPAWNER_MOB = getNamespacedKey(MetadataConstants.METADATA_KEY_MOB_SPAWNER_MOB);
+        NSK_EGG_MOB = getNamespacedKey(MetadataConstants.METADATA_KEY_EGG_MOB);
+        NSK_NETHER_GATE_MOB = getNamespacedKey(MetadataConstants.METADATA_KEY_NETHER_PORTAL_MOB);
+        NSK_COTW_SUMMONED_MOB = getNamespacedKey(MetadataConstants.METADATA_KEY_COTW_SUMMONED_MOB);
+        NSK_PLAYER_BRED_MOB = getNamespacedKey(MetadataConstants.METADATA_KEY_PLAYER_BRED_MOB);
+        NSK_PLAYER_TAMED_MOB = getNamespacedKey(MetadataConstants.METADATA_KEY_PLAYER_TAMED_MOB);
+        NSK_VILLAGER_TRADE_ORIGIN_ITEM = getNamespacedKey(MetadataConstants.METADATA_KEY_VILLAGER_TRADE_ORIGIN_ITEM);
+        NSK_EXPLOITED_ENDERMEN = getNamespacedKey(MetadataConstants.METADATA_KEY_EXPLOITED_ENDERMEN);
+        NSK_FURNACE_UUID_MOST_SIG = getNamespacedKey(MetadataConstants.METADATA_KEY_FURNACE_UUID_MOST_SIG);
+        NSK_FURNACE_UUID_LEAST_SIG = getNamespacedKey(MetadataConstants.METADATA_KEY_FURNACE_UUID_LEAST_SIG);
+    }
+
+    private final @NotNull ItemMetadataService itemMetadataService;
+    private final @NotNull MobMetadataService mobMetadataService;
+    private final @NotNull BlockMetadataService blockMetadataService;
+
+    public MetadataService(@NotNull mcMMO pluginRef) {
+        this.pluginRef = pluginRef;
+
+        blockMetadataService = new BlockMetadataService(pluginRef);
+        mobMetadataService = new MobMetadataService(pluginRef);
+        itemMetadataService = new ItemMetadataService(pluginRef);
+    }
+
+    /**
+     * Helper method to simplify generating namespaced keys
+     *
+     * @param key the {@link String} value of the key
+     *
+     * @return the generated {@link NamespacedKey}
+     */
+    public static @NotNull NamespacedKey getNamespacedKey(@NotNull String key) {
+        return new NamespacedKey(mcMMO.p, key);
+    }
+
+    public @NotNull ItemMetadataService getItemMetadataService() {
+        return itemMetadataService;
+    }
+
+    public @NotNull MobMetadataService getMobMetadataService() {
+        return mobMetadataService;
+    }
+
+    public @NotNull BlockMetadataService getBlockMetadataService() {
+        return blockMetadataService;
+    }
+}

src/main/java/com/gmail/nossr50/util/compat/layers/persistentdata/MobMetaFlagType.java → src/main/java/com/gmail/nossr50/metadata/MobMetaFlagType.java

@@ -1,4 +1,4 @@
-package com.gmail.nossr50.util.compat.layers.persistentdata;
+package com.gmail.nossr50.metadata;
 
 public enum MobMetaFlagType {
     MOB_SPAWNER_MOB,