beu/TrackManiaControl
1
0
Fork 0
Code Issues 10 Pull Requests Releases Wiki Activity

applied common formatting

Browse Source
This commit is contained in:
Steffen Schröder
2014-05-02 17:50:30 +02:00
parent ba720f46bf
commit a0f5421bea
48 changed files with 3539 additions and 3595 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
application/core/Server/Config.php
View File

@ -5,9 +5,9 @@ namespace ManiaControl\Server;
/**
* Model Class holding the Server Config
*
* @author steeffeen
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class Config {
/*
@ -22,17 +22,17 @@ class Config {
/**
* Create a new Server Config Instance
*
* @param string $id Config Id
* @param string $host Server Ip
* @param string $port Server Port
* @param string $id Config Id
* @param string $host Server Ip
* @param string $port Server Port
* @param string $login XmlRpc Login
* @param string $pass XmlRpc Password
* @param string $pass XmlRpc Password
*/
public function __construct($id = null, $host = null, $port = null, $login = null, $pass = null) {
$this->id = $id;
$this->host = $host;
$this->port = $port;
$this->id = $id;
$this->host = $host;
$this->port = $port;
$this->login = $login;
$this->pass = $pass;
$this->pass = $pass;
}
}

31
application/core/Server/RankingManager.php
View File

@ -11,8 +11,8 @@ use Maniaplanet\DedicatedServer\Xmlrpc\NotInScriptModeException;
/**
* Class managing Rankings
*
* @author kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class RankingManager implements CallbackListener {
@ -42,20 +42,10 @@ class RankingManager implements CallbackListener {
public function onInit() {
try {
$this->maniaControl->client->triggerModeScriptEvent('LibXmlRpc_GetRankings', '');
} catch(NotInScriptModeException $e) {
} catch (NotInScriptModeException $e) {
}
}
/**
* Get Rankings
*
* @return array
*/
public function getRankings() {
return $this->rankings;
}
/**
* Handle stats on callbacks (never call this Method)
*
@ -65,7 +55,7 @@ class RankingManager implements CallbackListener {
$callbackName = $callback[1][0];
//TODO not tested in TrackMania
switch($callbackName) {
switch ($callbackName) {
case 'updateRankings':
$this->updateRankings($callback[1][1][0]);
break;
@ -89,7 +79,7 @@ class RankingManager implements CallbackListener {
}
$scores = explode(';', $data);
foreach($scores as $player) {
foreach ($scores as $player) {
if (strpos($player, ':') !== false) {
$tmp = explode(':', $player);
$this->rankings[$tmp[0]] = $tmp[1];
@ -101,6 +91,15 @@ class RankingManager implements CallbackListener {
$this->maniaControl->callbackManager->triggerCallback(Callbacks::RANKINGSUPDATED, $this->getRankings());
}
/**
* Get Rankings
*
* @return array
*/
public function getRankings() {
return $this->rankings;
}
/**
* Get the Current Leading Players (as Login Array)
*
@ -109,7 +108,7 @@ class RankingManager implements CallbackListener {
public function getLeaders() {
$leaders = array();
$prev = -1;
foreach($this->rankings as $score) {
foreach ($this->rankings as $score) {
if ($prev != -1 && $prev < $score) {
return $leaders;
}

359
application/core/Server/Server.php
View File

@ -4,29 +4,28 @@ namespace ManiaControl\Server;
use ManiaControl\Callbacks\CallbackListener;
use ManiaControl\Callbacks\CallbackManager;
use ManiaControl\CommandLineHelper;
use ManiaControl\ManiaControl;
use Maniaplanet\DedicatedServer\Xmlrpc\Exception;
use ManiaControl\CommandLineHelper;
/**
* Class providing Access to the connected ManiaPlanet Server
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class Server implements CallbackListener {
/*
* Constants
*/
const TABLE_SERVERS = 'mc_servers';
const TABLE_SERVERS = 'mc_servers';
const CB_TEAM_MODE_CHANGED = 'ServerCallback.TeamModeChanged';
/*
* Public Properties
*/
/**
*
* @var Config $config
*/
public $config = null;
@ -40,7 +39,7 @@ class Server implements CallbackListener {
public $serverCommands = null;
public $usageReporter = null;
public $rankingManager = null;
/*
* Private Properties
*/
@ -49,28 +48,55 @@ class Server implements CallbackListener {
/**
* Construct a new Server
*
*
* @param ManiaControl $maniaControl
*/
public function __construct(ManiaControl $maniaControl) {
$this->maniaControl = $maniaControl;
$this->initTables();
$this->serverCommands = new ServerCommands($maniaControl);
$this->usageReporter = new UsageReporter($maniaControl);
$this->usageReporter = new UsageReporter($maniaControl);
$this->rankingManager = new RankingManager($maniaControl);
// Register for callbacks
$this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_ONINIT, $this, 'onInit');
}
/**
* Initialize necessary Database Tables
*
* @return bool
*/
private function initTables() {
$mysqli = $this->maniaControl->database->mysqli;
$query = "CREATE TABLE IF NOT EXISTS `" . self::TABLE_SERVERS . "` (
`index` int(11) NOT NULL AUTO_INCREMENT,
`login` varchar(100) NOT NULL,
PRIMARY KEY (`index`),
UNIQUE KEY `login` (`login`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci COMMENT='Servers' AUTO_INCREMENT=1;";
$statement = $mysqli->prepare($query);
if ($mysqli->error) {
trigger_error($mysqli->error, E_USER_ERROR);
return false;
}
$statement->execute();
if ($statement->error) {
trigger_error($statement->error, E_USER_ERROR);
return false;
}
$statement->close();
return true;
}
/**
* Load the Server Configuration from the Config XML
*/
public function loadConfig() {
// Server id parameter
$serverId = CommandLineHelper::getParameter('-id');
// Xml server tag with given id
$serverTag = null;
if ($serverId) {
@ -81,8 +107,7 @@ class Server implements CallbackListener {
if (!$serverTag) {
trigger_error("No Server configured with the ID '{$serverId}'!", E_USER_ERROR);
}
}
else {
} else {
$serverTags = $this->maniaControl->config->xpath('server');
if ($serverTags) {
$serverTag = $serverTags[0];
@ -91,62 +116,92 @@ class Server implements CallbackListener {
trigger_error('No Server configured!', E_USER_ERROR);
}
}
// Host
$host = $serverTag->xpath('host');
if ($host) {
$host = (string) $host[0];
$host = (string)$host[0];
}
if (!$host) {
trigger_error("Invalid server configuration (host).", E_USER_ERROR);
}
// Port
$port = $serverTag->xpath('port');
if ($port) {
$port = (string) $port[0];
$port = (string)$port[0];
}
if (!$port) {
trigger_error("Invalid server configuration (port).", E_USER_ERROR);
}
// Login
$login = $serverTag->xpath('login');
if ($login) {
$login = (string) $login[0];
$login = (string)$login[0];
}
if (!$login) {
trigger_error("Invalid server configuration (login).", E_USER_ERROR);
}
// Password
$pass = $serverTag->xpath('pass');
if ($pass) {
$pass = (string) $pass[0];
$pass = (string)$pass[0];
}
if (!$pass) {
trigger_error("Invalid server configuration (password).", E_USER_ERROR);
}
// Create config object
$this->config = new Config($serverId, $host, $port, $login, $pass);
}
/**
* Gets all Servers from the Database
*
* @return array
*/
public function getAllServers() {
$mysqli = $this->maniaControl->database->mysqli;
$query = "SELECT * FROM `" . self::TABLE_SERVERS . "`";
$result = $mysqli->query($query);
if (!$result) {
trigger_error($mysqli->error);
return array();
}
$servers = array();
while ($row = $result->fetch_object()) {
array_push($servers, $row);
}
$result->close();
return $servers;
}
/**
* Handle OnInit Callback
*/
public function onInit() {
$this->updateProperties();
}
/**
* Refetch the Server Properties
*/
private function updateProperties() {
// System info
$systemInfo = $this->maniaControl->client->getSystemInfo();
$this->ip = $systemInfo->publishedIp;
$this->port = $systemInfo->port;
$systemInfo = $this->maniaControl->client->getSystemInfo();
$this->ip = $systemInfo->publishedIp;
$this->port = $systemInfo->port;
$this->p2pPort = $systemInfo->p2PPort;
$this->login = $systemInfo->serverLogin;
$this->login = $systemInfo->serverLogin;
$this->titleId = $systemInfo->titleId;
// Database index
$mysqli = $this->maniaControl->database->mysqli;
$query = "INSERT INTO `" . self::TABLE_SERVERS . "` (
$mysqli = $this->maniaControl->database->mysqli;
$query = "INSERT INTO `" . self::TABLE_SERVERS . "` (
`login`
) VALUES (
?
@ -168,72 +223,15 @@ class Server implements CallbackListener {
$statement->close();
}
/**
* Initialize necessary Database Tables
*
* @return bool
*/
private function initTables() {
$mysqli = $this->maniaControl->database->mysqli;
$query = "CREATE TABLE IF NOT EXISTS `" . self::TABLE_SERVERS . "` (
`index` int(11) NOT NULL AUTO_INCREMENT,
`login` varchar(100) NOT NULL,
PRIMARY KEY (`index`),
UNIQUE KEY `login` (`login`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci COMMENT='Servers' AUTO_INCREMENT=1;";
$statement = $mysqli->prepare($query);
if ($mysqli->error) {
trigger_error($mysqli->error, E_USER_ERROR);
return false;
}
$statement->execute();
if ($statement->error) {
trigger_error($statement->error, E_USER_ERROR);
return false;
}
$statement->close();
return true;
}
/**
* Gets all Servers from the Database
*
* @return array
*/
public function getAllServers() {
$mysqli = $this->maniaControl->database->mysqli;
$query = "SELECT * FROM `" . self::TABLE_SERVERS . "`";
$result = $mysqli->query($query);
if (!$result) {
trigger_error($mysqli->error);
return array();
}
$servers = array();
while ($row = $result->fetch_object()) {
array_push($servers, $row);
}
$result->close();
return $servers;
}
/**
* Handle OnInit Callback
*/
public function onInit() {
$this->updateProperties();
}
/**
* Set if the Server Runs a Team-Mode or not
*
*
* @param bool $teamMode
*/
public function setTeamMode($teamMode = true) {
$oldStatus = $this->teamMode;
$oldStatus = $this->teamMode;
$this->teamMode = $teamMode;
// Trigger callback
if ($oldStatus != $this->teamMode) {
$this->maniaControl->callbackManager->triggerCallback(self::CB_TEAM_MODE_CHANGED, $teamMode);
@ -242,28 +240,16 @@ class Server implements CallbackListener {
/**
* Check if the Server Runs a TeamMode
*
*
* @return bool
*/
public function isTeamMode() {
return $this->teamMode;
}
/**
* Fetch Game Data Directory
*
* @return string
*/
public function getDataDirectory() {
if ($this->dataDirectory == '') {
$this->dataDirectory = $this->maniaControl->client->gameDataDirectory();
}
return $this->dataDirectory;
}
/**
* Fetch Maps Directory
*
*
* @return string
*/
public function getMapsDirectory() {
@ -274,9 +260,87 @@ class Server implements CallbackListener {
return "{$dataDirectory}Maps/";
}
/**
* Fetch Game Data Directory
*
* @return string
*/
public function getDataDirectory() {
if ($this->dataDirectory == '') {
$this->dataDirectory = $this->maniaControl->client->gameDataDirectory();
}
return $this->dataDirectory;
}
/**
* Get Server Player Info
*
* @return \Maniaplanet\DedicatedServer\Structures\Player
*/
public function getInfo() {
return $this->maniaControl->client->getMainServerPlayerInfo();
}
/**
* Retrieve Validation Replay for the given Player
*
* @param $login
* @return string
*/
public function getValidationReplay($login) {
try {
$replay = $this->maniaControl->client->getValidationReplay($login);
} catch (Exception $e) {
// TODO temp added 19.04.2014
$this->maniaControl->errorHandler->triggerDebugNotice("Exception line 330 Server.php" . $e->getMessage());
trigger_error("Couldn't get validation replay of '{$login}'. " . $e->getMessage());
return null;
}
return $replay;
}
/**
* Retrieve Ghost Replay for the given Player
*
* @param $login
* @return string
*/
public function getGhostReplay($login) {
$dataDir = $this->getDataDirectory();
if (!$this->checkAccess($dataDir)) {
return null;
}
// Build file name
$map = $this->maniaControl->mapManager->getCurrentMap();
$gameMode = $this->getGameMode();
$time = time();
$fileName = "GhostReplays/Ghost.{$login}.{$gameMode}.{$time}.{$map->uid}.Replay.Gbx";
// Save ghost replay
try {
$this->maniaControl->client->saveBestGhostsReplay($login, $fileName);
} catch (Exception $e) {
// TODO temp added 19.04.2014
$this->maniaControl->errorHandler->triggerDebugNotice("Exception line 360 Server.php" . $e->getMessage());
trigger_error("Couldn't save ghost replay. " . $e->getMessage());
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;
}
/**
* Checks if ManiaControl has Access to the given Directory
*
*
* @param string $directory
* @return bool
*/
@ -287,27 +351,17 @@ class Server implements CallbackListener {
return (is_dir($directory) && is_writable($directory));
}
/**
* Get Server Player Info
*
* @return \Maniaplanet\DedicatedServer\Structures\Player
*/
public function getInfo() {
return $this->maniaControl->client->getMainServerPlayerInfo();
}
/**
* Fetch current Game Mode
*
*
* @param bool $stringValue
* @param int $parseValue
* @param int $parseValue
* @return int | string
*/
public function getGameMode($stringValue = false, $parseValue = null) {
if (is_int($parseValue)) {
$gameMode = $parseValue;
}
else {
} else {
$gameMode = $this->maniaControl->client->getGameMode();
}
if ($stringValue) {
@ -333,68 +387,9 @@ class Server implements CallbackListener {
return $gameMode;
}
/**
* Retrieve Validation Replay for the given Player
*
* @param $login
* @return string
*/
public function getValidationReplay($login) {
try {
$replay = $this->maniaControl->client->getValidationReplay($login);
}
catch (Exception $e) {
// TODO temp added 19.04.2014
$this->maniaControl->errorHandler->triggerDebugNotice("Exception line 330 Server.php" . $e->getMessage());
trigger_error("Couldn't get validation replay of '{$login}'. " . $e->getMessage());
return null;
}
return $replay;
}
/**
* Retrieve Ghost Replay for the given Player
*
* @param $login
* @return string
*/
public function getGhostReplay($login) {
$dataDir = $this->getDataDirectory();
if (!$this->checkAccess($dataDir)) {
return null;
}
// Build file name
$map = $this->maniaControl->mapManager->getCurrentMap();
$gameMode = $this->getGameMode();
$time = time();
$fileName = "GhostReplays/Ghost.{$login}.{$gameMode}.{$time}.{$map->uid}.Replay.Gbx";
// Save ghost replay
try {
$this->maniaControl->client->saveBestGhostsReplay($login, $fileName);
}
catch (Exception $e) {
// TODO temp added 19.04.2014
$this->maniaControl->errorHandler->triggerDebugNotice("Exception line 360 Server.php" . $e->getMessage());
trigger_error("Couldn't save ghost replay. " . $e->getMessage());
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;
}
/**
* Wait for the Server to have the given Status
*
*
* @param int $statusCode
* @return bool
*/
@ -405,9 +400,9 @@ class Server implements CallbackListener {
return true;
}
// Server not yet in given status - Wait for it...
$waitBegin = time();
$waitBegin = time();
$maxWaitTime = 50;
$lastStatus = $response->name;
$lastStatus = $response->name;
$this->maniaControl->log("Waiting for server to reach status {$statusCode}...");
$this->maniaControl->log("Current Status: {$lastStatus}");
while ($response->code !== 4) {

38
application/core/Server/ServerCommands.php
View File

@ -18,8 +18,8 @@ use Maniaplanet\DedicatedServer\Xmlrpc\NotInScriptModeException;
/**
* Class offering various Commands related to the Dedicated Server
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class ServerCommands implements CallbackListener, CommandListener, ManialinkPageAnswerListener, TimerListener {
@ -106,11 +106,11 @@ class ServerCommands implements CallbackListener, CommandListener, ManialinkPage
//Check if Pause exists in current GameMode
try {
$scriptInfos = $this->maniaControl->client->getModeScriptInfo();
} catch(NotInScriptModeException $e) {
} catch (NotInScriptModeException $e) {
return;
}
$pauseExists = false;
foreach($scriptInfos->commandDescs as $param) {
foreach ($scriptInfos->commandDescs as $param) {
if ($param->name == "Command_ForceWarmUp") {
$pauseExists = true;
break;
@ -161,7 +161,7 @@ class ServerCommands implements CallbackListener, CommandListener, ManialinkPage
try {
$this->maniaControl->client->triggerModeScriptEvent('WarmUp_Extend', '10');
} catch(NotInScriptModeException $e) {
} catch (NotInScriptModeException $e) {
return;
}
@ -182,7 +182,7 @@ class ServerCommands implements CallbackListener, CommandListener, ManialinkPage
try {
$this->maniaControl->client->triggerModeScriptEvent('WarmUp_Stop', '');
} catch(NotInScriptModeException $e) {
} catch (NotInScriptModeException $e) {
return;
}
@ -192,7 +192,7 @@ class ServerCommands implements CallbackListener, CommandListener, ManialinkPage
/**
* Pause the current game
*
* @param array $callback
* @param array $callback
* @param Player $player
*/
public function setPause(array $callback, Player $player) {
@ -201,8 +201,8 @@ class ServerCommands implements CallbackListener, CommandListener, ManialinkPage
return;
}
try {
$this->maniaControl->client->sendModeScriptCommands(array('Command_ForceWarmUp' => True));
} catch(NotInScriptModeException $e) {
$this->maniaControl->client->sendModeScriptCommands(array('Command_ForceWarmUp' => true));
} catch (NotInScriptModeException $e) {
return;
}
@ -232,6 +232,16 @@ class ServerCommands implements CallbackListener, CommandListener, ManialinkPage
}
}
/**
* Perform server shutdown
*
* @param string $login
*/
private function shutdownServer($login = '#') {
$this->maniaControl->client->stopServer();
$this->maniaControl->quit("Server shutdown requested by '{$login}'");
}
/**
* Handle //systeminfo command
*
@ -411,14 +421,4 @@ class ServerCommands implements CallbackListener, CommandListener, ManialinkPage
$this->maniaControl->client->setMaxSpectators($amount);
$this->maniaControl->chat->sendSuccess("Changed max spectators to: {$amount}", $player->login);
}
/**
* Perform server shutdown
*
* @param string $login
*/
private function shutdownServer($login = '#') {
$this->maniaControl->client->stopServer();
$this->maniaControl->quit("Server shutdown requested by '{$login}'");
}
}

18
application/core/Server/UsageReporter.php
View File

@ -11,9 +11,9 @@ use Maniaplanet\DedicatedServer\Xmlrpc\Exception;
/**
* Class reporting ManiaControl Usage for the Server
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class UsageReporter implements TimerListener {
/*
@ -58,9 +58,9 @@ class UsageReporter implements TimerListener {
$properties['TitleId'] = $this->maniaControl->server->titleId;
$properties['ServerName'] = Formatter::stripDirtyCodes($this->maniaControl->client->getServerName());
$properties['PlayerCount'] = $this->maniaControl->playerManager->getPlayerCount();
$properties['MemoryUsage'] = memory_get_usage();
$properties['MemoryPeakUsage'] = memory_get_peak_usage();
$properties['PlayerCount'] = $this->maniaControl->playerManager->getPlayerCount();
$properties['MemoryUsage'] = memory_get_usage();
$properties['MemoryPeakUsage'] = memory_get_peak_usage();
$maxPlayers = $this->maniaControl->client->getMaxPlayers();
$properties['MaxPlayers'] = $maxPlayers["CurrentValue"];
@ -68,7 +68,7 @@ class UsageReporter implements TimerListener {
try {
$scriptName = $this->maniaControl->client->getScriptName();
$properties['ScriptName'] = $scriptName["CurrentValue"];
} catch(Exception $e) {
} catch (Exception $e) {
if ($e->getMessage() == 'Not in script mode.') {
$properties['ScriptName'] = '';
} else {
@ -79,7 +79,7 @@ class UsageReporter implements TimerListener {
$activePlugins = array();
if (is_array($this->maniaControl->pluginManager->getActivePlugins())) {
foreach($this->maniaControl->pluginManager->getActivePlugins() as $plugin) {
foreach ($this->maniaControl->pluginManager->getActivePlugins() as $plugin) {
/** @var Plugin $plugin */
if (!is_null($plugin::getId()) && is_numeric($plugin::getId())) {
$activePlugins[] = $plugin::getId();
@ -93,7 +93,7 @@ class UsageReporter implements TimerListener {
$info = base64_encode($json);
$self = $this;
$this->maniaControl->fileReader->loadFile(ManiaControl::URL_WEBSERVICE . "/usagereport?info=" . urlencode($info), function ($response, $error) use(&$self){
$this->maniaControl->fileReader->loadFile(ManiaControl::URL_WEBSERVICE . "/usagereport?info=" . urlencode($info), function ($response, $error) use (&$self) {
$response = json_decode($response);
if ($error || !$response) {
$self->maniaControl->log("Error while Sending data: " . $error);