1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/**
* Copyright (C) 2021 Saturneric <[email protected]>
*
* 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 <https://www.gnu.org/licenses/>.
*
* 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 <[email protected]> starting on May 12, 2021.
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#include "Module.h"
#include "core/module/GlobalModuleContext.h"
namespace GpgFrontend::Module {
class Module::Impl {
public:
friend class GlobalModuleContext;
using ExecCallback = std::function<void(int)>;
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), good_(false) {
for (auto& required_symbol : module_required_symbols_) {
*required_symbol.pointer =
reinterpret_cast<void*>(module_library.resolve(required_symbol.name));
if (*required_symbol.pointer == nullptr) {
GF_CORE_LOG_WARN(
"illegal module: {}, reason: cannot load symbol: {}, abort...",
module_library.fileName(), required_symbol.name);
return;
}
}
SPDLOG_INFO("module loaded, name: {}, verison: {}",
QString::fromUtf8(get_id_api_()),
QString::fromUtf8(get_version_api_()));
identifier_ = QString::fromUtf8(get_id_api_());
version_ = QString::fromUtf8(get_version_api_());
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 EventRefrernce& event) -> int {
if (good_ && execute_api_ != nullptr) {
return execute_api_(event->ToModuleEvent());
}
return -1;
}
auto Deactive() -> 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<TaskRunnerPtr> {
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_;
}
void SetGPC(GlobalModuleContext* gpc) { gpc_ = gpc; }
private:
GlobalModuleContext* gpc_{};
Module* m_ptr_;
ModuleIdentifier identifier_;
ModuleVersion version_;
ModuleMetaData meta_data_;
bool good_;
ModuleAPIGetModuleID get_id_api_;
ModuleAPIGetModuleVersion get_version_api_;
ModuleAPIGetModuleMetaData get_metadata_api_;
ModuleAPIRegisterModule register_api_;
ModuleAPIActivateModule activate_api_;
ModuleAPIExecuteModule execute_api_;
ModuleAPIDeactivateModule deactivate_api_;
ModuleAPIUnregisterModule unregister_api_;
struct Symbol {
const char* name;
void** pointer;
};
QList<Symbol> module_required_symbols_ = {
{"GetModuleID", reinterpret_cast<void**>(&get_id_api_)},
{"GetModuleVersion", reinterpret_cast<void**>(&get_version_api_)},
{"GetModuleMetaData", reinterpret_cast<void**>(&get_metadata_api_)},
{"RegisterModule", reinterpret_cast<void**>(®ister_api_)},
{"ActiveModule", reinterpret_cast<void**>(&activate_api_)},
{"ExecuteModule", reinterpret_cast<void**>(&execute_api_)},
{"DeactiveModule", reinterpret_cast<void**>(&deactivate_api_)},
{"UnregisterModule", reinterpret_cast<void**>(&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<Impl>(this, id, version, meta_data)) {}
Module::Module(QLibrary& module_library)
: p_(SecureCreateUniqueObject<Impl>(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(EventRefrernce event) -> int {
return p_->Exec(std::move(event));
}
auto Module::Deactive() -> int { return p_->Deactive(); }
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();
}
void Module::SetGPC(GlobalModuleContext* gpc) { p_->SetGPC(gpc); }
} // namespace GpgFrontend::Module
|