From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 From: Aikar <aikar@aikar.co> Date: Mon, 3 Jul 2017 18:11:34 -0500 Subject: [PATCH] ProfileWhitelistVerifyEvent Fires when the server is validating if a player is whitelisted. Allows you to do dynamic whitelisting and change of kick message diff --git a/src/main/java/com/destroystokyo/paper/event/profile/ProfileWhitelistVerifyEvent.java b/src/main/java/com/destroystokyo/paper/event/profile/ProfileWhitelistVerifyEvent.java new file mode 100644 index 0000000000000000000000000000000000000000..901efb61fdc02b3228cc25649926d691c4617512 --- /dev/null +++ b/src/main/java/com/destroystokyo/paper/event/profile/ProfileWhitelistVerifyEvent.java @@ -0,0 +1,146 @@ +/* + * Copyright (c) 2017 - Daniel Ennis (Aikar) - MIT License + * + * 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.destroystokyo.paper.event.profile; + +import com.destroystokyo.paper.profile.PlayerProfile; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer; +import org.bukkit.event.Event; +import org.bukkit.event.HandlerList; +import org.jetbrains.annotations.ApiStatus; +import org.jetbrains.annotations.Contract; +import org.jspecify.annotations.NullMarked; +import org.jspecify.annotations.Nullable; + +/** + * Fires when the server needs to verify if a player is whitelisted. + * <p> + * Plugins may override/control the servers whitelist with this event, + * and dynamically change the kick message. + */ +@NullMarked +public class ProfileWhitelistVerifyEvent extends Event { + + private static final HandlerList HANDLER_LIST = new HandlerList(); + + private final PlayerProfile profile; + private final boolean whitelistEnabled; + private final boolean isOp; + private boolean whitelisted; + private @Nullable Component kickMessage; + + @Deprecated + @ApiStatus.Internal + public ProfileWhitelistVerifyEvent(final PlayerProfile profile, final boolean whitelistEnabled, final boolean whitelisted, final boolean isOp, final @Nullable String kickMessage) { + this(profile, whitelistEnabled, whitelisted, isOp, kickMessage == null ? null : LegacyComponentSerializer.legacySection().deserialize(kickMessage)); + } + + @ApiStatus.Internal + public ProfileWhitelistVerifyEvent(final PlayerProfile profile, final boolean whitelistEnabled, final boolean whitelisted, final boolean isOp, final @Nullable Component kickMessage) { + this.profile = profile; + this.whitelistEnabled = whitelistEnabled; + this.whitelisted = whitelisted; + this.isOp = isOp; + this.kickMessage = kickMessage; + } + + /** + * @return the currently planned message to send to the user if they are not whitelisted + * @deprecated use {@link #kickMessage()} + */ + @Deprecated + public @Nullable String getKickMessage() { + return this.kickMessage == null ? null : LegacyComponentSerializer.legacySection().serialize(this.kickMessage); + } + + /** + * @param kickMessage The message to send to the player on kick if not whitelisted. May set to {@code null} to use the server configured default + * @deprecated Use {@link #kickMessage(Component)} + */ + @Deprecated + public void setKickMessage(final @Nullable String kickMessage) { + this.kickMessage(kickMessage == null ? null : LegacyComponentSerializer.legacySection().deserialize(kickMessage)); + } + + /** + * @return the currently planned message to send to the user if they are not whitelisted + */ + @Contract(pure = true) + public @Nullable Component kickMessage() { + return this.kickMessage; + } + + /** + * @param kickMessage The message to send to the player on kick if not whitelisted. May set to {@code null} to use the server configured default + */ + public void kickMessage(final @Nullable Component kickMessage) { + this.kickMessage = kickMessage; + } + + /** + * @return The profile of the player trying to connect + */ + public PlayerProfile getPlayerProfile() { + return this.profile; + } + + /** + * @return Whether the player is whitelisted to play on this server (whitelist may be off is why it's true) + */ + public boolean isWhitelisted() { + return this.whitelisted; + } + + /** + * Changes the players whitelisted state. {@code false} will deny the login + * + * @param whitelisted The new whitelisted state + */ + public void setWhitelisted(final boolean whitelisted) { + this.whitelisted = whitelisted; + } + + /** + * @return if the player obtained whitelist status by having op + */ + public boolean isOp() { + return this.isOp; + } + + /** + * @return if the server even has whitelist on + */ + public boolean isWhitelistEnabled() { + return this.whitelistEnabled; + } + + @Override + public HandlerList getHandlers() { + return HANDLER_LIST; + } + + public static HandlerList getHandlerList() { + return HANDLER_LIST; + } +}