3. LIBDNF5 Plugin Template

Below is a template code for a LIBDNF5 plugin. For the complete tutorial on writing LIBDNF5 plugins, refer to LIBDNF5 Plugins.

libdnf5-plugins/template/template.cpp

#include <libdnf5/base/base.hpp>
#include <libdnf5/common/exception.hpp>
#include <libdnf5/plugin/iplugin.hpp>

#include <algorithm>

using namespace libdnf5;

namespace {

constexpr const char * PLUGIN_NAME{"libdnf5_template_plugin"};
constexpr plugin::Version PLUGIN_VERSION{.major = 1, .minor = 1, .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 final : public plugin::IPlugin2_1 {
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::plugin::IPluginData & data, libdnf5::ConfigParser &) : IPlugin2_1(data) {}

    /// 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) {
    auto & base = get_base();
    auto & logger = *base.get_logger();
    logger.info("Libdnf5 template plugin: {} packages in transaction", transaction.get_transaction_packages_count());
}

// Global variable to store the last exception from plugin initialization
// Allows capturing exceptions from C linkage functions that cannot propagate C++ exceptions
std::exception_ptr last_exception;

}  // 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::plugin::IPluginData & data,
    libdnf5::ConfigParser & parser) try {
    return new TemplatePlugin(data, parser);
} catch (...) {
    // Capture any exception that occurs during plugin instance creation
    // std::current_exception() retrieves the current exception and stores it for later processing
    last_exception = std::current_exception();

    return nullptr;  // Return nullptr as failure indicator (C function cannot throw exceptions)
}

/// Delete the plugin instance.
void libdnf_plugin_delete_instance(plugin::IPlugin * plugin_object) {
    delete plugin_object;
}

// libdnf5 use this function to determine the actual failure cause
// when libdnf_plugin_new_instance() returns nullptr
std::exception_ptr * libdnf_plugin_get_last_exception(void) {
    return &last_exception;
}

libdnf5-plugins/template/CMakeLists.txt

# set gettext domain for translations
set(GETTEXT_DOMAIN libdnf5-plugin-template)
add_definitions(-DGETTEXT_DOMAIN=\"${GETTEXT_DOMAIN}\")

# add your source files
add_library(template_plugin MODULE template.cpp)

# disable the 'lib' prefix in order to create template.so
set_target_properties(template_plugin PROPERTIES PREFIX "")

# link the libdnf5 library
target_link_libraries(template_plugin PRIVATE libdnf5)

# install the plugin into the common libdnf5-plugins location
#install(TARGETS template_plugin LIBRARY DESTINATION "${CMAKE_INSTALL_FULL_LIBDIR}/libdnf5/plugins/")

# install default plugin configuration file
#install(FILES "template.conf" DESTINATION "${CMAKE_INSTALL_FULL_SYSCONFDIR}/dnf/libdnf5-plugins")

libdnf5-plugins/template/template.conf

[main]
name = template_plugin
enabled = yes

# We can provide optional custom keys and sections.
custom_key = some_value

[custom]
website = https://my-hosting/template-plugin.org