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;
36 extern int omit_dir_times;
40 extern int am_generator;
41 extern int am_starting_up;
42 extern int allow_8bit_chars;
43 extern int protocol_version;
46 extern int inc_recurse;
49 extern int keep_dirlinks;
50 extern int make_backups;
51 extern struct file_list *cur_flist, *first_flist, *dir_flist;
52 extern struct chmod_mode_struct *daemon_chmod_modes;
54 extern char *iconv_opt;
58 iconv_t ic_chck = (iconv_t)-1;
60 iconv_t ic_send = (iconv_t)-1, ic_recv = (iconv_t)-1;
64 static const char *default_charset(void)
66 #if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
67 return locale_charset();
68 #elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
69 return nl_langinfo(CODESET);
71 return ""; /* Works with (at the very least) gnu iconv... */
77 const char *defset = default_charset();
83 if (!am_server && !allow_8bit_chars) {
85 /* It's OK if this fails... */
86 ic_chck = iconv_open(defset, defset);
89 if (ic_chck == (iconv_t)-1) {
91 "note: iconv_open(\"%s\", \"%s\") failed (%d)"
92 " -- using isprint() instead of iconv().\n",
93 defset, defset, errno);
96 "note: iconv_open(\"%s\", \"%s\") succeeded.\n",
106 if ((cp = strchr(iconv_opt, ',')) != NULL) {
107 if (am_server) /* A local transfer needs this. */
113 if (!*iconv_opt || (*iconv_opt == '.' && iconv_opt[1] == '\0'))
118 if ((ic_send = iconv_open(UTF8_CHARSET, charset)) == (iconv_t)-1) {
119 rprintf(FERROR, "iconv_open(\"%s\", \"%s\") failed\n",
120 UTF8_CHARSET, charset);
121 exit_cleanup(RERR_UNSUPPORTED);
124 if ((ic_recv = iconv_open(charset, UTF8_CHARSET)) == (iconv_t)-1) {
125 rprintf(FERROR, "iconv_open(\"%s\", \"%s\") failed\n",
126 charset, UTF8_CHARSET);
127 exit_cleanup(RERR_UNSUPPORTED);
130 if (!am_sender || inc_recurse)
131 ic_ndx = ++file_extra_cnt;
134 rprintf(FINFO, "%s charset: %s\n",
135 am_server ? "server" : "client",
136 *charset ? charset : "[LOCALE]");
142 int read_ndx_and_attrs(int f_in, int *iflag_ptr, uchar *type_ptr,
143 char *buf, int *len_ptr)
146 struct file_list *flist;
147 uchar fnamecmp_type = FNAMECMP_FNAME;
152 ndx = read_ndx(f_in);
158 if (!inc_recurse || am_sender)
160 if (ndx == NDX_FLIST_EOF) {
162 send_msg(MSG_FLIST_EOF, "", 0, 0);
165 ndx = NDX_FLIST_OFFSET - ndx;
166 if (ndx < 0 || ndx >= dir_flist->used) {
167 ndx = NDX_FLIST_OFFSET - ndx;
169 "[%s] Invalid dir index: %d (%d - %d)\n",
170 who_am_i(), ndx, NDX_FLIST_OFFSET,
171 NDX_FLIST_OFFSET - dir_flist->used + 1);
172 exit_cleanup(RERR_PROTOCOL);
175 /* Send everything read from f_in to msg_fd_out. */
176 send_msg_int(MSG_FLIST, ndx);
177 start_flist_forward(f_in);
179 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
182 flist = recv_file_list(f_in);
183 flist->parent_ndx = ndx;
184 stop_flist_forward();
187 iflags = protocol_version >= 29 ? read_shortint(f_in)
188 : ITEM_TRANSFER | ITEM_MISSING_DATA;
190 /* Honor the old-style keep-alive indicator. */
191 if (protocol_version < 30
192 && ndx == cur_flist->used && iflags == ITEM_IS_NEW) {
194 maybe_send_keepalive();
198 if (!(flist = flist_for_ndx(ndx))) {
201 "Invalid file index: %d (%d - %d) with iflags %x [%s]\n",
202 ndx, first_flist->ndx_start - 1, first_flist->prev->ndx_end,
204 exit_cleanup(RERR_PROTOCOL);
208 if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
209 fnamecmp_type = read_byte(f_in);
210 *type_ptr = fnamecmp_type;
212 if (iflags & ITEM_XNAME_FOLLOWS) {
213 if ((len = read_vstring(f_in, buf, MAXPATHLEN)) < 0)
214 exit_cleanup(RERR_PROTOCOL);
221 if (iflags & ITEM_TRANSFER) {
222 int i = ndx - cur_flist->ndx_start;
223 if (i < 0 || !S_ISREG(cur_flist->files[i]->mode)) {
225 "received request to transfer non-regular file: %d [%s]\n",
227 exit_cleanup(RERR_PROTOCOL);
238 void free_sums(struct sum_struct *s)
240 if (s->sums) free(s->sums);
244 /* This is only called when we aren't preserving permissions. Figure out what
245 * the permissions should be and return them merged back into the mode. */
246 mode_t dest_mode(mode_t flist_mode, mode_t stat_mode, int dflt_perms,
250 /* If the file already exists, we'll return the local permissions,
251 * possibly tweaked by the --executability option. */
253 new_mode = (flist_mode & ~CHMOD_BITS) | (stat_mode & CHMOD_BITS);
254 if (preserve_executability && S_ISREG(flist_mode)) {
255 /* If the source file is executable, grant execute
256 * rights to everyone who can read, but ONLY if the
257 * file isn't already executable. */
258 if (!(flist_mode & 0111))
260 else if (!(stat_mode & 0111))
261 new_mode |= (new_mode & 0444) >> 2;
264 /* Apply destination default permissions and turn
265 * off special permissions. */
266 new_mode = flist_mode & (~CHMOD_BITS | dflt_perms);
271 int set_file_attrs(const char *fname, struct file_struct *file, statx *sxp,
272 const char *fnamecmp, int flags)
276 int change_uid, change_gid;
277 mode_t new_mode = file->mode;
282 if (link_stat(fname, &sx2.st, 0) < 0) {
283 rsyserr(FERROR, errno, "stat %s failed",
288 sx2.acc_acl = sx2.def_acl = NULL;
290 #ifdef SUPPORT_XATTRS
293 if (!preserve_perms && S_ISDIR(new_mode)
294 && sx2.st.st_mode & S_ISGID) {
295 /* We just created this directory and its setgid
296 * bit is on, so make sure it stays on. */
303 if (preserve_acls && !S_ISLNK(file->mode) && !ACL_READY(*sxp))
307 #ifdef SUPPORT_XATTRS
308 if (preserve_xattrs && fnamecmp)
309 set_xattr(fname, file, fnamecmp, sxp);
311 set_stat_xattr(fname, file);
314 if (!preserve_times || (S_ISDIR(sxp->st.st_mode) && omit_dir_times))
315 flags |= ATTRS_SKIP_MTIME;
316 if (!(flags & ATTRS_SKIP_MTIME)
317 && cmp_time(sxp->st.st_mtime, file->modtime) != 0) {
318 int ret = set_modtime(fname, file->modtime, sxp->st.st_mode);
320 rsyserr(FERROR, errno, "failed to set times on %s",
324 if (ret == 0) /* ret == 1 if symlink could not be set */
328 change_uid = am_root && uid_ndx && sxp->st.st_uid != (uid_t)F_OWNER(file);
329 change_gid = gid_ndx && !(file->flags & FLAG_SKIP_GROUP)
330 && sxp->st.st_gid != (gid_t)F_GROUP(file);
331 #if !defined HAVE_LCHOWN && !defined CHOWN_MODIFIES_SYMLINK
332 if (S_ISLNK(sxp->st.st_mode))
336 if (change_uid || change_gid) {
340 "set uid of %s from %u to %u\n",
341 fname, (unsigned)sxp->st.st_uid, F_OWNER(file));
345 "set gid of %s from %u to %u\n",
346 fname, (unsigned)sxp->st.st_gid, F_GROUP(file));
351 } else if (do_lchown(fname,
352 change_uid ? (uid_t)F_OWNER(file) : sxp->st.st_uid,
353 change_gid ? (gid_t)F_GROUP(file) : sxp->st.st_gid) != 0) {
354 /* shouldn't have attempted to change uid or gid
355 * unless have the privilege */
356 rsyserr(FERROR, errno, "%s %s failed",
357 change_uid ? "chown" : "chgrp",
361 /* a lchown had been done - we have to re-stat if the
362 * destination had the setuid or setgid bits set due
363 * to the side effect of the chown call */
364 if (sxp->st.st_mode & (S_ISUID | S_ISGID)) {
365 link_stat(fname, &sxp->st,
366 keep_dirlinks && S_ISDIR(sxp->st.st_mode));
371 if (daemon_chmod_modes && !S_ISLNK(new_mode))
372 new_mode = tweak_mode(new_mode, daemon_chmod_modes);
375 /* It's OK to call set_acl() now, even for a dir, as the generator
376 * will enable owner-writability using chmod, if necessary.
378 * If set_acl() changes permission bits in the process of setting
379 * an access ACL, it changes sxp->st.st_mode so we know whether we
380 * need to chmod(). */
381 if (preserve_acls && !S_ISLNK(new_mode) && set_acl(fname, file, sxp) == 0)
386 if (!BITS_EQUAL(sxp->st.st_mode, new_mode, CHMOD_BITS)) {
387 int ret = am_root < 0 ? 0 : do_chmod(fname, new_mode);
389 rsyserr(FERROR, errno,
390 "failed to set permissions on %s",
394 if (ret == 0) /* ret == 1 if symlink could not be set */
399 if (verbose > 1 && flags & ATTRS_REPORT) {
401 rprintf(FCLIENT, "%s\n", fname);
403 rprintf(FCLIENT, "%s is uptodate\n", fname);
411 #ifdef SUPPORT_XATTRS
419 RETSIGTYPE sig_int(UNUSED(int val))
421 /* KLUGE: if the user hits Ctrl-C while ssh is prompting
422 * for a password, then our cleanup's sending of a SIGUSR1
423 * signal to all our children may kill ssh before it has a
424 * chance to restore the tty settings (i.e. turn echo back
425 * on). By sleeping for a short time, ssh gets a bigger
426 * chance to do the right thing. If child processes are
427 * not ssh waiting for a password, then this tiny delay
428 * shouldn't hurt anything. */
430 exit_cleanup(RERR_SIGNAL);
433 /* Finish off a file transfer: renaming the file and setting the file's
434 * attributes (e.g. permissions, ownership, etc.). If partialptr is not
435 * NULL and the robust_rename() call is forced to copy the temp file, we
436 * stage the file into the partial-dir and then rename it into place. */
437 void finish_transfer(const char *fname, const char *fnametmp,
438 const char *fnamecmp, const char *partialptr,
439 struct file_struct *file, int ok_to_set_time,
440 int overwriting_basis)
446 rprintf(FINFO, "finishing %s\n", fname);
448 goto do_set_file_attrs;
451 if (make_backups > 0 && overwriting_basis && !make_backup(fname))
454 /* Change permissions before putting the file into place. */
455 set_file_attrs(fnametmp, file, NULL, fnamecmp,
456 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
458 /* move tmp file over real file */
460 rprintf(FINFO, "renaming %s to %s\n", fnametmp, fname);
461 ret = robust_rename(fnametmp, fname, partialptr,
462 file->mode & INITACCESSPERMS);
464 rsyserr(FERROR, errno, "%s %s -> \"%s\"",
465 ret == -2 ? "copy" : "rename",
466 full_fname(fnametmp), fname);
471 /* The file was moved into place (not copied), so it's done. */
474 /* The file was copied, so tweak the perms of the copied file. If it
475 * was copied to partialptr, move it into its final destination. */
476 fnametmp = partialptr ? partialptr : fname;
479 set_file_attrs(fnametmp, file, NULL, fnamecmp,
480 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
483 if (do_rename(fnametmp, fname) < 0) {
484 rsyserr(FERROR, errno, "rename %s -> \"%s\"",
485 full_fname(fnametmp), fname);
487 handle_partial_dir(partialptr, PDIR_DELETE);
491 struct file_list *flist_for_ndx(int ndx)
493 struct file_list *flist = cur_flist;
495 if (!flist && !(flist = first_flist))
498 while (ndx < flist->ndx_start-1) {
499 if (flist == first_flist)
503 while (ndx > flist->ndx_end) {
504 if (!(flist = flist->next))
510 const char *who_am_i(void)
513 return am_server ? "server" : "client";
514 return am_sender ? "sender" : am_generator ? "generator" : "receiver";