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

renamed server settings to server options to match dedi naming

Browse Source 
- renamed server options menu
- moved into server namespace
- changed names of table and its attributes
This commit is contained in:
Steffen Schröder 2014-07-25 15:32:46 +02:00
parent 7a69a8ed4e
commit ffb2bcba89
2 changed files with 82 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
application/core/Configurators/Configurator.php
View File

@ -17,6 +17,7 @@ use ManiaControl\ManiaControl;
use ManiaControl\Manialinks\ManialinkManager; use ManiaControl\Manialinks\ManialinkManager;
use ManiaControl\Manialinks\ManialinkPageAnswerListener; use ManiaControl\Manialinks\ManialinkPageAnswerListener;
use ManiaControl\Players\Player; use ManiaControl\Players\Player;
use ManiaControl\Server\ServerOptionsMenu;
/** /**
* Class managing ingame ManiaControl Configuration * Class managing ingame ManiaControl Configuration
@ -47,7 +48,7 @@ class Configurator implements CallbackListener, CommandListener, ManialinkPageAn
*/ */
private $maniaControl = null; private $maniaControl = null;
private $scriptSettings = null; private $scriptSettings = null;
private $serverSettings = null; private $serverOptionsMenu = null;
private $maniaControlSettings = null; private $maniaControlSettings = null;
/** @var ConfiguratorMenu[] $menus */ /** @var ConfiguratorMenu[] $menus */
private $menus = array(); private $menus = array();
@ -81,10 +82,9 @@ class Configurator implements CallbackListener, CommandListener, ManialinkPageAn
$this->maniaControl->callbackManager->registerCallbackListener(ManialinkManager::CB_MAIN_WINDOW_OPENED, $this, 'handleWidgetOpened'); $this->maniaControl->callbackManager->registerCallbackListener(ManialinkManager::CB_MAIN_WINDOW_OPENED, $this, 'handleWidgetOpened');
$this->maniaControl->callbackManager->registerCallbackListener(ManialinkManager::CB_MAIN_WINDOW_CLOSED, $this, 'closeWidget'); $this->maniaControl->callbackManager->registerCallbackListener(ManialinkManager::CB_MAIN_WINDOW_CLOSED, $this, 'closeWidget');
// Create server settings // Create server settings
$this->serverSettings = new ServerSettings($maniaControl); $this->serverOptionsMenu = new ServerOptionsMenu($maniaControl);
$this->addMenu($this->serverSettings); $this->addMenu($this->serverOptionsMenu);
// Create script settings // Create script settings
$this->scriptSettings = new ScriptSettings($maniaControl); $this->scriptSettings = new ScriptSettings($maniaControl);

149
application/core/Configurators/ServerSettings.php → application/core/Server/ServerOptionsMenu.php
View File

@ -1,6 +1,6 @@
<?php <?php
namespace ManiaControl\Configurators; namespace ManiaControl\Server;
use FML\Components\CheckBox; use FML\Components\CheckBox;
use FML\Controls\Entry; use FML\Controls\Entry;
@ -13,27 +13,32 @@ use FML\Script\Script;
use ManiaControl\Admin\AuthenticationManager; use ManiaControl\Admin\AuthenticationManager;
use ManiaControl\Callbacks\CallbackListener; use ManiaControl\Callbacks\CallbackListener;
use ManiaControl\Callbacks\Callbacks; use ManiaControl\Callbacks\Callbacks;
use ManiaControl\Configurators\ConfiguratorMenu;
use ManiaControl\ManiaControl; use ManiaControl\ManiaControl;
use ManiaControl\Players\Player; use ManiaControl\Players\Player;
use Maniaplanet\DedicatedServer\Structures\ServerOptions; use Maniaplanet\DedicatedServer\Structures\ServerOptions;
use Maniaplanet\DedicatedServer\Xmlrpc\ServerOptionsException; use Maniaplanet\DedicatedServer\Xmlrpc\ServerOptionsException;
/** /**
* Class offering a Configurator for Server Settings * Class offering a Configurator Menu for Server Options
* *
* @author ManiaControl Team <mail@maniacontrol.com> * @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014 ManiaControl Team * @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 ServerSettings implements ConfiguratorMenu, CallbackListener { class ServerOptionsMenu implements ConfiguratorMenu, CallbackListener {
/* /*
* Constants * Constants
*/ */
const ACTION_PREFIX_SETTING = 'ServerSettings.'; const CB_SERVER_OPTION_CHANGED = 'ServerOptionsMenu.OptionChanged';
const CB_SERVERSETTING_CHANGED = 'ServerSettings.SettingChanged'; const CB_SERVER_OPTIONS_CHANGED = 'ServerOptionsMenu.OptionsChanged';
const CB_SERVERSETTINGS_CHANGED = 'ServerSettings.SettingsChanged'; /** @deprecated */
const TABLE_SERVER_SETTINGS = 'mc_serversettings'; const CB_SERVERSETTING_CHANGED = 'ServerOptionsMenu.OptionChanged';
const SETTING_PERMISSION_CHANGE_SERVER_SETTINGS = 'Change Server-Settings'; /** @deprecated */
const CB_SERVERSETTINGS_CHANGED = 'ServerOptionsMenu.OptionsChanged';
const SETTING_PERMISSION_CHANGE_SERVER_OPTIONS = 'Change Server Options';
const TABLE_SERVER_OPTIONS = 'mc_server_options';
const ACTION_PREFIX_OPTION = 'ServerOptionsMenu.';
/* /*
* Private Properties * Private Properties
@ -41,7 +46,7 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener {
private $maniaControl = null; private $maniaControl = null;
/** /**
* Create a new Server Settings Instance * Create a new Server Options Instance
* *
* @param ManiaControl $maniaControl * @param ManiaControl $maniaControl
*/ */
@ -49,11 +54,11 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener {
$this->maniaControl = $maniaControl; $this->maniaControl = $maniaControl;
$this->initTables(); $this->initTables();
// Register for callbacks // Callbacks
$this->maniaControl->callbackManager->registerCallbackListener(Callbacks::ONINIT, $this, 'onInit'); $this->maniaControl->callbackManager->registerCallbackListener(Callbacks::ONINIT, $this, 'onInit');
//Permission for Change Script-Settings // Permissions
$this->maniaControl->authenticationManager->definePermissionLevel(self::SETTING_PERMISSION_CHANGE_SERVER_SETTINGS, AuthenticationManager::AUTH_LEVEL_SUPERADMIN); $this->maniaControl->authenticationManager->definePermissionLevel(self::SETTING_PERMISSION_CHANGE_SERVER_OPTIONS, AuthenticationManager::AUTH_LEVEL_SUPERADMIN);
} }
/** /**
@ -63,14 +68,14 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener {
*/ */
private function initTables() { private function initTables() {
$mysqli = $this->maniaControl->database->mysqli; $mysqli = $this->maniaControl->database->mysqli;
$query = "CREATE TABLE IF NOT EXISTS `" . self::TABLE_SERVER_SETTINGS . "` ( $query = "CREATE TABLE IF NOT EXISTS `" . self::TABLE_SERVER_OPTIONS . "` (
`index` int(11) NOT NULL AUTO_INCREMENT, `index` int(11) NOT NULL AUTO_INCREMENT,
`serverIndex` int(11) NOT NULL, `serverIndex` int(11) NOT NULL,
`settingName` varchar(100) NOT NULL, `optionName` varchar(100) NOT NULL,
`settingValue` varchar(500) NOT NULL, `optionValue` varchar(500) NOT NULL,
PRIMARY KEY (`index`), PRIMARY KEY (`index`),
UNIQUE KEY `setting` (`serverIndex`, `settingName`) UNIQUE KEY `option` (`serverIndex`, `optionName`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci COMMENT='Server Settings' AUTO_INCREMENT=1;"; ) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci COMMENT='Server Options' AUTO_INCREMENT=1;";
$statement = $mysqli->prepare($query); $statement = $mysqli->prepare($query);
if ($mysqli->error) { if ($mysqli->error) {
trigger_error($mysqli->error, E_USER_ERROR); trigger_error($mysqli->error, E_USER_ERROR);
@ -89,24 +94,24 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener {
* @see \ManiaControl\Configurators\ConfiguratorMenu::getTitle() * @see \ManiaControl\Configurators\ConfiguratorMenu::getTitle()
*/ */
public static function getTitle() { public static function getTitle() {
return 'Server Settings'; return 'Server Options';
} }
/** /**
* Handle OnInit callback * Handle OnInit callback
*/ */
public function onInit() { public function onInit() {
$this->loadSettingsFromDatabase(); $this->loadOptionsFromDatabase();
} }
/** /**
* Load Settings from Database * Load options from database
* *
* @return bool * @return bool
*/ */
public function loadSettingsFromDatabase() { public function loadOptionsFromDatabase() {
$mysqli = $this->maniaControl->database->mysqli; $mysqli = $this->maniaControl->database->mysqli;
$query = "SELECT * FROM `" . self::TABLE_SERVER_SETTINGS . "` $query = "SELECT * FROM `" . self::TABLE_SERVER_OPTIONS . "`
WHERE serverIndex = {$this->maniaControl->server->index};"; WHERE serverIndex = {$this->maniaControl->server->index};";
$result = $mysqli->query($query); $result = $mysqli->query($query);
if ($mysqli->error) { if ($mysqli->error) {
@ -118,12 +123,12 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener {
$newServerOptions = new ServerOptions(); $newServerOptions = new ServerOptions();
while ($row = $result->fetch_object()) { while ($row = $result->fetch_object()) {
$settingName = lcfirst($row->settingName); $optionName = lcfirst($row->optionName);
if (!property_exists($oldServerOptions, $settingName)) { if (!property_exists($oldServerOptions, $optionName)) {
continue; continue;
} }
$newServerOptions->$settingName = $row->settingValue; $newServerOptions->$optionName = $row->optionValue;
settype($newServerOptions->$settingName, gettype($oldServerOptions->$settingName)); settype($newServerOptions->$optionName, gettype($oldServerOptions->$optionName));
} }
$result->free(); $result->free();
@ -135,23 +140,23 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener {
} catch (ServerOptionsException $exception) { } catch (ServerOptionsException $exception) {
$this->maniaControl->chat->sendExceptionToAdmins($exception); $this->maniaControl->chat->sendExceptionToAdmins($exception);
} }
$message = ($loaded ? 'Server Settings successfully loaded!' : 'Error loading Server Settings!'); $message = ($loaded ? 'Server Options successfully loaded!' : 'Error loading Server Options!');
$this->maniaControl->chat->sendSuccessToAdmins($message); $this->maniaControl->chat->sendSuccessToAdmins($message);
return $loaded; return $loaded;
} }
/** /**
* Fill up the new server options object with the necessary settings based on the old options object * Fill up the new server options object with the necessary options based on the old options object
* *
* @param ServerOptions $newServerOptions * @param ServerOptions $newServerOptions
* @param ServerOptions $oldServerOptions * @param ServerOptions $oldServerOptions
* @return ServerOptions * @return ServerOptions
*/ */
private function fillUpMandatoryOptions(ServerOptions &$newServerOptions, ServerOptions $oldServerOptions) { private function fillUpMandatoryOptions(ServerOptions &$newServerOptions, ServerOptions $oldServerOptions) {
$mandatorySettings = array('name', 'comment', 'password', 'passwordForSpectator', 'nextCallVoteTimeOut', 'callVoteRatio'); $mandatoryOptions = array('name', 'comment', 'password', 'passwordForSpectator', 'nextCallVoteTimeOut', 'callVoteRatio');
foreach ($mandatorySettings as $settingName) { foreach ($mandatoryOptions as $optionName) {
if (!isset($newServerOptions->$settingName) && isset($oldServerOptions->$settingName)) { if (!isset($newServerOptions->$optionName) && isset($oldServerOptions->$optionName)) {
$newServerOptions->$settingName = $oldServerOptions->$settingName; $newServerOptions->$optionName = $oldServerOptions->$optionName;
} }
} }
return $newServerOptions; return $newServerOptions;
@ -166,11 +171,11 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener {
$frame = new Frame(); $frame = new Frame();
$serverOptions = $this->maniaControl->client->getServerOptions(); $serverOptions = $this->maniaControl->client->getServerOptions();
$serverSettings = $serverOptions->toArray(); $serverOptionsArray = $serverOptions->toArray();
// Config // Config
$pagerSize = 9.; $pagerSize = 9.;
$settingHeight = 5.; $optionHeight = 5.;
$labelTextSize = 2; $labelTextSize = 2;
// Pagers // Pagers
@ -197,12 +202,12 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener {
->addButton($pagerPrev) ->addButton($pagerPrev)
->setLabel($pageCountLabel); ->setLabel($pageCountLabel);
// Setting pages // Pages
$posY = 0.; $posY = 0.;
$index = 0; $index = 0;
$pageFrame = null; $pageFrame = null;
foreach ($serverSettings as $name => $value) { foreach ($serverOptionsArray as $name => $value) {
// Continue on CurrentMaxPlayers... // Continue on CurrentMaxPlayers...
$pos = strpos($name, 'Current'); // TODO: display 'Current...' somewhere $pos = strpos($name, 'Current'); // TODO: display 'Current...' somewhere
if ($pos !== false) { if ($pos !== false) {
@ -216,15 +221,15 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener {
$paging->addPage($pageFrame); $paging->addPage($pageFrame);
} }
$settingFrame = new Frame(); $optionsFrame = new Frame();
$pageFrame->add($settingFrame); $pageFrame->add($optionsFrame);
$settingFrame->setY($posY); $optionsFrame->setY($posY);
$nameLabel = new Label_Text(); $nameLabel = new Label_Text();
$settingFrame->add($nameLabel); $optionsFrame->add($nameLabel);
$nameLabel->setHAlign($nameLabel::LEFT) $nameLabel->setHAlign($nameLabel::LEFT)
->setX($width * -0.46) ->setX($width * -0.46)
->setSize($width * 0.4, $settingHeight) ->setSize($width * 0.4, $optionHeight)
->setStyle($nameLabel::STYLE_TextCardSmall) ->setStyle($nameLabel::STYLE_TextCardSmall)
->setTextSize($labelTextSize) ->setTextSize($labelTextSize)
->setText($name) ->setText($name)
@ -235,29 +240,29 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener {
$quad = new Quad(); $quad = new Quad();
$quad->setPosition($width * 0.23, 0, -0.01) $quad->setPosition($width * 0.23, 0, -0.01)
->setSize(4, 4); ->setSize(4, 4);
$checkBox = new CheckBox(self::ACTION_PREFIX_SETTING . $name, $value, $quad); $checkBox = new CheckBox(self::ACTION_PREFIX_OPTION . $name, $value, $quad);
$settingFrame->add($checkBox); $optionsFrame->add($checkBox);
} else { } else {
// Other // Other
$entry = new Entry(); $entry = new Entry();
$settingFrame->add($entry); $optionsFrame->add($entry);
$entry->setStyle(Label_Text::STYLE_TextValueSmall) $entry->setStyle(Label_Text::STYLE_TextValueSmall)
->setX($width * 0.23) ->setX($width * 0.23)
->setTextSize(1) ->setTextSize(1)
->setSize($width * 0.48, $settingHeight * 0.9) ->setSize($width * 0.48, $optionHeight * 0.9)
->setName(self::ACTION_PREFIX_SETTING . $name) ->setName(self::ACTION_PREFIX_OPTION . $name)
->setDefault($value); ->setDefault($value);
if ($name === 'Comment') { if ($name === 'Comment') {
$entry->setSize($width * 0.48, $settingHeight * 3. + $settingHeight * 0.9) $entry->setSize($width * 0.48, $optionHeight * 3. + $optionHeight * 0.9)
->setAutoNewLine(true); ->setAutoNewLine(true);
$settingFrame->setY($posY - $settingHeight * 1.5); $optionsFrame->setY($posY - $optionHeight * 1.5);
$posY -= $settingHeight * 3.; $posY -= $optionHeight * 3.;
$index += 3; $index += 3;
} }
} }
$posY -= $settingHeight; $posY -= $optionHeight;
$index++; $index++;
} }
@ -268,32 +273,32 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener {
* @see \ManiaControl\Configurators\ConfiguratorMenu::saveConfigData() * @see \ManiaControl\Configurators\ConfiguratorMenu::saveConfigData()
*/ */
public function saveConfigData(array $configData, Player $player) { public function saveConfigData(array $configData, Player $player) {
if (!$this->maniaControl->authenticationManager->checkPermission($player, self::SETTING_PERMISSION_CHANGE_SERVER_SETTINGS)) { if (!$this->maniaControl->authenticationManager->checkPermission($player, self::SETTING_PERMISSION_CHANGE_SERVER_OPTIONS)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player); $this->maniaControl->authenticationManager->sendNotAllowed($player);
return; return;
} }
if (!$configData[3] || strpos($configData[3][0]['Name'], self::ACTION_PREFIX_SETTING) !== 0) { if (!$configData[3] || strpos($configData[3][0]['Name'], self::ACTION_PREFIX_OPTION) !== 0) {
return; return;
} }
$prefixLength = strlen(self::ACTION_PREFIX_SETTING); $prefixLength = strlen(self::ACTION_PREFIX_OPTION);
$oldServerOptions = $this->maniaControl->client->getServerOptions(); $oldServerOptions = $this->maniaControl->client->getServerOptions();
$newServerOptions = new ServerOptions(); $newServerOptions = new ServerOptions();
foreach ($configData[3] as $setting) { foreach ($configData[3] as $option) {
$settingName = lcfirst(substr($setting['Name'], $prefixLength)); $optionName = lcfirst(substr($option['Name'], $prefixLength));
$newServerOptions->$settingName = $setting['Value']; $newServerOptions->$optionName = $option['Value'];
settype($newServerOptions->$settingName, gettype($oldServerOptions->$settingName)); settype($newServerOptions->$optionName, gettype($oldServerOptions->$optionName));
} }
$this->fillUpMandatoryOptions($newServerOptions, $oldServerOptions); $this->fillUpMandatoryOptions($newServerOptions, $oldServerOptions);
$success = $this->applyNewServerOptions($newServerOptions, $player); $success = $this->applyNewServerOptions($newServerOptions, $player);
if ($success) { if ($success) {
$this->maniaControl->chat->sendSuccess('Server Settings saved!', $player); $this->maniaControl->chat->sendSuccess('Server Options saved!', $player);
} else { } else {
$this->maniaControl->chat->sendSuccess('Server Settings saving failed!', $player); $this->maniaControl->chat->sendError('Server Options saving failed!', $player);
} }
// Reopen the Menu // Reopen the Menu
@ -301,7 +306,7 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener {
} }
/** /**
* Apply the Array of new Server Settings * Apply the array of new Server Options
* *
* @param ServerOptions $newServerOptions * @param ServerOptions $newServerOptions
* @param Player $player * @param Player $player
@ -317,7 +322,7 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener {
$this->saveServerOptions($newServerOptions, true); $this->saveServerOptions($newServerOptions, true);
$this->maniaControl->callbackManager->triggerCallback(self::CB_SERVERSETTINGS_CHANGED, array(self::CB_SERVERSETTINGS_CHANGED)); $this->maniaControl->callbackManager->triggerCallback(self::CB_SERVER_OPTIONS_CHANGED, array(self::CB_SERVER_OPTIONS_CHANGED));
return true; return true;
} }
@ -331,27 +336,27 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener {
*/ */
private function saveServerOptions(ServerOptions $serverOptions, $triggerCallbacks = false) { private function saveServerOptions(ServerOptions $serverOptions, $triggerCallbacks = false) {
$mysqli = $this->maniaControl->database->mysqli; $mysqli = $this->maniaControl->database->mysqli;
$query = "INSERT INTO `" . self::TABLE_SERVER_SETTINGS . "` ( $query = "INSERT INTO `" . self::TABLE_SERVER_OPTIONS . "` (
`serverIndex`, `serverIndex`,
`settingName`, `optionName`,
`settingValue` `optionValue`
) VALUES ( ) VALUES (
?, ?, ? ?, ?, ?
) ON DUPLICATE KEY UPDATE ) ON DUPLICATE KEY UPDATE
`settingValue` = VALUES(`settingValue`);"; `optionValue` = VALUES(`optionValue`);";
$statement = $mysqli->prepare($query); $statement = $mysqli->prepare($query);
if ($mysqli->error) { if ($mysqli->error) {
trigger_error($mysqli->error); trigger_error($mysqli->error);
return false; return false;
} }
$settingName = null; $optionName = null;
$settingValue = null; $optionValue = null;
$statement->bind_param('iss', $this->maniaControl->server->index, $settingName, $settingValue); $statement->bind_param('iss', $this->maniaControl->server->index, $optionName, $optionValue);
$settingsArray = $serverOptions->toArray(); $serverOptionsArray = $serverOptions->toArray();
foreach ($settingsArray as $settingName => $settingValue) { foreach ($serverOptionsArray as $optionName => $optionValue) {
if ($settingValue === null) { if ($optionValue === null) {
continue; continue;
} }
@ -363,7 +368,7 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener {
} }
if ($triggerCallbacks) { if ($triggerCallbacks) {
$this->maniaControl->callbackManager->triggerCallback(self::CB_SERVERSETTING_CHANGED, array(self::CB_SERVERSETTING_CHANGED, $settingName, $settingValue)); $this->maniaControl->callbackManager->triggerCallback(self::CB_SERVER_OPTION_CHANGED, array(self::CB_SERVER_OPTION_CHANGED, $optionName, $optionValue));
} }
} }