git.sur5r.net Git - bacula/bacula/blob - bacula/src/findlib/find_one.c

   1 /*
   2    Copyright (C) 2000-2003 Kern Sibbald and John Walker
   3
   4    This program is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU General Public License as
   6    published by the Free Software Foundation; either version 2 of
   7    the License, or (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12    General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public
  15    License along with this program; if not, write to the Free
  16    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  17    MA 02111-1307, USA.
  18
  19    This file is based on GNU TAR source code. Except for a few key
  20    ideas, it has been rewritten for Bacula.
  21
  22       Kern Sibbald, MM
  23
  24    Thanks to the TAR programmers.
  25
  26  */
  27
  28 #include "bacula.h"
  29 #include "find.h"
  30
  31 extern int32_t name_max;              /* filename max length */
  32 extern int32_t path_max;              /* path name max length */
  33
  34 /*
  35  * Structure for keeping track of hard linked files, we
  36  *   keep an entry for each hardlinked file that we save,
  37  *   which is the first one found. For all the other files that
  38  *   are linked to this one, we save only the directory
  39  *   entry so we can link it.
  40  */
  41 struct f_link {
  42     struct f_link *next;
  43     dev_t dev;                        /* device */
  44     ino_t ino;                        /* inode with device is unique */
  45     short linkcount;
  46     uint32_t FileIndex;               /* Bacula FileIndex of this file */
  47     char name[1];                     /* The name */
  48 };
  49
  50 static void free_dir_ff_pkt(FF_PKT *dir_ff_pkt)
  51 {
  52    free(dir_ff_pkt->fname);
  53    free(dir_ff_pkt->link);
  54    free_pool_memory(dir_ff_pkt->sys_fname);
  55    free(dir_ff_pkt);
  56 }
  57
  58 /*
  59  * Find a single file.
  60  * handle_file is the callback for handling the file.
  61  * p is the filename
  62  * parent_device is the device we are currently on
  63  * top_level is 1 when not recursing or 0 when
  64  *  decending into a directory.
  65  */
  66 int
  67 find_one_file(JCR *jcr, FF_PKT *ff_pkt, int handle_file(FF_PKT *ff, void *hpkt),
  68                void *pkt, char *fname, dev_t parent_device, int top_level)
  69 {
  70    struct utimbuf restore_times;
  71    int rtn_stat;
  72
  73    ff_pkt->fname = ff_pkt->link = fname;
  74
  75    if (lstat(fname, &ff_pkt->statp) != 0) {
  76        /* Cannot stat file */
  77        ff_pkt->type = FT_NOSTAT;
  78        ff_pkt->ff_errno = errno;
  79        return handle_file(ff_pkt, pkt);
  80    }
  81
  82    Dmsg1(300, "File ----: %s\n", fname);
  83
  84    /* Save current times of this directory in case we need to
  85     * reset them because the user doesn't want them changed.
  86     */
  87    restore_times.actime = ff_pkt->statp.st_atime;
  88    restore_times.modtime = ff_pkt->statp.st_mtime;
  89
  90
  91    /*
  92     * If this is an Incremental backup, see if file was modified
  93     * since our last "save_time", presumably the last Full save
  94     * or Incremental.
  95     */
  96    if (ff_pkt->incremental && !S_ISDIR(ff_pkt->statp.st_mode)) {
  97       Dmsg1(300, "Non-directory incremental: %s\n", ff_pkt->fname);
  98       /* Not a directory */
  99       if (ff_pkt->statp.st_mtime < ff_pkt->save_time
 100           && ((ff_pkt->flags & FO_MTIMEONLY) ||
 101               ff_pkt->statp.st_ctime < ff_pkt->save_time)) {
 102          /* Incremental option, file not changed */
 103          ff_pkt->type = FT_NOCHG;
 104          return handle_file(ff_pkt, pkt);
 105       }
 106    }
 107
 108 /* ***FIXME*** implement this */
 109 #if xxxxxxx
 110    /* See if we are trying to dump the archive.  */
 111    if (ar_dev && ff_pkt->statp.st_dev == ar_dev && ff_pkt->statp.st_ino == ar_ino) {
 112        ff_pkt->type = FT_ISARCH;
 113        return handle_file(ff_pkt, pkt);
 114    }
 115 #endif
 116    ff_pkt->LinkFI = 0;
 117    /*
 118     * Handle hard linked files
 119     *
 120     * Maintain a list of hard linked files already backed up. This
 121     *  allows us to ensure that the data of each file gets backed
 122     *  up only once.
 123     */
 124    if (ff_pkt->statp.st_nlink > 1
 125        && (S_ISREG(ff_pkt->statp.st_mode)
 126            || S_ISCHR(ff_pkt->statp.st_mode)
 127            || S_ISBLK(ff_pkt->statp.st_mode)
 128            || S_ISFIFO(ff_pkt->statp.st_mode)
 129            || S_ISSOCK(ff_pkt->statp.st_mode))) {
 130
 131        struct f_link *lp;
 132
 133       /* Search link list of hard linked files */
 134       for (lp = ff_pkt->linklist; lp; lp = lp->next)
 135          if (lp->ino == ff_pkt->statp.st_ino && lp->dev == ff_pkt->statp.st_dev) {
 136              /* If we have already backed up the hard linked file don't do it again */
 137              if (strcmp(lp->name, fname) == 0) {
 138                 Jmsg0(jcr, M_WARNING, 0, _("Attempt to backup hard linked file %s twice ignored.\n"));
 139                 return 1;             /* ignore */
 140              }
 141              ff_pkt->link = lp->name;
 142              ff_pkt->type = FT_LNKSAVED;       /* Handle link, file already saved */
 143              ff_pkt->LinkFI = lp->FileIndex;
 144              return handle_file(ff_pkt, pkt);
 145          }
 146
 147       /* File not previously dumped. Chain it into our list. */
 148       lp = (struct f_link *)bmalloc(sizeof(struct f_link) + strlen(fname) +1);
 149       lp->ino = ff_pkt->statp.st_ino;
 150       lp->dev = ff_pkt->statp.st_dev;
 151       strcpy(lp->name, fname);
 152       lp->next = ff_pkt->linklist;
 153       ff_pkt->linklist = lp;
 154       ff_pkt->linked = lp;            /* mark saved link */
 155    } else {
 156       ff_pkt->linked = NULL;
 157    }
 158
 159    /* This is not a link to a previously dumped file, so dump it.  */
 160    if (S_ISREG(ff_pkt->statp.st_mode)) {
 161       off_t sizeleft;
 162
 163       sizeleft = ff_pkt->statp.st_size;
 164
 165       /* Don't bother opening empty, world readable files.  Also do not open
 166          files when archive is meant for /dev/null.  */
 167       if (ff_pkt->null_output_device || (sizeleft == 0
 168               && MODE_RALL == (MODE_RALL & ff_pkt->statp.st_mode))) {
 169          ff_pkt->type = FT_REGE;
 170       } else {
 171          ff_pkt->type = FT_REG;
 172       }
 173       rtn_stat = handle_file(ff_pkt, pkt);
 174       if (ff_pkt->linked) {
 175          ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
 176       }
 177       return rtn_stat;
 178
 179
 180    } else if (S_ISLNK(ff_pkt->statp.st_mode)) {  /* soft link */
 181       int size;
 182       char *buffer = (char *)alloca(path_max + name_max + 102);
 183
 184       size = readlink(fname, buffer, path_max + name_max + 101);
 185       if (size < 0) {
 186          /* Could not follow link */
 187          ff_pkt->type = FT_NOFOLLOW;
 188          ff_pkt->ff_errno = errno;
 189          rtn_stat = handle_file(ff_pkt, pkt);
 190          if (ff_pkt->linked) {
 191             ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
 192          }
 193          return rtn_stat;
 194       }
 195       buffer[size] = 0;
 196       ff_pkt->link = buffer;          /* point to link */
 197       ff_pkt->type = FT_LNK;          /* got a real link */
 198       rtn_stat = handle_file(ff_pkt, pkt);
 199       if (ff_pkt->linked) {
 200          ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
 201       }
 202       return rtn_stat;
 203
 204    } else if (S_ISDIR(ff_pkt->statp.st_mode)) {
 205       DIR *directory;
 206       struct dirent *entry, *result;
 207       char *link;
 208       int link_len;
 209       int len;
 210       int status;
 211       dev_t our_device = ff_pkt->statp.st_dev;
 212
 213       /*
 214        * If we are using Win32 (non-portable) backup API, don't check
 215        *  access as everything is more complicated, and
 216        *  in principle, we should be able to access everything.
 217        */
 218       if (!have_win32_api() || (ff_pkt->flags & FO_PORTABLE)) {
 219          if (access(fname, R_OK) == -1 && geteuid() != 0) {
 220             /* Could not access() directory */
 221             ff_pkt->type = FT_NOACCESS;
 222             ff_pkt->ff_errno = errno;
 223             rtn_stat = handle_file(ff_pkt, pkt);
 224             if (ff_pkt->linked) {
 225                ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
 226             }
 227             return rtn_stat;
 228          }
 229       }
 230
 231       /* Build a canonical directory name with a trailing slash in link var */
 232       len = strlen(fname);
 233       link_len = len + 200;
 234       link = (char *)bmalloc(link_len + 2);
 235       bstrncpy(link, fname, link_len);
 236       /* Strip all trailing slashes */
 237       while (len >= 1 && link[len - 1] == '/')
 238         len--;
 239       link[len++] = '/';             /* add back one */
 240       link[len] = 0;
 241
 242       ff_pkt->link = link;
 243       if (ff_pkt->incremental &&
 244           (ff_pkt->statp.st_mtime < ff_pkt->save_time &&
 245            ff_pkt->statp.st_ctime < ff_pkt->save_time)) {
 246          /* Incremental option, directory entry not changed */
 247          ff_pkt->type = FT_DIRNOCHG;
 248       } else {
 249          ff_pkt->type = FT_DIR;
 250       }
 251
 252       /*
 253        * Create a temporary ff packet for this directory
 254        *   entry, and defer handling the directory until
 255        *   we have recursed into it.  This saves the
 256        *   directory after all files have been processed, and
 257        *   during the restore, the directory permissions will
 258        *   be reset after all the files have been restored.
 259        */
 260       Dmsg1(300, "Create temp ff packet for dir: %s\n", ff_pkt->fname);
 261       FF_PKT *dir_ff_pkt = (FF_PKT *)bmalloc(sizeof(FF_PKT));
 262       memcpy(dir_ff_pkt, ff_pkt, sizeof(FF_PKT));
 263       dir_ff_pkt->fname = bstrdup(ff_pkt->fname);
 264       dir_ff_pkt->link = bstrdup(ff_pkt->link);
 265       dir_ff_pkt->sys_fname = get_pool_memory(PM_FNAME);
 266       dir_ff_pkt->included_files_list = NULL;
 267       dir_ff_pkt->excluded_files_list = NULL;
 268       dir_ff_pkt->excluded_paths_list = NULL;
 269       dir_ff_pkt->linklist = NULL;
 270
 271       ff_pkt->link = ff_pkt->fname;     /* reset "link" */
 272
 273       /*
 274        * Do not decend into subdirectories (recurse) if the
 275        * user has turned it off for this directory.
 276        */
 277       if (ff_pkt->flags & FO_NO_RECURSION) {
 278          /* No recursion into this directory */
 279          ff_pkt->type = FT_NORECURSE;
 280          rtn_stat = handle_file(ff_pkt, pkt);
 281          if (ff_pkt->linked) {
 282             ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
 283          }
 284          free(link);
 285          free_dir_ff_pkt(dir_ff_pkt);
 286          return rtn_stat;
 287       }
 288
 289       /*
 290        * See if we are crossing file systems, and
 291        * avoid doing so if the user only wants to dump one file system.
 292        */
 293       if (!top_level && !(ff_pkt->flags & FO_MULTIFS) &&
 294            parent_device != ff_pkt->statp.st_dev) {
 295          /* returning here means we do not handle this directory */
 296          ff_pkt->type = FT_NOFSCHG;
 297          rtn_stat = handle_file(ff_pkt, pkt);
 298          if (ff_pkt->linked) {
 299             ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
 300          }
 301          free(link);
 302          free_dir_ff_pkt(dir_ff_pkt);
 303          return rtn_stat;
 304       }
 305       /*
 306        * Decend into or "recurse" into the directory to read
 307        *   all the files in it.
 308        */
 309       errno = 0;
 310       if ((directory = opendir(fname)) == NULL) {
 311          ff_pkt->type = FT_NOOPEN;
 312          ff_pkt->ff_errno = errno;
 313          rtn_stat = handle_file(ff_pkt, pkt);
 314          if (ff_pkt->linked) {
 315             ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
 316          }
 317          free(link);
 318          free_dir_ff_pkt(dir_ff_pkt);
 319          return rtn_stat;
 320       }
 321
 322       /*
 323        * Process all files in this directory entry (recursing).
 324        *    This would possibly run faster if we chdir to the directory
 325        *    before traversing it.
 326        */
 327       rtn_stat = 1;
 328       entry = (struct dirent *)malloc(sizeof(struct dirent) + name_max + 100);
 329       for ( ; !job_canceled(jcr); ) {
 330          char *p, *q;
 331          int i;
 332
 333          status  = readdir_r(directory, entry, &result);
 334          if (status != 0 || result == NULL) {
 335 //          Dmsg2(99, "readdir returned stat=%d result=0x%x\n",
 336 //             status, (long)result);
 337             break;
 338          }
 339          ASSERT(name_max+1 > (int)sizeof(struct dirent) + (int)NAMELEN(entry));
 340          p = entry->d_name;
 341          /* Skip `.', `..', and excluded file names.  */
 342          if (p[0] == '\0' || (p[0] == '.' && (p[1] == '\0' ||
 343              (p[1] == '.' && p[2] == '\0')))) {
 344             continue;
 345          }
 346
 347          if ((int)NAMELEN(entry) + len >= link_len) {
 348              link_len = len + NAMELEN(entry) + 1;
 349              link = (char *)brealloc(link, link_len + 1);
 350          }
 351          q = link + len;
 352          for (i=0; i < (int)NAMELEN(entry); i++) {
 353             *q++ = *p++;
 354          }
 355          *q = 0;
 356          if (!file_is_excluded(ff_pkt, link)) {
 357             rtn_stat = find_one_file(jcr, ff_pkt, handle_file, pkt, link, our_device, 0);
 358             if (ff_pkt->linked) {
 359                ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
 360             }
 361          }
 362       }
 363       closedir(directory);
 364       free(link);
 365       free(entry);
 366
 367       /*
 368        * Now that we have recursed through all the files in the
 369        *  directory, we "save" the directory so that after all
 370        *  the files are restored, this entry will serve to reset
 371        *  the directory modes and dates.  Temp directory values
 372        *  were used without this record.
 373        */
 374       handle_file(dir_ff_pkt, pkt);       /* handle directory entry */
 375       if (ff_pkt->linked) {
 376          ff_pkt->linked->FileIndex = dir_ff_pkt->FileIndex;
 377       }
 378       free_dir_ff_pkt(dir_ff_pkt);
 379
 380       if (ff_pkt->flags & FO_KEEPATIME) {
 381          utime(fname, &restore_times);
 382       }
 383       return rtn_stat;
 384    } /* end check for directory */
 385
 386    /*
 387     * If it is explicitly mentioned (i.e. top_level) and is
 388     *  a block device, we do a raw backup of it or if it is
 389     *  a fifo, we simply read it.
 390     */
 391 #ifdef HAVE_FREEBSD_OS
 392    /*
 393     * On FreeBSD, all block devices are character devices, so
 394     *   to be able to read a raw disk, we need the check for
 395     *   a character device.
 396     * crw-r-----  1 root  operator  - 116, 0x00040002 Jun  9 19:32 /dev/ad0s3
 397     * crw-r-----  1 root  operator  - 116, 0x00040002 Jun  9 19:32 /dev/rad0s3
 398     */
 399    if (top_level && (S_ISBLK(ff_pkt->statp.st_mode) || S_ISCHR(ff_pkt->statp.st_mode))) {
 400 #else
 401    if (top_level && S_ISBLK(ff_pkt->statp.st_mode)) {
 402 #endif
 403       ff_pkt->type = FT_RAW;          /* raw partition */
 404    } else if (top_level && S_ISFIFO(ff_pkt->statp.st_mode) &&
 405               ff_pkt->flags & FO_READFIFO) {
 406       ff_pkt->type = FT_FIFO;
 407    } else {
 408       /* The only remaining types are special (character, ...) files */
 409       ff_pkt->type = FT_SPEC;
 410    }
 411    rtn_stat = handle_file(ff_pkt, pkt);
 412    if (ff_pkt->linked) {
 413       ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
 414    }
 415    return rtn_stat;
 416 }
 417
 418 int term_find_one(FF_PKT *ff)
 419 {
 420    struct f_link *lp, *lc;
 421    int count = 0;
 422
 423    /* Free up list of hard linked files */
 424    for (lp = ff->linklist; lp;) {
 425       lc = lp;
 426       lp = lp->next;
 427       if (lc) {
 428          free(lc);
 429          count++;
 430       }
 431    }
 432    return count;
 433 }