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

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2001-2007 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 plus additions
  11    that are 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 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.
  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
  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 #define FO_STRIPPATH    (1<<25)       /* Check for stripping path */
 112
 113 struct s_included_file {
 114    struct s_included_file *next;
 115    uint32_t options;                  /* backup options */
 116    int level;                         /* compression level */
 117    int len;                           /* length of fname */
 118    int pattern;                       /* set if wild card pattern */
 119    char VerifyOpts[20];               /* Options for verify */
 120    char fname[1];
 121 };
 122
 123 struct s_excluded_file {
 124    struct s_excluded_file *next;
 125    int len;
 126    char fname[1];
 127 };
 128
 129 /* FileSet definitions very similar to the resource
 130  *  contained in the Director because the components
 131  *  of the structure are passed by the Director to the
 132  *  File daemon and recompiled back into this structure
 133  */
 134 #undef  MAX_FOPTS
 135 #define MAX_FOPTS 30
 136
 137 enum {
 138    state_none,
 139    state_options,
 140    state_include,
 141    state_error
 142 };
 143
 144 /* File options structure */
 145 struct findFOPTS {
 146    uint32_t flags;                    /* options in bits */
 147    int GZIP_level;                    /* GZIP level */
 148    int strip_path;                    /* strip path count */
 149    char VerifyOpts[MAX_FOPTS];        /* verify options */
 150    alist regex;                       /* regex string(s) */
 151    alist regexdir;                    /* regex string(s) for directories */
 152    alist regexfile;                   /* regex string(s) for files */
 153    alist wild;                        /* wild card strings */
 154    alist wilddir;                     /* wild card strings for directories */
 155    alist wildfile;                    /* wild card strings for files */
 156    alist wildbase;                    /* wild card strings for basenames */
 157    alist base;                        /* list of base names */
 158    alist fstype;                      /* file system type limitation */
 159    alist drivetype;                   /* drive type limitation */
 160    char *reader;                      /* reader program */
 161    char *writer;                      /* writer program */
 162 };
 163
 164
 165 /* This is either an include item or an exclude item */
 166 struct findINCEXE {
 167    findFOPTS *current_opts;           /* points to current options structure */
 168    alist opts_list;                   /* options list */
 169    dlist name_list;                   /* filename list -- holds dlistString */
 170 };
 171
 172 /*
 173  *   FileSet Resource
 174  *
 175  */
 176 struct findFILESET {
 177    int state;
 178    findINCEXE *incexe;                /* current item */
 179    alist include_list;
 180    alist exclude_list;
 181 };
 182
 183 #ifdef HAVE_DARWIN_OS
 184 struct HFSPLUS_INFO {
 185    unsigned long length;              /* Mandatory field */
 186    char fndrinfo[32];                 /* Finder Info */
 187    off_t rsrclength;                  /* Size of resource fork */
 188 };
 189 #endif
 190
 191 /*
 192  * Definition of the find_files packet passed as the
 193  * first argument to the find_files callback subroutine.
 194  */
 195 struct FF_PKT {
 196    char *top_fname;                   /* full filename before descending */
 197    char *fname;                       /* full filename */
 198    char *link;                        /* link if file linked */
 199    POOLMEM *sys_fname;                /* system filename */
 200    struct stat statp;                 /* stat packet */
 201    int32_t FileIndex;                 /* FileIndex of this file */
 202    int32_t LinkFI;                    /* FileIndex of main hard linked file */
 203    struct f_link *linked;             /* Set if this file is hard linked */
 204    int type;                          /* FT_ type from above */
 205    int ff_errno;                      /* errno */
 206    BFILE bfd;                         /* Bacula file descriptor */
 207    time_t save_time;                  /* start of incremental time */
 208    bool dereference;                  /* follow links (not implemented) */
 209    bool null_output_device;           /* using null output device */
 210    bool incremental;                  /* incremental save */
 211    char VerifyOpts[20];
 212    struct s_included_file *included_files_list;
 213    struct s_excluded_file *excluded_files_list;
 214    struct s_excluded_file *excluded_paths_list;
 215    findFILESET *fileset;
 216    int (*callback)(FF_PKT *, void *, bool); /* User's callback */
 217
 218    /* Values set by accept_file while processing Options */
 219    uint32_t flags;                    /* backup options */
 220    int GZIP_level;                    /* compression level */
 221    int strip_path;                    /* strip path count */
 222    char *reader;                      /* reader program */
 223    char *writer;                      /* writer program */
 224    alist fstypes;                     /* allowed file system types */
 225    alist drivetypes;                  /* allowed drive types */
 226
 227    /* List of all hard linked files found */
 228    struct f_link **linkhash;          /* hard linked files */
 229
 230    /* Darwin specific things.
 231     * To avoid clutter, we always include rsrc_bfd and volhas_attrlist */
 232    BFILE rsrc_bfd;                    /* fd for resource forks */
 233    bool volhas_attrlist;              /* Volume supports getattrlist() */
 234 #ifdef HAVE_DARWIN_OS
 235    struct HFSPLUS_INFO hfsinfo;       /* Finder Info and resource fork size */
 236 #endif
 237 };
 238
 239
 240 #include "protos.h"
 241
 242 #endif /* __FILES_H */