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

   1 /*
   2  * File types as returned by find_files()
   3  *
   4  *     Kern Sibbald MMI
   5  */
   6 /*
   7    Bacula® - The Network Backup Solution
   8
   9    Copyright (C) 2001-2006 Free Software Foundation Europe e.V.
  10
  11    The main author of Bacula is Kern Sibbald, with contributions from
  12    many others, a complete list can be found in the file AUTHORS.
  13    This program is Free Software; you can redistribute it and/or
  14    modify it under the terms of version two of the GNU General Public
  15    License as published by the Free Software Foundation plus additions
  16    that are listed in the file LICENSE.
  17
  18    This program is distributed in the hope that it will be useful, but
  19    WITHOUT ANY WARRANTY; without even the implied warranty of
  20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  21    General Public License for more details.
  22
  23    You should have received a copy of the GNU General Public License
  24    along with this program; if not, write to the Free Software
  25    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  26    02110-1301, USA.
  27
  28    Bacula® is a registered trademark of John Walker.
  29    The licensor of Bacula is the Free Software Foundation Europe
  30    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  31    Switzerland, email:ftf@fsfeurope.org.
  32 */
  33
  34 #ifndef __FILES_H
  35 #define __FILES_H
  36
  37 #include "jcr.h"
  38 #include "bfile.h"
  39
  40 #ifdef HAVE_DIRENT_H
  41 #include <dirent.h>
  42 #define NAMELEN(dirent) (strlen((dirent)->d_name))
  43 #endif
  44
  45 #include <sys/file.h>
  46 #if HAVE_UTIME_H
  47 #include <utime.h>
  48 #else
  49 struct utimbuf {
  50     long actime;
  51     long modtime;
  52 };
  53 #endif
  54
  55 #define MODE_RALL (S_IRUSR|S_IRGRP|S_IROTH)
  56
  57 #include "lib/fnmatch.h"
  58 #include "lib/enh_fnmatch.h"
  59
  60 #ifndef HAVE_REGEX_H
  61 #include "lib/bregex.h"
  62 #else
  63 #include <regex.h>
  64 #endif
  65
  66 #include "save-cwd.h"
  67
  68 #ifndef HAVE_READDIR_R
  69 int readdir_r(DIR *dirp, struct dirent *entry, struct dirent **result);
  70 #endif
  71
  72
  73 /*
  74  * Status codes returned by create_file()
  75  */
  76 enum {
  77    CF_SKIP = 1,                       /* skip file (not newer or something) */
  78    CF_ERROR,                          /* error creating file */
  79    CF_EXTRACT,                        /* file created, data to extract */
  80    CF_CREATED                         /* file created, no data to extract */
  81 };
  82
  83
  84 /* Options saved int "options" of the include/exclude lists.
  85  * They are directly jammed ito  "flag" of ff packet
  86  */
  87 #define FO_MD5          (1<<1)        /* Do MD5 checksum */
  88 #define FO_GZIP         (1<<2)        /* Do Zlib compression */
  89 #define FO_NO_RECURSION (1<<3)        /* no recursion in directories */
  90 #define FO_MULTIFS      (1<<4)        /* multiple file systems */
  91 #define FO_SPARSE       (1<<5)        /* do sparse file checking */
  92 #define FO_IF_NEWER     (1<<6)        /* replace if newer */
  93 #define FO_NOREPLACE    (1<<7)        /* never replace */
  94 #define FO_READFIFO     (1<<8)        /* read data from fifo */
  95 #define FO_SHA1         (1<<9)        /* Do SHA1 checksum */
  96 #define FO_PORTABLE     (1<<10)       /* Use portable data format -- no BackupWrite */
  97 #define FO_MTIMEONLY    (1<<11)       /* Use mtime rather than mtime & ctime */
  98 #define FO_KEEPATIME    (1<<12)       /* Reset access time */
  99 #define FO_EXCLUDE      (1<<13)       /* Exclude file */
 100 #define FO_ACL          (1<<14)       /* Backup ACLs */
 101 #define FO_NO_HARDLINK  (1<<15)       /* don't handle hard links */
 102 #define FO_IGNORECASE   (1<<16)       /* Ignore file name case */
 103 #define FO_HFSPLUS      (1<<17)       /* Resource forks and Finder Info */
 104 #define FO_WIN32DECOMP  (1<<18)       /* Use BackupRead decomposition */
 105 #define FO_SHA256       (1<<19)       /* Do SHA256 checksum */
 106 #define FO_SHA512       (1<<20)       /* Do SHA512 checksum */
 107 #define FO_ENCRYPT      (1<<21)       /* Encrypt data stream */
 108 #define FO_NOATIME      (1<<22)       /* Use O_NOATIME to prevent atime change */
 109 #define FO_ENHANCEDWILD (1<<23)       /* Enhanced wild card processing */
 110 #define FO_CHKCHANGES   (1<<24)       /* Check if file have been modified during backup */
 111
 112 struct s_included_file {
 113    struct s_included_file *next;
 114    uint32_t options;                  /* backup options */
 115    int level;                         /* compression level */
 116    int len;                           /* length of fname */
 117    int pattern;                       /* set if wild card pattern */
 118    char VerifyOpts[20];               /* Options for verify */
 119    char fname[1];
 120 };
 121
 122 struct s_excluded_file {
 123    struct s_excluded_file *next;
 124    int len;
 125    char fname[1];
 126 };
 127
 128 /* FileSet definitions very similar to the resource
 129  *  contained in the Director because the components
 130  *  of the structure are passed by the Director to the
 131  *  File daemon and recompiled back into this structure
 132  */
 133 #undef  MAX_FOPTS
 134 #define MAX_FOPTS 30
 135
 136 enum {
 137    state_none,
 138    state_options,
 139    state_include,
 140    state_error
 141 };
 142
 143 /* File options structure */
 144 struct findFOPTS {
 145    uint32_t flags;                    /* options in bits */
 146    int GZIP_level;                    /* GZIP level */
 147    char VerifyOpts[MAX_FOPTS];        /* verify options */
 148    alist regex;                       /* regex string(s) */
 149    alist regexdir;                    /* regex string(s) for directories */
 150    alist regexfile;                   /* regex string(s) for files */
 151    alist wild;                        /* wild card strings */
 152    alist wilddir;                     /* wild card strings for directories */
 153    alist wildfile;                    /* wild card strings for files */
 154    alist wildbase;                    /* wild card strings for basenames */
 155    alist base;                        /* list of base names */
 156    alist fstype;                      /* file system type limitation */
 157    alist drivetype;                   /* drive type limitation */
 158    char *reader;                      /* reader program */
 159    char *writer;                      /* writer program */
 160 };
 161
 162
 163 /* This is either an include item or an exclude item */
 164 struct findINCEXE {
 165    findFOPTS *current_opts;           /* points to current options structure */
 166    alist opts_list;                   /* options list */
 167    dlist name_list;                   /* filename list -- holds dlistString */
 168 };
 169
 170 /*
 171  *   FileSet Resource
 172  *
 173  */
 174 struct findFILESET {
 175    int state;
 176    findINCEXE *incexe;                /* current item */
 177    alist include_list;
 178    alist exclude_list;
 179 };
 180
 181 #ifdef HAVE_DARWIN_OS
 182 struct HFSPLUS_INFO {
 183    unsigned long length;              /* Mandatory field */
 184    char fndrinfo[32];                 /* Finder Info */
 185    off_t rsrclength;                  /* Size of resource fork */
 186 };
 187 #endif
 188
 189 /*
 190  * Definition of the find_files packet passed as the
 191  * first argument to the find_files callback subroutine.
 192  */
 193 struct FF_PKT {
 194    char *top_fname;                   /* full filename before descending */
 195    char *fname;                       /* full filename */
 196    char *link;                        /* link if file linked */
 197    POOLMEM *sys_fname;                /* system filename */
 198    struct stat statp;                 /* stat packet */
 199    int32_t FileIndex;                 /* FileIndex of this file */
 200    int32_t LinkFI;                    /* FileIndex of main hard linked file */
 201    struct f_link *linked;             /* Set if this file is hard linked */
 202    int type;                          /* FT_ type from above */
 203    int ff_errno;                      /* errno */
 204    BFILE bfd;                         /* Bacula file descriptor */
 205    time_t save_time;                  /* start of incremental time */
 206    bool dereference;                  /* follow links (not implemented) */
 207    bool null_output_device;           /* using null output device */
 208    bool incremental;                  /* incremental save */
 209    char VerifyOpts[20];
 210    struct s_included_file *included_files_list;
 211    struct s_excluded_file *excluded_files_list;
 212    struct s_excluded_file *excluded_paths_list;
 213    findFILESET *fileset;
 214    int (*callback)(FF_PKT *, void *, bool); /* User's callback */
 215
 216    /* Values set by accept_file while processing Options */
 217    uint32_t flags;                    /* backup options */
 218    int GZIP_level;                    /* compression level */
 219    char *reader;                      /* reader program */
 220    char *writer;                      /* writer program */
 221    alist fstypes;                     /* allowed file system types */
 222    alist drivetypes;                  /* allowed drive types */
 223
 224    /* List of all hard linked files found */
 225    struct f_link **linkhash;          /* hard linked files */
 226
 227    /* Darwin specific things.
 228     * To avoid clutter, we always include rsrc_bfd and volhas_attrlist */
 229    BFILE rsrc_bfd;                    /* fd for resource forks */
 230    bool volhas_attrlist;              /* Volume supports getattrlist() */
 231 #ifdef HAVE_DARWIN_OS
 232    struct HFSPLUS_INFO hfsinfo;       /* Finder Info and resource fork size */
 233 #endif
 234 };
 235
 236
 237 #include "protos.h"
 238
 239 #endif /* __FILES_H */