File: local.cpp

package info (click to toggle)
dnf5 5.4.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 17,960 kB
  • sloc: cpp: 94,312; python: 3,370; xml: 1,073; ruby: 600; sql: 250; ansic: 232; sh: 104; perl: 62; makefile: 30
file content (247 lines) | stat: -rw-r--r-- 9,423 bytes parent folder | download
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
// Copyright Contributors to the DNF5 project
// SPDX-License-Identifier: LGPL-2.1-or-later

#include "utils/string.hpp"

#include "libdnf5/utils/bgettext/bgettext-mark-domain.h"

#include <fcntl.h>
#include <libdnf5/base/base.hpp>
#include <libdnf5/conf/const.hpp>
#include <libdnf5/plugin/iplugin.hpp>
#include <libdnf5/repo/repo.hpp>
#include <libdnf5/repo/repo_query.hpp>
#include <sys/wait.h>


constexpr const char * LOCAL_REPO_NAME{"_dnf_local"};
constexpr const char * LOCATION_IN_PERSISTDIR{"plugins/local"};

using namespace libdnf5;

namespace {

constexpr const char * PLUGIN_NAME{"local"};
constexpr libdnf5::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[]{
    "Aleš Matěj",
    "amatej@redhat.com",
    "Automatically copy all downloaded packages to a repository configured path and generate repo metadata."};


class LocalPluginError : public libdnf5::Error {
    using Error::Error;
    const char * get_domain_name() const noexcept override { return "libdnf5::plugin"; }
    const char * get_name() const noexcept override { return "LocalPluginError"; }
};


class LocalPlugin : public plugin::IPlugin {
public:
    LocalPlugin(libdnf5::plugin::IPluginData & data, libdnf5::ConfigParser & config) : IPlugin(data), config(config) {}
    virtual ~LocalPlugin() = default;

    PluginAPIVersion get_api_version() const noexcept override { return REQUIRED_PLUGIN_API_VERSION; }

    const char * get_name() const noexcept override { return PLUGIN_NAME; }

    plugin::Version get_version() const noexcept override { return PLUGIN_VERSION; }

    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;
    }

    void post_base_setup() override {
        Base & base = get_base();
        auto repo_sack = base.get_repo_sack();
        auto repo = repo_sack->create_repo(LOCAL_REPO_NAME);
        if (config.has_option("main", "repodir")) {
            repodir = config.get_value("main", "repodir");
        } else {
            // default repo location
            repodir = base.get_config().get_persistdir_option().get_value();
            repodir = repodir / LOCATION_IN_PERSISTDIR;
        }
        repo->get_config().get_name_option().set("Local libdnf5 plugin repo");
        repo->get_config().get_baseurl_option().set("file://" + std::filesystem::absolute(repodir).string());
        repo->get_config().get_skip_if_unavailable_option().set(true);
        // Make local repo preferred over other repos (which by default have cost 1000)
        repo->get_config().get_cost_option().set(500);
        // The repo should never be cached:
        // - Users expect the packages to be available in it right after running a transaction
        // but this transaction would create a cache for the repo.
        // - The repo is usually local
        base.get_config().get_metadata_expire_option().set(0);
    }

    void post_transaction(const libdnf5::base::Transaction & transaction) override {
        std::filesystem::create_directories(repodir);

        std::vector<libdnf5::base::TransactionPackage> trans_packages = transaction.get_transaction_packages();
        bool need_rebuild = false;
        for (auto & tspkg : transaction.get_transaction_packages()) {
            if (transaction_item_action_is_inbound(tspkg.get_action())) {
                const auto & pkg = tspkg.get_package();
                if (pkg.get_repo_id() == LOCAL_REPO_NAME) {
                    continue;
                }
                std::filesystem::copy(
                    pkg.get_package_path(), repodir, std::filesystem::copy_options::overwrite_existing);
                need_rebuild = true;
            }
        }

        bool createrepo_enabled =
            OptionBool(false).from_string(config.get_value("createrepo", "enabled")) ? true : false;
        if (createrepo_enabled && need_rebuild) {
            std::vector<const char *> c_args{"--update", repodir.c_str()};

            // --quiet is on by default
            OptionBool quiet_option = OptionBool(true);
            OptionBool verbose_option = OptionBool(false);

            if (config.has_option("createrepo", "verbose")) {
                verbose_option.set(verbose_option.from_string(config.get_value("createrepo", "verbose")));
            }
            if (config.has_option("createrepo", "quiet")) {
                quiet_option.set(quiet_option.from_string(config.get_value("createrepo", "quiet")));
            }

            if (verbose_option.get_value()) {
                c_args.push_back("--verbose");
            } else if (quiet_option.get_value()) {
                c_args.push_back("--quiet");
            }

            std::filesystem::path cachedir;
            if (config.has_option("createrepo", "cachedir")) {
                cachedir = config.get_value("createrepo", "cachedir");
                if (!cachedir.empty()) {
                    c_args.push_back("--cachedir");
                    c_args.push_back(cachedir.c_str());
                }
            }
            // execvp expects null terminated array of arguments
            c_args.push_back(nullptr);

            int pipefd[2];
            if (pipe2(pipefd, O_CLOEXEC) == -1) {
                throw SystemError(errno, M_("Local plugin: Cannot create pipe"));
            }

            pid_t pid = fork();
            if (pid == -1) {
                throw SystemError(errno, M_("Local plugin: Cannot fork"));
            }

            if (pid == 0) {
                // This is the child process
                // Redirect stdout and stderr to the pipe
                dup2(pipefd[1], STDOUT_FILENO);
                dup2(pipefd[1], STDERR_FILENO);

                // Run program
                execvp("createrepo_c", const_cast<char * const *>(c_args.data()));

                // execvp should replace this process if it doesn't there was an error
                printf("Failed to execvp createrepo_c: %s\n", strerror(errno));
                _exit(255);
            } else {
                // This is the parent process
                // Close unused write pipe end
                close(pipefd[1]);

                char buffer[1024];
                ssize_t n;
                std::string output;
                while ((n = read(pipefd[0], buffer, sizeof(buffer) - 1)) > 0) {
                    buffer[n] = '\0';
                    output += buffer;
                }
                close(pipefd[0]);

                if (!output.empty()) {
                    auto & base = get_base();
                    auto & logger = *base.get_logger();

                    if (output.back() == '\n') {
                        output.pop_back();
                    }

                    for (const auto & line : libdnf5::utils::string::split(output, "\n")) {
                        logger.info("local plugin: createrepo_c: {}", line);
                        // This print can interleave with the installation transaction progressbar
                        // but I think we are missing an API the could print this correctly.
                        printf("local plugin: createrepo_c: %s\n", line.c_str());
                    }
                }

                // Wait for child
                int child_exit_status;
                int rc = waitpid(pid, &child_exit_status, 0);
                if (rc == -1) {
                    throw SystemError(errno, M_("Local plugin: Cannot waitpid"));
                }

                if (WIFEXITED(child_exit_status)) {
                    // Terminated normally (exit, _exit, returning from main) -> check exit code
                    if (const int exit_status = WEXITSTATUS(child_exit_status); exit_status != 0) {
                        throw LocalPluginError(M_("Createrepo_c process exited with code {}"), exit_status);
                    }
                } else if (WIFSIGNALED(child_exit_status)) {
                    throw LocalPluginError(M_("Createrepo_c process killed by signal {}"), WTERMSIG(child_exit_status));
                }
            }
        }
    }

private:
    libdnf5::ConfigParser & config;
    std::filesystem::path repodir;
};


std::exception_ptr last_exception;

}  // namespace


PluginAPIVersion libdnf_plugin_get_api_version(void) {
    return REQUIRED_PLUGIN_API_VERSION;
}

const char * libdnf_plugin_get_name(void) {
    return PLUGIN_NAME;
}

plugin::Version libdnf_plugin_get_version(void) {
    return PLUGIN_VERSION;
}

plugin::IPlugin * libdnf_plugin_new_instance(
    [[maybe_unused]] LibraryVersion library_version,
    libdnf5::plugin::IPluginData & data,
    libdnf5::ConfigParser & parser) try {
    return new LocalPlugin(data, parser);
} catch (...) {
    last_exception = std::current_exception();
    return nullptr;
}

void libdnf_plugin_delete_instance(plugin::IPlugin * plugin_object) {
    delete plugin_object;
}

std::exception_ptr * libdnf_plugin_get_last_exception(void) {
    return &last_exception;
}