Updated patches to work with the latest trunk.
[rsync-patches.git] / 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-dir-dels.diff
19     ./configure                                 (optional if already run)
20     make
21
22 based-on: 25082d1ef6712a15c52a1dacb36b7f0642c23ac8
23 diff --git a/backup.c b/backup.c
24 --- a/backup.c
25 +++ b/backup.c
26 @@ -29,25 +29,32 @@ extern int preserve_specials;
27  extern int preserve_links;
28  extern int safe_symlinks;
29  extern int backup_dir_len;
30 +extern int backup_dir_dels_len;
31  extern unsigned int backup_dir_remainder;
32 +extern unsigned int backup_dir_dels_remainder;
33  extern char backup_dir_buf[MAXPATHLEN];
34 +extern char backup_dir_dels_buf[MAXPATHLEN];
35  extern char *backup_suffix;
36 +extern char *backup_suffix_dels;
37  extern char *backup_dir;
38 +extern char *backup_dir_dels;
39 +
40 +static BOOL deleting;
41  
42  /* Returns -1 on error, 0 on missing dir, and 1 on present dir. */
43 -static int validate_backup_dir(void)
44 +static int validate_backup_dir(const char *buf)
45  {
46         STRUCT_STAT st;
47  
48 -       if (do_lstat(backup_dir_buf, &st) < 0) {
49 +       if (do_lstat(buf, &st) < 0) {
50                 if (errno == ENOENT)
51                         return 0;
52 -               rsyserr(FERROR, errno, "backup lstat %s failed", backup_dir_buf);
53 +               rsyserr(FERROR, errno, "backup lstat %s failed", buf);
54                 return -1;
55         }
56         if (!S_ISDIR(st.st_mode)) {
57                 int flags = get_del_for_flag(st.st_mode) | DEL_FOR_BACKUP | DEL_RECURSE;
58 -               if (delete_item(backup_dir_buf, st.st_mode, flags) == 0)
59 +               if (delete_item(buf, st.st_mode, flags) == 0)
60                         return 0;
61                 return -1;
62         }
63 @@ -58,20 +65,20 @@ static int validate_backup_dir(void)
64   * backup_dir_buf.  Any new directories (compared to the prior backup
65   * path) are ensured to exist as directories, replacing anything else
66   * that may be in the way (e.g. a symlink). */
67 -static BOOL copy_valid_path(const char *fname)
68 +static BOOL copy_valid_path(const char *fname, char *buf, int prefix_len, unsigned int remainder, const char *suffix)
69  {
70         const char *f;
71         int val;
72         BOOL ret = True;
73         stat_x sx;
74 -       char *b, *rel = backup_dir_buf + backup_dir_len, *name = rel;
75 +       char *b, *rel = buf + prefix_len, *name = rel;
76  
77         for (f = fname, b = rel; *f && *f == *b; f++, b++) {
78                 if (*b == '/')
79                         name = b + 1;
80         }
81  
82 -       if (stringjoin(rel, backup_dir_remainder, fname, backup_suffix, NULL) >= backup_dir_remainder) {
83 +       if (stringjoin(rel, remainder, fname, suffix, NULL) >= remainder) {
84                 rprintf(FERROR, "backup filename too long\n");
85                 *name = '\0';
86                 return False;
87 @@ -82,7 +89,7 @@ static BOOL copy_valid_path(const char *fname)
88                         return True;
89                 *b = '\0';
90  
91 -               val = validate_backup_dir();
92 +               val = validate_backup_dir(buf);
93                 if (val == 0)
94                         break;
95                 if (val < 0) {
96 @@ -98,9 +105,9 @@ static BOOL copy_valid_path(const char *fname)
97         for ( ; b; name = b + 1, b = strchr(name, '/')) {
98                 *b = '\0';
99  
100 -               while (mkdir_defmode(backup_dir_buf) < 0) {
101 +               while (mkdir_defmode(buf) < 0) {
102                         if (errno == EEXIST) {
103 -                               val = validate_backup_dir();
104 +                               val = validate_backup_dir(buf);
105                                 if (val > 0)
106                                         break;
107                                 if (val == 0)
108 @@ -134,7 +141,7 @@ static BOOL copy_valid_path(const char *fname)
109                                 free_xattr(&sx);
110                         }
111  #endif
112 -                       set_file_attrs(backup_dir_buf, file, NULL, NULL, 0);
113 +                       set_file_attrs(buf, file, NULL, NULL, 0);
114                         unmake_file(file);
115                 }
116  
117 @@ -156,16 +163,21 @@ static BOOL copy_valid_path(const char *fname)
118  /* Make a complete pathname for backup file and verify any new path elements. */
119  char *get_backup_name(const char *fname)
120  {
121 +       char *buf = deleting ? backup_dir_dels_buf : backup_dir_buf;
122 +       char *suffix = deleting ? backup_suffix_dels : backup_suffix;
123 +
124         if (backup_dir) {
125 +               int prefix_len = deleting ? backup_dir_dels_len : backup_dir_len;
126 +               unsigned int remainder = deleting ? backup_dir_dels_remainder : backup_dir_remainder;
127                 /* copy fname into backup_dir_buf while validating the dirs. */
128 -               if (copy_valid_path(fname))
129 -                       return backup_dir_buf;
130 +               if (copy_valid_path(fname, buf, prefix_len, remainder, suffix))
131 +                       return buf;
132                 /* copy_valid_path() has printed an error message. */
133                 return NULL;
134         }
135  
136 -       if (stringjoin(backup_dir_buf, MAXPATHLEN, fname, backup_suffix, NULL) < MAXPATHLEN)
137 -               return backup_dir_buf;
138 +       if (stringjoin(backup_dir_buf, MAXPATHLEN, fname, suffix, NULL) < MAXPATHLEN)
139 +               return buf;
140  
141         rprintf(FERROR, "backup filename too long\n");
142         return NULL;
143 @@ -339,3 +351,13 @@ int make_backup(const char *fname, BOOL prefer_rename)
144                 rprintf(FINFO, "backed up %s to %s\n", fname, buf);
145         return ret;
146  }
147 +
148 +/* backup switch routine called only when backing-up removed file */
149 +int safe_delete(const char *fname)
150 +{
151 +       int ret;
152 +       deleting = 1;
153 +       ret = make_backup(fname, True);
154 +       deleting = 0;
155 +       return ret;
156 +}
157 diff --git a/delete.c b/delete.c
158 --- a/delete.c
159 +++ b/delete.c
160 @@ -28,6 +28,9 @@ extern int max_delete;
161  extern char *backup_dir;
162  extern char *backup_suffix;
163  extern int backup_suffix_len;
164 +extern char *backup_dir_dels;
165 +extern char *backup_suffix_dels;
166 +extern int backup_suffix_dels_len;
167  extern uid_t our_uid;
168  extern struct stats stats;
169  
170 @@ -35,10 +38,14 @@ 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 @@ -170,9 +177,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 @@ -151,10 +151,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 @@ -166,7 +170,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 @@ -670,6 +676,8 @@ void usage(enum logcode F)
227    rprintf(F," -b, --backup                make backups (see --suffix & --backup-dir)\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 @@ -969,7 +977,9 @@ static struct poptOption long_options[] = {
236    {"backup",          'b', 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 @@ -2006,6 +2016,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 @@ -2027,6 +2039,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 @@ -2038,6 +2058,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                 while (*backup_dir == '.' && backup_dir[1] == '/')
289                         backup_dir += 2;
290 @@ -2071,6 +2105,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_rule(&filter_list, backup_dir_dels_buf, 0, 0);
321 +       }
322  
323         if (make_backups && !backup_dir) {
324                 omit_dir_times = 0; /* Implied, so avoid -O to sender. */
325 @@ -2484,6 +2546,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 @@ -2492,7 +2558,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                 if (max_delete > 0) {
351                         if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)