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 * Interface definition for Bacula Plugins
31 * Kern Sibbald, October 2007
35 #ifndef __FD_PLUGINS_H
36 #define __FD_PLUGINS_H
38 #include <sys/types.h>
44 #include "lib/plugins.h"
53 /****************************************************************************
55 * Bacula definitions *
57 ****************************************************************************/
59 /* Bacula Variable Ids */
97 typedef struct s_bEvent {
101 typedef struct s_baculaInfo {
106 /* Bacula interface version and function pointers */
107 typedef struct s_baculaFuncs {
110 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
111 bRC (*getBaculaValue)(bpContext *ctx, brVariable var, void *value);
112 bRC (*setBaculaValue)(bpContext *ctx, bwVariable var, void *value);
113 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
114 int type, time_t mtime, const char *msg);
115 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
116 int level, const char *msg);
119 /* Bacula Subroutines */
120 void load_dir_plugins(const char *plugin_dir);
121 void new_plugins(JCR *jcr);
122 void free_plugins(JCR *jcr);
123 void generate_plugin_event(JCR *jcr, bEventType event);
127 /****************************************************************************
129 * Plugin definitions *
131 ****************************************************************************/
139 #define PLUGIN_MAGIC "*PluginData*"
140 #define PLUGIN_INTERFACE 1
142 typedef struct s_pluginInfo {
146 char *plugin_license;
149 char *plugin_version;
150 char *plugin_description;
153 typedef struct s_pluginFuncs {
156 bRC (*newPlugin)(bpContext *ctx);
157 bRC (*freePlugin)(bpContext *ctx);
158 bRC (*getPluginValue)(bpContext *ctx, pVariable var, void *value);
159 bRC (*setPluginValue)(bpContext *ctx, pVariable var, void *value);
160 bRC (*handlePluginEvent)(bpContext *ctx, bEvent *event);
163 #define plug_func(plugin) ((pFuncs *)(plugin->pfuncs))
164 #define plug_info(plugin) ((pInfo *)(plugin->pinfo))
170 #endif /* __FD_PLUGINS_H */