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 * Sample Plugin program
31 * Kern Sibbald, October 2007
34 #include "fd-plugins.h"
43 #define PLUGIN_LICENSE "GPL"
44 #define PLUGIN_AUTHOR "Kern Sibbald"
45 #define PLUGIN_DATE "January 2008"
46 #define PLUGIN_VERSION "1"
47 #define PLUGIN_DESCRIPTION "Test File Daemon Plugin"
49 /* Forward referenced functions */
50 static bRC newPlugin(bpContext *ctx);
51 static bRC freePlugin(bpContext *ctx);
52 static bRC getPluginValue(bpContext *ctx, pVariable var, void *value);
53 static bRC setPluginValue(bpContext *ctx, pVariable var, void *value);
54 static bRC handlePluginEvent(bpContext *ctx, bEvent *event, void *value);
55 static bRC startPluginBackup(bpContext *ctx, struct save_pkt *sp);
56 static bRC pluginIO(bpContext *ctx, struct io_pkt *io);
59 /* Pointers to Bacula functions */
60 static bFuncs *bfuncs = NULL;
61 static bInfo *binfo = NULL;
63 static pInfo pluginInfo = {
65 PLUGIN_INTERFACE_VERSION,
74 static pFuncs pluginFuncs = {
76 PLUGIN_INTERFACE_VERSION,
78 /* Entry points into plugin */
79 newPlugin, /* new plugin instance */
80 freePlugin, /* free plugin instance */
93 bRC loadPlugin(bInfo *lbinfo, bFuncs *lbfuncs, pInfo **pinfo, pFuncs **pfuncs)
95 bfuncs = lbfuncs; /* set Bacula funct pointers */
97 printf("bpipe-fd: Loaded: size=%d version=%d\n", bfuncs->size, bfuncs->version);
99 *pinfo = &pluginInfo; /* return pointer to our info */
100 *pfuncs = &pluginFuncs; /* return pointer to our functions */
107 printf("bpipe-fd: Unloaded\n");
111 static bRC newPlugin(bpContext *ctx)
113 struct plugin_ctx *p_ctx = (struct plugin_ctx *)malloc(sizeof(struct plugin_ctx));
116 ctx->pContext = (void *)p_ctx; /* set our context pointer */
120 static bRC freePlugin(bpContext *ctx)
122 struct plugin_ctx *p_ctx = (struct plugin_ctx *)ctx->pContext;
127 static bRC getPluginValue(bpContext *ctx, pVariable var, void *value)
132 static bRC setPluginValue(bpContext *ctx, pVariable var, void *value)
137 static bRC handlePluginEvent(bpContext *ctx, bEvent *event, void *value)
141 switch (event->eventType) {
143 printf("bpipe-fd: JobStart=%s\n", (char *)value);
146 printf("bpipe-fd: JobEnd\n");
148 case bEventBackupStart:
149 printf("bpipe-fd: BackupStart\n");
151 case bEventBackupEnd:
152 printf("bpipe-fd: BackupEnd\n");
155 printf("bpipe-fd: JobLevel=%c %d\n", (int)value, (int)value);
158 printf("bpipe-fd: since=%d\n", (int)value);
161 case bEventRestoreStart:
162 printf("bpipe-fd: RestoreStart\n");
164 case bEventRestoreEnd:
165 printf("bpipe-fd: RestoreEnd\n");
168 /* Plugin command e.g. plugin = <plugin-name>:<name-space>:command */
169 case bEventPluginCommand:
170 printf("bpipe-fd: command=%s\n", (char *)value);
174 printf("bpipe-fd: unknown event=%d\n", event->eventType);
176 bfuncs->getBaculaValue(ctx, bVarFDName, (void *)&name);
177 // printf("FD Name=%s\n", name);
178 // bfuncs->JobMessage(ctx, __FILE__, __LINE__, 1, 0, "JobMesssage message");
179 // bfuncs->DebugMessage(ctx, __FILE__, __LINE__, 1, "DebugMesssage message");
183 static bRC startPluginBackup(bpContext *ctx, struct save_pkt *sp)
185 static char *fname = (char *)"/@BPIPE/test.txt";
186 time_t now = time(NULL);
188 sp->statp.st_mode = 0700;
189 sp->statp.st_ctime = now;
190 sp->statp.st_mtime = now;
191 sp->statp.st_atime = now;
192 sp->statp.st_size = -1;
193 sp->statp.st_blksize = 4096;
194 sp->statp.st_blocks = 1;
195 printf("bpipe: st_size=%p st_blocks=%p sp=%p\n", &sp->statp.st_size, &sp->statp.st_blocks,
198 printf("bpipe-fd: startPluginBackup\n");
205 static bRC pluginIO(bpContext *ctx, struct io_pkt *io)
207 struct plugin_ctx *p_ctx = (struct plugin_ctx *)ctx->pContext;
214 printf("bpipe-fd: IO_OPEN\n");
217 printf("bpipe-fd: IO_READ buf=%p len=%d\n", io->buf, io->count);
218 if (p_ctx->record == 0) {
219 strcpy(io->buf, "This is a test string.\n");
220 io->status = strlen(io->buf);
221 p_ctx->offset = io->status;
228 printf("bpipe-fd: IO_WRITE buf=%p len=%d\n", io->buf, io->count);
231 printf("bpipe-fd: IO_CLOSE\n");
234 io->offset = p_ctx->offset;