File: unsetopt.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 (220 lines) | stat: -rw-r--r-- 8,817 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
// Copyright Contributors to the DNF5 project.
// Copyright Contributors to the libdnf project.
// SPDX-License-Identifier: GPL-2.0-or-later
//
// This file is part of libdnf: https://github.com/rpm-software-management/libdnf/
//
// Libdnf 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 2 of the License, or
// (at your option) any later version.
//
// Libdnf 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 libdnf.  If not, see <https://www.gnu.org/licenses/>.

#include "unsetopt.hpp"

#include "shared.hpp"

#include <libdnf5/conf/const.hpp>
#include <libdnf5/utils/bgettext/bgettext-mark-domain.h>

#include <filesystem>

namespace dnf5 {

using namespace libdnf5;

namespace {

bool remove_from_config(
    ConfigParser & parser,
    const std::string & section_id,
    const std::set<std::string> & keys,
    std::set<std::string> & used_keys) {
    bool removed = false;
    for (const auto & key : keys) {
        if (parser.remove_option(section_id, key)) {
            removed = true;
            used_keys.insert(key);
        }
    }
    return removed;
}

}  // namespace


void ConfigManagerUnsetOptCommand::set_argument_parser() {
    auto & ctx = get_context();
    auto & parser = ctx.get_argument_parser();

    auto & cmd = *get_argument_parser_command();
    cmd.set_description("Unset/remove configuration and repositories options");

    auto opts_vals =
        parser.add_new_positional_arg("options", cli::ArgumentParser::PositionalArg::AT_LEAST_ONE, nullptr, nullptr);
    opts_vals->set_description("List of options to unset");
    opts_vals->set_parse_hook_func(
        [this, &ctx]([[maybe_unused]] cli::ArgumentParser::PositionalArg * arg, int argc, const char * const argv[]) {
            for (int i = 0; i < argc; ++i) {
                auto value = argv[i];
                std::string key{value};
                auto dot_pos = key.rfind('.');
                if (dot_pos != std::string::npos) {
                    if (dot_pos == key.size() - 1) {
                        throw cli::ArgumentParserError(
                            M_("{}: Badly formatted argument value: Last key character cannot be '.': {}"),
                            std::string{"remove-opt"},
                            std::string{value});
                    }

                    // Save the repository option for later processing (solving glob pattern, writing to file).
                    auto repo_id = key.substr(0, dot_pos);
                    if (repo_id.empty()) {
                        throw cli::ArgumentParserError(
                            M_("{}: Empty repository id is not allowed: {}"),
                            std::string{"remove-opt"},
                            std::string{value});
                    }
                    auto repo_key = key.substr(dot_pos + 1);

                    // Test if the repository options are known.
                    try {
                        tmp_repo_conf.opt_binds().at(repo_key);
                    } catch (const OptionBindsOptionNotFoundError & ex) {
                        write_warning(
                            *ctx.get_base().get_logger(),
                            M_("config-manager: Request to remove unsupported repository option: {}"),
                            key);
                    }

                    in_repos_opts_to_remove[repo_id].insert(repo_key);
                } else {
                    // Test if the global option is known.
                    try {
                        tmp_config.opt_binds().at(key);
                    } catch (const OptionBindsOptionNotFoundError & ex) {
                        write_warning(
                            *ctx.get_base().get_logger(),
                            M_("config-manager: Request to remove unsupported main option: {}"),
                            key);
                    }

                    // Save the global option for later removing from the file.
                    main_opts_to_remove.insert(key);
                }
            }
            return true;
        });
    cmd.register_positional_arg(opts_vals);
}


void ConfigManagerUnsetOptCommand::configure() {
    auto & ctx = get_context();
    const auto & config = ctx.get_base().get_config();

    // Remove options from main configuration file.
    if (!main_opts_to_remove.empty()) {
        const auto & cfg_filepath = get_config_file_path(ctx.get_base().get_config());
        if (std::filesystem::exists(cfg_filepath)) {
            ConfigParser parser;
            bool changed = false;
            std::set<std::string> used_keys;

            parser.read(cfg_filepath);

            changed |= remove_from_config(parser, "main", main_opts_to_remove, used_keys);

            // Generate warning for unused options
            for (const auto & key : main_opts_to_remove) {
                if (!used_keys.contains(key)) {
                    write_warning(
                        *ctx.get_base().get_logger(),
                        M_("config-manager: Request to remove main option but it is not present in the config file: "
                           "{}"),
                        key);
                }
            }

            if (changed) {
                parser.write(cfg_filepath, false);
            }
        } else {
            write_warning(
                *ctx.get_base().get_logger(),
                M_("config-manager: Request to remove main option but config file not found: {}"),
                cfg_filepath.string());
        }
    }

    // Remove options from repositories overrides configuration file, remove empty sections.
    if (!in_repos_opts_to_remove.empty()) {
        const auto & repos_override_file_path = get_config_manager_repos_override_file_path(config);
        if (std::filesystem::exists(repos_override_file_path)) {
            ConfigParser parser;
            bool changed = false;
            std::map<std::string, std::set<std::string>> used_repos_opts;

            parser.read(repos_override_file_path);

            std::vector<std::string> empty_config_sections;
            for (const auto & [repo_id, setopts] : parser.get_data()) {
                for (const auto & [in_repoid, keys] : in_repos_opts_to_remove) {
                    if (sack::match_string(repo_id, sack::QueryCmp::GLOB, in_repoid)) {
                        auto & used_repoid_opts = used_repos_opts[in_repoid];
                        changed |= remove_from_config(parser, repo_id, keys, used_repoid_opts);
                    }
                }
                if (setopts.empty()) {
                    empty_config_sections.emplace_back(repo_id);
                }
            }

            // Generate warning for unused repoids and options
            for (const auto & [in_repoid, keys] : in_repos_opts_to_remove) {
                if (const auto used_repoid_opts = used_repos_opts.find(in_repoid);
                    used_repoid_opts == used_repos_opts.end()) {
                    write_warning(
                        *ctx.get_base().get_logger(),
                        M_("config-manager: Request to remove repository option but repoid is not present "
                           "in the overrides: {}"),
                        in_repoid);
                } else {
                    for (const auto & key : keys) {
                        if (!used_repoid_opts->second.contains(key))
                            write_warning(
                                *ctx.get_base().get_logger(),
                                M_("config-manager: Request to remove repository option but it is not present "
                                   "in the overrides: {}.{}"),
                                in_repoid,
                                key);
                    }
                }
            }

            // Clean config - remove empty sections.
            for (const auto & section : empty_config_sections) {
                parser.remove_section(section);
                changed = true;
            }

            if (changed) {
                parser.write(repos_override_file_path, false);
            }
        } else {
            write_warning(
                *ctx.get_base().get_logger(),
                M_("config-manager: Request to remove repository option but file with overrides not found: {}"),
                repos_override_file_path.string());
        }
    }
}

}  // namespace dnf5