cloud.commandframework.bukkit.parsers.OfflinePlayerArgument Maven / Gradle / Ivy
Show all versions of cloud-bukkit Show documentation
//
// MIT License
//
// Copyright (c) 2021 Alexander Söderberg & Contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
package cloud.commandframework.bukkit.parsers;
import cloud.commandframework.ArgumentDescription;
import cloud.commandframework.arguments.CommandArgument;
import cloud.commandframework.arguments.parser.ArgumentParseResult;
import cloud.commandframework.arguments.parser.ArgumentParser;
import cloud.commandframework.bukkit.BukkitCaptionKeys;
import cloud.commandframework.bukkit.BukkitCommandContextKeys;
import cloud.commandframework.captions.CaptionVariable;
import cloud.commandframework.context.CommandContext;
import cloud.commandframework.exceptions.parsing.NoInputProvidedException;
import cloud.commandframework.exceptions.parsing.ParserException;
import java.util.ArrayList;
import java.util.List;
import java.util.Queue;
import java.util.function.BiFunction;
import org.bukkit.Bukkit;
import org.bukkit.OfflinePlayer;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
/**
* Argument type that parses into {@link OfflinePlayer}. This is not thread safe. This
* may also result in a blocking request to get the UUID for the offline player.
*
* Avoid using this type if possible.
*
* @param Command sender type
*/
@SuppressWarnings("unused")
public final class OfflinePlayerArgument extends CommandArgument {
private OfflinePlayerArgument(
final boolean required,
final @NonNull String name,
final @NonNull String defaultValue,
final @Nullable BiFunction<@NonNull CommandContext, @NonNull String,
@NonNull List<@NonNull String>> suggestionsProvider,
final @NonNull ArgumentDescription defaultDescription
) {
super(
required,
name,
new OfflinePlayerParser<>(),
defaultValue,
OfflinePlayer.class,
suggestionsProvider,
defaultDescription
);
}
/**
* Create a new builder
*
* @param name Name of the component
* @param Command sender type
* @return Created builder
*/
public static @NonNull Builder newBuilder(final @NonNull String name) {
return new Builder<>(name);
}
/**
* Create a new required command component
*
* @param name Component name
* @param Command sender type
* @return Created component
*/
public static @NonNull CommandArgument of(final @NonNull String name) {
return OfflinePlayerArgument.newBuilder(name).asRequired().build();
}
/**
* Create a new optional command component
*
* @param name Component name
* @param Command sender type
* @return Created component
*/
public static @NonNull CommandArgument optional(final @NonNull String name) {
return OfflinePlayerArgument.newBuilder(name).asOptional().build();
}
/**
* Create a new required command component with a default value
*
* @param name Component name
* @param defaultPlayer Default player
* @param Command sender type
* @return Created component
*/
public static @NonNull CommandArgument optional(
final @NonNull String name,
final @NonNull String defaultPlayer
) {
return OfflinePlayerArgument.newBuilder(name).asOptionalWithDefault(defaultPlayer).build();
}
public static final class Builder extends CommandArgument.Builder {
private Builder(final @NonNull String name) {
super(OfflinePlayer.class, name);
}
/**
* Builder a new boolean component
*
* @return Constructed component
*/
@Override
public @NonNull OfflinePlayerArgument build() {
return new OfflinePlayerArgument<>(this.isRequired(), this.getName(), this.getDefaultValue(),
this.getSuggestionsProvider(), this.getDefaultDescription()
);
}
}
public static final class OfflinePlayerParser implements ArgumentParser {
@Override
@SuppressWarnings("deprecation")
public @NonNull ArgumentParseResult parse(
final @NonNull CommandContext commandContext,
final @NonNull Queue inputQueue
) {
final String input = inputQueue.peek();
if (input == null) {
return ArgumentParseResult.failure(new NoInputProvidedException(
OfflinePlayerParser.class,
commandContext
));
}
final OfflinePlayer player = Bukkit.getOfflinePlayer(input);
if (!player.hasPlayedBefore() && !player.isOnline()) {
return ArgumentParseResult.failure(new OfflinePlayerParseException(input, commandContext));
}
inputQueue.remove();
return ArgumentParseResult.success(player);
}
@Override
public @NonNull List<@NonNull String> suggestions(
final @NonNull CommandContext commandContext,
final @NonNull String input
) {
List output = new ArrayList<>();
for (Player player : Bukkit.getOnlinePlayers()) {
final CommandSender bukkit = commandContext.get(BukkitCommandContextKeys.BUKKIT_COMMAND_SENDER);
if (bukkit instanceof Player && !((Player) bukkit).canSee(player)) {
continue;
}
output.add(player.getName());
}
return output;
}
}
/**
* OfflinePlayer parse exception
*/
public static final class OfflinePlayerParseException extends ParserException {
private static final long serialVersionUID = 7632293268451349508L;
private final String input;
/**
* Construct a new OfflinePlayer parse exception
*
* @param input String input
* @param context Command context
*/
public OfflinePlayerParseException(
final @NonNull String input,
final @NonNull CommandContext context
) {
super(
OfflinePlayerParser.class,
context,
BukkitCaptionKeys.ARGUMENT_PARSE_FAILURE_OFFLINEPLAYER,
CaptionVariable.of("input", input)
);
this.input = input;
}
/**
* Get the supplied input
*
* @return String value
*/
public @NonNull String getInput() {
return this.input;
}
}
}