Add command suggestions for schematic filenames

Author: seijikun

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

@@ -111,13 +111,15 @@ public SchematicCommands(WorldEdit worldEdit) {
     @CommandPermissions({"worldedit.clipboard.load", "worldedit.schematic.load"})
     public void load(Actor actor, LocalSession session,
                      @Arg(desc = "File name.")
-                         String filename,
+                         Schematic schematic,
                      @Arg(desc = "Format name.", def = "sponge")
                          ClipboardFormat format) throws FilenameException {
         LocalConfiguration config = worldEdit.getConfiguration();
 
-        File dir = worldEdit.getWorkingDirectoryPath(config.saveDir).toFile();
-        File f = worldEdit.getSafeOpenFile(actor, dir, filename,
+        // Schematic.path is relative, so treat it as filename
+        String filename = schematic.getPath().toString();
+        File schematicsRoot = worldEdit.getSchematicsManager().getRoot().toFile();
+        File f = worldEdit.getSafeOpenFile(actor, schematicsRoot, filename,
                 BuiltInClipboardFormat.SPONGE_V3_SCHEMATIC.getPrimaryFileExtension(),
                 ClipboardFormats.getFileExtensionArray());
 
@@ -249,10 +251,12 @@ public void share(Actor actor, LocalSession session,
     @CommandPermissions("worldedit.schematic.delete")
     public void delete(Actor actor,
                        @Arg(desc = "File name.")
-                           String filename) throws WorldEditException {
+                           Schematic schematic) throws WorldEditException {
         LocalConfiguration config = worldEdit.getConfiguration();
         File dir = worldEdit.getWorkingDirectoryPath(config.saveDir).toFile();
 
+        // Schematic.path is relative, so treat it as filename
+        String filename = schematic.getPath().toString();
         File f = worldEdit.getSafeOpenFile(actor,
                 dir, filename, "schematic", ClipboardFormats.getFileExtensionArray());
 

worldedit-core/src/main/java/com/sk89q/worldedit/command/argument/SchematicConverter.java

@@ -0,0 +1,89 @@
+/*
+ * WorldEdit, a Minecraft world manipulation toolkit
+ * Copyright (C) sk89q <http://www.sk89q.com>
+ * Copyright (C) WorldEdit team and contributors
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.sk89q.worldedit.command.argument;
+
+import com.sk89q.worldedit.WorldEdit;
+import com.sk89q.worldedit.internal.util.LogManagerCompat;
+import com.sk89q.worldedit.util.formatting.text.Component;
+import com.sk89q.worldedit.util.formatting.text.TextComponent;
+import com.sk89q.worldedit.util.io.file.FilenameException;
+import com.sk89q.worldedit.util.schematic.Schematic;
+import com.sk89q.worldedit.util.schematic.SchematicsManager;
+import org.enginehub.piston.CommandManager;
+import org.enginehub.piston.converter.ArgumentConverter;
+import org.enginehub.piston.converter.ConversionResult;
+import org.enginehub.piston.converter.FailedConversion;
+import org.enginehub.piston.converter.SuccessfulConversion;
+import org.enginehub.piston.inject.InjectedValueAccess;
+import org.enginehub.piston.inject.Key;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.List;
+
+import static org.enginehub.piston.converter.SuggestionHelper.limitByPrefix;
+
+public class SchematicConverter implements ArgumentConverter<Schematic> {
+
+    public static void register(WorldEdit worldEdit, CommandManager commandManager) {
+        commandManager.registerConverter(Key.of(Schematic.class), new SchematicConverter(worldEdit));
+    }
+
+    private final WorldEdit worldEdit;
+
+    private SchematicConverter(WorldEdit worldEdit) {
+        this.worldEdit = worldEdit;
+    }
+
+    private final TextComponent choices = TextComponent.of("schematic filename");
+
+    @Override
+    public Component describeAcceptableArguments() {
+        return choices;
+    }
+
+    @Override
+    public List<String> getSuggestions(String input, InjectedValueAccess context) {
+        SchematicsManager schematicsManager = worldEdit.getSchematicsManager();
+        Path schematicsRootPath = schematicsManager.getRoot();
+
+        return limitByPrefix(schematicsManager.getList().stream()
+                .map(s -> schematicsRootPath.relativize(s.getPath()).toString()), input);
+    }
+
+    @Override
+    public ConversionResult<Schematic> convert(String s, InjectedValueAccess injectedValueAccess) {
+        Path schematicsRoot = worldEdit.getSchematicsManager().getRoot();
+        // resolve as subpath of schematicsRoot
+        Path schematicPath = schematicsRoot.resolve(s).toAbsolutePath();
+        // then check whether it is still a subpath to rule out "../"
+        if (!schematicPath.startsWith(schematicsRoot)) {
+            return FailedConversion.from(new FilenameException(s));
+        }
+        // check whether the file exists
+        if (Files.exists(schematicPath)) {
+            // continue as relative path to schematicsRoot
+            schematicPath = schematicsRoot.relativize(schematicPath);
+            return SuccessfulConversion.fromSingle(new Schematic(schematicPath));
+        } else {
+            return FailedConversion.from(new FilenameException(s));
+        }
+    }
+}

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

@@ -82,6 +82,7 @@
 import com.sk89q.worldedit.command.argument.OffsetConverter;
 import com.sk89q.worldedit.command.argument.RegionFactoryConverter;
 import com.sk89q.worldedit.command.argument.RegistryConverter;
+import com.sk89q.worldedit.command.argument.SchematicConverter;
 import com.sk89q.worldedit.command.argument.SelectorChoiceConverter;
 import com.sk89q.worldedit.command.argument.SideEffectConverter;
 import com.sk89q.worldedit.command.argument.SideEffectSetConverter;
@@ -232,6 +233,7 @@ private void registerArgumentConverters() {
         ClipboardFormatConverter.register(commandManager);
         ClipboardShareDestinationConverter.register(commandManager);
         SelectorChoiceConverter.register(commandManager);
+        SchematicConverter.register(worldEdit, commandManager);
     }
 
     private void registerAlwaysInjectedValues() {