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-2007 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 version 2 as
10 * published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
23 #if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
24 #include <libcharset.h>
25 #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;
36 extern int omit_dir_times;
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 preserve_uid;
45 extern int preserve_gid;
46 extern int inc_recurse;
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;
64 static const char *default_charset(void)
66 #if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
67 return locale_charset();
68 #elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
69 return nl_langinfo(CODESET);
71 return ""; /* Works with (at the very least) gnu iconv... */
77 const char *defset = default_charset();
83 if (!am_server && !allow_8bit_chars) {
85 /* It's OK if this fails... */
86 ic_chck = iconv_open(defset, defset);
89 if (ic_chck == (iconv_t)-1) {
91 "note: iconv_open(\"%s\", \"%s\") failed (%d)"
92 " -- using isprint() instead of iconv().\n",
93 defset, defset, errno);
96 "note: iconv_open(\"%s\", \"%s\") succeeded.\n",
106 if ((cp = strchr(iconv_opt, ',')) != NULL) {
107 if (am_server) /* A local transfer needs this. */
113 if (!*iconv_opt || (*iconv_opt == '.' && iconv_opt[1] == '\0'))
118 if ((ic_send = iconv_open(UTF8_CHARSET, charset)) == (iconv_t)-1) {
119 rprintf(FERROR, "iconv_open(\"%s\", \"%s\") failed\n",
120 UTF8_CHARSET, charset);
121 exit_cleanup(RERR_UNSUPPORTED);
124 if ((ic_recv = iconv_open(charset, UTF8_CHARSET)) == (iconv_t)-1) {
125 rprintf(FERROR, "iconv_open(\"%s\", \"%s\") failed\n",
126 charset, UTF8_CHARSET);
127 exit_cleanup(RERR_UNSUPPORTED);
131 ic_ndx = ++file_extra_cnt;
134 rprintf(FINFO, "%s charset: %s\n",
135 am_server ? "server" : "client",
136 *charset ? charset : "[LOCALE]");
142 int read_ndx_and_attrs(int f_in, int *iflag_ptr, uchar *type_ptr,
143 char *buf, int *len_ptr)
146 struct file_list *flist;
147 uchar fnamecmp_type = FNAMECMP_FNAME;
152 ndx = read_ndx(f_in);
158 if (!inc_recurse || am_sender)
160 if (ndx == NDX_FLIST_EOF) {
162 send_msg(MSG_FLIST_EOF, "", 0, 0);
165 ndx = NDX_FLIST_OFFSET - ndx;
166 if (ndx < 0 || ndx >= dir_flist->count) {
167 ndx = NDX_FLIST_OFFSET - ndx;
169 "Invalid dir index: %d (%d - %d)\n",
170 ndx, NDX_FLIST_OFFSET,
171 NDX_FLIST_OFFSET - dir_flist->count);
172 exit_cleanup(RERR_PROTOCOL);
175 /* Send everything read from f_in to msg_fd_out. */
176 send_msg_int(MSG_FLIST, ndx);
177 start_flist_forward(f_in);
178 flist = recv_file_list(f_in);
179 flist->parent_ndx = ndx;
180 stop_flist_forward();
183 iflags = protocol_version >= 29 ? read_shortint(f_in)
184 : ITEM_TRANSFER | ITEM_MISSING_DATA;
186 /* Honor the old-style keep-alive indicator. */
187 if (protocol_version < 30
188 && ndx == cur_flist->count && iflags == ITEM_IS_NEW) {
190 maybe_send_keepalive();
194 if (!(flist = flist_for_ndx(ndx))) {
197 "Invalid file index: %d (%d - %d) with iflags %x [%s]\n",
198 ndx, first_flist->ndx_start + first_flist->ndx_start,
199 first_flist->prev->ndx_start + first_flist->ndx_start
200 + first_flist->prev->count - 1, iflags, who_am_i());
201 exit_cleanup(RERR_PROTOCOL);
205 if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
206 fnamecmp_type = read_byte(f_in);
207 *type_ptr = fnamecmp_type;
209 if (iflags & ITEM_XNAME_FOLLOWS) {
210 if ((len = read_vstring(f_in, buf, MAXPATHLEN)) < 0)
211 exit_cleanup(RERR_PROTOCOL);
218 if (iflags & ITEM_TRANSFER) {
219 int i = ndx - cur_flist->ndx_start;
220 if (!S_ISREG(cur_flist->files[i]->mode)) {
222 "received request to transfer non-regular file: %d [%s]\n",
224 exit_cleanup(RERR_PROTOCOL);
235 void free_sums(struct sum_struct *s)
237 if (s->sums) free(s->sums);
241 /* This is only called when we aren't preserving permissions. Figure out what
242 * the permissions should be and return them merged back into the mode. */
243 mode_t dest_mode(mode_t flist_mode, mode_t stat_mode, int dflt_perms,
247 /* If the file already exists, we'll return the local permissions,
248 * possibly tweaked by the --executability option. */
250 new_mode = (flist_mode & ~CHMOD_BITS) | (stat_mode & CHMOD_BITS);
251 if (preserve_executability && S_ISREG(flist_mode)) {
252 /* If the source file is executable, grant execute
253 * rights to everyone who can read, but ONLY if the
254 * file isn't already executable. */
255 if (!(flist_mode & 0111))
257 else if (!(stat_mode & 0111))
258 new_mode |= (new_mode & 0444) >> 2;
261 /* Apply destination default permissions and turn
262 * off special permissions. */
263 new_mode = flist_mode & (~CHMOD_BITS | dflt_perms);
268 int set_file_attrs(const char *fname, struct file_struct *file, statx *sxp,
269 const char *fnamecmp, int flags)
273 int change_uid, change_gid;
274 mode_t new_mode = file->mode;
279 if (link_stat(fname, &sx2.st, 0) < 0) {
280 rsyserr(FERROR, errno, "stat %s failed",
285 sx2.acc_acl = sx2.def_acl = NULL;
287 #ifdef SUPPORT_XATTRS
290 if (!preserve_perms && S_ISDIR(new_mode)
291 && sx2.st.st_mode & S_ISGID) {
292 /* We just created this directory and its setgid
293 * bit is on, so make sure it stays on. */
300 if (preserve_acls && !S_ISLNK(file->mode) && !ACL_READY(*sxp))
304 #ifdef SUPPORT_XATTRS
305 if (preserve_xattrs && fnamecmp)
306 set_xattr(fname, file, fnamecmp, sxp);
308 set_stat_xattr(fname, file);
311 if (!preserve_times || (S_ISDIR(sxp->st.st_mode) && omit_dir_times))
312 flags |= ATTRS_SKIP_MTIME;
313 if (!(flags & ATTRS_SKIP_MTIME)
314 && cmp_time(sxp->st.st_mtime, file->modtime) != 0) {
315 int ret = set_modtime(fname, file->modtime, sxp->st.st_mode);
317 rsyserr(FERROR, errno, "failed to set times on %s",
321 if (ret == 0) /* ret == 1 if symlink could not be set */
325 change_uid = am_root && preserve_uid && sxp->st.st_uid != F_UID(file);
326 change_gid = preserve_gid && F_GID(file) != GID_NONE
327 && sxp->st.st_gid != F_GID(file);
328 #if !defined HAVE_LCHOWN && !defined CHOWN_MODIFIES_SYMLINK
329 if (S_ISLNK(sxp->st.st_mode))
333 if (change_uid || change_gid) {
337 "set uid of %s from %ld to %ld\n",
339 (long)sxp->st.st_uid, (long)F_UID(file));
343 "set gid of %s from %ld to %ld\n",
345 (long)sxp->st.st_gid, (long)F_GID(file));
350 } else if (do_lchown(fname,
351 change_uid ? F_UID(file) : sxp->st.st_uid,
352 change_gid ? F_GID(file) : sxp->st.st_gid) != 0) {
353 /* shouldn't have attempted to change uid or gid
354 * unless have the privilege */
355 rsyserr(FERROR, errno, "%s %s failed",
356 change_uid ? "chown" : "chgrp",
360 /* a lchown had been done - we have to re-stat if the
361 * destination had the setuid or setgid bits set due
362 * to the side effect of the chown call */
363 if (sxp->st.st_mode & (S_ISUID | S_ISGID)) {
364 link_stat(fname, &sxp->st,
365 keep_dirlinks && S_ISDIR(sxp->st.st_mode));
370 if (daemon_chmod_modes && !S_ISLNK(new_mode))
371 new_mode = tweak_mode(new_mode, daemon_chmod_modes);
374 /* It's OK to call set_acl() now, even for a dir, as the generator
375 * will enable owner-writability using chmod, if necessary.
377 * If set_acl() changes permission bits in the process of setting
378 * an access ACL, it changes sxp->st.st_mode so we know whether we
379 * need to chmod(). */
380 if (preserve_acls && !S_ISLNK(new_mode) && set_acl(fname, file, sxp) == 0)
385 if (!BITS_EQUAL(sxp->st.st_mode, new_mode, CHMOD_BITS)) {
386 int ret = am_root < 0 ? 0 : do_chmod(fname, new_mode);
388 rsyserr(FERROR, errno,
389 "failed to set permissions on %s",
393 if (ret == 0) /* ret == 1 if symlink could not be set */
398 if (verbose > 1 && flags & ATTRS_REPORT) {
400 rprintf(FCLIENT, "%s\n", fname);
402 rprintf(FCLIENT, "%s is uptodate\n", fname);
410 #ifdef SUPPORT_XATTRS
418 RETSIGTYPE sig_int(UNUSED(int val))
420 /* KLUGE: if the user hits Ctrl-C while ssh is prompting
421 * for a password, then our cleanup's sending of a SIGUSR1
422 * signal to all our children may kill ssh before it has a
423 * chance to restore the tty settings (i.e. turn echo back
424 * on). By sleeping for a short time, ssh gets a bigger
425 * chance to do the right thing. If child processes are
426 * not ssh waiting for a password, then this tiny delay
427 * shouldn't hurt anything. */
429 exit_cleanup(RERR_SIGNAL);
432 /* Finish off a file transfer: renaming the file and setting the file's
433 * attributes (e.g. permissions, ownership, etc.). If partialptr is not
434 * NULL and the robust_rename() call is forced to copy the temp file, we
435 * stage the file into the partial-dir and then rename it into place. */
436 void finish_transfer(const char *fname, const char *fnametmp,
437 const char *fnamecmp, const char *partialptr,
438 struct file_struct *file, int ok_to_set_time,
439 int overwriting_basis)
445 rprintf(FINFO, "finishing %s\n", fname);
447 goto do_set_file_attrs;
450 if (make_backups > 0 && overwriting_basis && !make_backup(fname))
453 /* Change permissions before putting the file into place. */
454 set_file_attrs(fnametmp, file, NULL, fnamecmp,
455 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
457 /* move tmp file over real file */
459 rprintf(FINFO, "renaming %s to %s\n", fnametmp, fname);
460 ret = robust_rename(fnametmp, fname, partialptr,
461 file->mode & INITACCESSPERMS);
463 rsyserr(FERROR, errno, "%s %s -> \"%s\"",
464 ret == -2 ? "copy" : "rename",
465 full_fname(fnametmp), fname);
470 /* The file was moved into place (not copied), so it's done. */
473 /* The file was copied, so tweak the perms of the copied file. If it
474 * was copied to partialptr, move it into its final destination. */
475 fnametmp = partialptr ? partialptr : fname;
478 set_file_attrs(fnametmp, file, NULL, fnamecmp,
479 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
482 if (do_rename(fnametmp, fname) < 0) {
483 rsyserr(FERROR, errno, "rename %s -> \"%s\"",
484 full_fname(fnametmp), fname);
486 handle_partial_dir(partialptr, PDIR_DELETE);
490 struct file_list *flist_for_ndx(int ndx)
492 struct file_list *flist = cur_flist;
494 if (!flist && !(flist = first_flist))
497 while (ndx < flist->ndx_start) {
498 if (flist == first_flist)
502 while (ndx >= flist->ndx_start + flist->count) {
503 if (!(flist = flist->next))
509 const char *who_am_i(void)
512 return am_server ? "server" : "client";
513 return am_sender ? "sender" : am_generator ? "generator" : "receiver";