432309a187e283c9d0144f5053c8dea0c34c6efa
[rsync-patches.git] / backup-dir-dels.diff
1 This patches creates two new command line options as follows:
2         --backup-dir-rm
3         --backup-suffix-rm=SUFFIX
4
5 The backup-dir-rm and backup-suffix-rm 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-07 20:41:56
17 +++ backup.c    2004-09-22 02:36:06
18 @@ -22,11 +22,17 @@
19  
20  extern int verbose;
21  extern int backup_suffix_len;
22 +extern int backup_suffix_rm_len;
23  extern int backup_dir_len;
24 +extern int backup_dir_rm_len;
25  extern unsigned int backup_dir_remainder;
26 +extern unsigned int backup_dir_rm_remainder;
27  extern char backup_dir_buf[MAXPATHLEN];
28 +extern char backup_dir_rm_buf[MAXPATHLEN];
29  extern char *backup_suffix;
30 +extern char *backup_suffix_rm;
31  extern char *backup_dir;
32 +extern char *backup_dir_rm;
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,10 +60,27 @@ char *get_backup_name(char *fname)
46         return NULL;
47  }
48  
49 +static char *get_delete_name(char *fname)
50 +{
51 +       if (backup_dir_rm) {
52 +               if (stringjoin(backup_dir_rm_buf + backup_dir_rm_len, backup_dir_rm_remainder,
53 +                              fname, backup_suffix_rm, NULL) < backup_dir_rm_remainder)
54 +                       return backup_dir_rm_buf;
55 +       } else {
56 +               if (stringjoin(backup_dir_rm_buf, MAXPATHLEN,
57 +                              fname, backup_suffix_rm, NULL) < MAXPATHLEN)
58 +                       return backup_dir_rm_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 -       char *fnamebak = get_backup_name(fname);
69 +       char *fnamebak = deleting ? get_delete_name(fname)
70 +                                 : get_backup_name(fname);
71  
72         if (!fnamebak)
73                 return 0;
74 @@ -83,7 +108,8 @@ path
75  static int make_bak_dir(char *fullpath)
76  {
77         STRUCT_STAT st;
78 -       char *rel = fullpath + backup_dir_len;
79 +       int dir_len = deleting ? backup_dir_rm_len : backup_dir_len;
80 +       char *rel = fullpath + dir_len;
81         char *end = rel + strlen(rel);
82         char *p = end;
83  
84 @@ -170,7 +196,8 @@ static int keep_backup(char *fname)
85         if (!(file = make_file(fname, NULL, NO_FILTERS)))
86                 return 1; /* the file could have disappeared */
87  
88 -       if (!(buf = get_backup_name(fname)))
89 +       buf = deleting ? get_delete_name(fname) : get_backup_name(fname);
90 +       if (!buf)
91                 return 0;
92  
93         /* Check to see if this is a device file, or link */
94 @@ -263,3 +290,13 @@ int make_backup(char *fname)
95                 return keep_backup(fname);
96         return make_simple_backup(fname);
97  }
98 +
99 +/* backup switch routine called only when backing-up removed file */
100 +int safe_delete(char *fname)
101 +{
102 +       int ret;
103 +       deleting = 1;
104 +       ret = make_backup(fname);
105 +       deleting = 0;
106 +       return ret;
107 +}
108 --- orig/flist.c        2005-02-13 21:17:16
109 +++ flist.c     2005-01-30 10:11:42
110 @@ -46,6 +46,8 @@ extern char curr_dir[MAXPATHLEN];
111  extern unsigned int curr_dir_len;
112  extern char *backup_dir;
113  extern char *backup_suffix;
114 +extern char *backup_dir_rm;
115 +extern char *backup_suffix_rm;
116  extern int filesfrom_fd;
117  
118  extern int one_file_system;
119 @@ -60,6 +62,7 @@ extern int relative_paths;
120  extern int implied_dirs;
121  extern int make_backups;
122  extern int backup_suffix_len;
123 +extern int backup_suffix_rm_len;
124  extern int copy_links;
125  extern int copy_unsafe_links;
126  extern int protocol_version;
127 @@ -1709,10 +1712,14 @@ char *f_name(struct file_struct *f)
128  }
129  
130  
131 +/* Function now checks if file matches backup or delete suffix patterns */
132  static int is_backup_file(char *fn)
133  {
134         int k = strlen(fn) - backup_suffix_len;
135 -       return k > 0 && strcmp(fn+k, backup_suffix) == 0;
136 +       if (k > 0 && strcmp(fn+k, backup_suffix) == 0)
137 +               return 1;
138 +       k += backup_suffix_len - backup_suffix_rm_len;
139 +       return k > 0 && strcmp(fn+k, backup_suffix_rm) == 0;
140  }
141  
142  
143 @@ -1799,11 +1806,12 @@ void delete_missing(struct file_list *fu
144                 mode = dir_list->files[i]->mode;
145                 if (flist_find(full_list, dir_list->files[i]) < 0) {
146                         char *f = f_name(dir_list->files[i]);
147 -                       if (make_backups && (backup_dir || !is_backup_file(f))
148 +                       int backup_file = is_backup_file(f);
149 +                       if (make_backups && (backup_dir_rm || !backup_file)
150                           && !S_ISDIR(mode)) {
151 -                               make_backup(f);
152 +                               safe_delete(f);
153                                 if (verbose) {
154 -                                       rprintf(FINFO, "deleting %s\n",
155 +                                       rprintf(FINFO, "safe-deleting %s\n",
156                                                 safe_fname(f));
157                                 }
158                         } else if (S_ISDIR(mode))
159 --- orig/options.c      2005-02-13 05:50:28
160 +++ options.c   2005-01-28 19:17:35
161 @@ -118,10 +118,14 @@ int no_detach = 0;
162  int write_batch = 0;
163  int read_batch = 0;
164  int backup_dir_len = 0;
165 +int backup_dir_rm_len = 0;     
166  int backup_suffix_len;
167 +int backup_suffix_rm_len;
168  unsigned int backup_dir_remainder;
169 +unsigned int backup_dir_rm_remainder;
170  
171  char *backup_suffix = NULL;
172 +char *backup_suffix_rm = NULL;
173  char *tmpdir = NULL;
174  char *partial_dir = NULL;
175  char *basis_dir[MAX_BASIS_DIRS+1];
176 @@ -131,7 +135,9 @@ char *log_format = NULL;
177  char *password_file = NULL;
178  char *rsync_path = RSYNC_PATH;
179  char *backup_dir = NULL;
180 +char *backup_dir_rm = NULL;
181  char backup_dir_buf[MAXPATHLEN];
182 +char backup_dir_rm_buf[MAXPATHLEN];
183  int rsync_port = 0;
184  int compare_dest = 0;
185  int copy_dest = 0;
186 @@ -258,6 +264,8 @@ void usage(enum logcode F)
187    rprintf(F," -b, --backup                make backups (see --suffix & --backup-dir)\n");
188    rprintf(F,"     --backup-dir=DIR        make backups into hierarchy based in DIR\n");
189    rprintf(F,"     --suffix=SUFFIX         set backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
190 +  rprintf(F,"     --backup-dir-rm         make backups of removed files into current dir\n");
191 +  rprintf(F,"     --backup-suffix-rm=SUF  set removed-files suffix (defaults to --suffix)\n");
192    rprintf(F," -u, --update                skip files that are newer on the receiver\n");
193    rprintf(F,"     --inplace               update destination files in-place (SEE MAN PAGE)\n");
194    rprintf(F," -d, --dirs                  transfer directories without recursing\n");
195 @@ -350,6 +358,7 @@ static struct poptOption long_options[] 
196    /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
197    {"version",          0,  POPT_ARG_NONE,   0, OPT_VERSION, 0, 0},
198    {"suffix",           0,  POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
199 +  {"backup-suffix-rm", 0,  POPT_ARG_STRING, &backup_suffix_rm, 0, 0, 0 },
200    {"rsync-path",       0,  POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
201    {"password-file",    0,  POPT_ARG_STRING, &password_file, 0, 0, 0 },
202    {"ignore-times",    'I', POPT_ARG_NONE,   &ignore_times, 0, 0, 0 },
203 @@ -427,6 +436,7 @@ static struct poptOption long_options[] 
204    {"log-format",       0,  POPT_ARG_STRING, &log_format, 0, 0, 0 },
205    {"bwlimit",          0,  POPT_ARG_INT,    &bwlimit, 0, 0, 0 },
206    {"backup-dir",       0,  POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
207 +  {"backup-dir-rm",    0,  POPT_ARG_STRING, &backup_dir_rm, 0, 0, 0 },
208    {"hard-links",      'H', POPT_ARG_NONE,   &preserve_hard_links, 0, 0, 0 },
209    {"read-batch",       0,  POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
210    {"write-batch",      0,  POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
211 @@ -968,6 +978,8 @@ int parse_arguments(int *argc, const cha
212                         partial_dir = sanitize_path(NULL, partial_dir, NULL, 0);
213                 if (backup_dir)
214                         backup_dir = sanitize_path(NULL, backup_dir, NULL, 0);
215 +               if (backup_dir_rm)                                                      
216 +                       backup_dir_rm = sanitize_path(NULL, backup_dir_rm, NULL, 0);
217                 if (files_from)
218                         files_from = sanitize_path(NULL, files_from, NULL, 0);
219         }
220 @@ -1000,6 +1012,12 @@ int parse_arguments(int *argc, const cha
221                         if (check_filter(elp, backup_dir, 1) < 0)
222                                 goto options_rejected;
223                 }
224 +               /* Clean backup_dir_rm same as for backup_dir */
225 +               if (backup_dir_rm) {
226 +                       clean_fname(backup_dir_rm, 1);
227 +                       if (check_exclude(elp, backup_dir_rm, 1) < 0)
228 +                               goto options_rejected;
229 +               }
230         }
231         if (server_filter_list.head && files_from) {
232                 if (!*files_from)
233 @@ -1022,6 +1040,16 @@ int parse_arguments(int *argc, const cha
234                         backup_suffix);
235                 return 0;
236         }
237 +       /* if suffix_rm not supplied, default to backup_suffix */
238 +       if (!backup_suffix_rm)
239 +               backup_suffix_rm = backup_dir_rm ? "" : backup_suffix;
240 +       backup_suffix_rm_len = strlen(backup_suffix_rm);
241 +       if (strchr(backup_suffix_rm, '/') != NULL) {
242 +               snprintf(err_buf, sizeof err_buf,
243 +                       "--backup-suffix-rm cannot contain slashes: %s\n",
244 +                       backup_suffix_rm);      
245 +               return 0;
246 +       }
247         if (backup_dir) {
248                 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
249                 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
250 @@ -1043,6 +1071,31 @@ int parse_arguments(int *argc, const cha
251                         "--suffix cannot be a null string without --backup-dir\n");
252                 return 0;
253         }
254 +       /* If backup_dir_rm not supplied default to backup_dir if it has been supplied */
255 +       if (backup_dir && !backup_dir_rm) {
256 +               backup_dir_rm = backup_dir;
257 +               backup_dir_rm_len = backup_dir_len;
258 +               backup_dir_rm_remainder = backup_dir_remainder;
259 +               strlcpy(backup_dir_rm_buf, backup_dir_buf, sizeof backup_dir_buf);
260 +       } else if (backup_dir_rm) {
261 +               backup_dir_rm_len = strlcpy(backup_dir_rm_buf, backup_dir_rm, sizeof backup_dir_rm_buf);
262 +               backup_dir_rm_remainder = sizeof backup_dir_rm_buf - backup_dir_rm_len;
263 +               if (backup_dir_rm_remainder < 32) {
264 +                       snprintf(err_buf, sizeof err_buf,
265 +                               "the --backup-dir-rm path is WAY too long.\n");
266 +                       return 0;
267 +               }
268 +               if (backup_dir_rm_buf[backup_dir_rm_len - 1] != '/') {
269 +                       backup_dir_rm_buf[backup_dir_rm_len++] = '/';
270 +                       backup_dir_rm_buf[backup_dir_rm_len] = '\0';
271 +               }
272 +               if (verbose > 1 && !am_sender)
273 +                       rprintf(FINFO, "backup_dir_rm is %s\n", backup_dir_rm_buf);
274 +       } else if (!backup_suffix_rm_len && (!am_server || !am_sender)) {
275 +               snprintf(err_buf, sizeof err_buf,
276 +                       "--backup-suffix-rm cannot be a null string without --backup-dir-rm\n");
277 +               return 0;
278 +       }
279  
280         if (do_progress && !verbose) {
281                 if (refused_verbose) {
282 @@ -1279,6 +1332,10 @@ void server_options(char **args,int *arg
283                 args[ac++] = "--backup-dir";
284                 args[ac++] = backup_dir;
285         }
286 +       if (backup_dir_rm) {
287 +               args[ac++] = "--backup-dir-rm";
288 +               args[ac++] = backup_dir_rm;
289 +       }
290  
291         /* Only send --suffix if it specifies a non-default value. */
292         if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
293 @@ -1287,7 +1344,13 @@ void server_options(char **args,int *arg
294                         goto oom;
295                 args[ac++] = arg;
296         }
297 -
298 +       /* Only send --backup-suffix-rm if it specifies a non-default value. */
299 +       if (strcmp(backup_suffix_rm, backup_dir_rm ? "" : BACKUP_SUFFIX) != 0) {
300 +               /* We use the following syntax to avoid weirdness with '~'. */
301 +               if (asprintf(&arg, "--backup-suffix-rm=%s", backup_suffix_rm) < 0)
302 +                       goto oom;
303 +               args[ac++] = arg;
304 +       }
305         if (am_sender) {
306                 if (delete_excluded)
307                         args[ac++] = "--delete-excluded";