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
|
/**
* Copyright (C) 2021-2024 Saturneric <eric@bktus.com>
*
* 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 <eric@bktus.com> starting on May 12, 2021.
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#include <GFModule.h>
#include <GFSDKHostCommands.hpp>
#include "GFModuleIdentity.h"
#include "GFModuleTr.h"
#include "PGPInspectDialog.h"
namespace {
/// Spelled unqualified: lupdate misreads `gf::cmd::Meta kMeta{` in a class
/// body and warns about an unknown namespace.
using CommandMeta = gf::cmd::Meta;
/// The ceiling on what is read out of a tab. Past this, the menu entry stays
/// greyed out rather than making every menu opening pay for a packet walk.
constexpr qint64 kMaxInspectSize = 16LL * 1024 * 1024;
/// The current tab's document, or an invalid one when there is nothing to
/// show. Cheap enough to run when the menu opens: the walk is a linear pass
/// over at most kMaxInspectSize bytes and decrypts nothing.
auto InspectCurrentTab() -> PGPInspectDocument {
const auto bytes = PGPInspectCurrentTabBytes();
if (bytes.isEmpty() || bytes.size() > kMaxInspectSize) return {};
return PGPInspectBytes(bytes);
}
/**
* @brief The module's one action: show the current tab's packet structure.
*
* Enabled only when the tab holds something to show -- decided when the
* menu opens, because what the current tab holds changes constantly and an
* entry enabled over plain text promises a window with nothing in it.
*/
struct OpenInspector {
static constexpr CommandMeta kMeta{
GF_MODULE_ID ".open_inspector",
GTrC::Noop("Open OpenPGP Structure Inspector"),
GTrC::Noop("Show the packet structure of the current tab"),
"",
0,
gf::cmd::kNeedsGuiThread};
using Args = gf::cmd::Unit;
using Result = gf::cmd::Unit;
static auto State(const gf::cmd::CommandContext& /*ctx*/) -> uint32_t {
return PGPInspectHasStructure(InspectCurrentTab())
? GF_CMD_STATE_ENABLED | GF_CMD_STATE_VISIBLE
: GF_CMD_STATE_VISIBLE;
}
};
auto DoOpenInspector(const gf::cmd::CommandContext& /*ctx*/,
const gf::cmd::Unit& /*args*/)
-> gf::cmd::Outcome<gf::cmd::Unit> {
// The dialog is the module's mount; the Host owns its frame and opens it.
Commands().Invoke<gf::cmd::host::ViewOpen>(
{gf::cmd::ViewRef{QStringLiteral(GF_MODULE_ID ".inspector")}});
return gf::cmd::Outcome<gf::cmd::Unit>::Success({});
}
} // namespace
auto OnActivate() -> GFResult {
// The inspector, built from the current tab each time it is opened. Where
// it is offered is ui/main.lua's business.
const bool ok = gf::ui::RegisterNativeWidget<PGPInspectDialog>(
"inspector",
{GTrC::Noop("OpenPGP Structure"), "", "", "", ":/icons/help.png", 820,
620},
[](const QCborMap& /*args*/) {
const auto bytes = PGPInspectCurrentTabBytes();
return new PGPInspectDialog(PGPInspectBytes(bytes), bytes.size());
});
return ok ? GFResult::Ok()
: GFResult::Fail("the inspector widget was not registered");
}
// The module's whole framework surface: what it provides, what runs at each
// lifecycle point, and one forwarder to the runtime that implements all of
// it. Everything above is business logic.
const std::array<gf::cmd::Binding, 1> kCommands = {
gf::cmd::Bind<OpenInspector, &DoOpenInspector>(),
};
const GFModuleHooks kHooks = {
sizeof(GFModuleHooks),
GF_MODULE_ID,
GF_MODULE_VERSION,
GF_MODULE_TRANSLATION_CONTEXT,
&OnActivate,
nullptr, // the Host withdraws the command, widget and script itself
nullptr,
nullptr, // no events
0,
kCommands.data(),
kCommands.size(),
};
extern "C" GF_MODULE_EXPORT auto GFModuleGetApi(uint32_t abi)
-> const GFModuleApi* {
return GFModuleRuntimeGetApi(abi, &kHooks);
}
|
