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
|
// 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 <Python.h>
#include <fmt/format.h>
#include <libdnf5/base/base.hpp>
#include <libdnf5/plugin/iplugin.hpp>
#include <libdnf5/plugin/utils.hpp>
#include <libdnf5/utils/fs/utils.hpp>
#include <swigpyrun.h>
#include <cstdlib>
#include <cstring>
#include <filesystem>
#include <mutex>
using namespace libdnf5;
namespace fs = std::filesystem;
namespace {
constexpr const char * PLUGIN_NAME = "python_plugins_loader";
constexpr plugin::Version PLUGIN_VERSION{0, 1, 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[]{"Jaroslav Rohel", "jrohel@redhat.com", "Plugin for loading Python plugins."};
class PythonPluginLoader : public plugin::IPlugin {
public:
PythonPluginLoader(libdnf5::plugin::IPluginData & data, libdnf5::ConfigParser &) : IPlugin(data), data(data) {}
virtual ~PythonPluginLoader();
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 load_plugins() override;
private:
void load_plugin_file(
const std::string & plugin_name, libdnf5::ConfigParser * plugin_config, const fs::path & plugin_path);
void load_plugins_from_dirs(const std::vector<fs::path> & config_dirs, const fs::path & plugins_dir);
static int python_ref_counter;
bool active{false};
// Store the plugin data so we can pass them to each python plugin
libdnf5::plugin::IPluginData & data;
};
int PythonPluginLoader::python_ref_counter{0};
/// Smart pointer to PyObject
///
/// Owns and manages PyObject. Decrements the reference count for the PyObject
/// (calls Py_XDECREF on it) when UniquePtrPyObject goes out of scope.
///
/// Implements subset of standard std::unique_ptr methods.
///
class UniquePtrPyObject {
public:
constexpr UniquePtrPyObject() noexcept : py_obj(NULL) {}
explicit UniquePtrPyObject(PyObject * pyObj) noexcept : py_obj(pyObj) {}
UniquePtrPyObject(UniquePtrPyObject && src) noexcept : py_obj(src.py_obj) { src.py_obj = NULL; }
UniquePtrPyObject & operator=(UniquePtrPyObject && src) noexcept;
explicit operator bool() const noexcept { return py_obj != NULL; }
PyObject * get() const noexcept { return py_obj; }
PyObject * release() noexcept;
void reset(PyObject * pyObj = NULL) noexcept;
~UniquePtrPyObject() { Py_XDECREF(py_obj); }
private:
PyObject * py_obj;
};
inline PyObject * UniquePtrPyObject::release() noexcept {
auto tmpObj = py_obj;
py_obj = NULL;
return tmpObj;
}
inline UniquePtrPyObject & UniquePtrPyObject::operator=(UniquePtrPyObject && src) noexcept {
if (this == &src)
return *this;
Py_XDECREF(py_obj);
py_obj = src.py_obj;
src.py_obj = NULL;
return *this;
}
inline void UniquePtrPyObject::reset(PyObject * pyObj) noexcept {
Py_XDECREF(this->py_obj);
this->py_obj = pyObj;
}
/// bytes or unicode string in Python 3 to c string converter
class PycompString {
public:
PycompString() = default;
explicit PycompString(PyObject * str);
const std::string & get_string() const noexcept { return cpp_string; }
const char * get_cstring() const noexcept { return is_null ? nullptr : cpp_string.c_str(); }
private:
bool is_null{true};
std::string cpp_string;
};
PycompString::PycompString(PyObject * str) {
if (PyUnicode_Check(str)) {
UniquePtrPyObject py_string(PyUnicode_AsEncodedString(str, "utf-8", "replace"));
if (py_string) {
// The c_string refers to the internal buffer of py_string
char * c_string = PyBytes_AsString(py_string.get());
if (c_string) {
cpp_string = c_string;
is_null = false;
}
}
} else if (PyBytes_Check(str)) {
auto c_string = PyBytes_AsString(str);
if (c_string) {
cpp_string = c_string;
is_null = false;
}
} else {
throw std::runtime_error("Expected a string or a unicode object");
}
}
PythonPluginLoader::~PythonPluginLoader() {
if (active) {
std::lock_guard<libdnf5::Base> guard(get_base());
if (--python_ref_counter == 0) {
Py_Finalize();
}
}
}
/// Fetch Python error (if exist) and throw C++ exception
static void fetch_python_error_to_exception(const char * msg) {
if (!PyErr_Occurred()) {
return;
}
PyObject *type, *value, *traceback;
PyErr_Fetch(&type, &value, &traceback);
UniquePtrPyObject objectsRepresentation(PyObject_Repr(value));
auto pycomp_str = PycompString(objectsRepresentation.get());
throw std::runtime_error(msg + pycomp_str.get_string());
}
/// Load Python plugin from path
void PythonPluginLoader::load_plugin_file(
const std::string & plugin_name, libdnf5::ConfigParser * plugin_config, const fs::path & plugin_path) {
// Very High Level Embedding
// std::string python_code = "import " + file_path.stem().string() +";";
// python_code += "import libdnf5;";
// python_code += "plug = " + file_path.stem().string() +".Plugin(data);";
// python_code += "locked_base = libdnf5.base.Base.get_locked_base();";
// python_code += "locked_base.add_plugin(plug)";
// PyRun_SimpleString(python_code.c_str());
// Similar but Pure Embedding
fs::path module_name = plugin_path.stem();
PyObject * plugin_module = PyImport_ImportModule(module_name.c_str());
if (!plugin_module) {
fetch_python_error_to_exception("PyImport_ImportModule(): ");
}
PyObject * plugin_module_dict = PyModule_GetDict(plugin_module);
if (!plugin_module_dict) {
fetch_python_error_to_exception("PyModule_GetDict(plugin_module): ");
}
PyObject * plugin_class = PyDict_GetItemString(plugin_module_dict, "Plugin");
if (!plugin_class) {
fetch_python_error_to_exception("PyDict_GetItemString(plugin_module_dict, \"Plugin\"): ");
}
PyObject * plugin_class_constructor = PyInstanceMethod_New(plugin_class);
if (!plugin_class_constructor) {
fetch_python_error_to_exception("PyInstanceMethod_New(plugin_class): ");
}
PyObject * args_tuple = PyTuple_New(1);
if (!args_tuple) {
fetch_python_error_to_exception("PyTuple_New(1)");
}
swig_type_info * type = SWIG_TypeQuery("libdnf5::plugin::IPluginData *");
if (!PyTuple_SetItem(args_tuple, 0, SWIG_NewPointerObj(&data, type, 0))) {
fetch_python_error_to_exception("PyTuple_SetItem(args_tuple, 0, PyLong_FromVoidPtr(&data))");
}
PyObject * plugin_instance = PyObject_CallObject(plugin_class_constructor, args_tuple);
if (!plugin_instance) {
fetch_python_error_to_exception("PyObject_CallObject(plugin_class_constructor, args_tuple): ");
}
PyObject * libdnf5 = PyDict_GetItemString(plugin_module_dict, "libdnf5");
if (!libdnf5) {
fetch_python_error_to_exception("PyDict_GetItemString(plugin_module_dict, \"libdnf5\"): ");
}
PyObject * libdnf5_dict = PyModule_GetDict(libdnf5);
if (!libdnf5_dict) {
fetch_python_error_to_exception("PyModule_GetDict(libdnf5): ");
}
PyObject * base_module = PyDict_GetItemString(libdnf5_dict, "base");
if (!base_module) {
fetch_python_error_to_exception("PyDict_GetItemString(plugin_module_dict, \"libdnf5\"): ");
}
PyObject * base_module_dict = PyModule_GetDict(base_module);
if (!base_module_dict) {
fetch_python_error_to_exception("PyModule_GetDict(base_module): ");
}
PyObject * base_class = PyDict_GetItemString(base_module_dict, "Base");
if (!base_class) {
fetch_python_error_to_exception("PyDict_GetItemString(base_module_dict, \"Base\"): ");
}
UniquePtrPyObject locked_base(PyObject_CallMethod(base_class, "get_locked_base", NULL));
if (!locked_base) {
fetch_python_error_to_exception("PyDict_CallMethod(base_class, \"get_locked_base\", NULL): ");
}
UniquePtrPyObject add_plugin_string(PyUnicode_FromString("add_plugin"));
UniquePtrPyObject plugin_name_string(PyUnicode_FromString(plugin_name.c_str()));
type = SWIG_TypeQuery("libdnf5::ConfigParser *");
UniquePtrPyObject config_parser(
SWIG_NewPointerObj(new libdnf5::ConfigParser(std::move(*plugin_config)), type, SWIG_POINTER_OWN));
if (!config_parser) {
fetch_python_error_to_exception(
"SWIG_NewPointerObj(new libdnf5::ConfigParser(std::move(*plugin_config)), type, SWIG_POINTER_OWN)");
}
PyObject_CallMethodObjArgs(
locked_base.get(),
add_plugin_string.get(),
plugin_name_string.get(),
config_parser.get(),
plugin_instance,
NULL);
}
void PythonPluginLoader::load_plugins_from_dirs(
const std::vector<fs::path> & config_dirs, const fs::path & plugins_dir) {
auto & base = get_base();
auto & logger = *base.get_logger();
if (config_dirs.empty()) {
throw std::runtime_error("PythonPluginLoader::load_plugins_from_dir() config_dirs cannot be empty");
}
const auto config_paths = utils::fs::create_sorted_file_list(config_dirs, ".conf");
std::string error_msgs;
for (const auto & config_file_path : config_paths) {
auto [plugin_name, plugin_config, is_enabled] = base.load_plugin_config(config_file_path);
fs::path plugin_path = plugins_dir / (plugin_name + ".py");
std::error_code ec;
if (is_enabled && (fs::is_regular_file(plugin_path, ec) || fs::is_symlink(plugin_path, ec))) {
try {
load_plugin_file(plugin_name, &plugin_config, plugin_path);
} catch (const std::exception & ex) {
std::string msg = fmt::format("Cannot load plugin \"{}\": {}", plugin_path.string(), ex.what());
logger.error(msg);
error_msgs += msg + '\n';
}
}
if (ec) {
logger.warning(
"PythonPluginLoader: Cannot read plugins directory \"{}\": {}", plugins_dir.string(), ec.message());
continue;
}
}
if (!error_msgs.empty()) {
throw std::runtime_error(error_msgs);
}
}
void PythonPluginLoader::load_plugins() {
const char * plugins_dir = std::getenv("LIBDNF_PYTHON_PLUGIN_DIR");
if (!plugins_dir) {
return;
}
const fs::path python_plugins_dir(plugins_dir);
std::lock_guard<libdnf5::Base> guard(get_base());
if (python_ref_counter == 0) {
Py_InitializeEx(0);
if (!Py_IsInitialized()) {
return;
}
}
active = true;
++python_ref_counter;
// PyRun_SimpleString("import sys");
PyObject * sys_module = PyImport_ImportModule("sys");
if (!sys_module) {
fetch_python_error_to_exception("PyImport_ImportModule(): ");
}
// PyRun_SimpleString(("sys.path.append('" + path.string() + "')").c_str());
PyObject * sys_dict = PyModule_GetDict(sys_module);
if (!sys_dict) {
fetch_python_error_to_exception("PyModule_GetDict(sys_module): ");
}
PyObject * path_object = PyDict_GetItemString(sys_dict, "path");
if (!path_object) {
fetch_python_error_to_exception("PyDict_GetItemString(sys_dict, \"path\"): ");
}
UniquePtrPyObject append(PyObject_CallMethod(path_object, "append", "(s)", python_plugins_dir.c_str()));
if (!append) {
fetch_python_error_to_exception(
("PyDict_CallMethod(path_object, \"append\", \"(s)\", " + python_plugins_dir.string() + "): ").c_str());
}
auto python_plugins_config_dirs = plugin::get_config_dirs(get_base());
for (auto & python_plugins_config_dir : python_plugins_config_dirs) {
python_plugins_config_dir /= "python_plugins_loader.d";
}
load_plugins_from_dirs(python_plugins_config_dirs, python_plugins_dir);
}
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 PythonPluginLoader(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;
}
|