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
  90 struct s_included_file {
  91    struct s_included_file *next;
  92    uint32_t options;                  /* backup options */
  93    int level;                         /* compression level */
  94    int len;                           /* length of fname */
  95    int pattern;                       /* set if wild card pattern */
  96    char VerifyOpts[20];               /* Options for verify */
  97    char fname[1];
  98 };
  99
 100 struct s_excluded_file {
 101    struct s_excluded_file *next;
 102    int len;
 103    char fname[1];
 104 };
 105
 106 /* FileSet definitions very similar to the resource
 107  *  contained in the Director because the components
 108  *  of the structure are passed by the Director to the
 109  *  File daemon and recompiled back into this structure
 110  */
 111 #undef  MAX_FOPTS
 112 #define MAX_FOPTS 30
 113
 114 enum {
 115    state_none,
 116    state_options,
 117    state_include,
 118    state_error
 119 };
 120
 121 /* File options structure */
 122 struct findFOPTS {
 123    uint32_t flags;                    /* options in bits */
 124    int GZIP_level;                    /* GZIP level */
 125    char VerifyOpts[MAX_FOPTS];        /* verify options */
 126    alist regex;                       /* regex string(s) */
 127    alist regexdir;                    /* regex string(s) for directories */
 128    alist regexfile;                   /* regex string(s) for files */
 129    alist wild;                        /* wild card strings */
 130    alist wilddir;                     /* wild card strings for directories */
 131    alist wildfile;                    /* wild card strings for files */
 132    alist base;                        /* list of base names */
 133    alist fstype;                      /* file system type limitation */
 134    char *reader;                      /* reader program */
 135    char *writer;                      /* writer program */
 136 };
 137
 138
 139 /* This is either an include item or an exclude item */
 140 struct findINCEXE {
 141    findFOPTS *current_opts;           /* points to current options structure */
 142    alist opts_list;                   /* options list */
 143    alist name_list;                   /* filename list -- holds char * */
 144 };
 145
 146 /*
 147  *   FileSet Resource
 148  *
 149  */
 150 struct findFILESET {
 151    int state;
 152    findINCEXE *incexe;                /* current item */
 153    alist include_list;
 154    alist exclude_list;
 155 };
 156
 157 #ifdef HAVE_DARWIN_OS
 158 struct HFSPLUS_INFO {
 159    unsigned long length;              /* Mandatory field */
 160    char fndrinfo[32];                 /* Finder Info */
 161    off_t rsrclength;                  /* Size of resource fork */
 162 };
 163 #endif
 164
 165 /*
 166  * Definition of the find_files packet passed as the
 167  * first argument to the find_files callback subroutine.
 168  */
 169 struct FF_PKT {
 170    char *fname;                       /* filename */
 171    char *link;                        /* link if file linked */
 172    POOLMEM *sys_fname;                /* system filename */
 173    struct stat statp;                 /* stat packet */
 174    int32_t FileIndex;                 /* FileIndex of this file */
 175    int32_t LinkFI;                    /* FileIndex of main hard linked file */
 176    struct f_link *linked;             /* Set if this file is hard linked */
 177    int type;                          /* FT_ type from above */
 178    int ff_errno;                      /* errno */
 179    BFILE bfd;                         /* Bacula file descriptor */
 180    time_t save_time;                  /* start of incremental time */
 181    bool dereference;                  /* follow links (not implemented) */
 182    bool null_output_device;           /* using null output device */
 183    bool incremental;                  /* incremental save */
 184    char VerifyOpts[20];
 185    struct s_included_file *included_files_list;
 186    struct s_excluded_file *excluded_files_list;
 187    struct s_excluded_file *excluded_paths_list;
 188    findFILESET *fileset;
 189    int (*callback)(FF_PKT *, void *, bool); /* User's callback */
 190
 191    /* Values set by accept_file while processing Options */
 192    uint32_t flags;                    /* backup options */
 193    int GZIP_level;                    /* compression level */
 194    char *reader;                      /* reader program */
 195    char *writer;                      /* writer program */
 196    alist fstypes;                     /* allowed file system types */
 197
 198    /* List of all hard linked files found */
 199    struct f_link *linklist;           /* hard linked files */
 200
 201    /* Darwin specific things.
 202     * To avoid clutter, we always include rsrc_bfd and volhas_attrlist */
 203    BFILE rsrc_bfd;                    /* fd for resource forks */
 204    bool volhas_attrlist;              /* Volume supports getattrlist() */
 205 #ifdef HAVE_DARWIN_OS
 206    struct HFSPLUS_INFO hfsinfo;       /* Finder Info and resource fork size */
 207 #endif
 208 };
 209
 210
 211 #include "protos.h"
 212
 213 #endif /* __FILES_H */