-
Notifications
You must be signed in to change notification settings - Fork 256
/
python-fd.cc
913 lines (758 loc) · 28.3 KB
/
python-fd.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
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
/*
BAREOS® - Backup Archiving REcovery Open Sourced
Copyright (C) 2011-2015 Planets Communications B.V.
Copyright (C) 2013-2023 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 File 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 "fd"
#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 "filed/fd_plugins.h"
#include "include/filetypes.h"
#include "python-fd.h"
#include "module/bareosfd.h"
#include "lib/edit.h"
namespace filedaemon {
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 File Daemon Plugin"
#define PLUGIN_USAGE \
PLUGIN_NAME \
":module_name=<python-module-to-load>:module_path=<path-to-python-modules>:" \
"...\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" \
" 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,
bEvent* event,
void* value);
static bRC startBackupFile(PluginContext* plugin_ctx, save_pkt* sp);
static bRC endBackupFile(PluginContext* plugin_ctx);
static bRC pluginIO(PluginContext* plugin_ctx, io_pkt* io);
static bRC startRestoreFile(PluginContext* plugin_ctx, const char* cmd);
static bRC endRestoreFile(PluginContext* plugin_ctx);
static bRC createFile(PluginContext* plugin_ctx, restore_pkt* rp);
static bRC setFileAttributes(PluginContext* plugin_ctx, restore_pkt* rp);
static bRC checkFile(PluginContext* plugin_ctx, char* fname);
static bRC getAcl(PluginContext* plugin_ctx, acl_pkt* ap);
static bRC setAcl(PluginContext* plugin_ctx, acl_pkt* ap);
static bRC getXattr(PluginContext* plugin_ctx, xattr_pkt* xp);
static bRC setXattr(PluginContext* plugin_ctx, xattr_pkt* xp);
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), FD_PLUGIN_INTERFACE_VERSION,
FD_PLUGIN_MAGIC, PLUGIN_LICENSE,
PLUGIN_AUTHOR, PLUGIN_DATE,
PLUGIN_VERSION, PLUGIN_DESCRIPTION,
PLUGIN_USAGE};
static PluginFunctions pluginFuncs
= {sizeof(pluginFuncs), FD_PLUGIN_INTERFACE_VERSION,
/* Entry points into plugin */
newPlugin, /* new plugin instance */
freePlugin, /* free plugin instance */
getPluginValue, setPluginValue, handlePluginEvent, startBackupFile,
endBackupFile, startRestoreFile, endRestoreFile, pluginIO, createFile,
setFileAttributes, checkFile, getAcl, setAcl, getXattr, setXattr};
#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"
#ifdef __cplusplus
extern "C" {
#endif
// Plugin called here when it is first loaded
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 bareosfd module */
PyObject* bareosfdModule = PyImport_ImportModule("bareosfd");
if (!bareosfdModule) {
printf("loading of bareosfd extension module failed\n");
if (PyErr_Occurred()) { PyErrorHandler(); }
}
/* import the CAPI from the bareosfd python module
* afterwards, Bareosfd_* macros are initialized to
* point to the corresponding functions in the bareosfd python
* module */
import_bareosfd();
/* set bareos_core_functions inside of barosfd module */
Bareosfd_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;
}
/**
* Plugin called here when it is unloaded, normally when Bareos is going to
* exit.
*/
bRC unloadPlugin()
{
/* Terminate Python if it was initialized correctly */
if (mainThreadState) {
PyEval_RestoreThread(mainThreadState);
Py_Finalize();
mainThreadState = nullptr;
}
return bRC_OK;
}
#ifdef __cplusplus
}
#endif
/**
* Called here to make a new instance of the plugin -- i.e. when
* a new Job is started. There can be multiple instances of
* each plugin that are running at the same time. Your
* plugin instance must be thread safe and keep its own
* local data.
*/
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_plugin_context inside of bareosfd module */
Bareosfd_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, 9, bEventLevel, bEventSince, bEventNewPluginOptions,
bEventPluginCommand, bEventJobStart, bEventRestoreCommand,
bEventEstimateCommand, bEventBackupCommand, bEventRestoreObject);
return bRC_OK;
}
/**
* Release everything concerning a particular instance of a
* plugin. Normally called when the Job terminates.
*/
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; }
if (plugin_priv_ctx->plugin_options) {
free(plugin_priv_ctx->plugin_options);
}
if (plugin_priv_ctx->module_path) { free(plugin_priv_ctx->module_path); }
if (plugin_priv_ctx->module_name) { free(plugin_priv_ctx->module_name); }
if (plugin_priv_ctx->fname) { free(plugin_priv_ctx->fname); }
if (plugin_priv_ctx->link) { free(plugin_priv_ctx->link); }
if (plugin_priv_ctx->object_name) { free(plugin_priv_ctx->object_name); }
if (plugin_priv_ctx->object) { free(plugin_priv_ctx->object); }
// 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,
bEvent* 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; }
/* First handle some events internally before calling python if it
* want to do some special handling on the event triggered. */
switch (event->eventType) {
case bEventLevel:
plugin_priv_ctx->backup_level = (int64_t)value;
break;
case bEventSince:
plugin_priv_ctx->since = (int64_t)value;
break;
case bEventBackupCommand:
/* Fall-through wanted */
case bEventRestoreCommand:
/* Fall-through wanted */
case bEventEstimateCommand:
/* Fall-through wanted */
case bEventPluginCommand:
event_dispatched = true;
retval = parse_plugin_definition(plugin_ctx, value, plugin_options);
break;
case bEventNewPluginOptions:
/* Free any previous value. */
if (plugin_priv_ctx->plugin_options) {
free(plugin_priv_ctx->plugin_options);
plugin_priv_ctx->plugin_options = NULL;
}
event_dispatched = true;
retval = parse_plugin_definition(plugin_ctx, value, plugin_options);
/* Save that we got a plugin override. */
plugin_priv_ctx->plugin_options = strdup((char*)value);
break;
case bEventRestoreObject: {
restore_object_pkt* rop;
rop = (restore_object_pkt*)value;
/* Only use the plugin definition of a restore object if we
* didn't get any other plugin definition from some other source before.*/
if (!plugin_priv_ctx->python_loaded) {
if (rop && *rop->plugin_name) {
event_dispatched = true;
retval = parse_plugin_definition(plugin_ctx, rop->plugin_name,
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 bEventBackupCommand:
/* Fall-through wanted */
case bEventRestoreCommand:
/* Fall-through wanted */
case bEventEstimateCommand:
/* Fall-through wanted */
case bEventPluginCommand:
/* Fall-through wanted */
case bEventNewPluginOptions:
/* 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 = Bareosfd_PyParsePluginDefinition(plugin_ctx,
plugin_options.c_str());
}
break;
case bEventRestoreObject: {
restore_object_pkt* rop;
rop = (restore_object_pkt*)value;
if (!rop) {
/* If rop == NULL this means we got the last restore object.
* No need to call into python so just return. */
retval = bRC_OK;
} else {
/* See if we already loaded the Python modules. */
if (!plugin_priv_ctx->python_loaded && *rop->plugin_name) {
retval = PyLoadModule(plugin_ctx, plugin_options.c_str());
/* Only try to call when the loading succeeded. */
if (retval == bRC_OK) {
retval = Bareosfd_PyParsePluginDefinition(plugin_ctx,
plugin_options.c_str());
if (retval == bRC_OK) {
retval = Bareosfd_PyRestoreObjectData(plugin_ctx, rop);
}
}
} else {
retval = Bareosfd_PyRestoreObjectData(plugin_ctx, rop);
}
}
break;
}
case bEventHandleBackupFile:
retval = Bareosfd_PyHandleBackupFile(plugin_ctx, (save_pkt*)value);
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 = Bareosfd_PyHandlePluginEvent(plugin_ctx, event, value);
} else {
retval = bRC_OK;
}
break;
}
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
}
bail_out:
return retval;
}
/**
* Called when starting to backup a file. Here the plugin must
* return the "stat" packet for the directory/file and provide
* certain information so that Bareos knows what the file is.
* The plugin can create "Virtual" files by giving them a
* name that is not normally found on the file system.
*/
static bRC startBackupFile(PluginContext* plugin_ctx, save_pkt* sp)
{
bRC retval = bRC_Error;
struct plugin_private_context* plugin_priv_ctx
= (struct plugin_private_context*)plugin_ctx->plugin_private_context;
if (!plugin_priv_ctx) { goto bail_out; }
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
retval = Bareosfd_PyStartBackupFile(plugin_ctx, sp);
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
/* For Incremental and Differential backups use checkChanges method to
* see if we need to backup this file. */
switch (plugin_priv_ctx->backup_level) {
case L_INCREMENTAL:
case L_DIFFERENTIAL:
/* If the plugin didn't set a save_time but we have a since time
* from the bEventSince event we use that as basis for the actual
* save_time to check. */
if (sp->save_time == 0 && plugin_priv_ctx->since) {
sp->save_time = plugin_priv_ctx->since;
}
switch (bareos_core_functions->checkChanges(plugin_ctx, sp)) {
case bRC_Seen:
switch (sp->type) {
case FT_DIRBEGIN:
sp->type = FT_DIRNOCHG;
break;
default:
sp->type = FT_NOCHG;
break;
}
break;
default:
break;
}
}
bail_out:
return retval;
}
// Done backing up a file.
static bRC endBackupFile(PluginContext* plugin_ctx)
{
bRC retval = bRC_Error;
struct plugin_private_context* plugin_priv_ctx
= (struct plugin_private_context*)plugin_ctx->plugin_private_context;
if (!plugin_priv_ctx) { goto bail_out; }
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
retval = Bareosfd_PyEndBackupFile(plugin_ctx);
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
bail_out:
return retval;
}
/**
* Do actual I/O. Bareos calls this after startBackupFile
* or after startRestoreFile to do the actual file
* input or output.
*/
static bRC pluginIO(PluginContext* plugin_ctx, io_pkt* io)
{
bRC retval = bRC_Error;
struct plugin_private_context* plugin_priv_ctx
= (struct plugin_private_context*)plugin_ctx->plugin_private_context;
if (!plugin_priv_ctx) { goto bail_out; }
if (!plugin_priv_ctx->python_loaded) { goto bail_out; }
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
retval = Bareosfd_PyPluginIO(plugin_ctx, io);
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
bail_out:
return retval;
}
// Start restore of a file.
static bRC startRestoreFile(PluginContext* plugin_ctx, const char* cmd)
{
bRC retval = bRC_Error;
struct plugin_private_context* plugin_priv_ctx
= (struct plugin_private_context*)plugin_ctx->plugin_private_context;
if (!plugin_priv_ctx) { goto bail_out; }
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
retval = Bareosfd_PyStartRestoreFile(plugin_ctx, cmd);
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
bail_out:
return retval;
}
// Done restoring a file.
static bRC endRestoreFile(PluginContext* plugin_ctx)
{
bRC retval = bRC_Error;
struct plugin_private_context* plugin_priv_ctx
= (struct plugin_private_context*)plugin_ctx->plugin_private_context;
if (!plugin_priv_ctx) { goto bail_out; }
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
retval = Bareosfd_PyEndRestoreFile(plugin_ctx);
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
bail_out:
return retval;
}
/**
* Called here to give the plugin the information needed to
* re-create the file on a restore. It basically gets the
* stat packet that was created during the backup phase.
* This data is what is needed to create the file, but does
* not contain actual file data.
*/
static bRC createFile(PluginContext* plugin_ctx, restore_pkt* rp)
{
bRC retval = bRC_Error;
struct plugin_private_context* plugin_priv_ctx
= (struct plugin_private_context*)plugin_ctx->plugin_private_context;
if (!plugin_priv_ctx) { goto bail_out; }
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
retval = Bareosfd_PyCreateFile(plugin_ctx, rp);
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
bail_out:
return retval;
}
/**
* Called after the file has been restored. This can be used to
* set directory permissions, ...
*/
static bRC setFileAttributes(PluginContext* plugin_ctx, restore_pkt* rp)
{
bRC retval = bRC_Error;
struct plugin_private_context* plugin_priv_ctx
= (struct plugin_private_context*)plugin_ctx->plugin_private_context;
if (!plugin_priv_ctx) { goto bail_out; }
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
retval = Bareosfd_PySetFileAttributes(plugin_ctx, rp);
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
bail_out:
return retval;
}
// When using Incremental dump, all previous dumps are necessary
static bRC checkFile(PluginContext* plugin_ctx, char* fname)
{
bRC retval = bRC_Error;
struct plugin_private_context* plugin_priv_ctx
= (struct plugin_private_context*)plugin_ctx->plugin_private_context;
if (!plugin_priv_ctx) { goto bail_out; }
if (!plugin_priv_ctx->python_loaded) { return bRC_OK; }
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
retval = Bareosfd_PyCheckFile(plugin_ctx, fname);
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
bail_out:
return retval;
}
/**
*/
static bRC getAcl(PluginContext* plugin_ctx, acl_pkt* ap)
{
bRC retval = bRC_Error;
struct plugin_private_context* plugin_priv_ctx
= (struct plugin_private_context*)plugin_ctx->plugin_private_context;
if (!plugin_priv_ctx) { goto bail_out; }
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
retval = Bareosfd_PyGetAcl(plugin_ctx, ap);
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
bail_out:
return retval;
}
/**
*/
static bRC setAcl(PluginContext* plugin_ctx, acl_pkt* ap)
{
bRC retval = bRC_Error;
struct plugin_private_context* plugin_priv_ctx
= (struct plugin_private_context*)plugin_ctx->plugin_private_context;
if (!plugin_priv_ctx) { goto bail_out; }
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
retval = Bareosfd_PySetAcl(plugin_ctx, ap);
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
bail_out:
return retval;
}
/**
*/
static bRC getXattr(PluginContext* plugin_ctx, xattr_pkt* xp)
{
bRC retval = bRC_Error;
struct plugin_private_context* plugin_priv_ctx
= (struct plugin_private_context*)plugin_ctx->plugin_private_context;
if (!plugin_priv_ctx) { goto bail_out; }
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
retval = Bareosfd_PyGetXattr(plugin_ctx, xp);
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
bail_out:
return retval;
}
/**
*/
static bRC setXattr(PluginContext* plugin_ctx, xattr_pkt* xp)
{
bRC retval = bRC_Error;
struct plugin_private_context* plugin_priv_ctx
= (struct plugin_private_context*)plugin_ctx->plugin_private_context;
if (!plugin_priv_ctx) { goto bail_out; }
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
retval = Bareosfd_PySetXattr(plugin_ctx, xp);
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
bail_out:
return retval;
}
// Only set destination to value when it has no previous setting.
static inline void SetStringIfNull(char** destination, char* value)
{
if (!*destination) {
*destination = strdup(value);
StripBackSlashes(*destination);
}
}
/**
* 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;
bool keep_existing;
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; }
/* Skip this plugin when getting plugin definition "*all*"
* This allows to restore a Windows Backup on a Linux FD with
* Python Plugins enabled. */
if (bstrcmp((char*)value, "*all*")) {
Dmsg(plugin_ctx, debuglevel,
LOGPREFIX "Got plugin definition %s, skipping to ignore\n",
(char*)value);
return bRC_Skip;
}
keep_existing = (plugin_priv_ctx->plugin_options) ? true : false;
/* Parse the plugin definition.
* Make a private copy of the whole string. */
if (!plugin_priv_ctx->python_loaded && plugin_priv_ctx->plugin_options) {
int len;
/* We got some option string which got pushed before we actual were able to
* send it to the python module as the entry point was not instantiated. So
* we prepend that now in the option string and append the new option string
* with the first argument being the pluginname removed as that is already
* part of the other plugin option string. */
len = strlen(plugin_priv_ctx->plugin_options);
PmStrcpy(plugin_definition, plugin_priv_ctx->plugin_options);
bp = strchr((char*)value, ':');
if (!bp) {
Jmsg(plugin_ctx, M_FATAL, LOGPREFIX "Illegal plugin definition %s\n",
(char*)value);
Dmsg(plugin_ctx, debuglevel, LOGPREFIX "Illegal plugin definition %s\n",
(char*)value);
goto bail_out;
}
// See if option string end with ':'
if (plugin_priv_ctx->plugin_options[len - 1] != ':') {
PmStrcat(plugin_definition, (char*)bp);
} else {
PmStrcat(plugin_definition, (char*)bp + 1);
}
} else {
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)) {
char** str_destination = NULL;
bool* bool_destination = NULL;
switch (plugin_arguments[i].type) {
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;
}
// Keep the first value, ignore any next setting.
if (str_destination) {
if (keep_existing) {
SetStringIfNull(str_destination, argument_value);
} else {
SetString(str_destination, argument_value);
}
}
// Set any boolean variable.
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;
}
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; }
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
retval = Bareosfd_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; }
PyEval_AcquireThread(plugin_priv_ctx->interpreter);
retval = Bareosfd_PySetPluginValue(bareos_plugin_ctx, var, value);
PyEval_ReleaseThread(plugin_priv_ctx->interpreter);
return retval;
}
} /* namespace filedaemon */