From 48d1719745b9d0b78e7b0cdfdca86aaad972025d Mon Sep 17 00:00:00 2001 From: Aikar Date: Sat, 17 Jun 2017 16:30:44 -0400 Subject: [PATCH] Profile Lookup Events Adds a Pre Lookup Event and a Post Lookup Event so that plugins may prefill in profile data, and cache the responses from profiles that had to be looked up. --- .../event/profile/LookupProfileEvent.java | 45 ++++++++ .../event/profile/PreLookupProfileEvent.java | 107 ++++++++++++++++++ 2 files changed, 152 insertions(+) create mode 100644 paper-api/src/main/java/com/destroystokyo/paper/event/profile/LookupProfileEvent.java create mode 100644 paper-api/src/main/java/com/destroystokyo/paper/event/profile/PreLookupProfileEvent.java diff --git a/paper-api/src/main/java/com/destroystokyo/paper/event/profile/LookupProfileEvent.java b/paper-api/src/main/java/com/destroystokyo/paper/event/profile/LookupProfileEvent.java new file mode 100644 index 0000000000..9e8ae0ab13 --- /dev/null +++ b/paper-api/src/main/java/com/destroystokyo/paper/event/profile/LookupProfileEvent.java @@ -0,0 +1,45 @@ +package com.destroystokyo.paper.event.profile; + +import com.destroystokyo.paper.profile.PlayerProfile; +import org.bukkit.Bukkit; +import org.bukkit.event.Event; +import org.bukkit.event.HandlerList; +import org.jetbrains.annotations.ApiStatus; +import org.jspecify.annotations.NullMarked; + +/** + * Allows a plugin to be notified anytime AFTER a Profile has been looked up from the Mojang API + * This is an opportunity to view the response and potentially cache things. + *

+ * No guarantees are made about thread execution context for this event. If you need to know, check + * {@link Event#isAsynchronous()} + */ +@NullMarked +public class LookupProfileEvent extends Event { + + private static final HandlerList HANDLER_LIST = new HandlerList(); + + private final PlayerProfile profile; + + @ApiStatus.Internal + public LookupProfileEvent(final PlayerProfile profile) { + super(!Bukkit.isPrimaryThread()); + this.profile = profile; + } + + /** + * @return The profile that was recently looked up. This profile can be mutated + */ + public PlayerProfile getPlayerProfile() { + return this.profile; + } + + @Override + public HandlerList getHandlers() { + return HANDLER_LIST; + } + + public static HandlerList getHandlerList() { + return HANDLER_LIST; + } +} diff --git a/paper-api/src/main/java/com/destroystokyo/paper/event/profile/PreLookupProfileEvent.java b/paper-api/src/main/java/com/destroystokyo/paper/event/profile/PreLookupProfileEvent.java new file mode 100644 index 0000000000..07416cc9e2 --- /dev/null +++ b/paper-api/src/main/java/com/destroystokyo/paper/event/profile/PreLookupProfileEvent.java @@ -0,0 +1,107 @@ +package com.destroystokyo.paper.event.profile; + +import com.destroystokyo.paper.profile.ProfileProperty; +import java.util.HashSet; +import java.util.Set; +import java.util.UUID; +import org.bukkit.Bukkit; +import org.bukkit.event.Event; +import org.bukkit.event.HandlerList; +import org.jetbrains.annotations.ApiStatus; +import org.jspecify.annotations.NullMarked; +import org.jspecify.annotations.Nullable; + +/** + * Allows a plugin to intercept a Profile Lookup for a Profile by name + *

+ * At the point of event fire, the UUID and properties are unset. + *

+ * If a plugin sets the UUID, and optionally the properties, the API call to look up the profile may be skipped. + *

+ * No guarantees are made about thread execution context for this event. If you need to know, check + * {@link Event#isAsynchronous()} + */ +@NullMarked +public class PreLookupProfileEvent extends Event { + + private static final HandlerList HANDLER_LIST = new HandlerList(); + + private final String name; + + private @Nullable UUID uuid; + private Set properties = new HashSet<>(); + + @ApiStatus.Internal + public PreLookupProfileEvent(final String name) { + super(!Bukkit.isPrimaryThread()); + this.name = name; + } + + /** + * @return Name of the profile + */ + public String getName() { + return this.name; + } + + /** + * If this value is left {@code null} by the completion of the event call, then the server will + * trigger a call to the Mojang API to look up the UUID (Network Request), and subsequently, fire a + * {@link LookupProfileEvent} + * + * @return The UUID of the profile if it has already been provided by a plugin + */ + public @Nullable UUID getUUID() { + return this.uuid; + } + + /** + * Sets the UUID for this player name. This will skip the initial API call to find the players UUID. + *

+ * However, if Profile Properties are needed by the server, you must also set them or else an API call might still be made. + * + * @param uuid the UUID to set for the profile or {@code null} to reset + */ + public void setUUID(final @Nullable UUID uuid) { + this.uuid = uuid; + } + + /** + * @return The currently pending pre-populated properties. + * Any property in this Set will be automatically prefilled on this Profile + */ + public Set getProfileProperties() { + return this.properties; + } + + /** + * Clears any existing pre-populated properties and uses the supplied properties + * Any property in this Set will be automatically prefilled on this Profile + * + * @param properties The properties to add + */ + public void setProfileProperties(final Set properties) { + this.properties = new HashSet<>(); + this.properties.addAll(properties); + } + + /** + * Adds any properties currently missing to the pre-populated properties set, replacing any that already were set. + * Any property in this Set will be automatically prefilled on this Profile + * + * @param properties The properties to add + */ + public void addProfileProperties(final Set properties) { + this.properties.addAll(properties); + } + + @Override + public HandlerList getHandlers() { + return HANDLER_LIST; + } + + public static HandlerList getHandlerList() { + return HANDLER_LIST; + } + +}