2 Bacula® - The Network Backup Solution
4 Copyright (C) 2007-2008 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 two of the GNU 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 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"
39 const char *plugin_type = "-sd.so";
42 /* Forward referenced functions */
43 static bRC baculaGetValue(bpContext *ctx, brVariable var, void *value);
44 static bRC baculaSetValue(bpContext *ctx, bwVariable var, void *value);
45 static bRC baculaRegisterEvents(bpContext *ctx, ...);
46 static bRC baculaJobMsg(bpContext *ctx, const char *file, int line,
47 int type, time_t mtime, const char *msg);
48 static bRC baculaDebugMsg(bpContext *ctx, const char *file, int line,
49 int level, const char *msg);
53 static bInfo binfo = {
55 SD_PLUGIN_INTERFACE_VERSION,
58 /* Bacula entry points */
59 static bFuncs bfuncs = {
61 SD_PLUGIN_INTERFACE_VERSION,
70 * Create a plugin event
72 void generate_plugin_event(JCR *jcr, bEventType eventType, void *value)
82 bpContext *plugin_ctx_list = (bpContext *)jcr->plugin_ctx_list;
83 event.eventType = eventType;
85 Dmsg2(dbglvl, "plugin_ctx_list=%p JobId=%d\n", jcr->plugin_ctx_list, jcr->JobId);
87 foreach_alist(plugin, plugin_list) {
89 rc = plug_func(plugin)->handlePluginEvent(&plugin_ctx_list[i++], &event, value);
98 void load_dir_plugins(const char *plugin_dir)
104 plugin_list = New(alist(10, not_owned_by_alist));
105 load_plugins((void *)&binfo, (void *)&bfuncs, plugin_dir, plugin_type);
109 * Create a new instance of each plugin for this Job
111 void new_plugins(JCR *jcr)
120 int num = plugin_list->size();
126 jcr->plugin_ctx_list = (void *)malloc(sizeof(bpContext) * num);
128 bpContext *plugin_ctx_list = (bpContext *)jcr->plugin_ctx_list;
129 Dmsg2(dbglvl, "Instantiate plugin_ctx_list=%p JobId=%d\n", jcr->plugin_ctx_list, jcr->JobId);
130 foreach_alist(plugin, plugin_list) {
131 /* Start a new instance of each plugin */
132 plugin_ctx_list[i].bContext = (void *)jcr;
133 plugin_ctx_list[i].pContext = NULL;
134 plug_func(plugin)->newPlugin(&plugin_ctx_list[i++]);
139 * Free the plugin instances for this Job
141 void free_plugins(JCR *jcr)
150 bpContext *plugin_ctx_list = (bpContext *)jcr->plugin_ctx_list;
151 Dmsg2(dbglvl, "Free instance plugin_ctx_list=%p JobId=%d\n", jcr->plugin_ctx_list, jcr->JobId);
152 foreach_alist(plugin, plugin_list) {
153 /* Free the plugin instance */
154 plug_func(plugin)->freePlugin(&plugin_ctx_list[i++]);
156 free(plugin_ctx_list);
157 jcr->plugin_ctx_list = NULL;
161 /* ==============================================================
163 * Callbacks from the plugin
165 * ==============================================================
167 static bRC baculaGetValue(bpContext *ctx, brVariable var, void *value)
169 JCR *jcr = (JCR *)(ctx->bContext);
170 // Dmsg1(dbglvl, "bacula: baculaGetValue var=%d\n", var);
174 // Dmsg1(dbglvl, "Bacula: jcr=%p\n", jcr);
177 *((int *)value) = jcr->JobId;
178 Dmsg1(dbglvl, "Bacula: return bVarJobId=%d\n", jcr->JobId);
186 static bRC baculaSetValue(bpContext *ctx, bwVariable var, void *value)
188 Dmsg1(dbglvl, "bacula: baculaSetValue var=%d\n", var);
192 static bRC baculaRegisterEvents(bpContext *ctx, ...)
198 while ((event = va_arg(args, uint32_t))) {
199 Dmsg1(dbglvl, "Plugin wants event=%u\n", event);
205 static bRC baculaJobMsg(bpContext *ctx, const char *file, int line,
206 int type, time_t mtime, const char *msg)
208 Dmsg5(dbglvl, "Job message: %s:%d type=%d time=%ld msg=%s\n",
209 file, line, type, mtime, msg);
213 static bRC baculaDebugMsg(bpContext *ctx, const char *file, int line,
214 int level, const char *msg)
216 Dmsg4(dbglvl, "Debug message: %s:%d level=%d msg=%s\n",
217 file, line, level, msg);
224 int main(int argc, char *argv[])
226 char plugin_dir[1000];
231 strcpy(my_name, "test-dir");
233 getcwd(plugin_dir, sizeof(plugin_dir)-1);
234 load_dir_plugins(plugin_dir);
242 generate_plugin_event(jcr1, bEventJobStart, (void *)"Start Job 1");
243 generate_plugin_event(jcr1, bEventJobEnd);
244 generate_plugin_event(jcr2, bEventJobStart, (void *)"Start Job 1");
246 generate_plugin_event(jcr2, bEventJobEnd);
251 Dmsg0(dbglvl, "bacula: OK ...\n");
257 #endif /* TEST_PROGRAM */