Cloud for commands (#3808)

Co-authored-by: onebeastchris <github@onechris.mozmail.com>

api/src/main/java/org/geysermc/geyser/api/command/Command.java

@@ -28,7 +28,9 @@ package org.geysermc.geyser.api.command;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.geysermc.geyser.api.GeyserApi;
 import org.geysermc.geyser.api.connection.GeyserConnection;
+import org.geysermc.geyser.api.event.lifecycle.GeyserRegisterPermissionsEvent;
 import org.geysermc.geyser.api.extension.Extension;
+import org.geysermc.geyser.api.util.TriState;
 
 import java.util.Collections;
 import java.util.List;
@@ -58,15 +60,15 @@ public interface Command {
      * Gets the permission node associated with
      * this command.
      *
-     * @return the permission node for this command
+     * @return the permission node for this command if defined, otherwise an empty string
      */
     @NonNull
     String permission();
 
     /**
-     * Gets the aliases for this command.
+     * Gets the aliases for this command, as an unmodifiable list
      *
-     * @return the aliases for this command
+     * @return the aliases for this command as an unmodifiable list
      */
     @NonNull
     List<String> aliases();
@@ -75,35 +77,39 @@ public interface Command {
      * Gets if this command is designed to be used only by server operators.
      *
      * @return if this command is designated to be used only by server operators.
+     * @deprecated this method is not guaranteed to provide meaningful or expected results.
      */
-    boolean isSuggestedOpOnly();
-
-    /**
-     * Gets if this command is executable on console.
-     *
-     * @return if this command is executable on console
-     */
-    boolean isExecutableOnConsole();
-
-    /**
-     * Gets the subcommands associated with this
-     * command. Mainly used within the Geyser Standalone
-     * GUI to know what subcommands are supported.
-     *
-     * @return the subcommands associated with this command
-     */
-    @NonNull
-    default List<String> subCommands() {
-        return Collections.emptyList();
+    @Deprecated(forRemoval = true)
+    default boolean isSuggestedOpOnly() {
+        return false;
     }
 
     /**
-     * Used to send a deny message to Java players if this command can only be used by Bedrock players.
-     *
-     * @return true if this command can only be used by Bedrock players.
+     * @return true if this command is executable on console
+     * @deprecated use {@link #isPlayerOnly()} instead (inverted)
      */
-    default boolean isBedrockOnly() {
-        return false;
+    @Deprecated(forRemoval = true)
+    default boolean isExecutableOnConsole() {
+        return !isPlayerOnly();
+    }
+
+    /**
+     * @return true if this command can only be used by players
+     */
+    boolean isPlayerOnly();
+
+    /**
+     * @return true if this command can only be used by Bedrock players
+     */
+    boolean isBedrockOnly();
+
+    /**
+     * @deprecated this method will always return an empty immutable list
+     */
+    @Deprecated(forRemoval = true)
+    @NonNull
+    default List<String> subCommands() {
+        return Collections.emptyList();
     }
 
     /**
@@ -128,7 +134,7 @@ public interface Command {
          * is an instance of this source.
          *
          * @param sourceType the source type
-         * @return the builder
+         * @return this builder
          */
         Builder<T> source(@NonNull Class<? extends T> sourceType);
 
@@ -136,7 +142,7 @@ public interface Command {
          * Sets the command name.
          *
          * @param name the command name
-         * @return the builder
+         * @return this builder
          */
         Builder<T> name(@NonNull String name);
 
@@ -144,23 +150,40 @@ public interface Command {
          * Sets the command description.
          *
          * @param description the command description
-         * @return the builder
+         * @return this builder
          */
         Builder<T> description(@NonNull String description);
 
         /**
-         * Sets the permission node.
+         * Sets the permission node required to run this command. <br>
+         * It will not be registered with any permission registries, such as an underlying server,
+         * or a permissions Extension (unlike {@link #permission(String, TriState)}).
          *
          * @param permission the permission node
-         * @return the builder
+         * @return this builder
          */
         Builder<T> permission(@NonNull String permission);
 
+        /**
+         * Sets the permission node and its default value. The usage of the default value is platform dependant
+         * and may or may not be used. For example, it may be registered to an underlying server.
+         * <p>
+         * Extensions may instead listen for {@link GeyserRegisterPermissionsEvent} to register permissions,
+         * especially if the same permission is required by multiple commands. Also see this event for TriState meanings.
+         *
+         * @param permission the permission node
+         * @param defaultValue the node's default value
+         * @return this builder
+         * @deprecated this method is experimental and may be removed in the future
+         */
+        @Deprecated
+        Builder<T> permission(@NonNull String permission, @NonNull TriState defaultValue);
+
         /**
          * Sets the aliases.
          *
          * @param aliases the aliases
-         * @return the builder
+         * @return this builder
          */
         Builder<T> aliases(@NonNull List<String> aliases);
 
@@ -168,46 +191,62 @@ public interface Command {
          * Sets if this command is designed to be used only by server operators.
          *
          * @param suggestedOpOnly if this command is designed to be used only by server operators
-         * @return the builder
+         * @return this builder
+         * @deprecated this method is not guaranteed to produce meaningful or expected results
          */
+        @Deprecated(forRemoval = true)
         Builder<T> suggestedOpOnly(boolean suggestedOpOnly);
 
         /**
          * Sets if this command is executable on console.
          *
          * @param executableOnConsole if this command is executable on console
-         * @return the builder
+         * @return this builder
+         * @deprecated use {@link #isPlayerOnly()} instead (inverted)
          */
+        @Deprecated(forRemoval = true)
         Builder<T> executableOnConsole(boolean executableOnConsole);
 
+        /**
+         * Sets if this command can only be executed by players.
+         *
+         * @param playerOnly if this command is player only
+         * @return this builder
+         */
+        Builder<T> playerOnly(boolean playerOnly);
+
+        /**
+         * Sets if this command can only be executed by bedrock players.
+         *
+         * @param bedrockOnly if this command is bedrock only
+         * @return this builder
+         */
+        Builder<T> bedrockOnly(boolean bedrockOnly);
+
         /**
          * Sets the subcommands.
          *
          * @param subCommands the subcommands
-         * @return the builder
+         * @return this builder
+         * @deprecated this method has no effect
          */
-        Builder<T> subCommands(@NonNull List<String> subCommands);
-
-        /**
-         * Sets if this command is bedrock only.
-         *
-         * @param bedrockOnly if this command is bedrock only
-         * @return the builder
-         */
-        Builder<T> bedrockOnly(boolean bedrockOnly);
+        @Deprecated(forRemoval = true)
+        default Builder<T> subCommands(@NonNull List<String> subCommands) {
+            return this;
+        }
 
         /**
          * Sets the {@link CommandExecutor} for this command.
          *
          * @param executor the command executor
-         * @return the builder
+         * @return this builder
          */
         Builder<T> executor(@NonNull CommandExecutor<T> executor);
 
         /**
          * Builds the command.
          *
-         * @return the command
+         * @return a new command from this builder
          */
         @NonNull
         Command build();

api/src/main/java/org/geysermc/geyser/api/command/CommandSource.java

@@ -26,6 +26,10 @@
 package org.geysermc.geyser.api.command;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.geysermc.geyser.api.connection.GeyserConnection;
+
+import java.util.UUID;
 
 /**
  * Represents an instance capable of sending commands.
@@ -64,6 +68,17 @@ public interface CommandSource {
      */
     boolean isConsole();
 
+    /**
+     * @return a Java UUID if this source represents a player, otherwise null
+     */
+    @Nullable UUID playerUuid();
+
+    /**
+     * @return a GeyserConnection if this source represents a Bedrock player that is connected
+     * to this Geyser instance, otherwise null
+     */
+    @Nullable GeyserConnection connection();
+
     /**
      * Returns the locale of the command source.
      *

api/src/main/java/org/geysermc/geyser/api/event/lifecycle/GeyserDefineCommandsEvent.java

@@ -50,7 +50,7 @@ public interface GeyserDefineCommandsEvent extends Event {
     /**
      * Gets all the registered built-in {@link Command}s.
      *
-     * @return all the registered built-in commands
+     * @return all the registered built-in commands as an unmodifiable map
      */
     @NonNull
     Map<String, Command> commands();

api/src/main/java/org/geysermc/geyser/api/event/lifecycle/GeyserRegisterPermissionCheckersEvent.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2019-2023 GeyserMC. http://geysermc.org
+ *
+ * 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.
+ *
+ * @author GeyserMC
+ * @link https://github.com/GeyserMC/Geyser
+ */
+
+package org.geysermc.geyser.api.event.lifecycle;
+
+import org.geysermc.event.Event;
+import org.geysermc.event.PostOrder;
+import org.geysermc.geyser.api.permission.PermissionChecker;
+
+/**
+ * Fired by any permission manager implementations that wish to add support for custom permission checking.
+ * This event is not guaranteed to be fired - it is currently only fired on Geyser-Standalone and ViaProxy.
+ * <p>
+ * Subscribing to this event with an earlier {@link PostOrder} and registering a {@link PermissionChecker}
+ * will result in that checker having a higher priority than others.
+ */
+public interface GeyserRegisterPermissionCheckersEvent extends Event {
+
+    void register(PermissionChecker checker);
+}

api/src/main/java/org/geysermc/geyser/api/event/lifecycle/GeyserRegisterPermissionsEvent.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2019-2023 GeyserMC. http://geysermc.org
+ *
+ * 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.
+ *
+ * @author GeyserMC
+ * @link https://github.com/GeyserMC/Geyser
+ */
+
+package org.geysermc.geyser.api.event.lifecycle;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.geysermc.event.Event;
+import org.geysermc.geyser.api.util.TriState;
+
+/**
+ * Fired by anything that wishes to gather permission nodes and defaults.
+ * <p>
+ * This event is not guaranteed to be fired, as certain Geyser platforms do not have a native permission system.
+ * It can be expected to fire on Geyser-Spigot, Geyser-NeoForge, Geyser-Standalone, and Geyser-ViaProxy
+ * It may be fired by a 3rd party regardless of the platform.
+ */
+public interface GeyserRegisterPermissionsEvent extends Event {
+
+    /**
+     * Registers a permission node and its default value with the firer.<p>
+     * {@link TriState#TRUE} corresponds to all players having the permission by default.<br>
+     * {@link TriState#NOT_SET} corresponds to only server operators having the permission by default (if such a concept exists on the platform).<br>
+     * {@link TriState#FALSE} corresponds to no players having the permission by default.<br>
+     *
+     * @param permission the permission node to register
+     * @param defaultValue the default value of the node
+     */
+    void register(@NonNull String permission, @NonNull TriState defaultValue);
+}

api/src/main/java/org/geysermc/geyser/api/extension/Extension.java

@@ -107,6 +107,15 @@ public interface Extension extends EventRegistrar {
         return this.extensionLoader().description(this);
     }
 
+    /**
+     * @return the root command that all of this extension's commands will stem from.
+     *         By default, this is the extension's id.
+     */
+    @NonNull
+    default String rootCommand() {
+        return this.description().id();
+    }
+
     /**
      * Gets the extension's logger
      *

api/src/main/java/org/geysermc/geyser/api/permission/PermissionChecker.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2019-2023 GeyserMC. http://geysermc.org
+ *
+ * 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.
+ *
+ * @author GeyserMC
+ * @link https://github.com/GeyserMC/Geyser
+ */
+
+package org.geysermc.geyser.api.permission;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.geysermc.geyser.api.command.CommandSource;
+import org.geysermc.geyser.api.util.TriState;
+
+/**
+ * Something capable of checking if a {@link CommandSource} has a permission
+ */
+@FunctionalInterface
+public interface PermissionChecker {
+
+    /**
+     * Checks if the given source has a permission
+     *
+     * @param source the {@link CommandSource} whose permissions should be queried
+     * @param permission the permission node to check
+     * @return a {@link TriState} as the value of the node. {@link TriState#NOT_SET} generally means that the permission
+     *         node itself was not found, and the source does not have such permission.
+     *         {@link TriState#TRUE} and {@link TriState#FALSE} represent explicitly set values.
+     */
+    @NonNull
+    TriState hasPermission(@NonNull CommandSource source, @NonNull String permission);
+}