2 * Generate and receive file lists.
4 * Copyright (C) 1996 Andrew Tridgell
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
7 * Copyright (C) 2002, 2003, 2004, 2005, 2006 Wayne Davison
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
32 extern int do_progress;
33 extern int always_checksum;
35 extern int ignore_errors;
36 extern int numeric_ids;
39 extern int filesfrom_fd;
40 extern int one_file_system;
41 extern int copy_dirlinks;
42 extern int keep_dirlinks;
43 extern int preserve_links;
44 extern int preserve_hard_links;
45 extern int preserve_devices;
46 extern int preserve_specials;
47 extern int preserve_uid;
48 extern int preserve_gid;
49 extern int relative_paths;
50 extern int implied_dirs;
51 extern int prune_empty_dirs;
52 extern int copy_links;
53 extern int copy_unsafe_links;
54 extern int protocol_version;
55 extern int sanitize_paths;
56 extern struct stats stats;
57 extern struct file_list *the_file_list;
59 extern char curr_dir[MAXPATHLEN];
61 extern struct chmod_mode_struct *chmod_modes;
63 extern struct filter_list_struct filter_list;
64 extern struct filter_list_struct server_filter_list;
68 dev_t filesystem_dev; /* used to implement -x */
69 unsigned int file_struct_len;
71 static char empty_sum[MD4_SUM_LENGTH];
72 static int flist_count_offset;
74 static void clean_flist(struct file_list *flist, int strip_root, int no_dups);
75 static void output_flist(struct file_list *flist);
81 /* Figure out how big the file_struct is without trailing padding */
82 file_struct_len = offsetof(struct file_struct, flags) + sizeof f.flags;
83 checksum_len = protocol_version < 21 ? 2 : MD4_SUM_LENGTH;
86 static int show_filelist_p(void)
88 return verbose && xfer_dirs && !am_server;
91 static void start_filelist_progress(char *kind)
93 rprintf(FINFO, "%s ... ", kind);
94 if (verbose > 1 || do_progress)
99 static void emit_filelist_progress(int count)
101 rprintf(FINFO, " %d files...\r", count);
104 static void maybe_emit_filelist_progress(int count)
106 if (do_progress && show_filelist_p() && (count % 100) == 0)
107 emit_filelist_progress(count);
110 static void finish_filelist_progress(const struct file_list *flist)
113 /* This overwrites the progress line */
114 rprintf(FINFO, "%d file%sto consider\n",
115 flist->count, flist->count == 1 ? " " : "s ");
117 rprintf(FINFO, "done\n");
120 void show_flist_stats(void)
125 static void list_file_entry(struct file_struct *f)
127 char permbuf[PERMSTRING_SIZE];
130 /* this can happen if duplicate names were removed */
134 permstring(permbuf, f->mode);
137 if (preserve_links && S_ISLNK(f->mode)) {
138 rprintf(FINFO, "%s %11.0f %s %s -> %s\n",
140 (double)f->length, timestring(f->modtime),
141 f_name(f, NULL), f->u.link);
145 rprintf(FINFO, "%s %11.0f %s %s\n",
147 (double)f->length, timestring(f->modtime),
153 * Stat either a symlink or its referent, depending on the settings of
154 * copy_links, copy_unsafe_links, etc.
156 * @retval -1 on error
158 * @retval 0 for success
160 * @post If @p path is a symlink, then @p linkbuf (of size @c
161 * MAXPATHLEN) contains the symlink target.
163 * @post @p buffer contains information about the link or the
164 * referrent as appropriate, if they exist.
166 static int readlink_stat(const char *path, STRUCT_STAT *buffer, char *linkbuf)
170 return do_stat(path, buffer);
171 if (link_stat(path, buffer, copy_dirlinks) < 0)
173 if (S_ISLNK(buffer->st_mode)) {
174 int l = readlink((char *)path, linkbuf, MAXPATHLEN - 1);
178 if (copy_unsafe_links && unsafe_symlink(linkbuf, path)) {
180 rprintf(FINFO,"copying unsafe symlink \"%s\" -> \"%s\"\n",
183 return do_stat(path, buffer);
188 return do_stat(path, buffer);
192 int link_stat(const char *path, STRUCT_STAT *buffer, int follow_dirlinks)
196 return do_stat(path, buffer);
197 if (do_lstat(path, buffer) < 0)
199 if (follow_dirlinks && S_ISLNK(buffer->st_mode)) {
201 if (do_stat(path, &st) == 0 && S_ISDIR(st.st_mode))
206 return do_stat(path, buffer);
210 /* This function is used to check if a file should be included/excluded
211 * from the list of files based on its name and type etc. The value of
212 * filter_level is set to either SERVER_FILTERS or ALL_FILTERS. */
213 static int is_excluded(char *fname, int is_dir, int filter_level)
215 #if 0 /* This currently never happens, so avoid a useless compare. */
216 if (filter_level == NO_FILTERS)
220 /* never exclude '.', even if somebody does --exclude '*' */
221 if (fname[0] == '.' && !fname[1])
223 /* Handle the -R version of the '.' dir. */
224 if (fname[0] == '/') {
225 int len = strlen(fname);
226 if (fname[len-1] == '.' && fname[len-2] == '/')
230 if (server_filter_list.head
231 && check_filter(&server_filter_list, fname, is_dir) < 0)
233 if (filter_level != ALL_FILTERS)
236 && check_filter(&filter_list, fname, is_dir) < 0)
241 static int to_wire_mode(mode_t mode)
244 if (S_ISLNK(mode) && (_S_IFLNK != 0120000))
245 return (mode & ~(_S_IFMT)) | 0120000;
250 static mode_t from_wire_mode(int mode)
252 if ((mode & (_S_IFMT)) == 0120000 && (_S_IFLNK != 0120000))
253 return (mode & ~(_S_IFMT)) | _S_IFLNK;
257 static void send_directory(int f, struct file_list *flist,
258 char *fbuf, int len);
260 static char *flist_dir;
261 static int flist_dir_len;
265 * Make sure @p flist is big enough to hold at least @p flist->count
268 void flist_expand(struct file_list *flist)
270 struct file_struct **new_ptr;
272 if (flist->count < flist->malloced)
275 if (flist->malloced < FLIST_START)
276 flist->malloced = FLIST_START;
277 else if (flist->malloced >= FLIST_LINEAR)
278 flist->malloced += FLIST_LINEAR;
280 flist->malloced *= 2;
283 * In case count jumped or we are starting the list
284 * with a known size just set it.
286 if (flist->malloced < flist->count)
287 flist->malloced = flist->count;
289 new_ptr = realloc_array(flist->files, struct file_struct *,
292 if (verbose >= 2 && flist->malloced != FLIST_START) {
293 rprintf(FINFO, "[%s] expand file_list to %.0f bytes, did%s move\n",
295 (double)sizeof flist->files[0] * flist->malloced,
296 (new_ptr == flist->files) ? " not" : "");
299 flist->files = new_ptr;
302 out_of_memory("flist_expand");
305 static void send_file_entry(struct file_struct *file, int f)
307 unsigned short flags;
308 static time_t modtime;
312 static uint32 rdev_major;
315 static char lastname[MAXPATHLEN];
316 char fname[MAXPATHLEN];
324 modtime = 0, mode = 0;
325 dev = 0, rdev = makedev(0, 0);
334 flags = file->flags & XMIT_TOP_DIR;
336 if (file->mode == mode)
337 flags |= XMIT_SAME_MODE;
340 if ((preserve_devices && IS_DEVICE(mode))
341 || (preserve_specials && IS_SPECIAL(mode))) {
342 if (protocol_version < 28) {
343 if (file->u.rdev == rdev)
344 flags |= XMIT_SAME_RDEV_pre28;
349 if ((uint32)major(rdev) == rdev_major)
350 flags |= XMIT_SAME_RDEV_MAJOR;
352 rdev_major = major(rdev);
353 if ((uint32)minor(rdev) <= 0xFFu)
354 flags |= XMIT_RDEV_MINOR_IS_SMALL;
356 } else if (protocol_version < 28)
357 rdev = makedev(0, 0);
358 if (file->uid == uid)
359 flags |= XMIT_SAME_UID;
362 if (file->gid == gid)
363 flags |= XMIT_SAME_GID;
366 if (file->modtime == modtime)
367 flags |= XMIT_SAME_TIME;
369 modtime = file->modtime;
371 #ifdef SUPPORT_HARD_LINKS
372 if (file->link_u.idev) {
373 if (file->F_DEV == dev) {
374 if (protocol_version >= 28)
375 flags |= XMIT_SAME_DEV;
378 flags |= XMIT_HAS_IDEV_DATA;
383 lastname[l1] && (fname[l1] == lastname[l1]) && (l1 < 255);
385 l2 = strlen(fname+l1);
388 flags |= XMIT_SAME_NAME;
390 flags |= XMIT_LONG_NAME;
392 /* We must make sure we don't send a zero flag byte or the
393 * other end will terminate the flist transfer. Note that
394 * the use of XMIT_TOP_DIR on a non-dir has no meaning, so
395 * it's harmless way to add a bit to the first flag byte. */
396 if (protocol_version >= 28) {
397 if (!flags && !S_ISDIR(mode))
398 flags |= XMIT_TOP_DIR;
399 if ((flags & 0xFF00) || !flags) {
400 flags |= XMIT_EXTENDED_FLAGS;
401 write_byte(f, flags);
402 write_byte(f, flags >> 8);
404 write_byte(f, flags);
407 flags |= S_ISDIR(mode) ? XMIT_LONG_NAME : XMIT_TOP_DIR;
408 write_byte(f, flags);
410 if (flags & XMIT_SAME_NAME)
412 if (flags & XMIT_LONG_NAME)
416 write_buf(f, fname + l1, l2);
418 write_longint(f, file->length);
419 if (!(flags & XMIT_SAME_TIME))
420 write_int(f, modtime);
421 if (!(flags & XMIT_SAME_MODE))
422 write_int(f, to_wire_mode(mode));
423 if (preserve_uid && !(flags & XMIT_SAME_UID)) {
428 if (preserve_gid && !(flags & XMIT_SAME_GID)) {
433 if ((preserve_devices && IS_DEVICE(mode))
434 || (preserve_specials && IS_SPECIAL(mode))) {
435 if (protocol_version < 28) {
436 if (!(flags & XMIT_SAME_RDEV_pre28))
437 write_int(f, (int)rdev);
439 if (!(flags & XMIT_SAME_RDEV_MAJOR))
440 write_int(f, major(rdev));
441 if (flags & XMIT_RDEV_MINOR_IS_SMALL)
442 write_byte(f, minor(rdev));
444 write_int(f, minor(rdev));
449 if (preserve_links && S_ISLNK(mode)) {
450 int len = strlen(file->u.link);
452 write_buf(f, file->u.link, len);
456 #ifdef SUPPORT_HARD_LINKS
457 if (flags & XMIT_HAS_IDEV_DATA) {
458 if (protocol_version < 26) {
459 /* 32-bit dev_t and ino_t */
461 write_int(f, file->F_INODE);
463 /* 64-bit dev_t and ino_t */
464 if (!(flags & XMIT_SAME_DEV))
465 write_longint(f, dev);
466 write_longint(f, file->F_INODE);
471 if (always_checksum && (S_ISREG(mode) || protocol_version < 28)) {
476 /* Prior to 28, we sent a useless set of nulls. */
479 write_buf(f, sum, checksum_len);
482 strlcpy(lastname, fname, MAXPATHLEN);
485 static struct file_struct *receive_file_entry(struct file_list *flist,
486 unsigned short flags, int f)
488 static time_t modtime;
492 static uint32 rdev_major;
495 static char lastname[MAXPATHLEN], *lastdir;
496 static int lastdir_depth, lastdir_len = -1;
497 static unsigned int del_hier_name_len = 0;
498 static int in_del_hier = 0;
499 char thisname[MAXPATHLEN];
500 unsigned int l1 = 0, l2 = 0;
501 int alloc_len, basename_len, dirname_len, linkname_len, sum_len;
503 char *basename, *dirname, *bp;
504 struct file_struct *file;
507 modtime = 0, mode = 0;
508 dev = 0, rdev = makedev(0, 0);
517 if (flags & XMIT_SAME_NAME)
520 if (flags & XMIT_LONG_NAME)
525 if (l2 >= MAXPATHLEN - l1) {
527 "overflow: flags=0x%x l1=%d l2=%d lastname=%s\n",
528 flags, l1, l2, lastname);
529 overflow_exit("receive_file_entry");
532 strlcpy(thisname, lastname, l1 + 1);
533 read_sbuf(f, &thisname[l1], l2);
534 thisname[l1 + l2] = 0;
536 strlcpy(lastname, thisname, MAXPATHLEN);
538 clean_fname(thisname, 0);
541 sanitize_path(thisname, thisname, "", 0);
543 if ((basename = strrchr(thisname, '/')) != NULL) {
544 dirname_len = ++basename - thisname; /* counts future '\0' */
545 if (lastdir_len == dirname_len - 1
546 && strncmp(thisname, lastdir, lastdir_len) == 0) {
548 dirname_len = 0; /* indicates no copy is needed */
556 basename_len = strlen(basename) + 1; /* count the '\0' */
558 file_length = read_longint(f);
559 if (!(flags & XMIT_SAME_TIME))
560 modtime = (time_t)read_int(f);
561 if (!(flags & XMIT_SAME_MODE))
562 mode = from_wire_mode(read_int(f));
564 if (chmod_modes && !S_ISLNK(mode))
565 mode = tweak_mode(mode, chmod_modes);
567 if (preserve_uid && !(flags & XMIT_SAME_UID))
568 uid = (uid_t)read_int(f);
569 if (preserve_gid && !(flags & XMIT_SAME_GID))
570 gid = (gid_t)read_int(f);
572 if ((preserve_devices && IS_DEVICE(mode))
573 || (preserve_specials && IS_SPECIAL(mode))) {
574 if (protocol_version < 28) {
575 if (!(flags & XMIT_SAME_RDEV_pre28))
576 rdev = (dev_t)read_int(f);
579 if (!(flags & XMIT_SAME_RDEV_MAJOR))
580 rdev_major = read_int(f);
581 if (flags & XMIT_RDEV_MINOR_IS_SMALL)
582 rdev_minor = read_byte(f);
584 rdev_minor = read_int(f);
585 rdev = makedev(rdev_major, rdev_minor);
587 } else if (protocol_version < 28)
588 rdev = makedev(0, 0);
591 if (preserve_links && S_ISLNK(mode)) {
592 linkname_len = read_int(f) + 1; /* count the '\0' */
593 if (linkname_len <= 0 || linkname_len > MAXPATHLEN) {
594 rprintf(FERROR, "overflow: linkname_len=%d\n",
596 overflow_exit("receive_file_entry");
603 sum_len = always_checksum && S_ISREG(mode) ? MD4_SUM_LENGTH : 0;
605 alloc_len = file_struct_len + dirname_len + basename_len
606 + linkname_len + sum_len;
607 bp = pool_alloc(flist->file_pool, alloc_len, "receive_file_entry");
609 file = (struct file_struct *)bp;
610 memset(bp, 0, file_struct_len);
611 bp += file_struct_len;
613 file->modtime = modtime;
614 file->length = file_length;
620 file->dirname = lastdir = bp;
621 lastdir_len = dirname_len - 1;
622 memcpy(bp, dirname, dirname_len - 1);
625 lastdir_depth = count_dir_elements(lastdir);
626 file->dir.depth = lastdir_depth + 1;
627 } else if (dirname) {
628 file->dirname = dirname; /* we're reusing lastname */
629 file->dir.depth = lastdir_depth + 1;
634 if (basename_len == 1+1 && *basename == '.') /* +1 for '\0' */
636 if (flags & XMIT_TOP_DIR) {
637 in_del_hier = recurse;
638 del_hier_name_len = file->dir.depth == 0 ? 0 : l1 + l2;
639 if (relative_paths && del_hier_name_len > 2
640 && lastname[del_hier_name_len-1] == '.'
641 && lastname[del_hier_name_len-2] == '/')
642 del_hier_name_len -= 2;
643 file->flags |= FLAG_TOP_DIR | FLAG_DEL_HERE;
644 } else if (in_del_hier) {
645 if (!relative_paths || !del_hier_name_len
646 || (l1 >= del_hier_name_len
647 && lastname[del_hier_name_len] == '/'))
648 file->flags |= FLAG_DEL_HERE;
655 memcpy(bp, basename, basename_len);
658 if ((preserve_devices && IS_DEVICE(mode))
659 || (preserve_specials && IS_SPECIAL(mode)))
665 read_sbuf(f, bp, linkname_len - 1);
670 #ifdef SUPPORT_HARD_LINKS
671 if (preserve_hard_links && protocol_version < 28 && S_ISREG(mode))
672 flags |= XMIT_HAS_IDEV_DATA;
673 if (flags & XMIT_HAS_IDEV_DATA) {
675 if (protocol_version < 26) {
679 if (!(flags & XMIT_SAME_DEV))
680 dev = read_longint(f);
681 inode = read_longint(f);
683 if (flist->hlink_pool) {
684 file->link_u.idev = pool_talloc(flist->hlink_pool,
685 struct idev, 1, "inode_table");
686 file->F_INODE = inode;
692 if (always_checksum && (sum_len || protocol_version < 28)) {
695 file->u.sum = sum = bp;
698 /* Prior to 28, we get a useless set of nulls. */
701 read_buf(f, sum, checksum_len);
708 * Create a file_struct for a named file by reading its stat()
709 * information and performing extensive checks against global
712 * @return the new file, or NULL if there was an error or this file
713 * should be excluded.
715 * @todo There is a small optimization opportunity here to avoid
716 * stat()ing the file in some circumstances, which has a certain cost.
717 * We are called immediately after doing readdir(), and so we may
718 * already know the d_type of the file. We could for example avoid
719 * statting directories if we're not recursing, but this is not a very
720 * important case. Some systems may not have d_type.
722 struct file_struct *make_file(char *fname, struct file_list *flist,
723 STRUCT_STAT *stp, unsigned short flags,
726 static char *lastdir;
727 static int lastdir_len = -1;
728 struct file_struct *file;
730 char sum[SUM_LENGTH];
731 char thisname[MAXPATHLEN];
732 char linkname[MAXPATHLEN];
733 int alloc_len, basename_len, dirname_len, linkname_len, sum_len;
734 char *basename, *dirname, *bp;
736 if (!flist || !flist->count) /* Ignore lastdir when invalid. */
739 if (strlcpy(thisname, fname, sizeof thisname)
740 >= sizeof thisname - flist_dir_len) {
741 rprintf(FINFO, "skipping overly long name: %s\n", fname);
744 clean_fname(thisname, 0);
746 sanitize_path(thisname, thisname, "", 0);
748 memset(sum, 0, SUM_LENGTH);
750 if (stp && S_ISDIR(stp->st_mode))
751 st = *stp; /* Needed for "symlink/." with --relative. */
752 else if (readlink_stat(thisname, &st, linkname) != 0) {
753 int save_errno = errno;
754 /* See if file is excluded before reporting an error. */
755 if (filter_level != NO_FILTERS
756 && is_excluded(thisname, 0, filter_level))
758 if (save_errno == ENOENT) {
760 /* Avoid "vanished" error if symlink points nowhere. */
761 if (copy_links && do_lstat(thisname, &st) == 0
762 && S_ISLNK(st.st_mode)) {
763 io_error |= IOERR_GENERAL;
764 rprintf(FERROR, "symlink has no referent: %s\n",
765 full_fname(thisname));
769 enum logcode c = am_daemon && protocol_version < 28
771 io_error |= IOERR_VANISHED;
772 rprintf(c, "file has vanished: %s\n",
773 full_fname(thisname));
776 io_error |= IOERR_GENERAL;
777 rsyserr(FERROR, save_errno, "readlink %s failed",
778 full_fname(thisname));
783 /* backup.c calls us with filter_level set to NO_FILTERS. */
784 if (filter_level == NO_FILTERS)
787 if (S_ISDIR(st.st_mode) && !xfer_dirs) {
788 rprintf(FINFO, "skipping directory %s\n", thisname);
792 /* We only care about directories because we need to avoid recursing
793 * into a mount-point directory, not to avoid copying a symlinked
794 * file if -L (or similar) was specified. */
795 if (one_file_system && st.st_dev != filesystem_dev
796 && S_ISDIR(st.st_mode)) {
797 if (one_file_system > 1) {
799 rprintf(FINFO, "skipping mount-point dir %s\n",
804 flags |= FLAG_MOUNT_POINT;
807 if (is_excluded(thisname, S_ISDIR(st.st_mode) != 0, filter_level))
810 if (lp_ignore_nonreadable(module_id)) {
812 if (!S_ISLNK(st.st_mode))
814 if (access(thisname, R_OK) != 0)
821 rprintf(FINFO, "[%s] make_file(%s,*,%d)\n",
822 who_am_i(), thisname, filter_level);
825 if ((basename = strrchr(thisname, '/')) != NULL) {
826 dirname_len = ++basename - thisname; /* counts future '\0' */
827 if (lastdir_len == dirname_len - 1
828 && strncmp(thisname, lastdir, lastdir_len) == 0) {
830 dirname_len = 0; /* indicates no copy is needed */
838 basename_len = strlen(basename) + 1; /* count the '\0' */
841 linkname_len = S_ISLNK(st.st_mode) ? strlen(linkname) + 1 : 0;
846 sum_len = always_checksum && am_sender && S_ISREG(st.st_mode)
847 ? MD4_SUM_LENGTH : 0;
849 alloc_len = file_struct_len + dirname_len + basename_len
850 + linkname_len + sum_len;
852 bp = pool_alloc(flist->file_pool, alloc_len, "make_file");
854 if (!(bp = new_array(char, alloc_len)))
855 out_of_memory("make_file");
858 file = (struct file_struct *)bp;
859 memset(bp, 0, file_struct_len);
860 bp += file_struct_len;
863 file->modtime = st.st_mtime;
864 file->length = st.st_size;
865 file->mode = st.st_mode;
866 file->uid = st.st_uid;
867 file->gid = st.st_gid;
869 #ifdef SUPPORT_HARD_LINKS
870 if (flist && flist->hlink_pool) {
871 if (protocol_version < 28) {
872 if (S_ISREG(st.st_mode))
873 file->link_u.idev = pool_talloc(
874 flist->hlink_pool, struct idev, 1,
877 if (!S_ISDIR(st.st_mode) && st.st_nlink > 1)
878 file->link_u.idev = pool_talloc(
879 flist->hlink_pool, struct idev, 1,
883 if (file->link_u.idev) {
884 file->F_DEV = st.st_dev;
885 file->F_INODE = st.st_ino;
890 file->dirname = lastdir = bp;
891 lastdir_len = dirname_len - 1;
892 memcpy(bp, dirname, dirname_len - 1);
896 file->dirname = dirname;
899 memcpy(bp, basename, basename_len);
902 #ifdef HAVE_STRUCT_STAT_ST_RDEV
903 if ((preserve_devices && IS_DEVICE(st.st_mode))
904 || (preserve_specials && IS_SPECIAL(st.st_mode)))
905 file->u.rdev = st.st_rdev;
911 memcpy(bp, linkname, linkname_len);
918 file_checksum(thisname, bp, st.st_size);
922 file->dir.root = flist_dir;
924 /* This code is only used by the receiver when it is building
925 * a list of files for a delete pass. */
926 if (keep_dirlinks && linkname_len && flist) {
928 int save_mode = file->mode;
929 file->mode = S_IFDIR; /* Find a directory with our name. */
930 if (flist_find(the_file_list, file) >= 0
931 && do_stat(thisname, &st2) == 0 && S_ISDIR(st2.st_mode)) {
932 file->modtime = st2.st_mtime;
933 file->length = st2.st_size;
934 file->mode = st2.st_mode;
935 file->uid = st2.st_uid;
936 file->gid = st2.st_gid;
939 file->mode = save_mode;
942 if (S_ISREG(st.st_mode) || S_ISLNK(st.st_mode))
943 stats.total_size += st.st_size;
948 static struct file_struct *send_file_name(int f, struct file_list *flist,
949 char *fname, STRUCT_STAT *stp,
950 unsigned short flags)
952 struct file_struct *file;
954 file = make_file(fname, flist, stp, flags,
955 f == -2 ? SERVER_FILTERS : ALL_FILTERS);
959 if (chmod_modes && !S_ISLNK(file->mode))
960 file->mode = tweak_mode(file->mode, chmod_modes);
962 maybe_emit_filelist_progress(flist->count + flist_count_offset);
966 if (file->basename[0]) {
967 flist->files[flist->count++] = file;
968 send_file_entry(file, f);
973 static void send_if_directory(int f, struct file_list *flist,
974 struct file_struct *file,
975 char *fbuf, unsigned int ol)
977 char is_dot_dir = fbuf[ol-1] == '.' && (ol == 1 || fbuf[ol-2] == '/');
979 if (S_ISDIR(file->mode)
980 && !(file->flags & FLAG_MOUNT_POINT) && f_name(file, fbuf)) {
982 unsigned int len = strlen(fbuf);
983 if (len > 1 && fbuf[len-1] == '/')
985 if (len >= MAXPATHLEN - 1) {
986 io_error |= IOERR_GENERAL;
987 rprintf(FERROR, "skipping long-named directory: %s\n",
991 save_filters = push_local_filters(fbuf, len);
992 send_directory(f, flist, fbuf, len);
993 pop_local_filters(save_filters);
1000 /* This function is normally called by the sender, but the receiving side also
1001 * calls it from get_dirlist() with f set to -1 so that we just construct the
1002 * file list in memory without sending it over the wire. Also, get_dirlist()
1003 * might call this with f set to -2, which also indicates that local filter
1004 * rules should be ignored. */
1005 static void send_directory(int f, struct file_list *flist,
1006 char *fbuf, int len)
1012 int start = flist->count;
1014 if (!(d = opendir(fbuf))) {
1015 io_error |= IOERR_GENERAL;
1016 rsyserr(FERROR, errno, "opendir %s failed", full_fname(fbuf));
1021 if (len != 1 || *fbuf != '/')
1024 remainder = MAXPATHLEN - (p - fbuf);
1026 for (errno = 0, di = readdir(d); di; errno = 0, di = readdir(d)) {
1027 char *dname = d_name(di);
1028 if (dname[0] == '.' && (dname[1] == '\0'
1029 || (dname[1] == '.' && dname[2] == '\0')))
1031 if (strlcpy(p, dname, remainder) >= remainder) {
1032 io_error |= IOERR_GENERAL;
1034 "cannot send long-named file %s\n",
1039 send_file_name(f, flist, fbuf, NULL, 0);
1045 io_error |= IOERR_GENERAL;
1046 rsyserr(FERROR, errno, "readdir(%s)", full_fname(fbuf));
1052 int i, end = flist->count - 1;
1053 for (i = start; i <= end; i++)
1054 send_if_directory(f, flist, flist->files[i], fbuf, len);
1058 struct file_list *send_file_list(int f, int argc, char *argv[])
1062 char *p, *dir, olddir[sizeof curr_dir];
1063 char lastpath[MAXPATHLEN] = "";
1064 struct file_list *flist;
1065 struct timeval start_tv, end_tv;
1069 if (show_filelist_p())
1070 start_filelist_progress("building file list");
1072 start_write = stats.total_written;
1073 gettimeofday(&start_tv, NULL);
1075 flist = flist_new(WITH_HLINK, "send_file_list");
1077 io_start_buffering_out();
1078 if (filesfrom_fd >= 0) {
1079 if (argv[0] && !push_dir(argv[0])) {
1080 rsyserr(FERROR, errno, "push_dir %s failed",
1081 full_fname(argv[0]));
1082 exit_cleanup(RERR_FILESELECT);
1088 char fbuf[MAXPATHLEN];
1093 if (read_filesfrom_line(filesfrom_fd, fbuf) == 0)
1095 sanitize_path(fbuf, fbuf, "", 0);
1099 strlcpy(fbuf, *argv++, MAXPATHLEN);
1101 sanitize_path(fbuf, fbuf, "", 0);
1105 if (relative_paths) {
1106 /* We clean up fbuf below. */
1108 } else if (!len || fbuf[len - 1] == '/') {
1109 if (len == 2 && fbuf[0] == '.') {
1110 /* Turn "./" into just "." rather than "./." */
1113 if (len + 1 >= MAXPATHLEN)
1114 overflow_exit("send_file_list");
1119 } else if (len > 1 && fbuf[len-1] == '.' && fbuf[len-2] == '.'
1120 && (len == 2 || fbuf[len-3] == '/')) {
1121 if (len + 2 >= MAXPATHLEN)
1122 overflow_exit("send_file_list");
1128 is_dot_dir = fbuf[len-1] == '.'
1129 && (len == 1 || fbuf[len-2] == '/');
1132 if (link_stat(fbuf, &st, copy_dirlinks) != 0) {
1133 io_error |= IOERR_GENERAL;
1134 rsyserr(FERROR, errno, "link_stat %s failed",
1139 if (S_ISDIR(st.st_mode) && !xfer_dirs) {
1140 rprintf(FINFO, "skipping directory %s\n", fbuf);
1147 if (!relative_paths) {
1148 p = strrchr(fbuf, '/');
1155 len -= p - fbuf + 1;
1160 if ((p = strstr(fbuf, "/./")) != NULL) {
1166 len -= p - fbuf + 3;
1170 /* Get rid of trailing "/" and "/.". */
1172 if (fn[len - 1] == '/') {
1174 if (!--len && !dir) {
1179 else if (len >= 2 && fn[len - 1] == '.'
1180 && fn[len - 2] == '/') {
1182 if (!(len -= 2) && !dir) {
1190 /* Reject a ".." dir in the active part of the path. */
1191 for (p = fn; (p = strstr(p, "..")) != NULL; p += 2) {
1192 if ((p[2] == '/' || p[2] == '\0')
1193 && (p == fn || p[-1] == '/')) {
1195 "found \"..\" dir in relative path: %s\n",
1197 exit_cleanup(RERR_SYNTAX);
1208 static char *lastdir;
1209 static int lastdir_len;
1211 strlcpy(olddir, curr_dir, sizeof olddir);
1213 if (!push_dir(dir)) {
1214 io_error |= IOERR_GENERAL;
1215 rsyserr(FERROR, errno, "push_dir %s failed",
1220 if (lastdir && strcmp(lastdir, dir) == 0) {
1221 flist_dir = lastdir;
1222 flist_dir_len = lastdir_len;
1224 flist_dir = lastdir = strdup(dir);
1225 flist_dir_len = lastdir_len = strlen(dir);
1230 memmove(fbuf, fn, len + 1);
1232 if (implied_dirs && (p=strrchr(fbuf,'/')) && p != fbuf) {
1233 /* Send the implied directories at the start of the
1234 * source spec, so we get their permissions right. */
1235 char *lp = lastpath, *slash = fbuf;
1237 /* Skip any initial directories in our path that we
1238 * have in common with lastpath. */
1239 for (fn = fbuf; *fn && *lp == *fn; lp++, fn++) {
1244 if (fn != p || (*lp && *lp != '/')) {
1245 int save_copy_links = copy_links;
1246 int save_xfer_dirs = xfer_dirs;
1247 copy_links |= copy_unsafe_links;
1249 while ((slash = strchr(slash+1, '/')) != 0) {
1251 send_file_name(f, flist, fbuf, NULL, 0);
1254 copy_links = save_copy_links;
1255 xfer_dirs = save_xfer_dirs;
1257 strlcpy(lastpath, fbuf, sizeof lastpath);
1262 if (one_file_system)
1263 filesystem_dev = st.st_dev;
1265 if (recurse || (xfer_dirs && is_dot_dir)) {
1266 struct file_struct *file;
1267 file = send_file_name(f, flist, fbuf, &st, FLAG_TOP_DIR);
1269 send_if_directory(f, flist, file, fbuf, len);
1271 send_file_name(f, flist, fbuf, &st, 0);
1276 if (!pop_dir(olddir)) {
1277 rsyserr(FERROR, errno, "pop_dir %s failed",
1278 full_fname(olddir));
1279 exit_cleanup(RERR_FILESELECT);
1284 gettimeofday(&end_tv, NULL);
1285 stats.flist_buildtime = (int64)(end_tv.tv_sec - start_tv.tv_sec) * 1000
1286 + (end_tv.tv_usec - start_tv.tv_usec) / 1000;
1287 if (stats.flist_buildtime == 0)
1288 stats.flist_buildtime = 1;
1291 send_file_entry(NULL, f);
1293 if (show_filelist_p())
1294 finish_filelist_progress(flist);
1296 gettimeofday(&end_tv, NULL);
1297 stats.flist_xfertime = (int64)(end_tv.tv_sec - start_tv.tv_sec) * 1000
1298 + (end_tv.tv_usec - start_tv.tv_usec) / 1000;
1300 if (flist->hlink_pool) {
1301 pool_destroy(flist->hlink_pool);
1302 flist->hlink_pool = NULL;
1305 /* Sort the list without removing any duplicates. This allows the
1306 * receiving side to ask for any name they like, which gives us the
1307 * flexibility to change the way we unduplicate names in the future
1308 * without causing a compatibility problem with older versions. */
1309 clean_flist(flist, 0, 0);
1313 /* send the io_error flag */
1314 write_int(f, lp_ignore_errors(module_id) ? 0 : io_error);
1317 stats.flist_size = stats.total_written - start_write;
1318 stats.num_files = flist->count;
1321 output_flist(flist);
1324 rprintf(FINFO, "send_file_list done\n");
1329 struct file_list *recv_file_list(int f)
1331 struct file_list *flist;
1332 unsigned short flags;
1335 if (show_filelist_p())
1336 start_filelist_progress("receiving file list");
1338 start_read = stats.total_read;
1340 flist = flist_new(WITH_HLINK, "recv_file_list");
1343 flist->malloced = 1000;
1344 flist->files = new_array(struct file_struct *, flist->malloced);
1348 while ((flags = read_byte(f)) != 0) {
1349 struct file_struct *file;
1351 flist_expand(flist);
1353 if (protocol_version >= 28 && (flags & XMIT_EXTENDED_FLAGS))
1354 flags |= read_byte(f) << 8;
1355 file = receive_file_entry(flist, flags, f);
1357 if (S_ISREG(file->mode) || S_ISLNK(file->mode))
1358 stats.total_size += file->length;
1360 flist->files[flist->count++] = file;
1362 maybe_emit_filelist_progress(flist->count);
1365 rprintf(FINFO, "recv_file_name(%s)\n",
1366 f_name(file, NULL));
1369 receive_file_entry(NULL, 0, 0); /* Signal that we're done. */
1372 rprintf(FINFO, "received %d names\n", flist->count);
1374 if (show_filelist_p())
1375 finish_filelist_progress(flist);
1377 clean_flist(flist, relative_paths, 1);
1380 recv_uid_list(f, flist);
1382 /* Recv the io_error flag */
1383 if (lp_ignore_errors(module_id) || ignore_errors)
1386 io_error |= read_int(f);
1390 output_flist(flist);
1394 for (i = 0; i < flist->count; i++)
1395 list_file_entry(flist->files[i]);
1399 rprintf(FINFO, "recv_file_list done\n");
1401 stats.flist_size = stats.total_read - start_read;
1402 stats.num_files = flist->count;
1407 out_of_memory("recv_file_list");
1408 return NULL; /* not reached */
1411 static int file_compare(struct file_struct **file1, struct file_struct **file2)
1413 return f_name_cmp(*file1, *file2);
1416 /* Search for an identically-named item in the file list. Note that the
1417 * items must agree in their directory-ness, or no match is returned. */
1418 int flist_find(struct file_list *flist, struct file_struct *f)
1420 int low = flist->low, high = flist->high;
1421 int diff, mid, mid_up;
1423 while (low <= high) {
1424 mid = (low + high) / 2;
1425 if (flist->files[mid]->basename)
1428 /* Scan for the next non-empty entry using the cached
1429 * distance values. If the value isn't fully up-to-
1430 * date, update it. */
1431 mid_up = mid + flist->files[mid]->dir.depth;
1432 if (!flist->files[mid_up]->basename) {
1434 mid_up += flist->files[mid_up]->dir.depth;
1435 } while (!flist->files[mid_up]->basename);
1436 flist->files[mid]->dir.depth = mid_up - mid;
1438 if (mid_up > high) {
1439 /* If there's nothing left above us, set high to
1440 * a non-empty entry below us and continue. */
1441 high = mid - flist->files[mid]->length;
1442 if (!flist->files[high]->basename) {
1444 high -= flist->files[high]->length;
1445 } while (!flist->files[high]->basename);
1446 flist->files[mid]->length = mid - high;
1451 diff = f_name_cmp(flist->files[mid_up], f);
1453 if (protocol_version < 29
1454 && S_ISDIR(flist->files[mid_up]->mode)
1455 != S_ISDIR(f->mode))
1468 * Free up any resources a file_struct has allocated
1469 * and clear the file.
1471 void clear_file(struct file_struct *file, struct file_list *flist)
1473 if (flist->hlink_pool && file->link_u.idev)
1474 pool_free(flist->hlink_pool, 0, file->link_u.idev);
1475 memset(file, 0, file_struct_len);
1476 /* In an empty entry, dir.depth is an offset to the next non-empty
1477 * entry. Likewise for length in the opposite direction. We assume
1478 * that we're alone for now since flist_find() will adjust the counts
1479 * it runs into that aren't up-to-date. */
1480 file->length = file->dir.depth = 1;
1484 * allocate a new file list
1486 struct file_list *flist_new(int with_hlink, char *msg)
1488 struct file_list *flist;
1490 flist = new(struct file_list);
1494 memset(flist, 0, sizeof (struct file_list));
1496 if (!(flist->file_pool = pool_create(FILE_EXTENT, 0,
1497 out_of_memory, POOL_INTERN)))
1500 #ifdef SUPPORT_HARD_LINKS
1501 if (with_hlink && preserve_hard_links) {
1502 if (!(flist->hlink_pool = pool_create(HLINK_EXTENT,
1503 sizeof (struct idev), out_of_memory, POOL_INTERN)))
1512 * free up all elements in a flist
1514 void flist_free(struct file_list *flist)
1516 pool_destroy(flist->file_pool);
1517 pool_destroy(flist->hlink_pool);
1523 * This routine ensures we don't have any duplicate names in our file list.
1524 * duplicate names can cause corruption because of the pipelining
1526 static void clean_flist(struct file_list *flist, int strip_root, int no_dups)
1528 char fbuf[MAXPATHLEN];
1533 if (flist->count == 0) {
1538 qsort(flist->files, flist->count,
1539 sizeof flist->files[0], (int (*)())file_compare);
1541 for (i = no_dups? 0 : flist->count; i < flist->count; i++) {
1542 if (flist->files[i]->basename) {
1547 flist->low = prev_i;
1548 while (++i < flist->count) {
1550 struct file_struct *file = flist->files[i];
1552 if (!file->basename)
1554 if (f_name_cmp(file, flist->files[prev_i]) == 0)
1556 else if (protocol_version >= 29 && S_ISDIR(file->mode)) {
1557 int save_mode = file->mode;
1558 /* Make sure that this directory doesn't duplicate a
1559 * non-directory earlier in the list. */
1560 flist->high = prev_i;
1561 file->mode = S_IFREG;
1562 j = flist_find(flist, file);
1563 file->mode = save_mode;
1567 struct file_struct *fp = flist->files[j];
1569 /* If one is a dir and the other is not, we want to
1570 * keep the dir because it might have contents in the
1572 if (S_ISDIR(file->mode) != S_ISDIR(fp->mode)) {
1573 if (S_ISDIR(file->mode))
1579 if (verbose > 1 && !am_server) {
1581 "removing duplicate name %s from file list (%d)\n",
1582 f_name(file, fbuf), drop);
1584 /* Make sure we don't lose track of a user-specified
1586 flist->files[keep]->flags |= flist->files[drop]->flags
1587 & (FLAG_TOP_DIR|FLAG_DEL_HERE);
1589 clear_file(flist->files[drop], flist);
1592 if (flist->low == drop) {
1594 j < i && !flist->files[j]->basename;
1603 flist->high = no_dups ? prev_i : flist->count - 1;
1606 /* We need to strip off the leading slashes for relative
1607 * paths, but this must be done _after_ the sorting phase. */
1608 for (i = flist->low; i <= flist->high; i++) {
1609 struct file_struct *file = flist->files[i];
1613 while (*file->dirname == '/')
1615 if (!*file->dirname)
1616 file->dirname = NULL;
1620 if (prune_empty_dirs && no_dups) {
1621 int j, prev_depth = 0;
1623 prev_i = 0; /* It's OK that this isn't really true. */
1625 for (i = flist->low; i <= flist->high; i++) {
1626 struct file_struct *fp, *file = flist->files[i];
1628 /* This temporarily abuses the dir.depth value for a
1629 * directory that is in a chain that might get pruned.
1630 * We restore the old value if it gets a reprieve. */
1631 if (S_ISDIR(file->mode) && file->dir.depth) {
1632 /* Dump empty dirs when coming back down. */
1633 for (j = prev_depth; j >= file->dir.depth; j--) {
1634 fp = flist->files[prev_i];
1635 if (fp->dir.depth >= 0)
1637 prev_i = -fp->dir.depth-1;
1638 clear_file(fp, flist);
1640 prev_depth = file->dir.depth;
1641 if (is_excluded(f_name(file, fbuf), 1,
1643 /* Keep dirs through this dir. */
1644 for (j = prev_depth-1; ; j--) {
1645 fp = flist->files[prev_i];
1646 if (fp->dir.depth >= 0)
1648 prev_i = -fp->dir.depth-1;
1652 file->dir.depth = -prev_i-1;
1655 /* Keep dirs through this non-dir. */
1656 for (j = prev_depth; ; j--) {
1657 fp = flist->files[prev_i];
1658 if (fp->dir.depth >= 0)
1660 prev_i = -fp->dir.depth-1;
1665 /* Dump empty all remaining empty dirs. */
1667 struct file_struct *fp = flist->files[prev_i];
1668 if (fp->dir.depth >= 0)
1670 prev_i = -fp->dir.depth-1;
1671 clear_file(fp, flist);
1674 for (i = flist->low; i <= flist->high; i++) {
1675 if (flist->files[i]->basename)
1679 for (i = flist->high; i >= flist->low; i--) {
1680 if (flist->files[i]->basename)
1687 static void output_flist(struct file_list *flist)
1689 char uidbuf[16], gidbuf[16], depthbuf[16];
1690 struct file_struct *file;
1691 const char *who = who_am_i();
1694 for (i = 0; i < flist->count; i++) {
1695 file = flist->files[i];
1696 if ((am_root || am_sender) && preserve_uid)
1697 sprintf(uidbuf, " uid=%ld", (long)file->uid);
1700 if (preserve_gid && file->gid != GID_NONE)
1701 sprintf(gidbuf, " gid=%ld", (long)file->gid);
1705 sprintf(depthbuf, "%d", file->dir.depth);
1706 rprintf(FINFO, "[%s] i=%d %s %s%s%s%s mode=0%o len=%.0f%s%s flags=%x\n",
1707 who, i, am_sender ? NS(file->dir.root) : depthbuf,
1708 file->dirname ? file->dirname : "",
1709 file->dirname ? "/" : "", NS(file->basename),
1710 S_ISDIR(file->mode) ? "/" : "", (int)file->mode,
1711 (double)file->length, uidbuf, gidbuf, file->flags);
1715 enum fnc_state { s_DIR, s_SLASH, s_BASE, s_TRAILING };
1716 enum fnc_type { t_PATH, t_ITEM };
1718 /* Compare the names of two file_struct entities, similar to how strcmp()
1719 * would do if it were operating on the joined strings.
1721 * Some differences beginning with protocol_version 29: (1) directory names
1722 * are compared with an assumed trailing slash so that they compare in a
1723 * way that would cause them to sort immediately prior to any content they
1724 * may have; (2) a directory of any name compares after a non-directory of
1725 * any name at the same depth; (3) a directory with name "." compares prior
1726 * to anything else. These changes mean that a directory and a non-dir
1727 * with the same name will not compare as equal (protocol_version >= 29).
1729 * The dirname component can be an empty string, but the basename component
1730 * cannot (and never is in the current codebase). The basename component
1731 * may be NULL (for a removed item), in which case it is considered to be
1732 * after any existing item. */
1733 int f_name_cmp(struct file_struct *f1, struct file_struct *f2)
1736 const uchar *c1, *c2;
1737 enum fnc_state state1, state2;
1738 enum fnc_type type1, type2;
1739 enum fnc_type t_path = protocol_version >= 29 ? t_PATH : t_ITEM;
1741 if (!f1 || !f1->basename) {
1742 if (!f2 || !f2->basename)
1746 if (!f2 || !f2->basename)
1749 c1 = (uchar*)f1->dirname;
1750 c2 = (uchar*)f2->dirname;
1754 type1 = S_ISDIR(f1->mode) ? t_path : t_ITEM;
1755 c1 = (uchar*)f1->basename;
1756 if (type1 == t_PATH && *c1 == '.' && !c1[1]) {
1758 state1 = s_TRAILING;
1771 type2 = S_ISDIR(f2->mode) ? t_path : t_ITEM;
1772 c2 = (uchar*)f2->basename;
1773 if (type2 == t_PATH && *c2 == '.' && !c2[1]) {
1775 state2 = s_TRAILING;
1789 return type1 == t_PATH ? 1 : -1;
1792 if ((dif = (int)*c1++ - (int)*c2++) != 0)
1801 type1 = S_ISDIR(f1->mode) ? t_path : t_ITEM;
1802 c1 = (uchar*)f1->basename;
1803 if (type1 == t_PATH && *c1 == '.' && !c1[1]) {
1805 state1 = s_TRAILING;
1811 state1 = s_TRAILING;
1812 if (type1 == t_PATH) {
1821 if (*c2 && type1 != type2)
1822 return type1 == t_PATH ? 1 : -1;
1831 type2 = S_ISDIR(f2->mode) ? t_path : t_ITEM;
1832 c2 = (uchar*)f2->basename;
1833 if (type2 == t_PATH && *c2 == '.' && !c2[1]) {
1835 state2 = s_TRAILING;
1841 state2 = s_TRAILING;
1842 if (type2 == t_PATH) {
1854 return type1 == t_PATH ? 1 : -1;
1861 /* Return a copy of the full filename of a flist entry, using the indicated
1862 * buffer or one of 5 static buffers if fbuf is NULL. No size-checking is
1863 * done because we checked the size when creating the file_struct entry.
1865 char *f_name(struct file_struct *f, char *fbuf)
1867 if (!f || !f->basename)
1871 static char names[5][MAXPATHLEN];
1872 static unsigned int n;
1874 n = (n + 1) % (sizeof names / sizeof names[0]);
1880 int len = strlen(f->dirname);
1881 memcpy(fbuf, f->dirname, len);
1883 strcpy(fbuf + len + 1, f->basename);
1885 strcpy(fbuf, f->basename);
1890 /* Do a non-recursive scan of the named directory, possibly ignoring all
1891 * exclude rules except for the daemon's. If "dlen" is >=0, it is the length
1892 * of the dirname string, and also indicates that "dirname" is a MAXPATHLEN
1893 * buffer (the functions we call will append names onto the end, but the old
1894 * dir value will be restored on exit). */
1895 struct file_list *get_dirlist(char *dirname, int dlen,
1896 int ignore_filter_rules)
1898 struct file_list *dirlist;
1899 char dirbuf[MAXPATHLEN];
1900 int save_recurse = recurse;
1901 int save_xfer_dirs = xfer_dirs;
1904 dlen = strlcpy(dirbuf, dirname, MAXPATHLEN);
1905 if (dlen >= MAXPATHLEN)
1910 dirlist = flist_new(WITHOUT_HLINK, "get_dirlist");
1914 send_directory(ignore_filter_rules ? -2 : -1, dirlist, dirname, dlen);
1915 xfer_dirs = save_xfer_dirs;
1916 recurse = save_recurse;
1918 flist_count_offset += dirlist->count;
1920 clean_flist(dirlist, 0, 0);
1923 output_flist(dirlist);