36a36495d3ac122f4cf50e8073f76131ca517616
[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 --- orig/backup.c       2005-02-22 01:57:58
17 +++ backup.c    2005-02-22 02:11:15
18 @@ -22,11 +22,17 @@
19  
20  extern int verbose;
21  extern int backup_suffix_len;
22 +extern int backup_suffix_dels_len;
23  extern int backup_dir_len;
24 +extern int backup_dir_dels_len;
25  extern unsigned int backup_dir_remainder;
26 +extern unsigned int backup_dir_dels_remainder;
27  extern char backup_dir_buf[MAXPATHLEN];
28 +extern char backup_dir_dels_buf[MAXPATHLEN];
29  extern char *backup_suffix;
30 +extern char *backup_suffix_dels;
31  extern char *backup_dir;
32 +extern char *backup_dir_dels;
33  
34  extern int am_root;
35  extern int preserve_devices;
36 @@ -35,6 +41,8 @@ extern int preserve_hard_links;
37  extern int orig_umask;
38  extern int safe_symlinks;
39  
40 +static int deleting;
41 +
42  /* make a complete pathname for backup file */
43  char *get_backup_name(char *fname)
44  {
45 @@ -52,11 +60,28 @@ char *get_backup_name(char *fname)
46         return NULL;
47  }
48  
49 +static char *get_delete_name(char *fname)
50 +{
51 +       if (backup_dir_dels) {
52 +               if (stringjoin(backup_dir_dels_buf + backup_dir_dels_len, backup_dir_dels_remainder,
53 +                              fname, backup_suffix_dels, NULL) < backup_dir_dels_remainder)
54 +                       return backup_dir_dels_buf;
55 +       } else {
56 +               if (stringjoin(backup_dir_dels_buf, MAXPATHLEN,
57 +                              fname, backup_suffix_dels, NULL) < MAXPATHLEN)
58 +                       return backup_dir_dels_buf;
59 +       }
60 +
61 +       rprintf(FERROR, "delete filename too long\n");
62 +       return NULL;
63 +}
64 +
65  /* simple backup creates a backup with a suffix in the same directory */
66  static int make_simple_backup(char *fname)
67  {
68         int rename_errno;
69 -       char *fnamebak = get_backup_name(fname);
70 +       char *fnamebak = deleting ? get_delete_name(fname)
71 +                                 : get_backup_name(fname);
72  
73         if (!fnamebak)
74                 return 0;
75 @@ -97,7 +122,8 @@ path
76  static int make_bak_dir(char *fullpath)
77  {
78         STRUCT_STAT st;
79 -       char *rel = fullpath + backup_dir_len;
80 +       int dir_len = deleting ? backup_dir_dels_len : backup_dir_len;
81 +       char *rel = fullpath + dir_len;
82         char *end = rel + strlen(rel);
83         char *p = end;
84  
85 @@ -184,7 +210,8 @@ static int keep_backup(char *fname)
86         if (!(file = make_file(fname, NULL, NO_FILTERS)))
87                 return 1; /* the file could have disappeared */
88  
89 -       if (!(buf = get_backup_name(fname)))
90 +       buf = deleting ? get_delete_name(fname) : get_backup_name(fname);
91 +       if (!buf)
92                 return 0;
93  
94         /* Check to see if this is a device file, or link */
95 @@ -277,3 +304,13 @@ int make_backup(char *fname)
96                 return keep_backup(fname);
97         return make_simple_backup(fname);
98  }
99 +
100 +/* backup switch routine called only when backing-up removed file */
101 +int safe_delete(char *fname)
102 +{
103 +       int ret;
104 +       deleting = 1;
105 +       ret = make_backup(fname);
106 +       deleting = 0;
107 +       return ret;
108 +}
109 --- orig/generator.c    2005-03-30 16:35:08
110 +++ generator.c 2005-03-11 11:22:38
111 @@ -85,6 +85,9 @@ extern dev_t filesystem_dev;
112  extern char *backup_dir;
113  extern char *backup_suffix;
114  extern int backup_suffix_len;
115 +extern char *backup_dir_dels;
116 +extern char *backup_suffix_dels;
117 +extern int backup_suffix_dels_len;
118  extern struct file_list *the_file_list;
119  extern struct filter_list_struct server_filter_list;
120  
121 @@ -93,10 +96,14 @@ int allowed_lull = 0;
122  static int deletion_count = 0; /* used to implement --max-delete */
123  
124  
125 +/* Function now compares both backup_suffix and backup_suffix_dels. */
126  static int is_backup_file(char *fn)
127  {
128         int k = strlen(fn) - backup_suffix_len;
129 -       return k > 0 && strcmp(fn+k, backup_suffix) == 0;
130 +       if (k > 0 && strcmp(fn+k, backup_suffix) == 0)
131 +               return 1;
132 +       k += backup_suffix_len - backup_suffix_dels_len;
133 +       return k > 0 && strcmp(fn+k, backup_suffix_dels) == 0;
134  }
135  
136  
137 @@ -113,8 +120,8 @@ static int delete_item(char *fname, int 
138         if (!S_ISDIR(mode)) {
139                 if (max_delete && ++deletion_count > max_delete)
140                         return 0;
141 -               if (make_backups && (backup_dir || !is_backup_file(fname)))
142 -                       ok = make_backup(fname);
143 +               if (make_backups && (backup_dir_dels || !is_backup_file(fname)))
144 +                       ok = safe_delete(fname);
145                 else
146                         ok = robust_unlink(fname) == 0;
147                 if (ok) {
148 @@ -137,9 +144,9 @@ static int delete_item(char *fname, int 
149             || (dry_run && zap_dir)) {
150                 ok = 0;
151                 errno = ENOTEMPTY;
152 -       } else if (make_backups && !backup_dir && !is_backup_file(fname)
153 +       } else if (make_backups && !backup_dir_dels && !is_backup_file(fname)
154             && !(flags & DEL_FORCE_RECURSE))
155 -               ok = make_backup(fname);
156 +               ok = safe_delete(fname);
157         else
158                 ok = do_rmdir(fname) == 0;
159         if (ok) {
160 --- orig/options.c      2005-03-31 00:24:21
161 +++ options.c   2005-03-01 01:25:39
162 @@ -127,10 +127,14 @@ int no_detach
163  int write_batch = 0;
164  int read_batch = 0;
165  int backup_dir_len = 0;
166 +int backup_dir_dels_len = 0;   
167  int backup_suffix_len;
168 +int backup_suffix_dels_len;
169  unsigned int backup_dir_remainder;
170 +unsigned int backup_dir_dels_remainder;
171  
172  char *backup_suffix = NULL;
173 +char *backup_suffix_dels = NULL;
174  char *tmpdir = NULL;
175  char *partial_dir = NULL;
176  char *basis_dir[MAX_BASIS_DIRS+1];
177 @@ -140,7 +144,9 @@ char *log_format = NULL;
178  char *password_file = NULL;
179  char *rsync_path = RSYNC_PATH;
180  char *backup_dir = NULL;
181 +char *backup_dir_dels = NULL;
182  char backup_dir_buf[MAXPATHLEN];
183 +char backup_dir_dels_buf[MAXPATHLEN];
184  int rsync_port = 0;
185  int compare_dest = 0;
186  int copy_dest = 0;
187 @@ -271,6 +277,8 @@ void usage(enum logcode F)
188    rprintf(F," -b, --backup                make backups (see --suffix & --backup-dir)\n");
189    rprintf(F,"     --backup-dir=DIR        make backups into hierarchy based in DIR\n");
190    rprintf(F,"     --suffix=SUFFIX         set backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
191 +  rprintf(F,"     --backup-dir-dels       make backups of removed files into current dir\n");
192 +  rprintf(F,"     --suffix-dels=SUFFIX    set removed-files suffix (defaults to --suffix)\n");
193    rprintf(F," -u, --update                skip files that are newer on the receiver\n");
194    rprintf(F,"     --inplace               update destination files in-place (SEE MAN PAGE)\n");
195    rprintf(F," -d, --dirs                  transfer directories without recursing\n");
196 @@ -367,6 +375,7 @@ static struct poptOption long_options[] 
197    /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
198    {"version",          0,  POPT_ARG_NONE,   0, OPT_VERSION, 0, 0},
199    {"suffix",           0,  POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
200 +  {"suffix-dels",      0,  POPT_ARG_STRING, &backup_suffix_dels, 0, 0, 0 },
201    {"rsync-path",       0,  POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
202    {"password-file",    0,  POPT_ARG_STRING, &password_file, 0, 0, 0 },
203    {"ignore-times",    'I', POPT_ARG_NONE,   &ignore_times, 0, 0, 0 },
204 @@ -447,6 +456,7 @@ static struct poptOption long_options[] 
205    {"itemize-changes", 'i', POPT_ARG_NONE,   &itemize_changes, 0, 0, 0 },
206    {"bwlimit",          0,  POPT_ARG_INT,    &bwlimit, 0, 0, 0 },
207    {"backup-dir",       0,  POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
208 +  {"backup-dir-dels",  0,  POPT_ARG_STRING, &backup_dir_dels, 0, 0, 0 },
209    {"hard-links",      'H', POPT_ARG_NONE,   &preserve_hard_links, 0, 0, 0 },
210    {"read-batch",       0,  POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
211    {"write-batch",      0,  POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
212 @@ -1008,6 +1018,8 @@ int parse_arguments(int *argc, const cha
213                         partial_dir = sanitize_path(NULL, partial_dir, NULL, 0);
214                 if (backup_dir)
215                         backup_dir = sanitize_path(NULL, backup_dir, NULL, 0);
216 +               if (backup_dir_dels)                                                    
217 +                       backup_dir_dels = sanitize_path(NULL, backup_dir_dels, NULL, 0);
218         }
219         if (server_filter_list.head && !am_sender) {
220                 struct filter_list_struct *elp = &server_filter_list;
221 @@ -1042,6 +1054,14 @@ int parse_arguments(int *argc, const cha
222                                 return 0;
223                         }
224                 }
225 +               /* Clean backup_dir_dels same as for backup_dir */
226 +               if (backup_dir_dels) {
227 +                       if (!*backup_dir_dels)
228 +                               goto options_rejected;
229 +                       clean_fname(backup_dir_dels, 1);
230 +                       if (check_filter(elp, backup_dir_dels, 1) < 0)
231 +                               goto options_rejected;
232 +               }
233         }
234  
235         if (!backup_suffix)
236 @@ -1053,6 +1073,16 @@ int parse_arguments(int *argc, const cha
237                         backup_suffix);
238                 return 0;
239         }
240 +       /* if backup_suffix_dels not supplied, default to backup_suffix */
241 +       if (!backup_suffix_dels)
242 +               backup_suffix_dels = backup_dir_dels ? "" : backup_suffix;
243 +       backup_suffix_dels_len = strlen(backup_suffix_dels);
244 +       if (strchr(backup_suffix_dels, '/') != NULL) {
245 +               snprintf(err_buf, sizeof err_buf,
246 +                       "--suffix-dels cannot contain slashes: %s\n",
247 +                       backup_suffix_dels);    
248 +               return 0;
249 +       }
250         if (backup_dir) {
251                 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
252                 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
253 @@ -1074,6 +1104,31 @@ int parse_arguments(int *argc, const cha
254                         "--suffix cannot be a null string without --backup-dir\n");
255                 return 0;
256         }
257 +       /* If backup_dir_dels not supplied default to backup_dir if it has been supplied */
258 +       if (backup_dir && !backup_dir_dels) {
259 +               backup_dir_dels = backup_dir;
260 +               backup_dir_dels_len = backup_dir_len;
261 +               backup_dir_dels_remainder = backup_dir_remainder;
262 +               strlcpy(backup_dir_dels_buf, backup_dir_buf, sizeof backup_dir_buf);
263 +       } else if (backup_dir_dels) {
264 +               backup_dir_dels_len = strlcpy(backup_dir_dels_buf, backup_dir_dels, sizeof backup_dir_dels_buf);
265 +               backup_dir_dels_remainder = sizeof backup_dir_dels_buf - backup_dir_dels_len;
266 +               if (backup_dir_dels_remainder < 32) {
267 +                       snprintf(err_buf, sizeof err_buf,
268 +                               "the --backup-dir-dels path is WAY too long.\n");
269 +                       return 0;
270 +               }
271 +               if (backup_dir_dels_buf[backup_dir_dels_len - 1] != '/') {
272 +                       backup_dir_dels_buf[backup_dir_dels_len++] = '/';
273 +                       backup_dir_dels_buf[backup_dir_dels_len] = '\0';
274 +               }
275 +               if (verbose > 1 && !am_sender)
276 +                       rprintf(FINFO, "backup_dir_dels is %s\n", backup_dir_dels_buf);
277 +       } else if (!backup_suffix_dels_len && (!am_server || !am_sender)) {
278 +               snprintf(err_buf, sizeof err_buf,
279 +                       "--suffix-dels cannot be a null string without --backup-dir-dels\n");
280 +               return 0;
281 +       }
282         if (make_backups && !backup_dir)
283                 omit_dir_times = 1;
284  
285 @@ -1351,6 +1406,10 @@ void server_options(char **args,int *arg
286                 args[ac++] = "--backup-dir";
287                 args[ac++] = backup_dir;
288         }
289 +       if (backup_dir_dels) {
290 +               args[ac++] = "--backup-dir-dels";
291 +               args[ac++] = backup_dir_dels;
292 +       }
293  
294         /* Only send --suffix if it specifies a non-default value. */
295         if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
296 @@ -1359,7 +1418,13 @@ void server_options(char **args,int *arg
297                         goto oom;
298                 args[ac++] = arg;
299         }
300 -
301 +       /* Only send --suffix-dels if it specifies a non-default value. */
302 +       if (strcmp(backup_suffix_dels, backup_dir_dels ? "" : BACKUP_SUFFIX) != 0) {
303 +               /* We use the following syntax to avoid weirdness with '~'. */
304 +               if (asprintf(&arg, "--suffix-dels=%s", backup_suffix_dels) < 0)
305 +                       goto oom;
306 +               args[ac++] = arg;
307 +       }
308         if (am_sender) {
309                 if (delete_excluded)
310                         args[ac++] = "--delete-excluded";