Merge pull request #520 from EngineHub/feature/tool-command

Add /tool back, deprecate global tool commands

worldedit-core/src/main/java/com/sk89q/worldedit/command/BrushCommands.java

@@ -82,6 +82,15 @@ public class BrushCommands {
         this.worldEdit = worldEdit;
     }
 
+    @Command(
+        name = "none",
+        aliases = "unbind",
+        desc = "Unbind a bound brush from your current item"
+    )
+    void none(Player player, LocalSession session) throws WorldEditException {
+        ToolCommands.setToolNone(player, session, "Brush");
+    }
+
     @Command(
         name = "sphere",
         aliases = { "s" },

worldedit-core/src/main/java/com/sk89q/worldedit/command/ToolCommands.java

@@ -19,6 +19,7 @@
 
 package com.sk89q.worldedit.command;
 
+import com.google.common.collect.Collections2;
 import com.sk89q.worldedit.LocalConfiguration;
 import com.sk89q.worldedit.LocalSession;
 import com.sk89q.worldedit.WorldEdit;
@@ -29,6 +30,7 @@ import com.sk89q.worldedit.command.tool.BlockReplacer;
 import com.sk89q.worldedit.command.tool.DistanceWand;
 import com.sk89q.worldedit.command.tool.FloatingTreeRemover;
 import com.sk89q.worldedit.command.tool.FloodFillTool;
+import com.sk89q.worldedit.command.tool.InvalidToolBindException;
 import com.sk89q.worldedit.command.tool.LongRangeBuildTool;
 import com.sk89q.worldedit.command.tool.NavigationWand;
 import com.sk89q.worldedit.command.tool.QueryTool;
@@ -38,16 +40,94 @@ import com.sk89q.worldedit.command.util.CommandPermissions;
 import com.sk89q.worldedit.command.util.CommandPermissionsConditionGenerator;
 import com.sk89q.worldedit.entity.Player;
 import com.sk89q.worldedit.function.pattern.Pattern;
+import com.sk89q.worldedit.internal.command.CommandRegistrationHandler;
+import com.sk89q.worldedit.internal.command.CommandUtil;
 import com.sk89q.worldedit.util.HandSide;
 import com.sk89q.worldedit.util.TreeGenerator;
+import com.sk89q.worldedit.util.formatting.text.TextComponent;
+import com.sk89q.worldedit.util.formatting.text.TranslatableComponent;
 import com.sk89q.worldedit.world.block.BlockStateHolder;
 import com.sk89q.worldedit.world.item.ItemType;
+import org.enginehub.piston.CommandManager;
+import org.enginehub.piston.CommandManagerService;
+import org.enginehub.piston.CommandMetadata;
+import org.enginehub.piston.CommandParameters;
 import org.enginehub.piston.annotation.Command;
 import org.enginehub.piston.annotation.CommandContainer;
 import org.enginehub.piston.annotation.param.Arg;
+import org.enginehub.piston.part.SubCommandPart;
+
+import java.util.Optional;
+import java.util.Set;
+import java.util.stream.Collectors;
 
 @CommandContainer(superTypes = CommandPermissionsConditionGenerator.Registration.class)
 public class ToolCommands {
+
+    public static void register(CommandRegistrationHandler registration,
+                                CommandManager commandManager,
+                                CommandManagerService commandManagerService,
+                                WorldEdit worldEdit) {
+        // Collect the tool commands
+        CommandManager collect = commandManagerService.newCommandManager();
+
+        registration.register(
+            collect,
+            ToolCommandsRegistration.builder(),
+            new ToolCommands(worldEdit)
+        );
+
+        // Register deprecated global commands
+        Set<org.enginehub.piston.Command> commands = collect.getAllCommands()
+            .collect(Collectors.toSet());
+        for (org.enginehub.piston.Command command : commands) {
+            if (command.getAliases().contains("unbind")) {
+                // Don't register new /tool unbind alias
+                command = command.toBuilder().aliases(
+                    Collections2.filter(command.getAliases(), alias -> !"unbind".equals(alias))
+                ).build();
+            }
+            commandManager.register(CommandUtil.deprecate(
+                command, "Using global tool names is deprecated " +
+                "and will be removed in WorldEdit 8", ToolCommands::asNonGlobal
+            ));
+        }
+
+        // Remove aliases with / in them, since it doesn't make sense for sub-commands.
+        Set<org.enginehub.piston.Command> nonGlobalCommands = commands.stream()
+            .map(command ->
+                command.toBuilder().aliases(
+                    Collections2.filter(command.getAliases(), alias -> !alias.startsWith("/"))
+                ).build()
+            )
+            .collect(Collectors.toSet());
+        commandManager.register("tool", command -> {
+            command.addPart(SubCommandPart.builder(
+                TranslatableComponent.of("tool"),
+                TextComponent.of("The tool to bind")
+            )
+                .withCommands(nonGlobalCommands)
+                .required()
+                .build());
+            command.description(TextComponent.of("Binds a tool to the item in your hand"));
+        });
+    }
+
+    private static String asNonGlobal(org.enginehub.piston.Command oldCommand,
+                                      CommandParameters oldParameters) {
+        String name = Optional.ofNullable(oldParameters.getMetadata())
+            .map(CommandMetadata::getCalledName)
+            .filter(n -> !n.startsWith("/"))
+            .orElseGet(oldCommand::getName);
+        return "/tool " + name;
+    }
+
+    static void setToolNone(Player player, LocalSession session, String type)
+        throws InvalidToolBindException {
+        session.setTool(player.getItemInHand(HandSide.MAIN_HAND).getType(), null);
+        player.print(type + " unbound from your current item.");
+    }
+
     private final WorldEdit we;
 
     public ToolCommands(WorldEdit we) {
@@ -56,17 +136,16 @@ public class ToolCommands {
 
     @Command(
         name = "none",
+        aliases = "unbind",
         desc = "Unbind a bound tool from your current item"
     )
     public void none(Player player, LocalSession session) throws WorldEditException {
-
+        setToolNone(player, session, "Tool");
-        session.setTool(player.getItemInHand(HandSide.MAIN_HAND).getType(), null);
-        player.print("Tool unbound from your current item.");
     }
 
     @Command(
-        name = "/selwand",
+        name = "selwand",
-        aliases = "selwand",
+        aliases = "/selwand",
         desc = "Selection wand tool"
     )
     @CommandPermissions("worldedit.setwand")
@@ -78,8 +157,8 @@ public class ToolCommands {
     }
 
     @Command(
-        name = "/navwand",
+        name = "navwand",
-        aliases = "navwand",
+        aliases = "/navwand",
         desc = "Navigation wand tool"
     )
     @CommandPermissions("worldedit.setwand")

worldedit-core/src/main/java/com/sk89q/worldedit/extension/platform/PlatformCommandManager.java

@@ -19,8 +19,6 @@
 
 package com.sk89q.worldedit.extension.platform;
 
-import static com.google.common.base.Preconditions.checkNotNull;
-
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.reflect.TypeToken;
@@ -64,7 +62,6 @@ import com.sk89q.worldedit.command.SnapshotUtilCommandsRegistration;
 import com.sk89q.worldedit.command.SuperPickaxeCommands;
 import com.sk89q.worldedit.command.SuperPickaxeCommandsRegistration;
 import com.sk89q.worldedit.command.ToolCommands;
-import com.sk89q.worldedit.command.ToolCommandsRegistration;
 import com.sk89q.worldedit.command.ToolUtilCommands;
 import com.sk89q.worldedit.command.ToolUtilCommandsRegistration;
 import com.sk89q.worldedit.command.UtilityCommands;
@@ -141,6 +138,8 @@ import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import static com.google.common.base.Preconditions.checkNotNull;
+
 /**
  * Handles the registration and invocation of commands.
  *
@@ -399,11 +398,7 @@ public final class PlatformCommandManager {
             SnapshotUtilCommandsRegistration.builder(),
             new SnapshotUtilCommands(worldEdit)
         );
-        this.registration.register(
+        ToolCommands.register(registration, commandManager, commandManagerService, worldEdit);
-            commandManager,
-            ToolCommandsRegistration.builder(),
-            new ToolCommands(worldEdit)
-        );
         this.registration.register(
             commandManager,
             ToolUtilCommandsRegistration.builder(),

worldedit-core/src/main/java/com/sk89q/worldedit/internal/command/CommandUtil.java

@@ -21,11 +21,17 @@ package com.sk89q.worldedit.internal.command;
 
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.Iterables;
+import com.sk89q.worldedit.extension.platform.Actor;
 import com.sk89q.worldedit.extension.platform.PlatformCommandManager;
 import com.sk89q.worldedit.internal.util.Substring;
 import com.sk89q.worldedit.util.formatting.text.Component;
 import com.sk89q.worldedit.util.formatting.text.TextComponent;
+import com.sk89q.worldedit.util.formatting.text.event.ClickEvent;
+import com.sk89q.worldedit.util.formatting.text.format.TextColor;
+import com.sk89q.worldedit.util.formatting.text.format.TextDecoration;
 import org.enginehub.piston.Command;
+import org.enginehub.piston.CommandParameters;
+import org.enginehub.piston.NoInputCommandParameters;
 import org.enginehub.piston.exception.CommandException;
 import org.enginehub.piston.inject.InjectedValueAccess;
 import org.enginehub.piston.inject.Key;
@@ -43,6 +49,63 @@ import static java.util.stream.Collectors.toList;
 
 public class CommandUtil {
 
+    private static Component makeDeprecatedFooter(Component newCommand) {
+        return TextComponent.builder("This command is deprecated. Use ", TextColor.GOLD)
+            .decoration(TextDecoration.ITALIC, true)
+            .append(newCommand)
+            .append(" instead.")
+            .build();
+    }
+
+    public interface NewCommandGenerator {
+
+        String newCommand(Command oldCommand, CommandParameters oldParameters);
+
+    }
+
+    public static Command deprecate(Command command, String reason,
+                                    NewCommandGenerator newCommandGenerator) {
+        Component deprecatedWarning = makeDeprecatedFooter(
+            newCommandSuggestion(newCommandGenerator,
+                NoInputCommandParameters.builder().build(),
+                command)
+        );
+        return command.toBuilder()
+            .action(parameters ->
+                deprecatedCommandWarning(parameters, command, reason, newCommandGenerator))
+            .footer(command.getFooter()
+                .map(existingFooter -> existingFooter
+                    .append(TextComponent.newline()).append(deprecatedWarning))
+                .orElse(deprecatedWarning))
+            .build();
+    }
+
+    private static int deprecatedCommandWarning(
+        CommandParameters parameters,
+        Command command,
+        String reason,
+        NewCommandGenerator generator
+    ) throws Exception {
+        parameters.injectedValue(Key.of(Actor.class))
+            .ifPresent(actor -> {
+                Component suggestion = newCommandSuggestion(generator, parameters, command);
+                actor.print(TextComponent.of(reason + ". Please use ", TextColor.GOLD)
+                    .append(suggestion)
+                    .append(TextComponent.of(" instead."))
+                );
+            });
+        return command.getAction().run(parameters);
+    }
+
+    private static Component newCommandSuggestion(NewCommandGenerator generator,
+                                                  CommandParameters parameters,
+                                                  Command command) {
+        String suggestedCommand = generator.newCommand(command, parameters);
+        return TextComponent.of(suggestedCommand)
+            .decoration(TextDecoration.UNDERLINED, true)
+            .clickEvent(ClickEvent.suggestCommand(suggestedCommand));
+    }
+
     public static Map<String, Command> getSubCommands(Command currentCommand) {
         return currentCommand.getParts().stream()
             .filter(p -> p instanceof SubCommandPart)