Implement Minestom user metadata

Author: ItsNature

minestom/src/main/java/com/lunarclient/apollo/ApolloMinestomPlatform.java

@@ -25,8 +25,10 @@
 
 import com.lunarclient.apollo.command.MinestomApolloCommand;
 import com.lunarclient.apollo.command.MinestomLunarClientCommand;
+import com.lunarclient.apollo.listener.ApolloMetadataListener;
 import com.lunarclient.apollo.listener.ApolloPlayerListener;
 import com.lunarclient.apollo.listener.ApolloWorldListener;
+import com.lunarclient.apollo.metadata.MinestomMetadataManager;
 import com.lunarclient.apollo.module.ApolloModuleManagerImpl;
 import com.lunarclient.apollo.module.autotexthotkey.AutoTextHotkeyModule;
 import com.lunarclient.apollo.module.beam.BeamModule;
@@ -132,9 +134,11 @@ public static void init() {
         instance = new ApolloMinestomPlatform();
 
         ApolloManager.bootstrap(instance);
+        ApolloManager.setMetadataManager(new MinestomMetadataManager());
 
         EventNode<Event> node = EventNode.all("apollo");
 
+        new ApolloMetadataListener(node);
         new ApolloPlayerListener(node);
         new ApolloWorldListener(node);
 

minestom/src/main/java/com/lunarclient/apollo/listener/ApolloMetadataListener.java

@@ -0,0 +1,74 @@
+/*
+ * This file is part of Apollo, licensed under the MIT License.
+ *
+ * Copyright (c) 2023 Moonsworth
+ *
+ * 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 com.lunarclient.apollo.listener;
+
+import com.lunarclient.apollo.ApolloManager;
+import com.lunarclient.apollo.metadata.MinestomMetadataManager;
+import com.lunarclient.apollo.util.ByteBufUtil;
+import java.nio.ByteBuffer;
+import java.util.Map;
+import net.minestom.server.event.Event;
+import net.minestom.server.event.EventNode;
+import net.minestom.server.event.player.PlayerPluginMessageEvent;
+import net.minestom.server.event.player.PlayerResourcePackStatusEvent;
+
+/**
+ * Handles Apollo metadata listeners.
+ *
+ * @since 1.2.0
+ */
+public final class ApolloMetadataListener {
+
+    /**
+     * Constructs the {@link ApolloMetadataListener}.
+     *
+     * @param node the node
+     * @since 1.2.0
+     */
+    public ApolloMetadataListener(EventNode<Event> node) {
+        node.addListener(PlayerResourcePackStatusEvent.class, this::onResourcePackStatus);
+        node.addListener(PlayerPluginMessageEvent.class, this::onPlayerPluginMessage);
+    }
+
+    private void onResourcePackStatus(PlayerResourcePackStatusEvent event) {
+        String status = event.getStatus().name();
+        MinestomMetadataManager manager = (MinestomMetadataManager) ApolloManager.getMetadataManager();
+        Map<String, Integer> statuses = manager.getResourcePackStatuses();
+
+        statuses.put(status, statuses.getOrDefault(status, 0) + 1);
+    }
+
+    private void onPlayerPluginMessage(PlayerPluginMessageEvent event) {
+        String identifier = event.getIdentifier();
+
+        if (!identifier.equals("minecraft:brand")) {
+            return;
+        }
+
+        ByteBuffer buffer = ByteBuffer.wrap(event.getMessage());
+        MinestomMetadataManager manager = (MinestomMetadataManager) ApolloManager.getMetadataManager();
+        manager.getClientBrands().add(ByteBufUtil.readString(buffer));
+    }
+
+}

minestom/src/main/java/com/lunarclient/apollo/listener/ApolloPlayerListener.java

@@ -69,8 +69,6 @@ private void onPlayerPluginMessage(PlayerPluginMessageEvent event) {
         Player player = event.getPlayer();
         String identifier = event.getIdentifier();
 
-        System.out.println(event.getIdentifier());
-
         switch (identifier) {
             case "minecraft:register": {
                 if (this.getChannels(event.getMessageString()).contains(ApolloManager.PLUGIN_MESSAGE_CHANNEL)) {

minestom/src/main/java/com/lunarclient/apollo/metadata/MinestomMetadata.java

@@ -0,0 +1,60 @@
+/*
+ * This file is part of Apollo, licensed under the MIT License.
+ *
+ * Copyright (c) 2023 Moonsworth
+ *
+ * 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 com.lunarclient.apollo.metadata;
+
+import com.lunarclient.apollo.stats.metadata.PlatformMetadata;
+import java.util.Map;
+import java.util.Set;
+import lombok.Builder;
+import lombok.ToString;
+
+/**
+ * Represents the minestom metadata implementation.
+ *
+ * @since 1.2.0
+ */
+@ToString
+@Builder(toBuilder = true)
+public class MinestomMetadata extends PlatformMetadata {
+
+    /**
+     * Tracks client brands sent by the players.
+     *
+     * <p>A {@link Set} of {@link String} client brands.</p>
+     *
+     * @since 1.2.0
+     */
+    private final Set<String> clientBrands;
+
+    /**
+     * Tracks the total number of resource pack status events received.
+     *
+     * <p>Represents a {@link Map} of {@link String} status enum name as a key
+     * and {@link Integer} count of how many times that status has been reported.</p>
+     *
+     * @since 1.2.0
+     */
+    private final Map<String, Integer> resourcePackStatuses;
+
+}

minestom/src/main/java/com/lunarclient/apollo/metadata/MinestomMetadataManager.java

@@ -0,0 +1,59 @@
+/*
+ * This file is part of Apollo, licensed under the MIT License.
+ *
+ * Copyright (c) 2023 Moonsworth
+ *
+ * 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 com.lunarclient.apollo.metadata;
+
+import com.lunarclient.apollo.stats.metadata.ApolloMetadataManager;
+import com.lunarclient.apollo.stats.metadata.PlatformMetadata;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+import lombok.Getter;
+
+/**
+ * The Minestom implementation of {@link ApolloMetadataManager}.
+ *
+ * @since 1.2.0
+ */
+@Getter
+public class MinestomMetadataManager implements ApolloMetadataManager {
+
+    private final Set<String> clientBrands = new HashSet<>();
+    private final Map<String, Integer> resourcePackStatuses = new HashMap<>();
+
+    @Override
+    public PlatformMetadata extract() {
+        return MinestomMetadata.builder()
+            .clientBrands(new HashSet<>(this.clientBrands))
+            .resourcePackStatuses(new HashMap<>(this.resourcePackStatuses))
+            .build();
+    }
+
+    @Override
+    public void clear() {
+        this.clientBrands.clear();
+        this.resourcePackStatuses.clear();
+    }
+
+}

minestom/src/main/java/com/lunarclient/apollo/util/ByteBufUtil.java

@@ -0,0 +1,83 @@
+/*
+ * This file is part of Apollo, licensed under the MIT License.
+ *
+ * Copyright (c) 2023 Moonsworth
+ *
+ * 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 com.lunarclient.apollo.util;
+
+import java.nio.ByteBuffer;
+import java.nio.charset.StandardCharsets;
+
+/**
+ * Represents a util for reading byte buffs.
+ *
+ * @since 1.2.0
+ */
+public final class ByteBufUtil {
+
+    /**
+     * Reads an int from the given input stream.
+     *
+     * @param in in the {@link ByteBuffer} to read from
+     * @return the read int
+     * @throws IllegalArgumentException if the value length is invalid or too large
+     * @since 1.2.0
+     */
+    public static int readVarInt(ByteBuffer in) {
+        int i = 0;
+        int j = 0;
+
+        while (true) {
+            byte b = in.get();
+            i |= (b & 0x7F) << j++ * 7;
+
+            if (j > 5) {
+                throw new RuntimeException("VarInt too big");
+            }
+
+            if ((b & 0x80) != 128) {
+                break;
+            }
+        }
+
+        return i;
+    }
+
+    /**
+     * Reads a UTF-8 encoded string from the given input stream.
+     *
+     * @param in the {@link ByteBuffer} to read from
+     * @return the decoded string
+     * @throws IllegalArgumentException if the value length is invalid or too large
+     * @since 1.2.0
+     */
+    public static String readString(ByteBuffer in) {
+        int length = ByteBufUtil.readVarInt(in);
+        byte[] bytes = new byte[length];
+        in.get(bytes);
+
+        return new String(bytes, StandardCharsets.UTF_8);
+    }
+
+    private ByteBufUtil() {
+    }
+
+}