PlayerPreLoginEvent.php

<?php
 
/*
 *
 *  ____            _        _   __  __ _                  __  __ ____
 * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
 * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
 * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
 * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * @author PocketMine Team
 * @link http://www.pocketmine.net/
 *
 *
 */
 
declare(strict_types=1);
 
namespace pocketmine\event\player;
 
use pocketmine\event\Event;
use pocketmine\lang\Translatable;
use pocketmine\player\PlayerInfo;
use function array_keys;
use function count;
 
class PlayerPreLoginEvent extends Event{
    public const KICK_FLAG_PLUGIN = 0;
    public const KICK_FLAG_SERVER_FULL = 1;
    public const KICK_FLAG_SERVER_WHITELISTED = 2;
    public const KICK_FLAG_BANNED = 3;
 
    public const KICK_FLAG_PRIORITY = [
        self::KICK_FLAG_PLUGIN, //Plugin reason should always take priority over anything else
        self::KICK_FLAG_SERVER_FULL,
        self::KICK_FLAG_SERVER_WHITELISTED,
        self::KICK_FLAG_BANNED
    ];
 
    protected array $disconnectReasons = [];
    protected array $disconnectScreenMessages = [];
 
    public function __construct(
        private PlayerInfo $playerInfo,
        private string $ip,
        private int $port,
        protected bool $authRequired
    ){}
 
    public function getPlayerInfo() : PlayerInfo{
        return $this->playerInfo;
    }
 
    public function getIp() : string{
        return $this->ip;
    }
 
    public function getPort() : int{
        return $this->port;
    }
 
    public function isAuthRequired() : bool{
        return $this->authRequired;
    }
 
    public function setAuthRequired(bool $v) : void{
        $this->authRequired = $v;
    }
 
    public function getKickFlags() : array{
        return array_keys($this->disconnectReasons);
    }
 
    public function isKickFlagSet(int $flag) : bool{
        return isset($this->disconnectReasons[$flag]);
    }
 
    public function setKickFlag(int $flag, Translatable|string $disconnectReason, Translatable|string|null $disconnectScreenMessage = null) : void{
        $this->disconnectReasons[$flag] = $disconnectReason;
        $this->disconnectScreenMessages[$flag] = $disconnectScreenMessage ?? $disconnectReason;
    }
 
    public function clearKickFlag(int $flag) : void{
        unset($this->disconnectReasons[$flag], $this->disconnectScreenMessages[$flag]);
    }
 
    public function clearAllKickFlags() : void{
        $this->disconnectReasons = [];
        $this->disconnectScreenMessages = [];
    }
 
    public function isAllowed() : bool{
        return count($this->disconnectReasons) === 0;
    }
 
    public function getDisconnectReason(int $flag) : Translatable|string|null{
        return $this->disconnectReasons[$flag] ?? null;
    }
 
    public function getDisconnectScreenMessage(int $flag) : Translatable|string|null{
        return $this->disconnectScreenMessages[$flag] ?? null;
    }
 
    public function getFinalDisconnectReason() : Translatable|string{
        foreach(self::KICK_FLAG_PRIORITY as $p){
            if(isset($this->disconnectReasons[$p])){
                return $this->disconnectReasons[$p];
            }
        }
 
        return "";
    }
 
    public function getFinalDisconnectScreenMessage() : Translatable|string{
        foreach(self::KICK_FLAG_PRIORITY as $p){
            if(isset($this->disconnectScreenMessages[$p])){
                return $this->disconnectScreenMessages[$p];
            }
        }
 
        return "";
    }
}