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
32 extern int preserve_acls;
33 extern int preserve_xattrs;
34 extern int preserve_perms;
35 extern int preserve_executability;
36 extern int preserve_times;
40 extern int am_receiver;
41 extern int am_generator;
42 extern int am_starting_up;
43 extern int allow_8bit_chars;
44 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;
62 static const char *default_charset(void)
64 # if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
65 return locale_charset();
66 # elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
67 return nl_langinfo(CODESET);
69 return ""; /* Works with (at the very least) gnu iconv... */
73 void setup_iconv(void)
75 const char *defset = default_charset();
81 if (!am_server && !allow_8bit_chars) {
82 /* It's OK if this fails... */
83 ic_chck = iconv_open(defset, defset);
86 if (ic_chck == (iconv_t)-1) {
88 "note: iconv_open(\"%s\", \"%s\") failed (%d)"
89 " -- using isprint() instead of iconv().\n",
90 defset, defset, errno);
93 "note: iconv_open(\"%s\", \"%s\") succeeded.\n",
103 if ((cp = strchr(iconv_opt, ',')) != NULL) {
104 if (am_server) /* A local transfer needs this. */
110 if (!*iconv_opt || (*iconv_opt == '.' && iconv_opt[1] == '\0'))
115 if ((ic_send = iconv_open(UTF8_CHARSET, charset)) == (iconv_t)-1) {
116 rprintf(FERROR, "iconv_open(\"%s\", \"%s\") failed\n",
117 UTF8_CHARSET, charset);
118 exit_cleanup(RERR_UNSUPPORTED);
121 if ((ic_recv = iconv_open(charset, UTF8_CHARSET)) == (iconv_t)-1) {
122 rprintf(FERROR, "iconv_open(\"%s\", \"%s\") failed\n",
123 charset, UTF8_CHARSET);
124 exit_cleanup(RERR_UNSUPPORTED);
128 rprintf(FINFO, "%s charset: %s\n",
129 am_server ? "server" : "client",
130 *charset ? charset : "[LOCALE]");
135 /* This function converts the characters in the "in" xbuf into characters
136 * in the "out" xbuf. The "len" of the "in" xbuf is used starting from its
137 * "pos". The "size" of the "out" xbuf restricts how many characters can be
138 * stored, starting at its "pos+len" position. Note that the last byte of
139 * the buffer is never used, which reserves space for a terminating '\0'.
140 * We return a 0 on success or a -1 on error. An error also sets errno to
141 * E2BIG, EILSEQ, or EINVAL (see below); otherwise errno will be set to 0.
142 * The "in" xbuf is altered to update "pos" and "len". The "out" xbuf has
143 * data appended, and its "len" incremented. If ICB_EXPAND_OUT is set in
144 * "flags", the "out" xbuf will also be allocated if empty, and expanded if
145 * too small (so E2BIG will not be returned). If ICB_INCLUDE_BAD is set in
146 * "flags", any badly-encoded chars are included verbatim in the "out" xbuf,
147 * so EILSEQ will not be returned. Likewise for ICB_INCLUDE_INCOMPLETE with
148 * respect to an incomplete multi-byte char at the end, which ensures that
149 * EINVAL is not returned. Anytime "in.pos" is 0 we will reset the iconv()
150 * state prior to processing the characters. */
151 int iconvbufs(iconv_t ic, xbuf *in, xbuf *out, int flags)
153 ICONV_CONST char *ibuf;
157 if (!out->size && flags & ICB_EXPAND_OUT)
158 alloc_xbuf(out, 1024);
161 iconv(ic, NULL, 0, NULL, 0);
163 ibuf = in->buf + in->pos;
166 obuf = out->buf + (out->pos + out->len);
167 ocnt = out->size - (out->pos + out->len) - 1;
170 while (iconv(ic, &ibuf, &icnt, &obuf, &ocnt) == (size_t)-1) {
173 if (errno == EINVAL) {
174 if (!(flags & ICB_INCLUDE_INCOMPLETE))
176 } else if (errno == EILSEQ) {
177 if (!(flags & ICB_INCLUDE_BAD))
180 size_t opos = obuf - out->buf;
181 if (!(flags & ICB_EXPAND_OUT)) {
185 realloc_xbuf(out, out->size + 1024);
186 obuf = out->buf + opos;
199 in->pos = ibuf - in->buf;
200 out->len = obuf - out->buf - out->pos;
202 return errno ? -1 : 0;
206 void send_protected_args(int fd, char *args[])
210 int convert = ic_send != (iconv_t)-1;
214 alloc_xbuf(&outbuf, 1024);
217 for (i = 0; args[i]; i++) {} /* find first NULL */
218 args[i] = "rsync"; /* set a new arg0 */
220 print_child_argv("protected args:", args + i + 1);
223 write_buf(fd, ".", 2);
226 INIT_XBUF_STRLEN(inbuf, args[i]);
227 iconvbufs(ic_send, &inbuf, &outbuf,
228 ICB_EXPAND_OUT | ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
229 outbuf.buf[outbuf.len] = '\0';
230 write_buf(fd, outbuf.buf, outbuf.len + 1);
235 write_buf(fd, args[i], strlen(args[i]) + 1);
245 int read_ndx_and_attrs(int f_in, int *iflag_ptr, uchar *type_ptr,
246 char *buf, int *len_ptr)
249 struct file_list *flist;
250 uchar fnamecmp_type = FNAMECMP_FNAME;
251 int ndx, save_verbose = verbose;
255 ndx = read_ndx(f_in);
261 if (!inc_recurse || am_sender) {
264 last = first_flist->prev->ndx_start + first_flist->prev->used - 1;
268 "Invalid file index: %d (%d - %d) [%s]\n",
269 ndx, NDX_DONE, last, who_am_i());
270 exit_cleanup(RERR_PROTOCOL);
272 if (ndx == NDX_FLIST_EOF) {
274 send_msg(MSG_FLIST_EOF, "", 0, 0);
277 ndx = NDX_FLIST_OFFSET - ndx;
278 if (ndx < 0 || ndx >= dir_flist->used) {
279 ndx = NDX_FLIST_OFFSET - ndx;
281 "Invalid dir index: %d (%d - %d) [%s]\n",
282 ndx, NDX_FLIST_OFFSET,
283 NDX_FLIST_OFFSET - dir_flist->used + 1,
285 exit_cleanup(RERR_PROTOCOL);
288 /* Send everything read from f_in to msg_fd_out. */
290 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
294 send_msg_int(MSG_FLIST, ndx);
295 start_flist_forward(f_in);
296 flist = recv_file_list(f_in);
297 flist->parent_ndx = ndx;
298 stop_flist_forward();
299 verbose = save_verbose;
302 iflags = protocol_version >= 29 ? read_shortint(f_in)
303 : ITEM_TRANSFER | ITEM_MISSING_DATA;
305 /* Support the protocol-29 keep-alive style. */
306 if (protocol_version < 30 && ndx == cur_flist->used && iflags == ITEM_IS_NEW) {
308 maybe_send_keepalive();
312 cur_flist = flist_for_ndx(ndx, "read_ndx_and_attrs");
314 if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
315 fnamecmp_type = read_byte(f_in);
316 *type_ptr = fnamecmp_type;
318 if (iflags & ITEM_XNAME_FOLLOWS) {
319 if ((len = read_vstring(f_in, buf, MAXPATHLEN)) < 0)
320 exit_cleanup(RERR_PROTOCOL);
327 if (iflags & ITEM_TRANSFER) {
328 int i = ndx - cur_flist->ndx_start;
329 if (i < 0 || !S_ISREG(cur_flist->files[i]->mode)) {
331 "received request to transfer non-regular file: %d [%s]\n",
333 exit_cleanup(RERR_PROTOCOL);
344 void free_sums(struct sum_struct *s)
346 if (s->sums) free(s->sums);
350 /* This is only called when we aren't preserving permissions. Figure out what
351 * the permissions should be and return them merged back into the mode. */
352 mode_t dest_mode(mode_t flist_mode, mode_t stat_mode, int dflt_perms,
356 /* If the file already exists, we'll return the local permissions,
357 * possibly tweaked by the --executability option. */
359 new_mode = (flist_mode & ~CHMOD_BITS) | (stat_mode & CHMOD_BITS);
360 if (preserve_executability && S_ISREG(flist_mode)) {
361 /* If the source file is executable, grant execute
362 * rights to everyone who can read, but ONLY if the
363 * file isn't already executable. */
364 if (!(flist_mode & 0111))
366 else if (!(stat_mode & 0111))
367 new_mode |= (new_mode & 0444) >> 2;
370 /* Apply destination default permissions and turn
371 * off special permissions. */
372 new_mode = flist_mode & (~CHMOD_BITS | dflt_perms);
377 int set_file_attrs(const char *fname, struct file_struct *file, stat_x *sxp,
378 const char *fnamecmp, int flags)
382 int change_uid, change_gid;
383 mode_t new_mode = file->mode;
389 if (link_stat(fname, &sx2.st, 0) < 0) {
390 rsyserr(FERROR_XFER, errno, "stat %s failed",
395 sx2.acc_acl = sx2.def_acl = NULL;
397 #ifdef SUPPORT_XATTRS
401 inherit = !preserve_perms;
403 inherit = !preserve_perms && file->flags & FLAG_DIR_CREATED;
405 if (inherit && S_ISDIR(new_mode) && sxp->st.st_mode & S_ISGID) {
406 /* We just created this directory and its setgid
407 * bit is on, so make sure it stays on. */
411 if (daemon_chmod_modes && !S_ISLNK(new_mode))
412 new_mode = tweak_mode(new_mode, daemon_chmod_modes);
415 if (preserve_acls && !S_ISLNK(file->mode) && !ACL_READY(*sxp))
419 #ifdef SUPPORT_XATTRS
421 set_stat_xattr(fname, file, new_mode);
422 if (preserve_xattrs && fnamecmp)
423 set_xattr(fname, file, fnamecmp, sxp);
427 || (!(preserve_times & PRESERVE_DIR_TIMES) && S_ISDIR(sxp->st.st_mode))
428 || (!(preserve_times & PRESERVE_LINK_TIMES) && S_ISLNK(sxp->st.st_mode)))
429 flags |= ATTRS_SKIP_MTIME;
430 if (!(flags & ATTRS_SKIP_MTIME)
431 && cmp_time(sxp->st.st_mtime, file->modtime) != 0) {
432 int ret = set_modtime(fname, file->modtime, sxp->st.st_mode);
434 rsyserr(FERROR_XFER, errno, "failed to set times on %s",
438 if (ret == 0) /* ret == 1 if symlink could not be set */
441 file->flags |= FLAG_TIME_FAILED;
444 change_uid = am_root && uid_ndx && sxp->st.st_uid != (uid_t)F_OWNER(file);
445 change_gid = gid_ndx && !(file->flags & FLAG_SKIP_GROUP)
446 && sxp->st.st_gid != (gid_t)F_GROUP(file);
447 #ifndef CAN_CHOWN_SYMLINK
448 if (S_ISLNK(sxp->st.st_mode)) {
452 if (change_uid || change_gid) {
456 "set uid of %s from %u to %u\n",
457 fname, (unsigned)sxp->st.st_uid, F_OWNER(file));
461 "set gid of %s from %u to %u\n",
462 fname, (unsigned)sxp->st.st_gid, F_GROUP(file));
466 uid_t uid = change_uid ? (uid_t)F_OWNER(file) : sxp->st.st_uid;
467 gid_t gid = change_gid ? (gid_t)F_GROUP(file) : sxp->st.st_gid;
468 if (do_lchown(fname, uid, gid) != 0) {
469 /* We shouldn't have attempted to change uid
470 * or gid unless have the privilege. */
471 rsyserr(FERROR_XFER, errno, "%s %s failed",
472 change_uid ? "chown" : "chgrp",
476 if (uid == (uid_t)-1 && sxp->st.st_uid != (uid_t)-1)
477 rprintf(FERROR_XFER, "uid 4294967295 (-1) is impossible to set on %s\n", full_fname(fname));
478 if (gid == (gid_t)-1 && sxp->st.st_gid != (gid_t)-1)
479 rprintf(FERROR_XFER, "gid 4294967295 (-1) is impossible to set on %s\n", full_fname(fname));
480 /* A lchown had been done, so we need to re-stat if
481 * the destination had the setuid or setgid bits set
482 * (due to the side effect of the chown call). */
483 if (sxp->st.st_mode & (S_ISUID | S_ISGID)) {
484 link_stat(fname, &sxp->st,
485 keep_dirlinks && S_ISDIR(sxp->st.st_mode));
492 /* It's OK to call set_acl() now, even for a dir, as the generator
493 * will enable owner-writability using chmod, if necessary.
495 * If set_acl() changes permission bits in the process of setting
496 * an access ACL, it changes sxp->st.st_mode so we know whether we
497 * need to chmod(). */
498 if (preserve_acls && !S_ISLNK(new_mode)) {
499 if (set_acl(fname, file, sxp, new_mode) > 0)
505 if (!BITS_EQUAL(sxp->st.st_mode, new_mode, CHMOD_BITS)) {
506 int ret = am_root < 0 ? 0 : do_chmod(fname, new_mode);
508 rsyserr(FERROR_XFER, errno,
509 "failed to set permissions on %s",
513 if (ret == 0) /* ret == 1 if symlink could not be set */
518 if (verbose > 1 && flags & ATTRS_REPORT) {
520 rprintf(FCLIENT, "%s\n", fname);
522 rprintf(FCLIENT, "%s is uptodate\n", fname);
530 #ifdef SUPPORT_XATTRS
538 RETSIGTYPE sig_int(UNUSED(int val))
540 /* KLUGE: if the user hits Ctrl-C while ssh is prompting
541 * for a password, then our cleanup's sending of a SIGUSR1
542 * signal to all our children may kill ssh before it has a
543 * chance to restore the tty settings (i.e. turn echo back
544 * on). By sleeping for a short time, ssh gets a bigger
545 * chance to do the right thing. If child processes are
546 * not ssh waiting for a password, then this tiny delay
547 * shouldn't hurt anything. */
549 exit_cleanup(RERR_SIGNAL);
552 /* Finish off a file transfer: renaming the file and setting the file's
553 * attributes (e.g. permissions, ownership, etc.). If the robust_rename()
554 * call is forced to copy the temp file and partialptr is both non-NULL and
555 * not an absolute path, we stage the file into the partial-dir and then
556 * rename it into place. This returns 1 on succcess or 0 on failure. */
557 int finish_transfer(const char *fname, const char *fnametmp,
558 const char *fnamecmp, const char *partialptr,
559 struct file_struct *file, int ok_to_set_time,
560 int overwriting_basis)
563 const char *temp_copy_name = partialptr && *partialptr != '/' ? partialptr : NULL;
567 rprintf(FINFO, "finishing %s\n", fname);
569 goto do_set_file_attrs;
572 if (make_backups > 0 && overwriting_basis) {
573 if (!make_backup(fname))
575 if (fnamecmp == fname)
576 fnamecmp = get_backup_name(fname);
579 /* Change permissions before putting the file into place. */
580 set_file_attrs(fnametmp, file, NULL, fnamecmp,
581 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
583 /* move tmp file over real file */
585 rprintf(FINFO, "renaming %s to %s\n", fnametmp, fname);
586 ret = robust_rename(fnametmp, fname, temp_copy_name,
587 file->mode & INITACCESSPERMS);
589 rsyserr(FERROR_XFER, errno, "%s %s -> \"%s\"",
590 ret == -2 ? "copy" : "rename",
591 full_fname(fnametmp), fname);
592 if (!partialptr || (ret == -2 && temp_copy_name)
593 || robust_rename(fnametmp, partialptr, NULL,
594 file->mode & INITACCESSPERMS) < 0)
599 /* The file was moved into place (not copied), so it's done. */
602 /* The file was copied, so tweak the perms of the copied file. If it
603 * was copied to partialptr, move it into its final destination. */
604 fnametmp = temp_copy_name ? temp_copy_name : fname;
607 set_file_attrs(fnametmp, file, NULL, fnamecmp,
608 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
610 if (temp_copy_name) {
611 if (do_rename(fnametmp, fname) < 0) {
612 rsyserr(FERROR_XFER, errno, "rename %s -> \"%s\"",
613 full_fname(fnametmp), fname);
616 handle_partial_dir(temp_copy_name, PDIR_DELETE);
621 struct file_list *flist_for_ndx(int ndx, const char *fatal_error_loc)
623 struct file_list *flist = cur_flist;
625 if (!flist && !(flist = first_flist))
628 while (ndx < flist->ndx_start-1) {
629 if (flist == first_flist)
633 while (ndx >= flist->ndx_start + flist->used) {
634 if (!(flist = flist->next))
640 if (fatal_error_loc) {
643 first = first_flist->ndx_start - 1;
644 last = first_flist->prev->ndx_start + first_flist->prev->used - 1;
650 "File-list index %d not in %d - %d (%s) [%s]\n",
651 ndx, first, last, fatal_error_loc, who_am_i());
652 exit_cleanup(RERR_PROTOCOL);
657 const char *who_am_i(void)
660 return am_server ? "server" : "client";
661 return am_sender ? "sender"
662 : am_generator ? "generator"
663 : am_receiver ? "receiver"
664 : "Receiver"; /* pre-forked receiver */