TrackManiaControl/core/Players/PlayerActions.php

854 lines
27 KiB
PHP
Raw Normal View History

2013-12-23 20:57:50 +01:00
<?php
namespace ManiaControl\Players;
2013-12-24 12:49:53 +01:00
use FML\Controls\Frame;
use FML\Controls\Labels\Label_Text;
use FML\Controls\Quad;
use FML\Controls\Quads\Quad_Icons64x64_1;
use FML\ManiaLink;
2013-12-23 21:47:39 +01:00
use ManiaControl\Admin\AuthenticationManager;
2015-06-23 21:20:44 +02:00
use ManiaControl\Callbacks\EchoListener;
2015-06-26 11:48:21 +02:00
use ManiaControl\Communication\CommunicationAnswer;
2015-06-23 21:20:44 +02:00
use ManiaControl\Communication\CommunicationListener;
use ManiaControl\Communication\CommunicationMethods;
use ManiaControl\General\UsageInformationAble;
use ManiaControl\General\UsageInformationTrait;
use ManiaControl\Logger;
2013-12-23 20:57:50 +01:00
use ManiaControl\ManiaControl;
2013-12-24 12:49:53 +01:00
use ManiaControl\Manialinks\ManialinkManager;
use Maniaplanet\DedicatedServer\Xmlrpc\AlreadyInListException;
2014-04-28 20:58:21 +02:00
use Maniaplanet\DedicatedServer\Xmlrpc\FaultException;
2014-08-10 00:09:46 +02:00
use Maniaplanet\DedicatedServer\Xmlrpc\GameModeException;
use Maniaplanet\DedicatedServer\Xmlrpc\NotInListException;
use Maniaplanet\DedicatedServer\Xmlrpc\PlayerStateException;
2014-07-19 23:39:25 +02:00
use Maniaplanet\DedicatedServer\Xmlrpc\ServerOptionsException;
use Maniaplanet\DedicatedServer\Xmlrpc\UnknownPlayerException;
2013-12-23 20:57:50 +01:00
2013-12-24 13:09:39 +01:00
/**
* Player Actions Class
2013-12-24 13:09:39 +01:00
*
2017-04-14 19:23:09 +02:00
* @api
2014-05-02 17:50:30 +02:00
* @author ManiaControl Team <mail@maniacontrol.com>
2020-01-22 10:39:35 +01:00
* @copyright 2014-2020 ManiaControl Team
2014-04-13 12:25:39 +02:00
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
2013-12-24 13:09:39 +01:00
*/
class PlayerActions implements EchoListener, CommunicationListener, UsageInformationAble {
use UsageInformationTrait;
/*
2013-12-23 20:57:50 +01:00
* Constants
*/
const TEAM_BLUE = 0;
const TEAM_RED = 1;
const SPECTATOR_USER_SELECTABLE = 0;
const SPECTATOR_SPECTATOR = 1;
const SPECTATOR_PLAYER = 2;
2013-12-23 20:57:50 +01:00
const SPECTATOR_BUT_KEEP_SELECTABLE = 3;
2015-06-23 21:20:44 +02:00
const ECHO_WARN_PLAYER = 'ManiaControl.PlayerManager.WarnPlayer';
2023-11-01 17:20:05 +01:00
/*
* Callback Constants
*/
const CB_PLAYER_FORCED_TO_PLAY = 'PlayerActions.PlayerForcedToPlay';
const CB_PLAYER_FORCED_TO_TEAM = 'PlayerActions.PlayerForcedToTeam';
const CB_PLAYER_FORCED_TO_SPEC = 'PlayerActions.PlayerForcedToSpec';
const CB_PLAYER_MUTED = 'PlayerActions.PlayerMuted';
const CB_PLAYER_WARNED = 'PlayerActions.PlayerWarned';
const CB_PLAYER_KICKED = 'PlayerActions.PlayerKicked';
const CB_PLAYER_BANNED = 'PlayerActions.PlayerBanned';
/*
2014-01-09 19:08:29 +01:00
* Permission Setting Constants
*/
const SETTING_PERMISSION_FORCE_PLAYER_PLAY = 'Force Player to Play';
const SETTING_PERMISSION_FORCE_PLAYER_TEAM = 'Force Player to Team';
const SETTING_PERMISSION_FORCE_PLAYER_SPEC = 'Force Player to Spec';
2014-01-09 19:15:06 +01:00
const SETTING_PERMISSION_MUTE_PLAYER = 'Mute Player';
const SETTING_PERMISSION_WARN_PLAYER = 'Warn Player';
const SETTING_PERMISSION_KICK_PLAYER = 'Kick Player';
const SETTING_PERMISSION_BAN_PLAYER = 'Ban Player';
2014-01-09 19:08:29 +01:00
2015-06-23 21:20:44 +02:00
/*
* Private properties
2013-12-23 20:57:50 +01:00
*/
/** @var ManiaControl $maniaControl */
2013-12-23 20:57:50 +01:00
private $maniaControl = null;
2013-12-31 16:01:22 +01:00
/**
* Construct a new PlayerActions instance
2013-12-31 16:01:22 +01:00
*
* @param ManiaControl $maniaControl
*/
2013-12-23 20:57:50 +01:00
public function __construct(ManiaControl $maniaControl) {
$this->maniaControl = $maniaControl;
2014-01-09 19:08:29 +01:00
// Permissions
2014-08-13 11:05:52 +02:00
$this->maniaControl->getAuthenticationManager()->definePermissionLevel(self::SETTING_PERMISSION_BAN_PLAYER, AuthenticationManager::AUTH_LEVEL_ADMIN);
$this->maniaControl->getAuthenticationManager()->definePermissionLevel(self::SETTING_PERMISSION_KICK_PLAYER, AuthenticationManager::AUTH_LEVEL_MODERATOR);
$this->maniaControl->getAuthenticationManager()->definePermissionLevel(self::SETTING_PERMISSION_WARN_PLAYER, AuthenticationManager::AUTH_LEVEL_MODERATOR);
$this->maniaControl->getAuthenticationManager()->definePermissionLevel(self::SETTING_PERMISSION_MUTE_PLAYER, AuthenticationManager::AUTH_LEVEL_MODERATOR);
$this->maniaControl->getAuthenticationManager()->definePermissionLevel(self::SETTING_PERMISSION_FORCE_PLAYER_PLAY, AuthenticationManager::AUTH_LEVEL_MODERATOR);
$this->maniaControl->getAuthenticationManager()->definePermissionLevel(self::SETTING_PERMISSION_FORCE_PLAYER_TEAM, AuthenticationManager::AUTH_LEVEL_MODERATOR);
$this->maniaControl->getAuthenticationManager()->definePermissionLevel(self::SETTING_PERMISSION_FORCE_PLAYER_SPEC, AuthenticationManager::AUTH_LEVEL_MODERATOR);
2015-06-23 21:20:44 +02:00
// Echo Warn Command (Usage: sendEcho json_encode("player" => "loginName")
$this->maniaControl->getEchoManager()->registerEchoListener(self::ECHO_WARN_PLAYER, $this, function ($params) {
$this->warnPlayer(null, $params->player, false);
});
//Communication Manager Methods
$this->maniaControl->getCommunicationManager()->registerCommunicationListener(CommunicationMethods::WARN_PLAYER, $this, function ($data) {
if (!is_object($data) || !property_exists($data, "login")) {
2015-06-26 11:48:21 +02:00
return new CommunicationAnswer("You have to provide a valid player Login", true);
2015-06-23 21:20:44 +02:00
}
$success = $this->warnPlayer(null, $data->login, false);
2015-06-26 11:48:21 +02:00
return new CommunicationAnswer(array("success" => $success));
2015-06-23 21:20:44 +02:00
});
$this->maniaControl->getCommunicationManager()->registerCommunicationListener(CommunicationMethods::MUTE_PLAYER, $this, function ($data) {
if (!is_object($data) || !property_exists($data, "login")) {
2015-06-26 11:48:21 +02:00
return new CommunicationAnswer("You have to provide a valid player Login", true);
2015-06-23 21:20:44 +02:00
}
$success = $this->mutePlayer(null, $data->login, false);
2015-06-26 11:48:21 +02:00
return new CommunicationAnswer(array("success" => $success));
2015-06-23 21:20:44 +02:00
});
$this->maniaControl->getCommunicationManager()->registerCommunicationListener(CommunicationMethods::UNMUTE_PLAYER, $this, function ($data) {
if (!is_object($data) || !property_exists($data, "login")) {
2015-06-26 11:48:21 +02:00
return new CommunicationAnswer("You have to provide a valid player Login", true);
2015-06-23 21:20:44 +02:00
}
$success = $this->unMutePlayer(null, $data->login, false);
2015-06-26 11:48:21 +02:00
return new CommunicationAnswer(array("success" => $success));
2015-06-23 21:20:44 +02:00
});
$this->maniaControl->getCommunicationManager()->registerCommunicationListener(CommunicationMethods::KICK_PLAYER, $this, function ($data) {
if (!is_object($data) || !property_exists($data, "login")) {
2015-06-26 11:48:21 +02:00
return new CommunicationAnswer("You have to provide a valid player Login", true);
2015-06-23 21:20:44 +02:00
}
$message = "";
if (property_exists($data, "message")) {
$message = $data->message;
}
$success = $this->kickPlayer(null, $data->login, $message, false);
2015-06-26 11:48:21 +02:00
return new CommunicationAnswer(array("success" => $success));
2015-06-23 21:20:44 +02:00
});
2015-06-26 13:06:05 +02:00
$this->maniaControl->getCommunicationManager()->registerCommunicationListener(CommunicationMethods::FORCE_PLAYER_TO_SPEC, $this, function ($data) {
if (!is_object($data) || !property_exists($data, "login")) {
return new CommunicationAnswer("You have to provide a valid player Login", true);
}
//TODO allow parameters like spectator state
$success = $this->forcePlayerToSpectator(null, $data->login, self::SPECTATOR_BUT_KEEP_SELECTABLE, true, false);
return new CommunicationAnswer(array("success" => $success));
});
$this->maniaControl->getCommunicationManager()->registerCommunicationListener(CommunicationMethods::FORCE_PLAYER_TO_PLAY, $this, function ($data) {
if (!is_object($data) || !property_exists($data, "login")) {
return new CommunicationAnswer("You have to provide a valid player Login", true);
}
//TODO allow parameters like spectator state
if (property_exists($data, "teamId")) {
$success = $this->forcePlayerToTeam(null, $data->login, $data->teamId, false);
} else {
$success = $this->forcePlayerToPlay(null, $data->login, true, true, false);
}
return new CommunicationAnswer(array("success" => $success));
});
2013-12-23 20:57:50 +01:00
}
/**
2013-12-31 16:01:22 +01:00
* Force a Player to a certain Team
*
2017-04-14 19:23:09 +02:00
* @api
2013-12-31 16:01:22 +01:00
* @param string $adminLogin
* @param string $targetLogin
* @param int $teamId
2015-06-26 13:06:05 +02:00
* @param bool $calledByAdmin
* @return bool
2013-12-23 20:57:50 +01:00
*/
2015-06-26 13:06:05 +02:00
public function forcePlayerToTeam($adminLogin, $targetLogin, $teamId, $calledByAdmin = true) {
if ($calledByAdmin) {
$admin = $this->maniaControl->getPlayerManager()->getPlayer($adminLogin);
2020-05-30 22:42:39 +02:00
if (!$admin) {
2015-06-26 13:06:05 +02:00
return false;
}
2020-05-30 22:42:39 +02:00
if (!$this->maniaControl->getAuthenticationManager()->checkPermission($admin, self::SETTING_PERMISSION_FORCE_PLAYER_TEAM)) {
$this->maniaControl->getAuthenticationManager()->sendNotAllowed($admin);
2015-06-26 13:06:05 +02:00
return false;
}
2014-01-06 18:09:47 +01:00
}
2014-08-13 11:05:52 +02:00
$target = $this->maniaControl->getPlayerManager()->getPlayer($targetLogin);
2015-06-26 13:06:05 +02:00
if (!$target) {
return false;
2014-01-09 19:08:29 +01:00
}
2014-06-22 19:23:54 +02:00
if ($target->isSpectator) {
try {
2015-06-26 13:06:05 +02:00
if (!$this->forcePlayerToPlay($adminLogin, $targetLogin, true, false, $calledByAdmin)) {
return false;
2014-06-22 19:23:54 +02:00
}
2020-05-30 22:42:39 +02:00
} catch (FaultException $e) {
$this->maniaControl->getChat()->sendException($e, $adminLogin);
2014-06-22 19:23:54 +02:00
}
2013-12-23 21:47:39 +01:00
}
2014-03-13 18:25:29 +01:00
try {
2014-08-13 11:05:52 +02:00
$this->maniaControl->getClient()->forcePlayerTeam($target->login, $teamId);
2020-05-30 22:42:39 +02:00
} catch (ServerOptionsException $e) {
2014-04-19 23:47:46 +02:00
$this->forcePlayerToPlay($adminLogin, $targetLogin);
2015-06-26 13:06:05 +02:00
return false;
2020-05-30 22:42:39 +02:00
} catch (UnknownPlayerException $e) {
$this->maniaControl->getChat()->sendException($e, $adminLogin);
2015-06-26 13:06:05 +02:00
return false;
2020-05-30 22:42:39 +02:00
} catch (GameModeException $e) {
$this->maniaControl->getChat()->sendException($e, $adminLogin);
2015-06-26 13:06:05 +02:00
return false;
2014-03-13 18:25:29 +01:00
}
2023-11-01 17:20:05 +01:00
$this->maniaControl->getCallbackManager()->triggerCallback(self::CB_PLAYER_FORCED_TO_TEAM, $target, $teamId);
2020-05-30 22:42:39 +02:00
$message = false;
$teamName = '';
if ($teamId === self::TEAM_BLUE) {
$teamName = '$00fBlue';
} elseif ($teamId === self::TEAM_RED) {
$teamName = '$f00Red';
}
2015-06-26 13:06:05 +02:00
2020-05-30 22:42:39 +02:00
if ($teamName) {
if ($calledByAdmin) {
$title = $admin->getAuthLevelName();
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
"{$title} %s forced %s into the %s-Team!",
2020-05-30 22:42:39 +02:00
$admin,
$target,
$teamName
);
} else {
$message = $this->maniaControl->getChat()->formatMessage(
'%s got forced %s into the %s-Team!',
$target,
$teamName
);
2015-06-26 13:06:05 +02:00
}
2013-12-24 12:49:53 +01:00
}
2015-06-26 13:06:05 +02:00
2020-05-30 22:42:39 +02:00
if ($message) {
$this->maniaControl->getChat()->sendInformation($message);
2023-11-01 17:20:05 +01:00
Logger::logInfo($message, true);
2014-01-09 19:08:29 +01:00
}
2015-06-26 13:06:05 +02:00
return true;
2013-12-23 20:57:50 +01:00
}
2014-05-02 17:50:30 +02:00
/**
* Force a Player to Play
*
2017-04-14 19:23:09 +02:00
* @api
2014-05-02 17:50:30 +02:00
* @param string $adminLogin
* @param string $targetLogin
* @param bool $userIsAbleToSelect
* @param bool $displayAnnouncement
2015-06-26 13:06:05 +02:00
* @param bool $calledByAdmin
* @return bool
2014-05-02 17:50:30 +02:00
*/
2015-06-26 13:06:05 +02:00
public function forcePlayerToPlay($adminLogin, $targetLogin, $userIsAbleToSelect = true, $displayAnnouncement = true, $calledByAdmin = true) {
if ($calledByAdmin) {
$admin = $this->maniaControl->getPlayerManager()->getPlayer($adminLogin);
2015-07-29 22:07:52 +02:00
if (!$this->maniaControl->getAuthenticationManager()->checkPermission($admin, self::SETTING_PERMISSION_FORCE_PLAYER_PLAY)) {
2015-06-26 13:06:05 +02:00
$this->maniaControl->getAuthenticationManager()->sendNotAllowed($admin);
return false;
}
2014-05-02 17:50:30 +02:00
}
2015-06-26 13:06:05 +02:00
2014-08-13 11:05:52 +02:00
$target = $this->maniaControl->getPlayerManager()->getPlayer($targetLogin);
2014-05-02 17:50:30 +02:00
if (!$target) {
return false;
2014-05-02 17:50:30 +02:00
}
try {
2014-08-13 11:05:52 +02:00
$this->maniaControl->getClient()->forceSpectator($target->login, self::SPECTATOR_PLAYER);
2020-05-30 22:42:39 +02:00
} catch (ServerOptionsException $e) {
$this->maniaControl->getChat()->sendException($e, $adminLogin);
return false;
2020-05-30 22:42:39 +02:00
} catch (UnknownPlayerException $e) {
$this->maniaControl->getChat()->sendException($e, $adminLogin);
2017-02-11 23:26:28 +01:00
return false;
2014-05-02 17:50:30 +02:00
}
if ($userIsAbleToSelect) {
try {
2014-08-13 11:05:52 +02:00
$this->maniaControl->getClient()->forceSpectator($target->login, self::SPECTATOR_USER_SELECTABLE);
2020-05-30 22:42:39 +02:00
} catch (ServerOptionsException $e) {
2015-06-26 13:06:05 +02:00
if ($calledByAdmin) {
2020-05-30 22:42:39 +02:00
$this->maniaControl->getChat()->sendException($e, $admin);
2015-06-26 13:06:05 +02:00
}
return false;
2014-05-02 17:50:30 +02:00
}
}
2023-11-01 17:20:05 +01:00
$this->maniaControl->getCallbackManager()->triggerCallback(self::CB_PLAYER_FORCED_TO_PLAY, $target);
2014-05-02 17:50:30 +02:00
// Announce force
if ($displayAnnouncement) {
2015-06-26 13:06:05 +02:00
if ($calledByAdmin) {
$title = $admin->getAuthLevelName();
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
"{$title} %s forced %s to Play!",
2020-05-30 22:42:39 +02:00
$admin,
$target
);
2015-06-26 13:06:05 +02:00
} else {
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
'%s got forced to Play!',
$target
);
2015-06-26 13:06:05 +02:00
}
2020-05-30 22:42:39 +02:00
$this->maniaControl->getChat()->sendInformation($message);
2014-05-02 17:50:30 +02:00
}
return true;
2014-05-02 17:50:30 +02:00
}
2013-12-23 20:57:50 +01:00
/**
2013-12-31 16:01:22 +01:00
* Force a Player to Spectator
*
2017-04-14 19:23:09 +02:00
* @api
2013-12-31 16:01:22 +01:00
* @param string $adminLogin
* @param string $targetLogin
* @param int $spectatorState
* @param bool $releaseSlot
2015-06-26 13:06:05 +02:00
* @param bool $calledByAdmin
* @return bool
2013-12-23 20:57:50 +01:00
*/
2015-06-26 13:06:05 +02:00
public function forcePlayerToSpectator($adminLogin, $targetLogin, $spectatorState = self::SPECTATOR_BUT_KEEP_SELECTABLE, $releaseSlot = true, $calledByAdmin = true) {
if ($calledByAdmin) {
$admin = $this->maniaControl->getPlayerManager()->getPlayer($adminLogin);
2020-05-30 22:42:39 +02:00
if (!$admin) {
2015-06-26 13:06:05 +02:00
return false;
}
2020-05-30 22:42:39 +02:00
if (!$this->maniaControl->getAuthenticationManager()->checkPermission($admin, self::SETTING_PERMISSION_FORCE_PLAYER_SPEC)) {
$this->maniaControl->getAuthenticationManager()->sendNotAllowed($admin);
2015-06-26 13:06:05 +02:00
return false;
}
}
2015-06-26 13:06:05 +02:00
2014-08-13 11:05:52 +02:00
$target = $this->maniaControl->getPlayerManager()->getPlayer($targetLogin);
2015-06-26 13:06:05 +02:00
if (!$target || $target->isSpectator) {
return false;
2013-12-23 21:47:39 +01:00
}
2014-04-13 12:25:39 +02:00
try {
2014-08-13 11:05:52 +02:00
$this->maniaControl->getClient()->forceSpectator($target->login, $spectatorState);
2020-05-30 22:42:39 +02:00
} catch (ServerOptionsException $e) {
$this->maniaControl->getChat()->sendException($e, $adminLogin);
2015-06-26 13:06:05 +02:00
return false;
2014-04-13 12:25:39 +02:00
}
2023-11-01 17:20:05 +01:00
$this->maniaControl->getCallbackManager()->triggerCallback(self::CB_PLAYER_FORCED_TO_SPEC, $target);
2015-06-26 13:06:05 +02:00
if ($calledByAdmin) {
$title = $admin->getAuthLevelName();
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
"{$title} %s forced %s to Spectator!",
2020-05-30 22:42:39 +02:00
$admin,
$target
);
2015-06-26 13:06:05 +02:00
} else {
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
'%s got forced to Spectator!',
$target
);
2015-06-26 13:06:05 +02:00
}
2020-05-30 22:42:39 +02:00
$this->maniaControl->getChat()->sendInformation($message);
Logger::logInfo($message, true);
2014-02-27 13:25:11 +01:00
if ($releaseSlot) {
// Free player slot
2014-01-16 21:51:25 +01:00
try {
2014-08-13 11:05:52 +02:00
$this->maniaControl->getClient()->spectatorReleasePlayerSlot($target->login);
} catch (PlayerStateException $e) {
2014-07-19 23:39:25 +02:00
} catch (UnknownPlayerException $e) {
2014-01-16 21:51:25 +01:00
}
}
2015-06-26 13:06:05 +02:00
return true;
2013-12-23 20:57:50 +01:00
}
2014-01-02 16:37:52 +01:00
/**
* UnMute a Player
2014-01-02 16:37:52 +01:00
*
2017-04-14 19:23:09 +02:00
* @api
2015-06-23 21:20:44 +02:00
* @param $adminLogin
* @param $targetLogin
* @param bool $calledByAdmin
* @return bool
2014-01-02 16:37:52 +01:00
*/
2015-06-23 21:20:44 +02:00
public function unMutePlayer($adminLogin, $targetLogin, $calledByAdmin = true) {
if ($calledByAdmin) {
$admin = $this->maniaControl->getPlayerManager()->getPlayer($adminLogin);
2015-07-29 22:07:52 +02:00
if (!$this->maniaControl->getAuthenticationManager()->checkPermission($admin, self::SETTING_PERMISSION_MUTE_PLAYER)) {
2015-06-23 21:20:44 +02:00
$this->maniaControl->getAuthenticationManager()->sendNotAllowed($admin);
return false;
}
}
2020-05-30 22:42:39 +02:00
$target = $this->maniaControl->getPlayerManager()->getPlayer($targetLogin);
2014-02-27 13:25:11 +01:00
if (!$target) {
2015-06-23 21:20:44 +02:00
return false;
2014-01-02 16:37:52 +01:00
}
2014-05-02 17:50:30 +02:00
try {
2014-08-13 11:05:52 +02:00
$this->maniaControl->getClient()->unIgnore($targetLogin);
} catch (NotInListException $e) {
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
'%s is not muted!',
$targetLogin
2020-05-30 22:42:39 +02:00
);
$this->maniaControl->getChat()->sendError($message, $adminLogin);
2015-06-23 21:20:44 +02:00
return false;
}
if ($calledByAdmin) {
$title = $admin->getAuthLevelName();
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
"{$title} %s un-muted %s!",
2020-05-30 22:42:39 +02:00
$admin,
$target
);
2015-06-23 21:20:44 +02:00
} else {
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
'%s got un-muted!',
$target
);
2014-04-24 10:38:50 +02:00
}
2014-02-27 13:24:55 +01:00
2020-05-30 22:42:39 +02:00
$this->maniaControl->getChat()->sendInformation($message);
Logger::logInfo($message, true);
2015-06-23 21:20:44 +02:00
return true;
2014-01-02 16:37:52 +01:00
}
/**
* Mute a Player
2014-01-02 16:37:52 +01:00
*
2017-04-14 19:23:09 +02:00
* @api
2014-01-02 16:37:52 +01:00
* @param string $adminLogin
* @param string $targetLogin
2015-06-23 21:20:44 +02:00
* @param bool $calledByAdmin
* @return bool
2014-01-02 16:37:52 +01:00
*/
2015-06-23 21:20:44 +02:00
public function mutePlayer($adminLogin, $targetLogin, $calledByAdmin = true) {
if ($calledByAdmin) {
$admin = $this->maniaControl->getPlayerManager()->getPlayer($adminLogin);
2015-07-29 22:07:52 +02:00
if (!$this->maniaControl->getAuthenticationManager()->checkPermission($admin, self::SETTING_PERMISSION_MUTE_PLAYER)) {
2015-06-23 21:20:44 +02:00
$this->maniaControl->getAuthenticationManager()->sendNotAllowed($admin);
return false;
}
}
2020-05-30 22:42:39 +02:00
$target = $this->maniaControl->getPlayerManager()->getPlayer($targetLogin);
2014-02-27 13:25:11 +01:00
if (!$target) {
2015-06-23 21:20:44 +02:00
return false;
2014-02-27 13:24:55 +01:00
}
2014-05-02 17:50:30 +02:00
try {
2014-08-13 11:05:52 +02:00
$this->maniaControl->getClient()->ignore($targetLogin);
} catch (AlreadyInListException $e) {
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
'%s is already muted!',
$targetLogin
2020-05-30 22:42:39 +02:00
);
$this->maniaControl->getChat()->sendError($message, $adminLogin);
2015-06-23 21:20:44 +02:00
return false;
} catch (UnknownPlayerException $e) {
$this->maniaControl->getChat()->sendException($e, $adminLogin);
return false;
2015-06-23 21:20:44 +02:00
}
2023-11-01 17:20:05 +01:00
$this->maniaControl->getCallbackManager()->triggerCallback(self::CB_PLAYER_MUTED, $target);
2015-06-23 21:20:44 +02:00
if ($calledByAdmin) {
$title = $admin->getAuthLevelName();
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
"{$title} %s muted %s!",
2020-05-30 22:42:39 +02:00
$admin,
$target
);
2015-06-23 21:20:44 +02:00
} else {
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
'%s got muted!',
$target
);
2014-04-24 10:33:47 +02:00
}
2020-05-30 22:42:39 +02:00
$this->maniaControl->getChat()->sendInformation($message);
Logger::logInfo($message, true);
2015-06-23 21:20:44 +02:00
return true;
2014-01-02 16:37:52 +01:00
}
2013-12-23 21:47:39 +01:00
/**
* Warn a Player
2013-12-31 16:01:22 +01:00
*
2017-04-14 19:23:09 +02:00
* @api
2013-12-31 16:01:22 +01:00
* @param string $adminLogin
* @param string $targetLogin
* @param bool $calledByAdmin
2015-06-23 21:20:44 +02:00
* @return bool
2013-12-23 21:47:39 +01:00
*/
public function warnPlayer($adminLogin, $targetLogin, $calledByAdmin = true) {
if ($calledByAdmin) {
$admin = $this->maniaControl->getPlayerManager()->getPlayer($adminLogin);
2015-07-29 22:07:52 +02:00
if (!$this->maniaControl->getAuthenticationManager()->checkPermission($admin, self::SETTING_PERMISSION_WARN_PLAYER)) {
$this->maniaControl->getAuthenticationManager()->sendNotAllowed($admin);
2015-06-23 21:20:44 +02:00
return false;
}
}
2014-02-27 13:24:55 +01:00
2014-08-13 11:05:52 +02:00
$target = $this->maniaControl->getPlayerManager()->getPlayer($targetLogin);
2014-02-27 13:25:11 +01:00
if (!$target) {
2015-06-23 21:20:44 +02:00
return false;
2014-01-09 19:08:29 +01:00
}
// Display warning message
2013-12-24 12:49:53 +01:00
$message = '$s$f00This is an administrative warning.{br}{br}$gWhatever you wrote or you have done is against {br} our server\'s policy.
{br}Not respecting other players, or{br}using offensive language might result in a{br}$f00kick, or ban $ff0the next time.
{br}{br}$gThe server administrators.';
$message = preg_split('/{br}/', $message);
// Build Manialink
$width = 80;
$height = 50;
2014-08-13 11:05:52 +02:00
$quadStyle = $this->maniaControl->getManialinkManager()->getStyleManager()->getDefaultMainWindowStyle();
$quadSubstyle = $this->maniaControl->getManialinkManager()->getStyleManager()->getDefaultMainWindowSubStyle();
2013-12-24 12:49:53 +01:00
$maniaLink = new ManiaLink(ManialinkManager::MAIN_MLID);
$frame = new Frame();
2017-03-25 19:15:50 +01:00
$maniaLink->addChild($frame);
2013-12-24 12:49:53 +01:00
$frame->setPosition(0, 10);
2017-05-07 19:35:53 +02:00
$frame->setZ(ManialinkManager::MAIN_MANIALINK_Z_VALUE);
// Background
2013-12-24 12:49:53 +01:00
$backgroundQuad = new Quad();
2017-03-25 19:15:50 +01:00
$frame->addChild($backgroundQuad);
2013-12-31 16:01:22 +01:00
$backgroundQuad->setSize($width, $height);
2013-12-24 12:49:53 +01:00
$backgroundQuad->setStyles($quadStyle, $quadSubstyle);
2017-05-07 19:35:53 +02:00
$backgroundQuad->setZ(-1);
// Close Quad (X)
2013-12-24 12:49:53 +01:00
$closeQuad = new Quad_Icons64x64_1();
2017-03-25 19:15:50 +01:00
$frame->addChild($closeQuad);
2017-05-07 19:35:53 +02:00
$closeQuad->setPosition($width / 2 - 3, $height / 2 - 3, 3);
2013-12-24 12:49:53 +01:00
$closeQuad->setSize(6, 6);
$closeQuad->setSubStyle($closeQuad::SUBSTYLE_QuitRace);
2013-12-24 12:49:53 +01:00
$closeQuad->setAction(ManialinkManager::ACTION_CLOSEWIDGET);
// Headline
2013-12-24 12:49:53 +01:00
$label = new Label_Text();
2017-03-25 19:15:50 +01:00
$frame->addChild($label);
2013-12-24 12:49:53 +01:00
$label->setY($height / 2 - 5);
$label->setStyle($label::STYLE_TextCardMedium);
2013-12-24 12:49:53 +01:00
$label->setTextSize(4);
$label->setText('Administrative Warning');
$label->setTextColor('f00');
$posY = $height / 2 - 15;
2014-05-02 17:50:30 +02:00
foreach ($message as $line) {
// Message lines
2013-12-24 12:49:53 +01:00
$label = new Label_Text();
2017-03-25 19:15:50 +01:00
$frame->addChild($label);
$label->setY($posY);
$label->setStyle($label::STYLE_TextCardMedium);
2013-12-24 12:49:53 +01:00
$label->setText($line);
$label->setTextColor('ff0');
$label->setTextSize(1);
$posY -= 4;
2013-12-24 12:49:53 +01:00
}
2013-12-31 16:01:22 +01:00
// Display manialink
2014-08-13 11:05:52 +02:00
$this->maniaControl->getManialinkManager()->displayWidget($maniaLink, $target);
2023-11-01 17:20:05 +01:00
$this->maniaControl->getCallbackManager()->triggerCallback(self::CB_PLAYER_WARNED, $target);
if ($calledByAdmin) {
$title = $admin->getAuthLevelName();
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
"{$title} %s warned %s!",
2020-05-30 22:42:39 +02:00
$admin,
$target
);
} else {
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
'%s got warned!',
$target
);
}
2020-05-30 22:42:39 +02:00
$this->maniaControl->getChat()->sendInformation($message);
Logger::log($message, true);
2015-06-23 21:20:44 +02:00
return true;
2013-12-23 20:57:50 +01:00
}
2015-06-23 21:20:44 +02:00
2013-12-23 21:47:39 +01:00
/**
* Kick a Player
2013-12-31 16:01:22 +01:00
*
2017-04-14 19:23:09 +02:00
* @api
2015-06-23 21:20:44 +02:00
* @param $adminLogin
* @param $targetLogin
2013-12-23 21:47:39 +01:00
* @param string $message
2015-06-23 21:20:44 +02:00
* @param bool $calledByAdmin
* @return bool
2013-12-23 21:47:39 +01:00
*/
2015-06-23 21:20:44 +02:00
public function kickPlayer($adminLogin, $targetLogin, $message = '', $calledByAdmin = true) {
if ($calledByAdmin) {
$admin = $this->maniaControl->getPlayerManager()->getPlayer($adminLogin);
2015-07-29 22:07:52 +02:00
if (!$this->maniaControl->getAuthenticationManager()->checkPermission($admin, self::SETTING_PERMISSION_KICK_PLAYER)) {
2015-06-23 21:20:44 +02:00
$this->maniaControl->getAuthenticationManager()->sendNotAllowed($admin);
return false;
}
}
2015-06-23 21:20:44 +02:00
2014-08-13 11:05:52 +02:00
$target = $this->maniaControl->getPlayerManager()->getPlayer($targetLogin);
2014-02-27 13:25:11 +01:00
if (!$target) {
2015-06-23 21:20:44 +02:00
return false;
2014-01-09 19:08:29 +01:00
}
2015-06-18 15:52:30 +02:00
if ($target->isFakePlayer()) {
try {
2014-08-13 11:05:52 +02:00
$this->maniaControl->getClient()->disconnectFakePlayer($target->login);
2015-06-18 15:52:30 +02:00
} catch (PlayerStateException $e) {
2020-05-30 22:42:39 +02:00
$this->maniaControl->getChat()->sendException($e, $adminLogin);
2015-06-23 21:20:44 +02:00
return false;
2020-05-30 22:42:39 +02:00
} catch (UnknownPlayerException $e) {
$this->maniaControl->getChat()->sendException($e, $adminLogin);
2017-02-11 23:26:28 +01:00
return false;
2015-06-18 15:52:30 +02:00
}
} else {
try {
2014-08-13 11:05:52 +02:00
$this->maniaControl->getClient()->kick($target->login, $message);
2015-06-18 15:52:30 +02:00
} catch (UnknownPlayerException $e) {
2020-05-30 22:42:39 +02:00
$this->maniaControl->getChat()->sendException($e, $adminLogin);
2015-06-23 21:20:44 +02:00
return false;
2014-01-20 20:51:03 +01:00
}
2013-12-23 21:47:39 +01:00
}
2023-11-01 17:20:05 +01:00
$this->maniaControl->getCallbackManager()->triggerCallback(self::CB_PLAYER_KICKED, $target);
2015-06-23 21:20:44 +02:00
if ($calledByAdmin) {
$title = $admin->getAuthLevelName();
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
"{$title} %s kicked %s!",
2020-05-30 22:42:39 +02:00
$admin,
$target
);
2015-06-23 21:20:44 +02:00
} else {
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
'%s got kicked!',
$target
);
2015-06-23 21:20:44 +02:00
}
2020-05-30 22:42:39 +02:00
$this->maniaControl->getChat()->sendInformation($message);
Logger::logInfo($message, true);
2015-06-23 21:20:44 +02:00
return true;
2013-12-23 20:57:50 +01:00
}
2015-06-23 21:20:44 +02:00
2013-12-23 21:47:39 +01:00
/**
* Ban a Player
2013-12-31 16:01:22 +01:00
*
2017-04-14 19:23:09 +02:00
* @api
2013-12-31 16:01:22 +01:00
* @param string $adminLogin
* @param string $targetLogin
2013-12-23 21:47:39 +01:00
* @param string $message
*/
2013-12-31 16:01:22 +01:00
public function banPlayer($adminLogin, $targetLogin, $message = '') {
2014-08-13 11:05:52 +02:00
$admin = $this->maniaControl->getPlayerManager()->getPlayer($adminLogin);
2015-07-29 22:07:52 +02:00
if (!$this->maniaControl->getAuthenticationManager()->checkPermission($admin, self::SETTING_PERMISSION_BAN_PLAYER)) {
2014-08-13 11:05:52 +02:00
$this->maniaControl->getAuthenticationManager()->sendNotAllowed($admin);
return;
}
2015-07-29 22:07:52 +02:00
2014-08-13 11:05:52 +02:00
$target = $this->maniaControl->getPlayerManager()->getPlayer($targetLogin);
2014-02-27 13:25:11 +01:00
if (!$target) {
return;
2014-01-09 19:08:29 +01:00
}
2015-07-29 22:07:52 +02:00
//Todo Validate (Problem: Not connected player isFakePlayer)
if ($target->isOfficial && $target->isFakePlayer()) {
2020-05-11 17:19:35 +02:00
$this->maniaControl->getChat()->sendError('It is not possible to Ban a bot!', $admin);
2014-01-16 19:49:36 +01:00
return;
}
2015-01-12 13:20:21 +01:00
try {
$this->maniaControl->getClient()->ban($target->login, $message);
} catch (UnknownPlayerException $e) {
$this->maniaControl->getChat()->sendError('Unknown player!', $admin);
return;
}
2023-11-01 17:20:05 +01:00
$this->maniaControl->getCallbackManager()->triggerCallback(self::CB_PLAYER_BANNED, $target);
$title = $admin->getAuthLevelName();
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
"{$title} %s banned %s!",
2020-05-30 22:42:39 +02:00
$admin,
$target
);
$this->maniaControl->getChat()->sendInformation($message);
Logger::logInfo($message, true);
2013-12-23 20:57:50 +01:00
}
2013-12-26 11:25:10 +01:00
2015-01-11 15:53:46 +01:00
/**
* Unbans a Player
*
2017-04-14 19:23:09 +02:00
* @api
2015-01-11 15:53:46 +01:00
* @param string $adminLogin
* @param string $targetLogin
*/
public function unBanPlayer($adminLogin, $targetLogin) {
$admin = $this->maniaControl->getPlayerManager()->getPlayer($adminLogin);
2015-07-29 22:07:52 +02:00
if (!$this->maniaControl->getAuthenticationManager()->checkPermission($admin, self::SETTING_PERMISSION_BAN_PLAYER)) {
2015-01-11 15:53:46 +01:00
$this->maniaControl->getAuthenticationManager()->sendNotAllowed($admin);
return;
}
2020-05-11 17:19:35 +02:00
$target = $this->maniaControl->getPlayerManager()->getPlayer($targetLogin);
if (!$target) {
return;
}
//Todo Validate (Problem: Not connected player isFakePlayer)
if ($target->isOfficial && $target->isFakePlayer()) {
$this->maniaControl->getChat()->sendError('It is not possible to unban a bot!', $admin);
return;
}
2015-01-11 16:00:55 +01:00
try {
$this->maniaControl->getClient()->unBan($targetLogin);
} catch (NotInListException $e) {
$this->maniaControl->getChat()->sendError('This player is not Banned!', $admin);
2015-01-11 15:53:46 +01:00
return;
}
$title = $admin->getAuthLevelName();
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
"{$title} %s unbanned %s!",
2020-05-30 22:42:39 +02:00
$admin,
$target
);
$this->maniaControl->getChat()->sendInformation($message);
Logger::logInfo($message, true);
2015-01-11 15:53:46 +01:00
}
2013-12-26 11:25:10 +01:00
/**
2013-12-31 16:01:22 +01:00
* Grands the Player an Authorization Level
*
2017-04-14 19:23:09 +02:00
* @api
2020-05-30 22:42:39 +02:00
* @deprecated
2013-12-31 16:01:22 +01:00
* @param string $adminLogin
* @param string $targetLogin
* @param int $authLevel
2013-12-26 11:25:10 +01:00
*/
2013-12-31 16:01:22 +01:00
public function grandAuthLevel($adminLogin, $targetLogin, $authLevel) {
2020-05-30 22:42:39 +02:00
$this->grantAuthLevel($adminLogin, $targetLogin, $authLevel);
}
/**
* Grants the Player an Authorization Level
*
* @api
* @param string $adminLogin
* @param string $targetLogin
* @param int $authLevel
*/
public function grantAuthLevel($adminLogin, $targetLogin, $authLevel) {
2014-08-13 11:05:52 +02:00
$admin = $this->maniaControl->getPlayerManager()->getPlayer($adminLogin);
$target = $this->maniaControl->getPlayerManager()->getPlayer($targetLogin);
2014-02-27 13:25:11 +01:00
if (!$admin || !$target) {
return;
2014-01-09 19:08:29 +01:00
}
2020-05-30 22:42:39 +02:00
$authLevelName = AuthenticationManager::getAuthLevelName($authLevel);
if (!AuthenticationManager::checkRight($admin, $authLevel + 1)) {
$this->maniaControl->getChat()->sendError("You do not have the permission to add a {$authLevelName}!", $admin);
return;
}
2020-05-30 22:42:39 +02:00
if (AuthenticationManager::checkRight($target, $authLevel)) {
2014-08-13 11:05:52 +02:00
$this->maniaControl->getChat()->sendError("This Player is already {$authLevelName}!", $admin);
return;
}
2014-08-13 11:05:52 +02:00
$success = $this->maniaControl->getAuthenticationManager()->grantAuthLevel($target, $authLevel);
2014-02-27 13:25:11 +01:00
if (!$success) {
2014-08-13 11:05:52 +02:00
$this->maniaControl->getChat()->sendError('Error occurred.', $admin);
2013-12-26 11:25:10 +01:00
return;
}
$title = $admin->getAuthLevelName();
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
"{$title} %s added %s as {$authLevelName}!",
2020-05-30 22:42:39 +02:00
$admin,
$target
);
$this->maniaControl->getChat()->sendInformation($message);
Logger::logInfo($message, true);
2013-12-26 11:25:10 +01:00
}
/**
2013-12-31 16:01:22 +01:00
* Revokes all Rights from the Player
*
2017-04-14 19:23:09 +02:00
* @api
2013-12-31 16:01:22 +01:00
* @param string $adminLogin
* @param string $targetLogin
2013-12-26 11:25:10 +01:00
*/
2013-12-31 16:01:22 +01:00
public function revokeAuthLevel($adminLogin, $targetLogin) {
2014-08-13 11:05:52 +02:00
$admin = $this->maniaControl->getPlayerManager()->getPlayer($adminLogin);
$target = $this->maniaControl->getPlayerManager()->getPlayer($targetLogin);
2014-02-27 13:25:11 +01:00
if (!$admin || !$target) {
return;
2014-01-09 19:08:29 +01:00
}
2020-05-30 22:42:39 +02:00
if ($admin->authLevel <= $target->authLevel) {
$this->maniaControl->getChat()->sendError("You cannot revoke the Rights of a {$target->getAuthLevelName()}!", $admin);
return;
}
2020-05-30 22:42:39 +02:00
if (AuthenticationManager::checkRight($target, AuthenticationManager::AUTH_LEVEL_MASTERADMIN)) {
$this->maniaControl->getChat()->sendError("MasterAdmins cannot be removed!", $admin);
2013-12-26 11:25:10 +01:00
return;
}
2014-08-13 11:05:52 +02:00
$success = $this->maniaControl->getAuthenticationManager()->grantAuthLevel($target, AuthenticationManager::AUTH_LEVEL_PLAYER);
2014-02-27 13:25:11 +01:00
if (!$success) {
2014-08-13 11:05:52 +02:00
$this->maniaControl->getChat()->sendError('Error occurred.', $admin);
2013-12-26 11:25:10 +01:00
return;
}
$title = $admin->getAuthLevelName();
2020-05-30 22:42:39 +02:00
$message = $this->maniaControl->getChat()->formatMessage(
"{$title} %s revoked the Rights of %s!",
2020-05-30 22:42:39 +02:00
$admin,
$target
);
$this->maniaControl->getChat()->sendInformation($message);
Logger::logInfo($message, true);
2013-12-26 11:25:10 +01:00
}
2015-06-26 13:06:05 +02:00
}