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-2007 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 3 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, visit the http://fsf.org website.
23 #if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
24 #include <libcharset.h>
25 #elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
31 extern int preserve_acls;
32 extern int preserve_xattrs;
33 extern int preserve_perms;
34 extern int preserve_executability;
35 extern int preserve_times;
39 extern int am_generator;
40 extern int am_starting_up;
41 extern int allow_8bit_chars;
42 extern int protocol_version;
45 extern int inc_recurse;
48 extern int keep_dirlinks;
49 extern int make_backups;
50 extern struct file_list *cur_flist, *first_flist, *dir_flist;
51 extern struct chmod_mode_struct *daemon_chmod_modes;
53 extern char *iconv_opt;
57 iconv_t ic_chck = (iconv_t)-1;
59 iconv_t ic_send = (iconv_t)-1, ic_recv = (iconv_t)-1;
63 static const char *default_charset(void)
65 #if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
66 return locale_charset();
67 #elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
68 return nl_langinfo(CODESET);
70 return ""; /* Works with (at the very least) gnu iconv... */
76 const char *defset = default_charset();
82 if (!am_server && !allow_8bit_chars) {
84 /* It's OK if this fails... */
85 ic_chck = iconv_open(defset, defset);
88 if (ic_chck == (iconv_t)-1) {
90 "note: iconv_open(\"%s\", \"%s\") failed (%d)"
91 " -- using isprint() instead of iconv().\n",
92 defset, defset, errno);
95 "note: iconv_open(\"%s\", \"%s\") succeeded.\n",
105 if ((cp = strchr(iconv_opt, ',')) != NULL) {
106 if (am_server) /* A local transfer needs this. */
112 if (!*iconv_opt || (*iconv_opt == '.' && iconv_opt[1] == '\0'))
117 if ((ic_send = iconv_open(UTF8_CHARSET, charset)) == (iconv_t)-1) {
118 rprintf(FERROR, "iconv_open(\"%s\", \"%s\") failed\n",
119 UTF8_CHARSET, charset);
120 exit_cleanup(RERR_UNSUPPORTED);
123 if ((ic_recv = iconv_open(charset, UTF8_CHARSET)) == (iconv_t)-1) {
124 rprintf(FERROR, "iconv_open(\"%s\", \"%s\") failed\n",
125 charset, UTF8_CHARSET);
126 exit_cleanup(RERR_UNSUPPORTED);
129 if (!am_sender || inc_recurse)
130 ic_ndx = ++file_extra_cnt;
133 rprintf(FINFO, "%s charset: %s\n",
134 am_server ? "server" : "client",
135 *charset ? charset : "[LOCALE]");
141 int read_ndx_and_attrs(int f_in, int *iflag_ptr, uchar *type_ptr,
142 char *buf, int *len_ptr)
145 struct file_list *flist;
146 uchar fnamecmp_type = FNAMECMP_FNAME;
151 ndx = read_ndx(f_in);
157 if (!inc_recurse || am_sender)
159 if (ndx == NDX_FLIST_EOF) {
161 send_msg(MSG_FLIST_EOF, "", 0, 0);
164 ndx = NDX_FLIST_OFFSET - ndx;
165 if (ndx < 0 || ndx >= dir_flist->used) {
166 ndx = NDX_FLIST_OFFSET - ndx;
168 "[%s] Invalid dir index: %d (%d - %d)\n",
169 who_am_i(), ndx, NDX_FLIST_OFFSET,
170 NDX_FLIST_OFFSET - dir_flist->used + 1);
171 exit_cleanup(RERR_PROTOCOL);
174 /* Send everything read from f_in to msg_fd_out. */
175 send_msg_int(MSG_FLIST, ndx);
176 start_flist_forward(f_in);
178 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
181 flist = recv_file_list(f_in);
182 flist->parent_ndx = ndx;
183 stop_flist_forward();
186 iflags = protocol_version >= 29 ? read_shortint(f_in)
187 : ITEM_TRANSFER | ITEM_MISSING_DATA;
189 /* Honor the old-style keep-alive indicator. */
190 if (protocol_version < 30
191 && ndx == cur_flist->used && iflags == ITEM_IS_NEW) {
193 maybe_send_keepalive();
197 if (!(flist = flist_for_ndx(ndx))) {
200 "Invalid file index: %d (%d - %d) with iflags %x [%s]\n",
201 ndx, first_flist->ndx_start - 1, first_flist->prev->ndx_end,
203 exit_cleanup(RERR_PROTOCOL);
207 if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
208 fnamecmp_type = read_byte(f_in);
209 *type_ptr = fnamecmp_type;
211 if (iflags & ITEM_XNAME_FOLLOWS) {
212 if ((len = read_vstring(f_in, buf, MAXPATHLEN)) < 0)
213 exit_cleanup(RERR_PROTOCOL);
220 if (iflags & ITEM_TRANSFER) {
221 int i = ndx - cur_flist->ndx_start;
222 if (i < 0 || !S_ISREG(cur_flist->files[i]->mode)) {
224 "received request to transfer non-regular file: %d [%s]\n",
226 exit_cleanup(RERR_PROTOCOL);
237 void free_sums(struct sum_struct *s)
239 if (s->sums) free(s->sums);
243 /* This is only called when we aren't preserving permissions. Figure out what
244 * the permissions should be and return them merged back into the mode. */
245 mode_t dest_mode(mode_t flist_mode, mode_t stat_mode, int dflt_perms,
249 /* If the file already exists, we'll return the local permissions,
250 * possibly tweaked by the --executability option. */
252 new_mode = (flist_mode & ~CHMOD_BITS) | (stat_mode & CHMOD_BITS);
253 if (preserve_executability && S_ISREG(flist_mode)) {
254 /* If the source file is executable, grant execute
255 * rights to everyone who can read, but ONLY if the
256 * file isn't already executable. */
257 if (!(flist_mode & 0111))
259 else if (!(stat_mode & 0111))
260 new_mode |= (new_mode & 0444) >> 2;
263 /* Apply destination default permissions and turn
264 * off special permissions. */
265 new_mode = flist_mode & (~CHMOD_BITS | dflt_perms);
270 int set_file_attrs(const char *fname, struct file_struct *file, statx *sxp,
271 const char *fnamecmp, int flags)
275 int change_uid, change_gid;
276 mode_t new_mode = file->mode;
281 if (link_stat(fname, &sx2.st, 0) < 0) {
282 rsyserr(FERROR, errno, "stat %s failed",
287 sx2.acc_acl = sx2.def_acl = NULL;
289 #ifdef SUPPORT_XATTRS
292 if (!preserve_perms && S_ISDIR(new_mode)
293 && sx2.st.st_mode & S_ISGID) {
294 /* We just created this directory and its setgid
295 * bit is on, so make sure it stays on. */
302 if (preserve_acls && !S_ISLNK(file->mode) && !ACL_READY(*sxp))
306 #ifdef SUPPORT_XATTRS
307 if (preserve_xattrs && fnamecmp)
308 set_xattr(fname, file, fnamecmp, sxp);
310 set_stat_xattr(fname, file);
313 if (!preserve_times || (S_ISDIR(sxp->st.st_mode) && preserve_times == 1))
314 flags |= ATTRS_SKIP_MTIME;
315 if (!(flags & ATTRS_SKIP_MTIME)
316 && cmp_time(sxp->st.st_mtime, file->modtime) != 0) {
317 int ret = set_modtime(fname, file->modtime, sxp->st.st_mode);
319 rsyserr(FERROR, errno, "failed to set times on %s",
323 if (ret == 0) /* ret == 1 if symlink could not be set */
327 change_uid = am_root && uid_ndx && sxp->st.st_uid != (uid_t)F_OWNER(file);
328 change_gid = gid_ndx && !(file->flags & FLAG_SKIP_GROUP)
329 && sxp->st.st_gid != (gid_t)F_GROUP(file);
330 #if !defined HAVE_LCHOWN && !defined CHOWN_MODIFIES_SYMLINK
331 if (S_ISLNK(sxp->st.st_mode))
335 if (change_uid || change_gid) {
339 "set uid of %s from %u to %u\n",
340 fname, (unsigned)sxp->st.st_uid, F_OWNER(file));
344 "set gid of %s from %u to %u\n",
345 fname, (unsigned)sxp->st.st_gid, F_GROUP(file));
350 } else if (do_lchown(fname,
351 change_uid ? (uid_t)F_OWNER(file) : sxp->st.st_uid,
352 change_gid ? (gid_t)F_GROUP(file) : sxp->st.st_gid) != 0) {
353 /* shouldn't have attempted to change uid or gid
354 * unless have the privilege */
355 rsyserr(FERROR, errno, "%s %s failed",
356 change_uid ? "chown" : "chgrp",
360 /* a lchown had been done - we have to re-stat if the
361 * destination had the setuid or setgid bits set due
362 * to the side effect of the chown call */
363 if (sxp->st.st_mode & (S_ISUID | S_ISGID)) {
364 link_stat(fname, &sxp->st,
365 keep_dirlinks && S_ISDIR(sxp->st.st_mode));
370 if (daemon_chmod_modes && !S_ISLNK(new_mode))
371 new_mode = tweak_mode(new_mode, daemon_chmod_modes);
374 /* It's OK to call set_acl() now, even for a dir, as the generator
375 * will enable owner-writability using chmod, if necessary.
377 * If set_acl() changes permission bits in the process of setting
378 * an access ACL, it changes sxp->st.st_mode so we know whether we
379 * need to chmod(). */
380 if (preserve_acls && !S_ISLNK(new_mode) && set_acl(fname, file, sxp) == 0)
385 if (!BITS_EQUAL(sxp->st.st_mode, new_mode, CHMOD_BITS)) {
386 int ret = am_root < 0 ? 0 : do_chmod(fname, new_mode);
388 rsyserr(FERROR, errno,
389 "failed to set permissions on %s",
393 if (ret == 0) /* ret == 1 if symlink could not be set */
398 if (verbose > 1 && flags & ATTRS_REPORT) {
400 rprintf(FCLIENT, "%s\n", fname);
402 rprintf(FCLIENT, "%s is uptodate\n", fname);
410 #ifdef SUPPORT_XATTRS
418 RETSIGTYPE sig_int(UNUSED(int val))
420 /* KLUGE: if the user hits Ctrl-C while ssh is prompting
421 * for a password, then our cleanup's sending of a SIGUSR1
422 * signal to all our children may kill ssh before it has a
423 * chance to restore the tty settings (i.e. turn echo back
424 * on). By sleeping for a short time, ssh gets a bigger
425 * chance to do the right thing. If child processes are
426 * not ssh waiting for a password, then this tiny delay
427 * shouldn't hurt anything. */
429 exit_cleanup(RERR_SIGNAL);
432 /* Finish off a file transfer: renaming the file and setting the file's
433 * attributes (e.g. permissions, ownership, etc.). If partialptr is not
434 * NULL and the robust_rename() call is forced to copy the temp file, we
435 * stage the file into the partial-dir and then rename it into place. */
436 void finish_transfer(const char *fname, const char *fnametmp,
437 const char *fnamecmp, const char *partialptr,
438 struct file_struct *file, int ok_to_set_time,
439 int overwriting_basis)
445 rprintf(FINFO, "finishing %s\n", fname);
447 goto do_set_file_attrs;
450 if (make_backups > 0 && overwriting_basis && !make_backup(fname))
453 /* Change permissions before putting the file into place. */
454 set_file_attrs(fnametmp, file, NULL, fnamecmp,
455 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
457 /* move tmp file over real file */
459 rprintf(FINFO, "renaming %s to %s\n", fnametmp, fname);
460 ret = robust_rename(fnametmp, fname, partialptr,
461 file->mode & INITACCESSPERMS);
463 rsyserr(FERROR, errno, "%s %s -> \"%s\"",
464 ret == -2 ? "copy" : "rename",
465 full_fname(fnametmp), fname);
470 /* The file was moved into place (not copied), so it's done. */
473 /* The file was copied, so tweak the perms of the copied file. If it
474 * was copied to partialptr, move it into its final destination. */
475 fnametmp = partialptr ? partialptr : fname;
478 set_file_attrs(fnametmp, file, NULL, fnamecmp,
479 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
482 if (do_rename(fnametmp, fname) < 0) {
483 rsyserr(FERROR, errno, "rename %s -> \"%s\"",
484 full_fname(fnametmp), fname);
486 handle_partial_dir(partialptr, PDIR_DELETE);
490 struct file_list *flist_for_ndx(int ndx)
492 struct file_list *flist = cur_flist;
494 if (!flist && !(flist = first_flist))
497 while (ndx < flist->ndx_start-1) {
498 if (flist == first_flist)
502 while (ndx > flist->ndx_end) {
503 if (!(flist = flist->next))
509 const char *who_am_i(void)
512 return am_server ? "server" : "client";
513 return am_sender ? "sender" : am_generator ? "generator" : "receiver";