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