2 * Routines only used by the receiving process.
4 * Copyright (C) 1996-2000 Andrew Tridgell
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2003, 2004, 2005, 2006 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 2 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, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
28 extern int do_progress;
29 extern int log_before_transfer;
30 extern int stdout_format_has_i;
31 extern int logfile_format_has_i;
32 extern int csum_length;
33 extern int read_batch;
34 extern int write_batch;
35 extern int batch_gen_fd;
36 extern int protocol_version;
37 extern int relative_paths;
38 extern int preserve_hard_links;
39 extern int preserve_perms;
40 extern int basis_dir_cnt;
41 extern int make_backups;
42 extern int cleanup_got_literal;
43 extern int remove_source_files;
44 extern int append_mode;
45 extern int sparse_files;
46 extern int keep_partial;
47 extern int checksum_seed;
49 extern int delay_updates;
50 extern struct stats stats;
51 extern char *stdout_format;
53 extern char *partial_dir;
54 extern char *basis_dir[];
55 extern struct file_list *the_file_list;
56 extern struct filter_list_struct server_filter_list;
58 static struct bitbag *delayed_bits = NULL;
60 /* We're either updating the basis file or an identical copy: */
61 static int updating_basis;
65 * get_tmpname() - create a tmp filename for a given filename
67 * If a tmpdir is defined, use that as the directory to
68 * put it in. Otherwise, the tmp filename is in the same
69 * directory as the given name. Note that there may be no
70 * directory at all in the given name!
72 * The tmp filename is basically the given filename with a
73 * dot prepended, and .XXXXXX appended (for mkstemp() to
74 * put its unique gunk in). Take care to not exceed
75 * either the MAXPATHLEN or NAME_MAX, esp. the last, as
76 * the basename basically becomes 8 chars longer. In that
77 * case, the original name is shortened sufficiently to
80 * Of course, there's no real reason for the tmp name to
81 * look like the original, except to satisfy us humans.
82 * As long as it's unique, rsync will work.
85 int get_tmpname(char *fnametmp, char *fname)
87 int maxname, added, length = 0;
91 /* Note: this can't overflow, so the return value is safe */
92 length = strlcpy(fnametmp, tmpdir, MAXPATHLEN - 2);
93 fnametmp[length++] = '/';
96 if ((f = strrchr(fname, '/')) != NULL) {
100 /* copy up to and including the slash */
101 strlcpy(fnametmp, fname, length + 1);
105 fnametmp[length++] = '.';
107 /* The maxname value is bufsize, and includes space for the '\0'.
108 * (Note that NAME_MAX get -8 for the leading '.' above.) */
109 maxname = MIN(MAXPATHLEN - 7 - length, NAME_MAX - 8);
112 rprintf(FERROR, "temporary filename too long: %s\n", fname);
117 added = strlcpy(fnametmp + length, f, maxname);
118 if (added >= maxname)
120 memcpy(fnametmp + length + added, ".XXXXXX", 8);
126 static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
127 char *fname, int fd, OFF_T total_size)
129 static char file_sum1[MD4_SUM_LENGTH];
130 static char file_sum2[MD4_SUM_LENGTH];
131 struct map_struct *mapbuf;
132 struct sum_struct sum;
140 read_sum_head(f_in, &sum);
142 if (fd_r >= 0 && size_r > 0) {
143 int32 read_size = MAX(sum.blength * 2, 16*1024);
144 mapbuf = map_file(fd_r, size_r, read_size, sum.blength);
146 rprintf(FINFO, "recv mapped %s of size %.0f\n",
147 fname_r, (double)size_r);
152 sum_init(checksum_seed);
156 sum.flength = (OFF_T)sum.count * sum.blength;
158 sum.flength -= sum.blength - sum.remainder;
159 for (j = CHUNK_SIZE; j < sum.flength; j += CHUNK_SIZE) {
161 show_progress(offset, total_size);
162 sum_update(map_ptr(mapbuf, offset, CHUNK_SIZE),
166 if (offset < sum.flength) {
167 int32 len = (int32)(sum.flength - offset);
169 show_progress(offset, total_size);
170 sum_update(map_ptr(mapbuf, offset, len), len);
171 offset = sum.flength;
173 if (fd != -1 && (j = do_lseek(fd, offset, SEEK_SET)) != offset) {
174 rsyserr(FERROR, errno, "lseek of %s returned %.0f, not %.0f",
175 full_fname(fname), (double)j, (double)offset);
176 exit_cleanup(RERR_FILEIO);
180 while ((i = recv_token(f_in, &data)) != 0) {
182 show_progress(offset, total_size);
186 rprintf(FINFO,"data recv %d at %.0f\n",
190 stats.literal_data += i;
191 cleanup_got_literal = 1;
195 if (fd != -1 && write_file(fd,data,i) != i)
196 goto report_write_error;
202 offset2 = i * (OFF_T)sum.blength;
204 if (i == (int)sum.count-1 && sum.remainder != 0)
207 stats.matched_data += len;
211 "chunk[%d] of size %ld at %.0f offset=%.0f\n",
212 i, (long)len, (double)offset2, (double)offset);
216 map = map_ptr(mapbuf,offset2,len);
219 sum_update(map, len);
222 if (updating_basis) {
223 if (offset == offset2 && fd != -1) {
225 if (flush_write_file(fd) < 0)
226 goto report_write_error;
228 if ((pos = do_lseek(fd, len, SEEK_CUR)) != offset) {
229 rsyserr(FERROR, errno,
230 "lseek of %s returned %.0f, not %.0f",
232 (double)pos, (double)offset);
233 exit_cleanup(RERR_FILEIO);
238 if (fd != -1 && map && write_file(fd, map, len) != (int)len)
239 goto report_write_error;
243 if (flush_write_file(fd) < 0)
244 goto report_write_error;
246 #ifdef HAVE_FTRUNCATE
247 if (inplace && fd != -1)
248 ftruncate(fd, offset);
252 end_progress(total_size);
254 if (fd != -1 && offset > 0 && sparse_end(fd) != 0) {
256 rsyserr(FERROR, errno, "write failed on %s",
258 exit_cleanup(RERR_FILEIO);
266 read_buf(f_in,file_sum2,MD4_SUM_LENGTH);
268 rprintf(FINFO,"got file_sum\n");
269 if (fd != -1 && memcmp(file_sum1, file_sum2, MD4_SUM_LENGTH) != 0)
275 static void discard_receive_data(int f_in, OFF_T length)
277 receive_data(f_in, NULL, -1, 0, NULL, -1, length);
280 static void handle_delayed_updates(struct file_list *flist, char *local_name)
282 char *fname, *partialptr;
285 for (ndx = -1; (ndx = bitbag_next_bit(delayed_bits, ndx)) >= 0; ) {
286 struct file_struct *file = flist->files[ndx];
287 fname = local_name ? local_name : f_name(file, NULL);
288 if ((partialptr = partial_dir_fname(fname)) != NULL) {
289 if (make_backups && !make_backup(fname))
292 rprintf(FINFO, "renaming %s to %s\n",
295 /* We don't use robust_rename() here because the
296 * partial-dir must be on the same drive. */
297 if (do_rename(partialptr, fname) < 0) {
298 rsyserr(FERROR, errno,
299 "rename failed for %s (from %s)",
300 full_fname(fname), partialptr);
302 if (remove_source_files
303 || (preserve_hard_links && F_IS_HLINKED(file)))
304 send_msg_int(MSG_SUCCESS, ndx);
305 handle_partial_dir(partialptr, PDIR_DELETE);
311 static int get_next_gen_ndx(int batch_gen_fd, int next_gen_ndx, int desired_ndx)
313 while (next_gen_ndx < desired_ndx) {
314 if (next_gen_ndx >= 0) {
316 "(No batched update for%s \"%s\")\n",
317 phase ? " resend of" : "",
318 f_name(the_file_list->files[next_gen_ndx], NULL));
320 next_gen_ndx = read_int(batch_gen_fd);
321 if (next_gen_ndx == -1)
322 next_gen_ndx = the_file_list->count;
329 * main routine for receiver process.
331 * Receiver process runs on the same host as the generator process. */
332 int recv_files(int f_in, struct file_list *flist, char *local_name)
334 int next_gen_ndx = -1;
338 char *fname, fbuf[MAXPATHLEN];
339 char xname[MAXPATHLEN];
340 char fnametmp[MAXPATHLEN];
341 char *fnamecmp, *partialptr;
342 char fnamecmpbuf[MAXPATHLEN];
344 struct file_struct *file;
345 struct stats initial_stats;
346 int save_make_backups = make_backups;
347 int itemizing = am_server ? logfile_format_has_i : stdout_format_has_i;
348 enum logcode log_code = log_before_transfer ? FLOG : FINFO;
349 int max_phase = protocol_version >= 29 ? 2 : 1;
353 rprintf(FINFO, "recv_files(%d) starting\n", flist->count);
356 delayed_bits = bitbag_create(flist->count);
358 updating_basis = inplace;
363 ndx = read_int(f_in);
364 if (ndx == NDX_DONE) {
366 get_next_gen_ndx(batch_gen_fd, next_gen_ndx,
370 if (++phase > max_phase)
372 csum_length = SUM_LENGTH;
374 rprintf(FINFO, "recv_files phase=%d\n", phase);
375 if (phase == 2 && delay_updates)
376 handle_delayed_updates(flist, local_name);
377 send_msg(MSG_DONE, "", 0);
378 if (keep_partial && !partial_dir)
379 make_backups = 0; /* prevents double backup */
387 iflags = read_item_attrs(f_in, -1, ndx, &fnamecmp_type,
389 if (iflags == ITEM_IS_NEW) /* no-op packet */
392 file = flist->files[ndx];
393 fname = local_name ? local_name : f_name(file, fbuf);
396 rprintf(FINFO, "recv_files(%s)\n", fname);
398 if (!(iflags & ITEM_TRANSFER)) {
399 maybe_log_item(file, iflags, itemizing, xname);
404 "got transfer request in phase 2 [%s]\n",
406 exit_cleanup(RERR_PROTOCOL);
409 stats.current_file_index = ndx;
410 stats.num_transferred_files++;
411 stats.total_transferred_size += F_LENGTH(file);
412 cleanup_got_literal = 0;
414 if (server_filter_list.head
415 && check_filter(&server_filter_list, fname, 0) < 0) {
416 rprintf(FERROR, "attempt to hack rsync failed.\n");
417 exit_cleanup(RERR_PROTOCOL);
420 if (!do_xfers) { /* log the transfer */
421 log_item(FCLIENT, file, &stats, iflags, NULL);
423 discard_receive_data(f_in, F_LENGTH(file));
426 if (write_batch < 0) {
427 log_item(FINFO, file, &stats, iflags, NULL);
429 discard_receive_data(f_in, F_LENGTH(file));
434 next_gen_ndx = get_next_gen_ndx(batch_gen_fd, next_gen_ndx, ndx);
435 if (ndx < next_gen_ndx) {
437 "(Skipping batched update for \"%s\")\n",
439 discard_receive_data(f_in, F_LENGTH(file));
445 partialptr = partial_dir ? partial_dir_fname(fname) : fname;
447 if (protocol_version >= 29) {
448 switch (fnamecmp_type) {
452 case FNAMECMP_PARTIAL_DIR:
453 fnamecmp = partialptr;
455 case FNAMECMP_BACKUP:
456 fnamecmp = get_backup_name(fname);
461 pathjoin(fnamecmpbuf, MAXPATHLEN,
462 file->dirname, xname);
463 fnamecmp = fnamecmpbuf;
469 if (fnamecmp_type >= basis_dir_cnt) {
471 "invalid basis_dir index: %d.\n",
473 exit_cleanup(RERR_PROTOCOL);
475 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
476 basis_dir[fnamecmp_type], fname);
477 fnamecmp = fnamecmpbuf;
480 if (!fnamecmp || (server_filter_list.head
481 && check_filter(&server_filter_list, fname, 0) < 0))
484 /* Reminder: --inplace && --partial-dir are never
485 * enabled at the same time. */
486 if (inplace && make_backups) {
487 if (!(fnamecmp = get_backup_name(fname)))
489 } else if (partial_dir && partialptr)
490 fnamecmp = partialptr;
495 initial_stats = stats;
498 fd1 = do_open(fnamecmp, O_RDONLY, 0);
500 if (fd1 == -1 && protocol_version < 29) {
501 if (fnamecmp != fname) {
503 fd1 = do_open(fnamecmp, O_RDONLY, 0);
506 if (fd1 == -1 && basis_dir[0]) {
507 /* pre-29 allowed only one alternate basis */
508 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
509 basis_dir[0], fname);
510 fnamecmp = fnamecmpbuf;
511 fd1 = do_open(fnamecmp, O_RDONLY, 0);
518 } else if (do_fstat(fd1,&st) != 0) {
519 rsyserr(FERROR, errno, "fstat %s failed",
520 full_fname(fnamecmp));
521 discard_receive_data(f_in, F_LENGTH(file));
526 if (fd1 != -1 && S_ISDIR(st.st_mode) && fnamecmp == fname) {
527 /* this special handling for directories
528 * wouldn't be necessary if robust_rename()
529 * and the underlying robust_unlink could cope
532 rprintf(FERROR,"recv_files: %s is a directory\n",
533 full_fname(fnamecmp));
534 discard_receive_data(f_in, F_LENGTH(file));
539 if (fd1 != -1 && !S_ISREG(st.st_mode)) {
544 /* If we're not preserving permissions, change the file-list's
545 * mode based on the local permissions and some heuristics. */
546 if (!preserve_perms) {
547 int exists = fd1 != -1;
548 file->mode = dest_mode(file->mode, st.st_mode, exists);
551 /* We now check to see if we are writing the file "inplace" */
553 fd2 = do_open(fname, O_WRONLY|O_CREAT, 0600);
555 rsyserr(FERROR, errno, "open %s failed",
557 discard_receive_data(f_in, F_LENGTH(file));
563 if (!get_tmpname(fnametmp,fname)) {
564 discard_receive_data(f_in, F_LENGTH(file));
570 /* we initially set the perms without the
571 * setuid/setgid bits to ensure that there is no race
572 * condition. They are then correctly updated after
573 * the lchown. Thanks to snabb@epipe.fi for pointing
574 * this out. We also set it initially without group
575 * access because of a similar race condition. */
576 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
578 /* in most cases parent directories will already exist
579 * because their information should have been previously
580 * transferred, but that may not be the case with -R */
581 if (fd2 == -1 && relative_paths && errno == ENOENT
582 && create_directory_path(fnametmp) == 0) {
583 /* Get back to name with XXXXXX in it. */
584 get_tmpname(fnametmp, fname);
585 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
588 rsyserr(FERROR, errno, "mkstemp %s failed",
589 full_fname(fnametmp));
590 discard_receive_data(f_in, F_LENGTH(file));
596 cleanup_set(fnametmp, partialptr, file, fd1, fd2);
599 /* log the transfer */
600 if (log_before_transfer)
601 log_item(FCLIENT, file, &initial_stats, iflags, NULL);
602 else if (!am_server && verbose && do_progress)
603 rprintf(FINFO, "%s\n", fname);
606 recv_ok = receive_data(f_in, fnamecmp, fd1, st.st_size,
607 fname, fd2, F_LENGTH(file));
609 log_item(log_code, file, &initial_stats, iflags, NULL);
613 if (close(fd2) < 0) {
614 rsyserr(FERROR, errno, "close failed on %s",
615 full_fname(fnametmp));
616 exit_cleanup(RERR_FILEIO);
619 if ((recv_ok && (!delay_updates || !partialptr)) || inplace) {
620 char *temp_copy_name;
621 if (partialptr == fname)
622 partialptr = temp_copy_name = NULL;
623 else if (*partial_dir == '/')
624 temp_copy_name = NULL;
626 temp_copy_name = partialptr;
627 finish_transfer(fname, fnametmp, temp_copy_name,
629 if (fnamecmp == partialptr) {
630 do_unlink(partialptr);
631 handle_partial_dir(partialptr, PDIR_DELETE);
633 } else if (keep_partial && partialptr
634 && handle_partial_dir(partialptr, PDIR_CREATE)) {
635 finish_transfer(partialptr, fnametmp, NULL,
636 file, recv_ok, !partial_dir);
637 if (delay_updates && recv_ok) {
638 bitbag_set_bit(delayed_bits, ndx);
649 if (remove_source_files
650 || (preserve_hard_links && F_IS_HLINKED(file)))
651 send_msg_int(MSG_SUCCESS, ndx);
652 } else if (!recv_ok) {
653 enum logcode msgtype = phase || read_batch ? FERROR : FINFO;
654 if (msgtype == FERROR || verbose) {
655 char *errstr, *redostr, *keptstr;
656 if (!(keep_partial && partialptr) && !inplace)
657 keptstr = "discarded";
658 else if (partial_dir)
659 keptstr = "put into partial-dir";
661 keptstr = "retained";
662 if (msgtype == FERROR) {
667 redostr = " (will try again)";
670 "%s: %s failed verification -- update %s%s.\n",
671 errstr, fname, keptstr, redostr);
674 send_msg_int(MSG_REDO, ndx);
677 make_backups = save_make_backups;
679 if (phase == 2 && delay_updates) /* for protocol_version < 29 */
680 handle_delayed_updates(flist, local_name);
683 rprintf(FINFO,"recv_files finished\n");