[rsync/rsync.git] / backup.c

/* 
   Copyright (C) Andrew Tridgell 1999
   
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
   
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
   
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

/* backup handling code */

#include "rsync.h"

extern int verbose;
extern int suffix_specified;
extern char *backup_suffix;
extern char *backup_dir;


extern int am_root;
extern int preserve_devices;
extern int preserve_links;
extern int preserve_hard_links;

/* simple backup creates a backup with a suffix in the same directory */
static int make_simple_backup(char *fname)
{
	char fnamebak[MAXPATHLEN];
	if (strlen(fname) + strlen(backup_suffix) > (MAXPATHLEN-1)) {
		rprintf(FERROR, "backup filename too long\n");
		return 0;
	}

	snprintf(fnamebak, sizeof(fnamebak), "%s%s", fname, backup_suffix);
	if (do_rename(fname, fnamebak) != 0) {
		/* cygwin (at least version b19) reports EINVAL */
		if (errno != ENOENT && errno != EINVAL) {
			rsyserr(FERROR, errno, "rename %s to backup %s", fname, fnamebak);
			return 0;
		}
	} else if (verbose > 1) {
		rprintf(FINFO, "backed up %s to %s\n", fname, fnamebak);
	}
	return 1;
}


/* recursively make a directory path */
static int make_dir(char *name, int mask)
{
	char newdir [MAXPATHLEN];
	char *p, *d;

	/* copy pathname over, look for last '/' */
	for (p = d = newdir; *name; *d++ = *name++)
		if (*name == '/')
			p = d;
	if (p == newdir)
		return 0;
	*p = 0;

	/* make the new directory, if that fails then make its parent */
	while (do_mkdir (newdir, mask) != 0)
		if ((errno != ENOENT) || !make_dir (newdir, mask))
			return 0;

	return 1;
} /* make_dir */


/****************************************************************************
Create a directory given an absolute path, perms based upon another directory
path
****************************************************************************/
static int make_bak_dir(char *fname, char *bak_path)
{
	STRUCT_STAT st;
	STRUCT_STAT *st2;
	char fullpath[MAXPATHLEN];
	extern int orig_umask;
	char *p;
	char *q;

	while(strncmp(bak_path, "./", 2) == 0) bak_path += 2;

	if(bak_path[strlen(bak_path)-1] != '/') {
		snprintf(fullpath, sizeof(fullpath), "%s/", bak_path);
	} else {
		snprintf(fullpath, sizeof(fullpath), "%s", bak_path);
	}
	p = fullpath;
	q = &fullpath[strlen(fullpath)];  /* End of bak_path string */
	strcat(fullpath, fname);

	/* Make the directories */
	while ((p = strchr(p, '/'))) {
		*p = 0;
		if(do_lstat(fullpath, &st) != 0) {
			do_mkdir(fullpath, 0777 & ~orig_umask);
			if(p>q) {
				if(do_lstat(q, &st) != 0) {
					rprintf(FERROR, "make_bak_dir stat %s : %s\n", fullpath, strerror(errno));
				} else {
					st2 = &st;
					set_modtime(fullpath, st2->st_mtime);
					if(do_lchown(fullpath, st2->st_uid, st2->st_gid) != 0) {
						rprintf(FERROR, "make_bak_dir chown %s : %s\n", fullpath, strerror(errno));
					}
					if(do_chmod(fullpath, st2->st_mode) != 0) {
						rprintf(FERROR, "make_bak_dir failed to set permissions on %s : %s\n", fullpath, strerror(errno));
					}
				}
			}
		}
		*p = '/';
		p++;
	}
	return 0;
}

/* robustly move a file, creating new directory structures if necessary */
static int robust_move(char *src, char *dst)
{
	int keep_trying = 4;
	int keep_path_extfs = 0;
	int failed;

	while (keep_trying) {
		if (keep_path_extfs) {
			failed = copy_file(src, dst, 0755);
			if (!failed) {
				do_unlink(src);
			}
		} else {
			failed = robust_rename (src, dst);
		}

		if (failed) {
			if (verbose > 2)
				rprintf (FERROR, "robust_move failed: %s(%d)\n",
				    strerror (errno), errno);
			switch (errno) {
				/* external filesystem */
				case EXDEV:
					keep_path_extfs = 1;
					keep_trying--;
					break;
				/* no directory to write to */
				case ENOENT:
					make_dir (dst, 0755);
					keep_trying--;
					break;
				default:
					keep_trying = 0;
			} /* switch */
		} else
			keep_trying = 0;
	} /* while */
	return (!failed);
} /* robust_move */


/* if we have a backup_dir, then we get here from make_backup().
   We will move the file to be deleted into a parallel directory tree */
static int keep_backup(char *fname)
{

	static int initialised;

	char keep_name [MAXPATHLEN];
	STRUCT_STAT st;
	struct file_struct *file;

	int kept = 0;
	int ret_code;

	if (!initialised) {
		if (backup_dir[strlen(backup_dir) - 1] == '/')
			backup_dir[strlen(backup_dir) - 1] = 0;
		if (verbose > 0)
			rprintf (FINFO, "backup_dir is %s\n", backup_dir);
		initialised = 1;
	}

	/* return if no file to keep */
#if SUPPORT_LINKS
	if (do_lstat (fname, &st)) return 1;
#else
	if (do_stat (fname, &st)) return 1;
#endif

	file = make_file(fname, NULL, NO_EXCLUDES);

	/* the file could have disappeared */
	if (!file) return 1;

	/* make a complete pathname for backup file */
	if (strlen(backup_dir) + strlen(fname) +
		(suffix_specified ? strlen(backup_suffix) : 0) > (MAXPATHLEN - 1)) {
		rprintf (FERROR, "keep_backup filename too long\n");
		return 0;
	}

	if (suffix_specified) {
		snprintf(keep_name, sizeof (keep_name), "%s/%s%s",
		    backup_dir, fname, backup_suffix);
	} else {
		snprintf(keep_name, sizeof (keep_name), "%s/%s",
		    backup_dir, fname);
	}


#ifdef HAVE_MKNOD
	/* Check to see if this is a device file, or link */
	if(IS_DEVICE(file->mode)) {
		if(am_root && preserve_devices) {
			make_bak_dir(fname, backup_dir);
			if(do_mknod(keep_name, file->mode, file->rdev) != 0) {
				rprintf(FERROR, "mknod %s : %s\n",
				    keep_name, strerror(errno));
			} else if(verbose>2) {
				rprintf(FINFO, "make_backup : DEVICE %s successful.\n", fname);
			}
		}
		kept = 1;
		do_unlink(fname);
	}
#endif

	if(!kept && S_ISDIR(file->mode)) {
		/* make an empty directory */
		make_bak_dir(fname, backup_dir);
		do_mkdir(keep_name, file->mode);
		ret_code = do_rmdir(fname);

		if(verbose>2) {
			rprintf(FINFO, "make_backup : RMDIR %s returns %i\n",
			    fname, ret_code);
		}
		kept = 1;
	}

#if SUPPORT_LINKS
	if(!kept && preserve_links && S_ISLNK(file->mode)) {
		extern int safe_symlinks;
		if (safe_symlinks && unsafe_symlink(file->link, keep_name)) {
			if (verbose) {
				rprintf(FINFO, "ignoring unsafe symlink %s -> %s\n",
					keep_name, file->link);
			}
			kept = 1;
		}
		make_bak_dir(fname, backup_dir);
		if(do_symlink(file->link, keep_name) != 0) {
			rprintf(FERROR, "link %s -> %s : %s\n",
			    keep_name, file->link, strerror(errno));
		}
		do_unlink(fname);
		kept = 1;
	}
#endif
	if(!kept && preserve_hard_links && check_hard_link(file)) {
		if(verbose > 1)
			rprintf(FINFO, "%s is a hard link\n", f_name(file));
	}

	if(!kept && !S_ISREG(file->mode)) {
		rprintf(FINFO, "make_bak: skipping non-regular file %s\n",
		    fname);
	}

	/* move to keep tree if a file */
	if(!kept) {
		if (!robust_move (fname, keep_name)) {
			rprintf(FERROR, "keep_backup failed %s -> %s : %s\n",
			    fname, keep_name, strerror(errno));
		}
	}
	set_perms (keep_name, file, NULL, 0);
	free_file (file);
	free (file);

	if (verbose > 1)
		rprintf (FINFO, "keep_backup %s -> %s\n", fname, keep_name);
	return 1;
} /* keep_backup */


/* main backup switch routine */
int make_backup(char *fname)
{
	if (backup_dir)
		return (keep_backup(fname));
	else
		return (make_simple_backup(fname));
}
Commit	Line	Data
3d19b4c8 AT	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;
759ac870	24	extern int suffix_specified;
3d19b4c8	25	extern char *backup_suffix;
66203a98	26	extern char *backup_dir;
3d19b4c8 AT	27
3d19b4c8 AT	28
378a074c AT	29	extern int am_root;
	30	extern int preserve_devices;
	31	extern int preserve_links;
	32	extern int preserve_hard_links;
	33
66203a98 AT	34	/* simple backup creates a backup with a suffix in the same directory */
66203a98 AT	35	static int make_simple_backup(char *fname)
3d19b4c8 AT	36	{
	37	char fnamebak[MAXPATHLEN];
	38	if (strlen(fname) + strlen(backup_suffix) > (MAXPATHLEN-1)) {
47d6a60c	39	rprintf(FERROR, "backup filename too long\n");
3d19b4c8 AT	40	return 0;
	41	}
	42
47d6a60c S	43	snprintf(fnamebak, sizeof(fnamebak), "%s%s", fname, backup_suffix);
47d6a60c S	44	if (do_rename(fname, fnamebak) != 0) {
3d19b4c8 AT	45	/* cygwin (at least version b19) reports EINVAL */
3d19b4c8 AT	46	if (errno != ENOENT && errno != EINVAL) {
a039749b	47	rsyserr(FERROR, errno, "rename %s to backup %s", fname, fnamebak);
3d19b4c8 AT	48	return 0;
	49	}
	50	} else if (verbose > 1) {
47d6a60c	51	rprintf(FINFO, "backed up %s to %s\n", fname, fnamebak);
3d19b4c8 AT	52	}
	53	return 1;
	54	}
66203a98 AT	55
	56
	57	/* recursively make a directory path */
	58	static int make_dir(char *name, int mask)
	59	{
	60	char newdir [MAXPATHLEN];
	61	char p, d;
	62
	63	/* copy pathname over, look for last '/' */
	64	for (p = d = newdir; name; d++ = *name++)
	65	if (*name == '/')
	66	p = d;
	67	if (p == newdir)
	68	return 0;
	69	*p = 0;
	70
	71	/* make the new directory, if that fails then make its parent */
	72	while (do_mkdir (newdir, mask) != 0)
	73	if ((errno != ENOENT) \|\| !make_dir (newdir, mask))
	74	return 0;
	75
	76	return 1;
	77	} /* make_dir */
	78
	79
378a074c AT	80	/****************************************************************************
	81	Create a directory given an absolute path, perms based upon another directory
	82	path
	83	****************************************************************************/
47d6a60c	84	static int make_bak_dir(char fname, char bak_path)
378a074c	85	{
47d6a60c S	86	STRUCT_STAT st;
	87	STRUCT_STAT *st2;
	88	char fullpath[MAXPATHLEN];
	89	extern int orig_umask;
	90	char *p;
	91	char *q;
	92
	93	while(strncmp(bak_path, "./", 2) == 0) bak_path += 2;
	94
	95	if(bak_path[strlen(bak_path)-1] != '/') {
	96	snprintf(fullpath, sizeof(fullpath), "%s/", bak_path);
	97	} else {
	98	snprintf(fullpath, sizeof(fullpath), "%s", bak_path);
	99	}
	100	p = fullpath;
	101	q = &fullpath[strlen(fullpath)]; /* End of bak_path string */
	102	strcat(fullpath, fname);
	103
	104	/* Make the directories */
	105	while ((p = strchr(p, '/'))) {
	106	*p = 0;
	107	if(do_lstat(fullpath, &st) != 0) {
	108	do_mkdir(fullpath, 0777 & ~orig_umask);
	109	if(p>q) {
	110	if(do_lstat(q, &st) != 0) {
	111	rprintf(FERROR, "make_bak_dir stat %s : %s\n", fullpath, strerror(errno));
	112	} else {
	113	st2 = &st;
	114	set_modtime(fullpath, st2->st_mtime);
	115	if(do_lchown(fullpath, st2->st_uid, st2->st_gid) != 0) {
	116	rprintf(FERROR, "make_bak_dir chown %s : %s\n", fullpath, strerror(errno));
	117	}
	118	if(do_chmod(fullpath, st2->st_mode) != 0) {
	119	rprintf(FERROR, "make_bak_dir failed to set permissions on %s : %s\n", fullpath, strerror(errno));
	120	}
	121	}
	122	}
	123	}
	124	*p = '/';
	125	p++;
	126	}
	127	return 0;
378a074c AT	128	}
378a074c AT	129
66203a98 AT	130	/* robustly move a file, creating new directory structures if necessary */
	131	static int robust_move(char src, char dst)
	132	{
	133	int keep_trying = 4;
	134	int keep_path_extfs = 0;
	135	int failed;
	136
	137	while (keep_trying) {
49d6fdc0 AT	138	if (keep_path_extfs) {
	139	failed = copy_file(src, dst, 0755);
	140	if (!failed) {
	141	do_unlink(src);
	142	}
	143	} else {
66203a98	144	failed = robust_rename (src, dst);
49d6fdc0	145	}
66203a98 AT	146
	147	if (failed) {
	148	if (verbose > 2)
	149	rprintf (FERROR, "robust_move failed: %s(%d)\n",
47d6a60c	150	strerror (errno), errno);
66203a98 AT	151	switch (errno) {
	152	/* external filesystem */
	153	case EXDEV:
	154	keep_path_extfs = 1;
	155	keep_trying--;
	156	break;
	157	/* no directory to write to */
	158	case ENOENT:
	159	make_dir (dst, 0755);
	160	keep_trying--;
	161	break;
	162	default:
	163	keep_trying = 0;
	164	} /* switch */
	165	} else
	166	keep_trying = 0;
	167	} /* while */
	168	return (!failed);
	169	} /* robust_move */
	170
	171
	172	/* if we have a backup_dir, then we get here from make_backup().
	173	We will move the file to be deleted into a parallel directory tree */
	174	static int keep_backup(char *fname)
	175	{
378a074c	176
66203a98 AT	177	static int initialised;
	178
	179	char keep_name [MAXPATHLEN];
	180	STRUCT_STAT st;
	181	struct file_struct *file;
	182
47d6a60c	183	int kept = 0;
378a074c AT	184	int ret_code;
378a074c AT	185
66203a98 AT	186	if (!initialised) {
	187	if (backup_dir[strlen(backup_dir) - 1] == '/')
	188	backup_dir[strlen(backup_dir) - 1] = 0;
	189	if (verbose > 0)
	190	rprintf (FINFO, "backup_dir is %s\n", backup_dir);
	191	initialised = 1;
	192	}
	193
	194	/* return if no file to keep */
	195	#if SUPPORT_LINKS
	196	if (do_lstat (fname, &st)) return 1;
	197	#else
	198	if (do_stat (fname, &st)) return 1;
	199	#endif
	200
af1d91c5	201	file = make_file(fname, NULL, NO_EXCLUDES);
f2cbf44b AT	202
	203	/* the file could have disappeared */
	204	if (!file) return 1;
66203a98	205
47d6a60c S	206	/* make a complete pathname for backup file */
47d6a60c S	207	if (strlen(backup_dir) + strlen(fname) +
759ac870	208	(suffix_specified ? strlen(backup_suffix) : 0) > (MAXPATHLEN - 1)) {
47d6a60c S	209	rprintf (FERROR, "keep_backup filename too long\n");
	210	return 0;
	211	}
378a074c	212
759ac870	213	if (suffix_specified) {
47d6a60c S	214	snprintf(keep_name, sizeof (keep_name), "%s/%s%s",
	215	backup_dir, fname, backup_suffix);
	216	} else {
	217	snprintf(keep_name, sizeof (keep_name), "%s/%s",
	218	backup_dir, fname);
	219	}
378a074c AT	220
	221
	222	#ifdef HAVE_MKNOD
	223	/* Check to see if this is a device file, or link */
47d6a60c S	224	if(IS_DEVICE(file->mode)) {
	225	if(am_root && preserve_devices) {
	226	make_bak_dir(fname, backup_dir);
	227	if(do_mknod(keep_name, file->mode, file->rdev) != 0) {
	228	rprintf(FERROR, "mknod %s : %s\n",
	229	keep_name, strerror(errno));
	230	} else if(verbose>2) {
	231	rprintf(FINFO, "make_backup : DEVICE %s successful.\n", fname);
	232	}
	233	}
	234	kept = 1;
	235	do_unlink(fname);
	236	}
378a074c AT	237	#endif
	238
	239	if(!kept && S_ISDIR(file->mode)) {
	240	/* make an empty directory */
47d6a60c S	241	make_bak_dir(fname, backup_dir);
	242	do_mkdir(keep_name, file->mode);
	243	ret_code = do_rmdir(fname);
	244
	245	if(verbose>2) {
	246	rprintf(FINFO, "make_backup : RMDIR %s returns %i\n",
	247	fname, ret_code);
	248	}
	249	kept = 1;
	250	}
378a074c AT	251
378a074c AT	252	#if SUPPORT_LINKS
47d6a60c S	253	if(!kept && preserve_links && S_ISLNK(file->mode)) {
	254	extern int safe_symlinks;
	255	if (safe_symlinks && unsafe_symlink(file->link, keep_name)) {
	256	if (verbose) {
	257	rprintf(FINFO, "ignoring unsafe symlink %s -> %s\n",
	258	keep_name, file->link);
	259	}
	260	kept = 1;
	261	}
	262	make_bak_dir(fname, backup_dir);
	263	if(do_symlink(file->link, keep_name) != 0) {
	264	rprintf(FERROR, "link %s -> %s : %s\n",
	265	keep_name, file->link, strerror(errno));
	266	}
	267	do_unlink(fname);
	268	kept = 1;
	269	}
378a074c	270	#endif
47d6a60c S	271	if(!kept && preserve_hard_links && check_hard_link(file)) {
	272	if(verbose > 1)
	273	rprintf(FINFO, "%s is a hard link\n", f_name(file));
	274	}
378a074c	275
47d6a60c S	276	if(!kept && !S_ISREG(file->mode)) {
	277	rprintf(FINFO, "make_bak: skipping non-regular file %s\n",
	278	fname);
	279	}
66203a98	280
66203a98	281	/* move to keep tree if a file */
378a074c	282	if(!kept) {
47d6a60c	283	if (!robust_move (fname, keep_name)) {
66203a98	284	rprintf(FERROR, "keep_backup failed %s -> %s : %s\n",
47d6a60c S	285	fname, keep_name, strerror(errno));
	286	}
	287	}
66203a98 AT	288	set_perms (keep_name, file, NULL, 0);
	289	free_file (file);
	290	free (file);
378a074c	291
66203a98 AT	292	if (verbose > 1)
	293	rprintf (FINFO, "keep_backup %s -> %s\n", fname, keep_name);
	294	return 1;
	295	} /* keep_backup */
	296
	297
	298	/* main backup switch routine */
	299	int make_backup(char *fname)
	300	{
	301	if (backup_dir)
	302	return (keep_backup(fname));
	303	else
	304	return (make_simple_backup(fname));
	305	}