git.sur5r.net Git - bacula/bacula/blob - bacula/src/filed/fd_plugins.h

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2007-2008 Free Software Foundation Europe e.V.
   5
   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.
  12
  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.
  17
  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
  21    02110-1301, USA.
  22
  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.
  27 */
  28 /*
  29  * Application Programming Interface (API) definition for Bacula Plugins
  30  *
  31  * Kern Sibbald, October 2007
  32  *
  33  */
  34
  35 #ifndef __FD_PLUGINS_H
  36 #define __FD_PLUGINS_H
  37
  38 #ifndef _BACULA_H
  39 #ifdef __cplusplus
  40 /* Workaround for SGI IRIX 6.5 */
  41 #define _LANGUAGE_C_PLUS_PLUS 1
  42 #endif
  43 #define _REENTRANT    1
  44 #define _THREAD_SAFE  1
  45 #define _POSIX_PTHREAD_SEMANTICS 1
  46 #define _FILE_OFFSET_BITS 64
  47 #define _LARGEFILE_SOURCE 1
  48 #define _LARGE_FILES 1
  49 #endif
  50
  51 #include <sys/types.h>
  52
  53 #if defined(HAVE_WIN32)
  54 #if defined(HAVE_MINGW)
  55 #include "mingwconfig.h"
  56 #else
  57 #include "winconfig.h"
  58 #endif
  59 #else
  60 #ifndef __CONFIG_H
  61 #include "config.h"
  62 #define __CONFIG_H
  63 #endif
  64 #endif
  65
  66 #include "bc_types.h"
  67 #include "lib/plugins.h"
  68 #include <sys/stat.h>
  69
  70 /*
  71  * This packet is used for file save info transfer.
  72 */
  73 struct save_pkt {
  74   int32_t pkt_size;                   /* size of this packet */
  75   char *fname;                        /* Full path and filename */
  76   char *link;                         /* Link name if any */
  77   struct stat statp;                  /* System stat() packet for file */
  78   int32_t type;                       /* FT_xx for this file */
  79   uint32_t flags;                     /* Bacula internal flags */
  80   bool portable;                      /* set if data format is portable */
  81   char *cmd;                          /* command */
  82   int32_t pkt_end;                    /* end packet sentinel */
  83 };
  84
  85 /*
  86  * This packet is used for file restore info transfer.
  87 */
  88 struct restore_pkt {
  89    int32_t pkt_size;                  /* size of this packet */
  90    int32_t stream;                    /* attribute stream id */
  91    int32_t data_stream;               /* id of data stream to follow */
  92    int32_t type;                      /* file type FT */
  93    int32_t file_index;                /* file index */
  94    int32_t LinkFI;                    /* file index to data if hard link */
  95    uid_t uid;                         /* userid */
  96    struct stat statp;                 /* decoded stat packet */
  97    const char *attrEx;                /* extended attributes if any */
  98    const char *ofname;                /* output filename */
  99    const char *olname;                /* output link name */
 100    const char *where;                 /* where */
 101    const char *RegexWhere;            /* regex where */
 102    int replace;                       /* replace flag */
 103    int32_t pkt_end;                   /* end packet sentinel */
 104 };
 105
 106 enum {
 107    IO_OPEN = 1,
 108    IO_READ = 2,
 109    IO_WRITE = 3,
 110    IO_CLOSE = 4,
 111    IO_SEEK = 5
 112 };
 113
 114 struct io_pkt {
 115    int32_t pkt_size;                  /* Size of this packet */
 116    int32_t func;                      /* Function code */
 117    int32_t count;                     /* read/write count */
 118    int32_t flags;                     /* Open flags */
 119    mode_t mode;                       /* permissions for created files */
 120    char *buf;                         /* read/write buffer */
 121    const char *fname;                 /* open filename */
 122    int32_t status;                    /* return status */
 123    int32_t io_errno;                  /* errno code */
 124    int32_t lerror;                    /* Win32 error code */
 125    int32_t whence;                    /* lseek argument */
 126    boffset_t offset;                  /* lseek argument */
 127    bool win32;                        /* Win32 GetLastError returned */
 128    int32_t pkt_end;                   /* end packet sentinel */
 129 };
 130
 131 /****************************************************************************
 132  *                                                                          *
 133  *                Bacula definitions                                        *
 134  *                                                                          *
 135  ****************************************************************************/
 136
 137 /* Bacula Variable Ids */
 138 typedef enum {
 139   bVarJobId     = 1,
 140   bVarFDName    = 2,
 141   bVarLevel     = 3,
 142   bVarType      = 4,
 143   bVarClient    = 5,
 144   bVarJobName   = 6,
 145   bVarJobStatus = 7,
 146   bVarSinceTime = 8
 147 } bVariable;
 148
 149 typedef enum {
 150   bEventJobStart        = 1,
 151   bEventJobEnd          = 2,
 152   bEventStartBackupJob  = 3,
 153   bEventEndBackupJob    = 4,
 154   bEventStartRestoreJob = 5,
 155   bEventEndRestoreJob   = 6,
 156   bEventStartVerifyJob  = 7,
 157   bEventEndVerifyJob    = 8,
 158   bEventBackupCommand   = 9,
 159   bEventRestoreCommand  = 10,
 160   bEventLevel           = 11,
 161   bEventSince           = 12,
 162 } bEventType;
 163
 164 typedef struct s_bEvent {
 165    uint32_t eventType;
 166 } bEvent;
 167
 168 typedef struct s_baculaInfo {
 169    uint32_t size;
 170    uint32_t version;
 171 } bInfo;
 172
 173 /* Bacula Core Routines -- not used within a plugin */
 174 #ifdef FILE_DAEMON
 175 struct BFILE;                   /* forward referenced */
 176 struct FF_PKT;
 177 void load_fd_plugins(const char *plugin_dir);
 178 void new_plugins(JCR *jcr);
 179 void free_plugins(JCR *jcr);
 180 void generate_plugin_event(JCR *jcr, bEventType event, void *value=NULL);
 181 bool send_plugin_name(JCR *jcr, BSOCK *sd, bool start);
 182 void plugin_name_stream(JCR *jcr, char *name);
 183 int plugin_create_file(JCR *jcr, ATTR *attr, BFILE *bfd, int replace);
 184 bool plugin_set_attributes(JCR *jcr, ATTR *attr, BFILE *ofd);
 185 int plugin_save(JCR *jcr, FF_PKT *ff_pkt, bool top_level);
 186 #endif
 187
 188 #ifdef __cplusplus
 189 extern "C" {
 190 #endif
 191
 192 /*
 193  * Bacula interface version and function pointers --
 194  *  i.e. callbacks from the plugin to Bacula
 195  */
 196 typedef struct s_baculaFuncs {
 197    uint32_t size;
 198    uint32_t version;
 199    bRC (*registerBaculaEvents)(bpContext *ctx, ...);
 200    bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
 201    bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
 202    bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
 203        int type, time_t mtime, const char *fmt, ...);
 204    bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
 205        int level, const char *fmt, ...);
 206 } bFuncs;
 207
 208
 209
 210
 211 /****************************************************************************
 212  *                                                                          *
 213  *                Plugin definitions                                        *
 214  *                                                                          *
 215  ****************************************************************************/
 216
 217 typedef enum {
 218   pVarName = 1,
 219   pVarDescription = 2
 220 } pVariable;
 221
 222
 223 #define FD_PLUGIN_MAGIC     "*FDPluginData*"
 224 #define FD_PLUGIN_INTERFACE_VERSION  1
 225
 226 typedef struct s_pluginInfo {
 227    uint32_t size;
 228    uint32_t version;
 229    const char *plugin_magic;
 230    const char *plugin_license;
 231    const char *plugin_author;
 232    const char *plugin_date;
 233    const char *plugin_version;
 234    const char *plugin_description;
 235 } pInfo;
 236
 237 /*
 238  * This is a set of function pointers that Bacula can call
 239  *  within the plugin.
 240  */
 241 typedef struct s_pluginFuncs {
 242    uint32_t size;
 243    uint32_t version;
 244    bRC (*newPlugin)(bpContext *ctx);
 245    bRC (*freePlugin)(bpContext *ctx);
 246    bRC (*getPluginValue)(bpContext *ctx, pVariable var, void *value);
 247    bRC (*setPluginValue)(bpContext *ctx, pVariable var, void *value);
 248    bRC (*handlePluginEvent)(bpContext *ctx, bEvent *event, void *value);
 249    bRC (*startBackupFile)(bpContext *ctx, struct save_pkt *sp);
 250    bRC (*endBackupFile)(bpContext *ctx);
 251    bRC (*startRestoreFile)(bpContext *ctx, const char *cmd);
 252    bRC (*endRestoreFile)(bpContext *ctx);
 253    bRC (*pluginIO)(bpContext *ctx, struct io_pkt *io);
 254    bRC (*createFile)(bpContext *ctx, struct restore_pkt *rp);
 255    bRC (*setFileAttributes)(bpContext *ctx, struct restore_pkt *rp);
 256 } pFuncs;
 257
 258 #define plug_func(plugin) ((pFuncs *)(plugin->pfuncs))
 259 #define plug_info(plugin) ((pInfo *)(plugin->pinfo))
 260
 261 #ifdef __cplusplus
 262 }
 263 #endif
 264
 265 #endif /* __FD_PLUGINS_H */