-
Notifications
You must be signed in to change notification settings - Fork 256
/
python-dir.cc
505 lines (420 loc) · 15.5 KB
/
python-dir.cc
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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
/*
BAREOS® - Backup Archiving REcovery Open Sourced
Copyright (C) 2011-2014 Planets Communications B.V.
Copyright (C) 2013-2021 Bareos GmbH & Co. KG
This program is Free Software; you can redistribute it and/or
modify it under the terms of version three of the GNU Affero General Public
License as published by the Free Software Foundation, which is
listed in the file LICENSE.
This program 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
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
/**
* @file
* Python plugin for the Bareos Director Daemon
*/
#define PY_SSIZE_T_CLEAN
#define BUILD_PLUGIN
#if defined(HAVE_WIN32)
# include "include/bareos.h"
# include <Python.h>
#else
# include <Python.h>
# include "include/bareos.h"
#endif
#include "include/version_hex.h"
#define PLUGIN_DAEMON "dir"
#if PY_VERSION_HEX < VERSION_HEX(3, 0, 0)
# define PLUGIN_NAME "python"
# define PLUGIN_DIR PY2MODDIR
#else
# define PLUGIN_NAME "python3"
# define PLUGIN_DIR PY3MODDIR
#endif
#define LOGPREFIX PLUGIN_NAME "-" PLUGIN_DAEMON ": "
#include "dird/dird.h"
#include "plugins/include/python3compat.h"
#include "python-dir.h"
#include "module/bareosdir.h"
#include "lib/plugins.h"
#include "lib/edit.h"
namespace directordaemon {
static const int debuglevel = 150;
#define PLUGIN_LICENSE "Bareos AGPLv3"
#define PLUGIN_AUTHOR "Bareos GmbH & Co. KG"
#define PLUGIN_DATE "May 2020"
#define PLUGIN_VERSION "4"
#define PLUGIN_DESCRIPTION "Python Director Daemon Plugin"
#define PLUGIN_USAGE \
PLUGIN_NAME \
":module_name=<python-module-to-load>:module_path=<path-to-python-modules>:" \
"instance=<instance_id>:...\n" \
"\n" \
" module_name: The name of the Python module.\n" \
" module_path: Python search path for the module.\n" \
" The path '" PYTHON_MODULE_PATH \
"' is always checked for modules.\n" \
" instance: Default is ’0’.\n" \
" Increment the number, when using more than one plugin.\n" \
" Additional parameters are plugin specific."
/* Forward referenced functions */
static bRC newPlugin(PluginContext* plugin_ctx);
static bRC freePlugin(PluginContext* plugin_ctx);
static bRC getPluginValue(PluginContext* plugin_ctx,
pVariable var,
void* value);
static bRC setPluginValue(PluginContext* plugin_ctx,
pVariable var,
void* value);
static bRC handlePluginEvent(PluginContext* plugin_ctx,
bDirEvent* event,
void* value);
static bRC parse_plugin_definition(PluginContext* plugin_ctx,
void* value,
PoolMem& plugin_options);
/* Pointers to Bareos functions */
static CoreFunctions* bareos_core_functions = NULL;
static PluginApiDefinition* bareos_plugin_interface_version = NULL;
static PluginInformation pluginInfo
= {sizeof(pluginInfo), DIR_PLUGIN_INTERFACE_VERSION,
DIR_PLUGIN_MAGIC, PLUGIN_LICENSE,
PLUGIN_AUTHOR, PLUGIN_DATE,
PLUGIN_VERSION, PLUGIN_DESCRIPTION,
PLUGIN_USAGE};
static PluginFunctions pluginFuncs
= {sizeof(pluginFuncs), DIR_PLUGIN_INTERFACE_VERSION,
/* Entry points into plugin */
newPlugin, /* new plugin instance */
freePlugin, /* free plugin instance */
getPluginValue, setPluginValue, handlePluginEvent};
#include "plugin_private_context.h"
/**
* We don't actually use this but we need it to tear down the
* final python interpreter on unload of the plugin. Each instance of
* the plugin get its own interpreter.
*/
static PyThreadState* mainThreadState{nullptr};
/* functions common to all plugins */
#include "plugins/include/python_plugins_common.inc"
#include "plugins/include/python_plugin_modules_common.inc"
/* Common functions used in all python plugins. */
static bRC getPluginValue(PluginContext* bareos_plugin_ctx,
pVariable var,
void* value)
{
struct plugin_private_context* plugin_priv_ctx
= (struct plugin_private_context*)
bareos_plugin_ctx->plugin_private_context;
bRC retval = bRC_Error;
if (!plugin_priv_ctx) { goto bail_out; }
Bareosdir_set_plugin_context(bareos_plugin_ctx);
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
retval = Bareosdir_PyGetPluginValue(bareos_plugin_ctx, var, value);
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
bail_out:
return retval;
}
static bRC setPluginValue(PluginContext* bareos_plugin_ctx,
pVariable var,
void* value)
{
struct plugin_private_context* plugin_priv_ctx
= (struct plugin_private_context*)
bareos_plugin_ctx->plugin_private_context;
bRC retval = bRC_Error;
if (!plugin_priv_ctx) { return bRC_Error; }
Bareosdir_set_plugin_context(bareos_plugin_ctx);
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
retval = Bareosdir_PySetPluginValue(bareos_plugin_ctx, var, value);
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
return retval;
}
#ifdef __cplusplus
extern "C" {
#endif
/**
* loadPlugin() and unloadPlugin() are entry points that are
* exported, so Bareos can directly call these two entry points
* they are common to all Bareos plugins.
*
* External entry point called by Bareos to "load" the plugin
*/
bRC loadPlugin(PluginApiDefinition* lbareos_plugin_interface_version,
CoreFunctions* lbareos_core_functions,
PluginInformation** plugin_information,
PluginFunctions** plugin_functions)
{
if (Py_IsInitialized()) { return bRC_Error; }
Py_InitializeEx(0);
// add bareos plugin path to python module search path
PyObject* sysPath = PySys_GetObject((char*)"path");
PyObject* pluginPath = PyUnicode_FromString(PLUGIN_DIR);
PyList_Append(sysPath, pluginPath);
Py_DECREF(pluginPath);
/* import the bareosdir module */
PyObject* bareosdirModule = PyImport_ImportModule("bareosdir");
if (!bareosdirModule) {
printf("loading of bareosdir extension module failed\n");
if (PyErr_Occurred()) { PyErrorHandler(); }
}
/* import the CAPI from the bareosdir python module
* afterwards, Bareosdir_* macros are initialized to
* point to the corresponding functions in the bareosdir python
* module */
import_bareosdir();
/* set bareos_core_functions inside of barosdir module */
Bareosdir_set_bareos_core_functions(lbareos_core_functions);
bareos_core_functions
= lbareos_core_functions; /* Set Bareos funct pointers */
bareos_plugin_interface_version = lbareos_plugin_interface_version;
*plugin_information = &pluginInfo; /* Return pointer to our info */
*plugin_functions = &pluginFuncs; /* Return pointer to our functions */
#if PY_VERSION_HEX < VERSION_HEX(3, 7, 0)
PyEval_InitThreads();
#endif
mainThreadState = PyEval_SaveThread();
return bRC_OK;
}
// External entry point to unload the plugin
bRC unloadPlugin()
{
/* Terminate Python if it was initialized correctly */
if (mainThreadState) {
PyEval_RestoreThread(mainThreadState);
Py_Finalize();
mainThreadState = nullptr;
}
return bRC_OK;
}
#ifdef __cplusplus
}
#endif
/* Create a new instance of the plugin i.e. allocate our private storage */
static bRC newPlugin(PluginContext* plugin_ctx)
{
struct plugin_private_context* plugin_priv_ctx
= (struct plugin_private_context*)malloc(
sizeof(struct plugin_private_context));
if (!plugin_priv_ctx) { return bRC_Error; }
memset(plugin_priv_ctx, 0, sizeof(struct plugin_private_context));
plugin_ctx->plugin_private_context
= (void*)plugin_priv_ctx; /* set our context pointer */
/* set bareos_core_functions inside of barosdir module */
Bareosdir_set_plugin_context(plugin_ctx);
/* For each plugin instance we instantiate a new Python interpreter. */
PyEval_AcquireThread(mainThreadState);
plugin_priv_ctx->interpreter = Py_NewInterpreter();
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
/* Always register some events the python plugin itself can register
any other events it is interested in. */
bareos_core_functions->registerBareosEvents(plugin_ctx, 1,
bDirEventNewPluginOptions);
return bRC_OK;
}
/* Free a plugin instance, i.e. release our private storage */
static bRC freePlugin(PluginContext* plugin_ctx)
{
struct plugin_private_context* plugin_priv_ctx
= (struct plugin_private_context*)plugin_ctx->plugin_private_context;
if (!plugin_priv_ctx) { return bRC_Error; }
// Stop any sub interpreter started per plugin instance.
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
if (plugin_priv_ctx->pModule) { Py_DECREF(plugin_priv_ctx->pModule); }
Py_EndInterpreter(plugin_priv_ctx->interpreter);
#if PY_VERSION_HEX < VERSION_HEX(3, 2, 0)
PyEval_ReleaseLock();
#else
PyThreadState_Swap(mainThreadState);
PyEval_ReleaseThread(mainThreadState);
#endif
free(plugin_priv_ctx);
plugin_ctx->plugin_private_context = NULL;
return bRC_OK;
}
static bRC handlePluginEvent(PluginContext* plugin_ctx,
bDirEvent* event,
void* value)
{
bRC retval = bRC_Error;
bool event_dispatched = false;
PoolMem plugin_options(PM_FNAME);
plugin_private_context* plugin_priv_ctx
= (plugin_private_context*)plugin_ctx->plugin_private_context;
if (!plugin_priv_ctx) { goto bail_out; }
Bareosdir_set_plugin_context(plugin_ctx);
/*
* First handle some events internally before calling python if it
* want to do some special handling on the event triggered.
*/
switch (event->eventType) {
case bDirEventNewPluginOptions:
event_dispatched = true;
retval = parse_plugin_definition(plugin_ctx, value, plugin_options);
break;
default:
break;
}
/*
* See if we have been triggered in the previous switch if not we have to
* always dispatch the event. If we already processed the event internally
* we only do a dispatch to the python entry point when that internal
* processing was successful (e.g. retval == bRC_OK).
*/
if (!event_dispatched || retval == bRC_OK) {
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
/*
* Now dispatch the event to Python.
* First the calls that need special handling.
*/
switch (event->eventType) {
case bDirEventNewPluginOptions:
// See if we already loaded the Python modules.
if (!plugin_priv_ctx->python_loaded) {
retval = PyLoadModule(plugin_ctx, plugin_options.c_str());
}
/* Only try to call when the loading succeeded. */
if (retval == bRC_OK) {
retval = Bareosdir_PyParsePluginDefinition(plugin_ctx,
plugin_options.c_str());
}
break;
default:
/*
* Handle the generic events e.g. the ones which are just passed on.
* We only try to call Python when we loaded the right module until
* that time we pretend the call succeeded.
*/
if (plugin_priv_ctx->python_loaded) {
retval = Bareosdir_PyHandlePluginEvent(plugin_ctx, event, value);
} else {
retval = bRC_OK;
}
break;
}
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
}
bail_out:
return retval;
}
/**
* Parse the plugin definition passed in.
*
* The definition is in this form:
*
* python:module_path=<path>:module_name=<python_module_name>:...
*/
static bRC parse_plugin_definition(PluginContext* plugin_ctx,
void* value,
PoolMem& plugin_options)
{
bool found;
int i, cnt;
PoolMem plugin_definition(PM_FNAME);
char *bp, *argument, *argument_value;
plugin_private_context* plugin_priv_ctx
= (plugin_private_context*)plugin_ctx->plugin_private_context;
if (!value) { return bRC_Error; }
/*
* Parse the plugin definition.
* Make a private copy of the whole string.
*/
PmStrcpy(plugin_definition, (char*)value);
bp = strchr(plugin_definition.c_str(), ':');
if (!bp) {
Jmsg(plugin_ctx, M_FATAL, LOGPREFIX "Illegal plugin definition %s\n",
plugin_definition.c_str());
Dmsg(plugin_ctx, debuglevel, LOGPREFIX "Illegal plugin definition %s\n",
plugin_definition.c_str());
goto bail_out;
}
// Skip the first ':'
bp++;
cnt = 0;
while (bp) {
if (strlen(bp) == 0) { break; }
/*
* Each argument is in the form:
* <argument> = <argument_value>
*
* So we setup the right pointers here, argument to the beginning
* of the argument, argument_value to the beginning of the argument_value.
*/
argument = bp;
argument_value = strchr(bp, '=');
if (!argument_value) {
Jmsg(plugin_ctx, M_FATAL, LOGPREFIX "Illegal argument %s without value\n",
argument);
Dmsg(plugin_ctx, debuglevel,
LOGPREFIX "Illegal argument %s without value\n", argument);
goto bail_out;
}
*argument_value++ = '\0';
// See if there are more arguments and setup for the next run.
bp = argument_value;
do {
bp = strchr(bp, ':');
if (bp) {
if (*(bp - 1) != '\\') {
*bp++ = '\0';
break;
} else {
bp++;
}
}
} while (bp);
found = false;
for (i = 0; plugin_arguments[i].name; i++) {
if (Bstrcasecmp(argument, plugin_arguments[i].name)) {
int64_t* int_destination = NULL;
char** str_destination = NULL;
bool* bool_destination = NULL;
switch (plugin_arguments[i].type) {
case argument_instance:
int_destination = &plugin_priv_ctx->instance;
break;
case argument_module_path:
str_destination = &plugin_priv_ctx->module_path;
break;
case argument_module_name:
str_destination = &plugin_priv_ctx->module_name;
break;
default:
break;
}
if (int_destination) {
*int_destination = parse_integer(argument_value);
}
if (str_destination) { SetString(str_destination, argument_value); }
if (bool_destination) {
*bool_destination = ParseBoolean(argument_value);
}
// When we have a match break the loop.
found = true;
break;
}
}
// If we didn't consume this parameter we add it to the plugin_options list.
if (!found) {
PoolMem option(PM_FNAME);
if (cnt) {
Mmsg(option, ":%s=%s", argument, argument_value);
PmStrcat(plugin_options, option.c_str());
} else {
Mmsg(option, "%s=%s", argument, argument_value);
PmStrcat(plugin_options, option.c_str());
}
cnt++;
}
}
if (cnt > 0) { PmStrcat(plugin_options, ":"); }
return bRC_OK;
bail_out:
return bRC_Error;
}
} /* namespace directordaemon */