Cloud for commands #3808

Konicai · 2023-06-02T03:35:15Z

changes

GeyserCommandManager has been renamed to CommandRegistry
GeyserCommandExecutor and all subclasses have been removed in favour of Cloud.
WorldManager#hasPermission has been removed in favour of Cloud.
permission node for the root command of Geyser and extensions, that is required to use any child commands
Spigot
- no longer depends on paper mojang api.
- GeyserBrigadierSupport has been removed in favour of Cloud.
- GeyserPaperCommandListener has been removed - cloud (and the way i designed permission checks) handles what it did.
Standalone/ViaProxy:
- permissions.yml has been added, a list of default permissions available to all players.
Velocity/BungeeCord/Fabric/Standalone: commands are now registered before GeyserPostInitializeEvent, for consistency with Spigot, and to allow valid registration on Fabric.
- There is still inconsistency between bootstraps on whether or not commands are re-registered whenever a reload occurs.

api changes:

deprecations

Command#isSuggestedOpOnly and the relevant builder method have been deprecated for removal
Command#subCommands has been deprecated for removal and will always return Collections.emptyList()
Command#isExecutableOnConsole() has been deprecated & replaced with #isPlayerOnly()

changes

Command#aliases() now always returns an immutable list

additions

Command.Builder#permission(String, Tristate) - register the permission and its default value to the server implementation if possible.
CommandSource#playerUuid - return a uuid if the source represents a player.
CommandSource#connection - return a Connection if the source represents a bedrock player managed by the current Geyser instance.

GeyserRegisterPermissionCheckersEvent - only used by Geyser-Standalone/ViaProxy. Fired when the command manager is created. Allows registering PermissionCheckers to the manager. Event listeners with a higher listener priority will register PermissionCheckers as having a higher priority.
PermissionChecker - api interface that is responsible for resolving a CommandSource and a permission node to a Tristate.

GeyserRegisterPermissionsEvent - fired by a server platform, or extension, or anything, when it is the proper time for permissions to be registered to the event caller. This event will be called by Geyser-Spigot/Standalone/Forge. An extension may also fire the event in order to register permissions to LuckPerms for Geyser-Velocity/BungeeCord/Fabric. Geyser's CommandRegistry will listen for this event, but api users may as well.

future and separate PRs

implementations of CommandSource#sendMessage are wildly different in terms of what kind of text format is passed to it. maybe an earlier PR.
use cloud's brigadier mappings to get suggestions on geyser standalone
add tab completion to geyser standalone JLine

todo:

at least right now lol

bootstrap/spigot/src/main/java/org/geysermc/geyser/platform/spigot/GeyserSpigotPlugin.java

...ocity/src/main/java/org/geysermc/geyser/platform/velocity/command/VelocityCommandSource.java

any GeyserCommandSource should be valid to use in any CommandManager as long as one of the following is satisfied 1. it is a platform implementation 2. isConsole() returns true 2. playerUuid() returns a valid uuid and the player lookup succeeds

# Conflicts: # bootstrap/bungeecord/build.gradle.kts # bootstrap/spigot/build.gradle.kts # core/src/main/java/org/geysermc/geyser/command/GeyserCommandManager.java # core/src/main/java/org/geysermc/geyser/translator/protocol/bedrock/BedrockCommandRequestTranslator.java

# Conflicts: # bootstrap/standalone/src/main/java/org/geysermc/geyser/platform/standalone/gui/GeyserStandaloneGUI.java

# Conflicts: # bootstrap/fabric/src/main/java/org/geysermc/geyser/platform/fabric/GeyserFabricMod.java # bootstrap/fabric/src/main/java/org/geysermc/geyser/platform/fabric/command/FabricCommandSource.java # bootstrap/fabric/src/main/java/org/geysermc/geyser/platform/fabric/command/GeyserFabricCommandExecutor.java # bootstrap/spigot/src/main/java/org/geysermc/geyser/platform/spigot/GeyserSpigotPlugin.java # core/src/main/java/org/geysermc/geyser/command/defaults/HelpCommand.java # core/src/main/java/org/geysermc/geyser/command/defaults/VersionCommand.java # core/src/main/resources/languages # gradle/libs.versions.toml

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

core/src/main/java/org/geysermc/geyser/command/defaults/AdvancedTooltipsCommand.java

feeling kinda icky but idk

- create cloud earlier - trigger resource reload after geyser registers commands to cloud so that cloud registers them to the server

onebeastchris

some thoughts that came to mind, looks good otherwise (skipped the NeoForge permission stuff, since well, that's known)

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

...forge/src/main/java/org/geysermc/geyser/platform/neoforge/GeyserNeoForgeCommandRegistry.java

...ndalone/src/main/java/org/geysermc/geyser/platform/standalone/GeyserStandaloneBootstrap.java

core/src/main/java/org/geysermc/geyser/command/CommandRegistry.java

core/src/main/java/org/geysermc/geyser/command/defaults/DumpCommand.java

core/src/main/java/org/geysermc/geyser/extension/command/GeyserExtensionCommand.java

core/src/main/java/org/geysermc/geyser/session/GeyserSession.java

…nnection

# Conflicts: # bootstrap/mod/neoforge/src/main/java/org/geysermc/geyser/platform/neoforge/GeyserNeoForgeBootstrap.java # bootstrap/mod/src/main/java/org/geysermc/geyser/platform/mod/GeyserModBootstrap.java # bootstrap/velocity/src/main/java/org/geysermc/geyser/platform/velocity/GeyserVelocityPlugin.java # core/src/main/java/org/geysermc/geyser/session/GeyserSession.java # core/src/main/java/org/geysermc/geyser/translator/protocol/bedrock/BedrockCommandRequestTranslator.java

… of Help

…e subscription

onebeastchris

One nitpick; also the @NonNull nature of the permission/permission default on the permission registration event doesn't seem to be enforced at the moment

core/src/main/java/org/geysermc/geyser/command/CommandRegistry.java

Konicai · 2024-06-10T04:27:05Z

bootstrap/spigot/src/main/java/org/geysermc/geyser/platform/spigot/GeyserSpigotPlugin.java

@@ -213,6 +218,7 @@ public void onGeyserEnable() {

        GeyserImpl.start();

+
        if (geyserConfig.isLegacyPingPassthrough()) {


remove diff

Konicai · 2024-06-10T04:34:15Z

bootstrap/mod/src/main/java/org/geysermc/geyser/platform/mod/GeyserModUpdateListener.java

-            VersionCheckUtils.checkForGeyserUpdate(() -> new ModCommandSender(stack));
+        ModCommandSource source = new ModCommandSource(player.createCommandSourceStack());
+        if (source.hasPermission(Permissions.CHECK_UPDATE)) {
+            VersionCheckUtils.checkForGeyserUpdate(() -> source);


revert but use source.getServer().getOperatorUserPermissionLevel() instead of 2

Konicai · 2024-06-10T04:35:06Z

bootstrap/mod/src/main/java/org/geysermc/geyser/platform/mod/command/ModCommandSource.java

    }
-}
+}


Konicai · 2024-06-10T04:35:28Z

bootstrap/mod/src/main/java/org/geysermc/geyser/platform/mod/command/ModCommandSource.java


    private final CommandSourceStack source;

-    public ModCommandSender(CommandSourceStack source) {
+    public ModCommandSource(CommandSourceStack source) {
        this.source = source;
    }


load geyser locale like other CommandSource implementations?

Unfortunately, the CommandSourceStack doesn't expose a locale - Floodgate-Fabric for example always fallbacks to en_US as of now: https://github.com/GeyserMC/Floodgate-Fabric/blob/master/src/main/java/org/geysermc/floodgate/util/FabricCommandUtil.java#L43

Konicai · 2024-06-10T05:14:35Z

core/src/main/java/org/geysermc/geyser/command/CommandSourceConverter.java

+    public @NonNull S reverse(GeyserCommandSource source) throws IllegalArgumentException {
+        Object handle = source.handle();
+        if (senderType.isInstance(handle)) {
+            return senderType.cast(source); // one of the server platform implementations


handle not source, recent regression

bootstrap/spigot/src/main/java/org/geysermc/geyser/platform/spigot/GeyserSpigotPlugin.java

onebeastchris · 2024-06-10T14:27:02Z

bootstrap/mod/src/main/java/org/geysermc/geyser/platform/mod/command/ModCommandSource.java


    private final CommandSourceStack source;

-    public ModCommandSender(CommandSourceStack source) {
+    public ModCommandSource(CommandSourceStack source) {
        this.source = source;
    }


Unfortunately, the CommandSourceStack doesn't expose a locale - Floodgate-Fabric for example always fallbacks to en_US as of now: https://github.com/GeyserMC/Floodgate-Fabric/blob/master/src/main/java/org/geysermc/floodgate/util/FabricCommandUtil.java#L43

onebeastchris · 2024-06-10T14:28:11Z

core/src/main/java/org/geysermc/geyser/command/CommandRegistry.java

+     * it yet to platforms like Velocity where we cannot natively specify a permission default. Doing so will
+     * break setups as players would suddenly not have the required permission to execute any Geyser commands.
+     */
+    protected boolean applyRootPermission() {


should also be overridden on Standalone/ViaProxy/NeoForge

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

core/src/main/java/org/geysermc/geyser/Permissions.java

core/src/main/java/org/geysermc/geyser/command/GeyserCommand.java

Camotoy · 2024-06-10T20:03:20Z

core/src/main/java/org/geysermc/geyser/command/defaults/HelpCommand.java

-        });
+        this.commands.stream()
+            .distinct() // remove aliases
+            .filter(cmd -> !cmd.isBedrockOnly() || bedrockPlayer) // remove bedrock only commands if not a bedrock player


Small, unimportant nitpick: this might be a bit better as .filter(bedrockPlayer ? Predicates.alwaysTrue() : cmd -> !cmd.isBedrockOnly()).

Camotoy · 2024-06-10T20:16:54Z

core/src/main/java/org/geysermc/geyser/command/GeyserCommand.java

-    public abstract void execute(@Nullable GeyserSession session, GeyserCommandSource sender, String[] args);
+    /**
+     * The default value of the permission node.
+     * A null value indicates that the permission node should not be registered whatsoever.


Can we document what each of the values means here, or link to another Javadoc where they are explained?

Konicai added 3 commits June 1, 2023 00:28

Initial start on cloud

db5ccff

Compiling and working on spigot

8d7e789

paper-mojangapi is no longer required

9da3345

at least right now lol

Konicai changed the title ~~Feature/cloud~~ Cloud for commands Jun 2, 2023

Camotoy reviewed Jun 2, 2023

View reviewed changes

bootstrap/spigot/src/main/java/org/geysermc/geyser/platform/spigot/GeyserSpigotPlugin.java Outdated Show resolved Hide resolved

...ocity/src/main/java/org/geysermc/geyser/platform/velocity/command/VelocityCommandSource.java Show resolved Hide resolved

Konicai and others added 12 commits June 2, 2023 18:52

Cleanup the last commit

8e6d7d3

Fix small mistakes

e2f71af

Refactor CommandSourceConverter

411c289

Initial start on permissions

e3532fa

Fix GeyserSession#hasPermission, remove WorldManager#hasPermission, docs

5b3226b

Merge remote-tracking branch 'upstream/master' into feature/cloud

f553e83

# Conflicts: # bootstrap/standalone/src/main/java/org/geysermc/geyser/platform/standalone/gui/GeyserStandaloneGUI.java

permissions.yml and compiling

a830fb7

Make commands fully use cloud, command api deprecations

049e29e

Handle exceptions on standalone, class renaming and moving

6c932ec

Camotoy reviewed Aug 31, 2023

View reviewed changes

api/src/main/java/org/geysermc/geyser/api/permission/PermissionChecker.java Show resolved Hide resolved

Camotoy reviewed Aug 31, 2023

View reviewed changes

core/src/main/java/org/geysermc/geyser/command/defaults/AdvancedTooltipsCommand.java Outdated Show resolved Hide resolved

Konicai added 11 commits August 31, 2023 23:17

misc changes for reviews

47031ce

Cleanup builtin and extension command implementations

cddc34a

CommandBuilder -> ExtensionCommandBuilder

aea2a18

Attempt at permission defaults for spigot

7ee26fb

Define default permissions of builtin commands

94d3f62

Undo some changes, some legacy compat for suggestedOpOnly

4b893e6

Merge branch 'master' into feature/cloud

54b2597

Allow commands without aliases to have their permissions registered

2ab03e7

Don't force perm registration of perms used by commands

887509b

feeling kinda icky but idk

Merge remote-tracking branch 'origin/feature/cloud' into feature/cloud

a640e1a

fix commands on fabric

1eba87d

- create cloud earlier - trigger resource reload after geyser registers commands to cloud so that cloud registers them to the server

Konicai added 2 commits May 6, 2024 02:43

cleanup CommandRegistry

bdc2d07

misc

5105132

onebeastchris approved these changes May 7, 2024

View reviewed changes

Konicai added 14 commits May 8, 2024 00:41

address some reviews, update cloud, separate exception handling

1140306

Update GeyserNeoForgeCommandRegistry#hasPermission exception handling

83c131e

CommandSource#connection should return GeyserConnection instead of Co…

6f6be87

…nnection

NeoForge: Mixin for new PermissionNode instead of reflection

b5f6ddd

CommandRegistry: Don't expose the CommandManager

348ee4f

misc cleanup

30aa88e

Only initialize commands once on Geyser-Standalone

cc94227

delegate CommandSource#playerUuid impl in GeyserSession

c92ae75

discard root command permission for now, move root->help delegate out…

db399cb

… of Help

add back root command permission optionally, to avoid Spigot regression

c672d62

Permissions class for general perms, GeyserImpl is responsible for th…

d1abeee

…e subscription

Cleanup command constructors, reference GeyserCommand more

5ad0da1

register all permissions on NeoForge

4c00b11

onebeastchris reviewed Jun 10, 2024

View reviewed changes

core/src/main/java/org/geysermc/geyser/command/CommandRegistry.java Outdated Show resolved Hide resolved

Konicai added 3 commits June 9, 2024 21:13

check more parameters

3f90320

only one permissions.yml file, in core

c3d5219

update to cloud rc.2

ffb8256

Konicai requested review from rtm516, onebeastchris and Camotoy June 10, 2024 04:15

Konicai commented Jun 10, 2024

View reviewed changes

onebeastchris approved these changes Jun 10, 2024

View reviewed changes

Camotoy reviewed Jun 10, 2024

View reviewed changes

some review

6159799

onebeastchris mentioned this pull request Jun 12, 2024

Connectiontest doesn't work with IPv6 domain or address #4733

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cloud for commands #3808

Cloud for commands #3808

Konicai commented Jun 2, 2023 •

edited

onebeastchris left a comment

onebeastchris left a comment

Konicai Jun 10, 2024

Konicai Jun 10, 2024

Konicai Jun 10, 2024

Konicai Jun 10, 2024

onebeastchris Jun 10, 2024

Konicai Jun 10, 2024 •

edited

onebeastchris Jun 10, 2024

onebeastchris Jun 10, 2024

Camotoy Jun 10, 2024

Camotoy Jun 10, 2024

		@@ -213,6 +218,7 @@ public void onGeyserEnable() {

		GeyserImpl.start();


		if (geyserConfig.isLegacyPingPassthrough()) {

Cloud for commands #3808

Are you sure you want to change the base?

Cloud for commands #3808

Conversation

Konicai commented Jun 2, 2023 • edited

changes

api changes:

deprecations

changes

additions

future and separate PRs

todo:

onebeastchris left a comment

Choose a reason for hiding this comment

onebeastchris left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Konicai Jun 10, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Konicai commented Jun 2, 2023 •

edited

Konicai Jun 10, 2024 •

edited