Skip to content

Fix default failure handling so unauthorized subcommands are not exposed in "Did you mean" suggestions #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RareMan666 wants to merge 1 commit into
base: v4
Choose a base branch
from
Open

Fix default failure handling so unauthorized subcommands are not exposed in "Did you mean" suggestions #156

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 68 additions & 13 deletions common/src/main/java/revxrsal/commands/node/DefaultFailureHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,17 @@
import org.jetbrains.annotations.Unmodifiable;
import revxrsal.commands.Lamp;
import revxrsal.commands.command.CommandActor;
import revxrsal.commands.command.ExecutableCommand;
import revxrsal.commands.command.Potential;
import revxrsal.commands.exception.ExpectedLiteralException;
import revxrsal.commands.exception.NoPermissionException;
import revxrsal.commands.exception.UnknownCommandException;
import revxrsal.commands.exception.context.ErrorContext;
import revxrsal.commands.node.ExecutionContext;
import revxrsal.commands.stream.StringStream;

import java.util.ArrayList;
import java.util.List;

import static revxrsal.commands.util.Collections.any;
import static revxrsal.commands.util.Collections.filter;

/**
Expand All @@ -37,22 +40,74 @@ public void handleFailedAttempts(@NotNull A actor, @NotNull @Unmodifiable List<P
if (failedAttempts.isEmpty()) {
return;
}

List<Potential<A>> visibleAttempts = filter(failedAttempts, attempt -> attempt.context().command().isVisibleTo(actor));
for (Potential<A> potential : failedAttempts) {
if (!potential.context().command().permission().isExecutableBy(actor)
&& !(potential.error() instanceof ExpectedLiteralException)) {
handleNoPermission(potential.context());
return;
}
}

if (visibleAttempts.size() > 1) {
List<String> suggestions = new ArrayList<>(visibleAttempts.size());
for (Potential<A> attempt : visibleAttempts) {
suggestions.add(attempt.context().command().path());
}
showSuggestions(actor, input, suggestions);
return;
}

if (visibleAttempts.size() == 1) {
Potential<A> visibleAttempt = visibleAttempts.get(0);
List<ExecutableCommand<A>> related = visibleAttempt.context().command().relatedCommands(actor).all();
if (!related.isEmpty()) {
List<String> suggestions = new ArrayList<>(related.size() + 1);
suggestions.add(visibleAttempt.context().command().path());
for (ExecutableCommand<A> command : related) {
suggestions.add(command.path());
}
showSuggestions(actor, input, suggestions);
return;
}
visibleAttempt.handleException();
return;
}

for (Potential<A> potential : failedAttempts) {
if (!potential.context().command().permission().isExecutableBy(actor)) {
handleNoPermission(potential.context());
return;
}
}

if (failedAttempts.size() == 1) {
failedAttempts.get(0).handleException();
return;
}

List<Potential<A>> realExceptions = filter(failedAttempts, v -> !(v.error() instanceof ExpectedLiteralException));
if (realExceptions.isEmpty()) {
actor.error("Failed to find a suitable command for your input (\"" + input.source() + "\"). Did you mean:");
for (int i = 0; i < failedAttempts.size(); i++) {
if (i >= MAX_NUMBER_OF_SUGGESTIONS)
break;
Potential<A> failedAttempt = failedAttempts.get(i);
actor.reply("- " + failedAttempt.context().command().path());
}
} else {
realExceptions.get(0).handleException();
lamp(failedAttempts).handleException(new UnknownCommandException(input.peekUnquotedString()), ErrorContext.unknownCommand(actor));
}

private void handleNoPermission(@NotNull ExecutionContext<A> context) {
try {
context.command().permission().throwMissingPermission(context);
} catch (Throwable throwable) {
context.lamp().handleException(throwable, ErrorContext.executingFunction(context));
}
}

private Lamp<A> lamp(@NotNull List<Potential<A>> failedAttempts) {
return failedAttempts.get(0).context().lamp();
}

private void showSuggestions(@NotNull A actor, @NotNull StringStream input, @NotNull List<String> commands) {
actor.error("Failed to find a suitable command for your input (\"" + input.source() + "\"). Did you mean:");
for (int i = 0; i < commands.size(); i++) {
if (i >= MAX_NUMBER_OF_SUGGESTIONS)
break;
actor.reply("- " + commands.get(i));
}
}
}