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-2009 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 file_old_total;
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 chars in the "in" xbuf into characters in the
137 * "out" xbuf. The ".len" chars of the "in" xbuf is used starting from its
138 * ".pos". The ".size" of the "out" xbuf restricts how many characters can
139 * be stored, starting at its ".pos+.len" position. Note that the last byte
140 * of the "out" xbuf is not used, which reserves space for a trailing '\0'
141 * (though it is up to the caller to store a trailing '\0', as needed).
143 * We return a 0 on success or a -1 on error. An error also sets errno to
144 * E2BIG, EILSEQ, or EINVAL (see below); otherwise errno will be set to 0.
145 * The "in" xbuf is altered to update ".pos" and ".len". The "out" xbuf has
146 * data appended, and its ".len" incremented (see below for a ".size" note).
148 * If ICB_CIRCULAR_OUT is set in "flags", the chars going into the "out" xbuf
149 * can wrap around to the start, and the xbuf may have its ".size" reduced
150 * (presumably by 1 byte) if the iconv code doesn't have space to store a
151 * multi-byte character at the physical end of the ".buf" (though no reducing
152 * happens if ".pos" is <= 1, since there is no room to wrap around).
154 * If ICB_EXPAND_OUT is set in "flags", the "out" xbuf will be allocated if
155 * empty, and (as long as ICB_CIRCULAR_OUT is not set) expanded if too small.
156 * This prevents the return of E2BIG (except for a circular xbuf).
158 * If ICB_INCLUDE_BAD is set in "flags", any badly-encoded chars are included
159 * verbatim in the "out" xbuf, so EILSEQ will not be returned.
161 * If ICB_INCLUDE_INCOMPLETE is set in "flags", any incomplete multi-byte
162 * chars are included, which ensures that EINVAL is not returned.
164 * If ICB_INIT is set, the iconv() conversion state is initialized prior to
165 * processing the characters. */
166 int iconvbufs(iconv_t ic, xbuf *in, xbuf *out, int flags)
168 ICONV_CONST char *ibuf;
169 size_t icnt, ocnt, opos;
172 if (!out->size && flags & ICB_EXPAND_OUT) {
173 size_t siz = ROUND_UP_1024(in->len * 2);
174 alloc_xbuf(out, siz);
175 } else if (out->len+1 >= out->size) {
176 /* There is no room to even start storing data. */
177 if (!(flags & ICB_EXPAND_OUT) || flags & ICB_CIRCULAR_OUT) {
181 realloc_xbuf(out, out->size + ROUND_UP_1024(in->len * 2));
184 if (flags & ICB_INIT)
185 iconv(ic, NULL, 0, NULL, 0);
187 ibuf = in->buf + in->pos;
190 opos = out->pos + out->len;
191 if (flags & ICB_CIRCULAR_OUT) {
192 if (opos >= out->size) {
194 /* We know that out->pos is not 0 due to the "no room" check
195 * above, so this can't go "negative". */
196 ocnt = out->pos - opos - 1;
198 /* Allow the use of all bytes to the physical end of the buffer
199 * unless pos is 0, in which case we reserve our trailing '\0'. */
200 ocnt = out->size - opos - (out->pos ? 0 : 1);
203 ocnt = out->size - opos - 1;
204 obuf = out->buf + opos;
207 while (iconv(ic, &ibuf, &icnt, &obuf, &ocnt) == (size_t)-1) {
210 if (errno == EINVAL) {
211 if (!(flags & ICB_INCLUDE_INCOMPLETE))
213 } else if (errno == EILSEQ) {
214 if (!(flags & ICB_INCLUDE_BAD))
216 } else if (errno == E2BIG) {
218 opos = obuf - out->buf;
219 if (flags & ICB_CIRCULAR_OUT && out->pos > 1 && opos > out->pos) {
220 /* We are in a divided circular buffer at the physical
221 * end with room to wrap to the start. If iconv() refused
222 * to use one or more trailing bytes in the buffer, we
223 * set the size to ignore the unused bytes. */
224 if (opos < out->size)
225 reduce_iobuf_size(out, opos);
230 if (!(flags & ICB_EXPAND_OUT) || flags & ICB_CIRCULAR_OUT) {
234 siz = ROUND_UP_1024(in->len * 2);
235 realloc_xbuf(out, out->size + siz);
236 obuf = out->buf + opos;
240 rsyserr(FERROR, errno, "unexpected error from iconv()");
241 exit_cleanup(RERR_UNSUPPORTED);
251 opos = obuf - out->buf;
252 if (flags & ICB_CIRCULAR_OUT && opos < out->pos)
254 out->len = opos - out->pos;
257 in->pos = ibuf - in->buf;
259 return errno ? -1 : 0;
263 void send_protected_args(int fd, char *args[])
267 int convert = ic_send != (iconv_t)-1;
271 alloc_xbuf(&outbuf, 1024);
274 for (i = 0; args[i]; i++) {} /* find first NULL */
275 args[i] = "rsync"; /* set a new arg0 */
276 if (DEBUG_GTE(CMD, 1))
277 print_child_argv("protected args:", args + i + 1);
280 write_buf(fd, ".", 2);
283 INIT_XBUF_STRLEN(inbuf, args[i]);
284 iconvbufs(ic_send, &inbuf, &outbuf,
285 ICB_EXPAND_OUT | ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE | ICB_INIT);
286 outbuf.buf[outbuf.len] = '\0';
287 write_buf(fd, outbuf.buf, outbuf.len + 1);
292 write_buf(fd, args[i], strlen(args[i]) + 1);
302 int read_ndx_and_attrs(int f_in, int f_out, int *iflag_ptr, uchar *type_ptr,
303 char *buf, int *len_ptr)
306 struct file_list *flist;
307 uchar fnamecmp_type = FNAMECMP_FNAME;
312 ndx = read_ndx(f_in);
318 if (ndx == NDX_DEL_STATS) {
319 read_del_stats(f_in);
320 if (am_sender && am_server)
321 write_del_stats(f_out);
324 if (!inc_recurse || am_sender) {
327 last = first_flist->prev->ndx_start + first_flist->prev->used - 1;
331 "Invalid file index: %d (%d - %d) [%s]\n",
332 ndx, NDX_DONE, last, who_am_i());
333 exit_cleanup(RERR_PROTOCOL);
335 if (ndx == NDX_FLIST_EOF) {
337 if (DEBUG_GTE(FLIST, 3))
338 rprintf(FINFO, "[%s] flist_eof=1\n", who_am_i());
339 write_int(f_out, NDX_FLIST_EOF);
342 ndx = NDX_FLIST_OFFSET - ndx;
343 if (ndx < 0 || ndx >= dir_flist->used) {
344 ndx = NDX_FLIST_OFFSET - ndx;
346 "Invalid dir index: %d (%d - %d) [%s]\n",
347 ndx, NDX_FLIST_OFFSET,
348 NDX_FLIST_OFFSET - dir_flist->used + 1,
350 exit_cleanup(RERR_PROTOCOL);
353 if (DEBUG_GTE(FLIST, 2)) {
354 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
357 /* Send all the data we read for this flist to the generator. */
358 start_flist_forward(ndx);
359 flist = recv_file_list(f_in);
360 flist->parent_ndx = ndx;
361 stop_flist_forward();
364 iflags = protocol_version >= 29 ? read_shortint(f_in)
365 : ITEM_TRANSFER | ITEM_MISSING_DATA;
367 /* Honor the old-style keep-alive indicator. */
368 if (protocol_version < 30
369 && ndx == cur_flist->used && iflags == ITEM_IS_NEW) {
371 maybe_send_keepalive();
375 flist = flist_for_ndx(ndx, "read_ndx_and_attrs");
376 if (flist != cur_flist) {
379 file_old_total = cur_flist->used;
380 for (flist = first_flist; flist != cur_flist; flist = flist->next)
381 file_old_total += flist->used;
385 if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
386 fnamecmp_type = read_byte(f_in);
387 *type_ptr = fnamecmp_type;
389 if (iflags & ITEM_XNAME_FOLLOWS) {
390 if ((len = read_vstring(f_in, buf, MAXPATHLEN)) < 0)
391 exit_cleanup(RERR_PROTOCOL);
398 if (iflags & ITEM_TRANSFER) {
399 int i = ndx - cur_flist->ndx_start;
400 if (i < 0 || !S_ISREG(cur_flist->files[i]->mode)) {
402 "received request to transfer non-regular file: %d [%s]\n",
404 exit_cleanup(RERR_PROTOCOL);
415 void free_sums(struct sum_struct *s)
417 if (s->sums) free(s->sums);
421 /* This is only called when we aren't preserving permissions. Figure out what
422 * the permissions should be and return them merged back into the mode. */
423 mode_t dest_mode(mode_t flist_mode, mode_t stat_mode, int dflt_perms,
427 /* If the file already exists, we'll return the local permissions,
428 * possibly tweaked by the --executability option. */
430 new_mode = (flist_mode & ~CHMOD_BITS) | (stat_mode & CHMOD_BITS);
431 if (preserve_executability && S_ISREG(flist_mode)) {
432 /* If the source file is executable, grant execute
433 * rights to everyone who can read, but ONLY if the
434 * file isn't already executable. */
435 if (!(flist_mode & 0111))
437 else if (!(stat_mode & 0111))
438 new_mode |= (new_mode & 0444) >> 2;
441 /* Apply destination default permissions and turn
442 * off special permissions. */
443 new_mode = flist_mode & (~CHMOD_BITS | dflt_perms);
448 int set_file_attrs(const char *fname, struct file_struct *file, stat_x *sxp,
449 const char *fnamecmp, int flags)
453 int change_uid, change_gid;
454 mode_t new_mode = file->mode;
460 if (link_stat(fname, &sx2.st, 0) < 0) {
461 rsyserr(FERROR_XFER, errno, "stat %s failed",
467 inherit = !preserve_perms;
469 inherit = !preserve_perms && file->flags & FLAG_DIR_CREATED;
471 if (inherit && S_ISDIR(new_mode) && sxp->st.st_mode & S_ISGID) {
472 /* We just created this directory and its setgid
473 * bit is on, so make sure it stays on. */
477 if (daemon_chmod_modes && !S_ISLNK(new_mode))
478 new_mode = tweak_mode(new_mode, daemon_chmod_modes);
481 if (preserve_acls && !S_ISLNK(file->mode) && !ACL_READY(*sxp))
485 #ifdef SUPPORT_XATTRS
487 set_stat_xattr(fname, file, new_mode);
488 if (preserve_xattrs && fnamecmp)
489 set_xattr(fname, file, fnamecmp, sxp);
492 if (!preserve_times || (S_ISDIR(sxp->st.st_mode) && preserve_times == 1))
493 flags |= ATTRS_SKIP_MTIME;
494 if (!(flags & ATTRS_SKIP_MTIME)
495 && cmp_time(sxp->st.st_mtime, file->modtime) != 0) {
496 int ret = set_modtime(fname, file->modtime, F_MOD_NSEC(file), sxp->st.st_mode);
498 rsyserr(FERROR_XFER, errno, "failed to set times on %s",
502 if (ret == 0) /* ret == 1 if symlink could not be set */
505 file->flags |= FLAG_TIME_FAILED;
508 change_uid = am_root && uid_ndx && sxp->st.st_uid != (uid_t)F_OWNER(file);
509 change_gid = gid_ndx && !(file->flags & FLAG_SKIP_GROUP)
510 && sxp->st.st_gid != (gid_t)F_GROUP(file);
511 #if !defined HAVE_LCHOWN && !defined CHOWN_MODIFIES_SYMLINK
512 if (S_ISLNK(sxp->st.st_mode)) {
516 if (change_uid || change_gid) {
517 if (DEBUG_GTE(OWN, 1)) {
520 "set uid of %s from %u to %u\n",
521 fname, (unsigned)sxp->st.st_uid, F_OWNER(file));
525 "set gid of %s from %u to %u\n",
526 fname, (unsigned)sxp->st.st_gid, F_GROUP(file));
531 change_uid ? (uid_t)F_OWNER(file) : sxp->st.st_uid,
532 change_gid ? (gid_t)F_GROUP(file) : sxp->st.st_gid) != 0) {
533 /* We shouldn't have attempted to change uid
534 * or gid unless have the privilege. */
535 rsyserr(FERROR_XFER, errno, "%s %s failed",
536 change_uid ? "chown" : "chgrp",
540 /* A lchown had been done, so we need to re-stat if
541 * the destination had the setuid or setgid bits set
542 * (due to the side effect of the chown call). */
543 if (sxp->st.st_mode & (S_ISUID | S_ISGID)) {
544 link_stat(fname, &sxp->st,
545 keep_dirlinks && S_ISDIR(sxp->st.st_mode));
552 /* It's OK to call set_acl() now, even for a dir, as the generator
553 * will enable owner-writability using chmod, if necessary.
555 * If set_acl() changes permission bits in the process of setting
556 * an access ACL, it changes sxp->st.st_mode so we know whether we
557 * need to chmod(). */
558 if (preserve_acls && !S_ISLNK(new_mode)) {
559 if (set_acl(fname, file, sxp, new_mode) > 0)
565 if (!BITS_EQUAL(sxp->st.st_mode, new_mode, CHMOD_BITS)) {
566 int ret = am_root < 0 ? 0 : do_chmod(fname, new_mode);
568 rsyserr(FERROR_XFER, errno,
569 "failed to set permissions on %s",
573 if (ret == 0) /* ret == 1 if symlink could not be set */
578 if (INFO_GTE(NAME, 2) && flags & ATTRS_REPORT) {
580 rprintf(FCLIENT, "%s\n", fname);
582 rprintf(FCLIENT, "%s is uptodate\n", fname);
590 #ifdef SUPPORT_XATTRS
598 RETSIGTYPE sig_int(UNUSED(int val))
600 /* KLUGE: if the user hits Ctrl-C while ssh is prompting
601 * for a password, then our cleanup's sending of a SIGUSR1
602 * signal to all our children may kill ssh before it has a
603 * chance to restore the tty settings (i.e. turn echo back
604 * on). By sleeping for a short time, ssh gets a bigger
605 * chance to do the right thing. If child processes are
606 * not ssh waiting for a password, then this tiny delay
607 * shouldn't hurt anything. */
609 exit_cleanup(RERR_SIGNAL);
612 /* Finish off a file transfer: renaming the file and setting the file's
613 * attributes (e.g. permissions, ownership, etc.). If the robust_rename()
614 * call is forced to copy the temp file and partialptr is both non-NULL and
615 * not an absolute path, we stage the file into the partial-dir and then
616 * rename it into place. This returns 1 on succcess or 0 on failure. */
617 int finish_transfer(const char *fname, const char *fnametmp,
618 const char *fnamecmp, const char *partialptr,
619 struct file_struct *file, int ok_to_set_time,
620 int overwriting_basis)
623 const char *temp_copy_name = partialptr && *partialptr != '/' ? partialptr : NULL;
626 if (DEBUG_GTE(RECV, 1))
627 rprintf(FINFO, "finishing %s\n", fname);
629 goto do_set_file_attrs;
632 if (make_backups > 0 && overwriting_basis) {
633 int ok = make_backup(fname, False);
636 if (ok == 1 && fnamecmp == fname)
637 fnamecmp = get_backup_name(fname);
640 /* Change permissions before putting the file into place. */
641 set_file_attrs(fnametmp, file, NULL, fnamecmp,
642 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
644 /* move tmp file over real file */
645 if (DEBUG_GTE(RECV, 1))
646 rprintf(FINFO, "renaming %s to %s\n", fnametmp, fname);
647 ret = robust_rename(fnametmp, fname, temp_copy_name,
648 file->mode & INITACCESSPERMS);
650 rsyserr(FERROR_XFER, errno, "%s %s -> \"%s\"",
651 ret == -2 ? "copy" : "rename",
652 full_fname(fnametmp), fname);
653 if (!partialptr || (ret == -2 && temp_copy_name)
654 || robust_rename(fnametmp, partialptr, NULL,
655 file->mode & INITACCESSPERMS) < 0)
660 /* The file was moved into place (not copied), so it's done. */
663 /* The file was copied, so tweak the perms of the copied file. If it
664 * was copied to partialptr, move it into its final destination. */
665 fnametmp = temp_copy_name ? temp_copy_name : fname;
668 set_file_attrs(fnametmp, file, NULL, fnamecmp,
669 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
671 if (temp_copy_name) {
672 if (do_rename(fnametmp, fname) < 0) {
673 rsyserr(FERROR_XFER, errno, "rename %s -> \"%s\"",
674 full_fname(fnametmp), fname);
677 handle_partial_dir(temp_copy_name, PDIR_DELETE);
682 struct file_list *flist_for_ndx(int ndx, const char *fatal_error_loc)
684 struct file_list *flist = cur_flist;
686 if (!flist && !(flist = first_flist))
689 while (ndx < flist->ndx_start-1) {
690 if (flist == first_flist)
694 while (ndx >= flist->ndx_start + flist->used) {
695 if (!(flist = flist->next))
701 if (fatal_error_loc) {
704 first = first_flist->ndx_start - 1;
705 last = first_flist->prev->ndx_start + first_flist->prev->used - 1;
711 "File-list index %d not in %d - %d (%s) [%s]\n",
712 ndx, first, last, fatal_error_loc, who_am_i());
713 exit_cleanup(RERR_PROTOCOL);
718 const char *who_am_i(void)
721 return am_server ? "server" : "client";
722 return am_sender ? "sender" : am_generator ? "generator" : "receiver";