Clean up methods names and documentation

2024-05-21 14:41:41 +02:00
parent e9643ee3e2
commit be2ec1e5a8
26 changed files with 97 additions and 109 deletions
@@ -47,7 +47,6 @@ public class BukkitLoginSession extends LoginSession {
    private final ClientPublicKey clientPublicKey;

    private boolean verified;
-
    private SkinProperty skinProperty;

    public BukkitLoginSession(String username, byte[] verifyToken, ClientPublicKey publicKey, boolean registered,
@@ -109,7 +108,7 @@ public class BukkitLoginSession extends LoginSession {
     *
     * @param verified whether the player has valid session
     */
-    public synchronized void setVerified(boolean verified) {
+    public synchronized void setVerifiedPremium(boolean verified) {
        this.verified = verified;
    }

@@ -118,7 +117,7 @@ public class BukkitLoginSession extends LoginSession {
     *
     * @return whether the player has a valid session
     */
-    public synchronized boolean isVerified() {
+    public synchronized boolean isVerifiedPremium() {
        return verified;
    }
 }
@@ -95,7 +95,7 @@ public class CrackedCommand extends ToggleCommand {
        }

        //existing player is already cracked
-        if (profile.isSaved() && !profile.isOnlinemodePreferred()) {
+        if (profile.isExistingPlayer() && !profile.isOnlinemodePreferred()) {
            plugin.getCore().sendLocaleMessage("not-premium-other", sender);
        } else {
            plugin.getCore().sendLocaleMessage("remove-premium", sender);
@@ -45,9 +45,9 @@ import java.lang.reflect.Field;
 * <p>
 * Project page:
 * <p>
- * Bukkit: <a href="https://dev.bukkit.org/bukkit-plugins/authme-reloaded/">...</a>
+ * <a href="https://dev.bukkit.org/bukkit-plugins/authme-reloaded/">Bukkit</a>
 * <p>
- * Spigot: <a href="https://www.spigotmc.org/resources/authme-reloaded.6269/">...</a>
+ * <a href="https://www.spigotmc.org/resources/authme-reloaded.6269/">Spigot</a>
 */
 public class AuthMeHook implements AuthPlugin<Player>, Listener {

@@ -76,7 +76,7 @@ public class AuthMeHook implements AuthPlugin<Player>, Listener {
        Player player = restoreSessionEvent.getPlayer();

        BukkitLoginSession session = plugin.getSession(player.spigot().getRawAddress());
-        if (session != null && session.isVerified()) {
+        if (session != null && session.isVerifiedPremium()) {
            restoreSessionEvent.setCancelled(true);
        }
    }
@@ -46,7 +46,7 @@ import java.util.concurrent.Future;
 * <p>
 * Project page:
 * <p>
- * Bukkit: <a href="https://dev.bukkit.org/server-mods/crazylogin/">...</a>
+ * <a href="https://dev.bukkit.org/server-mods/crazylogin/">Bukkit</a>
 */
 public class CrazyLoginHook implements AuthPlugin<Player> {

@@ -39,9 +39,9 @@ import org.bukkit.entity.Player;
 * <p>
 * Project page:
 * <p>
- * Bukkit: <a href="https://dev.bukkit.org/bukkit-plugins/loginsecurity/">...</a>
+ * <a href="https://dev.bukkit.org/bukkit-plugins/loginsecurity/">Bukkit</a>
 * <p>
- * Spigot: <a href="https://www.spigotmc.org/resources/loginsecurity.19362/">...</a>
+ * <a href="https://www.spigotmc.org/resources/loginsecurity.19362/">Spigot</a>
 */
 public class LoginSecurityHook implements AuthPlugin<Player> {

@@ -38,9 +38,9 @@ import java.util.concurrent.Future;
 /**
 * Project page:
 * <p>
- * Bukkit: <a href="https://dev.bukkit.org/bukkit-plugins/ultraauth-aa/">...</a>
+ * <a href="https://dev.bukkit.org/bukkit-plugins/ultraauth-aa/">Bukkit</a>
 * <p>
- * Spigot: <a href="https://www.spigotmc.org/resources/ultraauth.17044/">...</a>
+ * <a href="https://www.spigotmc.org/resources/ultraauth.17044/">Spigot</a>
 */
 public class UltraAuthHook implements AuthPlugin<Player> {

@@ -40,7 +40,7 @@ import java.util.concurrent.Future;
 * <p>
 * Project page:
 * <p>
- * Bukkit: <a href="https://dev.bukkit.org/bukkit-plugins/xauth/">...</a>
+ * <a href="https://dev.bukkit.org/bukkit-plugins/xauth/">Bukkit</a>
 */
 public class XAuthHook implements AuthPlugin<Player> {

@@ -123,7 +123,7 @@ public class BungeeListener implements PluginMessageListener {
    }

    private void startLoginTaskIfReady(Player player, BukkitLoginSession session) {
-        session.setVerified(true);
+        session.setVerifiedPremium(true);
        plugin.putSession(player.spigot().getRawAddress(), session);

        // only start a new login task if the join event fired earlier. This event then didn't
@@ -52,6 +52,7 @@ import io.netty.util.AttributeKey;
 import lombok.val;
 import org.bukkit.entity.Player;
 import org.geysermc.floodgate.api.player.FloodgatePlayer;
+import org.jetbrains.annotations.NotNull;

 import javax.crypto.BadPaddingException;
 import javax.crypto.IllegalBlockSizeException;
@@ -114,22 +115,10 @@ public class ProtocolLibListener extends PacketAdapter {
        }

        Player sender = packetEvent.getPlayer();
-        PacketType packetType = packetEvent.getPacketType();
+        PacketType packetType = getOverriddenType(packetEvent.getPacketType());

        plugin.getLog().info("New packet {} from {}", packetType, sender);
        try {
-            if (packetType.isDynamic()) {
-                String vanillaName = packetType.getPacketClass().getName();
-                plugin.getLog().info("Overriding packet type for unregistered packet type to fix ProtocolLib bug");
-                if (vanillaName.endsWith("ServerboundHelloPacket")) {
-                    packetType = START;
-                }
-
-                if (vanillaName.endsWith("ServerboundKeyPacket")) {
-                    packetType = ENCRYPTION_BEGIN;
-                }
-            }
-
            if (packetType == START) {
                if (plugin.getFloodgateService() != null) {
                    boolean success = processFloodgateTasks(packetEvent);
@@ -169,6 +158,22 @@ public class ProtocolLibListener extends PacketAdapter {
        }
    }

+    private @NotNull PacketType getOverriddenType(PacketType packetType) {
+        if (packetType.isDynamic()) {
+            String vanillaName = packetType.getPacketClass().getName();
+            plugin.getLog().info("Overriding packet type for unregistered packet type to fix ProtocolLib bug");
+            if (vanillaName.endsWith("ServerboundHelloPacket")) {
+                return START;
+            }
+
+            if (vanillaName.endsWith("ServerboundKeyPacket")) {
+                return ENCRYPTION_BEGIN;
+            }
+        }
+
+        return packetType;
+    }
+
    private void onEncryptionBegin(PacketEvent packetEvent, Player sender) {
        byte[] sharedSecret = packetEvent.getPacket().getByteArrays().read(0);

@@ -240,7 +245,7 @@ public class ProtocolLibListener extends PacketAdapter {
        PacketContainer packet = packetEvent.getPacket();
        Optional<ClientPublicKey> clientKey;
        if (new MinecraftVersion(1, 19, 3).atOrAbove()) {
-            // public key sent separate
+            // public key is sent separate
            clientKey = Optional.empty();
        } else {
            val profileKey = packet.getOptionals(BukkitConverters.getWrappedPublicKeyDataConverter())
@@ -51,7 +51,6 @@ class ProtocolLibLoginSource implements LoginSource {
    private final ClientPublicKey clientKey;
    private final PublicKey publicKey;

-    private final String serverId = "";
    private byte[] verifyToken;

    ProtocolLibLoginSource(Player player, Random random, PublicKey serverPublicKey, ClientPublicKey clientKey) {
@@ -72,7 +71,7 @@ class ProtocolLibLoginSource implements LoginSource {
         */
        PacketContainer newPacket = new PacketContainer(ENCRYPTION_BEGIN);

-        newPacket.getStrings().write(0, serverId);
+        newPacket.getStrings().write(0, "");
        StructureModifier<PublicKey> keyModifier = newPacket.getSpecificModifier(PublicKey.class);
        int verifyField = 0;
        if (keyModifier.getFields().isEmpty()) {
@@ -117,10 +116,6 @@ class ProtocolLibLoginSource implements LoginSource {
        return clientKey;
    }

-    public String getServerId() {
-        return serverId;
-    }
-
    public byte[] getVerifyToken() {
        return verifyToken.clone();
    }
@@ -130,7 +125,6 @@ class ProtocolLibLoginSource implements LoginSource {
        return this.getClass().getSimpleName() + '{'
            + "player=" + player
            + ", random=" + random
-            + ", serverId='" + serverId + '\''
            + ", verifyToken=" + Arrays.toString(verifyToken)
            + '}';
    }
@@ -195,7 +195,7 @@ public class VerifyResponseTask implements Runnable {

        session.setVerifiedUsername(realUsername);
        session.setUuid(verification.getId());
-        session.setVerified(true);
+        session.setVerifiedPremium(true);

        setPremiumUUID(session.getUuid());
        receiveFakeStartPacket(realUsername, session.getClientPublicKey(), session.getUuid());
@@ -101,7 +101,7 @@ public class ProtocolSupportListener extends JoinManagement<Player, CommandSende
        BukkitLoginSession session = plugin.getSession(address);

        if (session != null && profileCompleteEvent.getConnection().getProfile().isOnlineMode()) {
-            session.setVerified(true);
+            session.setVerifiedPremium(true);

            if (!plugin.getConfig().getBoolean("premiumUuid")) {
                String username = Optional.ofNullable(profileCompleteEvent.getForcedName())
@@ -49,7 +49,7 @@ public class FloodgateAuthTask extends FloodgateManagement<Player, CommandSender
        BukkitLoginSession session = new BukkitLoginSession(player.getName(), isRegistered, profile);

        // enable auto login based on the value of 'autoLoginFloodgate' in config.yml
-        session.setVerified(isAutoAuthAllowed(autoLoginFloodgate));
+        session.setVerifiedPremium(isAutoAuthAllowed(autoLoginFloodgate));

        // run login task
        Runnable forceLoginTask = new ForceLoginTask(core.getPlugin().getCore(), player, session);
@@ -103,6 +103,6 @@ public class ForceLoginTask extends ForceLoginManagement<Player, CommandSender,

    @Override
    public boolean isOnlineMode() {
-        return session.isVerified();
+        return session.isVerifiedPremium();
    }
 }