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

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2001-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 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 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 "bfile.h"
  39 #include "../filed/fd_plugins.h"
  40
  41 #ifdef HAVE_DIRENT_H
  42 #include <dirent.h>
  43 #define NAMELEN(dirent) (strlen((dirent)->d_name))
  44 #endif
  45
  46 #include <sys/file.h>
  47 #include <sys/param.h>
  48 #if HAVE_UTIME_H
  49 #include <utime.h>
  50 #else
  51 struct utimbuf {
  52     long actime;
  53     long modtime;
  54 };
  55 #endif
  56
  57 #define MODE_RALL (S_IRUSR|S_IRGRP|S_IROTH)
  58
  59 #include "lib/fnmatch.h"
  60 // #include "lib/enh_fnmatch.h"
  61
  62 #ifndef HAVE_REGEX_H
  63 #include "lib/bregex.h"
  64 #else
  65 #include <regex.h>
  66 #endif
  67
  68 #ifndef HAVE_READDIR_R
  69 int readdir_r(DIR *dirp, struct dirent *entry, struct dirent **result);
  70 #endif
  71
  72 /*
  73  * Options saved int "options" of the include/exclude lists.
  74  * They are directly jammed ito  "flag" of ff packet
  75  */
  76 #define FO_MD5          (1<<1)        /* Do MD5 checksum */
  77 #define FO_GZIP         (1<<2)        /* Do Zlib compression */
  78 #define FO_NO_RECURSION (1<<3)        /* no recursion in directories */
  79 #define FO_MULTIFS      (1<<4)        /* multiple file systems */
  80 #define FO_SPARSE       (1<<5)        /* do sparse file checking */
  81 #define FO_IF_NEWER     (1<<6)        /* replace if newer */
  82 #define FO_NOREPLACE    (1<<7)        /* never replace */
  83 #define FO_READFIFO     (1<<8)        /* read data from fifo */
  84 #define FO_SHA1         (1<<9)        /* Do SHA1 checksum */
  85 #define FO_PORTABLE     (1<<10)       /* Use portable data format -- no BackupWrite */
  86 #define FO_MTIMEONLY    (1<<11)       /* Use mtime rather than mtime & ctime */
  87 #define FO_KEEPATIME    (1<<12)       /* Reset access time */
  88 #define FO_EXCLUDE      (1<<13)       /* Exclude file */
  89 #define FO_ACL          (1<<14)       /* Backup ACLs */
  90 #define FO_NO_HARDLINK  (1<<15)       /* don't handle hard links */
  91 #define FO_IGNORECASE   (1<<16)       /* Ignore file name case */
  92 #define FO_HFSPLUS      (1<<17)       /* Resource forks and Finder Info */
  93 #define FO_WIN32DECOMP  (1<<18)       /* Use BackupRead decomposition */
  94 #define FO_SHA256       (1<<19)       /* Do SHA256 checksum */
  95 #define FO_SHA512       (1<<20)       /* Do SHA512 checksum */
  96 #define FO_ENCRYPT      (1<<21)       /* Encrypt data stream */
  97 #define FO_NOATIME      (1<<22)       /* Use O_NOATIME to prevent atime change */
  98 #define FO_ENHANCEDWILD (1<<23)       /* Enhanced wild card processing */
  99 #define FO_CHKCHANGES   (1<<24)       /* Check if file have been modified during backup */
 100 #define FO_STRIPPATH    (1<<25)       /* Check for stripping path */
 101 #define FO_HONOR_NODUMP (1<<26)       /* honor NODUMP flag */
 102
 103 struct s_included_file {
 104    struct s_included_file *next;
 105    uint32_t options;                  /* backup options */
 106    int level;                         /* compression level */
 107    int len;                           /* length of fname */
 108    int pattern;                       /* set if wild card pattern */
 109    char VerifyOpts[20];               /* Options for verify */
 110    char fname[1];
 111 };
 112
 113 struct s_excluded_file {
 114    struct s_excluded_file *next;
 115    int len;
 116    char fname[1];
 117 };
 118
 119 /* FileSet definitions very similar to the resource
 120  *  contained in the Director because the components
 121  *  of the structure are passed by the Director to the
 122  *  File daemon and recompiled back into this structure
 123  */
 124 #undef  MAX_FOPTS
 125 #define MAX_FOPTS 30
 126
 127 enum {
 128    state_none,
 129    state_options,
 130    state_include,
 131    state_error
 132 };
 133
 134 /* File options structure */
 135 struct findFOPTS {
 136    uint32_t flags;                    /* options in bits */
 137    int GZIP_level;                    /* GZIP level */
 138    int strip_path;                    /* strip path count */
 139    char VerifyOpts[MAX_FOPTS];        /* verify options */
 140    char AccurateOpts[MAX_FOPTS];      /* accurate mode options */
 141    alist regex;                       /* regex string(s) */
 142    alist regexdir;                    /* regex string(s) for directories */
 143    alist regexfile;                   /* regex string(s) for files */
 144    alist wild;                        /* wild card strings */
 145    alist wilddir;                     /* wild card strings for directories */
 146    alist wildfile;                    /* wild card strings for files */
 147    alist wildbase;                    /* wild card strings for basenames */
 148    alist base;                        /* list of base names */
 149    alist fstype;                      /* file system type limitation */
 150    alist drivetype;                   /* drive type limitation */
 151    char *ignoredir;                   /* ignore directories with this file */
 152 };
 153
 154
 155 /* This is either an include item or an exclude item */
 156 struct findINCEXE {
 157    findFOPTS *current_opts;           /* points to current options structure */
 158    alist opts_list;                   /* options list */
 159    dlist name_list;                   /* filename list -- holds dlistString */
 160    dlist plugin_list;                 /* plugin list -- holds dlistString */
 161 };
 162
 163 /*
 164  *   FileSet Resource
 165  *
 166  */
 167 struct findFILESET {
 168    int state;
 169    findINCEXE *incexe;                /* current item */
 170    alist include_list;
 171    alist exclude_list;
 172 };
 173
 174 #ifdef HAVE_DARWIN_OS
 175 struct HFSPLUS_INFO {
 176    unsigned long length;              /* Mandatory field */
 177    char fndrinfo[32];                 /* Finder Info */
 178    off_t rsrclength;                  /* Size of resource fork */
 179 };
 180 #endif
 181
 182 /*
 183  * Definition of the find_files packet passed as the
 184  * first argument to the find_files callback subroutine.
 185  */
 186 struct FF_PKT {
 187    char *top_fname;                   /* full filename before descending */
 188    char *fname;                       /* full filename */
 189    char *link;                        /* link if file linked */
 190    POOLMEM *sys_fname;                /* system filename */
 191    POOLMEM *fname_save;               /* save when stripping path */
 192    POOLMEM *link_save;                /* save when stripping path */
 193    struct stat statp;                 /* stat packet */
 194    int32_t FileIndex;                 /* FileIndex of this file */
 195    int32_t LinkFI;                    /* FileIndex of main hard linked file */
 196    struct f_link *linked;             /* Set if this file is hard linked */
 197    int type;                          /* FT_ type from above */
 198    int ff_errno;                      /* errno */
 199    BFILE bfd;                         /* Bacula file descriptor */
 200    time_t save_time;                  /* start of incremental time */
 201    bool dereference;                  /* follow links (not implemented) */
 202    bool null_output_device;           /* using null output device */
 203    bool incremental;                  /* incremental save */
 204    char VerifyOpts[20];
 205    struct s_included_file *included_files_list;
 206    struct s_excluded_file *excluded_files_list;
 207    struct s_excluded_file *excluded_paths_list;
 208    findFILESET *fileset;
 209    int (*file_save)(JCR *, FF_PKT *, bool); /* User's callback */
 210    int (*plugin_save)(JCR *, FF_PKT *, bool); /* User's callback */
 211    bool (*check_fct)(JCR *, FF_PKT *); /* optionnal user fct to check file changes */
 212
 213    /* Values set by accept_file while processing Options */
 214    uint32_t flags;                    /* backup options */
 215    int GZIP_level;                    /* compression level */
 216    int strip_path;                    /* strip path count */
 217    char *ignoredir;                   /* ignore directories with this file */
 218    bool cmd_plugin;                   /* set if we have a command plugin */
 219    alist fstypes;                     /* allowed file system types */
 220    alist drivetypes;                  /* allowed drive types */
 221
 222    /* List of all hard linked files found */
 223    struct f_link **linkhash;          /* hard linked files */
 224
 225    /* Darwin specific things.
 226     * To avoid clutter, we always include rsrc_bfd and volhas_attrlist */
 227    BFILE rsrc_bfd;                    /* fd for resource forks */
 228    bool volhas_attrlist;              /* Volume supports getattrlist() */
 229 #ifdef HAVE_DARWIN_OS
 230    struct HFSPLUS_INFO hfsinfo;       /* Finder Info and resource fork size */
 231 #endif
 232 };
 233
 234
 235 #include "protos.h"
 236
 237 #endif /* __FILES_H */