geforkt von Mirrors/Paper
3aae7ef01a
Upstream has released updates that appear to apply and compile correctly. This update has not been tested by PaperMC and as with ANY update, please do your own testing Bukkit Changes: 214b9f14 SPIGOT-6605: Add method to access value of enforce-whitelist CraftBukkit Changes: b121d3b9 SPIGOT-6605: Add method to access value of enforce-whitelist
352 Zeilen
12 KiB
Diff
352 Zeilen
12 KiB
Diff
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
|
From: Aikar <aikar@aikar.co>
|
|
Date: Mon, 15 Jan 2018 21:46:46 -0500
|
|
Subject: [PATCH] Basic PlayerProfile API
|
|
|
|
Provides basic elements of a PlayerProfile to be used by future API/events
|
|
|
|
diff --git a/src/main/java/com/destroystokyo/paper/profile/PlayerProfile.java b/src/main/java/com/destroystokyo/paper/profile/PlayerProfile.java
|
|
new file mode 100644
|
|
index 0000000000000000000000000000000000000000..2ef9a7bd55e2c9cf8cb20d5f77282676ae11181f
|
|
--- /dev/null
|
|
+++ b/src/main/java/com/destroystokyo/paper/profile/PlayerProfile.java
|
|
@@ -0,0 +1,177 @@
|
|
+package com.destroystokyo.paper.profile;
|
|
+
|
|
+import java.util.Collection;
|
|
+import java.util.Set;
|
|
+import java.util.UUID;
|
|
+import org.jetbrains.annotations.NotNull;
|
|
+import org.jetbrains.annotations.Nullable;
|
|
+
|
|
+/**
|
|
+ * Represents a players profile for the game, such as UUID, Name, and textures.
|
|
+ */
|
|
+public interface PlayerProfile {
|
|
+
|
|
+ /**
|
|
+ * @return The players name, if set
|
|
+ */
|
|
+ @Nullable
|
|
+ String getName();
|
|
+
|
|
+ /**
|
|
+ * Sets this profiles Name
|
|
+ *
|
|
+ * @param name The new Name
|
|
+ * @return The previous Name
|
|
+ */
|
|
+ @NotNull
|
|
+ String setName(@Nullable String name);
|
|
+
|
|
+ /**
|
|
+ * @return The players unique identifier, if set
|
|
+ */
|
|
+ @Nullable UUID getId();
|
|
+
|
|
+ /**
|
|
+ * Sets this profiles UUID
|
|
+ *
|
|
+ * @param uuid The new UUID
|
|
+ * @return The previous UUID
|
|
+ */
|
|
+ @Nullable
|
|
+ UUID setId(@Nullable UUID uuid);
|
|
+
|
|
+ /**
|
|
+ * @return A Mutable set of this players properties, such as textures.
|
|
+ * Values specified here are subject to implementation details.
|
|
+ */
|
|
+ @NotNull Set<ProfileProperty> getProperties();
|
|
+
|
|
+ /**
|
|
+ * Check if the Profile has the specified property
|
|
+ * @param property Property name to check
|
|
+ * @return If the property is set
|
|
+ */
|
|
+ boolean hasProperty(@Nullable String property);
|
|
+
|
|
+ /**
|
|
+ * Sets a property. If the property already exists, the previous one will be replaced
|
|
+ * @param property Property to set.
|
|
+ */
|
|
+ void setProperty(@NotNull ProfileProperty property);
|
|
+
|
|
+ /**
|
|
+ * Sets multiple properties. If any of the set properties already exist, it will be replaced
|
|
+ * @param properties The properties to set
|
|
+ */
|
|
+ void setProperties(@NotNull Collection<ProfileProperty> properties);
|
|
+
|
|
+ /**
|
|
+ * Removes a specific property from this profile
|
|
+ * @param property The property to remove
|
|
+ * @return If a property was removed
|
|
+ */
|
|
+ boolean removeProperty(@Nullable String property);
|
|
+
|
|
+ /**
|
|
+ * Removes a specific property from this profile
|
|
+ * @param property The property to remove
|
|
+ * @return If a property was removed
|
|
+ */
|
|
+ default boolean removeProperty(@NotNull ProfileProperty property) {
|
|
+ return removeProperty(property.getName());
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Removes all properties in the collection
|
|
+ * @param properties The properties to remove
|
|
+ * @return If any property was removed
|
|
+ */
|
|
+ default boolean removeProperties(@NotNull Collection<ProfileProperty> properties) {
|
|
+ boolean removed = false;
|
|
+ for (ProfileProperty property : properties) {
|
|
+ if (removeProperty(property)) {
|
|
+ removed = true;
|
|
+ }
|
|
+ }
|
|
+ return removed;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Clears all properties on this profile
|
|
+ */
|
|
+ void clearProperties();
|
|
+
|
|
+ /**
|
|
+ * @return If the profile is now complete (has UUID and Name)
|
|
+ */
|
|
+ boolean isComplete();
|
|
+
|
|
+ /**
|
|
+ * Like {@link #complete(boolean)} but will try only from cache, and not make network calls
|
|
+ * Does not account for textures.
|
|
+ *
|
|
+ * @return If the profile is now complete (has UUID and Name)
|
|
+ */
|
|
+ boolean completeFromCache();
|
|
+
|
|
+ /**
|
|
+ * Like {@link #complete(boolean)} but will try only from cache, and not make network calls
|
|
+ * Does not account for textures.
|
|
+ *
|
|
+ * @param onlineMode Treat this as online mode or not
|
|
+ * @return If the profile is now complete (has UUID and Name)
|
|
+ */
|
|
+ boolean completeFromCache(boolean onlineMode);
|
|
+
|
|
+ /**
|
|
+ * Like {@link #complete(boolean)} but will try only from cache, and not make network calls
|
|
+ * Does not account for textures.
|
|
+ *
|
|
+ * @param lookupUUID If only name is supplied, should we do a UUID lookup
|
|
+ * @param onlineMode Treat this as online mode or not
|
|
+ * @return If the profile is now complete (has UUID and Name)
|
|
+ */
|
|
+ boolean completeFromCache(boolean lookupUUID, boolean onlineMode);
|
|
+
|
|
+ /**
|
|
+ * If this profile is not complete, then make the API call to complete it.
|
|
+ * This is a blocking operation and should be done asynchronously.
|
|
+ *
|
|
+ * This will also complete textures. If you do not want to load textures, use {{@link #complete(boolean)}}
|
|
+ * @return If the profile is now complete (has UUID and Name) (if you get rate limited, this operation may fail)
|
|
+ */
|
|
+ default boolean complete() {
|
|
+ return complete(true);
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * If this profile is not complete, then make the API call to complete it.
|
|
+ * This is a blocking operation and should be done asynchronously.
|
|
+ *
|
|
+ * Optionally will also fill textures.
|
|
+ *
|
|
+ * Online mode will be automatically determined
|
|
+ * @param textures controls if we should fill the profile with texture properties
|
|
+ * @return If the profile is now complete (has UUID and Name) (if you get rate limited, this operation may fail)
|
|
+ */
|
|
+ boolean complete(boolean textures);
|
|
+
|
|
+ /**
|
|
+ * If this profile is not complete, then make the API call to complete it.
|
|
+ * This is a blocking operation and should be done asynchronously.
|
|
+ *
|
|
+ * Optionally will also fill textures.
|
|
+ * @param textures controls if we should fill the profile with texture properties
|
|
+ * @param onlineMode Treat this server as online mode or not
|
|
+ * @return If the profile is now complete (has UUID and Name) (if you get rate limited, this operation may fail)
|
|
+ */
|
|
+ boolean complete(boolean textures, boolean onlineMode);
|
|
+
|
|
+ /**
|
|
+ * Whether or not this Profile has textures associated to it
|
|
+ * @return If has a textures property
|
|
+ */
|
|
+ default boolean hasTextures() {
|
|
+ return hasProperty("textures");
|
|
+ }
|
|
+}
|
|
diff --git a/src/main/java/com/destroystokyo/paper/profile/ProfileProperty.java b/src/main/java/com/destroystokyo/paper/profile/ProfileProperty.java
|
|
new file mode 100644
|
|
index 0000000000000000000000000000000000000000..7b3b6ef533d32169fbeca389bd61cfc6b0e0faee
|
|
--- /dev/null
|
|
+++ b/src/main/java/com/destroystokyo/paper/profile/ProfileProperty.java
|
|
@@ -0,0 +1,72 @@
|
|
+package com.destroystokyo.paper.profile;
|
|
+
|
|
+import com.google.common.base.Preconditions;
|
|
+
|
|
+import java.util.Objects;
|
|
+import org.jetbrains.annotations.NotNull;
|
|
+import org.jetbrains.annotations.Nullable;
|
|
+
|
|
+/**
|
|
+ * Represents a property on a {@link PlayerProfile}
|
|
+ */
|
|
+public class ProfileProperty {
|
|
+ private final String name;
|
|
+ private final String value;
|
|
+ private final String signature;
|
|
+
|
|
+ public ProfileProperty(@NotNull String name, @NotNull String value) {
|
|
+ this(name, value, null);
|
|
+ }
|
|
+
|
|
+ public ProfileProperty(@NotNull String name, @NotNull String value, @Nullable String signature) {
|
|
+ this.name = Preconditions.checkNotNull(name, "ProfileProperty name can not be null");
|
|
+ this.value = Preconditions.checkNotNull(value, "ProfileProperty value can not be null");
|
|
+ this.signature = signature;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * @return The property name, ie "textures"
|
|
+ */
|
|
+ @NotNull
|
|
+ public String getName() {
|
|
+ return name;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * @return The property value, likely to be base64 encoded
|
|
+ */
|
|
+ @NotNull
|
|
+ public String getValue() {
|
|
+ return value;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * @return A signature from Mojang for signed properties
|
|
+ */
|
|
+ @Nullable
|
|
+ public String getSignature() {
|
|
+ return signature;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * @return If this property has a signature or not
|
|
+ */
|
|
+ public boolean isSigned() {
|
|
+ return this.signature != null;
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public boolean equals(Object o) {
|
|
+ if (this == o) return true;
|
|
+ if (o == null || getClass() != o.getClass()) return false;
|
|
+ ProfileProperty that = (ProfileProperty) o;
|
|
+ return Objects.equals(name, that.name) &&
|
|
+ Objects.equals(value, that.value) &&
|
|
+ Objects.equals(signature, that.signature);
|
|
+ }
|
|
+
|
|
+ @Override
|
|
+ public int hashCode() {
|
|
+ return Objects.hash(name);
|
|
+ }
|
|
+}
|
|
diff --git a/src/main/java/org/bukkit/Bukkit.java b/src/main/java/org/bukkit/Bukkit.java
|
|
index 35dbed257032f797484c2e7db49339c0325246f6..baf0a417970b95d5d9c057f252f4d37d13ad8ddb 100644
|
|
--- a/src/main/java/org/bukkit/Bukkit.java
|
|
+++ b/src/main/java/org/bukkit/Bukkit.java
|
|
@@ -1802,6 +1802,40 @@ public final class Bukkit {
|
|
public static boolean suggestPlayerNamesWhenNullTabCompletions() {
|
|
return server.suggestPlayerNamesWhenNullTabCompletions();
|
|
}
|
|
+
|
|
+ /**
|
|
+ * Creates a PlayerProfile for the specified uuid, with name as null
|
|
+ * @param uuid UUID to create profile for
|
|
+ * @return A PlayerProfile object
|
|
+ */
|
|
+ @NotNull
|
|
+ public static com.destroystokyo.paper.profile.PlayerProfile createProfile(@NotNull UUID uuid) {
|
|
+ return server.createProfile(uuid);
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Creates a PlayerProfile for the specified name, with UUID as null
|
|
+ * @param name Name to create profile for
|
|
+ * @return A PlayerProfile object
|
|
+ */
|
|
+ @NotNull
|
|
+ public static com.destroystokyo.paper.profile.PlayerProfile createProfile(@NotNull String name) {
|
|
+ return server.createProfile(name);
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Creates a PlayerProfile for the specified name/uuid
|
|
+ *
|
|
+ * Both UUID and Name can not be null at same time. One must be supplied.
|
|
+ *
|
|
+ * @param uuid UUID to create profile for
|
|
+ * @param name Name to create profile for
|
|
+ * @return A PlayerProfile object
|
|
+ */
|
|
+ @NotNull
|
|
+ public static com.destroystokyo.paper.profile.PlayerProfile createProfile(@Nullable UUID uuid, @Nullable String name) {
|
|
+ return server.createProfile(uuid, name);
|
|
+ }
|
|
// Paper end
|
|
|
|
@NotNull
|
|
diff --git a/src/main/java/org/bukkit/Server.java b/src/main/java/org/bukkit/Server.java
|
|
index 39b5de22629880bb35e1fb1bb01f3e42693462f5..df66b39ce9f3dd6c567bc71bacfd0b105c2e0e8d 100644
|
|
--- a/src/main/java/org/bukkit/Server.java
|
|
+++ b/src/main/java/org/bukkit/Server.java
|
|
@@ -1582,5 +1582,33 @@ public interface Server extends PluginMessageRecipient, net.kyori.adventure.audi
|
|
* @return true if player names should be suggested
|
|
*/
|
|
boolean suggestPlayerNamesWhenNullTabCompletions();
|
|
+
|
|
+ /**
|
|
+ * Creates a PlayerProfile for the specified uuid, with name as null
|
|
+ * @param uuid UUID to create profile for
|
|
+ * @return A PlayerProfile object
|
|
+ */
|
|
+ @NotNull
|
|
+ com.destroystokyo.paper.profile.PlayerProfile createProfile(@NotNull UUID uuid);
|
|
+
|
|
+ /**
|
|
+ * Creates a PlayerProfile for the specified name, with UUID as null
|
|
+ * @param name Name to create profile for
|
|
+ * @return A PlayerProfile object
|
|
+ */
|
|
+ @NotNull
|
|
+ com.destroystokyo.paper.profile.PlayerProfile createProfile(@NotNull String name);
|
|
+
|
|
+ /**
|
|
+ * Creates a PlayerProfile for the specified name/uuid
|
|
+ *
|
|
+ * Both UUID and Name can not be null at same time. One must be supplied.
|
|
+ *
|
|
+ * @param uuid UUID to create profile for
|
|
+ * @param name Name to create profile for
|
|
+ * @return A PlayerProfile object
|
|
+ */
|
|
+ @NotNull
|
|
+ com.destroystokyo.paper.profile.PlayerProfile createProfile(@Nullable UUID uuid, @Nullable String name);
|
|
// Paper end
|
|
}
|