From b8f6b66e42e830539e5b24d532710d536bbdb8c2 Mon Sep 17 00:00:00 2001 From: "Dylan K. Taylor" Date: Wed, 18 Jan 2023 20:57:17 +0000 Subject: [PATCH] First look at separating disconnect reason and disconnect screen messages (#4512) --- .../player/PlayerDisconnectEventTrait.php | 62 +++++++++++++++++++ .../player/PlayerDuplicateLoginEvent.php | 5 +- src/event/player/PlayerKickEvent.php | 23 ++----- src/network/NetworkSessionManager.php | 7 ++- src/network/mcpe/NetworkSession.php | 31 +++++----- .../handler/ResourcePacksPacketHandler.php | 2 +- src/player/Player.php | 26 +++++--- 7 files changed, 111 insertions(+), 45 deletions(-) create mode 100644 src/event/player/PlayerDisconnectEventTrait.php diff --git a/src/event/player/PlayerDisconnectEventTrait.php b/src/event/player/PlayerDisconnectEventTrait.php new file mode 100644 index 000000000..219f74247 --- /dev/null +++ b/src/event/player/PlayerDisconnectEventTrait.php @@ -0,0 +1,62 @@ +disconnectReason = $disconnectReason; + } + + /** + * Returns the kick reason shown in the server log and on the console. + * When kicked by the /kick command, the default is something like "Kicked by admin.". + */ + public function getDisconnectReason() : Translatable|string{ + return $this->disconnectReason; + } + + /** + * Sets the message shown on the player's disconnection screen. + * This can be as long as you like, and may contain formatting and newlines. + * If this is set to null, the kick reason will be used as the disconnect screen message directly. + */ + public function setDisconnectScreenMessage(Translatable|string|null $disconnectScreenMessage) : void{ + $this->disconnectScreenMessage = $disconnectScreenMessage; + } + + /** + * Returns the message shown on the player's disconnection screen. + * When kicked by the /kick command, the default is something like "Kicked by admin.". + * If this is null, the kick reason will be used as the disconnect screen message directly. + */ + public function getDisconnectScreenMessage() : Translatable|string|null{ return $this->disconnectScreenMessage ?? $this->disconnectReason; } +} diff --git a/src/event/player/PlayerDuplicateLoginEvent.php b/src/event/player/PlayerDuplicateLoginEvent.php index 53d68bcd0..eddd544fd 100644 --- a/src/event/player/PlayerDuplicateLoginEvent.php +++ b/src/event/player/PlayerDuplicateLoginEvent.php @@ -36,12 +36,15 @@ use pocketmine\network\mcpe\NetworkSession; */ class PlayerDuplicateLoginEvent extends Event implements Cancellable{ use CancellableTrait; + use PlayerDisconnectEventTrait; private Translatable|string $disconnectMessage; public function __construct( private NetworkSession $connectingSession, - private NetworkSession $existingSession + private NetworkSession $existingSession, + private Translatable|string $disconnectReason, + private Translatable|string|null $disconnectScreenMessage ){ $this->disconnectMessage = KnownTranslationFactory::disconnectionScreen_loggedinOtherLocation(); } diff --git a/src/event/player/PlayerKickEvent.php b/src/event/player/PlayerKickEvent.php index 11f77e4de..8e00385a2 100644 --- a/src/event/player/PlayerKickEvent.php +++ b/src/event/player/PlayerKickEvent.php @@ -33,32 +33,17 @@ use pocketmine\player\Player; */ class PlayerKickEvent extends PlayerEvent implements Cancellable{ use CancellableTrait; + use PlayerDisconnectEventTrait; public function __construct( Player $player, - protected Translatable|string $reason, - protected Translatable|string $quitMessage + protected Translatable|string $disconnectReason, + protected Translatable|string $quitMessage, + protected Translatable|string|null $disconnectScreenMessage ){ $this->player = $player; } - /** - * Sets the message shown on the kicked player's disconnection screen. - * This message is also displayed in the console and server log. - */ - public function setReason(Translatable|string $reason) : void{ - $this->reason = $reason; - } - - /** - * Returns the message shown on the kicked player's disconnection screen. - * This message is also displayed in the console and server log. - * When kicked by the /kick command, the default is something like "Kicked by admin.". - */ - public function getReason() : Translatable|string{ - return $this->reason; - } - /** * Sets the quit message broadcasted to other players. */ diff --git a/src/network/NetworkSessionManager.php b/src/network/NetworkSessionManager.php index 35ddb0453..d8ff7fe03 100644 --- a/src/network/NetworkSessionManager.php +++ b/src/network/NetworkSessionManager.php @@ -96,10 +96,13 @@ class NetworkSessionManager{ /** * Terminates all connected sessions with the given reason. + * + * @param Translatable|string $reason Shown in the server log - this should be a short one-line message + * @param Translatable|string|null $disconnectScreenMessage Shown on the player's disconnection screen (null will use the reason) */ - public function close(Translatable|string $reason = "") : void{ + public function close(Translatable|string $reason = "", Translatable|string|null $disconnectScreenMessage = null) : void{ foreach($this->sessions as $session){ - $session->disconnect($reason); + $session->disconnect($reason, $disconnectScreenMessage); } $this->sessions = []; } diff --git a/src/network/mcpe/NetworkSession.php b/src/network/mcpe/NetworkSession.php index 3cb21106d..5025928d2 100644 --- a/src/network/mcpe/NetworkSession.php +++ b/src/network/mcpe/NetworkSession.php @@ -602,22 +602,25 @@ class NetworkSession{ $this->invManager = null; } - private function sendDisconnectPacket(Translatable|string $reason) : void{ - if($reason instanceof Translatable){ - $translated = $this->server->getLanguage()->translate($reason); + private function sendDisconnectPacket(Translatable|string $message) : void{ + if($message instanceof Translatable){ + $translated = $this->server->getLanguage()->translate($message); }else{ - $translated = $reason; + $translated = $message; } $this->sendDataPacket(DisconnectPacket::create($translated)); } /** * Disconnects the session, destroying the associated player (if it exists). + * + * @param Translatable|string $reason Shown in the server log - this should be a short one-line message + * @param Translatable|string|null $disconnectScreenMessage Shown on the player's disconnection screen (null will use the reason) */ - public function disconnect(Translatable|string $reason, bool $notify = true) : void{ - $this->tryDisconnect(function() use ($reason, $notify) : void{ + public function disconnect(Translatable|string $reason, Translatable|string|null $disconnectScreenMessage = null, bool $notify = true) : void{ + $this->tryDisconnect(function() use ($reason, $disconnectScreenMessage, $notify) : void{ if($notify){ - $this->sendDisconnectPacket($reason); + $this->sendDisconnectPacket($disconnectScreenMessage ?? $reason); } if($this->player !== null){ $this->player->onPostDisconnect($reason, null); @@ -654,9 +657,9 @@ class NetworkSession{ /** * Called by the Player when it is closed (for example due to getting kicked). */ - public function onPlayerDestroyed(Translatable|string $reason) : void{ - $this->tryDisconnect(function() use ($reason) : void{ - $this->sendDisconnectPacket($reason); + public function onPlayerDestroyed(Translatable|string $reason, Translatable|string $disconnectScreenMessage) : void{ + $this->tryDisconnect(function() use ($disconnectScreenMessage) : void{ + $this->sendDisconnectPacket($disconnectScreenMessage); }, $reason); } @@ -694,7 +697,7 @@ class NetworkSession{ if(!$this->authenticated){ if($authRequired){ - $this->disconnect(KnownTranslationFactory::disconnectionScreen_notAuthenticated()); + $this->disconnect("Not authenticated", KnownTranslationFactory::disconnectionScreen_notAuthenticated()); return; } if($this->info instanceof XboxLivePlayerInfo){ @@ -728,14 +731,14 @@ class NetworkSession{ if($kickForXUIDMismatch($info instanceof XboxLivePlayerInfo ? $info->getXuid() : "")){ return; } - $ev = new PlayerDuplicateLoginEvent($this, $existingSession); + $ev = new PlayerDuplicateLoginEvent($this, $existingSession, KnownTranslationFactory::disconnectionScreen_loggedinOtherLocation(), null); $ev->call(); if($ev->isCancelled()){ - $this->disconnect($ev->getDisconnectMessage()); + $this->disconnect($ev->getDisconnectReason(), $ev->getDisconnectScreenMessage()); return; } - $existingSession->disconnect($ev->getDisconnectMessage()); + $existingSession->disconnect($ev->getDisconnectReason(), $ev->getDisconnectScreenMessage()); } } diff --git a/src/network/mcpe/handler/ResourcePacksPacketHandler.php b/src/network/mcpe/handler/ResourcePacksPacketHandler.php index 8e76c545d..7438fe47c 100644 --- a/src/network/mcpe/handler/ResourcePacksPacketHandler.php +++ b/src/network/mcpe/handler/ResourcePacksPacketHandler.php @@ -93,7 +93,7 @@ class ResourcePacksPacketHandler extends PacketHandler{ switch($packet->status){ case ResourcePackClientResponsePacket::STATUS_REFUSED: //TODO: add lang strings for this - $this->session->disconnect("You must accept resource packs to join this server.", true); + $this->session->disconnect("Refused resource packs", "You must accept resource packs to join this server.", true); break; case ResourcePackClientResponsePacket::STATUS_SEND_PACKS: foreach($packet->packIds as $uuid){ diff --git a/src/player/Player.php b/src/player/Player.php index 5bf99b3bb..3218929a9 100644 --- a/src/player/Player.php +++ b/src/player/Player.php @@ -2090,16 +2090,24 @@ class Player extends Human implements CommandSender, ChunkListener, IPlayer{ /** * Kicks a player from the server + * + * @param Translatable|string $reason Shown in the server log - this should be a short one-line message + * @param Translatable|string|null $quitMessage Message to broadcast to online players (null will use default) + * @param Translatable|string|null $disconnectScreenMessage Shown on the player's disconnection screen (null will use the reason) */ - public function kick(Translatable|string $reason = "", Translatable|string|null $quitMessage = null) : bool{ - $ev = new PlayerKickEvent($this, $reason, $quitMessage ?? $this->getLeaveMessage()); + public function kick(Translatable|string $reason = "", Translatable|string|null $quitMessage = null, Translatable|string|null $disconnectScreenMessage = null) : bool{ + $ev = new PlayerKickEvent($this, $reason, $quitMessage ?? $this->getLeaveMessage(), $disconnectScreenMessage); $ev->call(); if(!$ev->isCancelled()){ - $reason = $ev->getReason(); + $reason = $ev->getDisconnectReason(); if($reason === ""){ $reason = KnownTranslationFactory::disconnectionScreen_noReason(); } - $this->disconnect($reason, $ev->getQuitMessage()); + $disconnectScreenMessage = $ev->getDisconnectScreenMessage() ?? $reason; + if($disconnectScreenMessage === ""){ + $disconnectScreenMessage = KnownTranslationFactory::disconnectionScreen_noReason(); + } + $this->disconnect($reason, $ev->getQuitMessage(), $disconnectScreenMessage); return true; } @@ -2116,15 +2124,16 @@ class Player extends Human implements CommandSender, ChunkListener, IPlayer{ * * Note for internals developers: Do not call this from network sessions. It will cause a feedback loop. * - * @param Translatable|string $reason Shown on the disconnect screen, and in the server log - * @param Translatable|string|null $quitMessage Message to broadcast to online players (null will use default) + * @param Translatable|string $reason Shown in the server log - this should be a short one-line message + * @param Translatable|string|null $quitMessage Message to broadcast to online players (null will use default) + * @param Translatable|string|null $disconnectScreenMessage Shown on the player's disconnection screen (null will use the reason) */ - public function disconnect(Translatable|string $reason, Translatable|string|null $quitMessage = null) : void{ + public function disconnect(Translatable|string $reason, Translatable|string|null $quitMessage = null, Translatable|string|null $disconnectScreenMessage = null) : void{ if(!$this->isConnected()){ return; } - $this->getNetworkSession()->onPlayerDestroyed($reason); + $this->getNetworkSession()->onPlayerDestroyed($reason, $disconnectScreenMessage ?? $reason); $this->onPostDisconnect($reason, $quitMessage); } @@ -2132,6 +2141,7 @@ class Player extends Human implements CommandSender, ChunkListener, IPlayer{ * @internal * This method executes post-disconnect actions and cleanups. * + * @param Translatable|string $reason Shown in the server log - this should be a short one-line message * @param Translatable|string|null $quitMessage Message to broadcast to online players (null will use default) */ public function onPostDisconnect(Translatable|string $reason, Translatable|string|null $quitMessage) : void{