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 John Walker.
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
38 const char *plugin_type = "-dir.so";
41 /* Forward referenced functions */
42 static bRC baculaGetValue(bpContext *ctx, brVariable var, void *value);
43 static bRC baculaSetValue(bpContext *ctx, bwVariable var, void *value);
44 static bRC baculaRegisterEvents(bpContext *ctx, ...);
45 static bRC baculaJobMsg(bpContext *ctx, const char *file, int line,
46 int type, time_t mtime, const char *msg);
47 static bRC baculaDebugMsg(bpContext *ctx, const char *file, int line,
48 int level, const char *msg);
52 static bInfo binfo = {
54 DIR_PLUGIN_INTERFACE_VERSION,
57 /* Bacula entry points */
58 static bFuncs bfuncs = {
60 DIR_PLUGIN_INTERFACE_VERSION,
69 * Create a plugin event
71 void generate_plugin_event(JCR *jcr, bEventType eventType, void *value)
81 bpContext *plugin_ctx_list = (bpContext *)jcr->plugin_ctx_list;
82 event.eventType = eventType;
84 Dmsg2(dbglvl, "plugin_ctx_list=%p JobId=%d\n", jcr->plugin_ctx_list, jcr->JobId);
86 foreach_alist(plugin, plugin_list) {
88 rc = plug_func(plugin)->handlePluginEvent(&plugin_ctx_list[i++], &event, value);
97 void load_dir_plugins(const char *plugin_dir)
103 plugin_list = New(alist(10, not_owned_by_alist));
104 load_plugins((void *)&binfo, (void *)&bfuncs, plugin_dir, plugin_type);
108 * Create a new instance of each plugin for this Job
110 void new_plugins(JCR *jcr)
119 int num = plugin_list->size();
125 jcr->plugin_ctx_list = (void *)malloc(sizeof(bpContext) * num);
127 bpContext *plugin_ctx_list = (bpContext *)jcr->plugin_ctx_list;
128 Dmsg2(dbglvl, "Instantiate plugin_ctx_list=%p JobId=%d\n", jcr->plugin_ctx_list, jcr->JobId);
129 foreach_alist(plugin, plugin_list) {
130 /* Start a new instance of each plugin */
131 plugin_ctx_list[i].bContext = (void *)jcr;
132 plugin_ctx_list[i].pContext = NULL;
133 plug_func(plugin)->newPlugin(&plugin_ctx_list[i++]);
138 * Free the plugin instances for this Job
140 void free_plugins(JCR *jcr)
149 bpContext *plugin_ctx_list = (bpContext *)jcr->plugin_ctx_list;
150 Dmsg2(dbglvl, "Free instance plugin_ctx_list=%p JobId=%d\n", jcr->plugin_ctx_list, jcr->JobId);
151 foreach_alist(plugin, plugin_list) {
152 /* Free the plugin instance */
153 plug_func(plugin)->freePlugin(&plugin_ctx_list[i++]);
155 free(plugin_ctx_list);
156 jcr->plugin_ctx_list = NULL;
160 /* ==============================================================
162 * Callbacks from the plugin
164 * ==============================================================
166 static bRC baculaGetValue(bpContext *ctx, brVariable var, void *value)
168 JCR *jcr = (JCR *)(ctx->bContext);
169 // Dmsg1(dbglvl, "bacula: baculaGetValue var=%d\n", var);
173 // Dmsg1(dbglvl, "Bacula: jcr=%p\n", jcr);
176 *((int *)value) = jcr->JobId;
177 Dmsg1(dbglvl, "Bacula: return bVarJobId=%d\n", jcr->JobId);
185 static bRC baculaSetValue(bpContext *ctx, bwVariable var, void *value)
187 Dmsg1(dbglvl, "bacula: baculaSetValue var=%d\n", var);
191 static bRC baculaRegisterEvents(bpContext *ctx, ...)
197 while ((event = va_arg(args, uint32_t))) {
198 Dmsg1(dbglvl, "Plugin wants event=%u\n", event);
204 static bRC baculaJobMsg(bpContext *ctx, const char *file, int line,
205 int type, time_t mtime, const char *msg)
207 Dmsg5(dbglvl, "Job message: %s:%d type=%d time=%ld msg=%s\n",
208 file, line, type, mtime, msg);
212 static bRC baculaDebugMsg(bpContext *ctx, const char *file, int line,
213 int level, const char *msg)
215 Dmsg4(dbglvl, "Debug message: %s:%d level=%d msg=%s\n",
216 file, line, level, msg);
223 int main(int argc, char *argv[])
225 char plugin_dir[1000];
230 strcpy(my_name, "test-dir");
232 getcwd(plugin_dir, sizeof(plugin_dir)-1);
233 load_dir_plugins(plugin_dir);
241 generate_plugin_event(jcr1, bEventJobStart, (void *)"Start Job 1");
242 generate_plugin_event(jcr1, bEventJobEnd);
243 generate_plugin_event(jcr2, bEventJobStart, (void *)"Start Job 1");
245 generate_plugin_event(jcr2, bEventJobEnd);
250 Dmsg0(dbglvl, "bacula: OK ...\n");
256 #endif /* TEST_PROGRAM */