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