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    Copyright (C) 2001-2005 Kern Sibbald
   8
   9    This program is free software; you can redistribute it and/or
  10    modify it under the terms of the GNU General Public License as
  11    published by the Free Software Foundation; either version 2 of
  12    the License, or (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17    General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public
  20    License along with this program; if not, write to the Free
  21    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  22    MA 02111-1307, USA.
  23
  24  */
  25
  26 #ifndef __FILES_H
  27 #define __FILES_H
  28
  29 #include "jcr.h"
  30 #include "bfile.h"
  31
  32 #ifdef HAVE_DIRENT_H
  33 #include <dirent.h>
  34 #define NAMELEN(dirent) (strlen((dirent)->d_name))
  35 #endif
  36
  37 #include <sys/file.h>
  38 #if HAVE_UTIME_H
  39 #include <utime.h>
  40 #else
  41 struct utimbuf {
  42     long actime;
  43     long modtime;
  44 };
  45 #endif
  46
  47 #define MODE_RALL (S_IRUSR|S_IRGRP|S_IROTH)
  48
  49 #include "lib/fnmatch.h"
  50
  51 #ifdef HAVE_REGEX_H
  52 #include <regex.h>
  53 #endif
  54
  55 #include "save-cwd.h"
  56
  57 #ifndef HAVE_READDIR_R
  58 int readdir_r(DIR *dirp, struct dirent *entry, struct dirent **result);
  59 #endif
  60
  61
  62 /*
  63  * Status codes returned by create_file()
  64  */
  65 enum {
  66    CF_SKIP = 1,                       /* skip file (not newer or something) */
  67    CF_ERROR,                          /* error creating file */
  68    CF_EXTRACT,                        /* file created, data to extract */
  69    CF_CREATED                         /* file created, no data to extract */
  70 };
  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
  94 struct s_included_file {
  95    struct s_included_file *next;
  96    uint32_t options;                  /* backup options */
  97    int level;                         /* compression level */
  98    int len;                           /* length of fname */
  99    int pattern;                       /* set if wild card pattern */
 100    char VerifyOpts[20];               /* Options for verify */
 101    char fname[1];
 102 };
 103
 104 struct s_excluded_file {
 105    struct s_excluded_file *next;
 106    int len;
 107    char fname[1];
 108 };
 109
 110 /* FileSet definitions very similar to the resource
 111  *  contained in the Director because the components
 112  *  of the structure are passed by the Director to the
 113  *  File daemon and recompiled back into this structure
 114  */
 115 #undef  MAX_FOPTS
 116 #define MAX_FOPTS 30
 117
 118 enum {
 119    state_none,
 120    state_options,
 121    state_include,
 122    state_error
 123 };
 124
 125 /* File options structure */
 126 struct findFOPTS {
 127    uint32_t flags;                    /* options in bits */
 128    int GZIP_level;                    /* GZIP level */
 129    char VerifyOpts[MAX_FOPTS];        /* verify options */
 130    alist regex;                       /* regex string(s) */
 131    alist regexdir;                    /* regex string(s) for directories */
 132    alist regexfile;                   /* regex string(s) for files */
 133    alist wild;                        /* wild card strings */
 134    alist wilddir;                     /* wild card strings for directories */
 135    alist wildfile;                    /* wild card strings for files */
 136    alist base;                        /* list of base names */
 137    alist fstype;                      /* file system type limitation */
 138    char *reader;                      /* reader program */
 139    char *writer;                      /* writer program */
 140 };
 141
 142
 143 /* This is either an include item or an exclude item */
 144 struct findINCEXE {
 145    findFOPTS *current_opts;           /* points to current options structure */
 146    alist opts_list;                   /* options list */
 147    alist name_list;                   /* filename list -- holds char * */
 148 };
 149
 150 /*
 151  *   FileSet Resource
 152  *
 153  */
 154 struct findFILESET {
 155    int state;
 156    findINCEXE *incexe;                /* current item */
 157    alist include_list;
 158    alist exclude_list;
 159 };
 160
 161 #ifdef HAVE_DARWIN_OS
 162 struct HFSPLUS_INFO {
 163    unsigned long length;              /* Mandatory field */
 164    char fndrinfo[32];                 /* Finder Info */
 165    off_t rsrclength;                  /* Size of resource fork */
 166 };
 167 #endif
 168
 169 /*
 170  * Definition of the find_files packet passed as the
 171  * first argument to the find_files callback subroutine.
 172  */
 173 struct FF_PKT {
 174    char *fname;                       /* filename */
 175    char *link;                        /* link if file linked */
 176    POOLMEM *sys_fname;                /* system filename */
 177    struct stat statp;                 /* stat packet */
 178    int32_t FileIndex;                 /* FileIndex of this file */
 179    int32_t LinkFI;                    /* FileIndex of main hard linked file */
 180    struct f_link *linked;             /* Set if this file is hard linked */
 181    int type;                          /* FT_ type from above */
 182    int ff_errno;                      /* errno */
 183    BFILE bfd;                         /* Bacula file descriptor */
 184    time_t save_time;                  /* start of incremental time */
 185    bool dereference;                  /* follow links (not implemented) */
 186    bool null_output_device;           /* using null output device */
 187    bool incremental;                  /* incremental save */
 188    char VerifyOpts[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 (*callback)(FF_PKT *, void *, bool); /* User's callback */
 194
 195    /* Values set by accept_file while processing Options */
 196    uint32_t flags;                    /* backup options */
 197    int GZIP_level;                    /* compression level */
 198    char *reader;                      /* reader program */
 199    char *writer;                      /* writer program */
 200    alist fstypes;                     /* allowed file system types */
 201
 202    /* List of all hard linked files found */
 203    struct f_link *linklist;           /* hard linked files */
 204
 205    /* Darwin specific things.
 206     * To avoid clutter, we always include rsrc_bfd and volhas_attrlist */
 207    BFILE rsrc_bfd;                    /* fd for resource forks */
 208    bool volhas_attrlist;              /* Volume supports getattrlist() */
 209 #ifdef HAVE_DARWIN_OS
 210    struct HFSPLUS_INFO hfsinfo;       /* Finder Info and resource fork size */
 211 #endif
 212 };
 213
 214
 215 #include "protos.h"
 216
 217 #endif /* __FILES_H */