Search in sources :

Example 1 with SpongeCommandSyntaxException

use of org.spongepowered.common.command.exception.SpongeCommandSyntaxException in project SpongeCommon by SpongePowered.

the class SpongeCommandManager method prettyPrintThrowableError.

private void prettyPrintThrowableError(final Throwable thr, final String commandNoArgs, final String args, final CommandCause cause) {
    final String commandString;
    if (args != null && !args.isEmpty()) {
        commandString = commandNoArgs + " " + args;
    } else {
        commandString = commandNoArgs;
    }
    final SpongeCommandMapping mapping = this.commandMappings.get(commandNoArgs.toLowerCase());
    final PrettyPrinter prettyPrinter = new PrettyPrinter(100).add("Unexpected error occurred while executing command '%s'", commandString).centre().hr().addWrapped("While trying to run '%s', an error occurred that the command processor was not expecting. " + "This usually indicates an error in the plugin that owns this command. Report this error " + "to the plugin developer first - this is usually not a Sponge error.", commandString).hr().add().add("Command: %s", commandString).add("Owning Plugin: %s", mapping.plugin().map(x -> x.metadata().id()).orElse("unknown")).add("Owning Registrar: %s", mapping.registrar().getClass().getName()).add().add("Exception Details: ");
    if (thr instanceof SpongeCommandSyntaxException) {
        // we know the inner exception was wrapped by us.
        prettyPrinter.add(thr.getCause());
    } else {
        prettyPrinter.add(thr);
    }
    prettyPrinter.add().add("CommandCause details: ").addWrapped(cause.cause().toString()).log(SpongeCommon.logger(), Level.ERROR);
}
Also used : LiteralCommandNode(com.mojang.brigadier.tree.LiteralCommandNode) Object2BooleanMap(it.unimi.dsi.fastutil.objects.Object2BooleanMap) SpongeCommandDispatcher(org.spongepowered.common.command.brigadier.dispatcher.SpongeCommandDispatcher) Arrays(java.util.Arrays) Game(org.spongepowered.api.Game) Inject(com.google.inject.Inject) Level(org.apache.logging.log4j.Level) CommandFailedRegistrationException(org.spongepowered.api.command.manager.CommandFailedRegistrationException) SpongeAdventure(org.spongepowered.common.adventure.SpongeAdventure) CommandPhaseContext(org.spongepowered.common.event.tracking.phase.general.CommandPhaseContext) MinecraftServer(net.minecraft.server.MinecraftServer) HashMultimap(com.google.common.collect.HashMultimap) Locale(java.util.Locale) Map(java.util.Map) RootCommandTreeNode(org.spongepowered.common.command.registrar.tree.builder.RootCommandTreeNode) TransactionalCaptureSupplier(org.spongepowered.common.event.tracking.context.transaction.TransactionalCaptureSupplier) Subject(org.spongepowered.api.service.permission.Subject) Object2BooleanOpenHashMap(it.unimi.dsi.fastutil.objects.Object2BooleanOpenHashMap) PrintWriter(java.io.PrintWriter) SpongeCommandCompletion(org.spongepowered.common.command.SpongeCommandCompletion) ImmutableSet(com.google.common.collect.ImmutableSet) CommandCompletion(org.spongepowered.api.command.CommandCompletion) Collection(java.util.Collection) Launch(org.spongepowered.common.launch.Launch) ConcurrentHashMap(java.util.concurrent.ConcurrentHashMap) Sponge(org.spongepowered.api.Sponge) Set(java.util.Set) SpongeCommandResult(org.spongepowered.common.command.result.SpongeCommandResult) TypeToken(io.leangen.geantyref.TypeToken) Collectors(java.util.stream.Collectors) LiteralArgumentBuilder(com.mojang.brigadier.builder.LiteralArgumentBuilder) NamedTextColor(net.kyori.adventure.text.format.NamedTextColor) SpongeParameterizedCommandRegistrar(org.spongepowered.common.command.registrar.SpongeParameterizedCommandRegistrar) Player(net.minecraft.world.entity.player.Player) Objects(java.util.Objects) ExecuteCommandEvent(org.spongepowered.api.event.command.ExecuteCommandEvent) List(java.util.List) PhaseContext(org.spongepowered.common.event.tracking.PhaseContext) Optional(java.util.Optional) HoverEvent(net.kyori.adventure.text.event.HoverEvent) CommandManager(org.spongepowered.api.command.manager.CommandManager) SpongePaginationService(org.spongepowered.common.service.game.pagination.SpongePaginationService) CommandRegistrar(org.spongepowered.api.command.registrar.CommandRegistrar) NonNull(org.checkerframework.checker.nullness.qual.NonNull) EventContextKeys(org.spongepowered.api.event.EventContextKeys) ComponentMessageThrowable(net.kyori.adventure.util.ComponentMessageThrowable) SharedSuggestionProvider(net.minecraft.commands.SharedSuggestionProvider) CommandSourceStack(net.minecraft.commands.CommandSourceStack) Constants(org.spongepowered.common.util.Constants) Command(com.mojang.brigadier.Command) CommandsBridge(org.spongepowered.common.bridge.commands.CommandsBridge) PrettyPrinter(org.spongepowered.common.util.PrettyPrinter) HashMap(java.util.HashMap) BrigadierCommandRegistrar(org.spongepowered.common.command.registrar.BrigadierCommandRegistrar) Multimap(com.google.common.collect.Multimap) ArrayList(java.util.ArrayList) HashSet(java.util.HashSet) LinkedHashMap(java.util.LinkedHashMap) SpongeCommand(org.spongepowered.common.command.sponge.SpongeCommand) Component(net.kyori.adventure.text.Component) CallbackCommand(org.spongepowered.common.adventure.CallbackCommand) CauseStackManager(org.spongepowered.api.event.CauseStackManager) Nullable(org.checkerframework.checker.nullness.qual.Nullable) GeneralPhase(org.spongepowered.common.event.tracking.phase.general.GeneralPhase) CommandResult(org.spongepowered.api.command.CommandResult) SpongeCommandSyntaxException(org.spongepowered.common.command.exception.SpongeCommandSyntaxException) RegisterCommandEventImpl(org.spongepowered.common.event.lifecycle.RegisterCommandEventImpl) Parameterized(org.spongepowered.api.command.Command.Parameterized) Identity(net.kyori.adventure.identity.Identity) CommandTreeNode(org.spongepowered.api.command.registrar.tree.CommandTreeNode) SpongeEventFactory(org.spongepowered.api.event.SpongeEventFactory) StringWriter(java.io.StringWriter) CommandRegistrarType(org.spongepowered.api.command.registrar.CommandRegistrarType) SpongeCommon(org.spongepowered.common.SpongeCommon) PhaseTracker(org.spongepowered.common.event.tracking.PhaseTracker) PaginationService(org.spongepowered.api.service.pagination.PaginationService) RegistryTypes(org.spongepowered.api.registry.RegistryTypes) Cause(org.spongepowered.api.event.Cause) CommandCause(org.spongepowered.api.command.CommandCause) CommandMapping(org.spongepowered.api.command.manager.CommandMapping) Provider(com.google.inject.Provider) PluginContainer(org.spongepowered.plugin.PluginContainer) Audience(net.kyori.adventure.audience.Audience) SpongeConfigs(org.spongepowered.common.applaunch.config.core.SpongeConfigs) CommandNode(com.mojang.brigadier.tree.CommandNode) GenericTypeReflector(io.leangen.geantyref.GenericTypeReflector) CommandSyntaxException(com.mojang.brigadier.exceptions.CommandSyntaxException) Collections(java.util.Collections) CommandException(org.spongepowered.api.command.exception.CommandException) ServerPlayer(org.spongepowered.api.entity.living.player.server.ServerPlayer) PrettyPrinter(org.spongepowered.common.util.PrettyPrinter) SpongeCommandSyntaxException(org.spongepowered.common.command.exception.SpongeCommandSyntaxException)

Example 2 with SpongeCommandSyntaxException

use of org.spongepowered.common.command.exception.SpongeCommandSyntaxException in project SpongeCommon by SpongePowered.

the class SpongeCommandDispatcher method parseNodes.

private ParseResults<CommandSourceStack> parseNodes(// Sponge: used in permission checks
final boolean isRoot, // Sponge: needed for handling what we do with defaults.
final boolean isSuggestion, final CommandNode<CommandSourceStack> node, final SpongeStringReader originalReader, final SpongeCommandContextBuilder contextSoFar) {
    final CommandSourceStack source = contextSoFar.getSource();
    // Sponge Start
    Map<CommandNode<CommandSourceStack>, CommandSyntaxException> errors = null;
    List<ParseResults<CommandSourceStack>> potentials = null;
    // Sponge End
    final int cursor = originalReader.getCursor();
    // Sponge Start: get relevant nodes if we're completing
    final Collection<? extends CommandNode<CommandSourceStack>> nodes;
    if (isSuggestion && node instanceof SpongeNode) {
        nodes = ((SpongeNode) node).getRelevantNodesForSuggestions(originalReader);
    } else if (originalReader.canRead()) {
        nodes = node.getRelevantNodes(originalReader);
    } else {
        // Reader cannot read anymore so ONLY nodes with parsers that do not read can be processed
        nodes = node.getChildren().stream().filter(n -> n instanceof SpongeArgumentCommandNode && (((SpongeArgumentCommandNode<?>) n).getParser().doesNotRead())).collect(Collectors.toList());
    }
    for (final CommandNode<CommandSourceStack> child : nodes) {
        final boolean doesNotRead = child instanceof SpongeArgumentCommandNode && ((SpongeArgumentCommandNode<?>) child).getParser().doesNotRead();
        // if (!child.canUse(source)) {
        if (!SpongeNodePermissionCache.canUse(isRoot, this, child, source)) {
            // Sponge End
            continue;
        }
        // Sponge Start
        final SpongeCommandContextBuilder context = contextSoFar.copy();
        final SpongeStringReader reader = new SpongeStringReader(originalReader);
        // Sponge End
        try {
            try {
                child.parse(reader, context);
            } catch (final RuntimeException ex) {
                throw CommandSyntaxException.BUILT_IN_EXCEPTIONS.dispatcherParseException().createWithContext(reader, ex.getMessage());
            }
            // Sponge Start: if we didn't consume anything we don't want Brig to complain at us.
            if (reader.getCursor() == cursor) {
                // of suggestions.
                if (isSuggestion && !reader.canRead()) {
                    throw CommandSyntaxException.BUILT_IN_EXCEPTIONS.dispatcherExpectedArgumentSeparator().createWithContext(reader);
                }
                reader.unskipWhitespace();
            } else if (reader.canRead()) {
                // Sponge End
                if (reader.peek() != CommandDispatcher.ARGUMENT_SEPARATOR_CHAR) {
                    throw CommandSyntaxException.BUILT_IN_EXCEPTIONS.dispatcherExpectedArgumentSeparator().createWithContext(reader);
                }
            }
        } catch (final CommandSyntaxException ex) {
            if (errors == null) {
                errors = new LinkedHashMap<>();
            }
            errors.put(child, ex);
            reader.setCursor(cursor);
            continue;
        }
        context.withCommand(child.getCommand());
        // must let it do so.
        if (this.shouldContinueTraversing(reader, child)) {
            // if (reader.canRead(child.getRedirect() == null ? 2 : 1)) {
            // Sponge End
            reader.skip();
            // Sponge Start: redirect is now in a local variable as we use it a fair bit
            final CommandNode<CommandSourceStack> redirect = child.getRedirect();
            if (redirect != null) {
                // If we've redirected to the root node, we may need to head back to our command
                // manager - so we should check to see if that's going to actually be the case.
                final boolean redirectingToRoot = redirect == this.getRoot();
                final SpongeCommandContextBuilder childContext = new SpongeCommandContextBuilder(this, source, child.getRedirect(), reader.getCursor());
                // For a redirect, we want to ensure all of our currently parsed information is available.
                context.applySpongeElementsTo(childContext, false);
                ParseResults<CommandSourceStack> parse = null;
                if (redirectingToRoot) {
                    // check to see if we can get an element
                    final ArgumentReader.Immutable snapshot = reader.immutable();
                    try {
                        final String commandToAttempt = reader.peekString();
                        final int offset = reader.cursor();
                        if (redirect.getChild(commandToAttempt) == null) {
                            // The redirect fails, so we intercept here, and reroute to our command
                            // manager with the rest of the string and the new context.
                            reader.parseString();
                            final boolean hasMore = reader.canRead();
                            reader.skipWhitespace();
                            final Optional<CommandMapping> optionalMapping = this.commandManager.commandMapping(commandToAttempt);
                            if (optionalMapping.isPresent()) {
                                final CommandMapping mapping = optionalMapping.get();
                                final String remaining = reader.remaining();
                                childContext.withCommand(commandContext -> {
                                    final SpongeCommandContext spongeContext = (SpongeCommandContext) commandContext;
                                    try {
                                        return mapping.registrar().process(spongeContext.cause(), mapping, commandToAttempt, remaining).result();
                                    } catch (final CommandException e) {
                                        throw new SpongeCommandSyntaxException(e, spongeContext);
                                    }
                                });
                                childContext.withNode(new DummyCommandNode(childContext.getCommand()), StringRange.between(offset, reader.totalLength()));
                                childContext.setNonBrigCommand(hasMore ? new String[] { commandToAttempt, remaining } : new String[] { commandToAttempt });
                                reader.setCursor(reader.totalLength());
                                parse = new ParseResults<>(childContext, reader, Collections.emptyMap());
                            } else {
                                // We'll just let this parser fail as normal.
                                reader.setState(snapshot);
                            }
                        }
                    } catch (final ArgumentParseException ignored) {
                        // ignore it, it'll handle it later.
                        reader.setState(snapshot);
                    }
                }
                if (parse == null) {
                    parse = this.parseNodes(redirect instanceof RootCommandNode, isSuggestion, child.getRedirect(), reader, childContext);
                }
                // It worked out, so let's apply it back. We clear and reapply, it's simpler than comparing and conditional adding.
                childContext.applySpongeElementsTo(context, true);
                // Sponge End
                context.withChild(parse.getContext());
                final ParseResults<CommandSourceStack> parse2 = new ParseResults<>(context, parse.getReader(), parse.getExceptions());
                if (doesNotRead && potentials != null) {
                    // If this is a optional or default parameter we only add the redirect as a potential option
                    potentials.add(parse2);
                    continue;
                }
                return parse2;
            } else {
                final ParseResults<CommandSourceStack> parse = this.parseNodes(false, isSuggestion, child, reader, context);
                if (potentials == null) {
                    potentials = new ArrayList<>(1);
                }
                potentials.add(parse);
            }
        } else {
            if (potentials == null) {
                potentials = new ArrayList<>(1);
            }
            potentials.add(new ParseResults<>(context, reader, Collections.emptyMap()));
        }
    }
    if (potentials != null) {
        if (potentials.size() > 1) {
            potentials.sort((a, b) -> {
                if (!a.getReader().canRead() && b.getReader().canRead()) {
                    return -1;
                }
                if (a.getReader().canRead() && !b.getReader().canRead()) {
                    return 1;
                }
                if (a.getExceptions().isEmpty() && !b.getExceptions().isEmpty()) {
                    return -1;
                }
                if (!a.getExceptions().isEmpty() && b.getExceptions().isEmpty()) {
                    return 1;
                }
                // If we get here both potentials parsed everything and there was no exception
                // BUT if parsing stopped at a non-terminal node this will cause an error later
                // see at the end of #execute() where !foundCommand
                // Instead we attempt to sort commands before that happens
                final Command<CommandSourceStack> aCommand = SpongeCommandDispatcher.getCommand(a.getContext());
                final Command<CommandSourceStack> bCommand = SpongeCommandDispatcher.getCommand(b.getContext());
                if (aCommand == null && bCommand != null) {
                    return 1;
                } else if (aCommand != null && bCommand == null) {
                    return -1;
                }
                return 0;
            });
        }
        return potentials.get(0);
    }
    return new ParseResults<>(contextSoFar, originalReader, errors == null ? Collections.emptyMap() : errors);
}
Also used : LiteralCommandNode(com.mojang.brigadier.tree.LiteralCommandNode) CommandDispatcher(com.mojang.brigadier.CommandDispatcher) EventContextKeys(org.spongepowered.api.event.EventContextKeys) CommandSourceStack(net.minecraft.commands.CommandSourceStack) Command(com.mojang.brigadier.Command) CommandContextBuilder(com.mojang.brigadier.context.CommandContextBuilder) CompletableFuture(java.util.concurrent.CompletableFuture) SpongeAdventure(org.spongepowered.common.adventure.SpongeAdventure) RedirectModifier(com.mojang.brigadier.RedirectModifier) SuggestionContext(com.mojang.brigadier.context.SuggestionContext) SpongeCommandContextBuilder(org.spongepowered.common.command.brigadier.context.SpongeCommandContextBuilder) ArrayList(java.util.ArrayList) LinkedHashMap(java.util.LinkedHashMap) CommandSourceStackBridge(org.spongepowered.common.bridge.commands.CommandSourceStackBridge) Map(java.util.Map) DummyCommandNode(org.spongepowered.common.command.brigadier.tree.DummyCommandNode) StringReader(com.mojang.brigadier.StringReader) SpongeRootCommandNode(org.spongepowered.common.command.brigadier.tree.SpongeRootCommandNode) CauseStackManager(org.spongepowered.api.event.CauseStackManager) SuggestionsBuilder(com.mojang.brigadier.suggestion.SuggestionsBuilder) RootCommandNode(com.mojang.brigadier.tree.RootCommandNode) SpongeCommandSyntaxException(org.spongepowered.common.command.exception.SpongeCommandSyntaxException) Suggestions(com.mojang.brigadier.suggestion.Suggestions) CommandContext(com.mojang.brigadier.context.CommandContext) CommandUtil(org.spongepowered.common.util.CommandUtil) Collection(java.util.Collection) ArgumentReader(org.spongepowered.api.command.parameter.ArgumentReader) PhaseTracker(org.spongepowered.common.event.tracking.PhaseTracker) Collectors(java.util.stream.Collectors) CommandMapping(org.spongepowered.api.command.manager.CommandMapping) AmbiguityConsumer(com.mojang.brigadier.AmbiguityConsumer) List(java.util.List) SpongeStringReader(org.spongepowered.common.command.brigadier.SpongeStringReader) ArgumentParseException(org.spongepowered.api.command.exception.ArgumentParseException) SpongeCommandContext(org.spongepowered.common.command.brigadier.context.SpongeCommandContext) ParseResults(com.mojang.brigadier.ParseResults) SpongeArgumentCommandNode(org.spongepowered.common.command.brigadier.tree.SpongeArgumentCommandNode) CommandNode(com.mojang.brigadier.tree.CommandNode) Optional(java.util.Optional) ResultConsumer(com.mojang.brigadier.ResultConsumer) CommandSyntaxException(com.mojang.brigadier.exceptions.CommandSyntaxException) CommandManager(org.spongepowered.api.command.manager.CommandManager) SpongeNode(org.spongepowered.common.command.brigadier.tree.SpongeNode) Collections(java.util.Collections) StringRange(com.mojang.brigadier.context.StringRange) CommandException(org.spongepowered.api.command.exception.CommandException) SpongeCommandManager(org.spongepowered.common.command.manager.SpongeCommandManager) DummyCommandNode(org.spongepowered.common.command.brigadier.tree.DummyCommandNode) LiteralCommandNode(com.mojang.brigadier.tree.LiteralCommandNode) DummyCommandNode(org.spongepowered.common.command.brigadier.tree.DummyCommandNode) SpongeRootCommandNode(org.spongepowered.common.command.brigadier.tree.SpongeRootCommandNode) RootCommandNode(com.mojang.brigadier.tree.RootCommandNode) SpongeArgumentCommandNode(org.spongepowered.common.command.brigadier.tree.SpongeArgumentCommandNode) CommandNode(com.mojang.brigadier.tree.CommandNode) SpongeRootCommandNode(org.spongepowered.common.command.brigadier.tree.SpongeRootCommandNode) RootCommandNode(com.mojang.brigadier.tree.RootCommandNode) ArgumentParseException(org.spongepowered.api.command.exception.ArgumentParseException) CommandSourceStack(net.minecraft.commands.CommandSourceStack) SpongeCommandContextBuilder(org.spongepowered.common.command.brigadier.context.SpongeCommandContextBuilder) LinkedHashMap(java.util.LinkedHashMap) SpongeStringReader(org.spongepowered.common.command.brigadier.SpongeStringReader) CommandMapping(org.spongepowered.api.command.manager.CommandMapping) SpongeNode(org.spongepowered.common.command.brigadier.tree.SpongeNode) SpongeCommandSyntaxException(org.spongepowered.common.command.exception.SpongeCommandSyntaxException) CommandSyntaxException(com.mojang.brigadier.exceptions.CommandSyntaxException) SpongeArgumentCommandNode(org.spongepowered.common.command.brigadier.tree.SpongeArgumentCommandNode) ArgumentReader(org.spongepowered.api.command.parameter.ArgumentReader) CommandException(org.spongepowered.api.command.exception.CommandException) SpongeCommandSyntaxException(org.spongepowered.common.command.exception.SpongeCommandSyntaxException) ParseResults(com.mojang.brigadier.ParseResults) SpongeCommandContext(org.spongepowered.common.command.brigadier.context.SpongeCommandContext)

Aggregations

Command (com.mojang.brigadier.Command)2 CommandSyntaxException (com.mojang.brigadier.exceptions.CommandSyntaxException)2 CommandNode (com.mojang.brigadier.tree.CommandNode)2 LiteralCommandNode (com.mojang.brigadier.tree.LiteralCommandNode)2 ArrayList (java.util.ArrayList)2 Collection (java.util.Collection)2 Collections (java.util.Collections)2 LinkedHashMap (java.util.LinkedHashMap)2 List (java.util.List)2 Map (java.util.Map)2 Optional (java.util.Optional)2 Collectors (java.util.stream.Collectors)2 CommandSourceStack (net.minecraft.commands.CommandSourceStack)2 CommandException (org.spongepowered.api.command.exception.CommandException)2 CommandManager (org.spongepowered.api.command.manager.CommandManager)2 CommandMapping (org.spongepowered.api.command.manager.CommandMapping)2 CauseStackManager (org.spongepowered.api.event.CauseStackManager)2 EventContextKeys (org.spongepowered.api.event.EventContextKeys)2 SpongeAdventure (org.spongepowered.common.adventure.SpongeAdventure)2 SpongeCommandSyntaxException (org.spongepowered.common.command.exception.SpongeCommandSyntaxException)2