Upstream
/
PlotSquared
mirror of https://github.com/IntellectualSites/PlotSquared.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

use cloud-requirements

This commit is contained in:
Alexander Söderberg 2024-01-02 18:59:39 +01:00
parent 3a1b373c8e
commit 92a00ef60a
No known key found for this signature in database
9 changed files with 66 additions and 148 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Bukkit/src/main/java/com/plotsquared/bukkit/inject/CloudModule.java
View File

@ -29,8 +29,9 @@ import com.google.inject.TypeLiteral;
import com.plotsquared.bukkit.BukkitPlatform;
import com.plotsquared.bukkit.commands.BukkitSenderMapper;
import com.plotsquared.bukkit.util.BukkitUtil;
import com.plotsquared.core.commands.CommandRequirement;
import com.plotsquared.core.commands.PlotSquaredCaptionProvider;
import com.plotsquared.core.commands.processing.CommandRequirementPostprocessor;
import com.plotsquared.core.commands.PlotSquaredRequirementFailureHandler;
import com.plotsquared.core.configuration.caption.TranslatableCaption;
import com.plotsquared.core.player.ConsolePlayer;
import com.plotsquared.core.player.PlotPlayer;
@ -40,6 +41,7 @@ import org.bukkit.Bukkit;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.incendo.cloud.requirement.RequirementPostprocessor;
public class CloudModule extends AbstractModule {
@ -80,7 +82,8 @@ public class CloudModule extends AbstractModule {
commandManager.registerAsynchronousCompletions();
}
final CommandRequirementPostprocessor requirementPostprocessor = new CommandRequirementPostprocessor();
final RequirementPostprocessor<PlotPlayer<?>, CommandRequirement> requirementPostprocessor =
RequirementPostprocessor.of(CommandRequirement.REQUIREMENTS_KEY, new PlotSquaredRequirementFailureHandler());
commandManager.registerCommandPostProcessor(requirementPostprocessor);
// TODO(City): Override parsing errors using MM parsing.

1
Core/build.gradle.kts
View File

@ -18,6 +18,7 @@ dependencies {
// Cloud
api(libs.cloud)
api(libs.cloudMinecraftExtras)
api(libs.cloudRequirements)
// Guice
api(libs.guice) {

36
Core/src/main/java/com/plotsquared/core/commands/CommandRequirement.java
View File

@ -19,19 +19,32 @@
package com.plotsquared.core.commands;
import cloud.commandframework.context.CommandContext;
import cloud.commandframework.keys.CloudKey;
import com.plotsquared.core.configuration.caption.TranslatableCaption;
import com.plotsquared.core.permissions.Permission;
import com.plotsquared.core.player.PlotPlayer;
import io.leangen.geantyref.TypeToken;
import net.kyori.adventure.text.minimessage.tag.Tag;
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.incendo.cloud.requirement.Requirement;
import org.incendo.cloud.requirement.Requirements;
import java.util.List;
/**
* Something that is required for a command to be executed.
*/
public interface CommandRequirement {
public interface CommandRequirement extends Requirement<PlotPlayer<?>, CommandRequirement> {
/**
* The key used to store the requirements in the {@link cloud.commandframework.meta.CommandMeta}.
*/
CloudKey<Requirements<PlotPlayer<?>, CommandRequirement>> REQUIREMENTS_KEY = CloudKey.of(
"requirements",
new TypeToken<Requirements<PlotPlayer<?>, CommandRequirement>>() {
}
);
/**
* Returns the caption sent when the requirement is not met.
@ -40,14 +53,6 @@ public interface CommandRequirement {
*/
@NonNull TranslatableCaption failureCaption();
/**
* Evaluates whether the requirement is met.
*
* @param context command context to evaluate
* @return {@code true} if the requirement is met, else {@code false}
*/
boolean evaluate(final @NonNull CommandContext<PlotPlayer<?>> context);
/**
* Returns the placeholder values.
*
@ -57,15 +62,6 @@ public interface CommandRequirement {
return new TagResolver[0];
}
/**
* Returns the list of parent requirements that should be evaluated before this requirement.
*
* @return the requirements
*/
default @NonNull List<@NonNull CommandRequirement> parents() {
return List.of();
}
/**
* Returns a requirement that evaluates to {@code true} if the sender has the given {@code permission} or if
* this requirement evaluates to {@code true}.
@ -94,8 +90,8 @@ public interface CommandRequirement {
}
@Override
public boolean evaluate(final @NonNull CommandContext<PlotPlayer<?>> context) {
return context.sender().hasPermission(permission) || thisRequirement.evaluate(context);
public boolean evaluateRequirement(final @NonNull CommandContext<PlotPlayer<?>> context) {
return context.sender().hasPermission(permission) || thisRequirement.evaluateRequirement(context);
}
};
}

72
Core/src/main/java/com/plotsquared/core/commands/CommandRequirements.java
View File

@ -1,72 +0,0 @@
/*
* PlotSquared, a land and world management plugin for Minecraft.
* Copyright (C) IntellectualSites <https://intellectualsites.com>
* Copyright (C) IntellectualSites 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.plotsquared.core.commands;
import cloud.commandframework.keys.CloudKey;
import org.checkerframework.checker.nullness.qual.NonNull;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
/**
* Holder of {@link CommandRequirement} requirements.
*/
public final class CommandRequirements implements Iterable<@NonNull CommandRequirement> {
/**
* The key used to store the requirements in the {@link cloud.commandframework.meta.CommandMeta}.
*/
public static final CloudKey<CommandRequirements> REQUIREMENTS_KEY = CloudKey.of(
"requirements",
CommandRequirements.class
);
/**
* Creates a new instance.
*
* @param requirements the requirements
* @return the instance
*/
public static @NonNull CommandRequirements create(final @NonNull List<@NonNull CommandRequirement> requirements) {
return new CommandRequirements(requirements);
}
private static @NonNull List<@NonNull CommandRequirement> extractRequirements(
final @NonNull List<@NonNull CommandRequirement> requirements
) {
final List<CommandRequirement> extractedRequirements = new ArrayList<>();
for (final CommandRequirement requirement : requirements) {
extractedRequirements.addAll(extractRequirements(requirement.parents()));
extractedRequirements.add(requirement);
}
return extractedRequirements;
}
private final List<CommandRequirement> requirements;
private CommandRequirements(final @NonNull List<@NonNull CommandRequirement> requirements) {
this.requirements = List.copyOf(extractRequirements(requirements));
}
@Override
public @NonNull Iterator<@NonNull CommandRequirement> iterator() {
return this.requirements.iterator();
}
}

2
Core/src/main/java/com/plotsquared/core/commands/CommonCommandRequirement.java
View File

@ -75,7 +75,7 @@ public enum CommonCommandRequirement implements CommandRequirement {
}
@Override
public boolean evaluate(final @NonNull CommandContext<PlotPlayer<?>> context) {
public boolean evaluateRequirement(final @NonNull CommandContext<PlotPlayer<?>> context) {
return this.predicate.test(context);
}
}

7
Core/src/main/java/com/plotsquared/core/commands/PlotSquaredCommandBean.java
View File

@ -24,11 +24,16 @@ import cloud.commandframework.CommandProperties;
import com.plotsquared.core.command.CommandCategory;
import com.plotsquared.core.player.PlotPlayer;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.incendo.cloud.requirement.RequirementApplicable;
import org.incendo.cloud.requirement.Requirements;
import java.util.List;
public abstract class PlotSquaredCommandBean extends CommandBean<PlotPlayer<?>> {
private final RequirementApplicable.RequirementApplicableFactory<PlotPlayer<?>, CommandRequirement>
requirementApplicableFactory = RequirementApplicable.factory(CommandRequirement.REQUIREMENTS_KEY);
/**
* Returns the category of the command.
*
@ -64,7 +69,7 @@ public abstract class PlotSquaredCommandBean extends CommandBean<PlotPlayer<?>>
@Override
protected final Command.@NonNull Builder<PlotPlayer<?>> configure(final Command.@NonNull Builder<PlotPlayer<?>> builder) {
return this.configurePlotCommand(this.prepare(builder.meta(PlotSquaredCommandMeta.META_CATEGORY, this.category())))
.meta(CommandRequirements.REQUIREMENTS_KEY, CommandRequirements.create(this.requirements()));
.apply(this.requirementApplicableFactory.create(Requirements.of(this.requirements())));
}
protected abstract Command.@NonNull Builder<PlotPlayer<?>> configurePlotCommand(

35
Core/src/main/java/com/plotsquared/core/commands/PlotSquaredRequirementFailureHandler.java Normal file
View File

@ -0,0 +1,35 @@
/*
* PlotSquared, a land and world management plugin for Minecraft.
* Copyright (C) IntellectualSites <https://intellectualsites.com>
* Copyright (C) IntellectualSites 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.plotsquared.core.commands;
import cloud.commandframework.context.CommandContext;
import com.plotsquared.core.player.PlotPlayer;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.incendo.cloud.requirement.RequirementFailureHandler;
public final class PlotSquaredRequirementFailureHandler implements RequirementFailureHandler<PlotPlayer<?>, CommandRequirement> {
@Override
public void handleFailure(
final @NonNull CommandContext<PlotPlayer<?>> context,
final @NonNull CommandRequirement requirement
) {
context.sender().sendMessage(requirement.failureCaption(), requirement.tagResolvers());
}
}

52
Core/src/main/java/com/plotsquared/core/commands/processing/CommandRequirementPostprocessor.java
View File

@ -1,52 +0,0 @@
/*
* PlotSquared, a land and world management plugin for Minecraft.
* Copyright (C) IntellectualSites <https://intellectualsites.com>
* Copyright (C) IntellectualSites 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.plotsquared.core.commands.processing;
import cloud.commandframework.execution.postprocessor.CommandPostprocessingContext;
import cloud.commandframework.execution.postprocessor.CommandPostprocessor;
import cloud.commandframework.services.types.ConsumerService;
import com.plotsquared.core.commands.CommandRequirement;
import com.plotsquared.core.commands.CommandRequirements;
import com.plotsquared.core.player.PlotPlayer;
import org.checkerframework.checker.nullness.qual.NonNull;
/**
* Processor that evaluates registered {@link CommandRequirement command requirements} before a command is executed.
*/
public final class CommandRequirementPostprocessor implements CommandPostprocessor<PlotPlayer<?>> {
@Override
public void accept(final @NonNull CommandPostprocessingContext<PlotPlayer<?>> processingContext) {
final CommandRequirements requirements = processingContext.command().commandMeta().getOrDefault(
CommandRequirements.REQUIREMENTS_KEY,
null
);
if (requirements == null) {
return;
}
for (final CommandRequirement requirement : requirements) {
if (requirement.evaluate(processingContext.commandContext())) {
continue;
}
processingContext.commandContext().sender().sendMessage(requirement.failureCaption(), requirement.tagResolvers());
// Not allowed :(
ConsumerService.interrupt();
}
}
}

2
gradle/libs.versions.toml
View File

@ -32,6 +32,7 @@ informative-annotations = "1.4"
vault = "1.7.1"
serverlib = "2.3.4"
cloud = "2.0.0-SNAPSHOT"
cloudRequirements = "1.0.0-SNAPSHOT"
# Gradle plugins
shadow = "8.1.1"
@ -81,6 +82,7 @@ serverlib = { group = "dev.notmyfault.serverlib", name = "ServerLib", version.re
cloud = { group = "cloud.commandframework", name = "cloud-core", version.ref = "cloud" }
cloudPaper = { group = "cloud.commandframework", name = "cloud-paper", version.ref = "cloud" }
cloudMinecraftExtras = { group = "cloud.commandframework", name = "cloud-minecraft-extras", version.ref = "cloud" }
cloudRequirements = { group = "org.incendo", name = "cloud-requirements", version.ref = "cloudRequirements" }
[plugins]
shadow = { id = "com.github.johnrengelman.shadow", version.ref = "shadow" }