- Improved Join/Leave messages
- Moved Server Commands into separate class - Added \Server namespace
This commit is contained in:
Steffen Schröder
311
application/core/Server/Server.php
Normal file
311
application/core/Server/Server.php
Normal file
@ -0,0 +1,311 @@
|
||||
<?php
|
||||
|
||||
namespace ManiaControl\Server;
|
||||
|
||||
use ManiaControl\FileUtil;
|
||||
use ManiaControl\ManiaControl;
|
||||
|
||||
require_once __DIR__ . '/ServerCommands.php';
|
||||
|
||||
/**
|
||||
* Class providing information and commands for the connected maniaplanet server
|
||||
*
|
||||
* @author steeffeen & kremsy
|
||||
*/
|
||||
class Server {
|
||||
|
||||
/**
|
||||
* Public properties
|
||||
*/
|
||||
public $config = null;
|
||||
|
||||
/**
|
||||
* Private properties
|
||||
*/
|
||||
private $maniaControl = null;
|
||||
private $serverCommands = null;
|
||||
|
||||
/**
|
||||
* Construct server
|
||||
*
|
||||
* @param ManiaControl $maniaControl
|
||||
*/
|
||||
public function __construct(ManiaControl $maniaControl) {
|
||||
$this->maniaControl = $maniaControl;
|
||||
|
||||
// Load config
|
||||
$this->config = FileUtil::loadConfig('server.xml');
|
||||
|
||||
$this->serverCommands = new ServerCommands($maniaControl);
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch game data directory
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getDataDirectory() {
|
||||
if (!$this->maniaControl->client->query('GameDataDirectory')) {
|
||||
trigger_error("Couldn't get data directory. " . $this->maniaControl->getClientErrorText());
|
||||
return null;
|
||||
}
|
||||
return $this->maniaControl->client->getResponse();
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch maps directory
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getMapsDirectory() {
|
||||
$dataDirectory = $this->getDataDirectory();
|
||||
if (!$dataDirectory) {
|
||||
return null;
|
||||
}
|
||||
return $dataDirectory . 'Maps/';
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if ManiaControl has access to the given directory
|
||||
*
|
||||
* @param string $directory
|
||||
* @return bool
|
||||
*/
|
||||
public function checkAccess($directory) {
|
||||
if (!$directory) {
|
||||
return false;
|
||||
}
|
||||
return (is_dir($directory) && is_writable($directory));
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch server login
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getLogin() {
|
||||
$systemInfo = $this->getSystemInfo();
|
||||
if (!$systemInfo) {
|
||||
return null;
|
||||
}
|
||||
return $systemInfo['ServerLogin'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get server info
|
||||
*
|
||||
* @param bool $detailed
|
||||
* @return array
|
||||
*/
|
||||
public function getInfo($detailed = false) {
|
||||
if ($detailed) {
|
||||
$login = $this->getLogin();
|
||||
if (!$this->maniaControl->client->query('GetDetailedPlayerInfo', $login)) {
|
||||
trigger_error("Couldn't fetch detailed server info. " . $this->maniaControl->getClientErrorText());
|
||||
return null;
|
||||
}
|
||||
return $this->maniaControl->client->getResponse();
|
||||
}
|
||||
if (!$this->maniaControl->client->query('GetMainServerPlayerInfo')) {
|
||||
trigger_error("Couldn't fetch server info. " . $this->maniaControl->getClientErrorText());
|
||||
return null;
|
||||
}
|
||||
return $this->maniaControl->client->getResponse();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get server options
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getOptions() {
|
||||
if (!$this->maniaControl->client->query('GetServerOptions')) {
|
||||
trigger_error("Couldn't fetch server options. " . $this->maniaControl->getClientErrorText());
|
||||
return null;
|
||||
}
|
||||
return $this->maniaControl->client->getResponse();
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch server name
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getName() {
|
||||
if (!$this->maniaControl->client->query('GetServerName')) {
|
||||
trigger_error("Couldn't fetch server name. " . $this->maniaControl->getClientErrorText());
|
||||
return null;
|
||||
}
|
||||
return $this->maniaControl->client->getResponse();
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch server version
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getVersion() {
|
||||
if (!$this->maniaControl->client->query('GetVersion')) {
|
||||
trigger_error("Couldn't fetch server version. " . $this->maniaControl->getClientErrorText());
|
||||
return null;
|
||||
}
|
||||
return $this->maniaControl->client->getResponse();
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch server system info
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getSystemInfo() {
|
||||
if (!$this->maniaControl->client->query('GetSystemInfo')) {
|
||||
trigger_error("Couldn't fetch server system info. " . $this->maniaControl->getClientErrorText($client));
|
||||
return null;
|
||||
}
|
||||
return $this->maniaControl->client->getResponse();
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch current game mode
|
||||
*
|
||||
* @param bool $stringValue
|
||||
* @param int $parseValue
|
||||
* @return int | string
|
||||
*/
|
||||
public function getGameMode($stringValue = false, $parseValue = null) {
|
||||
if (is_int($parseValue)) {
|
||||
$gameMode = $parseValue;
|
||||
}
|
||||
else {
|
||||
if (!$this->maniaControl->client->query('GetGameMode')) {
|
||||
trigger_error("Couldn't fetch current game mode. " . $this->maniaControl->getClientErrorText());
|
||||
return null;
|
||||
}
|
||||
$gameMode = $this->maniaControl->client->getResponse();
|
||||
}
|
||||
if ($stringValue) {
|
||||
switch ($gameMode) {
|
||||
case 0:
|
||||
{
|
||||
return 'Script';
|
||||
}
|
||||
case 1:
|
||||
{
|
||||
return 'Rounds';
|
||||
}
|
||||
case 2:
|
||||
{
|
||||
return 'TimeAttack';
|
||||
}
|
||||
case 3:
|
||||
{
|
||||
return 'Team';
|
||||
}
|
||||
case 4:
|
||||
{
|
||||
return 'Laps';
|
||||
}
|
||||
case 5:
|
||||
{
|
||||
return 'Cup';
|
||||
}
|
||||
case 6:
|
||||
{
|
||||
return 'Stunts';
|
||||
}
|
||||
default:
|
||||
{
|
||||
return 'Unknown';
|
||||
}
|
||||
}
|
||||
}
|
||||
return $gameMode;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve validation replay for given player
|
||||
*
|
||||
* @param Player $player
|
||||
* @return string
|
||||
*/
|
||||
public function getValidationReplay(Player $player) {
|
||||
if (!$this->maniaControl->client->query('GetValidationReplay', $player->login)) {
|
||||
trigger_error("Couldn't get validation replay of '{$player->login}'. " . $this->maniaControl->getClientErrorText());
|
||||
return null;
|
||||
}
|
||||
return $this->maniaControl->client->getResponse();
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve ghost replay for the given player
|
||||
*
|
||||
* @param Player $player
|
||||
* @return string
|
||||
*/
|
||||
public function getGhostReplay(Player $player) {
|
||||
$dataDir = $this->getDataDirectory();
|
||||
if (!$this->checkAccess($dataDir)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// Build file name
|
||||
$map = $this->getMap();
|
||||
$gameMode = $this->getGameMode();
|
||||
$time = time();
|
||||
$fileName = "GhostReplays/Ghost.{$login}.{$gameMode}.{$time}.{$map['UId']}.Replay.Gbx";
|
||||
|
||||
// Save ghost replay
|
||||
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/' . $fileName);
|
||||
if (!$ghostReplay) {
|
||||
trigger_error("Couldn't retrieve saved ghost replay.");
|
||||
return null;
|
||||
}
|
||||
return $ghostReplay;
|
||||
}
|
||||
|
||||
/**
|
||||
* Waits for the server to have the given status
|
||||
*
|
||||
* @param int $statusCode
|
||||
* @return bool
|
||||
*/
|
||||
public function waitForStatus($statusCode = 4) {
|
||||
$this->maniaControl->client->query('GetStatus');
|
||||
$response = $this->maniaControl->client->getResponse();
|
||||
// Check if server has the given status
|
||||
if ($response['Code'] === 4) {
|
||||
return true;
|
||||
}
|
||||
// Server not yet in given status -> Wait for it...
|
||||
$waitBegin = time();
|
||||
$maxWaitTime = 20;
|
||||
$lastStatus = $response['Name'];
|
||||
error_log("Waiting for server to reach status {$statusCode}...");
|
||||
error_log("Current Status: {$lastStatus}");
|
||||
while ($response['Code'] !== 4) {
|
||||
sleep(1);
|
||||
$this->maniaControl->client->query('GetStatus');
|
||||
$response = $this->maniaControl->client->getResponse();
|
||||
if ($lastStatus !== $response['Name']) {
|
||||
error_log("New Status: " . $response['Name']);
|
||||
$lastStatus = $response['Name'];
|
||||
}
|
||||
if (time() - $maxWaitTime > $waitBegin) {
|
||||
// It took too long to reach the status
|
||||
trigger_error(
|
||||
"Server couldn't reach status {$statusCode} after {$maxWaitTime} seconds! " .
|
||||
$this->maniaControl->getClientErrorText());
|
||||
return false;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
?>
|
||||
225
application/core/Server/ServerCommands.php
Normal file
225
application/core/Server/ServerCommands.php
Normal 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;
|
||||
}
|
||||
}
|
||||
|
||||
?>
|
||||
Reference in New Issue
Block a user