TrackManiaControl/application/core/ManiaControl.php

645 lines
16 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;
2014-02-25 18:34:35 +01:00
use ManiaControl\Bills\BillManager;
2014-06-20 16:19:30 +02:00
use ManiaControl\Callbacks\CallbackListener;
use ManiaControl\Callbacks\CallbackManager;
use ManiaControl\Callbacks\Callbacks;
2014-02-22 11:14:35 +01:00
use ManiaControl\Callbacks\TimerListener;
2014-01-30 22:35:32 +01:00
use ManiaControl\Callbacks\TimerManager;
use ManiaControl\Commands\CommandListener;
use ManiaControl\Commands\CommandManager;
use ManiaControl\Configurator\Configurator;
2014-05-02 17:40:47 +02:00
use ManiaControl\Database\Database;
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;
use ManiaControl\Utils\CommandLineHelper;
2014-06-15 00:51:43 +02:00
use ManiaControl\Utils\SystemUtil;
2014-01-16 17:19:01 +01:00
use Maniaplanet\DedicatedServer\Connection;
use Maniaplanet\DedicatedServer\Xmlrpc\AuthenticationException;
2014-04-27 15:21:57 +02:00
use Maniaplanet\DedicatedServer\Xmlrpc\TransportException;
2013-12-31 12:42:07 +01:00
2014-08-03 13:02:02 +02:00
require_once ManiaControlDir . '/libs/Maniaplanet/DedicatedServer/Connection.php';
require_once ManiaControlDir . '/libs/FML/autoload.php';
require_once ManiaControlDir . '/libs/Symfony/autoload.php';
require_once ManiaControlDir . '/libs/curl-easy/autoload.php';
2014-02-18 18:13:59 +01:00
2013-11-10 17:29:21 +01:00
/**
* ManiaControl Server Controller for ManiaPlanet Server
2014-05-02 17:40:47 +02:00
*
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
2013-11-10 17:29:21 +01:00
*/
2014-06-20 16:19:30 +02:00
class ManiaControl implements CallbackListener, CommandListener, TimerListener {
/*
2013-11-10 17:29:21 +01:00
* Constants
*/
2014-07-28 14:40:00 +02:00
const VERSION = '0.153';
2014-05-02 17:40:47 +02:00
const API_VERSION = '2013-04-16';
const MIN_DEDIVERSION = '2014-04-02_18_00';
2014-05-09 16:33:33 +02:00
const SCRIPT_TIMEOUT = 10;
2014-05-02 17:40:47 +02:00
const URL_WEBSERVICE = 'http://ws.maniacontrol.com/';
2014-01-31 16:55:01 +01:00
const SETTING_PERMISSION_SHUTDOWN = 'Shutdown ManiaControl';
2014-05-02 17:40:47 +02:00
const SETTING_PERMISSION_RESTART = 'Restart ManiaControl';
/*
* Public properties
2013-11-10 17:29:21 +01:00
*/
/** @var ActionsMenu $actionsMenu */
/** @deprecated see getActionsMenu() */
2013-12-31 12:42:07 +01:00
public $actionsMenu = null;
/** @var AuthenticationManager $authenticationManager */
/** @deprecated see getAuthenticationManager() */
public $authenticationManager = null;
/** @var CallbackManager $callbackManager */
/** @deprecated see getCallbackManager() */
public $callbackManager = null;
/** @var Chat $chat */
/** @deprecated see getChat() */
2013-11-10 17:29:21 +01:00
public $chat = null;
/** @var \SimpleXMLElement $config */
/** @deprecated see getConfig() */
public $config = null;
/** @var Configurator $configurator */
/** @deprecated see getConfigurator() */
public $configurator = null;
2014-05-10 10:12:48 +02:00
/** @var Connection $client */
/** @deprecated see getClient() */
2013-11-10 17:29:21 +01:00
public $client = null;
/** @var CommandManager $commandManager */
/** @deprecated see getCommandManager() */
public $commandManager = null;
/** @var Database $database */
/** @deprecated see getDatabase() */
2013-11-10 17:29:21 +01:00
public $database = null;
/** @var ManialinkManager $manialinkManager */
/** @deprecated see getManialinkManager */
public $manialinkManager = null;
/** @var MapManager $mapManager */
/** @deprecated see getMapManager() */
public $mapManager = null;
/** @var PlayerManager $playerManager */
/** @deprecated see getPlayerManager() */
public $playerManager = null;
/** @var PluginManager $pluginManager */
/** @deprecated see getPluginManager() */
public $pluginManager = null;
/** @var Server $server */
/** @deprecated see getServer() */
2013-11-10 17:29:21 +01:00
public $server = null;
/** @var SettingManager $settingManager */
/** @deprecated see getSettingManager() */
2013-11-10 17:29:21 +01:00
public $settingManager = null;
/** @var StatisticManager $statisticManager */
/** @deprecated see getStatisticManager() */
2013-12-31 17:31:05 +01:00
public $statisticManager = null;
2014-05-02 15:35:52 +02:00
/** @var UpdateManager $updateManager */
/** @deprecated see getUpdateManager() */
2013-12-17 17:38:44 +01:00
public $updateManager = null;
/** @var ErrorHandler $errorHandler */
/** @deprecated see getErrorHandler() */
2014-01-27 20:28:37 +01:00
public $errorHandler = null;
/** @var TimerManager $timerManager */
/** @deprecated see getTimerManager() */
2014-01-30 22:35:32 +01:00
public $timerManager = null;
/** @var AsynchronousFileReader $fileReader */
/** @deprecated see getFileReader() */
2014-02-07 12:30:53 +01:00
public $fileReader = null;
/** @var BillManager $billManager */
/** @deprecated see getBillManager() */
2014-02-25 18:34:35 +01:00
public $billManager = null;
2014-05-02 17:40:47 +02:00
/*
* Private properties
2013-11-10 17:29:21 +01:00
*/
2014-06-20 16:34:19 +02:00
private $requestQuitMessage = null;
2013-11-10 17:29:21 +01:00
/**
* Construct a new ManiaControl instance
2013-11-10 17:29:21 +01:00
*/
public function __construct() {
Logger::log('Loading ManiaControl v' . self::VERSION . ' ...');
2014-05-02 17:40:47 +02:00
2014-06-26 11:07:53 +02:00
$this->errorHandler = new ErrorHandler($this);
$this->loadConfig();
2014-05-02 17:40:47 +02:00
2013-12-17 17:38:44 +01:00
// Load ManiaControl Modules
2014-05-02 17:40:47 +02:00
$this->callbackManager = new CallbackManager($this);
$this->timerManager = new TimerManager($this);
$this->database = new Database($this);
$this->fileReader = new AsynchronousFileReader($this);
$this->billManager = new BillManager($this);
$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-05-02 17:40:47 +02: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-08-05 02:17:41 +02:00
$this->getErrorHandler()
->init();
// Permissions
2014-08-05 02:17:41 +02:00
$this->getAuthenticationManager()
->definePermissionLevel(self::SETTING_PERMISSION_SHUTDOWN, AuthenticationManager::AUTH_LEVEL_SUPERADMIN);
$this->getAuthenticationManager()
->definePermissionLevel(self::SETTING_PERMISSION_RESTART, AuthenticationManager::AUTH_LEVEL_SUPERADMIN);
2014-05-02 17:40:47 +02:00
// Commands
2014-08-05 02:17:41 +02:00
$this->getCommandManager()
->registerCommandListener('version', $this, 'commandVersion', false, 'Shows ManiaControl version.');
$this->getCommandManager()
->registerCommandListener('restart', $this, 'commandRestart', true, 'Restarts ManiaControl.');
$this->getCommandManager()
->registerCommandListener('shutdown', $this, 'commandShutdown', true, 'Shuts ManiaControl down.');
2014-05-02 17:40:47 +02:00
// Check connection every 30 seconds
2014-08-05 02:17:41 +02:00
$this->getTimerManager()
->registerTimerListening($this, 'checkConnection', 1000 * 30);
}
2014-05-02 17:40:47 +02:00
/**
* Print a message to console and log
*
* @param string $message
* @param bool $stripCodes
* @deprecated
* @see Logger::log()
2014-05-02 17:40:47 +02:00
*/
public function log($message, $stripCodes = false) {
Logger::log($message, $stripCodes);
2014-05-02 17:40:47 +02:00
}
/**
* Load the Config XML-File
*/
private function loadConfig() {
2014-05-02 17:40:47 +02:00
$configId = CommandLineHelper::getParameter('-config');
$configFileName = ($configId ? $configId : 'server.xml');
2014-08-05 02:17:41 +02:00
$config = FileUtil::loadConfig($configFileName);
if (!$config) {
2014-05-15 13:04:05 +02:00
$this->quit("Error loading Configuration XML-File! ('{$configFileName}')", true);
}
if ($config->count() < 3) {
2014-05-27 08:57:26 +02:00
$this->quit("Your Configuration File ('{$configFileName}') doesn't seem to be maintained properly. Please check it again!", true);
}
$this->config = $config;
}
2014-05-15 13:04:05 +02:00
/**
* Quit ManiaControl and log the given message
*
* @param string $message
* @param bool $errorPrefix
*/
public function quit($message = null, $errorPrefix = false) {
Connection::delete($this->getClient());
2014-05-29 22:54:43 +02:00
$this->client = null;
2014-08-02 20:51:48 +02:00
SystemUtil::quit($message, $errorPrefix);
2014-05-29 22:54:43 +02:00
}
/**
* Return the actions menu
*
* @return ActionsMenu
*/
public function getActionsMenu() {
return $this->actionsMenu;
}
/**
* Return the authentication manager
*
* @return AuthenticationManager
*/
public function getAuthenticationManager() {
return $this->authenticationManager;
}
/**
* Return the callback manager
*
* @return CallbackManager
*/
public function getCallbackManager() {
return $this->callbackManager;
}
/**
* Return the chat
*
* @return Chat
*/
public function getChat() {
return $this->chat;
}
/**
* Return the config
*
* @return \SimpleXMLElement
*/
public function getConfig() {
return $this->config;
}
/**
* Return the configurator
*
* @return Configurator
*/
public function getConfigurator() {
return $this->configurator;
}
/**
* Return the client
*
* @return Connection
*/
public function getClient() {
return $this->client;
}
/**
* Return the command manager
*
* @return CommandManager
*/
public function getCommandManager() {
return $this->commandManager;
}
/**
* Return the database
*
* @return Database
*/
public function getDatabase() {
return $this->database;
}
/**
* Return the manialink manager
*
* @return ManialinkManager
*/
public function getManialinkManager() {
return $this->manialinkManager;
}
/**
* Return the map manager
*
* @return MapManager
*/
public function getMapManager() {
return $this->mapManager;
}
/**
* Return the player manager
*
* @return PlayerManager
*/
public function getPlayerManager() {
return $this->playerManager;
}
/**
* Return the plugin manager
*
* @return PluginManager
*/
public function getPluginManager() {
return $this->pluginManager;
}
/**
* Return the server
*
* @return Server
*/
public function getServer() {
return $this->server;
}
/**
* Return the setting manager
*
* @return SettingManager
*/
public function getSettingManager() {
return $this->settingManager;
}
/**
* Return the statistic manager
*
* @return StatisticManager
*/
public function getStatisticManager() {
return $this->statisticManager;
}
/**
* Return the update manager
*
* @return UpdateManager
*/
public function getUpdateManager() {
return $this->updateManager;
}
/**
* Return the error handler
*
* @return ErrorHandler
*/
public function getErrorHandler() {
return $this->errorHandler;
}
/**
* Return the timer manager
*
* @return TimerManager
*/
public function getTimerManager() {
return $this->timerManager;
}
/**
* Return the file reader
*
* @return AsynchronousFileReader
*/
public function getFileReader() {
return $this->fileReader;
}
/**
* Return the bill manager
*
* @return BillManager
*/
public function getBillManager() {
return $this->billManager;
}
/**
2014-08-02 20:51:48 +02:00
* Check connection
*/
public function checkConnection() {
2014-08-05 02:17:41 +02:00
if ($this->getClient()
->getIdleTime() > 180
) {
$this->getClient()
->getServerName();
}
2013-11-10 17:29:21 +01:00
}
2013-12-09 15:53:10 +01:00
/**
2014-05-02 17:40:47 +02:00
* Handle Version Command
*
* @param array $chatCallback
* @param Player $player
*/
public function commandVersion(array $chatCallback, Player $player) {
2014-05-02 17:40:47 +02:00
$message = 'This server is using ManiaControl v' . ManiaControl::VERSION . '!';
2014-08-05 02:17:41 +02:00
$this->getChat()
->sendInformation($message, $player);
2014-05-02 17:40:47 +02:00
}
/**
* Handle Restart AdminCommand
*
* @param array $chatCallback
* @param Player $player
*/
public function commandRestart(array $chatCallback, Player $player) {
2014-08-05 02:17:41 +02:00
if (!$this->getAuthenticationManager()
->checkPermission($player, self::SETTING_PERMISSION_RESTART)
) {
$this->getAuthenticationManager()
->sendNotAllowed($player);
2014-05-02 17:40:47 +02:00
return;
}
$this->restart("ManiaControl Restart requested by '{$player->login}'!");
}
/**
* Restart ManiaControl
*
2013-12-31 12:42:07 +01:00
* @param string $message
2013-12-09 15:53:10 +01:00
*/
2014-05-02 17:40:47 +02:00
public function restart($message = null) {
// Shutdown callback
2014-08-05 02:17:41 +02:00
$this->getCallbackManager()
->triggerCallback(Callbacks::ONSHUTDOWN);
2014-05-02 17:40:47 +02:00
// Announce restart
if ($message) {
Logger::log($message);
2014-01-05 14:13:18 +01:00
}
2014-08-05 02:17:41 +02:00
$this->getChat()
->sendInformation('Restarting ManiaControl...');
Logger::log('Restarting ManiaControl!');
2014-05-02 17:40:47 +02:00
// Hide widgets
if ($this->getClient()) {
2014-08-05 02:17:41 +02:00
$this->getClient()
->sendHideManialinkPage();
2014-06-13 16:48:14 +02:00
}
2014-05-02 17:40:47 +02:00
2014-08-02 20:51:48 +02:00
// Start new instance
SystemUtil::restart();
2014-08-02 20:51:48 +02:00
// Quit old instance
$this->quit('Quitting ManiaControl to restart.');
2013-12-09 15:53:10 +01:00
}
2014-01-01 19:25:51 +01:00
/**
* Handle Shutdown Command
2014-05-02 17:40:47 +02:00
*
* @param array $chat
2014-01-01 19:25:51 +01:00
* @param Player $player
*/
public function commandShutdown(array $chat, Player $player) {
2014-08-05 02:17:41 +02:00
if (!$this->getAuthenticationManager()
->checkPermission($player, self::SETTING_PERMISSION_SHUTDOWN)
) {
$this->getAuthenticationManager()
->sendNotAllowed($player);
2014-01-01 19:25:51 +01:00
return;
}
2014-06-20 16:34:19 +02:00
$this->requestQuit("ManiaControl Shutdown requested by '{$player->login}'!");
}
2014-06-23 16:14:47 +02:00
/**
* Request ManiaControl to quit
*
* @param mixed $message
*/
public function requestQuit($message = true) {
$this->requestQuitMessage = $message;
}
2013-11-10 17:29:21 +01:00
/**
* Run ManiaControl
*/
public function run() {
Logger::log('Starting ManiaControl v' . self::VERSION . '!');
2014-05-02 17:40:47 +02:00
2014-02-15 21:48:23 +01:00
// Connect to server
try {
$this->connect();
} catch (TransportException $e) {
$this->quit($e->getMessage(), true);
}
2014-05-02 17:40:47 +02:00
2014-04-14 12:18:44 +02:00
// Check if the version of the server is high enough
2014-08-05 02:17:41 +02:00
$version = $this->getClient()
->getVersion();
if ($version->build < self::MIN_DEDIVERSION) {
2014-05-29 22:54:43 +02:00
$this->quit("The Server has Version '{$version->build}', while at least '" . self::MIN_DEDIVERSION . "' is required!", true);
2014-04-30 00:19:18 +02:00
}
2014-05-02 17:40:47 +02:00
2014-06-20 16:19:30 +02:00
// Listen for shutdown
2014-08-05 02:17:41 +02:00
$this->getCallbackManager()
->registerCallbackListener(CallbackManager::CB_MP_SERVERSTOP, $this, 'handleServerStopCallback');
2014-06-20 16:19:30 +02:00
// OnInit callback
2014-08-05 02:17:41 +02:00
$this->getCallbackManager()
->triggerCallback(Callbacks::ONINIT);
2014-05-02 17:40:47 +02:00
2014-01-18 10:26:32 +01:00
// Load plugins
2014-08-05 02:17:41 +02:00
$this->getPluginManager()
->loadPlugins();
$this->getUpdateManager()
->getPluginUpdateManager()
->checkPluginsUpdate();
2014-05-02 17:40:47 +02:00
// AfterInit callback
2014-08-05 02:17:41 +02:00
$this->getCallbackManager()
->triggerCallback(Callbacks::AFTERINIT);
2014-05-02 17:40:47 +02:00
// Loading finished
Logger::log('Loading completed!');
2014-08-05 02:17:41 +02:00
Logger::log('Link: ' . $this->getServer()
->getJoinLink());
$this->getChat()
->sendInformation('ManiaControl v' . self::VERSION . ' successfully started!');
2014-05-02 17:40:47 +02:00
2013-11-10 17:29:21 +01:00
// Main loop
2014-06-20 16:34:19 +02:00
while (!$this->requestQuitMessage) {
2014-05-09 13:46:04 +02:00
$this->loop();
}
2014-05-02 17:40:47 +02:00
2014-05-09 13:46:04 +02:00
// Shutdown
2014-06-20 16:34:19 +02:00
$this->quit($this->requestQuitMessage);
2014-05-09 13:46:04 +02:00
}
2014-05-02 17:40:47 +02:00
2013-11-10 17:29:21 +01:00
/**
* Connect to ManiaPlanet server
*/
private function connect() {
// Load remote client
2014-08-05 02:17:41 +02:00
$serverConfig = $this->getServer()
->loadConfig();
2014-05-02 17:40:47 +02:00
Logger::log("Connecting to Server at {$serverConfig->host}:{$serverConfig->port}...");
2014-05-02 17:40:47 +02:00
2014-01-17 16:32:53 +01:00
try {
$this->client = Connection::factory($serverConfig->host, $serverConfig->port, self::SCRIPT_TIMEOUT, $serverConfig->user, $serverConfig->pass, self::API_VERSION);
2014-06-23 16:14:47 +02:00
} catch (TransportException $exception) {
$message = "Couldn't connect to the server: '{$exception->getMessage()}'";
$this->quit($message, true);
} catch (AuthenticationException $exception) {
$message = "Couldn't authenticate on Server with User '{$serverConfig->user}' & Pass '{$serverConfig->pass}'! " . $exception->getMessage();
2014-05-09 14:08:39 +02:00
$this->quit($message, true);
}
2014-05-02 17:40:47 +02:00
2013-11-10 17:29:21 +01:00
// Enable callback system
2014-08-05 02:17:41 +02:00
$this->getClient()
->enableCallbacks(true);
2014-05-02 17:40:47 +02:00
2013-11-10 17:29:21 +01:00
// Wait for server to be ready
2014-08-05 02:17:41 +02:00
if (!$this->getServer()
->waitForStatus(4)
) {
$this->quit("Server couldn't get ready!");
2013-11-10 17:29:21 +01:00
}
2014-05-02 17:40:47 +02:00
2013-11-10 17:29:21 +01:00
// Connect finished
Logger::log('Server Connection successfully established!');
2014-05-02 17:40:47 +02:00
2013-12-31 14:50:45 +01:00
// Hide old widgets
2014-08-05 02:17:41 +02:00
$this->getClient()
->sendHideManialinkPage();
2014-05-02 17:40:47 +02:00
// Enable script callbacks
2014-08-05 02:17:41 +02:00
$this->getServer()
->getScriptManager()
->enableScriptCallbacks();
2013-11-10 17:29:21 +01:00
}
2014-05-09 14:08:39 +02:00
/**
* Perform the Main Loop
*/
private function loop() {
$loopStart = microtime(true);
2014-05-09 16:33:33 +02:00
// Extend script timeout
2014-05-09 14:08:39 +02:00
set_time_limit(self::SCRIPT_TIMEOUT);
try {
2014-08-05 02:17:41 +02:00
$this->getCallbackManager()
->manageCallbacks();
2014-05-09 14:08:39 +02:00
} catch (TransportException $e) {
Logger::logError('Connection interrupted!');
2014-05-09 14:08:39 +02:00
$this->quit($e->getMessage(), true);
}
// Manage FileReader
2014-08-05 02:17:41 +02:00
$this->getFileReader()
->appendData();
2014-05-09 14:08:39 +02:00
// Yield for next tick
$loopEnd = microtime(true);
$loopDuration = $loopEnd - $loopStart;
$sleepTime = (int)(2500 - $loopDuration * 1000000);
if ($sleepTime > 0) {
usleep($sleepTime);
}
}
2014-06-20 16:19:30 +02:00
/**
* Handle Server Stop Callback
*/
2014-06-20 16:22:45 +02:00
public function handleServerStopCallback() {
2014-06-20 16:34:19 +02:00
$this->requestQuit('The Server has been shut down!');
}
2013-11-10 17:29:21 +01:00
}