TrackManiaControl/application/core/ManiaControl.php

406 lines
12 KiB
PHP
Raw Normal View History

2013-11-10 17:29:21 +01:00
<?php
namespace ManiaControl;
2013-12-31 12:42:07 +01:00
use ManiaControl\Admin\ActionsMenu;
use ManiaControl\Admin\AuthenticationManager;
use ManiaControl\Callbacks\CallbackManager;
2014-01-30 22:35:32 +01:00
use ManiaControl\Callbacks\TimerManager;
use ManiaControl\Commands\CommandListener;
use ManiaControl\Commands\CommandManager;
use ManiaControl\Configurators\Configurator;
2014-02-07 12:30:53 +01:00
use ManiaControl\Files\AsynchronousFileReader;
2014-02-07 00:27:10 +01:00
use ManiaControl\Files\FileUtil;
use ManiaControl\Manialinks\ManialinkManager;
use ManiaControl\Maps\MapManager;
use ManiaControl\Players\Player;
use ManiaControl\Players\PlayerManager;
use ManiaControl\Plugins\PluginManager;
use ManiaControl\Server\Server;
2014-01-27 17:29:48 +01:00
use ManiaControl\Settings\SettingManager;
use ManiaControl\Statistics\StatisticManager;
2014-02-10 22:54:49 +01:00
use ManiaControl\Update\UpdateManager;
2014-01-16 17:19:01 +01:00
use Maniaplanet\DedicatedServer\Connection;
use Maniaplanet\DedicatedServer\Xmlrpc\Exception;
2013-12-31 12:42:07 +01:00
2014-01-16 17:19:01 +01:00
require_once __DIR__ . '/Maniaplanet/DedicatedServer/Connection.php';
2013-12-17 17:38:44 +01:00
require_once __DIR__ . '/GbxDataFetcher/gbxdatafetcher.inc.php';
require_once __DIR__ . '/FML/autoload.php';
2013-11-10 17:29:21 +01:00
/**
* ManiaControl Server Controller for ManiaPlanet Server
*
2014-02-10 22:54:49 +01:00
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
2014-02-10 15:26:08 +01:00
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
2013-11-10 17:29:21 +01:00
*/
class ManiaControl implements CommandListener {
2013-11-10 17:29:21 +01:00
/**
* Constants
*/
2014-01-31 16:55:01 +01:00
const VERSION = '0.01';
const API_VERSION = '2013-04-16';
const OS_UNIX = 'Unix';
const OS_WIN = 'Windows';
const CONNECT_TIMEOUT = 20;
const SCRIPT_TIMEOUT = 20;
const SETTING_PERMISSION_SHUTDOWN = 'Shutdown ManiaControl';
const SETTING_PERMISSION_RESTART = 'Restart ManiaControl';
2014-01-27 17:29:48 +01:00
2013-11-10 17:29:21 +01:00
/**
* Public properties
*/
2013-12-31 12:42:07 +01:00
public $actionsMenu = null;
public $authenticationManager = null;
public $callbackManager = null;
2013-11-10 17:29:21 +01:00
public $chat = null;
2014-01-06 14:22:48 +01:00
public $config = null;
public $configurator = null;
2014-01-27 17:29:48 +01:00
/** @var Connection $client */
2013-11-10 17:29:21 +01:00
public $client = null;
public $commandManager = null;
2013-11-10 17:29:21 +01:00
public $database = null;
public $manialinkManager = null;
public $mapManager = null;
public $playerManager = null;
public $pluginManager = null;
2013-11-10 17:29:21 +01:00
public $server = null;
public $settingManager = null;
2013-12-31 17:31:05 +01:00
public $statisticManager = null;
2013-12-17 17:38:44 +01:00
public $updateManager = null;
2014-01-27 20:28:37 +01:00
public $errorHandler = null;
2014-01-30 22:35:32 +01:00
public $timerManager = null;
2014-02-07 12:30:53 +01:00
public $fileReader = null;
2013-11-10 17:29:21 +01:00
/**
* Private properties
*/
private $shutdownRequested = false;
/**
* Construct ManiaControl
*/
public function __construct() {
2014-01-27 20:28:37 +01:00
//Construct Error Handler
$this->errorHandler = new ErrorHandler($this);
2013-12-31 14:50:45 +01:00
$this->log('Loading ManiaControl v' . self::VERSION . '...');
2014-01-27 17:29:48 +01:00
2014-01-06 14:22:48 +01:00
// Load config
$this->config = FileUtil::loadConfig('server.xml');
2014-01-27 17:29:48 +01:00
2013-12-17 17:38:44 +01:00
// Load ManiaControl Modules
2014-01-27 17:29:48 +01:00
$this->database = new Database($this);
$this->callbackManager = new CallbackManager($this);
2014-01-30 22:35:32 +01:00
$this->timerManager = new TimerManager($this);
2014-02-07 12:30:53 +01:00
$this->fileReader = new AsynchronousFileReader($this);
2014-01-27 17:29:48 +01:00
$this->settingManager = new SettingManager($this);
$this->statisticManager = new StatisticManager($this);
$this->manialinkManager = new ManialinkManager($this);
$this->actionsMenu = new ActionsMenu($this);
$this->chat = new Chat($this);
$this->commandManager = new CommandManager($this);
$this->server = new Server($this);
$this->authenticationManager = new AuthenticationManager($this);
2014-01-27 17:29:48 +01:00
$this->playerManager = new PlayerManager($this);
$this->mapManager = new MapManager($this);
$this->configurator = new Configurator($this);
$this->pluginManager = new PluginManager($this);
$this->updateManager = new UpdateManager($this);
2014-01-31 16:55:01 +01:00
//Define Permission Levels
$this->authenticationManager->definePermissionLevel(self::SETTING_PERMISSION_SHUTDOWN, AuthenticationManager::AUTH_LEVEL_SUPERADMIN);
$this->authenticationManager->definePermissionLevel(self::SETTING_PERMISSION_RESTART, AuthenticationManager::AUTH_LEVEL_SUPERADMIN);
2013-12-17 17:38:44 +01:00
// Register for commands
$this->commandManager->registerCommandListener('version', $this, 'command_Version');
$this->commandManager->registerCommandListener('restart', $this, 'command_Restart', true);
2014-01-01 19:25:51 +01:00
$this->commandManager->registerCommandListener('shutdown', $this, 'command_Shutdown', true);
2013-11-10 17:29:21 +01:00
}
2014-01-27 20:28:37 +01:00
2013-12-09 15:53:10 +01:00
/**
* Print a message to console and log
2013-12-31 12:42:07 +01:00
*
* @param string $message
2013-12-09 15:53:10 +01:00
*/
2014-01-05 14:13:18 +01:00
public function log($message, $stripCodes = false) {
2014-01-10 13:21:07 +01:00
$date = date("d.M y H:i:s");
2014-01-27 20:28:37 +01:00
if ($stripCodes) {
2014-01-05 14:13:18 +01:00
$message = Formatter::stripCodes($message);
}
2014-01-10 13:21:07 +01:00
logMessage($date . ' ' . $message);
2013-12-09 15:53:10 +01:00
}
/**
* Get the Operating System on which ManiaControl is running
*
* @param string $compareOS
* @return string
*/
public function getOS($compareOS = null) {
$windows = defined('PHP_WINDOWS_VERSION_MAJOR');
2014-01-27 20:28:37 +01:00
if ($compareOS) {
// Return bool whether OS equals $compareOS
2014-01-27 20:28:37 +01:00
if ($compareOS == self::OS_WIN) {
return $windows;
}
return !$windows;
}
// Return OS
2014-01-27 20:28:37 +01:00
if ($windows) {
return self::OS_WIN;
}
return self::OS_UNIX;
}
/**
* Handle Version Command
*
2014-01-27 17:29:48 +01:00
* @param array $chatCallback
2013-12-31 12:42:07 +01:00
* @param Player $player
*/
public function command_Version(array $chatCallback, Player $player) {
$message = 'This server is using ManiaControl v' . ManiaControl::VERSION . '!';
$this->chat->sendInformation($message, $player->login);
}
/**
* Handle Restart AdminCommand
*
2014-01-27 17:29:48 +01:00
* @param array $chatCallback
* @param Player $player
*/
public function command_Restart(array $chatCallback, Player $player) {
2014-01-31 16:55:01 +01:00
if (!$this->authenticationManager->checkPermission($player, self::SETTING_PERMISSION_RESTART)) {
$this->authenticationManager->sendNotAllowed($player);
return;
}
2014-01-01 19:25:51 +01:00
$this->restart("ManiaControl Restart requested by '{$player->login}'!");
}
/**
* Handle //shutdown command
*
2014-01-27 17:29:48 +01:00
* @param array $chat
2014-01-01 19:25:51 +01:00
* @param Player $player
*/
public function command_Shutdown(array $chat, Player $player) {
2014-01-31 16:55:01 +01:00
if (!$this->authenticationManager->checkPermission($player, self::SETTING_PERMISSION_SHUTDOWN)) {
2014-01-01 19:25:51 +01:00
$this->authenticationManager->sendNotAllowed($player);
return;
}
$this->quit("ManiaControl Shutdown requested by '{$player->login}'!");
}
2013-11-10 17:29:21 +01:00
/**
* Quit ManiaControl and log the given message
*
2013-12-31 12:42:07 +01:00
* @param string $message
2013-11-10 17:29:21 +01:00
*/
2014-01-01 19:25:51 +01:00
public function quit($message = null) {
2014-01-27 20:28:37 +01:00
if ($message) {
$this->log($message);
}
2014-01-01 19:25:51 +01:00
exit();
}
/**
* Handle PHP Process Shutdown
*/
public function handleShutdown() {
// OnShutdown callback
$this->callbackManager->triggerCallback(CallbackManager::CB_MC_ONSHUTDOWN, array(CallbackManager::CB_MC_ONSHUTDOWN));
2014-01-27 17:29:48 +01:00
2014-01-01 19:25:51 +01:00
// Announce quit
$this->chat->sendInformation('ManiaControl shutting down.');
2014-01-27 17:29:48 +01:00
2014-01-01 19:25:51 +01:00
// Hide manialinks
2014-02-01 21:37:38 +01:00
try {
$this->client->sendHideManialinkPage();
} catch(Exception $e) {
2014-02-01 21:37:38 +01:00
}
2014-02-13 20:41:55 +01:00
// Close the client connection
$this->client->delete($this->server->ip, $this->server->port);
2014-01-27 17:29:48 +01:00
2014-02-13 20:41:55 +01:00
//Check and Trigger Fatal Errors
$error = error_get_last();
if ($error && ($error['type'] & E_FATAL)) {
$this->errorHandler->errorHandler($error['type'], $error['message'], $error['file'], $error['line']);
}
$this->log('Quitting ManiaControl!');
2013-11-10 17:29:21 +01:00
exit();
}
/**
* Restart ManiaControl
*
* @param string $message
*/
public function restart($message = null) {
// Shutdown callback
$this->callbackManager->triggerCallback(CallbackManager::CB_MC_ONSHUTDOWN, array(CallbackManager::CB_MC_ONSHUTDOWN));
2014-01-27 17:29:48 +01:00
// Announce restart
$this->chat->sendInformation('Restarting ManiaControl...');
2014-01-27 20:28:37 +01:00
if ($message) {
$this->log($message);
}
2014-01-27 17:29:48 +01:00
// Hide widgets
2014-01-16 17:19:01 +01:00
$this->client->sendHideManialinkPage();
2014-01-27 17:29:48 +01:00
2014-01-01 19:25:51 +01:00
$this->log('Restarting ManiaControl!');
2014-01-27 17:29:48 +01:00
// Execute start script in background
2014-01-27 20:28:37 +01:00
if ($this->getOS(self::OS_UNIX)) {
$command = 'sh ' . escapeshellarg(ManiaControlDir . '/ManiaControl.sh') . ' > /dev/null &';
exec($command);
2014-01-27 17:29:48 +01:00
} else {
2014-01-20 20:51:03 +01:00
$command = escapeshellarg(ManiaControlDir . "\ManiaControl.bat");
system($command); // TODO, windows stucks here as long controller is running
}
exit();
}
2013-11-10 17:29:21 +01:00
/**
* Run ManiaControl
*/
public function run() {
$this->log('Starting ManiaControl v' . self::VERSION . '!');
2014-01-27 17:29:48 +01:00
2013-11-10 17:29:21 +01:00
// Connect to server
$this->connect();
2014-01-27 17:29:48 +01:00
// Register shutdown handler
2014-01-01 19:25:51 +01:00
register_shutdown_function(array($this, 'handleShutdown'));
2014-01-27 17:29:48 +01:00
// OnInit callback
$this->callbackManager->triggerCallback(CallbackManager::CB_MC_ONINIT, array(CallbackManager::CB_MC_ONINIT));
2014-01-27 17:29:48 +01:00
2014-01-18 10:26:32 +01:00
// Load plugins
$this->pluginManager->loadPlugins();
2014-01-27 17:29:48 +01:00
// AfterInit callback
$this->callbackManager->triggerCallback(CallbackManager::CB_MC_AFTERINIT, array(CallbackManager::CB_MC_AFTERINIT));
// Announce ManiaControl
$this->chat->sendInformation('ManiaControl v' . self::VERSION . ' successfully started!');
2014-01-27 17:29:48 +01:00
// Loading finished
$this->log('Loading completed!');
2014-02-13 20:41:55 +01:00
$this->log('Link: maniaplanet://#join=' . $this->server->login . '@' . $this->server->titleId);
2014-01-27 17:29:48 +01:00
2013-11-10 17:29:21 +01:00
// Main loop
2014-01-27 17:29:48 +01:00
while(!$this->shutdownRequested) {
2013-11-10 17:29:21 +01:00
$loopStart = microtime(true);
2014-01-27 17:29:48 +01:00
2013-11-10 17:29:21 +01:00
// Disable script timeout
2014-01-20 20:51:03 +01:00
set_time_limit(self::SCRIPT_TIMEOUT);
2014-01-27 17:29:48 +01:00
2014-02-14 13:51:23 +01:00
try {
// Manager callbacks
$this->callbackManager->manageCallbacks();
2014-01-27 17:29:48 +01:00
2014-02-14 13:51:23 +01:00
} catch(Exception $e) {
if ($e->getMessage() == 'Connection interupted') {
$this->quit($e->getMessage());
}
}
2014-02-07 12:30:53 +01:00
2014-02-14 13:52:20 +01:00
// Manage FileReader
$this->fileReader->appendData();
2013-11-10 17:29:21 +01:00
// Yield for next tick
2014-01-31 16:55:01 +01:00
$loopEnd = microtime(true);
2014-01-30 22:35:32 +01:00
2014-01-31 16:55:01 +01:00
$sleepTime = (int)(1000 - $loopEnd + $loopStart);
2014-01-27 20:28:37 +01:00
if ($sleepTime > 0) {
2013-11-10 17:29:21 +01:00
usleep($sleepTime);
}
}
2014-01-27 17:29:48 +01:00
2013-11-10 17:29:21 +01:00
// Shutdown
$this->quit();
2013-11-10 17:29:21 +01:00
}
/**
* Connect to ManiaPlanet server
*/
private function connect() {
// Load remote client
2014-01-06 14:22:48 +01:00
$host = $this->config->server->xpath('host');
2014-01-27 20:28:37 +01:00
if (!$host) {
trigger_error("Invalid server configuration (host).", E_USER_ERROR);
}
2014-01-27 17:29:48 +01:00
$host = (string)$host[0];
2014-01-06 14:22:48 +01:00
$port = $this->config->server->xpath('port');
2014-01-27 20:28:37 +01:00
if (!$host) {
trigger_error("Invalid server configuration (port).", E_USER_ERROR);
}
2014-01-27 17:29:48 +01:00
$port = (string)$port[0];
2013-12-31 14:50:45 +01:00
$this->log("Connecting to server at {$host}:{$port}...");
2014-01-27 17:29:48 +01:00
2014-01-06 14:22:48 +01:00
$login = $this->config->server->xpath('login');
2014-01-27 20:28:37 +01:00
if (!$login) {
trigger_error("Invalid server configuration (login).", E_USER_ERROR);
}
2014-01-27 17:29:48 +01:00
$login = (string)$login[0];
$pass = $this->config->server->xpath('pass');
2014-01-27 20:28:37 +01:00
if (!$pass) {
trigger_error("Invalid server configuration (password).", E_USER_ERROR);
}
2014-01-27 17:29:48 +01:00
$pass = (string)$pass[0];
2014-01-17 16:32:53 +01:00
try {
2014-01-18 22:06:07 +01:00
$this->client = Connection::factory($host, $port, self::CONNECT_TIMEOUT, $login, $pass);
} catch(Exception $e) {
// TODO: is it even needed to try-catch here? we will crash anyways
2014-01-17 16:32:53 +01:00
trigger_error("Couldn't authenticate on server with user '{$login}'! " . $e->getMessage(), E_USER_ERROR);
2013-11-10 17:29:21 +01:00
}
2014-01-27 17:29:48 +01:00
2013-11-10 17:29:21 +01:00
// Enable callback system
$this->client->enableCallbacks(true);
2014-01-27 17:29:48 +01:00
2013-11-10 17:29:21 +01:00
// Wait for server to be ready
2014-01-27 20:28:37 +01:00
if (!$this->server->waitForStatus(4)) {
2013-11-10 17:29:21 +01:00
trigger_error("Server couldn't get ready!", E_USER_ERROR);
}
2014-01-27 17:29:48 +01:00
2013-11-10 17:29:21 +01:00
// Connect finished
2013-12-31 14:50:45 +01:00
$this->log("Server Connection successfully established!");
2014-01-27 17:29:48 +01:00
2013-12-31 14:50:45 +01:00
// Hide old widgets
2014-01-16 17:19:01 +01:00
$this->client->sendHideManialinkPage();
2014-01-27 17:29:48 +01:00
2013-11-10 17:29:21 +01:00
// Enable script callbacks if needed
2014-01-27 20:28:37 +01:00
if ($this->server->getGameMode() != 0) {
return;
}
2014-01-27 17:29:48 +01:00
2014-01-17 16:32:53 +01:00
try {
$scriptSettings = $this->client->getModeScriptSettings();
} catch(Exception $e) {
if ($e->getMessage() == 'Not in script mode.') {
return;
}
throw $e;
}
2014-01-27 17:29:48 +01:00
2014-01-27 20:28:37 +01:00
if (!array_key_exists('S_UseScriptCallbacks', $scriptSettings)) {
return;
}
2014-01-27 17:29:48 +01:00
$scriptSettings['S_UseScriptCallbacks'] = true;
2014-01-17 16:32:53 +01:00
try {
$this->client->setModeScriptSettings($scriptSettings);
} catch(Exception $e) {
2014-01-18 22:06:07 +01:00
trigger_error("Couldn't set mode script settings to enable script callbacks. " . $e->getMessage());
return;
2013-11-10 17:29:21 +01:00
}
2013-12-31 14:50:45 +01:00
$this->log('Script Callbacks successfully enabled!');
2013-11-10 17:29:21 +01:00
}
}