/** * Copyright (C) 2021-2024 Saturneric * * This file is part of GpgFrontend. * * GpgFrontend is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * GpgFrontend is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GpgFrontend. If not, see . * * The initial version of the source code is inherited from * the gpg4usb project, which is under GPL-3.0-or-later. * * All the source code of GpgFrontend was modified and released by * Saturneric starting on May 12, 2021. * * SPDX-License-Identifier: GPL-3.0-or-later * */ #include "Module.h" #include "core/module/GlobalModuleContext.h" #include "core/utils/CommonUtils.h" #include "core/utils/IOUtils.h" #include "sdk/GFSDKModule.h" #include "utils/BuildInfoUtils.h" namespace GpgFrontend::Module { class Module::Impl { public: friend class GlobalModuleContext; using ExecCallback = std::function; Impl(ModuleRawPtr m_ptr, ModuleIdentifier id, ModuleVersion version, ModuleMetaData meta_data) : m_ptr_(m_ptr), identifier_(std::move(id)), version_(std::move(version)), meta_data_(std::move(meta_data)), good_(true) {} Impl(ModuleRawPtr m_ptr, QLibrary& module_library) : m_ptr_(m_ptr), module_hash_(CalculateBinaryChacksum(module_library.fileName())), module_library_path_(module_library.fileName()), good_(false) { for (auto& required_symbol : module_required_symbols_) { *required_symbol.pointer = reinterpret_cast(module_library.resolve(required_symbol.name)); if (*required_symbol.pointer == nullptr) { LOG_W() << "illegal module: " << module_library.fileName() << ", reason cannot load symbol: " << required_symbol.name << ", abort..."; return; } } identifier_ = GFUnStrDup(get_id_api_()); version_ = GFUnStrDup(get_version_api_()); gf_sdk_ver_ = GFUnStrDup(get_sdk_ver_api_()); qt_env_ver_ = GFUnStrDup(get_qt_ver_api_()); if (!module_identifier_regex_exp_.match(identifier_).hasMatch()) { LOG_W() << "illegal module: " << identifier_ << ", reason invalid module id, abort..."; return; } if (!module_version_regex_exp_.match(version_).hasMatch()) { LOG_W() << "illegal module: " << identifier_ << ", reason invalid version: " << version_ << ", abort..."; return; } if (!module_version_regex_exp_.match(gf_sdk_ver_).hasMatch()) { LOG_W() << "illegal module: " << identifier_ << ", reason invalid sdk version: " << gf_sdk_ver_ << ", abort..."; return; } if (GFCompareSoftwareVersion(gf_sdk_ver_, GetProjectVersion()) > 0) { LOG_W() << "uncompatible module: " << identifier_ << ", reason sdk version: " << gf_sdk_ver_ << "current sdk version: " << GetProjectVersion() << ", abort..."; return; } auto qt_env_ver_regex_match = module_version_regex_exp_.match(qt_env_ver_); if (!qt_env_ver_regex_match.hasMatch()) { LOG_W() << "illegal module: " << identifier_ << ", reason invalid qt env version: " << qt_env_ver_ << ", abort..."; return; } auto qt_env_ver_major = qt_env_ver_regex_match.captured(1); auto qt_env_ver_minor = qt_env_ver_regex_match.captured(2); if (qt_env_ver_major != QString::number(QT_VERSION_MAJOR) + "." || qt_env_ver_minor != QString::number(QT_VERSION_MINOR) + ".") { LOG_W() << "module: " << identifier_ << "is not compatible, reason module qt version: " << qt_env_ver_ << ", but application qt version: " << QString::fromUtf8(QT_VERSION_STR) << ", abort..."; return; } ::GFModuleMetaData* p_meta_data = get_metadata_api_(); while (p_meta_data != nullptr) { ::GFModuleMetaData* l_meta_data; meta_data_[QString::fromUtf8(p_meta_data->key)] = QString::fromUtf8(p_meta_data->value); l_meta_data = p_meta_data; p_meta_data = p_meta_data->next; SecureFree(l_meta_data); } good_ = true; } [[nodiscard]] auto IsGood() const -> bool { return good_; } auto Register() -> int { if (good_ && register_api_ != nullptr) return register_api_(); return -1; } auto Active() -> int { if (good_ && activate_api_ != nullptr) return activate_api_(); return -1; } auto Exec(const EventReference& event) -> int { if (good_ && execute_api_ != nullptr) { return execute_api_(event->ToModuleEvent()); } return -1; } auto Deactivate() -> int { if (good_ && deactivate_api_ != nullptr) return deactivate_api_(); return -1; } auto UnRegister() -> int { if (good_ && unregister_api_ != nullptr) return unregister_api_(); return -1; } auto GetChannel() -> int { return get_gpc()->GetChannel(m_ptr_); } auto GetDefaultChannel() -> int { return GlobalModuleContext::GetDefaultChannel(m_ptr_); } auto GetTaskRunner() -> std::optional { return get_gpc()->GetTaskRunner(m_ptr_); } auto ListenEvent(EventIdentifier event) -> bool { return get_gpc()->ListenEvent(GetModuleIdentifier(), std::move(event)); } [[nodiscard]] auto GetModuleIdentifier() const -> ModuleIdentifier { return identifier_; } [[nodiscard]] auto GetModuleVersion() const -> ModuleVersion { return version_; } [[nodiscard]] auto GetModuleSDKVersion() const -> QString { return gf_sdk_ver_; } [[nodiscard]] auto GetModuleQtEnvVersion() const -> QString { return qt_env_ver_; } [[nodiscard]] auto GetModuleMetaData() const -> ModuleMetaData { return meta_data_; } [[nodiscard]] auto GetModulePath() const -> QString { return module_library_path_; } [[nodiscard]] auto GetModuleHash() const -> QString { return module_hash_; } void SetGPC(GlobalModuleContext* gpc) { gpc_ = gpc; } private: GlobalModuleContext* gpc_{}; Module* m_ptr_; ModuleIdentifier identifier_; ModuleVersion version_; ModuleMetaData meta_data_; QString module_hash_; QString module_library_path_; QString gf_sdk_ver_; QString qt_env_ver_; QRegularExpression module_identifier_regex_exp_ = QRegularExpression( R"(^([A-Za-z]{1}[A-Za-z\d_]*\.)+[A-Za-z][A-Za-z\d_]*$)"); QRegularExpression module_version_regex_exp_ = QRegularExpression(R"(^(\d+\.)?(\d+\.)?(\*|\d+)$)"); bool good_; GFModuleAPIGetModuleGFSDKVersion get_sdk_ver_api_; GFModuleAPIGetModuleQtEnvVersion get_qt_ver_api_; GFModuleAPIGetModuleID get_id_api_; GFModuleAPIGetModuleVersion get_version_api_; GFModuleAPIGetModuleMetaData get_metadata_api_; GFModuleAPIRegisterModule register_api_; GFModuleAPIActivateModule activate_api_; GFModuleAPIExecuteModule execute_api_; GFModuleAPIDeactivateModule deactivate_api_; GFModuleAPIUnregisterModule unregister_api_; struct Symbol { const char* name; void** pointer; }; QList module_required_symbols_ = { {"GFGetModuleGFSDKVersion", reinterpret_cast(&get_sdk_ver_api_)}, {"GFGetModuleQtEnvVersion", reinterpret_cast(&get_qt_ver_api_)}, {"GFGetModuleID", reinterpret_cast(&get_id_api_)}, {"GFGetModuleVersion", reinterpret_cast(&get_version_api_)}, {"GFGetModuleMetaData", reinterpret_cast(&get_metadata_api_)}, {"GFRegisterModule", reinterpret_cast(®ister_api_)}, {"GFActiveModule", reinterpret_cast(&activate_api_)}, {"GFExecuteModule", reinterpret_cast(&execute_api_)}, {"GFDeactivateModule", reinterpret_cast(&deactivate_api_)}, {"GFUnregisterModule", reinterpret_cast(&unregister_api_)}, }; auto get_gpc() -> GlobalModuleContext* { if (gpc_ == nullptr) { throw std::runtime_error("module is not registered by module manager"); } return gpc_; } }; Module::Module(ModuleIdentifier id, ModuleVersion version, const ModuleMetaData& meta_data) : p_(SecureCreateUniqueObject(this, id, version, meta_data)) {} Module::Module(QLibrary& module_library) : p_(SecureCreateUniqueObject(this, module_library)) {} Module::~Module() = default; auto Module::IsGood() -> bool { return p_->IsGood(); } auto Module::Register() -> int { return p_->Register(); } auto Module::Active() -> int { return p_->Active(); } auto Module::Exec(EventReference event) -> int { LOG_D() << "module" << GetModuleIdentifier() << "executing..."; return p_->Exec(event); } auto Module::Deactivate() -> int { return p_->Deactivate(); } auto Module::UnRegister() -> int { return p_->UnRegister(); } auto Module::getChannel() -> int { return p_->GetChannel(); } auto Module::getDefaultChannel() -> int { return p_->GetDefaultChannel(); } auto Module::getTaskRunner() -> TaskRunnerPtr { return p_->GetTaskRunner().value_or(nullptr); } auto Module::listenEvent(EventIdentifier event) -> bool { return p_->ListenEvent(std::move(event)); } auto Module::GetModuleIdentifier() const -> ModuleIdentifier { return p_->GetModuleIdentifier(); } [[nodiscard]] auto Module::GetModuleVersion() const -> ModuleVersion { return p_->GetModuleVersion(); } [[nodiscard]] auto Module::GetModuleMetaData() const -> ModuleMetaData { return p_->GetModuleMetaData(); } [[nodiscard]] auto Module::GetModulePath() const -> QString { return p_->GetModulePath(); } [[nodiscard]] auto Module::GetModuleHash() const -> QString { return p_->GetModuleHash(); } [[nodiscard]] auto Module::GetModuleSDKVersion() const -> QString { return p_->GetModuleSDKVersion(); } [[nodiscard]] auto Module::GetModuleQtEnvVersion() const -> QString { return p_->GetModuleQtEnvVersion(); } void Module::SetGPC(GlobalModuleContext* gpc) { p_->SetGPC(gpc); } } // namespace GpgFrontend::Module