TrackManiaControl/application/core/ManiaControl.php

399 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;
use ManiaControl\Commands\CommandListener;
use ManiaControl\Commands\CommandManager;
use ManiaControl\Configurators\Configurator;
use ManiaControl\Manialinks\ManialinkManager;
use ManiaControl\Maps\MapManager;
use ManiaControl\Players\Player;
use ManiaControl\Players\PlayerManager;
use ManiaControl\Plugins\PluginManager;
use ManiaControl\Server\Server;
use ManiaControl\Statistics\StatisticManager;
2013-12-31 12:42:07 +01:00
require_once __DIR__ . '/Callbacks/CallbackListener.php';
require_once __DIR__ . '/Commands/CommandListener.php';
require_once __DIR__ . '/Manialinks/ManialinkPageAnswerListener.php';
2013-12-31 12:42:07 +01:00
require_once __DIR__ . '/Admin/ActionsMenu.php';
require_once __DIR__ . '/Admin/AuthenticationManager.php';
require_once __DIR__ . '/Callbacks/CallbackManager.php';
require_once __DIR__ . '/Chat.php';
require_once __DIR__ . '/ColorUtil.php';
require_once __DIR__ . '/Commands/CommandManager.php';
require_once __DIR__ . '/Configurators/Configurator.php';
require_once __DIR__ . '/Database.php';
require_once __DIR__ . '/FileUtil.php';
require_once __DIR__ . '/Formatter.php';
2013-12-17 17:38:44 +01:00
require_once __DIR__ . '/GbxDataFetcher/gbxdatafetcher.inc.php';
require_once __DIR__ . '/ManiaExchange/mxinfofetcher.inc.php';
require_once __DIR__ . '/ManiaExchange/mxinfosearcher.inc.php';
require_once __DIR__ . '/Manialinks/ManialinkManager.php';
require_once __DIR__ . '/Statistics/StatisticManager.php';
require_once __DIR__ . '/Maps/Map.php';
require_once __DIR__ . '/Maps/MapManager.php';
2013-12-14 22:00:59 +01:00
require_once __DIR__ . '/Maps/MapList.php';
2013-12-31 12:25:03 +01:00
require_once __DIR__ . '/Maps/MapQueue.php';
require_once __DIR__ . '/Players/PlayerManager.php';
2013-12-23 20:57:50 +01:00
require_once __DIR__ . '/Players/PlayerActions.php';
require_once __DIR__ . '/Plugins/PluginManager.php';
2013-12-18 15:48:33 +01:00
require_once __DIR__ . '/Players/PlayerList.php';
require_once __DIR__ . '/Server/Server.php';
require_once __DIR__ . '/Settings/SettingManager.php';
2013-12-17 17:38:44 +01:00
require_once __DIR__ . '/UpdateManager.php';
2013-11-10 17:29:21 +01:00
list($endiantest) = array_values(unpack('L1L', pack('V', 1)));
if ($endiantest == 1) {
require_once __DIR__ . '/PhpRemote/GbxRemote.inc.php';
}
else {
require_once __DIR__ . '/PhpRemote/GbxRemote.bem.php';
}
/**
* ManiaControl Server Controller for ManiaPlanet Server
*
* @author steeffeen & kremsy
2013-11-10 17:29:21 +01:00
*/
class ManiaControl implements CommandListener {
2013-11-10 17:29:21 +01:00
/**
* Constants
*/
2013-12-18 12:15:48 +01:00
const VERSION = '0.01';
2013-11-10 17:29:21 +01:00
const API_VERSION = '2013-04-16';
const OS_UNIX = 'Unix';
const OS_WIN = 'Windows';
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;
2013-12-31 12:42:07 +01:00
/**
2013-12-31 14:50:45 +01:00
*
* @var \IXR_ClientMulticall_Gbx
2013-12-31 12:42:07 +01:00
*/
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;
2013-11-10 17:29:21 +01:00
/**
* Private properties
*/
private $shutdownRequested = false;
/**
* Construct ManiaControl
*/
public function __construct() {
2013-12-31 14:50:45 +01:00
$this->log('Loading ManiaControl v' . self::VERSION . '...');
2014-01-06 14:22:48 +01:00
// Load config
$this->config = FileUtil::loadConfig('server.xml');
2013-12-17 17:38:44 +01:00
// Load ManiaControl Modules
2013-11-10 17:29:21 +01:00
$this->database = new Database($this);
$this->callbackManager = new CallbackManager($this);
2013-11-10 17:29:21 +01:00
$this->settingManager = new SettingManager($this);
2013-12-31 17:31:05 +01:00
$this->statisticManager = new StatisticManager($this);
$this->manialinkManager = new ManialinkManager($this);
2013-12-31 12:42:07 +01:00
$this->actionsMenu = new ActionsMenu($this);
2013-11-10 17:29:21 +01:00
$this->chat = new Chat($this);
$this->commandManager = new CommandManager($this);
$this->server = new Server($this);
$this->playerManager = new PlayerManager($this);
$this->authenticationManager = new AuthenticationManager($this);
$this->mapManager = new MapManager($this);
$this->configurator = new Configurator($this);
$this->pluginManager = new PluginManager($this);
2013-12-17 17:38:44 +01:00
$this->updateManager = new UpdateManager($this);
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
}
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) {
if ($stripCodes) {
$message = Formatter::stripCodes($message);
}
2013-12-09 15:53:10 +01:00
logMessage($message);
}
/**
* 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');
if ($compareOS) {
// Return bool whether OS equals $compareOS
if ($compareOS == self::OS_WIN) {
return $windows;
}
return !$windows;
}
// Return OS
if ($windows) {
return self::OS_WIN;
}
return self::OS_UNIX;
}
2013-11-10 17:29:21 +01:00
/**
* Return message composed of client error message and error code
*
2013-12-31 12:42:07 +01:00
* @param object $client
2013-11-10 17:29:21 +01:00
* @return string
*/
public function getClientErrorText($client = null) {
if (is_object($client)) {
return $client->getErrorMessage() . ' (' . $client->getErrorCode() . ')';
}
return $this->client->getErrorMessage() . ' (' . $this->client->getErrorCode() . ')';
}
/**
* Handle Version Command
*
* @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
*
* @param array $chatCallback
* @param Player $player
*/
public function command_Restart(array $chatCallback, Player $player) {
if (!AuthenticationManager::checkRight($player, AuthenticationManager::AUTH_LEVEL_SUPERADMIN)) {
$this->authenticationManager->sendNotAllowed($player);
return;
}
2014-01-01 19:25:51 +01:00
$this->restart("ManiaControl Restart requested by '{$player->login}'!");
}
/**
* Handle //shutdown command
*
* @param array $chat
* @param Player $player
*/
public function command_Shutdown(array $chat, Player $player) {
if (!$this->authenticationManager->checkRight($player, AuthenticationManager::AUTH_LEVEL_SUPERADMIN)) {
$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) {
if ($message) $this->log($message);
exit();
}
/**
* Handle PHP Process Shutdown
*/
public function handleShutdown() {
// OnShutdown callback
$this->callbackManager->triggerCallback(CallbackManager::CB_MC_ONSHUTDOWN, array(CallbackManager::CB_MC_ONSHUTDOWN));
2014-01-01 19:25:51 +01:00
// Announce quit
$this->chat->sendInformation('ManiaControl shutting down.');
2013-11-10 17:29:21 +01:00
2014-01-01 19:25:51 +01:00
// Hide manialinks
$this->client->query('SendHideManialinkPage');
// Close connection
$this->client->Terminate();
2013-11-10 17:29:21 +01:00
$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));
// Announce restart
$this->chat->sendInformation('Restarting ManiaControl...');
if ($message) $this->log($message);
// Hide widgets
$this->client->query('SendHideManialinkPage');
// Close connection
$this->client->Terminate();
2014-01-01 19:25:51 +01:00
$this->log('Restarting ManiaControl!');
// Execute start script in background
if ($this->getOS(self::OS_UNIX)) {
$command = 'sh ' . escapeshellarg(ManiaControlDir . '/ManiaControl.sh') . ' > /dev/null &';
exec($command);
}
else {
2014-01-01 19:30:42 +01:00
// TODO: validate restart on windows
$command = 'start /B ' . escapeshellarg(ManiaControlDir . '/ManiaControl.bat');
pclose(popen($command, 'r'));
}
exit();
}
2013-11-10 17:29:21 +01:00
/**
* Run ManiaControl
*/
public function run() {
$this->log('Starting ManiaControl v' . self::VERSION . '!');
2013-11-10 17:29:21 +01:00
// Load plugins
$this->pluginManager->loadPlugins();
2013-11-10 17:29:21 +01:00
// Connect to server
$this->connect();
// Register shutdown handler
2014-01-01 19:25:51 +01:00
register_shutdown_function(array($this, 'handleShutdown'));
2013-11-10 17:29:21 +01:00
// Loading finished
2013-12-31 14:50:45 +01:00
$this->log('Loading completed!');
2013-11-10 17:29:21 +01:00
// Announce ManiaControl
$this->chat->sendInformation('ManiaControl v' . self::VERSION . ' successfully started!');
// OnInit callback
$this->callbackManager->triggerCallback(CallbackManager::CB_MC_ONINIT, array(CallbackManager::CB_MC_ONINIT));
2013-11-10 17:29:21 +01:00
// Main loop
while (!$this->shutdownRequested) {
$loopStart = microtime(true);
// Disable script timeout
set_time_limit(30);
// Manager callbacks
$this->callbackManager->manageCallbacks();
2013-11-10 17:29:21 +01:00
// Yield for next tick
$loopEnd = microtime(true);
$sleepTime = 300000 - $loopEnd + $loopStart;
if ($sleepTime > 0) {
usleep($sleepTime);
}
}
// Shutdown
$this->quit();
2013-11-10 17:29:21 +01:00
}
/**
* Connect to ManiaPlanet server
*/
private function connect() {
// Load remote client
$this->client = new \IXR_ClientMulticall_Gbx();
2014-01-06 14:22:48 +01:00
$host = $this->config->server->xpath('host');
2013-11-10 17:29:21 +01:00
if (!$host) trigger_error("Invalid server configuration (host).", E_USER_ERROR);
$host = (string) $host[0];
2014-01-06 14:22:48 +01:00
$port = $this->config->server->xpath('port');
2013-11-10 17:29:21 +01:00
if (!$host) trigger_error("Invalid server configuration (port).", E_USER_ERROR);
$port = (string) $port[0];
2013-12-31 14:50:45 +01:00
$this->log("Connecting to server at {$host}:{$port}...");
2013-11-10 17:29:21 +01:00
// Connect
if (!$this->client->InitWithIp($host, $port, 20)) {
trigger_error("Couldn't connect to server! " . $this->getClientErrorText(), E_USER_ERROR);
}
2014-01-06 14:22:48 +01:00
$login = $this->config->server->xpath('login');
2013-11-10 17:29:21 +01:00
if (!$login) trigger_error("Invalid server configuration (login).", E_USER_ERROR);
$login = (string) $login[0];
2014-01-06 14:22:48 +01:00
$pass = $this->config->server->xpath('pass');
2013-11-10 17:29:21 +01:00
if (!$pass) trigger_error("Invalid server configuration (password).", E_USER_ERROR);
$pass = (string) $pass[0];
// Authenticate
if (!$this->client->query('Authenticate', $login, $pass)) {
trigger_error("Couldn't authenticate on server with user '{$login}'! " . $this->getClientErrorText(), E_USER_ERROR);
}
// Enable callback system
if (!$this->client->query('EnableCallbacks', true)) {
trigger_error("Couldn't enable callbacks! " . $this->getClientErrorText(), E_USER_ERROR);
}
// Wait for server to be ready
if (!$this->server->waitForStatus(4)) {
2013-11-10 17:29:21 +01:00
trigger_error("Server couldn't get ready!", E_USER_ERROR);
}
// Set api version
if (!$this->client->query('SetApiVersion', self::API_VERSION)) {
2014-01-05 14:13:18 +01:00
trigger_error("Couldn't set API version '" . self::API_VERSION . "'! This might cause problems. " . $this->getClientErrorText());
2013-11-10 17:29:21 +01:00
}
// Connect finished
2013-12-31 14:50:45 +01:00
$this->log("Server Connection successfully established!");
// Hide old widgets
$this->client->query('SendHideManialinkPage');
2013-11-10 17:29:21 +01:00
// Enable script callbacks if needed
if ($this->server->getGameMode() != 0) return;
if (!$this->client->query('GetModeScriptSettings')) {
trigger_error("Couldn't get mode script settings. " . $this->getClientErrorText());
return;
}
$scriptSettings = $this->client->getResponse();
if (!array_key_exists('S_UseScriptCallbacks', $scriptSettings)) return;
$scriptSettings['S_UseScriptCallbacks'] = true;
if (!$this->client->query('SetModeScriptSettings', $scriptSettings)) {
trigger_error("Couldn't set mode script settings to enable script callbacks. " . $this->getClientErrorText());
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
}
}