TrackManiaControl/application/core/Server/ServerCommands.php

372 lines
12 KiB
PHP
Raw Normal View History

<?php
namespace ManiaControl\Server;
use FML\Controls\Quads\Quad_Icons128x32_1;
2014-01-10 13:28:48 +01:00
use FML\Controls\Quads\Quad_Icons64x64_1;
use ManiaControl\Admin\AuthenticationManager;
use ManiaControl\Callbacks\CallbackListener;
use ManiaControl\Callbacks\CallbackManager;
2014-01-31 00:04:40 +01:00
use ManiaControl\Callbacks\TimerListener;
use ManiaControl\Commands\CommandListener;
2014-01-10 12:06:47 +01:00
use ManiaControl\ManiaControl;
use ManiaControl\Manialinks\ManialinkPageAnswerListener;
use ManiaControl\Players\Player;
2014-01-20 20:51:03 +01:00
use Maniaplanet\DedicatedServer\Xmlrpc\Exception;
/**
* Class offering various commands related to the dedicated server
*
* @author steeffeen & kremsy
*/
2014-01-31 00:04:40 +01:00
class ServerCommands implements CallbackListener, CommandListener, ManialinkPageAnswerListener, TimerListener {
/**
* Constants
*/
2014-01-10 13:28:48 +01:00
const ACTION_SET_PAUSE = 'ServerCommands.SetPause';
const ACTION_CANCEL_VOTE = 'ServerCommands.CancelVote';
const CB_VOTE_CANCELED = 'ServerCommands.VoteCanceled';
/**
* Private properties
*/
private $maniaControl = null;
private $serverShutdownTime = -1;
private $serverShutdownEmpty = false;
/**
* Create a new server commands instance
*
2014-01-01 19:25:51 +01:00
* @param ManiaControl $maniaControl
*/
public function __construct(ManiaControl $maniaControl) {
$this->maniaControl = $maniaControl;
2014-01-10 12:06:47 +01:00
2013-12-05 00:30:10 +01:00
// Register for callbacks
2014-01-31 00:04:40 +01:00
$this->maniaControl->timerManager->registerTimerListening($this, 'each5Seconds', 5000);
2014-01-14 20:09:27 +01:00
$this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_MC_ONINIT, $this, 'handleOnInit');
2014-01-10 12:06:47 +01:00
2013-12-05 00:30:10 +01:00
// Register for commands
2014-01-01 19:25:51 +01:00
$this->maniaControl->commandManager->registerCommandListener('setpwd', $this, 'command_SetPwd', true);
$this->maniaControl->commandManager->registerCommandListener('setservername', $this, 'command_SetServerName', true);
$this->maniaControl->commandManager->registerCommandListener('setmaxplayers', $this, 'command_SetMaxPlayers', true);
$this->maniaControl->commandManager->registerCommandListener('setmaxspectators', $this, 'command_SetMaxSpectators', true);
$this->maniaControl->commandManager->registerCommandListener('setspecpwd', $this, 'command_SetSpecPwd', true);
$this->maniaControl->commandManager->registerCommandListener('shutdownserver', $this, 'command_ShutdownServer', true);
$this->maniaControl->commandManager->registerCommandListener('systeminfo', $this, 'command_SystemInfo', true);
2014-01-10 13:28:48 +01:00
$this->maniaControl->commandManager->registerCommandListener('cancel', $this, 'command_CancelVote', true);
$this->maniaControl->manialinkManager->registerManialinkPageAnswerListener(self::ACTION_SET_PAUSE, $this, 'setPause');
2014-01-14 20:09:27 +01:00
}
2014-01-14 20:09:27 +01:00
/**
* Set Menu items on init
*
* @param array $callback
*/
public function handleOnInit(array $callback) {
//Check if Pause exists in current gamemode
2014-01-16 18:08:32 +01:00
$scriptInfos = $this->maniaControl->client->getModeScriptInfo();
2014-01-14 20:09:27 +01:00
$pauseExists = false;
2014-01-20 09:24:17 +01:00
foreach($scriptInfos->commandDescs as $param) {
2014-01-31 00:04:40 +01:00
if ($param->name == "Command_ForceWarmUp") {
2014-01-14 20:09:27 +01:00
$pauseExists = true;
break;
}
2014-01-20 09:24:17 +01:00
}
2014-01-16 18:08:32 +01:00
// Set Pause
2014-01-31 00:04:40 +01:00
if ($pauseExists) {
2014-01-14 20:09:27 +01:00
$itemQuad = new Quad_Icons128x32_1();
$itemQuad->setSubStyle($itemQuad::SUBSTYLE_ManiaLinkSwitch);
$itemQuad->setAction(self::ACTION_SET_PAUSE);
$this->maniaControl->actionsMenu->addAdminMenuItem($itemQuad, 1, 'Pauses the current game');
}
2014-01-10 13:28:48 +01:00
// Action cancel Vote
$this->maniaControl->manialinkManager->registerManialinkPageAnswerListener(self::ACTION_CANCEL_VOTE, $this, 'command_cancelVote');
$itemQuad = new Quad_Icons64x64_1();
$itemQuad->setSubStyle($itemQuad::SUBSTYLE_ArrowRed);
$itemQuad->setAction(self::ACTION_CANCEL_VOTE);
$this->maniaControl->actionsMenu->addMenuItem($itemQuad, false, 6, 'Cancel Vote');
}
/**
* Handle //cancelvote command
*
* @param array $chatCallback
* @param Player $player
*/
public function command_CancelVote(array $chatCallback, Player $player) {
2014-01-31 00:04:40 +01:00
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_MODERATOR)) {
2014-01-10 13:28:48 +01:00
$this->maniaControl->authenticationManager->sendNotAllowed($player);
return;
}
2014-01-16 19:49:36 +01:00
$this->maniaControl->client->cancelVote();
2014-01-10 13:28:48 +01:00
$this->maniaControl->chat->sendInformation('$<' . $player->nickname . '$> canceled the Vote!');
// Trigger callback
$this->maniaControl->callbackManager->triggerCallback(self::CB_VOTE_CANCELED, array(self::CB_VOTE_CANCELED, $player));
}
/**
* Breaks the current game
2014-01-10 12:06:47 +01:00
*
* @param array $callback
*/
2014-01-10 12:06:47 +01:00
public function setPause(array $callback) {
2014-01-16 18:08:32 +01:00
$success = $this->maniaControl->client->sendModeScriptCommands(array('Command_ForceWarmUp' => True));
2014-01-31 00:04:40 +01:00
if (!$success) {
2014-01-10 12:06:47 +01:00
$this->maniaControl->chat->sendError("Error while setting the pause");
}
}
/**
* Check stuff each 5 seconds
*
2014-01-31 00:04:40 +01:00
* @param $timer
* @return bool
*/
2014-01-31 00:04:40 +01:00
public function each5Seconds($timer) {
// Empty shutdown
2014-01-31 00:04:40 +01:00
if ($this->serverShutdownEmpty) {
$players = $this->maniaControl->playerManager->getPlayers();
2014-01-31 00:04:40 +01:00
if (count($players) <= 0) {
2013-12-05 00:30:10 +01:00
$this->shutdownServer('empty');
}
}
2014-01-10 12:06:47 +01:00
// Delayed shutdown
2014-01-31 00:04:40 +01:00
if ($this->serverShutdownTime > 0) {
if (time() >= $this->serverShutdownTime) {
2013-12-05 00:30:10 +01:00
$this->shutdownServer('delayed');
}
}
}
/**
* Handle //systeminfo command
*
2014-01-10 12:06:47 +01:00
* @param array $chat
2014-01-01 19:25:51 +01:00
* @param Player $player
*/
public function command_SystemInfo(array $chat, Player $player) {
2014-01-31 00:04:40 +01:00
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_SUPERADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
2013-12-05 00:30:10 +01:00
return;
}
$systemInfo = $this->maniaControl->server->getSystemInfo();
2014-01-23 17:47:21 +01:00
$message = 'SystemInfo: ip=' . $systemInfo->publishedIp . ', port=' . $systemInfo->port . ', p2pPort=' . $systemInfo->p2PPort . ', title=' . $systemInfo->titleId . ', login=' . $systemInfo->serverLogin . '.';
2013-12-05 00:30:10 +01:00
$this->maniaControl->chat->sendInformation($message, $player->login);
}
/**
* Handle //shutdownserver command
*
2014-01-10 12:06:47 +01:00
* @param array $chat
2014-01-01 19:25:51 +01:00
* @param Player $player
*/
public function command_ShutdownServer(array $chat, Player $player) {
2014-01-31 00:04:40 +01:00
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_SUPERADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
2013-12-05 00:30:10 +01:00
return;
}
// Check for delayed shutdown
$params = explode(' ', $chat[1][2]);
2014-01-31 00:04:40 +01:00
if (count($params) >= 2) {
$param = $params[1];
2014-01-31 00:04:40 +01:00
if ($param == 'empty') {
$this->serverShutdownEmpty = !$this->serverShutdownEmpty;
2014-01-31 00:04:40 +01:00
if ($this->serverShutdownEmpty) {
$this->maniaControl->chat->sendInformation("The server will shutdown as soon as it's empty!", $player->login);
2013-12-05 00:30:10 +01:00
return;
}
$this->maniaControl->chat->sendInformation("Empty-shutdown cancelled!", $player->login);
2013-12-05 00:30:10 +01:00
return;
}
2014-01-10 12:06:47 +01:00
$delay = (int)$param;
2014-01-31 00:04:40 +01:00
if ($delay <= 0) {
// Cancel shutdown
$this->serverShutdownTime = -1;
$this->maniaControl->chat->sendInformation("Delayed shutdown cancelled!", $player->login);
2013-12-05 00:30:10 +01:00
return;
}
// Trigger delayed shutdown
$this->serverShutdownTime = time() + $delay * 60.;
$this->maniaControl->chat->sendInformation("The server will shut down in {$delay} minutes!", $player->login);
2013-12-05 00:30:10 +01:00
return;
}
2013-12-05 00:30:10 +01:00
$this->shutdownServer($player->login);
}
/**
* Handle //setservername command
*
2014-01-10 12:06:47 +01:00
* @param array $chat
2014-01-01 19:25:51 +01:00
* @param Player $player
*/
public function command_SetServerName(array $chat, Player $player) {
2014-01-31 00:04:40 +01:00
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_ADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
2013-12-05 00:30:10 +01:00
return;
}
$params = explode(' ', $chat[1][2], 2);
2014-01-31 00:04:40 +01:00
if (count($params) < 2) {
$this->maniaControl->chat->sendUsageInfo('Usage example: //setservername ManiaPlanet Server', $player->login);
2013-12-05 00:30:10 +01:00
return;
}
$serverName = $params[1];
2014-01-20 20:51:03 +01:00
try {
$this->maniaControl->client->setServerName($serverName);
} catch(Exception $e) {
$this->maniaControl->chat->sendError('Error occurred: ' . $e->getMessage(), $player->login);
2013-12-05 00:30:10 +01:00
return;
}
$this->maniaControl->chat->sendSuccess("Server name changed to: '{$serverName}'!", $player->login);
}
/**
* Handle //setpwd command
*
2014-01-10 12:06:47 +01:00
* @param array $chatCallback
2014-01-01 19:25:51 +01:00
* @param Player $player
*/
public function command_SetPwd(array $chatCallback, Player $player) {
2014-01-31 00:04:40 +01:00
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_ADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
2013-12-05 00:30:10 +01:00
return;
}
2014-01-10 12:06:47 +01:00
$messageParts = explode(' ', $chatCallback[1][2], 2);
$password = '';
$successMessage = 'Password removed!';
2014-01-31 00:04:40 +01:00
if (isset($messageParts[1])) {
2014-01-10 12:06:47 +01:00
$password = $messageParts[1];
$successMessage = "Password changed to: '{$password}'!";
}
2014-01-20 20:51:03 +01:00
try {
$this->maniaControl->client->setServerPassword($password);
} catch(Exception $e) {
$this->maniaControl->chat->sendError('Error occurred: ' . $e->getMessage(), $player->login);
2013-12-05 00:30:10 +01:00
return;
}
$this->maniaControl->chat->sendSuccess($successMessage, $player->login);
}
/**
* Handle //setspecpwd command
*
2014-01-10 12:06:47 +01:00
* @param array $chatCallback
2014-01-01 19:25:51 +01:00
* @param Player $player
*/
public function command_SetSpecPwd(array $chatCallback, Player $player) {
2014-01-31 00:04:40 +01:00
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_ADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
2013-12-05 00:30:10 +01:00
return;
}
2014-01-10 12:06:47 +01:00
$messageParts = explode(' ', $chatCallback[1][2], 2);
$password = '';
$successMessage = 'Spectator password removed!';
2014-01-31 00:04:40 +01:00
if (isset($messageParts[1])) {
2014-01-10 12:06:47 +01:00
$password = $messageParts[1];
$successMessage = "Spectator password changed to: '{$password}'!";
}
2014-01-20 20:51:03 +01:00
try {
$this->maniaControl->client->setServerPasswordForSpectator($password);
} catch(Exception $e) {
$this->maniaControl->chat->sendError('Error occurred: ' . $e->getMessage(), $player->login);
2013-12-05 00:30:10 +01:00
return;
}
$this->maniaControl->chat->sendSuccess($successMessage, $player->login);
}
/**
* Handle //setmaxplayers command
*
2014-01-10 12:06:47 +01:00
* @param array $chatCallback
2014-01-01 19:25:51 +01:00
* @param Player $player
*/
public function command_SetMaxPlayers(array $chatCallback, Player $player) {
2014-01-31 00:04:40 +01:00
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_ADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
2013-12-05 00:30:10 +01:00
return;
}
$messageParts = explode(' ', $chatCallback[1][2], 2);
2014-01-31 00:04:40 +01:00
if (!isset($messageParts[1])) {
$this->maniaControl->chat->sendUsageInfo('Usage example: //setmaxplayers 16', $player->login);
2013-12-05 00:30:10 +01:00
return;
}
$amount = $messageParts[1];
2014-01-31 00:04:40 +01:00
if (!is_numeric($amount)) {
$this->maniaControl->chat->sendUsageInfo('Usage example: //setmaxplayers 16', $player->login);
2013-12-05 00:30:10 +01:00
return;
}
2014-01-10 12:06:47 +01:00
$amount = (int)$amount;
2014-01-31 00:04:40 +01:00
if ($amount < 0) {
$amount = 0;
}
2014-01-20 20:51:03 +01:00
try {
$this->maniaControl->client->setMaxPlayers($amount);
} catch(Exception $e) {
$this->maniaControl->chat->sendError('Error occurred: ' . $e->getMessage(), $player->login);
2013-12-05 00:30:10 +01:00
return;
}
2014-01-20 20:51:03 +01:00
$this->maniaControl->chat->sendSuccess("Changed max players to: {$amount}", $player->login);
}
/**
* Handle //setmaxspectators command
*
2014-01-10 12:06:47 +01:00
* @param array $chatCallback
2014-01-01 19:25:51 +01:00
* @param Player $player
*/
public function command_SetMaxSpectators(array $chatCallback, Player $player) {
2014-01-31 00:04:40 +01:00
if (!$this->maniaControl->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_ADMIN)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
2013-12-05 00:30:10 +01:00
return;
}
$messageParts = explode(' ', $chatCallback[1][2], 2);
2014-01-31 00:04:40 +01:00
if (!isset($messageParts[1])) {
$this->maniaControl->chat->sendUsageInfo('Usage example: //setmaxspectators 16', $player->login);
2013-12-05 00:30:10 +01:00
return;
}
$amount = $messageParts[1];
2014-01-31 00:04:40 +01:00
if (!is_numeric($amount)) {
$this->maniaControl->chat->sendUsageInfo('Usage example: //setmaxspectators 16', $player->login);
2013-12-05 00:30:10 +01:00
return;
}
2014-01-10 12:06:47 +01:00
$amount = (int)$amount;
2014-01-31 00:04:40 +01:00
if ($amount < 0) {
$amount = 0;
}
2014-01-20 20:51:03 +01:00
try {
$this->maniaControl->client->setMaxSpectators($amount);
} catch(Exception $e) {
$this->maniaControl->chat->sendError('Error occurred: ' . $e->getMessage(), $player->login);
2013-12-05 00:30:10 +01:00
return;
}
$this->maniaControl->chat->sendSuccess("Changed max spectators to: {$amount}", $player->login);
2013-12-05 00:30:10 +01:00
}
/**
* Perform server shutdown
*
2014-01-01 19:25:51 +01:00
* @param string $login
* @return bool
*/
private function shutdownServer($login = '#') {
2014-01-20 20:51:03 +01:00
try {
$this->maniaControl->client->stopServer();
} catch(Exception $e) {
2014-01-21 19:36:09 +01:00
trigger_error("Server shutdown command from '{login}' failed. " . $e->getMessage());
return false;
}
$this->maniaControl->quit("Server shutdown requested by '{$login}'");
return true;
}
}