path: root/patches/api/0091-Add-extended-PaperServerListPingEvent.patch

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Minecrell <minecrell@minecrell.net>
Date: Wed, 11 Oct 2017 15:55:38 +0200
Subject: [PATCH] Add extended PaperServerListPingEvent

Add a new event that extends the original ServerListPingEvent
and allows full control of the response sent to the client.

diff --git a/src/main/java/com/destroystokyo/paper/event/server/PaperServerListPingEvent.java b/src/main/java/com/destroystokyo/paper/event/server/PaperServerListPingEvent.java
new file mode 100644
index 0000000000000000000000000000000000000000..5e2099e79e43d0da118eaaa0eaaa832c4577b9da
--- /dev/null
+++ b/src/main/java/com/destroystokyo/paper/event/server/PaperServerListPingEvent.java
@@ -0,0 +1,499 @@
+package com.destroystokyo.paper.event.server;
+
+import static java.util.Objects.requireNonNull;
+
+import com.destroystokyo.paper.network.StatusClient;
+import com.destroystokyo.paper.profile.PlayerProfile;
+import com.destroystokyo.paper.profile.ProfileProperty;
+import com.google.common.base.Preconditions;
+import io.papermc.paper.util.TransformingRandomAccessList;
+import java.util.Collection;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.CompletableFuture;
+import org.bukkit.Bukkit;
+import org.bukkit.entity.Player;
+import org.bukkit.event.Cancellable;
+import org.bukkit.event.server.ServerListPingEvent;
+import org.bukkit.profile.PlayerTextures;
+import org.bukkit.util.CachedServerIcon;
+
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+import java.util.NoSuchElementException;
+import java.util.UUID;
+
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Extended version of {@link ServerListPingEvent} that allows full control
+ * of the response sent to the client.
+ */
+public class PaperServerListPingEvent extends ServerListPingEvent implements Cancellable {
+
+    @NotNull private final StatusClient client;
+
+    private int numPlayers;
+    private boolean hidePlayers;
+    @NotNull private final List<ListedPlayerInfo> listedPlayers = new ArrayList<>();
+    @NotNull private final TransformingRandomAccessList<ListedPlayerInfo, PlayerProfile> playerSample = new TransformingRandomAccessList<>(
+        listedPlayers,
+        info -> new UncheckedPlayerProfile(info.name(), info.id()),
+        profile -> new ListedPlayerInfo(profile.getName(), profile.getId())
+    );
+
+    @NotNull private String version;
+    private int protocolVersion;
+
+    @Nullable private CachedServerIcon favicon;
+
+    private boolean cancelled;
+
+    private boolean originalPlayerCount = true;
+    private Object[] players;
+
+    @Deprecated
+    @ApiStatus.Internal
+    public PaperServerListPingEvent(@NotNull StatusClient client, @NotNull String motd, int numPlayers, int maxPlayers,
+            @NotNull String version, int protocolVersion, @Nullable CachedServerIcon favicon) {
+        super("", client.getAddress().getAddress(), motd, numPlayers, maxPlayers);
+        this.client = client;
+        this.numPlayers = numPlayers;
+        this.version = version;
+        this.protocolVersion = protocolVersion;
+        setServerIcon(favicon);
+    }
+
+    @ApiStatus.Internal
+    public PaperServerListPingEvent(@NotNull StatusClient client, @NotNull net.kyori.adventure.text.Component motd, int numPlayers, int maxPlayers,
+                                    @NotNull String version, int protocolVersion, @Nullable CachedServerIcon favicon) {
+        super("", client.getAddress().getAddress(), motd, numPlayers, maxPlayers);
+        this.client = client;
+        this.numPlayers = numPlayers;
+        this.version = version;
+        this.protocolVersion = protocolVersion;
+        setServerIcon(favicon);
+    }
+
+    /**
+     * Returns the {@link StatusClient} pinging the server.
+     *
+     * @return The client
+     */
+    @NotNull
+    public StatusClient getClient() {
+        return this.client;
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * <p>Returns {@code -1} if players are hidden using
+     * {@link #shouldHidePlayers()}.</p>
+     */
+    @Override
+    public int getNumPlayers() {
+        if (this.hidePlayers) {
+            return -1;
+        }
+
+        return this.numPlayers;
+    }
+
+    /**
+     * Sets the number of players displayed in the server list.
+     * <p>
+     * Note that this won't have any effect if {@link #shouldHidePlayers()}
+     * is enabled.
+     *
+     * @param numPlayers The number of online players
+     */
+    public void setNumPlayers(int numPlayers) {
+        if (this.numPlayers != numPlayers) {
+            this.numPlayers = numPlayers;
+            this.originalPlayerCount = false;
+        }
+    }
+
+    /**
+     * {@inheritDoc}
+     * <p>
+     * Returns {@code -1} if players are hidden using
+     * {@link #shouldHidePlayers()}.
+     */
+    @Override
+    public int getMaxPlayers() {
+        if (this.hidePlayers) {
+            return -1;
+        }
+
+        return super.getMaxPlayers();
+    }
+
+    /**
+     * Returns whether all player related information is hidden in the server
+     * list. This will cause {@link #getNumPlayers()}, {@link #getMaxPlayers()}
+     * and {@link #getPlayerSample()} to be skipped in the response.
+     * <p>
+     * The Vanilla Minecraft client will display the player count as {@code ???}
+     * when this option is enabled.
+     *
+     * @return {@code true} if the player count is hidden
+     */
+    public boolean shouldHidePlayers() {
+        return this.hidePlayers;
+    }
+
+    /**
+     * Sets whether all player related information is hidden in the server
+     * list. This will cause {@link #getNumPlayers()}, {@link #getMaxPlayers()}
+     * and {@link #getPlayerSample()} to be skipped in the response.
+     * <p>
+     * The Vanilla Minecraft client will display the player count as {@code ???}
+     * when this option is enabled.
+     *
+     * @param hidePlayers {@code true} if the player count should be hidden
+     */
+    public void setHidePlayers(boolean hidePlayers) {
+        this.hidePlayers = hidePlayers;
+    }
+
+    /**
+     * Returns a mutable list of {@link ListedPlayerInfo} that will be displayed
+     * as online players on the client.
+     * <p>
+     * The Vanilla Minecraft client will display them when hovering the
+     * player count with the mouse.
+     *
+     * @return The mutable player sample list
+     */
+    @NotNull
+    public List<ListedPlayerInfo> getListedPlayers() {
+        return this.listedPlayers;
+    }
+
+    /**
+     * Returns a mutable list of {@link PlayerProfile} that will be displayed
+     * as online players on the client.
+     * <p>
+     * The Vanilla Minecraft client will display them when hovering the
+     * player count with the mouse.
+     *
+     * @return The mutable player sample list
+     * @deprecated Use {@link #getListedPlayers()}, as this does not contain real player profiles
+     */
+    @NotNull
+    @Deprecated(forRemoval = true)
+    public List<PlayerProfile> getPlayerSample() {
+        return this.playerSample;
+    }
+
+    /**
+     * Returns the version that will be sent as server version on the client.
+     *
+     * @return The server version
+     */
+    @NotNull
+    public String getVersion() {
+        return this.version;
+    }
+
+    /**
+     * Sets the version that will be sent as server version to the client.
+     *
+     * @param version The server version
+     */
+    public void setVersion(@NotNull String version) {
+        this.version = requireNonNull(version, "version");
+    }
+
+    /**
+     * Returns the protocol version that will be sent as the protocol version
+     * of the server to the client.
+     *
+     * @return The protocol version of the server, or {@code -1} if the server
+     * has not finished initialization yet
+     */
+    public int getProtocolVersion() {
+        return this.protocolVersion;
+    }
+
+    /**
+     * Sets the protocol version that will be sent as the protocol version
+     * of the server to the client.
+     *
+     * @param protocolVersion The protocol version of the server
+     */
+    public void setProtocolVersion(int protocolVersion) {
+        this.protocolVersion = protocolVersion;
+    }
+
+    /**
+     * Gets the server icon sent to the client.
+     *
+     * @return The icon to send to the client, or {@code null} for none
+     */
+    @Nullable
+    public CachedServerIcon getServerIcon() {
+        return this.favicon;
+    }
+
+    /**
+     * Sets the server icon sent to the client.
+     *
+     * @param icon The icon to send to the client, or {@code null} for none
+     */
+    @Override
+    public void setServerIcon(@Nullable CachedServerIcon icon) {
+        if (icon != null && icon.isEmpty()) {
+            // Represent empty icons as null
+            icon = null;
+        }
+
+        this.favicon = icon;
+    }
+
+    /**
+     * {@inheritDoc}
+     * <p>
+     * Cancelling this event will cause the connection to be closed immediately,
+     * without sending a response to the client.
+     */
+    @Override
+    public boolean isCancelled() {
+        return this.cancelled;
+    }
+
+    /**
+     * {@inheritDoc}
+     * <p>
+     * Cancelling this event will cause the connection to be closed immediately,
+     * without sending a response to the client.
+     */
+    @Override
+    public void setCancelled(boolean cancel) {
+        this.cancelled = cancel;
+    }
+
+    /**
+     * {@inheritDoc}
+     * <p>
+     * <b>Note:</b> For compatibility reasons, this method will return all
+     * online players, not just the ones referenced in {@link #getPlayerSample()}.
+     * Removing a player will:
+     *
+     * <ul>
+     *     <li>Decrement the online player count (if and only if) the player
+     *     count wasn't changed by another plugin before.</li>
+     *     <li>Remove all entries from {@link #getPlayerSample()} that refer to
+     *     the removed player (based on their {@link UUID}).</li>
+     * </ul>
+     */
+    @NotNull
+    @Override
+    public Iterator<Player> iterator() {
+        if (this.players == null) {
+            this.players = getOnlinePlayers();
+        }
+
+        return new PlayerIterator();
+    }
+
+    @NotNull
+    protected Object[] getOnlinePlayers() {
+        return Bukkit.getOnlinePlayers().toArray();
+    }
+
+    @NotNull
+    protected Player getBukkitPlayer(@NotNull Object player) {
+        return (Player) player;
+    }
+
+    @ApiStatus.Internal
+    private final class PlayerIterator implements Iterator<Player> {
+
+        private int next;
+        private int current;
+        @Nullable private Player player;
+
+        @Override
+        public boolean hasNext() {
+            for (; this.next < players.length; this.next++) {
+                if (players[this.next] != null) {
+                    return true;
+                }
+            }
+
+            return false;
+        }
+
+        @NotNull
+        @Override
+        public Player next() {
+            if (!hasNext()) {
+                this.player = null;
+                throw new NoSuchElementException();
+            }
+
+            this.current = this.next++;
+            return this.player = getBukkitPlayer(players[this.current]);
+        }
+
+        @Override
+        public void remove() {
+            if (this.player == null) {
+                throw new IllegalStateException();
+            }
+
+            UUID uniqueId = this.player.getUniqueId();
+            this.player = null;
+
+            // Remove player from iterator
+            players[this.current] = null;
+
+            // Remove player from sample
+            getPlayerSample().removeIf(p -> uniqueId.equals(p.getId()));
+
+            // Decrement player count
+            if (originalPlayerCount) {
+                numPlayers--;
+            }
+        }
+    }
+
+    /**
+     * Represents a player that will be displayed in the player sample of the server list.
+     *
+     * @param name name of the listed player
+     * @param id   UUID of the listed player
+     */
+    public record ListedPlayerInfo(@NotNull String name, @NotNull UUID id) {
+    }
+
+    private static final class UncheckedPlayerProfile implements PlayerProfile {
+        private String name;
+        private UUID uuid;
+
+        public UncheckedPlayerProfile(final @NotNull String name, final @NotNull UUID uuid) {
+            Preconditions.checkNotNull(name, "name cannot be null");
+            Preconditions.checkNotNull(uuid, "uuid cannot be null");
+            this.name = name;
+            this.uuid = uuid;
+        }
+
+        @Override
+        public @Nullable UUID getUniqueId() {
+            return uuid;
+        }
+
+        @Override
+        public @Nullable String getName() {
+            return name;
+        }
+
+        @Override
+        public @NotNull String setName(@Nullable final String name) {
+            Preconditions.checkNotNull(name, "name cannot be null");
+            return this.name = name;
+        }
+
+        @Override
+        public @Nullable UUID getId() {
+            return uuid;
+        }
+
+        @Override
+        public @Nullable UUID setId(@Nullable final UUID uuid) {
+            Preconditions.checkNotNull(uuid, "uuid cannot be null");
+            return this.uuid = uuid;
+        }
+
+        @Override
+        public @NotNull PlayerTextures getTextures() {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public void setTextures(@Nullable final PlayerTextures textures) {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public @NotNull Set<ProfileProperty> getProperties() {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public boolean hasProperty(@Nullable final String property) {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public void setProperty(@NotNull final ProfileProperty property) {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public void setProperties(@NotNull final Collection<ProfileProperty> properties) {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public boolean removeProperty(@Nullable final String property) {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public void clearProperties() {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public boolean isComplete() {
+            return false;
+        }
+
+        @Override
+        public boolean completeFromCache() {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public boolean completeFromCache(final boolean onlineMode) {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public boolean completeFromCache(final boolean lookupUUID, final boolean onlineMode) {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public boolean complete(final boolean textures) {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public boolean complete(final boolean textures, final boolean onlineMode) {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public @NotNull CompletableFuture<PlayerProfile> update() {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public org.bukkit.profile.@NotNull PlayerProfile clone() {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public @NotNull Map<String, Object> serialize() {
+            throw new UnsupportedOperationException();
+        }
+    }
+}
diff --git a/src/main/java/com/destroystokyo/paper/network/StatusClient.java b/src/main/java/com/destroystokyo/paper/network/StatusClient.java
new file mode 100644
index 0000000000000000000000000000000000000000..517d15238ed117f38bbd39f570874014cecf7bb5
--- /dev/null
+++ b/src/main/java/com/destroystokyo/paper/network/StatusClient.java
@@ -0,0 +1,13 @@
+package com.destroystokyo.paper.network;
+
+import com.destroystokyo.paper.event.server.PaperServerListPingEvent;
+
+/**
+ * Represents a client requesting the current status from the server (e.g. from
+ * the server list).
+ *
+ * @see PaperServerListPingEvent
+ */
+public interface StatusClient extends NetworkClient {
+
+}
diff --git a/src/main/java/org/bukkit/event/server/ServerListPingEvent.java b/src/main/java/org/bukkit/event/server/ServerListPingEvent.java
index 72ebc29db42d08d1d0361dba462fc8a573fbf918..1b60bab5d93bc909077e73fb236ea0b3b46a969e 100644
--- a/src/main/java/org/bukkit/event/server/ServerListPingEvent.java
+++ b/src/main/java/org/bukkit/event/server/ServerListPingEvent.java
@@ -248,9 +248,11 @@ public class ServerListPingEvent extends ServerEvent implements Iterable<Player>
      *
      * @throws UnsupportedOperationException if the caller of this event does
      *     not support removing players
+     * @deprecated the Iterable interface will be removed at some point
      */
     @NotNull
     @Override
+    @Deprecated(forRemoval = true)
     public Iterator<Player> iterator() throws UnsupportedOperationException {
         throw new UnsupportedOperationException();
     }
diff --git a/src/main/java/org/bukkit/util/CachedServerIcon.java b/src/main/java/org/bukkit/util/CachedServerIcon.java
index 9a7768d41270714d4a1c89b4dcb436cc66f57545..b74b21a1ac7798e847b6d34ff45026e1c9cfed14 100644
--- a/src/main/java/org/bukkit/util/CachedServerIcon.java
+++ b/src/main/java/org/bukkit/util/CachedServerIcon.java
@@ -18,4 +18,9 @@ public interface CachedServerIcon {
     @Nullable
     public String getData(); // Paper
 
+    // Paper start
+    default boolean isEmpty() {
+        return getData() == null;
+    }
+    // Paper end
 }