1/*
2 * Routines common to more than one of the rsync processes.
3 *
4 * Copyright (C) 1996 Andrew Tridgell
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2003, 2004, 2005, 2006 Wayne Davison
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
21 */
22
23#include "rsync.h"
24#if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
25#include <iconv.h>
26#endif
27#if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
28#include <libcharset.h>
29#elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
30#include <langinfo.h>
31#endif
32
33extern int verbose;
34extern int dry_run;
35extern int preserve_perms;
36extern int preserve_executability;
37extern int preserve_times;
38extern int omit_dir_times;
39extern int am_root;
40extern int am_server;
41extern int am_sender;
42extern int am_generator;
43extern int am_starting_up;
44extern int allow_8bit_chars;
45extern int preserve_uid;
46extern int preserve_gid;
47extern int inplace;
48extern int keep_dirlinks;
49extern int make_backups;
50extern mode_t orig_umask;
51extern struct stats stats;
52extern struct chmod_mode_struct *daemon_chmod_modes;
53
54#if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
55iconv_t ic_chck = (iconv_t)-1;
56
57static const char *default_charset(void)
58{
59#if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
60	return locale_charset();
61#elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
62	return nl_langinfo(CODESET);
63#else
64	return ""; /* Works with (at the very least) gnu iconv... */
65#endif
66}
67
68void setup_iconv()
69{
70	if (!am_server && !allow_8bit_chars) {
71		const char *defset = default_charset();
72
73		/* It's OK if this fails... */
74		ic_chck = iconv_open(defset, defset);
75
76		if (verbose > 3) {
77			if (ic_chck == (iconv_t)-1) {
78				rprintf(FINFO,
79					"note: iconv_open(\"%s\", \"%s\") failed (%d)"
80					" -- using isprint() instead of iconv().\n",
81					defset, defset, errno);
82			} else {
83				rprintf(FINFO,
84					"note: iconv_open(\"%s\", \"%s\") succeeded.\n",
85					defset, defset);
86			}
87		}
88	}
89}
90#endif
91
92/*
93  free a sums struct
94  */
95void free_sums(struct sum_struct *s)
96{
97	if (s->sums) free(s->sums);
98	free(s);
99}
100
101/* This is only called when we aren't preserving permissions.  Figure out what
102 * the permissions should be and return them merged back into the mode. */
103mode_t dest_mode(mode_t flist_mode, mode_t stat_mode, int exists)
104{
105	int new_mode;
106	/* If the file already exists, we'll return the local permissions,
107	 * possibly tweaked by the --executability option. */
108	if (exists) {
109		new_mode = (flist_mode & ~CHMOD_BITS) | (stat_mode & CHMOD_BITS);
110		if (preserve_executability && S_ISREG(flist_mode)) {
111			/* If the source file is executable, grant execute
112			 * rights to everyone who can read, but ONLY if the
113			 * file isn't already executable. */
114			if (!(flist_mode & 0111))
115				new_mode &= ~0111;
116			else if (!(stat_mode & 0111))
117				new_mode |= (new_mode & 0444) >> 2;
118		}
119	} else {
120		/* Apply the umask and turn off special permissions. */
121		new_mode = flist_mode & (~CHMOD_BITS | (ACCESSPERMS & ~orig_umask));
122	}
123	return new_mode;
124}
125
126int set_file_attrs(char *fname, struct file_struct *file, STRUCT_STAT *st,
127		   int flags)
128{
129	int updated = 0;
130	STRUCT_STAT st2;
131	int change_uid, change_gid;
132	mode_t new_mode = file->mode;
133
134	if (!st) {
135		if (dry_run)
136			return 1;
137		if (link_stat(fname, &st2, 0) < 0) {
138			rsyserr(FERROR, errno, "stat %s failed",
139				full_fname(fname));
140			return 0;
141		}
142		st = &st2;
143		if (!preserve_perms && S_ISDIR(new_mode)
144		 && st->st_mode & S_ISGID) {
145			/* We just created this directory and its setgid
146			 * bit is on, so make sure it stays on. */
147			new_mode |= S_ISGID;
148		}
149	}
150
151	if (!preserve_times || (S_ISDIR(st->st_mode) && omit_dir_times))
152		flags |= ATTRS_SKIP_MTIME;
153	if (!(flags & ATTRS_SKIP_MTIME)
154	    && cmp_time(st->st_mtime, file->modtime) != 0) {
155		int ret = set_modtime(fname, file->modtime, st->st_mode);
156		if (ret < 0) {
157			rsyserr(FERROR, errno, "failed to set times on %s",
158				full_fname(fname));
159			return 0;
160		}
161		if (ret == 0) /* ret == 1 if symlink could not be set */
162			updated = 1;
163	}
164
165	change_uid = am_root && preserve_uid && st->st_uid != file->uid;
166	change_gid = preserve_gid && file->gid != GID_NONE
167		&& st->st_gid != file->gid;
168#if !defined HAVE_LCHOWN && !defined CHOWN_MODIFIES_SYMLINK
169	if (S_ISLNK(st->st_mode))
170		;
171	else
172#endif
173	if (change_uid || change_gid) {
174		if (verbose > 2) {
175			if (change_uid) {
176				rprintf(FINFO,
177					"set uid of %s from %ld to %ld\n",
178					fname,
179					(long)st->st_uid, (long)file->uid);
180			}
181			if (change_gid) {
182				rprintf(FINFO,
183					"set gid of %s from %ld to %ld\n",
184					fname,
185					(long)st->st_gid, (long)file->gid);
186			}
187		}
188		if (do_lchown(fname,
189		    change_uid ? file->uid : st->st_uid,
190		    change_gid ? file->gid : st->st_gid) != 0) {
191			/* shouldn't have attempted to change uid or gid
192			 * unless have the privilege */
193			rsyserr(FERROR, errno, "%s %s failed",
194			    change_uid ? "chown" : "chgrp",
195			    full_fname(fname));
196			return 0;
197		}
198		/* a lchown had been done - we have to re-stat if the
199		 * destination had the setuid or setgid bits set due
200		 * to the side effect of the chown call */
201		if (st->st_mode & (S_ISUID | S_ISGID)) {
202			link_stat(fname, st,
203				  keep_dirlinks && S_ISDIR(st->st_mode));
204		}
205		updated = 1;
206	}
207
208	if (daemon_chmod_modes && !S_ISLNK(new_mode))
209		new_mode = tweak_mode(new_mode, daemon_chmod_modes);
210#ifdef HAVE_CHMOD
211	if ((st->st_mode & CHMOD_BITS) != (new_mode & CHMOD_BITS)) {
212		int ret = do_chmod(fname, new_mode);
213		if (ret < 0) {
214			rsyserr(FERROR, errno,
215				"failed to set permissions on %s",
216				full_fname(fname));
217			return 0;
218		}
219		if (ret == 0) /* ret == 1 if symlink could not be set */
220			updated = 1;
221	}
222#endif
223
224	if (verbose > 1 && flags & ATTRS_REPORT) {
225		if (updated)
226			rprintf(FCLIENT, "%s\n", fname);
227		else
228			rprintf(FCLIENT, "%s is uptodate\n", fname);
229	}
230	return updated;
231}
232
233RETSIGTYPE sig_int(UNUSED(int val))
234{
235	/* KLUGE: if the user hits Ctrl-C while ssh is prompting
236	 * for a password, then our cleanup's sending of a SIGUSR1
237	 * signal to all our children may kill ssh before it has a
238	 * chance to restore the tty settings (i.e. turn echo back
239	 * on).  By sleeping for a short time, ssh gets a bigger
240	 * chance to do the right thing.  If child processes are
241	 * not ssh waiting for a password, then this tiny delay
242	 * shouldn't hurt anything. */
243	msleep(400);
244	exit_cleanup(RERR_SIGNAL);
245}
246
247/* Finish off a file transfer: renaming the file and setting the file's
248 * attributes (e.g. permissions, ownership, etc.).  If partialptr is not
249 * NULL and the robust_rename() call is forced to copy the temp file, we
250 * stage the file into the partial-dir and then rename it into place. */
251void finish_transfer(char *fname, char *fnametmp, char *partialptr,
252		     struct file_struct *file, int ok_to_set_time,
253		     int overwriting_basis)
254{
255	int ret;
256
257	if (inplace) {
258		if (verbose > 2)
259			rprintf(FINFO, "finishing %s\n", fname);
260		fnametmp = fname;
261		goto do_set_file_attrs;
262	}
263
264	if (make_backups && overwriting_basis && !make_backup(fname))
265		return;
266
267	/* Change permissions before putting the file into place. */
268	set_file_attrs(fnametmp, file, NULL,
269		       ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
270
271	/* move tmp file over real file */
272	if (verbose > 2)
273		rprintf(FINFO, "renaming %s to %s\n", fnametmp, fname);
274	ret = robust_rename(fnametmp, fname, partialptr,
275			    file->mode & INITACCESSPERMS);
276	if (ret < 0) {
277		rsyserr(FERROR, errno, "%s %s -> \"%s\"",
278			ret == -2 ? "copy" : "rename",
279			full_fname(fnametmp), fname);
280		do_unlink(fnametmp);
281		return;
282	}
283	if (ret == 0) {
284		/* The file was moved into place (not copied), so it's done. */
285		return;
286	}
287	/* The file was copied, so tweak the perms of the copied file.  If it
288	 * was copied to partialptr, move it into its final destination. */
289	fnametmp = partialptr ? partialptr : fname;
290
291  do_set_file_attrs:
292	set_file_attrs(fnametmp, file, NULL,
293		       ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
294
295	if (partialptr) {
296		if (do_rename(fnametmp, fname) < 0) {
297			rsyserr(FERROR, errno, "rename %s -> \"%s\"",
298				full_fname(fnametmp), fname);
299		} else
300			handle_partial_dir(partialptr, PDIR_DELETE);
301	}
302}
303
304const char *who_am_i(void)
305{
306	if (am_starting_up)
307		return am_server ? "server" : "client";
308	return am_sender ? "sender" : am_generator ? "generator" : "receiver";
309}
310