TrackManiaControl/application/core/Configurators/ServerSettings.php

351 lines
10 KiB
PHP
Raw Normal View History

2014-01-02 23:49:21 +01:00
<?php
namespace ManiaControl\Configurators;
use FML\Components\CheckBox;
2014-01-02 23:49:21 +01:00
use FML\Controls\Entry;
use FML\Controls\Frame;
use FML\Controls\Labels\Label_Text;
use FML\Controls\Quad;
2014-01-02 23:49:21 +01:00
use FML\Controls\Quads\Quad_Icons64x64_1;
2014-04-27 16:22:12 +02:00
use FML\Script\Features\Paging;
2014-01-02 23:49:21 +01:00
use FML\Script\Script;
2014-04-13 19:05:54 +02:00
use ManiaControl\Admin\AuthenticationManager;
2014-01-02 23:49:21 +01:00
use ManiaControl\Callbacks\CallbackListener;
use ManiaControl\Callbacks\Callbacks;
2014-01-02 23:49:21 +01:00
use ManiaControl\ManiaControl;
use ManiaControl\Players\Player;
use Maniaplanet\DedicatedServer\Structures\ServerOptions;
2014-05-08 21:10:56 +02:00
use Maniaplanet\DedicatedServer\Xmlrpc\ServerOptionsException;
2014-01-02 23:49:21 +01:00
/**
* Class offering a Configurator for Server Settings
*
2014-05-02 17:50:30 +02:00
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014 ManiaControl Team
2014-04-13 19:05:54 +02:00
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
2014-01-02 23:49:21 +01:00
*/
class ServerSettings implements ConfiguratorMenu, CallbackListener {
/*
2014-01-02 23:49:21 +01:00
* Constants
*/
const ACTION_PREFIX_SETTING = 'ServerSettings.';
2014-04-13 19:05:54 +02:00
const CB_SERVERSETTING_CHANGED = 'ServerSettings.SettingChanged';
const CB_SERVERSETTINGS_CHANGED = 'ServerSettings.SettingsChanged';
const TABLE_SERVER_SETTINGS = 'mc_serversettings';
const SETTING_PERMISSION_CHANGE_SERVER_SETTINGS = 'Change Server-Settings';
2014-01-05 20:34:48 +01:00
/*
2014-01-02 23:49:21 +01:00
* Private Properties
*/
private $maniaControl = null;
/**
* Create a new Server Settings Instance
*
* @param ManiaControl $maniaControl
*/
public function __construct(ManiaControl $maniaControl) {
$this->maniaControl = $maniaControl;
2014-01-05 12:21:40 +01:00
$this->initTables();
2014-01-05 20:34:48 +01:00
2014-01-02 23:49:21 +01:00
// Register for callbacks
$this->maniaControl->callbackManager->registerCallbackListener(Callbacks::ONINIT, $this, 'onInit');
2014-04-13 19:05:54 +02:00
//Permission for Change Script-Settings
$this->maniaControl->authenticationManager->definePermissionLevel(self::SETTING_PERMISSION_CHANGE_SERVER_SETTINGS, AuthenticationManager::AUTH_LEVEL_SUPERADMIN);
2014-01-04 17:18:11 +01:00
}
/**
* Initialize necessary database tables
*
* @return bool
*/
private function initTables() {
2014-01-05 20:34:48 +01:00
$mysqli = $this->maniaControl->database->mysqli;
$query = "CREATE TABLE IF NOT EXISTS `" . self::TABLE_SERVER_SETTINGS . "` (
`index` int(11) NOT NULL AUTO_INCREMENT,
`serverIndex` int(11) NOT NULL,
`settingName` varchar(100) NOT NULL,
`settingValue` varchar(500) NOT NULL,
PRIMARY KEY (`index`),
2014-01-05 14:41:19 +01:00
UNIQUE KEY `setting` (`serverIndex`, `settingName`)
2014-01-04 17:18:11 +01:00
) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci COMMENT='Server Settings' AUTO_INCREMENT=1;";
$statement = $mysqli->prepare($query);
2014-02-01 20:03:17 +01:00
if ($mysqli->error) {
2014-01-04 17:18:11 +01:00
trigger_error($mysqli->error, E_USER_ERROR);
return false;
}
$statement->execute();
2014-02-01 20:03:17 +01:00
if ($statement->error) {
2014-01-04 17:18:11 +01:00
trigger_error($statement->error, E_USER_ERROR);
return false;
}
$statement->close();
return true;
}
/**
* Handle OnInit callback
*/
public function onInit() {
2014-01-04 17:18:11 +01:00
$this->loadSettingsFromDatabase();
}
/**
* Load Settings from Database
2014-01-04 17:30:29 +01:00
*
2014-01-04 17:18:11 +01:00
* @return bool
*/
public function loadSettingsFromDatabase() {
2014-01-12 22:24:30 +01:00
$serverId = $this->maniaControl->server->index;
$mysqli = $this->maniaControl->database->mysqli;
$query = "SELECT * FROM `" . self::TABLE_SERVER_SETTINGS . "`
WHERE serverIndex = {$serverId};";
2014-01-12 22:24:30 +01:00
$result = $mysqli->query($query);
2014-02-01 20:03:17 +01:00
if ($mysqli->error) {
2014-01-04 17:18:11 +01:00
trigger_error($mysqli->error);
2014-01-05 12:21:40 +01:00
return false;
2014-01-04 17:18:11 +01:00
}
$serverSettings = $this->maniaControl->client->getServerOptions();
$savedSettings = array();
2014-05-02 17:50:30 +02:00
while ($row = $result->fetch_object()) {
$settingName = lcfirst($row->settingName);
if (!property_exists($serverSettings, $settingName)) {
2014-01-05 20:34:48 +01:00
continue;
}
$settingValue = $row->settingValue;
settype($settingValue, gettype($serverSettings->$settingName));
$savedSettings[$settingName] = $settingValue;
2014-01-04 17:18:11 +01:00
}
$result->free();
if (empty($savedSettings)) {
2014-01-05 20:34:48 +01:00
return true;
2014-01-12 22:24:30 +01:00
}
2014-01-05 20:34:48 +01:00
try {
$serverOptions = ServerOptions::fromArray($savedSettings);
$success = $this->maniaControl->client->setServerOptions($serverOptions);
} catch (ServerOptionsException $exception) {
$this->maniaControl->chat->sendExceptionToAdmins($exception);
}
return $success;
2014-01-02 23:49:21 +01:00
}
/**
* @see \ManiaControl\Configurators\ConfiguratorMenu::getMenu()
*/
public function getMenu($width, $height, Script $script, Player $player) {
2014-05-02 17:50:30 +02:00
$paging = new Paging();
$script->addFeature($paging);
$frame = new Frame();
2014-01-05 20:34:48 +01:00
2014-06-22 19:02:18 +02:00
$serverSettings = $this->maniaControl->client->getServerOptions()
->toArray();
2014-01-05 20:34:48 +01:00
2014-01-02 23:49:21 +01:00
// Config
2014-01-05 20:34:48 +01:00
$pagerSize = 9.;
2014-01-02 23:49:21 +01:00
$settingHeight = 5.;
$labelTextSize = 2;
2014-01-05 20:34:48 +01:00
2014-01-02 23:49:21 +01:00
// Pagers
$pagerPrev = new Quad_Icons64x64_1();
$frame->add($pagerPrev);
$pagerPrev->setPosition($width * 0.39, $height * -0.44, 2);
$pagerPrev->setSize($pagerSize, $pagerSize);
$pagerPrev->setSubStyle(Quad_Icons64x64_1::SUBSTYLE_ArrowPrev);
2014-01-05 20:34:48 +01:00
2014-01-02 23:49:21 +01:00
$pagerNext = new Quad_Icons64x64_1();
$frame->add($pagerNext);
$pagerNext->setPosition($width * 0.45, $height * -0.44, 2);
$pagerNext->setSize($pagerSize, $pagerSize);
$pagerNext->setSubStyle(Quad_Icons64x64_1::SUBSTYLE_ArrowNext);
2014-01-05 20:34:48 +01:00
2014-05-02 17:50:30 +02:00
$paging->addButton($pagerNext);
$paging->addButton($pagerPrev);
2014-01-05 20:34:48 +01:00
2014-06-22 19:02:18 +02:00
$pageCountLabel = new Label_Text();
2014-01-02 23:49:21 +01:00
$frame->add($pageCountLabel);
2014-06-22 19:02:18 +02:00
$pageCountLabel->setHAlign($pageCountLabel::RIGHT);
2014-01-02 23:49:21 +01:00
$pageCountLabel->setPosition($width * 0.35, $height * -0.44, 1);
2014-06-22 19:02:18 +02:00
$pageCountLabel->setStyle($pageCountLabel::STYLE_TextTitle1);
2014-01-02 23:49:21 +01:00
$pageCountLabel->setTextSize(2);
2014-01-05 20:34:48 +01:00
2014-05-02 17:50:30 +02:00
$paging->setLabel($pageCountLabel);
2014-01-05 20:34:48 +01:00
2014-01-02 23:49:21 +01:00
// Setting pages
2014-06-17 23:55:59 +02:00
$posY = 0.;
$index = 0;
2014-05-15 17:45:08 +02:00
$pageFrame = null;
2014-05-02 17:50:30 +02:00
foreach ($serverSettings as $name => $value) {
2014-01-05 12:21:40 +01:00
// Continue on CurrentMaxPlayers...
2014-06-17 23:55:59 +02:00
$pos = strpos($name, 'Current'); // TODO maybe display current somewhere
2014-02-01 20:03:17 +01:00
if ($pos !== false) {
2014-01-02 23:49:21 +01:00
continue;
}
2014-01-05 20:34:48 +01:00
2014-06-17 23:55:59 +02:00
if ($index % 13 === 0) {
2014-01-02 23:49:21 +01:00
$pageFrame = new Frame();
$frame->add($pageFrame);
2014-06-17 23:55:59 +02:00
$posY = $height * 0.41;
2014-05-02 17:50:30 +02:00
$paging->addPage($pageFrame);
2014-01-02 23:49:21 +01:00
}
2014-01-05 20:34:48 +01:00
2014-01-02 23:49:21 +01:00
$settingFrame = new Frame();
$pageFrame->add($settingFrame);
2014-06-17 23:55:59 +02:00
$settingFrame->setY($posY);
2014-01-05 20:34:48 +01:00
2014-01-02 23:49:21 +01:00
$nameLabel = new Label_Text();
$settingFrame->add($nameLabel);
2014-06-22 19:02:18 +02:00
$nameLabel->setHAlign($nameLabel::LEFT);
2014-01-02 23:49:21 +01:00
$nameLabel->setX($width * -0.46);
$nameLabel->setSize($width * 0.4, $settingHeight);
$nameLabel->setStyle($nameLabel::STYLE_TextCardSmall);
$nameLabel->setTextSize($labelTextSize);
$nameLabel->setText($name);
2014-06-22 19:02:18 +02:00
$nameLabel->setTextColor('fff');
2014-01-05 20:34:48 +01:00
if (is_bool($value)) {
// Boolean checkbox
$quad = new Quad();
$quad->setPosition($width * 0.23, 0, -0.01);
2014-01-02 23:49:21 +01:00
$quad->setSize(4, 4);
2014-05-18 19:45:50 +02:00
$checkBox = new CheckBox(self::ACTION_PREFIX_SETTING . $name, $value, $quad);
$settingFrame->add($checkBox);
} else {
// Other
$entry = new Entry();
$settingFrame->add($entry);
$entry->setStyle(Label_Text::STYLE_TextValueSmall);
$entry->setX($width * 0.23);
$entry->setTextSize(1);
$entry->setSize($width * 0.48, $settingHeight * 0.9);
$entry->setName(self::ACTION_PREFIX_SETTING . $name);
$entry->setDefault($value);
if ($name === 'Comment') {
$entry->setAutoNewLine(true);
$entry->setSize($width * 0.48, $settingHeight * 3 + $settingHeight * 0.9);
2014-06-17 23:55:59 +02:00
$settingFrame->setY($posY - $settingHeight * 1.5);
// dummy:
// TODO: "dummy:" what? remove?
2014-06-17 23:55:59 +02:00
$posY -= $settingHeight * 3;
$index += 3;
}
2014-01-02 23:49:21 +01:00
}
2014-01-05 20:34:48 +01:00
2014-06-17 23:55:59 +02:00
$posY -= $settingHeight;
$index++;
2014-01-02 23:49:21 +01:00
}
2014-01-05 20:34:48 +01:00
2014-01-02 23:49:21 +01:00
return $frame;
}
/**
* @see \ManiaControl\Configurators\ConfiguratorMenu::saveConfigData()
*/
public function saveConfigData(array $configData, Player $player) {
2014-04-13 19:05:54 +02:00
if (!$this->maniaControl->authenticationManager->checkPermission($player, self::SETTING_PERMISSION_CHANGE_SERVER_SETTINGS)) {
$this->maniaControl->authenticationManager->sendNotAllowed($player);
return;
}
if (!$configData[3] || strpos($configData[3][0]['Name'], self::ACTION_PREFIX_SETTING) !== 0) {
2014-01-05 20:34:48 +01:00
return;
}
2014-06-22 19:02:18 +02:00
$serverSettings = $this->maniaControl->client->getServerOptions()
->toArray();
2014-01-05 20:34:48 +01:00
2014-01-02 23:49:21 +01:00
$prefixLength = strlen(self::ACTION_PREFIX_SETTING);
2014-01-05 20:34:48 +01:00
2014-05-25 09:58:52 +02:00
$newSettings = new ServerOptions();
2014-05-02 17:50:30 +02:00
foreach ($configData[3] as $setting) {
2014-05-25 09:58:52 +02:00
$settingName = substr($setting['Name'], $prefixLength);
$dynamicSettingName = lcfirst($settingName);
$newSettings->$dynamicSettingName = $setting['Value'];
settype($newSettings->$dynamicSettingName, gettype($serverSettings[$settingName]));
2014-01-02 23:49:21 +01:00
}
2014-01-05 20:34:48 +01:00
2014-05-16 20:42:37 +02:00
$success = $this->applyNewServerSettings($newSettings, $player);
if ($success) {
$this->maniaControl->chat->sendSuccess('Server Settings saved!', $player);
} else {
$this->maniaControl->chat->sendSuccess('Server Settings Saving failed!', $player);
}
2014-01-05 20:34:48 +01:00
2014-05-16 20:42:37 +02:00
// Reopen the Menu
2014-01-05 20:34:48 +01:00
$menuId = $this->maniaControl->configurator->getMenuId($this->getTitle());
2014-01-18 21:05:45 +01:00
$this->maniaControl->configurator->reopenMenu($player, $menuId);
2014-01-02 23:49:21 +01:00
}
/**
2014-01-16 19:40:54 +01:00
* Apply the Array of new Server Settings
2014-01-02 23:49:21 +01:00
*
* @param ServerOptions $newSettings
* @param Player $player
2014-01-04 17:18:11 +01:00
* @return bool
2014-01-02 23:49:21 +01:00
*/
private function applyNewServerSettings(ServerOptions $newSettings, Player $player) {
2014-02-01 20:03:17 +01:00
if (!$newSettings) {
2014-01-05 20:34:48 +01:00
return true;
2014-01-12 22:24:30 +01:00
}
2014-04-22 21:56:18 +02:00
try {
$this->maniaControl->client->setServerOptions($newSettings);
2014-05-08 21:10:56 +02:00
} catch (ServerOptionsException $e) {
$this->maniaControl->chat->sendError($e->getMessage());
2014-04-22 21:56:18 +02:00
return false;
}
2014-01-05 20:34:48 +01:00
2014-01-04 17:18:11 +01:00
// Save Settings into Database
$mysqli = $this->maniaControl->database->mysqli;
2014-01-05 20:34:48 +01:00
$query = "INSERT INTO `" . self::TABLE_SERVER_SETTINGS . "` (
2014-01-05 14:41:19 +01:00
`serverIndex`,
2014-01-04 17:18:11 +01:00
`settingName`,
`settingValue`
) VALUES (
?, ?, ?
) ON DUPLICATE KEY UPDATE
`settingValue` = VALUES(`settingValue`);";
$statement = $mysqli->prepare($query);
2014-02-01 20:03:17 +01:00
if ($mysqli->error) {
2014-01-04 17:18:11 +01:00
trigger_error($mysqli->error);
return false;
2014-01-02 23:49:21 +01:00
}
2014-01-05 20:34:48 +01:00
$settingsArray = $newSettings->toArray();
foreach ($settingsArray as $setting => $value) {
2014-02-01 20:03:17 +01:00
if ($value === null) {
2014-01-20 09:24:17 +01:00
continue;
}
2014-02-01 20:03:17 +01:00
$statement->bind_param('iss', $this->maniaControl->server->index, $setting, $value);
2014-01-04 17:18:11 +01:00
$statement->execute();
2014-02-01 20:03:17 +01:00
if ($statement->error) {
2014-01-04 17:18:11 +01:00
trigger_error($statement->error);
$statement->close();
return false;
}
2014-01-05 20:34:48 +01:00
2014-01-02 23:49:21 +01:00
// Trigger own callback
2014-01-05 20:34:48 +01:00
$this->maniaControl->callbackManager->triggerCallback(self::CB_SERVERSETTING_CHANGED, array(self::CB_SERVERSETTING_CHANGED, $setting, $value));
2014-01-02 23:49:21 +01:00
}
2014-01-05 20:34:48 +01:00
2014-01-04 17:18:11 +01:00
$statement->close();
2014-01-05 20:34:48 +01:00
2014-01-05 19:15:58 +01:00
$this->maniaControl->callbackManager->triggerCallback(self::CB_SERVERSETTINGS_CHANGED, array(self::CB_SERVERSETTINGS_CHANGED));
2014-01-05 20:34:48 +01:00
2014-01-04 17:18:11 +01:00
return true;
2014-01-02 23:49:21 +01:00
}
2014-05-02 17:50:30 +02:00
/**
* @see \ManiaControl\Configurators\ConfiguratorMenu::getTitle()
*/
public function getTitle() {
return 'Server Settings';
}
2014-01-02 23:49:21 +01:00
}