- Improved Join/Leave messages

- Moved Server Commands into separate class
- Added \Server namespace
This commit is contained in:
Steffen Schröder 2013-11-19 20:29:37 +01:00
parent b389b32d88
commit a9b1842a6f
8 changed files with 249 additions and 217 deletions

View File

@ -15,16 +15,13 @@ use ManiaControl\Players\Player;
*
* @author steeffeen & kremsy
*/
// TODO: settings for command auth levels
class CommandManager implements CallbackListener, CommandListener {
class CommandManager implements CallbackListener {
/**
* Private properties
*/
private $maniaControl = null;
private $commandListeners = array();
private $serverShutdownTime = -1;
private $serverShutdownEmpty = false;
/**
* Construct commands manager
@ -33,15 +30,7 @@ class CommandManager implements CallbackListener, CommandListener {
*/
public function __construct(ManiaControl $maniaControl) {
$this->maniaControl = $maniaControl;
$this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_MC_5_SECOND, $this, 'each5Seconds');
$this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_MP_PLAYERCHAT, $this, 'handleChatCallback');
// Register basic commands
$commands = array('version', 'shutdown', 'shutdownserver', 'systeminfo', 'setservername', 'kick');
foreach ($commands as $command) {
$this->registerCommandListener($command, $this, 'command_' . $command);
}
}
/**
@ -96,187 +85,6 @@ class CommandManager implements CallbackListener, CommandListener {
}
return true;
}
/**
* Send ManiaControl version
*
* @param array $chat
* @return bool
*/
private function command_version(array $chat) {
$login = $chat[1][1];
$message = 'This server is using ManiaControl v' . ManiaControl::VERSION . '!';
return $this->maniaControl->chat->sendInformation($message, $login);
}
/**
* Handle systeminfo command
*
* @param array $chat
* @param Player $player
* @return bool
*/
private function command_systeminfo(array $chat, Player $player) {
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_SUPERADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
return false;
}
$systemInfo = $this->maniaControl->server->getSystemInfo();
$message = 'SystemInfo: ip=' . $systemInfo['PublishedIp'] . ', port=' . $systemInfo['Port'] . ', p2pPort=' .
$systemInfo['P2PPort'] . ', title=' . $systemInfo['TitleId'] . ', login=' . $systemInfo['ServerLogin'] . ', ';
return $this->maniaControl->chat->sendInformation($message, $player->login);
}
/**
* Handle shutdown command
*
* @param array $chat
* @param Player $player
* @return bool
*/
private function command_shutdown(array $chat, Player $player) {
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_SUPERADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
return false;
}
return $this->maniaControl->quit("ManiaControl shutdown requested by '{$player->login}'");
}
/**
* Handle server shutdown command
*
* @param array $chat
* @param Player $player
* @return bool
*/
private function command_shutdownserver(array $chat, Player $player) {
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_SUPERADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
return false;
}
// Check for delayed shutdown
$params = explode(' ', $chat[1][2]);
if (count($params) >= 2) {
$param = $params[1];
if ($param == 'empty') {
$this->serverShutdownEmpty = !$this->serverShutdownEmpty;
if ($this->serverShutdownEmpty) {
$this->maniaControl->chat->sendInformation("The server will shutdown as soon as it's empty!", $player->login);
return true;
}
$this->maniaControl->chat->sendInformation("Empty-shutdown cancelled!", $player->login);
return true;
}
$delay = (int) $param;
if ($delay <= 0) {
// Cancel shutdown
$this->serverShutdownTime = -1;
$this->maniaControl->chat->sendInformation("Delayed shutdown cancelled!", $player->login);
return true;
}
// Trigger delayed shutdown
$this->serverShutdownTime = time() + $delay * 60.;
$this->maniaControl->chat->sendInformation("The server will shut down in {$delay} minutes!", $player->login);
return true;
}
return $this->shutdownServer($player->login);
}
/**
* Handle kick command
*
* @param array $chat
* @param Player $player
* @return bool
*/
private function command_kick(array $chat, Player $player) {
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_OPERATOR)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
return false;
}
$params = explode(' ', $chat[1][2], 3);
if (count($params) < 2) {
// TODO: show usage
return false;
}
$target = $params[1];
$target = $this->maniaControl->playerManager->getPlayer($target);
if (!$target) {
$this->maniaControl->chat->sendError("Invalid player login.", $player->login);
return false;
}
$message = '';
if (isset($params[2])) {
$message = $params[2];
}
return $this->maniaControl->client->query('Kick', $target->login, $message);
}
/**
* Handle setservername command
*
* @param array $chat
* @param Player $player
* @return bool
*/
private function command_setservername(array $chat, Player $player) {
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_ADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
return false;
}
$params = explode(' ', $chat[1][2], 2);
if (count($params) < 2) {
// TODO: show usage
return false;
}
$serverName = $params[1];
if (!$this->maniaControl->client->query('SetServerName', $serverName)) {
trigger_error("Couldn't set server name. " . $this->maniaControl->getClientErrorText());
$this->maniaControl->chat->sendError("Error setting server name!", $player->login);
return false;
}
$serverName = $this->maniaControl->server->getName();
$this->maniaControl->chat->sendInformation("New Name: " . $serverName, $player->login);
return true;
}
/**
* Check stuff each 5 seconds
*
* @param array $callback
* @return bool
*/
public function each5Seconds(array $callback) {
// Empty shutdown
if ($this->serverShutdownEmpty) {
$players = $this->maniaControl->server->getPlayers();
if (count($players) <= 0) {
return $this->shutdownServer('empty');
}
}
// Delayed shutdown
if ($this->serverShutdownTime > 0) {
if (time() >= $this->serverShutdownTime) {
return $this->shutdownServer('delayed');
}
}
}
/**
* Perform server shutdown
*
* @param string $login
* @return bool
*/
private function shutdownServer($login = '#') {
if (!$this->maniaControl->client->query('StopServer')) {
trigger_error("Server shutdown command from '{login}' failed. " . $this->maniaControl->getClientErrorText());
return false;
}
$this->maniaControl->quit("Server shutdown requested by '{$login}'");
return true;
}
}
?>

View File

@ -9,6 +9,7 @@ use ManiaControl\Manialinks\ManialinkIdHandler;
use ManiaControl\Maps\MapManager;
use ManiaControl\Players\PlayerManager;
use ManiaControl\Plugins\PluginManager;
use ManiaControl\Server\Server;
require_once __DIR__ . '/Callbacks/CallbackManager.php';
require_once __DIR__ . '/Commands/CommandManager.php';
@ -23,7 +24,7 @@ require_once __DIR__ . '/Maps/Map.php';
require_once __DIR__ . '/Maps/MapManager.php';
require_once __DIR__ . '/Players/PlayerManager.php';
require_once __DIR__ . '/Plugins/PluginManager.php';
require_once __DIR__ . '/Server.php';
require_once __DIR__ . '/Server/Server.php';
require_once __DIR__ . '/Settings/SettingManager.php';
require_once __DIR__ . '/GbxDataFetcher/gbxdatafetcher.inc.php';
require_once __DIR__ . '/ManiaExchange/mxinfofetcher.inc.php';
@ -63,7 +64,6 @@ class ManiaControl {
public $playerManager = null;
public $pluginManager = null;
public $server = null;
public $settingConfigurator = null;
public $settingManager = null;
/**
@ -80,8 +80,8 @@ class ManiaControl {
$this->manialinkIdHandler = new ManialinkIdHandler();
$this->settingManager = new SettingManager($this);
$this->chat = new Chat($this);
$this->server = new Server($this);
$this->commandManager = new CommandManager($this);
$this->server = new Server($this);
$this->authenticationManager = new AuthenticationManager($this);
$this->playerManager = new PlayerManager($this);
$this->mapManager = new MapManager($this);

View File

@ -20,11 +20,11 @@ class ManialinkIdHandler {
* @return array with manialink Ids
*/
public function reserveManiaLinkIds($count) {
$mlIds = array();
$manialinkIds = array();
for ($i = 0; $i < $count; $i++) {
array_push($mlIds, ++$this->maniaLinkIdCount);
array_push($manialinkIds, $this->maniaLinkIdCount++);
}
return $mlIds;
return $manialinkIds;
}
}

View File

@ -76,7 +76,7 @@ class MapCommands implements CommandListener {
// TODO: mx fetcher nutzen?
$params = explode(' ', $chat[1][2], 2);
if (count($params) < 2) {
// TODO: show usage
$this->maniaControl->chat->sendUsageInfo('Usage example: //addmap 1234', $player->login);
return false;
}
// Check if ManiaControl can even write to the maps dir

View File

@ -114,14 +114,12 @@ class PlayerManager implements CallbackListener {
if (!$this->maniaControl->settingManager->getSetting($this, self::SETTING_JOIN_LEAVE_MESSAGES)) {
return;
}
// TODO: improve styling?
$string = array(0 => 'New Player', 1 => '$0f0Operator', 2 => '$0f0Admin', 3 => '$0f0MasterAdmin', 4 => '$0f0MasterAdmin');
$nickname = Formatter::stripCodes($player->nickname);
$this->maniaControl->chat->sendChat(
'$ff0' . $string[$player->authLevel] . ': ' . $player->nickname . '$z $ff0Nation:$fff ' . $player->getCountry() .
'$ff0' . $string[$player->authLevel] . ': ' . $nickname . '$z $ff0Nation:$fff ' . $player->getCountry() .
' $ff0Ladder: $fff' . $player->ladderRank);
// TODO: remove $w, $l and stuff out of nick
// TODO: postfix playerConnect callBack as soon as needed
// TODO: Better style colours of the message or anything else
}
/**
@ -137,7 +135,7 @@ class PlayerManager implements CallbackListener {
return;
}
$played = Formatter::formatTimeH(time() - $player->joinTime);
$this->maniaControl->chat->sendChat('$<'.$player->nickname . '$> $ff0has left the game. Played:$fff ' . $played);
$this->maniaControl->chat->sendChat('$<' . $player->nickname . '$> $ff0has left the game. Played:$fff ' . $played);
}
/**

View File

@ -1,6 +1,11 @@
<?php
namespace ManiaControl;
namespace ManiaControl\Server;
use ManiaControl\FileUtil;
use ManiaControl\ManiaControl;
require_once __DIR__ . '/ServerCommands.php';
/**
* Class providing information and commands for the connected maniaplanet server
@ -8,11 +13,6 @@ namespace ManiaControl;
* @author steeffeen & kremsy
*/
class Server {
/**
* Constants
*/
const VALIDATIONREPLAYDIR = 'ValidationReplays/';
const GHOSTREPLAYDIR = 'GhostReplays/';
/**
* Public properties
@ -23,6 +23,7 @@ class Server {
* Private properties
*/
private $maniaControl = null;
private $serverCommands = null;
/**
* Construct server
@ -34,6 +35,8 @@ class Server {
// Load config
$this->config = FileUtil::loadConfig('server.xml');
$this->serverCommands = new ServerCommands($maniaControl);
}
/**
@ -249,16 +252,16 @@ class Server {
$map = $this->getMap();
$gameMode = $this->getGameMode();
$time = time();
$fileName = "Ghost.{$login}.{$gameMode}.{$time}.{$map['UId']}.Replay.Gbx";
$fileName = "GhostReplays/Ghost.{$login}.{$gameMode}.{$time}.{$map['UId']}.Replay.Gbx";
// Save ghost replay
if (!$this->maniaControl->client->query('SaveBestGhostsReplay', $player->login, self::GHOSTREPLAYDIR . $fileName)) {
if (!$this->maniaControl->client->query('SaveBestGhostsReplay', $player->login, $fileName)) {
trigger_error("Couldn't save ghost replay. " . $this->maniaControl->getClientErrorText());
return null;
}
// Load replay file
$ghostReplay = file_get_contents($dataDir . 'Replays/' . self::GHOSTREPLAYDIR . $fileName);
$ghostReplay = file_get_contents($dataDir . 'Replays/' . $fileName);
if (!$ghostReplay) {
trigger_error("Couldn't retrieve saved ghost replay.");
return null;

View File

@ -0,0 +1,225 @@
<?php
namespace ManiaControl\Server;
use ManiaControl\ManiaControl;
use ManiaControl\Admin\AuthenticationManager;
use ManiaControl\Callbacks\CallbackListener;
use ManiaControl\Callbacks\CallbackManager;
use ManiaControl\Commands\CommandListener;
use ManiaControl\Players\Player;
/**
* Class offering various commands related to the dedicated server
*
* @author steeffeen & kremsy
*/
class ServerCommands implements CallbackListener, CommandListener {
/**
* Private properties
*/
private $maniaControl = null;
private $serverShutdownTime = -1;
private $serverShutdownEmpty = false;
/**
* Create a new server commands instance
*
* @param ManiaControl $maniaControl
*/
public function __construct(ManiaControl $maniaControl) {
$this->maniaControl = $maniaControl;
$this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_MC_5_SECOND, $this, 'each5Seconds');
$this->maniaControl->commandManager->registerCommandListener('version', $this, 'command_Version');
$this->maniaControl->commandManager->registerCommandListener('/setservername', $this, 'command_SetServerName');
$this->maniaControl->commandManager->registerCommandListener('/kick', $this, 'command_Kick');
$this->maniaControl->commandManager->registerCommandListener('/systeminfo', $this, 'command_SystemInfo');
$this->maniaControl->commandManager->registerCommandListener('/shutdown', $this, 'command_Shutdown');
$this->maniaControl->commandManager->registerCommandListener('/shutdownserver', $this, 'command_ShutdownServer');
}
/**
* Check stuff each 5 seconds
*
* @param array $callback
* @return bool
*/
public function each5Seconds(array $callback) {
// Empty shutdown
if ($this->serverShutdownEmpty) {
$players = $this->maniaControl->server->getPlayers();
if (count($players) <= 0) {
return $this->shutdownServer('empty');
}
}
// Delayed shutdown
if ($this->serverShutdownTime > 0) {
if (time() >= $this->serverShutdownTime) {
return $this->shutdownServer('delayed');
}
}
}
/**
* Send ManiaControl version
*
* @param array $chat
* @return bool
*/
public function command_Version(array $chat) {
$login = $chat[1][1];
$message = 'This server is using ManiaControl v' . ManiaControl::VERSION . '!';
return $this->maniaControl->chat->sendInformation($message, $login);
}
/**
* Handle systeminfo command
*
* @param array $chat
* @param Player $player
* @return bool
*/
public function command_SystemInfo(array $chat, Player $player) {
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_SUPERADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
return false;
}
$systemInfo = $this->maniaControl->server->getSystemInfo();
$message = 'SystemInfo: ip=' . $systemInfo['PublishedIp'] . ', port=' . $systemInfo['Port'] . ', p2pPort=' .
$systemInfo['P2PPort'] . ', title=' . $systemInfo['TitleId'] . ', login=' . $systemInfo['ServerLogin'] . ', ';
return $this->maniaControl->chat->sendInformation($message, $player->login);
}
/**
* Handle shutdown command
*
* @param array $chat
* @param Player $player
* @return bool
*/
public function command_Shutdown(array $chat, Player $player) {
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_SUPERADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
return false;
}
return $this->maniaControl->quit("ManiaControl shutdown requested by '{$player->login}'");
}
/**
* Handle server shutdown command
*
* @param array $chat
* @param Player $player
* @return bool
*/
public function command_ShutdownServer(array $chat, Player $player) {
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_SUPERADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
return false;
}
// Check for delayed shutdown
$params = explode(' ', $chat[1][2]);
if (count($params) >= 2) {
$param = $params[1];
if ($param == 'empty') {
$this->serverShutdownEmpty = !$this->serverShutdownEmpty;
if ($this->serverShutdownEmpty) {
$this->maniaControl->chat->sendInformation("The server will shutdown as soon as it's empty!", $player->login);
return true;
}
$this->maniaControl->chat->sendInformation("Empty-shutdown cancelled!", $player->login);
return true;
}
$delay = (int) $param;
if ($delay <= 0) {
// Cancel shutdown
$this->serverShutdownTime = -1;
$this->maniaControl->chat->sendInformation("Delayed shutdown cancelled!", $player->login);
return true;
}
// Trigger delayed shutdown
$this->serverShutdownTime = time() + $delay * 60.;
$this->maniaControl->chat->sendInformation("The server will shut down in {$delay} minutes!", $player->login);
return true;
}
return $this->shutdownServer($player->login);
}
/**
* Handle kick command
*
* @param array $chat
* @param Player $player
* @return bool
*/
public function command_Kick(array $chat, Player $player) {
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_OPERATOR)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
return false;
}
$params = explode(' ', $chat[1][2], 3);
if (count($params) < 2) {
$this->maniaControl->chat->sendUsageInfo('Usage example: //kick login', $player->login);
return false;
}
$target = $params[1];
$target = $this->maniaControl->playerManager->getPlayer($target);
if (!$target) {
$this->maniaControl->chat->sendError("Invalid player login.", $player->login);
return false;
}
$message = '';
if (isset($params[2])) {
$message = $params[2];
}
return $this->maniaControl->client->query('Kick', $target->login, $message);
}
/**
* Handle setservername command
*
* @param array $chat
* @param Player $player
* @return bool
*/
public function command_SetServerName(array $chat, Player $player) {
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_ADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
return false;
}
$params = explode(' ', $chat[1][2], 2);
if (count($params) < 2) {
$this->maniaControl->chat->sendUsageInfo('Usage example: //setservername ManiaPlanet Server', $player->login);
return false;
}
$serverName = $params[1];
if (!$this->maniaControl->client->query('SetServerName', $serverName)) {
trigger_error("Couldn't set server name. " . $this->maniaControl->getClientErrorText());
$this->maniaControl->chat->sendError("Error setting server name!", $player->login);
return false;
}
$serverName = $this->maniaControl->server->getName();
$this->maniaControl->chat->sendInformation("New Name: " . $serverName, $player->login);
return true;
}
/**
* Perform server shutdown
*
* @param string $login
* @return bool
*/
private function shutdownServer($login = '#') {
if (!$this->maniaControl->client->query('StopServer')) {
trigger_error("Server shutdown command from '{login}' failed. " . $this->maniaControl->getClientErrorText());
return false;
}
$this->maniaControl->quit("Server shutdown requested by '{$login}'");
return true;
}
}
?>

View File

@ -36,9 +36,7 @@ class SettingManager {
*/
public function __construct(ManiaControl $maniaControl) {
$this->maniaControl = $maniaControl;
$this->initTables();
$this->configurator = new SettingConfigurator($maniaControl);
}