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) {
84 /* It's OK if this fails... */
85 ic_chck = iconv_open(defset, defset);
87 if (DEBUG_GTE(ICONV, 1)) {
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 (INFO_GTE(MISC, 2)) {
130 rprintf(FINFO, "%s charset: %s\n",
131 am_server ? "server" : "client",
132 *charset ? charset : "[LOCALE]");
137 /* This function converts the characters in the "in" xbuf into characters
138 * in the "out" xbuf. The "len" of the "in" xbuf is used starting from its
139 * "pos". The "size" of the "out" xbuf restricts how many characters can be
140 * stored, starting at its "pos+len" position. Note that the last byte of
141 * the buffer is never used, which reserves space for a terminating '\0'.
142 * We return a 0 on success or a -1 on error. An error also sets errno to
143 * E2BIG, EILSEQ, or EINVAL (see below); otherwise errno will be set to 0.
144 * The "in" xbuf is altered to update "pos" and "len". The "out" xbuf has
145 * data appended, and its "len" incremented. If ICB_EXPAND_OUT is set in
146 * "flags", the "out" xbuf will also be allocated if empty, and expanded if
147 * too small (so E2BIG will not be returned). If ICB_INCLUDE_BAD is set in
148 * "flags", any badly-encoded chars are included verbatim in the "out" xbuf,
149 * so EILSEQ will not be returned. Likewise for ICB_INCLUDE_INCOMPLETE with
150 * respect to an incomplete multi-byte char at the end, which ensures that
151 * EINVAL is not returned. Anytime "in.pos" is 0 we will reset the iconv()
152 * state prior to processing the characters. */
153 int iconvbufs(iconv_t ic, xbuf *in, xbuf *out, int flags)
155 ICONV_CONST char *ibuf;
159 if (!out->size && flags & ICB_EXPAND_OUT)
160 alloc_xbuf(out, 1024);
163 iconv(ic, NULL, 0, NULL, 0);
165 ibuf = in->buf + in->pos;
168 obuf = out->buf + (out->pos + out->len);
169 ocnt = out->size - (out->pos + out->len) - 1;
172 while (iconv(ic, &ibuf, &icnt, &obuf, &ocnt) == (size_t)-1) {
175 if (errno == EINVAL) {
176 if (!(flags & ICB_INCLUDE_INCOMPLETE))
178 } else if (errno == EILSEQ) {
179 if (!(flags & ICB_INCLUDE_BAD))
182 size_t opos = obuf - out->buf;
183 if (!(flags & ICB_EXPAND_OUT)) {
187 realloc_xbuf(out, out->size + 1024);
188 obuf = out->buf + opos;
201 in->pos = ibuf - in->buf;
202 out->len = obuf - out->buf - out->pos;
204 return errno ? -1 : 0;
208 void send_protected_args(int fd, char *args[])
212 int convert = ic_send != (iconv_t)-1;
216 alloc_xbuf(&outbuf, 1024);
219 for (i = 0; args[i]; i++) {} /* find first NULL */
220 args[i] = "rsync"; /* set a new arg0 */
221 if (DEBUG_GTE(CMD, 1))
222 print_child_argv("protected args:", args + i + 1);
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);
234 write_buf(fd, args[i], strlen(args[i]) + 1);
244 int read_ndx_and_attrs(int f_in, int *iflag_ptr, uchar *type_ptr,
245 char *buf, int *len_ptr)
248 struct file_list *flist;
249 uchar fnamecmp_type = FNAMECMP_FNAME;
254 ndx = read_ndx(f_in);
260 if (!inc_recurse || am_sender)
262 if (ndx == NDX_FLIST_EOF) {
264 send_msg(MSG_FLIST_EOF, "", 0, 0);
267 ndx = NDX_FLIST_OFFSET - ndx;
268 if (ndx < 0 || ndx >= dir_flist->used) {
269 ndx = NDX_FLIST_OFFSET - ndx;
271 "[%s] Invalid dir index: %d (%d - %d)\n",
272 who_am_i(), ndx, NDX_FLIST_OFFSET,
273 NDX_FLIST_OFFSET - dir_flist->used + 1);
274 exit_cleanup(RERR_PROTOCOL);
277 /* Send everything read from f_in to msg_fd_out. */
278 if (DEBUG_GTE(FLIST, 2)) {
279 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
283 negate_output_levels(); /* turn off all info/debug output */
284 send_msg_int(MSG_FLIST, ndx);
285 start_flist_forward(f_in);
286 flist = recv_file_list(f_in);
287 flist->parent_ndx = ndx;
288 stop_flist_forward();
290 negate_output_levels(); /* restore info/debug output */
293 iflags = protocol_version >= 29 ? read_shortint(f_in)
294 : ITEM_TRANSFER | ITEM_MISSING_DATA;
296 /* Honor the old-style keep-alive indicator. */
297 if (protocol_version < 30
298 && ndx == cur_flist->used && iflags == ITEM_IS_NEW) {
300 maybe_send_keepalive();
304 if (!(flist = flist_for_ndx(ndx))) {
307 start = first_flist ? first_flist->ndx_start : 0;
308 used = first_flist ? first_flist->used : 0;
310 "Invalid file index: %d (%d - %d) with iflags %x [%s]\n",
311 ndx, start - 1, start + used -1, iflags, who_am_i());
312 exit_cleanup(RERR_PROTOCOL);
316 if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
317 fnamecmp_type = read_byte(f_in);
318 *type_ptr = fnamecmp_type;
320 if (iflags & ITEM_XNAME_FOLLOWS) {
321 if ((len = read_vstring(f_in, buf, MAXPATHLEN)) < 0)
322 exit_cleanup(RERR_PROTOCOL);
329 if (iflags & ITEM_TRANSFER) {
330 int i = ndx - cur_flist->ndx_start;
331 if (i < 0 || !S_ISREG(cur_flist->files[i]->mode)) {
333 "received request to transfer non-regular file: %d [%s]\n",
335 exit_cleanup(RERR_PROTOCOL);
346 void free_sums(struct sum_struct *s)
348 if (s->sums) free(s->sums);
352 /* This is only called when we aren't preserving permissions. Figure out what
353 * the permissions should be and return them merged back into the mode. */
354 mode_t dest_mode(mode_t flist_mode, mode_t stat_mode, int dflt_perms,
358 /* If the file already exists, we'll return the local permissions,
359 * possibly tweaked by the --executability option. */
361 new_mode = (flist_mode & ~CHMOD_BITS) | (stat_mode & CHMOD_BITS);
362 if (preserve_executability && S_ISREG(flist_mode)) {
363 /* If the source file is executable, grant execute
364 * rights to everyone who can read, but ONLY if the
365 * file isn't already executable. */
366 if (!(flist_mode & 0111))
368 else if (!(stat_mode & 0111))
369 new_mode |= (new_mode & 0444) >> 2;
372 /* Apply destination default permissions and turn
373 * off special permissions. */
374 new_mode = flist_mode & (~CHMOD_BITS | dflt_perms);
379 int set_file_attrs(const char *fname, struct file_struct *file, stat_x *sxp,
380 const char *fnamecmp, int flags)
384 int change_uid, change_gid;
385 mode_t new_mode = file->mode;
391 if (link_stat(fname, &sx2.st, 0) < 0) {
392 rsyserr(FERROR_XFER, errno, "stat %s failed",
397 sx2.acc_acl = sx2.def_acl = NULL;
399 #ifdef SUPPORT_XATTRS
403 inherit = !preserve_perms;
405 inherit = !preserve_perms && file->flags & FLAG_DIR_CREATED;
407 if (inherit && S_ISDIR(new_mode) && sxp->st.st_mode & S_ISGID) {
408 /* We just created this directory and its setgid
409 * bit is on, so make sure it stays on. */
413 if (daemon_chmod_modes && !S_ISLNK(new_mode))
414 new_mode = tweak_mode(new_mode, daemon_chmod_modes);
417 if (preserve_acls && !S_ISLNK(file->mode) && !ACL_READY(*sxp))
421 #ifdef SUPPORT_XATTRS
423 set_stat_xattr(fname, file, new_mode);
424 if (preserve_xattrs && fnamecmp)
425 set_xattr(fname, file, fnamecmp, sxp);
428 if (!preserve_times || (S_ISDIR(sxp->st.st_mode) && preserve_times == 1))
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 #if !defined HAVE_LCHOWN && !defined CHOWN_MODIFIES_SYMLINK
448 if (S_ISLNK(sxp->st.st_mode)) {
452 if (change_uid || change_gid) {
453 if (DEBUG_GTE(OWN, 1)) {
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));
467 change_uid ? (uid_t)F_OWNER(file) : sxp->st.st_uid,
468 change_gid ? (gid_t)F_GROUP(file) : sxp->st.st_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 /* A lchown had been done, so we need to re-stat if
477 * the destination had the setuid or setgid bits set
478 * (due to the side effect of the chown call). */
479 if (sxp->st.st_mode & (S_ISUID | S_ISGID)) {
480 link_stat(fname, &sxp->st,
481 keep_dirlinks && S_ISDIR(sxp->st.st_mode));
488 /* It's OK to call set_acl() now, even for a dir, as the generator
489 * will enable owner-writability using chmod, if necessary.
491 * If set_acl() changes permission bits in the process of setting
492 * an access ACL, it changes sxp->st.st_mode so we know whether we
493 * need to chmod(). */
494 if (preserve_acls && !S_ISLNK(new_mode) && set_acl(fname, file, sxp) == 0)
499 if (!BITS_EQUAL(sxp->st.st_mode, new_mode, CHMOD_BITS)) {
500 int ret = am_root < 0 ? 0 : do_chmod(fname, new_mode);
502 rsyserr(FERROR_XFER, errno,
503 "failed to set permissions on %s",
507 if (ret == 0) /* ret == 1 if symlink could not be set */
512 if (INFO_GTE(NAME, 2) && flags & ATTRS_REPORT) {
514 rprintf(FCLIENT, "%s\n", fname);
516 rprintf(FCLIENT, "%s is uptodate\n", fname);
524 #ifdef SUPPORT_XATTRS
532 RETSIGTYPE sig_int(UNUSED(int val))
534 /* KLUGE: if the user hits Ctrl-C while ssh is prompting
535 * for a password, then our cleanup's sending of a SIGUSR1
536 * signal to all our children may kill ssh before it has a
537 * chance to restore the tty settings (i.e. turn echo back
538 * on). By sleeping for a short time, ssh gets a bigger
539 * chance to do the right thing. If child processes are
540 * not ssh waiting for a password, then this tiny delay
541 * shouldn't hurt anything. */
543 exit_cleanup(RERR_SIGNAL);
546 /* Finish off a file transfer: renaming the file and setting the file's
547 * attributes (e.g. permissions, ownership, etc.). If the robust_rename()
548 * call is forced to copy the temp file and partialptr is both non-NULL and
549 * not an absolute path, we stage the file into the partial-dir and then
550 * rename it into place. This returns 1 on succcess or 0 on failure. */
551 int finish_transfer(const char *fname, const char *fnametmp,
552 const char *fnamecmp, const char *partialptr,
553 struct file_struct *file, int ok_to_set_time,
554 int overwriting_basis)
557 const char *temp_copy_name = partialptr && *partialptr != '/' ? partialptr : NULL;
560 if (DEBUG_GTE(RECV, 1))
561 rprintf(FINFO, "finishing %s\n", fname);
563 goto do_set_file_attrs;
566 if (make_backups > 0 && overwriting_basis) {
567 if (!make_backup(fname))
569 if (fnamecmp == fname)
570 fnamecmp = get_backup_name(fname);
573 /* Change permissions before putting the file into place. */
574 set_file_attrs(fnametmp, file, NULL, fnamecmp,
575 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
577 /* move tmp file over real file */
578 if (DEBUG_GTE(RECV, 1))
579 rprintf(FINFO, "renaming %s to %s\n", fnametmp, fname);
580 ret = robust_rename(fnametmp, fname, temp_copy_name,
581 file->mode & INITACCESSPERMS);
583 rsyserr(FERROR_XFER, errno, "%s %s -> \"%s\"",
584 ret == -2 ? "copy" : "rename",
585 full_fname(fnametmp), fname);
586 if (!partialptr || (ret == -2 && temp_copy_name)
587 || robust_rename(fnametmp, partialptr, NULL,
588 file->mode & INITACCESSPERMS) < 0)
593 /* The file was moved into place (not copied), so it's done. */
596 /* The file was copied, so tweak the perms of the copied file. If it
597 * was copied to partialptr, move it into its final destination. */
598 fnametmp = temp_copy_name ? temp_copy_name : fname;
601 set_file_attrs(fnametmp, file, NULL, fnamecmp,
602 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
604 if (temp_copy_name) {
605 if (do_rename(fnametmp, fname) < 0) {
606 rsyserr(FERROR_XFER, errno, "rename %s -> \"%s\"",
607 full_fname(fnametmp), fname);
610 handle_partial_dir(temp_copy_name, PDIR_DELETE);
615 struct file_list *flist_for_ndx(int ndx)
617 struct file_list *flist = cur_flist;
619 if (!flist && !(flist = first_flist))
622 while (ndx < flist->ndx_start-1) {
623 if (flist == first_flist)
627 while (ndx >= flist->ndx_start + flist->used) {
628 if (!(flist = flist->next))
634 const char *who_am_i(void)
637 return am_server ? "server" : "client";
638 return am_sender ? "sender" : am_generator ? "generator" : "receiver";