Mamanyonyo/akashi-esquizolandia
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

move config logic to its own class

Browse Source
This commit is contained in:
scatterflower 2020-08-23 14:13:55 -05:00
parent cdfa2d5760
commit 04ae43d960
5 changed files with 132 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
include/akashimain.h
View File

@ -1,15 +1,12 @@
#ifndef AKASHIMAIN_H
#define AKASHIMAIN_H
#define CONFIG_VERSION 1
#include <include/advertiser.h>
#include <include/config_manager.h>
#include <QMainWindow>
#include <QSettings>
#include <QDebug>
#include <QFileInfo>
#include <QDir>
QT_BEGIN_NAMESPACE
namespace Ui { class AkashiMain; }
@ -24,8 +21,8 @@ public:
~AkashiMain();
QSettings config;
ConfigManager config_manager;
bool initConfig();
void generateDefaultConfig(bool backup_old);
void updateConfig(int current_version);
private:

22
include/config_manager.h Normal file
View File

@ -0,0 +1,22 @@
#ifndef CONFIG_MANAGER_H
#define CONFIG_MANAGER_H
#define CONFIG_VERSION 1
#include <QSettings>
#include <QFileInfo>
#include <QDir>
#include <QDebug>
class ConfigManager{
public:
ConfigManager(QSettings*);
bool initConfig();
void generateDefaultConfig(bool backup_old);
void updateConfig(int current_version);
private:
QSettings* config;
};
#endif // CONFIG_MANAGER_H

1
src/advertiser.cpp
View File

@ -23,6 +23,7 @@ void Advertiser::contactMasterServer() {
void Advertiser::readData() {
// The information coming back from the MS isn't very useful
// However, it can be useful to see it when debugging
// TODO: master network debug switch
// qDebug() << socket->readAll();
}

101
src/akashimain.cpp
View File

@ -4,15 +4,19 @@
AkashiMain::AkashiMain(QWidget *parent)
: QMainWindow(parent)
, config("config.ini", QSettings::IniFormat)
, config_manager(&config)
, ui(new Ui::AkashiMain)
{
ui->setupUi(this);
qDebug("Main application started");
if(initConfig()) {
if(config_manager.initConfig()) {
// Config is sound, so proceed with starting the server
// TODO: start the server here
// TODO: send signal server starting
// Validate some of the config before passing it on
// TODO: Move this logic into config_manager.cpp
bool port_conversion_success;
bool ws_port_conversion_success;
bool local_port_conversion_success;
@ -35,101 +39,6 @@ AkashiMain::AkashiMain(QWidget *parent)
}
}
// Returns true if config is up to date and valid, false otherwise
bool AkashiMain::initConfig()
{
config.beginGroup("Info");
QString config_version = config.value("version", "none").toString();
config.endGroup();
if(config_version == "none") {
QFileInfo check_file("config.ini");
// TODO: put proper translatable warnings here
if (!(check_file.exists() && check_file.isFile())){
// TODO: send signal config doesn't exist
generateDefaultConfig(false);
} else {
// TODO: send signal config is invalid
generateDefaultConfig(true);
}
return false;
}
else if(config_version != QString::number(CONFIG_VERSION)) {
bool version_number_is_valid;
int current_version = config_version.toInt(&version_number_is_valid);
if(version_number_is_valid)
updateConfig(current_version);
else
generateDefaultConfig(true); // Version number isn't a number at all
// This means the config is invalid
// TODO: send invalid config signal
return false;
} else {
// Config is valid and up to date, so let's go ahead
return true;
}
}
// Setting backup_old to true will move the existing config.ini to config_old.ini
void AkashiMain::generateDefaultConfig(bool backup_old)
{
qDebug() << "Config is invalid or missing, making a new one...";
QDir dir = QDir::current();
if(backup_old) {
// TODO: failsafe if config_old.ini already exists
dir.rename("config.ini", "config_old.ini");
}
// Group: Info
// This contains basic metadata about the config
config.beginGroup("Info");
config.setValue("version", CONFIG_VERSION);
config.endGroup();
// Group: Options
// This contains general configuration
config.beginGroup("Options");
config.setValue("hostname", "$H");
config.setValue("max_players", "100");
config.setValue("port", "27016");
config.setValue("webao_enable", "true");
config.setValue("webao_port", "27017");
config.setValue("modpass", "password");
config.setValue("advertise", "true");
config.setValue("ms_ip", "master.aceattorneyonline.com");
config.setValue("ms_port", "27016");
config.setValue("server_name", "My First Server");
config.setValue("server_description", "This is my flashy new server");
config.setValue("multiclient_limit", "16");
config.setValue("max_message_size", "256");
config.endGroup();
}
void AkashiMain::updateConfig(int current_version)
{
if(current_version > CONFIG_VERSION) {
// Config version is newer than the latest version, and the config is invalid
// This could also mean the server is out of date, and the user should be shown a relevant message
// Regardless, regen the config anyways
// TODO: send signal config is invalid
generateDefaultConfig(true);
}
else if (current_version < 0){
// Negative version number? Invalid!
generateDefaultConfig(true);
} else {
// TODO: send signal config is out of date, and is being updated
// Update the config as needed using a switch. This is nice because we can fall through as we go up the version ladder.
switch(current_version){
case 0: // Version 0 doesn't actually exist, but we should check for it just in case
case 1:
config.beginGroup("Info");
config.setValue("version", CONFIG_VERSION);
config.endGroup();
break; // This is the newest version, and nothing more needs to be done
}
}
}
AkashiMain::~AkashiMain()
{
delete ui;

102
src/config_manager.cpp Normal file
View File

@ -0,0 +1,102 @@
#include <include/config_manager.h>
ConfigManager::ConfigManager(QSettings* p_config)
{
config = p_config;
}
bool ConfigManager::initConfig()
{
config->beginGroup("Info");
QString config_version = config->value("version", "none").toString();
config->endGroup();
if(config_version == "none") {
QFileInfo check_file("config.ini");
// TODO: put proper translatable warnings here
if (!(check_file.exists() && check_file.isFile())){
// TODO: send signal config doesn't exist
generateDefaultConfig(false);
} else {
// TODO: send signal config is invalid
generateDefaultConfig(true);
}
return false;
}
else if(config_version != QString::number(CONFIG_VERSION)) {
bool version_number_is_valid;
int current_version = config_version.toInt(&version_number_is_valid);
if(version_number_is_valid)
updateConfig(current_version);
else
generateDefaultConfig(true); // Version number isn't a number at all
// This means the config is invalid
// TODO: send invalid config signal
return false;
} else {
// Config is valid and up to date, so let's go ahead
return true;
}
}
// Setting backup_old to true will move the existing config.ini to config_old.ini
void ConfigManager::generateDefaultConfig(bool backup_old)
{
qDebug() << "Config is invalid or missing, making a new one...";
QDir dir = QDir::current();
if(backup_old) {
// TODO: failsafe if config_old.ini already exists
dir.rename("config.ini", "config_old.ini");
}
// Group: Info
// This contains basic metadata about the config
config->beginGroup("Info");
config->setValue("version", CONFIG_VERSION);
config->endGroup();
// Group: Options
// This contains general configuration
config->beginGroup("Options");
config->setValue("language", "en");
config->setValue("hostname", "$H");
config->setValue("max_players", "100");
config->setValue("port", "27016");
config->setValue("webao_enable", "true");
config->setValue("webao_port", "27017");
config->setValue("modpass", "password");
config->setValue("advertise", "true");
config->setValue("ms_ip", "master.aceattorneyonline.com");
config->setValue("ms_port", "27016");
config->setValue("server_name", "My First Server");
config->setValue("server_description", "This is my flashy new server");
config->setValue("multiclient_limit", "16");
config->setValue("max_message_size", "256");
config->endGroup();
}
// Ensure version continuity with config versions
void ConfigManager::updateConfig(int current_version)
{
if(current_version > CONFIG_VERSION) {
// Config version is newer than the latest version, and the config is invalid
// This could also mean the server is out of date, and the user should be shown a relevant message
// Regardless, regen the config anyways
// TODO: send signal config is invalid
generateDefaultConfig(true);
}
else if (current_version < 0){
// Negative version number? Invalid!
generateDefaultConfig(true);
} else {
// TODO: send signal config is out of date, and is being updated
// Update the config as needed using a switch. This is nice because we can fall through as we go up the version ladder.
switch(current_version){
case 0: // Version 0 doesn't actually exist, but we should check for it just in case
case 1:
config->beginGroup("Info");
config->setValue("version", CONFIG_VERSION);
config->endGroup();
break; // This is the newest version, and nothing more needs to be done
}
}
}