git.sur5r.net Git - bacula/bacula/blob - bacula/src/findlib/find.h

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2001-2010 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 three of the GNU Affero General Public
  10    License as published by the Free Software Foundation and included
  11    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 Affero 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  * File types as returned by find_files()
  30  *
  31  *     Kern Sibbald MMI
  32  */
  33
  34 #ifndef __FILES_H
  35 #define __FILES_H
  36
  37 #include "jcr.h"
  38 #include "fileopts.h"
  39 #include "bfile.h"
  40 #include "../filed/fd_plugins.h"
  41
  42 #ifdef HAVE_DIRENT_H
  43 #include <dirent.h>
  44 #define NAMELEN(dirent) (strlen((dirent)->d_name))
  45 #endif
  46
  47 #include <sys/file.h>
  48 #if !defined(HAVE_WIN32) || defined(HAVE_MINGW)
  49 #include <sys/param.h>
  50 #endif
  51 #if HAVE_UTIME_H
  52 #include <utime.h>
  53 #else
  54 struct utimbuf {
  55     long actime;
  56     long modtime;
  57 };
  58 #endif
  59
  60 #define MODE_RALL (S_IRUSR|S_IRGRP|S_IROTH)
  61
  62 #include "lib/fnmatch.h"
  63 // #include "lib/enh_fnmatch.h"
  64
  65 #ifndef HAVE_REGEX_H
  66 #include "lib/bregex.h"
  67 #else
  68 #include <regex.h>
  69 #endif
  70
  71 #ifndef HAVE_READDIR_R
  72 int readdir_r(DIR *dirp, struct dirent *entry, struct dirent **result);
  73 #endif
  74
  75 /* For options FO_xxx values see src/fileopts.h */
  76
  77 struct s_included_file {
  78    struct s_included_file *next;
  79    uint32_t options;                  /* backup options */
  80    int level;                         /* compression level */
  81    int len;                           /* length of fname */
  82    int pattern;                       /* set if wild card pattern */
  83    char VerifyOpts[20];               /* Options for verify */
  84    char fname[1];
  85 };
  86
  87 struct s_excluded_file {
  88    struct s_excluded_file *next;
  89    int len;
  90    char fname[1];
  91 };
  92
  93 /* FileSet definitions very similar to the resource
  94  *  contained in the Director because the components
  95  *  of the structure are passed by the Director to the
  96  *  File daemon and recompiled back into this structure
  97  */
  98 #undef  MAX_FOPTS
  99 #define MAX_FOPTS 30
 100
 101 enum {
 102    state_none,
 103    state_options,
 104    state_include,
 105    state_error
 106 };
 107
 108 /* File options structure */
 109 struct findFOPTS {
 110    uint32_t flags;                    /* options in bits */
 111    int GZIP_level;                    /* GZIP level */
 112    int strip_path;                    /* strip path count */
 113    char VerifyOpts[MAX_FOPTS];        /* verify options */
 114    char AccurateOpts[MAX_FOPTS];      /* accurate mode options */
 115    char BaseJobOpts[MAX_FOPTS];       /* basejob mode options */
 116    alist regex;                       /* regex string(s) */
 117    alist regexdir;                    /* regex string(s) for directories */
 118    alist regexfile;                   /* regex string(s) for files */
 119    alist wild;                        /* wild card strings */
 120    alist wilddir;                     /* wild card strings for directories */
 121    alist wildfile;                    /* wild card strings for files */
 122    alist wildbase;                    /* wild card strings for basenames */
 123    alist base;                        /* list of base names */
 124    alist fstype;                      /* file system type limitation */
 125    alist drivetype;                   /* drive type limitation */
 126 };
 127
 128
 129 /* This is either an include item or an exclude item */
 130 struct findINCEXE {
 131    findFOPTS *current_opts;           /* points to current options structure */
 132    alist opts_list;                   /* options list */
 133    dlist name_list;                   /* filename list -- holds dlistString */
 134    dlist plugin_list;                 /* plugin list -- holds dlistString */
 135    char *ignoredir;                   /* ignore directories with this file */
 136 };
 137
 138 /*
 139  *   FileSet Resource
 140  *
 141  */
 142 struct findFILESET {
 143    int state;
 144    findINCEXE *incexe;                /* current item */
 145    alist include_list;
 146    alist exclude_list;
 147 };
 148
 149 struct HFSPLUS_INFO {
 150    unsigned long length;              /* Mandatory field */
 151    char fndrinfo[32];                 /* Finder Info */
 152    off_t rsrclength;                  /* Size of resource fork */
 153 };
 154
 155 /*
 156  * Definition of the find_files packet passed as the
 157  * first argument to the find_files callback subroutine.
 158  */
 159 struct FF_PKT {
 160    char *top_fname;                   /* full filename before descending */
 161    char *fname;                       /* full filename */
 162    char *link;                        /* link if file linked */
 163    char *object_name;                 /* Object name */
 164    char *object;                      /* restore object */
 165    POOLMEM *sys_fname;                /* system filename */
 166    POOLMEM *fname_save;               /* save when stripping path */
 167    POOLMEM *link_save;                /* save when stripping path */
 168    char *digest;                      /* set to file digest when the file is a hardlink */
 169    struct stat statp;                 /* stat packet */
 170    uint32_t digest_len;               /* set to the digest len when the file is a hardlink*/
 171    int32_t digest_stream;             /* set to digest type when the file is hardlink */
 172    int32_t FileIndex;                 /* FileIndex of this file */
 173    int32_t LinkFI;                    /* FileIndex of main hard linked file */
 174    int32_t delta_seq;                 /* Delta Sequence number */
 175    int32_t object_index;              /* Object index */
 176    int32_t object_len;                /* Object length */
 177    int32_t object_compression;        /* Type of compression for object */
 178    struct f_link *linked;             /* Set if this file is hard linked */
 179    int type;                          /* FT_ type from above */
 180    int ff_errno;                      /* errno */
 181    BFILE bfd;                         /* Bacula file descriptor */
 182    time_t save_time;                  /* start of incremental time */
 183    bool dereference;                  /* follow links (not implemented) */
 184    bool null_output_device;           /* using null output device */
 185    bool incremental;                  /* incremental save */
 186    char VerifyOpts[20];
 187    char AccurateOpts[20];
 188    char BaseJobOpts[20];
 189    struct s_included_file *included_files_list;
 190    struct s_excluded_file *excluded_files_list;
 191    struct s_excluded_file *excluded_paths_list;
 192    findFILESET *fileset;
 193    int (*file_save)(JCR *, FF_PKT *, bool); /* User's callback */
 194    int (*plugin_save)(JCR *, FF_PKT *, bool); /* User's callback */
 195    bool (*check_fct)(JCR *, FF_PKT *); /* optionnal user fct to check file changes */
 196
 197    /* Values set by accept_file while processing Options */
 198    uint32_t flags;                    /* backup options */
 199    int GZIP_level;                    /* compression level */
 200    int strip_path;                    /* strip path count */
 201    bool cmd_plugin;                   /* set if we have a command plugin */
 202    alist fstypes;                     /* allowed file system types */
 203    alist drivetypes;                  /* allowed drive types */
 204
 205    /* List of all hard linked files found */
 206    struct f_link **linkhash;          /* hard linked files */
 207
 208    /* Darwin specific things.
 209     * To avoid clutter, we always include rsrc_bfd and volhas_attrlist */
 210    BFILE rsrc_bfd;                    /* fd for resource forks */
 211    bool volhas_attrlist;              /* Volume supports getattrlist() */
 212    struct HFSPLUS_INFO hfsinfo;       /* Finder Info and resource fork size */
 213 };
 214
 215
 216 #include "protos.h"
 217
 218 #endif /* __FILES_H */