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_receiver
;
40 extern int am_generator
;
41 extern int am_starting_up
;
42 extern int allow_8bit_chars
;
43 extern int protocol_version
;
44 extern int inc_recurse
;
47 extern int file_old_total
;
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
);
85 if (DEBUG_GTE(ICONV
, 2)) {
86 if (ic_chck
== (iconv_t
)-1) {
88 "msg checking via isprint()"
89 " (iconv_open(\"%s\", \"%s\") errno: %d)\n",
90 defset
, defset
, errno
);
93 "msg checking charset: %s\n",
98 ic_chck
= (iconv_t
)-1;
104 if ((cp
= strchr(iconv_opt
, ',')) != NULL
) {
105 if (am_server
) /* A local transfer needs this. */
111 if (!*iconv_opt
|| (*iconv_opt
== '.' && iconv_opt
[1] == '\0'))
116 if ((ic_send
= iconv_open(UTF8_CHARSET
, charset
)) == (iconv_t
)-1) {
117 rprintf(FERROR
, "iconv_open(\"%s\", \"%s\") failed\n",
118 UTF8_CHARSET
, charset
);
119 exit_cleanup(RERR_UNSUPPORTED
);
122 if ((ic_recv
= iconv_open(charset
, UTF8_CHARSET
)) == (iconv_t
)-1) {
123 rprintf(FERROR
, "iconv_open(\"%s\", \"%s\") failed\n",
124 charset
, UTF8_CHARSET
);
125 exit_cleanup(RERR_UNSUPPORTED
);
128 if (DEBUG_GTE(ICONV
, 1)) {
129 rprintf(FINFO
, "[%s] charset: %s\n",
130 who_am_i(), *charset
? charset
: "[LOCALE]");
135 /* This function converts the chars in the "in" xbuf into characters in the
136 * "out" xbuf. The ".len" chars of the "in" xbuf is used starting from its
137 * ".pos". The ".size" of the "out" xbuf restricts how many characters can
138 * be stored, starting at its ".pos+.len" position. Note that the last byte
139 * of the "out" xbuf is not used, which reserves space for a trailing '\0'
140 * (though it is up to the caller to store a trailing '\0', as needed).
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 (see below for a ".size" note).
147 * If ICB_CIRCULAR_OUT is set in "flags", the chars going into the "out" xbuf
148 * can wrap around to the start, and the xbuf may have its ".size" reduced
149 * (presumably by 1 byte) if the iconv code doesn't have space to store a
150 * multi-byte character at the physical end of the ".buf" (though no reducing
151 * happens if ".pos" is <= 1, since there is no room to wrap around).
153 * If ICB_EXPAND_OUT is set in "flags", the "out" xbuf will be allocated if
154 * empty, and (as long as ICB_CIRCULAR_OUT is not set) expanded if too small.
155 * This prevents the return of E2BIG (except for a circular xbuf).
157 * If ICB_INCLUDE_BAD is set in "flags", any badly-encoded chars are included
158 * verbatim in the "out" xbuf, so EILSEQ will not be returned.
160 * If ICB_INCLUDE_INCOMPLETE is set in "flags", any incomplete multi-byte
161 * chars are included, which ensures that EINVAL is not returned.
163 * If ICB_INIT is set, the iconv() conversion state is initialized prior to
164 * processing the characters. */
165 int iconvbufs(iconv_t ic
, xbuf
*in
, xbuf
*out
, int flags
)
167 ICONV_CONST
char *ibuf
;
168 size_t icnt
, ocnt
, opos
;
171 if (!out
->size
&& flags
& ICB_EXPAND_OUT
) {
172 size_t siz
= ROUND_UP_1024(in
->len
* 2);
173 alloc_xbuf(out
, siz
);
174 } else if (out
->len
+1 >= out
->size
) {
175 /* There is no room to even start storing data. */
176 if (!(flags
& ICB_EXPAND_OUT
) || flags
& ICB_CIRCULAR_OUT
) {
180 realloc_xbuf(out
, out
->size
+ ROUND_UP_1024(in
->len
* 2));
183 if (flags
& ICB_INIT
)
184 iconv(ic
, NULL
, 0, NULL
, 0);
186 ibuf
= in
->buf
+ in
->pos
;
189 opos
= out
->pos
+ out
->len
;
190 if (flags
& ICB_CIRCULAR_OUT
) {
191 if (opos
>= out
->size
) {
193 /* We know that out->pos is not 0 due to the "no room" check
194 * above, so this can't go "negative". */
195 ocnt
= out
->pos
- opos
- 1;
197 /* Allow the use of all bytes to the physical end of the buffer
198 * unless pos is 0, in which case we reserve our trailing '\0'. */
199 ocnt
= out
->size
- opos
- (out
->pos
? 0 : 1);
202 ocnt
= out
->size
- opos
- 1;
203 obuf
= out
->buf
+ opos
;
206 while (iconv(ic
, &ibuf
, &icnt
, &obuf
, &ocnt
) == (size_t)-1) {
209 if (errno
== EINVAL
) {
210 if (!(flags
& ICB_INCLUDE_INCOMPLETE
))
212 } else if (errno
== EILSEQ
) {
213 if (!(flags
& ICB_INCLUDE_BAD
))
215 } else if (errno
== E2BIG
) {
217 opos
= obuf
- out
->buf
;
218 if (flags
& ICB_CIRCULAR_OUT
&& out
->pos
> 1 && opos
> out
->pos
) {
219 /* We are in a divided circular buffer at the physical
220 * end with room to wrap to the start. If iconv() refused
221 * to use one or more trailing bytes in the buffer, we
222 * set the size to ignore the unused bytes. */
223 if (opos
< out
->size
)
224 reduce_iobuf_size(out
, opos
);
229 if (!(flags
& ICB_EXPAND_OUT
) || flags
& ICB_CIRCULAR_OUT
) {
233 siz
= ROUND_UP_1024(in
->len
* 2);
234 realloc_xbuf(out
, out
->size
+ siz
);
235 obuf
= out
->buf
+ opos
;
239 rsyserr(FERROR
, errno
, "unexpected error from iconv()");
240 exit_cleanup(RERR_UNSUPPORTED
);
250 opos
= obuf
- out
->buf
;
251 if (flags
& ICB_CIRCULAR_OUT
&& opos
< out
->pos
)
253 out
->len
= opos
- out
->pos
;
256 in
->pos
= ibuf
- in
->buf
;
258 return errno
? -1 : 0;
262 void send_protected_args(int fd
, char *args
[])
266 int convert
= ic_send
!= (iconv_t
)-1;
270 alloc_xbuf(&outbuf
, 1024);
273 for (i
= 0; args
[i
]; i
++) {} /* find first NULL */
274 args
[i
] = "rsync"; /* set a new arg0 */
275 if (DEBUG_GTE(CMD
, 1))
276 print_child_argv("protected args:", args
+ i
+ 1);
279 write_buf(fd
, ".", 2);
282 INIT_XBUF_STRLEN(inbuf
, args
[i
]);
283 iconvbufs(ic_send
, &inbuf
, &outbuf
,
284 ICB_EXPAND_OUT
| ICB_INCLUDE_BAD
| ICB_INCLUDE_INCOMPLETE
| ICB_INIT
);
285 outbuf
.buf
[outbuf
.len
] = '\0';
286 write_buf(fd
, outbuf
.buf
, outbuf
.len
+ 1);
291 write_buf(fd
, args
[i
], strlen(args
[i
]) + 1);
301 int read_ndx_and_attrs(int f_in
, int f_out
, int *iflag_ptr
, uchar
*type_ptr
,
302 char *buf
, int *len_ptr
)
305 struct file_list
*flist
;
306 uchar fnamecmp_type
= FNAMECMP_FNAME
;
311 ndx
= read_ndx(f_in
);
317 if (ndx
== NDX_DEL_STATS
) {
318 read_del_stats(f_in
);
319 if (am_sender
&& am_server
)
320 write_del_stats(f_out
);
323 if (!inc_recurse
|| am_sender
) {
326 last
= first_flist
->prev
->ndx_start
+ first_flist
->prev
->used
- 1;
330 "Invalid file index: %d (%d - %d) [%s]\n",
331 ndx
, NDX_DONE
, last
, who_am_i());
332 exit_cleanup(RERR_PROTOCOL
);
334 if (ndx
== NDX_FLIST_EOF
) {
336 if (DEBUG_GTE(FLIST
, 3))
337 rprintf(FINFO
, "[%s] flist_eof=1\n", who_am_i());
338 write_int(f_out
, NDX_FLIST_EOF
);
341 ndx
= NDX_FLIST_OFFSET
- ndx
;
342 if (ndx
< 0 || ndx
>= dir_flist
->used
) {
343 ndx
= NDX_FLIST_OFFSET
- ndx
;
345 "Invalid dir index: %d (%d - %d) [%s]\n",
346 ndx
, NDX_FLIST_OFFSET
,
347 NDX_FLIST_OFFSET
- dir_flist
->used
+ 1,
349 exit_cleanup(RERR_PROTOCOL
);
352 if (DEBUG_GTE(FLIST
, 2)) {
353 rprintf(FINFO
, "[%s] receiving flist for dir %d\n",
356 /* Send all the data we read for this flist to the generator. */
357 start_flist_forward(ndx
);
358 flist
= recv_file_list(f_in
);
359 flist
->parent_ndx
= ndx
;
360 stop_flist_forward();
363 iflags
= protocol_version
>= 29 ? read_shortint(f_in
)
364 : ITEM_TRANSFER
| ITEM_MISSING_DATA
;
366 /* Support the protocol-29 keep-alive style. */
367 if (protocol_version
< 30 && ndx
== cur_flist
->used
&& iflags
== ITEM_IS_NEW
) {
369 maybe_send_keepalive(time(NULL
), MSK_ALLOW_FLUSH
);
373 flist
= flist_for_ndx(ndx
, "read_ndx_and_attrs");
374 if (flist
!= cur_flist
) {
377 file_old_total
= cur_flist
->used
;
378 for (flist
= first_flist
; flist
!= cur_flist
; flist
= flist
->next
)
379 file_old_total
+= flist
->used
;
383 if (iflags
& ITEM_BASIS_TYPE_FOLLOWS
)
384 fnamecmp_type
= read_byte(f_in
);
385 *type_ptr
= fnamecmp_type
;
387 if (iflags
& ITEM_XNAME_FOLLOWS
) {
388 if ((len
= read_vstring(f_in
, buf
, MAXPATHLEN
)) < 0)
389 exit_cleanup(RERR_PROTOCOL
);
396 if (iflags
& ITEM_TRANSFER
) {
397 int i
= ndx
- cur_flist
->ndx_start
;
398 if (i
< 0 || !S_ISREG(cur_flist
->files
[i
]->mode
)) {
400 "received request to transfer non-regular file: %d [%s]\n",
402 exit_cleanup(RERR_PROTOCOL
);
413 void free_sums(struct sum_struct
*s
)
415 if (s
->sums
) free(s
->sums
);
419 /* This is only called when we aren't preserving permissions. Figure out what
420 * the permissions should be and return them merged back into the mode. */
421 mode_t
dest_mode(mode_t flist_mode
, mode_t stat_mode
, int dflt_perms
,
425 /* If the file already exists, we'll return the local permissions,
426 * possibly tweaked by the --executability option. */
428 new_mode
= (flist_mode
& ~CHMOD_BITS
) | (stat_mode
& CHMOD_BITS
);
429 if (preserve_executability
&& S_ISREG(flist_mode
)) {
430 /* If the source file is executable, grant execute
431 * rights to everyone who can read, but ONLY if the
432 * file isn't already executable. */
433 if (!(flist_mode
& 0111))
435 else if (!(stat_mode
& 0111))
436 new_mode
|= (new_mode
& 0444) >> 2;
439 /* Apply destination default permissions and turn
440 * off special permissions. */
441 new_mode
= flist_mode
& (~CHMOD_BITS
| dflt_perms
);
446 int set_file_attrs(const char *fname
, struct file_struct
*file
, stat_x
*sxp
,
447 const char *fnamecmp
, int flags
)
451 int change_uid
, change_gid
;
452 mode_t new_mode
= file
->mode
;
458 if (link_stat(fname
, &sx2
.st
, 0) < 0) {
459 rsyserr(FERROR_XFER
, errno
, "stat %s failed",
465 inherit
= !preserve_perms
;
467 inherit
= !preserve_perms
&& file
->flags
& FLAG_DIR_CREATED
;
469 if (inherit
&& S_ISDIR(new_mode
) && sxp
->st
.st_mode
& S_ISGID
) {
470 /* We just created this directory and its setgid
471 * bit is on, so make sure it stays on. */
475 if (daemon_chmod_modes
&& !S_ISLNK(new_mode
))
476 new_mode
= tweak_mode(new_mode
, daemon_chmod_modes
);
479 if (preserve_acls
&& !S_ISLNK(file
->mode
) && !ACL_READY(*sxp
))
483 #ifdef SUPPORT_XATTRS
485 set_stat_xattr(fname
, file
, new_mode
);
486 if (preserve_xattrs
&& fnamecmp
)
487 set_xattr(fname
, file
, fnamecmp
, sxp
);
491 || (!(preserve_times
& PRESERVE_DIR_TIMES
) && S_ISDIR(sxp
->st
.st_mode
))
492 || (!(preserve_times
& PRESERVE_LINK_TIMES
) && S_ISLNK(sxp
->st
.st_mode
)))
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 #ifndef CAN_CHOWN_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
));
530 uid_t uid
= change_uid
? (uid_t
)F_OWNER(file
) : sxp
->st
.st_uid
;
531 gid_t gid
= change_gid
? (gid_t
)F_GROUP(file
) : sxp
->st
.st_gid
;
532 if (do_lchown(fname
, uid
, 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 if (uid
== (uid_t
)-1 && sxp
->st
.st_uid
!= (uid_t
)-1)
541 rprintf(FERROR_XFER
, "uid 4294967295 (-1) is impossible to set on %s\n", full_fname(fname
));
542 if (gid
== (gid_t
)-1 && sxp
->st
.st_gid
!= (gid_t
)-1)
543 rprintf(FERROR_XFER
, "gid 4294967295 (-1) is impossible to set on %s\n", full_fname(fname
));
544 /* A lchown had been done, so we need to re-stat if
545 * the destination had the setuid or setgid bits set
546 * (due to the side effect of the chown call). */
547 if (sxp
->st
.st_mode
& (S_ISUID
| S_ISGID
)) {
548 link_stat(fname
, &sxp
->st
,
549 keep_dirlinks
&& S_ISDIR(sxp
->st
.st_mode
));
556 /* It's OK to call set_acl() now, even for a dir, as the generator
557 * will enable owner-writability using chmod, if necessary.
559 * If set_acl() changes permission bits in the process of setting
560 * an access ACL, it changes sxp->st.st_mode so we know whether we
561 * need to chmod(). */
562 if (preserve_acls
&& !S_ISLNK(new_mode
)) {
563 if (set_acl(fname
, file
, sxp
, new_mode
) > 0)
569 if (!BITS_EQUAL(sxp
->st
.st_mode
, new_mode
, CHMOD_BITS
)) {
570 int ret
= am_root
< 0 ? 0 : do_chmod(fname
, new_mode
);
572 rsyserr(FERROR_XFER
, errno
,
573 "failed to set permissions on %s",
577 if (ret
== 0) /* ret == 1 if symlink could not be set */
582 if (INFO_GTE(NAME
, 2) && flags
& ATTRS_REPORT
) {
584 rprintf(FCLIENT
, "%s\n", fname
);
586 rprintf(FCLIENT
, "%s is uptodate\n", fname
);
594 #ifdef SUPPORT_XATTRS
602 RETSIGTYPE
sig_int(UNUSED(int val
))
604 /* KLUGE: if the user hits Ctrl-C while ssh is prompting
605 * for a password, then our cleanup's sending of a SIGUSR1
606 * signal to all our children may kill ssh before it has a
607 * chance to restore the tty settings (i.e. turn echo back
608 * on). By sleeping for a short time, ssh gets a bigger
609 * chance to do the right thing. If child processes are
610 * not ssh waiting for a password, then this tiny delay
611 * shouldn't hurt anything. */
613 exit_cleanup(RERR_SIGNAL
);
616 /* Finish off a file transfer: renaming the file and setting the file's
617 * attributes (e.g. permissions, ownership, etc.). If the robust_rename()
618 * call is forced to copy the temp file and partialptr is both non-NULL and
619 * not an absolute path, we stage the file into the partial-dir and then
620 * rename it into place. This returns 1 on succcess or 0 on failure. */
621 int finish_transfer(const char *fname
, const char *fnametmp
,
622 const char *fnamecmp
, const char *partialptr
,
623 struct file_struct
*file
, int ok_to_set_time
,
624 int overwriting_basis
)
627 const char *temp_copy_name
= partialptr
&& *partialptr
!= '/' ? partialptr
: NULL
;
630 if (DEBUG_GTE(RECV
, 1))
631 rprintf(FINFO
, "finishing %s\n", fname
);
633 goto do_set_file_attrs
;
636 if (make_backups
> 0 && overwriting_basis
) {
637 int ok
= make_backup(fname
, False
);
640 if (ok
== 1 && fnamecmp
== fname
)
641 fnamecmp
= get_backup_name(fname
);
644 /* Change permissions before putting the file into place. */
645 set_file_attrs(fnametmp
, file
, NULL
, fnamecmp
,
646 ok_to_set_time
? 0 : ATTRS_SKIP_MTIME
);
648 /* move tmp file over real file */
649 if (DEBUG_GTE(RECV
, 1))
650 rprintf(FINFO
, "renaming %s to %s\n", fnametmp
, fname
);
651 ret
= robust_rename(fnametmp
, fname
, temp_copy_name
, file
->mode
);
653 rsyserr(FERROR_XFER
, errno
, "%s %s -> \"%s\"",
654 ret
== -2 ? "copy" : "rename",
655 full_fname(fnametmp
), fname
);
656 if (!partialptr
|| (ret
== -2 && temp_copy_name
)
657 || robust_rename(fnametmp
, partialptr
, NULL
, file
->mode
) < 0)
662 /* The file was moved into place (not copied), so it's done. */
665 /* The file was copied, so tweak the perms of the copied file. If it
666 * was copied to partialptr, move it into its final destination. */
667 fnametmp
= temp_copy_name
? temp_copy_name
: fname
;
670 set_file_attrs(fnametmp
, file
, NULL
, fnamecmp
,
671 ok_to_set_time
? 0 : ATTRS_SKIP_MTIME
);
673 if (temp_copy_name
) {
674 if (do_rename(fnametmp
, fname
) < 0) {
675 rsyserr(FERROR_XFER
, errno
, "rename %s -> \"%s\"",
676 full_fname(fnametmp
), fname
);
679 handle_partial_dir(temp_copy_name
, PDIR_DELETE
);
684 struct file_list
*flist_for_ndx(int ndx
, const char *fatal_error_loc
)
686 struct file_list
*flist
= cur_flist
;
688 if (!flist
&& !(flist
= first_flist
))
691 while (ndx
< flist
->ndx_start
-1) {
692 if (flist
== first_flist
)
696 while (ndx
>= flist
->ndx_start
+ flist
->used
) {
697 if (!(flist
= flist
->next
))
703 if (fatal_error_loc
) {
706 first
= first_flist
->ndx_start
- 1;
707 last
= first_flist
->prev
->ndx_start
+ first_flist
->prev
->used
- 1;
713 "File-list index %d not in %d - %d (%s) [%s]\n",
714 ndx
, first
, last
, fatal_error_loc
, who_am_i());
715 exit_cleanup(RERR_PROTOCOL
);
720 const char *who_am_i(void)
723 return am_server
? "server" : "client";
724 return am_sender
? "sender"
725 : am_generator
? "generator"
726 : am_receiver
? "receiver"
727 : "Receiver"; /* pre-forked receiver */