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-2008 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.
24 #if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
25 #include <libcharset.h>
26 #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 msgs2stderr;
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;
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... */
74 void setup_iconv(void)
76 const char *defset = default_charset();
82 if (!am_server && !allow_8bit_chars) {
83 /* It's OK if this fails... */
84 ic_chck = iconv_open(defset, defset);
86 if (DEBUG_GTE(ICONV, 2)) {
87 if (ic_chck == (iconv_t)-1) {
89 "msg checking via isprint()"
90 " (iconv_open(\"%s\", \"%s\") errno: %d)\n",
91 defset, defset, errno);
94 "msg checking charset: %s\n",
99 ic_chck = (iconv_t)-1;
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 (DEBUG_GTE(ICONV, 1)) {
130 rprintf(FINFO, "[%s] charset: %s\n",
131 who_am_i(), *charset ? charset : "[LOCALE]");
136 /* This function converts the characters in the "in" xbuf into characters
137 * in the "out" xbuf. The "len" of the "in" xbuf is used starting from its
138 * "pos". The "size" of the "out" xbuf restricts how many characters can be
139 * stored, starting at its "pos+len" position. Note that the last byte of
140 * the buffer is never used, which reserves space for a terminating '\0'.
141 * We return a 0 on success or a -1 on error. An error also sets errno to
142 * E2BIG, EILSEQ, or EINVAL (see below); otherwise errno will be set to 0.
143 * The "in" xbuf is altered to update "pos" and "len". The "out" xbuf has
144 * data appended, and its "len" incremented. If ICB_EXPAND_OUT is set in
145 * "flags", the "out" xbuf will also be allocated if empty, and expanded if
146 * too small (so E2BIG will not be returned). If ICB_INCLUDE_BAD is set in
147 * "flags", any badly-encoded chars are included verbatim in the "out" xbuf,
148 * so EILSEQ will not be returned. Likewise for ICB_INCLUDE_INCOMPLETE with
149 * respect to an incomplete multi-byte char at the end, which ensures that
150 * EINVAL is not returned. Anytime "in.pos" is 0 we will reset the iconv()
151 * state prior to processing the characters. */
152 int iconvbufs(iconv_t ic, xbuf *in, xbuf *out, int flags)
154 ICONV_CONST char *ibuf;
158 if (!out->size && flags & ICB_EXPAND_OUT)
159 alloc_xbuf(out, 1024);
162 iconv(ic, NULL, 0, NULL, 0);
164 ibuf = in->buf + in->pos;
167 obuf = out->buf + (out->pos + out->len);
168 ocnt = out->size - (out->pos + out->len) - 1;
171 while (iconv(ic, &ibuf, &icnt, &obuf, &ocnt) == (size_t)-1) {
174 if (errno == EINVAL) {
175 if (!(flags & ICB_INCLUDE_INCOMPLETE))
177 } else if (errno == EILSEQ) {
178 if (!(flags & ICB_INCLUDE_BAD))
181 size_t opos = obuf - out->buf;
182 if (!(flags & ICB_EXPAND_OUT)) {
186 realloc_xbuf(out, out->size + 1024);
187 obuf = out->buf + opos;
200 in->pos = ibuf - in->buf;
201 out->len = obuf - out->buf - out->pos;
203 return errno ? -1 : 0;
207 void send_protected_args(int fd, char *args[])
211 int convert = ic_send != (iconv_t)-1;
215 alloc_xbuf(&outbuf, 1024);
218 for (i = 0; args[i]; i++) {} /* find first NULL */
219 args[i] = "rsync"; /* set a new arg0 */
220 if (DEBUG_GTE(CMD, 1))
221 print_child_argv("protected args:", args + i + 1);
225 INIT_XBUF_STRLEN(inbuf, args[i]);
226 iconvbufs(ic_send, &inbuf, &outbuf,
227 ICB_EXPAND_OUT | ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
228 outbuf.buf[outbuf.len] = '\0';
229 write_buf(fd, outbuf.buf, outbuf.len + 1);
233 write_buf(fd, args[i], strlen(args[i]) + 1);
243 int read_ndx_and_attrs(int f_in, int *iflag_ptr, uchar *type_ptr,
244 char *buf, int *len_ptr)
247 struct file_list *flist;
248 uchar fnamecmp_type = FNAMECMP_FNAME;
253 ndx = read_ndx(f_in);
259 if (!inc_recurse || am_sender)
261 if (ndx == NDX_FLIST_EOF) {
263 send_msg(MSG_FLIST_EOF, "", 0, 0);
266 ndx = NDX_FLIST_OFFSET - ndx;
267 if (ndx < 0 || ndx >= dir_flist->used) {
268 ndx = NDX_FLIST_OFFSET - ndx;
270 "[%s] Invalid dir index: %d (%d - %d)\n",
271 who_am_i(), ndx, NDX_FLIST_OFFSET,
272 NDX_FLIST_OFFSET - dir_flist->used + 1);
273 exit_cleanup(RERR_PROTOCOL);
276 /* Send everything read from f_in to msg_fd_out. */
277 if (DEBUG_GTE(FLIST, 2)) {
278 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
282 negate_output_levels(); /* turn off all info/debug output */
283 send_msg_int(MSG_FLIST, ndx);
284 start_flist_forward(f_in);
285 flist = recv_file_list(f_in);
286 flist->parent_ndx = ndx;
287 stop_flist_forward();
289 negate_output_levels(); /* restore info/debug output */
292 iflags = protocol_version >= 29 ? read_shortint(f_in)
293 : ITEM_TRANSFER | ITEM_MISSING_DATA;
295 /* Honor the old-style keep-alive indicator. */
296 if (protocol_version < 30
297 && ndx == cur_flist->used && iflags == ITEM_IS_NEW) {
299 maybe_send_keepalive();
303 if (!(flist = flist_for_ndx(ndx))) {
306 start = first_flist ? first_flist->ndx_start : 0;
307 used = first_flist ? first_flist->used : 0;
309 "Invalid file index: %d (%d - %d) with iflags %x [%s]\n",
310 ndx, start - 1, start + used -1, iflags, who_am_i());
311 exit_cleanup(RERR_PROTOCOL);
315 if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
316 fnamecmp_type = read_byte(f_in);
317 *type_ptr = fnamecmp_type;
319 if (iflags & ITEM_XNAME_FOLLOWS) {
320 if ((len = read_vstring(f_in, buf, MAXPATHLEN)) < 0)
321 exit_cleanup(RERR_PROTOCOL);
328 if (iflags & ITEM_TRANSFER) {
329 int i = ndx - cur_flist->ndx_start;
330 if (i < 0 || !S_ISREG(cur_flist->files[i]->mode)) {
332 "received request to transfer non-regular file: %d [%s]\n",
334 exit_cleanup(RERR_PROTOCOL);
345 void free_sums(struct sum_struct *s)
347 if (s->sums) free(s->sums);
351 /* This is only called when we aren't preserving permissions. Figure out what
352 * the permissions should be and return them merged back into the mode. */
353 mode_t dest_mode(mode_t flist_mode, mode_t stat_mode, int dflt_perms,
357 /* If the file already exists, we'll return the local permissions,
358 * possibly tweaked by the --executability option. */
360 new_mode = (flist_mode & ~CHMOD_BITS) | (stat_mode & CHMOD_BITS);
361 if (preserve_executability && S_ISREG(flist_mode)) {
362 /* If the source file is executable, grant execute
363 * rights to everyone who can read, but ONLY if the
364 * file isn't already executable. */
365 if (!(flist_mode & 0111))
367 else if (!(stat_mode & 0111))
368 new_mode |= (new_mode & 0444) >> 2;
371 /* Apply destination default permissions and turn
372 * off special permissions. */
373 new_mode = flist_mode & (~CHMOD_BITS | dflt_perms);
378 int set_file_attrs(const char *fname, struct file_struct *file, stat_x *sxp,
379 const char *fnamecmp, int flags)
383 int change_uid, change_gid;
384 mode_t new_mode = file->mode;
390 if (link_stat(fname, &sx2.st, 0) < 0) {
391 rsyserr(FERROR_XFER, errno, "stat %s failed",
396 sx2.acc_acl = sx2.def_acl = NULL;
398 #ifdef SUPPORT_XATTRS
402 inherit = !preserve_perms;
404 inherit = !preserve_perms && file->flags & FLAG_DIR_CREATED;
406 if (inherit && S_ISDIR(new_mode) && sxp->st.st_mode & S_ISGID) {
407 /* We just created this directory and its setgid
408 * bit is on, so make sure it stays on. */
412 if (daemon_chmod_modes && !S_ISLNK(new_mode))
413 new_mode = tweak_mode(new_mode, daemon_chmod_modes);
416 if (preserve_acls && !S_ISLNK(file->mode) && !ACL_READY(*sxp))
420 #ifdef SUPPORT_XATTRS
422 set_stat_xattr(fname, file, new_mode);
423 if (preserve_xattrs && fnamecmp)
424 set_xattr(fname, file, fnamecmp, sxp);
427 if (!preserve_times || (S_ISDIR(sxp->st.st_mode) && preserve_times == 1))
428 flags |= ATTRS_SKIP_MTIME;
429 if (!(flags & ATTRS_SKIP_MTIME)
430 && cmp_time(sxp->st.st_mtime, file->modtime) != 0) {
431 int ret = set_modtime(fname, file->modtime, sxp->st.st_mode);
433 rsyserr(FERROR_XFER, errno, "failed to set times on %s",
437 if (ret == 0) /* ret == 1 if symlink could not be set */
440 file->flags |= FLAG_TIME_FAILED;
443 change_uid = am_root && uid_ndx && sxp->st.st_uid != (uid_t)F_OWNER(file);
444 change_gid = gid_ndx && !(file->flags & FLAG_SKIP_GROUP)
445 && sxp->st.st_gid != (gid_t)F_GROUP(file);
446 #if !defined HAVE_LCHOWN && !defined CHOWN_MODIFIES_SYMLINK
447 if (S_ISLNK(sxp->st.st_mode)) {
451 if (change_uid || change_gid) {
452 if (DEBUG_GTE(OWN, 1)) {
455 "set uid of %s from %u to %u\n",
456 fname, (unsigned)sxp->st.st_uid, F_OWNER(file));
460 "set gid of %s from %u to %u\n",
461 fname, (unsigned)sxp->st.st_gid, F_GROUP(file));
466 change_uid ? (uid_t)F_OWNER(file) : sxp->st.st_uid,
467 change_gid ? (gid_t)F_GROUP(file) : sxp->st.st_gid) != 0) {
468 /* We shouldn't have attempted to change uid
469 * or gid unless have the privilege. */
470 rsyserr(FERROR_XFER, errno, "%s %s failed",
471 change_uid ? "chown" : "chgrp",
475 /* A lchown had been done, so we need to re-stat if
476 * the destination had the setuid or setgid bits set
477 * (due to the side effect of the chown call). */
478 if (sxp->st.st_mode & (S_ISUID | S_ISGID)) {
479 link_stat(fname, &sxp->st,
480 keep_dirlinks && S_ISDIR(sxp->st.st_mode));
487 /* It's OK to call set_acl() now, even for a dir, as the generator
488 * will enable owner-writability using chmod, if necessary.
490 * If set_acl() changes permission bits in the process of setting
491 * an access ACL, it changes sxp->st.st_mode so we know whether we
492 * need to chmod(). */
493 if (preserve_acls && !S_ISLNK(new_mode) && set_acl(fname, file, sxp) == 0)
498 if (!BITS_EQUAL(sxp->st.st_mode, new_mode, CHMOD_BITS)) {
499 int ret = am_root < 0 ? 0 : do_chmod(fname, new_mode);
501 rsyserr(FERROR_XFER, errno,
502 "failed to set permissions on %s",
506 if (ret == 0) /* ret == 1 if symlink could not be set */
511 if (INFO_GTE(NAME, 2) && flags & ATTRS_REPORT) {
513 rprintf(FCLIENT, "%s\n", fname);
515 rprintf(FCLIENT, "%s is uptodate\n", fname);
523 #ifdef SUPPORT_XATTRS
531 RETSIGTYPE sig_int(UNUSED(int val))
533 /* KLUGE: if the user hits Ctrl-C while ssh is prompting
534 * for a password, then our cleanup's sending of a SIGUSR1
535 * signal to all our children may kill ssh before it has a
536 * chance to restore the tty settings (i.e. turn echo back
537 * on). By sleeping for a short time, ssh gets a bigger
538 * chance to do the right thing. If child processes are
539 * not ssh waiting for a password, then this tiny delay
540 * shouldn't hurt anything. */
542 exit_cleanup(RERR_SIGNAL);
545 /* Finish off a file transfer: renaming the file and setting the file's
546 * attributes (e.g. permissions, ownership, etc.). If the robust_rename()
547 * call is forced to copy the temp file and partialptr is both non-NULL and
548 * not an absolute path, we stage the file into the partial-dir and then
549 * rename it into place. This returns 1 on succcess or 0 on failure. */
550 int finish_transfer(const char *fname, const char *fnametmp,
551 const char *fnamecmp, const char *partialptr,
552 struct file_struct *file, int ok_to_set_time,
553 int overwriting_basis)
556 const char *temp_copy_name = partialptr && *partialptr != '/' ? partialptr : NULL;
559 if (DEBUG_GTE(RECV, 1))
560 rprintf(FINFO, "finishing %s\n", fname);
562 goto do_set_file_attrs;
565 if (make_backups > 0 && overwriting_basis) {
566 if (!make_backup(fname))
568 if (fnamecmp == fname)
569 fnamecmp = get_backup_name(fname);
572 /* Change permissions before putting the file into place. */
573 set_file_attrs(fnametmp, file, NULL, fnamecmp,
574 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
576 /* move tmp file over real file */
577 if (DEBUG_GTE(RECV, 1))
578 rprintf(FINFO, "renaming %s to %s\n", fnametmp, fname);
579 ret = robust_rename(fnametmp, fname, temp_copy_name,
580 file->mode & INITACCESSPERMS);
582 rsyserr(FERROR_XFER, errno, "%s %s -> \"%s\"",
583 ret == -2 ? "copy" : "rename",
584 full_fname(fnametmp), fname);
585 if (!partialptr || (ret == -2 && temp_copy_name)
586 || robust_rename(fnametmp, partialptr, NULL,
587 file->mode & INITACCESSPERMS) < 0)
592 /* The file was moved into place (not copied), so it's done. */
595 /* The file was copied, so tweak the perms of the copied file. If it
596 * was copied to partialptr, move it into its final destination. */
597 fnametmp = temp_copy_name ? temp_copy_name : fname;
600 set_file_attrs(fnametmp, file, NULL, fnamecmp,
601 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
603 if (temp_copy_name) {
604 if (do_rename(fnametmp, fname) < 0) {
605 rsyserr(FERROR_XFER, errno, "rename %s -> \"%s\"",
606 full_fname(fnametmp), fname);
609 handle_partial_dir(temp_copy_name, PDIR_DELETE);
614 struct file_list *flist_for_ndx(int ndx)
616 struct file_list *flist = cur_flist;
618 if (!flist && !(flist = first_flist))
621 while (ndx < flist->ndx_start-1) {
622 if (flist == first_flist)
626 while (ndx >= flist->ndx_start + flist->used) {
627 if (!(flist = flist->next))
633 const char *who_am_i(void)
636 return am_server ? "server" : "client";
637 return am_sender ? "sender" : am_generator ? "generator" : "receiver";