aboutsummaryrefslogtreecommitdiffstats
path: root/src/core
diff options
context:
space:
mode:
Diffstat (limited to 'src/core')
-rw-r--r--src/core/CMakeLists.txt2
-rw-r--r--src/core/function/GlobalSettingStation.cpp402
-rw-r--r--src/core/function/GlobalSettingStation.h143
3 files changed, 345 insertions, 202 deletions
diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt
index 29b3e468..53129c84 100644
--- a/src/core/CMakeLists.txt
+++ b/src/core/CMakeLists.txt
@@ -78,7 +78,7 @@ if (MINGW)
endif ()
# spdlog
-target_link_libraries(gpgfrontend_core PUBLIC spdlog)
+target_link_libraries(gpgfrontend_core PRIVATE spdlog)
# link libarchive
target_link_libraries(gpgfrontend_core PRIVATE archive)
diff --git a/src/core/function/GlobalSettingStation.cpp b/src/core/function/GlobalSettingStation.cpp
index b5b653c6..166f57d2 100644
--- a/src/core/function/GlobalSettingStation.cpp
+++ b/src/core/function/GlobalSettingStation.cpp
@@ -28,136 +28,350 @@
#include "GlobalSettingStation.h"
+#include <memory>
+
#include "core/function/FileOperator.h"
-void GpgFrontend::GlobalSettingStation::SyncSettings() noexcept {
- using namespace libconfig;
- try {
- ui_cfg_.writeFile(ui_config_path_.u8string().c_str());
- SPDLOG_DEBUG("updated ui configuration successfully written to {}",
- ui_config_path_.u8string());
+namespace GpgFrontend {
+
+class GlobalSettingStation::Impl {
+ public:
+ /**
+ * @brief Construct a new Global Setting Station object
+ *
+ */
+ explicit Impl(int channel) noexcept {
+ using namespace std::filesystem;
+ using namespace libconfig;
+
+ SPDLOG_INFO("app path: {}", app_path_.u8string());
+ SPDLOG_INFO("app configure path: {}", app_configure_path_.u8string());
+ SPDLOG_INFO("app data path: {}", app_data_path_.u8string());
+ SPDLOG_INFO("app log path: {}", app_log_path_.u8string());
+ SPDLOG_INFO("app locale path: {}", app_locale_path_.u8string());
+ SPDLOG_INFO("app conf path: {}", main_config_path_.u8string());
+
+ SPDLOG_INFO("app log files total size: {}", GetLogFilesSize());
+ SPDLOG_INFO("app data objects files total size: {}",
+ GetDataObjectsFilesSize());
+
+ if (!is_directory(app_configure_path_))
+ create_directory(app_configure_path_);
+ if (!is_directory(app_data_path_)) create_directory(app_data_path_);
+ if (!is_directory(app_log_path_)) create_directory(app_log_path_);
+ if (!is_directory(config_dir_path_)) create_directory(config_dir_path_);
- } catch (const FileIOException &fioex) {
- SPDLOG_ERROR("i/o error while writing ui configuration file: {}",
- ui_config_path_.u8string());
+ if (!exists(main_config_path_)) {
+ try {
+ this->ui_cfg_.writeFile(main_config_path_.u8string().c_str());
+ SPDLOG_DEBUG("user interface configuration successfully written to {}",
+ main_config_path_.u8string());
+
+ } catch (const FileIOException &fioex) {
+ SPDLOG_DEBUG(
+ "i/o error while writing UserInterface configuration file {}",
+ main_config_path_.u8string());
+ }
+ } else {
+ try {
+ this->ui_cfg_.readFile(main_config_path_.u8string().c_str());
+ SPDLOG_DEBUG("user interface configuration successfully read from {}",
+ main_config_path_.u8string());
+ } catch (const FileIOException &fioex) {
+ SPDLOG_ERROR("i/o error while reading UserInterface configure file");
+ } catch (const ParseException &pex) {
+ SPDLOG_ERROR("parse error at {} : {} - {}", pex.getFile(),
+ pex.getLine(), pex.getError());
+ }
+ }
}
-}
-GpgFrontend::GlobalSettingStation::GlobalSettingStation(int channel) noexcept
- : SingletonFunctionObject<GlobalSettingStation>(channel) {
- using namespace std::filesystem;
- using namespace libconfig;
+ libconfig::Setting &GetMainSettings() noexcept { return ui_cfg_.getRoot(); }
- SPDLOG_INFO("app path: {}", app_path_.u8string());
- SPDLOG_INFO("app configure path: {}", app_configure_path_.u8string());
- SPDLOG_INFO("app data path: {}", app_data_path_.u8string());
- SPDLOG_INFO("app log path: {}", app_log_path_.u8string());
- SPDLOG_INFO("app locale path: {}", app_locale_path_.u8string());
- SPDLOG_INFO("app conf path: {}", ui_config_path_.u8string());
+ std::string GetLogFilesSize() const {
+ return get_human_readable_size(
+ get_files_size_at_path(app_log_path_, "*.log"));
+ }
- SPDLOG_INFO("app log files total size: {}", GetLogFilesSize());
- SPDLOG_INFO("app data objects files total size: {}",
- GetDataObjectsFilesSize());
+ std::string GetDataObjectsFilesSize() const {
+ return get_human_readable_size(
+ get_files_size_at_path(app_data_objs_path_, "*"));
+ }
+
+ void ClearAllLogFiles() const { delete_all_files(app_log_path_, "*.log"); }
- if (!is_directory(app_configure_path_)) create_directory(app_configure_path_);
- if (!is_directory(app_data_path_)) create_directory(app_data_path_);
- if (!is_directory(app_log_path_)) create_directory(app_log_path_);
- if (!is_directory(ui_config_dir_path_)) create_directory(ui_config_dir_path_);
+ void ClearAllDataObjects() const {
+ delete_all_files(app_data_objs_path_, "*");
+ }
- if (!exists(ui_config_path_)) {
+ /**
+ * @brief
+ *
+ * @return libconfig::Setting&
+ */
+ template <typename T>
+ T LookupSettings(std::string path, T default_value) noexcept {
+ T value = default_value;
try {
- this->ui_cfg_.writeFile(ui_config_path_.u8string().c_str());
- SPDLOG_DEBUG("user interface configuration successfully written to {}",
- ui_config_path_.u8string());
+ value = static_cast<T>(GetMainSettings().lookup(path));
+ } catch (...) {
+ SPDLOG_WARN("setting not found: {}", path);
+ }
+ return value;
+ }
- } catch (const FileIOException &fioex) {
- SPDLOG_DEBUG(
- "i/o error while writing UserInterface configuration file {}",
- ui_config_path_.u8string());
+ /**
+ * @brief Get the App Dir object
+ *
+ * @return std::filesystem::path
+ */
+ [[nodiscard]] std::filesystem::path GetAppDir() const { return app_path_; }
+
+ [[nodiscard]] std::filesystem::path GetAppDataPath() const {
+ return app_data_path_;
+ }
+
+ /**
+ * @brief Get the Log Dir object
+ *
+ * @return std::filesystem::path
+ */
+ [[nodiscard]] std::filesystem::path GetLogDir() const {
+ return app_log_path_;
+ }
+
+ /**
+ * @brief Get the Standalone Database Dir object
+ *
+ * @return std::filesystem::path
+ */
+ [[nodiscard]] std::filesystem::path GetStandaloneDatabaseDir() const {
+ auto db_path = app_configure_path_ / "db";
+ if (!std::filesystem::exists(db_path)) {
+ std::filesystem::create_directory(db_path);
}
- } else {
+ return db_path;
+ }
+
+ [[nodiscard]] std::filesystem::path GetAppConfigPath() const {
+ return app_configure_path_;
+ }
+
+ /**
+ * @brief Get the Standalone Gpg Bin Dir object
+ *
+ * @return std::filesystem::path
+ */
+ [[nodiscard]] std::filesystem::path GetStandaloneGpgBinDir() const {
+ return app_resource_path_ / "gpg1.4" / "gpg";
+ }
+
+ /**
+ * @brief Get the Locale Dir object
+ *
+ * @return std::filesystem::path
+ */
+ [[nodiscard]] std::filesystem::path GetLocaleDir() const {
+ return app_locale_path_;
+ }
+
+ /**
+ * @brief Get the Resource Dir object
+ *
+ * @return std::filesystem::path
+ */
+ [[nodiscard]] std::filesystem::path GetResourceDir() const {
+ return app_resource_path_;
+ }
+
+ /**
+ * @brief Get the Certs Dir object
+ *
+ * @return std::filesystem::path
+ */
+ [[nodiscard]] std::filesystem::path GetCertsDir() const {
+ return app_resource_path_ / "certs";
+ }
+
+ /**
+ * @brief sync the settings to the file
+ *
+ */
+ void SyncSettings() noexcept {
+ using namespace libconfig;
try {
- this->ui_cfg_.readFile(ui_config_path_.u8string().c_str());
- SPDLOG_DEBUG("user interface configuration successfully read from {}",
- ui_config_path_.u8string());
+ ui_cfg_.writeFile(main_config_path_.u8string().c_str());
+ SPDLOG_DEBUG("updated ui configuration successfully written to {}",
+ main_config_path_.u8string());
+
} catch (const FileIOException &fioex) {
- SPDLOG_ERROR("i/o error while reading UserInterface configure file");
- } catch (const ParseException &pex) {
- SPDLOG_ERROR("parse error at {} : {} - {}", pex.getFile(), pex.getLine(),
- pex.getError());
+ SPDLOG_ERROR("i/o error while writing ui configuration file: {}",
+ main_config_path_.u8string());
}
}
-}
-libconfig::Setting &
-GpgFrontend::GlobalSettingStation::GetUISettings() noexcept {
- return ui_cfg_.getRoot();
-}
+ private:
+ std::filesystem::path app_path_ = QCoreApplication::applicationDirPath()
+ .toStdString(); ///< Program Location
+ std::filesystem::path app_data_path_ =
+ QStandardPaths::writableLocation(QStandardPaths::AppLocalDataLocation)
+ .toStdString(); ///< Program Data Location
+ std::filesystem::path app_log_path_ =
+ app_data_path_ / "logs"; ///< Program Data Location
+ std::filesystem::path app_data_objs_path_ =
+ app_data_path_ / "data_objs"; ///< Object storage path
+
+#ifdef LINUX_INSTALL_BUILD
+ std::filesystem::path app_resource_path_ =
+ std::filesystem::path(APP_LOCALSTATE_PATH) /
+ "gpgfrontend"; ///< Program Data Location
+#else
+ std::filesystem::path app_resource_path_ =
+ RESOURCE_DIR_BOOST_PATH(app_path_); ///< Program Data Location
+#endif
+
+#ifdef LINUX_INSTALL_BUILD
+ std::filesystem::path app_locale_path_ =
+ std::string(APP_LOCALE_PATH); ///< Program Data Location
+#else
+ std::filesystem::path app_locale_path_ =
+ app_resource_path_ / "locales"; ///< Program Data Location
+#endif
-void GpgFrontend::GlobalSettingStation::init_app_secure_key() {}
+ std::filesystem::path app_configure_path_ =
+ QStandardPaths::writableLocation(QStandardPaths::AppConfigLocation)
+ .toStdString(); ///< Program Configure Location
+ std::filesystem::path config_dir_path_ =
+ app_configure_path_ / "conf"; ///< Configure File Directory Location
+ std::filesystem::path main_config_path_ =
+ config_dir_path_ / "main.cfg"; ///< Main Configure File Location
+ std::filesystem::path module_config_path_ =
+ config_dir_path_ / "module.cfg"; ///< Main Configure File Location
-int64_t GpgFrontend::GlobalSettingStation::get_files_size_at_path(
- std::filesystem::path path, std::string filename_pattern) const {
- auto dir = QDir(QString::fromStdString(path.u8string()));
- QFileInfoList fileList = dir.entryInfoList(
- QStringList() << QString::fromStdString(filename_pattern), QDir::Files);
- qint64 totalSize = 0;
+ libconfig::Config ui_cfg_; ///< UI Configure File
- for (const QFileInfo &fileInfo : fileList) {
- totalSize += fileInfo.size();
+ /**
+ * @brief
+ *
+ */
+ void init_app_secure_key() {}
+
+ /**
+ * @brief
+ *
+ */
+ int64_t get_files_size_at_path(std::filesystem::path path,
+ std::string filename_pattern) const {
+ auto dir = QDir(QString::fromStdString(path.u8string()));
+ QFileInfoList fileList = dir.entryInfoList(
+ QStringList() << QString::fromStdString(filename_pattern), QDir::Files);
+ qint64 totalSize = 0;
+
+ for (const QFileInfo &fileInfo : fileList) {
+ totalSize += fileInfo.size();
+ }
+ return totalSize;
}
- return totalSize;
-}
-std::string GpgFrontend::GlobalSettingStation::get_human_readable_size(
- int64_t size) const {
- double num = size;
- QStringList list;
- list << "KB"
- << "MB"
- << "GB"
- << "TB";
+ /**
+ * @brief
+ *
+ */
+ std::string get_human_readable_size(int64_t size) const {
+ double num = size;
+ QStringList list;
+ list << "KB"
+ << "MB"
+ << "GB"
+ << "TB";
- QStringListIterator i(list);
- QString unit("bytes");
+ QStringListIterator i(list);
+ QString unit("bytes");
- while (num >= 1024.0 && i.hasNext()) {
- unit = i.next();
- num /= 1024.0;
+ while (num >= 1024.0 && i.hasNext()) {
+ unit = i.next();
+ num /= 1024.0;
+ }
+ return (QString().setNum(num, 'f', 2) + " " + unit).toStdString();
+ }
+
+ /**
+ * @brief
+ *
+ */
+ void delete_all_files(std::filesystem::path path,
+ std::string filename_pattern) const {
+ auto dir = QDir(QString::fromStdString(path.u8string()));
+
+ QStringList logFiles = dir.entryList(
+ QStringList() << QString::fromStdString(filename_pattern), QDir::Files);
+
+ for (const auto &file : logFiles) {
+ QFile::remove(dir.absoluteFilePath(file));
+ }
}
- return (QString().setNum(num, 'f', 2) + " " + unit).toStdString();
+};
+
+GlobalSettingStation::GlobalSettingStation(int channel) noexcept
+ : SingletonFunctionObject<GlobalSettingStation>(channel),
+ p_(std::make_unique<Impl>(channel)) {}
+
+GlobalSettingStation::~GlobalSettingStation() noexcept = default;
+
+void GlobalSettingStation::SyncSettings() noexcept { p_->SyncSettings(); }
+
+libconfig::Setting &GlobalSettingStation::GetMainSettings() noexcept {
+ return p_->GetMainSettings();
+}
+
+std::filesystem::path GlobalSettingStation::GetAppDir() const {
+ return p_->GetAppDir();
}
-std::string GpgFrontend::GlobalSettingStation::GetLogFilesSize() const {
- return get_human_readable_size(
- get_files_size_at_path(app_log_path_, "*.log"));
+std::filesystem::path GlobalSettingStation::GetAppDataPath() const {
+ return p_->GetAppDataPath();
}
-std::string GpgFrontend::GlobalSettingStation::GetDataObjectsFilesSize() const {
- return get_human_readable_size(
- get_files_size_at_path(app_data_objs_path_, "*"));
+[[nodiscard]] std::filesystem::path GlobalSettingStation::GetLogDir() const {
+ return p_->GetLogDir();
}
-void GpgFrontend::GlobalSettingStation::ClearAllLogFiles() const {
- delete_all_files(app_log_path_, "*.log");
+std::filesystem::path GlobalSettingStation::GetStandaloneDatabaseDir() const {
+ return p_->GetStandaloneDatabaseDir();
}
-void GpgFrontend::GlobalSettingStation::ClearAllDataObjects() const {
- delete_all_files(app_data_objs_path_, "*");
+std::filesystem::path GlobalSettingStation::GetAppConfigPath() const {
+ return p_->GetAppConfigPath();
}
-void GpgFrontend::GlobalSettingStation::delete_all_files(
- std::filesystem::path path, std::string filename_pattern) const {
- auto dir = QDir(QString::fromStdString(path.u8string()));
+std::filesystem::path GlobalSettingStation::GetStandaloneGpgBinDir() const {
+ return p_->GetStandaloneGpgBinDir();
+}
- // 使用name filters来只选取以.log结尾的文件
- QStringList logFiles = dir.entryList(
- QStringList() << QString::fromStdString(filename_pattern), QDir::Files);
+std::filesystem::path GlobalSettingStation::GetLocaleDir() const {
+ return p_->GetLocaleDir();
+}
- // 遍历并删除所有符合条件的文件
- for (const auto &file : logFiles) {
- QFile::remove(dir.absoluteFilePath(file));
- }
+std::filesystem::path GlobalSettingStation::GetResourceDir() const {
+ return p_->GetResourceDir();
+}
+
+std::filesystem::path GlobalSettingStation::GetCertsDir() const {
+ return p_->GetCertsDir();
+}
+
+std::string GlobalSettingStation::GetLogFilesSize() const {
+ return p_->GetLogFilesSize();
+}
+
+std::string GlobalSettingStation::GetDataObjectsFilesSize() const {
+ return p_->GetDataObjectsFilesSize();
+}
+
+void GlobalSettingStation::ClearAllLogFiles() const { p_->ClearAllLogFiles(); }
+
+void GlobalSettingStation::ClearAllDataObjects() const {
+ p_->ClearAllDataObjects();
}
-GpgFrontend::GlobalSettingStation::~GlobalSettingStation() noexcept = default;
+} // namespace GpgFrontend \ No newline at end of file
diff --git a/src/core/function/GlobalSettingStation.h b/src/core/function/GlobalSettingStation.h
index 75610c92..8b76510b 100644
--- a/src/core/function/GlobalSettingStation.h
+++ b/src/core/function/GlobalSettingStation.h
@@ -30,6 +30,7 @@
#define GPGFRONTEND_GLOBALSETTINGSTATION_H
#include <filesystem>
+#include <memory>
#include "GpgFrontendBuildInstallInfo.h"
#include "core/GpgFrontendCore.h"
@@ -38,8 +39,11 @@
namespace GpgFrontend {
/**
- * @brief
+ * @class GlobalSettingStation
+ * @brief Singleton class for managing global settings in the application.
*
+ * This class handles reading and writing of global settings, as well as
+ * managing application directories and resource paths.
*/
class GPGFRONTEND_CORE_EXPORT GlobalSettingStation
: public SingletonFunctionObject<GlobalSettingStation> {
@@ -62,96 +66,64 @@ class GPGFRONTEND_CORE_EXPORT GlobalSettingStation
*
* @return libconfig::Setting&
*/
- libconfig::Setting &GetUISettings() noexcept;
-
- /**
- * @brief
- *
- * @return libconfig::Setting&
- */
- template <typename T>
- T LookupSettings(std::string path, T default_value) noexcept {
- T value = default_value;
- try {
- value = static_cast<T>(GetUISettings().lookup(path));
- } catch (...) {
- SPDLOG_WARN("setting not found: {}", path);
- }
- return value;
- }
+ libconfig::Setting &GetMainSettings() noexcept;
/**
* @brief Get the App Dir object
*
* @return std::filesystem::path
*/
- [[nodiscard]] std::filesystem::path GetAppDir() const { return app_path_; }
+ [[nodiscard]] std::filesystem::path GetAppDir() const;
- [[nodiscard]] std::filesystem::path GetAppDataPath() const {
- return app_data_path_;
- }
+ /**
+ * @brief Gets the application data directory.
+ * @return Path to the application data directory.
+ */
+ [[nodiscard]] std::filesystem::path GetAppDataPath() const;
/**
* @brief Get the Log Dir object
*
* @return std::filesystem::path
*/
- [[nodiscard]] std::filesystem::path GetLogDir() const {
- return app_log_path_;
- }
+ [[nodiscard]] std::filesystem::path GetLogDir() const;
/**
* @brief Get the Standalone Database Dir object
*
* @return std::filesystem::path
*/
- [[nodiscard]] std::filesystem::path GetStandaloneDatabaseDir() const {
- auto db_path = app_configure_path_ / "db";
- if (!std::filesystem::exists(db_path)) {
- std::filesystem::create_directory(db_path);
- }
- return db_path;
- }
+ [[nodiscard]] std::filesystem::path GetStandaloneDatabaseDir() const;
- [[nodiscard]] std::filesystem::path GetAppConfigPath() const {
- return app_configure_path_;
- }
+ [[nodiscard]] std::filesystem::path GetAppConfigPath() const;
/**
* @brief Get the Standalone Gpg Bin Dir object
*
* @return std::filesystem::path
*/
- [[nodiscard]] std::filesystem::path GetStandaloneGpgBinDir() const {
- return app_resource_path_ / "gpg1.4" / "gpg";
- }
+ [[nodiscard]] std::filesystem::path GetStandaloneGpgBinDir() const;
/**
* @brief Get the Locale Dir object
*
* @return std::filesystem::path
*/
- [[nodiscard]] std::filesystem::path GetLocaleDir() const {
- return app_locale_path_;
- }
+ [[nodiscard]] std::filesystem::path GetLocaleDir() const;
/**
* @brief Get the Resource Dir object
*
* @return std::filesystem::path
*/
- [[nodiscard]] std::filesystem::path GetResourceDir() const {
- return app_resource_path_;
- }
+ [[nodiscard]] std::filesystem::path GetResourceDir() const;
/**
* @brief Get the Certs Dir object
*
* @return std::filesystem::path
*/
- [[nodiscard]] std::filesystem::path GetCertsDir() const {
- return app_resource_path_ / "certs";
- }
+ [[nodiscard]] std::filesystem::path GetCertsDir() const;
[[nodiscard]] std::string GetLogFilesSize() const;
@@ -167,69 +139,26 @@ class GPGFRONTEND_CORE_EXPORT GlobalSettingStation
*/
void SyncSettings() noexcept;
- private:
- std::filesystem::path app_path_ = QCoreApplication::applicationDirPath()
- .toStdString(); ///< Program Location
- std::filesystem::path app_data_path_ =
- QStandardPaths::writableLocation(QStandardPaths::AppLocalDataLocation)
- .toStdString(); ///< Program Data Location
- std::filesystem::path app_log_path_ =
- app_data_path_ / "logs"; ///< Program Data Location
- std::filesystem::path app_data_objs_path_ =
- app_data_path_ / "data_objs"; ///< Object storage path
-
-#ifdef LINUX_INSTALL_BUILD
- std::filesystem::path app_resource_path_ =
- std::filesystem::path(APP_LOCALSTATE_PATH) /
- "gpgfrontend"; ///< Program Data Location
-#else
- std::filesystem::path app_resource_path_ =
- RESOURCE_DIR_BOOST_PATH(app_path_); ///< Program Data Location
-#endif
-
-#ifdef LINUX_INSTALL_BUILD
- std::filesystem::path app_locale_path_ =
- std::string(APP_LOCALE_PATH); ///< Program Data Location
-#else
- std::filesystem::path app_locale_path_ =
- app_resource_path_ / "locales"; ///< Program Data Location
-#endif
-
- std::filesystem::path app_configure_path_ =
- QStandardPaths::writableLocation(QStandardPaths::AppConfigLocation)
- .toStdString(); ///< Program Configure Location
- std::filesystem::path ui_config_dir_path_ =
- app_configure_path_ / "conf"; ///< Configure File Directory Location
- std::filesystem::path ui_config_path_ =
- ui_config_dir_path_ / "main.cfg"; ///< Main Configure File Location
-
- libconfig::Config ui_cfg_; ///< UI Configure File
-
- /**
- * @brief
- *
- */
- void init_app_secure_key();
-
- /**
- * @brief
- *
- */
- int64_t get_files_size_at_path(std::filesystem::path path,
- std::string filename_pattern) const;
-
/**
- * @brief
- *
+ * @brief Looks up a setting by path.
+ * @param path The path to the setting.
+ * @param default_value The default value to return if setting is not found.
+ * @return The setting value.
*/
- std::string get_human_readable_size(int64_t size) const;
+ template <typename T>
+ T LookupSettings(std::string path, T default_value) noexcept {
+ T value = default_value;
+ try {
+ value = static_cast<T>(GetMainSettings().lookup(path));
+ } catch (...) {
+ SPDLOG_WARN("setting not found: {}", path);
+ }
+ return value;
+ }
- /**
- * @brief
- *
- */
- void delete_all_files(std::filesystem::path path,
- std::string filename_pattern) const;
+ private:
+ class Impl;
+ std::unique_ptr<Impl> p_;
};
} // namespace GpgFrontend