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_ICONV_OPEN && defined HAVE_ICONV_H
26 #if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
27 #include <libcharset.h>
28 #elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
34 extern int preserve_acls;
35 extern int preserve_perms;
36 extern int preserve_executability;
37 extern int preserve_times;
38 extern int omit_dir_times;
42 extern int am_generator;
43 extern int am_starting_up;
44 extern int allow_8bit_chars;
45 extern int protocol_version;
46 extern int preserve_uid;
47 extern int preserve_gid;
48 extern int inc_recurse;
51 extern int keep_dirlinks;
52 extern int make_backups;
53 extern struct file_list *cur_flist, *first_flist, *dir_flist;
54 extern struct chmod_mode_struct *daemon_chmod_modes;
56 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
57 iconv_t ic_chck = (iconv_t)-1;
59 static const char *default_charset(void)
61 #if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
62 return locale_charset();
63 #elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
64 return nl_langinfo(CODESET);
66 return ""; /* Works with (at the very least) gnu iconv... */
72 if (!am_server && !allow_8bit_chars) {
73 const char *defset = default_charset();
75 /* It's OK if this fails... */
76 ic_chck = iconv_open(defset, defset);
79 if (ic_chck == (iconv_t)-1) {
81 "note: iconv_open(\"%s\", \"%s\") failed (%d)"
82 " -- using isprint() instead of iconv().\n",
83 defset, defset, errno);
86 "note: iconv_open(\"%s\", \"%s\") succeeded.\n",
94 /* This is used by sender.c with a valid f_out, and by receive.c with
96 int read_ndx_and_attrs(int f_in, int f_out, int *iflag_ptr,
97 uchar *type_ptr, char *buf, int *len_ptr)
100 struct file_list *flist;
101 uchar fnamecmp_type = FNAMECMP_FNAME;
102 int verbose_save, ndx;
106 ndx = read_ndx(f_in);
112 if (!inc_recurse || am_sender)
114 if (ndx == NDX_FLIST_EOF) {
116 send_msg(MSG_FLIST_EOF, "", 0);
119 ndx = NDX_FLIST_OFFSET - ndx;
120 if (ndx < 0 || ndx >= dir_flist->count) {
121 ndx = NDX_FLIST_OFFSET - ndx;
123 "Invalid dir index: %d (%d - %d)\n",
124 ndx, NDX_FLIST_OFFSET,
125 NDX_FLIST_OFFSET - dir_flist->count);
126 exit_cleanup(RERR_PROTOCOL);
128 verbose_save = verbose;
129 verbose = 0; /* TODO allow verbose messages? */
131 /* Send everything read from f_in to msg_fd_out. */
132 send_msg_int(MSG_FLIST, ndx);
133 start_flist_forward(f_in);
134 flist = recv_file_list(f_in);
135 flist->parent_ndx = ndx;
136 stop_flist_forward();
138 verbose = verbose_save;
141 iflags = protocol_version >= 29 ? read_shortint(f_in)
142 : ITEM_TRANSFER | ITEM_MISSING_DATA;
144 /* Honor the old-style keep-alive indicator. */
145 if (protocol_version < 30
146 && ndx == cur_flist->count && iflags == ITEM_IS_NEW) {
148 maybe_send_keepalive();
152 if (!(flist = flist_for_ndx(ndx))) {
155 "Invalid file index: %d (%d - %d) with iflags %x [%s]\n",
156 ndx, first_flist->ndx_start + first_flist->ndx_start,
157 first_flist->prev->ndx_start + first_flist->ndx_start
158 + first_flist->prev->count - 1, iflags, who_am_i());
159 exit_cleanup(RERR_PROTOCOL);
163 if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
164 fnamecmp_type = read_byte(f_in);
165 *type_ptr = fnamecmp_type;
167 if (iflags & ITEM_XNAME_FOLLOWS) {
168 if ((len = read_vstring(f_in, buf, MAXPATHLEN)) < 0)
169 exit_cleanup(RERR_PROTOCOL);
176 if (iflags & ITEM_TRANSFER) {
177 int i = ndx - cur_flist->ndx_start;
178 if (!S_ISREG(cur_flist->files[i]->mode)) {
180 "received request to transfer non-regular file: %d [%s]\n",
182 exit_cleanup(RERR_PROTOCOL);
184 } else if (f_out >= 0) {
186 send_extra_file_list(f_out, FILECNT_LOOKAHEAD);
187 write_ndx_and_attrs(f_out, ndx, iflags,
188 fnamecmp_type, buf, len);
198 void free_sums(struct sum_struct *s)
200 if (s->sums) free(s->sums);
204 /* This is only called when we aren't preserving permissions. Figure out what
205 * the permissions should be and return them merged back into the mode. */
206 mode_t dest_mode(mode_t flist_mode, mode_t stat_mode, int dflt_perms,
210 /* If the file already exists, we'll return the local permissions,
211 * possibly tweaked by the --executability option. */
213 new_mode = (flist_mode & ~CHMOD_BITS) | (stat_mode & CHMOD_BITS);
214 if (preserve_executability && S_ISREG(flist_mode)) {
215 /* If the source file is executable, grant execute
216 * rights to everyone who can read, but ONLY if the
217 * file isn't already executable. */
218 if (!(flist_mode & 0111))
220 else if (!(stat_mode & 0111))
221 new_mode |= (new_mode & 0444) >> 2;
224 /* Apply destination default permissions and turn
225 * off special permissions. */
226 new_mode = flist_mode & (~CHMOD_BITS | dflt_perms);
231 int set_file_attrs(char *fname, struct file_struct *file, statx *sxp,
236 int change_uid, change_gid;
237 mode_t new_mode = file->mode;
242 if (link_stat(fname, &sx2.st, 0) < 0) {
243 rsyserr(FERROR, errno, "stat %s failed",
248 sx2.acc_acl = sx2.def_acl = NULL;
250 if (!preserve_perms && S_ISDIR(new_mode)
251 && sx2.st.st_mode & S_ISGID) {
252 /* We just created this directory and its setgid
253 * bit is on, so make sure it stays on. */
260 if (preserve_acls && !S_ISLNK(file->mode) && !ACL_READY(*sxp))
264 if (!preserve_times || (S_ISDIR(sxp->st.st_mode) && omit_dir_times))
265 flags |= ATTRS_SKIP_MTIME;
266 if (!(flags & ATTRS_SKIP_MTIME)
267 && cmp_time(sxp->st.st_mtime, file->modtime) != 0) {
268 int ret = set_modtime(fname, file->modtime, sxp->st.st_mode);
270 rsyserr(FERROR, errno, "failed to set times on %s",
274 if (ret == 0) /* ret == 1 if symlink could not be set */
278 change_uid = am_root && preserve_uid && sxp->st.st_uid != F_UID(file);
279 change_gid = preserve_gid && F_GID(file) != GID_NONE
280 && sxp->st.st_gid != F_GID(file);
281 #if !defined HAVE_LCHOWN && !defined CHOWN_MODIFIES_SYMLINK
282 if (S_ISLNK(sxp->st.st_mode))
286 if (change_uid || change_gid) {
290 "set uid of %s from %ld to %ld\n",
292 (long)sxp->st.st_uid, (long)F_UID(file));
296 "set gid of %s from %ld to %ld\n",
298 (long)sxp->st.st_gid, (long)F_GID(file));
302 change_uid ? F_UID(file) : sxp->st.st_uid,
303 change_gid ? F_GID(file) : sxp->st.st_gid) != 0) {
304 /* shouldn't have attempted to change uid or gid
305 * unless have the privilege */
306 rsyserr(FERROR, errno, "%s %s failed",
307 change_uid ? "chown" : "chgrp",
311 /* a lchown had been done - we have to re-stat if the
312 * destination had the setuid or setgid bits set due
313 * to the side effect of the chown call */
314 if (sxp->st.st_mode & (S_ISUID | S_ISGID)) {
315 link_stat(fname, &sxp->st,
316 keep_dirlinks && S_ISDIR(sxp->st.st_mode));
321 if (daemon_chmod_modes && !S_ISLNK(new_mode))
322 new_mode = tweak_mode(new_mode, daemon_chmod_modes);
325 /* It's OK to call set_acl() now, even for a dir, as the generator
326 * will enable owner-writability using chmod, if necessary.
328 * If set_acl() changes permission bits in the process of setting
329 * an access ACL, it changes sxp->st.st_mode so we know whether we
330 * need to chmod(). */
331 if (preserve_acls && !S_ISLNK(new_mode) && set_acl(fname, file, sxp) == 0)
336 if (!BITS_EQUAL(sxp->st.st_mode, new_mode, CHMOD_BITS)) {
337 int ret = do_chmod(fname, new_mode);
339 rsyserr(FERROR, errno,
340 "failed to set permissions on %s",
344 if (ret == 0) /* ret == 1 if symlink could not be set */
349 if (verbose > 1 && flags & ATTRS_REPORT) {
351 rprintf(FCLIENT, "%s\n", fname);
353 rprintf(FCLIENT, "%s is uptodate\n", fname);
357 if (preserve_acls && sxp == &sx2)
363 RETSIGTYPE sig_int(UNUSED(int val))
365 /* KLUGE: if the user hits Ctrl-C while ssh is prompting
366 * for a password, then our cleanup's sending of a SIGUSR1
367 * signal to all our children may kill ssh before it has a
368 * chance to restore the tty settings (i.e. turn echo back
369 * on). By sleeping for a short time, ssh gets a bigger
370 * chance to do the right thing. If child processes are
371 * not ssh waiting for a password, then this tiny delay
372 * shouldn't hurt anything. */
374 exit_cleanup(RERR_SIGNAL);
377 /* Finish off a file transfer: renaming the file and setting the file's
378 * attributes (e.g. permissions, ownership, etc.). If partialptr is not
379 * NULL and the robust_rename() call is forced to copy the temp file, we
380 * stage the file into the partial-dir and then rename it into place. */
381 void finish_transfer(char *fname, char *fnametmp, char *partialptr,
382 struct file_struct *file, int ok_to_set_time,
383 int overwriting_basis)
389 rprintf(FINFO, "finishing %s\n", fname);
391 goto do_set_file_attrs;
394 if (make_backups > 0 && overwriting_basis && !make_backup(fname))
397 /* Change permissions before putting the file into place. */
398 set_file_attrs(fnametmp, file, NULL,
399 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
401 /* move tmp file over real file */
403 rprintf(FINFO, "renaming %s to %s\n", fnametmp, fname);
404 ret = robust_rename(fnametmp, fname, partialptr,
405 file->mode & INITACCESSPERMS);
407 rsyserr(FERROR, errno, "%s %s -> \"%s\"",
408 ret == -2 ? "copy" : "rename",
409 full_fname(fnametmp), fname);
414 /* The file was moved into place (not copied), so it's done. */
417 /* The file was copied, so tweak the perms of the copied file. If it
418 * was copied to partialptr, move it into its final destination. */
419 fnametmp = partialptr ? partialptr : fname;
422 set_file_attrs(fnametmp, file, NULL,
423 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
426 if (do_rename(fnametmp, fname) < 0) {
427 rsyserr(FERROR, errno, "rename %s -> \"%s\"",
428 full_fname(fnametmp), fname);
430 handle_partial_dir(partialptr, PDIR_DELETE);
434 struct file_list *flist_for_ndx(int ndx)
436 struct file_list *flist = cur_flist;
438 if (!flist && !(flist = first_flist))
441 while (ndx < flist->ndx_start) {
442 if (flist == first_flist)
446 while (ndx >= flist->ndx_start + flist->count) {
447 if (!(flist = flist->next))
453 const char *who_am_i(void)
456 return am_server ? "server" : "client";
457 return am_sender ? "sender" : am_generator ? "generator" : "receiver";