Kevin Day's version of the gzip-rsyncable patch.
[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-14 02:45:09
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/options.c      2005-02-20 00:02:23
109 +++ options.c   2005-01-28 19:17:35
110 @@ -119,10 +119,14 @@ int no_detach = 0;
111  int write_batch = 0;
112  int read_batch = 0;
113  int backup_dir_len = 0;
114 +int backup_dir_rm_len = 0;     
115  int backup_suffix_len;
116 +int backup_suffix_rm_len;
117  unsigned int backup_dir_remainder;
118 +unsigned int backup_dir_rm_remainder;
119  
120  char *backup_suffix = NULL;
121 +char *backup_suffix_rm = NULL;
122  char *tmpdir = NULL;
123  char *partial_dir = NULL;
124  char *basis_dir[MAX_BASIS_DIRS+1];
125 @@ -132,7 +136,9 @@ char *log_format = NULL;
126  char *password_file = NULL;
127  char *rsync_path = RSYNC_PATH;
128  char *backup_dir = NULL;
129 +char *backup_dir_rm = NULL;
130  char backup_dir_buf[MAXPATHLEN];
131 +char backup_dir_rm_buf[MAXPATHLEN];
132  int rsync_port = 0;
133  int compare_dest = 0;
134  int copy_dest = 0;
135 @@ -263,6 +269,8 @@ void usage(enum logcode F)
136    rprintf(F," -b, --backup                make backups (see --suffix & --backup-dir)\n");
137    rprintf(F,"     --backup-dir=DIR        make backups into hierarchy based in DIR\n");
138    rprintf(F,"     --suffix=SUFFIX         set backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
139 +  rprintf(F,"     --backup-dir-rm         make backups of removed files into current dir\n");
140 +  rprintf(F,"     --backup-suffix-rm=SUF  set removed-files suffix (defaults to --suffix)\n");
141    rprintf(F," -u, --update                skip files that are newer on the receiver\n");
142    rprintf(F,"     --inplace               update destination files in-place (SEE MAN PAGE)\n");
143    rprintf(F," -d, --dirs                  transfer directories without recursing\n");
144 @@ -357,6 +365,7 @@ static struct poptOption long_options[] 
145    /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
146    {"version",          0,  POPT_ARG_NONE,   0, OPT_VERSION, 0, 0},
147    {"suffix",           0,  POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
148 +  {"backup-suffix-rm", 0,  POPT_ARG_STRING, &backup_suffix_rm, 0, 0, 0 },
149    {"rsync-path",       0,  POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
150    {"password-file",    0,  POPT_ARG_STRING, &password_file, 0, 0, 0 },
151    {"ignore-times",    'I', POPT_ARG_NONE,   &ignore_times, 0, 0, 0 },
152 @@ -436,6 +445,7 @@ static struct poptOption long_options[] 
153    {"itemize-changes", 'i', POPT_ARG_NONE,   &itemize_changes, 0, 0, 0 },
154    {"bwlimit",          0,  POPT_ARG_INT,    &bwlimit, 0, 0, 0 },
155    {"backup-dir",       0,  POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
156 +  {"backup-dir-rm",    0,  POPT_ARG_STRING, &backup_dir_rm, 0, 0, 0 },
157    {"hard-links",      'H', POPT_ARG_NONE,   &preserve_hard_links, 0, 0, 0 },
158    {"read-batch",       0,  POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
159    {"write-batch",      0,  POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
160 @@ -991,6 +1001,8 @@ int parse_arguments(int *argc, const cha
161                         partial_dir = sanitize_path(NULL, partial_dir, NULL, 0);
162                 if (backup_dir)
163                         backup_dir = sanitize_path(NULL, backup_dir, NULL, 0);
164 +               if (backup_dir_rm)                                                      
165 +                       backup_dir_rm = sanitize_path(NULL, backup_dir_rm, NULL, 0);
166                 if (files_from)
167                         files_from = sanitize_path(NULL, files_from, NULL, 0);
168         }
169 @@ -1023,6 +1035,12 @@ int parse_arguments(int *argc, const cha
170                         if (check_filter(elp, backup_dir, 1) < 0)
171                                 goto options_rejected;
172                 }
173 +               /* Clean backup_dir_rm same as for backup_dir */
174 +               if (backup_dir_rm) {
175 +                       clean_fname(backup_dir_rm, 1);
176 +                       if (check_exclude(elp, backup_dir_rm, 1) < 0)
177 +                               goto options_rejected;
178 +               }
179         }
180         if (server_filter_list.head && files_from) {
181                 if (!*files_from)
182 @@ -1045,6 +1063,16 @@ int parse_arguments(int *argc, const cha
183                         backup_suffix);
184                 return 0;
185         }
186 +       /* if suffix_rm not supplied, default to backup_suffix */
187 +       if (!backup_suffix_rm)
188 +               backup_suffix_rm = backup_dir_rm ? "" : backup_suffix;
189 +       backup_suffix_rm_len = strlen(backup_suffix_rm);
190 +       if (strchr(backup_suffix_rm, '/') != NULL) {
191 +               snprintf(err_buf, sizeof err_buf,
192 +                       "--backup-suffix-rm cannot contain slashes: %s\n",
193 +                       backup_suffix_rm);      
194 +               return 0;
195 +       }
196         if (backup_dir) {
197                 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
198                 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
199 @@ -1066,6 +1094,31 @@ int parse_arguments(int *argc, const cha
200                         "--suffix cannot be a null string without --backup-dir\n");
201                 return 0;
202         }
203 +       /* If backup_dir_rm not supplied default to backup_dir if it has been supplied */
204 +       if (backup_dir && !backup_dir_rm) {
205 +               backup_dir_rm = backup_dir;
206 +               backup_dir_rm_len = backup_dir_len;
207 +               backup_dir_rm_remainder = backup_dir_remainder;
208 +               strlcpy(backup_dir_rm_buf, backup_dir_buf, sizeof backup_dir_buf);
209 +       } else if (backup_dir_rm) {
210 +               backup_dir_rm_len = strlcpy(backup_dir_rm_buf, backup_dir_rm, sizeof backup_dir_rm_buf);
211 +               backup_dir_rm_remainder = sizeof backup_dir_rm_buf - backup_dir_rm_len;
212 +               if (backup_dir_rm_remainder < 32) {
213 +                       snprintf(err_buf, sizeof err_buf,
214 +                               "the --backup-dir-rm path is WAY too long.\n");
215 +                       return 0;
216 +               }
217 +               if (backup_dir_rm_buf[backup_dir_rm_len - 1] != '/') {
218 +                       backup_dir_rm_buf[backup_dir_rm_len++] = '/';
219 +                       backup_dir_rm_buf[backup_dir_rm_len] = '\0';
220 +               }
221 +               if (verbose > 1 && !am_sender)
222 +                       rprintf(FINFO, "backup_dir_rm is %s\n", backup_dir_rm_buf);
223 +       } else if (!backup_suffix_rm_len && (!am_server || !am_sender)) {
224 +               snprintf(err_buf, sizeof err_buf,
225 +                       "--backup-suffix-rm cannot be a null string without --backup-dir-rm\n");
226 +               return 0;
227 +       }
228  
229         if (log_format) {
230                 if (strstr(log_format, "%i") != NULL)
231 @@ -1329,6 +1382,10 @@ void server_options(char **args,int *arg
232                 args[ac++] = "--backup-dir";
233                 args[ac++] = backup_dir;
234         }
235 +       if (backup_dir_rm) {
236 +               args[ac++] = "--backup-dir-rm";
237 +               args[ac++] = backup_dir_rm;
238 +       }
239  
240         /* Only send --suffix if it specifies a non-default value. */
241         if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
242 @@ -1337,7 +1394,13 @@ void server_options(char **args,int *arg
243                         goto oom;
244                 args[ac++] = arg;
245         }
246 -
247 +       /* Only send --backup-suffix-rm if it specifies a non-default value. */
248 +       if (strcmp(backup_suffix_rm, backup_dir_rm ? "" : BACKUP_SUFFIX) != 0) {
249 +               /* We use the following syntax to avoid weirdness with '~'. */
250 +               if (asprintf(&arg, "--backup-suffix-rm=%s", backup_suffix_rm) < 0)
251 +                       goto oom;
252 +               args[ac++] = arg;
253 +       }
254         if (am_sender) {
255                 if (delete_excluded)
256                         args[ac++] = "--delete-excluded";
257 --- orig/rsync.c        2005-02-20 00:02:23
258 +++ rsync.c     2005-02-20 00:05:49
259 @@ -44,12 +44,19 @@ extern char *backup_dir;
260  extern char *log_format;
261  extern char *backup_suffix;
262  extern int backup_suffix_len;
263 +extern char *backup_dir_rm;
264 +extern char *backup_suffix_rm;
265 +extern int backup_suffix_rm_len;
266  
267  
268 +/* Function now checks if file matches backup or delete suffix patterns */
269  static int is_backup_file(char *fn)
270  {
271         int k = strlen(fn) - backup_suffix_len;
272 -       return k > 0 && strcmp(fn+k, backup_suffix) == 0;
273 +       if (k > 0 && strcmp(fn+k, backup_suffix) == 0)
274 +               return 1;
275 +       k += backup_suffix_len - backup_suffix_rm_len;
276 +       return k > 0 && strcmp(fn+k, backup_suffix_rm) == 0;
277  }
278  
279  
280 @@ -82,8 +89,9 @@ int delete_file(char *fname, int mode, i
281  
282         if (!S_ISDIR(mode)) {
283                 int ok;
284 -               if (make_backups && (backup_dir || !is_backup_file(fname)))
285 -                       ok = make_backup(fname);
286 +               int backup_file = is_backup_file(f);
287 +               if (make_backups && (backup_dir_rm || !backup_file))
288 +                       ok = safe_delete(fname);
289                 else
290                         ok = robust_unlink(fname) == 0;
291                 if (ok) {