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