Moved the code that determines the backup filename into a new function
[rsync/rsync.git] / backup.c
1 /*
2    Copyright (C) Andrew Tridgell 1999
3
4    This program is free software; you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation; either version 2 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program; if not, write to the Free Software
16    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17 */
18
19 /* backup handling code */
20
21 #include "rsync.h"
22
23 extern int verbose;
24 extern int backup_suffix_len;
25 extern int backup_dir_len;
26 extern unsigned int backup_dir_remainder;
27 extern char backup_dir_buf[MAXPATHLEN];
28 extern char *backup_suffix;
29 extern char *backup_dir;
30
31 extern int am_root;
32 extern int preserve_devices;
33 extern int preserve_links;
34 extern int preserve_hard_links;
35 extern int orig_umask;
36 extern int safe_symlinks;
37
38 /* make a complete pathname for backup file */
39 char *get_backup_name(char *fname)
40 {
41         static char fnamebak[MAXPATHLEN];
42
43         if (backup_dir) {
44                 if (stringjoin(backup_dir_buf + backup_dir_len, backup_dir_remainder,
45                                fname, backup_suffix, NULL) < backup_dir_remainder)
46                         return backup_dir_buf;
47         } else {
48                 if (stringjoin(fnamebak, sizeof fnamebak,
49                                fname, backup_suffix, NULL) < sizeof fnamebak)
50                         return fnamebak;
51         }
52
53         rprintf(FERROR, "backup filename too long\n");
54         return NULL;
55 }
56
57 /* simple backup creates a backup with a suffix in the same directory */
58 static int make_simple_backup(char *fname)
59 {
60         char *fnamebak = get_backup_name(fname);
61
62         if (!fnamebak)
63                 return 0;
64
65         if (do_rename(fname, fnamebak) != 0) {
66                 /* cygwin (at least version b19) reports EINVAL */
67                 if (errno != ENOENT && errno != EINVAL) {
68                         rsyserr(FERROR, errno,
69                                 "rename %s to backup %s", fname, fnamebak);
70                         return 0;
71                 }
72         } else if (verbose > 1) {
73                 rprintf(FINFO, "backed up %s to %s\n", fname, fnamebak);
74         }
75         return 1;
76 }
77
78
79 /****************************************************************************
80 Create a directory given an absolute path, perms based upon another directory
81 path
82 ****************************************************************************/
83 static int make_bak_dir(char *fullpath)
84 {
85         STRUCT_STAT st;
86         char *rel = fullpath + backup_dir_len;
87         char *end = rel + strlen(rel);
88         char *p = end;
89
90         while (strncmp(fullpath, "./", 2) == 0)
91                 fullpath += 2;
92
93         /* Try to find an existing dir, starting from the deepest dir. */
94         while (1) {
95                 if (--p == fullpath) {
96                         p += strlen(p);
97                         goto failure;
98                 }
99                 if (*p == '/') {
100                         *p = '\0';
101                         if (do_mkdir(fullpath, 0777 & ~orig_umask) == 0)
102                                 break;
103                         if (errno != ENOENT) {
104                                 rsyserr(FERROR, errno,
105                                         "make_bak_dir mkdir %s failed",
106                                         full_fname(fullpath));
107                                 goto failure;
108                         }
109                 }
110         }
111
112         /* Make all the dirs that we didn't find on the way here. */
113         while (1) {
114                 if (p >= rel) {
115                         /* Try to transfer the directory settings of the
116                          * actual dir that the files are coming from. */
117                         if (do_stat(rel, &st) < 0) {
118                                 rsyserr(FERROR, errno,
119                                         "make_bak_dir stat %s failed",
120                                         full_fname(rel));
121                         } else {
122                                 do_lchown(fullpath, st.st_uid, st.st_gid);
123                                 do_chmod(fullpath, st.st_mode);
124                         }
125                 }
126                 *p = '/';
127                 p += strlen(p);
128                 if (p == end)
129                         break;
130                 if (do_mkdir(fullpath, 0777 & ~orig_umask) < 0) {
131                         rsyserr(FERROR, errno, "make_bak_dir mkdir %s failed",
132                                 full_fname(fullpath));
133                         goto failure;
134                 }
135         }
136         return 0;
137
138 failure:
139         while (p != end) {
140                 *p = '/';
141                 p += strlen(p);
142         }
143         return -1;
144 }
145
146 /* robustly move a file, creating new directory structures if necessary */
147 static int robust_move(char *src, char *dst)
148 {
149         if (robust_rename(src, dst, 0755) < 0 && (errno != ENOENT
150             || make_bak_dir(dst) < 0 || robust_rename(src, dst, 0755) < 0))
151                 return -1;
152         return 0;
153 }
154
155
156 /* If we have a --backup-dir, then we get here from make_backup().
157  * We will move the file to be deleted into a parallel directory tree. */
158 static int keep_backup(char *fname)
159 {
160         STRUCT_STAT st;
161         struct file_struct *file;
162         char *buf;
163         int kept = 0;
164         int ret_code;
165
166         /* return if no file to keep */
167 #if SUPPORT_LINKS
168         ret_code = do_lstat(fname, &st);
169 #else
170         ret_code = do_stat(fname, &st);
171 #endif
172         if (ret_code < 0)
173                 return 1;
174
175         if (!(file = make_file(fname, NULL, NO_EXCLUDES)))
176                 return 1; /* the file could have disappeared */
177
178         if (!(buf = get_backup_name(fname)))
179                 return 0;
180
181 #ifdef HAVE_MKNOD
182         /* Check to see if this is a device file, or link */
183         if (IS_DEVICE(file->mode)) {
184                 if (am_root && preserve_devices) {
185                         if (do_mknod(buf, file->mode, file->u.rdev) < 0
186                             && (errno != ENOENT || make_bak_dir(buf) < 0
187                              || do_mknod(buf, file->mode, file->u.rdev) < 0)) {
188                                 rsyserr(FERROR, errno, "mknod %s failed",
189                                         full_fname(buf));
190                         } else if (verbose > 2) {
191                                 rprintf(FINFO,
192                                         "make_backup: DEVICE %s successful.\n",
193                                         fname);
194                         }
195                 }
196                 kept = 1;
197                 do_unlink(fname);
198         }
199 #endif
200
201         if (!kept && S_ISDIR(file->mode)) {
202                 /* make an empty directory */
203                 if (do_mkdir(buf, file->mode) < 0
204                     && (errno != ENOENT || make_bak_dir(buf) < 0
205                      || do_mkdir(buf, file->mode) < 0)) {
206                         rsyserr(FINFO, errno, "mkdir %s failed",
207                                 full_fname(buf));
208                 }
209
210                 ret_code = do_rmdir(fname);
211                 if (verbose > 2) {
212                         rprintf(FINFO, "make_backup: RMDIR %s returns %i\n",
213                                 full_fname(fname), ret_code);
214                 }
215                 kept = 1;
216         }
217
218 #if SUPPORT_LINKS
219         if (!kept && preserve_links && S_ISLNK(file->mode)) {
220                 if (safe_symlinks && unsafe_symlink(file->u.link, buf)) {
221                         if (verbose) {
222                                 rprintf(FINFO, "ignoring unsafe symlink %s -> %s\n",
223                                         full_fname(buf), file->u.link);
224                         }
225                         kept = 1;
226                 }
227                 if (do_symlink(file->u.link, buf) < 0
228                     && (errno != ENOENT || make_bak_dir(buf) < 0
229                      || do_symlink(file->u.link, buf) < 0)) {
230                         rsyserr(FERROR, errno, "link %s -> \"%s\"",
231                                 full_fname(buf), file->u.link);
232                 }
233                 do_unlink(fname);
234                 kept = 1;
235         }
236 #endif
237
238         if (!kept && !S_ISREG(file->mode)) {
239                 rprintf(FINFO, "make_bak: skipping non-regular file %s\n",
240                         fname);
241                 return 1;
242         }
243
244         /* move to keep tree if a file */
245         if (!kept) {
246                 if (robust_move(fname, buf) != 0) {
247                         rsyserr(FERROR, errno, "keep_backup failed: %s -> \"%s\"",
248                                 full_fname(fname), buf);
249                 } else if (st.st_nlink > 1) {
250                         /* If someone has hard-linked the file into the backup
251                          * dir, rename() might return success but do nothing! */
252                         robust_unlink(fname); /* Just in case... */
253                 }
254         }
255         set_perms(buf, file, NULL, 0);
256         free(file);
257
258         if (verbose > 1)
259                 rprintf(FINFO, "keep_backup %s -> %s\n", fname, buf);
260         return 1;
261 }
262
263
264 /* main backup switch routine */
265 int make_backup(char *fname)
266 {
267         if (backup_dir)
268                 return keep_backup(fname);
269         return make_simple_backup(fname);
270 }