If we're not root and the "fakeroot" command is available, use it
[rsync.git] / receiver.c
blobff02e20baa507f7ddf0a56284a0dbcbad4974f0b
1 /* -*- c-file-style: "linux" -*-
3 Copyright (C) 1996-2000 by Andrew Tridgell
4 Copyright (C) Paul Mackerras 1996
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "rsync.h"
23 extern int verbose;
24 extern int dry_run;
25 extern int am_daemon;
26 extern int am_server;
27 extern int do_progress;
28 extern int log_before_transfer;
29 extern int log_format_has_i;
30 extern int daemon_log_format_has_i;
31 extern int csum_length;
32 extern int read_batch;
33 extern int batch_gen_fd;
34 extern int protocol_version;
35 extern int relative_paths;
36 extern int keep_dirlinks;
37 extern int preserve_hard_links;
38 extern int preserve_perms;
39 extern int io_error;
40 extern int basis_dir_cnt;
41 extern int make_backups;
42 extern int cleanup_got_literal;
43 extern int remove_sent_files;
44 extern int module_id;
45 extern int ignore_errors;
46 extern int orig_umask;
47 extern int keep_partial;
48 extern int checksum_seed;
49 extern int inplace;
50 extern int delay_updates;
51 extern struct stats stats;
52 extern char *log_format;
53 extern char *tmpdir;
54 extern char *partial_dir;
55 extern char *basis_dir[];
57 extern struct filter_list_struct server_filter_list;
59 #define SLOT_SIZE (16*1024) /* Desired size in bytes */
60 #define PER_SLOT_BITS (SLOT_SIZE * 8) /* Number of bits per slot */
61 #define PER_SLOT_INTS (SLOT_SIZE / 4) /* Number of int32s per slot */
63 static uint32 **delayed_bits = NULL;
64 static int delayed_slot_cnt = 0;
66 static void init_delayed_bits(int max_ndx)
68 delayed_slot_cnt = (max_ndx + PER_SLOT_BITS - 1) / PER_SLOT_BITS;
70 if (!(delayed_bits = (uint32**)calloc(delayed_slot_cnt, sizeof (uint32*))))
71 out_of_memory("set_delayed_bit");
74 static void set_delayed_bit(int ndx)
76 int slot = ndx / PER_SLOT_BITS;
77 ndx %= PER_SLOT_BITS;
79 if (!delayed_bits[slot]) {
80 if (!(delayed_bits[slot] = (uint32*)calloc(PER_SLOT_INTS, 4)))
81 out_of_memory("set_delayed_bit");
84 delayed_bits[slot][ndx/32] |= 1u << (ndx % 32);
87 /* Call this with -1 to start checking from 0. Returns -1 at the end. */
88 static int next_delayed_bit(int after)
90 uint32 bits, mask;
91 int i, ndx = after + 1;
92 int slot = ndx / PER_SLOT_BITS;
93 ndx %= PER_SLOT_BITS;
95 mask = (1u << (ndx % 32)) - 1;
96 for (i = ndx / 32; slot < delayed_slot_cnt; slot++, i = mask = 0) {
97 if (!delayed_bits[slot])
98 continue;
99 for ( ; i < PER_SLOT_INTS; i++, mask = 0) {
100 if (!(bits = delayed_bits[slot][i] & ~mask))
101 continue;
102 /* The xor magic figures out the lowest enabled bit in
103 * bits, and the switch quickly computes log2(bit). */
104 switch (bits ^ (bits & (bits-1))) {
105 #define LOG2(n) case 1u << n: return slot*PER_SLOT_BITS + i*32 + n
106 LOG2(0); LOG2(1); LOG2(2); LOG2(3);
107 LOG2(4); LOG2(5); LOG2(6); LOG2(7);
108 LOG2(8); LOG2(9); LOG2(10); LOG2(11);
109 LOG2(12); LOG2(13); LOG2(14); LOG2(15);
110 LOG2(16); LOG2(17); LOG2(18); LOG2(19);
111 LOG2(20); LOG2(21); LOG2(22); LOG2(23);
112 LOG2(24); LOG2(25); LOG2(26); LOG2(27);
113 LOG2(28); LOG2(29); LOG2(30); LOG2(31);
115 return -1; /* impossible... */
119 return -1;
124 * get_tmpname() - create a tmp filename for a given filename
126 * If a tmpdir is defined, use that as the directory to
127 * put it in. Otherwise, the tmp filename is in the same
128 * directory as the given name. Note that there may be no
129 * directory at all in the given name!
131 * The tmp filename is basically the given filename with a
132 * dot prepended, and .XXXXXX appended (for mkstemp() to
133 * put its unique gunk in). Take care to not exceed
134 * either the MAXPATHLEN or NAME_MAX, esp. the last, as
135 * the basename basically becomes 8 chars longer. In that
136 * case, the original name is shortened sufficiently to
137 * make it all fit.
139 * Of course, there's no real reason for the tmp name to
140 * look like the original, except to satisfy us humans.
141 * As long as it's unique, rsync will work.
144 static int get_tmpname(char *fnametmp, char *fname)
146 char *f;
147 int length = 0;
148 int maxname;
150 if (tmpdir) {
151 /* Note: this can't overflow, so the return value is safe */
152 length = strlcpy(fnametmp, tmpdir, MAXPATHLEN - 2);
153 fnametmp[length++] = '/';
154 fnametmp[length] = '\0'; /* always NULL terminated */
157 if ((f = strrchr(fname, '/')) != NULL) {
158 ++f;
159 if (!tmpdir) {
160 length = f - fname;
161 /* copy up to and including the slash */
162 strlcpy(fnametmp, fname, length + 1);
164 } else
165 f = fname;
166 fnametmp[length++] = '.';
167 fnametmp[length] = '\0'; /* always NULL terminated */
169 maxname = MIN(MAXPATHLEN - 7 - length, NAME_MAX - 8);
171 if (maxname < 1) {
172 rprintf(FERROR, "temporary filename too long: %s\n",
173 safe_fname(fname));
174 fnametmp[0] = '\0';
175 return 0;
178 strlcpy(fnametmp + length, f, maxname);
179 strcat(fnametmp + length, ".XXXXXX");
181 return 1;
185 static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
186 char *fname, int fd, OFF_T total_size)
188 static char file_sum1[MD4_SUM_LENGTH];
189 static char file_sum2[MD4_SUM_LENGTH];
190 struct map_struct *mapbuf;
191 struct sum_struct sum;
192 int32 len;
193 OFF_T offset = 0;
194 OFF_T offset2;
195 char *data;
196 int32 i;
197 char *map = NULL;
199 read_sum_head(f_in, &sum);
201 if (fd_r >= 0 && size_r > 0) {
202 int32 read_size = MAX(sum.blength * 2, 16*1024);
203 mapbuf = map_file(fd_r, size_r, read_size, sum.blength);
204 if (verbose > 2) {
205 rprintf(FINFO, "recv mapped %s of size %.0f\n",
206 safe_fname(fname_r), (double)size_r);
208 } else
209 mapbuf = NULL;
211 sum_init(checksum_seed);
213 while ((i = recv_token(f_in, &data)) != 0) {
214 if (do_progress)
215 show_progress(offset, total_size);
217 if (i > 0) {
218 if (verbose > 3) {
219 rprintf(FINFO,"data recv %d at %.0f\n",
220 i,(double)offset);
223 stats.literal_data += i;
224 cleanup_got_literal = 1;
226 sum_update(data, i);
228 if (fd != -1 && write_file(fd,data,i) != i)
229 goto report_write_error;
230 offset += i;
231 continue;
234 i = -(i+1);
235 offset2 = i * (OFF_T)sum.blength;
236 len = sum.blength;
237 if (i == (int)sum.count-1 && sum.remainder != 0)
238 len = sum.remainder;
240 stats.matched_data += len;
242 if (verbose > 3) {
243 rprintf(FINFO,
244 "chunk[%d] of size %ld at %.0f offset=%.0f\n",
245 i, (long)len, (double)offset2, (double)offset);
248 if (mapbuf) {
249 map = map_ptr(mapbuf,offset2,len);
251 see_token(map, len);
252 sum_update(map, len);
255 if (inplace) {
256 if (offset == offset2 && fd != -1) {
257 if (flush_write_file(fd) < 0)
258 goto report_write_error;
259 offset += len;
260 if (do_lseek(fd, len, SEEK_CUR) != offset) {
261 rsyserr(FERROR, errno,
262 "lseek failed on %s",
263 full_fname(fname));
264 exit_cleanup(RERR_FILEIO);
266 continue;
269 if (fd != -1 && write_file(fd, map, len) != (int)len)
270 goto report_write_error;
271 offset += len;
274 if (flush_write_file(fd) < 0)
275 goto report_write_error;
277 #ifdef HAVE_FTRUNCATE
278 if (inplace && fd != -1)
279 ftruncate(fd, offset);
280 #endif
282 if (do_progress)
283 end_progress(total_size);
285 if (fd != -1 && offset > 0 && sparse_end(fd) != 0) {
286 report_write_error:
287 rsyserr(FERROR, errno, "write failed on %s",
288 full_fname(fname));
289 exit_cleanup(RERR_FILEIO);
292 sum_end(file_sum1);
294 if (mapbuf)
295 unmap_file(mapbuf);
297 read_buf(f_in,file_sum2,MD4_SUM_LENGTH);
298 if (verbose > 2)
299 rprintf(FINFO,"got file_sum\n");
300 if (fd != -1 && memcmp(file_sum1, file_sum2, MD4_SUM_LENGTH) != 0)
301 return 0;
302 return 1;
306 static void discard_receive_data(int f_in, OFF_T length)
308 receive_data(f_in, NULL, -1, 0, NULL, -1, length);
311 static void handle_delayed_updates(struct file_list *flist, char *local_name)
313 char *fname, *partialptr, numbuf[4];
314 int i;
316 for (i = -1; (i = next_delayed_bit(i)) >= 0; ) {
317 struct file_struct *file = flist->files[i];
318 fname = local_name ? local_name : f_name(file);
319 if ((partialptr = partial_dir_fname(fname)) != NULL) {
320 if (make_backups && !make_backup(fname))
321 continue;
322 if (verbose > 2) {
323 rprintf(FINFO, "renaming %s to %s\n",
324 safe_fname(partialptr),
325 safe_fname(fname));
327 if (do_rename(partialptr, fname) < 0) {
328 rsyserr(FERROR, errno,
329 "rename failed for %s (from %s)",
330 full_fname(fname),
331 safe_fname(partialptr));
332 } else {
333 if (remove_sent_files
334 || (preserve_hard_links
335 && file->link_u.links)) {
336 SIVAL(numbuf, 0, i);
337 send_msg(MSG_SUCCESS,numbuf,4);
339 handle_partial_dir(partialptr,
340 PDIR_DELETE);
348 * main routine for receiver process.
350 * Receiver process runs on the same host as the generator process. */
351 int recv_files(int f_in, struct file_list *flist, char *local_name)
353 int next_gen_i = -1;
354 int fd1,fd2;
355 STRUCT_STAT st;
356 int iflags, xlen;
357 char *fname, fbuf[MAXPATHLEN];
358 char xname[MAXPATHLEN];
359 char fnametmp[MAXPATHLEN];
360 char *fnamecmp, *partialptr, numbuf[4];
361 char fnamecmpbuf[MAXPATHLEN];
362 uchar fnamecmp_type;
363 struct file_struct *file;
364 struct stats initial_stats;
365 int save_make_backups = make_backups;
366 int itemizing = am_daemon ? daemon_log_format_has_i
367 : !am_server && log_format_has_i;
368 int phase = 0, max_phase = protocol_version >= 29 ? 2 : 1;
369 int i, recv_ok;
371 if (verbose > 2)
372 rprintf(FINFO,"recv_files(%d) starting\n",flist->count);
374 if (flist->hlink_pool) {
375 pool_destroy(flist->hlink_pool);
376 flist->hlink_pool = NULL;
379 if (delay_updates)
380 init_delayed_bits(flist->count);
382 while (1) {
383 cleanup_disable();
385 i = read_int(f_in);
386 if (i == -1) {
387 if (read_batch) {
388 if (next_gen_i != flist->count)
389 while (read_int(batch_gen_fd) != -1) {}
390 next_gen_i = -1;
392 if (++phase > max_phase)
393 break;
394 csum_length = SUM_LENGTH;
395 if (verbose > 2)
396 rprintf(FINFO, "recv_files phase=%d\n", phase);
397 if (phase == 2 && delay_updates)
398 handle_delayed_updates(flist, local_name);
399 send_msg(MSG_DONE, "", 0);
400 if (keep_partial && !partial_dir)
401 make_backups = 0; /* prevents double backup */
402 continue;
405 iflags = read_item_attrs(f_in, -1, i, &fnamecmp_type,
406 xname, &xlen);
407 if (iflags == ITEM_IS_NEW) /* no-op packet */
408 continue;
410 file = flist->files[i];
411 fname = local_name ? local_name : f_name_to(file, fbuf);
413 if (verbose > 2)
414 rprintf(FINFO, "recv_files(%s)\n", safe_fname(fname));
416 if (!(iflags & ITEM_TRANSFER)) {
417 maybe_log_item(file, iflags, itemizing, xname);
418 continue;
420 if (phase == 2) {
421 rprintf(FERROR,
422 "got transfer request in phase 2 [%s]\n",
423 who_am_i());
424 exit_cleanup(RERR_PROTOCOL);
427 stats.current_file_index = i;
428 stats.num_transferred_files++;
429 stats.total_transferred_size += file->length;
430 cleanup_got_literal = 0;
432 if (server_filter_list.head
433 && check_filter(&server_filter_list, fname, 0) < 0) {
434 rprintf(FERROR, "attempt to hack rsync failed.\n");
435 exit_cleanup(RERR_PROTOCOL);
438 if (dry_run) { /* log the transfer */
439 if (!am_server && log_format)
440 log_item(file, &stats, iflags, NULL);
441 continue;
444 if (read_batch) {
445 while (i > next_gen_i) {
446 next_gen_i = read_int(batch_gen_fd);
447 if (next_gen_i == -1)
448 next_gen_i = flist->count;
450 if (i < next_gen_i) {
451 rprintf(FINFO, "skipping update for \"%s\"\n",
452 safe_fname(fname));
453 discard_receive_data(f_in, file->length);
454 continue;
456 next_gen_i = -1;
459 partialptr = partial_dir ? partial_dir_fname(fname) : fname;
461 if (protocol_version >= 29) {
462 switch (fnamecmp_type) {
463 case FNAMECMP_FNAME:
464 fnamecmp = fname;
465 break;
466 case FNAMECMP_PARTIAL_DIR:
467 fnamecmp = partialptr;
468 break;
469 case FNAMECMP_BACKUP:
470 fnamecmp = get_backup_name(fname);
471 break;
472 case FNAMECMP_FUZZY:
473 if (file->dirname) {
474 pathjoin(fnamecmpbuf, MAXPATHLEN,
475 file->dirname, xname);
476 fnamecmp = fnamecmpbuf;
477 } else
478 fnamecmp = xname;
479 break;
480 default:
481 if (fnamecmp_type >= basis_dir_cnt) {
482 rprintf(FERROR,
483 "invalid basis_dir index: %d.\n",
484 fnamecmp_type);
485 exit_cleanup(RERR_PROTOCOL);
487 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
488 basis_dir[fnamecmp_type], fname);
489 fnamecmp = fnamecmpbuf;
490 break;
492 if (!fnamecmp || (server_filter_list.head
493 && check_filter(&server_filter_list, fname, 0) < 0))
494 fnamecmp = fname;
495 } else {
496 /* Reminder: --inplace && --partial-dir are never
497 * enabled at the same time. */
498 if (inplace && make_backups) {
499 if (!(fnamecmp = get_backup_name(fname)))
500 fnamecmp = fname;
501 } else if (partial_dir && partialptr)
502 fnamecmp = partialptr;
503 else
504 fnamecmp = fname;
507 initial_stats = stats;
509 /* open the file */
510 fd1 = do_open(fnamecmp, O_RDONLY, 0);
512 if (fd1 == -1 && protocol_version < 29) {
513 if (fnamecmp != fname) {
514 fnamecmp = fname;
515 fd1 = do_open(fnamecmp, O_RDONLY, 0);
518 if (fd1 == -1 && basis_dir[0]) {
519 /* pre-29 allowed only one alternate basis */
520 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
521 basis_dir[0], fname);
522 fnamecmp = fnamecmpbuf;
523 fd1 = do_open(fnamecmp, O_RDONLY, 0);
527 if (fd1 != -1 && do_fstat(fd1,&st) != 0) {
528 rsyserr(FERROR, errno, "fstat %s failed",
529 full_fname(fnamecmp));
530 discard_receive_data(f_in, file->length);
531 close(fd1);
532 continue;
535 if (fd1 != -1 && S_ISDIR(st.st_mode) && fnamecmp == fname) {
536 /* this special handling for directories
537 * wouldn't be necessary if robust_rename()
538 * and the underlying robust_unlink could cope
539 * with directories
541 rprintf(FERROR,"recv_files: %s is a directory\n",
542 full_fname(fnamecmp));
543 discard_receive_data(f_in, file->length);
544 close(fd1);
545 continue;
548 if (fd1 != -1 && !S_ISREG(st.st_mode)) {
549 close(fd1);
550 fd1 = -1;
553 if (fd1 != -1 && !preserve_perms) {
554 /* if the file exists already and we aren't preserving
555 * permissions then act as though the remote end sent
556 * us the file permissions we already have */
557 file->mode = st.st_mode;
560 /* We now check to see if we are writing file "inplace" */
561 if (inplace) {
562 fd2 = do_open(fname, O_WRONLY|O_CREAT, 0);
563 if (fd2 == -1) {
564 rsyserr(FERROR, errno, "open %s failed",
565 full_fname(fname));
566 discard_receive_data(f_in, file->length);
567 if (fd1 != -1)
568 close(fd1);
569 continue;
571 } else {
572 if (!get_tmpname(fnametmp,fname)) {
573 discard_receive_data(f_in, file->length);
574 if (fd1 != -1)
575 close(fd1);
576 continue;
579 /* we initially set the perms without the
580 * setuid/setgid bits to ensure that there is no race
581 * condition. They are then correctly updated after
582 * the lchown. Thanks to snabb@epipe.fi for pointing
583 * this out. We also set it initially without group
584 * access because of a similar race condition. */
585 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
587 /* in most cases parent directories will already exist
588 * because their information should have been previously
589 * transferred, but that may not be the case with -R */
590 if (fd2 == -1 && relative_paths && errno == ENOENT
591 && create_directory_path(fnametmp, orig_umask) == 0) {
592 /* Get back to name with XXXXXX in it. */
593 get_tmpname(fnametmp, fname);
594 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
596 if (fd2 == -1) {
597 rsyserr(FERROR, errno, "mkstemp %s failed",
598 full_fname(fnametmp));
599 discard_receive_data(f_in, file->length);
600 if (fd1 != -1)
601 close(fd1);
602 continue;
605 if (partialptr)
606 cleanup_set(fnametmp, partialptr, file, fd1, fd2);
609 /* log the transfer */
610 if (log_before_transfer)
611 log_item(file, &initial_stats, iflags, NULL);
612 else if (!am_server && verbose && do_progress)
613 rprintf(FINFO, "%s\n", safe_fname(fname));
615 /* recv file data */
616 recv_ok = receive_data(f_in, fnamecmp, fd1, st.st_size,
617 fname, fd2, file->length);
619 if (!log_before_transfer)
620 log_item(file, &initial_stats, iflags, NULL);
622 if (fd1 != -1)
623 close(fd1);
624 if (close(fd2) < 0) {
625 rsyserr(FERROR, errno, "close failed on %s",
626 full_fname(fnametmp));
627 exit_cleanup(RERR_FILEIO);
630 if ((recv_ok && (!delay_updates || !partialptr)) || inplace) {
631 finish_transfer(fname, fnametmp, file, recv_ok, 1);
632 if (partialptr != fname && fnamecmp == partialptr) {
633 do_unlink(partialptr);
634 handle_partial_dir(partialptr, PDIR_DELETE);
636 } else if (keep_partial && partialptr
637 && handle_partial_dir(partialptr, PDIR_CREATE)) {
638 finish_transfer(partialptr, fnametmp, file, recv_ok,
639 !partial_dir);
640 if (delay_updates && recv_ok) {
641 set_delayed_bit(i);
642 recv_ok = -1;
644 } else {
645 partialptr = NULL;
646 do_unlink(fnametmp);
649 cleanup_disable();
651 if (recv_ok > 0) {
652 if (remove_sent_files
653 || (preserve_hard_links && file->link_u.links)) {
654 SIVAL(numbuf, 0, i);
655 send_msg(MSG_SUCCESS, numbuf, 4);
657 } else if (!recv_ok) {
658 int msgtype = phase || read_batch ? FERROR : FINFO;
659 if (msgtype == FERROR || verbose) {
660 char *errstr, *redostr, *keptstr;
661 if (!(keep_partial && partialptr) && !inplace)
662 keptstr = "discarded";
663 else if (partial_dir)
664 keptstr = "put into partial-dir";
665 else
666 keptstr = "retained";
667 if (msgtype == FERROR) {
668 errstr = "ERROR";
669 redostr = "";
670 } else {
671 errstr = "WARNING";
672 redostr = " (will try again)";
674 rprintf(msgtype,
675 "%s: %s failed verification -- update %s%s.\n",
676 errstr, safe_fname(fname),
677 keptstr, redostr);
679 if (!phase) {
680 SIVAL(numbuf, 0, i);
681 send_msg(MSG_REDO, numbuf, 4);
685 make_backups = save_make_backups;
687 if (phase == 2 && delay_updates) /* for protocol_version < 29 */
688 handle_delayed_updates(flist, local_name);
690 if (verbose > 2)
691 rprintf(FINFO,"recv_files finished\n");
693 return 0;