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

added support for "-config=" parameter to load another xml file

Browse Source
This commit is contained in:
Steffen Schröder 2014-05-01 20:21:40 +02:00
parent df976a8229
commit 509251c5f7
1 changed files with 127 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

232
application/core/ManiaControl.php
View File

@ -36,26 +36,26 @@ require_once __DIR__ . '/Libs/curl-easy/autoload.php';
/** /**
* ManiaControl Server Controller for ManiaPlanet Server * ManiaControl Server Controller for ManiaPlanet Server
* *
* @author steeffeen & kremsy * @author ManiaControl Team
* @copyright ManiaControl Copyright © 2014 ManiaControl Team * @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3 * @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/ */
class ManiaControl implements CommandListener, TimerListener { class ManiaControl implements CommandListener, TimerListener {
/* /*
* Constants * Constants
*/ */
const VERSION = '0.12'; const VERSION = '0.12';
const API_VERSION = '2013-04-16'; const API_VERSION = '2013-04-16';
const MIN_DEDIVERSION = '2014-04-02_18_00'; const MIN_DEDIVERSION = '2014-04-02_18_00';
const OS_UNIX = 'Unix'; const OS_UNIX = 'Unix';
const OS_WIN = 'Windows'; const OS_WIN = 'Windows';
const CONNECT_TIMEOUT = 50; const CONNECT_TIMEOUT = 50;
const SCRIPT_TIMEOUT = 20; const SCRIPT_TIMEOUT = 20;
const URL_WEBSERVICE = 'http://ws.maniacontrol.com/'; const URL_WEBSERVICE = 'http://ws.maniacontrol.com/';
const SETTING_PERMISSION_SHUTDOWN = 'Shutdown ManiaControl'; const SETTING_PERMISSION_SHUTDOWN = 'Shutdown ManiaControl';
const SETTING_PERMISSION_RESTART = 'Restart ManiaControl'; const SETTING_PERMISSION_RESTART = 'Restart ManiaControl';
/* /*
* Public Properties * Public Properties
*/ */
@ -63,9 +63,12 @@ class ManiaControl implements CommandListener, TimerListener {
public $authenticationManager = null; public $authenticationManager = null;
public $callbackManager = null; public $callbackManager = null;
public $chat = null; public $chat = null;
public $config = null; public $config = null;
public $configurator = null; public $configurator = null;
/** @var Connection $client */ /**
*
* @var Connection $client
*/
public $client = null; public $client = null;
public $commandManager = null; public $commandManager = null;
public $database = null; public $database = null;
@ -81,7 +84,7 @@ class ManiaControl implements CommandListener, TimerListener {
public $timerManager = null; public $timerManager = null;
public $fileReader = null; public $fileReader = null;
public $billManager = null; public $billManager = null;
/* /*
* Private Properties * Private Properties
*/ */
@ -93,50 +96,64 @@ class ManiaControl implements CommandListener, TimerListener {
public function __construct() { public function __construct() {
// Construct Error Handler // Construct Error Handler
$this->errorHandler = new ErrorHandler($this); $this->errorHandler = new ErrorHandler($this);
$this->log('Loading ManiaControl v' . self::VERSION . '...'); $this->log('Loading ManiaControl v' . self::VERSION . '...');
// Load config $this->loadConfig();
$this->config = FileUtil::loadConfig('server.xml');
// Load ManiaControl Modules // Load ManiaControl Modules
$this->callbackManager = new CallbackManager($this); $this->callbackManager = new CallbackManager($this);
$this->timerManager = new TimerManager($this); $this->timerManager = new TimerManager($this);
$this->database = new Database($this); $this->database = new Database($this);
$this->fileReader = new AsynchronousFileReader($this); $this->fileReader = new AsynchronousFileReader($this);
$this->billManager = new BillManager($this); $this->billManager = new BillManager($this);
$this->settingManager = new SettingManager($this); $this->settingManager = new SettingManager($this);
$this->statisticManager = new StatisticManager($this); $this->statisticManager = new StatisticManager($this);
$this->manialinkManager = new ManialinkManager($this); $this->manialinkManager = new ManialinkManager($this);
$this->actionsMenu = new ActionsMenu($this); $this->actionsMenu = new ActionsMenu($this);
$this->chat = new Chat($this); $this->chat = new Chat($this);
$this->commandManager = new CommandManager($this); $this->commandManager = new CommandManager($this);
$this->server = new Server($this); $this->server = new Server($this);
$this->authenticationManager = new AuthenticationManager($this); $this->authenticationManager = new AuthenticationManager($this);
$this->playerManager = new PlayerManager($this); $this->playerManager = new PlayerManager($this);
$this->mapManager = new MapManager($this); $this->mapManager = new MapManager($this);
$this->configurator = new Configurator($this); $this->configurator = new Configurator($this);
$this->pluginManager = new PluginManager($this); $this->pluginManager = new PluginManager($this);
$this->updateManager = new UpdateManager($this); $this->updateManager = new UpdateManager($this);
// Define Permission Levels // Define Permission Levels
$this->authenticationManager->definePermissionLevel(self::SETTING_PERMISSION_SHUTDOWN, AuthenticationManager::AUTH_LEVEL_SUPERADMIN); $this->authenticationManager->definePermissionLevel(self::SETTING_PERMISSION_SHUTDOWN, AuthenticationManager::AUTH_LEVEL_SUPERADMIN);
$this->authenticationManager->definePermissionLevel(self::SETTING_PERMISSION_RESTART, AuthenticationManager::AUTH_LEVEL_SUPERADMIN); $this->authenticationManager->definePermissionLevel(self::SETTING_PERMISSION_RESTART, AuthenticationManager::AUTH_LEVEL_SUPERADMIN);
// Register for commands // Register for commands
$this->commandManager->registerCommandListener('version', $this, 'command_Version', false, 'Shows ManiaControl version.'); $this->commandManager->registerCommandListener('version', $this, 'command_Version', false, 'Shows ManiaControl version.');
$this->commandManager->registerCommandListener('restart', $this, 'command_Restart', true, 'Restarts ManiaControl.'); $this->commandManager->registerCommandListener('restart', $this, 'command_Restart', true, 'Restarts ManiaControl.');
$this->commandManager->registerCommandListener('shutdown', $this, 'command_Shutdown', true, 'Shuts ManiaControl down.'); $this->commandManager->registerCommandListener('shutdown', $this, 'command_Shutdown', true, 'Shuts ManiaControl down.');
//Check connection every 30 seconds // Check connection every 30 seconds
$this->timerManager->registerTimerListening($this, 'checkConnection', 1000 * 30); $this->timerManager->registerTimerListening($this, 'checkConnection', 1000 * 30);
$this->errorHandler->init(); $this->errorHandler->init();
} }
/**
* Load the Config XML-File
*/
private function loadConfig() {
$configId = CommandLineHelper::getParameter('-config');
$configFileName = ($configId ? $configId : 'server.xml');
$this->config = FileUtil::loadConfig($configFileName);
if (!$this->config) {
trigger_error("Error loading Configuration XML-File! ('{$configFileName}')", E_USER_ERROR);
}
if (!$this->config->server->port || $this->config->server->port == 'port') {
trigger_error("Your Configuration File ('{$configFileName}') doesn't seem to be maintained. Please check it again!", E_USER_ERROR);
}
}
/** /**
* Checks connection every xxx Minutes * Checks connection every xxx Minutes
* *
* @param $time * @param $time
*/ */
public function checkConnection($time) { public function checkConnection($time) {
@ -147,20 +164,19 @@ class ManiaControl implements CommandListener, TimerListener {
/** /**
* Print a message to console and log * Print a message to console and log
* *
* @param string $message * @param string $message
*/ */
public function log($message, $stripCodes = false) { public function log($message, $stripCodes = false) {
$date = date("d.M y H:i:s");
if ($stripCodes) { if ($stripCodes) {
$message = Formatter::stripCodes($message); $message = Formatter::stripCodes($message);
} }
logMessage($date . ' ' . $message); logMessage($message);
} }
/** /**
* Get the Operating System on which ManiaControl is running * Get the Operating System on which ManiaControl is running
* *
* @param string $compareOS * @param string $compareOS
* @return string * @return string
*/ */
@ -182,8 +198,8 @@ class ManiaControl implements CommandListener, TimerListener {
/** /**
* Handle Version Command * Handle Version Command
* *
* @param array $chatCallback * @param array $chatCallback
* @param Player $player * @param Player $player
*/ */
public function command_Version(array $chatCallback, Player $player) { public function command_Version(array $chatCallback, Player $player) {
@ -193,8 +209,8 @@ class ManiaControl implements CommandListener, TimerListener {
/** /**
* Handle Restart AdminCommand * Handle Restart AdminCommand
* *
* @param array $chatCallback * @param array $chatCallback
* @param Player $player * @param Player $player
*/ */
public function command_Restart(array $chatCallback, Player $player) { public function command_Restart(array $chatCallback, Player $player) {
@ -207,8 +223,8 @@ class ManiaControl implements CommandListener, TimerListener {
/** /**
* Handle //shutdown command * Handle //shutdown command
* *
* @param array $chat * @param array $chat
* @param Player $player * @param Player $player
*/ */
public function command_Shutdown(array $chat, Player $player) { public function command_Shutdown(array $chat, Player $player) {
@ -221,14 +237,14 @@ class ManiaControl implements CommandListener, TimerListener {
/** /**
* Quit ManiaControl and log the given message * Quit ManiaControl and log the given message
* *
* @param string $message * @param string $message
*/ */
public function quit($message = null) { public function quit($message = null) {
if ($message) { if ($message) {
$this->log($message); $this->log($message);
} }
exit(); exit();
} }
@ -238,61 +254,63 @@ class ManiaControl implements CommandListener, TimerListener {
public function handleShutdown() { public function handleShutdown() {
// OnShutdown callback // OnShutdown callback
$this->callbackManager->triggerCallback(CallbackManager::CB_ONSHUTDOWN); $this->callbackManager->triggerCallback(CallbackManager::CB_ONSHUTDOWN);
// Announce quit // Announce quit
$this->chat->sendInformation('ManiaControl shutting down.'); $this->chat->sendInformation('ManiaControl shutting down.');
if ($this->client) { if ($this->client) {
try { try {
// Hide manialinks // Hide manialinks
$this->client->sendHideManialinkPage(); $this->client->sendHideManialinkPage();
// Close the client connection // Close the client connection
$this->client->delete($this->server->ip, $this->server->port); $this->client->delete($this->server->ip, $this->server->port);
} catch(TransportException $e) { }
catch (TransportException $e) {
$this->errorHandler->triggerDebugNotice($e->getMessage() . " File: " . $e->getFile() . " Line: " . $e->getLine()); $this->errorHandler->triggerDebugNotice($e->getMessage() . " File: " . $e->getFile() . " Line: " . $e->getLine());
} }
} }
// Check and Trigger Fatal Errors // Check and Trigger Fatal Errors
$error = error_get_last(); $error = error_get_last();
if ($error && ($error['type'] & E_FATAL)) { if ($error && ($error['type'] & E_FATAL)) {
$this->errorHandler->errorHandler($error['type'], $error['message'], $error['file'], $error['line']); $this->errorHandler->errorHandler($error['type'], $error['message'], $error['file'], $error['line']);
} }
// Disable Garbage Collector // Disable Garbage Collector
$this->collectGarbage(); $this->collectGarbage();
gc_disable(); gc_disable();
$this->log('Quitting ManiaControl!'); $this->log('Quitting ManiaControl!');
exit(); exit();
} }
/** /**
* Restart ManiaControl * Restart ManiaControl
* *
* @param string $message * @param string $message
*/ */
public function restart($message = null) { public function restart($message = null) {
// Shutdown callback // Shutdown callback
$this->callbackManager->triggerCallback(CallbackManager::CB_ONSHUTDOWN); $this->callbackManager->triggerCallback(CallbackManager::CB_ONSHUTDOWN);
// Announce restart // Announce restart
$this->chat->sendInformation('Restarting ManiaControl...'); $this->chat->sendInformation('Restarting ManiaControl...');
if ($message) { if ($message) {
$this->log($message); $this->log($message);
} }
// Hide widgets // Hide widgets
$this->client->sendHideManialinkPage(); $this->client->sendHideManialinkPage();
$this->log('Restarting ManiaControl!'); $this->log('Restarting ManiaControl!');
// Execute start script in background // Execute start script in background
// TODO: restart the .php script itself ($_SERVER['scriptname'] or something + $argv) // TODO: restart the .php script itself ($_SERVER['scriptname'] or something + $argv)
if ($this->getOS(self::OS_UNIX)) { if ($this->getOS(self::OS_UNIX)) {
$command = 'sh ' . escapeshellarg(ManiaControlDir . '/ManiaControl.sh') . ' > /dev/null &'; $command = 'sh ' . escapeshellarg(ManiaControlDir . '/ManiaControl.sh') . ' > /dev/null &';
exec($command); exec($command);
} else { }
else {
$command = escapeshellarg(ManiaControlDir . "\ManiaControl.bat"); $command = escapeshellarg(ManiaControlDir . "\ManiaControl.bat");
system($command); // TODO, windows stucks here as long controller is running system($command); // TODO, windows stucks here as long controller is running
} }
@ -304,51 +322,52 @@ class ManiaControl implements CommandListener, TimerListener {
*/ */
public function run() { public function run() {
$this->log('Starting ManiaControl v' . self::VERSION . '!'); $this->log('Starting ManiaControl v' . self::VERSION . '!');
// Register shutdown handler // Register shutdown handler
register_shutdown_function(array($this, 'handleShutdown')); register_shutdown_function(array($this, 'handleShutdown'));
// Connect to server // Connect to server
$this->connect(); $this->connect();
// Check if the version of the server is high enough // Check if the version of the server is high enough
$version = $this->client->getVersion(); $version = $this->client->getVersion();
if($version->build < self::MIN_DEDIVERSION) { if ($version->build < self::MIN_DEDIVERSION) {
trigger_error("The server has version ".$version->build.", while at least ".self::MIN_DEDIVERSION." is required!", E_USER_ERROR); trigger_error("The server has version " . $version->build . ", while at least " . self::MIN_DEDIVERSION . " is required!", E_USER_ERROR);
} }
// OnInit callback // OnInit callback
$this->callbackManager->triggerCallback(CallbackManager::CB_ONINIT); $this->callbackManager->triggerCallback(CallbackManager::CB_ONINIT);
// Load plugins // Load plugins
$this->pluginManager->loadPlugins(); $this->pluginManager->loadPlugins();
$this->updateManager->checkPluginsUpdate(); $this->updateManager->checkPluginsUpdate();
// AfterInit callback // AfterInit callback
$this->callbackManager->triggerCallback(CallbackManager::CB_AFTERINIT); $this->callbackManager->triggerCallback(CallbackManager::CB_AFTERINIT);
// Enable Garbage Collecting // Enable Garbage Collecting
gc_enable(); gc_enable();
$this->timerManager->registerTimerListening($this, 'collectGarbage', 1000 * 60); $this->timerManager->registerTimerListening($this, 'collectGarbage', 1000 * 60);
// Announce ManiaControl // Announce ManiaControl
$this->chat->sendInformation('ManiaControl v' . self::VERSION . ' successfully started!'); $this->chat->sendInformation('ManiaControl v' . self::VERSION . ' successfully started!');
// Loading finished // Loading finished
$this->log('Loading completed!'); $this->log('Loading completed!');
$this->log('Link: maniaplanet://#join=' . $this->server->login . '@' . $this->server->titleId); $this->log('Link: maniaplanet://#join=' . $this->server->login . '@' . $this->server->titleId);
// Main loop // Main loop
while(!$this->shutdownRequested) { while (!$this->shutdownRequested) {
$loopStart = microtime(true); $loopStart = microtime(true);
// Disable script timeout // Disable script timeout
set_time_limit(self::SCRIPT_TIMEOUT); set_time_limit(self::SCRIPT_TIMEOUT);
try { try {
// Manager callbacks // Manager callbacks
$this->callbackManager->manageCallbacks(); $this->callbackManager->manageCallbacks();
} catch(TransportException $e) { }
catch (TransportException $e) {
$this->log("Connection interrupted!"); $this->log("Connection interrupted!");
// TODO remove // TODO remove
if ($this->errorHandler) { if ($this->errorHandler) {
@ -356,20 +375,19 @@ class ManiaControl implements CommandListener, TimerListener {
} }
$this->quit($e->getMessage()); $this->quit($e->getMessage());
} }
// Manage FileReader // Manage FileReader
$this->fileReader->appendData(); $this->fileReader->appendData();
// Yield for next tick // Yield for next tick
$loopEnd = microtime(true); $loopEnd = microtime(true);
$sleepTime = (int)(2000 - ($loopEnd - $loopStart) * 1000000); $sleepTime = (int) (2000 - ($loopEnd - $loopStart) * 1000000);
if ($sleepTime > 0) { if ($sleepTime > 0) {
usleep($sleepTime); usleep($sleepTime);
} }
} }
// Shutdown // Shutdown
$this->quit(); $this->quit();
} }
@ -387,59 +405,63 @@ class ManiaControl implements CommandListener, TimerListener {
private function connect() { private function connect() {
// Load remote client // Load remote client
$this->server->loadConfig(); $this->server->loadConfig();
$this->log("Connecting to server at {$this->server->config->host}:{$this->server->config->port}..."); $this->log("Connecting to server at {$this->server->config->host}:{$this->server->config->port}...");
try { try {
$this->client = Connection::factory($this->server->config->host, $this->server->config->port, self::CONNECT_TIMEOUT, $this->server->config->login, $this->server->config->pass); $this->client = Connection::factory($this->server->config->host, $this->server->config->port, self::CONNECT_TIMEOUT, $this->server->config->login, $this->server->config->pass);
} catch(Exception $e) { }
catch (Exception $e) {
trigger_error("Couldn't authenticate on server with user '{$this->server->config->login}'! " . $e->getMessage(), E_USER_ERROR); trigger_error("Couldn't authenticate on server with user '{$this->server->config->login}'! " . $e->getMessage(), E_USER_ERROR);
} }
// Enable callback system // Enable callback system
$this->client->enableCallbacks(true); $this->client->enableCallbacks(true);
// Wait for server to be ready // Wait for server to be ready
try { try {
if (!$this->server->waitForStatus(4)) { if (!$this->server->waitForStatus(4)) {
trigger_error("Server couldn't get ready!", E_USER_ERROR); trigger_error("Server couldn't get ready!", E_USER_ERROR);
} }
} catch(Exception $e) { }
catch (Exception $e) {
// TODO remove // TODO remove
if ($this->errorHandler) { if ($this->errorHandler) {
$this->errorHandler->triggerDebugNotice("Fatal Exception: " . $e->getMessage() . " Trace: " . $e->getTraceAsString()); $this->errorHandler->triggerDebugNotice("Fatal Exception: " . $e->getMessage() . " Trace: " . $e->getTraceAsString());
} }
$this->quit($e->getMessage()); $this->quit($e->getMessage());
} }
// Connect finished // Connect finished
$this->log("Server Connection successfully established!"); $this->log("Server Connection successfully established!");
// Hide old widgets // Hide old widgets
$this->client->sendHideManialinkPage(); $this->client->sendHideManialinkPage();
// Enable script callbacks if needed // Enable script callbacks if needed
if ($this->server->getGameMode() != 0) { if ($this->server->getGameMode() != 0) {
return; return;
} }
try { try {
$scriptSettings = $this->client->getModeScriptSettings(); $scriptSettings = $this->client->getModeScriptSettings();
} catch(NotInScriptModeException $e) { }
catch (NotInScriptModeException $e) {
return; return;
} }
if (!array_key_exists('S_UseScriptCallbacks', $scriptSettings)) { if (!array_key_exists('S_UseScriptCallbacks', $scriptSettings)) {
return; return;
} }
$scriptSettings['S_UseScriptCallbacks'] = true; $scriptSettings['S_UseScriptCallbacks'] = true;
try { try {
$this->client->setModeScriptSettings($scriptSettings); $this->client->setModeScriptSettings($scriptSettings);
} catch(Exception $e) { }
//TODO temp added 19.04.2014 catch (Exception $e) {
// TODO temp added 19.04.2014
$this->errorHandler->triggerDebugNotice("Exception line 437 ManiaControl.php " . $e->getMessage()); $this->errorHandler->triggerDebugNotice("Exception line 437 ManiaControl.php " . $e->getMessage());
trigger_error("Couldn't set mode script settings to enable script callbacks. " . $e->getMessage()); trigger_error("Couldn't set mode script settings to enable script callbacks. " . $e->getMessage());
return; return;
} }