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 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
|
// Copyright Contributors to the DNF5 project.
// Copyright Contributors to the libdnf project.
// SPDX-License-Identifier: LGPL-2.1-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 Lesser General Public License as published by
// the Free Software Foundation, either version 2.1 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with libdnf. If not, see <https://www.gnu.org/licenses/>.
#include "libdnf5/base/log_event.hpp"
#include "utils/string.hpp"
#include "libdnf5/utils/bgettext/bgettext-lib.h"
#include "libdnf5/utils/format.hpp"
namespace libdnf5::base {
class LogEvent::Impl {
public:
Impl(
libdnf5::GoalAction action,
libdnf5::GoalProblem problem,
const std::set<std::string> & additional_data,
const libdnf5::GoalJobSettings & settings,
libdnf5::transaction::TransactionItemType spec_type,
const std::string & spec);
Impl(libdnf5::GoalAction action, libdnf5::GoalProblem problem, const SolverProblems & solver_problems);
private:
friend LogEvent;
libdnf5::GoalAction action;
libdnf5::GoalProblem problem;
std::set<std::string> additional_data;
std::optional<libdnf5::GoalJobSettings> job_settings;
std::optional<libdnf5::transaction::TransactionItemType> spec_type;
std::optional<std::string> spec;
std::optional<SolverProblems> solver_problems;
};
LogEvent::Impl::Impl(
libdnf5::GoalAction action,
libdnf5::GoalProblem problem,
const std::set<std::string> & additional_data,
const libdnf5::GoalJobSettings & settings,
const libdnf5::transaction::TransactionItemType spec_type,
const std::string & spec)
: action(action),
problem(problem),
additional_data(additional_data),
job_settings(settings),
spec_type(spec_type),
spec(spec) {}
LogEvent::Impl::Impl(libdnf5::GoalAction action, libdnf5::GoalProblem problem, const SolverProblems & solver_problems)
: action(action),
problem(problem),
solver_problems(solver_problems) {}
LogEvent::LogEvent(
libdnf5::GoalAction action,
libdnf5::GoalProblem problem,
const std::set<std::string> & additional_data,
const libdnf5::GoalJobSettings & settings,
const libdnf5::transaction::TransactionItemType spec_type,
const std::string & spec)
: p_impl(std::make_unique<Impl>(action, problem, additional_data, settings, spec_type, spec)) {
libdnf_assert(
!(problem == libdnf5::GoalProblem::SOLVER_ERROR ||
problem == libdnf5::GoalProblem::SOLVER_PROBLEM_STRICT_RESOLVEMENT ||
problem == libdnf5::GoalProblem::MODULE_SOLVER_ERROR ||
problem == libdnf5::GoalProblem::MODULE_SOLVER_ERROR_LATEST ||
problem == libdnf5::GoalProblem::MODULE_SOLVER_ERROR_DEFAULTS),
"LogEvent::LogEvent() called with incorrect problem, the constructor does not allow these problems: "
"libdnf5::GoalProblem::SOLVER_ERROR, libdnf5::GoalProblem::SOLVER_PROBLEM_STRICT_RESOLVEMENT, "
"libdnf5::GoalProblem::MODULE_SOLVER_ERROR, libdnf5::GoalProblem::MODULE_SOLVER_ERROR_LATEST, "
"libdnf5::GoalProblem::MODULE_SOLVER_ERROR_DEFAULTS. "
"With those problems it is necessary to provide SolverProblems in constructor");
}
LogEvent::LogEvent(libdnf5::GoalProblem problem, const SolverProblems & solver_problems)
: p_impl(std::make_unique<Impl>(libdnf5::GoalAction::RESOLVE, problem, solver_problems)) {
libdnf_assert(
problem == libdnf5::GoalProblem::SOLVER_ERROR ||
problem == libdnf5::GoalProblem::SOLVER_PROBLEM_STRICT_RESOLVEMENT ||
problem == libdnf5::GoalProblem::MODULE_SOLVER_ERROR ||
problem == libdnf5::GoalProblem::MODULE_SOLVER_ERROR_LATEST ||
problem == libdnf5::GoalProblem::MODULE_SOLVER_ERROR_DEFAULTS,
"LogEvent::LogEvent() called with incorrect problem, supported problems are only: "
"libdnf5::GoalProblem::SOLVER_ERROR, libdnf5::GoalProblem::SOLVER_PROBLEM_STRICT_RESOLVEMENT, "
"libdnf5::GoalProblem::MODULE_SOLVER_ERROR, libdnf5::GoalProblem::MODULE_SOLVER_ERROR_LATEST, "
"libdnf5::GoalProblem::MODULE_SOLVER_ERROR_DEFAULTS.");
}
LogEvent::~LogEvent() = default;
LogEvent::LogEvent(const LogEvent & src) : p_impl(new Impl(*src.p_impl)) {}
LogEvent::LogEvent(LogEvent && src) noexcept = default;
LogEvent & LogEvent::operator=(const LogEvent & src) {
if (this != &src) {
if (p_impl) {
*p_impl = *src.p_impl;
} else {
p_impl = std::make_unique<Impl>(*src.p_impl);
}
}
return *this;
}
LogEvent & LogEvent::operator=(LogEvent && src) noexcept = default;
std::string LogEvent::to_string(
libdnf5::GoalAction action,
libdnf5::GoalProblem problem,
const std::set<std::string> & additional_data,
const std::optional<libdnf5::GoalJobSettings> & settings,
const std::optional<libdnf5::transaction::TransactionItemType> & spec_type,
const std::optional<std::string> & spec,
const std::optional<SolverProblems> & solver_problems) {
std::string ret;
switch (problem) {
// TODO(jmracek) Improve messages => Each message can contain also an action
case GoalProblem::NOT_FOUND:
if (action == GoalAction::REMOVE) {
switch (*spec_type) {
case libdnf5::transaction::TransactionItemType::PACKAGE:
return ret.append(utils::sformat(_("No packages to remove for argument: {}"), *spec));
case libdnf5::transaction::TransactionItemType::GROUP:
return ret.append(utils::sformat(_("No groups to remove for argument: {}"), *spec));
case libdnf5::transaction::TransactionItemType::ENVIRONMENT:
return ret.append(
utils::sformat(_("No environmental groups to remove for argument: {}"), *spec));
case libdnf5::transaction::TransactionItemType::MODULE:
return ret.append(utils::sformat(_("No modules to remove for argument: {}"), *spec));
}
} else if (action == GoalAction::INSTALL_BY_COMPS) {
if (spec_type && *spec_type == libdnf5::transaction::TransactionItemType::GROUP) {
return ret.append(utils::sformat(_("No match for group from environment: {}"), *spec));
} else {
return ret.append(utils::sformat(_("No match for group package: {}"), *spec));
}
} else if (goal_action_is_replay(action)) {
return ret.append(
utils::sformat(_("Cannot perform {0}, no match for: {1}."), goal_action_to_string(action), *spec));
}
return ret.append(utils::sformat(_("No match for argument: {}"), *spec));
case GoalProblem::NOT_FOUND_IN_ADVISORIES:
if (spec && !spec->empty()) {
return ret.append(utils::sformat(_("No match for argument '{0}' in selected advisories"), *spec));
} else {
return ret.append(_("No match in selected advisories"));
}
case GoalProblem::NOT_FOUND_IN_REPOSITORIES:
return ret.append(utils::sformat(
_("No match for argument '{0}' in repositories '{1}'"),
*spec,
utils::string::join(settings->get_to_repo_ids(), ", ")));
case GoalProblem::NOT_INSTALLED: {
if (goal_action_is_replay(action)) {
return ret.append(utils::sformat(
_("Cannot perform {0} for {1} '{2}' because it is not installed."),
goal_action_to_string(action),
transaction_item_type_to_string(*spec_type),
*spec));
}
return ret.append(utils::sformat(_("Packages for argument '{}' available, but not installed."), *spec));
}
case GoalProblem::NOT_INSTALLED_FOR_ARCHITECTURE:
return ret.append(utils::sformat(
_("Packages for argument '{}' available, but installed for a different architecture."), *spec));
case GoalProblem::ONLY_SRC:
if (goal_action_is_replay(action)) {
return ret.append(utils::sformat(
_("Cannot perform {0} because '{1}' matches only source packages."),
goal_action_to_string(action),
*spec));
}
return ret.append(utils::sformat(_("Argument '{}' matches only source packages."), *spec));
case GoalProblem::EXCLUDED:
if (goal_action_is_replay(action)) {
return ret.append(utils::sformat(
_("Cannot perform {0} because '{1}' matches only excluded packages."),
goal_action_to_string(action),
*spec));
}
return ret.append(utils::sformat(_("Argument '{}' matches only excluded packages."), *spec));
case GoalProblem::EXCLUDED_VERSIONLOCK:
if (goal_action_is_replay(action)) {
return ret.append(utils::sformat(
_("Cannot perform {0} because '{1}' matches only packages excluded by versionlock."),
goal_action_to_string(action),
*spec));
}
return ret.append(utils::sformat(_("Argument '{}' matches only packages excluded by versionlock."), *spec));
case GoalProblem::HINT_ICASE:
if (additional_data.size() != 1) {
throw std::invalid_argument("Incorrect number of elements for HINT_ICASE");
}
return ret.append(utils::sformat(_(" * Maybe you meant: {}"), *additional_data.begin()));
case GoalProblem::HINT_ALTERNATIVES: {
auto elements = utils::string::join(additional_data, ", ");
return ret.append(utils::sformat(_("There are following alternatives for '{0}': {1}"), *spec, elements));
}
case GoalProblem::INSTALLED_LOWEST_VERSION: {
if (additional_data.size() != 1) {
throw std::invalid_argument("Incorrect number of elements for INSTALLED_LOWEST_VERSION");
}
return ret.append(utils::sformat(
_("The lowest available version of the \"{}\" package is already installed, cannot downgrade it."),
*additional_data.begin()));
}
case GoalProblem::INSTALLED_IN_DIFFERENT_VERSION:
if (action == GoalAction::REINSTALL) {
return ret.append(utils::sformat(
_("Installed packages for argument '{0}' are not available in repositories in the same version, "
"available versions: {1}, cannot reinstall."),
*spec,
libdnf5::utils::string::join(additional_data, ",")));
} else if (goal_action_is_replay(action)) {
return ret.append(utils::sformat(
_("Cannot perform {0} because '{1}' is installed in a different version: '{2}'."),
goal_action_to_string(action),
*spec,
libdnf5::utils::string::join(additional_data, ",")));
}
return ret.append(utils::sformat(
_("Packages for argument '{}' installed and available, but in a different version."), *spec));
case GoalProblem::NOT_AVAILABLE:
return ret.append(utils::sformat(_("Packages for argument '{}' installed, but not available."), *spec));
case GoalProblem::NO_PROBLEM:
throw std::invalid_argument("Unsupported elements for a goal problem");
case GoalProblem::ALREADY_INSTALLED:
if (spec_type && *spec_type == libdnf5::transaction::TransactionItemType::GROUP) {
return ret.append(utils::sformat(_("Group \"{}\" is already installed."), *spec));
}
if (spec_type && *spec_type == libdnf5::transaction::TransactionItemType::ENVIRONMENT) {
return ret.append(utils::sformat(_("Environmental group \"{}\" is already installed."), *spec));
}
if (additional_data.size() != 1) {
throw std::invalid_argument("Incorrect number of elements for ALREADY_INSTALLED");
}
if (action == GoalAction::REASON_CHANGE) {
return ret.append(utils::sformat(
_("Package \"{}\" is already installed with reason \"{}\"."), *spec, *additional_data.begin()));
} else {
return ret.append(utils::sformat(_("Package \"{}\" is already installed."), *additional_data.begin()));
}
case GoalProblem::SOLVER_ERROR:
case GoalProblem::SOLVER_PROBLEM_STRICT_RESOLVEMENT:
if (!solver_problems) {
throw std::invalid_argument("Missing SolverProblems to convert event into string");
}
return ret.append(solver_problems->to_string());
case GoalProblem::WRITE_DEBUG:
return ret.append(utils::sformat(_("Debug data written to \"{}\""), *additional_data.begin()));
case GoalProblem::UNSUPPORTED_ACTION:
if (action == GoalAction::REVERT_COMPS_UPGRADE) {
return ret.append(utils::sformat(
_("{0} upgrade cannot be reverted, however associated package actions will be. ({1} id: '{2}') ."),
transaction_item_type_to_string(*spec_type),
transaction_item_type_to_string(*spec_type),
*spec));
}
return ret.append(utils::sformat(
_("{} action for argument \"{}\" is not supported."), goal_action_to_string(action), *spec));
case GoalProblem::MULTIPLE_STREAMS: {
// Create module dict { name : { stream } } out of the additional data.
std::map<std::string, std::set<std::string>> module_dict;
for (const auto & module_stream : additional_data) {
const auto pos = module_stream.find(":");
module_dict[module_stream.substr(0, pos)].insert(module_stream.substr(pos + 1));
}
// Format a leading line of the error message.
ret.append(utils::sformat(_("Unable to resolve argument '{}':"), *spec));
// Describe all the streams of modules that were matched.
for (const auto & module_dict_iter : module_dict) {
ret.append(utils::sformat(
P_("\n - Argument '{}' matches {} stream ('{}') of module '{}', "
"but the stream is not enabled or default.",
"\n - Argument '{}' matches {} streams ('{}') of module '{}', "
"but none of the streams are enabled or default.",
module_dict_iter.second.size()),
*spec,
module_dict_iter.second.size(),
utils::string::join(module_dict_iter.second, _("', '")),
module_dict_iter.first));
}
return ret;
}
case GoalProblem::MODULE_SOLVER_ERROR: {
if (!solver_problems) {
throw std::invalid_argument("Missing SolverProblems to convert event into string");
}
ret.append(utils::sformat(_("Modular dependency problems:\n")));
return ret.append(solver_problems->to_string());
}
case GoalProblem::MODULE_SOLVER_ERROR_LATEST: {
if (!solver_problems) {
throw std::invalid_argument("Missing SolverProblems to convert event into string");
}
ret.append(utils::sformat(_("Modular dependency problems with the latest modules:\n")));
return ret.append(solver_problems->to_string());
}
case GoalProblem::MODULE_SOLVER_ERROR_DEFAULTS: {
if (!solver_problems) {
throw std::invalid_argument("Missing SolverProblems to convert event into string");
}
ret.append(utils::sformat(_("Modular dependency problems with the defaults:\n")));
return ret.append(solver_problems->to_string());
}
case GoalProblem::MODULE_CANNOT_SWITH_STREAMS: {
std::string original_stream;
std::string new_stream;
for (const auto & module_stream : additional_data) {
const auto pos = module_stream.find(":");
if (module_stream.substr(0, pos) == "0") {
original_stream = module_stream.substr(pos + 1);
} else {
new_stream = module_stream.substr(pos + 1);
}
}
ret.append(utils::sformat(
_("The operation would result in switching of module '{0}' stream '{1}' to stream '{2}'\n"),
*spec,
original_stream,
new_stream));
return ret.append(
_("Error: It is not possible to switch enabled streams of a module unless explicitly enabled via "
"configuration option module_stream_switch."));
}
case GoalProblem::EXTRA: {
return ret.append(utils::sformat(
_("Extra package '{0}' (with action '{1}') which is not present in the stored transaction was pulled "
"into the transaction.\n"),
*spec,
*additional_data.begin()));
}
case GoalProblem::MALFORMED: {
return ret.append(utils::sformat(_("Cannot parse file: '{0}': {1}.\n"), *spec, *additional_data.begin()));
}
case GoalProblem::NOT_FOUND_DEBUGINFO: {
if (additional_data.empty()) {
throw std::invalid_argument("Missing description of missing debuginfo packages");
}
return ret.append(utils::sformat(
_("Could not find debuginfo package for the following packages resolved from the argument '{0}': {1}"),
*spec,
utils::string::join(
additional_data, C_("String for joining NEVRAs - e.g. `foo-4-4.noarch, bar-5-5.noarch`", ", "))));
}
case GoalProblem::NOT_FOUND_DEBUGSOURCE: {
if (additional_data.empty()) {
throw std::invalid_argument("Missing description of missing debugsource packages");
}
return ret.append(utils::sformat(
_("Could not find debugsource package for the following packages resolved from the argument '{0}': "
"{1}"),
*spec,
utils::string::join(
additional_data, C_("String for joining NEVRAs - e.g. `foo-4-4.noarch, bar-5-5.noarch`", ", "))));
}
case GoalProblem::MERGE_ERROR: {
return ret.append(utils::sformat(_("Transaction merge error: '{0}'"), *additional_data.begin()));
}
}
return ret;
}
libdnf5::GoalAction LogEvent::get_action() const {
return p_impl->action;
};
libdnf5::GoalProblem LogEvent::get_problem() const {
return p_impl->problem;
};
const std::set<std::string> & LogEvent::get_additional_data() const {
return p_impl->additional_data;
};
const libdnf5::GoalJobSettings * LogEvent::get_job_settings() const {
return p_impl->job_settings ? &p_impl->job_settings.value() : nullptr;
};
const std::string * LogEvent::get_spec() const {
return p_impl->spec ? &p_impl->spec.value() : nullptr;
};
const SolverProblems * LogEvent::get_solver_problems() const {
return p_impl->solver_problems ? &p_impl->solver_problems.value() : nullptr;
};
std::string LogEvent::to_string() const {
return to_string(
p_impl->action,
p_impl->problem,
p_impl->additional_data,
p_impl->job_settings,
p_impl->spec_type,
p_impl->spec,
p_impl->solver_problems);
};
} // namespace libdnf5::base
|