Merge pull request #3030 from Multiverse/zax71/MV5/InfoCommand

Add `/mv info`

src/main/java/org/mvplugins/multiverse/core/commands/InfoCommand.java

@@ -0,0 +1,173 @@
+package org.mvplugins.multiverse.core.commands;
+
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+import co.aikar.commands.InvalidCommandArgument;
+import co.aikar.commands.annotation.CommandAlias;
+import co.aikar.commands.annotation.CommandCompletion;
+import co.aikar.commands.annotation.CommandPermission;
+import co.aikar.commands.annotation.Description;
+import co.aikar.commands.annotation.Flags;
+import co.aikar.commands.annotation.Optional;
+import co.aikar.commands.annotation.Subcommand;
+import co.aikar.commands.annotation.Syntax;
+import jakarta.inject.Inject;
+import org.bukkit.ChatColor;
+import org.jetbrains.annotations.NotNull;
+import org.jvnet.hk2.annotations.Service;
+
+import org.mvplugins.multiverse.core.api.LocationManipulation;
+import org.mvplugins.multiverse.core.commandtools.MVCommandIssuer;
+import org.mvplugins.multiverse.core.commandtools.MVCommandManager;
+import org.mvplugins.multiverse.core.commandtools.MultiverseCommand;
+import org.mvplugins.multiverse.core.commandtools.flags.CommandValueFlag;
+import org.mvplugins.multiverse.core.commandtools.flags.ParsedCommandFlags;
+import org.mvplugins.multiverse.core.display.ContentDisplay;
+import org.mvplugins.multiverse.core.display.filters.ContentFilter;
+import org.mvplugins.multiverse.core.display.filters.DefaultContentFilter;
+import org.mvplugins.multiverse.core.display.filters.RegexContentFilter;
+import org.mvplugins.multiverse.core.display.handlers.PagedSendHandler;
+import org.mvplugins.multiverse.core.display.parsers.MapContentProvider;
+import org.mvplugins.multiverse.core.economy.MVEconomist;
+import org.mvplugins.multiverse.core.world.LoadedMultiverseWorld;
+import org.mvplugins.multiverse.core.world.MultiverseWorld;
+
+@Service
+@CommandAlias("mv")
+class InfoCommand extends MultiverseCommand {
+
+    private final CommandValueFlag<Integer> PAGE_FLAG = flag(CommandValueFlag
+            .builder("--page", Integer.class)
+            .addAlias("-p")
+            .context(value -> {
+                try {
+                    return Integer.parseInt(value);
+                } catch (NumberFormatException e) {
+                    throw new InvalidCommandArgument("Invalid page number: " + value);
+                }
+            })
+            .build());
+
+    private final CommandValueFlag<ContentFilter> FILTER_FLAG = flag(CommandValueFlag
+            .builder("--filter", ContentFilter.class)
+            .addAlias("-f")
+            .context(value -> {
+                try {
+                    return RegexContentFilter.fromString(value);
+                } catch (IllegalArgumentException e) {
+                    throw new InvalidCommandArgument("Invalid filter: " + value);
+                }
+            })
+            .build());
+
+    private final LocationManipulation locationManipulation;
+    private final MVEconomist economist;
+
+    @Inject
+    InfoCommand(
+            @NotNull MVCommandManager commandManager,
+            @NotNull LocationManipulation locationManipulation,
+            @NotNull MVEconomist economist) {
+        super(commandManager);
+        this.locationManipulation = locationManipulation;
+        this.economist = economist;
+    }
+
+    // TODO: support info for unloaded worlds
+    @Subcommand("info")
+    @CommandPermission("multiverse.core.info")
+    @CommandCompletion("@mvworlds:scope=both|@flags:groupName=mvinfocommand @flags:groupName=mvinfocommand")
+    @Syntax("[world] [--page <page>] [--filter <filter>]")
+    @Description("{@@mv-core.info.description")
+    public void onInfoCommand(
+            MVCommandIssuer issuer,
+
+            @Flags("resolve=issuerAware")
+            @Syntax("<world>")
+            @Description("{@@mv-core.info.description.world}")
+            LoadedMultiverseWorld world,
+
+            @Optional
+            @Syntax("[--page <page>]")
+            @Description("{@@mv-core.info.description.page}")
+            String[] flags) {
+        ParsedCommandFlags parsedFlags = parseFlags(flags);
+
+        ContentDisplay.create()
+                .addContent(MapContentProvider.forContent(getInfo(world))
+                        .withKeyColor(ChatColor.AQUA)
+                        .withValueColor(ChatColor.WHITE))
+                .withSendHandler(PagedSendHandler.create()
+                        .withHeader(getTitle(world))
+                        .doPagination(true)
+                        .withTargetPage(parsedFlags.flagValue(PAGE_FLAG, 1))
+                        .withFilter(parsedFlags.flagValue(FILTER_FLAG, DefaultContentFilter.get())))
+                .send(issuer);
+    }
+
+    private String getTitle(MultiverseWorld world) {
+        return "&a&l---- World Info: &f&l%s&a&l ----".formatted(world.getName());
+    }
+
+    private Map<String, String> getInfo(LoadedMultiverseWorld world) {
+        Map<String, String> outMap = new LinkedHashMap<>();
+
+        outMap.put("World Name", world.getName());
+        outMap.put("World Alias", world.getAlias());
+        outMap.put("World UID", world.getUID().toString());
+        outMap.put("Game Mode: ", world.getGameMode().toString());
+        outMap.put("Difficulty", world.getDifficulty().toString());
+        outMap.put("Spawn Location", locationManipulation.strCoords(world.getSpawnLocation()));
+        outMap.put("Seed", String.valueOf(world.getSeed()));
+        getEntryFeeInfo(outMap, world); // Entry fee/reward
+        outMap.put("Respawn World", world.getRespawnWorldName());
+        outMap.put("World Type", world.getWorldType().get().toString());
+        outMap.put("Generator", world.getGenerator());
+        outMap.put("Generate Structures", world.canGenerateStructures().get().toString());
+        outMap.put("World Scale", String.valueOf(world.getScale()));
+        outMap.put("Weather Enabled", String.valueOf(world.getAllowWeather()));
+        outMap.put("Hunger Depletes", String.valueOf(world.getHunger()));
+        outMap.put("Keep Spawn In Memory", String.valueOf(world.getKeepSpawnInMemory()));
+        outMap.put("PVP Enabled", String.valueOf(world.getPvp()));
+        getAnimalSpawningInfo(outMap, world); // Animals that can spawn
+        getMonsterSpawningInfo(outMap, world); // Monsters that can spawn
+
+        return outMap;
+    }
+
+    private void getEntryFeeInfo(Map<String, String> outMap, LoadedMultiverseWorld world) {
+        double price = world.getPrice();
+        if (price == 0) {
+            outMap.put("Entry Fee", "FREE!");
+        } else if (price > 0) {
+            outMap.put("Entry Fee", economist.formatPrice(-price, world.getCurrency()));
+        } else if (price < 0) {
+            outMap.put("Entry Reward", economist.formatPrice(price, world.getCurrency()));
+        }
+    }
+
+    private void getAnimalSpawningInfo(Map<String, String> outMap, LoadedMultiverseWorld world) {
+        if (world.getSpawningAnimals()) {
+            outMap.put("Spawning Animals", "ALL");
+        } else {
+            if (!world.getSpawningAnimalsExceptions().isEmpty()) {
+                outMap.put("Spawning Animals", world.getSpawningAnimalsExceptions().toString());
+            } else {
+                outMap.put("Spawning Animals", "NONE");
+            }
+        }
+    }
+
+    private void getMonsterSpawningInfo(Map<String, String> outMap, LoadedMultiverseWorld world) {
+        if (world.getSpawningMonsters()) {
+            outMap.put("Spawning Monsters", "ALL");
+        } else {
+            if (!world.getSpawningMonstersExceptions().isEmpty()) {
+                outMap.put("Spawning Monsters", world.getSpawningMonstersExceptions().toString());
+            } else {
+                outMap.put("Spawning Monsters", "NONE");
+            }
+        }
+    }
+}

src/main/java/org/mvplugins/multiverse/core/display/parsers/MapContentProvider.java

@@ -2,9 +2,9 @@ package org.mvplugins.multiverse.core.display.parsers;
 
 import java.util.Collection;
 import java.util.Map;
-import java.util.stream.Collectors;
 
 import co.aikar.commands.BukkitCommandIssuer;
+import com.google.common.base.Strings;
 import org.bukkit.ChatColor;
 import org.jetbrains.annotations.NotNull;
 
@@ -45,8 +45,15 @@ public class MapContentProvider<K, V> implements ContentProvider {
     @Override
     public Collection<String> parse(@NotNull BukkitCommandIssuer issuer) {
         return map.entrySet().stream()
-                .map(e -> String.format(format, keyColor, e.getKey(), separator, valueColor, e.getValue()))
+                .map(e -> String.format(format, keyColor, e.getKey(), separator, valueColor, formatValue(e.getValue())))
-                .collect(Collectors.toList());
+                .toList();
+    }
+
+    private String formatValue(V value) {
+        if (value instanceof String stringValue) {
+            return Strings.isNullOrEmpty(stringValue) ? "&7&onull" : stringValue;
+        }
+        return value == null ? "&7&onull" : String.valueOf(value);
     }
 
     /**

src/main/java/org/mvplugins/multiverse/core/world/LoadedMultiverseWorld.java

@@ -103,6 +103,15 @@ public class LoadedMultiverseWorld extends MultiverseWorld {
         return location;
     }
 
+    /**
+     * Gets the Unique ID of this world.
+     *
+     * @return Unique ID of this world.
+     */
+    public UUID getUID() {
+        return worldUid;
+    }
+
     /**
      * Gets the Bukkit world object that this world describes.
      *