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
|
#include <libdnf5/base/base.hpp>
#include <libdnf5/common/exception.hpp>
#include <algorithm>
using namespace libdnf5;
namespace {
constexpr const char * PLUGIN_NAME{"template"};
constexpr plugin::Version PLUGIN_VERSION{.major = 1, .minor = 0, .micro = 0};
constexpr PluginAPIVersion REQUIRED_PLUGIN_API_VERSION{.major = 2, .minor = 0};
constexpr const char * attrs[]{"author.name", "author.email", "description", nullptr};
constexpr const char * attrs_value[]{"Fatima Freedom", "dummy@email.com", "Plugin description."};
class TemplatePlugin : public plugin::IPlugin {
public:
/// Implement custom constructor for the new plugin.
/// This is not necessary when you only need Base object for your implementation.
/// Optional to override.
TemplatePlugin(libdnf5::Base & base, libdnf5::ConfigParser &) : IPlugin(base) {}
/// Fill in the API version of your plugin.
/// This is used to check if the provided plugin API version is compatible with the library's plugin API version.
/// MANDATORY to override.
PluginAPIVersion get_api_version() const noexcept override { return REQUIRED_PLUGIN_API_VERSION; }
/// Enter the name of your new plugin.
/// This is used in log messages when an action or error related to the plugin occurs.
/// MANDATORY to override.
const char * get_name() const noexcept override { return PLUGIN_NAME; }
/// Fill in the version of your plugin.
/// This is utilized in informative and debugging log messages.
/// MANDATORY to override.
plugin::Version get_version() const noexcept override { return PLUGIN_VERSION; }
/// Add custom attributes, such as information about yourself and a description of the plugin.
/// These can be used to query plugin-specific data through the API.
/// Optional to override.
const char * const * get_attributes() const noexcept override { return attrs; }
const char * get_attribute(const char * attribute) const noexcept override {
for (size_t i = 0; attrs[i]; ++i) {
if (std::strcmp(attribute, attrs[i]) == 0) {
return attrs_value[i];
}
}
return nullptr;
}
/// Initialization method called after the Base object is created and before command-line arguments are parsed.
/// Optional to override.
void init() override {}
/// Cleanup method called when plugin objects are garbage collected.
/// Optional to override.
void finish() noexcept override {}
/// Override the hooks you want to implement.
void post_base_setup() override { post_base_magic(); }
void pre_transaction(const libdnf5::base::Transaction & transaction) override {
pre_transaction_magic(transaction);
};
private:
void post_base_magic();
void pre_transaction_magic(const libdnf5::base::Transaction &);
};
/// Example how to implement additional logic after the Base is set up.
void TemplatePlugin::post_base_magic() {
const auto & tsflags = get_base().get_config().get_tsflags_option().get_value();
if (std::find(tsflags.begin(), tsflags.end(), "noscripts") != tsflags.end()) {
libdnf_throw_assertion("Hey, we don't want a transaction without scriptlets!");
}
}
/// Example how to implement additional logic before starting the transaction.
void TemplatePlugin::pre_transaction_magic(const libdnf5::base::Transaction & transaction) {
transaction.set_description("This is our important transaction.");
}
} // namespace
/// Below is a block of functions with C linkage used for loading the plugin binaries from disk.
/// All of these are MANDATORY to implement.
/// Return plugin's API version.
PluginAPIVersion libdnf_plugin_get_api_version(void) {
return REQUIRED_PLUGIN_API_VERSION;
}
/// Return plugin's name.
const char * libdnf_plugin_get_name(void) {
return PLUGIN_NAME;
}
/// Return plugin's version.
plugin::Version libdnf_plugin_get_version(void) {
return PLUGIN_VERSION;
}
/// Return the instance of the implemented plugin.
plugin::IPlugin * libdnf_plugin_new_instance(
[[maybe_unused]] LibraryVersion library_version, libdnf5::Base & base, libdnf5::ConfigParser & parser) try {
return new TemplatePlugin(base, parser);
} catch (...) {
return nullptr;
}
/// Delete the plugin instance.
void libdnf_plugin_delete_instance(plugin::IPlugin * plugin_object) {
delete plugin_object;
}
|
