2 Bacula® - The Network Backup Solution
4 Copyright (C) 2007-2011 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version three of the GNU Affero General Public
10 License as published by the Free Software Foundation, which is
11 listed in the file LICENSE.
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU Affero General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of Kern Sibbald.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
29 * Main program to test loading and running Bacula plugins.
30 * Destined to become Bacula pluginloader, ...
32 * Kern Sibbald, October 2007
36 #include "sd_plugins.h"
38 const int dbglvl = 250;
39 const char *plugin_type = "-sd.so";
42 /* Forward referenced functions */
43 static bRC baculaGetValue(bpContext *ctx, bsdrVariable var, void *value);
44 static bRC baculaSetValue(bpContext *ctx, bsdwVariable var, void *value);
45 static bRC baculaRegisterEvents(bpContext *ctx, ...);
46 static bRC baculaJobMsg(bpContext *ctx, const char *file, int line,
47 int type, utime_t mtime, const char *fmt, ...);
48 static bRC baculaDebugMsg(bpContext *ctx, const char *file, int line,
49 int level, const char *fmt, ...);
50 static char *baculaEditDeviceCodes(DCR *dcr, char *omsg,
51 const char *imsg, const char *cmd);
52 static bool is_plugin_compatible(Plugin *plugin);
56 static bsdInfo binfo = {
58 SD_PLUGIN_INTERFACE_VERSION
61 /* Bacula entry points */
62 static bsdFuncs bfuncs = {
64 SD_PLUGIN_INTERFACE_VERSION,
74 * Bacula private context
77 JCR *jcr; /* jcr for plugin */
78 bRC rc; /* last return code */
79 bool disabled; /* set if plugin disabled */
82 static bool is_plugin_disabled(bpContext *plugin_ctx)
88 b_ctx = (bacula_ctx *)plugin_ctx->bContext;
89 return b_ctx->disabled;
93 static bool is_plugin_disabled(JCR *jcr)
95 return is_plugin_disabled(jcr->plugin_ctx);
100 * Create a plugin event
102 int generate_plugin_event(JCR *jcr, bsdEventType eventType, void *value)
104 bpContext *plugin_ctx;
111 Dmsg0(dbglvl, "No bplugin_list: generate_plugin_event ignored.\n");
115 Dmsg0(dbglvl, "No jcr: generate_plugin_event ignored.\n");
118 if (!jcr->plugin_ctx_list) {
119 Dmsg0(dbglvl, "No plugin_ctx_list: generate_plugin_event ignored.\n");
120 return bRC_OK; /* Return if no plugins loaded */
122 if (jcr->is_job_canceled()) {
123 Dmsg0(dbglvl, "Cancel return from generate_plugin_event\n");
127 bpContext *plugin_ctx_list = (bpContext *)jcr->plugin_ctx_list;
128 event.eventType = eventType;
130 Dmsg2(dbglvl, "sd-plugin_ctx_list=%p JobId=%d\n", jcr->plugin_ctx_list, jcr->JobId);
132 foreach_alist_index(i, plugin, bplugin_list) {
133 plugin_ctx = &plugin_ctx_list[i];
134 if (is_plugin_disabled(plugin_ctx)) {
137 rc = sdplug_func(plugin)->handlePluginEvent(plugin_ctx, &event, value);
147 * Print to file the plugin info.
149 void dump_sd_plugin(Plugin *plugin, FILE *fp)
154 psdInfo *info = (psdInfo *) plugin->pinfo;
155 fprintf(fp, "\tversion=%d\n", info->version);
156 fprintf(fp, "\tdate=%s\n", NPRTB(info->plugin_date));
157 fprintf(fp, "\tmagic=%s\n", NPRTB(info->plugin_magic));
158 fprintf(fp, "\tauthor=%s\n", NPRTB(info->plugin_author));
159 fprintf(fp, "\tlicence=%s\n", NPRTB(info->plugin_license));
160 fprintf(fp, "\tversion=%s\n", NPRTB(info->plugin_version));
161 fprintf(fp, "\tdescription=%s\n", NPRTB(info->plugin_description));
165 * This entry point is called internally by Bacula to ensure
166 * that the plugin IO calls come into this code.
168 void load_sd_plugins(const char *plugin_dir)
173 Dmsg0(dbglvl, "Load sd plugins\n");
175 Dmsg0(dbglvl, "No sd plugin dir!\n");
178 bplugin_list = New(alist(10, not_owned_by_alist));
179 if (!load_plugins((void *)&binfo, (void *)&bfuncs, plugin_dir, plugin_type,
180 is_plugin_compatible)) {
181 /* Either none found, or some error */
182 if (bplugin_list->size() == 0) {
185 Dmsg0(dbglvl, "No plugins loaded\n");
190 * Verify that the plugin is acceptable, and print information
193 foreach_alist_index(i, plugin, bplugin_list) {
194 Jmsg(NULL, M_INFO, 0, _("Loaded plugin: %s\n"), plugin->file);
195 Dmsg1(dbglvl, "Loaded plugin: %s\n", plugin->file);
198 Dmsg1(dbglvl, "num plugins=%d\n", bplugin_list->size());
199 dbg_plugin_add_hook(dump_sd_plugin);
203 * Check if a plugin is compatible. Called by the load_plugin function
204 * to allow us to verify the plugin.
206 static bool is_plugin_compatible(Plugin *plugin)
208 psdInfo *info = (psdInfo *)plugin->pinfo;
209 Dmsg0(50, "is_plugin_compatible called\n");
210 if (debug_level >= 50) {
211 dump_sd_plugin(plugin, stdin);
213 if (strcmp(info->plugin_magic, SD_PLUGIN_MAGIC) != 0) {
214 Jmsg(NULL, M_ERROR, 0, _("Plugin magic wrong. Plugin=%s wanted=%s got=%s\n"),
215 plugin->file, SD_PLUGIN_MAGIC, info->plugin_magic);
216 Dmsg3(50, "Plugin magic wrong. Plugin=%s wanted=%s got=%s\n",
217 plugin->file, SD_PLUGIN_MAGIC, info->plugin_magic);
221 if (info->version != SD_PLUGIN_INTERFACE_VERSION) {
222 Jmsg(NULL, M_ERROR, 0, _("Plugin version incorrect. Plugin=%s wanted=%d got=%d\n"),
223 plugin->file, SD_PLUGIN_INTERFACE_VERSION, info->version);
224 Dmsg3(50, "Plugin version incorrect. Plugin=%s wanted=%d got=%d\n",
225 plugin->file, SD_PLUGIN_INTERFACE_VERSION, info->version);
228 if (strcmp(info->plugin_license, "Bacula AGPLv3") != 0 &&
229 strcmp(info->plugin_license, "AGPLv3") != 0 &&
230 strcmp(info->plugin_license, "Bacula Systems(R) SA") != 0) {
231 Jmsg(NULL, M_ERROR, 0, _("Plugin license incompatible. Plugin=%s license=%s\n"),
232 plugin->file, info->plugin_license);
233 Dmsg2(50, "Plugin license incompatible. Plugin=%s license=%s\n",
234 plugin->file, info->plugin_license);
237 if (info->size != sizeof(psdInfo)) {
238 Jmsg(NULL, M_ERROR, 0,
239 _("Plugin size incorrect. Plugin=%s wanted=%d got=%d\n"),
240 plugin->file, sizeof(psdInfo), info->size);
249 * Create a new instance of each plugin for this Job
251 void new_plugins(JCR *jcr)
256 Dmsg0(dbglvl, "=== enter new_plugins ===\n");
258 Dmsg0(dbglvl, "No sd plugin list!\n");
261 if (jcr->is_job_canceled()) {
265 * If plugins already loaded, just return
267 if (jcr->plugin_ctx_list) {
271 int num = bplugin_list->size();
273 Dmsg1(dbglvl, "sd-plugin-list size=%d\n", num);
278 jcr->plugin_ctx_list = (bpContext *)malloc(sizeof(bpContext) * num);
280 bpContext *plugin_ctx_list = jcr->plugin_ctx_list;
281 Dmsg2(dbglvl, "Instantiate sd-plugin_ctx_list=%p JobId=%d\n", jcr->plugin_ctx_list, jcr->JobId);
282 foreach_alist_index(i, plugin, bplugin_list) {
283 /* Start a new instance of each plugin */
284 bacula_ctx *b_ctx = (bacula_ctx *)malloc(sizeof(bacula_ctx));
285 memset(b_ctx, 0, sizeof(bacula_ctx));
287 plugin_ctx_list[i].bContext = (void *)b_ctx;
288 plugin_ctx_list[i].pContext = NULL;
289 if (sdplug_func(plugin)->newPlugin(&plugin_ctx_list[i]) != bRC_OK) {
290 b_ctx->disabled = true;
296 * Free the plugin instances for this Job
298 void free_plugins(JCR *jcr)
303 if (!bplugin_list || !jcr->plugin_ctx_list) {
307 bpContext *plugin_ctx_list = (bpContext *)jcr->plugin_ctx_list;
308 Dmsg2(dbglvl, "Free instance sd-plugin_ctx_list=%p JobId=%d\n", jcr->plugin_ctx_list, jcr->JobId);
309 foreach_alist_index(i, plugin, bplugin_list) {
310 /* Free the plugin instance */
311 sdplug_func(plugin)->freePlugin(&plugin_ctx_list[i]);
312 free(plugin_ctx_list[i].bContext); /* free Bacula private context */
314 free(plugin_ctx_list);
315 jcr->plugin_ctx_list = NULL;
319 /* ==============================================================
321 * Callbacks from the plugin
323 * ==============================================================
325 static bRC baculaGetValue(bpContext *ctx, bsdrVariable var, void *value)
331 jcr = ((bacula_ctx *)ctx->bContext)->jcr;
340 *((int *)value) = jcr->JobId;
341 Dmsg1(dbglvl, "sd-plugin: return bVarJobId=%d\n", jcr->JobId);
344 *((char **)value) = jcr->Job;
345 Dmsg1(dbglvl, "Bacula: return Job name=%s\n", jcr->Job);
353 static bRC baculaSetValue(bpContext *ctx, bsdwVariable var, void *value)
356 if (!value || !ctx) {
359 // Dmsg1(dbglvl, "bacula: baculaGetValue var=%d\n", var);
360 jcr = ((bacula_ctx *)ctx->bContext)->jcr;
364 // Dmsg1(dbglvl, "Bacula: jcr=%p\n", jcr);
365 /* Nothing implemented yet */
366 Dmsg1(dbglvl, "sd-plugin: baculaSetValue var=%d\n", var);
370 static bRC baculaRegisterEvents(bpContext *ctx, ...)
376 while ((event = va_arg(args, uint32_t))) {
377 Dmsg1(dbglvl, "sd-Plugin wants event=%u\n", event);
383 static bRC baculaJobMsg(bpContext *ctx, const char *file, int line,
384 int type, utime_t mtime, const char *fmt, ...)
391 jcr = ((bacula_ctx *)ctx->bContext)->jcr;
396 va_start(arg_ptr, fmt);
397 bvsnprintf(buf, sizeof(buf), fmt, arg_ptr);
399 Jmsg(jcr, type, mtime, "%s", buf);
403 static bRC baculaDebugMsg(bpContext *ctx, const char *file, int line,
404 int level, const char *fmt, ...)
409 va_start(arg_ptr, fmt);
410 bvsnprintf(buf, sizeof(buf), fmt, arg_ptr);
412 d_msg(file, line, level, "%s", buf);
416 static char *baculaEditDeviceCodes(DCR *dcr, char *omsg,
417 const char *imsg, const char *cmd)
419 return edit_device_codes(dcr, omsg, imsg, cmd);
424 int main(int argc, char *argv[])
426 char plugin_dir[1000];
431 strcpy(my_name, "test-dir");
433 getcwd(plugin_dir, sizeof(plugin_dir)-1);
434 load_sd_plugins(plugin_dir);
442 generate_plugin_event(jcr1, bsdEventJobStart, (void *)"Start Job 1");
443 generate_plugin_event(jcr1, bsdEventJobEnd);
444 generate_plugin_event(jcr2, bsdEventJobStart, (void *)"Start Job 1");
446 generate_plugin_event(jcr2, bsdEventJobEnd);
451 Dmsg0(dbglvl, "sd-plugin: OK ...\n");
457 #endif /* TEST_PROGRAM */