backup-dir-dels.diff

   1 This patches creates two new command line options as follows:
   2         --backup-dir-dels=DIR
   3         --suffix-dels=SUFFIX
   4
   5 The backup-dir-dels and suffix-dels options give the ability to store
   6 backup of removed files on the receiver in different directories or with
   7 different suffix than the backup of files that have been changed but that
   8 are still on the source drive.  Both commands can be combined.
   9
  10 The default behaviour if one or both of the options are not specified
  11 is the previous behaviour, both backups use the same directory or
  12 suffix.
  13
  14 Marc St-Onge
  15
  16 To use this patch, run these commands for a successful build:
  17
  18     patch -p1 <patches/backup-deleted.diff
  19     patch -p1 <patches/backup-dir-dels.diff
  20     ./configure                                 (optional if already run)
  21     make
  22
  23 based-on: patch/master/backup-deleted
  24 diff --git a/backup.c b/backup.c
  25 --- a/backup.c
  26 +++ b/backup.c
  27 @@ -29,25 +29,32 @@ extern int preserve_specials;
  28  extern int preserve_links;
  29  extern int safe_symlinks;
  30  extern int backup_dir_len;
  31 +extern int backup_dir_dels_len;
  32  extern unsigned int backup_dir_remainder;
  33 +extern unsigned int backup_dir_dels_remainder;
  34  extern char backup_dir_buf[MAXPATHLEN];
  35 +extern char backup_dir_dels_buf[MAXPATHLEN];
  36  extern char *backup_suffix;
  37 +extern char *backup_suffix_dels;
  38  extern char *backup_dir;
  39 +extern char *backup_dir_dels;
  40 +
  41 +static BOOL deleting;
  42
  43  /* Returns -1 on error, 0 on missing dir, and 1 on present dir. */
  44 -static int validate_backup_dir(void)
  45 +static int validate_backup_dir(char *buf)
  46  {
  47         STRUCT_STAT st;
  48
  49 -       if (do_lstat(backup_dir_buf, &st) < 0) {
  50 +       if (do_lstat(buf, &st) < 0) {
  51                 if (errno == ENOENT)
  52                         return 0;
  53 -               rsyserr(FERROR, errno, "backup lstat %s failed", backup_dir_buf);
  54 +               rsyserr(FERROR, errno, "backup lstat %s failed", buf);
  55                 return -1;
  56         }
  57         if (!S_ISDIR(st.st_mode)) {
  58                 int flags = get_del_for_flag(st.st_mode) | DEL_FOR_BACKUP | DEL_RECURSE;
  59 -               if (delete_item(backup_dir_buf, st.st_mode, flags) == 0)
  60 +               if (delete_item(buf, st.st_mode, flags) == 0)
  61                         return 0;
  62                 return -1;
  63         }
  64 @@ -58,20 +65,20 @@ static int validate_backup_dir(void)
  65   * backup_dir_buf.  Any new directories (compared to the prior backup
  66   * path) are ensured to exist as directories, replacing anything else
  67   * that may be in the way (e.g. a symlink). */
  68 -static BOOL copy_valid_path(const char *fname)
  69 +static BOOL copy_valid_path(const char *fname, char *buf, int prefix_len, unsigned int remainder, const char *suffix)
  70  {
  71         const char *f;
  72         int val;
  73         BOOL ret = True;
  74         stat_x sx;
  75 -       char *b, *rel = backup_dir_buf + backup_dir_len, *name = rel;
  76 +       char *b, *rel = buf + prefix_len, *name = rel;
  77
  78         for (f = fname, b = rel; *f && *f == *b; f++, b++) {
  79                 if (*b == '/')
  80                         name = b + 1;
  81         }
  82
  83 -       if (stringjoin(rel, backup_dir_remainder, fname, backup_suffix, NULL) >= backup_dir_remainder) {
  84 +       if (stringjoin(rel, remainder, fname, suffix, NULL) >= remainder) {
  85                 rprintf(FERROR, "backup filename too long\n");
  86                 *name = '\0';
  87                 return False;
  88 @@ -82,7 +89,7 @@ static BOOL copy_valid_path(const char *fname)
  89                         return True;
  90                 *b = '\0';
  91
  92 -               val = validate_backup_dir();
  93 +               val = validate_backup_dir(buf);
  94                 if (val == 0)
  95                         break;
  96                 if (val < 0) {
  97 @@ -98,9 +105,9 @@ static BOOL copy_valid_path(const char *fname)
  98         for ( ; b; name = b + 1, b = strchr(name, '/')) {
  99                 *b = '\0';
 100
 101 -               while (do_mkdir(backup_dir_buf, ACCESSPERMS) < 0) {
 102 +               while (do_mkdir(buf, ACCESSPERMS) < 0) {
 103                         if (errno == EEXIST) {
 104 -                               val = validate_backup_dir();
 105 +                               val = validate_backup_dir(buf);
 106                                 if (val > 0)
 107                                         break;
 108                                 if (val == 0)
 109 @@ -134,7 +141,7 @@ static BOOL copy_valid_path(const char *fname)
 110                                 free_xattr(&sx);
 111                         }
 112  #endif
 113 -                       set_file_attrs(backup_dir_buf, file, NULL, NULL, 0);
 114 +                       set_file_attrs(buf, file, NULL, NULL, 0);
 115                         unmake_file(file);
 116                 }
 117
 118 @@ -156,16 +163,21 @@ static BOOL copy_valid_path(const char *fname)
 119  /* Make a complete pathname for backup file and verify any new path elements. */
 120  char *get_backup_name(const char *fname)
 121  {
 122 +       char *buf = deleting ? backup_dir_dels_buf : backup_dir_buf;
 123 +       char *suffix = deleting ? backup_suffix_dels : backup_suffix;
 124 +
 125         if (backup_dir) {
 126 +               int prefix_len = deleting ? backup_dir_dels_len : backup_dir_len;
 127 +               unsigned int remainder = deleting ? backup_dir_dels_remainder : backup_dir_remainder;
 128                 /* copy fname into backup_dir_buf while validating the dirs. */
 129 -               if (copy_valid_path(fname))
 130 -                       return backup_dir_buf;
 131 +               if (copy_valid_path(fname, buf, prefix_len, remainder, suffix))
 132 +                       return buf;
 133                 /* copy_valid_path() has printed an error message. */
 134                 return NULL;
 135         }
 136
 137 -       if (stringjoin(backup_dir_buf, MAXPATHLEN, fname, backup_suffix, NULL) < MAXPATHLEN)
 138 -               return backup_dir_buf;
 139 +       if (stringjoin(backup_dir_buf, MAXPATHLEN, fname, suffix, NULL) < MAXPATHLEN)
 140 +               return buf;
 141
 142         rprintf(FERROR, "backup filename too long\n");
 143         return NULL;
 144 @@ -339,3 +351,13 @@ int make_backup(const char *fname, BOOL prefer_rename)
 145                 rprintf(FINFO, "backed up %s to %s\n", fname, buf);
 146         return ret;
 147  }
 148 +
 149 +/* backup switch routine called only when backing-up removed file */
 150 +int safe_delete(const char *fname)
 151 +{
 152 +       int ret;
 153 +       deleting = 1;
 154 +       ret = make_backup(fname, True);
 155 +       deleting = 0;
 156 +       return ret;
 157 +}
 158 diff --git a/delete.c b/delete.c
 159 --- a/delete.c
 160 +++ b/delete.c
 161 @@ -28,16 +28,23 @@ extern int max_delete;
 162  extern char *backup_dir;
 163  extern char *backup_suffix;
 164  extern int backup_suffix_len;
 165 +extern char *backup_dir_dels;
 166 +extern char *backup_suffix_dels;
 167 +extern int backup_suffix_dels_len;
 168  extern struct stats stats;
 169
 170  int ignore_perishable = 0;
 171  int non_perishable_cnt = 0;
 172  int skipped_deletes = 0;
 173
 174 +/* Function now compares both backup_suffix and backup_suffix_dels. */
 175  static inline int is_backup_file(char *fn)
 176  {
 177         int k = strlen(fn) - backup_suffix_len;
 178 -       return k > 0 && strcmp(fn+k, backup_suffix) == 0;
 179 +       if (k > 0 && strcmp(fn+k, backup_suffix) == 0)
 180 +               return 1;
 181 +       k += backup_suffix_len - backup_suffix_dels_len;
 182 +       return k > 0 && strcmp(fn+k, backup_suffix_dels) == 0;
 183  }
 184
 185  /* The directory is about to be deleted: if DEL_RECURSE is given, delete all
 186 @@ -162,9 +169,9 @@ enum delret delete_item(char *fbuf, uint16 mode, uint16 flags)
 187                 what = "rmdir";
 188                 ok = do_rmdir(fbuf) == 0;
 189         } else {
 190 -               if (make_backups > 0 && !(flags & DEL_FOR_BACKUP) && (backup_dir || !is_backup_file(fbuf))) {
 191 +               if (make_backups > 0 && !(flags & DEL_FOR_BACKUP) && (backup_dir_dels || !is_backup_file(fbuf))) {
 192                         what = "make_backup";
 193 -                       ok = make_backup(fbuf, True);
 194 +                       ok = safe_delete(fbuf);
 195                         if (ok == 2) {
 196                                 what = "unlink";
 197                                 ok = robust_unlink(fbuf) == 0;
 198 diff --git a/options.c b/options.c
 199 --- a/options.c
 200 +++ b/options.c
 201 @@ -153,10 +153,14 @@ int no_detach
 202  int write_batch = 0;
 203  int read_batch = 0;
 204  int backup_dir_len = 0;
 205 +int backup_dir_dels_len = 0;
 206  int backup_suffix_len;
 207 +int backup_suffix_dels_len;
 208  unsigned int backup_dir_remainder;
 209 +unsigned int backup_dir_dels_remainder;
 210
 211  char *backup_suffix = NULL;
 212 +char *backup_suffix_dels = NULL;
 213  char *tmpdir = NULL;
 214  char *partial_dir = NULL;
 215  char *basis_dir[MAX_BASIS_DIRS+1];
 216 @@ -168,7 +172,9 @@ char *stdout_format = NULL;
 217  char *password_file = NULL;
 218  char *rsync_path = RSYNC_PATH;
 219  char *backup_dir = NULL;
 220 +char *backup_dir_dels = NULL;
 221  char backup_dir_buf[MAXPATHLEN];
 222 +char backup_dir_dels_buf[MAXPATHLEN];
 223  char *sockopts = NULL;
 224  char *usermap = NULL;
 225  char *groupmap = NULL;
 226 @@ -682,6 +688,8 @@ void usage(enum logcode F)
 227    rprintf(F,"     --backup-deleted        make backups only of deleted files\n");
 228    rprintf(F,"     --backup-dir=DIR        make backups into hierarchy based in DIR\n");
 229    rprintf(F,"     --suffix=SUFFIX         set backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
 230 +  rprintf(F,"     --backup-dir-dels=DIR   backup removed files into hierarchy based in DIR\n");
 231 +  rprintf(F,"     --suffix-dels=SUFFIX    set removed-files suffix (def. --suffix w/o b-d-d)\n");
 232    rprintf(F," -u, --update                skip files that are newer on the receiver\n");
 233    rprintf(F,"     --inplace               update destination files in-place (SEE MAN PAGE)\n");
 234    rprintf(F,"     --append                append data onto shorter files\n");
 235 @@ -998,7 +1006,9 @@ static struct poptOption long_options[] = {
 236    {"backup-deleted",   0,  POPT_ARG_VAL,    &make_backups, 1, 0, 0 },
 237    {"no-backup",        0,  POPT_ARG_VAL,    &make_backups, 0, 0, 0 },
 238    {"backup-dir",       0,  POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
 239 +  {"backup-dir-dels",  0,  POPT_ARG_STRING, &backup_dir_dels, 0, 0, 0 },
 240    {"suffix",           0,  POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
 241 +  {"suffix-dels",      0,  POPT_ARG_STRING, &backup_suffix_dels, 0, 0, 0 },
 242    {"list-only",        0,  POPT_ARG_VAL,    &list_only, 2, 0, 0 },
 243    {"read-batch",       0,  POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
 244    {"write-batch",      0,  POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
 245 @@ -2091,6 +2101,8 @@ int parse_arguments(int *argc_p, const char ***argv_p)
 246                         tmpdir = sanitize_path(NULL, tmpdir, NULL, 0, SP_DEFAULT);
 247                 if (backup_dir)
 248                         backup_dir = sanitize_path(NULL, backup_dir, NULL, 0, SP_DEFAULT);
 249 +               if (backup_dir_dels)
 250 +                       backup_dir_dels = sanitize_path(NULL, backup_dir_dels, NULL, 0, SP_DEFAULT);
 251         }
 252         if (daemon_filter_list.head && !am_sender) {
 253                 filter_rule_list *elp = &daemon_filter_list;
 254 @@ -2112,6 +2124,14 @@ int parse_arguments(int *argc_p, const char ***argv_p)
 255                         if (check_filter(elp, FLOG, dir, 1) < 0)
 256                                 goto options_rejected;
 257                 }
 258 +               /* Clean backup_dir_dels same as for backup_dir */
 259 +               if (backup_dir_dels) {
 260 +                       if (!*backup_dir_dels)
 261 +                               goto options_rejected;
 262 +                       clean_fname(backup_dir_dels, 1);
 263 +                       if (check_filter(elp, FLOG, backup_dir_dels, 1) < 0)
 264 +                               goto options_rejected;
 265 +               }
 266         }
 267
 268         if (!backup_suffix)
 269 @@ -2123,6 +2143,20 @@ int parse_arguments(int *argc_p, const char ***argv_p)
 270                         backup_suffix);
 271                 return 0;
 272         }
 273 +       /* --suffix-dels defaults to --suffix, or empty for a client given an
 274 +        * explicit --backup-dir-dels (just as --suffix defaults to empty when
 275 +        * a --backup-dir is given).  The second case does not apply to the
 276 +        * server for consistency with server_options, which sends --suffix-dels
 277 +        * to the server iff it differs from --suffix. */
 278 +       if (!backup_suffix_dels)
 279 +               backup_suffix_dels = backup_dir_dels && !am_server ? "" : backup_suffix;
 280 +       backup_suffix_dels_len = strlen(backup_suffix_dels);
 281 +       if (strchr(backup_suffix_dels, '/') != NULL) {
 282 +               snprintf(err_buf, sizeof err_buf,
 283 +                       "--suffix-dels cannot contain slashes: %s\n",
 284 +                       backup_suffix_dels);
 285 +               return 0;
 286 +       }
 287         if (backup_dir) {
 288                 size_t len;
 289                 while (*backup_dir == '.' && backup_dir[1] == '/')
 290 @@ -2158,6 +2192,34 @@ int parse_arguments(int *argc_p, const char ***argv_p)
 291                         "P *%s", backup_suffix);
 292                 parse_filter_str(&filter_list, backup_dir_buf, rule_template(0), 0);
 293         }
 294 +       if (backup_dir_dels) {
 295 +               backup_dir_dels_len = strlcpy(backup_dir_dels_buf, backup_dir_dels, sizeof backup_dir_dels_buf);
 296 +               backup_dir_dels_remainder = sizeof backup_dir_dels_buf - backup_dir_dels_len;
 297 +               if (backup_dir_dels_remainder < 32) {
 298 +                       snprintf(err_buf, sizeof err_buf,
 299 +                               "the --backup-dir-dels path is WAY too long.\n");
 300 +                       return 0;
 301 +               }
 302 +               if (backup_dir_dels_buf[backup_dir_dels_len - 1] != '/') {
 303 +                       backup_dir_dels_buf[backup_dir_dels_len++] = '/';
 304 +                       backup_dir_dels_buf[backup_dir_dels_len] = '\0';
 305 +               }
 306 +               if (INFO_GTE(BACKUP, 1) && !am_sender)
 307 +                       rprintf(FINFO, "backup_dir_dels is %s\n", backup_dir_dels_buf);
 308 +       } else if (backup_dir) {
 309 +               backup_dir_dels = backup_dir;
 310 +               backup_dir_dels_len = backup_dir_len;
 311 +               backup_dir_dels_remainder = backup_dir_remainder;
 312 +               strlcpy(backup_dir_dels_buf, backup_dir_buf, sizeof backup_dir_buf);
 313 +       } else if (!backup_suffix_dels_len && (!am_server || !am_sender)) {
 314 +               snprintf(err_buf, sizeof err_buf,
 315 +                       "--suffix-dels cannot be a null string without --backup-dir-dels\n");
 316 +               return 0;
 317 +       } else if (make_backups && delete_mode && !delete_excluded && !am_server) {
 318 +               snprintf(backup_dir_dels_buf, sizeof backup_dir_dels_buf,
 319 +                       "P *%s", backup_suffix_dels);
 320 +               parse_filter_str(&filter_list, backup_dir_dels_buf, rule_template(0), 0);
 321 +       }
 322
 323         if (preserve_times) {
 324                 preserve_times = PRESERVE_FILE_TIMES;
 325 @@ -2588,6 +2650,10 @@ void server_options(char **args, int *argc_p)
 326                 args[ac++] = "--backup-dir";
 327                 args[ac++] = backup_dir;
 328         }
 329 +       if (backup_dir_dels && backup_dir_dels != backup_dir) {
 330 +               args[ac++] = "--backup-dir-dels";
 331 +               args[ac++] = backup_dir_dels;
 332 +       }
 333
 334         /* Only send --suffix if it specifies a non-default value. */
 335         if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
 336 @@ -2596,7 +2662,14 @@ void server_options(char **args, int *argc_p)
 337                         goto oom;
 338                 args[ac++] = arg;
 339         }
 340 -
 341 +       /* Only send --suffix-dels if it specifies a value different from the
 342 +        * --suffix value, which would normally be used for deletions too. */
 343 +       if (strcmp(backup_suffix_dels, backup_suffix) != 0) {
 344 +               /* We use the following syntax to avoid weirdness with '~'. */
 345 +               if (asprintf(&arg, "--suffix-dels=%s", backup_suffix_dels) < 0)
 346 +                       goto oom;
 347 +               args[ac++] = arg;
 348 +       }
 349         if (am_sender) {
 350                 /* A remote sender just needs the above -b option.
 351                  * A remote receiver will override that with this option. */