Switch Bukkit config handling to ConfigLib (#229)

Author: AlexProgrammerDE

bukkit/build.gradle.kts

@@ -5,6 +5,7 @@ plugins {
 dependencies {
     implementation("net.pistonmaster:PistonUtils:1.4.0")
     implementation("org.bstats:bstats-bukkit:3.1.0")
+    implementation("de.exlll:configlib-yaml:4.6.3")
 
     compileOnly("net.dmulloy2:ProtocolLib:5.4.0")
     compileOnly("org.spigotmc:spigot-api:1.18.1-R0.1-SNAPSHOT")

bukkit/src/main/java/net/pistonmaster/pistonqueue/bukkit/PistonQueueBukkit.java

@@ -19,19 +19,32 @@
  */
 package net.pistonmaster.pistonqueue.bukkit;
 
+import de.exlll.configlib.NameFormatters;
+import de.exlll.configlib.YamlConfigurations;
 import lombok.Getter;
 import net.md_5.bungee.api.ChatColor;
+import net.pistonmaster.pistonqueue.bukkit.config.BukkitConfig;
 import net.pistonmaster.pistonutils.update.GitHubUpdateChecker;
 import net.pistonmaster.pistonutils.update.SemanticVersion;
 import org.bukkit.World;
+import org.bukkit.configuration.file.YamlConfiguration;
 import org.bukkit.plugin.java.JavaPlugin;
 
+import java.io.File;
 import java.io.IOException;
-import java.util.logging.Logger;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.HashSet;
+import java.util.Set;
+import java.util.function.Consumer;
+import java.util.function.IntConsumer;
 import java.util.logging.Level;
+import java.util.logging.Logger;
 
 @Getter
 public final class PistonQueueBukkit extends JavaPlugin {
+  private final Set<String> warnedLegacyPaths = new HashSet<>();
+  private BukkitConfig pluginConfig;
   private boolean forceLocation;
 
   private String forcedWorldName;
@@ -72,36 +85,13 @@ public void onEnable() {
     log.info(ChatColor.BLUE + "PistonQueue V" + getDescription().getVersion());
 
     log.info(ChatColor.BLUE + "Loading config");
-    saveDefaultConfig();
-
-    forceLocation = getConfig().getBoolean("forceLocation");
-    forcedWorldName = getConfig().getString("forcedWorldName");
-    forcedX = getConfig().getInt("forcedX");
-    forcedY = getConfig().getInt("forcedY");
-    forcedZ = getConfig().getInt("forcedZ");
-    hidePlayers = getConfig().getBoolean("hidePlayers");
-    restrictMovement = getConfig().getBoolean("restrictMovement");
-    forceGamemode = getConfig().getBoolean("forceGamemode");
-    disableChat = getConfig().getBoolean("disableChat");
-    disableCmd = getConfig().getBoolean("disableCmd");
-    forcedGamemode = getConfig().getString("forcedGamemode");
-    team = getConfig().getBoolean("team");
-    teamName = getConfig().getString("teamName");
-
-    preventExperience = getConfig().getBoolean("preventExperience");
-    preventDamage = getConfig().getBoolean("preventDamage");
-    preventHunger = getConfig().getBoolean("preventHunger");
-
-    disableDebug = getConfig().getBoolean("disableDebug");
-
-    noChunkPackets = getConfig().getBoolean("noChunkPackets");
-    noTimePackets = getConfig().getBoolean("noTimePackets");
-    noHealthPackets = getConfig().getBoolean("noHealthPackets");
-    noAdvancementPackets = getConfig().getBoolean("noAdvancementPackets");
-    noExperiencePackets = getConfig().getBoolean("noExperiencePackets");
-    showHeadPacket = getConfig().getBoolean("showHeadPacket");
-
-    playXP = getConfig().getBoolean("playXP");
+    try {
+      pluginConfig = loadConfig();
+    } catch (IOException e) {
+      throw new IllegalStateException("Failed to load config", e);
+    }
+
+    applyConfig(pluginConfig);
 
     log.info(ChatColor.BLUE + "Preparing server");
     if (hidePlayers) {
@@ -149,4 +139,134 @@ public void onEnable() {
   public void onDisable() {
     this.getServer().getMessenger().unregisterOutgoingPluginChannel(this);
   }
+
+  private BukkitConfig loadConfig() throws IOException {
+    Path dataFolder = getDataFolder().toPath();
+    if (Files.notExists(dataFolder)) {
+      Files.createDirectories(dataFolder);
+    }
+
+    Path configFile = dataFolder.resolve("config.yml");
+    BukkitConfig config = YamlConfigurations.update(
+      configFile,
+      BukkitConfig.class,
+      builder -> builder.setNameFormatter(NameFormatters.IDENTITY)
+    );
+
+    if (applyLegacyOverrides(configFile.toFile(), config)) {
+      YamlConfigurations.save(configFile, BukkitConfig.class, config);
+    }
+
+    return config;
+  }
+
+  private void applyConfig(BukkitConfig config) {
+    forceLocation = config.location.enabled;
+    forcedWorldName = config.location.world;
+    forcedX = config.location.coordinates.x;
+    forcedY = config.location.coordinates.y;
+    forcedZ = config.location.coordinates.z;
+
+    hidePlayers = config.visibility.hidePlayers;
+    restrictMovement = config.visibility.restrictMovement;
+    forceGamemode = config.visibility.forceGamemode.enabled;
+    forcedGamemode = config.visibility.forceGamemode.mode;
+    team = config.visibility.team.enabled;
+    teamName = config.visibility.team.name;
+
+    disableChat = config.communication.disableChat;
+    disableCmd = config.communication.disableCommands;
+
+    playXP = config.audio.playXpSound;
+
+    preventExperience = config.protections.preventExperience;
+    preventDamage = config.protections.preventDamage;
+    preventHunger = config.protections.preventHunger;
+
+    disableDebug = config.protocolLib.disableDebug;
+    noChunkPackets = config.protocolLib.suppressPackets.chunk;
+    noTimePackets = config.protocolLib.suppressPackets.time;
+    noHealthPackets = config.protocolLib.suppressPackets.health;
+    noAdvancementPackets = config.protocolLib.suppressPackets.advancement;
+    noExperiencePackets = config.protocolLib.suppressPackets.experience;
+    showHeadPacket = config.protocolLib.showFullHead;
+  }
+
+  private boolean applyLegacyOverrides(File file, BukkitConfig config) {
+    if (file == null || !file.exists()) {
+      return false;
+    }
+
+    YamlConfiguration legacy = YamlConfiguration.loadConfiguration(file);
+    boolean updated = false;
+
+    updated |= copyBoolean(legacy, "forceLocation", "location.enabled", value -> config.location.enabled = value);
+    updated |= copyString(legacy, "forcedWorldName", "location.world", value -> config.location.world = value);
+    updated |= copyInt(legacy, "forcedX", "location.coordinates.x", value -> config.location.coordinates.x = value);
+    updated |= copyInt(legacy, "forcedY", "location.coordinates.y", value -> config.location.coordinates.y = value);
+    updated |= copyInt(legacy, "forcedZ", "location.coordinates.z", value -> config.location.coordinates.z = value);
+
+    updated |= copyBoolean(legacy, "hidePlayers", "visibility.hidePlayers", value -> config.visibility.hidePlayers = value);
+    updated |= copyBoolean(legacy, "restrictMovement", "visibility.restrictMovement", value -> config.visibility.restrictMovement = value);
+    updated |= copyBoolean(legacy, "forceGamemode", "visibility.forceGamemode.enabled", value -> config.visibility.forceGamemode.enabled = value);
+    updated |= copyString(legacy, "forcedGamemode", "visibility.forceGamemode.mode", value -> config.visibility.forceGamemode.mode = value);
+    updated |= copyBoolean(legacy, "team", "visibility.team.enabled", value -> config.visibility.team.enabled = value);
+    updated |= copyString(legacy, "teamName", "visibility.team.name", value -> config.visibility.team.name = value);
+
+    updated |= copyBoolean(legacy, "disableChat", "communication.disableChat", value -> config.communication.disableChat = value);
+    updated |= copyBoolean(legacy, "disableCmd", "communication.disableCommands", value -> config.communication.disableCommands = value);
+
+    updated |= copyBoolean(legacy, "playXP", "audio.playXpSound", value -> config.audio.playXpSound = value);
+
+    updated |= copyBoolean(legacy, "preventExperience", "protections.preventExperience", value -> config.protections.preventExperience = value);
+    updated |= copyBoolean(legacy, "preventDamage", "protections.preventDamage", value -> config.protections.preventDamage = value);
+    updated |= copyBoolean(legacy, "preventHunger", "protections.preventHunger", value -> config.protections.preventHunger = value);
+
+    updated |= copyBoolean(legacy, "disableDebug", "protocolLib.disableDebug", value -> config.protocolLib.disableDebug = value);
+    updated |= copyBoolean(legacy, "noChunkPackets", "protocolLib.suppressPackets.chunk", value -> config.protocolLib.suppressPackets.chunk = value);
+    updated |= copyBoolean(legacy, "noTimePackets", "protocolLib.suppressPackets.time", value -> config.protocolLib.suppressPackets.time = value);
+    updated |= copyBoolean(legacy, "noHealthPackets", "protocolLib.suppressPackets.health", value -> config.protocolLib.suppressPackets.health = value);
+    updated |= copyBoolean(legacy, "noAdvancementPackets", "protocolLib.suppressPackets.advancement", value -> config.protocolLib.suppressPackets.advancement = value);
+    updated |= copyBoolean(legacy, "noExperiencePackets", "protocolLib.suppressPackets.experience", value -> config.protocolLib.suppressPackets.experience = value);
+    updated |= copyBoolean(legacy, "showHeadPacket", "protocolLib.showFullHead", value -> config.protocolLib.showFullHead = value);
+
+    return updated;
+  }
+
+  private boolean copyBoolean(YamlConfiguration legacy, String legacyPath, String newPath, Consumer<Boolean> setter) {
+    if (!legacy.contains(legacyPath)) {
+      return false;
+    }
+
+    setter.accept(legacy.getBoolean(legacyPath));
+    logLegacyUsage(newPath, legacyPath);
+    return true;
+  }
+
+  private boolean copyInt(YamlConfiguration legacy, String legacyPath, String newPath, IntConsumer setter) {
+    if (!legacy.contains(legacyPath)) {
+      return false;
+    }
+
+    setter.accept(legacy.getInt(legacyPath));
+    logLegacyUsage(newPath, legacyPath);
+    return true;
+  }
+
+  private boolean copyString(YamlConfiguration legacy, String legacyPath, String newPath, Consumer<String> setter) {
+    if (!legacy.contains(legacyPath)) {
+      return false;
+    }
+
+    setter.accept(legacy.getString(legacyPath));
+    logLegacyUsage(newPath, legacyPath);
+    return true;
+  }
+
+  private void logLegacyUsage(String newPath, String legacyPath) {
+    if (warnedLegacyPaths.add(legacyPath)) {
+      getLogger()
+        .warning(String.format("Configuration option '%s' has moved to '%s'. Please update your config.", legacyPath, newPath));
+    }
+  }
 }

bukkit/src/main/java/net/pistonmaster/pistonqueue/bukkit/config/BukkitConfig.java

@@ -0,0 +1,145 @@
+package net.pistonmaster.pistonqueue.bukkit.config;
+
+import de.exlll.configlib.Comment;
+import de.exlll.configlib.Configuration;
+
+@Configuration
+public final class BukkitConfig {
+  @Comment("Force the user to remain in a certain position.")
+  public LocationSection location = new LocationSection();
+
+  @Comment(
+    "Visibility controls. Hiding players also disables join/leave messages."
+  )
+  public VisibilitySection visibility = new VisibilitySection();
+
+  @Comment("Options that prevent communication while waiting in queue.")
+  public CommunicationSection communication = new CommunicationSection();
+
+  @Comment("Audio feedback played when the proxy sends plugin messages.")
+  public AudioSection audio = new AudioSection();
+
+  @Comment("General player protection toggles applied while in queue.")
+  public ProtectionsSection protections = new ProtectionsSection();
+
+  @Comment({ "ProtocolLib specific options", "Only applied when ProtocolLib is present" })
+  public ProtocolLibSection protocolLib = new ProtocolLibSection();
+
+  @Configuration
+  public static final class LocationSection {
+    @Comment("Force the user to remain in a certain position.")
+    public boolean enabled = true;
+
+    @Comment("Forced world")
+    public String world = "world_the_end";
+
+    @Comment("Forced coordinates")
+    public CoordinatesSection coordinates = new CoordinatesSection();
+  }
+
+  @Configuration
+  public static final class CoordinatesSection {
+    @Comment("Forced x coordinate")
+    public int x = 500;
+
+    @Comment("Forced y coordinate")
+    public int y = 256;
+
+    @Comment("Forced z coordinate")
+    public int z = 500;
+  }
+
+  @Configuration
+  public static final class VisibilitySection {
+    @Comment(
+      "Hide players from each other so that it looks like every user is alone in the world."
+    )
+    public boolean hidePlayers = true;
+
+    @Comment("Prevent players from moving.")
+    public boolean restrictMovement = true;
+
+    @Comment("Force players to remain in a gamemode.")
+    public ForceGamemodeSection forceGamemode = new ForceGamemodeSection();
+
+    @Comment("Show a player's own name to themselves in spectator menu.")
+    public TeamSection team = new TeamSection();
+  }
+
+  @Configuration
+  public static final class ForceGamemodeSection {
+    @Comment("Force players to remain in a gamemode.")
+    public boolean enabled = true;
+
+    @Comment("The gamemode to force players to remain in.")
+    public String mode = "spectator";
+  }
+
+  @Configuration
+  public static final class TeamSection {
+    @Comment("Show a player's own name to themselves in spectator menu.")
+    public boolean enabled = false;
+
+    @Comment("The team name the user sees. (Valid placeholders: %player_name%, %random%)")
+    public String name = "%player_name%";
+  }
+
+  @Configuration
+  public static final class CommunicationSection {
+    @Comment("Don't allow players to chat.")
+    public boolean disableChat = true;
+
+    @Comment("Don't allow commands.")
+    public boolean disableCommands = true;
+  }
+
+  @Configuration
+  public static final class AudioSection {
+    @Comment("Plays an XP sound when the proxy sends a plugin message.")
+    public boolean playXpSound = true;
+  }
+
+  @Configuration
+  public static final class ProtectionsSection {
+    @Comment("Prevents players from gaining experience.")
+    public boolean preventExperience = true;
+
+    @Comment("Prevents players from getting damage.")
+    public boolean preventDamage = true;
+
+    @Comment("Prevents players from gaining hunger.")
+    public boolean preventHunger = true;
+  }
+
+  @Configuration
+  public static final class ProtocolLibSection {
+    @Comment("Doesn't show the client's position on F3.")
+    public boolean disableDebug = true;
+
+    @Comment("Packets that should be suppressed when ProtocolLib is installed.")
+    public SuppressPacketsSection suppressPackets = new SuppressPacketsSection();
+
+    @Comment(
+      "Does not send entity metadata anymore, causing that the entire player head is shown while in spectator."
+    )
+    public boolean showFullHead = true;
+  }
+
+  @Configuration
+  public static final class SuppressPacketsSection {
+    @Comment("Do not send chunk data packets.")
+    public boolean chunk = true;
+
+    @Comment("Do not send time packets.")
+    public boolean time = true;
+
+    @Comment("Do not send health packets.")
+    public boolean health = true;
+
+    @Comment("Do not send advancement packets.")
+    public boolean advancement = true;
+
+    @Comment("Do not send experience packets.")
+    public boolean experience = true;
+  }
+}