2 * Routines common to more than one of the rsync processes.
4 * Copyright (C) 1996 Andrew Tridgell
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2003, 2004, 2005, 2006 Wayne Davison
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.
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.
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.
24 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
27 #if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
28 #include <libcharset.h>
29 #elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
35 extern int preserve_perms;
36 extern int preserve_executability;
37 extern int preserve_times;
38 extern int omit_dir_times;
42 extern int am_generator;
43 extern int am_starting_up;
44 extern int allow_8bit_chars;
45 extern int protocol_version;
46 extern int preserve_uid;
47 extern int preserve_gid;
48 extern int incremental;
51 extern int keep_dirlinks;
52 extern int make_backups;
53 extern mode_t orig_umask;
54 extern struct stats stats;
55 extern struct file_list *cur_flist, *first_flist, *dir_flist;
56 extern struct chmod_mode_struct *daemon_chmod_modes;
58 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
59 iconv_t ic_chck = (iconv_t)-1;
61 static const char *default_charset(void)
63 #if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
64 return locale_charset();
65 #elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
66 return nl_langinfo(CODESET);
68 return ""; /* Works with (at the very least) gnu iconv... */
74 if (!am_server && !allow_8bit_chars) {
75 const char *defset = default_charset();
77 /* It's OK if this fails... */
78 ic_chck = iconv_open(defset, defset);
81 if (ic_chck == (iconv_t)-1) {
83 "note: iconv_open(\"%s\", \"%s\") failed (%d)"
84 " -- using isprint() instead of iconv().\n",
85 defset, defset, errno);
88 "note: iconv_open(\"%s\", \"%s\") succeeded.\n",
96 /* This is used by sender.c with a valid f_out, and by receive.c with
98 int read_ndx_and_attrs(int f_in, int f_out, int *iflag_ptr,
99 uchar *type_ptr, char *buf, int *len_ptr)
102 struct file_list *flist;
103 uchar fnamecmp_type = FNAMECMP_FNAME;
104 int verbose_save, ndx;
108 ndx = read_ndx(f_in);
114 if (!incremental || am_sender)
116 if (ndx == NDX_FLIST_EOF) {
118 send_msg(MSG_FLIST_EOF, "", 0);
121 ndx = NDX_FLIST_OFFSET - ndx;
122 if (ndx < 0 || ndx >= dir_flist->count) {
123 ndx = NDX_FLIST_OFFSET - ndx;
125 "Invalid dir index: %d (%d - %d)\n",
126 ndx, NDX_FLIST_OFFSET,
127 NDX_FLIST_OFFSET - dir_flist->count);
128 exit_cleanup(RERR_PROTOCOL);
130 verbose_save = verbose;
131 verbose = 0; /* TODO allow verbose messages? */
133 /* Send everything read from f_in to msg_fd_out. */
134 send_msg_int(MSG_FLIST, ndx);
135 start_flist_forward(f_in);
136 flist = recv_file_list(f_in);
137 flist->parent_ndx = ndx;
138 stop_flist_forward();
140 verbose = verbose_save;
143 iflags = protocol_version >= 29 ? read_shortint(f_in)
144 : ITEM_TRANSFER | ITEM_MISSING_DATA;
146 /* Honor the old-style keep-alive indicator. */
147 if (protocol_version < 30
148 && ndx == cur_flist->count && iflags == ITEM_IS_NEW) {
150 maybe_send_keepalive();
154 if (!(flist = flist_for_ndx(ndx))) {
157 "Invalid file index: %d (%d - %d) with iflags %x [%s]\n",
158 ndx, first_flist->ndx_start + first_flist->ndx_start,
159 first_flist->prev->ndx_start + first_flist->ndx_start
160 + first_flist->prev->count - 1, iflags, who_am_i());
161 exit_cleanup(RERR_PROTOCOL);
165 if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
166 fnamecmp_type = read_byte(f_in);
167 *type_ptr = fnamecmp_type;
169 if (iflags & ITEM_XNAME_FOLLOWS) {
170 if ((len = read_vstring(f_in, buf, MAXPATHLEN)) < 0)
171 exit_cleanup(RERR_PROTOCOL);
178 if (iflags & ITEM_TRANSFER) {
179 int i = ndx - cur_flist->ndx_start;
180 if (!S_ISREG(cur_flist->files[i]->mode)) {
182 "received request to transfer non-regular file: %d [%s]\n",
184 exit_cleanup(RERR_PROTOCOL);
186 } else if (f_out >= 0) {
187 write_ndx_and_attrs(f_out, ndx, iflags,
188 fnamecmp_type, buf, len);
198 void free_sums(struct sum_struct *s)
200 if (s->sums) free(s->sums);
204 /* This is only called when we aren't preserving permissions. Figure out what
205 * the permissions should be and return them merged back into the mode. */
206 mode_t dest_mode(mode_t flist_mode, mode_t stat_mode, int exists)
209 /* If the file already exists, we'll return the local permissions,
210 * possibly tweaked by the --executability option. */
212 new_mode = (flist_mode & ~CHMOD_BITS) | (stat_mode & CHMOD_BITS);
213 if (preserve_executability && S_ISREG(flist_mode)) {
214 /* If the source file is executable, grant execute
215 * rights to everyone who can read, but ONLY if the
216 * file isn't already executable. */
217 if (!(flist_mode & 0111))
219 else if (!(stat_mode & 0111))
220 new_mode |= (new_mode & 0444) >> 2;
223 /* Apply the umask and turn off special permissions. */
224 new_mode = flist_mode & (~CHMOD_BITS | (ACCESSPERMS & ~orig_umask));
229 int set_file_attrs(char *fname, struct file_struct *file, STRUCT_STAT *st,
234 int change_uid, change_gid;
235 mode_t new_mode = file->mode;
240 if (link_stat(fname, &st2, 0) < 0) {
241 rsyserr(FERROR, errno, "stat %s failed",
246 if (!preserve_perms && S_ISDIR(new_mode)
247 && st->st_mode & S_ISGID) {
248 /* We just created this directory and its setgid
249 * bit is on, so make sure it stays on. */
254 if (!preserve_times || (S_ISDIR(st->st_mode) && omit_dir_times))
255 flags |= ATTRS_SKIP_MTIME;
256 if (!(flags & ATTRS_SKIP_MTIME)
257 && cmp_time(st->st_mtime, file->modtime) != 0) {
258 int ret = set_modtime(fname, file->modtime, st->st_mode);
260 rsyserr(FERROR, errno, "failed to set times on %s",
264 if (ret == 0) /* ret == 1 if symlink could not be set */
268 change_uid = am_root && preserve_uid && st->st_uid != F_UID(file);
269 change_gid = preserve_gid && F_GID(file) != GID_NONE
270 && st->st_gid != F_GID(file);
271 #if !defined HAVE_LCHOWN && !defined CHOWN_MODIFIES_SYMLINK
272 if (S_ISLNK(st->st_mode))
276 if (change_uid || change_gid) {
280 "set uid of %s from %ld to %ld\n",
282 (long)st->st_uid, (long)F_UID(file));
286 "set gid of %s from %ld to %ld\n",
288 (long)st->st_gid, (long)F_GID(file));
292 change_uid ? F_UID(file) : st->st_uid,
293 change_gid ? F_GID(file) : st->st_gid) != 0) {
294 /* shouldn't have attempted to change uid or gid
295 * unless have the privilege */
296 rsyserr(FERROR, errno, "%s %s failed",
297 change_uid ? "chown" : "chgrp",
301 /* a lchown had been done - we have to re-stat if the
302 * destination had the setuid or setgid bits set due
303 * to the side effect of the chown call */
304 if (st->st_mode & (S_ISUID | S_ISGID)) {
306 keep_dirlinks && S_ISDIR(st->st_mode));
311 if (daemon_chmod_modes && !S_ISLNK(new_mode))
312 new_mode = tweak_mode(new_mode, daemon_chmod_modes);
314 if (!BITS_EQUAL(st->st_mode, new_mode, CHMOD_BITS)) {
315 int ret = do_chmod(fname, new_mode);
317 rsyserr(FERROR, errno,
318 "failed to set permissions on %s",
322 if (ret == 0) /* ret == 1 if symlink could not be set */
327 if (verbose > 1 && flags & ATTRS_REPORT) {
329 rprintf(FCLIENT, "%s\n", fname);
331 rprintf(FCLIENT, "%s is uptodate\n", fname);
336 RETSIGTYPE sig_int(UNUSED(int val))
338 /* KLUGE: if the user hits Ctrl-C while ssh is prompting
339 * for a password, then our cleanup's sending of a SIGUSR1
340 * signal to all our children may kill ssh before it has a
341 * chance to restore the tty settings (i.e. turn echo back
342 * on). By sleeping for a short time, ssh gets a bigger
343 * chance to do the right thing. If child processes are
344 * not ssh waiting for a password, then this tiny delay
345 * shouldn't hurt anything. */
347 exit_cleanup(RERR_SIGNAL);
350 /* Finish off a file transfer: renaming the file and setting the file's
351 * attributes (e.g. permissions, ownership, etc.). If partialptr is not
352 * NULL and the robust_rename() call is forced to copy the temp file, we
353 * stage the file into the partial-dir and then rename it into place. */
354 void finish_transfer(char *fname, char *fnametmp, char *partialptr,
355 struct file_struct *file, int ok_to_set_time,
356 int overwriting_basis)
362 rprintf(FINFO, "finishing %s\n", fname);
364 goto do_set_file_attrs;
367 if (make_backups > 0 && overwriting_basis && !make_backup(fname))
370 /* Change permissions before putting the file into place. */
371 set_file_attrs(fnametmp, file, NULL,
372 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
374 /* move tmp file over real file */
376 rprintf(FINFO, "renaming %s to %s\n", fnametmp, fname);
377 ret = robust_rename(fnametmp, fname, partialptr,
378 file->mode & INITACCESSPERMS);
380 rsyserr(FERROR, errno, "%s %s -> \"%s\"",
381 ret == -2 ? "copy" : "rename",
382 full_fname(fnametmp), fname);
387 /* The file was moved into place (not copied), so it's done. */
390 /* The file was copied, so tweak the perms of the copied file. If it
391 * was copied to partialptr, move it into its final destination. */
392 fnametmp = partialptr ? partialptr : fname;
395 set_file_attrs(fnametmp, file, NULL,
396 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
399 if (do_rename(fnametmp, fname) < 0) {
400 rsyserr(FERROR, errno, "rename %s -> \"%s\"",
401 full_fname(fnametmp), fname);
403 handle_partial_dir(partialptr, PDIR_DELETE);
407 struct file_list *flist_for_ndx(int ndx)
409 struct file_list *flist = cur_flist;
414 while (ndx < flist->ndx_start) {
415 if (flist == first_flist)
419 while (ndx >= flist->ndx_start + flist->count) {
420 if (!(flist = flist->next))
426 const char *who_am_i(void)
429 return am_server ? "server" : "client";
430 return am_sender ? "sender" : am_generator ? "generator" : "receiver";