CompatibilityLayer framework

2025-08-05 05:55:26 +02:00 · 2020-04-24 20:21:21 -07:00
parent f82ad99c82
commit 5984230bf3
37 changed files with 1292 additions and 123 deletions
--- a/src/main/java/com/gmail/nossr50/util/compat/CompatibilityManager.java
+++ b/src/main/java/com/gmail/nossr50/util/compat/CompatibilityManager.java
@@ -0,0 +1,125 @@
+package com.gmail.nossr50.util.compat;
+
+import com.gmail.nossr50.locale.LocaleLoader;
+import com.gmail.nossr50.mcMMO;
+import com.gmail.nossr50.util.StringUtils;
+import com.gmail.nossr50.util.compat.layers.PlayerAttackCooldownExploitPreventionLayer;
+import com.gmail.nossr50.util.nms.NMSVersion;
+import com.gmail.nossr50.util.platform.MinecraftGameVersion;
+import org.bukkit.command.CommandSender;
+
+import java.util.HashMap;
+
+/**
+ *
+ * These classes are a band-aid solution for adding NMS support into 2.1.XXX
+ * In 2.2 we are switching to modules and that will clean things up significantly
+ *
+ */
+public class CompatibilityManager {
+    private HashMap<CompatibilityType, Boolean> supportedLayers;
+    private boolean isFullyCompatibleServerSoftware = true; //true if all compatibility layers load successfully
+    private final MinecraftGameVersion minecraftGameVersion;
+    private final NMSVersion nmsVersion;
+
+    /* Compatibility Layers */
+    private PlayerAttackCooldownExploitPreventionLayer playerAttackCooldownExploitPreventionLayer;
+
+    public CompatibilityManager(MinecraftGameVersion minecraftGameVersion) {
+        mcMMO.p.getLogger().info("Loading compatibility layers...");
+        this.minecraftGameVersion = minecraftGameVersion;
+        this.nmsVersion = determineNMSVersion();
+        init();
+        mcMMO.p.getLogger().info("Finished loading compatibility layers.");
+    }
+
+    private void init() {
+        initSupportedLayersMap();
+        initCompatibilityLayers();
+    }
+
+    private void initSupportedLayersMap() {
+        supportedLayers = new HashMap<>(); //Init map
+
+        for(CompatibilityType compatibilityType : CompatibilityType.values()) {
+            supportedLayers.put(compatibilityType, false); //All layers are set to false when initialized
+        }
+    }
+
+    /**
+     * Initialize all necessary compatibility layers
+     * For any unsupported layers, load a dummy layer
+     */
+    private void initCompatibilityLayers() {
+        if(nmsVersion == NMSVersion.UNSUPPORTED) {
+            mcMMO.p.getLogger().info("NMS not supported for this version of Minecraft, possible solutions include updating mcMMO or updating your server software. NMS Support is not available on every version of Minecraft.");
+            mcMMO.p.getLogger().info("Certain features of mcMMO that require NMS will be disabled, you can check what is disabled by running the /mmocompat command!");
+            //Load dummy compatibility layers
+            isFullyCompatibleServerSoftware = false;
+            loadDummyCompatibilityLayers();
+        } else {
+            playerAttackCooldownExploitPreventionLayer = new PlayerAttackCooldownExploitPreventionLayer(nmsVersion);
+
+            //Mark as operational
+            if(playerAttackCooldownExploitPreventionLayer.noErrorsOnInitialize()) {
+                supportedLayers.put(CompatibilityType.PLAYER_ATTACK_COOLDOWN_EXPLOIT_PREVENTION, true);
+            }
+        }
+    }
+
+    private void loadDummyCompatibilityLayers() {
+
+    }
+
+    public void reportCompatibilityStatus(CommandSender commandSender) {
+        if(isFullyCompatibleServerSoftware) {
+            commandSender.sendMessage(LocaleLoader.getString("mcMMO.Template.Prefix",
+                    "mcMMO is fully compatible with the currently running server software."));
+        } else {
+            //TODO: Better messages for each incompatible layer
+            for(CompatibilityType compatibilityType : CompatibilityType.values()) {
+                if(!supportedLayers.get(compatibilityType)) {
+                    commandSender.sendMessage(LocaleLoader.getString("mcMMO.Template.Prefix",
+                            "Support layer for " + StringUtils.getCapitalized(compatibilityType.toString()) + "is not supported on this version of Minecraft."));
+                }
+            }
+        }
+
+        commandSender.sendMessage(LocaleLoader.getString("mcMMO.Template.Prefix", "NMS Status - " + nmsVersion.toString()));
+    }
+
+    public boolean isCompatibilityLayerOperational(CompatibilityType compatibilityType) {
+        return supportedLayers.get(compatibilityType);
+    }
+
+    public boolean isFullyCompatibleServerSoftware() {
+        return isFullyCompatibleServerSoftware;
+    }
+
+    public NMSVersion getNmsVersion() {
+        return nmsVersion;
+    }
+
+    private NMSVersion determineNMSVersion() {
+        switch(minecraftGameVersion.getMajorVersion().asInt()) {
+            case 1:
+                switch(minecraftGameVersion.getMinorVersion().asInt()) {
+                    case 12:
+                        return NMSVersion.NMS_1_12_2;
+                    case 13:
+                        return NMSVersion.NMS_1_13_2;
+                    case 14:
+                        return NMSVersion.NMS_1_14_4;
+                    case 15:
+                        return NMSVersion.NMS_1_15_2;
+                }
+        }
+
+        return NMSVersion.UNSUPPORTED;
+    }
+
+    public PlayerAttackCooldownExploitPreventionLayer getPlayerAttackCooldownExploitPreventionLayer() {
+        return playerAttackCooldownExploitPreventionLayer;
+    }
+
+}